Linux驱动---/sys接口

一、伪文件 sys

伪文件(Pseudo File) 是 Linux 系统中一种特殊的文件,它不占用物理存储空间,而是由内核或系统动态生成,用于提供某种特定的功能或信息。我们本篇文章所整理的 /sys 便是伪文件,它提供了内核对象(如设备、驱动、总线)的属性和状态信息。

在上篇LED驱动文章中,我们通过在 /dev 下创建设备节点,提供了用户空间访问硬件设备的入口。不过这种情况下,用户只能通过open()、read()、write()等函数编程来操作设备。而 /sys 下的文件是内核为用户空间提供的高级抽象接口,直接读写文件(如cat、echo等)会触发内核中对应的回调函数,完成配置或信息获取。

这样,当我们回顾以前的知识就会发现,在学习Linux下的GPIO操作时为什么有 libgpiod 和 sysfs 两种操作方式,其实就是一直是通过编程操作 /dev 的设备,另一种是直接通过命令行操作 /sys 的设备。

二、led_classdev结构体

每个 LED 设备在内核中通过一个 led_classdev 结构体来表示。这个结构体包含了 LED 设备的各种属性和控制函数,例如亮度设置函数、最大亮度等,定义如下(只整理了常见部分):

struct led_classdev
{
  	const char		*name;                       // 设备名字
	enum led_brightness	 brightness;             // LED 默认亮度
	enum led_brightness	 max_brightness;         // LED 的最大亮度

    // 用于设置 LED 亮度的函数指针,不可休眠
    void    (*brightness_set)(struct led_classdev *led_cdev, enum led_brightness brightness);

    //用于设置 LED 亮度的函数指针,可以休眠
    int     (*brightness_set_blocking)(struct led_classdev *led_cdev, enum led_brightness brightness);
  
    struct device	    *dev;
    const char		    *default_trigger;
}


(1)name:表示设备名字;

(2)brightness和max_brightness:这两个成员都是枚举类型 enum led_brightness 的变量,一个表示 LED 的初始化亮度,一个表示 LED 的最大亮度,这个枚举 类型定义了 LED 的亮度等级,来看看这个枚举类型:

enum led_brightness {
	LED_OFF		= 0,
	LED_ON		= 1,
	LED_HALF	= 127,
	LED_FULL	= 255,
};


(3)default_trigger:该属性设置LED灯的默认动作,比如:

backlight:LED灯作为背光。

default-on:LED灯打开

heartbeat:LED灯作为心跳指示灯,可以作为系统运行提示灯。

ide-disk:LED灯作为硬盘活动指示灯。

timer:LED灯周期性闪烁,由定时器驱动,闪烁频率可以修改


(4)brightness_set:绑定 LED 亮度设置函数(不可休眠);

(5)brightness_set_blocking:绑定 LED 亮度设置函数(可以休眠);

三、注册/注销LED

3.1、led_classdev_register 函数

该函数将一个 LED 设备注册到 LED 子系统中,使其可以通过内核提供的统一接口进行操作。为 LED 设备初始化一些默认的属性,如亮度(brightness)、最大亮度(max_brightness)、触发器(trigger)等。同时在 /sys/class/leds/ 目录下为注册的 LED 设备创建一个对应的设备文件,用户可以通过该文件对 LED 进行操作。

int led_classdev_register(struct device *parent, struct led_classdev *led_cdev);
//parent:指向父设备的指针。通常为 NULL,表示该 LED 设备没有父设备。如果提供了父设备,则 LED 设备会与父设备关联。
//led_cdev:指向 led_classdev 结构体的指针,该结构体包含了 LED 设备的相关信息,如名称、亮度设置函数、最大亮度等。
//成功时返回 0。失败时返回负的错误码.

3.2、led_classdev_unregister 函数

该函数用于从 LED 子系统中注销一个之前注册的 LED 设备。删除 /sys/class/leds/ 目录下对应的设备文件。释放与该 LED 设备相关的内核资源。

void led_classdev_unregister(struct led_classdev *led_cdev);
//led_cdev:指向之前通过 led_classdev_register 注册的 led_classdev 结构体的指针。
功能

四、/sys接口实现

4.1、编写驱动程序

在上一篇文章中,我们通过注册字符设备,在/dev下创建设备节点,从而实现了用户空间通过编程对硬件进行操作。接下来在这里将通过/sys接口实现用户通过命令行直接操作硬件设备。代码如下(设备树文件参考上篇文章,这里没有做修改):

//vim ldv2.c

#include <linux/module.h>
#include <linux/init.h>
#include <linux/kernel.h>   
#include <linux/fs.h>       
#include <linux/errno.h>    
#include <linux/types.h>   
#include <linux/cdev.h>   
#include <linux/slab.h>     
#include <linux/version.h>  
#include <linux/uaccess.h>  
#include <linux/device.h>
#include <linux/of.h>
#include <linux/platform_device.h>
#include <linux/gpio/consumer.h>
#include <linux/leds.h>

struct leds_desc
{
    struct led_classdev dev;     /* dev for led_classdev_register() */
    struct gpio_desc   *gpio;    /* gpio instance for this led */
    char                name[8]; /* led name in /sys/class/leds */
};

