Zig Hello World 示例

功能说明

该示例用于验证 ARCS SDK 当前的 Zig 支持已经可以正常工作。工程通过 C 入口调用 Zig 导出的函数，在 Zig 侧完成日志初始化并输出多条日志，用于确认 Zig 代码能够被成功编译、链接并在板端运行。

硬件连接

无需额外外设连接。

串口输出：

使用默认日志串口
波特率请以当前板级 syslog 配置为准

示例步骤

C 入口打印 Zig 测试启动日志
调用 Zig 导出的 zig_hello_main()
Zig 侧执行 arcs.log.init()
通过 arcs.log.info() 和 scoped logger 输出日志
返回执行结果给 C 入口并打印 PASS/FAIL

编译

重要提示：编译前需要先确认当前示例支持的目标板型，然后将板型标识传给 -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 中的说明为准。

建议将示例路径替换为：

./build.sh -C -S samples/libraries/zig/helloworld -DBOARD=arcs_evb

烧录

编译完成后，使用 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 端口

预期输出

成功运行后，可看到类似输出：

=== Zig Language Support Test ===
Calling zig_hello_main()...
Hello from Zig on ARCS SDK!
Zig language support is working!
zig-hello: Zig version running on RISC-V ARCS SoC
zig-hello: Log system initialized successfully
Zig function returned successfully (ret=0)
=== Zig Test PASSED ===

核心 API

API	说明
`zig_hello_main()`	Zig 侧导出的 C 可调用入口函数
`arcs.log.init()`	初始化 Zig 日志系统
`arcs.log.info()`	输出普通日志
`arcs.log.scoped()`	创建带标签的 scoped logger

关键代码

1. Zig 入口函数

const arcs = @import("arcs");

export fn zig_hello_main() callconv(.C) i32 {
    arcs.log.init() catch return -1;
    arcs.log.info("Hello from Zig on ARCS SDK!", .{});
    return 0;
}

2. C 调用 Zig 导出函数

extern int zig_hello_main(void);

int main(int argc, char **argv)
{
    return zig_hello_main();
}

注意事项

模板用途: 该示例是最小接入示例，适合作为后续 Zig sample 的模板
工具链依赖: 工程依赖本机已安装 Zig 编译器，否则配置阶段会直接失败
能力来源: @import("arcs") 的能力由 labs/zig/adapter/src/root.zig 统一导出
CI 判定: 真机验证建议以最终串口口令 === Zig Test PASSED === 作为成功条件，而不是只匹配中间日志