睿豐德科技 專注RFID識別技術和條碼識別技術與管理軟件的集成項目。質量追溯系統、MES系統、金蝶與條碼系統對接、用友與條碼系統對接

一、_IO, _IOR, _IOW, _IOWR 宏的用法與解析

在驅動程序里， ioctl() 函數上傳送的變量 cmd 是應用程序用于區別設備驅動程序請求處理內容的值。cmd除了可區別數字外，還包含有助于處理的幾種相應信息。 cmd的大小為 32位，共分 4 個域：
bit31~bit30 2位為 “區別讀寫” 區，作用是區分是讀取命令還是寫入命令。
bit29~bit15 14位為 "數據大小" 區，表示 ioctl() 中的 arg 變量傳送的內存大小。
bit20~bit08  8位為 “魔數"(也稱為"幻數")區，這個值用以與其它設備驅動程序的 ioctl 命令進行區別。
bit07~bit00   8位為 "區別序號" 區，是區分命令的命令順序序號。
像命令碼中的 “區分讀寫區” 里的值可能是 _IOC_NONE （0值）表示無數據傳輸，_IOC_READ (讀)， _IOC_WRITE (寫) ， _IOC_READ|_IOC_WRITE (雙向)。
內核定義了 _IO() , _IOR() , IOW() 和 _IOWR() 這 4 個宏來輔助生成上面的 cmd 。下面分析 _IO() 的實現，其它的類似。

在 asm-generic/ioctl.h 里可以看到 _IO() 的定義：
#define _IO(type,nr)        _IOC(_IOC_NONE,(type),(nr),0)
再看 _IOC() 的定義：
#define _IOC(dir,type,nr,size) \
    (((dir)  << _IOC_DIRSHIFT) | \
     ((type) << _IOC_TYPESHIFT) | \
     ((nr)   << _IOC_NRSHIFT) | \
     ((size) << _IOC_SIZESHIFT))
可見，_IO() 的最后結果由 _IOC() 中的 4 個參數移位組合而成。

再看 _IOC_DIRSHIT 的定義：
#define _IOC_DIRSHIFT    (_IOC_SIZESHIFT+_IOC_SIZEBITS)_IOC_SIZESHIFT 的定義：
#define _IOC_SIZESHIFT    (_IOC_TYPESHIFT+_IOC_TYPEBITS)_IOC_TYPESHIF 的定義：
#define _IOC_TYPESHIFT    (_IOC_NRSHIFT+_IOC_NRBITS)_IOC_NRSHIFT 的定義：
#define _IOC_NRSHIFT    0_IOC_NRBITS 的定義：
#define _IOC_NRBITS    8_IOC_TYPEBITS 的定義：
#define _IOC_TYPEBITS    8由上面的定義，往上推得到：
_IOC_TYPESHIFT = 8
_IOC_SIZESHIFT = 16
_IOC_DIRSHIFT = 30
所以，(dir)  << _IOC_DIRSHIFT) 表是 dir 往左移 30 位，即移到 bit31~bit30 兩位上，得到方向(讀寫)的屬性；
            (size) << _IOC_SIZESHIFT) 位左移 16 位得到“數據大小”區；
            (type) << _IOC_TYPESHIFT) 左移 8位得到"魔數區" ；
           (nr)   << _IOC_NRSHIFT)      左移 0 位( bit7~bit0) 。

這樣，就得到了 _IO() 的宏值。

 

這幾個宏的使用格式為：

• _IO (魔數， 基數);
• _IOR (魔數， 基數， 變量型)
• _IOW  (魔數， 基數， 變量型)
• _IOWR (魔數， 基數，變量型 )

魔數 (magic number)
魔數范圍為 0~255 。通常，用英文字符 "A" ~ "Z" 或者 "a" ~ "z" 來表示。設備驅動程序從傳遞進來的命令獲取魔數，然后與自身處理的魔數想比較，如果相同則處理，不同則不處理。魔數是拒絕誤使用的初步輔助狀態。設備驅動程序可以通過 _IOC_TYPE (cmd) 來獲取魔數。不同的設備驅動程序最好設置不同的魔數，但并不是要求絕對，也是可以使用其他設備驅動程序已用過的魔數。

