- 前言
- 思考
- sys文件系统简介
- sys文件系统是什么
- sys文件系统功能描述
- sysfs与object
- sysfs接口使用
- sysfs读写操作例子
- sysfs常用的接口
- sysfs常用的结构体
- 代码实验
- 总结
前言
上篇介绍了Linux驱动中procfs接口的创建，今天介绍sysfs接口的创建，本篇内核采用5.10版本
思考
看本篇内容之前思考两个问题：
-
既然有了proc目录文件系统，为啥还要sys目录文件系统
-
尝试自己写一个内核模块，在/sys下创建名为"test"的目录，在"test"目录下创建个节点data，写进去字符后可以读出写入的数据
sys文件系统简介
sys文件系统是什么
sysfs文件系统是一个类似于proc文件系统的特殊文件系统，将内核中的设备和驱动程序信息以文件的形式呈现给用户空间，专注于设备与驱动的细节
sys文件系统功能描述
sysfs 与 proc 相比有很多优点， sysfs 的设计原则是一个属性文件只做一件事情， sysfs 属性文件一般只有一个值，直接读取或写入。
/sys 下的子目录 
sys文件系统下主要目录及功能描述如下表所示
因此，系统的整体信息可以通过procfs来获取，设备和驱动相关细节信息可以通过sysfs来获取。
sysfs与object
Kobject提供了一个通用的、层次化的对象模型，用于管理内核中的各种对象。每个Kobject都有一个唯一的名称和一个指向其父Kobject的指针，从而组织成一个层次结构。此外，Kobject还可以拥有属性（如设备属性、驱动程序属性等），这些属性可以通过sysfs文件系统向用户空间公开。
Sysfs是通过Kobject来表示设备、驱动程序等内核对象的信息的一种方式。当内核中的设备、驱动程序等对象被创建时，相应的Kobject也会被创建，然后通过Sysfs将其信息暴露给用户空间。
sysfs接口使用
sysfs读写操作例子
读取sysfs文件：可以使用cat命令或者其他文件读取命令来读取sysfs中的文件内容
例如，我们读取gpio1的sysfs的值内容：
# cat /sys/class/gpio/gpio1/value
写入sysfs文件：可以使用echo命令或者其他文件写入命令来写入sysfs中的文件内容。
例如，可以声明GPIO1口：
# echo 1 > /sys/class/gpio/export
注意，有些sysfs文件是只读的，不能进行写操作。
sysfs常用的接口
下面介绍下本实验会用到的一些API函数
动态生成kobject数据结构，然后将其注册到sysfs文件系统中
struct kobject *kobject_create_and_add(const char *name, struct kobject *parent)
参数：
-
name: 创建的文件或目录的名称 -
parent: 指向父目录的kobject数据结构，若parent为NULL，则说明/sys目录就是父目录
给定一个目录kobject，创建一组属性组
int sysfs_create_groups(struct kobject *kobj, const struct attribute_group **groups)
参数：
-
kobj:描述目录下创建一个属性集合，并且显示该属性集合中的文件 -
grp: 描述一组属性类型
要删除对应的sysfs文件，可以用
void sysfs_remove_file ( struct kobject * kobj, const struct attribute * attr);
参数：
-
kobj:描述目录下创建一个属性集合，并且显示该属性集合中的文件 -
attr: 代表具体某组节点属性
需要删除对应的sysfs目录
void kobject_put(struct kobject *kobj);
参数：
-
kobj: 描述目录下创建一个属性集合
sysfs常用的结构体
关键的attribute_group结构体定义：
#include <linux/sysfs.h>
struct attribute_group {
const char *name;
umode_t (*is_visible)(struct kobject *,
struct attribute *, int);
umode_t (*is_bin_visible)(struct kobject *, struct bin_attribute *, int);
struct attribute **attrs;
struct bin_attribute **bin_attrs;
};
设备属性device_attribute结构体定义:
struct device_attribute {
struct attribute attr;//要创建的设备属性
ssize_t (*show)(struct device *dev, struct device_attribute *attr,
char *buf); //读操作回调函数
ssize_t (*store)(struct device *dev, struct device_attribute *attr,
const char *buf, size_t count);//写操作回调函数
};
同时为了方便定义设备的属性，内核提供了一系列相关的宏定义，用于初始化设备的属性
#define DEVICE_ATTR(_name, _mode, _show, _store) \
struct device_attribute dev_attr_##_name = __ATTR(_name, _mode, _show, _store)
#define DEVICE_ATTR_RW(_name) \ //可读写的设备属性
struct device_attribute dev_attr_##_name = __ATTR_RW(_name)
#define DEVICE_ATTR_RO(_name) \ //只读的设备属性
struct device_attribute dev_attr_##_name = __ATTR_RO(_name)
#define DEVICE_ATTR_WO(_name) \ //只写的设备属性
struct device_attribute dev_attr_##_name = __ATTR_WO(_name)
代码实验
#include <linux/syscalls.h>
#include <linux/kobject.h>
#include <linux/string.h>
#include <linux/sysfs.h>
#include <linux/init.h>
#include <linux/uaccess.h>
#include <linux/module.h>
#define KERNEL_ATTR_RO(_name) \
static struct kobj_attribute _name##_attr = __ATTR_RO(_name)
#define KERNEL_ATTR_RW(_name) \
static struct kobj_attribute _name##_attr = \
__ATTR(_name, 0644, _name##_show, _name##_store)
struct kobject *test_kobj;
static char example_sysfs_value[64] = {0};
//读函数处理
static ssize_t data_show(struct kobject *kobj,
struct kobj_attribute *attr, char *buf)
{
return sprintf(buf, "%s\n", example_sysfs_value);
}
//写函数处理
static ssize_t data_store(struct kobject *kobj,
struct kobj_attribute *attr,
const char *buf, size_t count)
{
sscanf(buf, "%s", example_sysfs_value);
return count;
}
//定义data读写的属性
KERNEL_ATTR_RW(data);
static struct attribute * test_attrs[] = {
&data_attr.attr,
NULL,
};
static const struct attribute_group test_attr_group = {
.attrs = test_attrs,
};
static int __init ktest_init(void)
{
int error;
//创建/sys/test
test_kobj = kobject_create_and_add("test", NULL);
if (!test_kobj) {
error = -ENOMEM;
goto exit;
}
/创建/sys/test属性组
error = sysfs_create_group(test_kobj, &test_attr_group);
if (error)
goto kset_exit;
return 0;
kset_exit:
//删除对应的sysfs目录
kobject_put(kernel_kobj);
exit:
return error;
}
core_initcall(ktest_init);
MODULE_LICENSE("GPL");
MODULE_AUTHOR("pan");
Makefile
KERNELDIR ?= /home/forlinx/OK3588_Linux_fs/kernel
obj-m += sys_test.o
all: modules
modules:
$(MAKE) ARCH=arm64 CROSS_COMPILE=aarch64-none-linux-gnu- -C $(KERNELDIR) M=$(shell pwd) modules
modules_install:
$(MAKE) -C $(KERNELDIR) M=$(shell pwd) modules_install
clean:
$(MAKE) -C $(KERNELDIR) M=$(shell pwd) modules clean
测试结果：
# insmod sys_test.ko
# echo hello > /sys/test/data
# cat /sys/test/data
hello
总结
本篇我们学会了常用的sysfs节点信息以及实践操作sysfs节点例子，本篇学会的同学可以一键支持三连下，欢迎关注公众号[Linux随笔录]，持续分享干货！
