一叶知秋，从 LED 子系统看整个 Linux

Posted 2021-09-06 Li-Yongjun

简单点灯

最近项目上需要用到 LED 子系统，在嵌入式 Linux 里面点个灯还是比较简单的，只要在某个灯对应的目录里，向相应文件写入特定值，就可以让 LED 亮/灭/闪烁。

# echo 1 > /sys/class/leds/green/brightness // 点亮 LED
# echo 0 > /sys/class/leds/green/brightness // 熄灭 LED
# echo heartbeat > /sys/class/leds/green/trigger // 让 LED 像心跳一样闪烁

led trigger

当然，项目里用到的点灯功能要比上面介绍的稍微复杂一点，类似于硬盘灯，即对硬盘进行读写操作时，LED 会闪烁。
隐隐约约感觉到，这个功能应该和 trigger 文件有关系，因为在 cat 这个文件时，里面有 mmc0 这个字眼。
那就往 trigger 里面写个 mmc0 看看会有什么效果呢

# echo mmc0 > /sys/class/leds/green/trigger
# cat /sys/class/leds/green/trigger
none rc-feedback kbd-scrolllock kbd-numlock kbd-capslock kbd-kanalock kbd-shiftlock kbd-altgrlock kbd-ctrllock kbd-altlock kbd-shiftllock kbd-shiftrlock kbd-ctrlllock kbd-ctrlrlock [mmc0] heartbeat default-on ir-power-click axp20x-usb-online

向磁盘中写入数据

# touch aa | sync

神奇地发现，每执行一次命令向磁盘中写入数据，板子上绿色的灯就会闪烁一次，神奇。
通过查阅资料，了解到这是 LED 触发器相关的功能。

一时间，想到

• 为什么往 tigger 里写入 mmc0，就能让 LED 变成硬盘灯？
• 为什么往 brightness 文件里写入 1/0，就能控制灯的亮灭？
• 为什么往 trigger 文件里面写入 timer，LED 就会闪烁，同时会产生两个文件 delay_on、delay_off，并能用它们控制灯的闪烁频率？
• 等等
  种种疑惑涌上心头，急切地想了解这些功能背后的原理。

思想斗争

带着这些疑惑，准备去到内核一探究竟。好奇心很强烈，但是脑海后面又传来了阻挠的声音，内核那么大，从哪看啊？能看懂吗？其实这种场景在脑海里不止一次地发生过了，兴趣和困难进行猛烈地撞击，意志力稍强，会有所突破，静下心来研究，可能会有所收获，也可能收获甚微。意志力稍差，打游戏去了。。
很遗憾，我选择了后者，打游戏去了，哈哈！因为不知道从哪下手。先玩一局，放松下心情。

打完游戏晚上躺在床上又继续想 LED 子系统。突然想到，白天的时候误调用了一个名字好像叫做 led_classdev_register(“aaa”) 的接口，结果在 leds 目录下产生了一个 aaa 的目录。那我就从这开始研究呗，好，就这样，明天开搞。

开始探索

问题驱动行动，先列出想要知道的问题

• 各个灯对应的目录是怎么来的？
• trigger 里面的各个触发器是怎么产生的？
• 为什么向 brightness 里面写入 1/0，LED 会亮/灭
• 为什么向 trigger 里面写入 timer，会产生 delay_on、delay_off 这两个文件

开始研究，那就从昨晚想到的 led_classdev_register(“aaa”) 会产生一个 LED 目录开始。

LED 设备注册

先做一个实验，确定下 led_classdev_register() 是否会产生一个 led 灯对应的目录。
随便找了一个可以被运行到的地方，加入了下面这几行代码，期望是在 leds 目录下能够产生 aaa 目录

	struct led_classdev *cdev;
	int ret;


	cdev = kzalloc(sizeof(*cdev), GFP_KERNEL);
	if (!cdev)
		return -ENOMEM;

	cdev->name = "aaa";
	// cdev->brightness_set = ebsa110_led_set;
	// cdev->brightness_get = ebsa110_led_get;
	// cdev->default_trigger = "heartbeat";

	ret = led_classdev_register(NULL, cdev);
	if (ret	< 0) {
		kfree(cdev);
		return ret;
	}

