FreeRTOS 命名规则

这篇文章用来记录 FreeRTOS 的命名规则。

1. 数据类型

在 FreeRTOS 中，使用的数据类型虽然都是标准 C 里面的数据类型，但是针对不同的处理器，对标准 C 的
数据类型又进行了重定义，给它们取了一个新的名字，比如 char 重新定义了一个名字 portCHAR，这里面
的 port 表示接口的意思，就是 FreeRTOS 要移植到这些处理器上需要这些接口文件来把它们连接在一起。
但是用户在写程序的时候并非一定要遵循 FreeRTOS 的风格，我们还是可以直接用 C 语言的标准类型。在
FreeRTOS 中，int 型从不使用，只使用 short 和 long 型。在 Cortex-M 内核的 MCU 中，short 为 16 位，
long 为 32 位。

FreeRTOS 中详细的数据类型重定义在 portmacro.h 这个头文件中实现，具体汇总见表FreeRTOS 中的数据类型重定义和代码清单:FreeRTOS 中的数据类型重定义。

新定义的数据类型实际的	实际的数据类型（C 标准类型
portCHAR	char
portSHORT	short
portLONG	long
portTickType	unsigned shortint	用于定义系统时基计数器的值和阻塞时间的值。当 FreeRTOSConfig.h 头文件中的宏 configUSE_16_BI T_TICKS 为 1 时则为 16 位。
	unsigned int	用于定义系统时基计数器的值和阻塞时间的值。FreeRTOSConfig.h 头文件中的宏 configUSE_16_BI T_TICKS 为 1 时则为 32 位。
portBASE_TYPE	long	根据处理器的架构来决定是多少位的，如果是 32/16/8bit 的处理器则是 32/16/8bit 的数据类型。一般用于定义函数的返回值或者布尔类型。

#define portCHAR char
#define portFLOAT float
#define portDOUBLE double
#define portLONG long
#define portSHORT short
#define portSTACK_TYPE uint32_t

#define portBASE_TYPE long
typedef portSTACK_TYPE StackType_t;
typedeflong BaseType_t;
typedefunsigned long UBaseType_t;

#if( configUSE_16_BIT_TICKS == 1 )
typedefuint16_t TickType_t;
#define portMAX_DELAY ( TickType_t ) 0xffff
#else
typedefuint32_t TickType_t;
#define portMAX_DELAY ( TickType_t ) 0xffffffffUL

2. 变量命名

在 FreeRTOS 中，定义变量的时候往往会把变量的类型当作前缀加在变量上，这样的好处是让用户一看到这个变量就知道该变量的类型。比如 char 型变量的前缀是 c，short 型变量的前缀是 s，long 型变量的前缀是l，portBASE_TYPE 类型变量的前缀是 x。还有其他的数据类型，比如数据结构，任务句柄，队列句柄等定义的变量名的前缀也是 x。

如果一个变量是无符号型的那么会有一个前缀 u，如果是一个指针变量则会有一个前缀 p。因此，当我们定义一个无符号的 char 型变量的时候会加一个 uc 前缀，当定义一个 char 型的指针变量的时候会有一个 pc 前缀。

3. 函数名

函数名包含了函数返回值的类型、函数所在的文件名和函数的功能，如果是私有的函数则会加一个 prv（private）的前缀。特别的，在函数名中加入了函数所在的文件名，这大大的帮助了用户提高找函数定义的效率和了解函数作用的目的，具体的举例如下：

vTaskPrioritySet() 函数的返回值为 void 型，在 task.c 这个文件中定义。
xQueueReceive() 函数的返回值为 portBASE_TYPE 型，在 queue.c 这个文件中定义。
vSemaphoreCreateBinary() 函数的返回值为 void 型，在 semphr.h 这个文件中定义。

4. 宏

宏均是由大写字母表示，并配有小写字母的前缀，前缀用于表示该宏在哪个头文件定义，部分举例具体见下表。

前缀	宏定义的头文件
port (举例, portMAX_DELAY)	portable.h
task (举例, taskENTER_CRITICAL())	task.h
pd (举例, pdTRUE)	projdefs.h
config(举例, configUSE_PREEMPTION)	FreeRTOSConfig.h
err (举例, errQUEUE_FULL)	projdefs.h