Linux驱动开发笔记(十三)Sysfs文件系统

2024-06-22 16:52

本文主要是介绍Linux驱动开发笔记(十三)Sysfs文件系统,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

文章目录

  • 前言
  • 一、Sysfs
    • 1.1 Sysfs的引入
    • 1.2 Sysfs的目录结构
    • 1.2 Sysfs的目录详解
      • 1.2.1 devices
      • 1.2.2 bus
      • 1.2.3 class
      • 1.2.4 devices、bus、class目录之间的关系
      • 1.2.5 其他子目录
  • 二、Sysfs使用
    • 2.1 核心数据结构
    • 2.2 相关函数
      • 2.2.1 kobject_create_and_add
      • 2.2.2 kobject_put()
      • 2.2.3 kobject_get()
      • 2.2.4 sysfs_create_file
    • 2.3 设计思路


前言

  前面章节驱动学习中,我们测试驱动时经常使用/sys目录下文件,我们本章就简单介绍下Sysfs文件系统。

一、Sysfs

1.1 Sysfs的引入

  Sysfs是Linux内核的一种虚拟文件系统,用于导出内核对象的属性和状态,使用户空间能够方便地访问和管理这些信息。Sysfs在Linux内核2.6版本中引入,旨在替代和扩展早期的proc文件系统。它提供了一种统一的接口,用于查看和操作设备、驱动程序、文件系统等内核对象。Sysfs采用层次化的目录结构,反映了内核对象之间的关系,目录和文件分别表示内核对象及其属性。
  内核对象(如设备、驱动程序等)在sysfs中被表示为目录,目录下的文件表示对象的属性。这些文件通常是只读的,但有些也可以通过写操作进行配置。
  通过sysfs,用户可以统一地访问不同类型的内核信息,而不需要关心底层实现细节。Sysfs内容会随着系统硬件配置的变化动态更新。例如,插拔设备会导致相应的sysfs目录和文件创建或删除。

1.2 Sysfs的目录结构

  Sysfs文件系统是一种虚拟文件系统,也就是文件系统中文件不对应硬盘上任何文件,存在于内存中,其通常挂载在/sys目录下,主要目录包括:

/sys/devices:表示系统中的物理设备,每个子目录对应一个设备。
/sys/class:表示系统中的设备类别(如网络设备、块设备等),子目录按类别分类。
/sys/block:表示块设备(如硬盘、USB存储设备等)。
/sys/bus:表示系统总线类型(如PCI、USB等),每个子目录对应一个总线。
/sys/kernel:表示内核参数和信息,如调度器参数、内核模块等。
/sys/module:表示加载的内核模块,每个子目录对应一个模块,包含模块参数和状态信息。

  Sysfs是通过内核中的对象模型(kobject)实现的。每个kobject都可以在sysfs中创建一个对应的目录,kobject的属性(kobj_attribute)则映射为sysfs中的文件。通过定义和注册kobject和kobj_attribute,内核模块可以在sysfs中创建自己的条目。这些目录是在子系统注册kobject核心的系统启动时刻产生的, 当它们被初始化以后, 它们开始搜寻在各自的目录内注册了的对象。 一个kobject对应一个目录,包含的对象属性对应一个文件,文件只支持 目录、 普通文件 (文本或二进制文件)和 符号链接文件三种类型。

1.2 Sysfs的目录详解

1.2.1 devices

  devices目录反映系统中所有物理设备及其层次结构,设备按照硬件拓扑结构组织,表示设备的物理连接关系。/sys/devices是内核对系统中所有设备的分层次表达模型, 也是/sys文件系统管理设备的最重要的目录结构。其目录结构如下:

  • 系统设备:如 CPU、系统内存等。
  • 总线设备:例如 PCI、USB、SCSI 等设备。
  • 虚拟设备:如虚拟网络设备。

1.2.2 bus

  bus目录包含系统中所有已注册总线类型的子目录,每个子目录表示一种总线类型,例如 PCI、USB、I2C 等。这里是设备按照总线类型分层放置的目录结构, 每个子目录(总线类型)下包含两个子目录——devices和drivers文件夹;其中devices下是该总线类型下的所有设备, 而这些设备都是符号链接,它们分别指向真正的设备(/sys/devices/下);如下图bus下的usb总线中的device则是Devices目 录下/pci()/dev 0:10/usb2的符号链接。而drivers下是所有注册在这个总线上的驱动,每个driver子目录下 是一些可以观察和修改的driver参数。其目录结构如下:

  • devices:列出所有连接到该总线的设备。
  • drivers:列出与该总线相关的所有驱动程序。
  • drivers_autoprobe 和 drivers_probe:用于自动或手动驱动程序绑定。
  • uevent:用于触发 uevent 事件。

