接下来要说的内容是书中的《高级字符驱动程序操作》章节。本章的内容比较长，所以分多节介绍。本节主要介绍的是其中的ioctl操作。

ioctl的功能

对于一个设备，除了具有读取和写入功能之外，还需要通过驱动程序执行各种类型的硬件控制，而ioctl就是用于设备控制的接口。

在用户空间中，ioctl系统调用的原型如下：

int ioctl(int fd, unsignde long cmd, ...);

参数中最后的三个点(...)一般情况下用来表示的是可变数目的参数表。但在这种情况下不是作为这个作用使用，而是为了防止编译器在编译过程中进行类型检查。即该方法只有三个变量，第三个变量不做类型要求，其内容取决于第二个变量cmd需要完成的控制命令。

在驱动程序中，ioctl方法的原型如下：

int (*ioctl) (struct inode *inode, struct file *filp,
        unsigned int cmd, unsigned long arg);

前面两个参数在之前有说明过，这里就不再说明了。下面对于后面两个参数进行说明。

• cmd参数：该参数由用户控件不经过修改地传递给驱动程序
• arg参数：用户程序不论传递的是整数还是指针，都会以unsigned long的形式传递给驱动程序。

介绍到这里，我们可以想到ioctl的用法：预先定义一系列的命令（cmd），例如命令0用于控制led开关、命令1用于清空缓冲区大小、命令2用于重新设置缓冲区大小；用户空间通过ioctl系统调用发送相关命令cmd和参数arg到驱动程序中；驱动程序中实现ioctl接口，在其中通过switch来区分命令，然后执行相关操作，例如接收到0命令，参数为1则控制硬件打开led等，参数为0则关闭led等等。

ioctl的命令编号

就和我上面举例的ioctl用法，很多人本能的想到了从0或者1开始来进行命令编号，但这种命令编号方式存在问题：对于错误的设备使用正确的命令，即可能对某个设备无意间执行意想不到的操作。

为了解决这个问题，就要求命令编号在系统范围内是唯一的。

目前，使用4个字段来定义一个命令编号：

• 幻数，8位宽（_IOC_TYPEBITS)，选择一个号码并在整个驱动程序中使用这个号码
• 序数，8位宽（_IOC_NRBITS)，顺序编号
• 方向，2位宽(_IOC_DIRBITS)，用于定义数据传输的方向（_IOC_NONE、_IOC_READ、_IOC_WRITE、_IOC_READ | _IOC_WRITE）
• 数据大小，14位宽(_IOC_SIZEBITS)，定义传输数据的大小

在<linux/ioctl.h>头文件中，包含了以下一些宏，用于创建命令编号或者解开命令编号的位字段：

• _IO(type, nr) 创建无参数的命令编号
• _IOR(type, nr, datatype) 创建从驱动中读取数据的命令编号
• _IOW(type, nr, datatype) 创建写入数据的命令编号
• _IOWR(type, nr, datatype) 创建双向传输的命令编号
• _IOC_DIR(nr) 获取命令编号中的方向
• _IOC_TYPE(nr) 获取命令编号的幻数
• _IOC_NR(nr) 获取命令编号中的序号
• _IOC_SIZE(nr) 获取命令编号中的数据大小

后面的例子中会用到上面宏来创建命令编号。

ioctl实例

本节的实例基于之前的scull_lock实例上进行修改。拷贝之前的代码，并将设备名称命名为scull_ioctl。实例的全部源码位于：https://gitee.com/Quehehe/LinuxDeviceDriver

驱动代码

在之前的基础上，我们实现设备的scull_ioctl方法，如下：

long scull_ioctl (struct file *filp, unsigned int cmd, unsigned long data)
{
    struct scull_lock_dev *dev = filp->private_data;
    int result = 0;

    switch (cmd)
    {
    case IOCTL_CMD_CLEAR_DATA:
        dev->data_length = 0;
        up(&dev->data_sem); /* 释放信号量，使读取过程继续 */
        printk(KERN_ALERT "clear data cmd received!\n");
        break;
    case IOCTL_CMD_RELEASE_SEM:
        up(&dev->data_sem); /* 释放信号量，使读取过程继续 */
        printk(KERN_ALERT "release sem cmd received!\n");
        break;
    default:
        result = -EINVAL;
        printk(KERN_ALERT "invalid cmd received!\n");
        break;
    }
    return result;
}

其中有两个命令，分别为IOCTL_CMD_CLEAR_DATA和IOCTL_CMD_RELEASE_SEM，这两个命令定义在头文件中，如下：

#define IOCTL_MAGIC 'q' /* 定义幻数为'q' */
#define IOCTL_CMD_CLEAR_DATA    _IO(IOCTL_MAGIC, 1) /* 定义一个命令，用于清空数据 */
#define IOCTL_CMD_RELEASE_SEM   _IO(IOCTL_MAGIC, 2) /* 定义一个命令，用于释放信号量 */

