转自:http://blog.csdn.net/helloanthea/article/details/25330809。
0 前言
之前对ioctl的cmd认知是:只要保证应用程序传入的与驱动程序定义的cmd一致即可。但是最近在开发某驱动程序过程中发现不是如此。当试图传入的命令字是0x0000_0002时,出现了Bad Address的错误,而且根本没有进入驱动程序定义的ioctl方法(第一条语句(打印)没有执行),而其它的命令都正常进入。调试了很久,回想起大学助教时与老师争论是否需要调用内核API来构造命令,当时一直坚定认为是不用,那些API只是用于理解,所以最后尝试性地先换了0x0000_0006竟然正常执行了,恍然大悟,遂决定以后的规范cmd。(其实当时拒绝接受的原因还有是因为应用层没有找到对应的API,可恨当时没有静下来深究)。
最后被充说明下ioctl不能为2的理由,因为从应用层调用ioctl到驱动xxx_drv_ioctl的操作方法函数过程中间会经历vfs_ioctl或者file_ioctl,中间对于2会认为是个非法值,详见“http://stackoverflow.com/questions/10071296/ioctl-is-not-called-if-cmd-2”或“http://www.cnblogs.com/kevinhwang/p/5665485.html”。
1 ioctl的组成
cmd的大小为 32位,共分 4 个域:
bit31~bit30 2位为 “区别读写” 区,作用是区分是读取命令还是写入命令。
bit29~bit15 14位为 "数据大小" 区,表示 ioctl()中的 arg 变量传送的内存大小。
bit20~bit08 8位为 “魔数"(也称为"幻数")区,这个值用以与其它设备驱动程序的 ioctl 命令进行区别。
bit07~bit00 8位为 "区别序号" 区,是区分命令的命令顺序序号。
2 API填充
命令码中的 “区分读写区” 里的值可能是 _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() 的定义:
#define _IOC(dir,type,nr,size) \ (((dir) << _IOC_DIRSHIFT)| \ ((type)<< _IOC_TYPESHIFT)| \ ((nr) << _IOC_NRSHIFT)| \ ((size)<< _IOC_SIZESHIFT)) |
可见,_IO() 的最后结果由_IOC() 中的 4 个参数移位组合而成。再看 _IOC_DIRSHIT 的定义:
#define _IOC_DIRSHIFT (_IOC_SIZESHIFT+_IOC_SIZEBITS) |
_IOC_SIZESHIFT 的定义:
#define _IOC_SIZESHIFT (_IOC_TYPESHIFT+_IOC_TYPEBITS) |
_IOC_TYPESHIF 的定义:
#define _IOC_TYPESHIFT (_IOC_NRSHIFT+_IOC_NRBITS) |
_IOC_NRSHIFT 的定义:
#define _IOC_NRSHIFT 0 |
_IOC_NRBITS 的定义:
#define _IOC_NRBITS 8 |
_IOC_TYPEBITS 的定义:
#define _IOC_TYPEBITS 8 |
由上面的定义,往上推得到:
_IOC_TYPESHIFT =8 _IOC_SIZESHIFT =16 _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()一般是这样的:
#define I2C_IOCTL_CMD_MAKE(cmd) ( _IO( I2C_DRV_MAGICNUM, cmd) ) cmd = I2C_IOCTL_CMD_MAKE(I2C_CMD_WRITE); status = ioctl(hndl->fd, cmd,&prm); |
在对应的驱动程序中在switch对cmd做出分类时有这样的调用:
#define I2C_IOCTL_CMD_GET(cmd) ( _IOC_NR(cmd) ) #define I2C_IOCTL_CMD_IS_VALID(cmd) ( (_IOC_TYPE(cmd) == I2C_DRV_MAGICNUM ) ? 1 : 0)
if(!I2C_IOCTL_CMD_IS_VALID(cmd)) return-1; cmd = I2C_IOCTL_CMD_GET(cmd); switch(cmd) {} |
那么_IOC_NR()和_IOC_TYPE()又是什么东西,从形式上看应该是_IO()的逆操作
以上几个宏的使用格式为:
_IO (魔数,基数);
_IOR (魔数,基数,变量型)
_IOW (魔数,基数,变量型)
_IOWR (魔数,基数,变量型 )
魔数 (magicnumber)
魔数范围为 0~255 。通常,用英文字符 "A" ~ "Z" 或者 "a" ~"z" 来表示。设备驱动程序从传递进来的命令获取魔数,然后与自身处理的魔数想比较,如果相同则处理,不同则不处理。魔数是拒绝误使用的初步辅助状态。设备驱动程序可以通过 _IOC_TYPE(cmd)来获取魔数。不同的设备驱动程序最好设置不同的魔数,但并不是要求绝对,也是可以使用其他设备驱动程序已用过的魔数。
基(序列号)数
基数用于区别各种命令。通常,从 0开始递增,相同设备驱动程序上可以重复使用该值。例如,读取和写入命令中使用了相同的基数,设备驱动程序也能分辨出来,原因在于设备驱动程序区分命令时使用 switch ,且直接使用命令变量 cmd值。创建命令的宏生成的值由多个域组合而成,所以即使是相同的基数,也会判断为不同的命令。设备驱动程序想要从命令中获取该基数,就使用下面的宏:
_IOC_NR (cmd)
变量型
变量型使用 arg 变量指定传送的数据大小,但是不直接代入输入,而是代入变量或者是变量的类型,原因是在使用宏创建命令,已经包含了 sizeof() 编译命令。