1.2.3 class

  class 目录按设备类型对设备进行分类,每个子目录表示一种设备类型,例如网络设备、块设备、字符设备等。其目录结构如下:

  • net:表示所有网络接口。
  • block:表示所有块设备。
  • tty:表示所有终端设备。

注:大家可能注意到在/sys/class目录下也存在一个block子目录,这是由于历史遗留因素而导致的。 块设备现在是已经移到/sys/class/block, 旧的接口/sys/block为了向后兼容保留存在,现在该目录下的都是链接文件

1.2.4 devices、bus、class目录之间的关系

在这里插入图片描述

  • /sys/devices 目录表示设备的物理连接和层次结构,而 /sys/class 目录按设备功能或类型对设备进行逻辑分类。
  • /sys/bus 目录表示系统中的各种总线类型,每种总线都有一个子目录,包含该总线上的设备(链接到 /sys/devices)和驱动程序信息。
  • /sys/devices 中的设备可能会在 /sys/bus/<bus_type>/devices 下有一个符号链接,反映设备与总线的关系。/sys/class 提供了按设备类型的视图,使用户能够方便地找到特定类型的设备,而无需了解设备的具体物理连接位置。

  以上图的USB 存储设备插入系统为例,以下是目录之间关系的具体示例:

//表示 USB 存储设备的物理连接路径
ls /sys/devices/pci0000:00/0000:00:14.0/usb1/1-1//目录中包含指向上述设备的符号链接,表示它是一个 USB 设备
ls /sys/bus/usb/devices//目录中包含该设备的逻辑分类信息,表示它是一个块设备
ls /sys/class/block/sda

1.2.5 其他子目录

  在Sysfs文件系统中最重要的就是以上三个子目录,其他子目录我们简单了解即可。
firmware目录
  该目录包含具有固件对象和属性的子目录,关于内核的固件加载和firmware驱动,有兴趣可以自己去了解下。其目录结构如下:

  • devicetree:描述加载设备树信息,根节点对应base目录,每一个设备树节点对应一个目录,每个属性对应一个文件
  • fdt:原始dtb文件,是uboot传给内核的设备树文件,可以使用hexdump -C查看

fs目录
  这里按照设计是用于描述系统中所有文件系统,包括文件系统本身和按文件系统分类存放的已挂载点,描述已注册的文件系统视图, 但目前只有 fuse,ext4 等少数文件系统支持 sysfs 接口,一些传统的虚拟文件系统(VFS)层次控制参数仍然在sysctl(/proc/sys/fs) 接口中。
kernel目录
  该目录是内核所有可调整参数的位置,有些内核可调整参数仍然位于sysctl(/proc/sys/kernel)接口中。
module目录
  该目录有系统中所有模块的信息,不论这些模块是以内联(inlined)方式编译到内核映像文件(vmlinuz)中还是编译为外部模块(.ko文件), 都可能会出现在/sys/module目录下。
  编译为外部模块(.ko文件)在加载后,会/sys/module/出现对应的模块文件夹,在这个文件夹下会出现一些属性文件和属性目录, 表示此外部模块的一些信息,如版本号、加载状态、所提供的驱动程序等。
  编译进内核的模块则只在当它有非0属性的模块参数时会出现对应的/sys/module/, 这些模块的可用参数会出现在/sys/modules/parameters/中, 如:/sys/module/printk/parameters/time 这个可读写参数控制着内联模块printk在打印内核消息时是否加上时间前缀。
power目录
  该目录下是系统中电源选项,包含电源管理子系统提供的统一接口文件。 一些属性文件可以用于控制整个机器的电源状态,如可以向其中写入控制命令进行关机、重启等操作。

二、Sysfs使用

2.1 核心数据结构

  kobject是 Linux内核中的一个核心数据结构,用于表示内核中的对象并支持内核对象的引用计数、生命周期管理和对象间关系管理。它主要用于内核的设备模型(device model)以及 sysfs 文件系统的实现。kobject 提供了一个通用的机制来管理对象,这样不同的子系统可以共享一些通用的代码来处理对象。

