自定义段注入示例

功能说明

演示如何通过 listenai_add_linker_section() 注入自定义链接器段，并通过 listenai_add_linker_scatter() 注册启动时的数据复制。实现从 ROM 加载、在 RAM 中运行的自定义数据段。

硬件连接

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

示例内容

编写 .ld 片段文件定义 .app_config 段（>RAM AT>ROM）
在 CMakeLists.txt 中注册段到 ROM slot
注册散加载表条目，启动代码自动将数据从 ROM 复制到 RAM
在 C 代码中将配置项放入该段，运行时通过链接器符号遍历

编译

重要提示：编译前需要先确认当前示例支持的目标板型，然后将板型标识传给 -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][section] === Custom Section Demo ===
[I][section]   config[0]: baud_rate = 115200
[I][section]   config[1]: retry_count = 3
[I][section]   config[2]: timeout_ms = 5000
[I][section] Total config entries: 3

核心 API

API	说明
`listenai_add_linker_section()`	将自定义链接器脚本片段注入指定链接槽位
`listenai_add_linker_scatter(SCATLOAD ...)`	注册启动时从 ROM 复制到 RAM 的段
`listenai_add_linker_scatter(SCATZERO ...)`	注册启动时执行零填充的 BSS 段
`APP_CONFIG_DEFINE()`	将配置项放入 `.app_config.<name>` 段

关键代码

.ld 片段文件

/* linker/app-config-sections.ld */
    .app_config : ALIGN(4) {
        . = ALIGN(4);
        __app_config_start = .;
        KEEP(*(.app_config))
        KEEP(*(.app_config.*))
        . = ALIGN(4);
        __app_config_end = .;
    } >RAM AT>ROM

CMakeLists.txt 注册

# 注入段定义到 ROM slot
listenai_add_linker_section(
    FILE ${CMAKE_CURRENT_SOURCE_DIR}/linker/app-config-sections.ld
    SLOT ROM
    SORT_KEY "50-app"
)

# 注册散加载：启动时从 ROM 复制到 RAM
listenai_add_linker_scatter(SCATLOAD .app_config)

C 代码使用

/* 链接器导出的段起止符号 */
extern const app_config_entry_t __app_config_start[];
extern const app_config_entry_t __app_config_end[];

/* 将数据放入自定义段 */
#define APP_CONFIG_DEFINE(cfg_key, cfg_value)                              \
    static const app_config_entry_t __app_cfg_##cfg_key                   \
        __attribute__((used, section(".app_config." #cfg_key))) = {       \
            .key   = #cfg_key,                                            \
            .value = (cfg_value),                                         \
    }

APP_CONFIG_DEFINE(baud_rate,   115200);
APP_CONFIG_DEFINE(timeout_ms,  5000);

/* 运行时遍历 */
for (entry = __app_config_start; entry < __app_config_end; entry++) {
    LOGI("  %s = %ld", entry->key, (long)entry->value);
}

验证方法

# 确认最终链接脚本包含该段和散加载条目
grep app_config build/linker.ld

注意事项

KEEP() 必需：自定义段中的符号可能未被直接引用，必须用 KEEP() 防止链接器垃圾回收
SCATLOAD vs SCATZERO：SCATLOAD 用于从 ROM 复制到 RAM 的段，SCATZERO 用于需要零填充的 BSS 段
SLOT 选择：段定义必须放在正确的 SLOT 中，确保在链接脚本中的位置合理
attribute((used))：配合 KEEP() 使用，防止编译器优化掉未直接引用的变量