FreeRTOS 命名约定和前缀说明

FreeRTOS 命名约定和前缀说明

在 FreeRTOS 中，函数和变量名称的前缀遵循特定的命名约定，帮助开发者快速理解函数的作用、返回值类型或功能。以下是常见的前缀及其含义：

常见前缀及含义

前缀	含义	示例
pv	指向任意类型的指针（void）*。通常表示一个返回指针的函数或变量。	pvPortMalloc()：返回一个指向内存块的指针。
v	void 返回值。表示这个函数没有返回值，仅执行操作。	vTaskDelay()：执行任务延时，不返回值。
x	通用数据类型或结构体，通常用于返回状态或值。	xQueueSend()：返回状态（成功或失败）。
ux	无符号整数（unsigned portBASE_TYPE），通常用于计数或索引。	uxTaskPriorityGet()：返回任务优先级。
ul	无符号长整数（unsigned long），用于较大范围的无符号值。	ulTaskNotifyValueClear()：清除通知值。
pc	指向字符的指针（char）*，表示字符串或字符数组。	pcTaskGetName()：返回任务的名称字符串。
us	无符号短整数（unsigned short），通常用于较小范围的无符号值。	usTaskGetStackHighWaterMark()：获取剩余栈的高水位。
e	枚举类型（enum），通常用于状态或模式的定义。	eTaskState：任务的状态类型。
pd	布尔值（portBASE_TYPE，表示成功或失败），一般表示 pdTRUE/pdFALSE。	pdPASS / pdFAIL：操作成功或失败的返回值。
prv	私有函数（private），仅在模块内部使用。	prvTaskCheckStack()：内部任务栈检查函数。
port	与移植相关的定义或函数，通常与底层硬件架构相关。