设备控制接口（ioctl 函数）

设备驱动程序的一个基本功能就是管理和控制设备，同时为用户应用程序提供管理和控制设备的接口
设备控制接口（ioctl 函数）：

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

-->   static int second_driver_ioctl(struct inode *inode, struct file *file, unsigned int cmd, unsigned long arg)

这是驱动程序设备控制接口函数（ioctl函数）的内核原型定义，struct inode * 和struct file* 描述了操作的文件，unsigned int 描述了ioctl命令号，这是一个重要的参数，我们稍后会对它做详细介绍。最后一个参数是unsigned long数据类型，描述了ioctl命令可能带有的参数，它可能是一个整数或指针数据。

• ioctl命令号

ioctl命令号是这个函数中最重要的参数，它描述的ioctl要处理的命令。Linux中使用一个32位的数据来编码ioctl命令，它包含四个部分：dir：type：nr：size。

• dir：

代表数据传输的方向，占2位，可以是_IOC_NONE（无数据传输，0U），_IOC_WRITE（向设备写数据，1U）或_IOC_READ（从设备读数据，2U）或他们的逻辑或组合，当然只有_IOC_WRITE和_IOC_READ的逻辑或才有意义。

• type：

描述了ioctl命令的类型，8位。每种设备或系统都可以指定自己的一个类型号，ioctl用这个类型来表示ioctl命令所属的设备或驱动。一般用ASCII码字符来表示，如 'a'。

• nr：

ioctl命令序号，一般8位。对于一个指定的设备驱动，可以对它的ioctl命令做一个顺序编码，一般从零开始，这个编码就是ioctl命令的序号。

• size：

ioctl命令的参数大小，一般14位。ioctl命令号的这个数据成员不是强制使用的，你可以不使用它，但是我们建议你指定这个数据成员，通过它我们可以检查用户空间数据的大小以避免错误的数据操作，也可以实现兼容旧版本的ioctl命令。

我们可以自己来直接指定一个ioctl命令号，它可能仅仅是一个整数集，但Linux中的ioctl命令号都是有特定含义的，因此通常我们不推荐这么做。其实Linux内核已经提供了相应的宏来自动生成ioctl命令号：

_IO(type,nr)
_IOR(type,nr,size)
_IOW(type,nr,size)
_IOWR(type,nr,size)

宏_IO用于无数据传输，宏_IOR用于从设备读数据，宏 _IOW用于向设备写数据，宏_IOWR用于同时有读写数据的IOCTL命令。相对的，Linux内核也提供了相应的宏来从ioctl命令号种解码相应的域值：

_IOC_DIR(nr)
_IOC_TYPE(nr)
_IOC_NR(nr)
_IOC_SIZE(nr)

这些宏都定义在头文件中（一般 在头文件中）。一般在使用中，先指定各个IOCTL命令的顺序编号（一般从0开始），然后根据使用的环境用这 些宏来自动生成IOCTL命令号，在后面的例子中你可以了解实际的使用场景。

• ioctl返回值

ioctl函数的返回值是一个整数类型的值，如果命令执行成功，ioctl返回零，如 果出现错误，ioctl函数应该返回一个负值。这个负值会作为errno值反馈给调用此ioctl的用户空间程序。关于返回值的具体含义，请参 考和头文件。

• ioctl参数

这里有必要说明一下ioctl命令的参数，因为它很容易犯错误。如果ioctl命令参数仅仅是一个整数，那么事情很简单了，我们可以在ioctl函数中直接使用它。但如果它是一个指针数据，那么使用上就要小心了。首先要说明这个参数是有用户空间的程序传递过来的，因此这个指针指向的地址是用户空间地址，在Linux中，用户空间地址是一个虚拟地址，在内核空间是无法直接使用它的。为了解决 在内核空间使用用户空间地址的数据，Linux内核提供了以下函数，它们用于在内核空间访问用户空间的数据，定义 在头文件中：

unsigned long __must_check copy_to_user(void __user *to,
const void *from, unsigned long n);
unsigned long __must_check copy_from_user(void *to,
const void __user *from, unsigned long n);

copy_from_user和copy_to_user一般用于复杂的或大数据交换，对于简单的数据类型，如int或char，内核提供了简单的宏来实现这个功能：

#define get_user(x,ptr)
#define put_user(x,ptr)