struct led_priv
{
    int                 nleds; /* number of leds */
    struct leds_desc   *leds;  /* leds array */
};

struct led_priv *priv;

static void led_brightness_set(struct led_classdev *dev, enum led_brightness brightness)
{
    struct leds_desc *led = container_of(dev, struct leds_desc, dev);

    gpiod_set_value_cansleep(led->gpio, brightness?1:0 );
}

static int led_probe(struct platform_device *pdev)
{
    struct device *dev = &pdev->dev;
    struct leds_desc *led;
    int ret, i;

    /* allocate memory for private data structure */
    priv = devm_kzalloc(dev, sizeof(*priv), GFP_KERNEL);
    if (!priv)
        return -ENOMEM;

    /* parser the number of LEDs from the device tree */
    priv->nleds = gpiod_count(dev, NULL);
    if ( priv->nleds < 1) {
        dev_err(dev, "Failed to read leds gpio from device tree\n");
        return -EINVAL;
    }
    dev_info(dev, "led driver probe for %d leds from device tree\n", priv->nleds);

    /* allocate memory for all the leds */
    priv->leds = devm_kzalloc(dev, priv->nleds*sizeof(*priv->leds), GFP_KERNEL);
    if( !priv->leds )
        return -ENOMEM;

    /* parser and request GPIO pins from the device tree */
    for (i = 0; i < priv->nleds; i++) {
        priv->leds[i].gpio = devm_gpiod_get_index(dev, NULL, i, GPIOD_ASIS);
        if (IS_ERR(priv->leds[i].gpio))
            return PTR_ERR(priv->leds[i].gpio);

        /* set GPIO as output mode and default off */
        gpiod_direction_output(priv->leds[i].gpio, 0);
    }

    /* create sysfs file for each led */
    for (i = 0; i < priv->nleds; i++) {
        led = priv->leds+i;
        snprintf(led->name, sizeof(led->name), "led%d", i);

        led->dev.name = led->name;
        led->dev.brightness_set = led_brightness_set;
        ret = led_classdev_register(dev, &led->dev);
        if (ret) {
            dev_err(dev, "Failed to register LED[%d]\n", i);
            goto failed_destroy;
        }
    }

    platform_set_drvdata(pdev, priv);
    return 0;

failed_destroy:
    for (--i; i >= 0; i--)
        led_classdev_unregister(&priv->leds[i].dev);

    return ret;
}

static int led_remove(struct platform_device *pdev)
{
    struct led_priv *priv = platform_get_drvdata(pdev);
    int i;

    for (i = 0; i < priv->nleds; i++) {
        led_classdev_unregister(&priv->leds[i].dev);
    }

    dev_info(&pdev->dev, "led driver removed.\n");
    return 0;
}

static const struct of_device_id led_of_match[] = {
    { .compatible = "rgb,leds", },
    { /* sentinel */ },
};
MODULE_DEVICE_TABLE(of, led_of_match);

static struct platform_driver led_driver = {
    .probe = led_probe,
    .remove = led_remove,
    .driver = {
        .name = "leds",
        .of_match_table = led_of_match,
    },
};

module_platform_driver(led_driver);

MODULE_LICENSE("GPL");


Makefile文件如下:

ARCH ?= arm
CROSS_COMPILE ?= /opt/gcc-aarch32-10.3-2021.07/bin/arm-none-linux-gnueabihf-
KERNAL_DIR ?= ~/igkboard-imx6ull/bsp/kernel/linux-imx/

PWD :=$(shell pwd)

obj-m += ledv2.o

modules:
    $(MAKE) ARCH=${ARCH} CROSS_COMPILE=${CROSS_COMPILE} -C $(KERNAL_DIR) M=$(PWD) modules
    @make clear

clear:
    @rm -f *.o *.cmd *.mod *.mod.c
    @rm -rf *~ core .depend .tmp_versions Module.symvers modules.order -f
    @rm -f .*ko.cmd .*.o.cmd .*.o.d
    @rm -f *.unsigned

clean:
    @rm -f *.ko
make

4.2、驱动安装测试

将编译后的ledv2.ko下载到开发板上,并进行安装:

insmod ledv2.ko


在新的驱动中,我们并没有注册字符设备,所以 /dev/ 下并不会产生新的设备文件,而在 /sys/class/leds 路径下出现了我们的三个 Led 设备文件。

ls /dev/led*
  ls: cannot access '/dev/led*': No such file or directory

ls /sys/class/leds/
  led0  led1  led2  mmc0::  mmc1::

ls /sys/class/leds/led1/
  brightness  device  max_brightness  power  subsystem  trigger  uevent


接下来我们使用 echo 命令就可以控制相应 Led 亮灭了。

echo 1 > /sys/class/leds/led1/brightness
//效果:绿灯亮
echo 0 > /sys/class/leds/led1/brightness
//效果:绿灯灭


从上面 Led 驱动程序编写过程中我们了解到,要实现一个设备的驱动供应用程序空间使用,可以有多种不同的实现方式。如果我们想要容易编程控制,则可以使用常规的字符设备驱动通过调用 ioctl() 系统调用实现;而如果想要在命令行或Shell脚本中直接实现,则我们可以使用 /sys/class 伪文件系统来实现。