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

今天在寫字元驅動驗證程式的時候要用到ioctl函數，其中有一個cmd參數，搞了半天也不了解是什麼意思，那個cmd還有什麼指令碼了什麼的，還好google下，覺得這篇文章寫的不錯，就轉來看看：

在驅動程式裡， 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() 的宏值。

beyes

2009-09-26 11:23

這幾個宏的使用格式為：

_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)))