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)))
這幾個宏的使用格式爲:
_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)))
大部分驅動除了需要具備讀寫設備的能力之外,還需要具備對硬件控制的能力。
一、在用戶空間,使用ioctl系統調用來控制設備,原型如下:
int ioctl(int fd,unsigned long cmd,...); /* fd:文件描述符 cmd:控制命令 ...:可選參數:插入*argp,具體內容依賴於cmd */
用戶程序所作的只是通過命令碼告訴驅動程序它想做什麼,至於怎麼解釋這些命令和怎麼實現這些命令,這都是驅動程序要做的事情。
二、驅動ioctl方法:
int (*ioctl) (struct inode *inode,struct file *filp,unsigned int cmd,unsigned long arg); /* inode與filp兩個指針對應於應用程序傳遞的文件描述符fd,這和傳遞open方法的參數一樣。 cmd 由用戶空間直接不經修改的傳遞給驅動程序 arg 可選。 */
在驅動程序中實現的ioctl函數體內,實際上是有一個switch {case}結構,每一個case對應一個命令碼,做出一些相應的操作。怎麼實現這些操作,這是每一個程序員自己的事情,因爲設備都是特定的。關鍵在於怎麼樣組織命令碼,因爲在ioctl中命令碼是唯一聯繫用戶程序命令和驅動程序支持的途徑。
在Linux核心中是這樣定義一個命令碼的:
____________________________________
| 設備類型 | 序列號 | 方向 | 數據尺寸 |
|----------|--------|------|-------- |
| 8 bit | 8 bit | 2 bit |8~14 bit|
|----------|--------|------|-------- |
這樣一來,一個命令就變成了一個整數形式的命令碼。但是命令碼非常的不直觀,所以Linux Kernel中提供了一些宏,這些宏可根據便於理解的字符串生成命令碼,或者是從命令碼得到一些用戶可以理解的字符串以標明這個命令對應的設備類型、設備序列號、數據傳送方向和數據傳輸尺寸。
1、定義命令:
內核提供了一些宏來幫助定義命令:
//nr爲序號,datatype爲數據類型,如int_IO(type, nr ) //沒有參數的命令_IOR(type, nr, datatype) //從驅動中讀數據_IOW(type, nr, datatype) //寫數據到驅動_IOWR(type,nr, datatype) //雙向傳送
定義命令例子:
#define MEM_IOC_MAGIC 'm' //定義類型#define MEM_IOCSET _IOW(MEM_IOC_MAGIC,0,int) #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是一個整數,可以直接使用;
如果是指針,我們必須確保這個用戶地址是有效的,因此,使用之前需要進行正確檢查。
內部有檢查的,不需要檢測的:
copy_from_user copy_to_user get_user put_user
需要檢測的:
__get_user __put_user
檢測函數access_ok():
static inline int access_ok(int type, constvoid *addr, unsigned long size) /* type :是VERIFY_READ 或者VERIFY_WRITE用來表明是讀用戶內存還是寫用戶內存; addr:是要操作的用戶內存地址; size:是操作的長度。如果ioctl需要從用戶空間讀一個整數,那麼size參數就等於sizeof(int); 返回值:Access_ok返回一個布爾值:1,是成功(存取沒問題);0,是失敗,ioctl返回-EFAULT; */
3)命令操作;
switch(cmd) { case: ... ... }
三、ioctl實例分析:
(1)memdev.h:
#ifndef _MEMDEV_H_ #define _MEMDEV_H_ #include <linux/ioctl.h> #ifndef MEMDEV_MAJOR #define MEMDEV_MAJOR 0 /*預設的mem的主設備號*/ #endif #ifndef MEMDEV_NR_DEVS #define MEMDEV_NR_DEVS 2 /*設備數*/ #endif #ifndef MEMDEV_SIZE #define MEMDEV_SIZE 4096 #endif
/*mem設備描述結構體*/struct mem_dev { char *data; unsigned long size; }; /* 定義幻數 */#define MEMDEV_IOC_MAGIC 'k' /* 定義命令 */#define MEMDEV_IOCPRINT _IO(MEMDEV_IOC_MAGIC, 1) #define MEMDEV_IOCGETDATA _IOR(MEMDEV_IOC_MAGIC, 2, int) #define MEMDEV_IOCSETDATA _IOW(MEMDEV_IOC_MAGIC, 3, int) #define MEMDEV_IOC_MAXNR 3 #endif /* _MEMDEV_H_ */
(2)memdev.c:(驅動程序)
#include <linux/module.h> #include <linux/types.h> #include <linux/fs.h> #include <linux/errno.h> #include <linux/mm.h> #include <linux/sched.h> #include <linux/init.h> #include <linux/cdev.h> #include <asm/io.h> #include <asm/system.h> #include <asm/uaccess.h> #include "memdev.h"
staticint mem_major = MEMDEV_MAJOR; module_param(mem_major, int, S_IRUGO); struct mem_dev *mem_devp; /*設備結構體指針*/struct cdev cdev; /*文件打開函數*/int mem_open(struct inode *inode, struct file *filp) { struct mem_dev *dev; /*獲取次設備號*/int num = MINOR(inode->i_rdev); if (num >= MEMDEV_NR_DEVS) return -ENODEV; dev = &mem_devp[num]; /*將設備描述結構指針賦值給文件私有數據指針*/ filp->private_data = dev; return0; } /*文件釋放函數*/int mem_release(struct inode *inode, struct file *filp) { return0; } /*IO操作*/int memdev_ioctl(struct inode *inode, struct file *filp, unsigned int cmd, unsigned long arg) { int err = 0; int ret = 0; int ioarg = 0; /* 檢測命令的有效性 */if (_IOC_TYPE(cmd) != MEMDEV_IOC_MAGIC) return -EINVAL; if (_IOC_NR(cmd) > MEMDEV_IOC_MAXNR) return -EINVAL; /* 根據命令類型,檢測參數空間是否可以訪問 */if (_IOC_DIR(cmd) & _IOC_READ) err = !access_ok(VERIFY_WRITE, (void *)arg, _IOC_SIZE(cmd)); elseif (_IOC_DIR(cmd) & _IOC_WRITE) err = !access_ok(VERIFY_READ, (void *)arg, _IOC_SIZE(cmd)); if (err) return -EFAULT; /* 根據命令,執行相應的操作 */switch(cmd) { /* 打印當前設備信息 */case MEMDEV_IOCPRINT: printk("<--- CMD MEMDEV_IOCPRINT Done--->\n\n"); break; /* 獲取參數 */case MEMDEV_IOCGETDATA: ioarg = 1101; ret = __put_user(ioarg, (int *)arg); break; /* 設置參數 */case MEMDEV_IOCSETDATA: ret = __get_user(ioarg, (int *)arg); printk("<--- In Kernel MEMDEV_IOCSETDATA ioarg = %d --->\n\n",ioarg); break; default: return -EINVAL; } return ret; } /*文件操作結構體*/staticconststruct file_operations mem_fops = { .owner = THIS_MODULE, .open = mem_open, .release = mem_release, .ioctl = memdev_ioctl, }; /*設備驅動模塊加載函數*/staticint memdev_init(void) { int result; int i; dev_t devno = MKDEV(mem_major, 0); /* 靜態申請設備號*/if (mem_major) result = register_chrdev_region(devno, 2, "memdev"); else/* 動態分配設備號 */ { result = alloc_chrdev_region(&devno, 0, 2, "memdev"); mem_major = MAJOR(devno); } if (result < 0) return result; /*初始化cdev結構*/ cdev_init(&cdev, &mem_fops); cdev.owner = THIS_MODULE; cdev.ops = &mem_fops; /* 註冊字符設備 */ cdev_add(&cdev, MKDEV(mem_major, 0), MEMDEV_NR_DEVS); /* 爲設備描述結構分配內存*/ mem_devp = kmalloc(MEMDEV_NR_DEVS * sizeof(struct mem_dev), GFP_KERNEL); if (!mem_devp) /*申請失敗*/ { result = - ENOMEM; goto fail_malloc; } memset(mem_devp, 0, sizeof(struct mem_dev)); /*爲設備分配內存*/for (i=0; i < MEMDEV_NR_DEVS; i++) { mem_devp[i].size = MEMDEV_SIZE; mem_devp[i].data = kmalloc(MEMDEV_SIZE, GFP_KERNEL); memset(mem_devp[i].data, 0, MEMDEV_SIZE); } return0; fail_malloc: unregister_chrdev_region(devno, 1); return result; } /*模塊卸載函數*/staticvoid memdev_exit(void) { cdev_del(&cdev); /*註銷設備*/ kfree(mem_devp); /*釋放設備結構體內存*/ unregister_chrdev_region(MKDEV(mem_major, 0), 2); /*釋放設備號*/ } MODULE_AUTHOR("David Xie"); MODULE_LICENSE("GPL"); module_init(memdev_init); module_exit(memdev_exit);
(3)app-ioctl.c(應用程序)
#include <stdio.h> #include<sys/types.h> #include<sys/stat.h> #include<fcntl.h> #include "memdev.h"/* 包含命令定義 */int main() { int fd = 0; int cmd; int arg = 0; char Buf[4096]; /*打開設備文件*/ fd = open("/dev/memdev0",O_RDWR); if (fd < 0) { printf("Open Dev Mem0 Error!\n"); return -1; } /* 調用命令MEMDEV_IOCPRINT */ printf("<--- Call MEMDEV_IOCPRINT --->\n"); cmd = MEMDEV_IOCPRINT; if (ioctl(fd, cmd, &arg) < 0) { printf("Call cmd MEMDEV_IOCPRINT fail\n"); return -1; } /* 調用命令MEMDEV_IOCSETDATA */ printf("<--- Call MEMDEV_IOCSETDATA --->\n"); cmd = MEMDEV_IOCSETDATA; arg = 2007; if (ioctl(fd, cmd, &arg) < 0) { printf("Call cmd MEMDEV_IOCSETDATA fail\n"); return -1; } /* 調用命令MEMDEV_IOCGETDATA */ printf("<--- Call MEMDEV_IOCGETDATA --->\n"); cmd = MEMDEV_IOCGETDATA; if (ioctl(fd, cmd, &arg) < 0) { printf("Call cmd MEMDEV_IOCGETDATA fail\n"); return -1; } printf("<--- In User Space MEMDEV_IOCGETDATA Get Data is %d --->\n\n",arg); close(fd); return0; } ------------------------------------------------------------------------------------------ 需要root權限 Makefile: ifneq ($(KERNELRELEASE),) obj -m := memdev.o else KERNELDIR := /lib/modules/$(shell uname -r)/build PWD :=$(shell pwd) default: make -C $(KERNELDIR) SUBDIRS=$(PWD) modules .PHONY : clean clean: rm -f *.ko *mod* *.o *.symvers *.orer endif --------------------------------------------------------------------------------------------- 測試(sudo) insmod memdev.ko mknod /dev/memdev0 c yourmajor youminor 可以在驅動中用宏MAJOR來打印
1.傳入指針需要檢查安全性。memcpy函數儘量不要在內核中使用。
2.copy_to_user.copy_from_user.get_user.put_user函數會再拷貝數據前檢測指針的安全性。不需要access_ok。
3.如果在ioctl函數開頭使用了accsee_ok檢驗數據,接下來的代碼可以使用__put_user或__get_user這些不需要檢測的函數(書上有例子)