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

*本文為個(gè)人學(xué)習(xí)記錄，如有錯(cuò)誤，歡迎指正。

*本文參考資料：

*　　　　　　　　https://blog.csdn.net/qq_28992301/article/details/52410587

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

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

1. 驅(qū)動(dòng)框架的概念

內(nèi)核中驅(qū)動(dòng)部分維護(hù)者針對(duì)每個(gè)種類的驅(qū)動(dòng)設(shè)計(jì)一套成熟的、標(biāo)準(zhǔn)的、典型的驅(qū)動(dòng)實(shí)現(xiàn)，并把不同廠家的同類硬件驅(qū)動(dòng)中相同的部分抽出來(lái)自己實(shí)現(xiàn)好，再把不同部分留出接口給具體的驅(qū)動(dòng)開(kāi)發(fā)工程師來(lái)實(shí)現(xiàn)，這就叫驅(qū)動(dòng)框架。即標(biāo)準(zhǔn)化的驅(qū)動(dòng)實(shí)現(xiàn),統(tǒng)一管理系統(tǒng)資源，維護(hù)系統(tǒng)穩(wěn)定。

2. LED設(shè)備驅(qū)動(dòng)框架概述

（1）LED設(shè)備的共性：

1）LED的亮與滅；

2）具有相應(yīng)的設(shè)備節(jié)點(diǎn)（設(shè)備文件）。

（2）LED設(shè)備的不同點(diǎn)：

1）LED的硬件連接方式不同（GPIO不同）；

2）LED的控制方式不同（低或高電平觸發(fā)）；

3）等其他不同點(diǎn)。

因此，Linux中LED的驅(qū)動(dòng)框架把所有LED設(shè)備的共性給實(shí)現(xiàn)了，把不同的地方留給驅(qū)動(dòng)工程師去做。

（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）輔助文件(根據(jù)需求來(lái)決定這部分代碼是否需要)：

/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設(shè)備驅(qū)動(dòng)框架分析

3.1 創(chuàng)建leds類

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

內(nèi)核在啟動(dòng)過(guò)程中，內(nèi)核需要按照先后順序去進(jìn)行初始化操作。因此，內(nèi)核給是給啟動(dòng)時(shí)要調(diào)用的所有初始化函數(shù)歸類，然后每個(gè)類按照一定的次序去調(diào)用執(zhí)行。這些分類名就叫.initcalln.init，n的值從1到8。內(nèi)核開(kāi)發(fā)者在編寫(xiě)內(nèi)核代碼時(shí)只要將函數(shù)設(shè)置合適的級(jí)別，這些函數(shù)就會(huì)被鏈接的時(shí)候放入特定的段，內(nèi)核啟動(dòng)時(shí)再按照段順序去依次執(zhí)行各個(gè)段即可。module_init()、module_exit()也是一個(gè)宏，其功能與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驅(qū)動(dòng)框架使用subsys_initcall宏修飾leds_init()函數(shù)，因此leds_init()函數(shù)在內(nèi)核啟動(dòng)階段被調(diào)用。leds_init()函數(shù)的主要工作是：調(diào)用class_create()函數(shù)在/sys/class目錄下創(chuàng)建一個(gè)leds類目錄。

