xt-sdk 文档 v1.0.3
xt-sdk 嵌入式 SDK API 参考
载入中...
搜索中...
未找到
xt_hal_internal - HAL 内部公共头文件

版本:0.1 | 日期:2026-07-03 | 路径: platforms/components/xtiny/xt_hal/


一、概述

xt_hal_internal 是 xtiny HAL 模块的内部公共头文件,所有 HAL 子模块(如 xt_hal_dac、xt_hal_i2s 等)均通过此头文件统一引入 xt_error.h ,确保错误码类型( xt_err_t )和错误码常量( XT_EOK 等)在各模块中一致可用。

设计理念: 最小公共依赖层 。仅引入必需的类型定义,避免各 HAL 子模块各自重复 include。

1.1 设计原则

  • 单一职责 :仅负责引入公共依赖,不定义任何额外的类型、函数或宏
  • 不直接面向用户 :用户应 include 具体子模块头文件(如 xt_hal_dac.h ),无需直接 include 本头文件

1.2 依赖

依赖 xt_error.h (错误码与类型定义)。


二、核心概念

2.1 角色定位

xt_hal_internal.h 是 xt_hal 子模块间的"公共前缀",类似于一个预编译头:每个子模块头文件第一行业务 include 就是 #include "xt_hal_internal.h" ,从而间接到 xt_error.h 中的所有定义。

2.2 不公开 API

本模块无任何公开函数、类型或宏。其 @defgroup xt_hal_internal 仅用于 doxygen 文档组织结构,不提供用户可调用的接口。


三、API 参考

本模块无公开 API。所有类型和宏定义均来自 xt_error.h ,请查看 xt_error(错误码) 获取完整错误码说明。


四、已知行为与限制

  • 本头文件仅用于 xt_hal 内部,不应被上层应用直接 include
  • 若未来 xt_hal 需要额外的公共类型或宏,可在此文件中添加,但应保持最小化原则