Linux设备驱动---ioctl函数

序言
设备驱动程序的一个基本功能就是管理和控制设备，同时为用户应用程序提供管理和控制设备的接口。我们前面的“Hello World”驱动程序已经可以提供读写功能了，在这里我们将扩展我们的驱动以支持设备控制接口，在Linux中这个接口是通过ioctl函数来实现的。

设备控制接口（ioctl 函数）
回想一下我们在字符设备驱动中介绍的struct file_operations结构，这里我们将介绍一个新的方法：

int (*ioctl) (struct inode *, struct file *, unsigned int, 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：

ioct命令的参数大小（这个参数指的是ioctl函数中的arg，通过这个参数，驱动中的ioctl函数可以和应用程序中的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)

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

• ioctl返回值

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

• ioctl参数

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

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,
};

后记
到这里我们已经向您展示了Linux内核驱动程序的设备控制接口（ioctl接口），详细的介绍了它的使用，并给出了一个实际的例子，尽管它很简单，但已经足够了。到这里你可以写出一个标准的Linux驱动程序了。不过这里还有个问题，那就是我们不得不从/proc/devices文件里读取设备号然后手动创建设备节点。我们是否可以让系统自动的创建这个设备节点文件呢？当然可以。不过在那之前，我们必须深入了解Linux的设备驱动模型。后面的章节我们就详细的介绍Linux的设备驱动模型及Hotplug机制。

例子：

Linux设备驱动之Ioctl控制

　　大部分驱动除了需要具备读写设备的能力之外，还需要具备对硬件控制的能力。

　一、在用户空间，使用ioctl系统调用来控制设备，原型如下：

int ioctl(int fd,unsigned long cmd,...);/*fd:文件描述符cmd:控制命令...:可选参数:插入*argp，具体内容依赖于cmd*/

　　用户程序所作的只是通过命令码告诉驱动程序它想做什么，至于怎么解释这些命令和怎么实现这些命令，这都是驱动程序要做的事情。

二、驱动ioctl方法：

int (*ioctl) (struct inode *inode,struct file *filp,unsigned int cmd,unsigned long arg);/*inode与filp两个指针对应于应用程序传递的文件描述符fd，这和传递open方法的参数一样。cmd 由用户空间直接不经修改的传递给驱动程序arg 可选。*/

　　在驱动程序中实现的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) //双向传送

　　定义命令例子:

#define MEM_IOC_MAGIC 'm' //定义类型#define MEM_IOCSET _IOW(MEM_IOC_MAGIC,0,int)#define MEM_IOCGQSET _IOR(MEM_IOC_MAGIC, 1, int)

 

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 longarg)　　中的arg传递；
　　如果arg是一个整数，可以直接使用；
　　如果是指针，我们必须确保这个用户地址是有效的，因此，使用之前需要进行正确检查。
　　内部有检查的，不需要检测的：

copy_from_usercopy_to_userget_userput_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实例分析：

（1）memdev.h：

View Code

/*mem设备描述结构体*/struct mem_dev                                     {                                                          char *data;                        unsigned long size;       };/* 定义幻数 */#define MEMDEV_IOC_MAGIC  'k'/* 定义命令 */#define MEMDEV_IOCPRINT   _IO(MEMDEV_IOC_MAGIC, 1)#define MEMDEV_IOCGETDATA _IOR(MEMDEV_IOC_MAGIC, 2, int)#define MEMDEV_IOCSETDATA _IOW(MEMDEV_IOC_MAGIC, 3, int)#define MEMDEV_IOC_MAXNR 3#endif /* _MEMDEV_H_ */

（2）memdev.c：（驱动程序）

View Code

