u-boot 学习笔记：uclass 与 UCLASS

u-boot 学习笔记：uclass 与 UCLASS_DRIVER 的理解

前言

u-boot 是嵌入式开发中经常使用的一种 bootloader，兼顾 boot （启动）与 loader（引导）等基础功能，应用于 ARM 等多个平台，通用性比较好，在嵌入式 Linux 开发中，用于引导启动 Linux 内核，也可以用于引导启动其他的操作系统
u-boot 地址 https://github.com/u-boot/u-boot.git
当前代码版本：v2024.04-rc5
本篇记录： UCLASS_DRIVER 宏定义的含义、uclass 的定义

uclass

u-boot 的设备与驱动管理模型中，驱动使用 uclass 进行分类
struct uclass 的定义 include\dm\uclass.h

struct uclass {void *priv_;struct uclass_driver *uc_drv;struct list_head dev_head;struct list_head sibling_node;
};

这里 uclass 有两个链表节点： dev_head，用于链接这个类中的多个设备，可以简单理解为如果设备驱动属于同一个类，就链接在这里，dev_head 属于链表的【头部】header
【备注】使用链表管理，是一种比较常见的通用的管理多个节点的方法
这里 sibling_node 用于挂载到类管理的链表上，之所以使用链表，就是为了管理方便，所有的类，最终都挂载到一个全局的链表头部： gd->uclass_root。
在 u-boot 中，有一个结构比较复杂的全局变量 gd。 gd 中的 uclass_root，用于挂载所有的 uclass 节点。

`struct uclass_driver`

struct uclass_driver 结构体看起来成员比较的多，其实仔细看看，就几个关键的成员
name 用于标识一个 uclass_driver
enum uclass_id id 属于 uclass 分类的 id，在 include\dm\uclass-id.h 定义，比如 UCLASS_I2C, /* I2C bus */
init 用于 uclass 初始化

struct uclass_driver {const char *name;enum uclass_id id;int (*post_bind)(struct udevice *dev);int (*pre_unbind)(struct udevice *dev);int (*pre_probe)(struct udevice *dev);int (*post_probe)(struct udevice *dev);int (*pre_remove)(struct udevice *dev);int (*child_post_bind)(struct udevice *dev);int (*child_pre_probe)(struct udevice *dev);int (*child_post_probe)(struct udevice *dev);int (*init)(struct uclass *class);int (*destroy)(struct uclass *class);int priv_auto;int per_device_auto;int per_device_plat_auto;int per_child_auto;int per_child_plat_auto;uint32_t flags;
};

uclass 的定义

大概了解 struct uclass 与 struct uclass_driver 后，就需要了解 uclass 的使用方法，比如定义
这里 u-boot 推荐使用 UCLASS_DRIVER 进行定义

/* Declare a new uclass_driver */
#define UCLASS_DRIVER(__name)						\ll_entry_declare(struct uclass_driver, __name, uclass_driver)

比如 drivers\i2c\i2c-uclass.c 中的 i2c 的类定义：

UCLASS_DRIVER(i2c) = {.id		= UCLASS_I2C,.name		= "i2c",.flags		= DM_UC_FLAG_SEQ_ALIAS,.post_bind	= i2c_post_bind,.pre_probe      = i2c_pre_probe,.post_probe	= i2c_post_probe,.per_device_auto	= sizeof(struct dm_i2c_bus),.per_child_plat_auto	= sizeof(struct dm_i2c_chip),.child_post_bind = i2c_child_post_bind,
};

看来 UCLASS_DRIVER 这个宏有定义的功能，并且可以在定义后直接初始化，类似于全局的变量。
这里展开了解一下 UCLASS_DRIVER 宏定义具体怎么工作的。

/* Declare a new uclass_driver */
#define UCLASS_DRIVER(__name)						\ll_entry_declare(struct uclass_driver, __name, uclass_driver)#define ll_entry_declare(_type, _name, _list)				\_type _u_boot_list_2_##_list##_2_##_name __aligned(4)		\__attribute__((unused))				\__section("__u_boot_list_2_"#_list"_2_"#_name)

通过对 ll_entry_declare 的展开了解，大概是定义了一个基于 _type 类型的变量，然后指定放在了 section 段中。
比如 UCLASS_DRIVER(i2c) 展开后是

struct uclass_driver _u_boot_list_2_uclass_driver_2_i2c __aligned(4) __attribute__((unused)) __section("__u_boot_list_2_""uclass_driver""_2_""i2c")

