文章详情

短信预约-IT技能 免费直播动态提醒

请输入下面的图形验证码

提交验证

短信预约提醒成功

FreeRTOS编码标准及风格指南

2024-04-02 19:55

关注

1.编码标准

FreeRTOS的核心源代码遵从MISRA编码标准指南。这个标准篇幅稍长,你可以在MISRA官方网站花少量钱买到,这里不再复制任何标准。

FreeRTOS源代码不符合MISRA标准的项目如下所示:

有两个API函数有多个返回点。MISRA编码标准强制规定:一个函数在其结尾应该有单一的返回点。

指针算数运算,在创建任务时,为了兼容8、16、20、24、32位总线,不可避免的使用了指针算数运算。MISRA编码标准强制规定:指针的算术运算只能用在指向数组或数组元素的指针上。

默认情况下,跟踪宏为空语句,因此不符合MISRA的规定。MISRA编码标准强制规定:预处理指令在句法上应该是有意义的。

FreeRTOS可以在很多不同编译器中编译,其中的一些编译器比同类有更高级特性。因为这个原因,FreeRTOS不使用任何非C语言标准的特性或语法。一个例外情况是头文件stdint.h。在文件夹FreeRTOS/Source/include下包含一个叫做stdint.readme的文件,如果你的编译器不提供stdint类型定义,可以将stdint.readme文件重命名为stdint.h。

2.命名规则

      RTOS内核和演示例程源代码使用以下规则:

1> 变量

uint32_t类型的变量使用前缀ul,这里’u’表示’unsigned’,’l’表示’long’

uint16_t类型的变量使用前缀us,这里’u’表示’unsigned’,’s’表示’short’

uint8_t类型的变量使用前缀uc,这里’u’表示’unsigned’,’c’表示’char’

非stdint类型的变量使用前缀x,比如基本的Type_t和TickType_t类型,这些类型在移植层定义,定义成符合处理器架构的最高效类型;

非stdint类型的无符号变量使用前缀ux,比如UbaseType_t(unsigned BaseType_t)

size_t类型的变量使用前缀x;

枚举类型变量使用前缀e

指针类型变量在类型基础上附加前缀p,比如指向uint16_t的指针变量前缀为pus

与MISRA指南一致,char类型变量仅被允许保存ASCII字符,前缀为c

与MISRA指南一致,char *类型变量仅允许指向ASCII字符串,前缀为pc

2> 函数

在文件作用域范围的函数前缀为prvAPI函数的前缀为它们的返回类型,当返回为空时,前缀为vAPI函数名字起始部分为该函数所在的文件名。比如vTaskDelete函数定义在tasks.c,并且该函数返回空。

3> 宏

宏的名字起始部分为该宏定义所在的文件名的一部分。比如configUSE_PREEMPTION定义在FreeRTOSConfig.h文件中。除了前缀,宏剩下的字母全部为大写,两个单词间用下划线(’_’)隔开。

3.数据类型

只有stdint.h和RTOS自己定义的数据类型可以使用,但也有例外情况,如下所示:

char:与MISRA编码标准指南一致,char类型变量仅被允许保存ASCII字符char *:与MISRA编码标准指南一致,char *类型变量仅允许指向ASCII字符串。当标准库函数期望一个char *参数时,这样做可以消除一些编译器警告;特别是考虑到有些编译器将char类型当做signed类型,还有些编译器将char类型当做unsigned类型。

      有三种类型会在移植层定义,它们是:

TickType_t:如果configUSE_16_BIT_TICKS为非零(条件为真),TickType_t定义为无符号16位类型。如果configUSE_16_BIT_TICKS为零(条件为假),TickType_t定义为无符号32位类型。注:32位架构的微处理器应设置configUSE_16_BIT_TICKS为零。

BaseType_t:定义为微处理器架构效率最高的数据类型。比如,在32位架构处理器上,BaseType_t应该定义为32位类型。在16位架构处理器上,BaseType_t应该定义为16位类型。如果BaseType_t定义为char,对于函数返回值一定要确保使用的是signed char,否则可能造成负数错误。

UbaseType_t:这是一个无符号BaseType_t类型

风格指南

缩进:缩进使用制表符,一个制表符等于4个空格。

注释:注释单行不超过80列,特殊情况除外。不使用C++风格的双斜线(//)注释

布局:FreeRTOS的源代码被设计成尽可能的易于查看和阅读。下面的代码片中,第一部分展示文件布局,第二部分展示C代码设计格式。


#include <stdlib.h>

#include "FreeRTOS.h"

#include "HardwareSpecifics.h"

#define A_DEFINITION    ( 1 )

static void prvAFunction( uint32_t ulParameter );

static BaseType_t xMyVariable.


void vAFunction( void )
{

}

static UBaseType_t prvNextFunction( void )
{

}


void vAnExampleFunction( long lParameter1, unsigned short usParameter2 )
{

uint8_t ucByte;

for( ucByte = 0U; ucByte < fileBUFFER_LENGTH; ucByte++ )
{

}
}

for( ucByte = 0U; ucByte < fileBUFFER_LENGTH; ucByte++ )
{
}
while( ucByte < fileBUFFER_LENGTH )
{
}

if( ( ucByte < fileBUFFER_LENGTH ) && ( ucByte != 0U ) )
{
ulResult = ( ( ulValue1 + ulValue2 ) - ulValue3 ) * ulValue4;
}

#if( configUSE_TRACE_FACILITY == 1 )
{

pxNewTCB->uxTCBNumber = uxTaskNumber;
}
#endif

ucBuffer[ 0 ] = 0U;
ucBuffer[ fileBUFFER_LENGTH - 1U ] = 0U;

以上就是FreeRTOS编码标准及风格指南的详细内容,更多关于FreeRTOS编码标准风格的资料请关注编程网其它相关文章!

阅读原文内容投诉

免责声明:

① 本站未注明“稿件来源”的信息均来自网络整理。其文字、图片和音视频稿件的所属权归原作者所有。本站收集整理出于非商业性的教育和科研之目的,并不意味着本站赞同其观点或证实其内容的真实性。仅作为临时的测试数据,供内部测试之用。本站并未授权任何人以任何方式主动获取本站任何信息。

② 本站未注明“稿件来源”的临时测试数据将在测试完成后最终做删除处理。有问题或投稿请发送至: 邮箱/279061341@qq.com QQ/279061341

软考中级精品资料免费领

  • 历年真题答案解析
  • 备考技巧名师总结
  • 高频考点精准押题
  • 2024年上半年信息系统项目管理师第二批次真题及答案解析(完整版)

    难度     813人已做
    查看
  • 【考后总结】2024年5月26日信息系统项目管理师第2批次考情分析

    难度     354人已做
    查看
  • 【考后总结】2024年5月25日信息系统项目管理师第1批次考情分析

    难度     318人已做
    查看
  • 2024年上半年软考高项第一、二批次真题考点汇总(完整版)

    难度     435人已做
    查看
  • 2024年上半年系统架构设计师考试综合知识真题

    难度     224人已做
    查看

相关文章

发现更多好内容

猜你喜欢

AI推送时光机
位置:首页-资讯-后端开发
咦!没有更多了?去看看其它编程学习网 内容吧
首页课程
资料下载
问答资讯