Linux驅(qū)動(dòng)實(shí)踐:如何編寫【 GPIO 】設(shè)備的驅(qū)動(dòng)程序?
別人的經(jīng)驗(yàn),我們的階梯!
大家好,我是道哥。
在前幾篇文章中,我們一塊討論了:在 Linux 系統(tǒng)中,編寫字符設(shè)備驅(qū)動(dòng)程序的基本框架,主要是從代碼流程和 API 函數(shù)這兩方面觸發(fā)。
這篇文章,我們就以此為基礎(chǔ),寫一個(gè)有實(shí)際應(yīng)用功能的驅(qū)動(dòng)程序:
- 在驅(qū)動(dòng)程序中,初始化 GPIO 設(shè)備,自動(dòng)創(chuàng)建設(shè)備節(jié)點(diǎn);
- 在應(yīng)用程序中,打開 GPIO 設(shè)備,并發(fā)送控制指令設(shè)置 GPIO 口的狀態(tài);
示例程序目標(biāo)
編寫一個(gè)驅(qū)動(dòng)程序模塊:mygpio.ko。
當(dāng)這個(gè)驅(qū)動(dòng)模塊被加載的時(shí)候,在系統(tǒng)中創(chuàng)建一個(gè) mygpio 類設(shè)備,并且在 /dev 目錄下,創(chuàng)建 4 個(gè)設(shè)備節(jié)點(diǎn):
- /dev/mygpio0
- /dev/mygpio1
- /dev/mygpio2
- /dev/mygpio3
因?yàn)槲覀儸F(xiàn)在是在 x86 平臺(tái)上來模擬 GPIO 的控制操作,并沒有實(shí)際的 GPIO 硬件設(shè)備。
因此,在驅(qū)動(dòng)代碼中,與硬件相關(guān)部分的代碼,使用宏 MYGPIO_HW_ENABLE 控制起來,并且在其中使用printk輸出打印信息來體現(xiàn)硬件的操作。
在應(yīng)用程序中,可以分別打開以上這 4 個(gè) GPIO 設(shè)備,并且通過發(fā)送控制指令,來設(shè)置 GPIO 的狀態(tài)。
編寫驅(qū)動(dòng)程序
以下所有操作的工作目錄,都是與上一篇文章相同的,即:~/tmp/linux-4.15/drivers/。
創(chuàng)建驅(qū)動(dòng)目錄和驅(qū)動(dòng)程序
- $ cd linux-4.15/drivers/
- $ mkdir mygpio_driver
- $ cd mygpio_driver
- $ touch mygpio.c
mygpio.c 文件的內(nèi)容如下(不需要手敲,文末有代碼下載鏈接):
- #include <linux/module.h>
- #include <linux/kernel.h>
- #include <linux/ctype.h>
- #include <linux/device.h>
- #include <linux/cdev.h>
- // GPIO 硬件相關(guān)宏定義
- #define MYGPIO_HW_ENABLE
- // 設(shè)備名稱
- #define MYGPIO_NAME "mygpio"
- // 一共有4個(gè) GPIO 口
- #define MYGPIO_NUMBER 4
- // 設(shè)備類
- static struct class *gpio_class;
- // 用來保存設(shè)備
- struct cdev gpio_cdev[MYGPIO_NUMBER];
- // 用來保存設(shè)備號(hào)
- int gpio_major = 0;
- int gpio_minor = 0;
- #ifdef MYGPIO_HW_ENABLE
- // 硬件初始化函數(shù),在驅(qū)動(dòng)程序被加載的時(shí)候(gpio_driver_init)被調(diào)用
- static void gpio_hw_init(int gpio)
- {
- printk("gpio_hw_init is called: %d. \n", gpio);
- }
- // 硬件釋放
- static void gpio_hw_release(int gpio)
- {
- printk("gpio_hw_release is called: %d. \n", gpio);
- }
- // 設(shè)置硬件GPIO的狀態(tài),在控制GPIO的時(shí)候(gpio_ioctl)被調(diào)研
- static void gpio_hw_set(unsigned long gpio_no, unsigned int val)
- {
- printk("gpio_hw_set is called. gpio_no = %ld, val = %d. \n", gpio_no, val);
- }
- #endif
- // 當(dāng)應(yīng)用程序打開設(shè)備的時(shí)候被調(diào)用
- static int gpio_open(struct inode *inode, struct file *file)
- {
- printk("gpio_open is called. \n");
- return 0;
- }
- // 當(dāng)應(yīng)用程序控制GPIO的時(shí)候被調(diào)用
- static long gpio_ioctl(struct file* file, unsigned int val, unsigned long gpio_no)
- {
- printk("gpio_ioctl is called. \n");
- // 檢查設(shè)置的狀態(tài)值是否合法
- if (0 != val && 1 != val)
- {
- printk("val is NOT valid! \n");
- return 0;
- }
- // 檢查設(shè)備范圍是否合法
- if (gpio_no >= MYGPIO_NUMBER)
- {
- printk("dev_no is invalid! \n");
- return 0;
- }
- printk("set GPIO: %ld to %d. \n", gpio_no, val);
- #ifdef MYGPIO_HW_ENABLE
- // 操作 GPIO 硬件
- gpio_hw_set(gpio_no, val);
- #endif
- return 0;
- }
- static const struct file_operations gpio_ops={
- .owner = THIS_MODULE,
- .open = gpio_open,
- .unlocked_ioctl = gpio_ioctl
- };
- static int __init gpio_driver_init(void)
- {
- int i, devno;
- dev_t num_dev;
- printk("gpio_driver_init is called. \n");
- // 動(dòng)態(tài)申請(qǐng)?jiān)O(shè)備號(hào)(嚴(yán)謹(jǐn)點(diǎn)的話,應(yīng)該檢查函數(shù)返回值)
- alloc_chrdev_region(&num_dev, gpio_minor, MYGPIO_NUMBER, MYGPIO_NAME);
- // 獲取主設(shè)備號(hào)
- gpio_major = MAJOR(num_dev);
- printk("gpio_major = %d. \n", gpio_major);
- // 創(chuàng)建設(shè)備類
- gpio_class = class_create(THIS_MODULE, MYGPIO_NAME);
- // 創(chuàng)建設(shè)備節(jié)點(diǎn)
- for (i = 0; i < MYGPIO_NUMBER; ++i)
- {
- // 設(shè)備號(hào)
- devno = MKDEV(gpio_major, gpio_minor + i);
- // 初始化 cdev 結(jié)構(gòu)
- cdev_init(&gpio_cdev[i], &gpio_ops);
- // 注冊(cè)字符設(shè)備
- cdev_add(&gpio_cdev[i], devno, 1);
- // 創(chuàng)建設(shè)備節(jié)點(diǎn)
- device_create(gpio_class, NULL, devno, NULL, MYGPIO_NAME"%d", i);
- }
- #ifdef MYGPIO_HW_ENABLE
- // 初始化 GPIO 硬件
- for (i = 0; i < MYGPIO_NUMBER; ++i)
- {
- gpio_hw_init(i);
- }
- #endif
- return 0;
- }
- static void __exit gpio_driver_exit(void)
- {
- int i;
- printk("gpio_driver_exit is called. \n");
- // 刪除設(shè)備和設(shè)備節(jié)點(diǎn)
- for (i = 0; i < MYGPIO_NUMBER; ++i)
- {
- cdev_del(&gpio_cdev[i]);
- device_destroy(gpio_class, MKDEV(gpio_major, gpio_minor + i));
- }
- // 釋放設(shè)備類
- class_destroy(gpio_class);
- #ifdef MYGPIO_HW_ENABLE
- // 釋放 GPIO 硬件
- for (i = 0; i < MYGPIO_NUMBER; ++i)
- {
- gpio_hw_release(i);
- }
- #endif
- // 注銷設(shè)備號(hào)
- unregister_chrdev_region(MKDEV(gpio_major, gpio_minor), MYGPIO_NUMBER);
- }
- MODULE_LICENSE("GPL");
- module_init(gpio_driver_init);
- module_exit(gpio_driver_exit);
相對(duì)于前幾篇文章來說,上面的代碼稍微有一點(diǎn)點(diǎn)復(fù)雜,主要是多了宏定義 MYGPIO_HW_ENABLE 控制部分的代碼。
比如:在這個(gè)宏定義控制下的三個(gè)與硬件相關(guān)的函數(shù):
- gpio_hw_init()
- gpio_hw_release()
- gpio_hw_set()
就是與GPIO硬件的初始化、釋放、狀態(tài)設(shè)置相關(guān)的操作。
代碼中的注釋已經(jīng)比較完善了,結(jié)合前幾篇文章中的函數(shù)說明,還是比較容易理解的。
從代碼中可以看出:驅(qū)動(dòng)程序使用 alloc_chrdev_region 函數(shù),來動(dòng)態(tài)注冊(cè)設(shè)備號(hào),并且利用了 Linux 應(yīng)用層中的 udev 服務(wù),自動(dòng)在 /dev 目錄下創(chuàng)建了設(shè)備節(jié)點(diǎn)。
另外還有一點(diǎn):在上面示例代碼中,對(duì)設(shè)備的操作函數(shù)只實(shí)現(xiàn)了 open 和 ioctl 這兩個(gè)函數(shù),這是根據(jù)實(shí)際的使用場(chǎng)景來決定的。
這個(gè)示例中,只演示了如何控制 GPIO 的狀態(tài)。
你也可以稍微補(bǔ)充一下,增加一個(gè)read函數(shù),來讀取某個(gè)GPIO口的狀態(tài)。
控制 GPIO 設(shè)備,使用 write 或者 ioctl 函數(shù)都可以達(dá)到目的,只是 ioctl 更靈活一些。
創(chuàng)建 Makefile 文件
- $ touch Makefile
內(nèi)容如下:
- ifneq ($(KERNELRELEASE),)
- obj-m := mygpio.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)程序: mygpio.ko 。
加載驅(qū)動(dòng)模塊
在加載驅(qū)動(dòng)模塊之前,先來檢查一下系統(tǒng)中,幾個(gè)與驅(qū)動(dòng)設(shè)備相關(guān)的地方。
先看一下 /dev 目錄下,目前還沒有設(shè)備節(jié)點(diǎn)( /dev/mygpio[0-3] )。
- $ ls -l /dev/mygpio*
- ls: cannot access '/dev/mygpio*': No such file or directory
再來查看一下 /proc/devices 目錄下,也沒有 mygpio 設(shè)備的設(shè)備號(hào)。
- $ cat /proc/devices
為了方便查看打印信息,把dmesg輸出信息清理一下:
- $ sudo dmesg -c
現(xiàn)在來加載驅(qū)動(dòng)模塊,執(zhí)行如下指令:
- $ sudo insmod mygpio.ko
當(dāng)驅(qū)動(dòng)程序被加載的時(shí)候,通過 module_init( ) 注冊(cè)的函數(shù) gpio_driver_init() 將會(huì)被執(zhí)行,那么其中的打印信息就會(huì)輸出。
還是通過 dmesg 指令來查看驅(qū)動(dòng)模塊的打印信息:
- $ dmesg
可以看到:操作系統(tǒng)為這個(gè)設(shè)備分配的主設(shè)備號(hào)是 244,并且也打印了GPIO硬件的初始化函數(shù)的調(diào)用信息。
此時(shí),驅(qū)動(dòng)模塊已經(jīng)被加載了!
來查看一下 /proc/devices 目錄下顯示的設(shè)備號(hào):
- $ cat /proc/devices
設(shè)備已經(jīng)注冊(cè)了,主設(shè)備號(hào)是: 244 。
設(shè)備節(jié)點(diǎn)
由于在驅(qū)動(dòng)程序的初始化函數(shù)中,使用 cdev_add 和 device_create 這兩個(gè)函數(shù),自動(dòng)創(chuàng)建設(shè)備節(jié)點(diǎn)。
所以,此時(shí)我們?cè)?/dev 目錄下,就可以看到下面這4個(gè)設(shè)備節(jié)點(diǎn):
現(xiàn)在,設(shè)備的驅(qū)動(dòng)程序已經(jīng)加載了,設(shè)備節(jié)點(diǎn)也被創(chuàng)建好了,應(yīng)用程序就可以來控制 GPIO 硬件設(shè)備了。
應(yīng)用程序
應(yīng)用程序仍然放在 ~/tmp/App/ 目錄下。
- $ mkdir ~/tmp/App/app_mygpio
- $ cd ~/tmp/App/app_mygpio
- $ touch app_mygpio.c
文件內(nèi)容如下:
- #include <stdio.h>
- #include <stdlib.h>
- #include <unistd.h>
- #include <assert.h>
- #include <fcntl.h>
- #include <sys/ioctl.h>
- #define MY_GPIO_NUMBER 4
- // 4個(gè)設(shè)備節(jié)點(diǎn)
- char gpio_name[MY_GPIO_NUMBER][16] = {
- "/dev/mygpio0",
- "/dev/mygpio1",
- "/dev/mygpio2",
- "/dev/mygpio3"
- };
- int main(int argc, char *argv[])
- {
- int fd, gpio_no, val;
- // 參數(shù)個(gè)數(shù)檢查
- if (3 != argc)
- {
- printf("Usage: ./app_gpio gpio_no value \n");
- return -1;
- }
- gpio_no = atoi(argv[1]);
- val = atoi(argv[2]);
- // 參數(shù)合法性檢查
- assert(gpio_no < MY_GPIO_NUMBER);
- assert(0 == val || 1 == val);
- // 打開 GPIO 設(shè)備
- if((fd = open(gpio_name[gpio_no], O_RDWR | O_NDELAY)) < 0){
- printf("%s: open failed! \n", gpio_name[gpio_no]);
- return -1;
- }
- printf("%s: open success! \n", gpio_name[gpio_no]);
- // 控制 GPIO 設(shè)備狀態(tài)
- ioctl(fd, val, gpio_no);
- // 關(guān)閉設(shè)備
- close(fd);
- }
以上代碼也不需要過多解釋,只要注意參數(shù)的順序即可。
接下來就是編譯和測(cè)試了:
- $ gcc app_mygpio.c -o app_mygpio
執(zhí)行應(yīng)用程序的時(shí)候,需要攜帶2個(gè)參數(shù):GPIO 設(shè)備編號(hào)(0 ~ 3),設(shè)置的狀態(tài)值(0 或者 1)。
這里設(shè)置一下/dev/mygpio0這個(gè)設(shè)備,狀態(tài)設(shè)置為1:
- $ sudo ./app_mygpio 0 1
- [sudo] password for xxx: <輸入用戶密碼>
- /dev/mygpio0: open success!
如何確認(rèn)/dev/mygpio0這個(gè)GPIO的狀態(tài)確實(shí)被設(shè)置為1了呢?當(dāng)然是看 dmesg 指令的打印信息:
- $ dmesg
通過以上打印信息可以看到:確實(shí)執(zhí)行了【設(shè)置 mygpio0 的狀態(tài)為 1】的動(dòng)作。
再繼續(xù)測(cè)試一下:設(shè)置 mygpio0 的狀態(tài)為 0:
- $ sudo ./app_mygpio 0 0
當(dāng)然了,設(shè)置其他幾個(gè)GPIO口的狀態(tài),都是可以正確執(zhí)行的!
卸載驅(qū)動(dòng)模塊
卸載指令:
- $ sudo rmmod mygpio
此時(shí),/proc/devices 下主設(shè)備號(hào) 244 的 mygpio 已經(jīng)不存在了.
再來看一下 dmesg的打印信息:
可以看到:驅(qū)動(dòng)程序中的 gpio_driver_exit( ) 被調(diào)用執(zhí)行了。
并且,/dev 目錄下的 4 個(gè)設(shè)備節(jié)點(diǎn),也被函數(shù) device_destroy() 自動(dòng)刪除了!
本文轉(zhuǎn)載自微信公眾號(hào)「IOT物聯(lián)網(wǎng)小鎮(zhèn)」