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 long arg) 中的arg傳遞;
如果arg是一個整數,可以直接使用;
如果是指針,我們必須確保這個用戶地址是有效的,因此,使用之前需要進行正確檢查。
內部有檢查的,不需要檢測的:
copy_from_user copy_to_user get_user put_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:
/*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:(驅動程序)
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; }