Linux驱动的ioctl函数简要说明

ioctl是设备驱动程序中对设备的I/O通道进行管理的函数。所谓对I/O通道进行管理，就是对设备的一些特性进行控制，例如串口的传输波特率、马达的转速、LED的开关控制等等。它的函数原型如下所示：
int ioctl(int fd, ind cmd, …)；
其中fd是用户程序打开设备时使用open函数返回的文件标示符，cmd是用户程序对设备的控制命令，至于后面的省略号，那是一些补充参数，一般最多一个，这个参数的有无和cmd的意义相关。 ioctl函数是文件结构中的一个属性分量，就是说如果你的驱动程序提供了对ioctl的支持，用户就可以在用户程序中使用ioctl函数来控制设备的I/O通道。

应用程序中的ioctl（系统IO的内容）:

int ioctl（int fd, int cmd, ...）

/*
fd对应于应用程序传递的文件描述符fd
cmd 由用户空间直接不经修改的传递给驱动程序
... 可选，就是要传递到kernel的参数，可以是结构体指针等内容。
*/

驱动程序中，对应的ioctl

struct file_operations {
struct module *owner;
int (*ioctl) (struct inode *inode, struct file *filep, unsigned int cmd, unsigned long args);
long (*unlocked_ioctl) (struct file *filep, unsigned int cmd, unsigned long args);
......
｝
/*
在驱动程序中，ioctl和unlocked_ioctl的区别:
在2.6.36以后linux的内核中，只支持unlocked_ioctl()，不支持ioctl（）。
2.6.35.7内核中，两个函数都可以使用。
*/

在驱动程序中实现的ioctl函数体内，实际上是有一个switch {case}结构，每一个case对应一个命令码，做出一些相应的操作。怎么实现这些操作，这是每一个程序员自己的事情，因为设备都是特定的。关键在于怎么样组织命令码，因为在ioctl中命令码是唯一联系用户程序命令和驱动程序支持的途径。

在Linux核心中是这样定义一个命令码的：

| 设备类型  | 序列号 |  方向 | 数据尺寸 |

|----------|--------|------|-------- |

| 8 bit　　 |  8 bit   | 2 bit |8~14 bit|

|----------|--------|------|-------- |

这样一来，一个命令就变成了一个整数形式的命令码。但是命令码非常的不直观，所以Linux Kernel中提供了一些宏，这些宏可根据便于理解的字符串生成命令码，或者是从命令码得到一些用户可以理解的字符串以标明这个命令对应的设备类型、设备序列号、数据传送方向和数据传输尺寸。

1、定义命令：
　　内核提供了一些宏来帮助定义命令：

//nr为序号，datatype为数据类型,如int
_IO(type, nr ) //没有参数的命令
_IOR(type, nr, datatype) //从驱动中读数据
_IOW(type, nr, datatype) //写数据到驱动
_IOWR(type,nr, datatype) //双向传送

以上几个宏的使用格式为：
_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() 编译命令。

2、实现命令：
　　定义好了命令，下一步就是要实现ioctl函数了，ioctl的实现包括三个技术环节：

1）返回值；
　　ioctl函数的实现是根据命令执行的一个switch语句，但是，当命令不能匹配任何一个设备所支持的 命令时，通常返回-EINVAL(非法参数)；
2）参数使用；
　　用户空间使用　　int ioctl(int fd,unsinged long cmd,…)　　时，…就是要传递的参数；
　　再通过内核空间使用　　int (*ioctl)(struct inode *inode, struct file *filp, unsigned int cmd, unsigned long arg)或者long (*unlocked_ioctl) (struct file *filep, unsigned int cmd, unsigned long args);　　中的arg传递；
　　如果arg是一个整数，可以直接使用；
　　如果是指针，我们必须确保这个用户地址是有效的，因此，使用之前需要进行正确检查。

内部有检查的，不需要检测的函数接口：

copy_from_user
copy_to_user
get_user
put_user

需要检测的函数接口：

__get_user
__put_user

检测函数access_ok（）:

static inline int access_ok(int type, const void *addr, unsigned long size)

/*
type :是VERIFY_READ 或者VERIFY_WRITE用来表明是读用户内存还是写用户内存;
addr:是要操作的用户内存地址;
size:是操作的长度。如果ioctl需要从用户空间读一个整数，那么size参数就等于sizeof(int)；

返回值：Access_ok返回一个布尔值：1，是成功（存取没问题）；0，是失败，ioctl返回-EFAULT；
*/

3）命令操作；

switch(cmd)
{
 case:
 ... ...
}

如果不用ioctl的话，也可以实现对设备I/O通道的控制，例如，我们可以在驱动程序中实现write的时候检查一下是否有特殊约定的数 据流通过，如果有的话，那么后面就跟着控制命令（一般在socket编程中常常这样做）。但是如果这样做的话，会导致代码分工不明，程序结构混乱，程序员 自己也会头昏眼花的。所以，我们就使用ioctl来实现控制的功能。要记住，用户程序所作的只是通过命令码(cmd)告诉驱动程序它想做什么，至于怎么解释这些命令和怎么实现这些命令，这都是驱动程序要做的事情。

ioctl其实没有什么很难的东西需要理解，关键是理解cmd命令码是怎么在用户程序里生成并在驱动程序里解析的，程序员最主要的工作量在switch{case}结构中，因为对设备的I/O控制都是通过这一部分的代码实现的。