Name conventions in FreeRTOS

Data Type

TickType_t: FreeRTOS interrupt count value type, which can be 16-bit or 32-bit. For 32-bit CPU, TickType_t is preferably 32-bit.

BaseType_t: It is the data type that can make the CPU run more efficiently.
For 32-bit CPU, BaseType_t is uint32_t .16-bit CPU is uint16_t, 8-bit CPU is uint8_t.
Usually BaseType_t is used as a simple return value and logical value type, such as:

pdTRU1	1
pdFALSE	0
pdPASS	1
pdFAIL	0

When writing a program, you can set the return value type to BaseType_t type.

variable name

The variable name consists of the prefix + the variable name.

The prefix is ​​used to indicate some attributes of the variable, such as what type of variable is, char, short, long, or pointer type, etc.

prefix	Meaning
c	char
s	short
l	long
u	unsigned
uc	unsigned char
us	unsigned short
ul	unsigned long
x	BaseType_t type or complex type such as structure
p	Pointer
pc	char pointer

function name

The function name is also composed of the prefix + function name, where the prefix is ​​composed of the return value type and the file name where the function is located.

For example:

vTaskXXXX(); indicates that the return value of the function is void type, this function is defined in the Task.c file

xQueueXXXX(); indicates that the return value of the function is a structure or a more complex type such as BaseType_t, this function is in Queue.cis defined in the file

pvXXXX(); indicates that the return value type of the function is void* type, which is defined in the timers.c file

prvXXX:prv means private, it is a private function that is a function of type static

Macro Name

The prefix of the macro name indicates which file it is defined in

For example:

taskENTER_DRITICAL() is defined in task.h

pdRTUE is defined in projdefs.h

configUSE_PREEMPTION is defined in FreeRTOSConfig.h

Understanding the naming conventions of variables, functions, macros, etc. in FreeRTOS, we can know the return value type of the function or variable according to the name or is defined in that file, and can quickly find them, which is convenient for us to find and understandFreeRTOS.