基(序列號)數
基數用于區別各種命令。通常，從 0開始遞增，相同設備驅動程序上可以重復使用該值。例如，讀取和寫入命令中使用了相同的基數，設備驅動程序也能分辨出來，原因在于設備驅動程序區分命令時使用 switch ，且直接使用命令變量 cmd值。創建命令的宏生成的值由多個域組合而成，所以即使是相同的基數，也會判斷為不同的命令。設備驅動程序想要從命令中獲取該基數，就使用下面的宏：
_IOC_NR (cmd)
通常，switch 中的 case 值使用的是命令的本身。

變量型
變量型使用 arg 變量指定傳送的數據大小，但是不直接代入輸入，而是代入變量或者是變量的類型，原因是在使用宏創建命令，已經包含了 sizeof() 編譯命令。比如 _IOR() 宏的定義是：
#define _IOR(type,nr,size)    _IOC(_IOC_READ,(type),(nr),(_IOC_TYPECHECK(size)))
而 _IOC_TYPECHECK() 的定義正是：
#define _IOC_TYPECHECK(t) (sizeof(t))

設備驅動程序想要從傳送的命令獲取相應的值，就要使用下列宏函數：
_IOC_SIZE(cmd)

---

_IO 宏
該宏函數沒有可傳送的變量，只是用于傳送命令。例如如下約定：
#define TEST_DRV_RESET _IO ('Q', 0)
此時，省略由應用程序傳送的 arg 變量或者代入 0 。在應用程序中使用該宏時，比如：

ioctl (dev, TEST_DEV_RESET, 0)   或者  ioctl (dev, TEST_DRV_RESET) 。

這是因為變量的有效因素是可變因素。只作為命令使用時，沒有必要判斷出設備上數據的輸出或輸入。因此，設備驅動程序沒有必要執行設備文件大開選項的相關處理。

_IOR 宏
該函數用于創建從設備讀取數據的命令，例如可如下約定：
#define TEST_DEV_READ  _IRQ('Q', 1, int)
這說明應用程序從設備讀取數據的大小為 int 。下面宏用于判斷傳送到設備驅動程序的 cmd 命令的讀寫狀態：
_IOC_DIR (cmd)

運行該宏時，返回值的類型如下：

• _IOC_NONE                             :  無屬性
• _IOC_READ                             :  可讀屬性
• _IOC_WRITE                           : 可寫屬性
• _IOC_READ | _IOC_WRITE : 可讀，可寫屬性

使用該命令時，應用程序的 ioctl() 的 arg 變量值指定設備驅動程序上讀取數據時的緩存(結構體)地址。

_IOW 宏
用于創建設備上寫入數據的命令，其余內容與 _IOR 相同。通常，使用該命令時，ioctl() 的 arg 變量值指定設備驅動程序上寫入數據時的緩存(結構體)地址。

_IOWR 宏
用于創建設備上讀寫數據的命令。其余內容與 _IOR 相同。通常，使用該命令時，ioctl() 的 arg 變量值指定設備驅動程序上寫入或讀取數據時的緩存 (結構體) 地址。

_IOR() , _IOW(), IORW() 的定義：
#define _IOR(type,nr,size)    _IOC(_IOC_READ,(type),(nr),(_IOC_TYPECHECK(size)))
#define _IOW(type,nr,size)    _IOC(_IOC_WRITE,(type),(nr),(_IOC_TYPECHECK(size)))
#define _IOWR(type,nr,size)    _IOC(_IOC_READ|_IOC_WRITE,(type),(nr),(_IOC_TYPECHECK(size)))

 

二、下面來實際動手寫個測試例子

1.server.c

 

[cpp] view plain copy  