struct kobject {const char        *name;struct list_head  entry;struct kobject    *parent;struct kset       *kset;struct kobj_type  *ktype;struct kernfs_node *sd;struct kref       kref;unsigned int      state_initialized:1;unsigned int      state_in_sysfs:1;unsigned int      state_add_uevent_sent:1;unsigned int      state_remove_uevent_sent:1;unsigned int      uevent_suppress:1;
};
  • 关键成员解释
    • name:kobject 的名字,用于在 sysfs 文件系统中表示对象的名字。
    • parent:指向父对象的指针,用于形成层次结构,表示对象之间的包含关系。
    • kref:内核引用计数机制的对象,用于确保 kobject 在引用计数为零之前不会被释放。
    • ktype:指向 kobj_type 结构体的指针,kobj_type 定义了 kobject 的特定操作,如释放函数、sysfs 文件操作等。
    • kset:指向 kset 结构体的指针,一个 kset 是一组相关 kobject 的集合,可以用来组织和管理一组相关的对象。
    • sd:指向 kernfs_node 结构体的指针,表示 sysfs 中的目录项。
    • state_initialized 等标志位:用于跟踪对象的状态,如是否已初始化、是否已添加到 sysfs 中等。

  kobj_attribute是一个用于为kobject(内核对象)创建属性的结构体。这些属性可以通过sysfs文件系统进行读取或写入,sysfs提供了一种机制,让内核子系统、设备驱动程序和其他内核模块可以向用户空间导出信息。kobj_attribute结构体定义在linux/kobject.h中,包含以成员:

  • struct attribute attr: 一个通用的属性结构体,包含属性的名称和权限模式。
  • ssize_t (*show)(struct kobject *kobj, struct kobj_attribute *attr, char *buf): 指向显示方法的函数指针,当读取属性时调用该方法。
  • ssize_t (*store)(struct kobject *kobj, struct kobj_attribute *attr, const char *buf, size_t count): 指向存储方法的函数指针,当写入属性时调用该方法。

  __ATTR宏用于方便地定义struct attribute类型的结构体成员。它通常与kobj_attribute结构体一起使用,来定义sysfs属性。

#define __ATTR(_name, _mode, _show, _store) { \.attr = { .name = __stringify(_name), .mode = _mode }, \.show   = _show, \.store  = _store, \
}
  • 参数说明
    • _name:属性的名称。
    • _mode:属性的权限模式,如0644,表示所有者可读写,组和其他用户可读。
    • _show:指向显示函数的指针,该函数在读取属性时被调用。
    • _store:指向存储函数的指针,该函数在写入属性时被调用。

2.2 相关函数

  更多的函数可以参考内核源码include/linux/sysfs.h文件。

2.2.1 kobject_create_and_add

//函数用于创建、初始化并将kobject添加到系统中
struct kobject *kobject_create_and_add ( const char *name, struct kobject *parent);
  • 参数
    • name:创建kobj的名字
    • parent:指定父kobject,实际就是在那个目录下创建一个目录。比如为kernel_kobj,将在/sys/kernel目录下创建目录,如果为NULL,将在/sys下创建。
  • 返回值
    • 成功:指向新创建并添加的 kobject 结构体的指针
    • 失败:NULL

2.2.2 kobject_put()

//用于减少kobject的引用计数,当引用计数降为零时会释放该对象。
void kobject_put(struct kobject *kobj);
  • 参数:
    • kobj:指向要减少引用计数的 kobject 结构体。

2.2.3 kobject_get()

//用于增加kobject的引用计数
struct kobject *kobject_get(struct kobject *kobj);
  • 参数:
    • kobj:指向要增加引用计数的 kobject 结构体。
  • 返回值:
    • 成功:返回 kobj,或者如果 kobj 为 NULL 则返回 NULL。

2.2.4 sysfs_create_file

//创建一个文件
int sysfs_create_file ( struct kobject *  kobj, const struct attribute * attr);
  • 参数:
    • kobj:我们创建的kobject
    • attr:属性描述
  • 返回值:
    • 成功:0
    • 错误:错误码

2.3 设计思路

  在内核中,创建和使用 kobject 通常需要以下步骤:

  • 初始化并添加到 sysfs:使用 kobject_create_and_add函数创建kobject并添加到sysfs文件系统中。
  • 增加引用计数:使用 kobject_get() 增加引用计数。
  • 减少引用计数并释放:使用 kobject_put() 减少引用计数,当引用计数降到零时,kobject 会被释放。
//示例
#include <linux/kobject.h>
#include <linux/sysfs.h>
#include <linux/module.h>
#include <linux/init.h>static struct kobj_attribute foo_attribute = __ATTR(foo, 0664, foo_show, foo_store);
static struct kobject *example_kobj;static ssize_t foo_show(struct kobject *kobj, struct kobj_attribute *attr, char *buf) {return sprintf(buf, "%d\n", 123);  // 显示的示例值
}static ssize_t foo_store(struct kobject *kobj, struct kobj_attribute *attr, const char *buf, size_t count) {// 处理存储的示例逻辑int val;sscanf(buf, "%d", &val);printk(KERN_INFO "新值: %d\n", val);return count;
}static int __init example_init(void) {int error;example_kobj = kobject_create_and_add("example_kobject", kernel_kobj);if (!example_kobj)return -ENOMEM;error = sysfs_create_file(example_kobj, &foo_attribute.attr);if (error) {kobject_put(example_kobj);}return error;
}static void __exit example_exit(void) {kobject_put(example_kobj);
}module_init(example_init);
module_exit(example_exit);
MODULE_LICENSE("GPL");

