linux ioctl简介
ioctl 是设备驱动程序中设备控制接口函数,一个字符设备驱动通常会实现设备打开、关闭、读、写等功能,在一些需要细分的情境下,如果需要扩展新的功能,通常以增设 ioctl() 命令的方式实现。
ioctl的函数定义如下:
int ioctl(int fd, int cmd, ...) ;
其中各个参数的定义及说明如下:
参数 | 说明 |
---|---|
fd | 文件描述符 |
cmd | 交互协议,设备驱动将根据 cmd 执行对应操作 |
… | 可变参数 arg,依赖 cmd 指定长度以及类型 |
下面举一个简单的例子来展示ioctl的调用过程。
#define dev "/dev/test"
#defile magic 'A'
#define CMD_TEST _IOW(magic, 0x01, int)
int ioctl_test() {
int ret = -1;
int fd = open(IOCTL_DEVICE_NAME, O_RDWR);
if(fd < 0)
{
printf("can not open test device: %s\n\n", strerror(errno));
return ret;
}
ret = ioctl(fd, CMD_TEST, 1);
if (ret < 0) {
printf("ioctl_test ioctl failed");
}
close(fd);
return ret;
}
ioctl cmd参数
ioctl() 函数上传送的变量 cmd 是应用程序用于区别设备驱动程序请求处理内容的值。cmd除了可区别数字外,还包含有助于处理的几种相应信息。 cmd的大小为 32位,共分 4 个域:
区域 | 大小 | 说明 |
---|---|---|
bit31~bit30 | 2位 | "区别读写" 区,作用是区分是读取命令还是写入命令 |
bit29~bit16 | 14位 | "数据大小"区,表示 ioctl() 中的 arg 变量传送的内存大小 |
bit15~bit08 | 8位 | "魔数"(也称为"幻数")区,这个值用以与其它设备驱动程序的 ioctl 命令进行区别 |
bit07~bit00 | 8位 | "区别序号" 区,是区分命令的命令顺序序号 |
其中"区别读写" 区
可能的值包括:
值 | 说明 |
---|---|
_IOC_NONE | (0值), 表示无数据传输 |
_IOC_READ | 读 |
_IOC_WRITE | 写 |
_IOC_READ _IOC_WRITE | (读和写)双向 |
针对上述4种不同的情况,内核提定义了 _IO() , _IOR() , IOW() 和 _IOWR()
这 4 个宏来辅助生成上面的 cmd。 这4个宏的使用格式为:
- _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() 编译命令。 比如 _IOR() 宏的定义是:
#define _IOR(type,nr,size) _IOC(_IOC_READ,(type),(nr),(_IOC_TYPECHECK(size)))
而 _IOC_TYPECHECK() 的定义正是:
#define _IOC_TYPECHECK(t) (sizeof(t))
设备驱动程序想要从传送的命令获取相应的值,就要使用下列宏函数:
_IOC_SIZE(cmd)
_IO 宏
该宏函数没有可传送的变量,只是用于传送命令。例如如下约定:
#define TEST_DRV_RESET _IO ('Q', 0)
此时,省略由应用程序传送的 arg
变量或者代入 0 。在应用程序的ioctl
中使用该宏时,arg
参数传入0,或者可以不传,如:
ioctl (dev, TEST_DEV_RESET, 0);
// 或者
ioctl (dev, TEST_DRV_RESET);
只作为命令使用时,没有必要判断出设备上数据的输出或输入。因此,设备驱动程序没有必要执行设备文件打开选项的相关处理。
_IOR 宏
该函数用于创建从设备读取数据的命令,例如可如下约定:
#define TEST_DEV_READ _IRQ('Q', 1, int)
这说明应用程序从设备读取数据的大小为 int 。下面宏用于判断传送到设备驱动程序的 cmd 命令的读写状态:
_IOC_DIR (cmd)
运行该宏时,返回值的类型如下:
返回值 | 含义 |
---|---|
_IOC_NONE | 无属性 |
_IOC_READ | 可读属性 |
_IOC_WRITE | 可写属性 |
_IOC_READ _IOC_WRITE | 可读,可写属性 |
使用该命令时,应用程序的 ioctl() 的 arg 变量值指定设备驱动程序上读取数据时的缓存(结构体)地址。
_IOW 宏
用于创建设备上写入数据的命令,其余内容与 _IOR 相同。通常,使用该命令时,ioctl() 的 arg 变量值指定设备驱动程序上写入数据时的缓存(结构体)地址。
_IOWR 宏
用于创建设备上读写数据的命令。其余内容与 _IOR 相同。通常,使用该命令时,ioctl() 的 arg 变量值指定设备驱动程序上写入或读取数据时的缓存 (结构体) 地址。