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：

#ifndef _MEMDEV_H_#define _MEMDEV_H_#include <linux/ioctl.h>#ifndef MEMDEV_MAJOR#define MEMDEV_MAJOR 0   /*預設的mem的主裝置號*/#endif#ifndef MEMDEV_NR_DEVS#define MEMDEV_NR_DEVS 2    /*裝置數*/#endif#ifndef MEMDEV_SIZE#define MEMDEV_SIZE 4096#endif

/*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：（驅動程式）

#include <linux/module.h>#include <linux/types.h>#include <linux/fs.h>#include <linux/errno.h>#include <linux/mm.h>#include <linux/sched.h>#include <linux/init.h>#include <linux/cdev.h>#include <asm/io.h>#include <asm/system.h>#include <asm/uaccess.h>#include "memdev.h"

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