嵌入式 Linux 与 RTOS / 系统课时
用 sysfs 暴露设备属性
用 sysfs 暴露设备属性
sysfs 适合把设备的单值状态和轻量配置暴露给用户空间。本篇用一个可读写阈值属性跑通 show、store、权限与输入校验,并明确哪些接口应留给 ioctl 或 debugfs,避免把临时调试接口做成长期 ABI。
学习目标
- 为
struct device创建可读写 sysfs 属性,并正确实现show与store - 为写入值设置权限、格式与范围边界,返回合适的内核错误码
- 根据接口稳定性和数据形态区分 sysfs、ioctl 与 debugfs
什么属性适合放进 sysfs
sysfs 的核心约束是一个文件表达一个清晰属性。温度阈值、工作模式、固件版本、累计计数这类单值信息很合适;连续数据流、大块二进制数据和复杂事务则不合适。用户空间看到的是文本文件,驱动负责在文本与内部数据之间转换。
| 接口 | 更适合的内容 | 稳定性预期 |
|---|---|---|
| sysfs | 单值配置、状态、能力信息 | 面向用户空间时应保持稳定 |
| ioctl | 结构化命令、原子操作、复杂参数 | 属于正式 ABI,需要版本与兼容设计 |
| debugfs | 调试统计、寄存器快照、实验开关 | 不保证稳定,不应被产品程序依赖 |
show 与 store 的调用路径
读取属性时,sysfs 调用驱动的 show,驱动把当前状态格式化到缓冲区;写入时则进入 store,驱动解析文本、校验边界并更新状态。store 成功时应返回本次写入的 count,解析失败或越界则返回负错误码。

show 推荐使用 sysfs_emit(),它会按 sysfs 页大小安全格式化输出。store 不应直接调用 sscanf() 接受模糊格式;解析整数时使用 kstrtoint()、kstrtou32() 等内核转换函数,并在修改硬件或状态前完成完整校验。
实现一个可读写阈值
下面用根设备创建 /sys/devices/anystack_demo/threshold。属性由 DEVICE_ATTR_RW 声明,因此默认权限为 0644:所有用户可读,只有具备相应文件系统权限的进程可写。示例使用互斥锁保护状态,允许的阈值范围是 0~100。
将以下代码保存为 sysfs_demo.c:
#include <linux/device.h>
#include <linux/kernel.h>
#include <linux/module.h>
#include <linux/mutex.h>
static struct device *demo_dev;
static DEFINE_MUTEX(threshold_lock);
static int threshold = 50;
static ssize_t threshold_show(struct device *dev,
struct device_attribute *attr,
char *buf)
{
int value;
/* 读取与写入使用同一把锁,避免并发访问得到不一致状态。 */
mutex_lock(&threshold_lock);
value = threshold;
mutex_unlock(&threshold_lock);
return sysfs_emit(buf, "%d\n", value);
}
static ssize_t threshold_store(struct device *dev,
struct device_attribute *attr,
const char *buf,
size_t count)
{
int value;
int ret;
/* 先完成格式与范围校验,再修改驱动状态。 */
ret = kstrtoint(buf, 0, &value);
if (ret)
return ret;
if (value < 0 || value > 100)
return -ERANGE;
mutex_lock(&threshold_lock);
threshold = value;
mutex_unlock(&threshold_lock);
return count;
}
static DEVICE_ATTR_RW(threshold);
static int __init sysfs_demo_init(void)
{
int ret;
demo_dev = root_device_register("anystack_demo");
if (IS_ERR(demo_dev))
return PTR_ERR(demo_dev);
ret = device_create_file(demo_dev, &dev_attr_threshold);
if (ret) {
root_device_unregister(demo_dev);
return ret;
}
return 0;
}
static void __exit sysfs_demo_exit(void)
{
device_remove_file(demo_dev, &dev_attr_threshold);
root_device_unregister(demo_dev);
}
module_init(sysfs_demo_init);
module_exit(sysfs_demo_exit);
MODULE_LICENSE("GPL");
MODULE_DESCRIPTION("Minimal sysfs device attribute example");同目录创建 Makefile:
obj-m += sysfs_demo.o在已经安装当前内核构建头文件的 Linux 主机上执行:
make -C /lib/modules/$(uname -r)/build M=$PWD modules
sudo insmod sysfs_demo.ko
cat /sys/devices/anystack_demo/threshold
echo 80 | sudo tee /sys/devices/anystack_demo/threshold
cat /sys/devices/anystack_demo/threshold预期输出:
50
80
80tee 自身会回显写入的 80,随后一次 cat 再读出更新后的值。卸载模块可执行 sudo rmmod sysfs_demo,对应属性文件会随设备注销一起消失。
把权限和语义当成 ABI
如果属性只是观测值,应使用只读属性而不是在 store 中悄悄忽略写入;如果属性触发不可逆操作,也不应伪装成普通数值配置。show 与 store 还应避免长时间阻塞,因为一次普通文件读写不应意外变成耗时控制流程。
属性名称、单位和含义一旦交给用户空间使用,就应视作接口契约。例如 timeout_ms 不要在后续版本突然改成秒,也不要让 0 从“禁用”变成“立即超时”。需要调整语义时,优先新增属性并保留兼容路径,而不是悄悄改变旧属性。
sysfs 最适合的是稳定、文本化、单属性接口;当需求已经变成结构化命令、原子事务或调试内部状态时,应及时切换到 ioctl、专用字符设备或 debugfs,而不是继续扩张 sysfs 文件的职责。