_IO, _IOR, _IOW, _IOWR 宏的用法与解析

[cpp]  view plain copy
  1. #define PSTN_GET_BLOCKSIZE  _IOR (PSTN_CODE, 1, int)    /* Get Transfer Block Size. */  
  2. #define PSTN_SET_BLOCKSIZE  _IOW (PSTN_CODE, 2, int)    /* Set Transfer Block Size. */  
  3. #define PSTN_FLUSH          _IOW (PSTN_CODE, 3, int)    /* Flush Buffer(s) and stop I/O */  
  4. #define PSTN_SYNC           _IOW (PSTN_CODE, 4, int)    /* Wait for Write to Finish */  
  5. #define PSTN_GET_PARAMS     _IOR (PSTN_CODE, 5, tPstnParams)    /* Get channel parameters */  
  6. #define PSTN_SET_PARAMS     _IOW (PSTN_CODE, 6, tPstnParams)    /* Get channel parameters */  
  7. #define PSTN_HOOK           _IOW (PSTN_CODE, 7, int)    /* Set Hookswitch Status */  
  8. #define PSTN_GETEVENT       _IOR (PSTN_CODE, 8, int)    /* Get Signalling Event */  
  9. #define PSTN_IOMUX          _IOWR (PSTN_CODE, 9, int)   /* Wait for something to happen (IO Mux) */  
  10. #define PSTN_SPANSTAT       _IOWR (PSTN_CODE, 10, tPstnSpanInfo)    /* Get Span Status */  
  11. #define PSTN_MAINT          _IOW (PSTN_CODE, 11, tPstnMaintInfo)    /* Set Maintenance Mode */  

[cpp]  view plain copy
  1. ioctl(aud->pseudofd, PSTN_SET_BLOCKSIZE, &x);  
  2. ioctl(p_ptr->subs[SUB_REAL].zfd, PSTN_FLUSH, &x);  

对于系统支持设备的ioctl号,你可以在/usr/include下面的头文件中找到,对于你自己的设备,如果需要使用ioctl接口,则需要定义自己的ioctl号。以前的2.4中有个问题是,大家都随便定义自己的ioctl号,造成很大可能性的重复性。一个坏处是难以管理,另外一个是容易造成错误,例如如果用户本来希望打开一个串口设备,结果通过open打开了网口,如果串口的某个ioctl号正好是网口的关闭操作,这样就会造成错误。在2.6里面,你定义自己的ioctl号最好使用_IO,   _IOR,   _IOW和_IORW来定义,这些宏考虑了第三个参数的长度,设备的magic number,以及操作的方向等,避免了2.4中的问题.
-----------------------------------------------------
这几个宏的使用格式为:
_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)))

你可能感兴趣的:(_IO, _IOR, _IOW, _IOWR 宏的用法与解析)