ioctl函数详解

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

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

[cpp]  view plain  copy

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

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

二、驱动ioctl方法：

[cpp]  view plain  copy

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

在驱动程序中实现的ioctl函数体内，实际上是有一个switch {case}结构，每一个case对应一个命令码，做出一些相应的操作。怎么实现这些操作，这是每一个程序员自己的事情，因为设备都是特定的。关键在于怎么样组织命令码，因为在ioctl中命令码是唯一联系用户程序命令和驱动程序支持的途径。

在Linux核心中是这样定义一个命令码的：
____________________________________

| 设备类型  | 序列号 |  方向  | 数据尺寸 |

| 8 bit　　  |  8 bit     | 2 bit   |  8~14 bit  |

　　这样一来，一个命令就变成了一个整数形式的命令码。但是命令码非常的不直观，所以Linux Kernel中提供了一些宏，这些宏可根据便于理解的字符串生成命令码，或者是从命令码得到一些用户可以理解的字符串以标明这个命令对应的设备类型、设备序列号、数据传送方向和数据传输尺寸。

1、定义命令：
　　内核提供了一些宏来帮助定义命令：

[cpp]  view plain  copy

1. //nr为序号，datatype为数据类型,如int  
2. _IO(type, nr ) //没有参数的命令  
3. _IOR(type, nr, datatype) //从驱动中读数据  
4. _IOW(type, nr, datatype) //写数据到驱动  
5. _IOWR(type,nr, datatype) //双向传送  
6.   
7. 　　定义命令例子:  
8.   
9. #define MEM_IOC_MAGIC 'm' //定义类型  
10. #define MEM_IOCSET _IOW(MEM_IOC_MAGIC,0,int)  
11. #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是一个整数，可以直接使用；
　　如果是指针，我们必须确保这个用户地址是有效的，因此，使用之前需要进行正确检查。
　　内部有检查的，

不需要检测的：

[cpp]  view plain  copy

1. copy_from_user  
2. copy_to_user  
3. get_user  
4. put_user  

需要检测 的：

[cpp]  view plain  copy

1. __get_user  
2. __put_user  

检测函数 access_ok（）:

[cpp]  view plain  copy

1. static inline int access_ok(int type, const void *addr, unsigned long size)  
2. /* 
3. type :是VERIFY_READ 或者VERIFY_WRITE用来表明是读用户内存还是写用户内存; 
4. addr:是要操作的用户内存地址; 
5. size:是操作的长度。如果ioctl需要从用户空间读一个整数，那么size参数就等于sizeof(int)； 
6.  
7. 返回值：Access_ok返回一个布尔值：1，是成功（存取没问题）；0，是失败，ioctl返回-EFAULT； 
8.  
9. */  

3）命令操作：

[cpp]  view plain  copy

1. <span style="color:#000000;">switch(cmd)  
2. {  
3.      case:  
4.      ... ...  
5. }</span>  

举例：

[cpp]  view plain  copy

