编译时注册表模式示例

功能说明

演示基于自定义链接器段实现”编译时注册、运行时遍历”的模块注册表模式。各模块在自己的源文件中使用宏注册，无需修改 main.c。该模式与 SDK 中 LISA_DEVICE_REGISTER / SYS_INIT 的实现原理相同。

硬件连接

无需外部连接，本示例仅演示链接脚本特性；运行结果通过开发板板载烧录/日志接口输出。

示例内容

定义 .app_registry 只读段（.ld 片段 + CMake 注册）
定义 APP_MODULE_REGISTER() 宏将注册条目放入该段
LED 和 Sensor 模块各自在独立的 .c 文件中注册
main() 通过链接器符号遍历所有注册模块并调用初始化函数

编译

重要提示：编译前需要先确认当前示例支持的目标板型，然后将板型标识传给 -DBOARD。请按以下方式选择：

确认示例限制：查看当前示例 README 中的硬件连接和注意事项，确认是否限定板型。
参考示例配置：查看相关示例目录下的 sample.yaml，确认支持的板型。
填写板型标识：SDK 内置板型的标识为 boards/ 下的目录名。例如实际使用的板型目录为 boards/<板型名称>/，则编译参数填写为 -DBOARD=<板型名称>。

在 SDK 根目录执行编译，并将命令中的 <示例路径> 和 <板型名称> 替换为实际值。

Linux 使用 build.sh：

# 通用命令
./build.sh -C -S samples/<示例路径> -DBOARD=<板型名称>

# 示例：使用 arcs_evb 开发板
./build.sh -C -S samples/<示例路径> -DBOARD=arcs_evb

Windows PowerShell 使用 build.ps1：

# 通用命令
.\build.ps1 -C -S samples/<示例路径> -DBOARD=<板型名称>

# 示例：使用 arcs_evb 开发板
.\build.ps1 -C -S samples/<示例路径> -DBOARD=arcs_evb

Note

确保已安装对应平台的工具链和 ListenAI 开发工具包。Windows 环境请先执行 .\env.ps1 或直接使用 .\build.ps1 自动加载环境。

注意事项：-DBOARD 填写的是板型标识，不是芯片系列名称。如果示例有板型专用配置或额外编译参数，以示例 README 中的说明为准。

烧录

编译完成后，使用 SDK tools/burn 目录下的 cskburn 工具烧录固件。请先根据目标板型和当前示例确定芯片系列、串口设备、烧录地址和固件路径。

Linux：

# 通用命令
./tools/burn/cskburn -C <芯片系列> -s <串口设备> -b 3000000 <烧录地址> <固件路径>

# 示例：使用 arcs_evb 开发板
./tools/burn/cskburn -s /dev/ttyUSB0 -b 3000000 0x0 build/arcs.bin -C arcs

Windows PowerShell：

# 通用命令
.\tools\burn\cskburn.exe -C <芯片系列> -s <串口号> -b 3000000 <烧录地址> <固件路径>

# 示例：使用 arcs_evb 开发板
.\tools\burn\cskburn.exe -C arcs -s COM7 -b 3000000 0x0 .\build\arcs.bin

Note

烧录参数说明：

-s /dev/ttyUSB0 / -s COM7：串口设备路径，需要根据实际情况修改 - Linux 系统：通常是 /dev/ttyUSB0 或 /dev/ttyACM0 - 可通过 ls /dev/tty* 命令查看可用串口设备 - Windows 系统：通常是 COM7、COM8 等，可在“设备管理器”的“端口”中查看 - 不同开发板或 USB 转串口芯片可能使用不同的设备名
-b 3000000：烧录波特率（3Mbps）
0x0：烧录起始地址
build/arcs.bin / .\build\arcs.bin：编译生成的固件路径
-C arcs：芯片类型

注意事项：

确保开发板已正确连接到电脑
如果无法识别串口设备，请检查 USB 连接线是否正常，或尝试其他 USB 端口

预期输出

[I][registry] === App Registry Demo ===
[I][registry] Init module[0]: led
[I][led] LED module initialized
[I][registry] Init module[1]: sensor
[I][sensor] Sensor module initialized
[I][registry] All 2 modules initialized

模块按名称字典序排列（链接器 SORT() 保证）。

核心 API

API	说明
`listenai_add_linker_section()`	将自定义链接器脚本片段注入指定链接槽位
`APP_MODULE_REGISTER()`	将模块注册项放入 `.app_registry.<name>` 段
`__app_registry_start` / `__app_registry_end`	标记注册表起止地址，供运行时遍历

关键代码

注册宏定义（app_registry.h）

typedef struct {
    const char *name;
    int (*init)(void);
} app_module_entry_t;

extern const app_module_entry_t __app_registry_start[];
extern const app_module_entry_t __app_registry_end[];

#define APP_MODULE_REGISTER(mod_name, init_fn)                            \
    static const app_module_entry_t __app_module_##mod_name               \
        __attribute__((used, section(".app_registry." #mod_name))) = {    \
            .name = #mod_name,                                            \
            .init = (init_fn),                                            \
    }

模块注册（独立 .c 文件）

/* module_led.c — 无需修改 main.c */
#include "app_registry.h"

static int led_init(void)
{
    LOGI("LED module initialized");
    return 0;
}

APP_MODULE_REGISTER(led, led_init);

运行时遍历（main.c）

for (entry = __app_registry_start; entry < __app_registry_end; entry++) {
    entry->init();
}

注意事项

添加新模块：只需新建 .c 文件 + APP_MODULE_REGISTER() + 加入 CMakeLists.txt，无需修改 main.c
排序保证：链接器 SORT(.app_registry.*) 按段名字典序排列，模块名决定初始化顺序
只读段：注册表放在 ROM（>ROM AT>ROM），无需散加载，节省 RAM
SDK 同类机制：LISA_DEVICE_REGISTER 使用 .lisa_device_registry 段，SYS_INIT 使用 .sys_init 段，原理完全相同