Linux內核的LED設備驅動框架【轉】

/************************************************************************************

*本文爲我的學習記錄，若有錯誤，歡迎指正。

*本文參考資料：

*　　　　　　　　http://www.javashuo.com/article/p-mzpeqkih-ea.html

*　　　　　　　　https://blog.csdn.net/hanp_linux/article/details/79037610

************************************************************************************/

1. 驅動框架的概念

內核中驅動部分維護者針對每一個種類的驅動設計一套成熟的、標準的、典型的驅動實現，並把不一樣廠家的同類硬件驅動中相同的部分抽出來本身實現好，再把不一樣部分留出接口給具體的驅動開發工程師來實現，這就叫驅動框架。即標準化的驅動實現,統一管理系統資源，維護系統穩定。

2. LED設備驅動框架概述

（1）LED設備的共性：

1）LED的亮與滅；

2）具備相應的設備節點（設備文件）。

（2）LED設備的不一樣點：

1）LED的硬件鏈接方式不一樣（GPIO不一樣）；

2）LED的控制方式不一樣（低或高電平觸發）；

3）等其餘不一樣點。

所以，Linux中LED的驅動框架把全部LED設備的共性給實現了，把不一樣的地方留給驅動工程師去作。

（3）核心文件：

　　

/kernel/driver/leds/led-class.c 
/kernel/driver/leds/led-core.c 
/kernel/driver/leds/led-triggers.c 
/kernel/include/linux/leds.h

（4）輔助文件(根據需求來決定這部分代碼是否須要)：

　　

/kernel/driver/leds/led-triggers.c 
/kernel/driver/leds/trigger/led-triggers.c 
/kernel/driver/leds/trigger/ledtrig-oneshot.c 
/kernel/driver/leds/trigger/ledtrig-timer.c 
/kernel/driver/leds/trigger/ledtrig-heartbeat.c

3. LED設備驅動框架分析

3.1 建立leds類

subsys_initcall是一個宏，它的功能是將其聲明的函數放到一個特定的段：.initcall4.init。

內核在啓動過程當中，內核須要按照前後順序去進行初始化操做。所以，內核給是給啓動時要調用的全部初始化函數歸類，而後每一個類按照必定的次序去調用執行。這些分類名就叫.initcalln.init，n的值從1到8。內核開發者在編寫內核代碼時只要將函數設置合適的級別，這些函數就會被連接的時候放入特定的段，內核啓動時再按照段順序去依次執行各個段便可。module_init()、module_exit()也是一個宏，其功能與subsys_initcall相同，只是指定的段不一樣。

//所在文件/kernel/include/linux/init.h
#define subsys_initcall(fn)        __define_initcall("4",fn,4)

#define __define_initcall(level,fn,id) \
    static initcall_t __initcall_##fn##id __used \
    __attribute__((__section__(".initcall" level ".init"))) = fn

LED驅動框架使用subsys_initcall宏修飾leds_init()函數，所以leds_init()函數在內核啓動階段被調用。leds_init()函數的主要工做是：調用class_create()函數在/sys/class目錄下建立一個leds類目錄。

//所在文件/kernel/driver/leds/led-class.c
static int __init leds_init(void)
{
    leds_class = class_create(THIS_MODULE, "leds");  //在/sys/class目錄下建立一個leds類目錄
    if (IS_ERR(leds_class))
        return PTR_ERR(leds_class);
　　/*填充leds_class*/ 
　　leds_class->suspend = led_suspend; 
　　leds_class->resume = led_resume; 
　　leds_class->dev_attrs = led_class_attrs; //類屬性 
　　return 0; 
} 

subsys_initcall(leds_init);

3.2 leds類屬性的定義與初始化

leds_class->dev_attrs規定了leds設備類的類屬性，其中的類屬性將被sysfs以文件的形式導出至/sys/class/leds目錄下，用戶空間經過對這些文件的訪問來操做硬件設備。詳見Linux設備管理：sysfs文件系統的功能及其應用。

led_class_attrs結構體數組設置了leds設備類的屬性，即led硬件操做的對象和方法。分析可知，leds類設備的操做對象一共由3個brightness（LED的亮滅狀態）、max_brightness（LED最高亮度值）、trigger（LED閃爍狀態）。對應的操做規則有讀寫，即show和store。這些操做規則內部其實調用了設備體led_classdev內的具體操做函數，譬如：當用戶層試圖寫brightness這個對象時，會觸發操做規則led_brightness_store。