其中，x是内核空间的简单数据类型地址，ptr是用户空间地址指针。
我们需要牢记：在内核中是无法直接访问用户空间地址数据的。因此凡是从用户空间传递过来的指针数据，务必使用内核提供的函数来访问它们。

这里有必要再一次强调的是，在内核模块或驱动程序的编写中，我们强烈建议你使用内核提供的接口来生成并操作ioctl命令号，这样可以对命令号赋予特定的含义，使我们的程序更加的健壮；另一方面也可以提高程序的可移植性。

举例
好了，是时候举个例子了。我们将扩展我们的helloworld驱动添加ioctl函数。

首先，我们添加一个头文件来定义ioctl接口需要用到的数据（hello.h）：

#ifndef _HELLO_H
#define _HELLO_H
#include <asm/ioctl.h>
#define MAXBUF 20
typedef struct _buf_data{
int size;
char data [MAXBUF];
}buf_data;

#define HELLO_IOCTL_NR_BASE            0
#define HELLO_IOCTL_NR_SET_DATA (HELLO_IOCTL_NR_BASE + 1)
#define HELLO_IOCTL_NR_MAX (HELLO_IOCTL_NR_GET_BUFF + 1)

#define HELLO_IOCTL_SET_DATA           _IOR('h', HELLO_IOCTL_NR_SET_DATA, buf_data*)

#endif

然后为我们的驱动程序添加ioctl接口hello_ioctl，并实现这个函数：

static int hello_ioctl (struct inode *inode, struct file *filp,unsigned int cmd, unsigned long arg)
{
    int cmd_nr;
    int err;
    buf_data buff;

    err = 0;
    cmd_nr = _IOC_NR (cmd);

    switch (cmd_nr){
        case HELLO_IOCTL_NR_SET_DATA:
            if (copy_from_user(&buff, (unsigned char *)arg, sizeof(buf_data)))
            {
                err = -ENOMEM;
                goto error;
            }
            memset(hello_buf, 0, sizeof(hello_buf));
            memcpy(hello_buf, buff.data, buff.size);
        break;

        default:
            printk("hello_ioctl: Unknown ioctl command (%d)\n", cmd);
        break;
    }

    error:
    return err;
}

static struct file_operations hello_fops = {
    .read = hello_read,
    .write = hello_write,
    .open = hello_open,
    .ioctl = hello_ioctl,
    .release = hello_release,
};

---

---

---

一个控制LED的例子：（arg 传递指针数据 或者直接传递参数）
测试程序：LED_Test.c

#include <sys/types.h>
#include <sys/stat.h>
#include <fcntl.h>
#include <stdio.h>

int main(int argc, char * argv[])
{
    int fd;
    int cmd, led_num;

    fd = open("/dev/Button", O_RDWR);
    if(fd < 0)
        printf("can't open file \n");

    if(argc < 3)
    {
        printf("Usage: \n");
        printf("%s on|off 0|1|2\n", argv[0]);
        return 0;
    }

    if(strcmp(argv[1], "on") == 0)
    {
        cmd = 1;
    }
    else
        cmd = 0;

    if(strcmp(argv[2], "0") == 0)
        led_num = 0;
    else if(strcmp(argv[2], "1") == 0)
        led_num = 1;
    else if (strcmp(argv[2], "2") == 0)
        led_num = 2;
    else if(strcmp(argv[2], "all") == 0)
        led_num = 3;


    // 1. 利用指针传递数据。
    ioctl(fd, cmd, &led_num);

    // 2. 可以改为参数传递数据
    ioctl(fd, cmd, led_num);


    return 0;
}

驱动函数：LED_Driver.c

static int second_driver_ioctl(struct inode *inode, struct file *file, unsigned int cmd, unsigned long arg)
{
    // 1. 利用指针传递参数的做法
    unsigned int *ptr = (unsigned int *)arg;   // 把指针里的数据读出来
    unsigned int led_num = *ptr;

    // 2. 直接传递参数的做法
    unsigned int led_num = (unsigned int)arg;

    printk("arg: %d \n", led_num);
    switch(cmd)
    {
        case LED_ON:

            if(led_num == 3)
                ALL_LED_ON();
            else
                LED_ON_NUM(led_num);

        break;

        case LED_OFF:
            if(led_num == 3)
                ALL_LED_OFF();
            else
                LED_OFF_NUM(led_num);
        break;

        default:
        break;
    }


    return 0;
}