API 参考

本节提供所有 Nexus 模块的完整 API 文档。API 文档使用 Doxygen 从源代码自动生成，并通过 Breathe 集成。

核心层

Hardware Abstraction Layer (HAL)

HAL提供

HAL API 参考

完整的 HAL API 参考，包括 GPIO、UART、SPI、I2C、定时器、ADC 等。

OS Abstraction Layer (OSAL)

OSAL提供

OSAL API 参考

完整的 OSAL API 参考，包括任务、互斥锁、信号量、队列和定时器。

框架 Modules

Init 框架

使用链接器段的自动初始化系统。

Init Framework API Reference

Init 框架 API 参考，包含初始化级别和导出宏。

Log 框架

灵活的日志系统，支持多个后端和异步支持。

日志框架 API 参考

Log 框架 API 参考，包括日志级别、后端和配置。

Shell 框架

交互式命令行界面，支持自动完成和历史记录。

Shell 框架 API 参考

Shell 框架 API 参考，包括命令注册和行编辑。

配置管理器

配置管理系统，支持多个存储后端。

配置管理器 API 参考

配置管理器 API 参考，包括数据类型和后端。

开发 Tools

Kconfig 工具

用于管理基于 Kconfig 的配置的工具。

Kconfig Tools API

Kconfig 工具 API 参考，用于配置生成和验证。

模块 Organization

Nexus API 组织为以下类别：

Core Layers:

• HAL - 外设的硬件抽象

• OSAL - 操作系统抽象

Framework Modules:

• Init - 自动初始化系统

• Log - 日志框架

• Shell - 命令行界面

• Config - 配置管理

Development Tools:

• Kconfig Tools - 配置管理工具

API 文档标准

所有 API 函数都遵循以下文档标准：

• 函数签名，包含参数类型和返回值

• Parameter descriptions with direction (in/out/in-out)

• 返回值描述，包括错误代码

• 常见模式的**使用示例**

• 并发使用的**线程安全信息**

• Cross-references to related functions