static int mem_major = MEMDEV_MAJOR;module_param(mem_major, int, S_IRUGO);struct mem_dev *mem_devp; /*设备结构体指针*/struct cdev cdev; /*文件打开函数*/int mem_open(struct inode *inode, struct file *filp){    struct mem_dev *dev;        /*获取次设备号*/    int num = MINOR(inode->i_rdev);    if (num >= MEMDEV_NR_DEVS)             return -ENODEV;    dev = &mem_devp[num];        /*将设备描述结构指针赋值给文件私有数据指针*/    filp->private_data = dev;        return 0; }/*文件释放函数*/int mem_release(struct inode *inode, struct file *filp){  return 0;}/*IO操作*/int memdev_ioctl(struct inode *inode, struct file *filp,                 unsigned int cmd, unsigned long arg){    int err = 0;    int ret = 0;    int ioarg = 0;        /* 检测命令的有效性 */    if (_IOC_TYPE(cmd) != MEMDEV_IOC_MAGIC)         return -EINVAL;    if (_IOC_NR(cmd) > MEMDEV_IOC_MAXNR)         return -EINVAL;    /* 根据命令类型，检测参数空间是否可以访问 */    if (_IOC_DIR(cmd) & _IOC_READ)        err = !access_ok(VERIFY_WRITE, (void *)arg, _IOC_SIZE(cmd));    else if (_IOC_DIR(cmd) & _IOC_WRITE)        err = !access_ok(VERIFY_READ, (void *)arg, _IOC_SIZE(cmd));    if (err)         return -EFAULT;    /* 根据命令，执行相应的操作 */    switch(cmd) {      /* 打印当前设备信息 */      case MEMDEV_IOCPRINT:          printk("<--- CMD MEMDEV_IOCPRINT Done--->\n\n");        break;            /* 获取参数 */      case MEMDEV_IOCGETDATA:         ioarg = 1101;        ret = __put_user(ioarg, (int *)arg);        break;            /* 设置参数 */      case MEMDEV_IOCSETDATA:         ret = __get_user(ioarg, (int *)arg);        printk("<--- In Kernel MEMDEV_IOCSETDATA ioarg = %d --->\n\n",ioarg);        break;      default:          return -EINVAL;    }    return ret;}/*文件操作结构体*/static const struct file_operations mem_fops ={  .owner = THIS_MODULE,  .open = mem_open,  .release = mem_release,  .ioctl = memdev_ioctl,};/*设备驱动模块加载函数*/static int memdev_init(void){  int result;  int i;  dev_t devno = MKDEV(mem_major, 0);  /* 静态申请设备号*/  if (mem_major)    result = register_chrdev_region(devno, 2, "memdev");  else  /* 动态分配设备号 */  {    result = alloc_chrdev_region(&devno, 0, 2, "memdev");    mem_major = MAJOR(devno);  }      if (result < 0)    return result;  /*初始化cdev结构*/  cdev_init(&cdev, &mem_fops);  cdev.owner = THIS_MODULE;  cdev.ops = &mem_fops;    /* 注册字符设备 */  cdev_add(&cdev, MKDEV(mem_major, 0), MEMDEV_NR_DEVS);     /* 为设备描述结构分配内存*/  mem_devp = kmalloc(MEMDEV_NR_DEVS * sizeof(struct mem_dev), GFP_KERNEL);  if (!mem_devp)    /*申请失败*/  {    result =  - ENOMEM;    goto fail_malloc;  }  memset(mem_devp, 0, sizeof(struct mem_dev));    /*为设备分配内存*/  for (i=0; i < MEMDEV_NR_DEVS; i++)   {        mem_devp[i].size = MEMDEV_SIZE;        mem_devp[i].data = kmalloc(MEMDEV_SIZE, GFP_KERNEL);        memset(mem_devp[i].data, 0, MEMDEV_SIZE);  }      return 0;  fail_malloc:   unregister_chrdev_region(devno, 1);    return result;}/*模块卸载函数*/static void memdev_exit(void){  cdev_del(&cdev);   /*注销设备*/  kfree(mem_devp);     /*释放设备结构体内存*/  unregister_chrdev_region(MKDEV(mem_major, 0), 2); /*释放设备号*/}MODULE_AUTHOR("David Xie");MODULE_LICENSE("GPL");module_init(memdev_init);module_exit(memdev_exit);

(3)app-ioctl.c（应用程序）

#include <stdio.h>#include<sys/types.h>#include<sys/stat.h>#include<fcntl.h>#include "memdev.h"  /* 包含命令定义 */int main(){    int fd = 0;    int cmd;    int arg = 0;    char Buf[4096];            /*打开设备文件*/    fd = open("/dev/memdev0",O_RDWR);    if (fd < 0)    {        printf("Open Dev Mem0 Error!\n");        return -1;    }        /* 调用命令MEMDEV_IOCPRINT */    printf("<--- Call MEMDEV_IOCPRINT --->\n");    cmd = MEMDEV_IOCPRINT;    if (ioctl(fd, cmd, &arg) < 0)        {            printf("Call cmd MEMDEV_IOCPRINT fail\n");            return -1;    }            /* 调用命令MEMDEV_IOCSETDATA */    printf("<--- Call MEMDEV_IOCSETDATA --->\n");    cmd = MEMDEV_IOCSETDATA;    arg = 2007;    if (ioctl(fd, cmd, &arg) < 0)        {            printf("Call cmd MEMDEV_IOCSETDATA fail\n");            return -1;    }        /* 调用命令MEMDEV_IOCGETDATA */    printf("<--- Call MEMDEV_IOCGETDATA --->\n");    cmd = MEMDEV_IOCGETDATA;    if (ioctl(fd, cmd, &arg) < 0)        {            printf("Call cmd MEMDEV_IOCGETDATA fail\n");            return -1;    }    printf("<--- In User Space MEMDEV_IOCGETDATA Get Data is %d --->\n\n",arg);            close(fd);    return 0;    }

参考：http://www.cnblogs.com/noaming1900/archive/2010/10/20/1856581.html
            http://www.cnblogs.com/geneil/archive/2011/12/04/2275372.html