//所在文件/kernel/driver/leds/led-class.c
static struct device_attribute led_class_attrs[] = 
{
    __ATTR(brightness, 0644, led_brightness_show, led_brightness_store),
    __ATTR(max_brightness, 0444, led_max_brightness_show, NULL),
#ifdef CONFIG_LEDS_TRIGGERS
    __ATTR(trigger, 0644, led_trigger_show, led_trigger_store),
#endif
    __ATTR_NULL,
};

/*
*所在文件/kernel/include/linux/sysfs.h
*_name表示屬性的名字,即在sys中呈現的文件。
*_mode表示這個屬性的讀寫權限,如0666, 分別表示user/group/other的權限都是可讀可寫。
*_show表示的是對此屬性的讀函數,當cat這個屬性的時候被調用，_stroe表示的是對此屬性的寫函數,當echo內容到這個屬性的時候被調用。
*/

#define __ATTR(_name,_mode,_show,_store) { \
    .attr = {.name = __stringify(_name), .mode = _mode },    \
    .show    = _show,                    \
    .store    = _store,                    \
}

3.3 LED設備信息初始化

在registerLED設備以前，須要先定義並初始化一個struct led_classdev結構體變量，該結構體包含了該LED設備的全部信息。

初始化struct led_classdev結構體變量時，只需填充以下值便可，其他的在register過程當中自動完成填充。

--name：LED設備目錄名稱；

--brightness：LED設備初始亮度；

--max_brightness：LED設備的最大亮度；

--void (brightness_set)(struct led_classdev led_cdev, enum led_brightness brightness)：該函數爲實際操做LED硬件的函數，由驅動工程師根據具體的LED設備來實現；

--enum led_brightness (brightness_get)(struct led_classdev led_cdev)：該函數用於獲取LED設備的當前亮度值，LED驅動框架已實現led_get_brightness()函數（/kernel/drivers/leds/leds.h），將該函數的函數名賦予這個指針變量便可。

struct led_classdev {
    const char      *name;          //LED設備名
    int             brightness;     //LED設備的初始亮度
    int             max_brightness; //LED設備的最大亮度
    int             flags;

    /* Lower 16 bits reflect status */
#define LED_SUSPENDED        (1 << 0)
    /* Upper 16 bits reflect control information */
#define LED_CORE_SUSPENDRESUME    (1 << 16)

    void (*brightness_set)(struct led_classdev *led_cdev, enum led_brightness brightness); //設置LED設備的亮度
    enum led_brightness (*brightness_get)(struct led_classdev *led_cdev);　　　　　　　　　　 //獲取LED設備的當前亮度

    /* Activate hardware accelerated blink, delays are in
     * miliseconds and if none is provided then a sensible default
     * should be chosen. The call can adjust the timings if it can't
     * match the values specified exactly. */
    int　(*blink_set)(struct led_classdev *led_cdev, unsigned long *delay_on, unsigned long *delay_off);

    struct device        *dev;
    struct list_head     node;            /* LED Device list */
    const char        *default_trigger;    /* Trigger to use */

#ifdef CONFIG_LEDS_TRIGGERS
    /* Protects the trigger data below */
    struct rw_semaphore     trigger_lock;

    struct led_trigger    *trigger;
    struct list_head     trig_list;
    void            *trigger_data;
#endif
};

3.4 LED設備的register接口

LED設備驅動框架爲驅動開發者提供在/sys/class/leds這個類下建立LED設備的接口。

當驅動調用led_classdev_register註冊了一個LED設備，那麼就會在/sys/class/leds目錄下建立xxx設備，由sysfs建立該設備的一系列attr屬性文件（brightness、max_brightness等）將被保存至該目錄下供用戶空間訪問。

//所在文件/kernel/driver/leds/led-class.c
int led_classdev_register(struct device *parent, struct led_classdev *led_cdev)
{
    //在/sys/class/leds設備類目錄下建立具體的設備目錄，目錄名由led_cdev->name指定
    led_cdev->dev = device_create(leds_class, parent, 0, led_cdev, "%s", led_cdev->name); 

    if (IS_ERR(led_cdev->dev))
        return PTR_ERR(led_cdev->dev);

#ifdef CONFIG_LEDS_TRIGGERS
    init_rwsem(&led_cdev->trigger_lock);
#endif
    /* add to the list of leds */
    down_write(&leds_list_lock);
    list_add_tail(&led_cdev->node, &leds_list);
    up_write(&leds_list_lock);
　　
　　//若是設備驅動在註冊時沒有設置max_brightness,則將max_brightness設置爲滿即255
    if (!led_cdev->max_brightness)
        led_cdev->max_brightness = LED_FULL;

　　//若是在初始化struct_classdev *led_cdev時,設置了get_brightness方法,則讀出當前的brightness並更新
    led_update_brightness(led_cdev);

#ifdef CONFIG_LEDS_TRIGGERS
    led_trigger_set_default(led_cdev);
#endif

    printk(KERN_DEBUG "Registered led device: %s\n", led_cdev->name); //在內核啓動過程當中打印所註冊設備類的名稱

    return 0;
}

