linux驱动file_operations结构体的ioctl函数

最近太忙了，一直没有更新博客，虽然是个搬运工，但是写博客是督促自己学习的一个过程，当然了也希望能够帮助到更多的人。话不多说了下面讲一下file_operations结构体的ioctl函数的坑。顺便写file_operations结构体的ioctl函数的一些分析。

ioctl函数用途：

控制I/O设备，传入的参数可以为多个 每一个设备都有对应的设备文件 ，通过程序与设备文件交互即可实现与外围设备交互。

ioctl函数原型：
ioctl相关函数原型介绍：（在应用程序中）

int  ioctl(int fd, unsigned long cmd, ...)

参数1 fd：文件操作符

参数2 cmd：交互协议，设备驱动将根据 cmd 执行对应操作

参数3 …：可变参数 arg

在驱动程序中：

long (*unlocked_ioctl) (struct file *filp, unsigned int cmd, unsigned long arg);
long (*compat_ioctl) (struct file *filp, unsigned int cmd, unsigned long arg);

有坑，很大~

unlocked_ioctl，顾名思义，应该在无大内核锁（BKL）的情况下调用；compat_ioctl，compat 全称
compatible（兼容的），主要目的是为 64 位系统提供 32 位 ioctl 的兼容方法，也是在无大内核锁的情况下调用。在字符设备驱动开发中，一般情况下只要实现 unlocked_ioctl 函数即可。

---

但是在64位的系统上，unlocked_ioctl调用不到底层驱动函数的。所以64位的系统上使用compatible。

---

ioctl 用户与驱动之间的协议：
前文提到 ioctl 方法第二个参数 cmd 为用户与驱动的 “协议”，理论上可以为任意 int 型数据，可以为 0、1、2、3……，但是为了确保该 “协议” 的唯一性，ioctl 命令应该使用更科学严谨的方法赋值，在linux中，提供了一种 ioctl 命令的统一格式，将 32 位 int 型数据划分为四个位段，如下图所示：
dir（direction）：

ioctl 命令访问模式（数据传输方向），占据 2 bit，可以为
_IOC_NONE、_IOC_READ、_IOC_WRITE、_IOC_READ | _IOC_WRITE，分别指示了四种访问模式：无数据、读数据、写数据、读写数据。

type（device type）:

是个0-0xff的数或者一个字符，占8bit。这个数是用来区分不同的驱动的，像设备号一样，内核有一个文档(Documentation/ioctl/ioctl-number.txt)给出一些推荐的或者已经被使用的幻数。
nr（number），命令编号/序数，8 bit，取值范围 0~255，如果定义了多个 ioctl 命令，通常从 0 开始编号递增。

size:

涉及到 ioctl 函数 第三个参数 arg ，占据 13bit 或者 14bit（体系相关，arm 架构一般为 14 位），指定了 arg
的数据类型及长度，只需要填参数的类型，如int，函数就会帮你检测类型的正确性然后赋值sizeof(int)。

linux为了方便，会使用宏 _IOC() 衍生的接口来直接定义 ioctl 命令，函数原型如下所示：

#define _IO(type,nr)    _IOC(_IOC_NONE,(type),(nr),0)
#define _IOR(type,nr,size)  _IOC(_IOC_READ,(type),(nr),(_IOC_TYPECHECK(size)))
#define _IOW(type,nr,size)  _IOC(_IOC_WRITE,(type),(nr),(_IOC_TYPECHECK(size)))
#define _IOWR(type,nr,size) _IOC(_IOC_READ|_IOC_WRITE,(type),(nr),(_IOC_TYPECHECK(size)))

_IO：       定义不带参数的 ioctl 命令
_IOW：      定义带写参数的 ioctl 命令（copy_from_user）
_IOR：      定义带读参数的ioctl命令（copy_to_user）
_IOWR：     定义带读写参数的 ioctl 命令

ioctl相关函数使用：
底层驱动中：

#define CLOSE_CMD           _IO(0XEF, 1)           //关闭命令               
#define OPEN_CMD            _IO(0XEF, 2)          //打开命令             
#define SETPERIOD_CMD       _IOW(0xEF, 3, int)    //设置周期

static const struct file_operations timerdev_fops = {
    .owner		=	THIS_MODULE,
	.open		=	timer_open,
    .compatible_ioctl = timer_ioctl,
	.release	=	timer_release,
};

static long timer_ioctl(struct file *filp, unsigned int cmd, unsigned long arg)
{
	switch (cmd) {
	case CLOSE_CMD: 
		break;
	case OPEN_CMD:
		break;
	case SETPERIOD_CMD:
		break;
	}
	return ret;
}

在应用层上：

#define CLOSE_CMD           _IO(0XEF, 1)           //关闭命令               
#define OPEN_CMD            _IO(0XEF, 2)          //打开命令             
#define SETPERIOD_CMD       _IOW(0xEF, 3, int)    //设置周期

/* 循环读取 */
    while(1) {
        printf("Input CMD:");
        ret = scanf("%d", &cmd);
        if(ret !=1 ) {
            gets(str);  /* 防止卡死 */
        }

        if(cmd == 1) {          /* 关闭 */
            ioctl(fd, CLOSE_CMD, &arg);  
        } else if(cmd == 2) {   /* 打开 */
            ioctl(fd, OPEN_CMD, &arg); 
        } else if(cmd == 3) {    /* 设置周期 */
            printf("Input Timer period:");
            ret = scanf("%d", &arg);
            if(ret !=1 ) {
                gets(str);
            }
            ioctl(fd, SETPERIOD_CMD, &arg); 
        }
    }

过程分析：

应用层通过一个file_operations
结构体中的compat_ioctl实现与驱动程序中的timer_ioctl函数联系上的。在应用程序中给ioctl函数传递cmd等参数，此时cmd能够通过compat_ioctl传递给驱动程序中的timer_ioctl函数，该函数接收到cmd等参数之后就可以进行一系列的操作。具体执行什么操作，是由自己决定的，也即看我们想要这些cmd分别代表什么意思。