编译、烧录、运行、查看

# ls /sys/class/leds/
aaa    green

果然在 leds 下产生了我希望出现的目录 aaa，信心大增！

后来又追了下底层调用关系：

led_classdev_register()
	of_led_classdev_register() // register a new object(对象) of led_classdev class.
		led_classdev_next_name()
		device_create_with_groups()
		led_add_brightness_hw_changed()
		list_add_tail() // add to the list of leds
		led_update_brightness()
		//led_trigger_set_default()

leds 目录

知道了某个灯是怎么注册产生的，又想知道 leds 目录是怎么产生的，搜索了下代码，也不难找到，下面是产生 leds 目录相关的函数调用关系：

subsys_initcall(leds_init);
leds_init()	// 创建 leds 类，即产生 /sys/class/leds 目录
	class_create()
		__class_create()
			__class_register()
				kset_register()

触类旁通

后来，查资料了解到，/sys/class/leds 是一个类，一个类代表一个内核子系统，像这样的子系统在内核中还有很多，/sys/class/ 里面的每个目录都是一个类，也都是一个子系统

# ls /sys/class/
ata_device    extcon        mdio_bus      ptp           sound
ata_link      gpio          mem           pwm           spi_master
ata_port      graphics      misc          rc            thermal
bdi           hwmon         mmc_host      regulator     tty
block         i2c-adapter   net           rtc           udc
bsg           i2c-dev       phy           scsi_device   vc
dma           input         power_supply  scsi_disk     vtconsole
drm           leds          pps           scsi_host     watchdog

每个类里面又有具体的实例化对象，如 green、aaa

# ls /sys/class/leds/
aaa    green

每个对象里面又有相应的成员方法/属性，如 brightness、trigger

# ls /sys/class/leds/aaa/
brightness      power           trigger
max_brightness  subsystem       uevent

多像 C++ 里面的类啊！其实就是类，简单对比一下

具体 class 里面的注册逻辑，我这里就不展开讲了，因为我也还没研究透，哈哈！这里先不细究这点，等后面有时间了再慢慢吃透。
继续我们的路线探索。
注意，其实这里我的探索路线已经变掉了，已经不局限于探究 LED 子系统了，开始向 LED 子系统外面的 kernel 扩展了。

class 目录的产生

现在来到了 class 目录，因为知道 leds 目录是怎么来的之后，就在想其上面一级 class 目录是怎么来的。追代码，得到

classes_init()
	kset_create_and_add("class", NULL, NULL); // create a struct kset dynamically and add it to sysfs
		kset_create()
			kobject_set_name()
		kset_register()
			kset_init()
			kobject_add_internal()
				kobject_get()
				kobj_kset_join()
					kset_get()
					list_add_tail()
						__list_add()
						{
							next->prev = new;
							new->next = next;
							new->prev = prev;
						}
				create_dir() // 创建目录

start_kernel()

其实追到 classes_init() 后，就不用我费脑筋去想下面再去追啥代码了，继续向上追就行了，干就完了

/* kernel */
start_kernel()
	rest_init() // Do the rest non-__init'ed, we're now alive
		kernel_thread(kernel_init, NULL, CLONE_FS);
		kernel_init()
			kernel_init_freeable()
			/*
			 * Ok, the machine is now initialized. None of the devices
			 * have been touched yet, but the CPU subsystem is up and
			 * running, and memory and process management works.
			 *
			 * Now we can finally start doing some real work..
			 */
			do_basic_setup()
			driver_init() // to initialize their subsystems.
				devtmpfs_init()
				devices_init()
				buses_init()
				classes_init() // 刚刚的 classes_init()
				firmware_init()
				hypervisor_init()
				platform_bus_init()
				cpu_dev_init()
				memory_dev_init()
				container_dev_init()
				of_core_init()

