Linux 驅(qū)動(dòng) | 重新理解一波設(shè)備驅(qū)動(dòng)
先說(shuō)結(jié)論:
多年來(lái),我接觸到的 Linux 驅(qū)動(dòng)教程大多都是從 0 編寫,這樣對(duì)初學(xué)者而言最大的好處,就是可以接觸到比較多的底層原理。
但是在真正的工作場(chǎng)景里,其實(shí)是應(yīng)該盡量避免從 0 構(gòu)建自己的設(shè)備驅(qū)動(dòng)的。
更好的做法是在高度模塊化的驅(qū)動(dòng)框架里添加自己的設(shè)備驅(qū)動(dòng)。
這樣做的好處是最大程度地復(fù)用內(nèi)核現(xiàn)有的代碼,同時(shí)獲得極大的彈性和可維護(hù)性,并且為應(yīng)用程序提供出統(tǒng)一的訪問(wèn)接口。
下面詳細(xì)地說(shuō)說(shuō)。
什么是設(shè)備驅(qū)動(dòng)?
設(shè)備驅(qū)動(dòng)程序 (device driver) 是對(duì)硬件的抽象:
提供基礎(chǔ)框架來(lái)編寫和運(yùn)行設(shè)備驅(qū)動(dòng)程序是操作系統(tǒng)內(nèi)核責(zé)任的一部分。
盡管可以在用戶空間中運(yùn)行設(shè)備驅(qū)動(dòng)程序(通過(guò)一些內(nèi)核接口,如 UIO 或 I2CDEV),更常見(jiàn)的情況是讓它們?cè)趦?nèi)核空間中運(yùn)行。
以字符設(shè)備驅(qū)動(dòng)為例:
字符設(shè)備 (char device) 是一種最常見(jiàn)的硬件抽象。
/dev 目錄下的設(shè)備節(jié)點(diǎn)文件就是內(nèi)核導(dǎo)出給用戶空間的訪問(wèn)設(shè)備驅(qū)動(dòng)的接口。
設(shè)備節(jié)點(diǎn)文件中有三個(gè)基本信息:
- Type,用于標(biāo)識(shí)是 block 還是 char device;
- Major number,用于標(biāo)志是那一類 char deivce;
- Minor number,用于標(biāo)志是哪一個(gè) char device;
編寫字符設(shè)備驅(qū)動(dòng)的流程:
1、分配設(shè)備號(hào),這通過(guò) register_chrdev_region() 或 alloc_chrdev_region() 來(lái)完成;
2、實(shí)現(xiàn)文件操作(open、read、write、ioctl)等。
3、使用 cdev_init() 和 cdev_add() 向內(nèi)核中注冊(cè)字符設(shè)備。
以 LED 字符設(shè)備驅(qū)動(dòng)為例
如果按照從 0 構(gòu)建的思路編寫驅(qū)動(dòng)的話,偽代碼如下:
硬件訪問(wèn)相關(guān):
static struct {
dev_t devnum;
struct cdev cdev;
unsigned int led_status;
void __iomem *regbase;
} drvled_data;
static void drvled_setled(unsigned int status)
{
u32 val;
/* set value */
val = readl(drvled_data.regbase + GPIO1_REG_DATA);
if (status == LED_ON)
val |= GPIO_BIT;
else if (status == LED_OFF)
val &= ~GPIO_BIT;
writel(val, drvled_data.regbase + GPIO1_REG_DATA);
/* update status */
drvled_data.led_status = status;
}
static void drvled_setdirection(void)
{
...
}
文件操作相關(guān):
static ssize_t drvled_read(struct file *file, char __user *buf,
size_t count, loff_t *ppos)
{
...
}
static ssize_t drvled_write(struct file *file, const char __user *buf,
size_t count, loff_t *ppos)
{
char kbuf = 0;
if (copy_from_user(&kbuf, buf, 1))
return -EFAULT;
if (kbuf == '1') {
drvled_setled(LED_ON);
pr_info("LED ON!\n");
} else if (kbuf == '0') {
drvled_setled(LED_OFF);
pr_info("LED OFF!\n");
}
return count;
}
static const struct file_operations drvled_fops = {
.owner = THIS_MODULE,
.write = drvled_write,
.read = drvled_read,
};
注冊(cè)和卸載字符設(shè)備相關(guān):
static int __init drvled_init(void)
{
int result = 0;
if (!request_mem_region(GPIO1_BASE, GPIO1_SIZE, DRIVER_NAME)) {
pr_err("%s: Error requesting I/O!\n", DRIVER_NAME);
result = -EBUSY;
goto ret_err_request_mem_region;
}
drvled_data.regbase = ioremap(GPIO1_BASE, GPIO1_SIZE);
if (!drvled_data.regbase) {
pr_err("%s: Error mapping I/O!\n", DRIVER_NAME);
result = -ENOMEM;
goto err_ioremap;
}
result = alloc_chrdev_region(&drvled_data.devnum, 0, 1, DRIVER_NAME);
if (result) {
pr_err("%s: Failed to allocate device number!\n", DRIVER_NAME);
goto ret_err_alloc_chrdev_region;
}
cdev_init(&drvled_data.cdev, &drvled_fops);
result = cdev_add(&drvled_data.cdev, drvled_data.devnum, 1);
if (result) {
pr_err("%s: Char device registration failed!\n", DRIVER_NAME);
goto ret_err_cdev_add;
}
drvled_setdirection();
drvled_setled(LED_OFF);
pr_info("%s: initialized.\n", DRIVER_NAME);
goto ret_ok;
ret_err_cdev_add:
unregister_chrdev_region(drvled_data.devnum, 1);
ret_err_alloc_chrdev_region:
iounmap(drvled_data.regbase);
err_ioremap:
release_mem_region(GPIO1_BASE, GPIO1_SIZE);
ret_err_request_mem_region:
ret_ok:
return result;
}
static void __exit drvled_exit(void)
{
...
}
module_init(drvled_init);
module_exit(drvled_exit);
運(yùn)行效果:
$ install ledrv.ko
$ ls /dev/led
# 燈亮
$ echo 1 >/dev/led
# 燈滅
$ echo 1 >/dev/led
三個(gè)問(wèn)題
單從功能的角度看,上面的程序完全滿足控制一個(gè) LED 的需求。
但是,它不是一個(gè)好的驅(qū)動(dòng),這里有 3 個(gè)問(wèn)題。
問(wèn)題 1:
它創(chuàng)建的接口是 /dev/led,這不是一個(gè)通用接口,會(huì)增加上層開(kāi)發(fā)人員的學(xué)習(xí)成本。
解決這個(gè)問(wèn)題需要在 LED char driver 上再添加一層 LED framework,LED framework 負(fù)責(zé)給用戶空間提供標(biāo)準(zhǔn)化的訪問(wèn)接口,同時(shí)用于添加可復(fù)用的邏輯功能。
基本上各種設(shè)備驅(qū)動(dòng)都有自己的 framework,例如 input, IIO, ALSA, V2L2, RTC, watchdog 等。
使用這些 framework 驅(qū)動(dòng)工程師不用考慮提供給用戶空間的接口,應(yīng)用開(kāi)發(fā)人員也只需要學(xué)習(xí)一次標(biāo)準(zhǔn)的硬件訪問(wèn)接口接口。
問(wèn)題 2:
它只是控制 1 個(gè) gpio,但是卻申請(qǐng)使用了 2 個(gè)寄存器,這 2 個(gè)寄存器負(fù)責(zé)控制芯片的 8 個(gè) gpio。這意味著其他 7 個(gè) gpio 再也沒(méi)法被其他驅(qū)動(dòng)申請(qǐng)使用。
解決這個(gè)問(wèn)題需要引入一個(gè) gpio 的管理者:gpiolib。gpiolib 負(fù)責(zé)統(tǒng)一管理和分配 gpio 資源。
問(wèn)題 3:
它包含了硬件信息。如果我們想控制另外一個(gè) gpio或者多個(gè) gpio,就得改動(dòng)源碼,代碼維護(hù)的工作量極大。
解決這個(gè)問(wèn)題我們需要將硬件信息從代碼中抽取出來(lái),具體的就是引入總線、設(shè)備、驅(qū)動(dòng)模型。
更好的 LED 驅(qū)動(dòng)
我們用上面的思路,寫一個(gè)更合理的 LED 驅(qū)動(dòng)。
引入 LED framework:
1、初始化 led_classdev 結(jié)構(gòu)體。
2、提供一個(gè)回調(diào)函數(shù)來(lái)改變狀態(tài) LED 的。
3、使用 led_classdev_register() 在想 LED framework 注冊(cè)驅(qū)動(dòng)程序。
引入 gpiolib:
內(nèi)核管理 gpio 的思路是典型的 producer/consumer 模型。
GPIO controller driver 是 producer,LED driver 是 consumer。
下面是幾個(gè)常用的 gpiolib api,它們的作用一目了然:
#include <linux/gpio.h>
#include <linux/gpio/consumer.h>
struct gpio_desc *gpiod_get(struct device *dev, const char *con_id,enum gpiod_flags flags);
void gpiod_put(struct gpio_desc *desc);
int gpiod_direction_input(struct gpio_desc *desc);
int gpiod_direction_output(struct gpio_desc *desc, int value);
void gpiod_set_value(struct gpio_desc *desc, int value);
int gpiod_get_value(const struct gpio_desc *desc);
引入總線、設(shè)備、驅(qū)動(dòng)模型 :
該模型包含 4 部分。
Bus core: 對(duì)硬件總線的抽象,不同總線有不同的 Bus core,例如 USB core, SPI core, I2C core, PCI core ,在內(nèi)核中由 bus_type 結(jié)構(gòu)表示。
Bus adapters: 總線控制器驅(qū)動(dòng)程序,在內(nèi)核中由 device_driver 結(jié)構(gòu)體表示。
Bus drivers: 負(fù)責(zé)管理連接到總線的設(shè)備的驅(qū)動(dòng)程序,在內(nèi)核中由 device_driver 結(jié)構(gòu)體表示。
Bus devices: 連接到總線的設(shè)備,在內(nèi)核中由結(jié)構(gòu) device 表示。
內(nèi)核虛擬了一條叫 Platform 的總線,用于適配 LED 這種不屬于任何總線的設(shè)備。
看下改造后的代碼:
設(shè)備信息:
LED {
<&gpio1 9>
}
硬件控制:
tatic struct drvled_data_st *drvled_data;
static void drvled_setled(unsigned int status)
{
// 控制 gpio
if (status == LED_ON)
gpiod_set_value(drvled_data->desc, 1);
else
gpiod_set_value(drvled_data->desc, 0);
}
static void drvled_change_state(struct led_classdev *led_cdev,
enum led_brightness brightness)
{
if (brightness)
drvled_setled(LED_ON);
else
drvled_setled(LED_OFF);
}
向 LED framework 注冊(cè):
static int drvled_probe(struct platform_device *pdev)
{
struct device_node *np = pdev->dev.of_node;
struct device_node *child = NULL;
int result, gpio;
child = of_get_next_child(np, NULL);
drvled_data = devm_kzalloc(&pdev->dev, sizeof(*drvled_data),
GFP_KERNEL);
if (!drvled_data)
return -ENOMEM;
// 從設(shè)備數(shù)中獲得硬件信息
gpio = of_get_gpio(child, 0);
result = devm_gpio_request(&pdev->dev, gpio, pdev->name);
if (result) {
dev_err(&pdev->dev, "Error requesting GPIO\n");
return result;
}
drvled_data->desc = gpio_to_desc(gpio);
drvled_data->led_cdev.name = of_get_property(child, "label", NULL);
drvled_data->led_cdev.brightness_set = drvled_change_state;
// 注冊(cè)進(jìn) LED framework
result = devm_led_classdev_register(&pdev->dev, &drvled_data->led_cdev);
if (result) {
dev_err(&pdev->dev, "Error registering led\n");
return result;
}
gpiod_direction_output(drvled_data->desc, 0);
dev_info(&pdev->dev, "initialized.\n");
return 0;
}
static int drvled_remove(struct platform_device *pdev)
{
dev_info(&pdev->dev, "exiting.\n");
return 0;
}
static const struct of_device_id of_drvled_match[] = {
{ .compatible = "labworks,drvled" },
{},
};
static struct platform_driver drvled_driver = {
.driver = {
.name = "drvleds",
.owner = THIS_MODULE,
.of_match_table = of_drvled_match,
},
.probe = drvled_probe,
.remove = drvled_remove,
};
module_platform_driver(drvled_driver);
改造后,應(yīng)用總是通過(guò)下面這種標(biāo)準(zhǔn)的接口訪問(wèn) LED:
# 燈亮
$ echo 1 > /sys/class/leds/<LED driver name>/brightness
# 燈滅
$ echo 0 > /sys/class/leds/<LED driver name>/brightness
并且有大量的 trigger 可供使用,例如讓 LED 呈心跳狀態(tài)的 heartbeat trigger:
$ echo heartbeat > /sys/class/leds/<LED driver name>/trigger
假設(shè)這時(shí)你想改用 gpio expander 芯片來(lái)控制 LED:
只需要添加這個(gè) gpio expander 的驅(qū)動(dòng)代碼,并且修改設(shè)備樹(shù)即可,其他部分完全不需要改動(dòng):
gpioexp {
I2C0, 0x10
}
LED {
<&gpioexp 3>
}
到此,你是否更清楚如何為 Linux 添加設(shè)備驅(qū)動(dòng)了呢?