3、模块注册与发现：模块注册机制、west init与west update流程、模块的自动发现原理
好，咱们进入第三章。这一章我打算聊聊模块注册与发现。说实话，刚接触Zephyr那会儿，我对这套机制也是一头雾水。明明写好了驱动代码，west build就是找不到，气得我差点砸键盘。后来搞明白了，其实就是个「注册」和「发现」的问题。
3.1 模块注册机制
什么叫模块注册？说白了，就是告诉Zephyr构建系统：「嘿，我这儿有个新模块，你把它纳入管理范围。」
Zephyr的模块注册，核心文件就一个——west.yml。你在这个文件里声明了模块，west才能知道它的存在。我见过不少新手直接把代码扔进zephyr目录下，结果一编译全是未定义引用。嗯，这种做法其实绕过了模块注册机制，不推荐。
模块注册的典型结构是这样的：
# west.yml
manifest:
projects:
- name: my_custom_driver
url: https://github.com/myorg/my_custom_driver
revision: main
path: modules/my_custom_driver
self:
path: app
这里有几个关键字段：
- name：模块的名字，唯一标识。我习惯用下划线分隔，比如
my_custom_driver。 - url：仓库地址。可以是GitHub、GitLab，甚至本地路径。
- revision：分支或标签。建议用
main或v1.0.0这种稳定版本。 - path：模块在本地工作区的存放路径。这个路径很重要，决定了构建系统去哪里找你的代码。
重要提醒：模块的path字段必须指向一个包含CMakeLists.txt或Kconfig的目录。否则Zephyr会直接忽略它。我曾经因为少写了一个CMakeLists.txt，排查了整整一个下午。
3.2 west init与west update流程
这两个命令，是Zephyr模块管理的左膀右臂。咱们一个一个说。
3.2.1 west init
west init是初始化命令。它的作用是根据west.yml文件，在工作区创建一个.west目录，并拉取Zephyr核心代码。说白了，就是搭建舞台。
执行流程大致如下：
- 读取
west.yml中的manifest部分。 - 创建
.west/config配置文件，记录manifest路径。 - 根据
self字段，确定当前项目的位置。 - 克隆Zephyr核心仓库（如果指定了
zephyr-base）。
我个人习惯在初始化时指定manifest文件：
west init -m https://github.com/myorg/my-manifest --mr main
这样能确保拉取的是我自定义的manifest，而不是Zephyr官方的默认配置。
3.2.2 west update
west update才是真正干活儿的命令。它会根据west.yml中声明的所有项目，逐一克隆或更新到本地。
流程是这样的：
- 解析
west.yml中的projects列表。 - 检查每个项目是否已经在本地存在。
- 如果不存在，执行
git clone。 - 如果存在，执行
git fetch+git checkout到指定revision。 - 更新子模块（如果有）。
小技巧：如果你只想更新某个特定模块，可以用west update my_custom_driver。这样能节省大量时间，尤其是项目多的时候。我经常在调试驱动时只更新自己的模块，避免把整个Zephyr都拉一遍。
3.3 模块的自动发现原理
好，到了最核心的部分。模块是怎么被自动发现的？
Zephyr的构建系统（CMake）在编译时，会扫描所有注册的模块目录。它找什么呢？找两个东西：
- CMakeLists.txt：模块的构建入口。
- Kconfig：模块的配置选项。
具体流程是这样的：
- CMake读取
west.yml，获取所有模块的path。 - 遍历每个路径，检查是否存在
zephyr/module.yml文件。 - 如果存在，解析
module.yml，获取构建和配置文件的路径。 - 如果不存在，默认查找根目录下的
CMakeLists.txt和Kconfig。 - 将这些路径添加到构建系统的搜索列表中。
这里有个关键文件——module.yml。它长这样：
# module.yml
build:
cmake: .
kconfig: Kconfig
这个文件告诉Zephyr：「我的CMake文件在根目录，Kconfig也在根目录。」你也可以指定子目录：
build:
cmake: drivers/
kconfig: drivers/Kconfig
注意：如果模块目录下没有module.yml，Zephyr会假设模块结构是扁平的。但如果你有复杂的目录结构，强烈建议加上module.yml。我曾经因为没加这个文件，导致驱动死活编译不进去，最后发现是Zephyr没找到正确的CMake入口。
自动发现的本质，其实就是CMake的find_package机制加上Zephyr的扩展。Zephyr在zephyr/cmake/modules/目录下有一个modules.cmake文件，它负责遍历所有注册的模块，并调用add_subdirectory将它们纳入构建。
你想想看，如果没有这套自动发现机制，每次添加一个新模块，都得手动修改CMakeLists.txt。那维护成本得多高？尤其是团队协作时，每个人都要改同一个文件，冲突是家常便饭。
嗯，这里还要提一个坑。模块的自动发现是有顺序的。Zephyr按照west.yml中projects列表的顺序来加载模块。如果你的模块A依赖模块B，那么B必须排在A前面。否则编译时会报「未找到头文件」之类的错误。
我建议你在west.yml中按依赖关系排序：
manifest:
projects:
- name: zephyr
# ...
- name: hal_stm32
# ...
- name: my_driver_base
# ...
- name: my_driver_ext
# ...
这样能避免很多莫名其妙的编译错误。
3.4 总结一下
模块注册与发现，说白了就是三件事：
- 用
west.yml注册模块。 - 用
west init和west update拉取模块。 - 用
module.yml和CMake机制自动发现模块。
这套流程一旦跑通，后续添加新模块就变得非常简单。你只需要在west.yml里加一行声明，然后west update一下，Zephyr就能自动识别并编译你的代码。省心省力。
下一章，咱们聊聊模块的版本管理与依赖控制。到时候我会分享一些我在多模块项目中的实战经验，保证让你少走弯路。