//所在文件/kernel/driver/leds/led-class.c
static int __init leds_init(void)
{
    leds_class = class_create(THIS_MODULE, "leds");  //在/sys/class目錄下創(chuàng)建一個(gè)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規(guī)定了leds設(shè)備類的類屬性，其中的類屬性將被sysfs以文件的形式導(dǎo)出至/sys/class/leds目錄下，用戶空間通過(guò)對(duì)這些文件的訪問(wèn)來(lái)操作硬件設(shè)備。詳見(jiàn)Linux設(shè)備管理：sysfs文件系統(tǒng)的功能及其應(yīng)用。

led_class_attrs結(jié)構(gòu)體數(shù)組設(shè)置了leds設(shè)備類的屬性，即led硬件操作的對(duì)象和方法。分析可知，leds類設(shè)備的操作對(duì)象一共由3個(gè)brightness（LED的亮滅狀態(tài)）、max_brightness（LED最高亮度值）、trigger（LED閃爍狀態(tài)）。對(duì)應(yīng)的操作規(guī)則有讀寫(xiě)，即show和store。這些操作規(guī)則內(nèi)部其實(shí)調(diào)用了設(shè)備體led_classdev內(nèi)的具體操作函數(shù)，譬如：當(dāng)用戶層試圖寫(xiě)brightness這個(gè)對(duì)象時(shí)，會(huì)觸發(fā)操作規(guī)則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中呈現(xiàn)的文件。
*_mode表示這個(gè)屬性的讀寫(xiě)權(quán)限,如0666, 分別表示user/group/other的權(quán)限都是可讀可寫(xiě)。
*_show表示的是對(duì)此屬性的讀函數(shù),當(dāng)cat這個(gè)屬性的時(shí)候被調(diào)用，_stroe表示的是對(duì)此屬性的寫(xiě)函數(shù),當(dāng)echo內(nèi)容到這個(gè)屬性的時(shí)候被調(diào)用。
*/

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

3.3 LED設(shè)備信息初始化

在registerLED設(shè)備之前，需要先定義并初始化一個(gè)struct led_classdev結(jié)構(gòu)體變量，該結(jié)構(gòu)體包含了該LED設(shè)備的所有信息。

初始化struct led_classdev結(jié)構(gòu)體變量時(shí)，只需填充如下值即可，其余的在register過(guò)程中自動(dòng)完成填充。

--name：LED設(shè)備目錄名稱；

--brightness：LED設(shè)備初始亮度；

--max_brightness：LED設(shè)備的最大亮度；

--void (*brightness_set)(struct led_classdev *led_cdev, enum led_brightness brightness)：該函數(shù)為實(shí)際操作LED硬件的函數(shù)，由驅(qū)動(dòng)工程師根據(jù)具體的LED設(shè)備來(lái)實(shí)現(xiàn)；

--enum led_brightness (*brightness_get)(struct led_classdev *led_cdev)：該函數(shù)用于獲取LED設(shè)備的當(dāng)前亮度值，LED驅(qū)動(dòng)框架已實(shí)現(xiàn)led_get_brightness()函數(shù)（/kernel/drivers/leds/leds.h），將該函數(shù)的函數(shù)名賦予這個(gè)指針變量即可。

struct led_classdev {
    const char      *name;          //LED設(shè)備名
    int             brightness;     //LED設(shè)備的初始亮度
    int             max_brightness; //LED設(shè)備的最大亮度
    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); //設(shè)置LED設(shè)備的亮度
    enum led_brightness (*brightness_get)(struct led_classdev *led_cdev);　　　　　　　　　　 //獲取LED設(shè)備的當(dāng)前亮度

    /* 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設(shè)備的register接口

LED設(shè)備驅(qū)動(dòng)框架為驅(qū)動(dòng)開(kāi)發(fā)者提供在/sys/class/leds這個(gè)類下創(chuàng)建LED設(shè)備的接口。

當(dāng)驅(qū)動(dòng)調(diào)用led_classdev_register注冊(cè)了一個(gè)LED設(shè)備，那么就會(huì)在/sys/class/leds目錄下創(chuàng)建xxx設(shè)備，由sysfs創(chuàng)建該設(shè)備的一系列attr屬性文件（brightness、max_brightness等）將被保存至該目錄下供用戶空間訪問(wèn)。

//所在文件/kernel/driver/leds/led-class.c
int led_classdev_register(struct device *parent, struct led_classdev *led_cdev)
{
    //在/sys/class/leds設(shè)備類目錄下創(chuàng)建具體的設(shè)備目錄，目錄名由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);
　　
　　//如果設(shè)備驅(qū)動(dòng)在注冊(cè)時(shí)沒(méi)有設(shè)置max_brightness,則將max_brightness設(shè)置為滿即255
    if (!led_cdev->max_brightness)
        led_cdev->max_brightness = LED_FULL;

　　//如果在初始化struct_classdev *led_cdev時(shí),設(shè)置了get_brightness方法,則讀出當(dāng)前的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); //在內(nèi)核啟動(dòng)過(guò)程中打印所注冊(cè)設(shè)備類的名稱

    return 0;
}

3.5 leds類屬性的操作方法實(shí)現(xiàn)

當(dāng)用戶在文件系統(tǒng)下讀寫(xiě)LED設(shè)備的屬性文件時(shí),就會(huì)調(diào)用這些屬性文件的show和store方法，從而操作硬件。

（1）brightness屬性操作

1）當(dāng)用戶cat /sys/class/leds/xxx/brightness時(shí)會(huì)調(diào)用led-class.c中的brightness_show函數(shù)。

//所在文件/kernel/driver/leds/led-class.c
static ssize_t led_brightness_show(struct device *dev, struct device_attribute *attr, char *buf)
{
　　//根據(jù)device結(jié)構(gòu)體獲取led_classdev結(jié)構(gòu)體，其中包含了該LED設(shè)備的所有信息
　　struct led_classdev *led_cdev = dev_get_drvdata(dev);
　　//如果在初始化struct_classdev *led_cdev時(shí),設(shè)置了get_brightness方法,則讀出當(dāng)前的brightness并更新
 　led_update_brightness(led_cdev); 
　　
　 return sprintf(buf, "%u\n", led_cdev->brightness);  //將LED當(dāng)前亮度值存入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）當(dāng)用戶 echo 100 > /sys/class/leds/xxx/brightness時(shí)會(huì)調(diào)用led-class.c中的brightness_store函數(shù)。

//所在文件/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)
{
　　 //根據(jù)device結(jié)構(gòu)體獲取led_classdev結(jié)構(gòu)體，其中包含了該LED設(shè)備的所有信息
　　 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);//設(shè)置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);  //調(diào)用led_classdev下的LED硬件操作函數(shù)brightness_set，該函數(shù)由驅(qū)動(dòng)工程師完成編寫(xiě)。
}

（2）max_brightness屬性操作

當(dāng)用戶當(dāng)用戶cat /sys/class/leds/xxx/max_brightness時(shí)會(huì)調(diào)用led-class.c中的led_max_brightness_show函數(shù)。

//所在文件/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設(shè)備的unregister接口

LED設(shè)備驅(qū)動(dòng)框架為驅(qū)動(dòng)開(kāi)發(fā)者LED設(shè)備驅(qū)動(dòng)的卸載接口。調(diào)用led_classdev_unregister()函數(shù)卸載LED設(shè)備驅(qū)動(dòng)。

//所在文件/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);  //注銷設(shè)備類下的設(shè)備

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

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

module_exit(leds_exit);