IOCTL_CMD_CLEAR_DATA命令用于清空当前数据，IOCTL_CMD_RELEASE_SEM用于释放信号量，使得读取线程能够继续执行。

用户空间可执行程序

为了通过系统调用来调用驱动的ioctl方法，本节还编写了ioctl_test.c文件，该文件不是设备的驱动代码，而是用于编译生成用户空间的可执行程序，通过该程序来调用ioctl。部分代码如下：

#define IOCTL_MAGIC 'q' /* 定义幻数为'q' */
#define IOCTL_CMD_CLEAR_DATA    _IO(IOCTL_MAGIC, 1) /* 定义一个命令，用于清空数据 */
#define IOCTL_CMD_RELEASE_SEM   _IO(IOCTL_MAGIC, 2) /* 定义一个命令，用于释放信号量 */

int main(int argc, char *argv[])
{
    char *path = "/dev/scull_ioctl0";
    ......
    fd = open(path, O_WRONLY);
    ......
    cmd = atoi(argv[1]);
    if(cmd == 0) {
        cmd = IOCTL_CMD_CLEAR_DATA;
        printf("clear data cmd send!\n");
    }
    else if(cmd == 1) {
        cmd = IOCTL_CMD_RELEASE_SEM;
        printf("release sem cmd send!\n");
    }
    else {
        cmd = -1;
        printf("invalid cmd send!\n");
    }
    ioctl(fd, cmd, 0);
  	......
    return 0;
}

开头的宏定义的命令编号需要与驱动代码中的一致，否则命令不能够被驱动代码识别。

该文件可以通过gcc指令编译生成可执行文件：

gcc -o #define IOCTL_MAGIC 'q' /* 定义幻数为'q' */
#define IOCTL_CMD_CLEAR_DATA    _IO(IOCTL_MAGIC, 1) /* 定义一个命令，用于清空数据 */
#define IOCTL_CMD_RELEASE_SEM   _IO(IOCTL_MAGIC, 2) /* 定义一个命令，用于释放信号量 */

int main(int argc, char *argv[])
{
    char *path = "/dev/scull_ioctl0";
    int fd = -1;
    int cmd = -1;
    
    if(argc != 2) {
        printf("arguments count error!\n");
        return -1;
    }

    fd = open(path, O_WRONLY);
    if(fd < 0) {
        printf("open dev failed!\n");
        return -1;
    }
    cmd = atoi(argv[1]);
    if(cmd == 0) {
        cmd = IOCTL_CMD_CLEAR_DATA;
        printf("clear data cmd send!\n");
    }
    else if(cmd == 1) {
        cmd = IOCTL_CMD_RELEASE_SEM;
        printf("release sem cmd send!\n");
    }
    else {
        cmd = -1;
        printf("invalid cmd send!\n");
    }

    ioctl(fd, cmd, 0);

    close(fd);
    return 0;
}

执行该命令后，在同目录下会生成一个名为ioctl_test的可执行文件。

驱动测试

完成上面的工作后，我们会得到一个ioctl_test的可执行程序。

在项目的根目录下执行make命令生成模块的ko文件：scull_ioctl.ko，将该模块加载到系统中。

使用sudo执行目录下的cat_scull_ioctl.sh脚本，等待读取数据。由于我们是基于scull_lock设备来编写的，所以scull_lock设备有的功能，该设备也有。我们先试着往设备(/dev/scull_ioctl0)使用echo写入数据，结果如下：

右侧为等待读取的结果，左边为echo操作，可以看到，echo完后，读取结果立刻打印echo的值，说明驱动代码运行正常。

接下来就是测试ioctl了。

首先对于IOCTL_CMD_RELEASE_SEM命令进行测试，该命令作用是释放一个信号量，所以读取线程会从等待中唤醒继续执行，打印出上一次的结果，让我们看看结果是否和想象中的一样，执行以下代码：

./ioctl_test 1

执行结果如下：

可以看到，红色圈出的部分为之前输入的结果，即读取线程再次把之前的结果打印了遍，符合我们的预期。同时dmesg也打印了相关的log表示接收到了相关的命令：

然后对IOCTL_CMD_CLEAR_DATA命令进行测试，该命令会清除数据，所以读取线程不会返回内容。执行该命令后，如果再执行IOCTL_CMD_RELEASE_SEM命令，读取线程也不会打印之前的结果了。执行该命令的代码如下：

./ioctl_test 0

执行结果如下：

可以看到，没有读取线程没有打印新的内容，但通过dmesg的log我们可以知道读取线程是有返回一次的：

此时，如果我们在执行IOCTL_CMD_RELEASE_SEM，看看是什么情况：

我们多次执行了IOCTL_CMD_RELEASE_SEM命令，但还是没有打印新的信息，从dmesg的log中可以看出读取线程是有返回的，只是数据已经被清除了：

由此可知，ioctl功能正常。

至此，ioctl介绍完成，全部代码见：https://gitee.com/Quehehe/LinuxDeviceDriver