Linux 驅(qū)動(dòng)實(shí)踐:你知道字符設(shè)備驅(qū)動(dòng)程序的兩種寫(xiě)法嗎?
混亂的 API 函數(shù)
我在剛開(kāi)始接觸Linux驅(qū)動(dòng)的時(shí)候,非常的困擾:注冊(cè)一個(gè)字符設(shè)備,怎么有這么多的 API 函數(shù)啊?
參考的每一篇文章中,使用的函數(shù)都不一樣,但是執(zhí)行結(jié)果都是符合預(yù)期的!
比如下面這幾個(gè):
- register_chrdev(...);
- register_chrdev_regin(...);
- cdev_add(...);
它們的功能都是向系統(tǒng)注冊(cè)字符設(shè)備,但是只從函數(shù)名上看,初學(xué)者誰(shuí)能分得清它們的區(qū)別?!
這也難怪,Linux系統(tǒng)經(jīng)過(guò)這么多年的發(fā)展,代碼更新是很正常的事情。
但是,我們參考的文章就沒(méi)法做到:很詳細(xì)的把文章中所描述內(nèi)容的背景介紹清楚,往往都是文章作者在自己的實(shí)際工作環(huán)境中,測(cè)試某種方法解決了自己的問(wèn)題,于是就記錄成文。
不同的文章、不同的工作上下文、不同的API函數(shù)調(diào)用,這往往就苦了我們初學(xué)者,特別是我這種有選擇障礙癥的人!
其實(shí),上面這個(gè)幾個(gè)函數(shù)都是正確的,它們的功能都是類(lèi)似的,它們是 Linux 系統(tǒng)中不同階段的產(chǎn)物。
舊的 API 函數(shù)
在Linux內(nèi)核代碼2.4版本和早期的2.6版本中,注冊(cè)、卸載字符設(shè)備驅(qū)動(dòng)程序的經(jīng)典方式是:
注冊(cè)設(shè)備:
- int register_chrdev(unsigned int major,const char *name,struct file_operations *fops);
參數(shù)1 major:如果為0 - 由操作系統(tǒng)動(dòng)態(tài)分配一個(gè)主設(shè)備號(hào)給這個(gè)設(shè)備;如果非0 - 驅(qū)動(dòng)程序向系統(tǒng)申請(qǐng),使用這個(gè)主設(shè)備號(hào);
參數(shù)2 name:設(shè)備名稱(chēng);
參數(shù)3 fops:file_operations 類(lèi)型的指針變量,用于操作設(shè)備;
如果是動(dòng)態(tài)分配,那么這個(gè)函數(shù)的返回值就是:操作系統(tǒng)動(dòng)態(tài)分配給這個(gè)設(shè)備的主設(shè)備號(hào)。
這個(gè)動(dòng)態(tài)分配的設(shè)備號(hào),我們要把它記住,因?yàn)樵谄渌腁PI函數(shù)中需要使用它。
卸載設(shè)備:
- int unregister_chrdev(unsigned int major,const char *name)
參數(shù)1 major:設(shè)備的主設(shè)備號(hào),也就是 register_chrdev() 函數(shù)的返回值(動(dòng)態(tài)),或者驅(qū)動(dòng)程序指定的設(shè)備號(hào)(靜態(tài)方式);
參數(shù)2 name:設(shè)備名稱(chēng);
新的 API 函數(shù)
注冊(cè)設(shè)備:
- int register_chrdev_region(dev_t from, unsigned count, const char *name);
- int alloc_chrdev_region(dev_t *dev, unsigned baseminor, unsigned count,const char *name);
上面這2個(gè)注冊(cè)設(shè)備的函數(shù),其實(shí)對(duì)應(yīng)著舊的 API 函數(shù) register_chrdev:把參數(shù) 1 表示的動(dòng)態(tài)分配、靜態(tài)分配,拆分成2個(gè)函數(shù)而已。
也就是說(shuō):
register_chrdev_region(): 靜態(tài)注冊(cè)設(shè)備;
alloc_chrdev_region(): 動(dòng)態(tài)注冊(cè)設(shè)備;
這兩個(gè)函數(shù)的參數(shù)含義是:
register_chrdev_region 參數(shù):
參數(shù)1 from: 注冊(cè)指定的設(shè)備號(hào),這是靜態(tài)指定的,例如:MKDEV(200, 0) 表示起始主設(shè)備號(hào) 200, 起始次設(shè)備號(hào)為 0;
參數(shù)2 count: 驅(qū)動(dòng)程序指定連續(xù)注冊(cè)的次設(shè)備號(hào)的個(gè)數(shù),例如:起始次設(shè)備號(hào)是 0,count 為 10,表示驅(qū)動(dòng)程序?qū)?huì)使用 0 ~ 9 這 10 個(gè)次設(shè)備號(hào);
參數(shù)3 name:設(shè)備名稱(chēng);
alloc_chrdev_region 參數(shù):
參數(shù)1 dev: 動(dòng)態(tài)注冊(cè)就是系統(tǒng)來(lái)分配設(shè)備號(hào),那么驅(qū)動(dòng)程序就要提供一個(gè)指針變量來(lái)接收系統(tǒng)分配的結(jié)果(設(shè)備號(hào));
參數(shù)2 baseminor: 驅(qū)動(dòng)程序指定此設(shè)備號(hào)的起始值;
參數(shù)3 count: 驅(qū)動(dòng)程序指定連續(xù)注冊(cè)的次設(shè)備號(hào)的個(gè)數(shù),例如:起始次設(shè)備號(hào)是 0,count 為 10,表示驅(qū)動(dòng)程序?qū)?huì)使用 0 ~ 9 這 10 個(gè)次設(shè)備號(hào);
參數(shù)4 name:設(shè)備名稱(chēng);
補(bǔ)充一下關(guān)于設(shè)備號(hào)的內(nèi)容:
這里的結(jié)構(gòu)體 dev_t,用來(lái)保存設(shè)備號(hào),包括主設(shè)備號(hào)和次設(shè)備號(hào)。
它本質(zhì)上是一個(gè) 32 位的數(shù),其中的 12 位用來(lái)表示主設(shè)備號(hào),而其余 20 位用來(lái)表示次設(shè)備號(hào)。
系統(tǒng)中定義了3宏,來(lái)實(shí)現(xiàn)dev_t變量、主設(shè)備號(hào)、次設(shè)備號(hào)之間的轉(zhuǎn)換:
MAJOR(dev_t dev): 從 dev_t 類(lèi)型中獲取主設(shè)備號(hào);
MINOR(dev_t dev): 從 dev_t 類(lèi)型中獲取次設(shè)備號(hào);
MKDEV(int major,int minor): 把主設(shè)備號(hào)和次設(shè)備號(hào)轉(zhuǎn)換為 dev_t 類(lèi)型;
卸載設(shè)備:
- void unregister_chrdev_region(dev_t from, unsigned count);
參數(shù)1 from: 注銷(xiāo)的設(shè)備號(hào);
參數(shù)2 count: 注銷(xiāo)的連續(xù)次設(shè)備號(hào)的個(gè)數(shù);
代碼實(shí)操
下面,我們就用舊的API函數(shù),一步一步的描述字符設(shè)備驅(qū)動(dòng)程序的:編寫(xiě)、加載和卸載過(guò)程。
如何使用新的API函數(shù)來(lái)編寫(xiě)字符設(shè)備驅(qū)動(dòng)程序,下一篇文章再詳細(xì)討論。
以下所有操作的工作目錄,都是與上一篇文章相同的,即:~/tmp/linux-4.15/drivers/。
創(chuàng)建驅(qū)動(dòng)目錄和驅(qū)動(dòng)程序
- $ cd linux-4.15/drivers/
- $ mkdir my_driver1
- $ cd my_driver1
- $ touch driver1.c
driver1.c 文件的內(nèi)容如下(不需要手敲,文末有代碼下載鏈接):
- #include <linux/module.h>
- #include <linux/kernel.h>
- #include <linux/fs.h>
- #include <linux/init.h>
- #include <linux/delay.h>
- #include <linux/uaccess.h>
- #include <linux/ctype.h>
- #include <linux/irq.h>
- #include <linux/io.h>
- #include <linux/device.h>
- static unsigned int major;
- int driver1_open(struct inode *inode, struct file *file)
- {
- printk("driver1_open is called. \n");
- return 0;
- }
- ssize_t driver1_read(struct file *file, char __user *buf, size_t size, loff_t *ppos)
- {
- printk("driver1_read is called. \n");
- return 0;
- }
- ssize_t driver1_write (struct file *file, const char __user *buf, size_t size, loff_t *ppos)
- {
- printk("driver1_write is called. \n");
- return 0;
- }
- static const struct file_operations driver1_ops={
- .owner = THIS_MODULE,
- .open = driver1_open,
- .read = driver1_read,
- .write = driver1_write,
- };
- static int __init driver1_init(void)
- {
- printk("driver1_init is called. \n");
- major = register_chrdev(0, "driver1", &driver1_ops);
- printk("register_chrdev. major = %d\n",major);
- return 0;
- }
- static void __exit driver1_exit(void)
- {
- printk("driver1_exit is called. \n");
- unregister_chrdev(major,"driver1");
- }
- MODULE_LICENSE("GPL");
- module_init(driver1_init);
- module_exit(driver1_exit);
創(chuàng)建 Makefile 文件
- $ touch Makefile
內(nèi)容如下:
- ifneq ($(KERNELRELEASE),)
- obj-m := driver1.o
- else
- KERNELDIR ?= /lib/modules/$(shell uname -r)/build
- PWD := $(shell pwd)
- default:
- $(MAKE) -C $(KERNELDIR) M=$(PWD) modules
- clean:
- $(MAKE) -C $(KERNEL_PATH) M=$(PWD) clean
- endif
編譯驅(qū)動(dòng)模塊
- $ make
得到驅(qū)動(dòng)程序: driver1.ko 。
加載驅(qū)動(dòng)模塊
在加載驅(qū)動(dòng)模塊之前,先來(lái)看一下系統(tǒng)中,幾個(gè)與驅(qū)動(dòng)設(shè)備相關(guān)的地方。
先看一下 /dev 目錄下,目前還沒(méi)有我們的設(shè)備節(jié)點(diǎn)( /dev/driver1 )。
再來(lái)查看一下 /proc/devices 目錄下,也沒(méi)有 driver1 設(shè)備的設(shè)備號(hào)。
- cat /proc/devices | grep driver1
/proc/devices 文件: 列出字符和塊設(shè)備的主設(shè)備號(hào),以及分配到這些設(shè)備號(hào)的設(shè)備名稱(chēng)。
執(zhí)行如下指令,加載驅(qū)動(dòng)各模塊:
- $ sudo insmod driver1.ko
通過(guò)上一篇文章我們知道,當(dāng)驅(qū)動(dòng)程序被加載的時(shí)候,通過(guò) module_init(driver1_init); 注冊(cè)的函數(shù) driver1_init() 將會(huì)被執(zhí)行,那么其中的打印信息就會(huì)輸出。
還是通過(guò) dmesg 指令來(lái)查看驅(qū)動(dòng)模塊的打印信息:
- $ dmesg
如果輸入信息太多,可以使用dmesg | tail指令;
此時(shí),驅(qū)動(dòng)模塊已經(jīng)被加載了!
來(lái)查看一下 /proc/devices 目錄下顯示的設(shè)備號(hào):
可以看到 driver1 已經(jīng)掛載好了,并且它的主設(shè)備號(hào)是244。
此時(shí),雖然已經(jīng)向系統(tǒng)注冊(cè)了這個(gè)設(shè)備,并且主設(shè)備號(hào)已經(jīng)分配了,但是,在/dev目錄下,還不存在這個(gè)設(shè)備的節(jié)點(diǎn),需要我們手動(dòng)創(chuàng)建:
- sudo mknod -m 660 /dev/driver1 c 244 0
檢查一下設(shè)備節(jié)點(diǎn)是否創(chuàng)建成功:
- $ ls -l /dev
關(guān)于設(shè)備節(jié)點(diǎn),Linux 的應(yīng)用層有一個(gè) udev 服務(wù),可以自動(dòng)創(chuàng)建設(shè)備節(jié)點(diǎn);
也就是:當(dāng)驅(qū)動(dòng)模塊被加載的時(shí)候,自動(dòng)在 /dev 目錄下創(chuàng)建設(shè)備節(jié)點(diǎn)。當(dāng)然了,我們需要在驅(qū)動(dòng)程序中,提前告訴 udev 如何去創(chuàng)建;
下面會(huì)介紹:如何自動(dòng)創(chuàng)建設(shè)備節(jié)點(diǎn)。
現(xiàn)在,設(shè)備的驅(qū)動(dòng)程序已經(jīng)加載了,設(shè)備節(jié)點(diǎn)也被創(chuàng)建好了,應(yīng)用程序就可以來(lái)操作(讀、寫(xiě))這個(gè)設(shè)備了。
應(yīng)用程序
我們把所有的應(yīng)用程序,放在 ~/tmp/App/ 目錄下。
- $ cd ~/tmp
- $ mkdir -p App/app_driver1
- $ touch app_driver1.c
app_driver1.c 文件的內(nèi)容如下:
- #include <stdio.h>
- #include <unistd.h>
- #include <fcntl.h>
- int main(void)
- {
- int ret;
- int read_data[4] = { 0 };
- int write_data[4] = {1, 2, 3, 4};
- int fd = open("/dev/driver1", O_RDWR);
- if (-1 != fd)
- {
- ret = read(fd, read_data, 4);
- printf("read ret = %d \n", ret);
- ret = write(fd, write_data, 4);
- printf("write ret = %d \n", ret);
- }
- else
- {
- printf("open /dev/driver1 failed! \n");
- }
- return 0;
- }
這里演示的僅僅是通過(guò)打印信息來(lái)體現(xiàn)函數(shù)的調(diào)用,并沒(méi)有實(shí)際的讀取數(shù)據(jù)和寫(xiě)入數(shù)據(jù)。
因?yàn)椋x寫(xiě)數(shù)據(jù)又涉及到復(fù)雜的用戶(hù)空間和內(nèi)核空間的數(shù)據(jù)拷貝問(wèn)題。
應(yīng)用程序準(zhǔn)備妥當(dāng),接下來(lái)就是編譯和測(cè)試了:
- $ gcc app_driver1.c -o app_driver1
- $ sudo ./app_driver1
應(yīng)用程序的輸出信息如下:
- app_driver1$ sudo ./app_driver1
- [sudo] password for xxxx: <輸入用戶(hù)密碼>
- read ret = 0
- write ret = 0
從返回值來(lái)看,成功打開(kāi)了設(shè)備,并且調(diào)用讀函數(shù)、寫(xiě)函數(shù)都成功了!
根據(jù)Linux系統(tǒng)的驅(qū)動(dòng)框架,應(yīng)用層的 open、read、write 函數(shù)被調(diào)用的時(shí)候,驅(qū)動(dòng)程序中對(duì)應(yīng)的函數(shù)就會(huì)被執(zhí)行:
- static const struct file_operations driver1_ops={
- .owner = THIS_MODULE,
- .open = driver1_open,
- .read = driver1_read,
- .write = driver1_write,
- };
我們已經(jīng)在驅(qū)動(dòng)程序的這三個(gè)函數(shù)中打印了信息,繼續(xù)用dmesg命令查看一下:
卸載驅(qū)動(dòng)模塊
卸載指令:
- $ sudo rmmod driver1
繼續(xù)用dmesg指令來(lái)查看驅(qū)動(dòng)程序中的打印信息:
說(shuō)明驅(qū)動(dòng)程序中的 driver1_exit() 函數(shù)被調(diào)用了。
此時(shí),我們來(lái)看一下 /proc/devices 目錄下變化:
可以看到:剛才設(shè)備號(hào)為244的 driver1 已經(jīng)被系統(tǒng)卸載了!因?yàn)轵?qū)動(dòng)程序中的 unregister_chrdev(major,"driver1"); 函數(shù)被執(zhí)行了。
但是,由于 /dev 目錄下的設(shè)備節(jié)點(diǎn) driver1 ,是剛才手動(dòng)創(chuàng)建的,因此需要我們手動(dòng)刪除。
- $ sudo rm /dev/driver1
小結(jié)
以上,就是字符設(shè)備的最簡(jiǎn)單驅(qū)動(dòng)程序!
從編寫(xiě)過(guò)程可以看出:Linux系統(tǒng)已經(jīng)設(shè)計(jì)好了一套驅(qū)動(dòng)程序的框架。
我們只需要按照它要求,按部就班地把每一個(gè)函數(shù)或者是結(jié)構(gòu)體,注冊(cè)到系統(tǒng)中就可以了。
自動(dòng)在 /dev 目錄下創(chuàng)建設(shè)備節(jié)點(diǎn)
在上面的操作過(guò)程中,設(shè)備節(jié)點(diǎn) /dev/driver1 是手動(dòng)創(chuàng)建的。
Linux 系統(tǒng)的應(yīng)用層提供了 udev 這個(gè)服務(wù),可以幫助我們自動(dòng)創(chuàng)建設(shè)備節(jié)點(diǎn)。我們現(xiàn)在就來(lái)把這個(gè)功能補(bǔ)上。
修改驅(qū)動(dòng)程序
為了方便比較,添加的代碼全部用宏定義 UDEV_ENABLE 控制起來(lái)。
driver1.c代碼中,有 3 處變化:
1. 定義 2 個(gè)全局變量
#ifdef UDEV_ENABLE
static struct class *driver1_class;
static struct device *driver1_dev;
#endif
2. driver1_init() 函數(shù)
static int __init driver1_init(void)
{
printk("driver1_init is called. \n");
major = register_chrdev(0, "driver1", &driver1_ops);
printk("register_chrdev. major = %d\n",major);
#ifdef UDEV_ENABLE
driver1_class = class_create(THIS_MODULE, "driver1");
driver1_dev = device_create(driver1_class, NULL, MKDEV(major, 0), NULL, "driver1");
#endif
return 0;
}
3. driver1_exit() 函數(shù)
static void __exit driver1_exit(void)
{
printk("driver1_exit is called. \n");
#ifdef UDEV_ENABLE
class_destroy(driver1_class);
#endif
unregister_chrdev(major,"driver1");
}
代碼修改之后(也可以直接下載我放在網(wǎng)盤(pán)里的源代碼),重新編譯驅(qū)動(dòng)模塊:
$ make
生成driver1.ko驅(qū)動(dòng)模塊,然后加載它:
先確定一下:/proc/devices,/dev 目錄下,已經(jīng)沒(méi)有剛才測(cè)試的設(shè)備了;
為了便于查看驅(qū)動(dòng)程序中的打印信息,最好把 dmesg 輸出的打印信息清理一下(指令:sudo dmesg -c);
$ sudo insmod driver1.ko
按照剛才的操作流程,我們需要來(lái)驗(yàn)證3個(gè)信息:
(1) 看一下驅(qū)動(dòng)程序的打印信息(指令:dmesg):
圖片
(2) 看一下 /proc/devices 下的設(shè)備注冊(cè)情況:
圖片
(3) 看一下 /dev 下,是否自動(dòng)創(chuàng)建了設(shè)備節(jié)點(diǎn):
圖片
通過(guò)以上3張圖片,可以得到結(jié)論:驅(qū)動(dòng)程序正確加載了,設(shè)備節(jié)點(diǎn)被自動(dòng)創(chuàng)建了!
下面,就應(yīng)該是應(yīng)用程序登場(chǎng)測(cè)試了,代碼不用修改,直接執(zhí)行即可:
$ sudo ./app_driver1
[sudo] password for xxx: <輸入用戶(hù)密碼>
read ret = 0
write ret = 0
應(yīng)用層的函數(shù)返回值正確!
再看一下 dmesg 的輸出信息:
完美!
代碼下載
文中的所有代碼,已經(jīng)放在網(wǎng)盤(pán)中了。