FreeRTOS 中文参考手册 /A 数据类型与编码风格

第 A 章 · 原书 399–401 页数据类型与编码风格

Chapter A · Data Types and Coding Style Guide

FreeRTOS 的代码风格与数据类型命名并非“个人洁癖”,而是为了让同一份内核源码能在 8/16/32 位、不同编译器、不同 ABI 上都编得过。理解这套约定,看源码和写移植层会顺很多。

A.1数据类型

内核不使用 int、short 这类宽度随平台变化的裸类型,而是统一用 typedef 定义的可移植类型(定义在 portmacro.h 中):

类型含义典型宽度 / 用途
TickType_t节拍计数类型32 位(configUSE_16_BIT_TICKS=0)或 16 位(=1);用于延时、超时、时间戳
BaseType_t内核返回/布尔类型架构上最高效的有符号类型(Cortex-M 为 32 位 int);返回值 pdPASS/pdFAIL、pdTRUE/pdFALSE 都用它
UBaseType_tBaseType_t 的无符号版本用于计数、优先级等非负量
portSTACK_TYPE / StackType_t任务栈单元类型Cortex-M 为 uint32_t;栈深度以“字数”计,不是字节
portPOINTER_SIZE_TYPE指针宽度整数用于需要按指针宽度做运算的场合
StaticTask_t任务控制块(静态创建用)应用在 *Static 系列 API 中直接提供该结构
StaticQueue_t / StaticSemaphore_t / StaticEventGroup_t / StaticTimer_t / StaticStreamBuffer_t各类对象的静态控制块静态创建时由应用提供,避免动态内存
EventBits_t / EventGroupHandle_t事件组位值与句柄位宽受 configUSE_16_BIT_TICKS 影响(8 位或 24 位可用)
QueueHandle_t / SemaphoreHandle_t / TimerHandle_t / StreamBufferHandle_t / TaskHandle_t各类对象句柄本质是指向内部结构的指针,可直接判 NULL
pdMS_TO_TICKS( xTimeInMs )毫秒转节拍宏依赖 configTICK_RATE_HZ;用于把人类时间换算成节拍
portMAX_DELAY无限等待常量只在 INCLUDE_vTaskSuspend 为 1 时真正“无限”
两个常见误用:把 StackType_t 的“字”当成“字节”来配栈深(128 字在 32 位平台是 512 字节);以及把 BaseType_t 的返回值与 pdTRUE(值为 1)以外的非零值比较,导致判断失效——规范写法是 if( xResult == pdPASS ) 或 if( xResult != pdFAIL )。

A.2变量与函数命名前缀

FreeRTOS 用一套“匈牙利式”前缀表达变量类型与作用域,读源码时可以靠前缀猜类型:

前缀含义示例
cchar(字符)cRxChar
sshortsSample
llonglCounter
xBaseType_t / 无固定宽度的整数(也用于结构体)xTicksToWait、xTaskHandle
uunsigned(无符号)uxPriority(u + x)
ulunsigned longulCounter
ppointer(指针)pvBuffer、pxTask
pcpointer to char(字符串/字符指针)pcTaskName
pvpointer to void(通用指针)pvParameters
pppointer to pointerppvParameters
vvoid(函数无返回值或参数为 void)vTaskDelete
e枚举类型(enum)eState、eTaskState
prvprivate(文件内静态函数)prvIdleTask
uxunsigned 且基于 UBaseType_tuxTaskPriorityGet
xTask / vTask / pcTask作用于“任务”对象的函数/变量xTaskCreate

函数命名格式一般是 返回类型前缀 + 对象名 + 动作,例如 vTaskDelay(void、Task、Delay)、xQueueSend(BaseType_t 返回值、Queue、Send)。同族 API 的变体后缀也有固定含义:

A.3编码风格要点