1. #include <linux/module.h>  
2. #include <linux/highmem.h>  
3. #include <asm/uaccess.h>  //copy_to_user  copy_from_user  
4. #define MODULE_NAME "hepeng"  
5. #define HEPENG_TEST 0x0  //request code  
6.    
7. #define HEPENG_TEST_OK 0    //reply code  
8. #define HEPENG_TEST_UNKNOWN_OPTION -1 //reply code  
9. #define HEPENG_TEST_UNKNOWN_DEV -2   //reply code  
10.    
11. #define TEST_IOC_MAGIC 'k'    //device type  
12.    
13. struct COMMAND_STRU_T  
14. {  
15.     short op;   
16.     short error;  
17. };//Params transfers between server and client  
18.    
19. int hepeng_cmd(struct COMMAND_STRU_T *cmd)  
20. {  
21.     switch (cmd->op)  
22.     {     
23.         case HEPENG_TEST:  
24.             printk("hepeng_cmd: this is a test\n");  
25.             cmd->error = HEPENG_TEST_OK;  
26.             break;  
27.         default:  
28.             printk("hepeng_cmd: error option\n");  
29.             cmd->error = HEPENG_TEST_UNKNOWN_OPTION;  
30.             return -1;   
31.     }     
32.     return 0;  
33. }  
34.    
35. int hepeng_ioctl(struct inode *inode, struct file *file, unsigned int opt, unsigned long arg)  
36. {  
37.     int ret_val;  
38.     struct COMMAND_STRU_T *cmd = (struct COMMAND_STRU_T*)  
39.                  kmalloc(sizeof(struct COMMAND_STRU_T), GFP_KERNEL);  
40.     if (!cmd)  
41.     {     
42.         printk("hepeng_ioctl: failed to allocate spcmd\n");  
43.         goto ioctl_error1;  
44.     }     
45.     if (copy_from_user (cmd, (long *)arg, sizeof(struct COMMAND_STRU_T)))  
46.     {  
47.         printk("hepeng_ioctl: failed to copy from user\n");  
48.         goto ioctl_error2;  
49.     }  
50.     if(_IOC_TYPE(opt) != TEST_IOC_MAGIC)  
51.     {  
52.         cmd->error = HEPENG_TEST_UNKNOWN_DEV;  
53.         printk("hepeng_ioctl:unknown device type\n");  
54.         if(copy_to_user ((long *)arg, cmd, sizeof(struct COMMAND_STRU_T)))  
55.             printk("hepeng_ioctl: failed to copy to user\n");  
56.         goto ioctl_error2;  
57.     }  
58.     ret_val = hepeng_cmd(cmd);  
59.     if (copy_to_user ((long *)arg, cmd, sizeof(struct COMMAND_STRU_T)))  
60.     {  
61.         printk("hepeng_ioctl: failed to copy to user\n");  
62.         goto ioctl_error2;  
63.     }  
64.     kfree(cmd);  
65.     return  0;  
66.    
67. ioctl_error2:  
68.     kfree(cmd);  
69. ioctl_error1:  
70.     return -1;  
71. }  
72. int sp_major; //global variable  
73.    
74. int test_init(void)  
75. {  
76.     struct file_operations module_params =  
77.     {  
78.         owner:THIS_MODULE,  
79.         ioctl:hepeng_ioctl,  
80.     };//disorder assignment  
81.     sp_major = register_chrdev(0, MODULE_NAME, &module_params);//register a character device  
82.     if (sp_major < 0)  
83.     {  
84.         printk(MODULE_NAME "failed to initialize\n");  
85.         return -1;  
86.     }  
87.     printk(MODULE_NAME ":initialize ok\n");  
88.     return 0;  
89. }  
90. void test_clean(void)  
91. {  
92.     printk(MODULE_NAME ":quit module\n");  
93.     unregister_chrdev(sp_major, MODULE_NAME);//unregister a character device  
94. }  
95.    
96. module_init(test_init);//load module  
97. module_exit(test_clean);//quit module  
98.    
99. MODULE_DESCRIPTION("Only A Test");  
100. MODULE_AUTHOR("He Peng");  
101. MODULE_LICENSE("GPL v2");  

