逸珺 · 2021年01月05日

一文带你快速理解FreeRTOS代码规范

首发:嵌入式客栈
作者:逸珺

[导读] 遇到些朋友感觉FreeRTOS内核代码看起来很不习惯,不习惯其编码风格,本文就来梳理一下其代码规范,便于提高阅读其代码的效率。代码基于FreeRTOS V10.4.3。

FreeRTOS代码结构

image.png

其内核代码文件就这几个,非常简洁:

  • croutine.c/croutine.h: 协程,在8位/16位平台下效率比较高,在32位平台建议使用任务task
  • event\_groups.c / event\_groups.h:顾名思义,这个是事件组的实现
  • heap\_x.c:内核堆实现,FreeRTOS提供了heap\_1.c ~ heap\_5.c 5种堆管理器,各有优缺点,需要根据应用进行选择。
  • list.c/list.h:链表实现,主要为调度器提供数据结构算法支持服务。比如任务链表。
  • port.c/portmacro.h:硬件相关层级可移植抽象,主要包括SysTick中断,上下文切换,中断管理,具体实现很大程度上取决于平台(单片机体系硬件内核和编译器工具集)。通常以汇编语言实现。
  • queue.c/queue.h/semphr.h:信号量、互斥体实现
  • tasks.c/task.h:任务管理器实现
  • timers.c/timers.h:软件定时器实现
  • FreeRTOS.h:选编译配置文件,用于汇总所有源文件的编译选择控制
  • FreeRTOSConfig.h:FreeRTOS内核配置,Tick时钟和irq中断配置

接下来整理一下,相关的代码规范,具体就体现在上述文件的编码中。

变量

变量有严格的前缀标识变量类型属性:

  • c – char 字符型变量
  • s – short 短型变量
  • l – long  长整型变量
  • x – portBASE\_TYPE 在 portmacro.h 中定义,便于移植的数据类型转定义
  • u – unsigned 无符号整型
  • p - pointer 指针

举例:

//x表示portBASE_TYPE, u 表示无符号型  
PRIVILEGED_DATA static volatile TickType_t xTickCount = ( TickType_t ) configINITIAL_TICK_COUNT;  
PRIVILEGED_DATA static volatile UBaseType_t uxTopReadyPriority = tskIDLE_PRIORITY;  
  
//比如在list.h 中  
struct xLIST_ITEM  
{  
    configLIST_VOLATILE TickType_t xItemValue;  
    //指针以p打头  
    struct xLIST_ITEM * configLIST_VOLATILE pxNext;   
    struct xLIST_ITEM * configLIST_VOLATILE pxPrevious;   
    void * pvOwner;   
    struct xLIST * configLIST_VOLATILE pxContainer;   
};  

对于C语言的基本数据类型,做了可移植转定义:

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

函数

image.png

前缀:

  • v :void 无返回类型
  • x :返回portBASE\_TYPE
  • prv :私有函数,模块内使用
//ux 表示无符号portBASE_TYPE 返回值  
//List表示该函数所属文件  
//Remove函数名  
UBaseType_t uxListRemove( ListItem_t * const pxItemToRemove ) PRIVILEGED_FUNCTION;  
  
//又比如prv 表示模块内函数  
static TickType_t prvGetNextExpireTime( BaseType_t * const pxListWasEmpty ) PRIVILEGED_FUNCTION;  


-

定义宏所属文件,也即在哪个文件内定义的:

  • port:比如portable.h中portMAX\_DELAY
  • task:比如task.h中task\_ENTER\_CRITICAL
  • pd :例如projdefs.h中定义的pdTRUE
  • config:例如 FreeRTOSConfig.h中定义的configUSE\_PREEMPTION
  • err:例如 projdefs.h中定义的errQUEUE\_FULL

至于这么严格的代码规范是否值得推崇,这个见仁见智,个人比较喜欢Linux代码风格,对于过于复杂的代码规范,在实际开发中个人觉得有时候会让人不爽。

END—

推荐阅读

更多硬核嵌入式技术干货请关注嵌入式客栈专栏。
推荐阅读
关注数
2891
内容数
285
分享一些在嵌入式应用开发方面的浅见,广交朋友
目录
极术微信服务号
关注极术微信号
实时接收点赞提醒和评论通知
安谋科技学堂公众号
关注安谋科技学堂
实时获取安谋科技及 Arm 教学资源
安谋科技招聘公众号
关注安谋科技招聘
实时获取安谋科技中国职位信息