如上，一不小心就追到了 start_kernel()，梦开始的地方啊，第一次发现追内核代码这么有趣。。

Starting kernel …

追到 start_kernel() 后，便不自由地想，Starting kernel ... 这段字串在哪打印的啊，每次开机 uboot 之后都能看到这句，如果能找到，岂不美哉。不幸的是，在内核代码中没搜到。

uboot

一开始我以为 Starting kernel ... 会在 start_kernel() 中打印，但是在内核代码中没搜到。这时候便想到会不会是在 ubbot 中打印的，在开始加载内核前打印这句也是合理的。
就去 uboot 里面搜了下，
果然

boot_jump_linux()
	announce_and_cleanup()
		printf("\\nStarting kernel ...%s\\n\\n", fake ? "(fake run for tracing)" : "");

这里也就是 uboot 即将退出，kernel 即将运行的地方。

附完整调用关系

从 uboot 到 kernel 再到 /sys/class，然后注册 leds 类，再实例化一个 LED 灯。

/* uboot */
boot_jump_linux()
	announce_and_cleanup()
		printf("\\nStarting kernel ...%s\\n\\n"); // printf() 
		bootstage_mark_name(BOOTSTAGE_ID_BOOTM_HANDOFF, "start_kernel");
		cleanup_before_linux()
	kernel_entry(0, machid, r2);


/* kernel */
start_kernel()
	rest_init() // Do the rest non-__init'ed, we're now alive
		kernel_thread(kernel_init, NULL, CLONE_FS);
		kernel_init()
			kernel_init_freeable()
			/*
			 * Ok, the machine is now initialized. None of the devices
			 * have been touched yet, but the CPU subsystem is up and
			 * running, and memory and process management works.
			 *
			 * Now we can finally start doing some real work..
			 */
			do_basic_setup()
			driver_init() // to initialize their subsystems.
				devtmpfs_init()
				devices_init()
				buses_init()
				classes_init()
					kset_create_and_add("class", NULL, NULL); // create a struct kset dynamically and add it to sysfs
						kset_create()
							kobject_set_name()
						kset_register()
							kset_init()
							kobject_add_internal()
								kobject_get()
								kobj_kset_join()
									kset_get()
									list_add_tail()
										__list_add()
										{
											next->prev = new;
											new->next = next;
											new->prev = prev;
										}
								create_dir()
				firmware_init()
				hypervisor_init()
				platform_bus_init()
				cpu_dev_init()
				memory_dev_init()
				container_dev_init()
				of_core_init()


subsys_initcall(leds_init);
leds_init()	// 创建 leds 类，即 /sys/class/leds 目录
	class_create()
		__class_create()
			__class_register()
				kset_register()


led_classdev_register()
	of_led_classdev_register() // register a new object(对象) of led_classdev class.
		led_classdev_next_name()
		device_create_with_groups()
		led_add_brightness_hw_changed()
		list_add_tail() // add to the list of leds
		led_update_brightness()
		//led_trigger_set_default()

人生切入点

以上，从 LED 子系统进行切入，研究 Linux 内核。找到了研究 Linux 内核的切入点。
面对庞大的事物，我们往往会产生恐惧心理，这种恐惧阻止我们进一步研究，也就更加对其不了解，战胜不了它。
两个事例：

1. 一个著名的马拉松运动员在给大家讲自己的成功经验，他说自己总是事先将路程坐车看一遍，记下参照物，然后把距离缩成一节一节的，跑好每一节。
2. 我上高中时物理成绩比较好，因为我做题的方式跟别人不太一样，别人拿到题就死盯着最后的问题，想立马得到答案。而我是先扫一遍题，找其中几个已知条件，根据物理公式，尝试去推导未知的量，就这样一点一点推导，有时定睛一看，答案就在眼前。

小到一道题目，一门学科，一项技能，大到工作、生活，甚至整个人生。我们如果能够找到一个切入点，那么我们是幸运的，我们将以此通往成功，通向美好。

难了不会，会了不难。找到了切入点，我们就是后者。