Linux leds-gpio 驱动移植

概述

leds-gpio 封装得十分好，只需要提供可正常使用的 GPIO 即可。另外还具备触发器功能，其实就是控制 LED 的亮灭 (及频率)。比如 default-on 是点亮 LED 灯的触发器，没有取消前一直亮着。heartbeat 是心跳触发器，经笔者实践，此触发器是快速闪烁 2 次，然后灭掉，灭掉时间较亮的时间长。timer 为定时触发器，即 1HZ 内亮灭。其它还有如 ide 硬盘、mmc、CPU 触发器，就不一一介绍了。

leds 驱动位于 drivers/leds 目录。leds-gpio 驱动名称为“leds-gpio”，驱动文件为 drivers/leds/leds-gpio.c。

触发器驱动位于 drivers/leds/trigger 目录。

内核配置

本文基于 linux 3.17.1 版本内核进行分析。

Device Drivers->  
    -*- LED Support  --->    
        {*}   LED Class Support # 与用户空间交互的  
        <M>   LED Support for GPIO connected LEDs   # 可为模块，也可编译到内核中  
        -*-   LED Trigger support  ---> #触发器，最好编译到内核中（即选项“*”）<*>   LED Timer Trigger  
        <*>   LED One-shot Trigger  
        <*>   LED Heartbeat Trigger  
        <*>   LED backlight Trigger  
        [*]   LED CPU Trigger  
        <*>   LED GPIO Trigger  
        <*>   LED Default ON Trigger

从配置中看到，笔者将 LED 触发器全部编译到内核中。这样方便使用和选择。

设备注册及使用

LED 相关结构体

驱动开发者使用 gpio_led 对 LED 进行赋值，包括 LED 名称、GPIO 引脚号、灯亮是哪个电平，还有默认状态。gpio_led 结构体定义如下：

struct gpio_led {  
    const char *name; // 名称，会生成 /sys/.../leds/name 目录  
    const char *default_trigger; // 默认触发器，可写可不写，在命令行可以重新赋值  
    unsigned     gpio; // GPIO 引脚号  
    unsigned    active_low : 1; // 为 1 表示低电平 LED 点亮  
    unsigned    retain_state_suspended : 1;  
    unsigned    default_state : 2; // 默认状态  
    /* default_state should be one of LEDS_GPIO_DEFSTATE_(ON|OFF|KEEP) */  
}; 

另外还要填写 gpio_led_platform_data 结构体，其定义如下：

struct gpio_led_platform_data {  
    int         num_leds; // 一共有多少个 LED 灯  
    const struct gpio_led *leds; // 上面的结构体指针  
  
#define GPIO_LED_NO_BLINK_LOW    0    /* No blink GPIO state low */  
#define GPIO_LED_NO_BLINK_HIGH    1    /* No blink GPIO state high */  
#define GPIO_LED_BLINK        2    /* Please, blink */  
    int        (*gpio_blink_set)(unsigned gpio, int state,  
                    unsigned long *delay_on,  
                    unsigned long *delay_off); // LED 闪烁回调函数，可置为 NULL  
}; 

一个实例如下：

static struct gpio_led gpio_leds[] = {  
    {  
        .name = "red",  
        .gpio = 33, // GP2_1   GPIO_NO = Group * 32 + Id  
        .default_state = LEDS_GPIO_DEFSTATE_ON, // 默认 LED 亮  
        .active_low = 1, // 低电平亮  
        //.default_trigger = "timer", // 触发器  
    },  
    {  
        .name = "green",  
        .gpio = 34,  
        .default_state = LEDS_GPIO_DEFSTATE_ON,   
        .active_low = 1,  
        //.default_trigger = "heartbeat",   
    },  
};  
  
static struct gpio_led_platform_data gpio_led_info = {  
     .leds          = gpio_leds,  
     .num_leds     = ARRAY_SIZE(gpio_leds),  
}; 

从结构体中知道，系统有 2 个 LED，一个红灯，一个绿灯，都是低电平灯亮。

驱动源码分析

leds-gpio 驱动定义如下 (drivers/leds/leds-gpio.c)：

static struct platform_driver gpio_led_driver = {  
    .probe        = gpio_led_probe,  
    .remove        = gpio_led_remove,  
    .driver        = {  
        .name    = "leds-gpio",  
        .owner    = THIS_MODULE,  
        .of_match_table = of_match_ptr(of_gpio_leds_match),  
    },  
};  
  
module_platform_driver(gpio_led_driver); 

从 gpio_led_driver 结构体中可以看到驱动名称为 leds-gpio。因此要使用这个驱动，必须另外定义一个 platform 设备，并调用函数 platform_device_register 注册。本文实例如下：

static struct platform_device leds_gpio = {  
    .name = "leds-gpio",  
    .id = -1,  
    .dev = {  
        .platform_data = &gpio_led_info,  
        .release = platformdev_release,  
    },  
};  

其中 name 表示设备名称，必须为“leds-gpio”，这样才能匹配并加载成功。最后提一下 release 成员，在较新的内核中必须对此进行赋值，否则会有错误信息提示：

Device 'leds-gpio' does not have a release() function, it is broken and must be fixed.

最后，注册 leds 设备——建议在板子的 GPIO 正常工作之后再进行注册。

platform_device_register(&leds_gpio); // 注册 leds 设备  

注意，如果是以 modules 形式动态加载的话，必须要适合的地方如 remove 函数在卸载 leds 设备：

platform_device_unregister(&leds_gpio); // 卸载 leds 设备  

应用实例

LED 设备和驱动都正常情况下，系统启动后，会产生 /sys/bus/platform/devices/leds-gpio/leds 目录，其下分别有 red 和 green 两个子目录。可以分别对不同的红色 LED 和绿色 LED 做操作。

亮灭 LED

将 1 或 0 写入 brightness 文件即可控制亮灭。

示例如下：

echo 0 > /sys/bus/platform/devices/leds-gpio/leds/green/brightness  
echo 0 > /sys/bus/platform/devices/leds-gpio/leds/red/brightness   

echo 1 > /sys/bus/platform/devices/leds-gpio/leds/green/brightness  
echo 1 > /sys/bus/platform/devices/leds-gpio/leds/red/brightness   

触发器

直接查看 trigger 文件，即可知道当前系统支持的触发器，示例：

cat /sys/bus/platform/devices/leds-gpio/leds/red/trigger   
[none] timer oneshot heartbeat backlight gpio cpu0 default-on mmc0 mmc1 mmc2  

在前面的驱动中注释掉了 trigger，所以现在是 none。

设置触发器很简单，使用 ecoh 将需要的触发器名称写入 trigger 文件即可。注意，写入的字符串一定是 trigger 文件已经存在的，否则会提示参数非法。写入心跳触发器示例：

echo heartbeat > /sys/bus/platform/devices/leds-gpio/leds/red/trigger 

此时板子上红灯应会闪烁。

再次查看：

cat /sys/bus/platform/devices/leds-gpio/leds/red/trigger   

none timer oneshot [heartbeat] backlight gpio cpu0 default-on mmc0 mmc1 mmc2  

设置值已经生效了。

参考资源：

1. 内核源码官网：https://www.kernel.org
2. 内核源码查询：http://lxr.free-electrons.com…