linux驅動中的宏 _IOC_NR, _IOC_TYPE, _IOC_SIZE, _IOC_DIR

轉載自 : http://blog.csdn.net/u010245383/article/details/29391805    

雖然排版都點點亂,但是內容還是較全面的。


   在驅動程序裏, 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)))


發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章