THE FREERTOS™ REFERENCE MANUAL · 中文版
FreeRTOS 中文参考手册
FreeRTOS 内核全部 API 与配置选项的中文技术参考。按原书《The FreeRTOS™ Reference Manual》(v10.0.0, issue 1)的章节结构重排:每个函数给出原型、参数、返回值、说明与注意事项,并附可按名称或关键词实时检索的函数速查表。
版本 v10.0.0 · issue 1规模 9 章 + 附录API 155 条记录原书 405 页
怎么用这本手册
- 左边是全书目录,点章名展开小节;顶栏的“函数速查”是全书 API 的检索入口。
- 想找某个函数:直接在速查表里输函数名片段(如
QueueSend)或中文关键词(如“队列 发送”)。 - 想系统学某一类接口:按章读。第 2 章任务、第 3 章队列、第 4 章信号量、第 5 章软件定时器、第 6 章事件组、第 8 章流缓冲区、第 9 章消息缓冲区。
- 调参:第 7 章把
configXXX与INCLUDE_xxx两类配置常量逐条列出,是移植与裁剪时的对照表。
阅读约定
- 每个 API 小节固定五段:原型 → 参数(含方向 in / out / in-out)→ 返回值 → 说明 → 注意,重要函数再补一段“典型用法”。
- 函数原型中的
#include头文件保留原样;同一函数分FromISR与非FromISR两个版本的,分列两节,切勿混用。 - 代码块保留英文注释:注释里往往写着原书对该参数的额外约束,直接对照源码更安全。
- 译名统一:task 任务、queue 队列、semaphore 信号量、mutex 互斥量、event group 事件组、stream buffer 流缓冲区、message buffer 消息缓冲区、tick 节拍、blocked 阻塞态、ready 就绪态、suspended 挂起态。
关于原书。原书是纯 API 参考,不含教学推导。若你刚开始接触 FreeRTOS,建议先读同作者的《Mastering the FreeRTOS Real Time Kernel》教程,再回本手册查细节;本手册每章的说明段落也保留了原书对使用场景的简述,可作为速查用。
目录全书章节
附各章 API 数量一览
| 章节 | 内容 | 条目数 |
|---|---|---|
| 第 1 章 | 关于本手册:范围、API 分组、调用限制 | — |
| 第 2 章 | 任务与调度器 API(Task and Scheduler API) | 57 |
| 第 3 章 | 队列 API(Queue API),含队列集 Queue Set | 24 |
| 第 4 章 | 信号量 API(Semaphore API),含互斥量与递归互斥量 | 18 |
| 第 5 章 | 软件定时器 API(Software Timer API) | 21 |
| 第 6 章 | 事件组 API(Event Groups API) | 11 |
| 第 7 章 | 内核配置(Kernel Configuration):FreeRTOSConfig.h | — |
| 第 8 章 | 流缓冲区 API(Stream Buffer API) | 13 |
| 第 9 章 | 消息缓冲区 API(Message Buffer API) | 11 |
| 附录 A | 数据类型与编码风格指南(Data Types and Coding Style Guide) | — |
合计 155 个函数 / 宏条目(57 + 24 + 18 + 21 + 11 + 13 + 11),函数速查表收录的即这 155 条;第 7 章的 configXXX 与 INCLUDE_xxx 配置常量属“编译期开关”,不计入速查表,单独在第 7 章以表格列出。原书另有 List of Figures(4 图)、List of Code Listings(96 段示例代码)、List of Tables(若干),本中文版已把这些图、表、示例内联到各自小节中,不再单独罗列。