該模塊由test_init函數開始，設置了file_operations的成員owner,ioctl，而ioctl指向hepeng_ioctl函數，即注冊ioctl函數，如果該模塊加載成功，收到客戶端的ioctl函數，那么就會由hepeng_ioctl來處理。test_init調用了register_chrdev函數來注冊字符型設備，注冊字符設備是為了能和/dev/XXX的設備聯系的前提。模塊退出會調用test_clean函數。TEST_IOC_MAGIC即魔數，客戶端需要用該魔數來ioctl
2.Makefile

 

 

[cpp] view plain copy  

1. MODULE_NAME:=hepeng  
2.    
3. $(MODULE_NAME)-objs := server.o  
4. obj-m:=$(MODULE_NAME).o  
5. KDIR := /usr/src/kernels/2.6.18-164.el5-x86_64  #usual path: /lib/modules/(kernel name)/build  
6. PWD  := $(shell pwd)  
7. default:  
8.     $(MAKE) -C $(KDIR) M=$(PWD) modules  
9. clean:  
10.     rm -rf *.o *~ core .depend .*.cmd *.ko *.mod.c .tmp_versions Module.symvers  
11. distclean:  
12.     rm -rf *.o *~ core .depend .*.cmd *.mod.c .tmp_versions Module.symvers  

 

 

3.make 編譯

編譯后，當前目錄下生成一些文件，如hepeng.ko等，用/sbin/modinfo hepeng.ko查看結果如下：

 

filename:       hepeng.ko

license:        GPL v2

author:         He peng

description:    Only A Test

srcversion:     A66C3C701909D1C32559F94

depends:        

vermagic:       2.6.18-164.el5 SMP mod_unload gcc-4.1

4.手工加載模塊

insmod hepeng.ko

tail -f /var/log/messages 可以看見如下信息：

Jun 14 23:52:41 localhost kernel: hepeng:initialize ok

如果不是，則檢查linux系統運行的kernel版本與server.c編譯用的kernel版本是否一致

5.生成字符設備文件

只有生成字符設備文件才能給客戶端調用

cat /proc/devices | grep hepeng，可以看到如下信息：

253 hepeng

生成字符設置文件：mknod /dev/hepeng c 253 0

成功后生成/dev/hepeng文件，即字符設備，可以被客戶端open來打開。這個文件可以用于應用程序與kernel程序交互

 

6.client.c

[cpp] view plain copy  

1. #include <iostream>  
2. #include <unistd.h>  
3. #include <cstdio>  
4. #include <sys/ioctl.h>  
5. #include <linux/types.h>  
6. #include <fcntl.h>  
7. using namespace std;  
8. #define HEPENG_TEST 0  
9. #define TEST_IOC_MAGIC 'k'  //device command type  
10. #define IOCTL_HEPENGCMD     _IOWR ( TEST_IOC_MAGIC, 2, struct COMMAND_STRU_T)  
11. struct COMMAND_STRU_T  
12. {  
13.     short op;   
14.     short error;  
15. };  
16. int main()  
17. {  
18.     int fd = open("/dev/hepeng", O_RDWR);  
19.     if(fd < 0)  
20.     {     
21.         cout << "error open" << endl;  
22.         return -1;   
23.     }     
24.     COMMAND_STRU_T cmd;  
25.     cmd.op = HEPENG_TEST;  
26.     if( ioctl(fd, IOCTL_HEPENGCMD, (void*)&cmd) < 0 )   
27.     {     
28.         cout << "error ioctl" << endl;  
29.         cout << "cmd.error:" << cmd.error << endl;  
30.         return -1;   
31.     }     
32.     cout << "cmd.error:" << cmd.error << endl;  
33.     close(fd);  
34.     return 0;  
35. }  

g++ client.c -o client

 

7.使用client測試驅動是否正常

sudo ./client

輸入：cmd.error:0

查看/var/log/messages

hepeng_cmd: this is a test

RFID管理系統集成商 RFID中間件 條碼系統中間層 物聯網軟件集成