3.5 leds類屬性的操做方法實現

當用戶在文件系統下讀寫LED設備的屬性文件時,就會調用這些屬性文件的show和store方法，從而操做硬件。

（1）brightness屬性操做

1）當用戶cat /sys/class/leds/xxx/brightness時會調用led-class.c中的brightness_show函數。

//所在文件/kernel/driver/leds/led-class.c
static ssize_t led_brightness_show(struct device *dev, struct device_attribute *attr, char *buf)
{
　　//根據device結構體獲取led_classdev結構體，其中包含了該LED設備的全部信息
　　struct led_classdev *led_cdev = dev_get_drvdata(dev);
　　//若是在初始化struct_classdev *led_cdev時,設置了get_brightness方法,則讀出當前的brightness並更新
 　led_update_brightness(led_cdev); 
　　
　 return sprintf(buf, "%u\n", led_cdev->brightness);  //將LED當前亮度值存入buf中
}

static void led_update_brightness(struct led_classdev *led_cdev)
{
    if (led_cdev->brightness_get)
        led_cdev->brightness = led_cdev->brightness_get(led_cdev); 
}


static inline int led_get_brightness(struct led_classdev *led_cdev)
{
    return led_cdev->brightness;
}

2）當用戶 echo 100 > /sys/class/leds/xxx/brightness時會調用led-class.c中的brightness_store函數。

//所在文件/kernel/driver/leds/led-class.c
static ssize_t led_brightness_store(struct device *dev, struct device_attribute *attr, const char *buf, size_t size)
{
　　 //根據device結構體獲取led_classdev結構體，其中包含了該LED設備的全部信息
　　 struct led_classdev *led_cdev = dev_get_drvdata(dev);
    ssize_t ret = -EINVAL;
    char *after;
    unsigned long state = simple_strtoul(buf, &after, 10);
    size_t count = after - buf;

    if (isspace(*after))
        count++;

    if (count == size) {
        ret = count;

        if (state == LED_OFF)
            led_trigger_remove(led_cdev);
        led_set_brightness(led_cdev, state);//設置LED亮度
    }
    return ret;
}

//所在文件/kernel/driver/leds/leds.h
static inline void led_set_brightness(struct led_classdev *led_cdev, enum led_brightness value)
{
    if (value > led_cdev->max_brightness)
        value = led_cdev->max_brightness;
    led_cdev->brightness = value;
    if (!(led_cdev->flags & LED_SUSPENDED))
        led_cdev->brightness_set(led_cdev, value);  //調用led_classdev下的LED硬件操做函數brightness_set，該函數由驅動工程師完成編寫。
}

（2）max_brightness屬性操做

當用戶當用戶cat /sys/class/leds/xxx/max_brightness時會調用led-class.c中的led_max_brightness_show函數。

//所在文件/kernel/driver/leds/led-class.c
static ssize_t led_max_brightness_show(struct device *dev, struct device_attribute *attr, char *buf)
{
    struct led_classdev *led_cdev = dev_get_drvdata(dev);

    return sprintf(buf, "%u\n", led_cdev->max_brightness);//將最大亮度值保存至buf中
}

3.6 LED設備的unregister接口

LED設備驅動框架爲驅動開發者LED設備驅動的卸載接口。調用led_classdev_unregister()函數卸載LED設備驅動。

//所在文件/kernel/driver/leds/led-class.c
void led_classdev_unregister(struct led_classdev *led_cdev)
{
#ifdef CONFIG_LEDS_TRIGGERS
    down_write(&led_cdev->trigger_lock);
    if (led_cdev->trigger)
        led_trigger_set(led_cdev, NULL);
    up_write(&led_cdev->trigger_lock);
#endif

    device_unregister(led_cdev->dev);  //註銷設備類下的設備

    down_write(&leds_list_lock);
    list_del(&led_cdev->node);
    up_write(&leds_list_lock);
}

//註銷設備類
static void __exit leds_exit(void)
{
    class_destroy(leds_class);
}

module_exit(leds_exit);