ioctl中的cmd和_IO() , _IOR() , IOW() ,_IOWR() 以及_IOC_NR()的关系

来源:互联网 发布:飞思卡尔单片机 编辑:程序博客网 时间:2024/05/27 21:06

在驱动程序里, ioctl() 函数传送的变量 cmd 是应用程序用于区别设备驱动程序请求处理内容的值。cmd除了可区别数字外,还包含有助于处理的几种相应信息。

ioctl()的cmd可以通过使用宏_IO()得到,那么cmd到底是怎么组成的呢?

cmd的大小为 32位,共分 4 个域:

bit31~bit30 2位为 “区别读写” 区,作用是区分是读取命令还是写入命令。
bit29~bit15 14位为 "数据大小" 区,表示 ioctl() 中的 arg 变量传送的内存大小。
bit20~bit08 8位为 “魔数"(也称为"幻数")区,这个值用以与其它设备驱动程序的 ioctl 命令进行区别。
bit07~bit00 8位为 "区别序号" 区,是区分命令的命令顺序序号。
像命令码中的 “区分读写区” 里的值可能是 _IOC_NONE (0值)表示无数据传输,_IOC_READ (读), _IOC_WRITE (写) , _IOC_READ|_IOC_WRITE (双向)。
内核定义了 _IO() , _IOR() , IOW() 和 _IOWR() 这 4 个宏来辅助生成上面的 cmd 。下面分析 _IO() 的实现,其它的类似。
在 asm-generic/ioctl.h 里可以看到 _IO() 的定义:
#define _IO(type,nr) _IOC(_IOC_NONE,(type),(nr),0)
再看 _IOC() 的定义:
[cpp] view plaincopyprint?
  1. #define _IOC(dir,type,nr,size) \
  2. (((dir) << _IOC_DIRSHIFT) | \
  3. ((type) << _IOC_TYPESHIFT) | \
  4. ((nr) << _IOC_NRSHIFT) | \
  5. ((size) << _IOC_SIZESHIFT))
可见,_IO() 的最后结果由 _IOC() 中的 4 个参数移位组合而成。
再看 _IOC_DIRSHIT 的定义:
[cpp] view plaincopyprint?
  1. #define _IOC_DIRSHIFT (_IOC_SIZESHIFT+_IOC_SIZEBITS)
_IOC_SIZESHIFT 的定义:
[cpp] view plaincopyprint?
  1. #define _IOC_SIZESHIFT (_IOC_TYPESHIFT+_IOC_TYPEBITS)
_IOC_TYPESHIF 的定义:
[cpp] view plaincopyprint?
  1. #define _IOC_TYPESHIFT (_IOC_NRSHIFT+_IOC_NRBITS)
_IOC_NRSHIFT 的定义:
[cpp] view plaincopyprint?
  1. #define _IOC_NRSHIFT 0
_IOC_NRBITS 的定义:
[cpp] view plaincopyprint?
  1. #define _IOC_NRBITS 8
_IOC_TYPEBITS 的定义:
[cpp] view plaincopyprint?
  1. #define _IOC_TYPEBITS 8
由上面的定义,往上推得到:
[cpp] view plaincopyprint?
  1. _IOC_TYPESHIFT = 8
  2. _IOC_SIZESHIFT = 16
  3. _IOC_DIRSHIFT = 30
所以,(dir) << _IOC_DIRSHIFT) 表是 dir 往左移 30 位,即移到 bit31~bit30 两位上,得到方向(读写)的属性;
(size) << _IOC_SIZESHIFT) 位左移 16 位得到“数据大小”区;
(type) << _IOC_TYPESHIFT) 左移 8位得到"魔数区" ;
(nr) << _IOC_NRSHIFT) 左移 0 位( bit7~bit0) 。
这样,就得到了 _IO() 的宏值。

所以在应用程序中调用ioctl()一般是这样的:

[cpp] view plaincopyprint?
  1. #define I2C_IOCTL_CMD_MAKE(cmd) ( _IO( I2C_DRV_MAGICNUM, cmd) )
  2. cmd = I2C_IOCTL_CMD_MAKE(I2C_CMD_WRITE);
  3. status = ioctl(hndl->fd, cmd, &prm);

在对应的驱动程序中在switch对cmd做出分类时有这样的调用:

[cpp] view plaincopyprint?
  1. #define I2C_IOCTL_CMD_GET(cmd) ( _IOC_NR(cmd) )
  2. #define I2C_IOCTL_CMD_IS_VALID(cmd) ( (_IOC_TYPE(cmd) == I2C_DRV_MAGICNUM ) ? 1 : 0)
  3. if(!I2C_IOCTL_CMD_IS_VALID(cmd))
  4. return -1;
  5. cmd = I2C_IOCTL_CMD_GET(cmd);
  6. switch(cmd)
  7. {}

那么_IOC_NR()和_IOC_TYPE()又是什么东西,从形式上看应该是_IO()的逆操作


以上几个宏的使用格式为:
_IO (魔数, 基数);
_IOR (魔数, 基数, 变量型)
_IOW (魔数, 基数, 变量型)
_IOWR (魔数, 基数,变量型 )

魔数 (magic number)
魔数范围为 0~255 。通常,用英文字符 "A" ~ "Z" 或者 "a" ~ "z" 来表示。设备驱动程序从传递进来的命令获取魔数,然后与自身处理的魔数想比较,如果相同则处理,不同则不处理。魔数是拒绝误使用的初步辅助状态。设备驱动程序可以通过 _IOC_TYPE (cmd)来获取魔数。不同的设备驱动程序最好设置不同的魔数,但并不是要求绝对,也是可以使用其他设备驱动程序已用过的魔数。
基(序列号)数
基数用于区别各种命令。通常,从 0开始递增,相同设备驱动程序上可以重复使用该值。例如,读取和写入命令中使用了相同的基数,设备驱动程序也能分辨出来,原因在于设备驱动程序区分命令时使用 switch ,且直接使用命令变量 cmd值。创建命令的宏生成的值由多个域组合而成,所以即使是相同的基数,也会判断为不同的命令。设备驱动程序想要从命令中获取该基数,就使用下面的宏:
_IOC_NR (cmd)
通常,switch 中的 case 值使用的是命令的本身。
变量型
变量型使用 arg 变量指定传送的数据大小,但是不直接代入输入,而是代入变量或者是变量的类型,原因是在使用宏创建命令,已经包含了 sizeof() 编译命令。