01. FreeRTOS编码标准2 A' E0 K" e$ [
FreeRTOS核心的源代码遵从MISRA编码标准指南。这个标准篇幅稍长,大家可以在MISRA官方网站找到对应的文档。: [ o0 D$ p! U5 t$ k: ?7 I/ E
; k1 J$ Q3 w- |- w8 [/ ]$ ^FreeRTOS源代码不符合MISRA标准的项目如下所示:
# D# ~# F( x: I9 n* J
/ r1 V4 i3 `+ W2 O0 w, {* \1.有两个API函数有多个返回点。MISRA编码标准强制规定:一个函数在其结尾应该有单一的返回点。- [' D1 J- }9 p! v/ C
8 t* X9 ?/ S- ~( M* C* R$ E2.指针算数运算,在创建任务时,为了兼容8、16、20、24、32位总线,不可避免的使用了指针算数运算。MISRA编码标准强制规定:指针的算术运算只能用在指向数组或数组元素的指针上。( A/ \# S7 }' ^0 {
0 G" o. }; d& r C" W3.默认情况下,跟踪宏为空语句,因此不符合MISRA的规定。MISRA编码标准强制规定:预处理指令在句法上应该是有意义的。3 A! K. |7 k- q( t! |
1 \+ g: F, |8 U7 w: c+ |FreeRTOS可以在很多不同编译器中编译,其中的一些编译器比同类有更高级特性。因为这个原因,FreeRTOS不使用任何非C语言标准的特性或语法。一个例外情况是头文件stdint.h。在文件夹FreeRTOS/include下包含一个叫做stdint.readme的文件,如果你的编译器不提供stdint类型定义,可以将stdint.readme文件重命名为stdint.h。$ i* [. k! {1 L( R
9 M9 R0 v5 D6 V8 N, V8 h02. FreeRTOS变量命名规则
% t+ Y: \& Z7 v6 ^2 k8 z1 D; B) auint32_t类型的变量使用前缀ul,这里’u’表示’unsigned’,’l’表示’long’
. B1 ~) S0 z# T9 Ouint16_t类型的变量使用前缀us,这里’u’表示’unsigned’,’s’表示’short’
9 |' l' }$ J7 D- Uuint8_t类型的变量使用前缀uc,这里’u’表示’unsigned’,’c’表示’char’, w @3 ]* g/ d; U1 a
非stdint类型的变量使用前缀x,比如基本的Type_t和TickType_t类型,这些类型在移植层定义,定义成符合处理器架构的最高效类型;
. k1 [6 u# |+ T9 m# G非stdint类型的无符号变量使用前缀ux,比如UbaseType_t(unsigned BaseType_t)! g/ ?2 C2 H/ ]; I, {
size_t类型的变量使用前缀x;5 a. d8 p0 E+ }# ~" Q. @8 `- Z
枚举类型变量使用前缀e
, o. g8 c/ O5 w! k; z指针类型变量在类型基础上附加前缀p,比如指向uint16_t的指针变量前缀为pus2 H' t1 O" G. A
与MISRA指南一致,char类型变量仅被允许保存ASCII字符,前缀为c
% Y/ D+ A q+ W与MISRA指南一致,char *类型变量仅允许指向ASCII字符串,前缀为pc
- Y- \( e8 H! q) b03. FreeRTOS函数命名规则0 a+ t- a" ^1 v0 |% k9 k4 m8 `
在文件作用域范围的函数前缀为prv
# c" b; f% c# N% Q2 @0 ]: XAPI函数的前缀为它们的返回类型,当返回为空时,前缀为v
+ f4 G+ d8 Y$ n" O+ }4 }9 AAPI函数名字起始部分为该函数所在的文件名。比如vTaskDelete函数定义在tasks.c,并且该函数返回空。
, i: V' A Y! ^! N4 k5 G! U; e! J% T7 A5 [1 L
04. FreeRTOS宏命名规则7 s- x2 f: f9 a9 e
宏的名字起始部分为该宏定义所在的文件名的一部分。比如configUSE_PREEMPTION定义在FreeRTOSConfig.h文件中。* L* s' S$ r6 ?! r3 |. d1 d4 [
除了前缀,宏剩下的字母全部为大写,两个单词间用下划线(’_’)隔开。. h7 F" r% @# Q; S2 ?$ S' F! j
9 n8 ~; [) l9 R* u, U05. FreeRTOS数据类型/ c F$ _: T. n' {5 r$ r7 t
只有stdint.h和RTOS自己定义的数据类型可以使用,但也有例外情况,如下所示:
" A- O/ b2 t1 U9 X+ X
7 y- `4 I; n( I5 `1.char:与MISRA编码标准指南一致,char类型变量仅被允许保存ASCII字符- I. p8 Y, b' C/ n! V
( Y- I6 A( n9 T% a2.char *:与MISRA编码标准指南一致,char *类型变量仅允许指向ASCII字符串。当标准库函数期望一个char *参数时,这样做可以消除一些编译器警告;特别是考虑到有些编译器将char类型当做signed类型,还有些编译器将char类型当做unsigned类型。. c! I. ]; X! d( K
4 k+ {' I4 P5 N+ \
8 A5 j, t8 ^$ G1 S( E8 A$ H1 |# s有三种类型会在移植层定义,它们是:
9 Q/ K7 k: ?& A8 n: ?6 M4 `9 j) N9 ~8 n: a3 T/ x. O, j# ]
1.TickType_t:如果configUSE_16_BIT_TICKS为非零(条件为真),TickType_t定义为无符号16位类型。如果configUSE_16_BIT_TICKS为零(条件为假),TickType_t定义为无符号32位类型。注:32位架构的微处理器应设置configUSE_16_BIT_TICKS为零。( a( l2 n3 V' d! Y
2 ?7 @) D- B! T$ b7 I
2.BaseType_t:定义为微处理器架构效率最高的数据类型。比如,在32位架构处理器上,BaseType_t应该定义为32位类型。在16位架构处理器上,BaseType_t应该定义为16位类型。如果BaseType_t定义为char,对于函数返回值一定要确保使用的是signed char,否则可能造成负数错误。
' W) M# p/ n) K- X) _7 S/ d
5 a' ~2 K, x8 R6 A1 ?UbaseType_t:这是一个无符号BaseType_t类型% P9 U/ r; y( G9 ?7 r
% n: E0 v, Z' u) _( M! ]06. 其它; |4 [/ c$ O( N" x. ]( P
风格说明
/ n! X' @7 f6 W( j8 g6 y/ i1.缩进:缩进使用制表符,一个制表符等于4个空格。/ U% N3 K$ w1 W( D Q& _/ B
2.注释:注释单行不超过80列,特殊情况除外。不使用C++风格的双斜线(//)注释1 Z7 f# g" X2 ~, r4 g( H& g
3.布局:FreeRTOS的源代码被设计成尽可能的易于查看和阅读。下面的代码片中,第一部分展示文件布局,第二部分展示C代码设计格式。
) n5 p4 |8 ~& _: K. ?! r* i \, K0 y/ ^- c# D% M5 n3 b
示例) [0 N+ I6 d' \9 L, ]2 R
( w: ~. c% e, l; v( a
- /* 首先在这里包含库文件... */
3 ^) m1 G8 Q9 D4 @" F - #include <stdlib.h>
( o" g# E' y9 k* t! } - # n2 W9 f* @( _& M+ L3 ?7 m
- /* 然后是FreeRTOS的头文件... */ - f6 c X7 T% M5 v$ `1 i, ?! D
- #include "FreeRTOS.h"
, E1 P3 j8 }+ ~& R - 4 i8 t$ }: f0 C! Z+ x& m2 a
- /* 紧接着包含其它头文件. */ ' x% Y2 S; E" p- i; q' M
- #include "HardwareSpecifics.h" # n! R! O1 ], M
- / B* B, f4 N" {# N2 x
- /* 随后是#defines, 在合理的位置添加括号. */ # p4 D) ]$ O' T2 e2 V& O1 y2 E
- #define A_DEFINITION ( 1 ) ( w ?/ A0 B9 `7 I& _/ i
- 0 X( v# {% T$ F
- /*
) i. g0 H' X B! r. p; M - * 随后是Static (文件内部的)函数原型, 8 D- u1 _. U( H; D& ~+ l* Q
- * 如果注释有多行,参照本条注释风格---每一行都以’*’起始. ) H. n- ^% _7 G
- */
" K' H; T8 _7 g- A9 d5 F - static void prvAFunction( uint32_t ulParameter ); ) |) {* S- ~) d7 A$ O6 W
8 ^8 T* D+ N9 {. a- Y6 ^- /* 文件作用域变量(本文件内部使用)紧随其后,要在函数体定义之前. */ y( I1 N, v; ^8 W, I
- static BaseType_t xMyVariable. - \+ {2 I$ l7 Y/ E0 o2 K
; p- V/ v6 V$ j7 ~- /* 每一个函数的结束都有一行破折号,破折号与下面的第一个函数之间留一行空白。*/
9 [# `7 ]' ~' y; s; `( J
: K. l$ P( F- j0 N. p$ S2 ]- /*-----------------------------------------------------------*/
0 r. N1 e% Z: T r% A2 t% R - 6 |8 g/ N0 E" S- ]: Y; ^
- void vAFunction( void ) / y- y+ B9 }. |/ n2 N. X4 `
- {
6 x) a; s- o, e! Z; U - /* 函数体在此定义,注意要用大括号括住 */ ! S' Y: i# |: [
- }
/ Y/ V; {" L; a/ c4 C - /*-----------------------------------------------------------*/
$ l) {1 N2 L3 u8 _ - - G; `2 ^& Y. f
- static UBaseType_t prvNextFunction( void ) , z9 A$ t& A2 l
- {
" T m4 U' N, x! o, Q - /* 函数体在此定义. */ 8 c; U) t/ u- k9 d2 j$ ~; k
- }
: U& w/ @: K# v0 J - /*-----------------------------------------------------------*/1 R' h! a) q9 q, r
- 8 D" D4 _7 h! \' f8 z
- /*+ T8 e% J# D2 Q o
- * 函数名字总是占一行,包括返回类型。 左括号之前没有空格左括号之后有一个空格,! v' [+ `0 S5 X/ }9 n% ~& Q, @2 I
- * 每个参数后面有一个空格参数的命名应该具有一定的描述性. + C) d+ ~' `7 {7 J# u6 p/ F0 p* n
- */ i% w8 ]. d8 A1 U1 g$ O( ]
- void vAnExampleFunction( long lParameter1, unsigned short usParameter2 )
( ?: Y0 U+ v" Q9 V - { ' u) K9 \1 R/ ?/ y/ R
- /* 变量声明没有缩进. */ # L& L# V$ w4 n& P: F+ I
- uint8_t ucByte; + R% b$ j1 r. d+ e
- : E+ {. `! L# k
- /* 代码要对齐. 大括号占独自一行. */ : y' o4 P& p* I V9 ^
- for( ucByte = 0U; ucByte < fileBUFFER_LENGTH; ucByte++ ) + c4 r s9 r$ l c
- { 7 K* Q r9 I5 X! Z1 H$ I' |( R t
- /* 这里再次缩进. */
- B/ E, ] _8 ?7 d3 O - }
( x6 h) J, P6 H( } - }
6 g! I( ]( ^9 H
: O1 }* T H. i8 h6 U5 P0 {6 r: }* Y- /*
: g) n; s$ H% P# f - * for、while、do、if结构具有相似的模式。这些关键字和左括号之间没有空格。
+ P, P# U, ~! x+ q7 L; v& ^ - * 左括号之后有一个空格,右括号前面也有一个空格,每个分号后面有一个空格。
' F1 p+ Y: T* F# N( y - * 每个运算符的前后各一个空格。使用圆括号明确运算符的优先级。不允许有06 ~8 ]# {+ r- |+ }+ y7 v
- * 以外的数字(魔鬼数)出现,必要时将这些数字换成能表示出数字含义的常量或
2 _/ a4 j1 H" y5 f# o - * 宏定义。
- D6 Q$ J9 ]% t' Z1 Y2 k/ P - */
/ T' M+ s0 _2 P! E' { - for( ucByte = 0U; ucByte < fileBUFFER_LENGTH; ucByte++ ) , X/ x" j5 N' Z5 m* \" N, V
- {
1 ^$ x: B9 e0 X4 q4 S - }
+ k0 \7 s$ N' s# k - " G- E, I Q2 i& ~/ Q& @* W
- while( ucByte < fileBUFFER_LENGTH ) ) ?$ j+ j+ ^- p- `/ D0 o
- {
, _$ H% v* S/ w4 r! { n9 w* O - } ! }6 z0 N+ k: C5 X! v
- 3 M! `$ W% @: R$ d2 f
- /* 0 |# P6 o- b" p. u6 L7 z
- * 由于运算符优先级的复杂性,我们不能相信自己对运算符优先级时刻保持警惕. K; M$ Q/ y" } ?- N0 n
- * 并能正确的使用,因此对于多个表达式运算时,使用括号明确优先级顺序
x) A, }, W3 Y+ I9 ^2 T - */ ) T9 T& E! m' E& O$ W1 s1 M
- if( ( ucByte < fileBUFFER_LENGTH ) && ( ucByte != 0U ) )
+ p+ H3 U3 z$ e1 p; h4 B - { , d' P2 t' a2 V/ M
- ulResult = ( ( ulValue1 + ulValue2 ) - ulValue3 ) * ulValue4; $ N7 i+ M, ?" t! A( f
- } ; a6 Q0 u" U' f- G) j8 z
5 j9 B, `) _1 j! B- /* 条件表达式也要像其它代码那样对齐。 */ I& W+ K7 t3 o ~6 O+ @' \
- #if( configUSE_TRACE_FACILITY == 1 ) + s7 Y9 X. d2 O' v P
- { " q+ h6 R- d U* _1 C) ]+ ]3 z
- /* 向TCB增加一个用于跟踪的计数器. */
4 `/ m, O, W: m r# i) j8 F& V - pxNewTCB->uxTCBNumber = uxTaskNumber;
! W( `" U5 B0 ~( }2 X; Q - } + U* I1 W. \/ H0 f/ c7 z
- #endif
5 i4 a# L2 R9 w" |4 p4 G - * H) ^* Q8 {1 J$ l5 `* V
- /*方括号前后各留一个空格*/ , W# c9 e2 N& R0 h/ }+ R
- ucBuffer[ 0 ] = 0U;
( ]7 L+ D! G; X4 D; u4 z6 D: @ - ucBuffer[ fileBUFFER_LENGTH - 1U ] = 0U;
复制代码 ) @5 K! E0 g+ _8 G2 b7 Y H7 O
; X" b& e, U" d; b9 s
|