Yuan RTOS API 文档
本文档涵盖当前版本的所有 API，介绍了涉及的函数原型、参数、返回值、行为、限制与典型用法。
相关约定
| 相关约定 | 说明 |
|---|---|
| 基本类型 | 使用 include/portable.h 中定义的固件宽度基本类型 |
| 返回值 | 除了特定的移植接口，统一使用 include/yr_def.h 中定义的 yr_err_t、yr_bool_t |
| 优先级 | 范围为 [0 YR_TASK_PRIORITY_MAX), 数值越小优先级越高（0 为最高） |
| 节拍(滴答) | 全局节拍，频率由 YR_TICK_RATE_HZ 决定 |
| 临界区 | 内核临界区由 yr_irq_disable/enable 保护；外部则利用 IPC 相关 API 进行保护 |
| 节拍定时回调 | 要求提供时基定时中断执行，如 Systick |
| 上下文 | 有些 API 无法同时用于任务或者ISR上下文，见下文说明 |
返回值定义
类型为 yr_err_t 的返回值
| 返回值 | 含义 | 典型来源 |
|---|---|---|
| YR_OK | 成功 | 正常执行 |
| YR_ERR | 失败 | 超时、为空、已满、未知错误 |
| YR_NULL | 空指针 | 提供了空指针作为参数 |
| YR_INVALID | 无效值 | 提供了一个无效对象作为参数 |
类型为 yr_bool_t 的返回值
| 返回值 | 含义 | 典型来源 |
|---|---|---|
| YR_FALSE | 假 | 判断为假逻辑 |
| YR_TRUE | 真 | 判断为真逻辑 |