1. 三、ioctl实例分析：  
2.   
3. （1）memdev.h：  
4.   
5. /*mem设备描述结构体*/  
6. struct mem_dev                                       
7. {                                                          
8.   char *data;                        
9.   unsigned long size;         
10. };  
11.   
12. /* 定义幻数 */  
13. #define MEMDEV_IOC_MAGIC  'k'  
14.   
15. /* 定义命令 */  
16. #define MEMDEV_IOCPRINT   _IO(MEMDEV_IOC_MAGIC, 1)  
17. #define MEMDEV_IOCGETDATA _IOR(MEMDEV_IOC_MAGIC, 2, int)  
18. #define MEMDEV_IOCSETDATA _IOW(MEMDEV_IOC_MAGIC, 3, int)  
19.   
20. #define MEMDEV_IOC_MAXNR 3  
21.   
22. #endif /* _MEMDEV_H_ */  
23.   
24.   
25. （2）memdev.c：（驱动程序）  
26.   
27. static int mem_major = MEMDEV_MAJOR;  
28.   
29. module_param(mem_major, int, S_IRUGO);  
30.   
31. struct mem_dev *mem_devp; /*设备结构体指针*/  
32.   
33. struct cdev cdev;   
34.   
35. /*文件打开函数*/  
36. int mem_open(struct inode *inode, struct file *filp)  
37. {  
38.     struct mem_dev *dev;  
39.       
40.     /*获取次设备号*/  
41.     int num = MINOR(inode->i_rdev);  
42.   
43.     if (num >= MEMDEV_NR_DEVS)   
44.             return -ENODEV;  
45.     dev = &mem_devp[num];  
46.       
47.     /*将设备描述结构指针赋值给文件私有数据指针*/  
48.     filp->private_data = dev;  
49.       
50.     return 0;   
51. }  
52.   
53. /*文件释放函数*/  
54. int mem_release(struct inode *inode, struct file *filp)  
55. {  
56.   return 0;  
57. }  
58.   
59. /*IO操作*/  
60. int memdev_ioctl(struct inode *inode, struct file *filp,  
61.                  unsigned int cmd, unsigned long arg)  
62. {  
63.   
64.     int err = 0;  
65.     int ret = 0;  
66.     int ioarg = 0;  
67.       
68.     /* 检测命令的有效性 */  
69.     if (_IOC_TYPE(cmd) != MEMDEV_IOC_MAGIC)   
70.         return -EINVAL;  
71.     if (_IOC_NR(cmd) > MEMDEV_IOC_MAXNR)   
72.         return -EINVAL;  
73.   
74.     /* 根据命令类型，检测参数空间是否可以访问 */  
75.     if (_IOC_DIR(cmd) & _IOC_READ)  
76.         err = !access_ok(VERIFY_WRITE, (void *)arg, _IOC_SIZE(cmd));  
77.     else if (_IOC_DIR(cmd) & _IOC_WRITE)  
78.         err = !access_ok(VERIFY_READ, (void *)arg, _IOC_SIZE(cmd));  
79.     if (err)   
80.         return -EFAULT;  
81.   
82.     /* 根据命令，执行相应的操作 */  
83.     switch(cmd) {  
84.   
85.       /* 打印当前设备信息 */  
86.       case MEMDEV_IOCPRINT:  
87.           printk("<--- CMD MEMDEV_IOCPRINT Done--->\n\n");  
88.         break;  
89.         
90.       /* 获取参数 */  
91.       case MEMDEV_IOCGETDATA:   
92.         ioarg = 1101;  
93.         ret = __put_user(ioarg, (int *)arg);  
94.         break;  
95.         
96.       /* 设置参数 */  
97.       case MEMDEV_IOCSETDATA:   
98.         ret = __get_user(ioarg, (int *)arg);  
99.         printk("<--- In Kernel MEMDEV_IOCSETDATA ioarg = %d --->\n\n",ioarg);  
100.         break;  
101.   
102.       default:    
103.         return -EINVAL;  
104.     }  
105.     return ret;  
106.   
107. }  
108.   
109. /*文件操作结构体*/  
110. static const struct file_operations mem_fops =  
111. {  
112.   .owner = THIS_MODULE,  
113.   .open = mem_open,  
114.   .release = mem_release,  
115.   .ioctl = memdev_ioctl,  
116. };  
117.   
118. /*设备驱动模块加载函数*/  
119. static int memdev_init(void)  
120. {  
121.   int result;  
122.   int i;  
123.   
124.   dev_t devno = MKDEV(mem_major, 0);  
125.   
126.   /* 静态申请设备号*/  
127.   if (mem_major)  
128.     result = register_chrdev_region(devno, 2, "memdev");  
129.   else  /* 动态分配设备号 */  
130.   {  
131.     result = alloc_chrdev_region(&devno, 0, 2, "memdev");  
132.     mem_major = MAJOR(devno);  
133.   }    
134.     
135.   if (result < 0)  
136.     return result;  
137.   
138.   /*初始化cdev结构*/  
139.   cdev_init(&cdev, &mem_fops);  
140.   cdev.owner = THIS_MODULE;  
141.   cdev.ops = &mem_fops;  
142.     
143.   /* 注册字符设备 */  
144.   cdev_add(&cdev, MKDEV(mem_major, 0), MEMDEV_NR_DEVS);  
145.      
146.   /* 为设备描述结构分配内存*/  
147.   mem_devp = kmalloc(MEMDEV_NR_DEVS * sizeof(struct mem_dev), GFP_KERNEL);  
148.   if (!mem_devp)    /*申请失败*/  
149.   {  
150.     result =  - ENOMEM;  
151.     goto fail_malloc;  
152.   }  
153.   memset(mem_devp, 0, sizeof(struct mem_dev));  
154.     
155.   /*为设备分配内存*/  
156.   for (i=0; i < MEMDEV_NR_DEVS; i++)   
157.   {  
158.         mem_devp[i].size = MEMDEV_SIZE;  
159.         mem_devp[i].data = kmalloc(MEMDEV_SIZE, GFP_KERNEL);  
160.         memset(mem_devp[i].data, 0, MEMDEV_SIZE);  
161.   }  
162.       
163.   return 0;  
164.   
165.   fail_malloc:   
166.   unregister_chrdev_region(devno, 1);  
167.     
168.   return result;  
169. }  
170.   
171. /*模块卸载函数*/  
172. static void memdev_exit(void)  
173. {  
174.   cdev_del(&cdev);   /*注销设备*/  
175.   kfree(mem_devp);     /*释放设备结构体内存*/  
176.   unregister_chrdev_region(MKDEV(mem_major, 0), 2); /*释放设备号*/  
177. }  
178.   
179. MODULE_AUTHOR("David Xie");  
180. MODULE_LICENSE("GPL");  
181.   
182. module_init(memdev_init);  
183. module_exit(memdev_exit);  
184.   
185. 复制代码  
186.   
187.   
188. (3)app-ioctl.c（应用程序）  
189.   
190.   
191. #include <stdio.h>  
192. #include<sys/types.h>  
193. #include<sys/stat.h>  
194. #include<fcntl.h>  
195.   
196. #include "memdev.h"  /* 包含命令定义 */  
197.   
198. int main()  
199. {  
200.     int fd = 0;  
201.     int cmd;  
202.     int arg = 0;  
203.     char Buf[4096];  
204.       
205.       
206.     /*打开设备文件*/  
207.     fd = open("/dev/memdev0",O_RDWR);  
208.     if (fd < 0)  
209.     {  
210.         printf("Open Dev Mem0 Error!\n");  
211.         return -1;  
212.     }  
213.       
214.     /* 调用命令MEMDEV_IOCPRINT */  
215.     printf("<--- Call MEMDEV_IOCPRINT --->\n");  
216.     cmd = MEMDEV_IOCPRINT;  
217.     if (ioctl(fd, cmd, &arg) < 0)  
218.         {  
219.             printf("Call cmd MEMDEV_IOCPRINT fail\n");  
220.             return -1;  
221.     }  
222.       
223.       
224.     /* 调用命令MEMDEV_IOCSETDATA */  
225.     printf("<--- Call MEMDEV_IOCSETDATA --->\n");  
226.     cmd = MEMDEV_IOCSETDATA;  
227.     arg = 2007;  
228.     if (ioctl(fd, cmd, &arg) < 0)  
229.         {  
230.             printf("Call cmd MEMDEV_IOCSETDATA fail\n");  
231.             return -1;  
232.     }  
233.   
234.       
235.     /* 调用命令MEMDEV_IOCGETDATA */  
236.     printf("<--- Call MEMDEV_IOCGETDATA --->\n");  
237.     cmd = MEMDEV_IOCGETDATA;  
238.     if (ioctl(fd, cmd, &arg) < 0)  
239.         {  
240.             printf("Call cmd MEMDEV_IOCGETDATA fail\n");  
241.             return -1;  
242.     }  
243.     printf("<--- In User Space MEMDEV_IOCGETDATA Get Data is %d --->\n\n",arg);      
244.       
245.     close(fd);  
246.     return 0;      
247. }  

总结：

1.传入指针需要检查安全性。memcpy函数尽量不要在内核中使用。

2.copy_to_user.copy_from_user.get_user.put_user函数会再拷贝数据前检测指针的安全性。不需要access_ok。

3.如果在ioctl函数开头使用了accsee_ok检验数据，接下来的代码可以使用__put_user或__get_user这些不需要检测的函数（书上有例子）

虽然还有写东西还没搞懂，但个人觉得，如果使用个 access_ok 要这么麻烦的话，那我就不用好了，以后我就使用 copy_xx_user 函数，省力又省心。

参考文献：

http://www.cnblogs.com/geneil/archive/2011/12/04/2275372.html

http://blog.chinaunix.net/uid-26952464-id-3380699.html

装载：http://blog.csdn.net/chun_1959/article/details/44851793