免责声明:本内容部分参考野火科技及其他相关公开资料,若有侵权或者勘误请联系作者。

这篇关于Linux驱动开发笔记(十三)Sysfs文件系统的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/1084866

相关文章

Linux中shell解析脚本的通配符、元字符、转义符说明

《Linux中shell解析脚本的通配符、元字符、转义符说明》:本文主要介绍shell通配符、元字符、转义符以及shell解析脚本的过程,通配符用于路径扩展,元字符用于多命令分割,转义符用于将特殊... 目录一、linux shell通配符(wildcard)二、shell元字符(特殊字符 Meta)三、s

Linux之软件包管理器yum详解

《Linux之软件包管理器yum详解》文章介绍了现代类Unix操作系统中软件包管理和包存储库的工作原理,以及如何使用包管理器如yum来安装、更新和卸载软件,文章还介绍了如何配置yum源,更新系统软件包... 目录软件包yumyum语法yum常用命令yum源配置文件介绍更新yum源查看已经安装软件的方法总结软

linux报错INFO:task xxxxxx:634 blocked for more than 120 seconds.三种解决方式

《linux报错INFO:taskxxxxxx:634blockedformorethan120seconds.三种解决方式》文章描述了一个Linux最小系统运行时出现的“hung_ta... 目录1.问题描述2.解决办法2.1 缩小文件系统缓存大小2.2 修改系统IO调度策略2.3 取消120秒时间限制3

Linux alias的三种使用场景方式

《Linuxalias的三种使用场景方式》文章介绍了Linux中`alias`命令的三种使用场景:临时别名、用户级别别名和系统级别别名,临时别名仅在当前终端有效,用户级别别名在当前用户下所有终端有效... 目录linux alias三种使用场景一次性适用于当前用户全局生效,所有用户都可调用删除总结Linux

Linux:alias如何设置永久生效

《Linux:alias如何设置永久生效》在Linux中设置别名永久生效的步骤包括:在/root/.bashrc文件中配置别名,保存并退出,然后使用source命令(或点命令)使配置立即生效,这样,别... 目录linux:alias设置永久生效步骤保存退出后功能总结Linux:alias设置永久生效步骤

Linux使用fdisk进行磁盘的相关操作

《Linux使用fdisk进行磁盘的相关操作》fdisk命令是Linux中用于管理磁盘分区的强大文本实用程序,这篇文章主要为大家详细介绍了如何使用fdisk进行磁盘的相关操作,需要的可以了解下... 目录简介基本语法示例用法列出所有分区查看指定磁盘的区分管理指定的磁盘进入交互式模式创建一个新的分区删除一个存

Linux使用dd命令来复制和转换数据的操作方法

《Linux使用dd命令来复制和转换数据的操作方法》Linux中的dd命令是一个功能强大的数据复制和转换实用程序,它以较低级别运行,通常用于创建可启动的USB驱动器、克隆磁盘和生成随机数据等任务,本文... 目录简介功能和能力语法常用选项示例用法基础用法创建可启动www.chinasem.cn的 USB 驱动

基于Python开发电脑定时关机工具

《基于Python开发电脑定时关机工具》这篇文章主要为大家详细介绍了如何基于Python开发一个电脑定时关机工具,文中的示例代码讲解详细,感兴趣的小伙伴可以跟随小编一起学习一下... 目录1. 简介2. 运行效果3. 相关源码1. 简介这个程序就像一个“忠实的管家”,帮你按时关掉电脑,而且全程不需要你多做

高效管理你的Linux系统: Debian操作系统常用命令指南

《高效管理你的Linux系统:Debian操作系统常用命令指南》在Debian操作系统中,了解和掌握常用命令对于提高工作效率和系统管理至关重要,本文将详细介绍Debian的常用命令,帮助读者更好地使... Debian是一个流行的linux发行版,它以其稳定性、强大的软件包管理和丰富的社区资源而闻名。在使用

Java中的Opencv简介与开发环境部署方法

《Java中的Opencv简介与开发环境部署方法》OpenCV是一个开源的计算机视觉和图像处理库,提供了丰富的图像处理算法和工具,它支持多种图像处理和计算机视觉算法,可以用于物体识别与跟踪、图像分割与... 目录1.Opencv简介Opencv的应用2.Java使用OpenCV进行图像操作opencv安装j