类型 struct uclass_driver，类似于【静态】定义一个 struct uclass_driver 类型的全局变量，放在了
__u_boot_list_2_uclass_driver_2_i2c 段中
指定段有个好处就是可以通过段名，对段中的定义的数据进行遍历操作，类似于结构体数组。指定 section 的作用是为了集中管理，否则普通的全局变量，无法集中操作，指定 section，编译工具链可以把这些有规律命名的全局变量集中（排序）存放。
C 语言中，支持定义初始化，因此定义后，就紧接着可以初始化，这样就不需要单独的初始化函数了，这里的初始化，只是数据结构的成员数据填充。
看来这个 ll_entry_declare 不仅可以用于定义 struct uclass_driver，还可以用于定义其他的存放到 section 中的全局变量，为的就是方便集中遍历管理，比如一起初始化、遍历查询，这种全局变量，一般没有【删除】的操作

uclass 的操作

UCLASS_DRIVER 定义后，使用 uclass_get 可以获取或者添加一个新的 class 到 uclass 的全局链表头：(((gd_t *)gd)->uclass_root)

uclass_get-> uclass_find-> uclass_add  （如果没有 find 到）

uclass_find

这个函数，其实就是遍历全局 gd->uclass_root 链表，确认是否存在指定类 id 的 uclass，这里使用 list_for_each_entry，跟 Linux 中的list 管理接口基本一致，链表的遍历。

struct uclass *uclass_find(enum uclass_id key)
{struct uclass *uc;if (!gd->dm_root)return NULL;/** TODO(sjg@chromium.org): Optimise this, perhaps moving the found* node to the start of the list, or creating a linear array mapping* id to node.*/list_for_each_entry(uc, gd->uclass_root, sibling_node) {if (uc->uc_drv->id == key)return uc;}return NULL;
}

uclass_add

这里简单的理解就是：添加到 gd->uclass_root

static int uclass_add(enum uclass_id id, struct uclass **ucp)
{struct uclass_driver *uc_drv;struct uclass *uc;int ret;*ucp = NULL;uc_drv = lists_uclass_lookup(id);  /* 查询是否已经存在？ */if (!uc_drv) {debug("Cannot find uclass for id %d: please add the UCLASS_DRIVER() declaration for this UCLASS_... id\n",id);/** Use a strange error to make this case easier to find. When* a uclass is not available it can prevent driver model from* starting up and this failure is otherwise hard to debug.*/return -EPFNOSUPPORT;}uc = calloc(1, sizeof(*uc));  /* 申请 struct uclass 内存 */if (!uc)return -ENOMEM;if (uc_drv->priv_auto) {void *ptr;ptr = calloc(1, uc_drv->priv_auto); /* 申请 private 私有内存 */if (!ptr) {ret = -ENOMEM;goto fail_mem;}uclass_set_priv(uc, ptr);}uc->uc_drv = uc_drv;INIT_LIST_HEAD(&uc->sibling_node);  /* 链表头部：必须初始化 */INIT_LIST_HEAD(&uc->dev_head); list_add(&uc->sibling_node, DM_UCLASS_ROOT_NON_CONST);  /* 添加到 `gd->uclass_root`，这里的宏定义  `#define DM_UCLASS_ROOT_NON_CONST	(((gd_t *)gd)->uclass_root)` */if (uc_drv->init) {ret = uc_drv->init(uc); /* uclass 初始化，调用 uclass 中 uclass_driver 的 init 成员 */if (ret)goto fail;}*ucp = uc;return 0;
fail:if (uc_drv->priv_auto) {free(uclass_get_priv(uc));uclass_set_priv(uc, NULL);}list_del(&uc->sibling_node);
fail_mem:free(uc);return ret;
}

知识点回顾

首先 u-boot 有个全局的变量： gd，用于管理保存 u-boot 全局数据，其中包括 gd->uclass_root，这个是 uclass 的链表头，用于挂载所有的 uclass 类结构
uclass 定义使用了 u-boot linker lists 定义方式，也就是通过 section 进行集中管理，这样归类排序存放（编译工具链支持）后，可以集中的初始化、遍历与搜索。
linker lists 的理解其实并不难，编译工具链支持的通过指定 section 名的方式存放定义的全局变量，并于会按照 ASCII 码进行排序，类似于定义了一个相同结构的数组，这个在编程中使用会方便很多。并且这个定义可以放在不同的代码文件中。这中指定 section 的定义方式编译链接阶段后完成了，因此代码执行阶段就可以方便的统一操作。
【备注】 section 的操作前先获取 section 区域的起始（地址）。