linux ioctl函数及其驱动和应用程序注意事项

 在mtd-util的flash_eraseall中发现这样的用法：
----------------------------------------------------------------
#define MEMGETINFO              _IOR('M', 1, struct mtd_info_user)
......
ioctl(fd, MEMGETINFO, &meminfo)
----------------------------------------------------------------
找了一下解释如下：
对于系统支持设备的ioctl号，你可以在/usr/include下面的头文件中找到，对于你自己的设备，如果需要使用ioctl接口，则需要定义自己的ioctl号。以前的2.4中有个问题是，大家都随便定义自己的ioctl号，造成很大可能性的重复性。一个坏处是难以管理，另外一个是容易造成错误，例如如果用户本来希望打开一个串口设备，结果通过open打开了网口，如果串口的某个ioctl号正好是网口的关闭操作，这样就会造成错误。在2.6里面，你定义自己的ioctl号最好使用_IO,   _IOR,   _IOW和_IORW来定义，这些宏考虑了第三个参数的长度，设备的magic number，以及操作的方向等，避免了2.4中的问题

在驱动程序里， ioctl() 函数上传送的变量 cmd 是应用程序用于区别设备驱动程序请求处理内容的值。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() 的定义：

#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驱动的编写方法LDD这本书确实写的比较明白了，在这呢我就简单的做一个介绍。这里我主要描述自己编写IOCTL驱动时所遇到的问题及其原因。
    驱动里的ioctl函数主要实现不用read,write函数的与用户空间的简单数据交互及无参数的命令控制。那么我们如何实现这几种功能的IOCTL函数呢？ioctl驱动中以SWITCH｛case A,case B｝结构以实现对不同命令的响应，首先我们要对我们要使用的“A”，“B”命令定义一个整个操作系统内唯一的标识，同时这个标识又能够表明我们的操作类型及传递参数的类型（如果需要的话）。linux系统的每一个命令号被分为多个位字段，这些位字段包括type,number,direction,size,分别表示幻数（与设备相关的一个字母，以避免与内核冲突），序数（命令编号），方向位（以用户空间为参照的读，写和无数据传输），size（传递参数类型）。内核中/include/asm/ioctl.h,/Documentation/ioctl-number.txt两个文件表明了我们应该如何定义ioctl命令编号及自定义的幻数，。
    看起来构造IOTCL命令这么复杂，庆幸的是内核已经为我们编写了构造命令编号的宏命令。＿IO（type,nr）,_IOR(type,nr,datatype),_IOW(type,nr,datatype)。它们在<linux/ioctl.h>包含的<asm/ioctl.h>中有定义，所以在我们的驱动中应包含这个头文件。其中＿IO（）用做无参数的命令编号，＿IOR（）用做从驱动中读取数据的命令编号，＿IOW（）用做写入数据命令。 LDD中用：define SCULL_IOC_MAGIC 'k' ,define SCULL_IOCSQUANTUM _IOW(SCULL_IOC_MAGIC,1,int)表示SCULL_IOCSQUANTUM命令编号为向驱动中写数据，命令编号为1，传送参数类型为int。

这里把我所写的部分代码贴出来：
 驱动程序部分代码：
 #define MOTOR_MAGIC  'k'
 #define SET_PULSE _IOW(MOTOR_MAGIC,  1,int)
  .
  .
  static int motor_ioctl(struct inode *inode,struct file *filp,unsigned int cmd,unsigned long arg)
{      int data=0;
      int retval;
      switch (cmd) {
      case SET_PULSE:
              if (copy_from_user(&data, (int *)arg, sizeof(int)))
               return -EFAULT;
             .
             .
             .
}
   
应用程序部分代码： 
    #define MOTOR_MAGIC  'k'
    #define SET_PULSE _IOW(MOTOR_MAGIC,  1,int)
    int pulse,fileno;
    fileno = open("/tmp/usb",O_RDWR);
    if (fileno == -1) {
        printf("open device key error!\n");
        return 0;
    }
       .
       .
       printf("Please input the pulse:\n"
       scanf("%d",pulse); 
       if(ioctl(fileno,SET_PULSE,pulse)<0){
          perror("ioctl error");
          exit(1);
       }      
        .
        .
  这里我们一定要注意的是data 和pulse的数据类型一定要与SET_PULSE _IOW(MOTOR_MAGIC,  1,int)中定义的int类型严格一致，即使是unsigned int 和int类型之间也是有很大差别的，我就是因为设定了unsigned int类型的data和pulse却使用SET_PULSE _IOW(MOTOR_MAGIC,  1,int)搞了我两三天才搞明白。 再有就是ioctl函数的声明一定要与 static int motor_ioctl(struct inode *inode,struct file *filp,unsigned int cmd,unsigned long arg);相一致，我刚开始就是定义错了，也是搞了我好长时间才明白。因为内核非常的相信你，它不会检查你的IOTCL定义有没有问题，它只负责把你的IOCTL函数映射到驱动的ioctl操作上。其中inode和filp对应应用程序传递的文件描述符，这和传递给open方法的参数一样，参数cmd 由用户空间不经修改的传递给驱动程序，可选的arg参数无论用户空间传递的是指针还是值，它都以unsigned long的形式传递给驱动程序。

  还有就是我在驱动中明明是用的是使用地址的copy_from_usr函数，但用户程序却只能传递值．搞了半天最后才知道，原来我的用户程序中的scanf(x)，'x'没有加'&'符号，所以这时从终端把读到的数据写到了'x'所代表的地址处，也就是说现在'x'所代表的地址正是所读入的数据．呵呵，总结出的经验就是－－－－－＞对库函数的参数类型一定要搞清楚.