#include "AceVest.h"
-const uint8_t font_acevest[11472] ACEVEST_FONT_SECTION("font_acevest") =
- "{\0\4\2\5\5\5\5\6\20\20\0\376\12\376\13\377\1\270\3y\5{ \6\0@\217\2!\10A"
+const uint8_t font_acevest[11596] ACEVEST_FONT_SECTION("font_acevest") =
+ "~\0\4\2\5\5\5\5\6\20\20\0\376\12\376\13\377\1\270\3y\5{ \6\0@\217\2!\10A"
"Q\210\302AB\42\11\205H\214B\306M\0#\21FE\210JO\6\203D\244\305`\20\351\11\0$"
"\24GE\210Nh\240\210D$\241\331(\42\251\30\210\62\0%\27GE\210\206F\222(ID\24\251"
"X*!ID\22%\32\5\0&\24GE\210\312\246$S\21\22%\42\232\204(\221\221L\2'\7"
"\210d\42\211H&\262\0~\13gD\214\206F\22\321(\0\177&\20B\7C\242\337#\364\4z\304"
"d\220\310L\22\241T$\61Hd&\211Pj\62H\14\366\4z\2=\242\77\200'\20B\7C\242"
"\337#\364\4z\304F\262\230$\42\211H\344 \21\31\204\42\211HQ$\261\320\23\350\11\364\210\376\0"
- "\260\11\203H\215F\205\242\2\267\7BL\212\302 \0\0\0\10X\344\13\231\377\377 \34\15\206D\214"
+ "\260\11\203H\215F\205\242\2\267\7BL\212\302 \0\0\0\10W\371\13\215\377\377 \34\15\206D\214"
"FF\223\310$$\2 \35\16\206D\214\202D\221Id\64\11\0 \42\13\245D\211\306\301\27\13\0"
" \60\27HA\210F(QR\21\311Db\271X\242$\321\27\232D\2 \61\25HA\210F,\221"
"J\304\42\42\303DI\242\237$*\0!\3\31\307A\210F*\21J\244r\203H(\21J\304:J"
"\7\317\302\351\301@\225H\225\204j\252B\211T,\25K$\65\242\235\0S\360\37\15F\7W\70["
"U\227I&\6\17\22\321<\340Q.\224\13\345B\271\320\340(\27\1S\363!\17B\7[\274p\360"
"U<\35O\17\16B\211\134&\222\213dr\261\134,\27\33\234\345\42\0S\367\33\357A\7\317\340,"
- "\27\313\305r\261\301=f\360Q:>\70o\233H\247\0T\16#\17B\7ov\240\32H\343\361\301"
- "\233x\213\301@\225\210\205\42\261P$\226)\213\204\6\3],\2T\21\37\15F\7W\266r\360@"
- "k\63\320hj\64\65\232\32M\215f\240\321\324h\225\11i\2T+#\17B\7_<\235\310f\222"
- "\211LL\223\221\250R\242\301 ]\71\70\313\305r\261\134lp\226\313\0T/!\16B\7_<\70"
- "\70\320$\63\311L\62\63\70\320\244[\14N\352\42u\211LN\64\270\312\5Vh,\357A\7\313@"
- "\62\320\224d\232d\62\3\311@\30\311f\62\203\317\22Q\215L'\321J\6\222\201\246$\323$\223\31"
- "H\6\12\0V\333\35\255\305\7\303\7\232\32M\215\246FS\243\251\221\204\62\222\324@\221\234j\7\337"
- "\6V\355%\355E\7\303\7Z\311`\20\321Z\14.\64\221\220&\22\322DB\222L$!\311D\22"
- "\212\324B;\370\66W\37\20\357\301\7_\274\227\203\3e\274\357\6\37Wj'\17B\7O<\63\30"
- "\204b\271X.\23\251\30L\22\221PEU,\27\31\334\304r\261\334(\264K\5\343E\0W\371("
- "\17B\7O*\30\313e\6\203P<\23\212\14&e\361\310\340&^\63\30\204\26\251\304(\25I\25"
- "\16\6\301T\2X\344.\17B\7K,\27\31\334\304\63\213\311 \222h\224Y\214jR\221\301M("
- "\223\212\14n\64\65\213\301\201\42\25I\4\65\71EIR$Y\4.\17B\7O*\230\12\246\202\203"
- "H\60\22\221e\42\211T&R\223\210\324$\42\211LQ\42\223\14%C\301D&\227\21\306\6\3\71"
- "\0Y\17!\17B\7\307\340A.;\70\313\305\6g\271\330\340,\27\33\334\245\7W\211TM\355r"
- "s\71Y\26'\16B\7O*\227\312\245r\251\330@\22\313DD%\211L(RQ\222i\221)*"
- "\14\345R\261\252\134(\30\2Y'\32\17B\7_\274\273\301w\361t\42\234\310f\242\231d*W\225"
- "\214h\5Y)\34\357A\7\313\340@\31o\67\370.\235\10'\262\231h&\231\312U%#Z\1Y"
- "*\34\17B\7_\274\273\301w\361t\42\234\310f\242\231d\42\223\313T\205J\264\2Y\61!\17B"
- "\7_\64\23\315D\63\321\301A\250\60\25\317\15\276K'\302\211l&\231\312\25)\25\0Y\306\60\17"
- "B\7O<\64\30\365\42\222\30L*\62\221\242L\244(\23\31\34D*R\221\26\231\212H\243L*"
- "\223\210\14\6\212L.\21\252Hg\0[W\32\17B\7[\36\20\34<P\204\305\241\301@\335n\360"
- "]\274q\42\35\4[\211\42\17B\7[\36\220\34\274\211FB\251`<\70\370*\24L\345DQI"
- "X\34\21\252B\303\10\0[\242#\17B\7[\36\20\34<P\204\65\301\324` k\241\311.\67\227"
- "\233\301Y.\226\213\15\316r\31\0[\244\37\357\301\7[\36\20\34<P\204\305\231\301\201.\235\312\15"
- "N\63\321\344\340@\31\317\15>[\266(\17B\7[\36\20\34<P\204\305\221\301\203\134X\21\312l"
- "$\311D\241D\266Q$\25\21\225&\64\320$\322\71\0[\275(\17B\7[\36\20\34<P\204E"
- "\231\232\301\201.\223\7\16\316r\261LY\246,\222\210\4#\251\214&\65\210\15\6[\322(\17B\7"
- "[\36\20\34<Pd\212$\203\213X&\67\70\320eR\203\217R\271\210&U\23\321eTz\200\36"
- "\220\2\134\17\36\17B\7_\274\323LY&\224\312\244\62\241T&\24K\244b\262\272x\70\221\16\2"
- "\134\24 \17B\7S\274zp JfB\65\251\134,\36\315\224eB\255\42\251\230\254*\221\16\2"
- "\134\32!\13J\7WQE\246I]j\360\322d \221d\42\222LD\222\211H\6\22\245.!L"
- "\0]\346\32\357\301\7[\274p\360U\274:>\270\12%C\301T.V\27\34<\10]\356\42\17B"
- "\7S*\231\211\15\36\4\343\311\301\201\60\36\34|\225\256\30\14D\251\134\254.\71\70P\0]\362\27"
- "\314\311\7\303\203l\223`$\30\31\34D\262MM\23\203\3\1^\25-\15F\7K,\25K\25\15"
- "\24\203\201\242\225\242\225\242\225\242\225\242b\60P\264R\264R,R\221L*\222IE\62\203A$\223"
- "\12^\70&\17B\7_\64S\27\251\32<P\204\65\203A$U\230\12\16\6\331\350\340,S\226)"
- "\313$\312\62\221l\16^s\30\357A\7\307\340A\60\36\315\324E\62\271Hmn\360]\274\357\0^"
- "t\36\17B\7O<>\70\320\244\202\251\134,\71\70H\205\222\241d(\66\370\60\336\31\0^\217&"
- "\17B\7_\36\20\34<\210\304\63\203A(\230\252\210\325%\6\7\222X(\22\313\224\325\305r\251X"
- "\42\35\3^\223%\17B\7_\36\20\34<\210\204\222\241\344\340Mi\244\60\221\11&\6G\251`*"
- "\227\30\274\210\325\305c\0^\246'\17B\7_\36\20\34<\210d\312\62e\203\67\315\62e\231\201,"
- "\236\30\14T\221T\250&\225Z\205\64\252\335\0^\255.\17B\7_\36\20\34<\210\304\23\253I&"
- "\61HER%\251\212\203A$\23JeB\251D\305`\220\310D\63\302Ld\60\320d\1_\0\42"
- "\357A\7\307\340A\252\60\25L\5S\301Th\360Q*\230\12\246\202\251\134,\27\253K\5C\0_"
- "\2#\357A\7\313\340 \25L\5S\203\203T\64\23\15\15\16\364\250\302Th\360Q*\27\253K\5"
- "C\0_'\64\17B\7sd\240\32\244\22\203D.Q\222K\224\204\6\211\222PE$T\21\11U"
- "DB\203DM,Q\23K$$\261D\223\224DQ\222(\351\42\12_\61-\355E\7\303\305`\25"
- "K\305\6\203\304`\20K\305R\203\305`\221\211d\42\65\221\220J\242\310(\66\11M*\26I\204\22"
- "\241X\4_:\62\360A\7\303@\62\30\304\42\251X$\225\31D\6\203L\60\225\32\134\244\62\25\3"
- "E\246*\221\251J\14\256*S\221X*\223\210\304\6\13\315 \25_f#\16B\7[<\70\70P"
- "\25fb\203'\351\134*\64K\214\312T!M\305(\223\23\205V\221!\0_\205+\17B\7Se"
- "(\230\312e\6\3IQ\62\24L\14\16\42\272P\42\227\211$\6\7\231\134,\22\212e\312\62e\251"
- "D\254\10_\252=\17B\7Ol\20J\14f\221P*\23*I\14\16\62\211P,\222\30\14\42\222"
- "D*Q\222He\42\211\301 \23I\244\62\221\304`\220IDR\231D$\225\321\14\6\231P*\1"
- "_\256\70\17B\7OQ*\321$\24I\224d*\332D\22\3\305 \23\213d\202\211\210b\260\350\60"
- "\221\211\14\42\211L\244E&RQ\24\211HB\221\26\231D,\221\221e\2_\303#\317\301\7[\36"
- "\220\7\304\263\361X(\222\313Dr\231H\60\221\11&\62\251\210(\25L%\7\33\0`\312\61\17B"
- "\7O*\30\313E\6\67qm\242b\60\210$\62\251H\42\223JD\62\203A(\226\313D\22\251L"
- "\244(\222i\21\312\24%r\251\24\0a\37\63\17B\7k\42\34\311\14\36Dr\261\304@\21\311\344"
- "\42\231\304@Q\224\310DD\211L\244\42\62Pt\227\331\245r\301H&\24)\213\210\6\203H\0b"
- "\20*\17B\7g\42\34\311\346\6\17\42\261\134,\27\313d\6\222L\223L\27\241LE(\23\212T"
- "\324H\22\231\222DYhVb\67\35\14F\7W\70\233\33\34D\202\221`$\30\11F\6\7\221`"
- "$[\232\215f\1b\77(\16B\7[<\70x\22\215D#\203'\241`*\67x\222If\222\231"
- "\301 \222\211E\62\261D&\225\10\345\42\0b@.\17B\7[*\267y\226\12\246\202\3E\60\223"
- "\30\14\42\231D&\224IdB\3E&\224\312\204R\231\252P&\25\212\244\352b\21\0b\311-\17"
- "B\7O*\30\313\305r\331\201bp\23O\344B\222TF\223J(B\231T(\223\12eR\241H"
- ",\27J$\6\7\221\60\0c\242.\17B\7K<\62\270\211\344\62\221\212Hb \311\244\62\251P"
- ",\227\10\345\24\203\213Y.\65\13%\252\62\221\242\204&\263\210\325\245\0c\245/\17B\7O(\231"
- "\12F\6\3Qv\260\10\245B\221Xbp\220I\5E\71\305\340E(\223\312\204R\241H,\245J"
- "d$\242\210,\1e\66\60\16F\7O(\30JEB\251H&\26\311\14\6\222\242HEM\244\246"
- "\244\246$!Jd\24\241D&\222\312\205\22\261LU$\25J\344\2eE.\17B\7O*\230\12"
- "\246\202\241\330`\220\30\14\62E\251H\42\223\12e\62\3I\246\213P\246\42\224\11\245\62\25\241\201$"
- "\323\42\225+ep\62\17B\7S\252\244Y\242&\230\32<Hd*J\62\221\26\231D\246\42\22\212"
- "%\42\203A&\21\312\204:\222\204\22)U\42\244\310T\210\22\251\0e\207\37\17B\7[\36\20\317"
- "\15\276\311\305rU\301T\62\223M\244+\262\231d*\246\223h\5e\234\64\17B\7S.\26\212\244"
- "\22\241D(S\221I\205\42\211\201\244,\225\210\245\22\231\301 \64\12\15B\211\252P\42\22\312D\212"
- "\42\231\134(\221K\5#\0e\257\66\17B\7K&\232\211E\6\203\304 \224\211\344\62\221\334@\222"
- "\313D\6\223L\244h )\312D\212\62\221\222\301@\21\311e\42\241L\42S\245\211\304B\21\0e"
- "\271\37\17B\7[\36\20\317\15\276\212\227\17\6\301T\60\25L\345b\271X]\252\42\225K\1e\345"
- "\22\351M\7\303\203\234w\203\3\235\357\6\7\272\0e\366+\16F\7o:\62\220E\62\261H&\61"
- "\270\211E\62\261\310@\26\311D\62\221LIMIM,\62\220E\62\261l\42\234\1f\16+\355E"
- "\7\337\340@\22\322DB\232HH\23\31\34HB\232HH\23\11i\42\203\3IH\23\11\305R\261"
- "TQ\42\24K\0f\37\36\315\305\7\313\340(\27\32\34\345B\203\303\232\340\340 \22\212\245\202\203\303"
- "pl\360 f%(\17B\7_<\70x\20L\16\16\204\301\301G\251\134Ub\60HD$\251\210"
- "(\25\34\14\202\251`*\70\30\204\0f\221(\17B\7\317\340,\27\33\234\345b\203\313\354`\220H"
- "fB\203\317\264\203\201j\226\221\14\6\272Xn\60\320\305\62\0g\10$\14J\7\317\340&\227\311e"
- "r\231\134fp\223\313\344\62\271\314\340&\227\311E\202\221`\42\227P&\0g\37;\16B\7K&"
- "\231\211\14\24\203A\42\23\311D\62\221L$\23\31H\6\222L$\23\311D\62\221\201$\23\311D\6"
- "\222L$\63\270\310\244\42\241H&\21J\244\62\11U\5\0g*\35\17B\7_\274rp\240\214\327"
- "\15>\333&*#u\231\252P\211*\245\213\347\0g:-\17B\7O<\63\220e\312\62\65\203E"
- "&\226\251\322TM\62\241D\233P\242MI\246,S\222i\222\211\204\42\231Hj\223H\2g\317*"
- "\16B\7O\254\253\134f\360 \221\312TE\64\251\310$\225h\61\30$\272\222dR\231\252LU\246"
- "*\223\31\14\62U\1j*\60\17B\7O\263LYd\60P\14\26\231X\246,\61\70\210\250r\213"
- "\301 \223HHj\22\221\301 \322\253\310`\220\212g\312\42\251\212\134\2k!*\17B\7c.\26"
- "L\5S\203a\252$\24KD\202\211L\60\225Z%b\251D,\224I\205\62\251L*\24\311\245\222"
- "\1k'.\16F\7cj\60I\345R\231\314@!)J\64\311D:\212\244B\211\242\212\232DF"
- "\222Idr\211L,\23\31,\62\301T,\27kc\35\317\301\7\307\340A\60\336\64\23\315\14V\231"
- "h&\232\211f\242\231h&\67\370\0k\317%\17B\7O|p\240\211\247\23\203\233H.\26\11\305"
- "\62\65\203O\202\251L(\25\312\244\6\217\263\211t\12k\322$\17B\7_rp\240\214\16N\203\203"
- "\7y\320\340,\22\212ej\6\237dB\251P&\65x\34\26\1k\324%\355\311\7[U,\25K"
- "\205\22\251L$\25\311\14\24E)UY*\226\212\245R\22Ej\220I\311\6\3k\353'\17B\7"
- "_p\360 \17\32\234\345b\203{\320\340\201\42,\33(\62\3\371`\65\220\17\6\211\304`\227\33\14"
- "\4l\24\33\17B\7O<=x\223\216\14\6\232<bp\20\357= \21N\244\345\1l\64$\17"
- "B\7_\274Q\62\224\31($\301\204\42\30I$#\211`&\222\313T\205jR\251Y\70\221\16\2"
- "l`\61\357\301\7g.\26\214\24F*$\251\210\42\23JH\62\211\210\42\222\32D\252\42\215\62\221"
- "\222M$!\312DB\221L.\222\311EB\203\201\0l\325'\17B\7g.\26L\5SE\203\223"
- "\134,\27L\5\7Ob\251U\60\224\314\204R\221X(\61\70\210\345\22\0l\363\60\17B\7cY"
- "\60\226\213\14R\301L$\227\211D\6\211H*\223(\313$d\241\204h\23I\244\42\231H(\21\312"
- "dT\241H(\221\216\1mA+\17B\7cY\60\61\70\310\204b\65\241\252Lfp\224\14\245\63"
- "\221\222M\244(\23)\312D\212\62\221\212HM$\21\252\21mK\61\16B\7w$\62\320TdZ"
- "d\22\11Q\242\67\211\336$\272I\364&\321\223\212\26\203H\242\223P*\222I\204\42\231H&R\225"
- "\10\345\22\0mS-\17B\7g.\26L\5\23\203\213P$\24\251i\225\10f\22\231PD\21\11"
- "E\22\21\315\42R\26\312\244B]d\212T\271\34\0m\262\63\17B\7cY\60\61\70\310\224\204b"
- "\221T(\63\210\204\42\231PB\42\11E\22\221D&\243\210D\66\221\242LF\225)\313D\22\251L"
- "\42\23T\11m\361*\357A\7Kdp\224\310\205\22\221D$\21\313\204\252\62\271`*\230\30\334\304"
- "Rg\241DU&R\224\320d$\261x\12n\5/\17B\7K,\230\12&\6\247\251\324`\220\311"
- "\305\42\203\3Q:\62\30\244\42\251\222\301 \262I\205\62\203A(\223\12e*\202\241\14\0n)\60"
- "\317\301\7Kf\60HER%\251Hj\60\310\204R\231P\252d\60H\245#\203\213IE$\23\251"
- "\210d\42\25\221L\244\42\222I\14\16\4n\177\60\317\301\7Kd\60P%b\251D,\22\32\14\64"
- "e\231\262Tb\60Pe\42\261P$\264\210\264\211$\42\211PF\242\12Eb\211\301\201\0n\341/"
- "\17B\7_\250\253\304\340 S\24\311\3\62\203\203D,\22\13Eb\211\301A\244\223A\244/\22\212"
- "\222\210$#)\214\224%R\271\4\0po(\17B\7O\274dp\23K%\212R\11UE,\24"
- "\211\345b\271X.V\221\212EB\251L(\25K\204\202)\0q&)\16B\7S$\232\11\16\16"
- "\64\241\234(\226\30\34$\42\241`(\70\70\10\25\206\202\203\3M\66\222)\311\324\210\62\5q\66/"
- "\17B\7O,\27K\244\6\231H\246\231dp\21IdB\211H&\21Kd\22\271LU(\23\252"
- "\212\204ryD$\323\27\241L\5\0qg\62\356A\7\307@\61\30$\62-\62-\62-\62\221\212"
- "\304@\21\212d\42\203E&\22Jd\42\241D&\22J\14$\203= \222)\311\324\210\62\5rG"
- "!\15F\7c,\25K\305R\261Tlp \11\27\17\6\252X*\226\212\205r\241\134&\230\1r"
- "[\31\17B\7_\64\23\315D\63\321\301A\250\60\25\257\33|\27\357\35\0ry/\17B\7O,"
- "\27K%b\251Df\60\210\14D\251D,\24\211\14n\202\251Yd\220\31\14\24\205\251P&U\222"
- "\12\246b\211T.\3s\207!\17B\7[\36\20\34<\310%\63]\14\64\251LU&R\23\31\14"
- "\42\331\272\301w\361v\0s\257%\317A\7\303\305`\240\311\305r\261\272Xj\240Q\244B\211H("
- "\23\311\224d\232\345F\241]*\30\17\1t\6,\317\301\7\337`\220\30,\42E\231HQf\60\10"
- "e\42E\231H\311@\61\30\204b\271X.\63\30\204b\271Qh\227\12\15\16t\346\37\317\301\7\303"
- "\257\342\345\203a*\230\310\4#\205\221\302T.\226)\221d\62\243L\335 u\65%\15J\7W\270"
- "np \11\225\204JB%\203\3I\250$T\22*\31\34HB\25\251X*\26\33\14\2v}\24"
- "\13J\7W\262n\360\322\345\340A\322\313\301\203d\0v~!\357A\7\303\357\322\265\203\3Q\62\224"
- "\14%C\203\3Q\62\224\14%C\311\320\340@\224\214\0v\256&\17B\7c\274p\360&\25\312\244"
- "\62\241T\60\61\30\250\42\251\222TMY(\221K\345R\211X\306&\242\33x\1.\357A\7\337`"
- "\62\230\245\202\251P&\224\312\204\6\221LF\22\31\14\22\222\240\42\22\214\24F*\6\213\310 \30)"
- "\214\4\23\351\10\0y\313\61\17B\7S\341&\65H\5S\301L\42\223\30,jB\231D$$\251"
- "H\215b\211\222D*Q\222\10EB\221X\246,\23JEb\241D\60y\315#\16B\7S*\66"
- "\312\14b\335\14\36$\42\65%%\232H\311\244E\213\301 \321ID\22\353\337\0y\322.\17B\7"
- "S*\67\12\15b\271P\242*\224\210$\6\223D\246I&\242\211\304\26\231HEQ\244\242(\21)"
- "L\345bu!aD\7y\357/\17B\7Wz\71\310\14V\231P*\23J\14\216R\231PH\23"
- "\12M\6\233D\243L\242\62\22\212\324\204\62\251L(\225I\205\42\261\0y\373,\17B\7S*\67"
- "\12\15R\3Q\67\211Hd\60\222\225\251\42\241\211$\224(\32(\332\204$\31E$\224S\345b)"
- "]F\6z\13\60\357A\7\223b\60H\14\62\251P&\25\312\244\22\203\305`\20J\217\25\211\301 "
- "\222(J%b\241Hf\60\10\305r\261\134,\227\30\34\4z\15\60\16B\7S*\266\210D\6\242"
- "D$\23J\24\305\62\203\305`\220\251\212hR\221\203A\242\253DW\222\314`\220\251\312TeZd"
- "\212\22\0zz\35\357\301\7[\36\20\34<P\204\65\251H(\227J\346Q\203\323x\207\203\7\11\0"
- "z\227.\17B\7[\36\20\34<PDR\31IQ\42\226\35\34\210\62\251Pf\20\11E\62\221P"
- "\242M\250\233D&\24\211\205\6\7\242d\4z\313\34\357\301\7[\36\20\317\3\7\17\362\340X\256*"
- "\230Jf\242\231h$\17\33|z\326,\357\301\7S\66\222\30\14\62\221D*\23\251\11E\62\211T"
- "$\24\213d\22\242HB\244J\344\1\311\301\201\36\226JfR\203\17{I&\17B\7K,\67X"
- "\14\26\221L$\23J\204\222\311\301\201\62\236\33|\17M\15\36\244*C\311H\42\235\2|s$\17"
- "B\7_\62T\225\11\305\42\231\134\244\66\70x\220\333&J\23\225\221\272LU\250D\225\322\305s\0"
- "|\373\42\15F\7\337@\62\230fS\255\6\203lT\24\322%\6\17b\251L\244*\323\250\42\223H"
- "\325\1}/(\354E\7\307\340@\21\252\30\34(B\25\203\3U\64\24\32\14\222BQdp \13"
- "E\62\221L$\221I\204R\1~\252*\357\301\7O<\235\31\14B\311L$\27\31\4S\301Pf"
- "\60\310\204R\221\201\42\31\212\347\62\212\334 \223K\244\6\3\1~\254-\17B\7O,\27\253\213E"
- "\22\203\201\42\23\12\15T\271\320`\223K\5C\203\305`\240\10f\242\231\314(\221\30\344\42\205\361\20"
- "\0~\263/\17B\7O,\27\253\213\345R\221\304\340A$\323$S\222i\21\212$\42\203E\244\242"
- "(\221I\304d\31En\220\311%B\251D\254\2~\317(\357\301\7O<\63\30d\222\241H*\224"
- "\11i\6\242H*T\223\221%\322\203\305`\20\11\306s\243\320.\25\32\34~\334.\17B\7O("
- "\31\12\246\6\242\66\221\204&\63\230$r\251\134*\221\252\221\14\24\61E&\61X\206R\222PdT"
- "\223\32,C\21\0~\337/\17B\7O*\30\253\213e\6\27\221Pj\240\251\312\244\62\231\301E,"
- "\22\31l\42\241X$\33\211I\62\221A(\23I\204R\253$\0\177\26\61\16B\7O(\230\212e"
- "\6\3I&\226\210$b\203\305`\240\211$\63\301\320\340AB\321\221\242Ub\60\310,Z\14\42\211"
- "\236Tdr!\1\177Q-\355E\7\303\7Z\243\12E$\21IH\22\221DB\23\212hB\21I"
- "\42\222HH\22\221DB\21ID\22\243\224V\231\220&\0\200\63#\357A\7\307\340A(\27\313\305"
- "\6g\271X.\66\70\313\305r\261\330@\223\30(\62\3Y\274\15\0\201\363\31\317\301\7\307\340A."
- "]\225\253\32\34\310\223\361\344\340@\31\257\33|\202\71\63\17B\7S:\65\10\15$E\231H\221\244"
- "Q\242\244(\321fp\240\314D%\211\301&\321(\223h\224\251\10EB\211P\244\42\61X\204\42\241"
- "\4\0\202\202!\17B\7S*\230\12\15>J\5Sy\324\340a*\230\12\246\202\251`$\221\314D"
- "\343\205\0\202\222\32\357\301\7S*\230\12\15>J\5S\321< \67\370(\336\363\301A\2\202\257$"
- "\357\301\7S*\230\12\15>J\5S\321< \17\310\306B\221\134&\22Ld\202\242T\60\225\34l"
- "\0\202\261+\17B\7S*\230\12\15>J\345\201\231\262L$\26J\304D\262D(\26\311(#\211"
- "T&\21IeB\251Lj\260\311\2\203I\36\17B\7W&\232I\15\276\312\344\201\203\263\134lp"
- "\226\213\15Ns\203\357\342\355\0\206\360,\16B\7O(\30J\15\24\203U(\222\222H\42\203P$"
- "\221\251\350IJR\221\312\14\256\62U\231\252\301e(\62x\20\211\6\210L%\17B\7S<\62\30"
- "\204\322%\361tdp\42K%b\241H,\27\313\305r\261\134,\27J\344R)\0\211\177+\357A"
- "\7\303\257\62\321L\64\223\33\34\210\42\231H(\222\211\204\42\231H(\222\211\204\22\251\221\60\224\14%"
- "C\203\3Q\62\2\211\322)\15B\7S\70;\30\210r\231\134&\61\70\220\204JB%\203\3I\250"
- "$T\62\70\220\204*R\241D*\222\220&\0\211\343\64\17B\7O<\64\330\14B\221L$\24i"
- "\224h\61PdB\211\242T\242$\221\32H\6\232D\223T\242(\65P\14\6\221DQI\42\324M"
- "H\224\1\213\241#\17B\7g.\26L\5S\361\252Abp\220I\5S\301T\60\25L\5\23\231"
- "\240(\230\212\247\0\213\357*\357A\7Gh\60\10eR\241L*\70\30\344!\7\67\261\134,\227\30"
- "\34Hb\271T\42\226\310$b\232\252L*\227\23\213\367.\17B\7g,W\62\270\211e\7\203l"
- "j\62\70\210\304\63\203A(\223\12e\6\203P&\25J$\6\203\220$\25\312T\4C\31\0\214\67"
- "$\17B\7S*\30\253\11\265\212\204\22\331L\62\25\323I\264\232\301Y.\226\213\345b\271\330\340,"
- "\227\1\215%\61\17B\7gl\240\211e\312\22%\271D\311`\220\350(\223H(\62\25%\231\212\222"
- "LEM\42\224\250I\304Z\204\22\251HM\213T\42\225\13\215k\63\17B\7S*\230\12\246R\203"
- "\305@\226\12\246B\203Ab\60\310$\62\211X\42\223\10%\22n\22\375$\221ID\332$R\221F"
- "\211\222\232\222\210\6\215u.\17B\7S<\230\312\204\42\203I&U\21K%\42\203A(\27K%"
- "R\211P\42\225\10%&\231\212L(\223\310&\264\221\301s\0\215\363\67\17B\7g\42\64\320$B"
- "\231\212P&\321$\221\211(J\6\232\204\252\42\226J\250B\212\222\304\242I\242*\21J\244\22\241D"
- "(R\221\230\224\14B\231H,\65\217f\33\17B\7[\274r\360 \226\216D\63\311Prp\240\214"
- "\347\6\337\305\333\1\217\320#\317\301\7Kf\60H\305\363\24\203\213A*\30Jf\312\42\251\212\301Q"
- "$\26J'\262\231\301A\0\217\333,\357\301\7c$U\22\13Eb\221\301@\31\311F\62\203P$"
- "\226\30\34dB\221X(\22\313\224e\312\42\241T\42\233\31\34\4\220\0/\357\301\7\333`\20\312\244"
- "JR%\203A\60\25LE\6\221\301 \25\251\11E\62\211T$\24\213$\62\251\210*\24\211e\22"
- "\331\314\340 \220\1+\20B\7[.\222*\22eb\271\350\340\66\65\210\5c\301\304\340@\23\13\246"
- "\22\271P&\226I\205\22u\221LR\65\70\10\220\37)\357\301\7g.\26L\14\216R\331\301 \30"
- ")\31DZE\6\203Th\227I\224EZ%\62E\251\134\42\233\31\34\4\221\315\37\357\301\7ov"
- " \32\314s\203\357\242\203\263L\331\340,S\66\70M\16\16\224\271\301\7\221\317\42\357A\7\317\340,"
- "\27\33\234\345\62\203\357\61\203\263L\331\340,S\66\70\215\16N\203\203\7\11\0\224\237*\16B\7O"
- "\254\325 \224\312\205R\203\201b\220\210\324\224\324\224D\6\203D\244&\63\30dJjb\25\241\230*"
- "V\235\1\225\177\42\17B\7S<\226K\5C\311L\64\222\215\16>J\204#\331L\64\224\214\24&"
- "B\62\235(\12\225\350\22\15F\7G:\62\30H\222Z\377\227\11i\2\225\364%\15F\7G:\62"
- "\30H\222Z\315@\243\251\321\324hj\64\3\215\246FS\243\251\321\14\64ZeB\232\0\226\63*\355"
- "E\7\303@\230I\14\6\222*I\225\42\223\222TI\252\64\211\301@\223Hi\22\251E$\245\310\244"
- "T)\325`\240*\226;\62\356E\7\303@\61\230d\22\241H\243H\243H\42\63\230\64\212\64\212d"
- "\22\241H&\61\230d\22\241\210\42\22\212$\62\241H*\24\311\14\16\324\0\226M\61\16F\7_l"
- " \211e\42\203E\244(RQ\222I\244D\221\210Id\23\331\204j\22\203A\42\23\12)jB\211"
- "\310\340 \30\12\206\202!\0\226\234\67\16F\7gh\240\30\14\22\231H&R\224\310D\22\203\203D"
- "\66\22\31\14\22\221\252D&\61\30$\62\211T\42\223\30\14\22\212T(\21\31\34\4C\301P\60\4"
- "\226\350&\357A\7\303\357\342\205\203\7\221TI\252\244E&\222IDZ\225\264\310D\62\211H\253\222"
- "T&\21\211F\0\226\352$\17B\7\313\340@\31\34<P\244b\222Eb\21\214.\22{\324\340@"
- "^\65\70\210\27\15\16\344\21\0\226\366(\17B\7\313\340@\31\34<P\244b\222Eb\21\214.\22"
- "\313DT#\223\204$\252\224f\60\220'%a= \5\226\367$\357A\7\313\340@\31\34<P\244"
- "b\222Eb\21\214.\22{\324\340@\324G\203\3Q\37\15\16$\0\227\15,\17B\7\313\340@\31"
- "\34<P\244b\222Eb\21\214.\22\273Lrp\240\21\345\22\203\203HQrp\220\12%\7\7\242"
- ",\0\227\34\60\17B\7\313\340@\31\34<P\244b\222Eb\21\214.\22{\134f\60\31,B!"
- "\315`\223\220\204\42\25\211\301\42S\224\312\14V\231P\2\227\62\60\17B\7\313\340@\31\34<P\244"
- "b\222Eb\21\214.\22\343\330@\62\320T\224d\6\42Yf\262HL\23\241\201&\61\311DV\3"
- "\11\0\230\177\61\17B\7O<\63\30hb\241\301 \22\314\14\6\221D\253H\242I\213&-\232\224"
- "\14\24\221\242L\244(\223\310\204\22\231DLS\225I\345\12\230\316\60\357A\7\313\340 \25L\5S"
- "\211P\42\25\311$R\231D$\225IDR\241L*\224Ie\22\221T&\21\351&\222(\11E\22"
- "\265\353\0\232\330(\17B\7[\36\220\33|\17\32\14\202\251`*\70\30\344Q\203\7\221l$\62\30"
- "DZEZEJ\6\203H\251\2\377\1\13Ba\10\303\7\222A\0\377\14\14\204X\7\303 \42\31"
- "D\0\377\32\13\344\330\10\303\201x\60\20\377\33\16$\331\7\303\201x\20\221\14\42\0\377\37\23LI"
- "\10\313` \21\16\202R\241\251\36'\25\1\0";
+ "\27\313\305r\261\301=f\360Q:>\70o\233H\247\0T\14\42\354I\7\303\7Q\213\301@!\65"
+ "\31L$\241\210$\24\221\204\42\222\301D\22\212H\205\11e\2T\16#\17B\7ov\240\32H\343"
+ "\361\301\233x\213\301@\225\210\205\42\261P$\226)\213\204\6\3],\2T\21\37\15F\7W\266r"
+ "\360@k\63\320hj\64\65\232\32M\215f\240\321\324h\225\11i\2T+#\17B\7_<\235\310"
+ "f\222\211LL\223\221\250R\242\301 ]\71\70\313\305r\261\134lp\226\313\0T/!\16B\7_"
+ "<\70\70\320$\63\311L\62\63\70\320\244[\14N\352\42u\211LN\64\270\312\5Vh,\357A\7"
+ "\313@\62\320\224d\232d\62\3\311@\30\311f\62\203\317\22Q\215L'\321J\6\222\201\246$\323$"
+ "\223\31H\6\12\0V\333\35\255\305\7\303\7\232\32M\215\246FS\243\251\221\204\62\222\324@\221\234j"
+ "\7\337\6V\355%\355E\7\303\7Z\311`\20\321Z\14.\64\221\220&\22\322DB\222L$!\311"
+ "D\22\212\324B;\370\66W\37\20\357\301\7_\274\227\203\3e\274\357\6\37Wj'\17B\7O<"
+ "\63\30\204b\271X.\23\251\30L\22\221PEU,\27\31\334\304r\261\334(\264K\5\343E\0W"
+ "\371(\17B\7O*\30\313e\6\203P<\23\212\14&e\361\310\340&^\63\30\204\26\251\304(\25"
+ "I\25\16\6\301T\2X\344.\17B\7K,\27\31\334\304\63\213\311 \222h\224Y\214jR\221\301"
+ "M(\223\212\14n\64\65\213\301\201\42\25I\4\65\71EIR$Y\4.\17B\7O*\230\12\246"
+ "\202\203H\60\22\221e\42\211T&R\223\210\324$\42\211LQ\42\223\14%C\301D&\227\21\306\6"
+ "\3\71\0Y\17!\17B\7\307\340A.;\70\313\305\6g\271\330\340,\27\33\334\245\7W\211TM"
+ "\355rs\71Y\26'\16B\7O*\227\312\245r\251\330@\22\313DD%\211L(RQ\222i\221"
+ ")*\14\345R\261\252\134(\30\2Y'\32\17B\7_\274\273\301w\361t\42\234\310f\242\231d*"
+ "W\225\214h\5Y)\34\357A\7\313\340@\31o\67\370.\235\10'\262\231h&\231\312U%#Z"
+ "\1Y*\34\17B\7_\274\273\301w\361t\42\234\310f\242\231d\42\223\313T\205J\264\2Y\61!"
+ "\17B\7_\64\23\315D\63\321\301A\250\60\25\317\15\276K'\302\211l&\231\312\25)\25\0Y\306"
+ "\60\17B\7O<\64\30\365\42\222\30L*\62\221\242L\244(\23\31\34D*R\221\26\231\212H\243"
+ "L*\223\210\14\6\212L.\21\252Hg\0[W\32\17B\7[\36\20\34<P\204\305\241\301@\335"
+ "n\360]\274q\42\35\4[\211\42\17B\7[\36\220\34\274\211FB\251`<\70\370*\24L\345D"
+ "QIX\34\21\252B\303\10\0[\242#\17B\7[\36\20\34<P\204\65\301\324` k\241\311."
+ "\67\227\233\301Y.\226\213\15\316r\31\0[\244\37\357\301\7[\36\20\34<P\204\305\231\301\201.\235"
+ "\312\15N\63\321\344\340@\31\317\15>[\266(\17B\7[\36\20\34<P\204\305\221\301\203\134X\21"
+ "\312l$\311D\241D\266Q$\25\21\225&\64\320$\322\71\0[\275(\17B\7[\36\20\34<P"
+ "\204E\231\232\301\201.\223\7\16\316r\261LY\246,\222\210\4#\251\214&\65\210\15\6[\322(\17"
+ "B\7[\36\20\34<Pd\212$\203\213X&\67\70\320eR\203\217R\271\210&U\23\321eTz"
+ "\200\36\220\2\134\17\36\17B\7_\274\323LY&\224\312\244\62\241T&\24K\244b\262\272x\70\221"
+ "\16\2\134\24 \17B\7S\274zp JfB\65\251\134,\36\315\224eB\255\42\251\230\254*\221"
+ "\16\2\134\32!\13J\7WQE\246I]j\360\322d \221d\42\222LD\222\211H\6\22\245."
+ "!L\0]\346\32\357\301\7[\274p\360U\274:>\270\12%C\301T.V\27\34<\10]\356\42"
+ "\17B\7S*\231\211\15\36\4\343\311\301\201\60\36\34|\225\256\30\14D\251\134\254.\71\70P\0]"
+ "\362\27\314\311\7\303\203l\223`$\30\31\34D\262MM\23\203\3\1^\25-\15F\7K,\25K"
+ "\25\15\24\203\201\242\225\242\225\242\225\242\225\242b\60P\264R\264R,R\221L*\222IE\62\203A"
+ "$\223\12^\70&\17B\7_\64S\27\251\32<P\204\65\203A$U\230\12\16\6\331\350\340,S"
+ "\226)\313$\312\62\221l\16^s\30\357A\7\307\340A\60\36\315\324E\62\271Hmn\360]\274\357"
+ "\0^t\36\17B\7O<>\70\320\244\202\251\134,\71\70H\205\222\241d(\66\370\60\336\31\0^"
+ "\217&\17B\7_\36\20\34<\210\304\63\203A(\230\252\210\325%\6\7\222X(\22\313\224\325\305r"
+ "\251X\42\35\3^\223%\17B\7_\36\20\34<\210\204\222\241\344\340Mi\244\60\221\11&\6G\251"
+ "`*\227\30\274\210\325\305c\0^\246'\17B\7_\36\20\34<\210d\312\62e\203\67\315\62e\231"
+ "\201,\236\30\14T\221T\250&\225Z\205\64\252\335\0^\255.\17B\7_\36\20\34<\210\304\23\253"
+ "I&\61HER%\251\212\203A$\23JeB\251D\305`\220\310D\63\302Ld\60\320d\1_"
+ "\0\42\357A\7\307\340A\252\60\25L\5S\301Th\360Q*\230\12\246\202\251\134,\27\253K\5C"
+ "\0_\2#\357A\7\313\340 \25L\5S\203\203T\64\23\15\15\16\364\250\302Th\360Q*\27\253"
+ "K\5C\0_'\64\17B\7sd\240\32\244\22\203D.Q\222K\224\204\6\211\222PE$T\21"
+ "\11UDB\203DM,Q\23K$$\261D\223\224DQ\222(\351\42\12_\61-\355E\7\303\305"
+ "`\25K\305\6\203\304`\20K\305R\203\305`\221\211d\42\65\221\220J\242\310(\66\11M*\26I"
+ "\204\22\241X\4_:\62\360A\7\303@\62\30\304\42\251X$\225\31D\6\203L\60\225\32\134\244\62"
+ "\25\3E\246*\221\251J\14\256*S\221X*\223\210\304\6\13\315 \25_f#\16B\7[<\70"
+ "\70P\25fb\203'\351\134*\64K\214\312T!M\305(\223\23\205V\221!\0_\205+\17B\7"
+ "Se(\230\312e\6\3IQ\62\24L\14\16\42\272P\42\227\211$\6\7\231\134,\22\212e\312\62"
+ "e\251D\254\10_\252=\17B\7Ol\20J\14f\221P*\23*I\14\16\62\211P,\222\30\14"
+ "\42\222D*Q\222He\42\211\301 \23I\244\62\221\304`\220IDR\231D$\225\321\14\6\231P"
+ "*\1_\256\70\17B\7OQ*\321$\24I\224d*\332D\22\3\305 \23\213d\202\211\210b\260"
+ "\350\60\221\211\14\42\211L\244E&RQ\24\211HB\221\26\231D,\221\221e\2_\303#\317\301\7"
+ "[\36\220\7\304\263\361X(\222\313Dr\231H\60\221\11&\62\251\210(\25L%\7\33\0`\312\61"
+ "\17B\7O*\30\313E\6\67qm\242b\60\210$\62\251H\42\223JD\62\203A(\226\313D\22"
+ "\251L\244(\222i\21\312\24%r\251\24\0a\37\63\17B\7k\42\34\311\14\36Dr\261\304@\21"
+ "\311\344\42\231\304@Q\224\310DD\211L\244\42\62Pt\227\331\245r\301H&\24)\213\210\6\203H"
+ "\0b\20*\17B\7g\42\34\311\346\6\17\42\261\134,\27\313d\6\222L\223L\27\241LE(\23"
+ "\212T\324H\22\231\222DYhVb\67\35\14F\7W\70\233\33\34D\202\221`$\30\11F\6\7"
+ "\221`$[\232\215f\1b\77(\16B\7[<\70x\22\215D#\203'\241`*\67x\222If"
+ "\222\231\301 \222\211E\62\261D&\225\10\345\42\0b@.\17B\7[*\267y\226\12\246\202\3E"
+ "\60\223\30\14\42\231D&\224IdB\3E&\224\312\204R\231\252P&\25\212\244\352b\21\0b\311"
+ "-\17B\7O*\30\313\305r\331\201bp\23O\344B\222TF\223J(B\231T(\223\12eR"
+ "\241H,\27J$\6\7\221\60\0cn\71\20B\7Of\60\20eb\241L,\61\30\310B\231\301"
+ "@\24\321\344\22\65\71\311\340\246\231\246*\221\31\14\24\221\212T(\222H\205\22\221T$Q\222\312$"
+ "\62\203A\2c\242.\17B\7K<\62\270\211\344\62\221\212Hb \311\244\62\251P,\227\10\345\24"
+ "\203\213Y.\65\13%\252\62\221\242\204&\263\210\325\245\0c\245/\17B\7O(\231\12F\6\3Q"
+ "v\260\10\245B\221Xbp\220I\5E\71\305\340E(\223\312\204R\241H,\245Jd$\242\210,"
+ "\1e\66\60\16F\7O(\30JEB\251H&\26\311\14\6\222\242HEM\244\246\244\246$!J"
+ "d\24\241D&\222\312\205\22\261LU$\25J\344\2eE.\17B\7O*\230\12\246\202\241\330`"
+ "\220\30\14\62E\251H\42\223\12e\62\3I\246\213P\246\42\224\11\245\62\25\241\201$\323\42\225+e"
+ "p\62\17B\7S\252\244Y\242&\230\32<Hd*J\62\221\26\231D\246\42\22\212%\42\203A&"
+ "\21\312\204:\222\204\22)U\42\244\310T\210\22\251\0e\207\37\17B\7[\36\20\317\15\276\311\305r"
+ "U\301T\62\223M\244+\262\231d*\246\223h\5e\234\64\17B\7S.\26\212\244\22\241D(S"
+ "\221I\205\42\211\201\244,\225\210\245\22\231\301 \64\12\15B\211\252P\42\22\312D\212\42\231\134(\221"
+ "K\5#\0e\257\66\17B\7K&\232\211E\6\203\304 \224\211\344\62\221\334@\222\313D\6\223L"
+ "\244h )\312D\212\62\221\222\301@\21\311e\42\241L\42S\245\211\304B\21\0e\271\37\17B\7"
+ "[\36\20\317\15\276\212\227\17\6\301T\60\25L\345b\271X]\252\42\225K\1e\345\22\351M\7\303"
+ "\203\234w\203\3\235\357\6\7\272\0e\366+\16F\7o:\62\220E\62\261H&\61\270\211E\62\261"
+ "\310@\26\311D\62\221LIMIM,\62\220E\62\261l\42\234\1f\16+\355E\7\337\340@\22"
+ "\322DB\232HH\23\31\34HB\232HH\23\11i\42\203\3IH\23\11\305R\261TQ\42\24K"
+ "\0f\37\36\315\305\7\313\340(\27\32\34\345B\203\303\232\340\340 \22\212\245\202\203\303pl\360 f"
+ "%(\17B\7_<\70x\20L\16\16\204\301\301G\251\134Ub\60HD$\251\210(\25\34\14\202"
+ "\251`*\70\30\204\0f\221(\17B\7\317\340,\27\33\234\345b\203\313\354`\220HfB\203\317\264"
+ "\203\201j\226\221\14\6\272Xn\60\320\305\62\0g\10$\14J\7\317\340&\227\311er\231\134fp"
+ "\223\313\344\62\271\314\340&\227\311E\202\221`\42\227P&\0g\37;\16B\7K&\231\211\14\24\203"
+ "A\42\23\311D\62\221L$\23\31H\6\222L$\23\311D\62\221\201$\23\311D\6\222L$\63\270"
+ "\310\244\42\241H&\21J\244\62\11U\5\0g*\35\17B\7_\274rp\240\214\327\15>\333&*"
+ "#u\231\252P\211*\245\213\347\0g:-\17B\7O<\63\220e\312\62\65\203E&\226\251\322T"
+ "M\62\241D\233P\242MI\246,S\222i\222\211\204\42\231Hj\223H\2g\317*\16B\7O\254"
+ "\253\134f\360 \221\312TE\64\251\310$\225h\61\30$\272\222dR\231\252LU\246*\223\31\14\62"
+ "U\1j*\60\17B\7O\263LYd\60P\14\26\231X\246,\61\70\210\250r\213\301 \223HH"
+ "j\22\221\301 \322\253\310`\220\212g\312\42\251\212\134\2k!*\17B\7c.\26L\5S\203a"
+ "\252$\24KD\202\211L\60\225Z%b\251D,\224I\205\62\251L*\24\311\245\222\1k'.\16"
+ "F\7cj\60I\345R\231\314@!)J\64\311D:\212\244B\211\242\212\232DF\222Idr\211"
+ "L,\23\31,\62\301T,\27kc\35\317\301\7\307\340A\60\336\64\23\315\14V\231h&\232\211f"
+ "\242\231h&\67\370\0ke!\17B\7_<\232\31\254\62\321L\64\223\33|\27\217fB\251LU"
+ "(\222\212i\245\313\61\0k\317%\17B\7O|p\240\211\247\23\203\233H.\26\11\305\62\65\203O"
+ "\202\251L(\25\312\244\6\217\263\211t\12k\322$\17B\7_rp\240\214\16N\203\203\7y\320\340"
+ ",\22\212ej\6\237dB\251P&\65x\34\26\1k\324%\355\311\7[U,\25K\205\22\251L"
+ "$\25\311\14\24E)UY*\226\212\245R\22Ej\220I\311\6\3k\353'\17B\7_p\360 "
+ "\17\32\234\345b\203{\320\340\201\42,\33(\62\3\371`\65\220\17\6\211\304`\227\33\14\4l\24\33"
+ "\17B\7O<=x\223\216\14\6\232<bp\20\357= \21N\244\345\1l\64$\17B\7_\274"
+ "Q\62\224\31($\301\204\42\30I$#\211`&\222\313T\205jR\251Y\70\221\16\2l`\61\357"
+ "\301\7g.\26\214\24F*$\251\210\42\23JH\62\211\210\42\222\32D\252\42\215\62\221\222M$!"
+ "\312DB\221L.\222\311EB\203\201\0l\325'\17B\7g.\26L\5SE\203\223\134,\27L"
+ "\5\7Ob\251U\60\224\314\204R\221X(\61\70\210\345\22\0l\363\60\17B\7cY\60\226\213\14"
+ "R\301L$\227\211D\6\211H*\223(\313$d\241\204h\23I\244\42\231H(\21\312dT\241H"
+ "(\221\216\1mA+\17B\7cY\60\61\70\310\204b\65\241\252Lfp\224\14\245\63\221\222M\244"
+ "(\23)\312D\212\62\221\212HM$\21\252\21mK\61\16B\7w$\62\320TdZd\22\11Q"
+ "\242\67\211\336$\272I\364&\321\223\212\26\203H\242\223P*\222I\204\42\231H&R\225\10\345\22\0"
+ "mS-\17B\7g.\26L\5\23\203\213P$\24\251i\225\10f\22\231PD\21\11E\22\21\315"
+ "\42R\26\312\244B]d\212T\271\34\0m\262\63\17B\7cY\60\61\70\310\224\204b\221T(\63"
+ "\210\204\42\231PB\42\11E\22\221D&\243\210D\66\221\242LF\225)\313D\22\251L\42\23T\11"
+ "m\361*\357A\7Kdp\224\310\205\22\221D$\21\313\204\252\62\271`*\230\30\334\304Rg\241D"
+ "U&R\224\320d$\261x\12n\5/\17B\7K,\230\12&\6\247\251\324`\220\311\305\42\203\3"
+ "Q:\62\30\244\42\251\222\301 \262I\205\62\203A(\223\12e*\202\241\14\0n)\60\317\301\7K"
+ "f\60HER%\251Hj\60\310\204R\231P\252d\60H\245#\203\213IE$\23\251\210d\42\25"
+ "\221L\244\42\222I\14\16\4n\177\60\317\301\7Kd\60P%b\251D,\22\32\14\64e\231\262T"
+ "b\60Pe\42\261P$\264\210\264\211$\42\211PF\242\12Eb\211\301\201\0n\341/\17B\7_"
+ "\250\253\304\340 S\24\311\3\62\203\203D,\22\13Eb\211\301A\244\223A\244/\22\212\222\210$#"
+ ")\214\224%R\271\4\0po(\17B\7O\274dp\23K%\212R\11UE,\24\211\345b\271"
+ "X.V\221\212EB\251L(\25K\204\202)\0q&)\16B\7S$\232\11\16\16\64\241\234("
+ "\226\30\34$\42\241`(\70\70\10\25\206\202\203\3M\66\222)\311\324\210\62\5q\66/\17B\7O"
+ ",\27K\244\6\231H\246\231dp\21IdB\211H&\21Kd\22\271LU(\23\252\212\204ry"
+ "D$\323\27\241L\5\0qg\62\356A\7\307@\61\30$\62-\62-\62-\62\221\212\304@\21\212"
+ "d\42\203E&\22Jd\42\241D&\22J\14$\203= \222)\311\324\210\62\5rG!\15F\7"
+ "c,\25K\305R\261Tlp \11\27\17\6\252X*\226\212\205r\241\134&\230\1r[\31\17B"
+ "\7_\64\23\315D\63\321\301A\250\60\25\257\33|\27\357\35\0ry/\17B\7O,\27K%b"
+ "\251Df\60\210\14D\251D,\24\211\14n\202\251Yd\220\31\14\24\205\251P&U\222\12\246b\211"
+ "T.\3s\207!\17B\7[\36\20\34<\310%\63]\14\64\251LU&R\23\31\14\42\331\272\301"
+ "w\361v\0s\257%\317A\7\303\305`\240\311\305r\261\272Xj\240Q\244B\211H(\23\311\224d"
+ "\232\345F\241]*\30\17\1t\6,\317\301\7\337`\220\30,\42E\231HQf\60\10e\42E\231"
+ "H\311@\61\30\204b\271X.\63\30\204b\271Qh\227\12\15\16t\346\37\317\301\7\303\257\342\345\203"
+ "a*\230\310\4#\205\221\302T.\226)\221d\62\243L\335 u\65%\15J\7W\270np \11"
+ "\225\204JB%\203\3I\250$T\22*\31\34HB\25\251X*\26\33\14\2v}\24\13J\7W"
+ "\262n\360\322\345\340A\322\313\301\203d\0v~!\357A\7\303\357\322\265\203\3Q\62\224\14%C\203"
+ "\3Q\62\224\14%C\311\320\340@\224\214\0v\256&\17B\7c\274p\360&\25\312\244\62\241T\60"
+ "\61\30\250\42\251\222TMY(\221K\345R\211X\306&\242\33x\1.\357A\7\337`\62\230\245\202"
+ "\251P&\224\312\204\6\221LF\22\31\14\22\222\240\42\22\214\24F*\6\213\310 \30)\214\4\23\351"
+ "\10\0y\313\61\17B\7S\341&\65H\5S\301L\42\223\30,jB\231D$$\251H\215b\211"
+ "\222D*Q\222\10EB\221X\246,\23JEb\241D\60y\315#\16B\7S*\66\312\14b\335"
+ "\14\36$\42\65%%\232H\311\244E\213\301 \321ID\22\353\337\0y\322.\17B\7S*\67\12"
+ "\15b\271P\242*\224\210$\6\223D\246I&\242\211\304\26\231HEQ\244\242(\21)L\345bu"
+ "!aD\7y\357/\17B\7Wz\71\310\14V\231P*\23J\14\216R\231PH\23\12M\6\233"
+ "D\243L\242\62\22\212\324\204\62\251L(\225I\205\42\261\0y\373,\17B\7S*\67\12\15R\3"
+ "Q\67\211Hd\60\222\225\251\42\241\211$\224(\32(\332\204$\31E$\224S\345b)]F\6z"
+ "\13\60\357A\7\223b\60H\14\62\251P&\25\312\244\22\203\305`\20J\217\25\211\301 \222(J%"
+ "b\241Hf\60\10\305r\261\134,\227\30\34\4z\15\60\16B\7S*\266\210D\6\242D$\23J"
+ "\24\305\62\203\305`\220\251\212hR\221\203A\242\253DW\222\314`\220\251\312TeZd\212\22\0z"
+ "z\35\357\301\7[\36\20\34<P\204\65\251H(\227J\346Q\203\323x\207\203\7\11\0z\227.\17"
+ "B\7[\36\20\34<PDR\31IQ\42\226\35\34\210\62\251Pf\20\11E\62\221P\242M\250\233"
+ "D&\24\211\205\6\7\242d\4z\313\34\357\301\7[\36\20\317\3\7\17\362\340X\256*\230Jf\242"
+ "\231h$\17\33|z\326,\357\301\7S\66\222\30\14\62\221D*\23\251\11E\62\211T$\24\213d"
+ "\22\242HB\244J\344\1\311\301\201\36\226JfR\203\17{I&\17B\7K,\67X\14\26\221L"
+ "$\23J\204\222\311\301\201\62\236\33|\17M\15\36\244*C\311H\42\235\2|s$\17B\7_\62"
+ "T\225\11\305\42\231\134\244\66\70x\220\333&J\23\225\221\272LU\250D\225\322\305s\0|\373\42\15"
+ "F\7\337@\62\230fS\255\6\203lT\24\322%\6\17b\251L\244*\323\250\42\223H\325\1}/"
+ "(\354E\7\307\340@\21\252\30\34(B\25\203\3U\64\24\32\14\222BQdp \13E\62\221L"
+ "$\221I\204R\1~\252*\357\301\7O<\235\31\14B\311L$\27\31\4S\301Pf\60\310\204R"
+ "\221\201\42\31\212\347\62\212\334 \223K\244\6\3\1~\254-\17B\7O,\27\253\213E\22\203\201\42"
+ "\23\12\15T\271\320`\223K\5C\203\305`\240\10f\242\231\314(\221\30\344\42\205\361\20\0~\263/"
+ "\17B\7O,\27\253\213\345R\221\304\340A$\323$S\222i\21\212$\42\203E\244\242(\221I\304"
+ "d\31En\220\311%B\251D\254\2~\317(\357\301\7O<\63\30d\222\241H*\224\11i\6\242"
+ "H*T\223\221%\322\203\305`\20\11\306s\243\320.\25\32\34~\334.\17B\7O(\31\12\246\6"
+ "\242\66\221\204&\63\230$r\251\134*\221\252\221\14\24\61E&\61X\206R\222PdT\223\32,C"
+ "\21\0~\337/\17B\7O*\30\253\213e\6\27\221Pj\240\251\312\244\62\231\301E,\22\31l\42"
+ "\241X$\33\211I\62\221A(\23I\204R\253$\0\177\26\61\16B\7O(\230\212e\6\3I&"
+ "\226\210$b\203\305`\240\211$\63\301\320\340AB\321\221\242Ub\60\310,Z\14\42\211\236Tdr"
+ "!\1\177Q-\355E\7\303\7Z\243\12E$\21IH\22\221DB\23\212hB\21I\42\222HH"
+ "\22\221DB\21ID\22\243\224V\231\220&\0\200\63#\357A\7\307\340A(\27\313\305\6g\271X"
+ ".\66\70\313\305r\261\330@\223\30(\62\3Y\274\15\0\201\363\31\317\301\7\307\340A.]\225\253\32"
+ "\34\310\223\361\344\340@\31\257\33|\202\71\63\17B\7S:\65\10\15$E\231H\221\244Q\242\244("
+ "\321fp\240\314D%\211\301&\321(\223h\224\251\10EB\211P\244\42\61X\204\42\241\4\0\202\202"
+ "!\17B\7S*\230\12\15>J\5Sy\324\340a*\230\12\246\202\251`$\221\314D\343\205\0\202"
+ "\222\32\357\301\7S*\230\12\15>J\5S\321< \67\370(\336\363\301A\2\202\257$\357\301\7S"
+ "*\230\12\15>J\5S\321< \17\310\306B\221\134&\22Ld\202\242T\60\225\34l\0\202\261+"
+ "\17B\7S*\230\12\15>J\345\201\231\262L$\26J\304D\262D(\26\311(#\211T&\21I"
+ "eB\251Lj\260\311\2\203I\36\17B\7W&\232I\15\276\312\344\201\203\263\134lp\226\213\15N"
+ "s\203\357\342\355\0\206\360,\16B\7O(\30J\15\24\203U(\222\222H\42\203P$\221\251\350I"
+ "JR\221\312\14\256\62U\231\252\301e(\62x\20\211\6\210L%\17B\7S<\62\30\204\322%\361"
+ "tdp\42K%b\241H,\27\313\305r\261\134,\27J\344R)\0\211\177+\357A\7\303\257\62"
+ "\321L\64\223\33\34\210\42\231H(\222\211\204\42\231H(\222\211\204\22\251\221\60\224\14%C\203\3Q"
+ "\62\2\211\322)\15B\7S\70;\30\210r\231\134&\61\70\220\204JB%\203\3I\250$T\62\70"
+ "\220\204*R\241D*\222\220&\0\211\343\64\17B\7O<\64\330\14B\221L$\24i\224h\61P"
+ "dB\211\242T\242$\221\32H\6\232D\223T\242(\65P\14\6\221DQI\42\324MH\224\1\213"
+ "\241#\17B\7g.\26L\5S\361\252Abp\220I\5S\301T\60\25L\5\23\231\240(\230\212"
+ "\247\0\213\357*\357A\7Gh\60\10eR\241L*\70\30\344!\7\67\261\134,\227\30\34Hb\271"
+ "T\42\226\310$b\232\252L*\227\23\213\367.\17B\7g,W\62\270\211e\7\203lj\62\70\210"
+ "\304\63\203A(\223\12e\6\203P&\25J$\6\203\220$\25\312T\4C\31\0\214\67$\17B\7"
+ "S*\30\253\11\265\212\204\22\331L\62\25\323I\264\232\301Y.\226\213\345b\271\330\340,\227\1\215%"
+ "\61\17B\7gl\240\211e\312\22%\271D\311`\220\350(\223H(\62\25%\231\212\222LEM\42"
+ "\224\250I\304Z\204\22\251HM\213T\42\225\13\215k\63\17B\7S*\230\12\246R\203\305@\226\12"
+ "\246B\203Ab\60\310$\62\211X\42\223\10%\22n\22\375$\221ID\332$R\221F\211\222\232\222"
+ "\210\6\215u.\17B\7S<\230\312\204\42\203I&U\21K%\42\203A(\27K%R\211P\42"
+ "\225\10%&\231\212L(\223\310&\264\221\301s\0\215\363\67\17B\7g\42\64\320$B\231\212P&"
+ "\321$\221\211(J\6\232\204\252\42\226J\250B\212\222\304\242I\242*\21J\244\22\241D(R\221\230"
+ "\224\14B\231H,\65\217f\33\17B\7[\274r\360 \226\216D\63\311Prp\240\214\347\6\337\305"
+ "\333\1\217\320#\317\301\7Kf\60H\305\363\24\203\213A*\30Jf\312\42\251\212\301Q$\26J'"
+ "\262\231\301A\0\217\333,\357\301\7c$U\22\13Eb\221\301@\31\311F\62\203P$\226\30\34d"
+ "B\221X(\22\313\224e\312\42\241T\42\233\31\34\4\220\0/\357\301\7\333`\20\312\244JR%\203"
+ "A\60\25LE\6\221\301 \25\251\11E\62\211T$\24\213$\62\251\210*\24\211e\22\331\314\340 "
+ "\220\1+\20B\7[.\222*\22eb\271\350\340\66\65\210\5c\301\304\340@\23\13\246\22\271P&"
+ "\226I\205\22u\221LR\65\70\10\220\37)\357\301\7g.\26L\14\216R\331\301 \30)\31DZ"
+ "E\6\203Th\227I\224EZ%\62E\251\134\42\233\31\34\4\221\315\37\357\301\7ov \32\314s"
+ "\203\357\242\203\263L\331\340,S\66\70M\16\16\224\271\301\7\221\317\42\357A\7\317\340,\27\33\234\345"
+ "\62\203\357\61\203\263L\331\340,S\66\70\215\16N\203\203\7\11\0\224\237*\16B\7O\254\325 \224"
+ "\312\205R\203\201b\220\210\324\224\324\224D\6\203D\244&\63\30dJjb\25\241\230*V\235\1\225"
+ "\177\42\17B\7S<\226K\5C\311L\64\222\215\16>J\204#\331L\64\224\214\24&B\62\235("
+ "\12\225\350\22\15F\7G:\62\30H\222Z\377\227\11i\2\225\364%\15F\7G:\62\30H\222Z"
+ "\315@\243\251\321\324hj\64\3\215\246FS\243\251\321\14\64ZeB\232\0\226\63*\355E\7\303@"
+ "\230I\14\6\222*I\225\42\223\222TI\252\64\211\301@\223Hi\22\251E$\245\310\244T)\325`"
+ "\240*\226;\62\356E\7\303@\61\230d\22\241H\243H\243H\42\63\230\64\212\64\212d\22\241H&"
+ "\61\230d\22\241\210\42\22\212$\62\241H*\24\311\14\16\324\0\226M\61\16F\7_l \211e\42"
+ "\203E\244(RQ\222I\244D\221\210Id\23\331\204j\22\203A\42\23\12)jB\211\310\340 \30"
+ "\12\206\202!\0\226\234\67\16F\7gh\240\30\14\22\231H&R\224\310D\22\203\203D\66\22\31\14"
+ "\22\221\252D&\61\30$\62\211T\42\223\30\14\22\212T(\21\31\34\4C\301P\60\4\226\350&\357"
+ "A\7\303\357\342\205\203\7\221TI\252\244E&\222IDZ\225\264\310D\62\211H\253\222T&\21\211"
+ "F\0\226\352$\17B\7\313\340@\31\34<P\244b\222Eb\21\214.\22{\324\340@^\65\70\210"
+ "\27\15\16\344\21\0\226\366(\17B\7\313\340@\31\34<P\244b\222Eb\21\214.\22\313DT#"
+ "\223\204$\252\224f\60\220'%a= \5\226\367$\357A\7\313\340@\31\34<P\244b\222Eb"
+ "\21\214.\22{\324\340@\324G\203\3Q\37\15\16$\0\227\15,\17B\7\313\340@\31\34<P\244"
+ "b\222Eb\21\214.\22\273Lrp\240\21\345\22\203\203HQrp\220\12%\7\7\242,\0\227\34"
+ "\60\17B\7\313\340@\31\34<P\244b\222Eb\21\214.\22{\134f\60\31,B!\315`\223\220"
+ "\204\42\25\211\301\42S\224\312\14V\231P\2\227\62\60\17B\7\313\340@\31\34<P\244b\222Eb"
+ "\21\214.\22\343\330@\62\320T\224d\6\42Yf\262HL\23\241\201&\61\311DV\3\11\0\230\177"
+ "\61\17B\7O<\63\30hb\241\301 \22\314\14\6\221D\253H\242I\213&-\232\224\14\24\221\242"
+ "L\244(\223\310\204\22\231DLS\225I\345\12\230\316\60\357A\7\313\340 \25L\5S\211P\42\25"
+ "\311$R\231D$\225IDR\241L*\224Ie\22\221T&\21\351&\222(\11E\22\265\353\0\232"
+ "\330(\17B\7[\36\220\33|\17\32\14\202\251`*\70\30\344Q\203\7\221l$\62\30DZEZ"
+ "EJ\6\203H\251\2\377\1\13Ba\10\303\7\222A\0\377\14\14\204X\7\303 \42\31D\0\377\32"
+ "\13\344\330\10\303\201x\60\20\377\33\16$\331\7\303\201x\20\221\14\42\0\377\37\23LI\10\313` "
+ "\21\16\202R\241\251\36'\25\1\0";
--- /dev/null
+PROJECT_NAME := wifi
+
+include $(IDF_PATH)/make/project.mk
+
--- /dev/null
+menu "ESP8266 WiFi Configuration"
+
+config ESP_WIFI_SSID
+ string "WiFi SSID"
+ default ""
+ help
+ SSID (network name) for the example to connect to.
+
+config ESP_WIFI_PASSWORD
+ string "WiFi Password"
+ default ""
+ help
+ WiFi password (WPA or WPA2) for the example to use.
+
+endmenu
--- /dev/null
+#include <stdio.h>
+#include <stdlib.h>
+#include "esp_system.h"
+#include "esp_wifi.h"
+#include "esp_event_loop.h"
+#include "freertos/FreeRTOS.h"
+#include "freertos/task.h"
+#include "freertos/event_groups.h"
+#include "driver/gpio.h"
+#include "rom/ets_sys.h"
+
+const int WIFI_CONNECTED_BIT = BIT0;
+static EventGroupHandle_t wifi_event_group;
+
+const int led_pin = GPIO_NUM_16;
+void led_blink_task(void *pvParameters)
+{
+ printf("Blinker Task Running...\n");
+ gpio_set_direction(led_pin, GPIO_MODE_OUTPUT);
+ while(1) {
+ gpio_set_level(led_pin, !gpio_get_level(led_pin));
+ int r = rand() % 500;
+ vTaskDelay(r/portTICK_RATE_MS);
+ }
+}
+
+static esp_err_t event_handler(void *ctx, system_event_t *event)
+{
+ switch(event->event_id) {
+ case SYSTEM_EVENT_STA_GOT_IP:
+ printf("got ip: %s\n", ip4addr_ntoa(&event->event_info.got_ip.ip_info.ip));
+ xEventGroupSetBits(wifi_event_group, WIFI_CONNECTED_BIT);
+ break;
+ case SYSTEM_EVENT_STA_START:
+ esp_wifi_connect();
+ break;
+ case SYSTEM_EVENT_STA_DISCONNECTED:
+ esp_wifi_connect();
+ xEventGroupClearBits(wifi_event_group, WIFI_CONNECTED_BIT);
+ printf("disconnected\n");
+ break;
+ default:
+ printf("unsupport event id %x\n", event->event_id);
+ break;
+ };
+ return ESP_OK;
+}
+
+void wifi_init_sta() {
+ printf("esp wifi init STA start...\n");
+
+ tcpip_adapter_init();
+ ESP_ERROR_CHECK(esp_event_loop_init(event_handler, NULL));
+
+ wifi_init_config_t cfg = WIFI_INIT_CONFIG_DEFAULT();
+ ESP_ERROR_CHECK(esp_wifi_init(&cfg));
+
+ wifi_config_t wifi_config = {
+ .sta = {
+ .ssid = CONFIG_ESP_WIFI_SSID,
+ .password = CONFIG_ESP_WIFI_PASSWORD,
+ },
+ };
+
+ ESP_ERROR_CHECK(esp_wifi_set_mode(WIFI_MODE_STA));
+ ESP_ERROR_CHECK(esp_wifi_set_config(ESP_IF_WIFI_STA, &wifi_config));
+ ESP_ERROR_CHECK(esp_wifi_start());
+
+ printf("esp wifi init STA finished...\n");
+}
+
+void wifi_task(void *pvParameters)
+{
+ wifi_init_sta();
+ //while(true) {
+ // vTaskDelay(100/portTICK_RATE_MS);
+ //}
+ vTaskDelete(NULL);
+}
+
+void init() {
+ wifi_event_group = xEventGroupCreate();
+}
+
+void app_main(void)
+{
+ printf("SDK version:%s\n", esp_get_idf_version());
+
+ init();
+ //wifi_init_sta();
+
+ xTaskCreate(led_blink_task, "Blink", 512, NULL, 2, NULL);
+ xTaskCreate(wifi_task, "WiFi", 4096, NULL, 2, NULL);
+
+ for (int i = 10; i >= 0; i--) {
+ printf("Restarting in %d seconds...\n", i);
+ vTaskDelay(1000 / portTICK_PERIOD_MS);
+ }
+
+ printf("main task exited...\n");
+}
export PATH=/usr/local/sbin:$PATH
export PATH=$HOME/.local/bin:$PATH
export PATH=$PATH:$HOME/workspace/esp/xtensa-esp32-elf/bin
+export PATH=$PATH:$HOME/workspace/esp/xtensa-lx106-elf/bin
export GOBIN=$HOME/.local/bin
export IDF_PATH=$HOME/workspace/esp/esp-idf
export PATH=$PATH:/Applications/Arduino.app/Contents/Java/hardware/tools/avr/bin/
--- /dev/null
+/*
+ *--------------------------------------------------------------------------
+ * File Name: client.c
+ *
+ * Author: Zhao Yanbai [zhaoyanbai@126.com]
+ * Thu Jun 24 18:38:20 2010
+ *
+ * Description: none
+ *
+ *--------------------------------------------------------------------------
+ */
+#include<stdio.h>
+#include<stdlib.h>
+#include<string.h>
+#include<sys/types.h>
+#include<sys/socket.h>
+#include<netinet/in.h>
+#include<arpa/inet.h>
+#include<signal.h>
+#include<pthread.h>
+
+static int terminated = 0;
+static char remote_ip[16];
+static unsigned int data_len = 0;
+
+void sig_int(int signo);
+void *thread(void *arg);
+
+int main(int argc, char *argv[])
+{
+ strcpy(remote_ip, "127.0.0.1");
+ struct sockaddr_in serv;
+ memset(&serv, 0, sizeof(serv));
+ serv.sin_family = AF_INET;
+ serv.sin_port = htons(6666);
+ serv.sin_addr.s_addr = inet_addr(remote_ip);
+
+
+ int sock;
+ sock = socket(AF_INET, SOCK_STREAM, 0);
+ if(sock == -1)
+ {
+ perror("socket failed");
+ exit(1);
+ }
+
+ int flags;
+ setsockopt(sock, SOL_SOCKET, SO_REUSEADDR, &flags, sizeof(flags));
+
+ struct sockaddr_in cliaddr;
+ cliaddr.sin_family = AF_INET;
+ cliaddr.sin_addr.s_addr = htonl(INADDR_ANY);
+ cliaddr.sin_port = htons(5555);
+ if(bind(sock, (struct sockaddr*)&cliaddr, sizeof(cliaddr)) == -1)
+ {
+ perror("bind failed");
+ exit(1);
+ }
+
+ if(connect(sock, (struct sockaddr*)&serv, sizeof(serv)) != 0)
+ {
+ perror("connect");
+ exit(1);
+ }
+
+ close(sock);
+
+ return 0;
+}
+++ /dev/null
-CMAKE_MINIMUM_REQUIRED(VERSION 2.8)
-
-SET(CMAKE_VERBOSE_MAKEFILE on)
-SET(RTOS_VERSION_MAJOR 0)
-SET(RTOS_VERSION_MINOR 1)
-
-SET(CMAKE_SYSTEM_NAME Generic)
-SET(CMAKE_SYSTEM_PROCESSOR xtensa)
-SET(xtensa_esp32_elf_path ${IDF_PATH}/../xtensa-esp32-elf/)
-LINK_DIRECTORIES(${xtensa_esp32_elf_path}/lib/)
-SET(CMAKE_FIND_ROOT_PATH ${xtensa_esp32_elf_path})
-SET(CMAKE_FIND_ROOT_PATH_MODE_PROGRAM NEVER)
-SET(CMAKE_FIND_ROOT_PATH_MODE_LIBRARY ONLY)
-SET(CMAKE_FIND_ROOT_PATH_MODE_INCLUDE ONLY)
-SET(CMAKE_C_COMPILER xtensa-esp32-elf-gcc)
-SET(CMAKE_C_FLAGS "-nostdlib")
-SET(CMAKE_ASM_COMPILER xtensa-esp32-elf-gcc)
-SET(CMAKE_LINKER xtensa-esp32-elf-ld)
-SET(CMAKE_CROSSCOMPILING "TRUE")
-
-PROJECT(rtos NONE)
-ENABLE_LANGUAGE(C)
-ENABLE_LANGUAGE(ASM)
-
-
-CONFIGURE_FILE(
- "${PROJECT_SOURCE_DIR}/rtos_config.h.in"
- "${PROJECT_BINARY_DIR}/rtos_config.h"
-)
-
-INCLUDE_DIRECTORIES("${PROJECT_BINARY_DIR}"
- "components/utils"
- "kernel/include")
-
-ADD_SUBDIRECTORY(components)
-ADD_SUBDIRECTORY(kernel)
-
-LINK_DIRECTORIES(${LIBRARY_OUTPUT_PATH})
-
-ADD_EXECUTABLE(rtos entry.S rtos.c)
-
-
-# TARGET_LINK_LIBRARIES 参数里 debug optimized general 是关键词，不能用
-TARGET_LINK_LIBRARIES(rtos components kernel)
+++ /dev/null
-menu "RTOS Configuration"
-
-config BLINK_GPIO
- int "Blink GPIO number"
- range 0 34
- default 2
- help
- GPIO number (IOxx) to blink on and off.
-
- Some GPIOs are used for other purposes (flash connections, etc.) and cannot be used to blink.
-
- GPIOs 35-39 are input-only so cannot be used as outputs.
-
-endmenu
-
-source "$COMPONENT_KCONFIGS_PROJBUILD"
+++ /dev/null
-PROJECT_NAME = main
-
-include $(RTOS_PATH)/make/project.mk
-
-.PHONY: test
-test: $(COMPONENT_PROJECT_VARS)
- @echo $(COMPONENT_PROJECT_VARS)
+++ /dev/null
-
-1. make menuconfig
+++ /dev/null
-ADD_SUBDIRECTORY(utils)
-ADD_LIBRARY(components $<TARGET_OBJECTS:utils_object>)
+++ /dev/null
-$(SECURE_BOOT_SIGNING_KEY):
- @echo "Need to generate secure boot signing key."
- @echo "One way is to run this command:"
- @echo "$(ESPSECUREPY) generate_signing_key $@"
- @echo "Keep key file safe after generating."
- @echo "(See secure boot documentation for risks & alternatives.)"
- @exit 1
+++ /dev/null
-COMPONENT_CONFIG_ONLY := 1
+++ /dev/null
-/*\r
- * FreeRTOS Kernel V10.0.1\r
- * Copyright (C) 2017 Amazon.com, Inc. or its affiliates. All Rights Reserved.\r
- *\r
- * Permission is hereby granted, free of charge, to any person obtaining a copy of\r
- * this software and associated documentation files (the "Software"), to deal in\r
- * the Software without restriction, including without limitation the rights to\r
- * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of\r
- * the Software, and to permit persons to whom the Software is furnished to do so,\r
- * subject to the following conditions:\r
- *\r
- * The above copyright notice and this permission notice shall be included in all\r
- * copies or substantial portions of the Software.\r
- *\r
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\r
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS\r
- * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR\r
- * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER\r
- * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN\r
- * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\r
- *\r
- * http://www.FreeRTOS.org\r
- * http://aws.amazon.com/freertos\r
- *\r
- * 1 tab == 4 spaces!\r
- */\r
-\r
-#include "FreeRTOS.h"\r
-#include "task.h"\r
-#include "croutine.h"\r
-\r
-/* Remove the whole file is co-routines are not being used. */\r
-#if( configUSE_CO_ROUTINES != 0 )\r
-\r
-/*\r
- * Some kernel aware debuggers require data to be viewed to be global, rather\r
- * than file scope.\r
- */\r
-#ifdef portREMOVE_STATIC_QUALIFIER\r
- #define static\r
-#endif\r
-\r
-\r
-/* Lists for ready and blocked co-routines. --------------------*/\r
-static List_t pxReadyCoRoutineLists[ configMAX_CO_ROUTINE_PRIORITIES ]; /*< Prioritised ready co-routines. */\r
-static List_t xDelayedCoRoutineList1; /*< Delayed co-routines. */\r
-static List_t xDelayedCoRoutineList2; /*< Delayed co-routines (two lists are used - one for delays that have overflowed the current tick count. */\r
-static List_t * pxDelayedCoRoutineList; /*< Points to the delayed co-routine list currently being used. */\r
-static List_t * pxOverflowDelayedCoRoutineList; /*< Points to the delayed co-routine list currently being used to hold co-routines that have overflowed the current tick count. */\r
-static List_t xPendingReadyCoRoutineList; /*< Holds co-routines that have been readied by an external event. They cannot be added directly to the ready lists as the ready lists cannot be accessed by interrupts. */\r
-\r
-/* Other file private variables. --------------------------------*/\r
-CRCB_t * pxCurrentCoRoutine = NULL;\r
-static UBaseType_t uxTopCoRoutineReadyPriority = 0;\r
-static TickType_t xCoRoutineTickCount = 0, xLastTickCount = 0, xPassedTicks = 0;\r
-\r
-/* The initial state of the co-routine when it is created. */\r
-#define corINITIAL_STATE ( 0 )\r
-\r
-/*\r
- * Place the co-routine represented by pxCRCB into the appropriate ready queue\r
- * for the priority. It is inserted at the end of the list.\r
- *\r
- * This macro accesses the co-routine ready lists and therefore must not be\r
- * used from within an ISR.\r
- */\r
-#define prvAddCoRoutineToReadyQueue( pxCRCB ) \\r
-{ \\r
- if( pxCRCB->uxPriority > uxTopCoRoutineReadyPriority ) \\r
- { \\r
- uxTopCoRoutineReadyPriority = pxCRCB->uxPriority; \\r
- } \\r
- vListInsertEnd( ( List_t * ) &( pxReadyCoRoutineLists[ pxCRCB->uxPriority ] ), &( pxCRCB->xGenericListItem ) ); \\r
-}\r
-\r
-/*\r
- * Utility to ready all the lists used by the scheduler. This is called\r
- * automatically upon the creation of the first co-routine.\r
- */\r
-static void prvInitialiseCoRoutineLists( void );\r
-\r
-/*\r
- * Co-routines that are readied by an interrupt cannot be placed directly into\r
- * the ready lists (there is no mutual exclusion). Instead they are placed in\r
- * in the pending ready list in order that they can later be moved to the ready\r
- * list by the co-routine scheduler.\r
- */\r
-static void prvCheckPendingReadyList( void );\r
-\r
-/*\r
- * Macro that looks at the list of co-routines that are currently delayed to\r
- * see if any require waking.\r
- *\r
- * Co-routines are stored in the queue in the order of their wake time -\r
- * meaning once one co-routine has been found whose timer has not expired\r
- * we need not look any further down the list.\r
- */\r
-static void prvCheckDelayedList( void );\r
-\r
-/*-----------------------------------------------------------*/\r
-\r
-BaseType_t xCoRoutineCreate( crCOROUTINE_CODE pxCoRoutineCode, UBaseType_t uxPriority, UBaseType_t uxIndex )\r
-{\r
-BaseType_t xReturn;\r
-CRCB_t *pxCoRoutine;\r
-\r
- /* Allocate the memory that will store the co-routine control block. */\r
- pxCoRoutine = ( CRCB_t * ) pvPortMalloc( sizeof( CRCB_t ) );\r
- if( pxCoRoutine )\r
- {\r
- /* If pxCurrentCoRoutine is NULL then this is the first co-routine to\r
- be created and the co-routine data structures need initialising. */\r
- if( pxCurrentCoRoutine == NULL )\r
- {\r
- pxCurrentCoRoutine = pxCoRoutine;\r
- prvInitialiseCoRoutineLists();\r
- }\r
-\r
- /* Check the priority is within limits. */\r
- if( uxPriority >= configMAX_CO_ROUTINE_PRIORITIES )\r
- {\r
- uxPriority = configMAX_CO_ROUTINE_PRIORITIES - 1;\r
- }\r
-\r
- /* Fill out the co-routine control block from the function parameters. */\r
- pxCoRoutine->uxState = corINITIAL_STATE;\r
- pxCoRoutine->uxPriority = uxPriority;\r
- pxCoRoutine->uxIndex = uxIndex;\r
- pxCoRoutine->pxCoRoutineFunction = pxCoRoutineCode;\r
-\r
- /* Initialise all the other co-routine control block parameters. */\r
- vListInitialiseItem( &( pxCoRoutine->xGenericListItem ) );\r
- vListInitialiseItem( &( pxCoRoutine->xEventListItem ) );\r
-\r
- /* Set the co-routine control block as a link back from the ListItem_t.\r
- This is so we can get back to the containing CRCB from a generic item\r
- in a list. */\r
- listSET_LIST_ITEM_OWNER( &( pxCoRoutine->xGenericListItem ), pxCoRoutine );\r
- listSET_LIST_ITEM_OWNER( &( pxCoRoutine->xEventListItem ), pxCoRoutine );\r
-\r
- /* Event lists are always in priority order. */\r
- listSET_LIST_ITEM_VALUE( &( pxCoRoutine->xEventListItem ), ( ( TickType_t ) configMAX_CO_ROUTINE_PRIORITIES - ( TickType_t ) uxPriority ) );\r
-\r
- /* Now the co-routine has been initialised it can be added to the ready\r
- list at the correct priority. */\r
- prvAddCoRoutineToReadyQueue( pxCoRoutine );\r
-\r
- xReturn = pdPASS;\r
- }\r
- else\r
- {\r
- xReturn = errCOULD_NOT_ALLOCATE_REQUIRED_MEMORY;\r
- }\r
-\r
- return xReturn;\r
-}\r
-/*-----------------------------------------------------------*/\r
-\r
-void vCoRoutineAddToDelayedList( TickType_t xTicksToDelay, List_t *pxEventList )\r
-{\r
-TickType_t xTimeToWake;\r
-\r
- /* Calculate the time to wake - this may overflow but this is\r
- not a problem. */\r
- xTimeToWake = xCoRoutineTickCount + xTicksToDelay;\r
-\r
- /* We must remove ourselves from the ready list before adding\r
- ourselves to the blocked list as the same list item is used for\r
- both lists. */\r
- ( void ) uxListRemove( ( ListItem_t * ) &( pxCurrentCoRoutine->xGenericListItem ) );\r
-\r
- /* The list item will be inserted in wake time order. */\r
- listSET_LIST_ITEM_VALUE( &( pxCurrentCoRoutine->xGenericListItem ), xTimeToWake );\r
-\r
- if( xTimeToWake < xCoRoutineTickCount )\r
- {\r
- /* Wake time has overflowed. Place this item in the\r
- overflow list. */\r
- vListInsert( ( List_t * ) pxOverflowDelayedCoRoutineList, ( ListItem_t * ) &( pxCurrentCoRoutine->xGenericListItem ) );\r
- }\r
- else\r
- {\r
- /* The wake time has not overflowed, so we can use the\r
- current block list. */\r
- vListInsert( ( List_t * ) pxDelayedCoRoutineList, ( ListItem_t * ) &( pxCurrentCoRoutine->xGenericListItem ) );\r
- }\r
-\r
- if( pxEventList )\r
- {\r
- /* Also add the co-routine to an event list. If this is done then the\r
- function must be called with interrupts disabled. */\r
- vListInsert( pxEventList, &( pxCurrentCoRoutine->xEventListItem ) );\r
- }\r
-}\r
-/*-----------------------------------------------------------*/\r
-\r
-static void prvCheckPendingReadyList( void )\r
-{\r
- /* Are there any co-routines waiting to get moved to the ready list? These\r
- are co-routines that have been readied by an ISR. The ISR cannot access\r
- the ready lists itself. */\r
- while( listLIST_IS_EMPTY( &xPendingReadyCoRoutineList ) == pdFALSE )\r
- {\r
- CRCB_t *pxUnblockedCRCB;\r
-\r
- /* The pending ready list can be accessed by an ISR. */\r
- portDISABLE_INTERRUPTS();\r
- {\r
- pxUnblockedCRCB = ( CRCB_t * ) listGET_OWNER_OF_HEAD_ENTRY( (&xPendingReadyCoRoutineList) );\r
- ( void ) uxListRemove( &( pxUnblockedCRCB->xEventListItem ) );\r
- }\r
- portENABLE_INTERRUPTS();\r
-\r
- ( void ) uxListRemove( &( pxUnblockedCRCB->xGenericListItem ) );\r
- prvAddCoRoutineToReadyQueue( pxUnblockedCRCB );\r
- }\r
-}\r
-/*-----------------------------------------------------------*/\r
-\r
-static void prvCheckDelayedList( void )\r
-{\r
-CRCB_t *pxCRCB;\r
-\r
- xPassedTicks = xTaskGetTickCount() - xLastTickCount;\r
- while( xPassedTicks )\r
- {\r
- xCoRoutineTickCount++;\r
- xPassedTicks--;\r
-\r
- /* If the tick count has overflowed we need to swap the ready lists. */\r
- if( xCoRoutineTickCount == 0 )\r
- {\r
- List_t * pxTemp;\r
-\r
- /* Tick count has overflowed so we need to swap the delay lists. If there are\r
- any items in pxDelayedCoRoutineList here then there is an error! */\r
- pxTemp = pxDelayedCoRoutineList;\r
- pxDelayedCoRoutineList = pxOverflowDelayedCoRoutineList;\r
- pxOverflowDelayedCoRoutineList = pxTemp;\r
- }\r
-\r
- /* See if this tick has made a timeout expire. */\r
- while( listLIST_IS_EMPTY( pxDelayedCoRoutineList ) == pdFALSE )\r
- {\r
- pxCRCB = ( CRCB_t * ) listGET_OWNER_OF_HEAD_ENTRY( pxDelayedCoRoutineList );\r
-\r
- if( xCoRoutineTickCount < listGET_LIST_ITEM_VALUE( &( pxCRCB->xGenericListItem ) ) )\r
- {\r
- /* Timeout not yet expired. */\r
- break;\r
- }\r
-\r
- portDISABLE_INTERRUPTS();\r
- {\r
- /* The event could have occurred just before this critical\r
- section. If this is the case then the generic list item will\r
- have been moved to the pending ready list and the following\r
- line is still valid. Also the pvContainer parameter will have\r
- been set to NULL so the following lines are also valid. */\r
- ( void ) uxListRemove( &( pxCRCB->xGenericListItem ) );\r
-\r
- /* Is the co-routine waiting on an event also? */\r
- if( pxCRCB->xEventListItem.pvContainer )\r
- {\r
- ( void ) uxListRemove( &( pxCRCB->xEventListItem ) );\r
- }\r
- }\r
- portENABLE_INTERRUPTS();\r
-\r
- prvAddCoRoutineToReadyQueue( pxCRCB );\r
- }\r
- }\r
-\r
- xLastTickCount = xCoRoutineTickCount;\r
-}\r
-/*-----------------------------------------------------------*/\r
-\r
-void vCoRoutineSchedule( void )\r
-{\r
- /* See if any co-routines readied by events need moving to the ready lists. */\r
- prvCheckPendingReadyList();\r
-\r
- /* See if any delayed co-routines have timed out. */\r
- prvCheckDelayedList();\r
-\r
- /* Find the highest priority queue that contains ready co-routines. */\r
- while( listLIST_IS_EMPTY( &( pxReadyCoRoutineLists[ uxTopCoRoutineReadyPriority ] ) ) )\r
- {\r
- if( uxTopCoRoutineReadyPriority == 0 )\r
- {\r
- /* No more co-routines to check. */\r
- return;\r
- }\r
- --uxTopCoRoutineReadyPriority;\r
- }\r
-\r
- /* listGET_OWNER_OF_NEXT_ENTRY walks through the list, so the co-routines\r
- of the same priority get an equal share of the processor time. */\r
- listGET_OWNER_OF_NEXT_ENTRY( pxCurrentCoRoutine, &( pxReadyCoRoutineLists[ uxTopCoRoutineReadyPriority ] ) );\r
-\r
- /* Call the co-routine. */\r
- ( pxCurrentCoRoutine->pxCoRoutineFunction )( pxCurrentCoRoutine, pxCurrentCoRoutine->uxIndex );\r
-\r
- return;\r
-}\r
-/*-----------------------------------------------------------*/\r
-\r
-static void prvInitialiseCoRoutineLists( void )\r
-{\r
-UBaseType_t uxPriority;\r
-\r
- for( uxPriority = 0; uxPriority < configMAX_CO_ROUTINE_PRIORITIES; uxPriority++ )\r
- {\r
- vListInitialise( ( List_t * ) &( pxReadyCoRoutineLists[ uxPriority ] ) );\r
- }\r
-\r
- vListInitialise( ( List_t * ) &xDelayedCoRoutineList1 );\r
- vListInitialise( ( List_t * ) &xDelayedCoRoutineList2 );\r
- vListInitialise( ( List_t * ) &xPendingReadyCoRoutineList );\r
-\r
- /* Start with pxDelayedCoRoutineList using list1 and the\r
- pxOverflowDelayedCoRoutineList using list2. */\r
- pxDelayedCoRoutineList = &xDelayedCoRoutineList1;\r
- pxOverflowDelayedCoRoutineList = &xDelayedCoRoutineList2;\r
-}\r
-/*-----------------------------------------------------------*/\r
-\r
-BaseType_t xCoRoutineRemoveFromEventList( const List_t *pxEventList )\r
-{\r
-CRCB_t *pxUnblockedCRCB;\r
-BaseType_t xReturn;\r
-\r
- /* This function is called from within an interrupt. It can only access\r
- event lists and the pending ready list. This function assumes that a\r
- check has already been made to ensure pxEventList is not empty. */\r
- pxUnblockedCRCB = ( CRCB_t * ) listGET_OWNER_OF_HEAD_ENTRY( pxEventList );\r
- ( void ) uxListRemove( &( pxUnblockedCRCB->xEventListItem ) );\r
- vListInsertEnd( ( List_t * ) &( xPendingReadyCoRoutineList ), &( pxUnblockedCRCB->xEventListItem ) );\r
-\r
- if( pxUnblockedCRCB->uxPriority >= pxCurrentCoRoutine->uxPriority )\r
- {\r
- xReturn = pdTRUE;\r
- }\r
- else\r
- {\r
- xReturn = pdFALSE;\r
- }\r
-\r
- return xReturn;\r
-}\r
-\r
-#endif /* configUSE_CO_ROUTINES == 0 */\r
-\r
+++ /dev/null
-/*\r
- * FreeRTOS Kernel V10.0.1\r
- * Copyright (C) 2017 Amazon.com, Inc. or its affiliates. All Rights Reserved.\r
- *\r
- * Permission is hereby granted, free of charge, to any person obtaining a copy of\r
- * this software and associated documentation files (the "Software"), to deal in\r
- * the Software without restriction, including without limitation the rights to\r
- * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of\r
- * the Software, and to permit persons to whom the Software is furnished to do so,\r
- * subject to the following conditions:\r
- *\r
- * The above copyright notice and this permission notice shall be included in all\r
- * copies or substantial portions of the Software.\r
- *\r
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\r
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS\r
- * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR\r
- * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER\r
- * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN\r
- * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\r
- *\r
- * http://www.FreeRTOS.org\r
- * http://aws.amazon.com/freertos\r
- *\r
- * 1 tab == 4 spaces!\r
- */\r
-\r
-/* Standard includes. */\r
-#include <stdlib.h>\r
-\r
-/* Defining MPU_WRAPPERS_INCLUDED_FROM_API_FILE prevents task.h from redefining\r
-all the API functions to use the MPU wrappers. That should only be done when\r
-task.h is included from an application file. */\r
-#define MPU_WRAPPERS_INCLUDED_FROM_API_FILE\r
-\r
-/* FreeRTOS includes. */\r
-#include "FreeRTOS.h"\r
-#include "task.h"\r
-#include "timers.h"\r
-#include "event_groups.h"\r
-\r
-/* Lint e961 and e750 are suppressed as a MISRA exception justified because the\r
-MPU ports require MPU_WRAPPERS_INCLUDED_FROM_API_FILE to be defined for the\r
-header files above, but not in this file, in order to generate the correct\r
-privileged Vs unprivileged linkage and placement. */\r
-#undef MPU_WRAPPERS_INCLUDED_FROM_API_FILE /*lint !e961 !e750. */\r
-\r
-/* The following bit fields convey control information in a task's event list\r
-item value. It is important they don't clash with the\r
-taskEVENT_LIST_ITEM_VALUE_IN_USE definition. */\r
-#if configUSE_16_BIT_TICKS == 1\r
- #define eventCLEAR_EVENTS_ON_EXIT_BIT 0x0100U\r
- #define eventUNBLOCKED_DUE_TO_BIT_SET 0x0200U\r
- #define eventWAIT_FOR_ALL_BITS 0x0400U\r
- #define eventEVENT_BITS_CONTROL_BYTES 0xff00U\r
-#else\r
- #define eventCLEAR_EVENTS_ON_EXIT_BIT 0x01000000UL\r
- #define eventUNBLOCKED_DUE_TO_BIT_SET 0x02000000UL\r
- #define eventWAIT_FOR_ALL_BITS 0x04000000UL\r
- #define eventEVENT_BITS_CONTROL_BYTES 0xff000000UL\r
-#endif\r
-\r
-typedef struct xEventGroupDefinition\r
-{\r
- EventBits_t uxEventBits;\r
- List_t xTasksWaitingForBits; /*< List of tasks waiting for a bit to be set. */\r
-\r
- #if( configUSE_TRACE_FACILITY == 1 )\r
- UBaseType_t uxEventGroupNumber;\r
- #endif\r
-\r
- #if( ( configSUPPORT_STATIC_ALLOCATION == 1 ) && ( configSUPPORT_DYNAMIC_ALLOCATION == 1 ) )\r
- uint8_t ucStaticallyAllocated; /*< Set to pdTRUE if the event group is statically allocated to ensure no attempt is made to free the memory. */\r
- #endif\r
-} EventGroup_t;\r
-\r
-/*-----------------------------------------------------------*/\r
-\r
-/*\r
- * Test the bits set in uxCurrentEventBits to see if the wait condition is met.\r
- * The wait condition is defined by xWaitForAllBits. If xWaitForAllBits is\r
- * pdTRUE then the wait condition is met if all the bits set in uxBitsToWaitFor\r
- * are also set in uxCurrentEventBits. If xWaitForAllBits is pdFALSE then the\r
- * wait condition is met if any of the bits set in uxBitsToWait for are also set\r
- * in uxCurrentEventBits.\r
- */\r
-static BaseType_t prvTestWaitCondition( const EventBits_t uxCurrentEventBits, const EventBits_t uxBitsToWaitFor, const BaseType_t xWaitForAllBits ) PRIVILEGED_FUNCTION;\r
-\r
-/*-----------------------------------------------------------*/\r
-\r
-#if( configSUPPORT_STATIC_ALLOCATION == 1 )\r
-\r
- EventGroupHandle_t xEventGroupCreateStatic( StaticEventGroup_t *pxEventGroupBuffer )\r
- {\r
- EventGroup_t *pxEventBits;\r
-\r
- /* A StaticEventGroup_t object must be provided. */\r
- configASSERT( pxEventGroupBuffer );\r
-\r
- #if( configASSERT_DEFINED == 1 )\r
- {\r
- /* Sanity check that the size of the structure used to declare a\r
- variable of type StaticEventGroup_t equals the size of the real\r
- event group structure. */\r
- volatile size_t xSize = sizeof( StaticEventGroup_t );\r
- configASSERT( xSize == sizeof( EventGroup_t ) );\r
- }\r
- #endif /* configASSERT_DEFINED */\r
-\r
- /* The user has provided a statically allocated event group - use it. */\r
- pxEventBits = ( EventGroup_t * ) pxEventGroupBuffer; /*lint !e740 EventGroup_t and StaticEventGroup_t are guaranteed to have the same size and alignment requirement - checked by configASSERT(). */\r
-\r
- if( pxEventBits != NULL )\r
- {\r
- pxEventBits->uxEventBits = 0;\r
- vListInitialise( &( pxEventBits->xTasksWaitingForBits ) );\r
-\r
- #if( configSUPPORT_DYNAMIC_ALLOCATION == 1 )\r
- {\r
- /* Both static and dynamic allocation can be used, so note that\r
- this event group was created statically in case the event group\r
- is later deleted. */\r
- pxEventBits->ucStaticallyAllocated = pdTRUE;\r
- }\r
- #endif /* configSUPPORT_DYNAMIC_ALLOCATION */\r
-\r
- traceEVENT_GROUP_CREATE( pxEventBits );\r
- }\r
- else\r
- {\r
- traceEVENT_GROUP_CREATE_FAILED();\r
- }\r
-\r
- return ( EventGroupHandle_t ) pxEventBits;\r
- }\r
-\r
-#endif /* configSUPPORT_STATIC_ALLOCATION */\r
-/*-----------------------------------------------------------*/\r
-\r
-#if( configSUPPORT_DYNAMIC_ALLOCATION == 1 )\r
-\r
- EventGroupHandle_t xEventGroupCreate( void )\r
- {\r
- EventGroup_t *pxEventBits;\r
-\r
- /* Allocate the event group. */\r
- pxEventBits = ( EventGroup_t * ) pvPortMalloc( sizeof( EventGroup_t ) );\r
-\r
- if( pxEventBits != NULL )\r
- {\r
- pxEventBits->uxEventBits = 0;\r
- vListInitialise( &( pxEventBits->xTasksWaitingForBits ) );\r
-\r
- #if( configSUPPORT_STATIC_ALLOCATION == 1 )\r
- {\r
- /* Both static and dynamic allocation can be used, so note this\r
- event group was allocated statically in case the event group is\r
- later deleted. */\r
- pxEventBits->ucStaticallyAllocated = pdFALSE;\r
- }\r
- #endif /* configSUPPORT_STATIC_ALLOCATION */\r
-\r
- traceEVENT_GROUP_CREATE( pxEventBits );\r
- }\r
- else\r
- {\r
- traceEVENT_GROUP_CREATE_FAILED();\r
- }\r
-\r
- return ( EventGroupHandle_t ) pxEventBits;\r
- }\r
-\r
-#endif /* configSUPPORT_DYNAMIC_ALLOCATION */\r
-/*-----------------------------------------------------------*/\r
-\r
-EventBits_t xEventGroupSync( EventGroupHandle_t xEventGroup, const EventBits_t uxBitsToSet, const EventBits_t uxBitsToWaitFor, TickType_t xTicksToWait )\r
-{\r
-EventBits_t uxOriginalBitValue, uxReturn;\r
-EventGroup_t *pxEventBits = ( EventGroup_t * ) xEventGroup;\r
-BaseType_t xAlreadyYielded;\r
-BaseType_t xTimeoutOccurred = pdFALSE;\r
-\r
- configASSERT( ( uxBitsToWaitFor & eventEVENT_BITS_CONTROL_BYTES ) == 0 );\r
- configASSERT( uxBitsToWaitFor != 0 );\r
- #if ( ( INCLUDE_xTaskGetSchedulerState == 1 ) || ( configUSE_TIMERS == 1 ) )\r
- {\r
- configASSERT( !( ( xTaskGetSchedulerState() == taskSCHEDULER_SUSPENDED ) && ( xTicksToWait != 0 ) ) );\r
- }\r
- #endif\r
-\r
- vTaskSuspendAll();\r
- {\r
- uxOriginalBitValue = pxEventBits->uxEventBits;\r
-\r
- ( void ) xEventGroupSetBits( xEventGroup, uxBitsToSet );\r
-\r
- if( ( ( uxOriginalBitValue | uxBitsToSet ) & uxBitsToWaitFor ) == uxBitsToWaitFor )\r
- {\r
- /* All the rendezvous bits are now set - no need to block. */\r
- uxReturn = ( uxOriginalBitValue | uxBitsToSet );\r
-\r
- /* Rendezvous always clear the bits. They will have been cleared\r
- already unless this is the only task in the rendezvous. */\r
- pxEventBits->uxEventBits &= ~uxBitsToWaitFor;\r
-\r
- xTicksToWait = 0;\r
- }\r
- else\r
- {\r
- if( xTicksToWait != ( TickType_t ) 0 )\r
- {\r
- traceEVENT_GROUP_SYNC_BLOCK( xEventGroup, uxBitsToSet, uxBitsToWaitFor );\r
-\r
- /* Store the bits that the calling task is waiting for in the\r
- task's event list item so the kernel knows when a match is\r
- found. Then enter the blocked state. */\r
- vTaskPlaceOnUnorderedEventList( &( pxEventBits->xTasksWaitingForBits ), ( uxBitsToWaitFor | eventCLEAR_EVENTS_ON_EXIT_BIT | eventWAIT_FOR_ALL_BITS ), xTicksToWait );\r
-\r
- /* This assignment is obsolete as uxReturn will get set after\r
- the task unblocks, but some compilers mistakenly generate a\r
- warning about uxReturn being returned without being set if the\r
- assignment is omitted. */\r
- uxReturn = 0;\r
- }\r
- else\r
- {\r
- /* The rendezvous bits were not set, but no block time was\r
- specified - just return the current event bit value. */\r
- uxReturn = pxEventBits->uxEventBits;\r
- xTimeoutOccurred = pdTRUE;\r
- }\r
- }\r
- }\r
- xAlreadyYielded = xTaskResumeAll();\r
-\r
- if( xTicksToWait != ( TickType_t ) 0 )\r
- {\r
- if( xAlreadyYielded == pdFALSE )\r
- {\r
- portYIELD_WITHIN_API();\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
-\r
- /* The task blocked to wait for its required bits to be set - at this\r
- point either the required bits were set or the block time expired. If\r
- the required bits were set they will have been stored in the task's\r
- event list item, and they should now be retrieved then cleared. */\r
- uxReturn = uxTaskResetEventItemValue();\r
-\r
- if( ( uxReturn & eventUNBLOCKED_DUE_TO_BIT_SET ) == ( EventBits_t ) 0 )\r
- {\r
- /* The task timed out, just return the current event bit value. */\r
- taskENTER_CRITICAL();\r
- {\r
- uxReturn = pxEventBits->uxEventBits;\r
-\r
- /* Although the task got here because it timed out before the\r
- bits it was waiting for were set, it is possible that since it\r
- unblocked another task has set the bits. If this is the case\r
- then it needs to clear the bits before exiting. */\r
- if( ( uxReturn & uxBitsToWaitFor ) == uxBitsToWaitFor )\r
- {\r
- pxEventBits->uxEventBits &= ~uxBitsToWaitFor;\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- taskEXIT_CRITICAL();\r
-\r
- xTimeoutOccurred = pdTRUE;\r
- }\r
- else\r
- {\r
- /* The task unblocked because the bits were set. */\r
- }\r
-\r
- /* Control bits might be set as the task had blocked should not be\r
- returned. */\r
- uxReturn &= ~eventEVENT_BITS_CONTROL_BYTES;\r
- }\r
-\r
- traceEVENT_GROUP_SYNC_END( xEventGroup, uxBitsToSet, uxBitsToWaitFor, xTimeoutOccurred );\r
-\r
- /* Prevent compiler warnings when trace macros are not used. */\r
- ( void ) xTimeoutOccurred;\r
-\r
- return uxReturn;\r
-}\r
-/*-----------------------------------------------------------*/\r
-\r
-EventBits_t xEventGroupWaitBits( EventGroupHandle_t xEventGroup, const EventBits_t uxBitsToWaitFor, const BaseType_t xClearOnExit, const BaseType_t xWaitForAllBits, TickType_t xTicksToWait )\r
-{\r
-EventGroup_t *pxEventBits = ( EventGroup_t * ) xEventGroup;\r
-EventBits_t uxReturn, uxControlBits = 0;\r
-BaseType_t xWaitConditionMet, xAlreadyYielded;\r
-BaseType_t xTimeoutOccurred = pdFALSE;\r
-\r
- /* Check the user is not attempting to wait on the bits used by the kernel\r
- itself, and that at least one bit is being requested. */\r
- configASSERT( xEventGroup );\r
- configASSERT( ( uxBitsToWaitFor & eventEVENT_BITS_CONTROL_BYTES ) == 0 );\r
- configASSERT( uxBitsToWaitFor != 0 );\r
- #if ( ( INCLUDE_xTaskGetSchedulerState == 1 ) || ( configUSE_TIMERS == 1 ) )\r
- {\r
- configASSERT( !( ( xTaskGetSchedulerState() == taskSCHEDULER_SUSPENDED ) && ( xTicksToWait != 0 ) ) );\r
- }\r
- #endif\r
-\r
- vTaskSuspendAll();\r
- {\r
- const EventBits_t uxCurrentEventBits = pxEventBits->uxEventBits;\r
-\r
- /* Check to see if the wait condition is already met or not. */\r
- xWaitConditionMet = prvTestWaitCondition( uxCurrentEventBits, uxBitsToWaitFor, xWaitForAllBits );\r
-\r
- if( xWaitConditionMet != pdFALSE )\r
- {\r
- /* The wait condition has already been met so there is no need to\r
- block. */\r
- uxReturn = uxCurrentEventBits;\r
- xTicksToWait = ( TickType_t ) 0;\r
-\r
- /* Clear the wait bits if requested to do so. */\r
- if( xClearOnExit != pdFALSE )\r
- {\r
- pxEventBits->uxEventBits &= ~uxBitsToWaitFor;\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- else if( xTicksToWait == ( TickType_t ) 0 )\r
- {\r
- /* The wait condition has not been met, but no block time was\r
- specified, so just return the current value. */\r
- uxReturn = uxCurrentEventBits;\r
- xTimeoutOccurred = pdTRUE;\r
- }\r
- else\r
- {\r
- /* The task is going to block to wait for its required bits to be\r
- set. uxControlBits are used to remember the specified behaviour of\r
- this call to xEventGroupWaitBits() - for use when the event bits\r
- unblock the task. */\r
- if( xClearOnExit != pdFALSE )\r
- {\r
- uxControlBits |= eventCLEAR_EVENTS_ON_EXIT_BIT;\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
-\r
- if( xWaitForAllBits != pdFALSE )\r
- {\r
- uxControlBits |= eventWAIT_FOR_ALL_BITS;\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
-\r
- /* Store the bits that the calling task is waiting for in the\r
- task's event list item so the kernel knows when a match is\r
- found. Then enter the blocked state. */\r
- vTaskPlaceOnUnorderedEventList( &( pxEventBits->xTasksWaitingForBits ), ( uxBitsToWaitFor | uxControlBits ), xTicksToWait );\r
-\r
- /* This is obsolete as it will get set after the task unblocks, but\r
- some compilers mistakenly generate a warning about the variable\r
- being returned without being set if it is not done. */\r
- uxReturn = 0;\r
-\r
- traceEVENT_GROUP_WAIT_BITS_BLOCK( xEventGroup, uxBitsToWaitFor );\r
- }\r
- }\r
- xAlreadyYielded = xTaskResumeAll();\r
-\r
- if( xTicksToWait != ( TickType_t ) 0 )\r
- {\r
- if( xAlreadyYielded == pdFALSE )\r
- {\r
- portYIELD_WITHIN_API();\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
-\r
- /* The task blocked to wait for its required bits to be set - at this\r
- point either the required bits were set or the block time expired. If\r
- the required bits were set they will have been stored in the task's\r
- event list item, and they should now be retrieved then cleared. */\r
- uxReturn = uxTaskResetEventItemValue();\r
-\r
- if( ( uxReturn & eventUNBLOCKED_DUE_TO_BIT_SET ) == ( EventBits_t ) 0 )\r
- {\r
- taskENTER_CRITICAL();\r
- {\r
- /* The task timed out, just return the current event bit value. */\r
- uxReturn = pxEventBits->uxEventBits;\r
-\r
- /* It is possible that the event bits were updated between this\r
- task leaving the Blocked state and running again. */\r
- if( prvTestWaitCondition( uxReturn, uxBitsToWaitFor, xWaitForAllBits ) != pdFALSE )\r
- {\r
- if( xClearOnExit != pdFALSE )\r
- {\r
- pxEventBits->uxEventBits &= ~uxBitsToWaitFor;\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- xTimeoutOccurred = pdTRUE;\r
- }\r
- taskEXIT_CRITICAL();\r
- }\r
- else\r
- {\r
- /* The task unblocked because the bits were set. */\r
- }\r
-\r
- /* The task blocked so control bits may have been set. */\r
- uxReturn &= ~eventEVENT_BITS_CONTROL_BYTES;\r
- }\r
- traceEVENT_GROUP_WAIT_BITS_END( xEventGroup, uxBitsToWaitFor, xTimeoutOccurred );\r
-\r
- /* Prevent compiler warnings when trace macros are not used. */\r
- ( void ) xTimeoutOccurred;\r
-\r
- return uxReturn;\r
-}\r
-/*-----------------------------------------------------------*/\r
-\r
-EventBits_t xEventGroupClearBits( EventGroupHandle_t xEventGroup, const EventBits_t uxBitsToClear )\r
-{\r
-EventGroup_t *pxEventBits = ( EventGroup_t * ) xEventGroup;\r
-EventBits_t uxReturn;\r
-\r
- /* Check the user is not attempting to clear the bits used by the kernel\r
- itself. */\r
- configASSERT( xEventGroup );\r
- configASSERT( ( uxBitsToClear & eventEVENT_BITS_CONTROL_BYTES ) == 0 );\r
-\r
- taskENTER_CRITICAL();\r
- {\r
- traceEVENT_GROUP_CLEAR_BITS( xEventGroup, uxBitsToClear );\r
-\r
- /* The value returned is the event group value prior to the bits being\r
- cleared. */\r
- uxReturn = pxEventBits->uxEventBits;\r
-\r
- /* Clear the bits. */\r
- pxEventBits->uxEventBits &= ~uxBitsToClear;\r
- }\r
- taskEXIT_CRITICAL();\r
-\r
- return uxReturn;\r
-}\r
-/*-----------------------------------------------------------*/\r
-\r
-#if ( ( configUSE_TRACE_FACILITY == 1 ) && ( INCLUDE_xTimerPendFunctionCall == 1 ) && ( configUSE_TIMERS == 1 ) )\r
-\r
- BaseType_t xEventGroupClearBitsFromISR( EventGroupHandle_t xEventGroup, const EventBits_t uxBitsToClear )\r
- {\r
- BaseType_t xReturn;\r
-\r
- traceEVENT_GROUP_CLEAR_BITS_FROM_ISR( xEventGroup, uxBitsToClear );\r
- xReturn = xTimerPendFunctionCallFromISR( vEventGroupClearBitsCallback, ( void * ) xEventGroup, ( uint32_t ) uxBitsToClear, NULL );\r
-\r
- return xReturn;\r
- }\r
-\r
-#endif\r
-/*-----------------------------------------------------------*/\r
-\r
-EventBits_t xEventGroupGetBitsFromISR( EventGroupHandle_t xEventGroup )\r
-{\r
-UBaseType_t uxSavedInterruptStatus;\r
-EventGroup_t *pxEventBits = ( EventGroup_t * ) xEventGroup;\r
-EventBits_t uxReturn;\r
-\r
- uxSavedInterruptStatus = portSET_INTERRUPT_MASK_FROM_ISR();\r
- {\r
- uxReturn = pxEventBits->uxEventBits;\r
- }\r
- portCLEAR_INTERRUPT_MASK_FROM_ISR( uxSavedInterruptStatus );\r
-\r
- return uxReturn;\r
-}\r
-/*-----------------------------------------------------------*/\r
-\r
-EventBits_t xEventGroupSetBits( EventGroupHandle_t xEventGroup, const EventBits_t uxBitsToSet )\r
-{\r
-ListItem_t *pxListItem, *pxNext;\r
-ListItem_t const *pxListEnd;\r
-List_t *pxList;\r
-EventBits_t uxBitsToClear = 0, uxBitsWaitedFor, uxControlBits;\r
-EventGroup_t *pxEventBits = ( EventGroup_t * ) xEventGroup;\r
-BaseType_t xMatchFound = pdFALSE;\r
-\r
- /* Check the user is not attempting to set the bits used by the kernel\r
- itself. */\r
- configASSERT( xEventGroup );\r
- configASSERT( ( uxBitsToSet & eventEVENT_BITS_CONTROL_BYTES ) == 0 );\r
-\r
- pxList = &( pxEventBits->xTasksWaitingForBits );\r
- pxListEnd = listGET_END_MARKER( pxList ); /*lint !e826 !e740 The mini list structure is used as the list end to save RAM. This is checked and valid. */\r
- vTaskSuspendAll();\r
- {\r
- traceEVENT_GROUP_SET_BITS( xEventGroup, uxBitsToSet );\r
-\r
- pxListItem = listGET_HEAD_ENTRY( pxList );\r
-\r
- /* Set the bits. */\r
- pxEventBits->uxEventBits |= uxBitsToSet;\r
-\r
- /* See if the new bit value should unblock any tasks. */\r
- while( pxListItem != pxListEnd )\r
- {\r
- pxNext = listGET_NEXT( pxListItem );\r
- uxBitsWaitedFor = listGET_LIST_ITEM_VALUE( pxListItem );\r
- xMatchFound = pdFALSE;\r
-\r
- /* Split the bits waited for from the control bits. */\r
- uxControlBits = uxBitsWaitedFor & eventEVENT_BITS_CONTROL_BYTES;\r
- uxBitsWaitedFor &= ~eventEVENT_BITS_CONTROL_BYTES;\r
-\r
- if( ( uxControlBits & eventWAIT_FOR_ALL_BITS ) == ( EventBits_t ) 0 )\r
- {\r
- /* Just looking for single bit being set. */\r
- if( ( uxBitsWaitedFor & pxEventBits->uxEventBits ) != ( EventBits_t ) 0 )\r
- {\r
- xMatchFound = pdTRUE;\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- else if( ( uxBitsWaitedFor & pxEventBits->uxEventBits ) == uxBitsWaitedFor )\r
- {\r
- /* All bits are set. */\r
- xMatchFound = pdTRUE;\r
- }\r
- else\r
- {\r
- /* Need all bits to be set, but not all the bits were set. */\r
- }\r
-\r
- if( xMatchFound != pdFALSE )\r
- {\r
- /* The bits match. Should the bits be cleared on exit? */\r
- if( ( uxControlBits & eventCLEAR_EVENTS_ON_EXIT_BIT ) != ( EventBits_t ) 0 )\r
- {\r
- uxBitsToClear |= uxBitsWaitedFor;\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
-\r
- /* Store the actual event flag value in the task's event list\r
- item before removing the task from the event list. The\r
- eventUNBLOCKED_DUE_TO_BIT_SET bit is set so the task knows\r
- that is was unblocked due to its required bits matching, rather\r
- than because it timed out. */\r
- vTaskRemoveFromUnorderedEventList( pxListItem, pxEventBits->uxEventBits | eventUNBLOCKED_DUE_TO_BIT_SET );\r
- }\r
-\r
- /* Move onto the next list item. Note pxListItem->pxNext is not\r
- used here as the list item may have been removed from the event list\r
- and inserted into the ready/pending reading list. */\r
- pxListItem = pxNext;\r
- }\r
-\r
- /* Clear any bits that matched when the eventCLEAR_EVENTS_ON_EXIT_BIT\r
- bit was set in the control word. */\r
- pxEventBits->uxEventBits &= ~uxBitsToClear;\r
- }\r
- ( void ) xTaskResumeAll();\r
-\r
- return pxEventBits->uxEventBits;\r
-}\r
-/*-----------------------------------------------------------*/\r
-\r
-void vEventGroupDelete( EventGroupHandle_t xEventGroup )\r
-{\r
-EventGroup_t *pxEventBits = ( EventGroup_t * ) xEventGroup;\r
-const List_t *pxTasksWaitingForBits = &( pxEventBits->xTasksWaitingForBits );\r
-\r
- vTaskSuspendAll();\r
- {\r
- traceEVENT_GROUP_DELETE( xEventGroup );\r
-\r
- while( listCURRENT_LIST_LENGTH( pxTasksWaitingForBits ) > ( UBaseType_t ) 0 )\r
- {\r
- /* Unblock the task, returning 0 as the event list is being deleted\r
- and cannot therefore have any bits set. */\r
- configASSERT( pxTasksWaitingForBits->xListEnd.pxNext != ( const ListItem_t * ) &( pxTasksWaitingForBits->xListEnd ) );\r
- vTaskRemoveFromUnorderedEventList( pxTasksWaitingForBits->xListEnd.pxNext, eventUNBLOCKED_DUE_TO_BIT_SET );\r
- }\r
-\r
- #if( ( configSUPPORT_DYNAMIC_ALLOCATION == 1 ) && ( configSUPPORT_STATIC_ALLOCATION == 0 ) )\r
- {\r
- /* The event group can only have been allocated dynamically - free\r
- it again. */\r
- vPortFree( pxEventBits );\r
- }\r
- #elif( ( configSUPPORT_DYNAMIC_ALLOCATION == 1 ) && ( configSUPPORT_STATIC_ALLOCATION == 1 ) )\r
- {\r
- /* The event group could have been allocated statically or\r
- dynamically, so check before attempting to free the memory. */\r
- if( pxEventBits->ucStaticallyAllocated == ( uint8_t ) pdFALSE )\r
- {\r
- vPortFree( pxEventBits );\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- #endif /* configSUPPORT_DYNAMIC_ALLOCATION */\r
- }\r
- ( void ) xTaskResumeAll();\r
-}\r
-/*-----------------------------------------------------------*/\r
-\r
-/* For internal use only - execute a 'set bits' command that was pended from\r
-an interrupt. */\r
-void vEventGroupSetBitsCallback( void *pvEventGroup, const uint32_t ulBitsToSet )\r
-{\r
- ( void ) xEventGroupSetBits( pvEventGroup, ( EventBits_t ) ulBitsToSet );\r
-}\r
-/*-----------------------------------------------------------*/\r
-\r
-/* For internal use only - execute a 'clear bits' command that was pended from\r
-an interrupt. */\r
-void vEventGroupClearBitsCallback( void *pvEventGroup, const uint32_t ulBitsToClear )\r
-{\r
- ( void ) xEventGroupClearBits( pvEventGroup, ( EventBits_t ) ulBitsToClear );\r
-}\r
-/*-----------------------------------------------------------*/\r
-\r
-static BaseType_t prvTestWaitCondition( const EventBits_t uxCurrentEventBits, const EventBits_t uxBitsToWaitFor, const BaseType_t xWaitForAllBits )\r
-{\r
-BaseType_t xWaitConditionMet = pdFALSE;\r
-\r
- if( xWaitForAllBits == pdFALSE )\r
- {\r
- /* Task only has to wait for one bit within uxBitsToWaitFor to be\r
- set. Is one already set? */\r
- if( ( uxCurrentEventBits & uxBitsToWaitFor ) != ( EventBits_t ) 0 )\r
- {\r
- xWaitConditionMet = pdTRUE;\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- else\r
- {\r
- /* Task has to wait for all the bits in uxBitsToWaitFor to be set.\r
- Are they set already? */\r
- if( ( uxCurrentEventBits & uxBitsToWaitFor ) == uxBitsToWaitFor )\r
- {\r
- xWaitConditionMet = pdTRUE;\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
-\r
- return xWaitConditionMet;\r
-}\r
-/*-----------------------------------------------------------*/\r
-\r
-#if ( ( configUSE_TRACE_FACILITY == 1 ) && ( INCLUDE_xTimerPendFunctionCall == 1 ) && ( configUSE_TIMERS == 1 ) )\r
-\r
- BaseType_t xEventGroupSetBitsFromISR( EventGroupHandle_t xEventGroup, const EventBits_t uxBitsToSet, BaseType_t *pxHigherPriorityTaskWoken )\r
- {\r
- BaseType_t xReturn;\r
-\r
- traceEVENT_GROUP_SET_BITS_FROM_ISR( xEventGroup, uxBitsToSet );\r
- xReturn = xTimerPendFunctionCallFromISR( vEventGroupSetBitsCallback, ( void * ) xEventGroup, ( uint32_t ) uxBitsToSet, pxHigherPriorityTaskWoken );\r
-\r
- return xReturn;\r
- }\r
-\r
-#endif\r
-/*-----------------------------------------------------------*/\r
-\r
-#if (configUSE_TRACE_FACILITY == 1)\r
-\r
- UBaseType_t uxEventGroupGetNumber( void* xEventGroup )\r
- {\r
- UBaseType_t xReturn;\r
- EventGroup_t *pxEventBits = ( EventGroup_t * ) xEventGroup;\r
-\r
- if( xEventGroup == NULL )\r
- {\r
- xReturn = 0;\r
- }\r
- else\r
- {\r
- xReturn = pxEventBits->uxEventGroupNumber;\r
- }\r
-\r
- return xReturn;\r
- }\r
-\r
-#endif /* configUSE_TRACE_FACILITY */\r
-/*-----------------------------------------------------------*/\r
-\r
-#if ( configUSE_TRACE_FACILITY == 1 )\r
-\r
- void vEventGroupSetNumber( void * xEventGroup, UBaseType_t uxEventGroupNumber )\r
- {\r
- ( ( EventGroup_t * ) xEventGroup )->uxEventGroupNumber = uxEventGroupNumber;\r
- }\r
-\r
-#endif /* configUSE_TRACE_FACILITY */\r
-/*-----------------------------------------------------------*/\r
-\r
-\r
+++ /dev/null
-/*\r
- * FreeRTOS Kernel V10.0.1\r
- * Copyright (C) 2017 Amazon.com, Inc. or its affiliates. All Rights Reserved.\r
- *\r
- * Permission is hereby granted, free of charge, to any person obtaining a copy of\r
- * this software and associated documentation files (the "Software"), to deal in\r
- * the Software without restriction, including without limitation the rights to\r
- * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of\r
- * the Software, and to permit persons to whom the Software is furnished to do so,\r
- * subject to the following conditions:\r
- *\r
- * The above copyright notice and this permission notice shall be included in all\r
- * copies or substantial portions of the Software.\r
- *\r
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\r
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS\r
- * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR\r
- * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER\r
- * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN\r
- * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\r
- *\r
- * http://www.FreeRTOS.org\r
- * http://aws.amazon.com/freertos\r
- *\r
- * 1 tab == 4 spaces!\r
- */\r
-\r
-#ifndef INC_FREERTOS_H\r
-#define INC_FREERTOS_H\r
-\r
-/*\r
- * Include the generic headers required for the FreeRTOS port being used.\r
- */\r
-#include <stddef.h>\r
-\r
-/*\r
- * If stdint.h cannot be located then:\r
- * + If using GCC ensure the -nostdint options is *not* being used.\r
- * + Ensure the project's include path includes the directory in which your\r
- * compiler stores stdint.h.\r
- * + Set any compiler options necessary for it to support C99, as technically\r
- * stdint.h is only mandatory with C99 (FreeRTOS does not require C99 in any\r
- * other way).\r
- * + The FreeRTOS download includes a simple stdint.h definition that can be\r
- * used in cases where none is provided by the compiler. The files only\r
- * contains the typedefs required to build FreeRTOS. Read the instructions\r
- * in FreeRTOS/source/stdint.readme for more information.\r
- */\r
-#include <stdint.h> /* READ COMMENT ABOVE. */\r
-\r
-#ifdef __cplusplus\r
-extern "C" {\r
-#endif\r
-\r
-/* Application specific configuration options. */\r
-#include "FreeRTOSConfig.h"\r
-\r
-/* Basic FreeRTOS definitions. */\r
-#include "projdefs.h"\r
-\r
-/* Definitions specific to the port being used. */\r
-#include "portable.h"\r
-\r
-/* Must be defaulted before configUSE_NEWLIB_REENTRANT is used below. */\r
-#ifndef configUSE_NEWLIB_REENTRANT\r
- #define configUSE_NEWLIB_REENTRANT 0\r
-#endif\r
-\r
-/* Required if struct _reent is used. */\r
-#if ( configUSE_NEWLIB_REENTRANT == 1 )\r
- #include <reent.h>\r
-#endif\r
-/*\r
- * Check all the required application specific macros have been defined.\r
- * These macros are application specific and (as downloaded) are defined\r
- * within FreeRTOSConfig.h.\r
- */\r
-\r
-#ifndef configMINIMAL_STACK_SIZE\r
- #error Missing definition: configMINIMAL_STACK_SIZE must be defined in FreeRTOSConfig.h. configMINIMAL_STACK_SIZE defines the size (in words) of the stack allocated to the idle task. Refer to the demo project provided for your port for a suitable value.\r
-#endif\r
-\r
-#ifndef configMAX_PRIORITIES\r
- #error Missing definition: configMAX_PRIORITIES must be defined in FreeRTOSConfig.h. See the Configuration section of the FreeRTOS API documentation for details.\r
-#endif\r
-\r
-#if configMAX_PRIORITIES < 1\r
- #error configMAX_PRIORITIES must be defined to be greater than or equal to 1.\r
-#endif\r
-\r
-#ifndef configUSE_PREEMPTION\r
- #error Missing definition: configUSE_PREEMPTION must be defined in FreeRTOSConfig.h as either 1 or 0. See the Configuration section of the FreeRTOS API documentation for details.\r
-#endif\r
-\r
-#ifndef configUSE_IDLE_HOOK\r
- #error Missing definition: configUSE_IDLE_HOOK must be defined in FreeRTOSConfig.h as either 1 or 0. See the Configuration section of the FreeRTOS API documentation for details.\r
-#endif\r
-\r
-#ifndef configUSE_TICK_HOOK\r
- #error Missing definition: configUSE_TICK_HOOK must be defined in FreeRTOSConfig.h as either 1 or 0. See the Configuration section of the FreeRTOS API documentation for details.\r
-#endif\r
-\r
-#ifndef configUSE_16_BIT_TICKS\r
- #error Missing definition: configUSE_16_BIT_TICKS must be defined in FreeRTOSConfig.h as either 1 or 0. See the Configuration section of the FreeRTOS API documentation for details.\r
-#endif\r
-\r
-#ifndef configUSE_CO_ROUTINES\r
- #define configUSE_CO_ROUTINES 0\r
-#endif\r
-\r
-#ifndef INCLUDE_vTaskPrioritySet\r
- #define INCLUDE_vTaskPrioritySet 0\r
-#endif\r
-\r
-#ifndef INCLUDE_uxTaskPriorityGet\r
- #define INCLUDE_uxTaskPriorityGet 0\r
-#endif\r
-\r
-#ifndef INCLUDE_vTaskDelete\r
- #define INCLUDE_vTaskDelete 0\r
-#endif\r
-\r
-#ifndef INCLUDE_vTaskSuspend\r
- #define INCLUDE_vTaskSuspend 0\r
-#endif\r
-\r
-#ifndef INCLUDE_vTaskDelayUntil\r
- #define INCLUDE_vTaskDelayUntil 0\r
-#endif\r
-\r
-#ifndef INCLUDE_vTaskDelay\r
- #define INCLUDE_vTaskDelay 0\r
-#endif\r
-\r
-#ifndef INCLUDE_xTaskGetIdleTaskHandle\r
- #define INCLUDE_xTaskGetIdleTaskHandle 0\r
-#endif\r
-\r
-#ifndef INCLUDE_xTaskAbortDelay\r
- #define INCLUDE_xTaskAbortDelay 0\r
-#endif\r
-\r
-#ifndef INCLUDE_xQueueGetMutexHolder\r
- #define INCLUDE_xQueueGetMutexHolder 0\r
-#endif\r
-\r
-#ifndef INCLUDE_xSemaphoreGetMutexHolder\r
- #define INCLUDE_xSemaphoreGetMutexHolder INCLUDE_xQueueGetMutexHolder\r
-#endif\r
-\r
-#ifndef INCLUDE_xTaskGetHandle\r
- #define INCLUDE_xTaskGetHandle 0\r
-#endif\r
-\r
-#ifndef INCLUDE_uxTaskGetStackHighWaterMark\r
- #define INCLUDE_uxTaskGetStackHighWaterMark 0\r
-#endif\r
-\r
-#ifndef INCLUDE_eTaskGetState\r
- #define INCLUDE_eTaskGetState 0\r
-#endif\r
-\r
-#ifndef INCLUDE_xTaskResumeFromISR\r
- #define INCLUDE_xTaskResumeFromISR 1\r
-#endif\r
-\r
-#ifndef INCLUDE_xTimerPendFunctionCall\r
- #define INCLUDE_xTimerPendFunctionCall 0\r
-#endif\r
-\r
-#ifndef INCLUDE_xTaskGetSchedulerState\r
- #define INCLUDE_xTaskGetSchedulerState 0\r
-#endif\r
-\r
-#ifndef INCLUDE_xTaskGetCurrentTaskHandle\r
- #define INCLUDE_xTaskGetCurrentTaskHandle 0\r
-#endif\r
-\r
-#if configUSE_CO_ROUTINES != 0\r
- #ifndef configMAX_CO_ROUTINE_PRIORITIES\r
- #error configMAX_CO_ROUTINE_PRIORITIES must be greater than or equal to 1.\r
- #endif\r
-#endif\r
-\r
-#ifndef configUSE_DAEMON_TASK_STARTUP_HOOK\r
- #define configUSE_DAEMON_TASK_STARTUP_HOOK 0\r
-#endif\r
-\r
-#ifndef configUSE_APPLICATION_TASK_TAG\r
- #define configUSE_APPLICATION_TASK_TAG 0\r
-#endif\r
-\r
-#ifndef configNUM_THREAD_LOCAL_STORAGE_POINTERS\r
- #define configNUM_THREAD_LOCAL_STORAGE_POINTERS 0\r
-#endif\r
-\r
-#ifndef configUSE_RECURSIVE_MUTEXES\r
- #define configUSE_RECURSIVE_MUTEXES 0\r
-#endif\r
-\r
-#ifndef configUSE_MUTEXES\r
- #define configUSE_MUTEXES 0\r
-#endif\r
-\r
-#ifndef configUSE_TIMERS\r
- #define configUSE_TIMERS 0\r
-#endif\r
-\r
-#ifndef configUSE_COUNTING_SEMAPHORES\r
- #define configUSE_COUNTING_SEMAPHORES 0\r
-#endif\r
-\r
-#ifndef configUSE_ALTERNATIVE_API\r
- #define configUSE_ALTERNATIVE_API 0\r
-#endif\r
-\r
-#ifndef portCRITICAL_NESTING_IN_TCB\r
- #define portCRITICAL_NESTING_IN_TCB 0\r
-#endif\r
-\r
-#ifndef configMAX_TASK_NAME_LEN\r
- #define configMAX_TASK_NAME_LEN 16\r
-#endif\r
-\r
-#ifndef configIDLE_SHOULD_YIELD\r
- #define configIDLE_SHOULD_YIELD 1\r
-#endif\r
-\r
-#if configMAX_TASK_NAME_LEN < 1\r
- #error configMAX_TASK_NAME_LEN must be set to a minimum of 1 in FreeRTOSConfig.h\r
-#endif\r
-\r
-#ifndef configASSERT\r
- #define configASSERT( x )\r
- #define configASSERT_DEFINED 0\r
-#else\r
- #define configASSERT_DEFINED 1\r
-#endif\r
-\r
-/* The timers module relies on xTaskGetSchedulerState(). */\r
-#if configUSE_TIMERS == 1\r
-\r
- #ifndef configTIMER_TASK_PRIORITY\r
- #error If configUSE_TIMERS is set to 1 then configTIMER_TASK_PRIORITY must also be defined.\r
- #endif /* configTIMER_TASK_PRIORITY */\r
-\r
- #ifndef configTIMER_QUEUE_LENGTH\r
- #error If configUSE_TIMERS is set to 1 then configTIMER_QUEUE_LENGTH must also be defined.\r
- #endif /* configTIMER_QUEUE_LENGTH */\r
-\r
- #ifndef configTIMER_TASK_STACK_DEPTH\r
- #error If configUSE_TIMERS is set to 1 then configTIMER_TASK_STACK_DEPTH must also be defined.\r
- #endif /* configTIMER_TASK_STACK_DEPTH */\r
-\r
-#endif /* configUSE_TIMERS */\r
-\r
-#ifndef portSET_INTERRUPT_MASK_FROM_ISR\r
- #define portSET_INTERRUPT_MASK_FROM_ISR() 0\r
-#endif\r
-\r
-#ifndef portCLEAR_INTERRUPT_MASK_FROM_ISR\r
- #define portCLEAR_INTERRUPT_MASK_FROM_ISR( uxSavedStatusValue ) ( void ) uxSavedStatusValue\r
-#endif\r
-\r
-#ifndef portCLEAN_UP_TCB\r
- #define portCLEAN_UP_TCB( pxTCB ) ( void ) pxTCB\r
-#endif\r
-\r
-#ifndef portPRE_TASK_DELETE_HOOK\r
- #define portPRE_TASK_DELETE_HOOK( pvTaskToDelete, pxYieldPending )\r
-#endif\r
-\r
-#ifndef portSETUP_TCB\r
- #define portSETUP_TCB( pxTCB ) ( void ) pxTCB\r
-#endif\r
-\r
-#ifndef configQUEUE_REGISTRY_SIZE\r
- #define configQUEUE_REGISTRY_SIZE 0U\r
-#endif\r
-\r
-#if ( configQUEUE_REGISTRY_SIZE < 1 )\r
- #define vQueueAddToRegistry( xQueue, pcName )\r
- #define vQueueUnregisterQueue( xQueue )\r
- #define pcQueueGetName( xQueue )\r
-#endif\r
-\r
-#ifndef portPOINTER_SIZE_TYPE\r
- #define portPOINTER_SIZE_TYPE uint32_t\r
-#endif\r
-\r
-/* Remove any unused trace macros. */\r
-#ifndef traceSTART\r
- /* Used to perform any necessary initialisation - for example, open a file\r
- into which trace is to be written. */\r
- #define traceSTART()\r
-#endif\r
-\r
-#ifndef traceEND\r
- /* Use to close a trace, for example close a file into which trace has been\r
- written. */\r
- #define traceEND()\r
-#endif\r
-\r
-#ifndef traceTASK_SWITCHED_IN\r
- /* Called after a task has been selected to run. pxCurrentTCB holds a pointer\r
- to the task control block of the selected task. */\r
- #define traceTASK_SWITCHED_IN()\r
-#endif\r
-\r
-#ifndef traceINCREASE_TICK_COUNT\r
- /* Called before stepping the tick count after waking from tickless idle\r
- sleep. */\r
- #define traceINCREASE_TICK_COUNT( x )\r
-#endif\r
-\r
-#ifndef traceLOW_POWER_IDLE_BEGIN\r
- /* Called immediately before entering tickless idle. */\r
- #define traceLOW_POWER_IDLE_BEGIN()\r
-#endif\r
-\r
-#ifndef traceLOW_POWER_IDLE_END\r
- /* Called when returning to the Idle task after a tickless idle. */\r
- #define traceLOW_POWER_IDLE_END()\r
-#endif\r
-\r
-#ifndef traceTASK_SWITCHED_OUT\r
- /* Called before a task has been selected to run. pxCurrentTCB holds a pointer\r
- to the task control block of the task being switched out. */\r
- #define traceTASK_SWITCHED_OUT()\r
-#endif\r
-\r
-#ifndef traceTASK_PRIORITY_INHERIT\r
- /* Called when a task attempts to take a mutex that is already held by a\r
- lower priority task. pxTCBOfMutexHolder is a pointer to the TCB of the task\r
- that holds the mutex. uxInheritedPriority is the priority the mutex holder\r
- will inherit (the priority of the task that is attempting to obtain the\r
- muted. */\r
- #define traceTASK_PRIORITY_INHERIT( pxTCBOfMutexHolder, uxInheritedPriority )\r
-#endif\r
-\r
-#ifndef traceTASK_PRIORITY_DISINHERIT\r
- /* Called when a task releases a mutex, the holding of which had resulted in\r
- the task inheriting the priority of a higher priority task.\r
- pxTCBOfMutexHolder is a pointer to the TCB of the task that is releasing the\r
- mutex. uxOriginalPriority is the task's configured (base) priority. */\r
- #define traceTASK_PRIORITY_DISINHERIT( pxTCBOfMutexHolder, uxOriginalPriority )\r
-#endif\r
-\r
-#ifndef traceBLOCKING_ON_QUEUE_RECEIVE\r
- /* Task is about to block because it cannot read from a\r
- queue/mutex/semaphore. pxQueue is a pointer to the queue/mutex/semaphore\r
- upon which the read was attempted. pxCurrentTCB points to the TCB of the\r
- task that attempted the read. */\r
- #define traceBLOCKING_ON_QUEUE_RECEIVE( pxQueue )\r
-#endif\r
-\r
-#ifndef traceBLOCKING_ON_QUEUE_PEEK\r
- /* Task is about to block because it cannot read from a\r
- queue/mutex/semaphore. pxQueue is a pointer to the queue/mutex/semaphore\r
- upon which the read was attempted. pxCurrentTCB points to the TCB of the\r
- task that attempted the read. */\r
- #define traceBLOCKING_ON_QUEUE_PEEK( pxQueue )\r
-#endif\r
-\r
-#ifndef traceBLOCKING_ON_QUEUE_SEND\r
- /* Task is about to block because it cannot write to a\r
- queue/mutex/semaphore. pxQueue is a pointer to the queue/mutex/semaphore\r
- upon which the write was attempted. pxCurrentTCB points to the TCB of the\r
- task that attempted the write. */\r
- #define traceBLOCKING_ON_QUEUE_SEND( pxQueue )\r
-#endif\r
-\r
-#ifndef configCHECK_FOR_STACK_OVERFLOW\r
- #define configCHECK_FOR_STACK_OVERFLOW 0\r
-#endif\r
-\r
-#ifndef configRECORD_STACK_HIGH_ADDRESS\r
- #define configRECORD_STACK_HIGH_ADDRESS 0\r
-#endif\r
-\r
-#ifndef configINCLUDE_FREERTOS_TASK_C_ADDITIONS_H\r
- #define configINCLUDE_FREERTOS_TASK_C_ADDITIONS_H 0\r
-#endif\r
-\r
-/* The following event macros are embedded in the kernel API calls. */\r
-\r
-#ifndef traceMOVED_TASK_TO_READY_STATE\r
- #define traceMOVED_TASK_TO_READY_STATE( pxTCB )\r
-#endif\r
-\r
-#ifndef tracePOST_MOVED_TASK_TO_READY_STATE\r
- #define tracePOST_MOVED_TASK_TO_READY_STATE( pxTCB )\r
-#endif\r
-\r
-#ifndef traceQUEUE_CREATE\r
- #define traceQUEUE_CREATE( pxNewQueue )\r
-#endif\r
-\r
-#ifndef traceQUEUE_CREATE_FAILED\r
- #define traceQUEUE_CREATE_FAILED( ucQueueType )\r
-#endif\r
-\r
-#ifndef traceCREATE_MUTEX\r
- #define traceCREATE_MUTEX( pxNewQueue )\r
-#endif\r
-\r
-#ifndef traceCREATE_MUTEX_FAILED\r
- #define traceCREATE_MUTEX_FAILED()\r
-#endif\r
-\r
-#ifndef traceGIVE_MUTEX_RECURSIVE\r
- #define traceGIVE_MUTEX_RECURSIVE( pxMutex )\r
-#endif\r
-\r
-#ifndef traceGIVE_MUTEX_RECURSIVE_FAILED\r
- #define traceGIVE_MUTEX_RECURSIVE_FAILED( pxMutex )\r
-#endif\r
-\r
-#ifndef traceTAKE_MUTEX_RECURSIVE\r
- #define traceTAKE_MUTEX_RECURSIVE( pxMutex )\r
-#endif\r
-\r
-#ifndef traceTAKE_MUTEX_RECURSIVE_FAILED\r
- #define traceTAKE_MUTEX_RECURSIVE_FAILED( pxMutex )\r
-#endif\r
-\r
-#ifndef traceCREATE_COUNTING_SEMAPHORE\r
- #define traceCREATE_COUNTING_SEMAPHORE()\r
-#endif\r
-\r
-#ifndef traceCREATE_COUNTING_SEMAPHORE_FAILED\r
- #define traceCREATE_COUNTING_SEMAPHORE_FAILED()\r
-#endif\r
-\r
-#ifndef traceQUEUE_SEND\r
- #define traceQUEUE_SEND( pxQueue )\r
-#endif\r
-\r
-#ifndef traceQUEUE_SEND_FAILED\r
- #define traceQUEUE_SEND_FAILED( pxQueue )\r
-#endif\r
-\r
-#ifndef traceQUEUE_RECEIVE\r
- #define traceQUEUE_RECEIVE( pxQueue )\r
-#endif\r
-\r
-#ifndef traceQUEUE_PEEK\r
- #define traceQUEUE_PEEK( pxQueue )\r
-#endif\r
-\r
-#ifndef traceQUEUE_PEEK_FAILED\r
- #define traceQUEUE_PEEK_FAILED( pxQueue )\r
-#endif\r
-\r
-#ifndef traceQUEUE_PEEK_FROM_ISR\r
- #define traceQUEUE_PEEK_FROM_ISR( pxQueue )\r
-#endif\r
-\r
-#ifndef traceQUEUE_RECEIVE_FAILED\r
- #define traceQUEUE_RECEIVE_FAILED( pxQueue )\r
-#endif\r
-\r
-#ifndef traceQUEUE_SEND_FROM_ISR\r
- #define traceQUEUE_SEND_FROM_ISR( pxQueue )\r
-#endif\r
-\r
-#ifndef traceQUEUE_SEND_FROM_ISR_FAILED\r
- #define traceQUEUE_SEND_FROM_ISR_FAILED( pxQueue )\r
-#endif\r
-\r
-#ifndef traceQUEUE_RECEIVE_FROM_ISR\r
- #define traceQUEUE_RECEIVE_FROM_ISR( pxQueue )\r
-#endif\r
-\r
-#ifndef traceQUEUE_RECEIVE_FROM_ISR_FAILED\r
- #define traceQUEUE_RECEIVE_FROM_ISR_FAILED( pxQueue )\r
-#endif\r
-\r
-#ifndef traceQUEUE_PEEK_FROM_ISR_FAILED\r
- #define traceQUEUE_PEEK_FROM_ISR_FAILED( pxQueue )\r
-#endif\r
-\r
-#ifndef traceQUEUE_DELETE\r
- #define traceQUEUE_DELETE( pxQueue )\r
-#endif\r
-\r
-#ifndef traceTASK_CREATE\r
- #define traceTASK_CREATE( pxNewTCB )\r
-#endif\r
-\r
-#ifndef traceTASK_CREATE_FAILED\r
- #define traceTASK_CREATE_FAILED()\r
-#endif\r
-\r
-#ifndef traceTASK_DELETE\r
- #define traceTASK_DELETE( pxTaskToDelete )\r
-#endif\r
-\r
-#ifndef traceTASK_DELAY_UNTIL\r
- #define traceTASK_DELAY_UNTIL( x )\r
-#endif\r
-\r
-#ifndef traceTASK_DELAY\r
- #define traceTASK_DELAY()\r
-#endif\r
-\r
-#ifndef traceTASK_PRIORITY_SET\r
- #define traceTASK_PRIORITY_SET( pxTask, uxNewPriority )\r
-#endif\r
-\r
-#ifndef traceTASK_SUSPEND\r
- #define traceTASK_SUSPEND( pxTaskToSuspend )\r
-#endif\r
-\r
-#ifndef traceTASK_RESUME\r
- #define traceTASK_RESUME( pxTaskToResume )\r
-#endif\r
-\r
-#ifndef traceTASK_RESUME_FROM_ISR\r
- #define traceTASK_RESUME_FROM_ISR( pxTaskToResume )\r
-#endif\r
-\r
-#ifndef traceTASK_INCREMENT_TICK\r
- #define traceTASK_INCREMENT_TICK( xTickCount )\r
-#endif\r
-\r
-#ifndef traceTIMER_CREATE\r
- #define traceTIMER_CREATE( pxNewTimer )\r
-#endif\r
-\r
-#ifndef traceTIMER_CREATE_FAILED\r
- #define traceTIMER_CREATE_FAILED()\r
-#endif\r
-\r
-#ifndef traceTIMER_COMMAND_SEND\r
- #define traceTIMER_COMMAND_SEND( xTimer, xMessageID, xMessageValueValue, xReturn )\r
-#endif\r
-\r
-#ifndef traceTIMER_EXPIRED\r
- #define traceTIMER_EXPIRED( pxTimer )\r
-#endif\r
-\r
-#ifndef traceTIMER_COMMAND_RECEIVED\r
- #define traceTIMER_COMMAND_RECEIVED( pxTimer, xMessageID, xMessageValue )\r
-#endif\r
-\r
-#ifndef traceMALLOC\r
- #define traceMALLOC( pvAddress, uiSize )\r
-#endif\r
-\r
-#ifndef traceFREE\r
- #define traceFREE( pvAddress, uiSize )\r
-#endif\r
-\r
-#ifndef traceEVENT_GROUP_CREATE\r
- #define traceEVENT_GROUP_CREATE( xEventGroup )\r
-#endif\r
-\r
-#ifndef traceEVENT_GROUP_CREATE_FAILED\r
- #define traceEVENT_GROUP_CREATE_FAILED()\r
-#endif\r
-\r
-#ifndef traceEVENT_GROUP_SYNC_BLOCK\r
- #define traceEVENT_GROUP_SYNC_BLOCK( xEventGroup, uxBitsToSet, uxBitsToWaitFor )\r
-#endif\r
-\r
-#ifndef traceEVENT_GROUP_SYNC_END\r
- #define traceEVENT_GROUP_SYNC_END( xEventGroup, uxBitsToSet, uxBitsToWaitFor, xTimeoutOccurred ) ( void ) xTimeoutOccurred\r
-#endif\r
-\r
-#ifndef traceEVENT_GROUP_WAIT_BITS_BLOCK\r
- #define traceEVENT_GROUP_WAIT_BITS_BLOCK( xEventGroup, uxBitsToWaitFor )\r
-#endif\r
-\r
-#ifndef traceEVENT_GROUP_WAIT_BITS_END\r
- #define traceEVENT_GROUP_WAIT_BITS_END( xEventGroup, uxBitsToWaitFor, xTimeoutOccurred ) ( void ) xTimeoutOccurred\r
-#endif\r
-\r
-#ifndef traceEVENT_GROUP_CLEAR_BITS\r
- #define traceEVENT_GROUP_CLEAR_BITS( xEventGroup, uxBitsToClear )\r
-#endif\r
-\r
-#ifndef traceEVENT_GROUP_CLEAR_BITS_FROM_ISR\r
- #define traceEVENT_GROUP_CLEAR_BITS_FROM_ISR( xEventGroup, uxBitsToClear )\r
-#endif\r
-\r
-#ifndef traceEVENT_GROUP_SET_BITS\r
- #define traceEVENT_GROUP_SET_BITS( xEventGroup, uxBitsToSet )\r
-#endif\r
-\r
-#ifndef traceEVENT_GROUP_SET_BITS_FROM_ISR\r
- #define traceEVENT_GROUP_SET_BITS_FROM_ISR( xEventGroup, uxBitsToSet )\r
-#endif\r
-\r
-#ifndef traceEVENT_GROUP_DELETE\r
- #define traceEVENT_GROUP_DELETE( xEventGroup )\r
-#endif\r
-\r
-#ifndef tracePEND_FUNC_CALL\r
- #define tracePEND_FUNC_CALL(xFunctionToPend, pvParameter1, ulParameter2, ret)\r
-#endif\r
-\r
-#ifndef tracePEND_FUNC_CALL_FROM_ISR\r
- #define tracePEND_FUNC_CALL_FROM_ISR(xFunctionToPend, pvParameter1, ulParameter2, ret)\r
-#endif\r
-\r
-#ifndef traceQUEUE_REGISTRY_ADD\r
- #define traceQUEUE_REGISTRY_ADD(xQueue, pcQueueName)\r
-#endif\r
-\r
-#ifndef traceTASK_NOTIFY_TAKE_BLOCK\r
- #define traceTASK_NOTIFY_TAKE_BLOCK()\r
-#endif\r
-\r
-#ifndef traceTASK_NOTIFY_TAKE\r
- #define traceTASK_NOTIFY_TAKE()\r
-#endif\r
-\r
-#ifndef traceTASK_NOTIFY_WAIT_BLOCK\r
- #define traceTASK_NOTIFY_WAIT_BLOCK()\r
-#endif\r
-\r
-#ifndef traceTASK_NOTIFY_WAIT\r
- #define traceTASK_NOTIFY_WAIT()\r
-#endif\r
-\r
-#ifndef traceTASK_NOTIFY\r
- #define traceTASK_NOTIFY()\r
-#endif\r
-\r
-#ifndef traceTASK_NOTIFY_FROM_ISR\r
- #define traceTASK_NOTIFY_FROM_ISR()\r
-#endif\r
-\r
-#ifndef traceTASK_NOTIFY_GIVE_FROM_ISR\r
- #define traceTASK_NOTIFY_GIVE_FROM_ISR()\r
-#endif\r
-\r
-#ifndef traceSTREAM_BUFFER_CREATE_FAILED\r
- #define traceSTREAM_BUFFER_CREATE_FAILED( xIsMessageBuffer )\r
-#endif\r
-\r
-#ifndef traceSTREAM_BUFFER_CREATE_STATIC_FAILED\r
- #define traceSTREAM_BUFFER_CREATE_STATIC_FAILED( xReturn, xIsMessageBuffer )\r
-#endif\r
-\r
-#ifndef traceSTREAM_BUFFER_CREATE\r
- #define traceSTREAM_BUFFER_CREATE( pxStreamBuffer, xIsMessageBuffer )\r
-#endif\r
-\r
-#ifndef traceSTREAM_BUFFER_DELETE\r
- #define traceSTREAM_BUFFER_DELETE( xStreamBuffer )\r
-#endif\r
-\r
-#ifndef traceSTREAM_BUFFER_RESET\r
- #define traceSTREAM_BUFFER_RESET( xStreamBuffer )\r
-#endif\r
-\r
-#ifndef traceBLOCKING_ON_STREAM_BUFFER_SEND\r
- #define traceBLOCKING_ON_STREAM_BUFFER_SEND( xStreamBuffer )\r
-#endif\r
-\r
-#ifndef traceSTREAM_BUFFER_SEND\r
- #define traceSTREAM_BUFFER_SEND( xStreamBuffer, xBytesSent )\r
-#endif\r
-\r
-#ifndef traceSTREAM_BUFFER_SEND_FAILED\r
- #define traceSTREAM_BUFFER_SEND_FAILED( xStreamBuffer )\r
-#endif\r
-\r
-#ifndef traceSTREAM_BUFFER_SEND_FROM_ISR\r
- #define traceSTREAM_BUFFER_SEND_FROM_ISR( xStreamBuffer, xBytesSent )\r
-#endif\r
-\r
-#ifndef traceBLOCKING_ON_STREAM_BUFFER_RECEIVE\r
- #define traceBLOCKING_ON_STREAM_BUFFER_RECEIVE( xStreamBuffer )\r
-#endif\r
-\r
-#ifndef traceSTREAM_BUFFER_RECEIVE\r
- #define traceSTREAM_BUFFER_RECEIVE( xStreamBuffer, xReceivedLength )\r
-#endif\r
-\r
-#ifndef traceSTREAM_BUFFER_RECEIVE_FAILED\r
- #define traceSTREAM_BUFFER_RECEIVE_FAILED( xStreamBuffer )\r
-#endif\r
-\r
-#ifndef traceSTREAM_BUFFER_RECEIVE_FROM_ISR\r
- #define traceSTREAM_BUFFER_RECEIVE_FROM_ISR( xStreamBuffer, xReceivedLength )\r
-#endif\r
-\r
-#ifndef configGENERATE_RUN_TIME_STATS\r
- #define configGENERATE_RUN_TIME_STATS 0\r
-#endif\r
-\r
-#if ( configGENERATE_RUN_TIME_STATS == 1 )\r
-\r
- #ifndef portCONFIGURE_TIMER_FOR_RUN_TIME_STATS\r
- #error If configGENERATE_RUN_TIME_STATS is defined then portCONFIGURE_TIMER_FOR_RUN_TIME_STATS must also be defined. portCONFIGURE_TIMER_FOR_RUN_TIME_STATS should call a port layer function to setup a peripheral timer/counter that can then be used as the run time counter time base.\r
- #endif /* portCONFIGURE_TIMER_FOR_RUN_TIME_STATS */\r
-\r
- #ifndef portGET_RUN_TIME_COUNTER_VALUE\r
- #ifndef portALT_GET_RUN_TIME_COUNTER_VALUE\r
- #error If configGENERATE_RUN_TIME_STATS is defined then either portGET_RUN_TIME_COUNTER_VALUE or portALT_GET_RUN_TIME_COUNTER_VALUE must also be defined. See the examples provided and the FreeRTOS web site for more information.\r
- #endif /* portALT_GET_RUN_TIME_COUNTER_VALUE */\r
- #endif /* portGET_RUN_TIME_COUNTER_VALUE */\r
-\r
-#endif /* configGENERATE_RUN_TIME_STATS */\r
-\r
-#ifndef portCONFIGURE_TIMER_FOR_RUN_TIME_STATS\r
- #define portCONFIGURE_TIMER_FOR_RUN_TIME_STATS()\r
-#endif\r
-\r
-#ifndef configUSE_MALLOC_FAILED_HOOK\r
- #define configUSE_MALLOC_FAILED_HOOK 0\r
-#endif\r
-\r
-#ifndef portPRIVILEGE_BIT\r
- #define portPRIVILEGE_BIT ( ( UBaseType_t ) 0x00 )\r
-#endif\r
-\r
-#ifndef portYIELD_WITHIN_API\r
- #define portYIELD_WITHIN_API portYIELD\r
-#endif\r
-\r
-#ifndef portSUPPRESS_TICKS_AND_SLEEP\r
- #define portSUPPRESS_TICKS_AND_SLEEP( xExpectedIdleTime )\r
-#endif\r
-\r
-#ifndef configEXPECTED_IDLE_TIME_BEFORE_SLEEP\r
- #define configEXPECTED_IDLE_TIME_BEFORE_SLEEP 2\r
-#endif\r
-\r
-#if configEXPECTED_IDLE_TIME_BEFORE_SLEEP < 2\r
- #error configEXPECTED_IDLE_TIME_BEFORE_SLEEP must not be less than 2\r
-#endif\r
-\r
-#ifndef configUSE_TICKLESS_IDLE\r
- #define configUSE_TICKLESS_IDLE 0\r
-#endif\r
-\r
-#ifndef configPRE_SUPPRESS_TICKS_AND_SLEEP_PROCESSING\r
- #define configPRE_SUPPRESS_TICKS_AND_SLEEP_PROCESSING( x )\r
-#endif\r
-\r
-#ifndef configPRE_SLEEP_PROCESSING\r
- #define configPRE_SLEEP_PROCESSING( x )\r
-#endif\r
-\r
-#ifndef configPOST_SLEEP_PROCESSING\r
- #define configPOST_SLEEP_PROCESSING( x )\r
-#endif\r
-\r
-#ifndef configUSE_QUEUE_SETS\r
- #define configUSE_QUEUE_SETS 0\r
-#endif\r
-\r
-#ifndef portTASK_USES_FLOATING_POINT\r
- #define portTASK_USES_FLOATING_POINT()\r
-#endif\r
-\r
-#ifndef portTASK_CALLS_SECURE_FUNCTIONS\r
- #define portTASK_CALLS_SECURE_FUNCTIONS()\r
-#endif\r
-\r
-#ifndef configUSE_TIME_SLICING\r
- #define configUSE_TIME_SLICING 1\r
-#endif\r
-\r
-#ifndef configINCLUDE_APPLICATION_DEFINED_PRIVILEGED_FUNCTIONS\r
- #define configINCLUDE_APPLICATION_DEFINED_PRIVILEGED_FUNCTIONS 0\r
-#endif\r
-\r
-#ifndef configUSE_STATS_FORMATTING_FUNCTIONS\r
- #define configUSE_STATS_FORMATTING_FUNCTIONS 0\r
-#endif\r
-\r
-#ifndef portASSERT_IF_INTERRUPT_PRIORITY_INVALID\r
- #define portASSERT_IF_INTERRUPT_PRIORITY_INVALID()\r
-#endif\r
-\r
-#ifndef configUSE_TRACE_FACILITY\r
- #define configUSE_TRACE_FACILITY 0\r
-#endif\r
-\r
-#ifndef mtCOVERAGE_TEST_MARKER\r
- #define mtCOVERAGE_TEST_MARKER()\r
-#endif\r
-\r
-#ifndef mtCOVERAGE_TEST_DELAY\r
- #define mtCOVERAGE_TEST_DELAY()\r
-#endif\r
-\r
-#ifndef portASSERT_IF_IN_ISR\r
- #define portASSERT_IF_IN_ISR()\r
-#endif\r
-\r
-#ifndef configUSE_PORT_OPTIMISED_TASK_SELECTION\r
- #define configUSE_PORT_OPTIMISED_TASK_SELECTION 0\r
-#endif\r
-\r
-#ifndef configAPPLICATION_ALLOCATED_HEAP\r
- #define configAPPLICATION_ALLOCATED_HEAP 0\r
-#endif\r
-\r
-#ifndef configUSE_TASK_NOTIFICATIONS\r
- #define configUSE_TASK_NOTIFICATIONS 1\r
-#endif\r
-\r
-#ifndef portTICK_TYPE_IS_ATOMIC\r
- #define portTICK_TYPE_IS_ATOMIC 0\r
-#endif\r
-\r
-#ifndef configSUPPORT_STATIC_ALLOCATION\r
- /* Defaults to 0 for backward compatibility. */\r
- #define configSUPPORT_STATIC_ALLOCATION 0\r
-#endif\r
-\r
-#ifndef configSUPPORT_DYNAMIC_ALLOCATION\r
- /* Defaults to 1 for backward compatibility. */\r
- #define configSUPPORT_DYNAMIC_ALLOCATION 1\r
-#endif\r
-\r
-#ifndef configSTACK_DEPTH_TYPE\r
- /* Defaults to uint16_t for backward compatibility, but can be overridden\r
- in FreeRTOSConfig.h if uint16_t is too restrictive. */\r
- #define configSTACK_DEPTH_TYPE uint16_t\r
-#endif\r
-\r
-/* Sanity check the configuration. */\r
-#if( configUSE_TICKLESS_IDLE != 0 )\r
- #if( INCLUDE_vTaskSuspend != 1 )\r
- #error INCLUDE_vTaskSuspend must be set to 1 if configUSE_TICKLESS_IDLE is not set to 0\r
- #endif /* INCLUDE_vTaskSuspend */\r
-#endif /* configUSE_TICKLESS_IDLE */\r
-\r
-#if( ( configSUPPORT_STATIC_ALLOCATION == 0 ) && ( configSUPPORT_DYNAMIC_ALLOCATION == 0 ) )\r
- #error configSUPPORT_STATIC_ALLOCATION and configSUPPORT_DYNAMIC_ALLOCATION cannot both be 0, but can both be 1.\r
-#endif\r
-\r
-#if( ( configUSE_RECURSIVE_MUTEXES == 1 ) && ( configUSE_MUTEXES != 1 ) )\r
- #error configUSE_MUTEXES must be set to 1 to use recursive mutexes\r
-#endif\r
-\r
-#ifndef configINITIAL_TICK_COUNT\r
- #define configINITIAL_TICK_COUNT 0\r
-#endif\r
-\r
-#if( portTICK_TYPE_IS_ATOMIC == 0 )\r
- /* Either variables of tick type cannot be read atomically, or\r
- portTICK_TYPE_IS_ATOMIC was not set - map the critical sections used when\r
- the tick count is returned to the standard critical section macros. */\r
- #define portTICK_TYPE_ENTER_CRITICAL() portENTER_CRITICAL()\r
- #define portTICK_TYPE_EXIT_CRITICAL() portEXIT_CRITICAL()\r
- #define portTICK_TYPE_SET_INTERRUPT_MASK_FROM_ISR() portSET_INTERRUPT_MASK_FROM_ISR()\r
- #define portTICK_TYPE_CLEAR_INTERRUPT_MASK_FROM_ISR( x ) portCLEAR_INTERRUPT_MASK_FROM_ISR( ( x ) )\r
-#else\r
- /* The tick type can be read atomically, so critical sections used when the\r
- tick count is returned can be defined away. */\r
- #define portTICK_TYPE_ENTER_CRITICAL()\r
- #define portTICK_TYPE_EXIT_CRITICAL()\r
- #define portTICK_TYPE_SET_INTERRUPT_MASK_FROM_ISR() 0\r
- #define portTICK_TYPE_CLEAR_INTERRUPT_MASK_FROM_ISR( x ) ( void ) x\r
-#endif\r
-\r
-/* Definitions to allow backward compatibility with FreeRTOS versions prior to\r
-V8 if desired. */\r
-#ifndef configENABLE_BACKWARD_COMPATIBILITY\r
- #define configENABLE_BACKWARD_COMPATIBILITY 1\r
-#endif\r
-\r
-#ifndef configPRINTF\r
- /* configPRINTF() was not defined, so define it away to nothing. To use\r
- configPRINTF() then define it as follows (where MyPrintFunction() is\r
- provided by the application writer):\r
-\r
- void MyPrintFunction(const char *pcFormat, ... );\r
- #define configPRINTF( X ) MyPrintFunction X\r
-\r
- Then call like a standard printf() function, but placing brackets around\r
- all parameters so they are passed as a single parameter. For example:\r
- configPRINTF( ("Value = %d", MyVariable) ); */\r
- #define configPRINTF( X )\r
-#endif\r
-\r
-#ifndef configMAX\r
- /* The application writer has not provided their own MAX macro, so define\r
- the following generic implementation. */\r
- #define configMAX( a, b ) ( ( ( a ) > ( b ) ) ? ( a ) : ( b ) )\r
-#endif\r
-\r
-#ifndef configMIN\r
- /* The application writer has not provided their own MAX macro, so define\r
- the following generic implementation. */\r
- #define configMIN( a, b ) ( ( ( a ) < ( b ) ) ? ( a ) : ( b ) )\r
-#endif\r
-\r
-#if configENABLE_BACKWARD_COMPATIBILITY == 1\r
- #define eTaskStateGet eTaskGetState\r
- #define portTickType TickType_t\r
- #define xTaskHandle TaskHandle_t\r
- #define xQueueHandle QueueHandle_t\r
- #define xSemaphoreHandle SemaphoreHandle_t\r
- #define xQueueSetHandle QueueSetHandle_t\r
- #define xQueueSetMemberHandle QueueSetMemberHandle_t\r
- #define xTimeOutType TimeOut_t\r
- #define xMemoryRegion MemoryRegion_t\r
- #define xTaskParameters TaskParameters_t\r
- #define xTaskStatusType TaskStatus_t\r
- #define xTimerHandle TimerHandle_t\r
- #define xCoRoutineHandle CoRoutineHandle_t\r
- #define pdTASK_HOOK_CODE TaskHookFunction_t\r
- #define portTICK_RATE_MS portTICK_PERIOD_MS\r
- #define pcTaskGetTaskName pcTaskGetName\r
- #define pcTimerGetTimerName pcTimerGetName\r
- #define pcQueueGetQueueName pcQueueGetName\r
- #define vTaskGetTaskInfo vTaskGetInfo\r
-\r
- /* Backward compatibility within the scheduler code only - these definitions\r
- are not really required but are included for completeness. */\r
- #define tmrTIMER_CALLBACK TimerCallbackFunction_t\r
- #define pdTASK_CODE TaskFunction_t\r
- #define xListItem ListItem_t\r
- #define xList List_t\r
-#endif /* configENABLE_BACKWARD_COMPATIBILITY */\r
-\r
-#if( configUSE_ALTERNATIVE_API != 0 )\r
- #error The alternative API was deprecated some time ago, and was removed in FreeRTOS V9.0 0\r
-#endif\r
-\r
-/* Set configUSE_TASK_FPU_SUPPORT to 0 to omit floating point support even\r
-if floating point hardware is otherwise supported by the FreeRTOS port in use.\r
-This constant is not supported by all FreeRTOS ports that include floating\r
-point support. */\r
-#ifndef configUSE_TASK_FPU_SUPPORT\r
- #define configUSE_TASK_FPU_SUPPORT 1\r
-#endif\r
-\r
-/*\r
- * In line with software engineering best practice, FreeRTOS implements a strict\r
- * data hiding policy, so the real structures used by FreeRTOS to maintain the\r
- * state of tasks, queues, semaphores, etc. are not accessible to the application\r
- * code. However, if the application writer wants to statically allocate such\r
- * an object then the size of the object needs to be know. Dummy structures\r
- * that are guaranteed to have the same size and alignment requirements of the\r
- * real objects are used for this purpose. The dummy list and list item\r
- * structures below are used for inclusion in such a dummy structure.\r
- */\r
-struct xSTATIC_LIST_ITEM\r
-{\r
- TickType_t xDummy1;\r
- void *pvDummy2[ 4 ];\r
-};\r
-typedef struct xSTATIC_LIST_ITEM StaticListItem_t;\r
-\r
-/* See the comments above the struct xSTATIC_LIST_ITEM definition. */\r
-struct xSTATIC_MINI_LIST_ITEM\r
-{\r
- TickType_t xDummy1;\r
- void *pvDummy2[ 2 ];\r
-};\r
-typedef struct xSTATIC_MINI_LIST_ITEM StaticMiniListItem_t;\r
-\r
-/* See the comments above the struct xSTATIC_LIST_ITEM definition. */\r
-typedef struct xSTATIC_LIST\r
-{\r
- UBaseType_t uxDummy1;\r
- void *pvDummy2;\r
- StaticMiniListItem_t xDummy3;\r
-} StaticList_t;\r
-\r
-/*\r
- * In line with software engineering best practice, especially when supplying a\r
- * library that is likely to change in future versions, FreeRTOS implements a\r
- * strict data hiding policy. This means the Task structure used internally by\r
- * FreeRTOS is not accessible to application code. However, if the application\r
- * writer wants to statically allocate the memory required to create a task then\r
- * the size of the task object needs to be know. The StaticTask_t structure\r
- * below is provided for this purpose. Its sizes and alignment requirements are\r
- * guaranteed to match those of the genuine structure, no matter which\r
- * architecture is being used, and no matter how the values in FreeRTOSConfig.h\r
- * are set. Its contents are somewhat obfuscated in the hope users will\r
- * recognise that it would be unwise to make direct use of the structure members.\r
- */\r
-typedef struct xSTATIC_TCB\r
-{\r
- void *pxDummy1;\r
- #if ( portUSING_MPU_WRAPPERS == 1 )\r
- xMPU_SETTINGS xDummy2;\r
- #endif\r
- StaticListItem_t xDummy3[ 2 ];\r
- UBaseType_t uxDummy5;\r
- void *pxDummy6;\r
- uint8_t ucDummy7[ configMAX_TASK_NAME_LEN ];\r
- #if ( ( portSTACK_GROWTH > 0 ) || ( configRECORD_STACK_HIGH_ADDRESS == 1 ) )\r
- void *pxDummy8;\r
- #endif\r
- #if ( portCRITICAL_NESTING_IN_TCB == 1 )\r
- UBaseType_t uxDummy9;\r
- #endif\r
- #if ( configUSE_TRACE_FACILITY == 1 )\r
- UBaseType_t uxDummy10[ 2 ];\r
- #endif\r
- #if ( configUSE_MUTEXES == 1 )\r
- UBaseType_t uxDummy12[ 2 ];\r
- #endif\r
- #if ( configUSE_APPLICATION_TASK_TAG == 1 )\r
- void *pxDummy14;\r
- #endif\r
- #if( configNUM_THREAD_LOCAL_STORAGE_POINTERS > 0 )\r
- void *pvDummy15[ configNUM_THREAD_LOCAL_STORAGE_POINTERS ];\r
- #endif\r
- #if ( configGENERATE_RUN_TIME_STATS == 1 )\r
- uint32_t ulDummy16;\r
- #endif\r
- #if ( configUSE_NEWLIB_REENTRANT == 1 )\r
- struct _reent xDummy17;\r
- #endif\r
- #if ( configUSE_TASK_NOTIFICATIONS == 1 )\r
- uint32_t ulDummy18;\r
- uint8_t ucDummy19;\r
- #endif\r
- #if( ( ( configSUPPORT_STATIC_ALLOCATION == 1 ) && ( configSUPPORT_DYNAMIC_ALLOCATION == 1 ) ) || ( portUSING_MPU_WRAPPERS == 1 ) )\r
- uint8_t uxDummy20;\r
- #endif\r
-\r
- #if( INCLUDE_xTaskAbortDelay == 1 )\r
- uint8_t ucDummy21;\r
- #endif\r
-\r
-} StaticTask_t;\r
-\r
-/*\r
- * In line with software engineering best practice, especially when supplying a\r
- * library that is likely to change in future versions, FreeRTOS implements a\r
- * strict data hiding policy. This means the Queue structure used internally by\r
- * FreeRTOS is not accessible to application code. However, if the application\r
- * writer wants to statically allocate the memory required to create a queue\r
- * then the size of the queue object needs to be know. The StaticQueue_t\r
- * structure below is provided for this purpose. Its sizes and alignment\r
- * requirements are guaranteed to match those of the genuine structure, no\r
- * matter which architecture is being used, and no matter how the values in\r
- * FreeRTOSConfig.h are set. Its contents are somewhat obfuscated in the hope\r
- * users will recognise that it would be unwise to make direct use of the\r
- * structure members.\r
- */\r
-typedef struct xSTATIC_QUEUE\r
-{\r
- void *pvDummy1[ 3 ];\r
-\r
- union\r
- {\r
- void *pvDummy2;\r
- UBaseType_t uxDummy2;\r
- } u;\r
-\r
- StaticList_t xDummy3[ 2 ];\r
- UBaseType_t uxDummy4[ 3 ];\r
- uint8_t ucDummy5[ 2 ];\r
-\r
- #if( ( configSUPPORT_STATIC_ALLOCATION == 1 ) && ( configSUPPORT_DYNAMIC_ALLOCATION == 1 ) )\r
- uint8_t ucDummy6;\r
- #endif\r
-\r
- #if ( configUSE_QUEUE_SETS == 1 )\r
- void *pvDummy7;\r
- #endif\r
-\r
- #if ( configUSE_TRACE_FACILITY == 1 )\r
- UBaseType_t uxDummy8;\r
- uint8_t ucDummy9;\r
- #endif\r
-\r
-} StaticQueue_t;\r
-typedef StaticQueue_t StaticSemaphore_t;\r
-\r
-/*\r
- * In line with software engineering best practice, especially when supplying a\r
- * library that is likely to change in future versions, FreeRTOS implements a\r
- * strict data hiding policy. This means the event group structure used\r
- * internally by FreeRTOS is not accessible to application code. However, if\r
- * the application writer wants to statically allocate the memory required to\r
- * create an event group then the size of the event group object needs to be\r
- * know. The StaticEventGroup_t structure below is provided for this purpose.\r
- * Its sizes and alignment requirements are guaranteed to match those of the\r
- * genuine structure, no matter which architecture is being used, and no matter\r
- * how the values in FreeRTOSConfig.h are set. Its contents are somewhat\r
- * obfuscated in the hope users will recognise that it would be unwise to make\r
- * direct use of the structure members.\r
- */\r
-typedef struct xSTATIC_EVENT_GROUP\r
-{\r
- TickType_t xDummy1;\r
- StaticList_t xDummy2;\r
-\r
- #if( configUSE_TRACE_FACILITY == 1 )\r
- UBaseType_t uxDummy3;\r
- #endif\r
-\r
- #if( ( configSUPPORT_STATIC_ALLOCATION == 1 ) && ( configSUPPORT_DYNAMIC_ALLOCATION == 1 ) )\r
- uint8_t ucDummy4;\r
- #endif\r
-\r
-} StaticEventGroup_t;\r
-\r
-/*\r
- * In line with software engineering best practice, especially when supplying a\r
- * library that is likely to change in future versions, FreeRTOS implements a\r
- * strict data hiding policy. This means the software timer structure used\r
- * internally by FreeRTOS is not accessible to application code. However, if\r
- * the application writer wants to statically allocate the memory required to\r
- * create a software timer then the size of the queue object needs to be know.\r
- * The StaticTimer_t structure below is provided for this purpose. Its sizes\r
- * and alignment requirements are guaranteed to match those of the genuine\r
- * structure, no matter which architecture is being used, and no matter how the\r
- * values in FreeRTOSConfig.h are set. Its contents are somewhat obfuscated in\r
- * the hope users will recognise that it would be unwise to make direct use of\r
- * the structure members.\r
- */\r
-typedef struct xSTATIC_TIMER\r
-{\r
- void *pvDummy1;\r
- StaticListItem_t xDummy2;\r
- TickType_t xDummy3;\r
- UBaseType_t uxDummy4;\r
- void *pvDummy5[ 2 ];\r
- #if( configUSE_TRACE_FACILITY == 1 )\r
- UBaseType_t uxDummy6;\r
- #endif\r
-\r
- #if( ( configSUPPORT_STATIC_ALLOCATION == 1 ) && ( configSUPPORT_DYNAMIC_ALLOCATION == 1 ) )\r
- uint8_t ucDummy7;\r
- #endif\r
-\r
-} StaticTimer_t;\r
-\r
-/*\r
-* In line with software engineering best practice, especially when supplying a\r
-* library that is likely to change in future versions, FreeRTOS implements a\r
-* strict data hiding policy. This means the stream buffer structure used\r
-* internally by FreeRTOS is not accessible to application code. However, if\r
-* the application writer wants to statically allocate the memory required to\r
-* create a stream buffer then the size of the stream buffer object needs to be\r
-* know. The StaticStreamBuffer_t structure below is provided for this purpose.\r
-* Its size and alignment requirements are guaranteed to match those of the\r
-* genuine structure, no matter which architecture is being used, and no matter\r
-* how the values in FreeRTOSConfig.h are set. Its contents are somewhat\r
-* obfuscated in the hope users will recognise that it would be unwise to make\r
-* direct use of the structure members.\r
-*/\r
-typedef struct xSTATIC_STREAM_BUFFER\r
-{\r
- size_t uxDummy1[ 4 ];\r
- void * pvDummy2[ 3 ];\r
- uint8_t ucDummy3;\r
- #if ( configUSE_TRACE_FACILITY == 1 )\r
- UBaseType_t uxDummy4;\r
- #endif\r
-} StaticStreamBuffer_t;\r
-\r
-/* Message buffers are built on stream buffers. */\r
-typedef StaticStreamBuffer_t StaticMessageBuffer_t;\r
-\r
-#ifdef __cplusplus\r
-}\r
-#endif\r
-\r
-#endif /* INC_FREERTOS_H */\r
-\r
+++ /dev/null
-/*\r
- * FreeRTOS Kernel V10.0.1\r
- * Copyright (C) 2017 Amazon.com, Inc. or its affiliates. All Rights Reserved.\r
- *\r
- * Permission is hereby granted, free of charge, to any person obtaining a copy of\r
- * this software and associated documentation files (the "Software"), to deal in\r
- * the Software without restriction, including without limitation the rights to\r
- * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of\r
- * the Software, and to permit persons to whom the Software is furnished to do so,\r
- * subject to the following conditions:\r
- *\r
- * The above copyright notice and this permission notice shall be included in all\r
- * copies or substantial portions of the Software.\r
- *\r
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\r
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS\r
- * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR\r
- * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER\r
- * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN\r
- * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\r
- *\r
- * http://www.FreeRTOS.org\r
- * http://aws.amazon.com/freertos\r
- *\r
- * 1 tab == 4 spaces!\r
- */\r
-\r
-#ifndef STACK_MACROS_H\r
-#define STACK_MACROS_H\r
-\r
-#ifndef _MSC_VER /* Visual Studio doesn't support #warning. */\r
- #warning The name of this file has changed to stack_macros.h. Please update your code accordingly. This source file (which has the original name) will be removed in future released.\r
-#endif\r
-\r
-/*\r
- * Call the stack overflow hook function if the stack of the task being swapped\r
- * out is currently overflowed, or looks like it might have overflowed in the\r
- * past.\r
- *\r
- * Setting configCHECK_FOR_STACK_OVERFLOW to 1 will cause the macro to check\r
- * the current stack state only - comparing the current top of stack value to\r
- * the stack limit. Setting configCHECK_FOR_STACK_OVERFLOW to greater than 1\r
- * will also cause the last few stack bytes to be checked to ensure the value\r
- * to which the bytes were set when the task was created have not been\r
- * overwritten. Note this second test does not guarantee that an overflowed\r
- * stack will always be recognised.\r
- */\r
-\r
-/*-----------------------------------------------------------*/\r
-\r
-#if( ( configCHECK_FOR_STACK_OVERFLOW == 1 ) && ( portSTACK_GROWTH < 0 ) )\r
-\r
- /* Only the current stack state is to be checked. */\r
- #define taskCHECK_FOR_STACK_OVERFLOW() \\r
- { \\r
- /* Is the currently saved stack pointer within the stack limit? */ \\r
- if( pxCurrentTCB->pxTopOfStack <= pxCurrentTCB->pxStack ) \\r
- { \\r
- vApplicationStackOverflowHook( ( TaskHandle_t ) pxCurrentTCB, pxCurrentTCB->pcTaskName ); \\r
- } \\r
- }\r
-\r
-#endif /* configCHECK_FOR_STACK_OVERFLOW == 1 */\r
-/*-----------------------------------------------------------*/\r
-\r
-#if( ( configCHECK_FOR_STACK_OVERFLOW == 1 ) && ( portSTACK_GROWTH > 0 ) )\r
-\r
- /* Only the current stack state is to be checked. */\r
- #define taskCHECK_FOR_STACK_OVERFLOW() \\r
- { \\r
- \\r
- /* Is the currently saved stack pointer within the stack limit? */ \\r
- if( pxCurrentTCB->pxTopOfStack >= pxCurrentTCB->pxEndOfStack ) \\r
- { \\r
- vApplicationStackOverflowHook( ( TaskHandle_t ) pxCurrentTCB, pxCurrentTCB->pcTaskName ); \\r
- } \\r
- }\r
-\r
-#endif /* configCHECK_FOR_STACK_OVERFLOW == 1 */\r
-/*-----------------------------------------------------------*/\r
-\r
-#if( ( configCHECK_FOR_STACK_OVERFLOW > 1 ) && ( portSTACK_GROWTH < 0 ) )\r
-\r
- #define taskCHECK_FOR_STACK_OVERFLOW() \\r
- { \\r
- const uint32_t * const pulStack = ( uint32_t * ) pxCurrentTCB->pxStack; \\r
- const uint32_t ulCheckValue = ( uint32_t ) 0xa5a5a5a5; \\r
- \\r
- if( ( pulStack[ 0 ] != ulCheckValue ) || \\r
- ( pulStack[ 1 ] != ulCheckValue ) || \\r
- ( pulStack[ 2 ] != ulCheckValue ) || \\r
- ( pulStack[ 3 ] != ulCheckValue ) ) \\r
- { \\r
- vApplicationStackOverflowHook( ( TaskHandle_t ) pxCurrentTCB, pxCurrentTCB->pcTaskName ); \\r
- } \\r
- }\r
-\r
-#endif /* #if( configCHECK_FOR_STACK_OVERFLOW > 1 ) */\r
-/*-----------------------------------------------------------*/\r
-\r
-#if( ( configCHECK_FOR_STACK_OVERFLOW > 1 ) && ( portSTACK_GROWTH > 0 ) )\r
-\r
- #define taskCHECK_FOR_STACK_OVERFLOW() \\r
- { \\r
- int8_t *pcEndOfStack = ( int8_t * ) pxCurrentTCB->pxEndOfStack; \\r
- static const uint8_t ucExpectedStackBytes[] = { tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, \\r
- tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, \\r
- tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, \\r
- tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, \\r
- tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE }; \\r
- \\r
- \\r
- pcEndOfStack -= sizeof( ucExpectedStackBytes ); \\r
- \\r
- /* Has the extremity of the task stack ever been written over? */ \\r
- if( memcmp( ( void * ) pcEndOfStack, ( void * ) ucExpectedStackBytes, sizeof( ucExpectedStackBytes ) ) != 0 ) \\r
- { \\r
- vApplicationStackOverflowHook( ( TaskHandle_t ) pxCurrentTCB, pxCurrentTCB->pcTaskName ); \\r
- } \\r
- }\r
-\r
-#endif /* #if( configCHECK_FOR_STACK_OVERFLOW > 1 ) */\r
-/*-----------------------------------------------------------*/\r
-\r
-/* Remove stack overflow macro if not being used. */\r
-#ifndef taskCHECK_FOR_STACK_OVERFLOW\r
- #define taskCHECK_FOR_STACK_OVERFLOW()\r
-#endif\r
-\r
-\r
-\r
-#endif /* STACK_MACROS_H */\r
-\r
+++ /dev/null
-/*\r
- * FreeRTOS Kernel V10.0.1\r
- * Copyright (C) 2017 Amazon.com, Inc. or its affiliates. All Rights Reserved.\r
- *\r
- * Permission is hereby granted, free of charge, to any person obtaining a copy of\r
- * this software and associated documentation files (the "Software"), to deal in\r
- * the Software without restriction, including without limitation the rights to\r
- * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of\r
- * the Software, and to permit persons to whom the Software is furnished to do so,\r
- * subject to the following conditions:\r
- *\r
- * The above copyright notice and this permission notice shall be included in all\r
- * copies or substantial portions of the Software.\r
- *\r
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\r
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS\r
- * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR\r
- * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER\r
- * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN\r
- * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\r
- *\r
- * http://www.FreeRTOS.org\r
- * http://aws.amazon.com/freertos\r
- *\r
- * 1 tab == 4 spaces!\r
- */\r
-\r
-#ifndef CO_ROUTINE_H\r
-#define CO_ROUTINE_H\r
-\r
-#ifndef INC_FREERTOS_H\r
- #error "include FreeRTOS.h must appear in source files before include croutine.h"\r
-#endif\r
-\r
-#include "list.h"\r
-\r
-#ifdef __cplusplus\r
-extern "C" {\r
-#endif\r
-\r
-/* Used to hide the implementation of the co-routine control block. The\r
-control block structure however has to be included in the header due to\r
-the macro implementation of the co-routine functionality. */\r
-typedef void * CoRoutineHandle_t;\r
-\r
-/* Defines the prototype to which co-routine functions must conform. */\r
-typedef void (*crCOROUTINE_CODE)( CoRoutineHandle_t, UBaseType_t );\r
-\r
-typedef struct corCoRoutineControlBlock\r
-{\r
- crCOROUTINE_CODE pxCoRoutineFunction;\r
- ListItem_t xGenericListItem; /*< List item used to place the CRCB in ready and blocked queues. */\r
- ListItem_t xEventListItem; /*< List item used to place the CRCB in event lists. */\r
- UBaseType_t uxPriority; /*< The priority of the co-routine in relation to other co-routines. */\r
- UBaseType_t uxIndex; /*< Used to distinguish between co-routines when multiple co-routines use the same co-routine function. */\r
- uint16_t uxState; /*< Used internally by the co-routine implementation. */\r
-} CRCB_t; /* Co-routine control block. Note must be identical in size down to uxPriority with TCB_t. */\r
-\r
-/**\r
- * croutine. h\r
- *<pre>\r
- BaseType_t xCoRoutineCreate(\r
- crCOROUTINE_CODE pxCoRoutineCode,\r
- UBaseType_t uxPriority,\r
- UBaseType_t uxIndex\r
- );</pre>\r
- *\r
- * Create a new co-routine and add it to the list of co-routines that are\r
- * ready to run.\r
- *\r
- * @param pxCoRoutineCode Pointer to the co-routine function. Co-routine\r
- * functions require special syntax - see the co-routine section of the WEB\r
- * documentation for more information.\r
- *\r
- * @param uxPriority The priority with respect to other co-routines at which\r
- * the co-routine will run.\r
- *\r
- * @param uxIndex Used to distinguish between different co-routines that\r
- * execute the same function. See the example below and the co-routine section\r
- * of the WEB documentation for further information.\r
- *\r
- * @return pdPASS if the co-routine was successfully created and added to a ready\r
- * list, otherwise an error code defined with ProjDefs.h.\r
- *\r
- * Example usage:\r
- <pre>\r
- // Co-routine to be created.\r
- void vFlashCoRoutine( CoRoutineHandle_t xHandle, UBaseType_t uxIndex )\r
- {\r
- // Variables in co-routines must be declared static if they must maintain value across a blocking call.\r
- // This may not be necessary for const variables.\r
- static const char cLedToFlash[ 2 ] = { 5, 6 };\r
- static const TickType_t uxFlashRates[ 2 ] = { 200, 400 };\r
-\r
- // Must start every co-routine with a call to crSTART();\r
- crSTART( xHandle );\r
-\r
- for( ;; )\r
- {\r
- // This co-routine just delays for a fixed period, then toggles\r
- // an LED. Two co-routines are created using this function, so\r
- // the uxIndex parameter is used to tell the co-routine which\r
- // LED to flash and how int32_t to delay. This assumes xQueue has\r
- // already been created.\r
- vParTestToggleLED( cLedToFlash[ uxIndex ] );\r
- crDELAY( xHandle, uxFlashRates[ uxIndex ] );\r
- }\r
-\r
- // Must end every co-routine with a call to crEND();\r
- crEND();\r
- }\r
-\r
- // Function that creates two co-routines.\r
- void vOtherFunction( void )\r
- {\r
- uint8_t ucParameterToPass;\r
- TaskHandle_t xHandle;\r
-\r
- // Create two co-routines at priority 0. The first is given index 0\r
- // so (from the code above) toggles LED 5 every 200 ticks. The second\r
- // is given index 1 so toggles LED 6 every 400 ticks.\r
- for( uxIndex = 0; uxIndex < 2; uxIndex++ )\r
- {\r
- xCoRoutineCreate( vFlashCoRoutine, 0, uxIndex );\r
- }\r
- }\r
- </pre>\r
- * \defgroup xCoRoutineCreate xCoRoutineCreate\r
- * \ingroup Tasks\r
- */\r
-BaseType_t xCoRoutineCreate( crCOROUTINE_CODE pxCoRoutineCode, UBaseType_t uxPriority, UBaseType_t uxIndex );\r
-\r
-\r
-/**\r
- * croutine. h\r
- *<pre>\r
- void vCoRoutineSchedule( void );</pre>\r
- *\r
- * Run a co-routine.\r
- *\r
- * vCoRoutineSchedule() executes the highest priority co-routine that is able\r
- * to run. The co-routine will execute until it either blocks, yields or is\r
- * preempted by a task. Co-routines execute cooperatively so one\r
- * co-routine cannot be preempted by another, but can be preempted by a task.\r
- *\r
- * If an application comprises of both tasks and co-routines then\r
- * vCoRoutineSchedule should be called from the idle task (in an idle task\r
- * hook).\r
- *\r
- * Example usage:\r
- <pre>\r
- // This idle task hook will schedule a co-routine each time it is called.\r
- // The rest of the idle task will execute between co-routine calls.\r
- void vApplicationIdleHook( void )\r
- {\r
- vCoRoutineSchedule();\r
- }\r
-\r
- // Alternatively, if you do not require any other part of the idle task to\r
- // execute, the idle task hook can call vCoRoutineScheduler() within an\r
- // infinite loop.\r
- void vApplicationIdleHook( void )\r
- {\r
- for( ;; )\r
- {\r
- vCoRoutineSchedule();\r
- }\r
- }\r
- </pre>\r
- * \defgroup vCoRoutineSchedule vCoRoutineSchedule\r
- * \ingroup Tasks\r
- */\r
-void vCoRoutineSchedule( void );\r
-\r
-/**\r
- * croutine. h\r
- * <pre>\r
- crSTART( CoRoutineHandle_t xHandle );</pre>\r
- *\r
- * This macro MUST always be called at the start of a co-routine function.\r
- *\r
- * Example usage:\r
- <pre>\r
- // Co-routine to be created.\r
- void vACoRoutine( CoRoutineHandle_t xHandle, UBaseType_t uxIndex )\r
- {\r
- // Variables in co-routines must be declared static if they must maintain value across a blocking call.\r
- static int32_t ulAVariable;\r
-\r
- // Must start every co-routine with a call to crSTART();\r
- crSTART( xHandle );\r
-\r
- for( ;; )\r
- {\r
- // Co-routine functionality goes here.\r
- }\r
-\r
- // Must end every co-routine with a call to crEND();\r
- crEND();\r
- }</pre>\r
- * \defgroup crSTART crSTART\r
- * \ingroup Tasks\r
- */\r
-#define crSTART( pxCRCB ) switch( ( ( CRCB_t * )( pxCRCB ) )->uxState ) { case 0:\r
-\r
-/**\r
- * croutine. h\r
- * <pre>\r
- crEND();</pre>\r
- *\r
- * This macro MUST always be called at the end of a co-routine function.\r
- *\r
- * Example usage:\r
- <pre>\r
- // Co-routine to be created.\r
- void vACoRoutine( CoRoutineHandle_t xHandle, UBaseType_t uxIndex )\r
- {\r
- // Variables in co-routines must be declared static if they must maintain value across a blocking call.\r
- static int32_t ulAVariable;\r
-\r
- // Must start every co-routine with a call to crSTART();\r
- crSTART( xHandle );\r
-\r
- for( ;; )\r
- {\r
- // Co-routine functionality goes here.\r
- }\r
-\r
- // Must end every co-routine with a call to crEND();\r
- crEND();\r
- }</pre>\r
- * \defgroup crSTART crSTART\r
- * \ingroup Tasks\r
- */\r
-#define crEND() }\r
-\r
-/*\r
- * These macros are intended for internal use by the co-routine implementation\r
- * only. The macros should not be used directly by application writers.\r
- */\r
-#define crSET_STATE0( xHandle ) ( ( CRCB_t * )( xHandle ) )->uxState = (__LINE__ * 2); return; case (__LINE__ * 2):\r
-#define crSET_STATE1( xHandle ) ( ( CRCB_t * )( xHandle ) )->uxState = ((__LINE__ * 2)+1); return; case ((__LINE__ * 2)+1):\r
-\r
-/**\r
- * croutine. h\r
- *<pre>\r
- crDELAY( CoRoutineHandle_t xHandle, TickType_t xTicksToDelay );</pre>\r
- *\r
- * Delay a co-routine for a fixed period of time.\r
- *\r
- * crDELAY can only be called from the co-routine function itself - not\r
- * from within a function called by the co-routine function. This is because\r
- * co-routines do not maintain their own stack.\r
- *\r
- * @param xHandle The handle of the co-routine to delay. This is the xHandle\r
- * parameter of the co-routine function.\r
- *\r
- * @param xTickToDelay The number of ticks that the co-routine should delay\r
- * for. The actual amount of time this equates to is defined by\r
- * configTICK_RATE_HZ (set in FreeRTOSConfig.h). The constant portTICK_PERIOD_MS\r
- * can be used to convert ticks to milliseconds.\r
- *\r
- * Example usage:\r
- <pre>\r
- // Co-routine to be created.\r
- void vACoRoutine( CoRoutineHandle_t xHandle, UBaseType_t uxIndex )\r
- {\r
- // Variables in co-routines must be declared static if they must maintain value across a blocking call.\r
- // This may not be necessary for const variables.\r
- // We are to delay for 200ms.\r
- static const xTickType xDelayTime = 200 / portTICK_PERIOD_MS;\r
-\r
- // Must start every co-routine with a call to crSTART();\r
- crSTART( xHandle );\r
-\r
- for( ;; )\r
- {\r
- // Delay for 200ms.\r
- crDELAY( xHandle, xDelayTime );\r
-\r
- // Do something here.\r
- }\r
-\r
- // Must end every co-routine with a call to crEND();\r
- crEND();\r
- }</pre>\r
- * \defgroup crDELAY crDELAY\r
- * \ingroup Tasks\r
- */\r
-#define crDELAY( xHandle, xTicksToDelay ) \\r
- if( ( xTicksToDelay ) > 0 ) \\r
- { \\r
- vCoRoutineAddToDelayedList( ( xTicksToDelay ), NULL ); \\r
- } \\r
- crSET_STATE0( ( xHandle ) );\r
-\r
-/**\r
- * <pre>\r
- crQUEUE_SEND(\r
- CoRoutineHandle_t xHandle,\r
- QueueHandle_t pxQueue,\r
- void *pvItemToQueue,\r
- TickType_t xTicksToWait,\r
- BaseType_t *pxResult\r
- )</pre>\r
- *\r
- * The macro's crQUEUE_SEND() and crQUEUE_RECEIVE() are the co-routine\r
- * equivalent to the xQueueSend() and xQueueReceive() functions used by tasks.\r
- *\r
- * crQUEUE_SEND and crQUEUE_RECEIVE can only be used from a co-routine whereas\r
- * xQueueSend() and xQueueReceive() can only be used from tasks.\r
- *\r
- * crQUEUE_SEND can only be called from the co-routine function itself - not\r
- * from within a function called by the co-routine function. This is because\r
- * co-routines do not maintain their own stack.\r
- *\r
- * See the co-routine section of the WEB documentation for information on\r
- * passing data between tasks and co-routines and between ISR's and\r
- * co-routines.\r
- *\r
- * @param xHandle The handle of the calling co-routine. This is the xHandle\r
- * parameter of the co-routine function.\r
- *\r
- * @param pxQueue The handle of the queue on which the data will be posted.\r
- * The handle is obtained as the return value when the queue is created using\r
- * the xQueueCreate() API function.\r
- *\r
- * @param pvItemToQueue A pointer to the data being posted onto the queue.\r
- * The number of bytes of each queued item is specified when the queue is\r
- * created. This number of bytes is copied from pvItemToQueue into the queue\r
- * itself.\r
- *\r
- * @param xTickToDelay The number of ticks that the co-routine should block\r
- * to wait for space to become available on the queue, should space not be\r
- * available immediately. The actual amount of time this equates to is defined\r
- * by configTICK_RATE_HZ (set in FreeRTOSConfig.h). The constant\r
- * portTICK_PERIOD_MS can be used to convert ticks to milliseconds (see example\r
- * below).\r
- *\r
- * @param pxResult The variable pointed to by pxResult will be set to pdPASS if\r
- * data was successfully posted onto the queue, otherwise it will be set to an\r
- * error defined within ProjDefs.h.\r
- *\r
- * Example usage:\r
- <pre>\r
- // Co-routine function that blocks for a fixed period then posts a number onto\r
- // a queue.\r
- static void prvCoRoutineFlashTask( CoRoutineHandle_t xHandle, UBaseType_t uxIndex )\r
- {\r
- // Variables in co-routines must be declared static if they must maintain value across a blocking call.\r
- static BaseType_t xNumberToPost = 0;\r
- static BaseType_t xResult;\r
-\r
- // Co-routines must begin with a call to crSTART().\r
- crSTART( xHandle );\r
-\r
- for( ;; )\r
- {\r
- // This assumes the queue has already been created.\r
- crQUEUE_SEND( xHandle, xCoRoutineQueue, &xNumberToPost, NO_DELAY, &xResult );\r
-\r
- if( xResult != pdPASS )\r
- {\r
- // The message was not posted!\r
- }\r
-\r
- // Increment the number to be posted onto the queue.\r
- xNumberToPost++;\r
-\r
- // Delay for 100 ticks.\r
- crDELAY( xHandle, 100 );\r
- }\r
-\r
- // Co-routines must end with a call to crEND().\r
- crEND();\r
- }</pre>\r
- * \defgroup crQUEUE_SEND crQUEUE_SEND\r
- * \ingroup Tasks\r
- */\r
-#define crQUEUE_SEND( xHandle, pxQueue, pvItemToQueue, xTicksToWait, pxResult ) \\r
-{ \\r
- *( pxResult ) = xQueueCRSend( ( pxQueue) , ( pvItemToQueue) , ( xTicksToWait ) ); \\r
- if( *( pxResult ) == errQUEUE_BLOCKED ) \\r
- { \\r
- crSET_STATE0( ( xHandle ) ); \\r
- *pxResult = xQueueCRSend( ( pxQueue ), ( pvItemToQueue ), 0 ); \\r
- } \\r
- if( *pxResult == errQUEUE_YIELD ) \\r
- { \\r
- crSET_STATE1( ( xHandle ) ); \\r
- *pxResult = pdPASS; \\r
- } \\r
-}\r
-\r
-/**\r
- * croutine. h\r
- * <pre>\r
- crQUEUE_RECEIVE(\r
- CoRoutineHandle_t xHandle,\r
- QueueHandle_t pxQueue,\r
- void *pvBuffer,\r
- TickType_t xTicksToWait,\r
- BaseType_t *pxResult\r
- )</pre>\r
- *\r
- * The macro's crQUEUE_SEND() and crQUEUE_RECEIVE() are the co-routine\r
- * equivalent to the xQueueSend() and xQueueReceive() functions used by tasks.\r
- *\r
- * crQUEUE_SEND and crQUEUE_RECEIVE can only be used from a co-routine whereas\r
- * xQueueSend() and xQueueReceive() can only be used from tasks.\r
- *\r
- * crQUEUE_RECEIVE can only be called from the co-routine function itself - not\r
- * from within a function called by the co-routine function. This is because\r
- * co-routines do not maintain their own stack.\r
- *\r
- * See the co-routine section of the WEB documentation for information on\r
- * passing data between tasks and co-routines and between ISR's and\r
- * co-routines.\r
- *\r
- * @param xHandle The handle of the calling co-routine. This is the xHandle\r
- * parameter of the co-routine function.\r
- *\r
- * @param pxQueue The handle of the queue from which the data will be received.\r
- * The handle is obtained as the return value when the queue is created using\r
- * the xQueueCreate() API function.\r
- *\r
- * @param pvBuffer The buffer into which the received item is to be copied.\r
- * The number of bytes of each queued item is specified when the queue is\r
- * created. This number of bytes is copied into pvBuffer.\r
- *\r
- * @param xTickToDelay The number of ticks that the co-routine should block\r
- * to wait for data to become available from the queue, should data not be\r
- * available immediately. The actual amount of time this equates to is defined\r
- * by configTICK_RATE_HZ (set in FreeRTOSConfig.h). The constant\r
- * portTICK_PERIOD_MS can be used to convert ticks to milliseconds (see the\r
- * crQUEUE_SEND example).\r
- *\r
- * @param pxResult The variable pointed to by pxResult will be set to pdPASS if\r
- * data was successfully retrieved from the queue, otherwise it will be set to\r
- * an error code as defined within ProjDefs.h.\r
- *\r
- * Example usage:\r
- <pre>\r
- // A co-routine receives the number of an LED to flash from a queue. It\r
- // blocks on the queue until the number is received.\r
- static void prvCoRoutineFlashWorkTask( CoRoutineHandle_t xHandle, UBaseType_t uxIndex )\r
- {\r
- // Variables in co-routines must be declared static if they must maintain value across a blocking call.\r
- static BaseType_t xResult;\r
- static UBaseType_t uxLEDToFlash;\r
-\r
- // All co-routines must start with a call to crSTART().\r
- crSTART( xHandle );\r
-\r
- for( ;; )\r
- {\r
- // Wait for data to become available on the queue.\r
- crQUEUE_RECEIVE( xHandle, xCoRoutineQueue, &uxLEDToFlash, portMAX_DELAY, &xResult );\r
-\r
- if( xResult == pdPASS )\r
- {\r
- // We received the LED to flash - flash it!\r
- vParTestToggleLED( uxLEDToFlash );\r
- }\r
- }\r
-\r
- crEND();\r
- }</pre>\r
- * \defgroup crQUEUE_RECEIVE crQUEUE_RECEIVE\r
- * \ingroup Tasks\r
- */\r
-#define crQUEUE_RECEIVE( xHandle, pxQueue, pvBuffer, xTicksToWait, pxResult ) \\r
-{ \\r
- *( pxResult ) = xQueueCRReceive( ( pxQueue) , ( pvBuffer ), ( xTicksToWait ) ); \\r
- if( *( pxResult ) == errQUEUE_BLOCKED ) \\r
- { \\r
- crSET_STATE0( ( xHandle ) ); \\r
- *( pxResult ) = xQueueCRReceive( ( pxQueue) , ( pvBuffer ), 0 ); \\r
- } \\r
- if( *( pxResult ) == errQUEUE_YIELD ) \\r
- { \\r
- crSET_STATE1( ( xHandle ) ); \\r
- *( pxResult ) = pdPASS; \\r
- } \\r
-}\r
-\r
-/**\r
- * croutine. h\r
- * <pre>\r
- crQUEUE_SEND_FROM_ISR(\r
- QueueHandle_t pxQueue,\r
- void *pvItemToQueue,\r
- BaseType_t xCoRoutinePreviouslyWoken\r
- )</pre>\r
- *\r
- * The macro's crQUEUE_SEND_FROM_ISR() and crQUEUE_RECEIVE_FROM_ISR() are the\r
- * co-routine equivalent to the xQueueSendFromISR() and xQueueReceiveFromISR()\r
- * functions used by tasks.\r
- *\r
- * crQUEUE_SEND_FROM_ISR() and crQUEUE_RECEIVE_FROM_ISR() can only be used to\r
- * pass data between a co-routine and and ISR, whereas xQueueSendFromISR() and\r
- * xQueueReceiveFromISR() can only be used to pass data between a task and and\r
- * ISR.\r
- *\r
- * crQUEUE_SEND_FROM_ISR can only be called from an ISR to send data to a queue\r
- * that is being used from within a co-routine.\r
- *\r
- * See the co-routine section of the WEB documentation for information on\r
- * passing data between tasks and co-routines and between ISR's and\r
- * co-routines.\r
- *\r
- * @param xQueue The handle to the queue on which the item is to be posted.\r
- *\r
- * @param pvItemToQueue A pointer to the item that is to be placed on the\r
- * queue. The size of the items the queue will hold was defined when the\r
- * queue was created, so this many bytes will be copied from pvItemToQueue\r
- * into the queue storage area.\r
- *\r
- * @param xCoRoutinePreviouslyWoken This is included so an ISR can post onto\r
- * the same queue multiple times from a single interrupt. The first call\r
- * should always pass in pdFALSE. Subsequent calls should pass in\r
- * the value returned from the previous call.\r
- *\r
- * @return pdTRUE if a co-routine was woken by posting onto the queue. This is\r
- * used by the ISR to determine if a context switch may be required following\r
- * the ISR.\r
- *\r
- * Example usage:\r
- <pre>\r
- // A co-routine that blocks on a queue waiting for characters to be received.\r
- static void vReceivingCoRoutine( CoRoutineHandle_t xHandle, UBaseType_t uxIndex )\r
- {\r
- char cRxedChar;\r
- BaseType_t xResult;\r
-\r
- // All co-routines must start with a call to crSTART().\r
- crSTART( xHandle );\r
-\r
- for( ;; )\r
- {\r
- // Wait for data to become available on the queue. This assumes the\r
- // queue xCommsRxQueue has already been created!\r
- crQUEUE_RECEIVE( xHandle, xCommsRxQueue, &uxLEDToFlash, portMAX_DELAY, &xResult );\r
-\r
- // Was a character received?\r
- if( xResult == pdPASS )\r
- {\r
- // Process the character here.\r
- }\r
- }\r
-\r
- // All co-routines must end with a call to crEND().\r
- crEND();\r
- }\r
-\r
- // An ISR that uses a queue to send characters received on a serial port to\r
- // a co-routine.\r
- void vUART_ISR( void )\r
- {\r
- char cRxedChar;\r
- BaseType_t xCRWokenByPost = pdFALSE;\r
-\r
- // We loop around reading characters until there are none left in the UART.\r
- while( UART_RX_REG_NOT_EMPTY() )\r
- {\r
- // Obtain the character from the UART.\r
- cRxedChar = UART_RX_REG;\r
-\r
- // Post the character onto a queue. xCRWokenByPost will be pdFALSE\r
- // the first time around the loop. If the post causes a co-routine\r
- // to be woken (unblocked) then xCRWokenByPost will be set to pdTRUE.\r
- // In this manner we can ensure that if more than one co-routine is\r
- // blocked on the queue only one is woken by this ISR no matter how\r
- // many characters are posted to the queue.\r
- xCRWokenByPost = crQUEUE_SEND_FROM_ISR( xCommsRxQueue, &cRxedChar, xCRWokenByPost );\r
- }\r
- }</pre>\r
- * \defgroup crQUEUE_SEND_FROM_ISR crQUEUE_SEND_FROM_ISR\r
- * \ingroup Tasks\r
- */\r
-#define crQUEUE_SEND_FROM_ISR( pxQueue, pvItemToQueue, xCoRoutinePreviouslyWoken ) xQueueCRSendFromISR( ( pxQueue ), ( pvItemToQueue ), ( xCoRoutinePreviouslyWoken ) )\r
-\r
-\r
-/**\r
- * croutine. h\r
- * <pre>\r
- crQUEUE_SEND_FROM_ISR(\r
- QueueHandle_t pxQueue,\r
- void *pvBuffer,\r
- BaseType_t * pxCoRoutineWoken\r
- )</pre>\r
- *\r
- * The macro's crQUEUE_SEND_FROM_ISR() and crQUEUE_RECEIVE_FROM_ISR() are the\r
- * co-routine equivalent to the xQueueSendFromISR() and xQueueReceiveFromISR()\r
- * functions used by tasks.\r
- *\r
- * crQUEUE_SEND_FROM_ISR() and crQUEUE_RECEIVE_FROM_ISR() can only be used to\r
- * pass data between a co-routine and and ISR, whereas xQueueSendFromISR() and\r
- * xQueueReceiveFromISR() can only be used to pass data between a task and and\r
- * ISR.\r
- *\r
- * crQUEUE_RECEIVE_FROM_ISR can only be called from an ISR to receive data\r
- * from a queue that is being used from within a co-routine (a co-routine\r
- * posted to the queue).\r
- *\r
- * See the co-routine section of the WEB documentation for information on\r
- * passing data between tasks and co-routines and between ISR's and\r
- * co-routines.\r
- *\r
- * @param xQueue The handle to the queue on which the item is to be posted.\r
- *\r
- * @param pvBuffer A pointer to a buffer into which the received item will be\r
- * placed. The size of the items the queue will hold was defined when the\r
- * queue was created, so this many bytes will be copied from the queue into\r
- * pvBuffer.\r
- *\r
- * @param pxCoRoutineWoken A co-routine may be blocked waiting for space to become\r
- * available on the queue. If crQUEUE_RECEIVE_FROM_ISR causes such a\r
- * co-routine to unblock *pxCoRoutineWoken will get set to pdTRUE, otherwise\r
- * *pxCoRoutineWoken will remain unchanged.\r
- *\r
- * @return pdTRUE an item was successfully received from the queue, otherwise\r
- * pdFALSE.\r
- *\r
- * Example usage:\r
- <pre>\r
- // A co-routine that posts a character to a queue then blocks for a fixed\r
- // period. The character is incremented each time.\r
- static void vSendingCoRoutine( CoRoutineHandle_t xHandle, UBaseType_t uxIndex )\r
- {\r
- // cChar holds its value while this co-routine is blocked and must therefore\r
- // be declared static.\r
- static char cCharToTx = 'a';\r
- BaseType_t xResult;\r
-\r
- // All co-routines must start with a call to crSTART().\r
- crSTART( xHandle );\r
-\r
- for( ;; )\r
- {\r
- // Send the next character to the queue.\r
- crQUEUE_SEND( xHandle, xCoRoutineQueue, &cCharToTx, NO_DELAY, &xResult );\r
-\r
- if( xResult == pdPASS )\r
- {\r
- // The character was successfully posted to the queue.\r
- }\r
- else\r
- {\r
- // Could not post the character to the queue.\r
- }\r
-\r
- // Enable the UART Tx interrupt to cause an interrupt in this\r
- // hypothetical UART. The interrupt will obtain the character\r
- // from the queue and send it.\r
- ENABLE_RX_INTERRUPT();\r
-\r
- // Increment to the next character then block for a fixed period.\r
- // cCharToTx will maintain its value across the delay as it is\r
- // declared static.\r
- cCharToTx++;\r
- if( cCharToTx > 'x' )\r
- {\r
- cCharToTx = 'a';\r
- }\r
- crDELAY( 100 );\r
- }\r
-\r
- // All co-routines must end with a call to crEND().\r
- crEND();\r
- }\r
-\r
- // An ISR that uses a queue to receive characters to send on a UART.\r
- void vUART_ISR( void )\r
- {\r
- char cCharToTx;\r
- BaseType_t xCRWokenByPost = pdFALSE;\r
-\r
- while( UART_TX_REG_EMPTY() )\r
- {\r
- // Are there any characters in the queue waiting to be sent?\r
- // xCRWokenByPost will automatically be set to pdTRUE if a co-routine\r
- // is woken by the post - ensuring that only a single co-routine is\r
- // woken no matter how many times we go around this loop.\r
- if( crQUEUE_RECEIVE_FROM_ISR( pxQueue, &cCharToTx, &xCRWokenByPost ) )\r
- {\r
- SEND_CHARACTER( cCharToTx );\r
- }\r
- }\r
- }</pre>\r
- * \defgroup crQUEUE_RECEIVE_FROM_ISR crQUEUE_RECEIVE_FROM_ISR\r
- * \ingroup Tasks\r
- */\r
-#define crQUEUE_RECEIVE_FROM_ISR( pxQueue, pvBuffer, pxCoRoutineWoken ) xQueueCRReceiveFromISR( ( pxQueue ), ( pvBuffer ), ( pxCoRoutineWoken ) )\r
-\r
-/*\r
- * This function is intended for internal use by the co-routine macros only.\r
- * The macro nature of the co-routine implementation requires that the\r
- * prototype appears here. The function should not be used by application\r
- * writers.\r
- *\r
- * Removes the current co-routine from its ready list and places it in the\r
- * appropriate delayed list.\r
- */\r
-void vCoRoutineAddToDelayedList( TickType_t xTicksToDelay, List_t *pxEventList );\r
-\r
-/*\r
- * This function is intended for internal use by the queue implementation only.\r
- * The function should not be used by application writers.\r
- *\r
- * Removes the highest priority co-routine from the event list and places it in\r
- * the pending ready list.\r
- */\r
-BaseType_t xCoRoutineRemoveFromEventList( const List_t *pxEventList );\r
-\r
-#ifdef __cplusplus\r
-}\r
-#endif\r
-\r
-#endif /* CO_ROUTINE_H */\r
+++ /dev/null
-/*\r
- * FreeRTOS Kernel V10.0.1\r
- * Copyright (C) 2017 Amazon.com, Inc. or its affiliates. All Rights Reserved.\r
- *\r
- * Permission is hereby granted, free of charge, to any person obtaining a copy of\r
- * this software and associated documentation files (the "Software"), to deal in\r
- * the Software without restriction, including without limitation the rights to\r
- * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of\r
- * the Software, and to permit persons to whom the Software is furnished to do so,\r
- * subject to the following conditions:\r
- *\r
- * The above copyright notice and this permission notice shall be included in all\r
- * copies or substantial portions of the Software.\r
- *\r
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\r
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS\r
- * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR\r
- * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER\r
- * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN\r
- * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\r
- *\r
- * http://www.FreeRTOS.org\r
- * http://aws.amazon.com/freertos\r
- *\r
- * 1 tab == 4 spaces!\r
- */\r
-\r
-#ifndef DEPRECATED_DEFINITIONS_H\r
-#define DEPRECATED_DEFINITIONS_H\r
-\r
-\r
-/* Each FreeRTOS port has a unique portmacro.h header file. Originally a\r
-pre-processor definition was used to ensure the pre-processor found the correct\r
-portmacro.h file for the port being used. That scheme was deprecated in favour\r
-of setting the compiler's include path such that it found the correct\r
-portmacro.h file - removing the need for the constant and allowing the\r
-portmacro.h file to be located anywhere in relation to the port being used. The\r
-definitions below remain in the code for backward compatibility only. New\r
-projects should not use them. */\r
-\r
-#ifdef OPEN_WATCOM_INDUSTRIAL_PC_PORT\r
- #include "..\..\Source\portable\owatcom\16bitdos\pc\portmacro.h"\r
- typedef void ( __interrupt __far *pxISR )();\r
-#endif\r
-\r
-#ifdef OPEN_WATCOM_FLASH_LITE_186_PORT\r
- #include "..\..\Source\portable\owatcom\16bitdos\flsh186\portmacro.h"\r
- typedef void ( __interrupt __far *pxISR )();\r
-#endif\r
-\r
-#ifdef GCC_MEGA_AVR\r
- #include "../portable/GCC/ATMega323/portmacro.h"\r
-#endif\r
-\r
-#ifdef IAR_MEGA_AVR\r
- #include "../portable/IAR/ATMega323/portmacro.h"\r
-#endif\r
-\r
-#ifdef MPLAB_PIC24_PORT\r
- #include "../../Source/portable/MPLAB/PIC24_dsPIC/portmacro.h"\r
-#endif\r
-\r
-#ifdef MPLAB_DSPIC_PORT\r
- #include "../../Source/portable/MPLAB/PIC24_dsPIC/portmacro.h"\r
-#endif\r
-\r
-#ifdef MPLAB_PIC18F_PORT\r
- #include "../../Source/portable/MPLAB/PIC18F/portmacro.h"\r
-#endif\r
-\r
-#ifdef MPLAB_PIC32MX_PORT\r
- #include "../../Source/portable/MPLAB/PIC32MX/portmacro.h"\r
-#endif\r
-\r
-#ifdef _FEDPICC\r
- #include "libFreeRTOS/Include/portmacro.h"\r
-#endif\r
-\r
-#ifdef SDCC_CYGNAL\r
- #include "../../Source/portable/SDCC/Cygnal/portmacro.h"\r
-#endif\r
-\r
-#ifdef GCC_ARM7\r
- #include "../../Source/portable/GCC/ARM7_LPC2000/portmacro.h"\r
-#endif\r
-\r
-#ifdef GCC_ARM7_ECLIPSE\r
- #include "portmacro.h"\r
-#endif\r
-\r
-#ifdef ROWLEY_LPC23xx\r
- #include "../../Source/portable/GCC/ARM7_LPC23xx/portmacro.h"\r
-#endif\r
-\r
-#ifdef IAR_MSP430\r
- #include "..\..\Source\portable\IAR\MSP430\portmacro.h"\r
-#endif\r
-\r
-#ifdef GCC_MSP430\r
- #include "../../Source/portable/GCC/MSP430F449/portmacro.h"\r
-#endif\r
-\r
-#ifdef ROWLEY_MSP430\r
- #include "../../Source/portable/Rowley/MSP430F449/portmacro.h"\r
-#endif\r
-\r
-#ifdef ARM7_LPC21xx_KEIL_RVDS\r
- #include "..\..\Source\portable\RVDS\ARM7_LPC21xx\portmacro.h"\r
-#endif\r
-\r
-#ifdef SAM7_GCC\r
- #include "../../Source/portable/GCC/ARM7_AT91SAM7S/portmacro.h"\r
-#endif\r
-\r
-#ifdef SAM7_IAR\r
- #include "..\..\Source\portable\IAR\AtmelSAM7S64\portmacro.h"\r
-#endif\r
-\r
-#ifdef SAM9XE_IAR\r
- #include "..\..\Source\portable\IAR\AtmelSAM9XE\portmacro.h"\r
-#endif\r
-\r
-#ifdef LPC2000_IAR\r
- #include "..\..\Source\portable\IAR\LPC2000\portmacro.h"\r
-#endif\r
-\r
-#ifdef STR71X_IAR\r
- #include "..\..\Source\portable\IAR\STR71x\portmacro.h"\r
-#endif\r
-\r
-#ifdef STR75X_IAR\r
- #include "..\..\Source\portable\IAR\STR75x\portmacro.h"\r
-#endif\r
-\r
-#ifdef STR75X_GCC\r
- #include "..\..\Source\portable\GCC\STR75x\portmacro.h"\r
-#endif\r
-\r
-#ifdef STR91X_IAR\r
- #include "..\..\Source\portable\IAR\STR91x\portmacro.h"\r
-#endif\r
-\r
-#ifdef GCC_H8S\r
- #include "../../Source/portable/GCC/H8S2329/portmacro.h"\r
-#endif\r
-\r
-#ifdef GCC_AT91FR40008\r
- #include "../../Source/portable/GCC/ARM7_AT91FR40008/portmacro.h"\r
-#endif\r
-\r
-#ifdef RVDS_ARMCM3_LM3S102\r
- #include "../../Source/portable/RVDS/ARM_CM3/portmacro.h"\r
-#endif\r
-\r
-#ifdef GCC_ARMCM3_LM3S102\r
- #include "../../Source/portable/GCC/ARM_CM3/portmacro.h"\r
-#endif\r
-\r
-#ifdef GCC_ARMCM3\r
- #include "../../Source/portable/GCC/ARM_CM3/portmacro.h"\r
-#endif\r
-\r
-#ifdef IAR_ARM_CM3\r
- #include "../../Source/portable/IAR/ARM_CM3/portmacro.h"\r
-#endif\r
-\r
-#ifdef IAR_ARMCM3_LM\r
- #include "../../Source/portable/IAR/ARM_CM3/portmacro.h"\r
-#endif\r
-\r
-#ifdef HCS12_CODE_WARRIOR\r
- #include "../../Source/portable/CodeWarrior/HCS12/portmacro.h"\r
-#endif\r
-\r
-#ifdef MICROBLAZE_GCC\r
- #include "../../Source/portable/GCC/MicroBlaze/portmacro.h"\r
-#endif\r
-\r
-#ifdef TERN_EE\r
- #include "..\..\Source\portable\Paradigm\Tern_EE\small\portmacro.h"\r
-#endif\r
-\r
-#ifdef GCC_HCS12\r
- #include "../../Source/portable/GCC/HCS12/portmacro.h"\r
-#endif\r
-\r
-#ifdef GCC_MCF5235\r
- #include "../../Source/portable/GCC/MCF5235/portmacro.h"\r
-#endif\r
-\r
-#ifdef COLDFIRE_V2_GCC\r
- #include "../../../Source/portable/GCC/ColdFire_V2/portmacro.h"\r
-#endif\r
-\r
-#ifdef COLDFIRE_V2_CODEWARRIOR\r
- #include "../../Source/portable/CodeWarrior/ColdFire_V2/portmacro.h"\r
-#endif\r
-\r
-#ifdef GCC_PPC405\r
- #include "../../Source/portable/GCC/PPC405_Xilinx/portmacro.h"\r
-#endif\r
-\r
-#ifdef GCC_PPC440\r
- #include "../../Source/portable/GCC/PPC440_Xilinx/portmacro.h"\r
-#endif\r
-\r
-#ifdef _16FX_SOFTUNE\r
- #include "..\..\Source\portable\Softune\MB96340\portmacro.h"\r
-#endif\r
-\r
-#ifdef BCC_INDUSTRIAL_PC_PORT\r
- /* A short file name has to be used in place of the normal\r
- FreeRTOSConfig.h when using the Borland compiler. */\r
- #include "frconfig.h"\r
- #include "..\portable\BCC\16BitDOS\PC\prtmacro.h"\r
- typedef void ( __interrupt __far *pxISR )();\r
-#endif\r
-\r
-#ifdef BCC_FLASH_LITE_186_PORT\r
- /* A short file name has to be used in place of the normal\r
- FreeRTOSConfig.h when using the Borland compiler. */\r
- #include "frconfig.h"\r
- #include "..\portable\BCC\16BitDOS\flsh186\prtmacro.h"\r
- typedef void ( __interrupt __far *pxISR )();\r
-#endif\r
-\r
-#ifdef __GNUC__\r
- #ifdef __AVR32_AVR32A__\r
- #include "portmacro.h"\r
- #endif\r
-#endif\r
-\r
-#ifdef __ICCAVR32__\r
- #ifdef __CORE__\r
- #if __CORE__ == __AVR32A__\r
- #include "portmacro.h"\r
- #endif\r
- #endif\r
-#endif\r
-\r
-#ifdef __91467D\r
- #include "portmacro.h"\r
-#endif\r
-\r
-#ifdef __96340\r
- #include "portmacro.h"\r
-#endif\r
-\r
-\r
-#ifdef __IAR_V850ES_Fx3__\r
- #include "../../Source/portable/IAR/V850ES/portmacro.h"\r
-#endif\r
-\r
-#ifdef __IAR_V850ES_Jx3__\r
- #include "../../Source/portable/IAR/V850ES/portmacro.h"\r
-#endif\r
-\r
-#ifdef __IAR_V850ES_Jx3_L__\r
- #include "../../Source/portable/IAR/V850ES/portmacro.h"\r
-#endif\r
-\r
-#ifdef __IAR_V850ES_Jx2__\r
- #include "../../Source/portable/IAR/V850ES/portmacro.h"\r
-#endif\r
-\r
-#ifdef __IAR_V850ES_Hx2__\r
- #include "../../Source/portable/IAR/V850ES/portmacro.h"\r
-#endif\r
-\r
-#ifdef __IAR_78K0R_Kx3__\r
- #include "../../Source/portable/IAR/78K0R/portmacro.h"\r
-#endif\r
-\r
-#ifdef __IAR_78K0R_Kx3L__\r
- #include "../../Source/portable/IAR/78K0R/portmacro.h"\r
-#endif\r
-\r
-#endif /* DEPRECATED_DEFINITIONS_H */\r
-\r
+++ /dev/null
-/*\r
- * FreeRTOS Kernel V10.0.1\r
- * Copyright (C) 2017 Amazon.com, Inc. or its affiliates. All Rights Reserved.\r
- *\r
- * Permission is hereby granted, free of charge, to any person obtaining a copy of\r
- * this software and associated documentation files (the "Software"), to deal in\r
- * the Software without restriction, including without limitation the rights to\r
- * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of\r
- * the Software, and to permit persons to whom the Software is furnished to do so,\r
- * subject to the following conditions:\r
- *\r
- * The above copyright notice and this permission notice shall be included in all\r
- * copies or substantial portions of the Software.\r
- *\r
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\r
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS\r
- * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR\r
- * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER\r
- * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN\r
- * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\r
- *\r
- * http://www.FreeRTOS.org\r
- * http://aws.amazon.com/freertos\r
- *\r
- * 1 tab == 4 spaces!\r
- */\r
-\r
-#ifndef EVENT_GROUPS_H\r
-#define EVENT_GROUPS_H\r
-\r
-#ifndef INC_FREERTOS_H\r
- #error "include FreeRTOS.h" must appear in source files before "include event_groups.h"\r
-#endif\r
-\r
-/* FreeRTOS includes. */\r
-#include "timers.h"\r
-\r
-#ifdef __cplusplus\r
-extern "C" {\r
-#endif\r
-\r
-/**\r
- * An event group is a collection of bits to which an application can assign a\r
- * meaning. For example, an application may create an event group to convey\r
- * the status of various CAN bus related events in which bit 0 might mean "A CAN\r
- * message has been received and is ready for processing", bit 1 might mean "The\r
- * application has queued a message that is ready for sending onto the CAN\r
- * network", and bit 2 might mean "It is time to send a SYNC message onto the\r
- * CAN network" etc. A task can then test the bit values to see which events\r
- * are active, and optionally enter the Blocked state to wait for a specified\r
- * bit or a group of specified bits to be active. To continue the CAN bus\r
- * example, a CAN controlling task can enter the Blocked state (and therefore\r
- * not consume any processing time) until either bit 0, bit 1 or bit 2 are\r
- * active, at which time the bit that was actually active would inform the task\r
- * which action it had to take (process a received message, send a message, or\r
- * send a SYNC).\r
- *\r
- * The event groups implementation contains intelligence to avoid race\r
- * conditions that would otherwise occur were an application to use a simple\r
- * variable for the same purpose. This is particularly important with respect\r
- * to when a bit within an event group is to be cleared, and when bits have to\r
- * be set and then tested atomically - as is the case where event groups are\r
- * used to create a synchronisation point between multiple tasks (a\r
- * 'rendezvous').\r
- *\r
- * \defgroup EventGroup\r
- */\r
-\r
-\r
-\r
-/**\r
- * event_groups.h\r
- *\r
- * Type by which event groups are referenced. For example, a call to\r
- * xEventGroupCreate() returns an EventGroupHandle_t variable that can then\r
- * be used as a parameter to other event group functions.\r
- *\r
- * \defgroup EventGroupHandle_t EventGroupHandle_t\r
- * \ingroup EventGroup\r
- */\r
-typedef void * EventGroupHandle_t;\r
-\r
-/*\r
- * The type that holds event bits always matches TickType_t - therefore the\r
- * number of bits it holds is set by configUSE_16_BIT_TICKS (16 bits if set to 1,\r
- * 32 bits if set to 0.\r
- *\r
- * \defgroup EventBits_t EventBits_t\r
- * \ingroup EventGroup\r
- */\r
-typedef TickType_t EventBits_t;\r
-\r
-/**\r
- * event_groups.h\r
- *<pre>\r
- EventGroupHandle_t xEventGroupCreate( void );\r
- </pre>\r
- *\r
- * Create a new event group.\r
- *\r
- * Internally, within the FreeRTOS implementation, event groups use a [small]\r
- * block of memory, in which the event group's structure is stored. If an event\r
- * groups is created using xEventGropuCreate() then the required memory is\r
- * automatically dynamically allocated inside the xEventGroupCreate() function.\r
- * (see http://www.freertos.org/a00111.html). If an event group is created\r
- * using xEventGropuCreateStatic() then the application writer must instead\r
- * provide the memory that will get used by the event group.\r
- * xEventGroupCreateStatic() therefore allows an event group to be created\r
- * without using any dynamic memory allocation.\r
- *\r
- * Although event groups are not related to ticks, for internal implementation\r
- * reasons the number of bits available for use in an event group is dependent\r
- * on the configUSE_16_BIT_TICKS setting in FreeRTOSConfig.h. If\r
- * configUSE_16_BIT_TICKS is 1 then each event group contains 8 usable bits (bit\r
- * 0 to bit 7). If configUSE_16_BIT_TICKS is set to 0 then each event group has\r
- * 24 usable bits (bit 0 to bit 23). The EventBits_t type is used to store\r
- * event bits within an event group.\r
- *\r
- * @return If the event group was created then a handle to the event group is\r
- * returned. If there was insufficient FreeRTOS heap available to create the\r
- * event group then NULL is returned. See http://www.freertos.org/a00111.html\r
- *\r
- * Example usage:\r
- <pre>\r
- // Declare a variable to hold the created event group.\r
- EventGroupHandle_t xCreatedEventGroup;\r
-\r
- // Attempt to create the event group.\r
- xCreatedEventGroup = xEventGroupCreate();\r
-\r
- // Was the event group created successfully?\r
- if( xCreatedEventGroup == NULL )\r
- {\r
- // The event group was not created because there was insufficient\r
- // FreeRTOS heap available.\r
- }\r
- else\r
- {\r
- // The event group was created.\r
- }\r
- </pre>\r
- * \defgroup xEventGroupCreate xEventGroupCreate\r
- * \ingroup EventGroup\r
- */\r
-#if( configSUPPORT_DYNAMIC_ALLOCATION == 1 )\r
- EventGroupHandle_t xEventGroupCreate( void ) PRIVILEGED_FUNCTION;\r
-#endif\r
-\r
-/**\r
- * event_groups.h\r
- *<pre>\r
- EventGroupHandle_t xEventGroupCreateStatic( EventGroupHandle_t * pxEventGroupBuffer );\r
- </pre>\r
- *\r
- * Create a new event group.\r
- *\r
- * Internally, within the FreeRTOS implementation, event groups use a [small]\r
- * block of memory, in which the event group's structure is stored. If an event\r
- * groups is created using xEventGropuCreate() then the required memory is\r
- * automatically dynamically allocated inside the xEventGroupCreate() function.\r
- * (see http://www.freertos.org/a00111.html). If an event group is created\r
- * using xEventGropuCreateStatic() then the application writer must instead\r
- * provide the memory that will get used by the event group.\r
- * xEventGroupCreateStatic() therefore allows an event group to be created\r
- * without using any dynamic memory allocation.\r
- *\r
- * Although event groups are not related to ticks, for internal implementation\r
- * reasons the number of bits available for use in an event group is dependent\r
- * on the configUSE_16_BIT_TICKS setting in FreeRTOSConfig.h. If\r
- * configUSE_16_BIT_TICKS is 1 then each event group contains 8 usable bits (bit\r
- * 0 to bit 7). If configUSE_16_BIT_TICKS is set to 0 then each event group has\r
- * 24 usable bits (bit 0 to bit 23). The EventBits_t type is used to store\r
- * event bits within an event group.\r
- *\r
- * @param pxEventGroupBuffer pxEventGroupBuffer must point to a variable of type\r
- * StaticEventGroup_t, which will be then be used to hold the event group's data\r
- * structures, removing the need for the memory to be allocated dynamically.\r
- *\r
- * @return If the event group was created then a handle to the event group is\r
- * returned. If pxEventGroupBuffer was NULL then NULL is returned.\r
- *\r
- * Example usage:\r
- <pre>\r
- // StaticEventGroup_t is a publicly accessible structure that has the same\r
- // size and alignment requirements as the real event group structure. It is\r
- // provided as a mechanism for applications to know the size of the event\r
- // group (which is dependent on the architecture and configuration file\r
- // settings) without breaking the strict data hiding policy by exposing the\r
- // real event group internals. This StaticEventGroup_t variable is passed\r
- // into the xSemaphoreCreateEventGroupStatic() function and is used to store\r
- // the event group's data structures\r
- StaticEventGroup_t xEventGroupBuffer;\r
-\r
- // Create the event group without dynamically allocating any memory.\r
- xEventGroup = xEventGroupCreateStatic( &xEventGroupBuffer );\r
- </pre>\r
- */\r
-#if( configSUPPORT_STATIC_ALLOCATION == 1 )\r
- EventGroupHandle_t xEventGroupCreateStatic( StaticEventGroup_t *pxEventGroupBuffer ) PRIVILEGED_FUNCTION;\r
-#endif\r
-\r
-/**\r
- * event_groups.h\r
- *<pre>\r
- EventBits_t xEventGroupWaitBits( EventGroupHandle_t xEventGroup,\r
- const EventBits_t uxBitsToWaitFor,\r
- const BaseType_t xClearOnExit,\r
- const BaseType_t xWaitForAllBits,\r
- const TickType_t xTicksToWait );\r
- </pre>\r
- *\r
- * [Potentially] block to wait for one or more bits to be set within a\r
- * previously created event group.\r
- *\r
- * This function cannot be called from an interrupt.\r
- *\r
- * @param xEventGroup The event group in which the bits are being tested. The\r
- * event group must have previously been created using a call to\r
- * xEventGroupCreate().\r
- *\r
- * @param uxBitsToWaitFor A bitwise value that indicates the bit or bits to test\r
- * inside the event group. For example, to wait for bit 0 and/or bit 2 set\r
- * uxBitsToWaitFor to 0x05. To wait for bits 0 and/or bit 1 and/or bit 2 set\r
- * uxBitsToWaitFor to 0x07. Etc.\r
- *\r
- * @param xClearOnExit If xClearOnExit is set to pdTRUE then any bits within\r
- * uxBitsToWaitFor that are set within the event group will be cleared before\r
- * xEventGroupWaitBits() returns if the wait condition was met (if the function\r
- * returns for a reason other than a timeout). If xClearOnExit is set to\r
- * pdFALSE then the bits set in the event group are not altered when the call to\r
- * xEventGroupWaitBits() returns.\r
- *\r
- * @param xWaitForAllBits If xWaitForAllBits is set to pdTRUE then\r
- * xEventGroupWaitBits() will return when either all the bits in uxBitsToWaitFor\r
- * are set or the specified block time expires. If xWaitForAllBits is set to\r
- * pdFALSE then xEventGroupWaitBits() will return when any one of the bits set\r
- * in uxBitsToWaitFor is set or the specified block time expires. The block\r
- * time is specified by the xTicksToWait parameter.\r
- *\r
- * @param xTicksToWait The maximum amount of time (specified in 'ticks') to wait\r
- * for one/all (depending on the xWaitForAllBits value) of the bits specified by\r
- * uxBitsToWaitFor to become set.\r
- *\r
- * @return The value of the event group at the time either the bits being waited\r
- * for became set, or the block time expired. Test the return value to know\r
- * which bits were set. If xEventGroupWaitBits() returned because its timeout\r
- * expired then not all the bits being waited for will be set. If\r
- * xEventGroupWaitBits() returned because the bits it was waiting for were set\r
- * then the returned value is the event group value before any bits were\r
- * automatically cleared in the case that xClearOnExit parameter was set to\r
- * pdTRUE.\r
- *\r
- * Example usage:\r
- <pre>\r
- #define BIT_0 ( 1 << 0 )\r
- #define BIT_4 ( 1 << 4 )\r
-\r
- void aFunction( EventGroupHandle_t xEventGroup )\r
- {\r
- EventBits_t uxBits;\r
- const TickType_t xTicksToWait = 100 / portTICK_PERIOD_MS;\r
-\r
- // Wait a maximum of 100ms for either bit 0 or bit 4 to be set within\r
- // the event group. Clear the bits before exiting.\r
- uxBits = xEventGroupWaitBits(\r
- xEventGroup, // The event group being tested.\r
- BIT_0 | BIT_4, // The bits within the event group to wait for.\r
- pdTRUE, // BIT_0 and BIT_4 should be cleared before returning.\r
- pdFALSE, // Don't wait for both bits, either bit will do.\r
- xTicksToWait ); // Wait a maximum of 100ms for either bit to be set.\r
-\r
- if( ( uxBits & ( BIT_0 | BIT_4 ) ) == ( BIT_0 | BIT_4 ) )\r
- {\r
- // xEventGroupWaitBits() returned because both bits were set.\r
- }\r
- else if( ( uxBits & BIT_0 ) != 0 )\r
- {\r
- // xEventGroupWaitBits() returned because just BIT_0 was set.\r
- }\r
- else if( ( uxBits & BIT_4 ) != 0 )\r
- {\r
- // xEventGroupWaitBits() returned because just BIT_4 was set.\r
- }\r
- else\r
- {\r
- // xEventGroupWaitBits() returned because xTicksToWait ticks passed\r
- // without either BIT_0 or BIT_4 becoming set.\r
- }\r
- }\r
- </pre>\r
- * \defgroup xEventGroupWaitBits xEventGroupWaitBits\r
- * \ingroup EventGroup\r
- */\r
-EventBits_t xEventGroupWaitBits( EventGroupHandle_t xEventGroup, const EventBits_t uxBitsToWaitFor, const BaseType_t xClearOnExit, const BaseType_t xWaitForAllBits, TickType_t xTicksToWait ) PRIVILEGED_FUNCTION;\r
-\r
-/**\r
- * event_groups.h\r
- *<pre>\r
- EventBits_t xEventGroupClearBits( EventGroupHandle_t xEventGroup, const EventBits_t uxBitsToClear );\r
- </pre>\r
- *\r
- * Clear bits within an event group. This function cannot be called from an\r
- * interrupt.\r
- *\r
- * @param xEventGroup The event group in which the bits are to be cleared.\r
- *\r
- * @param uxBitsToClear A bitwise value that indicates the bit or bits to clear\r
- * in the event group. For example, to clear bit 3 only, set uxBitsToClear to\r
- * 0x08. To clear bit 3 and bit 0 set uxBitsToClear to 0x09.\r
- *\r
- * @return The value of the event group before the specified bits were cleared.\r
- *\r
- * Example usage:\r
- <pre>\r
- #define BIT_0 ( 1 << 0 )\r
- #define BIT_4 ( 1 << 4 )\r
-\r
- void aFunction( EventGroupHandle_t xEventGroup )\r
- {\r
- EventBits_t uxBits;\r
-\r
- // Clear bit 0 and bit 4 in xEventGroup.\r
- uxBits = xEventGroupClearBits(\r
- xEventGroup, // The event group being updated.\r
- BIT_0 | BIT_4 );// The bits being cleared.\r
-\r
- if( ( uxBits & ( BIT_0 | BIT_4 ) ) == ( BIT_0 | BIT_4 ) )\r
- {\r
- // Both bit 0 and bit 4 were set before xEventGroupClearBits() was\r
- // called. Both will now be clear (not set).\r
- }\r
- else if( ( uxBits & BIT_0 ) != 0 )\r
- {\r
- // Bit 0 was set before xEventGroupClearBits() was called. It will\r
- // now be clear.\r
- }\r
- else if( ( uxBits & BIT_4 ) != 0 )\r
- {\r
- // Bit 4 was set before xEventGroupClearBits() was called. It will\r
- // now be clear.\r
- }\r
- else\r
- {\r
- // Neither bit 0 nor bit 4 were set in the first place.\r
- }\r
- }\r
- </pre>\r
- * \defgroup xEventGroupClearBits xEventGroupClearBits\r
- * \ingroup EventGroup\r
- */\r
-EventBits_t xEventGroupClearBits( EventGroupHandle_t xEventGroup, const EventBits_t uxBitsToClear ) PRIVILEGED_FUNCTION;\r
-\r
-/**\r
- * event_groups.h\r
- *<pre>\r
- BaseType_t xEventGroupClearBitsFromISR( EventGroupHandle_t xEventGroup, const EventBits_t uxBitsToSet );\r
- </pre>\r
- *\r
- * A version of xEventGroupClearBits() that can be called from an interrupt.\r
- *\r
- * Setting bits in an event group is not a deterministic operation because there\r
- * are an unknown number of tasks that may be waiting for the bit or bits being\r
- * set. FreeRTOS does not allow nondeterministic operations to be performed\r
- * while interrupts are disabled, so protects event groups that are accessed\r
- * from tasks by suspending the scheduler rather than disabling interrupts. As\r
- * a result event groups cannot be accessed directly from an interrupt service\r
- * routine. Therefore xEventGroupClearBitsFromISR() sends a message to the\r
- * timer task to have the clear operation performed in the context of the timer\r
- * task.\r
- *\r
- * @param xEventGroup The event group in which the bits are to be cleared.\r
- *\r
- * @param uxBitsToClear A bitwise value that indicates the bit or bits to clear.\r
- * For example, to clear bit 3 only, set uxBitsToClear to 0x08. To clear bit 3\r
- * and bit 0 set uxBitsToClear to 0x09.\r
- *\r
- * @return If the request to execute the function was posted successfully then\r
- * pdPASS is returned, otherwise pdFALSE is returned. pdFALSE will be returned\r
- * if the timer service queue was full.\r
- *\r
- * Example usage:\r
- <pre>\r
- #define BIT_0 ( 1 << 0 )\r
- #define BIT_4 ( 1 << 4 )\r
-\r
- // An event group which it is assumed has already been created by a call to\r
- // xEventGroupCreate().\r
- EventGroupHandle_t xEventGroup;\r
-\r
- void anInterruptHandler( void )\r
- {\r
- // Clear bit 0 and bit 4 in xEventGroup.\r
- xResult = xEventGroupClearBitsFromISR(\r
- xEventGroup, // The event group being updated.\r
- BIT_0 | BIT_4 ); // The bits being set.\r
-\r
- if( xResult == pdPASS )\r
- {\r
- // The message was posted successfully.\r
- }\r
- }\r
- </pre>\r
- * \defgroup xEventGroupClearBitsFromISR xEventGroupClearBitsFromISR\r
- * \ingroup EventGroup\r
- */\r
-#if( configUSE_TRACE_FACILITY == 1 )\r
- BaseType_t xEventGroupClearBitsFromISR( EventGroupHandle_t xEventGroup, const EventBits_t uxBitsToSet ) PRIVILEGED_FUNCTION;\r
-#else\r
- #define xEventGroupClearBitsFromISR( xEventGroup, uxBitsToClear ) xTimerPendFunctionCallFromISR( vEventGroupClearBitsCallback, ( void * ) xEventGroup, ( uint32_t ) uxBitsToClear, NULL )\r
-#endif\r
-\r
-/**\r
- * event_groups.h\r
- *<pre>\r
- EventBits_t xEventGroupSetBits( EventGroupHandle_t xEventGroup, const EventBits_t uxBitsToSet );\r
- </pre>\r
- *\r
- * Set bits within an event group.\r
- * This function cannot be called from an interrupt. xEventGroupSetBitsFromISR()\r
- * is a version that can be called from an interrupt.\r
- *\r
- * Setting bits in an event group will automatically unblock tasks that are\r
- * blocked waiting for the bits.\r
- *\r
- * @param xEventGroup The event group in which the bits are to be set.\r
- *\r
- * @param uxBitsToSet A bitwise value that indicates the bit or bits to set.\r
- * For example, to set bit 3 only, set uxBitsToSet to 0x08. To set bit 3\r
- * and bit 0 set uxBitsToSet to 0x09.\r
- *\r
- * @return The value of the event group at the time the call to\r
- * xEventGroupSetBits() returns. There are two reasons why the returned value\r
- * might have the bits specified by the uxBitsToSet parameter cleared. First,\r
- * if setting a bit results in a task that was waiting for the bit leaving the\r
- * blocked state then it is possible the bit will be cleared automatically\r
- * (see the xClearBitOnExit parameter of xEventGroupWaitBits()). Second, any\r
- * unblocked (or otherwise Ready state) task that has a priority above that of\r
- * the task that called xEventGroupSetBits() will execute and may change the\r
- * event group value before the call to xEventGroupSetBits() returns.\r
- *\r
- * Example usage:\r
- <pre>\r
- #define BIT_0 ( 1 << 0 )\r
- #define BIT_4 ( 1 << 4 )\r
-\r
- void aFunction( EventGroupHandle_t xEventGroup )\r
- {\r
- EventBits_t uxBits;\r
-\r
- // Set bit 0 and bit 4 in xEventGroup.\r
- uxBits = xEventGroupSetBits(\r
- xEventGroup, // The event group being updated.\r
- BIT_0 | BIT_4 );// The bits being set.\r
-\r
- if( ( uxBits & ( BIT_0 | BIT_4 ) ) == ( BIT_0 | BIT_4 ) )\r
- {\r
- // Both bit 0 and bit 4 remained set when the function returned.\r
- }\r
- else if( ( uxBits & BIT_0 ) != 0 )\r
- {\r
- // Bit 0 remained set when the function returned, but bit 4 was\r
- // cleared. It might be that bit 4 was cleared automatically as a\r
- // task that was waiting for bit 4 was removed from the Blocked\r
- // state.\r
- }\r
- else if( ( uxBits & BIT_4 ) != 0 )\r
- {\r
- // Bit 4 remained set when the function returned, but bit 0 was\r
- // cleared. It might be that bit 0 was cleared automatically as a\r
- // task that was waiting for bit 0 was removed from the Blocked\r
- // state.\r
- }\r
- else\r
- {\r
- // Neither bit 0 nor bit 4 remained set. It might be that a task\r
- // was waiting for both of the bits to be set, and the bits were\r
- // cleared as the task left the Blocked state.\r
- }\r
- }\r
- </pre>\r
- * \defgroup xEventGroupSetBits xEventGroupSetBits\r
- * \ingroup EventGroup\r
- */\r
-EventBits_t xEventGroupSetBits( EventGroupHandle_t xEventGroup, const EventBits_t uxBitsToSet ) PRIVILEGED_FUNCTION;\r
-\r
-/**\r
- * event_groups.h\r
- *<pre>\r
- BaseType_t xEventGroupSetBitsFromISR( EventGroupHandle_t xEventGroup, const EventBits_t uxBitsToSet, BaseType_t *pxHigherPriorityTaskWoken );\r
- </pre>\r
- *\r
- * A version of xEventGroupSetBits() that can be called from an interrupt.\r
- *\r
- * Setting bits in an event group is not a deterministic operation because there\r
- * are an unknown number of tasks that may be waiting for the bit or bits being\r
- * set. FreeRTOS does not allow nondeterministic operations to be performed in\r
- * interrupts or from critical sections. Therefore xEventGroupSetBitsFromISR()\r
- * sends a message to the timer task to have the set operation performed in the\r
- * context of the timer task - where a scheduler lock is used in place of a\r
- * critical section.\r
- *\r
- * @param xEventGroup The event group in which the bits are to be set.\r
- *\r
- * @param uxBitsToSet A bitwise value that indicates the bit or bits to set.\r
- * For example, to set bit 3 only, set uxBitsToSet to 0x08. To set bit 3\r
- * and bit 0 set uxBitsToSet to 0x09.\r
- *\r
- * @param pxHigherPriorityTaskWoken As mentioned above, calling this function\r
- * will result in a message being sent to the timer daemon task. If the\r
- * priority of the timer daemon task is higher than the priority of the\r
- * currently running task (the task the interrupt interrupted) then\r
- * *pxHigherPriorityTaskWoken will be set to pdTRUE by\r
- * xEventGroupSetBitsFromISR(), indicating that a context switch should be\r
- * requested before the interrupt exits. For that reason\r
- * *pxHigherPriorityTaskWoken must be initialised to pdFALSE. See the\r
- * example code below.\r
- *\r
- * @return If the request to execute the function was posted successfully then\r
- * pdPASS is returned, otherwise pdFALSE is returned. pdFALSE will be returned\r
- * if the timer service queue was full.\r
- *\r
- * Example usage:\r
- <pre>\r
- #define BIT_0 ( 1 << 0 )\r
- #define BIT_4 ( 1 << 4 )\r
-\r
- // An event group which it is assumed has already been created by a call to\r
- // xEventGroupCreate().\r
- EventGroupHandle_t xEventGroup;\r
-\r
- void anInterruptHandler( void )\r
- {\r
- BaseType_t xHigherPriorityTaskWoken, xResult;\r
-\r
- // xHigherPriorityTaskWoken must be initialised to pdFALSE.\r
- xHigherPriorityTaskWoken = pdFALSE;\r
-\r
- // Set bit 0 and bit 4 in xEventGroup.\r
- xResult = xEventGroupSetBitsFromISR(\r
- xEventGroup, // The event group being updated.\r
- BIT_0 | BIT_4 // The bits being set.\r
- &xHigherPriorityTaskWoken );\r
-\r
- // Was the message posted successfully?\r
- if( xResult == pdPASS )\r
- {\r
- // If xHigherPriorityTaskWoken is now set to pdTRUE then a context\r
- // switch should be requested. The macro used is port specific and\r
- // will be either portYIELD_FROM_ISR() or portEND_SWITCHING_ISR() -\r
- // refer to the documentation page for the port being used.\r
- portYIELD_FROM_ISR( xHigherPriorityTaskWoken );\r
- }\r
- }\r
- </pre>\r
- * \defgroup xEventGroupSetBitsFromISR xEventGroupSetBitsFromISR\r
- * \ingroup EventGroup\r
- */\r
-#if( configUSE_TRACE_FACILITY == 1 )\r
- BaseType_t xEventGroupSetBitsFromISR( EventGroupHandle_t xEventGroup, const EventBits_t uxBitsToSet, BaseType_t *pxHigherPriorityTaskWoken ) PRIVILEGED_FUNCTION;\r
-#else\r
- #define xEventGroupSetBitsFromISR( xEventGroup, uxBitsToSet, pxHigherPriorityTaskWoken ) xTimerPendFunctionCallFromISR( vEventGroupSetBitsCallback, ( void * ) xEventGroup, ( uint32_t ) uxBitsToSet, pxHigherPriorityTaskWoken )\r
-#endif\r
-\r
-/**\r
- * event_groups.h\r
- *<pre>\r
- EventBits_t xEventGroupSync( EventGroupHandle_t xEventGroup,\r
- const EventBits_t uxBitsToSet,\r
- const EventBits_t uxBitsToWaitFor,\r
- TickType_t xTicksToWait );\r
- </pre>\r
- *\r
- * Atomically set bits within an event group, then wait for a combination of\r
- * bits to be set within the same event group. This functionality is typically\r
- * used to synchronise multiple tasks, where each task has to wait for the other\r
- * tasks to reach a synchronisation point before proceeding.\r
- *\r
- * This function cannot be used from an interrupt.\r
- *\r
- * The function will return before its block time expires if the bits specified\r
- * by the uxBitsToWait parameter are set, or become set within that time. In\r
- * this case all the bits specified by uxBitsToWait will be automatically\r
- * cleared before the function returns.\r
- *\r
- * @param xEventGroup The event group in which the bits are being tested. The\r
- * event group must have previously been created using a call to\r
- * xEventGroupCreate().\r
- *\r
- * @param uxBitsToSet The bits to set in the event group before determining\r
- * if, and possibly waiting for, all the bits specified by the uxBitsToWait\r
- * parameter are set.\r
- *\r
- * @param uxBitsToWaitFor A bitwise value that indicates the bit or bits to test\r
- * inside the event group. For example, to wait for bit 0 and bit 2 set\r
- * uxBitsToWaitFor to 0x05. To wait for bits 0 and bit 1 and bit 2 set\r
- * uxBitsToWaitFor to 0x07. Etc.\r
- *\r
- * @param xTicksToWait The maximum amount of time (specified in 'ticks') to wait\r
- * for all of the bits specified by uxBitsToWaitFor to become set.\r
- *\r
- * @return The value of the event group at the time either the bits being waited\r
- * for became set, or the block time expired. Test the return value to know\r
- * which bits were set. If xEventGroupSync() returned because its timeout\r
- * expired then not all the bits being waited for will be set. If\r
- * xEventGroupSync() returned because all the bits it was waiting for were\r
- * set then the returned value is the event group value before any bits were\r
- * automatically cleared.\r
- *\r
- * Example usage:\r
- <pre>\r
- // Bits used by the three tasks.\r
- #define TASK_0_BIT ( 1 << 0 )\r
- #define TASK_1_BIT ( 1 << 1 )\r
- #define TASK_2_BIT ( 1 << 2 )\r
-\r
- #define ALL_SYNC_BITS ( TASK_0_BIT | TASK_1_BIT | TASK_2_BIT )\r
-\r
- // Use an event group to synchronise three tasks. It is assumed this event\r
- // group has already been created elsewhere.\r
- EventGroupHandle_t xEventBits;\r
-\r
- void vTask0( void *pvParameters )\r
- {\r
- EventBits_t uxReturn;\r
- TickType_t xTicksToWait = 100 / portTICK_PERIOD_MS;\r
-\r
- for( ;; )\r
- {\r
- // Perform task functionality here.\r
-\r
- // Set bit 0 in the event flag to note this task has reached the\r
- // sync point. The other two tasks will set the other two bits defined\r
- // by ALL_SYNC_BITS. All three tasks have reached the synchronisation\r
- // point when all the ALL_SYNC_BITS are set. Wait a maximum of 100ms\r
- // for this to happen.\r
- uxReturn = xEventGroupSync( xEventBits, TASK_0_BIT, ALL_SYNC_BITS, xTicksToWait );\r
-\r
- if( ( uxReturn & ALL_SYNC_BITS ) == ALL_SYNC_BITS )\r
- {\r
- // All three tasks reached the synchronisation point before the call\r
- // to xEventGroupSync() timed out.\r
- }\r
- }\r
- }\r
-\r
- void vTask1( void *pvParameters )\r
- {\r
- for( ;; )\r
- {\r
- // Perform task functionality here.\r
-\r
- // Set bit 1 in the event flag to note this task has reached the\r
- // synchronisation point. The other two tasks will set the other two\r
- // bits defined by ALL_SYNC_BITS. All three tasks have reached the\r
- // synchronisation point when all the ALL_SYNC_BITS are set. Wait\r
- // indefinitely for this to happen.\r
- xEventGroupSync( xEventBits, TASK_1_BIT, ALL_SYNC_BITS, portMAX_DELAY );\r
-\r
- // xEventGroupSync() was called with an indefinite block time, so\r
- // this task will only reach here if the syncrhonisation was made by all\r
- // three tasks, so there is no need to test the return value.\r
- }\r
- }\r
-\r
- void vTask2( void *pvParameters )\r
- {\r
- for( ;; )\r
- {\r
- // Perform task functionality here.\r
-\r
- // Set bit 2 in the event flag to note this task has reached the\r
- // synchronisation point. The other two tasks will set the other two\r
- // bits defined by ALL_SYNC_BITS. All three tasks have reached the\r
- // synchronisation point when all the ALL_SYNC_BITS are set. Wait\r
- // indefinitely for this to happen.\r
- xEventGroupSync( xEventBits, TASK_2_BIT, ALL_SYNC_BITS, portMAX_DELAY );\r
-\r
- // xEventGroupSync() was called with an indefinite block time, so\r
- // this task will only reach here if the syncrhonisation was made by all\r
- // three tasks, so there is no need to test the return value.\r
- }\r
- }\r
-\r
- </pre>\r
- * \defgroup xEventGroupSync xEventGroupSync\r
- * \ingroup EventGroup\r
- */\r
-EventBits_t xEventGroupSync( EventGroupHandle_t xEventGroup, const EventBits_t uxBitsToSet, const EventBits_t uxBitsToWaitFor, TickType_t xTicksToWait ) PRIVILEGED_FUNCTION;\r
-\r
-\r
-/**\r
- * event_groups.h\r
- *<pre>\r
- EventBits_t xEventGroupGetBits( EventGroupHandle_t xEventGroup );\r
- </pre>\r
- *\r
- * Returns the current value of the bits in an event group. This function\r
- * cannot be used from an interrupt.\r
- *\r
- * @param xEventGroup The event group being queried.\r
- *\r
- * @return The event group bits at the time xEventGroupGetBits() was called.\r
- *\r
- * \defgroup xEventGroupGetBits xEventGroupGetBits\r
- * \ingroup EventGroup\r
- */\r
-#define xEventGroupGetBits( xEventGroup ) xEventGroupClearBits( xEventGroup, 0 )\r
-\r
-/**\r
- * event_groups.h\r
- *<pre>\r
- EventBits_t xEventGroupGetBitsFromISR( EventGroupHandle_t xEventGroup );\r
- </pre>\r
- *\r
- * A version of xEventGroupGetBits() that can be called from an ISR.\r
- *\r
- * @param xEventGroup The event group being queried.\r
- *\r
- * @return The event group bits at the time xEventGroupGetBitsFromISR() was called.\r
- *\r
- * \defgroup xEventGroupGetBitsFromISR xEventGroupGetBitsFromISR\r
- * \ingroup EventGroup\r
- */\r
-EventBits_t xEventGroupGetBitsFromISR( EventGroupHandle_t xEventGroup ) PRIVILEGED_FUNCTION;\r
-\r
-/**\r
- * event_groups.h\r
- *<pre>\r
- void xEventGroupDelete( EventGroupHandle_t xEventGroup );\r
- </pre>\r
- *\r
- * Delete an event group that was previously created by a call to\r
- * xEventGroupCreate(). Tasks that are blocked on the event group will be\r
- * unblocked and obtain 0 as the event group's value.\r
- *\r
- * @param xEventGroup The event group being deleted.\r
- */\r
-void vEventGroupDelete( EventGroupHandle_t xEventGroup ) PRIVILEGED_FUNCTION;\r
-\r
-/* For internal use only. */\r
-void vEventGroupSetBitsCallback( void *pvEventGroup, const uint32_t ulBitsToSet ) PRIVILEGED_FUNCTION;\r
-void vEventGroupClearBitsCallback( void *pvEventGroup, const uint32_t ulBitsToClear ) PRIVILEGED_FUNCTION;\r
-\r
-\r
-#if (configUSE_TRACE_FACILITY == 1)\r
- UBaseType_t uxEventGroupGetNumber( void* xEventGroup ) PRIVILEGED_FUNCTION;\r
- void vEventGroupSetNumber( void* xEventGroup, UBaseType_t uxEventGroupNumber ) PRIVILEGED_FUNCTION;\r
-#endif\r
-\r
-#ifdef __cplusplus\r
-}\r
-#endif\r
-\r
-#endif /* EVENT_GROUPS_H */\r
-\r
-\r
+++ /dev/null
-/*\r
- * FreeRTOS Kernel V10.0.1\r
- * Copyright (C) 2017 Amazon.com, Inc. or its affiliates. All Rights Reserved.\r
- *\r
- * Permission is hereby granted, free of charge, to any person obtaining a copy of\r
- * this software and associated documentation files (the "Software"), to deal in\r
- * the Software without restriction, including without limitation the rights to\r
- * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of\r
- * the Software, and to permit persons to whom the Software is furnished to do so,\r
- * subject to the following conditions:\r
- *\r
- * The above copyright notice and this permission notice shall be included in all\r
- * copies or substantial portions of the Software.\r
- *\r
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\r
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS\r
- * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR\r
- * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER\r
- * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN\r
- * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\r
- *\r
- * http://www.FreeRTOS.org\r
- * http://aws.amazon.com/freertos\r
- *\r
- * 1 tab == 4 spaces!\r
- */\r
-\r
-/*\r
- * This is the list implementation used by the scheduler. While it is tailored\r
- * heavily for the schedulers needs, it is also available for use by\r
- * application code.\r
- *\r
- * list_ts can only store pointers to list_item_ts. Each ListItem_t contains a\r
- * numeric value (xItemValue). Most of the time the lists are sorted in\r
- * descending item value order.\r
- *\r
- * Lists are created already containing one list item. The value of this\r
- * item is the maximum possible that can be stored, it is therefore always at\r
- * the end of the list and acts as a marker. The list member pxHead always\r
- * points to this marker - even though it is at the tail of the list. This\r
- * is because the tail contains a wrap back pointer to the true head of\r
- * the list.\r
- *\r
- * In addition to it's value, each list item contains a pointer to the next\r
- * item in the list (pxNext), a pointer to the list it is in (pxContainer)\r
- * and a pointer to back to the object that contains it. These later two\r
- * pointers are included for efficiency of list manipulation. There is\r
- * effectively a two way link between the object containing the list item and\r
- * the list item itself.\r
- *\r
- *\r
- * \page ListIntroduction List Implementation\r
- * \ingroup FreeRTOSIntro\r
- */\r
-\r
-#ifndef INC_FREERTOS_H\r
- #error FreeRTOS.h must be included before list.h\r
-#endif\r
-\r
-#ifndef LIST_H\r
-#define LIST_H\r
-\r
-/*\r
- * The list structure members are modified from within interrupts, and therefore\r
- * by rights should be declared volatile. However, they are only modified in a\r
- * functionally atomic way (within critical sections of with the scheduler\r
- * suspended) and are either passed by reference into a function or indexed via\r
- * a volatile variable. Therefore, in all use cases tested so far, the volatile\r
- * qualifier can be omitted in order to provide a moderate performance\r
- * improvement without adversely affecting functional behaviour. The assembly\r
- * instructions generated by the IAR, ARM and GCC compilers when the respective\r
- * compiler's options were set for maximum optimisation has been inspected and\r
- * deemed to be as intended. That said, as compiler technology advances, and\r
- * especially if aggressive cross module optimisation is used (a use case that\r
- * has not been exercised to any great extend) then it is feasible that the\r
- * volatile qualifier will be needed for correct optimisation. It is expected\r
- * that a compiler removing essential code because, without the volatile\r
- * qualifier on the list structure members and with aggressive cross module\r
- * optimisation, the compiler deemed the code unnecessary will result in\r
- * complete and obvious failure of the scheduler. If this is ever experienced\r
- * then the volatile qualifier can be inserted in the relevant places within the\r
- * list structures by simply defining configLIST_VOLATILE to volatile in\r
- * FreeRTOSConfig.h (as per the example at the bottom of this comment block).\r
- * If configLIST_VOLATILE is not defined then the preprocessor directives below\r
- * will simply #define configLIST_VOLATILE away completely.\r
- *\r
- * To use volatile list structure members then add the following line to\r
- * FreeRTOSConfig.h (without the quotes):\r
- * "#define configLIST_VOLATILE volatile"\r
- */\r
-#ifndef configLIST_VOLATILE\r
- #define configLIST_VOLATILE\r
-#endif /* configSUPPORT_CROSS_MODULE_OPTIMISATION */\r
-\r
-#ifdef __cplusplus\r
-extern "C" {\r
-#endif\r
-\r
-/* Macros that can be used to place known values within the list structures,\r
-then check that the known values do not get corrupted during the execution of\r
-the application. These may catch the list data structures being overwritten in\r
-memory. They will not catch data errors caused by incorrect configuration or\r
-use of FreeRTOS.*/\r
-#if( configUSE_LIST_DATA_INTEGRITY_CHECK_BYTES == 0 )\r
- /* Define the macros to do nothing. */\r
- #define listFIRST_LIST_ITEM_INTEGRITY_CHECK_VALUE\r
- #define listSECOND_LIST_ITEM_INTEGRITY_CHECK_VALUE\r
- #define listFIRST_LIST_INTEGRITY_CHECK_VALUE\r
- #define listSECOND_LIST_INTEGRITY_CHECK_VALUE\r
- #define listSET_FIRST_LIST_ITEM_INTEGRITY_CHECK_VALUE( pxItem )\r
- #define listSET_SECOND_LIST_ITEM_INTEGRITY_CHECK_VALUE( pxItem )\r
- #define listSET_LIST_INTEGRITY_CHECK_1_VALUE( pxList )\r
- #define listSET_LIST_INTEGRITY_CHECK_2_VALUE( pxList )\r
- #define listTEST_LIST_ITEM_INTEGRITY( pxItem )\r
- #define listTEST_LIST_INTEGRITY( pxList )\r
-#else\r
- /* Define macros that add new members into the list structures. */\r
- #define listFIRST_LIST_ITEM_INTEGRITY_CHECK_VALUE TickType_t xListItemIntegrityValue1;\r
- #define listSECOND_LIST_ITEM_INTEGRITY_CHECK_VALUE TickType_t xListItemIntegrityValue2;\r
- #define listFIRST_LIST_INTEGRITY_CHECK_VALUE TickType_t xListIntegrityValue1;\r
- #define listSECOND_LIST_INTEGRITY_CHECK_VALUE TickType_t xListIntegrityValue2;\r
-\r
- /* Define macros that set the new structure members to known values. */\r
- #define listSET_FIRST_LIST_ITEM_INTEGRITY_CHECK_VALUE( pxItem ) ( pxItem )->xListItemIntegrityValue1 = pdINTEGRITY_CHECK_VALUE\r
- #define listSET_SECOND_LIST_ITEM_INTEGRITY_CHECK_VALUE( pxItem ) ( pxItem )->xListItemIntegrityValue2 = pdINTEGRITY_CHECK_VALUE\r
- #define listSET_LIST_INTEGRITY_CHECK_1_VALUE( pxList ) ( pxList )->xListIntegrityValue1 = pdINTEGRITY_CHECK_VALUE\r
- #define listSET_LIST_INTEGRITY_CHECK_2_VALUE( pxList ) ( pxList )->xListIntegrityValue2 = pdINTEGRITY_CHECK_VALUE\r
-\r
- /* Define macros that will assert if one of the structure members does not\r
- contain its expected value. */\r
- #define listTEST_LIST_ITEM_INTEGRITY( pxItem ) configASSERT( ( ( pxItem )->xListItemIntegrityValue1 == pdINTEGRITY_CHECK_VALUE ) && ( ( pxItem )->xListItemIntegrityValue2 == pdINTEGRITY_CHECK_VALUE ) )\r
- #define listTEST_LIST_INTEGRITY( pxList ) configASSERT( ( ( pxList )->xListIntegrityValue1 == pdINTEGRITY_CHECK_VALUE ) && ( ( pxList )->xListIntegrityValue2 == pdINTEGRITY_CHECK_VALUE ) )\r
-#endif /* configUSE_LIST_DATA_INTEGRITY_CHECK_BYTES */\r
-\r
-\r
-/*\r
- * Definition of the only type of object that a list can contain.\r
- */\r
-struct xLIST_ITEM\r
-{\r
- listFIRST_LIST_ITEM_INTEGRITY_CHECK_VALUE /*< Set to a known value if configUSE_LIST_DATA_INTEGRITY_CHECK_BYTES is set to 1. */\r
- configLIST_VOLATILE TickType_t xItemValue; /*< The value being listed. In most cases this is used to sort the list in descending order. */\r
- struct xLIST_ITEM * configLIST_VOLATILE pxNext; /*< Pointer to the next ListItem_t in the list. */\r
- struct xLIST_ITEM * configLIST_VOLATILE pxPrevious; /*< Pointer to the previous ListItem_t in the list. */\r
- void * pvOwner; /*< Pointer to the object (normally a TCB) that contains the list item. There is therefore a two way link between the object containing the list item and the list item itself. */\r
- void * configLIST_VOLATILE pvContainer; /*< Pointer to the list in which this list item is placed (if any). */\r
- listSECOND_LIST_ITEM_INTEGRITY_CHECK_VALUE /*< Set to a known value if configUSE_LIST_DATA_INTEGRITY_CHECK_BYTES is set to 1. */\r
-};\r
-typedef struct xLIST_ITEM ListItem_t; /* For some reason lint wants this as two separate definitions. */\r
-\r
-struct xMINI_LIST_ITEM\r
-{\r
- listFIRST_LIST_ITEM_INTEGRITY_CHECK_VALUE /*< Set to a known value if configUSE_LIST_DATA_INTEGRITY_CHECK_BYTES is set to 1. */\r
- configLIST_VOLATILE TickType_t xItemValue;\r
- struct xLIST_ITEM * configLIST_VOLATILE pxNext;\r
- struct xLIST_ITEM * configLIST_VOLATILE pxPrevious;\r
-};\r
-typedef struct xMINI_LIST_ITEM MiniListItem_t;\r
-\r
-/*\r
- * Definition of the type of queue used by the scheduler.\r
- */\r
-typedef struct xLIST\r
-{\r
- listFIRST_LIST_INTEGRITY_CHECK_VALUE /*< Set to a known value if configUSE_LIST_DATA_INTEGRITY_CHECK_BYTES is set to 1. */\r
- volatile UBaseType_t uxNumberOfItems;\r
- ListItem_t * configLIST_VOLATILE pxIndex; /*< Used to walk through the list. Points to the last item returned by a call to listGET_OWNER_OF_NEXT_ENTRY (). */\r
- MiniListItem_t xListEnd; /*< List item that contains the maximum possible item value meaning it is always at the end of the list and is therefore used as a marker. */\r
- listSECOND_LIST_INTEGRITY_CHECK_VALUE /*< Set to a known value if configUSE_LIST_DATA_INTEGRITY_CHECK_BYTES is set to 1. */\r
-} List_t;\r
-\r
-/*\r
- * Access macro to set the owner of a list item. The owner of a list item\r
- * is the object (usually a TCB) that contains the list item.\r
- *\r
- * \page listSET_LIST_ITEM_OWNER listSET_LIST_ITEM_OWNER\r
- * \ingroup LinkedList\r
- */\r
-#define listSET_LIST_ITEM_OWNER( pxListItem, pxOwner ) ( ( pxListItem )->pvOwner = ( void * ) ( pxOwner ) )\r
-\r
-/*\r
- * Access macro to get the owner of a list item. The owner of a list item\r
- * is the object (usually a TCB) that contains the list item.\r
- *\r
- * \page listSET_LIST_ITEM_OWNER listSET_LIST_ITEM_OWNER\r
- * \ingroup LinkedList\r
- */\r
-#define listGET_LIST_ITEM_OWNER( pxListItem ) ( ( pxListItem )->pvOwner )\r
-\r
-/*\r
- * Access macro to set the value of the list item. In most cases the value is\r
- * used to sort the list in descending order.\r
- *\r
- * \page listSET_LIST_ITEM_VALUE listSET_LIST_ITEM_VALUE\r
- * \ingroup LinkedList\r
- */\r
-#define listSET_LIST_ITEM_VALUE( pxListItem, xValue ) ( ( pxListItem )->xItemValue = ( xValue ) )\r
-\r
-/*\r
- * Access macro to retrieve the value of the list item. The value can\r
- * represent anything - for example the priority of a task, or the time at\r
- * which a task should be unblocked.\r
- *\r
- * \page listGET_LIST_ITEM_VALUE listGET_LIST_ITEM_VALUE\r
- * \ingroup LinkedList\r
- */\r
-#define listGET_LIST_ITEM_VALUE( pxListItem ) ( ( pxListItem )->xItemValue )\r
-\r
-/*\r
- * Access macro to retrieve the value of the list item at the head of a given\r
- * list.\r
- *\r
- * \page listGET_LIST_ITEM_VALUE listGET_LIST_ITEM_VALUE\r
- * \ingroup LinkedList\r
- */\r
-#define listGET_ITEM_VALUE_OF_HEAD_ENTRY( pxList ) ( ( ( pxList )->xListEnd ).pxNext->xItemValue )\r
-\r
-/*\r
- * Return the list item at the head of the list.\r
- *\r
- * \page listGET_HEAD_ENTRY listGET_HEAD_ENTRY\r
- * \ingroup LinkedList\r
- */\r
-#define listGET_HEAD_ENTRY( pxList ) ( ( ( pxList )->xListEnd ).pxNext )\r
-\r
-/*\r
- * Return the list item at the head of the list.\r
- *\r
- * \page listGET_NEXT listGET_NEXT\r
- * \ingroup LinkedList\r
- */\r
-#define listGET_NEXT( pxListItem ) ( ( pxListItem )->pxNext )\r
-\r
-/*\r
- * Return the list item that marks the end of the list\r
- *\r
- * \page listGET_END_MARKER listGET_END_MARKER\r
- * \ingroup LinkedList\r
- */\r
-#define listGET_END_MARKER( pxList ) ( ( ListItem_t const * ) ( &( ( pxList )->xListEnd ) ) )\r
-\r
-/*\r
- * Access macro to determine if a list contains any items. The macro will\r
- * only have the value true if the list is empty.\r
- *\r
- * \page listLIST_IS_EMPTY listLIST_IS_EMPTY\r
- * \ingroup LinkedList\r
- */\r
-#define listLIST_IS_EMPTY( pxList ) ( ( BaseType_t ) ( ( pxList )->uxNumberOfItems == ( UBaseType_t ) 0 ) )\r
-\r
-/*\r
- * Access macro to return the number of items in the list.\r
- */\r
-#define listCURRENT_LIST_LENGTH( pxList ) ( ( pxList )->uxNumberOfItems )\r
-\r
-/*\r
- * Access function to obtain the owner of the next entry in a list.\r
- *\r
- * The list member pxIndex is used to walk through a list. Calling\r
- * listGET_OWNER_OF_NEXT_ENTRY increments pxIndex to the next item in the list\r
- * and returns that entry's pxOwner parameter. Using multiple calls to this\r
- * function it is therefore possible to move through every item contained in\r
- * a list.\r
- *\r
- * The pxOwner parameter of a list item is a pointer to the object that owns\r
- * the list item. In the scheduler this is normally a task control block.\r
- * The pxOwner parameter effectively creates a two way link between the list\r
- * item and its owner.\r
- *\r
- * @param pxTCB pxTCB is set to the address of the owner of the next list item.\r
- * @param pxList The list from which the next item owner is to be returned.\r
- *\r
- * \page listGET_OWNER_OF_NEXT_ENTRY listGET_OWNER_OF_NEXT_ENTRY\r
- * \ingroup LinkedList\r
- */\r
-#define listGET_OWNER_OF_NEXT_ENTRY( pxTCB, pxList ) \\r
-{ \\r
-List_t * const pxConstList = ( pxList ); \\r
- /* Increment the index to the next item and return the item, ensuring */ \\r
- /* we don't return the marker used at the end of the list. */ \\r
- ( pxConstList )->pxIndex = ( pxConstList )->pxIndex->pxNext; \\r
- if( ( void * ) ( pxConstList )->pxIndex == ( void * ) &( ( pxConstList )->xListEnd ) ) \\r
- { \\r
- ( pxConstList )->pxIndex = ( pxConstList )->pxIndex->pxNext; \\r
- } \\r
- ( pxTCB ) = ( pxConstList )->pxIndex->pvOwner; \\r
-}\r
-\r
-\r
-/*\r
- * Access function to obtain the owner of the first entry in a list. Lists\r
- * are normally sorted in ascending item value order.\r
- *\r
- * This function returns the pxOwner member of the first item in the list.\r
- * The pxOwner parameter of a list item is a pointer to the object that owns\r
- * the list item. In the scheduler this is normally a task control block.\r
- * The pxOwner parameter effectively creates a two way link between the list\r
- * item and its owner.\r
- *\r
- * @param pxList The list from which the owner of the head item is to be\r
- * returned.\r
- *\r
- * \page listGET_OWNER_OF_HEAD_ENTRY listGET_OWNER_OF_HEAD_ENTRY\r
- * \ingroup LinkedList\r
- */\r
-#define listGET_OWNER_OF_HEAD_ENTRY( pxList ) ( (&( ( pxList )->xListEnd ))->pxNext->pvOwner )\r
-\r
-/*\r
- * Check to see if a list item is within a list. The list item maintains a\r
- * "container" pointer that points to the list it is in. All this macro does\r
- * is check to see if the container and the list match.\r
- *\r
- * @param pxList The list we want to know if the list item is within.\r
- * @param pxListItem The list item we want to know if is in the list.\r
- * @return pdTRUE if the list item is in the list, otherwise pdFALSE.\r
- */\r
-#define listIS_CONTAINED_WITHIN( pxList, pxListItem ) ( ( BaseType_t ) ( ( pxListItem )->pvContainer == ( void * ) ( pxList ) ) )\r
-\r
-/*\r
- * Return the list a list item is contained within (referenced from).\r
- *\r
- * @param pxListItem The list item being queried.\r
- * @return A pointer to the List_t object that references the pxListItem\r
- */\r
-#define listLIST_ITEM_CONTAINER( pxListItem ) ( ( pxListItem )->pvContainer )\r
-\r
-/*\r
- * This provides a crude means of knowing if a list has been initialised, as\r
- * pxList->xListEnd.xItemValue is set to portMAX_DELAY by the vListInitialise()\r
- * function.\r
- */\r
-#define listLIST_IS_INITIALISED( pxList ) ( ( pxList )->xListEnd.xItemValue == portMAX_DELAY )\r
-\r
-/*\r
- * Must be called before a list is used! This initialises all the members\r
- * of the list structure and inserts the xListEnd item into the list as a\r
- * marker to the back of the list.\r
- *\r
- * @param pxList Pointer to the list being initialised.\r
- *\r
- * \page vListInitialise vListInitialise\r
- * \ingroup LinkedList\r
- */\r
-void vListInitialise( List_t * const pxList ) PRIVILEGED_FUNCTION;\r
-\r
-/*\r
- * Must be called before a list item is used. This sets the list container to\r
- * null so the item does not think that it is already contained in a list.\r
- *\r
- * @param pxItem Pointer to the list item being initialised.\r
- *\r
- * \page vListInitialiseItem vListInitialiseItem\r
- * \ingroup LinkedList\r
- */\r
-void vListInitialiseItem( ListItem_t * const pxItem ) PRIVILEGED_FUNCTION;\r
-\r
-/*\r
- * Insert a list item into a list. The item will be inserted into the list in\r
- * a position determined by its item value (descending item value order).\r
- *\r
- * @param pxList The list into which the item is to be inserted.\r
- *\r
- * @param pxNewListItem The item that is to be placed in the list.\r
- *\r
- * \page vListInsert vListInsert\r
- * \ingroup LinkedList\r
- */\r
-void vListInsert( List_t * const pxList, ListItem_t * const pxNewListItem ) PRIVILEGED_FUNCTION;\r
-\r
-/*\r
- * Insert a list item into a list. The item will be inserted in a position\r
- * such that it will be the last item within the list returned by multiple\r
- * calls to listGET_OWNER_OF_NEXT_ENTRY.\r
- *\r
- * The list member pxIndex is used to walk through a list. Calling\r
- * listGET_OWNER_OF_NEXT_ENTRY increments pxIndex to the next item in the list.\r
- * Placing an item in a list using vListInsertEnd effectively places the item\r
- * in the list position pointed to by pxIndex. This means that every other\r
- * item within the list will be returned by listGET_OWNER_OF_NEXT_ENTRY before\r
- * the pxIndex parameter again points to the item being inserted.\r
- *\r
- * @param pxList The list into which the item is to be inserted.\r
- *\r
- * @param pxNewListItem The list item to be inserted into the list.\r
- *\r
- * \page vListInsertEnd vListInsertEnd\r
- * \ingroup LinkedList\r
- */\r
-void vListInsertEnd( List_t * const pxList, ListItem_t * const pxNewListItem ) PRIVILEGED_FUNCTION;\r
-\r
-/*\r
- * Remove an item from a list. The list item has a pointer to the list that\r
- * it is in, so only the list item need be passed into the function.\r
- *\r
- * @param uxListRemove The item to be removed. The item will remove itself from\r
- * the list pointed to by it's pxContainer parameter.\r
- *\r
- * @return The number of items that remain in the list after the list item has\r
- * been removed.\r
- *\r
- * \page uxListRemove uxListRemove\r
- * \ingroup LinkedList\r
- */\r
-UBaseType_t uxListRemove( ListItem_t * const pxItemToRemove ) PRIVILEGED_FUNCTION;\r
-\r
-#ifdef __cplusplus\r
-}\r
-#endif\r
-\r
-#endif\r
-\r
+++ /dev/null
-/*\r
- * FreeRTOS Kernel V10.0.1\r
- * Copyright (C) 2017 Amazon.com, Inc. or its affiliates. All Rights Reserved.\r
- *\r
- * Permission is hereby granted, free of charge, to any person obtaining a copy of\r
- * this software and associated documentation files (the "Software"), to deal in\r
- * the Software without restriction, including without limitation the rights to\r
- * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of\r
- * the Software, and to permit persons to whom the Software is furnished to do so,\r
- * subject to the following conditions:\r
- *\r
- * The above copyright notice and this permission notice shall be included in all\r
- * copies or substantial portions of the Software.\r
- *\r
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\r
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS\r
- * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR\r
- * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER\r
- * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN\r
- * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\r
- *\r
- * http://www.FreeRTOS.org\r
- * http://aws.amazon.com/freertos\r
- *\r
- * 1 tab == 4 spaces!\r
- */\r
-\r
-\r
-/*\r
- * Message buffers build functionality on top of FreeRTOS stream buffers.\r
- * Whereas stream buffers are used to send a continuous stream of data from one\r
- * task or interrupt to another, message buffers are used to send variable\r
- * length discrete messages from one task or interrupt to another. Their\r
- * implementation is light weight, making them particularly suited for interrupt\r
- * to task and core to core communication scenarios.\r
- *\r
- * ***NOTE***: Uniquely among FreeRTOS objects, the stream buffer\r
- * implementation (so also the message buffer implementation, as message buffers\r
- * are built on top of stream buffers) assumes there is only one task or\r
- * interrupt that will write to the buffer (the writer), and only one task or\r
- * interrupt that will read from the buffer (the reader). It is safe for the\r
- * writer and reader to be different tasks or interrupts, but, unlike other\r
- * FreeRTOS objects, it is not safe to have multiple different writers or\r
- * multiple different readers. If there are to be multiple different writers\r
- * then the application writer must place each call to a writing API function\r
- * (such as xMessageBufferSend()) inside a critical section and set the send\r
- * block time to 0. Likewise, if there are to be multiple different readers\r
- * then the application writer must place each call to a reading API function\r
- * (such as xMessageBufferRead()) inside a critical section and set the receive\r
- * timeout to 0.\r
- *\r
- * Message buffers hold variable length messages. To enable that, when a\r
- * message is written to the message buffer an additional sizeof( size_t ) bytes\r
- * are also written to store the message's length (that happens internally, with\r
- * the API function). sizeof( size_t ) is typically 4 bytes on a 32-bit\r
- * architecture, so writing a 10 byte message to a message buffer on a 32-bit\r
- * architecture will actually reduce the available space in the message buffer\r
- * by 14 bytes (10 byte are used by the message, and 4 bytes to hold the length\r
- * of the message).\r
- */\r
-\r
-#ifndef FREERTOS_MESSAGE_BUFFER_H\r
-#define FREERTOS_MESSAGE_BUFFER_H\r
-\r
-/* Message buffers are built onto of stream buffers. */\r
-#include "stream_buffer.h"\r
-\r
-#if defined( __cplusplus )\r
-extern "C" {\r
-#endif\r
-\r
-/**\r
- * Type by which message buffers are referenced. For example, a call to\r
- * xMessageBufferCreate() returns an MessageBufferHandle_t variable that can\r
- * then be used as a parameter to xMessageBufferSend(), xMessageBufferReceive(),\r
- * etc.\r
- */\r
-typedef void * MessageBufferHandle_t;\r
-\r
-/*-----------------------------------------------------------*/\r
-\r
-/**\r
- * message_buffer.h\r
- *\r
-<pre>\r
-MessageBufferHandle_t xMessageBufferCreate( size_t xBufferSizeBytes );\r
-</pre>\r
- *\r
- * Creates a new message buffer using dynamically allocated memory. See\r
- * xMessageBufferCreateStatic() for a version that uses statically allocated\r
- * memory (memory that is allocated at compile time).\r
- *\r
- * configSUPPORT_DYNAMIC_ALLOCATION must be set to 1 or left undefined in\r
- * FreeRTOSConfig.h for xMessageBufferCreate() to be available.\r
- *\r
- * @param xBufferSizeBytes The total number of bytes (not messages) the message\r
- * buffer will be able to hold at any one time. When a message is written to\r
- * the message buffer an additional sizeof( size_t ) bytes are also written to\r
- * store the message's length. sizeof( size_t ) is typically 4 bytes on a\r
- * 32-bit architecture, so on most 32-bit architectures a 10 byte message will\r
- * take up 14 bytes of message buffer space.\r
- *\r
- * @return If NULL is returned, then the message buffer cannot be created\r
- * because there is insufficient heap memory available for FreeRTOS to allocate\r
- * the message buffer data structures and storage area. A non-NULL value being\r
- * returned indicates that the message buffer has been created successfully -\r
- * the returned value should be stored as the handle to the created message\r
- * buffer.\r
- *\r
- * Example use:\r
-<pre>\r
-\r
-void vAFunction( void )\r
-{\r
-MessageBufferHandle_t xMessageBuffer;\r
-const size_t xMessageBufferSizeBytes = 100;\r
-\r
- // Create a message buffer that can hold 100 bytes. The memory used to hold\r
- // both the message buffer structure and the messages themselves is allocated\r
- // dynamically. Each message added to the buffer consumes an additional 4\r
- // bytes which are used to hold the lengh of the message.\r
- xMessageBuffer = xMessageBufferCreate( xMessageBufferSizeBytes );\r
-\r
- if( xMessageBuffer == NULL )\r
- {\r
- // There was not enough heap memory space available to create the\r
- // message buffer.\r
- }\r
- else\r
- {\r
- // The message buffer was created successfully and can now be used.\r
- }\r
-\r
-</pre>\r
- * \defgroup xMessageBufferCreate xMessageBufferCreate\r
- * \ingroup MessageBufferManagement\r
- */\r
-#define xMessageBufferCreate( xBufferSizeBytes ) ( MessageBufferHandle_t ) xStreamBufferGenericCreate( xBufferSizeBytes, ( size_t ) 0, pdTRUE )\r
-\r
-/**\r
- * message_buffer.h\r
- *\r
-<pre>\r
-MessageBufferHandle_t xMessageBufferCreateStatic( size_t xBufferSizeBytes,\r
- uint8_t *pucMessageBufferStorageArea,\r
- StaticMessageBuffer_t *pxStaticMessageBuffer );\r
-</pre>\r
- * Creates a new message buffer using statically allocated memory. See\r
- * xMessageBufferCreate() for a version that uses dynamically allocated memory.\r
- *\r
- * @param xBufferSizeBytes The size, in bytes, of the buffer pointed to by the\r
- * pucMessageBufferStorageArea parameter. When a message is written to the\r
- * message buffer an additional sizeof( size_t ) bytes are also written to store\r
- * the message's length. sizeof( size_t ) is typically 4 bytes on a 32-bit\r
- * architecture, so on most 32-bit architecture a 10 byte message will take up\r
- * 14 bytes of message buffer space. The maximum number of bytes that can be\r
- * stored in the message buffer is actually (xBufferSizeBytes - 1).\r
- *\r
- * @param pucMessageBufferStorageArea Must point to a uint8_t array that is at\r
- * least xBufferSizeBytes + 1 big. This is the array to which messages are\r
- * copied when they are written to the message buffer.\r
- *\r
- * @param pxStaticMessageBuffer Must point to a variable of type\r
- * StaticMessageBuffer_t, which will be used to hold the message buffer's data\r
- * structure.\r
- *\r
- * @return If the message buffer is created successfully then a handle to the\r
- * created message buffer is returned. If either pucMessageBufferStorageArea or\r
- * pxStaticmessageBuffer are NULL then NULL is returned.\r
- *\r
- * Example use:\r
-<pre>\r
-\r
-// Used to dimension the array used to hold the messages. The available space\r
-// will actually be one less than this, so 999.\r
-#define STORAGE_SIZE_BYTES 1000\r
-\r
-// Defines the memory that will actually hold the messages within the message\r
-// buffer.\r
-static uint8_t ucStorageBuffer[ STORAGE_SIZE_BYTES ];\r
-\r
-// The variable used to hold the message buffer structure.\r
-StaticMessageBuffer_t xMessageBufferStruct;\r
-\r
-void MyFunction( void )\r
-{\r
-MessageBufferHandle_t xMessageBuffer;\r
-\r
- xMessageBuffer = xMessageBufferCreateStatic( sizeof( ucBufferStorage ),\r
- ucBufferStorage,\r
- &xMessageBufferStruct );\r
-\r
- // As neither the pucMessageBufferStorageArea or pxStaticMessageBuffer\r
- // parameters were NULL, xMessageBuffer will not be NULL, and can be used to\r
- // reference the created message buffer in other message buffer API calls.\r
-\r
- // Other code that uses the message buffer can go here.\r
-}\r
-\r
-</pre>\r
- * \defgroup xMessageBufferCreateStatic xMessageBufferCreateStatic\r
- * \ingroup MessageBufferManagement\r
- */\r
-#define xMessageBufferCreateStatic( xBufferSizeBytes, pucMessageBufferStorageArea, pxStaticMessageBuffer ) ( MessageBufferHandle_t ) xStreamBufferGenericCreateStatic( xBufferSizeBytes, 0, pdTRUE, pucMessageBufferStorageArea, pxStaticMessageBuffer )\r
-\r
-/**\r
- * message_buffer.h\r
- *\r
-<pre>\r
-size_t xMessageBufferSend( MessageBufferHandle_t xMessageBuffer,\r
- const void *pvTxData,\r
- size_t xDataLengthBytes,\r
- TickType_t xTicksToWait );\r
-<pre>\r
- *\r
- * Sends a discrete message to the message buffer. The message can be any\r
- * length that fits within the buffer's free space, and is copied into the\r
- * buffer.\r
- *\r
- * ***NOTE***: Uniquely among FreeRTOS objects, the stream buffer\r
- * implementation (so also the message buffer implementation, as message buffers\r
- * are built on top of stream buffers) assumes there is only one task or\r
- * interrupt that will write to the buffer (the writer), and only one task or\r
- * interrupt that will read from the buffer (the reader). It is safe for the\r
- * writer and reader to be different tasks or interrupts, but, unlike other\r
- * FreeRTOS objects, it is not safe to have multiple different writers or\r
- * multiple different readers. If there are to be multiple different writers\r
- * then the application writer must place each call to a writing API function\r
- * (such as xMessageBufferSend()) inside a critical section and set the send\r
- * block time to 0. Likewise, if there are to be multiple different readers\r
- * then the application writer must place each call to a reading API function\r
- * (such as xMessageBufferRead()) inside a critical section and set the receive\r
- * block time to 0.\r
- *\r
- * Use xMessageBufferSend() to write to a message buffer from a task. Use\r
- * xMessageBufferSendFromISR() to write to a message buffer from an interrupt\r
- * service routine (ISR).\r
- *\r
- * @param xMessageBuffer The handle of the message buffer to which a message is\r
- * being sent.\r
- *\r
- * @param pvTxData A pointer to the message that is to be copied into the\r
- * message buffer.\r
- *\r
- * @param xDataLengthBytes The length of the message. That is, the number of\r
- * bytes to copy from pvTxData into the message buffer. When a message is\r
- * written to the message buffer an additional sizeof( size_t ) bytes are also\r
- * written to store the message's length. sizeof( size_t ) is typically 4 bytes\r
- * on a 32-bit architecture, so on most 32-bit architecture setting\r
- * xDataLengthBytes to 20 will reduce the free space in the message buffer by 24\r
- * bytes (20 bytes of message data and 4 bytes to hold the message length).\r
- *\r
- * @param xTicksToWait The maximum amount of time the calling task should remain\r
- * in the Blocked state to wait for enough space to become available in the\r
- * message buffer, should the message buffer have insufficient space when\r
- * xMessageBufferSend() is called. The calling task will never block if\r
- * xTicksToWait is zero. The block time is specified in tick periods, so the\r
- * absolute time it represents is dependent on the tick frequency. The macro\r
- * pdMS_TO_TICKS() can be used to convert a time specified in milliseconds into\r
- * a time specified in ticks. Setting xTicksToWait to portMAX_DELAY will cause\r
- * the task to wait indefinitely (without timing out), provided\r
- * INCLUDE_vTaskSuspend is set to 1 in FreeRTOSConfig.h. Tasks do not use any\r
- * CPU time when they are in the Blocked state.\r
- *\r
- * @return The number of bytes written to the message buffer. If the call to\r
- * xMessageBufferSend() times out before there was enough space to write the\r
- * message into the message buffer then zero is returned. If the call did not\r
- * time out then xDataLengthBytes is returned.\r
- *\r
- * Example use:\r
-<pre>\r
-void vAFunction( MessageBufferHandle_t xMessageBuffer )\r
-{\r
-size_t xBytesSent;\r
-uint8_t ucArrayToSend[] = { 0, 1, 2, 3 };\r
-char *pcStringToSend = "String to send";\r
-const TickType_t x100ms = pdMS_TO_TICKS( 100 );\r
-\r
- // Send an array to the message buffer, blocking for a maximum of 100ms to\r
- // wait for enough space to be available in the message buffer.\r
- xBytesSent = xMessageBufferSend( xMessageBuffer, ( void * ) ucArrayToSend, sizeof( ucArrayToSend ), x100ms );\r
-\r
- if( xBytesSent != sizeof( ucArrayToSend ) )\r
- {\r
- // The call to xMessageBufferSend() times out before there was enough\r
- // space in the buffer for the data to be written.\r
- }\r
-\r
- // Send the string to the message buffer. Return immediately if there is\r
- // not enough space in the buffer.\r
- xBytesSent = xMessageBufferSend( xMessageBuffer, ( void * ) pcStringToSend, strlen( pcStringToSend ), 0 );\r
-\r
- if( xBytesSent != strlen( pcStringToSend ) )\r
- {\r
- // The string could not be added to the message buffer because there was\r
- // not enough free space in the buffer.\r
- }\r
-}\r
-</pre>\r
- * \defgroup xMessageBufferSend xMessageBufferSend\r
- * \ingroup MessageBufferManagement\r
- */\r
-#define xMessageBufferSend( xMessageBuffer, pvTxData, xDataLengthBytes, xTicksToWait ) xStreamBufferSend( ( StreamBufferHandle_t ) xMessageBuffer, pvTxData, xDataLengthBytes, xTicksToWait )\r
-\r
-/**\r
- * message_buffer.h\r
- *\r
-<pre>\r
-size_t xMessageBufferSendFromISR( MessageBufferHandle_t xMessageBuffer,\r
- const void *pvTxData,\r
- size_t xDataLengthBytes,\r
- BaseType_t *pxHigherPriorityTaskWoken );\r
-<pre>\r
- *\r
- * Interrupt safe version of the API function that sends a discrete message to\r
- * the message buffer. The message can be any length that fits within the\r
- * buffer's free space, and is copied into the buffer.\r
- *\r
- * ***NOTE***: Uniquely among FreeRTOS objects, the stream buffer\r
- * implementation (so also the message buffer implementation, as message buffers\r
- * are built on top of stream buffers) assumes there is only one task or\r
- * interrupt that will write to the buffer (the writer), and only one task or\r
- * interrupt that will read from the buffer (the reader). It is safe for the\r
- * writer and reader to be different tasks or interrupts, but, unlike other\r
- * FreeRTOS objects, it is not safe to have multiple different writers or\r
- * multiple different readers. If there are to be multiple different writers\r
- * then the application writer must place each call to a writing API function\r
- * (such as xMessageBufferSend()) inside a critical section and set the send\r
- * block time to 0. Likewise, if there are to be multiple different readers\r
- * then the application writer must place each call to a reading API function\r
- * (such as xMessageBufferRead()) inside a critical section and set the receive\r
- * block time to 0.\r
- *\r
- * Use xMessageBufferSend() to write to a message buffer from a task. Use\r
- * xMessageBufferSendFromISR() to write to a message buffer from an interrupt\r
- * service routine (ISR).\r
- *\r
- * @param xMessageBuffer The handle of the message buffer to which a message is\r
- * being sent.\r
- *\r
- * @param pvTxData A pointer to the message that is to be copied into the\r
- * message buffer.\r
- *\r
- * @param xDataLengthBytes The length of the message. That is, the number of\r
- * bytes to copy from pvTxData into the message buffer. When a message is\r
- * written to the message buffer an additional sizeof( size_t ) bytes are also\r
- * written to store the message's length. sizeof( size_t ) is typically 4 bytes\r
- * on a 32-bit architecture, so on most 32-bit architecture setting\r
- * xDataLengthBytes to 20 will reduce the free space in the message buffer by 24\r
- * bytes (20 bytes of message data and 4 bytes to hold the message length).\r
- *\r
- * @param pxHigherPriorityTaskWoken It is possible that a message buffer will\r
- * have a task blocked on it waiting for data. Calling\r
- * xMessageBufferSendFromISR() can make data available, and so cause a task that\r
- * was waiting for data to leave the Blocked state. If calling\r
- * xMessageBufferSendFromISR() causes a task to leave the Blocked state, and the\r
- * unblocked task has a priority higher than the currently executing task (the\r
- * task that was interrupted), then, internally, xMessageBufferSendFromISR()\r
- * will set *pxHigherPriorityTaskWoken to pdTRUE. If\r
- * xMessageBufferSendFromISR() sets this value to pdTRUE, then normally a\r
- * context switch should be performed before the interrupt is exited. This will\r
- * ensure that the interrupt returns directly to the highest priority Ready\r
- * state task. *pxHigherPriorityTaskWoken should be set to pdFALSE before it\r
- * is passed into the function. See the code example below for an example.\r
- *\r
- * @return The number of bytes actually written to the message buffer. If the\r
- * message buffer didn't have enough free space for the message to be stored\r
- * then 0 is returned, otherwise xDataLengthBytes is returned.\r
- *\r
- * Example use:\r
-<pre>\r
-// A message buffer that has already been created.\r
-MessageBufferHandle_t xMessageBuffer;\r
-\r
-void vAnInterruptServiceRoutine( void )\r
-{\r
-size_t xBytesSent;\r
-char *pcStringToSend = "String to send";\r
-BaseType_t xHigherPriorityTaskWoken = pdFALSE; // Initialised to pdFALSE.\r
-\r
- // Attempt to send the string to the message buffer.\r
- xBytesSent = xMessageBufferSendFromISR( xMessageBuffer,\r
- ( void * ) pcStringToSend,\r
- strlen( pcStringToSend ),\r
- &xHigherPriorityTaskWoken );\r
-\r
- if( xBytesSent != strlen( pcStringToSend ) )\r
- {\r
- // The string could not be added to the message buffer because there was\r
- // not enough free space in the buffer.\r
- }\r
-\r
- // If xHigherPriorityTaskWoken was set to pdTRUE inside\r
- // xMessageBufferSendFromISR() then a task that has a priority above the\r
- // priority of the currently executing task was unblocked and a context\r
- // switch should be performed to ensure the ISR returns to the unblocked\r
- // task. In most FreeRTOS ports this is done by simply passing\r
- // xHigherPriorityTaskWoken into taskYIELD_FROM_ISR(), which will test the\r
- // variables value, and perform the context switch if necessary. Check the\r
- // documentation for the port in use for port specific instructions.\r
- taskYIELD_FROM_ISR( xHigherPriorityTaskWoken );\r
-}\r
-</pre>\r
- * \defgroup xMessageBufferSendFromISR xMessageBufferSendFromISR\r
- * \ingroup MessageBufferManagement\r
- */\r
-#define xMessageBufferSendFromISR( xMessageBuffer, pvTxData, xDataLengthBytes, pxHigherPriorityTaskWoken ) xStreamBufferSendFromISR( ( StreamBufferHandle_t ) xMessageBuffer, pvTxData, xDataLengthBytes, pxHigherPriorityTaskWoken )\r
-\r
-/**\r
- * message_buffer.h\r
- *\r
-<pre>\r
-size_t xMessageBufferReceive( MessageBufferHandle_t xMessageBuffer,\r
- void *pvRxData,\r
- size_t xBufferLengthBytes,\r
- TickType_t xTicksToWait );\r
-</pre>\r
- *\r
- * Receives a discrete message from a message buffer. Messages can be of\r
- * variable length and are copied out of the buffer.\r
- *\r
- * ***NOTE***: Uniquely among FreeRTOS objects, the stream buffer\r
- * implementation (so also the message buffer implementation, as message buffers\r
- * are built on top of stream buffers) assumes there is only one task or\r
- * interrupt that will write to the buffer (the writer), and only one task or\r
- * interrupt that will read from the buffer (the reader). It is safe for the\r
- * writer and reader to be different tasks or interrupts, but, unlike other\r
- * FreeRTOS objects, it is not safe to have multiple different writers or\r
- * multiple different readers. If there are to be multiple different writers\r
- * then the application writer must place each call to a writing API function\r
- * (such as xMessageBufferSend()) inside a critical section and set the send\r
- * block time to 0. Likewise, if there are to be multiple different readers\r
- * then the application writer must place each call to a reading API function\r
- * (such as xMessageBufferRead()) inside a critical section and set the receive\r
- * block time to 0.\r
- *\r
- * Use xMessageBufferReceive() to read from a message buffer from a task. Use\r
- * xMessageBufferReceiveFromISR() to read from a message buffer from an\r
- * interrupt service routine (ISR).\r
- *\r
- * @param xMessageBuffer The handle of the message buffer from which a message\r
- * is being received.\r
- *\r
- * @param pvRxData A pointer to the buffer into which the received message is\r
- * to be copied.\r
- *\r
- * @param xBufferLengthBytes The length of the buffer pointed to by the pvRxData\r
- * parameter. This sets the maximum length of the message that can be received.\r
- * If xBufferLengthBytes is too small to hold the next message then the message\r
- * will be left in the message buffer and 0 will be returned.\r
- *\r
- * @param xTicksToWait The maximum amount of time the task should remain in the\r
- * Blocked state to wait for a message, should the message buffer be empty.\r
- * xMessageBufferReceive() will return immediately if xTicksToWait is zero and\r
- * the message buffer is empty. The block time is specified in tick periods, so\r
- * the absolute time it represents is dependent on the tick frequency. The\r
- * macro pdMS_TO_TICKS() can be used to convert a time specified in milliseconds\r
- * into a time specified in ticks. Setting xTicksToWait to portMAX_DELAY will\r
- * cause the task to wait indefinitely (without timing out), provided\r
- * INCLUDE_vTaskSuspend is set to 1 in FreeRTOSConfig.h. Tasks do not use any\r
- * CPU time when they are in the Blocked state.\r
- *\r
- * @return The length, in bytes, of the message read from the message buffer, if\r
- * any. If xMessageBufferReceive() times out before a message became available\r
- * then zero is returned. If the length of the message is greater than\r
- * xBufferLengthBytes then the message will be left in the message buffer and\r
- * zero is returned.\r
- *\r
- * Example use:\r
-<pre>\r
-void vAFunction( MessageBuffer_t xMessageBuffer )\r
-{\r
-uint8_t ucRxData[ 20 ];\r
-size_t xReceivedBytes;\r
-const TickType_t xBlockTime = pdMS_TO_TICKS( 20 );\r
-\r
- // Receive the next message from the message buffer. Wait in the Blocked\r
- // state (so not using any CPU processing time) for a maximum of 100ms for\r
- // a message to become available.\r
- xReceivedBytes = xMessageBufferReceive( xMessageBuffer,\r
- ( void * ) ucRxData,\r
- sizeof( ucRxData ),\r
- xBlockTime );\r
-\r
- if( xReceivedBytes > 0 )\r
- {\r
- // A ucRxData contains a message that is xReceivedBytes long. Process\r
- // the message here....\r
- }\r
-}\r
-</pre>\r
- * \defgroup xMessageBufferReceive xMessageBufferReceive\r
- * \ingroup MessageBufferManagement\r
- */\r
-#define xMessageBufferReceive( xMessageBuffer, pvRxData, xBufferLengthBytes, xTicksToWait ) xStreamBufferReceive( ( StreamBufferHandle_t ) xMessageBuffer, pvRxData, xBufferLengthBytes, xTicksToWait )\r
-\r
-\r
-/**\r
- * message_buffer.h\r
- *\r
-<pre>\r
-size_t xMessageBufferReceiveFromISR( MessageBufferHandle_t xMessageBuffer,\r
- void *pvRxData,\r
- size_t xBufferLengthBytes,\r
- BaseType_t *pxHigherPriorityTaskWoken );\r
-</pre>\r
- *\r
- * An interrupt safe version of the API function that receives a discrete\r
- * message from a message buffer. Messages can be of variable length and are\r
- * copied out of the buffer.\r
- *\r
- * ***NOTE***: Uniquely among FreeRTOS objects, the stream buffer\r
- * implementation (so also the message buffer implementation, as message buffers\r
- * are built on top of stream buffers) assumes there is only one task or\r
- * interrupt that will write to the buffer (the writer), and only one task or\r
- * interrupt that will read from the buffer (the reader). It is safe for the\r
- * writer and reader to be different tasks or interrupts, but, unlike other\r
- * FreeRTOS objects, it is not safe to have multiple different writers or\r
- * multiple different readers. If there are to be multiple different writers\r
- * then the application writer must place each call to a writing API function\r
- * (such as xMessageBufferSend()) inside a critical section and set the send\r
- * block time to 0. Likewise, if there are to be multiple different readers\r
- * then the application writer must place each call to a reading API function\r
- * (such as xMessageBufferRead()) inside a critical section and set the receive\r
- * block time to 0.\r
- *\r
- * Use xMessageBufferReceive() to read from a message buffer from a task. Use\r
- * xMessageBufferReceiveFromISR() to read from a message buffer from an\r
- * interrupt service routine (ISR).\r
- *\r
- * @param xMessageBuffer The handle of the message buffer from which a message\r
- * is being received.\r
- *\r
- * @param pvRxData A pointer to the buffer into which the received message is\r
- * to be copied.\r
- *\r
- * @param xBufferLengthBytes The length of the buffer pointed to by the pvRxData\r
- * parameter. This sets the maximum length of the message that can be received.\r
- * If xBufferLengthBytes is too small to hold the next message then the message\r
- * will be left in the message buffer and 0 will be returned.\r
- *\r
- * @param pxHigherPriorityTaskWoken It is possible that a message buffer will\r
- * have a task blocked on it waiting for space to become available. Calling\r
- * xMessageBufferReceiveFromISR() can make space available, and so cause a task\r
- * that is waiting for space to leave the Blocked state. If calling\r
- * xMessageBufferReceiveFromISR() causes a task to leave the Blocked state, and\r
- * the unblocked task has a priority higher than the currently executing task\r
- * (the task that was interrupted), then, internally,\r
- * xMessageBufferReceiveFromISR() will set *pxHigherPriorityTaskWoken to pdTRUE.\r
- * If xMessageBufferReceiveFromISR() sets this value to pdTRUE, then normally a\r
- * context switch should be performed before the interrupt is exited. That will\r
- * ensure the interrupt returns directly to the highest priority Ready state\r
- * task. *pxHigherPriorityTaskWoken should be set to pdFALSE before it is\r
- * passed into the function. See the code example below for an example.\r
- *\r
- * @return The length, in bytes, of the message read from the message buffer, if\r
- * any.\r
- *\r
- * Example use:\r
-<pre>\r
-// A message buffer that has already been created.\r
-MessageBuffer_t xMessageBuffer;\r
-\r
-void vAnInterruptServiceRoutine( void )\r
-{\r
-uint8_t ucRxData[ 20 ];\r
-size_t xReceivedBytes;\r
-BaseType_t xHigherPriorityTaskWoken = pdFALSE; // Initialised to pdFALSE.\r
-\r
- // Receive the next message from the message buffer.\r
- xReceivedBytes = xMessageBufferReceiveFromISR( xMessageBuffer,\r
- ( void * ) ucRxData,\r
- sizeof( ucRxData ),\r
- &xHigherPriorityTaskWoken );\r
-\r
- if( xReceivedBytes > 0 )\r
- {\r
- // A ucRxData contains a message that is xReceivedBytes long. Process\r
- // the message here....\r
- }\r
-\r
- // If xHigherPriorityTaskWoken was set to pdTRUE inside\r
- // xMessageBufferReceiveFromISR() then a task that has a priority above the\r
- // priority of the currently executing task was unblocked and a context\r
- // switch should be performed to ensure the ISR returns to the unblocked\r
- // task. In most FreeRTOS ports this is done by simply passing\r
- // xHigherPriorityTaskWoken into taskYIELD_FROM_ISR(), which will test the\r
- // variables value, and perform the context switch if necessary. Check the\r
- // documentation for the port in use for port specific instructions.\r
- taskYIELD_FROM_ISR( xHigherPriorityTaskWoken );\r
-}\r
-</pre>\r
- * \defgroup xMessageBufferReceiveFromISR xMessageBufferReceiveFromISR\r
- * \ingroup MessageBufferManagement\r
- */\r
-#define xMessageBufferReceiveFromISR( xMessageBuffer, pvRxData, xBufferLengthBytes, pxHigherPriorityTaskWoken ) xStreamBufferReceiveFromISR( ( StreamBufferHandle_t ) xMessageBuffer, pvRxData, xBufferLengthBytes, pxHigherPriorityTaskWoken )\r
-\r
-/**\r
- * message_buffer.h\r
- *\r
-<pre>\r
-void vMessageBufferDelete( MessageBufferHandle_t xMessageBuffer );\r
-</pre>\r
- *\r
- * Deletes a message buffer that was previously created using a call to\r
- * xMessageBufferCreate() or xMessageBufferCreateStatic(). If the message\r
- * buffer was created using dynamic memory (that is, by xMessageBufferCreate()),\r
- * then the allocated memory is freed.\r
- *\r
- * A message buffer handle must not be used after the message buffer has been\r
- * deleted.\r
- *\r
- * @param xMessageBuffer The handle of the message buffer to be deleted.\r
- *\r
- */\r
-#define vMessageBufferDelete( xMessageBuffer ) vStreamBufferDelete( ( StreamBufferHandle_t ) xMessageBuffer )\r
-\r
-/**\r
- * message_buffer.h\r
-<pre>\r
-BaseType_t xMessageBufferIsFull( MessageBufferHandle_t xMessageBuffer ) );\r
-</pre>\r
- *\r
- * Tests to see if a message buffer is full. A message buffer is full if it\r
- * cannot accept any more messages, of any size, until space is made available\r
- * by a message being removed from the message buffer.\r
- *\r
- * @param xMessageBuffer The handle of the message buffer being queried.\r
- *\r
- * @return If the message buffer referenced by xMessageBuffer is full then\r
- * pdTRUE is returned. Otherwise pdFALSE is returned.\r
- */\r
-#define xMessageBufferIsFull( xMessageBuffer ) xStreamBufferIsFull( ( StreamBufferHandle_t ) xMessageBuffer )\r
-\r
-/**\r
- * message_buffer.h\r
-<pre>\r
-BaseType_t xMessageBufferIsEmpty( MessageBufferHandle_t xMessageBuffer ) );\r
-</pre>\r
- *\r
- * Tests to see if a message buffer is empty (does not contain any messages).\r
- *\r
- * @param xMessageBuffer The handle of the message buffer being queried.\r
- *\r
- * @return If the message buffer referenced by xMessageBuffer is empty then\r
- * pdTRUE is returned. Otherwise pdFALSE is returned.\r
- *\r
- */\r
-#define xMessageBufferIsEmpty( xMessageBuffer ) xStreamBufferIsEmpty( ( StreamBufferHandle_t ) xMessageBuffer )\r
-\r
-/**\r
- * message_buffer.h\r
-<pre>\r
-BaseType_t xMessageBufferReset( MessageBufferHandle_t xMessageBuffer );\r
-</pre>\r
- *\r
- * Resets a message buffer to its initial empty state, discarding any message it\r
- * contained.\r
- *\r
- * A message buffer can only be reset if there are no tasks blocked on it.\r
- *\r
- * @param xMessageBuffer The handle of the message buffer being reset.\r
- *\r
- * @return If the message buffer was reset then pdPASS is returned. If the\r
- * message buffer could not be reset because either there was a task blocked on\r
- * the message queue to wait for space to become available, or to wait for a\r
- * a message to be available, then pdFAIL is returned.\r
- *\r
- * \defgroup xMessageBufferReset xMessageBufferReset\r
- * \ingroup MessageBufferManagement\r
- */\r
-#define xMessageBufferReset( xMessageBuffer ) xStreamBufferReset( ( StreamBufferHandle_t ) xMessageBuffer )\r
-\r
-\r
-/**\r
- * message_buffer.h\r
-<pre>\r
-size_t xMessageBufferSpaceAvailable( MessageBufferHandle_t xMessageBuffer ) );\r
-</pre>\r
- * Returns the number of bytes of free space in the message buffer.\r
- *\r
- * @param xMessageBuffer The handle of the message buffer being queried.\r
- *\r
- * @return The number of bytes that can be written to the message buffer before\r
- * the message buffer would be full. When a message is written to the message\r
- * buffer an additional sizeof( size_t ) bytes are also written to store the\r
- * message's length. sizeof( size_t ) is typically 4 bytes on a 32-bit\r
- * architecture, so if xMessageBufferSpacesAvailable() returns 10, then the size\r
- * of the largest message that can be written to the message buffer is 6 bytes.\r
- *\r
- * \defgroup xMessageBufferSpaceAvailable xMessageBufferSpaceAvailable\r
- * \ingroup MessageBufferManagement\r
- */\r
-#define xMessageBufferSpaceAvailable( xMessageBuffer ) xStreamBufferSpacesAvailable( ( StreamBufferHandle_t ) xMessageBuffer )\r
-\r
-/**\r
- * message_buffer.h\r
- *\r
-<pre>\r
-BaseType_t xMessageBufferSendCompletedFromISR( MessageBufferHandle_t xStreamBuffer, BaseType_t *pxHigherPriorityTaskWoken );\r
-</pre>\r
- *\r
- * For advanced users only.\r
- *\r
- * The sbSEND_COMPLETED() macro is called from within the FreeRTOS APIs when\r
- * data is sent to a message buffer or stream buffer. If there was a task that\r
- * was blocked on the message or stream buffer waiting for data to arrive then\r
- * the sbSEND_COMPLETED() macro sends a notification to the task to remove it\r
- * from the Blocked state. xMessageBufferSendCompletedFromISR() does the same\r
- * thing. It is provided to enable application writers to implement their own\r
- * version of sbSEND_COMPLETED(), and MUST NOT BE USED AT ANY OTHER TIME.\r
- *\r
- * See the example implemented in FreeRTOS/Demo/Minimal/MessageBufferAMP.c for\r
- * additional information.\r
- *\r
- * @param xStreamBuffer The handle of the stream buffer to which data was\r
- * written.\r
- *\r
- * @param pxHigherPriorityTaskWoken *pxHigherPriorityTaskWoken should be\r
- * initialised to pdFALSE before it is passed into\r
- * xMessageBufferSendCompletedFromISR(). If calling\r
- * xMessageBufferSendCompletedFromISR() removes a task from the Blocked state,\r
- * and the task has a priority above the priority of the currently running task,\r
- * then *pxHigherPriorityTaskWoken will get set to pdTRUE indicating that a\r
- * context switch should be performed before exiting the ISR.\r
- *\r
- * @return If a task was removed from the Blocked state then pdTRUE is returned.\r
- * Otherwise pdFALSE is returned.\r
- *\r
- * \defgroup xMessageBufferSendCompletedFromISR xMessageBufferSendCompletedFromISR\r
- * \ingroup StreamBufferManagement\r
- */\r
-#define xMessageBufferSendCompletedFromISR( xMessageBuffer, pxHigherPriorityTaskWoken ) xStreamBufferSendCompletedFromISR( ( StreamBufferHandle_t ) xMessageBuffer, pxHigherPriorityTaskWoken )\r
-\r
-/**\r
- * message_buffer.h\r
- *\r
-<pre>\r
-BaseType_t xMessageBufferReceiveCompletedFromISR( MessageBufferHandle_t xStreamBuffer, BaseType_t *pxHigherPriorityTaskWoken );\r
-</pre>\r
- *\r
- * For advanced users only.\r
- *\r
- * The sbRECEIVE_COMPLETED() macro is called from within the FreeRTOS APIs when\r
- * data is read out of a message buffer or stream buffer. If there was a task\r
- * that was blocked on the message or stream buffer waiting for data to arrive\r
- * then the sbRECEIVE_COMPLETED() macro sends a notification to the task to\r
- * remove it from the Blocked state. xMessageBufferReceiveCompletedFromISR()\r
- * does the same thing. It is provided to enable application writers to\r
- * implement their own version of sbRECEIVE_COMPLETED(), and MUST NOT BE USED AT\r
- * ANY OTHER TIME.\r
- *\r
- * See the example implemented in FreeRTOS/Demo/Minimal/MessageBufferAMP.c for\r
- * additional information.\r
- *\r
- * @param xStreamBuffer The handle of the stream buffer from which data was\r
- * read.\r
- *\r
- * @param pxHigherPriorityTaskWoken *pxHigherPriorityTaskWoken should be\r
- * initialised to pdFALSE before it is passed into\r
- * xMessageBufferReceiveCompletedFromISR(). If calling\r
- * xMessageBufferReceiveCompletedFromISR() removes a task from the Blocked state,\r
- * and the task has a priority above the priority of the currently running task,\r
- * then *pxHigherPriorityTaskWoken will get set to pdTRUE indicating that a\r
- * context switch should be performed before exiting the ISR.\r
- *\r
- * @return If a task was removed from the Blocked state then pdTRUE is returned.\r
- * Otherwise pdFALSE is returned.\r
- *\r
- * \defgroup xMessageBufferReceiveCompletedFromISR xMessageBufferReceiveCompletedFromISR\r
- * \ingroup StreamBufferManagement\r
- */\r
-#define xMessageBufferReceiveCompletedFromISR( xMessageBuffer, pxHigherPriorityTaskWoken ) xStreamBufferReceiveCompletedFromISR( ( StreamBufferHandle_t ) xMessageBuffer, pxHigherPriorityTaskWoken )\r
-\r
-#if defined( __cplusplus )\r
-} /* extern "C" */\r
-#endif\r
-\r
-#endif /* !defined( FREERTOS_MESSAGE_BUFFER_H ) */\r
+++ /dev/null
-/*\r
- * FreeRTOS Kernel V10.0.1\r
- * Copyright (C) 2017 Amazon.com, Inc. or its affiliates. All Rights Reserved.\r
- *\r
- * Permission is hereby granted, free of charge, to any person obtaining a copy of\r
- * this software and associated documentation files (the "Software"), to deal in\r
- * the Software without restriction, including without limitation the rights to\r
- * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of\r
- * the Software, and to permit persons to whom the Software is furnished to do so,\r
- * subject to the following conditions:\r
- *\r
- * The above copyright notice and this permission notice shall be included in all\r
- * copies or substantial portions of the Software.\r
- *\r
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\r
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS\r
- * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR\r
- * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER\r
- * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN\r
- * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\r
- *\r
- * http://www.FreeRTOS.org\r
- * http://aws.amazon.com/freertos\r
- *\r
- * 1 tab == 4 spaces!\r
- */\r
-\r
-/*\r
- * When the MPU is used the standard (non MPU) API functions are mapped to\r
- * equivalents that start "MPU_", the prototypes for which are defined in this\r
- * header files. This will cause the application code to call the MPU_ version\r
- * which wraps the non-MPU version with privilege promoting then demoting code,\r
- * so the kernel code always runs will full privileges.\r
- */\r
-\r
-\r
-#ifndef MPU_PROTOTYPES_H\r
-#define MPU_PROTOTYPES_H\r
-\r
-/* MPU versions of tasks.h API functions. */\r
-BaseType_t MPU_xTaskCreate( TaskFunction_t pxTaskCode, const char * const pcName, const uint16_t usStackDepth, void * const pvParameters, UBaseType_t uxPriority, TaskHandle_t * const pxCreatedTask );\r
-TaskHandle_t MPU_xTaskCreateStatic( TaskFunction_t pxTaskCode, const char * const pcName, const uint32_t ulStackDepth, void * const pvParameters, UBaseType_t uxPriority, StackType_t * const puxStackBuffer, StaticTask_t * const pxTaskBuffer );\r
-BaseType_t MPU_xTaskCreateRestricted( const TaskParameters_t * const pxTaskDefinition, TaskHandle_t *pxCreatedTask );\r
-BaseType_t MPU_xTaskCreateRestrictedStatic( const TaskParameters_t * const pxTaskDefinition, TaskHandle_t *pxCreatedTask );\r
-void MPU_vTaskAllocateMPURegions( TaskHandle_t xTask, const MemoryRegion_t * const pxRegions );\r
-void MPU_vTaskDelete( TaskHandle_t xTaskToDelete );\r
-void MPU_vTaskDelay( const TickType_t xTicksToDelay );\r
-void MPU_vTaskDelayUntil( TickType_t * const pxPreviousWakeTime, const TickType_t xTimeIncrement );\r
-BaseType_t MPU_xTaskAbortDelay( TaskHandle_t xTask );\r
-UBaseType_t MPU_uxTaskPriorityGet( TaskHandle_t xTask );\r
-eTaskState MPU_eTaskGetState( TaskHandle_t xTask );\r
-void MPU_vTaskGetInfo( TaskHandle_t xTask, TaskStatus_t *pxTaskStatus, BaseType_t xGetFreeStackSpace, eTaskState eState );\r
-void MPU_vTaskPrioritySet( TaskHandle_t xTask, UBaseType_t uxNewPriority );\r
-void MPU_vTaskSuspend( TaskHandle_t xTaskToSuspend );\r
-void MPU_vTaskResume( TaskHandle_t xTaskToResume );\r
-void MPU_vTaskStartScheduler( void );\r
-void MPU_vTaskSuspendAll( void );\r
-BaseType_t MPU_xTaskResumeAll( void );\r
-TickType_t MPU_xTaskGetTickCount( void );\r
-UBaseType_t MPU_uxTaskGetNumberOfTasks( void );\r
-char * MPU_pcTaskGetName( TaskHandle_t xTaskToQuery );\r
-TaskHandle_t MPU_xTaskGetHandle( const char *pcNameToQuery );\r
-UBaseType_t MPU_uxTaskGetStackHighWaterMark( TaskHandle_t xTask );\r
-void MPU_vTaskSetApplicationTaskTag( TaskHandle_t xTask, TaskHookFunction_t pxHookFunction );\r
-TaskHookFunction_t MPU_xTaskGetApplicationTaskTag( TaskHandle_t xTask );\r
-void MPU_vTaskSetThreadLocalStoragePointer( TaskHandle_t xTaskToSet, BaseType_t xIndex, void *pvValue );\r
-void * MPU_pvTaskGetThreadLocalStoragePointer( TaskHandle_t xTaskToQuery, BaseType_t xIndex );\r
-BaseType_t MPU_xTaskCallApplicationTaskHook( TaskHandle_t xTask, void *pvParameter );\r
-TaskHandle_t MPU_xTaskGetIdleTaskHandle( void );\r
-UBaseType_t MPU_uxTaskGetSystemState( TaskStatus_t * const pxTaskStatusArray, const UBaseType_t uxArraySize, uint32_t * const pulTotalRunTime );\r
-void MPU_vTaskList( char * pcWriteBuffer );\r
-void MPU_vTaskGetRunTimeStats( char *pcWriteBuffer );\r
-BaseType_t MPU_xTaskGenericNotify( TaskHandle_t xTaskToNotify, uint32_t ulValue, eNotifyAction eAction, uint32_t *pulPreviousNotificationValue );\r
-BaseType_t MPU_xTaskNotifyWait( uint32_t ulBitsToClearOnEntry, uint32_t ulBitsToClearOnExit, uint32_t *pulNotificationValue, TickType_t xTicksToWait );\r
-uint32_t MPU_ulTaskNotifyTake( BaseType_t xClearCountOnExit, TickType_t xTicksToWait );\r
-BaseType_t MPU_xTaskNotifyStateClear( TaskHandle_t xTask );\r
-BaseType_t MPU_xTaskIncrementTick( void );\r
-TaskHandle_t MPU_xTaskGetCurrentTaskHandle( void );\r
-void MPU_vTaskSetTimeOutState( TimeOut_t * const pxTimeOut );\r
-BaseType_t MPU_xTaskCheckForTimeOut( TimeOut_t * const pxTimeOut, TickType_t * const pxTicksToWait );\r
-void MPU_vTaskMissedYield( void );\r
-BaseType_t MPU_xTaskGetSchedulerState( void );\r
-\r
-/* MPU versions of queue.h API functions. */\r
-BaseType_t MPU_xQueueGenericSend( QueueHandle_t xQueue, const void * const pvItemToQueue, TickType_t xTicksToWait, const BaseType_t xCopyPosition );\r
-BaseType_t MPU_xQueueReceive( QueueHandle_t xQueue, void * const pvBuffer, TickType_t xTicksToWait );\r
-BaseType_t MPU_xQueuePeek( QueueHandle_t xQueue, void * const pvBuffer, TickType_t xTicksToWait );\r
-BaseType_t MPU_xQueueSemaphoreTake( QueueHandle_t xQueue, TickType_t xTicksToWait );\r
-UBaseType_t MPU_uxQueueMessagesWaiting( const QueueHandle_t xQueue );\r
-UBaseType_t MPU_uxQueueSpacesAvailable( const QueueHandle_t xQueue );\r
-void MPU_vQueueDelete( QueueHandle_t xQueue );\r
-QueueHandle_t MPU_xQueueCreateMutex( const uint8_t ucQueueType );\r
-QueueHandle_t MPU_xQueueCreateMutexStatic( const uint8_t ucQueueType, StaticQueue_t *pxStaticQueue );\r
-QueueHandle_t MPU_xQueueCreateCountingSemaphore( const UBaseType_t uxMaxCount, const UBaseType_t uxInitialCount );\r
-QueueHandle_t MPU_xQueueCreateCountingSemaphoreStatic( const UBaseType_t uxMaxCount, const UBaseType_t uxInitialCount, StaticQueue_t *pxStaticQueue );\r
-void* MPU_xQueueGetMutexHolder( QueueHandle_t xSemaphore );\r
-BaseType_t MPU_xQueueTakeMutexRecursive( QueueHandle_t xMutex, TickType_t xTicksToWait );\r
-BaseType_t MPU_xQueueGiveMutexRecursive( QueueHandle_t pxMutex );\r
-void MPU_vQueueAddToRegistry( QueueHandle_t xQueue, const char *pcName );\r
-void MPU_vQueueUnregisterQueue( QueueHandle_t xQueue );\r
-const char * MPU_pcQueueGetName( QueueHandle_t xQueue );\r
-QueueHandle_t MPU_xQueueGenericCreate( const UBaseType_t uxQueueLength, const UBaseType_t uxItemSize, const uint8_t ucQueueType );\r
-QueueHandle_t MPU_xQueueGenericCreateStatic( const UBaseType_t uxQueueLength, const UBaseType_t uxItemSize, uint8_t *pucQueueStorage, StaticQueue_t *pxStaticQueue, const uint8_t ucQueueType );\r
-QueueSetHandle_t MPU_xQueueCreateSet( const UBaseType_t uxEventQueueLength );\r
-BaseType_t MPU_xQueueAddToSet( QueueSetMemberHandle_t xQueueOrSemaphore, QueueSetHandle_t xQueueSet );\r
-BaseType_t MPU_xQueueRemoveFromSet( QueueSetMemberHandle_t xQueueOrSemaphore, QueueSetHandle_t xQueueSet );\r
-QueueSetMemberHandle_t MPU_xQueueSelectFromSet( QueueSetHandle_t xQueueSet, const TickType_t xTicksToWait );\r
-BaseType_t MPU_xQueueGenericReset( QueueHandle_t xQueue, BaseType_t xNewQueue );\r
-void MPU_vQueueSetQueueNumber( QueueHandle_t xQueue, UBaseType_t uxQueueNumber );\r
-UBaseType_t MPU_uxQueueGetQueueNumber( QueueHandle_t xQueue );\r
-uint8_t MPU_ucQueueGetQueueType( QueueHandle_t xQueue );\r
-\r
-/* MPU versions of timers.h API functions. */\r
-TimerHandle_t MPU_xTimerCreate( const char * const pcTimerName, const TickType_t xTimerPeriodInTicks, const UBaseType_t uxAutoReload, void * const pvTimerID, TimerCallbackFunction_t pxCallbackFunction );\r
-TimerHandle_t MPU_xTimerCreateStatic( const char * const pcTimerName, const TickType_t xTimerPeriodInTicks, const UBaseType_t uxAutoReload, void * const pvTimerID, TimerCallbackFunction_t pxCallbackFunction, StaticTimer_t *pxTimerBuffer );\r
-void * MPU_pvTimerGetTimerID( const TimerHandle_t xTimer );\r
-void MPU_vTimerSetTimerID( TimerHandle_t xTimer, void *pvNewID );\r
-BaseType_t MPU_xTimerIsTimerActive( TimerHandle_t xTimer );\r
-TaskHandle_t MPU_xTimerGetTimerDaemonTaskHandle( void );\r
-BaseType_t MPU_xTimerPendFunctionCall( PendedFunction_t xFunctionToPend, void *pvParameter1, uint32_t ulParameter2, TickType_t xTicksToWait );\r
-const char * MPU_pcTimerGetName( TimerHandle_t xTimer );\r
-TickType_t MPU_xTimerGetPeriod( TimerHandle_t xTimer );\r
-TickType_t MPU_xTimerGetExpiryTime( TimerHandle_t xTimer );\r
-BaseType_t MPU_xTimerCreateTimerTask( void );\r
-BaseType_t MPU_xTimerGenericCommand( TimerHandle_t xTimer, const BaseType_t xCommandID, const TickType_t xOptionalValue, BaseType_t * const pxHigherPriorityTaskWoken, const TickType_t xTicksToWait );\r
-\r
-/* MPU versions of event_group.h API functions. */\r
-EventGroupHandle_t MPU_xEventGroupCreate( void );\r
-EventGroupHandle_t MPU_xEventGroupCreateStatic( StaticEventGroup_t *pxEventGroupBuffer );\r
-EventBits_t MPU_xEventGroupWaitBits( EventGroupHandle_t xEventGroup, const EventBits_t uxBitsToWaitFor, const BaseType_t xClearOnExit, const BaseType_t xWaitForAllBits, TickType_t xTicksToWait );\r
-EventBits_t MPU_xEventGroupClearBits( EventGroupHandle_t xEventGroup, const EventBits_t uxBitsToClear );\r
-EventBits_t MPU_xEventGroupSetBits( EventGroupHandle_t xEventGroup, const EventBits_t uxBitsToSet );\r
-EventBits_t MPU_xEventGroupSync( EventGroupHandle_t xEventGroup, const EventBits_t uxBitsToSet, const EventBits_t uxBitsToWaitFor, TickType_t xTicksToWait );\r
-void MPU_vEventGroupDelete( EventGroupHandle_t xEventGroup );\r
-UBaseType_t MPU_uxEventGroupGetNumber( void* xEventGroup );\r
-\r
-/* MPU versions of message/stream_buffer.h API functions. */\r
-size_t MPU_xStreamBufferSend( StreamBufferHandle_t xStreamBuffer, const void *pvTxData, size_t xDataLengthBytes, TickType_t xTicksToWait );\r
-size_t MPU_xStreamBufferSendFromISR( StreamBufferHandle_t xStreamBuffer, const void *pvTxData, size_t xDataLengthBytes, BaseType_t * const pxHigherPriorityTaskWoken );\r
-size_t MPU_xStreamBufferReceive( StreamBufferHandle_t xStreamBuffer, void *pvRxData, size_t xBufferLengthBytes, TickType_t xTicksToWait );\r
-size_t MPU_xStreamBufferReceiveFromISR( StreamBufferHandle_t xStreamBuffer, void *pvRxData, size_t xBufferLengthBytes, BaseType_t * const pxHigherPriorityTaskWoken );\r
-void MPU_vStreamBufferDelete( StreamBufferHandle_t xStreamBuffer );\r
-BaseType_t MPU_xStreamBufferIsFull( StreamBufferHandle_t xStreamBuffer );\r
-BaseType_t MPU_xStreamBufferIsEmpty( StreamBufferHandle_t xStreamBuffer );\r
-BaseType_t MPU_xStreamBufferReset( StreamBufferHandle_t xStreamBuffer );\r
-size_t MPU_xStreamBufferSpacesAvailable( StreamBufferHandle_t xStreamBuffer );\r
-size_t MPU_xStreamBufferBytesAvailable( StreamBufferHandle_t xStreamBuffer );\r
-BaseType_t MPU_xStreamBufferSetTriggerLevel( StreamBufferHandle_t xStreamBuffer, size_t xTriggerLevel );\r
-StreamBufferHandle_t MPU_xStreamBufferGenericCreate( size_t xBufferSizeBytes, size_t xTriggerLevelBytes, BaseType_t xIsMessageBuffer );\r
-StreamBufferHandle_t MPU_xStreamBufferGenericCreateStatic( size_t xBufferSizeBytes, size_t xTriggerLevelBytes, BaseType_t xIsMessageBuffer, uint8_t * const pucStreamBufferStorageArea, StaticStreamBuffer_t * const pxStaticStreamBuffer );\r
-\r
-\r
-\r
-#endif /* MPU_PROTOTYPES_H */\r
-\r
+++ /dev/null
-/*\r
- * FreeRTOS Kernel V10.0.1\r
- * Copyright (C) 2017 Amazon.com, Inc. or its affiliates. All Rights Reserved.\r
- *\r
- * Permission is hereby granted, free of charge, to any person obtaining a copy of\r
- * this software and associated documentation files (the "Software"), to deal in\r
- * the Software without restriction, including without limitation the rights to\r
- * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of\r
- * the Software, and to permit persons to whom the Software is furnished to do so,\r
- * subject to the following conditions:\r
- *\r
- * The above copyright notice and this permission notice shall be included in all\r
- * copies or substantial portions of the Software.\r
- *\r
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\r
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS\r
- * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR\r
- * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER\r
- * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN\r
- * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\r
- *\r
- * http://www.FreeRTOS.org\r
- * http://aws.amazon.com/freertos\r
- *\r
- * 1 tab == 4 spaces!\r
- */\r
-\r
-#ifndef MPU_WRAPPERS_H\r
-#define MPU_WRAPPERS_H\r
-\r
-/* This file redefines API functions to be called through a wrapper macro, but\r
-only for ports that are using the MPU. */\r
-#ifdef portUSING_MPU_WRAPPERS\r
-\r
- /* MPU_WRAPPERS_INCLUDED_FROM_API_FILE will be defined when this file is\r
- included from queue.c or task.c to prevent it from having an effect within\r
- those files. */\r
- #ifndef MPU_WRAPPERS_INCLUDED_FROM_API_FILE\r
-\r
- /*\r
- * Map standard (non MPU) API functions to equivalents that start\r
- * "MPU_". This will cause the application code to call the MPU_\r
- * version, which wraps the non-MPU version with privilege promoting\r
- * then demoting code, so the kernel code always runs will full\r
- * privileges.\r
- */\r
-\r
- /* Map standard tasks.h API functions to the MPU equivalents. */\r
- #define xTaskCreate MPU_xTaskCreate\r
- #define xTaskCreateStatic MPU_xTaskCreateStatic\r
- #define xTaskCreateRestricted MPU_xTaskCreateRestricted\r
- #define vTaskAllocateMPURegions MPU_vTaskAllocateMPURegions\r
- #define vTaskDelete MPU_vTaskDelete\r
- #define vTaskDelay MPU_vTaskDelay\r
- #define vTaskDelayUntil MPU_vTaskDelayUntil\r
- #define xTaskAbortDelay MPU_xTaskAbortDelay\r
- #define uxTaskPriorityGet MPU_uxTaskPriorityGet\r
- #define eTaskGetState MPU_eTaskGetState\r
- #define vTaskGetInfo MPU_vTaskGetInfo\r
- #define vTaskPrioritySet MPU_vTaskPrioritySet\r
- #define vTaskSuspend MPU_vTaskSuspend\r
- #define vTaskResume MPU_vTaskResume\r
- #define vTaskSuspendAll MPU_vTaskSuspendAll\r
- #define xTaskResumeAll MPU_xTaskResumeAll\r
- #define xTaskGetTickCount MPU_xTaskGetTickCount\r
- #define uxTaskGetNumberOfTasks MPU_uxTaskGetNumberOfTasks\r
- #define pcTaskGetName MPU_pcTaskGetName\r
- #define xTaskGetHandle MPU_xTaskGetHandle\r
- #define uxTaskGetStackHighWaterMark MPU_uxTaskGetStackHighWaterMark\r
- #define vTaskSetApplicationTaskTag MPU_vTaskSetApplicationTaskTag\r
- #define xTaskGetApplicationTaskTag MPU_xTaskGetApplicationTaskTag\r
- #define vTaskSetThreadLocalStoragePointer MPU_vTaskSetThreadLocalStoragePointer\r
- #define pvTaskGetThreadLocalStoragePointer MPU_pvTaskGetThreadLocalStoragePointer\r
- #define xTaskCallApplicationTaskHook MPU_xTaskCallApplicationTaskHook\r
- #define xTaskGetIdleTaskHandle MPU_xTaskGetIdleTaskHandle\r
- #define uxTaskGetSystemState MPU_uxTaskGetSystemState\r
- #define vTaskList MPU_vTaskList\r
- #define vTaskGetRunTimeStats MPU_vTaskGetRunTimeStats\r
- #define xTaskGenericNotify MPU_xTaskGenericNotify\r
- #define xTaskNotifyWait MPU_xTaskNotifyWait\r
- #define ulTaskNotifyTake MPU_ulTaskNotifyTake\r
- #define xTaskNotifyStateClear MPU_xTaskNotifyStateClear\r
-\r
- #define xTaskGetCurrentTaskHandle MPU_xTaskGetCurrentTaskHandle\r
- #define vTaskSetTimeOutState MPU_vTaskSetTimeOutState\r
- #define xTaskCheckForTimeOut MPU_xTaskCheckForTimeOut\r
- #define xTaskGetSchedulerState MPU_xTaskGetSchedulerState\r
-\r
- /* Map standard queue.h API functions to the MPU equivalents. */\r
- #define xQueueGenericSend MPU_xQueueGenericSend\r
- #define xQueueReceive MPU_xQueueReceive\r
- #define xQueuePeek MPU_xQueuePeek\r
- #define xQueueSemaphoreTake MPU_xQueueSemaphoreTake\r
- #define uxQueueMessagesWaiting MPU_uxQueueMessagesWaiting\r
- #define uxQueueSpacesAvailable MPU_uxQueueSpacesAvailable\r
- #define vQueueDelete MPU_vQueueDelete\r
- #define xQueueCreateMutex MPU_xQueueCreateMutex\r
- #define xQueueCreateMutexStatic MPU_xQueueCreateMutexStatic\r
- #define xQueueCreateCountingSemaphore MPU_xQueueCreateCountingSemaphore\r
- #define xQueueCreateCountingSemaphoreStatic MPU_xQueueCreateCountingSemaphoreStatic\r
- #define xQueueGetMutexHolder MPU_xQueueGetMutexHolder\r
- #define xQueueTakeMutexRecursive MPU_xQueueTakeMutexRecursive\r
- #define xQueueGiveMutexRecursive MPU_xQueueGiveMutexRecursive\r
- #define xQueueGenericCreate MPU_xQueueGenericCreate\r
- #define xQueueGenericCreateStatic MPU_xQueueGenericCreateStatic\r
- #define xQueueCreateSet MPU_xQueueCreateSet\r
- #define xQueueAddToSet MPU_xQueueAddToSet\r
- #define xQueueRemoveFromSet MPU_xQueueRemoveFromSet\r
- #define xQueueSelectFromSet MPU_xQueueSelectFromSet\r
- #define xQueueGenericReset MPU_xQueueGenericReset\r
-\r
- #if( configQUEUE_REGISTRY_SIZE > 0 )\r
- #define vQueueAddToRegistry MPU_vQueueAddToRegistry\r
- #define vQueueUnregisterQueue MPU_vQueueUnregisterQueue\r
- #define pcQueueGetName MPU_pcQueueGetName\r
- #endif\r
-\r
- /* Map standard timer.h API functions to the MPU equivalents. */\r
- #define xTimerCreate MPU_xTimerCreate\r
- #define xTimerCreateStatic MPU_xTimerCreateStatic\r
- #define pvTimerGetTimerID MPU_pvTimerGetTimerID\r
- #define vTimerSetTimerID MPU_vTimerSetTimerID\r
- #define xTimerIsTimerActive MPU_xTimerIsTimerActive\r
- #define xTimerGetTimerDaemonTaskHandle MPU_xTimerGetTimerDaemonTaskHandle\r
- #define xTimerPendFunctionCall MPU_xTimerPendFunctionCall\r
- #define pcTimerGetName MPU_pcTimerGetName\r
- #define xTimerGetPeriod MPU_xTimerGetPeriod\r
- #define xTimerGetExpiryTime MPU_xTimerGetExpiryTime\r
- #define xTimerGenericCommand MPU_xTimerGenericCommand\r
-\r
- /* Map standard event_group.h API functions to the MPU equivalents. */\r
- #define xEventGroupCreate MPU_xEventGroupCreate\r
- #define xEventGroupCreateStatic MPU_xEventGroupCreateStatic\r
- #define xEventGroupWaitBits MPU_xEventGroupWaitBits\r
- #define xEventGroupClearBits MPU_xEventGroupClearBits\r
- #define xEventGroupSetBits MPU_xEventGroupSetBits\r
- #define xEventGroupSync MPU_xEventGroupSync\r
- #define vEventGroupDelete MPU_vEventGroupDelete\r
-\r
- /* Map standard message/stream_buffer.h API functions to the MPU\r
- equivalents. */\r
- #define xStreamBufferSend MPU_xStreamBufferSend\r
- #define xStreamBufferSendFromISR MPU_xStreamBufferSendFromISR\r
- #define xStreamBufferReceive MPU_xStreamBufferReceive\r
- #define xStreamBufferReceiveFromISR MPU_xStreamBufferReceiveFromISR\r
- #define vStreamBufferDelete MPU_vStreamBufferDelete\r
- #define xStreamBufferIsFull MPU_xStreamBufferIsFull\r
- #define xStreamBufferIsEmpty MPU_xStreamBufferIsEmpty\r
- #define xStreamBufferReset MPU_xStreamBufferReset\r
- #define xStreamBufferSpacesAvailable MPU_xStreamBufferSpacesAvailable\r
- #define xStreamBufferBytesAvailable MPU_xStreamBufferBytesAvailable\r
- #define xStreamBufferSetTriggerLevel MPU_xStreamBufferSetTriggerLevel\r
- #define xStreamBufferGenericCreate MPU_xStreamBufferGenericCreate\r
- #define xStreamBufferGenericCreateStatic MPU_xStreamBufferGenericCreateStatic\r
-\r
-\r
- /* Remove the privileged function macro, but keep the PRIVILEGED_DATA\r
- macro so applications can place data in privileged access sections\r
- (useful when using statically allocated objects). */\r
- #define PRIVILEGED_FUNCTION\r
- #define PRIVILEGED_DATA __attribute__((section("privileged_data")))\r
-\r
- #else /* MPU_WRAPPERS_INCLUDED_FROM_API_FILE */\r
-\r
- /* Ensure API functions go in the privileged execution section. */\r
- #define PRIVILEGED_FUNCTION __attribute__((section("privileged_functions")))\r
- #define PRIVILEGED_DATA __attribute__((section("privileged_data")))\r
-\r
- #endif /* MPU_WRAPPERS_INCLUDED_FROM_API_FILE */\r
-\r
-#else /* portUSING_MPU_WRAPPERS */\r
-\r
- #define PRIVILEGED_FUNCTION\r
- #define PRIVILEGED_DATA\r
- #define portUSING_MPU_WRAPPERS 0\r
-\r
-#endif /* portUSING_MPU_WRAPPERS */\r
-\r
-\r
-#endif /* MPU_WRAPPERS_H */\r
-\r
+++ /dev/null
-/*\r
- * FreeRTOS Kernel V10.0.1\r
- * Copyright (C) 2017 Amazon.com, Inc. or its affiliates. All Rights Reserved.\r
- *\r
- * Permission is hereby granted, free of charge, to any person obtaining a copy of\r
- * this software and associated documentation files (the "Software"), to deal in\r
- * the Software without restriction, including without limitation the rights to\r
- * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of\r
- * the Software, and to permit persons to whom the Software is furnished to do so,\r
- * subject to the following conditions:\r
- *\r
- * The above copyright notice and this permission notice shall be included in all\r
- * copies or substantial portions of the Software.\r
- *\r
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\r
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS\r
- * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR\r
- * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER\r
- * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN\r
- * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\r
- *\r
- * http://www.FreeRTOS.org\r
- * http://aws.amazon.com/freertos\r
- *\r
- * 1 tab == 4 spaces!\r
- */\r
-\r
-/*-----------------------------------------------------------\r
- * Portable layer API. Each function must be defined for each port.\r
- *----------------------------------------------------------*/\r
-\r
-#ifndef PORTABLE_H\r
-#define PORTABLE_H\r
-\r
-/* Each FreeRTOS port has a unique portmacro.h header file. Originally a\r
-pre-processor definition was used to ensure the pre-processor found the correct\r
-portmacro.h file for the port being used. That scheme was deprecated in favour\r
-of setting the compiler's include path such that it found the correct\r
-portmacro.h file - removing the need for the constant and allowing the\r
-portmacro.h file to be located anywhere in relation to the port being used.\r
-Purely for reasons of backward compatibility the old method is still valid, but\r
-to make it clear that new projects should not use it, support for the port\r
-specific constants has been moved into the deprecated_definitions.h header\r
-file. */\r
-#include "deprecated_definitions.h"\r
-\r
-/* If portENTER_CRITICAL is not defined then including deprecated_definitions.h\r
-did not result in a portmacro.h header file being included - and it should be\r
-included here. In this case the path to the correct portmacro.h header file\r
-must be set in the compiler's include path. */\r
-#ifndef portENTER_CRITICAL\r
- #include "portmacro.h"\r
-#endif\r
-\r
-#if portBYTE_ALIGNMENT == 32\r
- #define portBYTE_ALIGNMENT_MASK ( 0x001f )\r
-#endif\r
-\r
-#if portBYTE_ALIGNMENT == 16\r
- #define portBYTE_ALIGNMENT_MASK ( 0x000f )\r
-#endif\r
-\r
-#if portBYTE_ALIGNMENT == 8\r
- #define portBYTE_ALIGNMENT_MASK ( 0x0007 )\r
-#endif\r
-\r
-#if portBYTE_ALIGNMENT == 4\r
- #define portBYTE_ALIGNMENT_MASK ( 0x0003 )\r
-#endif\r
-\r
-#if portBYTE_ALIGNMENT == 2\r
- #define portBYTE_ALIGNMENT_MASK ( 0x0001 )\r
-#endif\r
-\r
-#if portBYTE_ALIGNMENT == 1\r
- #define portBYTE_ALIGNMENT_MASK ( 0x0000 )\r
-#endif\r
-\r
-#ifndef portBYTE_ALIGNMENT_MASK\r
- #error "Invalid portBYTE_ALIGNMENT definition"\r
-#endif\r
-\r
-#ifndef portNUM_CONFIGURABLE_REGIONS\r
- #define portNUM_CONFIGURABLE_REGIONS 1\r
-#endif\r
-\r
-#ifdef __cplusplus\r
-extern "C" {\r
-#endif\r
-\r
-#include "mpu_wrappers.h"\r
-\r
-/*\r
- * Setup the stack of a new task so it is ready to be placed under the\r
- * scheduler control. The registers have to be placed on the stack in\r
- * the order that the port expects to find them.\r
- *\r
- */\r
-#if( portUSING_MPU_WRAPPERS == 1 )\r
- StackType_t *pxPortInitialiseStack( StackType_t *pxTopOfStack, TaskFunction_t pxCode, void *pvParameters, BaseType_t xRunPrivileged ) PRIVILEGED_FUNCTION;\r
-#else\r
- StackType_t *pxPortInitialiseStack( StackType_t *pxTopOfStack, TaskFunction_t pxCode, void *pvParameters ) PRIVILEGED_FUNCTION;\r
-#endif\r
-\r
-/* Used by heap_5.c. */\r
-typedef struct HeapRegion\r
-{\r
- uint8_t *pucStartAddress;\r
- size_t xSizeInBytes;\r
-} HeapRegion_t;\r
-\r
-/*\r
- * Used to define multiple heap regions for use by heap_5.c. This function\r
- * must be called before any calls to pvPortMalloc() - not creating a task,\r
- * queue, semaphore, mutex, software timer, event group, etc. will result in\r
- * pvPortMalloc being called.\r
- *\r
- * pxHeapRegions passes in an array of HeapRegion_t structures - each of which\r
- * defines a region of memory that can be used as the heap. The array is\r
- * terminated by a HeapRegions_t structure that has a size of 0. The region\r
- * with the lowest start address must appear first in the array.\r
- */\r
-void vPortDefineHeapRegions( const HeapRegion_t * const pxHeapRegions ) PRIVILEGED_FUNCTION;\r
-\r
-\r
-/*\r
- * Map to the memory management routines required for the port.\r
- */\r
-void *pvPortMalloc( size_t xSize ) PRIVILEGED_FUNCTION;\r
-void vPortFree( void *pv ) PRIVILEGED_FUNCTION;\r
-void vPortInitialiseBlocks( void ) PRIVILEGED_FUNCTION;\r
-size_t xPortGetFreeHeapSize( void ) PRIVILEGED_FUNCTION;\r
-size_t xPortGetMinimumEverFreeHeapSize( void ) PRIVILEGED_FUNCTION;\r
-\r
-/*\r
- * Setup the hardware ready for the scheduler to take control. This generally\r
- * sets up a tick interrupt and sets timers for the correct tick frequency.\r
- */\r
-BaseType_t xPortStartScheduler( void ) PRIVILEGED_FUNCTION;\r
-\r
-/*\r
- * Undo any hardware/ISR setup that was performed by xPortStartScheduler() so\r
- * the hardware is left in its original condition after the scheduler stops\r
- * executing.\r
- */\r
-void vPortEndScheduler( void ) PRIVILEGED_FUNCTION;\r
-\r
-/*\r
- * The structures and methods of manipulating the MPU are contained within the\r
- * port layer.\r
- *\r
- * Fills the xMPUSettings structure with the memory region information\r
- * contained in xRegions.\r
- */\r
-#if( portUSING_MPU_WRAPPERS == 1 )\r
- struct xMEMORY_REGION;\r
- void vPortStoreTaskMPUSettings( xMPU_SETTINGS *xMPUSettings, const struct xMEMORY_REGION * const xRegions, StackType_t *pxBottomOfStack, uint32_t ulStackDepth ) PRIVILEGED_FUNCTION;\r
-#endif\r
-\r
-#ifdef __cplusplus\r
-}\r
-#endif\r
-\r
-#endif /* PORTABLE_H */\r
-\r
+++ /dev/null
-/*\r
- * FreeRTOS Kernel V10.0.1\r
- * Copyright (C) 2017 Amazon.com, Inc. or its affiliates. All Rights Reserved.\r
- *\r
- * Permission is hereby granted, free of charge, to any person obtaining a copy of\r
- * this software and associated documentation files (the "Software"), to deal in\r
- * the Software without restriction, including without limitation the rights to\r
- * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of\r
- * the Software, and to permit persons to whom the Software is furnished to do so,\r
- * subject to the following conditions:\r
- *\r
- * The above copyright notice and this permission notice shall be included in all\r
- * copies or substantial portions of the Software.\r
- *\r
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\r
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS\r
- * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR\r
- * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER\r
- * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN\r
- * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\r
- *\r
- * http://www.FreeRTOS.org\r
- * http://aws.amazon.com/freertos\r
- *\r
- * 1 tab == 4 spaces!\r
- */\r
-\r
-#ifndef PROJDEFS_H\r
-#define PROJDEFS_H\r
-\r
-/*\r
- * Defines the prototype to which task functions must conform. Defined in this\r
- * file to ensure the type is known before portable.h is included.\r
- */\r
-typedef void (*TaskFunction_t)( void * );\r
-\r
-/* Converts a time in milliseconds to a time in ticks. This macro can be\r
-overridden by a macro of the same name defined in FreeRTOSConfig.h in case the\r
-definition here is not suitable for your application. */\r
-#ifndef pdMS_TO_TICKS\r
- #define pdMS_TO_TICKS( xTimeInMs ) ( ( TickType_t ) ( ( ( TickType_t ) ( xTimeInMs ) * ( TickType_t ) configTICK_RATE_HZ ) / ( TickType_t ) 1000 ) )\r
-#endif\r
-\r
-#define pdFALSE ( ( BaseType_t ) 0 )\r
-#define pdTRUE ( ( BaseType_t ) 1 )\r
-\r
-#define pdPASS ( pdTRUE )\r
-#define pdFAIL ( pdFALSE )\r
-#define errQUEUE_EMPTY ( ( BaseType_t ) 0 )\r
-#define errQUEUE_FULL ( ( BaseType_t ) 0 )\r
-\r
-/* FreeRTOS error definitions. */\r
-#define errCOULD_NOT_ALLOCATE_REQUIRED_MEMORY ( -1 )\r
-#define errQUEUE_BLOCKED ( -4 )\r
-#define errQUEUE_YIELD ( -5 )\r
-\r
-/* Macros used for basic data corruption checks. */\r
-#ifndef configUSE_LIST_DATA_INTEGRITY_CHECK_BYTES\r
- #define configUSE_LIST_DATA_INTEGRITY_CHECK_BYTES 0\r
-#endif\r
-\r
-#if( configUSE_16_BIT_TICKS == 1 )\r
- #define pdINTEGRITY_CHECK_VALUE 0x5a5a\r
-#else\r
- #define pdINTEGRITY_CHECK_VALUE 0x5a5a5a5aUL\r
-#endif\r
-\r
-/* The following errno values are used by FreeRTOS+ components, not FreeRTOS\r
-itself. */\r
-#define pdFREERTOS_ERRNO_NONE 0 /* No errors */\r
-#define pdFREERTOS_ERRNO_ENOENT 2 /* No such file or directory */\r
-#define pdFREERTOS_ERRNO_EINTR 4 /* Interrupted system call */\r
-#define pdFREERTOS_ERRNO_EIO 5 /* I/O error */\r
-#define pdFREERTOS_ERRNO_ENXIO 6 /* No such device or address */\r
-#define pdFREERTOS_ERRNO_EBADF 9 /* Bad file number */\r
-#define pdFREERTOS_ERRNO_EAGAIN 11 /* No more processes */\r
-#define pdFREERTOS_ERRNO_EWOULDBLOCK 11 /* Operation would block */\r
-#define pdFREERTOS_ERRNO_ENOMEM 12 /* Not enough memory */\r
-#define pdFREERTOS_ERRNO_EACCES 13 /* Permission denied */\r
-#define pdFREERTOS_ERRNO_EFAULT 14 /* Bad address */\r
-#define pdFREERTOS_ERRNO_EBUSY 16 /* Mount device busy */\r
-#define pdFREERTOS_ERRNO_EEXIST 17 /* File exists */\r
-#define pdFREERTOS_ERRNO_EXDEV 18 /* Cross-device link */\r
-#define pdFREERTOS_ERRNO_ENODEV 19 /* No such device */\r
-#define pdFREERTOS_ERRNO_ENOTDIR 20 /* Not a directory */\r
-#define pdFREERTOS_ERRNO_EISDIR 21 /* Is a directory */\r
-#define pdFREERTOS_ERRNO_EINVAL 22 /* Invalid argument */\r
-#define pdFREERTOS_ERRNO_ENOSPC 28 /* No space left on device */\r
-#define pdFREERTOS_ERRNO_ESPIPE 29 /* Illegal seek */\r
-#define pdFREERTOS_ERRNO_EROFS 30 /* Read only file system */\r
-#define pdFREERTOS_ERRNO_EUNATCH 42 /* Protocol driver not attached */\r
-#define pdFREERTOS_ERRNO_EBADE 50 /* Invalid exchange */\r
-#define pdFREERTOS_ERRNO_EFTYPE 79 /* Inappropriate file type or format */\r
-#define pdFREERTOS_ERRNO_ENMFILE 89 /* No more files */\r
-#define pdFREERTOS_ERRNO_ENOTEMPTY 90 /* Directory not empty */\r
-#define pdFREERTOS_ERRNO_ENAMETOOLONG 91 /* File or path name too long */\r
-#define pdFREERTOS_ERRNO_EOPNOTSUPP 95 /* Operation not supported on transport endpoint */\r
-#define pdFREERTOS_ERRNO_ENOBUFS 105 /* No buffer space available */\r
-#define pdFREERTOS_ERRNO_ENOPROTOOPT 109 /* Protocol not available */\r
-#define pdFREERTOS_ERRNO_EADDRINUSE 112 /* Address already in use */\r
-#define pdFREERTOS_ERRNO_ETIMEDOUT 116 /* Connection timed out */\r
-#define pdFREERTOS_ERRNO_EINPROGRESS 119 /* Connection already in progress */\r
-#define pdFREERTOS_ERRNO_EALREADY 120 /* Socket already connected */\r
-#define pdFREERTOS_ERRNO_EADDRNOTAVAIL 125 /* Address not available */\r
-#define pdFREERTOS_ERRNO_EISCONN 127 /* Socket is already connected */\r
-#define pdFREERTOS_ERRNO_ENOTCONN 128 /* Socket is not connected */\r
-#define pdFREERTOS_ERRNO_ENOMEDIUM 135 /* No medium inserted */\r
-#define pdFREERTOS_ERRNO_EILSEQ 138 /* An invalid UTF-16 sequence was encountered. */\r
-#define pdFREERTOS_ERRNO_ECANCELED 140 /* Operation canceled. */\r
-\r
-/* The following endian values are used by FreeRTOS+ components, not FreeRTOS\r
-itself. */\r
-#define pdFREERTOS_LITTLE_ENDIAN 0\r
-#define pdFREERTOS_BIG_ENDIAN 1\r
-\r
-/* Re-defining endian values for generic naming. */\r
-#define pdLITTLE_ENDIAN pdFREERTOS_LITTLE_ENDIAN\r
-#define pdBIG_ENDIAN pdFREERTOS_BIG_ENDIAN\r
-\r
-\r
-#endif /* PROJDEFS_H */\r
-\r
-\r
-\r
+++ /dev/null
-/*\r
- * FreeRTOS Kernel V10.0.1\r
- * Copyright (C) 2017 Amazon.com, Inc. or its affiliates. All Rights Reserved.\r
- *\r
- * Permission is hereby granted, free of charge, to any person obtaining a copy of\r
- * this software and associated documentation files (the "Software"), to deal in\r
- * the Software without restriction, including without limitation the rights to\r
- * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of\r
- * the Software, and to permit persons to whom the Software is furnished to do so,\r
- * subject to the following conditions:\r
- *\r
- * The above copyright notice and this permission notice shall be included in all\r
- * copies or substantial portions of the Software.\r
- *\r
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\r
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS\r
- * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR\r
- * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER\r
- * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN\r
- * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\r
- *\r
- * http://www.FreeRTOS.org\r
- * http://aws.amazon.com/freertos\r
- *\r
- * 1 tab == 4 spaces!\r
- */\r
-\r
-\r
-#ifndef QUEUE_H\r
-#define QUEUE_H\r
-\r
-#ifndef INC_FREERTOS_H\r
- #error "include FreeRTOS.h" must appear in source files before "include queue.h"\r
-#endif\r
-\r
-#ifdef __cplusplus\r
-extern "C" {\r
-#endif\r
-\r
-\r
-/**\r
- * Type by which queues are referenced. For example, a call to xQueueCreate()\r
- * returns an QueueHandle_t variable that can then be used as a parameter to\r
- * xQueueSend(), xQueueReceive(), etc.\r
- */\r
-typedef void * QueueHandle_t;\r
-\r
-/**\r
- * Type by which queue sets are referenced. For example, a call to\r
- * xQueueCreateSet() returns an xQueueSet variable that can then be used as a\r
- * parameter to xQueueSelectFromSet(), xQueueAddToSet(), etc.\r
- */\r
-typedef void * QueueSetHandle_t;\r
-\r
-/**\r
- * Queue sets can contain both queues and semaphores, so the\r
- * QueueSetMemberHandle_t is defined as a type to be used where a parameter or\r
- * return value can be either an QueueHandle_t or an SemaphoreHandle_t.\r
- */\r
-typedef void * QueueSetMemberHandle_t;\r
-\r
-/* For internal use only. */\r
-#define queueSEND_TO_BACK ( ( BaseType_t ) 0 )\r
-#define queueSEND_TO_FRONT ( ( BaseType_t ) 1 )\r
-#define queueOVERWRITE ( ( BaseType_t ) 2 )\r
-\r
-/* For internal use only. These definitions *must* match those in queue.c. */\r
-#define queueQUEUE_TYPE_BASE ( ( uint8_t ) 0U )\r
-#define queueQUEUE_TYPE_SET ( ( uint8_t ) 0U )\r
-#define queueQUEUE_TYPE_MUTEX ( ( uint8_t ) 1U )\r
-#define queueQUEUE_TYPE_COUNTING_SEMAPHORE ( ( uint8_t ) 2U )\r
-#define queueQUEUE_TYPE_BINARY_SEMAPHORE ( ( uint8_t ) 3U )\r
-#define queueQUEUE_TYPE_RECURSIVE_MUTEX ( ( uint8_t ) 4U )\r
-\r
-/**\r
- * queue. h\r
- * <pre>\r
- QueueHandle_t xQueueCreate(\r
- UBaseType_t uxQueueLength,\r
- UBaseType_t uxItemSize\r
- );\r
- * </pre>\r
- *\r
- * Creates a new queue instance, and returns a handle by which the new queue\r
- * can be referenced.\r
- *\r
- * Internally, within the FreeRTOS implementation, queues use two blocks of\r
- * memory. The first block is used to hold the queue's data structures. The\r
- * second block is used to hold items placed into the queue. If a queue is\r
- * created using xQueueCreate() then both blocks of memory are automatically\r
- * dynamically allocated inside the xQueueCreate() function. (see\r
- * http://www.freertos.org/a00111.html). If a queue is created using\r
- * xQueueCreateStatic() then the application writer must provide the memory that\r
- * will get used by the queue. xQueueCreateStatic() therefore allows a queue to\r
- * be created without using any dynamic memory allocation.\r
- *\r
- * http://www.FreeRTOS.org/Embedded-RTOS-Queues.html\r
- *\r
- * @param uxQueueLength The maximum number of items that the queue can contain.\r
- *\r
- * @param uxItemSize The number of bytes each item in the queue will require.\r
- * Items are queued by copy, not by reference, so this is the number of bytes\r
- * that will be copied for each posted item. Each item on the queue must be\r
- * the same size.\r
- *\r
- * @return If the queue is successfully create then a handle to the newly\r
- * created queue is returned. If the queue cannot be created then 0 is\r
- * returned.\r
- *\r
- * Example usage:\r
- <pre>\r
- struct AMessage\r
- {\r
- char ucMessageID;\r
- char ucData[ 20 ];\r
- };\r
-\r
- void vATask( void *pvParameters )\r
- {\r
- QueueHandle_t xQueue1, xQueue2;\r
-\r
- // Create a queue capable of containing 10 uint32_t values.\r
- xQueue1 = xQueueCreate( 10, sizeof( uint32_t ) );\r
- if( xQueue1 == 0 )\r
- {\r
- // Queue was not created and must not be used.\r
- }\r
-\r
- // Create a queue capable of containing 10 pointers to AMessage structures.\r
- // These should be passed by pointer as they contain a lot of data.\r
- xQueue2 = xQueueCreate( 10, sizeof( struct AMessage * ) );\r
- if( xQueue2 == 0 )\r
- {\r
- // Queue was not created and must not be used.\r
- }\r
-\r
- // ... Rest of task code.\r
- }\r
- </pre>\r
- * \defgroup xQueueCreate xQueueCreate\r
- * \ingroup QueueManagement\r
- */\r
-#if( configSUPPORT_DYNAMIC_ALLOCATION == 1 )\r
- #define xQueueCreate( uxQueueLength, uxItemSize ) xQueueGenericCreate( ( uxQueueLength ), ( uxItemSize ), ( queueQUEUE_TYPE_BASE ) )\r
-#endif\r
-\r
-/**\r
- * queue. h\r
- * <pre>\r
- QueueHandle_t xQueueCreateStatic(\r
- UBaseType_t uxQueueLength,\r
- UBaseType_t uxItemSize,\r
- uint8_t *pucQueueStorageBuffer,\r
- StaticQueue_t *pxQueueBuffer\r
- );\r
- * </pre>\r
- *\r
- * Creates a new queue instance, and returns a handle by which the new queue\r
- * can be referenced.\r
- *\r
- * Internally, within the FreeRTOS implementation, queues use two blocks of\r
- * memory. The first block is used to hold the queue's data structures. The\r
- * second block is used to hold items placed into the queue. If a queue is\r
- * created using xQueueCreate() then both blocks of memory are automatically\r
- * dynamically allocated inside the xQueueCreate() function. (see\r
- * http://www.freertos.org/a00111.html). If a queue is created using\r
- * xQueueCreateStatic() then the application writer must provide the memory that\r
- * will get used by the queue. xQueueCreateStatic() therefore allows a queue to\r
- * be created without using any dynamic memory allocation.\r
- *\r
- * http://www.FreeRTOS.org/Embedded-RTOS-Queues.html\r
- *\r
- * @param uxQueueLength The maximum number of items that the queue can contain.\r
- *\r
- * @param uxItemSize The number of bytes each item in the queue will require.\r
- * Items are queued by copy, not by reference, so this is the number of bytes\r
- * that will be copied for each posted item. Each item on the queue must be\r
- * the same size.\r
- *\r
- * @param pucQueueStorageBuffer If uxItemSize is not zero then\r
- * pucQueueStorageBuffer must point to a uint8_t array that is at least large\r
- * enough to hold the maximum number of items that can be in the queue at any\r
- * one time - which is ( uxQueueLength * uxItemsSize ) bytes. If uxItemSize is\r
- * zero then pucQueueStorageBuffer can be NULL.\r
- *\r
- * @param pxQueueBuffer Must point to a variable of type StaticQueue_t, which\r
- * will be used to hold the queue's data structure.\r
- *\r
- * @return If the queue is created then a handle to the created queue is\r
- * returned. If pxQueueBuffer is NULL then NULL is returned.\r
- *\r
- * Example usage:\r
- <pre>\r
- struct AMessage\r
- {\r
- char ucMessageID;\r
- char ucData[ 20 ];\r
- };\r
-\r
- #define QUEUE_LENGTH 10\r
- #define ITEM_SIZE sizeof( uint32_t )\r
-\r
- // xQueueBuffer will hold the queue structure.\r
- StaticQueue_t xQueueBuffer;\r
-\r
- // ucQueueStorage will hold the items posted to the queue. Must be at least\r
- // [(queue length) * ( queue item size)] bytes long.\r
- uint8_t ucQueueStorage[ QUEUE_LENGTH * ITEM_SIZE ];\r
-\r
- void vATask( void *pvParameters )\r
- {\r
- QueueHandle_t xQueue1;\r
-\r
- // Create a queue capable of containing 10 uint32_t values.\r
- xQueue1 = xQueueCreate( QUEUE_LENGTH, // The number of items the queue can hold.\r
- ITEM_SIZE // The size of each item in the queue\r
- &( ucQueueStorage[ 0 ] ), // The buffer that will hold the items in the queue.\r
- &xQueueBuffer ); // The buffer that will hold the queue structure.\r
-\r
- // The queue is guaranteed to be created successfully as no dynamic memory\r
- // allocation is used. Therefore xQueue1 is now a handle to a valid queue.\r
-\r
- // ... Rest of task code.\r
- }\r
- </pre>\r
- * \defgroup xQueueCreateStatic xQueueCreateStatic\r
- * \ingroup QueueManagement\r
- */\r
-#if( configSUPPORT_STATIC_ALLOCATION == 1 )\r
- #define xQueueCreateStatic( uxQueueLength, uxItemSize, pucQueueStorage, pxQueueBuffer ) xQueueGenericCreateStatic( ( uxQueueLength ), ( uxItemSize ), ( pucQueueStorage ), ( pxQueueBuffer ), ( queueQUEUE_TYPE_BASE ) )\r
-#endif /* configSUPPORT_STATIC_ALLOCATION */\r
-\r
-/**\r
- * queue. h\r
- * <pre>\r
- BaseType_t xQueueSendToToFront(\r
- QueueHandle_t xQueue,\r
- const void *pvItemToQueue,\r
- TickType_t xTicksToWait\r
- );\r
- * </pre>\r
- *\r
- * Post an item to the front of a queue. The item is queued by copy, not by\r
- * reference. This function must not be called from an interrupt service\r
- * routine. See xQueueSendFromISR () for an alternative which may be used\r
- * in an ISR.\r
- *\r
- * @param xQueue The handle to the queue on which the item is to be posted.\r
- *\r
- * @param pvItemToQueue A pointer to the item that is to be placed on the\r
- * queue. The size of the items the queue will hold was defined when the\r
- * queue was created, so this many bytes will be copied from pvItemToQueue\r
- * into the queue storage area.\r
- *\r
- * @param xTicksToWait The maximum amount of time the task should block\r
- * waiting for space to become available on the queue, should it already\r
- * be full. The call will return immediately if this is set to 0 and the\r
- * queue is full. The time is defined in tick periods so the constant\r
- * portTICK_PERIOD_MS should be used to convert to real time if this is required.\r
- *\r
- * @return pdTRUE if the item was successfully posted, otherwise errQUEUE_FULL.\r
- *\r
- * Example usage:\r
- <pre>\r
- struct AMessage\r
- {\r
- char ucMessageID;\r
- char ucData[ 20 ];\r
- } xMessage;\r
-\r
- uint32_t ulVar = 10UL;\r
-\r
- void vATask( void *pvParameters )\r
- {\r
- QueueHandle_t xQueue1, xQueue2;\r
- struct AMessage *pxMessage;\r
-\r
- // Create a queue capable of containing 10 uint32_t values.\r
- xQueue1 = xQueueCreate( 10, sizeof( uint32_t ) );\r
-\r
- // Create a queue capable of containing 10 pointers to AMessage structures.\r
- // These should be passed by pointer as they contain a lot of data.\r
- xQueue2 = xQueueCreate( 10, sizeof( struct AMessage * ) );\r
-\r
- // ...\r
-\r
- if( xQueue1 != 0 )\r
- {\r
- // Send an uint32_t. Wait for 10 ticks for space to become\r
- // available if necessary.\r
- if( xQueueSendToFront( xQueue1, ( void * ) &ulVar, ( TickType_t ) 10 ) != pdPASS )\r
- {\r
- // Failed to post the message, even after 10 ticks.\r
- }\r
- }\r
-\r
- if( xQueue2 != 0 )\r
- {\r
- // Send a pointer to a struct AMessage object. Don't block if the\r
- // queue is already full.\r
- pxMessage = & xMessage;\r
- xQueueSendToFront( xQueue2, ( void * ) &pxMessage, ( TickType_t ) 0 );\r
- }\r
-\r
- // ... Rest of task code.\r
- }\r
- </pre>\r
- * \defgroup xQueueSend xQueueSend\r
- * \ingroup QueueManagement\r
- */\r
-#define xQueueSendToFront( xQueue, pvItemToQueue, xTicksToWait ) xQueueGenericSend( ( xQueue ), ( pvItemToQueue ), ( xTicksToWait ), queueSEND_TO_FRONT )\r
-\r
-/**\r
- * queue. h\r
- * <pre>\r
- BaseType_t xQueueSendToBack(\r
- QueueHandle_t xQueue,\r
- const void *pvItemToQueue,\r
- TickType_t xTicksToWait\r
- );\r
- * </pre>\r
- *\r
- * This is a macro that calls xQueueGenericSend().\r
- *\r
- * Post an item to the back of a queue. The item is queued by copy, not by\r
- * reference. This function must not be called from an interrupt service\r
- * routine. See xQueueSendFromISR () for an alternative which may be used\r
- * in an ISR.\r
- *\r
- * @param xQueue The handle to the queue on which the item is to be posted.\r
- *\r
- * @param pvItemToQueue A pointer to the item that is to be placed on the\r
- * queue. The size of the items the queue will hold was defined when the\r
- * queue was created, so this many bytes will be copied from pvItemToQueue\r
- * into the queue storage area.\r
- *\r
- * @param xTicksToWait The maximum amount of time the task should block\r
- * waiting for space to become available on the queue, should it already\r
- * be full. The call will return immediately if this is set to 0 and the queue\r
- * is full. The time is defined in tick periods so the constant\r
- * portTICK_PERIOD_MS should be used to convert to real time if this is required.\r
- *\r
- * @return pdTRUE if the item was successfully posted, otherwise errQUEUE_FULL.\r
- *\r
- * Example usage:\r
- <pre>\r
- struct AMessage\r
- {\r
- char ucMessageID;\r
- char ucData[ 20 ];\r
- } xMessage;\r
-\r
- uint32_t ulVar = 10UL;\r
-\r
- void vATask( void *pvParameters )\r
- {\r
- QueueHandle_t xQueue1, xQueue2;\r
- struct AMessage *pxMessage;\r
-\r
- // Create a queue capable of containing 10 uint32_t values.\r
- xQueue1 = xQueueCreate( 10, sizeof( uint32_t ) );\r
-\r
- // Create a queue capable of containing 10 pointers to AMessage structures.\r
- // These should be passed by pointer as they contain a lot of data.\r
- xQueue2 = xQueueCreate( 10, sizeof( struct AMessage * ) );\r
-\r
- // ...\r
-\r
- if( xQueue1 != 0 )\r
- {\r
- // Send an uint32_t. Wait for 10 ticks for space to become\r
- // available if necessary.\r
- if( xQueueSendToBack( xQueue1, ( void * ) &ulVar, ( TickType_t ) 10 ) != pdPASS )\r
- {\r
- // Failed to post the message, even after 10 ticks.\r
- }\r
- }\r
-\r
- if( xQueue2 != 0 )\r
- {\r
- // Send a pointer to a struct AMessage object. Don't block if the\r
- // queue is already full.\r
- pxMessage = & xMessage;\r
- xQueueSendToBack( xQueue2, ( void * ) &pxMessage, ( TickType_t ) 0 );\r
- }\r
-\r
- // ... Rest of task code.\r
- }\r
- </pre>\r
- * \defgroup xQueueSend xQueueSend\r
- * \ingroup QueueManagement\r
- */\r
-#define xQueueSendToBack( xQueue, pvItemToQueue, xTicksToWait ) xQueueGenericSend( ( xQueue ), ( pvItemToQueue ), ( xTicksToWait ), queueSEND_TO_BACK )\r
-\r
-/**\r
- * queue. h\r
- * <pre>\r
- BaseType_t xQueueSend(\r
- QueueHandle_t xQueue,\r
- const void * pvItemToQueue,\r
- TickType_t xTicksToWait\r
- );\r
- * </pre>\r
- *\r
- * This is a macro that calls xQueueGenericSend(). It is included for\r
- * backward compatibility with versions of FreeRTOS.org that did not\r
- * include the xQueueSendToFront() and xQueueSendToBack() macros. It is\r
- * equivalent to xQueueSendToBack().\r
- *\r
- * Post an item on a queue. The item is queued by copy, not by reference.\r
- * This function must not be called from an interrupt service routine.\r
- * See xQueueSendFromISR () for an alternative which may be used in an ISR.\r
- *\r
- * @param xQueue The handle to the queue on which the item is to be posted.\r
- *\r
- * @param pvItemToQueue A pointer to the item that is to be placed on the\r
- * queue. The size of the items the queue will hold was defined when the\r
- * queue was created, so this many bytes will be copied from pvItemToQueue\r
- * into the queue storage area.\r
- *\r
- * @param xTicksToWait The maximum amount of time the task should block\r
- * waiting for space to become available on the queue, should it already\r
- * be full. The call will return immediately if this is set to 0 and the\r
- * queue is full. The time is defined in tick periods so the constant\r
- * portTICK_PERIOD_MS should be used to convert to real time if this is required.\r
- *\r
- * @return pdTRUE if the item was successfully posted, otherwise errQUEUE_FULL.\r
- *\r
- * Example usage:\r
- <pre>\r
- struct AMessage\r
- {\r
- char ucMessageID;\r
- char ucData[ 20 ];\r
- } xMessage;\r
-\r
- uint32_t ulVar = 10UL;\r
-\r
- void vATask( void *pvParameters )\r
- {\r
- QueueHandle_t xQueue1, xQueue2;\r
- struct AMessage *pxMessage;\r
-\r
- // Create a queue capable of containing 10 uint32_t values.\r
- xQueue1 = xQueueCreate( 10, sizeof( uint32_t ) );\r
-\r
- // Create a queue capable of containing 10 pointers to AMessage structures.\r
- // These should be passed by pointer as they contain a lot of data.\r
- xQueue2 = xQueueCreate( 10, sizeof( struct AMessage * ) );\r
-\r
- // ...\r
-\r
- if( xQueue1 != 0 )\r
- {\r
- // Send an uint32_t. Wait for 10 ticks for space to become\r
- // available if necessary.\r
- if( xQueueSend( xQueue1, ( void * ) &ulVar, ( TickType_t ) 10 ) != pdPASS )\r
- {\r
- // Failed to post the message, even after 10 ticks.\r
- }\r
- }\r
-\r
- if( xQueue2 != 0 )\r
- {\r
- // Send a pointer to a struct AMessage object. Don't block if the\r
- // queue is already full.\r
- pxMessage = & xMessage;\r
- xQueueSend( xQueue2, ( void * ) &pxMessage, ( TickType_t ) 0 );\r
- }\r
-\r
- // ... Rest of task code.\r
- }\r
- </pre>\r
- * \defgroup xQueueSend xQueueSend\r
- * \ingroup QueueManagement\r
- */\r
-#define xQueueSend( xQueue, pvItemToQueue, xTicksToWait ) xQueueGenericSend( ( xQueue ), ( pvItemToQueue ), ( xTicksToWait ), queueSEND_TO_BACK )\r
-\r
-/**\r
- * queue. h\r
- * <pre>\r
- BaseType_t xQueueOverwrite(\r
- QueueHandle_t xQueue,\r
- const void * pvItemToQueue\r
- );\r
- * </pre>\r
- *\r
- * Only for use with queues that have a length of one - so the queue is either\r
- * empty or full.\r
- *\r
- * Post an item on a queue. If the queue is already full then overwrite the\r
- * value held in the queue. The item is queued by copy, not by reference.\r
- *\r
- * This function must not be called from an interrupt service routine.\r
- * See xQueueOverwriteFromISR () for an alternative which may be used in an ISR.\r
- *\r
- * @param xQueue The handle of the queue to which the data is being sent.\r
- *\r
- * @param pvItemToQueue A pointer to the item that is to be placed on the\r
- * queue. The size of the items the queue will hold was defined when the\r
- * queue was created, so this many bytes will be copied from pvItemToQueue\r
- * into the queue storage area.\r
- *\r
- * @return xQueueOverwrite() is a macro that calls xQueueGenericSend(), and\r
- * therefore has the same return values as xQueueSendToFront(). However, pdPASS\r
- * is the only value that can be returned because xQueueOverwrite() will write\r
- * to the queue even when the queue is already full.\r
- *\r
- * Example usage:\r
- <pre>\r
-\r
- void vFunction( void *pvParameters )\r
- {\r
- QueueHandle_t xQueue;\r
- uint32_t ulVarToSend, ulValReceived;\r
-\r
- // Create a queue to hold one uint32_t value. It is strongly\r
- // recommended *not* to use xQueueOverwrite() on queues that can\r
- // contain more than one value, and doing so will trigger an assertion\r
- // if configASSERT() is defined.\r
- xQueue = xQueueCreate( 1, sizeof( uint32_t ) );\r
-\r
- // Write the value 10 to the queue using xQueueOverwrite().\r
- ulVarToSend = 10;\r
- xQueueOverwrite( xQueue, &ulVarToSend );\r
-\r
- // Peeking the queue should now return 10, but leave the value 10 in\r
- // the queue. A block time of zero is used as it is known that the\r
- // queue holds a value.\r
- ulValReceived = 0;\r
- xQueuePeek( xQueue, &ulValReceived, 0 );\r
-\r
- if( ulValReceived != 10 )\r
- {\r
- // Error unless the item was removed by a different task.\r
- }\r
-\r
- // The queue is still full. Use xQueueOverwrite() to overwrite the\r
- // value held in the queue with 100.\r
- ulVarToSend = 100;\r
- xQueueOverwrite( xQueue, &ulVarToSend );\r
-\r
- // This time read from the queue, leaving the queue empty once more.\r
- // A block time of 0 is used again.\r
- xQueueReceive( xQueue, &ulValReceived, 0 );\r
-\r
- // The value read should be the last value written, even though the\r
- // queue was already full when the value was written.\r
- if( ulValReceived != 100 )\r
- {\r
- // Error!\r
- }\r
-\r
- // ...\r
-}\r
- </pre>\r
- * \defgroup xQueueOverwrite xQueueOverwrite\r
- * \ingroup QueueManagement\r
- */\r
-#define xQueueOverwrite( xQueue, pvItemToQueue ) xQueueGenericSend( ( xQueue ), ( pvItemToQueue ), 0, queueOVERWRITE )\r
-\r
-\r
-/**\r
- * queue. h\r
- * <pre>\r
- BaseType_t xQueueGenericSend(\r
- QueueHandle_t xQueue,\r
- const void * pvItemToQueue,\r
- TickType_t xTicksToWait\r
- BaseType_t xCopyPosition\r
- );\r
- * </pre>\r
- *\r
- * It is preferred that the macros xQueueSend(), xQueueSendToFront() and\r
- * xQueueSendToBack() are used in place of calling this function directly.\r
- *\r
- * Post an item on a queue. The item is queued by copy, not by reference.\r
- * This function must not be called from an interrupt service routine.\r
- * See xQueueSendFromISR () for an alternative which may be used in an ISR.\r
- *\r
- * @param xQueue The handle to the queue on which the item is to be posted.\r
- *\r
- * @param pvItemToQueue A pointer to the item that is to be placed on the\r
- * queue. The size of the items the queue will hold was defined when the\r
- * queue was created, so this many bytes will be copied from pvItemToQueue\r
- * into the queue storage area.\r
- *\r
- * @param xTicksToWait The maximum amount of time the task should block\r
- * waiting for space to become available on the queue, should it already\r
- * be full. The call will return immediately if this is set to 0 and the\r
- * queue is full. The time is defined in tick periods so the constant\r
- * portTICK_PERIOD_MS should be used to convert to real time if this is required.\r
- *\r
- * @param xCopyPosition Can take the value queueSEND_TO_BACK to place the\r
- * item at the back of the queue, or queueSEND_TO_FRONT to place the item\r
- * at the front of the queue (for high priority messages).\r
- *\r
- * @return pdTRUE if the item was successfully posted, otherwise errQUEUE_FULL.\r
- *\r
- * Example usage:\r
- <pre>\r
- struct AMessage\r
- {\r
- char ucMessageID;\r
- char ucData[ 20 ];\r
- } xMessage;\r
-\r
- uint32_t ulVar = 10UL;\r
-\r
- void vATask( void *pvParameters )\r
- {\r
- QueueHandle_t xQueue1, xQueue2;\r
- struct AMessage *pxMessage;\r
-\r
- // Create a queue capable of containing 10 uint32_t values.\r
- xQueue1 = xQueueCreate( 10, sizeof( uint32_t ) );\r
-\r
- // Create a queue capable of containing 10 pointers to AMessage structures.\r
- // These should be passed by pointer as they contain a lot of data.\r
- xQueue2 = xQueueCreate( 10, sizeof( struct AMessage * ) );\r
-\r
- // ...\r
-\r
- if( xQueue1 != 0 )\r
- {\r
- // Send an uint32_t. Wait for 10 ticks for space to become\r
- // available if necessary.\r
- if( xQueueGenericSend( xQueue1, ( void * ) &ulVar, ( TickType_t ) 10, queueSEND_TO_BACK ) != pdPASS )\r
- {\r
- // Failed to post the message, even after 10 ticks.\r
- }\r
- }\r
-\r
- if( xQueue2 != 0 )\r
- {\r
- // Send a pointer to a struct AMessage object. Don't block if the\r
- // queue is already full.\r
- pxMessage = & xMessage;\r
- xQueueGenericSend( xQueue2, ( void * ) &pxMessage, ( TickType_t ) 0, queueSEND_TO_BACK );\r
- }\r
-\r
- // ... Rest of task code.\r
- }\r
- </pre>\r
- * \defgroup xQueueSend xQueueSend\r
- * \ingroup QueueManagement\r
- */\r
-BaseType_t xQueueGenericSend( QueueHandle_t xQueue, const void * const pvItemToQueue, TickType_t xTicksToWait, const BaseType_t xCopyPosition ) PRIVILEGED_FUNCTION;\r
-\r
-/**\r
- * queue. h\r
- * <pre>\r
- BaseType_t xQueuePeek(\r
- QueueHandle_t xQueue,\r
- void * const pvBuffer,\r
- TickType_t xTicksToWait\r
- );</pre>\r
- *\r
- * Receive an item from a queue without removing the item from the queue.\r
- * The item is received by copy so a buffer of adequate size must be\r
- * provided. The number of bytes copied into the buffer was defined when\r
- * the queue was created.\r
- *\r
- * Successfully received items remain on the queue so will be returned again\r
- * by the next call, or a call to xQueueReceive().\r
- *\r
- * This macro must not be used in an interrupt service routine. See\r
- * xQueuePeekFromISR() for an alternative that can be called from an interrupt\r
- * service routine.\r
- *\r
- * @param xQueue The handle to the queue from which the item is to be\r
- * received.\r
- *\r
- * @param pvBuffer Pointer to the buffer into which the received item will\r
- * be copied.\r
- *\r
- * @param xTicksToWait The maximum amount of time the task should block\r
- * waiting for an item to receive should the queue be empty at the time\r
- * of the call. The time is defined in tick periods so the constant\r
- * portTICK_PERIOD_MS should be used to convert to real time if this is required.\r
- * xQueuePeek() will return immediately if xTicksToWait is 0 and the queue\r
- * is empty.\r
- *\r
- * @return pdTRUE if an item was successfully received from the queue,\r
- * otherwise pdFALSE.\r
- *\r
- * Example usage:\r
- <pre>\r
- struct AMessage\r
- {\r
- char ucMessageID;\r
- char ucData[ 20 ];\r
- } xMessage;\r
-\r
- QueueHandle_t xQueue;\r
-\r
- // Task to create a queue and post a value.\r
- void vATask( void *pvParameters )\r
- {\r
- struct AMessage *pxMessage;\r
-\r
- // Create a queue capable of containing 10 pointers to AMessage structures.\r
- // These should be passed by pointer as they contain a lot of data.\r
- xQueue = xQueueCreate( 10, sizeof( struct AMessage * ) );\r
- if( xQueue == 0 )\r
- {\r
- // Failed to create the queue.\r
- }\r
-\r
- // ...\r
-\r
- // Send a pointer to a struct AMessage object. Don't block if the\r
- // queue is already full.\r
- pxMessage = & xMessage;\r
- xQueueSend( xQueue, ( void * ) &pxMessage, ( TickType_t ) 0 );\r
-\r
- // ... Rest of task code.\r
- }\r
-\r
- // Task to peek the data from the queue.\r
- void vADifferentTask( void *pvParameters )\r
- {\r
- struct AMessage *pxRxedMessage;\r
-\r
- if( xQueue != 0 )\r
- {\r
- // Peek a message on the created queue. Block for 10 ticks if a\r
- // message is not immediately available.\r
- if( xQueuePeek( xQueue, &( pxRxedMessage ), ( TickType_t ) 10 ) )\r
- {\r
- // pcRxedMessage now points to the struct AMessage variable posted\r
- // by vATask, but the item still remains on the queue.\r
- }\r
- }\r
-\r
- // ... Rest of task code.\r
- }\r
- </pre>\r
- * \defgroup xQueuePeek xQueuePeek\r
- * \ingroup QueueManagement\r
- */\r
-BaseType_t xQueuePeek( QueueHandle_t xQueue, void * const pvBuffer, TickType_t xTicksToWait ) PRIVILEGED_FUNCTION;\r
-\r
-/**\r
- * queue. h\r
- * <pre>\r
- BaseType_t xQueuePeekFromISR(\r
- QueueHandle_t xQueue,\r
- void *pvBuffer,\r
- );</pre>\r
- *\r
- * A version of xQueuePeek() that can be called from an interrupt service\r
- * routine (ISR).\r
- *\r
- * Receive an item from a queue without removing the item from the queue.\r
- * The item is received by copy so a buffer of adequate size must be\r
- * provided. The number of bytes copied into the buffer was defined when\r
- * the queue was created.\r
- *\r
- * Successfully received items remain on the queue so will be returned again\r
- * by the next call, or a call to xQueueReceive().\r
- *\r
- * @param xQueue The handle to the queue from which the item is to be\r
- * received.\r
- *\r
- * @param pvBuffer Pointer to the buffer into which the received item will\r
- * be copied.\r
- *\r
- * @return pdTRUE if an item was successfully received from the queue,\r
- * otherwise pdFALSE.\r
- *\r
- * \defgroup xQueuePeekFromISR xQueuePeekFromISR\r
- * \ingroup QueueManagement\r
- */\r
-BaseType_t xQueuePeekFromISR( QueueHandle_t xQueue, void * const pvBuffer ) PRIVILEGED_FUNCTION;\r
-\r
-/**\r
- * queue. h\r
- * <pre>\r
- BaseType_t xQueueReceive(\r
- QueueHandle_t xQueue,\r
- void *pvBuffer,\r
- TickType_t xTicksToWait\r
- );</pre>\r
- *\r
- * Receive an item from a queue. The item is received by copy so a buffer of\r
- * adequate size must be provided. The number of bytes copied into the buffer\r
- * was defined when the queue was created.\r
- *\r
- * Successfully received items are removed from the queue.\r
- *\r
- * This function must not be used in an interrupt service routine. See\r
- * xQueueReceiveFromISR for an alternative that can.\r
- *\r
- * @param xQueue The handle to the queue from which the item is to be\r
- * received.\r
- *\r
- * @param pvBuffer Pointer to the buffer into which the received item will\r
- * be copied.\r
- *\r
- * @param xTicksToWait The maximum amount of time the task should block\r
- * waiting for an item to receive should the queue be empty at the time\r
- * of the call. xQueueReceive() will return immediately if xTicksToWait\r
- * is zero and the queue is empty. The time is defined in tick periods so the\r
- * constant portTICK_PERIOD_MS should be used to convert to real time if this is\r
- * required.\r
- *\r
- * @return pdTRUE if an item was successfully received from the queue,\r
- * otherwise pdFALSE.\r
- *\r
- * Example usage:\r
- <pre>\r
- struct AMessage\r
- {\r
- char ucMessageID;\r
- char ucData[ 20 ];\r
- } xMessage;\r
-\r
- QueueHandle_t xQueue;\r
-\r
- // Task to create a queue and post a value.\r
- void vATask( void *pvParameters )\r
- {\r
- struct AMessage *pxMessage;\r
-\r
- // Create a queue capable of containing 10 pointers to AMessage structures.\r
- // These should be passed by pointer as they contain a lot of data.\r
- xQueue = xQueueCreate( 10, sizeof( struct AMessage * ) );\r
- if( xQueue == 0 )\r
- {\r
- // Failed to create the queue.\r
- }\r
-\r
- // ...\r
-\r
- // Send a pointer to a struct AMessage object. Don't block if the\r
- // queue is already full.\r
- pxMessage = & xMessage;\r
- xQueueSend( xQueue, ( void * ) &pxMessage, ( TickType_t ) 0 );\r
-\r
- // ... Rest of task code.\r
- }\r
-\r
- // Task to receive from the queue.\r
- void vADifferentTask( void *pvParameters )\r
- {\r
- struct AMessage *pxRxedMessage;\r
-\r
- if( xQueue != 0 )\r
- {\r
- // Receive a message on the created queue. Block for 10 ticks if a\r
- // message is not immediately available.\r
- if( xQueueReceive( xQueue, &( pxRxedMessage ), ( TickType_t ) 10 ) )\r
- {\r
- // pcRxedMessage now points to the struct AMessage variable posted\r
- // by vATask.\r
- }\r
- }\r
-\r
- // ... Rest of task code.\r
- }\r
- </pre>\r
- * \defgroup xQueueReceive xQueueReceive\r
- * \ingroup QueueManagement\r
- */\r
-BaseType_t xQueueReceive( QueueHandle_t xQueue, void * const pvBuffer, TickType_t xTicksToWait ) PRIVILEGED_FUNCTION;\r
-\r
-/**\r
- * queue. h\r
- * <pre>UBaseType_t uxQueueMessagesWaiting( const QueueHandle_t xQueue );</pre>\r
- *\r
- * Return the number of messages stored in a queue.\r
- *\r
- * @param xQueue A handle to the queue being queried.\r
- *\r
- * @return The number of messages available in the queue.\r
- *\r
- * \defgroup uxQueueMessagesWaiting uxQueueMessagesWaiting\r
- * \ingroup QueueManagement\r
- */\r
-UBaseType_t uxQueueMessagesWaiting( const QueueHandle_t xQueue ) PRIVILEGED_FUNCTION;\r
-\r
-/**\r
- * queue. h\r
- * <pre>UBaseType_t uxQueueSpacesAvailable( const QueueHandle_t xQueue );</pre>\r
- *\r
- * Return the number of free spaces available in a queue. This is equal to the\r
- * number of items that can be sent to the queue before the queue becomes full\r
- * if no items are removed.\r
- *\r
- * @param xQueue A handle to the queue being queried.\r
- *\r
- * @return The number of spaces available in the queue.\r
- *\r
- * \defgroup uxQueueMessagesWaiting uxQueueMessagesWaiting\r
- * \ingroup QueueManagement\r
- */\r
-UBaseType_t uxQueueSpacesAvailable( const QueueHandle_t xQueue ) PRIVILEGED_FUNCTION;\r
-\r
-/**\r
- * queue. h\r
- * <pre>void vQueueDelete( QueueHandle_t xQueue );</pre>\r
- *\r
- * Delete a queue - freeing all the memory allocated for storing of items\r
- * placed on the queue.\r
- *\r
- * @param xQueue A handle to the queue to be deleted.\r
- *\r
- * \defgroup vQueueDelete vQueueDelete\r
- * \ingroup QueueManagement\r
- */\r
-void vQueueDelete( QueueHandle_t xQueue ) PRIVILEGED_FUNCTION;\r
-\r
-/**\r
- * queue. h\r
- * <pre>\r
- BaseType_t xQueueSendToFrontFromISR(\r
- QueueHandle_t xQueue,\r
- const void *pvItemToQueue,\r
- BaseType_t *pxHigherPriorityTaskWoken\r
- );\r
- </pre>\r
- *\r
- * This is a macro that calls xQueueGenericSendFromISR().\r
- *\r
- * Post an item to the front of a queue. It is safe to use this macro from\r
- * within an interrupt service routine.\r
- *\r
- * Items are queued by copy not reference so it is preferable to only\r
- * queue small items, especially when called from an ISR. In most cases\r
- * it would be preferable to store a pointer to the item being queued.\r
- *\r
- * @param xQueue The handle to the queue on which the item is to be posted.\r
- *\r
- * @param pvItemToQueue A pointer to the item that is to be placed on the\r
- * queue. The size of the items the queue will hold was defined when the\r
- * queue was created, so this many bytes will be copied from pvItemToQueue\r
- * into the queue storage area.\r
- *\r
- * @param pxHigherPriorityTaskWoken xQueueSendToFrontFromISR() will set\r
- * *pxHigherPriorityTaskWoken to pdTRUE if sending to the queue caused a task\r
- * to unblock, and the unblocked task has a priority higher than the currently\r
- * running task. If xQueueSendToFromFromISR() sets this value to pdTRUE then\r
- * a context switch should be requested before the interrupt is exited.\r
- *\r
- * @return pdTRUE if the data was successfully sent to the queue, otherwise\r
- * errQUEUE_FULL.\r
- *\r
- * Example usage for buffered IO (where the ISR can obtain more than one value\r
- * per call):\r
- <pre>\r
- void vBufferISR( void )\r
- {\r
- char cIn;\r
- BaseType_t xHigherPrioritTaskWoken;\r
-\r
- // We have not woken a task at the start of the ISR.\r
- xHigherPriorityTaskWoken = pdFALSE;\r
-\r
- // Loop until the buffer is empty.\r
- do\r
- {\r
- // Obtain a byte from the buffer.\r
- cIn = portINPUT_BYTE( RX_REGISTER_ADDRESS );\r
-\r
- // Post the byte.\r
- xQueueSendToFrontFromISR( xRxQueue, &cIn, &xHigherPriorityTaskWoken );\r
-\r
- } while( portINPUT_BYTE( BUFFER_COUNT ) );\r
-\r
- // Now the buffer is empty we can switch context if necessary.\r
- if( xHigherPriorityTaskWoken )\r
- {\r
- taskYIELD ();\r
- }\r
- }\r
- </pre>\r
- *\r
- * \defgroup xQueueSendFromISR xQueueSendFromISR\r
- * \ingroup QueueManagement\r
- */\r
-#define xQueueSendToFrontFromISR( xQueue, pvItemToQueue, pxHigherPriorityTaskWoken ) xQueueGenericSendFromISR( ( xQueue ), ( pvItemToQueue ), ( pxHigherPriorityTaskWoken ), queueSEND_TO_FRONT )\r
-\r
-\r
-/**\r
- * queue. h\r
- * <pre>\r
- BaseType_t xQueueSendToBackFromISR(\r
- QueueHandle_t xQueue,\r
- const void *pvItemToQueue,\r
- BaseType_t *pxHigherPriorityTaskWoken\r
- );\r
- </pre>\r
- *\r
- * This is a macro that calls xQueueGenericSendFromISR().\r
- *\r
- * Post an item to the back of a queue. It is safe to use this macro from\r
- * within an interrupt service routine.\r
- *\r
- * Items are queued by copy not reference so it is preferable to only\r
- * queue small items, especially when called from an ISR. In most cases\r
- * it would be preferable to store a pointer to the item being queued.\r
- *\r
- * @param xQueue The handle to the queue on which the item is to be posted.\r
- *\r
- * @param pvItemToQueue A pointer to the item that is to be placed on the\r
- * queue. The size of the items the queue will hold was defined when the\r
- * queue was created, so this many bytes will be copied from pvItemToQueue\r
- * into the queue storage area.\r
- *\r
- * @param pxHigherPriorityTaskWoken xQueueSendToBackFromISR() will set\r
- * *pxHigherPriorityTaskWoken to pdTRUE if sending to the queue caused a task\r
- * to unblock, and the unblocked task has a priority higher than the currently\r
- * running task. If xQueueSendToBackFromISR() sets this value to pdTRUE then\r
- * a context switch should be requested before the interrupt is exited.\r
- *\r
- * @return pdTRUE if the data was successfully sent to the queue, otherwise\r
- * errQUEUE_FULL.\r
- *\r
- * Example usage for buffered IO (where the ISR can obtain more than one value\r
- * per call):\r
- <pre>\r
- void vBufferISR( void )\r
- {\r
- char cIn;\r
- BaseType_t xHigherPriorityTaskWoken;\r
-\r
- // We have not woken a task at the start of the ISR.\r
- xHigherPriorityTaskWoken = pdFALSE;\r
-\r
- // Loop until the buffer is empty.\r
- do\r
- {\r
- // Obtain a byte from the buffer.\r
- cIn = portINPUT_BYTE( RX_REGISTER_ADDRESS );\r
-\r
- // Post the byte.\r
- xQueueSendToBackFromISR( xRxQueue, &cIn, &xHigherPriorityTaskWoken );\r
-\r
- } while( portINPUT_BYTE( BUFFER_COUNT ) );\r
-\r
- // Now the buffer is empty we can switch context if necessary.\r
- if( xHigherPriorityTaskWoken )\r
- {\r
- taskYIELD ();\r
- }\r
- }\r
- </pre>\r
- *\r
- * \defgroup xQueueSendFromISR xQueueSendFromISR\r
- * \ingroup QueueManagement\r
- */\r
-#define xQueueSendToBackFromISR( xQueue, pvItemToQueue, pxHigherPriorityTaskWoken ) xQueueGenericSendFromISR( ( xQueue ), ( pvItemToQueue ), ( pxHigherPriorityTaskWoken ), queueSEND_TO_BACK )\r
-\r
-/**\r
- * queue. h\r
- * <pre>\r
- BaseType_t xQueueOverwriteFromISR(\r
- QueueHandle_t xQueue,\r
- const void * pvItemToQueue,\r
- BaseType_t *pxHigherPriorityTaskWoken\r
- );\r
- * </pre>\r
- *\r
- * A version of xQueueOverwrite() that can be used in an interrupt service\r
- * routine (ISR).\r
- *\r
- * Only for use with queues that can hold a single item - so the queue is either\r
- * empty or full.\r
- *\r
- * Post an item on a queue. If the queue is already full then overwrite the\r
- * value held in the queue. The item is queued by copy, not by reference.\r
- *\r
- * @param xQueue The handle to the queue on which the item is to be posted.\r
- *\r
- * @param pvItemToQueue A pointer to the item that is to be placed on the\r
- * queue. The size of the items the queue will hold was defined when the\r
- * queue was created, so this many bytes will be copied from pvItemToQueue\r
- * into the queue storage area.\r
- *\r
- * @param pxHigherPriorityTaskWoken xQueueOverwriteFromISR() will set\r
- * *pxHigherPriorityTaskWoken to pdTRUE if sending to the queue caused a task\r
- * to unblock, and the unblocked task has a priority higher than the currently\r
- * running task. If xQueueOverwriteFromISR() sets this value to pdTRUE then\r
- * a context switch should be requested before the interrupt is exited.\r
- *\r
- * @return xQueueOverwriteFromISR() is a macro that calls\r
- * xQueueGenericSendFromISR(), and therefore has the same return values as\r
- * xQueueSendToFrontFromISR(). However, pdPASS is the only value that can be\r
- * returned because xQueueOverwriteFromISR() will write to the queue even when\r
- * the queue is already full.\r
- *\r
- * Example usage:\r
- <pre>\r
-\r
- QueueHandle_t xQueue;\r
-\r
- void vFunction( void *pvParameters )\r
- {\r
- // Create a queue to hold one uint32_t value. It is strongly\r
- // recommended *not* to use xQueueOverwriteFromISR() on queues that can\r
- // contain more than one value, and doing so will trigger an assertion\r
- // if configASSERT() is defined.\r
- xQueue = xQueueCreate( 1, sizeof( uint32_t ) );\r
-}\r
-\r
-void vAnInterruptHandler( void )\r
-{\r
-// xHigherPriorityTaskWoken must be set to pdFALSE before it is used.\r
-BaseType_t xHigherPriorityTaskWoken = pdFALSE;\r
-uint32_t ulVarToSend, ulValReceived;\r
-\r
- // Write the value 10 to the queue using xQueueOverwriteFromISR().\r
- ulVarToSend = 10;\r
- xQueueOverwriteFromISR( xQueue, &ulVarToSend, &xHigherPriorityTaskWoken );\r
-\r
- // The queue is full, but calling xQueueOverwriteFromISR() again will still\r
- // pass because the value held in the queue will be overwritten with the\r
- // new value.\r
- ulVarToSend = 100;\r
- xQueueOverwriteFromISR( xQueue, &ulVarToSend, &xHigherPriorityTaskWoken );\r
-\r
- // Reading from the queue will now return 100.\r
-\r
- // ...\r
-\r
- if( xHigherPrioritytaskWoken == pdTRUE )\r
- {\r
- // Writing to the queue caused a task to unblock and the unblocked task\r
- // has a priority higher than or equal to the priority of the currently\r
- // executing task (the task this interrupt interrupted). Perform a context\r
- // switch so this interrupt returns directly to the unblocked task.\r
- portYIELD_FROM_ISR(); // or portEND_SWITCHING_ISR() depending on the port.\r
- }\r
-}\r
- </pre>\r
- * \defgroup xQueueOverwriteFromISR xQueueOverwriteFromISR\r
- * \ingroup QueueManagement\r
- */\r
-#define xQueueOverwriteFromISR( xQueue, pvItemToQueue, pxHigherPriorityTaskWoken ) xQueueGenericSendFromISR( ( xQueue ), ( pvItemToQueue ), ( pxHigherPriorityTaskWoken ), queueOVERWRITE )\r
-\r
-/**\r
- * queue. h\r
- * <pre>\r
- BaseType_t xQueueSendFromISR(\r
- QueueHandle_t xQueue,\r
- const void *pvItemToQueue,\r
- BaseType_t *pxHigherPriorityTaskWoken\r
- );\r
- </pre>\r
- *\r
- * This is a macro that calls xQueueGenericSendFromISR(). It is included\r
- * for backward compatibility with versions of FreeRTOS.org that did not\r
- * include the xQueueSendToBackFromISR() and xQueueSendToFrontFromISR()\r
- * macros.\r
- *\r
- * Post an item to the back of a queue. It is safe to use this function from\r
- * within an interrupt service routine.\r
- *\r
- * Items are queued by copy not reference so it is preferable to only\r
- * queue small items, especially when called from an ISR. In most cases\r
- * it would be preferable to store a pointer to the item being queued.\r
- *\r
- * @param xQueue The handle to the queue on which the item is to be posted.\r
- *\r
- * @param pvItemToQueue A pointer to the item that is to be placed on the\r
- * queue. The size of the items the queue will hold was defined when the\r
- * queue was created, so this many bytes will be copied from pvItemToQueue\r
- * into the queue storage area.\r
- *\r
- * @param pxHigherPriorityTaskWoken xQueueSendFromISR() will set\r
- * *pxHigherPriorityTaskWoken to pdTRUE if sending to the queue caused a task\r
- * to unblock, and the unblocked task has a priority higher than the currently\r
- * running task. If xQueueSendFromISR() sets this value to pdTRUE then\r
- * a context switch should be requested before the interrupt is exited.\r
- *\r
- * @return pdTRUE if the data was successfully sent to the queue, otherwise\r
- * errQUEUE_FULL.\r
- *\r
- * Example usage for buffered IO (where the ISR can obtain more than one value\r
- * per call):\r
- <pre>\r
- void vBufferISR( void )\r
- {\r
- char cIn;\r
- BaseType_t xHigherPriorityTaskWoken;\r
-\r
- // We have not woken a task at the start of the ISR.\r
- xHigherPriorityTaskWoken = pdFALSE;\r
-\r
- // Loop until the buffer is empty.\r
- do\r
- {\r
- // Obtain a byte from the buffer.\r
- cIn = portINPUT_BYTE( RX_REGISTER_ADDRESS );\r
-\r
- // Post the byte.\r
- xQueueSendFromISR( xRxQueue, &cIn, &xHigherPriorityTaskWoken );\r
-\r
- } while( portINPUT_BYTE( BUFFER_COUNT ) );\r
-\r
- // Now the buffer is empty we can switch context if necessary.\r
- if( xHigherPriorityTaskWoken )\r
- {\r
- // Actual macro used here is port specific.\r
- portYIELD_FROM_ISR ();\r
- }\r
- }\r
- </pre>\r
- *\r
- * \defgroup xQueueSendFromISR xQueueSendFromISR\r
- * \ingroup QueueManagement\r
- */\r
-#define xQueueSendFromISR( xQueue, pvItemToQueue, pxHigherPriorityTaskWoken ) xQueueGenericSendFromISR( ( xQueue ), ( pvItemToQueue ), ( pxHigherPriorityTaskWoken ), queueSEND_TO_BACK )\r
-\r
-/**\r
- * queue. h\r
- * <pre>\r
- BaseType_t xQueueGenericSendFromISR(\r
- QueueHandle_t xQueue,\r
- const void *pvItemToQueue,\r
- BaseType_t *pxHigherPriorityTaskWoken,\r
- BaseType_t xCopyPosition\r
- );\r
- </pre>\r
- *\r
- * It is preferred that the macros xQueueSendFromISR(),\r
- * xQueueSendToFrontFromISR() and xQueueSendToBackFromISR() be used in place\r
- * of calling this function directly. xQueueGiveFromISR() is an\r
- * equivalent for use by semaphores that don't actually copy any data.\r
- *\r
- * Post an item on a queue. It is safe to use this function from within an\r
- * interrupt service routine.\r
- *\r
- * Items are queued by copy not reference so it is preferable to only\r
- * queue small items, especially when called from an ISR. In most cases\r
- * it would be preferable to store a pointer to the item being queued.\r
- *\r
- * @param xQueue The handle to the queue on which the item is to be posted.\r
- *\r
- * @param pvItemToQueue A pointer to the item that is to be placed on the\r
- * queue. The size of the items the queue will hold was defined when the\r
- * queue was created, so this many bytes will be copied from pvItemToQueue\r
- * into the queue storage area.\r
- *\r
- * @param pxHigherPriorityTaskWoken xQueueGenericSendFromISR() will set\r
- * *pxHigherPriorityTaskWoken to pdTRUE if sending to the queue caused a task\r
- * to unblock, and the unblocked task has a priority higher than the currently\r
- * running task. If xQueueGenericSendFromISR() sets this value to pdTRUE then\r
- * a context switch should be requested before the interrupt is exited.\r
- *\r
- * @param xCopyPosition Can take the value queueSEND_TO_BACK to place the\r
- * item at the back of the queue, or queueSEND_TO_FRONT to place the item\r
- * at the front of the queue (for high priority messages).\r
- *\r
- * @return pdTRUE if the data was successfully sent to the queue, otherwise\r
- * errQUEUE_FULL.\r
- *\r
- * Example usage for buffered IO (where the ISR can obtain more than one value\r
- * per call):\r
- <pre>\r
- void vBufferISR( void )\r
- {\r
- char cIn;\r
- BaseType_t xHigherPriorityTaskWokenByPost;\r
-\r
- // We have not woken a task at the start of the ISR.\r
- xHigherPriorityTaskWokenByPost = pdFALSE;\r
-\r
- // Loop until the buffer is empty.\r
- do\r
- {\r
- // Obtain a byte from the buffer.\r
- cIn = portINPUT_BYTE( RX_REGISTER_ADDRESS );\r
-\r
- // Post each byte.\r
- xQueueGenericSendFromISR( xRxQueue, &cIn, &xHigherPriorityTaskWokenByPost, queueSEND_TO_BACK );\r
-\r
- } while( portINPUT_BYTE( BUFFER_COUNT ) );\r
-\r
- // Now the buffer is empty we can switch context if necessary. Note that the\r
- // name of the yield function required is port specific.\r
- if( xHigherPriorityTaskWokenByPost )\r
- {\r
- taskYIELD_YIELD_FROM_ISR();\r
- }\r
- }\r
- </pre>\r
- *\r
- * \defgroup xQueueSendFromISR xQueueSendFromISR\r
- * \ingroup QueueManagement\r
- */\r
-BaseType_t xQueueGenericSendFromISR( QueueHandle_t xQueue, const void * const pvItemToQueue, BaseType_t * const pxHigherPriorityTaskWoken, const BaseType_t xCopyPosition ) PRIVILEGED_FUNCTION;\r
-BaseType_t xQueueGiveFromISR( QueueHandle_t xQueue, BaseType_t * const pxHigherPriorityTaskWoken ) PRIVILEGED_FUNCTION;\r
-\r
-/**\r
- * queue. h\r
- * <pre>\r
- BaseType_t xQueueReceiveFromISR(\r
- QueueHandle_t xQueue,\r
- void *pvBuffer,\r
- BaseType_t *pxTaskWoken\r
- );\r
- * </pre>\r
- *\r
- * Receive an item from a queue. It is safe to use this function from within an\r
- * interrupt service routine.\r
- *\r
- * @param xQueue The handle to the queue from which the item is to be\r
- * received.\r
- *\r
- * @param pvBuffer Pointer to the buffer into which the received item will\r
- * be copied.\r
- *\r
- * @param pxTaskWoken A task may be blocked waiting for space to become\r
- * available on the queue. If xQueueReceiveFromISR causes such a task to\r
- * unblock *pxTaskWoken will get set to pdTRUE, otherwise *pxTaskWoken will\r
- * remain unchanged.\r
- *\r
- * @return pdTRUE if an item was successfully received from the queue,\r
- * otherwise pdFALSE.\r
- *\r
- * Example usage:\r
- <pre>\r
-\r
- QueueHandle_t xQueue;\r
-\r
- // Function to create a queue and post some values.\r
- void vAFunction( void *pvParameters )\r
- {\r
- char cValueToPost;\r
- const TickType_t xTicksToWait = ( TickType_t )0xff;\r
-\r
- // Create a queue capable of containing 10 characters.\r
- xQueue = xQueueCreate( 10, sizeof( char ) );\r
- if( xQueue == 0 )\r
- {\r
- // Failed to create the queue.\r
- }\r
-\r
- // ...\r
-\r
- // Post some characters that will be used within an ISR. If the queue\r
- // is full then this task will block for xTicksToWait ticks.\r
- cValueToPost = 'a';\r
- xQueueSend( xQueue, ( void * ) &cValueToPost, xTicksToWait );\r
- cValueToPost = 'b';\r
- xQueueSend( xQueue, ( void * ) &cValueToPost, xTicksToWait );\r
-\r
- // ... keep posting characters ... this task may block when the queue\r
- // becomes full.\r
-\r
- cValueToPost = 'c';\r
- xQueueSend( xQueue, ( void * ) &cValueToPost, xTicksToWait );\r
- }\r
-\r
- // ISR that outputs all the characters received on the queue.\r
- void vISR_Routine( void )\r
- {\r
- BaseType_t xTaskWokenByReceive = pdFALSE;\r
- char cRxedChar;\r
-\r
- while( xQueueReceiveFromISR( xQueue, ( void * ) &cRxedChar, &xTaskWokenByReceive) )\r
- {\r
- // A character was received. Output the character now.\r
- vOutputCharacter( cRxedChar );\r
-\r
- // If removing the character from the queue woke the task that was\r
- // posting onto the queue cTaskWokenByReceive will have been set to\r
- // pdTRUE. No matter how many times this loop iterates only one\r
- // task will be woken.\r
- }\r
-\r
- if( cTaskWokenByPost != ( char ) pdFALSE;\r
- {\r
- taskYIELD ();\r
- }\r
- }\r
- </pre>\r
- * \defgroup xQueueReceiveFromISR xQueueReceiveFromISR\r
- * \ingroup QueueManagement\r
- */\r
-BaseType_t xQueueReceiveFromISR( QueueHandle_t xQueue, void * const pvBuffer, BaseType_t * const pxHigherPriorityTaskWoken ) PRIVILEGED_FUNCTION;\r
-\r
-/*\r
- * Utilities to query queues that are safe to use from an ISR. These utilities\r
- * should be used only from witin an ISR, or within a critical section.\r
- */\r
-BaseType_t xQueueIsQueueEmptyFromISR( const QueueHandle_t xQueue ) PRIVILEGED_FUNCTION;\r
-BaseType_t xQueueIsQueueFullFromISR( const QueueHandle_t xQueue ) PRIVILEGED_FUNCTION;\r
-UBaseType_t uxQueueMessagesWaitingFromISR( const QueueHandle_t xQueue ) PRIVILEGED_FUNCTION;\r
-\r
-/*\r
- * The functions defined above are for passing data to and from tasks. The\r
- * functions below are the equivalents for passing data to and from\r
- * co-routines.\r
- *\r
- * These functions are called from the co-routine macro implementation and\r
- * should not be called directly from application code. Instead use the macro\r
- * wrappers defined within croutine.h.\r
- */\r
-BaseType_t xQueueCRSendFromISR( QueueHandle_t xQueue, const void *pvItemToQueue, BaseType_t xCoRoutinePreviouslyWoken );\r
-BaseType_t xQueueCRReceiveFromISR( QueueHandle_t xQueue, void *pvBuffer, BaseType_t *pxTaskWoken );\r
-BaseType_t xQueueCRSend( QueueHandle_t xQueue, const void *pvItemToQueue, TickType_t xTicksToWait );\r
-BaseType_t xQueueCRReceive( QueueHandle_t xQueue, void *pvBuffer, TickType_t xTicksToWait );\r
-\r
-/*\r
- * For internal use only. Use xSemaphoreCreateMutex(),\r
- * xSemaphoreCreateCounting() or xSemaphoreGetMutexHolder() instead of calling\r
- * these functions directly.\r
- */\r
-QueueHandle_t xQueueCreateMutex( const uint8_t ucQueueType ) PRIVILEGED_FUNCTION;\r
-QueueHandle_t xQueueCreateMutexStatic( const uint8_t ucQueueType, StaticQueue_t *pxStaticQueue ) PRIVILEGED_FUNCTION;\r
-QueueHandle_t xQueueCreateCountingSemaphore( const UBaseType_t uxMaxCount, const UBaseType_t uxInitialCount ) PRIVILEGED_FUNCTION;\r
-QueueHandle_t xQueueCreateCountingSemaphoreStatic( const UBaseType_t uxMaxCount, const UBaseType_t uxInitialCount, StaticQueue_t *pxStaticQueue ) PRIVILEGED_FUNCTION;\r
-BaseType_t xQueueSemaphoreTake( QueueHandle_t xQueue, TickType_t xTicksToWait ) PRIVILEGED_FUNCTION;\r
-void* xQueueGetMutexHolder( QueueHandle_t xSemaphore ) PRIVILEGED_FUNCTION;\r
-void* xQueueGetMutexHolderFromISR( QueueHandle_t xSemaphore ) PRIVILEGED_FUNCTION;\r
-\r
-/*\r
- * For internal use only. Use xSemaphoreTakeMutexRecursive() or\r
- * xSemaphoreGiveMutexRecursive() instead of calling these functions directly.\r
- */\r
-BaseType_t xQueueTakeMutexRecursive( QueueHandle_t xMutex, TickType_t xTicksToWait ) PRIVILEGED_FUNCTION;\r
-BaseType_t xQueueGiveMutexRecursive( QueueHandle_t pxMutex ) PRIVILEGED_FUNCTION;\r
-\r
-/*\r
- * Reset a queue back to its original empty state. The return value is now\r
- * obsolete and is always set to pdPASS.\r
- */\r
-#define xQueueReset( xQueue ) xQueueGenericReset( xQueue, pdFALSE )\r
-\r
-/*\r
- * The registry is provided as a means for kernel aware debuggers to\r
- * locate queues, semaphores and mutexes. Call vQueueAddToRegistry() add\r
- * a queue, semaphore or mutex handle to the registry if you want the handle\r
- * to be available to a kernel aware debugger. If you are not using a kernel\r
- * aware debugger then this function can be ignored.\r
- *\r
- * configQUEUE_REGISTRY_SIZE defines the maximum number of handles the\r
- * registry can hold. configQUEUE_REGISTRY_SIZE must be greater than 0\r
- * within FreeRTOSConfig.h for the registry to be available. Its value\r
- * does not effect the number of queues, semaphores and mutexes that can be\r
- * created - just the number that the registry can hold.\r
- *\r
- * @param xQueue The handle of the queue being added to the registry. This\r
- * is the handle returned by a call to xQueueCreate(). Semaphore and mutex\r
- * handles can also be passed in here.\r
- *\r
- * @param pcName The name to be associated with the handle. This is the\r
- * name that the kernel aware debugger will display. The queue registry only\r
- * stores a pointer to the string - so the string must be persistent (global or\r
- * preferably in ROM/Flash), not on the stack.\r
- */\r
-#if( configQUEUE_REGISTRY_SIZE > 0 )\r
- void vQueueAddToRegistry( QueueHandle_t xQueue, const char *pcName ) PRIVILEGED_FUNCTION; /*lint !e971 Unqualified char types are allowed for strings and single characters only. */\r
-#endif\r
-\r
-/*\r
- * The registry is provided as a means for kernel aware debuggers to\r
- * locate queues, semaphores and mutexes. Call vQueueAddToRegistry() add\r
- * a queue, semaphore or mutex handle to the registry if you want the handle\r
- * to be available to a kernel aware debugger, and vQueueUnregisterQueue() to\r
- * remove the queue, semaphore or mutex from the register. If you are not using\r
- * a kernel aware debugger then this function can be ignored.\r
- *\r
- * @param xQueue The handle of the queue being removed from the registry.\r
- */\r
-#if( configQUEUE_REGISTRY_SIZE > 0 )\r
- void vQueueUnregisterQueue( QueueHandle_t xQueue ) PRIVILEGED_FUNCTION;\r
-#endif\r
-\r
-/*\r
- * The queue registry is provided as a means for kernel aware debuggers to\r
- * locate queues, semaphores and mutexes. Call pcQueueGetName() to look\r
- * up and return the name of a queue in the queue registry from the queue's\r
- * handle.\r
- *\r
- * @param xQueue The handle of the queue the name of which will be returned.\r
- * @return If the queue is in the registry then a pointer to the name of the\r
- * queue is returned. If the queue is not in the registry then NULL is\r
- * returned.\r
- */\r
-#if( configQUEUE_REGISTRY_SIZE > 0 )\r
- const char *pcQueueGetName( QueueHandle_t xQueue ) PRIVILEGED_FUNCTION; /*lint !e971 Unqualified char types are allowed for strings and single characters only. */\r
-#endif\r
-\r
-/*\r
- * Generic version of the function used to creaet a queue using dynamic memory\r
- * allocation. This is called by other functions and macros that create other\r
- * RTOS objects that use the queue structure as their base.\r
- */\r
-#if( configSUPPORT_DYNAMIC_ALLOCATION == 1 )\r
- QueueHandle_t xQueueGenericCreate( const UBaseType_t uxQueueLength, const UBaseType_t uxItemSize, const uint8_t ucQueueType ) PRIVILEGED_FUNCTION;\r
-#endif\r
-\r
-/*\r
- * Generic version of the function used to creaet a queue using dynamic memory\r
- * allocation. This is called by other functions and macros that create other\r
- * RTOS objects that use the queue structure as their base.\r
- */\r
-#if( configSUPPORT_STATIC_ALLOCATION == 1 )\r
- QueueHandle_t xQueueGenericCreateStatic( const UBaseType_t uxQueueLength, const UBaseType_t uxItemSize, uint8_t *pucQueueStorage, StaticQueue_t *pxStaticQueue, const uint8_t ucQueueType ) PRIVILEGED_FUNCTION;\r
-#endif\r
-\r
-/*\r
- * Queue sets provide a mechanism to allow a task to block (pend) on a read\r
- * operation from multiple queues or semaphores simultaneously.\r
- *\r
- * See FreeRTOS/Source/Demo/Common/Minimal/QueueSet.c for an example using this\r
- * function.\r
- *\r
- * A queue set must be explicitly created using a call to xQueueCreateSet()\r
- * before it can be used. Once created, standard FreeRTOS queues and semaphores\r
- * can be added to the set using calls to xQueueAddToSet().\r
- * xQueueSelectFromSet() is then used to determine which, if any, of the queues\r
- * or semaphores contained in the set is in a state where a queue read or\r
- * semaphore take operation would be successful.\r
- *\r
- * Note 1: See the documentation on http://wwwFreeRTOS.org/RTOS-queue-sets.html\r
- * for reasons why queue sets are very rarely needed in practice as there are\r
- * simpler methods of blocking on multiple objects.\r
- *\r
- * Note 2: Blocking on a queue set that contains a mutex will not cause the\r
- * mutex holder to inherit the priority of the blocked task.\r
- *\r
- * Note 3: An additional 4 bytes of RAM is required for each space in a every\r
- * queue added to a queue set. Therefore counting semaphores that have a high\r
- * maximum count value should not be added to a queue set.\r
- *\r
- * Note 4: A receive (in the case of a queue) or take (in the case of a\r
- * semaphore) operation must not be performed on a member of a queue set unless\r
- * a call to xQueueSelectFromSet() has first returned a handle to that set member.\r
- *\r
- * @param uxEventQueueLength Queue sets store events that occur on\r
- * the queues and semaphores contained in the set. uxEventQueueLength specifies\r
- * the maximum number of events that can be queued at once. To be absolutely\r
- * certain that events are not lost uxEventQueueLength should be set to the\r
- * total sum of the length of the queues added to the set, where binary\r
- * semaphores and mutexes have a length of 1, and counting semaphores have a\r
- * length set by their maximum count value. Examples:\r
- * + If a queue set is to hold a queue of length 5, another queue of length 12,\r
- * and a binary semaphore, then uxEventQueueLength should be set to\r
- * (5 + 12 + 1), or 18.\r
- * + If a queue set is to hold three binary semaphores then uxEventQueueLength\r
- * should be set to (1 + 1 + 1 ), or 3.\r
- * + If a queue set is to hold a counting semaphore that has a maximum count of\r
- * 5, and a counting semaphore that has a maximum count of 3, then\r
- * uxEventQueueLength should be set to (5 + 3), or 8.\r
- *\r
- * @return If the queue set is created successfully then a handle to the created\r
- * queue set is returned. Otherwise NULL is returned.\r
- */\r
-QueueSetHandle_t xQueueCreateSet( const UBaseType_t uxEventQueueLength ) PRIVILEGED_FUNCTION;\r
-\r
-/*\r
- * Adds a queue or semaphore to a queue set that was previously created by a\r
- * call to xQueueCreateSet().\r
- *\r
- * See FreeRTOS/Source/Demo/Common/Minimal/QueueSet.c for an example using this\r
- * function.\r
- *\r
- * Note 1: A receive (in the case of a queue) or take (in the case of a\r
- * semaphore) operation must not be performed on a member of a queue set unless\r
- * a call to xQueueSelectFromSet() has first returned a handle to that set member.\r
- *\r
- * @param xQueueOrSemaphore The handle of the queue or semaphore being added to\r
- * the queue set (cast to an QueueSetMemberHandle_t type).\r
- *\r
- * @param xQueueSet The handle of the queue set to which the queue or semaphore\r
- * is being added.\r
- *\r
- * @return If the queue or semaphore was successfully added to the queue set\r
- * then pdPASS is returned. If the queue could not be successfully added to the\r
- * queue set because it is already a member of a different queue set then pdFAIL\r
- * is returned.\r
- */\r
-BaseType_t xQueueAddToSet( QueueSetMemberHandle_t xQueueOrSemaphore, QueueSetHandle_t xQueueSet ) PRIVILEGED_FUNCTION;\r
-\r
-/*\r
- * Removes a queue or semaphore from a queue set. A queue or semaphore can only\r
- * be removed from a set if the queue or semaphore is empty.\r
- *\r
- * See FreeRTOS/Source/Demo/Common/Minimal/QueueSet.c for an example using this\r
- * function.\r
- *\r
- * @param xQueueOrSemaphore The handle of the queue or semaphore being removed\r
- * from the queue set (cast to an QueueSetMemberHandle_t type).\r
- *\r
- * @param xQueueSet The handle of the queue set in which the queue or semaphore\r
- * is included.\r
- *\r
- * @return If the queue or semaphore was successfully removed from the queue set\r
- * then pdPASS is returned. If the queue was not in the queue set, or the\r
- * queue (or semaphore) was not empty, then pdFAIL is returned.\r
- */\r
-BaseType_t xQueueRemoveFromSet( QueueSetMemberHandle_t xQueueOrSemaphore, QueueSetHandle_t xQueueSet ) PRIVILEGED_FUNCTION;\r
-\r
-/*\r
- * xQueueSelectFromSet() selects from the members of a queue set a queue or\r
- * semaphore that either contains data (in the case of a queue) or is available\r
- * to take (in the case of a semaphore). xQueueSelectFromSet() effectively\r
- * allows a task to block (pend) on a read operation on all the queues and\r
- * semaphores in a queue set simultaneously.\r
- *\r
- * See FreeRTOS/Source/Demo/Common/Minimal/QueueSet.c for an example using this\r
- * function.\r
- *\r
- * Note 1: See the documentation on http://wwwFreeRTOS.org/RTOS-queue-sets.html\r
- * for reasons why queue sets are very rarely needed in practice as there are\r
- * simpler methods of blocking on multiple objects.\r
- *\r
- * Note 2: Blocking on a queue set that contains a mutex will not cause the\r
- * mutex holder to inherit the priority of the blocked task.\r
- *\r
- * Note 3: A receive (in the case of a queue) or take (in the case of a\r
- * semaphore) operation must not be performed on a member of a queue set unless\r
- * a call to xQueueSelectFromSet() has first returned a handle to that set member.\r
- *\r
- * @param xQueueSet The queue set on which the task will (potentially) block.\r
- *\r
- * @param xTicksToWait The maximum time, in ticks, that the calling task will\r
- * remain in the Blocked state (with other tasks executing) to wait for a member\r
- * of the queue set to be ready for a successful queue read or semaphore take\r
- * operation.\r
- *\r
- * @return xQueueSelectFromSet() will return the handle of a queue (cast to\r
- * a QueueSetMemberHandle_t type) contained in the queue set that contains data,\r
- * or the handle of a semaphore (cast to a QueueSetMemberHandle_t type) contained\r
- * in the queue set that is available, or NULL if no such queue or semaphore\r
- * exists before before the specified block time expires.\r
- */\r
-QueueSetMemberHandle_t xQueueSelectFromSet( QueueSetHandle_t xQueueSet, const TickType_t xTicksToWait ) PRIVILEGED_FUNCTION;\r
-\r
-/*\r
- * A version of xQueueSelectFromSet() that can be used from an ISR.\r
- */\r
-QueueSetMemberHandle_t xQueueSelectFromSetFromISR( QueueSetHandle_t xQueueSet ) PRIVILEGED_FUNCTION;\r
-\r
-/* Not public API functions. */\r
-void vQueueWaitForMessageRestricted( QueueHandle_t xQueue, TickType_t xTicksToWait, const BaseType_t xWaitIndefinitely ) PRIVILEGED_FUNCTION;\r
-BaseType_t xQueueGenericReset( QueueHandle_t xQueue, BaseType_t xNewQueue ) PRIVILEGED_FUNCTION;\r
-void vQueueSetQueueNumber( QueueHandle_t xQueue, UBaseType_t uxQueueNumber ) PRIVILEGED_FUNCTION;\r
-UBaseType_t uxQueueGetQueueNumber( QueueHandle_t xQueue ) PRIVILEGED_FUNCTION;\r
-uint8_t ucQueueGetQueueType( QueueHandle_t xQueue ) PRIVILEGED_FUNCTION;\r
-\r
-\r
-#ifdef __cplusplus\r
-}\r
-#endif\r
-\r
-#endif /* QUEUE_H */\r
-\r
+++ /dev/null
-/*\r
- * FreeRTOS Kernel V10.0.1\r
- * Copyright (C) 2017 Amazon.com, Inc. or its affiliates. All Rights Reserved.\r
- *\r
- * Permission is hereby granted, free of charge, to any person obtaining a copy of\r
- * this software and associated documentation files (the "Software"), to deal in\r
- * the Software without restriction, including without limitation the rights to\r
- * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of\r
- * the Software, and to permit persons to whom the Software is furnished to do so,\r
- * subject to the following conditions:\r
- *\r
- * The above copyright notice and this permission notice shall be included in all\r
- * copies or substantial portions of the Software.\r
- *\r
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\r
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS\r
- * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR\r
- * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER\r
- * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN\r
- * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\r
- *\r
- * http://www.FreeRTOS.org\r
- * http://aws.amazon.com/freertos\r
- *\r
- * 1 tab == 4 spaces!\r
- */\r
-\r
-#ifndef SEMAPHORE_H\r
-#define SEMAPHORE_H\r
-\r
-#ifndef INC_FREERTOS_H\r
- #error "include FreeRTOS.h" must appear in source files before "include semphr.h"\r
-#endif\r
-\r
-#include "queue.h"\r
-\r
-typedef QueueHandle_t SemaphoreHandle_t;\r
-\r
-#define semBINARY_SEMAPHORE_QUEUE_LENGTH ( ( uint8_t ) 1U )\r
-#define semSEMAPHORE_QUEUE_ITEM_LENGTH ( ( uint8_t ) 0U )\r
-#define semGIVE_BLOCK_TIME ( ( TickType_t ) 0U )\r
-\r
-\r
-/**\r
- * semphr. h\r
- * <pre>vSemaphoreCreateBinary( SemaphoreHandle_t xSemaphore )</pre>\r
- *\r
- * In many usage scenarios it is faster and more memory efficient to use a\r
- * direct to task notification in place of a binary semaphore!\r
- * http://www.freertos.org/RTOS-task-notifications.html\r
- *\r
- * This old vSemaphoreCreateBinary() macro is now deprecated in favour of the\r
- * xSemaphoreCreateBinary() function. Note that binary semaphores created using\r
- * the vSemaphoreCreateBinary() macro are created in a state such that the\r
- * first call to 'take' the semaphore would pass, whereas binary semaphores\r
- * created using xSemaphoreCreateBinary() are created in a state such that the\r
- * the semaphore must first be 'given' before it can be 'taken'.\r
- *\r
- * <i>Macro</i> that implements a semaphore by using the existing queue mechanism.\r
- * The queue length is 1 as this is a binary semaphore. The data size is 0\r
- * as we don't want to actually store any data - we just want to know if the\r
- * queue is empty or full.\r
- *\r
- * This type of semaphore can be used for pure synchronisation between tasks or\r
- * between an interrupt and a task. The semaphore need not be given back once\r
- * obtained, so one task/interrupt can continuously 'give' the semaphore while\r
- * another continuously 'takes' the semaphore. For this reason this type of\r
- * semaphore does not use a priority inheritance mechanism. For an alternative\r
- * that does use priority inheritance see xSemaphoreCreateMutex().\r
- *\r
- * @param xSemaphore Handle to the created semaphore. Should be of type SemaphoreHandle_t.\r
- *\r
- * Example usage:\r
- <pre>\r
- SemaphoreHandle_t xSemaphore = NULL;\r
-\r
- void vATask( void * pvParameters )\r
- {\r
- // Semaphore cannot be used before a call to vSemaphoreCreateBinary ().\r
- // This is a macro so pass the variable in directly.\r
- vSemaphoreCreateBinary( xSemaphore );\r
-\r
- if( xSemaphore != NULL )\r
- {\r
- // The semaphore was created successfully.\r
- // The semaphore can now be used.\r
- }\r
- }\r
- </pre>\r
- * \defgroup vSemaphoreCreateBinary vSemaphoreCreateBinary\r
- * \ingroup Semaphores\r
- */\r
-#if( configSUPPORT_DYNAMIC_ALLOCATION == 1 )\r
- #define vSemaphoreCreateBinary( xSemaphore ) \\r
- { \\r
- ( xSemaphore ) = xQueueGenericCreate( ( UBaseType_t ) 1, semSEMAPHORE_QUEUE_ITEM_LENGTH, queueQUEUE_TYPE_BINARY_SEMAPHORE ); \\r
- if( ( xSemaphore ) != NULL ) \\r
- { \\r
- ( void ) xSemaphoreGive( ( xSemaphore ) ); \\r
- } \\r
- }\r
-#endif\r
-\r
-/**\r
- * semphr. h\r
- * <pre>SemaphoreHandle_t xSemaphoreCreateBinary( void )</pre>\r
- *\r
- * Creates a new binary semaphore instance, and returns a handle by which the\r
- * new semaphore can be referenced.\r
- *\r
- * In many usage scenarios it is faster and more memory efficient to use a\r
- * direct to task notification in place of a binary semaphore!\r
- * http://www.freertos.org/RTOS-task-notifications.html\r
- *\r
- * Internally, within the FreeRTOS implementation, binary semaphores use a block\r
- * of memory, in which the semaphore structure is stored. If a binary semaphore\r
- * is created using xSemaphoreCreateBinary() then the required memory is\r
- * automatically dynamically allocated inside the xSemaphoreCreateBinary()\r
- * function. (see http://www.freertos.org/a00111.html). If a binary semaphore\r
- * is created using xSemaphoreCreateBinaryStatic() then the application writer\r
- * must provide the memory. xSemaphoreCreateBinaryStatic() therefore allows a\r
- * binary semaphore to be created without using any dynamic memory allocation.\r
- *\r
- * The old vSemaphoreCreateBinary() macro is now deprecated in favour of this\r
- * xSemaphoreCreateBinary() function. Note that binary semaphores created using\r
- * the vSemaphoreCreateBinary() macro are created in a state such that the\r
- * first call to 'take' the semaphore would pass, whereas binary semaphores\r
- * created using xSemaphoreCreateBinary() are created in a state such that the\r
- * the semaphore must first be 'given' before it can be 'taken'.\r
- *\r
- * This type of semaphore can be used for pure synchronisation between tasks or\r
- * between an interrupt and a task. The semaphore need not be given back once\r
- * obtained, so one task/interrupt can continuously 'give' the semaphore while\r
- * another continuously 'takes' the semaphore. For this reason this type of\r
- * semaphore does not use a priority inheritance mechanism. For an alternative\r
- * that does use priority inheritance see xSemaphoreCreateMutex().\r
- *\r
- * @return Handle to the created semaphore, or NULL if the memory required to\r
- * hold the semaphore's data structures could not be allocated.\r
- *\r
- * Example usage:\r
- <pre>\r
- SemaphoreHandle_t xSemaphore = NULL;\r
-\r
- void vATask( void * pvParameters )\r
- {\r
- // Semaphore cannot be used before a call to xSemaphoreCreateBinary().\r
- // This is a macro so pass the variable in directly.\r
- xSemaphore = xSemaphoreCreateBinary();\r
-\r
- if( xSemaphore != NULL )\r
- {\r
- // The semaphore was created successfully.\r
- // The semaphore can now be used.\r
- }\r
- }\r
- </pre>\r
- * \defgroup xSemaphoreCreateBinary xSemaphoreCreateBinary\r
- * \ingroup Semaphores\r
- */\r
-#if( configSUPPORT_DYNAMIC_ALLOCATION == 1 )\r
- #define xSemaphoreCreateBinary() xQueueGenericCreate( ( UBaseType_t ) 1, semSEMAPHORE_QUEUE_ITEM_LENGTH, queueQUEUE_TYPE_BINARY_SEMAPHORE )\r
-#endif\r
-\r
-/**\r
- * semphr. h\r
- * <pre>SemaphoreHandle_t xSemaphoreCreateBinaryStatic( StaticSemaphore_t *pxSemaphoreBuffer )</pre>\r
- *\r
- * Creates a new binary semaphore instance, and returns a handle by which the\r
- * new semaphore can be referenced.\r
- *\r
- * NOTE: In many usage scenarios it is faster and more memory efficient to use a\r
- * direct to task notification in place of a binary semaphore!\r
- * http://www.freertos.org/RTOS-task-notifications.html\r
- *\r
- * Internally, within the FreeRTOS implementation, binary semaphores use a block\r
- * of memory, in which the semaphore structure is stored. If a binary semaphore\r
- * is created using xSemaphoreCreateBinary() then the required memory is\r
- * automatically dynamically allocated inside the xSemaphoreCreateBinary()\r
- * function. (see http://www.freertos.org/a00111.html). If a binary semaphore\r
- * is created using xSemaphoreCreateBinaryStatic() then the application writer\r
- * must provide the memory. xSemaphoreCreateBinaryStatic() therefore allows a\r
- * binary semaphore to be created without using any dynamic memory allocation.\r
- *\r
- * This type of semaphore can be used for pure synchronisation between tasks or\r
- * between an interrupt and a task. The semaphore need not be given back once\r
- * obtained, so one task/interrupt can continuously 'give' the semaphore while\r
- * another continuously 'takes' the semaphore. For this reason this type of\r
- * semaphore does not use a priority inheritance mechanism. For an alternative\r
- * that does use priority inheritance see xSemaphoreCreateMutex().\r
- *\r
- * @param pxSemaphoreBuffer Must point to a variable of type StaticSemaphore_t,\r
- * which will then be used to hold the semaphore's data structure, removing the\r
- * need for the memory to be allocated dynamically.\r
- *\r
- * @return If the semaphore is created then a handle to the created semaphore is\r
- * returned. If pxSemaphoreBuffer is NULL then NULL is returned.\r
- *\r
- * Example usage:\r
- <pre>\r
- SemaphoreHandle_t xSemaphore = NULL;\r
- StaticSemaphore_t xSemaphoreBuffer;\r
-\r
- void vATask( void * pvParameters )\r
- {\r
- // Semaphore cannot be used before a call to xSemaphoreCreateBinary().\r
- // The semaphore's data structures will be placed in the xSemaphoreBuffer\r
- // variable, the address of which is passed into the function. The\r
- // function's parameter is not NULL, so the function will not attempt any\r
- // dynamic memory allocation, and therefore the function will not return\r
- // return NULL.\r
- xSemaphore = xSemaphoreCreateBinary( &xSemaphoreBuffer );\r
-\r
- // Rest of task code goes here.\r
- }\r
- </pre>\r
- * \defgroup xSemaphoreCreateBinaryStatic xSemaphoreCreateBinaryStatic\r
- * \ingroup Semaphores\r
- */\r
-#if( configSUPPORT_STATIC_ALLOCATION == 1 )\r
- #define xSemaphoreCreateBinaryStatic( pxStaticSemaphore ) xQueueGenericCreateStatic( ( UBaseType_t ) 1, semSEMAPHORE_QUEUE_ITEM_LENGTH, NULL, pxStaticSemaphore, queueQUEUE_TYPE_BINARY_SEMAPHORE )\r
-#endif /* configSUPPORT_STATIC_ALLOCATION */\r
-\r
-/**\r
- * semphr. h\r
- * <pre>xSemaphoreTake(\r
- * SemaphoreHandle_t xSemaphore,\r
- * TickType_t xBlockTime\r
- * )</pre>\r
- *\r
- * <i>Macro</i> to obtain a semaphore. The semaphore must have previously been\r
- * created with a call to xSemaphoreCreateBinary(), xSemaphoreCreateMutex() or\r
- * xSemaphoreCreateCounting().\r
- *\r
- * @param xSemaphore A handle to the semaphore being taken - obtained when\r
- * the semaphore was created.\r
- *\r
- * @param xBlockTime The time in ticks to wait for the semaphore to become\r
- * available. The macro portTICK_PERIOD_MS can be used to convert this to a\r
- * real time. A block time of zero can be used to poll the semaphore. A block\r
- * time of portMAX_DELAY can be used to block indefinitely (provided\r
- * INCLUDE_vTaskSuspend is set to 1 in FreeRTOSConfig.h).\r
- *\r
- * @return pdTRUE if the semaphore was obtained. pdFALSE\r
- * if xBlockTime expired without the semaphore becoming available.\r
- *\r
- * Example usage:\r
- <pre>\r
- SemaphoreHandle_t xSemaphore = NULL;\r
-\r
- // A task that creates a semaphore.\r
- void vATask( void * pvParameters )\r
- {\r
- // Create the semaphore to guard a shared resource.\r
- xSemaphore = xSemaphoreCreateBinary();\r
- }\r
-\r
- // A task that uses the semaphore.\r
- void vAnotherTask( void * pvParameters )\r
- {\r
- // ... Do other things.\r
-\r
- if( xSemaphore != NULL )\r
- {\r
- // See if we can obtain the semaphore. If the semaphore is not available\r
- // wait 10 ticks to see if it becomes free.\r
- if( xSemaphoreTake( xSemaphore, ( TickType_t ) 10 ) == pdTRUE )\r
- {\r
- // We were able to obtain the semaphore and can now access the\r
- // shared resource.\r
-\r
- // ...\r
-\r
- // We have finished accessing the shared resource. Release the\r
- // semaphore.\r
- xSemaphoreGive( xSemaphore );\r
- }\r
- else\r
- {\r
- // We could not obtain the semaphore and can therefore not access\r
- // the shared resource safely.\r
- }\r
- }\r
- }\r
- </pre>\r
- * \defgroup xSemaphoreTake xSemaphoreTake\r
- * \ingroup Semaphores\r
- */\r
-#define xSemaphoreTake( xSemaphore, xBlockTime ) xQueueSemaphoreTake( ( xSemaphore ), ( xBlockTime ) )\r
-\r
-/**\r
- * semphr. h\r
- * xSemaphoreTakeRecursive(\r
- * SemaphoreHandle_t xMutex,\r
- * TickType_t xBlockTime\r
- * )\r
- *\r
- * <i>Macro</i> to recursively obtain, or 'take', a mutex type semaphore.\r
- * The mutex must have previously been created using a call to\r
- * xSemaphoreCreateRecursiveMutex();\r
- *\r
- * configUSE_RECURSIVE_MUTEXES must be set to 1 in FreeRTOSConfig.h for this\r
- * macro to be available.\r
- *\r
- * This macro must not be used on mutexes created using xSemaphoreCreateMutex().\r
- *\r
- * A mutex used recursively can be 'taken' repeatedly by the owner. The mutex\r
- * doesn't become available again until the owner has called\r
- * xSemaphoreGiveRecursive() for each successful 'take' request. For example,\r
- * if a task successfully 'takes' the same mutex 5 times then the mutex will\r
- * not be available to any other task until it has also 'given' the mutex back\r
- * exactly five times.\r
- *\r
- * @param xMutex A handle to the mutex being obtained. This is the\r
- * handle returned by xSemaphoreCreateRecursiveMutex();\r
- *\r
- * @param xBlockTime The time in ticks to wait for the semaphore to become\r
- * available. The macro portTICK_PERIOD_MS can be used to convert this to a\r
- * real time. A block time of zero can be used to poll the semaphore. If\r
- * the task already owns the semaphore then xSemaphoreTakeRecursive() will\r
- * return immediately no matter what the value of xBlockTime.\r
- *\r
- * @return pdTRUE if the semaphore was obtained. pdFALSE if xBlockTime\r
- * expired without the semaphore becoming available.\r
- *\r
- * Example usage:\r
- <pre>\r
- SemaphoreHandle_t xMutex = NULL;\r
-\r
- // A task that creates a mutex.\r
- void vATask( void * pvParameters )\r
- {\r
- // Create the mutex to guard a shared resource.\r
- xMutex = xSemaphoreCreateRecursiveMutex();\r
- }\r
-\r
- // A task that uses the mutex.\r
- void vAnotherTask( void * pvParameters )\r
- {\r
- // ... Do other things.\r
-\r
- if( xMutex != NULL )\r
- {\r
- // See if we can obtain the mutex. If the mutex is not available\r
- // wait 10 ticks to see if it becomes free.\r
- if( xSemaphoreTakeRecursive( xSemaphore, ( TickType_t ) 10 ) == pdTRUE )\r
- {\r
- // We were able to obtain the mutex and can now access the\r
- // shared resource.\r
-\r
- // ...\r
- // For some reason due to the nature of the code further calls to\r
- // xSemaphoreTakeRecursive() are made on the same mutex. In real\r
- // code these would not be just sequential calls as this would make\r
- // no sense. Instead the calls are likely to be buried inside\r
- // a more complex call structure.\r
- xSemaphoreTakeRecursive( xMutex, ( TickType_t ) 10 );\r
- xSemaphoreTakeRecursive( xMutex, ( TickType_t ) 10 );\r
-\r
- // The mutex has now been 'taken' three times, so will not be\r
- // available to another task until it has also been given back\r
- // three times. Again it is unlikely that real code would have\r
- // these calls sequentially, but instead buried in a more complex\r
- // call structure. This is just for illustrative purposes.\r
- xSemaphoreGiveRecursive( xMutex );\r
- xSemaphoreGiveRecursive( xMutex );\r
- xSemaphoreGiveRecursive( xMutex );\r
-\r
- // Now the mutex can be taken by other tasks.\r
- }\r
- else\r
- {\r
- // We could not obtain the mutex and can therefore not access\r
- // the shared resource safely.\r
- }\r
- }\r
- }\r
- </pre>\r
- * \defgroup xSemaphoreTakeRecursive xSemaphoreTakeRecursive\r
- * \ingroup Semaphores\r
- */\r
-#if( configUSE_RECURSIVE_MUTEXES == 1 )\r
- #define xSemaphoreTakeRecursive( xMutex, xBlockTime ) xQueueTakeMutexRecursive( ( xMutex ), ( xBlockTime ) )\r
-#endif\r
-\r
-/**\r
- * semphr. h\r
- * <pre>xSemaphoreGive( SemaphoreHandle_t xSemaphore )</pre>\r
- *\r
- * <i>Macro</i> to release a semaphore. The semaphore must have previously been\r
- * created with a call to xSemaphoreCreateBinary(), xSemaphoreCreateMutex() or\r
- * xSemaphoreCreateCounting(). and obtained using sSemaphoreTake().\r
- *\r
- * This macro must not be used from an ISR. See xSemaphoreGiveFromISR () for\r
- * an alternative which can be used from an ISR.\r
- *\r
- * This macro must also not be used on semaphores created using\r
- * xSemaphoreCreateRecursiveMutex().\r
- *\r
- * @param xSemaphore A handle to the semaphore being released. This is the\r
- * handle returned when the semaphore was created.\r
- *\r
- * @return pdTRUE if the semaphore was released. pdFALSE if an error occurred.\r
- * Semaphores are implemented using queues. An error can occur if there is\r
- * no space on the queue to post a message - indicating that the\r
- * semaphore was not first obtained correctly.\r
- *\r
- * Example usage:\r
- <pre>\r
- SemaphoreHandle_t xSemaphore = NULL;\r
-\r
- void vATask( void * pvParameters )\r
- {\r
- // Create the semaphore to guard a shared resource.\r
- xSemaphore = vSemaphoreCreateBinary();\r
-\r
- if( xSemaphore != NULL )\r
- {\r
- if( xSemaphoreGive( xSemaphore ) != pdTRUE )\r
- {\r
- // We would expect this call to fail because we cannot give\r
- // a semaphore without first "taking" it!\r
- }\r
-\r
- // Obtain the semaphore - don't block if the semaphore is not\r
- // immediately available.\r
- if( xSemaphoreTake( xSemaphore, ( TickType_t ) 0 ) )\r
- {\r
- // We now have the semaphore and can access the shared resource.\r
-\r
- // ...\r
-\r
- // We have finished accessing the shared resource so can free the\r
- // semaphore.\r
- if( xSemaphoreGive( xSemaphore ) != pdTRUE )\r
- {\r
- // We would not expect this call to fail because we must have\r
- // obtained the semaphore to get here.\r
- }\r
- }\r
- }\r
- }\r
- </pre>\r
- * \defgroup xSemaphoreGive xSemaphoreGive\r
- * \ingroup Semaphores\r
- */\r
-#define xSemaphoreGive( xSemaphore ) xQueueGenericSend( ( QueueHandle_t ) ( xSemaphore ), NULL, semGIVE_BLOCK_TIME, queueSEND_TO_BACK )\r
-\r
-/**\r
- * semphr. h\r
- * <pre>xSemaphoreGiveRecursive( SemaphoreHandle_t xMutex )</pre>\r
- *\r
- * <i>Macro</i> to recursively release, or 'give', a mutex type semaphore.\r
- * The mutex must have previously been created using a call to\r
- * xSemaphoreCreateRecursiveMutex();\r
- *\r
- * configUSE_RECURSIVE_MUTEXES must be set to 1 in FreeRTOSConfig.h for this\r
- * macro to be available.\r
- *\r
- * This macro must not be used on mutexes created using xSemaphoreCreateMutex().\r
- *\r
- * A mutex used recursively can be 'taken' repeatedly by the owner. The mutex\r
- * doesn't become available again until the owner has called\r
- * xSemaphoreGiveRecursive() for each successful 'take' request. For example,\r
- * if a task successfully 'takes' the same mutex 5 times then the mutex will\r
- * not be available to any other task until it has also 'given' the mutex back\r
- * exactly five times.\r
- *\r
- * @param xMutex A handle to the mutex being released, or 'given'. This is the\r
- * handle returned by xSemaphoreCreateMutex();\r
- *\r
- * @return pdTRUE if the semaphore was given.\r
- *\r
- * Example usage:\r
- <pre>\r
- SemaphoreHandle_t xMutex = NULL;\r
-\r
- // A task that creates a mutex.\r
- void vATask( void * pvParameters )\r
- {\r
- // Create the mutex to guard a shared resource.\r
- xMutex = xSemaphoreCreateRecursiveMutex();\r
- }\r
-\r
- // A task that uses the mutex.\r
- void vAnotherTask( void * pvParameters )\r
- {\r
- // ... Do other things.\r
-\r
- if( xMutex != NULL )\r
- {\r
- // See if we can obtain the mutex. If the mutex is not available\r
- // wait 10 ticks to see if it becomes free.\r
- if( xSemaphoreTakeRecursive( xMutex, ( TickType_t ) 10 ) == pdTRUE )\r
- {\r
- // We were able to obtain the mutex and can now access the\r
- // shared resource.\r
-\r
- // ...\r
- // For some reason due to the nature of the code further calls to\r
- // xSemaphoreTakeRecursive() are made on the same mutex. In real\r
- // code these would not be just sequential calls as this would make\r
- // no sense. Instead the calls are likely to be buried inside\r
- // a more complex call structure.\r
- xSemaphoreTakeRecursive( xMutex, ( TickType_t ) 10 );\r
- xSemaphoreTakeRecursive( xMutex, ( TickType_t ) 10 );\r
-\r
- // The mutex has now been 'taken' three times, so will not be\r
- // available to another task until it has also been given back\r
- // three times. Again it is unlikely that real code would have\r
- // these calls sequentially, it would be more likely that the calls\r
- // to xSemaphoreGiveRecursive() would be called as a call stack\r
- // unwound. This is just for demonstrative purposes.\r
- xSemaphoreGiveRecursive( xMutex );\r
- xSemaphoreGiveRecursive( xMutex );\r
- xSemaphoreGiveRecursive( xMutex );\r
-\r
- // Now the mutex can be taken by other tasks.\r
- }\r
- else\r
- {\r
- // We could not obtain the mutex and can therefore not access\r
- // the shared resource safely.\r
- }\r
- }\r
- }\r
- </pre>\r
- * \defgroup xSemaphoreGiveRecursive xSemaphoreGiveRecursive\r
- * \ingroup Semaphores\r
- */\r
-#if( configUSE_RECURSIVE_MUTEXES == 1 )\r
- #define xSemaphoreGiveRecursive( xMutex ) xQueueGiveMutexRecursive( ( xMutex ) )\r
-#endif\r
-\r
-/**\r
- * semphr. h\r
- * <pre>\r
- xSemaphoreGiveFromISR(\r
- SemaphoreHandle_t xSemaphore,\r
- BaseType_t *pxHigherPriorityTaskWoken\r
- )</pre>\r
- *\r
- * <i>Macro</i> to release a semaphore. The semaphore must have previously been\r
- * created with a call to xSemaphoreCreateBinary() or xSemaphoreCreateCounting().\r
- *\r
- * Mutex type semaphores (those created using a call to xSemaphoreCreateMutex())\r
- * must not be used with this macro.\r
- *\r
- * This macro can be used from an ISR.\r
- *\r
- * @param xSemaphore A handle to the semaphore being released. This is the\r
- * handle returned when the semaphore was created.\r
- *\r
- * @param pxHigherPriorityTaskWoken xSemaphoreGiveFromISR() will set\r
- * *pxHigherPriorityTaskWoken to pdTRUE if giving the semaphore caused a task\r
- * to unblock, and the unblocked task has a priority higher than the currently\r
- * running task. If xSemaphoreGiveFromISR() sets this value to pdTRUE then\r
- * a context switch should be requested before the interrupt is exited.\r
- *\r
- * @return pdTRUE if the semaphore was successfully given, otherwise errQUEUE_FULL.\r
- *\r
- * Example usage:\r
- <pre>\r
- \#define LONG_TIME 0xffff\r
- \#define TICKS_TO_WAIT 10\r
- SemaphoreHandle_t xSemaphore = NULL;\r
-\r
- // Repetitive task.\r
- void vATask( void * pvParameters )\r
- {\r
- for( ;; )\r
- {\r
- // We want this task to run every 10 ticks of a timer. The semaphore\r
- // was created before this task was started.\r
-\r
- // Block waiting for the semaphore to become available.\r
- if( xSemaphoreTake( xSemaphore, LONG_TIME ) == pdTRUE )\r
- {\r
- // It is time to execute.\r
-\r
- // ...\r
-\r
- // We have finished our task. Return to the top of the loop where\r
- // we will block on the semaphore until it is time to execute\r
- // again. Note when using the semaphore for synchronisation with an\r
- // ISR in this manner there is no need to 'give' the semaphore back.\r
- }\r
- }\r
- }\r
-\r
- // Timer ISR\r
- void vTimerISR( void * pvParameters )\r
- {\r
- static uint8_t ucLocalTickCount = 0;\r
- static BaseType_t xHigherPriorityTaskWoken;\r
-\r
- // A timer tick has occurred.\r
-\r
- // ... Do other time functions.\r
-\r
- // Is it time for vATask () to run?\r
- xHigherPriorityTaskWoken = pdFALSE;\r
- ucLocalTickCount++;\r
- if( ucLocalTickCount >= TICKS_TO_WAIT )\r
- {\r
- // Unblock the task by releasing the semaphore.\r
- xSemaphoreGiveFromISR( xSemaphore, &xHigherPriorityTaskWoken );\r
-\r
- // Reset the count so we release the semaphore again in 10 ticks time.\r
- ucLocalTickCount = 0;\r
- }\r
-\r
- if( xHigherPriorityTaskWoken != pdFALSE )\r
- {\r
- // We can force a context switch here. Context switching from an\r
- // ISR uses port specific syntax. Check the demo task for your port\r
- // to find the syntax required.\r
- }\r
- }\r
- </pre>\r
- * \defgroup xSemaphoreGiveFromISR xSemaphoreGiveFromISR\r
- * \ingroup Semaphores\r
- */\r
-#define xSemaphoreGiveFromISR( xSemaphore, pxHigherPriorityTaskWoken ) xQueueGiveFromISR( ( QueueHandle_t ) ( xSemaphore ), ( pxHigherPriorityTaskWoken ) )\r
-\r
-/**\r
- * semphr. h\r
- * <pre>\r
- xSemaphoreTakeFromISR(\r
- SemaphoreHandle_t xSemaphore,\r
- BaseType_t *pxHigherPriorityTaskWoken\r
- )</pre>\r
- *\r
- * <i>Macro</i> to take a semaphore from an ISR. The semaphore must have\r
- * previously been created with a call to xSemaphoreCreateBinary() or\r
- * xSemaphoreCreateCounting().\r
- *\r
- * Mutex type semaphores (those created using a call to xSemaphoreCreateMutex())\r
- * must not be used with this macro.\r
- *\r
- * This macro can be used from an ISR, however taking a semaphore from an ISR\r
- * is not a common operation. It is likely to only be useful when taking a\r
- * counting semaphore when an interrupt is obtaining an object from a resource\r
- * pool (when the semaphore count indicates the number of resources available).\r
- *\r
- * @param xSemaphore A handle to the semaphore being taken. This is the\r
- * handle returned when the semaphore was created.\r
- *\r
- * @param pxHigherPriorityTaskWoken xSemaphoreTakeFromISR() will set\r
- * *pxHigherPriorityTaskWoken to pdTRUE if taking the semaphore caused a task\r
- * to unblock, and the unblocked task has a priority higher than the currently\r
- * running task. If xSemaphoreTakeFromISR() sets this value to pdTRUE then\r
- * a context switch should be requested before the interrupt is exited.\r
- *\r
- * @return pdTRUE if the semaphore was successfully taken, otherwise\r
- * pdFALSE\r
- */\r
-#define xSemaphoreTakeFromISR( xSemaphore, pxHigherPriorityTaskWoken ) xQueueReceiveFromISR( ( QueueHandle_t ) ( xSemaphore ), NULL, ( pxHigherPriorityTaskWoken ) )\r
-\r
-/**\r
- * semphr. h\r
- * <pre>SemaphoreHandle_t xSemaphoreCreateMutex( void )</pre>\r
- *\r
- * Creates a new mutex type semaphore instance, and returns a handle by which\r
- * the new mutex can be referenced.\r
- *\r
- * Internally, within the FreeRTOS implementation, mutex semaphores use a block\r
- * of memory, in which the mutex structure is stored. If a mutex is created\r
- * using xSemaphoreCreateMutex() then the required memory is automatically\r
- * dynamically allocated inside the xSemaphoreCreateMutex() function. (see\r
- * http://www.freertos.org/a00111.html). If a mutex is created using\r
- * xSemaphoreCreateMutexStatic() then the application writer must provided the\r
- * memory. xSemaphoreCreateMutexStatic() therefore allows a mutex to be created\r
- * without using any dynamic memory allocation.\r
- *\r
- * Mutexes created using this function can be accessed using the xSemaphoreTake()\r
- * and xSemaphoreGive() macros. The xSemaphoreTakeRecursive() and\r
- * xSemaphoreGiveRecursive() macros must not be used.\r
- *\r
- * This type of semaphore uses a priority inheritance mechanism so a task\r
- * 'taking' a semaphore MUST ALWAYS 'give' the semaphore back once the\r
- * semaphore it is no longer required.\r
- *\r
- * Mutex type semaphores cannot be used from within interrupt service routines.\r
- *\r
- * See xSemaphoreCreateBinary() for an alternative implementation that can be\r
- * used for pure synchronisation (where one task or interrupt always 'gives' the\r
- * semaphore and another always 'takes' the semaphore) and from within interrupt\r
- * service routines.\r
- *\r
- * @return If the mutex was successfully created then a handle to the created\r
- * semaphore is returned. If there was not enough heap to allocate the mutex\r
- * data structures then NULL is returned.\r
- *\r
- * Example usage:\r
- <pre>\r
- SemaphoreHandle_t xSemaphore;\r
-\r
- void vATask( void * pvParameters )\r
- {\r
- // Semaphore cannot be used before a call to xSemaphoreCreateMutex().\r
- // This is a macro so pass the variable in directly.\r
- xSemaphore = xSemaphoreCreateMutex();\r
-\r
- if( xSemaphore != NULL )\r
- {\r
- // The semaphore was created successfully.\r
- // The semaphore can now be used.\r
- }\r
- }\r
- </pre>\r
- * \defgroup xSemaphoreCreateMutex xSemaphoreCreateMutex\r
- * \ingroup Semaphores\r
- */\r
-#if( configSUPPORT_DYNAMIC_ALLOCATION == 1 )\r
- #define xSemaphoreCreateMutex() xQueueCreateMutex( queueQUEUE_TYPE_MUTEX )\r
-#endif\r
-\r
-/**\r
- * semphr. h\r
- * <pre>SemaphoreHandle_t xSemaphoreCreateMutexStatic( StaticSemaphore_t *pxMutexBuffer )</pre>\r
- *\r
- * Creates a new mutex type semaphore instance, and returns a handle by which\r
- * the new mutex can be referenced.\r
- *\r
- * Internally, within the FreeRTOS implementation, mutex semaphores use a block\r
- * of memory, in which the mutex structure is stored. If a mutex is created\r
- * using xSemaphoreCreateMutex() then the required memory is automatically\r
- * dynamically allocated inside the xSemaphoreCreateMutex() function. (see\r
- * http://www.freertos.org/a00111.html). If a mutex is created using\r
- * xSemaphoreCreateMutexStatic() then the application writer must provided the\r
- * memory. xSemaphoreCreateMutexStatic() therefore allows a mutex to be created\r
- * without using any dynamic memory allocation.\r
- *\r
- * Mutexes created using this function can be accessed using the xSemaphoreTake()\r
- * and xSemaphoreGive() macros. The xSemaphoreTakeRecursive() and\r
- * xSemaphoreGiveRecursive() macros must not be used.\r
- *\r
- * This type of semaphore uses a priority inheritance mechanism so a task\r
- * 'taking' a semaphore MUST ALWAYS 'give' the semaphore back once the\r
- * semaphore it is no longer required.\r
- *\r
- * Mutex type semaphores cannot be used from within interrupt service routines.\r
- *\r
- * See xSemaphoreCreateBinary() for an alternative implementation that can be\r
- * used for pure synchronisation (where one task or interrupt always 'gives' the\r
- * semaphore and another always 'takes' the semaphore) and from within interrupt\r
- * service routines.\r
- *\r
- * @param pxMutexBuffer Must point to a variable of type StaticSemaphore_t,\r
- * which will be used to hold the mutex's data structure, removing the need for\r
- * the memory to be allocated dynamically.\r
- *\r
- * @return If the mutex was successfully created then a handle to the created\r
- * mutex is returned. If pxMutexBuffer was NULL then NULL is returned.\r
- *\r
- * Example usage:\r
- <pre>\r
- SemaphoreHandle_t xSemaphore;\r
- StaticSemaphore_t xMutexBuffer;\r
-\r
- void vATask( void * pvParameters )\r
- {\r
- // A mutex cannot be used before it has been created. xMutexBuffer is\r
- // into xSemaphoreCreateMutexStatic() so no dynamic memory allocation is\r
- // attempted.\r
- xSemaphore = xSemaphoreCreateMutexStatic( &xMutexBuffer );\r
-\r
- // As no dynamic memory allocation was performed, xSemaphore cannot be NULL,\r
- // so there is no need to check it.\r
- }\r
- </pre>\r
- * \defgroup xSemaphoreCreateMutexStatic xSemaphoreCreateMutexStatic\r
- * \ingroup Semaphores\r
- */\r
- #if( configSUPPORT_STATIC_ALLOCATION == 1 )\r
- #define xSemaphoreCreateMutexStatic( pxMutexBuffer ) xQueueCreateMutexStatic( queueQUEUE_TYPE_MUTEX, ( pxMutexBuffer ) )\r
-#endif /* configSUPPORT_STATIC_ALLOCATION */\r
-\r
-\r
-/**\r
- * semphr. h\r
- * <pre>SemaphoreHandle_t xSemaphoreCreateRecursiveMutex( void )</pre>\r
- *\r
- * Creates a new recursive mutex type semaphore instance, and returns a handle\r
- * by which the new recursive mutex can be referenced.\r
- *\r
- * Internally, within the FreeRTOS implementation, recursive mutexs use a block\r
- * of memory, in which the mutex structure is stored. If a recursive mutex is\r
- * created using xSemaphoreCreateRecursiveMutex() then the required memory is\r
- * automatically dynamically allocated inside the\r
- * xSemaphoreCreateRecursiveMutex() function. (see\r
- * http://www.freertos.org/a00111.html). If a recursive mutex is created using\r
- * xSemaphoreCreateRecursiveMutexStatic() then the application writer must\r
- * provide the memory that will get used by the mutex.\r
- * xSemaphoreCreateRecursiveMutexStatic() therefore allows a recursive mutex to\r
- * be created without using any dynamic memory allocation.\r
- *\r
- * Mutexes created using this macro can be accessed using the\r
- * xSemaphoreTakeRecursive() and xSemaphoreGiveRecursive() macros. The\r
- * xSemaphoreTake() and xSemaphoreGive() macros must not be used.\r
- *\r
- * A mutex used recursively can be 'taken' repeatedly by the owner. The mutex\r
- * doesn't become available again until the owner has called\r
- * xSemaphoreGiveRecursive() for each successful 'take' request. For example,\r
- * if a task successfully 'takes' the same mutex 5 times then the mutex will\r
- * not be available to any other task until it has also 'given' the mutex back\r
- * exactly five times.\r
- *\r
- * This type of semaphore uses a priority inheritance mechanism so a task\r
- * 'taking' a semaphore MUST ALWAYS 'give' the semaphore back once the\r
- * semaphore it is no longer required.\r
- *\r
- * Mutex type semaphores cannot be used from within interrupt service routines.\r
- *\r
- * See xSemaphoreCreateBinary() for an alternative implementation that can be\r
- * used for pure synchronisation (where one task or interrupt always 'gives' the\r
- * semaphore and another always 'takes' the semaphore) and from within interrupt\r
- * service routines.\r
- *\r
- * @return xSemaphore Handle to the created mutex semaphore. Should be of type\r
- * SemaphoreHandle_t.\r
- *\r
- * Example usage:\r
- <pre>\r
- SemaphoreHandle_t xSemaphore;\r
-\r
- void vATask( void * pvParameters )\r
- {\r
- // Semaphore cannot be used before a call to xSemaphoreCreateMutex().\r
- // This is a macro so pass the variable in directly.\r
- xSemaphore = xSemaphoreCreateRecursiveMutex();\r
-\r
- if( xSemaphore != NULL )\r
- {\r
- // The semaphore was created successfully.\r
- // The semaphore can now be used.\r
- }\r
- }\r
- </pre>\r
- * \defgroup xSemaphoreCreateRecursiveMutex xSemaphoreCreateRecursiveMutex\r
- * \ingroup Semaphores\r
- */\r
-#if( ( configSUPPORT_DYNAMIC_ALLOCATION == 1 ) && ( configUSE_RECURSIVE_MUTEXES == 1 ) )\r
- #define xSemaphoreCreateRecursiveMutex() xQueueCreateMutex( queueQUEUE_TYPE_RECURSIVE_MUTEX )\r
-#endif\r
-\r
-/**\r
- * semphr. h\r
- * <pre>SemaphoreHandle_t xSemaphoreCreateRecursiveMutexStatic( StaticSemaphore_t *pxMutexBuffer )</pre>\r
- *\r
- * Creates a new recursive mutex type semaphore instance, and returns a handle\r
- * by which the new recursive mutex can be referenced.\r
- *\r
- * Internally, within the FreeRTOS implementation, recursive mutexs use a block\r
- * of memory, in which the mutex structure is stored. If a recursive mutex is\r
- * created using xSemaphoreCreateRecursiveMutex() then the required memory is\r
- * automatically dynamically allocated inside the\r
- * xSemaphoreCreateRecursiveMutex() function. (see\r
- * http://www.freertos.org/a00111.html). If a recursive mutex is created using\r
- * xSemaphoreCreateRecursiveMutexStatic() then the application writer must\r
- * provide the memory that will get used by the mutex.\r
- * xSemaphoreCreateRecursiveMutexStatic() therefore allows a recursive mutex to\r
- * be created without using any dynamic memory allocation.\r
- *\r
- * Mutexes created using this macro can be accessed using the\r
- * xSemaphoreTakeRecursive() and xSemaphoreGiveRecursive() macros. The\r
- * xSemaphoreTake() and xSemaphoreGive() macros must not be used.\r
- *\r
- * A mutex used recursively can be 'taken' repeatedly by the owner. The mutex\r
- * doesn't become available again until the owner has called\r
- * xSemaphoreGiveRecursive() for each successful 'take' request. For example,\r
- * if a task successfully 'takes' the same mutex 5 times then the mutex will\r
- * not be available to any other task until it has also 'given' the mutex back\r
- * exactly five times.\r
- *\r
- * This type of semaphore uses a priority inheritance mechanism so a task\r
- * 'taking' a semaphore MUST ALWAYS 'give' the semaphore back once the\r
- * semaphore it is no longer required.\r
- *\r
- * Mutex type semaphores cannot be used from within interrupt service routines.\r
- *\r
- * See xSemaphoreCreateBinary() for an alternative implementation that can be\r
- * used for pure synchronisation (where one task or interrupt always 'gives' the\r
- * semaphore and another always 'takes' the semaphore) and from within interrupt\r
- * service routines.\r
- *\r
- * @param pxMutexBuffer Must point to a variable of type StaticSemaphore_t,\r
- * which will then be used to hold the recursive mutex's data structure,\r
- * removing the need for the memory to be allocated dynamically.\r
- *\r
- * @return If the recursive mutex was successfully created then a handle to the\r
- * created recursive mutex is returned. If pxMutexBuffer was NULL then NULL is\r
- * returned.\r
- *\r
- * Example usage:\r
- <pre>\r
- SemaphoreHandle_t xSemaphore;\r
- StaticSemaphore_t xMutexBuffer;\r
-\r
- void vATask( void * pvParameters )\r
- {\r
- // A recursive semaphore cannot be used before it is created. Here a\r
- // recursive mutex is created using xSemaphoreCreateRecursiveMutexStatic().\r
- // The address of xMutexBuffer is passed into the function, and will hold\r
- // the mutexes data structures - so no dynamic memory allocation will be\r
- // attempted.\r
- xSemaphore = xSemaphoreCreateRecursiveMutexStatic( &xMutexBuffer );\r
-\r
- // As no dynamic memory allocation was performed, xSemaphore cannot be NULL,\r
- // so there is no need to check it.\r
- }\r
- </pre>\r
- * \defgroup xSemaphoreCreateRecursiveMutexStatic xSemaphoreCreateRecursiveMutexStatic\r
- * \ingroup Semaphores\r
- */\r
-#if( ( configSUPPORT_STATIC_ALLOCATION == 1 ) && ( configUSE_RECURSIVE_MUTEXES == 1 ) )\r
- #define xSemaphoreCreateRecursiveMutexStatic( pxStaticSemaphore ) xQueueCreateMutexStatic( queueQUEUE_TYPE_RECURSIVE_MUTEX, pxStaticSemaphore )\r
-#endif /* configSUPPORT_STATIC_ALLOCATION */\r
-\r
-/**\r
- * semphr. h\r
- * <pre>SemaphoreHandle_t xSemaphoreCreateCounting( UBaseType_t uxMaxCount, UBaseType_t uxInitialCount )</pre>\r
- *\r
- * Creates a new counting semaphore instance, and returns a handle by which the\r
- * new counting semaphore can be referenced.\r
- *\r
- * In many usage scenarios it is faster and more memory efficient to use a\r
- * direct to task notification in place of a counting semaphore!\r
- * http://www.freertos.org/RTOS-task-notifications.html\r
- *\r
- * Internally, within the FreeRTOS implementation, counting semaphores use a\r
- * block of memory, in which the counting semaphore structure is stored. If a\r
- * counting semaphore is created using xSemaphoreCreateCounting() then the\r
- * required memory is automatically dynamically allocated inside the\r
- * xSemaphoreCreateCounting() function. (see\r
- * http://www.freertos.org/a00111.html). If a counting semaphore is created\r
- * using xSemaphoreCreateCountingStatic() then the application writer can\r
- * instead optionally provide the memory that will get used by the counting\r
- * semaphore. xSemaphoreCreateCountingStatic() therefore allows a counting\r
- * semaphore to be created without using any dynamic memory allocation.\r
- *\r
- * Counting semaphores are typically used for two things:\r
- *\r
- * 1) Counting events.\r
- *\r
- * In this usage scenario an event handler will 'give' a semaphore each time\r
- * an event occurs (incrementing the semaphore count value), and a handler\r
- * task will 'take' a semaphore each time it processes an event\r
- * (decrementing the semaphore count value). The count value is therefore\r
- * the difference between the number of events that have occurred and the\r
- * number that have been processed. In this case it is desirable for the\r
- * initial count value to be zero.\r
- *\r
- * 2) Resource management.\r
- *\r
- * In this usage scenario the count value indicates the number of resources\r
- * available. To obtain control of a resource a task must first obtain a\r
- * semaphore - decrementing the semaphore count value. When the count value\r
- * reaches zero there are no free resources. When a task finishes with the\r
- * resource it 'gives' the semaphore back - incrementing the semaphore count\r
- * value. In this case it is desirable for the initial count value to be\r
- * equal to the maximum count value, indicating that all resources are free.\r
- *\r
- * @param uxMaxCount The maximum count value that can be reached. When the\r
- * semaphore reaches this value it can no longer be 'given'.\r
- *\r
- * @param uxInitialCount The count value assigned to the semaphore when it is\r
- * created.\r
- *\r
- * @return Handle to the created semaphore. Null if the semaphore could not be\r
- * created.\r
- *\r
- * Example usage:\r
- <pre>\r
- SemaphoreHandle_t xSemaphore;\r
-\r
- void vATask( void * pvParameters )\r
- {\r
- SemaphoreHandle_t xSemaphore = NULL;\r
-\r
- // Semaphore cannot be used before a call to xSemaphoreCreateCounting().\r
- // The max value to which the semaphore can count should be 10, and the\r
- // initial value assigned to the count should be 0.\r
- xSemaphore = xSemaphoreCreateCounting( 10, 0 );\r
-\r
- if( xSemaphore != NULL )\r
- {\r
- // The semaphore was created successfully.\r
- // The semaphore can now be used.\r
- }\r
- }\r
- </pre>\r
- * \defgroup xSemaphoreCreateCounting xSemaphoreCreateCounting\r
- * \ingroup Semaphores\r
- */\r
-#if( configSUPPORT_DYNAMIC_ALLOCATION == 1 )\r
- #define xSemaphoreCreateCounting( uxMaxCount, uxInitialCount ) xQueueCreateCountingSemaphore( ( uxMaxCount ), ( uxInitialCount ) )\r
-#endif\r
-\r
-/**\r
- * semphr. h\r
- * <pre>SemaphoreHandle_t xSemaphoreCreateCountingStatic( UBaseType_t uxMaxCount, UBaseType_t uxInitialCount, StaticSemaphore_t *pxSemaphoreBuffer )</pre>\r
- *\r
- * Creates a new counting semaphore instance, and returns a handle by which the\r
- * new counting semaphore can be referenced.\r
- *\r
- * In many usage scenarios it is faster and more memory efficient to use a\r
- * direct to task notification in place of a counting semaphore!\r
- * http://www.freertos.org/RTOS-task-notifications.html\r
- *\r
- * Internally, within the FreeRTOS implementation, counting semaphores use a\r
- * block of memory, in which the counting semaphore structure is stored. If a\r
- * counting semaphore is created using xSemaphoreCreateCounting() then the\r
- * required memory is automatically dynamically allocated inside the\r
- * xSemaphoreCreateCounting() function. (see\r
- * http://www.freertos.org/a00111.html). If a counting semaphore is created\r
- * using xSemaphoreCreateCountingStatic() then the application writer must\r
- * provide the memory. xSemaphoreCreateCountingStatic() therefore allows a\r
- * counting semaphore to be created without using any dynamic memory allocation.\r
- *\r
- * Counting semaphores are typically used for two things:\r
- *\r
- * 1) Counting events.\r
- *\r
- * In this usage scenario an event handler will 'give' a semaphore each time\r
- * an event occurs (incrementing the semaphore count value), and a handler\r
- * task will 'take' a semaphore each time it processes an event\r
- * (decrementing the semaphore count value). The count value is therefore\r
- * the difference between the number of events that have occurred and the\r
- * number that have been processed. In this case it is desirable for the\r
- * initial count value to be zero.\r
- *\r
- * 2) Resource management.\r
- *\r
- * In this usage scenario the count value indicates the number of resources\r
- * available. To obtain control of a resource a task must first obtain a\r
- * semaphore - decrementing the semaphore count value. When the count value\r
- * reaches zero there are no free resources. When a task finishes with the\r
- * resource it 'gives' the semaphore back - incrementing the semaphore count\r
- * value. In this case it is desirable for the initial count value to be\r
- * equal to the maximum count value, indicating that all resources are free.\r
- *\r
- * @param uxMaxCount The maximum count value that can be reached. When the\r
- * semaphore reaches this value it can no longer be 'given'.\r
- *\r
- * @param uxInitialCount The count value assigned to the semaphore when it is\r
- * created.\r
- *\r
- * @param pxSemaphoreBuffer Must point to a variable of type StaticSemaphore_t,\r
- * which will then be used to hold the semaphore's data structure, removing the\r
- * need for the memory to be allocated dynamically.\r
- *\r
- * @return If the counting semaphore was successfully created then a handle to\r
- * the created counting semaphore is returned. If pxSemaphoreBuffer was NULL\r
- * then NULL is returned.\r
- *\r
- * Example usage:\r
- <pre>\r
- SemaphoreHandle_t xSemaphore;\r
- StaticSemaphore_t xSemaphoreBuffer;\r
-\r
- void vATask( void * pvParameters )\r
- {\r
- SemaphoreHandle_t xSemaphore = NULL;\r
-\r
- // Counting semaphore cannot be used before they have been created. Create\r
- // a counting semaphore using xSemaphoreCreateCountingStatic(). The max\r
- // value to which the semaphore can count is 10, and the initial value\r
- // assigned to the count will be 0. The address of xSemaphoreBuffer is\r
- // passed in and will be used to hold the semaphore structure, so no dynamic\r
- // memory allocation will be used.\r
- xSemaphore = xSemaphoreCreateCounting( 10, 0, &xSemaphoreBuffer );\r
-\r
- // No memory allocation was attempted so xSemaphore cannot be NULL, so there\r
- // is no need to check its value.\r
- }\r
- </pre>\r
- * \defgroup xSemaphoreCreateCountingStatic xSemaphoreCreateCountingStatic\r
- * \ingroup Semaphores\r
- */\r
-#if( configSUPPORT_STATIC_ALLOCATION == 1 )\r
- #define xSemaphoreCreateCountingStatic( uxMaxCount, uxInitialCount, pxSemaphoreBuffer ) xQueueCreateCountingSemaphoreStatic( ( uxMaxCount ), ( uxInitialCount ), ( pxSemaphoreBuffer ) )\r
-#endif /* configSUPPORT_STATIC_ALLOCATION */\r
-\r
-/**\r
- * semphr. h\r
- * <pre>void vSemaphoreDelete( SemaphoreHandle_t xSemaphore );</pre>\r
- *\r
- * Delete a semaphore. This function must be used with care. For example,\r
- * do not delete a mutex type semaphore if the mutex is held by a task.\r
- *\r
- * @param xSemaphore A handle to the semaphore to be deleted.\r
- *\r
- * \defgroup vSemaphoreDelete vSemaphoreDelete\r
- * \ingroup Semaphores\r
- */\r
-#define vSemaphoreDelete( xSemaphore ) vQueueDelete( ( QueueHandle_t ) ( xSemaphore ) )\r
-\r
-/**\r
- * semphr.h\r
- * <pre>TaskHandle_t xSemaphoreGetMutexHolder( SemaphoreHandle_t xMutex );</pre>\r
- *\r
- * If xMutex is indeed a mutex type semaphore, return the current mutex holder.\r
- * If xMutex is not a mutex type semaphore, or the mutex is available (not held\r
- * by a task), return NULL.\r
- *\r
- * Note: This is a good way of determining if the calling task is the mutex\r
- * holder, but not a good way of determining the identity of the mutex holder as\r
- * the holder may change between the function exiting and the returned value\r
- * being tested.\r
- */\r
-#define xSemaphoreGetMutexHolder( xSemaphore ) xQueueGetMutexHolder( ( xSemaphore ) )\r
-\r
-/**\r
- * semphr.h\r
- * <pre>TaskHandle_t xSemaphoreGetMutexHolderFromISR( SemaphoreHandle_t xMutex );</pre>\r
- *\r
- * If xMutex is indeed a mutex type semaphore, return the current mutex holder.\r
- * If xMutex is not a mutex type semaphore, or the mutex is available (not held\r
- * by a task), return NULL.\r
- *\r
- */\r
-#define xSemaphoreGetMutexHolderFromISR( xSemaphore ) xQueueGetMutexHolderFromISR( ( xSemaphore ) )\r
-\r
-/**\r
- * semphr.h\r
- * <pre>UBaseType_t uxSemaphoreGetCount( SemaphoreHandle_t xSemaphore );</pre>\r
- *\r
- * If the semaphore is a counting semaphore then uxSemaphoreGetCount() returns\r
- * its current count value. If the semaphore is a binary semaphore then\r
- * uxSemaphoreGetCount() returns 1 if the semaphore is available, and 0 if the\r
- * semaphore is not available.\r
- *\r
- */\r
-#define uxSemaphoreGetCount( xSemaphore ) uxQueueMessagesWaiting( ( QueueHandle_t ) ( xSemaphore ) )\r
-\r
-#endif /* SEMAPHORE_H */\r
-\r
-\r
+++ /dev/null
-/*\r
- * FreeRTOS Kernel V10.0.1\r
- * Copyright (C) 2017 Amazon.com, Inc. or its affiliates. All Rights Reserved.\r
- *\r
- * Permission is hereby granted, free of charge, to any person obtaining a copy of\r
- * this software and associated documentation files (the "Software"), to deal in\r
- * the Software without restriction, including without limitation the rights to\r
- * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of\r
- * the Software, and to permit persons to whom the Software is furnished to do so,\r
- * subject to the following conditions:\r
- *\r
- * The above copyright notice and this permission notice shall be included in all\r
- * copies or substantial portions of the Software.\r
- *\r
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\r
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS\r
- * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR\r
- * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER\r
- * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN\r
- * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\r
- *\r
- * http://www.FreeRTOS.org\r
- * http://aws.amazon.com/freertos\r
- *\r
- * 1 tab == 4 spaces!\r
- */\r
-\r
-#ifndef STACK_MACROS_H\r
-#define STACK_MACROS_H\r
-\r
-/*\r
- * Call the stack overflow hook function if the stack of the task being swapped\r
- * out is currently overflowed, or looks like it might have overflowed in the\r
- * past.\r
- *\r
- * Setting configCHECK_FOR_STACK_OVERFLOW to 1 will cause the macro to check\r
- * the current stack state only - comparing the current top of stack value to\r
- * the stack limit. Setting configCHECK_FOR_STACK_OVERFLOW to greater than 1\r
- * will also cause the last few stack bytes to be checked to ensure the value\r
- * to which the bytes were set when the task was created have not been\r
- * overwritten. Note this second test does not guarantee that an overflowed\r
- * stack will always be recognised.\r
- */\r
-\r
-/*-----------------------------------------------------------*/\r
-\r
-#if( ( configCHECK_FOR_STACK_OVERFLOW == 1 ) && ( portSTACK_GROWTH < 0 ) )\r
-\r
- /* Only the current stack state is to be checked. */\r
- #define taskCHECK_FOR_STACK_OVERFLOW() \\r
- { \\r
- /* Is the currently saved stack pointer within the stack limit? */ \\r
- if( pxCurrentTCB->pxTopOfStack <= pxCurrentTCB->pxStack ) \\r
- { \\r
- vApplicationStackOverflowHook( ( TaskHandle_t ) pxCurrentTCB, pxCurrentTCB->pcTaskName ); \\r
- } \\r
- }\r
-\r
-#endif /* configCHECK_FOR_STACK_OVERFLOW == 1 */\r
-/*-----------------------------------------------------------*/\r
-\r
-#if( ( configCHECK_FOR_STACK_OVERFLOW == 1 ) && ( portSTACK_GROWTH > 0 ) )\r
-\r
- /* Only the current stack state is to be checked. */\r
- #define taskCHECK_FOR_STACK_OVERFLOW() \\r
- { \\r
- \\r
- /* Is the currently saved stack pointer within the stack limit? */ \\r
- if( pxCurrentTCB->pxTopOfStack >= pxCurrentTCB->pxEndOfStack ) \\r
- { \\r
- vApplicationStackOverflowHook( ( TaskHandle_t ) pxCurrentTCB, pxCurrentTCB->pcTaskName ); \\r
- } \\r
- }\r
-\r
-#endif /* configCHECK_FOR_STACK_OVERFLOW == 1 */\r
-/*-----------------------------------------------------------*/\r
-\r
-#if( ( configCHECK_FOR_STACK_OVERFLOW > 1 ) && ( portSTACK_GROWTH < 0 ) )\r
-\r
- #define taskCHECK_FOR_STACK_OVERFLOW() \\r
- { \\r
- const uint32_t * const pulStack = ( uint32_t * ) pxCurrentTCB->pxStack; \\r
- const uint32_t ulCheckValue = ( uint32_t ) 0xa5a5a5a5; \\r
- \\r
- if( ( pulStack[ 0 ] != ulCheckValue ) || \\r
- ( pulStack[ 1 ] != ulCheckValue ) || \\r
- ( pulStack[ 2 ] != ulCheckValue ) || \\r
- ( pulStack[ 3 ] != ulCheckValue ) ) \\r
- { \\r
- vApplicationStackOverflowHook( ( TaskHandle_t ) pxCurrentTCB, pxCurrentTCB->pcTaskName ); \\r
- } \\r
- }\r
-\r
-#endif /* #if( configCHECK_FOR_STACK_OVERFLOW > 1 ) */\r
-/*-----------------------------------------------------------*/\r
-\r
-#if( ( configCHECK_FOR_STACK_OVERFLOW > 1 ) && ( portSTACK_GROWTH > 0 ) )\r
-\r
- #define taskCHECK_FOR_STACK_OVERFLOW() \\r
- { \\r
- int8_t *pcEndOfStack = ( int8_t * ) pxCurrentTCB->pxEndOfStack; \\r
- static const uint8_t ucExpectedStackBytes[] = { tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, \\r
- tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, \\r
- tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, \\r
- tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, \\r
- tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE }; \\r
- \\r
- \\r
- pcEndOfStack -= sizeof( ucExpectedStackBytes ); \\r
- \\r
- /* Has the extremity of the task stack ever been written over? */ \\r
- if( memcmp( ( void * ) pcEndOfStack, ( void * ) ucExpectedStackBytes, sizeof( ucExpectedStackBytes ) ) != 0 ) \\r
- { \\r
- vApplicationStackOverflowHook( ( TaskHandle_t ) pxCurrentTCB, pxCurrentTCB->pcTaskName ); \\r
- } \\r
- }\r
-\r
-#endif /* #if( configCHECK_FOR_STACK_OVERFLOW > 1 ) */\r
-/*-----------------------------------------------------------*/\r
-\r
-/* Remove stack overflow macro if not being used. */\r
-#ifndef taskCHECK_FOR_STACK_OVERFLOW\r
- #define taskCHECK_FOR_STACK_OVERFLOW()\r
-#endif\r
-\r
-\r
-\r
-#endif /* STACK_MACROS_H */\r
-\r
+++ /dev/null
-\r
-#ifndef FREERTOS_STDINT\r
-#define FREERTOS_STDINT\r
-\r
-/*******************************************************************************\r
- * THIS IS NOT A FULL stdint.h IMPLEMENTATION - It only contains the definitions\r
- * necessary to build the FreeRTOS code. It is provided to allow FreeRTOS to be\r
- * built using compilers that do not provide their own stdint.h definition.\r
- *\r
- * To use this file:\r
- *\r
- * 1) Copy this file into the directory that contains your FreeRTOSConfig.h\r
- * header file, as that directory will already be in the compilers include\r
- * path.\r
- *\r
- * 2) Rename the copied file stdint.h.\r
- *\r
- */\r
-\r
-typedef signed char int8_t;\r
-typedef unsigned char uint8_t;\r
-typedef short int16_t;\r
-typedef unsigned short uint16_t;\r
-typedef long int32_t;\r
-typedef unsigned long uint32_t;\r
-\r
-#endif /* FREERTOS_STDINT */\r
+++ /dev/null
-/*\r
- * FreeRTOS Kernel V10.0.1\r
- * Copyright (C) 2017 Amazon.com, Inc. or its affiliates. All Rights Reserved.\r
- *\r
- * Permission is hereby granted, free of charge, to any person obtaining a copy of\r
- * this software and associated documentation files (the "Software"), to deal in\r
- * the Software without restriction, including without limitation the rights to\r
- * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of\r
- * the Software, and to permit persons to whom the Software is furnished to do so,\r
- * subject to the following conditions:\r
- *\r
- * The above copyright notice and this permission notice shall be included in all\r
- * copies or substantial portions of the Software.\r
- *\r
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\r
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS\r
- * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR\r
- * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER\r
- * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN\r
- * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\r
- *\r
- * http://www.FreeRTOS.org\r
- * http://aws.amazon.com/freertos\r
- *\r
- * 1 tab == 4 spaces!\r
- */\r
-\r
-/*\r
- * Stream buffers are used to send a continuous stream of data from one task or\r
- * interrupt to another. Their implementation is light weight, making them\r
- * particularly suited for interrupt to task and core to core communication\r
- * scenarios.\r
- *\r
- * ***NOTE***: Uniquely among FreeRTOS objects, the stream buffer\r
- * implementation (so also the message buffer implementation, as message buffers\r
- * are built on top of stream buffers) assumes there is only one task or\r
- * interrupt that will write to the buffer (the writer), and only one task or\r
- * interrupt that will read from the buffer (the reader). It is safe for the\r
- * writer and reader to be different tasks or interrupts, but, unlike other\r
- * FreeRTOS objects, it is not safe to have multiple different writers or\r
- * multiple different readers. If there are to be multiple different writers\r
- * then the application writer must place each call to a writing API function\r
- * (such as xStreamBufferSend()) inside a critical section and set the send\r
- * block time to 0. Likewise, if there are to be multiple different readers\r
- * then the application writer must place each call to a reading API function\r
- * (such as xStreamBufferRead()) inside a critical section section and set the\r
- * receive block time to 0.\r
- *\r
- */\r
-\r
-#ifndef STREAM_BUFFER_H\r
-#define STREAM_BUFFER_H\r
-\r
-#if defined( __cplusplus )\r
-extern "C" {\r
-#endif\r
-\r
-/**\r
- * Type by which stream buffers are referenced. For example, a call to\r
- * xStreamBufferCreate() returns an StreamBufferHandle_t variable that can\r
- * then be used as a parameter to xStreamBufferSend(), xStreamBufferReceive(),\r
- * etc.\r
- */\r
-typedef void * StreamBufferHandle_t;\r
-\r
-\r
-/**\r
- * message_buffer.h\r
- *\r
-<pre>\r
-StreamBufferHandle_t xStreamBufferCreate( size_t xBufferSizeBytes, size_t xTriggerLevelBytes );\r
-</pre>\r
- *\r
- * Creates a new stream buffer using dynamically allocated memory. See\r
- * xStreamBufferCreateStatic() for a version that uses statically allocated\r
- * memory (memory that is allocated at compile time).\r
- *\r
- * configSUPPORT_DYNAMIC_ALLOCATION must be set to 1 or left undefined in\r
- * FreeRTOSConfig.h for xStreamBufferCreate() to be available.\r
- *\r
- * @param xBufferSizeBytes The total number of bytes the stream buffer will be\r
- * able to hold at any one time.\r
- *\r
- * @param xTriggerLevelBytes The number of bytes that must be in the stream\r
- * buffer before a task that is blocked on the stream buffer to wait for data is\r
- * moved out of the blocked state. For example, if a task is blocked on a read\r
- * of an empty stream buffer that has a trigger level of 1 then the task will be\r
- * unblocked when a single byte is written to the buffer or the task's block\r
- * time expires. As another example, if a task is blocked on a read of an empty\r
- * stream buffer that has a trigger level of 10 then the task will not be\r
- * unblocked until the stream buffer contains at least 10 bytes or the task's\r
- * block time expires. If a reading task's block time expires before the\r
- * trigger level is reached then the task will still receive however many bytes\r
- * are actually available. Setting a trigger level of 0 will result in a\r
- * trigger level of 1 being used. It is not valid to specify a trigger level\r
- * that is greater than the buffer size.\r
- *\r
- * @return If NULL is returned, then the stream buffer cannot be created\r
- * because there is insufficient heap memory available for FreeRTOS to allocate\r
- * the stream buffer data structures and storage area. A non-NULL value being\r
- * returned indicates that the stream buffer has been created successfully -\r
- * the returned value should be stored as the handle to the created stream\r
- * buffer.\r
- *\r
- * Example use:\r
-<pre>\r
-\r
-void vAFunction( void )\r
-{\r
-StreamBufferHandle_t xStreamBuffer;\r
-const size_t xStreamBufferSizeBytes = 100, xTriggerLevel = 10;\r
-\r
- // Create a stream buffer that can hold 100 bytes. The memory used to hold\r
- // both the stream buffer structure and the data in the stream buffer is\r
- // allocated dynamically.\r
- xStreamBuffer = xStreamBufferCreate( xStreamBufferSizeBytes, xTriggerLevel );\r
-\r
- if( xStreamBuffer == NULL )\r
- {\r
- // There was not enough heap memory space available to create the\r
- // stream buffer.\r
- }\r
- else\r
- {\r
- // The stream buffer was created successfully and can now be used.\r
- }\r
-}\r
-</pre>\r
- * \defgroup xStreamBufferCreate xStreamBufferCreate\r
- * \ingroup StreamBufferManagement\r
- */\r
-#define xStreamBufferCreate( xBufferSizeBytes, xTriggerLevelBytes ) xStreamBufferGenericCreate( xBufferSizeBytes, xTriggerLevelBytes, pdFALSE )\r
-\r
-/**\r
- * stream_buffer.h\r
- *\r
-<pre>\r
-StreamBufferHandle_t xStreamBufferCreateStatic( size_t xBufferSizeBytes,\r
- size_t xTriggerLevelBytes,\r
- uint8_t *pucStreamBufferStorageArea,\r
- StaticStreamBuffer_t *pxStaticStreamBuffer );\r
-</pre>\r
- * Creates a new stream buffer using statically allocated memory. See\r
- * xStreamBufferCreate() for a version that uses dynamically allocated memory.\r
- *\r
- * configSUPPORT_STATIC_ALLOCATION must be set to 1 in FreeRTOSConfig.h for\r
- * xStreamBufferCreateStatic() to be available.\r
- *\r
- * @param xBufferSizeBytes The size, in bytes, of the buffer pointed to by the\r
- * pucStreamBufferStorageArea parameter.\r
- *\r
- * @param xTriggerLevelBytes The number of bytes that must be in the stream\r
- * buffer before a task that is blocked on the stream buffer to wait for data is\r
- * moved out of the blocked state. For example, if a task is blocked on a read\r
- * of an empty stream buffer that has a trigger level of 1 then the task will be\r
- * unblocked when a single byte is written to the buffer or the task's block\r
- * time expires. As another example, if a task is blocked on a read of an empty\r
- * stream buffer that has a trigger level of 10 then the task will not be\r
- * unblocked until the stream buffer contains at least 10 bytes or the task's\r
- * block time expires. If a reading task's block time expires before the\r
- * trigger level is reached then the task will still receive however many bytes\r
- * are actually available. Setting a trigger level of 0 will result in a\r
- * trigger level of 1 being used. It is not valid to specify a trigger level\r
- * that is greater than the buffer size.\r
- *\r
- * @param pucStreamBufferStorageArea Must point to a uint8_t array that is at\r
- * least xBufferSizeBytes + 1 big. This is the array to which streams are\r
- * copied when they are written to the stream buffer.\r
- *\r
- * @param pxStaticStreamBuffer Must point to a variable of type\r
- * StaticStreamBuffer_t, which will be used to hold the stream buffer's data\r
- * structure.\r
- *\r
- * @return If the stream buffer is created successfully then a handle to the\r
- * created stream buffer is returned. If either pucStreamBufferStorageArea or\r
- * pxStaticstreamBuffer are NULL then NULL is returned.\r
- *\r
- * Example use:\r
-<pre>\r
-\r
-// Used to dimension the array used to hold the streams. The available space\r
-// will actually be one less than this, so 999.\r
-#define STORAGE_SIZE_BYTES 1000\r
-\r
-// Defines the memory that will actually hold the streams within the stream\r
-// buffer.\r
-static uint8_t ucStorageBuffer[ STORAGE_SIZE_BYTES ];\r
-\r
-// The variable used to hold the stream buffer structure.\r
-StaticStreamBuffer_t xStreamBufferStruct;\r
-\r
-void MyFunction( void )\r
-{\r
-StreamBufferHandle_t xStreamBuffer;\r
-const size_t xTriggerLevel = 1;\r
-\r
- xStreamBuffer = xStreamBufferCreateStatic( sizeof( ucBufferStorage ),\r
- xTriggerLevel,\r
- ucBufferStorage,\r
- &xStreamBufferStruct );\r
-\r
- // As neither the pucStreamBufferStorageArea or pxStaticStreamBuffer\r
- // parameters were NULL, xStreamBuffer will not be NULL, and can be used to\r
- // reference the created stream buffer in other stream buffer API calls.\r
-\r
- // Other code that uses the stream buffer can go here.\r
-}\r
-\r
-</pre>\r
- * \defgroup xStreamBufferCreateStatic xStreamBufferCreateStatic\r
- * \ingroup StreamBufferManagement\r
- */\r
-#define xStreamBufferCreateStatic( xBufferSizeBytes, xTriggerLevelBytes, pucStreamBufferStorageArea, pxStaticStreamBuffer ) xStreamBufferGenericCreateStatic( xBufferSizeBytes, xTriggerLevelBytes, pdFALSE, pucStreamBufferStorageArea, pxStaticStreamBuffer )\r
-\r
-/**\r
- * stream_buffer.h\r
- *\r
-<pre>\r
-size_t xStreamBufferSend( StreamBufferHandle_t xStreamBuffer,\r
- const void *pvTxData,\r
- size_t xDataLengthBytes,\r
- TickType_t xTicksToWait );\r
-<pre>\r
- *\r
- * Sends bytes to a stream buffer. The bytes are copied into the stream buffer.\r
- *\r
- * ***NOTE***: Uniquely among FreeRTOS objects, the stream buffer\r
- * implementation (so also the message buffer implementation, as message buffers\r
- * are built on top of stream buffers) assumes there is only one task or\r
- * interrupt that will write to the buffer (the writer), and only one task or\r
- * interrupt that will read from the buffer (the reader). It is safe for the\r
- * writer and reader to be different tasks or interrupts, but, unlike other\r
- * FreeRTOS objects, it is not safe to have multiple different writers or\r
- * multiple different readers. If there are to be multiple different writers\r
- * then the application writer must place each call to a writing API function\r
- * (such as xStreamBufferSend()) inside a critical section and set the send\r
- * block time to 0. Likewise, if there are to be multiple different readers\r
- * then the application writer must place each call to a reading API function\r
- * (such as xStreamBufferRead()) inside a critical section and set the receive\r
- * block time to 0.\r
- *\r
- * Use xStreamBufferSend() to write to a stream buffer from a task. Use\r
- * xStreamBufferSendFromISR() to write to a stream buffer from an interrupt\r
- * service routine (ISR).\r
- *\r
- * @param xStreamBuffer The handle of the stream buffer to which a stream is\r
- * being sent.\r
- *\r
- * @param pvTxData A pointer to the buffer that holds the bytes to be copied\r
- * into the stream buffer.\r
- *\r
- * @param xDataLengthBytes The maximum number of bytes to copy from pvTxData\r
- * into the stream buffer.\r
- *\r
- * @param xTicksToWait The maximum amount of time the task should remain in the\r
- * Blocked state to wait for enough space to become available in the stream\r
- * buffer, should the stream buffer contain too little space to hold the\r
- * another xDataLengthBytes bytes. The block time is specified in tick periods,\r
- * so the absolute time it represents is dependent on the tick frequency. The\r
- * macro pdMS_TO_TICKS() can be used to convert a time specified in milliseconds\r
- * into a time specified in ticks. Setting xTicksToWait to portMAX_DELAY will\r
- * cause the task to wait indefinitely (without timing out), provided\r
- * INCLUDE_vTaskSuspend is set to 1 in FreeRTOSConfig.h. If a task times out\r
- * before it can write all xDataLengthBytes into the buffer it will still write\r
- * as many bytes as possible. A task does not use any CPU time when it is in\r
- * the blocked state.\r
- *\r
- * @return The number of bytes written to the stream buffer. If a task times\r
- * out before it can write all xDataLengthBytes into the buffer it will still\r
- * write as many bytes as possible.\r
- *\r
- * Example use:\r
-<pre>\r
-void vAFunction( StreamBufferHandle_t xStreamBuffer )\r
-{\r
-size_t xBytesSent;\r
-uint8_t ucArrayToSend[] = { 0, 1, 2, 3 };\r
-char *pcStringToSend = "String to send";\r
-const TickType_t x100ms = pdMS_TO_TICKS( 100 );\r
-\r
- // Send an array to the stream buffer, blocking for a maximum of 100ms to\r
- // wait for enough space to be available in the stream buffer.\r
- xBytesSent = xStreamBufferSend( xStreamBuffer, ( void * ) ucArrayToSend, sizeof( ucArrayToSend ), x100ms );\r
-\r
- if( xBytesSent != sizeof( ucArrayToSend ) )\r
- {\r
- // The call to xStreamBufferSend() times out before there was enough\r
- // space in the buffer for the data to be written, but it did\r
- // successfully write xBytesSent bytes.\r
- }\r
-\r
- // Send the string to the stream buffer. Return immediately if there is not\r
- // enough space in the buffer.\r
- xBytesSent = xStreamBufferSend( xStreamBuffer, ( void * ) pcStringToSend, strlen( pcStringToSend ), 0 );\r
-\r
- if( xBytesSent != strlen( pcStringToSend ) )\r
- {\r
- // The entire string could not be added to the stream buffer because\r
- // there was not enough free space in the buffer, but xBytesSent bytes\r
- // were sent. Could try again to send the remaining bytes.\r
- }\r
-}\r
-</pre>\r
- * \defgroup xStreamBufferSend xStreamBufferSend\r
- * \ingroup StreamBufferManagement\r
- */\r
-size_t xStreamBufferSend( StreamBufferHandle_t xStreamBuffer,\r
- const void *pvTxData,\r
- size_t xDataLengthBytes,\r
- TickType_t xTicksToWait ) PRIVILEGED_FUNCTION;\r
-\r
-/**\r
- * stream_buffer.h\r
- *\r
-<pre>\r
-size_t xStreamBufferSendFromISR( StreamBufferHandle_t xStreamBuffer,\r
- const void *pvTxData,\r
- size_t xDataLengthBytes,\r
- BaseType_t *pxHigherPriorityTaskWoken );\r
-<pre>\r
- *\r
- * Interrupt safe version of the API function that sends a stream of bytes to\r
- * the stream buffer.\r
- *\r
- * ***NOTE***: Uniquely among FreeRTOS objects, the stream buffer\r
- * implementation (so also the message buffer implementation, as message buffers\r
- * are built on top of stream buffers) assumes there is only one task or\r
- * interrupt that will write to the buffer (the writer), and only one task or\r
- * interrupt that will read from the buffer (the reader). It is safe for the\r
- * writer and reader to be different tasks or interrupts, but, unlike other\r
- * FreeRTOS objects, it is not safe to have multiple different writers or\r
- * multiple different readers. If there are to be multiple different writers\r
- * then the application writer must place each call to a writing API function\r
- * (such as xStreamBufferSend()) inside a critical section and set the send\r
- * block time to 0. Likewise, if there are to be multiple different readers\r
- * then the application writer must place each call to a reading API function\r
- * (such as xStreamBufferRead()) inside a critical section and set the receive\r
- * block time to 0.\r
- *\r
- * Use xStreamBufferSend() to write to a stream buffer from a task. Use\r
- * xStreamBufferSendFromISR() to write to a stream buffer from an interrupt\r
- * service routine (ISR).\r
- *\r
- * @param xStreamBuffer The handle of the stream buffer to which a stream is\r
- * being sent.\r
- *\r
- * @param pvTxData A pointer to the data that is to be copied into the stream\r
- * buffer.\r
- *\r
- * @param xDataLengthBytes The maximum number of bytes to copy from pvTxData\r
- * into the stream buffer.\r
- *\r
- * @param pxHigherPriorityTaskWoken It is possible that a stream buffer will\r
- * have a task blocked on it waiting for data. Calling\r
- * xStreamBufferSendFromISR() can make data available, and so cause a task that\r
- * was waiting for data to leave the Blocked state. If calling\r
- * xStreamBufferSendFromISR() causes a task to leave the Blocked state, and the\r
- * unblocked task has a priority higher than the currently executing task (the\r
- * task that was interrupted), then, internally, xStreamBufferSendFromISR()\r
- * will set *pxHigherPriorityTaskWoken to pdTRUE. If\r
- * xStreamBufferSendFromISR() sets this value to pdTRUE, then normally a\r
- * context switch should be performed before the interrupt is exited. This will\r
- * ensure that the interrupt returns directly to the highest priority Ready\r
- * state task. *pxHigherPriorityTaskWoken should be set to pdFALSE before it\r
- * is passed into the function. See the example code below for an example.\r
- *\r
- * @return The number of bytes actually written to the stream buffer, which will\r
- * be less than xDataLengthBytes if the stream buffer didn't have enough free\r
- * space for all the bytes to be written.\r
- *\r
- * Example use:\r
-<pre>\r
-// A stream buffer that has already been created.\r
-StreamBufferHandle_t xStreamBuffer;\r
-\r
-void vAnInterruptServiceRoutine( void )\r
-{\r
-size_t xBytesSent;\r
-char *pcStringToSend = "String to send";\r
-BaseType_t xHigherPriorityTaskWoken = pdFALSE; // Initialised to pdFALSE.\r
-\r
- // Attempt to send the string to the stream buffer.\r
- xBytesSent = xStreamBufferSendFromISR( xStreamBuffer,\r
- ( void * ) pcStringToSend,\r
- strlen( pcStringToSend ),\r
- &xHigherPriorityTaskWoken );\r
-\r
- if( xBytesSent != strlen( pcStringToSend ) )\r
- {\r
- // There was not enough free space in the stream buffer for the entire\r
- // string to be written, ut xBytesSent bytes were written.\r
- }\r
-\r
- // If xHigherPriorityTaskWoken was set to pdTRUE inside\r
- // xStreamBufferSendFromISR() then a task that has a priority above the\r
- // priority of the currently executing task was unblocked and a context\r
- // switch should be performed to ensure the ISR returns to the unblocked\r
- // task. In most FreeRTOS ports this is done by simply passing\r
- // xHigherPriorityTaskWoken into taskYIELD_FROM_ISR(), which will test the\r
- // variables value, and perform the context switch if necessary. Check the\r
- // documentation for the port in use for port specific instructions.\r
- taskYIELD_FROM_ISR( xHigherPriorityTaskWoken );\r
-}\r
-</pre>\r
- * \defgroup xStreamBufferSendFromISR xStreamBufferSendFromISR\r
- * \ingroup StreamBufferManagement\r
- */\r
-size_t xStreamBufferSendFromISR( StreamBufferHandle_t xStreamBuffer,\r
- const void *pvTxData,\r
- size_t xDataLengthBytes,\r
- BaseType_t * const pxHigherPriorityTaskWoken ) PRIVILEGED_FUNCTION;\r
-\r
-/**\r
- * stream_buffer.h\r
- *\r
-<pre>\r
-size_t xStreamBufferReceive( StreamBufferHandle_t xStreamBuffer,\r
- void *pvRxData,\r
- size_t xBufferLengthBytes,\r
- TickType_t xTicksToWait );\r
-</pre>\r
- *\r
- * Receives bytes from a stream buffer.\r
- *\r
- * ***NOTE***: Uniquely among FreeRTOS objects, the stream buffer\r
- * implementation (so also the message buffer implementation, as message buffers\r
- * are built on top of stream buffers) assumes there is only one task or\r
- * interrupt that will write to the buffer (the writer), and only one task or\r
- * interrupt that will read from the buffer (the reader). It is safe for the\r
- * writer and reader to be different tasks or interrupts, but, unlike other\r
- * FreeRTOS objects, it is not safe to have multiple different writers or\r
- * multiple different readers. If there are to be multiple different writers\r
- * then the application writer must place each call to a writing API function\r
- * (such as xStreamBufferSend()) inside a critical section and set the send\r
- * block time to 0. Likewise, if there are to be multiple different readers\r
- * then the application writer must place each call to a reading API function\r
- * (such as xStreamBufferRead()) inside a critical section and set the receive\r
- * block time to 0.\r
- *\r
- * Use xStreamBufferReceive() to read from a stream buffer from a task. Use\r
- * xStreamBufferReceiveFromISR() to read from a stream buffer from an\r
- * interrupt service routine (ISR).\r
- *\r
- * @param xStreamBuffer The handle of the stream buffer from which bytes are to\r
- * be received.\r
- *\r
- * @param pvRxData A pointer to the buffer into which the received bytes will be\r
- * copied.\r
- *\r
- * @param xBufferLengthBytes The length of the buffer pointed to by the\r
- * pvRxData parameter. This sets the maximum number of bytes to receive in one\r
- * call. xStreamBufferReceive will return as many bytes as possible up to a\r
- * maximum set by xBufferLengthBytes.\r
- *\r
- * @param xTicksToWait The maximum amount of time the task should remain in the\r
- * Blocked state to wait for data to become available if the stream buffer is\r
- * empty. xStreamBufferReceive() will return immediately if xTicksToWait is\r
- * zero. The block time is specified in tick periods, so the absolute time it\r
- * represents is dependent on the tick frequency. The macro pdMS_TO_TICKS() can\r
- * be used to convert a time specified in milliseconds into a time specified in\r
- * ticks. Setting xTicksToWait to portMAX_DELAY will cause the task to wait\r
- * indefinitely (without timing out), provided INCLUDE_vTaskSuspend is set to 1\r
- * in FreeRTOSConfig.h. A task does not use any CPU time when it is in the\r
- * Blocked state.\r
- *\r
- * @return The number of bytes actually read from the stream buffer, which will\r
- * be less than xBufferLengthBytes if the call to xStreamBufferReceive() timed\r
- * out before xBufferLengthBytes were available.\r
- *\r
- * Example use:\r
-<pre>\r
-void vAFunction( StreamBuffer_t xStreamBuffer )\r
-{\r
-uint8_t ucRxData[ 20 ];\r
-size_t xReceivedBytes;\r
-const TickType_t xBlockTime = pdMS_TO_TICKS( 20 );\r
-\r
- // Receive up to another sizeof( ucRxData ) bytes from the stream buffer.\r
- // Wait in the Blocked state (so not using any CPU processing time) for a\r
- // maximum of 100ms for the full sizeof( ucRxData ) number of bytes to be\r
- // available.\r
- xReceivedBytes = xStreamBufferReceive( xStreamBuffer,\r
- ( void * ) ucRxData,\r
- sizeof( ucRxData ),\r
- xBlockTime );\r
-\r
- if( xReceivedBytes > 0 )\r
- {\r
- // A ucRxData contains another xRecievedBytes bytes of data, which can\r
- // be processed here....\r
- }\r
-}\r
-</pre>\r
- * \defgroup xStreamBufferReceive xStreamBufferReceive\r
- * \ingroup StreamBufferManagement\r
- */\r
-size_t xStreamBufferReceive( StreamBufferHandle_t xStreamBuffer,\r
- void *pvRxData,\r
- size_t xBufferLengthBytes,\r
- TickType_t xTicksToWait ) PRIVILEGED_FUNCTION;\r
-\r
-/**\r
- * stream_buffer.h\r
- *\r
-<pre>\r
-size_t xStreamBufferReceiveFromISR( StreamBufferHandle_t xStreamBuffer,\r
- void *pvRxData,\r
- size_t xBufferLengthBytes,\r
- BaseType_t *pxHigherPriorityTaskWoken );\r
-</pre>\r
- *\r
- * An interrupt safe version of the API function that receives bytes from a\r
- * stream buffer.\r
- *\r
- * Use xStreamBufferReceive() to read bytes from a stream buffer from a task.\r
- * Use xStreamBufferReceiveFromISR() to read bytes from a stream buffer from an\r
- * interrupt service routine (ISR).\r
- *\r
- * @param xStreamBuffer The handle of the stream buffer from which a stream\r
- * is being received.\r
- *\r
- * @param pvRxData A pointer to the buffer into which the received bytes are\r
- * copied.\r
- *\r
- * @param xBufferLengthBytes The length of the buffer pointed to by the\r
- * pvRxData parameter. This sets the maximum number of bytes to receive in one\r
- * call. xStreamBufferReceive will return as many bytes as possible up to a\r
- * maximum set by xBufferLengthBytes.\r
- *\r
- * @param pxHigherPriorityTaskWoken It is possible that a stream buffer will\r
- * have a task blocked on it waiting for space to become available. Calling\r
- * xStreamBufferReceiveFromISR() can make space available, and so cause a task\r
- * that is waiting for space to leave the Blocked state. If calling\r
- * xStreamBufferReceiveFromISR() causes a task to leave the Blocked state, and\r
- * the unblocked task has a priority higher than the currently executing task\r
- * (the task that was interrupted), then, internally,\r
- * xStreamBufferReceiveFromISR() will set *pxHigherPriorityTaskWoken to pdTRUE.\r
- * If xStreamBufferReceiveFromISR() sets this value to pdTRUE, then normally a\r
- * context switch should be performed before the interrupt is exited. That will\r
- * ensure the interrupt returns directly to the highest priority Ready state\r
- * task. *pxHigherPriorityTaskWoken should be set to pdFALSE before it is\r
- * passed into the function. See the code example below for an example.\r
- *\r
- * @return The number of bytes read from the stream buffer, if any.\r
- *\r
- * Example use:\r
-<pre>\r
-// A stream buffer that has already been created.\r
-StreamBuffer_t xStreamBuffer;\r
-\r
-void vAnInterruptServiceRoutine( void )\r
-{\r
-uint8_t ucRxData[ 20 ];\r
-size_t xReceivedBytes;\r
-BaseType_t xHigherPriorityTaskWoken = pdFALSE; // Initialised to pdFALSE.\r
-\r
- // Receive the next stream from the stream buffer.\r
- xReceivedBytes = xStreamBufferReceiveFromISR( xStreamBuffer,\r
- ( void * ) ucRxData,\r
- sizeof( ucRxData ),\r
- &xHigherPriorityTaskWoken );\r
-\r
- if( xReceivedBytes > 0 )\r
- {\r
- // ucRxData contains xReceivedBytes read from the stream buffer.\r
- // Process the stream here....\r
- }\r
-\r
- // If xHigherPriorityTaskWoken was set to pdTRUE inside\r
- // xStreamBufferReceiveFromISR() then a task that has a priority above the\r
- // priority of the currently executing task was unblocked and a context\r
- // switch should be performed to ensure the ISR returns to the unblocked\r
- // task. In most FreeRTOS ports this is done by simply passing\r
- // xHigherPriorityTaskWoken into taskYIELD_FROM_ISR(), which will test the\r
- // variables value, and perform the context switch if necessary. Check the\r
- // documentation for the port in use for port specific instructions.\r
- taskYIELD_FROM_ISR( xHigherPriorityTaskWoken );\r
-}\r
-</pre>\r
- * \defgroup xStreamBufferReceiveFromISR xStreamBufferReceiveFromISR\r
- * \ingroup StreamBufferManagement\r
- */\r
-size_t xStreamBufferReceiveFromISR( StreamBufferHandle_t xStreamBuffer,\r
- void *pvRxData,\r
- size_t xBufferLengthBytes,\r
- BaseType_t * const pxHigherPriorityTaskWoken ) PRIVILEGED_FUNCTION;\r
-\r
-/**\r
- * stream_buffer.h\r
- *\r
-<pre>\r
-void vStreamBufferDelete( StreamBufferHandle_t xStreamBuffer );\r
-</pre>\r
- *\r
- * Deletes a stream buffer that was previously created using a call to\r
- * xStreamBufferCreate() or xStreamBufferCreateStatic(). If the stream\r
- * buffer was created using dynamic memory (that is, by xStreamBufferCreate()),\r
- * then the allocated memory is freed.\r
- *\r
- * A stream buffer handle must not be used after the stream buffer has been\r
- * deleted.\r
- *\r
- * @param xStreamBuffer The handle of the stream buffer to be deleted.\r
- *\r
- * \defgroup vStreamBufferDelete vStreamBufferDelete\r
- * \ingroup StreamBufferManagement\r
- */\r
-void vStreamBufferDelete( StreamBufferHandle_t xStreamBuffer ) PRIVILEGED_FUNCTION;\r
-\r
-/**\r
- * stream_buffer.h\r
- *\r
-<pre>\r
-BaseType_t xStreamBufferIsFull( StreamBufferHandle_t xStreamBuffer );\r
-</pre>\r
- *\r
- * Queries a stream buffer to see if it is full. A stream buffer is full if it\r
- * does not have any free space, and therefore cannot accept any more data.\r
- *\r
- * @param xStreamBuffer The handle of the stream buffer being queried.\r
- *\r
- * @return If the stream buffer is full then pdTRUE is returned. Otherwise\r
- * pdFALSE is returned.\r
- *\r
- * \defgroup xStreamBufferIsFull xStreamBufferIsFull\r
- * \ingroup StreamBufferManagement\r
- */\r
-BaseType_t xStreamBufferIsFull( StreamBufferHandle_t xStreamBuffer ) PRIVILEGED_FUNCTION;\r
-\r
-/**\r
- * stream_buffer.h\r
- *\r
-<pre>\r
-BaseType_t xStreamBufferIsEmpty( StreamBufferHandle_t xStreamBuffer );\r
-</pre>\r
- *\r
- * Queries a stream buffer to see if it is empty. A stream buffer is empty if\r
- * it does not contain any data.\r
- *\r
- * @param xStreamBuffer The handle of the stream buffer being queried.\r
- *\r
- * @return If the stream buffer is empty then pdTRUE is returned. Otherwise\r
- * pdFALSE is returned.\r
- *\r
- * \defgroup xStreamBufferIsEmpty xStreamBufferIsEmpty\r
- * \ingroup StreamBufferManagement\r
- */\r
-BaseType_t xStreamBufferIsEmpty( StreamBufferHandle_t xStreamBuffer ) PRIVILEGED_FUNCTION;\r
-\r
-/**\r
- * stream_buffer.h\r
- *\r
-<pre>\r
-BaseType_t xStreamBufferReset( StreamBufferHandle_t xStreamBuffer );\r
-</pre>\r
- *\r
- * Resets a stream buffer to its initial, empty, state. Any data that was in\r
- * the stream buffer is discarded. A stream buffer can only be reset if there\r
- * are no tasks blocked waiting to either send to or receive from the stream\r
- * buffer.\r
- *\r
- * @param xStreamBuffer The handle of the stream buffer being reset.\r
- *\r
- * @return If the stream buffer is reset then pdPASS is returned. If there was\r
- * a task blocked waiting to send to or read from the stream buffer then the\r
- * stream buffer is not reset and pdFAIL is returned.\r
- *\r
- * \defgroup xStreamBufferReset xStreamBufferReset\r
- * \ingroup StreamBufferManagement\r
- */\r
-BaseType_t xStreamBufferReset( StreamBufferHandle_t xStreamBuffer ) PRIVILEGED_FUNCTION;\r
-\r
-/**\r
- * stream_buffer.h\r
- *\r
-<pre>\r
-size_t xStreamBufferSpacesAvailable( StreamBufferHandle_t xStreamBuffer );\r
-</pre>\r
- *\r
- * Queries a stream buffer to see how much free space it contains, which is\r
- * equal to the amount of data that can be sent to the stream buffer before it\r
- * is full.\r
- *\r
- * @param xStreamBuffer The handle of the stream buffer being queried.\r
- *\r
- * @return The number of bytes that can be written to the stream buffer before\r
- * the stream buffer would be full.\r
- *\r
- * \defgroup xStreamBufferSpacesAvailable xStreamBufferSpacesAvailable\r
- * \ingroup StreamBufferManagement\r
- */\r
-size_t xStreamBufferSpacesAvailable( StreamBufferHandle_t xStreamBuffer ) PRIVILEGED_FUNCTION;\r
-\r
-/**\r
- * stream_buffer.h\r
- *\r
-<pre>\r
-size_t xStreamBufferBytesAvailable( StreamBufferHandle_t xStreamBuffer );\r
-</pre>\r
- *\r
- * Queries a stream buffer to see how much data it contains, which is equal to\r
- * the number of bytes that can be read from the stream buffer before the stream\r
- * buffer would be empty.\r
- *\r
- * @param xStreamBuffer The handle of the stream buffer being queried.\r
- *\r
- * @return The number of bytes that can be read from the stream buffer before\r
- * the stream buffer would be empty.\r
- *\r
- * \defgroup xStreamBufferBytesAvailable xStreamBufferBytesAvailable\r
- * \ingroup StreamBufferManagement\r
- */\r
-size_t xStreamBufferBytesAvailable( StreamBufferHandle_t xStreamBuffer ) PRIVILEGED_FUNCTION;\r
-\r
-/**\r
- * stream_buffer.h\r
- *\r
-<pre>\r
-BaseType_t xStreamBufferSetTriggerLevel( StreamBufferHandle_t xStreamBuffer, size_t xTriggerLevel );\r
-</pre>\r
- *\r
- * A stream buffer's trigger level is the number of bytes that must be in the\r
- * stream buffer before a task that is blocked on the stream buffer to\r
- * wait for data is moved out of the blocked state. For example, if a task is\r
- * blocked on a read of an empty stream buffer that has a trigger level of 1\r
- * then the task will be unblocked when a single byte is written to the buffer\r
- * or the task's block time expires. As another example, if a task is blocked\r
- * on a read of an empty stream buffer that has a trigger level of 10 then the\r
- * task will not be unblocked until the stream buffer contains at least 10 bytes\r
- * or the task's block time expires. If a reading task's block time expires\r
- * before the trigger level is reached then the task will still receive however\r
- * many bytes are actually available. Setting a trigger level of 0 will result\r
- * in a trigger level of 1 being used. It is not valid to specify a trigger\r
- * level that is greater than the buffer size.\r
- *\r
- * A trigger level is set when the stream buffer is created, and can be modified\r
- * using xStreamBufferSetTriggerLevel().\r
- *\r
- * @param xStreamBuffer The handle of the stream buffer being updated.\r
- *\r
- * @param xTriggerLevel The new trigger level for the stream buffer.\r
- *\r
- * @return If xTriggerLevel was less than or equal to the stream buffer's length\r
- * then the trigger level will be updated and pdTRUE is returned. Otherwise\r
- * pdFALSE is returned.\r
- *\r
- * \defgroup xStreamBufferSetTriggerLevel xStreamBufferSetTriggerLevel\r
- * \ingroup StreamBufferManagement\r
- */\r
-BaseType_t xStreamBufferSetTriggerLevel( StreamBufferHandle_t xStreamBuffer, size_t xTriggerLevel ) PRIVILEGED_FUNCTION;\r
-\r
-/**\r
- * stream_buffer.h\r
- *\r
-<pre>\r
-BaseType_t xStreamBufferSendCompletedFromISR( StreamBufferHandle_t xStreamBuffer, BaseType_t *pxHigherPriorityTaskWoken );\r
-</pre>\r
- *\r
- * For advanced users only.\r
- *\r
- * The sbSEND_COMPLETED() macro is called from within the FreeRTOS APIs when\r
- * data is sent to a message buffer or stream buffer. If there was a task that\r
- * was blocked on the message or stream buffer waiting for data to arrive then\r
- * the sbSEND_COMPLETED() macro sends a notification to the task to remove it\r
- * from the Blocked state. xStreamBufferSendCompletedFromISR() does the same\r
- * thing. It is provided to enable application writers to implement their own\r
- * version of sbSEND_COMPLETED(), and MUST NOT BE USED AT ANY OTHER TIME.\r
- *\r
- * See the example implemented in FreeRTOS/Demo/Minimal/MessageBufferAMP.c for\r
- * additional information.\r
- *\r
- * @param xStreamBuffer The handle of the stream buffer to which data was\r
- * written.\r
- *\r
- * @param pxHigherPriorityTaskWoken *pxHigherPriorityTaskWoken should be\r
- * initialised to pdFALSE before it is passed into\r
- * xStreamBufferSendCompletedFromISR(). If calling\r
- * xStreamBufferSendCompletedFromISR() removes a task from the Blocked state,\r
- * and the task has a priority above the priority of the currently running task,\r
- * then *pxHigherPriorityTaskWoken will get set to pdTRUE indicating that a\r
- * context switch should be performed before exiting the ISR.\r
- *\r
- * @return If a task was removed from the Blocked state then pdTRUE is returned.\r
- * Otherwise pdFALSE is returned.\r
- *\r
- * \defgroup xStreamBufferSendCompletedFromISR xStreamBufferSendCompletedFromISR\r
- * \ingroup StreamBufferManagement\r
- */\r
-BaseType_t xStreamBufferSendCompletedFromISR( StreamBufferHandle_t xStreamBuffer, BaseType_t *pxHigherPriorityTaskWoken ) PRIVILEGED_FUNCTION;\r
-\r
-/**\r
- * stream_buffer.h\r
- *\r
-<pre>\r
-BaseType_t xStreamBufferReceiveCompletedFromISR( StreamBufferHandle_t xStreamBuffer, BaseType_t *pxHigherPriorityTaskWoken );\r
-</pre>\r
- *\r
- * For advanced users only.\r
- *\r
- * The sbRECEIVE_COMPLETED() macro is called from within the FreeRTOS APIs when\r
- * data is read out of a message buffer or stream buffer. If there was a task\r
- * that was blocked on the message or stream buffer waiting for data to arrive\r
- * then the sbRECEIVE_COMPLETED() macro sends a notification to the task to\r
- * remove it from the Blocked state. xStreamBufferReceiveCompletedFromISR()\r
- * does the same thing. It is provided to enable application writers to\r
- * implement their own version of sbRECEIVE_COMPLETED(), and MUST NOT BE USED AT\r
- * ANY OTHER TIME.\r
- *\r
- * See the example implemented in FreeRTOS/Demo/Minimal/MessageBufferAMP.c for\r
- * additional information.\r
- *\r
- * @param xStreamBuffer The handle of the stream buffer from which data was\r
- * read.\r
- *\r
- * @param pxHigherPriorityTaskWoken *pxHigherPriorityTaskWoken should be\r
- * initialised to pdFALSE before it is passed into\r
- * xStreamBufferReceiveCompletedFromISR(). If calling\r
- * xStreamBufferReceiveCompletedFromISR() removes a task from the Blocked state,\r
- * and the task has a priority above the priority of the currently running task,\r
- * then *pxHigherPriorityTaskWoken will get set to pdTRUE indicating that a\r
- * context switch should be performed before exiting the ISR.\r
- *\r
- * @return If a task was removed from the Blocked state then pdTRUE is returned.\r
- * Otherwise pdFALSE is returned.\r
- *\r
- * \defgroup xStreamBufferReceiveCompletedFromISR xStreamBufferReceiveCompletedFromISR\r
- * \ingroup StreamBufferManagement\r
- */\r
-BaseType_t xStreamBufferReceiveCompletedFromISR( StreamBufferHandle_t xStreamBuffer, BaseType_t *pxHigherPriorityTaskWoken ) PRIVILEGED_FUNCTION;\r
-\r
-/* Functions below here are not part of the public API. */\r
-StreamBufferHandle_t xStreamBufferGenericCreate( size_t xBufferSizeBytes,\r
- size_t xTriggerLevelBytes,\r
- BaseType_t xIsMessageBuffer ) PRIVILEGED_FUNCTION;\r
-\r
-StreamBufferHandle_t xStreamBufferGenericCreateStatic( size_t xBufferSizeBytes,\r
- size_t xTriggerLevelBytes,\r
- BaseType_t xIsMessageBuffer,\r
- uint8_t * const pucStreamBufferStorageArea,\r
- StaticStreamBuffer_t * const pxStaticStreamBuffer ) PRIVILEGED_FUNCTION;\r
-\r
-#if( configUSE_TRACE_FACILITY == 1 )\r
- void vStreamBufferSetStreamBufferNumber( StreamBufferHandle_t xStreamBuffer, UBaseType_t uxStreamBufferNumber ) PRIVILEGED_FUNCTION;\r
- UBaseType_t uxStreamBufferGetStreamBufferNumber( StreamBufferHandle_t xStreamBuffer ) PRIVILEGED_FUNCTION;\r
- uint8_t ucStreamBufferGetStreamBufferType( StreamBufferHandle_t xStreamBuffer ) PRIVILEGED_FUNCTION;\r
-#endif\r
-\r
-#if defined( __cplusplus )\r
-}\r
-#endif\r
-\r
-#endif /* !defined( STREAM_BUFFER_H ) */\r
+++ /dev/null
-/*\r
- * FreeRTOS Kernel V10.0.1\r
- * Copyright (C) 2017 Amazon.com, Inc. or its affiliates. All Rights Reserved.\r
- *\r
- * Permission is hereby granted, free of charge, to any person obtaining a copy of\r
- * this software and associated documentation files (the "Software"), to deal in\r
- * the Software without restriction, including without limitation the rights to\r
- * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of\r
- * the Software, and to permit persons to whom the Software is furnished to do so,\r
- * subject to the following conditions:\r
- *\r
- * The above copyright notice and this permission notice shall be included in all\r
- * copies or substantial portions of the Software.\r
- *\r
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\r
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS\r
- * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR\r
- * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER\r
- * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN\r
- * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\r
- *\r
- * http://www.FreeRTOS.org\r
- * http://aws.amazon.com/freertos\r
- *\r
- * 1 tab == 4 spaces!\r
- */\r
-\r
-\r
-#ifndef INC_TASK_H\r
-#define INC_TASK_H\r
-\r
-#ifndef INC_FREERTOS_H\r
- #error "include FreeRTOS.h must appear in source files before include task.h"\r
-#endif\r
-\r
-#include "list.h"\r
-\r
-#ifdef __cplusplus\r
-extern "C" {\r
-#endif\r
-\r
-/*-----------------------------------------------------------\r
- * MACROS AND DEFINITIONS\r
- *----------------------------------------------------------*/\r
-\r
-#define tskKERNEL_VERSION_NUMBER "V10.0.1"\r
-#define tskKERNEL_VERSION_MAJOR 10\r
-#define tskKERNEL_VERSION_MINOR 0\r
-#define tskKERNEL_VERSION_BUILD 1\r
-\r
-/**\r
- * task. h\r
- *\r
- * Type by which tasks are referenced. For example, a call to xTaskCreate\r
- * returns (via a pointer parameter) an TaskHandle_t variable that can then\r
- * be used as a parameter to vTaskDelete to delete the task.\r
- *\r
- * \defgroup TaskHandle_t TaskHandle_t\r
- * \ingroup Tasks\r
- */\r
-typedef void * TaskHandle_t;\r
-\r
-/*\r
- * Defines the prototype to which the application task hook function must\r
- * conform.\r
- */\r
-typedef BaseType_t (*TaskHookFunction_t)( void * );\r
-\r
-/* Task states returned by eTaskGetState. */\r
-typedef enum\r
-{\r
- eRunning = 0, /* A task is querying the state of itself, so must be running. */\r
- eReady, /* The task being queried is in a read or pending ready list. */\r
- eBlocked, /* The task being queried is in the Blocked state. */\r
- eSuspended, /* The task being queried is in the Suspended state, or is in the Blocked state with an infinite time out. */\r
- eDeleted, /* The task being queried has been deleted, but its TCB has not yet been freed. */\r
- eInvalid /* Used as an 'invalid state' value. */\r
-} eTaskState;\r
-\r
-/* Actions that can be performed when vTaskNotify() is called. */\r
-typedef enum\r
-{\r
- eNoAction = 0, /* Notify the task without updating its notify value. */\r
- eSetBits, /* Set bits in the task's notification value. */\r
- eIncrement, /* Increment the task's notification value. */\r
- eSetValueWithOverwrite, /* Set the task's notification value to a specific value even if the previous value has not yet been read by the task. */\r
- eSetValueWithoutOverwrite /* Set the task's notification value if the previous value has been read by the task. */\r
-} eNotifyAction;\r
-\r
-/*\r
- * Used internally only.\r
- */\r
-typedef struct xTIME_OUT\r
-{\r
- BaseType_t xOverflowCount;\r
- TickType_t xTimeOnEntering;\r
-} TimeOut_t;\r
-\r
-/*\r
- * Defines the memory ranges allocated to the task when an MPU is used.\r
- */\r
-typedef struct xMEMORY_REGION\r
-{\r
- void *pvBaseAddress;\r
- uint32_t ulLengthInBytes;\r
- uint32_t ulParameters;\r
-} MemoryRegion_t;\r
-\r
-/*\r
- * Parameters required to create an MPU protected task.\r
- */\r
-typedef struct xTASK_PARAMETERS\r
-{\r
- TaskFunction_t pvTaskCode;\r
- const char * const pcName; /*lint !e971 Unqualified char types are allowed for strings and single characters only. */\r
- uint16_t usStackDepth;\r
- void *pvParameters;\r
- UBaseType_t uxPriority;\r
- StackType_t *puxStackBuffer;\r
- MemoryRegion_t xRegions[ portNUM_CONFIGURABLE_REGIONS ];\r
- #if ( ( portUSING_MPU_WRAPPERS == 1 ) && ( configSUPPORT_STATIC_ALLOCATION == 1 ) )\r
- StaticTask_t * const pxTaskBuffer;\r
- #endif\r
-} TaskParameters_t;\r
-\r
-/* Used with the uxTaskGetSystemState() function to return the state of each task\r
-in the system. */\r
-typedef struct xTASK_STATUS\r
-{\r
- TaskHandle_t xHandle; /* The handle of the task to which the rest of the information in the structure relates. */\r
- const char *pcTaskName; /* A pointer to the task's name. This value will be invalid if the task was deleted since the structure was populated! */ /*lint !e971 Unqualified char types are allowed for strings and single characters only. */\r
- UBaseType_t xTaskNumber; /* A number unique to the task. */\r
- eTaskState eCurrentState; /* The state in which the task existed when the structure was populated. */\r
- UBaseType_t uxCurrentPriority; /* The priority at which the task was running (may be inherited) when the structure was populated. */\r
- UBaseType_t uxBasePriority; /* The priority to which the task will return if the task's current priority has been inherited to avoid unbounded priority inversion when obtaining a mutex. Only valid if configUSE_MUTEXES is defined as 1 in FreeRTOSConfig.h. */\r
- uint32_t ulRunTimeCounter; /* The total run time allocated to the task so far, as defined by the run time stats clock. See http://www.freertos.org/rtos-run-time-stats.html. Only valid when configGENERATE_RUN_TIME_STATS is defined as 1 in FreeRTOSConfig.h. */\r
- StackType_t *pxStackBase; /* Points to the lowest address of the task's stack area. */\r
- uint16_t usStackHighWaterMark; /* The minimum amount of stack space that has remained for the task since the task was created. The closer this value is to zero the closer the task has come to overflowing its stack. */\r
-} TaskStatus_t;\r
-\r
-/* Possible return values for eTaskConfirmSleepModeStatus(). */\r
-typedef enum\r
-{\r
- eAbortSleep = 0, /* A task has been made ready or a context switch pended since portSUPPORESS_TICKS_AND_SLEEP() was called - abort entering a sleep mode. */\r
- eStandardSleep, /* Enter a sleep mode that will not last any longer than the expected idle time. */\r
- eNoTasksWaitingTimeout /* No tasks are waiting for a timeout so it is safe to enter a sleep mode that can only be exited by an external interrupt. */\r
-} eSleepModeStatus;\r
-\r
-/**\r
- * Defines the priority used by the idle task. This must not be modified.\r
- *\r
- * \ingroup TaskUtils\r
- */\r
-#define tskIDLE_PRIORITY ( ( UBaseType_t ) 0U )\r
-\r
-/**\r
- * task. h\r
- *\r
- * Macro for forcing a context switch.\r
- *\r
- * \defgroup taskYIELD taskYIELD\r
- * \ingroup SchedulerControl\r
- */\r
-#define taskYIELD() portYIELD()\r
-\r
-/**\r
- * task. h\r
- *\r
- * Macro to mark the start of a critical code region. Preemptive context\r
- * switches cannot occur when in a critical region.\r
- *\r
- * NOTE: This may alter the stack (depending on the portable implementation)\r
- * so must be used with care!\r
- *\r
- * \defgroup taskENTER_CRITICAL taskENTER_CRITICAL\r
- * \ingroup SchedulerControl\r
- */\r
-#define taskENTER_CRITICAL() portENTER_CRITICAL()\r
-#define taskENTER_CRITICAL_FROM_ISR() portSET_INTERRUPT_MASK_FROM_ISR()\r
-\r
-/**\r
- * task. h\r
- *\r
- * Macro to mark the end of a critical code region. Preemptive context\r
- * switches cannot occur when in a critical region.\r
- *\r
- * NOTE: This may alter the stack (depending on the portable implementation)\r
- * so must be used with care!\r
- *\r
- * \defgroup taskEXIT_CRITICAL taskEXIT_CRITICAL\r
- * \ingroup SchedulerControl\r
- */\r
-#define taskEXIT_CRITICAL() portEXIT_CRITICAL()\r
-#define taskEXIT_CRITICAL_FROM_ISR( x ) portCLEAR_INTERRUPT_MASK_FROM_ISR( x )\r
-/**\r
- * task. h\r
- *\r
- * Macro to disable all maskable interrupts.\r
- *\r
- * \defgroup taskDISABLE_INTERRUPTS taskDISABLE_INTERRUPTS\r
- * \ingroup SchedulerControl\r
- */\r
-#define taskDISABLE_INTERRUPTS() portDISABLE_INTERRUPTS()\r
-\r
-/**\r
- * task. h\r
- *\r
- * Macro to enable microcontroller interrupts.\r
- *\r
- * \defgroup taskENABLE_INTERRUPTS taskENABLE_INTERRUPTS\r
- * \ingroup SchedulerControl\r
- */\r
-#define taskENABLE_INTERRUPTS() portENABLE_INTERRUPTS()\r
-\r
-/* Definitions returned by xTaskGetSchedulerState(). taskSCHEDULER_SUSPENDED is\r
-0 to generate more optimal code when configASSERT() is defined as the constant\r
-is used in assert() statements. */\r
-#define taskSCHEDULER_SUSPENDED ( ( BaseType_t ) 0 )\r
-#define taskSCHEDULER_NOT_STARTED ( ( BaseType_t ) 1 )\r
-#define taskSCHEDULER_RUNNING ( ( BaseType_t ) 2 )\r
-\r
-\r
-/*-----------------------------------------------------------\r
- * TASK CREATION API\r
- *----------------------------------------------------------*/\r
-\r
-/**\r
- * task. h\r
- *<pre>\r
- BaseType_t xTaskCreate(\r
- TaskFunction_t pvTaskCode,\r
- const char * const pcName,\r
- configSTACK_DEPTH_TYPE usStackDepth,\r
- void *pvParameters,\r
- UBaseType_t uxPriority,\r
- TaskHandle_t *pvCreatedTask\r
- );</pre>\r
- *\r
- * Create a new task and add it to the list of tasks that are ready to run.\r
- *\r
- * Internally, within the FreeRTOS implementation, tasks use two blocks of\r
- * memory. The first block is used to hold the task's data structures. The\r
- * second block is used by the task as its stack. If a task is created using\r
- * xTaskCreate() then both blocks of memory are automatically dynamically\r
- * allocated inside the xTaskCreate() function. (see\r
- * http://www.freertos.org/a00111.html). If a task is created using\r
- * xTaskCreateStatic() then the application writer must provide the required\r
- * memory. xTaskCreateStatic() therefore allows a task to be created without\r
- * using any dynamic memory allocation.\r
- *\r
- * See xTaskCreateStatic() for a version that does not use any dynamic memory\r
- * allocation.\r
- *\r
- * xTaskCreate() can only be used to create a task that has unrestricted\r
- * access to the entire microcontroller memory map. Systems that include MPU\r
- * support can alternatively create an MPU constrained task using\r
- * xTaskCreateRestricted().\r
- *\r
- * @param pvTaskCode Pointer to the task entry function. Tasks\r
- * must be implemented to never return (i.e. continuous loop).\r
- *\r
- * @param pcName A descriptive name for the task. This is mainly used to\r
- * facilitate debugging. Max length defined by configMAX_TASK_NAME_LEN - default\r
- * is 16.\r
- *\r
- * @param usStackDepth The size of the task stack specified as the number of\r
- * variables the stack can hold - not the number of bytes. For example, if\r
- * the stack is 16 bits wide and usStackDepth is defined as 100, 200 bytes\r
- * will be allocated for stack storage.\r
- *\r
- * @param pvParameters Pointer that will be used as the parameter for the task\r
- * being created.\r
- *\r
- * @param uxPriority The priority at which the task should run. Systems that\r
- * include MPU support can optionally create tasks in a privileged (system)\r
- * mode by setting bit portPRIVILEGE_BIT of the priority parameter. For\r
- * example, to create a privileged task at priority 2 the uxPriority parameter\r
- * should be set to ( 2 | portPRIVILEGE_BIT ).\r
- *\r
- * @param pvCreatedTask Used to pass back a handle by which the created task\r
- * can be referenced.\r
- *\r
- * @return pdPASS if the task was successfully created and added to a ready\r
- * list, otherwise an error code defined in the file projdefs.h\r
- *\r
- * Example usage:\r
- <pre>\r
- // Task to be created.\r
- void vTaskCode( void * pvParameters )\r
- {\r
- for( ;; )\r
- {\r
- // Task code goes here.\r
- }\r
- }\r
-\r
- // Function that creates a task.\r
- void vOtherFunction( void )\r
- {\r
- static uint8_t ucParameterToPass;\r
- TaskHandle_t xHandle = NULL;\r
-\r
- // Create the task, storing the handle. Note that the passed parameter ucParameterToPass\r
- // must exist for the lifetime of the task, so in this case is declared static. If it was just an\r
- // an automatic stack variable it might no longer exist, or at least have been corrupted, by the time\r
- // the new task attempts to access it.\r
- xTaskCreate( vTaskCode, "NAME", STACK_SIZE, &ucParameterToPass, tskIDLE_PRIORITY, &xHandle );\r
- configASSERT( xHandle );\r
-\r
- // Use the handle to delete the task.\r
- if( xHandle != NULL )\r
- {\r
- vTaskDelete( xHandle );\r
- }\r
- }\r
- </pre>\r
- * \defgroup xTaskCreate xTaskCreate\r
- * \ingroup Tasks\r
- */\r
-#if( configSUPPORT_DYNAMIC_ALLOCATION == 1 )\r
- BaseType_t xTaskCreate( TaskFunction_t pxTaskCode,\r
- const char * const pcName, /*lint !e971 Unqualified char types are allowed for strings and single characters only. */\r
- const configSTACK_DEPTH_TYPE usStackDepth,\r
- void * const pvParameters,\r
- UBaseType_t uxPriority,\r
- TaskHandle_t * const pxCreatedTask ) PRIVILEGED_FUNCTION;\r
-#endif\r
-\r
-/**\r
- * task. h\r
- *<pre>\r
- TaskHandle_t xTaskCreateStatic( TaskFunction_t pvTaskCode,\r
- const char * const pcName,\r
- uint32_t ulStackDepth,\r
- void *pvParameters,\r
- UBaseType_t uxPriority,\r
- StackType_t *pxStackBuffer,\r
- StaticTask_t *pxTaskBuffer );</pre>\r
- *\r
- * Create a new task and add it to the list of tasks that are ready to run.\r
- *\r
- * Internally, within the FreeRTOS implementation, tasks use two blocks of\r
- * memory. The first block is used to hold the task's data structures. The\r
- * second block is used by the task as its stack. If a task is created using\r
- * xTaskCreate() then both blocks of memory are automatically dynamically\r
- * allocated inside the xTaskCreate() function. (see\r
- * http://www.freertos.org/a00111.html). If a task is created using\r
- * xTaskCreateStatic() then the application writer must provide the required\r
- * memory. xTaskCreateStatic() therefore allows a task to be created without\r
- * using any dynamic memory allocation.\r
- *\r
- * @param pvTaskCode Pointer to the task entry function. Tasks\r
- * must be implemented to never return (i.e. continuous loop).\r
- *\r
- * @param pcName A descriptive name for the task. This is mainly used to\r
- * facilitate debugging. The maximum length of the string is defined by\r
- * configMAX_TASK_NAME_LEN in FreeRTOSConfig.h.\r
- *\r
- * @param ulStackDepth The size of the task stack specified as the number of\r
- * variables the stack can hold - not the number of bytes. For example, if\r
- * the stack is 32-bits wide and ulStackDepth is defined as 100 then 400 bytes\r
- * will be allocated for stack storage.\r
- *\r
- * @param pvParameters Pointer that will be used as the parameter for the task\r
- * being created.\r
- *\r
- * @param uxPriority The priority at which the task will run.\r
- *\r
- * @param pxStackBuffer Must point to a StackType_t array that has at least\r
- * ulStackDepth indexes - the array will then be used as the task's stack,\r
- * removing the need for the stack to be allocated dynamically.\r
- *\r
- * @param pxTaskBuffer Must point to a variable of type StaticTask_t, which will\r
- * then be used to hold the task's data structures, removing the need for the\r
- * memory to be allocated dynamically.\r
- *\r
- * @return If neither pxStackBuffer or pxTaskBuffer are NULL, then the task will\r
- * be created and pdPASS is returned. If either pxStackBuffer or pxTaskBuffer\r
- * are NULL then the task will not be created and\r
- * errCOULD_NOT_ALLOCATE_REQUIRED_MEMORY is returned.\r
- *\r
- * Example usage:\r
- <pre>\r
-\r
- // Dimensions the buffer that the task being created will use as its stack.\r
- // NOTE: This is the number of words the stack will hold, not the number of\r
- // bytes. For example, if each stack item is 32-bits, and this is set to 100,\r
- // then 400 bytes (100 * 32-bits) will be allocated.\r
- #define STACK_SIZE 200\r
-\r
- // Structure that will hold the TCB of the task being created.\r
- StaticTask_t xTaskBuffer;\r
-\r
- // Buffer that the task being created will use as its stack. Note this is\r
- // an array of StackType_t variables. The size of StackType_t is dependent on\r
- // the RTOS port.\r
- StackType_t xStack[ STACK_SIZE ];\r
-\r
- // Function that implements the task being created.\r
- void vTaskCode( void * pvParameters )\r
- {\r
- // The parameter value is expected to be 1 as 1 is passed in the\r
- // pvParameters value in the call to xTaskCreateStatic().\r
- configASSERT( ( uint32_t ) pvParameters == 1UL );\r
-\r
- for( ;; )\r
- {\r
- // Task code goes here.\r
- }\r
- }\r
-\r
- // Function that creates a task.\r
- void vOtherFunction( void )\r
- {\r
- TaskHandle_t xHandle = NULL;\r
-\r
- // Create the task without using any dynamic memory allocation.\r
- xHandle = xTaskCreateStatic(\r
- vTaskCode, // Function that implements the task.\r
- "NAME", // Text name for the task.\r
- STACK_SIZE, // Stack size in words, not bytes.\r
- ( void * ) 1, // Parameter passed into the task.\r
- tskIDLE_PRIORITY,// Priority at which the task is created.\r
- xStack, // Array to use as the task's stack.\r
- &xTaskBuffer ); // Variable to hold the task's data structure.\r
-\r
- // puxStackBuffer and pxTaskBuffer were not NULL, so the task will have\r
- // been created, and xHandle will be the task's handle. Use the handle\r
- // to suspend the task.\r
- vTaskSuspend( xHandle );\r
- }\r
- </pre>\r
- * \defgroup xTaskCreateStatic xTaskCreateStatic\r
- * \ingroup Tasks\r
- */\r
-#if( configSUPPORT_STATIC_ALLOCATION == 1 )\r
- TaskHandle_t xTaskCreateStatic( TaskFunction_t pxTaskCode,\r
- const char * const pcName, /*lint !e971 Unqualified char types are allowed for strings and single characters only. */\r
- const uint32_t ulStackDepth,\r
- void * const pvParameters,\r
- UBaseType_t uxPriority,\r
- StackType_t * const puxStackBuffer,\r
- StaticTask_t * const pxTaskBuffer ) PRIVILEGED_FUNCTION;\r
-#endif /* configSUPPORT_STATIC_ALLOCATION */\r
-\r
-/**\r
- * task. h\r
- *<pre>\r
- BaseType_t xTaskCreateRestricted( TaskParameters_t *pxTaskDefinition, TaskHandle_t *pxCreatedTask );</pre>\r
- *\r
- * Only available when configSUPPORT_DYNAMIC_ALLOCATION is set to 1.\r
- *\r
- * xTaskCreateRestricted() should only be used in systems that include an MPU\r
- * implementation.\r
- *\r
- * Create a new task and add it to the list of tasks that are ready to run.\r
- * The function parameters define the memory regions and associated access\r
- * permissions allocated to the task.\r
- *\r
- * See xTaskCreateRestrictedStatic() for a version that does not use any\r
- * dynamic memory allocation.\r
- *\r
- * @param pxTaskDefinition Pointer to a structure that contains a member\r
- * for each of the normal xTaskCreate() parameters (see the xTaskCreate() API\r
- * documentation) plus an optional stack buffer and the memory region\r
- * definitions.\r
- *\r
- * @param pxCreatedTask Used to pass back a handle by which the created task\r
- * can be referenced.\r
- *\r
- * @return pdPASS if the task was successfully created and added to a ready\r
- * list, otherwise an error code defined in the file projdefs.h\r
- *\r
- * Example usage:\r
- <pre>\r
-// Create an TaskParameters_t structure that defines the task to be created.\r
-static const TaskParameters_t xCheckTaskParameters =\r
-{\r
- vATask, // pvTaskCode - the function that implements the task.\r
- "ATask", // pcName - just a text name for the task to assist debugging.\r
- 100, // usStackDepth - the stack size DEFINED IN WORDS.\r
- NULL, // pvParameters - passed into the task function as the function parameters.\r
- ( 1UL | portPRIVILEGE_BIT ),// uxPriority - task priority, set the portPRIVILEGE_BIT if the task should run in a privileged state.\r
- cStackBuffer,// puxStackBuffer - the buffer to be used as the task stack.\r
-\r
- // xRegions - Allocate up to three separate memory regions for access by\r
- // the task, with appropriate access permissions. Different processors have\r
- // different memory alignment requirements - refer to the FreeRTOS documentation\r
- // for full information.\r
- {\r
- // Base address Length Parameters\r
- { cReadWriteArray, 32, portMPU_REGION_READ_WRITE },\r
- { cReadOnlyArray, 32, portMPU_REGION_READ_ONLY },\r
- { cPrivilegedOnlyAccessArray, 128, portMPU_REGION_PRIVILEGED_READ_WRITE }\r
- }\r
-};\r
-\r
-int main( void )\r
-{\r
-TaskHandle_t xHandle;\r
-\r
- // Create a task from the const structure defined above. The task handle\r
- // is requested (the second parameter is not NULL) but in this case just for\r
- // demonstration purposes as its not actually used.\r
- xTaskCreateRestricted( &xRegTest1Parameters, &xHandle );\r
-\r
- // Start the scheduler.\r
- vTaskStartScheduler();\r
-\r
- // Will only get here if there was insufficient memory to create the idle\r
- // and/or timer task.\r
- for( ;; );\r
-}\r
- </pre>\r
- * \defgroup xTaskCreateRestricted xTaskCreateRestricted\r
- * \ingroup Tasks\r
- */\r
-#if( portUSING_MPU_WRAPPERS == 1 )\r
- BaseType_t xTaskCreateRestricted( const TaskParameters_t * const pxTaskDefinition, TaskHandle_t *pxCreatedTask ) PRIVILEGED_FUNCTION;\r
-#endif\r
-\r
-/**\r
- * task. h\r
- *<pre>\r
- BaseType_t xTaskCreateRestrictedStatic( TaskParameters_t *pxTaskDefinition, TaskHandle_t *pxCreatedTask );</pre>\r
- *\r
- * Only available when configSUPPORT_STATIC_ALLOCATION is set to 1.\r
- *\r
- * xTaskCreateRestrictedStatic() should only be used in systems that include an\r
- * MPU implementation.\r
- *\r
- * Internally, within the FreeRTOS implementation, tasks use two blocks of\r
- * memory. The first block is used to hold the task's data structures. The\r
- * second block is used by the task as its stack. If a task is created using\r
- * xTaskCreateRestricted() then the stack is provided by the application writer,\r
- * and the memory used to hold the task's data structure is automatically\r
- * dynamically allocated inside the xTaskCreateRestricted() function. If a task\r
- * is created using xTaskCreateRestrictedStatic() then the application writer\r
- * must provide the memory used to hold the task's data structures too.\r
- * xTaskCreateRestrictedStatic() therefore allows a memory protected task to be\r
- * created without using any dynamic memory allocation.\r
- *\r
- * @param pxTaskDefinition Pointer to a structure that contains a member\r
- * for each of the normal xTaskCreate() parameters (see the xTaskCreate() API\r
- * documentation) plus an optional stack buffer and the memory region\r
- * definitions. If configSUPPORT_STATIC_ALLOCATION is set to 1 the structure\r
- * contains an additional member, which is used to point to a variable of type\r
- * StaticTask_t - which is then used to hold the task's data structure.\r
- *\r
- * @param pxCreatedTask Used to pass back a handle by which the created task\r
- * can be referenced.\r
- *\r
- * @return pdPASS if the task was successfully created and added to a ready\r
- * list, otherwise an error code defined in the file projdefs.h\r
- *\r
- * Example usage:\r
- <pre>\r
-// Create an TaskParameters_t structure that defines the task to be created.\r
-// The StaticTask_t variable is only included in the structure when\r
-// configSUPPORT_STATIC_ALLOCATION is set to 1. The PRIVILEGED_DATA macro can\r
-// be used to force the variable into the RTOS kernel's privileged data area.\r
-static PRIVILEGED_DATA StaticTask_t xTaskBuffer;\r
-static const TaskParameters_t xCheckTaskParameters =\r
-{\r
- vATask, // pvTaskCode - the function that implements the task.\r
- "ATask", // pcName - just a text name for the task to assist debugging.\r
- 100, // usStackDepth - the stack size DEFINED IN WORDS.\r
- NULL, // pvParameters - passed into the task function as the function parameters.\r
- ( 1UL | portPRIVILEGE_BIT ),// uxPriority - task priority, set the portPRIVILEGE_BIT if the task should run in a privileged state.\r
- cStackBuffer,// puxStackBuffer - the buffer to be used as the task stack.\r
-\r
- // xRegions - Allocate up to three separate memory regions for access by\r
- // the task, with appropriate access permissions. Different processors have\r
- // different memory alignment requirements - refer to the FreeRTOS documentation\r
- // for full information.\r
- {\r
- // Base address Length Parameters\r
- { cReadWriteArray, 32, portMPU_REGION_READ_WRITE },\r
- { cReadOnlyArray, 32, portMPU_REGION_READ_ONLY },\r
- { cPrivilegedOnlyAccessArray, 128, portMPU_REGION_PRIVILEGED_READ_WRITE }\r
- }\r
-\r
- &xTaskBuffer; // Holds the task's data structure.\r
-};\r
-\r
-int main( void )\r
-{\r
-TaskHandle_t xHandle;\r
-\r
- // Create a task from the const structure defined above. The task handle\r
- // is requested (the second parameter is not NULL) but in this case just for\r
- // demonstration purposes as its not actually used.\r
- xTaskCreateRestricted( &xRegTest1Parameters, &xHandle );\r
-\r
- // Start the scheduler.\r
- vTaskStartScheduler();\r
-\r
- // Will only get here if there was insufficient memory to create the idle\r
- // and/or timer task.\r
- for( ;; );\r
-}\r
- </pre>\r
- * \defgroup xTaskCreateRestrictedStatic xTaskCreateRestrictedStatic\r
- * \ingroup Tasks\r
- */\r
-#if( ( portUSING_MPU_WRAPPERS == 1 ) && ( configSUPPORT_STATIC_ALLOCATION == 1 ) )\r
- BaseType_t xTaskCreateRestrictedStatic( const TaskParameters_t * const pxTaskDefinition, TaskHandle_t *pxCreatedTask ) PRIVILEGED_FUNCTION;\r
-#endif\r
-\r
-/**\r
- * task. h\r
- *<pre>\r
- void vTaskAllocateMPURegions( TaskHandle_t xTask, const MemoryRegion_t * const pxRegions );</pre>\r
- *\r
- * Memory regions are assigned to a restricted task when the task is created by\r
- * a call to xTaskCreateRestricted(). These regions can be redefined using\r
- * vTaskAllocateMPURegions().\r
- *\r
- * @param xTask The handle of the task being updated.\r
- *\r
- * @param xRegions A pointer to an MemoryRegion_t structure that contains the\r
- * new memory region definitions.\r
- *\r
- * Example usage:\r
- <pre>\r
-// Define an array of MemoryRegion_t structures that configures an MPU region\r
-// allowing read/write access for 1024 bytes starting at the beginning of the\r
-// ucOneKByte array. The other two of the maximum 3 definable regions are\r
-// unused so set to zero.\r
-static const MemoryRegion_t xAltRegions[ portNUM_CONFIGURABLE_REGIONS ] =\r
-{\r
- // Base address Length Parameters\r
- { ucOneKByte, 1024, portMPU_REGION_READ_WRITE },\r
- { 0, 0, 0 },\r
- { 0, 0, 0 }\r
-};\r
-\r
-void vATask( void *pvParameters )\r
-{\r
- // This task was created such that it has access to certain regions of\r
- // memory as defined by the MPU configuration. At some point it is\r
- // desired that these MPU regions are replaced with that defined in the\r
- // xAltRegions const struct above. Use a call to vTaskAllocateMPURegions()\r
- // for this purpose. NULL is used as the task handle to indicate that this\r
- // function should modify the MPU regions of the calling task.\r
- vTaskAllocateMPURegions( NULL, xAltRegions );\r
-\r
- // Now the task can continue its function, but from this point on can only\r
- // access its stack and the ucOneKByte array (unless any other statically\r
- // defined or shared regions have been declared elsewhere).\r
-}\r
- </pre>\r
- * \defgroup xTaskCreateRestricted xTaskCreateRestricted\r
- * \ingroup Tasks\r
- */\r
-void vTaskAllocateMPURegions( TaskHandle_t xTask, const MemoryRegion_t * const pxRegions ) PRIVILEGED_FUNCTION;\r
-\r
-/**\r
- * task. h\r
- * <pre>void vTaskDelete( TaskHandle_t xTask );</pre>\r
- *\r
- * INCLUDE_vTaskDelete must be defined as 1 for this function to be available.\r
- * See the configuration section for more information.\r
- *\r
- * Remove a task from the RTOS real time kernel's management. The task being\r
- * deleted will be removed from all ready, blocked, suspended and event lists.\r
- *\r
- * NOTE: The idle task is responsible for freeing the kernel allocated\r
- * memory from tasks that have been deleted. It is therefore important that\r
- * the idle task is not starved of microcontroller processing time if your\r
- * application makes any calls to vTaskDelete (). Memory allocated by the\r
- * task code is not automatically freed, and should be freed before the task\r
- * is deleted.\r
- *\r
- * See the demo application file death.c for sample code that utilises\r
- * vTaskDelete ().\r
- *\r
- * @param xTask The handle of the task to be deleted. Passing NULL will\r
- * cause the calling task to be deleted.\r
- *\r
- * Example usage:\r
- <pre>\r
- void vOtherFunction( void )\r
- {\r
- TaskHandle_t xHandle;\r
-\r
- // Create the task, storing the handle.\r
- xTaskCreate( vTaskCode, "NAME", STACK_SIZE, NULL, tskIDLE_PRIORITY, &xHandle );\r
-\r
- // Use the handle to delete the task.\r
- vTaskDelete( xHandle );\r
- }\r
- </pre>\r
- * \defgroup vTaskDelete vTaskDelete\r
- * \ingroup Tasks\r
- */\r
-void vTaskDelete( TaskHandle_t xTaskToDelete ) PRIVILEGED_FUNCTION;\r
-\r
-/*-----------------------------------------------------------\r
- * TASK CONTROL API\r
- *----------------------------------------------------------*/\r
-\r
-/**\r
- * task. h\r
- * <pre>void vTaskDelay( const TickType_t xTicksToDelay );</pre>\r
- *\r
- * Delay a task for a given number of ticks. The actual time that the\r
- * task remains blocked depends on the tick rate. The constant\r
- * portTICK_PERIOD_MS can be used to calculate real time from the tick\r
- * rate - with the resolution of one tick period.\r
- *\r
- * INCLUDE_vTaskDelay must be defined as 1 for this function to be available.\r
- * See the configuration section for more information.\r
- *\r
- *\r
- * vTaskDelay() specifies a time at which the task wishes to unblock relative to\r
- * the time at which vTaskDelay() is called. For example, specifying a block\r
- * period of 100 ticks will cause the task to unblock 100 ticks after\r
- * vTaskDelay() is called. vTaskDelay() does not therefore provide a good method\r
- * of controlling the frequency of a periodic task as the path taken through the\r
- * code, as well as other task and interrupt activity, will effect the frequency\r
- * at which vTaskDelay() gets called and therefore the time at which the task\r
- * next executes. See vTaskDelayUntil() for an alternative API function designed\r
- * to facilitate fixed frequency execution. It does this by specifying an\r
- * absolute time (rather than a relative time) at which the calling task should\r
- * unblock.\r
- *\r
- * @param xTicksToDelay The amount of time, in tick periods, that\r
- * the calling task should block.\r
- *\r
- * Example usage:\r
-\r
- void vTaskFunction( void * pvParameters )\r
- {\r
- // Block for 500ms.\r
- const TickType_t xDelay = 500 / portTICK_PERIOD_MS;\r
-\r
- for( ;; )\r
- {\r
- // Simply toggle the LED every 500ms, blocking between each toggle.\r
- vToggleLED();\r
- vTaskDelay( xDelay );\r
- }\r
- }\r
-\r
- * \defgroup vTaskDelay vTaskDelay\r
- * \ingroup TaskCtrl\r
- */\r
-void vTaskDelay( const TickType_t xTicksToDelay ) PRIVILEGED_FUNCTION;\r
-\r
-/**\r
- * task. h\r
- * <pre>void vTaskDelayUntil( TickType_t *pxPreviousWakeTime, const TickType_t xTimeIncrement );</pre>\r
- *\r
- * INCLUDE_vTaskDelayUntil must be defined as 1 for this function to be available.\r
- * See the configuration section for more information.\r
- *\r
- * Delay a task until a specified time. This function can be used by periodic\r
- * tasks to ensure a constant execution frequency.\r
- *\r
- * This function differs from vTaskDelay () in one important aspect: vTaskDelay () will\r
- * cause a task to block for the specified number of ticks from the time vTaskDelay () is\r
- * called. It is therefore difficult to use vTaskDelay () by itself to generate a fixed\r
- * execution frequency as the time between a task starting to execute and that task\r
- * calling vTaskDelay () may not be fixed [the task may take a different path though the\r
- * code between calls, or may get interrupted or preempted a different number of times\r
- * each time it executes].\r
- *\r
- * Whereas vTaskDelay () specifies a wake time relative to the time at which the function\r
- * is called, vTaskDelayUntil () specifies the absolute (exact) time at which it wishes to\r
- * unblock.\r
- *\r
- * The constant portTICK_PERIOD_MS can be used to calculate real time from the tick\r
- * rate - with the resolution of one tick period.\r
- *\r
- * @param pxPreviousWakeTime Pointer to a variable that holds the time at which the\r
- * task was last unblocked. The variable must be initialised with the current time\r
- * prior to its first use (see the example below). Following this the variable is\r
- * automatically updated within vTaskDelayUntil ().\r
- *\r
- * @param xTimeIncrement The cycle time period. The task will be unblocked at\r
- * time *pxPreviousWakeTime + xTimeIncrement. Calling vTaskDelayUntil with the\r
- * same xTimeIncrement parameter value will cause the task to execute with\r
- * a fixed interface period.\r
- *\r
- * Example usage:\r
- <pre>\r
- // Perform an action every 10 ticks.\r
- void vTaskFunction( void * pvParameters )\r
- {\r
- TickType_t xLastWakeTime;\r
- const TickType_t xFrequency = 10;\r
-\r
- // Initialise the xLastWakeTime variable with the current time.\r
- xLastWakeTime = xTaskGetTickCount ();\r
- for( ;; )\r
- {\r
- // Wait for the next cycle.\r
- vTaskDelayUntil( &xLastWakeTime, xFrequency );\r
-\r
- // Perform action here.\r
- }\r
- }\r
- </pre>\r
- * \defgroup vTaskDelayUntil vTaskDelayUntil\r
- * \ingroup TaskCtrl\r
- */\r
-void vTaskDelayUntil( TickType_t * const pxPreviousWakeTime, const TickType_t xTimeIncrement ) PRIVILEGED_FUNCTION;\r
-\r
-/**\r
- * task. h\r
- * <pre>BaseType_t xTaskAbortDelay( TaskHandle_t xTask );</pre>\r
- *\r
- * INCLUDE_xTaskAbortDelay must be defined as 1 in FreeRTOSConfig.h for this\r
- * function to be available.\r
- *\r
- * A task will enter the Blocked state when it is waiting for an event. The\r
- * event it is waiting for can be a temporal event (waiting for a time), such\r
- * as when vTaskDelay() is called, or an event on an object, such as when\r
- * xQueueReceive() or ulTaskNotifyTake() is called. If the handle of a task\r
- * that is in the Blocked state is used in a call to xTaskAbortDelay() then the\r
- * task will leave the Blocked state, and return from whichever function call\r
- * placed the task into the Blocked state.\r
- *\r
- * @param xTask The handle of the task to remove from the Blocked state.\r
- *\r
- * @return If the task referenced by xTask was not in the Blocked state then\r
- * pdFAIL is returned. Otherwise pdPASS is returned.\r
- *\r
- * \defgroup xTaskAbortDelay xTaskAbortDelay\r
- * \ingroup TaskCtrl\r
- */\r
-BaseType_t xTaskAbortDelay( TaskHandle_t xTask ) PRIVILEGED_FUNCTION;\r
-\r
-/**\r
- * task. h\r
- * <pre>UBaseType_t uxTaskPriorityGet( TaskHandle_t xTask );</pre>\r
- *\r
- * INCLUDE_uxTaskPriorityGet must be defined as 1 for this function to be available.\r
- * See the configuration section for more information.\r
- *\r
- * Obtain the priority of any task.\r
- *\r
- * @param xTask Handle of the task to be queried. Passing a NULL\r
- * handle results in the priority of the calling task being returned.\r
- *\r
- * @return The priority of xTask.\r
- *\r
- * Example usage:\r
- <pre>\r
- void vAFunction( void )\r
- {\r
- TaskHandle_t xHandle;\r
-\r
- // Create a task, storing the handle.\r
- xTaskCreate( vTaskCode, "NAME", STACK_SIZE, NULL, tskIDLE_PRIORITY, &xHandle );\r
-\r
- // ...\r
-\r
- // Use the handle to obtain the priority of the created task.\r
- // It was created with tskIDLE_PRIORITY, but may have changed\r
- // it itself.\r
- if( uxTaskPriorityGet( xHandle ) != tskIDLE_PRIORITY )\r
- {\r
- // The task has changed it's priority.\r
- }\r
-\r
- // ...\r
-\r
- // Is our priority higher than the created task?\r
- if( uxTaskPriorityGet( xHandle ) < uxTaskPriorityGet( NULL ) )\r
- {\r
- // Our priority (obtained using NULL handle) is higher.\r
- }\r
- }\r
- </pre>\r
- * \defgroup uxTaskPriorityGet uxTaskPriorityGet\r
- * \ingroup TaskCtrl\r
- */\r
-UBaseType_t uxTaskPriorityGet( TaskHandle_t xTask ) PRIVILEGED_FUNCTION;\r
-\r
-/**\r
- * task. h\r
- * <pre>UBaseType_t uxTaskPriorityGetFromISR( TaskHandle_t xTask );</pre>\r
- *\r
- * A version of uxTaskPriorityGet() that can be used from an ISR.\r
- */\r
-UBaseType_t uxTaskPriorityGetFromISR( TaskHandle_t xTask ) PRIVILEGED_FUNCTION;\r
-\r
-/**\r
- * task. h\r
- * <pre>eTaskState eTaskGetState( TaskHandle_t xTask );</pre>\r
- *\r
- * INCLUDE_eTaskGetState must be defined as 1 for this function to be available.\r
- * See the configuration section for more information.\r
- *\r
- * Obtain the state of any task. States are encoded by the eTaskState\r
- * enumerated type.\r
- *\r
- * @param xTask Handle of the task to be queried.\r
- *\r
- * @return The state of xTask at the time the function was called. Note the\r
- * state of the task might change between the function being called, and the\r
- * functions return value being tested by the calling task.\r
- */\r
-eTaskState eTaskGetState( TaskHandle_t xTask ) PRIVILEGED_FUNCTION;\r
-\r
-/**\r
- * task. h\r
- * <pre>void vTaskGetInfo( TaskHandle_t xTask, TaskStatus_t *pxTaskStatus, BaseType_t xGetFreeStackSpace, eTaskState eState );</pre>\r
- *\r
- * configUSE_TRACE_FACILITY must be defined as 1 for this function to be\r
- * available. See the configuration section for more information.\r
- *\r
- * Populates a TaskStatus_t structure with information about a task.\r
- *\r
- * @param xTask Handle of the task being queried. If xTask is NULL then\r
- * information will be returned about the calling task.\r
- *\r
- * @param pxTaskStatus A pointer to the TaskStatus_t structure that will be\r
- * filled with information about the task referenced by the handle passed using\r
- * the xTask parameter.\r
- *\r
- * @xGetFreeStackSpace The TaskStatus_t structure contains a member to report\r
- * the stack high water mark of the task being queried. Calculating the stack\r
- * high water mark takes a relatively long time, and can make the system\r
- * temporarily unresponsive - so the xGetFreeStackSpace parameter is provided to\r
- * allow the high water mark checking to be skipped. The high watermark value\r
- * will only be written to the TaskStatus_t structure if xGetFreeStackSpace is\r
- * not set to pdFALSE;\r
- *\r
- * @param eState The TaskStatus_t structure contains a member to report the\r
- * state of the task being queried. Obtaining the task state is not as fast as\r
- * a simple assignment - so the eState parameter is provided to allow the state\r
- * information to be omitted from the TaskStatus_t structure. To obtain state\r
- * information then set eState to eInvalid - otherwise the value passed in\r
- * eState will be reported as the task state in the TaskStatus_t structure.\r
- *\r
- * Example usage:\r
- <pre>\r
- void vAFunction( void )\r
- {\r
- TaskHandle_t xHandle;\r
- TaskStatus_t xTaskDetails;\r
-\r
- // Obtain the handle of a task from its name.\r
- xHandle = xTaskGetHandle( "Task_Name" );\r
-\r
- // Check the handle is not NULL.\r
- configASSERT( xHandle );\r
-\r
- // Use the handle to obtain further information about the task.\r
- vTaskGetInfo( xHandle,\r
- &xTaskDetails,\r
- pdTRUE, // Include the high water mark in xTaskDetails.\r
- eInvalid ); // Include the task state in xTaskDetails.\r
- }\r
- </pre>\r
- * \defgroup vTaskGetInfo vTaskGetInfo\r
- * \ingroup TaskCtrl\r
- */\r
-void vTaskGetInfo( TaskHandle_t xTask, TaskStatus_t *pxTaskStatus, BaseType_t xGetFreeStackSpace, eTaskState eState ) PRIVILEGED_FUNCTION;\r
-\r
-/**\r
- * task. h\r
- * <pre>void vTaskPrioritySet( TaskHandle_t xTask, UBaseType_t uxNewPriority );</pre>\r
- *\r
- * INCLUDE_vTaskPrioritySet must be defined as 1 for this function to be available.\r
- * See the configuration section for more information.\r
- *\r
- * Set the priority of any task.\r
- *\r
- * A context switch will occur before the function returns if the priority\r
- * being set is higher than the currently executing task.\r
- *\r
- * @param xTask Handle to the task for which the priority is being set.\r
- * Passing a NULL handle results in the priority of the calling task being set.\r
- *\r
- * @param uxNewPriority The priority to which the task will be set.\r
- *\r
- * Example usage:\r
- <pre>\r
- void vAFunction( void )\r
- {\r
- TaskHandle_t xHandle;\r
-\r
- // Create a task, storing the handle.\r
- xTaskCreate( vTaskCode, "NAME", STACK_SIZE, NULL, tskIDLE_PRIORITY, &xHandle );\r
-\r
- // ...\r
-\r
- // Use the handle to raise the priority of the created task.\r
- vTaskPrioritySet( xHandle, tskIDLE_PRIORITY + 1 );\r
-\r
- // ...\r
-\r
- // Use a NULL handle to raise our priority to the same value.\r
- vTaskPrioritySet( NULL, tskIDLE_PRIORITY + 1 );\r
- }\r
- </pre>\r
- * \defgroup vTaskPrioritySet vTaskPrioritySet\r
- * \ingroup TaskCtrl\r
- */\r
-void vTaskPrioritySet( TaskHandle_t xTask, UBaseType_t uxNewPriority ) PRIVILEGED_FUNCTION;\r
-\r
-/**\r
- * task. h\r
- * <pre>void vTaskSuspend( TaskHandle_t xTaskToSuspend );</pre>\r
- *\r
- * INCLUDE_vTaskSuspend must be defined as 1 for this function to be available.\r
- * See the configuration section for more information.\r
- *\r
- * Suspend any task. When suspended a task will never get any microcontroller\r
- * processing time, no matter what its priority.\r
- *\r
- * Calls to vTaskSuspend are not accumulative -\r
- * i.e. calling vTaskSuspend () twice on the same task still only requires one\r
- * call to vTaskResume () to ready the suspended task.\r
- *\r
- * @param xTaskToSuspend Handle to the task being suspended. Passing a NULL\r
- * handle will cause the calling task to be suspended.\r
- *\r
- * Example usage:\r
- <pre>\r
- void vAFunction( void )\r
- {\r
- TaskHandle_t xHandle;\r
-\r
- // Create a task, storing the handle.\r
- xTaskCreate( vTaskCode, "NAME", STACK_SIZE, NULL, tskIDLE_PRIORITY, &xHandle );\r
-\r
- // ...\r
-\r
- // Use the handle to suspend the created task.\r
- vTaskSuspend( xHandle );\r
-\r
- // ...\r
-\r
- // The created task will not run during this period, unless\r
- // another task calls vTaskResume( xHandle ).\r
-\r
- //...\r
-\r
-\r
- // Suspend ourselves.\r
- vTaskSuspend( NULL );\r
-\r
- // We cannot get here unless another task calls vTaskResume\r
- // with our handle as the parameter.\r
- }\r
- </pre>\r
- * \defgroup vTaskSuspend vTaskSuspend\r
- * \ingroup TaskCtrl\r
- */\r
-void vTaskSuspend( TaskHandle_t xTaskToSuspend ) PRIVILEGED_FUNCTION;\r
-\r
-/**\r
- * task. h\r
- * <pre>void vTaskResume( TaskHandle_t xTaskToResume );</pre>\r
- *\r
- * INCLUDE_vTaskSuspend must be defined as 1 for this function to be available.\r
- * See the configuration section for more information.\r
- *\r
- * Resumes a suspended task.\r
- *\r
- * A task that has been suspended by one or more calls to vTaskSuspend ()\r
- * will be made available for running again by a single call to\r
- * vTaskResume ().\r
- *\r
- * @param xTaskToResume Handle to the task being readied.\r
- *\r
- * Example usage:\r
- <pre>\r
- void vAFunction( void )\r
- {\r
- TaskHandle_t xHandle;\r
-\r
- // Create a task, storing the handle.\r
- xTaskCreate( vTaskCode, "NAME", STACK_SIZE, NULL, tskIDLE_PRIORITY, &xHandle );\r
-\r
- // ...\r
-\r
- // Use the handle to suspend the created task.\r
- vTaskSuspend( xHandle );\r
-\r
- // ...\r
-\r
- // The created task will not run during this period, unless\r
- // another task calls vTaskResume( xHandle ).\r
-\r
- //...\r
-\r
-\r
- // Resume the suspended task ourselves.\r
- vTaskResume( xHandle );\r
-\r
- // The created task will once again get microcontroller processing\r
- // time in accordance with its priority within the system.\r
- }\r
- </pre>\r
- * \defgroup vTaskResume vTaskResume\r
- * \ingroup TaskCtrl\r
- */\r
-void vTaskResume( TaskHandle_t xTaskToResume ) PRIVILEGED_FUNCTION;\r
-\r
-/**\r
- * task. h\r
- * <pre>void xTaskResumeFromISR( TaskHandle_t xTaskToResume );</pre>\r
- *\r
- * INCLUDE_xTaskResumeFromISR must be defined as 1 for this function to be\r
- * available. See the configuration section for more information.\r
- *\r
- * An implementation of vTaskResume() that can be called from within an ISR.\r
- *\r
- * A task that has been suspended by one or more calls to vTaskSuspend ()\r
- * will be made available for running again by a single call to\r
- * xTaskResumeFromISR ().\r
- *\r
- * xTaskResumeFromISR() should not be used to synchronise a task with an\r
- * interrupt if there is a chance that the interrupt could arrive prior to the\r
- * task being suspended - as this can lead to interrupts being missed. Use of a\r
- * semaphore as a synchronisation mechanism would avoid this eventuality.\r
- *\r
- * @param xTaskToResume Handle to the task being readied.\r
- *\r
- * @return pdTRUE if resuming the task should result in a context switch,\r
- * otherwise pdFALSE. This is used by the ISR to determine if a context switch\r
- * may be required following the ISR.\r
- *\r
- * \defgroup vTaskResumeFromISR vTaskResumeFromISR\r
- * \ingroup TaskCtrl\r
- */\r
-BaseType_t xTaskResumeFromISR( TaskHandle_t xTaskToResume ) PRIVILEGED_FUNCTION;\r
-\r
-/*-----------------------------------------------------------\r
- * SCHEDULER CONTROL\r
- *----------------------------------------------------------*/\r
-\r
-/**\r
- * task. h\r
- * <pre>void vTaskStartScheduler( void );</pre>\r
- *\r
- * Starts the real time kernel tick processing. After calling the kernel\r
- * has control over which tasks are executed and when.\r
- *\r
- * See the demo application file main.c for an example of creating\r
- * tasks and starting the kernel.\r
- *\r
- * Example usage:\r
- <pre>\r
- void vAFunction( void )\r
- {\r
- // Create at least one task before starting the kernel.\r
- xTaskCreate( vTaskCode, "NAME", STACK_SIZE, NULL, tskIDLE_PRIORITY, NULL );\r
-\r
- // Start the real time kernel with preemption.\r
- vTaskStartScheduler ();\r
-\r
- // Will not get here unless a task calls vTaskEndScheduler ()\r
- }\r
- </pre>\r
- *\r
- * \defgroup vTaskStartScheduler vTaskStartScheduler\r
- * \ingroup SchedulerControl\r
- */\r
-void vTaskStartScheduler( void ) PRIVILEGED_FUNCTION;\r
-\r
-/**\r
- * task. h\r
- * <pre>void vTaskEndScheduler( void );</pre>\r
- *\r
- * NOTE: At the time of writing only the x86 real mode port, which runs on a PC\r
- * in place of DOS, implements this function.\r
- *\r
- * Stops the real time kernel tick. All created tasks will be automatically\r
- * deleted and multitasking (either preemptive or cooperative) will\r
- * stop. Execution then resumes from the point where vTaskStartScheduler ()\r
- * was called, as if vTaskStartScheduler () had just returned.\r
- *\r
- * See the demo application file main. c in the demo/PC directory for an\r
- * example that uses vTaskEndScheduler ().\r
- *\r
- * vTaskEndScheduler () requires an exit function to be defined within the\r
- * portable layer (see vPortEndScheduler () in port. c for the PC port). This\r
- * performs hardware specific operations such as stopping the kernel tick.\r
- *\r
- * vTaskEndScheduler () will cause all of the resources allocated by the\r
- * kernel to be freed - but will not free resources allocated by application\r
- * tasks.\r
- *\r
- * Example usage:\r
- <pre>\r
- void vTaskCode( void * pvParameters )\r
- {\r
- for( ;; )\r
- {\r
- // Task code goes here.\r
-\r
- // At some point we want to end the real time kernel processing\r
- // so call ...\r
- vTaskEndScheduler ();\r
- }\r
- }\r
-\r
- void vAFunction( void )\r
- {\r
- // Create at least one task before starting the kernel.\r
- xTaskCreate( vTaskCode, "NAME", STACK_SIZE, NULL, tskIDLE_PRIORITY, NULL );\r
-\r
- // Start the real time kernel with preemption.\r
- vTaskStartScheduler ();\r
-\r
- // Will only get here when the vTaskCode () task has called\r
- // vTaskEndScheduler (). When we get here we are back to single task\r
- // execution.\r
- }\r
- </pre>\r
- *\r
- * \defgroup vTaskEndScheduler vTaskEndScheduler\r
- * \ingroup SchedulerControl\r
- */\r
-void vTaskEndScheduler( void ) PRIVILEGED_FUNCTION;\r
-\r
-/**\r
- * task. h\r
- * <pre>void vTaskSuspendAll( void );</pre>\r
- *\r
- * Suspends the scheduler without disabling interrupts. Context switches will\r
- * not occur while the scheduler is suspended.\r
- *\r
- * After calling vTaskSuspendAll () the calling task will continue to execute\r
- * without risk of being swapped out until a call to xTaskResumeAll () has been\r
- * made.\r
- *\r
- * API functions that have the potential to cause a context switch (for example,\r
- * vTaskDelayUntil(), xQueueSend(), etc.) must not be called while the scheduler\r
- * is suspended.\r
- *\r
- * Example usage:\r
- <pre>\r
- void vTask1( void * pvParameters )\r
- {\r
- for( ;; )\r
- {\r
- // Task code goes here.\r
-\r
- // ...\r
-\r
- // At some point the task wants to perform a long operation during\r
- // which it does not want to get swapped out. It cannot use\r
- // taskENTER_CRITICAL ()/taskEXIT_CRITICAL () as the length of the\r
- // operation may cause interrupts to be missed - including the\r
- // ticks.\r
-\r
- // Prevent the real time kernel swapping out the task.\r
- vTaskSuspendAll ();\r
-\r
- // Perform the operation here. There is no need to use critical\r
- // sections as we have all the microcontroller processing time.\r
- // During this time interrupts will still operate and the kernel\r
- // tick count will be maintained.\r
-\r
- // ...\r
-\r
- // The operation is complete. Restart the kernel.\r
- xTaskResumeAll ();\r
- }\r
- }\r
- </pre>\r
- * \defgroup vTaskSuspendAll vTaskSuspendAll\r
- * \ingroup SchedulerControl\r
- */\r
-void vTaskSuspendAll( void ) PRIVILEGED_FUNCTION;\r
-\r
-/**\r
- * task. h\r
- * <pre>BaseType_t xTaskResumeAll( void );</pre>\r
- *\r
- * Resumes scheduler activity after it was suspended by a call to\r
- * vTaskSuspendAll().\r
- *\r
- * xTaskResumeAll() only resumes the scheduler. It does not unsuspend tasks\r
- * that were previously suspended by a call to vTaskSuspend().\r
- *\r
- * @return If resuming the scheduler caused a context switch then pdTRUE is\r
- * returned, otherwise pdFALSE is returned.\r
- *\r
- * Example usage:\r
- <pre>\r
- void vTask1( void * pvParameters )\r
- {\r
- for( ;; )\r
- {\r
- // Task code goes here.\r
-\r
- // ...\r
-\r
- // At some point the task wants to perform a long operation during\r
- // which it does not want to get swapped out. It cannot use\r
- // taskENTER_CRITICAL ()/taskEXIT_CRITICAL () as the length of the\r
- // operation may cause interrupts to be missed - including the\r
- // ticks.\r
-\r
- // Prevent the real time kernel swapping out the task.\r
- vTaskSuspendAll ();\r
-\r
- // Perform the operation here. There is no need to use critical\r
- // sections as we have all the microcontroller processing time.\r
- // During this time interrupts will still operate and the real\r
- // time kernel tick count will be maintained.\r
-\r
- // ...\r
-\r
- // The operation is complete. Restart the kernel. We want to force\r
- // a context switch - but there is no point if resuming the scheduler\r
- // caused a context switch already.\r
- if( !xTaskResumeAll () )\r
- {\r
- taskYIELD ();\r
- }\r
- }\r
- }\r
- </pre>\r
- * \defgroup xTaskResumeAll xTaskResumeAll\r
- * \ingroup SchedulerControl\r
- */\r
-BaseType_t xTaskResumeAll( void ) PRIVILEGED_FUNCTION;\r
-\r
-/*-----------------------------------------------------------\r
- * TASK UTILITIES\r
- *----------------------------------------------------------*/\r
-\r
-/**\r
- * task. h\r
- * <PRE>TickType_t xTaskGetTickCount( void );</PRE>\r
- *\r
- * @return The count of ticks since vTaskStartScheduler was called.\r
- *\r
- * \defgroup xTaskGetTickCount xTaskGetTickCount\r
- * \ingroup TaskUtils\r
- */\r
-TickType_t xTaskGetTickCount( void ) PRIVILEGED_FUNCTION;\r
-\r
-/**\r
- * task. h\r
- * <PRE>TickType_t xTaskGetTickCountFromISR( void );</PRE>\r
- *\r
- * @return The count of ticks since vTaskStartScheduler was called.\r
- *\r
- * This is a version of xTaskGetTickCount() that is safe to be called from an\r
- * ISR - provided that TickType_t is the natural word size of the\r
- * microcontroller being used or interrupt nesting is either not supported or\r
- * not being used.\r
- *\r
- * \defgroup xTaskGetTickCountFromISR xTaskGetTickCountFromISR\r
- * \ingroup TaskUtils\r
- */\r
-TickType_t xTaskGetTickCountFromISR( void ) PRIVILEGED_FUNCTION;\r
-\r
-/**\r
- * task. h\r
- * <PRE>uint16_t uxTaskGetNumberOfTasks( void );</PRE>\r
- *\r
- * @return The number of tasks that the real time kernel is currently managing.\r
- * This includes all ready, blocked and suspended tasks. A task that\r
- * has been deleted but not yet freed by the idle task will also be\r
- * included in the count.\r
- *\r
- * \defgroup uxTaskGetNumberOfTasks uxTaskGetNumberOfTasks\r
- * \ingroup TaskUtils\r
- */\r
-UBaseType_t uxTaskGetNumberOfTasks( void ) PRIVILEGED_FUNCTION;\r
-\r
-/**\r
- * task. h\r
- * <PRE>char *pcTaskGetName( TaskHandle_t xTaskToQuery );</PRE>\r
- *\r
- * @return The text (human readable) name of the task referenced by the handle\r
- * xTaskToQuery. A task can query its own name by either passing in its own\r
- * handle, or by setting xTaskToQuery to NULL.\r
- *\r
- * \defgroup pcTaskGetName pcTaskGetName\r
- * \ingroup TaskUtils\r
- */\r
-char *pcTaskGetName( TaskHandle_t xTaskToQuery ) PRIVILEGED_FUNCTION; /*lint !e971 Unqualified char types are allowed for strings and single characters only. */\r
-\r
-/**\r
- * task. h\r
- * <PRE>TaskHandle_t xTaskGetHandle( const char *pcNameToQuery );</PRE>\r
- *\r
- * NOTE: This function takes a relatively long time to complete and should be\r
- * used sparingly.\r
- *\r
- * @return The handle of the task that has the human readable name pcNameToQuery.\r
- * NULL is returned if no matching name is found. INCLUDE_xTaskGetHandle\r
- * must be set to 1 in FreeRTOSConfig.h for pcTaskGetHandle() to be available.\r
- *\r
- * \defgroup pcTaskGetHandle pcTaskGetHandle\r
- * \ingroup TaskUtils\r
- */\r
-TaskHandle_t xTaskGetHandle( const char *pcNameToQuery ) PRIVILEGED_FUNCTION; /*lint !e971 Unqualified char types are allowed for strings and single characters only. */\r
-\r
-/**\r
- * task.h\r
- * <PRE>UBaseType_t uxTaskGetStackHighWaterMark( TaskHandle_t xTask );</PRE>\r
- *\r
- * INCLUDE_uxTaskGetStackHighWaterMark must be set to 1 in FreeRTOSConfig.h for\r
- * this function to be available.\r
- *\r
- * Returns the high water mark of the stack associated with xTask. That is,\r
- * the minimum free stack space there has been (in words, so on a 32 bit machine\r
- * a value of 1 means 4 bytes) since the task started. The smaller the returned\r
- * number the closer the task has come to overflowing its stack.\r
- *\r
- * @param xTask Handle of the task associated with the stack to be checked.\r
- * Set xTask to NULL to check the stack of the calling task.\r
- *\r
- * @return The smallest amount of free stack space there has been (in words, so\r
- * actual spaces on the stack rather than bytes) since the task referenced by\r
- * xTask was created.\r
- */\r
-UBaseType_t uxTaskGetStackHighWaterMark( TaskHandle_t xTask ) PRIVILEGED_FUNCTION;\r
-\r
-/* When using trace macros it is sometimes necessary to include task.h before\r
-FreeRTOS.h. When this is done TaskHookFunction_t will not yet have been defined,\r
-so the following two prototypes will cause a compilation error. This can be\r
-fixed by simply guarding against the inclusion of these two prototypes unless\r
-they are explicitly required by the configUSE_APPLICATION_TASK_TAG configuration\r
-constant. */\r
-#ifdef configUSE_APPLICATION_TASK_TAG\r
- #if configUSE_APPLICATION_TASK_TAG == 1\r
- /**\r
- * task.h\r
- * <pre>void vTaskSetApplicationTaskTag( TaskHandle_t xTask, TaskHookFunction_t pxHookFunction );</pre>\r
- *\r
- * Sets pxHookFunction to be the task hook function used by the task xTask.\r
- * Passing xTask as NULL has the effect of setting the calling tasks hook\r
- * function.\r
- */\r
- void vTaskSetApplicationTaskTag( TaskHandle_t xTask, TaskHookFunction_t pxHookFunction ) PRIVILEGED_FUNCTION;\r
-\r
- /**\r
- * task.h\r
- * <pre>void xTaskGetApplicationTaskTag( TaskHandle_t xTask );</pre>\r
- *\r
- * Returns the pxHookFunction value assigned to the task xTask.\r
- */\r
- TaskHookFunction_t xTaskGetApplicationTaskTag( TaskHandle_t xTask ) PRIVILEGED_FUNCTION;\r
- #endif /* configUSE_APPLICATION_TASK_TAG ==1 */\r
-#endif /* ifdef configUSE_APPLICATION_TASK_TAG */\r
-\r
-#if( configNUM_THREAD_LOCAL_STORAGE_POINTERS > 0 )\r
-\r
- /* Each task contains an array of pointers that is dimensioned by the\r
- configNUM_THREAD_LOCAL_STORAGE_POINTERS setting in FreeRTOSConfig.h. The\r
- kernel does not use the pointers itself, so the application writer can use\r
- the pointers for any purpose they wish. The following two functions are\r
- used to set and query a pointer respectively. */\r
- void vTaskSetThreadLocalStoragePointer( TaskHandle_t xTaskToSet, BaseType_t xIndex, void *pvValue ) PRIVILEGED_FUNCTION;\r
- void *pvTaskGetThreadLocalStoragePointer( TaskHandle_t xTaskToQuery, BaseType_t xIndex ) PRIVILEGED_FUNCTION;\r
-\r
-#endif\r
-\r
-/**\r
- * task.h\r
- * <pre>BaseType_t xTaskCallApplicationTaskHook( TaskHandle_t xTask, void *pvParameter );</pre>\r
- *\r
- * Calls the hook function associated with xTask. Passing xTask as NULL has\r
- * the effect of calling the Running tasks (the calling task) hook function.\r
- *\r
- * pvParameter is passed to the hook function for the task to interpret as it\r
- * wants. The return value is the value returned by the task hook function\r
- * registered by the user.\r
- */\r
-BaseType_t xTaskCallApplicationTaskHook( TaskHandle_t xTask, void *pvParameter ) PRIVILEGED_FUNCTION;\r
-\r
-/**\r
- * xTaskGetIdleTaskHandle() is only available if\r
- * INCLUDE_xTaskGetIdleTaskHandle is set to 1 in FreeRTOSConfig.h.\r
- *\r
- * Simply returns the handle of the idle task. It is not valid to call\r
- * xTaskGetIdleTaskHandle() before the scheduler has been started.\r
- */\r
-TaskHandle_t xTaskGetIdleTaskHandle( void ) PRIVILEGED_FUNCTION;\r
-\r
-/**\r
- * configUSE_TRACE_FACILITY must be defined as 1 in FreeRTOSConfig.h for\r
- * uxTaskGetSystemState() to be available.\r
- *\r
- * uxTaskGetSystemState() populates an TaskStatus_t structure for each task in\r
- * the system. TaskStatus_t structures contain, among other things, members\r
- * for the task handle, task name, task priority, task state, and total amount\r
- * of run time consumed by the task. See the TaskStatus_t structure\r
- * definition in this file for the full member list.\r
- *\r
- * NOTE: This function is intended for debugging use only as its use results in\r
- * the scheduler remaining suspended for an extended period.\r
- *\r
- * @param pxTaskStatusArray A pointer to an array of TaskStatus_t structures.\r
- * The array must contain at least one TaskStatus_t structure for each task\r
- * that is under the control of the RTOS. The number of tasks under the control\r
- * of the RTOS can be determined using the uxTaskGetNumberOfTasks() API function.\r
- *\r
- * @param uxArraySize The size of the array pointed to by the pxTaskStatusArray\r
- * parameter. The size is specified as the number of indexes in the array, or\r
- * the number of TaskStatus_t structures contained in the array, not by the\r
- * number of bytes in the array.\r
- *\r
- * @param pulTotalRunTime If configGENERATE_RUN_TIME_STATS is set to 1 in\r
- * FreeRTOSConfig.h then *pulTotalRunTime is set by uxTaskGetSystemState() to the\r
- * total run time (as defined by the run time stats clock, see\r
- * http://www.freertos.org/rtos-run-time-stats.html) since the target booted.\r
- * pulTotalRunTime can be set to NULL to omit the total run time information.\r
- *\r
- * @return The number of TaskStatus_t structures that were populated by\r
- * uxTaskGetSystemState(). This should equal the number returned by the\r
- * uxTaskGetNumberOfTasks() API function, but will be zero if the value passed\r
- * in the uxArraySize parameter was too small.\r
- *\r
- * Example usage:\r
- <pre>\r
- // This example demonstrates how a human readable table of run time stats\r
- // information is generated from raw data provided by uxTaskGetSystemState().\r
- // The human readable table is written to pcWriteBuffer\r
- void vTaskGetRunTimeStats( char *pcWriteBuffer )\r
- {\r
- TaskStatus_t *pxTaskStatusArray;\r
- volatile UBaseType_t uxArraySize, x;\r
- uint32_t ulTotalRunTime, ulStatsAsPercentage;\r
-\r
- // Make sure the write buffer does not contain a string.\r
- *pcWriteBuffer = 0x00;\r
-\r
- // Take a snapshot of the number of tasks in case it changes while this\r
- // function is executing.\r
- uxArraySize = uxTaskGetNumberOfTasks();\r
-\r
- // Allocate a TaskStatus_t structure for each task. An array could be\r
- // allocated statically at compile time.\r
- pxTaskStatusArray = pvPortMalloc( uxArraySize * sizeof( TaskStatus_t ) );\r
-\r
- if( pxTaskStatusArray != NULL )\r
- {\r
- // Generate raw status information about each task.\r
- uxArraySize = uxTaskGetSystemState( pxTaskStatusArray, uxArraySize, &ulTotalRunTime );\r
-\r
- // For percentage calculations.\r
- ulTotalRunTime /= 100UL;\r
-\r
- // Avoid divide by zero errors.\r
- if( ulTotalRunTime > 0 )\r
- {\r
- // For each populated position in the pxTaskStatusArray array,\r
- // format the raw data as human readable ASCII data\r
- for( x = 0; x < uxArraySize; x++ )\r
- {\r
- // What percentage of the total run time has the task used?\r
- // This will always be rounded down to the nearest integer.\r
- // ulTotalRunTimeDiv100 has already been divided by 100.\r
- ulStatsAsPercentage = pxTaskStatusArray[ x ].ulRunTimeCounter / ulTotalRunTime;\r
-\r
- if( ulStatsAsPercentage > 0UL )\r
- {\r
- sprintf( pcWriteBuffer, "%s\t\t%lu\t\t%lu%%\r\n", pxTaskStatusArray[ x ].pcTaskName, pxTaskStatusArray[ x ].ulRunTimeCounter, ulStatsAsPercentage );\r
- }\r
- else\r
- {\r
- // If the percentage is zero here then the task has\r
- // consumed less than 1% of the total run time.\r
- sprintf( pcWriteBuffer, "%s\t\t%lu\t\t<1%%\r\n", pxTaskStatusArray[ x ].pcTaskName, pxTaskStatusArray[ x ].ulRunTimeCounter );\r
- }\r
-\r
- pcWriteBuffer += strlen( ( char * ) pcWriteBuffer );\r
- }\r
- }\r
-\r
- // The array is no longer needed, free the memory it consumes.\r
- vPortFree( pxTaskStatusArray );\r
- }\r
- }\r
- </pre>\r
- */\r
-UBaseType_t uxTaskGetSystemState( TaskStatus_t * const pxTaskStatusArray, const UBaseType_t uxArraySize, uint32_t * const pulTotalRunTime ) PRIVILEGED_FUNCTION;\r
-\r
-/**\r
- * task. h\r
- * <PRE>void vTaskList( char *pcWriteBuffer );</PRE>\r
- *\r
- * configUSE_TRACE_FACILITY and configUSE_STATS_FORMATTING_FUNCTIONS must\r
- * both be defined as 1 for this function to be available. See the\r
- * configuration section of the FreeRTOS.org website for more information.\r
- *\r
- * NOTE 1: This function will disable interrupts for its duration. It is\r
- * not intended for normal application runtime use but as a debug aid.\r
- *\r
- * Lists all the current tasks, along with their current state and stack\r
- * usage high water mark.\r
- *\r
- * Tasks are reported as blocked ('B'), ready ('R'), deleted ('D') or\r
- * suspended ('S').\r
- *\r
- * PLEASE NOTE:\r
- *\r
- * This function is provided for convenience only, and is used by many of the\r
- * demo applications. Do not consider it to be part of the scheduler.\r
- *\r
- * vTaskList() calls uxTaskGetSystemState(), then formats part of the\r
- * uxTaskGetSystemState() output into a human readable table that displays task\r
- * names, states and stack usage.\r
- *\r
- * vTaskList() has a dependency on the sprintf() C library function that might\r
- * bloat the code size, use a lot of stack, and provide different results on\r
- * different platforms. An alternative, tiny, third party, and limited\r
- * functionality implementation of sprintf() is provided in many of the\r
- * FreeRTOS/Demo sub-directories in a file called printf-stdarg.c (note\r
- * printf-stdarg.c does not provide a full snprintf() implementation!).\r
- *\r
- * It is recommended that production systems call uxTaskGetSystemState()\r
- * directly to get access to raw stats data, rather than indirectly through a\r
- * call to vTaskList().\r
- *\r
- * @param pcWriteBuffer A buffer into which the above mentioned details\r
- * will be written, in ASCII form. This buffer is assumed to be large\r
- * enough to contain the generated report. Approximately 40 bytes per\r
- * task should be sufficient.\r
- *\r
- * \defgroup vTaskList vTaskList\r
- * \ingroup TaskUtils\r
- */\r
-void vTaskList( char * pcWriteBuffer ) PRIVILEGED_FUNCTION; /*lint !e971 Unqualified char types are allowed for strings and single characters only. */\r
-\r
-/**\r
- * task. h\r
- * <PRE>void vTaskGetRunTimeStats( char *pcWriteBuffer );</PRE>\r
- *\r
- * configGENERATE_RUN_TIME_STATS and configUSE_STATS_FORMATTING_FUNCTIONS\r
- * must both be defined as 1 for this function to be available. The application\r
- * must also then provide definitions for\r
- * portCONFIGURE_TIMER_FOR_RUN_TIME_STATS() and portGET_RUN_TIME_COUNTER_VALUE()\r
- * to configure a peripheral timer/counter and return the timers current count\r
- * value respectively. The counter should be at least 10 times the frequency of\r
- * the tick count.\r
- *\r
- * NOTE 1: This function will disable interrupts for its duration. It is\r
- * not intended for normal application runtime use but as a debug aid.\r
- *\r
- * Setting configGENERATE_RUN_TIME_STATS to 1 will result in a total\r
- * accumulated execution time being stored for each task. The resolution\r
- * of the accumulated time value depends on the frequency of the timer\r
- * configured by the portCONFIGURE_TIMER_FOR_RUN_TIME_STATS() macro.\r
- * Calling vTaskGetRunTimeStats() writes the total execution time of each\r
- * task into a buffer, both as an absolute count value and as a percentage\r
- * of the total system execution time.\r
- *\r
- * NOTE 2:\r
- *\r
- * This function is provided for convenience only, and is used by many of the\r
- * demo applications. Do not consider it to be part of the scheduler.\r
- *\r
- * vTaskGetRunTimeStats() calls uxTaskGetSystemState(), then formats part of the\r
- * uxTaskGetSystemState() output into a human readable table that displays the\r
- * amount of time each task has spent in the Running state in both absolute and\r
- * percentage terms.\r
- *\r
- * vTaskGetRunTimeStats() has a dependency on the sprintf() C library function\r
- * that might bloat the code size, use a lot of stack, and provide different\r
- * results on different platforms. An alternative, tiny, third party, and\r
- * limited functionality implementation of sprintf() is provided in many of the\r
- * FreeRTOS/Demo sub-directories in a file called printf-stdarg.c (note\r
- * printf-stdarg.c does not provide a full snprintf() implementation!).\r
- *\r
- * It is recommended that production systems call uxTaskGetSystemState() directly\r
- * to get access to raw stats data, rather than indirectly through a call to\r
- * vTaskGetRunTimeStats().\r
- *\r
- * @param pcWriteBuffer A buffer into which the execution times will be\r
- * written, in ASCII form. This buffer is assumed to be large enough to\r
- * contain the generated report. Approximately 40 bytes per task should\r
- * be sufficient.\r
- *\r
- * \defgroup vTaskGetRunTimeStats vTaskGetRunTimeStats\r
- * \ingroup TaskUtils\r
- */\r
-void vTaskGetRunTimeStats( char *pcWriteBuffer ) PRIVILEGED_FUNCTION; /*lint !e971 Unqualified char types are allowed for strings and single characters only. */\r
-\r
-/**\r
- * task. h\r
- * <PRE>BaseType_t xTaskNotify( TaskHandle_t xTaskToNotify, uint32_t ulValue, eNotifyAction eAction );</PRE>\r
- *\r
- * configUSE_TASK_NOTIFICATIONS must be undefined or defined as 1 for this\r
- * function to be available.\r
- *\r
- * When configUSE_TASK_NOTIFICATIONS is set to one each task has its own private\r
- * "notification value", which is a 32-bit unsigned integer (uint32_t).\r
- *\r
- * Events can be sent to a task using an intermediary object. Examples of such\r
- * objects are queues, semaphores, mutexes and event groups. Task notifications\r
- * are a method of sending an event directly to a task without the need for such\r
- * an intermediary object.\r
- *\r
- * A notification sent to a task can optionally perform an action, such as\r
- * update, overwrite or increment the task's notification value. In that way\r
- * task notifications can be used to send data to a task, or be used as light\r
- * weight and fast binary or counting semaphores.\r
- *\r
- * A notification sent to a task will remain pending until it is cleared by the\r
- * task calling xTaskNotifyWait() or ulTaskNotifyTake(). If the task was\r
- * already in the Blocked state to wait for a notification when the notification\r
- * arrives then the task will automatically be removed from the Blocked state\r
- * (unblocked) and the notification cleared.\r
- *\r
- * A task can use xTaskNotifyWait() to [optionally] block to wait for a\r
- * notification to be pending, or ulTaskNotifyTake() to [optionally] block\r
- * to wait for its notification value to have a non-zero value. The task does\r
- * not consume any CPU time while it is in the Blocked state.\r
- *\r
- * See http://www.FreeRTOS.org/RTOS-task-notifications.html for details.\r
- *\r
- * @param xTaskToNotify The handle of the task being notified. The handle to a\r
- * task can be returned from the xTaskCreate() API function used to create the\r
- * task, and the handle of the currently running task can be obtained by calling\r
- * xTaskGetCurrentTaskHandle().\r
- *\r
- * @param ulValue Data that can be sent with the notification. How the data is\r
- * used depends on the value of the eAction parameter.\r
- *\r
- * @param eAction Specifies how the notification updates the task's notification\r
- * value, if at all. Valid values for eAction are as follows:\r
- *\r
- * eSetBits -\r
- * The task's notification value is bitwise ORed with ulValue. xTaskNofify()\r
- * always returns pdPASS in this case.\r
- *\r
- * eIncrement -\r
- * The task's notification value is incremented. ulValue is not used and\r
- * xTaskNotify() always returns pdPASS in this case.\r
- *\r
- * eSetValueWithOverwrite -\r
- * The task's notification value is set to the value of ulValue, even if the\r
- * task being notified had not yet processed the previous notification (the\r
- * task already had a notification pending). xTaskNotify() always returns\r
- * pdPASS in this case.\r
- *\r
- * eSetValueWithoutOverwrite -\r
- * If the task being notified did not already have a notification pending then\r
- * the task's notification value is set to ulValue and xTaskNotify() will\r
- * return pdPASS. If the task being notified already had a notification\r
- * pending then no action is performed and pdFAIL is returned.\r
- *\r
- * eNoAction -\r
- * The task receives a notification without its notification value being\r
- * updated. ulValue is not used and xTaskNotify() always returns pdPASS in\r
- * this case.\r
- *\r
- * pulPreviousNotificationValue -\r
- * Can be used to pass out the subject task's notification value before any\r
- * bits are modified by the notify function.\r
- *\r
- * @return Dependent on the value of eAction. See the description of the\r
- * eAction parameter.\r
- *\r
- * \defgroup xTaskNotify xTaskNotify\r
- * \ingroup TaskNotifications\r
- */\r
-BaseType_t xTaskGenericNotify( TaskHandle_t xTaskToNotify, uint32_t ulValue, eNotifyAction eAction, uint32_t *pulPreviousNotificationValue ) PRIVILEGED_FUNCTION;\r
-#define xTaskNotify( xTaskToNotify, ulValue, eAction ) xTaskGenericNotify( ( xTaskToNotify ), ( ulValue ), ( eAction ), NULL )\r
-#define xTaskNotifyAndQuery( xTaskToNotify, ulValue, eAction, pulPreviousNotifyValue ) xTaskGenericNotify( ( xTaskToNotify ), ( ulValue ), ( eAction ), ( pulPreviousNotifyValue ) )\r
-\r
-/**\r
- * task. h\r
- * <PRE>BaseType_t xTaskNotifyFromISR( TaskHandle_t xTaskToNotify, uint32_t ulValue, eNotifyAction eAction, BaseType_t *pxHigherPriorityTaskWoken );</PRE>\r
- *\r
- * configUSE_TASK_NOTIFICATIONS must be undefined or defined as 1 for this\r
- * function to be available.\r
- *\r
- * When configUSE_TASK_NOTIFICATIONS is set to one each task has its own private\r
- * "notification value", which is a 32-bit unsigned integer (uint32_t).\r
- *\r
- * A version of xTaskNotify() that can be used from an interrupt service routine\r
- * (ISR).\r
- *\r
- * Events can be sent to a task using an intermediary object. Examples of such\r
- * objects are queues, semaphores, mutexes and event groups. Task notifications\r
- * are a method of sending an event directly to a task without the need for such\r
- * an intermediary object.\r
- *\r
- * A notification sent to a task can optionally perform an action, such as\r
- * update, overwrite or increment the task's notification value. In that way\r
- * task notifications can be used to send data to a task, or be used as light\r
- * weight and fast binary or counting semaphores.\r
- *\r
- * A notification sent to a task will remain pending until it is cleared by the\r
- * task calling xTaskNotifyWait() or ulTaskNotifyTake(). If the task was\r
- * already in the Blocked state to wait for a notification when the notification\r
- * arrives then the task will automatically be removed from the Blocked state\r
- * (unblocked) and the notification cleared.\r
- *\r
- * A task can use xTaskNotifyWait() to [optionally] block to wait for a\r
- * notification to be pending, or ulTaskNotifyTake() to [optionally] block\r
- * to wait for its notification value to have a non-zero value. The task does\r
- * not consume any CPU time while it is in the Blocked state.\r
- *\r
- * See http://www.FreeRTOS.org/RTOS-task-notifications.html for details.\r
- *\r
- * @param xTaskToNotify The handle of the task being notified. The handle to a\r
- * task can be returned from the xTaskCreate() API function used to create the\r
- * task, and the handle of the currently running task can be obtained by calling\r
- * xTaskGetCurrentTaskHandle().\r
- *\r
- * @param ulValue Data that can be sent with the notification. How the data is\r
- * used depends on the value of the eAction parameter.\r
- *\r
- * @param eAction Specifies how the notification updates the task's notification\r
- * value, if at all. Valid values for eAction are as follows:\r
- *\r
- * eSetBits -\r
- * The task's notification value is bitwise ORed with ulValue. xTaskNofify()\r
- * always returns pdPASS in this case.\r
- *\r
- * eIncrement -\r
- * The task's notification value is incremented. ulValue is not used and\r
- * xTaskNotify() always returns pdPASS in this case.\r
- *\r
- * eSetValueWithOverwrite -\r
- * The task's notification value is set to the value of ulValue, even if the\r
- * task being notified had not yet processed the previous notification (the\r
- * task already had a notification pending). xTaskNotify() always returns\r
- * pdPASS in this case.\r
- *\r
- * eSetValueWithoutOverwrite -\r
- * If the task being notified did not already have a notification pending then\r
- * the task's notification value is set to ulValue and xTaskNotify() will\r
- * return pdPASS. If the task being notified already had a notification\r
- * pending then no action is performed and pdFAIL is returned.\r
- *\r
- * eNoAction -\r
- * The task receives a notification without its notification value being\r
- * updated. ulValue is not used and xTaskNotify() always returns pdPASS in\r
- * this case.\r
- *\r
- * @param pxHigherPriorityTaskWoken xTaskNotifyFromISR() will set\r
- * *pxHigherPriorityTaskWoken to pdTRUE if sending the notification caused the\r
- * task to which the notification was sent to leave the Blocked state, and the\r
- * unblocked task has a priority higher than the currently running task. If\r
- * xTaskNotifyFromISR() sets this value to pdTRUE then a context switch should\r
- * be requested before the interrupt is exited. How a context switch is\r
- * requested from an ISR is dependent on the port - see the documentation page\r
- * for the port in use.\r
- *\r
- * @return Dependent on the value of eAction. See the description of the\r
- * eAction parameter.\r
- *\r
- * \defgroup xTaskNotify xTaskNotify\r
- * \ingroup TaskNotifications\r
- */\r
-BaseType_t xTaskGenericNotifyFromISR( TaskHandle_t xTaskToNotify, uint32_t ulValue, eNotifyAction eAction, uint32_t *pulPreviousNotificationValue, BaseType_t *pxHigherPriorityTaskWoken ) PRIVILEGED_FUNCTION;\r
-#define xTaskNotifyFromISR( xTaskToNotify, ulValue, eAction, pxHigherPriorityTaskWoken ) xTaskGenericNotifyFromISR( ( xTaskToNotify ), ( ulValue ), ( eAction ), NULL, ( pxHigherPriorityTaskWoken ) )\r
-#define xTaskNotifyAndQueryFromISR( xTaskToNotify, ulValue, eAction, pulPreviousNotificationValue, pxHigherPriorityTaskWoken ) xTaskGenericNotifyFromISR( ( xTaskToNotify ), ( ulValue ), ( eAction ), ( pulPreviousNotificationValue ), ( pxHigherPriorityTaskWoken ) )\r
-\r
-/**\r
- * task. h\r
- * <PRE>BaseType_t xTaskNotifyWait( uint32_t ulBitsToClearOnEntry, uint32_t ulBitsToClearOnExit, uint32_t *pulNotificationValue, TickType_t xTicksToWait );</pre>\r
- *\r
- * configUSE_TASK_NOTIFICATIONS must be undefined or defined as 1 for this\r
- * function to be available.\r
- *\r
- * When configUSE_TASK_NOTIFICATIONS is set to one each task has its own private\r
- * "notification value", which is a 32-bit unsigned integer (uint32_t).\r
- *\r
- * Events can be sent to a task using an intermediary object. Examples of such\r
- * objects are queues, semaphores, mutexes and event groups. Task notifications\r
- * are a method of sending an event directly to a task without the need for such\r
- * an intermediary object.\r
- *\r
- * A notification sent to a task can optionally perform an action, such as\r
- * update, overwrite or increment the task's notification value. In that way\r
- * task notifications can be used to send data to a task, or be used as light\r
- * weight and fast binary or counting semaphores.\r
- *\r
- * A notification sent to a task will remain pending until it is cleared by the\r
- * task calling xTaskNotifyWait() or ulTaskNotifyTake(). If the task was\r
- * already in the Blocked state to wait for a notification when the notification\r
- * arrives then the task will automatically be removed from the Blocked state\r
- * (unblocked) and the notification cleared.\r
- *\r
- * A task can use xTaskNotifyWait() to [optionally] block to wait for a\r
- * notification to be pending, or ulTaskNotifyTake() to [optionally] block\r
- * to wait for its notification value to have a non-zero value. The task does\r
- * not consume any CPU time while it is in the Blocked state.\r
- *\r
- * See http://www.FreeRTOS.org/RTOS-task-notifications.html for details.\r
- *\r
- * @param ulBitsToClearOnEntry Bits that are set in ulBitsToClearOnEntry value\r
- * will be cleared in the calling task's notification value before the task\r
- * checks to see if any notifications are pending, and optionally blocks if no\r
- * notifications are pending. Setting ulBitsToClearOnEntry to ULONG_MAX (if\r
- * limits.h is included) or 0xffffffffUL (if limits.h is not included) will have\r
- * the effect of resetting the task's notification value to 0. Setting\r
- * ulBitsToClearOnEntry to 0 will leave the task's notification value unchanged.\r
- *\r
- * @param ulBitsToClearOnExit If a notification is pending or received before\r
- * the calling task exits the xTaskNotifyWait() function then the task's\r
- * notification value (see the xTaskNotify() API function) is passed out using\r
- * the pulNotificationValue parameter. Then any bits that are set in\r
- * ulBitsToClearOnExit will be cleared in the task's notification value (note\r
- * *pulNotificationValue is set before any bits are cleared). Setting\r
- * ulBitsToClearOnExit to ULONG_MAX (if limits.h is included) or 0xffffffffUL\r
- * (if limits.h is not included) will have the effect of resetting the task's\r
- * notification value to 0 before the function exits. Setting\r
- * ulBitsToClearOnExit to 0 will leave the task's notification value unchanged\r
- * when the function exits (in which case the value passed out in\r
- * pulNotificationValue will match the task's notification value).\r
- *\r
- * @param pulNotificationValue Used to pass the task's notification value out\r
- * of the function. Note the value passed out will not be effected by the\r
- * clearing of any bits caused by ulBitsToClearOnExit being non-zero.\r
- *\r
- * @param xTicksToWait The maximum amount of time that the task should wait in\r
- * the Blocked state for a notification to be received, should a notification\r
- * not already be pending when xTaskNotifyWait() was called. The task\r
- * will not consume any processing time while it is in the Blocked state. This\r
- * is specified in kernel ticks, the macro pdMS_TO_TICSK( value_in_ms ) can be\r
- * used to convert a time specified in milliseconds to a time specified in\r
- * ticks.\r
- *\r
- * @return If a notification was received (including notifications that were\r
- * already pending when xTaskNotifyWait was called) then pdPASS is\r
- * returned. Otherwise pdFAIL is returned.\r
- *\r
- * \defgroup xTaskNotifyWait xTaskNotifyWait\r
- * \ingroup TaskNotifications\r
- */\r
-BaseType_t xTaskNotifyWait( uint32_t ulBitsToClearOnEntry, uint32_t ulBitsToClearOnExit, uint32_t *pulNotificationValue, TickType_t xTicksToWait ) PRIVILEGED_FUNCTION;\r
-\r
-/**\r
- * task. h\r
- * <PRE>BaseType_t xTaskNotifyGive( TaskHandle_t xTaskToNotify );</PRE>\r
- *\r
- * configUSE_TASK_NOTIFICATIONS must be undefined or defined as 1 for this macro\r
- * to be available.\r
- *\r
- * When configUSE_TASK_NOTIFICATIONS is set to one each task has its own private\r
- * "notification value", which is a 32-bit unsigned integer (uint32_t).\r
- *\r
- * Events can be sent to a task using an intermediary object. Examples of such\r
- * objects are queues, semaphores, mutexes and event groups. Task notifications\r
- * are a method of sending an event directly to a task without the need for such\r
- * an intermediary object.\r
- *\r
- * A notification sent to a task can optionally perform an action, such as\r
- * update, overwrite or increment the task's notification value. In that way\r
- * task notifications can be used to send data to a task, or be used as light\r
- * weight and fast binary or counting semaphores.\r
- *\r
- * xTaskNotifyGive() is a helper macro intended for use when task notifications\r
- * are used as light weight and faster binary or counting semaphore equivalents.\r
- * Actual FreeRTOS semaphores are given using the xSemaphoreGive() API function,\r
- * the equivalent action that instead uses a task notification is\r
- * xTaskNotifyGive().\r
- *\r
- * When task notifications are being used as a binary or counting semaphore\r
- * equivalent then the task being notified should wait for the notification\r
- * using the ulTaskNotificationTake() API function rather than the\r
- * xTaskNotifyWait() API function.\r
- *\r
- * See http://www.FreeRTOS.org/RTOS-task-notifications.html for more details.\r
- *\r
- * @param xTaskToNotify The handle of the task being notified. The handle to a\r
- * task can be returned from the xTaskCreate() API function used to create the\r
- * task, and the handle of the currently running task can be obtained by calling\r
- * xTaskGetCurrentTaskHandle().\r
- *\r
- * @return xTaskNotifyGive() is a macro that calls xTaskNotify() with the\r
- * eAction parameter set to eIncrement - so pdPASS is always returned.\r
- *\r
- * \defgroup xTaskNotifyGive xTaskNotifyGive\r
- * \ingroup TaskNotifications\r
- */\r
-#define xTaskNotifyGive( xTaskToNotify ) xTaskGenericNotify( ( xTaskToNotify ), ( 0 ), eIncrement, NULL )\r
-\r
-/**\r
- * task. h\r
- * <PRE>void vTaskNotifyGiveFromISR( TaskHandle_t xTaskHandle, BaseType_t *pxHigherPriorityTaskWoken );\r
- *\r
- * configUSE_TASK_NOTIFICATIONS must be undefined or defined as 1 for this macro\r
- * to be available.\r
- *\r
- * When configUSE_TASK_NOTIFICATIONS is set to one each task has its own private\r
- * "notification value", which is a 32-bit unsigned integer (uint32_t).\r
- *\r
- * A version of xTaskNotifyGive() that can be called from an interrupt service\r
- * routine (ISR).\r
- *\r
- * Events can be sent to a task using an intermediary object. Examples of such\r
- * objects are queues, semaphores, mutexes and event groups. Task notifications\r
- * are a method of sending an event directly to a task without the need for such\r
- * an intermediary object.\r
- *\r
- * A notification sent to a task can optionally perform an action, such as\r
- * update, overwrite or increment the task's notification value. In that way\r
- * task notifications can be used to send data to a task, or be used as light\r
- * weight and fast binary or counting semaphores.\r
- *\r
- * vTaskNotifyGiveFromISR() is intended for use when task notifications are\r
- * used as light weight and faster binary or counting semaphore equivalents.\r
- * Actual FreeRTOS semaphores are given from an ISR using the\r
- * xSemaphoreGiveFromISR() API function, the equivalent action that instead uses\r
- * a task notification is vTaskNotifyGiveFromISR().\r
- *\r
- * When task notifications are being used as a binary or counting semaphore\r
- * equivalent then the task being notified should wait for the notification\r
- * using the ulTaskNotificationTake() API function rather than the\r
- * xTaskNotifyWait() API function.\r
- *\r
- * See http://www.FreeRTOS.org/RTOS-task-notifications.html for more details.\r
- *\r
- * @param xTaskToNotify The handle of the task being notified. The handle to a\r
- * task can be returned from the xTaskCreate() API function used to create the\r
- * task, and the handle of the currently running task can be obtained by calling\r
- * xTaskGetCurrentTaskHandle().\r
- *\r
- * @param pxHigherPriorityTaskWoken vTaskNotifyGiveFromISR() will set\r
- * *pxHigherPriorityTaskWoken to pdTRUE if sending the notification caused the\r
- * task to which the notification was sent to leave the Blocked state, and the\r
- * unblocked task has a priority higher than the currently running task. If\r
- * vTaskNotifyGiveFromISR() sets this value to pdTRUE then a context switch\r
- * should be requested before the interrupt is exited. How a context switch is\r
- * requested from an ISR is dependent on the port - see the documentation page\r
- * for the port in use.\r
- *\r
- * \defgroup xTaskNotifyWait xTaskNotifyWait\r
- * \ingroup TaskNotifications\r
- */\r
-void vTaskNotifyGiveFromISR( TaskHandle_t xTaskToNotify, BaseType_t *pxHigherPriorityTaskWoken ) PRIVILEGED_FUNCTION;\r
-\r
-/**\r
- * task. h\r
- * <PRE>uint32_t ulTaskNotifyTake( BaseType_t xClearCountOnExit, TickType_t xTicksToWait );</pre>\r
- *\r
- * configUSE_TASK_NOTIFICATIONS must be undefined or defined as 1 for this\r
- * function to be available.\r
- *\r
- * When configUSE_TASK_NOTIFICATIONS is set to one each task has its own private\r
- * "notification value", which is a 32-bit unsigned integer (uint32_t).\r
- *\r
- * Events can be sent to a task using an intermediary object. Examples of such\r
- * objects are queues, semaphores, mutexes and event groups. Task notifications\r
- * are a method of sending an event directly to a task without the need for such\r
- * an intermediary object.\r
- *\r
- * A notification sent to a task can optionally perform an action, such as\r
- * update, overwrite or increment the task's notification value. In that way\r
- * task notifications can be used to send data to a task, or be used as light\r
- * weight and fast binary or counting semaphores.\r
- *\r
- * ulTaskNotifyTake() is intended for use when a task notification is used as a\r
- * faster and lighter weight binary or counting semaphore alternative. Actual\r
- * FreeRTOS semaphores are taken using the xSemaphoreTake() API function, the\r
- * equivalent action that instead uses a task notification is\r
- * ulTaskNotifyTake().\r
- *\r
- * When a task is using its notification value as a binary or counting semaphore\r
- * other tasks should send notifications to it using the xTaskNotifyGive()\r
- * macro, or xTaskNotify() function with the eAction parameter set to\r
- * eIncrement.\r
- *\r
- * ulTaskNotifyTake() can either clear the task's notification value to\r
- * zero on exit, in which case the notification value acts like a binary\r
- * semaphore, or decrement the task's notification value on exit, in which case\r
- * the notification value acts like a counting semaphore.\r
- *\r
- * A task can use ulTaskNotifyTake() to [optionally] block to wait for a\r
- * the task's notification value to be non-zero. The task does not consume any\r
- * CPU time while it is in the Blocked state.\r
- *\r
- * Where as xTaskNotifyWait() will return when a notification is pending,\r
- * ulTaskNotifyTake() will return when the task's notification value is\r
- * not zero.\r
- *\r
- * See http://www.FreeRTOS.org/RTOS-task-notifications.html for details.\r
- *\r
- * @param xClearCountOnExit if xClearCountOnExit is pdFALSE then the task's\r
- * notification value is decremented when the function exits. In this way the\r
- * notification value acts like a counting semaphore. If xClearCountOnExit is\r
- * not pdFALSE then the task's notification value is cleared to zero when the\r
- * function exits. In this way the notification value acts like a binary\r
- * semaphore.\r
- *\r
- * @param xTicksToWait The maximum amount of time that the task should wait in\r
- * the Blocked state for the task's notification value to be greater than zero,\r
- * should the count not already be greater than zero when\r
- * ulTaskNotifyTake() was called. The task will not consume any processing\r
- * time while it is in the Blocked state. This is specified in kernel ticks,\r
- * the macro pdMS_TO_TICSK( value_in_ms ) can be used to convert a time\r
- * specified in milliseconds to a time specified in ticks.\r
- *\r
- * @return The task's notification count before it is either cleared to zero or\r
- * decremented (see the xClearCountOnExit parameter).\r
- *\r
- * \defgroup ulTaskNotifyTake ulTaskNotifyTake\r
- * \ingroup TaskNotifications\r
- */\r
-uint32_t ulTaskNotifyTake( BaseType_t xClearCountOnExit, TickType_t xTicksToWait ) PRIVILEGED_FUNCTION;\r
-\r
-/**\r
- * task. h\r
- * <PRE>BaseType_t xTaskNotifyStateClear( TaskHandle_t xTask );</pre>\r
- *\r
- * If the notification state of the task referenced by the handle xTask is\r
- * eNotified, then set the task's notification state to eNotWaitingNotification.\r
- * The task's notification value is not altered. Set xTask to NULL to clear the\r
- * notification state of the calling task.\r
- *\r
- * @return pdTRUE if the task's notification state was set to\r
- * eNotWaitingNotification, otherwise pdFALSE.\r
- * \defgroup xTaskNotifyStateClear xTaskNotifyStateClear\r
- * \ingroup TaskNotifications\r
- */\r
-BaseType_t xTaskNotifyStateClear( TaskHandle_t xTask );\r
-\r
-/*-----------------------------------------------------------\r
- * SCHEDULER INTERNALS AVAILABLE FOR PORTING PURPOSES\r
- *----------------------------------------------------------*/\r
-\r
-/*\r
- * THIS FUNCTION MUST NOT BE USED FROM APPLICATION CODE. IT IS ONLY\r
- * INTENDED FOR USE WHEN IMPLEMENTING A PORT OF THE SCHEDULER AND IS\r
- * AN INTERFACE WHICH IS FOR THE EXCLUSIVE USE OF THE SCHEDULER.\r
- *\r
- * Called from the real time kernel tick (either preemptive or cooperative),\r
- * this increments the tick count and checks if any tasks that are blocked\r
- * for a finite period required removing from a blocked list and placing on\r
- * a ready list. If a non-zero value is returned then a context switch is\r
- * required because either:\r
- * + A task was removed from a blocked list because its timeout had expired,\r
- * or\r
- * + Time slicing is in use and there is a task of equal priority to the\r
- * currently running task.\r
- */\r
-BaseType_t xTaskIncrementTick( void ) PRIVILEGED_FUNCTION;\r
-\r
-/*\r
- * THIS FUNCTION MUST NOT BE USED FROM APPLICATION CODE. IT IS AN\r
- * INTERFACE WHICH IS FOR THE EXCLUSIVE USE OF THE SCHEDULER.\r
- *\r
- * THIS FUNCTION MUST BE CALLED WITH INTERRUPTS DISABLED.\r
- *\r
- * Removes the calling task from the ready list and places it both\r
- * on the list of tasks waiting for a particular event, and the\r
- * list of delayed tasks. The task will be removed from both lists\r
- * and replaced on the ready list should either the event occur (and\r
- * there be no higher priority tasks waiting on the same event) or\r
- * the delay period expires.\r
- *\r
- * The 'unordered' version replaces the event list item value with the\r
- * xItemValue value, and inserts the list item at the end of the list.\r
- *\r
- * The 'ordered' version uses the existing event list item value (which is the\r
- * owning tasks priority) to insert the list item into the event list is task\r
- * priority order.\r
- *\r
- * @param pxEventList The list containing tasks that are blocked waiting\r
- * for the event to occur.\r
- *\r
- * @param xItemValue The item value to use for the event list item when the\r
- * event list is not ordered by task priority.\r
- *\r
- * @param xTicksToWait The maximum amount of time that the task should wait\r
- * for the event to occur. This is specified in kernel ticks,the constant\r
- * portTICK_PERIOD_MS can be used to convert kernel ticks into a real time\r
- * period.\r
- */\r
-void vTaskPlaceOnEventList( List_t * const pxEventList, const TickType_t xTicksToWait ) PRIVILEGED_FUNCTION;\r
-void vTaskPlaceOnUnorderedEventList( List_t * pxEventList, const TickType_t xItemValue, const TickType_t xTicksToWait ) PRIVILEGED_FUNCTION;\r
-\r
-/*\r
- * THIS FUNCTION MUST NOT BE USED FROM APPLICATION CODE. IT IS AN\r
- * INTERFACE WHICH IS FOR THE EXCLUSIVE USE OF THE SCHEDULER.\r
- *\r
- * THIS FUNCTION MUST BE CALLED WITH INTERRUPTS DISABLED.\r
- *\r
- * This function performs nearly the same function as vTaskPlaceOnEventList().\r
- * The difference being that this function does not permit tasks to block\r
- * indefinitely, whereas vTaskPlaceOnEventList() does.\r
- *\r
- */\r
-void vTaskPlaceOnEventListRestricted( List_t * const pxEventList, TickType_t xTicksToWait, const BaseType_t xWaitIndefinitely ) PRIVILEGED_FUNCTION;\r
-\r
-/*\r
- * THIS FUNCTION MUST NOT BE USED FROM APPLICATION CODE. IT IS AN\r
- * INTERFACE WHICH IS FOR THE EXCLUSIVE USE OF THE SCHEDULER.\r
- *\r
- * THIS FUNCTION MUST BE CALLED WITH INTERRUPTS DISABLED.\r
- *\r
- * Removes a task from both the specified event list and the list of blocked\r
- * tasks, and places it on a ready queue.\r
- *\r
- * xTaskRemoveFromEventList()/vTaskRemoveFromUnorderedEventList() will be called\r
- * if either an event occurs to unblock a task, or the block timeout period\r
- * expires.\r
- *\r
- * xTaskRemoveFromEventList() is used when the event list is in task priority\r
- * order. It removes the list item from the head of the event list as that will\r
- * have the highest priority owning task of all the tasks on the event list.\r
- * vTaskRemoveFromUnorderedEventList() is used when the event list is not\r
- * ordered and the event list items hold something other than the owning tasks\r
- * priority. In this case the event list item value is updated to the value\r
- * passed in the xItemValue parameter.\r
- *\r
- * @return pdTRUE if the task being removed has a higher priority than the task\r
- * making the call, otherwise pdFALSE.\r
- */\r
-BaseType_t xTaskRemoveFromEventList( const List_t * const pxEventList ) PRIVILEGED_FUNCTION;\r
-void vTaskRemoveFromUnorderedEventList( ListItem_t * pxEventListItem, const TickType_t xItemValue ) PRIVILEGED_FUNCTION;\r
-\r
-/*\r
- * THIS FUNCTION MUST NOT BE USED FROM APPLICATION CODE. IT IS ONLY\r
- * INTENDED FOR USE WHEN IMPLEMENTING A PORT OF THE SCHEDULER AND IS\r
- * AN INTERFACE WHICH IS FOR THE EXCLUSIVE USE OF THE SCHEDULER.\r
- *\r
- * Sets the pointer to the current TCB to the TCB of the highest priority task\r
- * that is ready to run.\r
- */\r
-void vTaskSwitchContext( void ) PRIVILEGED_FUNCTION;\r
-\r
-/*\r
- * THESE FUNCTIONS MUST NOT BE USED FROM APPLICATION CODE. THEY ARE USED BY\r
- * THE EVENT BITS MODULE.\r
- */\r
-TickType_t uxTaskResetEventItemValue( void ) PRIVILEGED_FUNCTION;\r
-\r
-/*\r
- * Return the handle of the calling task.\r
- */\r
-TaskHandle_t xTaskGetCurrentTaskHandle( void ) PRIVILEGED_FUNCTION;\r
-\r
-/*\r
- * Capture the current time status for future reference.\r
- */\r
-void vTaskSetTimeOutState( TimeOut_t * const pxTimeOut ) PRIVILEGED_FUNCTION;\r
-\r
-/*\r
- * Compare the time status now with that previously captured to see if the\r
- * timeout has expired.\r
- */\r
-BaseType_t xTaskCheckForTimeOut( TimeOut_t * const pxTimeOut, TickType_t * const pxTicksToWait ) PRIVILEGED_FUNCTION;\r
-\r
-/*\r
- * Shortcut used by the queue implementation to prevent unnecessary call to\r
- * taskYIELD();\r
- */\r
-void vTaskMissedYield( void ) PRIVILEGED_FUNCTION;\r
-\r
-/*\r
- * Returns the scheduler state as taskSCHEDULER_RUNNING,\r
- * taskSCHEDULER_NOT_STARTED or taskSCHEDULER_SUSPENDED.\r
- */\r
-BaseType_t xTaskGetSchedulerState( void ) PRIVILEGED_FUNCTION;\r
-\r
-/*\r
- * Raises the priority of the mutex holder to that of the calling task should\r
- * the mutex holder have a priority less than the calling task.\r
- */\r
-BaseType_t xTaskPriorityInherit( TaskHandle_t const pxMutexHolder ) PRIVILEGED_FUNCTION;\r
-\r
-/*\r
- * Set the priority of a task back to its proper priority in the case that it\r
- * inherited a higher priority while it was holding a semaphore.\r
- */\r
-BaseType_t xTaskPriorityDisinherit( TaskHandle_t const pxMutexHolder ) PRIVILEGED_FUNCTION;\r
-\r
-/*\r
- * If a higher priority task attempting to obtain a mutex caused a lower\r
- * priority task to inherit the higher priority task's priority - but the higher\r
- * priority task then timed out without obtaining the mutex, then the lower\r
- * priority task will disinherit the priority again - but only down as far as\r
- * the highest priority task that is still waiting for the mutex (if there were\r
- * more than one task waiting for the mutex).\r
- */\r
-void vTaskPriorityDisinheritAfterTimeout( TaskHandle_t const pxMutexHolder, UBaseType_t uxHighestPriorityWaitingTask ) PRIVILEGED_FUNCTION;\r
-\r
-/*\r
- * Get the uxTCBNumber assigned to the task referenced by the xTask parameter.\r
- */\r
-UBaseType_t uxTaskGetTaskNumber( TaskHandle_t xTask ) PRIVILEGED_FUNCTION;\r
-\r
-/*\r
- * Set the uxTaskNumber of the task referenced by the xTask parameter to\r
- * uxHandle.\r
- */\r
-void vTaskSetTaskNumber( TaskHandle_t xTask, const UBaseType_t uxHandle ) PRIVILEGED_FUNCTION;\r
-\r
-/*\r
- * Only available when configUSE_TICKLESS_IDLE is set to 1.\r
- * If tickless mode is being used, or a low power mode is implemented, then\r
- * the tick interrupt will not execute during idle periods. When this is the\r
- * case, the tick count value maintained by the scheduler needs to be kept up\r
- * to date with the actual execution time by being skipped forward by a time\r
- * equal to the idle period.\r
- */\r
-void vTaskStepTick( const TickType_t xTicksToJump ) PRIVILEGED_FUNCTION;\r
-\r
-/*\r
- * Only avilable when configUSE_TICKLESS_IDLE is set to 1.\r
- * Provided for use within portSUPPRESS_TICKS_AND_SLEEP() to allow the port\r
- * specific sleep function to determine if it is ok to proceed with the sleep,\r
- * and if it is ok to proceed, if it is ok to sleep indefinitely.\r
- *\r
- * This function is necessary because portSUPPRESS_TICKS_AND_SLEEP() is only\r
- * called with the scheduler suspended, not from within a critical section. It\r
- * is therefore possible for an interrupt to request a context switch between\r
- * portSUPPRESS_TICKS_AND_SLEEP() and the low power mode actually being\r
- * entered. eTaskConfirmSleepModeStatus() should be called from a short\r
- * critical section between the timer being stopped and the sleep mode being\r
- * entered to ensure it is ok to proceed into the sleep mode.\r
- */\r
-eSleepModeStatus eTaskConfirmSleepModeStatus( void ) PRIVILEGED_FUNCTION;\r
-\r
-/*\r
- * For internal use only. Increment the mutex held count when a mutex is\r
- * taken and return the handle of the task that has taken the mutex.\r
- */\r
-void *pvTaskIncrementMutexHeldCount( void ) PRIVILEGED_FUNCTION;\r
-\r
-/*\r
- * For internal use only. Same as vTaskSetTimeOutState(), but without a critial\r
- * section.\r
- */\r
-void vTaskInternalSetTimeOutState( TimeOut_t * const pxTimeOut ) PRIVILEGED_FUNCTION;\r
-\r
-\r
-#ifdef __cplusplus\r
-}\r
-#endif\r
-#endif /* INC_TASK_H */\r
-\r
-\r
-\r
+++ /dev/null
-/*\r
- * FreeRTOS Kernel V10.0.1\r
- * Copyright (C) 2017 Amazon.com, Inc. or its affiliates. All Rights Reserved.\r
- *\r
- * Permission is hereby granted, free of charge, to any person obtaining a copy of\r
- * this software and associated documentation files (the "Software"), to deal in\r
- * the Software without restriction, including without limitation the rights to\r
- * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of\r
- * the Software, and to permit persons to whom the Software is furnished to do so,\r
- * subject to the following conditions:\r
- *\r
- * The above copyright notice and this permission notice shall be included in all\r
- * copies or substantial portions of the Software.\r
- *\r
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\r
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS\r
- * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR\r
- * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER\r
- * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN\r
- * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\r
- *\r
- * http://www.FreeRTOS.org\r
- * http://aws.amazon.com/freertos\r
- *\r
- * 1 tab == 4 spaces!\r
- */\r
-\r
-\r
-#ifndef TIMERS_H\r
-#define TIMERS_H\r
-\r
-#ifndef INC_FREERTOS_H\r
- #error "include FreeRTOS.h must appear in source files before include timers.h"\r
-#endif\r
-\r
-/*lint -save -e537 This headers are only multiply included if the application code\r
-happens to also be including task.h. */\r
-#include "task.h"\r
-/*lint -restore */\r
-\r
-#ifdef __cplusplus\r
-extern "C" {\r
-#endif\r
-\r
-/*-----------------------------------------------------------\r
- * MACROS AND DEFINITIONS\r
- *----------------------------------------------------------*/\r
-\r
-/* IDs for commands that can be sent/received on the timer queue. These are to\r
-be used solely through the macros that make up the public software timer API,\r
-as defined below. The commands that are sent from interrupts must use the\r
-highest numbers as tmrFIRST_FROM_ISR_COMMAND is used to determine if the task\r
-or interrupt version of the queue send function should be used. */\r
-#define tmrCOMMAND_EXECUTE_CALLBACK_FROM_ISR ( ( BaseType_t ) -2 )\r
-#define tmrCOMMAND_EXECUTE_CALLBACK ( ( BaseType_t ) -1 )\r
-#define tmrCOMMAND_START_DONT_TRACE ( ( BaseType_t ) 0 )\r
-#define tmrCOMMAND_START ( ( BaseType_t ) 1 )\r
-#define tmrCOMMAND_RESET ( ( BaseType_t ) 2 )\r
-#define tmrCOMMAND_STOP ( ( BaseType_t ) 3 )\r
-#define tmrCOMMAND_CHANGE_PERIOD ( ( BaseType_t ) 4 )\r
-#define tmrCOMMAND_DELETE ( ( BaseType_t ) 5 )\r
-\r
-#define tmrFIRST_FROM_ISR_COMMAND ( ( BaseType_t ) 6 )\r
-#define tmrCOMMAND_START_FROM_ISR ( ( BaseType_t ) 6 )\r
-#define tmrCOMMAND_RESET_FROM_ISR ( ( BaseType_t ) 7 )\r
-#define tmrCOMMAND_STOP_FROM_ISR ( ( BaseType_t ) 8 )\r
-#define tmrCOMMAND_CHANGE_PERIOD_FROM_ISR ( ( BaseType_t ) 9 )\r
-\r
-\r
-/**\r
- * Type by which software timers are referenced. For example, a call to\r
- * xTimerCreate() returns an TimerHandle_t variable that can then be used to\r
- * reference the subject timer in calls to other software timer API functions\r
- * (for example, xTimerStart(), xTimerReset(), etc.).\r
- */\r
-typedef void * TimerHandle_t;\r
-\r
-/*\r
- * Defines the prototype to which timer callback functions must conform.\r
- */\r
-typedef void (*TimerCallbackFunction_t)( TimerHandle_t xTimer );\r
-\r
-/*\r
- * Defines the prototype to which functions used with the\r
- * xTimerPendFunctionCallFromISR() function must conform.\r
- */\r
-typedef void (*PendedFunction_t)( void *, uint32_t );\r
-\r
-/**\r
- * TimerHandle_t xTimerCreate( const char * const pcTimerName,\r
- * TickType_t xTimerPeriodInTicks,\r
- * UBaseType_t uxAutoReload,\r
- * void * pvTimerID,\r
- * TimerCallbackFunction_t pxCallbackFunction );\r
- *\r
- * Creates a new software timer instance, and returns a handle by which the\r
- * created software timer can be referenced.\r
- *\r
- * Internally, within the FreeRTOS implementation, software timers use a block\r
- * of memory, in which the timer data structure is stored. If a software timer\r
- * is created using xTimerCreate() then the required memory is automatically\r
- * dynamically allocated inside the xTimerCreate() function. (see\r
- * http://www.freertos.org/a00111.html). If a software timer is created using\r
- * xTimerCreateStatic() then the application writer must provide the memory that\r
- * will get used by the software timer. xTimerCreateStatic() therefore allows a\r
- * software timer to be created without using any dynamic memory allocation.\r
- *\r
- * Timers are created in the dormant state. The xTimerStart(), xTimerReset(),\r
- * xTimerStartFromISR(), xTimerResetFromISR(), xTimerChangePeriod() and\r
- * xTimerChangePeriodFromISR() API functions can all be used to transition a\r
- * timer into the active state.\r
- *\r
- * @param pcTimerName A text name that is assigned to the timer. This is done\r
- * purely to assist debugging. The kernel itself only ever references a timer\r
- * by its handle, and never by its name.\r
- *\r
- * @param xTimerPeriodInTicks The timer period. The time is defined in tick\r
- * periods so the constant portTICK_PERIOD_MS can be used to convert a time that\r
- * has been specified in milliseconds. For example, if the timer must expire\r
- * after 100 ticks, then xTimerPeriodInTicks should be set to 100.\r
- * Alternatively, if the timer must expire after 500ms, then xPeriod can be set\r
- * to ( 500 / portTICK_PERIOD_MS ) provided configTICK_RATE_HZ is less than or\r
- * equal to 1000.\r
- *\r
- * @param uxAutoReload If uxAutoReload is set to pdTRUE then the timer will\r
- * expire repeatedly with a frequency set by the xTimerPeriodInTicks parameter.\r
- * If uxAutoReload is set to pdFALSE then the timer will be a one-shot timer and\r
- * enter the dormant state after it expires.\r
- *\r
- * @param pvTimerID An identifier that is assigned to the timer being created.\r
- * Typically this would be used in the timer callback function to identify which\r
- * timer expired when the same callback function is assigned to more than one\r
- * timer.\r
- *\r
- * @param pxCallbackFunction The function to call when the timer expires.\r
- * Callback functions must have the prototype defined by TimerCallbackFunction_t,\r
- * which is "void vCallbackFunction( TimerHandle_t xTimer );".\r
- *\r
- * @return If the timer is successfully created then a handle to the newly\r
- * created timer is returned. If the timer cannot be created (because either\r
- * there is insufficient FreeRTOS heap remaining to allocate the timer\r
- * structures, or the timer period was set to 0) then NULL is returned.\r
- *\r
- * Example usage:\r
- * @verbatim\r
- * #define NUM_TIMERS 5\r
- *\r
- * // An array to hold handles to the created timers.\r
- * TimerHandle_t xTimers[ NUM_TIMERS ];\r
- *\r
- * // An array to hold a count of the number of times each timer expires.\r
- * int32_t lExpireCounters[ NUM_TIMERS ] = { 0 };\r
- *\r
- * // Define a callback function that will be used by multiple timer instances.\r
- * // The callback function does nothing but count the number of times the\r
- * // associated timer expires, and stop the timer once the timer has expired\r
- * // 10 times.\r
- * void vTimerCallback( TimerHandle_t pxTimer )\r
- * {\r
- * int32_t lArrayIndex;\r
- * const int32_t xMaxExpiryCountBeforeStopping = 10;\r
- *\r
- * // Optionally do something if the pxTimer parameter is NULL.\r
- * configASSERT( pxTimer );\r
- *\r
- * // Which timer expired?\r
- * lArrayIndex = ( int32_t ) pvTimerGetTimerID( pxTimer );\r
- *\r
- * // Increment the number of times that pxTimer has expired.\r
- * lExpireCounters[ lArrayIndex ] += 1;\r
- *\r
- * // If the timer has expired 10 times then stop it from running.\r
- * if( lExpireCounters[ lArrayIndex ] == xMaxExpiryCountBeforeStopping )\r
- * {\r
- * // Do not use a block time if calling a timer API function from a\r
- * // timer callback function, as doing so could cause a deadlock!\r
- * xTimerStop( pxTimer, 0 );\r
- * }\r
- * }\r
- *\r
- * void main( void )\r
- * {\r
- * int32_t x;\r
- *\r
- * // Create then start some timers. Starting the timers before the scheduler\r
- * // has been started means the timers will start running immediately that\r
- * // the scheduler starts.\r
- * for( x = 0; x < NUM_TIMERS; x++ )\r
- * {\r
- * xTimers[ x ] = xTimerCreate( "Timer", // Just a text name, not used by the kernel.\r
- * ( 100 * x ), // The timer period in ticks.\r
- * pdTRUE, // The timers will auto-reload themselves when they expire.\r
- * ( void * ) x, // Assign each timer a unique id equal to its array index.\r
- * vTimerCallback // Each timer calls the same callback when it expires.\r
- * );\r
- *\r
- * if( xTimers[ x ] == NULL )\r
- * {\r
- * // The timer was not created.\r
- * }\r
- * else\r
- * {\r
- * // Start the timer. No block time is specified, and even if one was\r
- * // it would be ignored because the scheduler has not yet been\r
- * // started.\r
- * if( xTimerStart( xTimers[ x ], 0 ) != pdPASS )\r
- * {\r
- * // The timer could not be set into the Active state.\r
- * }\r
- * }\r
- * }\r
- *\r
- * // ...\r
- * // Create tasks here.\r
- * // ...\r
- *\r
- * // Starting the scheduler will start the timers running as they have already\r
- * // been set into the active state.\r
- * vTaskStartScheduler();\r
- *\r
- * // Should not reach here.\r
- * for( ;; );\r
- * }\r
- * @endverbatim\r
- */\r
-#if( configSUPPORT_DYNAMIC_ALLOCATION == 1 )\r
- TimerHandle_t xTimerCreate( const char * const pcTimerName, /*lint !e971 Unqualified char types are allowed for strings and single characters only. */\r
- const TickType_t xTimerPeriodInTicks,\r
- const UBaseType_t uxAutoReload,\r
- void * const pvTimerID,\r
- TimerCallbackFunction_t pxCallbackFunction ) PRIVILEGED_FUNCTION;\r
-#endif\r
-\r
-/**\r
- * TimerHandle_t xTimerCreateStatic(const char * const pcTimerName,\r
- * TickType_t xTimerPeriodInTicks,\r
- * UBaseType_t uxAutoReload,\r
- * void * pvTimerID,\r
- * TimerCallbackFunction_t pxCallbackFunction,\r
- * StaticTimer_t *pxTimerBuffer );\r
- *\r
- * Creates a new software timer instance, and returns a handle by which the\r
- * created software timer can be referenced.\r
- *\r
- * Internally, within the FreeRTOS implementation, software timers use a block\r
- * of memory, in which the timer data structure is stored. If a software timer\r
- * is created using xTimerCreate() then the required memory is automatically\r
- * dynamically allocated inside the xTimerCreate() function. (see\r
- * http://www.freertos.org/a00111.html). If a software timer is created using\r
- * xTimerCreateStatic() then the application writer must provide the memory that\r
- * will get used by the software timer. xTimerCreateStatic() therefore allows a\r
- * software timer to be created without using any dynamic memory allocation.\r
- *\r
- * Timers are created in the dormant state. The xTimerStart(), xTimerReset(),\r
- * xTimerStartFromISR(), xTimerResetFromISR(), xTimerChangePeriod() and\r
- * xTimerChangePeriodFromISR() API functions can all be used to transition a\r
- * timer into the active state.\r
- *\r
- * @param pcTimerName A text name that is assigned to the timer. This is done\r
- * purely to assist debugging. The kernel itself only ever references a timer\r
- * by its handle, and never by its name.\r
- *\r
- * @param xTimerPeriodInTicks The timer period. The time is defined in tick\r
- * periods so the constant portTICK_PERIOD_MS can be used to convert a time that\r
- * has been specified in milliseconds. For example, if the timer must expire\r
- * after 100 ticks, then xTimerPeriodInTicks should be set to 100.\r
- * Alternatively, if the timer must expire after 500ms, then xPeriod can be set\r
- * to ( 500 / portTICK_PERIOD_MS ) provided configTICK_RATE_HZ is less than or\r
- * equal to 1000.\r
- *\r
- * @param uxAutoReload If uxAutoReload is set to pdTRUE then the timer will\r
- * expire repeatedly with a frequency set by the xTimerPeriodInTicks parameter.\r
- * If uxAutoReload is set to pdFALSE then the timer will be a one-shot timer and\r
- * enter the dormant state after it expires.\r
- *\r
- * @param pvTimerID An identifier that is assigned to the timer being created.\r
- * Typically this would be used in the timer callback function to identify which\r
- * timer expired when the same callback function is assigned to more than one\r
- * timer.\r
- *\r
- * @param pxCallbackFunction The function to call when the timer expires.\r
- * Callback functions must have the prototype defined by TimerCallbackFunction_t,\r
- * which is "void vCallbackFunction( TimerHandle_t xTimer );".\r
- *\r
- * @param pxTimerBuffer Must point to a variable of type StaticTimer_t, which\r
- * will be then be used to hold the software timer's data structures, removing\r
- * the need for the memory to be allocated dynamically.\r
- *\r
- * @return If the timer is created then a handle to the created timer is\r
- * returned. If pxTimerBuffer was NULL then NULL is returned.\r
- *\r
- * Example usage:\r
- * @verbatim\r
- *\r
- * // The buffer used to hold the software timer's data structure.\r
- * static StaticTimer_t xTimerBuffer;\r
- *\r
- * // A variable that will be incremented by the software timer's callback\r
- * // function.\r
- * UBaseType_t uxVariableToIncrement = 0;\r
- *\r
- * // A software timer callback function that increments a variable passed to\r
- * // it when the software timer was created. After the 5th increment the\r
- * // callback function stops the software timer.\r
- * static void prvTimerCallback( TimerHandle_t xExpiredTimer )\r
- * {\r
- * UBaseType_t *puxVariableToIncrement;\r
- * BaseType_t xReturned;\r
- *\r
- * // Obtain the address of the variable to increment from the timer ID.\r
- * puxVariableToIncrement = ( UBaseType_t * ) pvTimerGetTimerID( xExpiredTimer );\r
- *\r
- * // Increment the variable to show the timer callback has executed.\r
- * ( *puxVariableToIncrement )++;\r
- *\r
- * // If this callback has executed the required number of times, stop the\r
- * // timer.\r
- * if( *puxVariableToIncrement == 5 )\r
- * {\r
- * // This is called from a timer callback so must not block.\r
- * xTimerStop( xExpiredTimer, staticDONT_BLOCK );\r
- * }\r
- * }\r
- *\r
- *\r
- * void main( void )\r
- * {\r
- * // Create the software time. xTimerCreateStatic() has an extra parameter\r
- * // than the normal xTimerCreate() API function. The parameter is a pointer\r
- * // to the StaticTimer_t structure that will hold the software timer\r
- * // structure. If the parameter is passed as NULL then the structure will be\r
- * // allocated dynamically, just as if xTimerCreate() had been called.\r
- * xTimer = xTimerCreateStatic( "T1", // Text name for the task. Helps debugging only. Not used by FreeRTOS.\r
- * xTimerPeriod, // The period of the timer in ticks.\r
- * pdTRUE, // This is an auto-reload timer.\r
- * ( void * ) &uxVariableToIncrement, // A variable incremented by the software timer's callback function\r
- * prvTimerCallback, // The function to execute when the timer expires.\r
- * &xTimerBuffer ); // The buffer that will hold the software timer structure.\r
- *\r
- * // The scheduler has not started yet so a block time is not used.\r
- * xReturned = xTimerStart( xTimer, 0 );\r
- *\r
- * // ...\r
- * // Create tasks here.\r
- * // ...\r
- *\r
- * // Starting the scheduler will start the timers running as they have already\r
- * // been set into the active state.\r
- * vTaskStartScheduler();\r
- *\r
- * // Should not reach here.\r
- * for( ;; );\r
- * }\r
- * @endverbatim\r
- */\r
-#if( configSUPPORT_STATIC_ALLOCATION == 1 )\r
- TimerHandle_t xTimerCreateStatic( const char * const pcTimerName, /*lint !e971 Unqualified char types are allowed for strings and single characters only. */\r
- const TickType_t xTimerPeriodInTicks,\r
- const UBaseType_t uxAutoReload,\r
- void * const pvTimerID,\r
- TimerCallbackFunction_t pxCallbackFunction,\r
- StaticTimer_t *pxTimerBuffer ) PRIVILEGED_FUNCTION;\r
-#endif /* configSUPPORT_STATIC_ALLOCATION */\r
-\r
-/**\r
- * void *pvTimerGetTimerID( TimerHandle_t xTimer );\r
- *\r
- * Returns the ID assigned to the timer.\r
- *\r
- * IDs are assigned to timers using the pvTimerID parameter of the call to\r
- * xTimerCreated() that was used to create the timer, and by calling the\r
- * vTimerSetTimerID() API function.\r
- *\r
- * If the same callback function is assigned to multiple timers then the timer\r
- * ID can be used as time specific (timer local) storage.\r
- *\r
- * @param xTimer The timer being queried.\r
- *\r
- * @return The ID assigned to the timer being queried.\r
- *\r
- * Example usage:\r
- *\r
- * See the xTimerCreate() API function example usage scenario.\r
- */\r
-void *pvTimerGetTimerID( const TimerHandle_t xTimer ) PRIVILEGED_FUNCTION;\r
-\r
-/**\r
- * void vTimerSetTimerID( TimerHandle_t xTimer, void *pvNewID );\r
- *\r
- * Sets the ID assigned to the timer.\r
- *\r
- * IDs are assigned to timers using the pvTimerID parameter of the call to\r
- * xTimerCreated() that was used to create the timer.\r
- *\r
- * If the same callback function is assigned to multiple timers then the timer\r
- * ID can be used as time specific (timer local) storage.\r
- *\r
- * @param xTimer The timer being updated.\r
- *\r
- * @param pvNewID The ID to assign to the timer.\r
- *\r
- * Example usage:\r
- *\r
- * See the xTimerCreate() API function example usage scenario.\r
- */\r
-void vTimerSetTimerID( TimerHandle_t xTimer, void *pvNewID ) PRIVILEGED_FUNCTION;\r
-\r
-/**\r
- * BaseType_t xTimerIsTimerActive( TimerHandle_t xTimer );\r
- *\r
- * Queries a timer to see if it is active or dormant.\r
- *\r
- * A timer will be dormant if:\r
- * 1) It has been created but not started, or\r
- * 2) It is an expired one-shot timer that has not been restarted.\r
- *\r
- * Timers are created in the dormant state. The xTimerStart(), xTimerReset(),\r
- * xTimerStartFromISR(), xTimerResetFromISR(), xTimerChangePeriod() and\r
- * xTimerChangePeriodFromISR() API functions can all be used to transition a timer into the\r
- * active state.\r
- *\r
- * @param xTimer The timer being queried.\r
- *\r
- * @return pdFALSE will be returned if the timer is dormant. A value other than\r
- * pdFALSE will be returned if the timer is active.\r
- *\r
- * Example usage:\r
- * @verbatim\r
- * // This function assumes xTimer has already been created.\r
- * void vAFunction( TimerHandle_t xTimer )\r
- * {\r
- * if( xTimerIsTimerActive( xTimer ) != pdFALSE ) // or more simply and equivalently "if( xTimerIsTimerActive( xTimer ) )"\r
- * {\r
- * // xTimer is active, do something.\r
- * }\r
- * else\r
- * {\r
- * // xTimer is not active, do something else.\r
- * }\r
- * }\r
- * @endverbatim\r
- */\r
-BaseType_t xTimerIsTimerActive( TimerHandle_t xTimer ) PRIVILEGED_FUNCTION;\r
-\r
-/**\r
- * TaskHandle_t xTimerGetTimerDaemonTaskHandle( void );\r
- *\r
- * Simply returns the handle of the timer service/daemon task. It it not valid\r
- * to call xTimerGetTimerDaemonTaskHandle() before the scheduler has been started.\r
- */\r
-TaskHandle_t xTimerGetTimerDaemonTaskHandle( void ) PRIVILEGED_FUNCTION;\r
-\r
-/**\r
- * BaseType_t xTimerStart( TimerHandle_t xTimer, TickType_t xTicksToWait );\r
- *\r
- * Timer functionality is provided by a timer service/daemon task. Many of the\r
- * public FreeRTOS timer API functions send commands to the timer service task\r
- * through a queue called the timer command queue. The timer command queue is\r
- * private to the kernel itself and is not directly accessible to application\r
- * code. The length of the timer command queue is set by the\r
- * configTIMER_QUEUE_LENGTH configuration constant.\r
- *\r
- * xTimerStart() starts a timer that was previously created using the\r
- * xTimerCreate() API function. If the timer had already been started and was\r
- * already in the active state, then xTimerStart() has equivalent functionality\r
- * to the xTimerReset() API function.\r
- *\r
- * Starting a timer ensures the timer is in the active state. If the timer\r
- * is not stopped, deleted, or reset in the mean time, the callback function\r
- * associated with the timer will get called 'n' ticks after xTimerStart() was\r
- * called, where 'n' is the timers defined period.\r
- *\r
- * It is valid to call xTimerStart() before the scheduler has been started, but\r
- * when this is done the timer will not actually start until the scheduler is\r
- * started, and the timers expiry time will be relative to when the scheduler is\r
- * started, not relative to when xTimerStart() was called.\r
- *\r
- * The configUSE_TIMERS configuration constant must be set to 1 for xTimerStart()\r
- * to be available.\r
- *\r
- * @param xTimer The handle of the timer being started/restarted.\r
- *\r
- * @param xTicksToWait Specifies the time, in ticks, that the calling task should\r
- * be held in the Blocked state to wait for the start command to be successfully\r
- * sent to the timer command queue, should the queue already be full when\r
- * xTimerStart() was called. xTicksToWait is ignored if xTimerStart() is called\r
- * before the scheduler is started.\r
- *\r
- * @return pdFAIL will be returned if the start command could not be sent to\r
- * the timer command queue even after xTicksToWait ticks had passed. pdPASS will\r
- * be returned if the command was successfully sent to the timer command queue.\r
- * When the command is actually processed will depend on the priority of the\r
- * timer service/daemon task relative to other tasks in the system, although the\r
- * timers expiry time is relative to when xTimerStart() is actually called. The\r
- * timer service/daemon task priority is set by the configTIMER_TASK_PRIORITY\r
- * configuration constant.\r
- *\r
- * Example usage:\r
- *\r
- * See the xTimerCreate() API function example usage scenario.\r
- *\r
- */\r
-#define xTimerStart( xTimer, xTicksToWait ) xTimerGenericCommand( ( xTimer ), tmrCOMMAND_START, ( xTaskGetTickCount() ), NULL, ( xTicksToWait ) )\r
-\r
-/**\r
- * BaseType_t xTimerStop( TimerHandle_t xTimer, TickType_t xTicksToWait );\r
- *\r
- * Timer functionality is provided by a timer service/daemon task. Many of the\r
- * public FreeRTOS timer API functions send commands to the timer service task\r
- * through a queue called the timer command queue. The timer command queue is\r
- * private to the kernel itself and is not directly accessible to application\r
- * code. The length of the timer command queue is set by the\r
- * configTIMER_QUEUE_LENGTH configuration constant.\r
- *\r
- * xTimerStop() stops a timer that was previously started using either of the\r
- * The xTimerStart(), xTimerReset(), xTimerStartFromISR(), xTimerResetFromISR(),\r
- * xTimerChangePeriod() or xTimerChangePeriodFromISR() API functions.\r
- *\r
- * Stopping a timer ensures the timer is not in the active state.\r
- *\r
- * The configUSE_TIMERS configuration constant must be set to 1 for xTimerStop()\r
- * to be available.\r
- *\r
- * @param xTimer The handle of the timer being stopped.\r
- *\r
- * @param xTicksToWait Specifies the time, in ticks, that the calling task should\r
- * be held in the Blocked state to wait for the stop command to be successfully\r
- * sent to the timer command queue, should the queue already be full when\r
- * xTimerStop() was called. xTicksToWait is ignored if xTimerStop() is called\r
- * before the scheduler is started.\r
- *\r
- * @return pdFAIL will be returned if the stop command could not be sent to\r
- * the timer command queue even after xTicksToWait ticks had passed. pdPASS will\r
- * be returned if the command was successfully sent to the timer command queue.\r
- * When the command is actually processed will depend on the priority of the\r
- * timer service/daemon task relative to other tasks in the system. The timer\r
- * service/daemon task priority is set by the configTIMER_TASK_PRIORITY\r
- * configuration constant.\r
- *\r
- * Example usage:\r
- *\r
- * See the xTimerCreate() API function example usage scenario.\r
- *\r
- */\r
-#define xTimerStop( xTimer, xTicksToWait ) xTimerGenericCommand( ( xTimer ), tmrCOMMAND_STOP, 0U, NULL, ( xTicksToWait ) )\r
-\r
-/**\r
- * BaseType_t xTimerChangePeriod( TimerHandle_t xTimer,\r
- * TickType_t xNewPeriod,\r
- * TickType_t xTicksToWait );\r
- *\r
- * Timer functionality is provided by a timer service/daemon task. Many of the\r
- * public FreeRTOS timer API functions send commands to the timer service task\r
- * through a queue called the timer command queue. The timer command queue is\r
- * private to the kernel itself and is not directly accessible to application\r
- * code. The length of the timer command queue is set by the\r
- * configTIMER_QUEUE_LENGTH configuration constant.\r
- *\r
- * xTimerChangePeriod() changes the period of a timer that was previously\r
- * created using the xTimerCreate() API function.\r
- *\r
- * xTimerChangePeriod() can be called to change the period of an active or\r
- * dormant state timer.\r
- *\r
- * The configUSE_TIMERS configuration constant must be set to 1 for\r
- * xTimerChangePeriod() to be available.\r
- *\r
- * @param xTimer The handle of the timer that is having its period changed.\r
- *\r
- * @param xNewPeriod The new period for xTimer. Timer periods are specified in\r
- * tick periods, so the constant portTICK_PERIOD_MS can be used to convert a time\r
- * that has been specified in milliseconds. For example, if the timer must\r
- * expire after 100 ticks, then xNewPeriod should be set to 100. Alternatively,\r
- * if the timer must expire after 500ms, then xNewPeriod can be set to\r
- * ( 500 / portTICK_PERIOD_MS ) provided configTICK_RATE_HZ is less than\r
- * or equal to 1000.\r
- *\r
- * @param xTicksToWait Specifies the time, in ticks, that the calling task should\r
- * be held in the Blocked state to wait for the change period command to be\r
- * successfully sent to the timer command queue, should the queue already be\r
- * full when xTimerChangePeriod() was called. xTicksToWait is ignored if\r
- * xTimerChangePeriod() is called before the scheduler is started.\r
- *\r
- * @return pdFAIL will be returned if the change period command could not be\r
- * sent to the timer command queue even after xTicksToWait ticks had passed.\r
- * pdPASS will be returned if the command was successfully sent to the timer\r
- * command queue. When the command is actually processed will depend on the\r
- * priority of the timer service/daemon task relative to other tasks in the\r
- * system. The timer service/daemon task priority is set by the\r
- * configTIMER_TASK_PRIORITY configuration constant.\r
- *\r
- * Example usage:\r
- * @verbatim\r
- * // This function assumes xTimer has already been created. If the timer\r
- * // referenced by xTimer is already active when it is called, then the timer\r
- * // is deleted. If the timer referenced by xTimer is not active when it is\r
- * // called, then the period of the timer is set to 500ms and the timer is\r
- * // started.\r
- * void vAFunction( TimerHandle_t xTimer )\r
- * {\r
- * if( xTimerIsTimerActive( xTimer ) != pdFALSE ) // or more simply and equivalently "if( xTimerIsTimerActive( xTimer ) )"\r
- * {\r
- * // xTimer is already active - delete it.\r
- * xTimerDelete( xTimer );\r
- * }\r
- * else\r
- * {\r
- * // xTimer is not active, change its period to 500ms. This will also\r
- * // cause the timer to start. Block for a maximum of 100 ticks if the\r
- * // change period command cannot immediately be sent to the timer\r
- * // command queue.\r
- * if( xTimerChangePeriod( xTimer, 500 / portTICK_PERIOD_MS, 100 ) == pdPASS )\r
- * {\r
- * // The command was successfully sent.\r
- * }\r
- * else\r
- * {\r
- * // The command could not be sent, even after waiting for 100 ticks\r
- * // to pass. Take appropriate action here.\r
- * }\r
- * }\r
- * }\r
- * @endverbatim\r
- */\r
- #define xTimerChangePeriod( xTimer, xNewPeriod, xTicksToWait ) xTimerGenericCommand( ( xTimer ), tmrCOMMAND_CHANGE_PERIOD, ( xNewPeriod ), NULL, ( xTicksToWait ) )\r
-\r
-/**\r
- * BaseType_t xTimerDelete( TimerHandle_t xTimer, TickType_t xTicksToWait );\r
- *\r
- * Timer functionality is provided by a timer service/daemon task. Many of the\r
- * public FreeRTOS timer API functions send commands to the timer service task\r
- * through a queue called the timer command queue. The timer command queue is\r
- * private to the kernel itself and is not directly accessible to application\r
- * code. The length of the timer command queue is set by the\r
- * configTIMER_QUEUE_LENGTH configuration constant.\r
- *\r
- * xTimerDelete() deletes a timer that was previously created using the\r
- * xTimerCreate() API function.\r
- *\r
- * The configUSE_TIMERS configuration constant must be set to 1 for\r
- * xTimerDelete() to be available.\r
- *\r
- * @param xTimer The handle of the timer being deleted.\r
- *\r
- * @param xTicksToWait Specifies the time, in ticks, that the calling task should\r
- * be held in the Blocked state to wait for the delete command to be\r
- * successfully sent to the timer command queue, should the queue already be\r
- * full when xTimerDelete() was called. xTicksToWait is ignored if xTimerDelete()\r
- * is called before the scheduler is started.\r
- *\r
- * @return pdFAIL will be returned if the delete command could not be sent to\r
- * the timer command queue even after xTicksToWait ticks had passed. pdPASS will\r
- * be returned if the command was successfully sent to the timer command queue.\r
- * When the command is actually processed will depend on the priority of the\r
- * timer service/daemon task relative to other tasks in the system. The timer\r
- * service/daemon task priority is set by the configTIMER_TASK_PRIORITY\r
- * configuration constant.\r
- *\r
- * Example usage:\r
- *\r
- * See the xTimerChangePeriod() API function example usage scenario.\r
- */\r
-#define xTimerDelete( xTimer, xTicksToWait ) xTimerGenericCommand( ( xTimer ), tmrCOMMAND_DELETE, 0U, NULL, ( xTicksToWait ) )\r
-\r
-/**\r
- * BaseType_t xTimerReset( TimerHandle_t xTimer, TickType_t xTicksToWait );\r
- *\r
- * Timer functionality is provided by a timer service/daemon task. Many of the\r
- * public FreeRTOS timer API functions send commands to the timer service task\r
- * through a queue called the timer command queue. The timer command queue is\r
- * private to the kernel itself and is not directly accessible to application\r
- * code. The length of the timer command queue is set by the\r
- * configTIMER_QUEUE_LENGTH configuration constant.\r
- *\r
- * xTimerReset() re-starts a timer that was previously created using the\r
- * xTimerCreate() API function. If the timer had already been started and was\r
- * already in the active state, then xTimerReset() will cause the timer to\r
- * re-evaluate its expiry time so that it is relative to when xTimerReset() was\r
- * called. If the timer was in the dormant state then xTimerReset() has\r
- * equivalent functionality to the xTimerStart() API function.\r
- *\r
- * Resetting a timer ensures the timer is in the active state. If the timer\r
- * is not stopped, deleted, or reset in the mean time, the callback function\r
- * associated with the timer will get called 'n' ticks after xTimerReset() was\r
- * called, where 'n' is the timers defined period.\r
- *\r
- * It is valid to call xTimerReset() before the scheduler has been started, but\r
- * when this is done the timer will not actually start until the scheduler is\r
- * started, and the timers expiry time will be relative to when the scheduler is\r
- * started, not relative to when xTimerReset() was called.\r
- *\r
- * The configUSE_TIMERS configuration constant must be set to 1 for xTimerReset()\r
- * to be available.\r
- *\r
- * @param xTimer The handle of the timer being reset/started/restarted.\r
- *\r
- * @param xTicksToWait Specifies the time, in ticks, that the calling task should\r
- * be held in the Blocked state to wait for the reset command to be successfully\r
- * sent to the timer command queue, should the queue already be full when\r
- * xTimerReset() was called. xTicksToWait is ignored if xTimerReset() is called\r
- * before the scheduler is started.\r
- *\r
- * @return pdFAIL will be returned if the reset command could not be sent to\r
- * the timer command queue even after xTicksToWait ticks had passed. pdPASS will\r
- * be returned if the command was successfully sent to the timer command queue.\r
- * When the command is actually processed will depend on the priority of the\r
- * timer service/daemon task relative to other tasks in the system, although the\r
- * timers expiry time is relative to when xTimerStart() is actually called. The\r
- * timer service/daemon task priority is set by the configTIMER_TASK_PRIORITY\r
- * configuration constant.\r
- *\r
- * Example usage:\r
- * @verbatim\r
- * // When a key is pressed, an LCD back-light is switched on. If 5 seconds pass\r
- * // without a key being pressed, then the LCD back-light is switched off. In\r
- * // this case, the timer is a one-shot timer.\r
- *\r
- * TimerHandle_t xBacklightTimer = NULL;\r
- *\r
- * // The callback function assigned to the one-shot timer. In this case the\r
- * // parameter is not used.\r
- * void vBacklightTimerCallback( TimerHandle_t pxTimer )\r
- * {\r
- * // The timer expired, therefore 5 seconds must have passed since a key\r
- * // was pressed. Switch off the LCD back-light.\r
- * vSetBacklightState( BACKLIGHT_OFF );\r
- * }\r
- *\r
- * // The key press event handler.\r
- * void vKeyPressEventHandler( char cKey )\r
- * {\r
- * // Ensure the LCD back-light is on, then reset the timer that is\r
- * // responsible for turning the back-light off after 5 seconds of\r
- * // key inactivity. Wait 10 ticks for the command to be successfully sent\r
- * // if it cannot be sent immediately.\r
- * vSetBacklightState( BACKLIGHT_ON );\r
- * if( xTimerReset( xBacklightTimer, 100 ) != pdPASS )\r
- * {\r
- * // The reset command was not executed successfully. Take appropriate\r
- * // action here.\r
- * }\r
- *\r
- * // Perform the rest of the key processing here.\r
- * }\r
- *\r
- * void main( void )\r
- * {\r
- * int32_t x;\r
- *\r
- * // Create then start the one-shot timer that is responsible for turning\r
- * // the back-light off if no keys are pressed within a 5 second period.\r
- * xBacklightTimer = xTimerCreate( "BacklightTimer", // Just a text name, not used by the kernel.\r
- * ( 5000 / portTICK_PERIOD_MS), // The timer period in ticks.\r
- * pdFALSE, // The timer is a one-shot timer.\r
- * 0, // The id is not used by the callback so can take any value.\r
- * vBacklightTimerCallback // The callback function that switches the LCD back-light off.\r
- * );\r
- *\r
- * if( xBacklightTimer == NULL )\r
- * {\r
- * // The timer was not created.\r
- * }\r
- * else\r
- * {\r
- * // Start the timer. No block time is specified, and even if one was\r
- * // it would be ignored because the scheduler has not yet been\r
- * // started.\r
- * if( xTimerStart( xBacklightTimer, 0 ) != pdPASS )\r
- * {\r
- * // The timer could not be set into the Active state.\r
- * }\r
- * }\r
- *\r
- * // ...\r
- * // Create tasks here.\r
- * // ...\r
- *\r
- * // Starting the scheduler will start the timer running as it has already\r
- * // been set into the active state.\r
- * vTaskStartScheduler();\r
- *\r
- * // Should not reach here.\r
- * for( ;; );\r
- * }\r
- * @endverbatim\r
- */\r
-#define xTimerReset( xTimer, xTicksToWait ) xTimerGenericCommand( ( xTimer ), tmrCOMMAND_RESET, ( xTaskGetTickCount() ), NULL, ( xTicksToWait ) )\r
-\r
-/**\r
- * BaseType_t xTimerStartFromISR( TimerHandle_t xTimer,\r
- * BaseType_t *pxHigherPriorityTaskWoken );\r
- *\r
- * A version of xTimerStart() that can be called from an interrupt service\r
- * routine.\r
- *\r
- * @param xTimer The handle of the timer being started/restarted.\r
- *\r
- * @param pxHigherPriorityTaskWoken The timer service/daemon task spends most\r
- * of its time in the Blocked state, waiting for messages to arrive on the timer\r
- * command queue. Calling xTimerStartFromISR() writes a message to the timer\r
- * command queue, so has the potential to transition the timer service/daemon\r
- * task out of the Blocked state. If calling xTimerStartFromISR() causes the\r
- * timer service/daemon task to leave the Blocked state, and the timer service/\r
- * daemon task has a priority equal to or greater than the currently executing\r
- * task (the task that was interrupted), then *pxHigherPriorityTaskWoken will\r
- * get set to pdTRUE internally within the xTimerStartFromISR() function. If\r
- * xTimerStartFromISR() sets this value to pdTRUE then a context switch should\r
- * be performed before the interrupt exits.\r
- *\r
- * @return pdFAIL will be returned if the start command could not be sent to\r
- * the timer command queue. pdPASS will be returned if the command was\r
- * successfully sent to the timer command queue. When the command is actually\r
- * processed will depend on the priority of the timer service/daemon task\r
- * relative to other tasks in the system, although the timers expiry time is\r
- * relative to when xTimerStartFromISR() is actually called. The timer\r
- * service/daemon task priority is set by the configTIMER_TASK_PRIORITY\r
- * configuration constant.\r
- *\r
- * Example usage:\r
- * @verbatim\r
- * // This scenario assumes xBacklightTimer has already been created. When a\r
- * // key is pressed, an LCD back-light is switched on. If 5 seconds pass\r
- * // without a key being pressed, then the LCD back-light is switched off. In\r
- * // this case, the timer is a one-shot timer, and unlike the example given for\r
- * // the xTimerReset() function, the key press event handler is an interrupt\r
- * // service routine.\r
- *\r
- * // The callback function assigned to the one-shot timer. In this case the\r
- * // parameter is not used.\r
- * void vBacklightTimerCallback( TimerHandle_t pxTimer )\r
- * {\r
- * // The timer expired, therefore 5 seconds must have passed since a key\r
- * // was pressed. Switch off the LCD back-light.\r
- * vSetBacklightState( BACKLIGHT_OFF );\r
- * }\r
- *\r
- * // The key press interrupt service routine.\r
- * void vKeyPressEventInterruptHandler( void )\r
- * {\r
- * BaseType_t xHigherPriorityTaskWoken = pdFALSE;\r
- *\r
- * // Ensure the LCD back-light is on, then restart the timer that is\r
- * // responsible for turning the back-light off after 5 seconds of\r
- * // key inactivity. This is an interrupt service routine so can only\r
- * // call FreeRTOS API functions that end in "FromISR".\r
- * vSetBacklightState( BACKLIGHT_ON );\r
- *\r
- * // xTimerStartFromISR() or xTimerResetFromISR() could be called here\r
- * // as both cause the timer to re-calculate its expiry time.\r
- * // xHigherPriorityTaskWoken was initialised to pdFALSE when it was\r
- * // declared (in this function).\r
- * if( xTimerStartFromISR( xBacklightTimer, &xHigherPriorityTaskWoken ) != pdPASS )\r
- * {\r
- * // The start command was not executed successfully. Take appropriate\r
- * // action here.\r
- * }\r
- *\r
- * // Perform the rest of the key processing here.\r
- *\r
- * // If xHigherPriorityTaskWoken equals pdTRUE, then a context switch\r
- * // should be performed. The syntax required to perform a context switch\r
- * // from inside an ISR varies from port to port, and from compiler to\r
- * // compiler. Inspect the demos for the port you are using to find the\r
- * // actual syntax required.\r
- * if( xHigherPriorityTaskWoken != pdFALSE )\r
- * {\r
- * // Call the interrupt safe yield function here (actual function\r
- * // depends on the FreeRTOS port being used).\r
- * }\r
- * }\r
- * @endverbatim\r
- */\r
-#define xTimerStartFromISR( xTimer, pxHigherPriorityTaskWoken ) xTimerGenericCommand( ( xTimer ), tmrCOMMAND_START_FROM_ISR, ( xTaskGetTickCountFromISR() ), ( pxHigherPriorityTaskWoken ), 0U )\r
-\r
-/**\r
- * BaseType_t xTimerStopFromISR( TimerHandle_t xTimer,\r
- * BaseType_t *pxHigherPriorityTaskWoken );\r
- *\r
- * A version of xTimerStop() that can be called from an interrupt service\r
- * routine.\r
- *\r
- * @param xTimer The handle of the timer being stopped.\r
- *\r
- * @param pxHigherPriorityTaskWoken The timer service/daemon task spends most\r
- * of its time in the Blocked state, waiting for messages to arrive on the timer\r
- * command queue. Calling xTimerStopFromISR() writes a message to the timer\r
- * command queue, so has the potential to transition the timer service/daemon\r
- * task out of the Blocked state. If calling xTimerStopFromISR() causes the\r
- * timer service/daemon task to leave the Blocked state, and the timer service/\r
- * daemon task has a priority equal to or greater than the currently executing\r
- * task (the task that was interrupted), then *pxHigherPriorityTaskWoken will\r
- * get set to pdTRUE internally within the xTimerStopFromISR() function. If\r
- * xTimerStopFromISR() sets this value to pdTRUE then a context switch should\r
- * be performed before the interrupt exits.\r
- *\r
- * @return pdFAIL will be returned if the stop command could not be sent to\r
- * the timer command queue. pdPASS will be returned if the command was\r
- * successfully sent to the timer command queue. When the command is actually\r
- * processed will depend on the priority of the timer service/daemon task\r
- * relative to other tasks in the system. The timer service/daemon task\r
- * priority is set by the configTIMER_TASK_PRIORITY configuration constant.\r
- *\r
- * Example usage:\r
- * @verbatim\r
- * // This scenario assumes xTimer has already been created and started. When\r
- * // an interrupt occurs, the timer should be simply stopped.\r
- *\r
- * // The interrupt service routine that stops the timer.\r
- * void vAnExampleInterruptServiceRoutine( void )\r
- * {\r
- * BaseType_t xHigherPriorityTaskWoken = pdFALSE;\r
- *\r
- * // The interrupt has occurred - simply stop the timer.\r
- * // xHigherPriorityTaskWoken was set to pdFALSE where it was defined\r
- * // (within this function). As this is an interrupt service routine, only\r
- * // FreeRTOS API functions that end in "FromISR" can be used.\r
- * if( xTimerStopFromISR( xTimer, &xHigherPriorityTaskWoken ) != pdPASS )\r
- * {\r
- * // The stop command was not executed successfully. Take appropriate\r
- * // action here.\r
- * }\r
- *\r
- * // If xHigherPriorityTaskWoken equals pdTRUE, then a context switch\r
- * // should be performed. The syntax required to perform a context switch\r
- * // from inside an ISR varies from port to port, and from compiler to\r
- * // compiler. Inspect the demos for the port you are using to find the\r
- * // actual syntax required.\r
- * if( xHigherPriorityTaskWoken != pdFALSE )\r
- * {\r
- * // Call the interrupt safe yield function here (actual function\r
- * // depends on the FreeRTOS port being used).\r
- * }\r
- * }\r
- * @endverbatim\r
- */\r
-#define xTimerStopFromISR( xTimer, pxHigherPriorityTaskWoken ) xTimerGenericCommand( ( xTimer ), tmrCOMMAND_STOP_FROM_ISR, 0, ( pxHigherPriorityTaskWoken ), 0U )\r
-\r
-/**\r
- * BaseType_t xTimerChangePeriodFromISR( TimerHandle_t xTimer,\r
- * TickType_t xNewPeriod,\r
- * BaseType_t *pxHigherPriorityTaskWoken );\r
- *\r
- * A version of xTimerChangePeriod() that can be called from an interrupt\r
- * service routine.\r
- *\r
- * @param xTimer The handle of the timer that is having its period changed.\r
- *\r
- * @param xNewPeriod The new period for xTimer. Timer periods are specified in\r
- * tick periods, so the constant portTICK_PERIOD_MS can be used to convert a time\r
- * that has been specified in milliseconds. For example, if the timer must\r
- * expire after 100 ticks, then xNewPeriod should be set to 100. Alternatively,\r
- * if the timer must expire after 500ms, then xNewPeriod can be set to\r
- * ( 500 / portTICK_PERIOD_MS ) provided configTICK_RATE_HZ is less than\r
- * or equal to 1000.\r
- *\r
- * @param pxHigherPriorityTaskWoken The timer service/daemon task spends most\r
- * of its time in the Blocked state, waiting for messages to arrive on the timer\r
- * command queue. Calling xTimerChangePeriodFromISR() writes a message to the\r
- * timer command queue, so has the potential to transition the timer service/\r
- * daemon task out of the Blocked state. If calling xTimerChangePeriodFromISR()\r
- * causes the timer service/daemon task to leave the Blocked state, and the\r
- * timer service/daemon task has a priority equal to or greater than the\r
- * currently executing task (the task that was interrupted), then\r
- * *pxHigherPriorityTaskWoken will get set to pdTRUE internally within the\r
- * xTimerChangePeriodFromISR() function. If xTimerChangePeriodFromISR() sets\r
- * this value to pdTRUE then a context switch should be performed before the\r
- * interrupt exits.\r
- *\r
- * @return pdFAIL will be returned if the command to change the timers period\r
- * could not be sent to the timer command queue. pdPASS will be returned if the\r
- * command was successfully sent to the timer command queue. When the command\r
- * is actually processed will depend on the priority of the timer service/daemon\r
- * task relative to other tasks in the system. The timer service/daemon task\r
- * priority is set by the configTIMER_TASK_PRIORITY configuration constant.\r
- *\r
- * Example usage:\r
- * @verbatim\r
- * // This scenario assumes xTimer has already been created and started. When\r
- * // an interrupt occurs, the period of xTimer should be changed to 500ms.\r
- *\r
- * // The interrupt service routine that changes the period of xTimer.\r
- * void vAnExampleInterruptServiceRoutine( void )\r
- * {\r
- * BaseType_t xHigherPriorityTaskWoken = pdFALSE;\r
- *\r
- * // The interrupt has occurred - change the period of xTimer to 500ms.\r
- * // xHigherPriorityTaskWoken was set to pdFALSE where it was defined\r
- * // (within this function). As this is an interrupt service routine, only\r
- * // FreeRTOS API functions that end in "FromISR" can be used.\r
- * if( xTimerChangePeriodFromISR( xTimer, &xHigherPriorityTaskWoken ) != pdPASS )\r
- * {\r
- * // The command to change the timers period was not executed\r
- * // successfully. Take appropriate action here.\r
- * }\r
- *\r
- * // If xHigherPriorityTaskWoken equals pdTRUE, then a context switch\r
- * // should be performed. The syntax required to perform a context switch\r
- * // from inside an ISR varies from port to port, and from compiler to\r
- * // compiler. Inspect the demos for the port you are using to find the\r
- * // actual syntax required.\r
- * if( xHigherPriorityTaskWoken != pdFALSE )\r
- * {\r
- * // Call the interrupt safe yield function here (actual function\r
- * // depends on the FreeRTOS port being used).\r
- * }\r
- * }\r
- * @endverbatim\r
- */\r
-#define xTimerChangePeriodFromISR( xTimer, xNewPeriod, pxHigherPriorityTaskWoken ) xTimerGenericCommand( ( xTimer ), tmrCOMMAND_CHANGE_PERIOD_FROM_ISR, ( xNewPeriod ), ( pxHigherPriorityTaskWoken ), 0U )\r
-\r
-/**\r
- * BaseType_t xTimerResetFromISR( TimerHandle_t xTimer,\r
- * BaseType_t *pxHigherPriorityTaskWoken );\r
- *\r
- * A version of xTimerReset() that can be called from an interrupt service\r
- * routine.\r
- *\r
- * @param xTimer The handle of the timer that is to be started, reset, or\r
- * restarted.\r
- *\r
- * @param pxHigherPriorityTaskWoken The timer service/daemon task spends most\r
- * of its time in the Blocked state, waiting for messages to arrive on the timer\r
- * command queue. Calling xTimerResetFromISR() writes a message to the timer\r
- * command queue, so has the potential to transition the timer service/daemon\r
- * task out of the Blocked state. If calling xTimerResetFromISR() causes the\r
- * timer service/daemon task to leave the Blocked state, and the timer service/\r
- * daemon task has a priority equal to or greater than the currently executing\r
- * task (the task that was interrupted), then *pxHigherPriorityTaskWoken will\r
- * get set to pdTRUE internally within the xTimerResetFromISR() function. If\r
- * xTimerResetFromISR() sets this value to pdTRUE then a context switch should\r
- * be performed before the interrupt exits.\r
- *\r
- * @return pdFAIL will be returned if the reset command could not be sent to\r
- * the timer command queue. pdPASS will be returned if the command was\r
- * successfully sent to the timer command queue. When the command is actually\r
- * processed will depend on the priority of the timer service/daemon task\r
- * relative to other tasks in the system, although the timers expiry time is\r
- * relative to when xTimerResetFromISR() is actually called. The timer service/daemon\r
- * task priority is set by the configTIMER_TASK_PRIORITY configuration constant.\r
- *\r
- * Example usage:\r
- * @verbatim\r
- * // This scenario assumes xBacklightTimer has already been created. When a\r
- * // key is pressed, an LCD back-light is switched on. If 5 seconds pass\r
- * // without a key being pressed, then the LCD back-light is switched off. In\r
- * // this case, the timer is a one-shot timer, and unlike the example given for\r
- * // the xTimerReset() function, the key press event handler is an interrupt\r
- * // service routine.\r
- *\r
- * // The callback function assigned to the one-shot timer. In this case the\r
- * // parameter is not used.\r
- * void vBacklightTimerCallback( TimerHandle_t pxTimer )\r
- * {\r
- * // The timer expired, therefore 5 seconds must have passed since a key\r
- * // was pressed. Switch off the LCD back-light.\r
- * vSetBacklightState( BACKLIGHT_OFF );\r
- * }\r
- *\r
- * // The key press interrupt service routine.\r
- * void vKeyPressEventInterruptHandler( void )\r
- * {\r
- * BaseType_t xHigherPriorityTaskWoken = pdFALSE;\r
- *\r
- * // Ensure the LCD back-light is on, then reset the timer that is\r
- * // responsible for turning the back-light off after 5 seconds of\r
- * // key inactivity. This is an interrupt service routine so can only\r
- * // call FreeRTOS API functions that end in "FromISR".\r
- * vSetBacklightState( BACKLIGHT_ON );\r
- *\r
- * // xTimerStartFromISR() or xTimerResetFromISR() could be called here\r
- * // as both cause the timer to re-calculate its expiry time.\r
- * // xHigherPriorityTaskWoken was initialised to pdFALSE when it was\r
- * // declared (in this function).\r
- * if( xTimerResetFromISR( xBacklightTimer, &xHigherPriorityTaskWoken ) != pdPASS )\r
- * {\r
- * // The reset command was not executed successfully. Take appropriate\r
- * // action here.\r
- * }\r
- *\r
- * // Perform the rest of the key processing here.\r
- *\r
- * // If xHigherPriorityTaskWoken equals pdTRUE, then a context switch\r
- * // should be performed. The syntax required to perform a context switch\r
- * // from inside an ISR varies from port to port, and from compiler to\r
- * // compiler. Inspect the demos for the port you are using to find the\r
- * // actual syntax required.\r
- * if( xHigherPriorityTaskWoken != pdFALSE )\r
- * {\r
- * // Call the interrupt safe yield function here (actual function\r
- * // depends on the FreeRTOS port being used).\r
- * }\r
- * }\r
- * @endverbatim\r
- */\r
-#define xTimerResetFromISR( xTimer, pxHigherPriorityTaskWoken ) xTimerGenericCommand( ( xTimer ), tmrCOMMAND_RESET_FROM_ISR, ( xTaskGetTickCountFromISR() ), ( pxHigherPriorityTaskWoken ), 0U )\r
-\r
-\r
-/**\r
- * BaseType_t xTimerPendFunctionCallFromISR( PendedFunction_t xFunctionToPend,\r
- * void *pvParameter1,\r
- * uint32_t ulParameter2,\r
- * BaseType_t *pxHigherPriorityTaskWoken );\r
- *\r
- *\r
- * Used from application interrupt service routines to defer the execution of a\r
- * function to the RTOS daemon task (the timer service task, hence this function\r
- * is implemented in timers.c and is prefixed with 'Timer').\r
- *\r
- * Ideally an interrupt service routine (ISR) is kept as short as possible, but\r
- * sometimes an ISR either has a lot of processing to do, or needs to perform\r
- * processing that is not deterministic. In these cases\r
- * xTimerPendFunctionCallFromISR() can be used to defer processing of a function\r
- * to the RTOS daemon task.\r
- *\r
- * A mechanism is provided that allows the interrupt to return directly to the\r
- * task that will subsequently execute the pended callback function. This\r
- * allows the callback function to execute contiguously in time with the\r
- * interrupt - just as if the callback had executed in the interrupt itself.\r
- *\r
- * @param xFunctionToPend The function to execute from the timer service/\r
- * daemon task. The function must conform to the PendedFunction_t\r
- * prototype.\r
- *\r
- * @param pvParameter1 The value of the callback function's first parameter.\r
- * The parameter has a void * type to allow it to be used to pass any type.\r
- * For example, unsigned longs can be cast to a void *, or the void * can be\r
- * used to point to a structure.\r
- *\r
- * @param ulParameter2 The value of the callback function's second parameter.\r
- *\r
- * @param pxHigherPriorityTaskWoken As mentioned above, calling this function\r
- * will result in a message being sent to the timer daemon task. If the\r
- * priority of the timer daemon task (which is set using\r
- * configTIMER_TASK_PRIORITY in FreeRTOSConfig.h) is higher than the priority of\r
- * the currently running task (the task the interrupt interrupted) then\r
- * *pxHigherPriorityTaskWoken will be set to pdTRUE within\r
- * xTimerPendFunctionCallFromISR(), indicating that a context switch should be\r
- * requested before the interrupt exits. For that reason\r
- * *pxHigherPriorityTaskWoken must be initialised to pdFALSE. See the\r
- * example code below.\r
- *\r
- * @return pdPASS is returned if the message was successfully sent to the\r
- * timer daemon task, otherwise pdFALSE is returned.\r
- *\r
- * Example usage:\r
- * @verbatim\r
- *\r
- * // The callback function that will execute in the context of the daemon task.\r
- * // Note callback functions must all use this same prototype.\r
- * void vProcessInterface( void *pvParameter1, uint32_t ulParameter2 )\r
- * {\r
- * BaseType_t xInterfaceToService;\r
- *\r
- * // The interface that requires servicing is passed in the second\r
- * // parameter. The first parameter is not used in this case.\r
- * xInterfaceToService = ( BaseType_t ) ulParameter2;\r
- *\r
- * // ...Perform the processing here...\r
- * }\r
- *\r
- * // An ISR that receives data packets from multiple interfaces\r
- * void vAnISR( void )\r
- * {\r
- * BaseType_t xInterfaceToService, xHigherPriorityTaskWoken;\r
- *\r
- * // Query the hardware to determine which interface needs processing.\r
- * xInterfaceToService = prvCheckInterfaces();\r
- *\r
- * // The actual processing is to be deferred to a task. Request the\r
- * // vProcessInterface() callback function is executed, passing in the\r
- * // number of the interface that needs processing. The interface to\r
- * // service is passed in the second parameter. The first parameter is\r
- * // not used in this case.\r
- * xHigherPriorityTaskWoken = pdFALSE;\r
- * xTimerPendFunctionCallFromISR( vProcessInterface, NULL, ( uint32_t ) xInterfaceToService, &xHigherPriorityTaskWoken );\r
- *\r
- * // If xHigherPriorityTaskWoken is now set to pdTRUE then a context\r
- * // switch should be requested. The macro used is port specific and will\r
- * // be either portYIELD_FROM_ISR() or portEND_SWITCHING_ISR() - refer to\r
- * // the documentation page for the port being used.\r
- * portYIELD_FROM_ISR( xHigherPriorityTaskWoken );\r
- *\r
- * }\r
- * @endverbatim\r
- */\r
-BaseType_t xTimerPendFunctionCallFromISR( PendedFunction_t xFunctionToPend, void *pvParameter1, uint32_t ulParameter2, BaseType_t *pxHigherPriorityTaskWoken ) PRIVILEGED_FUNCTION;\r
-\r
- /**\r
- * BaseType_t xTimerPendFunctionCall( PendedFunction_t xFunctionToPend,\r
- * void *pvParameter1,\r
- * uint32_t ulParameter2,\r
- * TickType_t xTicksToWait );\r
- *\r
- *\r
- * Used to defer the execution of a function to the RTOS daemon task (the timer\r
- * service task, hence this function is implemented in timers.c and is prefixed\r
- * with 'Timer').\r
- *\r
- * @param xFunctionToPend The function to execute from the timer service/\r
- * daemon task. The function must conform to the PendedFunction_t\r
- * prototype.\r
- *\r
- * @param pvParameter1 The value of the callback function's first parameter.\r
- * The parameter has a void * type to allow it to be used to pass any type.\r
- * For example, unsigned longs can be cast to a void *, or the void * can be\r
- * used to point to a structure.\r
- *\r
- * @param ulParameter2 The value of the callback function's second parameter.\r
- *\r
- * @param xTicksToWait Calling this function will result in a message being\r
- * sent to the timer daemon task on a queue. xTicksToWait is the amount of\r
- * time the calling task should remain in the Blocked state (so not using any\r
- * processing time) for space to become available on the timer queue if the\r
- * queue is found to be full.\r
- *\r
- * @return pdPASS is returned if the message was successfully sent to the\r
- * timer daemon task, otherwise pdFALSE is returned.\r
- *\r
- */\r
-BaseType_t xTimerPendFunctionCall( PendedFunction_t xFunctionToPend, void *pvParameter1, uint32_t ulParameter2, TickType_t xTicksToWait ) PRIVILEGED_FUNCTION;\r
-\r
-/**\r
- * const char * const pcTimerGetName( TimerHandle_t xTimer );\r
- *\r
- * Returns the name that was assigned to a timer when the timer was created.\r
- *\r
- * @param xTimer The handle of the timer being queried.\r
- *\r
- * @return The name assigned to the timer specified by the xTimer parameter.\r
- */\r
-const char * pcTimerGetName( TimerHandle_t xTimer ) PRIVILEGED_FUNCTION; /*lint !e971 Unqualified char types are allowed for strings and single characters only. */\r
-\r
-/**\r
- * TickType_t xTimerGetPeriod( TimerHandle_t xTimer );\r
- *\r
- * Returns the period of a timer.\r
- *\r
- * @param xTimer The handle of the timer being queried.\r
- *\r
- * @return The period of the timer in ticks.\r
- */\r
-TickType_t xTimerGetPeriod( TimerHandle_t xTimer ) PRIVILEGED_FUNCTION;\r
-\r
-/**\r
-* TickType_t xTimerGetExpiryTime( TimerHandle_t xTimer );\r
-*\r
-* Returns the time in ticks at which the timer will expire. If this is less\r
-* than the current tick count then the expiry time has overflowed from the\r
-* current time.\r
-*\r
-* @param xTimer The handle of the timer being queried.\r
-*\r
-* @return If the timer is running then the time in ticks at which the timer\r
-* will next expire is returned. If the timer is not running then the return\r
-* value is undefined.\r
-*/\r
-TickType_t xTimerGetExpiryTime( TimerHandle_t xTimer ) PRIVILEGED_FUNCTION;\r
-\r
-/*\r
- * Functions beyond this part are not part of the public API and are intended\r
- * for use by the kernel only.\r
- */\r
-BaseType_t xTimerCreateTimerTask( void ) PRIVILEGED_FUNCTION;\r
-BaseType_t xTimerGenericCommand( TimerHandle_t xTimer, const BaseType_t xCommandID, const TickType_t xOptionalValue, BaseType_t * const pxHigherPriorityTaskWoken, const TickType_t xTicksToWait ) PRIVILEGED_FUNCTION;\r
-\r
-#if( configUSE_TRACE_FACILITY == 1 )\r
- void vTimerSetTimerNumber( TimerHandle_t xTimer, UBaseType_t uxTimerNumber ) PRIVILEGED_FUNCTION;\r
- UBaseType_t uxTimerGetTimerNumber( TimerHandle_t xTimer ) PRIVILEGED_FUNCTION;\r
-#endif\r
-\r
-#ifdef __cplusplus\r
-}\r
-#endif\r
-#endif /* TIMERS_H */\r
-\r
-\r
-\r
+++ /dev/null
-/*\r
- * FreeRTOS Kernel V10.0.1\r
- * Copyright (C) 2017 Amazon.com, Inc. or its affiliates. All Rights Reserved.\r
- *\r
- * Permission is hereby granted, free of charge, to any person obtaining a copy of\r
- * this software and associated documentation files (the "Software"), to deal in\r
- * the Software without restriction, including without limitation the rights to\r
- * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of\r
- * the Software, and to permit persons to whom the Software is furnished to do so,\r
- * subject to the following conditions:\r
- *\r
- * The above copyright notice and this permission notice shall be included in all\r
- * copies or substantial portions of the Software.\r
- *\r
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\r
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS\r
- * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR\r
- * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER\r
- * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN\r
- * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\r
- *\r
- * http://www.FreeRTOS.org\r
- * http://aws.amazon.com/freertos\r
- *\r
- * 1 tab == 4 spaces!\r
- */\r
-\r
-\r
-#include <stdlib.h>\r
-#include "FreeRTOS.h"\r
-#include "list.h"\r
-\r
-/*-----------------------------------------------------------\r
- * PUBLIC LIST API documented in list.h\r
- *----------------------------------------------------------*/\r
-\r
-void vListInitialise( List_t * const pxList )\r
-{\r
- /* The list structure contains a list item which is used to mark the\r
- end of the list. To initialise the list the list end is inserted\r
- as the only list entry. */\r
- pxList->pxIndex = ( ListItem_t * ) &( pxList->xListEnd ); /*lint !e826 !e740 The mini list structure is used as the list end to save RAM. This is checked and valid. */\r
-\r
- /* The list end value is the highest possible value in the list to\r
- ensure it remains at the end of the list. */\r
- pxList->xListEnd.xItemValue = portMAX_DELAY;\r
-\r
- /* The list end next and previous pointers point to itself so we know\r
- when the list is empty. */\r
- pxList->xListEnd.pxNext = ( ListItem_t * ) &( pxList->xListEnd ); /*lint !e826 !e740 The mini list structure is used as the list end to save RAM. This is checked and valid. */\r
- pxList->xListEnd.pxPrevious = ( ListItem_t * ) &( pxList->xListEnd );/*lint !e826 !e740 The mini list structure is used as the list end to save RAM. This is checked and valid. */\r
-\r
- pxList->uxNumberOfItems = ( UBaseType_t ) 0U;\r
-\r
- /* Write known values into the list if\r
- configUSE_LIST_DATA_INTEGRITY_CHECK_BYTES is set to 1. */\r
- listSET_LIST_INTEGRITY_CHECK_1_VALUE( pxList );\r
- listSET_LIST_INTEGRITY_CHECK_2_VALUE( pxList );\r
-}\r
-/*-----------------------------------------------------------*/\r
-\r
-void vListInitialiseItem( ListItem_t * const pxItem )\r
-{\r
- /* Make sure the list item is not recorded as being on a list. */\r
- pxItem->pvContainer = NULL;\r
-\r
- /* Write known values into the list item if\r
- configUSE_LIST_DATA_INTEGRITY_CHECK_BYTES is set to 1. */\r
- listSET_FIRST_LIST_ITEM_INTEGRITY_CHECK_VALUE( pxItem );\r
- listSET_SECOND_LIST_ITEM_INTEGRITY_CHECK_VALUE( pxItem );\r
-}\r
-/*-----------------------------------------------------------*/\r
-\r
-void vListInsertEnd( List_t * const pxList, ListItem_t * const pxNewListItem )\r
-{\r
-ListItem_t * const pxIndex = pxList->pxIndex;\r
-\r
- /* Only effective when configASSERT() is also defined, these tests may catch\r
- the list data structures being overwritten in memory. They will not catch\r
- data errors caused by incorrect configuration or use of FreeRTOS. */\r
- listTEST_LIST_INTEGRITY( pxList );\r
- listTEST_LIST_ITEM_INTEGRITY( pxNewListItem );\r
-\r
- /* Insert a new list item into pxList, but rather than sort the list,\r
- makes the new list item the last item to be removed by a call to\r
- listGET_OWNER_OF_NEXT_ENTRY(). */\r
- pxNewListItem->pxNext = pxIndex;\r
- pxNewListItem->pxPrevious = pxIndex->pxPrevious;\r
-\r
- /* Only used during decision coverage testing. */\r
- mtCOVERAGE_TEST_DELAY();\r
-\r
- pxIndex->pxPrevious->pxNext = pxNewListItem;\r
- pxIndex->pxPrevious = pxNewListItem;\r
-\r
- /* Remember which list the item is in. */\r
- pxNewListItem->pvContainer = ( void * ) pxList;\r
-\r
- ( pxList->uxNumberOfItems )++;\r
-}\r
-/*-----------------------------------------------------------*/\r
-\r
-void vListInsert( List_t * const pxList, ListItem_t * const pxNewListItem )\r
-{\r
-ListItem_t *pxIterator;\r
-const TickType_t xValueOfInsertion = pxNewListItem->xItemValue;\r
-\r
- /* Only effective when configASSERT() is also defined, these tests may catch\r
- the list data structures being overwritten in memory. They will not catch\r
- data errors caused by incorrect configuration or use of FreeRTOS. */\r
- listTEST_LIST_INTEGRITY( pxList );\r
- listTEST_LIST_ITEM_INTEGRITY( pxNewListItem );\r
-\r
- /* Insert the new list item into the list, sorted in xItemValue order.\r
-\r
- If the list already contains a list item with the same item value then the\r
- new list item should be placed after it. This ensures that TCB's which are\r
- stored in ready lists (all of which have the same xItemValue value) get a\r
- share of the CPU. However, if the xItemValue is the same as the back marker\r
- the iteration loop below will not end. Therefore the value is checked\r
- first, and the algorithm slightly modified if necessary. */\r
- if( xValueOfInsertion == portMAX_DELAY )\r
- {\r
- pxIterator = pxList->xListEnd.pxPrevious;\r
- }\r
- else\r
- {\r
- /* *** NOTE ***********************************************************\r
- If you find your application is crashing here then likely causes are\r
- listed below. In addition see http://www.freertos.org/FAQHelp.html for\r
- more tips, and ensure configASSERT() is defined!\r
- http://www.freertos.org/a00110.html#configASSERT\r
-\r
- 1) Stack overflow -\r
- see http://www.freertos.org/Stacks-and-stack-overflow-checking.html\r
- 2) Incorrect interrupt priority assignment, especially on Cortex-M\r
- parts where numerically high priority values denote low actual\r
- interrupt priorities, which can seem counter intuitive. See\r
- http://www.freertos.org/RTOS-Cortex-M3-M4.html and the definition\r
- of configMAX_SYSCALL_INTERRUPT_PRIORITY on\r
- http://www.freertos.org/a00110.html\r
- 3) Calling an API function from within a critical section or when\r
- the scheduler is suspended, or calling an API function that does\r
- not end in "FromISR" from an interrupt.\r
- 4) Using a queue or semaphore before it has been initialised or\r
- before the scheduler has been started (are interrupts firing\r
- before vTaskStartScheduler() has been called?).\r
- **********************************************************************/\r
-\r
- for( pxIterator = ( ListItem_t * ) &( pxList->xListEnd ); pxIterator->pxNext->xItemValue <= xValueOfInsertion; pxIterator = pxIterator->pxNext ) /*lint !e826 !e740 The mini list structure is used as the list end to save RAM. This is checked and valid. */\r
- {\r
- /* There is nothing to do here, just iterating to the wanted\r
- insertion position. */\r
- }\r
- }\r
-\r
- pxNewListItem->pxNext = pxIterator->pxNext;\r
- pxNewListItem->pxNext->pxPrevious = pxNewListItem;\r
- pxNewListItem->pxPrevious = pxIterator;\r
- pxIterator->pxNext = pxNewListItem;\r
-\r
- /* Remember which list the item is in. This allows fast removal of the\r
- item later. */\r
- pxNewListItem->pvContainer = ( void * ) pxList;\r
-\r
- ( pxList->uxNumberOfItems )++;\r
-}\r
-/*-----------------------------------------------------------*/\r
-\r
-UBaseType_t uxListRemove( ListItem_t * const pxItemToRemove )\r
-{\r
-/* The list item knows which list it is in. Obtain the list from the list\r
-item. */\r
-List_t * const pxList = ( List_t * ) pxItemToRemove->pvContainer;\r
-\r
- pxItemToRemove->pxNext->pxPrevious = pxItemToRemove->pxPrevious;\r
- pxItemToRemove->pxPrevious->pxNext = pxItemToRemove->pxNext;\r
-\r
- /* Only used during decision coverage testing. */\r
- mtCOVERAGE_TEST_DELAY();\r
-\r
- /* Make sure the index is left pointing to a valid item. */\r
- if( pxList->pxIndex == pxItemToRemove )\r
- {\r
- pxList->pxIndex = pxItemToRemove->pxPrevious;\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
-\r
- pxItemToRemove->pvContainer = NULL;\r
- ( pxList->uxNumberOfItems )--;\r
-\r
- return pxList->uxNumberOfItems;\r
-}\r
-/*-----------------------------------------------------------*/\r
-\r
+++ /dev/null
-/*\r
- * FreeRTOS Kernel V10.0.1\r
- * Copyright (C) 2017 Amazon.com, Inc. or its affiliates. All Rights Reserved.\r
- *\r
- * Permission is hereby granted, free of charge, to any person obtaining a copy of\r
- * this software and associated documentation files (the "Software"), to deal in\r
- * the Software without restriction, including without limitation the rights to\r
- * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of\r
- * the Software, and to permit persons to whom the Software is furnished to do so,\r
- * subject to the following conditions:\r
- *\r
- * The above copyright notice and this permission notice shall be included in all\r
- * copies or substantial portions of the Software.\r
- *\r
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\r
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS\r
- * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR\r
- * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER\r
- * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN\r
- * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\r
- *\r
- * http://www.FreeRTOS.org\r
- * http://aws.amazon.com/freertos\r
- *\r
- * 1 tab == 4 spaces!\r
- */\r
-\r
-#include <stdlib.h>\r
-#include <string.h>\r
-\r
-/* Defining MPU_WRAPPERS_INCLUDED_FROM_API_FILE prevents task.h from redefining\r
-all the API functions to use the MPU wrappers. That should only be done when\r
-task.h is included from an application file. */\r
-#define MPU_WRAPPERS_INCLUDED_FROM_API_FILE\r
-\r
-#include "FreeRTOS.h"\r
-#include "task.h"\r
-#include "queue.h"\r
-\r
-#if ( configUSE_CO_ROUTINES == 1 )\r
- #include "croutine.h"\r
-#endif\r
-\r
-/* Lint e961 and e750 are suppressed as a MISRA exception justified because the\r
-MPU ports require MPU_WRAPPERS_INCLUDED_FROM_API_FILE to be defined for the\r
-header files above, but not in this file, in order to generate the correct\r
-privileged Vs unprivileged linkage and placement. */\r
-#undef MPU_WRAPPERS_INCLUDED_FROM_API_FILE /*lint !e961 !e750. */\r
-\r
-\r
-/* Constants used with the cRxLock and cTxLock structure members. */\r
-#define queueUNLOCKED ( ( int8_t ) -1 )\r
-#define queueLOCKED_UNMODIFIED ( ( int8_t ) 0 )\r
-\r
-/* When the Queue_t structure is used to represent a base queue its pcHead and\r
-pcTail members are used as pointers into the queue storage area. When the\r
-Queue_t structure is used to represent a mutex pcHead and pcTail pointers are\r
-not necessary, and the pcHead pointer is set to NULL to indicate that the\r
-pcTail pointer actually points to the mutex holder (if any). Map alternative\r
-names to the pcHead and pcTail structure members to ensure the readability of\r
-the code is maintained despite this dual use of two structure members. An\r
-alternative implementation would be to use a union, but use of a union is\r
-against the coding standard (although an exception to the standard has been\r
-permitted where the dual use also significantly changes the type of the\r
-structure member). */\r
-#define pxMutexHolder pcTail\r
-#define uxQueueType pcHead\r
-#define queueQUEUE_IS_MUTEX NULL\r
-\r
-/* Semaphores do not actually store or copy data, so have an item size of\r
-zero. */\r
-#define queueSEMAPHORE_QUEUE_ITEM_LENGTH ( ( UBaseType_t ) 0 )\r
-#define queueMUTEX_GIVE_BLOCK_TIME ( ( TickType_t ) 0U )\r
-\r
-#if( configUSE_PREEMPTION == 0 )\r
- /* If the cooperative scheduler is being used then a yield should not be\r
- performed just because a higher priority task has been woken. */\r
- #define queueYIELD_IF_USING_PREEMPTION()\r
-#else\r
- #define queueYIELD_IF_USING_PREEMPTION() portYIELD_WITHIN_API()\r
-#endif\r
-\r
-/*\r
- * Definition of the queue used by the scheduler.\r
- * Items are queued by copy, not reference. See the following link for the\r
- * rationale: http://www.freertos.org/Embedded-RTOS-Queues.html\r
- */\r
-typedef struct QueueDefinition\r
-{\r
- int8_t *pcHead; /*< Points to the beginning of the queue storage area. */\r
- int8_t *pcTail; /*< Points to the byte at the end of the queue storage area. Once more byte is allocated than necessary to store the queue items, this is used as a marker. */\r
- int8_t *pcWriteTo; /*< Points to the free next place in the storage area. */\r
-\r
- union /* Use of a union is an exception to the coding standard to ensure two mutually exclusive structure members don't appear simultaneously (wasting RAM). */\r
- {\r
- int8_t *pcReadFrom; /*< Points to the last place that a queued item was read from when the structure is used as a queue. */\r
- UBaseType_t uxRecursiveCallCount;/*< Maintains a count of the number of times a recursive mutex has been recursively 'taken' when the structure is used as a mutex. */\r
- } u;\r
-\r
- List_t xTasksWaitingToSend; /*< List of tasks that are blocked waiting to post onto this queue. Stored in priority order. */\r
- List_t xTasksWaitingToReceive; /*< List of tasks that are blocked waiting to read from this queue. Stored in priority order. */\r
-\r
- volatile UBaseType_t uxMessagesWaiting;/*< The number of items currently in the queue. */\r
- UBaseType_t uxLength; /*< The length of the queue defined as the number of items it will hold, not the number of bytes. */\r
- UBaseType_t uxItemSize; /*< The size of each items that the queue will hold. */\r
-\r
- volatile int8_t cRxLock; /*< Stores the number of items received from the queue (removed from the queue) while the queue was locked. Set to queueUNLOCKED when the queue is not locked. */\r
- volatile int8_t cTxLock; /*< Stores the number of items transmitted to the queue (added to the queue) while the queue was locked. Set to queueUNLOCKED when the queue is not locked. */\r
-\r
- #if( ( configSUPPORT_STATIC_ALLOCATION == 1 ) && ( configSUPPORT_DYNAMIC_ALLOCATION == 1 ) )\r
- uint8_t ucStaticallyAllocated; /*< Set to pdTRUE if the memory used by the queue was statically allocated to ensure no attempt is made to free the memory. */\r
- #endif\r
-\r
- #if ( configUSE_QUEUE_SETS == 1 )\r
- struct QueueDefinition *pxQueueSetContainer;\r
- #endif\r
-\r
- #if ( configUSE_TRACE_FACILITY == 1 )\r
- UBaseType_t uxQueueNumber;\r
- uint8_t ucQueueType;\r
- #endif\r
-\r
-} xQUEUE;\r
-\r
-/* The old xQUEUE name is maintained above then typedefed to the new Queue_t\r
-name below to enable the use of older kernel aware debuggers. */\r
-typedef xQUEUE Queue_t;\r
-\r
-/*-----------------------------------------------------------*/\r
-\r
-/*\r
- * The queue registry is just a means for kernel aware debuggers to locate\r
- * queue structures. It has no other purpose so is an optional component.\r
- */\r
-#if ( configQUEUE_REGISTRY_SIZE > 0 )\r
-\r
- /* The type stored within the queue registry array. This allows a name\r
- to be assigned to each queue making kernel aware debugging a little\r
- more user friendly. */\r
- typedef struct QUEUE_REGISTRY_ITEM\r
- {\r
- const char *pcQueueName; /*lint !e971 Unqualified char types are allowed for strings and single characters only. */\r
- QueueHandle_t xHandle;\r
- } xQueueRegistryItem;\r
-\r
- /* The old xQueueRegistryItem name is maintained above then typedefed to the\r
- new xQueueRegistryItem name below to enable the use of older kernel aware\r
- debuggers. */\r
- typedef xQueueRegistryItem QueueRegistryItem_t;\r
-\r
- /* The queue registry is simply an array of QueueRegistryItem_t structures.\r
- The pcQueueName member of a structure being NULL is indicative of the\r
- array position being vacant. */\r
- PRIVILEGED_DATA QueueRegistryItem_t xQueueRegistry[ configQUEUE_REGISTRY_SIZE ];\r
-\r
-#endif /* configQUEUE_REGISTRY_SIZE */\r
-\r
-/*\r
- * Unlocks a queue locked by a call to prvLockQueue. Locking a queue does not\r
- * prevent an ISR from adding or removing items to the queue, but does prevent\r
- * an ISR from removing tasks from the queue event lists. If an ISR finds a\r
- * queue is locked it will instead increment the appropriate queue lock count\r
- * to indicate that a task may require unblocking. When the queue in unlocked\r
- * these lock counts are inspected, and the appropriate action taken.\r
- */\r
-static void prvUnlockQueue( Queue_t * const pxQueue ) PRIVILEGED_FUNCTION;\r
-\r
-/*\r
- * Uses a critical section to determine if there is any data in a queue.\r
- *\r
- * @return pdTRUE if the queue contains no items, otherwise pdFALSE.\r
- */\r
-static BaseType_t prvIsQueueEmpty( const Queue_t *pxQueue ) PRIVILEGED_FUNCTION;\r
-\r
-/*\r
- * Uses a critical section to determine if there is any space in a queue.\r
- *\r
- * @return pdTRUE if there is no space, otherwise pdFALSE;\r
- */\r
-static BaseType_t prvIsQueueFull( const Queue_t *pxQueue ) PRIVILEGED_FUNCTION;\r
-\r
-/*\r
- * Copies an item into the queue, either at the front of the queue or the\r
- * back of the queue.\r
- */\r
-static BaseType_t prvCopyDataToQueue( Queue_t * const pxQueue, const void *pvItemToQueue, const BaseType_t xPosition ) PRIVILEGED_FUNCTION;\r
-\r
-/*\r
- * Copies an item out of a queue.\r
- */\r
-static void prvCopyDataFromQueue( Queue_t * const pxQueue, void * const pvBuffer ) PRIVILEGED_FUNCTION;\r
-\r
-#if ( configUSE_QUEUE_SETS == 1 )\r
- /*\r
- * Checks to see if a queue is a member of a queue set, and if so, notifies\r
- * the queue set that the queue contains data.\r
- */\r
- static BaseType_t prvNotifyQueueSetContainer( const Queue_t * const pxQueue, const BaseType_t xCopyPosition ) PRIVILEGED_FUNCTION;\r
-#endif\r
-\r
-/*\r
- * Called after a Queue_t structure has been allocated either statically or\r
- * dynamically to fill in the structure's members.\r
- */\r
-static void prvInitialiseNewQueue( const UBaseType_t uxQueueLength, const UBaseType_t uxItemSize, uint8_t *pucQueueStorage, const uint8_t ucQueueType, Queue_t *pxNewQueue ) PRIVILEGED_FUNCTION;\r
-\r
-/*\r
- * Mutexes are a special type of queue. When a mutex is created, first the\r
- * queue is created, then prvInitialiseMutex() is called to configure the queue\r
- * as a mutex.\r
- */\r
-#if( configUSE_MUTEXES == 1 )\r
- static void prvInitialiseMutex( Queue_t *pxNewQueue ) PRIVILEGED_FUNCTION;\r
-#endif\r
-\r
-#if( configUSE_MUTEXES == 1 )\r
- /*\r
- * If a task waiting for a mutex causes the mutex holder to inherit a\r
- * priority, but the waiting task times out, then the holder should\r
- * disinherit the priority - but only down to the highest priority of any\r
- * other tasks that are waiting for the same mutex. This function returns\r
- * that priority.\r
- */\r
- static UBaseType_t prvGetDisinheritPriorityAfterTimeout( const Queue_t * const pxQueue ) PRIVILEGED_FUNCTION;\r
-#endif\r
-/*-----------------------------------------------------------*/\r
-\r
-/*\r
- * Macro to mark a queue as locked. Locking a queue prevents an ISR from\r
- * accessing the queue event lists.\r
- */\r
-#define prvLockQueue( pxQueue ) \\r
- taskENTER_CRITICAL(); \\r
- { \\r
- if( ( pxQueue )->cRxLock == queueUNLOCKED ) \\r
- { \\r
- ( pxQueue )->cRxLock = queueLOCKED_UNMODIFIED; \\r
- } \\r
- if( ( pxQueue )->cTxLock == queueUNLOCKED ) \\r
- { \\r
- ( pxQueue )->cTxLock = queueLOCKED_UNMODIFIED; \\r
- } \\r
- } \\r
- taskEXIT_CRITICAL()\r
-/*-----------------------------------------------------------*/\r
-\r
-BaseType_t xQueueGenericReset( QueueHandle_t xQueue, BaseType_t xNewQueue )\r
-{\r
-Queue_t * const pxQueue = ( Queue_t * ) xQueue;\r
-\r
- configASSERT( pxQueue );\r
-\r
- taskENTER_CRITICAL();\r
- {\r
- pxQueue->pcTail = pxQueue->pcHead + ( pxQueue->uxLength * pxQueue->uxItemSize );\r
- pxQueue->uxMessagesWaiting = ( UBaseType_t ) 0U;\r
- pxQueue->pcWriteTo = pxQueue->pcHead;\r
- pxQueue->u.pcReadFrom = pxQueue->pcHead + ( ( pxQueue->uxLength - ( UBaseType_t ) 1U ) * pxQueue->uxItemSize );\r
- pxQueue->cRxLock = queueUNLOCKED;\r
- pxQueue->cTxLock = queueUNLOCKED;\r
-\r
- if( xNewQueue == pdFALSE )\r
- {\r
- /* If there are tasks blocked waiting to read from the queue, then\r
- the tasks will remain blocked as after this function exits the queue\r
- will still be empty. If there are tasks blocked waiting to write to\r
- the queue, then one should be unblocked as after this function exits\r
- it will be possible to write to it. */\r
- if( listLIST_IS_EMPTY( &( pxQueue->xTasksWaitingToSend ) ) == pdFALSE )\r
- {\r
- if( xTaskRemoveFromEventList( &( pxQueue->xTasksWaitingToSend ) ) != pdFALSE )\r
- {\r
- queueYIELD_IF_USING_PREEMPTION();\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- else\r
- {\r
- /* Ensure the event queues start in the correct state. */\r
- vListInitialise( &( pxQueue->xTasksWaitingToSend ) );\r
- vListInitialise( &( pxQueue->xTasksWaitingToReceive ) );\r
- }\r
- }\r
- taskEXIT_CRITICAL();\r
-\r
- /* A value is returned for calling semantic consistency with previous\r
- versions. */\r
- return pdPASS;\r
-}\r
-/*-----------------------------------------------------------*/\r
-\r
-#if( configSUPPORT_STATIC_ALLOCATION == 1 )\r
-\r
- QueueHandle_t xQueueGenericCreateStatic( const UBaseType_t uxQueueLength, const UBaseType_t uxItemSize, uint8_t *pucQueueStorage, StaticQueue_t *pxStaticQueue, const uint8_t ucQueueType )\r
- {\r
- Queue_t *pxNewQueue;\r
-\r
- configASSERT( uxQueueLength > ( UBaseType_t ) 0 );\r
-\r
- /* The StaticQueue_t structure and the queue storage area must be\r
- supplied. */\r
- configASSERT( pxStaticQueue != NULL );\r
-\r
- /* A queue storage area should be provided if the item size is not 0, and\r
- should not be provided if the item size is 0. */\r
- configASSERT( !( ( pucQueueStorage != NULL ) && ( uxItemSize == 0 ) ) );\r
- configASSERT( !( ( pucQueueStorage == NULL ) && ( uxItemSize != 0 ) ) );\r
-\r
- #if( configASSERT_DEFINED == 1 )\r
- {\r
- /* Sanity check that the size of the structure used to declare a\r
- variable of type StaticQueue_t or StaticSemaphore_t equals the size of\r
- the real queue and semaphore structures. */\r
- volatile size_t xSize = sizeof( StaticQueue_t );\r
- configASSERT( xSize == sizeof( Queue_t ) );\r
- }\r
- #endif /* configASSERT_DEFINED */\r
-\r
- /* The address of a statically allocated queue was passed in, use it.\r
- The address of a statically allocated storage area was also passed in\r
- but is already set. */\r
- pxNewQueue = ( Queue_t * ) pxStaticQueue; /*lint !e740 Unusual cast is ok as the structures are designed to have the same alignment, and the size is checked by an assert. */\r
-\r
- if( pxNewQueue != NULL )\r
- {\r
- #if( configSUPPORT_DYNAMIC_ALLOCATION == 1 )\r
- {\r
- /* Queues can be allocated wither statically or dynamically, so\r
- note this queue was allocated statically in case the queue is\r
- later deleted. */\r
- pxNewQueue->ucStaticallyAllocated = pdTRUE;\r
- }\r
- #endif /* configSUPPORT_DYNAMIC_ALLOCATION */\r
-\r
- prvInitialiseNewQueue( uxQueueLength, uxItemSize, pucQueueStorage, ucQueueType, pxNewQueue );\r
- }\r
- else\r
- {\r
- traceQUEUE_CREATE_FAILED( ucQueueType );\r
- }\r
-\r
- return pxNewQueue;\r
- }\r
-\r
-#endif /* configSUPPORT_STATIC_ALLOCATION */\r
-/*-----------------------------------------------------------*/\r
-\r
-#if( configSUPPORT_DYNAMIC_ALLOCATION == 1 )\r
-\r
- QueueHandle_t xQueueGenericCreate( const UBaseType_t uxQueueLength, const UBaseType_t uxItemSize, const uint8_t ucQueueType )\r
- {\r
- Queue_t *pxNewQueue;\r
- size_t xQueueSizeInBytes;\r
- uint8_t *pucQueueStorage;\r
-\r
- configASSERT( uxQueueLength > ( UBaseType_t ) 0 );\r
-\r
- if( uxItemSize == ( UBaseType_t ) 0 )\r
- {\r
- /* There is not going to be a queue storage area. */\r
- xQueueSizeInBytes = ( size_t ) 0;\r
- }\r
- else\r
- {\r
- /* Allocate enough space to hold the maximum number of items that\r
- can be in the queue at any time. */\r
- xQueueSizeInBytes = ( size_t ) ( uxQueueLength * uxItemSize ); /*lint !e961 MISRA exception as the casts are only redundant for some ports. */\r
- }\r
-\r
- pxNewQueue = ( Queue_t * ) pvPortMalloc( sizeof( Queue_t ) + xQueueSizeInBytes );\r
-\r
- if( pxNewQueue != NULL )\r
- {\r
- /* Jump past the queue structure to find the location of the queue\r
- storage area. */\r
- pucQueueStorage = ( ( uint8_t * ) pxNewQueue ) + sizeof( Queue_t );\r
-\r
- #if( configSUPPORT_STATIC_ALLOCATION == 1 )\r
- {\r
- /* Queues can be created either statically or dynamically, so\r
- note this task was created dynamically in case it is later\r
- deleted. */\r
- pxNewQueue->ucStaticallyAllocated = pdFALSE;\r
- }\r
- #endif /* configSUPPORT_STATIC_ALLOCATION */\r
-\r
- prvInitialiseNewQueue( uxQueueLength, uxItemSize, pucQueueStorage, ucQueueType, pxNewQueue );\r
- }\r
- else\r
- {\r
- traceQUEUE_CREATE_FAILED( ucQueueType );\r
- }\r
-\r
- return pxNewQueue;\r
- }\r
-\r
-#endif /* configSUPPORT_STATIC_ALLOCATION */\r
-/*-----------------------------------------------------------*/\r
-\r
-static void prvInitialiseNewQueue( const UBaseType_t uxQueueLength, const UBaseType_t uxItemSize, uint8_t *pucQueueStorage, const uint8_t ucQueueType, Queue_t *pxNewQueue )\r
-{\r
- /* Remove compiler warnings about unused parameters should\r
- configUSE_TRACE_FACILITY not be set to 1. */\r
- ( void ) ucQueueType;\r
-\r
- if( uxItemSize == ( UBaseType_t ) 0 )\r
- {\r
- /* No RAM was allocated for the queue storage area, but PC head cannot\r
- be set to NULL because NULL is used as a key to say the queue is used as\r
- a mutex. Therefore just set pcHead to point to the queue as a benign\r
- value that is known to be within the memory map. */\r
- pxNewQueue->pcHead = ( int8_t * ) pxNewQueue;\r
- }\r
- else\r
- {\r
- /* Set the head to the start of the queue storage area. */\r
- pxNewQueue->pcHead = ( int8_t * ) pucQueueStorage;\r
- }\r
-\r
- /* Initialise the queue members as described where the queue type is\r
- defined. */\r
- pxNewQueue->uxLength = uxQueueLength;\r
- pxNewQueue->uxItemSize = uxItemSize;\r
- ( void ) xQueueGenericReset( pxNewQueue, pdTRUE );\r
-\r
- #if ( configUSE_TRACE_FACILITY == 1 )\r
- {\r
- pxNewQueue->ucQueueType = ucQueueType;\r
- }\r
- #endif /* configUSE_TRACE_FACILITY */\r
-\r
- #if( configUSE_QUEUE_SETS == 1 )\r
- {\r
- pxNewQueue->pxQueueSetContainer = NULL;\r
- }\r
- #endif /* configUSE_QUEUE_SETS */\r
-\r
- traceQUEUE_CREATE( pxNewQueue );\r
-}\r
-/*-----------------------------------------------------------*/\r
-\r
-#if( configUSE_MUTEXES == 1 )\r
-\r
- static void prvInitialiseMutex( Queue_t *pxNewQueue )\r
- {\r
- if( pxNewQueue != NULL )\r
- {\r
- /* The queue create function will set all the queue structure members\r
- correctly for a generic queue, but this function is creating a\r
- mutex. Overwrite those members that need to be set differently -\r
- in particular the information required for priority inheritance. */\r
- pxNewQueue->pxMutexHolder = NULL;\r
- pxNewQueue->uxQueueType = queueQUEUE_IS_MUTEX;\r
-\r
- /* In case this is a recursive mutex. */\r
- pxNewQueue->u.uxRecursiveCallCount = 0;\r
-\r
- traceCREATE_MUTEX( pxNewQueue );\r
-\r
- /* Start with the semaphore in the expected state. */\r
- ( void ) xQueueGenericSend( pxNewQueue, NULL, ( TickType_t ) 0U, queueSEND_TO_BACK );\r
- }\r
- else\r
- {\r
- traceCREATE_MUTEX_FAILED();\r
- }\r
- }\r
-\r
-#endif /* configUSE_MUTEXES */\r
-/*-----------------------------------------------------------*/\r
-\r
-#if( ( configUSE_MUTEXES == 1 ) && ( configSUPPORT_DYNAMIC_ALLOCATION == 1 ) )\r
-\r
- QueueHandle_t xQueueCreateMutex( const uint8_t ucQueueType )\r
- {\r
- Queue_t *pxNewQueue;\r
- const UBaseType_t uxMutexLength = ( UBaseType_t ) 1, uxMutexSize = ( UBaseType_t ) 0;\r
-\r
- pxNewQueue = ( Queue_t * ) xQueueGenericCreate( uxMutexLength, uxMutexSize, ucQueueType );\r
- prvInitialiseMutex( pxNewQueue );\r
-\r
- return pxNewQueue;\r
- }\r
-\r
-#endif /* configUSE_MUTEXES */\r
-/*-----------------------------------------------------------*/\r
-\r
-#if( ( configUSE_MUTEXES == 1 ) && ( configSUPPORT_STATIC_ALLOCATION == 1 ) )\r
-\r
- QueueHandle_t xQueueCreateMutexStatic( const uint8_t ucQueueType, StaticQueue_t *pxStaticQueue )\r
- {\r
- Queue_t *pxNewQueue;\r
- const UBaseType_t uxMutexLength = ( UBaseType_t ) 1, uxMutexSize = ( UBaseType_t ) 0;\r
-\r
- /* Prevent compiler warnings about unused parameters if\r
- configUSE_TRACE_FACILITY does not equal 1. */\r
- ( void ) ucQueueType;\r
-\r
- pxNewQueue = ( Queue_t * ) xQueueGenericCreateStatic( uxMutexLength, uxMutexSize, NULL, pxStaticQueue, ucQueueType );\r
- prvInitialiseMutex( pxNewQueue );\r
-\r
- return pxNewQueue;\r
- }\r
-\r
-#endif /* configUSE_MUTEXES */\r
-/*-----------------------------------------------------------*/\r
-\r
-#if ( ( configUSE_MUTEXES == 1 ) && ( INCLUDE_xSemaphoreGetMutexHolder == 1 ) )\r
-\r
- void* xQueueGetMutexHolder( QueueHandle_t xSemaphore )\r
- {\r
- void *pxReturn;\r
-\r
- /* This function is called by xSemaphoreGetMutexHolder(), and should not\r
- be called directly. Note: This is a good way of determining if the\r
- calling task is the mutex holder, but not a good way of determining the\r
- identity of the mutex holder, as the holder may change between the\r
- following critical section exiting and the function returning. */\r
- taskENTER_CRITICAL();\r
- {\r
- if( ( ( Queue_t * ) xSemaphore )->uxQueueType == queueQUEUE_IS_MUTEX )\r
- {\r
- pxReturn = ( void * ) ( ( Queue_t * ) xSemaphore )->pxMutexHolder;\r
- }\r
- else\r
- {\r
- pxReturn = NULL;\r
- }\r
- }\r
- taskEXIT_CRITICAL();\r
-\r
- return pxReturn;\r
- } /*lint !e818 xSemaphore cannot be a pointer to const because it is a typedef. */\r
-\r
-#endif\r
-/*-----------------------------------------------------------*/\r
-\r
-#if ( ( configUSE_MUTEXES == 1 ) && ( INCLUDE_xSemaphoreGetMutexHolder == 1 ) )\r
-\r
- void* xQueueGetMutexHolderFromISR( QueueHandle_t xSemaphore )\r
- {\r
- void *pxReturn;\r
-\r
- configASSERT( xSemaphore );\r
-\r
- /* Mutexes cannot be used in interrupt service routines, so the mutex\r
- holder should not change in an ISR, and therefore a critical section is\r
- not required here. */\r
- if( ( ( Queue_t * ) xSemaphore )->uxQueueType == queueQUEUE_IS_MUTEX )\r
- {\r
- pxReturn = ( void * ) ( ( Queue_t * ) xSemaphore )->pxMutexHolder;\r
- }\r
- else\r
- {\r
- pxReturn = NULL;\r
- }\r
-\r
- return pxReturn;\r
- } /*lint !e818 xSemaphore cannot be a pointer to const because it is a typedef. */\r
-\r
-#endif\r
-/*-----------------------------------------------------------*/\r
-\r
-#if ( configUSE_RECURSIVE_MUTEXES == 1 )\r
-\r
- BaseType_t xQueueGiveMutexRecursive( QueueHandle_t xMutex )\r
- {\r
- BaseType_t xReturn;\r
- Queue_t * const pxMutex = ( Queue_t * ) xMutex;\r
-\r
- configASSERT( pxMutex );\r
-\r
- /* If this is the task that holds the mutex then pxMutexHolder will not\r
- change outside of this task. If this task does not hold the mutex then\r
- pxMutexHolder can never coincidentally equal the tasks handle, and as\r
- this is the only condition we are interested in it does not matter if\r
- pxMutexHolder is accessed simultaneously by another task. Therefore no\r
- mutual exclusion is required to test the pxMutexHolder variable. */\r
- if( pxMutex->pxMutexHolder == ( void * ) xTaskGetCurrentTaskHandle() ) /*lint !e961 Not a redundant cast as TaskHandle_t is a typedef. */\r
- {\r
- traceGIVE_MUTEX_RECURSIVE( pxMutex );\r
-\r
- /* uxRecursiveCallCount cannot be zero if pxMutexHolder is equal to\r
- the task handle, therefore no underflow check is required. Also,\r
- uxRecursiveCallCount is only modified by the mutex holder, and as\r
- there can only be one, no mutual exclusion is required to modify the\r
- uxRecursiveCallCount member. */\r
- ( pxMutex->u.uxRecursiveCallCount )--;\r
-\r
- /* Has the recursive call count unwound to 0? */\r
- if( pxMutex->u.uxRecursiveCallCount == ( UBaseType_t ) 0 )\r
- {\r
- /* Return the mutex. This will automatically unblock any other\r
- task that might be waiting to access the mutex. */\r
- ( void ) xQueueGenericSend( pxMutex, NULL, queueMUTEX_GIVE_BLOCK_TIME, queueSEND_TO_BACK );\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
-\r
- xReturn = pdPASS;\r
- }\r
- else\r
- {\r
- /* The mutex cannot be given because the calling task is not the\r
- holder. */\r
- xReturn = pdFAIL;\r
-\r
- traceGIVE_MUTEX_RECURSIVE_FAILED( pxMutex );\r
- }\r
-\r
- return xReturn;\r
- }\r
-\r
-#endif /* configUSE_RECURSIVE_MUTEXES */\r
-/*-----------------------------------------------------------*/\r
-\r
-#if ( configUSE_RECURSIVE_MUTEXES == 1 )\r
-\r
- BaseType_t xQueueTakeMutexRecursive( QueueHandle_t xMutex, TickType_t xTicksToWait )\r
- {\r
- BaseType_t xReturn;\r
- Queue_t * const pxMutex = ( Queue_t * ) xMutex;\r
-\r
- configASSERT( pxMutex );\r
-\r
- /* Comments regarding mutual exclusion as per those within\r
- xQueueGiveMutexRecursive(). */\r
-\r
- traceTAKE_MUTEX_RECURSIVE( pxMutex );\r
-\r
- if( pxMutex->pxMutexHolder == ( void * ) xTaskGetCurrentTaskHandle() ) /*lint !e961 Cast is not redundant as TaskHandle_t is a typedef. */\r
- {\r
- ( pxMutex->u.uxRecursiveCallCount )++;\r
- xReturn = pdPASS;\r
- }\r
- else\r
- {\r
- xReturn = xQueueSemaphoreTake( pxMutex, xTicksToWait );\r
-\r
- /* pdPASS will only be returned if the mutex was successfully\r
- obtained. The calling task may have entered the Blocked state\r
- before reaching here. */\r
- if( xReturn != pdFAIL )\r
- {\r
- ( pxMutex->u.uxRecursiveCallCount )++;\r
- }\r
- else\r
- {\r
- traceTAKE_MUTEX_RECURSIVE_FAILED( pxMutex );\r
- }\r
- }\r
-\r
- return xReturn;\r
- }\r
-\r
-#endif /* configUSE_RECURSIVE_MUTEXES */\r
-/*-----------------------------------------------------------*/\r
-\r
-#if( ( configUSE_COUNTING_SEMAPHORES == 1 ) && ( configSUPPORT_STATIC_ALLOCATION == 1 ) )\r
-\r
- QueueHandle_t xQueueCreateCountingSemaphoreStatic( const UBaseType_t uxMaxCount, const UBaseType_t uxInitialCount, StaticQueue_t *pxStaticQueue )\r
- {\r
- QueueHandle_t xHandle;\r
-\r
- configASSERT( uxMaxCount != 0 );\r
- configASSERT( uxInitialCount <= uxMaxCount );\r
-\r
- xHandle = xQueueGenericCreateStatic( uxMaxCount, queueSEMAPHORE_QUEUE_ITEM_LENGTH, NULL, pxStaticQueue, queueQUEUE_TYPE_COUNTING_SEMAPHORE );\r
-\r
- if( xHandle != NULL )\r
- {\r
- ( ( Queue_t * ) xHandle )->uxMessagesWaiting = uxInitialCount;\r
-\r
- traceCREATE_COUNTING_SEMAPHORE();\r
- }\r
- else\r
- {\r
- traceCREATE_COUNTING_SEMAPHORE_FAILED();\r
- }\r
-\r
- return xHandle;\r
- }\r
-\r
-#endif /* ( ( configUSE_COUNTING_SEMAPHORES == 1 ) && ( configSUPPORT_DYNAMIC_ALLOCATION == 1 ) ) */\r
-/*-----------------------------------------------------------*/\r
-\r
-#if( ( configUSE_COUNTING_SEMAPHORES == 1 ) && ( configSUPPORT_DYNAMIC_ALLOCATION == 1 ) )\r
-\r
- QueueHandle_t xQueueCreateCountingSemaphore( const UBaseType_t uxMaxCount, const UBaseType_t uxInitialCount )\r
- {\r
- QueueHandle_t xHandle;\r
-\r
- configASSERT( uxMaxCount != 0 );\r
- configASSERT( uxInitialCount <= uxMaxCount );\r
-\r
- xHandle = xQueueGenericCreate( uxMaxCount, queueSEMAPHORE_QUEUE_ITEM_LENGTH, queueQUEUE_TYPE_COUNTING_SEMAPHORE );\r
-\r
- if( xHandle != NULL )\r
- {\r
- ( ( Queue_t * ) xHandle )->uxMessagesWaiting = uxInitialCount;\r
-\r
- traceCREATE_COUNTING_SEMAPHORE();\r
- }\r
- else\r
- {\r
- traceCREATE_COUNTING_SEMAPHORE_FAILED();\r
- }\r
-\r
- return xHandle;\r
- }\r
-\r
-#endif /* ( ( configUSE_COUNTING_SEMAPHORES == 1 ) && ( configSUPPORT_DYNAMIC_ALLOCATION == 1 ) ) */\r
-/*-----------------------------------------------------------*/\r
-\r
-BaseType_t xQueueGenericSend( QueueHandle_t xQueue, const void * const pvItemToQueue, TickType_t xTicksToWait, const BaseType_t xCopyPosition )\r
-{\r
-BaseType_t xEntryTimeSet = pdFALSE, xYieldRequired;\r
-TimeOut_t xTimeOut;\r
-Queue_t * const pxQueue = ( Queue_t * ) xQueue;\r
-\r
- configASSERT( pxQueue );\r
- configASSERT( !( ( pvItemToQueue == NULL ) && ( pxQueue->uxItemSize != ( UBaseType_t ) 0U ) ) );\r
- configASSERT( !( ( xCopyPosition == queueOVERWRITE ) && ( pxQueue->uxLength != 1 ) ) );\r
- #if ( ( INCLUDE_xTaskGetSchedulerState == 1 ) || ( configUSE_TIMERS == 1 ) )\r
- {\r
- configASSERT( !( ( xTaskGetSchedulerState() == taskSCHEDULER_SUSPENDED ) && ( xTicksToWait != 0 ) ) );\r
- }\r
- #endif\r
-\r
-\r
- /* This function relaxes the coding standard somewhat to allow return\r
- statements within the function itself. This is done in the interest\r
- of execution time efficiency. */\r
- for( ;; )\r
- {\r
- taskENTER_CRITICAL();\r
- {\r
- /* Is there room on the queue now? The running task must be the\r
- highest priority task wanting to access the queue. If the head item\r
- in the queue is to be overwritten then it does not matter if the\r
- queue is full. */\r
- if( ( pxQueue->uxMessagesWaiting < pxQueue->uxLength ) || ( xCopyPosition == queueOVERWRITE ) )\r
- {\r
- traceQUEUE_SEND( pxQueue );\r
- xYieldRequired = prvCopyDataToQueue( pxQueue, pvItemToQueue, xCopyPosition );\r
-\r
- #if ( configUSE_QUEUE_SETS == 1 )\r
- {\r
- if( pxQueue->pxQueueSetContainer != NULL )\r
- {\r
- if( prvNotifyQueueSetContainer( pxQueue, xCopyPosition ) != pdFALSE )\r
- {\r
- /* The queue is a member of a queue set, and posting\r
- to the queue set caused a higher priority task to\r
- unblock. A context switch is required. */\r
- queueYIELD_IF_USING_PREEMPTION();\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- else\r
- {\r
- /* If there was a task waiting for data to arrive on the\r
- queue then unblock it now. */\r
- if( listLIST_IS_EMPTY( &( pxQueue->xTasksWaitingToReceive ) ) == pdFALSE )\r
- {\r
- if( xTaskRemoveFromEventList( &( pxQueue->xTasksWaitingToReceive ) ) != pdFALSE )\r
- {\r
- /* The unblocked task has a priority higher than\r
- our own so yield immediately. Yes it is ok to\r
- do this from within the critical section - the\r
- kernel takes care of that. */\r
- queueYIELD_IF_USING_PREEMPTION();\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- else if( xYieldRequired != pdFALSE )\r
- {\r
- /* This path is a special case that will only get\r
- executed if the task was holding multiple mutexes\r
- and the mutexes were given back in an order that is\r
- different to that in which they were taken. */\r
- queueYIELD_IF_USING_PREEMPTION();\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- }\r
- #else /* configUSE_QUEUE_SETS */\r
- {\r
- /* If there was a task waiting for data to arrive on the\r
- queue then unblock it now. */\r
- if( listLIST_IS_EMPTY( &( pxQueue->xTasksWaitingToReceive ) ) == pdFALSE )\r
- {\r
- if( xTaskRemoveFromEventList( &( pxQueue->xTasksWaitingToReceive ) ) != pdFALSE )\r
- {\r
- /* The unblocked task has a priority higher than\r
- our own so yield immediately. Yes it is ok to do\r
- this from within the critical section - the kernel\r
- takes care of that. */\r
- queueYIELD_IF_USING_PREEMPTION();\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- else if( xYieldRequired != pdFALSE )\r
- {\r
- /* This path is a special case that will only get\r
- executed if the task was holding multiple mutexes and\r
- the mutexes were given back in an order that is\r
- different to that in which they were taken. */\r
- queueYIELD_IF_USING_PREEMPTION();\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- #endif /* configUSE_QUEUE_SETS */\r
-\r
- taskEXIT_CRITICAL();\r
- return pdPASS;\r
- }\r
- else\r
- {\r
- if( xTicksToWait == ( TickType_t ) 0 )\r
- {\r
- /* The queue was full and no block time is specified (or\r
- the block time has expired) so leave now. */\r
- taskEXIT_CRITICAL();\r
-\r
- /* Return to the original privilege level before exiting\r
- the function. */\r
- traceQUEUE_SEND_FAILED( pxQueue );\r
- return errQUEUE_FULL;\r
- }\r
- else if( xEntryTimeSet == pdFALSE )\r
- {\r
- /* The queue was full and a block time was specified so\r
- configure the timeout structure. */\r
- vTaskInternalSetTimeOutState( &xTimeOut );\r
- xEntryTimeSet = pdTRUE;\r
- }\r
- else\r
- {\r
- /* Entry time was already set. */\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- }\r
- taskEXIT_CRITICAL();\r
-\r
- /* Interrupts and other tasks can send to and receive from the queue\r
- now the critical section has been exited. */\r
-\r
- vTaskSuspendAll();\r
- prvLockQueue( pxQueue );\r
-\r
- /* Update the timeout state to see if it has expired yet. */\r
- if( xTaskCheckForTimeOut( &xTimeOut, &xTicksToWait ) == pdFALSE )\r
- {\r
- if( prvIsQueueFull( pxQueue ) != pdFALSE )\r
- {\r
- traceBLOCKING_ON_QUEUE_SEND( pxQueue );\r
- vTaskPlaceOnEventList( &( pxQueue->xTasksWaitingToSend ), xTicksToWait );\r
-\r
- /* Unlocking the queue means queue events can effect the\r
- event list. It is possible that interrupts occurring now\r
- remove this task from the event list again - but as the\r
- scheduler is suspended the task will go onto the pending\r
- ready last instead of the actual ready list. */\r
- prvUnlockQueue( pxQueue );\r
-\r
- /* Resuming the scheduler will move tasks from the pending\r
- ready list into the ready list - so it is feasible that this\r
- task is already in a ready list before it yields - in which\r
- case the yield will not cause a context switch unless there\r
- is also a higher priority task in the pending ready list. */\r
- if( xTaskResumeAll() == pdFALSE )\r
- {\r
- portYIELD_WITHIN_API();\r
- }\r
- }\r
- else\r
- {\r
- /* Try again. */\r
- prvUnlockQueue( pxQueue );\r
- ( void ) xTaskResumeAll();\r
- }\r
- }\r
- else\r
- {\r
- /* The timeout has expired. */\r
- prvUnlockQueue( pxQueue );\r
- ( void ) xTaskResumeAll();\r
-\r
- traceQUEUE_SEND_FAILED( pxQueue );\r
- return errQUEUE_FULL;\r
- }\r
- }\r
-}\r
-/*-----------------------------------------------------------*/\r
-\r
-BaseType_t xQueueGenericSendFromISR( QueueHandle_t xQueue, const void * const pvItemToQueue, BaseType_t * const pxHigherPriorityTaskWoken, const BaseType_t xCopyPosition )\r
-{\r
-BaseType_t xReturn;\r
-UBaseType_t uxSavedInterruptStatus;\r
-Queue_t * const pxQueue = ( Queue_t * ) xQueue;\r
-\r
- configASSERT( pxQueue );\r
- configASSERT( !( ( pvItemToQueue == NULL ) && ( pxQueue->uxItemSize != ( UBaseType_t ) 0U ) ) );\r
- configASSERT( !( ( xCopyPosition == queueOVERWRITE ) && ( pxQueue->uxLength != 1 ) ) );\r
-\r
- /* RTOS ports that support interrupt nesting have the concept of a maximum\r
- system call (or maximum API call) interrupt priority. Interrupts that are\r
- above the maximum system call priority are kept permanently enabled, even\r
- when the RTOS kernel is in a critical section, but cannot make any calls to\r
- FreeRTOS API functions. If configASSERT() is defined in FreeRTOSConfig.h\r
- then portASSERT_IF_INTERRUPT_PRIORITY_INVALID() will result in an assertion\r
- failure if a FreeRTOS API function is called from an interrupt that has been\r
- assigned a priority above the configured maximum system call priority.\r
- Only FreeRTOS functions that end in FromISR can be called from interrupts\r
- that have been assigned a priority at or (logically) below the maximum\r
- system call interrupt priority. FreeRTOS maintains a separate interrupt\r
- safe API to ensure interrupt entry is as fast and as simple as possible.\r
- More information (albeit Cortex-M specific) is provided on the following\r
- link: http://www.freertos.org/RTOS-Cortex-M3-M4.html */\r
- portASSERT_IF_INTERRUPT_PRIORITY_INVALID();\r
-\r
- /* Similar to xQueueGenericSend, except without blocking if there is no room\r
- in the queue. Also don't directly wake a task that was blocked on a queue\r
- read, instead return a flag to say whether a context switch is required or\r
- not (i.e. has a task with a higher priority than us been woken by this\r
- post). */\r
- uxSavedInterruptStatus = portSET_INTERRUPT_MASK_FROM_ISR();\r
- {\r
- if( ( pxQueue->uxMessagesWaiting < pxQueue->uxLength ) || ( xCopyPosition == queueOVERWRITE ) )\r
- {\r
- const int8_t cTxLock = pxQueue->cTxLock;\r
-\r
- traceQUEUE_SEND_FROM_ISR( pxQueue );\r
-\r
- /* Semaphores use xQueueGiveFromISR(), so pxQueue will not be a\r
- semaphore or mutex. That means prvCopyDataToQueue() cannot result\r
- in a task disinheriting a priority and prvCopyDataToQueue() can be\r
- called here even though the disinherit function does not check if\r
- the scheduler is suspended before accessing the ready lists. */\r
- ( void ) prvCopyDataToQueue( pxQueue, pvItemToQueue, xCopyPosition );\r
-\r
- /* The event list is not altered if the queue is locked. This will\r
- be done when the queue is unlocked later. */\r
- if( cTxLock == queueUNLOCKED )\r
- {\r
- #if ( configUSE_QUEUE_SETS == 1 )\r
- {\r
- if( pxQueue->pxQueueSetContainer != NULL )\r
- {\r
- if( prvNotifyQueueSetContainer( pxQueue, xCopyPosition ) != pdFALSE )\r
- {\r
- /* The queue is a member of a queue set, and posting\r
- to the queue set caused a higher priority task to\r
- unblock. A context switch is required. */\r
- if( pxHigherPriorityTaskWoken != NULL )\r
- {\r
- *pxHigherPriorityTaskWoken = pdTRUE;\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- else\r
- {\r
- if( listLIST_IS_EMPTY( &( pxQueue->xTasksWaitingToReceive ) ) == pdFALSE )\r
- {\r
- if( xTaskRemoveFromEventList( &( pxQueue->xTasksWaitingToReceive ) ) != pdFALSE )\r
- {\r
- /* The task waiting has a higher priority so\r
- record that a context switch is required. */\r
- if( pxHigherPriorityTaskWoken != NULL )\r
- {\r
- *pxHigherPriorityTaskWoken = pdTRUE;\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- }\r
- #else /* configUSE_QUEUE_SETS */\r
- {\r
- if( listLIST_IS_EMPTY( &( pxQueue->xTasksWaitingToReceive ) ) == pdFALSE )\r
- {\r
- if( xTaskRemoveFromEventList( &( pxQueue->xTasksWaitingToReceive ) ) != pdFALSE )\r
- {\r
- /* The task waiting has a higher priority so record that a\r
- context switch is required. */\r
- if( pxHigherPriorityTaskWoken != NULL )\r
- {\r
- *pxHigherPriorityTaskWoken = pdTRUE;\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- #endif /* configUSE_QUEUE_SETS */\r
- }\r
- else\r
- {\r
- /* Increment the lock count so the task that unlocks the queue\r
- knows that data was posted while it was locked. */\r
- pxQueue->cTxLock = ( int8_t ) ( cTxLock + 1 );\r
- }\r
-\r
- xReturn = pdPASS;\r
- }\r
- else\r
- {\r
- traceQUEUE_SEND_FROM_ISR_FAILED( pxQueue );\r
- xReturn = errQUEUE_FULL;\r
- }\r
- }\r
- portCLEAR_INTERRUPT_MASK_FROM_ISR( uxSavedInterruptStatus );\r
-\r
- return xReturn;\r
-}\r
-/*-----------------------------------------------------------*/\r
-\r
-BaseType_t xQueueGiveFromISR( QueueHandle_t xQueue, BaseType_t * const pxHigherPriorityTaskWoken )\r
-{\r
-BaseType_t xReturn;\r
-UBaseType_t uxSavedInterruptStatus;\r
-Queue_t * const pxQueue = ( Queue_t * ) xQueue;\r
-\r
- /* Similar to xQueueGenericSendFromISR() but used with semaphores where the\r
- item size is 0. Don't directly wake a task that was blocked on a queue\r
- read, instead return a flag to say whether a context switch is required or\r
- not (i.e. has a task with a higher priority than us been woken by this\r
- post). */\r
-\r
- configASSERT( pxQueue );\r
-\r
- /* xQueueGenericSendFromISR() should be used instead of xQueueGiveFromISR()\r
- if the item size is not 0. */\r
- configASSERT( pxQueue->uxItemSize == 0 );\r
-\r
- /* Normally a mutex would not be given from an interrupt, especially if\r
- there is a mutex holder, as priority inheritance makes no sense for an\r
- interrupts, only tasks. */\r
- configASSERT( !( ( pxQueue->uxQueueType == queueQUEUE_IS_MUTEX ) && ( pxQueue->pxMutexHolder != NULL ) ) );\r
-\r
- /* RTOS ports that support interrupt nesting have the concept of a maximum\r
- system call (or maximum API call) interrupt priority. Interrupts that are\r
- above the maximum system call priority are kept permanently enabled, even\r
- when the RTOS kernel is in a critical section, but cannot make any calls to\r
- FreeRTOS API functions. If configASSERT() is defined in FreeRTOSConfig.h\r
- then portASSERT_IF_INTERRUPT_PRIORITY_INVALID() will result in an assertion\r
- failure if a FreeRTOS API function is called from an interrupt that has been\r
- assigned a priority above the configured maximum system call priority.\r
- Only FreeRTOS functions that end in FromISR can be called from interrupts\r
- that have been assigned a priority at or (logically) below the maximum\r
- system call interrupt priority. FreeRTOS maintains a separate interrupt\r
- safe API to ensure interrupt entry is as fast and as simple as possible.\r
- More information (albeit Cortex-M specific) is provided on the following\r
- link: http://www.freertos.org/RTOS-Cortex-M3-M4.html */\r
- portASSERT_IF_INTERRUPT_PRIORITY_INVALID();\r
-\r
- uxSavedInterruptStatus = portSET_INTERRUPT_MASK_FROM_ISR();\r
- {\r
- const UBaseType_t uxMessagesWaiting = pxQueue->uxMessagesWaiting;\r
-\r
- /* When the queue is used to implement a semaphore no data is ever\r
- moved through the queue but it is still valid to see if the queue 'has\r
- space'. */\r
- if( uxMessagesWaiting < pxQueue->uxLength )\r
- {\r
- const int8_t cTxLock = pxQueue->cTxLock;\r
-\r
- traceQUEUE_SEND_FROM_ISR( pxQueue );\r
-\r
- /* A task can only have an inherited priority if it is a mutex\r
- holder - and if there is a mutex holder then the mutex cannot be\r
- given from an ISR. As this is the ISR version of the function it\r
- can be assumed there is no mutex holder and no need to determine if\r
- priority disinheritance is needed. Simply increase the count of\r
- messages (semaphores) available. */\r
- pxQueue->uxMessagesWaiting = uxMessagesWaiting + ( UBaseType_t ) 1;\r
-\r
- /* The event list is not altered if the queue is locked. This will\r
- be done when the queue is unlocked later. */\r
- if( cTxLock == queueUNLOCKED )\r
- {\r
- #if ( configUSE_QUEUE_SETS == 1 )\r
- {\r
- if( pxQueue->pxQueueSetContainer != NULL )\r
- {\r
- if( prvNotifyQueueSetContainer( pxQueue, queueSEND_TO_BACK ) != pdFALSE )\r
- {\r
- /* The semaphore is a member of a queue set, and\r
- posting to the queue set caused a higher priority\r
- task to unblock. A context switch is required. */\r
- if( pxHigherPriorityTaskWoken != NULL )\r
- {\r
- *pxHigherPriorityTaskWoken = pdTRUE;\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- else\r
- {\r
- if( listLIST_IS_EMPTY( &( pxQueue->xTasksWaitingToReceive ) ) == pdFALSE )\r
- {\r
- if( xTaskRemoveFromEventList( &( pxQueue->xTasksWaitingToReceive ) ) != pdFALSE )\r
- {\r
- /* The task waiting has a higher priority so\r
- record that a context switch is required. */\r
- if( pxHigherPriorityTaskWoken != NULL )\r
- {\r
- *pxHigherPriorityTaskWoken = pdTRUE;\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- }\r
- #else /* configUSE_QUEUE_SETS */\r
- {\r
- if( listLIST_IS_EMPTY( &( pxQueue->xTasksWaitingToReceive ) ) == pdFALSE )\r
- {\r
- if( xTaskRemoveFromEventList( &( pxQueue->xTasksWaitingToReceive ) ) != pdFALSE )\r
- {\r
- /* The task waiting has a higher priority so record that a\r
- context switch is required. */\r
- if( pxHigherPriorityTaskWoken != NULL )\r
- {\r
- *pxHigherPriorityTaskWoken = pdTRUE;\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- #endif /* configUSE_QUEUE_SETS */\r
- }\r
- else\r
- {\r
- /* Increment the lock count so the task that unlocks the queue\r
- knows that data was posted while it was locked. */\r
- pxQueue->cTxLock = ( int8_t ) ( cTxLock + 1 );\r
- }\r
-\r
- xReturn = pdPASS;\r
- }\r
- else\r
- {\r
- traceQUEUE_SEND_FROM_ISR_FAILED( pxQueue );\r
- xReturn = errQUEUE_FULL;\r
- }\r
- }\r
- portCLEAR_INTERRUPT_MASK_FROM_ISR( uxSavedInterruptStatus );\r
-\r
- return xReturn;\r
-}\r
-/*-----------------------------------------------------------*/\r
-\r
-BaseType_t xQueueReceive( QueueHandle_t xQueue, void * const pvBuffer, TickType_t xTicksToWait )\r
-{\r
-BaseType_t xEntryTimeSet = pdFALSE;\r
-TimeOut_t xTimeOut;\r
-Queue_t * const pxQueue = ( Queue_t * ) xQueue;\r
-\r
- /* Check the pointer is not NULL. */\r
- configASSERT( ( pxQueue ) );\r
-\r
- /* The buffer into which data is received can only be NULL if the data size\r
- is zero (so no data is copied into the buffer. */\r
- configASSERT( !( ( ( pvBuffer ) == NULL ) && ( ( pxQueue )->uxItemSize != ( UBaseType_t ) 0U ) ) );\r
-\r
- /* Cannot block if the scheduler is suspended. */\r
- #if ( ( INCLUDE_xTaskGetSchedulerState == 1 ) || ( configUSE_TIMERS == 1 ) )\r
- {\r
- configASSERT( !( ( xTaskGetSchedulerState() == taskSCHEDULER_SUSPENDED ) && ( xTicksToWait != 0 ) ) );\r
- }\r
- #endif\r
-\r
-\r
- /* This function relaxes the coding standard somewhat to allow return\r
- statements within the function itself. This is done in the interest\r
- of execution time efficiency. */\r
-\r
- for( ;; )\r
- {\r
- taskENTER_CRITICAL();\r
- {\r
- const UBaseType_t uxMessagesWaiting = pxQueue->uxMessagesWaiting;\r
-\r
- /* Is there data in the queue now? To be running the calling task\r
- must be the highest priority task wanting to access the queue. */\r
- if( uxMessagesWaiting > ( UBaseType_t ) 0 )\r
- {\r
- /* Data available, remove one item. */\r
- prvCopyDataFromQueue( pxQueue, pvBuffer );\r
- traceQUEUE_RECEIVE( pxQueue );\r
- pxQueue->uxMessagesWaiting = uxMessagesWaiting - ( UBaseType_t ) 1;\r
-\r
- /* There is now space in the queue, were any tasks waiting to\r
- post to the queue? If so, unblock the highest priority waiting\r
- task. */\r
- if( listLIST_IS_EMPTY( &( pxQueue->xTasksWaitingToSend ) ) == pdFALSE )\r
- {\r
- if( xTaskRemoveFromEventList( &( pxQueue->xTasksWaitingToSend ) ) != pdFALSE )\r
- {\r
- queueYIELD_IF_USING_PREEMPTION();\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
-\r
- taskEXIT_CRITICAL();\r
- return pdPASS;\r
- }\r
- else\r
- {\r
- if( xTicksToWait == ( TickType_t ) 0 )\r
- {\r
- /* The queue was empty and no block time is specified (or\r
- the block time has expired) so leave now. */\r
- taskEXIT_CRITICAL();\r
- traceQUEUE_RECEIVE_FAILED( pxQueue );\r
- return errQUEUE_EMPTY;\r
- }\r
- else if( xEntryTimeSet == pdFALSE )\r
- {\r
- /* The queue was empty and a block time was specified so\r
- configure the timeout structure. */\r
- vTaskInternalSetTimeOutState( &xTimeOut );\r
- xEntryTimeSet = pdTRUE;\r
- }\r
- else\r
- {\r
- /* Entry time was already set. */\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- }\r
- taskEXIT_CRITICAL();\r
-\r
- /* Interrupts and other tasks can send to and receive from the queue\r
- now the critical section has been exited. */\r
-\r
- vTaskSuspendAll();\r
- prvLockQueue( pxQueue );\r
-\r
- /* Update the timeout state to see if it has expired yet. */\r
- if( xTaskCheckForTimeOut( &xTimeOut, &xTicksToWait ) == pdFALSE )\r
- {\r
- /* The timeout has not expired. If the queue is still empty place\r
- the task on the list of tasks waiting to receive from the queue. */\r
- if( prvIsQueueEmpty( pxQueue ) != pdFALSE )\r
- {\r
- traceBLOCKING_ON_QUEUE_RECEIVE( pxQueue );\r
- vTaskPlaceOnEventList( &( pxQueue->xTasksWaitingToReceive ), xTicksToWait );\r
- prvUnlockQueue( pxQueue );\r
- if( xTaskResumeAll() == pdFALSE )\r
- {\r
- portYIELD_WITHIN_API();\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- else\r
- {\r
- /* The queue contains data again. Loop back to try and read the\r
- data. */\r
- prvUnlockQueue( pxQueue );\r
- ( void ) xTaskResumeAll();\r
- }\r
- }\r
- else\r
- {\r
- /* Timed out. If there is no data in the queue exit, otherwise loop\r
- back and attempt to read the data. */\r
- prvUnlockQueue( pxQueue );\r
- ( void ) xTaskResumeAll();\r
-\r
- if( prvIsQueueEmpty( pxQueue ) != pdFALSE )\r
- {\r
- traceQUEUE_RECEIVE_FAILED( pxQueue );\r
- return errQUEUE_EMPTY;\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- }\r
-}\r
-/*-----------------------------------------------------------*/\r
-\r
-BaseType_t xQueueSemaphoreTake( QueueHandle_t xQueue, TickType_t xTicksToWait )\r
-{\r
-BaseType_t xEntryTimeSet = pdFALSE;\r
-TimeOut_t xTimeOut;\r
-Queue_t * const pxQueue = ( Queue_t * ) xQueue;\r
-\r
-#if( configUSE_MUTEXES == 1 )\r
- BaseType_t xInheritanceOccurred = pdFALSE;\r
-#endif\r
-\r
- /* Check the queue pointer is not NULL. */\r
- configASSERT( ( pxQueue ) );\r
-\r
- /* Check this really is a semaphore, in which case the item size will be\r
- 0. */\r
- configASSERT( pxQueue->uxItemSize == 0 );\r
-\r
- /* Cannot block if the scheduler is suspended. */\r
- #if ( ( INCLUDE_xTaskGetSchedulerState == 1 ) || ( configUSE_TIMERS == 1 ) )\r
- {\r
- configASSERT( !( ( xTaskGetSchedulerState() == taskSCHEDULER_SUSPENDED ) && ( xTicksToWait != 0 ) ) );\r
- }\r
- #endif\r
-\r
-\r
- /* This function relaxes the coding standard somewhat to allow return\r
- statements within the function itself. This is done in the interest\r
- of execution time efficiency. */\r
-\r
- for( ;; )\r
- {\r
- taskENTER_CRITICAL();\r
- {\r
- /* Semaphores are queues with an item size of 0, and where the\r
- number of messages in the queue is the semaphore's count value. */\r
- const UBaseType_t uxSemaphoreCount = pxQueue->uxMessagesWaiting;\r
-\r
- /* Is there data in the queue now? To be running the calling task\r
- must be the highest priority task wanting to access the queue. */\r
- if( uxSemaphoreCount > ( UBaseType_t ) 0 )\r
- {\r
- traceQUEUE_RECEIVE( pxQueue );\r
-\r
- /* Semaphores are queues with a data size of zero and where the\r
- messages waiting is the semaphore's count. Reduce the count. */\r
- pxQueue->uxMessagesWaiting = uxSemaphoreCount - ( UBaseType_t ) 1;\r
-\r
- #if ( configUSE_MUTEXES == 1 )\r
- {\r
- if( pxQueue->uxQueueType == queueQUEUE_IS_MUTEX )\r
- {\r
- /* Record the information required to implement\r
- priority inheritance should it become necessary. */\r
- pxQueue->pxMutexHolder = ( int8_t * ) pvTaskIncrementMutexHeldCount(); /*lint !e961 Cast is not redundant as TaskHandle_t is a typedef. */\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- #endif /* configUSE_MUTEXES */\r
-\r
- /* Check to see if other tasks are blocked waiting to give the\r
- semaphore, and if so, unblock the highest priority such task. */\r
- if( listLIST_IS_EMPTY( &( pxQueue->xTasksWaitingToSend ) ) == pdFALSE )\r
- {\r
- if( xTaskRemoveFromEventList( &( pxQueue->xTasksWaitingToSend ) ) != pdFALSE )\r
- {\r
- queueYIELD_IF_USING_PREEMPTION();\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
-\r
- taskEXIT_CRITICAL();\r
- return pdPASS;\r
- }\r
- else\r
- {\r
- if( xTicksToWait == ( TickType_t ) 0 )\r
- {\r
- /* For inheritance to have occurred there must have been an\r
- initial timeout, and an adjusted timeout cannot become 0, as\r
- if it were 0 the function would have exited. */\r
- #if( configUSE_MUTEXES == 1 )\r
- {\r
- configASSERT( xInheritanceOccurred == pdFALSE );\r
- }\r
- #endif /* configUSE_MUTEXES */\r
-\r
- /* The semaphore count was 0 and no block time is specified\r
- (or the block time has expired) so exit now. */\r
- taskEXIT_CRITICAL();\r
- traceQUEUE_RECEIVE_FAILED( pxQueue );\r
- return errQUEUE_EMPTY;\r
- }\r
- else if( xEntryTimeSet == pdFALSE )\r
- {\r
- /* The semaphore count was 0 and a block time was specified\r
- so configure the timeout structure ready to block. */\r
- vTaskInternalSetTimeOutState( &xTimeOut );\r
- xEntryTimeSet = pdTRUE;\r
- }\r
- else\r
- {\r
- /* Entry time was already set. */\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- }\r
- taskEXIT_CRITICAL();\r
-\r
- /* Interrupts and other tasks can give to and take from the semaphore\r
- now the critical section has been exited. */\r
-\r
- vTaskSuspendAll();\r
- prvLockQueue( pxQueue );\r
-\r
- /* Update the timeout state to see if it has expired yet. */\r
- if( xTaskCheckForTimeOut( &xTimeOut, &xTicksToWait ) == pdFALSE )\r
- {\r
- /* A block time is specified and not expired. If the semaphore\r
- count is 0 then enter the Blocked state to wait for a semaphore to\r
- become available. As semaphores are implemented with queues the\r
- queue being empty is equivalent to the semaphore count being 0. */\r
- if( prvIsQueueEmpty( pxQueue ) != pdFALSE )\r
- {\r
- traceBLOCKING_ON_QUEUE_RECEIVE( pxQueue );\r
-\r
- #if ( configUSE_MUTEXES == 1 )\r
- {\r
- if( pxQueue->uxQueueType == queueQUEUE_IS_MUTEX )\r
- {\r
- taskENTER_CRITICAL();\r
- {\r
- xInheritanceOccurred = xTaskPriorityInherit( ( void * ) pxQueue->pxMutexHolder );\r
- }\r
- taskEXIT_CRITICAL();\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- #endif\r
-\r
- vTaskPlaceOnEventList( &( pxQueue->xTasksWaitingToReceive ), xTicksToWait );\r
- prvUnlockQueue( pxQueue );\r
- if( xTaskResumeAll() == pdFALSE )\r
- {\r
- portYIELD_WITHIN_API();\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- else\r
- {\r
- /* There was no timeout and the semaphore count was not 0, so\r
- attempt to take the semaphore again. */\r
- prvUnlockQueue( pxQueue );\r
- ( void ) xTaskResumeAll();\r
- }\r
- }\r
- else\r
- {\r
- /* Timed out. */\r
- prvUnlockQueue( pxQueue );\r
- ( void ) xTaskResumeAll();\r
-\r
- /* If the semaphore count is 0 exit now as the timeout has\r
- expired. Otherwise return to attempt to take the semaphore that is\r
- known to be available. As semaphores are implemented by queues the\r
- queue being empty is equivalent to the semaphore count being 0. */\r
- if( prvIsQueueEmpty( pxQueue ) != pdFALSE )\r
- {\r
- #if ( configUSE_MUTEXES == 1 )\r
- {\r
- /* xInheritanceOccurred could only have be set if\r
- pxQueue->uxQueueType == queueQUEUE_IS_MUTEX so no need to\r
- test the mutex type again to check it is actually a mutex. */\r
- if( xInheritanceOccurred != pdFALSE )\r
- {\r
- taskENTER_CRITICAL();\r
- {\r
- UBaseType_t uxHighestWaitingPriority;\r
-\r
- /* This task blocking on the mutex caused another\r
- task to inherit this task's priority. Now this task\r
- has timed out the priority should be disinherited\r
- again, but only as low as the next highest priority\r
- task that is waiting for the same mutex. */\r
- uxHighestWaitingPriority = prvGetDisinheritPriorityAfterTimeout( pxQueue );\r
- vTaskPriorityDisinheritAfterTimeout( ( void * ) pxQueue->pxMutexHolder, uxHighestWaitingPriority );\r
- }\r
- taskEXIT_CRITICAL();\r
- }\r
- }\r
- #endif /* configUSE_MUTEXES */\r
-\r
- traceQUEUE_RECEIVE_FAILED( pxQueue );\r
- return errQUEUE_EMPTY;\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- }\r
-}\r
-/*-----------------------------------------------------------*/\r
-\r
-BaseType_t xQueuePeek( QueueHandle_t xQueue, void * const pvBuffer, TickType_t xTicksToWait )\r
-{\r
-BaseType_t xEntryTimeSet = pdFALSE;\r
-TimeOut_t xTimeOut;\r
-int8_t *pcOriginalReadPosition;\r
-Queue_t * const pxQueue = ( Queue_t * ) xQueue;\r
-\r
- /* Check the pointer is not NULL. */\r
- configASSERT( ( pxQueue ) );\r
-\r
- /* The buffer into which data is received can only be NULL if the data size\r
- is zero (so no data is copied into the buffer. */\r
- configASSERT( !( ( ( pvBuffer ) == NULL ) && ( ( pxQueue )->uxItemSize != ( UBaseType_t ) 0U ) ) );\r
-\r
- /* Cannot block if the scheduler is suspended. */\r
- #if ( ( INCLUDE_xTaskGetSchedulerState == 1 ) || ( configUSE_TIMERS == 1 ) )\r
- {\r
- configASSERT( !( ( xTaskGetSchedulerState() == taskSCHEDULER_SUSPENDED ) && ( xTicksToWait != 0 ) ) );\r
- }\r
- #endif\r
-\r
-\r
- /* This function relaxes the coding standard somewhat to allow return\r
- statements within the function itself. This is done in the interest\r
- of execution time efficiency. */\r
-\r
- for( ;; )\r
- {\r
- taskENTER_CRITICAL();\r
- {\r
- const UBaseType_t uxMessagesWaiting = pxQueue->uxMessagesWaiting;\r
-\r
- /* Is there data in the queue now? To be running the calling task\r
- must be the highest priority task wanting to access the queue. */\r
- if( uxMessagesWaiting > ( UBaseType_t ) 0 )\r
- {\r
- /* Remember the read position so it can be reset after the data\r
- is read from the queue as this function is only peeking the\r
- data, not removing it. */\r
- pcOriginalReadPosition = pxQueue->u.pcReadFrom;\r
-\r
- prvCopyDataFromQueue( pxQueue, pvBuffer );\r
- traceQUEUE_PEEK( pxQueue );\r
-\r
- /* The data is not being removed, so reset the read pointer. */\r
- pxQueue->u.pcReadFrom = pcOriginalReadPosition;\r
-\r
- /* The data is being left in the queue, so see if there are\r
- any other tasks waiting for the data. */\r
- if( listLIST_IS_EMPTY( &( pxQueue->xTasksWaitingToReceive ) ) == pdFALSE )\r
- {\r
- if( xTaskRemoveFromEventList( &( pxQueue->xTasksWaitingToReceive ) ) != pdFALSE )\r
- {\r
- /* The task waiting has a higher priority than this task. */\r
- queueYIELD_IF_USING_PREEMPTION();\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
-\r
- taskEXIT_CRITICAL();\r
- return pdPASS;\r
- }\r
- else\r
- {\r
- if( xTicksToWait == ( TickType_t ) 0 )\r
- {\r
- /* The queue was empty and no block time is specified (or\r
- the block time has expired) so leave now. */\r
- taskEXIT_CRITICAL();\r
- traceQUEUE_PEEK_FAILED( pxQueue );\r
- return errQUEUE_EMPTY;\r
- }\r
- else if( xEntryTimeSet == pdFALSE )\r
- {\r
- /* The queue was empty and a block time was specified so\r
- configure the timeout structure ready to enter the blocked\r
- state. */\r
- vTaskInternalSetTimeOutState( &xTimeOut );\r
- xEntryTimeSet = pdTRUE;\r
- }\r
- else\r
- {\r
- /* Entry time was already set. */\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- }\r
- taskEXIT_CRITICAL();\r
-\r
- /* Interrupts and other tasks can send to and receive from the queue\r
- now the critical section has been exited. */\r
-\r
- vTaskSuspendAll();\r
- prvLockQueue( pxQueue );\r
-\r
- /* Update the timeout state to see if it has expired yet. */\r
- if( xTaskCheckForTimeOut( &xTimeOut, &xTicksToWait ) == pdFALSE )\r
- {\r
- /* Timeout has not expired yet, check to see if there is data in the\r
- queue now, and if not enter the Blocked state to wait for data. */\r
- if( prvIsQueueEmpty( pxQueue ) != pdFALSE )\r
- {\r
- traceBLOCKING_ON_QUEUE_PEEK( pxQueue );\r
- vTaskPlaceOnEventList( &( pxQueue->xTasksWaitingToReceive ), xTicksToWait );\r
- prvUnlockQueue( pxQueue );\r
- if( xTaskResumeAll() == pdFALSE )\r
- {\r
- portYIELD_WITHIN_API();\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- else\r
- {\r
- /* There is data in the queue now, so don't enter the blocked\r
- state, instead return to try and obtain the data. */\r
- prvUnlockQueue( pxQueue );\r
- ( void ) xTaskResumeAll();\r
- }\r
- }\r
- else\r
- {\r
- /* The timeout has expired. If there is still no data in the queue\r
- exit, otherwise go back and try to read the data again. */\r
- prvUnlockQueue( pxQueue );\r
- ( void ) xTaskResumeAll();\r
-\r
- if( prvIsQueueEmpty( pxQueue ) != pdFALSE )\r
- {\r
- traceQUEUE_PEEK_FAILED( pxQueue );\r
- return errQUEUE_EMPTY;\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- }\r
-}\r
-/*-----------------------------------------------------------*/\r
-\r
-BaseType_t xQueueReceiveFromISR( QueueHandle_t xQueue, void * const pvBuffer, BaseType_t * const pxHigherPriorityTaskWoken )\r
-{\r
-BaseType_t xReturn;\r
-UBaseType_t uxSavedInterruptStatus;\r
-Queue_t * const pxQueue = ( Queue_t * ) xQueue;\r
-\r
- configASSERT( pxQueue );\r
- configASSERT( !( ( pvBuffer == NULL ) && ( pxQueue->uxItemSize != ( UBaseType_t ) 0U ) ) );\r
-\r
- /* RTOS ports that support interrupt nesting have the concept of a maximum\r
- system call (or maximum API call) interrupt priority. Interrupts that are\r
- above the maximum system call priority are kept permanently enabled, even\r
- when the RTOS kernel is in a critical section, but cannot make any calls to\r
- FreeRTOS API functions. If configASSERT() is defined in FreeRTOSConfig.h\r
- then portASSERT_IF_INTERRUPT_PRIORITY_INVALID() will result in an assertion\r
- failure if a FreeRTOS API function is called from an interrupt that has been\r
- assigned a priority above the configured maximum system call priority.\r
- Only FreeRTOS functions that end in FromISR can be called from interrupts\r
- that have been assigned a priority at or (logically) below the maximum\r
- system call interrupt priority. FreeRTOS maintains a separate interrupt\r
- safe API to ensure interrupt entry is as fast and as simple as possible.\r
- More information (albeit Cortex-M specific) is provided on the following\r
- link: http://www.freertos.org/RTOS-Cortex-M3-M4.html */\r
- portASSERT_IF_INTERRUPT_PRIORITY_INVALID();\r
-\r
- uxSavedInterruptStatus = portSET_INTERRUPT_MASK_FROM_ISR();\r
- {\r
- const UBaseType_t uxMessagesWaiting = pxQueue->uxMessagesWaiting;\r
-\r
- /* Cannot block in an ISR, so check there is data available. */\r
- if( uxMessagesWaiting > ( UBaseType_t ) 0 )\r
- {\r
- const int8_t cRxLock = pxQueue->cRxLock;\r
-\r
- traceQUEUE_RECEIVE_FROM_ISR( pxQueue );\r
-\r
- prvCopyDataFromQueue( pxQueue, pvBuffer );\r
- pxQueue->uxMessagesWaiting = uxMessagesWaiting - ( UBaseType_t ) 1;\r
-\r
- /* If the queue is locked the event list will not be modified.\r
- Instead update the lock count so the task that unlocks the queue\r
- will know that an ISR has removed data while the queue was\r
- locked. */\r
- if( cRxLock == queueUNLOCKED )\r
- {\r
- if( listLIST_IS_EMPTY( &( pxQueue->xTasksWaitingToSend ) ) == pdFALSE )\r
- {\r
- if( xTaskRemoveFromEventList( &( pxQueue->xTasksWaitingToSend ) ) != pdFALSE )\r
- {\r
- /* The task waiting has a higher priority than us so\r
- force a context switch. */\r
- if( pxHigherPriorityTaskWoken != NULL )\r
- {\r
- *pxHigherPriorityTaskWoken = pdTRUE;\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- else\r
- {\r
- /* Increment the lock count so the task that unlocks the queue\r
- knows that data was removed while it was locked. */\r
- pxQueue->cRxLock = ( int8_t ) ( cRxLock + 1 );\r
- }\r
-\r
- xReturn = pdPASS;\r
- }\r
- else\r
- {\r
- xReturn = pdFAIL;\r
- traceQUEUE_RECEIVE_FROM_ISR_FAILED( pxQueue );\r
- }\r
- }\r
- portCLEAR_INTERRUPT_MASK_FROM_ISR( uxSavedInterruptStatus );\r
-\r
- return xReturn;\r
-}\r
-/*-----------------------------------------------------------*/\r
-\r
-BaseType_t xQueuePeekFromISR( QueueHandle_t xQueue, void * const pvBuffer )\r
-{\r
-BaseType_t xReturn;\r
-UBaseType_t uxSavedInterruptStatus;\r
-int8_t *pcOriginalReadPosition;\r
-Queue_t * const pxQueue = ( Queue_t * ) xQueue;\r
-\r
- configASSERT( pxQueue );\r
- configASSERT( !( ( pvBuffer == NULL ) && ( pxQueue->uxItemSize != ( UBaseType_t ) 0U ) ) );\r
- configASSERT( pxQueue->uxItemSize != 0 ); /* Can't peek a semaphore. */\r
-\r
- /* RTOS ports that support interrupt nesting have the concept of a maximum\r
- system call (or maximum API call) interrupt priority. Interrupts that are\r
- above the maximum system call priority are kept permanently enabled, even\r
- when the RTOS kernel is in a critical section, but cannot make any calls to\r
- FreeRTOS API functions. If configASSERT() is defined in FreeRTOSConfig.h\r
- then portASSERT_IF_INTERRUPT_PRIORITY_INVALID() will result in an assertion\r
- failure if a FreeRTOS API function is called from an interrupt that has been\r
- assigned a priority above the configured maximum system call priority.\r
- Only FreeRTOS functions that end in FromISR can be called from interrupts\r
- that have been assigned a priority at or (logically) below the maximum\r
- system call interrupt priority. FreeRTOS maintains a separate interrupt\r
- safe API to ensure interrupt entry is as fast and as simple as possible.\r
- More information (albeit Cortex-M specific) is provided on the following\r
- link: http://www.freertos.org/RTOS-Cortex-M3-M4.html */\r
- portASSERT_IF_INTERRUPT_PRIORITY_INVALID();\r
-\r
- uxSavedInterruptStatus = portSET_INTERRUPT_MASK_FROM_ISR();\r
- {\r
- /* Cannot block in an ISR, so check there is data available. */\r
- if( pxQueue->uxMessagesWaiting > ( UBaseType_t ) 0 )\r
- {\r
- traceQUEUE_PEEK_FROM_ISR( pxQueue );\r
-\r
- /* Remember the read position so it can be reset as nothing is\r
- actually being removed from the queue. */\r
- pcOriginalReadPosition = pxQueue->u.pcReadFrom;\r
- prvCopyDataFromQueue( pxQueue, pvBuffer );\r
- pxQueue->u.pcReadFrom = pcOriginalReadPosition;\r
-\r
- xReturn = pdPASS;\r
- }\r
- else\r
- {\r
- xReturn = pdFAIL;\r
- traceQUEUE_PEEK_FROM_ISR_FAILED( pxQueue );\r
- }\r
- }\r
- portCLEAR_INTERRUPT_MASK_FROM_ISR( uxSavedInterruptStatus );\r
-\r
- return xReturn;\r
-}\r
-/*-----------------------------------------------------------*/\r
-\r
-UBaseType_t uxQueueMessagesWaiting( const QueueHandle_t xQueue )\r
-{\r
-UBaseType_t uxReturn;\r
-\r
- configASSERT( xQueue );\r
-\r
- taskENTER_CRITICAL();\r
- {\r
- uxReturn = ( ( Queue_t * ) xQueue )->uxMessagesWaiting;\r
- }\r
- taskEXIT_CRITICAL();\r
-\r
- return uxReturn;\r
-} /*lint !e818 Pointer cannot be declared const as xQueue is a typedef not pointer. */\r
-/*-----------------------------------------------------------*/\r
-\r
-UBaseType_t uxQueueSpacesAvailable( const QueueHandle_t xQueue )\r
-{\r
-UBaseType_t uxReturn;\r
-Queue_t *pxQueue;\r
-\r
- pxQueue = ( Queue_t * ) xQueue;\r
- configASSERT( pxQueue );\r
-\r
- taskENTER_CRITICAL();\r
- {\r
- uxReturn = pxQueue->uxLength - pxQueue->uxMessagesWaiting;\r
- }\r
- taskEXIT_CRITICAL();\r
-\r
- return uxReturn;\r
-} /*lint !e818 Pointer cannot be declared const as xQueue is a typedef not pointer. */\r
-/*-----------------------------------------------------------*/\r
-\r
-UBaseType_t uxQueueMessagesWaitingFromISR( const QueueHandle_t xQueue )\r
-{\r
-UBaseType_t uxReturn;\r
-\r
- configASSERT( xQueue );\r
-\r
- uxReturn = ( ( Queue_t * ) xQueue )->uxMessagesWaiting;\r
-\r
- return uxReturn;\r
-} /*lint !e818 Pointer cannot be declared const as xQueue is a typedef not pointer. */\r
-/*-----------------------------------------------------------*/\r
-\r
-void vQueueDelete( QueueHandle_t xQueue )\r
-{\r
-Queue_t * const pxQueue = ( Queue_t * ) xQueue;\r
-\r
- configASSERT( pxQueue );\r
- traceQUEUE_DELETE( pxQueue );\r
-\r
- #if ( configQUEUE_REGISTRY_SIZE > 0 )\r
- {\r
- vQueueUnregisterQueue( pxQueue );\r
- }\r
- #endif\r
-\r
- #if( ( configSUPPORT_DYNAMIC_ALLOCATION == 1 ) && ( configSUPPORT_STATIC_ALLOCATION == 0 ) )\r
- {\r
- /* The queue can only have been allocated dynamically - free it\r
- again. */\r
- vPortFree( pxQueue );\r
- }\r
- #elif( ( configSUPPORT_DYNAMIC_ALLOCATION == 1 ) && ( configSUPPORT_STATIC_ALLOCATION == 1 ) )\r
- {\r
- /* The queue could have been allocated statically or dynamically, so\r
- check before attempting to free the memory. */\r
- if( pxQueue->ucStaticallyAllocated == ( uint8_t ) pdFALSE )\r
- {\r
- vPortFree( pxQueue );\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- #else\r
- {\r
- /* The queue must have been statically allocated, so is not going to be\r
- deleted. Avoid compiler warnings about the unused parameter. */\r
- ( void ) pxQueue;\r
- }\r
- #endif /* configSUPPORT_DYNAMIC_ALLOCATION */\r
-}\r
-/*-----------------------------------------------------------*/\r
-\r
-#if ( configUSE_TRACE_FACILITY == 1 )\r
-\r
- UBaseType_t uxQueueGetQueueNumber( QueueHandle_t xQueue )\r
- {\r
- return ( ( Queue_t * ) xQueue )->uxQueueNumber;\r
- }\r
-\r
-#endif /* configUSE_TRACE_FACILITY */\r
-/*-----------------------------------------------------------*/\r
-\r
-#if ( configUSE_TRACE_FACILITY == 1 )\r
-\r
- void vQueueSetQueueNumber( QueueHandle_t xQueue, UBaseType_t uxQueueNumber )\r
- {\r
- ( ( Queue_t * ) xQueue )->uxQueueNumber = uxQueueNumber;\r
- }\r
-\r
-#endif /* configUSE_TRACE_FACILITY */\r
-/*-----------------------------------------------------------*/\r
-\r
-#if ( configUSE_TRACE_FACILITY == 1 )\r
-\r
- uint8_t ucQueueGetQueueType( QueueHandle_t xQueue )\r
- {\r
- return ( ( Queue_t * ) xQueue )->ucQueueType;\r
- }\r
-\r
-#endif /* configUSE_TRACE_FACILITY */\r
-/*-----------------------------------------------------------*/\r
-\r
-#if( configUSE_MUTEXES == 1 )\r
-\r
- static UBaseType_t prvGetDisinheritPriorityAfterTimeout( const Queue_t * const pxQueue )\r
- {\r
- UBaseType_t uxHighestPriorityOfWaitingTasks;\r
-\r
- /* If a task waiting for a mutex causes the mutex holder to inherit a\r
- priority, but the waiting task times out, then the holder should\r
- disinherit the priority - but only down to the highest priority of any\r
- other tasks that are waiting for the same mutex. For this purpose,\r
- return the priority of the highest priority task that is waiting for the\r
- mutex. */\r
- if( listCURRENT_LIST_LENGTH( &( pxQueue->xTasksWaitingToReceive ) ) > 0 )\r
- {\r
- uxHighestPriorityOfWaitingTasks = configMAX_PRIORITIES - listGET_ITEM_VALUE_OF_HEAD_ENTRY( &( pxQueue->xTasksWaitingToReceive ) );\r
- }\r
- else\r
- {\r
- uxHighestPriorityOfWaitingTasks = tskIDLE_PRIORITY;\r
- }\r
-\r
- return uxHighestPriorityOfWaitingTasks;\r
- }\r
-\r
-#endif /* configUSE_MUTEXES */\r
-/*-----------------------------------------------------------*/\r
-\r
-static BaseType_t prvCopyDataToQueue( Queue_t * const pxQueue, const void *pvItemToQueue, const BaseType_t xPosition )\r
-{\r
-BaseType_t xReturn = pdFALSE;\r
-UBaseType_t uxMessagesWaiting;\r
-\r
- /* This function is called from a critical section. */\r
-\r
- uxMessagesWaiting = pxQueue->uxMessagesWaiting;\r
-\r
- if( pxQueue->uxItemSize == ( UBaseType_t ) 0 )\r
- {\r
- #if ( configUSE_MUTEXES == 1 )\r
- {\r
- if( pxQueue->uxQueueType == queueQUEUE_IS_MUTEX )\r
- {\r
- /* The mutex is no longer being held. */\r
- xReturn = xTaskPriorityDisinherit( ( void * ) pxQueue->pxMutexHolder );\r
- pxQueue->pxMutexHolder = NULL;\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- #endif /* configUSE_MUTEXES */\r
- }\r
- else if( xPosition == queueSEND_TO_BACK )\r
- {\r
- ( void ) memcpy( ( void * ) pxQueue->pcWriteTo, pvItemToQueue, ( size_t ) pxQueue->uxItemSize ); /*lint !e961 !e418 MISRA exception as the casts are only redundant for some ports, plus previous logic ensures a null pointer can only be passed to memcpy() if the copy size is 0. */\r
- pxQueue->pcWriteTo += pxQueue->uxItemSize;\r
- if( pxQueue->pcWriteTo >= pxQueue->pcTail ) /*lint !e946 MISRA exception justified as comparison of pointers is the cleanest solution. */\r
- {\r
- pxQueue->pcWriteTo = pxQueue->pcHead;\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- else\r
- {\r
- ( void ) memcpy( ( void * ) pxQueue->u.pcReadFrom, pvItemToQueue, ( size_t ) pxQueue->uxItemSize ); /*lint !e961 MISRA exception as the casts are only redundant for some ports. */\r
- pxQueue->u.pcReadFrom -= pxQueue->uxItemSize;\r
- if( pxQueue->u.pcReadFrom < pxQueue->pcHead ) /*lint !e946 MISRA exception justified as comparison of pointers is the cleanest solution. */\r
- {\r
- pxQueue->u.pcReadFrom = ( pxQueue->pcTail - pxQueue->uxItemSize );\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
-\r
- if( xPosition == queueOVERWRITE )\r
- {\r
- if( uxMessagesWaiting > ( UBaseType_t ) 0 )\r
- {\r
- /* An item is not being added but overwritten, so subtract\r
- one from the recorded number of items in the queue so when\r
- one is added again below the number of recorded items remains\r
- correct. */\r
- --uxMessagesWaiting;\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
-\r
- pxQueue->uxMessagesWaiting = uxMessagesWaiting + ( UBaseType_t ) 1;\r
-\r
- return xReturn;\r
-}\r
-/*-----------------------------------------------------------*/\r
-\r
-static void prvCopyDataFromQueue( Queue_t * const pxQueue, void * const pvBuffer )\r
-{\r
- if( pxQueue->uxItemSize != ( UBaseType_t ) 0 )\r
- {\r
- pxQueue->u.pcReadFrom += pxQueue->uxItemSize;\r
- if( pxQueue->u.pcReadFrom >= pxQueue->pcTail ) /*lint !e946 MISRA exception justified as use of the relational operator is the cleanest solutions. */\r
- {\r
- pxQueue->u.pcReadFrom = pxQueue->pcHead;\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- ( void ) memcpy( ( void * ) pvBuffer, ( void * ) pxQueue->u.pcReadFrom, ( size_t ) pxQueue->uxItemSize ); /*lint !e961 !e418 MISRA exception as the casts are only redundant for some ports. Also previous logic ensures a null pointer can only be passed to memcpy() when the count is 0. */\r
- }\r
-}\r
-/*-----------------------------------------------------------*/\r
-\r
-static void prvUnlockQueue( Queue_t * const pxQueue )\r
-{\r
- /* THIS FUNCTION MUST BE CALLED WITH THE SCHEDULER SUSPENDED. */\r
-\r
- /* The lock counts contains the number of extra data items placed or\r
- removed from the queue while the queue was locked. When a queue is\r
- locked items can be added or removed, but the event lists cannot be\r
- updated. */\r
- taskENTER_CRITICAL();\r
- {\r
- int8_t cTxLock = pxQueue->cTxLock;\r
-\r
- /* See if data was added to the queue while it was locked. */\r
- while( cTxLock > queueLOCKED_UNMODIFIED )\r
- {\r
- /* Data was posted while the queue was locked. Are any tasks\r
- blocked waiting for data to become available? */\r
- #if ( configUSE_QUEUE_SETS == 1 )\r
- {\r
- if( pxQueue->pxQueueSetContainer != NULL )\r
- {\r
- if( prvNotifyQueueSetContainer( pxQueue, queueSEND_TO_BACK ) != pdFALSE )\r
- {\r
- /* The queue is a member of a queue set, and posting to\r
- the queue set caused a higher priority task to unblock.\r
- A context switch is required. */\r
- vTaskMissedYield();\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- else\r
- {\r
- /* Tasks that are removed from the event list will get\r
- added to the pending ready list as the scheduler is still\r
- suspended. */\r
- if( listLIST_IS_EMPTY( &( pxQueue->xTasksWaitingToReceive ) ) == pdFALSE )\r
- {\r
- if( xTaskRemoveFromEventList( &( pxQueue->xTasksWaitingToReceive ) ) != pdFALSE )\r
- {\r
- /* The task waiting has a higher priority so record that a\r
- context switch is required. */\r
- vTaskMissedYield();\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- else\r
- {\r
- break;\r
- }\r
- }\r
- }\r
- #else /* configUSE_QUEUE_SETS */\r
- {\r
- /* Tasks that are removed from the event list will get added to\r
- the pending ready list as the scheduler is still suspended. */\r
- if( listLIST_IS_EMPTY( &( pxQueue->xTasksWaitingToReceive ) ) == pdFALSE )\r
- {\r
- if( xTaskRemoveFromEventList( &( pxQueue->xTasksWaitingToReceive ) ) != pdFALSE )\r
- {\r
- /* The task waiting has a higher priority so record that\r
- a context switch is required. */\r
- vTaskMissedYield();\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- else\r
- {\r
- break;\r
- }\r
- }\r
- #endif /* configUSE_QUEUE_SETS */\r
-\r
- --cTxLock;\r
- }\r
-\r
- pxQueue->cTxLock = queueUNLOCKED;\r
- }\r
- taskEXIT_CRITICAL();\r
-\r
- /* Do the same for the Rx lock. */\r
- taskENTER_CRITICAL();\r
- {\r
- int8_t cRxLock = pxQueue->cRxLock;\r
-\r
- while( cRxLock > queueLOCKED_UNMODIFIED )\r
- {\r
- if( listLIST_IS_EMPTY( &( pxQueue->xTasksWaitingToSend ) ) == pdFALSE )\r
- {\r
- if( xTaskRemoveFromEventList( &( pxQueue->xTasksWaitingToSend ) ) != pdFALSE )\r
- {\r
- vTaskMissedYield();\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
-\r
- --cRxLock;\r
- }\r
- else\r
- {\r
- break;\r
- }\r
- }\r
-\r
- pxQueue->cRxLock = queueUNLOCKED;\r
- }\r
- taskEXIT_CRITICAL();\r
-}\r
-/*-----------------------------------------------------------*/\r
-\r
-static BaseType_t prvIsQueueEmpty( const Queue_t *pxQueue )\r
-{\r
-BaseType_t xReturn;\r
-\r
- taskENTER_CRITICAL();\r
- {\r
- if( pxQueue->uxMessagesWaiting == ( UBaseType_t ) 0 )\r
- {\r
- xReturn = pdTRUE;\r
- }\r
- else\r
- {\r
- xReturn = pdFALSE;\r
- }\r
- }\r
- taskEXIT_CRITICAL();\r
-\r
- return xReturn;\r
-}\r
-/*-----------------------------------------------------------*/\r
-\r
-BaseType_t xQueueIsQueueEmptyFromISR( const QueueHandle_t xQueue )\r
-{\r
-BaseType_t xReturn;\r
-\r
- configASSERT( xQueue );\r
- if( ( ( Queue_t * ) xQueue )->uxMessagesWaiting == ( UBaseType_t ) 0 )\r
- {\r
- xReturn = pdTRUE;\r
- }\r
- else\r
- {\r
- xReturn = pdFALSE;\r
- }\r
-\r
- return xReturn;\r
-} /*lint !e818 xQueue could not be pointer to const because it is a typedef. */\r
-/*-----------------------------------------------------------*/\r
-\r
-static BaseType_t prvIsQueueFull( const Queue_t *pxQueue )\r
-{\r
-BaseType_t xReturn;\r
-\r
- taskENTER_CRITICAL();\r
- {\r
- if( pxQueue->uxMessagesWaiting == pxQueue->uxLength )\r
- {\r
- xReturn = pdTRUE;\r
- }\r
- else\r
- {\r
- xReturn = pdFALSE;\r
- }\r
- }\r
- taskEXIT_CRITICAL();\r
-\r
- return xReturn;\r
-}\r
-/*-----------------------------------------------------------*/\r
-\r
-BaseType_t xQueueIsQueueFullFromISR( const QueueHandle_t xQueue )\r
-{\r
-BaseType_t xReturn;\r
-\r
- configASSERT( xQueue );\r
- if( ( ( Queue_t * ) xQueue )->uxMessagesWaiting == ( ( Queue_t * ) xQueue )->uxLength )\r
- {\r
- xReturn = pdTRUE;\r
- }\r
- else\r
- {\r
- xReturn = pdFALSE;\r
- }\r
-\r
- return xReturn;\r
-} /*lint !e818 xQueue could not be pointer to const because it is a typedef. */\r
-/*-----------------------------------------------------------*/\r
-\r
-#if ( configUSE_CO_ROUTINES == 1 )\r
-\r
- BaseType_t xQueueCRSend( QueueHandle_t xQueue, const void *pvItemToQueue, TickType_t xTicksToWait )\r
- {\r
- BaseType_t xReturn;\r
- Queue_t * const pxQueue = ( Queue_t * ) xQueue;\r
-\r
- /* If the queue is already full we may have to block. A critical section\r
- is required to prevent an interrupt removing something from the queue\r
- between the check to see if the queue is full and blocking on the queue. */\r
- portDISABLE_INTERRUPTS();\r
- {\r
- if( prvIsQueueFull( pxQueue ) != pdFALSE )\r
- {\r
- /* The queue is full - do we want to block or just leave without\r
- posting? */\r
- if( xTicksToWait > ( TickType_t ) 0 )\r
- {\r
- /* As this is called from a coroutine we cannot block directly, but\r
- return indicating that we need to block. */\r
- vCoRoutineAddToDelayedList( xTicksToWait, &( pxQueue->xTasksWaitingToSend ) );\r
- portENABLE_INTERRUPTS();\r
- return errQUEUE_BLOCKED;\r
- }\r
- else\r
- {\r
- portENABLE_INTERRUPTS();\r
- return errQUEUE_FULL;\r
- }\r
- }\r
- }\r
- portENABLE_INTERRUPTS();\r
-\r
- portDISABLE_INTERRUPTS();\r
- {\r
- if( pxQueue->uxMessagesWaiting < pxQueue->uxLength )\r
- {\r
- /* There is room in the queue, copy the data into the queue. */\r
- prvCopyDataToQueue( pxQueue, pvItemToQueue, queueSEND_TO_BACK );\r
- xReturn = pdPASS;\r
-\r
- /* Were any co-routines waiting for data to become available? */\r
- if( listLIST_IS_EMPTY( &( pxQueue->xTasksWaitingToReceive ) ) == pdFALSE )\r
- {\r
- /* In this instance the co-routine could be placed directly\r
- into the ready list as we are within a critical section.\r
- Instead the same pending ready list mechanism is used as if\r
- the event were caused from within an interrupt. */\r
- if( xCoRoutineRemoveFromEventList( &( pxQueue->xTasksWaitingToReceive ) ) != pdFALSE )\r
- {\r
- /* The co-routine waiting has a higher priority so record\r
- that a yield might be appropriate. */\r
- xReturn = errQUEUE_YIELD;\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- else\r
- {\r
- xReturn = errQUEUE_FULL;\r
- }\r
- }\r
- portENABLE_INTERRUPTS();\r
-\r
- return xReturn;\r
- }\r
-\r
-#endif /* configUSE_CO_ROUTINES */\r
-/*-----------------------------------------------------------*/\r
-\r
-#if ( configUSE_CO_ROUTINES == 1 )\r
-\r
- BaseType_t xQueueCRReceive( QueueHandle_t xQueue, void *pvBuffer, TickType_t xTicksToWait )\r
- {\r
- BaseType_t xReturn;\r
- Queue_t * const pxQueue = ( Queue_t * ) xQueue;\r
-\r
- /* If the queue is already empty we may have to block. A critical section\r
- is required to prevent an interrupt adding something to the queue\r
- between the check to see if the queue is empty and blocking on the queue. */\r
- portDISABLE_INTERRUPTS();\r
- {\r
- if( pxQueue->uxMessagesWaiting == ( UBaseType_t ) 0 )\r
- {\r
- /* There are no messages in the queue, do we want to block or just\r
- leave with nothing? */\r
- if( xTicksToWait > ( TickType_t ) 0 )\r
- {\r
- /* As this is a co-routine we cannot block directly, but return\r
- indicating that we need to block. */\r
- vCoRoutineAddToDelayedList( xTicksToWait, &( pxQueue->xTasksWaitingToReceive ) );\r
- portENABLE_INTERRUPTS();\r
- return errQUEUE_BLOCKED;\r
- }\r
- else\r
- {\r
- portENABLE_INTERRUPTS();\r
- return errQUEUE_FULL;\r
- }\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- portENABLE_INTERRUPTS();\r
-\r
- portDISABLE_INTERRUPTS();\r
- {\r
- if( pxQueue->uxMessagesWaiting > ( UBaseType_t ) 0 )\r
- {\r
- /* Data is available from the queue. */\r
- pxQueue->u.pcReadFrom += pxQueue->uxItemSize;\r
- if( pxQueue->u.pcReadFrom >= pxQueue->pcTail )\r
- {\r
- pxQueue->u.pcReadFrom = pxQueue->pcHead;\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- --( pxQueue->uxMessagesWaiting );\r
- ( void ) memcpy( ( void * ) pvBuffer, ( void * ) pxQueue->u.pcReadFrom, ( unsigned ) pxQueue->uxItemSize );\r
-\r
- xReturn = pdPASS;\r
-\r
- /* Were any co-routines waiting for space to become available? */\r
- if( listLIST_IS_EMPTY( &( pxQueue->xTasksWaitingToSend ) ) == pdFALSE )\r
- {\r
- /* In this instance the co-routine could be placed directly\r
- into the ready list as we are within a critical section.\r
- Instead the same pending ready list mechanism is used as if\r
- the event were caused from within an interrupt. */\r
- if( xCoRoutineRemoveFromEventList( &( pxQueue->xTasksWaitingToSend ) ) != pdFALSE )\r
- {\r
- xReturn = errQUEUE_YIELD;\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- else\r
- {\r
- xReturn = pdFAIL;\r
- }\r
- }\r
- portENABLE_INTERRUPTS();\r
-\r
- return xReturn;\r
- }\r
-\r
-#endif /* configUSE_CO_ROUTINES */\r
-/*-----------------------------------------------------------*/\r
-\r
-#if ( configUSE_CO_ROUTINES == 1 )\r
-\r
- BaseType_t xQueueCRSendFromISR( QueueHandle_t xQueue, const void *pvItemToQueue, BaseType_t xCoRoutinePreviouslyWoken )\r
- {\r
- Queue_t * const pxQueue = ( Queue_t * ) xQueue;\r
-\r
- /* Cannot block within an ISR so if there is no space on the queue then\r
- exit without doing anything. */\r
- if( pxQueue->uxMessagesWaiting < pxQueue->uxLength )\r
- {\r
- prvCopyDataToQueue( pxQueue, pvItemToQueue, queueSEND_TO_BACK );\r
-\r
- /* We only want to wake one co-routine per ISR, so check that a\r
- co-routine has not already been woken. */\r
- if( xCoRoutinePreviouslyWoken == pdFALSE )\r
- {\r
- if( listLIST_IS_EMPTY( &( pxQueue->xTasksWaitingToReceive ) ) == pdFALSE )\r
- {\r
- if( xCoRoutineRemoveFromEventList( &( pxQueue->xTasksWaitingToReceive ) ) != pdFALSE )\r
- {\r
- return pdTRUE;\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
-\r
- return xCoRoutinePreviouslyWoken;\r
- }\r
-\r
-#endif /* configUSE_CO_ROUTINES */\r
-/*-----------------------------------------------------------*/\r
-\r
-#if ( configUSE_CO_ROUTINES == 1 )\r
-\r
- BaseType_t xQueueCRReceiveFromISR( QueueHandle_t xQueue, void *pvBuffer, BaseType_t *pxCoRoutineWoken )\r
- {\r
- BaseType_t xReturn;\r
- Queue_t * const pxQueue = ( Queue_t * ) xQueue;\r
-\r
- /* We cannot block from an ISR, so check there is data available. If\r
- not then just leave without doing anything. */\r
- if( pxQueue->uxMessagesWaiting > ( UBaseType_t ) 0 )\r
- {\r
- /* Copy the data from the queue. */\r
- pxQueue->u.pcReadFrom += pxQueue->uxItemSize;\r
- if( pxQueue->u.pcReadFrom >= pxQueue->pcTail )\r
- {\r
- pxQueue->u.pcReadFrom = pxQueue->pcHead;\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- --( pxQueue->uxMessagesWaiting );\r
- ( void ) memcpy( ( void * ) pvBuffer, ( void * ) pxQueue->u.pcReadFrom, ( unsigned ) pxQueue->uxItemSize );\r
-\r
- if( ( *pxCoRoutineWoken ) == pdFALSE )\r
- {\r
- if( listLIST_IS_EMPTY( &( pxQueue->xTasksWaitingToSend ) ) == pdFALSE )\r
- {\r
- if( xCoRoutineRemoveFromEventList( &( pxQueue->xTasksWaitingToSend ) ) != pdFALSE )\r
- {\r
- *pxCoRoutineWoken = pdTRUE;\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
-\r
- xReturn = pdPASS;\r
- }\r
- else\r
- {\r
- xReturn = pdFAIL;\r
- }\r
-\r
- return xReturn;\r
- }\r
-\r
-#endif /* configUSE_CO_ROUTINES */\r
-/*-----------------------------------------------------------*/\r
-\r
-#if ( configQUEUE_REGISTRY_SIZE > 0 )\r
-\r
- void vQueueAddToRegistry( QueueHandle_t xQueue, const char *pcQueueName ) /*lint !e971 Unqualified char types are allowed for strings and single characters only. */\r
- {\r
- UBaseType_t ux;\r
-\r
- /* See if there is an empty space in the registry. A NULL name denotes\r
- a free slot. */\r
- for( ux = ( UBaseType_t ) 0U; ux < ( UBaseType_t ) configQUEUE_REGISTRY_SIZE; ux++ )\r
- {\r
- if( xQueueRegistry[ ux ].pcQueueName == NULL )\r
- {\r
- /* Store the information on this queue. */\r
- xQueueRegistry[ ux ].pcQueueName = pcQueueName;\r
- xQueueRegistry[ ux ].xHandle = xQueue;\r
-\r
- traceQUEUE_REGISTRY_ADD( xQueue, pcQueueName );\r
- break;\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- }\r
-\r
-#endif /* configQUEUE_REGISTRY_SIZE */\r
-/*-----------------------------------------------------------*/\r
-\r
-#if ( configQUEUE_REGISTRY_SIZE > 0 )\r
-\r
- const char *pcQueueGetName( QueueHandle_t xQueue ) /*lint !e971 Unqualified char types are allowed for strings and single characters only. */\r
- {\r
- UBaseType_t ux;\r
- const char *pcReturn = NULL; /*lint !e971 Unqualified char types are allowed for strings and single characters only. */\r
-\r
- /* Note there is nothing here to protect against another task adding or\r
- removing entries from the registry while it is being searched. */\r
- for( ux = ( UBaseType_t ) 0U; ux < ( UBaseType_t ) configQUEUE_REGISTRY_SIZE; ux++ )\r
- {\r
- if( xQueueRegistry[ ux ].xHandle == xQueue )\r
- {\r
- pcReturn = xQueueRegistry[ ux ].pcQueueName;\r
- break;\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
-\r
- return pcReturn;\r
- } /*lint !e818 xQueue cannot be a pointer to const because it is a typedef. */\r
-\r
-#endif /* configQUEUE_REGISTRY_SIZE */\r
-/*-----------------------------------------------------------*/\r
-\r
-#if ( configQUEUE_REGISTRY_SIZE > 0 )\r
-\r
- void vQueueUnregisterQueue( QueueHandle_t xQueue )\r
- {\r
- UBaseType_t ux;\r
-\r
- /* See if the handle of the queue being unregistered in actually in the\r
- registry. */\r
- for( ux = ( UBaseType_t ) 0U; ux < ( UBaseType_t ) configQUEUE_REGISTRY_SIZE; ux++ )\r
- {\r
- if( xQueueRegistry[ ux ].xHandle == xQueue )\r
- {\r
- /* Set the name to NULL to show that this slot if free again. */\r
- xQueueRegistry[ ux ].pcQueueName = NULL;\r
-\r
- /* Set the handle to NULL to ensure the same queue handle cannot\r
- appear in the registry twice if it is added, removed, then\r
- added again. */\r
- xQueueRegistry[ ux ].xHandle = ( QueueHandle_t ) 0;\r
- break;\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
-\r
- } /*lint !e818 xQueue could not be pointer to const because it is a typedef. */\r
-\r
-#endif /* configQUEUE_REGISTRY_SIZE */\r
-/*-----------------------------------------------------------*/\r
-\r
-#if ( configUSE_TIMERS == 1 )\r
-\r
- void vQueueWaitForMessageRestricted( QueueHandle_t xQueue, TickType_t xTicksToWait, const BaseType_t xWaitIndefinitely )\r
- {\r
- Queue_t * const pxQueue = ( Queue_t * ) xQueue;\r
-\r
- /* This function should not be called by application code hence the\r
- 'Restricted' in its name. It is not part of the public API. It is\r
- designed for use by kernel code, and has special calling requirements.\r
- It can result in vListInsert() being called on a list that can only\r
- possibly ever have one item in it, so the list will be fast, but even\r
- so it should be called with the scheduler locked and not from a critical\r
- section. */\r
-\r
- /* Only do anything if there are no messages in the queue. This function\r
- will not actually cause the task to block, just place it on a blocked\r
- list. It will not block until the scheduler is unlocked - at which\r
- time a yield will be performed. If an item is added to the queue while\r
- the queue is locked, and the calling task blocks on the queue, then the\r
- calling task will be immediately unblocked when the queue is unlocked. */\r
- prvLockQueue( pxQueue );\r
- if( pxQueue->uxMessagesWaiting == ( UBaseType_t ) 0U )\r
- {\r
- /* There is nothing in the queue, block for the specified period. */\r
- vTaskPlaceOnEventListRestricted( &( pxQueue->xTasksWaitingToReceive ), xTicksToWait, xWaitIndefinitely );\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- prvUnlockQueue( pxQueue );\r
- }\r
-\r
-#endif /* configUSE_TIMERS */\r
-/*-----------------------------------------------------------*/\r
-\r
-#if( ( configUSE_QUEUE_SETS == 1 ) && ( configSUPPORT_DYNAMIC_ALLOCATION == 1 ) )\r
-\r
- QueueSetHandle_t xQueueCreateSet( const UBaseType_t uxEventQueueLength )\r
- {\r
- QueueSetHandle_t pxQueue;\r
-\r
- pxQueue = xQueueGenericCreate( uxEventQueueLength, ( UBaseType_t ) sizeof( Queue_t * ), queueQUEUE_TYPE_SET );\r
-\r
- return pxQueue;\r
- }\r
-\r
-#endif /* configUSE_QUEUE_SETS */\r
-/*-----------------------------------------------------------*/\r
-\r
-#if ( configUSE_QUEUE_SETS == 1 )\r
-\r
- BaseType_t xQueueAddToSet( QueueSetMemberHandle_t xQueueOrSemaphore, QueueSetHandle_t xQueueSet )\r
- {\r
- BaseType_t xReturn;\r
-\r
- taskENTER_CRITICAL();\r
- {\r
- if( ( ( Queue_t * ) xQueueOrSemaphore )->pxQueueSetContainer != NULL )\r
- {\r
- /* Cannot add a queue/semaphore to more than one queue set. */\r
- xReturn = pdFAIL;\r
- }\r
- else if( ( ( Queue_t * ) xQueueOrSemaphore )->uxMessagesWaiting != ( UBaseType_t ) 0 )\r
- {\r
- /* Cannot add a queue/semaphore to a queue set if there are already\r
- items in the queue/semaphore. */\r
- xReturn = pdFAIL;\r
- }\r
- else\r
- {\r
- ( ( Queue_t * ) xQueueOrSemaphore )->pxQueueSetContainer = xQueueSet;\r
- xReturn = pdPASS;\r
- }\r
- }\r
- taskEXIT_CRITICAL();\r
-\r
- return xReturn;\r
- }\r
-\r
-#endif /* configUSE_QUEUE_SETS */\r
-/*-----------------------------------------------------------*/\r
-\r
-#if ( configUSE_QUEUE_SETS == 1 )\r
-\r
- BaseType_t xQueueRemoveFromSet( QueueSetMemberHandle_t xQueueOrSemaphore, QueueSetHandle_t xQueueSet )\r
- {\r
- BaseType_t xReturn;\r
- Queue_t * const pxQueueOrSemaphore = ( Queue_t * ) xQueueOrSemaphore;\r
-\r
- if( pxQueueOrSemaphore->pxQueueSetContainer != xQueueSet )\r
- {\r
- /* The queue was not a member of the set. */\r
- xReturn = pdFAIL;\r
- }\r
- else if( pxQueueOrSemaphore->uxMessagesWaiting != ( UBaseType_t ) 0 )\r
- {\r
- /* It is dangerous to remove a queue from a set when the queue is\r
- not empty because the queue set will still hold pending events for\r
- the queue. */\r
- xReturn = pdFAIL;\r
- }\r
- else\r
- {\r
- taskENTER_CRITICAL();\r
- {\r
- /* The queue is no longer contained in the set. */\r
- pxQueueOrSemaphore->pxQueueSetContainer = NULL;\r
- }\r
- taskEXIT_CRITICAL();\r
- xReturn = pdPASS;\r
- }\r
-\r
- return xReturn;\r
- } /*lint !e818 xQueueSet could not be declared as pointing to const as it is a typedef. */\r
-\r
-#endif /* configUSE_QUEUE_SETS */\r
-/*-----------------------------------------------------------*/\r
-\r
-#if ( configUSE_QUEUE_SETS == 1 )\r
-\r
- QueueSetMemberHandle_t xQueueSelectFromSet( QueueSetHandle_t xQueueSet, TickType_t const xTicksToWait )\r
- {\r
- QueueSetMemberHandle_t xReturn = NULL;\r
-\r
- ( void ) xQueueReceive( ( QueueHandle_t ) xQueueSet, &xReturn, xTicksToWait ); /*lint !e961 Casting from one typedef to another is not redundant. */\r
- return xReturn;\r
- }\r
-\r
-#endif /* configUSE_QUEUE_SETS */\r
-/*-----------------------------------------------------------*/\r
-\r
-#if ( configUSE_QUEUE_SETS == 1 )\r
-\r
- QueueSetMemberHandle_t xQueueSelectFromSetFromISR( QueueSetHandle_t xQueueSet )\r
- {\r
- QueueSetMemberHandle_t xReturn = NULL;\r
-\r
- ( void ) xQueueReceiveFromISR( ( QueueHandle_t ) xQueueSet, &xReturn, NULL ); /*lint !e961 Casting from one typedef to another is not redundant. */\r
- return xReturn;\r
- }\r
-\r
-#endif /* configUSE_QUEUE_SETS */\r
-/*-----------------------------------------------------------*/\r
-\r
-#if ( configUSE_QUEUE_SETS == 1 )\r
-\r
- static BaseType_t prvNotifyQueueSetContainer( const Queue_t * const pxQueue, const BaseType_t xCopyPosition )\r
- {\r
- Queue_t *pxQueueSetContainer = pxQueue->pxQueueSetContainer;\r
- BaseType_t xReturn = pdFALSE;\r
-\r
- /* This function must be called form a critical section. */\r
-\r
- configASSERT( pxQueueSetContainer );\r
- configASSERT( pxQueueSetContainer->uxMessagesWaiting < pxQueueSetContainer->uxLength );\r
-\r
- if( pxQueueSetContainer->uxMessagesWaiting < pxQueueSetContainer->uxLength )\r
- {\r
- const int8_t cTxLock = pxQueueSetContainer->cTxLock;\r
-\r
- traceQUEUE_SEND( pxQueueSetContainer );\r
-\r
- /* The data copied is the handle of the queue that contains data. */\r
- xReturn = prvCopyDataToQueue( pxQueueSetContainer, &pxQueue, xCopyPosition );\r
-\r
- if( cTxLock == queueUNLOCKED )\r
- {\r
- if( listLIST_IS_EMPTY( &( pxQueueSetContainer->xTasksWaitingToReceive ) ) == pdFALSE )\r
- {\r
- if( xTaskRemoveFromEventList( &( pxQueueSetContainer->xTasksWaitingToReceive ) ) != pdFALSE )\r
- {\r
- /* The task waiting has a higher priority. */\r
- xReturn = pdTRUE;\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- else\r
- {\r
- pxQueueSetContainer->cTxLock = ( int8_t ) ( cTxLock + 1 );\r
- }\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
-\r
- return xReturn;\r
- }\r
-\r
-#endif /* configUSE_QUEUE_SETS */\r
-\r
-\r
-\r
-\r
-\r
-\r
-\r
-\r
-\r
-\r
-\r
-\r
+++ /dev/null
-/*\r
- * FreeRTOS Kernel V10.0.1\r
- * Copyright (C) 2017 Amazon.com, Inc. or its affiliates. All Rights Reserved.\r
- *\r
- * Permission is hereby granted, free of charge, to any person obtaining a copy of\r
- * this software and associated documentation files (the "Software"), to deal in\r
- * the Software without restriction, including without limitation the rights to\r
- * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of\r
- * the Software, and to permit persons to whom the Software is furnished to do so,\r
- * subject to the following conditions:\r
- *\r
- * The above copyright notice and this permission notice shall be included in all\r
- * copies or substantial portions of the Software.\r
- *\r
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\r
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS\r
- * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR\r
- * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER\r
- * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN\r
- * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\r
- *\r
- * http://www.FreeRTOS.org\r
- * http://aws.amazon.com/freertos\r
- *\r
- * 1 tab == 4 spaces!\r
- */\r
-\r
-/* Standard includes. */\r
-#include <stdint.h>\r
-#include <string.h>\r
-\r
-/* Defining MPU_WRAPPERS_INCLUDED_FROM_API_FILE prevents task.h from redefining\r
-all the API functions to use the MPU wrappers. That should only be done when\r
-task.h is included from an application file. */\r
-#define MPU_WRAPPERS_INCLUDED_FROM_API_FILE\r
-\r
-/* FreeRTOS includes. */\r
-#include "FreeRTOS.h"\r
-#include "task.h"\r
-#include "stream_buffer.h"\r
-\r
-#if( configUSE_TASK_NOTIFICATIONS != 1 )\r
- #error configUSE_TASK_NOTIFICATIONS must be set to 1 to build stream_buffer.c\r
-#endif\r
-\r
-/* Lint e961 and e750 are suppressed as a MISRA exception justified because the\r
-MPU ports require MPU_WRAPPERS_INCLUDED_FROM_API_FILE to be defined for the\r
-header files above, but not in this file, in order to generate the correct\r
-privileged Vs unprivileged linkage and placement. */\r
-#undef MPU_WRAPPERS_INCLUDED_FROM_API_FILE /*lint !e961 !e750. */\r
-\r
-/* If the user has not provided application specific Rx notification macros,\r
-or #defined the notification macros away, them provide default implementations\r
-that uses task notifications. */\r
-/*lint -save -e9026 Function like macros allowed and needed here so they can be overidden. */\r
-#ifndef sbRECEIVE_COMPLETED\r
- #define sbRECEIVE_COMPLETED( pxStreamBuffer ) \\r
- vTaskSuspendAll(); \\r
- { \\r
- if( ( pxStreamBuffer )->xTaskWaitingToSend != NULL ) \\r
- { \\r
- ( void ) xTaskNotify( ( pxStreamBuffer )->xTaskWaitingToSend, \\r
- ( uint32_t ) 0, \\r
- eNoAction ); \\r
- ( pxStreamBuffer )->xTaskWaitingToSend = NULL; \\r
- } \\r
- } \\r
- ( void ) xTaskResumeAll();\r
-#endif /* sbRECEIVE_COMPLETED */\r
-\r
-#ifndef sbRECEIVE_COMPLETED_FROM_ISR\r
- #define sbRECEIVE_COMPLETED_FROM_ISR( pxStreamBuffer, \\r
- pxHigherPriorityTaskWoken ) \\r
- { \\r
- UBaseType_t uxSavedInterruptStatus; \\r
- \\r
- uxSavedInterruptStatus = ( UBaseType_t ) portSET_INTERRUPT_MASK_FROM_ISR(); \\r
- { \\r
- if( ( pxStreamBuffer )->xTaskWaitingToSend != NULL ) \\r
- { \\r
- ( void ) xTaskNotifyFromISR( ( pxStreamBuffer )->xTaskWaitingToSend, \\r
- ( uint32_t ) 0, \\r
- eNoAction, \\r
- pxHigherPriorityTaskWoken ); \\r
- ( pxStreamBuffer )->xTaskWaitingToSend = NULL; \\r
- } \\r
- } \\r
- portCLEAR_INTERRUPT_MASK_FROM_ISR( uxSavedInterruptStatus ); \\r
- }\r
-#endif /* sbRECEIVE_COMPLETED_FROM_ISR */\r
-\r
-/* If the user has not provided an application specific Tx notification macro,\r
-or #defined the notification macro away, them provide a default implementation\r
-that uses task notifications. */\r
-#ifndef sbSEND_COMPLETED\r
- #define sbSEND_COMPLETED( pxStreamBuffer ) \\r
- vTaskSuspendAll(); \\r
- { \\r
- if( ( pxStreamBuffer )->xTaskWaitingToReceive != NULL ) \\r
- { \\r
- ( void ) xTaskNotify( ( pxStreamBuffer )->xTaskWaitingToReceive, \\r
- ( uint32_t ) 0, \\r
- eNoAction ); \\r
- ( pxStreamBuffer )->xTaskWaitingToReceive = NULL; \\r
- } \\r
- } \\r
- ( void ) xTaskResumeAll();\r
-#endif /* sbSEND_COMPLETED */\r
-\r
-#ifndef sbSEND_COMPLETE_FROM_ISR\r
- #define sbSEND_COMPLETE_FROM_ISR( pxStreamBuffer, pxHigherPriorityTaskWoken ) \\r
- { \\r
- UBaseType_t uxSavedInterruptStatus; \\r
- \\r
- uxSavedInterruptStatus = ( UBaseType_t ) portSET_INTERRUPT_MASK_FROM_ISR(); \\r
- { \\r
- if( ( pxStreamBuffer )->xTaskWaitingToReceive != NULL ) \\r
- { \\r
- ( void ) xTaskNotifyFromISR( ( pxStreamBuffer )->xTaskWaitingToReceive, \\r
- ( uint32_t ) 0, \\r
- eNoAction, \\r
- pxHigherPriorityTaskWoken ); \\r
- ( pxStreamBuffer )->xTaskWaitingToReceive = NULL; \\r
- } \\r
- } \\r
- portCLEAR_INTERRUPT_MASK_FROM_ISR( uxSavedInterruptStatus ); \\r
- }\r
-#endif /* sbSEND_COMPLETE_FROM_ISR */\r
-/*lint -restore (9026) */\r
-\r
-/* The number of bytes used to hold the length of a message in the buffer. */\r
-#define sbBYTES_TO_STORE_MESSAGE_LENGTH ( sizeof( size_t ) )\r
-\r
-/* Bits stored in the ucFlags field of the stream buffer. */\r
-#define sbFLAGS_IS_MESSAGE_BUFFER ( ( uint8_t ) 1 ) /* Set if the stream buffer was created as a message buffer, in which case it holds discrete messages rather than a stream. */\r
-#define sbFLAGS_IS_STATICALLY_ALLOCATED ( ( uint8_t ) 2 ) /* Set if the stream buffer was created using statically allocated memory. */\r
-\r
-/*-----------------------------------------------------------*/\r
-\r
-/* Structure that hold state information on the buffer. */\r
-typedef struct xSTREAM_BUFFER /*lint !e9058 Style convention uses tag. */\r
-{\r
- volatile size_t xTail; /* Index to the next item to read within the buffer. */\r
- volatile size_t xHead; /* Index to the next item to write within the buffer. */\r
- size_t xLength; /* The length of the buffer pointed to by pucBuffer. */\r
- size_t xTriggerLevelBytes; /* The number of bytes that must be in the stream buffer before a task that is waiting for data is unblocked. */\r
- volatile TaskHandle_t xTaskWaitingToReceive; /* Holds the handle of a task waiting for data, or NULL if no tasks are waiting. */\r
- volatile TaskHandle_t xTaskWaitingToSend; /* Holds the handle of a task waiting to send data to a message buffer that is full. */\r
- uint8_t *pucBuffer; /* Points to the buffer itself - that is - the RAM that stores the data passed through the buffer. */\r
- uint8_t ucFlags;\r
-\r
- #if ( configUSE_TRACE_FACILITY == 1 )\r
- UBaseType_t uxStreamBufferNumber; /* Used for tracing purposes. */\r
- #endif\r
-} StreamBuffer_t;\r
-\r
-/*\r
- * The number of bytes available to be read from the buffer.\r
- */\r
-static size_t prvBytesInBuffer( const StreamBuffer_t * const pxStreamBuffer ) PRIVILEGED_FUNCTION;\r
-\r
-/*\r
- * Add xCount bytes from pucData into the pxStreamBuffer message buffer.\r
- * Returns the number of bytes written, which will either equal xCount in the\r
- * success case, or 0 if there was not enough space in the buffer (in which case\r
- * no data is written into the buffer).\r
- */\r
-static size_t prvWriteBytesToBuffer( StreamBuffer_t * const pxStreamBuffer, const uint8_t *pucData, size_t xCount ) PRIVILEGED_FUNCTION;\r
-\r
-/*\r
- * If the stream buffer is being used as a message buffer, then reads an entire\r
- * message out of the buffer. If the stream buffer is being used as a stream\r
- * buffer then read as many bytes as possible from the buffer.\r
- * prvReadBytesFromBuffer() is called to actually extract the bytes from the\r
- * buffer's data storage area.\r
- */\r
-static size_t prvReadMessageFromBuffer( StreamBuffer_t *pxStreamBuffer,\r
- void *pvRxData,\r
- size_t xBufferLengthBytes,\r
- size_t xBytesAvailable,\r
- size_t xBytesToStoreMessageLength ) PRIVILEGED_FUNCTION;\r
-\r
-/*\r
- * If the stream buffer is being used as a message buffer, then writes an entire\r
- * message to the buffer. If the stream buffer is being used as a stream\r
- * buffer then write as many bytes as possible to the buffer.\r
- * prvWriteBytestoBuffer() is called to actually send the bytes to the buffer's\r
- * data storage area.\r
- */\r
-static size_t prvWriteMessageToBuffer( StreamBuffer_t * const pxStreamBuffer,\r
- const void * pvTxData,\r
- size_t xDataLengthBytes,\r
- size_t xSpace,\r
- size_t xRequiredSpace ) PRIVILEGED_FUNCTION;\r
-\r
-/*\r
- * Read xMaxCount bytes from the pxStreamBuffer message buffer and write them\r
- * to pucData.\r
- */\r
-static size_t prvReadBytesFromBuffer( StreamBuffer_t *pxStreamBuffer,\r
- uint8_t *pucData,\r
- size_t xMaxCount,\r
- size_t xBytesAvailable ); PRIVILEGED_FUNCTION\r
-\r
-/*\r
- * Called by both pxStreamBufferCreate() and pxStreamBufferCreateStatic() to\r
- * initialise the members of the newly created stream buffer structure.\r
- */\r
-static void prvInitialiseNewStreamBuffer( StreamBuffer_t * const pxStreamBuffer,\r
- uint8_t * const pucBuffer,\r
- size_t xBufferSizeBytes,\r
- size_t xTriggerLevelBytes,\r
- BaseType_t xIsMessageBuffer ) PRIVILEGED_FUNCTION;\r
-\r
-/*-----------------------------------------------------------*/\r
-\r
-#if( configSUPPORT_DYNAMIC_ALLOCATION == 1 )\r
-\r
- StreamBufferHandle_t xStreamBufferGenericCreate( size_t xBufferSizeBytes, size_t xTriggerLevelBytes, BaseType_t xIsMessageBuffer )\r
- {\r
- uint8_t *pucAllocatedMemory;\r
-\r
- /* In case the stream buffer is going to be used as a message buffer\r
- (that is, it will hold discrete messages with a little meta data that\r
- says how big the next message is) check the buffer will be large enough\r
- to hold at least one message. */\r
- configASSERT( xBufferSizeBytes > sbBYTES_TO_STORE_MESSAGE_LENGTH );\r
- configASSERT( xTriggerLevelBytes <= xBufferSizeBytes );\r
-\r
- /* A trigger level of 0 would cause a waiting task to unblock even when\r
- the buffer was empty. */\r
- if( xTriggerLevelBytes == ( size_t ) 0 )\r
- {\r
- xTriggerLevelBytes = ( size_t ) 1; /*lint !e9044 Parameter modified to ensure it doesn't have a dangerous value. */\r
- }\r
-\r
- /* A stream buffer requires a StreamBuffer_t structure and a buffer.\r
- Both are allocated in a single call to pvPortMalloc(). The\r
- StreamBuffer_t structure is placed at the start of the allocated memory\r
- and the buffer follows immediately after. The requested size is\r
- incremented so the free space is returned as the user would expect -\r
- this is a quirk of the implementation that means otherwise the free\r
- space would be reported as one byte smaller than would be logically\r
- expected. */\r
- xBufferSizeBytes++;\r
- pucAllocatedMemory = ( uint8_t * ) pvPortMalloc( xBufferSizeBytes + sizeof( StreamBuffer_t ) ); /*lint !e9079 malloc() only returns void*. */\r
-\r
- if( pucAllocatedMemory != NULL )\r
- {\r
- prvInitialiseNewStreamBuffer( ( StreamBuffer_t * ) pucAllocatedMemory, /* Structure at the start of the allocated memory. */ /*lint !e9087 Safe cast as allocated memory is aligned. */ /*lint !e826 Area is not too small and alignment is guaranteed provided malloc() behaves as expected and returns aligned buffer. */\r
- pucAllocatedMemory + sizeof( StreamBuffer_t ), /* Storage area follows. */ /*lint !e9016 Indexing past structure valid for uint8_t pointer, also storage area has no alignment requirement. */\r
- xBufferSizeBytes,\r
- xTriggerLevelBytes,\r
- xIsMessageBuffer );\r
-\r
- traceSTREAM_BUFFER_CREATE( ( ( StreamBuffer_t * ) pucAllocatedMemory ), xIsMessageBuffer );\r
- }\r
- else\r
- {\r
- traceSTREAM_BUFFER_CREATE_FAILED( xIsMessageBuffer );\r
- }\r
-\r
- return ( StreamBufferHandle_t * ) pucAllocatedMemory; /*lint !e9087 !e826 Safe cast as allocated memory is aligned. */\r
- }\r
-\r
-#endif /* configSUPPORT_DYNAMIC_ALLOCATION */\r
-/*-----------------------------------------------------------*/\r
-\r
-#if( configSUPPORT_STATIC_ALLOCATION == 1 )\r
-\r
- StreamBufferHandle_t xStreamBufferGenericCreateStatic( size_t xBufferSizeBytes,\r
- size_t xTriggerLevelBytes,\r
- BaseType_t xIsMessageBuffer,\r
- uint8_t * const pucStreamBufferStorageArea,\r
- StaticStreamBuffer_t * const pxStaticStreamBuffer )\r
- {\r
- StreamBuffer_t * const pxStreamBuffer = ( StreamBuffer_t * ) pxStaticStreamBuffer; /*lint !e740 !e9087 Safe cast as StaticStreamBuffer_t is opaque Streambuffer_t. */\r
- StreamBufferHandle_t xReturn;\r
-\r
- configASSERT( pucStreamBufferStorageArea );\r
- configASSERT( pxStaticStreamBuffer );\r
- configASSERT( xTriggerLevelBytes <= xBufferSizeBytes );\r
-\r
- /* A trigger level of 0 would cause a waiting task to unblock even when\r
- the buffer was empty. */\r
- if( xTriggerLevelBytes == ( size_t ) 0 )\r
- {\r
- xTriggerLevelBytes = ( size_t ) 1; /*lint !e9044 Function parameter deliberately modified to ensure it is in range. */\r
- }\r
-\r
- /* In case the stream buffer is going to be used as a message buffer\r
- (that is, it will hold discrete messages with a little meta data that\r
- says how big the next message is) check the buffer will be large enough\r
- to hold at least one message. */\r
- configASSERT( xBufferSizeBytes > sbBYTES_TO_STORE_MESSAGE_LENGTH );\r
-\r
- #if( configASSERT_DEFINED == 1 )\r
- {\r
- /* Sanity check that the size of the structure used to declare a\r
- variable of type StaticStreamBuffer_t equals the size of the real\r
- message buffer structure. */\r
- volatile size_t xSize = sizeof( StaticStreamBuffer_t );\r
- configASSERT( xSize == sizeof( StreamBuffer_t ) );\r
- }\r
- #endif /* configASSERT_DEFINED */\r
-\r
- if( ( pucStreamBufferStorageArea != NULL ) && ( pxStaticStreamBuffer != NULL ) )\r
- {\r
- prvInitialiseNewStreamBuffer( pxStreamBuffer,\r
- pucStreamBufferStorageArea,\r
- xBufferSizeBytes,\r
- xTriggerLevelBytes,\r
- xIsMessageBuffer );\r
-\r
- /* Remember this was statically allocated in case it is ever deleted\r
- again. */\r
- pxStreamBuffer->ucFlags |= sbFLAGS_IS_STATICALLY_ALLOCATED;\r
-\r
- traceSTREAM_BUFFER_CREATE( pxStreamBuffer, xIsMessageBuffer );\r
-\r
- xReturn = ( StreamBufferHandle_t ) pxStaticStreamBuffer; /*lint !e9087 Data hiding requires cast to opaque type. */\r
- }\r
- else\r
- {\r
- xReturn = NULL;\r
- traceSTREAM_BUFFER_CREATE_STATIC_FAILED( xReturn, xIsMessageBuffer );\r
- }\r
-\r
- return xReturn;\r
- }\r
-\r
-#endif /* ( configSUPPORT_STATIC_ALLOCATION == 1 ) */\r
-/*-----------------------------------------------------------*/\r
-\r
-void vStreamBufferDelete( StreamBufferHandle_t xStreamBuffer )\r
-{\r
-StreamBuffer_t * pxStreamBuffer = ( StreamBuffer_t * ) xStreamBuffer; /*lint !e9087 !e9079 Safe cast as StreamBufferHandle_t is opaque Streambuffer_t. */\r
-\r
- configASSERT( pxStreamBuffer );\r
-\r
- traceSTREAM_BUFFER_DELETE( xStreamBuffer );\r
-\r
- if( ( pxStreamBuffer->ucFlags & sbFLAGS_IS_STATICALLY_ALLOCATED ) == ( uint8_t ) pdFALSE )\r
- {\r
- #if( configSUPPORT_DYNAMIC_ALLOCATION == 1 )\r
- {\r
- /* Both the structure and the buffer were allocated using a single call\r
- to pvPortMalloc(), hence only one call to vPortFree() is required. */\r
- vPortFree( ( void * ) pxStreamBuffer ); /*lint !e9087 Standard free() semantics require void *, plus pxStreamBuffer was allocated by pvPortMalloc(). */\r
- }\r
- #else\r
- {\r
- /* Should not be possible to get here, ucFlags must be corrupt.\r
- Force an assert. */\r
- configASSERT( xStreamBuffer == ( StreamBufferHandle_t ) ~0 );\r
- }\r
- #endif\r
- }\r
- else\r
- {\r
- /* The structure and buffer were not allocated dynamically and cannot be\r
- freed - just scrub the structure so future use will assert. */\r
- memset( pxStreamBuffer, 0x00, sizeof( StreamBuffer_t ) );\r
- }\r
-}\r
-/*-----------------------------------------------------------*/\r
-\r
-BaseType_t xStreamBufferReset( StreamBufferHandle_t xStreamBuffer )\r
-{\r
-StreamBuffer_t * const pxStreamBuffer = ( StreamBuffer_t * ) xStreamBuffer; /*lint !e9087 !e9079 Safe cast as StreamBufferHandle_t is opaque Streambuffer_t. */\r
-BaseType_t xReturn = pdFAIL, xIsMessageBuffer;\r
-\r
-#if( configUSE_TRACE_FACILITY == 1 )\r
- UBaseType_t uxStreamBufferNumber;\r
-#endif\r
-\r
- configASSERT( pxStreamBuffer );\r
-\r
- #if( configUSE_TRACE_FACILITY == 1 )\r
- {\r
- /* Store the stream buffer number so it can be restored after the\r
- reset. */\r
- uxStreamBufferNumber = pxStreamBuffer->uxStreamBufferNumber;\r
- }\r
- #endif\r
-\r
- /* Can only reset a message buffer if there are no tasks blocked on it. */\r
- if( pxStreamBuffer->xTaskWaitingToReceive == NULL )\r
- {\r
- if( pxStreamBuffer->xTaskWaitingToSend == NULL )\r
- {\r
- if( ( pxStreamBuffer->ucFlags & sbFLAGS_IS_MESSAGE_BUFFER ) != ( uint8_t ) 0 )\r
- {\r
- xIsMessageBuffer = pdTRUE;\r
- }\r
- else\r
- {\r
- xIsMessageBuffer = pdFALSE;\r
- }\r
-\r
- prvInitialiseNewStreamBuffer( pxStreamBuffer,\r
- pxStreamBuffer->pucBuffer,\r
- pxStreamBuffer->xLength,\r
- pxStreamBuffer->xTriggerLevelBytes,\r
- xIsMessageBuffer );\r
- xReturn = pdPASS;\r
-\r
- #if( configUSE_TRACE_FACILITY == 1 )\r
- {\r
- pxStreamBuffer->uxStreamBufferNumber = uxStreamBufferNumber;\r
- }\r
- #endif\r
-\r
- traceSTREAM_BUFFER_RESET( xStreamBuffer );\r
- }\r
- }\r
-\r
- return xReturn;\r
-}\r
-/*-----------------------------------------------------------*/\r
-\r
-BaseType_t xStreamBufferSetTriggerLevel( StreamBufferHandle_t xStreamBuffer, size_t xTriggerLevel )\r
-{\r
-StreamBuffer_t * const pxStreamBuffer = ( StreamBuffer_t * ) xStreamBuffer; /*lint !e9087 !e9079 Safe cast as StreamBufferHandle_t is opaque Streambuffer_t. */\r
-BaseType_t xReturn;\r
-\r
- configASSERT( pxStreamBuffer );\r
-\r
- /* It is not valid for the trigger level to be 0. */\r
- if( xTriggerLevel == ( size_t ) 0 )\r
- {\r
- xTriggerLevel = ( size_t ) 1; /*lint !e9044 Parameter modified to ensure it doesn't have a dangerous value. */\r
- }\r
-\r
- /* The trigger level is the number of bytes that must be in the stream\r
- buffer before a task that is waiting for data is unblocked. */\r
- if( xTriggerLevel <= pxStreamBuffer->xLength )\r
- {\r
- pxStreamBuffer->xTriggerLevelBytes = xTriggerLevel;\r
- xReturn = pdPASS;\r
- }\r
- else\r
- {\r
- xReturn = pdFALSE;\r
- }\r
-\r
- return xReturn;\r
-}\r
-/*-----------------------------------------------------------*/\r
-\r
-size_t xStreamBufferSpacesAvailable( StreamBufferHandle_t xStreamBuffer )\r
-{\r
-const StreamBuffer_t * const pxStreamBuffer = ( StreamBuffer_t * ) xStreamBuffer; /*lint !e9087 !e9079 Safe cast as StreamBufferHandle_t is opaque Streambuffer_t. */\r
-size_t xSpace;\r
-\r
- configASSERT( pxStreamBuffer );\r
-\r
- xSpace = pxStreamBuffer->xLength + pxStreamBuffer->xTail;\r
- xSpace -= pxStreamBuffer->xHead;\r
- xSpace -= ( size_t ) 1;\r
-\r
- if( xSpace >= pxStreamBuffer->xLength )\r
- {\r
- xSpace -= pxStreamBuffer->xLength;\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
-\r
- return xSpace;\r
-}\r
-/*-----------------------------------------------------------*/\r
-\r
-size_t xStreamBufferBytesAvailable( StreamBufferHandle_t xStreamBuffer )\r
-{\r
-const StreamBuffer_t * const pxStreamBuffer = ( StreamBuffer_t * ) xStreamBuffer; /*lint !e9087 !e9079 Safe cast as StreamBufferHandle_t is opaque Streambuffer_t. */\r
-size_t xReturn;\r
-\r
- configASSERT( pxStreamBuffer );\r
-\r
- xReturn = prvBytesInBuffer( pxStreamBuffer );\r
- return xReturn;\r
-}\r
-/*-----------------------------------------------------------*/\r
-\r
-size_t xStreamBufferSend( StreamBufferHandle_t xStreamBuffer,\r
- const void *pvTxData,\r
- size_t xDataLengthBytes,\r
- TickType_t xTicksToWait )\r
-{\r
-StreamBuffer_t * const pxStreamBuffer = ( StreamBuffer_t * ) xStreamBuffer; /*lint !e9087 !e9079 Safe cast as StreamBufferHandle_t is opaque Streambuffer_t. */\r
-size_t xReturn, xSpace = 0;\r
-size_t xRequiredSpace = xDataLengthBytes;\r
-TimeOut_t xTimeOut;\r
-\r
- configASSERT( pvTxData );\r
- configASSERT( pxStreamBuffer );\r
-\r
- /* This send function is used to write to both message buffers and stream\r
- buffers. If this is a message buffer then the space needed must be\r
- increased by the amount of bytes needed to store the length of the\r
- message. */\r
- if( ( pxStreamBuffer->ucFlags & sbFLAGS_IS_MESSAGE_BUFFER ) != ( uint8_t ) 0 )\r
- {\r
- xRequiredSpace += sbBYTES_TO_STORE_MESSAGE_LENGTH;\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
-\r
- if( xTicksToWait != ( TickType_t ) 0 )\r
- {\r
- vTaskSetTimeOutState( &xTimeOut );\r
-\r
- do\r
- {\r
- /* Wait until the required number of bytes are free in the message\r
- buffer. */\r
- taskENTER_CRITICAL();\r
- {\r
- xSpace = xStreamBufferSpacesAvailable( pxStreamBuffer );\r
-\r
- if( xSpace < xRequiredSpace )\r
- {\r
- /* Clear notification state as going to wait for space. */\r
- ( void ) xTaskNotifyStateClear( NULL );\r
-\r
- /* Should only be one writer. */\r
- configASSERT( pxStreamBuffer->xTaskWaitingToSend == NULL );\r
- pxStreamBuffer->xTaskWaitingToSend = xTaskGetCurrentTaskHandle();\r
- }\r
- else\r
- {\r
- taskEXIT_CRITICAL();\r
- break;\r
- }\r
- }\r
- taskEXIT_CRITICAL();\r
-\r
- traceBLOCKING_ON_STREAM_BUFFER_SEND( xStreamBuffer );\r
- ( void ) xTaskNotifyWait( ( uint32_t ) 0, UINT32_MAX, NULL, xTicksToWait );\r
- pxStreamBuffer->xTaskWaitingToSend = NULL;\r
-\r
- } while( xTaskCheckForTimeOut( &xTimeOut, &xTicksToWait ) == pdFALSE );\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
-\r
- if( xSpace == ( size_t ) 0 )\r
- {\r
- xSpace = xStreamBufferSpacesAvailable( pxStreamBuffer );\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
-\r
- xReturn = prvWriteMessageToBuffer( pxStreamBuffer, pvTxData, xDataLengthBytes, xSpace, xRequiredSpace );\r
-\r
- if( xReturn > ( size_t ) 0 )\r
- {\r
- traceSTREAM_BUFFER_SEND( xStreamBuffer, xReturn );\r
-\r
- /* Was a task waiting for the data? */\r
- if( prvBytesInBuffer( pxStreamBuffer ) >= pxStreamBuffer->xTriggerLevelBytes )\r
- {\r
- sbSEND_COMPLETED( pxStreamBuffer );\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- traceSTREAM_BUFFER_SEND_FAILED( xStreamBuffer );\r
- }\r
-\r
- return xReturn;\r
-}\r
-/*-----------------------------------------------------------*/\r
-\r
-size_t xStreamBufferSendFromISR( StreamBufferHandle_t xStreamBuffer,\r
- const void *pvTxData,\r
- size_t xDataLengthBytes,\r
- BaseType_t * const pxHigherPriorityTaskWoken )\r
-{\r
-StreamBuffer_t * const pxStreamBuffer = ( StreamBuffer_t * ) xStreamBuffer; /*lint !e9087 !e9079 Safe cast as StreamBufferHandle_t is opaque Streambuffer_t. */\r
-size_t xReturn, xSpace;\r
-size_t xRequiredSpace = xDataLengthBytes;\r
-\r
- configASSERT( pvTxData );\r
- configASSERT( pxStreamBuffer );\r
-\r
- /* This send function is used to write to both message buffers and stream\r
- buffers. If this is a message buffer then the space needed must be\r
- increased by the amount of bytes needed to store the length of the\r
- message. */\r
- if( ( pxStreamBuffer->ucFlags & sbFLAGS_IS_MESSAGE_BUFFER ) != ( uint8_t ) 0 )\r
- {\r
- xRequiredSpace += sbBYTES_TO_STORE_MESSAGE_LENGTH;\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
-\r
- xSpace = xStreamBufferSpacesAvailable( pxStreamBuffer );\r
- xReturn = prvWriteMessageToBuffer( pxStreamBuffer, pvTxData, xDataLengthBytes, xSpace, xRequiredSpace );\r
-\r
- if( xReturn > ( size_t ) 0 )\r
- {\r
- /* Was a task waiting for the data? */\r
- if( prvBytesInBuffer( pxStreamBuffer ) >= pxStreamBuffer->xTriggerLevelBytes )\r
- {\r
- sbSEND_COMPLETE_FROM_ISR( pxStreamBuffer, pxHigherPriorityTaskWoken );\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
-\r
- traceSTREAM_BUFFER_SEND_FROM_ISR( xStreamBuffer, xReturn );\r
-\r
- return xReturn;\r
-}\r
-/*-----------------------------------------------------------*/\r
-\r
-static size_t prvWriteMessageToBuffer( StreamBuffer_t * const pxStreamBuffer,\r
- const void * pvTxData,\r
- size_t xDataLengthBytes,\r
- size_t xSpace,\r
- size_t xRequiredSpace )\r
-{\r
- BaseType_t xShouldWrite;\r
- size_t xReturn;\r
-\r
- if( xSpace == ( size_t ) 0 )\r
- {\r
- /* Doesn't matter if this is a stream buffer or a message buffer, there\r
- is no space to write. */\r
- xShouldWrite = pdFALSE;\r
- }\r
- else if( ( pxStreamBuffer->ucFlags & sbFLAGS_IS_MESSAGE_BUFFER ) == ( uint8_t ) 0 )\r
- {\r
- /* This is a stream buffer, as opposed to a message buffer, so writing a\r
- stream of bytes rather than discrete messages. Write as many bytes as\r
- possible. */\r
- xShouldWrite = pdTRUE;\r
- xDataLengthBytes = configMIN( xDataLengthBytes, xSpace ); /*lint !e9044 Function parameter modified to ensure it is capped to available space. */\r
- }\r
- else if( xSpace >= xRequiredSpace )\r
- {\r
- /* This is a message buffer, as opposed to a stream buffer, and there\r
- is enough space to write both the message length and the message itself\r
- into the buffer. Start by writing the length of the data, the data\r
- itself will be written later in this function. */\r
- xShouldWrite = pdTRUE;\r
- ( void ) prvWriteBytesToBuffer( pxStreamBuffer, ( const uint8_t * ) &( xDataLengthBytes ), sbBYTES_TO_STORE_MESSAGE_LENGTH );\r
- }\r
- else\r
- {\r
- /* There is space available, but not enough space. */\r
- xShouldWrite = pdFALSE;\r
- }\r
-\r
- if( xShouldWrite != pdFALSE )\r
- {\r
- /* Writes the data itself. */\r
- xReturn = prvWriteBytesToBuffer( pxStreamBuffer, ( const uint8_t * ) pvTxData, xDataLengthBytes ); /*lint !e9079 Storage buffer is implemented as uint8_t for ease of sizing, alighment and access. */\r
- }\r
- else\r
- {\r
- xReturn = 0;\r
- }\r
-\r
- return xReturn;\r
-}\r
-/*-----------------------------------------------------------*/\r
-\r
-size_t xStreamBufferReceive( StreamBufferHandle_t xStreamBuffer,\r
- void *pvRxData,\r
- size_t xBufferLengthBytes,\r
- TickType_t xTicksToWait )\r
-{\r
-StreamBuffer_t * const pxStreamBuffer = ( StreamBuffer_t * ) xStreamBuffer; /*lint !e9087 !e9079 Safe cast as StreamBufferHandle_t is opaque Streambuffer_t. */\r
-size_t xReceivedLength = 0, xBytesAvailable, xBytesToStoreMessageLength;\r
-\r
- configASSERT( pvRxData );\r
- configASSERT( pxStreamBuffer );\r
-\r
- /* This receive function is used by both message buffers, which store\r
- discrete messages, and stream buffers, which store a continuous stream of\r
- bytes. Discrete messages include an additional\r
- sbBYTES_TO_STORE_MESSAGE_LENGTH bytes that hold the length of the\r
- message. */\r
- if( ( pxStreamBuffer->ucFlags & sbFLAGS_IS_MESSAGE_BUFFER ) != ( uint8_t ) 0 )\r
- {\r
- xBytesToStoreMessageLength = sbBYTES_TO_STORE_MESSAGE_LENGTH;\r
- }\r
- else\r
- {\r
- xBytesToStoreMessageLength = 0;\r
- }\r
-\r
- if( xTicksToWait != ( TickType_t ) 0 )\r
- {\r
- /* Checking if there is data and clearing the notification state must be\r
- performed atomically. */\r
- taskENTER_CRITICAL();\r
- {\r
- xBytesAvailable = prvBytesInBuffer( pxStreamBuffer );\r
-\r
- /* If this function was invoked by a message buffer read then\r
- xBytesToStoreMessageLength holds the number of bytes used to hold\r
- the length of the next discrete message. If this function was\r
- invoked by a stream buffer read then xBytesToStoreMessageLength will\r
- be 0. */\r
- if( xBytesAvailable <= xBytesToStoreMessageLength )\r
- {\r
- /* Clear notification state as going to wait for data. */\r
- ( void ) xTaskNotifyStateClear( NULL );\r
-\r
- /* Should only be one reader. */\r
- configASSERT( pxStreamBuffer->xTaskWaitingToReceive == NULL );\r
- pxStreamBuffer->xTaskWaitingToReceive = xTaskGetCurrentTaskHandle();\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- taskEXIT_CRITICAL();\r
-\r
- if( xBytesAvailable <= xBytesToStoreMessageLength )\r
- {\r
- /* Wait for data to be available. */\r
- traceBLOCKING_ON_STREAM_BUFFER_RECEIVE( xStreamBuffer );\r
- ( void ) xTaskNotifyWait( ( uint32_t ) 0, UINT32_MAX, NULL, xTicksToWait );\r
- pxStreamBuffer->xTaskWaitingToReceive = NULL;\r
-\r
- /* Recheck the data available after blocking. */\r
- xBytesAvailable = prvBytesInBuffer( pxStreamBuffer );\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- else\r
- {\r
- xBytesAvailable = prvBytesInBuffer( pxStreamBuffer );\r
- }\r
-\r
- /* Whether receiving a discrete message (where xBytesToStoreMessageLength\r
- holds the number of bytes used to store the message length) or a stream of\r
- bytes (where xBytesToStoreMessageLength is zero), the number of bytes\r
- available must be greater than xBytesToStoreMessageLength to be able to\r
- read bytes from the buffer. */\r
- if( xBytesAvailable > xBytesToStoreMessageLength )\r
- {\r
- xReceivedLength = prvReadMessageFromBuffer( pxStreamBuffer, pvRxData, xBufferLengthBytes, xBytesAvailable, xBytesToStoreMessageLength );\r
-\r
- /* Was a task waiting for space in the buffer? */\r
- if( xReceivedLength != ( size_t ) 0 )\r
- {\r
- traceSTREAM_BUFFER_RECEIVE( xStreamBuffer, xReceivedLength );\r
- sbRECEIVE_COMPLETED( pxStreamBuffer );\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- else\r
- {\r
- traceSTREAM_BUFFER_RECEIVE_FAILED( xStreamBuffer );\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
-\r
- return xReceivedLength;\r
-}\r
-/*-----------------------------------------------------------*/\r
-\r
-size_t xStreamBufferReceiveFromISR( StreamBufferHandle_t xStreamBuffer,\r
- void *pvRxData,\r
- size_t xBufferLengthBytes,\r
- BaseType_t * const pxHigherPriorityTaskWoken )\r
-{\r
-StreamBuffer_t * const pxStreamBuffer = ( StreamBuffer_t * ) xStreamBuffer; /*lint !e9087 !e9079 Safe cast as StreamBufferHandle_t is opaque Streambuffer_t. */\r
-size_t xReceivedLength = 0, xBytesAvailable, xBytesToStoreMessageLength;\r
-\r
- configASSERT( pvRxData );\r
- configASSERT( pxStreamBuffer );\r
-\r
- /* This receive function is used by both message buffers, which store\r
- discrete messages, and stream buffers, which store a continuous stream of\r
- bytes. Discrete messages include an additional\r
- sbBYTES_TO_STORE_MESSAGE_LENGTH bytes that hold the length of the\r
- message. */\r
- if( ( pxStreamBuffer->ucFlags & sbFLAGS_IS_MESSAGE_BUFFER ) != ( uint8_t ) 0 )\r
- {\r
- xBytesToStoreMessageLength = sbBYTES_TO_STORE_MESSAGE_LENGTH;\r
- }\r
- else\r
- {\r
- xBytesToStoreMessageLength = 0;\r
- }\r
-\r
- xBytesAvailable = prvBytesInBuffer( pxStreamBuffer );\r
-\r
- /* Whether receiving a discrete message (where xBytesToStoreMessageLength\r
- holds the number of bytes used to store the message length) or a stream of\r
- bytes (where xBytesToStoreMessageLength is zero), the number of bytes\r
- available must be greater than xBytesToStoreMessageLength to be able to\r
- read bytes from the buffer. */\r
- if( xBytesAvailable > xBytesToStoreMessageLength )\r
- {\r
- xReceivedLength = prvReadMessageFromBuffer( pxStreamBuffer, pvRxData, xBufferLengthBytes, xBytesAvailable, xBytesToStoreMessageLength );\r
-\r
- /* Was a task waiting for space in the buffer? */\r
- if( xReceivedLength != ( size_t ) 0 )\r
- {\r
- sbRECEIVE_COMPLETED_FROM_ISR( pxStreamBuffer, pxHigherPriorityTaskWoken );\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
-\r
- traceSTREAM_BUFFER_RECEIVE_FROM_ISR( xStreamBuffer, xReceivedLength );\r
-\r
- return xReceivedLength;\r
-}\r
-/*-----------------------------------------------------------*/\r
-\r
-static size_t prvReadMessageFromBuffer( StreamBuffer_t *pxStreamBuffer,\r
- void *pvRxData,\r
- size_t xBufferLengthBytes,\r
- size_t xBytesAvailable,\r
- size_t xBytesToStoreMessageLength )\r
-{\r
-size_t xOriginalTail, xReceivedLength, xNextMessageLength;\r
-\r
- if( xBytesToStoreMessageLength != ( size_t ) 0 )\r
- {\r
- /* A discrete message is being received. First receive the length\r
- of the message. A copy of the tail is stored so the buffer can be\r
- returned to its prior state if the length of the message is too\r
- large for the provided buffer. */\r
- xOriginalTail = pxStreamBuffer->xTail;\r
- ( void ) prvReadBytesFromBuffer( pxStreamBuffer, ( uint8_t * ) &xNextMessageLength, xBytesToStoreMessageLength, xBytesAvailable );\r
-\r
- /* Reduce the number of bytes available by the number of bytes just\r
- read out. */\r
- xBytesAvailable -= xBytesToStoreMessageLength;\r
-\r
- /* Check there is enough space in the buffer provided by the\r
- user. */\r
- if( xNextMessageLength > xBufferLengthBytes )\r
- {\r
- /* The user has provided insufficient space to read the message\r
- so return the buffer to its previous state (so the length of\r
- the message is in the buffer again). */\r
- pxStreamBuffer->xTail = xOriginalTail;\r
- xNextMessageLength = 0;\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- else\r
- {\r
- /* A stream of bytes is being received (as opposed to a discrete\r
- message), so read as many bytes as possible. */\r
- xNextMessageLength = xBufferLengthBytes;\r
- }\r
-\r
- /* Read the actual data. */\r
- xReceivedLength = prvReadBytesFromBuffer( pxStreamBuffer, ( uint8_t * ) pvRxData, xNextMessageLength, xBytesAvailable ); /*lint !e9079 Data storage area is implemented as uint8_t array for ease of sizing, indexing and alignment. */\r
-\r
- return xReceivedLength;\r
-}\r
-/*-----------------------------------------------------------*/\r
-\r
-BaseType_t xStreamBufferIsEmpty( StreamBufferHandle_t xStreamBuffer )\r
-{\r
-const StreamBuffer_t * const pxStreamBuffer = ( StreamBuffer_t * ) xStreamBuffer; /*lint !e9087 !e9079 Safe cast as StreamBufferHandle_t is opaque Streambuffer_t. */\r
-BaseType_t xReturn;\r
-size_t xTail;\r
-\r
- configASSERT( pxStreamBuffer );\r
-\r
- /* True if no bytes are available. */\r
- xTail = pxStreamBuffer->xTail;\r
- if( pxStreamBuffer->xHead == xTail )\r
- {\r
- xReturn = pdTRUE;\r
- }\r
- else\r
- {\r
- xReturn = pdFALSE;\r
- }\r
-\r
- return xReturn;\r
-}\r
-/*-----------------------------------------------------------*/\r
-\r
-BaseType_t xStreamBufferIsFull( StreamBufferHandle_t xStreamBuffer )\r
-{\r
-BaseType_t xReturn;\r
-size_t xBytesToStoreMessageLength;\r
-const StreamBuffer_t * const pxStreamBuffer = ( StreamBuffer_t * ) xStreamBuffer; /*lint !e9087 !e9079 Safe cast as StreamBufferHandle_t is opaque Streambuffer_t. */\r
-\r
- configASSERT( pxStreamBuffer );\r
-\r
- /* This generic version of the receive function is used by both message\r
- buffers, which store discrete messages, and stream buffers, which store a\r
- continuous stream of bytes. Discrete messages include an additional\r
- sbBYTES_TO_STORE_MESSAGE_LENGTH bytes that hold the length of the message. */\r
- if( ( pxStreamBuffer->ucFlags & sbFLAGS_IS_MESSAGE_BUFFER ) != ( uint8_t ) 0 )\r
- {\r
- xBytesToStoreMessageLength = sbBYTES_TO_STORE_MESSAGE_LENGTH;\r
- }\r
- else\r
- {\r
- xBytesToStoreMessageLength = 0;\r
- }\r
-\r
- /* True if the available space equals zero. */\r
- if( xStreamBufferSpacesAvailable( xStreamBuffer ) <= xBytesToStoreMessageLength )\r
- {\r
- xReturn = pdTRUE;\r
- }\r
- else\r
- {\r
- xReturn = pdFALSE;\r
- }\r
-\r
- return xReturn;\r
-}\r
-/*-----------------------------------------------------------*/\r
-\r
-BaseType_t xStreamBufferSendCompletedFromISR( StreamBufferHandle_t xStreamBuffer, BaseType_t *pxHigherPriorityTaskWoken )\r
-{\r
-StreamBuffer_t * const pxStreamBuffer = ( StreamBuffer_t * ) xStreamBuffer; /*lint !e9087 !e9079 Safe cast as StreamBufferHandle_t is opaque Streambuffer_t. */\r
-BaseType_t xReturn;\r
-UBaseType_t uxSavedInterruptStatus;\r
-\r
- configASSERT( pxStreamBuffer );\r
-\r
- uxSavedInterruptStatus = ( UBaseType_t ) portSET_INTERRUPT_MASK_FROM_ISR();\r
- {\r
- if( ( pxStreamBuffer )->xTaskWaitingToReceive != NULL )\r
- {\r
- ( void ) xTaskNotifyFromISR( ( pxStreamBuffer )->xTaskWaitingToReceive,\r
- ( uint32_t ) 0,\r
- eNoAction,\r
- pxHigherPriorityTaskWoken );\r
- ( pxStreamBuffer )->xTaskWaitingToReceive = NULL;\r
- xReturn = pdTRUE;\r
- }\r
- else\r
- {\r
- xReturn = pdFALSE;\r
- }\r
- }\r
- portCLEAR_INTERRUPT_MASK_FROM_ISR( uxSavedInterruptStatus );\r
-\r
- return xReturn;\r
-}\r
-/*-----------------------------------------------------------*/\r
-\r
-BaseType_t xStreamBufferReceiveCompletedFromISR( StreamBufferHandle_t xStreamBuffer, BaseType_t *pxHigherPriorityTaskWoken )\r
-{\r
-StreamBuffer_t * const pxStreamBuffer = ( StreamBuffer_t * ) xStreamBuffer; /*lint !e9087 !e9079 Safe cast as StreamBufferHandle_t is opaque Streambuffer_t. */\r
-BaseType_t xReturn;\r
-UBaseType_t uxSavedInterruptStatus;\r
-\r
- configASSERT( pxStreamBuffer );\r
-\r
- uxSavedInterruptStatus = ( UBaseType_t ) portSET_INTERRUPT_MASK_FROM_ISR();\r
- {\r
- if( ( pxStreamBuffer )->xTaskWaitingToSend != NULL )\r
- {\r
- ( void ) xTaskNotifyFromISR( ( pxStreamBuffer )->xTaskWaitingToSend,\r
- ( uint32_t ) 0,\r
- eNoAction,\r
- pxHigherPriorityTaskWoken );\r
- ( pxStreamBuffer )->xTaskWaitingToSend = NULL;\r
- xReturn = pdTRUE;\r
- }\r
- else\r
- {\r
- xReturn = pdFALSE;\r
- }\r
- }\r
- portCLEAR_INTERRUPT_MASK_FROM_ISR( uxSavedInterruptStatus );\r
-\r
- return xReturn;\r
-}\r
-/*-----------------------------------------------------------*/\r
-\r
-static size_t prvWriteBytesToBuffer( StreamBuffer_t * const pxStreamBuffer, const uint8_t *pucData, size_t xCount )\r
-{\r
-size_t xNextHead, xFirstLength;\r
-\r
- configASSERT( xCount > ( size_t ) 0 );\r
-\r
- xNextHead = pxStreamBuffer->xHead;\r
-\r
- /* Calculate the number of bytes that can be added in the first write -\r
- which may be less than the total number of bytes that need to be added if\r
- the buffer will wrap back to the beginning. */\r
- xFirstLength = configMIN( pxStreamBuffer->xLength - xNextHead, xCount );\r
-\r
- /* Write as many bytes as can be written in the first write. */\r
- configASSERT( ( xNextHead + xFirstLength ) <= pxStreamBuffer->xLength );\r
- memcpy( ( void* ) ( &( pxStreamBuffer->pucBuffer[ xNextHead ] ) ), ( const void * ) pucData, xFirstLength ); /*lint !e9087 memcpy() requires void *. */\r
-\r
- /* If the number of bytes written was less than the number that could be\r
- written in the first write... */\r
- if( xCount > xFirstLength )\r
- {\r
- /* ...then write the remaining bytes to the start of the buffer. */\r
- configASSERT( ( xCount - xFirstLength ) <= pxStreamBuffer->xLength );\r
- memcpy( ( void * ) pxStreamBuffer->pucBuffer, ( const void * ) &( pucData[ xFirstLength ] ), xCount - xFirstLength ); /*lint !e9087 memcpy() requires void *. */\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
-\r
- xNextHead += xCount;\r
- if( xNextHead >= pxStreamBuffer->xLength )\r
- {\r
- xNextHead -= pxStreamBuffer->xLength;\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
-\r
- pxStreamBuffer->xHead = xNextHead;\r
-\r
- return xCount;\r
-}\r
-/*-----------------------------------------------------------*/\r
-\r
-static size_t prvReadBytesFromBuffer( StreamBuffer_t *pxStreamBuffer, uint8_t *pucData, size_t xMaxCount, size_t xBytesAvailable )\r
-{\r
-size_t xCount, xFirstLength, xNextTail;\r
-\r
- /* Use the minimum of the wanted bytes and the available bytes. */\r
- xCount = configMIN( xBytesAvailable, xMaxCount );\r
-\r
- if( xCount > ( size_t ) 0 )\r
- {\r
- xNextTail = pxStreamBuffer->xTail;\r
-\r
- /* Calculate the number of bytes that can be read - which may be\r
- less than the number wanted if the data wraps around to the start of\r
- the buffer. */\r
- xFirstLength = configMIN( pxStreamBuffer->xLength - xNextTail, xCount );\r
-\r
- /* Obtain the number of bytes it is possible to obtain in the first\r
- read. Asserts check bounds of read and write. */\r
- configASSERT( xFirstLength <= xMaxCount );\r
- configASSERT( ( xNextTail + xFirstLength ) <= pxStreamBuffer->xLength );\r
- memcpy( ( void * ) pucData, ( const void * ) &( pxStreamBuffer->pucBuffer[ xNextTail ] ), xFirstLength ); /*lint !e9087 memcpy() requires void *. */\r
-\r
- /* If the total number of wanted bytes is greater than the number\r
- that could be read in the first read... */\r
- if( xCount > xFirstLength )\r
- {\r
- /*...then read the remaining bytes from the start of the buffer. */\r
- configASSERT( xCount <= xMaxCount );\r
- memcpy( ( void * ) &( pucData[ xFirstLength ] ), ( void * ) ( pxStreamBuffer->pucBuffer ), xCount - xFirstLength ); /*lint !e9087 memcpy() requires void *. */\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
-\r
- /* Move the tail pointer to effectively remove the data read from\r
- the buffer. */\r
- xNextTail += xCount;\r
-\r
- if( xNextTail >= pxStreamBuffer->xLength )\r
- {\r
- xNextTail -= pxStreamBuffer->xLength;\r
- }\r
-\r
- pxStreamBuffer->xTail = xNextTail;\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
-\r
- return xCount;\r
-}\r
-/*-----------------------------------------------------------*/\r
-\r
-static size_t prvBytesInBuffer( const StreamBuffer_t * const pxStreamBuffer )\r
-{\r
-/* Returns the distance between xTail and xHead. */\r
-size_t xCount;\r
-\r
- xCount = pxStreamBuffer->xLength + pxStreamBuffer->xHead;\r
- xCount -= pxStreamBuffer->xTail;\r
- if ( xCount >= pxStreamBuffer->xLength )\r
- {\r
- xCount -= pxStreamBuffer->xLength;\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
-\r
- return xCount;\r
-}\r
-/*-----------------------------------------------------------*/\r
-\r
-static void prvInitialiseNewStreamBuffer( StreamBuffer_t * const pxStreamBuffer,\r
- uint8_t * const pucBuffer,\r
- size_t xBufferSizeBytes,\r
- size_t xTriggerLevelBytes,\r
- BaseType_t xIsMessageBuffer )\r
-{\r
- /* Assert here is deliberately writing to the entire buffer to ensure it can\r
- be written to without generating exceptions, and is setting the buffer to a\r
- known value to assist in development/debugging. */\r
- #if( configASSERT_DEFINED == 1 )\r
- {\r
- /* The value written just has to be identifiable when looking at the\r
- memory. Don't use 0xA5 as that is the stack fill value and could\r
- result in confusion as to what is actually being observed. */\r
- const BaseType_t xWriteValue = 0x55;\r
- configASSERT( memset( pucBuffer, ( int ) xWriteValue, xBufferSizeBytes ) == pucBuffer );\r
- }\r
- #endif\r
-\r
- memset( ( void * ) pxStreamBuffer, 0x00, sizeof( StreamBuffer_t ) ); /*lint !e9087 memset() requires void *. */\r
- pxStreamBuffer->pucBuffer = pucBuffer;\r
- pxStreamBuffer->xLength = xBufferSizeBytes;\r
- pxStreamBuffer->xTriggerLevelBytes = xTriggerLevelBytes;\r
-\r
- if( xIsMessageBuffer != pdFALSE )\r
- {\r
- pxStreamBuffer->ucFlags |= sbFLAGS_IS_MESSAGE_BUFFER;\r
- }\r
-}\r
-\r
-#if ( configUSE_TRACE_FACILITY == 1 )\r
-\r
- UBaseType_t uxStreamBufferGetStreamBufferNumber( StreamBufferHandle_t xStreamBuffer )\r
- {\r
- return ( ( StreamBuffer_t * ) xStreamBuffer )->uxStreamBufferNumber;\r
- }\r
-\r
-#endif /* configUSE_TRACE_FACILITY */\r
-/*-----------------------------------------------------------*/\r
-\r
-#if ( configUSE_TRACE_FACILITY == 1 )\r
-\r
- void vStreamBufferSetStreamBufferNumber( StreamBufferHandle_t xStreamBuffer, UBaseType_t uxStreamBufferNumber )\r
- {\r
- ( ( StreamBuffer_t * ) xStreamBuffer )->uxStreamBufferNumber = uxStreamBufferNumber;\r
- }\r
-\r
-#endif /* configUSE_TRACE_FACILITY */\r
-/*-----------------------------------------------------------*/\r
-\r
-#if ( configUSE_TRACE_FACILITY == 1 )\r
-\r
- uint8_t ucStreamBufferGetStreamBufferType( StreamBufferHandle_t xStreamBuffer )\r
- {\r
- return ( ( StreamBuffer_t * )xStreamBuffer )->ucFlags | sbFLAGS_IS_MESSAGE_BUFFER;\r
- }\r
-\r
-#endif /* configUSE_TRACE_FACILITY */\r
-/*-----------------------------------------------------------*/\r
+++ /dev/null
-/*\r
- * FreeRTOS Kernel V10.0.1\r
- * Copyright (C) 2017 Amazon.com, Inc. or its affiliates. All Rights Reserved.\r
- *\r
- * Permission is hereby granted, free of charge, to any person obtaining a copy of\r
- * this software and associated documentation files (the "Software"), to deal in\r
- * the Software without restriction, including without limitation the rights to\r
- * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of\r
- * the Software, and to permit persons to whom the Software is furnished to do so,\r
- * subject to the following conditions:\r
- *\r
- * The above copyright notice and this permission notice shall be included in all\r
- * copies or substantial portions of the Software.\r
- *\r
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\r
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS\r
- * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR\r
- * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER\r
- * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN\r
- * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\r
- *\r
- * http://www.FreeRTOS.org\r
- * http://aws.amazon.com/freertos\r
- *\r
- * 1 tab == 4 spaces!\r
- */\r
-\r
-/* Standard includes. */\r
-#include <stdlib.h>\r
-#include <string.h>\r
-\r
-/* Defining MPU_WRAPPERS_INCLUDED_FROM_API_FILE prevents task.h from redefining\r
-all the API functions to use the MPU wrappers. That should only be done when\r
-task.h is included from an application file. */\r
-#define MPU_WRAPPERS_INCLUDED_FROM_API_FILE\r
-\r
-/* FreeRTOS includes. */\r
-#include "FreeRTOS.h"\r
-#include "task.h"\r
-#include "timers.h"\r
-#include "stack_macros.h"\r
-\r
-/* Lint e961 and e750 are suppressed as a MISRA exception justified because the\r
-MPU ports require MPU_WRAPPERS_INCLUDED_FROM_API_FILE to be defined for the\r
-header files above, but not in this file, in order to generate the correct\r
-privileged Vs unprivileged linkage and placement. */\r
-#undef MPU_WRAPPERS_INCLUDED_FROM_API_FILE /*lint !e961 !e750. */\r
-\r
-/* Set configUSE_STATS_FORMATTING_FUNCTIONS to 2 to include the stats formatting\r
-functions but without including stdio.h here. */\r
-#if ( configUSE_STATS_FORMATTING_FUNCTIONS == 1 )\r
- /* At the bottom of this file are two optional functions that can be used\r
- to generate human readable text from the raw data generated by the\r
- uxTaskGetSystemState() function. Note the formatting functions are provided\r
- for convenience only, and are NOT considered part of the kernel. */\r
- #include <stdio.h>\r
-#endif /* configUSE_STATS_FORMATTING_FUNCTIONS == 1 ) */\r
-\r
-#if( configUSE_PREEMPTION == 0 )\r
- /* If the cooperative scheduler is being used then a yield should not be\r
- performed just because a higher priority task has been woken. */\r
- #define taskYIELD_IF_USING_PREEMPTION()\r
-#else\r
- #define taskYIELD_IF_USING_PREEMPTION() portYIELD_WITHIN_API()\r
-#endif\r
-\r
-/* Values that can be assigned to the ucNotifyState member of the TCB. */\r
-#define taskNOT_WAITING_NOTIFICATION ( ( uint8_t ) 0 )\r
-#define taskWAITING_NOTIFICATION ( ( uint8_t ) 1 )\r
-#define taskNOTIFICATION_RECEIVED ( ( uint8_t ) 2 )\r
-\r
-/*\r
- * The value used to fill the stack of a task when the task is created. This\r
- * is used purely for checking the high water mark for tasks.\r
- */\r
-#define tskSTACK_FILL_BYTE ( 0xa5U )\r
-\r
-/* Sometimes the FreeRTOSConfig.h settings only allow a task to be created using\r
-dynamically allocated RAM, in which case when any task is deleted it is known\r
-that both the task's stack and TCB need to be freed. Sometimes the\r
-FreeRTOSConfig.h settings only allow a task to be created using statically\r
-allocated RAM, in which case when any task is deleted it is known that neither\r
-the task's stack or TCB should be freed. Sometimes the FreeRTOSConfig.h\r
-settings allow a task to be created using either statically or dynamically\r
-allocated RAM, in which case a member of the TCB is used to record whether the\r
-stack and/or TCB were allocated statically or dynamically, so when a task is\r
-deleted the RAM that was allocated dynamically is freed again and no attempt is\r
-made to free the RAM that was allocated statically.\r
-tskSTATIC_AND_DYNAMIC_ALLOCATION_POSSIBLE is only true if it is possible for a\r
-task to be created using either statically or dynamically allocated RAM. Note\r
-that if portUSING_MPU_WRAPPERS is 1 then a protected task can be created with\r
-a statically allocated stack and a dynamically allocated TCB.\r
-!!!NOTE!!! If the definition of tskSTATIC_AND_DYNAMIC_ALLOCATION_POSSIBLE is\r
-changed then the definition of StaticTask_t must also be updated. */\r
-#define tskSTATIC_AND_DYNAMIC_ALLOCATION_POSSIBLE ( ( configSUPPORT_STATIC_ALLOCATION == 1 ) && ( configSUPPORT_DYNAMIC_ALLOCATION == 1 ) )\r
-#define tskDYNAMICALLY_ALLOCATED_STACK_AND_TCB ( ( uint8_t ) 0 )\r
-#define tskSTATICALLY_ALLOCATED_STACK_ONLY ( ( uint8_t ) 1 )\r
-#define tskSTATICALLY_ALLOCATED_STACK_AND_TCB ( ( uint8_t ) 2 )\r
-\r
-/* If any of the following are set then task stacks are filled with a known\r
-value so the high water mark can be determined. If none of the following are\r
-set then don't fill the stack so there is no unnecessary dependency on memset. */\r
-#if( ( configCHECK_FOR_STACK_OVERFLOW > 1 ) || ( configUSE_TRACE_FACILITY == 1 ) || ( INCLUDE_uxTaskGetStackHighWaterMark == 1 ) )\r
- #define tskSET_NEW_STACKS_TO_KNOWN_VALUE 1\r
-#else\r
- #define tskSET_NEW_STACKS_TO_KNOWN_VALUE 0\r
-#endif\r
-\r
-/*\r
- * Macros used by vListTask to indicate which state a task is in.\r
- */\r
-#define tskRUNNING_CHAR ( 'X' )\r
-#define tskBLOCKED_CHAR ( 'B' )\r
-#define tskREADY_CHAR ( 'R' )\r
-#define tskDELETED_CHAR ( 'D' )\r
-#define tskSUSPENDED_CHAR ( 'S' )\r
-\r
-/*\r
- * Some kernel aware debuggers require the data the debugger needs access to be\r
- * global, rather than file scope.\r
- */\r
-#ifdef portREMOVE_STATIC_QUALIFIER\r
- #define static\r
-#endif\r
-\r
-/* The name allocated to the Idle task. This can be overridden by defining\r
-configIDLE_TASK_NAME in FreeRTOSConfig.h. */\r
-#ifndef configIDLE_TASK_NAME\r
- #define configIDLE_TASK_NAME "IDLE"\r
-#endif\r
-\r
-#if ( configUSE_PORT_OPTIMISED_TASK_SELECTION == 0 )\r
-\r
- /* If configUSE_PORT_OPTIMISED_TASK_SELECTION is 0 then task selection is\r
- performed in a generic way that is not optimised to any particular\r
- microcontroller architecture. */\r
-\r
- /* uxTopReadyPriority holds the priority of the highest priority ready\r
- state task. */\r
- #define taskRECORD_READY_PRIORITY( uxPriority ) \\r
- { \\r
- if( ( uxPriority ) > uxTopReadyPriority ) \\r
- { \\r
- uxTopReadyPriority = ( uxPriority ); \\r
- } \\r
- } /* taskRECORD_READY_PRIORITY */\r
-\r
- /*-----------------------------------------------------------*/\r
-\r
- #define taskSELECT_HIGHEST_PRIORITY_TASK() \\r
- { \\r
- UBaseType_t uxTopPriority = uxTopReadyPriority; \\r
- \\r
- /* Find the highest priority queue that contains ready tasks. */ \\r
- while( listLIST_IS_EMPTY( &( pxReadyTasksLists[ uxTopPriority ] ) ) ) \\r
- { \\r
- configASSERT( uxTopPriority ); \\r
- --uxTopPriority; \\r
- } \\r
- \\r
- /* listGET_OWNER_OF_NEXT_ENTRY indexes through the list, so the tasks of \\r
- the same priority get an equal share of the processor time. */ \\r
- listGET_OWNER_OF_NEXT_ENTRY( pxCurrentTCB, &( pxReadyTasksLists[ uxTopPriority ] ) ); \\r
- uxTopReadyPriority = uxTopPriority; \\r
- } /* taskSELECT_HIGHEST_PRIORITY_TASK */\r
-\r
- /*-----------------------------------------------------------*/\r
-\r
- /* Define away taskRESET_READY_PRIORITY() and portRESET_READY_PRIORITY() as\r
- they are only required when a port optimised method of task selection is\r
- being used. */\r
- #define taskRESET_READY_PRIORITY( uxPriority )\r
- #define portRESET_READY_PRIORITY( uxPriority, uxTopReadyPriority )\r
-\r
-#else /* configUSE_PORT_OPTIMISED_TASK_SELECTION */\r
-\r
- /* If configUSE_PORT_OPTIMISED_TASK_SELECTION is 1 then task selection is\r
- performed in a way that is tailored to the particular microcontroller\r
- architecture being used. */\r
-\r
- /* A port optimised version is provided. Call the port defined macros. */\r
- #define taskRECORD_READY_PRIORITY( uxPriority ) portRECORD_READY_PRIORITY( uxPriority, uxTopReadyPriority )\r
-\r
- /*-----------------------------------------------------------*/\r
-\r
- #define taskSELECT_HIGHEST_PRIORITY_TASK() \\r
- { \\r
- UBaseType_t uxTopPriority; \\r
- \\r
- /* Find the highest priority list that contains ready tasks. */ \\r
- portGET_HIGHEST_PRIORITY( uxTopPriority, uxTopReadyPriority ); \\r
- configASSERT( listCURRENT_LIST_LENGTH( &( pxReadyTasksLists[ uxTopPriority ] ) ) > 0 ); \\r
- listGET_OWNER_OF_NEXT_ENTRY( pxCurrentTCB, &( pxReadyTasksLists[ uxTopPriority ] ) ); \\r
- } /* taskSELECT_HIGHEST_PRIORITY_TASK() */\r
-\r
- /*-----------------------------------------------------------*/\r
-\r
- /* A port optimised version is provided, call it only if the TCB being reset\r
- is being referenced from a ready list. If it is referenced from a delayed\r
- or suspended list then it won't be in a ready list. */\r
- #define taskRESET_READY_PRIORITY( uxPriority ) \\r
- { \\r
- if( listCURRENT_LIST_LENGTH( &( pxReadyTasksLists[ ( uxPriority ) ] ) ) == ( UBaseType_t ) 0 ) \\r
- { \\r
- portRESET_READY_PRIORITY( ( uxPriority ), ( uxTopReadyPriority ) ); \\r
- } \\r
- }\r
-\r
-#endif /* configUSE_PORT_OPTIMISED_TASK_SELECTION */\r
-\r
-/*-----------------------------------------------------------*/\r
-\r
-/* pxDelayedTaskList and pxOverflowDelayedTaskList are switched when the tick\r
-count overflows. */\r
-#define taskSWITCH_DELAYED_LISTS() \\r
-{ \\r
- List_t *pxTemp; \\r
- \\r
- /* The delayed tasks list should be empty when the lists are switched. */ \\r
- configASSERT( ( listLIST_IS_EMPTY( pxDelayedTaskList ) ) ); \\r
- \\r
- pxTemp = pxDelayedTaskList; \\r
- pxDelayedTaskList = pxOverflowDelayedTaskList; \\r
- pxOverflowDelayedTaskList = pxTemp; \\r
- xNumOfOverflows++; \\r
- prvResetNextTaskUnblockTime(); \\r
-}\r
-\r
-/*-----------------------------------------------------------*/\r
-\r
-/*\r
- * Place the task represented by pxTCB into the appropriate ready list for\r
- * the task. It is inserted at the end of the list.\r
- */\r
-#define prvAddTaskToReadyList( pxTCB ) \\r
- traceMOVED_TASK_TO_READY_STATE( pxTCB ); \\r
- taskRECORD_READY_PRIORITY( ( pxTCB )->uxPriority ); \\r
- vListInsertEnd( &( pxReadyTasksLists[ ( pxTCB )->uxPriority ] ), &( ( pxTCB )->xStateListItem ) ); \\r
- tracePOST_MOVED_TASK_TO_READY_STATE( pxTCB )\r
-/*-----------------------------------------------------------*/\r
-\r
-/*\r
- * Several functions take an TaskHandle_t parameter that can optionally be NULL,\r
- * where NULL is used to indicate that the handle of the currently executing\r
- * task should be used in place of the parameter. This macro simply checks to\r
- * see if the parameter is NULL and returns a pointer to the appropriate TCB.\r
- */\r
-#define prvGetTCBFromHandle( pxHandle ) ( ( ( pxHandle ) == NULL ) ? ( TCB_t * ) pxCurrentTCB : ( TCB_t * ) ( pxHandle ) )\r
-\r
-/* The item value of the event list item is normally used to hold the priority\r
-of the task to which it belongs (coded to allow it to be held in reverse\r
-priority order). However, it is occasionally borrowed for other purposes. It\r
-is important its value is not updated due to a task priority change while it is\r
-being used for another purpose. The following bit definition is used to inform\r
-the scheduler that the value should not be changed - in which case it is the\r
-responsibility of whichever module is using the value to ensure it gets set back\r
-to its original value when it is released. */\r
-#if( configUSE_16_BIT_TICKS == 1 )\r
- #define taskEVENT_LIST_ITEM_VALUE_IN_USE 0x8000U\r
-#else\r
- #define taskEVENT_LIST_ITEM_VALUE_IN_USE 0x80000000UL\r
-#endif\r
-\r
-/*\r
- * Task control block. A task control block (TCB) is allocated for each task,\r
- * and stores task state information, including a pointer to the task's context\r
- * (the task's run time environment, including register values)\r
- */\r
-typedef struct tskTaskControlBlock\r
-{\r
- volatile StackType_t *pxTopOfStack; /*< Points to the location of the last item placed on the tasks stack. THIS MUST BE THE FIRST MEMBER OF THE TCB STRUCT. */\r
-\r
- #if ( portUSING_MPU_WRAPPERS == 1 )\r
- xMPU_SETTINGS xMPUSettings; /*< The MPU settings are defined as part of the port layer. THIS MUST BE THE SECOND MEMBER OF THE TCB STRUCT. */\r
- #endif\r
-\r
- ListItem_t xStateListItem; /*< The list that the state list item of a task is reference from denotes the state of that task (Ready, Blocked, Suspended ). */\r
- ListItem_t xEventListItem; /*< Used to reference a task from an event list. */\r
- UBaseType_t uxPriority; /*< The priority of the task. 0 is the lowest priority. */\r
- StackType_t *pxStack; /*< Points to the start of the stack. */\r
- char pcTaskName[ configMAX_TASK_NAME_LEN ];/*< Descriptive name given to the task when created. Facilitates debugging only. */ /*lint !e971 Unqualified char types are allowed for strings and single characters only. */\r
-\r
- #if ( ( portSTACK_GROWTH > 0 ) || ( configRECORD_STACK_HIGH_ADDRESS == 1 ) )\r
- StackType_t *pxEndOfStack; /*< Points to the highest valid address for the stack. */\r
- #endif\r
-\r
- #if ( portCRITICAL_NESTING_IN_TCB == 1 )\r
- UBaseType_t uxCriticalNesting; /*< Holds the critical section nesting depth for ports that do not maintain their own count in the port layer. */\r
- #endif\r
-\r
- #if ( configUSE_TRACE_FACILITY == 1 )\r
- UBaseType_t uxTCBNumber; /*< Stores a number that increments each time a TCB is created. It allows debuggers to determine when a task has been deleted and then recreated. */\r
- UBaseType_t uxTaskNumber; /*< Stores a number specifically for use by third party trace code. */\r
- #endif\r
-\r
- #if ( configUSE_MUTEXES == 1 )\r
- UBaseType_t uxBasePriority; /*< The priority last assigned to the task - used by the priority inheritance mechanism. */\r
- UBaseType_t uxMutexesHeld;\r
- #endif\r
-\r
- #if ( configUSE_APPLICATION_TASK_TAG == 1 )\r
- TaskHookFunction_t pxTaskTag;\r
- #endif\r
-\r
- #if( configNUM_THREAD_LOCAL_STORAGE_POINTERS > 0 )\r
- void *pvThreadLocalStoragePointers[ configNUM_THREAD_LOCAL_STORAGE_POINTERS ];\r
- #endif\r
-\r
- #if( configGENERATE_RUN_TIME_STATS == 1 )\r
- uint32_t ulRunTimeCounter; /*< Stores the amount of time the task has spent in the Running state. */\r
- #endif\r
-\r
- #if ( configUSE_NEWLIB_REENTRANT == 1 )\r
- /* Allocate a Newlib reent structure that is specific to this task.\r
- Note Newlib support has been included by popular demand, but is not\r
- used by the FreeRTOS maintainers themselves. FreeRTOS is not\r
- responsible for resulting newlib operation. User must be familiar with\r
- newlib and must provide system-wide implementations of the necessary\r
- stubs. Be warned that (at the time of writing) the current newlib design\r
- implements a system-wide malloc() that must be provided with locks. */\r
- struct _reent xNewLib_reent;\r
- #endif\r
-\r
- #if( configUSE_TASK_NOTIFICATIONS == 1 )\r
- volatile uint32_t ulNotifiedValue;\r
- volatile uint8_t ucNotifyState;\r
- #endif\r
-\r
- /* See the comments above the definition of\r
- tskSTATIC_AND_DYNAMIC_ALLOCATION_POSSIBLE. */\r
- #if( tskSTATIC_AND_DYNAMIC_ALLOCATION_POSSIBLE != 0 ) /*lint !e731 Macro has been consolidated for readability reasons. */\r
- uint8_t ucStaticallyAllocated; /*< Set to pdTRUE if the task is a statically allocated to ensure no attempt is made to free the memory. */\r
- #endif\r
-\r
- #if( INCLUDE_xTaskAbortDelay == 1 )\r
- uint8_t ucDelayAborted;\r
- #endif\r
-\r
-} tskTCB;\r
-\r
-/* The old tskTCB name is maintained above then typedefed to the new TCB_t name\r
-below to enable the use of older kernel aware debuggers. */\r
-typedef tskTCB TCB_t;\r
-\r
-/*lint -save -e956 A manual analysis and inspection has been used to determine\r
-which static variables must be declared volatile. */\r
-\r
-PRIVILEGED_DATA TCB_t * volatile pxCurrentTCB = NULL;\r
-\r
-/* Lists for ready and blocked tasks. --------------------*/\r
-PRIVILEGED_DATA static List_t pxReadyTasksLists[ configMAX_PRIORITIES ];/*< Prioritised ready tasks. */\r
-PRIVILEGED_DATA static List_t xDelayedTaskList1; /*< Delayed tasks. */\r
-PRIVILEGED_DATA static List_t xDelayedTaskList2; /*< Delayed tasks (two lists are used - one for delays that have overflowed the current tick count. */\r
-PRIVILEGED_DATA static List_t * volatile pxDelayedTaskList; /*< Points to the delayed task list currently being used. */\r
-PRIVILEGED_DATA static List_t * volatile pxOverflowDelayedTaskList; /*< Points to the delayed task list currently being used to hold tasks that have overflowed the current tick count. */\r
-PRIVILEGED_DATA static List_t xPendingReadyList; /*< Tasks that have been readied while the scheduler was suspended. They will be moved to the ready list when the scheduler is resumed. */\r
-\r
-#if( INCLUDE_vTaskDelete == 1 )\r
-\r
- PRIVILEGED_DATA static List_t xTasksWaitingTermination; /*< Tasks that have been deleted - but their memory not yet freed. */\r
- PRIVILEGED_DATA static volatile UBaseType_t uxDeletedTasksWaitingCleanUp = ( UBaseType_t ) 0U;\r
-\r
-#endif\r
-\r
-#if ( INCLUDE_vTaskSuspend == 1 )\r
-\r
- PRIVILEGED_DATA static List_t xSuspendedTaskList; /*< Tasks that are currently suspended. */\r
-\r
-#endif\r
-\r
-/* Other file private variables. --------------------------------*/\r
-PRIVILEGED_DATA static volatile UBaseType_t uxCurrentNumberOfTasks = ( UBaseType_t ) 0U;\r
-PRIVILEGED_DATA static volatile TickType_t xTickCount = ( TickType_t ) configINITIAL_TICK_COUNT;\r
-PRIVILEGED_DATA static volatile UBaseType_t uxTopReadyPriority = tskIDLE_PRIORITY;\r
-PRIVILEGED_DATA static volatile BaseType_t xSchedulerRunning = pdFALSE;\r
-PRIVILEGED_DATA static volatile UBaseType_t uxPendedTicks = ( UBaseType_t ) 0U;\r
-PRIVILEGED_DATA static volatile BaseType_t xYieldPending = pdFALSE;\r
-PRIVILEGED_DATA static volatile BaseType_t xNumOfOverflows = ( BaseType_t ) 0;\r
-PRIVILEGED_DATA static UBaseType_t uxTaskNumber = ( UBaseType_t ) 0U;\r
-PRIVILEGED_DATA static volatile TickType_t xNextTaskUnblockTime = ( TickType_t ) 0U; /* Initialised to portMAX_DELAY before the scheduler starts. */\r
-PRIVILEGED_DATA static TaskHandle_t xIdleTaskHandle = NULL; /*< Holds the handle of the idle task. The idle task is created automatically when the scheduler is started. */\r
-\r
-/* Context switches are held pending while the scheduler is suspended. Also,\r
-interrupts must not manipulate the xStateListItem of a TCB, or any of the\r
-lists the xStateListItem can be referenced from, if the scheduler is suspended.\r
-If an interrupt needs to unblock a task while the scheduler is suspended then it\r
-moves the task's event list item into the xPendingReadyList, ready for the\r
-kernel to move the task from the pending ready list into the real ready list\r
-when the scheduler is unsuspended. The pending ready list itself can only be\r
-accessed from a critical section. */\r
-PRIVILEGED_DATA static volatile UBaseType_t uxSchedulerSuspended = ( UBaseType_t ) pdFALSE;\r
-\r
-#if ( configGENERATE_RUN_TIME_STATS == 1 )\r
-\r
- PRIVILEGED_DATA static uint32_t ulTaskSwitchedInTime = 0UL; /*< Holds the value of a timer/counter the last time a task was switched in. */\r
- PRIVILEGED_DATA static uint32_t ulTotalRunTime = 0UL; /*< Holds the total amount of execution time as defined by the run time counter clock. */\r
-\r
-#endif\r
-\r
-/*lint -restore */\r
-\r
-/*-----------------------------------------------------------*/\r
-\r
-/* Callback function prototypes. --------------------------*/\r
-#if( configCHECK_FOR_STACK_OVERFLOW > 0 )\r
-\r
- extern void vApplicationStackOverflowHook( TaskHandle_t xTask, char *pcTaskName );\r
-\r
-#endif\r
-\r
-#if( configUSE_TICK_HOOK > 0 )\r
-\r
- extern void vApplicationTickHook( void );\r
-\r
-#endif\r
-\r
-#if( configSUPPORT_STATIC_ALLOCATION == 1 )\r
-\r
- extern void vApplicationGetIdleTaskMemory( StaticTask_t **ppxIdleTaskTCBBuffer, StackType_t **ppxIdleTaskStackBuffer, uint32_t *pulIdleTaskStackSize );\r
-\r
-#endif\r
-\r
-/* File private functions. --------------------------------*/\r
-\r
-/**\r
- * Utility task that simply returns pdTRUE if the task referenced by xTask is\r
- * currently in the Suspended state, or pdFALSE if the task referenced by xTask\r
- * is in any other state.\r
- */\r
-#if ( INCLUDE_vTaskSuspend == 1 )\r
-\r
- static BaseType_t prvTaskIsTaskSuspended( const TaskHandle_t xTask ) PRIVILEGED_FUNCTION;\r
-\r
-#endif /* INCLUDE_vTaskSuspend */\r
-\r
-/*\r
- * Utility to ready all the lists used by the scheduler. This is called\r
- * automatically upon the creation of the first task.\r
- */\r
-static void prvInitialiseTaskLists( void ) PRIVILEGED_FUNCTION;\r
-\r
-/*\r
- * The idle task, which as all tasks is implemented as a never ending loop.\r
- * The idle task is automatically created and added to the ready lists upon\r
- * creation of the first user task.\r
- *\r
- * The portTASK_FUNCTION_PROTO() macro is used to allow port/compiler specific\r
- * language extensions. The equivalent prototype for this function is:\r
- *\r
- * void prvIdleTask( void *pvParameters );\r
- *\r
- */\r
-static portTASK_FUNCTION_PROTO( prvIdleTask, pvParameters );\r
-\r
-/*\r
- * Utility to free all memory allocated by the scheduler to hold a TCB,\r
- * including the stack pointed to by the TCB.\r
- *\r
- * This does not free memory allocated by the task itself (i.e. memory\r
- * allocated by calls to pvPortMalloc from within the tasks application code).\r
- */\r
-#if ( INCLUDE_vTaskDelete == 1 )\r
-\r
- static void prvDeleteTCB( TCB_t *pxTCB ) PRIVILEGED_FUNCTION;\r
-\r
-#endif\r
-\r
-/*\r
- * Used only by the idle task. This checks to see if anything has been placed\r
- * in the list of tasks waiting to be deleted. If so the task is cleaned up\r
- * and its TCB deleted.\r
- */\r
-static void prvCheckTasksWaitingTermination( void ) PRIVILEGED_FUNCTION;\r
-\r
-/*\r
- * The currently executing task is entering the Blocked state. Add the task to\r
- * either the current or the overflow delayed task list.\r
- */\r
-static void prvAddCurrentTaskToDelayedList( TickType_t xTicksToWait, const BaseType_t xCanBlockIndefinitely ) PRIVILEGED_FUNCTION;\r
-\r
-/*\r
- * Fills an TaskStatus_t structure with information on each task that is\r
- * referenced from the pxList list (which may be a ready list, a delayed list,\r
- * a suspended list, etc.).\r
- *\r
- * THIS FUNCTION IS INTENDED FOR DEBUGGING ONLY, AND SHOULD NOT BE CALLED FROM\r
- * NORMAL APPLICATION CODE.\r
- */\r
-#if ( configUSE_TRACE_FACILITY == 1 )\r
-\r
- static UBaseType_t prvListTasksWithinSingleList( TaskStatus_t *pxTaskStatusArray, List_t *pxList, eTaskState eState ) PRIVILEGED_FUNCTION;\r
-\r
-#endif\r
-\r
-/*\r
- * Searches pxList for a task with name pcNameToQuery - returning a handle to\r
- * the task if it is found, or NULL if the task is not found.\r
- */\r
-#if ( INCLUDE_xTaskGetHandle == 1 )\r
-\r
- static TCB_t *prvSearchForNameWithinSingleList( List_t *pxList, const char pcNameToQuery[] ) PRIVILEGED_FUNCTION;\r
-\r
-#endif\r
-\r
-/*\r
- * When a task is created, the stack of the task is filled with a known value.\r
- * This function determines the 'high water mark' of the task stack by\r
- * determining how much of the stack remains at the original preset value.\r
- */\r
-#if ( ( configUSE_TRACE_FACILITY == 1 ) || ( INCLUDE_uxTaskGetStackHighWaterMark == 1 ) )\r
-\r
- static uint16_t prvTaskCheckFreeStackSpace( const uint8_t * pucStackByte ) PRIVILEGED_FUNCTION;\r
-\r
-#endif\r
-\r
-/*\r
- * Return the amount of time, in ticks, that will pass before the kernel will\r
- * next move a task from the Blocked state to the Running state.\r
- *\r
- * This conditional compilation should use inequality to 0, not equality to 1.\r
- * This is to ensure portSUPPRESS_TICKS_AND_SLEEP() can be called when user\r
- * defined low power mode implementations require configUSE_TICKLESS_IDLE to be\r
- * set to a value other than 1.\r
- */\r
-#if ( configUSE_TICKLESS_IDLE != 0 )\r
-\r
- static TickType_t prvGetExpectedIdleTime( void ) PRIVILEGED_FUNCTION;\r
-\r
-#endif\r
-\r
-/*\r
- * Set xNextTaskUnblockTime to the time at which the next Blocked state task\r
- * will exit the Blocked state.\r
- */\r
-static void prvResetNextTaskUnblockTime( void );\r
-\r
-#if ( ( configUSE_TRACE_FACILITY == 1 ) && ( configUSE_STATS_FORMATTING_FUNCTIONS > 0 ) )\r
-\r
- /*\r
- * Helper function used to pad task names with spaces when printing out\r
- * human readable tables of task information.\r
- */\r
- static char *prvWriteNameToBuffer( char *pcBuffer, const char *pcTaskName ) PRIVILEGED_FUNCTION;\r
-\r
-#endif\r
-\r
-/*\r
- * Called after a Task_t structure has been allocated either statically or\r
- * dynamically to fill in the structure's members.\r
- */\r
-static void prvInitialiseNewTask( TaskFunction_t pxTaskCode,\r
- const char * const pcName, /*lint !e971 Unqualified char types are allowed for strings and single characters only. */\r
- const uint32_t ulStackDepth,\r
- void * const pvParameters,\r
- UBaseType_t uxPriority,\r
- TaskHandle_t * const pxCreatedTask,\r
- TCB_t *pxNewTCB,\r
- const MemoryRegion_t * const xRegions ) PRIVILEGED_FUNCTION;\r
-\r
-/*\r
- * Called after a new task has been created and initialised to place the task\r
- * under the control of the scheduler.\r
- */\r
-static void prvAddNewTaskToReadyList( TCB_t *pxNewTCB ) PRIVILEGED_FUNCTION;\r
-\r
-/*\r
- * freertos_tasks_c_additions_init() should only be called if the user definable\r
- * macro FREERTOS_TASKS_C_ADDITIONS_INIT() is defined, as that is the only macro\r
- * called by the function.\r
- */\r
-#ifdef FREERTOS_TASKS_C_ADDITIONS_INIT\r
-\r
- static void freertos_tasks_c_additions_init( void ) PRIVILEGED_FUNCTION;\r
-\r
-#endif\r
-\r
-/*-----------------------------------------------------------*/\r
-\r
-#if( configSUPPORT_STATIC_ALLOCATION == 1 )\r
-\r
- TaskHandle_t xTaskCreateStatic( TaskFunction_t pxTaskCode,\r
- const char * const pcName, /*lint !e971 Unqualified char types are allowed for strings and single characters only. */\r
- const uint32_t ulStackDepth,\r
- void * const pvParameters,\r
- UBaseType_t uxPriority,\r
- StackType_t * const puxStackBuffer,\r
- StaticTask_t * const pxTaskBuffer )\r
- {\r
- TCB_t *pxNewTCB;\r
- TaskHandle_t xReturn;\r
-\r
- configASSERT( puxStackBuffer != NULL );\r
- configASSERT( pxTaskBuffer != NULL );\r
-\r
- #if( configASSERT_DEFINED == 1 )\r
- {\r
- /* Sanity check that the size of the structure used to declare a\r
- variable of type StaticTask_t equals the size of the real task\r
- structure. */\r
- volatile size_t xSize = sizeof( StaticTask_t );\r
- configASSERT( xSize == sizeof( TCB_t ) );\r
- }\r
- #endif /* configASSERT_DEFINED */\r
-\r
-\r
- if( ( pxTaskBuffer != NULL ) && ( puxStackBuffer != NULL ) )\r
- {\r
- /* The memory used for the task's TCB and stack are passed into this\r
- function - use them. */\r
- pxNewTCB = ( TCB_t * ) pxTaskBuffer; /*lint !e740 Unusual cast is ok as the structures are designed to have the same alignment, and the size is checked by an assert. */\r
- pxNewTCB->pxStack = ( StackType_t * ) puxStackBuffer;\r
-\r
- #if( tskSTATIC_AND_DYNAMIC_ALLOCATION_POSSIBLE != 0 ) /*lint !e731 Macro has been consolidated for readability reasons. */\r
- {\r
- /* Tasks can be created statically or dynamically, so note this\r
- task was created statically in case the task is later deleted. */\r
- pxNewTCB->ucStaticallyAllocated = tskSTATICALLY_ALLOCATED_STACK_AND_TCB;\r
- }\r
- #endif /* configSUPPORT_DYNAMIC_ALLOCATION */\r
-\r
- prvInitialiseNewTask( pxTaskCode, pcName, ulStackDepth, pvParameters, uxPriority, &xReturn, pxNewTCB, NULL );\r
- prvAddNewTaskToReadyList( pxNewTCB );\r
- }\r
- else\r
- {\r
- xReturn = NULL;\r
- }\r
-\r
- return xReturn;\r
- }\r
-\r
-#endif /* SUPPORT_STATIC_ALLOCATION */\r
-/*-----------------------------------------------------------*/\r
-\r
-#if( ( portUSING_MPU_WRAPPERS == 1 ) && ( configSUPPORT_STATIC_ALLOCATION == 1 ) )\r
-\r
- BaseType_t xTaskCreateRestrictedStatic( const TaskParameters_t * const pxTaskDefinition, TaskHandle_t *pxCreatedTask )\r
- {\r
- TCB_t *pxNewTCB;\r
- BaseType_t xReturn = errCOULD_NOT_ALLOCATE_REQUIRED_MEMORY;\r
-\r
- configASSERT( pxTaskDefinition->puxStackBuffer != NULL );\r
- configASSERT( pxTaskDefinition->pxTaskBuffer != NULL );\r
-\r
- if( ( pxTaskDefinition->puxStackBuffer != NULL ) && ( pxTaskDefinition->pxTaskBuffer != NULL ) )\r
- {\r
- /* Allocate space for the TCB. Where the memory comes from depends\r
- on the implementation of the port malloc function and whether or\r
- not static allocation is being used. */\r
- pxNewTCB = ( TCB_t * ) pxTaskDefinition->pxTaskBuffer;\r
-\r
- /* Store the stack location in the TCB. */\r
- pxNewTCB->pxStack = pxTaskDefinition->puxStackBuffer;\r
-\r
- #if( tskSTATIC_AND_DYNAMIC_ALLOCATION_POSSIBLE != 0 )\r
- {\r
- /* Tasks can be created statically or dynamically, so note this\r
- task was created statically in case the task is later deleted. */\r
- pxNewTCB->ucStaticallyAllocated = tskSTATICALLY_ALLOCATED_STACK_AND_TCB;\r
- }\r
- #endif /* configSUPPORT_DYNAMIC_ALLOCATION */\r
-\r
- prvInitialiseNewTask( pxTaskDefinition->pvTaskCode,\r
- pxTaskDefinition->pcName,\r
- ( uint32_t ) pxTaskDefinition->usStackDepth,\r
- pxTaskDefinition->pvParameters,\r
- pxTaskDefinition->uxPriority,\r
- pxCreatedTask, pxNewTCB,\r
- pxTaskDefinition->xRegions );\r
-\r
- prvAddNewTaskToReadyList( pxNewTCB );\r
- xReturn = pdPASS;\r
- }\r
-\r
- return xReturn;\r
- }\r
-\r
-#endif /* ( portUSING_MPU_WRAPPERS == 1 ) && ( configSUPPORT_STATIC_ALLOCATION == 1 ) */\r
-/*-----------------------------------------------------------*/\r
-\r
-#if( ( portUSING_MPU_WRAPPERS == 1 ) && ( configSUPPORT_DYNAMIC_ALLOCATION == 1 ) )\r
-\r
- BaseType_t xTaskCreateRestricted( const TaskParameters_t * const pxTaskDefinition, TaskHandle_t *pxCreatedTask )\r
- {\r
- TCB_t *pxNewTCB;\r
- BaseType_t xReturn = errCOULD_NOT_ALLOCATE_REQUIRED_MEMORY;\r
-\r
- configASSERT( pxTaskDefinition->puxStackBuffer );\r
-\r
- if( pxTaskDefinition->puxStackBuffer != NULL )\r
- {\r
- /* Allocate space for the TCB. Where the memory comes from depends\r
- on the implementation of the port malloc function and whether or\r
- not static allocation is being used. */\r
- pxNewTCB = ( TCB_t * ) pvPortMalloc( sizeof( TCB_t ) );\r
-\r
- if( pxNewTCB != NULL )\r
- {\r
- /* Store the stack location in the TCB. */\r
- pxNewTCB->pxStack = pxTaskDefinition->puxStackBuffer;\r
-\r
- #if( configSUPPORT_STATIC_ALLOCATION == 1 )\r
- {\r
- /* Tasks can be created statically or dynamically, so note\r
- this task had a statically allocated stack in case it is\r
- later deleted. The TCB was allocated dynamically. */\r
- pxNewTCB->ucStaticallyAllocated = tskSTATICALLY_ALLOCATED_STACK_ONLY;\r
- }\r
- #endif\r
-\r
- prvInitialiseNewTask( pxTaskDefinition->pvTaskCode,\r
- pxTaskDefinition->pcName,\r
- ( uint32_t ) pxTaskDefinition->usStackDepth,\r
- pxTaskDefinition->pvParameters,\r
- pxTaskDefinition->uxPriority,\r
- pxCreatedTask, pxNewTCB,\r
- pxTaskDefinition->xRegions );\r
-\r
- prvAddNewTaskToReadyList( pxNewTCB );\r
- xReturn = pdPASS;\r
- }\r
- }\r
-\r
- return xReturn;\r
- }\r
-\r
-#endif /* portUSING_MPU_WRAPPERS */\r
-/*-----------------------------------------------------------*/\r
-\r
-#if( configSUPPORT_DYNAMIC_ALLOCATION == 1 )\r
-\r
- BaseType_t xTaskCreate( TaskFunction_t pxTaskCode,\r
- const char * const pcName, /*lint !e971 Unqualified char types are allowed for strings and single characters only. */\r
- const configSTACK_DEPTH_TYPE usStackDepth,\r
- void * const pvParameters,\r
- UBaseType_t uxPriority,\r
- TaskHandle_t * const pxCreatedTask )\r
- {\r
- TCB_t *pxNewTCB;\r
- BaseType_t xReturn;\r
-\r
- /* If the stack grows down then allocate the stack then the TCB so the stack\r
- does not grow into the TCB. Likewise if the stack grows up then allocate\r
- the TCB then the stack. */\r
- #if( portSTACK_GROWTH > 0 )\r
- {\r
- /* Allocate space for the TCB. Where the memory comes from depends on\r
- the implementation of the port malloc function and whether or not static\r
- allocation is being used. */\r
- pxNewTCB = ( TCB_t * ) pvPortMalloc( sizeof( TCB_t ) );\r
-\r
- if( pxNewTCB != NULL )\r
- {\r
- /* Allocate space for the stack used by the task being created.\r
- The base of the stack memory stored in the TCB so the task can\r
- be deleted later if required. */\r
- pxNewTCB->pxStack = ( StackType_t * ) pvPortMalloc( ( ( ( size_t ) usStackDepth ) * sizeof( StackType_t ) ) ); /*lint !e961 MISRA exception as the casts are only redundant for some ports. */\r
-\r
- if( pxNewTCB->pxStack == NULL )\r
- {\r
- /* Could not allocate the stack. Delete the allocated TCB. */\r
- vPortFree( pxNewTCB );\r
- pxNewTCB = NULL;\r
- }\r
- }\r
- }\r
- #else /* portSTACK_GROWTH */\r
- {\r
- StackType_t *pxStack;\r
-\r
- /* Allocate space for the stack used by the task being created. */\r
- pxStack = ( StackType_t * ) pvPortMalloc( ( ( ( size_t ) usStackDepth ) * sizeof( StackType_t ) ) ); /*lint !e961 MISRA exception as the casts are only redundant for some ports. */\r
-\r
- if( pxStack != NULL )\r
- {\r
- /* Allocate space for the TCB. */\r
- pxNewTCB = ( TCB_t * ) pvPortMalloc( sizeof( TCB_t ) ); /*lint !e961 MISRA exception as the casts are only redundant for some paths. */\r
-\r
- if( pxNewTCB != NULL )\r
- {\r
- /* Store the stack location in the TCB. */\r
- pxNewTCB->pxStack = pxStack;\r
- }\r
- else\r
- {\r
- /* The stack cannot be used as the TCB was not created. Free\r
- it again. */\r
- vPortFree( pxStack );\r
- }\r
- }\r
- else\r
- {\r
- pxNewTCB = NULL;\r
- }\r
- }\r
- #endif /* portSTACK_GROWTH */\r
-\r
- if( pxNewTCB != NULL )\r
- {\r
- #if( tskSTATIC_AND_DYNAMIC_ALLOCATION_POSSIBLE != 0 ) /*lint !e731 Macro has been consolidated for readability reasons. */\r
- {\r
- /* Tasks can be created statically or dynamically, so note this\r
- task was created dynamically in case it is later deleted. */\r
- pxNewTCB->ucStaticallyAllocated = tskDYNAMICALLY_ALLOCATED_STACK_AND_TCB;\r
- }\r
- #endif /* configSUPPORT_STATIC_ALLOCATION */\r
-\r
- prvInitialiseNewTask( pxTaskCode, pcName, ( uint32_t ) usStackDepth, pvParameters, uxPriority, pxCreatedTask, pxNewTCB, NULL );\r
- prvAddNewTaskToReadyList( pxNewTCB );\r
- xReturn = pdPASS;\r
- }\r
- else\r
- {\r
- xReturn = errCOULD_NOT_ALLOCATE_REQUIRED_MEMORY;\r
- }\r
-\r
- return xReturn;\r
- }\r
-\r
-#endif /* configSUPPORT_DYNAMIC_ALLOCATION */\r
-/*-----------------------------------------------------------*/\r
-\r
-static void prvInitialiseNewTask( TaskFunction_t pxTaskCode,\r
- const char * const pcName, /*lint !e971 Unqualified char types are allowed for strings and single characters only. */\r
- const uint32_t ulStackDepth,\r
- void * const pvParameters,\r
- UBaseType_t uxPriority,\r
- TaskHandle_t * const pxCreatedTask,\r
- TCB_t *pxNewTCB,\r
- const MemoryRegion_t * const xRegions )\r
-{\r
-StackType_t *pxTopOfStack;\r
-UBaseType_t x;\r
-\r
- #if( portUSING_MPU_WRAPPERS == 1 )\r
- /* Should the task be created in privileged mode? */\r
- BaseType_t xRunPrivileged;\r
- if( ( uxPriority & portPRIVILEGE_BIT ) != 0U )\r
- {\r
- xRunPrivileged = pdTRUE;\r
- }\r
- else\r
- {\r
- xRunPrivileged = pdFALSE;\r
- }\r
- uxPriority &= ~portPRIVILEGE_BIT;\r
- #endif /* portUSING_MPU_WRAPPERS == 1 */\r
-\r
- /* Avoid dependency on memset() if it is not required. */\r
- #if( tskSET_NEW_STACKS_TO_KNOWN_VALUE == 1 )\r
- {\r
- /* Fill the stack with a known value to assist debugging. */\r
- ( void ) memset( pxNewTCB->pxStack, ( int ) tskSTACK_FILL_BYTE, ( size_t ) ulStackDepth * sizeof( StackType_t ) );\r
- }\r
- #endif /* tskSET_NEW_STACKS_TO_KNOWN_VALUE */\r
-\r
- /* Calculate the top of stack address. This depends on whether the stack\r
- grows from high memory to low (as per the 80x86) or vice versa.\r
- portSTACK_GROWTH is used to make the result positive or negative as required\r
- by the port. */\r
- #if( portSTACK_GROWTH < 0 )\r
- {\r
- pxTopOfStack = pxNewTCB->pxStack + ( ulStackDepth - ( uint32_t ) 1 );\r
- pxTopOfStack = ( StackType_t * ) ( ( ( portPOINTER_SIZE_TYPE ) pxTopOfStack ) & ( ~( ( portPOINTER_SIZE_TYPE ) portBYTE_ALIGNMENT_MASK ) ) ); /*lint !e923 MISRA exception. Avoiding casts between pointers and integers is not practical. Size differences accounted for using portPOINTER_SIZE_TYPE type. */\r
-\r
- /* Check the alignment of the calculated top of stack is correct. */\r
- configASSERT( ( ( ( portPOINTER_SIZE_TYPE ) pxTopOfStack & ( portPOINTER_SIZE_TYPE ) portBYTE_ALIGNMENT_MASK ) == 0UL ) );\r
-\r
- #if( configRECORD_STACK_HIGH_ADDRESS == 1 )\r
- {\r
- /* Also record the stack's high address, which may assist\r
- debugging. */\r
- pxNewTCB->pxEndOfStack = pxTopOfStack;\r
- }\r
- #endif /* configRECORD_STACK_HIGH_ADDRESS */\r
- }\r
- #else /* portSTACK_GROWTH */\r
- {\r
- pxTopOfStack = pxNewTCB->pxStack;\r
-\r
- /* Check the alignment of the stack buffer is correct. */\r
- configASSERT( ( ( ( portPOINTER_SIZE_TYPE ) pxNewTCB->pxStack & ( portPOINTER_SIZE_TYPE ) portBYTE_ALIGNMENT_MASK ) == 0UL ) );\r
-\r
- /* The other extreme of the stack space is required if stack checking is\r
- performed. */\r
- pxNewTCB->pxEndOfStack = pxNewTCB->pxStack + ( ulStackDepth - ( uint32_t ) 1 );\r
- }\r
- #endif /* portSTACK_GROWTH */\r
-\r
- /* Store the task name in the TCB. */\r
- for( x = ( UBaseType_t ) 0; x < ( UBaseType_t ) configMAX_TASK_NAME_LEN; x++ )\r
- {\r
- pxNewTCB->pcTaskName[ x ] = pcName[ x ];\r
-\r
- /* Don't copy all configMAX_TASK_NAME_LEN if the string is shorter than\r
- configMAX_TASK_NAME_LEN characters just in case the memory after the\r
- string is not accessible (extremely unlikely). */\r
- if( pcName[ x ] == 0x00 )\r
- {\r
- break;\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
-\r
- /* Ensure the name string is terminated in the case that the string length\r
- was greater or equal to configMAX_TASK_NAME_LEN. */\r
- pxNewTCB->pcTaskName[ configMAX_TASK_NAME_LEN - 1 ] = '\0';\r
-\r
- /* This is used as an array index so must ensure it's not too large. First\r
- remove the privilege bit if one is present. */\r
- if( uxPriority >= ( UBaseType_t ) configMAX_PRIORITIES )\r
- {\r
- uxPriority = ( UBaseType_t ) configMAX_PRIORITIES - ( UBaseType_t ) 1U;\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
-\r
- pxNewTCB->uxPriority = uxPriority;\r
- #if ( configUSE_MUTEXES == 1 )\r
- {\r
- pxNewTCB->uxBasePriority = uxPriority;\r
- pxNewTCB->uxMutexesHeld = 0;\r
- }\r
- #endif /* configUSE_MUTEXES */\r
-\r
- vListInitialiseItem( &( pxNewTCB->xStateListItem ) );\r
- vListInitialiseItem( &( pxNewTCB->xEventListItem ) );\r
-\r
- /* Set the pxNewTCB as a link back from the ListItem_t. This is so we can get\r
- back to the containing TCB from a generic item in a list. */\r
- listSET_LIST_ITEM_OWNER( &( pxNewTCB->xStateListItem ), pxNewTCB );\r
-\r
- /* Event lists are always in priority order. */\r
- listSET_LIST_ITEM_VALUE( &( pxNewTCB->xEventListItem ), ( TickType_t ) configMAX_PRIORITIES - ( TickType_t ) uxPriority ); /*lint !e961 MISRA exception as the casts are only redundant for some ports. */\r
- listSET_LIST_ITEM_OWNER( &( pxNewTCB->xEventListItem ), pxNewTCB );\r
-\r
- #if ( portCRITICAL_NESTING_IN_TCB == 1 )\r
- {\r
- pxNewTCB->uxCriticalNesting = ( UBaseType_t ) 0U;\r
- }\r
- #endif /* portCRITICAL_NESTING_IN_TCB */\r
-\r
- #if ( configUSE_APPLICATION_TASK_TAG == 1 )\r
- {\r
- pxNewTCB->pxTaskTag = NULL;\r
- }\r
- #endif /* configUSE_APPLICATION_TASK_TAG */\r
-\r
- #if ( configGENERATE_RUN_TIME_STATS == 1 )\r
- {\r
- pxNewTCB->ulRunTimeCounter = 0UL;\r
- }\r
- #endif /* configGENERATE_RUN_TIME_STATS */\r
-\r
- #if ( portUSING_MPU_WRAPPERS == 1 )\r
- {\r
- vPortStoreTaskMPUSettings( &( pxNewTCB->xMPUSettings ), xRegions, pxNewTCB->pxStack, ulStackDepth );\r
- }\r
- #else\r
- {\r
- /* Avoid compiler warning about unreferenced parameter. */\r
- ( void ) xRegions;\r
- }\r
- #endif\r
-\r
- #if( configNUM_THREAD_LOCAL_STORAGE_POINTERS != 0 )\r
- {\r
- for( x = 0; x < ( UBaseType_t ) configNUM_THREAD_LOCAL_STORAGE_POINTERS; x++ )\r
- {\r
- pxNewTCB->pvThreadLocalStoragePointers[ x ] = NULL;\r
- }\r
- }\r
- #endif\r
-\r
- #if ( configUSE_TASK_NOTIFICATIONS == 1 )\r
- {\r
- pxNewTCB->ulNotifiedValue = 0;\r
- pxNewTCB->ucNotifyState = taskNOT_WAITING_NOTIFICATION;\r
- }\r
- #endif\r
-\r
- #if ( configUSE_NEWLIB_REENTRANT == 1 )\r
- {\r
- /* Initialise this task's Newlib reent structure. */\r
- _REENT_INIT_PTR( ( &( pxNewTCB->xNewLib_reent ) ) );\r
- }\r
- #endif\r
-\r
- #if( INCLUDE_xTaskAbortDelay == 1 )\r
- {\r
- pxNewTCB->ucDelayAborted = pdFALSE;\r
- }\r
- #endif\r
-\r
- /* Initialize the TCB stack to look as if the task was already running,\r
- but had been interrupted by the scheduler. The return address is set\r
- to the start of the task function. Once the stack has been initialised\r
- the top of stack variable is updated. */\r
- #if( portUSING_MPU_WRAPPERS == 1 )\r
- {\r
- pxNewTCB->pxTopOfStack = pxPortInitialiseStack( pxTopOfStack, pxTaskCode, pvParameters, xRunPrivileged );\r
- }\r
- #else /* portUSING_MPU_WRAPPERS */\r
- {\r
- pxNewTCB->pxTopOfStack = pxPortInitialiseStack( pxTopOfStack, pxTaskCode, pvParameters );\r
- }\r
- #endif /* portUSING_MPU_WRAPPERS */\r
-\r
- if( ( void * ) pxCreatedTask != NULL )\r
- {\r
- /* Pass the handle out in an anonymous way. The handle can be used to\r
- change the created task's priority, delete the created task, etc.*/\r
- *pxCreatedTask = ( TaskHandle_t ) pxNewTCB;\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
-}\r
-/*-----------------------------------------------------------*/\r
-\r
-static void prvAddNewTaskToReadyList( TCB_t *pxNewTCB )\r
-{\r
- /* Ensure interrupts don't access the task lists while the lists are being\r
- updated. */\r
- taskENTER_CRITICAL();\r
- {\r
- uxCurrentNumberOfTasks++;\r
- if( pxCurrentTCB == NULL )\r
- {\r
- /* There are no other tasks, or all the other tasks are in\r
- the suspended state - make this the current task. */\r
- pxCurrentTCB = pxNewTCB;\r
-\r
- if( uxCurrentNumberOfTasks == ( UBaseType_t ) 1 )\r
- {\r
- /* This is the first task to be created so do the preliminary\r
- initialisation required. We will not recover if this call\r
- fails, but we will report the failure. */\r
- prvInitialiseTaskLists();\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- else\r
- {\r
- /* If the scheduler is not already running, make this task the\r
- current task if it is the highest priority task to be created\r
- so far. */\r
- if( xSchedulerRunning == pdFALSE )\r
- {\r
- if( pxCurrentTCB->uxPriority <= pxNewTCB->uxPriority )\r
- {\r
- pxCurrentTCB = pxNewTCB;\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
-\r
- uxTaskNumber++;\r
-\r
- #if ( configUSE_TRACE_FACILITY == 1 )\r
- {\r
- /* Add a counter into the TCB for tracing only. */\r
- pxNewTCB->uxTCBNumber = uxTaskNumber;\r
- }\r
- #endif /* configUSE_TRACE_FACILITY */\r
- traceTASK_CREATE( pxNewTCB );\r
-\r
- prvAddTaskToReadyList( pxNewTCB );\r
-\r
- portSETUP_TCB( pxNewTCB );\r
- }\r
- taskEXIT_CRITICAL();\r
-\r
- if( xSchedulerRunning != pdFALSE )\r
- {\r
- /* If the created task is of a higher priority than the current task\r
- then it should run now. */\r
- if( pxCurrentTCB->uxPriority < pxNewTCB->uxPriority )\r
- {\r
- taskYIELD_IF_USING_PREEMPTION();\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
-}\r
-/*-----------------------------------------------------------*/\r
-\r
-#if ( INCLUDE_vTaskDelete == 1 )\r
-\r
- void vTaskDelete( TaskHandle_t xTaskToDelete )\r
- {\r
- TCB_t *pxTCB;\r
-\r
- taskENTER_CRITICAL();\r
- {\r
- /* If null is passed in here then it is the calling task that is\r
- being deleted. */\r
- pxTCB = prvGetTCBFromHandle( xTaskToDelete );\r
-\r
- /* Remove task from the ready list. */\r
- if( uxListRemove( &( pxTCB->xStateListItem ) ) == ( UBaseType_t ) 0 )\r
- {\r
- taskRESET_READY_PRIORITY( pxTCB->uxPriority );\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
-\r
- /* Is the task waiting on an event also? */\r
- if( listLIST_ITEM_CONTAINER( &( pxTCB->xEventListItem ) ) != NULL )\r
- {\r
- ( void ) uxListRemove( &( pxTCB->xEventListItem ) );\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
-\r
- /* Increment the uxTaskNumber also so kernel aware debuggers can\r
- detect that the task lists need re-generating. This is done before\r
- portPRE_TASK_DELETE_HOOK() as in the Windows port that macro will\r
- not return. */\r
- uxTaskNumber++;\r
-\r
- if( pxTCB == pxCurrentTCB )\r
- {\r
- /* A task is deleting itself. This cannot complete within the\r
- task itself, as a context switch to another task is required.\r
- Place the task in the termination list. The idle task will\r
- check the termination list and free up any memory allocated by\r
- the scheduler for the TCB and stack of the deleted task. */\r
- vListInsertEnd( &xTasksWaitingTermination, &( pxTCB->xStateListItem ) );\r
-\r
- /* Increment the ucTasksDeleted variable so the idle task knows\r
- there is a task that has been deleted and that it should therefore\r
- check the xTasksWaitingTermination list. */\r
- ++uxDeletedTasksWaitingCleanUp;\r
-\r
- /* The pre-delete hook is primarily for the Windows simulator,\r
- in which Windows specific clean up operations are performed,\r
- after which it is not possible to yield away from this task -\r
- hence xYieldPending is used to latch that a context switch is\r
- required. */\r
- portPRE_TASK_DELETE_HOOK( pxTCB, &xYieldPending );\r
- }\r
- else\r
- {\r
- --uxCurrentNumberOfTasks;\r
- prvDeleteTCB( pxTCB );\r
-\r
- /* Reset the next expected unblock time in case it referred to\r
- the task that has just been deleted. */\r
- prvResetNextTaskUnblockTime();\r
- }\r
-\r
- traceTASK_DELETE( pxTCB );\r
- }\r
- taskEXIT_CRITICAL();\r
-\r
- /* Force a reschedule if it is the currently running task that has just\r
- been deleted. */\r
- if( xSchedulerRunning != pdFALSE )\r
- {\r
- if( pxTCB == pxCurrentTCB )\r
- {\r
- configASSERT( uxSchedulerSuspended == 0 );\r
- portYIELD_WITHIN_API();\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- }\r
-\r
-#endif /* INCLUDE_vTaskDelete */\r
-/*-----------------------------------------------------------*/\r
-\r
-#if ( INCLUDE_vTaskDelayUntil == 1 )\r
-\r
- void vTaskDelayUntil( TickType_t * const pxPreviousWakeTime, const TickType_t xTimeIncrement )\r
- {\r
- TickType_t xTimeToWake;\r
- BaseType_t xAlreadyYielded, xShouldDelay = pdFALSE;\r
-\r
- configASSERT( pxPreviousWakeTime );\r
- configASSERT( ( xTimeIncrement > 0U ) );\r
- configASSERT( uxSchedulerSuspended == 0 );\r
-\r
- vTaskSuspendAll();\r
- {\r
- /* Minor optimisation. The tick count cannot change in this\r
- block. */\r
- const TickType_t xConstTickCount = xTickCount;\r
-\r
- /* Generate the tick time at which the task wants to wake. */\r
- xTimeToWake = *pxPreviousWakeTime + xTimeIncrement;\r
-\r
- if( xConstTickCount < *pxPreviousWakeTime )\r
- {\r
- /* The tick count has overflowed since this function was\r
- lasted called. In this case the only time we should ever\r
- actually delay is if the wake time has also overflowed,\r
- and the wake time is greater than the tick time. When this\r
- is the case it is as if neither time had overflowed. */\r
- if( ( xTimeToWake < *pxPreviousWakeTime ) && ( xTimeToWake > xConstTickCount ) )\r
- {\r
- xShouldDelay = pdTRUE;\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- else\r
- {\r
- /* The tick time has not overflowed. In this case we will\r
- delay if either the wake time has overflowed, and/or the\r
- tick time is less than the wake time. */\r
- if( ( xTimeToWake < *pxPreviousWakeTime ) || ( xTimeToWake > xConstTickCount ) )\r
- {\r
- xShouldDelay = pdTRUE;\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
-\r
- /* Update the wake time ready for the next call. */\r
- *pxPreviousWakeTime = xTimeToWake;\r
-\r
- if( xShouldDelay != pdFALSE )\r
- {\r
- traceTASK_DELAY_UNTIL( xTimeToWake );\r
-\r
- /* prvAddCurrentTaskToDelayedList() needs the block time, not\r
- the time to wake, so subtract the current tick count. */\r
- prvAddCurrentTaskToDelayedList( xTimeToWake - xConstTickCount, pdFALSE );\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- xAlreadyYielded = xTaskResumeAll();\r
-\r
- /* Force a reschedule if xTaskResumeAll has not already done so, we may\r
- have put ourselves to sleep. */\r
- if( xAlreadyYielded == pdFALSE )\r
- {\r
- portYIELD_WITHIN_API();\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
-\r
-#endif /* INCLUDE_vTaskDelayUntil */\r
-/*-----------------------------------------------------------*/\r
-\r
-#if ( INCLUDE_vTaskDelay == 1 )\r
-\r
- void vTaskDelay( const TickType_t xTicksToDelay )\r
- {\r
- BaseType_t xAlreadyYielded = pdFALSE;\r
-\r
- /* A delay time of zero just forces a reschedule. */\r
- if( xTicksToDelay > ( TickType_t ) 0U )\r
- {\r
- configASSERT( uxSchedulerSuspended == 0 );\r
- vTaskSuspendAll();\r
- {\r
- traceTASK_DELAY();\r
-\r
- /* A task that is removed from the event list while the\r
- scheduler is suspended will not get placed in the ready\r
- list or removed from the blocked list until the scheduler\r
- is resumed.\r
-\r
- This task cannot be in an event list as it is the currently\r
- executing task. */\r
- prvAddCurrentTaskToDelayedList( xTicksToDelay, pdFALSE );\r
- }\r
- xAlreadyYielded = xTaskResumeAll();\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
-\r
- /* Force a reschedule if xTaskResumeAll has not already done so, we may\r
- have put ourselves to sleep. */\r
- if( xAlreadyYielded == pdFALSE )\r
- {\r
- portYIELD_WITHIN_API();\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
-\r
-#endif /* INCLUDE_vTaskDelay */\r
-/*-----------------------------------------------------------*/\r
-\r
-#if( ( INCLUDE_eTaskGetState == 1 ) || ( configUSE_TRACE_FACILITY == 1 ) )\r
-\r
- eTaskState eTaskGetState( TaskHandle_t xTask )\r
- {\r
- eTaskState eReturn;\r
- List_t *pxStateList;\r
- const TCB_t * const pxTCB = ( TCB_t * ) xTask;\r
-\r
- configASSERT( pxTCB );\r
-\r
- if( pxTCB == pxCurrentTCB )\r
- {\r
- /* The task calling this function is querying its own state. */\r
- eReturn = eRunning;\r
- }\r
- else\r
- {\r
- taskENTER_CRITICAL();\r
- {\r
- pxStateList = ( List_t * ) listLIST_ITEM_CONTAINER( &( pxTCB->xStateListItem ) );\r
- }\r
- taskEXIT_CRITICAL();\r
-\r
- if( ( pxStateList == pxDelayedTaskList ) || ( pxStateList == pxOverflowDelayedTaskList ) )\r
- {\r
- /* The task being queried is referenced from one of the Blocked\r
- lists. */\r
- eReturn = eBlocked;\r
- }\r
-\r
- #if ( INCLUDE_vTaskSuspend == 1 )\r
- else if( pxStateList == &xSuspendedTaskList )\r
- {\r
- /* The task being queried is referenced from the suspended\r
- list. Is it genuinely suspended or is it block\r
- indefinitely? */\r
- if( listLIST_ITEM_CONTAINER( &( pxTCB->xEventListItem ) ) == NULL )\r
- {\r
- eReturn = eSuspended;\r
- }\r
- else\r
- {\r
- eReturn = eBlocked;\r
- }\r
- }\r
- #endif\r
-\r
- #if ( INCLUDE_vTaskDelete == 1 )\r
- else if( ( pxStateList == &xTasksWaitingTermination ) || ( pxStateList == NULL ) )\r
- {\r
- /* The task being queried is referenced from the deleted\r
- tasks list, or it is not referenced from any lists at\r
- all. */\r
- eReturn = eDeleted;\r
- }\r
- #endif\r
-\r
- else /*lint !e525 Negative indentation is intended to make use of pre-processor clearer. */\r
- {\r
- /* If the task is not in any other state, it must be in the\r
- Ready (including pending ready) state. */\r
- eReturn = eReady;\r
- }\r
- }\r
-\r
- return eReturn;\r
- } /*lint !e818 xTask cannot be a pointer to const because it is a typedef. */\r
-\r
-#endif /* INCLUDE_eTaskGetState */\r
-/*-----------------------------------------------------------*/\r
-\r
-#if ( INCLUDE_uxTaskPriorityGet == 1 )\r
-\r
- UBaseType_t uxTaskPriorityGet( TaskHandle_t xTask )\r
- {\r
- TCB_t *pxTCB;\r
- UBaseType_t uxReturn;\r
-\r
- taskENTER_CRITICAL();\r
- {\r
- /* If null is passed in here then it is the priority of the that\r
- called uxTaskPriorityGet() that is being queried. */\r
- pxTCB = prvGetTCBFromHandle( xTask );\r
- uxReturn = pxTCB->uxPriority;\r
- }\r
- taskEXIT_CRITICAL();\r
-\r
- return uxReturn;\r
- }\r
-\r
-#endif /* INCLUDE_uxTaskPriorityGet */\r
-/*-----------------------------------------------------------*/\r
-\r
-#if ( INCLUDE_uxTaskPriorityGet == 1 )\r
-\r
- UBaseType_t uxTaskPriorityGetFromISR( TaskHandle_t xTask )\r
- {\r
- TCB_t *pxTCB;\r
- UBaseType_t uxReturn, uxSavedInterruptState;\r
-\r
- /* RTOS ports that support interrupt nesting have the concept of a\r
- maximum system call (or maximum API call) interrupt priority.\r
- Interrupts that are above the maximum system call priority are keep\r
- permanently enabled, even when the RTOS kernel is in a critical section,\r
- but cannot make any calls to FreeRTOS API functions. If configASSERT()\r
- is defined in FreeRTOSConfig.h then\r
- portASSERT_IF_INTERRUPT_PRIORITY_INVALID() will result in an assertion\r
- failure if a FreeRTOS API function is called from an interrupt that has\r
- been assigned a priority above the configured maximum system call\r
- priority. Only FreeRTOS functions that end in FromISR can be called\r
- from interrupts that have been assigned a priority at or (logically)\r
- below the maximum system call interrupt priority. FreeRTOS maintains a\r
- separate interrupt safe API to ensure interrupt entry is as fast and as\r
- simple as possible. More information (albeit Cortex-M specific) is\r
- provided on the following link:\r
- http://www.freertos.org/RTOS-Cortex-M3-M4.html */\r
- portASSERT_IF_INTERRUPT_PRIORITY_INVALID();\r
-\r
- uxSavedInterruptState = portSET_INTERRUPT_MASK_FROM_ISR();\r
- {\r
- /* If null is passed in here then it is the priority of the calling\r
- task that is being queried. */\r
- pxTCB = prvGetTCBFromHandle( xTask );\r
- uxReturn = pxTCB->uxPriority;\r
- }\r
- portCLEAR_INTERRUPT_MASK_FROM_ISR( uxSavedInterruptState );\r
-\r
- return uxReturn;\r
- }\r
-\r
-#endif /* INCLUDE_uxTaskPriorityGet */\r
-/*-----------------------------------------------------------*/\r
-\r
-#if ( INCLUDE_vTaskPrioritySet == 1 )\r
-\r
- void vTaskPrioritySet( TaskHandle_t xTask, UBaseType_t uxNewPriority )\r
- {\r
- TCB_t *pxTCB;\r
- UBaseType_t uxCurrentBasePriority, uxPriorityUsedOnEntry;\r
- BaseType_t xYieldRequired = pdFALSE;\r
-\r
- configASSERT( ( uxNewPriority < configMAX_PRIORITIES ) );\r
-\r
- /* Ensure the new priority is valid. */\r
- if( uxNewPriority >= ( UBaseType_t ) configMAX_PRIORITIES )\r
- {\r
- uxNewPriority = ( UBaseType_t ) configMAX_PRIORITIES - ( UBaseType_t ) 1U;\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
-\r
- taskENTER_CRITICAL();\r
- {\r
- /* If null is passed in here then it is the priority of the calling\r
- task that is being changed. */\r
- pxTCB = prvGetTCBFromHandle( xTask );\r
-\r
- traceTASK_PRIORITY_SET( pxTCB, uxNewPriority );\r
-\r
- #if ( configUSE_MUTEXES == 1 )\r
- {\r
- uxCurrentBasePriority = pxTCB->uxBasePriority;\r
- }\r
- #else\r
- {\r
- uxCurrentBasePriority = pxTCB->uxPriority;\r
- }\r
- #endif\r
-\r
- if( uxCurrentBasePriority != uxNewPriority )\r
- {\r
- /* The priority change may have readied a task of higher\r
- priority than the calling task. */\r
- if( uxNewPriority > uxCurrentBasePriority )\r
- {\r
- if( pxTCB != pxCurrentTCB )\r
- {\r
- /* The priority of a task other than the currently\r
- running task is being raised. Is the priority being\r
- raised above that of the running task? */\r
- if( uxNewPriority >= pxCurrentTCB->uxPriority )\r
- {\r
- xYieldRequired = pdTRUE;\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- else\r
- {\r
- /* The priority of the running task is being raised,\r
- but the running task must already be the highest\r
- priority task able to run so no yield is required. */\r
- }\r
- }\r
- else if( pxTCB == pxCurrentTCB )\r
- {\r
- /* Setting the priority of the running task down means\r
- there may now be another task of higher priority that\r
- is ready to execute. */\r
- xYieldRequired = pdTRUE;\r
- }\r
- else\r
- {\r
- /* Setting the priority of any other task down does not\r
- require a yield as the running task must be above the\r
- new priority of the task being modified. */\r
- }\r
-\r
- /* Remember the ready list the task might be referenced from\r
- before its uxPriority member is changed so the\r
- taskRESET_READY_PRIORITY() macro can function correctly. */\r
- uxPriorityUsedOnEntry = pxTCB->uxPriority;\r
-\r
- #if ( configUSE_MUTEXES == 1 )\r
- {\r
- /* Only change the priority being used if the task is not\r
- currently using an inherited priority. */\r
- if( pxTCB->uxBasePriority == pxTCB->uxPriority )\r
- {\r
- pxTCB->uxPriority = uxNewPriority;\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
-\r
- /* The base priority gets set whatever. */\r
- pxTCB->uxBasePriority = uxNewPriority;\r
- }\r
- #else\r
- {\r
- pxTCB->uxPriority = uxNewPriority;\r
- }\r
- #endif\r
-\r
- /* Only reset the event list item value if the value is not\r
- being used for anything else. */\r
- if( ( listGET_LIST_ITEM_VALUE( &( pxTCB->xEventListItem ) ) & taskEVENT_LIST_ITEM_VALUE_IN_USE ) == 0UL )\r
- {\r
- listSET_LIST_ITEM_VALUE( &( pxTCB->xEventListItem ), ( ( TickType_t ) configMAX_PRIORITIES - ( TickType_t ) uxNewPriority ) ); /*lint !e961 MISRA exception as the casts are only redundant for some ports. */\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
-\r
- /* If the task is in the blocked or suspended list we need do\r
- nothing more than change its priority variable. However, if\r
- the task is in a ready list it needs to be removed and placed\r
- in the list appropriate to its new priority. */\r
- if( listIS_CONTAINED_WITHIN( &( pxReadyTasksLists[ uxPriorityUsedOnEntry ] ), &( pxTCB->xStateListItem ) ) != pdFALSE )\r
- {\r
- /* The task is currently in its ready list - remove before\r
- adding it to it's new ready list. As we are in a critical\r
- section we can do this even if the scheduler is suspended. */\r
- if( uxListRemove( &( pxTCB->xStateListItem ) ) == ( UBaseType_t ) 0 )\r
- {\r
- /* It is known that the task is in its ready list so\r
- there is no need to check again and the port level\r
- reset macro can be called directly. */\r
- portRESET_READY_PRIORITY( uxPriorityUsedOnEntry, uxTopReadyPriority );\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- prvAddTaskToReadyList( pxTCB );\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
-\r
- if( xYieldRequired != pdFALSE )\r
- {\r
- taskYIELD_IF_USING_PREEMPTION();\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
-\r
- /* Remove compiler warning about unused variables when the port\r
- optimised task selection is not being used. */\r
- ( void ) uxPriorityUsedOnEntry;\r
- }\r
- }\r
- taskEXIT_CRITICAL();\r
- }\r
-\r
-#endif /* INCLUDE_vTaskPrioritySet */\r
-/*-----------------------------------------------------------*/\r
-\r
-#if ( INCLUDE_vTaskSuspend == 1 )\r
-\r
- void vTaskSuspend( TaskHandle_t xTaskToSuspend )\r
- {\r
- TCB_t *pxTCB;\r
-\r
- taskENTER_CRITICAL();\r
- {\r
- /* If null is passed in here then it is the running task that is\r
- being suspended. */\r
- pxTCB = prvGetTCBFromHandle( xTaskToSuspend );\r
-\r
- traceTASK_SUSPEND( pxTCB );\r
-\r
- /* Remove task from the ready/delayed list and place in the\r
- suspended list. */\r
- if( uxListRemove( &( pxTCB->xStateListItem ) ) == ( UBaseType_t ) 0 )\r
- {\r
- taskRESET_READY_PRIORITY( pxTCB->uxPriority );\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
-\r
- /* Is the task waiting on an event also? */\r
- if( listLIST_ITEM_CONTAINER( &( pxTCB->xEventListItem ) ) != NULL )\r
- {\r
- ( void ) uxListRemove( &( pxTCB->xEventListItem ) );\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
-\r
- vListInsertEnd( &xSuspendedTaskList, &( pxTCB->xStateListItem ) );\r
-\r
- #if( configUSE_TASK_NOTIFICATIONS == 1 )\r
- {\r
- if( pxTCB->ucNotifyState == taskWAITING_NOTIFICATION )\r
- {\r
- /* The task was blocked to wait for a notification, but is\r
- now suspended, so no notification was received. */\r
- pxTCB->ucNotifyState = taskNOT_WAITING_NOTIFICATION;\r
- }\r
- }\r
- #endif\r
- }\r
- taskEXIT_CRITICAL();\r
-\r
- if( xSchedulerRunning != pdFALSE )\r
- {\r
- /* Reset the next expected unblock time in case it referred to the\r
- task that is now in the Suspended state. */\r
- taskENTER_CRITICAL();\r
- {\r
- prvResetNextTaskUnblockTime();\r
- }\r
- taskEXIT_CRITICAL();\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
-\r
- if( pxTCB == pxCurrentTCB )\r
- {\r
- if( xSchedulerRunning != pdFALSE )\r
- {\r
- /* The current task has just been suspended. */\r
- configASSERT( uxSchedulerSuspended == 0 );\r
- portYIELD_WITHIN_API();\r
- }\r
- else\r
- {\r
- /* The scheduler is not running, but the task that was pointed\r
- to by pxCurrentTCB has just been suspended and pxCurrentTCB\r
- must be adjusted to point to a different task. */\r
- if( listCURRENT_LIST_LENGTH( &xSuspendedTaskList ) == uxCurrentNumberOfTasks )\r
- {\r
- /* No other tasks are ready, so set pxCurrentTCB back to\r
- NULL so when the next task is created pxCurrentTCB will\r
- be set to point to it no matter what its relative priority\r
- is. */\r
- pxCurrentTCB = NULL;\r
- }\r
- else\r
- {\r
- vTaskSwitchContext();\r
- }\r
- }\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
-\r
-#endif /* INCLUDE_vTaskSuspend */\r
-/*-----------------------------------------------------------*/\r
-\r
-#if ( INCLUDE_vTaskSuspend == 1 )\r
-\r
- static BaseType_t prvTaskIsTaskSuspended( const TaskHandle_t xTask )\r
- {\r
- BaseType_t xReturn = pdFALSE;\r
- const TCB_t * const pxTCB = ( TCB_t * ) xTask;\r
-\r
- /* Accesses xPendingReadyList so must be called from a critical\r
- section. */\r
-\r
- /* It does not make sense to check if the calling task is suspended. */\r
- configASSERT( xTask );\r
-\r
- /* Is the task being resumed actually in the suspended list? */\r
- if( listIS_CONTAINED_WITHIN( &xSuspendedTaskList, &( pxTCB->xStateListItem ) ) != pdFALSE )\r
- {\r
- /* Has the task already been resumed from within an ISR? */\r
- if( listIS_CONTAINED_WITHIN( &xPendingReadyList, &( pxTCB->xEventListItem ) ) == pdFALSE )\r
- {\r
- /* Is it in the suspended list because it is in the Suspended\r
- state, or because is is blocked with no timeout? */\r
- if( listIS_CONTAINED_WITHIN( NULL, &( pxTCB->xEventListItem ) ) != pdFALSE ) /*lint !e961. The cast is only redundant when NULL is used. */\r
- {\r
- xReturn = pdTRUE;\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
-\r
- return xReturn;\r
- } /*lint !e818 xTask cannot be a pointer to const because it is a typedef. */\r
-\r
-#endif /* INCLUDE_vTaskSuspend */\r
-/*-----------------------------------------------------------*/\r
-\r
-#if ( INCLUDE_vTaskSuspend == 1 )\r
-\r
- void vTaskResume( TaskHandle_t xTaskToResume )\r
- {\r
- TCB_t * const pxTCB = ( TCB_t * ) xTaskToResume;\r
-\r
- /* It does not make sense to resume the calling task. */\r
- configASSERT( xTaskToResume );\r
-\r
- /* The parameter cannot be NULL as it is impossible to resume the\r
- currently executing task. */\r
- if( ( pxTCB != NULL ) && ( pxTCB != pxCurrentTCB ) )\r
- {\r
- taskENTER_CRITICAL();\r
- {\r
- if( prvTaskIsTaskSuspended( pxTCB ) != pdFALSE )\r
- {\r
- traceTASK_RESUME( pxTCB );\r
-\r
- /* The ready list can be accessed even if the scheduler is\r
- suspended because this is inside a critical section. */\r
- ( void ) uxListRemove( &( pxTCB->xStateListItem ) );\r
- prvAddTaskToReadyList( pxTCB );\r
-\r
- /* A higher priority task may have just been resumed. */\r
- if( pxTCB->uxPriority >= pxCurrentTCB->uxPriority )\r
- {\r
- /* This yield may not cause the task just resumed to run,\r
- but will leave the lists in the correct state for the\r
- next yield. */\r
- taskYIELD_IF_USING_PREEMPTION();\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- taskEXIT_CRITICAL();\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
-\r
-#endif /* INCLUDE_vTaskSuspend */\r
-\r
-/*-----------------------------------------------------------*/\r
-\r
-#if ( ( INCLUDE_xTaskResumeFromISR == 1 ) && ( INCLUDE_vTaskSuspend == 1 ) )\r
-\r
- BaseType_t xTaskResumeFromISR( TaskHandle_t xTaskToResume )\r
- {\r
- BaseType_t xYieldRequired = pdFALSE;\r
- TCB_t * const pxTCB = ( TCB_t * ) xTaskToResume;\r
- UBaseType_t uxSavedInterruptStatus;\r
-\r
- configASSERT( xTaskToResume );\r
-\r
- /* RTOS ports that support interrupt nesting have the concept of a\r
- maximum system call (or maximum API call) interrupt priority.\r
- Interrupts that are above the maximum system call priority are keep\r
- permanently enabled, even when the RTOS kernel is in a critical section,\r
- but cannot make any calls to FreeRTOS API functions. If configASSERT()\r
- is defined in FreeRTOSConfig.h then\r
- portASSERT_IF_INTERRUPT_PRIORITY_INVALID() will result in an assertion\r
- failure if a FreeRTOS API function is called from an interrupt that has\r
- been assigned a priority above the configured maximum system call\r
- priority. Only FreeRTOS functions that end in FromISR can be called\r
- from interrupts that have been assigned a priority at or (logically)\r
- below the maximum system call interrupt priority. FreeRTOS maintains a\r
- separate interrupt safe API to ensure interrupt entry is as fast and as\r
- simple as possible. More information (albeit Cortex-M specific) is\r
- provided on the following link:\r
- http://www.freertos.org/RTOS-Cortex-M3-M4.html */\r
- portASSERT_IF_INTERRUPT_PRIORITY_INVALID();\r
-\r
- uxSavedInterruptStatus = portSET_INTERRUPT_MASK_FROM_ISR();\r
- {\r
- if( prvTaskIsTaskSuspended( pxTCB ) != pdFALSE )\r
- {\r
- traceTASK_RESUME_FROM_ISR( pxTCB );\r
-\r
- /* Check the ready lists can be accessed. */\r
- if( uxSchedulerSuspended == ( UBaseType_t ) pdFALSE )\r
- {\r
- /* Ready lists can be accessed so move the task from the\r
- suspended list to the ready list directly. */\r
- if( pxTCB->uxPriority >= pxCurrentTCB->uxPriority )\r
- {\r
- xYieldRequired = pdTRUE;\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
-\r
- ( void ) uxListRemove( &( pxTCB->xStateListItem ) );\r
- prvAddTaskToReadyList( pxTCB );\r
- }\r
- else\r
- {\r
- /* The delayed or ready lists cannot be accessed so the task\r
- is held in the pending ready list until the scheduler is\r
- unsuspended. */\r
- vListInsertEnd( &( xPendingReadyList ), &( pxTCB->xEventListItem ) );\r
- }\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- portCLEAR_INTERRUPT_MASK_FROM_ISR( uxSavedInterruptStatus );\r
-\r
- return xYieldRequired;\r
- }\r
-\r
-#endif /* ( ( INCLUDE_xTaskResumeFromISR == 1 ) && ( INCLUDE_vTaskSuspend == 1 ) ) */\r
-/*-----------------------------------------------------------*/\r
-\r
-void vTaskStartScheduler( void )\r
-{\r
-BaseType_t xReturn;\r
-\r
- /* Add the idle task at the lowest priority. */\r
- #if( configSUPPORT_STATIC_ALLOCATION == 1 )\r
- {\r
- StaticTask_t *pxIdleTaskTCBBuffer = NULL;\r
- StackType_t *pxIdleTaskStackBuffer = NULL;\r
- uint32_t ulIdleTaskStackSize;\r
-\r
- /* The Idle task is created using user provided RAM - obtain the\r
- address of the RAM then create the idle task. */\r
- vApplicationGetIdleTaskMemory( &pxIdleTaskTCBBuffer, &pxIdleTaskStackBuffer, &ulIdleTaskStackSize );\r
- xIdleTaskHandle = xTaskCreateStatic( prvIdleTask,\r
- configIDLE_TASK_NAME,\r
- ulIdleTaskStackSize,\r
- ( void * ) NULL, /*lint !e961. The cast is not redundant for all compilers. */\r
- ( tskIDLE_PRIORITY | portPRIVILEGE_BIT ),\r
- pxIdleTaskStackBuffer,\r
- pxIdleTaskTCBBuffer ); /*lint !e961 MISRA exception, justified as it is not a redundant explicit cast to all supported compilers. */\r
-\r
- if( xIdleTaskHandle != NULL )\r
- {\r
- xReturn = pdPASS;\r
- }\r
- else\r
- {\r
- xReturn = pdFAIL;\r
- }\r
- }\r
- #else\r
- {\r
- /* The Idle task is being created using dynamically allocated RAM. */\r
- xReturn = xTaskCreate( prvIdleTask,\r
- configIDLE_TASK_NAME,\r
- configMINIMAL_STACK_SIZE,\r
- ( void * ) NULL,\r
- ( tskIDLE_PRIORITY | portPRIVILEGE_BIT ),\r
- &xIdleTaskHandle ); /*lint !e961 MISRA exception, justified as it is not a redundant explicit cast to all supported compilers. */\r
- }\r
- #endif /* configSUPPORT_STATIC_ALLOCATION */\r
-\r
- #if ( configUSE_TIMERS == 1 )\r
- {\r
- if( xReturn == pdPASS )\r
- {\r
- xReturn = xTimerCreateTimerTask();\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- #endif /* configUSE_TIMERS */\r
-\r
- if( xReturn == pdPASS )\r
- {\r
- /* freertos_tasks_c_additions_init() should only be called if the user\r
- definable macro FREERTOS_TASKS_C_ADDITIONS_INIT() is defined, as that is\r
- the only macro called by the function. */\r
- #ifdef FREERTOS_TASKS_C_ADDITIONS_INIT\r
- {\r
- freertos_tasks_c_additions_init();\r
- }\r
- #endif\r
-\r
- /* Interrupts are turned off here, to ensure a tick does not occur\r
- before or during the call to xPortStartScheduler(). The stacks of\r
- the created tasks contain a status word with interrupts switched on\r
- so interrupts will automatically get re-enabled when the first task\r
- starts to run. */\r
- portDISABLE_INTERRUPTS();\r
-\r
- #if ( configUSE_NEWLIB_REENTRANT == 1 )\r
- {\r
- /* Switch Newlib's _impure_ptr variable to point to the _reent\r
- structure specific to the task that will run first. */\r
- _impure_ptr = &( pxCurrentTCB->xNewLib_reent );\r
- }\r
- #endif /* configUSE_NEWLIB_REENTRANT */\r
-\r
- xNextTaskUnblockTime = portMAX_DELAY;\r
- xSchedulerRunning = pdTRUE;\r
- xTickCount = ( TickType_t ) 0U;\r
-\r
- /* If configGENERATE_RUN_TIME_STATS is defined then the following\r
- macro must be defined to configure the timer/counter used to generate\r
- the run time counter time base. NOTE: If configGENERATE_RUN_TIME_STATS\r
- is set to 0 and the following line fails to build then ensure you do not\r
- have portCONFIGURE_TIMER_FOR_RUN_TIME_STATS() defined in your\r
- FreeRTOSConfig.h file. */\r
- portCONFIGURE_TIMER_FOR_RUN_TIME_STATS();\r
-\r
- /* Setting up the timer tick is hardware specific and thus in the\r
- portable interface. */\r
- if( xPortStartScheduler() != pdFALSE )\r
- {\r
- /* Should not reach here as if the scheduler is running the\r
- function will not return. */\r
- }\r
- else\r
- {\r
- /* Should only reach here if a task calls xTaskEndScheduler(). */\r
- }\r
- }\r
- else\r
- {\r
- /* This line will only be reached if the kernel could not be started,\r
- because there was not enough FreeRTOS heap to create the idle task\r
- or the timer task. */\r
- configASSERT( xReturn != errCOULD_NOT_ALLOCATE_REQUIRED_MEMORY );\r
- }\r
-\r
- /* Prevent compiler warnings if INCLUDE_xTaskGetIdleTaskHandle is set to 0,\r
- meaning xIdleTaskHandle is not used anywhere else. */\r
- ( void ) xIdleTaskHandle;\r
-}\r
-/*-----------------------------------------------------------*/\r
-\r
-void vTaskEndScheduler( void )\r
-{\r
- /* Stop the scheduler interrupts and call the portable scheduler end\r
- routine so the original ISRs can be restored if necessary. The port\r
- layer must ensure interrupts enable bit is left in the correct state. */\r
- portDISABLE_INTERRUPTS();\r
- xSchedulerRunning = pdFALSE;\r
- vPortEndScheduler();\r
-}\r
-/*----------------------------------------------------------*/\r
-\r
-void vTaskSuspendAll( void )\r
-{\r
- /* A critical section is not required as the variable is of type\r
- BaseType_t. Please read Richard Barry's reply in the following link to a\r
- post in the FreeRTOS support forum before reporting this as a bug! -\r
- http://goo.gl/wu4acr */\r
- ++uxSchedulerSuspended;\r
-}\r
-/*----------------------------------------------------------*/\r
-\r
-#if ( configUSE_TICKLESS_IDLE != 0 )\r
-\r
- static TickType_t prvGetExpectedIdleTime( void )\r
- {\r
- TickType_t xReturn;\r
- UBaseType_t uxHigherPriorityReadyTasks = pdFALSE;\r
-\r
- /* uxHigherPriorityReadyTasks takes care of the case where\r
- configUSE_PREEMPTION is 0, so there may be tasks above the idle priority\r
- task that are in the Ready state, even though the idle task is\r
- running. */\r
- #if( configUSE_PORT_OPTIMISED_TASK_SELECTION == 0 )\r
- {\r
- if( uxTopReadyPriority > tskIDLE_PRIORITY )\r
- {\r
- uxHigherPriorityReadyTasks = pdTRUE;\r
- }\r
- }\r
- #else\r
- {\r
- const UBaseType_t uxLeastSignificantBit = ( UBaseType_t ) 0x01;\r
-\r
- /* When port optimised task selection is used the uxTopReadyPriority\r
- variable is used as a bit map. If bits other than the least\r
- significant bit are set then there are tasks that have a priority\r
- above the idle priority that are in the Ready state. This takes\r
- care of the case where the co-operative scheduler is in use. */\r
- if( uxTopReadyPriority > uxLeastSignificantBit )\r
- {\r
- uxHigherPriorityReadyTasks = pdTRUE;\r
- }\r
- }\r
- #endif\r
-\r
- if( pxCurrentTCB->uxPriority > tskIDLE_PRIORITY )\r
- {\r
- xReturn = 0;\r
- }\r
- else if( listCURRENT_LIST_LENGTH( &( pxReadyTasksLists[ tskIDLE_PRIORITY ] ) ) > 1 )\r
- {\r
- /* There are other idle priority tasks in the ready state. If\r
- time slicing is used then the very next tick interrupt must be\r
- processed. */\r
- xReturn = 0;\r
- }\r
- else if( uxHigherPriorityReadyTasks != pdFALSE )\r
- {\r
- /* There are tasks in the Ready state that have a priority above the\r
- idle priority. This path can only be reached if\r
- configUSE_PREEMPTION is 0. */\r
- xReturn = 0;\r
- }\r
- else\r
- {\r
- xReturn = xNextTaskUnblockTime - xTickCount;\r
- }\r
-\r
- return xReturn;\r
- }\r
-\r
-#endif /* configUSE_TICKLESS_IDLE */\r
-/*----------------------------------------------------------*/\r
-\r
-BaseType_t xTaskResumeAll( void )\r
-{\r
-TCB_t *pxTCB = NULL;\r
-BaseType_t xAlreadyYielded = pdFALSE;\r
-\r
- /* If uxSchedulerSuspended is zero then this function does not match a\r
- previous call to vTaskSuspendAll(). */\r
- configASSERT( uxSchedulerSuspended );\r
-\r
- /* It is possible that an ISR caused a task to be removed from an event\r
- list while the scheduler was suspended. If this was the case then the\r
- removed task will have been added to the xPendingReadyList. Once the\r
- scheduler has been resumed it is safe to move all the pending ready\r
- tasks from this list into their appropriate ready list. */\r
- taskENTER_CRITICAL();\r
- {\r
- --uxSchedulerSuspended;\r
-\r
- if( uxSchedulerSuspended == ( UBaseType_t ) pdFALSE )\r
- {\r
- if( uxCurrentNumberOfTasks > ( UBaseType_t ) 0U )\r
- {\r
- /* Move any readied tasks from the pending list into the\r
- appropriate ready list. */\r
- while( listLIST_IS_EMPTY( &xPendingReadyList ) == pdFALSE )\r
- {\r
- pxTCB = ( TCB_t * ) listGET_OWNER_OF_HEAD_ENTRY( ( &xPendingReadyList ) );\r
- ( void ) uxListRemove( &( pxTCB->xEventListItem ) );\r
- ( void ) uxListRemove( &( pxTCB->xStateListItem ) );\r
- prvAddTaskToReadyList( pxTCB );\r
-\r
- /* If the moved task has a priority higher than the current\r
- task then a yield must be performed. */\r
- if( pxTCB->uxPriority >= pxCurrentTCB->uxPriority )\r
- {\r
- xYieldPending = pdTRUE;\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
-\r
- if( pxTCB != NULL )\r
- {\r
- /* A task was unblocked while the scheduler was suspended,\r
- which may have prevented the next unblock time from being\r
- re-calculated, in which case re-calculate it now. Mainly\r
- important for low power tickless implementations, where\r
- this can prevent an unnecessary exit from low power\r
- state. */\r
- prvResetNextTaskUnblockTime();\r
- }\r
-\r
- /* If any ticks occurred while the scheduler was suspended then\r
- they should be processed now. This ensures the tick count does\r
- not slip, and that any delayed tasks are resumed at the correct\r
- time. */\r
- {\r
- UBaseType_t uxPendedCounts = uxPendedTicks; /* Non-volatile copy. */\r
-\r
- if( uxPendedCounts > ( UBaseType_t ) 0U )\r
- {\r
- do\r
- {\r
- if( xTaskIncrementTick() != pdFALSE )\r
- {\r
- xYieldPending = pdTRUE;\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- --uxPendedCounts;\r
- } while( uxPendedCounts > ( UBaseType_t ) 0U );\r
-\r
- uxPendedTicks = 0;\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
-\r
- if( xYieldPending != pdFALSE )\r
- {\r
- #if( configUSE_PREEMPTION != 0 )\r
- {\r
- xAlreadyYielded = pdTRUE;\r
- }\r
- #endif\r
- taskYIELD_IF_USING_PREEMPTION();\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- taskEXIT_CRITICAL();\r
-\r
- return xAlreadyYielded;\r
-}\r
-/*-----------------------------------------------------------*/\r
-\r
-TickType_t xTaskGetTickCount( void )\r
-{\r
-TickType_t xTicks;\r
-\r
- /* Critical section required if running on a 16 bit processor. */\r
- portTICK_TYPE_ENTER_CRITICAL();\r
- {\r
- xTicks = xTickCount;\r
- }\r
- portTICK_TYPE_EXIT_CRITICAL();\r
-\r
- return xTicks;\r
-}\r
-/*-----------------------------------------------------------*/\r
-\r
-TickType_t xTaskGetTickCountFromISR( void )\r
-{\r
-TickType_t xReturn;\r
-UBaseType_t uxSavedInterruptStatus;\r
-\r
- /* RTOS ports that support interrupt nesting have the concept of a maximum\r
- system call (or maximum API call) interrupt priority. Interrupts that are\r
- above the maximum system call priority are kept permanently enabled, even\r
- when the RTOS kernel is in a critical section, but cannot make any calls to\r
- FreeRTOS API functions. If configASSERT() is defined in FreeRTOSConfig.h\r
- then portASSERT_IF_INTERRUPT_PRIORITY_INVALID() will result in an assertion\r
- failure if a FreeRTOS API function is called from an interrupt that has been\r
- assigned a priority above the configured maximum system call priority.\r
- Only FreeRTOS functions that end in FromISR can be called from interrupts\r
- that have been assigned a priority at or (logically) below the maximum\r
- system call interrupt priority. FreeRTOS maintains a separate interrupt\r
- safe API to ensure interrupt entry is as fast and as simple as possible.\r
- More information (albeit Cortex-M specific) is provided on the following\r
- link: http://www.freertos.org/RTOS-Cortex-M3-M4.html */\r
- portASSERT_IF_INTERRUPT_PRIORITY_INVALID();\r
-\r
- uxSavedInterruptStatus = portTICK_TYPE_SET_INTERRUPT_MASK_FROM_ISR();\r
- {\r
- xReturn = xTickCount;\r
- }\r
- portTICK_TYPE_CLEAR_INTERRUPT_MASK_FROM_ISR( uxSavedInterruptStatus );\r
-\r
- return xReturn;\r
-}\r
-/*-----------------------------------------------------------*/\r
-\r
-UBaseType_t uxTaskGetNumberOfTasks( void )\r
-{\r
- /* A critical section is not required because the variables are of type\r
- BaseType_t. */\r
- return uxCurrentNumberOfTasks;\r
-}\r
-/*-----------------------------------------------------------*/\r
-\r
-char *pcTaskGetName( TaskHandle_t xTaskToQuery ) /*lint !e971 Unqualified char types are allowed for strings and single characters only. */\r
-{\r
-TCB_t *pxTCB;\r
-\r
- /* If null is passed in here then the name of the calling task is being\r
- queried. */\r
- pxTCB = prvGetTCBFromHandle( xTaskToQuery );\r
- configASSERT( pxTCB );\r
- return &( pxTCB->pcTaskName[ 0 ] );\r
-}\r
-/*-----------------------------------------------------------*/\r
-\r
-#if ( INCLUDE_xTaskGetHandle == 1 )\r
-\r
- static TCB_t *prvSearchForNameWithinSingleList( List_t *pxList, const char pcNameToQuery[] )\r
- {\r
- TCB_t *pxNextTCB, *pxFirstTCB, *pxReturn = NULL;\r
- UBaseType_t x;\r
- char cNextChar;\r
-\r
- /* This function is called with the scheduler suspended. */\r
-\r
- if( listCURRENT_LIST_LENGTH( pxList ) > ( UBaseType_t ) 0 )\r
- {\r
- listGET_OWNER_OF_NEXT_ENTRY( pxFirstTCB, pxList );\r
-\r
- do\r
- {\r
- listGET_OWNER_OF_NEXT_ENTRY( pxNextTCB, pxList );\r
-\r
- /* Check each character in the name looking for a match or\r
- mismatch. */\r
- for( x = ( UBaseType_t ) 0; x < ( UBaseType_t ) configMAX_TASK_NAME_LEN; x++ )\r
- {\r
- cNextChar = pxNextTCB->pcTaskName[ x ];\r
-\r
- if( cNextChar != pcNameToQuery[ x ] )\r
- {\r
- /* Characters didn't match. */\r
- break;\r
- }\r
- else if( cNextChar == 0x00 )\r
- {\r
- /* Both strings terminated, a match must have been\r
- found. */\r
- pxReturn = pxNextTCB;\r
- break;\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
-\r
- if( pxReturn != NULL )\r
- {\r
- /* The handle has been found. */\r
- break;\r
- }\r
-\r
- } while( pxNextTCB != pxFirstTCB );\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
-\r
- return pxReturn;\r
- }\r
-\r
-#endif /* INCLUDE_xTaskGetHandle */\r
-/*-----------------------------------------------------------*/\r
-\r
-#if ( INCLUDE_xTaskGetHandle == 1 )\r
-\r
- TaskHandle_t xTaskGetHandle( const char *pcNameToQuery ) /*lint !e971 Unqualified char types are allowed for strings and single characters only. */\r
- {\r
- UBaseType_t uxQueue = configMAX_PRIORITIES;\r
- TCB_t* pxTCB;\r
-\r
- /* Task names will be truncated to configMAX_TASK_NAME_LEN - 1 bytes. */\r
- configASSERT( strlen( pcNameToQuery ) < configMAX_TASK_NAME_LEN );\r
-\r
- vTaskSuspendAll();\r
- {\r
- /* Search the ready lists. */\r
- do\r
- {\r
- uxQueue--;\r
- pxTCB = prvSearchForNameWithinSingleList( ( List_t * ) &( pxReadyTasksLists[ uxQueue ] ), pcNameToQuery );\r
-\r
- if( pxTCB != NULL )\r
- {\r
- /* Found the handle. */\r
- break;\r
- }\r
-\r
- } while( uxQueue > ( UBaseType_t ) tskIDLE_PRIORITY ); /*lint !e961 MISRA exception as the casts are only redundant for some ports. */\r
-\r
- /* Search the delayed lists. */\r
- if( pxTCB == NULL )\r
- {\r
- pxTCB = prvSearchForNameWithinSingleList( ( List_t * ) pxDelayedTaskList, pcNameToQuery );\r
- }\r
-\r
- if( pxTCB == NULL )\r
- {\r
- pxTCB = prvSearchForNameWithinSingleList( ( List_t * ) pxOverflowDelayedTaskList, pcNameToQuery );\r
- }\r
-\r
- #if ( INCLUDE_vTaskSuspend == 1 )\r
- {\r
- if( pxTCB == NULL )\r
- {\r
- /* Search the suspended list. */\r
- pxTCB = prvSearchForNameWithinSingleList( &xSuspendedTaskList, pcNameToQuery );\r
- }\r
- }\r
- #endif\r
-\r
- #if( INCLUDE_vTaskDelete == 1 )\r
- {\r
- if( pxTCB == NULL )\r
- {\r
- /* Search the deleted list. */\r
- pxTCB = prvSearchForNameWithinSingleList( &xTasksWaitingTermination, pcNameToQuery );\r
- }\r
- }\r
- #endif\r
- }\r
- ( void ) xTaskResumeAll();\r
-\r
- return ( TaskHandle_t ) pxTCB;\r
- }\r
-\r
-#endif /* INCLUDE_xTaskGetHandle */\r
-/*-----------------------------------------------------------*/\r
-\r
-#if ( configUSE_TRACE_FACILITY == 1 )\r
-\r
- UBaseType_t uxTaskGetSystemState( TaskStatus_t * const pxTaskStatusArray, const UBaseType_t uxArraySize, uint32_t * const pulTotalRunTime )\r
- {\r
- UBaseType_t uxTask = 0, uxQueue = configMAX_PRIORITIES;\r
-\r
- vTaskSuspendAll();\r
- {\r
- /* Is there a space in the array for each task in the system? */\r
- if( uxArraySize >= uxCurrentNumberOfTasks )\r
- {\r
- /* Fill in an TaskStatus_t structure with information on each\r
- task in the Ready state. */\r
- do\r
- {\r
- uxQueue--;\r
- uxTask += prvListTasksWithinSingleList( &( pxTaskStatusArray[ uxTask ] ), &( pxReadyTasksLists[ uxQueue ] ), eReady );\r
-\r
- } while( uxQueue > ( UBaseType_t ) tskIDLE_PRIORITY ); /*lint !e961 MISRA exception as the casts are only redundant for some ports. */\r
-\r
- /* Fill in an TaskStatus_t structure with information on each\r
- task in the Blocked state. */\r
- uxTask += prvListTasksWithinSingleList( &( pxTaskStatusArray[ uxTask ] ), ( List_t * ) pxDelayedTaskList, eBlocked );\r
- uxTask += prvListTasksWithinSingleList( &( pxTaskStatusArray[ uxTask ] ), ( List_t * ) pxOverflowDelayedTaskList, eBlocked );\r
-\r
- #if( INCLUDE_vTaskDelete == 1 )\r
- {\r
- /* Fill in an TaskStatus_t structure with information on\r
- each task that has been deleted but not yet cleaned up. */\r
- uxTask += prvListTasksWithinSingleList( &( pxTaskStatusArray[ uxTask ] ), &xTasksWaitingTermination, eDeleted );\r
- }\r
- #endif\r
-\r
- #if ( INCLUDE_vTaskSuspend == 1 )\r
- {\r
- /* Fill in an TaskStatus_t structure with information on\r
- each task in the Suspended state. */\r
- uxTask += prvListTasksWithinSingleList( &( pxTaskStatusArray[ uxTask ] ), &xSuspendedTaskList, eSuspended );\r
- }\r
- #endif\r
-\r
- #if ( configGENERATE_RUN_TIME_STATS == 1)\r
- {\r
- if( pulTotalRunTime != NULL )\r
- {\r
- #ifdef portALT_GET_RUN_TIME_COUNTER_VALUE\r
- portALT_GET_RUN_TIME_COUNTER_VALUE( ( *pulTotalRunTime ) );\r
- #else\r
- *pulTotalRunTime = portGET_RUN_TIME_COUNTER_VALUE();\r
- #endif\r
- }\r
- }\r
- #else\r
- {\r
- if( pulTotalRunTime != NULL )\r
- {\r
- *pulTotalRunTime = 0;\r
- }\r
- }\r
- #endif\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- ( void ) xTaskResumeAll();\r
-\r
- return uxTask;\r
- }\r
-\r
-#endif /* configUSE_TRACE_FACILITY */\r
-/*----------------------------------------------------------*/\r
-\r
-#if ( INCLUDE_xTaskGetIdleTaskHandle == 1 )\r
-\r
- TaskHandle_t xTaskGetIdleTaskHandle( void )\r
- {\r
- /* If xTaskGetIdleTaskHandle() is called before the scheduler has been\r
- started, then xIdleTaskHandle will be NULL. */\r
- configASSERT( ( xIdleTaskHandle != NULL ) );\r
- return xIdleTaskHandle;\r
- }\r
-\r
-#endif /* INCLUDE_xTaskGetIdleTaskHandle */\r
-/*----------------------------------------------------------*/\r
-\r
-/* This conditional compilation should use inequality to 0, not equality to 1.\r
-This is to ensure vTaskStepTick() is available when user defined low power mode\r
-implementations require configUSE_TICKLESS_IDLE to be set to a value other than\r
-1. */\r
-#if ( configUSE_TICKLESS_IDLE != 0 )\r
-\r
- void vTaskStepTick( const TickType_t xTicksToJump )\r
- {\r
- /* Correct the tick count value after a period during which the tick\r
- was suppressed. Note this does *not* call the tick hook function for\r
- each stepped tick. */\r
- configASSERT( ( xTickCount + xTicksToJump ) <= xNextTaskUnblockTime );\r
- xTickCount += xTicksToJump;\r
- traceINCREASE_TICK_COUNT( xTicksToJump );\r
- }\r
-\r
-#endif /* configUSE_TICKLESS_IDLE */\r
-/*----------------------------------------------------------*/\r
-\r
-#if ( INCLUDE_xTaskAbortDelay == 1 )\r
-\r
- BaseType_t xTaskAbortDelay( TaskHandle_t xTask )\r
- {\r
- TCB_t *pxTCB = ( TCB_t * ) xTask;\r
- BaseType_t xReturn;\r
-\r
- configASSERT( pxTCB );\r
-\r
- vTaskSuspendAll();\r
- {\r
- /* A task can only be prematurely removed from the Blocked state if\r
- it is actually in the Blocked state. */\r
- if( eTaskGetState( xTask ) == eBlocked )\r
- {\r
- xReturn = pdPASS;\r
-\r
- /* Remove the reference to the task from the blocked list. An\r
- interrupt won't touch the xStateListItem because the\r
- scheduler is suspended. */\r
- ( void ) uxListRemove( &( pxTCB->xStateListItem ) );\r
-\r
- /* Is the task waiting on an event also? If so remove it from\r
- the event list too. Interrupts can touch the event list item,\r
- even though the scheduler is suspended, so a critical section\r
- is used. */\r
- taskENTER_CRITICAL();\r
- {\r
- if( listLIST_ITEM_CONTAINER( &( pxTCB->xEventListItem ) ) != NULL )\r
- {\r
- ( void ) uxListRemove( &( pxTCB->xEventListItem ) );\r
- pxTCB->ucDelayAborted = pdTRUE;\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- taskEXIT_CRITICAL();\r
-\r
- /* Place the unblocked task into the appropriate ready list. */\r
- prvAddTaskToReadyList( pxTCB );\r
-\r
- /* A task being unblocked cannot cause an immediate context\r
- switch if preemption is turned off. */\r
- #if ( configUSE_PREEMPTION == 1 )\r
- {\r
- /* Preemption is on, but a context switch should only be\r
- performed if the unblocked task has a priority that is\r
- equal to or higher than the currently executing task. */\r
- if( pxTCB->uxPriority > pxCurrentTCB->uxPriority )\r
- {\r
- /* Pend the yield to be performed when the scheduler\r
- is unsuspended. */\r
- xYieldPending = pdTRUE;\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- #endif /* configUSE_PREEMPTION */\r
- }\r
- else\r
- {\r
- xReturn = pdFAIL;\r
- }\r
- }\r
- ( void ) xTaskResumeAll();\r
-\r
- return xReturn;\r
- }\r
-\r
-#endif /* INCLUDE_xTaskAbortDelay */\r
-/*----------------------------------------------------------*/\r
-\r
-BaseType_t xTaskIncrementTick( void )\r
-{\r
-TCB_t * pxTCB;\r
-TickType_t xItemValue;\r
-BaseType_t xSwitchRequired = pdFALSE;\r
-\r
- /* Called by the portable layer each time a tick interrupt occurs.\r
- Increments the tick then checks to see if the new tick value will cause any\r
- tasks to be unblocked. */\r
- traceTASK_INCREMENT_TICK( xTickCount );\r
- if( uxSchedulerSuspended == ( UBaseType_t ) pdFALSE )\r
- {\r
- /* Minor optimisation. The tick count cannot change in this\r
- block. */\r
- const TickType_t xConstTickCount = xTickCount + ( TickType_t ) 1;\r
-\r
- /* Increment the RTOS tick, switching the delayed and overflowed\r
- delayed lists if it wraps to 0. */\r
- xTickCount = xConstTickCount;\r
-\r
- if( xConstTickCount == ( TickType_t ) 0U ) /*lint !e774 'if' does not always evaluate to false as it is looking for an overflow. */\r
- {\r
- taskSWITCH_DELAYED_LISTS();\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
-\r
- /* See if this tick has made a timeout expire. Tasks are stored in\r
- the queue in the order of their wake time - meaning once one task\r
- has been found whose block time has not expired there is no need to\r
- look any further down the list. */\r
- if( xConstTickCount >= xNextTaskUnblockTime )\r
- {\r
- for( ;; )\r
- {\r
- if( listLIST_IS_EMPTY( pxDelayedTaskList ) != pdFALSE )\r
- {\r
- /* The delayed list is empty. Set xNextTaskUnblockTime\r
- to the maximum possible value so it is extremely\r
- unlikely that the\r
- if( xTickCount >= xNextTaskUnblockTime ) test will pass\r
- next time through. */\r
- xNextTaskUnblockTime = portMAX_DELAY; /*lint !e961 MISRA exception as the casts are only redundant for some ports. */\r
- break;\r
- }\r
- else\r
- {\r
- /* The delayed list is not empty, get the value of the\r
- item at the head of the delayed list. This is the time\r
- at which the task at the head of the delayed list must\r
- be removed from the Blocked state. */\r
- pxTCB = ( TCB_t * ) listGET_OWNER_OF_HEAD_ENTRY( pxDelayedTaskList );\r
- xItemValue = listGET_LIST_ITEM_VALUE( &( pxTCB->xStateListItem ) );\r
-\r
- if( xConstTickCount < xItemValue )\r
- {\r
- /* It is not time to unblock this item yet, but the\r
- item value is the time at which the task at the head\r
- of the blocked list must be removed from the Blocked\r
- state - so record the item value in\r
- xNextTaskUnblockTime. */\r
- xNextTaskUnblockTime = xItemValue;\r
- break;\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
-\r
- /* It is time to remove the item from the Blocked state. */\r
- ( void ) uxListRemove( &( pxTCB->xStateListItem ) );\r
-\r
- /* Is the task waiting on an event also? If so remove\r
- it from the event list. */\r
- if( listLIST_ITEM_CONTAINER( &( pxTCB->xEventListItem ) ) != NULL )\r
- {\r
- ( void ) uxListRemove( &( pxTCB->xEventListItem ) );\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
-\r
- /* Place the unblocked task into the appropriate ready\r
- list. */\r
- prvAddTaskToReadyList( pxTCB );\r
-\r
- /* A task being unblocked cannot cause an immediate\r
- context switch if preemption is turned off. */\r
- #if ( configUSE_PREEMPTION == 1 )\r
- {\r
- /* Preemption is on, but a context switch should\r
- only be performed if the unblocked task has a\r
- priority that is equal to or higher than the\r
- currently executing task. */\r
- if( pxTCB->uxPriority >= pxCurrentTCB->uxPriority )\r
- {\r
- xSwitchRequired = pdTRUE;\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- #endif /* configUSE_PREEMPTION */\r
- }\r
- }\r
- }\r
-\r
- /* Tasks of equal priority to the currently running task will share\r
- processing time (time slice) if preemption is on, and the application\r
- writer has not explicitly turned time slicing off. */\r
- #if ( ( configUSE_PREEMPTION == 1 ) && ( configUSE_TIME_SLICING == 1 ) )\r
- {\r
- if( listCURRENT_LIST_LENGTH( &( pxReadyTasksLists[ pxCurrentTCB->uxPriority ] ) ) > ( UBaseType_t ) 1 )\r
- {\r
- xSwitchRequired = pdTRUE;\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- #endif /* ( ( configUSE_PREEMPTION == 1 ) && ( configUSE_TIME_SLICING == 1 ) ) */\r
-\r
- #if ( configUSE_TICK_HOOK == 1 )\r
- {\r
- /* Guard against the tick hook being called when the pended tick\r
- count is being unwound (when the scheduler is being unlocked). */\r
- if( uxPendedTicks == ( UBaseType_t ) 0U )\r
- {\r
- vApplicationTickHook();\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- #endif /* configUSE_TICK_HOOK */\r
- }\r
- else\r
- {\r
- ++uxPendedTicks;\r
-\r
- /* The tick hook gets called at regular intervals, even if the\r
- scheduler is locked. */\r
- #if ( configUSE_TICK_HOOK == 1 )\r
- {\r
- vApplicationTickHook();\r
- }\r
- #endif\r
- }\r
-\r
- #if ( configUSE_PREEMPTION == 1 )\r
- {\r
- if( xYieldPending != pdFALSE )\r
- {\r
- xSwitchRequired = pdTRUE;\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- #endif /* configUSE_PREEMPTION */\r
-\r
- return xSwitchRequired;\r
-}\r
-/*-----------------------------------------------------------*/\r
-\r
-#if ( configUSE_APPLICATION_TASK_TAG == 1 )\r
-\r
- void vTaskSetApplicationTaskTag( TaskHandle_t xTask, TaskHookFunction_t pxHookFunction )\r
- {\r
- TCB_t *xTCB;\r
-\r
- /* If xTask is NULL then it is the task hook of the calling task that is\r
- getting set. */\r
- if( xTask == NULL )\r
- {\r
- xTCB = ( TCB_t * ) pxCurrentTCB;\r
- }\r
- else\r
- {\r
- xTCB = ( TCB_t * ) xTask;\r
- }\r
-\r
- /* Save the hook function in the TCB. A critical section is required as\r
- the value can be accessed from an interrupt. */\r
- taskENTER_CRITICAL();\r
- xTCB->pxTaskTag = pxHookFunction;\r
- taskEXIT_CRITICAL();\r
- }\r
-\r
-#endif /* configUSE_APPLICATION_TASK_TAG */\r
-/*-----------------------------------------------------------*/\r
-\r
-#if ( configUSE_APPLICATION_TASK_TAG == 1 )\r
-\r
- TaskHookFunction_t xTaskGetApplicationTaskTag( TaskHandle_t xTask )\r
- {\r
- TCB_t *xTCB;\r
- TaskHookFunction_t xReturn;\r
-\r
- /* If xTask is NULL then we are setting our own task hook. */\r
- if( xTask == NULL )\r
- {\r
- xTCB = ( TCB_t * ) pxCurrentTCB;\r
- }\r
- else\r
- {\r
- xTCB = ( TCB_t * ) xTask;\r
- }\r
-\r
- /* Save the hook function in the TCB. A critical section is required as\r
- the value can be accessed from an interrupt. */\r
- taskENTER_CRITICAL();\r
- {\r
- xReturn = xTCB->pxTaskTag;\r
- }\r
- taskEXIT_CRITICAL();\r
-\r
- return xReturn;\r
- }\r
-\r
-#endif /* configUSE_APPLICATION_TASK_TAG */\r
-/*-----------------------------------------------------------*/\r
-\r
-#if ( configUSE_APPLICATION_TASK_TAG == 1 )\r
-\r
- BaseType_t xTaskCallApplicationTaskHook( TaskHandle_t xTask, void *pvParameter )\r
- {\r
- TCB_t *xTCB;\r
- BaseType_t xReturn;\r
-\r
- /* If xTask is NULL then we are calling our own task hook. */\r
- if( xTask == NULL )\r
- {\r
- xTCB = ( TCB_t * ) pxCurrentTCB;\r
- }\r
- else\r
- {\r
- xTCB = ( TCB_t * ) xTask;\r
- }\r
-\r
- if( xTCB->pxTaskTag != NULL )\r
- {\r
- xReturn = xTCB->pxTaskTag( pvParameter );\r
- }\r
- else\r
- {\r
- xReturn = pdFAIL;\r
- }\r
-\r
- return xReturn;\r
- }\r
-\r
-#endif /* configUSE_APPLICATION_TASK_TAG */\r
-/*-----------------------------------------------------------*/\r
-\r
-void vTaskSwitchContext( void )\r
-{\r
- if( uxSchedulerSuspended != ( UBaseType_t ) pdFALSE )\r
- {\r
- /* The scheduler is currently suspended - do not allow a context\r
- switch. */\r
- xYieldPending = pdTRUE;\r
- }\r
- else\r
- {\r
- xYieldPending = pdFALSE;\r
- traceTASK_SWITCHED_OUT();\r
-\r
- #if ( configGENERATE_RUN_TIME_STATS == 1 )\r
- {\r
- #ifdef portALT_GET_RUN_TIME_COUNTER_VALUE\r
- portALT_GET_RUN_TIME_COUNTER_VALUE( ulTotalRunTime );\r
- #else\r
- ulTotalRunTime = portGET_RUN_TIME_COUNTER_VALUE();\r
- #endif\r
-\r
- /* Add the amount of time the task has been running to the\r
- accumulated time so far. The time the task started running was\r
- stored in ulTaskSwitchedInTime. Note that there is no overflow\r
- protection here so count values are only valid until the timer\r
- overflows. The guard against negative values is to protect\r
- against suspect run time stat counter implementations - which\r
- are provided by the application, not the kernel. */\r
- if( ulTotalRunTime > ulTaskSwitchedInTime )\r
- {\r
- pxCurrentTCB->ulRunTimeCounter += ( ulTotalRunTime - ulTaskSwitchedInTime );\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- ulTaskSwitchedInTime = ulTotalRunTime;\r
- }\r
- #endif /* configGENERATE_RUN_TIME_STATS */\r
-\r
- /* Check for stack overflow, if configured. */\r
- taskCHECK_FOR_STACK_OVERFLOW();\r
-\r
- /* Select a new task to run using either the generic C or port\r
- optimised asm code. */\r
- taskSELECT_HIGHEST_PRIORITY_TASK();\r
- traceTASK_SWITCHED_IN();\r
-\r
- #if ( configUSE_NEWLIB_REENTRANT == 1 )\r
- {\r
- /* Switch Newlib's _impure_ptr variable to point to the _reent\r
- structure specific to this task. */\r
- _impure_ptr = &( pxCurrentTCB->xNewLib_reent );\r
- }\r
- #endif /* configUSE_NEWLIB_REENTRANT */\r
- }\r
-}\r
-/*-----------------------------------------------------------*/\r
-\r
-void vTaskPlaceOnEventList( List_t * const pxEventList, const TickType_t xTicksToWait )\r
-{\r
- configASSERT( pxEventList );\r
-\r
- /* THIS FUNCTION MUST BE CALLED WITH EITHER INTERRUPTS DISABLED OR THE\r
- SCHEDULER SUSPENDED AND THE QUEUE BEING ACCESSED LOCKED. */\r
-\r
- /* Place the event list item of the TCB in the appropriate event list.\r
- This is placed in the list in priority order so the highest priority task\r
- is the first to be woken by the event. The queue that contains the event\r
- list is locked, preventing simultaneous access from interrupts. */\r
- vListInsert( pxEventList, &( pxCurrentTCB->xEventListItem ) );\r
-\r
- prvAddCurrentTaskToDelayedList( xTicksToWait, pdTRUE );\r
-}\r
-/*-----------------------------------------------------------*/\r
-\r
-void vTaskPlaceOnUnorderedEventList( List_t * pxEventList, const TickType_t xItemValue, const TickType_t xTicksToWait )\r
-{\r
- configASSERT( pxEventList );\r
-\r
- /* THIS FUNCTION MUST BE CALLED WITH THE SCHEDULER SUSPENDED. It is used by\r
- the event groups implementation. */\r
- configASSERT( uxSchedulerSuspended != 0 );\r
-\r
- /* Store the item value in the event list item. It is safe to access the\r
- event list item here as interrupts won't access the event list item of a\r
- task that is not in the Blocked state. */\r
- listSET_LIST_ITEM_VALUE( &( pxCurrentTCB->xEventListItem ), xItemValue | taskEVENT_LIST_ITEM_VALUE_IN_USE );\r
-\r
- /* Place the event list item of the TCB at the end of the appropriate event\r
- list. It is safe to access the event list here because it is part of an\r
- event group implementation - and interrupts don't access event groups\r
- directly (instead they access them indirectly by pending function calls to\r
- the task level). */\r
- vListInsertEnd( pxEventList, &( pxCurrentTCB->xEventListItem ) );\r
-\r
- prvAddCurrentTaskToDelayedList( xTicksToWait, pdTRUE );\r
-}\r
-/*-----------------------------------------------------------*/\r
-\r
-#if( configUSE_TIMERS == 1 )\r
-\r
- void vTaskPlaceOnEventListRestricted( List_t * const pxEventList, TickType_t xTicksToWait, const BaseType_t xWaitIndefinitely )\r
- {\r
- configASSERT( pxEventList );\r
-\r
- /* This function should not be called by application code hence the\r
- 'Restricted' in its name. It is not part of the public API. It is\r
- designed for use by kernel code, and has special calling requirements -\r
- it should be called with the scheduler suspended. */\r
-\r
-\r
- /* Place the event list item of the TCB in the appropriate event list.\r
- In this case it is assume that this is the only task that is going to\r
- be waiting on this event list, so the faster vListInsertEnd() function\r
- can be used in place of vListInsert. */\r
- vListInsertEnd( pxEventList, &( pxCurrentTCB->xEventListItem ) );\r
-\r
- /* If the task should block indefinitely then set the block time to a\r
- value that will be recognised as an indefinite delay inside the\r
- prvAddCurrentTaskToDelayedList() function. */\r
- if( xWaitIndefinitely != pdFALSE )\r
- {\r
- xTicksToWait = portMAX_DELAY;\r
- }\r
-\r
- traceTASK_DELAY_UNTIL( ( xTickCount + xTicksToWait ) );\r
- prvAddCurrentTaskToDelayedList( xTicksToWait, xWaitIndefinitely );\r
- }\r
-\r
-#endif /* configUSE_TIMERS */\r
-/*-----------------------------------------------------------*/\r
-\r
-BaseType_t xTaskRemoveFromEventList( const List_t * const pxEventList )\r
-{\r
-TCB_t *pxUnblockedTCB;\r
-BaseType_t xReturn;\r
-\r
- /* THIS FUNCTION MUST BE CALLED FROM A CRITICAL SECTION. It can also be\r
- called from a critical section within an ISR. */\r
-\r
- /* The event list is sorted in priority order, so the first in the list can\r
- be removed as it is known to be the highest priority. Remove the TCB from\r
- the delayed list, and add it to the ready list.\r
-\r
- If an event is for a queue that is locked then this function will never\r
- get called - the lock count on the queue will get modified instead. This\r
- means exclusive access to the event list is guaranteed here.\r
-\r
- This function assumes that a check has already been made to ensure that\r
- pxEventList is not empty. */\r
- pxUnblockedTCB = ( TCB_t * ) listGET_OWNER_OF_HEAD_ENTRY( pxEventList );\r
- configASSERT( pxUnblockedTCB );\r
- ( void ) uxListRemove( &( pxUnblockedTCB->xEventListItem ) );\r
-\r
- if( uxSchedulerSuspended == ( UBaseType_t ) pdFALSE )\r
- {\r
- ( void ) uxListRemove( &( pxUnblockedTCB->xStateListItem ) );\r
- prvAddTaskToReadyList( pxUnblockedTCB );\r
- }\r
- else\r
- {\r
- /* The delayed and ready lists cannot be accessed, so hold this task\r
- pending until the scheduler is resumed. */\r
- vListInsertEnd( &( xPendingReadyList ), &( pxUnblockedTCB->xEventListItem ) );\r
- }\r
-\r
- if( pxUnblockedTCB->uxPriority > pxCurrentTCB->uxPriority )\r
- {\r
- /* Return true if the task removed from the event list has a higher\r
- priority than the calling task. This allows the calling task to know if\r
- it should force a context switch now. */\r
- xReturn = pdTRUE;\r
-\r
- /* Mark that a yield is pending in case the user is not using the\r
- "xHigherPriorityTaskWoken" parameter to an ISR safe FreeRTOS function. */\r
- xYieldPending = pdTRUE;\r
- }\r
- else\r
- {\r
- xReturn = pdFALSE;\r
- }\r
-\r
- #if( configUSE_TICKLESS_IDLE != 0 )\r
- {\r
- /* If a task is blocked on a kernel object then xNextTaskUnblockTime\r
- might be set to the blocked task's time out time. If the task is\r
- unblocked for a reason other than a timeout xNextTaskUnblockTime is\r
- normally left unchanged, because it is automatically reset to a new\r
- value when the tick count equals xNextTaskUnblockTime. However if\r
- tickless idling is used it might be more important to enter sleep mode\r
- at the earliest possible time - so reset xNextTaskUnblockTime here to\r
- ensure it is updated at the earliest possible time. */\r
- prvResetNextTaskUnblockTime();\r
- }\r
- #endif\r
-\r
- return xReturn;\r
-}\r
-/*-----------------------------------------------------------*/\r
-\r
-void vTaskRemoveFromUnorderedEventList( ListItem_t * pxEventListItem, const TickType_t xItemValue )\r
-{\r
-TCB_t *pxUnblockedTCB;\r
-\r
- /* THIS FUNCTION MUST BE CALLED WITH THE SCHEDULER SUSPENDED. It is used by\r
- the event flags implementation. */\r
- configASSERT( uxSchedulerSuspended != pdFALSE );\r
-\r
- /* Store the new item value in the event list. */\r
- listSET_LIST_ITEM_VALUE( pxEventListItem, xItemValue | taskEVENT_LIST_ITEM_VALUE_IN_USE );\r
-\r
- /* Remove the event list form the event flag. Interrupts do not access\r
- event flags. */\r
- pxUnblockedTCB = ( TCB_t * ) listGET_LIST_ITEM_OWNER( pxEventListItem );\r
- configASSERT( pxUnblockedTCB );\r
- ( void ) uxListRemove( pxEventListItem );\r
-\r
- /* Remove the task from the delayed list and add it to the ready list. The\r
- scheduler is suspended so interrupts will not be accessing the ready\r
- lists. */\r
- ( void ) uxListRemove( &( pxUnblockedTCB->xStateListItem ) );\r
- prvAddTaskToReadyList( pxUnblockedTCB );\r
-\r
- if( pxUnblockedTCB->uxPriority > pxCurrentTCB->uxPriority )\r
- {\r
- /* The unblocked task has a priority above that of the calling task, so\r
- a context switch is required. This function is called with the\r
- scheduler suspended so xYieldPending is set so the context switch\r
- occurs immediately that the scheduler is resumed (unsuspended). */\r
- xYieldPending = pdTRUE;\r
- }\r
-}\r
-/*-----------------------------------------------------------*/\r
-\r
-void vTaskSetTimeOutState( TimeOut_t * const pxTimeOut )\r
-{\r
- configASSERT( pxTimeOut );\r
- taskENTER_CRITICAL();\r
- {\r
- pxTimeOut->xOverflowCount = xNumOfOverflows;\r
- pxTimeOut->xTimeOnEntering = xTickCount;\r
- }\r
- taskEXIT_CRITICAL();\r
-}\r
-/*-----------------------------------------------------------*/\r
-\r
-void vTaskInternalSetTimeOutState( TimeOut_t * const pxTimeOut )\r
-{\r
- /* For internal use only as it does not use a critical section. */\r
- pxTimeOut->xOverflowCount = xNumOfOverflows;\r
- pxTimeOut->xTimeOnEntering = xTickCount;\r
-}\r
-/*-----------------------------------------------------------*/\r
-\r
-BaseType_t xTaskCheckForTimeOut( TimeOut_t * const pxTimeOut, TickType_t * const pxTicksToWait )\r
-{\r
-BaseType_t xReturn;\r
-\r
- configASSERT( pxTimeOut );\r
- configASSERT( pxTicksToWait );\r
-\r
- taskENTER_CRITICAL();\r
- {\r
- /* Minor optimisation. The tick count cannot change in this block. */\r
- const TickType_t xConstTickCount = xTickCount;\r
- const TickType_t xElapsedTime = xConstTickCount - pxTimeOut->xTimeOnEntering;\r
-\r
- #if( INCLUDE_xTaskAbortDelay == 1 )\r
- if( pxCurrentTCB->ucDelayAborted != pdFALSE )\r
- {\r
- /* The delay was aborted, which is not the same as a time out,\r
- but has the same result. */\r
- pxCurrentTCB->ucDelayAborted = pdFALSE;\r
- xReturn = pdTRUE;\r
- }\r
- else\r
- #endif\r
-\r
- #if ( INCLUDE_vTaskSuspend == 1 )\r
- if( *pxTicksToWait == portMAX_DELAY )\r
- {\r
- /* If INCLUDE_vTaskSuspend is set to 1 and the block time\r
- specified is the maximum block time then the task should block\r
- indefinitely, and therefore never time out. */\r
- xReturn = pdFALSE;\r
- }\r
- else\r
- #endif\r
-\r
- if( ( xNumOfOverflows != pxTimeOut->xOverflowCount ) && ( xConstTickCount >= pxTimeOut->xTimeOnEntering ) ) /*lint !e525 Indentation preferred as is to make code within pre-processor directives clearer. */\r
- {\r
- /* The tick count is greater than the time at which\r
- vTaskSetTimeout() was called, but has also overflowed since\r
- vTaskSetTimeOut() was called. It must have wrapped all the way\r
- around and gone past again. This passed since vTaskSetTimeout()\r
- was called. */\r
- xReturn = pdTRUE;\r
- }\r
- else if( xElapsedTime < *pxTicksToWait ) /*lint !e961 Explicit casting is only redundant with some compilers, whereas others require it to prevent integer conversion errors. */\r
- {\r
- /* Not a genuine timeout. Adjust parameters for time remaining. */\r
- *pxTicksToWait -= xElapsedTime;\r
- vTaskInternalSetTimeOutState( pxTimeOut );\r
- xReturn = pdFALSE;\r
- }\r
- else\r
- {\r
- *pxTicksToWait = 0;\r
- xReturn = pdTRUE;\r
- }\r
- }\r
- taskEXIT_CRITICAL();\r
-\r
- return xReturn;\r
-}\r
-/*-----------------------------------------------------------*/\r
-\r
-void vTaskMissedYield( void )\r
-{\r
- xYieldPending = pdTRUE;\r
-}\r
-/*-----------------------------------------------------------*/\r
-\r
-#if ( configUSE_TRACE_FACILITY == 1 )\r
-\r
- UBaseType_t uxTaskGetTaskNumber( TaskHandle_t xTask )\r
- {\r
- UBaseType_t uxReturn;\r
- TCB_t *pxTCB;\r
-\r
- if( xTask != NULL )\r
- {\r
- pxTCB = ( TCB_t * ) xTask;\r
- uxReturn = pxTCB->uxTaskNumber;\r
- }\r
- else\r
- {\r
- uxReturn = 0U;\r
- }\r
-\r
- return uxReturn;\r
- }\r
-\r
-#endif /* configUSE_TRACE_FACILITY */\r
-/*-----------------------------------------------------------*/\r
-\r
-#if ( configUSE_TRACE_FACILITY == 1 )\r
-\r
- void vTaskSetTaskNumber( TaskHandle_t xTask, const UBaseType_t uxHandle )\r
- {\r
- TCB_t *pxTCB;\r
-\r
- if( xTask != NULL )\r
- {\r
- pxTCB = ( TCB_t * ) xTask;\r
- pxTCB->uxTaskNumber = uxHandle;\r
- }\r
- }\r
-\r
-#endif /* configUSE_TRACE_FACILITY */\r
-\r
-/*\r
- * -----------------------------------------------------------\r
- * The Idle task.\r
- * ----------------------------------------------------------\r
- *\r
- * The portTASK_FUNCTION() macro is used to allow port/compiler specific\r
- * language extensions. The equivalent prototype for this function is:\r
- *\r
- * void prvIdleTask( void *pvParameters );\r
- *\r
- */\r
-static portTASK_FUNCTION( prvIdleTask, pvParameters )\r
-{\r
- /* Stop warnings. */\r
- ( void ) pvParameters;\r
-\r
- /** THIS IS THE RTOS IDLE TASK - WHICH IS CREATED AUTOMATICALLY WHEN THE\r
- SCHEDULER IS STARTED. **/\r
-\r
- /* In case a task that has a secure context deletes itself, in which case\r
- the idle task is responsible for deleting the task's secure context, if\r
- any. */\r
- portTASK_CALLS_SECURE_FUNCTIONS();\r
-\r
- for( ;; )\r
- {\r
- /* See if any tasks have deleted themselves - if so then the idle task\r
- is responsible for freeing the deleted task's TCB and stack. */\r
- prvCheckTasksWaitingTermination();\r
-\r
- #if ( configUSE_PREEMPTION == 0 )\r
- {\r
- /* If we are not using preemption we keep forcing a task switch to\r
- see if any other task has become available. If we are using\r
- preemption we don't need to do this as any task becoming available\r
- will automatically get the processor anyway. */\r
- taskYIELD();\r
- }\r
- #endif /* configUSE_PREEMPTION */\r
-\r
- #if ( ( configUSE_PREEMPTION == 1 ) && ( configIDLE_SHOULD_YIELD == 1 ) )\r
- {\r
- /* When using preemption tasks of equal priority will be\r
- timesliced. If a task that is sharing the idle priority is ready\r
- to run then the idle task should yield before the end of the\r
- timeslice.\r
-\r
- A critical region is not required here as we are just reading from\r
- the list, and an occasional incorrect value will not matter. If\r
- the ready list at the idle priority contains more than one task\r
- then a task other than the idle task is ready to execute. */\r
- if( listCURRENT_LIST_LENGTH( &( pxReadyTasksLists[ tskIDLE_PRIORITY ] ) ) > ( UBaseType_t ) 1 )\r
- {\r
- taskYIELD();\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- #endif /* ( ( configUSE_PREEMPTION == 1 ) && ( configIDLE_SHOULD_YIELD == 1 ) ) */\r
-\r
- #if ( configUSE_IDLE_HOOK == 1 )\r
- {\r
- extern void vApplicationIdleHook( void );\r
-\r
- /* Call the user defined function from within the idle task. This\r
- allows the application designer to add background functionality\r
- without the overhead of a separate task.\r
- NOTE: vApplicationIdleHook() MUST NOT, UNDER ANY CIRCUMSTANCES,\r
- CALL A FUNCTION THAT MIGHT BLOCK. */\r
- vApplicationIdleHook();\r
- }\r
- #endif /* configUSE_IDLE_HOOK */\r
-\r
- /* This conditional compilation should use inequality to 0, not equality\r
- to 1. This is to ensure portSUPPRESS_TICKS_AND_SLEEP() is called when\r
- user defined low power mode implementations require\r
- configUSE_TICKLESS_IDLE to be set to a value other than 1. */\r
- #if ( configUSE_TICKLESS_IDLE != 0 )\r
- {\r
- TickType_t xExpectedIdleTime;\r
-\r
- /* It is not desirable to suspend then resume the scheduler on\r
- each iteration of the idle task. Therefore, a preliminary\r
- test of the expected idle time is performed without the\r
- scheduler suspended. The result here is not necessarily\r
- valid. */\r
- xExpectedIdleTime = prvGetExpectedIdleTime();\r
-\r
- if( xExpectedIdleTime >= configEXPECTED_IDLE_TIME_BEFORE_SLEEP )\r
- {\r
- vTaskSuspendAll();\r
- {\r
- /* Now the scheduler is suspended, the expected idle\r
- time can be sampled again, and this time its value can\r
- be used. */\r
- configASSERT( xNextTaskUnblockTime >= xTickCount );\r
- xExpectedIdleTime = prvGetExpectedIdleTime();\r
-\r
- /* Define the following macro to set xExpectedIdleTime to 0\r
- if the application does not want\r
- portSUPPRESS_TICKS_AND_SLEEP() to be called. */\r
- configPRE_SUPPRESS_TICKS_AND_SLEEP_PROCESSING( xExpectedIdleTime );\r
-\r
- if( xExpectedIdleTime >= configEXPECTED_IDLE_TIME_BEFORE_SLEEP )\r
- {\r
- traceLOW_POWER_IDLE_BEGIN();\r
- portSUPPRESS_TICKS_AND_SLEEP( xExpectedIdleTime );\r
- traceLOW_POWER_IDLE_END();\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- ( void ) xTaskResumeAll();\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- #endif /* configUSE_TICKLESS_IDLE */\r
- }\r
-}\r
-/*-----------------------------------------------------------*/\r
-\r
-#if( configUSE_TICKLESS_IDLE != 0 )\r
-\r
- eSleepModeStatus eTaskConfirmSleepModeStatus( void )\r
- {\r
- /* The idle task exists in addition to the application tasks. */\r
- const UBaseType_t uxNonApplicationTasks = 1;\r
- eSleepModeStatus eReturn = eStandardSleep;\r
-\r
- if( listCURRENT_LIST_LENGTH( &xPendingReadyList ) != 0 )\r
- {\r
- /* A task was made ready while the scheduler was suspended. */\r
- eReturn = eAbortSleep;\r
- }\r
- else if( xYieldPending != pdFALSE )\r
- {\r
- /* A yield was pended while the scheduler was suspended. */\r
- eReturn = eAbortSleep;\r
- }\r
- else\r
- {\r
- /* If all the tasks are in the suspended list (which might mean they\r
- have an infinite block time rather than actually being suspended)\r
- then it is safe to turn all clocks off and just wait for external\r
- interrupts. */\r
- if( listCURRENT_LIST_LENGTH( &xSuspendedTaskList ) == ( uxCurrentNumberOfTasks - uxNonApplicationTasks ) )\r
- {\r
- eReturn = eNoTasksWaitingTimeout;\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
-\r
- return eReturn;\r
- }\r
-\r
-#endif /* configUSE_TICKLESS_IDLE */\r
-/*-----------------------------------------------------------*/\r
-\r
-#if ( configNUM_THREAD_LOCAL_STORAGE_POINTERS != 0 )\r
-\r
- void vTaskSetThreadLocalStoragePointer( TaskHandle_t xTaskToSet, BaseType_t xIndex, void *pvValue )\r
- {\r
- TCB_t *pxTCB;\r
-\r
- if( xIndex < configNUM_THREAD_LOCAL_STORAGE_POINTERS )\r
- {\r
- pxTCB = prvGetTCBFromHandle( xTaskToSet );\r
- pxTCB->pvThreadLocalStoragePointers[ xIndex ] = pvValue;\r
- }\r
- }\r
-\r
-#endif /* configNUM_THREAD_LOCAL_STORAGE_POINTERS */\r
-/*-----------------------------------------------------------*/\r
-\r
-#if ( configNUM_THREAD_LOCAL_STORAGE_POINTERS != 0 )\r
-\r
- void *pvTaskGetThreadLocalStoragePointer( TaskHandle_t xTaskToQuery, BaseType_t xIndex )\r
- {\r
- void *pvReturn = NULL;\r
- TCB_t *pxTCB;\r
-\r
- if( xIndex < configNUM_THREAD_LOCAL_STORAGE_POINTERS )\r
- {\r
- pxTCB = prvGetTCBFromHandle( xTaskToQuery );\r
- pvReturn = pxTCB->pvThreadLocalStoragePointers[ xIndex ];\r
- }\r
- else\r
- {\r
- pvReturn = NULL;\r
- }\r
-\r
- return pvReturn;\r
- }\r
-\r
-#endif /* configNUM_THREAD_LOCAL_STORAGE_POINTERS */\r
-/*-----------------------------------------------------------*/\r
-\r
-#if ( portUSING_MPU_WRAPPERS == 1 )\r
-\r
- void vTaskAllocateMPURegions( TaskHandle_t xTaskToModify, const MemoryRegion_t * const xRegions )\r
- {\r
- TCB_t *pxTCB;\r
-\r
- /* If null is passed in here then we are modifying the MPU settings of\r
- the calling task. */\r
- pxTCB = prvGetTCBFromHandle( xTaskToModify );\r
-\r
- vPortStoreTaskMPUSettings( &( pxTCB->xMPUSettings ), xRegions, NULL, 0 );\r
- }\r
-\r
-#endif /* portUSING_MPU_WRAPPERS */\r
-/*-----------------------------------------------------------*/\r
-\r
-static void prvInitialiseTaskLists( void )\r
-{\r
-UBaseType_t uxPriority;\r
-\r
- for( uxPriority = ( UBaseType_t ) 0U; uxPriority < ( UBaseType_t ) configMAX_PRIORITIES; uxPriority++ )\r
- {\r
- vListInitialise( &( pxReadyTasksLists[ uxPriority ] ) );\r
- }\r
-\r
- vListInitialise( &xDelayedTaskList1 );\r
- vListInitialise( &xDelayedTaskList2 );\r
- vListInitialise( &xPendingReadyList );\r
-\r
- #if ( INCLUDE_vTaskDelete == 1 )\r
- {\r
- vListInitialise( &xTasksWaitingTermination );\r
- }\r
- #endif /* INCLUDE_vTaskDelete */\r
-\r
- #if ( INCLUDE_vTaskSuspend == 1 )\r
- {\r
- vListInitialise( &xSuspendedTaskList );\r
- }\r
- #endif /* INCLUDE_vTaskSuspend */\r
-\r
- /* Start with pxDelayedTaskList using list1 and the pxOverflowDelayedTaskList\r
- using list2. */\r
- pxDelayedTaskList = &xDelayedTaskList1;\r
- pxOverflowDelayedTaskList = &xDelayedTaskList2;\r
-}\r
-/*-----------------------------------------------------------*/\r
-\r
-static void prvCheckTasksWaitingTermination( void )\r
-{\r
-\r
- /** THIS FUNCTION IS CALLED FROM THE RTOS IDLE TASK **/\r
-\r
- #if ( INCLUDE_vTaskDelete == 1 )\r
- {\r
- TCB_t *pxTCB;\r
-\r
- /* uxDeletedTasksWaitingCleanUp is used to prevent vTaskSuspendAll()\r
- being called too often in the idle task. */\r
- while( uxDeletedTasksWaitingCleanUp > ( UBaseType_t ) 0U )\r
- {\r
- taskENTER_CRITICAL();\r
- {\r
- pxTCB = ( TCB_t * ) listGET_OWNER_OF_HEAD_ENTRY( ( &xTasksWaitingTermination ) );\r
- ( void ) uxListRemove( &( pxTCB->xStateListItem ) );\r
- --uxCurrentNumberOfTasks;\r
- --uxDeletedTasksWaitingCleanUp;\r
- }\r
- taskEXIT_CRITICAL();\r
-\r
- prvDeleteTCB( pxTCB );\r
- }\r
- }\r
- #endif /* INCLUDE_vTaskDelete */\r
-}\r
-/*-----------------------------------------------------------*/\r
-\r
-#if( configUSE_TRACE_FACILITY == 1 )\r
-\r
- void vTaskGetInfo( TaskHandle_t xTask, TaskStatus_t *pxTaskStatus, BaseType_t xGetFreeStackSpace, eTaskState eState )\r
- {\r
- TCB_t *pxTCB;\r
-\r
- /* xTask is NULL then get the state of the calling task. */\r
- pxTCB = prvGetTCBFromHandle( xTask );\r
-\r
- pxTaskStatus->xHandle = ( TaskHandle_t ) pxTCB;\r
- pxTaskStatus->pcTaskName = ( const char * ) &( pxTCB->pcTaskName [ 0 ] );\r
- pxTaskStatus->uxCurrentPriority = pxTCB->uxPriority;\r
- pxTaskStatus->pxStackBase = pxTCB->pxStack;\r
- pxTaskStatus->xTaskNumber = pxTCB->uxTCBNumber;\r
-\r
- #if ( configUSE_MUTEXES == 1 )\r
- {\r
- pxTaskStatus->uxBasePriority = pxTCB->uxBasePriority;\r
- }\r
- #else\r
- {\r
- pxTaskStatus->uxBasePriority = 0;\r
- }\r
- #endif\r
-\r
- #if ( configGENERATE_RUN_TIME_STATS == 1 )\r
- {\r
- pxTaskStatus->ulRunTimeCounter = pxTCB->ulRunTimeCounter;\r
- }\r
- #else\r
- {\r
- pxTaskStatus->ulRunTimeCounter = 0;\r
- }\r
- #endif\r
-\r
- /* Obtaining the task state is a little fiddly, so is only done if the\r
- value of eState passed into this function is eInvalid - otherwise the\r
- state is just set to whatever is passed in. */\r
- if( eState != eInvalid )\r
- {\r
- if( pxTCB == pxCurrentTCB )\r
- {\r
- pxTaskStatus->eCurrentState = eRunning;\r
- }\r
- else\r
- {\r
- pxTaskStatus->eCurrentState = eState;\r
-\r
- #if ( INCLUDE_vTaskSuspend == 1 )\r
- {\r
- /* If the task is in the suspended list then there is a\r
- chance it is actually just blocked indefinitely - so really\r
- it should be reported as being in the Blocked state. */\r
- if( eState == eSuspended )\r
- {\r
- vTaskSuspendAll();\r
- {\r
- if( listLIST_ITEM_CONTAINER( &( pxTCB->xEventListItem ) ) != NULL )\r
- {\r
- pxTaskStatus->eCurrentState = eBlocked;\r
- }\r
- }\r
- ( void ) xTaskResumeAll();\r
- }\r
- }\r
- #endif /* INCLUDE_vTaskSuspend */\r
- }\r
- }\r
- else\r
- {\r
- pxTaskStatus->eCurrentState = eTaskGetState( pxTCB );\r
- }\r
-\r
- /* Obtaining the stack space takes some time, so the xGetFreeStackSpace\r
- parameter is provided to allow it to be skipped. */\r
- if( xGetFreeStackSpace != pdFALSE )\r
- {\r
- #if ( portSTACK_GROWTH > 0 )\r
- {\r
- pxTaskStatus->usStackHighWaterMark = prvTaskCheckFreeStackSpace( ( uint8_t * ) pxTCB->pxEndOfStack );\r
- }\r
- #else\r
- {\r
- pxTaskStatus->usStackHighWaterMark = prvTaskCheckFreeStackSpace( ( uint8_t * ) pxTCB->pxStack );\r
- }\r
- #endif\r
- }\r
- else\r
- {\r
- pxTaskStatus->usStackHighWaterMark = 0;\r
- }\r
- }\r
-\r
-#endif /* configUSE_TRACE_FACILITY */\r
-/*-----------------------------------------------------------*/\r
-\r
-#if ( configUSE_TRACE_FACILITY == 1 )\r
-\r
- static UBaseType_t prvListTasksWithinSingleList( TaskStatus_t *pxTaskStatusArray, List_t *pxList, eTaskState eState )\r
- {\r
- configLIST_VOLATILE TCB_t *pxNextTCB, *pxFirstTCB;\r
- UBaseType_t uxTask = 0;\r
-\r
- if( listCURRENT_LIST_LENGTH( pxList ) > ( UBaseType_t ) 0 )\r
- {\r
- listGET_OWNER_OF_NEXT_ENTRY( pxFirstTCB, pxList );\r
-\r
- /* Populate an TaskStatus_t structure within the\r
- pxTaskStatusArray array for each task that is referenced from\r
- pxList. See the definition of TaskStatus_t in task.h for the\r
- meaning of each TaskStatus_t structure member. */\r
- do\r
- {\r
- listGET_OWNER_OF_NEXT_ENTRY( pxNextTCB, pxList );\r
- vTaskGetInfo( ( TaskHandle_t ) pxNextTCB, &( pxTaskStatusArray[ uxTask ] ), pdTRUE, eState );\r
- uxTask++;\r
- } while( pxNextTCB != pxFirstTCB );\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
-\r
- return uxTask;\r
- }\r
-\r
-#endif /* configUSE_TRACE_FACILITY */\r
-/*-----------------------------------------------------------*/\r
-\r
-#if ( ( configUSE_TRACE_FACILITY == 1 ) || ( INCLUDE_uxTaskGetStackHighWaterMark == 1 ) )\r
-\r
- static uint16_t prvTaskCheckFreeStackSpace( const uint8_t * pucStackByte )\r
- {\r
- uint32_t ulCount = 0U;\r
-\r
- while( *pucStackByte == ( uint8_t ) tskSTACK_FILL_BYTE )\r
- {\r
- pucStackByte -= portSTACK_GROWTH;\r
- ulCount++;\r
- }\r
-\r
- ulCount /= ( uint32_t ) sizeof( StackType_t ); /*lint !e961 Casting is not redundant on smaller architectures. */\r
-\r
- return ( uint16_t ) ulCount;\r
- }\r
-\r
-#endif /* ( ( configUSE_TRACE_FACILITY == 1 ) || ( INCLUDE_uxTaskGetStackHighWaterMark == 1 ) ) */\r
-/*-----------------------------------------------------------*/\r
-\r
-#if ( INCLUDE_uxTaskGetStackHighWaterMark == 1 )\r
-\r
- UBaseType_t uxTaskGetStackHighWaterMark( TaskHandle_t xTask )\r
- {\r
- TCB_t *pxTCB;\r
- uint8_t *pucEndOfStack;\r
- UBaseType_t uxReturn;\r
-\r
- pxTCB = prvGetTCBFromHandle( xTask );\r
-\r
- #if portSTACK_GROWTH < 0\r
- {\r
- pucEndOfStack = ( uint8_t * ) pxTCB->pxStack;\r
- }\r
- #else\r
- {\r
- pucEndOfStack = ( uint8_t * ) pxTCB->pxEndOfStack;\r
- }\r
- #endif\r
-\r
- uxReturn = ( UBaseType_t ) prvTaskCheckFreeStackSpace( pucEndOfStack );\r
-\r
- return uxReturn;\r
- }\r
-\r
-#endif /* INCLUDE_uxTaskGetStackHighWaterMark */\r
-/*-----------------------------------------------------------*/\r
-\r
-#if ( INCLUDE_vTaskDelete == 1 )\r
-\r
- static void prvDeleteTCB( TCB_t *pxTCB )\r
- {\r
- /* This call is required specifically for the TriCore port. It must be\r
- above the vPortFree() calls. The call is also used by ports/demos that\r
- want to allocate and clean RAM statically. */\r
- portCLEAN_UP_TCB( pxTCB );\r
-\r
- /* Free up the memory allocated by the scheduler for the task. It is up\r
- to the task to free any memory allocated at the application level. */\r
- #if ( configUSE_NEWLIB_REENTRANT == 1 )\r
- {\r
- _reclaim_reent( &( pxTCB->xNewLib_reent ) );\r
- }\r
- #endif /* configUSE_NEWLIB_REENTRANT */\r
-\r
- #if( ( configSUPPORT_DYNAMIC_ALLOCATION == 1 ) && ( configSUPPORT_STATIC_ALLOCATION == 0 ) && ( portUSING_MPU_WRAPPERS == 0 ) )\r
- {\r
- /* The task can only have been allocated dynamically - free both\r
- the stack and TCB. */\r
- vPortFree( pxTCB->pxStack );\r
- vPortFree( pxTCB );\r
- }\r
- #elif( tskSTATIC_AND_DYNAMIC_ALLOCATION_POSSIBLE != 0 ) /*lint !e731 Macro has been consolidated for readability reasons. */\r
- {\r
- /* The task could have been allocated statically or dynamically, so\r
- check what was statically allocated before trying to free the\r
- memory. */\r
- if( pxTCB->ucStaticallyAllocated == tskDYNAMICALLY_ALLOCATED_STACK_AND_TCB )\r
- {\r
- /* Both the stack and TCB were allocated dynamically, so both\r
- must be freed. */\r
- vPortFree( pxTCB->pxStack );\r
- vPortFree( pxTCB );\r
- }\r
- else if( pxTCB->ucStaticallyAllocated == tskSTATICALLY_ALLOCATED_STACK_ONLY )\r
- {\r
- /* Only the stack was statically allocated, so the TCB is the\r
- only memory that must be freed. */\r
- vPortFree( pxTCB );\r
- }\r
- else\r
- {\r
- /* Neither the stack nor the TCB were allocated dynamically, so\r
- nothing needs to be freed. */\r
- configASSERT( pxTCB->ucStaticallyAllocated == tskSTATICALLY_ALLOCATED_STACK_AND_TCB );\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- #endif /* configSUPPORT_DYNAMIC_ALLOCATION */\r
- }\r
-\r
-#endif /* INCLUDE_vTaskDelete */\r
-/*-----------------------------------------------------------*/\r
-\r
-static void prvResetNextTaskUnblockTime( void )\r
-{\r
-TCB_t *pxTCB;\r
-\r
- if( listLIST_IS_EMPTY( pxDelayedTaskList ) != pdFALSE )\r
- {\r
- /* The new current delayed list is empty. Set xNextTaskUnblockTime to\r
- the maximum possible value so it is extremely unlikely that the\r
- if( xTickCount >= xNextTaskUnblockTime ) test will pass until\r
- there is an item in the delayed list. */\r
- xNextTaskUnblockTime = portMAX_DELAY;\r
- }\r
- else\r
- {\r
- /* The new current delayed list is not empty, get the value of\r
- the item at the head of the delayed list. This is the time at\r
- which the task at the head of the delayed list should be removed\r
- from the Blocked state. */\r
- ( pxTCB ) = ( TCB_t * ) listGET_OWNER_OF_HEAD_ENTRY( pxDelayedTaskList );\r
- xNextTaskUnblockTime = listGET_LIST_ITEM_VALUE( &( ( pxTCB )->xStateListItem ) );\r
- }\r
-}\r
-/*-----------------------------------------------------------*/\r
-\r
-#if ( ( INCLUDE_xTaskGetCurrentTaskHandle == 1 ) || ( configUSE_MUTEXES == 1 ) )\r
-\r
- TaskHandle_t xTaskGetCurrentTaskHandle( void )\r
- {\r
- TaskHandle_t xReturn;\r
-\r
- /* A critical section is not required as this is not called from\r
- an interrupt and the current TCB will always be the same for any\r
- individual execution thread. */\r
- xReturn = pxCurrentTCB;\r
-\r
- return xReturn;\r
- }\r
-\r
-#endif /* ( ( INCLUDE_xTaskGetCurrentTaskHandle == 1 ) || ( configUSE_MUTEXES == 1 ) ) */\r
-/*-----------------------------------------------------------*/\r
-\r
-#if ( ( INCLUDE_xTaskGetSchedulerState == 1 ) || ( configUSE_TIMERS == 1 ) )\r
-\r
- BaseType_t xTaskGetSchedulerState( void )\r
- {\r
- BaseType_t xReturn;\r
-\r
- if( xSchedulerRunning == pdFALSE )\r
- {\r
- xReturn = taskSCHEDULER_NOT_STARTED;\r
- }\r
- else\r
- {\r
- if( uxSchedulerSuspended == ( UBaseType_t ) pdFALSE )\r
- {\r
- xReturn = taskSCHEDULER_RUNNING;\r
- }\r
- else\r
- {\r
- xReturn = taskSCHEDULER_SUSPENDED;\r
- }\r
- }\r
-\r
- return xReturn;\r
- }\r
-\r
-#endif /* ( ( INCLUDE_xTaskGetSchedulerState == 1 ) || ( configUSE_TIMERS == 1 ) ) */\r
-/*-----------------------------------------------------------*/\r
-\r
-#if ( configUSE_MUTEXES == 1 )\r
-\r
- BaseType_t xTaskPriorityInherit( TaskHandle_t const pxMutexHolder )\r
- {\r
- TCB_t * const pxMutexHolderTCB = ( TCB_t * ) pxMutexHolder;\r
- BaseType_t xReturn = pdFALSE;\r
-\r
- /* If the mutex was given back by an interrupt while the queue was\r
- locked then the mutex holder might now be NULL. _RB_ Is this still\r
- needed as interrupts can no longer use mutexes? */\r
- if( pxMutexHolder != NULL )\r
- {\r
- /* If the holder of the mutex has a priority below the priority of\r
- the task attempting to obtain the mutex then it will temporarily\r
- inherit the priority of the task attempting to obtain the mutex. */\r
- if( pxMutexHolderTCB->uxPriority < pxCurrentTCB->uxPriority )\r
- {\r
- /* Adjust the mutex holder state to account for its new\r
- priority. Only reset the event list item value if the value is\r
- not being used for anything else. */\r
- if( ( listGET_LIST_ITEM_VALUE( &( pxMutexHolderTCB->xEventListItem ) ) & taskEVENT_LIST_ITEM_VALUE_IN_USE ) == 0UL )\r
- {\r
- listSET_LIST_ITEM_VALUE( &( pxMutexHolderTCB->xEventListItem ), ( TickType_t ) configMAX_PRIORITIES - ( TickType_t ) pxCurrentTCB->uxPriority ); /*lint !e961 MISRA exception as the casts are only redundant for some ports. */\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
-\r
- /* If the task being modified is in the ready state it will need\r
- to be moved into a new list. */\r
- if( listIS_CONTAINED_WITHIN( &( pxReadyTasksLists[ pxMutexHolderTCB->uxPriority ] ), &( pxMutexHolderTCB->xStateListItem ) ) != pdFALSE )\r
- {\r
- if( uxListRemove( &( pxMutexHolderTCB->xStateListItem ) ) == ( UBaseType_t ) 0 )\r
- {\r
- taskRESET_READY_PRIORITY( pxMutexHolderTCB->uxPriority );\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
-\r
- /* Inherit the priority before being moved into the new list. */\r
- pxMutexHolderTCB->uxPriority = pxCurrentTCB->uxPriority;\r
- prvAddTaskToReadyList( pxMutexHolderTCB );\r
- }\r
- else\r
- {\r
- /* Just inherit the priority. */\r
- pxMutexHolderTCB->uxPriority = pxCurrentTCB->uxPriority;\r
- }\r
-\r
- traceTASK_PRIORITY_INHERIT( pxMutexHolderTCB, pxCurrentTCB->uxPriority );\r
-\r
- /* Inheritance occurred. */\r
- xReturn = pdTRUE;\r
- }\r
- else\r
- {\r
- if( pxMutexHolderTCB->uxBasePriority < pxCurrentTCB->uxPriority )\r
- {\r
- /* The base priority of the mutex holder is lower than the\r
- priority of the task attempting to take the mutex, but the\r
- current priority of the mutex holder is not lower than the\r
- priority of the task attempting to take the mutex.\r
- Therefore the mutex holder must have already inherited a\r
- priority, but inheritance would have occurred if that had\r
- not been the case. */\r
- xReturn = pdTRUE;\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
-\r
- return xReturn;\r
- }\r
-\r
-#endif /* configUSE_MUTEXES */\r
-/*-----------------------------------------------------------*/\r
-\r
-#if ( configUSE_MUTEXES == 1 )\r
-\r
- BaseType_t xTaskPriorityDisinherit( TaskHandle_t const pxMutexHolder )\r
- {\r
- TCB_t * const pxTCB = ( TCB_t * ) pxMutexHolder;\r
- BaseType_t xReturn = pdFALSE;\r
-\r
- if( pxMutexHolder != NULL )\r
- {\r
- /* A task can only have an inherited priority if it holds the mutex.\r
- If the mutex is held by a task then it cannot be given from an\r
- interrupt, and if a mutex is given by the holding task then it must\r
- be the running state task. */\r
- configASSERT( pxTCB == pxCurrentTCB );\r
- configASSERT( pxTCB->uxMutexesHeld );\r
- ( pxTCB->uxMutexesHeld )--;\r
-\r
- /* Has the holder of the mutex inherited the priority of another\r
- task? */\r
- if( pxTCB->uxPriority != pxTCB->uxBasePriority )\r
- {\r
- /* Only disinherit if no other mutexes are held. */\r
- if( pxTCB->uxMutexesHeld == ( UBaseType_t ) 0 )\r
- {\r
- /* A task can only have an inherited priority if it holds\r
- the mutex. If the mutex is held by a task then it cannot be\r
- given from an interrupt, and if a mutex is given by the\r
- holding task then it must be the running state task. Remove\r
- the holding task from the ready list. */\r
- if( uxListRemove( &( pxTCB->xStateListItem ) ) == ( UBaseType_t ) 0 )\r
- {\r
- taskRESET_READY_PRIORITY( pxTCB->uxPriority );\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
-\r
- /* Disinherit the priority before adding the task into the\r
- new ready list. */\r
- traceTASK_PRIORITY_DISINHERIT( pxTCB, pxTCB->uxBasePriority );\r
- pxTCB->uxPriority = pxTCB->uxBasePriority;\r
-\r
- /* Reset the event list item value. It cannot be in use for\r
- any other purpose if this task is running, and it must be\r
- running to give back the mutex. */\r
- listSET_LIST_ITEM_VALUE( &( pxTCB->xEventListItem ), ( TickType_t ) configMAX_PRIORITIES - ( TickType_t ) pxTCB->uxPriority ); /*lint !e961 MISRA exception as the casts are only redundant for some ports. */\r
- prvAddTaskToReadyList( pxTCB );\r
-\r
- /* Return true to indicate that a context switch is required.\r
- This is only actually required in the corner case whereby\r
- multiple mutexes were held and the mutexes were given back\r
- in an order different to that in which they were taken.\r
- If a context switch did not occur when the first mutex was\r
- returned, even if a task was waiting on it, then a context\r
- switch should occur when the last mutex is returned whether\r
- a task is waiting on it or not. */\r
- xReturn = pdTRUE;\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
-\r
- return xReturn;\r
- }\r
-\r
-#endif /* configUSE_MUTEXES */\r
-/*-----------------------------------------------------------*/\r
-\r
-#if ( configUSE_MUTEXES == 1 )\r
-\r
- void vTaskPriorityDisinheritAfterTimeout( TaskHandle_t const pxMutexHolder, UBaseType_t uxHighestPriorityWaitingTask )\r
- {\r
- TCB_t * const pxTCB = ( TCB_t * ) pxMutexHolder;\r
- UBaseType_t uxPriorityUsedOnEntry, uxPriorityToUse;\r
- const UBaseType_t uxOnlyOneMutexHeld = ( UBaseType_t ) 1;\r
-\r
- if( pxMutexHolder != NULL )\r
- {\r
- /* If pxMutexHolder is not NULL then the holder must hold at least\r
- one mutex. */\r
- configASSERT( pxTCB->uxMutexesHeld );\r
-\r
- /* Determine the priority to which the priority of the task that\r
- holds the mutex should be set. This will be the greater of the\r
- holding task's base priority and the priority of the highest\r
- priority task that is waiting to obtain the mutex. */\r
- if( pxTCB->uxBasePriority < uxHighestPriorityWaitingTask )\r
- {\r
- uxPriorityToUse = uxHighestPriorityWaitingTask;\r
- }\r
- else\r
- {\r
- uxPriorityToUse = pxTCB->uxBasePriority;\r
- }\r
-\r
- /* Does the priority need to change? */\r
- if( pxTCB->uxPriority != uxPriorityToUse )\r
- {\r
- /* Only disinherit if no other mutexes are held. This is a\r
- simplification in the priority inheritance implementation. If\r
- the task that holds the mutex is also holding other mutexes then\r
- the other mutexes may have caused the priority inheritance. */\r
- if( pxTCB->uxMutexesHeld == uxOnlyOneMutexHeld )\r
- {\r
- /* If a task has timed out because it already holds the\r
- mutex it was trying to obtain then it cannot of inherited\r
- its own priority. */\r
- configASSERT( pxTCB != pxCurrentTCB );\r
-\r
- /* Disinherit the priority, remembering the previous\r
- priority to facilitate determining the subject task's\r
- state. */\r
- traceTASK_PRIORITY_DISINHERIT( pxTCB, pxTCB->uxBasePriority );\r
- uxPriorityUsedOnEntry = pxTCB->uxPriority;\r
- pxTCB->uxPriority = uxPriorityToUse;\r
-\r
- /* Only reset the event list item value if the value is not\r
- being used for anything else. */\r
- if( ( listGET_LIST_ITEM_VALUE( &( pxTCB->xEventListItem ) ) & taskEVENT_LIST_ITEM_VALUE_IN_USE ) == 0UL )\r
- {\r
- listSET_LIST_ITEM_VALUE( &( pxTCB->xEventListItem ), ( TickType_t ) configMAX_PRIORITIES - ( TickType_t ) uxPriorityToUse ); /*lint !e961 MISRA exception as the casts are only redundant for some ports. */\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
-\r
- /* If the running task is not the task that holds the mutex\r
- then the task that holds the mutex could be in either the\r
- Ready, Blocked or Suspended states. Only remove the task\r
- from its current state list if it is in the Ready state as\r
- the task's priority is going to change and there is one\r
- Ready list per priority. */\r
- if( listIS_CONTAINED_WITHIN( &( pxReadyTasksLists[ uxPriorityUsedOnEntry ] ), &( pxTCB->xStateListItem ) ) != pdFALSE )\r
- {\r
- if( uxListRemove( &( pxTCB->xStateListItem ) ) == ( UBaseType_t ) 0 )\r
- {\r
- taskRESET_READY_PRIORITY( pxTCB->uxPriority );\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
-\r
- prvAddTaskToReadyList( pxTCB );\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
-\r
-#endif /* configUSE_MUTEXES */\r
-/*-----------------------------------------------------------*/\r
-\r
-#if ( portCRITICAL_NESTING_IN_TCB == 1 )\r
-\r
- void vTaskEnterCritical( void )\r
- {\r
- portDISABLE_INTERRUPTS();\r
-\r
- if( xSchedulerRunning != pdFALSE )\r
- {\r
- ( pxCurrentTCB->uxCriticalNesting )++;\r
-\r
- /* This is not the interrupt safe version of the enter critical\r
- function so assert() if it is being called from an interrupt\r
- context. Only API functions that end in "FromISR" can be used in an\r
- interrupt. Only assert if the critical nesting count is 1 to\r
- protect against recursive calls if the assert function also uses a\r
- critical section. */\r
- if( pxCurrentTCB->uxCriticalNesting == 1 )\r
- {\r
- portASSERT_IF_IN_ISR();\r
- }\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
-\r
-#endif /* portCRITICAL_NESTING_IN_TCB */\r
-/*-----------------------------------------------------------*/\r
-\r
-#if ( portCRITICAL_NESTING_IN_TCB == 1 )\r
-\r
- void vTaskExitCritical( void )\r
- {\r
- if( xSchedulerRunning != pdFALSE )\r
- {\r
- if( pxCurrentTCB->uxCriticalNesting > 0U )\r
- {\r
- ( pxCurrentTCB->uxCriticalNesting )--;\r
-\r
- if( pxCurrentTCB->uxCriticalNesting == 0U )\r
- {\r
- portENABLE_INTERRUPTS();\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
-\r
-#endif /* portCRITICAL_NESTING_IN_TCB */\r
-/*-----------------------------------------------------------*/\r
-\r
-#if ( ( configUSE_TRACE_FACILITY == 1 ) && ( configUSE_STATS_FORMATTING_FUNCTIONS > 0 ) )\r
-\r
- static char *prvWriteNameToBuffer( char *pcBuffer, const char *pcTaskName )\r
- {\r
- size_t x;\r
-\r
- /* Start by copying the entire string. */\r
- strcpy( pcBuffer, pcTaskName );\r
-\r
- /* Pad the end of the string with spaces to ensure columns line up when\r
- printed out. */\r
- for( x = strlen( pcBuffer ); x < ( size_t ) ( configMAX_TASK_NAME_LEN - 1 ); x++ )\r
- {\r
- pcBuffer[ x ] = ' ';\r
- }\r
-\r
- /* Terminate. */\r
- pcBuffer[ x ] = 0x00;\r
-\r
- /* Return the new end of string. */\r
- return &( pcBuffer[ x ] );\r
- }\r
-\r
-#endif /* ( configUSE_TRACE_FACILITY == 1 ) && ( configUSE_STATS_FORMATTING_FUNCTIONS > 0 ) */\r
-/*-----------------------------------------------------------*/\r
-\r
-#if ( ( configUSE_TRACE_FACILITY == 1 ) && ( configUSE_STATS_FORMATTING_FUNCTIONS > 0 ) && ( configSUPPORT_DYNAMIC_ALLOCATION == 1 ) )\r
-\r
- void vTaskList( char * pcWriteBuffer )\r
- {\r
- TaskStatus_t *pxTaskStatusArray;\r
- volatile UBaseType_t uxArraySize, x;\r
- char cStatus;\r
-\r
- /*\r
- * PLEASE NOTE:\r
- *\r
- * This function is provided for convenience only, and is used by many\r
- * of the demo applications. Do not consider it to be part of the\r
- * scheduler.\r
- *\r
- * vTaskList() calls uxTaskGetSystemState(), then formats part of the\r
- * uxTaskGetSystemState() output into a human readable table that\r
- * displays task names, states and stack usage.\r
- *\r
- * vTaskList() has a dependency on the sprintf() C library function that\r
- * might bloat the code size, use a lot of stack, and provide different\r
- * results on different platforms. An alternative, tiny, third party,\r
- * and limited functionality implementation of sprintf() is provided in\r
- * many of the FreeRTOS/Demo sub-directories in a file called\r
- * printf-stdarg.c (note printf-stdarg.c does not provide a full\r
- * snprintf() implementation!).\r
- *\r
- * It is recommended that production systems call uxTaskGetSystemState()\r
- * directly to get access to raw stats data, rather than indirectly\r
- * through a call to vTaskList().\r
- */\r
-\r
-\r
- /* Make sure the write buffer does not contain a string. */\r
- *pcWriteBuffer = 0x00;\r
-\r
- /* Take a snapshot of the number of tasks in case it changes while this\r
- function is executing. */\r
- uxArraySize = uxCurrentNumberOfTasks;\r
-\r
- /* Allocate an array index for each task. NOTE! if\r
- configSUPPORT_DYNAMIC_ALLOCATION is set to 0 then pvPortMalloc() will\r
- equate to NULL. */\r
- pxTaskStatusArray = pvPortMalloc( uxCurrentNumberOfTasks * sizeof( TaskStatus_t ) );\r
-\r
- if( pxTaskStatusArray != NULL )\r
- {\r
- /* Generate the (binary) data. */\r
- uxArraySize = uxTaskGetSystemState( pxTaskStatusArray, uxArraySize, NULL );\r
-\r
- /* Create a human readable table from the binary data. */\r
- for( x = 0; x < uxArraySize; x++ )\r
- {\r
- switch( pxTaskStatusArray[ x ].eCurrentState )\r
- {\r
- case eRunning: cStatus = tskRUNNING_CHAR;\r
- break;\r
-\r
- case eReady: cStatus = tskREADY_CHAR;\r
- break;\r
-\r
- case eBlocked: cStatus = tskBLOCKED_CHAR;\r
- break;\r
-\r
- case eSuspended: cStatus = tskSUSPENDED_CHAR;\r
- break;\r
-\r
- case eDeleted: cStatus = tskDELETED_CHAR;\r
- break;\r
-\r
- default: /* Should not get here, but it is included\r
- to prevent static checking errors. */\r
- cStatus = 0x00;\r
- break;\r
- }\r
-\r
- /* Write the task name to the string, padding with spaces so it\r
- can be printed in tabular form more easily. */\r
- pcWriteBuffer = prvWriteNameToBuffer( pcWriteBuffer, pxTaskStatusArray[ x ].pcTaskName );\r
-\r
- /* Write the rest of the string. */\r
- sprintf( pcWriteBuffer, "\t%c\t%u\t%u\t%u\r\n", cStatus, ( unsigned int ) pxTaskStatusArray[ x ].uxCurrentPriority, ( unsigned int ) pxTaskStatusArray[ x ].usStackHighWaterMark, ( unsigned int ) pxTaskStatusArray[ x ].xTaskNumber );\r
- pcWriteBuffer += strlen( pcWriteBuffer );\r
- }\r
-\r
- /* Free the array again. NOTE! If configSUPPORT_DYNAMIC_ALLOCATION\r
- is 0 then vPortFree() will be #defined to nothing. */\r
- vPortFree( pxTaskStatusArray );\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
-\r
-#endif /* ( ( configUSE_TRACE_FACILITY == 1 ) && ( configUSE_STATS_FORMATTING_FUNCTIONS > 0 ) && ( configSUPPORT_DYNAMIC_ALLOCATION == 1 ) ) */\r
-/*----------------------------------------------------------*/\r
-\r
-#if ( ( configGENERATE_RUN_TIME_STATS == 1 ) && ( configUSE_STATS_FORMATTING_FUNCTIONS > 0 ) && ( configSUPPORT_DYNAMIC_ALLOCATION == 1 ) )\r
-\r
- void vTaskGetRunTimeStats( char *pcWriteBuffer )\r
- {\r
- TaskStatus_t *pxTaskStatusArray;\r
- volatile UBaseType_t uxArraySize, x;\r
- uint32_t ulTotalTime, ulStatsAsPercentage;\r
-\r
- #if( configUSE_TRACE_FACILITY != 1 )\r
- {\r
- #error configUSE_TRACE_FACILITY must also be set to 1 in FreeRTOSConfig.h to use vTaskGetRunTimeStats().\r
- }\r
- #endif\r
-\r
- /*\r
- * PLEASE NOTE:\r
- *\r
- * This function is provided for convenience only, and is used by many\r
- * of the demo applications. Do not consider it to be part of the\r
- * scheduler.\r
- *\r
- * vTaskGetRunTimeStats() calls uxTaskGetSystemState(), then formats part\r
- * of the uxTaskGetSystemState() output into a human readable table that\r
- * displays the amount of time each task has spent in the Running state\r
- * in both absolute and percentage terms.\r
- *\r
- * vTaskGetRunTimeStats() has a dependency on the sprintf() C library\r
- * function that might bloat the code size, use a lot of stack, and\r
- * provide different results on different platforms. An alternative,\r
- * tiny, third party, and limited functionality implementation of\r
- * sprintf() is provided in many of the FreeRTOS/Demo sub-directories in\r
- * a file called printf-stdarg.c (note printf-stdarg.c does not provide\r
- * a full snprintf() implementation!).\r
- *\r
- * It is recommended that production systems call uxTaskGetSystemState()\r
- * directly to get access to raw stats data, rather than indirectly\r
- * through a call to vTaskGetRunTimeStats().\r
- */\r
-\r
- /* Make sure the write buffer does not contain a string. */\r
- *pcWriteBuffer = 0x00;\r
-\r
- /* Take a snapshot of the number of tasks in case it changes while this\r
- function is executing. */\r
- uxArraySize = uxCurrentNumberOfTasks;\r
-\r
- /* Allocate an array index for each task. NOTE! If\r
- configSUPPORT_DYNAMIC_ALLOCATION is set to 0 then pvPortMalloc() will\r
- equate to NULL. */\r
- pxTaskStatusArray = pvPortMalloc( uxCurrentNumberOfTasks * sizeof( TaskStatus_t ) );\r
-\r
- if( pxTaskStatusArray != NULL )\r
- {\r
- /* Generate the (binary) data. */\r
- uxArraySize = uxTaskGetSystemState( pxTaskStatusArray, uxArraySize, &ulTotalTime );\r
-\r
- /* For percentage calculations. */\r
- ulTotalTime /= 100UL;\r
-\r
- /* Avoid divide by zero errors. */\r
- if( ulTotalTime > 0 )\r
- {\r
- /* Create a human readable table from the binary data. */\r
- for( x = 0; x < uxArraySize; x++ )\r
- {\r
- /* What percentage of the total run time has the task used?\r
- This will always be rounded down to the nearest integer.\r
- ulTotalRunTimeDiv100 has already been divided by 100. */\r
- ulStatsAsPercentage = pxTaskStatusArray[ x ].ulRunTimeCounter / ulTotalTime;\r
-\r
- /* Write the task name to the string, padding with\r
- spaces so it can be printed in tabular form more\r
- easily. */\r
- pcWriteBuffer = prvWriteNameToBuffer( pcWriteBuffer, pxTaskStatusArray[ x ].pcTaskName );\r
-\r
- if( ulStatsAsPercentage > 0UL )\r
- {\r
- #ifdef portLU_PRINTF_SPECIFIER_REQUIRED\r
- {\r
- sprintf( pcWriteBuffer, "\t%lu\t\t%lu%%\r\n", pxTaskStatusArray[ x ].ulRunTimeCounter, ulStatsAsPercentage );\r
- }\r
- #else\r
- {\r
- /* sizeof( int ) == sizeof( long ) so a smaller\r
- printf() library can be used. */\r
- sprintf( pcWriteBuffer, "\t%u\t\t%u%%\r\n", ( unsigned int ) pxTaskStatusArray[ x ].ulRunTimeCounter, ( unsigned int ) ulStatsAsPercentage );\r
- }\r
- #endif\r
- }\r
- else\r
- {\r
- /* If the percentage is zero here then the task has\r
- consumed less than 1% of the total run time. */\r
- #ifdef portLU_PRINTF_SPECIFIER_REQUIRED\r
- {\r
- sprintf( pcWriteBuffer, "\t%lu\t\t<1%%\r\n", pxTaskStatusArray[ x ].ulRunTimeCounter );\r
- }\r
- #else\r
- {\r
- /* sizeof( int ) == sizeof( long ) so a smaller\r
- printf() library can be used. */\r
- sprintf( pcWriteBuffer, "\t%u\t\t<1%%\r\n", ( unsigned int ) pxTaskStatusArray[ x ].ulRunTimeCounter );\r
- }\r
- #endif\r
- }\r
-\r
- pcWriteBuffer += strlen( pcWriteBuffer );\r
- }\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
-\r
- /* Free the array again. NOTE! If configSUPPORT_DYNAMIC_ALLOCATION\r
- is 0 then vPortFree() will be #defined to nothing. */\r
- vPortFree( pxTaskStatusArray );\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
-\r
-#endif /* ( ( configGENERATE_RUN_TIME_STATS == 1 ) && ( configUSE_STATS_FORMATTING_FUNCTIONS > 0 ) && ( configSUPPORT_STATIC_ALLOCATION == 1 ) ) */\r
-/*-----------------------------------------------------------*/\r
-\r
-TickType_t uxTaskResetEventItemValue( void )\r
-{\r
-TickType_t uxReturn;\r
-\r
- uxReturn = listGET_LIST_ITEM_VALUE( &( pxCurrentTCB->xEventListItem ) );\r
-\r
- /* Reset the event list item to its normal value - so it can be used with\r
- queues and semaphores. */\r
- listSET_LIST_ITEM_VALUE( &( pxCurrentTCB->xEventListItem ), ( ( TickType_t ) configMAX_PRIORITIES - ( TickType_t ) pxCurrentTCB->uxPriority ) ); /*lint !e961 MISRA exception as the casts are only redundant for some ports. */\r
-\r
- return uxReturn;\r
-}\r
-/*-----------------------------------------------------------*/\r
-\r
-#if ( configUSE_MUTEXES == 1 )\r
-\r
- void *pvTaskIncrementMutexHeldCount( void )\r
- {\r
- /* If xSemaphoreCreateMutex() is called before any tasks have been created\r
- then pxCurrentTCB will be NULL. */\r
- if( pxCurrentTCB != NULL )\r
- {\r
- ( pxCurrentTCB->uxMutexesHeld )++;\r
- }\r
-\r
- return pxCurrentTCB;\r
- }\r
-\r
-#endif /* configUSE_MUTEXES */\r
-/*-----------------------------------------------------------*/\r
-\r
-#if( configUSE_TASK_NOTIFICATIONS == 1 )\r
-\r
- uint32_t ulTaskNotifyTake( BaseType_t xClearCountOnExit, TickType_t xTicksToWait )\r
- {\r
- uint32_t ulReturn;\r
-\r
- taskENTER_CRITICAL();\r
- {\r
- /* Only block if the notification count is not already non-zero. */\r
- if( pxCurrentTCB->ulNotifiedValue == 0UL )\r
- {\r
- /* Mark this task as waiting for a notification. */\r
- pxCurrentTCB->ucNotifyState = taskWAITING_NOTIFICATION;\r
-\r
- if( xTicksToWait > ( TickType_t ) 0 )\r
- {\r
- prvAddCurrentTaskToDelayedList( xTicksToWait, pdTRUE );\r
- traceTASK_NOTIFY_TAKE_BLOCK();\r
-\r
- /* All ports are written to allow a yield in a critical\r
- section (some will yield immediately, others wait until the\r
- critical section exits) - but it is not something that\r
- application code should ever do. */\r
- portYIELD_WITHIN_API();\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- taskEXIT_CRITICAL();\r
-\r
- taskENTER_CRITICAL();\r
- {\r
- traceTASK_NOTIFY_TAKE();\r
- ulReturn = pxCurrentTCB->ulNotifiedValue;\r
-\r
- if( ulReturn != 0UL )\r
- {\r
- if( xClearCountOnExit != pdFALSE )\r
- {\r
- pxCurrentTCB->ulNotifiedValue = 0UL;\r
- }\r
- else\r
- {\r
- pxCurrentTCB->ulNotifiedValue = ulReturn - ( uint32_t ) 1;\r
- }\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
-\r
- pxCurrentTCB->ucNotifyState = taskNOT_WAITING_NOTIFICATION;\r
- }\r
- taskEXIT_CRITICAL();\r
-\r
- return ulReturn;\r
- }\r
-\r
-#endif /* configUSE_TASK_NOTIFICATIONS */\r
-/*-----------------------------------------------------------*/\r
-\r
-#if( configUSE_TASK_NOTIFICATIONS == 1 )\r
-\r
- BaseType_t xTaskNotifyWait( uint32_t ulBitsToClearOnEntry, uint32_t ulBitsToClearOnExit, uint32_t *pulNotificationValue, TickType_t xTicksToWait )\r
- {\r
- BaseType_t xReturn;\r
-\r
- taskENTER_CRITICAL();\r
- {\r
- /* Only block if a notification is not already pending. */\r
- if( pxCurrentTCB->ucNotifyState != taskNOTIFICATION_RECEIVED )\r
- {\r
- /* Clear bits in the task's notification value as bits may get\r
- set by the notifying task or interrupt. This can be used to\r
- clear the value to zero. */\r
- pxCurrentTCB->ulNotifiedValue &= ~ulBitsToClearOnEntry;\r
-\r
- /* Mark this task as waiting for a notification. */\r
- pxCurrentTCB->ucNotifyState = taskWAITING_NOTIFICATION;\r
-\r
- if( xTicksToWait > ( TickType_t ) 0 )\r
- {\r
- prvAddCurrentTaskToDelayedList( xTicksToWait, pdTRUE );\r
- traceTASK_NOTIFY_WAIT_BLOCK();\r
-\r
- /* All ports are written to allow a yield in a critical\r
- section (some will yield immediately, others wait until the\r
- critical section exits) - but it is not something that\r
- application code should ever do. */\r
- portYIELD_WITHIN_API();\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- taskEXIT_CRITICAL();\r
-\r
- taskENTER_CRITICAL();\r
- {\r
- traceTASK_NOTIFY_WAIT();\r
-\r
- if( pulNotificationValue != NULL )\r
- {\r
- /* Output the current notification value, which may or may not\r
- have changed. */\r
- *pulNotificationValue = pxCurrentTCB->ulNotifiedValue;\r
- }\r
-\r
- /* If ucNotifyValue is set then either the task never entered the\r
- blocked state (because a notification was already pending) or the\r
- task unblocked because of a notification. Otherwise the task\r
- unblocked because of a timeout. */\r
- if( pxCurrentTCB->ucNotifyState != taskNOTIFICATION_RECEIVED )\r
- {\r
- /* A notification was not received. */\r
- xReturn = pdFALSE;\r
- }\r
- else\r
- {\r
- /* A notification was already pending or a notification was\r
- received while the task was waiting. */\r
- pxCurrentTCB->ulNotifiedValue &= ~ulBitsToClearOnExit;\r
- xReturn = pdTRUE;\r
- }\r
-\r
- pxCurrentTCB->ucNotifyState = taskNOT_WAITING_NOTIFICATION;\r
- }\r
- taskEXIT_CRITICAL();\r
-\r
- return xReturn;\r
- }\r
-\r
-#endif /* configUSE_TASK_NOTIFICATIONS */\r
-/*-----------------------------------------------------------*/\r
-\r
-#if( configUSE_TASK_NOTIFICATIONS == 1 )\r
-\r
- BaseType_t xTaskGenericNotify( TaskHandle_t xTaskToNotify, uint32_t ulValue, eNotifyAction eAction, uint32_t *pulPreviousNotificationValue )\r
- {\r
- TCB_t * pxTCB;\r
- BaseType_t xReturn = pdPASS;\r
- uint8_t ucOriginalNotifyState;\r
-\r
- configASSERT( xTaskToNotify );\r
- pxTCB = ( TCB_t * ) xTaskToNotify;\r
-\r
- taskENTER_CRITICAL();\r
- {\r
- if( pulPreviousNotificationValue != NULL )\r
- {\r
- *pulPreviousNotificationValue = pxTCB->ulNotifiedValue;\r
- }\r
-\r
- ucOriginalNotifyState = pxTCB->ucNotifyState;\r
-\r
- pxTCB->ucNotifyState = taskNOTIFICATION_RECEIVED;\r
-\r
- switch( eAction )\r
- {\r
- case eSetBits :\r
- pxTCB->ulNotifiedValue |= ulValue;\r
- break;\r
-\r
- case eIncrement :\r
- ( pxTCB->ulNotifiedValue )++;\r
- break;\r
-\r
- case eSetValueWithOverwrite :\r
- pxTCB->ulNotifiedValue = ulValue;\r
- break;\r
-\r
- case eSetValueWithoutOverwrite :\r
- if( ucOriginalNotifyState != taskNOTIFICATION_RECEIVED )\r
- {\r
- pxTCB->ulNotifiedValue = ulValue;\r
- }\r
- else\r
- {\r
- /* The value could not be written to the task. */\r
- xReturn = pdFAIL;\r
- }\r
- break;\r
-\r
- case eNoAction:\r
- /* The task is being notified without its notify value being\r
- updated. */\r
- break;\r
- }\r
-\r
- traceTASK_NOTIFY();\r
-\r
- /* If the task is in the blocked state specifically to wait for a\r
- notification then unblock it now. */\r
- if( ucOriginalNotifyState == taskWAITING_NOTIFICATION )\r
- {\r
- ( void ) uxListRemove( &( pxTCB->xStateListItem ) );\r
- prvAddTaskToReadyList( pxTCB );\r
-\r
- /* The task should not have been on an event list. */\r
- configASSERT( listLIST_ITEM_CONTAINER( &( pxTCB->xEventListItem ) ) == NULL );\r
-\r
- #if( configUSE_TICKLESS_IDLE != 0 )\r
- {\r
- /* If a task is blocked waiting for a notification then\r
- xNextTaskUnblockTime might be set to the blocked task's time\r
- out time. If the task is unblocked for a reason other than\r
- a timeout xNextTaskUnblockTime is normally left unchanged,\r
- because it will automatically get reset to a new value when\r
- the tick count equals xNextTaskUnblockTime. However if\r
- tickless idling is used it might be more important to enter\r
- sleep mode at the earliest possible time - so reset\r
- xNextTaskUnblockTime here to ensure it is updated at the\r
- earliest possible time. */\r
- prvResetNextTaskUnblockTime();\r
- }\r
- #endif\r
-\r
- if( pxTCB->uxPriority > pxCurrentTCB->uxPriority )\r
- {\r
- /* The notified task has a priority above the currently\r
- executing task so a yield is required. */\r
- taskYIELD_IF_USING_PREEMPTION();\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- taskEXIT_CRITICAL();\r
-\r
- return xReturn;\r
- }\r
-\r
-#endif /* configUSE_TASK_NOTIFICATIONS */\r
-/*-----------------------------------------------------------*/\r
-\r
-#if( configUSE_TASK_NOTIFICATIONS == 1 )\r
-\r
- BaseType_t xTaskGenericNotifyFromISR( TaskHandle_t xTaskToNotify, uint32_t ulValue, eNotifyAction eAction, uint32_t *pulPreviousNotificationValue, BaseType_t *pxHigherPriorityTaskWoken )\r
- {\r
- TCB_t * pxTCB;\r
- uint8_t ucOriginalNotifyState;\r
- BaseType_t xReturn = pdPASS;\r
- UBaseType_t uxSavedInterruptStatus;\r
-\r
- configASSERT( xTaskToNotify );\r
-\r
- /* RTOS ports that support interrupt nesting have the concept of a\r
- maximum system call (or maximum API call) interrupt priority.\r
- Interrupts that are above the maximum system call priority are keep\r
- permanently enabled, even when the RTOS kernel is in a critical section,\r
- but cannot make any calls to FreeRTOS API functions. If configASSERT()\r
- is defined in FreeRTOSConfig.h then\r
- portASSERT_IF_INTERRUPT_PRIORITY_INVALID() will result in an assertion\r
- failure if a FreeRTOS API function is called from an interrupt that has\r
- been assigned a priority above the configured maximum system call\r
- priority. Only FreeRTOS functions that end in FromISR can be called\r
- from interrupts that have been assigned a priority at or (logically)\r
- below the maximum system call interrupt priority. FreeRTOS maintains a\r
- separate interrupt safe API to ensure interrupt entry is as fast and as\r
- simple as possible. More information (albeit Cortex-M specific) is\r
- provided on the following link:\r
- http://www.freertos.org/RTOS-Cortex-M3-M4.html */\r
- portASSERT_IF_INTERRUPT_PRIORITY_INVALID();\r
-\r
- pxTCB = ( TCB_t * ) xTaskToNotify;\r
-\r
- uxSavedInterruptStatus = portSET_INTERRUPT_MASK_FROM_ISR();\r
- {\r
- if( pulPreviousNotificationValue != NULL )\r
- {\r
- *pulPreviousNotificationValue = pxTCB->ulNotifiedValue;\r
- }\r
-\r
- ucOriginalNotifyState = pxTCB->ucNotifyState;\r
- pxTCB->ucNotifyState = taskNOTIFICATION_RECEIVED;\r
-\r
- switch( eAction )\r
- {\r
- case eSetBits :\r
- pxTCB->ulNotifiedValue |= ulValue;\r
- break;\r
-\r
- case eIncrement :\r
- ( pxTCB->ulNotifiedValue )++;\r
- break;\r
-\r
- case eSetValueWithOverwrite :\r
- pxTCB->ulNotifiedValue = ulValue;\r
- break;\r
-\r
- case eSetValueWithoutOverwrite :\r
- if( ucOriginalNotifyState != taskNOTIFICATION_RECEIVED )\r
- {\r
- pxTCB->ulNotifiedValue = ulValue;\r
- }\r
- else\r
- {\r
- /* The value could not be written to the task. */\r
- xReturn = pdFAIL;\r
- }\r
- break;\r
-\r
- case eNoAction :\r
- /* The task is being notified without its notify value being\r
- updated. */\r
- break;\r
- }\r
-\r
- traceTASK_NOTIFY_FROM_ISR();\r
-\r
- /* If the task is in the blocked state specifically to wait for a\r
- notification then unblock it now. */\r
- if( ucOriginalNotifyState == taskWAITING_NOTIFICATION )\r
- {\r
- /* The task should not have been on an event list. */\r
- configASSERT( listLIST_ITEM_CONTAINER( &( pxTCB->xEventListItem ) ) == NULL );\r
-\r
- if( uxSchedulerSuspended == ( UBaseType_t ) pdFALSE )\r
- {\r
- ( void ) uxListRemove( &( pxTCB->xStateListItem ) );\r
- prvAddTaskToReadyList( pxTCB );\r
- }\r
- else\r
- {\r
- /* The delayed and ready lists cannot be accessed, so hold\r
- this task pending until the scheduler is resumed. */\r
- vListInsertEnd( &( xPendingReadyList ), &( pxTCB->xEventListItem ) );\r
- }\r
-\r
- if( pxTCB->uxPriority > pxCurrentTCB->uxPriority )\r
- {\r
- /* The notified task has a priority above the currently\r
- executing task so a yield is required. */\r
- if( pxHigherPriorityTaskWoken != NULL )\r
- {\r
- *pxHigherPriorityTaskWoken = pdTRUE;\r
- }\r
- else\r
- {\r
- /* Mark that a yield is pending in case the user is not\r
- using the "xHigherPriorityTaskWoken" parameter to an ISR\r
- safe FreeRTOS function. */\r
- xYieldPending = pdTRUE;\r
- }\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- }\r
- portCLEAR_INTERRUPT_MASK_FROM_ISR( uxSavedInterruptStatus );\r
-\r
- return xReturn;\r
- }\r
-\r
-#endif /* configUSE_TASK_NOTIFICATIONS */\r
-/*-----------------------------------------------------------*/\r
-\r
-#if( configUSE_TASK_NOTIFICATIONS == 1 )\r
-\r
- void vTaskNotifyGiveFromISR( TaskHandle_t xTaskToNotify, BaseType_t *pxHigherPriorityTaskWoken )\r
- {\r
- TCB_t * pxTCB;\r
- uint8_t ucOriginalNotifyState;\r
- UBaseType_t uxSavedInterruptStatus;\r
-\r
- configASSERT( xTaskToNotify );\r
-\r
- /* RTOS ports that support interrupt nesting have the concept of a\r
- maximum system call (or maximum API call) interrupt priority.\r
- Interrupts that are above the maximum system call priority are keep\r
- permanently enabled, even when the RTOS kernel is in a critical section,\r
- but cannot make any calls to FreeRTOS API functions. If configASSERT()\r
- is defined in FreeRTOSConfig.h then\r
- portASSERT_IF_INTERRUPT_PRIORITY_INVALID() will result in an assertion\r
- failure if a FreeRTOS API function is called from an interrupt that has\r
- been assigned a priority above the configured maximum system call\r
- priority. Only FreeRTOS functions that end in FromISR can be called\r
- from interrupts that have been assigned a priority at or (logically)\r
- below the maximum system call interrupt priority. FreeRTOS maintains a\r
- separate interrupt safe API to ensure interrupt entry is as fast and as\r
- simple as possible. More information (albeit Cortex-M specific) is\r
- provided on the following link:\r
- http://www.freertos.org/RTOS-Cortex-M3-M4.html */\r
- portASSERT_IF_INTERRUPT_PRIORITY_INVALID();\r
-\r
- pxTCB = ( TCB_t * ) xTaskToNotify;\r
-\r
- uxSavedInterruptStatus = portSET_INTERRUPT_MASK_FROM_ISR();\r
- {\r
- ucOriginalNotifyState = pxTCB->ucNotifyState;\r
- pxTCB->ucNotifyState = taskNOTIFICATION_RECEIVED;\r
-\r
- /* 'Giving' is equivalent to incrementing a count in a counting\r
- semaphore. */\r
- ( pxTCB->ulNotifiedValue )++;\r
-\r
- traceTASK_NOTIFY_GIVE_FROM_ISR();\r
-\r
- /* If the task is in the blocked state specifically to wait for a\r
- notification then unblock it now. */\r
- if( ucOriginalNotifyState == taskWAITING_NOTIFICATION )\r
- {\r
- /* The task should not have been on an event list. */\r
- configASSERT( listLIST_ITEM_CONTAINER( &( pxTCB->xEventListItem ) ) == NULL );\r
-\r
- if( uxSchedulerSuspended == ( UBaseType_t ) pdFALSE )\r
- {\r
- ( void ) uxListRemove( &( pxTCB->xStateListItem ) );\r
- prvAddTaskToReadyList( pxTCB );\r
- }\r
- else\r
- {\r
- /* The delayed and ready lists cannot be accessed, so hold\r
- this task pending until the scheduler is resumed. */\r
- vListInsertEnd( &( xPendingReadyList ), &( pxTCB->xEventListItem ) );\r
- }\r
-\r
- if( pxTCB->uxPriority > pxCurrentTCB->uxPriority )\r
- {\r
- /* The notified task has a priority above the currently\r
- executing task so a yield is required. */\r
- if( pxHigherPriorityTaskWoken != NULL )\r
- {\r
- *pxHigherPriorityTaskWoken = pdTRUE;\r
- }\r
- else\r
- {\r
- /* Mark that a yield is pending in case the user is not\r
- using the "xHigherPriorityTaskWoken" parameter in an ISR\r
- safe FreeRTOS function. */\r
- xYieldPending = pdTRUE;\r
- }\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- }\r
- portCLEAR_INTERRUPT_MASK_FROM_ISR( uxSavedInterruptStatus );\r
- }\r
-\r
-#endif /* configUSE_TASK_NOTIFICATIONS */\r
-\r
-/*-----------------------------------------------------------*/\r
-\r
-#if( configUSE_TASK_NOTIFICATIONS == 1 )\r
-\r
- BaseType_t xTaskNotifyStateClear( TaskHandle_t xTask )\r
- {\r
- TCB_t *pxTCB;\r
- BaseType_t xReturn;\r
-\r
- /* If null is passed in here then it is the calling task that is having\r
- its notification state cleared. */\r
- pxTCB = prvGetTCBFromHandle( xTask );\r
-\r
- taskENTER_CRITICAL();\r
- {\r
- if( pxTCB->ucNotifyState == taskNOTIFICATION_RECEIVED )\r
- {\r
- pxTCB->ucNotifyState = taskNOT_WAITING_NOTIFICATION;\r
- xReturn = pdPASS;\r
- }\r
- else\r
- {\r
- xReturn = pdFAIL;\r
- }\r
- }\r
- taskEXIT_CRITICAL();\r
-\r
- return xReturn;\r
- }\r
-\r
-#endif /* configUSE_TASK_NOTIFICATIONS */\r
-/*-----------------------------------------------------------*/\r
-\r
-\r
-static void prvAddCurrentTaskToDelayedList( TickType_t xTicksToWait, const BaseType_t xCanBlockIndefinitely )\r
-{\r
-TickType_t xTimeToWake;\r
-const TickType_t xConstTickCount = xTickCount;\r
-\r
- #if( INCLUDE_xTaskAbortDelay == 1 )\r
- {\r
- /* About to enter a delayed list, so ensure the ucDelayAborted flag is\r
- reset to pdFALSE so it can be detected as having been set to pdTRUE\r
- when the task leaves the Blocked state. */\r
- pxCurrentTCB->ucDelayAborted = pdFALSE;\r
- }\r
- #endif\r
-\r
- /* Remove the task from the ready list before adding it to the blocked list\r
- as the same list item is used for both lists. */\r
- if( uxListRemove( &( pxCurrentTCB->xStateListItem ) ) == ( UBaseType_t ) 0 )\r
- {\r
- /* The current task must be in a ready list, so there is no need to\r
- check, and the port reset macro can be called directly. */\r
- portRESET_READY_PRIORITY( pxCurrentTCB->uxPriority, uxTopReadyPriority );\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
-\r
- #if ( INCLUDE_vTaskSuspend == 1 )\r
- {\r
- if( ( xTicksToWait == portMAX_DELAY ) && ( xCanBlockIndefinitely != pdFALSE ) )\r
- {\r
- /* Add the task to the suspended task list instead of a delayed task\r
- list to ensure it is not woken by a timing event. It will block\r
- indefinitely. */\r
- vListInsertEnd( &xSuspendedTaskList, &( pxCurrentTCB->xStateListItem ) );\r
- }\r
- else\r
- {\r
- /* Calculate the time at which the task should be woken if the event\r
- does not occur. This may overflow but this doesn't matter, the\r
- kernel will manage it correctly. */\r
- xTimeToWake = xConstTickCount + xTicksToWait;\r
-\r
- /* The list item will be inserted in wake time order. */\r
- listSET_LIST_ITEM_VALUE( &( pxCurrentTCB->xStateListItem ), xTimeToWake );\r
-\r
- if( xTimeToWake < xConstTickCount )\r
- {\r
- /* Wake time has overflowed. Place this item in the overflow\r
- list. */\r
- vListInsert( pxOverflowDelayedTaskList, &( pxCurrentTCB->xStateListItem ) );\r
- }\r
- else\r
- {\r
- /* The wake time has not overflowed, so the current block list\r
- is used. */\r
- vListInsert( pxDelayedTaskList, &( pxCurrentTCB->xStateListItem ) );\r
-\r
- /* If the task entering the blocked state was placed at the\r
- head of the list of blocked tasks then xNextTaskUnblockTime\r
- needs to be updated too. */\r
- if( xTimeToWake < xNextTaskUnblockTime )\r
- {\r
- xNextTaskUnblockTime = xTimeToWake;\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- }\r
- }\r
- #else /* INCLUDE_vTaskSuspend */\r
- {\r
- /* Calculate the time at which the task should be woken if the event\r
- does not occur. This may overflow but this doesn't matter, the kernel\r
- will manage it correctly. */\r
- xTimeToWake = xConstTickCount + xTicksToWait;\r
-\r
- /* The list item will be inserted in wake time order. */\r
- listSET_LIST_ITEM_VALUE( &( pxCurrentTCB->xStateListItem ), xTimeToWake );\r
-\r
- if( xTimeToWake < xConstTickCount )\r
- {\r
- /* Wake time has overflowed. Place this item in the overflow list. */\r
- vListInsert( pxOverflowDelayedTaskList, &( pxCurrentTCB->xStateListItem ) );\r
- }\r
- else\r
- {\r
- /* The wake time has not overflowed, so the current block list is used. */\r
- vListInsert( pxDelayedTaskList, &( pxCurrentTCB->xStateListItem ) );\r
-\r
- /* If the task entering the blocked state was placed at the head of the\r
- list of blocked tasks then xNextTaskUnblockTime needs to be updated\r
- too. */\r
- if( xTimeToWake < xNextTaskUnblockTime )\r
- {\r
- xNextTaskUnblockTime = xTimeToWake;\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
-\r
- /* Avoid compiler warning when INCLUDE_vTaskSuspend is not 1. */\r
- ( void ) xCanBlockIndefinitely;\r
- }\r
- #endif /* INCLUDE_vTaskSuspend */\r
-}\r
-\r
-/* Code below here allows additional code to be inserted into this source file,\r
-especially where access to file scope functions and data is needed (for example\r
-when performing module tests). */\r
-\r
-#ifdef FREERTOS_MODULE_TEST\r
- #include "tasks_test_access_functions.h"\r
-#endif\r
-\r
-\r
-#if( configINCLUDE_FREERTOS_TASK_C_ADDITIONS_H == 1 )\r
-\r
- #include "freertos_tasks_c_additions.h"\r
-\r
- static void freertos_tasks_c_additions_init( void )\r
- {\r
- #ifdef FREERTOS_TASKS_C_ADDITIONS_INIT\r
- FREERTOS_TASKS_C_ADDITIONS_INIT();\r
- #endif\r
- }\r
-\r
-#endif\r
-\r
-\r
+++ /dev/null
-/*\r
- * FreeRTOS Kernel V10.0.1\r
- * Copyright (C) 2017 Amazon.com, Inc. or its affiliates. All Rights Reserved.\r
- *\r
- * Permission is hereby granted, free of charge, to any person obtaining a copy of\r
- * this software and associated documentation files (the "Software"), to deal in\r
- * the Software without restriction, including without limitation the rights to\r
- * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of\r
- * the Software, and to permit persons to whom the Software is furnished to do so,\r
- * subject to the following conditions:\r
- *\r
- * The above copyright notice and this permission notice shall be included in all\r
- * copies or substantial portions of the Software.\r
- *\r
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\r
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS\r
- * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR\r
- * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER\r
- * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN\r
- * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\r
- *\r
- * http://www.FreeRTOS.org\r
- * http://aws.amazon.com/freertos\r
- *\r
- * 1 tab == 4 spaces!\r
- */\r
-\r
-/* Standard includes. */\r
-#include <stdlib.h>\r
-\r
-/* Defining MPU_WRAPPERS_INCLUDED_FROM_API_FILE prevents task.h from redefining\r
-all the API functions to use the MPU wrappers. That should only be done when\r
-task.h is included from an application file. */\r
-#define MPU_WRAPPERS_INCLUDED_FROM_API_FILE\r
-\r
-#include "FreeRTOS.h"\r
-#include "task.h"\r
-#include "queue.h"\r
-#include "timers.h"\r
-\r
-#if ( INCLUDE_xTimerPendFunctionCall == 1 ) && ( configUSE_TIMERS == 0 )\r
- #error configUSE_TIMERS must be set to 1 to make the xTimerPendFunctionCall() function available.\r
-#endif\r
-\r
-/* Lint e961 and e750 are suppressed as a MISRA exception justified because the\r
-MPU ports require MPU_WRAPPERS_INCLUDED_FROM_API_FILE to be defined for the\r
-header files above, but not in this file, in order to generate the correct\r
-privileged Vs unprivileged linkage and placement. */\r
-#undef MPU_WRAPPERS_INCLUDED_FROM_API_FILE /*lint !e961 !e750. */\r
-\r
-\r
-/* This entire source file will be skipped if the application is not configured\r
-to include software timer functionality. This #if is closed at the very bottom\r
-of this file. If you want to include software timer functionality then ensure\r
-configUSE_TIMERS is set to 1 in FreeRTOSConfig.h. */\r
-#if ( configUSE_TIMERS == 1 )\r
-\r
-/* Misc definitions. */\r
-#define tmrNO_DELAY ( TickType_t ) 0U\r
-\r
-/* The name assigned to the timer service task. This can be overridden by\r
-defining trmTIMER_SERVICE_TASK_NAME in FreeRTOSConfig.h. */\r
-#ifndef configTIMER_SERVICE_TASK_NAME\r
- #define configTIMER_SERVICE_TASK_NAME "Tmr Svc"\r
-#endif\r
-\r
-/* The definition of the timers themselves. */\r
-typedef struct tmrTimerControl\r
-{\r
- const char *pcTimerName; /*<< Text name. This is not used by the kernel, it is included simply to make debugging easier. */ /*lint !e971 Unqualified char types are allowed for strings and single characters only. */\r
- ListItem_t xTimerListItem; /*<< Standard linked list item as used by all kernel features for event management. */\r
- TickType_t xTimerPeriodInTicks;/*<< How quickly and often the timer expires. */\r
- UBaseType_t uxAutoReload; /*<< Set to pdTRUE if the timer should be automatically restarted once expired. Set to pdFALSE if the timer is, in effect, a one-shot timer. */\r
- void *pvTimerID; /*<< An ID to identify the timer. This allows the timer to be identified when the same callback is used for multiple timers. */\r
- TimerCallbackFunction_t pxCallbackFunction; /*<< The function that will be called when the timer expires. */\r
- #if( configUSE_TRACE_FACILITY == 1 )\r
- UBaseType_t uxTimerNumber; /*<< An ID assigned by trace tools such as FreeRTOS+Trace */\r
- #endif\r
-\r
- #if( ( configSUPPORT_STATIC_ALLOCATION == 1 ) && ( configSUPPORT_DYNAMIC_ALLOCATION == 1 ) )\r
- uint8_t ucStaticallyAllocated; /*<< Set to pdTRUE if the timer was created statically so no attempt is made to free the memory again if the timer is later deleted. */\r
- #endif\r
-} xTIMER;\r
-\r
-/* The old xTIMER name is maintained above then typedefed to the new Timer_t\r
-name below to enable the use of older kernel aware debuggers. */\r
-typedef xTIMER Timer_t;\r
-\r
-/* The definition of messages that can be sent and received on the timer queue.\r
-Two types of message can be queued - messages that manipulate a software timer,\r
-and messages that request the execution of a non-timer related callback. The\r
-two message types are defined in two separate structures, xTimerParametersType\r
-and xCallbackParametersType respectively. */\r
-typedef struct tmrTimerParameters\r
-{\r
- TickType_t xMessageValue; /*<< An optional value used by a subset of commands, for example, when changing the period of a timer. */\r
- Timer_t * pxTimer; /*<< The timer to which the command will be applied. */\r
-} TimerParameter_t;\r
-\r
-\r
-typedef struct tmrCallbackParameters\r
-{\r
- PendedFunction_t pxCallbackFunction; /* << The callback function to execute. */\r
- void *pvParameter1; /* << The value that will be used as the callback functions first parameter. */\r
- uint32_t ulParameter2; /* << The value that will be used as the callback functions second parameter. */\r
-} CallbackParameters_t;\r
-\r
-/* The structure that contains the two message types, along with an identifier\r
-that is used to determine which message type is valid. */\r
-typedef struct tmrTimerQueueMessage\r
-{\r
- BaseType_t xMessageID; /*<< The command being sent to the timer service task. */\r
- union\r
- {\r
- TimerParameter_t xTimerParameters;\r
-\r
- /* Don't include xCallbackParameters if it is not going to be used as\r
- it makes the structure (and therefore the timer queue) larger. */\r
- #if ( INCLUDE_xTimerPendFunctionCall == 1 )\r
- CallbackParameters_t xCallbackParameters;\r
- #endif /* INCLUDE_xTimerPendFunctionCall */\r
- } u;\r
-} DaemonTaskMessage_t;\r
-\r
-/*lint -save -e956 A manual analysis and inspection has been used to determine\r
-which static variables must be declared volatile. */\r
-\r
-/* The list in which active timers are stored. Timers are referenced in expire\r
-time order, with the nearest expiry time at the front of the list. Only the\r
-timer service task is allowed to access these lists. */\r
-PRIVILEGED_DATA static List_t xActiveTimerList1;\r
-PRIVILEGED_DATA static List_t xActiveTimerList2;\r
-PRIVILEGED_DATA static List_t *pxCurrentTimerList;\r
-PRIVILEGED_DATA static List_t *pxOverflowTimerList;\r
-\r
-/* A queue that is used to send commands to the timer service task. */\r
-PRIVILEGED_DATA static QueueHandle_t xTimerQueue = NULL;\r
-PRIVILEGED_DATA static TaskHandle_t xTimerTaskHandle = NULL;\r
-\r
-/*lint -restore */\r
-\r
-/*-----------------------------------------------------------*/\r
-\r
-#if( configSUPPORT_STATIC_ALLOCATION == 1 )\r
-\r
- /* If static allocation is supported then the application must provide the\r
- following callback function - which enables the application to optionally\r
- provide the memory that will be used by the timer task as the task's stack\r
- and TCB. */\r
- extern void vApplicationGetTimerTaskMemory( StaticTask_t **ppxTimerTaskTCBBuffer, StackType_t **ppxTimerTaskStackBuffer, uint32_t *pulTimerTaskStackSize );\r
-\r
-#endif\r
-\r
-/*\r
- * Initialise the infrastructure used by the timer service task if it has not\r
- * been initialised already.\r
- */\r
-static void prvCheckForValidListAndQueue( void ) PRIVILEGED_FUNCTION;\r
-\r
-/*\r
- * The timer service task (daemon). Timer functionality is controlled by this\r
- * task. Other tasks communicate with the timer service task using the\r
- * xTimerQueue queue.\r
- */\r
-static void prvTimerTask( void *pvParameters ) PRIVILEGED_FUNCTION;\r
-\r
-/*\r
- * Called by the timer service task to interpret and process a command it\r
- * received on the timer queue.\r
- */\r
-static void prvProcessReceivedCommands( void ) PRIVILEGED_FUNCTION;\r
-\r
-/*\r
- * Insert the timer into either xActiveTimerList1, or xActiveTimerList2,\r
- * depending on if the expire time causes a timer counter overflow.\r
- */\r
-static BaseType_t prvInsertTimerInActiveList( Timer_t * const pxTimer, const TickType_t xNextExpiryTime, const TickType_t xTimeNow, const TickType_t xCommandTime ) PRIVILEGED_FUNCTION;\r
-\r
-/*\r
- * An active timer has reached its expire time. Reload the timer if it is an\r
- * auto reload timer, then call its callback.\r
- */\r
-static void prvProcessExpiredTimer( const TickType_t xNextExpireTime, const TickType_t xTimeNow ) PRIVILEGED_FUNCTION;\r
-\r
-/*\r
- * The tick count has overflowed. Switch the timer lists after ensuring the\r
- * current timer list does not still reference some timers.\r
- */\r
-static void prvSwitchTimerLists( void ) PRIVILEGED_FUNCTION;\r
-\r
-/*\r
- * Obtain the current tick count, setting *pxTimerListsWereSwitched to pdTRUE\r
- * if a tick count overflow occurred since prvSampleTimeNow() was last called.\r
- */\r
-static TickType_t prvSampleTimeNow( BaseType_t * const pxTimerListsWereSwitched ) PRIVILEGED_FUNCTION;\r
-\r
-/*\r
- * If the timer list contains any active timers then return the expire time of\r
- * the timer that will expire first and set *pxListWasEmpty to false. If the\r
- * timer list does not contain any timers then return 0 and set *pxListWasEmpty\r
- * to pdTRUE.\r
- */\r
-static TickType_t prvGetNextExpireTime( BaseType_t * const pxListWasEmpty ) PRIVILEGED_FUNCTION;\r
-\r
-/*\r
- * If a timer has expired, process it. Otherwise, block the timer service task\r
- * until either a timer does expire or a command is received.\r
- */\r
-static void prvProcessTimerOrBlockTask( const TickType_t xNextExpireTime, BaseType_t xListWasEmpty ) PRIVILEGED_FUNCTION;\r
-\r
-/*\r
- * Called after a Timer_t structure has been allocated either statically or\r
- * dynamically to fill in the structure's members.\r
- */\r
-static void prvInitialiseNewTimer( const char * const pcTimerName, /*lint !e971 Unqualified char types are allowed for strings and single characters only. */\r
- const TickType_t xTimerPeriodInTicks,\r
- const UBaseType_t uxAutoReload,\r
- void * const pvTimerID,\r
- TimerCallbackFunction_t pxCallbackFunction,\r
- Timer_t *pxNewTimer ) PRIVILEGED_FUNCTION;\r
-/*-----------------------------------------------------------*/\r
-\r
-BaseType_t xTimerCreateTimerTask( void )\r
-{\r
-BaseType_t xReturn = pdFAIL;\r
-\r
- /* This function is called when the scheduler is started if\r
- configUSE_TIMERS is set to 1. Check that the infrastructure used by the\r
- timer service task has been created/initialised. If timers have already\r
- been created then the initialisation will already have been performed. */\r
- prvCheckForValidListAndQueue();\r
-\r
- if( xTimerQueue != NULL )\r
- {\r
- #if( configSUPPORT_STATIC_ALLOCATION == 1 )\r
- {\r
- StaticTask_t *pxTimerTaskTCBBuffer = NULL;\r
- StackType_t *pxTimerTaskStackBuffer = NULL;\r
- uint32_t ulTimerTaskStackSize;\r
-\r
- vApplicationGetTimerTaskMemory( &pxTimerTaskTCBBuffer, &pxTimerTaskStackBuffer, &ulTimerTaskStackSize );\r
- xTimerTaskHandle = xTaskCreateStatic( prvTimerTask,\r
- configTIMER_SERVICE_TASK_NAME,\r
- ulTimerTaskStackSize,\r
- NULL,\r
- ( ( UBaseType_t ) configTIMER_TASK_PRIORITY ) | portPRIVILEGE_BIT,\r
- pxTimerTaskStackBuffer,\r
- pxTimerTaskTCBBuffer );\r
-\r
- if( xTimerTaskHandle != NULL )\r
- {\r
- xReturn = pdPASS;\r
- }\r
- }\r
- #else\r
- {\r
- xReturn = xTaskCreate( prvTimerTask,\r
- configTIMER_SERVICE_TASK_NAME,\r
- configTIMER_TASK_STACK_DEPTH,\r
- NULL,\r
- ( ( UBaseType_t ) configTIMER_TASK_PRIORITY ) | portPRIVILEGE_BIT,\r
- &xTimerTaskHandle );\r
- }\r
- #endif /* configSUPPORT_STATIC_ALLOCATION */\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
-\r
- configASSERT( xReturn );\r
- return xReturn;\r
-}\r
-/*-----------------------------------------------------------*/\r
-\r
-#if( configSUPPORT_DYNAMIC_ALLOCATION == 1 )\r
-\r
- TimerHandle_t xTimerCreate( const char * const pcTimerName, /*lint !e971 Unqualified char types are allowed for strings and single characters only. */\r
- const TickType_t xTimerPeriodInTicks,\r
- const UBaseType_t uxAutoReload,\r
- void * const pvTimerID,\r
- TimerCallbackFunction_t pxCallbackFunction )\r
- {\r
- Timer_t *pxNewTimer;\r
-\r
- pxNewTimer = ( Timer_t * ) pvPortMalloc( sizeof( Timer_t ) );\r
-\r
- if( pxNewTimer != NULL )\r
- {\r
- prvInitialiseNewTimer( pcTimerName, xTimerPeriodInTicks, uxAutoReload, pvTimerID, pxCallbackFunction, pxNewTimer );\r
-\r
- #if( configSUPPORT_STATIC_ALLOCATION == 1 )\r
- {\r
- /* Timers can be created statically or dynamically, so note this\r
- timer was created dynamically in case the timer is later\r
- deleted. */\r
- pxNewTimer->ucStaticallyAllocated = pdFALSE;\r
- }\r
- #endif /* configSUPPORT_STATIC_ALLOCATION */\r
- }\r
-\r
- return pxNewTimer;\r
- }\r
-\r
-#endif /* configSUPPORT_STATIC_ALLOCATION */\r
-/*-----------------------------------------------------------*/\r
-\r
-#if( configSUPPORT_STATIC_ALLOCATION == 1 )\r
-\r
- TimerHandle_t xTimerCreateStatic( const char * const pcTimerName, /*lint !e971 Unqualified char types are allowed for strings and single characters only. */\r
- const TickType_t xTimerPeriodInTicks,\r
- const UBaseType_t uxAutoReload,\r
- void * const pvTimerID,\r
- TimerCallbackFunction_t pxCallbackFunction,\r
- StaticTimer_t *pxTimerBuffer )\r
- {\r
- Timer_t *pxNewTimer;\r
-\r
- #if( configASSERT_DEFINED == 1 )\r
- {\r
- /* Sanity check that the size of the structure used to declare a\r
- variable of type StaticTimer_t equals the size of the real timer\r
- structure. */\r
- volatile size_t xSize = sizeof( StaticTimer_t );\r
- configASSERT( xSize == sizeof( Timer_t ) );\r
- }\r
- #endif /* configASSERT_DEFINED */\r
-\r
- /* A pointer to a StaticTimer_t structure MUST be provided, use it. */\r
- configASSERT( pxTimerBuffer );\r
- pxNewTimer = ( Timer_t * ) pxTimerBuffer; /*lint !e740 Unusual cast is ok as the structures are designed to have the same alignment, and the size is checked by an assert. */\r
-\r
- if( pxNewTimer != NULL )\r
- {\r
- prvInitialiseNewTimer( pcTimerName, xTimerPeriodInTicks, uxAutoReload, pvTimerID, pxCallbackFunction, pxNewTimer );\r
-\r
- #if( configSUPPORT_DYNAMIC_ALLOCATION == 1 )\r
- {\r
- /* Timers can be created statically or dynamically so note this\r
- timer was created statically in case it is later deleted. */\r
- pxNewTimer->ucStaticallyAllocated = pdTRUE;\r
- }\r
- #endif /* configSUPPORT_DYNAMIC_ALLOCATION */\r
- }\r
-\r
- return pxNewTimer;\r
- }\r
-\r
-#endif /* configSUPPORT_STATIC_ALLOCATION */\r
-/*-----------------------------------------------------------*/\r
-\r
-static void prvInitialiseNewTimer( const char * const pcTimerName, /*lint !e971 Unqualified char types are allowed for strings and single characters only. */\r
- const TickType_t xTimerPeriodInTicks,\r
- const UBaseType_t uxAutoReload,\r
- void * const pvTimerID,\r
- TimerCallbackFunction_t pxCallbackFunction,\r
- Timer_t *pxNewTimer )\r
-{\r
- /* 0 is not a valid value for xTimerPeriodInTicks. */\r
- configASSERT( ( xTimerPeriodInTicks > 0 ) );\r
-\r
- if( pxNewTimer != NULL )\r
- {\r
- /* Ensure the infrastructure used by the timer service task has been\r
- created/initialised. */\r
- prvCheckForValidListAndQueue();\r
-\r
- /* Initialise the timer structure members using the function\r
- parameters. */\r
- pxNewTimer->pcTimerName = pcTimerName;\r
- pxNewTimer->xTimerPeriodInTicks = xTimerPeriodInTicks;\r
- pxNewTimer->uxAutoReload = uxAutoReload;\r
- pxNewTimer->pvTimerID = pvTimerID;\r
- pxNewTimer->pxCallbackFunction = pxCallbackFunction;\r
- vListInitialiseItem( &( pxNewTimer->xTimerListItem ) );\r
- traceTIMER_CREATE( pxNewTimer );\r
- }\r
-}\r
-/*-----------------------------------------------------------*/\r
-\r
-BaseType_t xTimerGenericCommand( TimerHandle_t xTimer, const BaseType_t xCommandID, const TickType_t xOptionalValue, BaseType_t * const pxHigherPriorityTaskWoken, const TickType_t xTicksToWait )\r
-{\r
-BaseType_t xReturn = pdFAIL;\r
-DaemonTaskMessage_t xMessage;\r
-\r
- configASSERT( xTimer );\r
-\r
- /* Send a message to the timer service task to perform a particular action\r
- on a particular timer definition. */\r
- if( xTimerQueue != NULL )\r
- {\r
- /* Send a command to the timer service task to start the xTimer timer. */\r
- xMessage.xMessageID = xCommandID;\r
- xMessage.u.xTimerParameters.xMessageValue = xOptionalValue;\r
- xMessage.u.xTimerParameters.pxTimer = ( Timer_t * ) xTimer;\r
-\r
- if( xCommandID < tmrFIRST_FROM_ISR_COMMAND )\r
- {\r
- if( xTaskGetSchedulerState() == taskSCHEDULER_RUNNING )\r
- {\r
- xReturn = xQueueSendToBack( xTimerQueue, &xMessage, xTicksToWait );\r
- }\r
- else\r
- {\r
- xReturn = xQueueSendToBack( xTimerQueue, &xMessage, tmrNO_DELAY );\r
- }\r
- }\r
- else\r
- {\r
- xReturn = xQueueSendToBackFromISR( xTimerQueue, &xMessage, pxHigherPriorityTaskWoken );\r
- }\r
-\r
- traceTIMER_COMMAND_SEND( xTimer, xCommandID, xOptionalValue, xReturn );\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
-\r
- return xReturn;\r
-}\r
-/*-----------------------------------------------------------*/\r
-\r
-TaskHandle_t xTimerGetTimerDaemonTaskHandle( void )\r
-{\r
- /* If xTimerGetTimerDaemonTaskHandle() is called before the scheduler has been\r
- started, then xTimerTaskHandle will be NULL. */\r
- configASSERT( ( xTimerTaskHandle != NULL ) );\r
- return xTimerTaskHandle;\r
-}\r
-/*-----------------------------------------------------------*/\r
-\r
-TickType_t xTimerGetPeriod( TimerHandle_t xTimer )\r
-{\r
-Timer_t *pxTimer = ( Timer_t * ) xTimer;\r
-\r
- configASSERT( xTimer );\r
- return pxTimer->xTimerPeriodInTicks;\r
-}\r
-/*-----------------------------------------------------------*/\r
-\r
-TickType_t xTimerGetExpiryTime( TimerHandle_t xTimer )\r
-{\r
-Timer_t * pxTimer = ( Timer_t * ) xTimer;\r
-TickType_t xReturn;\r
-\r
- configASSERT( xTimer );\r
- xReturn = listGET_LIST_ITEM_VALUE( &( pxTimer->xTimerListItem ) );\r
- return xReturn;\r
-}\r
-/*-----------------------------------------------------------*/\r
-\r
-const char * pcTimerGetName( TimerHandle_t xTimer ) /*lint !e971 Unqualified char types are allowed for strings and single characters only. */\r
-{\r
-Timer_t *pxTimer = ( Timer_t * ) xTimer;\r
-\r
- configASSERT( xTimer );\r
- return pxTimer->pcTimerName;\r
-}\r
-/*-----------------------------------------------------------*/\r
-\r
-static void prvProcessExpiredTimer( const TickType_t xNextExpireTime, const TickType_t xTimeNow )\r
-{\r
-BaseType_t xResult;\r
-Timer_t * const pxTimer = ( Timer_t * ) listGET_OWNER_OF_HEAD_ENTRY( pxCurrentTimerList );\r
-\r
- /* Remove the timer from the list of active timers. A check has already\r
- been performed to ensure the list is not empty. */\r
- ( void ) uxListRemove( &( pxTimer->xTimerListItem ) );\r
- traceTIMER_EXPIRED( pxTimer );\r
-\r
- /* If the timer is an auto reload timer then calculate the next\r
- expiry time and re-insert the timer in the list of active timers. */\r
- if( pxTimer->uxAutoReload == ( UBaseType_t ) pdTRUE )\r
- {\r
- /* The timer is inserted into a list using a time relative to anything\r
- other than the current time. It will therefore be inserted into the\r
- correct list relative to the time this task thinks it is now. */\r
- if( prvInsertTimerInActiveList( pxTimer, ( xNextExpireTime + pxTimer->xTimerPeriodInTicks ), xTimeNow, xNextExpireTime ) != pdFALSE )\r
- {\r
- /* The timer expired before it was added to the active timer\r
- list. Reload it now. */\r
- xResult = xTimerGenericCommand( pxTimer, tmrCOMMAND_START_DONT_TRACE, xNextExpireTime, NULL, tmrNO_DELAY );\r
- configASSERT( xResult );\r
- ( void ) xResult;\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
-\r
- /* Call the timer callback. */\r
- pxTimer->pxCallbackFunction( ( TimerHandle_t ) pxTimer );\r
-}\r
-/*-----------------------------------------------------------*/\r
-\r
-static void prvTimerTask( void *pvParameters )\r
-{\r
-TickType_t xNextExpireTime;\r
-BaseType_t xListWasEmpty;\r
-\r
- /* Just to avoid compiler warnings. */\r
- ( void ) pvParameters;\r
-\r
- #if( configUSE_DAEMON_TASK_STARTUP_HOOK == 1 )\r
- {\r
- extern void vApplicationDaemonTaskStartupHook( void );\r
-\r
- /* Allow the application writer to execute some code in the context of\r
- this task at the point the task starts executing. This is useful if the\r
- application includes initialisation code that would benefit from\r
- executing after the scheduler has been started. */\r
- vApplicationDaemonTaskStartupHook();\r
- }\r
- #endif /* configUSE_DAEMON_TASK_STARTUP_HOOK */\r
-\r
- for( ;; )\r
- {\r
- /* Query the timers list to see if it contains any timers, and if so,\r
- obtain the time at which the next timer will expire. */\r
- xNextExpireTime = prvGetNextExpireTime( &xListWasEmpty );\r
-\r
- /* If a timer has expired, process it. Otherwise, block this task\r
- until either a timer does expire, or a command is received. */\r
- prvProcessTimerOrBlockTask( xNextExpireTime, xListWasEmpty );\r
-\r
- /* Empty the command queue. */\r
- prvProcessReceivedCommands();\r
- }\r
-}\r
-/*-----------------------------------------------------------*/\r
-\r
-static void prvProcessTimerOrBlockTask( const TickType_t xNextExpireTime, BaseType_t xListWasEmpty )\r
-{\r
-TickType_t xTimeNow;\r
-BaseType_t xTimerListsWereSwitched;\r
-\r
- vTaskSuspendAll();\r
- {\r
- /* Obtain the time now to make an assessment as to whether the timer\r
- has expired or not. If obtaining the time causes the lists to switch\r
- then don't process this timer as any timers that remained in the list\r
- when the lists were switched will have been processed within the\r
- prvSampleTimeNow() function. */\r
- xTimeNow = prvSampleTimeNow( &xTimerListsWereSwitched );\r
- if( xTimerListsWereSwitched == pdFALSE )\r
- {\r
- /* The tick count has not overflowed, has the timer expired? */\r
- if( ( xListWasEmpty == pdFALSE ) && ( xNextExpireTime <= xTimeNow ) )\r
- {\r
- ( void ) xTaskResumeAll();\r
- prvProcessExpiredTimer( xNextExpireTime, xTimeNow );\r
- }\r
- else\r
- {\r
- /* The tick count has not overflowed, and the next expire\r
- time has not been reached yet. This task should therefore\r
- block to wait for the next expire time or a command to be\r
- received - whichever comes first. The following line cannot\r
- be reached unless xNextExpireTime > xTimeNow, except in the\r
- case when the current timer list is empty. */\r
- if( xListWasEmpty != pdFALSE )\r
- {\r
- /* The current timer list is empty - is the overflow list\r
- also empty? */\r
- xListWasEmpty = listLIST_IS_EMPTY( pxOverflowTimerList );\r
- }\r
-\r
- vQueueWaitForMessageRestricted( xTimerQueue, ( xNextExpireTime - xTimeNow ), xListWasEmpty );\r
-\r
- if( xTaskResumeAll() == pdFALSE )\r
- {\r
- /* Yield to wait for either a command to arrive, or the\r
- block time to expire. If a command arrived between the\r
- critical section being exited and this yield then the yield\r
- will not cause the task to block. */\r
- portYIELD_WITHIN_API();\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- }\r
- else\r
- {\r
- ( void ) xTaskResumeAll();\r
- }\r
- }\r
-}\r
-/*-----------------------------------------------------------*/\r
-\r
-static TickType_t prvGetNextExpireTime( BaseType_t * const pxListWasEmpty )\r
-{\r
-TickType_t xNextExpireTime;\r
-\r
- /* Timers are listed in expiry time order, with the head of the list\r
- referencing the task that will expire first. Obtain the time at which\r
- the timer with the nearest expiry time will expire. If there are no\r
- active timers then just set the next expire time to 0. That will cause\r
- this task to unblock when the tick count overflows, at which point the\r
- timer lists will be switched and the next expiry time can be\r
- re-assessed. */\r
- *pxListWasEmpty = listLIST_IS_EMPTY( pxCurrentTimerList );\r
- if( *pxListWasEmpty == pdFALSE )\r
- {\r
- xNextExpireTime = listGET_ITEM_VALUE_OF_HEAD_ENTRY( pxCurrentTimerList );\r
- }\r
- else\r
- {\r
- /* Ensure the task unblocks when the tick count rolls over. */\r
- xNextExpireTime = ( TickType_t ) 0U;\r
- }\r
-\r
- return xNextExpireTime;\r
-}\r
-/*-----------------------------------------------------------*/\r
-\r
-static TickType_t prvSampleTimeNow( BaseType_t * const pxTimerListsWereSwitched )\r
-{\r
-TickType_t xTimeNow;\r
-PRIVILEGED_DATA static TickType_t xLastTime = ( TickType_t ) 0U; /*lint !e956 Variable is only accessible to one task. */\r
-\r
- xTimeNow = xTaskGetTickCount();\r
-\r
- if( xTimeNow < xLastTime )\r
- {\r
- prvSwitchTimerLists();\r
- *pxTimerListsWereSwitched = pdTRUE;\r
- }\r
- else\r
- {\r
- *pxTimerListsWereSwitched = pdFALSE;\r
- }\r
-\r
- xLastTime = xTimeNow;\r
-\r
- return xTimeNow;\r
-}\r
-/*-----------------------------------------------------------*/\r
-\r
-static BaseType_t prvInsertTimerInActiveList( Timer_t * const pxTimer, const TickType_t xNextExpiryTime, const TickType_t xTimeNow, const TickType_t xCommandTime )\r
-{\r
-BaseType_t xProcessTimerNow = pdFALSE;\r
-\r
- listSET_LIST_ITEM_VALUE( &( pxTimer->xTimerListItem ), xNextExpiryTime );\r
- listSET_LIST_ITEM_OWNER( &( pxTimer->xTimerListItem ), pxTimer );\r
-\r
- if( xNextExpiryTime <= xTimeNow )\r
- {\r
- /* Has the expiry time elapsed between the command to start/reset a\r
- timer was issued, and the time the command was processed? */\r
- if( ( ( TickType_t ) ( xTimeNow - xCommandTime ) ) >= pxTimer->xTimerPeriodInTicks ) /*lint !e961 MISRA exception as the casts are only redundant for some ports. */\r
- {\r
- /* The time between a command being issued and the command being\r
- processed actually exceeds the timers period. */\r
- xProcessTimerNow = pdTRUE;\r
- }\r
- else\r
- {\r
- vListInsert( pxOverflowTimerList, &( pxTimer->xTimerListItem ) );\r
- }\r
- }\r
- else\r
- {\r
- if( ( xTimeNow < xCommandTime ) && ( xNextExpiryTime >= xCommandTime ) )\r
- {\r
- /* If, since the command was issued, the tick count has overflowed\r
- but the expiry time has not, then the timer must have already passed\r
- its expiry time and should be processed immediately. */\r
- xProcessTimerNow = pdTRUE;\r
- }\r
- else\r
- {\r
- vListInsert( pxCurrentTimerList, &( pxTimer->xTimerListItem ) );\r
- }\r
- }\r
-\r
- return xProcessTimerNow;\r
-}\r
-/*-----------------------------------------------------------*/\r
-\r
-static void prvProcessReceivedCommands( void )\r
-{\r
-DaemonTaskMessage_t xMessage;\r
-Timer_t *pxTimer;\r
-BaseType_t xTimerListsWereSwitched, xResult;\r
-TickType_t xTimeNow;\r
-\r
- while( xQueueReceive( xTimerQueue, &xMessage, tmrNO_DELAY ) != pdFAIL ) /*lint !e603 xMessage does not have to be initialised as it is passed out, not in, and it is not used unless xQueueReceive() returns pdTRUE. */\r
- {\r
- #if ( INCLUDE_xTimerPendFunctionCall == 1 )\r
- {\r
- /* Negative commands are pended function calls rather than timer\r
- commands. */\r
- if( xMessage.xMessageID < ( BaseType_t ) 0 )\r
- {\r
- const CallbackParameters_t * const pxCallback = &( xMessage.u.xCallbackParameters );\r
-\r
- /* The timer uses the xCallbackParameters member to request a\r
- callback be executed. Check the callback is not NULL. */\r
- configASSERT( pxCallback );\r
-\r
- /* Call the function. */\r
- pxCallback->pxCallbackFunction( pxCallback->pvParameter1, pxCallback->ulParameter2 );\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- #endif /* INCLUDE_xTimerPendFunctionCall */\r
-\r
- /* Commands that are positive are timer commands rather than pended\r
- function calls. */\r
- if( xMessage.xMessageID >= ( BaseType_t ) 0 )\r
- {\r
- /* The messages uses the xTimerParameters member to work on a\r
- software timer. */\r
- pxTimer = xMessage.u.xTimerParameters.pxTimer;\r
-\r
- if( listIS_CONTAINED_WITHIN( NULL, &( pxTimer->xTimerListItem ) ) == pdFALSE ) /*lint !e961. The cast is only redundant when NULL is passed into the macro. */\r
- {\r
- /* The timer is in a list, remove it. */\r
- ( void ) uxListRemove( &( pxTimer->xTimerListItem ) );\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
-\r
- traceTIMER_COMMAND_RECEIVED( pxTimer, xMessage.xMessageID, xMessage.u.xTimerParameters.xMessageValue );\r
-\r
- /* In this case the xTimerListsWereSwitched parameter is not used, but\r
- it must be present in the function call. prvSampleTimeNow() must be\r
- called after the message is received from xTimerQueue so there is no\r
- possibility of a higher priority task adding a message to the message\r
- queue with a time that is ahead of the timer daemon task (because it\r
- pre-empted the timer daemon task after the xTimeNow value was set). */\r
- xTimeNow = prvSampleTimeNow( &xTimerListsWereSwitched );\r
-\r
- switch( xMessage.xMessageID )\r
- {\r
- case tmrCOMMAND_START :\r
- case tmrCOMMAND_START_FROM_ISR :\r
- case tmrCOMMAND_RESET :\r
- case tmrCOMMAND_RESET_FROM_ISR :\r
- case tmrCOMMAND_START_DONT_TRACE :\r
- /* Start or restart a timer. */\r
- if( prvInsertTimerInActiveList( pxTimer, xMessage.u.xTimerParameters.xMessageValue + pxTimer->xTimerPeriodInTicks, xTimeNow, xMessage.u.xTimerParameters.xMessageValue ) != pdFALSE )\r
- {\r
- /* The timer expired before it was added to the active\r
- timer list. Process it now. */\r
- pxTimer->pxCallbackFunction( ( TimerHandle_t ) pxTimer );\r
- traceTIMER_EXPIRED( pxTimer );\r
-\r
- if( pxTimer->uxAutoReload == ( UBaseType_t ) pdTRUE )\r
- {\r
- xResult = xTimerGenericCommand( pxTimer, tmrCOMMAND_START_DONT_TRACE, xMessage.u.xTimerParameters.xMessageValue + pxTimer->xTimerPeriodInTicks, NULL, tmrNO_DELAY );\r
- configASSERT( xResult );\r
- ( void ) xResult;\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- break;\r
-\r
- case tmrCOMMAND_STOP :\r
- case tmrCOMMAND_STOP_FROM_ISR :\r
- /* The timer has already been removed from the active list.\r
- There is nothing to do here. */\r
- break;\r
-\r
- case tmrCOMMAND_CHANGE_PERIOD :\r
- case tmrCOMMAND_CHANGE_PERIOD_FROM_ISR :\r
- pxTimer->xTimerPeriodInTicks = xMessage.u.xTimerParameters.xMessageValue;\r
- configASSERT( ( pxTimer->xTimerPeriodInTicks > 0 ) );\r
-\r
- /* The new period does not really have a reference, and can\r
- be longer or shorter than the old one. The command time is\r
- therefore set to the current time, and as the period cannot\r
- be zero the next expiry time can only be in the future,\r
- meaning (unlike for the xTimerStart() case above) there is\r
- no fail case that needs to be handled here. */\r
- ( void ) prvInsertTimerInActiveList( pxTimer, ( xTimeNow + pxTimer->xTimerPeriodInTicks ), xTimeNow, xTimeNow );\r
- break;\r
-\r
- case tmrCOMMAND_DELETE :\r
- /* The timer has already been removed from the active list,\r
- just free up the memory if the memory was dynamically\r
- allocated. */\r
- #if( ( configSUPPORT_DYNAMIC_ALLOCATION == 1 ) && ( configSUPPORT_STATIC_ALLOCATION == 0 ) )\r
- {\r
- /* The timer can only have been allocated dynamically -\r
- free it again. */\r
- vPortFree( pxTimer );\r
- }\r
- #elif( ( configSUPPORT_DYNAMIC_ALLOCATION == 1 ) && ( configSUPPORT_STATIC_ALLOCATION == 1 ) )\r
- {\r
- /* The timer could have been allocated statically or\r
- dynamically, so check before attempting to free the\r
- memory. */\r
- if( pxTimer->ucStaticallyAllocated == ( uint8_t ) pdFALSE )\r
- {\r
- vPortFree( pxTimer );\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- #endif /* configSUPPORT_DYNAMIC_ALLOCATION */\r
- break;\r
-\r
- default :\r
- /* Don't expect to get here. */\r
- break;\r
- }\r
- }\r
- }\r
-}\r
-/*-----------------------------------------------------------*/\r
-\r
-static void prvSwitchTimerLists( void )\r
-{\r
-TickType_t xNextExpireTime, xReloadTime;\r
-List_t *pxTemp;\r
-Timer_t *pxTimer;\r
-BaseType_t xResult;\r
-\r
- /* The tick count has overflowed. The timer lists must be switched.\r
- If there are any timers still referenced from the current timer list\r
- then they must have expired and should be processed before the lists\r
- are switched. */\r
- while( listLIST_IS_EMPTY( pxCurrentTimerList ) == pdFALSE )\r
- {\r
- xNextExpireTime = listGET_ITEM_VALUE_OF_HEAD_ENTRY( pxCurrentTimerList );\r
-\r
- /* Remove the timer from the list. */\r
- pxTimer = ( Timer_t * ) listGET_OWNER_OF_HEAD_ENTRY( pxCurrentTimerList );\r
- ( void ) uxListRemove( &( pxTimer->xTimerListItem ) );\r
- traceTIMER_EXPIRED( pxTimer );\r
-\r
- /* Execute its callback, then send a command to restart the timer if\r
- it is an auto-reload timer. It cannot be restarted here as the lists\r
- have not yet been switched. */\r
- pxTimer->pxCallbackFunction( ( TimerHandle_t ) pxTimer );\r
-\r
- if( pxTimer->uxAutoReload == ( UBaseType_t ) pdTRUE )\r
- {\r
- /* Calculate the reload value, and if the reload value results in\r
- the timer going into the same timer list then it has already expired\r
- and the timer should be re-inserted into the current list so it is\r
- processed again within this loop. Otherwise a command should be sent\r
- to restart the timer to ensure it is only inserted into a list after\r
- the lists have been swapped. */\r
- xReloadTime = ( xNextExpireTime + pxTimer->xTimerPeriodInTicks );\r
- if( xReloadTime > xNextExpireTime )\r
- {\r
- listSET_LIST_ITEM_VALUE( &( pxTimer->xTimerListItem ), xReloadTime );\r
- listSET_LIST_ITEM_OWNER( &( pxTimer->xTimerListItem ), pxTimer );\r
- vListInsert( pxCurrentTimerList, &( pxTimer->xTimerListItem ) );\r
- }\r
- else\r
- {\r
- xResult = xTimerGenericCommand( pxTimer, tmrCOMMAND_START_DONT_TRACE, xNextExpireTime, NULL, tmrNO_DELAY );\r
- configASSERT( xResult );\r
- ( void ) xResult;\r
- }\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
-\r
- pxTemp = pxCurrentTimerList;\r
- pxCurrentTimerList = pxOverflowTimerList;\r
- pxOverflowTimerList = pxTemp;\r
-}\r
-/*-----------------------------------------------------------*/\r
-\r
-static void prvCheckForValidListAndQueue( void )\r
-{\r
- /* Check that the list from which active timers are referenced, and the\r
- queue used to communicate with the timer service, have been\r
- initialised. */\r
- taskENTER_CRITICAL();\r
- {\r
- if( xTimerQueue == NULL )\r
- {\r
- vListInitialise( &xActiveTimerList1 );\r
- vListInitialise( &xActiveTimerList2 );\r
- pxCurrentTimerList = &xActiveTimerList1;\r
- pxOverflowTimerList = &xActiveTimerList2;\r
-\r
- #if( configSUPPORT_STATIC_ALLOCATION == 1 )\r
- {\r
- /* The timer queue is allocated statically in case\r
- configSUPPORT_DYNAMIC_ALLOCATION is 0. */\r
- static StaticQueue_t xStaticTimerQueue; /*lint !e956 Ok to declare in this manner to prevent additional conditional compilation guards in other locations. */\r
- static uint8_t ucStaticTimerQueueStorage[ ( size_t ) configTIMER_QUEUE_LENGTH * sizeof( DaemonTaskMessage_t ) ]; /*lint !e956 Ok to declare in this manner to prevent additional conditional compilation guards in other locations. */\r
-\r
- xTimerQueue = xQueueCreateStatic( ( UBaseType_t ) configTIMER_QUEUE_LENGTH, ( UBaseType_t ) sizeof( DaemonTaskMessage_t ), &( ucStaticTimerQueueStorage[ 0 ] ), &xStaticTimerQueue );\r
- }\r
- #else\r
- {\r
- xTimerQueue = xQueueCreate( ( UBaseType_t ) configTIMER_QUEUE_LENGTH, sizeof( DaemonTaskMessage_t ) );\r
- }\r
- #endif\r
-\r
- #if ( configQUEUE_REGISTRY_SIZE > 0 )\r
- {\r
- if( xTimerQueue != NULL )\r
- {\r
- vQueueAddToRegistry( xTimerQueue, "TmrQ" );\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- #endif /* configQUEUE_REGISTRY_SIZE */\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- taskEXIT_CRITICAL();\r
-}\r
-/*-----------------------------------------------------------*/\r
-\r
-BaseType_t xTimerIsTimerActive( TimerHandle_t xTimer )\r
-{\r
-BaseType_t xTimerIsInActiveList;\r
-Timer_t *pxTimer = ( Timer_t * ) xTimer;\r
-\r
- configASSERT( xTimer );\r
-\r
- /* Is the timer in the list of active timers? */\r
- taskENTER_CRITICAL();\r
- {\r
- /* Checking to see if it is in the NULL list in effect checks to see if\r
- it is referenced from either the current or the overflow timer lists in\r
- one go, but the logic has to be reversed, hence the '!'. */\r
- xTimerIsInActiveList = ( BaseType_t ) !( listIS_CONTAINED_WITHIN( NULL, &( pxTimer->xTimerListItem ) ) ); /*lint !e961. Cast is only redundant when NULL is passed into the macro. */\r
- }\r
- taskEXIT_CRITICAL();\r
-\r
- return xTimerIsInActiveList;\r
-} /*lint !e818 Can't be pointer to const due to the typedef. */\r
-/*-----------------------------------------------------------*/\r
-\r
-void *pvTimerGetTimerID( const TimerHandle_t xTimer )\r
-{\r
-Timer_t * const pxTimer = ( Timer_t * ) xTimer;\r
-void *pvReturn;\r
-\r
- configASSERT( xTimer );\r
-\r
- taskENTER_CRITICAL();\r
- {\r
- pvReturn = pxTimer->pvTimerID;\r
- }\r
- taskEXIT_CRITICAL();\r
-\r
- return pvReturn;\r
-}\r
-/*-----------------------------------------------------------*/\r
-\r
-void vTimerSetTimerID( TimerHandle_t xTimer, void *pvNewID )\r
-{\r
-Timer_t * const pxTimer = ( Timer_t * ) xTimer;\r
-\r
- configASSERT( xTimer );\r
-\r
- taskENTER_CRITICAL();\r
- {\r
- pxTimer->pvTimerID = pvNewID;\r
- }\r
- taskEXIT_CRITICAL();\r
-}\r
-/*-----------------------------------------------------------*/\r
-\r
-#if( INCLUDE_xTimerPendFunctionCall == 1 )\r
-\r
- BaseType_t xTimerPendFunctionCallFromISR( PendedFunction_t xFunctionToPend, void *pvParameter1, uint32_t ulParameter2, BaseType_t *pxHigherPriorityTaskWoken )\r
- {\r
- DaemonTaskMessage_t xMessage;\r
- BaseType_t xReturn;\r
-\r
- /* Complete the message with the function parameters and post it to the\r
- daemon task. */\r
- xMessage.xMessageID = tmrCOMMAND_EXECUTE_CALLBACK_FROM_ISR;\r
- xMessage.u.xCallbackParameters.pxCallbackFunction = xFunctionToPend;\r
- xMessage.u.xCallbackParameters.pvParameter1 = pvParameter1;\r
- xMessage.u.xCallbackParameters.ulParameter2 = ulParameter2;\r
-\r
- xReturn = xQueueSendFromISR( xTimerQueue, &xMessage, pxHigherPriorityTaskWoken );\r
-\r
- tracePEND_FUNC_CALL_FROM_ISR( xFunctionToPend, pvParameter1, ulParameter2, xReturn );\r
-\r
- return xReturn;\r
- }\r
-\r
-#endif /* INCLUDE_xTimerPendFunctionCall */\r
-/*-----------------------------------------------------------*/\r
-\r
-#if( INCLUDE_xTimerPendFunctionCall == 1 )\r
-\r
- BaseType_t xTimerPendFunctionCall( PendedFunction_t xFunctionToPend, void *pvParameter1, uint32_t ulParameter2, TickType_t xTicksToWait )\r
- {\r
- DaemonTaskMessage_t xMessage;\r
- BaseType_t xReturn;\r
-\r
- /* This function can only be called after a timer has been created or\r
- after the scheduler has been started because, until then, the timer\r
- queue does not exist. */\r
- configASSERT( xTimerQueue );\r
-\r
- /* Complete the message with the function parameters and post it to the\r
- daemon task. */\r
- xMessage.xMessageID = tmrCOMMAND_EXECUTE_CALLBACK;\r
- xMessage.u.xCallbackParameters.pxCallbackFunction = xFunctionToPend;\r
- xMessage.u.xCallbackParameters.pvParameter1 = pvParameter1;\r
- xMessage.u.xCallbackParameters.ulParameter2 = ulParameter2;\r
-\r
- xReturn = xQueueSendToBack( xTimerQueue, &xMessage, xTicksToWait );\r
-\r
- tracePEND_FUNC_CALL( xFunctionToPend, pvParameter1, ulParameter2, xReturn );\r
-\r
- return xReturn;\r
- }\r
-\r
-#endif /* INCLUDE_xTimerPendFunctionCall */\r
-/*-----------------------------------------------------------*/\r
-\r
-#if ( configUSE_TRACE_FACILITY == 1 )\r
-\r
- UBaseType_t uxTimerGetTimerNumber( TimerHandle_t xTimer )\r
- {\r
- return ( ( Timer_t * ) xTimer )->uxTimerNumber;\r
- }\r
-\r
-#endif /* configUSE_TRACE_FACILITY */\r
-/*-----------------------------------------------------------*/\r
-\r
-#if ( configUSE_TRACE_FACILITY == 1 )\r
-\r
- void vTimerSetTimerNumber( TimerHandle_t xTimer, UBaseType_t uxTimerNumber )\r
- {\r
- ( ( Timer_t * ) xTimer )->uxTimerNumber = uxTimerNumber;\r
- }\r
-\r
-#endif /* configUSE_TRACE_FACILITY */\r
-/*-----------------------------------------------------------*/\r
-\r
-/* This entire source file will be skipped if the application is not configured\r
-to include software timer functionality. If you want to include software timer\r
-functionality then ensure configUSE_TIMERS is set to 1 in FreeRTOSConfig.h. */\r
-#endif /* configUSE_TIMERS == 1 */\r
-\r
-\r
-\r
+++ /dev/null
-/*
- * ------------------------------------------------------------------------
- * File Name: components/test/main.c
- * Author: Zhao Yanbai
- * 2018-07-07 14:44:34 Saturday CST
- * Description: none
- * ------------------------------------------------------------------------
- */
-#include<stdio.h>
-
-int main(int argc, char *argv[]){
-
- return 0;
-}
\ No newline at end of file
+++ /dev/null
-/*
- * ------------------------------------------------------------------------
- * File Name: test.c
- * Author: Zhao Yanbai
- * 2018-07-07 14:03:04 Saturday CST
- * Description: none
- * ------------------------------------------------------------------------
- */
-
-int test() {
- return 0;
-}
+++ /dev/null
-SET(utils_sources
- debug.c
- debug.S
-)
-ADD_LIBRARY(utils_object OBJECT ${utils_sources})
-ADD_LIBRARY(utils STATIC ${utils_sources})
+++ /dev/null
-.global asm_debug
-asm_debug:
- nop
- nop
- nop
- ret
+++ /dev/null
-/*
- * ------------------------------------------------------------------------
- * File Name: debug.c
- * Author: Zhao Yanbai
- * 2018-07-07 14:02:11 Saturday CST
- * Description: none
- * ------------------------------------------------------------------------
- */
-
-int debug() {
-
- return 0;
-}
+++ /dev/null
-/*
- * ------------------------------------------------------------------------
- * File Name: debug.h
- * Author: Zhao Yanbai
- * 2018-07-26 15:47:46 Thursday CST
- * Description: none
- * ------------------------------------------------------------------------
- */
-
-#pragma once
-
-void debug();
-
-// 在mac系统调用asm_debug会自动调用_asm_debug
-// 在linux系统上会自动调用asm_debug
-// 所以这里强制编译器生成的代码只能调用asm_debug
-void asm_debug() asm("asm_debug");
+++ /dev/null
-/*
- * ------------------------------------------------------------------------
- * File Name: ../components/utils/utils.h
- * Author: Zhao Yanbai
- * 2018-07-27 15:35:19 星期五 CST
- * Description: none
- * ------------------------------------------------------------------------
- */
-
-#pragma once
-
-#include "debug.h"
+++ /dev/null
-.global _start
-
-.extern main
-
-_start:
- call0 main
+++ /dev/null
-ADD_LIBRARY(kernel STATIC
- croutine.c
- event_groups.c
- list.c
- queue.c
- stream_buffer.c
- tasks.c
- timers.c
-)
+++ /dev/null
-/*\r
- * FreeRTOS Kernel V10.0.1\r
- * Copyright (C) 2017 Amazon.com, Inc. or its affiliates. All Rights Reserved.\r
- *\r
- * Permission is hereby granted, free of charge, to any person obtaining a copy of\r
- * this software and associated documentation files (the "Software"), to deal in\r
- * the Software without restriction, including without limitation the rights to\r
- * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of\r
- * the Software, and to permit persons to whom the Software is furnished to do so,\r
- * subject to the following conditions:\r
- *\r
- * The above copyright notice and this permission notice shall be included in all\r
- * copies or substantial portions of the Software.\r
- *\r
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\r
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS\r
- * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR\r
- * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER\r
- * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN\r
- * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\r
- *\r
- * http://www.FreeRTOS.org\r
- * http://aws.amazon.com/freertos\r
- *\r
- * 1 tab == 4 spaces!\r
- */\r
-\r
-#include "FreeRTOS.h"\r
-#include "task.h"\r
-#include "croutine.h"\r
-\r
-/* Remove the whole file is co-routines are not being used. */\r
-#if( configUSE_CO_ROUTINES != 0 )\r
-\r
-/*\r
- * Some kernel aware debuggers require data to be viewed to be global, rather\r
- * than file scope.\r
- */\r
-#ifdef portREMOVE_STATIC_QUALIFIER\r
- #define static\r
-#endif\r
-\r
-\r
-/* Lists for ready and blocked co-routines. --------------------*/\r
-static List_t pxReadyCoRoutineLists[ configMAX_CO_ROUTINE_PRIORITIES ]; /*< Prioritised ready co-routines. */\r
-static List_t xDelayedCoRoutineList1; /*< Delayed co-routines. */\r
-static List_t xDelayedCoRoutineList2; /*< Delayed co-routines (two lists are used - one for delays that have overflowed the current tick count. */\r
-static List_t * pxDelayedCoRoutineList; /*< Points to the delayed co-routine list currently being used. */\r
-static List_t * pxOverflowDelayedCoRoutineList; /*< Points to the delayed co-routine list currently being used to hold co-routines that have overflowed the current tick count. */\r
-static List_t xPendingReadyCoRoutineList; /*< Holds co-routines that have been readied by an external event. They cannot be added directly to the ready lists as the ready lists cannot be accessed by interrupts. */\r
-\r
-/* Other file private variables. --------------------------------*/\r
-CRCB_t * pxCurrentCoRoutine = NULL;\r
-static UBaseType_t uxTopCoRoutineReadyPriority = 0;\r
-static TickType_t xCoRoutineTickCount = 0, xLastTickCount = 0, xPassedTicks = 0;\r
-\r
-/* The initial state of the co-routine when it is created. */\r
-#define corINITIAL_STATE ( 0 )\r
-\r
-/*\r
- * Place the co-routine represented by pxCRCB into the appropriate ready queue\r
- * for the priority. It is inserted at the end of the list.\r
- *\r
- * This macro accesses the co-routine ready lists and therefore must not be\r
- * used from within an ISR.\r
- */\r
-#define prvAddCoRoutineToReadyQueue( pxCRCB ) \\r
-{ \\r
- if( pxCRCB->uxPriority > uxTopCoRoutineReadyPriority ) \\r
- { \\r
- uxTopCoRoutineReadyPriority = pxCRCB->uxPriority; \\r
- } \\r
- vListInsertEnd( ( List_t * ) &( pxReadyCoRoutineLists[ pxCRCB->uxPriority ] ), &( pxCRCB->xGenericListItem ) ); \\r
-}\r
-\r
-/*\r
- * Utility to ready all the lists used by the scheduler. This is called\r
- * automatically upon the creation of the first co-routine.\r
- */\r
-static void prvInitialiseCoRoutineLists( void );\r
-\r
-/*\r
- * Co-routines that are readied by an interrupt cannot be placed directly into\r
- * the ready lists (there is no mutual exclusion). Instead they are placed in\r
- * in the pending ready list in order that they can later be moved to the ready\r
- * list by the co-routine scheduler.\r
- */\r
-static void prvCheckPendingReadyList( void );\r
-\r
-/*\r
- * Macro that looks at the list of co-routines that are currently delayed to\r
- * see if any require waking.\r
- *\r
- * Co-routines are stored in the queue in the order of their wake time -\r
- * meaning once one co-routine has been found whose timer has not expired\r
- * we need not look any further down the list.\r
- */\r
-static void prvCheckDelayedList( void );\r
-\r
-/*-----------------------------------------------------------*/\r
-\r
-BaseType_t xCoRoutineCreate( crCOROUTINE_CODE pxCoRoutineCode, UBaseType_t uxPriority, UBaseType_t uxIndex )\r
-{\r
-BaseType_t xReturn;\r
-CRCB_t *pxCoRoutine;\r
-\r
- /* Allocate the memory that will store the co-routine control block. */\r
- pxCoRoutine = ( CRCB_t * ) pvPortMalloc( sizeof( CRCB_t ) );\r
- if( pxCoRoutine )\r
- {\r
- /* If pxCurrentCoRoutine is NULL then this is the first co-routine to\r
- be created and the co-routine data structures need initialising. */\r
- if( pxCurrentCoRoutine == NULL )\r
- {\r
- pxCurrentCoRoutine = pxCoRoutine;\r
- prvInitialiseCoRoutineLists();\r
- }\r
-\r
- /* Check the priority is within limits. */\r
- if( uxPriority >= configMAX_CO_ROUTINE_PRIORITIES )\r
- {\r
- uxPriority = configMAX_CO_ROUTINE_PRIORITIES - 1;\r
- }\r
-\r
- /* Fill out the co-routine control block from the function parameters. */\r
- pxCoRoutine->uxState = corINITIAL_STATE;\r
- pxCoRoutine->uxPriority = uxPriority;\r
- pxCoRoutine->uxIndex = uxIndex;\r
- pxCoRoutine->pxCoRoutineFunction = pxCoRoutineCode;\r
-\r
- /* Initialise all the other co-routine control block parameters. */\r
- vListInitialiseItem( &( pxCoRoutine->xGenericListItem ) );\r
- vListInitialiseItem( &( pxCoRoutine->xEventListItem ) );\r
-\r
- /* Set the co-routine control block as a link back from the ListItem_t.\r
- This is so we can get back to the containing CRCB from a generic item\r
- in a list. */\r
- listSET_LIST_ITEM_OWNER( &( pxCoRoutine->xGenericListItem ), pxCoRoutine );\r
- listSET_LIST_ITEM_OWNER( &( pxCoRoutine->xEventListItem ), pxCoRoutine );\r
-\r
- /* Event lists are always in priority order. */\r
- listSET_LIST_ITEM_VALUE( &( pxCoRoutine->xEventListItem ), ( ( TickType_t ) configMAX_CO_ROUTINE_PRIORITIES - ( TickType_t ) uxPriority ) );\r
-\r
- /* Now the co-routine has been initialised it can be added to the ready\r
- list at the correct priority. */\r
- prvAddCoRoutineToReadyQueue( pxCoRoutine );\r
-\r
- xReturn = pdPASS;\r
- }\r
- else\r
- {\r
- xReturn = errCOULD_NOT_ALLOCATE_REQUIRED_MEMORY;\r
- }\r
-\r
- return xReturn;\r
-}\r
-/*-----------------------------------------------------------*/\r
-\r
-void vCoRoutineAddToDelayedList( TickType_t xTicksToDelay, List_t *pxEventList )\r
-{\r
-TickType_t xTimeToWake;\r
-\r
- /* Calculate the time to wake - this may overflow but this is\r
- not a problem. */\r
- xTimeToWake = xCoRoutineTickCount + xTicksToDelay;\r
-\r
- /* We must remove ourselves from the ready list before adding\r
- ourselves to the blocked list as the same list item is used for\r
- both lists. */\r
- ( void ) uxListRemove( ( ListItem_t * ) &( pxCurrentCoRoutine->xGenericListItem ) );\r
-\r
- /* The list item will be inserted in wake time order. */\r
- listSET_LIST_ITEM_VALUE( &( pxCurrentCoRoutine->xGenericListItem ), xTimeToWake );\r
-\r
- if( xTimeToWake < xCoRoutineTickCount )\r
- {\r
- /* Wake time has overflowed. Place this item in the\r
- overflow list. */\r
- vListInsert( ( List_t * ) pxOverflowDelayedCoRoutineList, ( ListItem_t * ) &( pxCurrentCoRoutine->xGenericListItem ) );\r
- }\r
- else\r
- {\r
- /* The wake time has not overflowed, so we can use the\r
- current block list. */\r
- vListInsert( ( List_t * ) pxDelayedCoRoutineList, ( ListItem_t * ) &( pxCurrentCoRoutine->xGenericListItem ) );\r
- }\r
-\r
- if( pxEventList )\r
- {\r
- /* Also add the co-routine to an event list. If this is done then the\r
- function must be called with interrupts disabled. */\r
- vListInsert( pxEventList, &( pxCurrentCoRoutine->xEventListItem ) );\r
- }\r
-}\r
-/*-----------------------------------------------------------*/\r
-\r
-static void prvCheckPendingReadyList( void )\r
-{\r
- /* Are there any co-routines waiting to get moved to the ready list? These\r
- are co-routines that have been readied by an ISR. The ISR cannot access\r
- the ready lists itself. */\r
- while( listLIST_IS_EMPTY( &xPendingReadyCoRoutineList ) == pdFALSE )\r
- {\r
- CRCB_t *pxUnblockedCRCB;\r
-\r
- /* The pending ready list can be accessed by an ISR. */\r
- portDISABLE_INTERRUPTS();\r
- {\r
- pxUnblockedCRCB = ( CRCB_t * ) listGET_OWNER_OF_HEAD_ENTRY( (&xPendingReadyCoRoutineList) );\r
- ( void ) uxListRemove( &( pxUnblockedCRCB->xEventListItem ) );\r
- }\r
- portENABLE_INTERRUPTS();\r
-\r
- ( void ) uxListRemove( &( pxUnblockedCRCB->xGenericListItem ) );\r
- prvAddCoRoutineToReadyQueue( pxUnblockedCRCB );\r
- }\r
-}\r
-/*-----------------------------------------------------------*/\r
-\r
-static void prvCheckDelayedList( void )\r
-{\r
-CRCB_t *pxCRCB;\r
-\r
- xPassedTicks = xTaskGetTickCount() - xLastTickCount;\r
- while( xPassedTicks )\r
- {\r
- xCoRoutineTickCount++;\r
- xPassedTicks--;\r
-\r
- /* If the tick count has overflowed we need to swap the ready lists. */\r
- if( xCoRoutineTickCount == 0 )\r
- {\r
- List_t * pxTemp;\r
-\r
- /* Tick count has overflowed so we need to swap the delay lists. If there are\r
- any items in pxDelayedCoRoutineList here then there is an error! */\r
- pxTemp = pxDelayedCoRoutineList;\r
- pxDelayedCoRoutineList = pxOverflowDelayedCoRoutineList;\r
- pxOverflowDelayedCoRoutineList = pxTemp;\r
- }\r
-\r
- /* See if this tick has made a timeout expire. */\r
- while( listLIST_IS_EMPTY( pxDelayedCoRoutineList ) == pdFALSE )\r
- {\r
- pxCRCB = ( CRCB_t * ) listGET_OWNER_OF_HEAD_ENTRY( pxDelayedCoRoutineList );\r
-\r
- if( xCoRoutineTickCount < listGET_LIST_ITEM_VALUE( &( pxCRCB->xGenericListItem ) ) )\r
- {\r
- /* Timeout not yet expired. */\r
- break;\r
- }\r
-\r
- portDISABLE_INTERRUPTS();\r
- {\r
- /* The event could have occurred just before this critical\r
- section. If this is the case then the generic list item will\r
- have been moved to the pending ready list and the following\r
- line is still valid. Also the pvContainer parameter will have\r
- been set to NULL so the following lines are also valid. */\r
- ( void ) uxListRemove( &( pxCRCB->xGenericListItem ) );\r
-\r
- /* Is the co-routine waiting on an event also? */\r
- if( pxCRCB->xEventListItem.pvContainer )\r
- {\r
- ( void ) uxListRemove( &( pxCRCB->xEventListItem ) );\r
- }\r
- }\r
- portENABLE_INTERRUPTS();\r
-\r
- prvAddCoRoutineToReadyQueue( pxCRCB );\r
- }\r
- }\r
-\r
- xLastTickCount = xCoRoutineTickCount;\r
-}\r
-/*-----------------------------------------------------------*/\r
-\r
-void vCoRoutineSchedule( void )\r
-{\r
- /* See if any co-routines readied by events need moving to the ready lists. */\r
- prvCheckPendingReadyList();\r
-\r
- /* See if any delayed co-routines have timed out. */\r
- prvCheckDelayedList();\r
-\r
- /* Find the highest priority queue that contains ready co-routines. */\r
- while( listLIST_IS_EMPTY( &( pxReadyCoRoutineLists[ uxTopCoRoutineReadyPriority ] ) ) )\r
- {\r
- if( uxTopCoRoutineReadyPriority == 0 )\r
- {\r
- /* No more co-routines to check. */\r
- return;\r
- }\r
- --uxTopCoRoutineReadyPriority;\r
- }\r
-\r
- /* listGET_OWNER_OF_NEXT_ENTRY walks through the list, so the co-routines\r
- of the same priority get an equal share of the processor time. */\r
- listGET_OWNER_OF_NEXT_ENTRY( pxCurrentCoRoutine, &( pxReadyCoRoutineLists[ uxTopCoRoutineReadyPriority ] ) );\r
-\r
- /* Call the co-routine. */\r
- ( pxCurrentCoRoutine->pxCoRoutineFunction )( pxCurrentCoRoutine, pxCurrentCoRoutine->uxIndex );\r
-\r
- return;\r
-}\r
-/*-----------------------------------------------------------*/\r
-\r
-static void prvInitialiseCoRoutineLists( void )\r
-{\r
-UBaseType_t uxPriority;\r
-\r
- for( uxPriority = 0; uxPriority < configMAX_CO_ROUTINE_PRIORITIES; uxPriority++ )\r
- {\r
- vListInitialise( ( List_t * ) &( pxReadyCoRoutineLists[ uxPriority ] ) );\r
- }\r
-\r
- vListInitialise( ( List_t * ) &xDelayedCoRoutineList1 );\r
- vListInitialise( ( List_t * ) &xDelayedCoRoutineList2 );\r
- vListInitialise( ( List_t * ) &xPendingReadyCoRoutineList );\r
-\r
- /* Start with pxDelayedCoRoutineList using list1 and the\r
- pxOverflowDelayedCoRoutineList using list2. */\r
- pxDelayedCoRoutineList = &xDelayedCoRoutineList1;\r
- pxOverflowDelayedCoRoutineList = &xDelayedCoRoutineList2;\r
-}\r
-/*-----------------------------------------------------------*/\r
-\r
-BaseType_t xCoRoutineRemoveFromEventList( const List_t *pxEventList )\r
-{\r
-CRCB_t *pxUnblockedCRCB;\r
-BaseType_t xReturn;\r
-\r
- /* This function is called from within an interrupt. It can only access\r
- event lists and the pending ready list. This function assumes that a\r
- check has already been made to ensure pxEventList is not empty. */\r
- pxUnblockedCRCB = ( CRCB_t * ) listGET_OWNER_OF_HEAD_ENTRY( pxEventList );\r
- ( void ) uxListRemove( &( pxUnblockedCRCB->xEventListItem ) );\r
- vListInsertEnd( ( List_t * ) &( xPendingReadyCoRoutineList ), &( pxUnblockedCRCB->xEventListItem ) );\r
-\r
- if( pxUnblockedCRCB->uxPriority >= pxCurrentCoRoutine->uxPriority )\r
- {\r
- xReturn = pdTRUE;\r
- }\r
- else\r
- {\r
- xReturn = pdFALSE;\r
- }\r
-\r
- return xReturn;\r
-}\r
-\r
-#endif /* configUSE_CO_ROUTINES == 0 */\r
-\r
+++ /dev/null
-/*\r
- * FreeRTOS Kernel V10.0.1\r
- * Copyright (C) 2017 Amazon.com, Inc. or its affiliates. All Rights Reserved.\r
- *\r
- * Permission is hereby granted, free of charge, to any person obtaining a copy of\r
- * this software and associated documentation files (the "Software"), to deal in\r
- * the Software without restriction, including without limitation the rights to\r
- * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of\r
- * the Software, and to permit persons to whom the Software is furnished to do so,\r
- * subject to the following conditions:\r
- *\r
- * The above copyright notice and this permission notice shall be included in all\r
- * copies or substantial portions of the Software.\r
- *\r
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\r
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS\r
- * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR\r
- * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER\r
- * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN\r
- * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\r
- *\r
- * http://www.FreeRTOS.org\r
- * http://aws.amazon.com/freertos\r
- *\r
- * 1 tab == 4 spaces!\r
- */\r
-\r
-/* Standard includes. */\r
-#include <stdlib.h>\r
-\r
-/* Defining MPU_WRAPPERS_INCLUDED_FROM_API_FILE prevents task.h from redefining\r
-all the API functions to use the MPU wrappers. That should only be done when\r
-task.h is included from an application file. */\r
-#define MPU_WRAPPERS_INCLUDED_FROM_API_FILE\r
-\r
-/* FreeRTOS includes. */\r
-#include "FreeRTOS.h"\r
-#include "task.h"\r
-#include "timers.h"\r
-#include "event_groups.h"\r
-\r
-/* Lint e961 and e750 are suppressed as a MISRA exception justified because the\r
-MPU ports require MPU_WRAPPERS_INCLUDED_FROM_API_FILE to be defined for the\r
-header files above, but not in this file, in order to generate the correct\r
-privileged Vs unprivileged linkage and placement. */\r
-#undef MPU_WRAPPERS_INCLUDED_FROM_API_FILE /*lint !e961 !e750. */\r
-\r
-/* The following bit fields convey control information in a task's event list\r
-item value. It is important they don't clash with the\r
-taskEVENT_LIST_ITEM_VALUE_IN_USE definition. */\r
-#if configUSE_16_BIT_TICKS == 1\r
- #define eventCLEAR_EVENTS_ON_EXIT_BIT 0x0100U\r
- #define eventUNBLOCKED_DUE_TO_BIT_SET 0x0200U\r
- #define eventWAIT_FOR_ALL_BITS 0x0400U\r
- #define eventEVENT_BITS_CONTROL_BYTES 0xff00U\r
-#else\r
- #define eventCLEAR_EVENTS_ON_EXIT_BIT 0x01000000UL\r
- #define eventUNBLOCKED_DUE_TO_BIT_SET 0x02000000UL\r
- #define eventWAIT_FOR_ALL_BITS 0x04000000UL\r
- #define eventEVENT_BITS_CONTROL_BYTES 0xff000000UL\r
-#endif\r
-\r
-typedef struct xEventGroupDefinition\r
-{\r
- EventBits_t uxEventBits;\r
- List_t xTasksWaitingForBits; /*< List of tasks waiting for a bit to be set. */\r
-\r
- #if( configUSE_TRACE_FACILITY == 1 )\r
- UBaseType_t uxEventGroupNumber;\r
- #endif\r
-\r
- #if( ( configSUPPORT_STATIC_ALLOCATION == 1 ) && ( configSUPPORT_DYNAMIC_ALLOCATION == 1 ) )\r
- uint8_t ucStaticallyAllocated; /*< Set to pdTRUE if the event group is statically allocated to ensure no attempt is made to free the memory. */\r
- #endif\r
-} EventGroup_t;\r
-\r
-/*-----------------------------------------------------------*/\r
-\r
-/*\r
- * Test the bits set in uxCurrentEventBits to see if the wait condition is met.\r
- * The wait condition is defined by xWaitForAllBits. If xWaitForAllBits is\r
- * pdTRUE then the wait condition is met if all the bits set in uxBitsToWaitFor\r
- * are also set in uxCurrentEventBits. If xWaitForAllBits is pdFALSE then the\r
- * wait condition is met if any of the bits set in uxBitsToWait for are also set\r
- * in uxCurrentEventBits.\r
- */\r
-static BaseType_t prvTestWaitCondition( const EventBits_t uxCurrentEventBits, const EventBits_t uxBitsToWaitFor, const BaseType_t xWaitForAllBits ) PRIVILEGED_FUNCTION;\r
-\r
-/*-----------------------------------------------------------*/\r
-\r
-#if( configSUPPORT_STATIC_ALLOCATION == 1 )\r
-\r
- EventGroupHandle_t xEventGroupCreateStatic( StaticEventGroup_t *pxEventGroupBuffer )\r
- {\r
- EventGroup_t *pxEventBits;\r
-\r
- /* A StaticEventGroup_t object must be provided. */\r
- configASSERT( pxEventGroupBuffer );\r
-\r
- #if( configASSERT_DEFINED == 1 )\r
- {\r
- /* Sanity check that the size of the structure used to declare a\r
- variable of type StaticEventGroup_t equals the size of the real\r
- event group structure. */\r
- volatile size_t xSize = sizeof( StaticEventGroup_t );\r
- configASSERT( xSize == sizeof( EventGroup_t ) );\r
- }\r
- #endif /* configASSERT_DEFINED */\r
-\r
- /* The user has provided a statically allocated event group - use it. */\r
- pxEventBits = ( EventGroup_t * ) pxEventGroupBuffer; /*lint !e740 EventGroup_t and StaticEventGroup_t are guaranteed to have the same size and alignment requirement - checked by configASSERT(). */\r
-\r
- if( pxEventBits != NULL )\r
- {\r
- pxEventBits->uxEventBits = 0;\r
- vListInitialise( &( pxEventBits->xTasksWaitingForBits ) );\r
-\r
- #if( configSUPPORT_DYNAMIC_ALLOCATION == 1 )\r
- {\r
- /* Both static and dynamic allocation can be used, so note that\r
- this event group was created statically in case the event group\r
- is later deleted. */\r
- pxEventBits->ucStaticallyAllocated = pdTRUE;\r
- }\r
- #endif /* configSUPPORT_DYNAMIC_ALLOCATION */\r
-\r
- traceEVENT_GROUP_CREATE( pxEventBits );\r
- }\r
- else\r
- {\r
- traceEVENT_GROUP_CREATE_FAILED();\r
- }\r
-\r
- return ( EventGroupHandle_t ) pxEventBits;\r
- }\r
-\r
-#endif /* configSUPPORT_STATIC_ALLOCATION */\r
-/*-----------------------------------------------------------*/\r
-\r
-#if( configSUPPORT_DYNAMIC_ALLOCATION == 1 )\r
-\r
- EventGroupHandle_t xEventGroupCreate( void )\r
- {\r
- EventGroup_t *pxEventBits;\r
-\r
- /* Allocate the event group. */\r
- pxEventBits = ( EventGroup_t * ) pvPortMalloc( sizeof( EventGroup_t ) );\r
-\r
- if( pxEventBits != NULL )\r
- {\r
- pxEventBits->uxEventBits = 0;\r
- vListInitialise( &( pxEventBits->xTasksWaitingForBits ) );\r
-\r
- #if( configSUPPORT_STATIC_ALLOCATION == 1 )\r
- {\r
- /* Both static and dynamic allocation can be used, so note this\r
- event group was allocated statically in case the event group is\r
- later deleted. */\r
- pxEventBits->ucStaticallyAllocated = pdFALSE;\r
- }\r
- #endif /* configSUPPORT_STATIC_ALLOCATION */\r
-\r
- traceEVENT_GROUP_CREATE( pxEventBits );\r
- }\r
- else\r
- {\r
- traceEVENT_GROUP_CREATE_FAILED();\r
- }\r
-\r
- return ( EventGroupHandle_t ) pxEventBits;\r
- }\r
-\r
-#endif /* configSUPPORT_DYNAMIC_ALLOCATION */\r
-/*-----------------------------------------------------------*/\r
-\r
-EventBits_t xEventGroupSync( EventGroupHandle_t xEventGroup, const EventBits_t uxBitsToSet, const EventBits_t uxBitsToWaitFor, TickType_t xTicksToWait )\r
-{\r
-EventBits_t uxOriginalBitValue, uxReturn;\r
-EventGroup_t *pxEventBits = ( EventGroup_t * ) xEventGroup;\r
-BaseType_t xAlreadyYielded;\r
-BaseType_t xTimeoutOccurred = pdFALSE;\r
-\r
- configASSERT( ( uxBitsToWaitFor & eventEVENT_BITS_CONTROL_BYTES ) == 0 );\r
- configASSERT( uxBitsToWaitFor != 0 );\r
- #if ( ( INCLUDE_xTaskGetSchedulerState == 1 ) || ( configUSE_TIMERS == 1 ) )\r
- {\r
- configASSERT( !( ( xTaskGetSchedulerState() == taskSCHEDULER_SUSPENDED ) && ( xTicksToWait != 0 ) ) );\r
- }\r
- #endif\r
-\r
- vTaskSuspendAll();\r
- {\r
- uxOriginalBitValue = pxEventBits->uxEventBits;\r
-\r
- ( void ) xEventGroupSetBits( xEventGroup, uxBitsToSet );\r
-\r
- if( ( ( uxOriginalBitValue | uxBitsToSet ) & uxBitsToWaitFor ) == uxBitsToWaitFor )\r
- {\r
- /* All the rendezvous bits are now set - no need to block. */\r
- uxReturn = ( uxOriginalBitValue | uxBitsToSet );\r
-\r
- /* Rendezvous always clear the bits. They will have been cleared\r
- already unless this is the only task in the rendezvous. */\r
- pxEventBits->uxEventBits &= ~uxBitsToWaitFor;\r
-\r
- xTicksToWait = 0;\r
- }\r
- else\r
- {\r
- if( xTicksToWait != ( TickType_t ) 0 )\r
- {\r
- traceEVENT_GROUP_SYNC_BLOCK( xEventGroup, uxBitsToSet, uxBitsToWaitFor );\r
-\r
- /* Store the bits that the calling task is waiting for in the\r
- task's event list item so the kernel knows when a match is\r
- found. Then enter the blocked state. */\r
- vTaskPlaceOnUnorderedEventList( &( pxEventBits->xTasksWaitingForBits ), ( uxBitsToWaitFor | eventCLEAR_EVENTS_ON_EXIT_BIT | eventWAIT_FOR_ALL_BITS ), xTicksToWait );\r
-\r
- /* This assignment is obsolete as uxReturn will get set after\r
- the task unblocks, but some compilers mistakenly generate a\r
- warning about uxReturn being returned without being set if the\r
- assignment is omitted. */\r
- uxReturn = 0;\r
- }\r
- else\r
- {\r
- /* The rendezvous bits were not set, but no block time was\r
- specified - just return the current event bit value. */\r
- uxReturn = pxEventBits->uxEventBits;\r
- xTimeoutOccurred = pdTRUE;\r
- }\r
- }\r
- }\r
- xAlreadyYielded = xTaskResumeAll();\r
-\r
- if( xTicksToWait != ( TickType_t ) 0 )\r
- {\r
- if( xAlreadyYielded == pdFALSE )\r
- {\r
- portYIELD_WITHIN_API();\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
-\r
- /* The task blocked to wait for its required bits to be set - at this\r
- point either the required bits were set or the block time expired. If\r
- the required bits were set they will have been stored in the task's\r
- event list item, and they should now be retrieved then cleared. */\r
- uxReturn = uxTaskResetEventItemValue();\r
-\r
- if( ( uxReturn & eventUNBLOCKED_DUE_TO_BIT_SET ) == ( EventBits_t ) 0 )\r
- {\r
- /* The task timed out, just return the current event bit value. */\r
- taskENTER_CRITICAL();\r
- {\r
- uxReturn = pxEventBits->uxEventBits;\r
-\r
- /* Although the task got here because it timed out before the\r
- bits it was waiting for were set, it is possible that since it\r
- unblocked another task has set the bits. If this is the case\r
- then it needs to clear the bits before exiting. */\r
- if( ( uxReturn & uxBitsToWaitFor ) == uxBitsToWaitFor )\r
- {\r
- pxEventBits->uxEventBits &= ~uxBitsToWaitFor;\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- taskEXIT_CRITICAL();\r
-\r
- xTimeoutOccurred = pdTRUE;\r
- }\r
- else\r
- {\r
- /* The task unblocked because the bits were set. */\r
- }\r
-\r
- /* Control bits might be set as the task had blocked should not be\r
- returned. */\r
- uxReturn &= ~eventEVENT_BITS_CONTROL_BYTES;\r
- }\r
-\r
- traceEVENT_GROUP_SYNC_END( xEventGroup, uxBitsToSet, uxBitsToWaitFor, xTimeoutOccurred );\r
-\r
- /* Prevent compiler warnings when trace macros are not used. */\r
- ( void ) xTimeoutOccurred;\r
-\r
- return uxReturn;\r
-}\r
-/*-----------------------------------------------------------*/\r
-\r
-EventBits_t xEventGroupWaitBits( EventGroupHandle_t xEventGroup, const EventBits_t uxBitsToWaitFor, const BaseType_t xClearOnExit, const BaseType_t xWaitForAllBits, TickType_t xTicksToWait )\r
-{\r
-EventGroup_t *pxEventBits = ( EventGroup_t * ) xEventGroup;\r
-EventBits_t uxReturn, uxControlBits = 0;\r
-BaseType_t xWaitConditionMet, xAlreadyYielded;\r
-BaseType_t xTimeoutOccurred = pdFALSE;\r
-\r
- /* Check the user is not attempting to wait on the bits used by the kernel\r
- itself, and that at least one bit is being requested. */\r
- configASSERT( xEventGroup );\r
- configASSERT( ( uxBitsToWaitFor & eventEVENT_BITS_CONTROL_BYTES ) == 0 );\r
- configASSERT( uxBitsToWaitFor != 0 );\r
- #if ( ( INCLUDE_xTaskGetSchedulerState == 1 ) || ( configUSE_TIMERS == 1 ) )\r
- {\r
- configASSERT( !( ( xTaskGetSchedulerState() == taskSCHEDULER_SUSPENDED ) && ( xTicksToWait != 0 ) ) );\r
- }\r
- #endif\r
-\r
- vTaskSuspendAll();\r
- {\r
- const EventBits_t uxCurrentEventBits = pxEventBits->uxEventBits;\r
-\r
- /* Check to see if the wait condition is already met or not. */\r
- xWaitConditionMet = prvTestWaitCondition( uxCurrentEventBits, uxBitsToWaitFor, xWaitForAllBits );\r
-\r
- if( xWaitConditionMet != pdFALSE )\r
- {\r
- /* The wait condition has already been met so there is no need to\r
- block. */\r
- uxReturn = uxCurrentEventBits;\r
- xTicksToWait = ( TickType_t ) 0;\r
-\r
- /* Clear the wait bits if requested to do so. */\r
- if( xClearOnExit != pdFALSE )\r
- {\r
- pxEventBits->uxEventBits &= ~uxBitsToWaitFor;\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- else if( xTicksToWait == ( TickType_t ) 0 )\r
- {\r
- /* The wait condition has not been met, but no block time was\r
- specified, so just return the current value. */\r
- uxReturn = uxCurrentEventBits;\r
- xTimeoutOccurred = pdTRUE;\r
- }\r
- else\r
- {\r
- /* The task is going to block to wait for its required bits to be\r
- set. uxControlBits are used to remember the specified behaviour of\r
- this call to xEventGroupWaitBits() - for use when the event bits\r
- unblock the task. */\r
- if( xClearOnExit != pdFALSE )\r
- {\r
- uxControlBits |= eventCLEAR_EVENTS_ON_EXIT_BIT;\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
-\r
- if( xWaitForAllBits != pdFALSE )\r
- {\r
- uxControlBits |= eventWAIT_FOR_ALL_BITS;\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
-\r
- /* Store the bits that the calling task is waiting for in the\r
- task's event list item so the kernel knows when a match is\r
- found. Then enter the blocked state. */\r
- vTaskPlaceOnUnorderedEventList( &( pxEventBits->xTasksWaitingForBits ), ( uxBitsToWaitFor | uxControlBits ), xTicksToWait );\r
-\r
- /* This is obsolete as it will get set after the task unblocks, but\r
- some compilers mistakenly generate a warning about the variable\r
- being returned without being set if it is not done. */\r
- uxReturn = 0;\r
-\r
- traceEVENT_GROUP_WAIT_BITS_BLOCK( xEventGroup, uxBitsToWaitFor );\r
- }\r
- }\r
- xAlreadyYielded = xTaskResumeAll();\r
-\r
- if( xTicksToWait != ( TickType_t ) 0 )\r
- {\r
- if( xAlreadyYielded == pdFALSE )\r
- {\r
- portYIELD_WITHIN_API();\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
-\r
- /* The task blocked to wait for its required bits to be set - at this\r
- point either the required bits were set or the block time expired. If\r
- the required bits were set they will have been stored in the task's\r
- event list item, and they should now be retrieved then cleared. */\r
- uxReturn = uxTaskResetEventItemValue();\r
-\r
- if( ( uxReturn & eventUNBLOCKED_DUE_TO_BIT_SET ) == ( EventBits_t ) 0 )\r
- {\r
- taskENTER_CRITICAL();\r
- {\r
- /* The task timed out, just return the current event bit value. */\r
- uxReturn = pxEventBits->uxEventBits;\r
-\r
- /* It is possible that the event bits were updated between this\r
- task leaving the Blocked state and running again. */\r
- if( prvTestWaitCondition( uxReturn, uxBitsToWaitFor, xWaitForAllBits ) != pdFALSE )\r
- {\r
- if( xClearOnExit != pdFALSE )\r
- {\r
- pxEventBits->uxEventBits &= ~uxBitsToWaitFor;\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- xTimeoutOccurred = pdTRUE;\r
- }\r
- taskEXIT_CRITICAL();\r
- }\r
- else\r
- {\r
- /* The task unblocked because the bits were set. */\r
- }\r
-\r
- /* The task blocked so control bits may have been set. */\r
- uxReturn &= ~eventEVENT_BITS_CONTROL_BYTES;\r
- }\r
- traceEVENT_GROUP_WAIT_BITS_END( xEventGroup, uxBitsToWaitFor, xTimeoutOccurred );\r
-\r
- /* Prevent compiler warnings when trace macros are not used. */\r
- ( void ) xTimeoutOccurred;\r
-\r
- return uxReturn;\r
-}\r
-/*-----------------------------------------------------------*/\r
-\r
-EventBits_t xEventGroupClearBits( EventGroupHandle_t xEventGroup, const EventBits_t uxBitsToClear )\r
-{\r
-EventGroup_t *pxEventBits = ( EventGroup_t * ) xEventGroup;\r
-EventBits_t uxReturn;\r
-\r
- /* Check the user is not attempting to clear the bits used by the kernel\r
- itself. */\r
- configASSERT( xEventGroup );\r
- configASSERT( ( uxBitsToClear & eventEVENT_BITS_CONTROL_BYTES ) == 0 );\r
-\r
- taskENTER_CRITICAL();\r
- {\r
- traceEVENT_GROUP_CLEAR_BITS( xEventGroup, uxBitsToClear );\r
-\r
- /* The value returned is the event group value prior to the bits being\r
- cleared. */\r
- uxReturn = pxEventBits->uxEventBits;\r
-\r
- /* Clear the bits. */\r
- pxEventBits->uxEventBits &= ~uxBitsToClear;\r
- }\r
- taskEXIT_CRITICAL();\r
-\r
- return uxReturn;\r
-}\r
-/*-----------------------------------------------------------*/\r
-\r
-#if ( ( configUSE_TRACE_FACILITY == 1 ) && ( INCLUDE_xTimerPendFunctionCall == 1 ) && ( configUSE_TIMERS == 1 ) )\r
-\r
- BaseType_t xEventGroupClearBitsFromISR( EventGroupHandle_t xEventGroup, const EventBits_t uxBitsToClear )\r
- {\r
- BaseType_t xReturn;\r
-\r
- traceEVENT_GROUP_CLEAR_BITS_FROM_ISR( xEventGroup, uxBitsToClear );\r
- xReturn = xTimerPendFunctionCallFromISR( vEventGroupClearBitsCallback, ( void * ) xEventGroup, ( uint32_t ) uxBitsToClear, NULL );\r
-\r
- return xReturn;\r
- }\r
-\r
-#endif\r
-/*-----------------------------------------------------------*/\r
-\r
-EventBits_t xEventGroupGetBitsFromISR( EventGroupHandle_t xEventGroup )\r
-{\r
-UBaseType_t uxSavedInterruptStatus;\r
-EventGroup_t *pxEventBits = ( EventGroup_t * ) xEventGroup;\r
-EventBits_t uxReturn;\r
-\r
- uxSavedInterruptStatus = portSET_INTERRUPT_MASK_FROM_ISR();\r
- {\r
- uxReturn = pxEventBits->uxEventBits;\r
- }\r
- portCLEAR_INTERRUPT_MASK_FROM_ISR( uxSavedInterruptStatus );\r
-\r
- return uxReturn;\r
-}\r
-/*-----------------------------------------------------------*/\r
-\r
-EventBits_t xEventGroupSetBits( EventGroupHandle_t xEventGroup, const EventBits_t uxBitsToSet )\r
-{\r
-ListItem_t *pxListItem, *pxNext;\r
-ListItem_t const *pxListEnd;\r
-List_t *pxList;\r
-EventBits_t uxBitsToClear = 0, uxBitsWaitedFor, uxControlBits;\r
-EventGroup_t *pxEventBits = ( EventGroup_t * ) xEventGroup;\r
-BaseType_t xMatchFound = pdFALSE;\r
-\r
- /* Check the user is not attempting to set the bits used by the kernel\r
- itself. */\r
- configASSERT( xEventGroup );\r
- configASSERT( ( uxBitsToSet & eventEVENT_BITS_CONTROL_BYTES ) == 0 );\r
-\r
- pxList = &( pxEventBits->xTasksWaitingForBits );\r
- pxListEnd = listGET_END_MARKER( pxList ); /*lint !e826 !e740 The mini list structure is used as the list end to save RAM. This is checked and valid. */\r
- vTaskSuspendAll();\r
- {\r
- traceEVENT_GROUP_SET_BITS( xEventGroup, uxBitsToSet );\r
-\r
- pxListItem = listGET_HEAD_ENTRY( pxList );\r
-\r
- /* Set the bits. */\r
- pxEventBits->uxEventBits |= uxBitsToSet;\r
-\r
- /* See if the new bit value should unblock any tasks. */\r
- while( pxListItem != pxListEnd )\r
- {\r
- pxNext = listGET_NEXT( pxListItem );\r
- uxBitsWaitedFor = listGET_LIST_ITEM_VALUE( pxListItem );\r
- xMatchFound = pdFALSE;\r
-\r
- /* Split the bits waited for from the control bits. */\r
- uxControlBits = uxBitsWaitedFor & eventEVENT_BITS_CONTROL_BYTES;\r
- uxBitsWaitedFor &= ~eventEVENT_BITS_CONTROL_BYTES;\r
-\r
- if( ( uxControlBits & eventWAIT_FOR_ALL_BITS ) == ( EventBits_t ) 0 )\r
- {\r
- /* Just looking for single bit being set. */\r
- if( ( uxBitsWaitedFor & pxEventBits->uxEventBits ) != ( EventBits_t ) 0 )\r
- {\r
- xMatchFound = pdTRUE;\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- else if( ( uxBitsWaitedFor & pxEventBits->uxEventBits ) == uxBitsWaitedFor )\r
- {\r
- /* All bits are set. */\r
- xMatchFound = pdTRUE;\r
- }\r
- else\r
- {\r
- /* Need all bits to be set, but not all the bits were set. */\r
- }\r
-\r
- if( xMatchFound != pdFALSE )\r
- {\r
- /* The bits match. Should the bits be cleared on exit? */\r
- if( ( uxControlBits & eventCLEAR_EVENTS_ON_EXIT_BIT ) != ( EventBits_t ) 0 )\r
- {\r
- uxBitsToClear |= uxBitsWaitedFor;\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
-\r
- /* Store the actual event flag value in the task's event list\r
- item before removing the task from the event list. The\r
- eventUNBLOCKED_DUE_TO_BIT_SET bit is set so the task knows\r
- that is was unblocked due to its required bits matching, rather\r
- than because it timed out. */\r
- vTaskRemoveFromUnorderedEventList( pxListItem, pxEventBits->uxEventBits | eventUNBLOCKED_DUE_TO_BIT_SET );\r
- }\r
-\r
- /* Move onto the next list item. Note pxListItem->pxNext is not\r
- used here as the list item may have been removed from the event list\r
- and inserted into the ready/pending reading list. */\r
- pxListItem = pxNext;\r
- }\r
-\r
- /* Clear any bits that matched when the eventCLEAR_EVENTS_ON_EXIT_BIT\r
- bit was set in the control word. */\r
- pxEventBits->uxEventBits &= ~uxBitsToClear;\r
- }\r
- ( void ) xTaskResumeAll();\r
-\r
- return pxEventBits->uxEventBits;\r
-}\r
-/*-----------------------------------------------------------*/\r
-\r
-void vEventGroupDelete( EventGroupHandle_t xEventGroup )\r
-{\r
-EventGroup_t *pxEventBits = ( EventGroup_t * ) xEventGroup;\r
-const List_t *pxTasksWaitingForBits = &( pxEventBits->xTasksWaitingForBits );\r
-\r
- vTaskSuspendAll();\r
- {\r
- traceEVENT_GROUP_DELETE( xEventGroup );\r
-\r
- while( listCURRENT_LIST_LENGTH( pxTasksWaitingForBits ) > ( UBaseType_t ) 0 )\r
- {\r
- /* Unblock the task, returning 0 as the event list is being deleted\r
- and cannot therefore have any bits set. */\r
- configASSERT( pxTasksWaitingForBits->xListEnd.pxNext != ( const ListItem_t * ) &( pxTasksWaitingForBits->xListEnd ) );\r
- vTaskRemoveFromUnorderedEventList( pxTasksWaitingForBits->xListEnd.pxNext, eventUNBLOCKED_DUE_TO_BIT_SET );\r
- }\r
-\r
- #if( ( configSUPPORT_DYNAMIC_ALLOCATION == 1 ) && ( configSUPPORT_STATIC_ALLOCATION == 0 ) )\r
- {\r
- /* The event group can only have been allocated dynamically - free\r
- it again. */\r
- vPortFree( pxEventBits );\r
- }\r
- #elif( ( configSUPPORT_DYNAMIC_ALLOCATION == 1 ) && ( configSUPPORT_STATIC_ALLOCATION == 1 ) )\r
- {\r
- /* The event group could have been allocated statically or\r
- dynamically, so check before attempting to free the memory. */\r
- if( pxEventBits->ucStaticallyAllocated == ( uint8_t ) pdFALSE )\r
- {\r
- vPortFree( pxEventBits );\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- #endif /* configSUPPORT_DYNAMIC_ALLOCATION */\r
- }\r
- ( void ) xTaskResumeAll();\r
-}\r
-/*-----------------------------------------------------------*/\r
-\r
-/* For internal use only - execute a 'set bits' command that was pended from\r
-an interrupt. */\r
-void vEventGroupSetBitsCallback( void *pvEventGroup, const uint32_t ulBitsToSet )\r
-{\r
- ( void ) xEventGroupSetBits( pvEventGroup, ( EventBits_t ) ulBitsToSet );\r
-}\r
-/*-----------------------------------------------------------*/\r
-\r
-/* For internal use only - execute a 'clear bits' command that was pended from\r
-an interrupt. */\r
-void vEventGroupClearBitsCallback( void *pvEventGroup, const uint32_t ulBitsToClear )\r
-{\r
- ( void ) xEventGroupClearBits( pvEventGroup, ( EventBits_t ) ulBitsToClear );\r
-}\r
-/*-----------------------------------------------------------*/\r
-\r
-static BaseType_t prvTestWaitCondition( const EventBits_t uxCurrentEventBits, const EventBits_t uxBitsToWaitFor, const BaseType_t xWaitForAllBits )\r
-{\r
-BaseType_t xWaitConditionMet = pdFALSE;\r
-\r
- if( xWaitForAllBits == pdFALSE )\r
- {\r
- /* Task only has to wait for one bit within uxBitsToWaitFor to be\r
- set. Is one already set? */\r
- if( ( uxCurrentEventBits & uxBitsToWaitFor ) != ( EventBits_t ) 0 )\r
- {\r
- xWaitConditionMet = pdTRUE;\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- else\r
- {\r
- /* Task has to wait for all the bits in uxBitsToWaitFor to be set.\r
- Are they set already? */\r
- if( ( uxCurrentEventBits & uxBitsToWaitFor ) == uxBitsToWaitFor )\r
- {\r
- xWaitConditionMet = pdTRUE;\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
-\r
- return xWaitConditionMet;\r
-}\r
-/*-----------------------------------------------------------*/\r
-\r
-#if ( ( configUSE_TRACE_FACILITY == 1 ) && ( INCLUDE_xTimerPendFunctionCall == 1 ) && ( configUSE_TIMERS == 1 ) )\r
-\r
- BaseType_t xEventGroupSetBitsFromISR( EventGroupHandle_t xEventGroup, const EventBits_t uxBitsToSet, BaseType_t *pxHigherPriorityTaskWoken )\r
- {\r
- BaseType_t xReturn;\r
-\r
- traceEVENT_GROUP_SET_BITS_FROM_ISR( xEventGroup, uxBitsToSet );\r
- xReturn = xTimerPendFunctionCallFromISR( vEventGroupSetBitsCallback, ( void * ) xEventGroup, ( uint32_t ) uxBitsToSet, pxHigherPriorityTaskWoken );\r
-\r
- return xReturn;\r
- }\r
-\r
-#endif\r
-/*-----------------------------------------------------------*/\r
-\r
-#if (configUSE_TRACE_FACILITY == 1)\r
-\r
- UBaseType_t uxEventGroupGetNumber( void* xEventGroup )\r
- {\r
- UBaseType_t xReturn;\r
- EventGroup_t *pxEventBits = ( EventGroup_t * ) xEventGroup;\r
-\r
- if( xEventGroup == NULL )\r
- {\r
- xReturn = 0;\r
- }\r
- else\r
- {\r
- xReturn = pxEventBits->uxEventGroupNumber;\r
- }\r
-\r
- return xReturn;\r
- }\r
-\r
-#endif /* configUSE_TRACE_FACILITY */\r
-/*-----------------------------------------------------------*/\r
-\r
-#if ( configUSE_TRACE_FACILITY == 1 )\r
-\r
- void vEventGroupSetNumber( void * xEventGroup, UBaseType_t uxEventGroupNumber )\r
- {\r
- ( ( EventGroup_t * ) xEventGroup )->uxEventGroupNumber = uxEventGroupNumber;\r
- }\r
-\r
-#endif /* configUSE_TRACE_FACILITY */\r
-/*-----------------------------------------------------------*/\r
-\r
-\r
+++ /dev/null
-/*\r
- * FreeRTOS Kernel V10.0.1\r
- * Copyright (C) 2017 Amazon.com, Inc. or its affiliates. All Rights Reserved.\r
- *\r
- * Permission is hereby granted, free of charge, to any person obtaining a copy of\r
- * this software and associated documentation files (the "Software"), to deal in\r
- * the Software without restriction, including without limitation the rights to\r
- * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of\r
- * the Software, and to permit persons to whom the Software is furnished to do so,\r
- * subject to the following conditions:\r
- *\r
- * The above copyright notice and this permission notice shall be included in all\r
- * copies or substantial portions of the Software.\r
- *\r
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\r
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS\r
- * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR\r
- * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER\r
- * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN\r
- * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\r
- *\r
- * http://www.FreeRTOS.org\r
- * http://aws.amazon.com/freertos\r
- *\r
- * 1 tab == 4 spaces!\r
- */\r
-\r
-#ifndef INC_FREERTOS_H\r
-#define INC_FREERTOS_H\r
-\r
-/*\r
- * Include the generic headers required for the FreeRTOS port being used.\r
- */\r
-#include <stddef.h>\r
-\r
-/*\r
- * If stdint.h cannot be located then:\r
- * + If using GCC ensure the -nostdint options is *not* being used.\r
- * + Ensure the project's include path includes the directory in which your\r
- * compiler stores stdint.h.\r
- * + Set any compiler options necessary for it to support C99, as technically\r
- * stdint.h is only mandatory with C99 (FreeRTOS does not require C99 in any\r
- * other way).\r
- * + The FreeRTOS download includes a simple stdint.h definition that can be\r
- * used in cases where none is provided by the compiler. The files only\r
- * contains the typedefs required to build FreeRTOS. Read the instructions\r
- * in FreeRTOS/source/stdint.readme for more information.\r
- */\r
-#include <stdint.h> /* READ COMMENT ABOVE. */\r
-\r
-#ifdef __cplusplus\r
-extern "C" {\r
-#endif\r
-\r
-/* Application specific configuration options. */\r
-#include "FreeRTOSConfig.h"\r
-\r
-/* Basic FreeRTOS definitions. */\r
-#include "projdefs.h"\r
-\r
-/* Definitions specific to the port being used. */\r
-#include "portable.h"\r
-\r
-/* Must be defaulted before configUSE_NEWLIB_REENTRANT is used below. */\r
-#ifndef configUSE_NEWLIB_REENTRANT\r
- #define configUSE_NEWLIB_REENTRANT 0\r
-#endif\r
-\r
-/* Required if struct _reent is used. */\r
-#if ( configUSE_NEWLIB_REENTRANT == 1 )\r
- #include <reent.h>\r
-#endif\r
-/*\r
- * Check all the required application specific macros have been defined.\r
- * These macros are application specific and (as downloaded) are defined\r
- * within FreeRTOSConfig.h.\r
- */\r
-\r
-#ifndef configMINIMAL_STACK_SIZE\r
- #error Missing definition: configMINIMAL_STACK_SIZE must be defined in FreeRTOSConfig.h. configMINIMAL_STACK_SIZE defines the size (in words) of the stack allocated to the idle task. Refer to the demo project provided for your port for a suitable value.\r
-#endif\r
-\r
-#ifndef configMAX_PRIORITIES\r
- #error Missing definition: configMAX_PRIORITIES must be defined in FreeRTOSConfig.h. See the Configuration section of the FreeRTOS API documentation for details.\r
-#endif\r
-\r
-#if configMAX_PRIORITIES < 1\r
- #error configMAX_PRIORITIES must be defined to be greater than or equal to 1.\r
-#endif\r
-\r
-#ifndef configUSE_PREEMPTION\r
- #error Missing definition: configUSE_PREEMPTION must be defined in FreeRTOSConfig.h as either 1 or 0. See the Configuration section of the FreeRTOS API documentation for details.\r
-#endif\r
-\r
-#ifndef configUSE_IDLE_HOOK\r
- #error Missing definition: configUSE_IDLE_HOOK must be defined in FreeRTOSConfig.h as either 1 or 0. See the Configuration section of the FreeRTOS API documentation for details.\r
-#endif\r
-\r
-#ifndef configUSE_TICK_HOOK\r
- #error Missing definition: configUSE_TICK_HOOK must be defined in FreeRTOSConfig.h as either 1 or 0. See the Configuration section of the FreeRTOS API documentation for details.\r
-#endif\r
-\r
-#ifndef configUSE_16_BIT_TICKS\r
- #error Missing definition: configUSE_16_BIT_TICKS must be defined in FreeRTOSConfig.h as either 1 or 0. See the Configuration section of the FreeRTOS API documentation for details.\r
-#endif\r
-\r
-#ifndef configUSE_CO_ROUTINES\r
- #define configUSE_CO_ROUTINES 0\r
-#endif\r
-\r
-#ifndef INCLUDE_vTaskPrioritySet\r
- #define INCLUDE_vTaskPrioritySet 0\r
-#endif\r
-\r
-#ifndef INCLUDE_uxTaskPriorityGet\r
- #define INCLUDE_uxTaskPriorityGet 0\r
-#endif\r
-\r
-#ifndef INCLUDE_vTaskDelete\r
- #define INCLUDE_vTaskDelete 0\r
-#endif\r
-\r
-#ifndef INCLUDE_vTaskSuspend\r
- #define INCLUDE_vTaskSuspend 0\r
-#endif\r
-\r
-#ifndef INCLUDE_vTaskDelayUntil\r
- #define INCLUDE_vTaskDelayUntil 0\r
-#endif\r
-\r
-#ifndef INCLUDE_vTaskDelay\r
- #define INCLUDE_vTaskDelay 0\r
-#endif\r
-\r
-#ifndef INCLUDE_xTaskGetIdleTaskHandle\r
- #define INCLUDE_xTaskGetIdleTaskHandle 0\r
-#endif\r
-\r
-#ifndef INCLUDE_xTaskAbortDelay\r
- #define INCLUDE_xTaskAbortDelay 0\r
-#endif\r
-\r
-#ifndef INCLUDE_xQueueGetMutexHolder\r
- #define INCLUDE_xQueueGetMutexHolder 0\r
-#endif\r
-\r
-#ifndef INCLUDE_xSemaphoreGetMutexHolder\r
- #define INCLUDE_xSemaphoreGetMutexHolder INCLUDE_xQueueGetMutexHolder\r
-#endif\r
-\r
-#ifndef INCLUDE_xTaskGetHandle\r
- #define INCLUDE_xTaskGetHandle 0\r
-#endif\r
-\r
-#ifndef INCLUDE_uxTaskGetStackHighWaterMark\r
- #define INCLUDE_uxTaskGetStackHighWaterMark 0\r
-#endif\r
-\r
-#ifndef INCLUDE_eTaskGetState\r
- #define INCLUDE_eTaskGetState 0\r
-#endif\r
-\r
-#ifndef INCLUDE_xTaskResumeFromISR\r
- #define INCLUDE_xTaskResumeFromISR 1\r
-#endif\r
-\r
-#ifndef INCLUDE_xTimerPendFunctionCall\r
- #define INCLUDE_xTimerPendFunctionCall 0\r
-#endif\r
-\r
-#ifndef INCLUDE_xTaskGetSchedulerState\r
- #define INCLUDE_xTaskGetSchedulerState 0\r
-#endif\r
-\r
-#ifndef INCLUDE_xTaskGetCurrentTaskHandle\r
- #define INCLUDE_xTaskGetCurrentTaskHandle 0\r
-#endif\r
-\r
-#if configUSE_CO_ROUTINES != 0\r
- #ifndef configMAX_CO_ROUTINE_PRIORITIES\r
- #error configMAX_CO_ROUTINE_PRIORITIES must be greater than or equal to 1.\r
- #endif\r
-#endif\r
-\r
-#ifndef configUSE_DAEMON_TASK_STARTUP_HOOK\r
- #define configUSE_DAEMON_TASK_STARTUP_HOOK 0\r
-#endif\r
-\r
-#ifndef configUSE_APPLICATION_TASK_TAG\r
- #define configUSE_APPLICATION_TASK_TAG 0\r
-#endif\r
-\r
-#ifndef configNUM_THREAD_LOCAL_STORAGE_POINTERS\r
- #define configNUM_THREAD_LOCAL_STORAGE_POINTERS 0\r
-#endif\r
-\r
-#ifndef configUSE_RECURSIVE_MUTEXES\r
- #define configUSE_RECURSIVE_MUTEXES 0\r
-#endif\r
-\r
-#ifndef configUSE_MUTEXES\r
- #define configUSE_MUTEXES 0\r
-#endif\r
-\r
-#ifndef configUSE_TIMERS\r
- #define configUSE_TIMERS 0\r
-#endif\r
-\r
-#ifndef configUSE_COUNTING_SEMAPHORES\r
- #define configUSE_COUNTING_SEMAPHORES 0\r
-#endif\r
-\r
-#ifndef configUSE_ALTERNATIVE_API\r
- #define configUSE_ALTERNATIVE_API 0\r
-#endif\r
-\r
-#ifndef portCRITICAL_NESTING_IN_TCB\r
- #define portCRITICAL_NESTING_IN_TCB 0\r
-#endif\r
-\r
-#ifndef configMAX_TASK_NAME_LEN\r
- #define configMAX_TASK_NAME_LEN 16\r
-#endif\r
-\r
-#ifndef configIDLE_SHOULD_YIELD\r
- #define configIDLE_SHOULD_YIELD 1\r
-#endif\r
-\r
-#if configMAX_TASK_NAME_LEN < 1\r
- #error configMAX_TASK_NAME_LEN must be set to a minimum of 1 in FreeRTOSConfig.h\r
-#endif\r
-\r
-#ifndef configASSERT\r
- #define configASSERT( x )\r
- #define configASSERT_DEFINED 0\r
-#else\r
- #define configASSERT_DEFINED 1\r
-#endif\r
-\r
-/* The timers module relies on xTaskGetSchedulerState(). */\r
-#if configUSE_TIMERS == 1\r
-\r
- #ifndef configTIMER_TASK_PRIORITY\r
- #error If configUSE_TIMERS is set to 1 then configTIMER_TASK_PRIORITY must also be defined.\r
- #endif /* configTIMER_TASK_PRIORITY */\r
-\r
- #ifndef configTIMER_QUEUE_LENGTH\r
- #error If configUSE_TIMERS is set to 1 then configTIMER_QUEUE_LENGTH must also be defined.\r
- #endif /* configTIMER_QUEUE_LENGTH */\r
-\r
- #ifndef configTIMER_TASK_STACK_DEPTH\r
- #error If configUSE_TIMERS is set to 1 then configTIMER_TASK_STACK_DEPTH must also be defined.\r
- #endif /* configTIMER_TASK_STACK_DEPTH */\r
-\r
-#endif /* configUSE_TIMERS */\r
-\r
-#ifndef portSET_INTERRUPT_MASK_FROM_ISR\r
- #define portSET_INTERRUPT_MASK_FROM_ISR() 0\r
-#endif\r
-\r
-#ifndef portCLEAR_INTERRUPT_MASK_FROM_ISR\r
- #define portCLEAR_INTERRUPT_MASK_FROM_ISR( uxSavedStatusValue ) ( void ) uxSavedStatusValue\r
-#endif\r
-\r
-#ifndef portCLEAN_UP_TCB\r
- #define portCLEAN_UP_TCB( pxTCB ) ( void ) pxTCB\r
-#endif\r
-\r
-#ifndef portPRE_TASK_DELETE_HOOK\r
- #define portPRE_TASK_DELETE_HOOK( pvTaskToDelete, pxYieldPending )\r
-#endif\r
-\r
-#ifndef portSETUP_TCB\r
- #define portSETUP_TCB( pxTCB ) ( void ) pxTCB\r
-#endif\r
-\r
-#ifndef configQUEUE_REGISTRY_SIZE\r
- #define configQUEUE_REGISTRY_SIZE 0U\r
-#endif\r
-\r
-#if ( configQUEUE_REGISTRY_SIZE < 1 )\r
- #define vQueueAddToRegistry( xQueue, pcName )\r
- #define vQueueUnregisterQueue( xQueue )\r
- #define pcQueueGetName( xQueue )\r
-#endif\r
-\r
-#ifndef portPOINTER_SIZE_TYPE\r
- #define portPOINTER_SIZE_TYPE uint32_t\r
-#endif\r
-\r
-/* Remove any unused trace macros. */\r
-#ifndef traceSTART\r
- /* Used to perform any necessary initialisation - for example, open a file\r
- into which trace is to be written. */\r
- #define traceSTART()\r
-#endif\r
-\r
-#ifndef traceEND\r
- /* Use to close a trace, for example close a file into which trace has been\r
- written. */\r
- #define traceEND()\r
-#endif\r
-\r
-#ifndef traceTASK_SWITCHED_IN\r
- /* Called after a task has been selected to run. pxCurrentTCB holds a pointer\r
- to the task control block of the selected task. */\r
- #define traceTASK_SWITCHED_IN()\r
-#endif\r
-\r
-#ifndef traceINCREASE_TICK_COUNT\r
- /* Called before stepping the tick count after waking from tickless idle\r
- sleep. */\r
- #define traceINCREASE_TICK_COUNT( x )\r
-#endif\r
-\r
-#ifndef traceLOW_POWER_IDLE_BEGIN\r
- /* Called immediately before entering tickless idle. */\r
- #define traceLOW_POWER_IDLE_BEGIN()\r
-#endif\r
-\r
-#ifndef traceLOW_POWER_IDLE_END\r
- /* Called when returning to the Idle task after a tickless idle. */\r
- #define traceLOW_POWER_IDLE_END()\r
-#endif\r
-\r
-#ifndef traceTASK_SWITCHED_OUT\r
- /* Called before a task has been selected to run. pxCurrentTCB holds a pointer\r
- to the task control block of the task being switched out. */\r
- #define traceTASK_SWITCHED_OUT()\r
-#endif\r
-\r
-#ifndef traceTASK_PRIORITY_INHERIT\r
- /* Called when a task attempts to take a mutex that is already held by a\r
- lower priority task. pxTCBOfMutexHolder is a pointer to the TCB of the task\r
- that holds the mutex. uxInheritedPriority is the priority the mutex holder\r
- will inherit (the priority of the task that is attempting to obtain the\r
- muted. */\r
- #define traceTASK_PRIORITY_INHERIT( pxTCBOfMutexHolder, uxInheritedPriority )\r
-#endif\r
-\r
-#ifndef traceTASK_PRIORITY_DISINHERIT\r
- /* Called when a task releases a mutex, the holding of which had resulted in\r
- the task inheriting the priority of a higher priority task.\r
- pxTCBOfMutexHolder is a pointer to the TCB of the task that is releasing the\r
- mutex. uxOriginalPriority is the task's configured (base) priority. */\r
- #define traceTASK_PRIORITY_DISINHERIT( pxTCBOfMutexHolder, uxOriginalPriority )\r
-#endif\r
-\r
-#ifndef traceBLOCKING_ON_QUEUE_RECEIVE\r
- /* Task is about to block because it cannot read from a\r
- queue/mutex/semaphore. pxQueue is a pointer to the queue/mutex/semaphore\r
- upon which the read was attempted. pxCurrentTCB points to the TCB of the\r
- task that attempted the read. */\r
- #define traceBLOCKING_ON_QUEUE_RECEIVE( pxQueue )\r
-#endif\r
-\r
-#ifndef traceBLOCKING_ON_QUEUE_PEEK\r
- /* Task is about to block because it cannot read from a\r
- queue/mutex/semaphore. pxQueue is a pointer to the queue/mutex/semaphore\r
- upon which the read was attempted. pxCurrentTCB points to the TCB of the\r
- task that attempted the read. */\r
- #define traceBLOCKING_ON_QUEUE_PEEK( pxQueue )\r
-#endif\r
-\r
-#ifndef traceBLOCKING_ON_QUEUE_SEND\r
- /* Task is about to block because it cannot write to a\r
- queue/mutex/semaphore. pxQueue is a pointer to the queue/mutex/semaphore\r
- upon which the write was attempted. pxCurrentTCB points to the TCB of the\r
- task that attempted the write. */\r
- #define traceBLOCKING_ON_QUEUE_SEND( pxQueue )\r
-#endif\r
-\r
-#ifndef configCHECK_FOR_STACK_OVERFLOW\r
- #define configCHECK_FOR_STACK_OVERFLOW 0\r
-#endif\r
-\r
-#ifndef configRECORD_STACK_HIGH_ADDRESS\r
- #define configRECORD_STACK_HIGH_ADDRESS 0\r
-#endif\r
-\r
-#ifndef configINCLUDE_FREERTOS_TASK_C_ADDITIONS_H\r
- #define configINCLUDE_FREERTOS_TASK_C_ADDITIONS_H 0\r
-#endif\r
-\r
-/* The following event macros are embedded in the kernel API calls. */\r
-\r
-#ifndef traceMOVED_TASK_TO_READY_STATE\r
- #define traceMOVED_TASK_TO_READY_STATE( pxTCB )\r
-#endif\r
-\r
-#ifndef tracePOST_MOVED_TASK_TO_READY_STATE\r
- #define tracePOST_MOVED_TASK_TO_READY_STATE( pxTCB )\r
-#endif\r
-\r
-#ifndef traceQUEUE_CREATE\r
- #define traceQUEUE_CREATE( pxNewQueue )\r
-#endif\r
-\r
-#ifndef traceQUEUE_CREATE_FAILED\r
- #define traceQUEUE_CREATE_FAILED( ucQueueType )\r
-#endif\r
-\r
-#ifndef traceCREATE_MUTEX\r
- #define traceCREATE_MUTEX( pxNewQueue )\r
-#endif\r
-\r
-#ifndef traceCREATE_MUTEX_FAILED\r
- #define traceCREATE_MUTEX_FAILED()\r
-#endif\r
-\r
-#ifndef traceGIVE_MUTEX_RECURSIVE\r
- #define traceGIVE_MUTEX_RECURSIVE( pxMutex )\r
-#endif\r
-\r
-#ifndef traceGIVE_MUTEX_RECURSIVE_FAILED\r
- #define traceGIVE_MUTEX_RECURSIVE_FAILED( pxMutex )\r
-#endif\r
-\r
-#ifndef traceTAKE_MUTEX_RECURSIVE\r
- #define traceTAKE_MUTEX_RECURSIVE( pxMutex )\r
-#endif\r
-\r
-#ifndef traceTAKE_MUTEX_RECURSIVE_FAILED\r
- #define traceTAKE_MUTEX_RECURSIVE_FAILED( pxMutex )\r
-#endif\r
-\r
-#ifndef traceCREATE_COUNTING_SEMAPHORE\r
- #define traceCREATE_COUNTING_SEMAPHORE()\r
-#endif\r
-\r
-#ifndef traceCREATE_COUNTING_SEMAPHORE_FAILED\r
- #define traceCREATE_COUNTING_SEMAPHORE_FAILED()\r
-#endif\r
-\r
-#ifndef traceQUEUE_SEND\r
- #define traceQUEUE_SEND( pxQueue )\r
-#endif\r
-\r
-#ifndef traceQUEUE_SEND_FAILED\r
- #define traceQUEUE_SEND_FAILED( pxQueue )\r
-#endif\r
-\r
-#ifndef traceQUEUE_RECEIVE\r
- #define traceQUEUE_RECEIVE( pxQueue )\r
-#endif\r
-\r
-#ifndef traceQUEUE_PEEK\r
- #define traceQUEUE_PEEK( pxQueue )\r
-#endif\r
-\r
-#ifndef traceQUEUE_PEEK_FAILED\r
- #define traceQUEUE_PEEK_FAILED( pxQueue )\r
-#endif\r
-\r
-#ifndef traceQUEUE_PEEK_FROM_ISR\r
- #define traceQUEUE_PEEK_FROM_ISR( pxQueue )\r
-#endif\r
-\r
-#ifndef traceQUEUE_RECEIVE_FAILED\r
- #define traceQUEUE_RECEIVE_FAILED( pxQueue )\r
-#endif\r
-\r
-#ifndef traceQUEUE_SEND_FROM_ISR\r
- #define traceQUEUE_SEND_FROM_ISR( pxQueue )\r
-#endif\r
-\r
-#ifndef traceQUEUE_SEND_FROM_ISR_FAILED\r
- #define traceQUEUE_SEND_FROM_ISR_FAILED( pxQueue )\r
-#endif\r
-\r
-#ifndef traceQUEUE_RECEIVE_FROM_ISR\r
- #define traceQUEUE_RECEIVE_FROM_ISR( pxQueue )\r
-#endif\r
-\r
-#ifndef traceQUEUE_RECEIVE_FROM_ISR_FAILED\r
- #define traceQUEUE_RECEIVE_FROM_ISR_FAILED( pxQueue )\r
-#endif\r
-\r
-#ifndef traceQUEUE_PEEK_FROM_ISR_FAILED\r
- #define traceQUEUE_PEEK_FROM_ISR_FAILED( pxQueue )\r
-#endif\r
-\r
-#ifndef traceQUEUE_DELETE\r
- #define traceQUEUE_DELETE( pxQueue )\r
-#endif\r
-\r
-#ifndef traceTASK_CREATE\r
- #define traceTASK_CREATE( pxNewTCB )\r
-#endif\r
-\r
-#ifndef traceTASK_CREATE_FAILED\r
- #define traceTASK_CREATE_FAILED()\r
-#endif\r
-\r
-#ifndef traceTASK_DELETE\r
- #define traceTASK_DELETE( pxTaskToDelete )\r
-#endif\r
-\r
-#ifndef traceTASK_DELAY_UNTIL\r
- #define traceTASK_DELAY_UNTIL( x )\r
-#endif\r
-\r
-#ifndef traceTASK_DELAY\r
- #define traceTASK_DELAY()\r
-#endif\r
-\r
-#ifndef traceTASK_PRIORITY_SET\r
- #define traceTASK_PRIORITY_SET( pxTask, uxNewPriority )\r
-#endif\r
-\r
-#ifndef traceTASK_SUSPEND\r
- #define traceTASK_SUSPEND( pxTaskToSuspend )\r
-#endif\r
-\r
-#ifndef traceTASK_RESUME\r
- #define traceTASK_RESUME( pxTaskToResume )\r
-#endif\r
-\r
-#ifndef traceTASK_RESUME_FROM_ISR\r
- #define traceTASK_RESUME_FROM_ISR( pxTaskToResume )\r
-#endif\r
-\r
-#ifndef traceTASK_INCREMENT_TICK\r
- #define traceTASK_INCREMENT_TICK( xTickCount )\r
-#endif\r
-\r
-#ifndef traceTIMER_CREATE\r
- #define traceTIMER_CREATE( pxNewTimer )\r
-#endif\r
-\r
-#ifndef traceTIMER_CREATE_FAILED\r
- #define traceTIMER_CREATE_FAILED()\r
-#endif\r
-\r
-#ifndef traceTIMER_COMMAND_SEND\r
- #define traceTIMER_COMMAND_SEND( xTimer, xMessageID, xMessageValueValue, xReturn )\r
-#endif\r
-\r
-#ifndef traceTIMER_EXPIRED\r
- #define traceTIMER_EXPIRED( pxTimer )\r
-#endif\r
-\r
-#ifndef traceTIMER_COMMAND_RECEIVED\r
- #define traceTIMER_COMMAND_RECEIVED( pxTimer, xMessageID, xMessageValue )\r
-#endif\r
-\r
-#ifndef traceMALLOC\r
- #define traceMALLOC( pvAddress, uiSize )\r
-#endif\r
-\r
-#ifndef traceFREE\r
- #define traceFREE( pvAddress, uiSize )\r
-#endif\r
-\r
-#ifndef traceEVENT_GROUP_CREATE\r
- #define traceEVENT_GROUP_CREATE( xEventGroup )\r
-#endif\r
-\r
-#ifndef traceEVENT_GROUP_CREATE_FAILED\r
- #define traceEVENT_GROUP_CREATE_FAILED()\r
-#endif\r
-\r
-#ifndef traceEVENT_GROUP_SYNC_BLOCK\r
- #define traceEVENT_GROUP_SYNC_BLOCK( xEventGroup, uxBitsToSet, uxBitsToWaitFor )\r
-#endif\r
-\r
-#ifndef traceEVENT_GROUP_SYNC_END\r
- #define traceEVENT_GROUP_SYNC_END( xEventGroup, uxBitsToSet, uxBitsToWaitFor, xTimeoutOccurred ) ( void ) xTimeoutOccurred\r
-#endif\r
-\r
-#ifndef traceEVENT_GROUP_WAIT_BITS_BLOCK\r
- #define traceEVENT_GROUP_WAIT_BITS_BLOCK( xEventGroup, uxBitsToWaitFor )\r
-#endif\r
-\r
-#ifndef traceEVENT_GROUP_WAIT_BITS_END\r
- #define traceEVENT_GROUP_WAIT_BITS_END( xEventGroup, uxBitsToWaitFor, xTimeoutOccurred ) ( void ) xTimeoutOccurred\r
-#endif\r
-\r
-#ifndef traceEVENT_GROUP_CLEAR_BITS\r
- #define traceEVENT_GROUP_CLEAR_BITS( xEventGroup, uxBitsToClear )\r
-#endif\r
-\r
-#ifndef traceEVENT_GROUP_CLEAR_BITS_FROM_ISR\r
- #define traceEVENT_GROUP_CLEAR_BITS_FROM_ISR( xEventGroup, uxBitsToClear )\r
-#endif\r
-\r
-#ifndef traceEVENT_GROUP_SET_BITS\r
- #define traceEVENT_GROUP_SET_BITS( xEventGroup, uxBitsToSet )\r
-#endif\r
-\r
-#ifndef traceEVENT_GROUP_SET_BITS_FROM_ISR\r
- #define traceEVENT_GROUP_SET_BITS_FROM_ISR( xEventGroup, uxBitsToSet )\r
-#endif\r
-\r
-#ifndef traceEVENT_GROUP_DELETE\r
- #define traceEVENT_GROUP_DELETE( xEventGroup )\r
-#endif\r
-\r
-#ifndef tracePEND_FUNC_CALL\r
- #define tracePEND_FUNC_CALL(xFunctionToPend, pvParameter1, ulParameter2, ret)\r
-#endif\r
-\r
-#ifndef tracePEND_FUNC_CALL_FROM_ISR\r
- #define tracePEND_FUNC_CALL_FROM_ISR(xFunctionToPend, pvParameter1, ulParameter2, ret)\r
-#endif\r
-\r
-#ifndef traceQUEUE_REGISTRY_ADD\r
- #define traceQUEUE_REGISTRY_ADD(xQueue, pcQueueName)\r
-#endif\r
-\r
-#ifndef traceTASK_NOTIFY_TAKE_BLOCK\r
- #define traceTASK_NOTIFY_TAKE_BLOCK()\r
-#endif\r
-\r
-#ifndef traceTASK_NOTIFY_TAKE\r
- #define traceTASK_NOTIFY_TAKE()\r
-#endif\r
-\r
-#ifndef traceTASK_NOTIFY_WAIT_BLOCK\r
- #define traceTASK_NOTIFY_WAIT_BLOCK()\r
-#endif\r
-\r
-#ifndef traceTASK_NOTIFY_WAIT\r
- #define traceTASK_NOTIFY_WAIT()\r
-#endif\r
-\r
-#ifndef traceTASK_NOTIFY\r
- #define traceTASK_NOTIFY()\r
-#endif\r
-\r
-#ifndef traceTASK_NOTIFY_FROM_ISR\r
- #define traceTASK_NOTIFY_FROM_ISR()\r
-#endif\r
-\r
-#ifndef traceTASK_NOTIFY_GIVE_FROM_ISR\r
- #define traceTASK_NOTIFY_GIVE_FROM_ISR()\r
-#endif\r
-\r
-#ifndef traceSTREAM_BUFFER_CREATE_FAILED\r
- #define traceSTREAM_BUFFER_CREATE_FAILED( xIsMessageBuffer )\r
-#endif\r
-\r
-#ifndef traceSTREAM_BUFFER_CREATE_STATIC_FAILED\r
- #define traceSTREAM_BUFFER_CREATE_STATIC_FAILED( xReturn, xIsMessageBuffer )\r
-#endif\r
-\r
-#ifndef traceSTREAM_BUFFER_CREATE\r
- #define traceSTREAM_BUFFER_CREATE( pxStreamBuffer, xIsMessageBuffer )\r
-#endif\r
-\r
-#ifndef traceSTREAM_BUFFER_DELETE\r
- #define traceSTREAM_BUFFER_DELETE( xStreamBuffer )\r
-#endif\r
-\r
-#ifndef traceSTREAM_BUFFER_RESET\r
- #define traceSTREAM_BUFFER_RESET( xStreamBuffer )\r
-#endif\r
-\r
-#ifndef traceBLOCKING_ON_STREAM_BUFFER_SEND\r
- #define traceBLOCKING_ON_STREAM_BUFFER_SEND( xStreamBuffer )\r
-#endif\r
-\r
-#ifndef traceSTREAM_BUFFER_SEND\r
- #define traceSTREAM_BUFFER_SEND( xStreamBuffer, xBytesSent )\r
-#endif\r
-\r
-#ifndef traceSTREAM_BUFFER_SEND_FAILED\r
- #define traceSTREAM_BUFFER_SEND_FAILED( xStreamBuffer )\r
-#endif\r
-\r
-#ifndef traceSTREAM_BUFFER_SEND_FROM_ISR\r
- #define traceSTREAM_BUFFER_SEND_FROM_ISR( xStreamBuffer, xBytesSent )\r
-#endif\r
-\r
-#ifndef traceBLOCKING_ON_STREAM_BUFFER_RECEIVE\r
- #define traceBLOCKING_ON_STREAM_BUFFER_RECEIVE( xStreamBuffer )\r
-#endif\r
-\r
-#ifndef traceSTREAM_BUFFER_RECEIVE\r
- #define traceSTREAM_BUFFER_RECEIVE( xStreamBuffer, xReceivedLength )\r
-#endif\r
-\r
-#ifndef traceSTREAM_BUFFER_RECEIVE_FAILED\r
- #define traceSTREAM_BUFFER_RECEIVE_FAILED( xStreamBuffer )\r
-#endif\r
-\r
-#ifndef traceSTREAM_BUFFER_RECEIVE_FROM_ISR\r
- #define traceSTREAM_BUFFER_RECEIVE_FROM_ISR( xStreamBuffer, xReceivedLength )\r
-#endif\r
-\r
-#ifndef configGENERATE_RUN_TIME_STATS\r
- #define configGENERATE_RUN_TIME_STATS 0\r
-#endif\r
-\r
-#if ( configGENERATE_RUN_TIME_STATS == 1 )\r
-\r
- #ifndef portCONFIGURE_TIMER_FOR_RUN_TIME_STATS\r
- #error If configGENERATE_RUN_TIME_STATS is defined then portCONFIGURE_TIMER_FOR_RUN_TIME_STATS must also be defined. portCONFIGURE_TIMER_FOR_RUN_TIME_STATS should call a port layer function to setup a peripheral timer/counter that can then be used as the run time counter time base.\r
- #endif /* portCONFIGURE_TIMER_FOR_RUN_TIME_STATS */\r
-\r
- #ifndef portGET_RUN_TIME_COUNTER_VALUE\r
- #ifndef portALT_GET_RUN_TIME_COUNTER_VALUE\r
- #error If configGENERATE_RUN_TIME_STATS is defined then either portGET_RUN_TIME_COUNTER_VALUE or portALT_GET_RUN_TIME_COUNTER_VALUE must also be defined. See the examples provided and the FreeRTOS web site for more information.\r
- #endif /* portALT_GET_RUN_TIME_COUNTER_VALUE */\r
- #endif /* portGET_RUN_TIME_COUNTER_VALUE */\r
-\r
-#endif /* configGENERATE_RUN_TIME_STATS */\r
-\r
-#ifndef portCONFIGURE_TIMER_FOR_RUN_TIME_STATS\r
- #define portCONFIGURE_TIMER_FOR_RUN_TIME_STATS()\r
-#endif\r
-\r
-#ifndef configUSE_MALLOC_FAILED_HOOK\r
- #define configUSE_MALLOC_FAILED_HOOK 0\r
-#endif\r
-\r
-#ifndef portPRIVILEGE_BIT\r
- #define portPRIVILEGE_BIT ( ( UBaseType_t ) 0x00 )\r
-#endif\r
-\r
-#ifndef portYIELD_WITHIN_API\r
- #define portYIELD_WITHIN_API portYIELD\r
-#endif\r
-\r
-#ifndef portSUPPRESS_TICKS_AND_SLEEP\r
- #define portSUPPRESS_TICKS_AND_SLEEP( xExpectedIdleTime )\r
-#endif\r
-\r
-#ifndef configEXPECTED_IDLE_TIME_BEFORE_SLEEP\r
- #define configEXPECTED_IDLE_TIME_BEFORE_SLEEP 2\r
-#endif\r
-\r
-#if configEXPECTED_IDLE_TIME_BEFORE_SLEEP < 2\r
- #error configEXPECTED_IDLE_TIME_BEFORE_SLEEP must not be less than 2\r
-#endif\r
-\r
-#ifndef configUSE_TICKLESS_IDLE\r
- #define configUSE_TICKLESS_IDLE 0\r
-#endif\r
-\r
-#ifndef configPRE_SUPPRESS_TICKS_AND_SLEEP_PROCESSING\r
- #define configPRE_SUPPRESS_TICKS_AND_SLEEP_PROCESSING( x )\r
-#endif\r
-\r
-#ifndef configPRE_SLEEP_PROCESSING\r
- #define configPRE_SLEEP_PROCESSING( x )\r
-#endif\r
-\r
-#ifndef configPOST_SLEEP_PROCESSING\r
- #define configPOST_SLEEP_PROCESSING( x )\r
-#endif\r
-\r
-#ifndef configUSE_QUEUE_SETS\r
- #define configUSE_QUEUE_SETS 0\r
-#endif\r
-\r
-#ifndef portTASK_USES_FLOATING_POINT\r
- #define portTASK_USES_FLOATING_POINT()\r
-#endif\r
-\r
-#ifndef portTASK_CALLS_SECURE_FUNCTIONS\r
- #define portTASK_CALLS_SECURE_FUNCTIONS()\r
-#endif\r
-\r
-#ifndef configUSE_TIME_SLICING\r
- #define configUSE_TIME_SLICING 1\r
-#endif\r
-\r
-#ifndef configINCLUDE_APPLICATION_DEFINED_PRIVILEGED_FUNCTIONS\r
- #define configINCLUDE_APPLICATION_DEFINED_PRIVILEGED_FUNCTIONS 0\r
-#endif\r
-\r
-#ifndef configUSE_STATS_FORMATTING_FUNCTIONS\r
- #define configUSE_STATS_FORMATTING_FUNCTIONS 0\r
-#endif\r
-\r
-#ifndef portASSERT_IF_INTERRUPT_PRIORITY_INVALID\r
- #define portASSERT_IF_INTERRUPT_PRIORITY_INVALID()\r
-#endif\r
-\r
-#ifndef configUSE_TRACE_FACILITY\r
- #define configUSE_TRACE_FACILITY 0\r
-#endif\r
-\r
-#ifndef mtCOVERAGE_TEST_MARKER\r
- #define mtCOVERAGE_TEST_MARKER()\r
-#endif\r
-\r
-#ifndef mtCOVERAGE_TEST_DELAY\r
- #define mtCOVERAGE_TEST_DELAY()\r
-#endif\r
-\r
-#ifndef portASSERT_IF_IN_ISR\r
- #define portASSERT_IF_IN_ISR()\r
-#endif\r
-\r
-#ifndef configUSE_PORT_OPTIMISED_TASK_SELECTION\r
- #define configUSE_PORT_OPTIMISED_TASK_SELECTION 0\r
-#endif\r
-\r
-#ifndef configAPPLICATION_ALLOCATED_HEAP\r
- #define configAPPLICATION_ALLOCATED_HEAP 0\r
-#endif\r
-\r
-#ifndef configUSE_TASK_NOTIFICATIONS\r
- #define configUSE_TASK_NOTIFICATIONS 1\r
-#endif\r
-\r
-#ifndef portTICK_TYPE_IS_ATOMIC\r
- #define portTICK_TYPE_IS_ATOMIC 0\r
-#endif\r
-\r
-#ifndef configSUPPORT_STATIC_ALLOCATION\r
- /* Defaults to 0 for backward compatibility. */\r
- #define configSUPPORT_STATIC_ALLOCATION 0\r
-#endif\r
-\r
-#ifndef configSUPPORT_DYNAMIC_ALLOCATION\r
- /* Defaults to 1 for backward compatibility. */\r
- #define configSUPPORT_DYNAMIC_ALLOCATION 1\r
-#endif\r
-\r
-#ifndef configSTACK_DEPTH_TYPE\r
- /* Defaults to uint16_t for backward compatibility, but can be overridden\r
- in FreeRTOSConfig.h if uint16_t is too restrictive. */\r
- #define configSTACK_DEPTH_TYPE uint16_t\r
-#endif\r
-\r
-/* Sanity check the configuration. */\r
-#if( configUSE_TICKLESS_IDLE != 0 )\r
- #if( INCLUDE_vTaskSuspend != 1 )\r
- #error INCLUDE_vTaskSuspend must be set to 1 if configUSE_TICKLESS_IDLE is not set to 0\r
- #endif /* INCLUDE_vTaskSuspend */\r
-#endif /* configUSE_TICKLESS_IDLE */\r
-\r
-#if( ( configSUPPORT_STATIC_ALLOCATION == 0 ) && ( configSUPPORT_DYNAMIC_ALLOCATION == 0 ) )\r
- #error configSUPPORT_STATIC_ALLOCATION and configSUPPORT_DYNAMIC_ALLOCATION cannot both be 0, but can both be 1.\r
-#endif\r
-\r
-#if( ( configUSE_RECURSIVE_MUTEXES == 1 ) && ( configUSE_MUTEXES != 1 ) )\r
- #error configUSE_MUTEXES must be set to 1 to use recursive mutexes\r
-#endif\r
-\r
-#ifndef configINITIAL_TICK_COUNT\r
- #define configINITIAL_TICK_COUNT 0\r
-#endif\r
-\r
-#if( portTICK_TYPE_IS_ATOMIC == 0 )\r
- /* Either variables of tick type cannot be read atomically, or\r
- portTICK_TYPE_IS_ATOMIC was not set - map the critical sections used when\r
- the tick count is returned to the standard critical section macros. */\r
- #define portTICK_TYPE_ENTER_CRITICAL() portENTER_CRITICAL()\r
- #define portTICK_TYPE_EXIT_CRITICAL() portEXIT_CRITICAL()\r
- #define portTICK_TYPE_SET_INTERRUPT_MASK_FROM_ISR() portSET_INTERRUPT_MASK_FROM_ISR()\r
- #define portTICK_TYPE_CLEAR_INTERRUPT_MASK_FROM_ISR( x ) portCLEAR_INTERRUPT_MASK_FROM_ISR( ( x ) )\r
-#else\r
- /* The tick type can be read atomically, so critical sections used when the\r
- tick count is returned can be defined away. */\r
- #define portTICK_TYPE_ENTER_CRITICAL()\r
- #define portTICK_TYPE_EXIT_CRITICAL()\r
- #define portTICK_TYPE_SET_INTERRUPT_MASK_FROM_ISR() 0\r
- #define portTICK_TYPE_CLEAR_INTERRUPT_MASK_FROM_ISR( x ) ( void ) x\r
-#endif\r
-\r
-/* Definitions to allow backward compatibility with FreeRTOS versions prior to\r
-V8 if desired. */\r
-#ifndef configENABLE_BACKWARD_COMPATIBILITY\r
- #define configENABLE_BACKWARD_COMPATIBILITY 1\r
-#endif\r
-\r
-#ifndef configPRINTF\r
- /* configPRINTF() was not defined, so define it away to nothing. To use\r
- configPRINTF() then define it as follows (where MyPrintFunction() is\r
- provided by the application writer):\r
-\r
- void MyPrintFunction(const char *pcFormat, ... );\r
- #define configPRINTF( X ) MyPrintFunction X\r
-\r
- Then call like a standard printf() function, but placing brackets around\r
- all parameters so they are passed as a single parameter. For example:\r
- configPRINTF( ("Value = %d", MyVariable) ); */\r
- #define configPRINTF( X )\r
-#endif\r
-\r
-#ifndef configMAX\r
- /* The application writer has not provided their own MAX macro, so define\r
- the following generic implementation. */\r
- #define configMAX( a, b ) ( ( ( a ) > ( b ) ) ? ( a ) : ( b ) )\r
-#endif\r
-\r
-#ifndef configMIN\r
- /* The application writer has not provided their own MAX macro, so define\r
- the following generic implementation. */\r
- #define configMIN( a, b ) ( ( ( a ) < ( b ) ) ? ( a ) : ( b ) )\r
-#endif\r
-\r
-#if configENABLE_BACKWARD_COMPATIBILITY == 1\r
- #define eTaskStateGet eTaskGetState\r
- #define portTickType TickType_t\r
- #define xTaskHandle TaskHandle_t\r
- #define xQueueHandle QueueHandle_t\r
- #define xSemaphoreHandle SemaphoreHandle_t\r
- #define xQueueSetHandle QueueSetHandle_t\r
- #define xQueueSetMemberHandle QueueSetMemberHandle_t\r
- #define xTimeOutType TimeOut_t\r
- #define xMemoryRegion MemoryRegion_t\r
- #define xTaskParameters TaskParameters_t\r
- #define xTaskStatusType TaskStatus_t\r
- #define xTimerHandle TimerHandle_t\r
- #define xCoRoutineHandle CoRoutineHandle_t\r
- #define pdTASK_HOOK_CODE TaskHookFunction_t\r
- #define portTICK_RATE_MS portTICK_PERIOD_MS\r
- #define pcTaskGetTaskName pcTaskGetName\r
- #define pcTimerGetTimerName pcTimerGetName\r
- #define pcQueueGetQueueName pcQueueGetName\r
- #define vTaskGetTaskInfo vTaskGetInfo\r
-\r
- /* Backward compatibility within the scheduler code only - these definitions\r
- are not really required but are included for completeness. */\r
- #define tmrTIMER_CALLBACK TimerCallbackFunction_t\r
- #define pdTASK_CODE TaskFunction_t\r
- #define xListItem ListItem_t\r
- #define xList List_t\r
-#endif /* configENABLE_BACKWARD_COMPATIBILITY */\r
-\r
-#if( configUSE_ALTERNATIVE_API != 0 )\r
- #error The alternative API was deprecated some time ago, and was removed in FreeRTOS V9.0 0\r
-#endif\r
-\r
-/* Set configUSE_TASK_FPU_SUPPORT to 0 to omit floating point support even\r
-if floating point hardware is otherwise supported by the FreeRTOS port in use.\r
-This constant is not supported by all FreeRTOS ports that include floating\r
-point support. */\r
-#ifndef configUSE_TASK_FPU_SUPPORT\r
- #define configUSE_TASK_FPU_SUPPORT 1\r
-#endif\r
-\r
-/*\r
- * In line with software engineering best practice, FreeRTOS implements a strict\r
- * data hiding policy, so the real structures used by FreeRTOS to maintain the\r
- * state of tasks, queues, semaphores, etc. are not accessible to the application\r
- * code. However, if the application writer wants to statically allocate such\r
- * an object then the size of the object needs to be know. Dummy structures\r
- * that are guaranteed to have the same size and alignment requirements of the\r
- * real objects are used for this purpose. The dummy list and list item\r
- * structures below are used for inclusion in such a dummy structure.\r
- */\r
-struct xSTATIC_LIST_ITEM\r
-{\r
- TickType_t xDummy1;\r
- void *pvDummy2[ 4 ];\r
-};\r
-typedef struct xSTATIC_LIST_ITEM StaticListItem_t;\r
-\r
-/* See the comments above the struct xSTATIC_LIST_ITEM definition. */\r
-struct xSTATIC_MINI_LIST_ITEM\r
-{\r
- TickType_t xDummy1;\r
- void *pvDummy2[ 2 ];\r
-};\r
-typedef struct xSTATIC_MINI_LIST_ITEM StaticMiniListItem_t;\r
-\r
-/* See the comments above the struct xSTATIC_LIST_ITEM definition. */\r
-typedef struct xSTATIC_LIST\r
-{\r
- UBaseType_t uxDummy1;\r
- void *pvDummy2;\r
- StaticMiniListItem_t xDummy3;\r
-} StaticList_t;\r
-\r
-/*\r
- * In line with software engineering best practice, especially when supplying a\r
- * library that is likely to change in future versions, FreeRTOS implements a\r
- * strict data hiding policy. This means the Task structure used internally by\r
- * FreeRTOS is not accessible to application code. However, if the application\r
- * writer wants to statically allocate the memory required to create a task then\r
- * the size of the task object needs to be know. The StaticTask_t structure\r
- * below is provided for this purpose. Its sizes and alignment requirements are\r
- * guaranteed to match those of the genuine structure, no matter which\r
- * architecture is being used, and no matter how the values in FreeRTOSConfig.h\r
- * are set. Its contents are somewhat obfuscated in the hope users will\r
- * recognise that it would be unwise to make direct use of the structure members.\r
- */\r
-typedef struct xSTATIC_TCB\r
-{\r
- void *pxDummy1;\r
- #if ( portUSING_MPU_WRAPPERS == 1 )\r
- xMPU_SETTINGS xDummy2;\r
- #endif\r
- StaticListItem_t xDummy3[ 2 ];\r
- UBaseType_t uxDummy5;\r
- void *pxDummy6;\r
- uint8_t ucDummy7[ configMAX_TASK_NAME_LEN ];\r
- #if ( ( portSTACK_GROWTH > 0 ) || ( configRECORD_STACK_HIGH_ADDRESS == 1 ) )\r
- void *pxDummy8;\r
- #endif\r
- #if ( portCRITICAL_NESTING_IN_TCB == 1 )\r
- UBaseType_t uxDummy9;\r
- #endif\r
- #if ( configUSE_TRACE_FACILITY == 1 )\r
- UBaseType_t uxDummy10[ 2 ];\r
- #endif\r
- #if ( configUSE_MUTEXES == 1 )\r
- UBaseType_t uxDummy12[ 2 ];\r
- #endif\r
- #if ( configUSE_APPLICATION_TASK_TAG == 1 )\r
- void *pxDummy14;\r
- #endif\r
- #if( configNUM_THREAD_LOCAL_STORAGE_POINTERS > 0 )\r
- void *pvDummy15[ configNUM_THREAD_LOCAL_STORAGE_POINTERS ];\r
- #endif\r
- #if ( configGENERATE_RUN_TIME_STATS == 1 )\r
- uint32_t ulDummy16;\r
- #endif\r
- #if ( configUSE_NEWLIB_REENTRANT == 1 )\r
- struct _reent xDummy17;\r
- #endif\r
- #if ( configUSE_TASK_NOTIFICATIONS == 1 )\r
- uint32_t ulDummy18;\r
- uint8_t ucDummy19;\r
- #endif\r
- #if( ( ( configSUPPORT_STATIC_ALLOCATION == 1 ) && ( configSUPPORT_DYNAMIC_ALLOCATION == 1 ) ) || ( portUSING_MPU_WRAPPERS == 1 ) )\r
- uint8_t uxDummy20;\r
- #endif\r
-\r
- #if( INCLUDE_xTaskAbortDelay == 1 )\r
- uint8_t ucDummy21;\r
- #endif\r
-\r
-} StaticTask_t;\r
-\r
-/*\r
- * In line with software engineering best practice, especially when supplying a\r
- * library that is likely to change in future versions, FreeRTOS implements a\r
- * strict data hiding policy. This means the Queue structure used internally by\r
- * FreeRTOS is not accessible to application code. However, if the application\r
- * writer wants to statically allocate the memory required to create a queue\r
- * then the size of the queue object needs to be know. The StaticQueue_t\r
- * structure below is provided for this purpose. Its sizes and alignment\r
- * requirements are guaranteed to match those of the genuine structure, no\r
- * matter which architecture is being used, and no matter how the values in\r
- * FreeRTOSConfig.h are set. Its contents are somewhat obfuscated in the hope\r
- * users will recognise that it would be unwise to make direct use of the\r
- * structure members.\r
- */\r
-typedef struct xSTATIC_QUEUE\r
-{\r
- void *pvDummy1[ 3 ];\r
-\r
- union\r
- {\r
- void *pvDummy2;\r
- UBaseType_t uxDummy2;\r
- } u;\r
-\r
- StaticList_t xDummy3[ 2 ];\r
- UBaseType_t uxDummy4[ 3 ];\r
- uint8_t ucDummy5[ 2 ];\r
-\r
- #if( ( configSUPPORT_STATIC_ALLOCATION == 1 ) && ( configSUPPORT_DYNAMIC_ALLOCATION == 1 ) )\r
- uint8_t ucDummy6;\r
- #endif\r
-\r
- #if ( configUSE_QUEUE_SETS == 1 )\r
- void *pvDummy7;\r
- #endif\r
-\r
- #if ( configUSE_TRACE_FACILITY == 1 )\r
- UBaseType_t uxDummy8;\r
- uint8_t ucDummy9;\r
- #endif\r
-\r
-} StaticQueue_t;\r
-typedef StaticQueue_t StaticSemaphore_t;\r
-\r
-/*\r
- * In line with software engineering best practice, especially when supplying a\r
- * library that is likely to change in future versions, FreeRTOS implements a\r
- * strict data hiding policy. This means the event group structure used\r
- * internally by FreeRTOS is not accessible to application code. However, if\r
- * the application writer wants to statically allocate the memory required to\r
- * create an event group then the size of the event group object needs to be\r
- * know. The StaticEventGroup_t structure below is provided for this purpose.\r
- * Its sizes and alignment requirements are guaranteed to match those of the\r
- * genuine structure, no matter which architecture is being used, and no matter\r
- * how the values in FreeRTOSConfig.h are set. Its contents are somewhat\r
- * obfuscated in the hope users will recognise that it would be unwise to make\r
- * direct use of the structure members.\r
- */\r
-typedef struct xSTATIC_EVENT_GROUP\r
-{\r
- TickType_t xDummy1;\r
- StaticList_t xDummy2;\r
-\r
- #if( configUSE_TRACE_FACILITY == 1 )\r
- UBaseType_t uxDummy3;\r
- #endif\r
-\r
- #if( ( configSUPPORT_STATIC_ALLOCATION == 1 ) && ( configSUPPORT_DYNAMIC_ALLOCATION == 1 ) )\r
- uint8_t ucDummy4;\r
- #endif\r
-\r
-} StaticEventGroup_t;\r
-\r
-/*\r
- * In line with software engineering best practice, especially when supplying a\r
- * library that is likely to change in future versions, FreeRTOS implements a\r
- * strict data hiding policy. This means the software timer structure used\r
- * internally by FreeRTOS is not accessible to application code. However, if\r
- * the application writer wants to statically allocate the memory required to\r
- * create a software timer then the size of the queue object needs to be know.\r
- * The StaticTimer_t structure below is provided for this purpose. Its sizes\r
- * and alignment requirements are guaranteed to match those of the genuine\r
- * structure, no matter which architecture is being used, and no matter how the\r
- * values in FreeRTOSConfig.h are set. Its contents are somewhat obfuscated in\r
- * the hope users will recognise that it would be unwise to make direct use of\r
- * the structure members.\r
- */\r
-typedef struct xSTATIC_TIMER\r
-{\r
- void *pvDummy1;\r
- StaticListItem_t xDummy2;\r
- TickType_t xDummy3;\r
- UBaseType_t uxDummy4;\r
- void *pvDummy5[ 2 ];\r
- #if( configUSE_TRACE_FACILITY == 1 )\r
- UBaseType_t uxDummy6;\r
- #endif\r
-\r
- #if( ( configSUPPORT_STATIC_ALLOCATION == 1 ) && ( configSUPPORT_DYNAMIC_ALLOCATION == 1 ) )\r
- uint8_t ucDummy7;\r
- #endif\r
-\r
-} StaticTimer_t;\r
-\r
-/*\r
-* In line with software engineering best practice, especially when supplying a\r
-* library that is likely to change in future versions, FreeRTOS implements a\r
-* strict data hiding policy. This means the stream buffer structure used\r
-* internally by FreeRTOS is not accessible to application code. However, if\r
-* the application writer wants to statically allocate the memory required to\r
-* create a stream buffer then the size of the stream buffer object needs to be\r
-* know. The StaticStreamBuffer_t structure below is provided for this purpose.\r
-* Its size and alignment requirements are guaranteed to match those of the\r
-* genuine structure, no matter which architecture is being used, and no matter\r
-* how the values in FreeRTOSConfig.h are set. Its contents are somewhat\r
-* obfuscated in the hope users will recognise that it would be unwise to make\r
-* direct use of the structure members.\r
-*/\r
-typedef struct xSTATIC_STREAM_BUFFER\r
-{\r
- size_t uxDummy1[ 4 ];\r
- void * pvDummy2[ 3 ];\r
- uint8_t ucDummy3;\r
- #if ( configUSE_TRACE_FACILITY == 1 )\r
- UBaseType_t uxDummy4;\r
- #endif\r
-} StaticStreamBuffer_t;\r
-\r
-/* Message buffers are built on stream buffers. */\r
-typedef StaticStreamBuffer_t StaticMessageBuffer_t;\r
-\r
-#ifdef __cplusplus\r
-}\r
-#endif\r
-\r
-#endif /* INC_FREERTOS_H */\r
-\r
+++ /dev/null
-/*
- * ------------------------------------------------------------------------
- * File Name: FreeRTOSConfig.h
- * Author: Zhao Yanbai
- * 2018-07-07 15:16:55 Saturday CST
- * Description: none
- * ------------------------------------------------------------------------
- */
-
-#pragma once
-
-#define configMAX_PRIORITIES 25
-#define configMINIMAL_STACK_SIZE 768
-#define configUSE_TICK_HOOK 0
-#define configUSE_IDLE_HOOK 0
-#define configUSE_PREEMPTION 1
-#define configUSE_16_BIT_TICKS 0
-#define configUSE_CO_ROUTINES 0
-
-
-
+++ /dev/null
-/*\r
- * FreeRTOS Kernel V10.0.1\r
- * Copyright (C) 2017 Amazon.com, Inc. or its affiliates. All Rights Reserved.\r
- *\r
- * Permission is hereby granted, free of charge, to any person obtaining a copy of\r
- * this software and associated documentation files (the "Software"), to deal in\r
- * the Software without restriction, including without limitation the rights to\r
- * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of\r
- * the Software, and to permit persons to whom the Software is furnished to do so,\r
- * subject to the following conditions:\r
- *\r
- * The above copyright notice and this permission notice shall be included in all\r
- * copies or substantial portions of the Software.\r
- *\r
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\r
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS\r
- * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR\r
- * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER\r
- * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN\r
- * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\r
- *\r
- * http://www.FreeRTOS.org\r
- * http://aws.amazon.com/freertos\r
- *\r
- * 1 tab == 4 spaces!\r
- */\r
-\r
-#ifndef STACK_MACROS_H\r
-#define STACK_MACROS_H\r
-\r
-#ifndef _MSC_VER /* Visual Studio doesn't support #warning. */\r
- #warning The name of this file has changed to stack_macros.h. Please update your code accordingly. This source file (which has the original name) will be removed in future released.\r
-#endif\r
-\r
-/*\r
- * Call the stack overflow hook function if the stack of the task being swapped\r
- * out is currently overflowed, or looks like it might have overflowed in the\r
- * past.\r
- *\r
- * Setting configCHECK_FOR_STACK_OVERFLOW to 1 will cause the macro to check\r
- * the current stack state only - comparing the current top of stack value to\r
- * the stack limit. Setting configCHECK_FOR_STACK_OVERFLOW to greater than 1\r
- * will also cause the last few stack bytes to be checked to ensure the value\r
- * to which the bytes were set when the task was created have not been\r
- * overwritten. Note this second test does not guarantee that an overflowed\r
- * stack will always be recognised.\r
- */\r
-\r
-/*-----------------------------------------------------------*/\r
-\r
-#if( ( configCHECK_FOR_STACK_OVERFLOW == 1 ) && ( portSTACK_GROWTH < 0 ) )\r
-\r
- /* Only the current stack state is to be checked. */\r
- #define taskCHECK_FOR_STACK_OVERFLOW() \\r
- { \\r
- /* Is the currently saved stack pointer within the stack limit? */ \\r
- if( pxCurrentTCB->pxTopOfStack <= pxCurrentTCB->pxStack ) \\r
- { \\r
- vApplicationStackOverflowHook( ( TaskHandle_t ) pxCurrentTCB, pxCurrentTCB->pcTaskName ); \\r
- } \\r
- }\r
-\r
-#endif /* configCHECK_FOR_STACK_OVERFLOW == 1 */\r
-/*-----------------------------------------------------------*/\r
-\r
-#if( ( configCHECK_FOR_STACK_OVERFLOW == 1 ) && ( portSTACK_GROWTH > 0 ) )\r
-\r
- /* Only the current stack state is to be checked. */\r
- #define taskCHECK_FOR_STACK_OVERFLOW() \\r
- { \\r
- \\r
- /* Is the currently saved stack pointer within the stack limit? */ \\r
- if( pxCurrentTCB->pxTopOfStack >= pxCurrentTCB->pxEndOfStack ) \\r
- { \\r
- vApplicationStackOverflowHook( ( TaskHandle_t ) pxCurrentTCB, pxCurrentTCB->pcTaskName ); \\r
- } \\r
- }\r
-\r
-#endif /* configCHECK_FOR_STACK_OVERFLOW == 1 */\r
-/*-----------------------------------------------------------*/\r
-\r
-#if( ( configCHECK_FOR_STACK_OVERFLOW > 1 ) && ( portSTACK_GROWTH < 0 ) )\r
-\r
- #define taskCHECK_FOR_STACK_OVERFLOW() \\r
- { \\r
- const uint32_t * const pulStack = ( uint32_t * ) pxCurrentTCB->pxStack; \\r
- const uint32_t ulCheckValue = ( uint32_t ) 0xa5a5a5a5; \\r
- \\r
- if( ( pulStack[ 0 ] != ulCheckValue ) || \\r
- ( pulStack[ 1 ] != ulCheckValue ) || \\r
- ( pulStack[ 2 ] != ulCheckValue ) || \\r
- ( pulStack[ 3 ] != ulCheckValue ) ) \\r
- { \\r
- vApplicationStackOverflowHook( ( TaskHandle_t ) pxCurrentTCB, pxCurrentTCB->pcTaskName ); \\r
- } \\r
- }\r
-\r
-#endif /* #if( configCHECK_FOR_STACK_OVERFLOW > 1 ) */\r
-/*-----------------------------------------------------------*/\r
-\r
-#if( ( configCHECK_FOR_STACK_OVERFLOW > 1 ) && ( portSTACK_GROWTH > 0 ) )\r
-\r
- #define taskCHECK_FOR_STACK_OVERFLOW() \\r
- { \\r
- int8_t *pcEndOfStack = ( int8_t * ) pxCurrentTCB->pxEndOfStack; \\r
- static const uint8_t ucExpectedStackBytes[] = { tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, \\r
- tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, \\r
- tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, \\r
- tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, \\r
- tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE }; \\r
- \\r
- \\r
- pcEndOfStack -= sizeof( ucExpectedStackBytes ); \\r
- \\r
- /* Has the extremity of the task stack ever been written over? */ \\r
- if( memcmp( ( void * ) pcEndOfStack, ( void * ) ucExpectedStackBytes, sizeof( ucExpectedStackBytes ) ) != 0 ) \\r
- { \\r
- vApplicationStackOverflowHook( ( TaskHandle_t ) pxCurrentTCB, pxCurrentTCB->pcTaskName ); \\r
- } \\r
- }\r
-\r
-#endif /* #if( configCHECK_FOR_STACK_OVERFLOW > 1 ) */\r
-/*-----------------------------------------------------------*/\r
-\r
-/* Remove stack overflow macro if not being used. */\r
-#ifndef taskCHECK_FOR_STACK_OVERFLOW\r
- #define taskCHECK_FOR_STACK_OVERFLOW()\r
-#endif\r
-\r
-\r
-\r
-#endif /* STACK_MACROS_H */\r
-\r
+++ /dev/null
-/*\r
- * FreeRTOS Kernel V10.0.1\r
- * Copyright (C) 2017 Amazon.com, Inc. or its affiliates. All Rights Reserved.\r
- *\r
- * Permission is hereby granted, free of charge, to any person obtaining a copy of\r
- * this software and associated documentation files (the "Software"), to deal in\r
- * the Software without restriction, including without limitation the rights to\r
- * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of\r
- * the Software, and to permit persons to whom the Software is furnished to do so,\r
- * subject to the following conditions:\r
- *\r
- * The above copyright notice and this permission notice shall be included in all\r
- * copies or substantial portions of the Software.\r
- *\r
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\r
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS\r
- * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR\r
- * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER\r
- * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN\r
- * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\r
- *\r
- * http://www.FreeRTOS.org\r
- * http://aws.amazon.com/freertos\r
- *\r
- * 1 tab == 4 spaces!\r
- */\r
-\r
-#ifndef CO_ROUTINE_H\r
-#define CO_ROUTINE_H\r
-\r
-#ifndef INC_FREERTOS_H\r
- #error "include FreeRTOS.h must appear in source files before include croutine.h"\r
-#endif\r
-\r
-#include "list.h"\r
-\r
-#ifdef __cplusplus\r
-extern "C" {\r
-#endif\r
-\r
-/* Used to hide the implementation of the co-routine control block. The\r
-control block structure however has to be included in the header due to\r
-the macro implementation of the co-routine functionality. */\r
-typedef void * CoRoutineHandle_t;\r
-\r
-/* Defines the prototype to which co-routine functions must conform. */\r
-typedef void (*crCOROUTINE_CODE)( CoRoutineHandle_t, UBaseType_t );\r
-\r
-typedef struct corCoRoutineControlBlock\r
-{\r
- crCOROUTINE_CODE pxCoRoutineFunction;\r
- ListItem_t xGenericListItem; /*< List item used to place the CRCB in ready and blocked queues. */\r
- ListItem_t xEventListItem; /*< List item used to place the CRCB in event lists. */\r
- UBaseType_t uxPriority; /*< The priority of the co-routine in relation to other co-routines. */\r
- UBaseType_t uxIndex; /*< Used to distinguish between co-routines when multiple co-routines use the same co-routine function. */\r
- uint16_t uxState; /*< Used internally by the co-routine implementation. */\r
-} CRCB_t; /* Co-routine control block. Note must be identical in size down to uxPriority with TCB_t. */\r
-\r
-/**\r
- * croutine. h\r
- *<pre>\r
- BaseType_t xCoRoutineCreate(\r
- crCOROUTINE_CODE pxCoRoutineCode,\r
- UBaseType_t uxPriority,\r
- UBaseType_t uxIndex\r
- );</pre>\r
- *\r
- * Create a new co-routine and add it to the list of co-routines that are\r
- * ready to run.\r
- *\r
- * @param pxCoRoutineCode Pointer to the co-routine function. Co-routine\r
- * functions require special syntax - see the co-routine section of the WEB\r
- * documentation for more information.\r
- *\r
- * @param uxPriority The priority with respect to other co-routines at which\r
- * the co-routine will run.\r
- *\r
- * @param uxIndex Used to distinguish between different co-routines that\r
- * execute the same function. See the example below and the co-routine section\r
- * of the WEB documentation for further information.\r
- *\r
- * @return pdPASS if the co-routine was successfully created and added to a ready\r
- * list, otherwise an error code defined with ProjDefs.h.\r
- *\r
- * Example usage:\r
- <pre>\r
- // Co-routine to be created.\r
- void vFlashCoRoutine( CoRoutineHandle_t xHandle, UBaseType_t uxIndex )\r
- {\r
- // Variables in co-routines must be declared static if they must maintain value across a blocking call.\r
- // This may not be necessary for const variables.\r
- static const char cLedToFlash[ 2 ] = { 5, 6 };\r
- static const TickType_t uxFlashRates[ 2 ] = { 200, 400 };\r
-\r
- // Must start every co-routine with a call to crSTART();\r
- crSTART( xHandle );\r
-\r
- for( ;; )\r
- {\r
- // This co-routine just delays for a fixed period, then toggles\r
- // an LED. Two co-routines are created using this function, so\r
- // the uxIndex parameter is used to tell the co-routine which\r
- // LED to flash and how int32_t to delay. This assumes xQueue has\r
- // already been created.\r
- vParTestToggleLED( cLedToFlash[ uxIndex ] );\r
- crDELAY( xHandle, uxFlashRates[ uxIndex ] );\r
- }\r
-\r
- // Must end every co-routine with a call to crEND();\r
- crEND();\r
- }\r
-\r
- // Function that creates two co-routines.\r
- void vOtherFunction( void )\r
- {\r
- uint8_t ucParameterToPass;\r
- TaskHandle_t xHandle;\r
-\r
- // Create two co-routines at priority 0. The first is given index 0\r
- // so (from the code above) toggles LED 5 every 200 ticks. The second\r
- // is given index 1 so toggles LED 6 every 400 ticks.\r
- for( uxIndex = 0; uxIndex < 2; uxIndex++ )\r
- {\r
- xCoRoutineCreate( vFlashCoRoutine, 0, uxIndex );\r
- }\r
- }\r
- </pre>\r
- * \defgroup xCoRoutineCreate xCoRoutineCreate\r
- * \ingroup Tasks\r
- */\r
-BaseType_t xCoRoutineCreate( crCOROUTINE_CODE pxCoRoutineCode, UBaseType_t uxPriority, UBaseType_t uxIndex );\r
-\r
-\r
-/**\r
- * croutine. h\r
- *<pre>\r
- void vCoRoutineSchedule( void );</pre>\r
- *\r
- * Run a co-routine.\r
- *\r
- * vCoRoutineSchedule() executes the highest priority co-routine that is able\r
- * to run. The co-routine will execute until it either blocks, yields or is\r
- * preempted by a task. Co-routines execute cooperatively so one\r
- * co-routine cannot be preempted by another, but can be preempted by a task.\r
- *\r
- * If an application comprises of both tasks and co-routines then\r
- * vCoRoutineSchedule should be called from the idle task (in an idle task\r
- * hook).\r
- *\r
- * Example usage:\r
- <pre>\r
- // This idle task hook will schedule a co-routine each time it is called.\r
- // The rest of the idle task will execute between co-routine calls.\r
- void vApplicationIdleHook( void )\r
- {\r
- vCoRoutineSchedule();\r
- }\r
-\r
- // Alternatively, if you do not require any other part of the idle task to\r
- // execute, the idle task hook can call vCoRoutineScheduler() within an\r
- // infinite loop.\r
- void vApplicationIdleHook( void )\r
- {\r
- for( ;; )\r
- {\r
- vCoRoutineSchedule();\r
- }\r
- }\r
- </pre>\r
- * \defgroup vCoRoutineSchedule vCoRoutineSchedule\r
- * \ingroup Tasks\r
- */\r
-void vCoRoutineSchedule( void );\r
-\r
-/**\r
- * croutine. h\r
- * <pre>\r
- crSTART( CoRoutineHandle_t xHandle );</pre>\r
- *\r
- * This macro MUST always be called at the start of a co-routine function.\r
- *\r
- * Example usage:\r
- <pre>\r
- // Co-routine to be created.\r
- void vACoRoutine( CoRoutineHandle_t xHandle, UBaseType_t uxIndex )\r
- {\r
- // Variables in co-routines must be declared static if they must maintain value across a blocking call.\r
- static int32_t ulAVariable;\r
-\r
- // Must start every co-routine with a call to crSTART();\r
- crSTART( xHandle );\r
-\r
- for( ;; )\r
- {\r
- // Co-routine functionality goes here.\r
- }\r
-\r
- // Must end every co-routine with a call to crEND();\r
- crEND();\r
- }</pre>\r
- * \defgroup crSTART crSTART\r
- * \ingroup Tasks\r
- */\r
-#define crSTART( pxCRCB ) switch( ( ( CRCB_t * )( pxCRCB ) )->uxState ) { case 0:\r
-\r
-/**\r
- * croutine. h\r
- * <pre>\r
- crEND();</pre>\r
- *\r
- * This macro MUST always be called at the end of a co-routine function.\r
- *\r
- * Example usage:\r
- <pre>\r
- // Co-routine to be created.\r
- void vACoRoutine( CoRoutineHandle_t xHandle, UBaseType_t uxIndex )\r
- {\r
- // Variables in co-routines must be declared static if they must maintain value across a blocking call.\r
- static int32_t ulAVariable;\r
-\r
- // Must start every co-routine with a call to crSTART();\r
- crSTART( xHandle );\r
-\r
- for( ;; )\r
- {\r
- // Co-routine functionality goes here.\r
- }\r
-\r
- // Must end every co-routine with a call to crEND();\r
- crEND();\r
- }</pre>\r
- * \defgroup crSTART crSTART\r
- * \ingroup Tasks\r
- */\r
-#define crEND() }\r
-\r
-/*\r
- * These macros are intended for internal use by the co-routine implementation\r
- * only. The macros should not be used directly by application writers.\r
- */\r
-#define crSET_STATE0( xHandle ) ( ( CRCB_t * )( xHandle ) )->uxState = (__LINE__ * 2); return; case (__LINE__ * 2):\r
-#define crSET_STATE1( xHandle ) ( ( CRCB_t * )( xHandle ) )->uxState = ((__LINE__ * 2)+1); return; case ((__LINE__ * 2)+1):\r
-\r
-/**\r
- * croutine. h\r
- *<pre>\r
- crDELAY( CoRoutineHandle_t xHandle, TickType_t xTicksToDelay );</pre>\r
- *\r
- * Delay a co-routine for a fixed period of time.\r
- *\r
- * crDELAY can only be called from the co-routine function itself - not\r
- * from within a function called by the co-routine function. This is because\r
- * co-routines do not maintain their own stack.\r
- *\r
- * @param xHandle The handle of the co-routine to delay. This is the xHandle\r
- * parameter of the co-routine function.\r
- *\r
- * @param xTickToDelay The number of ticks that the co-routine should delay\r
- * for. The actual amount of time this equates to is defined by\r
- * configTICK_RATE_HZ (set in FreeRTOSConfig.h). The constant portTICK_PERIOD_MS\r
- * can be used to convert ticks to milliseconds.\r
- *\r
- * Example usage:\r
- <pre>\r
- // Co-routine to be created.\r
- void vACoRoutine( CoRoutineHandle_t xHandle, UBaseType_t uxIndex )\r
- {\r
- // Variables in co-routines must be declared static if they must maintain value across a blocking call.\r
- // This may not be necessary for const variables.\r
- // We are to delay for 200ms.\r
- static const xTickType xDelayTime = 200 / portTICK_PERIOD_MS;\r
-\r
- // Must start every co-routine with a call to crSTART();\r
- crSTART( xHandle );\r
-\r
- for( ;; )\r
- {\r
- // Delay for 200ms.\r
- crDELAY( xHandle, xDelayTime );\r
-\r
- // Do something here.\r
- }\r
-\r
- // Must end every co-routine with a call to crEND();\r
- crEND();\r
- }</pre>\r
- * \defgroup crDELAY crDELAY\r
- * \ingroup Tasks\r
- */\r
-#define crDELAY( xHandle, xTicksToDelay ) \\r
- if( ( xTicksToDelay ) > 0 ) \\r
- { \\r
- vCoRoutineAddToDelayedList( ( xTicksToDelay ), NULL ); \\r
- } \\r
- crSET_STATE0( ( xHandle ) );\r
-\r
-/**\r
- * <pre>\r
- crQUEUE_SEND(\r
- CoRoutineHandle_t xHandle,\r
- QueueHandle_t pxQueue,\r
- void *pvItemToQueue,\r
- TickType_t xTicksToWait,\r
- BaseType_t *pxResult\r
- )</pre>\r
- *\r
- * The macro's crQUEUE_SEND() and crQUEUE_RECEIVE() are the co-routine\r
- * equivalent to the xQueueSend() and xQueueReceive() functions used by tasks.\r
- *\r
- * crQUEUE_SEND and crQUEUE_RECEIVE can only be used from a co-routine whereas\r
- * xQueueSend() and xQueueReceive() can only be used from tasks.\r
- *\r
- * crQUEUE_SEND can only be called from the co-routine function itself - not\r
- * from within a function called by the co-routine function. This is because\r
- * co-routines do not maintain their own stack.\r
- *\r
- * See the co-routine section of the WEB documentation for information on\r
- * passing data between tasks and co-routines and between ISR's and\r
- * co-routines.\r
- *\r
- * @param xHandle The handle of the calling co-routine. This is the xHandle\r
- * parameter of the co-routine function.\r
- *\r
- * @param pxQueue The handle of the queue on which the data will be posted.\r
- * The handle is obtained as the return value when the queue is created using\r
- * the xQueueCreate() API function.\r
- *\r
- * @param pvItemToQueue A pointer to the data being posted onto the queue.\r
- * The number of bytes of each queued item is specified when the queue is\r
- * created. This number of bytes is copied from pvItemToQueue into the queue\r
- * itself.\r
- *\r
- * @param xTickToDelay The number of ticks that the co-routine should block\r
- * to wait for space to become available on the queue, should space not be\r
- * available immediately. The actual amount of time this equates to is defined\r
- * by configTICK_RATE_HZ (set in FreeRTOSConfig.h). The constant\r
- * portTICK_PERIOD_MS can be used to convert ticks to milliseconds (see example\r
- * below).\r
- *\r
- * @param pxResult The variable pointed to by pxResult will be set to pdPASS if\r
- * data was successfully posted onto the queue, otherwise it will be set to an\r
- * error defined within ProjDefs.h.\r
- *\r
- * Example usage:\r
- <pre>\r
- // Co-routine function that blocks for a fixed period then posts a number onto\r
- // a queue.\r
- static void prvCoRoutineFlashTask( CoRoutineHandle_t xHandle, UBaseType_t uxIndex )\r
- {\r
- // Variables in co-routines must be declared static if they must maintain value across a blocking call.\r
- static BaseType_t xNumberToPost = 0;\r
- static BaseType_t xResult;\r
-\r
- // Co-routines must begin with a call to crSTART().\r
- crSTART( xHandle );\r
-\r
- for( ;; )\r
- {\r
- // This assumes the queue has already been created.\r
- crQUEUE_SEND( xHandle, xCoRoutineQueue, &xNumberToPost, NO_DELAY, &xResult );\r
-\r
- if( xResult != pdPASS )\r
- {\r
- // The message was not posted!\r
- }\r
-\r
- // Increment the number to be posted onto the queue.\r
- xNumberToPost++;\r
-\r
- // Delay for 100 ticks.\r
- crDELAY( xHandle, 100 );\r
- }\r
-\r
- // Co-routines must end with a call to crEND().\r
- crEND();\r
- }</pre>\r
- * \defgroup crQUEUE_SEND crQUEUE_SEND\r
- * \ingroup Tasks\r
- */\r
-#define crQUEUE_SEND( xHandle, pxQueue, pvItemToQueue, xTicksToWait, pxResult ) \\r
-{ \\r
- *( pxResult ) = xQueueCRSend( ( pxQueue) , ( pvItemToQueue) , ( xTicksToWait ) ); \\r
- if( *( pxResult ) == errQUEUE_BLOCKED ) \\r
- { \\r
- crSET_STATE0( ( xHandle ) ); \\r
- *pxResult = xQueueCRSend( ( pxQueue ), ( pvItemToQueue ), 0 ); \\r
- } \\r
- if( *pxResult == errQUEUE_YIELD ) \\r
- { \\r
- crSET_STATE1( ( xHandle ) ); \\r
- *pxResult = pdPASS; \\r
- } \\r
-}\r
-\r
-/**\r
- * croutine. h\r
- * <pre>\r
- crQUEUE_RECEIVE(\r
- CoRoutineHandle_t xHandle,\r
- QueueHandle_t pxQueue,\r
- void *pvBuffer,\r
- TickType_t xTicksToWait,\r
- BaseType_t *pxResult\r
- )</pre>\r
- *\r
- * The macro's crQUEUE_SEND() and crQUEUE_RECEIVE() are the co-routine\r
- * equivalent to the xQueueSend() and xQueueReceive() functions used by tasks.\r
- *\r
- * crQUEUE_SEND and crQUEUE_RECEIVE can only be used from a co-routine whereas\r
- * xQueueSend() and xQueueReceive() can only be used from tasks.\r
- *\r
- * crQUEUE_RECEIVE can only be called from the co-routine function itself - not\r
- * from within a function called by the co-routine function. This is because\r
- * co-routines do not maintain their own stack.\r
- *\r
- * See the co-routine section of the WEB documentation for information on\r
- * passing data between tasks and co-routines and between ISR's and\r
- * co-routines.\r
- *\r
- * @param xHandle The handle of the calling co-routine. This is the xHandle\r
- * parameter of the co-routine function.\r
- *\r
- * @param pxQueue The handle of the queue from which the data will be received.\r
- * The handle is obtained as the return value when the queue is created using\r
- * the xQueueCreate() API function.\r
- *\r
- * @param pvBuffer The buffer into which the received item is to be copied.\r
- * The number of bytes of each queued item is specified when the queue is\r
- * created. This number of bytes is copied into pvBuffer.\r
- *\r
- * @param xTickToDelay The number of ticks that the co-routine should block\r
- * to wait for data to become available from the queue, should data not be\r
- * available immediately. The actual amount of time this equates to is defined\r
- * by configTICK_RATE_HZ (set in FreeRTOSConfig.h). The constant\r
- * portTICK_PERIOD_MS can be used to convert ticks to milliseconds (see the\r
- * crQUEUE_SEND example).\r
- *\r
- * @param pxResult The variable pointed to by pxResult will be set to pdPASS if\r
- * data was successfully retrieved from the queue, otherwise it will be set to\r
- * an error code as defined within ProjDefs.h.\r
- *\r
- * Example usage:\r
- <pre>\r
- // A co-routine receives the number of an LED to flash from a queue. It\r
- // blocks on the queue until the number is received.\r
- static void prvCoRoutineFlashWorkTask( CoRoutineHandle_t xHandle, UBaseType_t uxIndex )\r
- {\r
- // Variables in co-routines must be declared static if they must maintain value across a blocking call.\r
- static BaseType_t xResult;\r
- static UBaseType_t uxLEDToFlash;\r
-\r
- // All co-routines must start with a call to crSTART().\r
- crSTART( xHandle );\r
-\r
- for( ;; )\r
- {\r
- // Wait for data to become available on the queue.\r
- crQUEUE_RECEIVE( xHandle, xCoRoutineQueue, &uxLEDToFlash, portMAX_DELAY, &xResult );\r
-\r
- if( xResult == pdPASS )\r
- {\r
- // We received the LED to flash - flash it!\r
- vParTestToggleLED( uxLEDToFlash );\r
- }\r
- }\r
-\r
- crEND();\r
- }</pre>\r
- * \defgroup crQUEUE_RECEIVE crQUEUE_RECEIVE\r
- * \ingroup Tasks\r
- */\r
-#define crQUEUE_RECEIVE( xHandle, pxQueue, pvBuffer, xTicksToWait, pxResult ) \\r
-{ \\r
- *( pxResult ) = xQueueCRReceive( ( pxQueue) , ( pvBuffer ), ( xTicksToWait ) ); \\r
- if( *( pxResult ) == errQUEUE_BLOCKED ) \\r
- { \\r
- crSET_STATE0( ( xHandle ) ); \\r
- *( pxResult ) = xQueueCRReceive( ( pxQueue) , ( pvBuffer ), 0 ); \\r
- } \\r
- if( *( pxResult ) == errQUEUE_YIELD ) \\r
- { \\r
- crSET_STATE1( ( xHandle ) ); \\r
- *( pxResult ) = pdPASS; \\r
- } \\r
-}\r
-\r
-/**\r
- * croutine. h\r
- * <pre>\r
- crQUEUE_SEND_FROM_ISR(\r
- QueueHandle_t pxQueue,\r
- void *pvItemToQueue,\r
- BaseType_t xCoRoutinePreviouslyWoken\r
- )</pre>\r
- *\r
- * The macro's crQUEUE_SEND_FROM_ISR() and crQUEUE_RECEIVE_FROM_ISR() are the\r
- * co-routine equivalent to the xQueueSendFromISR() and xQueueReceiveFromISR()\r
- * functions used by tasks.\r
- *\r
- * crQUEUE_SEND_FROM_ISR() and crQUEUE_RECEIVE_FROM_ISR() can only be used to\r
- * pass data between a co-routine and and ISR, whereas xQueueSendFromISR() and\r
- * xQueueReceiveFromISR() can only be used to pass data between a task and and\r
- * ISR.\r
- *\r
- * crQUEUE_SEND_FROM_ISR can only be called from an ISR to send data to a queue\r
- * that is being used from within a co-routine.\r
- *\r
- * See the co-routine section of the WEB documentation for information on\r
- * passing data between tasks and co-routines and between ISR's and\r
- * co-routines.\r
- *\r
- * @param xQueue The handle to the queue on which the item is to be posted.\r
- *\r
- * @param pvItemToQueue A pointer to the item that is to be placed on the\r
- * queue. The size of the items the queue will hold was defined when the\r
- * queue was created, so this many bytes will be copied from pvItemToQueue\r
- * into the queue storage area.\r
- *\r
- * @param xCoRoutinePreviouslyWoken This is included so an ISR can post onto\r
- * the same queue multiple times from a single interrupt. The first call\r
- * should always pass in pdFALSE. Subsequent calls should pass in\r
- * the value returned from the previous call.\r
- *\r
- * @return pdTRUE if a co-routine was woken by posting onto the queue. This is\r
- * used by the ISR to determine if a context switch may be required following\r
- * the ISR.\r
- *\r
- * Example usage:\r
- <pre>\r
- // A co-routine that blocks on a queue waiting for characters to be received.\r
- static void vReceivingCoRoutine( CoRoutineHandle_t xHandle, UBaseType_t uxIndex )\r
- {\r
- char cRxedChar;\r
- BaseType_t xResult;\r
-\r
- // All co-routines must start with a call to crSTART().\r
- crSTART( xHandle );\r
-\r
- for( ;; )\r
- {\r
- // Wait for data to become available on the queue. This assumes the\r
- // queue xCommsRxQueue has already been created!\r
- crQUEUE_RECEIVE( xHandle, xCommsRxQueue, &uxLEDToFlash, portMAX_DELAY, &xResult );\r
-\r
- // Was a character received?\r
- if( xResult == pdPASS )\r
- {\r
- // Process the character here.\r
- }\r
- }\r
-\r
- // All co-routines must end with a call to crEND().\r
- crEND();\r
- }\r
-\r
- // An ISR that uses a queue to send characters received on a serial port to\r
- // a co-routine.\r
- void vUART_ISR( void )\r
- {\r
- char cRxedChar;\r
- BaseType_t xCRWokenByPost = pdFALSE;\r
-\r
- // We loop around reading characters until there are none left in the UART.\r
- while( UART_RX_REG_NOT_EMPTY() )\r
- {\r
- // Obtain the character from the UART.\r
- cRxedChar = UART_RX_REG;\r
-\r
- // Post the character onto a queue. xCRWokenByPost will be pdFALSE\r
- // the first time around the loop. If the post causes a co-routine\r
- // to be woken (unblocked) then xCRWokenByPost will be set to pdTRUE.\r
- // In this manner we can ensure that if more than one co-routine is\r
- // blocked on the queue only one is woken by this ISR no matter how\r
- // many characters are posted to the queue.\r
- xCRWokenByPost = crQUEUE_SEND_FROM_ISR( xCommsRxQueue, &cRxedChar, xCRWokenByPost );\r
- }\r
- }</pre>\r
- * \defgroup crQUEUE_SEND_FROM_ISR crQUEUE_SEND_FROM_ISR\r
- * \ingroup Tasks\r
- */\r
-#define crQUEUE_SEND_FROM_ISR( pxQueue, pvItemToQueue, xCoRoutinePreviouslyWoken ) xQueueCRSendFromISR( ( pxQueue ), ( pvItemToQueue ), ( xCoRoutinePreviouslyWoken ) )\r
-\r
-\r
-/**\r
- * croutine. h\r
- * <pre>\r
- crQUEUE_SEND_FROM_ISR(\r
- QueueHandle_t pxQueue,\r
- void *pvBuffer,\r
- BaseType_t * pxCoRoutineWoken\r
- )</pre>\r
- *\r
- * The macro's crQUEUE_SEND_FROM_ISR() and crQUEUE_RECEIVE_FROM_ISR() are the\r
- * co-routine equivalent to the xQueueSendFromISR() and xQueueReceiveFromISR()\r
- * functions used by tasks.\r
- *\r
- * crQUEUE_SEND_FROM_ISR() and crQUEUE_RECEIVE_FROM_ISR() can only be used to\r
- * pass data between a co-routine and and ISR, whereas xQueueSendFromISR() and\r
- * xQueueReceiveFromISR() can only be used to pass data between a task and and\r
- * ISR.\r
- *\r
- * crQUEUE_RECEIVE_FROM_ISR can only be called from an ISR to receive data\r
- * from a queue that is being used from within a co-routine (a co-routine\r
- * posted to the queue).\r
- *\r
- * See the co-routine section of the WEB documentation for information on\r
- * passing data between tasks and co-routines and between ISR's and\r
- * co-routines.\r
- *\r
- * @param xQueue The handle to the queue on which the item is to be posted.\r
- *\r
- * @param pvBuffer A pointer to a buffer into which the received item will be\r
- * placed. The size of the items the queue will hold was defined when the\r
- * queue was created, so this many bytes will be copied from the queue into\r
- * pvBuffer.\r
- *\r
- * @param pxCoRoutineWoken A co-routine may be blocked waiting for space to become\r
- * available on the queue. If crQUEUE_RECEIVE_FROM_ISR causes such a\r
- * co-routine to unblock *pxCoRoutineWoken will get set to pdTRUE, otherwise\r
- * *pxCoRoutineWoken will remain unchanged.\r
- *\r
- * @return pdTRUE an item was successfully received from the queue, otherwise\r
- * pdFALSE.\r
- *\r
- * Example usage:\r
- <pre>\r
- // A co-routine that posts a character to a queue then blocks for a fixed\r
- // period. The character is incremented each time.\r
- static void vSendingCoRoutine( CoRoutineHandle_t xHandle, UBaseType_t uxIndex )\r
- {\r
- // cChar holds its value while this co-routine is blocked and must therefore\r
- // be declared static.\r
- static char cCharToTx = 'a';\r
- BaseType_t xResult;\r
-\r
- // All co-routines must start with a call to crSTART().\r
- crSTART( xHandle );\r
-\r
- for( ;; )\r
- {\r
- // Send the next character to the queue.\r
- crQUEUE_SEND( xHandle, xCoRoutineQueue, &cCharToTx, NO_DELAY, &xResult );\r
-\r
- if( xResult == pdPASS )\r
- {\r
- // The character was successfully posted to the queue.\r
- }\r
- else\r
- {\r
- // Could not post the character to the queue.\r
- }\r
-\r
- // Enable the UART Tx interrupt to cause an interrupt in this\r
- // hypothetical UART. The interrupt will obtain the character\r
- // from the queue and send it.\r
- ENABLE_RX_INTERRUPT();\r
-\r
- // Increment to the next character then block for a fixed period.\r
- // cCharToTx will maintain its value across the delay as it is\r
- // declared static.\r
- cCharToTx++;\r
- if( cCharToTx > 'x' )\r
- {\r
- cCharToTx = 'a';\r
- }\r
- crDELAY( 100 );\r
- }\r
-\r
- // All co-routines must end with a call to crEND().\r
- crEND();\r
- }\r
-\r
- // An ISR that uses a queue to receive characters to send on a UART.\r
- void vUART_ISR( void )\r
- {\r
- char cCharToTx;\r
- BaseType_t xCRWokenByPost = pdFALSE;\r
-\r
- while( UART_TX_REG_EMPTY() )\r
- {\r
- // Are there any characters in the queue waiting to be sent?\r
- // xCRWokenByPost will automatically be set to pdTRUE if a co-routine\r
- // is woken by the post - ensuring that only a single co-routine is\r
- // woken no matter how many times we go around this loop.\r
- if( crQUEUE_RECEIVE_FROM_ISR( pxQueue, &cCharToTx, &xCRWokenByPost ) )\r
- {\r
- SEND_CHARACTER( cCharToTx );\r
- }\r
- }\r
- }</pre>\r
- * \defgroup crQUEUE_RECEIVE_FROM_ISR crQUEUE_RECEIVE_FROM_ISR\r
- * \ingroup Tasks\r
- */\r
-#define crQUEUE_RECEIVE_FROM_ISR( pxQueue, pvBuffer, pxCoRoutineWoken ) xQueueCRReceiveFromISR( ( pxQueue ), ( pvBuffer ), ( pxCoRoutineWoken ) )\r
-\r
-/*\r
- * This function is intended for internal use by the co-routine macros only.\r
- * The macro nature of the co-routine implementation requires that the\r
- * prototype appears here. The function should not be used by application\r
- * writers.\r
- *\r
- * Removes the current co-routine from its ready list and places it in the\r
- * appropriate delayed list.\r
- */\r
-void vCoRoutineAddToDelayedList( TickType_t xTicksToDelay, List_t *pxEventList );\r
-\r
-/*\r
- * This function is intended for internal use by the queue implementation only.\r
- * The function should not be used by application writers.\r
- *\r
- * Removes the highest priority co-routine from the event list and places it in\r
- * the pending ready list.\r
- */\r
-BaseType_t xCoRoutineRemoveFromEventList( const List_t *pxEventList );\r
-\r
-#ifdef __cplusplus\r
-}\r
-#endif\r
-\r
-#endif /* CO_ROUTINE_H */\r
+++ /dev/null
-/*\r
- * FreeRTOS Kernel V10.0.1\r
- * Copyright (C) 2017 Amazon.com, Inc. or its affiliates. All Rights Reserved.\r
- *\r
- * Permission is hereby granted, free of charge, to any person obtaining a copy of\r
- * this software and associated documentation files (the "Software"), to deal in\r
- * the Software without restriction, including without limitation the rights to\r
- * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of\r
- * the Software, and to permit persons to whom the Software is furnished to do so,\r
- * subject to the following conditions:\r
- *\r
- * The above copyright notice and this permission notice shall be included in all\r
- * copies or substantial portions of the Software.\r
- *\r
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\r
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS\r
- * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR\r
- * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER\r
- * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN\r
- * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\r
- *\r
- * http://www.FreeRTOS.org\r
- * http://aws.amazon.com/freertos\r
- *\r
- * 1 tab == 4 spaces!\r
- */\r
-\r
-#ifndef DEPRECATED_DEFINITIONS_H\r
-#define DEPRECATED_DEFINITIONS_H\r
-\r
-\r
-/* Each FreeRTOS port has a unique portmacro.h header file. Originally a\r
-pre-processor definition was used to ensure the pre-processor found the correct\r
-portmacro.h file for the port being used. That scheme was deprecated in favour\r
-of setting the compiler's include path such that it found the correct\r
-portmacro.h file - removing the need for the constant and allowing the\r
-portmacro.h file to be located anywhere in relation to the port being used. The\r
-definitions below remain in the code for backward compatibility only. New\r
-projects should not use them. */\r
-\r
-#ifdef OPEN_WATCOM_INDUSTRIAL_PC_PORT\r
- #include "..\..\Source\portable\owatcom\16bitdos\pc\portmacro.h"\r
- typedef void ( __interrupt __far *pxISR )();\r
-#endif\r
-\r
-#ifdef OPEN_WATCOM_FLASH_LITE_186_PORT\r
- #include "..\..\Source\portable\owatcom\16bitdos\flsh186\portmacro.h"\r
- typedef void ( __interrupt __far *pxISR )();\r
-#endif\r
-\r
-#ifdef GCC_MEGA_AVR\r
- #include "../portable/GCC/ATMega323/portmacro.h"\r
-#endif\r
-\r
-#ifdef IAR_MEGA_AVR\r
- #include "../portable/IAR/ATMega323/portmacro.h"\r
-#endif\r
-\r
-#ifdef MPLAB_PIC24_PORT\r
- #include "../../Source/portable/MPLAB/PIC24_dsPIC/portmacro.h"\r
-#endif\r
-\r
-#ifdef MPLAB_DSPIC_PORT\r
- #include "../../Source/portable/MPLAB/PIC24_dsPIC/portmacro.h"\r
-#endif\r
-\r
-#ifdef MPLAB_PIC18F_PORT\r
- #include "../../Source/portable/MPLAB/PIC18F/portmacro.h"\r
-#endif\r
-\r
-#ifdef MPLAB_PIC32MX_PORT\r
- #include "../../Source/portable/MPLAB/PIC32MX/portmacro.h"\r
-#endif\r
-\r
-#ifdef _FEDPICC\r
- #include "libFreeRTOS/Include/portmacro.h"\r
-#endif\r
-\r
-#ifdef SDCC_CYGNAL\r
- #include "../../Source/portable/SDCC/Cygnal/portmacro.h"\r
-#endif\r
-\r
-#ifdef GCC_ARM7\r
- #include "../../Source/portable/GCC/ARM7_LPC2000/portmacro.h"\r
-#endif\r
-\r
-#ifdef GCC_ARM7_ECLIPSE\r
- #include "portmacro.h"\r
-#endif\r
-\r
-#ifdef ROWLEY_LPC23xx\r
- #include "../../Source/portable/GCC/ARM7_LPC23xx/portmacro.h"\r
-#endif\r
-\r
-#ifdef IAR_MSP430\r
- #include "..\..\Source\portable\IAR\MSP430\portmacro.h"\r
-#endif\r
-\r
-#ifdef GCC_MSP430\r
- #include "../../Source/portable/GCC/MSP430F449/portmacro.h"\r
-#endif\r
-\r
-#ifdef ROWLEY_MSP430\r
- #include "../../Source/portable/Rowley/MSP430F449/portmacro.h"\r
-#endif\r
-\r
-#ifdef ARM7_LPC21xx_KEIL_RVDS\r
- #include "..\..\Source\portable\RVDS\ARM7_LPC21xx\portmacro.h"\r
-#endif\r
-\r
-#ifdef SAM7_GCC\r
- #include "../../Source/portable/GCC/ARM7_AT91SAM7S/portmacro.h"\r
-#endif\r
-\r
-#ifdef SAM7_IAR\r
- #include "..\..\Source\portable\IAR\AtmelSAM7S64\portmacro.h"\r
-#endif\r
-\r
-#ifdef SAM9XE_IAR\r
- #include "..\..\Source\portable\IAR\AtmelSAM9XE\portmacro.h"\r
-#endif\r
-\r
-#ifdef LPC2000_IAR\r
- #include "..\..\Source\portable\IAR\LPC2000\portmacro.h"\r
-#endif\r
-\r
-#ifdef STR71X_IAR\r
- #include "..\..\Source\portable\IAR\STR71x\portmacro.h"\r
-#endif\r
-\r
-#ifdef STR75X_IAR\r
- #include "..\..\Source\portable\IAR\STR75x\portmacro.h"\r
-#endif\r
-\r
-#ifdef STR75X_GCC\r
- #include "..\..\Source\portable\GCC\STR75x\portmacro.h"\r
-#endif\r
-\r
-#ifdef STR91X_IAR\r
- #include "..\..\Source\portable\IAR\STR91x\portmacro.h"\r
-#endif\r
-\r
-#ifdef GCC_H8S\r
- #include "../../Source/portable/GCC/H8S2329/portmacro.h"\r
-#endif\r
-\r
-#ifdef GCC_AT91FR40008\r
- #include "../../Source/portable/GCC/ARM7_AT91FR40008/portmacro.h"\r
-#endif\r
-\r
-#ifdef RVDS_ARMCM3_LM3S102\r
- #include "../../Source/portable/RVDS/ARM_CM3/portmacro.h"\r
-#endif\r
-\r
-#ifdef GCC_ARMCM3_LM3S102\r
- #include "../../Source/portable/GCC/ARM_CM3/portmacro.h"\r
-#endif\r
-\r
-#ifdef GCC_ARMCM3\r
- #include "../../Source/portable/GCC/ARM_CM3/portmacro.h"\r
-#endif\r
-\r
-#ifdef IAR_ARM_CM3\r
- #include "../../Source/portable/IAR/ARM_CM3/portmacro.h"\r
-#endif\r
-\r
-#ifdef IAR_ARMCM3_LM\r
- #include "../../Source/portable/IAR/ARM_CM3/portmacro.h"\r
-#endif\r
-\r
-#ifdef HCS12_CODE_WARRIOR\r
- #include "../../Source/portable/CodeWarrior/HCS12/portmacro.h"\r
-#endif\r
-\r
-#ifdef MICROBLAZE_GCC\r
- #include "../../Source/portable/GCC/MicroBlaze/portmacro.h"\r
-#endif\r
-\r
-#ifdef TERN_EE\r
- #include "..\..\Source\portable\Paradigm\Tern_EE\small\portmacro.h"\r
-#endif\r
-\r
-#ifdef GCC_HCS12\r
- #include "../../Source/portable/GCC/HCS12/portmacro.h"\r
-#endif\r
-\r
-#ifdef GCC_MCF5235\r
- #include "../../Source/portable/GCC/MCF5235/portmacro.h"\r
-#endif\r
-\r
-#ifdef COLDFIRE_V2_GCC\r
- #include "../../../Source/portable/GCC/ColdFire_V2/portmacro.h"\r
-#endif\r
-\r
-#ifdef COLDFIRE_V2_CODEWARRIOR\r
- #include "../../Source/portable/CodeWarrior/ColdFire_V2/portmacro.h"\r
-#endif\r
-\r
-#ifdef GCC_PPC405\r
- #include "../../Source/portable/GCC/PPC405_Xilinx/portmacro.h"\r
-#endif\r
-\r
-#ifdef GCC_PPC440\r
- #include "../../Source/portable/GCC/PPC440_Xilinx/portmacro.h"\r
-#endif\r
-\r
-#ifdef _16FX_SOFTUNE\r
- #include "..\..\Source\portable\Softune\MB96340\portmacro.h"\r
-#endif\r
-\r
-#ifdef BCC_INDUSTRIAL_PC_PORT\r
- /* A short file name has to be used in place of the normal\r
- FreeRTOSConfig.h when using the Borland compiler. */\r
- #include "frconfig.h"\r
- #include "..\portable\BCC\16BitDOS\PC\prtmacro.h"\r
- typedef void ( __interrupt __far *pxISR )();\r
-#endif\r
-\r
-#ifdef BCC_FLASH_LITE_186_PORT\r
- /* A short file name has to be used in place of the normal\r
- FreeRTOSConfig.h when using the Borland compiler. */\r
- #include "frconfig.h"\r
- #include "..\portable\BCC\16BitDOS\flsh186\prtmacro.h"\r
- typedef void ( __interrupt __far *pxISR )();\r
-#endif\r
-\r
-#ifdef __GNUC__\r
- #ifdef __AVR32_AVR32A__\r
- #include "portmacro.h"\r
- #endif\r
-#endif\r
-\r
-#ifdef __ICCAVR32__\r
- #ifdef __CORE__\r
- #if __CORE__ == __AVR32A__\r
- #include "portmacro.h"\r
- #endif\r
- #endif\r
-#endif\r
-\r
-#ifdef __91467D\r
- #include "portmacro.h"\r
-#endif\r
-\r
-#ifdef __96340\r
- #include "portmacro.h"\r
-#endif\r
-\r
-\r
-#ifdef __IAR_V850ES_Fx3__\r
- #include "../../Source/portable/IAR/V850ES/portmacro.h"\r
-#endif\r
-\r
-#ifdef __IAR_V850ES_Jx3__\r
- #include "../../Source/portable/IAR/V850ES/portmacro.h"\r
-#endif\r
-\r
-#ifdef __IAR_V850ES_Jx3_L__\r
- #include "../../Source/portable/IAR/V850ES/portmacro.h"\r
-#endif\r
-\r
-#ifdef __IAR_V850ES_Jx2__\r
- #include "../../Source/portable/IAR/V850ES/portmacro.h"\r
-#endif\r
-\r
-#ifdef __IAR_V850ES_Hx2__\r
- #include "../../Source/portable/IAR/V850ES/portmacro.h"\r
-#endif\r
-\r
-#ifdef __IAR_78K0R_Kx3__\r
- #include "../../Source/portable/IAR/78K0R/portmacro.h"\r
-#endif\r
-\r
-#ifdef __IAR_78K0R_Kx3L__\r
- #include "../../Source/portable/IAR/78K0R/portmacro.h"\r
-#endif\r
-\r
-#endif /* DEPRECATED_DEFINITIONS_H */\r
-\r
+++ /dev/null
-/*\r
- * FreeRTOS Kernel V10.0.1\r
- * Copyright (C) 2017 Amazon.com, Inc. or its affiliates. All Rights Reserved.\r
- *\r
- * Permission is hereby granted, free of charge, to any person obtaining a copy of\r
- * this software and associated documentation files (the "Software"), to deal in\r
- * the Software without restriction, including without limitation the rights to\r
- * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of\r
- * the Software, and to permit persons to whom the Software is furnished to do so,\r
- * subject to the following conditions:\r
- *\r
- * The above copyright notice and this permission notice shall be included in all\r
- * copies or substantial portions of the Software.\r
- *\r
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\r
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS\r
- * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR\r
- * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER\r
- * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN\r
- * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\r
- *\r
- * http://www.FreeRTOS.org\r
- * http://aws.amazon.com/freertos\r
- *\r
- * 1 tab == 4 spaces!\r
- */\r
-\r
-#ifndef EVENT_GROUPS_H\r
-#define EVENT_GROUPS_H\r
-\r
-#ifndef INC_FREERTOS_H\r
- #error "include FreeRTOS.h" must appear in source files before "include event_groups.h"\r
-#endif\r
-\r
-/* FreeRTOS includes. */\r
-#include "timers.h"\r
-\r
-#ifdef __cplusplus\r
-extern "C" {\r
-#endif\r
-\r
-/**\r
- * An event group is a collection of bits to which an application can assign a\r
- * meaning. For example, an application may create an event group to convey\r
- * the status of various CAN bus related events in which bit 0 might mean "A CAN\r
- * message has been received and is ready for processing", bit 1 might mean "The\r
- * application has queued a message that is ready for sending onto the CAN\r
- * network", and bit 2 might mean "It is time to send a SYNC message onto the\r
- * CAN network" etc. A task can then test the bit values to see which events\r
- * are active, and optionally enter the Blocked state to wait for a specified\r
- * bit or a group of specified bits to be active. To continue the CAN bus\r
- * example, a CAN controlling task can enter the Blocked state (and therefore\r
- * not consume any processing time) until either bit 0, bit 1 or bit 2 are\r
- * active, at which time the bit that was actually active would inform the task\r
- * which action it had to take (process a received message, send a message, or\r
- * send a SYNC).\r
- *\r
- * The event groups implementation contains intelligence to avoid race\r
- * conditions that would otherwise occur were an application to use a simple\r
- * variable for the same purpose. This is particularly important with respect\r
- * to when a bit within an event group is to be cleared, and when bits have to\r
- * be set and then tested atomically - as is the case where event groups are\r
- * used to create a synchronisation point between multiple tasks (a\r
- * 'rendezvous').\r
- *\r
- * \defgroup EventGroup\r
- */\r
-\r
-\r
-\r
-/**\r
- * event_groups.h\r
- *\r
- * Type by which event groups are referenced. For example, a call to\r
- * xEventGroupCreate() returns an EventGroupHandle_t variable that can then\r
- * be used as a parameter to other event group functions.\r
- *\r
- * \defgroup EventGroupHandle_t EventGroupHandle_t\r
- * \ingroup EventGroup\r
- */\r
-typedef void * EventGroupHandle_t;\r
-\r
-/*\r
- * The type that holds event bits always matches TickType_t - therefore the\r
- * number of bits it holds is set by configUSE_16_BIT_TICKS (16 bits if set to 1,\r
- * 32 bits if set to 0.\r
- *\r
- * \defgroup EventBits_t EventBits_t\r
- * \ingroup EventGroup\r
- */\r
-typedef TickType_t EventBits_t;\r
-\r
-/**\r
- * event_groups.h\r
- *<pre>\r
- EventGroupHandle_t xEventGroupCreate( void );\r
- </pre>\r
- *\r
- * Create a new event group.\r
- *\r
- * Internally, within the FreeRTOS implementation, event groups use a [small]\r
- * block of memory, in which the event group's structure is stored. If an event\r
- * groups is created using xEventGropuCreate() then the required memory is\r
- * automatically dynamically allocated inside the xEventGroupCreate() function.\r
- * (see http://www.freertos.org/a00111.html). If an event group is created\r
- * using xEventGropuCreateStatic() then the application writer must instead\r
- * provide the memory that will get used by the event group.\r
- * xEventGroupCreateStatic() therefore allows an event group to be created\r
- * without using any dynamic memory allocation.\r
- *\r
- * Although event groups are not related to ticks, for internal implementation\r
- * reasons the number of bits available for use in an event group is dependent\r
- * on the configUSE_16_BIT_TICKS setting in FreeRTOSConfig.h. If\r
- * configUSE_16_BIT_TICKS is 1 then each event group contains 8 usable bits (bit\r
- * 0 to bit 7). If configUSE_16_BIT_TICKS is set to 0 then each event group has\r
- * 24 usable bits (bit 0 to bit 23). The EventBits_t type is used to store\r
- * event bits within an event group.\r
- *\r
- * @return If the event group was created then a handle to the event group is\r
- * returned. If there was insufficient FreeRTOS heap available to create the\r
- * event group then NULL is returned. See http://www.freertos.org/a00111.html\r
- *\r
- * Example usage:\r
- <pre>\r
- // Declare a variable to hold the created event group.\r
- EventGroupHandle_t xCreatedEventGroup;\r
-\r
- // Attempt to create the event group.\r
- xCreatedEventGroup = xEventGroupCreate();\r
-\r
- // Was the event group created successfully?\r
- if( xCreatedEventGroup == NULL )\r
- {\r
- // The event group was not created because there was insufficient\r
- // FreeRTOS heap available.\r
- }\r
- else\r
- {\r
- // The event group was created.\r
- }\r
- </pre>\r
- * \defgroup xEventGroupCreate xEventGroupCreate\r
- * \ingroup EventGroup\r
- */\r
-#if( configSUPPORT_DYNAMIC_ALLOCATION == 1 )\r
- EventGroupHandle_t xEventGroupCreate( void ) PRIVILEGED_FUNCTION;\r
-#endif\r
-\r
-/**\r
- * event_groups.h\r
- *<pre>\r
- EventGroupHandle_t xEventGroupCreateStatic( EventGroupHandle_t * pxEventGroupBuffer );\r
- </pre>\r
- *\r
- * Create a new event group.\r
- *\r
- * Internally, within the FreeRTOS implementation, event groups use a [small]\r
- * block of memory, in which the event group's structure is stored. If an event\r
- * groups is created using xEventGropuCreate() then the required memory is\r
- * automatically dynamically allocated inside the xEventGroupCreate() function.\r
- * (see http://www.freertos.org/a00111.html). If an event group is created\r
- * using xEventGropuCreateStatic() then the application writer must instead\r
- * provide the memory that will get used by the event group.\r
- * xEventGroupCreateStatic() therefore allows an event group to be created\r
- * without using any dynamic memory allocation.\r
- *\r
- * Although event groups are not related to ticks, for internal implementation\r
- * reasons the number of bits available for use in an event group is dependent\r
- * on the configUSE_16_BIT_TICKS setting in FreeRTOSConfig.h. If\r
- * configUSE_16_BIT_TICKS is 1 then each event group contains 8 usable bits (bit\r
- * 0 to bit 7). If configUSE_16_BIT_TICKS is set to 0 then each event group has\r
- * 24 usable bits (bit 0 to bit 23). The EventBits_t type is used to store\r
- * event bits within an event group.\r
- *\r
- * @param pxEventGroupBuffer pxEventGroupBuffer must point to a variable of type\r
- * StaticEventGroup_t, which will be then be used to hold the event group's data\r
- * structures, removing the need for the memory to be allocated dynamically.\r
- *\r
- * @return If the event group was created then a handle to the event group is\r
- * returned. If pxEventGroupBuffer was NULL then NULL is returned.\r
- *\r
- * Example usage:\r
- <pre>\r
- // StaticEventGroup_t is a publicly accessible structure that has the same\r
- // size and alignment requirements as the real event group structure. It is\r
- // provided as a mechanism for applications to know the size of the event\r
- // group (which is dependent on the architecture and configuration file\r
- // settings) without breaking the strict data hiding policy by exposing the\r
- // real event group internals. This StaticEventGroup_t variable is passed\r
- // into the xSemaphoreCreateEventGroupStatic() function and is used to store\r
- // the event group's data structures\r
- StaticEventGroup_t xEventGroupBuffer;\r
-\r
- // Create the event group without dynamically allocating any memory.\r
- xEventGroup = xEventGroupCreateStatic( &xEventGroupBuffer );\r
- </pre>\r
- */\r
-#if( configSUPPORT_STATIC_ALLOCATION == 1 )\r
- EventGroupHandle_t xEventGroupCreateStatic( StaticEventGroup_t *pxEventGroupBuffer ) PRIVILEGED_FUNCTION;\r
-#endif\r
-\r
-/**\r
- * event_groups.h\r
- *<pre>\r
- EventBits_t xEventGroupWaitBits( EventGroupHandle_t xEventGroup,\r
- const EventBits_t uxBitsToWaitFor,\r
- const BaseType_t xClearOnExit,\r
- const BaseType_t xWaitForAllBits,\r
- const TickType_t xTicksToWait );\r
- </pre>\r
- *\r
- * [Potentially] block to wait for one or more bits to be set within a\r
- * previously created event group.\r
- *\r
- * This function cannot be called from an interrupt.\r
- *\r
- * @param xEventGroup The event group in which the bits are being tested. The\r
- * event group must have previously been created using a call to\r
- * xEventGroupCreate().\r
- *\r
- * @param uxBitsToWaitFor A bitwise value that indicates the bit or bits to test\r
- * inside the event group. For example, to wait for bit 0 and/or bit 2 set\r
- * uxBitsToWaitFor to 0x05. To wait for bits 0 and/or bit 1 and/or bit 2 set\r
- * uxBitsToWaitFor to 0x07. Etc.\r
- *\r
- * @param xClearOnExit If xClearOnExit is set to pdTRUE then any bits within\r
- * uxBitsToWaitFor that are set within the event group will be cleared before\r
- * xEventGroupWaitBits() returns if the wait condition was met (if the function\r
- * returns for a reason other than a timeout). If xClearOnExit is set to\r
- * pdFALSE then the bits set in the event group are not altered when the call to\r
- * xEventGroupWaitBits() returns.\r
- *\r
- * @param xWaitForAllBits If xWaitForAllBits is set to pdTRUE then\r
- * xEventGroupWaitBits() will return when either all the bits in uxBitsToWaitFor\r
- * are set or the specified block time expires. If xWaitForAllBits is set to\r
- * pdFALSE then xEventGroupWaitBits() will return when any one of the bits set\r
- * in uxBitsToWaitFor is set or the specified block time expires. The block\r
- * time is specified by the xTicksToWait parameter.\r
- *\r
- * @param xTicksToWait The maximum amount of time (specified in 'ticks') to wait\r
- * for one/all (depending on the xWaitForAllBits value) of the bits specified by\r
- * uxBitsToWaitFor to become set.\r
- *\r
- * @return The value of the event group at the time either the bits being waited\r
- * for became set, or the block time expired. Test the return value to know\r
- * which bits were set. If xEventGroupWaitBits() returned because its timeout\r
- * expired then not all the bits being waited for will be set. If\r
- * xEventGroupWaitBits() returned because the bits it was waiting for were set\r
- * then the returned value is the event group value before any bits were\r
- * automatically cleared in the case that xClearOnExit parameter was set to\r
- * pdTRUE.\r
- *\r
- * Example usage:\r
- <pre>\r
- #define BIT_0 ( 1 << 0 )\r
- #define BIT_4 ( 1 << 4 )\r
-\r
- void aFunction( EventGroupHandle_t xEventGroup )\r
- {\r
- EventBits_t uxBits;\r
- const TickType_t xTicksToWait = 100 / portTICK_PERIOD_MS;\r
-\r
- // Wait a maximum of 100ms for either bit 0 or bit 4 to be set within\r
- // the event group. Clear the bits before exiting.\r
- uxBits = xEventGroupWaitBits(\r
- xEventGroup, // The event group being tested.\r
- BIT_0 | BIT_4, // The bits within the event group to wait for.\r
- pdTRUE, // BIT_0 and BIT_4 should be cleared before returning.\r
- pdFALSE, // Don't wait for both bits, either bit will do.\r
- xTicksToWait ); // Wait a maximum of 100ms for either bit to be set.\r
-\r
- if( ( uxBits & ( BIT_0 | BIT_4 ) ) == ( BIT_0 | BIT_4 ) )\r
- {\r
- // xEventGroupWaitBits() returned because both bits were set.\r
- }\r
- else if( ( uxBits & BIT_0 ) != 0 )\r
- {\r
- // xEventGroupWaitBits() returned because just BIT_0 was set.\r
- }\r
- else if( ( uxBits & BIT_4 ) != 0 )\r
- {\r
- // xEventGroupWaitBits() returned because just BIT_4 was set.\r
- }\r
- else\r
- {\r
- // xEventGroupWaitBits() returned because xTicksToWait ticks passed\r
- // without either BIT_0 or BIT_4 becoming set.\r
- }\r
- }\r
- </pre>\r
- * \defgroup xEventGroupWaitBits xEventGroupWaitBits\r
- * \ingroup EventGroup\r
- */\r
-EventBits_t xEventGroupWaitBits( EventGroupHandle_t xEventGroup, const EventBits_t uxBitsToWaitFor, const BaseType_t xClearOnExit, const BaseType_t xWaitForAllBits, TickType_t xTicksToWait ) PRIVILEGED_FUNCTION;\r
-\r
-/**\r
- * event_groups.h\r
- *<pre>\r
- EventBits_t xEventGroupClearBits( EventGroupHandle_t xEventGroup, const EventBits_t uxBitsToClear );\r
- </pre>\r
- *\r
- * Clear bits within an event group. This function cannot be called from an\r
- * interrupt.\r
- *\r
- * @param xEventGroup The event group in which the bits are to be cleared.\r
- *\r
- * @param uxBitsToClear A bitwise value that indicates the bit or bits to clear\r
- * in the event group. For example, to clear bit 3 only, set uxBitsToClear to\r
- * 0x08. To clear bit 3 and bit 0 set uxBitsToClear to 0x09.\r
- *\r
- * @return The value of the event group before the specified bits were cleared.\r
- *\r
- * Example usage:\r
- <pre>\r
- #define BIT_0 ( 1 << 0 )\r
- #define BIT_4 ( 1 << 4 )\r
-\r
- void aFunction( EventGroupHandle_t xEventGroup )\r
- {\r
- EventBits_t uxBits;\r
-\r
- // Clear bit 0 and bit 4 in xEventGroup.\r
- uxBits = xEventGroupClearBits(\r
- xEventGroup, // The event group being updated.\r
- BIT_0 | BIT_4 );// The bits being cleared.\r
-\r
- if( ( uxBits & ( BIT_0 | BIT_4 ) ) == ( BIT_0 | BIT_4 ) )\r
- {\r
- // Both bit 0 and bit 4 were set before xEventGroupClearBits() was\r
- // called. Both will now be clear (not set).\r
- }\r
- else if( ( uxBits & BIT_0 ) != 0 )\r
- {\r
- // Bit 0 was set before xEventGroupClearBits() was called. It will\r
- // now be clear.\r
- }\r
- else if( ( uxBits & BIT_4 ) != 0 )\r
- {\r
- // Bit 4 was set before xEventGroupClearBits() was called. It will\r
- // now be clear.\r
- }\r
- else\r
- {\r
- // Neither bit 0 nor bit 4 were set in the first place.\r
- }\r
- }\r
- </pre>\r
- * \defgroup xEventGroupClearBits xEventGroupClearBits\r
- * \ingroup EventGroup\r
- */\r
-EventBits_t xEventGroupClearBits( EventGroupHandle_t xEventGroup, const EventBits_t uxBitsToClear ) PRIVILEGED_FUNCTION;\r
-\r
-/**\r
- * event_groups.h\r
- *<pre>\r
- BaseType_t xEventGroupClearBitsFromISR( EventGroupHandle_t xEventGroup, const EventBits_t uxBitsToSet );\r
- </pre>\r
- *\r
- * A version of xEventGroupClearBits() that can be called from an interrupt.\r
- *\r
- * Setting bits in an event group is not a deterministic operation because there\r
- * are an unknown number of tasks that may be waiting for the bit or bits being\r
- * set. FreeRTOS does not allow nondeterministic operations to be performed\r
- * while interrupts are disabled, so protects event groups that are accessed\r
- * from tasks by suspending the scheduler rather than disabling interrupts. As\r
- * a result event groups cannot be accessed directly from an interrupt service\r
- * routine. Therefore xEventGroupClearBitsFromISR() sends a message to the\r
- * timer task to have the clear operation performed in the context of the timer\r
- * task.\r
- *\r
- * @param xEventGroup The event group in which the bits are to be cleared.\r
- *\r
- * @param uxBitsToClear A bitwise value that indicates the bit or bits to clear.\r
- * For example, to clear bit 3 only, set uxBitsToClear to 0x08. To clear bit 3\r
- * and bit 0 set uxBitsToClear to 0x09.\r
- *\r
- * @return If the request to execute the function was posted successfully then\r
- * pdPASS is returned, otherwise pdFALSE is returned. pdFALSE will be returned\r
- * if the timer service queue was full.\r
- *\r
- * Example usage:\r
- <pre>\r
- #define BIT_0 ( 1 << 0 )\r
- #define BIT_4 ( 1 << 4 )\r
-\r
- // An event group which it is assumed has already been created by a call to\r
- // xEventGroupCreate().\r
- EventGroupHandle_t xEventGroup;\r
-\r
- void anInterruptHandler( void )\r
- {\r
- // Clear bit 0 and bit 4 in xEventGroup.\r
- xResult = xEventGroupClearBitsFromISR(\r
- xEventGroup, // The event group being updated.\r
- BIT_0 | BIT_4 ); // The bits being set.\r
-\r
- if( xResult == pdPASS )\r
- {\r
- // The message was posted successfully.\r
- }\r
- }\r
- </pre>\r
- * \defgroup xEventGroupClearBitsFromISR xEventGroupClearBitsFromISR\r
- * \ingroup EventGroup\r
- */\r
-#if( configUSE_TRACE_FACILITY == 1 )\r
- BaseType_t xEventGroupClearBitsFromISR( EventGroupHandle_t xEventGroup, const EventBits_t uxBitsToSet ) PRIVILEGED_FUNCTION;\r
-#else\r
- #define xEventGroupClearBitsFromISR( xEventGroup, uxBitsToClear ) xTimerPendFunctionCallFromISR( vEventGroupClearBitsCallback, ( void * ) xEventGroup, ( uint32_t ) uxBitsToClear, NULL )\r
-#endif\r
-\r
-/**\r
- * event_groups.h\r
- *<pre>\r
- EventBits_t xEventGroupSetBits( EventGroupHandle_t xEventGroup, const EventBits_t uxBitsToSet );\r
- </pre>\r
- *\r
- * Set bits within an event group.\r
- * This function cannot be called from an interrupt. xEventGroupSetBitsFromISR()\r
- * is a version that can be called from an interrupt.\r
- *\r
- * Setting bits in an event group will automatically unblock tasks that are\r
- * blocked waiting for the bits.\r
- *\r
- * @param xEventGroup The event group in which the bits are to be set.\r
- *\r
- * @param uxBitsToSet A bitwise value that indicates the bit or bits to set.\r
- * For example, to set bit 3 only, set uxBitsToSet to 0x08. To set bit 3\r
- * and bit 0 set uxBitsToSet to 0x09.\r
- *\r
- * @return The value of the event group at the time the call to\r
- * xEventGroupSetBits() returns. There are two reasons why the returned value\r
- * might have the bits specified by the uxBitsToSet parameter cleared. First,\r
- * if setting a bit results in a task that was waiting for the bit leaving the\r
- * blocked state then it is possible the bit will be cleared automatically\r
- * (see the xClearBitOnExit parameter of xEventGroupWaitBits()). Second, any\r
- * unblocked (or otherwise Ready state) task that has a priority above that of\r
- * the task that called xEventGroupSetBits() will execute and may change the\r
- * event group value before the call to xEventGroupSetBits() returns.\r
- *\r
- * Example usage:\r
- <pre>\r
- #define BIT_0 ( 1 << 0 )\r
- #define BIT_4 ( 1 << 4 )\r
-\r
- void aFunction( EventGroupHandle_t xEventGroup )\r
- {\r
- EventBits_t uxBits;\r
-\r
- // Set bit 0 and bit 4 in xEventGroup.\r
- uxBits = xEventGroupSetBits(\r
- xEventGroup, // The event group being updated.\r
- BIT_0 | BIT_4 );// The bits being set.\r
-\r
- if( ( uxBits & ( BIT_0 | BIT_4 ) ) == ( BIT_0 | BIT_4 ) )\r
- {\r
- // Both bit 0 and bit 4 remained set when the function returned.\r
- }\r
- else if( ( uxBits & BIT_0 ) != 0 )\r
- {\r
- // Bit 0 remained set when the function returned, but bit 4 was\r
- // cleared. It might be that bit 4 was cleared automatically as a\r
- // task that was waiting for bit 4 was removed from the Blocked\r
- // state.\r
- }\r
- else if( ( uxBits & BIT_4 ) != 0 )\r
- {\r
- // Bit 4 remained set when the function returned, but bit 0 was\r
- // cleared. It might be that bit 0 was cleared automatically as a\r
- // task that was waiting for bit 0 was removed from the Blocked\r
- // state.\r
- }\r
- else\r
- {\r
- // Neither bit 0 nor bit 4 remained set. It might be that a task\r
- // was waiting for both of the bits to be set, and the bits were\r
- // cleared as the task left the Blocked state.\r
- }\r
- }\r
- </pre>\r
- * \defgroup xEventGroupSetBits xEventGroupSetBits\r
- * \ingroup EventGroup\r
- */\r
-EventBits_t xEventGroupSetBits( EventGroupHandle_t xEventGroup, const EventBits_t uxBitsToSet ) PRIVILEGED_FUNCTION;\r
-\r
-/**\r
- * event_groups.h\r
- *<pre>\r
- BaseType_t xEventGroupSetBitsFromISR( EventGroupHandle_t xEventGroup, const EventBits_t uxBitsToSet, BaseType_t *pxHigherPriorityTaskWoken );\r
- </pre>\r
- *\r
- * A version of xEventGroupSetBits() that can be called from an interrupt.\r
- *\r
- * Setting bits in an event group is not a deterministic operation because there\r
- * are an unknown number of tasks that may be waiting for the bit or bits being\r
- * set. FreeRTOS does not allow nondeterministic operations to be performed in\r
- * interrupts or from critical sections. Therefore xEventGroupSetBitsFromISR()\r
- * sends a message to the timer task to have the set operation performed in the\r
- * context of the timer task - where a scheduler lock is used in place of a\r
- * critical section.\r
- *\r
- * @param xEventGroup The event group in which the bits are to be set.\r
- *\r
- * @param uxBitsToSet A bitwise value that indicates the bit or bits to set.\r
- * For example, to set bit 3 only, set uxBitsToSet to 0x08. To set bit 3\r
- * and bit 0 set uxBitsToSet to 0x09.\r
- *\r
- * @param pxHigherPriorityTaskWoken As mentioned above, calling this function\r
- * will result in a message being sent to the timer daemon task. If the\r
- * priority of the timer daemon task is higher than the priority of the\r
- * currently running task (the task the interrupt interrupted) then\r
- * *pxHigherPriorityTaskWoken will be set to pdTRUE by\r
- * xEventGroupSetBitsFromISR(), indicating that a context switch should be\r
- * requested before the interrupt exits. For that reason\r
- * *pxHigherPriorityTaskWoken must be initialised to pdFALSE. See the\r
- * example code below.\r
- *\r
- * @return If the request to execute the function was posted successfully then\r
- * pdPASS is returned, otherwise pdFALSE is returned. pdFALSE will be returned\r
- * if the timer service queue was full.\r
- *\r
- * Example usage:\r
- <pre>\r
- #define BIT_0 ( 1 << 0 )\r
- #define BIT_4 ( 1 << 4 )\r
-\r
- // An event group which it is assumed has already been created by a call to\r
- // xEventGroupCreate().\r
- EventGroupHandle_t xEventGroup;\r
-\r
- void anInterruptHandler( void )\r
- {\r
- BaseType_t xHigherPriorityTaskWoken, xResult;\r
-\r
- // xHigherPriorityTaskWoken must be initialised to pdFALSE.\r
- xHigherPriorityTaskWoken = pdFALSE;\r
-\r
- // Set bit 0 and bit 4 in xEventGroup.\r
- xResult = xEventGroupSetBitsFromISR(\r
- xEventGroup, // The event group being updated.\r
- BIT_0 | BIT_4 // The bits being set.\r
- &xHigherPriorityTaskWoken );\r
-\r
- // Was the message posted successfully?\r
- if( xResult == pdPASS )\r
- {\r
- // If xHigherPriorityTaskWoken is now set to pdTRUE then a context\r
- // switch should be requested. The macro used is port specific and\r
- // will be either portYIELD_FROM_ISR() or portEND_SWITCHING_ISR() -\r
- // refer to the documentation page for the port being used.\r
- portYIELD_FROM_ISR( xHigherPriorityTaskWoken );\r
- }\r
- }\r
- </pre>\r
- * \defgroup xEventGroupSetBitsFromISR xEventGroupSetBitsFromISR\r
- * \ingroup EventGroup\r
- */\r
-#if( configUSE_TRACE_FACILITY == 1 )\r
- BaseType_t xEventGroupSetBitsFromISR( EventGroupHandle_t xEventGroup, const EventBits_t uxBitsToSet, BaseType_t *pxHigherPriorityTaskWoken ) PRIVILEGED_FUNCTION;\r
-#else\r
- #define xEventGroupSetBitsFromISR( xEventGroup, uxBitsToSet, pxHigherPriorityTaskWoken ) xTimerPendFunctionCallFromISR( vEventGroupSetBitsCallback, ( void * ) xEventGroup, ( uint32_t ) uxBitsToSet, pxHigherPriorityTaskWoken )\r
-#endif\r
-\r
-/**\r
- * event_groups.h\r
- *<pre>\r
- EventBits_t xEventGroupSync( EventGroupHandle_t xEventGroup,\r
- const EventBits_t uxBitsToSet,\r
- const EventBits_t uxBitsToWaitFor,\r
- TickType_t xTicksToWait );\r
- </pre>\r
- *\r
- * Atomically set bits within an event group, then wait for a combination of\r
- * bits to be set within the same event group. This functionality is typically\r
- * used to synchronise multiple tasks, where each task has to wait for the other\r
- * tasks to reach a synchronisation point before proceeding.\r
- *\r
- * This function cannot be used from an interrupt.\r
- *\r
- * The function will return before its block time expires if the bits specified\r
- * by the uxBitsToWait parameter are set, or become set within that time. In\r
- * this case all the bits specified by uxBitsToWait will be automatically\r
- * cleared before the function returns.\r
- *\r
- * @param xEventGroup The event group in which the bits are being tested. The\r
- * event group must have previously been created using a call to\r
- * xEventGroupCreate().\r
- *\r
- * @param uxBitsToSet The bits to set in the event group before determining\r
- * if, and possibly waiting for, all the bits specified by the uxBitsToWait\r
- * parameter are set.\r
- *\r
- * @param uxBitsToWaitFor A bitwise value that indicates the bit or bits to test\r
- * inside the event group. For example, to wait for bit 0 and bit 2 set\r
- * uxBitsToWaitFor to 0x05. To wait for bits 0 and bit 1 and bit 2 set\r
- * uxBitsToWaitFor to 0x07. Etc.\r
- *\r
- * @param xTicksToWait The maximum amount of time (specified in 'ticks') to wait\r
- * for all of the bits specified by uxBitsToWaitFor to become set.\r
- *\r
- * @return The value of the event group at the time either the bits being waited\r
- * for became set, or the block time expired. Test the return value to know\r
- * which bits were set. If xEventGroupSync() returned because its timeout\r
- * expired then not all the bits being waited for will be set. If\r
- * xEventGroupSync() returned because all the bits it was waiting for were\r
- * set then the returned value is the event group value before any bits were\r
- * automatically cleared.\r
- *\r
- * Example usage:\r
- <pre>\r
- // Bits used by the three tasks.\r
- #define TASK_0_BIT ( 1 << 0 )\r
- #define TASK_1_BIT ( 1 << 1 )\r
- #define TASK_2_BIT ( 1 << 2 )\r
-\r
- #define ALL_SYNC_BITS ( TASK_0_BIT | TASK_1_BIT | TASK_2_BIT )\r
-\r
- // Use an event group to synchronise three tasks. It is assumed this event\r
- // group has already been created elsewhere.\r
- EventGroupHandle_t xEventBits;\r
-\r
- void vTask0( void *pvParameters )\r
- {\r
- EventBits_t uxReturn;\r
- TickType_t xTicksToWait = 100 / portTICK_PERIOD_MS;\r
-\r
- for( ;; )\r
- {\r
- // Perform task functionality here.\r
-\r
- // Set bit 0 in the event flag to note this task has reached the\r
- // sync point. The other two tasks will set the other two bits defined\r
- // by ALL_SYNC_BITS. All three tasks have reached the synchronisation\r
- // point when all the ALL_SYNC_BITS are set. Wait a maximum of 100ms\r
- // for this to happen.\r
- uxReturn = xEventGroupSync( xEventBits, TASK_0_BIT, ALL_SYNC_BITS, xTicksToWait );\r
-\r
- if( ( uxReturn & ALL_SYNC_BITS ) == ALL_SYNC_BITS )\r
- {\r
- // All three tasks reached the synchronisation point before the call\r
- // to xEventGroupSync() timed out.\r
- }\r
- }\r
- }\r
-\r
- void vTask1( void *pvParameters )\r
- {\r
- for( ;; )\r
- {\r
- // Perform task functionality here.\r
-\r
- // Set bit 1 in the event flag to note this task has reached the\r
- // synchronisation point. The other two tasks will set the other two\r
- // bits defined by ALL_SYNC_BITS. All three tasks have reached the\r
- // synchronisation point when all the ALL_SYNC_BITS are set. Wait\r
- // indefinitely for this to happen.\r
- xEventGroupSync( xEventBits, TASK_1_BIT, ALL_SYNC_BITS, portMAX_DELAY );\r
-\r
- // xEventGroupSync() was called with an indefinite block time, so\r
- // this task will only reach here if the syncrhonisation was made by all\r
- // three tasks, so there is no need to test the return value.\r
- }\r
- }\r
-\r
- void vTask2( void *pvParameters )\r
- {\r
- for( ;; )\r
- {\r
- // Perform task functionality here.\r
-\r
- // Set bit 2 in the event flag to note this task has reached the\r
- // synchronisation point. The other two tasks will set the other two\r
- // bits defined by ALL_SYNC_BITS. All three tasks have reached the\r
- // synchronisation point when all the ALL_SYNC_BITS are set. Wait\r
- // indefinitely for this to happen.\r
- xEventGroupSync( xEventBits, TASK_2_BIT, ALL_SYNC_BITS, portMAX_DELAY );\r
-\r
- // xEventGroupSync() was called with an indefinite block time, so\r
- // this task will only reach here if the syncrhonisation was made by all\r
- // three tasks, so there is no need to test the return value.\r
- }\r
- }\r
-\r
- </pre>\r
- * \defgroup xEventGroupSync xEventGroupSync\r
- * \ingroup EventGroup\r
- */\r
-EventBits_t xEventGroupSync( EventGroupHandle_t xEventGroup, const EventBits_t uxBitsToSet, const EventBits_t uxBitsToWaitFor, TickType_t xTicksToWait ) PRIVILEGED_FUNCTION;\r
-\r
-\r
-/**\r
- * event_groups.h\r
- *<pre>\r
- EventBits_t xEventGroupGetBits( EventGroupHandle_t xEventGroup );\r
- </pre>\r
- *\r
- * Returns the current value of the bits in an event group. This function\r
- * cannot be used from an interrupt.\r
- *\r
- * @param xEventGroup The event group being queried.\r
- *\r
- * @return The event group bits at the time xEventGroupGetBits() was called.\r
- *\r
- * \defgroup xEventGroupGetBits xEventGroupGetBits\r
- * \ingroup EventGroup\r
- */\r
-#define xEventGroupGetBits( xEventGroup ) xEventGroupClearBits( xEventGroup, 0 )\r
-\r
-/**\r
- * event_groups.h\r
- *<pre>\r
- EventBits_t xEventGroupGetBitsFromISR( EventGroupHandle_t xEventGroup );\r
- </pre>\r
- *\r
- * A version of xEventGroupGetBits() that can be called from an ISR.\r
- *\r
- * @param xEventGroup The event group being queried.\r
- *\r
- * @return The event group bits at the time xEventGroupGetBitsFromISR() was called.\r
- *\r
- * \defgroup xEventGroupGetBitsFromISR xEventGroupGetBitsFromISR\r
- * \ingroup EventGroup\r
- */\r
-EventBits_t xEventGroupGetBitsFromISR( EventGroupHandle_t xEventGroup ) PRIVILEGED_FUNCTION;\r
-\r
-/**\r
- * event_groups.h\r
- *<pre>\r
- void xEventGroupDelete( EventGroupHandle_t xEventGroup );\r
- </pre>\r
- *\r
- * Delete an event group that was previously created by a call to\r
- * xEventGroupCreate(). Tasks that are blocked on the event group will be\r
- * unblocked and obtain 0 as the event group's value.\r
- *\r
- * @param xEventGroup The event group being deleted.\r
- */\r
-void vEventGroupDelete( EventGroupHandle_t xEventGroup ) PRIVILEGED_FUNCTION;\r
-\r
-/* For internal use only. */\r
-void vEventGroupSetBitsCallback( void *pvEventGroup, const uint32_t ulBitsToSet ) PRIVILEGED_FUNCTION;\r
-void vEventGroupClearBitsCallback( void *pvEventGroup, const uint32_t ulBitsToClear ) PRIVILEGED_FUNCTION;\r
-\r
-\r
-#if (configUSE_TRACE_FACILITY == 1)\r
- UBaseType_t uxEventGroupGetNumber( void* xEventGroup ) PRIVILEGED_FUNCTION;\r
- void vEventGroupSetNumber( void* xEventGroup, UBaseType_t uxEventGroupNumber ) PRIVILEGED_FUNCTION;\r
-#endif\r
-\r
-#ifdef __cplusplus\r
-}\r
-#endif\r
-\r
-#endif /* EVENT_GROUPS_H */\r
-\r
-\r
+++ /dev/null
-/*\r
- * FreeRTOS Kernel V10.0.1\r
- * Copyright (C) 2017 Amazon.com, Inc. or its affiliates. All Rights Reserved.\r
- *\r
- * Permission is hereby granted, free of charge, to any person obtaining a copy of\r
- * this software and associated documentation files (the "Software"), to deal in\r
- * the Software without restriction, including without limitation the rights to\r
- * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of\r
- * the Software, and to permit persons to whom the Software is furnished to do so,\r
- * subject to the following conditions:\r
- *\r
- * The above copyright notice and this permission notice shall be included in all\r
- * copies or substantial portions of the Software.\r
- *\r
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\r
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS\r
- * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR\r
- * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER\r
- * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN\r
- * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\r
- *\r
- * http://www.FreeRTOS.org\r
- * http://aws.amazon.com/freertos\r
- *\r
- * 1 tab == 4 spaces!\r
- */\r
-\r
-/*\r
- * This is the list implementation used by the scheduler. While it is tailored\r
- * heavily for the schedulers needs, it is also available for use by\r
- * application code.\r
- *\r
- * list_ts can only store pointers to list_item_ts. Each ListItem_t contains a\r
- * numeric value (xItemValue). Most of the time the lists are sorted in\r
- * descending item value order.\r
- *\r
- * Lists are created already containing one list item. The value of this\r
- * item is the maximum possible that can be stored, it is therefore always at\r
- * the end of the list and acts as a marker. The list member pxHead always\r
- * points to this marker - even though it is at the tail of the list. This\r
- * is because the tail contains a wrap back pointer to the true head of\r
- * the list.\r
- *\r
- * In addition to it's value, each list item contains a pointer to the next\r
- * item in the list (pxNext), a pointer to the list it is in (pxContainer)\r
- * and a pointer to back to the object that contains it. These later two\r
- * pointers are included for efficiency of list manipulation. There is\r
- * effectively a two way link between the object containing the list item and\r
- * the list item itself.\r
- *\r
- *\r
- * \page ListIntroduction List Implementation\r
- * \ingroup FreeRTOSIntro\r
- */\r
-\r
-#ifndef INC_FREERTOS_H\r
- #error FreeRTOS.h must be included before list.h\r
-#endif\r
-\r
-#ifndef LIST_H\r
-#define LIST_H\r
-\r
-/*\r
- * The list structure members are modified from within interrupts, and therefore\r
- * by rights should be declared volatile. However, they are only modified in a\r
- * functionally atomic way (within critical sections of with the scheduler\r
- * suspended) and are either passed by reference into a function or indexed via\r
- * a volatile variable. Therefore, in all use cases tested so far, the volatile\r
- * qualifier can be omitted in order to provide a moderate performance\r
- * improvement without adversely affecting functional behaviour. The assembly\r
- * instructions generated by the IAR, ARM and GCC compilers when the respective\r
- * compiler's options were set for maximum optimisation has been inspected and\r
- * deemed to be as intended. That said, as compiler technology advances, and\r
- * especially if aggressive cross module optimisation is used (a use case that\r
- * has not been exercised to any great extend) then it is feasible that the\r
- * volatile qualifier will be needed for correct optimisation. It is expected\r
- * that a compiler removing essential code because, without the volatile\r
- * qualifier on the list structure members and with aggressive cross module\r
- * optimisation, the compiler deemed the code unnecessary will result in\r
- * complete and obvious failure of the scheduler. If this is ever experienced\r
- * then the volatile qualifier can be inserted in the relevant places within the\r
- * list structures by simply defining configLIST_VOLATILE to volatile in\r
- * FreeRTOSConfig.h (as per the example at the bottom of this comment block).\r
- * If configLIST_VOLATILE is not defined then the preprocessor directives below\r
- * will simply #define configLIST_VOLATILE away completely.\r
- *\r
- * To use volatile list structure members then add the following line to\r
- * FreeRTOSConfig.h (without the quotes):\r
- * "#define configLIST_VOLATILE volatile"\r
- */\r
-#ifndef configLIST_VOLATILE\r
- #define configLIST_VOLATILE\r
-#endif /* configSUPPORT_CROSS_MODULE_OPTIMISATION */\r
-\r
-#ifdef __cplusplus\r
-extern "C" {\r
-#endif\r
-\r
-/* Macros that can be used to place known values within the list structures,\r
-then check that the known values do not get corrupted during the execution of\r
-the application. These may catch the list data structures being overwritten in\r
-memory. They will not catch data errors caused by incorrect configuration or\r
-use of FreeRTOS.*/\r
-#if( configUSE_LIST_DATA_INTEGRITY_CHECK_BYTES == 0 )\r
- /* Define the macros to do nothing. */\r
- #define listFIRST_LIST_ITEM_INTEGRITY_CHECK_VALUE\r
- #define listSECOND_LIST_ITEM_INTEGRITY_CHECK_VALUE\r
- #define listFIRST_LIST_INTEGRITY_CHECK_VALUE\r
- #define listSECOND_LIST_INTEGRITY_CHECK_VALUE\r
- #define listSET_FIRST_LIST_ITEM_INTEGRITY_CHECK_VALUE( pxItem )\r
- #define listSET_SECOND_LIST_ITEM_INTEGRITY_CHECK_VALUE( pxItem )\r
- #define listSET_LIST_INTEGRITY_CHECK_1_VALUE( pxList )\r
- #define listSET_LIST_INTEGRITY_CHECK_2_VALUE( pxList )\r
- #define listTEST_LIST_ITEM_INTEGRITY( pxItem )\r
- #define listTEST_LIST_INTEGRITY( pxList )\r
-#else\r
- /* Define macros that add new members into the list structures. */\r
- #define listFIRST_LIST_ITEM_INTEGRITY_CHECK_VALUE TickType_t xListItemIntegrityValue1;\r
- #define listSECOND_LIST_ITEM_INTEGRITY_CHECK_VALUE TickType_t xListItemIntegrityValue2;\r
- #define listFIRST_LIST_INTEGRITY_CHECK_VALUE TickType_t xListIntegrityValue1;\r
- #define listSECOND_LIST_INTEGRITY_CHECK_VALUE TickType_t xListIntegrityValue2;\r
-\r
- /* Define macros that set the new structure members to known values. */\r
- #define listSET_FIRST_LIST_ITEM_INTEGRITY_CHECK_VALUE( pxItem ) ( pxItem )->xListItemIntegrityValue1 = pdINTEGRITY_CHECK_VALUE\r
- #define listSET_SECOND_LIST_ITEM_INTEGRITY_CHECK_VALUE( pxItem ) ( pxItem )->xListItemIntegrityValue2 = pdINTEGRITY_CHECK_VALUE\r
- #define listSET_LIST_INTEGRITY_CHECK_1_VALUE( pxList ) ( pxList )->xListIntegrityValue1 = pdINTEGRITY_CHECK_VALUE\r
- #define listSET_LIST_INTEGRITY_CHECK_2_VALUE( pxList ) ( pxList )->xListIntegrityValue2 = pdINTEGRITY_CHECK_VALUE\r
-\r
- /* Define macros that will assert if one of the structure members does not\r
- contain its expected value. */\r
- #define listTEST_LIST_ITEM_INTEGRITY( pxItem ) configASSERT( ( ( pxItem )->xListItemIntegrityValue1 == pdINTEGRITY_CHECK_VALUE ) && ( ( pxItem )->xListItemIntegrityValue2 == pdINTEGRITY_CHECK_VALUE ) )\r
- #define listTEST_LIST_INTEGRITY( pxList ) configASSERT( ( ( pxList )->xListIntegrityValue1 == pdINTEGRITY_CHECK_VALUE ) && ( ( pxList )->xListIntegrityValue2 == pdINTEGRITY_CHECK_VALUE ) )\r
-#endif /* configUSE_LIST_DATA_INTEGRITY_CHECK_BYTES */\r
-\r
-\r
-/*\r
- * Definition of the only type of object that a list can contain.\r
- */\r
-struct xLIST_ITEM\r
-{\r
- listFIRST_LIST_ITEM_INTEGRITY_CHECK_VALUE /*< Set to a known value if configUSE_LIST_DATA_INTEGRITY_CHECK_BYTES is set to 1. */\r
- configLIST_VOLATILE TickType_t xItemValue; /*< The value being listed. In most cases this is used to sort the list in descending order. */\r
- struct xLIST_ITEM * configLIST_VOLATILE pxNext; /*< Pointer to the next ListItem_t in the list. */\r
- struct xLIST_ITEM * configLIST_VOLATILE pxPrevious; /*< Pointer to the previous ListItem_t in the list. */\r
- void * pvOwner; /*< Pointer to the object (normally a TCB) that contains the list item. There is therefore a two way link between the object containing the list item and the list item itself. */\r
- void * configLIST_VOLATILE pvContainer; /*< Pointer to the list in which this list item is placed (if any). */\r
- listSECOND_LIST_ITEM_INTEGRITY_CHECK_VALUE /*< Set to a known value if configUSE_LIST_DATA_INTEGRITY_CHECK_BYTES is set to 1. */\r
-};\r
-typedef struct xLIST_ITEM ListItem_t; /* For some reason lint wants this as two separate definitions. */\r
-\r
-struct xMINI_LIST_ITEM\r
-{\r
- listFIRST_LIST_ITEM_INTEGRITY_CHECK_VALUE /*< Set to a known value if configUSE_LIST_DATA_INTEGRITY_CHECK_BYTES is set to 1. */\r
- configLIST_VOLATILE TickType_t xItemValue;\r
- struct xLIST_ITEM * configLIST_VOLATILE pxNext;\r
- struct xLIST_ITEM * configLIST_VOLATILE pxPrevious;\r
-};\r
-typedef struct xMINI_LIST_ITEM MiniListItem_t;\r
-\r
-/*\r
- * Definition of the type of queue used by the scheduler.\r
- */\r
-typedef struct xLIST\r
-{\r
- listFIRST_LIST_INTEGRITY_CHECK_VALUE /*< Set to a known value if configUSE_LIST_DATA_INTEGRITY_CHECK_BYTES is set to 1. */\r
- volatile UBaseType_t uxNumberOfItems;\r
- ListItem_t * configLIST_VOLATILE pxIndex; /*< Used to walk through the list. Points to the last item returned by a call to listGET_OWNER_OF_NEXT_ENTRY (). */\r
- MiniListItem_t xListEnd; /*< List item that contains the maximum possible item value meaning it is always at the end of the list and is therefore used as a marker. */\r
- listSECOND_LIST_INTEGRITY_CHECK_VALUE /*< Set to a known value if configUSE_LIST_DATA_INTEGRITY_CHECK_BYTES is set to 1. */\r
-} List_t;\r
-\r
-/*\r
- * Access macro to set the owner of a list item. The owner of a list item\r
- * is the object (usually a TCB) that contains the list item.\r
- *\r
- * \page listSET_LIST_ITEM_OWNER listSET_LIST_ITEM_OWNER\r
- * \ingroup LinkedList\r
- */\r
-#define listSET_LIST_ITEM_OWNER( pxListItem, pxOwner ) ( ( pxListItem )->pvOwner = ( void * ) ( pxOwner ) )\r
-\r
-/*\r
- * Access macro to get the owner of a list item. The owner of a list item\r
- * is the object (usually a TCB) that contains the list item.\r
- *\r
- * \page listSET_LIST_ITEM_OWNER listSET_LIST_ITEM_OWNER\r
- * \ingroup LinkedList\r
- */\r
-#define listGET_LIST_ITEM_OWNER( pxListItem ) ( ( pxListItem )->pvOwner )\r
-\r
-/*\r
- * Access macro to set the value of the list item. In most cases the value is\r
- * used to sort the list in descending order.\r
- *\r
- * \page listSET_LIST_ITEM_VALUE listSET_LIST_ITEM_VALUE\r
- * \ingroup LinkedList\r
- */\r
-#define listSET_LIST_ITEM_VALUE( pxListItem, xValue ) ( ( pxListItem )->xItemValue = ( xValue ) )\r
-\r
-/*\r
- * Access macro to retrieve the value of the list item. The value can\r
- * represent anything - for example the priority of a task, or the time at\r
- * which a task should be unblocked.\r
- *\r
- * \page listGET_LIST_ITEM_VALUE listGET_LIST_ITEM_VALUE\r
- * \ingroup LinkedList\r
- */\r
-#define listGET_LIST_ITEM_VALUE( pxListItem ) ( ( pxListItem )->xItemValue )\r
-\r
-/*\r
- * Access macro to retrieve the value of the list item at the head of a given\r
- * list.\r
- *\r
- * \page listGET_LIST_ITEM_VALUE listGET_LIST_ITEM_VALUE\r
- * \ingroup LinkedList\r
- */\r
-#define listGET_ITEM_VALUE_OF_HEAD_ENTRY( pxList ) ( ( ( pxList )->xListEnd ).pxNext->xItemValue )\r
-\r
-/*\r
- * Return the list item at the head of the list.\r
- *\r
- * \page listGET_HEAD_ENTRY listGET_HEAD_ENTRY\r
- * \ingroup LinkedList\r
- */\r
-#define listGET_HEAD_ENTRY( pxList ) ( ( ( pxList )->xListEnd ).pxNext )\r
-\r
-/*\r
- * Return the list item at the head of the list.\r
- *\r
- * \page listGET_NEXT listGET_NEXT\r
- * \ingroup LinkedList\r
- */\r
-#define listGET_NEXT( pxListItem ) ( ( pxListItem )->pxNext )\r
-\r
-/*\r
- * Return the list item that marks the end of the list\r
- *\r
- * \page listGET_END_MARKER listGET_END_MARKER\r
- * \ingroup LinkedList\r
- */\r
-#define listGET_END_MARKER( pxList ) ( ( ListItem_t const * ) ( &( ( pxList )->xListEnd ) ) )\r
-\r
-/*\r
- * Access macro to determine if a list contains any items. The macro will\r
- * only have the value true if the list is empty.\r
- *\r
- * \page listLIST_IS_EMPTY listLIST_IS_EMPTY\r
- * \ingroup LinkedList\r
- */\r
-#define listLIST_IS_EMPTY( pxList ) ( ( BaseType_t ) ( ( pxList )->uxNumberOfItems == ( UBaseType_t ) 0 ) )\r
-\r
-/*\r
- * Access macro to return the number of items in the list.\r
- */\r
-#define listCURRENT_LIST_LENGTH( pxList ) ( ( pxList )->uxNumberOfItems )\r
-\r
-/*\r
- * Access function to obtain the owner of the next entry in a list.\r
- *\r
- * The list member pxIndex is used to walk through a list. Calling\r
- * listGET_OWNER_OF_NEXT_ENTRY increments pxIndex to the next item in the list\r
- * and returns that entry's pxOwner parameter. Using multiple calls to this\r
- * function it is therefore possible to move through every item contained in\r
- * a list.\r
- *\r
- * The pxOwner parameter of a list item is a pointer to the object that owns\r
- * the list item. In the scheduler this is normally a task control block.\r
- * The pxOwner parameter effectively creates a two way link between the list\r
- * item and its owner.\r
- *\r
- * @param pxTCB pxTCB is set to the address of the owner of the next list item.\r
- * @param pxList The list from which the next item owner is to be returned.\r
- *\r
- * \page listGET_OWNER_OF_NEXT_ENTRY listGET_OWNER_OF_NEXT_ENTRY\r
- * \ingroup LinkedList\r
- */\r
-#define listGET_OWNER_OF_NEXT_ENTRY( pxTCB, pxList ) \\r
-{ \\r
-List_t * const pxConstList = ( pxList ); \\r
- /* Increment the index to the next item and return the item, ensuring */ \\r
- /* we don't return the marker used at the end of the list. */ \\r
- ( pxConstList )->pxIndex = ( pxConstList )->pxIndex->pxNext; \\r
- if( ( void * ) ( pxConstList )->pxIndex == ( void * ) &( ( pxConstList )->xListEnd ) ) \\r
- { \\r
- ( pxConstList )->pxIndex = ( pxConstList )->pxIndex->pxNext; \\r
- } \\r
- ( pxTCB ) = ( pxConstList )->pxIndex->pvOwner; \\r
-}\r
-\r
-\r
-/*\r
- * Access function to obtain the owner of the first entry in a list. Lists\r
- * are normally sorted in ascending item value order.\r
- *\r
- * This function returns the pxOwner member of the first item in the list.\r
- * The pxOwner parameter of a list item is a pointer to the object that owns\r
- * the list item. In the scheduler this is normally a task control block.\r
- * The pxOwner parameter effectively creates a two way link between the list\r
- * item and its owner.\r
- *\r
- * @param pxList The list from which the owner of the head item is to be\r
- * returned.\r
- *\r
- * \page listGET_OWNER_OF_HEAD_ENTRY listGET_OWNER_OF_HEAD_ENTRY\r
- * \ingroup LinkedList\r
- */\r
-#define listGET_OWNER_OF_HEAD_ENTRY( pxList ) ( (&( ( pxList )->xListEnd ))->pxNext->pvOwner )\r
-\r
-/*\r
- * Check to see if a list item is within a list. The list item maintains a\r
- * "container" pointer that points to the list it is in. All this macro does\r
- * is check to see if the container and the list match.\r
- *\r
- * @param pxList The list we want to know if the list item is within.\r
- * @param pxListItem The list item we want to know if is in the list.\r
- * @return pdTRUE if the list item is in the list, otherwise pdFALSE.\r
- */\r
-#define listIS_CONTAINED_WITHIN( pxList, pxListItem ) ( ( BaseType_t ) ( ( pxListItem )->pvContainer == ( void * ) ( pxList ) ) )\r
-\r
-/*\r
- * Return the list a list item is contained within (referenced from).\r
- *\r
- * @param pxListItem The list item being queried.\r
- * @return A pointer to the List_t object that references the pxListItem\r
- */\r
-#define listLIST_ITEM_CONTAINER( pxListItem ) ( ( pxListItem )->pvContainer )\r
-\r
-/*\r
- * This provides a crude means of knowing if a list has been initialised, as\r
- * pxList->xListEnd.xItemValue is set to portMAX_DELAY by the vListInitialise()\r
- * function.\r
- */\r
-#define listLIST_IS_INITIALISED( pxList ) ( ( pxList )->xListEnd.xItemValue == portMAX_DELAY )\r
-\r
-/*\r
- * Must be called before a list is used! This initialises all the members\r
- * of the list structure and inserts the xListEnd item into the list as a\r
- * marker to the back of the list.\r
- *\r
- * @param pxList Pointer to the list being initialised.\r
- *\r
- * \page vListInitialise vListInitialise\r
- * \ingroup LinkedList\r
- */\r
-void vListInitialise( List_t * const pxList ) PRIVILEGED_FUNCTION;\r
-\r
-/*\r
- * Must be called before a list item is used. This sets the list container to\r
- * null so the item does not think that it is already contained in a list.\r
- *\r
- * @param pxItem Pointer to the list item being initialised.\r
- *\r
- * \page vListInitialiseItem vListInitialiseItem\r
- * \ingroup LinkedList\r
- */\r
-void vListInitialiseItem( ListItem_t * const pxItem ) PRIVILEGED_FUNCTION;\r
-\r
-/*\r
- * Insert a list item into a list. The item will be inserted into the list in\r
- * a position determined by its item value (descending item value order).\r
- *\r
- * @param pxList The list into which the item is to be inserted.\r
- *\r
- * @param pxNewListItem The item that is to be placed in the list.\r
- *\r
- * \page vListInsert vListInsert\r
- * \ingroup LinkedList\r
- */\r
-void vListInsert( List_t * const pxList, ListItem_t * const pxNewListItem ) PRIVILEGED_FUNCTION;\r
-\r
-/*\r
- * Insert a list item into a list. The item will be inserted in a position\r
- * such that it will be the last item within the list returned by multiple\r
- * calls to listGET_OWNER_OF_NEXT_ENTRY.\r
- *\r
- * The list member pxIndex is used to walk through a list. Calling\r
- * listGET_OWNER_OF_NEXT_ENTRY increments pxIndex to the next item in the list.\r
- * Placing an item in a list using vListInsertEnd effectively places the item\r
- * in the list position pointed to by pxIndex. This means that every other\r
- * item within the list will be returned by listGET_OWNER_OF_NEXT_ENTRY before\r
- * the pxIndex parameter again points to the item being inserted.\r
- *\r
- * @param pxList The list into which the item is to be inserted.\r
- *\r
- * @param pxNewListItem The list item to be inserted into the list.\r
- *\r
- * \page vListInsertEnd vListInsertEnd\r
- * \ingroup LinkedList\r
- */\r
-void vListInsertEnd( List_t * const pxList, ListItem_t * const pxNewListItem ) PRIVILEGED_FUNCTION;\r
-\r
-/*\r
- * Remove an item from a list. The list item has a pointer to the list that\r
- * it is in, so only the list item need be passed into the function.\r
- *\r
- * @param uxListRemove The item to be removed. The item will remove itself from\r
- * the list pointed to by it's pxContainer parameter.\r
- *\r
- * @return The number of items that remain in the list after the list item has\r
- * been removed.\r
- *\r
- * \page uxListRemove uxListRemove\r
- * \ingroup LinkedList\r
- */\r
-UBaseType_t uxListRemove( ListItem_t * const pxItemToRemove ) PRIVILEGED_FUNCTION;\r
-\r
-#ifdef __cplusplus\r
-}\r
-#endif\r
-\r
-#endif\r
-\r
+++ /dev/null
-/*\r
- * FreeRTOS Kernel V10.0.1\r
- * Copyright (C) 2017 Amazon.com, Inc. or its affiliates. All Rights Reserved.\r
- *\r
- * Permission is hereby granted, free of charge, to any person obtaining a copy of\r
- * this software and associated documentation files (the "Software"), to deal in\r
- * the Software without restriction, including without limitation the rights to\r
- * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of\r
- * the Software, and to permit persons to whom the Software is furnished to do so,\r
- * subject to the following conditions:\r
- *\r
- * The above copyright notice and this permission notice shall be included in all\r
- * copies or substantial portions of the Software.\r
- *\r
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\r
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS\r
- * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR\r
- * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER\r
- * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN\r
- * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\r
- *\r
- * http://www.FreeRTOS.org\r
- * http://aws.amazon.com/freertos\r
- *\r
- * 1 tab == 4 spaces!\r
- */\r
-\r
-\r
-/*\r
- * Message buffers build functionality on top of FreeRTOS stream buffers.\r
- * Whereas stream buffers are used to send a continuous stream of data from one\r
- * task or interrupt to another, message buffers are used to send variable\r
- * length discrete messages from one task or interrupt to another. Their\r
- * implementation is light weight, making them particularly suited for interrupt\r
- * to task and core to core communication scenarios.\r
- *\r
- * ***NOTE***: Uniquely among FreeRTOS objects, the stream buffer\r
- * implementation (so also the message buffer implementation, as message buffers\r
- * are built on top of stream buffers) assumes there is only one task or\r
- * interrupt that will write to the buffer (the writer), and only one task or\r
- * interrupt that will read from the buffer (the reader). It is safe for the\r
- * writer and reader to be different tasks or interrupts, but, unlike other\r
- * FreeRTOS objects, it is not safe to have multiple different writers or\r
- * multiple different readers. If there are to be multiple different writers\r
- * then the application writer must place each call to a writing API function\r
- * (such as xMessageBufferSend()) inside a critical section and set the send\r
- * block time to 0. Likewise, if there are to be multiple different readers\r
- * then the application writer must place each call to a reading API function\r
- * (such as xMessageBufferRead()) inside a critical section and set the receive\r
- * timeout to 0.\r
- *\r
- * Message buffers hold variable length messages. To enable that, when a\r
- * message is written to the message buffer an additional sizeof( size_t ) bytes\r
- * are also written to store the message's length (that happens internally, with\r
- * the API function). sizeof( size_t ) is typically 4 bytes on a 32-bit\r
- * architecture, so writing a 10 byte message to a message buffer on a 32-bit\r
- * architecture will actually reduce the available space in the message buffer\r
- * by 14 bytes (10 byte are used by the message, and 4 bytes to hold the length\r
- * of the message).\r
- */\r
-\r
-#ifndef FREERTOS_MESSAGE_BUFFER_H\r
-#define FREERTOS_MESSAGE_BUFFER_H\r
-\r
-/* Message buffers are built onto of stream buffers. */\r
-#include "stream_buffer.h"\r
-\r
-#if defined( __cplusplus )\r
-extern "C" {\r
-#endif\r
-\r
-/**\r
- * Type by which message buffers are referenced. For example, a call to\r
- * xMessageBufferCreate() returns an MessageBufferHandle_t variable that can\r
- * then be used as a parameter to xMessageBufferSend(), xMessageBufferReceive(),\r
- * etc.\r
- */\r
-typedef void * MessageBufferHandle_t;\r
-\r
-/*-----------------------------------------------------------*/\r
-\r
-/**\r
- * message_buffer.h\r
- *\r
-<pre>\r
-MessageBufferHandle_t xMessageBufferCreate( size_t xBufferSizeBytes );\r
-</pre>\r
- *\r
- * Creates a new message buffer using dynamically allocated memory. See\r
- * xMessageBufferCreateStatic() for a version that uses statically allocated\r
- * memory (memory that is allocated at compile time).\r
- *\r
- * configSUPPORT_DYNAMIC_ALLOCATION must be set to 1 or left undefined in\r
- * FreeRTOSConfig.h for xMessageBufferCreate() to be available.\r
- *\r
- * @param xBufferSizeBytes The total number of bytes (not messages) the message\r
- * buffer will be able to hold at any one time. When a message is written to\r
- * the message buffer an additional sizeof( size_t ) bytes are also written to\r
- * store the message's length. sizeof( size_t ) is typically 4 bytes on a\r
- * 32-bit architecture, so on most 32-bit architectures a 10 byte message will\r
- * take up 14 bytes of message buffer space.\r
- *\r
- * @return If NULL is returned, then the message buffer cannot be created\r
- * because there is insufficient heap memory available for FreeRTOS to allocate\r
- * the message buffer data structures and storage area. A non-NULL value being\r
- * returned indicates that the message buffer has been created successfully -\r
- * the returned value should be stored as the handle to the created message\r
- * buffer.\r
- *\r
- * Example use:\r
-<pre>\r
-\r
-void vAFunction( void )\r
-{\r
-MessageBufferHandle_t xMessageBuffer;\r
-const size_t xMessageBufferSizeBytes = 100;\r
-\r
- // Create a message buffer that can hold 100 bytes. The memory used to hold\r
- // both the message buffer structure and the messages themselves is allocated\r
- // dynamically. Each message added to the buffer consumes an additional 4\r
- // bytes which are used to hold the lengh of the message.\r
- xMessageBuffer = xMessageBufferCreate( xMessageBufferSizeBytes );\r
-\r
- if( xMessageBuffer == NULL )\r
- {\r
- // There was not enough heap memory space available to create the\r
- // message buffer.\r
- }\r
- else\r
- {\r
- // The message buffer was created successfully and can now be used.\r
- }\r
-\r
-</pre>\r
- * \defgroup xMessageBufferCreate xMessageBufferCreate\r
- * \ingroup MessageBufferManagement\r
- */\r
-#define xMessageBufferCreate( xBufferSizeBytes ) ( MessageBufferHandle_t ) xStreamBufferGenericCreate( xBufferSizeBytes, ( size_t ) 0, pdTRUE )\r
-\r
-/**\r
- * message_buffer.h\r
- *\r
-<pre>\r
-MessageBufferHandle_t xMessageBufferCreateStatic( size_t xBufferSizeBytes,\r
- uint8_t *pucMessageBufferStorageArea,\r
- StaticMessageBuffer_t *pxStaticMessageBuffer );\r
-</pre>\r
- * Creates a new message buffer using statically allocated memory. See\r
- * xMessageBufferCreate() for a version that uses dynamically allocated memory.\r
- *\r
- * @param xBufferSizeBytes The size, in bytes, of the buffer pointed to by the\r
- * pucMessageBufferStorageArea parameter. When a message is written to the\r
- * message buffer an additional sizeof( size_t ) bytes are also written to store\r
- * the message's length. sizeof( size_t ) is typically 4 bytes on a 32-bit\r
- * architecture, so on most 32-bit architecture a 10 byte message will take up\r
- * 14 bytes of message buffer space. The maximum number of bytes that can be\r
- * stored in the message buffer is actually (xBufferSizeBytes - 1).\r
- *\r
- * @param pucMessageBufferStorageArea Must point to a uint8_t array that is at\r
- * least xBufferSizeBytes + 1 big. This is the array to which messages are\r
- * copied when they are written to the message buffer.\r
- *\r
- * @param pxStaticMessageBuffer Must point to a variable of type\r
- * StaticMessageBuffer_t, which will be used to hold the message buffer's data\r
- * structure.\r
- *\r
- * @return If the message buffer is created successfully then a handle to the\r
- * created message buffer is returned. If either pucMessageBufferStorageArea or\r
- * pxStaticmessageBuffer are NULL then NULL is returned.\r
- *\r
- * Example use:\r
-<pre>\r
-\r
-// Used to dimension the array used to hold the messages. The available space\r
-// will actually be one less than this, so 999.\r
-#define STORAGE_SIZE_BYTES 1000\r
-\r
-// Defines the memory that will actually hold the messages within the message\r
-// buffer.\r
-static uint8_t ucStorageBuffer[ STORAGE_SIZE_BYTES ];\r
-\r
-// The variable used to hold the message buffer structure.\r
-StaticMessageBuffer_t xMessageBufferStruct;\r
-\r
-void MyFunction( void )\r
-{\r
-MessageBufferHandle_t xMessageBuffer;\r
-\r
- xMessageBuffer = xMessageBufferCreateStatic( sizeof( ucBufferStorage ),\r
- ucBufferStorage,\r
- &xMessageBufferStruct );\r
-\r
- // As neither the pucMessageBufferStorageArea or pxStaticMessageBuffer\r
- // parameters were NULL, xMessageBuffer will not be NULL, and can be used to\r
- // reference the created message buffer in other message buffer API calls.\r
-\r
- // Other code that uses the message buffer can go here.\r
-}\r
-\r
-</pre>\r
- * \defgroup xMessageBufferCreateStatic xMessageBufferCreateStatic\r
- * \ingroup MessageBufferManagement\r
- */\r
-#define xMessageBufferCreateStatic( xBufferSizeBytes, pucMessageBufferStorageArea, pxStaticMessageBuffer ) ( MessageBufferHandle_t ) xStreamBufferGenericCreateStatic( xBufferSizeBytes, 0, pdTRUE, pucMessageBufferStorageArea, pxStaticMessageBuffer )\r
-\r
-/**\r
- * message_buffer.h\r
- *\r
-<pre>\r
-size_t xMessageBufferSend( MessageBufferHandle_t xMessageBuffer,\r
- const void *pvTxData,\r
- size_t xDataLengthBytes,\r
- TickType_t xTicksToWait );\r
-<pre>\r
- *\r
- * Sends a discrete message to the message buffer. The message can be any\r
- * length that fits within the buffer's free space, and is copied into the\r
- * buffer.\r
- *\r
- * ***NOTE***: Uniquely among FreeRTOS objects, the stream buffer\r
- * implementation (so also the message buffer implementation, as message buffers\r
- * are built on top of stream buffers) assumes there is only one task or\r
- * interrupt that will write to the buffer (the writer), and only one task or\r
- * interrupt that will read from the buffer (the reader). It is safe for the\r
- * writer and reader to be different tasks or interrupts, but, unlike other\r
- * FreeRTOS objects, it is not safe to have multiple different writers or\r
- * multiple different readers. If there are to be multiple different writers\r
- * then the application writer must place each call to a writing API function\r
- * (such as xMessageBufferSend()) inside a critical section and set the send\r
- * block time to 0. Likewise, if there are to be multiple different readers\r
- * then the application writer must place each call to a reading API function\r
- * (such as xMessageBufferRead()) inside a critical section and set the receive\r
- * block time to 0.\r
- *\r
- * Use xMessageBufferSend() to write to a message buffer from a task. Use\r
- * xMessageBufferSendFromISR() to write to a message buffer from an interrupt\r
- * service routine (ISR).\r
- *\r
- * @param xMessageBuffer The handle of the message buffer to which a message is\r
- * being sent.\r
- *\r
- * @param pvTxData A pointer to the message that is to be copied into the\r
- * message buffer.\r
- *\r
- * @param xDataLengthBytes The length of the message. That is, the number of\r
- * bytes to copy from pvTxData into the message buffer. When a message is\r
- * written to the message buffer an additional sizeof( size_t ) bytes are also\r
- * written to store the message's length. sizeof( size_t ) is typically 4 bytes\r
- * on a 32-bit architecture, so on most 32-bit architecture setting\r
- * xDataLengthBytes to 20 will reduce the free space in the message buffer by 24\r
- * bytes (20 bytes of message data and 4 bytes to hold the message length).\r
- *\r
- * @param xTicksToWait The maximum amount of time the calling task should remain\r
- * in the Blocked state to wait for enough space to become available in the\r
- * message buffer, should the message buffer have insufficient space when\r
- * xMessageBufferSend() is called. The calling task will never block if\r
- * xTicksToWait is zero. The block time is specified in tick periods, so the\r
- * absolute time it represents is dependent on the tick frequency. The macro\r
- * pdMS_TO_TICKS() can be used to convert a time specified in milliseconds into\r
- * a time specified in ticks. Setting xTicksToWait to portMAX_DELAY will cause\r
- * the task to wait indefinitely (without timing out), provided\r
- * INCLUDE_vTaskSuspend is set to 1 in FreeRTOSConfig.h. Tasks do not use any\r
- * CPU time when they are in the Blocked state.\r
- *\r
- * @return The number of bytes written to the message buffer. If the call to\r
- * xMessageBufferSend() times out before there was enough space to write the\r
- * message into the message buffer then zero is returned. If the call did not\r
- * time out then xDataLengthBytes is returned.\r
- *\r
- * Example use:\r
-<pre>\r
-void vAFunction( MessageBufferHandle_t xMessageBuffer )\r
-{\r
-size_t xBytesSent;\r
-uint8_t ucArrayToSend[] = { 0, 1, 2, 3 };\r
-char *pcStringToSend = "String to send";\r
-const TickType_t x100ms = pdMS_TO_TICKS( 100 );\r
-\r
- // Send an array to the message buffer, blocking for a maximum of 100ms to\r
- // wait for enough space to be available in the message buffer.\r
- xBytesSent = xMessageBufferSend( xMessageBuffer, ( void * ) ucArrayToSend, sizeof( ucArrayToSend ), x100ms );\r
-\r
- if( xBytesSent != sizeof( ucArrayToSend ) )\r
- {\r
- // The call to xMessageBufferSend() times out before there was enough\r
- // space in the buffer for the data to be written.\r
- }\r
-\r
- // Send the string to the message buffer. Return immediately if there is\r
- // not enough space in the buffer.\r
- xBytesSent = xMessageBufferSend( xMessageBuffer, ( void * ) pcStringToSend, strlen( pcStringToSend ), 0 );\r
-\r
- if( xBytesSent != strlen( pcStringToSend ) )\r
- {\r
- // The string could not be added to the message buffer because there was\r
- // not enough free space in the buffer.\r
- }\r
-}\r
-</pre>\r
- * \defgroup xMessageBufferSend xMessageBufferSend\r
- * \ingroup MessageBufferManagement\r
- */\r
-#define xMessageBufferSend( xMessageBuffer, pvTxData, xDataLengthBytes, xTicksToWait ) xStreamBufferSend( ( StreamBufferHandle_t ) xMessageBuffer, pvTxData, xDataLengthBytes, xTicksToWait )\r
-\r
-/**\r
- * message_buffer.h\r
- *\r
-<pre>\r
-size_t xMessageBufferSendFromISR( MessageBufferHandle_t xMessageBuffer,\r
- const void *pvTxData,\r
- size_t xDataLengthBytes,\r
- BaseType_t *pxHigherPriorityTaskWoken );\r
-<pre>\r
- *\r
- * Interrupt safe version of the API function that sends a discrete message to\r
- * the message buffer. The message can be any length that fits within the\r
- * buffer's free space, and is copied into the buffer.\r
- *\r
- * ***NOTE***: Uniquely among FreeRTOS objects, the stream buffer\r
- * implementation (so also the message buffer implementation, as message buffers\r
- * are built on top of stream buffers) assumes there is only one task or\r
- * interrupt that will write to the buffer (the writer), and only one task or\r
- * interrupt that will read from the buffer (the reader). It is safe for the\r
- * writer and reader to be different tasks or interrupts, but, unlike other\r
- * FreeRTOS objects, it is not safe to have multiple different writers or\r
- * multiple different readers. If there are to be multiple different writers\r
- * then the application writer must place each call to a writing API function\r
- * (such as xMessageBufferSend()) inside a critical section and set the send\r
- * block time to 0. Likewise, if there are to be multiple different readers\r
- * then the application writer must place each call to a reading API function\r
- * (such as xMessageBufferRead()) inside a critical section and set the receive\r
- * block time to 0.\r
- *\r
- * Use xMessageBufferSend() to write to a message buffer from a task. Use\r
- * xMessageBufferSendFromISR() to write to a message buffer from an interrupt\r
- * service routine (ISR).\r
- *\r
- * @param xMessageBuffer The handle of the message buffer to which a message is\r
- * being sent.\r
- *\r
- * @param pvTxData A pointer to the message that is to be copied into the\r
- * message buffer.\r
- *\r
- * @param xDataLengthBytes The length of the message. That is, the number of\r
- * bytes to copy from pvTxData into the message buffer. When a message is\r
- * written to the message buffer an additional sizeof( size_t ) bytes are also\r
- * written to store the message's length. sizeof( size_t ) is typically 4 bytes\r
- * on a 32-bit architecture, so on most 32-bit architecture setting\r
- * xDataLengthBytes to 20 will reduce the free space in the message buffer by 24\r
- * bytes (20 bytes of message data and 4 bytes to hold the message length).\r
- *\r
- * @param pxHigherPriorityTaskWoken It is possible that a message buffer will\r
- * have a task blocked on it waiting for data. Calling\r
- * xMessageBufferSendFromISR() can make data available, and so cause a task that\r
- * was waiting for data to leave the Blocked state. If calling\r
- * xMessageBufferSendFromISR() causes a task to leave the Blocked state, and the\r
- * unblocked task has a priority higher than the currently executing task (the\r
- * task that was interrupted), then, internally, xMessageBufferSendFromISR()\r
- * will set *pxHigherPriorityTaskWoken to pdTRUE. If\r
- * xMessageBufferSendFromISR() sets this value to pdTRUE, then normally a\r
- * context switch should be performed before the interrupt is exited. This will\r
- * ensure that the interrupt returns directly to the highest priority Ready\r
- * state task. *pxHigherPriorityTaskWoken should be set to pdFALSE before it\r
- * is passed into the function. See the code example below for an example.\r
- *\r
- * @return The number of bytes actually written to the message buffer. If the\r
- * message buffer didn't have enough free space for the message to be stored\r
- * then 0 is returned, otherwise xDataLengthBytes is returned.\r
- *\r
- * Example use:\r
-<pre>\r
-// A message buffer that has already been created.\r
-MessageBufferHandle_t xMessageBuffer;\r
-\r
-void vAnInterruptServiceRoutine( void )\r
-{\r
-size_t xBytesSent;\r
-char *pcStringToSend = "String to send";\r
-BaseType_t xHigherPriorityTaskWoken = pdFALSE; // Initialised to pdFALSE.\r
-\r
- // Attempt to send the string to the message buffer.\r
- xBytesSent = xMessageBufferSendFromISR( xMessageBuffer,\r
- ( void * ) pcStringToSend,\r
- strlen( pcStringToSend ),\r
- &xHigherPriorityTaskWoken );\r
-\r
- if( xBytesSent != strlen( pcStringToSend ) )\r
- {\r
- // The string could not be added to the message buffer because there was\r
- // not enough free space in the buffer.\r
- }\r
-\r
- // If xHigherPriorityTaskWoken was set to pdTRUE inside\r
- // xMessageBufferSendFromISR() then a task that has a priority above the\r
- // priority of the currently executing task was unblocked and a context\r
- // switch should be performed to ensure the ISR returns to the unblocked\r
- // task. In most FreeRTOS ports this is done by simply passing\r
- // xHigherPriorityTaskWoken into taskYIELD_FROM_ISR(), which will test the\r
- // variables value, and perform the context switch if necessary. Check the\r
- // documentation for the port in use for port specific instructions.\r
- taskYIELD_FROM_ISR( xHigherPriorityTaskWoken );\r
-}\r
-</pre>\r
- * \defgroup xMessageBufferSendFromISR xMessageBufferSendFromISR\r
- * \ingroup MessageBufferManagement\r
- */\r
-#define xMessageBufferSendFromISR( xMessageBuffer, pvTxData, xDataLengthBytes, pxHigherPriorityTaskWoken ) xStreamBufferSendFromISR( ( StreamBufferHandle_t ) xMessageBuffer, pvTxData, xDataLengthBytes, pxHigherPriorityTaskWoken )\r
-\r
-/**\r
- * message_buffer.h\r
- *\r
-<pre>\r
-size_t xMessageBufferReceive( MessageBufferHandle_t xMessageBuffer,\r
- void *pvRxData,\r
- size_t xBufferLengthBytes,\r
- TickType_t xTicksToWait );\r
-</pre>\r
- *\r
- * Receives a discrete message from a message buffer. Messages can be of\r
- * variable length and are copied out of the buffer.\r
- *\r
- * ***NOTE***: Uniquely among FreeRTOS objects, the stream buffer\r
- * implementation (so also the message buffer implementation, as message buffers\r
- * are built on top of stream buffers) assumes there is only one task or\r
- * interrupt that will write to the buffer (the writer), and only one task or\r
- * interrupt that will read from the buffer (the reader). It is safe for the\r
- * writer and reader to be different tasks or interrupts, but, unlike other\r
- * FreeRTOS objects, it is not safe to have multiple different writers or\r
- * multiple different readers. If there are to be multiple different writers\r
- * then the application writer must place each call to a writing API function\r
- * (such as xMessageBufferSend()) inside a critical section and set the send\r
- * block time to 0. Likewise, if there are to be multiple different readers\r
- * then the application writer must place each call to a reading API function\r
- * (such as xMessageBufferRead()) inside a critical section and set the receive\r
- * block time to 0.\r
- *\r
- * Use xMessageBufferReceive() to read from a message buffer from a task. Use\r
- * xMessageBufferReceiveFromISR() to read from a message buffer from an\r
- * interrupt service routine (ISR).\r
- *\r
- * @param xMessageBuffer The handle of the message buffer from which a message\r
- * is being received.\r
- *\r
- * @param pvRxData A pointer to the buffer into which the received message is\r
- * to be copied.\r
- *\r
- * @param xBufferLengthBytes The length of the buffer pointed to by the pvRxData\r
- * parameter. This sets the maximum length of the message that can be received.\r
- * If xBufferLengthBytes is too small to hold the next message then the message\r
- * will be left in the message buffer and 0 will be returned.\r
- *\r
- * @param xTicksToWait The maximum amount of time the task should remain in the\r
- * Blocked state to wait for a message, should the message buffer be empty.\r
- * xMessageBufferReceive() will return immediately if xTicksToWait is zero and\r
- * the message buffer is empty. The block time is specified in tick periods, so\r
- * the absolute time it represents is dependent on the tick frequency. The\r
- * macro pdMS_TO_TICKS() can be used to convert a time specified in milliseconds\r
- * into a time specified in ticks. Setting xTicksToWait to portMAX_DELAY will\r
- * cause the task to wait indefinitely (without timing out), provided\r
- * INCLUDE_vTaskSuspend is set to 1 in FreeRTOSConfig.h. Tasks do not use any\r
- * CPU time when they are in the Blocked state.\r
- *\r
- * @return The length, in bytes, of the message read from the message buffer, if\r
- * any. If xMessageBufferReceive() times out before a message became available\r
- * then zero is returned. If the length of the message is greater than\r
- * xBufferLengthBytes then the message will be left in the message buffer and\r
- * zero is returned.\r
- *\r
- * Example use:\r
-<pre>\r
-void vAFunction( MessageBuffer_t xMessageBuffer )\r
-{\r
-uint8_t ucRxData[ 20 ];\r
-size_t xReceivedBytes;\r
-const TickType_t xBlockTime = pdMS_TO_TICKS( 20 );\r
-\r
- // Receive the next message from the message buffer. Wait in the Blocked\r
- // state (so not using any CPU processing time) for a maximum of 100ms for\r
- // a message to become available.\r
- xReceivedBytes = xMessageBufferReceive( xMessageBuffer,\r
- ( void * ) ucRxData,\r
- sizeof( ucRxData ),\r
- xBlockTime );\r
-\r
- if( xReceivedBytes > 0 )\r
- {\r
- // A ucRxData contains a message that is xReceivedBytes long. Process\r
- // the message here....\r
- }\r
-}\r
-</pre>\r
- * \defgroup xMessageBufferReceive xMessageBufferReceive\r
- * \ingroup MessageBufferManagement\r
- */\r
-#define xMessageBufferReceive( xMessageBuffer, pvRxData, xBufferLengthBytes, xTicksToWait ) xStreamBufferReceive( ( StreamBufferHandle_t ) xMessageBuffer, pvRxData, xBufferLengthBytes, xTicksToWait )\r
-\r
-\r
-/**\r
- * message_buffer.h\r
- *\r
-<pre>\r
-size_t xMessageBufferReceiveFromISR( MessageBufferHandle_t xMessageBuffer,\r
- void *pvRxData,\r
- size_t xBufferLengthBytes,\r
- BaseType_t *pxHigherPriorityTaskWoken );\r
-</pre>\r
- *\r
- * An interrupt safe version of the API function that receives a discrete\r
- * message from a message buffer. Messages can be of variable length and are\r
- * copied out of the buffer.\r
- *\r
- * ***NOTE***: Uniquely among FreeRTOS objects, the stream buffer\r
- * implementation (so also the message buffer implementation, as message buffers\r
- * are built on top of stream buffers) assumes there is only one task or\r
- * interrupt that will write to the buffer (the writer), and only one task or\r
- * interrupt that will read from the buffer (the reader). It is safe for the\r
- * writer and reader to be different tasks or interrupts, but, unlike other\r
- * FreeRTOS objects, it is not safe to have multiple different writers or\r
- * multiple different readers. If there are to be multiple different writers\r
- * then the application writer must place each call to a writing API function\r
- * (such as xMessageBufferSend()) inside a critical section and set the send\r
- * block time to 0. Likewise, if there are to be multiple different readers\r
- * then the application writer must place each call to a reading API function\r
- * (such as xMessageBufferRead()) inside a critical section and set the receive\r
- * block time to 0.\r
- *\r
- * Use xMessageBufferReceive() to read from a message buffer from a task. Use\r
- * xMessageBufferReceiveFromISR() to read from a message buffer from an\r
- * interrupt service routine (ISR).\r
- *\r
- * @param xMessageBuffer The handle of the message buffer from which a message\r
- * is being received.\r
- *\r
- * @param pvRxData A pointer to the buffer into which the received message is\r
- * to be copied.\r
- *\r
- * @param xBufferLengthBytes The length of the buffer pointed to by the pvRxData\r
- * parameter. This sets the maximum length of the message that can be received.\r
- * If xBufferLengthBytes is too small to hold the next message then the message\r
- * will be left in the message buffer and 0 will be returned.\r
- *\r
- * @param pxHigherPriorityTaskWoken It is possible that a message buffer will\r
- * have a task blocked on it waiting for space to become available. Calling\r
- * xMessageBufferReceiveFromISR() can make space available, and so cause a task\r
- * that is waiting for space to leave the Blocked state. If calling\r
- * xMessageBufferReceiveFromISR() causes a task to leave the Blocked state, and\r
- * the unblocked task has a priority higher than the currently executing task\r
- * (the task that was interrupted), then, internally,\r
- * xMessageBufferReceiveFromISR() will set *pxHigherPriorityTaskWoken to pdTRUE.\r
- * If xMessageBufferReceiveFromISR() sets this value to pdTRUE, then normally a\r
- * context switch should be performed before the interrupt is exited. That will\r
- * ensure the interrupt returns directly to the highest priority Ready state\r
- * task. *pxHigherPriorityTaskWoken should be set to pdFALSE before it is\r
- * passed into the function. See the code example below for an example.\r
- *\r
- * @return The length, in bytes, of the message read from the message buffer, if\r
- * any.\r
- *\r
- * Example use:\r
-<pre>\r
-// A message buffer that has already been created.\r
-MessageBuffer_t xMessageBuffer;\r
-\r
-void vAnInterruptServiceRoutine( void )\r
-{\r
-uint8_t ucRxData[ 20 ];\r
-size_t xReceivedBytes;\r
-BaseType_t xHigherPriorityTaskWoken = pdFALSE; // Initialised to pdFALSE.\r
-\r
- // Receive the next message from the message buffer.\r
- xReceivedBytes = xMessageBufferReceiveFromISR( xMessageBuffer,\r
- ( void * ) ucRxData,\r
- sizeof( ucRxData ),\r
- &xHigherPriorityTaskWoken );\r
-\r
- if( xReceivedBytes > 0 )\r
- {\r
- // A ucRxData contains a message that is xReceivedBytes long. Process\r
- // the message here....\r
- }\r
-\r
- // If xHigherPriorityTaskWoken was set to pdTRUE inside\r
- // xMessageBufferReceiveFromISR() then a task that has a priority above the\r
- // priority of the currently executing task was unblocked and a context\r
- // switch should be performed to ensure the ISR returns to the unblocked\r
- // task. In most FreeRTOS ports this is done by simply passing\r
- // xHigherPriorityTaskWoken into taskYIELD_FROM_ISR(), which will test the\r
- // variables value, and perform the context switch if necessary. Check the\r
- // documentation for the port in use for port specific instructions.\r
- taskYIELD_FROM_ISR( xHigherPriorityTaskWoken );\r
-}\r
-</pre>\r
- * \defgroup xMessageBufferReceiveFromISR xMessageBufferReceiveFromISR\r
- * \ingroup MessageBufferManagement\r
- */\r
-#define xMessageBufferReceiveFromISR( xMessageBuffer, pvRxData, xBufferLengthBytes, pxHigherPriorityTaskWoken ) xStreamBufferReceiveFromISR( ( StreamBufferHandle_t ) xMessageBuffer, pvRxData, xBufferLengthBytes, pxHigherPriorityTaskWoken )\r
-\r
-/**\r
- * message_buffer.h\r
- *\r
-<pre>\r
-void vMessageBufferDelete( MessageBufferHandle_t xMessageBuffer );\r
-</pre>\r
- *\r
- * Deletes a message buffer that was previously created using a call to\r
- * xMessageBufferCreate() or xMessageBufferCreateStatic(). If the message\r
- * buffer was created using dynamic memory (that is, by xMessageBufferCreate()),\r
- * then the allocated memory is freed.\r
- *\r
- * A message buffer handle must not be used after the message buffer has been\r
- * deleted.\r
- *\r
- * @param xMessageBuffer The handle of the message buffer to be deleted.\r
- *\r
- */\r
-#define vMessageBufferDelete( xMessageBuffer ) vStreamBufferDelete( ( StreamBufferHandle_t ) xMessageBuffer )\r
-\r
-/**\r
- * message_buffer.h\r
-<pre>\r
-BaseType_t xMessageBufferIsFull( MessageBufferHandle_t xMessageBuffer ) );\r
-</pre>\r
- *\r
- * Tests to see if a message buffer is full. A message buffer is full if it\r
- * cannot accept any more messages, of any size, until space is made available\r
- * by a message being removed from the message buffer.\r
- *\r
- * @param xMessageBuffer The handle of the message buffer being queried.\r
- *\r
- * @return If the message buffer referenced by xMessageBuffer is full then\r
- * pdTRUE is returned. Otherwise pdFALSE is returned.\r
- */\r
-#define xMessageBufferIsFull( xMessageBuffer ) xStreamBufferIsFull( ( StreamBufferHandle_t ) xMessageBuffer )\r
-\r
-/**\r
- * message_buffer.h\r
-<pre>\r
-BaseType_t xMessageBufferIsEmpty( MessageBufferHandle_t xMessageBuffer ) );\r
-</pre>\r
- *\r
- * Tests to see if a message buffer is empty (does not contain any messages).\r
- *\r
- * @param xMessageBuffer The handle of the message buffer being queried.\r
- *\r
- * @return If the message buffer referenced by xMessageBuffer is empty then\r
- * pdTRUE is returned. Otherwise pdFALSE is returned.\r
- *\r
- */\r
-#define xMessageBufferIsEmpty( xMessageBuffer ) xStreamBufferIsEmpty( ( StreamBufferHandle_t ) xMessageBuffer )\r
-\r
-/**\r
- * message_buffer.h\r
-<pre>\r
-BaseType_t xMessageBufferReset( MessageBufferHandle_t xMessageBuffer );\r
-</pre>\r
- *\r
- * Resets a message buffer to its initial empty state, discarding any message it\r
- * contained.\r
- *\r
- * A message buffer can only be reset if there are no tasks blocked on it.\r
- *\r
- * @param xMessageBuffer The handle of the message buffer being reset.\r
- *\r
- * @return If the message buffer was reset then pdPASS is returned. If the\r
- * message buffer could not be reset because either there was a task blocked on\r
- * the message queue to wait for space to become available, or to wait for a\r
- * a message to be available, then pdFAIL is returned.\r
- *\r
- * \defgroup xMessageBufferReset xMessageBufferReset\r
- * \ingroup MessageBufferManagement\r
- */\r
-#define xMessageBufferReset( xMessageBuffer ) xStreamBufferReset( ( StreamBufferHandle_t ) xMessageBuffer )\r
-\r
-\r
-/**\r
- * message_buffer.h\r
-<pre>\r
-size_t xMessageBufferSpaceAvailable( MessageBufferHandle_t xMessageBuffer ) );\r
-</pre>\r
- * Returns the number of bytes of free space in the message buffer.\r
- *\r
- * @param xMessageBuffer The handle of the message buffer being queried.\r
- *\r
- * @return The number of bytes that can be written to the message buffer before\r
- * the message buffer would be full. When a message is written to the message\r
- * buffer an additional sizeof( size_t ) bytes are also written to store the\r
- * message's length. sizeof( size_t ) is typically 4 bytes on a 32-bit\r
- * architecture, so if xMessageBufferSpacesAvailable() returns 10, then the size\r
- * of the largest message that can be written to the message buffer is 6 bytes.\r
- *\r
- * \defgroup xMessageBufferSpaceAvailable xMessageBufferSpaceAvailable\r
- * \ingroup MessageBufferManagement\r
- */\r
-#define xMessageBufferSpaceAvailable( xMessageBuffer ) xStreamBufferSpacesAvailable( ( StreamBufferHandle_t ) xMessageBuffer )\r
-\r
-/**\r
- * message_buffer.h\r
- *\r
-<pre>\r
-BaseType_t xMessageBufferSendCompletedFromISR( MessageBufferHandle_t xStreamBuffer, BaseType_t *pxHigherPriorityTaskWoken );\r
-</pre>\r
- *\r
- * For advanced users only.\r
- *\r
- * The sbSEND_COMPLETED() macro is called from within the FreeRTOS APIs when\r
- * data is sent to a message buffer or stream buffer. If there was a task that\r
- * was blocked on the message or stream buffer waiting for data to arrive then\r
- * the sbSEND_COMPLETED() macro sends a notification to the task to remove it\r
- * from the Blocked state. xMessageBufferSendCompletedFromISR() does the same\r
- * thing. It is provided to enable application writers to implement their own\r
- * version of sbSEND_COMPLETED(), and MUST NOT BE USED AT ANY OTHER TIME.\r
- *\r
- * See the example implemented in FreeRTOS/Demo/Minimal/MessageBufferAMP.c for\r
- * additional information.\r
- *\r
- * @param xStreamBuffer The handle of the stream buffer to which data was\r
- * written.\r
- *\r
- * @param pxHigherPriorityTaskWoken *pxHigherPriorityTaskWoken should be\r
- * initialised to pdFALSE before it is passed into\r
- * xMessageBufferSendCompletedFromISR(). If calling\r
- * xMessageBufferSendCompletedFromISR() removes a task from the Blocked state,\r
- * and the task has a priority above the priority of the currently running task,\r
- * then *pxHigherPriorityTaskWoken will get set to pdTRUE indicating that a\r
- * context switch should be performed before exiting the ISR.\r
- *\r
- * @return If a task was removed from the Blocked state then pdTRUE is returned.\r
- * Otherwise pdFALSE is returned.\r
- *\r
- * \defgroup xMessageBufferSendCompletedFromISR xMessageBufferSendCompletedFromISR\r
- * \ingroup StreamBufferManagement\r
- */\r
-#define xMessageBufferSendCompletedFromISR( xMessageBuffer, pxHigherPriorityTaskWoken ) xStreamBufferSendCompletedFromISR( ( StreamBufferHandle_t ) xMessageBuffer, pxHigherPriorityTaskWoken )\r
-\r
-/**\r
- * message_buffer.h\r
- *\r
-<pre>\r
-BaseType_t xMessageBufferReceiveCompletedFromISR( MessageBufferHandle_t xStreamBuffer, BaseType_t *pxHigherPriorityTaskWoken );\r
-</pre>\r
- *\r
- * For advanced users only.\r
- *\r
- * The sbRECEIVE_COMPLETED() macro is called from within the FreeRTOS APIs when\r
- * data is read out of a message buffer or stream buffer. If there was a task\r
- * that was blocked on the message or stream buffer waiting for data to arrive\r
- * then the sbRECEIVE_COMPLETED() macro sends a notification to the task to\r
- * remove it from the Blocked state. xMessageBufferReceiveCompletedFromISR()\r
- * does the same thing. It is provided to enable application writers to\r
- * implement their own version of sbRECEIVE_COMPLETED(), and MUST NOT BE USED AT\r
- * ANY OTHER TIME.\r
- *\r
- * See the example implemented in FreeRTOS/Demo/Minimal/MessageBufferAMP.c for\r
- * additional information.\r
- *\r
- * @param xStreamBuffer The handle of the stream buffer from which data was\r
- * read.\r
- *\r
- * @param pxHigherPriorityTaskWoken *pxHigherPriorityTaskWoken should be\r
- * initialised to pdFALSE before it is passed into\r
- * xMessageBufferReceiveCompletedFromISR(). If calling\r
- * xMessageBufferReceiveCompletedFromISR() removes a task from the Blocked state,\r
- * and the task has a priority above the priority of the currently running task,\r
- * then *pxHigherPriorityTaskWoken will get set to pdTRUE indicating that a\r
- * context switch should be performed before exiting the ISR.\r
- *\r
- * @return If a task was removed from the Blocked state then pdTRUE is returned.\r
- * Otherwise pdFALSE is returned.\r
- *\r
- * \defgroup xMessageBufferReceiveCompletedFromISR xMessageBufferReceiveCompletedFromISR\r
- * \ingroup StreamBufferManagement\r
- */\r
-#define xMessageBufferReceiveCompletedFromISR( xMessageBuffer, pxHigherPriorityTaskWoken ) xStreamBufferReceiveCompletedFromISR( ( StreamBufferHandle_t ) xMessageBuffer, pxHigherPriorityTaskWoken )\r
-\r
-#if defined( __cplusplus )\r
-} /* extern "C" */\r
-#endif\r
-\r
-#endif /* !defined( FREERTOS_MESSAGE_BUFFER_H ) */\r
+++ /dev/null
-/*\r
- * FreeRTOS Kernel V10.0.1\r
- * Copyright (C) 2017 Amazon.com, Inc. or its affiliates. All Rights Reserved.\r
- *\r
- * Permission is hereby granted, free of charge, to any person obtaining a copy of\r
- * this software and associated documentation files (the "Software"), to deal in\r
- * the Software without restriction, including without limitation the rights to\r
- * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of\r
- * the Software, and to permit persons to whom the Software is furnished to do so,\r
- * subject to the following conditions:\r
- *\r
- * The above copyright notice and this permission notice shall be included in all\r
- * copies or substantial portions of the Software.\r
- *\r
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\r
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS\r
- * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR\r
- * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER\r
- * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN\r
- * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\r
- *\r
- * http://www.FreeRTOS.org\r
- * http://aws.amazon.com/freertos\r
- *\r
- * 1 tab == 4 spaces!\r
- */\r
-\r
-/*\r
- * When the MPU is used the standard (non MPU) API functions are mapped to\r
- * equivalents that start "MPU_", the prototypes for which are defined in this\r
- * header files. This will cause the application code to call the MPU_ version\r
- * which wraps the non-MPU version with privilege promoting then demoting code,\r
- * so the kernel code always runs will full privileges.\r
- */\r
-\r
-\r
-#ifndef MPU_PROTOTYPES_H\r
-#define MPU_PROTOTYPES_H\r
-\r
-/* MPU versions of tasks.h API functions. */\r
-BaseType_t MPU_xTaskCreate( TaskFunction_t pxTaskCode, const char * const pcName, const uint16_t usStackDepth, void * const pvParameters, UBaseType_t uxPriority, TaskHandle_t * const pxCreatedTask );\r
-TaskHandle_t MPU_xTaskCreateStatic( TaskFunction_t pxTaskCode, const char * const pcName, const uint32_t ulStackDepth, void * const pvParameters, UBaseType_t uxPriority, StackType_t * const puxStackBuffer, StaticTask_t * const pxTaskBuffer );\r
-BaseType_t MPU_xTaskCreateRestricted( const TaskParameters_t * const pxTaskDefinition, TaskHandle_t *pxCreatedTask );\r
-BaseType_t MPU_xTaskCreateRestrictedStatic( const TaskParameters_t * const pxTaskDefinition, TaskHandle_t *pxCreatedTask );\r
-void MPU_vTaskAllocateMPURegions( TaskHandle_t xTask, const MemoryRegion_t * const pxRegions );\r
-void MPU_vTaskDelete( TaskHandle_t xTaskToDelete );\r
-void MPU_vTaskDelay( const TickType_t xTicksToDelay );\r
-void MPU_vTaskDelayUntil( TickType_t * const pxPreviousWakeTime, const TickType_t xTimeIncrement );\r
-BaseType_t MPU_xTaskAbortDelay( TaskHandle_t xTask );\r
-UBaseType_t MPU_uxTaskPriorityGet( TaskHandle_t xTask );\r
-eTaskState MPU_eTaskGetState( TaskHandle_t xTask );\r
-void MPU_vTaskGetInfo( TaskHandle_t xTask, TaskStatus_t *pxTaskStatus, BaseType_t xGetFreeStackSpace, eTaskState eState );\r
-void MPU_vTaskPrioritySet( TaskHandle_t xTask, UBaseType_t uxNewPriority );\r
-void MPU_vTaskSuspend( TaskHandle_t xTaskToSuspend );\r
-void MPU_vTaskResume( TaskHandle_t xTaskToResume );\r
-void MPU_vTaskStartScheduler( void );\r
-void MPU_vTaskSuspendAll( void );\r
-BaseType_t MPU_xTaskResumeAll( void );\r
-TickType_t MPU_xTaskGetTickCount( void );\r
-UBaseType_t MPU_uxTaskGetNumberOfTasks( void );\r
-char * MPU_pcTaskGetName( TaskHandle_t xTaskToQuery );\r
-TaskHandle_t MPU_xTaskGetHandle( const char *pcNameToQuery );\r
-UBaseType_t MPU_uxTaskGetStackHighWaterMark( TaskHandle_t xTask );\r
-void MPU_vTaskSetApplicationTaskTag( TaskHandle_t xTask, TaskHookFunction_t pxHookFunction );\r
-TaskHookFunction_t MPU_xTaskGetApplicationTaskTag( TaskHandle_t xTask );\r
-void MPU_vTaskSetThreadLocalStoragePointer( TaskHandle_t xTaskToSet, BaseType_t xIndex, void *pvValue );\r
-void * MPU_pvTaskGetThreadLocalStoragePointer( TaskHandle_t xTaskToQuery, BaseType_t xIndex );\r
-BaseType_t MPU_xTaskCallApplicationTaskHook( TaskHandle_t xTask, void *pvParameter );\r
-TaskHandle_t MPU_xTaskGetIdleTaskHandle( void );\r
-UBaseType_t MPU_uxTaskGetSystemState( TaskStatus_t * const pxTaskStatusArray, const UBaseType_t uxArraySize, uint32_t * const pulTotalRunTime );\r
-void MPU_vTaskList( char * pcWriteBuffer );\r
-void MPU_vTaskGetRunTimeStats( char *pcWriteBuffer );\r
-BaseType_t MPU_xTaskGenericNotify( TaskHandle_t xTaskToNotify, uint32_t ulValue, eNotifyAction eAction, uint32_t *pulPreviousNotificationValue );\r
-BaseType_t MPU_xTaskNotifyWait( uint32_t ulBitsToClearOnEntry, uint32_t ulBitsToClearOnExit, uint32_t *pulNotificationValue, TickType_t xTicksToWait );\r
-uint32_t MPU_ulTaskNotifyTake( BaseType_t xClearCountOnExit, TickType_t xTicksToWait );\r
-BaseType_t MPU_xTaskNotifyStateClear( TaskHandle_t xTask );\r
-BaseType_t MPU_xTaskIncrementTick( void );\r
-TaskHandle_t MPU_xTaskGetCurrentTaskHandle( void );\r
-void MPU_vTaskSetTimeOutState( TimeOut_t * const pxTimeOut );\r
-BaseType_t MPU_xTaskCheckForTimeOut( TimeOut_t * const pxTimeOut, TickType_t * const pxTicksToWait );\r
-void MPU_vTaskMissedYield( void );\r
-BaseType_t MPU_xTaskGetSchedulerState( void );\r
-\r
-/* MPU versions of queue.h API functions. */\r
-BaseType_t MPU_xQueueGenericSend( QueueHandle_t xQueue, const void * const pvItemToQueue, TickType_t xTicksToWait, const BaseType_t xCopyPosition );\r
-BaseType_t MPU_xQueueReceive( QueueHandle_t xQueue, void * const pvBuffer, TickType_t xTicksToWait );\r
-BaseType_t MPU_xQueuePeek( QueueHandle_t xQueue, void * const pvBuffer, TickType_t xTicksToWait );\r
-BaseType_t MPU_xQueueSemaphoreTake( QueueHandle_t xQueue, TickType_t xTicksToWait );\r
-UBaseType_t MPU_uxQueueMessagesWaiting( const QueueHandle_t xQueue );\r
-UBaseType_t MPU_uxQueueSpacesAvailable( const QueueHandle_t xQueue );\r
-void MPU_vQueueDelete( QueueHandle_t xQueue );\r
-QueueHandle_t MPU_xQueueCreateMutex( const uint8_t ucQueueType );\r
-QueueHandle_t MPU_xQueueCreateMutexStatic( const uint8_t ucQueueType, StaticQueue_t *pxStaticQueue );\r
-QueueHandle_t MPU_xQueueCreateCountingSemaphore( const UBaseType_t uxMaxCount, const UBaseType_t uxInitialCount );\r
-QueueHandle_t MPU_xQueueCreateCountingSemaphoreStatic( const UBaseType_t uxMaxCount, const UBaseType_t uxInitialCount, StaticQueue_t *pxStaticQueue );\r
-void* MPU_xQueueGetMutexHolder( QueueHandle_t xSemaphore );\r
-BaseType_t MPU_xQueueTakeMutexRecursive( QueueHandle_t xMutex, TickType_t xTicksToWait );\r
-BaseType_t MPU_xQueueGiveMutexRecursive( QueueHandle_t pxMutex );\r
-void MPU_vQueueAddToRegistry( QueueHandle_t xQueue, const char *pcName );\r
-void MPU_vQueueUnregisterQueue( QueueHandle_t xQueue );\r
-const char * MPU_pcQueueGetName( QueueHandle_t xQueue );\r
-QueueHandle_t MPU_xQueueGenericCreate( const UBaseType_t uxQueueLength, const UBaseType_t uxItemSize, const uint8_t ucQueueType );\r
-QueueHandle_t MPU_xQueueGenericCreateStatic( const UBaseType_t uxQueueLength, const UBaseType_t uxItemSize, uint8_t *pucQueueStorage, StaticQueue_t *pxStaticQueue, const uint8_t ucQueueType );\r
-QueueSetHandle_t MPU_xQueueCreateSet( const UBaseType_t uxEventQueueLength );\r
-BaseType_t MPU_xQueueAddToSet( QueueSetMemberHandle_t xQueueOrSemaphore, QueueSetHandle_t xQueueSet );\r
-BaseType_t MPU_xQueueRemoveFromSet( QueueSetMemberHandle_t xQueueOrSemaphore, QueueSetHandle_t xQueueSet );\r
-QueueSetMemberHandle_t MPU_xQueueSelectFromSet( QueueSetHandle_t xQueueSet, const TickType_t xTicksToWait );\r
-BaseType_t MPU_xQueueGenericReset( QueueHandle_t xQueue, BaseType_t xNewQueue );\r
-void MPU_vQueueSetQueueNumber( QueueHandle_t xQueue, UBaseType_t uxQueueNumber );\r
-UBaseType_t MPU_uxQueueGetQueueNumber( QueueHandle_t xQueue );\r
-uint8_t MPU_ucQueueGetQueueType( QueueHandle_t xQueue );\r
-\r
-/* MPU versions of timers.h API functions. */\r
-TimerHandle_t MPU_xTimerCreate( const char * const pcTimerName, const TickType_t xTimerPeriodInTicks, const UBaseType_t uxAutoReload, void * const pvTimerID, TimerCallbackFunction_t pxCallbackFunction );\r
-TimerHandle_t MPU_xTimerCreateStatic( const char * const pcTimerName, const TickType_t xTimerPeriodInTicks, const UBaseType_t uxAutoReload, void * const pvTimerID, TimerCallbackFunction_t pxCallbackFunction, StaticTimer_t *pxTimerBuffer );\r
-void * MPU_pvTimerGetTimerID( const TimerHandle_t xTimer );\r
-void MPU_vTimerSetTimerID( TimerHandle_t xTimer, void *pvNewID );\r
-BaseType_t MPU_xTimerIsTimerActive( TimerHandle_t xTimer );\r
-TaskHandle_t MPU_xTimerGetTimerDaemonTaskHandle( void );\r
-BaseType_t MPU_xTimerPendFunctionCall( PendedFunction_t xFunctionToPend, void *pvParameter1, uint32_t ulParameter2, TickType_t xTicksToWait );\r
-const char * MPU_pcTimerGetName( TimerHandle_t xTimer );\r
-TickType_t MPU_xTimerGetPeriod( TimerHandle_t xTimer );\r
-TickType_t MPU_xTimerGetExpiryTime( TimerHandle_t xTimer );\r
-BaseType_t MPU_xTimerCreateTimerTask( void );\r
-BaseType_t MPU_xTimerGenericCommand( TimerHandle_t xTimer, const BaseType_t xCommandID, const TickType_t xOptionalValue, BaseType_t * const pxHigherPriorityTaskWoken, const TickType_t xTicksToWait );\r
-\r
-/* MPU versions of event_group.h API functions. */\r
-EventGroupHandle_t MPU_xEventGroupCreate( void );\r
-EventGroupHandle_t MPU_xEventGroupCreateStatic( StaticEventGroup_t *pxEventGroupBuffer );\r
-EventBits_t MPU_xEventGroupWaitBits( EventGroupHandle_t xEventGroup, const EventBits_t uxBitsToWaitFor, const BaseType_t xClearOnExit, const BaseType_t xWaitForAllBits, TickType_t xTicksToWait );\r
-EventBits_t MPU_xEventGroupClearBits( EventGroupHandle_t xEventGroup, const EventBits_t uxBitsToClear );\r
-EventBits_t MPU_xEventGroupSetBits( EventGroupHandle_t xEventGroup, const EventBits_t uxBitsToSet );\r
-EventBits_t MPU_xEventGroupSync( EventGroupHandle_t xEventGroup, const EventBits_t uxBitsToSet, const EventBits_t uxBitsToWaitFor, TickType_t xTicksToWait );\r
-void MPU_vEventGroupDelete( EventGroupHandle_t xEventGroup );\r
-UBaseType_t MPU_uxEventGroupGetNumber( void* xEventGroup );\r
-\r
-/* MPU versions of message/stream_buffer.h API functions. */\r
-size_t MPU_xStreamBufferSend( StreamBufferHandle_t xStreamBuffer, const void *pvTxData, size_t xDataLengthBytes, TickType_t xTicksToWait );\r
-size_t MPU_xStreamBufferSendFromISR( StreamBufferHandle_t xStreamBuffer, const void *pvTxData, size_t xDataLengthBytes, BaseType_t * const pxHigherPriorityTaskWoken );\r
-size_t MPU_xStreamBufferReceive( StreamBufferHandle_t xStreamBuffer, void *pvRxData, size_t xBufferLengthBytes, TickType_t xTicksToWait );\r
-size_t MPU_xStreamBufferReceiveFromISR( StreamBufferHandle_t xStreamBuffer, void *pvRxData, size_t xBufferLengthBytes, BaseType_t * const pxHigherPriorityTaskWoken );\r
-void MPU_vStreamBufferDelete( StreamBufferHandle_t xStreamBuffer );\r
-BaseType_t MPU_xStreamBufferIsFull( StreamBufferHandle_t xStreamBuffer );\r
-BaseType_t MPU_xStreamBufferIsEmpty( StreamBufferHandle_t xStreamBuffer );\r
-BaseType_t MPU_xStreamBufferReset( StreamBufferHandle_t xStreamBuffer );\r
-size_t MPU_xStreamBufferSpacesAvailable( StreamBufferHandle_t xStreamBuffer );\r
-size_t MPU_xStreamBufferBytesAvailable( StreamBufferHandle_t xStreamBuffer );\r
-BaseType_t MPU_xStreamBufferSetTriggerLevel( StreamBufferHandle_t xStreamBuffer, size_t xTriggerLevel );\r
-StreamBufferHandle_t MPU_xStreamBufferGenericCreate( size_t xBufferSizeBytes, size_t xTriggerLevelBytes, BaseType_t xIsMessageBuffer );\r
-StreamBufferHandle_t MPU_xStreamBufferGenericCreateStatic( size_t xBufferSizeBytes, size_t xTriggerLevelBytes, BaseType_t xIsMessageBuffer, uint8_t * const pucStreamBufferStorageArea, StaticStreamBuffer_t * const pxStaticStreamBuffer );\r
-\r
-\r
-\r
-#endif /* MPU_PROTOTYPES_H */\r
-\r
+++ /dev/null
-/*\r
- * FreeRTOS Kernel V10.0.1\r
- * Copyright (C) 2017 Amazon.com, Inc. or its affiliates. All Rights Reserved.\r
- *\r
- * Permission is hereby granted, free of charge, to any person obtaining a copy of\r
- * this software and associated documentation files (the "Software"), to deal in\r
- * the Software without restriction, including without limitation the rights to\r
- * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of\r
- * the Software, and to permit persons to whom the Software is furnished to do so,\r
- * subject to the following conditions:\r
- *\r
- * The above copyright notice and this permission notice shall be included in all\r
- * copies or substantial portions of the Software.\r
- *\r
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\r
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS\r
- * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR\r
- * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER\r
- * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN\r
- * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\r
- *\r
- * http://www.FreeRTOS.org\r
- * http://aws.amazon.com/freertos\r
- *\r
- * 1 tab == 4 spaces!\r
- */\r
-\r
-#ifndef MPU_WRAPPERS_H\r
-#define MPU_WRAPPERS_H\r
-\r
-/* This file redefines API functions to be called through a wrapper macro, but\r
-only for ports that are using the MPU. */\r
-#ifdef portUSING_MPU_WRAPPERS\r
-\r
- /* MPU_WRAPPERS_INCLUDED_FROM_API_FILE will be defined when this file is\r
- included from queue.c or task.c to prevent it from having an effect within\r
- those files. */\r
- #ifndef MPU_WRAPPERS_INCLUDED_FROM_API_FILE\r
-\r
- /*\r
- * Map standard (non MPU) API functions to equivalents that start\r
- * "MPU_". This will cause the application code to call the MPU_\r
- * version, which wraps the non-MPU version with privilege promoting\r
- * then demoting code, so the kernel code always runs will full\r
- * privileges.\r
- */\r
-\r
- /* Map standard tasks.h API functions to the MPU equivalents. */\r
- #define xTaskCreate MPU_xTaskCreate\r
- #define xTaskCreateStatic MPU_xTaskCreateStatic\r
- #define xTaskCreateRestricted MPU_xTaskCreateRestricted\r
- #define vTaskAllocateMPURegions MPU_vTaskAllocateMPURegions\r
- #define vTaskDelete MPU_vTaskDelete\r
- #define vTaskDelay MPU_vTaskDelay\r
- #define vTaskDelayUntil MPU_vTaskDelayUntil\r
- #define xTaskAbortDelay MPU_xTaskAbortDelay\r
- #define uxTaskPriorityGet MPU_uxTaskPriorityGet\r
- #define eTaskGetState MPU_eTaskGetState\r
- #define vTaskGetInfo MPU_vTaskGetInfo\r
- #define vTaskPrioritySet MPU_vTaskPrioritySet\r
- #define vTaskSuspend MPU_vTaskSuspend\r
- #define vTaskResume MPU_vTaskResume\r
- #define vTaskSuspendAll MPU_vTaskSuspendAll\r
- #define xTaskResumeAll MPU_xTaskResumeAll\r
- #define xTaskGetTickCount MPU_xTaskGetTickCount\r
- #define uxTaskGetNumberOfTasks MPU_uxTaskGetNumberOfTasks\r
- #define pcTaskGetName MPU_pcTaskGetName\r
- #define xTaskGetHandle MPU_xTaskGetHandle\r
- #define uxTaskGetStackHighWaterMark MPU_uxTaskGetStackHighWaterMark\r
- #define vTaskSetApplicationTaskTag MPU_vTaskSetApplicationTaskTag\r
- #define xTaskGetApplicationTaskTag MPU_xTaskGetApplicationTaskTag\r
- #define vTaskSetThreadLocalStoragePointer MPU_vTaskSetThreadLocalStoragePointer\r
- #define pvTaskGetThreadLocalStoragePointer MPU_pvTaskGetThreadLocalStoragePointer\r
- #define xTaskCallApplicationTaskHook MPU_xTaskCallApplicationTaskHook\r
- #define xTaskGetIdleTaskHandle MPU_xTaskGetIdleTaskHandle\r
- #define uxTaskGetSystemState MPU_uxTaskGetSystemState\r
- #define vTaskList MPU_vTaskList\r
- #define vTaskGetRunTimeStats MPU_vTaskGetRunTimeStats\r
- #define xTaskGenericNotify MPU_xTaskGenericNotify\r
- #define xTaskNotifyWait MPU_xTaskNotifyWait\r
- #define ulTaskNotifyTake MPU_ulTaskNotifyTake\r
- #define xTaskNotifyStateClear MPU_xTaskNotifyStateClear\r
-\r
- #define xTaskGetCurrentTaskHandle MPU_xTaskGetCurrentTaskHandle\r
- #define vTaskSetTimeOutState MPU_vTaskSetTimeOutState\r
- #define xTaskCheckForTimeOut MPU_xTaskCheckForTimeOut\r
- #define xTaskGetSchedulerState MPU_xTaskGetSchedulerState\r
-\r
- /* Map standard queue.h API functions to the MPU equivalents. */\r
- #define xQueueGenericSend MPU_xQueueGenericSend\r
- #define xQueueReceive MPU_xQueueReceive\r
- #define xQueuePeek MPU_xQueuePeek\r
- #define xQueueSemaphoreTake MPU_xQueueSemaphoreTake\r
- #define uxQueueMessagesWaiting MPU_uxQueueMessagesWaiting\r
- #define uxQueueSpacesAvailable MPU_uxQueueSpacesAvailable\r
- #define vQueueDelete MPU_vQueueDelete\r
- #define xQueueCreateMutex MPU_xQueueCreateMutex\r
- #define xQueueCreateMutexStatic MPU_xQueueCreateMutexStatic\r
- #define xQueueCreateCountingSemaphore MPU_xQueueCreateCountingSemaphore\r
- #define xQueueCreateCountingSemaphoreStatic MPU_xQueueCreateCountingSemaphoreStatic\r
- #define xQueueGetMutexHolder MPU_xQueueGetMutexHolder\r
- #define xQueueTakeMutexRecursive MPU_xQueueTakeMutexRecursive\r
- #define xQueueGiveMutexRecursive MPU_xQueueGiveMutexRecursive\r
- #define xQueueGenericCreate MPU_xQueueGenericCreate\r
- #define xQueueGenericCreateStatic MPU_xQueueGenericCreateStatic\r
- #define xQueueCreateSet MPU_xQueueCreateSet\r
- #define xQueueAddToSet MPU_xQueueAddToSet\r
- #define xQueueRemoveFromSet MPU_xQueueRemoveFromSet\r
- #define xQueueSelectFromSet MPU_xQueueSelectFromSet\r
- #define xQueueGenericReset MPU_xQueueGenericReset\r
-\r
- #if( configQUEUE_REGISTRY_SIZE > 0 )\r
- #define vQueueAddToRegistry MPU_vQueueAddToRegistry\r
- #define vQueueUnregisterQueue MPU_vQueueUnregisterQueue\r
- #define pcQueueGetName MPU_pcQueueGetName\r
- #endif\r
-\r
- /* Map standard timer.h API functions to the MPU equivalents. */\r
- #define xTimerCreate MPU_xTimerCreate\r
- #define xTimerCreateStatic MPU_xTimerCreateStatic\r
- #define pvTimerGetTimerID MPU_pvTimerGetTimerID\r
- #define vTimerSetTimerID MPU_vTimerSetTimerID\r
- #define xTimerIsTimerActive MPU_xTimerIsTimerActive\r
- #define xTimerGetTimerDaemonTaskHandle MPU_xTimerGetTimerDaemonTaskHandle\r
- #define xTimerPendFunctionCall MPU_xTimerPendFunctionCall\r
- #define pcTimerGetName MPU_pcTimerGetName\r
- #define xTimerGetPeriod MPU_xTimerGetPeriod\r
- #define xTimerGetExpiryTime MPU_xTimerGetExpiryTime\r
- #define xTimerGenericCommand MPU_xTimerGenericCommand\r
-\r
- /* Map standard event_group.h API functions to the MPU equivalents. */\r
- #define xEventGroupCreate MPU_xEventGroupCreate\r
- #define xEventGroupCreateStatic MPU_xEventGroupCreateStatic\r
- #define xEventGroupWaitBits MPU_xEventGroupWaitBits\r
- #define xEventGroupClearBits MPU_xEventGroupClearBits\r
- #define xEventGroupSetBits MPU_xEventGroupSetBits\r
- #define xEventGroupSync MPU_xEventGroupSync\r
- #define vEventGroupDelete MPU_vEventGroupDelete\r
-\r
- /* Map standard message/stream_buffer.h API functions to the MPU\r
- equivalents. */\r
- #define xStreamBufferSend MPU_xStreamBufferSend\r
- #define xStreamBufferSendFromISR MPU_xStreamBufferSendFromISR\r
- #define xStreamBufferReceive MPU_xStreamBufferReceive\r
- #define xStreamBufferReceiveFromISR MPU_xStreamBufferReceiveFromISR\r
- #define vStreamBufferDelete MPU_vStreamBufferDelete\r
- #define xStreamBufferIsFull MPU_xStreamBufferIsFull\r
- #define xStreamBufferIsEmpty MPU_xStreamBufferIsEmpty\r
- #define xStreamBufferReset MPU_xStreamBufferReset\r
- #define xStreamBufferSpacesAvailable MPU_xStreamBufferSpacesAvailable\r
- #define xStreamBufferBytesAvailable MPU_xStreamBufferBytesAvailable\r
- #define xStreamBufferSetTriggerLevel MPU_xStreamBufferSetTriggerLevel\r
- #define xStreamBufferGenericCreate MPU_xStreamBufferGenericCreate\r
- #define xStreamBufferGenericCreateStatic MPU_xStreamBufferGenericCreateStatic\r
-\r
-\r
- /* Remove the privileged function macro, but keep the PRIVILEGED_DATA\r
- macro so applications can place data in privileged access sections\r
- (useful when using statically allocated objects). */\r
- #define PRIVILEGED_FUNCTION\r
- #define PRIVILEGED_DATA __attribute__((section("privileged_data")))\r
-\r
- #else /* MPU_WRAPPERS_INCLUDED_FROM_API_FILE */\r
-\r
- /* Ensure API functions go in the privileged execution section. */\r
- #define PRIVILEGED_FUNCTION __attribute__((section("privileged_functions")))\r
- #define PRIVILEGED_DATA __attribute__((section("privileged_data")))\r
-\r
- #endif /* MPU_WRAPPERS_INCLUDED_FROM_API_FILE */\r
-\r
-#else /* portUSING_MPU_WRAPPERS */\r
-\r
- #define PRIVILEGED_FUNCTION\r
- #define PRIVILEGED_DATA\r
- #define portUSING_MPU_WRAPPERS 0\r
-\r
-#endif /* portUSING_MPU_WRAPPERS */\r
-\r
-\r
-#endif /* MPU_WRAPPERS_H */\r
-\r
+++ /dev/null
-/*\r
- * FreeRTOS Kernel V10.0.1\r
- * Copyright (C) 2017 Amazon.com, Inc. or its affiliates. All Rights Reserved.\r
- *\r
- * Permission is hereby granted, free of charge, to any person obtaining a copy of\r
- * this software and associated documentation files (the "Software"), to deal in\r
- * the Software without restriction, including without limitation the rights to\r
- * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of\r
- * the Software, and to permit persons to whom the Software is furnished to do so,\r
- * subject to the following conditions:\r
- *\r
- * The above copyright notice and this permission notice shall be included in all\r
- * copies or substantial portions of the Software.\r
- *\r
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\r
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS\r
- * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR\r
- * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER\r
- * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN\r
- * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\r
- *\r
- * http://www.FreeRTOS.org\r
- * http://aws.amazon.com/freertos\r
- *\r
- * 1 tab == 4 spaces!\r
- */\r
-\r
-/*-----------------------------------------------------------\r
- * Portable layer API. Each function must be defined for each port.\r
- *----------------------------------------------------------*/\r
-\r
-#ifndef PORTABLE_H\r
-#define PORTABLE_H\r
-\r
-/* Each FreeRTOS port has a unique portmacro.h header file. Originally a\r
-pre-processor definition was used to ensure the pre-processor found the correct\r
-portmacro.h file for the port being used. That scheme was deprecated in favour\r
-of setting the compiler's include path such that it found the correct\r
-portmacro.h file - removing the need for the constant and allowing the\r
-portmacro.h file to be located anywhere in relation to the port being used.\r
-Purely for reasons of backward compatibility the old method is still valid, but\r
-to make it clear that new projects should not use it, support for the port\r
-specific constants has been moved into the deprecated_definitions.h header\r
-file. */\r
-#include "deprecated_definitions.h"\r
-\r
-/* If portENTER_CRITICAL is not defined then including deprecated_definitions.h\r
-did not result in a portmacro.h header file being included - and it should be\r
-included here. In this case the path to the correct portmacro.h header file\r
-must be set in the compiler's include path. */\r
-#ifndef portENTER_CRITICAL\r
- #include "portmacro.h"\r
-#endif\r
-\r
-#if portBYTE_ALIGNMENT == 32\r
- #define portBYTE_ALIGNMENT_MASK ( 0x001f )\r
-#endif\r
-\r
-#if portBYTE_ALIGNMENT == 16\r
- #define portBYTE_ALIGNMENT_MASK ( 0x000f )\r
-#endif\r
-\r
-#if portBYTE_ALIGNMENT == 8\r
- #define portBYTE_ALIGNMENT_MASK ( 0x0007 )\r
-#endif\r
-\r
-#if portBYTE_ALIGNMENT == 4\r
- #define portBYTE_ALIGNMENT_MASK ( 0x0003 )\r
-#endif\r
-\r
-#if portBYTE_ALIGNMENT == 2\r
- #define portBYTE_ALIGNMENT_MASK ( 0x0001 )\r
-#endif\r
-\r
-#if portBYTE_ALIGNMENT == 1\r
- #define portBYTE_ALIGNMENT_MASK ( 0x0000 )\r
-#endif\r
-\r
-#ifndef portBYTE_ALIGNMENT_MASK\r
- #error "Invalid portBYTE_ALIGNMENT definition"\r
-#endif\r
-\r
-#ifndef portNUM_CONFIGURABLE_REGIONS\r
- #define portNUM_CONFIGURABLE_REGIONS 1\r
-#endif\r
-\r
-#ifdef __cplusplus\r
-extern "C" {\r
-#endif\r
-\r
-#include "mpu_wrappers.h"\r
-\r
-/*\r
- * Setup the stack of a new task so it is ready to be placed under the\r
- * scheduler control. The registers have to be placed on the stack in\r
- * the order that the port expects to find them.\r
- *\r
- */\r
-#if( portUSING_MPU_WRAPPERS == 1 )\r
- StackType_t *pxPortInitialiseStack( StackType_t *pxTopOfStack, TaskFunction_t pxCode, void *pvParameters, BaseType_t xRunPrivileged ) PRIVILEGED_FUNCTION;\r
-#else\r
- StackType_t *pxPortInitialiseStack( StackType_t *pxTopOfStack, TaskFunction_t pxCode, void *pvParameters ) PRIVILEGED_FUNCTION;\r
-#endif\r
-\r
-/* Used by heap_5.c. */\r
-typedef struct HeapRegion\r
-{\r
- uint8_t *pucStartAddress;\r
- size_t xSizeInBytes;\r
-} HeapRegion_t;\r
-\r
-/*\r
- * Used to define multiple heap regions for use by heap_5.c. This function\r
- * must be called before any calls to pvPortMalloc() - not creating a task,\r
- * queue, semaphore, mutex, software timer, event group, etc. will result in\r
- * pvPortMalloc being called.\r
- *\r
- * pxHeapRegions passes in an array of HeapRegion_t structures - each of which\r
- * defines a region of memory that can be used as the heap. The array is\r
- * terminated by a HeapRegions_t structure that has a size of 0. The region\r
- * with the lowest start address must appear first in the array.\r
- */\r
-void vPortDefineHeapRegions( const HeapRegion_t * const pxHeapRegions ) PRIVILEGED_FUNCTION;\r
-\r
-\r
-/*\r
- * Map to the memory management routines required for the port.\r
- */\r
-void *pvPortMalloc( size_t xSize ) PRIVILEGED_FUNCTION;\r
-void vPortFree( void *pv ) PRIVILEGED_FUNCTION;\r
-void vPortInitialiseBlocks( void ) PRIVILEGED_FUNCTION;\r
-size_t xPortGetFreeHeapSize( void ) PRIVILEGED_FUNCTION;\r
-size_t xPortGetMinimumEverFreeHeapSize( void ) PRIVILEGED_FUNCTION;\r
-\r
-/*\r
- * Setup the hardware ready for the scheduler to take control. This generally\r
- * sets up a tick interrupt and sets timers for the correct tick frequency.\r
- */\r
-BaseType_t xPortStartScheduler( void ) PRIVILEGED_FUNCTION;\r
-\r
-/*\r
- * Undo any hardware/ISR setup that was performed by xPortStartScheduler() so\r
- * the hardware is left in its original condition after the scheduler stops\r
- * executing.\r
- */\r
-void vPortEndScheduler( void ) PRIVILEGED_FUNCTION;\r
-\r
-/*\r
- * The structures and methods of manipulating the MPU are contained within the\r
- * port layer.\r
- *\r
- * Fills the xMPUSettings structure with the memory region information\r
- * contained in xRegions.\r
- */\r
-#if( portUSING_MPU_WRAPPERS == 1 )\r
- struct xMEMORY_REGION;\r
- void vPortStoreTaskMPUSettings( xMPU_SETTINGS *xMPUSettings, const struct xMEMORY_REGION * const xRegions, StackType_t *pxBottomOfStack, uint32_t ulStackDepth ) PRIVILEGED_FUNCTION;\r
-#endif\r
-\r
-#ifdef __cplusplus\r
-}\r
-#endif\r
-\r
-#endif /* PORTABLE_H */\r
-\r
+++ /dev/null
-/*
- * ------------------------------------------------------------------------
- * File Name: portmacro.h
- * Author: Zhao Yanbai
- * 2018-07-28 13:25:04 Saturday CST
- * Description: none
- * ------------------------------------------------------------------------
- */
-
-#pragma once
-
-#define portCHAR int8_t
-#define portFLOAT float
-#define portDOUBLE double
-#define portLONG int32_t
-#define portSHORT int16_t
-#define portSTACK_TYPE uint8_t
-#define portBASE_TYPE int
-
-typedef portSTACK_TYPE StackType_t;
-typedef portBASE_TYPE BaseType_t;
-typedef unsigned portBASE_TYPE UBaseType_t;
-
-typedef uint32_t TickType_t;
-#define portMAX_DELAY ( TickType_t ) 0xffffffffUL
-
-#define portBYTE_ALIGNMENT 4
-#define portSTACK_GROWTH ( -1 )
-#define portTICK_PERIOD_MS ( ( TickType_t ) 1000 / 100)
-
-// TODO BELOW
-#define portYIELD()
-
-
-// Need to Modify, see esp idf source code
-#define portENTER_CRITICAL()
-#define portEXIT_CRITICAL()
-
-
-#define portDISABLE_INTERRUPTS()
-#define portENABLE_INTERRUPTS()
-
-#define portTASK_FUNCTION_PROTO( vFunction, pvParameters ) void vFunction( void *pvParameters )
-#define portTASK_FUNCTION( vFunction, pvParameters ) void vFunction( void *pvParameters )
+++ /dev/null
-/*\r
- * FreeRTOS Kernel V10.0.1\r
- * Copyright (C) 2017 Amazon.com, Inc. or its affiliates. All Rights Reserved.\r
- *\r
- * Permission is hereby granted, free of charge, to any person obtaining a copy of\r
- * this software and associated documentation files (the "Software"), to deal in\r
- * the Software without restriction, including without limitation the rights to\r
- * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of\r
- * the Software, and to permit persons to whom the Software is furnished to do so,\r
- * subject to the following conditions:\r
- *\r
- * The above copyright notice and this permission notice shall be included in all\r
- * copies or substantial portions of the Software.\r
- *\r
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\r
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS\r
- * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR\r
- * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER\r
- * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN\r
- * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\r
- *\r
- * http://www.FreeRTOS.org\r
- * http://aws.amazon.com/freertos\r
- *\r
- * 1 tab == 4 spaces!\r
- */\r
-\r
-#ifndef PROJDEFS_H\r
-#define PROJDEFS_H\r
-\r
-/*\r
- * Defines the prototype to which task functions must conform. Defined in this\r
- * file to ensure the type is known before portable.h is included.\r
- */\r
-typedef void (*TaskFunction_t)( void * );\r
-\r
-/* Converts a time in milliseconds to a time in ticks. This macro can be\r
-overridden by a macro of the same name defined in FreeRTOSConfig.h in case the\r
-definition here is not suitable for your application. */\r
-#ifndef pdMS_TO_TICKS\r
- #define pdMS_TO_TICKS( xTimeInMs ) ( ( TickType_t ) ( ( ( TickType_t ) ( xTimeInMs ) * ( TickType_t ) configTICK_RATE_HZ ) / ( TickType_t ) 1000 ) )\r
-#endif\r
-\r
-#define pdFALSE ( ( BaseType_t ) 0 )\r
-#define pdTRUE ( ( BaseType_t ) 1 )\r
-\r
-#define pdPASS ( pdTRUE )\r
-#define pdFAIL ( pdFALSE )\r
-#define errQUEUE_EMPTY ( ( BaseType_t ) 0 )\r
-#define errQUEUE_FULL ( ( BaseType_t ) 0 )\r
-\r
-/* FreeRTOS error definitions. */\r
-#define errCOULD_NOT_ALLOCATE_REQUIRED_MEMORY ( -1 )\r
-#define errQUEUE_BLOCKED ( -4 )\r
-#define errQUEUE_YIELD ( -5 )\r
-\r
-/* Macros used for basic data corruption checks. */\r
-#ifndef configUSE_LIST_DATA_INTEGRITY_CHECK_BYTES\r
- #define configUSE_LIST_DATA_INTEGRITY_CHECK_BYTES 0\r
-#endif\r
-\r
-#if( configUSE_16_BIT_TICKS == 1 )\r
- #define pdINTEGRITY_CHECK_VALUE 0x5a5a\r
-#else\r
- #define pdINTEGRITY_CHECK_VALUE 0x5a5a5a5aUL\r
-#endif\r
-\r
-/* The following errno values are used by FreeRTOS+ components, not FreeRTOS\r
-itself. */\r
-#define pdFREERTOS_ERRNO_NONE 0 /* No errors */\r
-#define pdFREERTOS_ERRNO_ENOENT 2 /* No such file or directory */\r
-#define pdFREERTOS_ERRNO_EINTR 4 /* Interrupted system call */\r
-#define pdFREERTOS_ERRNO_EIO 5 /* I/O error */\r
-#define pdFREERTOS_ERRNO_ENXIO 6 /* No such device or address */\r
-#define pdFREERTOS_ERRNO_EBADF 9 /* Bad file number */\r
-#define pdFREERTOS_ERRNO_EAGAIN 11 /* No more processes */\r
-#define pdFREERTOS_ERRNO_EWOULDBLOCK 11 /* Operation would block */\r
-#define pdFREERTOS_ERRNO_ENOMEM 12 /* Not enough memory */\r
-#define pdFREERTOS_ERRNO_EACCES 13 /* Permission denied */\r
-#define pdFREERTOS_ERRNO_EFAULT 14 /* Bad address */\r
-#define pdFREERTOS_ERRNO_EBUSY 16 /* Mount device busy */\r
-#define pdFREERTOS_ERRNO_EEXIST 17 /* File exists */\r
-#define pdFREERTOS_ERRNO_EXDEV 18 /* Cross-device link */\r
-#define pdFREERTOS_ERRNO_ENODEV 19 /* No such device */\r
-#define pdFREERTOS_ERRNO_ENOTDIR 20 /* Not a directory */\r
-#define pdFREERTOS_ERRNO_EISDIR 21 /* Is a directory */\r
-#define pdFREERTOS_ERRNO_EINVAL 22 /* Invalid argument */\r
-#define pdFREERTOS_ERRNO_ENOSPC 28 /* No space left on device */\r
-#define pdFREERTOS_ERRNO_ESPIPE 29 /* Illegal seek */\r
-#define pdFREERTOS_ERRNO_EROFS 30 /* Read only file system */\r
-#define pdFREERTOS_ERRNO_EUNATCH 42 /* Protocol driver not attached */\r
-#define pdFREERTOS_ERRNO_EBADE 50 /* Invalid exchange */\r
-#define pdFREERTOS_ERRNO_EFTYPE 79 /* Inappropriate file type or format */\r
-#define pdFREERTOS_ERRNO_ENMFILE 89 /* No more files */\r
-#define pdFREERTOS_ERRNO_ENOTEMPTY 90 /* Directory not empty */\r
-#define pdFREERTOS_ERRNO_ENAMETOOLONG 91 /* File or path name too long */\r
-#define pdFREERTOS_ERRNO_EOPNOTSUPP 95 /* Operation not supported on transport endpoint */\r
-#define pdFREERTOS_ERRNO_ENOBUFS 105 /* No buffer space available */\r
-#define pdFREERTOS_ERRNO_ENOPROTOOPT 109 /* Protocol not available */\r
-#define pdFREERTOS_ERRNO_EADDRINUSE 112 /* Address already in use */\r
-#define pdFREERTOS_ERRNO_ETIMEDOUT 116 /* Connection timed out */\r
-#define pdFREERTOS_ERRNO_EINPROGRESS 119 /* Connection already in progress */\r
-#define pdFREERTOS_ERRNO_EALREADY 120 /* Socket already connected */\r
-#define pdFREERTOS_ERRNO_EADDRNOTAVAIL 125 /* Address not available */\r
-#define pdFREERTOS_ERRNO_EISCONN 127 /* Socket is already connected */\r
-#define pdFREERTOS_ERRNO_ENOTCONN 128 /* Socket is not connected */\r
-#define pdFREERTOS_ERRNO_ENOMEDIUM 135 /* No medium inserted */\r
-#define pdFREERTOS_ERRNO_EILSEQ 138 /* An invalid UTF-16 sequence was encountered. */\r
-#define pdFREERTOS_ERRNO_ECANCELED 140 /* Operation canceled. */\r
-\r
-/* The following endian values are used by FreeRTOS+ components, not FreeRTOS\r
-itself. */\r
-#define pdFREERTOS_LITTLE_ENDIAN 0\r
-#define pdFREERTOS_BIG_ENDIAN 1\r
-\r
-/* Re-defining endian values for generic naming. */\r
-#define pdLITTLE_ENDIAN pdFREERTOS_LITTLE_ENDIAN\r
-#define pdBIG_ENDIAN pdFREERTOS_BIG_ENDIAN\r
-\r
-\r
-#endif /* PROJDEFS_H */\r
-\r
-\r
-\r
+++ /dev/null
-/*\r
- * FreeRTOS Kernel V10.0.1\r
- * Copyright (C) 2017 Amazon.com, Inc. or its affiliates. All Rights Reserved.\r
- *\r
- * Permission is hereby granted, free of charge, to any person obtaining a copy of\r
- * this software and associated documentation files (the "Software"), to deal in\r
- * the Software without restriction, including without limitation the rights to\r
- * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of\r
- * the Software, and to permit persons to whom the Software is furnished to do so,\r
- * subject to the following conditions:\r
- *\r
- * The above copyright notice and this permission notice shall be included in all\r
- * copies or substantial portions of the Software.\r
- *\r
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\r
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS\r
- * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR\r
- * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER\r
- * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN\r
- * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\r
- *\r
- * http://www.FreeRTOS.org\r
- * http://aws.amazon.com/freertos\r
- *\r
- * 1 tab == 4 spaces!\r
- */\r
-\r
-\r
-#ifndef QUEUE_H\r
-#define QUEUE_H\r
-\r
-#ifndef INC_FREERTOS_H\r
- #error "include FreeRTOS.h" must appear in source files before "include queue.h"\r
-#endif\r
-\r
-#ifdef __cplusplus\r
-extern "C" {\r
-#endif\r
-\r
-\r
-/**\r
- * Type by which queues are referenced. For example, a call to xQueueCreate()\r
- * returns an QueueHandle_t variable that can then be used as a parameter to\r
- * xQueueSend(), xQueueReceive(), etc.\r
- */\r
-typedef void * QueueHandle_t;\r
-\r
-/**\r
- * Type by which queue sets are referenced. For example, a call to\r
- * xQueueCreateSet() returns an xQueueSet variable that can then be used as a\r
- * parameter to xQueueSelectFromSet(), xQueueAddToSet(), etc.\r
- */\r
-typedef void * QueueSetHandle_t;\r
-\r
-/**\r
- * Queue sets can contain both queues and semaphores, so the\r
- * QueueSetMemberHandle_t is defined as a type to be used where a parameter or\r
- * return value can be either an QueueHandle_t or an SemaphoreHandle_t.\r
- */\r
-typedef void * QueueSetMemberHandle_t;\r
-\r
-/* For internal use only. */\r
-#define queueSEND_TO_BACK ( ( BaseType_t ) 0 )\r
-#define queueSEND_TO_FRONT ( ( BaseType_t ) 1 )\r
-#define queueOVERWRITE ( ( BaseType_t ) 2 )\r
-\r
-/* For internal use only. These definitions *must* match those in queue.c. */\r
-#define queueQUEUE_TYPE_BASE ( ( uint8_t ) 0U )\r
-#define queueQUEUE_TYPE_SET ( ( uint8_t ) 0U )\r
-#define queueQUEUE_TYPE_MUTEX ( ( uint8_t ) 1U )\r
-#define queueQUEUE_TYPE_COUNTING_SEMAPHORE ( ( uint8_t ) 2U )\r
-#define queueQUEUE_TYPE_BINARY_SEMAPHORE ( ( uint8_t ) 3U )\r
-#define queueQUEUE_TYPE_RECURSIVE_MUTEX ( ( uint8_t ) 4U )\r
-\r
-/**\r
- * queue. h\r
- * <pre>\r
- QueueHandle_t xQueueCreate(\r
- UBaseType_t uxQueueLength,\r
- UBaseType_t uxItemSize\r
- );\r
- * </pre>\r
- *\r
- * Creates a new queue instance, and returns a handle by which the new queue\r
- * can be referenced.\r
- *\r
- * Internally, within the FreeRTOS implementation, queues use two blocks of\r
- * memory. The first block is used to hold the queue's data structures. The\r
- * second block is used to hold items placed into the queue. If a queue is\r
- * created using xQueueCreate() then both blocks of memory are automatically\r
- * dynamically allocated inside the xQueueCreate() function. (see\r
- * http://www.freertos.org/a00111.html). If a queue is created using\r
- * xQueueCreateStatic() then the application writer must provide the memory that\r
- * will get used by the queue. xQueueCreateStatic() therefore allows a queue to\r
- * be created without using any dynamic memory allocation.\r
- *\r
- * http://www.FreeRTOS.org/Embedded-RTOS-Queues.html\r
- *\r
- * @param uxQueueLength The maximum number of items that the queue can contain.\r
- *\r
- * @param uxItemSize The number of bytes each item in the queue will require.\r
- * Items are queued by copy, not by reference, so this is the number of bytes\r
- * that will be copied for each posted item. Each item on the queue must be\r
- * the same size.\r
- *\r
- * @return If the queue is successfully create then a handle to the newly\r
- * created queue is returned. If the queue cannot be created then 0 is\r
- * returned.\r
- *\r
- * Example usage:\r
- <pre>\r
- struct AMessage\r
- {\r
- char ucMessageID;\r
- char ucData[ 20 ];\r
- };\r
-\r
- void vATask( void *pvParameters )\r
- {\r
- QueueHandle_t xQueue1, xQueue2;\r
-\r
- // Create a queue capable of containing 10 uint32_t values.\r
- xQueue1 = xQueueCreate( 10, sizeof( uint32_t ) );\r
- if( xQueue1 == 0 )\r
- {\r
- // Queue was not created and must not be used.\r
- }\r
-\r
- // Create a queue capable of containing 10 pointers to AMessage structures.\r
- // These should be passed by pointer as they contain a lot of data.\r
- xQueue2 = xQueueCreate( 10, sizeof( struct AMessage * ) );\r
- if( xQueue2 == 0 )\r
- {\r
- // Queue was not created and must not be used.\r
- }\r
-\r
- // ... Rest of task code.\r
- }\r
- </pre>\r
- * \defgroup xQueueCreate xQueueCreate\r
- * \ingroup QueueManagement\r
- */\r
-#if( configSUPPORT_DYNAMIC_ALLOCATION == 1 )\r
- #define xQueueCreate( uxQueueLength, uxItemSize ) xQueueGenericCreate( ( uxQueueLength ), ( uxItemSize ), ( queueQUEUE_TYPE_BASE ) )\r
-#endif\r
-\r
-/**\r
- * queue. h\r
- * <pre>\r
- QueueHandle_t xQueueCreateStatic(\r
- UBaseType_t uxQueueLength,\r
- UBaseType_t uxItemSize,\r
- uint8_t *pucQueueStorageBuffer,\r
- StaticQueue_t *pxQueueBuffer\r
- );\r
- * </pre>\r
- *\r
- * Creates a new queue instance, and returns a handle by which the new queue\r
- * can be referenced.\r
- *\r
- * Internally, within the FreeRTOS implementation, queues use two blocks of\r
- * memory. The first block is used to hold the queue's data structures. The\r
- * second block is used to hold items placed into the queue. If a queue is\r
- * created using xQueueCreate() then both blocks of memory are automatically\r
- * dynamically allocated inside the xQueueCreate() function. (see\r
- * http://www.freertos.org/a00111.html). If a queue is created using\r
- * xQueueCreateStatic() then the application writer must provide the memory that\r
- * will get used by the queue. xQueueCreateStatic() therefore allows a queue to\r
- * be created without using any dynamic memory allocation.\r
- *\r
- * http://www.FreeRTOS.org/Embedded-RTOS-Queues.html\r
- *\r
- * @param uxQueueLength The maximum number of items that the queue can contain.\r
- *\r
- * @param uxItemSize The number of bytes each item in the queue will require.\r
- * Items are queued by copy, not by reference, so this is the number of bytes\r
- * that will be copied for each posted item. Each item on the queue must be\r
- * the same size.\r
- *\r
- * @param pucQueueStorageBuffer If uxItemSize is not zero then\r
- * pucQueueStorageBuffer must point to a uint8_t array that is at least large\r
- * enough to hold the maximum number of items that can be in the queue at any\r
- * one time - which is ( uxQueueLength * uxItemsSize ) bytes. If uxItemSize is\r
- * zero then pucQueueStorageBuffer can be NULL.\r
- *\r
- * @param pxQueueBuffer Must point to a variable of type StaticQueue_t, which\r
- * will be used to hold the queue's data structure.\r
- *\r
- * @return If the queue is created then a handle to the created queue is\r
- * returned. If pxQueueBuffer is NULL then NULL is returned.\r
- *\r
- * Example usage:\r
- <pre>\r
- struct AMessage\r
- {\r
- char ucMessageID;\r
- char ucData[ 20 ];\r
- };\r
-\r
- #define QUEUE_LENGTH 10\r
- #define ITEM_SIZE sizeof( uint32_t )\r
-\r
- // xQueueBuffer will hold the queue structure.\r
- StaticQueue_t xQueueBuffer;\r
-\r
- // ucQueueStorage will hold the items posted to the queue. Must be at least\r
- // [(queue length) * ( queue item size)] bytes long.\r
- uint8_t ucQueueStorage[ QUEUE_LENGTH * ITEM_SIZE ];\r
-\r
- void vATask( void *pvParameters )\r
- {\r
- QueueHandle_t xQueue1;\r
-\r
- // Create a queue capable of containing 10 uint32_t values.\r
- xQueue1 = xQueueCreate( QUEUE_LENGTH, // The number of items the queue can hold.\r
- ITEM_SIZE // The size of each item in the queue\r
- &( ucQueueStorage[ 0 ] ), // The buffer that will hold the items in the queue.\r
- &xQueueBuffer ); // The buffer that will hold the queue structure.\r
-\r
- // The queue is guaranteed to be created successfully as no dynamic memory\r
- // allocation is used. Therefore xQueue1 is now a handle to a valid queue.\r
-\r
- // ... Rest of task code.\r
- }\r
- </pre>\r
- * \defgroup xQueueCreateStatic xQueueCreateStatic\r
- * \ingroup QueueManagement\r
- */\r
-#if( configSUPPORT_STATIC_ALLOCATION == 1 )\r
- #define xQueueCreateStatic( uxQueueLength, uxItemSize, pucQueueStorage, pxQueueBuffer ) xQueueGenericCreateStatic( ( uxQueueLength ), ( uxItemSize ), ( pucQueueStorage ), ( pxQueueBuffer ), ( queueQUEUE_TYPE_BASE ) )\r
-#endif /* configSUPPORT_STATIC_ALLOCATION */\r
-\r
-/**\r
- * queue. h\r
- * <pre>\r
- BaseType_t xQueueSendToToFront(\r
- QueueHandle_t xQueue,\r
- const void *pvItemToQueue,\r
- TickType_t xTicksToWait\r
- );\r
- * </pre>\r
- *\r
- * Post an item to the front of a queue. The item is queued by copy, not by\r
- * reference. This function must not be called from an interrupt service\r
- * routine. See xQueueSendFromISR () for an alternative which may be used\r
- * in an ISR.\r
- *\r
- * @param xQueue The handle to the queue on which the item is to be posted.\r
- *\r
- * @param pvItemToQueue A pointer to the item that is to be placed on the\r
- * queue. The size of the items the queue will hold was defined when the\r
- * queue was created, so this many bytes will be copied from pvItemToQueue\r
- * into the queue storage area.\r
- *\r
- * @param xTicksToWait The maximum amount of time the task should block\r
- * waiting for space to become available on the queue, should it already\r
- * be full. The call will return immediately if this is set to 0 and the\r
- * queue is full. The time is defined in tick periods so the constant\r
- * portTICK_PERIOD_MS should be used to convert to real time if this is required.\r
- *\r
- * @return pdTRUE if the item was successfully posted, otherwise errQUEUE_FULL.\r
- *\r
- * Example usage:\r
- <pre>\r
- struct AMessage\r
- {\r
- char ucMessageID;\r
- char ucData[ 20 ];\r
- } xMessage;\r
-\r
- uint32_t ulVar = 10UL;\r
-\r
- void vATask( void *pvParameters )\r
- {\r
- QueueHandle_t xQueue1, xQueue2;\r
- struct AMessage *pxMessage;\r
-\r
- // Create a queue capable of containing 10 uint32_t values.\r
- xQueue1 = xQueueCreate( 10, sizeof( uint32_t ) );\r
-\r
- // Create a queue capable of containing 10 pointers to AMessage structures.\r
- // These should be passed by pointer as they contain a lot of data.\r
- xQueue2 = xQueueCreate( 10, sizeof( struct AMessage * ) );\r
-\r
- // ...\r
-\r
- if( xQueue1 != 0 )\r
- {\r
- // Send an uint32_t. Wait for 10 ticks for space to become\r
- // available if necessary.\r
- if( xQueueSendToFront( xQueue1, ( void * ) &ulVar, ( TickType_t ) 10 ) != pdPASS )\r
- {\r
- // Failed to post the message, even after 10 ticks.\r
- }\r
- }\r
-\r
- if( xQueue2 != 0 )\r
- {\r
- // Send a pointer to a struct AMessage object. Don't block if the\r
- // queue is already full.\r
- pxMessage = & xMessage;\r
- xQueueSendToFront( xQueue2, ( void * ) &pxMessage, ( TickType_t ) 0 );\r
- }\r
-\r
- // ... Rest of task code.\r
- }\r
- </pre>\r
- * \defgroup xQueueSend xQueueSend\r
- * \ingroup QueueManagement\r
- */\r
-#define xQueueSendToFront( xQueue, pvItemToQueue, xTicksToWait ) xQueueGenericSend( ( xQueue ), ( pvItemToQueue ), ( xTicksToWait ), queueSEND_TO_FRONT )\r
-\r
-/**\r
- * queue. h\r
- * <pre>\r
- BaseType_t xQueueSendToBack(\r
- QueueHandle_t xQueue,\r
- const void *pvItemToQueue,\r
- TickType_t xTicksToWait\r
- );\r
- * </pre>\r
- *\r
- * This is a macro that calls xQueueGenericSend().\r
- *\r
- * Post an item to the back of a queue. The item is queued by copy, not by\r
- * reference. This function must not be called from an interrupt service\r
- * routine. See xQueueSendFromISR () for an alternative which may be used\r
- * in an ISR.\r
- *\r
- * @param xQueue The handle to the queue on which the item is to be posted.\r
- *\r
- * @param pvItemToQueue A pointer to the item that is to be placed on the\r
- * queue. The size of the items the queue will hold was defined when the\r
- * queue was created, so this many bytes will be copied from pvItemToQueue\r
- * into the queue storage area.\r
- *\r
- * @param xTicksToWait The maximum amount of time the task should block\r
- * waiting for space to become available on the queue, should it already\r
- * be full. The call will return immediately if this is set to 0 and the queue\r
- * is full. The time is defined in tick periods so the constant\r
- * portTICK_PERIOD_MS should be used to convert to real time if this is required.\r
- *\r
- * @return pdTRUE if the item was successfully posted, otherwise errQUEUE_FULL.\r
- *\r
- * Example usage:\r
- <pre>\r
- struct AMessage\r
- {\r
- char ucMessageID;\r
- char ucData[ 20 ];\r
- } xMessage;\r
-\r
- uint32_t ulVar = 10UL;\r
-\r
- void vATask( void *pvParameters )\r
- {\r
- QueueHandle_t xQueue1, xQueue2;\r
- struct AMessage *pxMessage;\r
-\r
- // Create a queue capable of containing 10 uint32_t values.\r
- xQueue1 = xQueueCreate( 10, sizeof( uint32_t ) );\r
-\r
- // Create a queue capable of containing 10 pointers to AMessage structures.\r
- // These should be passed by pointer as they contain a lot of data.\r
- xQueue2 = xQueueCreate( 10, sizeof( struct AMessage * ) );\r
-\r
- // ...\r
-\r
- if( xQueue1 != 0 )\r
- {\r
- // Send an uint32_t. Wait for 10 ticks for space to become\r
- // available if necessary.\r
- if( xQueueSendToBack( xQueue1, ( void * ) &ulVar, ( TickType_t ) 10 ) != pdPASS )\r
- {\r
- // Failed to post the message, even after 10 ticks.\r
- }\r
- }\r
-\r
- if( xQueue2 != 0 )\r
- {\r
- // Send a pointer to a struct AMessage object. Don't block if the\r
- // queue is already full.\r
- pxMessage = & xMessage;\r
- xQueueSendToBack( xQueue2, ( void * ) &pxMessage, ( TickType_t ) 0 );\r
- }\r
-\r
- // ... Rest of task code.\r
- }\r
- </pre>\r
- * \defgroup xQueueSend xQueueSend\r
- * \ingroup QueueManagement\r
- */\r
-#define xQueueSendToBack( xQueue, pvItemToQueue, xTicksToWait ) xQueueGenericSend( ( xQueue ), ( pvItemToQueue ), ( xTicksToWait ), queueSEND_TO_BACK )\r
-\r
-/**\r
- * queue. h\r
- * <pre>\r
- BaseType_t xQueueSend(\r
- QueueHandle_t xQueue,\r
- const void * pvItemToQueue,\r
- TickType_t xTicksToWait\r
- );\r
- * </pre>\r
- *\r
- * This is a macro that calls xQueueGenericSend(). It is included for\r
- * backward compatibility with versions of FreeRTOS.org that did not\r
- * include the xQueueSendToFront() and xQueueSendToBack() macros. It is\r
- * equivalent to xQueueSendToBack().\r
- *\r
- * Post an item on a queue. The item is queued by copy, not by reference.\r
- * This function must not be called from an interrupt service routine.\r
- * See xQueueSendFromISR () for an alternative which may be used in an ISR.\r
- *\r
- * @param xQueue The handle to the queue on which the item is to be posted.\r
- *\r
- * @param pvItemToQueue A pointer to the item that is to be placed on the\r
- * queue. The size of the items the queue will hold was defined when the\r
- * queue was created, so this many bytes will be copied from pvItemToQueue\r
- * into the queue storage area.\r
- *\r
- * @param xTicksToWait The maximum amount of time the task should block\r
- * waiting for space to become available on the queue, should it already\r
- * be full. The call will return immediately if this is set to 0 and the\r
- * queue is full. The time is defined in tick periods so the constant\r
- * portTICK_PERIOD_MS should be used to convert to real time if this is required.\r
- *\r
- * @return pdTRUE if the item was successfully posted, otherwise errQUEUE_FULL.\r
- *\r
- * Example usage:\r
- <pre>\r
- struct AMessage\r
- {\r
- char ucMessageID;\r
- char ucData[ 20 ];\r
- } xMessage;\r
-\r
- uint32_t ulVar = 10UL;\r
-\r
- void vATask( void *pvParameters )\r
- {\r
- QueueHandle_t xQueue1, xQueue2;\r
- struct AMessage *pxMessage;\r
-\r
- // Create a queue capable of containing 10 uint32_t values.\r
- xQueue1 = xQueueCreate( 10, sizeof( uint32_t ) );\r
-\r
- // Create a queue capable of containing 10 pointers to AMessage structures.\r
- // These should be passed by pointer as they contain a lot of data.\r
- xQueue2 = xQueueCreate( 10, sizeof( struct AMessage * ) );\r
-\r
- // ...\r
-\r
- if( xQueue1 != 0 )\r
- {\r
- // Send an uint32_t. Wait for 10 ticks for space to become\r
- // available if necessary.\r
- if( xQueueSend( xQueue1, ( void * ) &ulVar, ( TickType_t ) 10 ) != pdPASS )\r
- {\r
- // Failed to post the message, even after 10 ticks.\r
- }\r
- }\r
-\r
- if( xQueue2 != 0 )\r
- {\r
- // Send a pointer to a struct AMessage object. Don't block if the\r
- // queue is already full.\r
- pxMessage = & xMessage;\r
- xQueueSend( xQueue2, ( void * ) &pxMessage, ( TickType_t ) 0 );\r
- }\r
-\r
- // ... Rest of task code.\r
- }\r
- </pre>\r
- * \defgroup xQueueSend xQueueSend\r
- * \ingroup QueueManagement\r
- */\r
-#define xQueueSend( xQueue, pvItemToQueue, xTicksToWait ) xQueueGenericSend( ( xQueue ), ( pvItemToQueue ), ( xTicksToWait ), queueSEND_TO_BACK )\r
-\r
-/**\r
- * queue. h\r
- * <pre>\r
- BaseType_t xQueueOverwrite(\r
- QueueHandle_t xQueue,\r
- const void * pvItemToQueue\r
- );\r
- * </pre>\r
- *\r
- * Only for use with queues that have a length of one - so the queue is either\r
- * empty or full.\r
- *\r
- * Post an item on a queue. If the queue is already full then overwrite the\r
- * value held in the queue. The item is queued by copy, not by reference.\r
- *\r
- * This function must not be called from an interrupt service routine.\r
- * See xQueueOverwriteFromISR () for an alternative which may be used in an ISR.\r
- *\r
- * @param xQueue The handle of the queue to which the data is being sent.\r
- *\r
- * @param pvItemToQueue A pointer to the item that is to be placed on the\r
- * queue. The size of the items the queue will hold was defined when the\r
- * queue was created, so this many bytes will be copied from pvItemToQueue\r
- * into the queue storage area.\r
- *\r
- * @return xQueueOverwrite() is a macro that calls xQueueGenericSend(), and\r
- * therefore has the same return values as xQueueSendToFront(). However, pdPASS\r
- * is the only value that can be returned because xQueueOverwrite() will write\r
- * to the queue even when the queue is already full.\r
- *\r
- * Example usage:\r
- <pre>\r
-\r
- void vFunction( void *pvParameters )\r
- {\r
- QueueHandle_t xQueue;\r
- uint32_t ulVarToSend, ulValReceived;\r
-\r
- // Create a queue to hold one uint32_t value. It is strongly\r
- // recommended *not* to use xQueueOverwrite() on queues that can\r
- // contain more than one value, and doing so will trigger an assertion\r
- // if configASSERT() is defined.\r
- xQueue = xQueueCreate( 1, sizeof( uint32_t ) );\r
-\r
- // Write the value 10 to the queue using xQueueOverwrite().\r
- ulVarToSend = 10;\r
- xQueueOverwrite( xQueue, &ulVarToSend );\r
-\r
- // Peeking the queue should now return 10, but leave the value 10 in\r
- // the queue. A block time of zero is used as it is known that the\r
- // queue holds a value.\r
- ulValReceived = 0;\r
- xQueuePeek( xQueue, &ulValReceived, 0 );\r
-\r
- if( ulValReceived != 10 )\r
- {\r
- // Error unless the item was removed by a different task.\r
- }\r
-\r
- // The queue is still full. Use xQueueOverwrite() to overwrite the\r
- // value held in the queue with 100.\r
- ulVarToSend = 100;\r
- xQueueOverwrite( xQueue, &ulVarToSend );\r
-\r
- // This time read from the queue, leaving the queue empty once more.\r
- // A block time of 0 is used again.\r
- xQueueReceive( xQueue, &ulValReceived, 0 );\r
-\r
- // The value read should be the last value written, even though the\r
- // queue was already full when the value was written.\r
- if( ulValReceived != 100 )\r
- {\r
- // Error!\r
- }\r
-\r
- // ...\r
-}\r
- </pre>\r
- * \defgroup xQueueOverwrite xQueueOverwrite\r
- * \ingroup QueueManagement\r
- */\r
-#define xQueueOverwrite( xQueue, pvItemToQueue ) xQueueGenericSend( ( xQueue ), ( pvItemToQueue ), 0, queueOVERWRITE )\r
-\r
-\r
-/**\r
- * queue. h\r
- * <pre>\r
- BaseType_t xQueueGenericSend(\r
- QueueHandle_t xQueue,\r
- const void * pvItemToQueue,\r
- TickType_t xTicksToWait\r
- BaseType_t xCopyPosition\r
- );\r
- * </pre>\r
- *\r
- * It is preferred that the macros xQueueSend(), xQueueSendToFront() and\r
- * xQueueSendToBack() are used in place of calling this function directly.\r
- *\r
- * Post an item on a queue. The item is queued by copy, not by reference.\r
- * This function must not be called from an interrupt service routine.\r
- * See xQueueSendFromISR () for an alternative which may be used in an ISR.\r
- *\r
- * @param xQueue The handle to the queue on which the item is to be posted.\r
- *\r
- * @param pvItemToQueue A pointer to the item that is to be placed on the\r
- * queue. The size of the items the queue will hold was defined when the\r
- * queue was created, so this many bytes will be copied from pvItemToQueue\r
- * into the queue storage area.\r
- *\r
- * @param xTicksToWait The maximum amount of time the task should block\r
- * waiting for space to become available on the queue, should it already\r
- * be full. The call will return immediately if this is set to 0 and the\r
- * queue is full. The time is defined in tick periods so the constant\r
- * portTICK_PERIOD_MS should be used to convert to real time if this is required.\r
- *\r
- * @param xCopyPosition Can take the value queueSEND_TO_BACK to place the\r
- * item at the back of the queue, or queueSEND_TO_FRONT to place the item\r
- * at the front of the queue (for high priority messages).\r
- *\r
- * @return pdTRUE if the item was successfully posted, otherwise errQUEUE_FULL.\r
- *\r
- * Example usage:\r
- <pre>\r
- struct AMessage\r
- {\r
- char ucMessageID;\r
- char ucData[ 20 ];\r
- } xMessage;\r
-\r
- uint32_t ulVar = 10UL;\r
-\r
- void vATask( void *pvParameters )\r
- {\r
- QueueHandle_t xQueue1, xQueue2;\r
- struct AMessage *pxMessage;\r
-\r
- // Create a queue capable of containing 10 uint32_t values.\r
- xQueue1 = xQueueCreate( 10, sizeof( uint32_t ) );\r
-\r
- // Create a queue capable of containing 10 pointers to AMessage structures.\r
- // These should be passed by pointer as they contain a lot of data.\r
- xQueue2 = xQueueCreate( 10, sizeof( struct AMessage * ) );\r
-\r
- // ...\r
-\r
- if( xQueue1 != 0 )\r
- {\r
- // Send an uint32_t. Wait for 10 ticks for space to become\r
- // available if necessary.\r
- if( xQueueGenericSend( xQueue1, ( void * ) &ulVar, ( TickType_t ) 10, queueSEND_TO_BACK ) != pdPASS )\r
- {\r
- // Failed to post the message, even after 10 ticks.\r
- }\r
- }\r
-\r
- if( xQueue2 != 0 )\r
- {\r
- // Send a pointer to a struct AMessage object. Don't block if the\r
- // queue is already full.\r
- pxMessage = & xMessage;\r
- xQueueGenericSend( xQueue2, ( void * ) &pxMessage, ( TickType_t ) 0, queueSEND_TO_BACK );\r
- }\r
-\r
- // ... Rest of task code.\r
- }\r
- </pre>\r
- * \defgroup xQueueSend xQueueSend\r
- * \ingroup QueueManagement\r
- */\r
-BaseType_t xQueueGenericSend( QueueHandle_t xQueue, const void * const pvItemToQueue, TickType_t xTicksToWait, const BaseType_t xCopyPosition ) PRIVILEGED_FUNCTION;\r
-\r
-/**\r
- * queue. h\r
- * <pre>\r
- BaseType_t xQueuePeek(\r
- QueueHandle_t xQueue,\r
- void * const pvBuffer,\r
- TickType_t xTicksToWait\r
- );</pre>\r
- *\r
- * Receive an item from a queue without removing the item from the queue.\r
- * The item is received by copy so a buffer of adequate size must be\r
- * provided. The number of bytes copied into the buffer was defined when\r
- * the queue was created.\r
- *\r
- * Successfully received items remain on the queue so will be returned again\r
- * by the next call, or a call to xQueueReceive().\r
- *\r
- * This macro must not be used in an interrupt service routine. See\r
- * xQueuePeekFromISR() for an alternative that can be called from an interrupt\r
- * service routine.\r
- *\r
- * @param xQueue The handle to the queue from which the item is to be\r
- * received.\r
- *\r
- * @param pvBuffer Pointer to the buffer into which the received item will\r
- * be copied.\r
- *\r
- * @param xTicksToWait The maximum amount of time the task should block\r
- * waiting for an item to receive should the queue be empty at the time\r
- * of the call. The time is defined in tick periods so the constant\r
- * portTICK_PERIOD_MS should be used to convert to real time if this is required.\r
- * xQueuePeek() will return immediately if xTicksToWait is 0 and the queue\r
- * is empty.\r
- *\r
- * @return pdTRUE if an item was successfully received from the queue,\r
- * otherwise pdFALSE.\r
- *\r
- * Example usage:\r
- <pre>\r
- struct AMessage\r
- {\r
- char ucMessageID;\r
- char ucData[ 20 ];\r
- } xMessage;\r
-\r
- QueueHandle_t xQueue;\r
-\r
- // Task to create a queue and post a value.\r
- void vATask( void *pvParameters )\r
- {\r
- struct AMessage *pxMessage;\r
-\r
- // Create a queue capable of containing 10 pointers to AMessage structures.\r
- // These should be passed by pointer as they contain a lot of data.\r
- xQueue = xQueueCreate( 10, sizeof( struct AMessage * ) );\r
- if( xQueue == 0 )\r
- {\r
- // Failed to create the queue.\r
- }\r
-\r
- // ...\r
-\r
- // Send a pointer to a struct AMessage object. Don't block if the\r
- // queue is already full.\r
- pxMessage = & xMessage;\r
- xQueueSend( xQueue, ( void * ) &pxMessage, ( TickType_t ) 0 );\r
-\r
- // ... Rest of task code.\r
- }\r
-\r
- // Task to peek the data from the queue.\r
- void vADifferentTask( void *pvParameters )\r
- {\r
- struct AMessage *pxRxedMessage;\r
-\r
- if( xQueue != 0 )\r
- {\r
- // Peek a message on the created queue. Block for 10 ticks if a\r
- // message is not immediately available.\r
- if( xQueuePeek( xQueue, &( pxRxedMessage ), ( TickType_t ) 10 ) )\r
- {\r
- // pcRxedMessage now points to the struct AMessage variable posted\r
- // by vATask, but the item still remains on the queue.\r
- }\r
- }\r
-\r
- // ... Rest of task code.\r
- }\r
- </pre>\r
- * \defgroup xQueuePeek xQueuePeek\r
- * \ingroup QueueManagement\r
- */\r
-BaseType_t xQueuePeek( QueueHandle_t xQueue, void * const pvBuffer, TickType_t xTicksToWait ) PRIVILEGED_FUNCTION;\r
-\r
-/**\r
- * queue. h\r
- * <pre>\r
- BaseType_t xQueuePeekFromISR(\r
- QueueHandle_t xQueue,\r
- void *pvBuffer,\r
- );</pre>\r
- *\r
- * A version of xQueuePeek() that can be called from an interrupt service\r
- * routine (ISR).\r
- *\r
- * Receive an item from a queue without removing the item from the queue.\r
- * The item is received by copy so a buffer of adequate size must be\r
- * provided. The number of bytes copied into the buffer was defined when\r
- * the queue was created.\r
- *\r
- * Successfully received items remain on the queue so will be returned again\r
- * by the next call, or a call to xQueueReceive().\r
- *\r
- * @param xQueue The handle to the queue from which the item is to be\r
- * received.\r
- *\r
- * @param pvBuffer Pointer to the buffer into which the received item will\r
- * be copied.\r
- *\r
- * @return pdTRUE if an item was successfully received from the queue,\r
- * otherwise pdFALSE.\r
- *\r
- * \defgroup xQueuePeekFromISR xQueuePeekFromISR\r
- * \ingroup QueueManagement\r
- */\r
-BaseType_t xQueuePeekFromISR( QueueHandle_t xQueue, void * const pvBuffer ) PRIVILEGED_FUNCTION;\r
-\r
-/**\r
- * queue. h\r
- * <pre>\r
- BaseType_t xQueueReceive(\r
- QueueHandle_t xQueue,\r
- void *pvBuffer,\r
- TickType_t xTicksToWait\r
- );</pre>\r
- *\r
- * Receive an item from a queue. The item is received by copy so a buffer of\r
- * adequate size must be provided. The number of bytes copied into the buffer\r
- * was defined when the queue was created.\r
- *\r
- * Successfully received items are removed from the queue.\r
- *\r
- * This function must not be used in an interrupt service routine. See\r
- * xQueueReceiveFromISR for an alternative that can.\r
- *\r
- * @param xQueue The handle to the queue from which the item is to be\r
- * received.\r
- *\r
- * @param pvBuffer Pointer to the buffer into which the received item will\r
- * be copied.\r
- *\r
- * @param xTicksToWait The maximum amount of time the task should block\r
- * waiting for an item to receive should the queue be empty at the time\r
- * of the call. xQueueReceive() will return immediately if xTicksToWait\r
- * is zero and the queue is empty. The time is defined in tick periods so the\r
- * constant portTICK_PERIOD_MS should be used to convert to real time if this is\r
- * required.\r
- *\r
- * @return pdTRUE if an item was successfully received from the queue,\r
- * otherwise pdFALSE.\r
- *\r
- * Example usage:\r
- <pre>\r
- struct AMessage\r
- {\r
- char ucMessageID;\r
- char ucData[ 20 ];\r
- } xMessage;\r
-\r
- QueueHandle_t xQueue;\r
-\r
- // Task to create a queue and post a value.\r
- void vATask( void *pvParameters )\r
- {\r
- struct AMessage *pxMessage;\r
-\r
- // Create a queue capable of containing 10 pointers to AMessage structures.\r
- // These should be passed by pointer as they contain a lot of data.\r
- xQueue = xQueueCreate( 10, sizeof( struct AMessage * ) );\r
- if( xQueue == 0 )\r
- {\r
- // Failed to create the queue.\r
- }\r
-\r
- // ...\r
-\r
- // Send a pointer to a struct AMessage object. Don't block if the\r
- // queue is already full.\r
- pxMessage = & xMessage;\r
- xQueueSend( xQueue, ( void * ) &pxMessage, ( TickType_t ) 0 );\r
-\r
- // ... Rest of task code.\r
- }\r
-\r
- // Task to receive from the queue.\r
- void vADifferentTask( void *pvParameters )\r
- {\r
- struct AMessage *pxRxedMessage;\r
-\r
- if( xQueue != 0 )\r
- {\r
- // Receive a message on the created queue. Block for 10 ticks if a\r
- // message is not immediately available.\r
- if( xQueueReceive( xQueue, &( pxRxedMessage ), ( TickType_t ) 10 ) )\r
- {\r
- // pcRxedMessage now points to the struct AMessage variable posted\r
- // by vATask.\r
- }\r
- }\r
-\r
- // ... Rest of task code.\r
- }\r
- </pre>\r
- * \defgroup xQueueReceive xQueueReceive\r
- * \ingroup QueueManagement\r
- */\r
-BaseType_t xQueueReceive( QueueHandle_t xQueue, void * const pvBuffer, TickType_t xTicksToWait ) PRIVILEGED_FUNCTION;\r
-\r
-/**\r
- * queue. h\r
- * <pre>UBaseType_t uxQueueMessagesWaiting( const QueueHandle_t xQueue );</pre>\r
- *\r
- * Return the number of messages stored in a queue.\r
- *\r
- * @param xQueue A handle to the queue being queried.\r
- *\r
- * @return The number of messages available in the queue.\r
- *\r
- * \defgroup uxQueueMessagesWaiting uxQueueMessagesWaiting\r
- * \ingroup QueueManagement\r
- */\r
-UBaseType_t uxQueueMessagesWaiting( const QueueHandle_t xQueue ) PRIVILEGED_FUNCTION;\r
-\r
-/**\r
- * queue. h\r
- * <pre>UBaseType_t uxQueueSpacesAvailable( const QueueHandle_t xQueue );</pre>\r
- *\r
- * Return the number of free spaces available in a queue. This is equal to the\r
- * number of items that can be sent to the queue before the queue becomes full\r
- * if no items are removed.\r
- *\r
- * @param xQueue A handle to the queue being queried.\r
- *\r
- * @return The number of spaces available in the queue.\r
- *\r
- * \defgroup uxQueueMessagesWaiting uxQueueMessagesWaiting\r
- * \ingroup QueueManagement\r
- */\r
-UBaseType_t uxQueueSpacesAvailable( const QueueHandle_t xQueue ) PRIVILEGED_FUNCTION;\r
-\r
-/**\r
- * queue. h\r
- * <pre>void vQueueDelete( QueueHandle_t xQueue );</pre>\r
- *\r
- * Delete a queue - freeing all the memory allocated for storing of items\r
- * placed on the queue.\r
- *\r
- * @param xQueue A handle to the queue to be deleted.\r
- *\r
- * \defgroup vQueueDelete vQueueDelete\r
- * \ingroup QueueManagement\r
- */\r
-void vQueueDelete( QueueHandle_t xQueue ) PRIVILEGED_FUNCTION;\r
-\r
-/**\r
- * queue. h\r
- * <pre>\r
- BaseType_t xQueueSendToFrontFromISR(\r
- QueueHandle_t xQueue,\r
- const void *pvItemToQueue,\r
- BaseType_t *pxHigherPriorityTaskWoken\r
- );\r
- </pre>\r
- *\r
- * This is a macro that calls xQueueGenericSendFromISR().\r
- *\r
- * Post an item to the front of a queue. It is safe to use this macro from\r
- * within an interrupt service routine.\r
- *\r
- * Items are queued by copy not reference so it is preferable to only\r
- * queue small items, especially when called from an ISR. In most cases\r
- * it would be preferable to store a pointer to the item being queued.\r
- *\r
- * @param xQueue The handle to the queue on which the item is to be posted.\r
- *\r
- * @param pvItemToQueue A pointer to the item that is to be placed on the\r
- * queue. The size of the items the queue will hold was defined when the\r
- * queue was created, so this many bytes will be copied from pvItemToQueue\r
- * into the queue storage area.\r
- *\r
- * @param pxHigherPriorityTaskWoken xQueueSendToFrontFromISR() will set\r
- * *pxHigherPriorityTaskWoken to pdTRUE if sending to the queue caused a task\r
- * to unblock, and the unblocked task has a priority higher than the currently\r
- * running task. If xQueueSendToFromFromISR() sets this value to pdTRUE then\r
- * a context switch should be requested before the interrupt is exited.\r
- *\r
- * @return pdTRUE if the data was successfully sent to the queue, otherwise\r
- * errQUEUE_FULL.\r
- *\r
- * Example usage for buffered IO (where the ISR can obtain more than one value\r
- * per call):\r
- <pre>\r
- void vBufferISR( void )\r
- {\r
- char cIn;\r
- BaseType_t xHigherPrioritTaskWoken;\r
-\r
- // We have not woken a task at the start of the ISR.\r
- xHigherPriorityTaskWoken = pdFALSE;\r
-\r
- // Loop until the buffer is empty.\r
- do\r
- {\r
- // Obtain a byte from the buffer.\r
- cIn = portINPUT_BYTE( RX_REGISTER_ADDRESS );\r
-\r
- // Post the byte.\r
- xQueueSendToFrontFromISR( xRxQueue, &cIn, &xHigherPriorityTaskWoken );\r
-\r
- } while( portINPUT_BYTE( BUFFER_COUNT ) );\r
-\r
- // Now the buffer is empty we can switch context if necessary.\r
- if( xHigherPriorityTaskWoken )\r
- {\r
- taskYIELD ();\r
- }\r
- }\r
- </pre>\r
- *\r
- * \defgroup xQueueSendFromISR xQueueSendFromISR\r
- * \ingroup QueueManagement\r
- */\r
-#define xQueueSendToFrontFromISR( xQueue, pvItemToQueue, pxHigherPriorityTaskWoken ) xQueueGenericSendFromISR( ( xQueue ), ( pvItemToQueue ), ( pxHigherPriorityTaskWoken ), queueSEND_TO_FRONT )\r
-\r
-\r
-/**\r
- * queue. h\r
- * <pre>\r
- BaseType_t xQueueSendToBackFromISR(\r
- QueueHandle_t xQueue,\r
- const void *pvItemToQueue,\r
- BaseType_t *pxHigherPriorityTaskWoken\r
- );\r
- </pre>\r
- *\r
- * This is a macro that calls xQueueGenericSendFromISR().\r
- *\r
- * Post an item to the back of a queue. It is safe to use this macro from\r
- * within an interrupt service routine.\r
- *\r
- * Items are queued by copy not reference so it is preferable to only\r
- * queue small items, especially when called from an ISR. In most cases\r
- * it would be preferable to store a pointer to the item being queued.\r
- *\r
- * @param xQueue The handle to the queue on which the item is to be posted.\r
- *\r
- * @param pvItemToQueue A pointer to the item that is to be placed on the\r
- * queue. The size of the items the queue will hold was defined when the\r
- * queue was created, so this many bytes will be copied from pvItemToQueue\r
- * into the queue storage area.\r
- *\r
- * @param pxHigherPriorityTaskWoken xQueueSendToBackFromISR() will set\r
- * *pxHigherPriorityTaskWoken to pdTRUE if sending to the queue caused a task\r
- * to unblock, and the unblocked task has a priority higher than the currently\r
- * running task. If xQueueSendToBackFromISR() sets this value to pdTRUE then\r
- * a context switch should be requested before the interrupt is exited.\r
- *\r
- * @return pdTRUE if the data was successfully sent to the queue, otherwise\r
- * errQUEUE_FULL.\r
- *\r
- * Example usage for buffered IO (where the ISR can obtain more than one value\r
- * per call):\r
- <pre>\r
- void vBufferISR( void )\r
- {\r
- char cIn;\r
- BaseType_t xHigherPriorityTaskWoken;\r
-\r
- // We have not woken a task at the start of the ISR.\r
- xHigherPriorityTaskWoken = pdFALSE;\r
-\r
- // Loop until the buffer is empty.\r
- do\r
- {\r
- // Obtain a byte from the buffer.\r
- cIn = portINPUT_BYTE( RX_REGISTER_ADDRESS );\r
-\r
- // Post the byte.\r
- xQueueSendToBackFromISR( xRxQueue, &cIn, &xHigherPriorityTaskWoken );\r
-\r
- } while( portINPUT_BYTE( BUFFER_COUNT ) );\r
-\r
- // Now the buffer is empty we can switch context if necessary.\r
- if( xHigherPriorityTaskWoken )\r
- {\r
- taskYIELD ();\r
- }\r
- }\r
- </pre>\r
- *\r
- * \defgroup xQueueSendFromISR xQueueSendFromISR\r
- * \ingroup QueueManagement\r
- */\r
-#define xQueueSendToBackFromISR( xQueue, pvItemToQueue, pxHigherPriorityTaskWoken ) xQueueGenericSendFromISR( ( xQueue ), ( pvItemToQueue ), ( pxHigherPriorityTaskWoken ), queueSEND_TO_BACK )\r
-\r
-/**\r
- * queue. h\r
- * <pre>\r
- BaseType_t xQueueOverwriteFromISR(\r
- QueueHandle_t xQueue,\r
- const void * pvItemToQueue,\r
- BaseType_t *pxHigherPriorityTaskWoken\r
- );\r
- * </pre>\r
- *\r
- * A version of xQueueOverwrite() that can be used in an interrupt service\r
- * routine (ISR).\r
- *\r
- * Only for use with queues that can hold a single item - so the queue is either\r
- * empty or full.\r
- *\r
- * Post an item on a queue. If the queue is already full then overwrite the\r
- * value held in the queue. The item is queued by copy, not by reference.\r
- *\r
- * @param xQueue The handle to the queue on which the item is to be posted.\r
- *\r
- * @param pvItemToQueue A pointer to the item that is to be placed on the\r
- * queue. The size of the items the queue will hold was defined when the\r
- * queue was created, so this many bytes will be copied from pvItemToQueue\r
- * into the queue storage area.\r
- *\r
- * @param pxHigherPriorityTaskWoken xQueueOverwriteFromISR() will set\r
- * *pxHigherPriorityTaskWoken to pdTRUE if sending to the queue caused a task\r
- * to unblock, and the unblocked task has a priority higher than the currently\r
- * running task. If xQueueOverwriteFromISR() sets this value to pdTRUE then\r
- * a context switch should be requested before the interrupt is exited.\r
- *\r
- * @return xQueueOverwriteFromISR() is a macro that calls\r
- * xQueueGenericSendFromISR(), and therefore has the same return values as\r
- * xQueueSendToFrontFromISR(). However, pdPASS is the only value that can be\r
- * returned because xQueueOverwriteFromISR() will write to the queue even when\r
- * the queue is already full.\r
- *\r
- * Example usage:\r
- <pre>\r
-\r
- QueueHandle_t xQueue;\r
-\r
- void vFunction( void *pvParameters )\r
- {\r
- // Create a queue to hold one uint32_t value. It is strongly\r
- // recommended *not* to use xQueueOverwriteFromISR() on queues that can\r
- // contain more than one value, and doing so will trigger an assertion\r
- // if configASSERT() is defined.\r
- xQueue = xQueueCreate( 1, sizeof( uint32_t ) );\r
-}\r
-\r
-void vAnInterruptHandler( void )\r
-{\r
-// xHigherPriorityTaskWoken must be set to pdFALSE before it is used.\r
-BaseType_t xHigherPriorityTaskWoken = pdFALSE;\r
-uint32_t ulVarToSend, ulValReceived;\r
-\r
- // Write the value 10 to the queue using xQueueOverwriteFromISR().\r
- ulVarToSend = 10;\r
- xQueueOverwriteFromISR( xQueue, &ulVarToSend, &xHigherPriorityTaskWoken );\r
-\r
- // The queue is full, but calling xQueueOverwriteFromISR() again will still\r
- // pass because the value held in the queue will be overwritten with the\r
- // new value.\r
- ulVarToSend = 100;\r
- xQueueOverwriteFromISR( xQueue, &ulVarToSend, &xHigherPriorityTaskWoken );\r
-\r
- // Reading from the queue will now return 100.\r
-\r
- // ...\r
-\r
- if( xHigherPrioritytaskWoken == pdTRUE )\r
- {\r
- // Writing to the queue caused a task to unblock and the unblocked task\r
- // has a priority higher than or equal to the priority of the currently\r
- // executing task (the task this interrupt interrupted). Perform a context\r
- // switch so this interrupt returns directly to the unblocked task.\r
- portYIELD_FROM_ISR(); // or portEND_SWITCHING_ISR() depending on the port.\r
- }\r
-}\r
- </pre>\r
- * \defgroup xQueueOverwriteFromISR xQueueOverwriteFromISR\r
- * \ingroup QueueManagement\r
- */\r
-#define xQueueOverwriteFromISR( xQueue, pvItemToQueue, pxHigherPriorityTaskWoken ) xQueueGenericSendFromISR( ( xQueue ), ( pvItemToQueue ), ( pxHigherPriorityTaskWoken ), queueOVERWRITE )\r
-\r
-/**\r
- * queue. h\r
- * <pre>\r
- BaseType_t xQueueSendFromISR(\r
- QueueHandle_t xQueue,\r
- const void *pvItemToQueue,\r
- BaseType_t *pxHigherPriorityTaskWoken\r
- );\r
- </pre>\r
- *\r
- * This is a macro that calls xQueueGenericSendFromISR(). It is included\r
- * for backward compatibility with versions of FreeRTOS.org that did not\r
- * include the xQueueSendToBackFromISR() and xQueueSendToFrontFromISR()\r
- * macros.\r
- *\r
- * Post an item to the back of a queue. It is safe to use this function from\r
- * within an interrupt service routine.\r
- *\r
- * Items are queued by copy not reference so it is preferable to only\r
- * queue small items, especially when called from an ISR. In most cases\r
- * it would be preferable to store a pointer to the item being queued.\r
- *\r
- * @param xQueue The handle to the queue on which the item is to be posted.\r
- *\r
- * @param pvItemToQueue A pointer to the item that is to be placed on the\r
- * queue. The size of the items the queue will hold was defined when the\r
- * queue was created, so this many bytes will be copied from pvItemToQueue\r
- * into the queue storage area.\r
- *\r
- * @param pxHigherPriorityTaskWoken xQueueSendFromISR() will set\r
- * *pxHigherPriorityTaskWoken to pdTRUE if sending to the queue caused a task\r
- * to unblock, and the unblocked task has a priority higher than the currently\r
- * running task. If xQueueSendFromISR() sets this value to pdTRUE then\r
- * a context switch should be requested before the interrupt is exited.\r
- *\r
- * @return pdTRUE if the data was successfully sent to the queue, otherwise\r
- * errQUEUE_FULL.\r
- *\r
- * Example usage for buffered IO (where the ISR can obtain more than one value\r
- * per call):\r
- <pre>\r
- void vBufferISR( void )\r
- {\r
- char cIn;\r
- BaseType_t xHigherPriorityTaskWoken;\r
-\r
- // We have not woken a task at the start of the ISR.\r
- xHigherPriorityTaskWoken = pdFALSE;\r
-\r
- // Loop until the buffer is empty.\r
- do\r
- {\r
- // Obtain a byte from the buffer.\r
- cIn = portINPUT_BYTE( RX_REGISTER_ADDRESS );\r
-\r
- // Post the byte.\r
- xQueueSendFromISR( xRxQueue, &cIn, &xHigherPriorityTaskWoken );\r
-\r
- } while( portINPUT_BYTE( BUFFER_COUNT ) );\r
-\r
- // Now the buffer is empty we can switch context if necessary.\r
- if( xHigherPriorityTaskWoken )\r
- {\r
- // Actual macro used here is port specific.\r
- portYIELD_FROM_ISR ();\r
- }\r
- }\r
- </pre>\r
- *\r
- * \defgroup xQueueSendFromISR xQueueSendFromISR\r
- * \ingroup QueueManagement\r
- */\r
-#define xQueueSendFromISR( xQueue, pvItemToQueue, pxHigherPriorityTaskWoken ) xQueueGenericSendFromISR( ( xQueue ), ( pvItemToQueue ), ( pxHigherPriorityTaskWoken ), queueSEND_TO_BACK )\r
-\r
-/**\r
- * queue. h\r
- * <pre>\r
- BaseType_t xQueueGenericSendFromISR(\r
- QueueHandle_t xQueue,\r
- const void *pvItemToQueue,\r
- BaseType_t *pxHigherPriorityTaskWoken,\r
- BaseType_t xCopyPosition\r
- );\r
- </pre>\r
- *\r
- * It is preferred that the macros xQueueSendFromISR(),\r
- * xQueueSendToFrontFromISR() and xQueueSendToBackFromISR() be used in place\r
- * of calling this function directly. xQueueGiveFromISR() is an\r
- * equivalent for use by semaphores that don't actually copy any data.\r
- *\r
- * Post an item on a queue. It is safe to use this function from within an\r
- * interrupt service routine.\r
- *\r
- * Items are queued by copy not reference so it is preferable to only\r
- * queue small items, especially when called from an ISR. In most cases\r
- * it would be preferable to store a pointer to the item being queued.\r
- *\r
- * @param xQueue The handle to the queue on which the item is to be posted.\r
- *\r
- * @param pvItemToQueue A pointer to the item that is to be placed on the\r
- * queue. The size of the items the queue will hold was defined when the\r
- * queue was created, so this many bytes will be copied from pvItemToQueue\r
- * into the queue storage area.\r
- *\r
- * @param pxHigherPriorityTaskWoken xQueueGenericSendFromISR() will set\r
- * *pxHigherPriorityTaskWoken to pdTRUE if sending to the queue caused a task\r
- * to unblock, and the unblocked task has a priority higher than the currently\r
- * running task. If xQueueGenericSendFromISR() sets this value to pdTRUE then\r
- * a context switch should be requested before the interrupt is exited.\r
- *\r
- * @param xCopyPosition Can take the value queueSEND_TO_BACK to place the\r
- * item at the back of the queue, or queueSEND_TO_FRONT to place the item\r
- * at the front of the queue (for high priority messages).\r
- *\r
- * @return pdTRUE if the data was successfully sent to the queue, otherwise\r
- * errQUEUE_FULL.\r
- *\r
- * Example usage for buffered IO (where the ISR can obtain more than one value\r
- * per call):\r
- <pre>\r
- void vBufferISR( void )\r
- {\r
- char cIn;\r
- BaseType_t xHigherPriorityTaskWokenByPost;\r
-\r
- // We have not woken a task at the start of the ISR.\r
- xHigherPriorityTaskWokenByPost = pdFALSE;\r
-\r
- // Loop until the buffer is empty.\r
- do\r
- {\r
- // Obtain a byte from the buffer.\r
- cIn = portINPUT_BYTE( RX_REGISTER_ADDRESS );\r
-\r
- // Post each byte.\r
- xQueueGenericSendFromISR( xRxQueue, &cIn, &xHigherPriorityTaskWokenByPost, queueSEND_TO_BACK );\r
-\r
- } while( portINPUT_BYTE( BUFFER_COUNT ) );\r
-\r
- // Now the buffer is empty we can switch context if necessary. Note that the\r
- // name of the yield function required is port specific.\r
- if( xHigherPriorityTaskWokenByPost )\r
- {\r
- taskYIELD_YIELD_FROM_ISR();\r
- }\r
- }\r
- </pre>\r
- *\r
- * \defgroup xQueueSendFromISR xQueueSendFromISR\r
- * \ingroup QueueManagement\r
- */\r
-BaseType_t xQueueGenericSendFromISR( QueueHandle_t xQueue, const void * const pvItemToQueue, BaseType_t * const pxHigherPriorityTaskWoken, const BaseType_t xCopyPosition ) PRIVILEGED_FUNCTION;\r
-BaseType_t xQueueGiveFromISR( QueueHandle_t xQueue, BaseType_t * const pxHigherPriorityTaskWoken ) PRIVILEGED_FUNCTION;\r
-\r
-/**\r
- * queue. h\r
- * <pre>\r
- BaseType_t xQueueReceiveFromISR(\r
- QueueHandle_t xQueue,\r
- void *pvBuffer,\r
- BaseType_t *pxTaskWoken\r
- );\r
- * </pre>\r
- *\r
- * Receive an item from a queue. It is safe to use this function from within an\r
- * interrupt service routine.\r
- *\r
- * @param xQueue The handle to the queue from which the item is to be\r
- * received.\r
- *\r
- * @param pvBuffer Pointer to the buffer into which the received item will\r
- * be copied.\r
- *\r
- * @param pxTaskWoken A task may be blocked waiting for space to become\r
- * available on the queue. If xQueueReceiveFromISR causes such a task to\r
- * unblock *pxTaskWoken will get set to pdTRUE, otherwise *pxTaskWoken will\r
- * remain unchanged.\r
- *\r
- * @return pdTRUE if an item was successfully received from the queue,\r
- * otherwise pdFALSE.\r
- *\r
- * Example usage:\r
- <pre>\r
-\r
- QueueHandle_t xQueue;\r
-\r
- // Function to create a queue and post some values.\r
- void vAFunction( void *pvParameters )\r
- {\r
- char cValueToPost;\r
- const TickType_t xTicksToWait = ( TickType_t )0xff;\r
-\r
- // Create a queue capable of containing 10 characters.\r
- xQueue = xQueueCreate( 10, sizeof( char ) );\r
- if( xQueue == 0 )\r
- {\r
- // Failed to create the queue.\r
- }\r
-\r
- // ...\r
-\r
- // Post some characters that will be used within an ISR. If the queue\r
- // is full then this task will block for xTicksToWait ticks.\r
- cValueToPost = 'a';\r
- xQueueSend( xQueue, ( void * ) &cValueToPost, xTicksToWait );\r
- cValueToPost = 'b';\r
- xQueueSend( xQueue, ( void * ) &cValueToPost, xTicksToWait );\r
-\r
- // ... keep posting characters ... this task may block when the queue\r
- // becomes full.\r
-\r
- cValueToPost = 'c';\r
- xQueueSend( xQueue, ( void * ) &cValueToPost, xTicksToWait );\r
- }\r
-\r
- // ISR that outputs all the characters received on the queue.\r
- void vISR_Routine( void )\r
- {\r
- BaseType_t xTaskWokenByReceive = pdFALSE;\r
- char cRxedChar;\r
-\r
- while( xQueueReceiveFromISR( xQueue, ( void * ) &cRxedChar, &xTaskWokenByReceive) )\r
- {\r
- // A character was received. Output the character now.\r
- vOutputCharacter( cRxedChar );\r
-\r
- // If removing the character from the queue woke the task that was\r
- // posting onto the queue cTaskWokenByReceive will have been set to\r
- // pdTRUE. No matter how many times this loop iterates only one\r
- // task will be woken.\r
- }\r
-\r
- if( cTaskWokenByPost != ( char ) pdFALSE;\r
- {\r
- taskYIELD ();\r
- }\r
- }\r
- </pre>\r
- * \defgroup xQueueReceiveFromISR xQueueReceiveFromISR\r
- * \ingroup QueueManagement\r
- */\r
-BaseType_t xQueueReceiveFromISR( QueueHandle_t xQueue, void * const pvBuffer, BaseType_t * const pxHigherPriorityTaskWoken ) PRIVILEGED_FUNCTION;\r
-\r
-/*\r
- * Utilities to query queues that are safe to use from an ISR. These utilities\r
- * should be used only from witin an ISR, or within a critical section.\r
- */\r
-BaseType_t xQueueIsQueueEmptyFromISR( const QueueHandle_t xQueue ) PRIVILEGED_FUNCTION;\r
-BaseType_t xQueueIsQueueFullFromISR( const QueueHandle_t xQueue ) PRIVILEGED_FUNCTION;\r
-UBaseType_t uxQueueMessagesWaitingFromISR( const QueueHandle_t xQueue ) PRIVILEGED_FUNCTION;\r
-\r
-/*\r
- * The functions defined above are for passing data to and from tasks. The\r
- * functions below are the equivalents for passing data to and from\r
- * co-routines.\r
- *\r
- * These functions are called from the co-routine macro implementation and\r
- * should not be called directly from application code. Instead use the macro\r
- * wrappers defined within croutine.h.\r
- */\r
-BaseType_t xQueueCRSendFromISR( QueueHandle_t xQueue, const void *pvItemToQueue, BaseType_t xCoRoutinePreviouslyWoken );\r
-BaseType_t xQueueCRReceiveFromISR( QueueHandle_t xQueue, void *pvBuffer, BaseType_t *pxTaskWoken );\r
-BaseType_t xQueueCRSend( QueueHandle_t xQueue, const void *pvItemToQueue, TickType_t xTicksToWait );\r
-BaseType_t xQueueCRReceive( QueueHandle_t xQueue, void *pvBuffer, TickType_t xTicksToWait );\r
-\r
-/*\r
- * For internal use only. Use xSemaphoreCreateMutex(),\r
- * xSemaphoreCreateCounting() or xSemaphoreGetMutexHolder() instead of calling\r
- * these functions directly.\r
- */\r
-QueueHandle_t xQueueCreateMutex( const uint8_t ucQueueType ) PRIVILEGED_FUNCTION;\r
-QueueHandle_t xQueueCreateMutexStatic( const uint8_t ucQueueType, StaticQueue_t *pxStaticQueue ) PRIVILEGED_FUNCTION;\r
-QueueHandle_t xQueueCreateCountingSemaphore( const UBaseType_t uxMaxCount, const UBaseType_t uxInitialCount ) PRIVILEGED_FUNCTION;\r
-QueueHandle_t xQueueCreateCountingSemaphoreStatic( const UBaseType_t uxMaxCount, const UBaseType_t uxInitialCount, StaticQueue_t *pxStaticQueue ) PRIVILEGED_FUNCTION;\r
-BaseType_t xQueueSemaphoreTake( QueueHandle_t xQueue, TickType_t xTicksToWait ) PRIVILEGED_FUNCTION;\r
-void* xQueueGetMutexHolder( QueueHandle_t xSemaphore ) PRIVILEGED_FUNCTION;\r
-void* xQueueGetMutexHolderFromISR( QueueHandle_t xSemaphore ) PRIVILEGED_FUNCTION;\r
-\r
-/*\r
- * For internal use only. Use xSemaphoreTakeMutexRecursive() or\r
- * xSemaphoreGiveMutexRecursive() instead of calling these functions directly.\r
- */\r
-BaseType_t xQueueTakeMutexRecursive( QueueHandle_t xMutex, TickType_t xTicksToWait ) PRIVILEGED_FUNCTION;\r
-BaseType_t xQueueGiveMutexRecursive( QueueHandle_t pxMutex ) PRIVILEGED_FUNCTION;\r
-\r
-/*\r
- * Reset a queue back to its original empty state. The return value is now\r
- * obsolete and is always set to pdPASS.\r
- */\r
-#define xQueueReset( xQueue ) xQueueGenericReset( xQueue, pdFALSE )\r
-\r
-/*\r
- * The registry is provided as a means for kernel aware debuggers to\r
- * locate queues, semaphores and mutexes. Call vQueueAddToRegistry() add\r
- * a queue, semaphore or mutex handle to the registry if you want the handle\r
- * to be available to a kernel aware debugger. If you are not using a kernel\r
- * aware debugger then this function can be ignored.\r
- *\r
- * configQUEUE_REGISTRY_SIZE defines the maximum number of handles the\r
- * registry can hold. configQUEUE_REGISTRY_SIZE must be greater than 0\r
- * within FreeRTOSConfig.h for the registry to be available. Its value\r
- * does not effect the number of queues, semaphores and mutexes that can be\r
- * created - just the number that the registry can hold.\r
- *\r
- * @param xQueue The handle of the queue being added to the registry. This\r
- * is the handle returned by a call to xQueueCreate(). Semaphore and mutex\r
- * handles can also be passed in here.\r
- *\r
- * @param pcName The name to be associated with the handle. This is the\r
- * name that the kernel aware debugger will display. The queue registry only\r
- * stores a pointer to the string - so the string must be persistent (global or\r
- * preferably in ROM/Flash), not on the stack.\r
- */\r
-#if( configQUEUE_REGISTRY_SIZE > 0 )\r
- void vQueueAddToRegistry( QueueHandle_t xQueue, const char *pcName ) PRIVILEGED_FUNCTION; /*lint !e971 Unqualified char types are allowed for strings and single characters only. */\r
-#endif\r
-\r
-/*\r
- * The registry is provided as a means for kernel aware debuggers to\r
- * locate queues, semaphores and mutexes. Call vQueueAddToRegistry() add\r
- * a queue, semaphore or mutex handle to the registry if you want the handle\r
- * to be available to a kernel aware debugger, and vQueueUnregisterQueue() to\r
- * remove the queue, semaphore or mutex from the register. If you are not using\r
- * a kernel aware debugger then this function can be ignored.\r
- *\r
- * @param xQueue The handle of the queue being removed from the registry.\r
- */\r
-#if( configQUEUE_REGISTRY_SIZE > 0 )\r
- void vQueueUnregisterQueue( QueueHandle_t xQueue ) PRIVILEGED_FUNCTION;\r
-#endif\r
-\r
-/*\r
- * The queue registry is provided as a means for kernel aware debuggers to\r
- * locate queues, semaphores and mutexes. Call pcQueueGetName() to look\r
- * up and return the name of a queue in the queue registry from the queue's\r
- * handle.\r
- *\r
- * @param xQueue The handle of the queue the name of which will be returned.\r
- * @return If the queue is in the registry then a pointer to the name of the\r
- * queue is returned. If the queue is not in the registry then NULL is\r
- * returned.\r
- */\r
-#if( configQUEUE_REGISTRY_SIZE > 0 )\r
- const char *pcQueueGetName( QueueHandle_t xQueue ) PRIVILEGED_FUNCTION; /*lint !e971 Unqualified char types are allowed for strings and single characters only. */\r
-#endif\r
-\r
-/*\r
- * Generic version of the function used to creaet a queue using dynamic memory\r
- * allocation. This is called by other functions and macros that create other\r
- * RTOS objects that use the queue structure as their base.\r
- */\r
-#if( configSUPPORT_DYNAMIC_ALLOCATION == 1 )\r
- QueueHandle_t xQueueGenericCreate( const UBaseType_t uxQueueLength, const UBaseType_t uxItemSize, const uint8_t ucQueueType ) PRIVILEGED_FUNCTION;\r
-#endif\r
-\r
-/*\r
- * Generic version of the function used to creaet a queue using dynamic memory\r
- * allocation. This is called by other functions and macros that create other\r
- * RTOS objects that use the queue structure as their base.\r
- */\r
-#if( configSUPPORT_STATIC_ALLOCATION == 1 )\r
- QueueHandle_t xQueueGenericCreateStatic( const UBaseType_t uxQueueLength, const UBaseType_t uxItemSize, uint8_t *pucQueueStorage, StaticQueue_t *pxStaticQueue, const uint8_t ucQueueType ) PRIVILEGED_FUNCTION;\r
-#endif\r
-\r
-/*\r
- * Queue sets provide a mechanism to allow a task to block (pend) on a read\r
- * operation from multiple queues or semaphores simultaneously.\r
- *\r
- * See FreeRTOS/Source/Demo/Common/Minimal/QueueSet.c for an example using this\r
- * function.\r
- *\r
- * A queue set must be explicitly created using a call to xQueueCreateSet()\r
- * before it can be used. Once created, standard FreeRTOS queues and semaphores\r
- * can be added to the set using calls to xQueueAddToSet().\r
- * xQueueSelectFromSet() is then used to determine which, if any, of the queues\r
- * or semaphores contained in the set is in a state where a queue read or\r
- * semaphore take operation would be successful.\r
- *\r
- * Note 1: See the documentation on http://wwwFreeRTOS.org/RTOS-queue-sets.html\r
- * for reasons why queue sets are very rarely needed in practice as there are\r
- * simpler methods of blocking on multiple objects.\r
- *\r
- * Note 2: Blocking on a queue set that contains a mutex will not cause the\r
- * mutex holder to inherit the priority of the blocked task.\r
- *\r
- * Note 3: An additional 4 bytes of RAM is required for each space in a every\r
- * queue added to a queue set. Therefore counting semaphores that have a high\r
- * maximum count value should not be added to a queue set.\r
- *\r
- * Note 4: A receive (in the case of a queue) or take (in the case of a\r
- * semaphore) operation must not be performed on a member of a queue set unless\r
- * a call to xQueueSelectFromSet() has first returned a handle to that set member.\r
- *\r
- * @param uxEventQueueLength Queue sets store events that occur on\r
- * the queues and semaphores contained in the set. uxEventQueueLength specifies\r
- * the maximum number of events that can be queued at once. To be absolutely\r
- * certain that events are not lost uxEventQueueLength should be set to the\r
- * total sum of the length of the queues added to the set, where binary\r
- * semaphores and mutexes have a length of 1, and counting semaphores have a\r
- * length set by their maximum count value. Examples:\r
- * + If a queue set is to hold a queue of length 5, another queue of length 12,\r
- * and a binary semaphore, then uxEventQueueLength should be set to\r
- * (5 + 12 + 1), or 18.\r
- * + If a queue set is to hold three binary semaphores then uxEventQueueLength\r
- * should be set to (1 + 1 + 1 ), or 3.\r
- * + If a queue set is to hold a counting semaphore that has a maximum count of\r
- * 5, and a counting semaphore that has a maximum count of 3, then\r
- * uxEventQueueLength should be set to (5 + 3), or 8.\r
- *\r
- * @return If the queue set is created successfully then a handle to the created\r
- * queue set is returned. Otherwise NULL is returned.\r
- */\r
-QueueSetHandle_t xQueueCreateSet( const UBaseType_t uxEventQueueLength ) PRIVILEGED_FUNCTION;\r
-\r
-/*\r
- * Adds a queue or semaphore to a queue set that was previously created by a\r
- * call to xQueueCreateSet().\r
- *\r
- * See FreeRTOS/Source/Demo/Common/Minimal/QueueSet.c for an example using this\r
- * function.\r
- *\r
- * Note 1: A receive (in the case of a queue) or take (in the case of a\r
- * semaphore) operation must not be performed on a member of a queue set unless\r
- * a call to xQueueSelectFromSet() has first returned a handle to that set member.\r
- *\r
- * @param xQueueOrSemaphore The handle of the queue or semaphore being added to\r
- * the queue set (cast to an QueueSetMemberHandle_t type).\r
- *\r
- * @param xQueueSet The handle of the queue set to which the queue or semaphore\r
- * is being added.\r
- *\r
- * @return If the queue or semaphore was successfully added to the queue set\r
- * then pdPASS is returned. If the queue could not be successfully added to the\r
- * queue set because it is already a member of a different queue set then pdFAIL\r
- * is returned.\r
- */\r
-BaseType_t xQueueAddToSet( QueueSetMemberHandle_t xQueueOrSemaphore, QueueSetHandle_t xQueueSet ) PRIVILEGED_FUNCTION;\r
-\r
-/*\r
- * Removes a queue or semaphore from a queue set. A queue or semaphore can only\r
- * be removed from a set if the queue or semaphore is empty.\r
- *\r
- * See FreeRTOS/Source/Demo/Common/Minimal/QueueSet.c for an example using this\r
- * function.\r
- *\r
- * @param xQueueOrSemaphore The handle of the queue or semaphore being removed\r
- * from the queue set (cast to an QueueSetMemberHandle_t type).\r
- *\r
- * @param xQueueSet The handle of the queue set in which the queue or semaphore\r
- * is included.\r
- *\r
- * @return If the queue or semaphore was successfully removed from the queue set\r
- * then pdPASS is returned. If the queue was not in the queue set, or the\r
- * queue (or semaphore) was not empty, then pdFAIL is returned.\r
- */\r
-BaseType_t xQueueRemoveFromSet( QueueSetMemberHandle_t xQueueOrSemaphore, QueueSetHandle_t xQueueSet ) PRIVILEGED_FUNCTION;\r
-\r
-/*\r
- * xQueueSelectFromSet() selects from the members of a queue set a queue or\r
- * semaphore that either contains data (in the case of a queue) or is available\r
- * to take (in the case of a semaphore). xQueueSelectFromSet() effectively\r
- * allows a task to block (pend) on a read operation on all the queues and\r
- * semaphores in a queue set simultaneously.\r
- *\r
- * See FreeRTOS/Source/Demo/Common/Minimal/QueueSet.c for an example using this\r
- * function.\r
- *\r
- * Note 1: See the documentation on http://wwwFreeRTOS.org/RTOS-queue-sets.html\r
- * for reasons why queue sets are very rarely needed in practice as there are\r
- * simpler methods of blocking on multiple objects.\r
- *\r
- * Note 2: Blocking on a queue set that contains a mutex will not cause the\r
- * mutex holder to inherit the priority of the blocked task.\r
- *\r
- * Note 3: A receive (in the case of a queue) or take (in the case of a\r
- * semaphore) operation must not be performed on a member of a queue set unless\r
- * a call to xQueueSelectFromSet() has first returned a handle to that set member.\r
- *\r
- * @param xQueueSet The queue set on which the task will (potentially) block.\r
- *\r
- * @param xTicksToWait The maximum time, in ticks, that the calling task will\r
- * remain in the Blocked state (with other tasks executing) to wait for a member\r
- * of the queue set to be ready for a successful queue read or semaphore take\r
- * operation.\r
- *\r
- * @return xQueueSelectFromSet() will return the handle of a queue (cast to\r
- * a QueueSetMemberHandle_t type) contained in the queue set that contains data,\r
- * or the handle of a semaphore (cast to a QueueSetMemberHandle_t type) contained\r
- * in the queue set that is available, or NULL if no such queue or semaphore\r
- * exists before before the specified block time expires.\r
- */\r
-QueueSetMemberHandle_t xQueueSelectFromSet( QueueSetHandle_t xQueueSet, const TickType_t xTicksToWait ) PRIVILEGED_FUNCTION;\r
-\r
-/*\r
- * A version of xQueueSelectFromSet() that can be used from an ISR.\r
- */\r
-QueueSetMemberHandle_t xQueueSelectFromSetFromISR( QueueSetHandle_t xQueueSet ) PRIVILEGED_FUNCTION;\r
-\r
-/* Not public API functions. */\r
-void vQueueWaitForMessageRestricted( QueueHandle_t xQueue, TickType_t xTicksToWait, const BaseType_t xWaitIndefinitely ) PRIVILEGED_FUNCTION;\r
-BaseType_t xQueueGenericReset( QueueHandle_t xQueue, BaseType_t xNewQueue ) PRIVILEGED_FUNCTION;\r
-void vQueueSetQueueNumber( QueueHandle_t xQueue, UBaseType_t uxQueueNumber ) PRIVILEGED_FUNCTION;\r
-UBaseType_t uxQueueGetQueueNumber( QueueHandle_t xQueue ) PRIVILEGED_FUNCTION;\r
-uint8_t ucQueueGetQueueType( QueueHandle_t xQueue ) PRIVILEGED_FUNCTION;\r
-\r
-\r
-#ifdef __cplusplus\r
-}\r
-#endif\r
-\r
-#endif /* QUEUE_H */\r
-\r
+++ /dev/null
-/*\r
- * FreeRTOS Kernel V10.0.1\r
- * Copyright (C) 2017 Amazon.com, Inc. or its affiliates. All Rights Reserved.\r
- *\r
- * Permission is hereby granted, free of charge, to any person obtaining a copy of\r
- * this software and associated documentation files (the "Software"), to deal in\r
- * the Software without restriction, including without limitation the rights to\r
- * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of\r
- * the Software, and to permit persons to whom the Software is furnished to do so,\r
- * subject to the following conditions:\r
- *\r
- * The above copyright notice and this permission notice shall be included in all\r
- * copies or substantial portions of the Software.\r
- *\r
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\r
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS\r
- * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR\r
- * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER\r
- * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN\r
- * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\r
- *\r
- * http://www.FreeRTOS.org\r
- * http://aws.amazon.com/freertos\r
- *\r
- * 1 tab == 4 spaces!\r
- */\r
-\r
-#ifndef SEMAPHORE_H\r
-#define SEMAPHORE_H\r
-\r
-#ifndef INC_FREERTOS_H\r
- #error "include FreeRTOS.h" must appear in source files before "include semphr.h"\r
-#endif\r
-\r
-#include "queue.h"\r
-\r
-typedef QueueHandle_t SemaphoreHandle_t;\r
-\r
-#define semBINARY_SEMAPHORE_QUEUE_LENGTH ( ( uint8_t ) 1U )\r
-#define semSEMAPHORE_QUEUE_ITEM_LENGTH ( ( uint8_t ) 0U )\r
-#define semGIVE_BLOCK_TIME ( ( TickType_t ) 0U )\r
-\r
-\r
-/**\r
- * semphr. h\r
- * <pre>vSemaphoreCreateBinary( SemaphoreHandle_t xSemaphore )</pre>\r
- *\r
- * In many usage scenarios it is faster and more memory efficient to use a\r
- * direct to task notification in place of a binary semaphore!\r
- * http://www.freertos.org/RTOS-task-notifications.html\r
- *\r
- * This old vSemaphoreCreateBinary() macro is now deprecated in favour of the\r
- * xSemaphoreCreateBinary() function. Note that binary semaphores created using\r
- * the vSemaphoreCreateBinary() macro are created in a state such that the\r
- * first call to 'take' the semaphore would pass, whereas binary semaphores\r
- * created using xSemaphoreCreateBinary() are created in a state such that the\r
- * the semaphore must first be 'given' before it can be 'taken'.\r
- *\r
- * <i>Macro</i> that implements a semaphore by using the existing queue mechanism.\r
- * The queue length is 1 as this is a binary semaphore. The data size is 0\r
- * as we don't want to actually store any data - we just want to know if the\r
- * queue is empty or full.\r
- *\r
- * This type of semaphore can be used for pure synchronisation between tasks or\r
- * between an interrupt and a task. The semaphore need not be given back once\r
- * obtained, so one task/interrupt can continuously 'give' the semaphore while\r
- * another continuously 'takes' the semaphore. For this reason this type of\r
- * semaphore does not use a priority inheritance mechanism. For an alternative\r
- * that does use priority inheritance see xSemaphoreCreateMutex().\r
- *\r
- * @param xSemaphore Handle to the created semaphore. Should be of type SemaphoreHandle_t.\r
- *\r
- * Example usage:\r
- <pre>\r
- SemaphoreHandle_t xSemaphore = NULL;\r
-\r
- void vATask( void * pvParameters )\r
- {\r
- // Semaphore cannot be used before a call to vSemaphoreCreateBinary ().\r
- // This is a macro so pass the variable in directly.\r
- vSemaphoreCreateBinary( xSemaphore );\r
-\r
- if( xSemaphore != NULL )\r
- {\r
- // The semaphore was created successfully.\r
- // The semaphore can now be used.\r
- }\r
- }\r
- </pre>\r
- * \defgroup vSemaphoreCreateBinary vSemaphoreCreateBinary\r
- * \ingroup Semaphores\r
- */\r
-#if( configSUPPORT_DYNAMIC_ALLOCATION == 1 )\r
- #define vSemaphoreCreateBinary( xSemaphore ) \\r
- { \\r
- ( xSemaphore ) = xQueueGenericCreate( ( UBaseType_t ) 1, semSEMAPHORE_QUEUE_ITEM_LENGTH, queueQUEUE_TYPE_BINARY_SEMAPHORE ); \\r
- if( ( xSemaphore ) != NULL ) \\r
- { \\r
- ( void ) xSemaphoreGive( ( xSemaphore ) ); \\r
- } \\r
- }\r
-#endif\r
-\r
-/**\r
- * semphr. h\r
- * <pre>SemaphoreHandle_t xSemaphoreCreateBinary( void )</pre>\r
- *\r
- * Creates a new binary semaphore instance, and returns a handle by which the\r
- * new semaphore can be referenced.\r
- *\r
- * In many usage scenarios it is faster and more memory efficient to use a\r
- * direct to task notification in place of a binary semaphore!\r
- * http://www.freertos.org/RTOS-task-notifications.html\r
- *\r
- * Internally, within the FreeRTOS implementation, binary semaphores use a block\r
- * of memory, in which the semaphore structure is stored. If a binary semaphore\r
- * is created using xSemaphoreCreateBinary() then the required memory is\r
- * automatically dynamically allocated inside the xSemaphoreCreateBinary()\r
- * function. (see http://www.freertos.org/a00111.html). If a binary semaphore\r
- * is created using xSemaphoreCreateBinaryStatic() then the application writer\r
- * must provide the memory. xSemaphoreCreateBinaryStatic() therefore allows a\r
- * binary semaphore to be created without using any dynamic memory allocation.\r
- *\r
- * The old vSemaphoreCreateBinary() macro is now deprecated in favour of this\r
- * xSemaphoreCreateBinary() function. Note that binary semaphores created using\r
- * the vSemaphoreCreateBinary() macro are created in a state such that the\r
- * first call to 'take' the semaphore would pass, whereas binary semaphores\r
- * created using xSemaphoreCreateBinary() are created in a state such that the\r
- * the semaphore must first be 'given' before it can be 'taken'.\r
- *\r
- * This type of semaphore can be used for pure synchronisation between tasks or\r
- * between an interrupt and a task. The semaphore need not be given back once\r
- * obtained, so one task/interrupt can continuously 'give' the semaphore while\r
- * another continuously 'takes' the semaphore. For this reason this type of\r
- * semaphore does not use a priority inheritance mechanism. For an alternative\r
- * that does use priority inheritance see xSemaphoreCreateMutex().\r
- *\r
- * @return Handle to the created semaphore, or NULL if the memory required to\r
- * hold the semaphore's data structures could not be allocated.\r
- *\r
- * Example usage:\r
- <pre>\r
- SemaphoreHandle_t xSemaphore = NULL;\r
-\r
- void vATask( void * pvParameters )\r
- {\r
- // Semaphore cannot be used before a call to xSemaphoreCreateBinary().\r
- // This is a macro so pass the variable in directly.\r
- xSemaphore = xSemaphoreCreateBinary();\r
-\r
- if( xSemaphore != NULL )\r
- {\r
- // The semaphore was created successfully.\r
- // The semaphore can now be used.\r
- }\r
- }\r
- </pre>\r
- * \defgroup xSemaphoreCreateBinary xSemaphoreCreateBinary\r
- * \ingroup Semaphores\r
- */\r
-#if( configSUPPORT_DYNAMIC_ALLOCATION == 1 )\r
- #define xSemaphoreCreateBinary() xQueueGenericCreate( ( UBaseType_t ) 1, semSEMAPHORE_QUEUE_ITEM_LENGTH, queueQUEUE_TYPE_BINARY_SEMAPHORE )\r
-#endif\r
-\r
-/**\r
- * semphr. h\r
- * <pre>SemaphoreHandle_t xSemaphoreCreateBinaryStatic( StaticSemaphore_t *pxSemaphoreBuffer )</pre>\r
- *\r
- * Creates a new binary semaphore instance, and returns a handle by which the\r
- * new semaphore can be referenced.\r
- *\r
- * NOTE: In many usage scenarios it is faster and more memory efficient to use a\r
- * direct to task notification in place of a binary semaphore!\r
- * http://www.freertos.org/RTOS-task-notifications.html\r
- *\r
- * Internally, within the FreeRTOS implementation, binary semaphores use a block\r
- * of memory, in which the semaphore structure is stored. If a binary semaphore\r
- * is created using xSemaphoreCreateBinary() then the required memory is\r
- * automatically dynamically allocated inside the xSemaphoreCreateBinary()\r
- * function. (see http://www.freertos.org/a00111.html). If a binary semaphore\r
- * is created using xSemaphoreCreateBinaryStatic() then the application writer\r
- * must provide the memory. xSemaphoreCreateBinaryStatic() therefore allows a\r
- * binary semaphore to be created without using any dynamic memory allocation.\r
- *\r
- * This type of semaphore can be used for pure synchronisation between tasks or\r
- * between an interrupt and a task. The semaphore need not be given back once\r
- * obtained, so one task/interrupt can continuously 'give' the semaphore while\r
- * another continuously 'takes' the semaphore. For this reason this type of\r
- * semaphore does not use a priority inheritance mechanism. For an alternative\r
- * that does use priority inheritance see xSemaphoreCreateMutex().\r
- *\r
- * @param pxSemaphoreBuffer Must point to a variable of type StaticSemaphore_t,\r
- * which will then be used to hold the semaphore's data structure, removing the\r
- * need for the memory to be allocated dynamically.\r
- *\r
- * @return If the semaphore is created then a handle to the created semaphore is\r
- * returned. If pxSemaphoreBuffer is NULL then NULL is returned.\r
- *\r
- * Example usage:\r
- <pre>\r
- SemaphoreHandle_t xSemaphore = NULL;\r
- StaticSemaphore_t xSemaphoreBuffer;\r
-\r
- void vATask( void * pvParameters )\r
- {\r
- // Semaphore cannot be used before a call to xSemaphoreCreateBinary().\r
- // The semaphore's data structures will be placed in the xSemaphoreBuffer\r
- // variable, the address of which is passed into the function. The\r
- // function's parameter is not NULL, so the function will not attempt any\r
- // dynamic memory allocation, and therefore the function will not return\r
- // return NULL.\r
- xSemaphore = xSemaphoreCreateBinary( &xSemaphoreBuffer );\r
-\r
- // Rest of task code goes here.\r
- }\r
- </pre>\r
- * \defgroup xSemaphoreCreateBinaryStatic xSemaphoreCreateBinaryStatic\r
- * \ingroup Semaphores\r
- */\r
-#if( configSUPPORT_STATIC_ALLOCATION == 1 )\r
- #define xSemaphoreCreateBinaryStatic( pxStaticSemaphore ) xQueueGenericCreateStatic( ( UBaseType_t ) 1, semSEMAPHORE_QUEUE_ITEM_LENGTH, NULL, pxStaticSemaphore, queueQUEUE_TYPE_BINARY_SEMAPHORE )\r
-#endif /* configSUPPORT_STATIC_ALLOCATION */\r
-\r
-/**\r
- * semphr. h\r
- * <pre>xSemaphoreTake(\r
- * SemaphoreHandle_t xSemaphore,\r
- * TickType_t xBlockTime\r
- * )</pre>\r
- *\r
- * <i>Macro</i> to obtain a semaphore. The semaphore must have previously been\r
- * created with a call to xSemaphoreCreateBinary(), xSemaphoreCreateMutex() or\r
- * xSemaphoreCreateCounting().\r
- *\r
- * @param xSemaphore A handle to the semaphore being taken - obtained when\r
- * the semaphore was created.\r
- *\r
- * @param xBlockTime The time in ticks to wait for the semaphore to become\r
- * available. The macro portTICK_PERIOD_MS can be used to convert this to a\r
- * real time. A block time of zero can be used to poll the semaphore. A block\r
- * time of portMAX_DELAY can be used to block indefinitely (provided\r
- * INCLUDE_vTaskSuspend is set to 1 in FreeRTOSConfig.h).\r
- *\r
- * @return pdTRUE if the semaphore was obtained. pdFALSE\r
- * if xBlockTime expired without the semaphore becoming available.\r
- *\r
- * Example usage:\r
- <pre>\r
- SemaphoreHandle_t xSemaphore = NULL;\r
-\r
- // A task that creates a semaphore.\r
- void vATask( void * pvParameters )\r
- {\r
- // Create the semaphore to guard a shared resource.\r
- xSemaphore = xSemaphoreCreateBinary();\r
- }\r
-\r
- // A task that uses the semaphore.\r
- void vAnotherTask( void * pvParameters )\r
- {\r
- // ... Do other things.\r
-\r
- if( xSemaphore != NULL )\r
- {\r
- // See if we can obtain the semaphore. If the semaphore is not available\r
- // wait 10 ticks to see if it becomes free.\r
- if( xSemaphoreTake( xSemaphore, ( TickType_t ) 10 ) == pdTRUE )\r
- {\r
- // We were able to obtain the semaphore and can now access the\r
- // shared resource.\r
-\r
- // ...\r
-\r
- // We have finished accessing the shared resource. Release the\r
- // semaphore.\r
- xSemaphoreGive( xSemaphore );\r
- }\r
- else\r
- {\r
- // We could not obtain the semaphore and can therefore not access\r
- // the shared resource safely.\r
- }\r
- }\r
- }\r
- </pre>\r
- * \defgroup xSemaphoreTake xSemaphoreTake\r
- * \ingroup Semaphores\r
- */\r
-#define xSemaphoreTake( xSemaphore, xBlockTime ) xQueueSemaphoreTake( ( xSemaphore ), ( xBlockTime ) )\r
-\r
-/**\r
- * semphr. h\r
- * xSemaphoreTakeRecursive(\r
- * SemaphoreHandle_t xMutex,\r
- * TickType_t xBlockTime\r
- * )\r
- *\r
- * <i>Macro</i> to recursively obtain, or 'take', a mutex type semaphore.\r
- * The mutex must have previously been created using a call to\r
- * xSemaphoreCreateRecursiveMutex();\r
- *\r
- * configUSE_RECURSIVE_MUTEXES must be set to 1 in FreeRTOSConfig.h for this\r
- * macro to be available.\r
- *\r
- * This macro must not be used on mutexes created using xSemaphoreCreateMutex().\r
- *\r
- * A mutex used recursively can be 'taken' repeatedly by the owner. The mutex\r
- * doesn't become available again until the owner has called\r
- * xSemaphoreGiveRecursive() for each successful 'take' request. For example,\r
- * if a task successfully 'takes' the same mutex 5 times then the mutex will\r
- * not be available to any other task until it has also 'given' the mutex back\r
- * exactly five times.\r
- *\r
- * @param xMutex A handle to the mutex being obtained. This is the\r
- * handle returned by xSemaphoreCreateRecursiveMutex();\r
- *\r
- * @param xBlockTime The time in ticks to wait for the semaphore to become\r
- * available. The macro portTICK_PERIOD_MS can be used to convert this to a\r
- * real time. A block time of zero can be used to poll the semaphore. If\r
- * the task already owns the semaphore then xSemaphoreTakeRecursive() will\r
- * return immediately no matter what the value of xBlockTime.\r
- *\r
- * @return pdTRUE if the semaphore was obtained. pdFALSE if xBlockTime\r
- * expired without the semaphore becoming available.\r
- *\r
- * Example usage:\r
- <pre>\r
- SemaphoreHandle_t xMutex = NULL;\r
-\r
- // A task that creates a mutex.\r
- void vATask( void * pvParameters )\r
- {\r
- // Create the mutex to guard a shared resource.\r
- xMutex = xSemaphoreCreateRecursiveMutex();\r
- }\r
-\r
- // A task that uses the mutex.\r
- void vAnotherTask( void * pvParameters )\r
- {\r
- // ... Do other things.\r
-\r
- if( xMutex != NULL )\r
- {\r
- // See if we can obtain the mutex. If the mutex is not available\r
- // wait 10 ticks to see if it becomes free.\r
- if( xSemaphoreTakeRecursive( xSemaphore, ( TickType_t ) 10 ) == pdTRUE )\r
- {\r
- // We were able to obtain the mutex and can now access the\r
- // shared resource.\r
-\r
- // ...\r
- // For some reason due to the nature of the code further calls to\r
- // xSemaphoreTakeRecursive() are made on the same mutex. In real\r
- // code these would not be just sequential calls as this would make\r
- // no sense. Instead the calls are likely to be buried inside\r
- // a more complex call structure.\r
- xSemaphoreTakeRecursive( xMutex, ( TickType_t ) 10 );\r
- xSemaphoreTakeRecursive( xMutex, ( TickType_t ) 10 );\r
-\r
- // The mutex has now been 'taken' three times, so will not be\r
- // available to another task until it has also been given back\r
- // three times. Again it is unlikely that real code would have\r
- // these calls sequentially, but instead buried in a more complex\r
- // call structure. This is just for illustrative purposes.\r
- xSemaphoreGiveRecursive( xMutex );\r
- xSemaphoreGiveRecursive( xMutex );\r
- xSemaphoreGiveRecursive( xMutex );\r
-\r
- // Now the mutex can be taken by other tasks.\r
- }\r
- else\r
- {\r
- // We could not obtain the mutex and can therefore not access\r
- // the shared resource safely.\r
- }\r
- }\r
- }\r
- </pre>\r
- * \defgroup xSemaphoreTakeRecursive xSemaphoreTakeRecursive\r
- * \ingroup Semaphores\r
- */\r
-#if( configUSE_RECURSIVE_MUTEXES == 1 )\r
- #define xSemaphoreTakeRecursive( xMutex, xBlockTime ) xQueueTakeMutexRecursive( ( xMutex ), ( xBlockTime ) )\r
-#endif\r
-\r
-/**\r
- * semphr. h\r
- * <pre>xSemaphoreGive( SemaphoreHandle_t xSemaphore )</pre>\r
- *\r
- * <i>Macro</i> to release a semaphore. The semaphore must have previously been\r
- * created with a call to xSemaphoreCreateBinary(), xSemaphoreCreateMutex() or\r
- * xSemaphoreCreateCounting(). and obtained using sSemaphoreTake().\r
- *\r
- * This macro must not be used from an ISR. See xSemaphoreGiveFromISR () for\r
- * an alternative which can be used from an ISR.\r
- *\r
- * This macro must also not be used on semaphores created using\r
- * xSemaphoreCreateRecursiveMutex().\r
- *\r
- * @param xSemaphore A handle to the semaphore being released. This is the\r
- * handle returned when the semaphore was created.\r
- *\r
- * @return pdTRUE if the semaphore was released. pdFALSE if an error occurred.\r
- * Semaphores are implemented using queues. An error can occur if there is\r
- * no space on the queue to post a message - indicating that the\r
- * semaphore was not first obtained correctly.\r
- *\r
- * Example usage:\r
- <pre>\r
- SemaphoreHandle_t xSemaphore = NULL;\r
-\r
- void vATask( void * pvParameters )\r
- {\r
- // Create the semaphore to guard a shared resource.\r
- xSemaphore = vSemaphoreCreateBinary();\r
-\r
- if( xSemaphore != NULL )\r
- {\r
- if( xSemaphoreGive( xSemaphore ) != pdTRUE )\r
- {\r
- // We would expect this call to fail because we cannot give\r
- // a semaphore without first "taking" it!\r
- }\r
-\r
- // Obtain the semaphore - don't block if the semaphore is not\r
- // immediately available.\r
- if( xSemaphoreTake( xSemaphore, ( TickType_t ) 0 ) )\r
- {\r
- // We now have the semaphore and can access the shared resource.\r
-\r
- // ...\r
-\r
- // We have finished accessing the shared resource so can free the\r
- // semaphore.\r
- if( xSemaphoreGive( xSemaphore ) != pdTRUE )\r
- {\r
- // We would not expect this call to fail because we must have\r
- // obtained the semaphore to get here.\r
- }\r
- }\r
- }\r
- }\r
- </pre>\r
- * \defgroup xSemaphoreGive xSemaphoreGive\r
- * \ingroup Semaphores\r
- */\r
-#define xSemaphoreGive( xSemaphore ) xQueueGenericSend( ( QueueHandle_t ) ( xSemaphore ), NULL, semGIVE_BLOCK_TIME, queueSEND_TO_BACK )\r
-\r
-/**\r
- * semphr. h\r
- * <pre>xSemaphoreGiveRecursive( SemaphoreHandle_t xMutex )</pre>\r
- *\r
- * <i>Macro</i> to recursively release, or 'give', a mutex type semaphore.\r
- * The mutex must have previously been created using a call to\r
- * xSemaphoreCreateRecursiveMutex();\r
- *\r
- * configUSE_RECURSIVE_MUTEXES must be set to 1 in FreeRTOSConfig.h for this\r
- * macro to be available.\r
- *\r
- * This macro must not be used on mutexes created using xSemaphoreCreateMutex().\r
- *\r
- * A mutex used recursively can be 'taken' repeatedly by the owner. The mutex\r
- * doesn't become available again until the owner has called\r
- * xSemaphoreGiveRecursive() for each successful 'take' request. For example,\r
- * if a task successfully 'takes' the same mutex 5 times then the mutex will\r
- * not be available to any other task until it has also 'given' the mutex back\r
- * exactly five times.\r
- *\r
- * @param xMutex A handle to the mutex being released, or 'given'. This is the\r
- * handle returned by xSemaphoreCreateMutex();\r
- *\r
- * @return pdTRUE if the semaphore was given.\r
- *\r
- * Example usage:\r
- <pre>\r
- SemaphoreHandle_t xMutex = NULL;\r
-\r
- // A task that creates a mutex.\r
- void vATask( void * pvParameters )\r
- {\r
- // Create the mutex to guard a shared resource.\r
- xMutex = xSemaphoreCreateRecursiveMutex();\r
- }\r
-\r
- // A task that uses the mutex.\r
- void vAnotherTask( void * pvParameters )\r
- {\r
- // ... Do other things.\r
-\r
- if( xMutex != NULL )\r
- {\r
- // See if we can obtain the mutex. If the mutex is not available\r
- // wait 10 ticks to see if it becomes free.\r
- if( xSemaphoreTakeRecursive( xMutex, ( TickType_t ) 10 ) == pdTRUE )\r
- {\r
- // We were able to obtain the mutex and can now access the\r
- // shared resource.\r
-\r
- // ...\r
- // For some reason due to the nature of the code further calls to\r
- // xSemaphoreTakeRecursive() are made on the same mutex. In real\r
- // code these would not be just sequential calls as this would make\r
- // no sense. Instead the calls are likely to be buried inside\r
- // a more complex call structure.\r
- xSemaphoreTakeRecursive( xMutex, ( TickType_t ) 10 );\r
- xSemaphoreTakeRecursive( xMutex, ( TickType_t ) 10 );\r
-\r
- // The mutex has now been 'taken' three times, so will not be\r
- // available to another task until it has also been given back\r
- // three times. Again it is unlikely that real code would have\r
- // these calls sequentially, it would be more likely that the calls\r
- // to xSemaphoreGiveRecursive() would be called as a call stack\r
- // unwound. This is just for demonstrative purposes.\r
- xSemaphoreGiveRecursive( xMutex );\r
- xSemaphoreGiveRecursive( xMutex );\r
- xSemaphoreGiveRecursive( xMutex );\r
-\r
- // Now the mutex can be taken by other tasks.\r
- }\r
- else\r
- {\r
- // We could not obtain the mutex and can therefore not access\r
- // the shared resource safely.\r
- }\r
- }\r
- }\r
- </pre>\r
- * \defgroup xSemaphoreGiveRecursive xSemaphoreGiveRecursive\r
- * \ingroup Semaphores\r
- */\r
-#if( configUSE_RECURSIVE_MUTEXES == 1 )\r
- #define xSemaphoreGiveRecursive( xMutex ) xQueueGiveMutexRecursive( ( xMutex ) )\r
-#endif\r
-\r
-/**\r
- * semphr. h\r
- * <pre>\r
- xSemaphoreGiveFromISR(\r
- SemaphoreHandle_t xSemaphore,\r
- BaseType_t *pxHigherPriorityTaskWoken\r
- )</pre>\r
- *\r
- * <i>Macro</i> to release a semaphore. The semaphore must have previously been\r
- * created with a call to xSemaphoreCreateBinary() or xSemaphoreCreateCounting().\r
- *\r
- * Mutex type semaphores (those created using a call to xSemaphoreCreateMutex())\r
- * must not be used with this macro.\r
- *\r
- * This macro can be used from an ISR.\r
- *\r
- * @param xSemaphore A handle to the semaphore being released. This is the\r
- * handle returned when the semaphore was created.\r
- *\r
- * @param pxHigherPriorityTaskWoken xSemaphoreGiveFromISR() will set\r
- * *pxHigherPriorityTaskWoken to pdTRUE if giving the semaphore caused a task\r
- * to unblock, and the unblocked task has a priority higher than the currently\r
- * running task. If xSemaphoreGiveFromISR() sets this value to pdTRUE then\r
- * a context switch should be requested before the interrupt is exited.\r
- *\r
- * @return pdTRUE if the semaphore was successfully given, otherwise errQUEUE_FULL.\r
- *\r
- * Example usage:\r
- <pre>\r
- \#define LONG_TIME 0xffff\r
- \#define TICKS_TO_WAIT 10\r
- SemaphoreHandle_t xSemaphore = NULL;\r
-\r
- // Repetitive task.\r
- void vATask( void * pvParameters )\r
- {\r
- for( ;; )\r
- {\r
- // We want this task to run every 10 ticks of a timer. The semaphore\r
- // was created before this task was started.\r
-\r
- // Block waiting for the semaphore to become available.\r
- if( xSemaphoreTake( xSemaphore, LONG_TIME ) == pdTRUE )\r
- {\r
- // It is time to execute.\r
-\r
- // ...\r
-\r
- // We have finished our task. Return to the top of the loop where\r
- // we will block on the semaphore until it is time to execute\r
- // again. Note when using the semaphore for synchronisation with an\r
- // ISR in this manner there is no need to 'give' the semaphore back.\r
- }\r
- }\r
- }\r
-\r
- // Timer ISR\r
- void vTimerISR( void * pvParameters )\r
- {\r
- static uint8_t ucLocalTickCount = 0;\r
- static BaseType_t xHigherPriorityTaskWoken;\r
-\r
- // A timer tick has occurred.\r
-\r
- // ... Do other time functions.\r
-\r
- // Is it time for vATask () to run?\r
- xHigherPriorityTaskWoken = pdFALSE;\r
- ucLocalTickCount++;\r
- if( ucLocalTickCount >= TICKS_TO_WAIT )\r
- {\r
- // Unblock the task by releasing the semaphore.\r
- xSemaphoreGiveFromISR( xSemaphore, &xHigherPriorityTaskWoken );\r
-\r
- // Reset the count so we release the semaphore again in 10 ticks time.\r
- ucLocalTickCount = 0;\r
- }\r
-\r
- if( xHigherPriorityTaskWoken != pdFALSE )\r
- {\r
- // We can force a context switch here. Context switching from an\r
- // ISR uses port specific syntax. Check the demo task for your port\r
- // to find the syntax required.\r
- }\r
- }\r
- </pre>\r
- * \defgroup xSemaphoreGiveFromISR xSemaphoreGiveFromISR\r
- * \ingroup Semaphores\r
- */\r
-#define xSemaphoreGiveFromISR( xSemaphore, pxHigherPriorityTaskWoken ) xQueueGiveFromISR( ( QueueHandle_t ) ( xSemaphore ), ( pxHigherPriorityTaskWoken ) )\r
-\r
-/**\r
- * semphr. h\r
- * <pre>\r
- xSemaphoreTakeFromISR(\r
- SemaphoreHandle_t xSemaphore,\r
- BaseType_t *pxHigherPriorityTaskWoken\r
- )</pre>\r
- *\r
- * <i>Macro</i> to take a semaphore from an ISR. The semaphore must have\r
- * previously been created with a call to xSemaphoreCreateBinary() or\r
- * xSemaphoreCreateCounting().\r
- *\r
- * Mutex type semaphores (those created using a call to xSemaphoreCreateMutex())\r
- * must not be used with this macro.\r
- *\r
- * This macro can be used from an ISR, however taking a semaphore from an ISR\r
- * is not a common operation. It is likely to only be useful when taking a\r
- * counting semaphore when an interrupt is obtaining an object from a resource\r
- * pool (when the semaphore count indicates the number of resources available).\r
- *\r
- * @param xSemaphore A handle to the semaphore being taken. This is the\r
- * handle returned when the semaphore was created.\r
- *\r
- * @param pxHigherPriorityTaskWoken xSemaphoreTakeFromISR() will set\r
- * *pxHigherPriorityTaskWoken to pdTRUE if taking the semaphore caused a task\r
- * to unblock, and the unblocked task has a priority higher than the currently\r
- * running task. If xSemaphoreTakeFromISR() sets this value to pdTRUE then\r
- * a context switch should be requested before the interrupt is exited.\r
- *\r
- * @return pdTRUE if the semaphore was successfully taken, otherwise\r
- * pdFALSE\r
- */\r
-#define xSemaphoreTakeFromISR( xSemaphore, pxHigherPriorityTaskWoken ) xQueueReceiveFromISR( ( QueueHandle_t ) ( xSemaphore ), NULL, ( pxHigherPriorityTaskWoken ) )\r
-\r
-/**\r
- * semphr. h\r
- * <pre>SemaphoreHandle_t xSemaphoreCreateMutex( void )</pre>\r
- *\r
- * Creates a new mutex type semaphore instance, and returns a handle by which\r
- * the new mutex can be referenced.\r
- *\r
- * Internally, within the FreeRTOS implementation, mutex semaphores use a block\r
- * of memory, in which the mutex structure is stored. If a mutex is created\r
- * using xSemaphoreCreateMutex() then the required memory is automatically\r
- * dynamically allocated inside the xSemaphoreCreateMutex() function. (see\r
- * http://www.freertos.org/a00111.html). If a mutex is created using\r
- * xSemaphoreCreateMutexStatic() then the application writer must provided the\r
- * memory. xSemaphoreCreateMutexStatic() therefore allows a mutex to be created\r
- * without using any dynamic memory allocation.\r
- *\r
- * Mutexes created using this function can be accessed using the xSemaphoreTake()\r
- * and xSemaphoreGive() macros. The xSemaphoreTakeRecursive() and\r
- * xSemaphoreGiveRecursive() macros must not be used.\r
- *\r
- * This type of semaphore uses a priority inheritance mechanism so a task\r
- * 'taking' a semaphore MUST ALWAYS 'give' the semaphore back once the\r
- * semaphore it is no longer required.\r
- *\r
- * Mutex type semaphores cannot be used from within interrupt service routines.\r
- *\r
- * See xSemaphoreCreateBinary() for an alternative implementation that can be\r
- * used for pure synchronisation (where one task or interrupt always 'gives' the\r
- * semaphore and another always 'takes' the semaphore) and from within interrupt\r
- * service routines.\r
- *\r
- * @return If the mutex was successfully created then a handle to the created\r
- * semaphore is returned. If there was not enough heap to allocate the mutex\r
- * data structures then NULL is returned.\r
- *\r
- * Example usage:\r
- <pre>\r
- SemaphoreHandle_t xSemaphore;\r
-\r
- void vATask( void * pvParameters )\r
- {\r
- // Semaphore cannot be used before a call to xSemaphoreCreateMutex().\r
- // This is a macro so pass the variable in directly.\r
- xSemaphore = xSemaphoreCreateMutex();\r
-\r
- if( xSemaphore != NULL )\r
- {\r
- // The semaphore was created successfully.\r
- // The semaphore can now be used.\r
- }\r
- }\r
- </pre>\r
- * \defgroup xSemaphoreCreateMutex xSemaphoreCreateMutex\r
- * \ingroup Semaphores\r
- */\r
-#if( configSUPPORT_DYNAMIC_ALLOCATION == 1 )\r
- #define xSemaphoreCreateMutex() xQueueCreateMutex( queueQUEUE_TYPE_MUTEX )\r
-#endif\r
-\r
-/**\r
- * semphr. h\r
- * <pre>SemaphoreHandle_t xSemaphoreCreateMutexStatic( StaticSemaphore_t *pxMutexBuffer )</pre>\r
- *\r
- * Creates a new mutex type semaphore instance, and returns a handle by which\r
- * the new mutex can be referenced.\r
- *\r
- * Internally, within the FreeRTOS implementation, mutex semaphores use a block\r
- * of memory, in which the mutex structure is stored. If a mutex is created\r
- * using xSemaphoreCreateMutex() then the required memory is automatically\r
- * dynamically allocated inside the xSemaphoreCreateMutex() function. (see\r
- * http://www.freertos.org/a00111.html). If a mutex is created using\r
- * xSemaphoreCreateMutexStatic() then the application writer must provided the\r
- * memory. xSemaphoreCreateMutexStatic() therefore allows a mutex to be created\r
- * without using any dynamic memory allocation.\r
- *\r
- * Mutexes created using this function can be accessed using the xSemaphoreTake()\r
- * and xSemaphoreGive() macros. The xSemaphoreTakeRecursive() and\r
- * xSemaphoreGiveRecursive() macros must not be used.\r
- *\r
- * This type of semaphore uses a priority inheritance mechanism so a task\r
- * 'taking' a semaphore MUST ALWAYS 'give' the semaphore back once the\r
- * semaphore it is no longer required.\r
- *\r
- * Mutex type semaphores cannot be used from within interrupt service routines.\r
- *\r
- * See xSemaphoreCreateBinary() for an alternative implementation that can be\r
- * used for pure synchronisation (where one task or interrupt always 'gives' the\r
- * semaphore and another always 'takes' the semaphore) and from within interrupt\r
- * service routines.\r
- *\r
- * @param pxMutexBuffer Must point to a variable of type StaticSemaphore_t,\r
- * which will be used to hold the mutex's data structure, removing the need for\r
- * the memory to be allocated dynamically.\r
- *\r
- * @return If the mutex was successfully created then a handle to the created\r
- * mutex is returned. If pxMutexBuffer was NULL then NULL is returned.\r
- *\r
- * Example usage:\r
- <pre>\r
- SemaphoreHandle_t xSemaphore;\r
- StaticSemaphore_t xMutexBuffer;\r
-\r
- void vATask( void * pvParameters )\r
- {\r
- // A mutex cannot be used before it has been created. xMutexBuffer is\r
- // into xSemaphoreCreateMutexStatic() so no dynamic memory allocation is\r
- // attempted.\r
- xSemaphore = xSemaphoreCreateMutexStatic( &xMutexBuffer );\r
-\r
- // As no dynamic memory allocation was performed, xSemaphore cannot be NULL,\r
- // so there is no need to check it.\r
- }\r
- </pre>\r
- * \defgroup xSemaphoreCreateMutexStatic xSemaphoreCreateMutexStatic\r
- * \ingroup Semaphores\r
- */\r
- #if( configSUPPORT_STATIC_ALLOCATION == 1 )\r
- #define xSemaphoreCreateMutexStatic( pxMutexBuffer ) xQueueCreateMutexStatic( queueQUEUE_TYPE_MUTEX, ( pxMutexBuffer ) )\r
-#endif /* configSUPPORT_STATIC_ALLOCATION */\r
-\r
-\r
-/**\r
- * semphr. h\r
- * <pre>SemaphoreHandle_t xSemaphoreCreateRecursiveMutex( void )</pre>\r
- *\r
- * Creates a new recursive mutex type semaphore instance, and returns a handle\r
- * by which the new recursive mutex can be referenced.\r
- *\r
- * Internally, within the FreeRTOS implementation, recursive mutexs use a block\r
- * of memory, in which the mutex structure is stored. If a recursive mutex is\r
- * created using xSemaphoreCreateRecursiveMutex() then the required memory is\r
- * automatically dynamically allocated inside the\r
- * xSemaphoreCreateRecursiveMutex() function. (see\r
- * http://www.freertos.org/a00111.html). If a recursive mutex is created using\r
- * xSemaphoreCreateRecursiveMutexStatic() then the application writer must\r
- * provide the memory that will get used by the mutex.\r
- * xSemaphoreCreateRecursiveMutexStatic() therefore allows a recursive mutex to\r
- * be created without using any dynamic memory allocation.\r
- *\r
- * Mutexes created using this macro can be accessed using the\r
- * xSemaphoreTakeRecursive() and xSemaphoreGiveRecursive() macros. The\r
- * xSemaphoreTake() and xSemaphoreGive() macros must not be used.\r
- *\r
- * A mutex used recursively can be 'taken' repeatedly by the owner. The mutex\r
- * doesn't become available again until the owner has called\r
- * xSemaphoreGiveRecursive() for each successful 'take' request. For example,\r
- * if a task successfully 'takes' the same mutex 5 times then the mutex will\r
- * not be available to any other task until it has also 'given' the mutex back\r
- * exactly five times.\r
- *\r
- * This type of semaphore uses a priority inheritance mechanism so a task\r
- * 'taking' a semaphore MUST ALWAYS 'give' the semaphore back once the\r
- * semaphore it is no longer required.\r
- *\r
- * Mutex type semaphores cannot be used from within interrupt service routines.\r
- *\r
- * See xSemaphoreCreateBinary() for an alternative implementation that can be\r
- * used for pure synchronisation (where one task or interrupt always 'gives' the\r
- * semaphore and another always 'takes' the semaphore) and from within interrupt\r
- * service routines.\r
- *\r
- * @return xSemaphore Handle to the created mutex semaphore. Should be of type\r
- * SemaphoreHandle_t.\r
- *\r
- * Example usage:\r
- <pre>\r
- SemaphoreHandle_t xSemaphore;\r
-\r
- void vATask( void * pvParameters )\r
- {\r
- // Semaphore cannot be used before a call to xSemaphoreCreateMutex().\r
- // This is a macro so pass the variable in directly.\r
- xSemaphore = xSemaphoreCreateRecursiveMutex();\r
-\r
- if( xSemaphore != NULL )\r
- {\r
- // The semaphore was created successfully.\r
- // The semaphore can now be used.\r
- }\r
- }\r
- </pre>\r
- * \defgroup xSemaphoreCreateRecursiveMutex xSemaphoreCreateRecursiveMutex\r
- * \ingroup Semaphores\r
- */\r
-#if( ( configSUPPORT_DYNAMIC_ALLOCATION == 1 ) && ( configUSE_RECURSIVE_MUTEXES == 1 ) )\r
- #define xSemaphoreCreateRecursiveMutex() xQueueCreateMutex( queueQUEUE_TYPE_RECURSIVE_MUTEX )\r
-#endif\r
-\r
-/**\r
- * semphr. h\r
- * <pre>SemaphoreHandle_t xSemaphoreCreateRecursiveMutexStatic( StaticSemaphore_t *pxMutexBuffer )</pre>\r
- *\r
- * Creates a new recursive mutex type semaphore instance, and returns a handle\r
- * by which the new recursive mutex can be referenced.\r
- *\r
- * Internally, within the FreeRTOS implementation, recursive mutexs use a block\r
- * of memory, in which the mutex structure is stored. If a recursive mutex is\r
- * created using xSemaphoreCreateRecursiveMutex() then the required memory is\r
- * automatically dynamically allocated inside the\r
- * xSemaphoreCreateRecursiveMutex() function. (see\r
- * http://www.freertos.org/a00111.html). If a recursive mutex is created using\r
- * xSemaphoreCreateRecursiveMutexStatic() then the application writer must\r
- * provide the memory that will get used by the mutex.\r
- * xSemaphoreCreateRecursiveMutexStatic() therefore allows a recursive mutex to\r
- * be created without using any dynamic memory allocation.\r
- *\r
- * Mutexes created using this macro can be accessed using the\r
- * xSemaphoreTakeRecursive() and xSemaphoreGiveRecursive() macros. The\r
- * xSemaphoreTake() and xSemaphoreGive() macros must not be used.\r
- *\r
- * A mutex used recursively can be 'taken' repeatedly by the owner. The mutex\r
- * doesn't become available again until the owner has called\r
- * xSemaphoreGiveRecursive() for each successful 'take' request. For example,\r
- * if a task successfully 'takes' the same mutex 5 times then the mutex will\r
- * not be available to any other task until it has also 'given' the mutex back\r
- * exactly five times.\r
- *\r
- * This type of semaphore uses a priority inheritance mechanism so a task\r
- * 'taking' a semaphore MUST ALWAYS 'give' the semaphore back once the\r
- * semaphore it is no longer required.\r
- *\r
- * Mutex type semaphores cannot be used from within interrupt service routines.\r
- *\r
- * See xSemaphoreCreateBinary() for an alternative implementation that can be\r
- * used for pure synchronisation (where one task or interrupt always 'gives' the\r
- * semaphore and another always 'takes' the semaphore) and from within interrupt\r
- * service routines.\r
- *\r
- * @param pxMutexBuffer Must point to a variable of type StaticSemaphore_t,\r
- * which will then be used to hold the recursive mutex's data structure,\r
- * removing the need for the memory to be allocated dynamically.\r
- *\r
- * @return If the recursive mutex was successfully created then a handle to the\r
- * created recursive mutex is returned. If pxMutexBuffer was NULL then NULL is\r
- * returned.\r
- *\r
- * Example usage:\r
- <pre>\r
- SemaphoreHandle_t xSemaphore;\r
- StaticSemaphore_t xMutexBuffer;\r
-\r
- void vATask( void * pvParameters )\r
- {\r
- // A recursive semaphore cannot be used before it is created. Here a\r
- // recursive mutex is created using xSemaphoreCreateRecursiveMutexStatic().\r
- // The address of xMutexBuffer is passed into the function, and will hold\r
- // the mutexes data structures - so no dynamic memory allocation will be\r
- // attempted.\r
- xSemaphore = xSemaphoreCreateRecursiveMutexStatic( &xMutexBuffer );\r
-\r
- // As no dynamic memory allocation was performed, xSemaphore cannot be NULL,\r
- // so there is no need to check it.\r
- }\r
- </pre>\r
- * \defgroup xSemaphoreCreateRecursiveMutexStatic xSemaphoreCreateRecursiveMutexStatic\r
- * \ingroup Semaphores\r
- */\r
-#if( ( configSUPPORT_STATIC_ALLOCATION == 1 ) && ( configUSE_RECURSIVE_MUTEXES == 1 ) )\r
- #define xSemaphoreCreateRecursiveMutexStatic( pxStaticSemaphore ) xQueueCreateMutexStatic( queueQUEUE_TYPE_RECURSIVE_MUTEX, pxStaticSemaphore )\r
-#endif /* configSUPPORT_STATIC_ALLOCATION */\r
-\r
-/**\r
- * semphr. h\r
- * <pre>SemaphoreHandle_t xSemaphoreCreateCounting( UBaseType_t uxMaxCount, UBaseType_t uxInitialCount )</pre>\r
- *\r
- * Creates a new counting semaphore instance, and returns a handle by which the\r
- * new counting semaphore can be referenced.\r
- *\r
- * In many usage scenarios it is faster and more memory efficient to use a\r
- * direct to task notification in place of a counting semaphore!\r
- * http://www.freertos.org/RTOS-task-notifications.html\r
- *\r
- * Internally, within the FreeRTOS implementation, counting semaphores use a\r
- * block of memory, in which the counting semaphore structure is stored. If a\r
- * counting semaphore is created using xSemaphoreCreateCounting() then the\r
- * required memory is automatically dynamically allocated inside the\r
- * xSemaphoreCreateCounting() function. (see\r
- * http://www.freertos.org/a00111.html). If a counting semaphore is created\r
- * using xSemaphoreCreateCountingStatic() then the application writer can\r
- * instead optionally provide the memory that will get used by the counting\r
- * semaphore. xSemaphoreCreateCountingStatic() therefore allows a counting\r
- * semaphore to be created without using any dynamic memory allocation.\r
- *\r
- * Counting semaphores are typically used for two things:\r
- *\r
- * 1) Counting events.\r
- *\r
- * In this usage scenario an event handler will 'give' a semaphore each time\r
- * an event occurs (incrementing the semaphore count value), and a handler\r
- * task will 'take' a semaphore each time it processes an event\r
- * (decrementing the semaphore count value). The count value is therefore\r
- * the difference between the number of events that have occurred and the\r
- * number that have been processed. In this case it is desirable for the\r
- * initial count value to be zero.\r
- *\r
- * 2) Resource management.\r
- *\r
- * In this usage scenario the count value indicates the number of resources\r
- * available. To obtain control of a resource a task must first obtain a\r
- * semaphore - decrementing the semaphore count value. When the count value\r
- * reaches zero there are no free resources. When a task finishes with the\r
- * resource it 'gives' the semaphore back - incrementing the semaphore count\r
- * value. In this case it is desirable for the initial count value to be\r
- * equal to the maximum count value, indicating that all resources are free.\r
- *\r
- * @param uxMaxCount The maximum count value that can be reached. When the\r
- * semaphore reaches this value it can no longer be 'given'.\r
- *\r
- * @param uxInitialCount The count value assigned to the semaphore when it is\r
- * created.\r
- *\r
- * @return Handle to the created semaphore. Null if the semaphore could not be\r
- * created.\r
- *\r
- * Example usage:\r
- <pre>\r
- SemaphoreHandle_t xSemaphore;\r
-\r
- void vATask( void * pvParameters )\r
- {\r
- SemaphoreHandle_t xSemaphore = NULL;\r
-\r
- // Semaphore cannot be used before a call to xSemaphoreCreateCounting().\r
- // The max value to which the semaphore can count should be 10, and the\r
- // initial value assigned to the count should be 0.\r
- xSemaphore = xSemaphoreCreateCounting( 10, 0 );\r
-\r
- if( xSemaphore != NULL )\r
- {\r
- // The semaphore was created successfully.\r
- // The semaphore can now be used.\r
- }\r
- }\r
- </pre>\r
- * \defgroup xSemaphoreCreateCounting xSemaphoreCreateCounting\r
- * \ingroup Semaphores\r
- */\r
-#if( configSUPPORT_DYNAMIC_ALLOCATION == 1 )\r
- #define xSemaphoreCreateCounting( uxMaxCount, uxInitialCount ) xQueueCreateCountingSemaphore( ( uxMaxCount ), ( uxInitialCount ) )\r
-#endif\r
-\r
-/**\r
- * semphr. h\r
- * <pre>SemaphoreHandle_t xSemaphoreCreateCountingStatic( UBaseType_t uxMaxCount, UBaseType_t uxInitialCount, StaticSemaphore_t *pxSemaphoreBuffer )</pre>\r
- *\r
- * Creates a new counting semaphore instance, and returns a handle by which the\r
- * new counting semaphore can be referenced.\r
- *\r
- * In many usage scenarios it is faster and more memory efficient to use a\r
- * direct to task notification in place of a counting semaphore!\r
- * http://www.freertos.org/RTOS-task-notifications.html\r
- *\r
- * Internally, within the FreeRTOS implementation, counting semaphores use a\r
- * block of memory, in which the counting semaphore structure is stored. If a\r
- * counting semaphore is created using xSemaphoreCreateCounting() then the\r
- * required memory is automatically dynamically allocated inside the\r
- * xSemaphoreCreateCounting() function. (see\r
- * http://www.freertos.org/a00111.html). If a counting semaphore is created\r
- * using xSemaphoreCreateCountingStatic() then the application writer must\r
- * provide the memory. xSemaphoreCreateCountingStatic() therefore allows a\r
- * counting semaphore to be created without using any dynamic memory allocation.\r
- *\r
- * Counting semaphores are typically used for two things:\r
- *\r
- * 1) Counting events.\r
- *\r
- * In this usage scenario an event handler will 'give' a semaphore each time\r
- * an event occurs (incrementing the semaphore count value), and a handler\r
- * task will 'take' a semaphore each time it processes an event\r
- * (decrementing the semaphore count value). The count value is therefore\r
- * the difference between the number of events that have occurred and the\r
- * number that have been processed. In this case it is desirable for the\r
- * initial count value to be zero.\r
- *\r
- * 2) Resource management.\r
- *\r
- * In this usage scenario the count value indicates the number of resources\r
- * available. To obtain control of a resource a task must first obtain a\r
- * semaphore - decrementing the semaphore count value. When the count value\r
- * reaches zero there are no free resources. When a task finishes with the\r
- * resource it 'gives' the semaphore back - incrementing the semaphore count\r
- * value. In this case it is desirable for the initial count value to be\r
- * equal to the maximum count value, indicating that all resources are free.\r
- *\r
- * @param uxMaxCount The maximum count value that can be reached. When the\r
- * semaphore reaches this value it can no longer be 'given'.\r
- *\r
- * @param uxInitialCount The count value assigned to the semaphore when it is\r
- * created.\r
- *\r
- * @param pxSemaphoreBuffer Must point to a variable of type StaticSemaphore_t,\r
- * which will then be used to hold the semaphore's data structure, removing the\r
- * need for the memory to be allocated dynamically.\r
- *\r
- * @return If the counting semaphore was successfully created then a handle to\r
- * the created counting semaphore is returned. If pxSemaphoreBuffer was NULL\r
- * then NULL is returned.\r
- *\r
- * Example usage:\r
- <pre>\r
- SemaphoreHandle_t xSemaphore;\r
- StaticSemaphore_t xSemaphoreBuffer;\r
-\r
- void vATask( void * pvParameters )\r
- {\r
- SemaphoreHandle_t xSemaphore = NULL;\r
-\r
- // Counting semaphore cannot be used before they have been created. Create\r
- // a counting semaphore using xSemaphoreCreateCountingStatic(). The max\r
- // value to which the semaphore can count is 10, and the initial value\r
- // assigned to the count will be 0. The address of xSemaphoreBuffer is\r
- // passed in and will be used to hold the semaphore structure, so no dynamic\r
- // memory allocation will be used.\r
- xSemaphore = xSemaphoreCreateCounting( 10, 0, &xSemaphoreBuffer );\r
-\r
- // No memory allocation was attempted so xSemaphore cannot be NULL, so there\r
- // is no need to check its value.\r
- }\r
- </pre>\r
- * \defgroup xSemaphoreCreateCountingStatic xSemaphoreCreateCountingStatic\r
- * \ingroup Semaphores\r
- */\r
-#if( configSUPPORT_STATIC_ALLOCATION == 1 )\r
- #define xSemaphoreCreateCountingStatic( uxMaxCount, uxInitialCount, pxSemaphoreBuffer ) xQueueCreateCountingSemaphoreStatic( ( uxMaxCount ), ( uxInitialCount ), ( pxSemaphoreBuffer ) )\r
-#endif /* configSUPPORT_STATIC_ALLOCATION */\r
-\r
-/**\r
- * semphr. h\r
- * <pre>void vSemaphoreDelete( SemaphoreHandle_t xSemaphore );</pre>\r
- *\r
- * Delete a semaphore. This function must be used with care. For example,\r
- * do not delete a mutex type semaphore if the mutex is held by a task.\r
- *\r
- * @param xSemaphore A handle to the semaphore to be deleted.\r
- *\r
- * \defgroup vSemaphoreDelete vSemaphoreDelete\r
- * \ingroup Semaphores\r
- */\r
-#define vSemaphoreDelete( xSemaphore ) vQueueDelete( ( QueueHandle_t ) ( xSemaphore ) )\r
-\r
-/**\r
- * semphr.h\r
- * <pre>TaskHandle_t xSemaphoreGetMutexHolder( SemaphoreHandle_t xMutex );</pre>\r
- *\r
- * If xMutex is indeed a mutex type semaphore, return the current mutex holder.\r
- * If xMutex is not a mutex type semaphore, or the mutex is available (not held\r
- * by a task), return NULL.\r
- *\r
- * Note: This is a good way of determining if the calling task is the mutex\r
- * holder, but not a good way of determining the identity of the mutex holder as\r
- * the holder may change between the function exiting and the returned value\r
- * being tested.\r
- */\r
-#define xSemaphoreGetMutexHolder( xSemaphore ) xQueueGetMutexHolder( ( xSemaphore ) )\r
-\r
-/**\r
- * semphr.h\r
- * <pre>TaskHandle_t xSemaphoreGetMutexHolderFromISR( SemaphoreHandle_t xMutex );</pre>\r
- *\r
- * If xMutex is indeed a mutex type semaphore, return the current mutex holder.\r
- * If xMutex is not a mutex type semaphore, or the mutex is available (not held\r
- * by a task), return NULL.\r
- *\r
- */\r
-#define xSemaphoreGetMutexHolderFromISR( xSemaphore ) xQueueGetMutexHolderFromISR( ( xSemaphore ) )\r
-\r
-/**\r
- * semphr.h\r
- * <pre>UBaseType_t uxSemaphoreGetCount( SemaphoreHandle_t xSemaphore );</pre>\r
- *\r
- * If the semaphore is a counting semaphore then uxSemaphoreGetCount() returns\r
- * its current count value. If the semaphore is a binary semaphore then\r
- * uxSemaphoreGetCount() returns 1 if the semaphore is available, and 0 if the\r
- * semaphore is not available.\r
- *\r
- */\r
-#define uxSemaphoreGetCount( xSemaphore ) uxQueueMessagesWaiting( ( QueueHandle_t ) ( xSemaphore ) )\r
-\r
-#endif /* SEMAPHORE_H */\r
-\r
-\r
+++ /dev/null
-/*\r
- * FreeRTOS Kernel V10.0.1\r
- * Copyright (C) 2017 Amazon.com, Inc. or its affiliates. All Rights Reserved.\r
- *\r
- * Permission is hereby granted, free of charge, to any person obtaining a copy of\r
- * this software and associated documentation files (the "Software"), to deal in\r
- * the Software without restriction, including without limitation the rights to\r
- * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of\r
- * the Software, and to permit persons to whom the Software is furnished to do so,\r
- * subject to the following conditions:\r
- *\r
- * The above copyright notice and this permission notice shall be included in all\r
- * copies or substantial portions of the Software.\r
- *\r
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\r
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS\r
- * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR\r
- * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER\r
- * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN\r
- * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\r
- *\r
- * http://www.FreeRTOS.org\r
- * http://aws.amazon.com/freertos\r
- *\r
- * 1 tab == 4 spaces!\r
- */\r
-\r
-#ifndef STACK_MACROS_H\r
-#define STACK_MACROS_H\r
-\r
-/*\r
- * Call the stack overflow hook function if the stack of the task being swapped\r
- * out is currently overflowed, or looks like it might have overflowed in the\r
- * past.\r
- *\r
- * Setting configCHECK_FOR_STACK_OVERFLOW to 1 will cause the macro to check\r
- * the current stack state only - comparing the current top of stack value to\r
- * the stack limit. Setting configCHECK_FOR_STACK_OVERFLOW to greater than 1\r
- * will also cause the last few stack bytes to be checked to ensure the value\r
- * to which the bytes were set when the task was created have not been\r
- * overwritten. Note this second test does not guarantee that an overflowed\r
- * stack will always be recognised.\r
- */\r
-\r
-/*-----------------------------------------------------------*/\r
-\r
-#if( ( configCHECK_FOR_STACK_OVERFLOW == 1 ) && ( portSTACK_GROWTH < 0 ) )\r
-\r
- /* Only the current stack state is to be checked. */\r
- #define taskCHECK_FOR_STACK_OVERFLOW() \\r
- { \\r
- /* Is the currently saved stack pointer within the stack limit? */ \\r
- if( pxCurrentTCB->pxTopOfStack <= pxCurrentTCB->pxStack ) \\r
- { \\r
- vApplicationStackOverflowHook( ( TaskHandle_t ) pxCurrentTCB, pxCurrentTCB->pcTaskName ); \\r
- } \\r
- }\r
-\r
-#endif /* configCHECK_FOR_STACK_OVERFLOW == 1 */\r
-/*-----------------------------------------------------------*/\r
-\r
-#if( ( configCHECK_FOR_STACK_OVERFLOW == 1 ) && ( portSTACK_GROWTH > 0 ) )\r
-\r
- /* Only the current stack state is to be checked. */\r
- #define taskCHECK_FOR_STACK_OVERFLOW() \\r
- { \\r
- \\r
- /* Is the currently saved stack pointer within the stack limit? */ \\r
- if( pxCurrentTCB->pxTopOfStack >= pxCurrentTCB->pxEndOfStack ) \\r
- { \\r
- vApplicationStackOverflowHook( ( TaskHandle_t ) pxCurrentTCB, pxCurrentTCB->pcTaskName ); \\r
- } \\r
- }\r
-\r
-#endif /* configCHECK_FOR_STACK_OVERFLOW == 1 */\r
-/*-----------------------------------------------------------*/\r
-\r
-#if( ( configCHECK_FOR_STACK_OVERFLOW > 1 ) && ( portSTACK_GROWTH < 0 ) )\r
-\r
- #define taskCHECK_FOR_STACK_OVERFLOW() \\r
- { \\r
- const uint32_t * const pulStack = ( uint32_t * ) pxCurrentTCB->pxStack; \\r
- const uint32_t ulCheckValue = ( uint32_t ) 0xa5a5a5a5; \\r
- \\r
- if( ( pulStack[ 0 ] != ulCheckValue ) || \\r
- ( pulStack[ 1 ] != ulCheckValue ) || \\r
- ( pulStack[ 2 ] != ulCheckValue ) || \\r
- ( pulStack[ 3 ] != ulCheckValue ) ) \\r
- { \\r
- vApplicationStackOverflowHook( ( TaskHandle_t ) pxCurrentTCB, pxCurrentTCB->pcTaskName ); \\r
- } \\r
- }\r
-\r
-#endif /* #if( configCHECK_FOR_STACK_OVERFLOW > 1 ) */\r
-/*-----------------------------------------------------------*/\r
-\r
-#if( ( configCHECK_FOR_STACK_OVERFLOW > 1 ) && ( portSTACK_GROWTH > 0 ) )\r
-\r
- #define taskCHECK_FOR_STACK_OVERFLOW() \\r
- { \\r
- int8_t *pcEndOfStack = ( int8_t * ) pxCurrentTCB->pxEndOfStack; \\r
- static const uint8_t ucExpectedStackBytes[] = { tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, \\r
- tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, \\r
- tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, \\r
- tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, \\r
- tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE, tskSTACK_FILL_BYTE }; \\r
- \\r
- \\r
- pcEndOfStack -= sizeof( ucExpectedStackBytes ); \\r
- \\r
- /* Has the extremity of the task stack ever been written over? */ \\r
- if( memcmp( ( void * ) pcEndOfStack, ( void * ) ucExpectedStackBytes, sizeof( ucExpectedStackBytes ) ) != 0 ) \\r
- { \\r
- vApplicationStackOverflowHook( ( TaskHandle_t ) pxCurrentTCB, pxCurrentTCB->pcTaskName ); \\r
- } \\r
- }\r
-\r
-#endif /* #if( configCHECK_FOR_STACK_OVERFLOW > 1 ) */\r
-/*-----------------------------------------------------------*/\r
-\r
-/* Remove stack overflow macro if not being used. */\r
-#ifndef taskCHECK_FOR_STACK_OVERFLOW\r
- #define taskCHECK_FOR_STACK_OVERFLOW()\r
-#endif\r
-\r
-\r
-\r
-#endif /* STACK_MACROS_H */\r
-\r
+++ /dev/null
-\r
-#ifndef FREERTOS_STDINT\r
-#define FREERTOS_STDINT\r
-\r
-/*******************************************************************************\r
- * THIS IS NOT A FULL stdint.h IMPLEMENTATION - It only contains the definitions\r
- * necessary to build the FreeRTOS code. It is provided to allow FreeRTOS to be\r
- * built using compilers that do not provide their own stdint.h definition.\r
- *\r
- * To use this file:\r
- *\r
- * 1) Copy this file into the directory that contains your FreeRTOSConfig.h\r
- * header file, as that directory will already be in the compilers include\r
- * path.\r
- *\r
- * 2) Rename the copied file stdint.h.\r
- *\r
- */\r
-\r
-typedef signed char int8_t;\r
-typedef unsigned char uint8_t;\r
-typedef short int16_t;\r
-typedef unsigned short uint16_t;\r
-typedef long int32_t;\r
-typedef unsigned long uint32_t;\r
-\r
-#endif /* FREERTOS_STDINT */\r
+++ /dev/null
-/*\r
- * FreeRTOS Kernel V10.0.1\r
- * Copyright (C) 2017 Amazon.com, Inc. or its affiliates. All Rights Reserved.\r
- *\r
- * Permission is hereby granted, free of charge, to any person obtaining a copy of\r
- * this software and associated documentation files (the "Software"), to deal in\r
- * the Software without restriction, including without limitation the rights to\r
- * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of\r
- * the Software, and to permit persons to whom the Software is furnished to do so,\r
- * subject to the following conditions:\r
- *\r
- * The above copyright notice and this permission notice shall be included in all\r
- * copies or substantial portions of the Software.\r
- *\r
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\r
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS\r
- * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR\r
- * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER\r
- * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN\r
- * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\r
- *\r
- * http://www.FreeRTOS.org\r
- * http://aws.amazon.com/freertos\r
- *\r
- * 1 tab == 4 spaces!\r
- */\r
-\r
-/*\r
- * Stream buffers are used to send a continuous stream of data from one task or\r
- * interrupt to another. Their implementation is light weight, making them\r
- * particularly suited for interrupt to task and core to core communication\r
- * scenarios.\r
- *\r
- * ***NOTE***: Uniquely among FreeRTOS objects, the stream buffer\r
- * implementation (so also the message buffer implementation, as message buffers\r
- * are built on top of stream buffers) assumes there is only one task or\r
- * interrupt that will write to the buffer (the writer), and only one task or\r
- * interrupt that will read from the buffer (the reader). It is safe for the\r
- * writer and reader to be different tasks or interrupts, but, unlike other\r
- * FreeRTOS objects, it is not safe to have multiple different writers or\r
- * multiple different readers. If there are to be multiple different writers\r
- * then the application writer must place each call to a writing API function\r
- * (such as xStreamBufferSend()) inside a critical section and set the send\r
- * block time to 0. Likewise, if there are to be multiple different readers\r
- * then the application writer must place each call to a reading API function\r
- * (such as xStreamBufferRead()) inside a critical section section and set the\r
- * receive block time to 0.\r
- *\r
- */\r
-\r
-#ifndef STREAM_BUFFER_H\r
-#define STREAM_BUFFER_H\r
-\r
-#if defined( __cplusplus )\r
-extern "C" {\r
-#endif\r
-\r
-/**\r
- * Type by which stream buffers are referenced. For example, a call to\r
- * xStreamBufferCreate() returns an StreamBufferHandle_t variable that can\r
- * then be used as a parameter to xStreamBufferSend(), xStreamBufferReceive(),\r
- * etc.\r
- */\r
-typedef void * StreamBufferHandle_t;\r
-\r
-\r
-/**\r
- * message_buffer.h\r
- *\r
-<pre>\r
-StreamBufferHandle_t xStreamBufferCreate( size_t xBufferSizeBytes, size_t xTriggerLevelBytes );\r
-</pre>\r
- *\r
- * Creates a new stream buffer using dynamically allocated memory. See\r
- * xStreamBufferCreateStatic() for a version that uses statically allocated\r
- * memory (memory that is allocated at compile time).\r
- *\r
- * configSUPPORT_DYNAMIC_ALLOCATION must be set to 1 or left undefined in\r
- * FreeRTOSConfig.h for xStreamBufferCreate() to be available.\r
- *\r
- * @param xBufferSizeBytes The total number of bytes the stream buffer will be\r
- * able to hold at any one time.\r
- *\r
- * @param xTriggerLevelBytes The number of bytes that must be in the stream\r
- * buffer before a task that is blocked on the stream buffer to wait for data is\r
- * moved out of the blocked state. For example, if a task is blocked on a read\r
- * of an empty stream buffer that has a trigger level of 1 then the task will be\r
- * unblocked when a single byte is written to the buffer or the task's block\r
- * time expires. As another example, if a task is blocked on a read of an empty\r
- * stream buffer that has a trigger level of 10 then the task will not be\r
- * unblocked until the stream buffer contains at least 10 bytes or the task's\r
- * block time expires. If a reading task's block time expires before the\r
- * trigger level is reached then the task will still receive however many bytes\r
- * are actually available. Setting a trigger level of 0 will result in a\r
- * trigger level of 1 being used. It is not valid to specify a trigger level\r
- * that is greater than the buffer size.\r
- *\r
- * @return If NULL is returned, then the stream buffer cannot be created\r
- * because there is insufficient heap memory available for FreeRTOS to allocate\r
- * the stream buffer data structures and storage area. A non-NULL value being\r
- * returned indicates that the stream buffer has been created successfully -\r
- * the returned value should be stored as the handle to the created stream\r
- * buffer.\r
- *\r
- * Example use:\r
-<pre>\r
-\r
-void vAFunction( void )\r
-{\r
-StreamBufferHandle_t xStreamBuffer;\r
-const size_t xStreamBufferSizeBytes = 100, xTriggerLevel = 10;\r
-\r
- // Create a stream buffer that can hold 100 bytes. The memory used to hold\r
- // both the stream buffer structure and the data in the stream buffer is\r
- // allocated dynamically.\r
- xStreamBuffer = xStreamBufferCreate( xStreamBufferSizeBytes, xTriggerLevel );\r
-\r
- if( xStreamBuffer == NULL )\r
- {\r
- // There was not enough heap memory space available to create the\r
- // stream buffer.\r
- }\r
- else\r
- {\r
- // The stream buffer was created successfully and can now be used.\r
- }\r
-}\r
-</pre>\r
- * \defgroup xStreamBufferCreate xStreamBufferCreate\r
- * \ingroup StreamBufferManagement\r
- */\r
-#define xStreamBufferCreate( xBufferSizeBytes, xTriggerLevelBytes ) xStreamBufferGenericCreate( xBufferSizeBytes, xTriggerLevelBytes, pdFALSE )\r
-\r
-/**\r
- * stream_buffer.h\r
- *\r
-<pre>\r
-StreamBufferHandle_t xStreamBufferCreateStatic( size_t xBufferSizeBytes,\r
- size_t xTriggerLevelBytes,\r
- uint8_t *pucStreamBufferStorageArea,\r
- StaticStreamBuffer_t *pxStaticStreamBuffer );\r
-</pre>\r
- * Creates a new stream buffer using statically allocated memory. See\r
- * xStreamBufferCreate() for a version that uses dynamically allocated memory.\r
- *\r
- * configSUPPORT_STATIC_ALLOCATION must be set to 1 in FreeRTOSConfig.h for\r
- * xStreamBufferCreateStatic() to be available.\r
- *\r
- * @param xBufferSizeBytes The size, in bytes, of the buffer pointed to by the\r
- * pucStreamBufferStorageArea parameter.\r
- *\r
- * @param xTriggerLevelBytes The number of bytes that must be in the stream\r
- * buffer before a task that is blocked on the stream buffer to wait for data is\r
- * moved out of the blocked state. For example, if a task is blocked on a read\r
- * of an empty stream buffer that has a trigger level of 1 then the task will be\r
- * unblocked when a single byte is written to the buffer or the task's block\r
- * time expires. As another example, if a task is blocked on a read of an empty\r
- * stream buffer that has a trigger level of 10 then the task will not be\r
- * unblocked until the stream buffer contains at least 10 bytes or the task's\r
- * block time expires. If a reading task's block time expires before the\r
- * trigger level is reached then the task will still receive however many bytes\r
- * are actually available. Setting a trigger level of 0 will result in a\r
- * trigger level of 1 being used. It is not valid to specify a trigger level\r
- * that is greater than the buffer size.\r
- *\r
- * @param pucStreamBufferStorageArea Must point to a uint8_t array that is at\r
- * least xBufferSizeBytes + 1 big. This is the array to which streams are\r
- * copied when they are written to the stream buffer.\r
- *\r
- * @param pxStaticStreamBuffer Must point to a variable of type\r
- * StaticStreamBuffer_t, which will be used to hold the stream buffer's data\r
- * structure.\r
- *\r
- * @return If the stream buffer is created successfully then a handle to the\r
- * created stream buffer is returned. If either pucStreamBufferStorageArea or\r
- * pxStaticstreamBuffer are NULL then NULL is returned.\r
- *\r
- * Example use:\r
-<pre>\r
-\r
-// Used to dimension the array used to hold the streams. The available space\r
-// will actually be one less than this, so 999.\r
-#define STORAGE_SIZE_BYTES 1000\r
-\r
-// Defines the memory that will actually hold the streams within the stream\r
-// buffer.\r
-static uint8_t ucStorageBuffer[ STORAGE_SIZE_BYTES ];\r
-\r
-// The variable used to hold the stream buffer structure.\r
-StaticStreamBuffer_t xStreamBufferStruct;\r
-\r
-void MyFunction( void )\r
-{\r
-StreamBufferHandle_t xStreamBuffer;\r
-const size_t xTriggerLevel = 1;\r
-\r
- xStreamBuffer = xStreamBufferCreateStatic( sizeof( ucBufferStorage ),\r
- xTriggerLevel,\r
- ucBufferStorage,\r
- &xStreamBufferStruct );\r
-\r
- // As neither the pucStreamBufferStorageArea or pxStaticStreamBuffer\r
- // parameters were NULL, xStreamBuffer will not be NULL, and can be used to\r
- // reference the created stream buffer in other stream buffer API calls.\r
-\r
- // Other code that uses the stream buffer can go here.\r
-}\r
-\r
-</pre>\r
- * \defgroup xStreamBufferCreateStatic xStreamBufferCreateStatic\r
- * \ingroup StreamBufferManagement\r
- */\r
-#define xStreamBufferCreateStatic( xBufferSizeBytes, xTriggerLevelBytes, pucStreamBufferStorageArea, pxStaticStreamBuffer ) xStreamBufferGenericCreateStatic( xBufferSizeBytes, xTriggerLevelBytes, pdFALSE, pucStreamBufferStorageArea, pxStaticStreamBuffer )\r
-\r
-/**\r
- * stream_buffer.h\r
- *\r
-<pre>\r
-size_t xStreamBufferSend( StreamBufferHandle_t xStreamBuffer,\r
- const void *pvTxData,\r
- size_t xDataLengthBytes,\r
- TickType_t xTicksToWait );\r
-<pre>\r
- *\r
- * Sends bytes to a stream buffer. The bytes are copied into the stream buffer.\r
- *\r
- * ***NOTE***: Uniquely among FreeRTOS objects, the stream buffer\r
- * implementation (so also the message buffer implementation, as message buffers\r
- * are built on top of stream buffers) assumes there is only one task or\r
- * interrupt that will write to the buffer (the writer), and only one task or\r
- * interrupt that will read from the buffer (the reader). It is safe for the\r
- * writer and reader to be different tasks or interrupts, but, unlike other\r
- * FreeRTOS objects, it is not safe to have multiple different writers or\r
- * multiple different readers. If there are to be multiple different writers\r
- * then the application writer must place each call to a writing API function\r
- * (such as xStreamBufferSend()) inside a critical section and set the send\r
- * block time to 0. Likewise, if there are to be multiple different readers\r
- * then the application writer must place each call to a reading API function\r
- * (such as xStreamBufferRead()) inside a critical section and set the receive\r
- * block time to 0.\r
- *\r
- * Use xStreamBufferSend() to write to a stream buffer from a task. Use\r
- * xStreamBufferSendFromISR() to write to a stream buffer from an interrupt\r
- * service routine (ISR).\r
- *\r
- * @param xStreamBuffer The handle of the stream buffer to which a stream is\r
- * being sent.\r
- *\r
- * @param pvTxData A pointer to the buffer that holds the bytes to be copied\r
- * into the stream buffer.\r
- *\r
- * @param xDataLengthBytes The maximum number of bytes to copy from pvTxData\r
- * into the stream buffer.\r
- *\r
- * @param xTicksToWait The maximum amount of time the task should remain in the\r
- * Blocked state to wait for enough space to become available in the stream\r
- * buffer, should the stream buffer contain too little space to hold the\r
- * another xDataLengthBytes bytes. The block time is specified in tick periods,\r
- * so the absolute time it represents is dependent on the tick frequency. The\r
- * macro pdMS_TO_TICKS() can be used to convert a time specified in milliseconds\r
- * into a time specified in ticks. Setting xTicksToWait to portMAX_DELAY will\r
- * cause the task to wait indefinitely (without timing out), provided\r
- * INCLUDE_vTaskSuspend is set to 1 in FreeRTOSConfig.h. If a task times out\r
- * before it can write all xDataLengthBytes into the buffer it will still write\r
- * as many bytes as possible. A task does not use any CPU time when it is in\r
- * the blocked state.\r
- *\r
- * @return The number of bytes written to the stream buffer. If a task times\r
- * out before it can write all xDataLengthBytes into the buffer it will still\r
- * write as many bytes as possible.\r
- *\r
- * Example use:\r
-<pre>\r
-void vAFunction( StreamBufferHandle_t xStreamBuffer )\r
-{\r
-size_t xBytesSent;\r
-uint8_t ucArrayToSend[] = { 0, 1, 2, 3 };\r
-char *pcStringToSend = "String to send";\r
-const TickType_t x100ms = pdMS_TO_TICKS( 100 );\r
-\r
- // Send an array to the stream buffer, blocking for a maximum of 100ms to\r
- // wait for enough space to be available in the stream buffer.\r
- xBytesSent = xStreamBufferSend( xStreamBuffer, ( void * ) ucArrayToSend, sizeof( ucArrayToSend ), x100ms );\r
-\r
- if( xBytesSent != sizeof( ucArrayToSend ) )\r
- {\r
- // The call to xStreamBufferSend() times out before there was enough\r
- // space in the buffer for the data to be written, but it did\r
- // successfully write xBytesSent bytes.\r
- }\r
-\r
- // Send the string to the stream buffer. Return immediately if there is not\r
- // enough space in the buffer.\r
- xBytesSent = xStreamBufferSend( xStreamBuffer, ( void * ) pcStringToSend, strlen( pcStringToSend ), 0 );\r
-\r
- if( xBytesSent != strlen( pcStringToSend ) )\r
- {\r
- // The entire string could not be added to the stream buffer because\r
- // there was not enough free space in the buffer, but xBytesSent bytes\r
- // were sent. Could try again to send the remaining bytes.\r
- }\r
-}\r
-</pre>\r
- * \defgroup xStreamBufferSend xStreamBufferSend\r
- * \ingroup StreamBufferManagement\r
- */\r
-size_t xStreamBufferSend( StreamBufferHandle_t xStreamBuffer,\r
- const void *pvTxData,\r
- size_t xDataLengthBytes,\r
- TickType_t xTicksToWait ) PRIVILEGED_FUNCTION;\r
-\r
-/**\r
- * stream_buffer.h\r
- *\r
-<pre>\r
-size_t xStreamBufferSendFromISR( StreamBufferHandle_t xStreamBuffer,\r
- const void *pvTxData,\r
- size_t xDataLengthBytes,\r
- BaseType_t *pxHigherPriorityTaskWoken );\r
-<pre>\r
- *\r
- * Interrupt safe version of the API function that sends a stream of bytes to\r
- * the stream buffer.\r
- *\r
- * ***NOTE***: Uniquely among FreeRTOS objects, the stream buffer\r
- * implementation (so also the message buffer implementation, as message buffers\r
- * are built on top of stream buffers) assumes there is only one task or\r
- * interrupt that will write to the buffer (the writer), and only one task or\r
- * interrupt that will read from the buffer (the reader). It is safe for the\r
- * writer and reader to be different tasks or interrupts, but, unlike other\r
- * FreeRTOS objects, it is not safe to have multiple different writers or\r
- * multiple different readers. If there are to be multiple different writers\r
- * then the application writer must place each call to a writing API function\r
- * (such as xStreamBufferSend()) inside a critical section and set the send\r
- * block time to 0. Likewise, if there are to be multiple different readers\r
- * then the application writer must place each call to a reading API function\r
- * (such as xStreamBufferRead()) inside a critical section and set the receive\r
- * block time to 0.\r
- *\r
- * Use xStreamBufferSend() to write to a stream buffer from a task. Use\r
- * xStreamBufferSendFromISR() to write to a stream buffer from an interrupt\r
- * service routine (ISR).\r
- *\r
- * @param xStreamBuffer The handle of the stream buffer to which a stream is\r
- * being sent.\r
- *\r
- * @param pvTxData A pointer to the data that is to be copied into the stream\r
- * buffer.\r
- *\r
- * @param xDataLengthBytes The maximum number of bytes to copy from pvTxData\r
- * into the stream buffer.\r
- *\r
- * @param pxHigherPriorityTaskWoken It is possible that a stream buffer will\r
- * have a task blocked on it waiting for data. Calling\r
- * xStreamBufferSendFromISR() can make data available, and so cause a task that\r
- * was waiting for data to leave the Blocked state. If calling\r
- * xStreamBufferSendFromISR() causes a task to leave the Blocked state, and the\r
- * unblocked task has a priority higher than the currently executing task (the\r
- * task that was interrupted), then, internally, xStreamBufferSendFromISR()\r
- * will set *pxHigherPriorityTaskWoken to pdTRUE. If\r
- * xStreamBufferSendFromISR() sets this value to pdTRUE, then normally a\r
- * context switch should be performed before the interrupt is exited. This will\r
- * ensure that the interrupt returns directly to the highest priority Ready\r
- * state task. *pxHigherPriorityTaskWoken should be set to pdFALSE before it\r
- * is passed into the function. See the example code below for an example.\r
- *\r
- * @return The number of bytes actually written to the stream buffer, which will\r
- * be less than xDataLengthBytes if the stream buffer didn't have enough free\r
- * space for all the bytes to be written.\r
- *\r
- * Example use:\r
-<pre>\r
-// A stream buffer that has already been created.\r
-StreamBufferHandle_t xStreamBuffer;\r
-\r
-void vAnInterruptServiceRoutine( void )\r
-{\r
-size_t xBytesSent;\r
-char *pcStringToSend = "String to send";\r
-BaseType_t xHigherPriorityTaskWoken = pdFALSE; // Initialised to pdFALSE.\r
-\r
- // Attempt to send the string to the stream buffer.\r
- xBytesSent = xStreamBufferSendFromISR( xStreamBuffer,\r
- ( void * ) pcStringToSend,\r
- strlen( pcStringToSend ),\r
- &xHigherPriorityTaskWoken );\r
-\r
- if( xBytesSent != strlen( pcStringToSend ) )\r
- {\r
- // There was not enough free space in the stream buffer for the entire\r
- // string to be written, ut xBytesSent bytes were written.\r
- }\r
-\r
- // If xHigherPriorityTaskWoken was set to pdTRUE inside\r
- // xStreamBufferSendFromISR() then a task that has a priority above the\r
- // priority of the currently executing task was unblocked and a context\r
- // switch should be performed to ensure the ISR returns to the unblocked\r
- // task. In most FreeRTOS ports this is done by simply passing\r
- // xHigherPriorityTaskWoken into taskYIELD_FROM_ISR(), which will test the\r
- // variables value, and perform the context switch if necessary. Check the\r
- // documentation for the port in use for port specific instructions.\r
- taskYIELD_FROM_ISR( xHigherPriorityTaskWoken );\r
-}\r
-</pre>\r
- * \defgroup xStreamBufferSendFromISR xStreamBufferSendFromISR\r
- * \ingroup StreamBufferManagement\r
- */\r
-size_t xStreamBufferSendFromISR( StreamBufferHandle_t xStreamBuffer,\r
- const void *pvTxData,\r
- size_t xDataLengthBytes,\r
- BaseType_t * const pxHigherPriorityTaskWoken ) PRIVILEGED_FUNCTION;\r
-\r
-/**\r
- * stream_buffer.h\r
- *\r
-<pre>\r
-size_t xStreamBufferReceive( StreamBufferHandle_t xStreamBuffer,\r
- void *pvRxData,\r
- size_t xBufferLengthBytes,\r
- TickType_t xTicksToWait );\r
-</pre>\r
- *\r
- * Receives bytes from a stream buffer.\r
- *\r
- * ***NOTE***: Uniquely among FreeRTOS objects, the stream buffer\r
- * implementation (so also the message buffer implementation, as message buffers\r
- * are built on top of stream buffers) assumes there is only one task or\r
- * interrupt that will write to the buffer (the writer), and only one task or\r
- * interrupt that will read from the buffer (the reader). It is safe for the\r
- * writer and reader to be different tasks or interrupts, but, unlike other\r
- * FreeRTOS objects, it is not safe to have multiple different writers or\r
- * multiple different readers. If there are to be multiple different writers\r
- * then the application writer must place each call to a writing API function\r
- * (such as xStreamBufferSend()) inside a critical section and set the send\r
- * block time to 0. Likewise, if there are to be multiple different readers\r
- * then the application writer must place each call to a reading API function\r
- * (such as xStreamBufferRead()) inside a critical section and set the receive\r
- * block time to 0.\r
- *\r
- * Use xStreamBufferReceive() to read from a stream buffer from a task. Use\r
- * xStreamBufferReceiveFromISR() to read from a stream buffer from an\r
- * interrupt service routine (ISR).\r
- *\r
- * @param xStreamBuffer The handle of the stream buffer from which bytes are to\r
- * be received.\r
- *\r
- * @param pvRxData A pointer to the buffer into which the received bytes will be\r
- * copied.\r
- *\r
- * @param xBufferLengthBytes The length of the buffer pointed to by the\r
- * pvRxData parameter. This sets the maximum number of bytes to receive in one\r
- * call. xStreamBufferReceive will return as many bytes as possible up to a\r
- * maximum set by xBufferLengthBytes.\r
- *\r
- * @param xTicksToWait The maximum amount of time the task should remain in the\r
- * Blocked state to wait for data to become available if the stream buffer is\r
- * empty. xStreamBufferReceive() will return immediately if xTicksToWait is\r
- * zero. The block time is specified in tick periods, so the absolute time it\r
- * represents is dependent on the tick frequency. The macro pdMS_TO_TICKS() can\r
- * be used to convert a time specified in milliseconds into a time specified in\r
- * ticks. Setting xTicksToWait to portMAX_DELAY will cause the task to wait\r
- * indefinitely (without timing out), provided INCLUDE_vTaskSuspend is set to 1\r
- * in FreeRTOSConfig.h. A task does not use any CPU time when it is in the\r
- * Blocked state.\r
- *\r
- * @return The number of bytes actually read from the stream buffer, which will\r
- * be less than xBufferLengthBytes if the call to xStreamBufferReceive() timed\r
- * out before xBufferLengthBytes were available.\r
- *\r
- * Example use:\r
-<pre>\r
-void vAFunction( StreamBuffer_t xStreamBuffer )\r
-{\r
-uint8_t ucRxData[ 20 ];\r
-size_t xReceivedBytes;\r
-const TickType_t xBlockTime = pdMS_TO_TICKS( 20 );\r
-\r
- // Receive up to another sizeof( ucRxData ) bytes from the stream buffer.\r
- // Wait in the Blocked state (so not using any CPU processing time) for a\r
- // maximum of 100ms for the full sizeof( ucRxData ) number of bytes to be\r
- // available.\r
- xReceivedBytes = xStreamBufferReceive( xStreamBuffer,\r
- ( void * ) ucRxData,\r
- sizeof( ucRxData ),\r
- xBlockTime );\r
-\r
- if( xReceivedBytes > 0 )\r
- {\r
- // A ucRxData contains another xRecievedBytes bytes of data, which can\r
- // be processed here....\r
- }\r
-}\r
-</pre>\r
- * \defgroup xStreamBufferReceive xStreamBufferReceive\r
- * \ingroup StreamBufferManagement\r
- */\r
-size_t xStreamBufferReceive( StreamBufferHandle_t xStreamBuffer,\r
- void *pvRxData,\r
- size_t xBufferLengthBytes,\r
- TickType_t xTicksToWait ) PRIVILEGED_FUNCTION;\r
-\r
-/**\r
- * stream_buffer.h\r
- *\r
-<pre>\r
-size_t xStreamBufferReceiveFromISR( StreamBufferHandle_t xStreamBuffer,\r
- void *pvRxData,\r
- size_t xBufferLengthBytes,\r
- BaseType_t *pxHigherPriorityTaskWoken );\r
-</pre>\r
- *\r
- * An interrupt safe version of the API function that receives bytes from a\r
- * stream buffer.\r
- *\r
- * Use xStreamBufferReceive() to read bytes from a stream buffer from a task.\r
- * Use xStreamBufferReceiveFromISR() to read bytes from a stream buffer from an\r
- * interrupt service routine (ISR).\r
- *\r
- * @param xStreamBuffer The handle of the stream buffer from which a stream\r
- * is being received.\r
- *\r
- * @param pvRxData A pointer to the buffer into which the received bytes are\r
- * copied.\r
- *\r
- * @param xBufferLengthBytes The length of the buffer pointed to by the\r
- * pvRxData parameter. This sets the maximum number of bytes to receive in one\r
- * call. xStreamBufferReceive will return as many bytes as possible up to a\r
- * maximum set by xBufferLengthBytes.\r
- *\r
- * @param pxHigherPriorityTaskWoken It is possible that a stream buffer will\r
- * have a task blocked on it waiting for space to become available. Calling\r
- * xStreamBufferReceiveFromISR() can make space available, and so cause a task\r
- * that is waiting for space to leave the Blocked state. If calling\r
- * xStreamBufferReceiveFromISR() causes a task to leave the Blocked state, and\r
- * the unblocked task has a priority higher than the currently executing task\r
- * (the task that was interrupted), then, internally,\r
- * xStreamBufferReceiveFromISR() will set *pxHigherPriorityTaskWoken to pdTRUE.\r
- * If xStreamBufferReceiveFromISR() sets this value to pdTRUE, then normally a\r
- * context switch should be performed before the interrupt is exited. That will\r
- * ensure the interrupt returns directly to the highest priority Ready state\r
- * task. *pxHigherPriorityTaskWoken should be set to pdFALSE before it is\r
- * passed into the function. See the code example below for an example.\r
- *\r
- * @return The number of bytes read from the stream buffer, if any.\r
- *\r
- * Example use:\r
-<pre>\r
-// A stream buffer that has already been created.\r
-StreamBuffer_t xStreamBuffer;\r
-\r
-void vAnInterruptServiceRoutine( void )\r
-{\r
-uint8_t ucRxData[ 20 ];\r
-size_t xReceivedBytes;\r
-BaseType_t xHigherPriorityTaskWoken = pdFALSE; // Initialised to pdFALSE.\r
-\r
- // Receive the next stream from the stream buffer.\r
- xReceivedBytes = xStreamBufferReceiveFromISR( xStreamBuffer,\r
- ( void * ) ucRxData,\r
- sizeof( ucRxData ),\r
- &xHigherPriorityTaskWoken );\r
-\r
- if( xReceivedBytes > 0 )\r
- {\r
- // ucRxData contains xReceivedBytes read from the stream buffer.\r
- // Process the stream here....\r
- }\r
-\r
- // If xHigherPriorityTaskWoken was set to pdTRUE inside\r
- // xStreamBufferReceiveFromISR() then a task that has a priority above the\r
- // priority of the currently executing task was unblocked and a context\r
- // switch should be performed to ensure the ISR returns to the unblocked\r
- // task. In most FreeRTOS ports this is done by simply passing\r
- // xHigherPriorityTaskWoken into taskYIELD_FROM_ISR(), which will test the\r
- // variables value, and perform the context switch if necessary. Check the\r
- // documentation for the port in use for port specific instructions.\r
- taskYIELD_FROM_ISR( xHigherPriorityTaskWoken );\r
-}\r
-</pre>\r
- * \defgroup xStreamBufferReceiveFromISR xStreamBufferReceiveFromISR\r
- * \ingroup StreamBufferManagement\r
- */\r
-size_t xStreamBufferReceiveFromISR( StreamBufferHandle_t xStreamBuffer,\r
- void *pvRxData,\r
- size_t xBufferLengthBytes,\r
- BaseType_t * const pxHigherPriorityTaskWoken ) PRIVILEGED_FUNCTION;\r
-\r
-/**\r
- * stream_buffer.h\r
- *\r
-<pre>\r
-void vStreamBufferDelete( StreamBufferHandle_t xStreamBuffer );\r
-</pre>\r
- *\r
- * Deletes a stream buffer that was previously created using a call to\r
- * xStreamBufferCreate() or xStreamBufferCreateStatic(). If the stream\r
- * buffer was created using dynamic memory (that is, by xStreamBufferCreate()),\r
- * then the allocated memory is freed.\r
- *\r
- * A stream buffer handle must not be used after the stream buffer has been\r
- * deleted.\r
- *\r
- * @param xStreamBuffer The handle of the stream buffer to be deleted.\r
- *\r
- * \defgroup vStreamBufferDelete vStreamBufferDelete\r
- * \ingroup StreamBufferManagement\r
- */\r
-void vStreamBufferDelete( StreamBufferHandle_t xStreamBuffer ) PRIVILEGED_FUNCTION;\r
-\r
-/**\r
- * stream_buffer.h\r
- *\r
-<pre>\r
-BaseType_t xStreamBufferIsFull( StreamBufferHandle_t xStreamBuffer );\r
-</pre>\r
- *\r
- * Queries a stream buffer to see if it is full. A stream buffer is full if it\r
- * does not have any free space, and therefore cannot accept any more data.\r
- *\r
- * @param xStreamBuffer The handle of the stream buffer being queried.\r
- *\r
- * @return If the stream buffer is full then pdTRUE is returned. Otherwise\r
- * pdFALSE is returned.\r
- *\r
- * \defgroup xStreamBufferIsFull xStreamBufferIsFull\r
- * \ingroup StreamBufferManagement\r
- */\r
-BaseType_t xStreamBufferIsFull( StreamBufferHandle_t xStreamBuffer ) PRIVILEGED_FUNCTION;\r
-\r
-/**\r
- * stream_buffer.h\r
- *\r
-<pre>\r
-BaseType_t xStreamBufferIsEmpty( StreamBufferHandle_t xStreamBuffer );\r
-</pre>\r
- *\r
- * Queries a stream buffer to see if it is empty. A stream buffer is empty if\r
- * it does not contain any data.\r
- *\r
- * @param xStreamBuffer The handle of the stream buffer being queried.\r
- *\r
- * @return If the stream buffer is empty then pdTRUE is returned. Otherwise\r
- * pdFALSE is returned.\r
- *\r
- * \defgroup xStreamBufferIsEmpty xStreamBufferIsEmpty\r
- * \ingroup StreamBufferManagement\r
- */\r
-BaseType_t xStreamBufferIsEmpty( StreamBufferHandle_t xStreamBuffer ) PRIVILEGED_FUNCTION;\r
-\r
-/**\r
- * stream_buffer.h\r
- *\r
-<pre>\r
-BaseType_t xStreamBufferReset( StreamBufferHandle_t xStreamBuffer );\r
-</pre>\r
- *\r
- * Resets a stream buffer to its initial, empty, state. Any data that was in\r
- * the stream buffer is discarded. A stream buffer can only be reset if there\r
- * are no tasks blocked waiting to either send to or receive from the stream\r
- * buffer.\r
- *\r
- * @param xStreamBuffer The handle of the stream buffer being reset.\r
- *\r
- * @return If the stream buffer is reset then pdPASS is returned. If there was\r
- * a task blocked waiting to send to or read from the stream buffer then the\r
- * stream buffer is not reset and pdFAIL is returned.\r
- *\r
- * \defgroup xStreamBufferReset xStreamBufferReset\r
- * \ingroup StreamBufferManagement\r
- */\r
-BaseType_t xStreamBufferReset( StreamBufferHandle_t xStreamBuffer ) PRIVILEGED_FUNCTION;\r
-\r
-/**\r
- * stream_buffer.h\r
- *\r
-<pre>\r
-size_t xStreamBufferSpacesAvailable( StreamBufferHandle_t xStreamBuffer );\r
-</pre>\r
- *\r
- * Queries a stream buffer to see how much free space it contains, which is\r
- * equal to the amount of data that can be sent to the stream buffer before it\r
- * is full.\r
- *\r
- * @param xStreamBuffer The handle of the stream buffer being queried.\r
- *\r
- * @return The number of bytes that can be written to the stream buffer before\r
- * the stream buffer would be full.\r
- *\r
- * \defgroup xStreamBufferSpacesAvailable xStreamBufferSpacesAvailable\r
- * \ingroup StreamBufferManagement\r
- */\r
-size_t xStreamBufferSpacesAvailable( StreamBufferHandle_t xStreamBuffer ) PRIVILEGED_FUNCTION;\r
-\r
-/**\r
- * stream_buffer.h\r
- *\r
-<pre>\r
-size_t xStreamBufferBytesAvailable( StreamBufferHandle_t xStreamBuffer );\r
-</pre>\r
- *\r
- * Queries a stream buffer to see how much data it contains, which is equal to\r
- * the number of bytes that can be read from the stream buffer before the stream\r
- * buffer would be empty.\r
- *\r
- * @param xStreamBuffer The handle of the stream buffer being queried.\r
- *\r
- * @return The number of bytes that can be read from the stream buffer before\r
- * the stream buffer would be empty.\r
- *\r
- * \defgroup xStreamBufferBytesAvailable xStreamBufferBytesAvailable\r
- * \ingroup StreamBufferManagement\r
- */\r
-size_t xStreamBufferBytesAvailable( StreamBufferHandle_t xStreamBuffer ) PRIVILEGED_FUNCTION;\r
-\r
-/**\r
- * stream_buffer.h\r
- *\r
-<pre>\r
-BaseType_t xStreamBufferSetTriggerLevel( StreamBufferHandle_t xStreamBuffer, size_t xTriggerLevel );\r
-</pre>\r
- *\r
- * A stream buffer's trigger level is the number of bytes that must be in the\r
- * stream buffer before a task that is blocked on the stream buffer to\r
- * wait for data is moved out of the blocked state. For example, if a task is\r
- * blocked on a read of an empty stream buffer that has a trigger level of 1\r
- * then the task will be unblocked when a single byte is written to the buffer\r
- * or the task's block time expires. As another example, if a task is blocked\r
- * on a read of an empty stream buffer that has a trigger level of 10 then the\r
- * task will not be unblocked until the stream buffer contains at least 10 bytes\r
- * or the task's block time expires. If a reading task's block time expires\r
- * before the trigger level is reached then the task will still receive however\r
- * many bytes are actually available. Setting a trigger level of 0 will result\r
- * in a trigger level of 1 being used. It is not valid to specify a trigger\r
- * level that is greater than the buffer size.\r
- *\r
- * A trigger level is set when the stream buffer is created, and can be modified\r
- * using xStreamBufferSetTriggerLevel().\r
- *\r
- * @param xStreamBuffer The handle of the stream buffer being updated.\r
- *\r
- * @param xTriggerLevel The new trigger level for the stream buffer.\r
- *\r
- * @return If xTriggerLevel was less than or equal to the stream buffer's length\r
- * then the trigger level will be updated and pdTRUE is returned. Otherwise\r
- * pdFALSE is returned.\r
- *\r
- * \defgroup xStreamBufferSetTriggerLevel xStreamBufferSetTriggerLevel\r
- * \ingroup StreamBufferManagement\r
- */\r
-BaseType_t xStreamBufferSetTriggerLevel( StreamBufferHandle_t xStreamBuffer, size_t xTriggerLevel ) PRIVILEGED_FUNCTION;\r
-\r
-/**\r
- * stream_buffer.h\r
- *\r
-<pre>\r
-BaseType_t xStreamBufferSendCompletedFromISR( StreamBufferHandle_t xStreamBuffer, BaseType_t *pxHigherPriorityTaskWoken );\r
-</pre>\r
- *\r
- * For advanced users only.\r
- *\r
- * The sbSEND_COMPLETED() macro is called from within the FreeRTOS APIs when\r
- * data is sent to a message buffer or stream buffer. If there was a task that\r
- * was blocked on the message or stream buffer waiting for data to arrive then\r
- * the sbSEND_COMPLETED() macro sends a notification to the task to remove it\r
- * from the Blocked state. xStreamBufferSendCompletedFromISR() does the same\r
- * thing. It is provided to enable application writers to implement their own\r
- * version of sbSEND_COMPLETED(), and MUST NOT BE USED AT ANY OTHER TIME.\r
- *\r
- * See the example implemented in FreeRTOS/Demo/Minimal/MessageBufferAMP.c for\r
- * additional information.\r
- *\r
- * @param xStreamBuffer The handle of the stream buffer to which data was\r
- * written.\r
- *\r
- * @param pxHigherPriorityTaskWoken *pxHigherPriorityTaskWoken should be\r
- * initialised to pdFALSE before it is passed into\r
- * xStreamBufferSendCompletedFromISR(). If calling\r
- * xStreamBufferSendCompletedFromISR() removes a task from the Blocked state,\r
- * and the task has a priority above the priority of the currently running task,\r
- * then *pxHigherPriorityTaskWoken will get set to pdTRUE indicating that a\r
- * context switch should be performed before exiting the ISR.\r
- *\r
- * @return If a task was removed from the Blocked state then pdTRUE is returned.\r
- * Otherwise pdFALSE is returned.\r
- *\r
- * \defgroup xStreamBufferSendCompletedFromISR xStreamBufferSendCompletedFromISR\r
- * \ingroup StreamBufferManagement\r
- */\r
-BaseType_t xStreamBufferSendCompletedFromISR( StreamBufferHandle_t xStreamBuffer, BaseType_t *pxHigherPriorityTaskWoken ) PRIVILEGED_FUNCTION;\r
-\r
-/**\r
- * stream_buffer.h\r
- *\r
-<pre>\r
-BaseType_t xStreamBufferReceiveCompletedFromISR( StreamBufferHandle_t xStreamBuffer, BaseType_t *pxHigherPriorityTaskWoken );\r
-</pre>\r
- *\r
- * For advanced users only.\r
- *\r
- * The sbRECEIVE_COMPLETED() macro is called from within the FreeRTOS APIs when\r
- * data is read out of a message buffer or stream buffer. If there was a task\r
- * that was blocked on the message or stream buffer waiting for data to arrive\r
- * then the sbRECEIVE_COMPLETED() macro sends a notification to the task to\r
- * remove it from the Blocked state. xStreamBufferReceiveCompletedFromISR()\r
- * does the same thing. It is provided to enable application writers to\r
- * implement their own version of sbRECEIVE_COMPLETED(), and MUST NOT BE USED AT\r
- * ANY OTHER TIME.\r
- *\r
- * See the example implemented in FreeRTOS/Demo/Minimal/MessageBufferAMP.c for\r
- * additional information.\r
- *\r
- * @param xStreamBuffer The handle of the stream buffer from which data was\r
- * read.\r
- *\r
- * @param pxHigherPriorityTaskWoken *pxHigherPriorityTaskWoken should be\r
- * initialised to pdFALSE before it is passed into\r
- * xStreamBufferReceiveCompletedFromISR(). If calling\r
- * xStreamBufferReceiveCompletedFromISR() removes a task from the Blocked state,\r
- * and the task has a priority above the priority of the currently running task,\r
- * then *pxHigherPriorityTaskWoken will get set to pdTRUE indicating that a\r
- * context switch should be performed before exiting the ISR.\r
- *\r
- * @return If a task was removed from the Blocked state then pdTRUE is returned.\r
- * Otherwise pdFALSE is returned.\r
- *\r
- * \defgroup xStreamBufferReceiveCompletedFromISR xStreamBufferReceiveCompletedFromISR\r
- * \ingroup StreamBufferManagement\r
- */\r
-BaseType_t xStreamBufferReceiveCompletedFromISR( StreamBufferHandle_t xStreamBuffer, BaseType_t *pxHigherPriorityTaskWoken ) PRIVILEGED_FUNCTION;\r
-\r
-/* Functions below here are not part of the public API. */\r
-StreamBufferHandle_t xStreamBufferGenericCreate( size_t xBufferSizeBytes,\r
- size_t xTriggerLevelBytes,\r
- BaseType_t xIsMessageBuffer ) PRIVILEGED_FUNCTION;\r
-\r
-StreamBufferHandle_t xStreamBufferGenericCreateStatic( size_t xBufferSizeBytes,\r
- size_t xTriggerLevelBytes,\r
- BaseType_t xIsMessageBuffer,\r
- uint8_t * const pucStreamBufferStorageArea,\r
- StaticStreamBuffer_t * const pxStaticStreamBuffer ) PRIVILEGED_FUNCTION;\r
-\r
-#if( configUSE_TRACE_FACILITY == 1 )\r
- void vStreamBufferSetStreamBufferNumber( StreamBufferHandle_t xStreamBuffer, UBaseType_t uxStreamBufferNumber ) PRIVILEGED_FUNCTION;\r
- UBaseType_t uxStreamBufferGetStreamBufferNumber( StreamBufferHandle_t xStreamBuffer ) PRIVILEGED_FUNCTION;\r
- uint8_t ucStreamBufferGetStreamBufferType( StreamBufferHandle_t xStreamBuffer ) PRIVILEGED_FUNCTION;\r
-#endif\r
-\r
-#if defined( __cplusplus )\r
-}\r
-#endif\r
-\r
-#endif /* !defined( STREAM_BUFFER_H ) */\r
+++ /dev/null
-/*\r
- * FreeRTOS Kernel V10.0.1\r
- * Copyright (C) 2017 Amazon.com, Inc. or its affiliates. All Rights Reserved.\r
- *\r
- * Permission is hereby granted, free of charge, to any person obtaining a copy of\r
- * this software and associated documentation files (the "Software"), to deal in\r
- * the Software without restriction, including without limitation the rights to\r
- * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of\r
- * the Software, and to permit persons to whom the Software is furnished to do so,\r
- * subject to the following conditions:\r
- *\r
- * The above copyright notice and this permission notice shall be included in all\r
- * copies or substantial portions of the Software.\r
- *\r
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\r
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS\r
- * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR\r
- * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER\r
- * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN\r
- * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\r
- *\r
- * http://www.FreeRTOS.org\r
- * http://aws.amazon.com/freertos\r
- *\r
- * 1 tab == 4 spaces!\r
- */\r
-\r
-\r
-#ifndef INC_TASK_H\r
-#define INC_TASK_H\r
-\r
-#ifndef INC_FREERTOS_H\r
- #error "include FreeRTOS.h must appear in source files before include task.h"\r
-#endif\r
-\r
-#include "list.h"\r
-\r
-#ifdef __cplusplus\r
-extern "C" {\r
-#endif\r
-\r
-/*-----------------------------------------------------------\r
- * MACROS AND DEFINITIONS\r
- *----------------------------------------------------------*/\r
-\r
-#define tskKERNEL_VERSION_NUMBER "V10.0.1"\r
-#define tskKERNEL_VERSION_MAJOR 10\r
-#define tskKERNEL_VERSION_MINOR 0\r
-#define tskKERNEL_VERSION_BUILD 1\r
-\r
-/**\r
- * task. h\r
- *\r
- * Type by which tasks are referenced. For example, a call to xTaskCreate\r
- * returns (via a pointer parameter) an TaskHandle_t variable that can then\r
- * be used as a parameter to vTaskDelete to delete the task.\r
- *\r
- * \defgroup TaskHandle_t TaskHandle_t\r
- * \ingroup Tasks\r
- */\r
-typedef void * TaskHandle_t;\r
-\r
-/*\r
- * Defines the prototype to which the application task hook function must\r
- * conform.\r
- */\r
-typedef BaseType_t (*TaskHookFunction_t)( void * );\r
-\r
-/* Task states returned by eTaskGetState. */\r
-typedef enum\r
-{\r
- eRunning = 0, /* A task is querying the state of itself, so must be running. */\r
- eReady, /* The task being queried is in a read or pending ready list. */\r
- eBlocked, /* The task being queried is in the Blocked state. */\r
- eSuspended, /* The task being queried is in the Suspended state, or is in the Blocked state with an infinite time out. */\r
- eDeleted, /* The task being queried has been deleted, but its TCB has not yet been freed. */\r
- eInvalid /* Used as an 'invalid state' value. */\r
-} eTaskState;\r
-\r
-/* Actions that can be performed when vTaskNotify() is called. */\r
-typedef enum\r
-{\r
- eNoAction = 0, /* Notify the task without updating its notify value. */\r
- eSetBits, /* Set bits in the task's notification value. */\r
- eIncrement, /* Increment the task's notification value. */\r
- eSetValueWithOverwrite, /* Set the task's notification value to a specific value even if the previous value has not yet been read by the task. */\r
- eSetValueWithoutOverwrite /* Set the task's notification value if the previous value has been read by the task. */\r
-} eNotifyAction;\r
-\r
-/*\r
- * Used internally only.\r
- */\r
-typedef struct xTIME_OUT\r
-{\r
- BaseType_t xOverflowCount;\r
- TickType_t xTimeOnEntering;\r
-} TimeOut_t;\r
-\r
-/*\r
- * Defines the memory ranges allocated to the task when an MPU is used.\r
- */\r
-typedef struct xMEMORY_REGION\r
-{\r
- void *pvBaseAddress;\r
- uint32_t ulLengthInBytes;\r
- uint32_t ulParameters;\r
-} MemoryRegion_t;\r
-\r
-/*\r
- * Parameters required to create an MPU protected task.\r
- */\r
-typedef struct xTASK_PARAMETERS\r
-{\r
- TaskFunction_t pvTaskCode;\r
- const char * const pcName; /*lint !e971 Unqualified char types are allowed for strings and single characters only. */\r
- uint16_t usStackDepth;\r
- void *pvParameters;\r
- UBaseType_t uxPriority;\r
- StackType_t *puxStackBuffer;\r
- MemoryRegion_t xRegions[ portNUM_CONFIGURABLE_REGIONS ];\r
- #if ( ( portUSING_MPU_WRAPPERS == 1 ) && ( configSUPPORT_STATIC_ALLOCATION == 1 ) )\r
- StaticTask_t * const pxTaskBuffer;\r
- #endif\r
-} TaskParameters_t;\r
-\r
-/* Used with the uxTaskGetSystemState() function to return the state of each task\r
-in the system. */\r
-typedef struct xTASK_STATUS\r
-{\r
- TaskHandle_t xHandle; /* The handle of the task to which the rest of the information in the structure relates. */\r
- const char *pcTaskName; /* A pointer to the task's name. This value will be invalid if the task was deleted since the structure was populated! */ /*lint !e971 Unqualified char types are allowed for strings and single characters only. */\r
- UBaseType_t xTaskNumber; /* A number unique to the task. */\r
- eTaskState eCurrentState; /* The state in which the task existed when the structure was populated. */\r
- UBaseType_t uxCurrentPriority; /* The priority at which the task was running (may be inherited) when the structure was populated. */\r
- UBaseType_t uxBasePriority; /* The priority to which the task will return if the task's current priority has been inherited to avoid unbounded priority inversion when obtaining a mutex. Only valid if configUSE_MUTEXES is defined as 1 in FreeRTOSConfig.h. */\r
- uint32_t ulRunTimeCounter; /* The total run time allocated to the task so far, as defined by the run time stats clock. See http://www.freertos.org/rtos-run-time-stats.html. Only valid when configGENERATE_RUN_TIME_STATS is defined as 1 in FreeRTOSConfig.h. */\r
- StackType_t *pxStackBase; /* Points to the lowest address of the task's stack area. */\r
- uint16_t usStackHighWaterMark; /* The minimum amount of stack space that has remained for the task since the task was created. The closer this value is to zero the closer the task has come to overflowing its stack. */\r
-} TaskStatus_t;\r
-\r
-/* Possible return values for eTaskConfirmSleepModeStatus(). */\r
-typedef enum\r
-{\r
- eAbortSleep = 0, /* A task has been made ready or a context switch pended since portSUPPORESS_TICKS_AND_SLEEP() was called - abort entering a sleep mode. */\r
- eStandardSleep, /* Enter a sleep mode that will not last any longer than the expected idle time. */\r
- eNoTasksWaitingTimeout /* No tasks are waiting for a timeout so it is safe to enter a sleep mode that can only be exited by an external interrupt. */\r
-} eSleepModeStatus;\r
-\r
-/**\r
- * Defines the priority used by the idle task. This must not be modified.\r
- *\r
- * \ingroup TaskUtils\r
- */\r
-#define tskIDLE_PRIORITY ( ( UBaseType_t ) 0U )\r
-\r
-/**\r
- * task. h\r
- *\r
- * Macro for forcing a context switch.\r
- *\r
- * \defgroup taskYIELD taskYIELD\r
- * \ingroup SchedulerControl\r
- */\r
-#define taskYIELD() portYIELD()\r
-\r
-/**\r
- * task. h\r
- *\r
- * Macro to mark the start of a critical code region. Preemptive context\r
- * switches cannot occur when in a critical region.\r
- *\r
- * NOTE: This may alter the stack (depending on the portable implementation)\r
- * so must be used with care!\r
- *\r
- * \defgroup taskENTER_CRITICAL taskENTER_CRITICAL\r
- * \ingroup SchedulerControl\r
- */\r
-#define taskENTER_CRITICAL() portENTER_CRITICAL()\r
-#define taskENTER_CRITICAL_FROM_ISR() portSET_INTERRUPT_MASK_FROM_ISR()\r
-\r
-/**\r
- * task. h\r
- *\r
- * Macro to mark the end of a critical code region. Preemptive context\r
- * switches cannot occur when in a critical region.\r
- *\r
- * NOTE: This may alter the stack (depending on the portable implementation)\r
- * so must be used with care!\r
- *\r
- * \defgroup taskEXIT_CRITICAL taskEXIT_CRITICAL\r
- * \ingroup SchedulerControl\r
- */\r
-#define taskEXIT_CRITICAL() portEXIT_CRITICAL()\r
-#define taskEXIT_CRITICAL_FROM_ISR( x ) portCLEAR_INTERRUPT_MASK_FROM_ISR( x )\r
-/**\r
- * task. h\r
- *\r
- * Macro to disable all maskable interrupts.\r
- *\r
- * \defgroup taskDISABLE_INTERRUPTS taskDISABLE_INTERRUPTS\r
- * \ingroup SchedulerControl\r
- */\r
-#define taskDISABLE_INTERRUPTS() portDISABLE_INTERRUPTS()\r
-\r
-/**\r
- * task. h\r
- *\r
- * Macro to enable microcontroller interrupts.\r
- *\r
- * \defgroup taskENABLE_INTERRUPTS taskENABLE_INTERRUPTS\r
- * \ingroup SchedulerControl\r
- */\r
-#define taskENABLE_INTERRUPTS() portENABLE_INTERRUPTS()\r
-\r
-/* Definitions returned by xTaskGetSchedulerState(). taskSCHEDULER_SUSPENDED is\r
-0 to generate more optimal code when configASSERT() is defined as the constant\r
-is used in assert() statements. */\r
-#define taskSCHEDULER_SUSPENDED ( ( BaseType_t ) 0 )\r
-#define taskSCHEDULER_NOT_STARTED ( ( BaseType_t ) 1 )\r
-#define taskSCHEDULER_RUNNING ( ( BaseType_t ) 2 )\r
-\r
-\r
-/*-----------------------------------------------------------\r
- * TASK CREATION API\r
- *----------------------------------------------------------*/\r
-\r
-/**\r
- * task. h\r
- *<pre>\r
- BaseType_t xTaskCreate(\r
- TaskFunction_t pvTaskCode,\r
- const char * const pcName,\r
- configSTACK_DEPTH_TYPE usStackDepth,\r
- void *pvParameters,\r
- UBaseType_t uxPriority,\r
- TaskHandle_t *pvCreatedTask\r
- );</pre>\r
- *\r
- * Create a new task and add it to the list of tasks that are ready to run.\r
- *\r
- * Internally, within the FreeRTOS implementation, tasks use two blocks of\r
- * memory. The first block is used to hold the task's data structures. The\r
- * second block is used by the task as its stack. If a task is created using\r
- * xTaskCreate() then both blocks of memory are automatically dynamically\r
- * allocated inside the xTaskCreate() function. (see\r
- * http://www.freertos.org/a00111.html). If a task is created using\r
- * xTaskCreateStatic() then the application writer must provide the required\r
- * memory. xTaskCreateStatic() therefore allows a task to be created without\r
- * using any dynamic memory allocation.\r
- *\r
- * See xTaskCreateStatic() for a version that does not use any dynamic memory\r
- * allocation.\r
- *\r
- * xTaskCreate() can only be used to create a task that has unrestricted\r
- * access to the entire microcontroller memory map. Systems that include MPU\r
- * support can alternatively create an MPU constrained task using\r
- * xTaskCreateRestricted().\r
- *\r
- * @param pvTaskCode Pointer to the task entry function. Tasks\r
- * must be implemented to never return (i.e. continuous loop).\r
- *\r
- * @param pcName A descriptive name for the task. This is mainly used to\r
- * facilitate debugging. Max length defined by configMAX_TASK_NAME_LEN - default\r
- * is 16.\r
- *\r
- * @param usStackDepth The size of the task stack specified as the number of\r
- * variables the stack can hold - not the number of bytes. For example, if\r
- * the stack is 16 bits wide and usStackDepth is defined as 100, 200 bytes\r
- * will be allocated for stack storage.\r
- *\r
- * @param pvParameters Pointer that will be used as the parameter for the task\r
- * being created.\r
- *\r
- * @param uxPriority The priority at which the task should run. Systems that\r
- * include MPU support can optionally create tasks in a privileged (system)\r
- * mode by setting bit portPRIVILEGE_BIT of the priority parameter. For\r
- * example, to create a privileged task at priority 2 the uxPriority parameter\r
- * should be set to ( 2 | portPRIVILEGE_BIT ).\r
- *\r
- * @param pvCreatedTask Used to pass back a handle by which the created task\r
- * can be referenced.\r
- *\r
- * @return pdPASS if the task was successfully created and added to a ready\r
- * list, otherwise an error code defined in the file projdefs.h\r
- *\r
- * Example usage:\r
- <pre>\r
- // Task to be created.\r
- void vTaskCode( void * pvParameters )\r
- {\r
- for( ;; )\r
- {\r
- // Task code goes here.\r
- }\r
- }\r
-\r
- // Function that creates a task.\r
- void vOtherFunction( void )\r
- {\r
- static uint8_t ucParameterToPass;\r
- TaskHandle_t xHandle = NULL;\r
-\r
- // Create the task, storing the handle. Note that the passed parameter ucParameterToPass\r
- // must exist for the lifetime of the task, so in this case is declared static. If it was just an\r
- // an automatic stack variable it might no longer exist, or at least have been corrupted, by the time\r
- // the new task attempts to access it.\r
- xTaskCreate( vTaskCode, "NAME", STACK_SIZE, &ucParameterToPass, tskIDLE_PRIORITY, &xHandle );\r
- configASSERT( xHandle );\r
-\r
- // Use the handle to delete the task.\r
- if( xHandle != NULL )\r
- {\r
- vTaskDelete( xHandle );\r
- }\r
- }\r
- </pre>\r
- * \defgroup xTaskCreate xTaskCreate\r
- * \ingroup Tasks\r
- */\r
-#if( configSUPPORT_DYNAMIC_ALLOCATION == 1 )\r
- BaseType_t xTaskCreate( TaskFunction_t pxTaskCode,\r
- const char * const pcName, /*lint !e971 Unqualified char types are allowed for strings and single characters only. */\r
- const configSTACK_DEPTH_TYPE usStackDepth,\r
- void * const pvParameters,\r
- UBaseType_t uxPriority,\r
- TaskHandle_t * const pxCreatedTask ) PRIVILEGED_FUNCTION;\r
-#endif\r
-\r
-/**\r
- * task. h\r
- *<pre>\r
- TaskHandle_t xTaskCreateStatic( TaskFunction_t pvTaskCode,\r
- const char * const pcName,\r
- uint32_t ulStackDepth,\r
- void *pvParameters,\r
- UBaseType_t uxPriority,\r
- StackType_t *pxStackBuffer,\r
- StaticTask_t *pxTaskBuffer );</pre>\r
- *\r
- * Create a new task and add it to the list of tasks that are ready to run.\r
- *\r
- * Internally, within the FreeRTOS implementation, tasks use two blocks of\r
- * memory. The first block is used to hold the task's data structures. The\r
- * second block is used by the task as its stack. If a task is created using\r
- * xTaskCreate() then both blocks of memory are automatically dynamically\r
- * allocated inside the xTaskCreate() function. (see\r
- * http://www.freertos.org/a00111.html). If a task is created using\r
- * xTaskCreateStatic() then the application writer must provide the required\r
- * memory. xTaskCreateStatic() therefore allows a task to be created without\r
- * using any dynamic memory allocation.\r
- *\r
- * @param pvTaskCode Pointer to the task entry function. Tasks\r
- * must be implemented to never return (i.e. continuous loop).\r
- *\r
- * @param pcName A descriptive name for the task. This is mainly used to\r
- * facilitate debugging. The maximum length of the string is defined by\r
- * configMAX_TASK_NAME_LEN in FreeRTOSConfig.h.\r
- *\r
- * @param ulStackDepth The size of the task stack specified as the number of\r
- * variables the stack can hold - not the number of bytes. For example, if\r
- * the stack is 32-bits wide and ulStackDepth is defined as 100 then 400 bytes\r
- * will be allocated for stack storage.\r
- *\r
- * @param pvParameters Pointer that will be used as the parameter for the task\r
- * being created.\r
- *\r
- * @param uxPriority The priority at which the task will run.\r
- *\r
- * @param pxStackBuffer Must point to a StackType_t array that has at least\r
- * ulStackDepth indexes - the array will then be used as the task's stack,\r
- * removing the need for the stack to be allocated dynamically.\r
- *\r
- * @param pxTaskBuffer Must point to a variable of type StaticTask_t, which will\r
- * then be used to hold the task's data structures, removing the need for the\r
- * memory to be allocated dynamically.\r
- *\r
- * @return If neither pxStackBuffer or pxTaskBuffer are NULL, then the task will\r
- * be created and pdPASS is returned. If either pxStackBuffer or pxTaskBuffer\r
- * are NULL then the task will not be created and\r
- * errCOULD_NOT_ALLOCATE_REQUIRED_MEMORY is returned.\r
- *\r
- * Example usage:\r
- <pre>\r
-\r
- // Dimensions the buffer that the task being created will use as its stack.\r
- // NOTE: This is the number of words the stack will hold, not the number of\r
- // bytes. For example, if each stack item is 32-bits, and this is set to 100,\r
- // then 400 bytes (100 * 32-bits) will be allocated.\r
- #define STACK_SIZE 200\r
-\r
- // Structure that will hold the TCB of the task being created.\r
- StaticTask_t xTaskBuffer;\r
-\r
- // Buffer that the task being created will use as its stack. Note this is\r
- // an array of StackType_t variables. The size of StackType_t is dependent on\r
- // the RTOS port.\r
- StackType_t xStack[ STACK_SIZE ];\r
-\r
- // Function that implements the task being created.\r
- void vTaskCode( void * pvParameters )\r
- {\r
- // The parameter value is expected to be 1 as 1 is passed in the\r
- // pvParameters value in the call to xTaskCreateStatic().\r
- configASSERT( ( uint32_t ) pvParameters == 1UL );\r
-\r
- for( ;; )\r
- {\r
- // Task code goes here.\r
- }\r
- }\r
-\r
- // Function that creates a task.\r
- void vOtherFunction( void )\r
- {\r
- TaskHandle_t xHandle = NULL;\r
-\r
- // Create the task without using any dynamic memory allocation.\r
- xHandle = xTaskCreateStatic(\r
- vTaskCode, // Function that implements the task.\r
- "NAME", // Text name for the task.\r
- STACK_SIZE, // Stack size in words, not bytes.\r
- ( void * ) 1, // Parameter passed into the task.\r
- tskIDLE_PRIORITY,// Priority at which the task is created.\r
- xStack, // Array to use as the task's stack.\r
- &xTaskBuffer ); // Variable to hold the task's data structure.\r
-\r
- // puxStackBuffer and pxTaskBuffer were not NULL, so the task will have\r
- // been created, and xHandle will be the task's handle. Use the handle\r
- // to suspend the task.\r
- vTaskSuspend( xHandle );\r
- }\r
- </pre>\r
- * \defgroup xTaskCreateStatic xTaskCreateStatic\r
- * \ingroup Tasks\r
- */\r
-#if( configSUPPORT_STATIC_ALLOCATION == 1 )\r
- TaskHandle_t xTaskCreateStatic( TaskFunction_t pxTaskCode,\r
- const char * const pcName, /*lint !e971 Unqualified char types are allowed for strings and single characters only. */\r
- const uint32_t ulStackDepth,\r
- void * const pvParameters,\r
- UBaseType_t uxPriority,\r
- StackType_t * const puxStackBuffer,\r
- StaticTask_t * const pxTaskBuffer ) PRIVILEGED_FUNCTION;\r
-#endif /* configSUPPORT_STATIC_ALLOCATION */\r
-\r
-/**\r
- * task. h\r
- *<pre>\r
- BaseType_t xTaskCreateRestricted( TaskParameters_t *pxTaskDefinition, TaskHandle_t *pxCreatedTask );</pre>\r
- *\r
- * Only available when configSUPPORT_DYNAMIC_ALLOCATION is set to 1.\r
- *\r
- * xTaskCreateRestricted() should only be used in systems that include an MPU\r
- * implementation.\r
- *\r
- * Create a new task and add it to the list of tasks that are ready to run.\r
- * The function parameters define the memory regions and associated access\r
- * permissions allocated to the task.\r
- *\r
- * See xTaskCreateRestrictedStatic() for a version that does not use any\r
- * dynamic memory allocation.\r
- *\r
- * @param pxTaskDefinition Pointer to a structure that contains a member\r
- * for each of the normal xTaskCreate() parameters (see the xTaskCreate() API\r
- * documentation) plus an optional stack buffer and the memory region\r
- * definitions.\r
- *\r
- * @param pxCreatedTask Used to pass back a handle by which the created task\r
- * can be referenced.\r
- *\r
- * @return pdPASS if the task was successfully created and added to a ready\r
- * list, otherwise an error code defined in the file projdefs.h\r
- *\r
- * Example usage:\r
- <pre>\r
-// Create an TaskParameters_t structure that defines the task to be created.\r
-static const TaskParameters_t xCheckTaskParameters =\r
-{\r
- vATask, // pvTaskCode - the function that implements the task.\r
- "ATask", // pcName - just a text name for the task to assist debugging.\r
- 100, // usStackDepth - the stack size DEFINED IN WORDS.\r
- NULL, // pvParameters - passed into the task function as the function parameters.\r
- ( 1UL | portPRIVILEGE_BIT ),// uxPriority - task priority, set the portPRIVILEGE_BIT if the task should run in a privileged state.\r
- cStackBuffer,// puxStackBuffer - the buffer to be used as the task stack.\r
-\r
- // xRegions - Allocate up to three separate memory regions for access by\r
- // the task, with appropriate access permissions. Different processors have\r
- // different memory alignment requirements - refer to the FreeRTOS documentation\r
- // for full information.\r
- {\r
- // Base address Length Parameters\r
- { cReadWriteArray, 32, portMPU_REGION_READ_WRITE },\r
- { cReadOnlyArray, 32, portMPU_REGION_READ_ONLY },\r
- { cPrivilegedOnlyAccessArray, 128, portMPU_REGION_PRIVILEGED_READ_WRITE }\r
- }\r
-};\r
-\r
-int main( void )\r
-{\r
-TaskHandle_t xHandle;\r
-\r
- // Create a task from the const structure defined above. The task handle\r
- // is requested (the second parameter is not NULL) but in this case just for\r
- // demonstration purposes as its not actually used.\r
- xTaskCreateRestricted( &xRegTest1Parameters, &xHandle );\r
-\r
- // Start the scheduler.\r
- vTaskStartScheduler();\r
-\r
- // Will only get here if there was insufficient memory to create the idle\r
- // and/or timer task.\r
- for( ;; );\r
-}\r
- </pre>\r
- * \defgroup xTaskCreateRestricted xTaskCreateRestricted\r
- * \ingroup Tasks\r
- */\r
-#if( portUSING_MPU_WRAPPERS == 1 )\r
- BaseType_t xTaskCreateRestricted( const TaskParameters_t * const pxTaskDefinition, TaskHandle_t *pxCreatedTask ) PRIVILEGED_FUNCTION;\r
-#endif\r
-\r
-/**\r
- * task. h\r
- *<pre>\r
- BaseType_t xTaskCreateRestrictedStatic( TaskParameters_t *pxTaskDefinition, TaskHandle_t *pxCreatedTask );</pre>\r
- *\r
- * Only available when configSUPPORT_STATIC_ALLOCATION is set to 1.\r
- *\r
- * xTaskCreateRestrictedStatic() should only be used in systems that include an\r
- * MPU implementation.\r
- *\r
- * Internally, within the FreeRTOS implementation, tasks use two blocks of\r
- * memory. The first block is used to hold the task's data structures. The\r
- * second block is used by the task as its stack. If a task is created using\r
- * xTaskCreateRestricted() then the stack is provided by the application writer,\r
- * and the memory used to hold the task's data structure is automatically\r
- * dynamically allocated inside the xTaskCreateRestricted() function. If a task\r
- * is created using xTaskCreateRestrictedStatic() then the application writer\r
- * must provide the memory used to hold the task's data structures too.\r
- * xTaskCreateRestrictedStatic() therefore allows a memory protected task to be\r
- * created without using any dynamic memory allocation.\r
- *\r
- * @param pxTaskDefinition Pointer to a structure that contains a member\r
- * for each of the normal xTaskCreate() parameters (see the xTaskCreate() API\r
- * documentation) plus an optional stack buffer and the memory region\r
- * definitions. If configSUPPORT_STATIC_ALLOCATION is set to 1 the structure\r
- * contains an additional member, which is used to point to a variable of type\r
- * StaticTask_t - which is then used to hold the task's data structure.\r
- *\r
- * @param pxCreatedTask Used to pass back a handle by which the created task\r
- * can be referenced.\r
- *\r
- * @return pdPASS if the task was successfully created and added to a ready\r
- * list, otherwise an error code defined in the file projdefs.h\r
- *\r
- * Example usage:\r
- <pre>\r
-// Create an TaskParameters_t structure that defines the task to be created.\r
-// The StaticTask_t variable is only included in the structure when\r
-// configSUPPORT_STATIC_ALLOCATION is set to 1. The PRIVILEGED_DATA macro can\r
-// be used to force the variable into the RTOS kernel's privileged data area.\r
-static PRIVILEGED_DATA StaticTask_t xTaskBuffer;\r
-static const TaskParameters_t xCheckTaskParameters =\r
-{\r
- vATask, // pvTaskCode - the function that implements the task.\r
- "ATask", // pcName - just a text name for the task to assist debugging.\r
- 100, // usStackDepth - the stack size DEFINED IN WORDS.\r
- NULL, // pvParameters - passed into the task function as the function parameters.\r
- ( 1UL | portPRIVILEGE_BIT ),// uxPriority - task priority, set the portPRIVILEGE_BIT if the task should run in a privileged state.\r
- cStackBuffer,// puxStackBuffer - the buffer to be used as the task stack.\r
-\r
- // xRegions - Allocate up to three separate memory regions for access by\r
- // the task, with appropriate access permissions. Different processors have\r
- // different memory alignment requirements - refer to the FreeRTOS documentation\r
- // for full information.\r
- {\r
- // Base address Length Parameters\r
- { cReadWriteArray, 32, portMPU_REGION_READ_WRITE },\r
- { cReadOnlyArray, 32, portMPU_REGION_READ_ONLY },\r
- { cPrivilegedOnlyAccessArray, 128, portMPU_REGION_PRIVILEGED_READ_WRITE }\r
- }\r
-\r
- &xTaskBuffer; // Holds the task's data structure.\r
-};\r
-\r
-int main( void )\r
-{\r
-TaskHandle_t xHandle;\r
-\r
- // Create a task from the const structure defined above. The task handle\r
- // is requested (the second parameter is not NULL) but in this case just for\r
- // demonstration purposes as its not actually used.\r
- xTaskCreateRestricted( &xRegTest1Parameters, &xHandle );\r
-\r
- // Start the scheduler.\r
- vTaskStartScheduler();\r
-\r
- // Will only get here if there was insufficient memory to create the idle\r
- // and/or timer task.\r
- for( ;; );\r
-}\r
- </pre>\r
- * \defgroup xTaskCreateRestrictedStatic xTaskCreateRestrictedStatic\r
- * \ingroup Tasks\r
- */\r
-#if( ( portUSING_MPU_WRAPPERS == 1 ) && ( configSUPPORT_STATIC_ALLOCATION == 1 ) )\r
- BaseType_t xTaskCreateRestrictedStatic( const TaskParameters_t * const pxTaskDefinition, TaskHandle_t *pxCreatedTask ) PRIVILEGED_FUNCTION;\r
-#endif\r
-\r
-/**\r
- * task. h\r
- *<pre>\r
- void vTaskAllocateMPURegions( TaskHandle_t xTask, const MemoryRegion_t * const pxRegions );</pre>\r
- *\r
- * Memory regions are assigned to a restricted task when the task is created by\r
- * a call to xTaskCreateRestricted(). These regions can be redefined using\r
- * vTaskAllocateMPURegions().\r
- *\r
- * @param xTask The handle of the task being updated.\r
- *\r
- * @param xRegions A pointer to an MemoryRegion_t structure that contains the\r
- * new memory region definitions.\r
- *\r
- * Example usage:\r
- <pre>\r
-// Define an array of MemoryRegion_t structures that configures an MPU region\r
-// allowing read/write access for 1024 bytes starting at the beginning of the\r
-// ucOneKByte array. The other two of the maximum 3 definable regions are\r
-// unused so set to zero.\r
-static const MemoryRegion_t xAltRegions[ portNUM_CONFIGURABLE_REGIONS ] =\r
-{\r
- // Base address Length Parameters\r
- { ucOneKByte, 1024, portMPU_REGION_READ_WRITE },\r
- { 0, 0, 0 },\r
- { 0, 0, 0 }\r
-};\r
-\r
-void vATask( void *pvParameters )\r
-{\r
- // This task was created such that it has access to certain regions of\r
- // memory as defined by the MPU configuration. At some point it is\r
- // desired that these MPU regions are replaced with that defined in the\r
- // xAltRegions const struct above. Use a call to vTaskAllocateMPURegions()\r
- // for this purpose. NULL is used as the task handle to indicate that this\r
- // function should modify the MPU regions of the calling task.\r
- vTaskAllocateMPURegions( NULL, xAltRegions );\r
-\r
- // Now the task can continue its function, but from this point on can only\r
- // access its stack and the ucOneKByte array (unless any other statically\r
- // defined or shared regions have been declared elsewhere).\r
-}\r
- </pre>\r
- * \defgroup xTaskCreateRestricted xTaskCreateRestricted\r
- * \ingroup Tasks\r
- */\r
-void vTaskAllocateMPURegions( TaskHandle_t xTask, const MemoryRegion_t * const pxRegions ) PRIVILEGED_FUNCTION;\r
-\r
-/**\r
- * task. h\r
- * <pre>void vTaskDelete( TaskHandle_t xTask );</pre>\r
- *\r
- * INCLUDE_vTaskDelete must be defined as 1 for this function to be available.\r
- * See the configuration section for more information.\r
- *\r
- * Remove a task from the RTOS real time kernel's management. The task being\r
- * deleted will be removed from all ready, blocked, suspended and event lists.\r
- *\r
- * NOTE: The idle task is responsible for freeing the kernel allocated\r
- * memory from tasks that have been deleted. It is therefore important that\r
- * the idle task is not starved of microcontroller processing time if your\r
- * application makes any calls to vTaskDelete (). Memory allocated by the\r
- * task code is not automatically freed, and should be freed before the task\r
- * is deleted.\r
- *\r
- * See the demo application file death.c for sample code that utilises\r
- * vTaskDelete ().\r
- *\r
- * @param xTask The handle of the task to be deleted. Passing NULL will\r
- * cause the calling task to be deleted.\r
- *\r
- * Example usage:\r
- <pre>\r
- void vOtherFunction( void )\r
- {\r
- TaskHandle_t xHandle;\r
-\r
- // Create the task, storing the handle.\r
- xTaskCreate( vTaskCode, "NAME", STACK_SIZE, NULL, tskIDLE_PRIORITY, &xHandle );\r
-\r
- // Use the handle to delete the task.\r
- vTaskDelete( xHandle );\r
- }\r
- </pre>\r
- * \defgroup vTaskDelete vTaskDelete\r
- * \ingroup Tasks\r
- */\r
-void vTaskDelete( TaskHandle_t xTaskToDelete ) PRIVILEGED_FUNCTION;\r
-\r
-/*-----------------------------------------------------------\r
- * TASK CONTROL API\r
- *----------------------------------------------------------*/\r
-\r
-/**\r
- * task. h\r
- * <pre>void vTaskDelay( const TickType_t xTicksToDelay );</pre>\r
- *\r
- * Delay a task for a given number of ticks. The actual time that the\r
- * task remains blocked depends on the tick rate. The constant\r
- * portTICK_PERIOD_MS can be used to calculate real time from the tick\r
- * rate - with the resolution of one tick period.\r
- *\r
- * INCLUDE_vTaskDelay must be defined as 1 for this function to be available.\r
- * See the configuration section for more information.\r
- *\r
- *\r
- * vTaskDelay() specifies a time at which the task wishes to unblock relative to\r
- * the time at which vTaskDelay() is called. For example, specifying a block\r
- * period of 100 ticks will cause the task to unblock 100 ticks after\r
- * vTaskDelay() is called. vTaskDelay() does not therefore provide a good method\r
- * of controlling the frequency of a periodic task as the path taken through the\r
- * code, as well as other task and interrupt activity, will effect the frequency\r
- * at which vTaskDelay() gets called and therefore the time at which the task\r
- * next executes. See vTaskDelayUntil() for an alternative API function designed\r
- * to facilitate fixed frequency execution. It does this by specifying an\r
- * absolute time (rather than a relative time) at which the calling task should\r
- * unblock.\r
- *\r
- * @param xTicksToDelay The amount of time, in tick periods, that\r
- * the calling task should block.\r
- *\r
- * Example usage:\r
-\r
- void vTaskFunction( void * pvParameters )\r
- {\r
- // Block for 500ms.\r
- const TickType_t xDelay = 500 / portTICK_PERIOD_MS;\r
-\r
- for( ;; )\r
- {\r
- // Simply toggle the LED every 500ms, blocking between each toggle.\r
- vToggleLED();\r
- vTaskDelay( xDelay );\r
- }\r
- }\r
-\r
- * \defgroup vTaskDelay vTaskDelay\r
- * \ingroup TaskCtrl\r
- */\r
-void vTaskDelay( const TickType_t xTicksToDelay ) PRIVILEGED_FUNCTION;\r
-\r
-/**\r
- * task. h\r
- * <pre>void vTaskDelayUntil( TickType_t *pxPreviousWakeTime, const TickType_t xTimeIncrement );</pre>\r
- *\r
- * INCLUDE_vTaskDelayUntil must be defined as 1 for this function to be available.\r
- * See the configuration section for more information.\r
- *\r
- * Delay a task until a specified time. This function can be used by periodic\r
- * tasks to ensure a constant execution frequency.\r
- *\r
- * This function differs from vTaskDelay () in one important aspect: vTaskDelay () will\r
- * cause a task to block for the specified number of ticks from the time vTaskDelay () is\r
- * called. It is therefore difficult to use vTaskDelay () by itself to generate a fixed\r
- * execution frequency as the time between a task starting to execute and that task\r
- * calling vTaskDelay () may not be fixed [the task may take a different path though the\r
- * code between calls, or may get interrupted or preempted a different number of times\r
- * each time it executes].\r
- *\r
- * Whereas vTaskDelay () specifies a wake time relative to the time at which the function\r
- * is called, vTaskDelayUntil () specifies the absolute (exact) time at which it wishes to\r
- * unblock.\r
- *\r
- * The constant portTICK_PERIOD_MS can be used to calculate real time from the tick\r
- * rate - with the resolution of one tick period.\r
- *\r
- * @param pxPreviousWakeTime Pointer to a variable that holds the time at which the\r
- * task was last unblocked. The variable must be initialised with the current time\r
- * prior to its first use (see the example below). Following this the variable is\r
- * automatically updated within vTaskDelayUntil ().\r
- *\r
- * @param xTimeIncrement The cycle time period. The task will be unblocked at\r
- * time *pxPreviousWakeTime + xTimeIncrement. Calling vTaskDelayUntil with the\r
- * same xTimeIncrement parameter value will cause the task to execute with\r
- * a fixed interface period.\r
- *\r
- * Example usage:\r
- <pre>\r
- // Perform an action every 10 ticks.\r
- void vTaskFunction( void * pvParameters )\r
- {\r
- TickType_t xLastWakeTime;\r
- const TickType_t xFrequency = 10;\r
-\r
- // Initialise the xLastWakeTime variable with the current time.\r
- xLastWakeTime = xTaskGetTickCount ();\r
- for( ;; )\r
- {\r
- // Wait for the next cycle.\r
- vTaskDelayUntil( &xLastWakeTime, xFrequency );\r
-\r
- // Perform action here.\r
- }\r
- }\r
- </pre>\r
- * \defgroup vTaskDelayUntil vTaskDelayUntil\r
- * \ingroup TaskCtrl\r
- */\r
-void vTaskDelayUntil( TickType_t * const pxPreviousWakeTime, const TickType_t xTimeIncrement ) PRIVILEGED_FUNCTION;\r
-\r
-/**\r
- * task. h\r
- * <pre>BaseType_t xTaskAbortDelay( TaskHandle_t xTask );</pre>\r
- *\r
- * INCLUDE_xTaskAbortDelay must be defined as 1 in FreeRTOSConfig.h for this\r
- * function to be available.\r
- *\r
- * A task will enter the Blocked state when it is waiting for an event. The\r
- * event it is waiting for can be a temporal event (waiting for a time), such\r
- * as when vTaskDelay() is called, or an event on an object, such as when\r
- * xQueueReceive() or ulTaskNotifyTake() is called. If the handle of a task\r
- * that is in the Blocked state is used in a call to xTaskAbortDelay() then the\r
- * task will leave the Blocked state, and return from whichever function call\r
- * placed the task into the Blocked state.\r
- *\r
- * @param xTask The handle of the task to remove from the Blocked state.\r
- *\r
- * @return If the task referenced by xTask was not in the Blocked state then\r
- * pdFAIL is returned. Otherwise pdPASS is returned.\r
- *\r
- * \defgroup xTaskAbortDelay xTaskAbortDelay\r
- * \ingroup TaskCtrl\r
- */\r
-BaseType_t xTaskAbortDelay( TaskHandle_t xTask ) PRIVILEGED_FUNCTION;\r
-\r
-/**\r
- * task. h\r
- * <pre>UBaseType_t uxTaskPriorityGet( TaskHandle_t xTask );</pre>\r
- *\r
- * INCLUDE_uxTaskPriorityGet must be defined as 1 for this function to be available.\r
- * See the configuration section for more information.\r
- *\r
- * Obtain the priority of any task.\r
- *\r
- * @param xTask Handle of the task to be queried. Passing a NULL\r
- * handle results in the priority of the calling task being returned.\r
- *\r
- * @return The priority of xTask.\r
- *\r
- * Example usage:\r
- <pre>\r
- void vAFunction( void )\r
- {\r
- TaskHandle_t xHandle;\r
-\r
- // Create a task, storing the handle.\r
- xTaskCreate( vTaskCode, "NAME", STACK_SIZE, NULL, tskIDLE_PRIORITY, &xHandle );\r
-\r
- // ...\r
-\r
- // Use the handle to obtain the priority of the created task.\r
- // It was created with tskIDLE_PRIORITY, but may have changed\r
- // it itself.\r
- if( uxTaskPriorityGet( xHandle ) != tskIDLE_PRIORITY )\r
- {\r
- // The task has changed it's priority.\r
- }\r
-\r
- // ...\r
-\r
- // Is our priority higher than the created task?\r
- if( uxTaskPriorityGet( xHandle ) < uxTaskPriorityGet( NULL ) )\r
- {\r
- // Our priority (obtained using NULL handle) is higher.\r
- }\r
- }\r
- </pre>\r
- * \defgroup uxTaskPriorityGet uxTaskPriorityGet\r
- * \ingroup TaskCtrl\r
- */\r
-UBaseType_t uxTaskPriorityGet( TaskHandle_t xTask ) PRIVILEGED_FUNCTION;\r
-\r
-/**\r
- * task. h\r
- * <pre>UBaseType_t uxTaskPriorityGetFromISR( TaskHandle_t xTask );</pre>\r
- *\r
- * A version of uxTaskPriorityGet() that can be used from an ISR.\r
- */\r
-UBaseType_t uxTaskPriorityGetFromISR( TaskHandle_t xTask ) PRIVILEGED_FUNCTION;\r
-\r
-/**\r
- * task. h\r
- * <pre>eTaskState eTaskGetState( TaskHandle_t xTask );</pre>\r
- *\r
- * INCLUDE_eTaskGetState must be defined as 1 for this function to be available.\r
- * See the configuration section for more information.\r
- *\r
- * Obtain the state of any task. States are encoded by the eTaskState\r
- * enumerated type.\r
- *\r
- * @param xTask Handle of the task to be queried.\r
- *\r
- * @return The state of xTask at the time the function was called. Note the\r
- * state of the task might change between the function being called, and the\r
- * functions return value being tested by the calling task.\r
- */\r
-eTaskState eTaskGetState( TaskHandle_t xTask ) PRIVILEGED_FUNCTION;\r
-\r
-/**\r
- * task. h\r
- * <pre>void vTaskGetInfo( TaskHandle_t xTask, TaskStatus_t *pxTaskStatus, BaseType_t xGetFreeStackSpace, eTaskState eState );</pre>\r
- *\r
- * configUSE_TRACE_FACILITY must be defined as 1 for this function to be\r
- * available. See the configuration section for more information.\r
- *\r
- * Populates a TaskStatus_t structure with information about a task.\r
- *\r
- * @param xTask Handle of the task being queried. If xTask is NULL then\r
- * information will be returned about the calling task.\r
- *\r
- * @param pxTaskStatus A pointer to the TaskStatus_t structure that will be\r
- * filled with information about the task referenced by the handle passed using\r
- * the xTask parameter.\r
- *\r
- * @xGetFreeStackSpace The TaskStatus_t structure contains a member to report\r
- * the stack high water mark of the task being queried. Calculating the stack\r
- * high water mark takes a relatively long time, and can make the system\r
- * temporarily unresponsive - so the xGetFreeStackSpace parameter is provided to\r
- * allow the high water mark checking to be skipped. The high watermark value\r
- * will only be written to the TaskStatus_t structure if xGetFreeStackSpace is\r
- * not set to pdFALSE;\r
- *\r
- * @param eState The TaskStatus_t structure contains a member to report the\r
- * state of the task being queried. Obtaining the task state is not as fast as\r
- * a simple assignment - so the eState parameter is provided to allow the state\r
- * information to be omitted from the TaskStatus_t structure. To obtain state\r
- * information then set eState to eInvalid - otherwise the value passed in\r
- * eState will be reported as the task state in the TaskStatus_t structure.\r
- *\r
- * Example usage:\r
- <pre>\r
- void vAFunction( void )\r
- {\r
- TaskHandle_t xHandle;\r
- TaskStatus_t xTaskDetails;\r
-\r
- // Obtain the handle of a task from its name.\r
- xHandle = xTaskGetHandle( "Task_Name" );\r
-\r
- // Check the handle is not NULL.\r
- configASSERT( xHandle );\r
-\r
- // Use the handle to obtain further information about the task.\r
- vTaskGetInfo( xHandle,\r
- &xTaskDetails,\r
- pdTRUE, // Include the high water mark in xTaskDetails.\r
- eInvalid ); // Include the task state in xTaskDetails.\r
- }\r
- </pre>\r
- * \defgroup vTaskGetInfo vTaskGetInfo\r
- * \ingroup TaskCtrl\r
- */\r
-void vTaskGetInfo( TaskHandle_t xTask, TaskStatus_t *pxTaskStatus, BaseType_t xGetFreeStackSpace, eTaskState eState ) PRIVILEGED_FUNCTION;\r
-\r
-/**\r
- * task. h\r
- * <pre>void vTaskPrioritySet( TaskHandle_t xTask, UBaseType_t uxNewPriority );</pre>\r
- *\r
- * INCLUDE_vTaskPrioritySet must be defined as 1 for this function to be available.\r
- * See the configuration section for more information.\r
- *\r
- * Set the priority of any task.\r
- *\r
- * A context switch will occur before the function returns if the priority\r
- * being set is higher than the currently executing task.\r
- *\r
- * @param xTask Handle to the task for which the priority is being set.\r
- * Passing a NULL handle results in the priority of the calling task being set.\r
- *\r
- * @param uxNewPriority The priority to which the task will be set.\r
- *\r
- * Example usage:\r
- <pre>\r
- void vAFunction( void )\r
- {\r
- TaskHandle_t xHandle;\r
-\r
- // Create a task, storing the handle.\r
- xTaskCreate( vTaskCode, "NAME", STACK_SIZE, NULL, tskIDLE_PRIORITY, &xHandle );\r
-\r
- // ...\r
-\r
- // Use the handle to raise the priority of the created task.\r
- vTaskPrioritySet( xHandle, tskIDLE_PRIORITY + 1 );\r
-\r
- // ...\r
-\r
- // Use a NULL handle to raise our priority to the same value.\r
- vTaskPrioritySet( NULL, tskIDLE_PRIORITY + 1 );\r
- }\r
- </pre>\r
- * \defgroup vTaskPrioritySet vTaskPrioritySet\r
- * \ingroup TaskCtrl\r
- */\r
-void vTaskPrioritySet( TaskHandle_t xTask, UBaseType_t uxNewPriority ) PRIVILEGED_FUNCTION;\r
-\r
-/**\r
- * task. h\r
- * <pre>void vTaskSuspend( TaskHandle_t xTaskToSuspend );</pre>\r
- *\r
- * INCLUDE_vTaskSuspend must be defined as 1 for this function to be available.\r
- * See the configuration section for more information.\r
- *\r
- * Suspend any task. When suspended a task will never get any microcontroller\r
- * processing time, no matter what its priority.\r
- *\r
- * Calls to vTaskSuspend are not accumulative -\r
- * i.e. calling vTaskSuspend () twice on the same task still only requires one\r
- * call to vTaskResume () to ready the suspended task.\r
- *\r
- * @param xTaskToSuspend Handle to the task being suspended. Passing a NULL\r
- * handle will cause the calling task to be suspended.\r
- *\r
- * Example usage:\r
- <pre>\r
- void vAFunction( void )\r
- {\r
- TaskHandle_t xHandle;\r
-\r
- // Create a task, storing the handle.\r
- xTaskCreate( vTaskCode, "NAME", STACK_SIZE, NULL, tskIDLE_PRIORITY, &xHandle );\r
-\r
- // ...\r
-\r
- // Use the handle to suspend the created task.\r
- vTaskSuspend( xHandle );\r
-\r
- // ...\r
-\r
- // The created task will not run during this period, unless\r
- // another task calls vTaskResume( xHandle ).\r
-\r
- //...\r
-\r
-\r
- // Suspend ourselves.\r
- vTaskSuspend( NULL );\r
-\r
- // We cannot get here unless another task calls vTaskResume\r
- // with our handle as the parameter.\r
- }\r
- </pre>\r
- * \defgroup vTaskSuspend vTaskSuspend\r
- * \ingroup TaskCtrl\r
- */\r
-void vTaskSuspend( TaskHandle_t xTaskToSuspend ) PRIVILEGED_FUNCTION;\r
-\r
-/**\r
- * task. h\r
- * <pre>void vTaskResume( TaskHandle_t xTaskToResume );</pre>\r
- *\r
- * INCLUDE_vTaskSuspend must be defined as 1 for this function to be available.\r
- * See the configuration section for more information.\r
- *\r
- * Resumes a suspended task.\r
- *\r
- * A task that has been suspended by one or more calls to vTaskSuspend ()\r
- * will be made available for running again by a single call to\r
- * vTaskResume ().\r
- *\r
- * @param xTaskToResume Handle to the task being readied.\r
- *\r
- * Example usage:\r
- <pre>\r
- void vAFunction( void )\r
- {\r
- TaskHandle_t xHandle;\r
-\r
- // Create a task, storing the handle.\r
- xTaskCreate( vTaskCode, "NAME", STACK_SIZE, NULL, tskIDLE_PRIORITY, &xHandle );\r
-\r
- // ...\r
-\r
- // Use the handle to suspend the created task.\r
- vTaskSuspend( xHandle );\r
-\r
- // ...\r
-\r
- // The created task will not run during this period, unless\r
- // another task calls vTaskResume( xHandle ).\r
-\r
- //...\r
-\r
-\r
- // Resume the suspended task ourselves.\r
- vTaskResume( xHandle );\r
-\r
- // The created task will once again get microcontroller processing\r
- // time in accordance with its priority within the system.\r
- }\r
- </pre>\r
- * \defgroup vTaskResume vTaskResume\r
- * \ingroup TaskCtrl\r
- */\r
-void vTaskResume( TaskHandle_t xTaskToResume ) PRIVILEGED_FUNCTION;\r
-\r
-/**\r
- * task. h\r
- * <pre>void xTaskResumeFromISR( TaskHandle_t xTaskToResume );</pre>\r
- *\r
- * INCLUDE_xTaskResumeFromISR must be defined as 1 for this function to be\r
- * available. See the configuration section for more information.\r
- *\r
- * An implementation of vTaskResume() that can be called from within an ISR.\r
- *\r
- * A task that has been suspended by one or more calls to vTaskSuspend ()\r
- * will be made available for running again by a single call to\r
- * xTaskResumeFromISR ().\r
- *\r
- * xTaskResumeFromISR() should not be used to synchronise a task with an\r
- * interrupt if there is a chance that the interrupt could arrive prior to the\r
- * task being suspended - as this can lead to interrupts being missed. Use of a\r
- * semaphore as a synchronisation mechanism would avoid this eventuality.\r
- *\r
- * @param xTaskToResume Handle to the task being readied.\r
- *\r
- * @return pdTRUE if resuming the task should result in a context switch,\r
- * otherwise pdFALSE. This is used by the ISR to determine if a context switch\r
- * may be required following the ISR.\r
- *\r
- * \defgroup vTaskResumeFromISR vTaskResumeFromISR\r
- * \ingroup TaskCtrl\r
- */\r
-BaseType_t xTaskResumeFromISR( TaskHandle_t xTaskToResume ) PRIVILEGED_FUNCTION;\r
-\r
-/*-----------------------------------------------------------\r
- * SCHEDULER CONTROL\r
- *----------------------------------------------------------*/\r
-\r
-/**\r
- * task. h\r
- * <pre>void vTaskStartScheduler( void );</pre>\r
- *\r
- * Starts the real time kernel tick processing. After calling the kernel\r
- * has control over which tasks are executed and when.\r
- *\r
- * See the demo application file main.c for an example of creating\r
- * tasks and starting the kernel.\r
- *\r
- * Example usage:\r
- <pre>\r
- void vAFunction( void )\r
- {\r
- // Create at least one task before starting the kernel.\r
- xTaskCreate( vTaskCode, "NAME", STACK_SIZE, NULL, tskIDLE_PRIORITY, NULL );\r
-\r
- // Start the real time kernel with preemption.\r
- vTaskStartScheduler ();\r
-\r
- // Will not get here unless a task calls vTaskEndScheduler ()\r
- }\r
- </pre>\r
- *\r
- * \defgroup vTaskStartScheduler vTaskStartScheduler\r
- * \ingroup SchedulerControl\r
- */\r
-void vTaskStartScheduler( void ) PRIVILEGED_FUNCTION;\r
-\r
-/**\r
- * task. h\r
- * <pre>void vTaskEndScheduler( void );</pre>\r
- *\r
- * NOTE: At the time of writing only the x86 real mode port, which runs on a PC\r
- * in place of DOS, implements this function.\r
- *\r
- * Stops the real time kernel tick. All created tasks will be automatically\r
- * deleted and multitasking (either preemptive or cooperative) will\r
- * stop. Execution then resumes from the point where vTaskStartScheduler ()\r
- * was called, as if vTaskStartScheduler () had just returned.\r
- *\r
- * See the demo application file main. c in the demo/PC directory for an\r
- * example that uses vTaskEndScheduler ().\r
- *\r
- * vTaskEndScheduler () requires an exit function to be defined within the\r
- * portable layer (see vPortEndScheduler () in port. c for the PC port). This\r
- * performs hardware specific operations such as stopping the kernel tick.\r
- *\r
- * vTaskEndScheduler () will cause all of the resources allocated by the\r
- * kernel to be freed - but will not free resources allocated by application\r
- * tasks.\r
- *\r
- * Example usage:\r
- <pre>\r
- void vTaskCode( void * pvParameters )\r
- {\r
- for( ;; )\r
- {\r
- // Task code goes here.\r
-\r
- // At some point we want to end the real time kernel processing\r
- // so call ...\r
- vTaskEndScheduler ();\r
- }\r
- }\r
-\r
- void vAFunction( void )\r
- {\r
- // Create at least one task before starting the kernel.\r
- xTaskCreate( vTaskCode, "NAME", STACK_SIZE, NULL, tskIDLE_PRIORITY, NULL );\r
-\r
- // Start the real time kernel with preemption.\r
- vTaskStartScheduler ();\r
-\r
- // Will only get here when the vTaskCode () task has called\r
- // vTaskEndScheduler (). When we get here we are back to single task\r
- // execution.\r
- }\r
- </pre>\r
- *\r
- * \defgroup vTaskEndScheduler vTaskEndScheduler\r
- * \ingroup SchedulerControl\r
- */\r
-void vTaskEndScheduler( void ) PRIVILEGED_FUNCTION;\r
-\r
-/**\r
- * task. h\r
- * <pre>void vTaskSuspendAll( void );</pre>\r
- *\r
- * Suspends the scheduler without disabling interrupts. Context switches will\r
- * not occur while the scheduler is suspended.\r
- *\r
- * After calling vTaskSuspendAll () the calling task will continue to execute\r
- * without risk of being swapped out until a call to xTaskResumeAll () has been\r
- * made.\r
- *\r
- * API functions that have the potential to cause a context switch (for example,\r
- * vTaskDelayUntil(), xQueueSend(), etc.) must not be called while the scheduler\r
- * is suspended.\r
- *\r
- * Example usage:\r
- <pre>\r
- void vTask1( void * pvParameters )\r
- {\r
- for( ;; )\r
- {\r
- // Task code goes here.\r
-\r
- // ...\r
-\r
- // At some point the task wants to perform a long operation during\r
- // which it does not want to get swapped out. It cannot use\r
- // taskENTER_CRITICAL ()/taskEXIT_CRITICAL () as the length of the\r
- // operation may cause interrupts to be missed - including the\r
- // ticks.\r
-\r
- // Prevent the real time kernel swapping out the task.\r
- vTaskSuspendAll ();\r
-\r
- // Perform the operation here. There is no need to use critical\r
- // sections as we have all the microcontroller processing time.\r
- // During this time interrupts will still operate and the kernel\r
- // tick count will be maintained.\r
-\r
- // ...\r
-\r
- // The operation is complete. Restart the kernel.\r
- xTaskResumeAll ();\r
- }\r
- }\r
- </pre>\r
- * \defgroup vTaskSuspendAll vTaskSuspendAll\r
- * \ingroup SchedulerControl\r
- */\r
-void vTaskSuspendAll( void ) PRIVILEGED_FUNCTION;\r
-\r
-/**\r
- * task. h\r
- * <pre>BaseType_t xTaskResumeAll( void );</pre>\r
- *\r
- * Resumes scheduler activity after it was suspended by a call to\r
- * vTaskSuspendAll().\r
- *\r
- * xTaskResumeAll() only resumes the scheduler. It does not unsuspend tasks\r
- * that were previously suspended by a call to vTaskSuspend().\r
- *\r
- * @return If resuming the scheduler caused a context switch then pdTRUE is\r
- * returned, otherwise pdFALSE is returned.\r
- *\r
- * Example usage:\r
- <pre>\r
- void vTask1( void * pvParameters )\r
- {\r
- for( ;; )\r
- {\r
- // Task code goes here.\r
-\r
- // ...\r
-\r
- // At some point the task wants to perform a long operation during\r
- // which it does not want to get swapped out. It cannot use\r
- // taskENTER_CRITICAL ()/taskEXIT_CRITICAL () as the length of the\r
- // operation may cause interrupts to be missed - including the\r
- // ticks.\r
-\r
- // Prevent the real time kernel swapping out the task.\r
- vTaskSuspendAll ();\r
-\r
- // Perform the operation here. There is no need to use critical\r
- // sections as we have all the microcontroller processing time.\r
- // During this time interrupts will still operate and the real\r
- // time kernel tick count will be maintained.\r
-\r
- // ...\r
-\r
- // The operation is complete. Restart the kernel. We want to force\r
- // a context switch - but there is no point if resuming the scheduler\r
- // caused a context switch already.\r
- if( !xTaskResumeAll () )\r
- {\r
- taskYIELD ();\r
- }\r
- }\r
- }\r
- </pre>\r
- * \defgroup xTaskResumeAll xTaskResumeAll\r
- * \ingroup SchedulerControl\r
- */\r
-BaseType_t xTaskResumeAll( void ) PRIVILEGED_FUNCTION;\r
-\r
-/*-----------------------------------------------------------\r
- * TASK UTILITIES\r
- *----------------------------------------------------------*/\r
-\r
-/**\r
- * task. h\r
- * <PRE>TickType_t xTaskGetTickCount( void );</PRE>\r
- *\r
- * @return The count of ticks since vTaskStartScheduler was called.\r
- *\r
- * \defgroup xTaskGetTickCount xTaskGetTickCount\r
- * \ingroup TaskUtils\r
- */\r
-TickType_t xTaskGetTickCount( void ) PRIVILEGED_FUNCTION;\r
-\r
-/**\r
- * task. h\r
- * <PRE>TickType_t xTaskGetTickCountFromISR( void );</PRE>\r
- *\r
- * @return The count of ticks since vTaskStartScheduler was called.\r
- *\r
- * This is a version of xTaskGetTickCount() that is safe to be called from an\r
- * ISR - provided that TickType_t is the natural word size of the\r
- * microcontroller being used or interrupt nesting is either not supported or\r
- * not being used.\r
- *\r
- * \defgroup xTaskGetTickCountFromISR xTaskGetTickCountFromISR\r
- * \ingroup TaskUtils\r
- */\r
-TickType_t xTaskGetTickCountFromISR( void ) PRIVILEGED_FUNCTION;\r
-\r
-/**\r
- * task. h\r
- * <PRE>uint16_t uxTaskGetNumberOfTasks( void );</PRE>\r
- *\r
- * @return The number of tasks that the real time kernel is currently managing.\r
- * This includes all ready, blocked and suspended tasks. A task that\r
- * has been deleted but not yet freed by the idle task will also be\r
- * included in the count.\r
- *\r
- * \defgroup uxTaskGetNumberOfTasks uxTaskGetNumberOfTasks\r
- * \ingroup TaskUtils\r
- */\r
-UBaseType_t uxTaskGetNumberOfTasks( void ) PRIVILEGED_FUNCTION;\r
-\r
-/**\r
- * task. h\r
- * <PRE>char *pcTaskGetName( TaskHandle_t xTaskToQuery );</PRE>\r
- *\r
- * @return The text (human readable) name of the task referenced by the handle\r
- * xTaskToQuery. A task can query its own name by either passing in its own\r
- * handle, or by setting xTaskToQuery to NULL.\r
- *\r
- * \defgroup pcTaskGetName pcTaskGetName\r
- * \ingroup TaskUtils\r
- */\r
-char *pcTaskGetName( TaskHandle_t xTaskToQuery ) PRIVILEGED_FUNCTION; /*lint !e971 Unqualified char types are allowed for strings and single characters only. */\r
-\r
-/**\r
- * task. h\r
- * <PRE>TaskHandle_t xTaskGetHandle( const char *pcNameToQuery );</PRE>\r
- *\r
- * NOTE: This function takes a relatively long time to complete and should be\r
- * used sparingly.\r
- *\r
- * @return The handle of the task that has the human readable name pcNameToQuery.\r
- * NULL is returned if no matching name is found. INCLUDE_xTaskGetHandle\r
- * must be set to 1 in FreeRTOSConfig.h for pcTaskGetHandle() to be available.\r
- *\r
- * \defgroup pcTaskGetHandle pcTaskGetHandle\r
- * \ingroup TaskUtils\r
- */\r
-TaskHandle_t xTaskGetHandle( const char *pcNameToQuery ) PRIVILEGED_FUNCTION; /*lint !e971 Unqualified char types are allowed for strings and single characters only. */\r
-\r
-/**\r
- * task.h\r
- * <PRE>UBaseType_t uxTaskGetStackHighWaterMark( TaskHandle_t xTask );</PRE>\r
- *\r
- * INCLUDE_uxTaskGetStackHighWaterMark must be set to 1 in FreeRTOSConfig.h for\r
- * this function to be available.\r
- *\r
- * Returns the high water mark of the stack associated with xTask. That is,\r
- * the minimum free stack space there has been (in words, so on a 32 bit machine\r
- * a value of 1 means 4 bytes) since the task started. The smaller the returned\r
- * number the closer the task has come to overflowing its stack.\r
- *\r
- * @param xTask Handle of the task associated with the stack to be checked.\r
- * Set xTask to NULL to check the stack of the calling task.\r
- *\r
- * @return The smallest amount of free stack space there has been (in words, so\r
- * actual spaces on the stack rather than bytes) since the task referenced by\r
- * xTask was created.\r
- */\r
-UBaseType_t uxTaskGetStackHighWaterMark( TaskHandle_t xTask ) PRIVILEGED_FUNCTION;\r
-\r
-/* When using trace macros it is sometimes necessary to include task.h before\r
-FreeRTOS.h. When this is done TaskHookFunction_t will not yet have been defined,\r
-so the following two prototypes will cause a compilation error. This can be\r
-fixed by simply guarding against the inclusion of these two prototypes unless\r
-they are explicitly required by the configUSE_APPLICATION_TASK_TAG configuration\r
-constant. */\r
-#ifdef configUSE_APPLICATION_TASK_TAG\r
- #if configUSE_APPLICATION_TASK_TAG == 1\r
- /**\r
- * task.h\r
- * <pre>void vTaskSetApplicationTaskTag( TaskHandle_t xTask, TaskHookFunction_t pxHookFunction );</pre>\r
- *\r
- * Sets pxHookFunction to be the task hook function used by the task xTask.\r
- * Passing xTask as NULL has the effect of setting the calling tasks hook\r
- * function.\r
- */\r
- void vTaskSetApplicationTaskTag( TaskHandle_t xTask, TaskHookFunction_t pxHookFunction ) PRIVILEGED_FUNCTION;\r
-\r
- /**\r
- * task.h\r
- * <pre>void xTaskGetApplicationTaskTag( TaskHandle_t xTask );</pre>\r
- *\r
- * Returns the pxHookFunction value assigned to the task xTask.\r
- */\r
- TaskHookFunction_t xTaskGetApplicationTaskTag( TaskHandle_t xTask ) PRIVILEGED_FUNCTION;\r
- #endif /* configUSE_APPLICATION_TASK_TAG ==1 */\r
-#endif /* ifdef configUSE_APPLICATION_TASK_TAG */\r
-\r
-#if( configNUM_THREAD_LOCAL_STORAGE_POINTERS > 0 )\r
-\r
- /* Each task contains an array of pointers that is dimensioned by the\r
- configNUM_THREAD_LOCAL_STORAGE_POINTERS setting in FreeRTOSConfig.h. The\r
- kernel does not use the pointers itself, so the application writer can use\r
- the pointers for any purpose they wish. The following two functions are\r
- used to set and query a pointer respectively. */\r
- void vTaskSetThreadLocalStoragePointer( TaskHandle_t xTaskToSet, BaseType_t xIndex, void *pvValue ) PRIVILEGED_FUNCTION;\r
- void *pvTaskGetThreadLocalStoragePointer( TaskHandle_t xTaskToQuery, BaseType_t xIndex ) PRIVILEGED_FUNCTION;\r
-\r
-#endif\r
-\r
-/**\r
- * task.h\r
- * <pre>BaseType_t xTaskCallApplicationTaskHook( TaskHandle_t xTask, void *pvParameter );</pre>\r
- *\r
- * Calls the hook function associated with xTask. Passing xTask as NULL has\r
- * the effect of calling the Running tasks (the calling task) hook function.\r
- *\r
- * pvParameter is passed to the hook function for the task to interpret as it\r
- * wants. The return value is the value returned by the task hook function\r
- * registered by the user.\r
- */\r
-BaseType_t xTaskCallApplicationTaskHook( TaskHandle_t xTask, void *pvParameter ) PRIVILEGED_FUNCTION;\r
-\r
-/**\r
- * xTaskGetIdleTaskHandle() is only available if\r
- * INCLUDE_xTaskGetIdleTaskHandle is set to 1 in FreeRTOSConfig.h.\r
- *\r
- * Simply returns the handle of the idle task. It is not valid to call\r
- * xTaskGetIdleTaskHandle() before the scheduler has been started.\r
- */\r
-TaskHandle_t xTaskGetIdleTaskHandle( void ) PRIVILEGED_FUNCTION;\r
-\r
-/**\r
- * configUSE_TRACE_FACILITY must be defined as 1 in FreeRTOSConfig.h for\r
- * uxTaskGetSystemState() to be available.\r
- *\r
- * uxTaskGetSystemState() populates an TaskStatus_t structure for each task in\r
- * the system. TaskStatus_t structures contain, among other things, members\r
- * for the task handle, task name, task priority, task state, and total amount\r
- * of run time consumed by the task. See the TaskStatus_t structure\r
- * definition in this file for the full member list.\r
- *\r
- * NOTE: This function is intended for debugging use only as its use results in\r
- * the scheduler remaining suspended for an extended period.\r
- *\r
- * @param pxTaskStatusArray A pointer to an array of TaskStatus_t structures.\r
- * The array must contain at least one TaskStatus_t structure for each task\r
- * that is under the control of the RTOS. The number of tasks under the control\r
- * of the RTOS can be determined using the uxTaskGetNumberOfTasks() API function.\r
- *\r
- * @param uxArraySize The size of the array pointed to by the pxTaskStatusArray\r
- * parameter. The size is specified as the number of indexes in the array, or\r
- * the number of TaskStatus_t structures contained in the array, not by the\r
- * number of bytes in the array.\r
- *\r
- * @param pulTotalRunTime If configGENERATE_RUN_TIME_STATS is set to 1 in\r
- * FreeRTOSConfig.h then *pulTotalRunTime is set by uxTaskGetSystemState() to the\r
- * total run time (as defined by the run time stats clock, see\r
- * http://www.freertos.org/rtos-run-time-stats.html) since the target booted.\r
- * pulTotalRunTime can be set to NULL to omit the total run time information.\r
- *\r
- * @return The number of TaskStatus_t structures that were populated by\r
- * uxTaskGetSystemState(). This should equal the number returned by the\r
- * uxTaskGetNumberOfTasks() API function, but will be zero if the value passed\r
- * in the uxArraySize parameter was too small.\r
- *\r
- * Example usage:\r
- <pre>\r
- // This example demonstrates how a human readable table of run time stats\r
- // information is generated from raw data provided by uxTaskGetSystemState().\r
- // The human readable table is written to pcWriteBuffer\r
- void vTaskGetRunTimeStats( char *pcWriteBuffer )\r
- {\r
- TaskStatus_t *pxTaskStatusArray;\r
- volatile UBaseType_t uxArraySize, x;\r
- uint32_t ulTotalRunTime, ulStatsAsPercentage;\r
-\r
- // Make sure the write buffer does not contain a string.\r
- *pcWriteBuffer = 0x00;\r
-\r
- // Take a snapshot of the number of tasks in case it changes while this\r
- // function is executing.\r
- uxArraySize = uxTaskGetNumberOfTasks();\r
-\r
- // Allocate a TaskStatus_t structure for each task. An array could be\r
- // allocated statically at compile time.\r
- pxTaskStatusArray = pvPortMalloc( uxArraySize * sizeof( TaskStatus_t ) );\r
-\r
- if( pxTaskStatusArray != NULL )\r
- {\r
- // Generate raw status information about each task.\r
- uxArraySize = uxTaskGetSystemState( pxTaskStatusArray, uxArraySize, &ulTotalRunTime );\r
-\r
- // For percentage calculations.\r
- ulTotalRunTime /= 100UL;\r
-\r
- // Avoid divide by zero errors.\r
- if( ulTotalRunTime > 0 )\r
- {\r
- // For each populated position in the pxTaskStatusArray array,\r
- // format the raw data as human readable ASCII data\r
- for( x = 0; x < uxArraySize; x++ )\r
- {\r
- // What percentage of the total run time has the task used?\r
- // This will always be rounded down to the nearest integer.\r
- // ulTotalRunTimeDiv100 has already been divided by 100.\r
- ulStatsAsPercentage = pxTaskStatusArray[ x ].ulRunTimeCounter / ulTotalRunTime;\r
-\r
- if( ulStatsAsPercentage > 0UL )\r
- {\r
- sprintf( pcWriteBuffer, "%s\t\t%lu\t\t%lu%%\r\n", pxTaskStatusArray[ x ].pcTaskName, pxTaskStatusArray[ x ].ulRunTimeCounter, ulStatsAsPercentage );\r
- }\r
- else\r
- {\r
- // If the percentage is zero here then the task has\r
- // consumed less than 1% of the total run time.\r
- sprintf( pcWriteBuffer, "%s\t\t%lu\t\t<1%%\r\n", pxTaskStatusArray[ x ].pcTaskName, pxTaskStatusArray[ x ].ulRunTimeCounter );\r
- }\r
-\r
- pcWriteBuffer += strlen( ( char * ) pcWriteBuffer );\r
- }\r
- }\r
-\r
- // The array is no longer needed, free the memory it consumes.\r
- vPortFree( pxTaskStatusArray );\r
- }\r
- }\r
- </pre>\r
- */\r
-UBaseType_t uxTaskGetSystemState( TaskStatus_t * const pxTaskStatusArray, const UBaseType_t uxArraySize, uint32_t * const pulTotalRunTime ) PRIVILEGED_FUNCTION;\r
-\r
-/**\r
- * task. h\r
- * <PRE>void vTaskList( char *pcWriteBuffer );</PRE>\r
- *\r
- * configUSE_TRACE_FACILITY and configUSE_STATS_FORMATTING_FUNCTIONS must\r
- * both be defined as 1 for this function to be available. See the\r
- * configuration section of the FreeRTOS.org website for more information.\r
- *\r
- * NOTE 1: This function will disable interrupts for its duration. It is\r
- * not intended for normal application runtime use but as a debug aid.\r
- *\r
- * Lists all the current tasks, along with their current state and stack\r
- * usage high water mark.\r
- *\r
- * Tasks are reported as blocked ('B'), ready ('R'), deleted ('D') or\r
- * suspended ('S').\r
- *\r
- * PLEASE NOTE:\r
- *\r
- * This function is provided for convenience only, and is used by many of the\r
- * demo applications. Do not consider it to be part of the scheduler.\r
- *\r
- * vTaskList() calls uxTaskGetSystemState(), then formats part of the\r
- * uxTaskGetSystemState() output into a human readable table that displays task\r
- * names, states and stack usage.\r
- *\r
- * vTaskList() has a dependency on the sprintf() C library function that might\r
- * bloat the code size, use a lot of stack, and provide different results on\r
- * different platforms. An alternative, tiny, third party, and limited\r
- * functionality implementation of sprintf() is provided in many of the\r
- * FreeRTOS/Demo sub-directories in a file called printf-stdarg.c (note\r
- * printf-stdarg.c does not provide a full snprintf() implementation!).\r
- *\r
- * It is recommended that production systems call uxTaskGetSystemState()\r
- * directly to get access to raw stats data, rather than indirectly through a\r
- * call to vTaskList().\r
- *\r
- * @param pcWriteBuffer A buffer into which the above mentioned details\r
- * will be written, in ASCII form. This buffer is assumed to be large\r
- * enough to contain the generated report. Approximately 40 bytes per\r
- * task should be sufficient.\r
- *\r
- * \defgroup vTaskList vTaskList\r
- * \ingroup TaskUtils\r
- */\r
-void vTaskList( char * pcWriteBuffer ) PRIVILEGED_FUNCTION; /*lint !e971 Unqualified char types are allowed for strings and single characters only. */\r
-\r
-/**\r
- * task. h\r
- * <PRE>void vTaskGetRunTimeStats( char *pcWriteBuffer );</PRE>\r
- *\r
- * configGENERATE_RUN_TIME_STATS and configUSE_STATS_FORMATTING_FUNCTIONS\r
- * must both be defined as 1 for this function to be available. The application\r
- * must also then provide definitions for\r
- * portCONFIGURE_TIMER_FOR_RUN_TIME_STATS() and portGET_RUN_TIME_COUNTER_VALUE()\r
- * to configure a peripheral timer/counter and return the timers current count\r
- * value respectively. The counter should be at least 10 times the frequency of\r
- * the tick count.\r
- *\r
- * NOTE 1: This function will disable interrupts for its duration. It is\r
- * not intended for normal application runtime use but as a debug aid.\r
- *\r
- * Setting configGENERATE_RUN_TIME_STATS to 1 will result in a total\r
- * accumulated execution time being stored for each task. The resolution\r
- * of the accumulated time value depends on the frequency of the timer\r
- * configured by the portCONFIGURE_TIMER_FOR_RUN_TIME_STATS() macro.\r
- * Calling vTaskGetRunTimeStats() writes the total execution time of each\r
- * task into a buffer, both as an absolute count value and as a percentage\r
- * of the total system execution time.\r
- *\r
- * NOTE 2:\r
- *\r
- * This function is provided for convenience only, and is used by many of the\r
- * demo applications. Do not consider it to be part of the scheduler.\r
- *\r
- * vTaskGetRunTimeStats() calls uxTaskGetSystemState(), then formats part of the\r
- * uxTaskGetSystemState() output into a human readable table that displays the\r
- * amount of time each task has spent in the Running state in both absolute and\r
- * percentage terms.\r
- *\r
- * vTaskGetRunTimeStats() has a dependency on the sprintf() C library function\r
- * that might bloat the code size, use a lot of stack, and provide different\r
- * results on different platforms. An alternative, tiny, third party, and\r
- * limited functionality implementation of sprintf() is provided in many of the\r
- * FreeRTOS/Demo sub-directories in a file called printf-stdarg.c (note\r
- * printf-stdarg.c does not provide a full snprintf() implementation!).\r
- *\r
- * It is recommended that production systems call uxTaskGetSystemState() directly\r
- * to get access to raw stats data, rather than indirectly through a call to\r
- * vTaskGetRunTimeStats().\r
- *\r
- * @param pcWriteBuffer A buffer into which the execution times will be\r
- * written, in ASCII form. This buffer is assumed to be large enough to\r
- * contain the generated report. Approximately 40 bytes per task should\r
- * be sufficient.\r
- *\r
- * \defgroup vTaskGetRunTimeStats vTaskGetRunTimeStats\r
- * \ingroup TaskUtils\r
- */\r
-void vTaskGetRunTimeStats( char *pcWriteBuffer ) PRIVILEGED_FUNCTION; /*lint !e971 Unqualified char types are allowed for strings and single characters only. */\r
-\r
-/**\r
- * task. h\r
- * <PRE>BaseType_t xTaskNotify( TaskHandle_t xTaskToNotify, uint32_t ulValue, eNotifyAction eAction );</PRE>\r
- *\r
- * configUSE_TASK_NOTIFICATIONS must be undefined or defined as 1 for this\r
- * function to be available.\r
- *\r
- * When configUSE_TASK_NOTIFICATIONS is set to one each task has its own private\r
- * "notification value", which is a 32-bit unsigned integer (uint32_t).\r
- *\r
- * Events can be sent to a task using an intermediary object. Examples of such\r
- * objects are queues, semaphores, mutexes and event groups. Task notifications\r
- * are a method of sending an event directly to a task without the need for such\r
- * an intermediary object.\r
- *\r
- * A notification sent to a task can optionally perform an action, such as\r
- * update, overwrite or increment the task's notification value. In that way\r
- * task notifications can be used to send data to a task, or be used as light\r
- * weight and fast binary or counting semaphores.\r
- *\r
- * A notification sent to a task will remain pending until it is cleared by the\r
- * task calling xTaskNotifyWait() or ulTaskNotifyTake(). If the task was\r
- * already in the Blocked state to wait for a notification when the notification\r
- * arrives then the task will automatically be removed from the Blocked state\r
- * (unblocked) and the notification cleared.\r
- *\r
- * A task can use xTaskNotifyWait() to [optionally] block to wait for a\r
- * notification to be pending, or ulTaskNotifyTake() to [optionally] block\r
- * to wait for its notification value to have a non-zero value. The task does\r
- * not consume any CPU time while it is in the Blocked state.\r
- *\r
- * See http://www.FreeRTOS.org/RTOS-task-notifications.html for details.\r
- *\r
- * @param xTaskToNotify The handle of the task being notified. The handle to a\r
- * task can be returned from the xTaskCreate() API function used to create the\r
- * task, and the handle of the currently running task can be obtained by calling\r
- * xTaskGetCurrentTaskHandle().\r
- *\r
- * @param ulValue Data that can be sent with the notification. How the data is\r
- * used depends on the value of the eAction parameter.\r
- *\r
- * @param eAction Specifies how the notification updates the task's notification\r
- * value, if at all. Valid values for eAction are as follows:\r
- *\r
- * eSetBits -\r
- * The task's notification value is bitwise ORed with ulValue. xTaskNofify()\r
- * always returns pdPASS in this case.\r
- *\r
- * eIncrement -\r
- * The task's notification value is incremented. ulValue is not used and\r
- * xTaskNotify() always returns pdPASS in this case.\r
- *\r
- * eSetValueWithOverwrite -\r
- * The task's notification value is set to the value of ulValue, even if the\r
- * task being notified had not yet processed the previous notification (the\r
- * task already had a notification pending). xTaskNotify() always returns\r
- * pdPASS in this case.\r
- *\r
- * eSetValueWithoutOverwrite -\r
- * If the task being notified did not already have a notification pending then\r
- * the task's notification value is set to ulValue and xTaskNotify() will\r
- * return pdPASS. If the task being notified already had a notification\r
- * pending then no action is performed and pdFAIL is returned.\r
- *\r
- * eNoAction -\r
- * The task receives a notification without its notification value being\r
- * updated. ulValue is not used and xTaskNotify() always returns pdPASS in\r
- * this case.\r
- *\r
- * pulPreviousNotificationValue -\r
- * Can be used to pass out the subject task's notification value before any\r
- * bits are modified by the notify function.\r
- *\r
- * @return Dependent on the value of eAction. See the description of the\r
- * eAction parameter.\r
- *\r
- * \defgroup xTaskNotify xTaskNotify\r
- * \ingroup TaskNotifications\r
- */\r
-BaseType_t xTaskGenericNotify( TaskHandle_t xTaskToNotify, uint32_t ulValue, eNotifyAction eAction, uint32_t *pulPreviousNotificationValue ) PRIVILEGED_FUNCTION;\r
-#define xTaskNotify( xTaskToNotify, ulValue, eAction ) xTaskGenericNotify( ( xTaskToNotify ), ( ulValue ), ( eAction ), NULL )\r
-#define xTaskNotifyAndQuery( xTaskToNotify, ulValue, eAction, pulPreviousNotifyValue ) xTaskGenericNotify( ( xTaskToNotify ), ( ulValue ), ( eAction ), ( pulPreviousNotifyValue ) )\r
-\r
-/**\r
- * task. h\r
- * <PRE>BaseType_t xTaskNotifyFromISR( TaskHandle_t xTaskToNotify, uint32_t ulValue, eNotifyAction eAction, BaseType_t *pxHigherPriorityTaskWoken );</PRE>\r
- *\r
- * configUSE_TASK_NOTIFICATIONS must be undefined or defined as 1 for this\r
- * function to be available.\r
- *\r
- * When configUSE_TASK_NOTIFICATIONS is set to one each task has its own private\r
- * "notification value", which is a 32-bit unsigned integer (uint32_t).\r
- *\r
- * A version of xTaskNotify() that can be used from an interrupt service routine\r
- * (ISR).\r
- *\r
- * Events can be sent to a task using an intermediary object. Examples of such\r
- * objects are queues, semaphores, mutexes and event groups. Task notifications\r
- * are a method of sending an event directly to a task without the need for such\r
- * an intermediary object.\r
- *\r
- * A notification sent to a task can optionally perform an action, such as\r
- * update, overwrite or increment the task's notification value. In that way\r
- * task notifications can be used to send data to a task, or be used as light\r
- * weight and fast binary or counting semaphores.\r
- *\r
- * A notification sent to a task will remain pending until it is cleared by the\r
- * task calling xTaskNotifyWait() or ulTaskNotifyTake(). If the task was\r
- * already in the Blocked state to wait for a notification when the notification\r
- * arrives then the task will automatically be removed from the Blocked state\r
- * (unblocked) and the notification cleared.\r
- *\r
- * A task can use xTaskNotifyWait() to [optionally] block to wait for a\r
- * notification to be pending, or ulTaskNotifyTake() to [optionally] block\r
- * to wait for its notification value to have a non-zero value. The task does\r
- * not consume any CPU time while it is in the Blocked state.\r
- *\r
- * See http://www.FreeRTOS.org/RTOS-task-notifications.html for details.\r
- *\r
- * @param xTaskToNotify The handle of the task being notified. The handle to a\r
- * task can be returned from the xTaskCreate() API function used to create the\r
- * task, and the handle of the currently running task can be obtained by calling\r
- * xTaskGetCurrentTaskHandle().\r
- *\r
- * @param ulValue Data that can be sent with the notification. How the data is\r
- * used depends on the value of the eAction parameter.\r
- *\r
- * @param eAction Specifies how the notification updates the task's notification\r
- * value, if at all. Valid values for eAction are as follows:\r
- *\r
- * eSetBits -\r
- * The task's notification value is bitwise ORed with ulValue. xTaskNofify()\r
- * always returns pdPASS in this case.\r
- *\r
- * eIncrement -\r
- * The task's notification value is incremented. ulValue is not used and\r
- * xTaskNotify() always returns pdPASS in this case.\r
- *\r
- * eSetValueWithOverwrite -\r
- * The task's notification value is set to the value of ulValue, even if the\r
- * task being notified had not yet processed the previous notification (the\r
- * task already had a notification pending). xTaskNotify() always returns\r
- * pdPASS in this case.\r
- *\r
- * eSetValueWithoutOverwrite -\r
- * If the task being notified did not already have a notification pending then\r
- * the task's notification value is set to ulValue and xTaskNotify() will\r
- * return pdPASS. If the task being notified already had a notification\r
- * pending then no action is performed and pdFAIL is returned.\r
- *\r
- * eNoAction -\r
- * The task receives a notification without its notification value being\r
- * updated. ulValue is not used and xTaskNotify() always returns pdPASS in\r
- * this case.\r
- *\r
- * @param pxHigherPriorityTaskWoken xTaskNotifyFromISR() will set\r
- * *pxHigherPriorityTaskWoken to pdTRUE if sending the notification caused the\r
- * task to which the notification was sent to leave the Blocked state, and the\r
- * unblocked task has a priority higher than the currently running task. If\r
- * xTaskNotifyFromISR() sets this value to pdTRUE then a context switch should\r
- * be requested before the interrupt is exited. How a context switch is\r
- * requested from an ISR is dependent on the port - see the documentation page\r
- * for the port in use.\r
- *\r
- * @return Dependent on the value of eAction. See the description of the\r
- * eAction parameter.\r
- *\r
- * \defgroup xTaskNotify xTaskNotify\r
- * \ingroup TaskNotifications\r
- */\r
-BaseType_t xTaskGenericNotifyFromISR( TaskHandle_t xTaskToNotify, uint32_t ulValue, eNotifyAction eAction, uint32_t *pulPreviousNotificationValue, BaseType_t *pxHigherPriorityTaskWoken ) PRIVILEGED_FUNCTION;\r
-#define xTaskNotifyFromISR( xTaskToNotify, ulValue, eAction, pxHigherPriorityTaskWoken ) xTaskGenericNotifyFromISR( ( xTaskToNotify ), ( ulValue ), ( eAction ), NULL, ( pxHigherPriorityTaskWoken ) )\r
-#define xTaskNotifyAndQueryFromISR( xTaskToNotify, ulValue, eAction, pulPreviousNotificationValue, pxHigherPriorityTaskWoken ) xTaskGenericNotifyFromISR( ( xTaskToNotify ), ( ulValue ), ( eAction ), ( pulPreviousNotificationValue ), ( pxHigherPriorityTaskWoken ) )\r
-\r
-/**\r
- * task. h\r
- * <PRE>BaseType_t xTaskNotifyWait( uint32_t ulBitsToClearOnEntry, uint32_t ulBitsToClearOnExit, uint32_t *pulNotificationValue, TickType_t xTicksToWait );</pre>\r
- *\r
- * configUSE_TASK_NOTIFICATIONS must be undefined or defined as 1 for this\r
- * function to be available.\r
- *\r
- * When configUSE_TASK_NOTIFICATIONS is set to one each task has its own private\r
- * "notification value", which is a 32-bit unsigned integer (uint32_t).\r
- *\r
- * Events can be sent to a task using an intermediary object. Examples of such\r
- * objects are queues, semaphores, mutexes and event groups. Task notifications\r
- * are a method of sending an event directly to a task without the need for such\r
- * an intermediary object.\r
- *\r
- * A notification sent to a task can optionally perform an action, such as\r
- * update, overwrite or increment the task's notification value. In that way\r
- * task notifications can be used to send data to a task, or be used as light\r
- * weight and fast binary or counting semaphores.\r
- *\r
- * A notification sent to a task will remain pending until it is cleared by the\r
- * task calling xTaskNotifyWait() or ulTaskNotifyTake(). If the task was\r
- * already in the Blocked state to wait for a notification when the notification\r
- * arrives then the task will automatically be removed from the Blocked state\r
- * (unblocked) and the notification cleared.\r
- *\r
- * A task can use xTaskNotifyWait() to [optionally] block to wait for a\r
- * notification to be pending, or ulTaskNotifyTake() to [optionally] block\r
- * to wait for its notification value to have a non-zero value. The task does\r
- * not consume any CPU time while it is in the Blocked state.\r
- *\r
- * See http://www.FreeRTOS.org/RTOS-task-notifications.html for details.\r
- *\r
- * @param ulBitsToClearOnEntry Bits that are set in ulBitsToClearOnEntry value\r
- * will be cleared in the calling task's notification value before the task\r
- * checks to see if any notifications are pending, and optionally blocks if no\r
- * notifications are pending. Setting ulBitsToClearOnEntry to ULONG_MAX (if\r
- * limits.h is included) or 0xffffffffUL (if limits.h is not included) will have\r
- * the effect of resetting the task's notification value to 0. Setting\r
- * ulBitsToClearOnEntry to 0 will leave the task's notification value unchanged.\r
- *\r
- * @param ulBitsToClearOnExit If a notification is pending or received before\r
- * the calling task exits the xTaskNotifyWait() function then the task's\r
- * notification value (see the xTaskNotify() API function) is passed out using\r
- * the pulNotificationValue parameter. Then any bits that are set in\r
- * ulBitsToClearOnExit will be cleared in the task's notification value (note\r
- * *pulNotificationValue is set before any bits are cleared). Setting\r
- * ulBitsToClearOnExit to ULONG_MAX (if limits.h is included) or 0xffffffffUL\r
- * (if limits.h is not included) will have the effect of resetting the task's\r
- * notification value to 0 before the function exits. Setting\r
- * ulBitsToClearOnExit to 0 will leave the task's notification value unchanged\r
- * when the function exits (in which case the value passed out in\r
- * pulNotificationValue will match the task's notification value).\r
- *\r
- * @param pulNotificationValue Used to pass the task's notification value out\r
- * of the function. Note the value passed out will not be effected by the\r
- * clearing of any bits caused by ulBitsToClearOnExit being non-zero.\r
- *\r
- * @param xTicksToWait The maximum amount of time that the task should wait in\r
- * the Blocked state for a notification to be received, should a notification\r
- * not already be pending when xTaskNotifyWait() was called. The task\r
- * will not consume any processing time while it is in the Blocked state. This\r
- * is specified in kernel ticks, the macro pdMS_TO_TICSK( value_in_ms ) can be\r
- * used to convert a time specified in milliseconds to a time specified in\r
- * ticks.\r
- *\r
- * @return If a notification was received (including notifications that were\r
- * already pending when xTaskNotifyWait was called) then pdPASS is\r
- * returned. Otherwise pdFAIL is returned.\r
- *\r
- * \defgroup xTaskNotifyWait xTaskNotifyWait\r
- * \ingroup TaskNotifications\r
- */\r
-BaseType_t xTaskNotifyWait( uint32_t ulBitsToClearOnEntry, uint32_t ulBitsToClearOnExit, uint32_t *pulNotificationValue, TickType_t xTicksToWait ) PRIVILEGED_FUNCTION;\r
-\r
-/**\r
- * task. h\r
- * <PRE>BaseType_t xTaskNotifyGive( TaskHandle_t xTaskToNotify );</PRE>\r
- *\r
- * configUSE_TASK_NOTIFICATIONS must be undefined or defined as 1 for this macro\r
- * to be available.\r
- *\r
- * When configUSE_TASK_NOTIFICATIONS is set to one each task has its own private\r
- * "notification value", which is a 32-bit unsigned integer (uint32_t).\r
- *\r
- * Events can be sent to a task using an intermediary object. Examples of such\r
- * objects are queues, semaphores, mutexes and event groups. Task notifications\r
- * are a method of sending an event directly to a task without the need for such\r
- * an intermediary object.\r
- *\r
- * A notification sent to a task can optionally perform an action, such as\r
- * update, overwrite or increment the task's notification value. In that way\r
- * task notifications can be used to send data to a task, or be used as light\r
- * weight and fast binary or counting semaphores.\r
- *\r
- * xTaskNotifyGive() is a helper macro intended for use when task notifications\r
- * are used as light weight and faster binary or counting semaphore equivalents.\r
- * Actual FreeRTOS semaphores are given using the xSemaphoreGive() API function,\r
- * the equivalent action that instead uses a task notification is\r
- * xTaskNotifyGive().\r
- *\r
- * When task notifications are being used as a binary or counting semaphore\r
- * equivalent then the task being notified should wait for the notification\r
- * using the ulTaskNotificationTake() API function rather than the\r
- * xTaskNotifyWait() API function.\r
- *\r
- * See http://www.FreeRTOS.org/RTOS-task-notifications.html for more details.\r
- *\r
- * @param xTaskToNotify The handle of the task being notified. The handle to a\r
- * task can be returned from the xTaskCreate() API function used to create the\r
- * task, and the handle of the currently running task can be obtained by calling\r
- * xTaskGetCurrentTaskHandle().\r
- *\r
- * @return xTaskNotifyGive() is a macro that calls xTaskNotify() with the\r
- * eAction parameter set to eIncrement - so pdPASS is always returned.\r
- *\r
- * \defgroup xTaskNotifyGive xTaskNotifyGive\r
- * \ingroup TaskNotifications\r
- */\r
-#define xTaskNotifyGive( xTaskToNotify ) xTaskGenericNotify( ( xTaskToNotify ), ( 0 ), eIncrement, NULL )\r
-\r
-/**\r
- * task. h\r
- * <PRE>void vTaskNotifyGiveFromISR( TaskHandle_t xTaskHandle, BaseType_t *pxHigherPriorityTaskWoken );\r
- *\r
- * configUSE_TASK_NOTIFICATIONS must be undefined or defined as 1 for this macro\r
- * to be available.\r
- *\r
- * When configUSE_TASK_NOTIFICATIONS is set to one each task has its own private\r
- * "notification value", which is a 32-bit unsigned integer (uint32_t).\r
- *\r
- * A version of xTaskNotifyGive() that can be called from an interrupt service\r
- * routine (ISR).\r
- *\r
- * Events can be sent to a task using an intermediary object. Examples of such\r
- * objects are queues, semaphores, mutexes and event groups. Task notifications\r
- * are a method of sending an event directly to a task without the need for such\r
- * an intermediary object.\r
- *\r
- * A notification sent to a task can optionally perform an action, such as\r
- * update, overwrite or increment the task's notification value. In that way\r
- * task notifications can be used to send data to a task, or be used as light\r
- * weight and fast binary or counting semaphores.\r
- *\r
- * vTaskNotifyGiveFromISR() is intended for use when task notifications are\r
- * used as light weight and faster binary or counting semaphore equivalents.\r
- * Actual FreeRTOS semaphores are given from an ISR using the\r
- * xSemaphoreGiveFromISR() API function, the equivalent action that instead uses\r
- * a task notification is vTaskNotifyGiveFromISR().\r
- *\r
- * When task notifications are being used as a binary or counting semaphore\r
- * equivalent then the task being notified should wait for the notification\r
- * using the ulTaskNotificationTake() API function rather than the\r
- * xTaskNotifyWait() API function.\r
- *\r
- * See http://www.FreeRTOS.org/RTOS-task-notifications.html for more details.\r
- *\r
- * @param xTaskToNotify The handle of the task being notified. The handle to a\r
- * task can be returned from the xTaskCreate() API function used to create the\r
- * task, and the handle of the currently running task can be obtained by calling\r
- * xTaskGetCurrentTaskHandle().\r
- *\r
- * @param pxHigherPriorityTaskWoken vTaskNotifyGiveFromISR() will set\r
- * *pxHigherPriorityTaskWoken to pdTRUE if sending the notification caused the\r
- * task to which the notification was sent to leave the Blocked state, and the\r
- * unblocked task has a priority higher than the currently running task. If\r
- * vTaskNotifyGiveFromISR() sets this value to pdTRUE then a context switch\r
- * should be requested before the interrupt is exited. How a context switch is\r
- * requested from an ISR is dependent on the port - see the documentation page\r
- * for the port in use.\r
- *\r
- * \defgroup xTaskNotifyWait xTaskNotifyWait\r
- * \ingroup TaskNotifications\r
- */\r
-void vTaskNotifyGiveFromISR( TaskHandle_t xTaskToNotify, BaseType_t *pxHigherPriorityTaskWoken ) PRIVILEGED_FUNCTION;\r
-\r
-/**\r
- * task. h\r
- * <PRE>uint32_t ulTaskNotifyTake( BaseType_t xClearCountOnExit, TickType_t xTicksToWait );</pre>\r
- *\r
- * configUSE_TASK_NOTIFICATIONS must be undefined or defined as 1 for this\r
- * function to be available.\r
- *\r
- * When configUSE_TASK_NOTIFICATIONS is set to one each task has its own private\r
- * "notification value", which is a 32-bit unsigned integer (uint32_t).\r
- *\r
- * Events can be sent to a task using an intermediary object. Examples of such\r
- * objects are queues, semaphores, mutexes and event groups. Task notifications\r
- * are a method of sending an event directly to a task without the need for such\r
- * an intermediary object.\r
- *\r
- * A notification sent to a task can optionally perform an action, such as\r
- * update, overwrite or increment the task's notification value. In that way\r
- * task notifications can be used to send data to a task, or be used as light\r
- * weight and fast binary or counting semaphores.\r
- *\r
- * ulTaskNotifyTake() is intended for use when a task notification is used as a\r
- * faster and lighter weight binary or counting semaphore alternative. Actual\r
- * FreeRTOS semaphores are taken using the xSemaphoreTake() API function, the\r
- * equivalent action that instead uses a task notification is\r
- * ulTaskNotifyTake().\r
- *\r
- * When a task is using its notification value as a binary or counting semaphore\r
- * other tasks should send notifications to it using the xTaskNotifyGive()\r
- * macro, or xTaskNotify() function with the eAction parameter set to\r
- * eIncrement.\r
- *\r
- * ulTaskNotifyTake() can either clear the task's notification value to\r
- * zero on exit, in which case the notification value acts like a binary\r
- * semaphore, or decrement the task's notification value on exit, in which case\r
- * the notification value acts like a counting semaphore.\r
- *\r
- * A task can use ulTaskNotifyTake() to [optionally] block to wait for a\r
- * the task's notification value to be non-zero. The task does not consume any\r
- * CPU time while it is in the Blocked state.\r
- *\r
- * Where as xTaskNotifyWait() will return when a notification is pending,\r
- * ulTaskNotifyTake() will return when the task's notification value is\r
- * not zero.\r
- *\r
- * See http://www.FreeRTOS.org/RTOS-task-notifications.html for details.\r
- *\r
- * @param xClearCountOnExit if xClearCountOnExit is pdFALSE then the task's\r
- * notification value is decremented when the function exits. In this way the\r
- * notification value acts like a counting semaphore. If xClearCountOnExit is\r
- * not pdFALSE then the task's notification value is cleared to zero when the\r
- * function exits. In this way the notification value acts like a binary\r
- * semaphore.\r
- *\r
- * @param xTicksToWait The maximum amount of time that the task should wait in\r
- * the Blocked state for the task's notification value to be greater than zero,\r
- * should the count not already be greater than zero when\r
- * ulTaskNotifyTake() was called. The task will not consume any processing\r
- * time while it is in the Blocked state. This is specified in kernel ticks,\r
- * the macro pdMS_TO_TICSK( value_in_ms ) can be used to convert a time\r
- * specified in milliseconds to a time specified in ticks.\r
- *\r
- * @return The task's notification count before it is either cleared to zero or\r
- * decremented (see the xClearCountOnExit parameter).\r
- *\r
- * \defgroup ulTaskNotifyTake ulTaskNotifyTake\r
- * \ingroup TaskNotifications\r
- */\r
-uint32_t ulTaskNotifyTake( BaseType_t xClearCountOnExit, TickType_t xTicksToWait ) PRIVILEGED_FUNCTION;\r
-\r
-/**\r
- * task. h\r
- * <PRE>BaseType_t xTaskNotifyStateClear( TaskHandle_t xTask );</pre>\r
- *\r
- * If the notification state of the task referenced by the handle xTask is\r
- * eNotified, then set the task's notification state to eNotWaitingNotification.\r
- * The task's notification value is not altered. Set xTask to NULL to clear the\r
- * notification state of the calling task.\r
- *\r
- * @return pdTRUE if the task's notification state was set to\r
- * eNotWaitingNotification, otherwise pdFALSE.\r
- * \defgroup xTaskNotifyStateClear xTaskNotifyStateClear\r
- * \ingroup TaskNotifications\r
- */\r
-BaseType_t xTaskNotifyStateClear( TaskHandle_t xTask );\r
-\r
-/*-----------------------------------------------------------\r
- * SCHEDULER INTERNALS AVAILABLE FOR PORTING PURPOSES\r
- *----------------------------------------------------------*/\r
-\r
-/*\r
- * THIS FUNCTION MUST NOT BE USED FROM APPLICATION CODE. IT IS ONLY\r
- * INTENDED FOR USE WHEN IMPLEMENTING A PORT OF THE SCHEDULER AND IS\r
- * AN INTERFACE WHICH IS FOR THE EXCLUSIVE USE OF THE SCHEDULER.\r
- *\r
- * Called from the real time kernel tick (either preemptive or cooperative),\r
- * this increments the tick count and checks if any tasks that are blocked\r
- * for a finite period required removing from a blocked list and placing on\r
- * a ready list. If a non-zero value is returned then a context switch is\r
- * required because either:\r
- * + A task was removed from a blocked list because its timeout had expired,\r
- * or\r
- * + Time slicing is in use and there is a task of equal priority to the\r
- * currently running task.\r
- */\r
-BaseType_t xTaskIncrementTick( void ) PRIVILEGED_FUNCTION;\r
-\r
-/*\r
- * THIS FUNCTION MUST NOT BE USED FROM APPLICATION CODE. IT IS AN\r
- * INTERFACE WHICH IS FOR THE EXCLUSIVE USE OF THE SCHEDULER.\r
- *\r
- * THIS FUNCTION MUST BE CALLED WITH INTERRUPTS DISABLED.\r
- *\r
- * Removes the calling task from the ready list and places it both\r
- * on the list of tasks waiting for a particular event, and the\r
- * list of delayed tasks. The task will be removed from both lists\r
- * and replaced on the ready list should either the event occur (and\r
- * there be no higher priority tasks waiting on the same event) or\r
- * the delay period expires.\r
- *\r
- * The 'unordered' version replaces the event list item value with the\r
- * xItemValue value, and inserts the list item at the end of the list.\r
- *\r
- * The 'ordered' version uses the existing event list item value (which is the\r
- * owning tasks priority) to insert the list item into the event list is task\r
- * priority order.\r
- *\r
- * @param pxEventList The list containing tasks that are blocked waiting\r
- * for the event to occur.\r
- *\r
- * @param xItemValue The item value to use for the event list item when the\r
- * event list is not ordered by task priority.\r
- *\r
- * @param xTicksToWait The maximum amount of time that the task should wait\r
- * for the event to occur. This is specified in kernel ticks,the constant\r
- * portTICK_PERIOD_MS can be used to convert kernel ticks into a real time\r
- * period.\r
- */\r
-void vTaskPlaceOnEventList( List_t * const pxEventList, const TickType_t xTicksToWait ) PRIVILEGED_FUNCTION;\r
-void vTaskPlaceOnUnorderedEventList( List_t * pxEventList, const TickType_t xItemValue, const TickType_t xTicksToWait ) PRIVILEGED_FUNCTION;\r
-\r
-/*\r
- * THIS FUNCTION MUST NOT BE USED FROM APPLICATION CODE. IT IS AN\r
- * INTERFACE WHICH IS FOR THE EXCLUSIVE USE OF THE SCHEDULER.\r
- *\r
- * THIS FUNCTION MUST BE CALLED WITH INTERRUPTS DISABLED.\r
- *\r
- * This function performs nearly the same function as vTaskPlaceOnEventList().\r
- * The difference being that this function does not permit tasks to block\r
- * indefinitely, whereas vTaskPlaceOnEventList() does.\r
- *\r
- */\r
-void vTaskPlaceOnEventListRestricted( List_t * const pxEventList, TickType_t xTicksToWait, const BaseType_t xWaitIndefinitely ) PRIVILEGED_FUNCTION;\r
-\r
-/*\r
- * THIS FUNCTION MUST NOT BE USED FROM APPLICATION CODE. IT IS AN\r
- * INTERFACE WHICH IS FOR THE EXCLUSIVE USE OF THE SCHEDULER.\r
- *\r
- * THIS FUNCTION MUST BE CALLED WITH INTERRUPTS DISABLED.\r
- *\r
- * Removes a task from both the specified event list and the list of blocked\r
- * tasks, and places it on a ready queue.\r
- *\r
- * xTaskRemoveFromEventList()/vTaskRemoveFromUnorderedEventList() will be called\r
- * if either an event occurs to unblock a task, or the block timeout period\r
- * expires.\r
- *\r
- * xTaskRemoveFromEventList() is used when the event list is in task priority\r
- * order. It removes the list item from the head of the event list as that will\r
- * have the highest priority owning task of all the tasks on the event list.\r
- * vTaskRemoveFromUnorderedEventList() is used when the event list is not\r
- * ordered and the event list items hold something other than the owning tasks\r
- * priority. In this case the event list item value is updated to the value\r
- * passed in the xItemValue parameter.\r
- *\r
- * @return pdTRUE if the task being removed has a higher priority than the task\r
- * making the call, otherwise pdFALSE.\r
- */\r
-BaseType_t xTaskRemoveFromEventList( const List_t * const pxEventList ) PRIVILEGED_FUNCTION;\r
-void vTaskRemoveFromUnorderedEventList( ListItem_t * pxEventListItem, const TickType_t xItemValue ) PRIVILEGED_FUNCTION;\r
-\r
-/*\r
- * THIS FUNCTION MUST NOT BE USED FROM APPLICATION CODE. IT IS ONLY\r
- * INTENDED FOR USE WHEN IMPLEMENTING A PORT OF THE SCHEDULER AND IS\r
- * AN INTERFACE WHICH IS FOR THE EXCLUSIVE USE OF THE SCHEDULER.\r
- *\r
- * Sets the pointer to the current TCB to the TCB of the highest priority task\r
- * that is ready to run.\r
- */\r
-void vTaskSwitchContext( void ) PRIVILEGED_FUNCTION;\r
-\r
-/*\r
- * THESE FUNCTIONS MUST NOT BE USED FROM APPLICATION CODE. THEY ARE USED BY\r
- * THE EVENT BITS MODULE.\r
- */\r
-TickType_t uxTaskResetEventItemValue( void ) PRIVILEGED_FUNCTION;\r
-\r
-/*\r
- * Return the handle of the calling task.\r
- */\r
-TaskHandle_t xTaskGetCurrentTaskHandle( void ) PRIVILEGED_FUNCTION;\r
-\r
-/*\r
- * Capture the current time status for future reference.\r
- */\r
-void vTaskSetTimeOutState( TimeOut_t * const pxTimeOut ) PRIVILEGED_FUNCTION;\r
-\r
-/*\r
- * Compare the time status now with that previously captured to see if the\r
- * timeout has expired.\r
- */\r
-BaseType_t xTaskCheckForTimeOut( TimeOut_t * const pxTimeOut, TickType_t * const pxTicksToWait ) PRIVILEGED_FUNCTION;\r
-\r
-/*\r
- * Shortcut used by the queue implementation to prevent unnecessary call to\r
- * taskYIELD();\r
- */\r
-void vTaskMissedYield( void ) PRIVILEGED_FUNCTION;\r
-\r
-/*\r
- * Returns the scheduler state as taskSCHEDULER_RUNNING,\r
- * taskSCHEDULER_NOT_STARTED or taskSCHEDULER_SUSPENDED.\r
- */\r
-BaseType_t xTaskGetSchedulerState( void ) PRIVILEGED_FUNCTION;\r
-\r
-/*\r
- * Raises the priority of the mutex holder to that of the calling task should\r
- * the mutex holder have a priority less than the calling task.\r
- */\r
-BaseType_t xTaskPriorityInherit( TaskHandle_t const pxMutexHolder ) PRIVILEGED_FUNCTION;\r
-\r
-/*\r
- * Set the priority of a task back to its proper priority in the case that it\r
- * inherited a higher priority while it was holding a semaphore.\r
- */\r
-BaseType_t xTaskPriorityDisinherit( TaskHandle_t const pxMutexHolder ) PRIVILEGED_FUNCTION;\r
-\r
-/*\r
- * If a higher priority task attempting to obtain a mutex caused a lower\r
- * priority task to inherit the higher priority task's priority - but the higher\r
- * priority task then timed out without obtaining the mutex, then the lower\r
- * priority task will disinherit the priority again - but only down as far as\r
- * the highest priority task that is still waiting for the mutex (if there were\r
- * more than one task waiting for the mutex).\r
- */\r
-void vTaskPriorityDisinheritAfterTimeout( TaskHandle_t const pxMutexHolder, UBaseType_t uxHighestPriorityWaitingTask ) PRIVILEGED_FUNCTION;\r
-\r
-/*\r
- * Get the uxTCBNumber assigned to the task referenced by the xTask parameter.\r
- */\r
-UBaseType_t uxTaskGetTaskNumber( TaskHandle_t xTask ) PRIVILEGED_FUNCTION;\r
-\r
-/*\r
- * Set the uxTaskNumber of the task referenced by the xTask parameter to\r
- * uxHandle.\r
- */\r
-void vTaskSetTaskNumber( TaskHandle_t xTask, const UBaseType_t uxHandle ) PRIVILEGED_FUNCTION;\r
-\r
-/*\r
- * Only available when configUSE_TICKLESS_IDLE is set to 1.\r
- * If tickless mode is being used, or a low power mode is implemented, then\r
- * the tick interrupt will not execute during idle periods. When this is the\r
- * case, the tick count value maintained by the scheduler needs to be kept up\r
- * to date with the actual execution time by being skipped forward by a time\r
- * equal to the idle period.\r
- */\r
-void vTaskStepTick( const TickType_t xTicksToJump ) PRIVILEGED_FUNCTION;\r
-\r
-/*\r
- * Only avilable when configUSE_TICKLESS_IDLE is set to 1.\r
- * Provided for use within portSUPPRESS_TICKS_AND_SLEEP() to allow the port\r
- * specific sleep function to determine if it is ok to proceed with the sleep,\r
- * and if it is ok to proceed, if it is ok to sleep indefinitely.\r
- *\r
- * This function is necessary because portSUPPRESS_TICKS_AND_SLEEP() is only\r
- * called with the scheduler suspended, not from within a critical section. It\r
- * is therefore possible for an interrupt to request a context switch between\r
- * portSUPPRESS_TICKS_AND_SLEEP() and the low power mode actually being\r
- * entered. eTaskConfirmSleepModeStatus() should be called from a short\r
- * critical section between the timer being stopped and the sleep mode being\r
- * entered to ensure it is ok to proceed into the sleep mode.\r
- */\r
-eSleepModeStatus eTaskConfirmSleepModeStatus( void ) PRIVILEGED_FUNCTION;\r
-\r
-/*\r
- * For internal use only. Increment the mutex held count when a mutex is\r
- * taken and return the handle of the task that has taken the mutex.\r
- */\r
-void *pvTaskIncrementMutexHeldCount( void ) PRIVILEGED_FUNCTION;\r
-\r
-/*\r
- * For internal use only. Same as vTaskSetTimeOutState(), but without a critial\r
- * section.\r
- */\r
-void vTaskInternalSetTimeOutState( TimeOut_t * const pxTimeOut ) PRIVILEGED_FUNCTION;\r
-\r
-\r
-#ifdef __cplusplus\r
-}\r
-#endif\r
-#endif /* INC_TASK_H */\r
-\r
-\r
-\r
+++ /dev/null
-/*\r
- * FreeRTOS Kernel V10.0.1\r
- * Copyright (C) 2017 Amazon.com, Inc. or its affiliates. All Rights Reserved.\r
- *\r
- * Permission is hereby granted, free of charge, to any person obtaining a copy of\r
- * this software and associated documentation files (the "Software"), to deal in\r
- * the Software without restriction, including without limitation the rights to\r
- * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of\r
- * the Software, and to permit persons to whom the Software is furnished to do so,\r
- * subject to the following conditions:\r
- *\r
- * The above copyright notice and this permission notice shall be included in all\r
- * copies or substantial portions of the Software.\r
- *\r
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\r
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS\r
- * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR\r
- * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER\r
- * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN\r
- * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\r
- *\r
- * http://www.FreeRTOS.org\r
- * http://aws.amazon.com/freertos\r
- *\r
- * 1 tab == 4 spaces!\r
- */\r
-\r
-\r
-#ifndef TIMERS_H\r
-#define TIMERS_H\r
-\r
-#ifndef INC_FREERTOS_H\r
- #error "include FreeRTOS.h must appear in source files before include timers.h"\r
-#endif\r
-\r
-/*lint -save -e537 This headers are only multiply included if the application code\r
-happens to also be including task.h. */\r
-#include "task.h"\r
-/*lint -restore */\r
-\r
-#ifdef __cplusplus\r
-extern "C" {\r
-#endif\r
-\r
-/*-----------------------------------------------------------\r
- * MACROS AND DEFINITIONS\r
- *----------------------------------------------------------*/\r
-\r
-/* IDs for commands that can be sent/received on the timer queue. These are to\r
-be used solely through the macros that make up the public software timer API,\r
-as defined below. The commands that are sent from interrupts must use the\r
-highest numbers as tmrFIRST_FROM_ISR_COMMAND is used to determine if the task\r
-or interrupt version of the queue send function should be used. */\r
-#define tmrCOMMAND_EXECUTE_CALLBACK_FROM_ISR ( ( BaseType_t ) -2 )\r
-#define tmrCOMMAND_EXECUTE_CALLBACK ( ( BaseType_t ) -1 )\r
-#define tmrCOMMAND_START_DONT_TRACE ( ( BaseType_t ) 0 )\r
-#define tmrCOMMAND_START ( ( BaseType_t ) 1 )\r
-#define tmrCOMMAND_RESET ( ( BaseType_t ) 2 )\r
-#define tmrCOMMAND_STOP ( ( BaseType_t ) 3 )\r
-#define tmrCOMMAND_CHANGE_PERIOD ( ( BaseType_t ) 4 )\r
-#define tmrCOMMAND_DELETE ( ( BaseType_t ) 5 )\r
-\r
-#define tmrFIRST_FROM_ISR_COMMAND ( ( BaseType_t ) 6 )\r
-#define tmrCOMMAND_START_FROM_ISR ( ( BaseType_t ) 6 )\r
-#define tmrCOMMAND_RESET_FROM_ISR ( ( BaseType_t ) 7 )\r
-#define tmrCOMMAND_STOP_FROM_ISR ( ( BaseType_t ) 8 )\r
-#define tmrCOMMAND_CHANGE_PERIOD_FROM_ISR ( ( BaseType_t ) 9 )\r
-\r
-\r
-/**\r
- * Type by which software timers are referenced. For example, a call to\r
- * xTimerCreate() returns an TimerHandle_t variable that can then be used to\r
- * reference the subject timer in calls to other software timer API functions\r
- * (for example, xTimerStart(), xTimerReset(), etc.).\r
- */\r
-typedef void * TimerHandle_t;\r
-\r
-/*\r
- * Defines the prototype to which timer callback functions must conform.\r
- */\r
-typedef void (*TimerCallbackFunction_t)( TimerHandle_t xTimer );\r
-\r
-/*\r
- * Defines the prototype to which functions used with the\r
- * xTimerPendFunctionCallFromISR() function must conform.\r
- */\r
-typedef void (*PendedFunction_t)( void *, uint32_t );\r
-\r
-/**\r
- * TimerHandle_t xTimerCreate( const char * const pcTimerName,\r
- * TickType_t xTimerPeriodInTicks,\r
- * UBaseType_t uxAutoReload,\r
- * void * pvTimerID,\r
- * TimerCallbackFunction_t pxCallbackFunction );\r
- *\r
- * Creates a new software timer instance, and returns a handle by which the\r
- * created software timer can be referenced.\r
- *\r
- * Internally, within the FreeRTOS implementation, software timers use a block\r
- * of memory, in which the timer data structure is stored. If a software timer\r
- * is created using xTimerCreate() then the required memory is automatically\r
- * dynamically allocated inside the xTimerCreate() function. (see\r
- * http://www.freertos.org/a00111.html). If a software timer is created using\r
- * xTimerCreateStatic() then the application writer must provide the memory that\r
- * will get used by the software timer. xTimerCreateStatic() therefore allows a\r
- * software timer to be created without using any dynamic memory allocation.\r
- *\r
- * Timers are created in the dormant state. The xTimerStart(), xTimerReset(),\r
- * xTimerStartFromISR(), xTimerResetFromISR(), xTimerChangePeriod() and\r
- * xTimerChangePeriodFromISR() API functions can all be used to transition a\r
- * timer into the active state.\r
- *\r
- * @param pcTimerName A text name that is assigned to the timer. This is done\r
- * purely to assist debugging. The kernel itself only ever references a timer\r
- * by its handle, and never by its name.\r
- *\r
- * @param xTimerPeriodInTicks The timer period. The time is defined in tick\r
- * periods so the constant portTICK_PERIOD_MS can be used to convert a time that\r
- * has been specified in milliseconds. For example, if the timer must expire\r
- * after 100 ticks, then xTimerPeriodInTicks should be set to 100.\r
- * Alternatively, if the timer must expire after 500ms, then xPeriod can be set\r
- * to ( 500 / portTICK_PERIOD_MS ) provided configTICK_RATE_HZ is less than or\r
- * equal to 1000.\r
- *\r
- * @param uxAutoReload If uxAutoReload is set to pdTRUE then the timer will\r
- * expire repeatedly with a frequency set by the xTimerPeriodInTicks parameter.\r
- * If uxAutoReload is set to pdFALSE then the timer will be a one-shot timer and\r
- * enter the dormant state after it expires.\r
- *\r
- * @param pvTimerID An identifier that is assigned to the timer being created.\r
- * Typically this would be used in the timer callback function to identify which\r
- * timer expired when the same callback function is assigned to more than one\r
- * timer.\r
- *\r
- * @param pxCallbackFunction The function to call when the timer expires.\r
- * Callback functions must have the prototype defined by TimerCallbackFunction_t,\r
- * which is "void vCallbackFunction( TimerHandle_t xTimer );".\r
- *\r
- * @return If the timer is successfully created then a handle to the newly\r
- * created timer is returned. If the timer cannot be created (because either\r
- * there is insufficient FreeRTOS heap remaining to allocate the timer\r
- * structures, or the timer period was set to 0) then NULL is returned.\r
- *\r
- * Example usage:\r
- * @verbatim\r
- * #define NUM_TIMERS 5\r
- *\r
- * // An array to hold handles to the created timers.\r
- * TimerHandle_t xTimers[ NUM_TIMERS ];\r
- *\r
- * // An array to hold a count of the number of times each timer expires.\r
- * int32_t lExpireCounters[ NUM_TIMERS ] = { 0 };\r
- *\r
- * // Define a callback function that will be used by multiple timer instances.\r
- * // The callback function does nothing but count the number of times the\r
- * // associated timer expires, and stop the timer once the timer has expired\r
- * // 10 times.\r
- * void vTimerCallback( TimerHandle_t pxTimer )\r
- * {\r
- * int32_t lArrayIndex;\r
- * const int32_t xMaxExpiryCountBeforeStopping = 10;\r
- *\r
- * // Optionally do something if the pxTimer parameter is NULL.\r
- * configASSERT( pxTimer );\r
- *\r
- * // Which timer expired?\r
- * lArrayIndex = ( int32_t ) pvTimerGetTimerID( pxTimer );\r
- *\r
- * // Increment the number of times that pxTimer has expired.\r
- * lExpireCounters[ lArrayIndex ] += 1;\r
- *\r
- * // If the timer has expired 10 times then stop it from running.\r
- * if( lExpireCounters[ lArrayIndex ] == xMaxExpiryCountBeforeStopping )\r
- * {\r
- * // Do not use a block time if calling a timer API function from a\r
- * // timer callback function, as doing so could cause a deadlock!\r
- * xTimerStop( pxTimer, 0 );\r
- * }\r
- * }\r
- *\r
- * void main( void )\r
- * {\r
- * int32_t x;\r
- *\r
- * // Create then start some timers. Starting the timers before the scheduler\r
- * // has been started means the timers will start running immediately that\r
- * // the scheduler starts.\r
- * for( x = 0; x < NUM_TIMERS; x++ )\r
- * {\r
- * xTimers[ x ] = xTimerCreate( "Timer", // Just a text name, not used by the kernel.\r
- * ( 100 * x ), // The timer period in ticks.\r
- * pdTRUE, // The timers will auto-reload themselves when they expire.\r
- * ( void * ) x, // Assign each timer a unique id equal to its array index.\r
- * vTimerCallback // Each timer calls the same callback when it expires.\r
- * );\r
- *\r
- * if( xTimers[ x ] == NULL )\r
- * {\r
- * // The timer was not created.\r
- * }\r
- * else\r
- * {\r
- * // Start the timer. No block time is specified, and even if one was\r
- * // it would be ignored because the scheduler has not yet been\r
- * // started.\r
- * if( xTimerStart( xTimers[ x ], 0 ) != pdPASS )\r
- * {\r
- * // The timer could not be set into the Active state.\r
- * }\r
- * }\r
- * }\r
- *\r
- * // ...\r
- * // Create tasks here.\r
- * // ...\r
- *\r
- * // Starting the scheduler will start the timers running as they have already\r
- * // been set into the active state.\r
- * vTaskStartScheduler();\r
- *\r
- * // Should not reach here.\r
- * for( ;; );\r
- * }\r
- * @endverbatim\r
- */\r
-#if( configSUPPORT_DYNAMIC_ALLOCATION == 1 )\r
- TimerHandle_t xTimerCreate( const char * const pcTimerName, /*lint !e971 Unqualified char types are allowed for strings and single characters only. */\r
- const TickType_t xTimerPeriodInTicks,\r
- const UBaseType_t uxAutoReload,\r
- void * const pvTimerID,\r
- TimerCallbackFunction_t pxCallbackFunction ) PRIVILEGED_FUNCTION;\r
-#endif\r
-\r
-/**\r
- * TimerHandle_t xTimerCreateStatic(const char * const pcTimerName,\r
- * TickType_t xTimerPeriodInTicks,\r
- * UBaseType_t uxAutoReload,\r
- * void * pvTimerID,\r
- * TimerCallbackFunction_t pxCallbackFunction,\r
- * StaticTimer_t *pxTimerBuffer );\r
- *\r
- * Creates a new software timer instance, and returns a handle by which the\r
- * created software timer can be referenced.\r
- *\r
- * Internally, within the FreeRTOS implementation, software timers use a block\r
- * of memory, in which the timer data structure is stored. If a software timer\r
- * is created using xTimerCreate() then the required memory is automatically\r
- * dynamically allocated inside the xTimerCreate() function. (see\r
- * http://www.freertos.org/a00111.html). If a software timer is created using\r
- * xTimerCreateStatic() then the application writer must provide the memory that\r
- * will get used by the software timer. xTimerCreateStatic() therefore allows a\r
- * software timer to be created without using any dynamic memory allocation.\r
- *\r
- * Timers are created in the dormant state. The xTimerStart(), xTimerReset(),\r
- * xTimerStartFromISR(), xTimerResetFromISR(), xTimerChangePeriod() and\r
- * xTimerChangePeriodFromISR() API functions can all be used to transition a\r
- * timer into the active state.\r
- *\r
- * @param pcTimerName A text name that is assigned to the timer. This is done\r
- * purely to assist debugging. The kernel itself only ever references a timer\r
- * by its handle, and never by its name.\r
- *\r
- * @param xTimerPeriodInTicks The timer period. The time is defined in tick\r
- * periods so the constant portTICK_PERIOD_MS can be used to convert a time that\r
- * has been specified in milliseconds. For example, if the timer must expire\r
- * after 100 ticks, then xTimerPeriodInTicks should be set to 100.\r
- * Alternatively, if the timer must expire after 500ms, then xPeriod can be set\r
- * to ( 500 / portTICK_PERIOD_MS ) provided configTICK_RATE_HZ is less than or\r
- * equal to 1000.\r
- *\r
- * @param uxAutoReload If uxAutoReload is set to pdTRUE then the timer will\r
- * expire repeatedly with a frequency set by the xTimerPeriodInTicks parameter.\r
- * If uxAutoReload is set to pdFALSE then the timer will be a one-shot timer and\r
- * enter the dormant state after it expires.\r
- *\r
- * @param pvTimerID An identifier that is assigned to the timer being created.\r
- * Typically this would be used in the timer callback function to identify which\r
- * timer expired when the same callback function is assigned to more than one\r
- * timer.\r
- *\r
- * @param pxCallbackFunction The function to call when the timer expires.\r
- * Callback functions must have the prototype defined by TimerCallbackFunction_t,\r
- * which is "void vCallbackFunction( TimerHandle_t xTimer );".\r
- *\r
- * @param pxTimerBuffer Must point to a variable of type StaticTimer_t, which\r
- * will be then be used to hold the software timer's data structures, removing\r
- * the need for the memory to be allocated dynamically.\r
- *\r
- * @return If the timer is created then a handle to the created timer is\r
- * returned. If pxTimerBuffer was NULL then NULL is returned.\r
- *\r
- * Example usage:\r
- * @verbatim\r
- *\r
- * // The buffer used to hold the software timer's data structure.\r
- * static StaticTimer_t xTimerBuffer;\r
- *\r
- * // A variable that will be incremented by the software timer's callback\r
- * // function.\r
- * UBaseType_t uxVariableToIncrement = 0;\r
- *\r
- * // A software timer callback function that increments a variable passed to\r
- * // it when the software timer was created. After the 5th increment the\r
- * // callback function stops the software timer.\r
- * static void prvTimerCallback( TimerHandle_t xExpiredTimer )\r
- * {\r
- * UBaseType_t *puxVariableToIncrement;\r
- * BaseType_t xReturned;\r
- *\r
- * // Obtain the address of the variable to increment from the timer ID.\r
- * puxVariableToIncrement = ( UBaseType_t * ) pvTimerGetTimerID( xExpiredTimer );\r
- *\r
- * // Increment the variable to show the timer callback has executed.\r
- * ( *puxVariableToIncrement )++;\r
- *\r
- * // If this callback has executed the required number of times, stop the\r
- * // timer.\r
- * if( *puxVariableToIncrement == 5 )\r
- * {\r
- * // This is called from a timer callback so must not block.\r
- * xTimerStop( xExpiredTimer, staticDONT_BLOCK );\r
- * }\r
- * }\r
- *\r
- *\r
- * void main( void )\r
- * {\r
- * // Create the software time. xTimerCreateStatic() has an extra parameter\r
- * // than the normal xTimerCreate() API function. The parameter is a pointer\r
- * // to the StaticTimer_t structure that will hold the software timer\r
- * // structure. If the parameter is passed as NULL then the structure will be\r
- * // allocated dynamically, just as if xTimerCreate() had been called.\r
- * xTimer = xTimerCreateStatic( "T1", // Text name for the task. Helps debugging only. Not used by FreeRTOS.\r
- * xTimerPeriod, // The period of the timer in ticks.\r
- * pdTRUE, // This is an auto-reload timer.\r
- * ( void * ) &uxVariableToIncrement, // A variable incremented by the software timer's callback function\r
- * prvTimerCallback, // The function to execute when the timer expires.\r
- * &xTimerBuffer ); // The buffer that will hold the software timer structure.\r
- *\r
- * // The scheduler has not started yet so a block time is not used.\r
- * xReturned = xTimerStart( xTimer, 0 );\r
- *\r
- * // ...\r
- * // Create tasks here.\r
- * // ...\r
- *\r
- * // Starting the scheduler will start the timers running as they have already\r
- * // been set into the active state.\r
- * vTaskStartScheduler();\r
- *\r
- * // Should not reach here.\r
- * for( ;; );\r
- * }\r
- * @endverbatim\r
- */\r
-#if( configSUPPORT_STATIC_ALLOCATION == 1 )\r
- TimerHandle_t xTimerCreateStatic( const char * const pcTimerName, /*lint !e971 Unqualified char types are allowed for strings and single characters only. */\r
- const TickType_t xTimerPeriodInTicks,\r
- const UBaseType_t uxAutoReload,\r
- void * const pvTimerID,\r
- TimerCallbackFunction_t pxCallbackFunction,\r
- StaticTimer_t *pxTimerBuffer ) PRIVILEGED_FUNCTION;\r
-#endif /* configSUPPORT_STATIC_ALLOCATION */\r
-\r
-/**\r
- * void *pvTimerGetTimerID( TimerHandle_t xTimer );\r
- *\r
- * Returns the ID assigned to the timer.\r
- *\r
- * IDs are assigned to timers using the pvTimerID parameter of the call to\r
- * xTimerCreated() that was used to create the timer, and by calling the\r
- * vTimerSetTimerID() API function.\r
- *\r
- * If the same callback function is assigned to multiple timers then the timer\r
- * ID can be used as time specific (timer local) storage.\r
- *\r
- * @param xTimer The timer being queried.\r
- *\r
- * @return The ID assigned to the timer being queried.\r
- *\r
- * Example usage:\r
- *\r
- * See the xTimerCreate() API function example usage scenario.\r
- */\r
-void *pvTimerGetTimerID( const TimerHandle_t xTimer ) PRIVILEGED_FUNCTION;\r
-\r
-/**\r
- * void vTimerSetTimerID( TimerHandle_t xTimer, void *pvNewID );\r
- *\r
- * Sets the ID assigned to the timer.\r
- *\r
- * IDs are assigned to timers using the pvTimerID parameter of the call to\r
- * xTimerCreated() that was used to create the timer.\r
- *\r
- * If the same callback function is assigned to multiple timers then the timer\r
- * ID can be used as time specific (timer local) storage.\r
- *\r
- * @param xTimer The timer being updated.\r
- *\r
- * @param pvNewID The ID to assign to the timer.\r
- *\r
- * Example usage:\r
- *\r
- * See the xTimerCreate() API function example usage scenario.\r
- */\r
-void vTimerSetTimerID( TimerHandle_t xTimer, void *pvNewID ) PRIVILEGED_FUNCTION;\r
-\r
-/**\r
- * BaseType_t xTimerIsTimerActive( TimerHandle_t xTimer );\r
- *\r
- * Queries a timer to see if it is active or dormant.\r
- *\r
- * A timer will be dormant if:\r
- * 1) It has been created but not started, or\r
- * 2) It is an expired one-shot timer that has not been restarted.\r
- *\r
- * Timers are created in the dormant state. The xTimerStart(), xTimerReset(),\r
- * xTimerStartFromISR(), xTimerResetFromISR(), xTimerChangePeriod() and\r
- * xTimerChangePeriodFromISR() API functions can all be used to transition a timer into the\r
- * active state.\r
- *\r
- * @param xTimer The timer being queried.\r
- *\r
- * @return pdFALSE will be returned if the timer is dormant. A value other than\r
- * pdFALSE will be returned if the timer is active.\r
- *\r
- * Example usage:\r
- * @verbatim\r
- * // This function assumes xTimer has already been created.\r
- * void vAFunction( TimerHandle_t xTimer )\r
- * {\r
- * if( xTimerIsTimerActive( xTimer ) != pdFALSE ) // or more simply and equivalently "if( xTimerIsTimerActive( xTimer ) )"\r
- * {\r
- * // xTimer is active, do something.\r
- * }\r
- * else\r
- * {\r
- * // xTimer is not active, do something else.\r
- * }\r
- * }\r
- * @endverbatim\r
- */\r
-BaseType_t xTimerIsTimerActive( TimerHandle_t xTimer ) PRIVILEGED_FUNCTION;\r
-\r
-/**\r
- * TaskHandle_t xTimerGetTimerDaemonTaskHandle( void );\r
- *\r
- * Simply returns the handle of the timer service/daemon task. It it not valid\r
- * to call xTimerGetTimerDaemonTaskHandle() before the scheduler has been started.\r
- */\r
-TaskHandle_t xTimerGetTimerDaemonTaskHandle( void ) PRIVILEGED_FUNCTION;\r
-\r
-/**\r
- * BaseType_t xTimerStart( TimerHandle_t xTimer, TickType_t xTicksToWait );\r
- *\r
- * Timer functionality is provided by a timer service/daemon task. Many of the\r
- * public FreeRTOS timer API functions send commands to the timer service task\r
- * through a queue called the timer command queue. The timer command queue is\r
- * private to the kernel itself and is not directly accessible to application\r
- * code. The length of the timer command queue is set by the\r
- * configTIMER_QUEUE_LENGTH configuration constant.\r
- *\r
- * xTimerStart() starts a timer that was previously created using the\r
- * xTimerCreate() API function. If the timer had already been started and was\r
- * already in the active state, then xTimerStart() has equivalent functionality\r
- * to the xTimerReset() API function.\r
- *\r
- * Starting a timer ensures the timer is in the active state. If the timer\r
- * is not stopped, deleted, or reset in the mean time, the callback function\r
- * associated with the timer will get called 'n' ticks after xTimerStart() was\r
- * called, where 'n' is the timers defined period.\r
- *\r
- * It is valid to call xTimerStart() before the scheduler has been started, but\r
- * when this is done the timer will not actually start until the scheduler is\r
- * started, and the timers expiry time will be relative to when the scheduler is\r
- * started, not relative to when xTimerStart() was called.\r
- *\r
- * The configUSE_TIMERS configuration constant must be set to 1 for xTimerStart()\r
- * to be available.\r
- *\r
- * @param xTimer The handle of the timer being started/restarted.\r
- *\r
- * @param xTicksToWait Specifies the time, in ticks, that the calling task should\r
- * be held in the Blocked state to wait for the start command to be successfully\r
- * sent to the timer command queue, should the queue already be full when\r
- * xTimerStart() was called. xTicksToWait is ignored if xTimerStart() is called\r
- * before the scheduler is started.\r
- *\r
- * @return pdFAIL will be returned if the start command could not be sent to\r
- * the timer command queue even after xTicksToWait ticks had passed. pdPASS will\r
- * be returned if the command was successfully sent to the timer command queue.\r
- * When the command is actually processed will depend on the priority of the\r
- * timer service/daemon task relative to other tasks in the system, although the\r
- * timers expiry time is relative to when xTimerStart() is actually called. The\r
- * timer service/daemon task priority is set by the configTIMER_TASK_PRIORITY\r
- * configuration constant.\r
- *\r
- * Example usage:\r
- *\r
- * See the xTimerCreate() API function example usage scenario.\r
- *\r
- */\r
-#define xTimerStart( xTimer, xTicksToWait ) xTimerGenericCommand( ( xTimer ), tmrCOMMAND_START, ( xTaskGetTickCount() ), NULL, ( xTicksToWait ) )\r
-\r
-/**\r
- * BaseType_t xTimerStop( TimerHandle_t xTimer, TickType_t xTicksToWait );\r
- *\r
- * Timer functionality is provided by a timer service/daemon task. Many of the\r
- * public FreeRTOS timer API functions send commands to the timer service task\r
- * through a queue called the timer command queue. The timer command queue is\r
- * private to the kernel itself and is not directly accessible to application\r
- * code. The length of the timer command queue is set by the\r
- * configTIMER_QUEUE_LENGTH configuration constant.\r
- *\r
- * xTimerStop() stops a timer that was previously started using either of the\r
- * The xTimerStart(), xTimerReset(), xTimerStartFromISR(), xTimerResetFromISR(),\r
- * xTimerChangePeriod() or xTimerChangePeriodFromISR() API functions.\r
- *\r
- * Stopping a timer ensures the timer is not in the active state.\r
- *\r
- * The configUSE_TIMERS configuration constant must be set to 1 for xTimerStop()\r
- * to be available.\r
- *\r
- * @param xTimer The handle of the timer being stopped.\r
- *\r
- * @param xTicksToWait Specifies the time, in ticks, that the calling task should\r
- * be held in the Blocked state to wait for the stop command to be successfully\r
- * sent to the timer command queue, should the queue already be full when\r
- * xTimerStop() was called. xTicksToWait is ignored if xTimerStop() is called\r
- * before the scheduler is started.\r
- *\r
- * @return pdFAIL will be returned if the stop command could not be sent to\r
- * the timer command queue even after xTicksToWait ticks had passed. pdPASS will\r
- * be returned if the command was successfully sent to the timer command queue.\r
- * When the command is actually processed will depend on the priority of the\r
- * timer service/daemon task relative to other tasks in the system. The timer\r
- * service/daemon task priority is set by the configTIMER_TASK_PRIORITY\r
- * configuration constant.\r
- *\r
- * Example usage:\r
- *\r
- * See the xTimerCreate() API function example usage scenario.\r
- *\r
- */\r
-#define xTimerStop( xTimer, xTicksToWait ) xTimerGenericCommand( ( xTimer ), tmrCOMMAND_STOP, 0U, NULL, ( xTicksToWait ) )\r
-\r
-/**\r
- * BaseType_t xTimerChangePeriod( TimerHandle_t xTimer,\r
- * TickType_t xNewPeriod,\r
- * TickType_t xTicksToWait );\r
- *\r
- * Timer functionality is provided by a timer service/daemon task. Many of the\r
- * public FreeRTOS timer API functions send commands to the timer service task\r
- * through a queue called the timer command queue. The timer command queue is\r
- * private to the kernel itself and is not directly accessible to application\r
- * code. The length of the timer command queue is set by the\r
- * configTIMER_QUEUE_LENGTH configuration constant.\r
- *\r
- * xTimerChangePeriod() changes the period of a timer that was previously\r
- * created using the xTimerCreate() API function.\r
- *\r
- * xTimerChangePeriod() can be called to change the period of an active or\r
- * dormant state timer.\r
- *\r
- * The configUSE_TIMERS configuration constant must be set to 1 for\r
- * xTimerChangePeriod() to be available.\r
- *\r
- * @param xTimer The handle of the timer that is having its period changed.\r
- *\r
- * @param xNewPeriod The new period for xTimer. Timer periods are specified in\r
- * tick periods, so the constant portTICK_PERIOD_MS can be used to convert a time\r
- * that has been specified in milliseconds. For example, if the timer must\r
- * expire after 100 ticks, then xNewPeriod should be set to 100. Alternatively,\r
- * if the timer must expire after 500ms, then xNewPeriod can be set to\r
- * ( 500 / portTICK_PERIOD_MS ) provided configTICK_RATE_HZ is less than\r
- * or equal to 1000.\r
- *\r
- * @param xTicksToWait Specifies the time, in ticks, that the calling task should\r
- * be held in the Blocked state to wait for the change period command to be\r
- * successfully sent to the timer command queue, should the queue already be\r
- * full when xTimerChangePeriod() was called. xTicksToWait is ignored if\r
- * xTimerChangePeriod() is called before the scheduler is started.\r
- *\r
- * @return pdFAIL will be returned if the change period command could not be\r
- * sent to the timer command queue even after xTicksToWait ticks had passed.\r
- * pdPASS will be returned if the command was successfully sent to the timer\r
- * command queue. When the command is actually processed will depend on the\r
- * priority of the timer service/daemon task relative to other tasks in the\r
- * system. The timer service/daemon task priority is set by the\r
- * configTIMER_TASK_PRIORITY configuration constant.\r
- *\r
- * Example usage:\r
- * @verbatim\r
- * // This function assumes xTimer has already been created. If the timer\r
- * // referenced by xTimer is already active when it is called, then the timer\r
- * // is deleted. If the timer referenced by xTimer is not active when it is\r
- * // called, then the period of the timer is set to 500ms and the timer is\r
- * // started.\r
- * void vAFunction( TimerHandle_t xTimer )\r
- * {\r
- * if( xTimerIsTimerActive( xTimer ) != pdFALSE ) // or more simply and equivalently "if( xTimerIsTimerActive( xTimer ) )"\r
- * {\r
- * // xTimer is already active - delete it.\r
- * xTimerDelete( xTimer );\r
- * }\r
- * else\r
- * {\r
- * // xTimer is not active, change its period to 500ms. This will also\r
- * // cause the timer to start. Block for a maximum of 100 ticks if the\r
- * // change period command cannot immediately be sent to the timer\r
- * // command queue.\r
- * if( xTimerChangePeriod( xTimer, 500 / portTICK_PERIOD_MS, 100 ) == pdPASS )\r
- * {\r
- * // The command was successfully sent.\r
- * }\r
- * else\r
- * {\r
- * // The command could not be sent, even after waiting for 100 ticks\r
- * // to pass. Take appropriate action here.\r
- * }\r
- * }\r
- * }\r
- * @endverbatim\r
- */\r
- #define xTimerChangePeriod( xTimer, xNewPeriod, xTicksToWait ) xTimerGenericCommand( ( xTimer ), tmrCOMMAND_CHANGE_PERIOD, ( xNewPeriod ), NULL, ( xTicksToWait ) )\r
-\r
-/**\r
- * BaseType_t xTimerDelete( TimerHandle_t xTimer, TickType_t xTicksToWait );\r
- *\r
- * Timer functionality is provided by a timer service/daemon task. Many of the\r
- * public FreeRTOS timer API functions send commands to the timer service task\r
- * through a queue called the timer command queue. The timer command queue is\r
- * private to the kernel itself and is not directly accessible to application\r
- * code. The length of the timer command queue is set by the\r
- * configTIMER_QUEUE_LENGTH configuration constant.\r
- *\r
- * xTimerDelete() deletes a timer that was previously created using the\r
- * xTimerCreate() API function.\r
- *\r
- * The configUSE_TIMERS configuration constant must be set to 1 for\r
- * xTimerDelete() to be available.\r
- *\r
- * @param xTimer The handle of the timer being deleted.\r
- *\r
- * @param xTicksToWait Specifies the time, in ticks, that the calling task should\r
- * be held in the Blocked state to wait for the delete command to be\r
- * successfully sent to the timer command queue, should the queue already be\r
- * full when xTimerDelete() was called. xTicksToWait is ignored if xTimerDelete()\r
- * is called before the scheduler is started.\r
- *\r
- * @return pdFAIL will be returned if the delete command could not be sent to\r
- * the timer command queue even after xTicksToWait ticks had passed. pdPASS will\r
- * be returned if the command was successfully sent to the timer command queue.\r
- * When the command is actually processed will depend on the priority of the\r
- * timer service/daemon task relative to other tasks in the system. The timer\r
- * service/daemon task priority is set by the configTIMER_TASK_PRIORITY\r
- * configuration constant.\r
- *\r
- * Example usage:\r
- *\r
- * See the xTimerChangePeriod() API function example usage scenario.\r
- */\r
-#define xTimerDelete( xTimer, xTicksToWait ) xTimerGenericCommand( ( xTimer ), tmrCOMMAND_DELETE, 0U, NULL, ( xTicksToWait ) )\r
-\r
-/**\r
- * BaseType_t xTimerReset( TimerHandle_t xTimer, TickType_t xTicksToWait );\r
- *\r
- * Timer functionality is provided by a timer service/daemon task. Many of the\r
- * public FreeRTOS timer API functions send commands to the timer service task\r
- * through a queue called the timer command queue. The timer command queue is\r
- * private to the kernel itself and is not directly accessible to application\r
- * code. The length of the timer command queue is set by the\r
- * configTIMER_QUEUE_LENGTH configuration constant.\r
- *\r
- * xTimerReset() re-starts a timer that was previously created using the\r
- * xTimerCreate() API function. If the timer had already been started and was\r
- * already in the active state, then xTimerReset() will cause the timer to\r
- * re-evaluate its expiry time so that it is relative to when xTimerReset() was\r
- * called. If the timer was in the dormant state then xTimerReset() has\r
- * equivalent functionality to the xTimerStart() API function.\r
- *\r
- * Resetting a timer ensures the timer is in the active state. If the timer\r
- * is not stopped, deleted, or reset in the mean time, the callback function\r
- * associated with the timer will get called 'n' ticks after xTimerReset() was\r
- * called, where 'n' is the timers defined period.\r
- *\r
- * It is valid to call xTimerReset() before the scheduler has been started, but\r
- * when this is done the timer will not actually start until the scheduler is\r
- * started, and the timers expiry time will be relative to when the scheduler is\r
- * started, not relative to when xTimerReset() was called.\r
- *\r
- * The configUSE_TIMERS configuration constant must be set to 1 for xTimerReset()\r
- * to be available.\r
- *\r
- * @param xTimer The handle of the timer being reset/started/restarted.\r
- *\r
- * @param xTicksToWait Specifies the time, in ticks, that the calling task should\r
- * be held in the Blocked state to wait for the reset command to be successfully\r
- * sent to the timer command queue, should the queue already be full when\r
- * xTimerReset() was called. xTicksToWait is ignored if xTimerReset() is called\r
- * before the scheduler is started.\r
- *\r
- * @return pdFAIL will be returned if the reset command could not be sent to\r
- * the timer command queue even after xTicksToWait ticks had passed. pdPASS will\r
- * be returned if the command was successfully sent to the timer command queue.\r
- * When the command is actually processed will depend on the priority of the\r
- * timer service/daemon task relative to other tasks in the system, although the\r
- * timers expiry time is relative to when xTimerStart() is actually called. The\r
- * timer service/daemon task priority is set by the configTIMER_TASK_PRIORITY\r
- * configuration constant.\r
- *\r
- * Example usage:\r
- * @verbatim\r
- * // When a key is pressed, an LCD back-light is switched on. If 5 seconds pass\r
- * // without a key being pressed, then the LCD back-light is switched off. In\r
- * // this case, the timer is a one-shot timer.\r
- *\r
- * TimerHandle_t xBacklightTimer = NULL;\r
- *\r
- * // The callback function assigned to the one-shot timer. In this case the\r
- * // parameter is not used.\r
- * void vBacklightTimerCallback( TimerHandle_t pxTimer )\r
- * {\r
- * // The timer expired, therefore 5 seconds must have passed since a key\r
- * // was pressed. Switch off the LCD back-light.\r
- * vSetBacklightState( BACKLIGHT_OFF );\r
- * }\r
- *\r
- * // The key press event handler.\r
- * void vKeyPressEventHandler( char cKey )\r
- * {\r
- * // Ensure the LCD back-light is on, then reset the timer that is\r
- * // responsible for turning the back-light off after 5 seconds of\r
- * // key inactivity. Wait 10 ticks for the command to be successfully sent\r
- * // if it cannot be sent immediately.\r
- * vSetBacklightState( BACKLIGHT_ON );\r
- * if( xTimerReset( xBacklightTimer, 100 ) != pdPASS )\r
- * {\r
- * // The reset command was not executed successfully. Take appropriate\r
- * // action here.\r
- * }\r
- *\r
- * // Perform the rest of the key processing here.\r
- * }\r
- *\r
- * void main( void )\r
- * {\r
- * int32_t x;\r
- *\r
- * // Create then start the one-shot timer that is responsible for turning\r
- * // the back-light off if no keys are pressed within a 5 second period.\r
- * xBacklightTimer = xTimerCreate( "BacklightTimer", // Just a text name, not used by the kernel.\r
- * ( 5000 / portTICK_PERIOD_MS), // The timer period in ticks.\r
- * pdFALSE, // The timer is a one-shot timer.\r
- * 0, // The id is not used by the callback so can take any value.\r
- * vBacklightTimerCallback // The callback function that switches the LCD back-light off.\r
- * );\r
- *\r
- * if( xBacklightTimer == NULL )\r
- * {\r
- * // The timer was not created.\r
- * }\r
- * else\r
- * {\r
- * // Start the timer. No block time is specified, and even if one was\r
- * // it would be ignored because the scheduler has not yet been\r
- * // started.\r
- * if( xTimerStart( xBacklightTimer, 0 ) != pdPASS )\r
- * {\r
- * // The timer could not be set into the Active state.\r
- * }\r
- * }\r
- *\r
- * // ...\r
- * // Create tasks here.\r
- * // ...\r
- *\r
- * // Starting the scheduler will start the timer running as it has already\r
- * // been set into the active state.\r
- * vTaskStartScheduler();\r
- *\r
- * // Should not reach here.\r
- * for( ;; );\r
- * }\r
- * @endverbatim\r
- */\r
-#define xTimerReset( xTimer, xTicksToWait ) xTimerGenericCommand( ( xTimer ), tmrCOMMAND_RESET, ( xTaskGetTickCount() ), NULL, ( xTicksToWait ) )\r
-\r
-/**\r
- * BaseType_t xTimerStartFromISR( TimerHandle_t xTimer,\r
- * BaseType_t *pxHigherPriorityTaskWoken );\r
- *\r
- * A version of xTimerStart() that can be called from an interrupt service\r
- * routine.\r
- *\r
- * @param xTimer The handle of the timer being started/restarted.\r
- *\r
- * @param pxHigherPriorityTaskWoken The timer service/daemon task spends most\r
- * of its time in the Blocked state, waiting for messages to arrive on the timer\r
- * command queue. Calling xTimerStartFromISR() writes a message to the timer\r
- * command queue, so has the potential to transition the timer service/daemon\r
- * task out of the Blocked state. If calling xTimerStartFromISR() causes the\r
- * timer service/daemon task to leave the Blocked state, and the timer service/\r
- * daemon task has a priority equal to or greater than the currently executing\r
- * task (the task that was interrupted), then *pxHigherPriorityTaskWoken will\r
- * get set to pdTRUE internally within the xTimerStartFromISR() function. If\r
- * xTimerStartFromISR() sets this value to pdTRUE then a context switch should\r
- * be performed before the interrupt exits.\r
- *\r
- * @return pdFAIL will be returned if the start command could not be sent to\r
- * the timer command queue. pdPASS will be returned if the command was\r
- * successfully sent to the timer command queue. When the command is actually\r
- * processed will depend on the priority of the timer service/daemon task\r
- * relative to other tasks in the system, although the timers expiry time is\r
- * relative to when xTimerStartFromISR() is actually called. The timer\r
- * service/daemon task priority is set by the configTIMER_TASK_PRIORITY\r
- * configuration constant.\r
- *\r
- * Example usage:\r
- * @verbatim\r
- * // This scenario assumes xBacklightTimer has already been created. When a\r
- * // key is pressed, an LCD back-light is switched on. If 5 seconds pass\r
- * // without a key being pressed, then the LCD back-light is switched off. In\r
- * // this case, the timer is a one-shot timer, and unlike the example given for\r
- * // the xTimerReset() function, the key press event handler is an interrupt\r
- * // service routine.\r
- *\r
- * // The callback function assigned to the one-shot timer. In this case the\r
- * // parameter is not used.\r
- * void vBacklightTimerCallback( TimerHandle_t pxTimer )\r
- * {\r
- * // The timer expired, therefore 5 seconds must have passed since a key\r
- * // was pressed. Switch off the LCD back-light.\r
- * vSetBacklightState( BACKLIGHT_OFF );\r
- * }\r
- *\r
- * // The key press interrupt service routine.\r
- * void vKeyPressEventInterruptHandler( void )\r
- * {\r
- * BaseType_t xHigherPriorityTaskWoken = pdFALSE;\r
- *\r
- * // Ensure the LCD back-light is on, then restart the timer that is\r
- * // responsible for turning the back-light off after 5 seconds of\r
- * // key inactivity. This is an interrupt service routine so can only\r
- * // call FreeRTOS API functions that end in "FromISR".\r
- * vSetBacklightState( BACKLIGHT_ON );\r
- *\r
- * // xTimerStartFromISR() or xTimerResetFromISR() could be called here\r
- * // as both cause the timer to re-calculate its expiry time.\r
- * // xHigherPriorityTaskWoken was initialised to pdFALSE when it was\r
- * // declared (in this function).\r
- * if( xTimerStartFromISR( xBacklightTimer, &xHigherPriorityTaskWoken ) != pdPASS )\r
- * {\r
- * // The start command was not executed successfully. Take appropriate\r
- * // action here.\r
- * }\r
- *\r
- * // Perform the rest of the key processing here.\r
- *\r
- * // If xHigherPriorityTaskWoken equals pdTRUE, then a context switch\r
- * // should be performed. The syntax required to perform a context switch\r
- * // from inside an ISR varies from port to port, and from compiler to\r
- * // compiler. Inspect the demos for the port you are using to find the\r
- * // actual syntax required.\r
- * if( xHigherPriorityTaskWoken != pdFALSE )\r
- * {\r
- * // Call the interrupt safe yield function here (actual function\r
- * // depends on the FreeRTOS port being used).\r
- * }\r
- * }\r
- * @endverbatim\r
- */\r
-#define xTimerStartFromISR( xTimer, pxHigherPriorityTaskWoken ) xTimerGenericCommand( ( xTimer ), tmrCOMMAND_START_FROM_ISR, ( xTaskGetTickCountFromISR() ), ( pxHigherPriorityTaskWoken ), 0U )\r
-\r
-/**\r
- * BaseType_t xTimerStopFromISR( TimerHandle_t xTimer,\r
- * BaseType_t *pxHigherPriorityTaskWoken );\r
- *\r
- * A version of xTimerStop() that can be called from an interrupt service\r
- * routine.\r
- *\r
- * @param xTimer The handle of the timer being stopped.\r
- *\r
- * @param pxHigherPriorityTaskWoken The timer service/daemon task spends most\r
- * of its time in the Blocked state, waiting for messages to arrive on the timer\r
- * command queue. Calling xTimerStopFromISR() writes a message to the timer\r
- * command queue, so has the potential to transition the timer service/daemon\r
- * task out of the Blocked state. If calling xTimerStopFromISR() causes the\r
- * timer service/daemon task to leave the Blocked state, and the timer service/\r
- * daemon task has a priority equal to or greater than the currently executing\r
- * task (the task that was interrupted), then *pxHigherPriorityTaskWoken will\r
- * get set to pdTRUE internally within the xTimerStopFromISR() function. If\r
- * xTimerStopFromISR() sets this value to pdTRUE then a context switch should\r
- * be performed before the interrupt exits.\r
- *\r
- * @return pdFAIL will be returned if the stop command could not be sent to\r
- * the timer command queue. pdPASS will be returned if the command was\r
- * successfully sent to the timer command queue. When the command is actually\r
- * processed will depend on the priority of the timer service/daemon task\r
- * relative to other tasks in the system. The timer service/daemon task\r
- * priority is set by the configTIMER_TASK_PRIORITY configuration constant.\r
- *\r
- * Example usage:\r
- * @verbatim\r
- * // This scenario assumes xTimer has already been created and started. When\r
- * // an interrupt occurs, the timer should be simply stopped.\r
- *\r
- * // The interrupt service routine that stops the timer.\r
- * void vAnExampleInterruptServiceRoutine( void )\r
- * {\r
- * BaseType_t xHigherPriorityTaskWoken = pdFALSE;\r
- *\r
- * // The interrupt has occurred - simply stop the timer.\r
- * // xHigherPriorityTaskWoken was set to pdFALSE where it was defined\r
- * // (within this function). As this is an interrupt service routine, only\r
- * // FreeRTOS API functions that end in "FromISR" can be used.\r
- * if( xTimerStopFromISR( xTimer, &xHigherPriorityTaskWoken ) != pdPASS )\r
- * {\r
- * // The stop command was not executed successfully. Take appropriate\r
- * // action here.\r
- * }\r
- *\r
- * // If xHigherPriorityTaskWoken equals pdTRUE, then a context switch\r
- * // should be performed. The syntax required to perform a context switch\r
- * // from inside an ISR varies from port to port, and from compiler to\r
- * // compiler. Inspect the demos for the port you are using to find the\r
- * // actual syntax required.\r
- * if( xHigherPriorityTaskWoken != pdFALSE )\r
- * {\r
- * // Call the interrupt safe yield function here (actual function\r
- * // depends on the FreeRTOS port being used).\r
- * }\r
- * }\r
- * @endverbatim\r
- */\r
-#define xTimerStopFromISR( xTimer, pxHigherPriorityTaskWoken ) xTimerGenericCommand( ( xTimer ), tmrCOMMAND_STOP_FROM_ISR, 0, ( pxHigherPriorityTaskWoken ), 0U )\r
-\r
-/**\r
- * BaseType_t xTimerChangePeriodFromISR( TimerHandle_t xTimer,\r
- * TickType_t xNewPeriod,\r
- * BaseType_t *pxHigherPriorityTaskWoken );\r
- *\r
- * A version of xTimerChangePeriod() that can be called from an interrupt\r
- * service routine.\r
- *\r
- * @param xTimer The handle of the timer that is having its period changed.\r
- *\r
- * @param xNewPeriod The new period for xTimer. Timer periods are specified in\r
- * tick periods, so the constant portTICK_PERIOD_MS can be used to convert a time\r
- * that has been specified in milliseconds. For example, if the timer must\r
- * expire after 100 ticks, then xNewPeriod should be set to 100. Alternatively,\r
- * if the timer must expire after 500ms, then xNewPeriod can be set to\r
- * ( 500 / portTICK_PERIOD_MS ) provided configTICK_RATE_HZ is less than\r
- * or equal to 1000.\r
- *\r
- * @param pxHigherPriorityTaskWoken The timer service/daemon task spends most\r
- * of its time in the Blocked state, waiting for messages to arrive on the timer\r
- * command queue. Calling xTimerChangePeriodFromISR() writes a message to the\r
- * timer command queue, so has the potential to transition the timer service/\r
- * daemon task out of the Blocked state. If calling xTimerChangePeriodFromISR()\r
- * causes the timer service/daemon task to leave the Blocked state, and the\r
- * timer service/daemon task has a priority equal to or greater than the\r
- * currently executing task (the task that was interrupted), then\r
- * *pxHigherPriorityTaskWoken will get set to pdTRUE internally within the\r
- * xTimerChangePeriodFromISR() function. If xTimerChangePeriodFromISR() sets\r
- * this value to pdTRUE then a context switch should be performed before the\r
- * interrupt exits.\r
- *\r
- * @return pdFAIL will be returned if the command to change the timers period\r
- * could not be sent to the timer command queue. pdPASS will be returned if the\r
- * command was successfully sent to the timer command queue. When the command\r
- * is actually processed will depend on the priority of the timer service/daemon\r
- * task relative to other tasks in the system. The timer service/daemon task\r
- * priority is set by the configTIMER_TASK_PRIORITY configuration constant.\r
- *\r
- * Example usage:\r
- * @verbatim\r
- * // This scenario assumes xTimer has already been created and started. When\r
- * // an interrupt occurs, the period of xTimer should be changed to 500ms.\r
- *\r
- * // The interrupt service routine that changes the period of xTimer.\r
- * void vAnExampleInterruptServiceRoutine( void )\r
- * {\r
- * BaseType_t xHigherPriorityTaskWoken = pdFALSE;\r
- *\r
- * // The interrupt has occurred - change the period of xTimer to 500ms.\r
- * // xHigherPriorityTaskWoken was set to pdFALSE where it was defined\r
- * // (within this function). As this is an interrupt service routine, only\r
- * // FreeRTOS API functions that end in "FromISR" can be used.\r
- * if( xTimerChangePeriodFromISR( xTimer, &xHigherPriorityTaskWoken ) != pdPASS )\r
- * {\r
- * // The command to change the timers period was not executed\r
- * // successfully. Take appropriate action here.\r
- * }\r
- *\r
- * // If xHigherPriorityTaskWoken equals pdTRUE, then a context switch\r
- * // should be performed. The syntax required to perform a context switch\r
- * // from inside an ISR varies from port to port, and from compiler to\r
- * // compiler. Inspect the demos for the port you are using to find the\r
- * // actual syntax required.\r
- * if( xHigherPriorityTaskWoken != pdFALSE )\r
- * {\r
- * // Call the interrupt safe yield function here (actual function\r
- * // depends on the FreeRTOS port being used).\r
- * }\r
- * }\r
- * @endverbatim\r
- */\r
-#define xTimerChangePeriodFromISR( xTimer, xNewPeriod, pxHigherPriorityTaskWoken ) xTimerGenericCommand( ( xTimer ), tmrCOMMAND_CHANGE_PERIOD_FROM_ISR, ( xNewPeriod ), ( pxHigherPriorityTaskWoken ), 0U )\r
-\r
-/**\r
- * BaseType_t xTimerResetFromISR( TimerHandle_t xTimer,\r
- * BaseType_t *pxHigherPriorityTaskWoken );\r
- *\r
- * A version of xTimerReset() that can be called from an interrupt service\r
- * routine.\r
- *\r
- * @param xTimer The handle of the timer that is to be started, reset, or\r
- * restarted.\r
- *\r
- * @param pxHigherPriorityTaskWoken The timer service/daemon task spends most\r
- * of its time in the Blocked state, waiting for messages to arrive on the timer\r
- * command queue. Calling xTimerResetFromISR() writes a message to the timer\r
- * command queue, so has the potential to transition the timer service/daemon\r
- * task out of the Blocked state. If calling xTimerResetFromISR() causes the\r
- * timer service/daemon task to leave the Blocked state, and the timer service/\r
- * daemon task has a priority equal to or greater than the currently executing\r
- * task (the task that was interrupted), then *pxHigherPriorityTaskWoken will\r
- * get set to pdTRUE internally within the xTimerResetFromISR() function. If\r
- * xTimerResetFromISR() sets this value to pdTRUE then a context switch should\r
- * be performed before the interrupt exits.\r
- *\r
- * @return pdFAIL will be returned if the reset command could not be sent to\r
- * the timer command queue. pdPASS will be returned if the command was\r
- * successfully sent to the timer command queue. When the command is actually\r
- * processed will depend on the priority of the timer service/daemon task\r
- * relative to other tasks in the system, although the timers expiry time is\r
- * relative to when xTimerResetFromISR() is actually called. The timer service/daemon\r
- * task priority is set by the configTIMER_TASK_PRIORITY configuration constant.\r
- *\r
- * Example usage:\r
- * @verbatim\r
- * // This scenario assumes xBacklightTimer has already been created. When a\r
- * // key is pressed, an LCD back-light is switched on. If 5 seconds pass\r
- * // without a key being pressed, then the LCD back-light is switched off. In\r
- * // this case, the timer is a one-shot timer, and unlike the example given for\r
- * // the xTimerReset() function, the key press event handler is an interrupt\r
- * // service routine.\r
- *\r
- * // The callback function assigned to the one-shot timer. In this case the\r
- * // parameter is not used.\r
- * void vBacklightTimerCallback( TimerHandle_t pxTimer )\r
- * {\r
- * // The timer expired, therefore 5 seconds must have passed since a key\r
- * // was pressed. Switch off the LCD back-light.\r
- * vSetBacklightState( BACKLIGHT_OFF );\r
- * }\r
- *\r
- * // The key press interrupt service routine.\r
- * void vKeyPressEventInterruptHandler( void )\r
- * {\r
- * BaseType_t xHigherPriorityTaskWoken = pdFALSE;\r
- *\r
- * // Ensure the LCD back-light is on, then reset the timer that is\r
- * // responsible for turning the back-light off after 5 seconds of\r
- * // key inactivity. This is an interrupt service routine so can only\r
- * // call FreeRTOS API functions that end in "FromISR".\r
- * vSetBacklightState( BACKLIGHT_ON );\r
- *\r
- * // xTimerStartFromISR() or xTimerResetFromISR() could be called here\r
- * // as both cause the timer to re-calculate its expiry time.\r
- * // xHigherPriorityTaskWoken was initialised to pdFALSE when it was\r
- * // declared (in this function).\r
- * if( xTimerResetFromISR( xBacklightTimer, &xHigherPriorityTaskWoken ) != pdPASS )\r
- * {\r
- * // The reset command was not executed successfully. Take appropriate\r
- * // action here.\r
- * }\r
- *\r
- * // Perform the rest of the key processing here.\r
- *\r
- * // If xHigherPriorityTaskWoken equals pdTRUE, then a context switch\r
- * // should be performed. The syntax required to perform a context switch\r
- * // from inside an ISR varies from port to port, and from compiler to\r
- * // compiler. Inspect the demos for the port you are using to find the\r
- * // actual syntax required.\r
- * if( xHigherPriorityTaskWoken != pdFALSE )\r
- * {\r
- * // Call the interrupt safe yield function here (actual function\r
- * // depends on the FreeRTOS port being used).\r
- * }\r
- * }\r
- * @endverbatim\r
- */\r
-#define xTimerResetFromISR( xTimer, pxHigherPriorityTaskWoken ) xTimerGenericCommand( ( xTimer ), tmrCOMMAND_RESET_FROM_ISR, ( xTaskGetTickCountFromISR() ), ( pxHigherPriorityTaskWoken ), 0U )\r
-\r
-\r
-/**\r
- * BaseType_t xTimerPendFunctionCallFromISR( PendedFunction_t xFunctionToPend,\r
- * void *pvParameter1,\r
- * uint32_t ulParameter2,\r
- * BaseType_t *pxHigherPriorityTaskWoken );\r
- *\r
- *\r
- * Used from application interrupt service routines to defer the execution of a\r
- * function to the RTOS daemon task (the timer service task, hence this function\r
- * is implemented in timers.c and is prefixed with 'Timer').\r
- *\r
- * Ideally an interrupt service routine (ISR) is kept as short as possible, but\r
- * sometimes an ISR either has a lot of processing to do, or needs to perform\r
- * processing that is not deterministic. In these cases\r
- * xTimerPendFunctionCallFromISR() can be used to defer processing of a function\r
- * to the RTOS daemon task.\r
- *\r
- * A mechanism is provided that allows the interrupt to return directly to the\r
- * task that will subsequently execute the pended callback function. This\r
- * allows the callback function to execute contiguously in time with the\r
- * interrupt - just as if the callback had executed in the interrupt itself.\r
- *\r
- * @param xFunctionToPend The function to execute from the timer service/\r
- * daemon task. The function must conform to the PendedFunction_t\r
- * prototype.\r
- *\r
- * @param pvParameter1 The value of the callback function's first parameter.\r
- * The parameter has a void * type to allow it to be used to pass any type.\r
- * For example, unsigned longs can be cast to a void *, or the void * can be\r
- * used to point to a structure.\r
- *\r
- * @param ulParameter2 The value of the callback function's second parameter.\r
- *\r
- * @param pxHigherPriorityTaskWoken As mentioned above, calling this function\r
- * will result in a message being sent to the timer daemon task. If the\r
- * priority of the timer daemon task (which is set using\r
- * configTIMER_TASK_PRIORITY in FreeRTOSConfig.h) is higher than the priority of\r
- * the currently running task (the task the interrupt interrupted) then\r
- * *pxHigherPriorityTaskWoken will be set to pdTRUE within\r
- * xTimerPendFunctionCallFromISR(), indicating that a context switch should be\r
- * requested before the interrupt exits. For that reason\r
- * *pxHigherPriorityTaskWoken must be initialised to pdFALSE. See the\r
- * example code below.\r
- *\r
- * @return pdPASS is returned if the message was successfully sent to the\r
- * timer daemon task, otherwise pdFALSE is returned.\r
- *\r
- * Example usage:\r
- * @verbatim\r
- *\r
- * // The callback function that will execute in the context of the daemon task.\r
- * // Note callback functions must all use this same prototype.\r
- * void vProcessInterface( void *pvParameter1, uint32_t ulParameter2 )\r
- * {\r
- * BaseType_t xInterfaceToService;\r
- *\r
- * // The interface that requires servicing is passed in the second\r
- * // parameter. The first parameter is not used in this case.\r
- * xInterfaceToService = ( BaseType_t ) ulParameter2;\r
- *\r
- * // ...Perform the processing here...\r
- * }\r
- *\r
- * // An ISR that receives data packets from multiple interfaces\r
- * void vAnISR( void )\r
- * {\r
- * BaseType_t xInterfaceToService, xHigherPriorityTaskWoken;\r
- *\r
- * // Query the hardware to determine which interface needs processing.\r
- * xInterfaceToService = prvCheckInterfaces();\r
- *\r
- * // The actual processing is to be deferred to a task. Request the\r
- * // vProcessInterface() callback function is executed, passing in the\r
- * // number of the interface that needs processing. The interface to\r
- * // service is passed in the second parameter. The first parameter is\r
- * // not used in this case.\r
- * xHigherPriorityTaskWoken = pdFALSE;\r
- * xTimerPendFunctionCallFromISR( vProcessInterface, NULL, ( uint32_t ) xInterfaceToService, &xHigherPriorityTaskWoken );\r
- *\r
- * // If xHigherPriorityTaskWoken is now set to pdTRUE then a context\r
- * // switch should be requested. The macro used is port specific and will\r
- * // be either portYIELD_FROM_ISR() or portEND_SWITCHING_ISR() - refer to\r
- * // the documentation page for the port being used.\r
- * portYIELD_FROM_ISR( xHigherPriorityTaskWoken );\r
- *\r
- * }\r
- * @endverbatim\r
- */\r
-BaseType_t xTimerPendFunctionCallFromISR( PendedFunction_t xFunctionToPend, void *pvParameter1, uint32_t ulParameter2, BaseType_t *pxHigherPriorityTaskWoken ) PRIVILEGED_FUNCTION;\r
-\r
- /**\r
- * BaseType_t xTimerPendFunctionCall( PendedFunction_t xFunctionToPend,\r
- * void *pvParameter1,\r
- * uint32_t ulParameter2,\r
- * TickType_t xTicksToWait );\r
- *\r
- *\r
- * Used to defer the execution of a function to the RTOS daemon task (the timer\r
- * service task, hence this function is implemented in timers.c and is prefixed\r
- * with 'Timer').\r
- *\r
- * @param xFunctionToPend The function to execute from the timer service/\r
- * daemon task. The function must conform to the PendedFunction_t\r
- * prototype.\r
- *\r
- * @param pvParameter1 The value of the callback function's first parameter.\r
- * The parameter has a void * type to allow it to be used to pass any type.\r
- * For example, unsigned longs can be cast to a void *, or the void * can be\r
- * used to point to a structure.\r
- *\r
- * @param ulParameter2 The value of the callback function's second parameter.\r
- *\r
- * @param xTicksToWait Calling this function will result in a message being\r
- * sent to the timer daemon task on a queue. xTicksToWait is the amount of\r
- * time the calling task should remain in the Blocked state (so not using any\r
- * processing time) for space to become available on the timer queue if the\r
- * queue is found to be full.\r
- *\r
- * @return pdPASS is returned if the message was successfully sent to the\r
- * timer daemon task, otherwise pdFALSE is returned.\r
- *\r
- */\r
-BaseType_t xTimerPendFunctionCall( PendedFunction_t xFunctionToPend, void *pvParameter1, uint32_t ulParameter2, TickType_t xTicksToWait ) PRIVILEGED_FUNCTION;\r
-\r
-/**\r
- * const char * const pcTimerGetName( TimerHandle_t xTimer );\r
- *\r
- * Returns the name that was assigned to a timer when the timer was created.\r
- *\r
- * @param xTimer The handle of the timer being queried.\r
- *\r
- * @return The name assigned to the timer specified by the xTimer parameter.\r
- */\r
-const char * pcTimerGetName( TimerHandle_t xTimer ) PRIVILEGED_FUNCTION; /*lint !e971 Unqualified char types are allowed for strings and single characters only. */\r
-\r
-/**\r
- * TickType_t xTimerGetPeriod( TimerHandle_t xTimer );\r
- *\r
- * Returns the period of a timer.\r
- *\r
- * @param xTimer The handle of the timer being queried.\r
- *\r
- * @return The period of the timer in ticks.\r
- */\r
-TickType_t xTimerGetPeriod( TimerHandle_t xTimer ) PRIVILEGED_FUNCTION;\r
-\r
-/**\r
-* TickType_t xTimerGetExpiryTime( TimerHandle_t xTimer );\r
-*\r
-* Returns the time in ticks at which the timer will expire. If this is less\r
-* than the current tick count then the expiry time has overflowed from the\r
-* current time.\r
-*\r
-* @param xTimer The handle of the timer being queried.\r
-*\r
-* @return If the timer is running then the time in ticks at which the timer\r
-* will next expire is returned. If the timer is not running then the return\r
-* value is undefined.\r
-*/\r
-TickType_t xTimerGetExpiryTime( TimerHandle_t xTimer ) PRIVILEGED_FUNCTION;\r
-\r
-/*\r
- * Functions beyond this part are not part of the public API and are intended\r
- * for use by the kernel only.\r
- */\r
-BaseType_t xTimerCreateTimerTask( void ) PRIVILEGED_FUNCTION;\r
-BaseType_t xTimerGenericCommand( TimerHandle_t xTimer, const BaseType_t xCommandID, const TickType_t xOptionalValue, BaseType_t * const pxHigherPriorityTaskWoken, const TickType_t xTicksToWait ) PRIVILEGED_FUNCTION;\r
-\r
-#if( configUSE_TRACE_FACILITY == 1 )\r
- void vTimerSetTimerNumber( TimerHandle_t xTimer, UBaseType_t uxTimerNumber ) PRIVILEGED_FUNCTION;\r
- UBaseType_t uxTimerGetTimerNumber( TimerHandle_t xTimer ) PRIVILEGED_FUNCTION;\r
-#endif\r
-\r
-#ifdef __cplusplus\r
-}\r
-#endif\r
-#endif /* TIMERS_H */\r
-\r
-\r
-\r
+++ /dev/null
-/*\r
- * FreeRTOS Kernel V10.0.1\r
- * Copyright (C) 2017 Amazon.com, Inc. or its affiliates. All Rights Reserved.\r
- *\r
- * Permission is hereby granted, free of charge, to any person obtaining a copy of\r
- * this software and associated documentation files (the "Software"), to deal in\r
- * the Software without restriction, including without limitation the rights to\r
- * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of\r
- * the Software, and to permit persons to whom the Software is furnished to do so,\r
- * subject to the following conditions:\r
- *\r
- * The above copyright notice and this permission notice shall be included in all\r
- * copies or substantial portions of the Software.\r
- *\r
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\r
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS\r
- * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR\r
- * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER\r
- * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN\r
- * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\r
- *\r
- * http://www.FreeRTOS.org\r
- * http://aws.amazon.com/freertos\r
- *\r
- * 1 tab == 4 spaces!\r
- */\r
-\r
-\r
-#include <stdlib.h>\r
-#include "FreeRTOS.h"\r
-#include "list.h"\r
-\r
-/*-----------------------------------------------------------\r
- * PUBLIC LIST API documented in list.h\r
- *----------------------------------------------------------*/\r
-\r
-void vListInitialise( List_t * const pxList )\r
-{\r
- /* The list structure contains a list item which is used to mark the\r
- end of the list. To initialise the list the list end is inserted\r
- as the only list entry. */\r
- pxList->pxIndex = ( ListItem_t * ) &( pxList->xListEnd ); /*lint !e826 !e740 The mini list structure is used as the list end to save RAM. This is checked and valid. */\r
-\r
- /* The list end value is the highest possible value in the list to\r
- ensure it remains at the end of the list. */\r
- pxList->xListEnd.xItemValue = portMAX_DELAY;\r
-\r
- /* The list end next and previous pointers point to itself so we know\r
- when the list is empty. */\r
- pxList->xListEnd.pxNext = ( ListItem_t * ) &( pxList->xListEnd ); /*lint !e826 !e740 The mini list structure is used as the list end to save RAM. This is checked and valid. */\r
- pxList->xListEnd.pxPrevious = ( ListItem_t * ) &( pxList->xListEnd );/*lint !e826 !e740 The mini list structure is used as the list end to save RAM. This is checked and valid. */\r
-\r
- pxList->uxNumberOfItems = ( UBaseType_t ) 0U;\r
-\r
- /* Write known values into the list if\r
- configUSE_LIST_DATA_INTEGRITY_CHECK_BYTES is set to 1. */\r
- listSET_LIST_INTEGRITY_CHECK_1_VALUE( pxList );\r
- listSET_LIST_INTEGRITY_CHECK_2_VALUE( pxList );\r
-}\r
-/*-----------------------------------------------------------*/\r
-\r
-void vListInitialiseItem( ListItem_t * const pxItem )\r
-{\r
- /* Make sure the list item is not recorded as being on a list. */\r
- pxItem->pvContainer = NULL;\r
-\r
- /* Write known values into the list item if\r
- configUSE_LIST_DATA_INTEGRITY_CHECK_BYTES is set to 1. */\r
- listSET_FIRST_LIST_ITEM_INTEGRITY_CHECK_VALUE( pxItem );\r
- listSET_SECOND_LIST_ITEM_INTEGRITY_CHECK_VALUE( pxItem );\r
-}\r
-/*-----------------------------------------------------------*/\r
-\r
-void vListInsertEnd( List_t * const pxList, ListItem_t * const pxNewListItem )\r
-{\r
-ListItem_t * const pxIndex = pxList->pxIndex;\r
-\r
- /* Only effective when configASSERT() is also defined, these tests may catch\r
- the list data structures being overwritten in memory. They will not catch\r
- data errors caused by incorrect configuration or use of FreeRTOS. */\r
- listTEST_LIST_INTEGRITY( pxList );\r
- listTEST_LIST_ITEM_INTEGRITY( pxNewListItem );\r
-\r
- /* Insert a new list item into pxList, but rather than sort the list,\r
- makes the new list item the last item to be removed by a call to\r
- listGET_OWNER_OF_NEXT_ENTRY(). */\r
- pxNewListItem->pxNext = pxIndex;\r
- pxNewListItem->pxPrevious = pxIndex->pxPrevious;\r
-\r
- /* Only used during decision coverage testing. */\r
- mtCOVERAGE_TEST_DELAY();\r
-\r
- pxIndex->pxPrevious->pxNext = pxNewListItem;\r
- pxIndex->pxPrevious = pxNewListItem;\r
-\r
- /* Remember which list the item is in. */\r
- pxNewListItem->pvContainer = ( void * ) pxList;\r
-\r
- ( pxList->uxNumberOfItems )++;\r
-}\r
-/*-----------------------------------------------------------*/\r
-\r
-void vListInsert( List_t * const pxList, ListItem_t * const pxNewListItem )\r
-{\r
-ListItem_t *pxIterator;\r
-const TickType_t xValueOfInsertion = pxNewListItem->xItemValue;\r
-\r
- /* Only effective when configASSERT() is also defined, these tests may catch\r
- the list data structures being overwritten in memory. They will not catch\r
- data errors caused by incorrect configuration or use of FreeRTOS. */\r
- listTEST_LIST_INTEGRITY( pxList );\r
- listTEST_LIST_ITEM_INTEGRITY( pxNewListItem );\r
-\r
- /* Insert the new list item into the list, sorted in xItemValue order.\r
-\r
- If the list already contains a list item with the same item value then the\r
- new list item should be placed after it. This ensures that TCB's which are\r
- stored in ready lists (all of which have the same xItemValue value) get a\r
- share of the CPU. However, if the xItemValue is the same as the back marker\r
- the iteration loop below will not end. Therefore the value is checked\r
- first, and the algorithm slightly modified if necessary. */\r
- if( xValueOfInsertion == portMAX_DELAY )\r
- {\r
- pxIterator = pxList->xListEnd.pxPrevious;\r
- }\r
- else\r
- {\r
- /* *** NOTE ***********************************************************\r
- If you find your application is crashing here then likely causes are\r
- listed below. In addition see http://www.freertos.org/FAQHelp.html for\r
- more tips, and ensure configASSERT() is defined!\r
- http://www.freertos.org/a00110.html#configASSERT\r
-\r
- 1) Stack overflow -\r
- see http://www.freertos.org/Stacks-and-stack-overflow-checking.html\r
- 2) Incorrect interrupt priority assignment, especially on Cortex-M\r
- parts where numerically high priority values denote low actual\r
- interrupt priorities, which can seem counter intuitive. See\r
- http://www.freertos.org/RTOS-Cortex-M3-M4.html and the definition\r
- of configMAX_SYSCALL_INTERRUPT_PRIORITY on\r
- http://www.freertos.org/a00110.html\r
- 3) Calling an API function from within a critical section or when\r
- the scheduler is suspended, or calling an API function that does\r
- not end in "FromISR" from an interrupt.\r
- 4) Using a queue or semaphore before it has been initialised or\r
- before the scheduler has been started (are interrupts firing\r
- before vTaskStartScheduler() has been called?).\r
- **********************************************************************/\r
-\r
- for( pxIterator = ( ListItem_t * ) &( pxList->xListEnd ); pxIterator->pxNext->xItemValue <= xValueOfInsertion; pxIterator = pxIterator->pxNext ) /*lint !e826 !e740 The mini list structure is used as the list end to save RAM. This is checked and valid. */\r
- {\r
- /* There is nothing to do here, just iterating to the wanted\r
- insertion position. */\r
- }\r
- }\r
-\r
- pxNewListItem->pxNext = pxIterator->pxNext;\r
- pxNewListItem->pxNext->pxPrevious = pxNewListItem;\r
- pxNewListItem->pxPrevious = pxIterator;\r
- pxIterator->pxNext = pxNewListItem;\r
-\r
- /* Remember which list the item is in. This allows fast removal of the\r
- item later. */\r
- pxNewListItem->pvContainer = ( void * ) pxList;\r
-\r
- ( pxList->uxNumberOfItems )++;\r
-}\r
-/*-----------------------------------------------------------*/\r
-\r
-UBaseType_t uxListRemove( ListItem_t * const pxItemToRemove )\r
-{\r
-/* The list item knows which list it is in. Obtain the list from the list\r
-item. */\r
-List_t * const pxList = ( List_t * ) pxItemToRemove->pvContainer;\r
-\r
- pxItemToRemove->pxNext->pxPrevious = pxItemToRemove->pxPrevious;\r
- pxItemToRemove->pxPrevious->pxNext = pxItemToRemove->pxNext;\r
-\r
- /* Only used during decision coverage testing. */\r
- mtCOVERAGE_TEST_DELAY();\r
-\r
- /* Make sure the index is left pointing to a valid item. */\r
- if( pxList->pxIndex == pxItemToRemove )\r
- {\r
- pxList->pxIndex = pxItemToRemove->pxPrevious;\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
-\r
- pxItemToRemove->pvContainer = NULL;\r
- ( pxList->uxNumberOfItems )--;\r
-\r
- return pxList->uxNumberOfItems;\r
-}\r
-/*-----------------------------------------------------------*/\r
-\r
+++ /dev/null
-/*\r
- * FreeRTOS Kernel V10.0.1\r
- * Copyright (C) 2017 Amazon.com, Inc. or its affiliates. All Rights Reserved.\r
- *\r
- * Permission is hereby granted, free of charge, to any person obtaining a copy of\r
- * this software and associated documentation files (the "Software"), to deal in\r
- * the Software without restriction, including without limitation the rights to\r
- * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of\r
- * the Software, and to permit persons to whom the Software is furnished to do so,\r
- * subject to the following conditions:\r
- *\r
- * The above copyright notice and this permission notice shall be included in all\r
- * copies or substantial portions of the Software.\r
- *\r
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\r
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS\r
- * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR\r
- * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER\r
- * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN\r
- * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\r
- *\r
- * http://www.FreeRTOS.org\r
- * http://aws.amazon.com/freertos\r
- *\r
- * 1 tab == 4 spaces!\r
- */\r
-\r
-#include <stdlib.h>\r
-#include <string.h>\r
-\r
-/* Defining MPU_WRAPPERS_INCLUDED_FROM_API_FILE prevents task.h from redefining\r
-all the API functions to use the MPU wrappers. That should only be done when\r
-task.h is included from an application file. */\r
-#define MPU_WRAPPERS_INCLUDED_FROM_API_FILE\r
-\r
-#include "FreeRTOS.h"\r
-#include "task.h"\r
-#include "queue.h"\r
-\r
-#if ( configUSE_CO_ROUTINES == 1 )\r
- #include "croutine.h"\r
-#endif\r
-\r
-/* Lint e961 and e750 are suppressed as a MISRA exception justified because the\r
-MPU ports require MPU_WRAPPERS_INCLUDED_FROM_API_FILE to be defined for the\r
-header files above, but not in this file, in order to generate the correct\r
-privileged Vs unprivileged linkage and placement. */\r
-#undef MPU_WRAPPERS_INCLUDED_FROM_API_FILE /*lint !e961 !e750. */\r
-\r
-\r
-/* Constants used with the cRxLock and cTxLock structure members. */\r
-#define queueUNLOCKED ( ( int8_t ) -1 )\r
-#define queueLOCKED_UNMODIFIED ( ( int8_t ) 0 )\r
-\r
-/* When the Queue_t structure is used to represent a base queue its pcHead and\r
-pcTail members are used as pointers into the queue storage area. When the\r
-Queue_t structure is used to represent a mutex pcHead and pcTail pointers are\r
-not necessary, and the pcHead pointer is set to NULL to indicate that the\r
-pcTail pointer actually points to the mutex holder (if any). Map alternative\r
-names to the pcHead and pcTail structure members to ensure the readability of\r
-the code is maintained despite this dual use of two structure members. An\r
-alternative implementation would be to use a union, but use of a union is\r
-against the coding standard (although an exception to the standard has been\r
-permitted where the dual use also significantly changes the type of the\r
-structure member). */\r
-#define pxMutexHolder pcTail\r
-#define uxQueueType pcHead\r
-#define queueQUEUE_IS_MUTEX NULL\r
-\r
-/* Semaphores do not actually store or copy data, so have an item size of\r
-zero. */\r
-#define queueSEMAPHORE_QUEUE_ITEM_LENGTH ( ( UBaseType_t ) 0 )\r
-#define queueMUTEX_GIVE_BLOCK_TIME ( ( TickType_t ) 0U )\r
-\r
-#if( configUSE_PREEMPTION == 0 )\r
- /* If the cooperative scheduler is being used then a yield should not be\r
- performed just because a higher priority task has been woken. */\r
- #define queueYIELD_IF_USING_PREEMPTION()\r
-#else\r
- #define queueYIELD_IF_USING_PREEMPTION() portYIELD_WITHIN_API()\r
-#endif\r
-\r
-/*\r
- * Definition of the queue used by the scheduler.\r
- * Items are queued by copy, not reference. See the following link for the\r
- * rationale: http://www.freertos.org/Embedded-RTOS-Queues.html\r
- */\r
-typedef struct QueueDefinition\r
-{\r
- int8_t *pcHead; /*< Points to the beginning of the queue storage area. */\r
- int8_t *pcTail; /*< Points to the byte at the end of the queue storage area. Once more byte is allocated than necessary to store the queue items, this is used as a marker. */\r
- int8_t *pcWriteTo; /*< Points to the free next place in the storage area. */\r
-\r
- union /* Use of a union is an exception to the coding standard to ensure two mutually exclusive structure members don't appear simultaneously (wasting RAM). */\r
- {\r
- int8_t *pcReadFrom; /*< Points to the last place that a queued item was read from when the structure is used as a queue. */\r
- UBaseType_t uxRecursiveCallCount;/*< Maintains a count of the number of times a recursive mutex has been recursively 'taken' when the structure is used as a mutex. */\r
- } u;\r
-\r
- List_t xTasksWaitingToSend; /*< List of tasks that are blocked waiting to post onto this queue. Stored in priority order. */\r
- List_t xTasksWaitingToReceive; /*< List of tasks that are blocked waiting to read from this queue. Stored in priority order. */\r
-\r
- volatile UBaseType_t uxMessagesWaiting;/*< The number of items currently in the queue. */\r
- UBaseType_t uxLength; /*< The length of the queue defined as the number of items it will hold, not the number of bytes. */\r
- UBaseType_t uxItemSize; /*< The size of each items that the queue will hold. */\r
-\r
- volatile int8_t cRxLock; /*< Stores the number of items received from the queue (removed from the queue) while the queue was locked. Set to queueUNLOCKED when the queue is not locked. */\r
- volatile int8_t cTxLock; /*< Stores the number of items transmitted to the queue (added to the queue) while the queue was locked. Set to queueUNLOCKED when the queue is not locked. */\r
-\r
- #if( ( configSUPPORT_STATIC_ALLOCATION == 1 ) && ( configSUPPORT_DYNAMIC_ALLOCATION == 1 ) )\r
- uint8_t ucStaticallyAllocated; /*< Set to pdTRUE if the memory used by the queue was statically allocated to ensure no attempt is made to free the memory. */\r
- #endif\r
-\r
- #if ( configUSE_QUEUE_SETS == 1 )\r
- struct QueueDefinition *pxQueueSetContainer;\r
- #endif\r
-\r
- #if ( configUSE_TRACE_FACILITY == 1 )\r
- UBaseType_t uxQueueNumber;\r
- uint8_t ucQueueType;\r
- #endif\r
-\r
-} xQUEUE;\r
-\r
-/* The old xQUEUE name is maintained above then typedefed to the new Queue_t\r
-name below to enable the use of older kernel aware debuggers. */\r
-typedef xQUEUE Queue_t;\r
-\r
-/*-----------------------------------------------------------*/\r
-\r
-/*\r
- * The queue registry is just a means for kernel aware debuggers to locate\r
- * queue structures. It has no other purpose so is an optional component.\r
- */\r
-#if ( configQUEUE_REGISTRY_SIZE > 0 )\r
-\r
- /* The type stored within the queue registry array. This allows a name\r
- to be assigned to each queue making kernel aware debugging a little\r
- more user friendly. */\r
- typedef struct QUEUE_REGISTRY_ITEM\r
- {\r
- const char *pcQueueName; /*lint !e971 Unqualified char types are allowed for strings and single characters only. */\r
- QueueHandle_t xHandle;\r
- } xQueueRegistryItem;\r
-\r
- /* The old xQueueRegistryItem name is maintained above then typedefed to the\r
- new xQueueRegistryItem name below to enable the use of older kernel aware\r
- debuggers. */\r
- typedef xQueueRegistryItem QueueRegistryItem_t;\r
-\r
- /* The queue registry is simply an array of QueueRegistryItem_t structures.\r
- The pcQueueName member of a structure being NULL is indicative of the\r
- array position being vacant. */\r
- PRIVILEGED_DATA QueueRegistryItem_t xQueueRegistry[ configQUEUE_REGISTRY_SIZE ];\r
-\r
-#endif /* configQUEUE_REGISTRY_SIZE */\r
-\r
-/*\r
- * Unlocks a queue locked by a call to prvLockQueue. Locking a queue does not\r
- * prevent an ISR from adding or removing items to the queue, but does prevent\r
- * an ISR from removing tasks from the queue event lists. If an ISR finds a\r
- * queue is locked it will instead increment the appropriate queue lock count\r
- * to indicate that a task may require unblocking. When the queue in unlocked\r
- * these lock counts are inspected, and the appropriate action taken.\r
- */\r
-static void prvUnlockQueue( Queue_t * const pxQueue ) PRIVILEGED_FUNCTION;\r
-\r
-/*\r
- * Uses a critical section to determine if there is any data in a queue.\r
- *\r
- * @return pdTRUE if the queue contains no items, otherwise pdFALSE.\r
- */\r
-static BaseType_t prvIsQueueEmpty( const Queue_t *pxQueue ) PRIVILEGED_FUNCTION;\r
-\r
-/*\r
- * Uses a critical section to determine if there is any space in a queue.\r
- *\r
- * @return pdTRUE if there is no space, otherwise pdFALSE;\r
- */\r
-static BaseType_t prvIsQueueFull( const Queue_t *pxQueue ) PRIVILEGED_FUNCTION;\r
-\r
-/*\r
- * Copies an item into the queue, either at the front of the queue or the\r
- * back of the queue.\r
- */\r
-static BaseType_t prvCopyDataToQueue( Queue_t * const pxQueue, const void *pvItemToQueue, const BaseType_t xPosition ) PRIVILEGED_FUNCTION;\r
-\r
-/*\r
- * Copies an item out of a queue.\r
- */\r
-static void prvCopyDataFromQueue( Queue_t * const pxQueue, void * const pvBuffer ) PRIVILEGED_FUNCTION;\r
-\r
-#if ( configUSE_QUEUE_SETS == 1 )\r
- /*\r
- * Checks to see if a queue is a member of a queue set, and if so, notifies\r
- * the queue set that the queue contains data.\r
- */\r
- static BaseType_t prvNotifyQueueSetContainer( const Queue_t * const pxQueue, const BaseType_t xCopyPosition ) PRIVILEGED_FUNCTION;\r
-#endif\r
-\r
-/*\r
- * Called after a Queue_t structure has been allocated either statically or\r
- * dynamically to fill in the structure's members.\r
- */\r
-static void prvInitialiseNewQueue( const UBaseType_t uxQueueLength, const UBaseType_t uxItemSize, uint8_t *pucQueueStorage, const uint8_t ucQueueType, Queue_t *pxNewQueue ) PRIVILEGED_FUNCTION;\r
-\r
-/*\r
- * Mutexes are a special type of queue. When a mutex is created, first the\r
- * queue is created, then prvInitialiseMutex() is called to configure the queue\r
- * as a mutex.\r
- */\r
-#if( configUSE_MUTEXES == 1 )\r
- static void prvInitialiseMutex( Queue_t *pxNewQueue ) PRIVILEGED_FUNCTION;\r
-#endif\r
-\r
-#if( configUSE_MUTEXES == 1 )\r
- /*\r
- * If a task waiting for a mutex causes the mutex holder to inherit a\r
- * priority, but the waiting task times out, then the holder should\r
- * disinherit the priority - but only down to the highest priority of any\r
- * other tasks that are waiting for the same mutex. This function returns\r
- * that priority.\r
- */\r
- static UBaseType_t prvGetDisinheritPriorityAfterTimeout( const Queue_t * const pxQueue ) PRIVILEGED_FUNCTION;\r
-#endif\r
-/*-----------------------------------------------------------*/\r
-\r
-/*\r
- * Macro to mark a queue as locked. Locking a queue prevents an ISR from\r
- * accessing the queue event lists.\r
- */\r
-#define prvLockQueue( pxQueue ) \\r
- taskENTER_CRITICAL(); \\r
- { \\r
- if( ( pxQueue )->cRxLock == queueUNLOCKED ) \\r
- { \\r
- ( pxQueue )->cRxLock = queueLOCKED_UNMODIFIED; \\r
- } \\r
- if( ( pxQueue )->cTxLock == queueUNLOCKED ) \\r
- { \\r
- ( pxQueue )->cTxLock = queueLOCKED_UNMODIFIED; \\r
- } \\r
- } \\r
- taskEXIT_CRITICAL()\r
-/*-----------------------------------------------------------*/\r
-\r
-BaseType_t xQueueGenericReset( QueueHandle_t xQueue, BaseType_t xNewQueue )\r
-{\r
-Queue_t * const pxQueue = ( Queue_t * ) xQueue;\r
-\r
- configASSERT( pxQueue );\r
-\r
- taskENTER_CRITICAL();\r
- {\r
- pxQueue->pcTail = pxQueue->pcHead + ( pxQueue->uxLength * pxQueue->uxItemSize );\r
- pxQueue->uxMessagesWaiting = ( UBaseType_t ) 0U;\r
- pxQueue->pcWriteTo = pxQueue->pcHead;\r
- pxQueue->u.pcReadFrom = pxQueue->pcHead + ( ( pxQueue->uxLength - ( UBaseType_t ) 1U ) * pxQueue->uxItemSize );\r
- pxQueue->cRxLock = queueUNLOCKED;\r
- pxQueue->cTxLock = queueUNLOCKED;\r
-\r
- if( xNewQueue == pdFALSE )\r
- {\r
- /* If there are tasks blocked waiting to read from the queue, then\r
- the tasks will remain blocked as after this function exits the queue\r
- will still be empty. If there are tasks blocked waiting to write to\r
- the queue, then one should be unblocked as after this function exits\r
- it will be possible to write to it. */\r
- if( listLIST_IS_EMPTY( &( pxQueue->xTasksWaitingToSend ) ) == pdFALSE )\r
- {\r
- if( xTaskRemoveFromEventList( &( pxQueue->xTasksWaitingToSend ) ) != pdFALSE )\r
- {\r
- queueYIELD_IF_USING_PREEMPTION();\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- else\r
- {\r
- /* Ensure the event queues start in the correct state. */\r
- vListInitialise( &( pxQueue->xTasksWaitingToSend ) );\r
- vListInitialise( &( pxQueue->xTasksWaitingToReceive ) );\r
- }\r
- }\r
- taskEXIT_CRITICAL();\r
-\r
- /* A value is returned for calling semantic consistency with previous\r
- versions. */\r
- return pdPASS;\r
-}\r
-/*-----------------------------------------------------------*/\r
-\r
-#if( configSUPPORT_STATIC_ALLOCATION == 1 )\r
-\r
- QueueHandle_t xQueueGenericCreateStatic( const UBaseType_t uxQueueLength, const UBaseType_t uxItemSize, uint8_t *pucQueueStorage, StaticQueue_t *pxStaticQueue, const uint8_t ucQueueType )\r
- {\r
- Queue_t *pxNewQueue;\r
-\r
- configASSERT( uxQueueLength > ( UBaseType_t ) 0 );\r
-\r
- /* The StaticQueue_t structure and the queue storage area must be\r
- supplied. */\r
- configASSERT( pxStaticQueue != NULL );\r
-\r
- /* A queue storage area should be provided if the item size is not 0, and\r
- should not be provided if the item size is 0. */\r
- configASSERT( !( ( pucQueueStorage != NULL ) && ( uxItemSize == 0 ) ) );\r
- configASSERT( !( ( pucQueueStorage == NULL ) && ( uxItemSize != 0 ) ) );\r
-\r
- #if( configASSERT_DEFINED == 1 )\r
- {\r
- /* Sanity check that the size of the structure used to declare a\r
- variable of type StaticQueue_t or StaticSemaphore_t equals the size of\r
- the real queue and semaphore structures. */\r
- volatile size_t xSize = sizeof( StaticQueue_t );\r
- configASSERT( xSize == sizeof( Queue_t ) );\r
- }\r
- #endif /* configASSERT_DEFINED */\r
-\r
- /* The address of a statically allocated queue was passed in, use it.\r
- The address of a statically allocated storage area was also passed in\r
- but is already set. */\r
- pxNewQueue = ( Queue_t * ) pxStaticQueue; /*lint !e740 Unusual cast is ok as the structures are designed to have the same alignment, and the size is checked by an assert. */\r
-\r
- if( pxNewQueue != NULL )\r
- {\r
- #if( configSUPPORT_DYNAMIC_ALLOCATION == 1 )\r
- {\r
- /* Queues can be allocated wither statically or dynamically, so\r
- note this queue was allocated statically in case the queue is\r
- later deleted. */\r
- pxNewQueue->ucStaticallyAllocated = pdTRUE;\r
- }\r
- #endif /* configSUPPORT_DYNAMIC_ALLOCATION */\r
-\r
- prvInitialiseNewQueue( uxQueueLength, uxItemSize, pucQueueStorage, ucQueueType, pxNewQueue );\r
- }\r
- else\r
- {\r
- traceQUEUE_CREATE_FAILED( ucQueueType );\r
- }\r
-\r
- return pxNewQueue;\r
- }\r
-\r
-#endif /* configSUPPORT_STATIC_ALLOCATION */\r
-/*-----------------------------------------------------------*/\r
-\r
-#if( configSUPPORT_DYNAMIC_ALLOCATION == 1 )\r
-\r
- QueueHandle_t xQueueGenericCreate( const UBaseType_t uxQueueLength, const UBaseType_t uxItemSize, const uint8_t ucQueueType )\r
- {\r
- Queue_t *pxNewQueue;\r
- size_t xQueueSizeInBytes;\r
- uint8_t *pucQueueStorage;\r
-\r
- configASSERT( uxQueueLength > ( UBaseType_t ) 0 );\r
-\r
- if( uxItemSize == ( UBaseType_t ) 0 )\r
- {\r
- /* There is not going to be a queue storage area. */\r
- xQueueSizeInBytes = ( size_t ) 0;\r
- }\r
- else\r
- {\r
- /* Allocate enough space to hold the maximum number of items that\r
- can be in the queue at any time. */\r
- xQueueSizeInBytes = ( size_t ) ( uxQueueLength * uxItemSize ); /*lint !e961 MISRA exception as the casts are only redundant for some ports. */\r
- }\r
-\r
- pxNewQueue = ( Queue_t * ) pvPortMalloc( sizeof( Queue_t ) + xQueueSizeInBytes );\r
-\r
- if( pxNewQueue != NULL )\r
- {\r
- /* Jump past the queue structure to find the location of the queue\r
- storage area. */\r
- pucQueueStorage = ( ( uint8_t * ) pxNewQueue ) + sizeof( Queue_t );\r
-\r
- #if( configSUPPORT_STATIC_ALLOCATION == 1 )\r
- {\r
- /* Queues can be created either statically or dynamically, so\r
- note this task was created dynamically in case it is later\r
- deleted. */\r
- pxNewQueue->ucStaticallyAllocated = pdFALSE;\r
- }\r
- #endif /* configSUPPORT_STATIC_ALLOCATION */\r
-\r
- prvInitialiseNewQueue( uxQueueLength, uxItemSize, pucQueueStorage, ucQueueType, pxNewQueue );\r
- }\r
- else\r
- {\r
- traceQUEUE_CREATE_FAILED( ucQueueType );\r
- }\r
-\r
- return pxNewQueue;\r
- }\r
-\r
-#endif /* configSUPPORT_STATIC_ALLOCATION */\r
-/*-----------------------------------------------------------*/\r
-\r
-static void prvInitialiseNewQueue( const UBaseType_t uxQueueLength, const UBaseType_t uxItemSize, uint8_t *pucQueueStorage, const uint8_t ucQueueType, Queue_t *pxNewQueue )\r
-{\r
- /* Remove compiler warnings about unused parameters should\r
- configUSE_TRACE_FACILITY not be set to 1. */\r
- ( void ) ucQueueType;\r
-\r
- if( uxItemSize == ( UBaseType_t ) 0 )\r
- {\r
- /* No RAM was allocated for the queue storage area, but PC head cannot\r
- be set to NULL because NULL is used as a key to say the queue is used as\r
- a mutex. Therefore just set pcHead to point to the queue as a benign\r
- value that is known to be within the memory map. */\r
- pxNewQueue->pcHead = ( int8_t * ) pxNewQueue;\r
- }\r
- else\r
- {\r
- /* Set the head to the start of the queue storage area. */\r
- pxNewQueue->pcHead = ( int8_t * ) pucQueueStorage;\r
- }\r
-\r
- /* Initialise the queue members as described where the queue type is\r
- defined. */\r
- pxNewQueue->uxLength = uxQueueLength;\r
- pxNewQueue->uxItemSize = uxItemSize;\r
- ( void ) xQueueGenericReset( pxNewQueue, pdTRUE );\r
-\r
- #if ( configUSE_TRACE_FACILITY == 1 )\r
- {\r
- pxNewQueue->ucQueueType = ucQueueType;\r
- }\r
- #endif /* configUSE_TRACE_FACILITY */\r
-\r
- #if( configUSE_QUEUE_SETS == 1 )\r
- {\r
- pxNewQueue->pxQueueSetContainer = NULL;\r
- }\r
- #endif /* configUSE_QUEUE_SETS */\r
-\r
- traceQUEUE_CREATE( pxNewQueue );\r
-}\r
-/*-----------------------------------------------------------*/\r
-\r
-#if( configUSE_MUTEXES == 1 )\r
-\r
- static void prvInitialiseMutex( Queue_t *pxNewQueue )\r
- {\r
- if( pxNewQueue != NULL )\r
- {\r
- /* The queue create function will set all the queue structure members\r
- correctly for a generic queue, but this function is creating a\r
- mutex. Overwrite those members that need to be set differently -\r
- in particular the information required for priority inheritance. */\r
- pxNewQueue->pxMutexHolder = NULL;\r
- pxNewQueue->uxQueueType = queueQUEUE_IS_MUTEX;\r
-\r
- /* In case this is a recursive mutex. */\r
- pxNewQueue->u.uxRecursiveCallCount = 0;\r
-\r
- traceCREATE_MUTEX( pxNewQueue );\r
-\r
- /* Start with the semaphore in the expected state. */\r
- ( void ) xQueueGenericSend( pxNewQueue, NULL, ( TickType_t ) 0U, queueSEND_TO_BACK );\r
- }\r
- else\r
- {\r
- traceCREATE_MUTEX_FAILED();\r
- }\r
- }\r
-\r
-#endif /* configUSE_MUTEXES */\r
-/*-----------------------------------------------------------*/\r
-\r
-#if( ( configUSE_MUTEXES == 1 ) && ( configSUPPORT_DYNAMIC_ALLOCATION == 1 ) )\r
-\r
- QueueHandle_t xQueueCreateMutex( const uint8_t ucQueueType )\r
- {\r
- Queue_t *pxNewQueue;\r
- const UBaseType_t uxMutexLength = ( UBaseType_t ) 1, uxMutexSize = ( UBaseType_t ) 0;\r
-\r
- pxNewQueue = ( Queue_t * ) xQueueGenericCreate( uxMutexLength, uxMutexSize, ucQueueType );\r
- prvInitialiseMutex( pxNewQueue );\r
-\r
- return pxNewQueue;\r
- }\r
-\r
-#endif /* configUSE_MUTEXES */\r
-/*-----------------------------------------------------------*/\r
-\r
-#if( ( configUSE_MUTEXES == 1 ) && ( configSUPPORT_STATIC_ALLOCATION == 1 ) )\r
-\r
- QueueHandle_t xQueueCreateMutexStatic( const uint8_t ucQueueType, StaticQueue_t *pxStaticQueue )\r
- {\r
- Queue_t *pxNewQueue;\r
- const UBaseType_t uxMutexLength = ( UBaseType_t ) 1, uxMutexSize = ( UBaseType_t ) 0;\r
-\r
- /* Prevent compiler warnings about unused parameters if\r
- configUSE_TRACE_FACILITY does not equal 1. */\r
- ( void ) ucQueueType;\r
-\r
- pxNewQueue = ( Queue_t * ) xQueueGenericCreateStatic( uxMutexLength, uxMutexSize, NULL, pxStaticQueue, ucQueueType );\r
- prvInitialiseMutex( pxNewQueue );\r
-\r
- return pxNewQueue;\r
- }\r
-\r
-#endif /* configUSE_MUTEXES */\r
-/*-----------------------------------------------------------*/\r
-\r
-#if ( ( configUSE_MUTEXES == 1 ) && ( INCLUDE_xSemaphoreGetMutexHolder == 1 ) )\r
-\r
- void* xQueueGetMutexHolder( QueueHandle_t xSemaphore )\r
- {\r
- void *pxReturn;\r
-\r
- /* This function is called by xSemaphoreGetMutexHolder(), and should not\r
- be called directly. Note: This is a good way of determining if the\r
- calling task is the mutex holder, but not a good way of determining the\r
- identity of the mutex holder, as the holder may change between the\r
- following critical section exiting and the function returning. */\r
- taskENTER_CRITICAL();\r
- {\r
- if( ( ( Queue_t * ) xSemaphore )->uxQueueType == queueQUEUE_IS_MUTEX )\r
- {\r
- pxReturn = ( void * ) ( ( Queue_t * ) xSemaphore )->pxMutexHolder;\r
- }\r
- else\r
- {\r
- pxReturn = NULL;\r
- }\r
- }\r
- taskEXIT_CRITICAL();\r
-\r
- return pxReturn;\r
- } /*lint !e818 xSemaphore cannot be a pointer to const because it is a typedef. */\r
-\r
-#endif\r
-/*-----------------------------------------------------------*/\r
-\r
-#if ( ( configUSE_MUTEXES == 1 ) && ( INCLUDE_xSemaphoreGetMutexHolder == 1 ) )\r
-\r
- void* xQueueGetMutexHolderFromISR( QueueHandle_t xSemaphore )\r
- {\r
- void *pxReturn;\r
-\r
- configASSERT( xSemaphore );\r
-\r
- /* Mutexes cannot be used in interrupt service routines, so the mutex\r
- holder should not change in an ISR, and therefore a critical section is\r
- not required here. */\r
- if( ( ( Queue_t * ) xSemaphore )->uxQueueType == queueQUEUE_IS_MUTEX )\r
- {\r
- pxReturn = ( void * ) ( ( Queue_t * ) xSemaphore )->pxMutexHolder;\r
- }\r
- else\r
- {\r
- pxReturn = NULL;\r
- }\r
-\r
- return pxReturn;\r
- } /*lint !e818 xSemaphore cannot be a pointer to const because it is a typedef. */\r
-\r
-#endif\r
-/*-----------------------------------------------------------*/\r
-\r
-#if ( configUSE_RECURSIVE_MUTEXES == 1 )\r
-\r
- BaseType_t xQueueGiveMutexRecursive( QueueHandle_t xMutex )\r
- {\r
- BaseType_t xReturn;\r
- Queue_t * const pxMutex = ( Queue_t * ) xMutex;\r
-\r
- configASSERT( pxMutex );\r
-\r
- /* If this is the task that holds the mutex then pxMutexHolder will not\r
- change outside of this task. If this task does not hold the mutex then\r
- pxMutexHolder can never coincidentally equal the tasks handle, and as\r
- this is the only condition we are interested in it does not matter if\r
- pxMutexHolder is accessed simultaneously by another task. Therefore no\r
- mutual exclusion is required to test the pxMutexHolder variable. */\r
- if( pxMutex->pxMutexHolder == ( void * ) xTaskGetCurrentTaskHandle() ) /*lint !e961 Not a redundant cast as TaskHandle_t is a typedef. */\r
- {\r
- traceGIVE_MUTEX_RECURSIVE( pxMutex );\r
-\r
- /* uxRecursiveCallCount cannot be zero if pxMutexHolder is equal to\r
- the task handle, therefore no underflow check is required. Also,\r
- uxRecursiveCallCount is only modified by the mutex holder, and as\r
- there can only be one, no mutual exclusion is required to modify the\r
- uxRecursiveCallCount member. */\r
- ( pxMutex->u.uxRecursiveCallCount )--;\r
-\r
- /* Has the recursive call count unwound to 0? */\r
- if( pxMutex->u.uxRecursiveCallCount == ( UBaseType_t ) 0 )\r
- {\r
- /* Return the mutex. This will automatically unblock any other\r
- task that might be waiting to access the mutex. */\r
- ( void ) xQueueGenericSend( pxMutex, NULL, queueMUTEX_GIVE_BLOCK_TIME, queueSEND_TO_BACK );\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
-\r
- xReturn = pdPASS;\r
- }\r
- else\r
- {\r
- /* The mutex cannot be given because the calling task is not the\r
- holder. */\r
- xReturn = pdFAIL;\r
-\r
- traceGIVE_MUTEX_RECURSIVE_FAILED( pxMutex );\r
- }\r
-\r
- return xReturn;\r
- }\r
-\r
-#endif /* configUSE_RECURSIVE_MUTEXES */\r
-/*-----------------------------------------------------------*/\r
-\r
-#if ( configUSE_RECURSIVE_MUTEXES == 1 )\r
-\r
- BaseType_t xQueueTakeMutexRecursive( QueueHandle_t xMutex, TickType_t xTicksToWait )\r
- {\r
- BaseType_t xReturn;\r
- Queue_t * const pxMutex = ( Queue_t * ) xMutex;\r
-\r
- configASSERT( pxMutex );\r
-\r
- /* Comments regarding mutual exclusion as per those within\r
- xQueueGiveMutexRecursive(). */\r
-\r
- traceTAKE_MUTEX_RECURSIVE( pxMutex );\r
-\r
- if( pxMutex->pxMutexHolder == ( void * ) xTaskGetCurrentTaskHandle() ) /*lint !e961 Cast is not redundant as TaskHandle_t is a typedef. */\r
- {\r
- ( pxMutex->u.uxRecursiveCallCount )++;\r
- xReturn = pdPASS;\r
- }\r
- else\r
- {\r
- xReturn = xQueueSemaphoreTake( pxMutex, xTicksToWait );\r
-\r
- /* pdPASS will only be returned if the mutex was successfully\r
- obtained. The calling task may have entered the Blocked state\r
- before reaching here. */\r
- if( xReturn != pdFAIL )\r
- {\r
- ( pxMutex->u.uxRecursiveCallCount )++;\r
- }\r
- else\r
- {\r
- traceTAKE_MUTEX_RECURSIVE_FAILED( pxMutex );\r
- }\r
- }\r
-\r
- return xReturn;\r
- }\r
-\r
-#endif /* configUSE_RECURSIVE_MUTEXES */\r
-/*-----------------------------------------------------------*/\r
-\r
-#if( ( configUSE_COUNTING_SEMAPHORES == 1 ) && ( configSUPPORT_STATIC_ALLOCATION == 1 ) )\r
-\r
- QueueHandle_t xQueueCreateCountingSemaphoreStatic( const UBaseType_t uxMaxCount, const UBaseType_t uxInitialCount, StaticQueue_t *pxStaticQueue )\r
- {\r
- QueueHandle_t xHandle;\r
-\r
- configASSERT( uxMaxCount != 0 );\r
- configASSERT( uxInitialCount <= uxMaxCount );\r
-\r
- xHandle = xQueueGenericCreateStatic( uxMaxCount, queueSEMAPHORE_QUEUE_ITEM_LENGTH, NULL, pxStaticQueue, queueQUEUE_TYPE_COUNTING_SEMAPHORE );\r
-\r
- if( xHandle != NULL )\r
- {\r
- ( ( Queue_t * ) xHandle )->uxMessagesWaiting = uxInitialCount;\r
-\r
- traceCREATE_COUNTING_SEMAPHORE();\r
- }\r
- else\r
- {\r
- traceCREATE_COUNTING_SEMAPHORE_FAILED();\r
- }\r
-\r
- return xHandle;\r
- }\r
-\r
-#endif /* ( ( configUSE_COUNTING_SEMAPHORES == 1 ) && ( configSUPPORT_DYNAMIC_ALLOCATION == 1 ) ) */\r
-/*-----------------------------------------------------------*/\r
-\r
-#if( ( configUSE_COUNTING_SEMAPHORES == 1 ) && ( configSUPPORT_DYNAMIC_ALLOCATION == 1 ) )\r
-\r
- QueueHandle_t xQueueCreateCountingSemaphore( const UBaseType_t uxMaxCount, const UBaseType_t uxInitialCount )\r
- {\r
- QueueHandle_t xHandle;\r
-\r
- configASSERT( uxMaxCount != 0 );\r
- configASSERT( uxInitialCount <= uxMaxCount );\r
-\r
- xHandle = xQueueGenericCreate( uxMaxCount, queueSEMAPHORE_QUEUE_ITEM_LENGTH, queueQUEUE_TYPE_COUNTING_SEMAPHORE );\r
-\r
- if( xHandle != NULL )\r
- {\r
- ( ( Queue_t * ) xHandle )->uxMessagesWaiting = uxInitialCount;\r
-\r
- traceCREATE_COUNTING_SEMAPHORE();\r
- }\r
- else\r
- {\r
- traceCREATE_COUNTING_SEMAPHORE_FAILED();\r
- }\r
-\r
- return xHandle;\r
- }\r
-\r
-#endif /* ( ( configUSE_COUNTING_SEMAPHORES == 1 ) && ( configSUPPORT_DYNAMIC_ALLOCATION == 1 ) ) */\r
-/*-----------------------------------------------------------*/\r
-\r
-BaseType_t xQueueGenericSend( QueueHandle_t xQueue, const void * const pvItemToQueue, TickType_t xTicksToWait, const BaseType_t xCopyPosition )\r
-{\r
-BaseType_t xEntryTimeSet = pdFALSE, xYieldRequired;\r
-TimeOut_t xTimeOut;\r
-Queue_t * const pxQueue = ( Queue_t * ) xQueue;\r
-\r
- configASSERT( pxQueue );\r
- configASSERT( !( ( pvItemToQueue == NULL ) && ( pxQueue->uxItemSize != ( UBaseType_t ) 0U ) ) );\r
- configASSERT( !( ( xCopyPosition == queueOVERWRITE ) && ( pxQueue->uxLength != 1 ) ) );\r
- #if ( ( INCLUDE_xTaskGetSchedulerState == 1 ) || ( configUSE_TIMERS == 1 ) )\r
- {\r
- configASSERT( !( ( xTaskGetSchedulerState() == taskSCHEDULER_SUSPENDED ) && ( xTicksToWait != 0 ) ) );\r
- }\r
- #endif\r
-\r
-\r
- /* This function relaxes the coding standard somewhat to allow return\r
- statements within the function itself. This is done in the interest\r
- of execution time efficiency. */\r
- for( ;; )\r
- {\r
- taskENTER_CRITICAL();\r
- {\r
- /* Is there room on the queue now? The running task must be the\r
- highest priority task wanting to access the queue. If the head item\r
- in the queue is to be overwritten then it does not matter if the\r
- queue is full. */\r
- if( ( pxQueue->uxMessagesWaiting < pxQueue->uxLength ) || ( xCopyPosition == queueOVERWRITE ) )\r
- {\r
- traceQUEUE_SEND( pxQueue );\r
- xYieldRequired = prvCopyDataToQueue( pxQueue, pvItemToQueue, xCopyPosition );\r
-\r
- #if ( configUSE_QUEUE_SETS == 1 )\r
- {\r
- if( pxQueue->pxQueueSetContainer != NULL )\r
- {\r
- if( prvNotifyQueueSetContainer( pxQueue, xCopyPosition ) != pdFALSE )\r
- {\r
- /* The queue is a member of a queue set, and posting\r
- to the queue set caused a higher priority task to\r
- unblock. A context switch is required. */\r
- queueYIELD_IF_USING_PREEMPTION();\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- else\r
- {\r
- /* If there was a task waiting for data to arrive on the\r
- queue then unblock it now. */\r
- if( listLIST_IS_EMPTY( &( pxQueue->xTasksWaitingToReceive ) ) == pdFALSE )\r
- {\r
- if( xTaskRemoveFromEventList( &( pxQueue->xTasksWaitingToReceive ) ) != pdFALSE )\r
- {\r
- /* The unblocked task has a priority higher than\r
- our own so yield immediately. Yes it is ok to\r
- do this from within the critical section - the\r
- kernel takes care of that. */\r
- queueYIELD_IF_USING_PREEMPTION();\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- else if( xYieldRequired != pdFALSE )\r
- {\r
- /* This path is a special case that will only get\r
- executed if the task was holding multiple mutexes\r
- and the mutexes were given back in an order that is\r
- different to that in which they were taken. */\r
- queueYIELD_IF_USING_PREEMPTION();\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- }\r
- #else /* configUSE_QUEUE_SETS */\r
- {\r
- /* If there was a task waiting for data to arrive on the\r
- queue then unblock it now. */\r
- if( listLIST_IS_EMPTY( &( pxQueue->xTasksWaitingToReceive ) ) == pdFALSE )\r
- {\r
- if( xTaskRemoveFromEventList( &( pxQueue->xTasksWaitingToReceive ) ) != pdFALSE )\r
- {\r
- /* The unblocked task has a priority higher than\r
- our own so yield immediately. Yes it is ok to do\r
- this from within the critical section - the kernel\r
- takes care of that. */\r
- queueYIELD_IF_USING_PREEMPTION();\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- else if( xYieldRequired != pdFALSE )\r
- {\r
- /* This path is a special case that will only get\r
- executed if the task was holding multiple mutexes and\r
- the mutexes were given back in an order that is\r
- different to that in which they were taken. */\r
- queueYIELD_IF_USING_PREEMPTION();\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- #endif /* configUSE_QUEUE_SETS */\r
-\r
- taskEXIT_CRITICAL();\r
- return pdPASS;\r
- }\r
- else\r
- {\r
- if( xTicksToWait == ( TickType_t ) 0 )\r
- {\r
- /* The queue was full and no block time is specified (or\r
- the block time has expired) so leave now. */\r
- taskEXIT_CRITICAL();\r
-\r
- /* Return to the original privilege level before exiting\r
- the function. */\r
- traceQUEUE_SEND_FAILED( pxQueue );\r
- return errQUEUE_FULL;\r
- }\r
- else if( xEntryTimeSet == pdFALSE )\r
- {\r
- /* The queue was full and a block time was specified so\r
- configure the timeout structure. */\r
- vTaskInternalSetTimeOutState( &xTimeOut );\r
- xEntryTimeSet = pdTRUE;\r
- }\r
- else\r
- {\r
- /* Entry time was already set. */\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- }\r
- taskEXIT_CRITICAL();\r
-\r
- /* Interrupts and other tasks can send to and receive from the queue\r
- now the critical section has been exited. */\r
-\r
- vTaskSuspendAll();\r
- prvLockQueue( pxQueue );\r
-\r
- /* Update the timeout state to see if it has expired yet. */\r
- if( xTaskCheckForTimeOut( &xTimeOut, &xTicksToWait ) == pdFALSE )\r
- {\r
- if( prvIsQueueFull( pxQueue ) != pdFALSE )\r
- {\r
- traceBLOCKING_ON_QUEUE_SEND( pxQueue );\r
- vTaskPlaceOnEventList( &( pxQueue->xTasksWaitingToSend ), xTicksToWait );\r
-\r
- /* Unlocking the queue means queue events can effect the\r
- event list. It is possible that interrupts occurring now\r
- remove this task from the event list again - but as the\r
- scheduler is suspended the task will go onto the pending\r
- ready last instead of the actual ready list. */\r
- prvUnlockQueue( pxQueue );\r
-\r
- /* Resuming the scheduler will move tasks from the pending\r
- ready list into the ready list - so it is feasible that this\r
- task is already in a ready list before it yields - in which\r
- case the yield will not cause a context switch unless there\r
- is also a higher priority task in the pending ready list. */\r
- if( xTaskResumeAll() == pdFALSE )\r
- {\r
- portYIELD_WITHIN_API();\r
- }\r
- }\r
- else\r
- {\r
- /* Try again. */\r
- prvUnlockQueue( pxQueue );\r
- ( void ) xTaskResumeAll();\r
- }\r
- }\r
- else\r
- {\r
- /* The timeout has expired. */\r
- prvUnlockQueue( pxQueue );\r
- ( void ) xTaskResumeAll();\r
-\r
- traceQUEUE_SEND_FAILED( pxQueue );\r
- return errQUEUE_FULL;\r
- }\r
- }\r
-}\r
-/*-----------------------------------------------------------*/\r
-\r
-BaseType_t xQueueGenericSendFromISR( QueueHandle_t xQueue, const void * const pvItemToQueue, BaseType_t * const pxHigherPriorityTaskWoken, const BaseType_t xCopyPosition )\r
-{\r
-BaseType_t xReturn;\r
-UBaseType_t uxSavedInterruptStatus;\r
-Queue_t * const pxQueue = ( Queue_t * ) xQueue;\r
-\r
- configASSERT( pxQueue );\r
- configASSERT( !( ( pvItemToQueue == NULL ) && ( pxQueue->uxItemSize != ( UBaseType_t ) 0U ) ) );\r
- configASSERT( !( ( xCopyPosition == queueOVERWRITE ) && ( pxQueue->uxLength != 1 ) ) );\r
-\r
- /* RTOS ports that support interrupt nesting have the concept of a maximum\r
- system call (or maximum API call) interrupt priority. Interrupts that are\r
- above the maximum system call priority are kept permanently enabled, even\r
- when the RTOS kernel is in a critical section, but cannot make any calls to\r
- FreeRTOS API functions. If configASSERT() is defined in FreeRTOSConfig.h\r
- then portASSERT_IF_INTERRUPT_PRIORITY_INVALID() will result in an assertion\r
- failure if a FreeRTOS API function is called from an interrupt that has been\r
- assigned a priority above the configured maximum system call priority.\r
- Only FreeRTOS functions that end in FromISR can be called from interrupts\r
- that have been assigned a priority at or (logically) below the maximum\r
- system call interrupt priority. FreeRTOS maintains a separate interrupt\r
- safe API to ensure interrupt entry is as fast and as simple as possible.\r
- More information (albeit Cortex-M specific) is provided on the following\r
- link: http://www.freertos.org/RTOS-Cortex-M3-M4.html */\r
- portASSERT_IF_INTERRUPT_PRIORITY_INVALID();\r
-\r
- /* Similar to xQueueGenericSend, except without blocking if there is no room\r
- in the queue. Also don't directly wake a task that was blocked on a queue\r
- read, instead return a flag to say whether a context switch is required or\r
- not (i.e. has a task with a higher priority than us been woken by this\r
- post). */\r
- uxSavedInterruptStatus = portSET_INTERRUPT_MASK_FROM_ISR();\r
- {\r
- if( ( pxQueue->uxMessagesWaiting < pxQueue->uxLength ) || ( xCopyPosition == queueOVERWRITE ) )\r
- {\r
- const int8_t cTxLock = pxQueue->cTxLock;\r
-\r
- traceQUEUE_SEND_FROM_ISR( pxQueue );\r
-\r
- /* Semaphores use xQueueGiveFromISR(), so pxQueue will not be a\r
- semaphore or mutex. That means prvCopyDataToQueue() cannot result\r
- in a task disinheriting a priority and prvCopyDataToQueue() can be\r
- called here even though the disinherit function does not check if\r
- the scheduler is suspended before accessing the ready lists. */\r
- ( void ) prvCopyDataToQueue( pxQueue, pvItemToQueue, xCopyPosition );\r
-\r
- /* The event list is not altered if the queue is locked. This will\r
- be done when the queue is unlocked later. */\r
- if( cTxLock == queueUNLOCKED )\r
- {\r
- #if ( configUSE_QUEUE_SETS == 1 )\r
- {\r
- if( pxQueue->pxQueueSetContainer != NULL )\r
- {\r
- if( prvNotifyQueueSetContainer( pxQueue, xCopyPosition ) != pdFALSE )\r
- {\r
- /* The queue is a member of a queue set, and posting\r
- to the queue set caused a higher priority task to\r
- unblock. A context switch is required. */\r
- if( pxHigherPriorityTaskWoken != NULL )\r
- {\r
- *pxHigherPriorityTaskWoken = pdTRUE;\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- else\r
- {\r
- if( listLIST_IS_EMPTY( &( pxQueue->xTasksWaitingToReceive ) ) == pdFALSE )\r
- {\r
- if( xTaskRemoveFromEventList( &( pxQueue->xTasksWaitingToReceive ) ) != pdFALSE )\r
- {\r
- /* The task waiting has a higher priority so\r
- record that a context switch is required. */\r
- if( pxHigherPriorityTaskWoken != NULL )\r
- {\r
- *pxHigherPriorityTaskWoken = pdTRUE;\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- }\r
- #else /* configUSE_QUEUE_SETS */\r
- {\r
- if( listLIST_IS_EMPTY( &( pxQueue->xTasksWaitingToReceive ) ) == pdFALSE )\r
- {\r
- if( xTaskRemoveFromEventList( &( pxQueue->xTasksWaitingToReceive ) ) != pdFALSE )\r
- {\r
- /* The task waiting has a higher priority so record that a\r
- context switch is required. */\r
- if( pxHigherPriorityTaskWoken != NULL )\r
- {\r
- *pxHigherPriorityTaskWoken = pdTRUE;\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- #endif /* configUSE_QUEUE_SETS */\r
- }\r
- else\r
- {\r
- /* Increment the lock count so the task that unlocks the queue\r
- knows that data was posted while it was locked. */\r
- pxQueue->cTxLock = ( int8_t ) ( cTxLock + 1 );\r
- }\r
-\r
- xReturn = pdPASS;\r
- }\r
- else\r
- {\r
- traceQUEUE_SEND_FROM_ISR_FAILED( pxQueue );\r
- xReturn = errQUEUE_FULL;\r
- }\r
- }\r
- portCLEAR_INTERRUPT_MASK_FROM_ISR( uxSavedInterruptStatus );\r
-\r
- return xReturn;\r
-}\r
-/*-----------------------------------------------------------*/\r
-\r
-BaseType_t xQueueGiveFromISR( QueueHandle_t xQueue, BaseType_t * const pxHigherPriorityTaskWoken )\r
-{\r
-BaseType_t xReturn;\r
-UBaseType_t uxSavedInterruptStatus;\r
-Queue_t * const pxQueue = ( Queue_t * ) xQueue;\r
-\r
- /* Similar to xQueueGenericSendFromISR() but used with semaphores where the\r
- item size is 0. Don't directly wake a task that was blocked on a queue\r
- read, instead return a flag to say whether a context switch is required or\r
- not (i.e. has a task with a higher priority than us been woken by this\r
- post). */\r
-\r
- configASSERT( pxQueue );\r
-\r
- /* xQueueGenericSendFromISR() should be used instead of xQueueGiveFromISR()\r
- if the item size is not 0. */\r
- configASSERT( pxQueue->uxItemSize == 0 );\r
-\r
- /* Normally a mutex would not be given from an interrupt, especially if\r
- there is a mutex holder, as priority inheritance makes no sense for an\r
- interrupts, only tasks. */\r
- configASSERT( !( ( pxQueue->uxQueueType == queueQUEUE_IS_MUTEX ) && ( pxQueue->pxMutexHolder != NULL ) ) );\r
-\r
- /* RTOS ports that support interrupt nesting have the concept of a maximum\r
- system call (or maximum API call) interrupt priority. Interrupts that are\r
- above the maximum system call priority are kept permanently enabled, even\r
- when the RTOS kernel is in a critical section, but cannot make any calls to\r
- FreeRTOS API functions. If configASSERT() is defined in FreeRTOSConfig.h\r
- then portASSERT_IF_INTERRUPT_PRIORITY_INVALID() will result in an assertion\r
- failure if a FreeRTOS API function is called from an interrupt that has been\r
- assigned a priority above the configured maximum system call priority.\r
- Only FreeRTOS functions that end in FromISR can be called from interrupts\r
- that have been assigned a priority at or (logically) below the maximum\r
- system call interrupt priority. FreeRTOS maintains a separate interrupt\r
- safe API to ensure interrupt entry is as fast and as simple as possible.\r
- More information (albeit Cortex-M specific) is provided on the following\r
- link: http://www.freertos.org/RTOS-Cortex-M3-M4.html */\r
- portASSERT_IF_INTERRUPT_PRIORITY_INVALID();\r
-\r
- uxSavedInterruptStatus = portSET_INTERRUPT_MASK_FROM_ISR();\r
- {\r
- const UBaseType_t uxMessagesWaiting = pxQueue->uxMessagesWaiting;\r
-\r
- /* When the queue is used to implement a semaphore no data is ever\r
- moved through the queue but it is still valid to see if the queue 'has\r
- space'. */\r
- if( uxMessagesWaiting < pxQueue->uxLength )\r
- {\r
- const int8_t cTxLock = pxQueue->cTxLock;\r
-\r
- traceQUEUE_SEND_FROM_ISR( pxQueue );\r
-\r
- /* A task can only have an inherited priority if it is a mutex\r
- holder - and if there is a mutex holder then the mutex cannot be\r
- given from an ISR. As this is the ISR version of the function it\r
- can be assumed there is no mutex holder and no need to determine if\r
- priority disinheritance is needed. Simply increase the count of\r
- messages (semaphores) available. */\r
- pxQueue->uxMessagesWaiting = uxMessagesWaiting + ( UBaseType_t ) 1;\r
-\r
- /* The event list is not altered if the queue is locked. This will\r
- be done when the queue is unlocked later. */\r
- if( cTxLock == queueUNLOCKED )\r
- {\r
- #if ( configUSE_QUEUE_SETS == 1 )\r
- {\r
- if( pxQueue->pxQueueSetContainer != NULL )\r
- {\r
- if( prvNotifyQueueSetContainer( pxQueue, queueSEND_TO_BACK ) != pdFALSE )\r
- {\r
- /* The semaphore is a member of a queue set, and\r
- posting to the queue set caused a higher priority\r
- task to unblock. A context switch is required. */\r
- if( pxHigherPriorityTaskWoken != NULL )\r
- {\r
- *pxHigherPriorityTaskWoken = pdTRUE;\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- else\r
- {\r
- if( listLIST_IS_EMPTY( &( pxQueue->xTasksWaitingToReceive ) ) == pdFALSE )\r
- {\r
- if( xTaskRemoveFromEventList( &( pxQueue->xTasksWaitingToReceive ) ) != pdFALSE )\r
- {\r
- /* The task waiting has a higher priority so\r
- record that a context switch is required. */\r
- if( pxHigherPriorityTaskWoken != NULL )\r
- {\r
- *pxHigherPriorityTaskWoken = pdTRUE;\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- }\r
- #else /* configUSE_QUEUE_SETS */\r
- {\r
- if( listLIST_IS_EMPTY( &( pxQueue->xTasksWaitingToReceive ) ) == pdFALSE )\r
- {\r
- if( xTaskRemoveFromEventList( &( pxQueue->xTasksWaitingToReceive ) ) != pdFALSE )\r
- {\r
- /* The task waiting has a higher priority so record that a\r
- context switch is required. */\r
- if( pxHigherPriorityTaskWoken != NULL )\r
- {\r
- *pxHigherPriorityTaskWoken = pdTRUE;\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- #endif /* configUSE_QUEUE_SETS */\r
- }\r
- else\r
- {\r
- /* Increment the lock count so the task that unlocks the queue\r
- knows that data was posted while it was locked. */\r
- pxQueue->cTxLock = ( int8_t ) ( cTxLock + 1 );\r
- }\r
-\r
- xReturn = pdPASS;\r
- }\r
- else\r
- {\r
- traceQUEUE_SEND_FROM_ISR_FAILED( pxQueue );\r
- xReturn = errQUEUE_FULL;\r
- }\r
- }\r
- portCLEAR_INTERRUPT_MASK_FROM_ISR( uxSavedInterruptStatus );\r
-\r
- return xReturn;\r
-}\r
-/*-----------------------------------------------------------*/\r
-\r
-BaseType_t xQueueReceive( QueueHandle_t xQueue, void * const pvBuffer, TickType_t xTicksToWait )\r
-{\r
-BaseType_t xEntryTimeSet = pdFALSE;\r
-TimeOut_t xTimeOut;\r
-Queue_t * const pxQueue = ( Queue_t * ) xQueue;\r
-\r
- /* Check the pointer is not NULL. */\r
- configASSERT( ( pxQueue ) );\r
-\r
- /* The buffer into which data is received can only be NULL if the data size\r
- is zero (so no data is copied into the buffer. */\r
- configASSERT( !( ( ( pvBuffer ) == NULL ) && ( ( pxQueue )->uxItemSize != ( UBaseType_t ) 0U ) ) );\r
-\r
- /* Cannot block if the scheduler is suspended. */\r
- #if ( ( INCLUDE_xTaskGetSchedulerState == 1 ) || ( configUSE_TIMERS == 1 ) )\r
- {\r
- configASSERT( !( ( xTaskGetSchedulerState() == taskSCHEDULER_SUSPENDED ) && ( xTicksToWait != 0 ) ) );\r
- }\r
- #endif\r
-\r
-\r
- /* This function relaxes the coding standard somewhat to allow return\r
- statements within the function itself. This is done in the interest\r
- of execution time efficiency. */\r
-\r
- for( ;; )\r
- {\r
- taskENTER_CRITICAL();\r
- {\r
- const UBaseType_t uxMessagesWaiting = pxQueue->uxMessagesWaiting;\r
-\r
- /* Is there data in the queue now? To be running the calling task\r
- must be the highest priority task wanting to access the queue. */\r
- if( uxMessagesWaiting > ( UBaseType_t ) 0 )\r
- {\r
- /* Data available, remove one item. */\r
- prvCopyDataFromQueue( pxQueue, pvBuffer );\r
- traceQUEUE_RECEIVE( pxQueue );\r
- pxQueue->uxMessagesWaiting = uxMessagesWaiting - ( UBaseType_t ) 1;\r
-\r
- /* There is now space in the queue, were any tasks waiting to\r
- post to the queue? If so, unblock the highest priority waiting\r
- task. */\r
- if( listLIST_IS_EMPTY( &( pxQueue->xTasksWaitingToSend ) ) == pdFALSE )\r
- {\r
- if( xTaskRemoveFromEventList( &( pxQueue->xTasksWaitingToSend ) ) != pdFALSE )\r
- {\r
- queueYIELD_IF_USING_PREEMPTION();\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
-\r
- taskEXIT_CRITICAL();\r
- return pdPASS;\r
- }\r
- else\r
- {\r
- if( xTicksToWait == ( TickType_t ) 0 )\r
- {\r
- /* The queue was empty and no block time is specified (or\r
- the block time has expired) so leave now. */\r
- taskEXIT_CRITICAL();\r
- traceQUEUE_RECEIVE_FAILED( pxQueue );\r
- return errQUEUE_EMPTY;\r
- }\r
- else if( xEntryTimeSet == pdFALSE )\r
- {\r
- /* The queue was empty and a block time was specified so\r
- configure the timeout structure. */\r
- vTaskInternalSetTimeOutState( &xTimeOut );\r
- xEntryTimeSet = pdTRUE;\r
- }\r
- else\r
- {\r
- /* Entry time was already set. */\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- }\r
- taskEXIT_CRITICAL();\r
-\r
- /* Interrupts and other tasks can send to and receive from the queue\r
- now the critical section has been exited. */\r
-\r
- vTaskSuspendAll();\r
- prvLockQueue( pxQueue );\r
-\r
- /* Update the timeout state to see if it has expired yet. */\r
- if( xTaskCheckForTimeOut( &xTimeOut, &xTicksToWait ) == pdFALSE )\r
- {\r
- /* The timeout has not expired. If the queue is still empty place\r
- the task on the list of tasks waiting to receive from the queue. */\r
- if( prvIsQueueEmpty( pxQueue ) != pdFALSE )\r
- {\r
- traceBLOCKING_ON_QUEUE_RECEIVE( pxQueue );\r
- vTaskPlaceOnEventList( &( pxQueue->xTasksWaitingToReceive ), xTicksToWait );\r
- prvUnlockQueue( pxQueue );\r
- if( xTaskResumeAll() == pdFALSE )\r
- {\r
- portYIELD_WITHIN_API();\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- else\r
- {\r
- /* The queue contains data again. Loop back to try and read the\r
- data. */\r
- prvUnlockQueue( pxQueue );\r
- ( void ) xTaskResumeAll();\r
- }\r
- }\r
- else\r
- {\r
- /* Timed out. If there is no data in the queue exit, otherwise loop\r
- back and attempt to read the data. */\r
- prvUnlockQueue( pxQueue );\r
- ( void ) xTaskResumeAll();\r
-\r
- if( prvIsQueueEmpty( pxQueue ) != pdFALSE )\r
- {\r
- traceQUEUE_RECEIVE_FAILED( pxQueue );\r
- return errQUEUE_EMPTY;\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- }\r
-}\r
-/*-----------------------------------------------------------*/\r
-\r
-BaseType_t xQueueSemaphoreTake( QueueHandle_t xQueue, TickType_t xTicksToWait )\r
-{\r
-BaseType_t xEntryTimeSet = pdFALSE;\r
-TimeOut_t xTimeOut;\r
-Queue_t * const pxQueue = ( Queue_t * ) xQueue;\r
-\r
-#if( configUSE_MUTEXES == 1 )\r
- BaseType_t xInheritanceOccurred = pdFALSE;\r
-#endif\r
-\r
- /* Check the queue pointer is not NULL. */\r
- configASSERT( ( pxQueue ) );\r
-\r
- /* Check this really is a semaphore, in which case the item size will be\r
- 0. */\r
- configASSERT( pxQueue->uxItemSize == 0 );\r
-\r
- /* Cannot block if the scheduler is suspended. */\r
- #if ( ( INCLUDE_xTaskGetSchedulerState == 1 ) || ( configUSE_TIMERS == 1 ) )\r
- {\r
- configASSERT( !( ( xTaskGetSchedulerState() == taskSCHEDULER_SUSPENDED ) && ( xTicksToWait != 0 ) ) );\r
- }\r
- #endif\r
-\r
-\r
- /* This function relaxes the coding standard somewhat to allow return\r
- statements within the function itself. This is done in the interest\r
- of execution time efficiency. */\r
-\r
- for( ;; )\r
- {\r
- taskENTER_CRITICAL();\r
- {\r
- /* Semaphores are queues with an item size of 0, and where the\r
- number of messages in the queue is the semaphore's count value. */\r
- const UBaseType_t uxSemaphoreCount = pxQueue->uxMessagesWaiting;\r
-\r
- /* Is there data in the queue now? To be running the calling task\r
- must be the highest priority task wanting to access the queue. */\r
- if( uxSemaphoreCount > ( UBaseType_t ) 0 )\r
- {\r
- traceQUEUE_RECEIVE( pxQueue );\r
-\r
- /* Semaphores are queues with a data size of zero and where the\r
- messages waiting is the semaphore's count. Reduce the count. */\r
- pxQueue->uxMessagesWaiting = uxSemaphoreCount - ( UBaseType_t ) 1;\r
-\r
- #if ( configUSE_MUTEXES == 1 )\r
- {\r
- if( pxQueue->uxQueueType == queueQUEUE_IS_MUTEX )\r
- {\r
- /* Record the information required to implement\r
- priority inheritance should it become necessary. */\r
- pxQueue->pxMutexHolder = ( int8_t * ) pvTaskIncrementMutexHeldCount(); /*lint !e961 Cast is not redundant as TaskHandle_t is a typedef. */\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- #endif /* configUSE_MUTEXES */\r
-\r
- /* Check to see if other tasks are blocked waiting to give the\r
- semaphore, and if so, unblock the highest priority such task. */\r
- if( listLIST_IS_EMPTY( &( pxQueue->xTasksWaitingToSend ) ) == pdFALSE )\r
- {\r
- if( xTaskRemoveFromEventList( &( pxQueue->xTasksWaitingToSend ) ) != pdFALSE )\r
- {\r
- queueYIELD_IF_USING_PREEMPTION();\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
-\r
- taskEXIT_CRITICAL();\r
- return pdPASS;\r
- }\r
- else\r
- {\r
- if( xTicksToWait == ( TickType_t ) 0 )\r
- {\r
- /* For inheritance to have occurred there must have been an\r
- initial timeout, and an adjusted timeout cannot become 0, as\r
- if it were 0 the function would have exited. */\r
- #if( configUSE_MUTEXES == 1 )\r
- {\r
- configASSERT( xInheritanceOccurred == pdFALSE );\r
- }\r
- #endif /* configUSE_MUTEXES */\r
-\r
- /* The semaphore count was 0 and no block time is specified\r
- (or the block time has expired) so exit now. */\r
- taskEXIT_CRITICAL();\r
- traceQUEUE_RECEIVE_FAILED( pxQueue );\r
- return errQUEUE_EMPTY;\r
- }\r
- else if( xEntryTimeSet == pdFALSE )\r
- {\r
- /* The semaphore count was 0 and a block time was specified\r
- so configure the timeout structure ready to block. */\r
- vTaskInternalSetTimeOutState( &xTimeOut );\r
- xEntryTimeSet = pdTRUE;\r
- }\r
- else\r
- {\r
- /* Entry time was already set. */\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- }\r
- taskEXIT_CRITICAL();\r
-\r
- /* Interrupts and other tasks can give to and take from the semaphore\r
- now the critical section has been exited. */\r
-\r
- vTaskSuspendAll();\r
- prvLockQueue( pxQueue );\r
-\r
- /* Update the timeout state to see if it has expired yet. */\r
- if( xTaskCheckForTimeOut( &xTimeOut, &xTicksToWait ) == pdFALSE )\r
- {\r
- /* A block time is specified and not expired. If the semaphore\r
- count is 0 then enter the Blocked state to wait for a semaphore to\r
- become available. As semaphores are implemented with queues the\r
- queue being empty is equivalent to the semaphore count being 0. */\r
- if( prvIsQueueEmpty( pxQueue ) != pdFALSE )\r
- {\r
- traceBLOCKING_ON_QUEUE_RECEIVE( pxQueue );\r
-\r
- #if ( configUSE_MUTEXES == 1 )\r
- {\r
- if( pxQueue->uxQueueType == queueQUEUE_IS_MUTEX )\r
- {\r
- taskENTER_CRITICAL();\r
- {\r
- xInheritanceOccurred = xTaskPriorityInherit( ( void * ) pxQueue->pxMutexHolder );\r
- }\r
- taskEXIT_CRITICAL();\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- #endif\r
-\r
- vTaskPlaceOnEventList( &( pxQueue->xTasksWaitingToReceive ), xTicksToWait );\r
- prvUnlockQueue( pxQueue );\r
- if( xTaskResumeAll() == pdFALSE )\r
- {\r
- portYIELD_WITHIN_API();\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- else\r
- {\r
- /* There was no timeout and the semaphore count was not 0, so\r
- attempt to take the semaphore again. */\r
- prvUnlockQueue( pxQueue );\r
- ( void ) xTaskResumeAll();\r
- }\r
- }\r
- else\r
- {\r
- /* Timed out. */\r
- prvUnlockQueue( pxQueue );\r
- ( void ) xTaskResumeAll();\r
-\r
- /* If the semaphore count is 0 exit now as the timeout has\r
- expired. Otherwise return to attempt to take the semaphore that is\r
- known to be available. As semaphores are implemented by queues the\r
- queue being empty is equivalent to the semaphore count being 0. */\r
- if( prvIsQueueEmpty( pxQueue ) != pdFALSE )\r
- {\r
- #if ( configUSE_MUTEXES == 1 )\r
- {\r
- /* xInheritanceOccurred could only have be set if\r
- pxQueue->uxQueueType == queueQUEUE_IS_MUTEX so no need to\r
- test the mutex type again to check it is actually a mutex. */\r
- if( xInheritanceOccurred != pdFALSE )\r
- {\r
- taskENTER_CRITICAL();\r
- {\r
- UBaseType_t uxHighestWaitingPriority;\r
-\r
- /* This task blocking on the mutex caused another\r
- task to inherit this task's priority. Now this task\r
- has timed out the priority should be disinherited\r
- again, but only as low as the next highest priority\r
- task that is waiting for the same mutex. */\r
- uxHighestWaitingPriority = prvGetDisinheritPriorityAfterTimeout( pxQueue );\r
- vTaskPriorityDisinheritAfterTimeout( ( void * ) pxQueue->pxMutexHolder, uxHighestWaitingPriority );\r
- }\r
- taskEXIT_CRITICAL();\r
- }\r
- }\r
- #endif /* configUSE_MUTEXES */\r
-\r
- traceQUEUE_RECEIVE_FAILED( pxQueue );\r
- return errQUEUE_EMPTY;\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- }\r
-}\r
-/*-----------------------------------------------------------*/\r
-\r
-BaseType_t xQueuePeek( QueueHandle_t xQueue, void * const pvBuffer, TickType_t xTicksToWait )\r
-{\r
-BaseType_t xEntryTimeSet = pdFALSE;\r
-TimeOut_t xTimeOut;\r
-int8_t *pcOriginalReadPosition;\r
-Queue_t * const pxQueue = ( Queue_t * ) xQueue;\r
-\r
- /* Check the pointer is not NULL. */\r
- configASSERT( ( pxQueue ) );\r
-\r
- /* The buffer into which data is received can only be NULL if the data size\r
- is zero (so no data is copied into the buffer. */\r
- configASSERT( !( ( ( pvBuffer ) == NULL ) && ( ( pxQueue )->uxItemSize != ( UBaseType_t ) 0U ) ) );\r
-\r
- /* Cannot block if the scheduler is suspended. */\r
- #if ( ( INCLUDE_xTaskGetSchedulerState == 1 ) || ( configUSE_TIMERS == 1 ) )\r
- {\r
- configASSERT( !( ( xTaskGetSchedulerState() == taskSCHEDULER_SUSPENDED ) && ( xTicksToWait != 0 ) ) );\r
- }\r
- #endif\r
-\r
-\r
- /* This function relaxes the coding standard somewhat to allow return\r
- statements within the function itself. This is done in the interest\r
- of execution time efficiency. */\r
-\r
- for( ;; )\r
- {\r
- taskENTER_CRITICAL();\r
- {\r
- const UBaseType_t uxMessagesWaiting = pxQueue->uxMessagesWaiting;\r
-\r
- /* Is there data in the queue now? To be running the calling task\r
- must be the highest priority task wanting to access the queue. */\r
- if( uxMessagesWaiting > ( UBaseType_t ) 0 )\r
- {\r
- /* Remember the read position so it can be reset after the data\r
- is read from the queue as this function is only peeking the\r
- data, not removing it. */\r
- pcOriginalReadPosition = pxQueue->u.pcReadFrom;\r
-\r
- prvCopyDataFromQueue( pxQueue, pvBuffer );\r
- traceQUEUE_PEEK( pxQueue );\r
-\r
- /* The data is not being removed, so reset the read pointer. */\r
- pxQueue->u.pcReadFrom = pcOriginalReadPosition;\r
-\r
- /* The data is being left in the queue, so see if there are\r
- any other tasks waiting for the data. */\r
- if( listLIST_IS_EMPTY( &( pxQueue->xTasksWaitingToReceive ) ) == pdFALSE )\r
- {\r
- if( xTaskRemoveFromEventList( &( pxQueue->xTasksWaitingToReceive ) ) != pdFALSE )\r
- {\r
- /* The task waiting has a higher priority than this task. */\r
- queueYIELD_IF_USING_PREEMPTION();\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
-\r
- taskEXIT_CRITICAL();\r
- return pdPASS;\r
- }\r
- else\r
- {\r
- if( xTicksToWait == ( TickType_t ) 0 )\r
- {\r
- /* The queue was empty and no block time is specified (or\r
- the block time has expired) so leave now. */\r
- taskEXIT_CRITICAL();\r
- traceQUEUE_PEEK_FAILED( pxQueue );\r
- return errQUEUE_EMPTY;\r
- }\r
- else if( xEntryTimeSet == pdFALSE )\r
- {\r
- /* The queue was empty and a block time was specified so\r
- configure the timeout structure ready to enter the blocked\r
- state. */\r
- vTaskInternalSetTimeOutState( &xTimeOut );\r
- xEntryTimeSet = pdTRUE;\r
- }\r
- else\r
- {\r
- /* Entry time was already set. */\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- }\r
- taskEXIT_CRITICAL();\r
-\r
- /* Interrupts and other tasks can send to and receive from the queue\r
- now the critical section has been exited. */\r
-\r
- vTaskSuspendAll();\r
- prvLockQueue( pxQueue );\r
-\r
- /* Update the timeout state to see if it has expired yet. */\r
- if( xTaskCheckForTimeOut( &xTimeOut, &xTicksToWait ) == pdFALSE )\r
- {\r
- /* Timeout has not expired yet, check to see if there is data in the\r
- queue now, and if not enter the Blocked state to wait for data. */\r
- if( prvIsQueueEmpty( pxQueue ) != pdFALSE )\r
- {\r
- traceBLOCKING_ON_QUEUE_PEEK( pxQueue );\r
- vTaskPlaceOnEventList( &( pxQueue->xTasksWaitingToReceive ), xTicksToWait );\r
- prvUnlockQueue( pxQueue );\r
- if( xTaskResumeAll() == pdFALSE )\r
- {\r
- portYIELD_WITHIN_API();\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- else\r
- {\r
- /* There is data in the queue now, so don't enter the blocked\r
- state, instead return to try and obtain the data. */\r
- prvUnlockQueue( pxQueue );\r
- ( void ) xTaskResumeAll();\r
- }\r
- }\r
- else\r
- {\r
- /* The timeout has expired. If there is still no data in the queue\r
- exit, otherwise go back and try to read the data again. */\r
- prvUnlockQueue( pxQueue );\r
- ( void ) xTaskResumeAll();\r
-\r
- if( prvIsQueueEmpty( pxQueue ) != pdFALSE )\r
- {\r
- traceQUEUE_PEEK_FAILED( pxQueue );\r
- return errQUEUE_EMPTY;\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- }\r
-}\r
-/*-----------------------------------------------------------*/\r
-\r
-BaseType_t xQueueReceiveFromISR( QueueHandle_t xQueue, void * const pvBuffer, BaseType_t * const pxHigherPriorityTaskWoken )\r
-{\r
-BaseType_t xReturn;\r
-UBaseType_t uxSavedInterruptStatus;\r
-Queue_t * const pxQueue = ( Queue_t * ) xQueue;\r
-\r
- configASSERT( pxQueue );\r
- configASSERT( !( ( pvBuffer == NULL ) && ( pxQueue->uxItemSize != ( UBaseType_t ) 0U ) ) );\r
-\r
- /* RTOS ports that support interrupt nesting have the concept of a maximum\r
- system call (or maximum API call) interrupt priority. Interrupts that are\r
- above the maximum system call priority are kept permanently enabled, even\r
- when the RTOS kernel is in a critical section, but cannot make any calls to\r
- FreeRTOS API functions. If configASSERT() is defined in FreeRTOSConfig.h\r
- then portASSERT_IF_INTERRUPT_PRIORITY_INVALID() will result in an assertion\r
- failure if a FreeRTOS API function is called from an interrupt that has been\r
- assigned a priority above the configured maximum system call priority.\r
- Only FreeRTOS functions that end in FromISR can be called from interrupts\r
- that have been assigned a priority at or (logically) below the maximum\r
- system call interrupt priority. FreeRTOS maintains a separate interrupt\r
- safe API to ensure interrupt entry is as fast and as simple as possible.\r
- More information (albeit Cortex-M specific) is provided on the following\r
- link: http://www.freertos.org/RTOS-Cortex-M3-M4.html */\r
- portASSERT_IF_INTERRUPT_PRIORITY_INVALID();\r
-\r
- uxSavedInterruptStatus = portSET_INTERRUPT_MASK_FROM_ISR();\r
- {\r
- const UBaseType_t uxMessagesWaiting = pxQueue->uxMessagesWaiting;\r
-\r
- /* Cannot block in an ISR, so check there is data available. */\r
- if( uxMessagesWaiting > ( UBaseType_t ) 0 )\r
- {\r
- const int8_t cRxLock = pxQueue->cRxLock;\r
-\r
- traceQUEUE_RECEIVE_FROM_ISR( pxQueue );\r
-\r
- prvCopyDataFromQueue( pxQueue, pvBuffer );\r
- pxQueue->uxMessagesWaiting = uxMessagesWaiting - ( UBaseType_t ) 1;\r
-\r
- /* If the queue is locked the event list will not be modified.\r
- Instead update the lock count so the task that unlocks the queue\r
- will know that an ISR has removed data while the queue was\r
- locked. */\r
- if( cRxLock == queueUNLOCKED )\r
- {\r
- if( listLIST_IS_EMPTY( &( pxQueue->xTasksWaitingToSend ) ) == pdFALSE )\r
- {\r
- if( xTaskRemoveFromEventList( &( pxQueue->xTasksWaitingToSend ) ) != pdFALSE )\r
- {\r
- /* The task waiting has a higher priority than us so\r
- force a context switch. */\r
- if( pxHigherPriorityTaskWoken != NULL )\r
- {\r
- *pxHigherPriorityTaskWoken = pdTRUE;\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- else\r
- {\r
- /* Increment the lock count so the task that unlocks the queue\r
- knows that data was removed while it was locked. */\r
- pxQueue->cRxLock = ( int8_t ) ( cRxLock + 1 );\r
- }\r
-\r
- xReturn = pdPASS;\r
- }\r
- else\r
- {\r
- xReturn = pdFAIL;\r
- traceQUEUE_RECEIVE_FROM_ISR_FAILED( pxQueue );\r
- }\r
- }\r
- portCLEAR_INTERRUPT_MASK_FROM_ISR( uxSavedInterruptStatus );\r
-\r
- return xReturn;\r
-}\r
-/*-----------------------------------------------------------*/\r
-\r
-BaseType_t xQueuePeekFromISR( QueueHandle_t xQueue, void * const pvBuffer )\r
-{\r
-BaseType_t xReturn;\r
-UBaseType_t uxSavedInterruptStatus;\r
-int8_t *pcOriginalReadPosition;\r
-Queue_t * const pxQueue = ( Queue_t * ) xQueue;\r
-\r
- configASSERT( pxQueue );\r
- configASSERT( !( ( pvBuffer == NULL ) && ( pxQueue->uxItemSize != ( UBaseType_t ) 0U ) ) );\r
- configASSERT( pxQueue->uxItemSize != 0 ); /* Can't peek a semaphore. */\r
-\r
- /* RTOS ports that support interrupt nesting have the concept of a maximum\r
- system call (or maximum API call) interrupt priority. Interrupts that are\r
- above the maximum system call priority are kept permanently enabled, even\r
- when the RTOS kernel is in a critical section, but cannot make any calls to\r
- FreeRTOS API functions. If configASSERT() is defined in FreeRTOSConfig.h\r
- then portASSERT_IF_INTERRUPT_PRIORITY_INVALID() will result in an assertion\r
- failure if a FreeRTOS API function is called from an interrupt that has been\r
- assigned a priority above the configured maximum system call priority.\r
- Only FreeRTOS functions that end in FromISR can be called from interrupts\r
- that have been assigned a priority at or (logically) below the maximum\r
- system call interrupt priority. FreeRTOS maintains a separate interrupt\r
- safe API to ensure interrupt entry is as fast and as simple as possible.\r
- More information (albeit Cortex-M specific) is provided on the following\r
- link: http://www.freertos.org/RTOS-Cortex-M3-M4.html */\r
- portASSERT_IF_INTERRUPT_PRIORITY_INVALID();\r
-\r
- uxSavedInterruptStatus = portSET_INTERRUPT_MASK_FROM_ISR();\r
- {\r
- /* Cannot block in an ISR, so check there is data available. */\r
- if( pxQueue->uxMessagesWaiting > ( UBaseType_t ) 0 )\r
- {\r
- traceQUEUE_PEEK_FROM_ISR( pxQueue );\r
-\r
- /* Remember the read position so it can be reset as nothing is\r
- actually being removed from the queue. */\r
- pcOriginalReadPosition = pxQueue->u.pcReadFrom;\r
- prvCopyDataFromQueue( pxQueue, pvBuffer );\r
- pxQueue->u.pcReadFrom = pcOriginalReadPosition;\r
-\r
- xReturn = pdPASS;\r
- }\r
- else\r
- {\r
- xReturn = pdFAIL;\r
- traceQUEUE_PEEK_FROM_ISR_FAILED( pxQueue );\r
- }\r
- }\r
- portCLEAR_INTERRUPT_MASK_FROM_ISR( uxSavedInterruptStatus );\r
-\r
- return xReturn;\r
-}\r
-/*-----------------------------------------------------------*/\r
-\r
-UBaseType_t uxQueueMessagesWaiting( const QueueHandle_t xQueue )\r
-{\r
-UBaseType_t uxReturn;\r
-\r
- configASSERT( xQueue );\r
-\r
- taskENTER_CRITICAL();\r
- {\r
- uxReturn = ( ( Queue_t * ) xQueue )->uxMessagesWaiting;\r
- }\r
- taskEXIT_CRITICAL();\r
-\r
- return uxReturn;\r
-} /*lint !e818 Pointer cannot be declared const as xQueue is a typedef not pointer. */\r
-/*-----------------------------------------------------------*/\r
-\r
-UBaseType_t uxQueueSpacesAvailable( const QueueHandle_t xQueue )\r
-{\r
-UBaseType_t uxReturn;\r
-Queue_t *pxQueue;\r
-\r
- pxQueue = ( Queue_t * ) xQueue;\r
- configASSERT( pxQueue );\r
-\r
- taskENTER_CRITICAL();\r
- {\r
- uxReturn = pxQueue->uxLength - pxQueue->uxMessagesWaiting;\r
- }\r
- taskEXIT_CRITICAL();\r
-\r
- return uxReturn;\r
-} /*lint !e818 Pointer cannot be declared const as xQueue is a typedef not pointer. */\r
-/*-----------------------------------------------------------*/\r
-\r
-UBaseType_t uxQueueMessagesWaitingFromISR( const QueueHandle_t xQueue )\r
-{\r
-UBaseType_t uxReturn;\r
-\r
- configASSERT( xQueue );\r
-\r
- uxReturn = ( ( Queue_t * ) xQueue )->uxMessagesWaiting;\r
-\r
- return uxReturn;\r
-} /*lint !e818 Pointer cannot be declared const as xQueue is a typedef not pointer. */\r
-/*-----------------------------------------------------------*/\r
-\r
-void vQueueDelete( QueueHandle_t xQueue )\r
-{\r
-Queue_t * const pxQueue = ( Queue_t * ) xQueue;\r
-\r
- configASSERT( pxQueue );\r
- traceQUEUE_DELETE( pxQueue );\r
-\r
- #if ( configQUEUE_REGISTRY_SIZE > 0 )\r
- {\r
- vQueueUnregisterQueue( pxQueue );\r
- }\r
- #endif\r
-\r
- #if( ( configSUPPORT_DYNAMIC_ALLOCATION == 1 ) && ( configSUPPORT_STATIC_ALLOCATION == 0 ) )\r
- {\r
- /* The queue can only have been allocated dynamically - free it\r
- again. */\r
- vPortFree( pxQueue );\r
- }\r
- #elif( ( configSUPPORT_DYNAMIC_ALLOCATION == 1 ) && ( configSUPPORT_STATIC_ALLOCATION == 1 ) )\r
- {\r
- /* The queue could have been allocated statically or dynamically, so\r
- check before attempting to free the memory. */\r
- if( pxQueue->ucStaticallyAllocated == ( uint8_t ) pdFALSE )\r
- {\r
- vPortFree( pxQueue );\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- #else\r
- {\r
- /* The queue must have been statically allocated, so is not going to be\r
- deleted. Avoid compiler warnings about the unused parameter. */\r
- ( void ) pxQueue;\r
- }\r
- #endif /* configSUPPORT_DYNAMIC_ALLOCATION */\r
-}\r
-/*-----------------------------------------------------------*/\r
-\r
-#if ( configUSE_TRACE_FACILITY == 1 )\r
-\r
- UBaseType_t uxQueueGetQueueNumber( QueueHandle_t xQueue )\r
- {\r
- return ( ( Queue_t * ) xQueue )->uxQueueNumber;\r
- }\r
-\r
-#endif /* configUSE_TRACE_FACILITY */\r
-/*-----------------------------------------------------------*/\r
-\r
-#if ( configUSE_TRACE_FACILITY == 1 )\r
-\r
- void vQueueSetQueueNumber( QueueHandle_t xQueue, UBaseType_t uxQueueNumber )\r
- {\r
- ( ( Queue_t * ) xQueue )->uxQueueNumber = uxQueueNumber;\r
- }\r
-\r
-#endif /* configUSE_TRACE_FACILITY */\r
-/*-----------------------------------------------------------*/\r
-\r
-#if ( configUSE_TRACE_FACILITY == 1 )\r
-\r
- uint8_t ucQueueGetQueueType( QueueHandle_t xQueue )\r
- {\r
- return ( ( Queue_t * ) xQueue )->ucQueueType;\r
- }\r
-\r
-#endif /* configUSE_TRACE_FACILITY */\r
-/*-----------------------------------------------------------*/\r
-\r
-#if( configUSE_MUTEXES == 1 )\r
-\r
- static UBaseType_t prvGetDisinheritPriorityAfterTimeout( const Queue_t * const pxQueue )\r
- {\r
- UBaseType_t uxHighestPriorityOfWaitingTasks;\r
-\r
- /* If a task waiting for a mutex causes the mutex holder to inherit a\r
- priority, but the waiting task times out, then the holder should\r
- disinherit the priority - but only down to the highest priority of any\r
- other tasks that are waiting for the same mutex. For this purpose,\r
- return the priority of the highest priority task that is waiting for the\r
- mutex. */\r
- if( listCURRENT_LIST_LENGTH( &( pxQueue->xTasksWaitingToReceive ) ) > 0 )\r
- {\r
- uxHighestPriorityOfWaitingTasks = configMAX_PRIORITIES - listGET_ITEM_VALUE_OF_HEAD_ENTRY( &( pxQueue->xTasksWaitingToReceive ) );\r
- }\r
- else\r
- {\r
- uxHighestPriorityOfWaitingTasks = tskIDLE_PRIORITY;\r
- }\r
-\r
- return uxHighestPriorityOfWaitingTasks;\r
- }\r
-\r
-#endif /* configUSE_MUTEXES */\r
-/*-----------------------------------------------------------*/\r
-\r
-static BaseType_t prvCopyDataToQueue( Queue_t * const pxQueue, const void *pvItemToQueue, const BaseType_t xPosition )\r
-{\r
-BaseType_t xReturn = pdFALSE;\r
-UBaseType_t uxMessagesWaiting;\r
-\r
- /* This function is called from a critical section. */\r
-\r
- uxMessagesWaiting = pxQueue->uxMessagesWaiting;\r
-\r
- if( pxQueue->uxItemSize == ( UBaseType_t ) 0 )\r
- {\r
- #if ( configUSE_MUTEXES == 1 )\r
- {\r
- if( pxQueue->uxQueueType == queueQUEUE_IS_MUTEX )\r
- {\r
- /* The mutex is no longer being held. */\r
- xReturn = xTaskPriorityDisinherit( ( void * ) pxQueue->pxMutexHolder );\r
- pxQueue->pxMutexHolder = NULL;\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- #endif /* configUSE_MUTEXES */\r
- }\r
- else if( xPosition == queueSEND_TO_BACK )\r
- {\r
- ( void ) memcpy( ( void * ) pxQueue->pcWriteTo, pvItemToQueue, ( size_t ) pxQueue->uxItemSize ); /*lint !e961 !e418 MISRA exception as the casts are only redundant for some ports, plus previous logic ensures a null pointer can only be passed to memcpy() if the copy size is 0. */\r
- pxQueue->pcWriteTo += pxQueue->uxItemSize;\r
- if( pxQueue->pcWriteTo >= pxQueue->pcTail ) /*lint !e946 MISRA exception justified as comparison of pointers is the cleanest solution. */\r
- {\r
- pxQueue->pcWriteTo = pxQueue->pcHead;\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- else\r
- {\r
- ( void ) memcpy( ( void * ) pxQueue->u.pcReadFrom, pvItemToQueue, ( size_t ) pxQueue->uxItemSize ); /*lint !e961 MISRA exception as the casts are only redundant for some ports. */\r
- pxQueue->u.pcReadFrom -= pxQueue->uxItemSize;\r
- if( pxQueue->u.pcReadFrom < pxQueue->pcHead ) /*lint !e946 MISRA exception justified as comparison of pointers is the cleanest solution. */\r
- {\r
- pxQueue->u.pcReadFrom = ( pxQueue->pcTail - pxQueue->uxItemSize );\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
-\r
- if( xPosition == queueOVERWRITE )\r
- {\r
- if( uxMessagesWaiting > ( UBaseType_t ) 0 )\r
- {\r
- /* An item is not being added but overwritten, so subtract\r
- one from the recorded number of items in the queue so when\r
- one is added again below the number of recorded items remains\r
- correct. */\r
- --uxMessagesWaiting;\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
-\r
- pxQueue->uxMessagesWaiting = uxMessagesWaiting + ( UBaseType_t ) 1;\r
-\r
- return xReturn;\r
-}\r
-/*-----------------------------------------------------------*/\r
-\r
-static void prvCopyDataFromQueue( Queue_t * const pxQueue, void * const pvBuffer )\r
-{\r
- if( pxQueue->uxItemSize != ( UBaseType_t ) 0 )\r
- {\r
- pxQueue->u.pcReadFrom += pxQueue->uxItemSize;\r
- if( pxQueue->u.pcReadFrom >= pxQueue->pcTail ) /*lint !e946 MISRA exception justified as use of the relational operator is the cleanest solutions. */\r
- {\r
- pxQueue->u.pcReadFrom = pxQueue->pcHead;\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- ( void ) memcpy( ( void * ) pvBuffer, ( void * ) pxQueue->u.pcReadFrom, ( size_t ) pxQueue->uxItemSize ); /*lint !e961 !e418 MISRA exception as the casts are only redundant for some ports. Also previous logic ensures a null pointer can only be passed to memcpy() when the count is 0. */\r
- }\r
-}\r
-/*-----------------------------------------------------------*/\r
-\r
-static void prvUnlockQueue( Queue_t * const pxQueue )\r
-{\r
- /* THIS FUNCTION MUST BE CALLED WITH THE SCHEDULER SUSPENDED. */\r
-\r
- /* The lock counts contains the number of extra data items placed or\r
- removed from the queue while the queue was locked. When a queue is\r
- locked items can be added or removed, but the event lists cannot be\r
- updated. */\r
- taskENTER_CRITICAL();\r
- {\r
- int8_t cTxLock = pxQueue->cTxLock;\r
-\r
- /* See if data was added to the queue while it was locked. */\r
- while( cTxLock > queueLOCKED_UNMODIFIED )\r
- {\r
- /* Data was posted while the queue was locked. Are any tasks\r
- blocked waiting for data to become available? */\r
- #if ( configUSE_QUEUE_SETS == 1 )\r
- {\r
- if( pxQueue->pxQueueSetContainer != NULL )\r
- {\r
- if( prvNotifyQueueSetContainer( pxQueue, queueSEND_TO_BACK ) != pdFALSE )\r
- {\r
- /* The queue is a member of a queue set, and posting to\r
- the queue set caused a higher priority task to unblock.\r
- A context switch is required. */\r
- vTaskMissedYield();\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- else\r
- {\r
- /* Tasks that are removed from the event list will get\r
- added to the pending ready list as the scheduler is still\r
- suspended. */\r
- if( listLIST_IS_EMPTY( &( pxQueue->xTasksWaitingToReceive ) ) == pdFALSE )\r
- {\r
- if( xTaskRemoveFromEventList( &( pxQueue->xTasksWaitingToReceive ) ) != pdFALSE )\r
- {\r
- /* The task waiting has a higher priority so record that a\r
- context switch is required. */\r
- vTaskMissedYield();\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- else\r
- {\r
- break;\r
- }\r
- }\r
- }\r
- #else /* configUSE_QUEUE_SETS */\r
- {\r
- /* Tasks that are removed from the event list will get added to\r
- the pending ready list as the scheduler is still suspended. */\r
- if( listLIST_IS_EMPTY( &( pxQueue->xTasksWaitingToReceive ) ) == pdFALSE )\r
- {\r
- if( xTaskRemoveFromEventList( &( pxQueue->xTasksWaitingToReceive ) ) != pdFALSE )\r
- {\r
- /* The task waiting has a higher priority so record that\r
- a context switch is required. */\r
- vTaskMissedYield();\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- else\r
- {\r
- break;\r
- }\r
- }\r
- #endif /* configUSE_QUEUE_SETS */\r
-\r
- --cTxLock;\r
- }\r
-\r
- pxQueue->cTxLock = queueUNLOCKED;\r
- }\r
- taskEXIT_CRITICAL();\r
-\r
- /* Do the same for the Rx lock. */\r
- taskENTER_CRITICAL();\r
- {\r
- int8_t cRxLock = pxQueue->cRxLock;\r
-\r
- while( cRxLock > queueLOCKED_UNMODIFIED )\r
- {\r
- if( listLIST_IS_EMPTY( &( pxQueue->xTasksWaitingToSend ) ) == pdFALSE )\r
- {\r
- if( xTaskRemoveFromEventList( &( pxQueue->xTasksWaitingToSend ) ) != pdFALSE )\r
- {\r
- vTaskMissedYield();\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
-\r
- --cRxLock;\r
- }\r
- else\r
- {\r
- break;\r
- }\r
- }\r
-\r
- pxQueue->cRxLock = queueUNLOCKED;\r
- }\r
- taskEXIT_CRITICAL();\r
-}\r
-/*-----------------------------------------------------------*/\r
-\r
-static BaseType_t prvIsQueueEmpty( const Queue_t *pxQueue )\r
-{\r
-BaseType_t xReturn;\r
-\r
- taskENTER_CRITICAL();\r
- {\r
- if( pxQueue->uxMessagesWaiting == ( UBaseType_t ) 0 )\r
- {\r
- xReturn = pdTRUE;\r
- }\r
- else\r
- {\r
- xReturn = pdFALSE;\r
- }\r
- }\r
- taskEXIT_CRITICAL();\r
-\r
- return xReturn;\r
-}\r
-/*-----------------------------------------------------------*/\r
-\r
-BaseType_t xQueueIsQueueEmptyFromISR( const QueueHandle_t xQueue )\r
-{\r
-BaseType_t xReturn;\r
-\r
- configASSERT( xQueue );\r
- if( ( ( Queue_t * ) xQueue )->uxMessagesWaiting == ( UBaseType_t ) 0 )\r
- {\r
- xReturn = pdTRUE;\r
- }\r
- else\r
- {\r
- xReturn = pdFALSE;\r
- }\r
-\r
- return xReturn;\r
-} /*lint !e818 xQueue could not be pointer to const because it is a typedef. */\r
-/*-----------------------------------------------------------*/\r
-\r
-static BaseType_t prvIsQueueFull( const Queue_t *pxQueue )\r
-{\r
-BaseType_t xReturn;\r
-\r
- taskENTER_CRITICAL();\r
- {\r
- if( pxQueue->uxMessagesWaiting == pxQueue->uxLength )\r
- {\r
- xReturn = pdTRUE;\r
- }\r
- else\r
- {\r
- xReturn = pdFALSE;\r
- }\r
- }\r
- taskEXIT_CRITICAL();\r
-\r
- return xReturn;\r
-}\r
-/*-----------------------------------------------------------*/\r
-\r
-BaseType_t xQueueIsQueueFullFromISR( const QueueHandle_t xQueue )\r
-{\r
-BaseType_t xReturn;\r
-\r
- configASSERT( xQueue );\r
- if( ( ( Queue_t * ) xQueue )->uxMessagesWaiting == ( ( Queue_t * ) xQueue )->uxLength )\r
- {\r
- xReturn = pdTRUE;\r
- }\r
- else\r
- {\r
- xReturn = pdFALSE;\r
- }\r
-\r
- return xReturn;\r
-} /*lint !e818 xQueue could not be pointer to const because it is a typedef. */\r
-/*-----------------------------------------------------------*/\r
-\r
-#if ( configUSE_CO_ROUTINES == 1 )\r
-\r
- BaseType_t xQueueCRSend( QueueHandle_t xQueue, const void *pvItemToQueue, TickType_t xTicksToWait )\r
- {\r
- BaseType_t xReturn;\r
- Queue_t * const pxQueue = ( Queue_t * ) xQueue;\r
-\r
- /* If the queue is already full we may have to block. A critical section\r
- is required to prevent an interrupt removing something from the queue\r
- between the check to see if the queue is full and blocking on the queue. */\r
- portDISABLE_INTERRUPTS();\r
- {\r
- if( prvIsQueueFull( pxQueue ) != pdFALSE )\r
- {\r
- /* The queue is full - do we want to block or just leave without\r
- posting? */\r
- if( xTicksToWait > ( TickType_t ) 0 )\r
- {\r
- /* As this is called from a coroutine we cannot block directly, but\r
- return indicating that we need to block. */\r
- vCoRoutineAddToDelayedList( xTicksToWait, &( pxQueue->xTasksWaitingToSend ) );\r
- portENABLE_INTERRUPTS();\r
- return errQUEUE_BLOCKED;\r
- }\r
- else\r
- {\r
- portENABLE_INTERRUPTS();\r
- return errQUEUE_FULL;\r
- }\r
- }\r
- }\r
- portENABLE_INTERRUPTS();\r
-\r
- portDISABLE_INTERRUPTS();\r
- {\r
- if( pxQueue->uxMessagesWaiting < pxQueue->uxLength )\r
- {\r
- /* There is room in the queue, copy the data into the queue. */\r
- prvCopyDataToQueue( pxQueue, pvItemToQueue, queueSEND_TO_BACK );\r
- xReturn = pdPASS;\r
-\r
- /* Were any co-routines waiting for data to become available? */\r
- if( listLIST_IS_EMPTY( &( pxQueue->xTasksWaitingToReceive ) ) == pdFALSE )\r
- {\r
- /* In this instance the co-routine could be placed directly\r
- into the ready list as we are within a critical section.\r
- Instead the same pending ready list mechanism is used as if\r
- the event were caused from within an interrupt. */\r
- if( xCoRoutineRemoveFromEventList( &( pxQueue->xTasksWaitingToReceive ) ) != pdFALSE )\r
- {\r
- /* The co-routine waiting has a higher priority so record\r
- that a yield might be appropriate. */\r
- xReturn = errQUEUE_YIELD;\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- else\r
- {\r
- xReturn = errQUEUE_FULL;\r
- }\r
- }\r
- portENABLE_INTERRUPTS();\r
-\r
- return xReturn;\r
- }\r
-\r
-#endif /* configUSE_CO_ROUTINES */\r
-/*-----------------------------------------------------------*/\r
-\r
-#if ( configUSE_CO_ROUTINES == 1 )\r
-\r
- BaseType_t xQueueCRReceive( QueueHandle_t xQueue, void *pvBuffer, TickType_t xTicksToWait )\r
- {\r
- BaseType_t xReturn;\r
- Queue_t * const pxQueue = ( Queue_t * ) xQueue;\r
-\r
- /* If the queue is already empty we may have to block. A critical section\r
- is required to prevent an interrupt adding something to the queue\r
- between the check to see if the queue is empty and blocking on the queue. */\r
- portDISABLE_INTERRUPTS();\r
- {\r
- if( pxQueue->uxMessagesWaiting == ( UBaseType_t ) 0 )\r
- {\r
- /* There are no messages in the queue, do we want to block or just\r
- leave with nothing? */\r
- if( xTicksToWait > ( TickType_t ) 0 )\r
- {\r
- /* As this is a co-routine we cannot block directly, but return\r
- indicating that we need to block. */\r
- vCoRoutineAddToDelayedList( xTicksToWait, &( pxQueue->xTasksWaitingToReceive ) );\r
- portENABLE_INTERRUPTS();\r
- return errQUEUE_BLOCKED;\r
- }\r
- else\r
- {\r
- portENABLE_INTERRUPTS();\r
- return errQUEUE_FULL;\r
- }\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- portENABLE_INTERRUPTS();\r
-\r
- portDISABLE_INTERRUPTS();\r
- {\r
- if( pxQueue->uxMessagesWaiting > ( UBaseType_t ) 0 )\r
- {\r
- /* Data is available from the queue. */\r
- pxQueue->u.pcReadFrom += pxQueue->uxItemSize;\r
- if( pxQueue->u.pcReadFrom >= pxQueue->pcTail )\r
- {\r
- pxQueue->u.pcReadFrom = pxQueue->pcHead;\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- --( pxQueue->uxMessagesWaiting );\r
- ( void ) memcpy( ( void * ) pvBuffer, ( void * ) pxQueue->u.pcReadFrom, ( unsigned ) pxQueue->uxItemSize );\r
-\r
- xReturn = pdPASS;\r
-\r
- /* Were any co-routines waiting for space to become available? */\r
- if( listLIST_IS_EMPTY( &( pxQueue->xTasksWaitingToSend ) ) == pdFALSE )\r
- {\r
- /* In this instance the co-routine could be placed directly\r
- into the ready list as we are within a critical section.\r
- Instead the same pending ready list mechanism is used as if\r
- the event were caused from within an interrupt. */\r
- if( xCoRoutineRemoveFromEventList( &( pxQueue->xTasksWaitingToSend ) ) != pdFALSE )\r
- {\r
- xReturn = errQUEUE_YIELD;\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- else\r
- {\r
- xReturn = pdFAIL;\r
- }\r
- }\r
- portENABLE_INTERRUPTS();\r
-\r
- return xReturn;\r
- }\r
-\r
-#endif /* configUSE_CO_ROUTINES */\r
-/*-----------------------------------------------------------*/\r
-\r
-#if ( configUSE_CO_ROUTINES == 1 )\r
-\r
- BaseType_t xQueueCRSendFromISR( QueueHandle_t xQueue, const void *pvItemToQueue, BaseType_t xCoRoutinePreviouslyWoken )\r
- {\r
- Queue_t * const pxQueue = ( Queue_t * ) xQueue;\r
-\r
- /* Cannot block within an ISR so if there is no space on the queue then\r
- exit without doing anything. */\r
- if( pxQueue->uxMessagesWaiting < pxQueue->uxLength )\r
- {\r
- prvCopyDataToQueue( pxQueue, pvItemToQueue, queueSEND_TO_BACK );\r
-\r
- /* We only want to wake one co-routine per ISR, so check that a\r
- co-routine has not already been woken. */\r
- if( xCoRoutinePreviouslyWoken == pdFALSE )\r
- {\r
- if( listLIST_IS_EMPTY( &( pxQueue->xTasksWaitingToReceive ) ) == pdFALSE )\r
- {\r
- if( xCoRoutineRemoveFromEventList( &( pxQueue->xTasksWaitingToReceive ) ) != pdFALSE )\r
- {\r
- return pdTRUE;\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
-\r
- return xCoRoutinePreviouslyWoken;\r
- }\r
-\r
-#endif /* configUSE_CO_ROUTINES */\r
-/*-----------------------------------------------------------*/\r
-\r
-#if ( configUSE_CO_ROUTINES == 1 )\r
-\r
- BaseType_t xQueueCRReceiveFromISR( QueueHandle_t xQueue, void *pvBuffer, BaseType_t *pxCoRoutineWoken )\r
- {\r
- BaseType_t xReturn;\r
- Queue_t * const pxQueue = ( Queue_t * ) xQueue;\r
-\r
- /* We cannot block from an ISR, so check there is data available. If\r
- not then just leave without doing anything. */\r
- if( pxQueue->uxMessagesWaiting > ( UBaseType_t ) 0 )\r
- {\r
- /* Copy the data from the queue. */\r
- pxQueue->u.pcReadFrom += pxQueue->uxItemSize;\r
- if( pxQueue->u.pcReadFrom >= pxQueue->pcTail )\r
- {\r
- pxQueue->u.pcReadFrom = pxQueue->pcHead;\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- --( pxQueue->uxMessagesWaiting );\r
- ( void ) memcpy( ( void * ) pvBuffer, ( void * ) pxQueue->u.pcReadFrom, ( unsigned ) pxQueue->uxItemSize );\r
-\r
- if( ( *pxCoRoutineWoken ) == pdFALSE )\r
- {\r
- if( listLIST_IS_EMPTY( &( pxQueue->xTasksWaitingToSend ) ) == pdFALSE )\r
- {\r
- if( xCoRoutineRemoveFromEventList( &( pxQueue->xTasksWaitingToSend ) ) != pdFALSE )\r
- {\r
- *pxCoRoutineWoken = pdTRUE;\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
-\r
- xReturn = pdPASS;\r
- }\r
- else\r
- {\r
- xReturn = pdFAIL;\r
- }\r
-\r
- return xReturn;\r
- }\r
-\r
-#endif /* configUSE_CO_ROUTINES */\r
-/*-----------------------------------------------------------*/\r
-\r
-#if ( configQUEUE_REGISTRY_SIZE > 0 )\r
-\r
- void vQueueAddToRegistry( QueueHandle_t xQueue, const char *pcQueueName ) /*lint !e971 Unqualified char types are allowed for strings and single characters only. */\r
- {\r
- UBaseType_t ux;\r
-\r
- /* See if there is an empty space in the registry. A NULL name denotes\r
- a free slot. */\r
- for( ux = ( UBaseType_t ) 0U; ux < ( UBaseType_t ) configQUEUE_REGISTRY_SIZE; ux++ )\r
- {\r
- if( xQueueRegistry[ ux ].pcQueueName == NULL )\r
- {\r
- /* Store the information on this queue. */\r
- xQueueRegistry[ ux ].pcQueueName = pcQueueName;\r
- xQueueRegistry[ ux ].xHandle = xQueue;\r
-\r
- traceQUEUE_REGISTRY_ADD( xQueue, pcQueueName );\r
- break;\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- }\r
-\r
-#endif /* configQUEUE_REGISTRY_SIZE */\r
-/*-----------------------------------------------------------*/\r
-\r
-#if ( configQUEUE_REGISTRY_SIZE > 0 )\r
-\r
- const char *pcQueueGetName( QueueHandle_t xQueue ) /*lint !e971 Unqualified char types are allowed for strings and single characters only. */\r
- {\r
- UBaseType_t ux;\r
- const char *pcReturn = NULL; /*lint !e971 Unqualified char types are allowed for strings and single characters only. */\r
-\r
- /* Note there is nothing here to protect against another task adding or\r
- removing entries from the registry while it is being searched. */\r
- for( ux = ( UBaseType_t ) 0U; ux < ( UBaseType_t ) configQUEUE_REGISTRY_SIZE; ux++ )\r
- {\r
- if( xQueueRegistry[ ux ].xHandle == xQueue )\r
- {\r
- pcReturn = xQueueRegistry[ ux ].pcQueueName;\r
- break;\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
-\r
- return pcReturn;\r
- } /*lint !e818 xQueue cannot be a pointer to const because it is a typedef. */\r
-\r
-#endif /* configQUEUE_REGISTRY_SIZE */\r
-/*-----------------------------------------------------------*/\r
-\r
-#if ( configQUEUE_REGISTRY_SIZE > 0 )\r
-\r
- void vQueueUnregisterQueue( QueueHandle_t xQueue )\r
- {\r
- UBaseType_t ux;\r
-\r
- /* See if the handle of the queue being unregistered in actually in the\r
- registry. */\r
- for( ux = ( UBaseType_t ) 0U; ux < ( UBaseType_t ) configQUEUE_REGISTRY_SIZE; ux++ )\r
- {\r
- if( xQueueRegistry[ ux ].xHandle == xQueue )\r
- {\r
- /* Set the name to NULL to show that this slot if free again. */\r
- xQueueRegistry[ ux ].pcQueueName = NULL;\r
-\r
- /* Set the handle to NULL to ensure the same queue handle cannot\r
- appear in the registry twice if it is added, removed, then\r
- added again. */\r
- xQueueRegistry[ ux ].xHandle = ( QueueHandle_t ) 0;\r
- break;\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
-\r
- } /*lint !e818 xQueue could not be pointer to const because it is a typedef. */\r
-\r
-#endif /* configQUEUE_REGISTRY_SIZE */\r
-/*-----------------------------------------------------------*/\r
-\r
-#if ( configUSE_TIMERS == 1 )\r
-\r
- void vQueueWaitForMessageRestricted( QueueHandle_t xQueue, TickType_t xTicksToWait, const BaseType_t xWaitIndefinitely )\r
- {\r
- Queue_t * const pxQueue = ( Queue_t * ) xQueue;\r
-\r
- /* This function should not be called by application code hence the\r
- 'Restricted' in its name. It is not part of the public API. It is\r
- designed for use by kernel code, and has special calling requirements.\r
- It can result in vListInsert() being called on a list that can only\r
- possibly ever have one item in it, so the list will be fast, but even\r
- so it should be called with the scheduler locked and not from a critical\r
- section. */\r
-\r
- /* Only do anything if there are no messages in the queue. This function\r
- will not actually cause the task to block, just place it on a blocked\r
- list. It will not block until the scheduler is unlocked - at which\r
- time a yield will be performed. If an item is added to the queue while\r
- the queue is locked, and the calling task blocks on the queue, then the\r
- calling task will be immediately unblocked when the queue is unlocked. */\r
- prvLockQueue( pxQueue );\r
- if( pxQueue->uxMessagesWaiting == ( UBaseType_t ) 0U )\r
- {\r
- /* There is nothing in the queue, block for the specified period. */\r
- vTaskPlaceOnEventListRestricted( &( pxQueue->xTasksWaitingToReceive ), xTicksToWait, xWaitIndefinitely );\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- prvUnlockQueue( pxQueue );\r
- }\r
-\r
-#endif /* configUSE_TIMERS */\r
-/*-----------------------------------------------------------*/\r
-\r
-#if( ( configUSE_QUEUE_SETS == 1 ) && ( configSUPPORT_DYNAMIC_ALLOCATION == 1 ) )\r
-\r
- QueueSetHandle_t xQueueCreateSet( const UBaseType_t uxEventQueueLength )\r
- {\r
- QueueSetHandle_t pxQueue;\r
-\r
- pxQueue = xQueueGenericCreate( uxEventQueueLength, ( UBaseType_t ) sizeof( Queue_t * ), queueQUEUE_TYPE_SET );\r
-\r
- return pxQueue;\r
- }\r
-\r
-#endif /* configUSE_QUEUE_SETS */\r
-/*-----------------------------------------------------------*/\r
-\r
-#if ( configUSE_QUEUE_SETS == 1 )\r
-\r
- BaseType_t xQueueAddToSet( QueueSetMemberHandle_t xQueueOrSemaphore, QueueSetHandle_t xQueueSet )\r
- {\r
- BaseType_t xReturn;\r
-\r
- taskENTER_CRITICAL();\r
- {\r
- if( ( ( Queue_t * ) xQueueOrSemaphore )->pxQueueSetContainer != NULL )\r
- {\r
- /* Cannot add a queue/semaphore to more than one queue set. */\r
- xReturn = pdFAIL;\r
- }\r
- else if( ( ( Queue_t * ) xQueueOrSemaphore )->uxMessagesWaiting != ( UBaseType_t ) 0 )\r
- {\r
- /* Cannot add a queue/semaphore to a queue set if there are already\r
- items in the queue/semaphore. */\r
- xReturn = pdFAIL;\r
- }\r
- else\r
- {\r
- ( ( Queue_t * ) xQueueOrSemaphore )->pxQueueSetContainer = xQueueSet;\r
- xReturn = pdPASS;\r
- }\r
- }\r
- taskEXIT_CRITICAL();\r
-\r
- return xReturn;\r
- }\r
-\r
-#endif /* configUSE_QUEUE_SETS */\r
-/*-----------------------------------------------------------*/\r
-\r
-#if ( configUSE_QUEUE_SETS == 1 )\r
-\r
- BaseType_t xQueueRemoveFromSet( QueueSetMemberHandle_t xQueueOrSemaphore, QueueSetHandle_t xQueueSet )\r
- {\r
- BaseType_t xReturn;\r
- Queue_t * const pxQueueOrSemaphore = ( Queue_t * ) xQueueOrSemaphore;\r
-\r
- if( pxQueueOrSemaphore->pxQueueSetContainer != xQueueSet )\r
- {\r
- /* The queue was not a member of the set. */\r
- xReturn = pdFAIL;\r
- }\r
- else if( pxQueueOrSemaphore->uxMessagesWaiting != ( UBaseType_t ) 0 )\r
- {\r
- /* It is dangerous to remove a queue from a set when the queue is\r
- not empty because the queue set will still hold pending events for\r
- the queue. */\r
- xReturn = pdFAIL;\r
- }\r
- else\r
- {\r
- taskENTER_CRITICAL();\r
- {\r
- /* The queue is no longer contained in the set. */\r
- pxQueueOrSemaphore->pxQueueSetContainer = NULL;\r
- }\r
- taskEXIT_CRITICAL();\r
- xReturn = pdPASS;\r
- }\r
-\r
- return xReturn;\r
- } /*lint !e818 xQueueSet could not be declared as pointing to const as it is a typedef. */\r
-\r
-#endif /* configUSE_QUEUE_SETS */\r
-/*-----------------------------------------------------------*/\r
-\r
-#if ( configUSE_QUEUE_SETS == 1 )\r
-\r
- QueueSetMemberHandle_t xQueueSelectFromSet( QueueSetHandle_t xQueueSet, TickType_t const xTicksToWait )\r
- {\r
- QueueSetMemberHandle_t xReturn = NULL;\r
-\r
- ( void ) xQueueReceive( ( QueueHandle_t ) xQueueSet, &xReturn, xTicksToWait ); /*lint !e961 Casting from one typedef to another is not redundant. */\r
- return xReturn;\r
- }\r
-\r
-#endif /* configUSE_QUEUE_SETS */\r
-/*-----------------------------------------------------------*/\r
-\r
-#if ( configUSE_QUEUE_SETS == 1 )\r
-\r
- QueueSetMemberHandle_t xQueueSelectFromSetFromISR( QueueSetHandle_t xQueueSet )\r
- {\r
- QueueSetMemberHandle_t xReturn = NULL;\r
-\r
- ( void ) xQueueReceiveFromISR( ( QueueHandle_t ) xQueueSet, &xReturn, NULL ); /*lint !e961 Casting from one typedef to another is not redundant. */\r
- return xReturn;\r
- }\r
-\r
-#endif /* configUSE_QUEUE_SETS */\r
-/*-----------------------------------------------------------*/\r
-\r
-#if ( configUSE_QUEUE_SETS == 1 )\r
-\r
- static BaseType_t prvNotifyQueueSetContainer( const Queue_t * const pxQueue, const BaseType_t xCopyPosition )\r
- {\r
- Queue_t *pxQueueSetContainer = pxQueue->pxQueueSetContainer;\r
- BaseType_t xReturn = pdFALSE;\r
-\r
- /* This function must be called form a critical section. */\r
-\r
- configASSERT( pxQueueSetContainer );\r
- configASSERT( pxQueueSetContainer->uxMessagesWaiting < pxQueueSetContainer->uxLength );\r
-\r
- if( pxQueueSetContainer->uxMessagesWaiting < pxQueueSetContainer->uxLength )\r
- {\r
- const int8_t cTxLock = pxQueueSetContainer->cTxLock;\r
-\r
- traceQUEUE_SEND( pxQueueSetContainer );\r
-\r
- /* The data copied is the handle of the queue that contains data. */\r
- xReturn = prvCopyDataToQueue( pxQueueSetContainer, &pxQueue, xCopyPosition );\r
-\r
- if( cTxLock == queueUNLOCKED )\r
- {\r
- if( listLIST_IS_EMPTY( &( pxQueueSetContainer->xTasksWaitingToReceive ) ) == pdFALSE )\r
- {\r
- if( xTaskRemoveFromEventList( &( pxQueueSetContainer->xTasksWaitingToReceive ) ) != pdFALSE )\r
- {\r
- /* The task waiting has a higher priority. */\r
- xReturn = pdTRUE;\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- else\r
- {\r
- pxQueueSetContainer->cTxLock = ( int8_t ) ( cTxLock + 1 );\r
- }\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
-\r
- return xReturn;\r
- }\r
-\r
-#endif /* configUSE_QUEUE_SETS */\r
-\r
-\r
-\r
-\r
-\r
-\r
-\r
-\r
-\r
-\r
-\r
-\r
+++ /dev/null
-/*\r
- * FreeRTOS Kernel V10.0.1\r
- * Copyright (C) 2017 Amazon.com, Inc. or its affiliates. All Rights Reserved.\r
- *\r
- * Permission is hereby granted, free of charge, to any person obtaining a copy of\r
- * this software and associated documentation files (the "Software"), to deal in\r
- * the Software without restriction, including without limitation the rights to\r
- * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of\r
- * the Software, and to permit persons to whom the Software is furnished to do so,\r
- * subject to the following conditions:\r
- *\r
- * The above copyright notice and this permission notice shall be included in all\r
- * copies or substantial portions of the Software.\r
- *\r
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\r
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS\r
- * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR\r
- * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER\r
- * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN\r
- * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\r
- *\r
- * http://www.FreeRTOS.org\r
- * http://aws.amazon.com/freertos\r
- *\r
- * 1 tab == 4 spaces!\r
- */\r
-\r
-/* Standard includes. */\r
-#include <stdint.h>\r
-#include <string.h>\r
-\r
-/* Defining MPU_WRAPPERS_INCLUDED_FROM_API_FILE prevents task.h from redefining\r
-all the API functions to use the MPU wrappers. That should only be done when\r
-task.h is included from an application file. */\r
-#define MPU_WRAPPERS_INCLUDED_FROM_API_FILE\r
-\r
-/* FreeRTOS includes. */\r
-#include "FreeRTOS.h"\r
-#include "task.h"\r
-#include "stream_buffer.h"\r
-\r
-#if( configUSE_TASK_NOTIFICATIONS != 1 )\r
- #error configUSE_TASK_NOTIFICATIONS must be set to 1 to build stream_buffer.c\r
-#endif\r
-\r
-/* Lint e961 and e750 are suppressed as a MISRA exception justified because the\r
-MPU ports require MPU_WRAPPERS_INCLUDED_FROM_API_FILE to be defined for the\r
-header files above, but not in this file, in order to generate the correct\r
-privileged Vs unprivileged linkage and placement. */\r
-#undef MPU_WRAPPERS_INCLUDED_FROM_API_FILE /*lint !e961 !e750. */\r
-\r
-/* If the user has not provided application specific Rx notification macros,\r
-or #defined the notification macros away, them provide default implementations\r
-that uses task notifications. */\r
-/*lint -save -e9026 Function like macros allowed and needed here so they can be overidden. */\r
-#ifndef sbRECEIVE_COMPLETED\r
- #define sbRECEIVE_COMPLETED( pxStreamBuffer ) \\r
- vTaskSuspendAll(); \\r
- { \\r
- if( ( pxStreamBuffer )->xTaskWaitingToSend != NULL ) \\r
- { \\r
- ( void ) xTaskNotify( ( pxStreamBuffer )->xTaskWaitingToSend, \\r
- ( uint32_t ) 0, \\r
- eNoAction ); \\r
- ( pxStreamBuffer )->xTaskWaitingToSend = NULL; \\r
- } \\r
- } \\r
- ( void ) xTaskResumeAll();\r
-#endif /* sbRECEIVE_COMPLETED */\r
-\r
-#ifndef sbRECEIVE_COMPLETED_FROM_ISR\r
- #define sbRECEIVE_COMPLETED_FROM_ISR( pxStreamBuffer, \\r
- pxHigherPriorityTaskWoken ) \\r
- { \\r
- UBaseType_t uxSavedInterruptStatus; \\r
- \\r
- uxSavedInterruptStatus = ( UBaseType_t ) portSET_INTERRUPT_MASK_FROM_ISR(); \\r
- { \\r
- if( ( pxStreamBuffer )->xTaskWaitingToSend != NULL ) \\r
- { \\r
- ( void ) xTaskNotifyFromISR( ( pxStreamBuffer )->xTaskWaitingToSend, \\r
- ( uint32_t ) 0, \\r
- eNoAction, \\r
- pxHigherPriorityTaskWoken ); \\r
- ( pxStreamBuffer )->xTaskWaitingToSend = NULL; \\r
- } \\r
- } \\r
- portCLEAR_INTERRUPT_MASK_FROM_ISR( uxSavedInterruptStatus ); \\r
- }\r
-#endif /* sbRECEIVE_COMPLETED_FROM_ISR */\r
-\r
-/* If the user has not provided an application specific Tx notification macro,\r
-or #defined the notification macro away, them provide a default implementation\r
-that uses task notifications. */\r
-#ifndef sbSEND_COMPLETED\r
- #define sbSEND_COMPLETED( pxStreamBuffer ) \\r
- vTaskSuspendAll(); \\r
- { \\r
- if( ( pxStreamBuffer )->xTaskWaitingToReceive != NULL ) \\r
- { \\r
- ( void ) xTaskNotify( ( pxStreamBuffer )->xTaskWaitingToReceive, \\r
- ( uint32_t ) 0, \\r
- eNoAction ); \\r
- ( pxStreamBuffer )->xTaskWaitingToReceive = NULL; \\r
- } \\r
- } \\r
- ( void ) xTaskResumeAll();\r
-#endif /* sbSEND_COMPLETED */\r
-\r
-#ifndef sbSEND_COMPLETE_FROM_ISR\r
- #define sbSEND_COMPLETE_FROM_ISR( pxStreamBuffer, pxHigherPriorityTaskWoken ) \\r
- { \\r
- UBaseType_t uxSavedInterruptStatus; \\r
- \\r
- uxSavedInterruptStatus = ( UBaseType_t ) portSET_INTERRUPT_MASK_FROM_ISR(); \\r
- { \\r
- if( ( pxStreamBuffer )->xTaskWaitingToReceive != NULL ) \\r
- { \\r
- ( void ) xTaskNotifyFromISR( ( pxStreamBuffer )->xTaskWaitingToReceive, \\r
- ( uint32_t ) 0, \\r
- eNoAction, \\r
- pxHigherPriorityTaskWoken ); \\r
- ( pxStreamBuffer )->xTaskWaitingToReceive = NULL; \\r
- } \\r
- } \\r
- portCLEAR_INTERRUPT_MASK_FROM_ISR( uxSavedInterruptStatus ); \\r
- }\r
-#endif /* sbSEND_COMPLETE_FROM_ISR */\r
-/*lint -restore (9026) */\r
-\r
-/* The number of bytes used to hold the length of a message in the buffer. */\r
-#define sbBYTES_TO_STORE_MESSAGE_LENGTH ( sizeof( size_t ) )\r
-\r
-/* Bits stored in the ucFlags field of the stream buffer. */\r
-#define sbFLAGS_IS_MESSAGE_BUFFER ( ( uint8_t ) 1 ) /* Set if the stream buffer was created as a message buffer, in which case it holds discrete messages rather than a stream. */\r
-#define sbFLAGS_IS_STATICALLY_ALLOCATED ( ( uint8_t ) 2 ) /* Set if the stream buffer was created using statically allocated memory. */\r
-\r
-/*-----------------------------------------------------------*/\r
-\r
-/* Structure that hold state information on the buffer. */\r
-typedef struct xSTREAM_BUFFER /*lint !e9058 Style convention uses tag. */\r
-{\r
- volatile size_t xTail; /* Index to the next item to read within the buffer. */\r
- volatile size_t xHead; /* Index to the next item to write within the buffer. */\r
- size_t xLength; /* The length of the buffer pointed to by pucBuffer. */\r
- size_t xTriggerLevelBytes; /* The number of bytes that must be in the stream buffer before a task that is waiting for data is unblocked. */\r
- volatile TaskHandle_t xTaskWaitingToReceive; /* Holds the handle of a task waiting for data, or NULL if no tasks are waiting. */\r
- volatile TaskHandle_t xTaskWaitingToSend; /* Holds the handle of a task waiting to send data to a message buffer that is full. */\r
- uint8_t *pucBuffer; /* Points to the buffer itself - that is - the RAM that stores the data passed through the buffer. */\r
- uint8_t ucFlags;\r
-\r
- #if ( configUSE_TRACE_FACILITY == 1 )\r
- UBaseType_t uxStreamBufferNumber; /* Used for tracing purposes. */\r
- #endif\r
-} StreamBuffer_t;\r
-\r
-/*\r
- * The number of bytes available to be read from the buffer.\r
- */\r
-static size_t prvBytesInBuffer( const StreamBuffer_t * const pxStreamBuffer ) PRIVILEGED_FUNCTION;\r
-\r
-/*\r
- * Add xCount bytes from pucData into the pxStreamBuffer message buffer.\r
- * Returns the number of bytes written, which will either equal xCount in the\r
- * success case, or 0 if there was not enough space in the buffer (in which case\r
- * no data is written into the buffer).\r
- */\r
-static size_t prvWriteBytesToBuffer( StreamBuffer_t * const pxStreamBuffer, const uint8_t *pucData, size_t xCount ) PRIVILEGED_FUNCTION;\r
-\r
-/*\r
- * If the stream buffer is being used as a message buffer, then reads an entire\r
- * message out of the buffer. If the stream buffer is being used as a stream\r
- * buffer then read as many bytes as possible from the buffer.\r
- * prvReadBytesFromBuffer() is called to actually extract the bytes from the\r
- * buffer's data storage area.\r
- */\r
-static size_t prvReadMessageFromBuffer( StreamBuffer_t *pxStreamBuffer,\r
- void *pvRxData,\r
- size_t xBufferLengthBytes,\r
- size_t xBytesAvailable,\r
- size_t xBytesToStoreMessageLength ) PRIVILEGED_FUNCTION;\r
-\r
-/*\r
- * If the stream buffer is being used as a message buffer, then writes an entire\r
- * message to the buffer. If the stream buffer is being used as a stream\r
- * buffer then write as many bytes as possible to the buffer.\r
- * prvWriteBytestoBuffer() is called to actually send the bytes to the buffer's\r
- * data storage area.\r
- */\r
-static size_t prvWriteMessageToBuffer( StreamBuffer_t * const pxStreamBuffer,\r
- const void * pvTxData,\r
- size_t xDataLengthBytes,\r
- size_t xSpace,\r
- size_t xRequiredSpace ) PRIVILEGED_FUNCTION;\r
-\r
-/*\r
- * Read xMaxCount bytes from the pxStreamBuffer message buffer and write them\r
- * to pucData.\r
- */\r
-static size_t prvReadBytesFromBuffer( StreamBuffer_t *pxStreamBuffer,\r
- uint8_t *pucData,\r
- size_t xMaxCount,\r
- size_t xBytesAvailable ); PRIVILEGED_FUNCTION\r
-\r
-/*\r
- * Called by both pxStreamBufferCreate() and pxStreamBufferCreateStatic() to\r
- * initialise the members of the newly created stream buffer structure.\r
- */\r
-static void prvInitialiseNewStreamBuffer( StreamBuffer_t * const pxStreamBuffer,\r
- uint8_t * const pucBuffer,\r
- size_t xBufferSizeBytes,\r
- size_t xTriggerLevelBytes,\r
- BaseType_t xIsMessageBuffer ) PRIVILEGED_FUNCTION;\r
-\r
-/*-----------------------------------------------------------*/\r
-\r
-#if( configSUPPORT_DYNAMIC_ALLOCATION == 1 )\r
-\r
- StreamBufferHandle_t xStreamBufferGenericCreate( size_t xBufferSizeBytes, size_t xTriggerLevelBytes, BaseType_t xIsMessageBuffer )\r
- {\r
- uint8_t *pucAllocatedMemory;\r
-\r
- /* In case the stream buffer is going to be used as a message buffer\r
- (that is, it will hold discrete messages with a little meta data that\r
- says how big the next message is) check the buffer will be large enough\r
- to hold at least one message. */\r
- configASSERT( xBufferSizeBytes > sbBYTES_TO_STORE_MESSAGE_LENGTH );\r
- configASSERT( xTriggerLevelBytes <= xBufferSizeBytes );\r
-\r
- /* A trigger level of 0 would cause a waiting task to unblock even when\r
- the buffer was empty. */\r
- if( xTriggerLevelBytes == ( size_t ) 0 )\r
- {\r
- xTriggerLevelBytes = ( size_t ) 1; /*lint !e9044 Parameter modified to ensure it doesn't have a dangerous value. */\r
- }\r
-\r
- /* A stream buffer requires a StreamBuffer_t structure and a buffer.\r
- Both are allocated in a single call to pvPortMalloc(). The\r
- StreamBuffer_t structure is placed at the start of the allocated memory\r
- and the buffer follows immediately after. The requested size is\r
- incremented so the free space is returned as the user would expect -\r
- this is a quirk of the implementation that means otherwise the free\r
- space would be reported as one byte smaller than would be logically\r
- expected. */\r
- xBufferSizeBytes++;\r
- pucAllocatedMemory = ( uint8_t * ) pvPortMalloc( xBufferSizeBytes + sizeof( StreamBuffer_t ) ); /*lint !e9079 malloc() only returns void*. */\r
-\r
- if( pucAllocatedMemory != NULL )\r
- {\r
- prvInitialiseNewStreamBuffer( ( StreamBuffer_t * ) pucAllocatedMemory, /* Structure at the start of the allocated memory. */ /*lint !e9087 Safe cast as allocated memory is aligned. */ /*lint !e826 Area is not too small and alignment is guaranteed provided malloc() behaves as expected and returns aligned buffer. */\r
- pucAllocatedMemory + sizeof( StreamBuffer_t ), /* Storage area follows. */ /*lint !e9016 Indexing past structure valid for uint8_t pointer, also storage area has no alignment requirement. */\r
- xBufferSizeBytes,\r
- xTriggerLevelBytes,\r
- xIsMessageBuffer );\r
-\r
- traceSTREAM_BUFFER_CREATE( ( ( StreamBuffer_t * ) pucAllocatedMemory ), xIsMessageBuffer );\r
- }\r
- else\r
- {\r
- traceSTREAM_BUFFER_CREATE_FAILED( xIsMessageBuffer );\r
- }\r
-\r
- return ( StreamBufferHandle_t * ) pucAllocatedMemory; /*lint !e9087 !e826 Safe cast as allocated memory is aligned. */\r
- }\r
-\r
-#endif /* configSUPPORT_DYNAMIC_ALLOCATION */\r
-/*-----------------------------------------------------------*/\r
-\r
-#if( configSUPPORT_STATIC_ALLOCATION == 1 )\r
-\r
- StreamBufferHandle_t xStreamBufferGenericCreateStatic( size_t xBufferSizeBytes,\r
- size_t xTriggerLevelBytes,\r
- BaseType_t xIsMessageBuffer,\r
- uint8_t * const pucStreamBufferStorageArea,\r
- StaticStreamBuffer_t * const pxStaticStreamBuffer )\r
- {\r
- StreamBuffer_t * const pxStreamBuffer = ( StreamBuffer_t * ) pxStaticStreamBuffer; /*lint !e740 !e9087 Safe cast as StaticStreamBuffer_t is opaque Streambuffer_t. */\r
- StreamBufferHandle_t xReturn;\r
-\r
- configASSERT( pucStreamBufferStorageArea );\r
- configASSERT( pxStaticStreamBuffer );\r
- configASSERT( xTriggerLevelBytes <= xBufferSizeBytes );\r
-\r
- /* A trigger level of 0 would cause a waiting task to unblock even when\r
- the buffer was empty. */\r
- if( xTriggerLevelBytes == ( size_t ) 0 )\r
- {\r
- xTriggerLevelBytes = ( size_t ) 1; /*lint !e9044 Function parameter deliberately modified to ensure it is in range. */\r
- }\r
-\r
- /* In case the stream buffer is going to be used as a message buffer\r
- (that is, it will hold discrete messages with a little meta data that\r
- says how big the next message is) check the buffer will be large enough\r
- to hold at least one message. */\r
- configASSERT( xBufferSizeBytes > sbBYTES_TO_STORE_MESSAGE_LENGTH );\r
-\r
- #if( configASSERT_DEFINED == 1 )\r
- {\r
- /* Sanity check that the size of the structure used to declare a\r
- variable of type StaticStreamBuffer_t equals the size of the real\r
- message buffer structure. */\r
- volatile size_t xSize = sizeof( StaticStreamBuffer_t );\r
- configASSERT( xSize == sizeof( StreamBuffer_t ) );\r
- }\r
- #endif /* configASSERT_DEFINED */\r
-\r
- if( ( pucStreamBufferStorageArea != NULL ) && ( pxStaticStreamBuffer != NULL ) )\r
- {\r
- prvInitialiseNewStreamBuffer( pxStreamBuffer,\r
- pucStreamBufferStorageArea,\r
- xBufferSizeBytes,\r
- xTriggerLevelBytes,\r
- xIsMessageBuffer );\r
-\r
- /* Remember this was statically allocated in case it is ever deleted\r
- again. */\r
- pxStreamBuffer->ucFlags |= sbFLAGS_IS_STATICALLY_ALLOCATED;\r
-\r
- traceSTREAM_BUFFER_CREATE( pxStreamBuffer, xIsMessageBuffer );\r
-\r
- xReturn = ( StreamBufferHandle_t ) pxStaticStreamBuffer; /*lint !e9087 Data hiding requires cast to opaque type. */\r
- }\r
- else\r
- {\r
- xReturn = NULL;\r
- traceSTREAM_BUFFER_CREATE_STATIC_FAILED( xReturn, xIsMessageBuffer );\r
- }\r
-\r
- return xReturn;\r
- }\r
-\r
-#endif /* ( configSUPPORT_STATIC_ALLOCATION == 1 ) */\r
-/*-----------------------------------------------------------*/\r
-\r
-void vStreamBufferDelete( StreamBufferHandle_t xStreamBuffer )\r
-{\r
-StreamBuffer_t * pxStreamBuffer = ( StreamBuffer_t * ) xStreamBuffer; /*lint !e9087 !e9079 Safe cast as StreamBufferHandle_t is opaque Streambuffer_t. */\r
-\r
- configASSERT( pxStreamBuffer );\r
-\r
- traceSTREAM_BUFFER_DELETE( xStreamBuffer );\r
-\r
- if( ( pxStreamBuffer->ucFlags & sbFLAGS_IS_STATICALLY_ALLOCATED ) == ( uint8_t ) pdFALSE )\r
- {\r
- #if( configSUPPORT_DYNAMIC_ALLOCATION == 1 )\r
- {\r
- /* Both the structure and the buffer were allocated using a single call\r
- to pvPortMalloc(), hence only one call to vPortFree() is required. */\r
- vPortFree( ( void * ) pxStreamBuffer ); /*lint !e9087 Standard free() semantics require void *, plus pxStreamBuffer was allocated by pvPortMalloc(). */\r
- }\r
- #else\r
- {\r
- /* Should not be possible to get here, ucFlags must be corrupt.\r
- Force an assert. */\r
- configASSERT( xStreamBuffer == ( StreamBufferHandle_t ) ~0 );\r
- }\r
- #endif\r
- }\r
- else\r
- {\r
- /* The structure and buffer were not allocated dynamically and cannot be\r
- freed - just scrub the structure so future use will assert. */\r
- memset( pxStreamBuffer, 0x00, sizeof( StreamBuffer_t ) );\r
- }\r
-}\r
-/*-----------------------------------------------------------*/\r
-\r
-BaseType_t xStreamBufferReset( StreamBufferHandle_t xStreamBuffer )\r
-{\r
-StreamBuffer_t * const pxStreamBuffer = ( StreamBuffer_t * ) xStreamBuffer; /*lint !e9087 !e9079 Safe cast as StreamBufferHandle_t is opaque Streambuffer_t. */\r
-BaseType_t xReturn = pdFAIL, xIsMessageBuffer;\r
-\r
-#if( configUSE_TRACE_FACILITY == 1 )\r
- UBaseType_t uxStreamBufferNumber;\r
-#endif\r
-\r
- configASSERT( pxStreamBuffer );\r
-\r
- #if( configUSE_TRACE_FACILITY == 1 )\r
- {\r
- /* Store the stream buffer number so it can be restored after the\r
- reset. */\r
- uxStreamBufferNumber = pxStreamBuffer->uxStreamBufferNumber;\r
- }\r
- #endif\r
-\r
- /* Can only reset a message buffer if there are no tasks blocked on it. */\r
- if( pxStreamBuffer->xTaskWaitingToReceive == NULL )\r
- {\r
- if( pxStreamBuffer->xTaskWaitingToSend == NULL )\r
- {\r
- if( ( pxStreamBuffer->ucFlags & sbFLAGS_IS_MESSAGE_BUFFER ) != ( uint8_t ) 0 )\r
- {\r
- xIsMessageBuffer = pdTRUE;\r
- }\r
- else\r
- {\r
- xIsMessageBuffer = pdFALSE;\r
- }\r
-\r
- prvInitialiseNewStreamBuffer( pxStreamBuffer,\r
- pxStreamBuffer->pucBuffer,\r
- pxStreamBuffer->xLength,\r
- pxStreamBuffer->xTriggerLevelBytes,\r
- xIsMessageBuffer );\r
- xReturn = pdPASS;\r
-\r
- #if( configUSE_TRACE_FACILITY == 1 )\r
- {\r
- pxStreamBuffer->uxStreamBufferNumber = uxStreamBufferNumber;\r
- }\r
- #endif\r
-\r
- traceSTREAM_BUFFER_RESET( xStreamBuffer );\r
- }\r
- }\r
-\r
- return xReturn;\r
-}\r
-/*-----------------------------------------------------------*/\r
-\r
-BaseType_t xStreamBufferSetTriggerLevel( StreamBufferHandle_t xStreamBuffer, size_t xTriggerLevel )\r
-{\r
-StreamBuffer_t * const pxStreamBuffer = ( StreamBuffer_t * ) xStreamBuffer; /*lint !e9087 !e9079 Safe cast as StreamBufferHandle_t is opaque Streambuffer_t. */\r
-BaseType_t xReturn;\r
-\r
- configASSERT( pxStreamBuffer );\r
-\r
- /* It is not valid for the trigger level to be 0. */\r
- if( xTriggerLevel == ( size_t ) 0 )\r
- {\r
- xTriggerLevel = ( size_t ) 1; /*lint !e9044 Parameter modified to ensure it doesn't have a dangerous value. */\r
- }\r
-\r
- /* The trigger level is the number of bytes that must be in the stream\r
- buffer before a task that is waiting for data is unblocked. */\r
- if( xTriggerLevel <= pxStreamBuffer->xLength )\r
- {\r
- pxStreamBuffer->xTriggerLevelBytes = xTriggerLevel;\r
- xReturn = pdPASS;\r
- }\r
- else\r
- {\r
- xReturn = pdFALSE;\r
- }\r
-\r
- return xReturn;\r
-}\r
-/*-----------------------------------------------------------*/\r
-\r
-size_t xStreamBufferSpacesAvailable( StreamBufferHandle_t xStreamBuffer )\r
-{\r
-const StreamBuffer_t * const pxStreamBuffer = ( StreamBuffer_t * ) xStreamBuffer; /*lint !e9087 !e9079 Safe cast as StreamBufferHandle_t is opaque Streambuffer_t. */\r
-size_t xSpace;\r
-\r
- configASSERT( pxStreamBuffer );\r
-\r
- xSpace = pxStreamBuffer->xLength + pxStreamBuffer->xTail;\r
- xSpace -= pxStreamBuffer->xHead;\r
- xSpace -= ( size_t ) 1;\r
-\r
- if( xSpace >= pxStreamBuffer->xLength )\r
- {\r
- xSpace -= pxStreamBuffer->xLength;\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
-\r
- return xSpace;\r
-}\r
-/*-----------------------------------------------------------*/\r
-\r
-size_t xStreamBufferBytesAvailable( StreamBufferHandle_t xStreamBuffer )\r
-{\r
-const StreamBuffer_t * const pxStreamBuffer = ( StreamBuffer_t * ) xStreamBuffer; /*lint !e9087 !e9079 Safe cast as StreamBufferHandle_t is opaque Streambuffer_t. */\r
-size_t xReturn;\r
-\r
- configASSERT( pxStreamBuffer );\r
-\r
- xReturn = prvBytesInBuffer( pxStreamBuffer );\r
- return xReturn;\r
-}\r
-/*-----------------------------------------------------------*/\r
-\r
-size_t xStreamBufferSend( StreamBufferHandle_t xStreamBuffer,\r
- const void *pvTxData,\r
- size_t xDataLengthBytes,\r
- TickType_t xTicksToWait )\r
-{\r
-StreamBuffer_t * const pxStreamBuffer = ( StreamBuffer_t * ) xStreamBuffer; /*lint !e9087 !e9079 Safe cast as StreamBufferHandle_t is opaque Streambuffer_t. */\r
-size_t xReturn, xSpace = 0;\r
-size_t xRequiredSpace = xDataLengthBytes;\r
-TimeOut_t xTimeOut;\r
-\r
- configASSERT( pvTxData );\r
- configASSERT( pxStreamBuffer );\r
-\r
- /* This send function is used to write to both message buffers and stream\r
- buffers. If this is a message buffer then the space needed must be\r
- increased by the amount of bytes needed to store the length of the\r
- message. */\r
- if( ( pxStreamBuffer->ucFlags & sbFLAGS_IS_MESSAGE_BUFFER ) != ( uint8_t ) 0 )\r
- {\r
- xRequiredSpace += sbBYTES_TO_STORE_MESSAGE_LENGTH;\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
-\r
- if( xTicksToWait != ( TickType_t ) 0 )\r
- {\r
- vTaskSetTimeOutState( &xTimeOut );\r
-\r
- do\r
- {\r
- /* Wait until the required number of bytes are free in the message\r
- buffer. */\r
- taskENTER_CRITICAL();\r
- {\r
- xSpace = xStreamBufferSpacesAvailable( pxStreamBuffer );\r
-\r
- if( xSpace < xRequiredSpace )\r
- {\r
- /* Clear notification state as going to wait for space. */\r
- ( void ) xTaskNotifyStateClear( NULL );\r
-\r
- /* Should only be one writer. */\r
- configASSERT( pxStreamBuffer->xTaskWaitingToSend == NULL );\r
- pxStreamBuffer->xTaskWaitingToSend = xTaskGetCurrentTaskHandle();\r
- }\r
- else\r
- {\r
- taskEXIT_CRITICAL();\r
- break;\r
- }\r
- }\r
- taskEXIT_CRITICAL();\r
-\r
- traceBLOCKING_ON_STREAM_BUFFER_SEND( xStreamBuffer );\r
- ( void ) xTaskNotifyWait( ( uint32_t ) 0, UINT32_MAX, NULL, xTicksToWait );\r
- pxStreamBuffer->xTaskWaitingToSend = NULL;\r
-\r
- } while( xTaskCheckForTimeOut( &xTimeOut, &xTicksToWait ) == pdFALSE );\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
-\r
- if( xSpace == ( size_t ) 0 )\r
- {\r
- xSpace = xStreamBufferSpacesAvailable( pxStreamBuffer );\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
-\r
- xReturn = prvWriteMessageToBuffer( pxStreamBuffer, pvTxData, xDataLengthBytes, xSpace, xRequiredSpace );\r
-\r
- if( xReturn > ( size_t ) 0 )\r
- {\r
- traceSTREAM_BUFFER_SEND( xStreamBuffer, xReturn );\r
-\r
- /* Was a task waiting for the data? */\r
- if( prvBytesInBuffer( pxStreamBuffer ) >= pxStreamBuffer->xTriggerLevelBytes )\r
- {\r
- sbSEND_COMPLETED( pxStreamBuffer );\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- traceSTREAM_BUFFER_SEND_FAILED( xStreamBuffer );\r
- }\r
-\r
- return xReturn;\r
-}\r
-/*-----------------------------------------------------------*/\r
-\r
-size_t xStreamBufferSendFromISR( StreamBufferHandle_t xStreamBuffer,\r
- const void *pvTxData,\r
- size_t xDataLengthBytes,\r
- BaseType_t * const pxHigherPriorityTaskWoken )\r
-{\r
-StreamBuffer_t * const pxStreamBuffer = ( StreamBuffer_t * ) xStreamBuffer; /*lint !e9087 !e9079 Safe cast as StreamBufferHandle_t is opaque Streambuffer_t. */\r
-size_t xReturn, xSpace;\r
-size_t xRequiredSpace = xDataLengthBytes;\r
-\r
- configASSERT( pvTxData );\r
- configASSERT( pxStreamBuffer );\r
-\r
- /* This send function is used to write to both message buffers and stream\r
- buffers. If this is a message buffer then the space needed must be\r
- increased by the amount of bytes needed to store the length of the\r
- message. */\r
- if( ( pxStreamBuffer->ucFlags & sbFLAGS_IS_MESSAGE_BUFFER ) != ( uint8_t ) 0 )\r
- {\r
- xRequiredSpace += sbBYTES_TO_STORE_MESSAGE_LENGTH;\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
-\r
- xSpace = xStreamBufferSpacesAvailable( pxStreamBuffer );\r
- xReturn = prvWriteMessageToBuffer( pxStreamBuffer, pvTxData, xDataLengthBytes, xSpace, xRequiredSpace );\r
-\r
- if( xReturn > ( size_t ) 0 )\r
- {\r
- /* Was a task waiting for the data? */\r
- if( prvBytesInBuffer( pxStreamBuffer ) >= pxStreamBuffer->xTriggerLevelBytes )\r
- {\r
- sbSEND_COMPLETE_FROM_ISR( pxStreamBuffer, pxHigherPriorityTaskWoken );\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
-\r
- traceSTREAM_BUFFER_SEND_FROM_ISR( xStreamBuffer, xReturn );\r
-\r
- return xReturn;\r
-}\r
-/*-----------------------------------------------------------*/\r
-\r
-static size_t prvWriteMessageToBuffer( StreamBuffer_t * const pxStreamBuffer,\r
- const void * pvTxData,\r
- size_t xDataLengthBytes,\r
- size_t xSpace,\r
- size_t xRequiredSpace )\r
-{\r
- BaseType_t xShouldWrite;\r
- size_t xReturn;\r
-\r
- if( xSpace == ( size_t ) 0 )\r
- {\r
- /* Doesn't matter if this is a stream buffer or a message buffer, there\r
- is no space to write. */\r
- xShouldWrite = pdFALSE;\r
- }\r
- else if( ( pxStreamBuffer->ucFlags & sbFLAGS_IS_MESSAGE_BUFFER ) == ( uint8_t ) 0 )\r
- {\r
- /* This is a stream buffer, as opposed to a message buffer, so writing a\r
- stream of bytes rather than discrete messages. Write as many bytes as\r
- possible. */\r
- xShouldWrite = pdTRUE;\r
- xDataLengthBytes = configMIN( xDataLengthBytes, xSpace ); /*lint !e9044 Function parameter modified to ensure it is capped to available space. */\r
- }\r
- else if( xSpace >= xRequiredSpace )\r
- {\r
- /* This is a message buffer, as opposed to a stream buffer, and there\r
- is enough space to write both the message length and the message itself\r
- into the buffer. Start by writing the length of the data, the data\r
- itself will be written later in this function. */\r
- xShouldWrite = pdTRUE;\r
- ( void ) prvWriteBytesToBuffer( pxStreamBuffer, ( const uint8_t * ) &( xDataLengthBytes ), sbBYTES_TO_STORE_MESSAGE_LENGTH );\r
- }\r
- else\r
- {\r
- /* There is space available, but not enough space. */\r
- xShouldWrite = pdFALSE;\r
- }\r
-\r
- if( xShouldWrite != pdFALSE )\r
- {\r
- /* Writes the data itself. */\r
- xReturn = prvWriteBytesToBuffer( pxStreamBuffer, ( const uint8_t * ) pvTxData, xDataLengthBytes ); /*lint !e9079 Storage buffer is implemented as uint8_t for ease of sizing, alighment and access. */\r
- }\r
- else\r
- {\r
- xReturn = 0;\r
- }\r
-\r
- return xReturn;\r
-}\r
-/*-----------------------------------------------------------*/\r
-\r
-size_t xStreamBufferReceive( StreamBufferHandle_t xStreamBuffer,\r
- void *pvRxData,\r
- size_t xBufferLengthBytes,\r
- TickType_t xTicksToWait )\r
-{\r
-StreamBuffer_t * const pxStreamBuffer = ( StreamBuffer_t * ) xStreamBuffer; /*lint !e9087 !e9079 Safe cast as StreamBufferHandle_t is opaque Streambuffer_t. */\r
-size_t xReceivedLength = 0, xBytesAvailable, xBytesToStoreMessageLength;\r
-\r
- configASSERT( pvRxData );\r
- configASSERT( pxStreamBuffer );\r
-\r
- /* This receive function is used by both message buffers, which store\r
- discrete messages, and stream buffers, which store a continuous stream of\r
- bytes. Discrete messages include an additional\r
- sbBYTES_TO_STORE_MESSAGE_LENGTH bytes that hold the length of the\r
- message. */\r
- if( ( pxStreamBuffer->ucFlags & sbFLAGS_IS_MESSAGE_BUFFER ) != ( uint8_t ) 0 )\r
- {\r
- xBytesToStoreMessageLength = sbBYTES_TO_STORE_MESSAGE_LENGTH;\r
- }\r
- else\r
- {\r
- xBytesToStoreMessageLength = 0;\r
- }\r
-\r
- if( xTicksToWait != ( TickType_t ) 0 )\r
- {\r
- /* Checking if there is data and clearing the notification state must be\r
- performed atomically. */\r
- taskENTER_CRITICAL();\r
- {\r
- xBytesAvailable = prvBytesInBuffer( pxStreamBuffer );\r
-\r
- /* If this function was invoked by a message buffer read then\r
- xBytesToStoreMessageLength holds the number of bytes used to hold\r
- the length of the next discrete message. If this function was\r
- invoked by a stream buffer read then xBytesToStoreMessageLength will\r
- be 0. */\r
- if( xBytesAvailable <= xBytesToStoreMessageLength )\r
- {\r
- /* Clear notification state as going to wait for data. */\r
- ( void ) xTaskNotifyStateClear( NULL );\r
-\r
- /* Should only be one reader. */\r
- configASSERT( pxStreamBuffer->xTaskWaitingToReceive == NULL );\r
- pxStreamBuffer->xTaskWaitingToReceive = xTaskGetCurrentTaskHandle();\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- taskEXIT_CRITICAL();\r
-\r
- if( xBytesAvailable <= xBytesToStoreMessageLength )\r
- {\r
- /* Wait for data to be available. */\r
- traceBLOCKING_ON_STREAM_BUFFER_RECEIVE( xStreamBuffer );\r
- ( void ) xTaskNotifyWait( ( uint32_t ) 0, UINT32_MAX, NULL, xTicksToWait );\r
- pxStreamBuffer->xTaskWaitingToReceive = NULL;\r
-\r
- /* Recheck the data available after blocking. */\r
- xBytesAvailable = prvBytesInBuffer( pxStreamBuffer );\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- else\r
- {\r
- xBytesAvailable = prvBytesInBuffer( pxStreamBuffer );\r
- }\r
-\r
- /* Whether receiving a discrete message (where xBytesToStoreMessageLength\r
- holds the number of bytes used to store the message length) or a stream of\r
- bytes (where xBytesToStoreMessageLength is zero), the number of bytes\r
- available must be greater than xBytesToStoreMessageLength to be able to\r
- read bytes from the buffer. */\r
- if( xBytesAvailable > xBytesToStoreMessageLength )\r
- {\r
- xReceivedLength = prvReadMessageFromBuffer( pxStreamBuffer, pvRxData, xBufferLengthBytes, xBytesAvailable, xBytesToStoreMessageLength );\r
-\r
- /* Was a task waiting for space in the buffer? */\r
- if( xReceivedLength != ( size_t ) 0 )\r
- {\r
- traceSTREAM_BUFFER_RECEIVE( xStreamBuffer, xReceivedLength );\r
- sbRECEIVE_COMPLETED( pxStreamBuffer );\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- else\r
- {\r
- traceSTREAM_BUFFER_RECEIVE_FAILED( xStreamBuffer );\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
-\r
- return xReceivedLength;\r
-}\r
-/*-----------------------------------------------------------*/\r
-\r
-size_t xStreamBufferReceiveFromISR( StreamBufferHandle_t xStreamBuffer,\r
- void *pvRxData,\r
- size_t xBufferLengthBytes,\r
- BaseType_t * const pxHigherPriorityTaskWoken )\r
-{\r
-StreamBuffer_t * const pxStreamBuffer = ( StreamBuffer_t * ) xStreamBuffer; /*lint !e9087 !e9079 Safe cast as StreamBufferHandle_t is opaque Streambuffer_t. */\r
-size_t xReceivedLength = 0, xBytesAvailable, xBytesToStoreMessageLength;\r
-\r
- configASSERT( pvRxData );\r
- configASSERT( pxStreamBuffer );\r
-\r
- /* This receive function is used by both message buffers, which store\r
- discrete messages, and stream buffers, which store a continuous stream of\r
- bytes. Discrete messages include an additional\r
- sbBYTES_TO_STORE_MESSAGE_LENGTH bytes that hold the length of the\r
- message. */\r
- if( ( pxStreamBuffer->ucFlags & sbFLAGS_IS_MESSAGE_BUFFER ) != ( uint8_t ) 0 )\r
- {\r
- xBytesToStoreMessageLength = sbBYTES_TO_STORE_MESSAGE_LENGTH;\r
- }\r
- else\r
- {\r
- xBytesToStoreMessageLength = 0;\r
- }\r
-\r
- xBytesAvailable = prvBytesInBuffer( pxStreamBuffer );\r
-\r
- /* Whether receiving a discrete message (where xBytesToStoreMessageLength\r
- holds the number of bytes used to store the message length) or a stream of\r
- bytes (where xBytesToStoreMessageLength is zero), the number of bytes\r
- available must be greater than xBytesToStoreMessageLength to be able to\r
- read bytes from the buffer. */\r
- if( xBytesAvailable > xBytesToStoreMessageLength )\r
- {\r
- xReceivedLength = prvReadMessageFromBuffer( pxStreamBuffer, pvRxData, xBufferLengthBytes, xBytesAvailable, xBytesToStoreMessageLength );\r
-\r
- /* Was a task waiting for space in the buffer? */\r
- if( xReceivedLength != ( size_t ) 0 )\r
- {\r
- sbRECEIVE_COMPLETED_FROM_ISR( pxStreamBuffer, pxHigherPriorityTaskWoken );\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
-\r
- traceSTREAM_BUFFER_RECEIVE_FROM_ISR( xStreamBuffer, xReceivedLength );\r
-\r
- return xReceivedLength;\r
-}\r
-/*-----------------------------------------------------------*/\r
-\r
-static size_t prvReadMessageFromBuffer( StreamBuffer_t *pxStreamBuffer,\r
- void *pvRxData,\r
- size_t xBufferLengthBytes,\r
- size_t xBytesAvailable,\r
- size_t xBytesToStoreMessageLength )\r
-{\r
-size_t xOriginalTail, xReceivedLength, xNextMessageLength;\r
-\r
- if( xBytesToStoreMessageLength != ( size_t ) 0 )\r
- {\r
- /* A discrete message is being received. First receive the length\r
- of the message. A copy of the tail is stored so the buffer can be\r
- returned to its prior state if the length of the message is too\r
- large for the provided buffer. */\r
- xOriginalTail = pxStreamBuffer->xTail;\r
- ( void ) prvReadBytesFromBuffer( pxStreamBuffer, ( uint8_t * ) &xNextMessageLength, xBytesToStoreMessageLength, xBytesAvailable );\r
-\r
- /* Reduce the number of bytes available by the number of bytes just\r
- read out. */\r
- xBytesAvailable -= xBytesToStoreMessageLength;\r
-\r
- /* Check there is enough space in the buffer provided by the\r
- user. */\r
- if( xNextMessageLength > xBufferLengthBytes )\r
- {\r
- /* The user has provided insufficient space to read the message\r
- so return the buffer to its previous state (so the length of\r
- the message is in the buffer again). */\r
- pxStreamBuffer->xTail = xOriginalTail;\r
- xNextMessageLength = 0;\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- else\r
- {\r
- /* A stream of bytes is being received (as opposed to a discrete\r
- message), so read as many bytes as possible. */\r
- xNextMessageLength = xBufferLengthBytes;\r
- }\r
-\r
- /* Read the actual data. */\r
- xReceivedLength = prvReadBytesFromBuffer( pxStreamBuffer, ( uint8_t * ) pvRxData, xNextMessageLength, xBytesAvailable ); /*lint !e9079 Data storage area is implemented as uint8_t array for ease of sizing, indexing and alignment. */\r
-\r
- return xReceivedLength;\r
-}\r
-/*-----------------------------------------------------------*/\r
-\r
-BaseType_t xStreamBufferIsEmpty( StreamBufferHandle_t xStreamBuffer )\r
-{\r
-const StreamBuffer_t * const pxStreamBuffer = ( StreamBuffer_t * ) xStreamBuffer; /*lint !e9087 !e9079 Safe cast as StreamBufferHandle_t is opaque Streambuffer_t. */\r
-BaseType_t xReturn;\r
-size_t xTail;\r
-\r
- configASSERT( pxStreamBuffer );\r
-\r
- /* True if no bytes are available. */\r
- xTail = pxStreamBuffer->xTail;\r
- if( pxStreamBuffer->xHead == xTail )\r
- {\r
- xReturn = pdTRUE;\r
- }\r
- else\r
- {\r
- xReturn = pdFALSE;\r
- }\r
-\r
- return xReturn;\r
-}\r
-/*-----------------------------------------------------------*/\r
-\r
-BaseType_t xStreamBufferIsFull( StreamBufferHandle_t xStreamBuffer )\r
-{\r
-BaseType_t xReturn;\r
-size_t xBytesToStoreMessageLength;\r
-const StreamBuffer_t * const pxStreamBuffer = ( StreamBuffer_t * ) xStreamBuffer; /*lint !e9087 !e9079 Safe cast as StreamBufferHandle_t is opaque Streambuffer_t. */\r
-\r
- configASSERT( pxStreamBuffer );\r
-\r
- /* This generic version of the receive function is used by both message\r
- buffers, which store discrete messages, and stream buffers, which store a\r
- continuous stream of bytes. Discrete messages include an additional\r
- sbBYTES_TO_STORE_MESSAGE_LENGTH bytes that hold the length of the message. */\r
- if( ( pxStreamBuffer->ucFlags & sbFLAGS_IS_MESSAGE_BUFFER ) != ( uint8_t ) 0 )\r
- {\r
- xBytesToStoreMessageLength = sbBYTES_TO_STORE_MESSAGE_LENGTH;\r
- }\r
- else\r
- {\r
- xBytesToStoreMessageLength = 0;\r
- }\r
-\r
- /* True if the available space equals zero. */\r
- if( xStreamBufferSpacesAvailable( xStreamBuffer ) <= xBytesToStoreMessageLength )\r
- {\r
- xReturn = pdTRUE;\r
- }\r
- else\r
- {\r
- xReturn = pdFALSE;\r
- }\r
-\r
- return xReturn;\r
-}\r
-/*-----------------------------------------------------------*/\r
-\r
-BaseType_t xStreamBufferSendCompletedFromISR( StreamBufferHandle_t xStreamBuffer, BaseType_t *pxHigherPriorityTaskWoken )\r
-{\r
-StreamBuffer_t * const pxStreamBuffer = ( StreamBuffer_t * ) xStreamBuffer; /*lint !e9087 !e9079 Safe cast as StreamBufferHandle_t is opaque Streambuffer_t. */\r
-BaseType_t xReturn;\r
-UBaseType_t uxSavedInterruptStatus;\r
-\r
- configASSERT( pxStreamBuffer );\r
-\r
- uxSavedInterruptStatus = ( UBaseType_t ) portSET_INTERRUPT_MASK_FROM_ISR();\r
- {\r
- if( ( pxStreamBuffer )->xTaskWaitingToReceive != NULL )\r
- {\r
- ( void ) xTaskNotifyFromISR( ( pxStreamBuffer )->xTaskWaitingToReceive,\r
- ( uint32_t ) 0,\r
- eNoAction,\r
- pxHigherPriorityTaskWoken );\r
- ( pxStreamBuffer )->xTaskWaitingToReceive = NULL;\r
- xReturn = pdTRUE;\r
- }\r
- else\r
- {\r
- xReturn = pdFALSE;\r
- }\r
- }\r
- portCLEAR_INTERRUPT_MASK_FROM_ISR( uxSavedInterruptStatus );\r
-\r
- return xReturn;\r
-}\r
-/*-----------------------------------------------------------*/\r
-\r
-BaseType_t xStreamBufferReceiveCompletedFromISR( StreamBufferHandle_t xStreamBuffer, BaseType_t *pxHigherPriorityTaskWoken )\r
-{\r
-StreamBuffer_t * const pxStreamBuffer = ( StreamBuffer_t * ) xStreamBuffer; /*lint !e9087 !e9079 Safe cast as StreamBufferHandle_t is opaque Streambuffer_t. */\r
-BaseType_t xReturn;\r
-UBaseType_t uxSavedInterruptStatus;\r
-\r
- configASSERT( pxStreamBuffer );\r
-\r
- uxSavedInterruptStatus = ( UBaseType_t ) portSET_INTERRUPT_MASK_FROM_ISR();\r
- {\r
- if( ( pxStreamBuffer )->xTaskWaitingToSend != NULL )\r
- {\r
- ( void ) xTaskNotifyFromISR( ( pxStreamBuffer )->xTaskWaitingToSend,\r
- ( uint32_t ) 0,\r
- eNoAction,\r
- pxHigherPriorityTaskWoken );\r
- ( pxStreamBuffer )->xTaskWaitingToSend = NULL;\r
- xReturn = pdTRUE;\r
- }\r
- else\r
- {\r
- xReturn = pdFALSE;\r
- }\r
- }\r
- portCLEAR_INTERRUPT_MASK_FROM_ISR( uxSavedInterruptStatus );\r
-\r
- return xReturn;\r
-}\r
-/*-----------------------------------------------------------*/\r
-\r
-static size_t prvWriteBytesToBuffer( StreamBuffer_t * const pxStreamBuffer, const uint8_t *pucData, size_t xCount )\r
-{\r
-size_t xNextHead, xFirstLength;\r
-\r
- configASSERT( xCount > ( size_t ) 0 );\r
-\r
- xNextHead = pxStreamBuffer->xHead;\r
-\r
- /* Calculate the number of bytes that can be added in the first write -\r
- which may be less than the total number of bytes that need to be added if\r
- the buffer will wrap back to the beginning. */\r
- xFirstLength = configMIN( pxStreamBuffer->xLength - xNextHead, xCount );\r
-\r
- /* Write as many bytes as can be written in the first write. */\r
- configASSERT( ( xNextHead + xFirstLength ) <= pxStreamBuffer->xLength );\r
- memcpy( ( void* ) ( &( pxStreamBuffer->pucBuffer[ xNextHead ] ) ), ( const void * ) pucData, xFirstLength ); /*lint !e9087 memcpy() requires void *. */\r
-\r
- /* If the number of bytes written was less than the number that could be\r
- written in the first write... */\r
- if( xCount > xFirstLength )\r
- {\r
- /* ...then write the remaining bytes to the start of the buffer. */\r
- configASSERT( ( xCount - xFirstLength ) <= pxStreamBuffer->xLength );\r
- memcpy( ( void * ) pxStreamBuffer->pucBuffer, ( const void * ) &( pucData[ xFirstLength ] ), xCount - xFirstLength ); /*lint !e9087 memcpy() requires void *. */\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
-\r
- xNextHead += xCount;\r
- if( xNextHead >= pxStreamBuffer->xLength )\r
- {\r
- xNextHead -= pxStreamBuffer->xLength;\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
-\r
- pxStreamBuffer->xHead = xNextHead;\r
-\r
- return xCount;\r
-}\r
-/*-----------------------------------------------------------*/\r
-\r
-static size_t prvReadBytesFromBuffer( StreamBuffer_t *pxStreamBuffer, uint8_t *pucData, size_t xMaxCount, size_t xBytesAvailable )\r
-{\r
-size_t xCount, xFirstLength, xNextTail;\r
-\r
- /* Use the minimum of the wanted bytes and the available bytes. */\r
- xCount = configMIN( xBytesAvailable, xMaxCount );\r
-\r
- if( xCount > ( size_t ) 0 )\r
- {\r
- xNextTail = pxStreamBuffer->xTail;\r
-\r
- /* Calculate the number of bytes that can be read - which may be\r
- less than the number wanted if the data wraps around to the start of\r
- the buffer. */\r
- xFirstLength = configMIN( pxStreamBuffer->xLength - xNextTail, xCount );\r
-\r
- /* Obtain the number of bytes it is possible to obtain in the first\r
- read. Asserts check bounds of read and write. */\r
- configASSERT( xFirstLength <= xMaxCount );\r
- configASSERT( ( xNextTail + xFirstLength ) <= pxStreamBuffer->xLength );\r
- memcpy( ( void * ) pucData, ( const void * ) &( pxStreamBuffer->pucBuffer[ xNextTail ] ), xFirstLength ); /*lint !e9087 memcpy() requires void *. */\r
-\r
- /* If the total number of wanted bytes is greater than the number\r
- that could be read in the first read... */\r
- if( xCount > xFirstLength )\r
- {\r
- /*...then read the remaining bytes from the start of the buffer. */\r
- configASSERT( xCount <= xMaxCount );\r
- memcpy( ( void * ) &( pucData[ xFirstLength ] ), ( void * ) ( pxStreamBuffer->pucBuffer ), xCount - xFirstLength ); /*lint !e9087 memcpy() requires void *. */\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
-\r
- /* Move the tail pointer to effectively remove the data read from\r
- the buffer. */\r
- xNextTail += xCount;\r
-\r
- if( xNextTail >= pxStreamBuffer->xLength )\r
- {\r
- xNextTail -= pxStreamBuffer->xLength;\r
- }\r
-\r
- pxStreamBuffer->xTail = xNextTail;\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
-\r
- return xCount;\r
-}\r
-/*-----------------------------------------------------------*/\r
-\r
-static size_t prvBytesInBuffer( const StreamBuffer_t * const pxStreamBuffer )\r
-{\r
-/* Returns the distance between xTail and xHead. */\r
-size_t xCount;\r
-\r
- xCount = pxStreamBuffer->xLength + pxStreamBuffer->xHead;\r
- xCount -= pxStreamBuffer->xTail;\r
- if ( xCount >= pxStreamBuffer->xLength )\r
- {\r
- xCount -= pxStreamBuffer->xLength;\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
-\r
- return xCount;\r
-}\r
-/*-----------------------------------------------------------*/\r
-\r
-static void prvInitialiseNewStreamBuffer( StreamBuffer_t * const pxStreamBuffer,\r
- uint8_t * const pucBuffer,\r
- size_t xBufferSizeBytes,\r
- size_t xTriggerLevelBytes,\r
- BaseType_t xIsMessageBuffer )\r
-{\r
- /* Assert here is deliberately writing to the entire buffer to ensure it can\r
- be written to without generating exceptions, and is setting the buffer to a\r
- known value to assist in development/debugging. */\r
- #if( configASSERT_DEFINED == 1 )\r
- {\r
- /* The value written just has to be identifiable when looking at the\r
- memory. Don't use 0xA5 as that is the stack fill value and could\r
- result in confusion as to what is actually being observed. */\r
- const BaseType_t xWriteValue = 0x55;\r
- configASSERT( memset( pucBuffer, ( int ) xWriteValue, xBufferSizeBytes ) == pucBuffer );\r
- }\r
- #endif\r
-\r
- memset( ( void * ) pxStreamBuffer, 0x00, sizeof( StreamBuffer_t ) ); /*lint !e9087 memset() requires void *. */\r
- pxStreamBuffer->pucBuffer = pucBuffer;\r
- pxStreamBuffer->xLength = xBufferSizeBytes;\r
- pxStreamBuffer->xTriggerLevelBytes = xTriggerLevelBytes;\r
-\r
- if( xIsMessageBuffer != pdFALSE )\r
- {\r
- pxStreamBuffer->ucFlags |= sbFLAGS_IS_MESSAGE_BUFFER;\r
- }\r
-}\r
-\r
-#if ( configUSE_TRACE_FACILITY == 1 )\r
-\r
- UBaseType_t uxStreamBufferGetStreamBufferNumber( StreamBufferHandle_t xStreamBuffer )\r
- {\r
- return ( ( StreamBuffer_t * ) xStreamBuffer )->uxStreamBufferNumber;\r
- }\r
-\r
-#endif /* configUSE_TRACE_FACILITY */\r
-/*-----------------------------------------------------------*/\r
-\r
-#if ( configUSE_TRACE_FACILITY == 1 )\r
-\r
- void vStreamBufferSetStreamBufferNumber( StreamBufferHandle_t xStreamBuffer, UBaseType_t uxStreamBufferNumber )\r
- {\r
- ( ( StreamBuffer_t * ) xStreamBuffer )->uxStreamBufferNumber = uxStreamBufferNumber;\r
- }\r
-\r
-#endif /* configUSE_TRACE_FACILITY */\r
-/*-----------------------------------------------------------*/\r
-\r
-#if ( configUSE_TRACE_FACILITY == 1 )\r
-\r
- uint8_t ucStreamBufferGetStreamBufferType( StreamBufferHandle_t xStreamBuffer )\r
- {\r
- return ( ( StreamBuffer_t * )xStreamBuffer )->ucFlags | sbFLAGS_IS_MESSAGE_BUFFER;\r
- }\r
-\r
-#endif /* configUSE_TRACE_FACILITY */\r
-/*-----------------------------------------------------------*/\r
+++ /dev/null
-/*\r
- * FreeRTOS Kernel V10.0.1\r
- * Copyright (C) 2017 Amazon.com, Inc. or its affiliates. All Rights Reserved.\r
- *\r
- * Permission is hereby granted, free of charge, to any person obtaining a copy of\r
- * this software and associated documentation files (the "Software"), to deal in\r
- * the Software without restriction, including without limitation the rights to\r
- * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of\r
- * the Software, and to permit persons to whom the Software is furnished to do so,\r
- * subject to the following conditions:\r
- *\r
- * The above copyright notice and this permission notice shall be included in all\r
- * copies or substantial portions of the Software.\r
- *\r
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\r
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS\r
- * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR\r
- * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER\r
- * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN\r
- * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\r
- *\r
- * http://www.FreeRTOS.org\r
- * http://aws.amazon.com/freertos\r
- *\r
- * 1 tab == 4 spaces!\r
- */\r
-\r
-/* Standard includes. */\r
-#include <stdlib.h>\r
-#include <string.h>\r
-\r
-/* Defining MPU_WRAPPERS_INCLUDED_FROM_API_FILE prevents task.h from redefining\r
-all the API functions to use the MPU wrappers. That should only be done when\r
-task.h is included from an application file. */\r
-#define MPU_WRAPPERS_INCLUDED_FROM_API_FILE\r
-\r
-/* FreeRTOS includes. */\r
-#include "FreeRTOS.h"\r
-#include "task.h"\r
-#include "timers.h"\r
-#include "stack_macros.h"\r
-\r
-/* Lint e961 and e750 are suppressed as a MISRA exception justified because the\r
-MPU ports require MPU_WRAPPERS_INCLUDED_FROM_API_FILE to be defined for the\r
-header files above, but not in this file, in order to generate the correct\r
-privileged Vs unprivileged linkage and placement. */\r
-#undef MPU_WRAPPERS_INCLUDED_FROM_API_FILE /*lint !e961 !e750. */\r
-\r
-/* Set configUSE_STATS_FORMATTING_FUNCTIONS to 2 to include the stats formatting\r
-functions but without including stdio.h here. */\r
-#if ( configUSE_STATS_FORMATTING_FUNCTIONS == 1 )\r
- /* At the bottom of this file are two optional functions that can be used\r
- to generate human readable text from the raw data generated by the\r
- uxTaskGetSystemState() function. Note the formatting functions are provided\r
- for convenience only, and are NOT considered part of the kernel. */\r
- #include <stdio.h>\r
-#endif /* configUSE_STATS_FORMATTING_FUNCTIONS == 1 ) */\r
-\r
-#if( configUSE_PREEMPTION == 0 )\r
- /* If the cooperative scheduler is being used then a yield should not be\r
- performed just because a higher priority task has been woken. */\r
- #define taskYIELD_IF_USING_PREEMPTION()\r
-#else\r
- #define taskYIELD_IF_USING_PREEMPTION() portYIELD_WITHIN_API()\r
-#endif\r
-\r
-/* Values that can be assigned to the ucNotifyState member of the TCB. */\r
-#define taskNOT_WAITING_NOTIFICATION ( ( uint8_t ) 0 )\r
-#define taskWAITING_NOTIFICATION ( ( uint8_t ) 1 )\r
-#define taskNOTIFICATION_RECEIVED ( ( uint8_t ) 2 )\r
-\r
-/*\r
- * The value used to fill the stack of a task when the task is created. This\r
- * is used purely for checking the high water mark for tasks.\r
- */\r
-#define tskSTACK_FILL_BYTE ( 0xa5U )\r
-\r
-/* Sometimes the FreeRTOSConfig.h settings only allow a task to be created using\r
-dynamically allocated RAM, in which case when any task is deleted it is known\r
-that both the task's stack and TCB need to be freed. Sometimes the\r
-FreeRTOSConfig.h settings only allow a task to be created using statically\r
-allocated RAM, in which case when any task is deleted it is known that neither\r
-the task's stack or TCB should be freed. Sometimes the FreeRTOSConfig.h\r
-settings allow a task to be created using either statically or dynamically\r
-allocated RAM, in which case a member of the TCB is used to record whether the\r
-stack and/or TCB were allocated statically or dynamically, so when a task is\r
-deleted the RAM that was allocated dynamically is freed again and no attempt is\r
-made to free the RAM that was allocated statically.\r
-tskSTATIC_AND_DYNAMIC_ALLOCATION_POSSIBLE is only true if it is possible for a\r
-task to be created using either statically or dynamically allocated RAM. Note\r
-that if portUSING_MPU_WRAPPERS is 1 then a protected task can be created with\r
-a statically allocated stack and a dynamically allocated TCB.\r
-!!!NOTE!!! If the definition of tskSTATIC_AND_DYNAMIC_ALLOCATION_POSSIBLE is\r
-changed then the definition of StaticTask_t must also be updated. */\r
-#define tskSTATIC_AND_DYNAMIC_ALLOCATION_POSSIBLE ( ( configSUPPORT_STATIC_ALLOCATION == 1 ) && ( configSUPPORT_DYNAMIC_ALLOCATION == 1 ) )\r
-#define tskDYNAMICALLY_ALLOCATED_STACK_AND_TCB ( ( uint8_t ) 0 )\r
-#define tskSTATICALLY_ALLOCATED_STACK_ONLY ( ( uint8_t ) 1 )\r
-#define tskSTATICALLY_ALLOCATED_STACK_AND_TCB ( ( uint8_t ) 2 )\r
-\r
-/* If any of the following are set then task stacks are filled with a known\r
-value so the high water mark can be determined. If none of the following are\r
-set then don't fill the stack so there is no unnecessary dependency on memset. */\r
-#if( ( configCHECK_FOR_STACK_OVERFLOW > 1 ) || ( configUSE_TRACE_FACILITY == 1 ) || ( INCLUDE_uxTaskGetStackHighWaterMark == 1 ) )\r
- #define tskSET_NEW_STACKS_TO_KNOWN_VALUE 1\r
-#else\r
- #define tskSET_NEW_STACKS_TO_KNOWN_VALUE 0\r
-#endif\r
-\r
-/*\r
- * Macros used by vListTask to indicate which state a task is in.\r
- */\r
-#define tskRUNNING_CHAR ( 'X' )\r
-#define tskBLOCKED_CHAR ( 'B' )\r
-#define tskREADY_CHAR ( 'R' )\r
-#define tskDELETED_CHAR ( 'D' )\r
-#define tskSUSPENDED_CHAR ( 'S' )\r
-\r
-/*\r
- * Some kernel aware debuggers require the data the debugger needs access to be\r
- * global, rather than file scope.\r
- */\r
-#ifdef portREMOVE_STATIC_QUALIFIER\r
- #define static\r
-#endif\r
-\r
-/* The name allocated to the Idle task. This can be overridden by defining\r
-configIDLE_TASK_NAME in FreeRTOSConfig.h. */\r
-#ifndef configIDLE_TASK_NAME\r
- #define configIDLE_TASK_NAME "IDLE"\r
-#endif\r
-\r
-#if ( configUSE_PORT_OPTIMISED_TASK_SELECTION == 0 )\r
-\r
- /* If configUSE_PORT_OPTIMISED_TASK_SELECTION is 0 then task selection is\r
- performed in a generic way that is not optimised to any particular\r
- microcontroller architecture. */\r
-\r
- /* uxTopReadyPriority holds the priority of the highest priority ready\r
- state task. */\r
- #define taskRECORD_READY_PRIORITY( uxPriority ) \\r
- { \\r
- if( ( uxPriority ) > uxTopReadyPriority ) \\r
- { \\r
- uxTopReadyPriority = ( uxPriority ); \\r
- } \\r
- } /* taskRECORD_READY_PRIORITY */\r
-\r
- /*-----------------------------------------------------------*/\r
-\r
- #define taskSELECT_HIGHEST_PRIORITY_TASK() \\r
- { \\r
- UBaseType_t uxTopPriority = uxTopReadyPriority; \\r
- \\r
- /* Find the highest priority queue that contains ready tasks. */ \\r
- while( listLIST_IS_EMPTY( &( pxReadyTasksLists[ uxTopPriority ] ) ) ) \\r
- { \\r
- configASSERT( uxTopPriority ); \\r
- --uxTopPriority; \\r
- } \\r
- \\r
- /* listGET_OWNER_OF_NEXT_ENTRY indexes through the list, so the tasks of \\r
- the same priority get an equal share of the processor time. */ \\r
- listGET_OWNER_OF_NEXT_ENTRY( pxCurrentTCB, &( pxReadyTasksLists[ uxTopPriority ] ) ); \\r
- uxTopReadyPriority = uxTopPriority; \\r
- } /* taskSELECT_HIGHEST_PRIORITY_TASK */\r
-\r
- /*-----------------------------------------------------------*/\r
-\r
- /* Define away taskRESET_READY_PRIORITY() and portRESET_READY_PRIORITY() as\r
- they are only required when a port optimised method of task selection is\r
- being used. */\r
- #define taskRESET_READY_PRIORITY( uxPriority )\r
- #define portRESET_READY_PRIORITY( uxPriority, uxTopReadyPriority )\r
-\r
-#else /* configUSE_PORT_OPTIMISED_TASK_SELECTION */\r
-\r
- /* If configUSE_PORT_OPTIMISED_TASK_SELECTION is 1 then task selection is\r
- performed in a way that is tailored to the particular microcontroller\r
- architecture being used. */\r
-\r
- /* A port optimised version is provided. Call the port defined macros. */\r
- #define taskRECORD_READY_PRIORITY( uxPriority ) portRECORD_READY_PRIORITY( uxPriority, uxTopReadyPriority )\r
-\r
- /*-----------------------------------------------------------*/\r
-\r
- #define taskSELECT_HIGHEST_PRIORITY_TASK() \\r
- { \\r
- UBaseType_t uxTopPriority; \\r
- \\r
- /* Find the highest priority list that contains ready tasks. */ \\r
- portGET_HIGHEST_PRIORITY( uxTopPriority, uxTopReadyPriority ); \\r
- configASSERT( listCURRENT_LIST_LENGTH( &( pxReadyTasksLists[ uxTopPriority ] ) ) > 0 ); \\r
- listGET_OWNER_OF_NEXT_ENTRY( pxCurrentTCB, &( pxReadyTasksLists[ uxTopPriority ] ) ); \\r
- } /* taskSELECT_HIGHEST_PRIORITY_TASK() */\r
-\r
- /*-----------------------------------------------------------*/\r
-\r
- /* A port optimised version is provided, call it only if the TCB being reset\r
- is being referenced from a ready list. If it is referenced from a delayed\r
- or suspended list then it won't be in a ready list. */\r
- #define taskRESET_READY_PRIORITY( uxPriority ) \\r
- { \\r
- if( listCURRENT_LIST_LENGTH( &( pxReadyTasksLists[ ( uxPriority ) ] ) ) == ( UBaseType_t ) 0 ) \\r
- { \\r
- portRESET_READY_PRIORITY( ( uxPriority ), ( uxTopReadyPriority ) ); \\r
- } \\r
- }\r
-\r
-#endif /* configUSE_PORT_OPTIMISED_TASK_SELECTION */\r
-\r
-/*-----------------------------------------------------------*/\r
-\r
-/* pxDelayedTaskList and pxOverflowDelayedTaskList are switched when the tick\r
-count overflows. */\r
-#define taskSWITCH_DELAYED_LISTS() \\r
-{ \\r
- List_t *pxTemp; \\r
- \\r
- /* The delayed tasks list should be empty when the lists are switched. */ \\r
- configASSERT( ( listLIST_IS_EMPTY( pxDelayedTaskList ) ) ); \\r
- \\r
- pxTemp = pxDelayedTaskList; \\r
- pxDelayedTaskList = pxOverflowDelayedTaskList; \\r
- pxOverflowDelayedTaskList = pxTemp; \\r
- xNumOfOverflows++; \\r
- prvResetNextTaskUnblockTime(); \\r
-}\r
-\r
-/*-----------------------------------------------------------*/\r
-\r
-/*\r
- * Place the task represented by pxTCB into the appropriate ready list for\r
- * the task. It is inserted at the end of the list.\r
- */\r
-#define prvAddTaskToReadyList( pxTCB ) \\r
- traceMOVED_TASK_TO_READY_STATE( pxTCB ); \\r
- taskRECORD_READY_PRIORITY( ( pxTCB )->uxPriority ); \\r
- vListInsertEnd( &( pxReadyTasksLists[ ( pxTCB )->uxPriority ] ), &( ( pxTCB )->xStateListItem ) ); \\r
- tracePOST_MOVED_TASK_TO_READY_STATE( pxTCB )\r
-/*-----------------------------------------------------------*/\r
-\r
-/*\r
- * Several functions take an TaskHandle_t parameter that can optionally be NULL,\r
- * where NULL is used to indicate that the handle of the currently executing\r
- * task should be used in place of the parameter. This macro simply checks to\r
- * see if the parameter is NULL and returns a pointer to the appropriate TCB.\r
- */\r
-#define prvGetTCBFromHandle( pxHandle ) ( ( ( pxHandle ) == NULL ) ? ( TCB_t * ) pxCurrentTCB : ( TCB_t * ) ( pxHandle ) )\r
-\r
-/* The item value of the event list item is normally used to hold the priority\r
-of the task to which it belongs (coded to allow it to be held in reverse\r
-priority order). However, it is occasionally borrowed for other purposes. It\r
-is important its value is not updated due to a task priority change while it is\r
-being used for another purpose. The following bit definition is used to inform\r
-the scheduler that the value should not be changed - in which case it is the\r
-responsibility of whichever module is using the value to ensure it gets set back\r
-to its original value when it is released. */\r
-#if( configUSE_16_BIT_TICKS == 1 )\r
- #define taskEVENT_LIST_ITEM_VALUE_IN_USE 0x8000U\r
-#else\r
- #define taskEVENT_LIST_ITEM_VALUE_IN_USE 0x80000000UL\r
-#endif\r
-\r
-/*\r
- * Task control block. A task control block (TCB) is allocated for each task,\r
- * and stores task state information, including a pointer to the task's context\r
- * (the task's run time environment, including register values)\r
- */\r
-typedef struct tskTaskControlBlock\r
-{\r
- volatile StackType_t *pxTopOfStack; /*< Points to the location of the last item placed on the tasks stack. THIS MUST BE THE FIRST MEMBER OF THE TCB STRUCT. */\r
-\r
- #if ( portUSING_MPU_WRAPPERS == 1 )\r
- xMPU_SETTINGS xMPUSettings; /*< The MPU settings are defined as part of the port layer. THIS MUST BE THE SECOND MEMBER OF THE TCB STRUCT. */\r
- #endif\r
-\r
- ListItem_t xStateListItem; /*< The list that the state list item of a task is reference from denotes the state of that task (Ready, Blocked, Suspended ). */\r
- ListItem_t xEventListItem; /*< Used to reference a task from an event list. */\r
- UBaseType_t uxPriority; /*< The priority of the task. 0 is the lowest priority. */\r
- StackType_t *pxStack; /*< Points to the start of the stack. */\r
- char pcTaskName[ configMAX_TASK_NAME_LEN ];/*< Descriptive name given to the task when created. Facilitates debugging only. */ /*lint !e971 Unqualified char types are allowed for strings and single characters only. */\r
-\r
- #if ( ( portSTACK_GROWTH > 0 ) || ( configRECORD_STACK_HIGH_ADDRESS == 1 ) )\r
- StackType_t *pxEndOfStack; /*< Points to the highest valid address for the stack. */\r
- #endif\r
-\r
- #if ( portCRITICAL_NESTING_IN_TCB == 1 )\r
- UBaseType_t uxCriticalNesting; /*< Holds the critical section nesting depth for ports that do not maintain their own count in the port layer. */\r
- #endif\r
-\r
- #if ( configUSE_TRACE_FACILITY == 1 )\r
- UBaseType_t uxTCBNumber; /*< Stores a number that increments each time a TCB is created. It allows debuggers to determine when a task has been deleted and then recreated. */\r
- UBaseType_t uxTaskNumber; /*< Stores a number specifically for use by third party trace code. */\r
- #endif\r
-\r
- #if ( configUSE_MUTEXES == 1 )\r
- UBaseType_t uxBasePriority; /*< The priority last assigned to the task - used by the priority inheritance mechanism. */\r
- UBaseType_t uxMutexesHeld;\r
- #endif\r
-\r
- #if ( configUSE_APPLICATION_TASK_TAG == 1 )\r
- TaskHookFunction_t pxTaskTag;\r
- #endif\r
-\r
- #if( configNUM_THREAD_LOCAL_STORAGE_POINTERS > 0 )\r
- void *pvThreadLocalStoragePointers[ configNUM_THREAD_LOCAL_STORAGE_POINTERS ];\r
- #endif\r
-\r
- #if( configGENERATE_RUN_TIME_STATS == 1 )\r
- uint32_t ulRunTimeCounter; /*< Stores the amount of time the task has spent in the Running state. */\r
- #endif\r
-\r
- #if ( configUSE_NEWLIB_REENTRANT == 1 )\r
- /* Allocate a Newlib reent structure that is specific to this task.\r
- Note Newlib support has been included by popular demand, but is not\r
- used by the FreeRTOS maintainers themselves. FreeRTOS is not\r
- responsible for resulting newlib operation. User must be familiar with\r
- newlib and must provide system-wide implementations of the necessary\r
- stubs. Be warned that (at the time of writing) the current newlib design\r
- implements a system-wide malloc() that must be provided with locks. */\r
- struct _reent xNewLib_reent;\r
- #endif\r
-\r
- #if( configUSE_TASK_NOTIFICATIONS == 1 )\r
- volatile uint32_t ulNotifiedValue;\r
- volatile uint8_t ucNotifyState;\r
- #endif\r
-\r
- /* See the comments above the definition of\r
- tskSTATIC_AND_DYNAMIC_ALLOCATION_POSSIBLE. */\r
- #if( tskSTATIC_AND_DYNAMIC_ALLOCATION_POSSIBLE != 0 ) /*lint !e731 Macro has been consolidated for readability reasons. */\r
- uint8_t ucStaticallyAllocated; /*< Set to pdTRUE if the task is a statically allocated to ensure no attempt is made to free the memory. */\r
- #endif\r
-\r
- #if( INCLUDE_xTaskAbortDelay == 1 )\r
- uint8_t ucDelayAborted;\r
- #endif\r
-\r
-} tskTCB;\r
-\r
-/* The old tskTCB name is maintained above then typedefed to the new TCB_t name\r
-below to enable the use of older kernel aware debuggers. */\r
-typedef tskTCB TCB_t;\r
-\r
-/*lint -save -e956 A manual analysis and inspection has been used to determine\r
-which static variables must be declared volatile. */\r
-\r
-PRIVILEGED_DATA TCB_t * volatile pxCurrentTCB = NULL;\r
-\r
-/* Lists for ready and blocked tasks. --------------------*/\r
-PRIVILEGED_DATA static List_t pxReadyTasksLists[ configMAX_PRIORITIES ];/*< Prioritised ready tasks. */\r
-PRIVILEGED_DATA static List_t xDelayedTaskList1; /*< Delayed tasks. */\r
-PRIVILEGED_DATA static List_t xDelayedTaskList2; /*< Delayed tasks (two lists are used - one for delays that have overflowed the current tick count. */\r
-PRIVILEGED_DATA static List_t * volatile pxDelayedTaskList; /*< Points to the delayed task list currently being used. */\r
-PRIVILEGED_DATA static List_t * volatile pxOverflowDelayedTaskList; /*< Points to the delayed task list currently being used to hold tasks that have overflowed the current tick count. */\r
-PRIVILEGED_DATA static List_t xPendingReadyList; /*< Tasks that have been readied while the scheduler was suspended. They will be moved to the ready list when the scheduler is resumed. */\r
-\r
-#if( INCLUDE_vTaskDelete == 1 )\r
-\r
- PRIVILEGED_DATA static List_t xTasksWaitingTermination; /*< Tasks that have been deleted - but their memory not yet freed. */\r
- PRIVILEGED_DATA static volatile UBaseType_t uxDeletedTasksWaitingCleanUp = ( UBaseType_t ) 0U;\r
-\r
-#endif\r
-\r
-#if ( INCLUDE_vTaskSuspend == 1 )\r
-\r
- PRIVILEGED_DATA static List_t xSuspendedTaskList; /*< Tasks that are currently suspended. */\r
-\r
-#endif\r
-\r
-/* Other file private variables. --------------------------------*/\r
-PRIVILEGED_DATA static volatile UBaseType_t uxCurrentNumberOfTasks = ( UBaseType_t ) 0U;\r
-PRIVILEGED_DATA static volatile TickType_t xTickCount = ( TickType_t ) configINITIAL_TICK_COUNT;\r
-PRIVILEGED_DATA static volatile UBaseType_t uxTopReadyPriority = tskIDLE_PRIORITY;\r
-PRIVILEGED_DATA static volatile BaseType_t xSchedulerRunning = pdFALSE;\r
-PRIVILEGED_DATA static volatile UBaseType_t uxPendedTicks = ( UBaseType_t ) 0U;\r
-PRIVILEGED_DATA static volatile BaseType_t xYieldPending = pdFALSE;\r
-PRIVILEGED_DATA static volatile BaseType_t xNumOfOverflows = ( BaseType_t ) 0;\r
-PRIVILEGED_DATA static UBaseType_t uxTaskNumber = ( UBaseType_t ) 0U;\r
-PRIVILEGED_DATA static volatile TickType_t xNextTaskUnblockTime = ( TickType_t ) 0U; /* Initialised to portMAX_DELAY before the scheduler starts. */\r
-PRIVILEGED_DATA static TaskHandle_t xIdleTaskHandle = NULL; /*< Holds the handle of the idle task. The idle task is created automatically when the scheduler is started. */\r
-\r
-/* Context switches are held pending while the scheduler is suspended. Also,\r
-interrupts must not manipulate the xStateListItem of a TCB, or any of the\r
-lists the xStateListItem can be referenced from, if the scheduler is suspended.\r
-If an interrupt needs to unblock a task while the scheduler is suspended then it\r
-moves the task's event list item into the xPendingReadyList, ready for the\r
-kernel to move the task from the pending ready list into the real ready list\r
-when the scheduler is unsuspended. The pending ready list itself can only be\r
-accessed from a critical section. */\r
-PRIVILEGED_DATA static volatile UBaseType_t uxSchedulerSuspended = ( UBaseType_t ) pdFALSE;\r
-\r
-#if ( configGENERATE_RUN_TIME_STATS == 1 )\r
-\r
- PRIVILEGED_DATA static uint32_t ulTaskSwitchedInTime = 0UL; /*< Holds the value of a timer/counter the last time a task was switched in. */\r
- PRIVILEGED_DATA static uint32_t ulTotalRunTime = 0UL; /*< Holds the total amount of execution time as defined by the run time counter clock. */\r
-\r
-#endif\r
-\r
-/*lint -restore */\r
-\r
-/*-----------------------------------------------------------*/\r
-\r
-/* Callback function prototypes. --------------------------*/\r
-#if( configCHECK_FOR_STACK_OVERFLOW > 0 )\r
-\r
- extern void vApplicationStackOverflowHook( TaskHandle_t xTask, char *pcTaskName );\r
-\r
-#endif\r
-\r
-#if( configUSE_TICK_HOOK > 0 )\r
-\r
- extern void vApplicationTickHook( void );\r
-\r
-#endif\r
-\r
-#if( configSUPPORT_STATIC_ALLOCATION == 1 )\r
-\r
- extern void vApplicationGetIdleTaskMemory( StaticTask_t **ppxIdleTaskTCBBuffer, StackType_t **ppxIdleTaskStackBuffer, uint32_t *pulIdleTaskStackSize );\r
-\r
-#endif\r
-\r
-/* File private functions. --------------------------------*/\r
-\r
-/**\r
- * Utility task that simply returns pdTRUE if the task referenced by xTask is\r
- * currently in the Suspended state, or pdFALSE if the task referenced by xTask\r
- * is in any other state.\r
- */\r
-#if ( INCLUDE_vTaskSuspend == 1 )\r
-\r
- static BaseType_t prvTaskIsTaskSuspended( const TaskHandle_t xTask ) PRIVILEGED_FUNCTION;\r
-\r
-#endif /* INCLUDE_vTaskSuspend */\r
-\r
-/*\r
- * Utility to ready all the lists used by the scheduler. This is called\r
- * automatically upon the creation of the first task.\r
- */\r
-static void prvInitialiseTaskLists( void ) PRIVILEGED_FUNCTION;\r
-\r
-/*\r
- * The idle task, which as all tasks is implemented as a never ending loop.\r
- * The idle task is automatically created and added to the ready lists upon\r
- * creation of the first user task.\r
- *\r
- * The portTASK_FUNCTION_PROTO() macro is used to allow port/compiler specific\r
- * language extensions. The equivalent prototype for this function is:\r
- *\r
- * void prvIdleTask( void *pvParameters );\r
- *\r
- */\r
-static portTASK_FUNCTION_PROTO( prvIdleTask, pvParameters );\r
-\r
-/*\r
- * Utility to free all memory allocated by the scheduler to hold a TCB,\r
- * including the stack pointed to by the TCB.\r
- *\r
- * This does not free memory allocated by the task itself (i.e. memory\r
- * allocated by calls to pvPortMalloc from within the tasks application code).\r
- */\r
-#if ( INCLUDE_vTaskDelete == 1 )\r
-\r
- static void prvDeleteTCB( TCB_t *pxTCB ) PRIVILEGED_FUNCTION;\r
-\r
-#endif\r
-\r
-/*\r
- * Used only by the idle task. This checks to see if anything has been placed\r
- * in the list of tasks waiting to be deleted. If so the task is cleaned up\r
- * and its TCB deleted.\r
- */\r
-static void prvCheckTasksWaitingTermination( void ) PRIVILEGED_FUNCTION;\r
-\r
-/*\r
- * The currently executing task is entering the Blocked state. Add the task to\r
- * either the current or the overflow delayed task list.\r
- */\r
-static void prvAddCurrentTaskToDelayedList( TickType_t xTicksToWait, const BaseType_t xCanBlockIndefinitely ) PRIVILEGED_FUNCTION;\r
-\r
-/*\r
- * Fills an TaskStatus_t structure with information on each task that is\r
- * referenced from the pxList list (which may be a ready list, a delayed list,\r
- * a suspended list, etc.).\r
- *\r
- * THIS FUNCTION IS INTENDED FOR DEBUGGING ONLY, AND SHOULD NOT BE CALLED FROM\r
- * NORMAL APPLICATION CODE.\r
- */\r
-#if ( configUSE_TRACE_FACILITY == 1 )\r
-\r
- static UBaseType_t prvListTasksWithinSingleList( TaskStatus_t *pxTaskStatusArray, List_t *pxList, eTaskState eState ) PRIVILEGED_FUNCTION;\r
-\r
-#endif\r
-\r
-/*\r
- * Searches pxList for a task with name pcNameToQuery - returning a handle to\r
- * the task if it is found, or NULL if the task is not found.\r
- */\r
-#if ( INCLUDE_xTaskGetHandle == 1 )\r
-\r
- static TCB_t *prvSearchForNameWithinSingleList( List_t *pxList, const char pcNameToQuery[] ) PRIVILEGED_FUNCTION;\r
-\r
-#endif\r
-\r
-/*\r
- * When a task is created, the stack of the task is filled with a known value.\r
- * This function determines the 'high water mark' of the task stack by\r
- * determining how much of the stack remains at the original preset value.\r
- */\r
-#if ( ( configUSE_TRACE_FACILITY == 1 ) || ( INCLUDE_uxTaskGetStackHighWaterMark == 1 ) )\r
-\r
- static uint16_t prvTaskCheckFreeStackSpace( const uint8_t * pucStackByte ) PRIVILEGED_FUNCTION;\r
-\r
-#endif\r
-\r
-/*\r
- * Return the amount of time, in ticks, that will pass before the kernel will\r
- * next move a task from the Blocked state to the Running state.\r
- *\r
- * This conditional compilation should use inequality to 0, not equality to 1.\r
- * This is to ensure portSUPPRESS_TICKS_AND_SLEEP() can be called when user\r
- * defined low power mode implementations require configUSE_TICKLESS_IDLE to be\r
- * set to a value other than 1.\r
- */\r
-#if ( configUSE_TICKLESS_IDLE != 0 )\r
-\r
- static TickType_t prvGetExpectedIdleTime( void ) PRIVILEGED_FUNCTION;\r
-\r
-#endif\r
-\r
-/*\r
- * Set xNextTaskUnblockTime to the time at which the next Blocked state task\r
- * will exit the Blocked state.\r
- */\r
-static void prvResetNextTaskUnblockTime( void );\r
-\r
-#if ( ( configUSE_TRACE_FACILITY == 1 ) && ( configUSE_STATS_FORMATTING_FUNCTIONS > 0 ) )\r
-\r
- /*\r
- * Helper function used to pad task names with spaces when printing out\r
- * human readable tables of task information.\r
- */\r
- static char *prvWriteNameToBuffer( char *pcBuffer, const char *pcTaskName ) PRIVILEGED_FUNCTION;\r
-\r
-#endif\r
-\r
-/*\r
- * Called after a Task_t structure has been allocated either statically or\r
- * dynamically to fill in the structure's members.\r
- */\r
-static void prvInitialiseNewTask( TaskFunction_t pxTaskCode,\r
- const char * const pcName, /*lint !e971 Unqualified char types are allowed for strings and single characters only. */\r
- const uint32_t ulStackDepth,\r
- void * const pvParameters,\r
- UBaseType_t uxPriority,\r
- TaskHandle_t * const pxCreatedTask,\r
- TCB_t *pxNewTCB,\r
- const MemoryRegion_t * const xRegions ) PRIVILEGED_FUNCTION;\r
-\r
-/*\r
- * Called after a new task has been created and initialised to place the task\r
- * under the control of the scheduler.\r
- */\r
-static void prvAddNewTaskToReadyList( TCB_t *pxNewTCB ) PRIVILEGED_FUNCTION;\r
-\r
-/*\r
- * freertos_tasks_c_additions_init() should only be called if the user definable\r
- * macro FREERTOS_TASKS_C_ADDITIONS_INIT() is defined, as that is the only macro\r
- * called by the function.\r
- */\r
-#ifdef FREERTOS_TASKS_C_ADDITIONS_INIT\r
-\r
- static void freertos_tasks_c_additions_init( void ) PRIVILEGED_FUNCTION;\r
-\r
-#endif\r
-\r
-/*-----------------------------------------------------------*/\r
-\r
-#if( configSUPPORT_STATIC_ALLOCATION == 1 )\r
-\r
- TaskHandle_t xTaskCreateStatic( TaskFunction_t pxTaskCode,\r
- const char * const pcName, /*lint !e971 Unqualified char types are allowed for strings and single characters only. */\r
- const uint32_t ulStackDepth,\r
- void * const pvParameters,\r
- UBaseType_t uxPriority,\r
- StackType_t * const puxStackBuffer,\r
- StaticTask_t * const pxTaskBuffer )\r
- {\r
- TCB_t *pxNewTCB;\r
- TaskHandle_t xReturn;\r
-\r
- configASSERT( puxStackBuffer != NULL );\r
- configASSERT( pxTaskBuffer != NULL );\r
-\r
- #if( configASSERT_DEFINED == 1 )\r
- {\r
- /* Sanity check that the size of the structure used to declare a\r
- variable of type StaticTask_t equals the size of the real task\r
- structure. */\r
- volatile size_t xSize = sizeof( StaticTask_t );\r
- configASSERT( xSize == sizeof( TCB_t ) );\r
- }\r
- #endif /* configASSERT_DEFINED */\r
-\r
-\r
- if( ( pxTaskBuffer != NULL ) && ( puxStackBuffer != NULL ) )\r
- {\r
- /* The memory used for the task's TCB and stack are passed into this\r
- function - use them. */\r
- pxNewTCB = ( TCB_t * ) pxTaskBuffer; /*lint !e740 Unusual cast is ok as the structures are designed to have the same alignment, and the size is checked by an assert. */\r
- pxNewTCB->pxStack = ( StackType_t * ) puxStackBuffer;\r
-\r
- #if( tskSTATIC_AND_DYNAMIC_ALLOCATION_POSSIBLE != 0 ) /*lint !e731 Macro has been consolidated for readability reasons. */\r
- {\r
- /* Tasks can be created statically or dynamically, so note this\r
- task was created statically in case the task is later deleted. */\r
- pxNewTCB->ucStaticallyAllocated = tskSTATICALLY_ALLOCATED_STACK_AND_TCB;\r
- }\r
- #endif /* configSUPPORT_DYNAMIC_ALLOCATION */\r
-\r
- prvInitialiseNewTask( pxTaskCode, pcName, ulStackDepth, pvParameters, uxPriority, &xReturn, pxNewTCB, NULL );\r
- prvAddNewTaskToReadyList( pxNewTCB );\r
- }\r
- else\r
- {\r
- xReturn = NULL;\r
- }\r
-\r
- return xReturn;\r
- }\r
-\r
-#endif /* SUPPORT_STATIC_ALLOCATION */\r
-/*-----------------------------------------------------------*/\r
-\r
-#if( ( portUSING_MPU_WRAPPERS == 1 ) && ( configSUPPORT_STATIC_ALLOCATION == 1 ) )\r
-\r
- BaseType_t xTaskCreateRestrictedStatic( const TaskParameters_t * const pxTaskDefinition, TaskHandle_t *pxCreatedTask )\r
- {\r
- TCB_t *pxNewTCB;\r
- BaseType_t xReturn = errCOULD_NOT_ALLOCATE_REQUIRED_MEMORY;\r
-\r
- configASSERT( pxTaskDefinition->puxStackBuffer != NULL );\r
- configASSERT( pxTaskDefinition->pxTaskBuffer != NULL );\r
-\r
- if( ( pxTaskDefinition->puxStackBuffer != NULL ) && ( pxTaskDefinition->pxTaskBuffer != NULL ) )\r
- {\r
- /* Allocate space for the TCB. Where the memory comes from depends\r
- on the implementation of the port malloc function and whether or\r
- not static allocation is being used. */\r
- pxNewTCB = ( TCB_t * ) pxTaskDefinition->pxTaskBuffer;\r
-\r
- /* Store the stack location in the TCB. */\r
- pxNewTCB->pxStack = pxTaskDefinition->puxStackBuffer;\r
-\r
- #if( tskSTATIC_AND_DYNAMIC_ALLOCATION_POSSIBLE != 0 )\r
- {\r
- /* Tasks can be created statically or dynamically, so note this\r
- task was created statically in case the task is later deleted. */\r
- pxNewTCB->ucStaticallyAllocated = tskSTATICALLY_ALLOCATED_STACK_AND_TCB;\r
- }\r
- #endif /* configSUPPORT_DYNAMIC_ALLOCATION */\r
-\r
- prvInitialiseNewTask( pxTaskDefinition->pvTaskCode,\r
- pxTaskDefinition->pcName,\r
- ( uint32_t ) pxTaskDefinition->usStackDepth,\r
- pxTaskDefinition->pvParameters,\r
- pxTaskDefinition->uxPriority,\r
- pxCreatedTask, pxNewTCB,\r
- pxTaskDefinition->xRegions );\r
-\r
- prvAddNewTaskToReadyList( pxNewTCB );\r
- xReturn = pdPASS;\r
- }\r
-\r
- return xReturn;\r
- }\r
-\r
-#endif /* ( portUSING_MPU_WRAPPERS == 1 ) && ( configSUPPORT_STATIC_ALLOCATION == 1 ) */\r
-/*-----------------------------------------------------------*/\r
-\r
-#if( ( portUSING_MPU_WRAPPERS == 1 ) && ( configSUPPORT_DYNAMIC_ALLOCATION == 1 ) )\r
-\r
- BaseType_t xTaskCreateRestricted( const TaskParameters_t * const pxTaskDefinition, TaskHandle_t *pxCreatedTask )\r
- {\r
- TCB_t *pxNewTCB;\r
- BaseType_t xReturn = errCOULD_NOT_ALLOCATE_REQUIRED_MEMORY;\r
-\r
- configASSERT( pxTaskDefinition->puxStackBuffer );\r
-\r
- if( pxTaskDefinition->puxStackBuffer != NULL )\r
- {\r
- /* Allocate space for the TCB. Where the memory comes from depends\r
- on the implementation of the port malloc function and whether or\r
- not static allocation is being used. */\r
- pxNewTCB = ( TCB_t * ) pvPortMalloc( sizeof( TCB_t ) );\r
-\r
- if( pxNewTCB != NULL )\r
- {\r
- /* Store the stack location in the TCB. */\r
- pxNewTCB->pxStack = pxTaskDefinition->puxStackBuffer;\r
-\r
- #if( configSUPPORT_STATIC_ALLOCATION == 1 )\r
- {\r
- /* Tasks can be created statically or dynamically, so note\r
- this task had a statically allocated stack in case it is\r
- later deleted. The TCB was allocated dynamically. */\r
- pxNewTCB->ucStaticallyAllocated = tskSTATICALLY_ALLOCATED_STACK_ONLY;\r
- }\r
- #endif\r
-\r
- prvInitialiseNewTask( pxTaskDefinition->pvTaskCode,\r
- pxTaskDefinition->pcName,\r
- ( uint32_t ) pxTaskDefinition->usStackDepth,\r
- pxTaskDefinition->pvParameters,\r
- pxTaskDefinition->uxPriority,\r
- pxCreatedTask, pxNewTCB,\r
- pxTaskDefinition->xRegions );\r
-\r
- prvAddNewTaskToReadyList( pxNewTCB );\r
- xReturn = pdPASS;\r
- }\r
- }\r
-\r
- return xReturn;\r
- }\r
-\r
-#endif /* portUSING_MPU_WRAPPERS */\r
-/*-----------------------------------------------------------*/\r
-\r
-#if( configSUPPORT_DYNAMIC_ALLOCATION == 1 )\r
-\r
- BaseType_t xTaskCreate( TaskFunction_t pxTaskCode,\r
- const char * const pcName, /*lint !e971 Unqualified char types are allowed for strings and single characters only. */\r
- const configSTACK_DEPTH_TYPE usStackDepth,\r
- void * const pvParameters,\r
- UBaseType_t uxPriority,\r
- TaskHandle_t * const pxCreatedTask )\r
- {\r
- TCB_t *pxNewTCB;\r
- BaseType_t xReturn;\r
-\r
- /* If the stack grows down then allocate the stack then the TCB so the stack\r
- does not grow into the TCB. Likewise if the stack grows up then allocate\r
- the TCB then the stack. */\r
- #if( portSTACK_GROWTH > 0 )\r
- {\r
- /* Allocate space for the TCB. Where the memory comes from depends on\r
- the implementation of the port malloc function and whether or not static\r
- allocation is being used. */\r
- pxNewTCB = ( TCB_t * ) pvPortMalloc( sizeof( TCB_t ) );\r
-\r
- if( pxNewTCB != NULL )\r
- {\r
- /* Allocate space for the stack used by the task being created.\r
- The base of the stack memory stored in the TCB so the task can\r
- be deleted later if required. */\r
- pxNewTCB->pxStack = ( StackType_t * ) pvPortMalloc( ( ( ( size_t ) usStackDepth ) * sizeof( StackType_t ) ) ); /*lint !e961 MISRA exception as the casts are only redundant for some ports. */\r
-\r
- if( pxNewTCB->pxStack == NULL )\r
- {\r
- /* Could not allocate the stack. Delete the allocated TCB. */\r
- vPortFree( pxNewTCB );\r
- pxNewTCB = NULL;\r
- }\r
- }\r
- }\r
- #else /* portSTACK_GROWTH */\r
- {\r
- StackType_t *pxStack;\r
-\r
- /* Allocate space for the stack used by the task being created. */\r
- pxStack = ( StackType_t * ) pvPortMalloc( ( ( ( size_t ) usStackDepth ) * sizeof( StackType_t ) ) ); /*lint !e961 MISRA exception as the casts are only redundant for some ports. */\r
-\r
- if( pxStack != NULL )\r
- {\r
- /* Allocate space for the TCB. */\r
- pxNewTCB = ( TCB_t * ) pvPortMalloc( sizeof( TCB_t ) ); /*lint !e961 MISRA exception as the casts are only redundant for some paths. */\r
-\r
- if( pxNewTCB != NULL )\r
- {\r
- /* Store the stack location in the TCB. */\r
- pxNewTCB->pxStack = pxStack;\r
- }\r
- else\r
- {\r
- /* The stack cannot be used as the TCB was not created. Free\r
- it again. */\r
- vPortFree( pxStack );\r
- }\r
- }\r
- else\r
- {\r
- pxNewTCB = NULL;\r
- }\r
- }\r
- #endif /* portSTACK_GROWTH */\r
-\r
- if( pxNewTCB != NULL )\r
- {\r
- #if( tskSTATIC_AND_DYNAMIC_ALLOCATION_POSSIBLE != 0 ) /*lint !e731 Macro has been consolidated for readability reasons. */\r
- {\r
- /* Tasks can be created statically or dynamically, so note this\r
- task was created dynamically in case it is later deleted. */\r
- pxNewTCB->ucStaticallyAllocated = tskDYNAMICALLY_ALLOCATED_STACK_AND_TCB;\r
- }\r
- #endif /* configSUPPORT_STATIC_ALLOCATION */\r
-\r
- prvInitialiseNewTask( pxTaskCode, pcName, ( uint32_t ) usStackDepth, pvParameters, uxPriority, pxCreatedTask, pxNewTCB, NULL );\r
- prvAddNewTaskToReadyList( pxNewTCB );\r
- xReturn = pdPASS;\r
- }\r
- else\r
- {\r
- xReturn = errCOULD_NOT_ALLOCATE_REQUIRED_MEMORY;\r
- }\r
-\r
- return xReturn;\r
- }\r
-\r
-#endif /* configSUPPORT_DYNAMIC_ALLOCATION */\r
-/*-----------------------------------------------------------*/\r
-\r
-static void prvInitialiseNewTask( TaskFunction_t pxTaskCode,\r
- const char * const pcName, /*lint !e971 Unqualified char types are allowed for strings and single characters only. */\r
- const uint32_t ulStackDepth,\r
- void * const pvParameters,\r
- UBaseType_t uxPriority,\r
- TaskHandle_t * const pxCreatedTask,\r
- TCB_t *pxNewTCB,\r
- const MemoryRegion_t * const xRegions )\r
-{\r
-StackType_t *pxTopOfStack;\r
-UBaseType_t x;\r
-\r
- #if( portUSING_MPU_WRAPPERS == 1 )\r
- /* Should the task be created in privileged mode? */\r
- BaseType_t xRunPrivileged;\r
- if( ( uxPriority & portPRIVILEGE_BIT ) != 0U )\r
- {\r
- xRunPrivileged = pdTRUE;\r
- }\r
- else\r
- {\r
- xRunPrivileged = pdFALSE;\r
- }\r
- uxPriority &= ~portPRIVILEGE_BIT;\r
- #endif /* portUSING_MPU_WRAPPERS == 1 */\r
-\r
- /* Avoid dependency on memset() if it is not required. */\r
- #if( tskSET_NEW_STACKS_TO_KNOWN_VALUE == 1 )\r
- {\r
- /* Fill the stack with a known value to assist debugging. */\r
- ( void ) memset( pxNewTCB->pxStack, ( int ) tskSTACK_FILL_BYTE, ( size_t ) ulStackDepth * sizeof( StackType_t ) );\r
- }\r
- #endif /* tskSET_NEW_STACKS_TO_KNOWN_VALUE */\r
-\r
- /* Calculate the top of stack address. This depends on whether the stack\r
- grows from high memory to low (as per the 80x86) or vice versa.\r
- portSTACK_GROWTH is used to make the result positive or negative as required\r
- by the port. */\r
- #if( portSTACK_GROWTH < 0 )\r
- {\r
- pxTopOfStack = pxNewTCB->pxStack + ( ulStackDepth - ( uint32_t ) 1 );\r
- pxTopOfStack = ( StackType_t * ) ( ( ( portPOINTER_SIZE_TYPE ) pxTopOfStack ) & ( ~( ( portPOINTER_SIZE_TYPE ) portBYTE_ALIGNMENT_MASK ) ) ); /*lint !e923 MISRA exception. Avoiding casts between pointers and integers is not practical. Size differences accounted for using portPOINTER_SIZE_TYPE type. */\r
-\r
- /* Check the alignment of the calculated top of stack is correct. */\r
- configASSERT( ( ( ( portPOINTER_SIZE_TYPE ) pxTopOfStack & ( portPOINTER_SIZE_TYPE ) portBYTE_ALIGNMENT_MASK ) == 0UL ) );\r
-\r
- #if( configRECORD_STACK_HIGH_ADDRESS == 1 )\r
- {\r
- /* Also record the stack's high address, which may assist\r
- debugging. */\r
- pxNewTCB->pxEndOfStack = pxTopOfStack;\r
- }\r
- #endif /* configRECORD_STACK_HIGH_ADDRESS */\r
- }\r
- #else /* portSTACK_GROWTH */\r
- {\r
- pxTopOfStack = pxNewTCB->pxStack;\r
-\r
- /* Check the alignment of the stack buffer is correct. */\r
- configASSERT( ( ( ( portPOINTER_SIZE_TYPE ) pxNewTCB->pxStack & ( portPOINTER_SIZE_TYPE ) portBYTE_ALIGNMENT_MASK ) == 0UL ) );\r
-\r
- /* The other extreme of the stack space is required if stack checking is\r
- performed. */\r
- pxNewTCB->pxEndOfStack = pxNewTCB->pxStack + ( ulStackDepth - ( uint32_t ) 1 );\r
- }\r
- #endif /* portSTACK_GROWTH */\r
-\r
- /* Store the task name in the TCB. */\r
- for( x = ( UBaseType_t ) 0; x < ( UBaseType_t ) configMAX_TASK_NAME_LEN; x++ )\r
- {\r
- pxNewTCB->pcTaskName[ x ] = pcName[ x ];\r
-\r
- /* Don't copy all configMAX_TASK_NAME_LEN if the string is shorter than\r
- configMAX_TASK_NAME_LEN characters just in case the memory after the\r
- string is not accessible (extremely unlikely). */\r
- if( pcName[ x ] == 0x00 )\r
- {\r
- break;\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
-\r
- /* Ensure the name string is terminated in the case that the string length\r
- was greater or equal to configMAX_TASK_NAME_LEN. */\r
- pxNewTCB->pcTaskName[ configMAX_TASK_NAME_LEN - 1 ] = '\0';\r
-\r
- /* This is used as an array index so must ensure it's not too large. First\r
- remove the privilege bit if one is present. */\r
- if( uxPriority >= ( UBaseType_t ) configMAX_PRIORITIES )\r
- {\r
- uxPriority = ( UBaseType_t ) configMAX_PRIORITIES - ( UBaseType_t ) 1U;\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
-\r
- pxNewTCB->uxPriority = uxPriority;\r
- #if ( configUSE_MUTEXES == 1 )\r
- {\r
- pxNewTCB->uxBasePriority = uxPriority;\r
- pxNewTCB->uxMutexesHeld = 0;\r
- }\r
- #endif /* configUSE_MUTEXES */\r
-\r
- vListInitialiseItem( &( pxNewTCB->xStateListItem ) );\r
- vListInitialiseItem( &( pxNewTCB->xEventListItem ) );\r
-\r
- /* Set the pxNewTCB as a link back from the ListItem_t. This is so we can get\r
- back to the containing TCB from a generic item in a list. */\r
- listSET_LIST_ITEM_OWNER( &( pxNewTCB->xStateListItem ), pxNewTCB );\r
-\r
- /* Event lists are always in priority order. */\r
- listSET_LIST_ITEM_VALUE( &( pxNewTCB->xEventListItem ), ( TickType_t ) configMAX_PRIORITIES - ( TickType_t ) uxPriority ); /*lint !e961 MISRA exception as the casts are only redundant for some ports. */\r
- listSET_LIST_ITEM_OWNER( &( pxNewTCB->xEventListItem ), pxNewTCB );\r
-\r
- #if ( portCRITICAL_NESTING_IN_TCB == 1 )\r
- {\r
- pxNewTCB->uxCriticalNesting = ( UBaseType_t ) 0U;\r
- }\r
- #endif /* portCRITICAL_NESTING_IN_TCB */\r
-\r
- #if ( configUSE_APPLICATION_TASK_TAG == 1 )\r
- {\r
- pxNewTCB->pxTaskTag = NULL;\r
- }\r
- #endif /* configUSE_APPLICATION_TASK_TAG */\r
-\r
- #if ( configGENERATE_RUN_TIME_STATS == 1 )\r
- {\r
- pxNewTCB->ulRunTimeCounter = 0UL;\r
- }\r
- #endif /* configGENERATE_RUN_TIME_STATS */\r
-\r
- #if ( portUSING_MPU_WRAPPERS == 1 )\r
- {\r
- vPortStoreTaskMPUSettings( &( pxNewTCB->xMPUSettings ), xRegions, pxNewTCB->pxStack, ulStackDepth );\r
- }\r
- #else\r
- {\r
- /* Avoid compiler warning about unreferenced parameter. */\r
- ( void ) xRegions;\r
- }\r
- #endif\r
-\r
- #if( configNUM_THREAD_LOCAL_STORAGE_POINTERS != 0 )\r
- {\r
- for( x = 0; x < ( UBaseType_t ) configNUM_THREAD_LOCAL_STORAGE_POINTERS; x++ )\r
- {\r
- pxNewTCB->pvThreadLocalStoragePointers[ x ] = NULL;\r
- }\r
- }\r
- #endif\r
-\r
- #if ( configUSE_TASK_NOTIFICATIONS == 1 )\r
- {\r
- pxNewTCB->ulNotifiedValue = 0;\r
- pxNewTCB->ucNotifyState = taskNOT_WAITING_NOTIFICATION;\r
- }\r
- #endif\r
-\r
- #if ( configUSE_NEWLIB_REENTRANT == 1 )\r
- {\r
- /* Initialise this task's Newlib reent structure. */\r
- _REENT_INIT_PTR( ( &( pxNewTCB->xNewLib_reent ) ) );\r
- }\r
- #endif\r
-\r
- #if( INCLUDE_xTaskAbortDelay == 1 )\r
- {\r
- pxNewTCB->ucDelayAborted = pdFALSE;\r
- }\r
- #endif\r
-\r
- /* Initialize the TCB stack to look as if the task was already running,\r
- but had been interrupted by the scheduler. The return address is set\r
- to the start of the task function. Once the stack has been initialised\r
- the top of stack variable is updated. */\r
- #if( portUSING_MPU_WRAPPERS == 1 )\r
- {\r
- pxNewTCB->pxTopOfStack = pxPortInitialiseStack( pxTopOfStack, pxTaskCode, pvParameters, xRunPrivileged );\r
- }\r
- #else /* portUSING_MPU_WRAPPERS */\r
- {\r
- pxNewTCB->pxTopOfStack = pxPortInitialiseStack( pxTopOfStack, pxTaskCode, pvParameters );\r
- }\r
- #endif /* portUSING_MPU_WRAPPERS */\r
-\r
- if( ( void * ) pxCreatedTask != NULL )\r
- {\r
- /* Pass the handle out in an anonymous way. The handle can be used to\r
- change the created task's priority, delete the created task, etc.*/\r
- *pxCreatedTask = ( TaskHandle_t ) pxNewTCB;\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
-}\r
-/*-----------------------------------------------------------*/\r
-\r
-static void prvAddNewTaskToReadyList( TCB_t *pxNewTCB )\r
-{\r
- /* Ensure interrupts don't access the task lists while the lists are being\r
- updated. */\r
- taskENTER_CRITICAL();\r
- {\r
- uxCurrentNumberOfTasks++;\r
- if( pxCurrentTCB == NULL )\r
- {\r
- /* There are no other tasks, or all the other tasks are in\r
- the suspended state - make this the current task. */\r
- pxCurrentTCB = pxNewTCB;\r
-\r
- if( uxCurrentNumberOfTasks == ( UBaseType_t ) 1 )\r
- {\r
- /* This is the first task to be created so do the preliminary\r
- initialisation required. We will not recover if this call\r
- fails, but we will report the failure. */\r
- prvInitialiseTaskLists();\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- else\r
- {\r
- /* If the scheduler is not already running, make this task the\r
- current task if it is the highest priority task to be created\r
- so far. */\r
- if( xSchedulerRunning == pdFALSE )\r
- {\r
- if( pxCurrentTCB->uxPriority <= pxNewTCB->uxPriority )\r
- {\r
- pxCurrentTCB = pxNewTCB;\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
-\r
- uxTaskNumber++;\r
-\r
- #if ( configUSE_TRACE_FACILITY == 1 )\r
- {\r
- /* Add a counter into the TCB for tracing only. */\r
- pxNewTCB->uxTCBNumber = uxTaskNumber;\r
- }\r
- #endif /* configUSE_TRACE_FACILITY */\r
- traceTASK_CREATE( pxNewTCB );\r
-\r
- prvAddTaskToReadyList( pxNewTCB );\r
-\r
- portSETUP_TCB( pxNewTCB );\r
- }\r
- taskEXIT_CRITICAL();\r
-\r
- if( xSchedulerRunning != pdFALSE )\r
- {\r
- /* If the created task is of a higher priority than the current task\r
- then it should run now. */\r
- if( pxCurrentTCB->uxPriority < pxNewTCB->uxPriority )\r
- {\r
- taskYIELD_IF_USING_PREEMPTION();\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
-}\r
-/*-----------------------------------------------------------*/\r
-\r
-#if ( INCLUDE_vTaskDelete == 1 )\r
-\r
- void vTaskDelete( TaskHandle_t xTaskToDelete )\r
- {\r
- TCB_t *pxTCB;\r
-\r
- taskENTER_CRITICAL();\r
- {\r
- /* If null is passed in here then it is the calling task that is\r
- being deleted. */\r
- pxTCB = prvGetTCBFromHandle( xTaskToDelete );\r
-\r
- /* Remove task from the ready list. */\r
- if( uxListRemove( &( pxTCB->xStateListItem ) ) == ( UBaseType_t ) 0 )\r
- {\r
- taskRESET_READY_PRIORITY( pxTCB->uxPriority );\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
-\r
- /* Is the task waiting on an event also? */\r
- if( listLIST_ITEM_CONTAINER( &( pxTCB->xEventListItem ) ) != NULL )\r
- {\r
- ( void ) uxListRemove( &( pxTCB->xEventListItem ) );\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
-\r
- /* Increment the uxTaskNumber also so kernel aware debuggers can\r
- detect that the task lists need re-generating. This is done before\r
- portPRE_TASK_DELETE_HOOK() as in the Windows port that macro will\r
- not return. */\r
- uxTaskNumber++;\r
-\r
- if( pxTCB == pxCurrentTCB )\r
- {\r
- /* A task is deleting itself. This cannot complete within the\r
- task itself, as a context switch to another task is required.\r
- Place the task in the termination list. The idle task will\r
- check the termination list and free up any memory allocated by\r
- the scheduler for the TCB and stack of the deleted task. */\r
- vListInsertEnd( &xTasksWaitingTermination, &( pxTCB->xStateListItem ) );\r
-\r
- /* Increment the ucTasksDeleted variable so the idle task knows\r
- there is a task that has been deleted and that it should therefore\r
- check the xTasksWaitingTermination list. */\r
- ++uxDeletedTasksWaitingCleanUp;\r
-\r
- /* The pre-delete hook is primarily for the Windows simulator,\r
- in which Windows specific clean up operations are performed,\r
- after which it is not possible to yield away from this task -\r
- hence xYieldPending is used to latch that a context switch is\r
- required. */\r
- portPRE_TASK_DELETE_HOOK( pxTCB, &xYieldPending );\r
- }\r
- else\r
- {\r
- --uxCurrentNumberOfTasks;\r
- prvDeleteTCB( pxTCB );\r
-\r
- /* Reset the next expected unblock time in case it referred to\r
- the task that has just been deleted. */\r
- prvResetNextTaskUnblockTime();\r
- }\r
-\r
- traceTASK_DELETE( pxTCB );\r
- }\r
- taskEXIT_CRITICAL();\r
-\r
- /* Force a reschedule if it is the currently running task that has just\r
- been deleted. */\r
- if( xSchedulerRunning != pdFALSE )\r
- {\r
- if( pxTCB == pxCurrentTCB )\r
- {\r
- configASSERT( uxSchedulerSuspended == 0 );\r
- portYIELD_WITHIN_API();\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- }\r
-\r
-#endif /* INCLUDE_vTaskDelete */\r
-/*-----------------------------------------------------------*/\r
-\r
-#if ( INCLUDE_vTaskDelayUntil == 1 )\r
-\r
- void vTaskDelayUntil( TickType_t * const pxPreviousWakeTime, const TickType_t xTimeIncrement )\r
- {\r
- TickType_t xTimeToWake;\r
- BaseType_t xAlreadyYielded, xShouldDelay = pdFALSE;\r
-\r
- configASSERT( pxPreviousWakeTime );\r
- configASSERT( ( xTimeIncrement > 0U ) );\r
- configASSERT( uxSchedulerSuspended == 0 );\r
-\r
- vTaskSuspendAll();\r
- {\r
- /* Minor optimisation. The tick count cannot change in this\r
- block. */\r
- const TickType_t xConstTickCount = xTickCount;\r
-\r
- /* Generate the tick time at which the task wants to wake. */\r
- xTimeToWake = *pxPreviousWakeTime + xTimeIncrement;\r
-\r
- if( xConstTickCount < *pxPreviousWakeTime )\r
- {\r
- /* The tick count has overflowed since this function was\r
- lasted called. In this case the only time we should ever\r
- actually delay is if the wake time has also overflowed,\r
- and the wake time is greater than the tick time. When this\r
- is the case it is as if neither time had overflowed. */\r
- if( ( xTimeToWake < *pxPreviousWakeTime ) && ( xTimeToWake > xConstTickCount ) )\r
- {\r
- xShouldDelay = pdTRUE;\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- else\r
- {\r
- /* The tick time has not overflowed. In this case we will\r
- delay if either the wake time has overflowed, and/or the\r
- tick time is less than the wake time. */\r
- if( ( xTimeToWake < *pxPreviousWakeTime ) || ( xTimeToWake > xConstTickCount ) )\r
- {\r
- xShouldDelay = pdTRUE;\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
-\r
- /* Update the wake time ready for the next call. */\r
- *pxPreviousWakeTime = xTimeToWake;\r
-\r
- if( xShouldDelay != pdFALSE )\r
- {\r
- traceTASK_DELAY_UNTIL( xTimeToWake );\r
-\r
- /* prvAddCurrentTaskToDelayedList() needs the block time, not\r
- the time to wake, so subtract the current tick count. */\r
- prvAddCurrentTaskToDelayedList( xTimeToWake - xConstTickCount, pdFALSE );\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- xAlreadyYielded = xTaskResumeAll();\r
-\r
- /* Force a reschedule if xTaskResumeAll has not already done so, we may\r
- have put ourselves to sleep. */\r
- if( xAlreadyYielded == pdFALSE )\r
- {\r
- portYIELD_WITHIN_API();\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
-\r
-#endif /* INCLUDE_vTaskDelayUntil */\r
-/*-----------------------------------------------------------*/\r
-\r
-#if ( INCLUDE_vTaskDelay == 1 )\r
-\r
- void vTaskDelay( const TickType_t xTicksToDelay )\r
- {\r
- BaseType_t xAlreadyYielded = pdFALSE;\r
-\r
- /* A delay time of zero just forces a reschedule. */\r
- if( xTicksToDelay > ( TickType_t ) 0U )\r
- {\r
- configASSERT( uxSchedulerSuspended == 0 );\r
- vTaskSuspendAll();\r
- {\r
- traceTASK_DELAY();\r
-\r
- /* A task that is removed from the event list while the\r
- scheduler is suspended will not get placed in the ready\r
- list or removed from the blocked list until the scheduler\r
- is resumed.\r
-\r
- This task cannot be in an event list as it is the currently\r
- executing task. */\r
- prvAddCurrentTaskToDelayedList( xTicksToDelay, pdFALSE );\r
- }\r
- xAlreadyYielded = xTaskResumeAll();\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
-\r
- /* Force a reschedule if xTaskResumeAll has not already done so, we may\r
- have put ourselves to sleep. */\r
- if( xAlreadyYielded == pdFALSE )\r
- {\r
- portYIELD_WITHIN_API();\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
-\r
-#endif /* INCLUDE_vTaskDelay */\r
-/*-----------------------------------------------------------*/\r
-\r
-#if( ( INCLUDE_eTaskGetState == 1 ) || ( configUSE_TRACE_FACILITY == 1 ) )\r
-\r
- eTaskState eTaskGetState( TaskHandle_t xTask )\r
- {\r
- eTaskState eReturn;\r
- List_t *pxStateList;\r
- const TCB_t * const pxTCB = ( TCB_t * ) xTask;\r
-\r
- configASSERT( pxTCB );\r
-\r
- if( pxTCB == pxCurrentTCB )\r
- {\r
- /* The task calling this function is querying its own state. */\r
- eReturn = eRunning;\r
- }\r
- else\r
- {\r
- taskENTER_CRITICAL();\r
- {\r
- pxStateList = ( List_t * ) listLIST_ITEM_CONTAINER( &( pxTCB->xStateListItem ) );\r
- }\r
- taskEXIT_CRITICAL();\r
-\r
- if( ( pxStateList == pxDelayedTaskList ) || ( pxStateList == pxOverflowDelayedTaskList ) )\r
- {\r
- /* The task being queried is referenced from one of the Blocked\r
- lists. */\r
- eReturn = eBlocked;\r
- }\r
-\r
- #if ( INCLUDE_vTaskSuspend == 1 )\r
- else if( pxStateList == &xSuspendedTaskList )\r
- {\r
- /* The task being queried is referenced from the suspended\r
- list. Is it genuinely suspended or is it block\r
- indefinitely? */\r
- if( listLIST_ITEM_CONTAINER( &( pxTCB->xEventListItem ) ) == NULL )\r
- {\r
- eReturn = eSuspended;\r
- }\r
- else\r
- {\r
- eReturn = eBlocked;\r
- }\r
- }\r
- #endif\r
-\r
- #if ( INCLUDE_vTaskDelete == 1 )\r
- else if( ( pxStateList == &xTasksWaitingTermination ) || ( pxStateList == NULL ) )\r
- {\r
- /* The task being queried is referenced from the deleted\r
- tasks list, or it is not referenced from any lists at\r
- all. */\r
- eReturn = eDeleted;\r
- }\r
- #endif\r
-\r
- else /*lint !e525 Negative indentation is intended to make use of pre-processor clearer. */\r
- {\r
- /* If the task is not in any other state, it must be in the\r
- Ready (including pending ready) state. */\r
- eReturn = eReady;\r
- }\r
- }\r
-\r
- return eReturn;\r
- } /*lint !e818 xTask cannot be a pointer to const because it is a typedef. */\r
-\r
-#endif /* INCLUDE_eTaskGetState */\r
-/*-----------------------------------------------------------*/\r
-\r
-#if ( INCLUDE_uxTaskPriorityGet == 1 )\r
-\r
- UBaseType_t uxTaskPriorityGet( TaskHandle_t xTask )\r
- {\r
- TCB_t *pxTCB;\r
- UBaseType_t uxReturn;\r
-\r
- taskENTER_CRITICAL();\r
- {\r
- /* If null is passed in here then it is the priority of the that\r
- called uxTaskPriorityGet() that is being queried. */\r
- pxTCB = prvGetTCBFromHandle( xTask );\r
- uxReturn = pxTCB->uxPriority;\r
- }\r
- taskEXIT_CRITICAL();\r
-\r
- return uxReturn;\r
- }\r
-\r
-#endif /* INCLUDE_uxTaskPriorityGet */\r
-/*-----------------------------------------------------------*/\r
-\r
-#if ( INCLUDE_uxTaskPriorityGet == 1 )\r
-\r
- UBaseType_t uxTaskPriorityGetFromISR( TaskHandle_t xTask )\r
- {\r
- TCB_t *pxTCB;\r
- UBaseType_t uxReturn, uxSavedInterruptState;\r
-\r
- /* RTOS ports that support interrupt nesting have the concept of a\r
- maximum system call (or maximum API call) interrupt priority.\r
- Interrupts that are above the maximum system call priority are keep\r
- permanently enabled, even when the RTOS kernel is in a critical section,\r
- but cannot make any calls to FreeRTOS API functions. If configASSERT()\r
- is defined in FreeRTOSConfig.h then\r
- portASSERT_IF_INTERRUPT_PRIORITY_INVALID() will result in an assertion\r
- failure if a FreeRTOS API function is called from an interrupt that has\r
- been assigned a priority above the configured maximum system call\r
- priority. Only FreeRTOS functions that end in FromISR can be called\r
- from interrupts that have been assigned a priority at or (logically)\r
- below the maximum system call interrupt priority. FreeRTOS maintains a\r
- separate interrupt safe API to ensure interrupt entry is as fast and as\r
- simple as possible. More information (albeit Cortex-M specific) is\r
- provided on the following link:\r
- http://www.freertos.org/RTOS-Cortex-M3-M4.html */\r
- portASSERT_IF_INTERRUPT_PRIORITY_INVALID();\r
-\r
- uxSavedInterruptState = portSET_INTERRUPT_MASK_FROM_ISR();\r
- {\r
- /* If null is passed in here then it is the priority of the calling\r
- task that is being queried. */\r
- pxTCB = prvGetTCBFromHandle( xTask );\r
- uxReturn = pxTCB->uxPriority;\r
- }\r
- portCLEAR_INTERRUPT_MASK_FROM_ISR( uxSavedInterruptState );\r
-\r
- return uxReturn;\r
- }\r
-\r
-#endif /* INCLUDE_uxTaskPriorityGet */\r
-/*-----------------------------------------------------------*/\r
-\r
-#if ( INCLUDE_vTaskPrioritySet == 1 )\r
-\r
- void vTaskPrioritySet( TaskHandle_t xTask, UBaseType_t uxNewPriority )\r
- {\r
- TCB_t *pxTCB;\r
- UBaseType_t uxCurrentBasePriority, uxPriorityUsedOnEntry;\r
- BaseType_t xYieldRequired = pdFALSE;\r
-\r
- configASSERT( ( uxNewPriority < configMAX_PRIORITIES ) );\r
-\r
- /* Ensure the new priority is valid. */\r
- if( uxNewPriority >= ( UBaseType_t ) configMAX_PRIORITIES )\r
- {\r
- uxNewPriority = ( UBaseType_t ) configMAX_PRIORITIES - ( UBaseType_t ) 1U;\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
-\r
- taskENTER_CRITICAL();\r
- {\r
- /* If null is passed in here then it is the priority of the calling\r
- task that is being changed. */\r
- pxTCB = prvGetTCBFromHandle( xTask );\r
-\r
- traceTASK_PRIORITY_SET( pxTCB, uxNewPriority );\r
-\r
- #if ( configUSE_MUTEXES == 1 )\r
- {\r
- uxCurrentBasePriority = pxTCB->uxBasePriority;\r
- }\r
- #else\r
- {\r
- uxCurrentBasePriority = pxTCB->uxPriority;\r
- }\r
- #endif\r
-\r
- if( uxCurrentBasePriority != uxNewPriority )\r
- {\r
- /* The priority change may have readied a task of higher\r
- priority than the calling task. */\r
- if( uxNewPriority > uxCurrentBasePriority )\r
- {\r
- if( pxTCB != pxCurrentTCB )\r
- {\r
- /* The priority of a task other than the currently\r
- running task is being raised. Is the priority being\r
- raised above that of the running task? */\r
- if( uxNewPriority >= pxCurrentTCB->uxPriority )\r
- {\r
- xYieldRequired = pdTRUE;\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- else\r
- {\r
- /* The priority of the running task is being raised,\r
- but the running task must already be the highest\r
- priority task able to run so no yield is required. */\r
- }\r
- }\r
- else if( pxTCB == pxCurrentTCB )\r
- {\r
- /* Setting the priority of the running task down means\r
- there may now be another task of higher priority that\r
- is ready to execute. */\r
- xYieldRequired = pdTRUE;\r
- }\r
- else\r
- {\r
- /* Setting the priority of any other task down does not\r
- require a yield as the running task must be above the\r
- new priority of the task being modified. */\r
- }\r
-\r
- /* Remember the ready list the task might be referenced from\r
- before its uxPriority member is changed so the\r
- taskRESET_READY_PRIORITY() macro can function correctly. */\r
- uxPriorityUsedOnEntry = pxTCB->uxPriority;\r
-\r
- #if ( configUSE_MUTEXES == 1 )\r
- {\r
- /* Only change the priority being used if the task is not\r
- currently using an inherited priority. */\r
- if( pxTCB->uxBasePriority == pxTCB->uxPriority )\r
- {\r
- pxTCB->uxPriority = uxNewPriority;\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
-\r
- /* The base priority gets set whatever. */\r
- pxTCB->uxBasePriority = uxNewPriority;\r
- }\r
- #else\r
- {\r
- pxTCB->uxPriority = uxNewPriority;\r
- }\r
- #endif\r
-\r
- /* Only reset the event list item value if the value is not\r
- being used for anything else. */\r
- if( ( listGET_LIST_ITEM_VALUE( &( pxTCB->xEventListItem ) ) & taskEVENT_LIST_ITEM_VALUE_IN_USE ) == 0UL )\r
- {\r
- listSET_LIST_ITEM_VALUE( &( pxTCB->xEventListItem ), ( ( TickType_t ) configMAX_PRIORITIES - ( TickType_t ) uxNewPriority ) ); /*lint !e961 MISRA exception as the casts are only redundant for some ports. */\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
-\r
- /* If the task is in the blocked or suspended list we need do\r
- nothing more than change its priority variable. However, if\r
- the task is in a ready list it needs to be removed and placed\r
- in the list appropriate to its new priority. */\r
- if( listIS_CONTAINED_WITHIN( &( pxReadyTasksLists[ uxPriorityUsedOnEntry ] ), &( pxTCB->xStateListItem ) ) != pdFALSE )\r
- {\r
- /* The task is currently in its ready list - remove before\r
- adding it to it's new ready list. As we are in a critical\r
- section we can do this even if the scheduler is suspended. */\r
- if( uxListRemove( &( pxTCB->xStateListItem ) ) == ( UBaseType_t ) 0 )\r
- {\r
- /* It is known that the task is in its ready list so\r
- there is no need to check again and the port level\r
- reset macro can be called directly. */\r
- portRESET_READY_PRIORITY( uxPriorityUsedOnEntry, uxTopReadyPriority );\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- prvAddTaskToReadyList( pxTCB );\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
-\r
- if( xYieldRequired != pdFALSE )\r
- {\r
- taskYIELD_IF_USING_PREEMPTION();\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
-\r
- /* Remove compiler warning about unused variables when the port\r
- optimised task selection is not being used. */\r
- ( void ) uxPriorityUsedOnEntry;\r
- }\r
- }\r
- taskEXIT_CRITICAL();\r
- }\r
-\r
-#endif /* INCLUDE_vTaskPrioritySet */\r
-/*-----------------------------------------------------------*/\r
-\r
-#if ( INCLUDE_vTaskSuspend == 1 )\r
-\r
- void vTaskSuspend( TaskHandle_t xTaskToSuspend )\r
- {\r
- TCB_t *pxTCB;\r
-\r
- taskENTER_CRITICAL();\r
- {\r
- /* If null is passed in here then it is the running task that is\r
- being suspended. */\r
- pxTCB = prvGetTCBFromHandle( xTaskToSuspend );\r
-\r
- traceTASK_SUSPEND( pxTCB );\r
-\r
- /* Remove task from the ready/delayed list and place in the\r
- suspended list. */\r
- if( uxListRemove( &( pxTCB->xStateListItem ) ) == ( UBaseType_t ) 0 )\r
- {\r
- taskRESET_READY_PRIORITY( pxTCB->uxPriority );\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
-\r
- /* Is the task waiting on an event also? */\r
- if( listLIST_ITEM_CONTAINER( &( pxTCB->xEventListItem ) ) != NULL )\r
- {\r
- ( void ) uxListRemove( &( pxTCB->xEventListItem ) );\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
-\r
- vListInsertEnd( &xSuspendedTaskList, &( pxTCB->xStateListItem ) );\r
-\r
- #if( configUSE_TASK_NOTIFICATIONS == 1 )\r
- {\r
- if( pxTCB->ucNotifyState == taskWAITING_NOTIFICATION )\r
- {\r
- /* The task was blocked to wait for a notification, but is\r
- now suspended, so no notification was received. */\r
- pxTCB->ucNotifyState = taskNOT_WAITING_NOTIFICATION;\r
- }\r
- }\r
- #endif\r
- }\r
- taskEXIT_CRITICAL();\r
-\r
- if( xSchedulerRunning != pdFALSE )\r
- {\r
- /* Reset the next expected unblock time in case it referred to the\r
- task that is now in the Suspended state. */\r
- taskENTER_CRITICAL();\r
- {\r
- prvResetNextTaskUnblockTime();\r
- }\r
- taskEXIT_CRITICAL();\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
-\r
- if( pxTCB == pxCurrentTCB )\r
- {\r
- if( xSchedulerRunning != pdFALSE )\r
- {\r
- /* The current task has just been suspended. */\r
- configASSERT( uxSchedulerSuspended == 0 );\r
- portYIELD_WITHIN_API();\r
- }\r
- else\r
- {\r
- /* The scheduler is not running, but the task that was pointed\r
- to by pxCurrentTCB has just been suspended and pxCurrentTCB\r
- must be adjusted to point to a different task. */\r
- if( listCURRENT_LIST_LENGTH( &xSuspendedTaskList ) == uxCurrentNumberOfTasks )\r
- {\r
- /* No other tasks are ready, so set pxCurrentTCB back to\r
- NULL so when the next task is created pxCurrentTCB will\r
- be set to point to it no matter what its relative priority\r
- is. */\r
- pxCurrentTCB = NULL;\r
- }\r
- else\r
- {\r
- vTaskSwitchContext();\r
- }\r
- }\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
-\r
-#endif /* INCLUDE_vTaskSuspend */\r
-/*-----------------------------------------------------------*/\r
-\r
-#if ( INCLUDE_vTaskSuspend == 1 )\r
-\r
- static BaseType_t prvTaskIsTaskSuspended( const TaskHandle_t xTask )\r
- {\r
- BaseType_t xReturn = pdFALSE;\r
- const TCB_t * const pxTCB = ( TCB_t * ) xTask;\r
-\r
- /* Accesses xPendingReadyList so must be called from a critical\r
- section. */\r
-\r
- /* It does not make sense to check if the calling task is suspended. */\r
- configASSERT( xTask );\r
-\r
- /* Is the task being resumed actually in the suspended list? */\r
- if( listIS_CONTAINED_WITHIN( &xSuspendedTaskList, &( pxTCB->xStateListItem ) ) != pdFALSE )\r
- {\r
- /* Has the task already been resumed from within an ISR? */\r
- if( listIS_CONTAINED_WITHIN( &xPendingReadyList, &( pxTCB->xEventListItem ) ) == pdFALSE )\r
- {\r
- /* Is it in the suspended list because it is in the Suspended\r
- state, or because is is blocked with no timeout? */\r
- if( listIS_CONTAINED_WITHIN( NULL, &( pxTCB->xEventListItem ) ) != pdFALSE ) /*lint !e961. The cast is only redundant when NULL is used. */\r
- {\r
- xReturn = pdTRUE;\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
-\r
- return xReturn;\r
- } /*lint !e818 xTask cannot be a pointer to const because it is a typedef. */\r
-\r
-#endif /* INCLUDE_vTaskSuspend */\r
-/*-----------------------------------------------------------*/\r
-\r
-#if ( INCLUDE_vTaskSuspend == 1 )\r
-\r
- void vTaskResume( TaskHandle_t xTaskToResume )\r
- {\r
- TCB_t * const pxTCB = ( TCB_t * ) xTaskToResume;\r
-\r
- /* It does not make sense to resume the calling task. */\r
- configASSERT( xTaskToResume );\r
-\r
- /* The parameter cannot be NULL as it is impossible to resume the\r
- currently executing task. */\r
- if( ( pxTCB != NULL ) && ( pxTCB != pxCurrentTCB ) )\r
- {\r
- taskENTER_CRITICAL();\r
- {\r
- if( prvTaskIsTaskSuspended( pxTCB ) != pdFALSE )\r
- {\r
- traceTASK_RESUME( pxTCB );\r
-\r
- /* The ready list can be accessed even if the scheduler is\r
- suspended because this is inside a critical section. */\r
- ( void ) uxListRemove( &( pxTCB->xStateListItem ) );\r
- prvAddTaskToReadyList( pxTCB );\r
-\r
- /* A higher priority task may have just been resumed. */\r
- if( pxTCB->uxPriority >= pxCurrentTCB->uxPriority )\r
- {\r
- /* This yield may not cause the task just resumed to run,\r
- but will leave the lists in the correct state for the\r
- next yield. */\r
- taskYIELD_IF_USING_PREEMPTION();\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- taskEXIT_CRITICAL();\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
-\r
-#endif /* INCLUDE_vTaskSuspend */\r
-\r
-/*-----------------------------------------------------------*/\r
-\r
-#if ( ( INCLUDE_xTaskResumeFromISR == 1 ) && ( INCLUDE_vTaskSuspend == 1 ) )\r
-\r
- BaseType_t xTaskResumeFromISR( TaskHandle_t xTaskToResume )\r
- {\r
- BaseType_t xYieldRequired = pdFALSE;\r
- TCB_t * const pxTCB = ( TCB_t * ) xTaskToResume;\r
- UBaseType_t uxSavedInterruptStatus;\r
-\r
- configASSERT( xTaskToResume );\r
-\r
- /* RTOS ports that support interrupt nesting have the concept of a\r
- maximum system call (or maximum API call) interrupt priority.\r
- Interrupts that are above the maximum system call priority are keep\r
- permanently enabled, even when the RTOS kernel is in a critical section,\r
- but cannot make any calls to FreeRTOS API functions. If configASSERT()\r
- is defined in FreeRTOSConfig.h then\r
- portASSERT_IF_INTERRUPT_PRIORITY_INVALID() will result in an assertion\r
- failure if a FreeRTOS API function is called from an interrupt that has\r
- been assigned a priority above the configured maximum system call\r
- priority. Only FreeRTOS functions that end in FromISR can be called\r
- from interrupts that have been assigned a priority at or (logically)\r
- below the maximum system call interrupt priority. FreeRTOS maintains a\r
- separate interrupt safe API to ensure interrupt entry is as fast and as\r
- simple as possible. More information (albeit Cortex-M specific) is\r
- provided on the following link:\r
- http://www.freertos.org/RTOS-Cortex-M3-M4.html */\r
- portASSERT_IF_INTERRUPT_PRIORITY_INVALID();\r
-\r
- uxSavedInterruptStatus = portSET_INTERRUPT_MASK_FROM_ISR();\r
- {\r
- if( prvTaskIsTaskSuspended( pxTCB ) != pdFALSE )\r
- {\r
- traceTASK_RESUME_FROM_ISR( pxTCB );\r
-\r
- /* Check the ready lists can be accessed. */\r
- if( uxSchedulerSuspended == ( UBaseType_t ) pdFALSE )\r
- {\r
- /* Ready lists can be accessed so move the task from the\r
- suspended list to the ready list directly. */\r
- if( pxTCB->uxPriority >= pxCurrentTCB->uxPriority )\r
- {\r
- xYieldRequired = pdTRUE;\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
-\r
- ( void ) uxListRemove( &( pxTCB->xStateListItem ) );\r
- prvAddTaskToReadyList( pxTCB );\r
- }\r
- else\r
- {\r
- /* The delayed or ready lists cannot be accessed so the task\r
- is held in the pending ready list until the scheduler is\r
- unsuspended. */\r
- vListInsertEnd( &( xPendingReadyList ), &( pxTCB->xEventListItem ) );\r
- }\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- portCLEAR_INTERRUPT_MASK_FROM_ISR( uxSavedInterruptStatus );\r
-\r
- return xYieldRequired;\r
- }\r
-\r
-#endif /* ( ( INCLUDE_xTaskResumeFromISR == 1 ) && ( INCLUDE_vTaskSuspend == 1 ) ) */\r
-/*-----------------------------------------------------------*/\r
-\r
-void vTaskStartScheduler( void )\r
-{\r
-BaseType_t xReturn;\r
-\r
- /* Add the idle task at the lowest priority. */\r
- #if( configSUPPORT_STATIC_ALLOCATION == 1 )\r
- {\r
- StaticTask_t *pxIdleTaskTCBBuffer = NULL;\r
- StackType_t *pxIdleTaskStackBuffer = NULL;\r
- uint32_t ulIdleTaskStackSize;\r
-\r
- /* The Idle task is created using user provided RAM - obtain the\r
- address of the RAM then create the idle task. */\r
- vApplicationGetIdleTaskMemory( &pxIdleTaskTCBBuffer, &pxIdleTaskStackBuffer, &ulIdleTaskStackSize );\r
- xIdleTaskHandle = xTaskCreateStatic( prvIdleTask,\r
- configIDLE_TASK_NAME,\r
- ulIdleTaskStackSize,\r
- ( void * ) NULL, /*lint !e961. The cast is not redundant for all compilers. */\r
- ( tskIDLE_PRIORITY | portPRIVILEGE_BIT ),\r
- pxIdleTaskStackBuffer,\r
- pxIdleTaskTCBBuffer ); /*lint !e961 MISRA exception, justified as it is not a redundant explicit cast to all supported compilers. */\r
-\r
- if( xIdleTaskHandle != NULL )\r
- {\r
- xReturn = pdPASS;\r
- }\r
- else\r
- {\r
- xReturn = pdFAIL;\r
- }\r
- }\r
- #else\r
- {\r
- /* The Idle task is being created using dynamically allocated RAM. */\r
- xReturn = xTaskCreate( prvIdleTask,\r
- configIDLE_TASK_NAME,\r
- configMINIMAL_STACK_SIZE,\r
- ( void * ) NULL,\r
- ( tskIDLE_PRIORITY | portPRIVILEGE_BIT ),\r
- &xIdleTaskHandle ); /*lint !e961 MISRA exception, justified as it is not a redundant explicit cast to all supported compilers. */\r
- }\r
- #endif /* configSUPPORT_STATIC_ALLOCATION */\r
-\r
- #if ( configUSE_TIMERS == 1 )\r
- {\r
- if( xReturn == pdPASS )\r
- {\r
- xReturn = xTimerCreateTimerTask();\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- #endif /* configUSE_TIMERS */\r
-\r
- if( xReturn == pdPASS )\r
- {\r
- /* freertos_tasks_c_additions_init() should only be called if the user\r
- definable macro FREERTOS_TASKS_C_ADDITIONS_INIT() is defined, as that is\r
- the only macro called by the function. */\r
- #ifdef FREERTOS_TASKS_C_ADDITIONS_INIT\r
- {\r
- freertos_tasks_c_additions_init();\r
- }\r
- #endif\r
-\r
- /* Interrupts are turned off here, to ensure a tick does not occur\r
- before or during the call to xPortStartScheduler(). The stacks of\r
- the created tasks contain a status word with interrupts switched on\r
- so interrupts will automatically get re-enabled when the first task\r
- starts to run. */\r
- portDISABLE_INTERRUPTS();\r
-\r
- #if ( configUSE_NEWLIB_REENTRANT == 1 )\r
- {\r
- /* Switch Newlib's _impure_ptr variable to point to the _reent\r
- structure specific to the task that will run first. */\r
- _impure_ptr = &( pxCurrentTCB->xNewLib_reent );\r
- }\r
- #endif /* configUSE_NEWLIB_REENTRANT */\r
-\r
- xNextTaskUnblockTime = portMAX_DELAY;\r
- xSchedulerRunning = pdTRUE;\r
- xTickCount = ( TickType_t ) 0U;\r
-\r
- /* If configGENERATE_RUN_TIME_STATS is defined then the following\r
- macro must be defined to configure the timer/counter used to generate\r
- the run time counter time base. NOTE: If configGENERATE_RUN_TIME_STATS\r
- is set to 0 and the following line fails to build then ensure you do not\r
- have portCONFIGURE_TIMER_FOR_RUN_TIME_STATS() defined in your\r
- FreeRTOSConfig.h file. */\r
- portCONFIGURE_TIMER_FOR_RUN_TIME_STATS();\r
-\r
- /* Setting up the timer tick is hardware specific and thus in the\r
- portable interface. */\r
- if( xPortStartScheduler() != pdFALSE )\r
- {\r
- /* Should not reach here as if the scheduler is running the\r
- function will not return. */\r
- }\r
- else\r
- {\r
- /* Should only reach here if a task calls xTaskEndScheduler(). */\r
- }\r
- }\r
- else\r
- {\r
- /* This line will only be reached if the kernel could not be started,\r
- because there was not enough FreeRTOS heap to create the idle task\r
- or the timer task. */\r
- configASSERT( xReturn != errCOULD_NOT_ALLOCATE_REQUIRED_MEMORY );\r
- }\r
-\r
- /* Prevent compiler warnings if INCLUDE_xTaskGetIdleTaskHandle is set to 0,\r
- meaning xIdleTaskHandle is not used anywhere else. */\r
- ( void ) xIdleTaskHandle;\r
-}\r
-/*-----------------------------------------------------------*/\r
-\r
-void vTaskEndScheduler( void )\r
-{\r
- /* Stop the scheduler interrupts and call the portable scheduler end\r
- routine so the original ISRs can be restored if necessary. The port\r
- layer must ensure interrupts enable bit is left in the correct state. */\r
- portDISABLE_INTERRUPTS();\r
- xSchedulerRunning = pdFALSE;\r
- vPortEndScheduler();\r
-}\r
-/*----------------------------------------------------------*/\r
-\r
-void vTaskSuspendAll( void )\r
-{\r
- /* A critical section is not required as the variable is of type\r
- BaseType_t. Please read Richard Barry's reply in the following link to a\r
- post in the FreeRTOS support forum before reporting this as a bug! -\r
- http://goo.gl/wu4acr */\r
- ++uxSchedulerSuspended;\r
-}\r
-/*----------------------------------------------------------*/\r
-\r
-#if ( configUSE_TICKLESS_IDLE != 0 )\r
-\r
- static TickType_t prvGetExpectedIdleTime( void )\r
- {\r
- TickType_t xReturn;\r
- UBaseType_t uxHigherPriorityReadyTasks = pdFALSE;\r
-\r
- /* uxHigherPriorityReadyTasks takes care of the case where\r
- configUSE_PREEMPTION is 0, so there may be tasks above the idle priority\r
- task that are in the Ready state, even though the idle task is\r
- running. */\r
- #if( configUSE_PORT_OPTIMISED_TASK_SELECTION == 0 )\r
- {\r
- if( uxTopReadyPriority > tskIDLE_PRIORITY )\r
- {\r
- uxHigherPriorityReadyTasks = pdTRUE;\r
- }\r
- }\r
- #else\r
- {\r
- const UBaseType_t uxLeastSignificantBit = ( UBaseType_t ) 0x01;\r
-\r
- /* When port optimised task selection is used the uxTopReadyPriority\r
- variable is used as a bit map. If bits other than the least\r
- significant bit are set then there are tasks that have a priority\r
- above the idle priority that are in the Ready state. This takes\r
- care of the case where the co-operative scheduler is in use. */\r
- if( uxTopReadyPriority > uxLeastSignificantBit )\r
- {\r
- uxHigherPriorityReadyTasks = pdTRUE;\r
- }\r
- }\r
- #endif\r
-\r
- if( pxCurrentTCB->uxPriority > tskIDLE_PRIORITY )\r
- {\r
- xReturn = 0;\r
- }\r
- else if( listCURRENT_LIST_LENGTH( &( pxReadyTasksLists[ tskIDLE_PRIORITY ] ) ) > 1 )\r
- {\r
- /* There are other idle priority tasks in the ready state. If\r
- time slicing is used then the very next tick interrupt must be\r
- processed. */\r
- xReturn = 0;\r
- }\r
- else if( uxHigherPriorityReadyTasks != pdFALSE )\r
- {\r
- /* There are tasks in the Ready state that have a priority above the\r
- idle priority. This path can only be reached if\r
- configUSE_PREEMPTION is 0. */\r
- xReturn = 0;\r
- }\r
- else\r
- {\r
- xReturn = xNextTaskUnblockTime - xTickCount;\r
- }\r
-\r
- return xReturn;\r
- }\r
-\r
-#endif /* configUSE_TICKLESS_IDLE */\r
-/*----------------------------------------------------------*/\r
-\r
-BaseType_t xTaskResumeAll( void )\r
-{\r
-TCB_t *pxTCB = NULL;\r
-BaseType_t xAlreadyYielded = pdFALSE;\r
-\r
- /* If uxSchedulerSuspended is zero then this function does not match a\r
- previous call to vTaskSuspendAll(). */\r
- configASSERT( uxSchedulerSuspended );\r
-\r
- /* It is possible that an ISR caused a task to be removed from an event\r
- list while the scheduler was suspended. If this was the case then the\r
- removed task will have been added to the xPendingReadyList. Once the\r
- scheduler has been resumed it is safe to move all the pending ready\r
- tasks from this list into their appropriate ready list. */\r
- taskENTER_CRITICAL();\r
- {\r
- --uxSchedulerSuspended;\r
-\r
- if( uxSchedulerSuspended == ( UBaseType_t ) pdFALSE )\r
- {\r
- if( uxCurrentNumberOfTasks > ( UBaseType_t ) 0U )\r
- {\r
- /* Move any readied tasks from the pending list into the\r
- appropriate ready list. */\r
- while( listLIST_IS_EMPTY( &xPendingReadyList ) == pdFALSE )\r
- {\r
- pxTCB = ( TCB_t * ) listGET_OWNER_OF_HEAD_ENTRY( ( &xPendingReadyList ) );\r
- ( void ) uxListRemove( &( pxTCB->xEventListItem ) );\r
- ( void ) uxListRemove( &( pxTCB->xStateListItem ) );\r
- prvAddTaskToReadyList( pxTCB );\r
-\r
- /* If the moved task has a priority higher than the current\r
- task then a yield must be performed. */\r
- if( pxTCB->uxPriority >= pxCurrentTCB->uxPriority )\r
- {\r
- xYieldPending = pdTRUE;\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
-\r
- if( pxTCB != NULL )\r
- {\r
- /* A task was unblocked while the scheduler was suspended,\r
- which may have prevented the next unblock time from being\r
- re-calculated, in which case re-calculate it now. Mainly\r
- important for low power tickless implementations, where\r
- this can prevent an unnecessary exit from low power\r
- state. */\r
- prvResetNextTaskUnblockTime();\r
- }\r
-\r
- /* If any ticks occurred while the scheduler was suspended then\r
- they should be processed now. This ensures the tick count does\r
- not slip, and that any delayed tasks are resumed at the correct\r
- time. */\r
- {\r
- UBaseType_t uxPendedCounts = uxPendedTicks; /* Non-volatile copy. */\r
-\r
- if( uxPendedCounts > ( UBaseType_t ) 0U )\r
- {\r
- do\r
- {\r
- if( xTaskIncrementTick() != pdFALSE )\r
- {\r
- xYieldPending = pdTRUE;\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- --uxPendedCounts;\r
- } while( uxPendedCounts > ( UBaseType_t ) 0U );\r
-\r
- uxPendedTicks = 0;\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
-\r
- if( xYieldPending != pdFALSE )\r
- {\r
- #if( configUSE_PREEMPTION != 0 )\r
- {\r
- xAlreadyYielded = pdTRUE;\r
- }\r
- #endif\r
- taskYIELD_IF_USING_PREEMPTION();\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- taskEXIT_CRITICAL();\r
-\r
- return xAlreadyYielded;\r
-}\r
-/*-----------------------------------------------------------*/\r
-\r
-TickType_t xTaskGetTickCount( void )\r
-{\r
-TickType_t xTicks;\r
-\r
- /* Critical section required if running on a 16 bit processor. */\r
- portTICK_TYPE_ENTER_CRITICAL();\r
- {\r
- xTicks = xTickCount;\r
- }\r
- portTICK_TYPE_EXIT_CRITICAL();\r
-\r
- return xTicks;\r
-}\r
-/*-----------------------------------------------------------*/\r
-\r
-TickType_t xTaskGetTickCountFromISR( void )\r
-{\r
-TickType_t xReturn;\r
-UBaseType_t uxSavedInterruptStatus;\r
-\r
- /* RTOS ports that support interrupt nesting have the concept of a maximum\r
- system call (or maximum API call) interrupt priority. Interrupts that are\r
- above the maximum system call priority are kept permanently enabled, even\r
- when the RTOS kernel is in a critical section, but cannot make any calls to\r
- FreeRTOS API functions. If configASSERT() is defined in FreeRTOSConfig.h\r
- then portASSERT_IF_INTERRUPT_PRIORITY_INVALID() will result in an assertion\r
- failure if a FreeRTOS API function is called from an interrupt that has been\r
- assigned a priority above the configured maximum system call priority.\r
- Only FreeRTOS functions that end in FromISR can be called from interrupts\r
- that have been assigned a priority at or (logically) below the maximum\r
- system call interrupt priority. FreeRTOS maintains a separate interrupt\r
- safe API to ensure interrupt entry is as fast and as simple as possible.\r
- More information (albeit Cortex-M specific) is provided on the following\r
- link: http://www.freertos.org/RTOS-Cortex-M3-M4.html */\r
- portASSERT_IF_INTERRUPT_PRIORITY_INVALID();\r
-\r
- uxSavedInterruptStatus = portTICK_TYPE_SET_INTERRUPT_MASK_FROM_ISR();\r
- {\r
- xReturn = xTickCount;\r
- }\r
- portTICK_TYPE_CLEAR_INTERRUPT_MASK_FROM_ISR( uxSavedInterruptStatus );\r
-\r
- return xReturn;\r
-}\r
-/*-----------------------------------------------------------*/\r
-\r
-UBaseType_t uxTaskGetNumberOfTasks( void )\r
-{\r
- /* A critical section is not required because the variables are of type\r
- BaseType_t. */\r
- return uxCurrentNumberOfTasks;\r
-}\r
-/*-----------------------------------------------------------*/\r
-\r
-char *pcTaskGetName( TaskHandle_t xTaskToQuery ) /*lint !e971 Unqualified char types are allowed for strings and single characters only. */\r
-{\r
-TCB_t *pxTCB;\r
-\r
- /* If null is passed in here then the name of the calling task is being\r
- queried. */\r
- pxTCB = prvGetTCBFromHandle( xTaskToQuery );\r
- configASSERT( pxTCB );\r
- return &( pxTCB->pcTaskName[ 0 ] );\r
-}\r
-/*-----------------------------------------------------------*/\r
-\r
-#if ( INCLUDE_xTaskGetHandle == 1 )\r
-\r
- static TCB_t *prvSearchForNameWithinSingleList( List_t *pxList, const char pcNameToQuery[] )\r
- {\r
- TCB_t *pxNextTCB, *pxFirstTCB, *pxReturn = NULL;\r
- UBaseType_t x;\r
- char cNextChar;\r
-\r
- /* This function is called with the scheduler suspended. */\r
-\r
- if( listCURRENT_LIST_LENGTH( pxList ) > ( UBaseType_t ) 0 )\r
- {\r
- listGET_OWNER_OF_NEXT_ENTRY( pxFirstTCB, pxList );\r
-\r
- do\r
- {\r
- listGET_OWNER_OF_NEXT_ENTRY( pxNextTCB, pxList );\r
-\r
- /* Check each character in the name looking for a match or\r
- mismatch. */\r
- for( x = ( UBaseType_t ) 0; x < ( UBaseType_t ) configMAX_TASK_NAME_LEN; x++ )\r
- {\r
- cNextChar = pxNextTCB->pcTaskName[ x ];\r
-\r
- if( cNextChar != pcNameToQuery[ x ] )\r
- {\r
- /* Characters didn't match. */\r
- break;\r
- }\r
- else if( cNextChar == 0x00 )\r
- {\r
- /* Both strings terminated, a match must have been\r
- found. */\r
- pxReturn = pxNextTCB;\r
- break;\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
-\r
- if( pxReturn != NULL )\r
- {\r
- /* The handle has been found. */\r
- break;\r
- }\r
-\r
- } while( pxNextTCB != pxFirstTCB );\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
-\r
- return pxReturn;\r
- }\r
-\r
-#endif /* INCLUDE_xTaskGetHandle */\r
-/*-----------------------------------------------------------*/\r
-\r
-#if ( INCLUDE_xTaskGetHandle == 1 )\r
-\r
- TaskHandle_t xTaskGetHandle( const char *pcNameToQuery ) /*lint !e971 Unqualified char types are allowed for strings and single characters only. */\r
- {\r
- UBaseType_t uxQueue = configMAX_PRIORITIES;\r
- TCB_t* pxTCB;\r
-\r
- /* Task names will be truncated to configMAX_TASK_NAME_LEN - 1 bytes. */\r
- configASSERT( strlen( pcNameToQuery ) < configMAX_TASK_NAME_LEN );\r
-\r
- vTaskSuspendAll();\r
- {\r
- /* Search the ready lists. */\r
- do\r
- {\r
- uxQueue--;\r
- pxTCB = prvSearchForNameWithinSingleList( ( List_t * ) &( pxReadyTasksLists[ uxQueue ] ), pcNameToQuery );\r
-\r
- if( pxTCB != NULL )\r
- {\r
- /* Found the handle. */\r
- break;\r
- }\r
-\r
- } while( uxQueue > ( UBaseType_t ) tskIDLE_PRIORITY ); /*lint !e961 MISRA exception as the casts are only redundant for some ports. */\r
-\r
- /* Search the delayed lists. */\r
- if( pxTCB == NULL )\r
- {\r
- pxTCB = prvSearchForNameWithinSingleList( ( List_t * ) pxDelayedTaskList, pcNameToQuery );\r
- }\r
-\r
- if( pxTCB == NULL )\r
- {\r
- pxTCB = prvSearchForNameWithinSingleList( ( List_t * ) pxOverflowDelayedTaskList, pcNameToQuery );\r
- }\r
-\r
- #if ( INCLUDE_vTaskSuspend == 1 )\r
- {\r
- if( pxTCB == NULL )\r
- {\r
- /* Search the suspended list. */\r
- pxTCB = prvSearchForNameWithinSingleList( &xSuspendedTaskList, pcNameToQuery );\r
- }\r
- }\r
- #endif\r
-\r
- #if( INCLUDE_vTaskDelete == 1 )\r
- {\r
- if( pxTCB == NULL )\r
- {\r
- /* Search the deleted list. */\r
- pxTCB = prvSearchForNameWithinSingleList( &xTasksWaitingTermination, pcNameToQuery );\r
- }\r
- }\r
- #endif\r
- }\r
- ( void ) xTaskResumeAll();\r
-\r
- return ( TaskHandle_t ) pxTCB;\r
- }\r
-\r
-#endif /* INCLUDE_xTaskGetHandle */\r
-/*-----------------------------------------------------------*/\r
-\r
-#if ( configUSE_TRACE_FACILITY == 1 )\r
-\r
- UBaseType_t uxTaskGetSystemState( TaskStatus_t * const pxTaskStatusArray, const UBaseType_t uxArraySize, uint32_t * const pulTotalRunTime )\r
- {\r
- UBaseType_t uxTask = 0, uxQueue = configMAX_PRIORITIES;\r
-\r
- vTaskSuspendAll();\r
- {\r
- /* Is there a space in the array for each task in the system? */\r
- if( uxArraySize >= uxCurrentNumberOfTasks )\r
- {\r
- /* Fill in an TaskStatus_t structure with information on each\r
- task in the Ready state. */\r
- do\r
- {\r
- uxQueue--;\r
- uxTask += prvListTasksWithinSingleList( &( pxTaskStatusArray[ uxTask ] ), &( pxReadyTasksLists[ uxQueue ] ), eReady );\r
-\r
- } while( uxQueue > ( UBaseType_t ) tskIDLE_PRIORITY ); /*lint !e961 MISRA exception as the casts are only redundant for some ports. */\r
-\r
- /* Fill in an TaskStatus_t structure with information on each\r
- task in the Blocked state. */\r
- uxTask += prvListTasksWithinSingleList( &( pxTaskStatusArray[ uxTask ] ), ( List_t * ) pxDelayedTaskList, eBlocked );\r
- uxTask += prvListTasksWithinSingleList( &( pxTaskStatusArray[ uxTask ] ), ( List_t * ) pxOverflowDelayedTaskList, eBlocked );\r
-\r
- #if( INCLUDE_vTaskDelete == 1 )\r
- {\r
- /* Fill in an TaskStatus_t structure with information on\r
- each task that has been deleted but not yet cleaned up. */\r
- uxTask += prvListTasksWithinSingleList( &( pxTaskStatusArray[ uxTask ] ), &xTasksWaitingTermination, eDeleted );\r
- }\r
- #endif\r
-\r
- #if ( INCLUDE_vTaskSuspend == 1 )\r
- {\r
- /* Fill in an TaskStatus_t structure with information on\r
- each task in the Suspended state. */\r
- uxTask += prvListTasksWithinSingleList( &( pxTaskStatusArray[ uxTask ] ), &xSuspendedTaskList, eSuspended );\r
- }\r
- #endif\r
-\r
- #if ( configGENERATE_RUN_TIME_STATS == 1)\r
- {\r
- if( pulTotalRunTime != NULL )\r
- {\r
- #ifdef portALT_GET_RUN_TIME_COUNTER_VALUE\r
- portALT_GET_RUN_TIME_COUNTER_VALUE( ( *pulTotalRunTime ) );\r
- #else\r
- *pulTotalRunTime = portGET_RUN_TIME_COUNTER_VALUE();\r
- #endif\r
- }\r
- }\r
- #else\r
- {\r
- if( pulTotalRunTime != NULL )\r
- {\r
- *pulTotalRunTime = 0;\r
- }\r
- }\r
- #endif\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- ( void ) xTaskResumeAll();\r
-\r
- return uxTask;\r
- }\r
-\r
-#endif /* configUSE_TRACE_FACILITY */\r
-/*----------------------------------------------------------*/\r
-\r
-#if ( INCLUDE_xTaskGetIdleTaskHandle == 1 )\r
-\r
- TaskHandle_t xTaskGetIdleTaskHandle( void )\r
- {\r
- /* If xTaskGetIdleTaskHandle() is called before the scheduler has been\r
- started, then xIdleTaskHandle will be NULL. */\r
- configASSERT( ( xIdleTaskHandle != NULL ) );\r
- return xIdleTaskHandle;\r
- }\r
-\r
-#endif /* INCLUDE_xTaskGetIdleTaskHandle */\r
-/*----------------------------------------------------------*/\r
-\r
-/* This conditional compilation should use inequality to 0, not equality to 1.\r
-This is to ensure vTaskStepTick() is available when user defined low power mode\r
-implementations require configUSE_TICKLESS_IDLE to be set to a value other than\r
-1. */\r
-#if ( configUSE_TICKLESS_IDLE != 0 )\r
-\r
- void vTaskStepTick( const TickType_t xTicksToJump )\r
- {\r
- /* Correct the tick count value after a period during which the tick\r
- was suppressed. Note this does *not* call the tick hook function for\r
- each stepped tick. */\r
- configASSERT( ( xTickCount + xTicksToJump ) <= xNextTaskUnblockTime );\r
- xTickCount += xTicksToJump;\r
- traceINCREASE_TICK_COUNT( xTicksToJump );\r
- }\r
-\r
-#endif /* configUSE_TICKLESS_IDLE */\r
-/*----------------------------------------------------------*/\r
-\r
-#if ( INCLUDE_xTaskAbortDelay == 1 )\r
-\r
- BaseType_t xTaskAbortDelay( TaskHandle_t xTask )\r
- {\r
- TCB_t *pxTCB = ( TCB_t * ) xTask;\r
- BaseType_t xReturn;\r
-\r
- configASSERT( pxTCB );\r
-\r
- vTaskSuspendAll();\r
- {\r
- /* A task can only be prematurely removed from the Blocked state if\r
- it is actually in the Blocked state. */\r
- if( eTaskGetState( xTask ) == eBlocked )\r
- {\r
- xReturn = pdPASS;\r
-\r
- /* Remove the reference to the task from the blocked list. An\r
- interrupt won't touch the xStateListItem because the\r
- scheduler is suspended. */\r
- ( void ) uxListRemove( &( pxTCB->xStateListItem ) );\r
-\r
- /* Is the task waiting on an event also? If so remove it from\r
- the event list too. Interrupts can touch the event list item,\r
- even though the scheduler is suspended, so a critical section\r
- is used. */\r
- taskENTER_CRITICAL();\r
- {\r
- if( listLIST_ITEM_CONTAINER( &( pxTCB->xEventListItem ) ) != NULL )\r
- {\r
- ( void ) uxListRemove( &( pxTCB->xEventListItem ) );\r
- pxTCB->ucDelayAborted = pdTRUE;\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- taskEXIT_CRITICAL();\r
-\r
- /* Place the unblocked task into the appropriate ready list. */\r
- prvAddTaskToReadyList( pxTCB );\r
-\r
- /* A task being unblocked cannot cause an immediate context\r
- switch if preemption is turned off. */\r
- #if ( configUSE_PREEMPTION == 1 )\r
- {\r
- /* Preemption is on, but a context switch should only be\r
- performed if the unblocked task has a priority that is\r
- equal to or higher than the currently executing task. */\r
- if( pxTCB->uxPriority > pxCurrentTCB->uxPriority )\r
- {\r
- /* Pend the yield to be performed when the scheduler\r
- is unsuspended. */\r
- xYieldPending = pdTRUE;\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- #endif /* configUSE_PREEMPTION */\r
- }\r
- else\r
- {\r
- xReturn = pdFAIL;\r
- }\r
- }\r
- ( void ) xTaskResumeAll();\r
-\r
- return xReturn;\r
- }\r
-\r
-#endif /* INCLUDE_xTaskAbortDelay */\r
-/*----------------------------------------------------------*/\r
-\r
-BaseType_t xTaskIncrementTick( void )\r
-{\r
-TCB_t * pxTCB;\r
-TickType_t xItemValue;\r
-BaseType_t xSwitchRequired = pdFALSE;\r
-\r
- /* Called by the portable layer each time a tick interrupt occurs.\r
- Increments the tick then checks to see if the new tick value will cause any\r
- tasks to be unblocked. */\r
- traceTASK_INCREMENT_TICK( xTickCount );\r
- if( uxSchedulerSuspended == ( UBaseType_t ) pdFALSE )\r
- {\r
- /* Minor optimisation. The tick count cannot change in this\r
- block. */\r
- const TickType_t xConstTickCount = xTickCount + ( TickType_t ) 1;\r
-\r
- /* Increment the RTOS tick, switching the delayed and overflowed\r
- delayed lists if it wraps to 0. */\r
- xTickCount = xConstTickCount;\r
-\r
- if( xConstTickCount == ( TickType_t ) 0U ) /*lint !e774 'if' does not always evaluate to false as it is looking for an overflow. */\r
- {\r
- taskSWITCH_DELAYED_LISTS();\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
-\r
- /* See if this tick has made a timeout expire. Tasks are stored in\r
- the queue in the order of their wake time - meaning once one task\r
- has been found whose block time has not expired there is no need to\r
- look any further down the list. */\r
- if( xConstTickCount >= xNextTaskUnblockTime )\r
- {\r
- for( ;; )\r
- {\r
- if( listLIST_IS_EMPTY( pxDelayedTaskList ) != pdFALSE )\r
- {\r
- /* The delayed list is empty. Set xNextTaskUnblockTime\r
- to the maximum possible value so it is extremely\r
- unlikely that the\r
- if( xTickCount >= xNextTaskUnblockTime ) test will pass\r
- next time through. */\r
- xNextTaskUnblockTime = portMAX_DELAY; /*lint !e961 MISRA exception as the casts are only redundant for some ports. */\r
- break;\r
- }\r
- else\r
- {\r
- /* The delayed list is not empty, get the value of the\r
- item at the head of the delayed list. This is the time\r
- at which the task at the head of the delayed list must\r
- be removed from the Blocked state. */\r
- pxTCB = ( TCB_t * ) listGET_OWNER_OF_HEAD_ENTRY( pxDelayedTaskList );\r
- xItemValue = listGET_LIST_ITEM_VALUE( &( pxTCB->xStateListItem ) );\r
-\r
- if( xConstTickCount < xItemValue )\r
- {\r
- /* It is not time to unblock this item yet, but the\r
- item value is the time at which the task at the head\r
- of the blocked list must be removed from the Blocked\r
- state - so record the item value in\r
- xNextTaskUnblockTime. */\r
- xNextTaskUnblockTime = xItemValue;\r
- break;\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
-\r
- /* It is time to remove the item from the Blocked state. */\r
- ( void ) uxListRemove( &( pxTCB->xStateListItem ) );\r
-\r
- /* Is the task waiting on an event also? If so remove\r
- it from the event list. */\r
- if( listLIST_ITEM_CONTAINER( &( pxTCB->xEventListItem ) ) != NULL )\r
- {\r
- ( void ) uxListRemove( &( pxTCB->xEventListItem ) );\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
-\r
- /* Place the unblocked task into the appropriate ready\r
- list. */\r
- prvAddTaskToReadyList( pxTCB );\r
-\r
- /* A task being unblocked cannot cause an immediate\r
- context switch if preemption is turned off. */\r
- #if ( configUSE_PREEMPTION == 1 )\r
- {\r
- /* Preemption is on, but a context switch should\r
- only be performed if the unblocked task has a\r
- priority that is equal to or higher than the\r
- currently executing task. */\r
- if( pxTCB->uxPriority >= pxCurrentTCB->uxPriority )\r
- {\r
- xSwitchRequired = pdTRUE;\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- #endif /* configUSE_PREEMPTION */\r
- }\r
- }\r
- }\r
-\r
- /* Tasks of equal priority to the currently running task will share\r
- processing time (time slice) if preemption is on, and the application\r
- writer has not explicitly turned time slicing off. */\r
- #if ( ( configUSE_PREEMPTION == 1 ) && ( configUSE_TIME_SLICING == 1 ) )\r
- {\r
- if( listCURRENT_LIST_LENGTH( &( pxReadyTasksLists[ pxCurrentTCB->uxPriority ] ) ) > ( UBaseType_t ) 1 )\r
- {\r
- xSwitchRequired = pdTRUE;\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- #endif /* ( ( configUSE_PREEMPTION == 1 ) && ( configUSE_TIME_SLICING == 1 ) ) */\r
-\r
- #if ( configUSE_TICK_HOOK == 1 )\r
- {\r
- /* Guard against the tick hook being called when the pended tick\r
- count is being unwound (when the scheduler is being unlocked). */\r
- if( uxPendedTicks == ( UBaseType_t ) 0U )\r
- {\r
- vApplicationTickHook();\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- #endif /* configUSE_TICK_HOOK */\r
- }\r
- else\r
- {\r
- ++uxPendedTicks;\r
-\r
- /* The tick hook gets called at regular intervals, even if the\r
- scheduler is locked. */\r
- #if ( configUSE_TICK_HOOK == 1 )\r
- {\r
- vApplicationTickHook();\r
- }\r
- #endif\r
- }\r
-\r
- #if ( configUSE_PREEMPTION == 1 )\r
- {\r
- if( xYieldPending != pdFALSE )\r
- {\r
- xSwitchRequired = pdTRUE;\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- #endif /* configUSE_PREEMPTION */\r
-\r
- return xSwitchRequired;\r
-}\r
-/*-----------------------------------------------------------*/\r
-\r
-#if ( configUSE_APPLICATION_TASK_TAG == 1 )\r
-\r
- void vTaskSetApplicationTaskTag( TaskHandle_t xTask, TaskHookFunction_t pxHookFunction )\r
- {\r
- TCB_t *xTCB;\r
-\r
- /* If xTask is NULL then it is the task hook of the calling task that is\r
- getting set. */\r
- if( xTask == NULL )\r
- {\r
- xTCB = ( TCB_t * ) pxCurrentTCB;\r
- }\r
- else\r
- {\r
- xTCB = ( TCB_t * ) xTask;\r
- }\r
-\r
- /* Save the hook function in the TCB. A critical section is required as\r
- the value can be accessed from an interrupt. */\r
- taskENTER_CRITICAL();\r
- xTCB->pxTaskTag = pxHookFunction;\r
- taskEXIT_CRITICAL();\r
- }\r
-\r
-#endif /* configUSE_APPLICATION_TASK_TAG */\r
-/*-----------------------------------------------------------*/\r
-\r
-#if ( configUSE_APPLICATION_TASK_TAG == 1 )\r
-\r
- TaskHookFunction_t xTaskGetApplicationTaskTag( TaskHandle_t xTask )\r
- {\r
- TCB_t *xTCB;\r
- TaskHookFunction_t xReturn;\r
-\r
- /* If xTask is NULL then we are setting our own task hook. */\r
- if( xTask == NULL )\r
- {\r
- xTCB = ( TCB_t * ) pxCurrentTCB;\r
- }\r
- else\r
- {\r
- xTCB = ( TCB_t * ) xTask;\r
- }\r
-\r
- /* Save the hook function in the TCB. A critical section is required as\r
- the value can be accessed from an interrupt. */\r
- taskENTER_CRITICAL();\r
- {\r
- xReturn = xTCB->pxTaskTag;\r
- }\r
- taskEXIT_CRITICAL();\r
-\r
- return xReturn;\r
- }\r
-\r
-#endif /* configUSE_APPLICATION_TASK_TAG */\r
-/*-----------------------------------------------------------*/\r
-\r
-#if ( configUSE_APPLICATION_TASK_TAG == 1 )\r
-\r
- BaseType_t xTaskCallApplicationTaskHook( TaskHandle_t xTask, void *pvParameter )\r
- {\r
- TCB_t *xTCB;\r
- BaseType_t xReturn;\r
-\r
- /* If xTask is NULL then we are calling our own task hook. */\r
- if( xTask == NULL )\r
- {\r
- xTCB = ( TCB_t * ) pxCurrentTCB;\r
- }\r
- else\r
- {\r
- xTCB = ( TCB_t * ) xTask;\r
- }\r
-\r
- if( xTCB->pxTaskTag != NULL )\r
- {\r
- xReturn = xTCB->pxTaskTag( pvParameter );\r
- }\r
- else\r
- {\r
- xReturn = pdFAIL;\r
- }\r
-\r
- return xReturn;\r
- }\r
-\r
-#endif /* configUSE_APPLICATION_TASK_TAG */\r
-/*-----------------------------------------------------------*/\r
-\r
-void vTaskSwitchContext( void )\r
-{\r
- if( uxSchedulerSuspended != ( UBaseType_t ) pdFALSE )\r
- {\r
- /* The scheduler is currently suspended - do not allow a context\r
- switch. */\r
- xYieldPending = pdTRUE;\r
- }\r
- else\r
- {\r
- xYieldPending = pdFALSE;\r
- traceTASK_SWITCHED_OUT();\r
-\r
- #if ( configGENERATE_RUN_TIME_STATS == 1 )\r
- {\r
- #ifdef portALT_GET_RUN_TIME_COUNTER_VALUE\r
- portALT_GET_RUN_TIME_COUNTER_VALUE( ulTotalRunTime );\r
- #else\r
- ulTotalRunTime = portGET_RUN_TIME_COUNTER_VALUE();\r
- #endif\r
-\r
- /* Add the amount of time the task has been running to the\r
- accumulated time so far. The time the task started running was\r
- stored in ulTaskSwitchedInTime. Note that there is no overflow\r
- protection here so count values are only valid until the timer\r
- overflows. The guard against negative values is to protect\r
- against suspect run time stat counter implementations - which\r
- are provided by the application, not the kernel. */\r
- if( ulTotalRunTime > ulTaskSwitchedInTime )\r
- {\r
- pxCurrentTCB->ulRunTimeCounter += ( ulTotalRunTime - ulTaskSwitchedInTime );\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- ulTaskSwitchedInTime = ulTotalRunTime;\r
- }\r
- #endif /* configGENERATE_RUN_TIME_STATS */\r
-\r
- /* Check for stack overflow, if configured. */\r
- taskCHECK_FOR_STACK_OVERFLOW();\r
-\r
- /* Select a new task to run using either the generic C or port\r
- optimised asm code. */\r
- taskSELECT_HIGHEST_PRIORITY_TASK();\r
- traceTASK_SWITCHED_IN();\r
-\r
- #if ( configUSE_NEWLIB_REENTRANT == 1 )\r
- {\r
- /* Switch Newlib's _impure_ptr variable to point to the _reent\r
- structure specific to this task. */\r
- _impure_ptr = &( pxCurrentTCB->xNewLib_reent );\r
- }\r
- #endif /* configUSE_NEWLIB_REENTRANT */\r
- }\r
-}\r
-/*-----------------------------------------------------------*/\r
-\r
-void vTaskPlaceOnEventList( List_t * const pxEventList, const TickType_t xTicksToWait )\r
-{\r
- configASSERT( pxEventList );\r
-\r
- /* THIS FUNCTION MUST BE CALLED WITH EITHER INTERRUPTS DISABLED OR THE\r
- SCHEDULER SUSPENDED AND THE QUEUE BEING ACCESSED LOCKED. */\r
-\r
- /* Place the event list item of the TCB in the appropriate event list.\r
- This is placed in the list in priority order so the highest priority task\r
- is the first to be woken by the event. The queue that contains the event\r
- list is locked, preventing simultaneous access from interrupts. */\r
- vListInsert( pxEventList, &( pxCurrentTCB->xEventListItem ) );\r
-\r
- prvAddCurrentTaskToDelayedList( xTicksToWait, pdTRUE );\r
-}\r
-/*-----------------------------------------------------------*/\r
-\r
-void vTaskPlaceOnUnorderedEventList( List_t * pxEventList, const TickType_t xItemValue, const TickType_t xTicksToWait )\r
-{\r
- configASSERT( pxEventList );\r
-\r
- /* THIS FUNCTION MUST BE CALLED WITH THE SCHEDULER SUSPENDED. It is used by\r
- the event groups implementation. */\r
- configASSERT( uxSchedulerSuspended != 0 );\r
-\r
- /* Store the item value in the event list item. It is safe to access the\r
- event list item here as interrupts won't access the event list item of a\r
- task that is not in the Blocked state. */\r
- listSET_LIST_ITEM_VALUE( &( pxCurrentTCB->xEventListItem ), xItemValue | taskEVENT_LIST_ITEM_VALUE_IN_USE );\r
-\r
- /* Place the event list item of the TCB at the end of the appropriate event\r
- list. It is safe to access the event list here because it is part of an\r
- event group implementation - and interrupts don't access event groups\r
- directly (instead they access them indirectly by pending function calls to\r
- the task level). */\r
- vListInsertEnd( pxEventList, &( pxCurrentTCB->xEventListItem ) );\r
-\r
- prvAddCurrentTaskToDelayedList( xTicksToWait, pdTRUE );\r
-}\r
-/*-----------------------------------------------------------*/\r
-\r
-#if( configUSE_TIMERS == 1 )\r
-\r
- void vTaskPlaceOnEventListRestricted( List_t * const pxEventList, TickType_t xTicksToWait, const BaseType_t xWaitIndefinitely )\r
- {\r
- configASSERT( pxEventList );\r
-\r
- /* This function should not be called by application code hence the\r
- 'Restricted' in its name. It is not part of the public API. It is\r
- designed for use by kernel code, and has special calling requirements -\r
- it should be called with the scheduler suspended. */\r
-\r
-\r
- /* Place the event list item of the TCB in the appropriate event list.\r
- In this case it is assume that this is the only task that is going to\r
- be waiting on this event list, so the faster vListInsertEnd() function\r
- can be used in place of vListInsert. */\r
- vListInsertEnd( pxEventList, &( pxCurrentTCB->xEventListItem ) );\r
-\r
- /* If the task should block indefinitely then set the block time to a\r
- value that will be recognised as an indefinite delay inside the\r
- prvAddCurrentTaskToDelayedList() function. */\r
- if( xWaitIndefinitely != pdFALSE )\r
- {\r
- xTicksToWait = portMAX_DELAY;\r
- }\r
-\r
- traceTASK_DELAY_UNTIL( ( xTickCount + xTicksToWait ) );\r
- prvAddCurrentTaskToDelayedList( xTicksToWait, xWaitIndefinitely );\r
- }\r
-\r
-#endif /* configUSE_TIMERS */\r
-/*-----------------------------------------------------------*/\r
-\r
-BaseType_t xTaskRemoveFromEventList( const List_t * const pxEventList )\r
-{\r
-TCB_t *pxUnblockedTCB;\r
-BaseType_t xReturn;\r
-\r
- /* THIS FUNCTION MUST BE CALLED FROM A CRITICAL SECTION. It can also be\r
- called from a critical section within an ISR. */\r
-\r
- /* The event list is sorted in priority order, so the first in the list can\r
- be removed as it is known to be the highest priority. Remove the TCB from\r
- the delayed list, and add it to the ready list.\r
-\r
- If an event is for a queue that is locked then this function will never\r
- get called - the lock count on the queue will get modified instead. This\r
- means exclusive access to the event list is guaranteed here.\r
-\r
- This function assumes that a check has already been made to ensure that\r
- pxEventList is not empty. */\r
- pxUnblockedTCB = ( TCB_t * ) listGET_OWNER_OF_HEAD_ENTRY( pxEventList );\r
- configASSERT( pxUnblockedTCB );\r
- ( void ) uxListRemove( &( pxUnblockedTCB->xEventListItem ) );\r
-\r
- if( uxSchedulerSuspended == ( UBaseType_t ) pdFALSE )\r
- {\r
- ( void ) uxListRemove( &( pxUnblockedTCB->xStateListItem ) );\r
- prvAddTaskToReadyList( pxUnblockedTCB );\r
- }\r
- else\r
- {\r
- /* The delayed and ready lists cannot be accessed, so hold this task\r
- pending until the scheduler is resumed. */\r
- vListInsertEnd( &( xPendingReadyList ), &( pxUnblockedTCB->xEventListItem ) );\r
- }\r
-\r
- if( pxUnblockedTCB->uxPriority > pxCurrentTCB->uxPriority )\r
- {\r
- /* Return true if the task removed from the event list has a higher\r
- priority than the calling task. This allows the calling task to know if\r
- it should force a context switch now. */\r
- xReturn = pdTRUE;\r
-\r
- /* Mark that a yield is pending in case the user is not using the\r
- "xHigherPriorityTaskWoken" parameter to an ISR safe FreeRTOS function. */\r
- xYieldPending = pdTRUE;\r
- }\r
- else\r
- {\r
- xReturn = pdFALSE;\r
- }\r
-\r
- #if( configUSE_TICKLESS_IDLE != 0 )\r
- {\r
- /* If a task is blocked on a kernel object then xNextTaskUnblockTime\r
- might be set to the blocked task's time out time. If the task is\r
- unblocked for a reason other than a timeout xNextTaskUnblockTime is\r
- normally left unchanged, because it is automatically reset to a new\r
- value when the tick count equals xNextTaskUnblockTime. However if\r
- tickless idling is used it might be more important to enter sleep mode\r
- at the earliest possible time - so reset xNextTaskUnblockTime here to\r
- ensure it is updated at the earliest possible time. */\r
- prvResetNextTaskUnblockTime();\r
- }\r
- #endif\r
-\r
- return xReturn;\r
-}\r
-/*-----------------------------------------------------------*/\r
-\r
-void vTaskRemoveFromUnorderedEventList( ListItem_t * pxEventListItem, const TickType_t xItemValue )\r
-{\r
-TCB_t *pxUnblockedTCB;\r
-\r
- /* THIS FUNCTION MUST BE CALLED WITH THE SCHEDULER SUSPENDED. It is used by\r
- the event flags implementation. */\r
- configASSERT( uxSchedulerSuspended != pdFALSE );\r
-\r
- /* Store the new item value in the event list. */\r
- listSET_LIST_ITEM_VALUE( pxEventListItem, xItemValue | taskEVENT_LIST_ITEM_VALUE_IN_USE );\r
-\r
- /* Remove the event list form the event flag. Interrupts do not access\r
- event flags. */\r
- pxUnblockedTCB = ( TCB_t * ) listGET_LIST_ITEM_OWNER( pxEventListItem );\r
- configASSERT( pxUnblockedTCB );\r
- ( void ) uxListRemove( pxEventListItem );\r
-\r
- /* Remove the task from the delayed list and add it to the ready list. The\r
- scheduler is suspended so interrupts will not be accessing the ready\r
- lists. */\r
- ( void ) uxListRemove( &( pxUnblockedTCB->xStateListItem ) );\r
- prvAddTaskToReadyList( pxUnblockedTCB );\r
-\r
- if( pxUnblockedTCB->uxPriority > pxCurrentTCB->uxPriority )\r
- {\r
- /* The unblocked task has a priority above that of the calling task, so\r
- a context switch is required. This function is called with the\r
- scheduler suspended so xYieldPending is set so the context switch\r
- occurs immediately that the scheduler is resumed (unsuspended). */\r
- xYieldPending = pdTRUE;\r
- }\r
-}\r
-/*-----------------------------------------------------------*/\r
-\r
-void vTaskSetTimeOutState( TimeOut_t * const pxTimeOut )\r
-{\r
- configASSERT( pxTimeOut );\r
- taskENTER_CRITICAL();\r
- {\r
- pxTimeOut->xOverflowCount = xNumOfOverflows;\r
- pxTimeOut->xTimeOnEntering = xTickCount;\r
- }\r
- taskEXIT_CRITICAL();\r
-}\r
-/*-----------------------------------------------------------*/\r
-\r
-void vTaskInternalSetTimeOutState( TimeOut_t * const pxTimeOut )\r
-{\r
- /* For internal use only as it does not use a critical section. */\r
- pxTimeOut->xOverflowCount = xNumOfOverflows;\r
- pxTimeOut->xTimeOnEntering = xTickCount;\r
-}\r
-/*-----------------------------------------------------------*/\r
-\r
-BaseType_t xTaskCheckForTimeOut( TimeOut_t * const pxTimeOut, TickType_t * const pxTicksToWait )\r
-{\r
-BaseType_t xReturn;\r
-\r
- configASSERT( pxTimeOut );\r
- configASSERT( pxTicksToWait );\r
-\r
- taskENTER_CRITICAL();\r
- {\r
- /* Minor optimisation. The tick count cannot change in this block. */\r
- const TickType_t xConstTickCount = xTickCount;\r
- const TickType_t xElapsedTime = xConstTickCount - pxTimeOut->xTimeOnEntering;\r
-\r
- #if( INCLUDE_xTaskAbortDelay == 1 )\r
- if( pxCurrentTCB->ucDelayAborted != pdFALSE )\r
- {\r
- /* The delay was aborted, which is not the same as a time out,\r
- but has the same result. */\r
- pxCurrentTCB->ucDelayAborted = pdFALSE;\r
- xReturn = pdTRUE;\r
- }\r
- else\r
- #endif\r
-\r
- #if ( INCLUDE_vTaskSuspend == 1 )\r
- if( *pxTicksToWait == portMAX_DELAY )\r
- {\r
- /* If INCLUDE_vTaskSuspend is set to 1 and the block time\r
- specified is the maximum block time then the task should block\r
- indefinitely, and therefore never time out. */\r
- xReturn = pdFALSE;\r
- }\r
- else\r
- #endif\r
-\r
- if( ( xNumOfOverflows != pxTimeOut->xOverflowCount ) && ( xConstTickCount >= pxTimeOut->xTimeOnEntering ) ) /*lint !e525 Indentation preferred as is to make code within pre-processor directives clearer. */\r
- {\r
- /* The tick count is greater than the time at which\r
- vTaskSetTimeout() was called, but has also overflowed since\r
- vTaskSetTimeOut() was called. It must have wrapped all the way\r
- around and gone past again. This passed since vTaskSetTimeout()\r
- was called. */\r
- xReturn = pdTRUE;\r
- }\r
- else if( xElapsedTime < *pxTicksToWait ) /*lint !e961 Explicit casting is only redundant with some compilers, whereas others require it to prevent integer conversion errors. */\r
- {\r
- /* Not a genuine timeout. Adjust parameters for time remaining. */\r
- *pxTicksToWait -= xElapsedTime;\r
- vTaskInternalSetTimeOutState( pxTimeOut );\r
- xReturn = pdFALSE;\r
- }\r
- else\r
- {\r
- *pxTicksToWait = 0;\r
- xReturn = pdTRUE;\r
- }\r
- }\r
- taskEXIT_CRITICAL();\r
-\r
- return xReturn;\r
-}\r
-/*-----------------------------------------------------------*/\r
-\r
-void vTaskMissedYield( void )\r
-{\r
- xYieldPending = pdTRUE;\r
-}\r
-/*-----------------------------------------------------------*/\r
-\r
-#if ( configUSE_TRACE_FACILITY == 1 )\r
-\r
- UBaseType_t uxTaskGetTaskNumber( TaskHandle_t xTask )\r
- {\r
- UBaseType_t uxReturn;\r
- TCB_t *pxTCB;\r
-\r
- if( xTask != NULL )\r
- {\r
- pxTCB = ( TCB_t * ) xTask;\r
- uxReturn = pxTCB->uxTaskNumber;\r
- }\r
- else\r
- {\r
- uxReturn = 0U;\r
- }\r
-\r
- return uxReturn;\r
- }\r
-\r
-#endif /* configUSE_TRACE_FACILITY */\r
-/*-----------------------------------------------------------*/\r
-\r
-#if ( configUSE_TRACE_FACILITY == 1 )\r
-\r
- void vTaskSetTaskNumber( TaskHandle_t xTask, const UBaseType_t uxHandle )\r
- {\r
- TCB_t *pxTCB;\r
-\r
- if( xTask != NULL )\r
- {\r
- pxTCB = ( TCB_t * ) xTask;\r
- pxTCB->uxTaskNumber = uxHandle;\r
- }\r
- }\r
-\r
-#endif /* configUSE_TRACE_FACILITY */\r
-\r
-/*\r
- * -----------------------------------------------------------\r
- * The Idle task.\r
- * ----------------------------------------------------------\r
- *\r
- * The portTASK_FUNCTION() macro is used to allow port/compiler specific\r
- * language extensions. The equivalent prototype for this function is:\r
- *\r
- * void prvIdleTask( void *pvParameters );\r
- *\r
- */\r
-static portTASK_FUNCTION( prvIdleTask, pvParameters )\r
-{\r
- /* Stop warnings. */\r
- ( void ) pvParameters;\r
-\r
- /** THIS IS THE RTOS IDLE TASK - WHICH IS CREATED AUTOMATICALLY WHEN THE\r
- SCHEDULER IS STARTED. **/\r
-\r
- /* In case a task that has a secure context deletes itself, in which case\r
- the idle task is responsible for deleting the task's secure context, if\r
- any. */\r
- portTASK_CALLS_SECURE_FUNCTIONS();\r
-\r
- for( ;; )\r
- {\r
- /* See if any tasks have deleted themselves - if so then the idle task\r
- is responsible for freeing the deleted task's TCB and stack. */\r
- prvCheckTasksWaitingTermination();\r
-\r
- #if ( configUSE_PREEMPTION == 0 )\r
- {\r
- /* If we are not using preemption we keep forcing a task switch to\r
- see if any other task has become available. If we are using\r
- preemption we don't need to do this as any task becoming available\r
- will automatically get the processor anyway. */\r
- taskYIELD();\r
- }\r
- #endif /* configUSE_PREEMPTION */\r
-\r
- #if ( ( configUSE_PREEMPTION == 1 ) && ( configIDLE_SHOULD_YIELD == 1 ) )\r
- {\r
- /* When using preemption tasks of equal priority will be\r
- timesliced. If a task that is sharing the idle priority is ready\r
- to run then the idle task should yield before the end of the\r
- timeslice.\r
-\r
- A critical region is not required here as we are just reading from\r
- the list, and an occasional incorrect value will not matter. If\r
- the ready list at the idle priority contains more than one task\r
- then a task other than the idle task is ready to execute. */\r
- if( listCURRENT_LIST_LENGTH( &( pxReadyTasksLists[ tskIDLE_PRIORITY ] ) ) > ( UBaseType_t ) 1 )\r
- {\r
- taskYIELD();\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- #endif /* ( ( configUSE_PREEMPTION == 1 ) && ( configIDLE_SHOULD_YIELD == 1 ) ) */\r
-\r
- #if ( configUSE_IDLE_HOOK == 1 )\r
- {\r
- extern void vApplicationIdleHook( void );\r
-\r
- /* Call the user defined function from within the idle task. This\r
- allows the application designer to add background functionality\r
- without the overhead of a separate task.\r
- NOTE: vApplicationIdleHook() MUST NOT, UNDER ANY CIRCUMSTANCES,\r
- CALL A FUNCTION THAT MIGHT BLOCK. */\r
- vApplicationIdleHook();\r
- }\r
- #endif /* configUSE_IDLE_HOOK */\r
-\r
- /* This conditional compilation should use inequality to 0, not equality\r
- to 1. This is to ensure portSUPPRESS_TICKS_AND_SLEEP() is called when\r
- user defined low power mode implementations require\r
- configUSE_TICKLESS_IDLE to be set to a value other than 1. */\r
- #if ( configUSE_TICKLESS_IDLE != 0 )\r
- {\r
- TickType_t xExpectedIdleTime;\r
-\r
- /* It is not desirable to suspend then resume the scheduler on\r
- each iteration of the idle task. Therefore, a preliminary\r
- test of the expected idle time is performed without the\r
- scheduler suspended. The result here is not necessarily\r
- valid. */\r
- xExpectedIdleTime = prvGetExpectedIdleTime();\r
-\r
- if( xExpectedIdleTime >= configEXPECTED_IDLE_TIME_BEFORE_SLEEP )\r
- {\r
- vTaskSuspendAll();\r
- {\r
- /* Now the scheduler is suspended, the expected idle\r
- time can be sampled again, and this time its value can\r
- be used. */\r
- configASSERT( xNextTaskUnblockTime >= xTickCount );\r
- xExpectedIdleTime = prvGetExpectedIdleTime();\r
-\r
- /* Define the following macro to set xExpectedIdleTime to 0\r
- if the application does not want\r
- portSUPPRESS_TICKS_AND_SLEEP() to be called. */\r
- configPRE_SUPPRESS_TICKS_AND_SLEEP_PROCESSING( xExpectedIdleTime );\r
-\r
- if( xExpectedIdleTime >= configEXPECTED_IDLE_TIME_BEFORE_SLEEP )\r
- {\r
- traceLOW_POWER_IDLE_BEGIN();\r
- portSUPPRESS_TICKS_AND_SLEEP( xExpectedIdleTime );\r
- traceLOW_POWER_IDLE_END();\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- ( void ) xTaskResumeAll();\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- #endif /* configUSE_TICKLESS_IDLE */\r
- }\r
-}\r
-/*-----------------------------------------------------------*/\r
-\r
-#if( configUSE_TICKLESS_IDLE != 0 )\r
-\r
- eSleepModeStatus eTaskConfirmSleepModeStatus( void )\r
- {\r
- /* The idle task exists in addition to the application tasks. */\r
- const UBaseType_t uxNonApplicationTasks = 1;\r
- eSleepModeStatus eReturn = eStandardSleep;\r
-\r
- if( listCURRENT_LIST_LENGTH( &xPendingReadyList ) != 0 )\r
- {\r
- /* A task was made ready while the scheduler was suspended. */\r
- eReturn = eAbortSleep;\r
- }\r
- else if( xYieldPending != pdFALSE )\r
- {\r
- /* A yield was pended while the scheduler was suspended. */\r
- eReturn = eAbortSleep;\r
- }\r
- else\r
- {\r
- /* If all the tasks are in the suspended list (which might mean they\r
- have an infinite block time rather than actually being suspended)\r
- then it is safe to turn all clocks off and just wait for external\r
- interrupts. */\r
- if( listCURRENT_LIST_LENGTH( &xSuspendedTaskList ) == ( uxCurrentNumberOfTasks - uxNonApplicationTasks ) )\r
- {\r
- eReturn = eNoTasksWaitingTimeout;\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
-\r
- return eReturn;\r
- }\r
-\r
-#endif /* configUSE_TICKLESS_IDLE */\r
-/*-----------------------------------------------------------*/\r
-\r
-#if ( configNUM_THREAD_LOCAL_STORAGE_POINTERS != 0 )\r
-\r
- void vTaskSetThreadLocalStoragePointer( TaskHandle_t xTaskToSet, BaseType_t xIndex, void *pvValue )\r
- {\r
- TCB_t *pxTCB;\r
-\r
- if( xIndex < configNUM_THREAD_LOCAL_STORAGE_POINTERS )\r
- {\r
- pxTCB = prvGetTCBFromHandle( xTaskToSet );\r
- pxTCB->pvThreadLocalStoragePointers[ xIndex ] = pvValue;\r
- }\r
- }\r
-\r
-#endif /* configNUM_THREAD_LOCAL_STORAGE_POINTERS */\r
-/*-----------------------------------------------------------*/\r
-\r
-#if ( configNUM_THREAD_LOCAL_STORAGE_POINTERS != 0 )\r
-\r
- void *pvTaskGetThreadLocalStoragePointer( TaskHandle_t xTaskToQuery, BaseType_t xIndex )\r
- {\r
- void *pvReturn = NULL;\r
- TCB_t *pxTCB;\r
-\r
- if( xIndex < configNUM_THREAD_LOCAL_STORAGE_POINTERS )\r
- {\r
- pxTCB = prvGetTCBFromHandle( xTaskToQuery );\r
- pvReturn = pxTCB->pvThreadLocalStoragePointers[ xIndex ];\r
- }\r
- else\r
- {\r
- pvReturn = NULL;\r
- }\r
-\r
- return pvReturn;\r
- }\r
-\r
-#endif /* configNUM_THREAD_LOCAL_STORAGE_POINTERS */\r
-/*-----------------------------------------------------------*/\r
-\r
-#if ( portUSING_MPU_WRAPPERS == 1 )\r
-\r
- void vTaskAllocateMPURegions( TaskHandle_t xTaskToModify, const MemoryRegion_t * const xRegions )\r
- {\r
- TCB_t *pxTCB;\r
-\r
- /* If null is passed in here then we are modifying the MPU settings of\r
- the calling task. */\r
- pxTCB = prvGetTCBFromHandle( xTaskToModify );\r
-\r
- vPortStoreTaskMPUSettings( &( pxTCB->xMPUSettings ), xRegions, NULL, 0 );\r
- }\r
-\r
-#endif /* portUSING_MPU_WRAPPERS */\r
-/*-----------------------------------------------------------*/\r
-\r
-static void prvInitialiseTaskLists( void )\r
-{\r
-UBaseType_t uxPriority;\r
-\r
- for( uxPriority = ( UBaseType_t ) 0U; uxPriority < ( UBaseType_t ) configMAX_PRIORITIES; uxPriority++ )\r
- {\r
- vListInitialise( &( pxReadyTasksLists[ uxPriority ] ) );\r
- }\r
-\r
- vListInitialise( &xDelayedTaskList1 );\r
- vListInitialise( &xDelayedTaskList2 );\r
- vListInitialise( &xPendingReadyList );\r
-\r
- #if ( INCLUDE_vTaskDelete == 1 )\r
- {\r
- vListInitialise( &xTasksWaitingTermination );\r
- }\r
- #endif /* INCLUDE_vTaskDelete */\r
-\r
- #if ( INCLUDE_vTaskSuspend == 1 )\r
- {\r
- vListInitialise( &xSuspendedTaskList );\r
- }\r
- #endif /* INCLUDE_vTaskSuspend */\r
-\r
- /* Start with pxDelayedTaskList using list1 and the pxOverflowDelayedTaskList\r
- using list2. */\r
- pxDelayedTaskList = &xDelayedTaskList1;\r
- pxOverflowDelayedTaskList = &xDelayedTaskList2;\r
-}\r
-/*-----------------------------------------------------------*/\r
-\r
-static void prvCheckTasksWaitingTermination( void )\r
-{\r
-\r
- /** THIS FUNCTION IS CALLED FROM THE RTOS IDLE TASK **/\r
-\r
- #if ( INCLUDE_vTaskDelete == 1 )\r
- {\r
- TCB_t *pxTCB;\r
-\r
- /* uxDeletedTasksWaitingCleanUp is used to prevent vTaskSuspendAll()\r
- being called too often in the idle task. */\r
- while( uxDeletedTasksWaitingCleanUp > ( UBaseType_t ) 0U )\r
- {\r
- taskENTER_CRITICAL();\r
- {\r
- pxTCB = ( TCB_t * ) listGET_OWNER_OF_HEAD_ENTRY( ( &xTasksWaitingTermination ) );\r
- ( void ) uxListRemove( &( pxTCB->xStateListItem ) );\r
- --uxCurrentNumberOfTasks;\r
- --uxDeletedTasksWaitingCleanUp;\r
- }\r
- taskEXIT_CRITICAL();\r
-\r
- prvDeleteTCB( pxTCB );\r
- }\r
- }\r
- #endif /* INCLUDE_vTaskDelete */\r
-}\r
-/*-----------------------------------------------------------*/\r
-\r
-#if( configUSE_TRACE_FACILITY == 1 )\r
-\r
- void vTaskGetInfo( TaskHandle_t xTask, TaskStatus_t *pxTaskStatus, BaseType_t xGetFreeStackSpace, eTaskState eState )\r
- {\r
- TCB_t *pxTCB;\r
-\r
- /* xTask is NULL then get the state of the calling task. */\r
- pxTCB = prvGetTCBFromHandle( xTask );\r
-\r
- pxTaskStatus->xHandle = ( TaskHandle_t ) pxTCB;\r
- pxTaskStatus->pcTaskName = ( const char * ) &( pxTCB->pcTaskName [ 0 ] );\r
- pxTaskStatus->uxCurrentPriority = pxTCB->uxPriority;\r
- pxTaskStatus->pxStackBase = pxTCB->pxStack;\r
- pxTaskStatus->xTaskNumber = pxTCB->uxTCBNumber;\r
-\r
- #if ( configUSE_MUTEXES == 1 )\r
- {\r
- pxTaskStatus->uxBasePriority = pxTCB->uxBasePriority;\r
- }\r
- #else\r
- {\r
- pxTaskStatus->uxBasePriority = 0;\r
- }\r
- #endif\r
-\r
- #if ( configGENERATE_RUN_TIME_STATS == 1 )\r
- {\r
- pxTaskStatus->ulRunTimeCounter = pxTCB->ulRunTimeCounter;\r
- }\r
- #else\r
- {\r
- pxTaskStatus->ulRunTimeCounter = 0;\r
- }\r
- #endif\r
-\r
- /* Obtaining the task state is a little fiddly, so is only done if the\r
- value of eState passed into this function is eInvalid - otherwise the\r
- state is just set to whatever is passed in. */\r
- if( eState != eInvalid )\r
- {\r
- if( pxTCB == pxCurrentTCB )\r
- {\r
- pxTaskStatus->eCurrentState = eRunning;\r
- }\r
- else\r
- {\r
- pxTaskStatus->eCurrentState = eState;\r
-\r
- #if ( INCLUDE_vTaskSuspend == 1 )\r
- {\r
- /* If the task is in the suspended list then there is a\r
- chance it is actually just blocked indefinitely - so really\r
- it should be reported as being in the Blocked state. */\r
- if( eState == eSuspended )\r
- {\r
- vTaskSuspendAll();\r
- {\r
- if( listLIST_ITEM_CONTAINER( &( pxTCB->xEventListItem ) ) != NULL )\r
- {\r
- pxTaskStatus->eCurrentState = eBlocked;\r
- }\r
- }\r
- ( void ) xTaskResumeAll();\r
- }\r
- }\r
- #endif /* INCLUDE_vTaskSuspend */\r
- }\r
- }\r
- else\r
- {\r
- pxTaskStatus->eCurrentState = eTaskGetState( pxTCB );\r
- }\r
-\r
- /* Obtaining the stack space takes some time, so the xGetFreeStackSpace\r
- parameter is provided to allow it to be skipped. */\r
- if( xGetFreeStackSpace != pdFALSE )\r
- {\r
- #if ( portSTACK_GROWTH > 0 )\r
- {\r
- pxTaskStatus->usStackHighWaterMark = prvTaskCheckFreeStackSpace( ( uint8_t * ) pxTCB->pxEndOfStack );\r
- }\r
- #else\r
- {\r
- pxTaskStatus->usStackHighWaterMark = prvTaskCheckFreeStackSpace( ( uint8_t * ) pxTCB->pxStack );\r
- }\r
- #endif\r
- }\r
- else\r
- {\r
- pxTaskStatus->usStackHighWaterMark = 0;\r
- }\r
- }\r
-\r
-#endif /* configUSE_TRACE_FACILITY */\r
-/*-----------------------------------------------------------*/\r
-\r
-#if ( configUSE_TRACE_FACILITY == 1 )\r
-\r
- static UBaseType_t prvListTasksWithinSingleList( TaskStatus_t *pxTaskStatusArray, List_t *pxList, eTaskState eState )\r
- {\r
- configLIST_VOLATILE TCB_t *pxNextTCB, *pxFirstTCB;\r
- UBaseType_t uxTask = 0;\r
-\r
- if( listCURRENT_LIST_LENGTH( pxList ) > ( UBaseType_t ) 0 )\r
- {\r
- listGET_OWNER_OF_NEXT_ENTRY( pxFirstTCB, pxList );\r
-\r
- /* Populate an TaskStatus_t structure within the\r
- pxTaskStatusArray array for each task that is referenced from\r
- pxList. See the definition of TaskStatus_t in task.h for the\r
- meaning of each TaskStatus_t structure member. */\r
- do\r
- {\r
- listGET_OWNER_OF_NEXT_ENTRY( pxNextTCB, pxList );\r
- vTaskGetInfo( ( TaskHandle_t ) pxNextTCB, &( pxTaskStatusArray[ uxTask ] ), pdTRUE, eState );\r
- uxTask++;\r
- } while( pxNextTCB != pxFirstTCB );\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
-\r
- return uxTask;\r
- }\r
-\r
-#endif /* configUSE_TRACE_FACILITY */\r
-/*-----------------------------------------------------------*/\r
-\r
-#if ( ( configUSE_TRACE_FACILITY == 1 ) || ( INCLUDE_uxTaskGetStackHighWaterMark == 1 ) )\r
-\r
- static uint16_t prvTaskCheckFreeStackSpace( const uint8_t * pucStackByte )\r
- {\r
- uint32_t ulCount = 0U;\r
-\r
- while( *pucStackByte == ( uint8_t ) tskSTACK_FILL_BYTE )\r
- {\r
- pucStackByte -= portSTACK_GROWTH;\r
- ulCount++;\r
- }\r
-\r
- ulCount /= ( uint32_t ) sizeof( StackType_t ); /*lint !e961 Casting is not redundant on smaller architectures. */\r
-\r
- return ( uint16_t ) ulCount;\r
- }\r
-\r
-#endif /* ( ( configUSE_TRACE_FACILITY == 1 ) || ( INCLUDE_uxTaskGetStackHighWaterMark == 1 ) ) */\r
-/*-----------------------------------------------------------*/\r
-\r
-#if ( INCLUDE_uxTaskGetStackHighWaterMark == 1 )\r
-\r
- UBaseType_t uxTaskGetStackHighWaterMark( TaskHandle_t xTask )\r
- {\r
- TCB_t *pxTCB;\r
- uint8_t *pucEndOfStack;\r
- UBaseType_t uxReturn;\r
-\r
- pxTCB = prvGetTCBFromHandle( xTask );\r
-\r
- #if portSTACK_GROWTH < 0\r
- {\r
- pucEndOfStack = ( uint8_t * ) pxTCB->pxStack;\r
- }\r
- #else\r
- {\r
- pucEndOfStack = ( uint8_t * ) pxTCB->pxEndOfStack;\r
- }\r
- #endif\r
-\r
- uxReturn = ( UBaseType_t ) prvTaskCheckFreeStackSpace( pucEndOfStack );\r
-\r
- return uxReturn;\r
- }\r
-\r
-#endif /* INCLUDE_uxTaskGetStackHighWaterMark */\r
-/*-----------------------------------------------------------*/\r
-\r
-#if ( INCLUDE_vTaskDelete == 1 )\r
-\r
- static void prvDeleteTCB( TCB_t *pxTCB )\r
- {\r
- /* This call is required specifically for the TriCore port. It must be\r
- above the vPortFree() calls. The call is also used by ports/demos that\r
- want to allocate and clean RAM statically. */\r
- portCLEAN_UP_TCB( pxTCB );\r
-\r
- /* Free up the memory allocated by the scheduler for the task. It is up\r
- to the task to free any memory allocated at the application level. */\r
- #if ( configUSE_NEWLIB_REENTRANT == 1 )\r
- {\r
- _reclaim_reent( &( pxTCB->xNewLib_reent ) );\r
- }\r
- #endif /* configUSE_NEWLIB_REENTRANT */\r
-\r
- #if( ( configSUPPORT_DYNAMIC_ALLOCATION == 1 ) && ( configSUPPORT_STATIC_ALLOCATION == 0 ) && ( portUSING_MPU_WRAPPERS == 0 ) )\r
- {\r
- /* The task can only have been allocated dynamically - free both\r
- the stack and TCB. */\r
- vPortFree( pxTCB->pxStack );\r
- vPortFree( pxTCB );\r
- }\r
- #elif( tskSTATIC_AND_DYNAMIC_ALLOCATION_POSSIBLE != 0 ) /*lint !e731 Macro has been consolidated for readability reasons. */\r
- {\r
- /* The task could have been allocated statically or dynamically, so\r
- check what was statically allocated before trying to free the\r
- memory. */\r
- if( pxTCB->ucStaticallyAllocated == tskDYNAMICALLY_ALLOCATED_STACK_AND_TCB )\r
- {\r
- /* Both the stack and TCB were allocated dynamically, so both\r
- must be freed. */\r
- vPortFree( pxTCB->pxStack );\r
- vPortFree( pxTCB );\r
- }\r
- else if( pxTCB->ucStaticallyAllocated == tskSTATICALLY_ALLOCATED_STACK_ONLY )\r
- {\r
- /* Only the stack was statically allocated, so the TCB is the\r
- only memory that must be freed. */\r
- vPortFree( pxTCB );\r
- }\r
- else\r
- {\r
- /* Neither the stack nor the TCB were allocated dynamically, so\r
- nothing needs to be freed. */\r
- configASSERT( pxTCB->ucStaticallyAllocated == tskSTATICALLY_ALLOCATED_STACK_AND_TCB );\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- #endif /* configSUPPORT_DYNAMIC_ALLOCATION */\r
- }\r
-\r
-#endif /* INCLUDE_vTaskDelete */\r
-/*-----------------------------------------------------------*/\r
-\r
-static void prvResetNextTaskUnblockTime( void )\r
-{\r
-TCB_t *pxTCB;\r
-\r
- if( listLIST_IS_EMPTY( pxDelayedTaskList ) != pdFALSE )\r
- {\r
- /* The new current delayed list is empty. Set xNextTaskUnblockTime to\r
- the maximum possible value so it is extremely unlikely that the\r
- if( xTickCount >= xNextTaskUnblockTime ) test will pass until\r
- there is an item in the delayed list. */\r
- xNextTaskUnblockTime = portMAX_DELAY;\r
- }\r
- else\r
- {\r
- /* The new current delayed list is not empty, get the value of\r
- the item at the head of the delayed list. This is the time at\r
- which the task at the head of the delayed list should be removed\r
- from the Blocked state. */\r
- ( pxTCB ) = ( TCB_t * ) listGET_OWNER_OF_HEAD_ENTRY( pxDelayedTaskList );\r
- xNextTaskUnblockTime = listGET_LIST_ITEM_VALUE( &( ( pxTCB )->xStateListItem ) );\r
- }\r
-}\r
-/*-----------------------------------------------------------*/\r
-\r
-#if ( ( INCLUDE_xTaskGetCurrentTaskHandle == 1 ) || ( configUSE_MUTEXES == 1 ) )\r
-\r
- TaskHandle_t xTaskGetCurrentTaskHandle( void )\r
- {\r
- TaskHandle_t xReturn;\r
-\r
- /* A critical section is not required as this is not called from\r
- an interrupt and the current TCB will always be the same for any\r
- individual execution thread. */\r
- xReturn = pxCurrentTCB;\r
-\r
- return xReturn;\r
- }\r
-\r
-#endif /* ( ( INCLUDE_xTaskGetCurrentTaskHandle == 1 ) || ( configUSE_MUTEXES == 1 ) ) */\r
-/*-----------------------------------------------------------*/\r
-\r
-#if ( ( INCLUDE_xTaskGetSchedulerState == 1 ) || ( configUSE_TIMERS == 1 ) )\r
-\r
- BaseType_t xTaskGetSchedulerState( void )\r
- {\r
- BaseType_t xReturn;\r
-\r
- if( xSchedulerRunning == pdFALSE )\r
- {\r
- xReturn = taskSCHEDULER_NOT_STARTED;\r
- }\r
- else\r
- {\r
- if( uxSchedulerSuspended == ( UBaseType_t ) pdFALSE )\r
- {\r
- xReturn = taskSCHEDULER_RUNNING;\r
- }\r
- else\r
- {\r
- xReturn = taskSCHEDULER_SUSPENDED;\r
- }\r
- }\r
-\r
- return xReturn;\r
- }\r
-\r
-#endif /* ( ( INCLUDE_xTaskGetSchedulerState == 1 ) || ( configUSE_TIMERS == 1 ) ) */\r
-/*-----------------------------------------------------------*/\r
-\r
-#if ( configUSE_MUTEXES == 1 )\r
-\r
- BaseType_t xTaskPriorityInherit( TaskHandle_t const pxMutexHolder )\r
- {\r
- TCB_t * const pxMutexHolderTCB = ( TCB_t * ) pxMutexHolder;\r
- BaseType_t xReturn = pdFALSE;\r
-\r
- /* If the mutex was given back by an interrupt while the queue was\r
- locked then the mutex holder might now be NULL. _RB_ Is this still\r
- needed as interrupts can no longer use mutexes? */\r
- if( pxMutexHolder != NULL )\r
- {\r
- /* If the holder of the mutex has a priority below the priority of\r
- the task attempting to obtain the mutex then it will temporarily\r
- inherit the priority of the task attempting to obtain the mutex. */\r
- if( pxMutexHolderTCB->uxPriority < pxCurrentTCB->uxPriority )\r
- {\r
- /* Adjust the mutex holder state to account for its new\r
- priority. Only reset the event list item value if the value is\r
- not being used for anything else. */\r
- if( ( listGET_LIST_ITEM_VALUE( &( pxMutexHolderTCB->xEventListItem ) ) & taskEVENT_LIST_ITEM_VALUE_IN_USE ) == 0UL )\r
- {\r
- listSET_LIST_ITEM_VALUE( &( pxMutexHolderTCB->xEventListItem ), ( TickType_t ) configMAX_PRIORITIES - ( TickType_t ) pxCurrentTCB->uxPriority ); /*lint !e961 MISRA exception as the casts are only redundant for some ports. */\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
-\r
- /* If the task being modified is in the ready state it will need\r
- to be moved into a new list. */\r
- if( listIS_CONTAINED_WITHIN( &( pxReadyTasksLists[ pxMutexHolderTCB->uxPriority ] ), &( pxMutexHolderTCB->xStateListItem ) ) != pdFALSE )\r
- {\r
- if( uxListRemove( &( pxMutexHolderTCB->xStateListItem ) ) == ( UBaseType_t ) 0 )\r
- {\r
- taskRESET_READY_PRIORITY( pxMutexHolderTCB->uxPriority );\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
-\r
- /* Inherit the priority before being moved into the new list. */\r
- pxMutexHolderTCB->uxPriority = pxCurrentTCB->uxPriority;\r
- prvAddTaskToReadyList( pxMutexHolderTCB );\r
- }\r
- else\r
- {\r
- /* Just inherit the priority. */\r
- pxMutexHolderTCB->uxPriority = pxCurrentTCB->uxPriority;\r
- }\r
-\r
- traceTASK_PRIORITY_INHERIT( pxMutexHolderTCB, pxCurrentTCB->uxPriority );\r
-\r
- /* Inheritance occurred. */\r
- xReturn = pdTRUE;\r
- }\r
- else\r
- {\r
- if( pxMutexHolderTCB->uxBasePriority < pxCurrentTCB->uxPriority )\r
- {\r
- /* The base priority of the mutex holder is lower than the\r
- priority of the task attempting to take the mutex, but the\r
- current priority of the mutex holder is not lower than the\r
- priority of the task attempting to take the mutex.\r
- Therefore the mutex holder must have already inherited a\r
- priority, but inheritance would have occurred if that had\r
- not been the case. */\r
- xReturn = pdTRUE;\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
-\r
- return xReturn;\r
- }\r
-\r
-#endif /* configUSE_MUTEXES */\r
-/*-----------------------------------------------------------*/\r
-\r
-#if ( configUSE_MUTEXES == 1 )\r
-\r
- BaseType_t xTaskPriorityDisinherit( TaskHandle_t const pxMutexHolder )\r
- {\r
- TCB_t * const pxTCB = ( TCB_t * ) pxMutexHolder;\r
- BaseType_t xReturn = pdFALSE;\r
-\r
- if( pxMutexHolder != NULL )\r
- {\r
- /* A task can only have an inherited priority if it holds the mutex.\r
- If the mutex is held by a task then it cannot be given from an\r
- interrupt, and if a mutex is given by the holding task then it must\r
- be the running state task. */\r
- configASSERT( pxTCB == pxCurrentTCB );\r
- configASSERT( pxTCB->uxMutexesHeld );\r
- ( pxTCB->uxMutexesHeld )--;\r
-\r
- /* Has the holder of the mutex inherited the priority of another\r
- task? */\r
- if( pxTCB->uxPriority != pxTCB->uxBasePriority )\r
- {\r
- /* Only disinherit if no other mutexes are held. */\r
- if( pxTCB->uxMutexesHeld == ( UBaseType_t ) 0 )\r
- {\r
- /* A task can only have an inherited priority if it holds\r
- the mutex. If the mutex is held by a task then it cannot be\r
- given from an interrupt, and if a mutex is given by the\r
- holding task then it must be the running state task. Remove\r
- the holding task from the ready list. */\r
- if( uxListRemove( &( pxTCB->xStateListItem ) ) == ( UBaseType_t ) 0 )\r
- {\r
- taskRESET_READY_PRIORITY( pxTCB->uxPriority );\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
-\r
- /* Disinherit the priority before adding the task into the\r
- new ready list. */\r
- traceTASK_PRIORITY_DISINHERIT( pxTCB, pxTCB->uxBasePriority );\r
- pxTCB->uxPriority = pxTCB->uxBasePriority;\r
-\r
- /* Reset the event list item value. It cannot be in use for\r
- any other purpose if this task is running, and it must be\r
- running to give back the mutex. */\r
- listSET_LIST_ITEM_VALUE( &( pxTCB->xEventListItem ), ( TickType_t ) configMAX_PRIORITIES - ( TickType_t ) pxTCB->uxPriority ); /*lint !e961 MISRA exception as the casts are only redundant for some ports. */\r
- prvAddTaskToReadyList( pxTCB );\r
-\r
- /* Return true to indicate that a context switch is required.\r
- This is only actually required in the corner case whereby\r
- multiple mutexes were held and the mutexes were given back\r
- in an order different to that in which they were taken.\r
- If a context switch did not occur when the first mutex was\r
- returned, even if a task was waiting on it, then a context\r
- switch should occur when the last mutex is returned whether\r
- a task is waiting on it or not. */\r
- xReturn = pdTRUE;\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
-\r
- return xReturn;\r
- }\r
-\r
-#endif /* configUSE_MUTEXES */\r
-/*-----------------------------------------------------------*/\r
-\r
-#if ( configUSE_MUTEXES == 1 )\r
-\r
- void vTaskPriorityDisinheritAfterTimeout( TaskHandle_t const pxMutexHolder, UBaseType_t uxHighestPriorityWaitingTask )\r
- {\r
- TCB_t * const pxTCB = ( TCB_t * ) pxMutexHolder;\r
- UBaseType_t uxPriorityUsedOnEntry, uxPriorityToUse;\r
- const UBaseType_t uxOnlyOneMutexHeld = ( UBaseType_t ) 1;\r
-\r
- if( pxMutexHolder != NULL )\r
- {\r
- /* If pxMutexHolder is not NULL then the holder must hold at least\r
- one mutex. */\r
- configASSERT( pxTCB->uxMutexesHeld );\r
-\r
- /* Determine the priority to which the priority of the task that\r
- holds the mutex should be set. This will be the greater of the\r
- holding task's base priority and the priority of the highest\r
- priority task that is waiting to obtain the mutex. */\r
- if( pxTCB->uxBasePriority < uxHighestPriorityWaitingTask )\r
- {\r
- uxPriorityToUse = uxHighestPriorityWaitingTask;\r
- }\r
- else\r
- {\r
- uxPriorityToUse = pxTCB->uxBasePriority;\r
- }\r
-\r
- /* Does the priority need to change? */\r
- if( pxTCB->uxPriority != uxPriorityToUse )\r
- {\r
- /* Only disinherit if no other mutexes are held. This is a\r
- simplification in the priority inheritance implementation. If\r
- the task that holds the mutex is also holding other mutexes then\r
- the other mutexes may have caused the priority inheritance. */\r
- if( pxTCB->uxMutexesHeld == uxOnlyOneMutexHeld )\r
- {\r
- /* If a task has timed out because it already holds the\r
- mutex it was trying to obtain then it cannot of inherited\r
- its own priority. */\r
- configASSERT( pxTCB != pxCurrentTCB );\r
-\r
- /* Disinherit the priority, remembering the previous\r
- priority to facilitate determining the subject task's\r
- state. */\r
- traceTASK_PRIORITY_DISINHERIT( pxTCB, pxTCB->uxBasePriority );\r
- uxPriorityUsedOnEntry = pxTCB->uxPriority;\r
- pxTCB->uxPriority = uxPriorityToUse;\r
-\r
- /* Only reset the event list item value if the value is not\r
- being used for anything else. */\r
- if( ( listGET_LIST_ITEM_VALUE( &( pxTCB->xEventListItem ) ) & taskEVENT_LIST_ITEM_VALUE_IN_USE ) == 0UL )\r
- {\r
- listSET_LIST_ITEM_VALUE( &( pxTCB->xEventListItem ), ( TickType_t ) configMAX_PRIORITIES - ( TickType_t ) uxPriorityToUse ); /*lint !e961 MISRA exception as the casts are only redundant for some ports. */\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
-\r
- /* If the running task is not the task that holds the mutex\r
- then the task that holds the mutex could be in either the\r
- Ready, Blocked or Suspended states. Only remove the task\r
- from its current state list if it is in the Ready state as\r
- the task's priority is going to change and there is one\r
- Ready list per priority. */\r
- if( listIS_CONTAINED_WITHIN( &( pxReadyTasksLists[ uxPriorityUsedOnEntry ] ), &( pxTCB->xStateListItem ) ) != pdFALSE )\r
- {\r
- if( uxListRemove( &( pxTCB->xStateListItem ) ) == ( UBaseType_t ) 0 )\r
- {\r
- taskRESET_READY_PRIORITY( pxTCB->uxPriority );\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
-\r
- prvAddTaskToReadyList( pxTCB );\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
-\r
-#endif /* configUSE_MUTEXES */\r
-/*-----------------------------------------------------------*/\r
-\r
-#if ( portCRITICAL_NESTING_IN_TCB == 1 )\r
-\r
- void vTaskEnterCritical( void )\r
- {\r
- portDISABLE_INTERRUPTS();\r
-\r
- if( xSchedulerRunning != pdFALSE )\r
- {\r
- ( pxCurrentTCB->uxCriticalNesting )++;\r
-\r
- /* This is not the interrupt safe version of the enter critical\r
- function so assert() if it is being called from an interrupt\r
- context. Only API functions that end in "FromISR" can be used in an\r
- interrupt. Only assert if the critical nesting count is 1 to\r
- protect against recursive calls if the assert function also uses a\r
- critical section. */\r
- if( pxCurrentTCB->uxCriticalNesting == 1 )\r
- {\r
- portASSERT_IF_IN_ISR();\r
- }\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
-\r
-#endif /* portCRITICAL_NESTING_IN_TCB */\r
-/*-----------------------------------------------------------*/\r
-\r
-#if ( portCRITICAL_NESTING_IN_TCB == 1 )\r
-\r
- void vTaskExitCritical( void )\r
- {\r
- if( xSchedulerRunning != pdFALSE )\r
- {\r
- if( pxCurrentTCB->uxCriticalNesting > 0U )\r
- {\r
- ( pxCurrentTCB->uxCriticalNesting )--;\r
-\r
- if( pxCurrentTCB->uxCriticalNesting == 0U )\r
- {\r
- portENABLE_INTERRUPTS();\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
-\r
-#endif /* portCRITICAL_NESTING_IN_TCB */\r
-/*-----------------------------------------------------------*/\r
-\r
-#if ( ( configUSE_TRACE_FACILITY == 1 ) && ( configUSE_STATS_FORMATTING_FUNCTIONS > 0 ) )\r
-\r
- static char *prvWriteNameToBuffer( char *pcBuffer, const char *pcTaskName )\r
- {\r
- size_t x;\r
-\r
- /* Start by copying the entire string. */\r
- strcpy( pcBuffer, pcTaskName );\r
-\r
- /* Pad the end of the string with spaces to ensure columns line up when\r
- printed out. */\r
- for( x = strlen( pcBuffer ); x < ( size_t ) ( configMAX_TASK_NAME_LEN - 1 ); x++ )\r
- {\r
- pcBuffer[ x ] = ' ';\r
- }\r
-\r
- /* Terminate. */\r
- pcBuffer[ x ] = 0x00;\r
-\r
- /* Return the new end of string. */\r
- return &( pcBuffer[ x ] );\r
- }\r
-\r
-#endif /* ( configUSE_TRACE_FACILITY == 1 ) && ( configUSE_STATS_FORMATTING_FUNCTIONS > 0 ) */\r
-/*-----------------------------------------------------------*/\r
-\r
-#if ( ( configUSE_TRACE_FACILITY == 1 ) && ( configUSE_STATS_FORMATTING_FUNCTIONS > 0 ) && ( configSUPPORT_DYNAMIC_ALLOCATION == 1 ) )\r
-\r
- void vTaskList( char * pcWriteBuffer )\r
- {\r
- TaskStatus_t *pxTaskStatusArray;\r
- volatile UBaseType_t uxArraySize, x;\r
- char cStatus;\r
-\r
- /*\r
- * PLEASE NOTE:\r
- *\r
- * This function is provided for convenience only, and is used by many\r
- * of the demo applications. Do not consider it to be part of the\r
- * scheduler.\r
- *\r
- * vTaskList() calls uxTaskGetSystemState(), then formats part of the\r
- * uxTaskGetSystemState() output into a human readable table that\r
- * displays task names, states and stack usage.\r
- *\r
- * vTaskList() has a dependency on the sprintf() C library function that\r
- * might bloat the code size, use a lot of stack, and provide different\r
- * results on different platforms. An alternative, tiny, third party,\r
- * and limited functionality implementation of sprintf() is provided in\r
- * many of the FreeRTOS/Demo sub-directories in a file called\r
- * printf-stdarg.c (note printf-stdarg.c does not provide a full\r
- * snprintf() implementation!).\r
- *\r
- * It is recommended that production systems call uxTaskGetSystemState()\r
- * directly to get access to raw stats data, rather than indirectly\r
- * through a call to vTaskList().\r
- */\r
-\r
-\r
- /* Make sure the write buffer does not contain a string. */\r
- *pcWriteBuffer = 0x00;\r
-\r
- /* Take a snapshot of the number of tasks in case it changes while this\r
- function is executing. */\r
- uxArraySize = uxCurrentNumberOfTasks;\r
-\r
- /* Allocate an array index for each task. NOTE! if\r
- configSUPPORT_DYNAMIC_ALLOCATION is set to 0 then pvPortMalloc() will\r
- equate to NULL. */\r
- pxTaskStatusArray = pvPortMalloc( uxCurrentNumberOfTasks * sizeof( TaskStatus_t ) );\r
-\r
- if( pxTaskStatusArray != NULL )\r
- {\r
- /* Generate the (binary) data. */\r
- uxArraySize = uxTaskGetSystemState( pxTaskStatusArray, uxArraySize, NULL );\r
-\r
- /* Create a human readable table from the binary data. */\r
- for( x = 0; x < uxArraySize; x++ )\r
- {\r
- switch( pxTaskStatusArray[ x ].eCurrentState )\r
- {\r
- case eRunning: cStatus = tskRUNNING_CHAR;\r
- break;\r
-\r
- case eReady: cStatus = tskREADY_CHAR;\r
- break;\r
-\r
- case eBlocked: cStatus = tskBLOCKED_CHAR;\r
- break;\r
-\r
- case eSuspended: cStatus = tskSUSPENDED_CHAR;\r
- break;\r
-\r
- case eDeleted: cStatus = tskDELETED_CHAR;\r
- break;\r
-\r
- default: /* Should not get here, but it is included\r
- to prevent static checking errors. */\r
- cStatus = 0x00;\r
- break;\r
- }\r
-\r
- /* Write the task name to the string, padding with spaces so it\r
- can be printed in tabular form more easily. */\r
- pcWriteBuffer = prvWriteNameToBuffer( pcWriteBuffer, pxTaskStatusArray[ x ].pcTaskName );\r
-\r
- /* Write the rest of the string. */\r
- sprintf( pcWriteBuffer, "\t%c\t%u\t%u\t%u\r\n", cStatus, ( unsigned int ) pxTaskStatusArray[ x ].uxCurrentPriority, ( unsigned int ) pxTaskStatusArray[ x ].usStackHighWaterMark, ( unsigned int ) pxTaskStatusArray[ x ].xTaskNumber );\r
- pcWriteBuffer += strlen( pcWriteBuffer );\r
- }\r
-\r
- /* Free the array again. NOTE! If configSUPPORT_DYNAMIC_ALLOCATION\r
- is 0 then vPortFree() will be #defined to nothing. */\r
- vPortFree( pxTaskStatusArray );\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
-\r
-#endif /* ( ( configUSE_TRACE_FACILITY == 1 ) && ( configUSE_STATS_FORMATTING_FUNCTIONS > 0 ) && ( configSUPPORT_DYNAMIC_ALLOCATION == 1 ) ) */\r
-/*----------------------------------------------------------*/\r
-\r
-#if ( ( configGENERATE_RUN_TIME_STATS == 1 ) && ( configUSE_STATS_FORMATTING_FUNCTIONS > 0 ) && ( configSUPPORT_DYNAMIC_ALLOCATION == 1 ) )\r
-\r
- void vTaskGetRunTimeStats( char *pcWriteBuffer )\r
- {\r
- TaskStatus_t *pxTaskStatusArray;\r
- volatile UBaseType_t uxArraySize, x;\r
- uint32_t ulTotalTime, ulStatsAsPercentage;\r
-\r
- #if( configUSE_TRACE_FACILITY != 1 )\r
- {\r
- #error configUSE_TRACE_FACILITY must also be set to 1 in FreeRTOSConfig.h to use vTaskGetRunTimeStats().\r
- }\r
- #endif\r
-\r
- /*\r
- * PLEASE NOTE:\r
- *\r
- * This function is provided for convenience only, and is used by many\r
- * of the demo applications. Do not consider it to be part of the\r
- * scheduler.\r
- *\r
- * vTaskGetRunTimeStats() calls uxTaskGetSystemState(), then formats part\r
- * of the uxTaskGetSystemState() output into a human readable table that\r
- * displays the amount of time each task has spent in the Running state\r
- * in both absolute and percentage terms.\r
- *\r
- * vTaskGetRunTimeStats() has a dependency on the sprintf() C library\r
- * function that might bloat the code size, use a lot of stack, and\r
- * provide different results on different platforms. An alternative,\r
- * tiny, third party, and limited functionality implementation of\r
- * sprintf() is provided in many of the FreeRTOS/Demo sub-directories in\r
- * a file called printf-stdarg.c (note printf-stdarg.c does not provide\r
- * a full snprintf() implementation!).\r
- *\r
- * It is recommended that production systems call uxTaskGetSystemState()\r
- * directly to get access to raw stats data, rather than indirectly\r
- * through a call to vTaskGetRunTimeStats().\r
- */\r
-\r
- /* Make sure the write buffer does not contain a string. */\r
- *pcWriteBuffer = 0x00;\r
-\r
- /* Take a snapshot of the number of tasks in case it changes while this\r
- function is executing. */\r
- uxArraySize = uxCurrentNumberOfTasks;\r
-\r
- /* Allocate an array index for each task. NOTE! If\r
- configSUPPORT_DYNAMIC_ALLOCATION is set to 0 then pvPortMalloc() will\r
- equate to NULL. */\r
- pxTaskStatusArray = pvPortMalloc( uxCurrentNumberOfTasks * sizeof( TaskStatus_t ) );\r
-\r
- if( pxTaskStatusArray != NULL )\r
- {\r
- /* Generate the (binary) data. */\r
- uxArraySize = uxTaskGetSystemState( pxTaskStatusArray, uxArraySize, &ulTotalTime );\r
-\r
- /* For percentage calculations. */\r
- ulTotalTime /= 100UL;\r
-\r
- /* Avoid divide by zero errors. */\r
- if( ulTotalTime > 0 )\r
- {\r
- /* Create a human readable table from the binary data. */\r
- for( x = 0; x < uxArraySize; x++ )\r
- {\r
- /* What percentage of the total run time has the task used?\r
- This will always be rounded down to the nearest integer.\r
- ulTotalRunTimeDiv100 has already been divided by 100. */\r
- ulStatsAsPercentage = pxTaskStatusArray[ x ].ulRunTimeCounter / ulTotalTime;\r
-\r
- /* Write the task name to the string, padding with\r
- spaces so it can be printed in tabular form more\r
- easily. */\r
- pcWriteBuffer = prvWriteNameToBuffer( pcWriteBuffer, pxTaskStatusArray[ x ].pcTaskName );\r
-\r
- if( ulStatsAsPercentage > 0UL )\r
- {\r
- #ifdef portLU_PRINTF_SPECIFIER_REQUIRED\r
- {\r
- sprintf( pcWriteBuffer, "\t%lu\t\t%lu%%\r\n", pxTaskStatusArray[ x ].ulRunTimeCounter, ulStatsAsPercentage );\r
- }\r
- #else\r
- {\r
- /* sizeof( int ) == sizeof( long ) so a smaller\r
- printf() library can be used. */\r
- sprintf( pcWriteBuffer, "\t%u\t\t%u%%\r\n", ( unsigned int ) pxTaskStatusArray[ x ].ulRunTimeCounter, ( unsigned int ) ulStatsAsPercentage );\r
- }\r
- #endif\r
- }\r
- else\r
- {\r
- /* If the percentage is zero here then the task has\r
- consumed less than 1% of the total run time. */\r
- #ifdef portLU_PRINTF_SPECIFIER_REQUIRED\r
- {\r
- sprintf( pcWriteBuffer, "\t%lu\t\t<1%%\r\n", pxTaskStatusArray[ x ].ulRunTimeCounter );\r
- }\r
- #else\r
- {\r
- /* sizeof( int ) == sizeof( long ) so a smaller\r
- printf() library can be used. */\r
- sprintf( pcWriteBuffer, "\t%u\t\t<1%%\r\n", ( unsigned int ) pxTaskStatusArray[ x ].ulRunTimeCounter );\r
- }\r
- #endif\r
- }\r
-\r
- pcWriteBuffer += strlen( pcWriteBuffer );\r
- }\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
-\r
- /* Free the array again. NOTE! If configSUPPORT_DYNAMIC_ALLOCATION\r
- is 0 then vPortFree() will be #defined to nothing. */\r
- vPortFree( pxTaskStatusArray );\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
-\r
-#endif /* ( ( configGENERATE_RUN_TIME_STATS == 1 ) && ( configUSE_STATS_FORMATTING_FUNCTIONS > 0 ) && ( configSUPPORT_STATIC_ALLOCATION == 1 ) ) */\r
-/*-----------------------------------------------------------*/\r
-\r
-TickType_t uxTaskResetEventItemValue( void )\r
-{\r
-TickType_t uxReturn;\r
-\r
- uxReturn = listGET_LIST_ITEM_VALUE( &( pxCurrentTCB->xEventListItem ) );\r
-\r
- /* Reset the event list item to its normal value - so it can be used with\r
- queues and semaphores. */\r
- listSET_LIST_ITEM_VALUE( &( pxCurrentTCB->xEventListItem ), ( ( TickType_t ) configMAX_PRIORITIES - ( TickType_t ) pxCurrentTCB->uxPriority ) ); /*lint !e961 MISRA exception as the casts are only redundant for some ports. */\r
-\r
- return uxReturn;\r
-}\r
-/*-----------------------------------------------------------*/\r
-\r
-#if ( configUSE_MUTEXES == 1 )\r
-\r
- void *pvTaskIncrementMutexHeldCount( void )\r
- {\r
- /* If xSemaphoreCreateMutex() is called before any tasks have been created\r
- then pxCurrentTCB will be NULL. */\r
- if( pxCurrentTCB != NULL )\r
- {\r
- ( pxCurrentTCB->uxMutexesHeld )++;\r
- }\r
-\r
- return pxCurrentTCB;\r
- }\r
-\r
-#endif /* configUSE_MUTEXES */\r
-/*-----------------------------------------------------------*/\r
-\r
-#if( configUSE_TASK_NOTIFICATIONS == 1 )\r
-\r
- uint32_t ulTaskNotifyTake( BaseType_t xClearCountOnExit, TickType_t xTicksToWait )\r
- {\r
- uint32_t ulReturn;\r
-\r
- taskENTER_CRITICAL();\r
- {\r
- /* Only block if the notification count is not already non-zero. */\r
- if( pxCurrentTCB->ulNotifiedValue == 0UL )\r
- {\r
- /* Mark this task as waiting for a notification. */\r
- pxCurrentTCB->ucNotifyState = taskWAITING_NOTIFICATION;\r
-\r
- if( xTicksToWait > ( TickType_t ) 0 )\r
- {\r
- prvAddCurrentTaskToDelayedList( xTicksToWait, pdTRUE );\r
- traceTASK_NOTIFY_TAKE_BLOCK();\r
-\r
- /* All ports are written to allow a yield in a critical\r
- section (some will yield immediately, others wait until the\r
- critical section exits) - but it is not something that\r
- application code should ever do. */\r
- portYIELD_WITHIN_API();\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- taskEXIT_CRITICAL();\r
-\r
- taskENTER_CRITICAL();\r
- {\r
- traceTASK_NOTIFY_TAKE();\r
- ulReturn = pxCurrentTCB->ulNotifiedValue;\r
-\r
- if( ulReturn != 0UL )\r
- {\r
- if( xClearCountOnExit != pdFALSE )\r
- {\r
- pxCurrentTCB->ulNotifiedValue = 0UL;\r
- }\r
- else\r
- {\r
- pxCurrentTCB->ulNotifiedValue = ulReturn - ( uint32_t ) 1;\r
- }\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
-\r
- pxCurrentTCB->ucNotifyState = taskNOT_WAITING_NOTIFICATION;\r
- }\r
- taskEXIT_CRITICAL();\r
-\r
- return ulReturn;\r
- }\r
-\r
-#endif /* configUSE_TASK_NOTIFICATIONS */\r
-/*-----------------------------------------------------------*/\r
-\r
-#if( configUSE_TASK_NOTIFICATIONS == 1 )\r
-\r
- BaseType_t xTaskNotifyWait( uint32_t ulBitsToClearOnEntry, uint32_t ulBitsToClearOnExit, uint32_t *pulNotificationValue, TickType_t xTicksToWait )\r
- {\r
- BaseType_t xReturn;\r
-\r
- taskENTER_CRITICAL();\r
- {\r
- /* Only block if a notification is not already pending. */\r
- if( pxCurrentTCB->ucNotifyState != taskNOTIFICATION_RECEIVED )\r
- {\r
- /* Clear bits in the task's notification value as bits may get\r
- set by the notifying task or interrupt. This can be used to\r
- clear the value to zero. */\r
- pxCurrentTCB->ulNotifiedValue &= ~ulBitsToClearOnEntry;\r
-\r
- /* Mark this task as waiting for a notification. */\r
- pxCurrentTCB->ucNotifyState = taskWAITING_NOTIFICATION;\r
-\r
- if( xTicksToWait > ( TickType_t ) 0 )\r
- {\r
- prvAddCurrentTaskToDelayedList( xTicksToWait, pdTRUE );\r
- traceTASK_NOTIFY_WAIT_BLOCK();\r
-\r
- /* All ports are written to allow a yield in a critical\r
- section (some will yield immediately, others wait until the\r
- critical section exits) - but it is not something that\r
- application code should ever do. */\r
- portYIELD_WITHIN_API();\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- taskEXIT_CRITICAL();\r
-\r
- taskENTER_CRITICAL();\r
- {\r
- traceTASK_NOTIFY_WAIT();\r
-\r
- if( pulNotificationValue != NULL )\r
- {\r
- /* Output the current notification value, which may or may not\r
- have changed. */\r
- *pulNotificationValue = pxCurrentTCB->ulNotifiedValue;\r
- }\r
-\r
- /* If ucNotifyValue is set then either the task never entered the\r
- blocked state (because a notification was already pending) or the\r
- task unblocked because of a notification. Otherwise the task\r
- unblocked because of a timeout. */\r
- if( pxCurrentTCB->ucNotifyState != taskNOTIFICATION_RECEIVED )\r
- {\r
- /* A notification was not received. */\r
- xReturn = pdFALSE;\r
- }\r
- else\r
- {\r
- /* A notification was already pending or a notification was\r
- received while the task was waiting. */\r
- pxCurrentTCB->ulNotifiedValue &= ~ulBitsToClearOnExit;\r
- xReturn = pdTRUE;\r
- }\r
-\r
- pxCurrentTCB->ucNotifyState = taskNOT_WAITING_NOTIFICATION;\r
- }\r
- taskEXIT_CRITICAL();\r
-\r
- return xReturn;\r
- }\r
-\r
-#endif /* configUSE_TASK_NOTIFICATIONS */\r
-/*-----------------------------------------------------------*/\r
-\r
-#if( configUSE_TASK_NOTIFICATIONS == 1 )\r
-\r
- BaseType_t xTaskGenericNotify( TaskHandle_t xTaskToNotify, uint32_t ulValue, eNotifyAction eAction, uint32_t *pulPreviousNotificationValue )\r
- {\r
- TCB_t * pxTCB;\r
- BaseType_t xReturn = pdPASS;\r
- uint8_t ucOriginalNotifyState;\r
-\r
- configASSERT( xTaskToNotify );\r
- pxTCB = ( TCB_t * ) xTaskToNotify;\r
-\r
- taskENTER_CRITICAL();\r
- {\r
- if( pulPreviousNotificationValue != NULL )\r
- {\r
- *pulPreviousNotificationValue = pxTCB->ulNotifiedValue;\r
- }\r
-\r
- ucOriginalNotifyState = pxTCB->ucNotifyState;\r
-\r
- pxTCB->ucNotifyState = taskNOTIFICATION_RECEIVED;\r
-\r
- switch( eAction )\r
- {\r
- case eSetBits :\r
- pxTCB->ulNotifiedValue |= ulValue;\r
- break;\r
-\r
- case eIncrement :\r
- ( pxTCB->ulNotifiedValue )++;\r
- break;\r
-\r
- case eSetValueWithOverwrite :\r
- pxTCB->ulNotifiedValue = ulValue;\r
- break;\r
-\r
- case eSetValueWithoutOverwrite :\r
- if( ucOriginalNotifyState != taskNOTIFICATION_RECEIVED )\r
- {\r
- pxTCB->ulNotifiedValue = ulValue;\r
- }\r
- else\r
- {\r
- /* The value could not be written to the task. */\r
- xReturn = pdFAIL;\r
- }\r
- break;\r
-\r
- case eNoAction:\r
- /* The task is being notified without its notify value being\r
- updated. */\r
- break;\r
- }\r
-\r
- traceTASK_NOTIFY();\r
-\r
- /* If the task is in the blocked state specifically to wait for a\r
- notification then unblock it now. */\r
- if( ucOriginalNotifyState == taskWAITING_NOTIFICATION )\r
- {\r
- ( void ) uxListRemove( &( pxTCB->xStateListItem ) );\r
- prvAddTaskToReadyList( pxTCB );\r
-\r
- /* The task should not have been on an event list. */\r
- configASSERT( listLIST_ITEM_CONTAINER( &( pxTCB->xEventListItem ) ) == NULL );\r
-\r
- #if( configUSE_TICKLESS_IDLE != 0 )\r
- {\r
- /* If a task is blocked waiting for a notification then\r
- xNextTaskUnblockTime might be set to the blocked task's time\r
- out time. If the task is unblocked for a reason other than\r
- a timeout xNextTaskUnblockTime is normally left unchanged,\r
- because it will automatically get reset to a new value when\r
- the tick count equals xNextTaskUnblockTime. However if\r
- tickless idling is used it might be more important to enter\r
- sleep mode at the earliest possible time - so reset\r
- xNextTaskUnblockTime here to ensure it is updated at the\r
- earliest possible time. */\r
- prvResetNextTaskUnblockTime();\r
- }\r
- #endif\r
-\r
- if( pxTCB->uxPriority > pxCurrentTCB->uxPriority )\r
- {\r
- /* The notified task has a priority above the currently\r
- executing task so a yield is required. */\r
- taskYIELD_IF_USING_PREEMPTION();\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- taskEXIT_CRITICAL();\r
-\r
- return xReturn;\r
- }\r
-\r
-#endif /* configUSE_TASK_NOTIFICATIONS */\r
-/*-----------------------------------------------------------*/\r
-\r
-#if( configUSE_TASK_NOTIFICATIONS == 1 )\r
-\r
- BaseType_t xTaskGenericNotifyFromISR( TaskHandle_t xTaskToNotify, uint32_t ulValue, eNotifyAction eAction, uint32_t *pulPreviousNotificationValue, BaseType_t *pxHigherPriorityTaskWoken )\r
- {\r
- TCB_t * pxTCB;\r
- uint8_t ucOriginalNotifyState;\r
- BaseType_t xReturn = pdPASS;\r
- UBaseType_t uxSavedInterruptStatus;\r
-\r
- configASSERT( xTaskToNotify );\r
-\r
- /* RTOS ports that support interrupt nesting have the concept of a\r
- maximum system call (or maximum API call) interrupt priority.\r
- Interrupts that are above the maximum system call priority are keep\r
- permanently enabled, even when the RTOS kernel is in a critical section,\r
- but cannot make any calls to FreeRTOS API functions. If configASSERT()\r
- is defined in FreeRTOSConfig.h then\r
- portASSERT_IF_INTERRUPT_PRIORITY_INVALID() will result in an assertion\r
- failure if a FreeRTOS API function is called from an interrupt that has\r
- been assigned a priority above the configured maximum system call\r
- priority. Only FreeRTOS functions that end in FromISR can be called\r
- from interrupts that have been assigned a priority at or (logically)\r
- below the maximum system call interrupt priority. FreeRTOS maintains a\r
- separate interrupt safe API to ensure interrupt entry is as fast and as\r
- simple as possible. More information (albeit Cortex-M specific) is\r
- provided on the following link:\r
- http://www.freertos.org/RTOS-Cortex-M3-M4.html */\r
- portASSERT_IF_INTERRUPT_PRIORITY_INVALID();\r
-\r
- pxTCB = ( TCB_t * ) xTaskToNotify;\r
-\r
- uxSavedInterruptStatus = portSET_INTERRUPT_MASK_FROM_ISR();\r
- {\r
- if( pulPreviousNotificationValue != NULL )\r
- {\r
- *pulPreviousNotificationValue = pxTCB->ulNotifiedValue;\r
- }\r
-\r
- ucOriginalNotifyState = pxTCB->ucNotifyState;\r
- pxTCB->ucNotifyState = taskNOTIFICATION_RECEIVED;\r
-\r
- switch( eAction )\r
- {\r
- case eSetBits :\r
- pxTCB->ulNotifiedValue |= ulValue;\r
- break;\r
-\r
- case eIncrement :\r
- ( pxTCB->ulNotifiedValue )++;\r
- break;\r
-\r
- case eSetValueWithOverwrite :\r
- pxTCB->ulNotifiedValue = ulValue;\r
- break;\r
-\r
- case eSetValueWithoutOverwrite :\r
- if( ucOriginalNotifyState != taskNOTIFICATION_RECEIVED )\r
- {\r
- pxTCB->ulNotifiedValue = ulValue;\r
- }\r
- else\r
- {\r
- /* The value could not be written to the task. */\r
- xReturn = pdFAIL;\r
- }\r
- break;\r
-\r
- case eNoAction :\r
- /* The task is being notified without its notify value being\r
- updated. */\r
- break;\r
- }\r
-\r
- traceTASK_NOTIFY_FROM_ISR();\r
-\r
- /* If the task is in the blocked state specifically to wait for a\r
- notification then unblock it now. */\r
- if( ucOriginalNotifyState == taskWAITING_NOTIFICATION )\r
- {\r
- /* The task should not have been on an event list. */\r
- configASSERT( listLIST_ITEM_CONTAINER( &( pxTCB->xEventListItem ) ) == NULL );\r
-\r
- if( uxSchedulerSuspended == ( UBaseType_t ) pdFALSE )\r
- {\r
- ( void ) uxListRemove( &( pxTCB->xStateListItem ) );\r
- prvAddTaskToReadyList( pxTCB );\r
- }\r
- else\r
- {\r
- /* The delayed and ready lists cannot be accessed, so hold\r
- this task pending until the scheduler is resumed. */\r
- vListInsertEnd( &( xPendingReadyList ), &( pxTCB->xEventListItem ) );\r
- }\r
-\r
- if( pxTCB->uxPriority > pxCurrentTCB->uxPriority )\r
- {\r
- /* The notified task has a priority above the currently\r
- executing task so a yield is required. */\r
- if( pxHigherPriorityTaskWoken != NULL )\r
- {\r
- *pxHigherPriorityTaskWoken = pdTRUE;\r
- }\r
- else\r
- {\r
- /* Mark that a yield is pending in case the user is not\r
- using the "xHigherPriorityTaskWoken" parameter to an ISR\r
- safe FreeRTOS function. */\r
- xYieldPending = pdTRUE;\r
- }\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- }\r
- portCLEAR_INTERRUPT_MASK_FROM_ISR( uxSavedInterruptStatus );\r
-\r
- return xReturn;\r
- }\r
-\r
-#endif /* configUSE_TASK_NOTIFICATIONS */\r
-/*-----------------------------------------------------------*/\r
-\r
-#if( configUSE_TASK_NOTIFICATIONS == 1 )\r
-\r
- void vTaskNotifyGiveFromISR( TaskHandle_t xTaskToNotify, BaseType_t *pxHigherPriorityTaskWoken )\r
- {\r
- TCB_t * pxTCB;\r
- uint8_t ucOriginalNotifyState;\r
- UBaseType_t uxSavedInterruptStatus;\r
-\r
- configASSERT( xTaskToNotify );\r
-\r
- /* RTOS ports that support interrupt nesting have the concept of a\r
- maximum system call (or maximum API call) interrupt priority.\r
- Interrupts that are above the maximum system call priority are keep\r
- permanently enabled, even when the RTOS kernel is in a critical section,\r
- but cannot make any calls to FreeRTOS API functions. If configASSERT()\r
- is defined in FreeRTOSConfig.h then\r
- portASSERT_IF_INTERRUPT_PRIORITY_INVALID() will result in an assertion\r
- failure if a FreeRTOS API function is called from an interrupt that has\r
- been assigned a priority above the configured maximum system call\r
- priority. Only FreeRTOS functions that end in FromISR can be called\r
- from interrupts that have been assigned a priority at or (logically)\r
- below the maximum system call interrupt priority. FreeRTOS maintains a\r
- separate interrupt safe API to ensure interrupt entry is as fast and as\r
- simple as possible. More information (albeit Cortex-M specific) is\r
- provided on the following link:\r
- http://www.freertos.org/RTOS-Cortex-M3-M4.html */\r
- portASSERT_IF_INTERRUPT_PRIORITY_INVALID();\r
-\r
- pxTCB = ( TCB_t * ) xTaskToNotify;\r
-\r
- uxSavedInterruptStatus = portSET_INTERRUPT_MASK_FROM_ISR();\r
- {\r
- ucOriginalNotifyState = pxTCB->ucNotifyState;\r
- pxTCB->ucNotifyState = taskNOTIFICATION_RECEIVED;\r
-\r
- /* 'Giving' is equivalent to incrementing a count in a counting\r
- semaphore. */\r
- ( pxTCB->ulNotifiedValue )++;\r
-\r
- traceTASK_NOTIFY_GIVE_FROM_ISR();\r
-\r
- /* If the task is in the blocked state specifically to wait for a\r
- notification then unblock it now. */\r
- if( ucOriginalNotifyState == taskWAITING_NOTIFICATION )\r
- {\r
- /* The task should not have been on an event list. */\r
- configASSERT( listLIST_ITEM_CONTAINER( &( pxTCB->xEventListItem ) ) == NULL );\r
-\r
- if( uxSchedulerSuspended == ( UBaseType_t ) pdFALSE )\r
- {\r
- ( void ) uxListRemove( &( pxTCB->xStateListItem ) );\r
- prvAddTaskToReadyList( pxTCB );\r
- }\r
- else\r
- {\r
- /* The delayed and ready lists cannot be accessed, so hold\r
- this task pending until the scheduler is resumed. */\r
- vListInsertEnd( &( xPendingReadyList ), &( pxTCB->xEventListItem ) );\r
- }\r
-\r
- if( pxTCB->uxPriority > pxCurrentTCB->uxPriority )\r
- {\r
- /* The notified task has a priority above the currently\r
- executing task so a yield is required. */\r
- if( pxHigherPriorityTaskWoken != NULL )\r
- {\r
- *pxHigherPriorityTaskWoken = pdTRUE;\r
- }\r
- else\r
- {\r
- /* Mark that a yield is pending in case the user is not\r
- using the "xHigherPriorityTaskWoken" parameter in an ISR\r
- safe FreeRTOS function. */\r
- xYieldPending = pdTRUE;\r
- }\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- }\r
- portCLEAR_INTERRUPT_MASK_FROM_ISR( uxSavedInterruptStatus );\r
- }\r
-\r
-#endif /* configUSE_TASK_NOTIFICATIONS */\r
-\r
-/*-----------------------------------------------------------*/\r
-\r
-#if( configUSE_TASK_NOTIFICATIONS == 1 )\r
-\r
- BaseType_t xTaskNotifyStateClear( TaskHandle_t xTask )\r
- {\r
- TCB_t *pxTCB;\r
- BaseType_t xReturn;\r
-\r
- /* If null is passed in here then it is the calling task that is having\r
- its notification state cleared. */\r
- pxTCB = prvGetTCBFromHandle( xTask );\r
-\r
- taskENTER_CRITICAL();\r
- {\r
- if( pxTCB->ucNotifyState == taskNOTIFICATION_RECEIVED )\r
- {\r
- pxTCB->ucNotifyState = taskNOT_WAITING_NOTIFICATION;\r
- xReturn = pdPASS;\r
- }\r
- else\r
- {\r
- xReturn = pdFAIL;\r
- }\r
- }\r
- taskEXIT_CRITICAL();\r
-\r
- return xReturn;\r
- }\r
-\r
-#endif /* configUSE_TASK_NOTIFICATIONS */\r
-/*-----------------------------------------------------------*/\r
-\r
-\r
-static void prvAddCurrentTaskToDelayedList( TickType_t xTicksToWait, const BaseType_t xCanBlockIndefinitely )\r
-{\r
-TickType_t xTimeToWake;\r
-const TickType_t xConstTickCount = xTickCount;\r
-\r
- #if( INCLUDE_xTaskAbortDelay == 1 )\r
- {\r
- /* About to enter a delayed list, so ensure the ucDelayAborted flag is\r
- reset to pdFALSE so it can be detected as having been set to pdTRUE\r
- when the task leaves the Blocked state. */\r
- pxCurrentTCB->ucDelayAborted = pdFALSE;\r
- }\r
- #endif\r
-\r
- /* Remove the task from the ready list before adding it to the blocked list\r
- as the same list item is used for both lists. */\r
- if( uxListRemove( &( pxCurrentTCB->xStateListItem ) ) == ( UBaseType_t ) 0 )\r
- {\r
- /* The current task must be in a ready list, so there is no need to\r
- check, and the port reset macro can be called directly. */\r
- portRESET_READY_PRIORITY( pxCurrentTCB->uxPriority, uxTopReadyPriority );\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
-\r
- #if ( INCLUDE_vTaskSuspend == 1 )\r
- {\r
- if( ( xTicksToWait == portMAX_DELAY ) && ( xCanBlockIndefinitely != pdFALSE ) )\r
- {\r
- /* Add the task to the suspended task list instead of a delayed task\r
- list to ensure it is not woken by a timing event. It will block\r
- indefinitely. */\r
- vListInsertEnd( &xSuspendedTaskList, &( pxCurrentTCB->xStateListItem ) );\r
- }\r
- else\r
- {\r
- /* Calculate the time at which the task should be woken if the event\r
- does not occur. This may overflow but this doesn't matter, the\r
- kernel will manage it correctly. */\r
- xTimeToWake = xConstTickCount + xTicksToWait;\r
-\r
- /* The list item will be inserted in wake time order. */\r
- listSET_LIST_ITEM_VALUE( &( pxCurrentTCB->xStateListItem ), xTimeToWake );\r
-\r
- if( xTimeToWake < xConstTickCount )\r
- {\r
- /* Wake time has overflowed. Place this item in the overflow\r
- list. */\r
- vListInsert( pxOverflowDelayedTaskList, &( pxCurrentTCB->xStateListItem ) );\r
- }\r
- else\r
- {\r
- /* The wake time has not overflowed, so the current block list\r
- is used. */\r
- vListInsert( pxDelayedTaskList, &( pxCurrentTCB->xStateListItem ) );\r
-\r
- /* If the task entering the blocked state was placed at the\r
- head of the list of blocked tasks then xNextTaskUnblockTime\r
- needs to be updated too. */\r
- if( xTimeToWake < xNextTaskUnblockTime )\r
- {\r
- xNextTaskUnblockTime = xTimeToWake;\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- }\r
- }\r
- #else /* INCLUDE_vTaskSuspend */\r
- {\r
- /* Calculate the time at which the task should be woken if the event\r
- does not occur. This may overflow but this doesn't matter, the kernel\r
- will manage it correctly. */\r
- xTimeToWake = xConstTickCount + xTicksToWait;\r
-\r
- /* The list item will be inserted in wake time order. */\r
- listSET_LIST_ITEM_VALUE( &( pxCurrentTCB->xStateListItem ), xTimeToWake );\r
-\r
- if( xTimeToWake < xConstTickCount )\r
- {\r
- /* Wake time has overflowed. Place this item in the overflow list. */\r
- vListInsert( pxOverflowDelayedTaskList, &( pxCurrentTCB->xStateListItem ) );\r
- }\r
- else\r
- {\r
- /* The wake time has not overflowed, so the current block list is used. */\r
- vListInsert( pxDelayedTaskList, &( pxCurrentTCB->xStateListItem ) );\r
-\r
- /* If the task entering the blocked state was placed at the head of the\r
- list of blocked tasks then xNextTaskUnblockTime needs to be updated\r
- too. */\r
- if( xTimeToWake < xNextTaskUnblockTime )\r
- {\r
- xNextTaskUnblockTime = xTimeToWake;\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
-\r
- /* Avoid compiler warning when INCLUDE_vTaskSuspend is not 1. */\r
- ( void ) xCanBlockIndefinitely;\r
- }\r
- #endif /* INCLUDE_vTaskSuspend */\r
-}\r
-\r
-/* Code below here allows additional code to be inserted into this source file,\r
-especially where access to file scope functions and data is needed (for example\r
-when performing module tests). */\r
-\r
-#ifdef FREERTOS_MODULE_TEST\r
- #include "tasks_test_access_functions.h"\r
-#endif\r
-\r
-\r
-#if( configINCLUDE_FREERTOS_TASK_C_ADDITIONS_H == 1 )\r
-\r
- #include "freertos_tasks_c_additions.h"\r
-\r
- static void freertos_tasks_c_additions_init( void )\r
- {\r
- #ifdef FREERTOS_TASKS_C_ADDITIONS_INIT\r
- FREERTOS_TASKS_C_ADDITIONS_INIT();\r
- #endif\r
- }\r
-\r
-#endif\r
-\r
-\r
+++ /dev/null
-/*\r
- * FreeRTOS Kernel V10.0.1\r
- * Copyright (C) 2017 Amazon.com, Inc. or its affiliates. All Rights Reserved.\r
- *\r
- * Permission is hereby granted, free of charge, to any person obtaining a copy of\r
- * this software and associated documentation files (the "Software"), to deal in\r
- * the Software without restriction, including without limitation the rights to\r
- * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of\r
- * the Software, and to permit persons to whom the Software is furnished to do so,\r
- * subject to the following conditions:\r
- *\r
- * The above copyright notice and this permission notice shall be included in all\r
- * copies or substantial portions of the Software.\r
- *\r
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\r
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS\r
- * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR\r
- * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER\r
- * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN\r
- * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\r
- *\r
- * http://www.FreeRTOS.org\r
- * http://aws.amazon.com/freertos\r
- *\r
- * 1 tab == 4 spaces!\r
- */\r
-\r
-/* Standard includes. */\r
-#include <stdlib.h>\r
-\r
-/* Defining MPU_WRAPPERS_INCLUDED_FROM_API_FILE prevents task.h from redefining\r
-all the API functions to use the MPU wrappers. That should only be done when\r
-task.h is included from an application file. */\r
-#define MPU_WRAPPERS_INCLUDED_FROM_API_FILE\r
-\r
-#include "FreeRTOS.h"\r
-#include "task.h"\r
-#include "queue.h"\r
-#include "timers.h"\r
-\r
-#if ( INCLUDE_xTimerPendFunctionCall == 1 ) && ( configUSE_TIMERS == 0 )\r
- #error configUSE_TIMERS must be set to 1 to make the xTimerPendFunctionCall() function available.\r
-#endif\r
-\r
-/* Lint e961 and e750 are suppressed as a MISRA exception justified because the\r
-MPU ports require MPU_WRAPPERS_INCLUDED_FROM_API_FILE to be defined for the\r
-header files above, but not in this file, in order to generate the correct\r
-privileged Vs unprivileged linkage and placement. */\r
-#undef MPU_WRAPPERS_INCLUDED_FROM_API_FILE /*lint !e961 !e750. */\r
-\r
-\r
-/* This entire source file will be skipped if the application is not configured\r
-to include software timer functionality. This #if is closed at the very bottom\r
-of this file. If you want to include software timer functionality then ensure\r
-configUSE_TIMERS is set to 1 in FreeRTOSConfig.h. */\r
-#if ( configUSE_TIMERS == 1 )\r
-\r
-/* Misc definitions. */\r
-#define tmrNO_DELAY ( TickType_t ) 0U\r
-\r
-/* The name assigned to the timer service task. This can be overridden by\r
-defining trmTIMER_SERVICE_TASK_NAME in FreeRTOSConfig.h. */\r
-#ifndef configTIMER_SERVICE_TASK_NAME\r
- #define configTIMER_SERVICE_TASK_NAME "Tmr Svc"\r
-#endif\r
-\r
-/* The definition of the timers themselves. */\r
-typedef struct tmrTimerControl\r
-{\r
- const char *pcTimerName; /*<< Text name. This is not used by the kernel, it is included simply to make debugging easier. */ /*lint !e971 Unqualified char types are allowed for strings and single characters only. */\r
- ListItem_t xTimerListItem; /*<< Standard linked list item as used by all kernel features for event management. */\r
- TickType_t xTimerPeriodInTicks;/*<< How quickly and often the timer expires. */\r
- UBaseType_t uxAutoReload; /*<< Set to pdTRUE if the timer should be automatically restarted once expired. Set to pdFALSE if the timer is, in effect, a one-shot timer. */\r
- void *pvTimerID; /*<< An ID to identify the timer. This allows the timer to be identified when the same callback is used for multiple timers. */\r
- TimerCallbackFunction_t pxCallbackFunction; /*<< The function that will be called when the timer expires. */\r
- #if( configUSE_TRACE_FACILITY == 1 )\r
- UBaseType_t uxTimerNumber; /*<< An ID assigned by trace tools such as FreeRTOS+Trace */\r
- #endif\r
-\r
- #if( ( configSUPPORT_STATIC_ALLOCATION == 1 ) && ( configSUPPORT_DYNAMIC_ALLOCATION == 1 ) )\r
- uint8_t ucStaticallyAllocated; /*<< Set to pdTRUE if the timer was created statically so no attempt is made to free the memory again if the timer is later deleted. */\r
- #endif\r
-} xTIMER;\r
-\r
-/* The old xTIMER name is maintained above then typedefed to the new Timer_t\r
-name below to enable the use of older kernel aware debuggers. */\r
-typedef xTIMER Timer_t;\r
-\r
-/* The definition of messages that can be sent and received on the timer queue.\r
-Two types of message can be queued - messages that manipulate a software timer,\r
-and messages that request the execution of a non-timer related callback. The\r
-two message types are defined in two separate structures, xTimerParametersType\r
-and xCallbackParametersType respectively. */\r
-typedef struct tmrTimerParameters\r
-{\r
- TickType_t xMessageValue; /*<< An optional value used by a subset of commands, for example, when changing the period of a timer. */\r
- Timer_t * pxTimer; /*<< The timer to which the command will be applied. */\r
-} TimerParameter_t;\r
-\r
-\r
-typedef struct tmrCallbackParameters\r
-{\r
- PendedFunction_t pxCallbackFunction; /* << The callback function to execute. */\r
- void *pvParameter1; /* << The value that will be used as the callback functions first parameter. */\r
- uint32_t ulParameter2; /* << The value that will be used as the callback functions second parameter. */\r
-} CallbackParameters_t;\r
-\r
-/* The structure that contains the two message types, along with an identifier\r
-that is used to determine which message type is valid. */\r
-typedef struct tmrTimerQueueMessage\r
-{\r
- BaseType_t xMessageID; /*<< The command being sent to the timer service task. */\r
- union\r
- {\r
- TimerParameter_t xTimerParameters;\r
-\r
- /* Don't include xCallbackParameters if it is not going to be used as\r
- it makes the structure (and therefore the timer queue) larger. */\r
- #if ( INCLUDE_xTimerPendFunctionCall == 1 )\r
- CallbackParameters_t xCallbackParameters;\r
- #endif /* INCLUDE_xTimerPendFunctionCall */\r
- } u;\r
-} DaemonTaskMessage_t;\r
-\r
-/*lint -save -e956 A manual analysis and inspection has been used to determine\r
-which static variables must be declared volatile. */\r
-\r
-/* The list in which active timers are stored. Timers are referenced in expire\r
-time order, with the nearest expiry time at the front of the list. Only the\r
-timer service task is allowed to access these lists. */\r
-PRIVILEGED_DATA static List_t xActiveTimerList1;\r
-PRIVILEGED_DATA static List_t xActiveTimerList2;\r
-PRIVILEGED_DATA static List_t *pxCurrentTimerList;\r
-PRIVILEGED_DATA static List_t *pxOverflowTimerList;\r
-\r
-/* A queue that is used to send commands to the timer service task. */\r
-PRIVILEGED_DATA static QueueHandle_t xTimerQueue = NULL;\r
-PRIVILEGED_DATA static TaskHandle_t xTimerTaskHandle = NULL;\r
-\r
-/*lint -restore */\r
-\r
-/*-----------------------------------------------------------*/\r
-\r
-#if( configSUPPORT_STATIC_ALLOCATION == 1 )\r
-\r
- /* If static allocation is supported then the application must provide the\r
- following callback function - which enables the application to optionally\r
- provide the memory that will be used by the timer task as the task's stack\r
- and TCB. */\r
- extern void vApplicationGetTimerTaskMemory( StaticTask_t **ppxTimerTaskTCBBuffer, StackType_t **ppxTimerTaskStackBuffer, uint32_t *pulTimerTaskStackSize );\r
-\r
-#endif\r
-\r
-/*\r
- * Initialise the infrastructure used by the timer service task if it has not\r
- * been initialised already.\r
- */\r
-static void prvCheckForValidListAndQueue( void ) PRIVILEGED_FUNCTION;\r
-\r
-/*\r
- * The timer service task (daemon). Timer functionality is controlled by this\r
- * task. Other tasks communicate with the timer service task using the\r
- * xTimerQueue queue.\r
- */\r
-static void prvTimerTask( void *pvParameters ) PRIVILEGED_FUNCTION;\r
-\r
-/*\r
- * Called by the timer service task to interpret and process a command it\r
- * received on the timer queue.\r
- */\r
-static void prvProcessReceivedCommands( void ) PRIVILEGED_FUNCTION;\r
-\r
-/*\r
- * Insert the timer into either xActiveTimerList1, or xActiveTimerList2,\r
- * depending on if the expire time causes a timer counter overflow.\r
- */\r
-static BaseType_t prvInsertTimerInActiveList( Timer_t * const pxTimer, const TickType_t xNextExpiryTime, const TickType_t xTimeNow, const TickType_t xCommandTime ) PRIVILEGED_FUNCTION;\r
-\r
-/*\r
- * An active timer has reached its expire time. Reload the timer if it is an\r
- * auto reload timer, then call its callback.\r
- */\r
-static void prvProcessExpiredTimer( const TickType_t xNextExpireTime, const TickType_t xTimeNow ) PRIVILEGED_FUNCTION;\r
-\r
-/*\r
- * The tick count has overflowed. Switch the timer lists after ensuring the\r
- * current timer list does not still reference some timers.\r
- */\r
-static void prvSwitchTimerLists( void ) PRIVILEGED_FUNCTION;\r
-\r
-/*\r
- * Obtain the current tick count, setting *pxTimerListsWereSwitched to pdTRUE\r
- * if a tick count overflow occurred since prvSampleTimeNow() was last called.\r
- */\r
-static TickType_t prvSampleTimeNow( BaseType_t * const pxTimerListsWereSwitched ) PRIVILEGED_FUNCTION;\r
-\r
-/*\r
- * If the timer list contains any active timers then return the expire time of\r
- * the timer that will expire first and set *pxListWasEmpty to false. If the\r
- * timer list does not contain any timers then return 0 and set *pxListWasEmpty\r
- * to pdTRUE.\r
- */\r
-static TickType_t prvGetNextExpireTime( BaseType_t * const pxListWasEmpty ) PRIVILEGED_FUNCTION;\r
-\r
-/*\r
- * If a timer has expired, process it. Otherwise, block the timer service task\r
- * until either a timer does expire or a command is received.\r
- */\r
-static void prvProcessTimerOrBlockTask( const TickType_t xNextExpireTime, BaseType_t xListWasEmpty ) PRIVILEGED_FUNCTION;\r
-\r
-/*\r
- * Called after a Timer_t structure has been allocated either statically or\r
- * dynamically to fill in the structure's members.\r
- */\r
-static void prvInitialiseNewTimer( const char * const pcTimerName, /*lint !e971 Unqualified char types are allowed for strings and single characters only. */\r
- const TickType_t xTimerPeriodInTicks,\r
- const UBaseType_t uxAutoReload,\r
- void * const pvTimerID,\r
- TimerCallbackFunction_t pxCallbackFunction,\r
- Timer_t *pxNewTimer ) PRIVILEGED_FUNCTION;\r
-/*-----------------------------------------------------------*/\r
-\r
-BaseType_t xTimerCreateTimerTask( void )\r
-{\r
-BaseType_t xReturn = pdFAIL;\r
-\r
- /* This function is called when the scheduler is started if\r
- configUSE_TIMERS is set to 1. Check that the infrastructure used by the\r
- timer service task has been created/initialised. If timers have already\r
- been created then the initialisation will already have been performed. */\r
- prvCheckForValidListAndQueue();\r
-\r
- if( xTimerQueue != NULL )\r
- {\r
- #if( configSUPPORT_STATIC_ALLOCATION == 1 )\r
- {\r
- StaticTask_t *pxTimerTaskTCBBuffer = NULL;\r
- StackType_t *pxTimerTaskStackBuffer = NULL;\r
- uint32_t ulTimerTaskStackSize;\r
-\r
- vApplicationGetTimerTaskMemory( &pxTimerTaskTCBBuffer, &pxTimerTaskStackBuffer, &ulTimerTaskStackSize );\r
- xTimerTaskHandle = xTaskCreateStatic( prvTimerTask,\r
- configTIMER_SERVICE_TASK_NAME,\r
- ulTimerTaskStackSize,\r
- NULL,\r
- ( ( UBaseType_t ) configTIMER_TASK_PRIORITY ) | portPRIVILEGE_BIT,\r
- pxTimerTaskStackBuffer,\r
- pxTimerTaskTCBBuffer );\r
-\r
- if( xTimerTaskHandle != NULL )\r
- {\r
- xReturn = pdPASS;\r
- }\r
- }\r
- #else\r
- {\r
- xReturn = xTaskCreate( prvTimerTask,\r
- configTIMER_SERVICE_TASK_NAME,\r
- configTIMER_TASK_STACK_DEPTH,\r
- NULL,\r
- ( ( UBaseType_t ) configTIMER_TASK_PRIORITY ) | portPRIVILEGE_BIT,\r
- &xTimerTaskHandle );\r
- }\r
- #endif /* configSUPPORT_STATIC_ALLOCATION */\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
-\r
- configASSERT( xReturn );\r
- return xReturn;\r
-}\r
-/*-----------------------------------------------------------*/\r
-\r
-#if( configSUPPORT_DYNAMIC_ALLOCATION == 1 )\r
-\r
- TimerHandle_t xTimerCreate( const char * const pcTimerName, /*lint !e971 Unqualified char types are allowed for strings and single characters only. */\r
- const TickType_t xTimerPeriodInTicks,\r
- const UBaseType_t uxAutoReload,\r
- void * const pvTimerID,\r
- TimerCallbackFunction_t pxCallbackFunction )\r
- {\r
- Timer_t *pxNewTimer;\r
-\r
- pxNewTimer = ( Timer_t * ) pvPortMalloc( sizeof( Timer_t ) );\r
-\r
- if( pxNewTimer != NULL )\r
- {\r
- prvInitialiseNewTimer( pcTimerName, xTimerPeriodInTicks, uxAutoReload, pvTimerID, pxCallbackFunction, pxNewTimer );\r
-\r
- #if( configSUPPORT_STATIC_ALLOCATION == 1 )\r
- {\r
- /* Timers can be created statically or dynamically, so note this\r
- timer was created dynamically in case the timer is later\r
- deleted. */\r
- pxNewTimer->ucStaticallyAllocated = pdFALSE;\r
- }\r
- #endif /* configSUPPORT_STATIC_ALLOCATION */\r
- }\r
-\r
- return pxNewTimer;\r
- }\r
-\r
-#endif /* configSUPPORT_STATIC_ALLOCATION */\r
-/*-----------------------------------------------------------*/\r
-\r
-#if( configSUPPORT_STATIC_ALLOCATION == 1 )\r
-\r
- TimerHandle_t xTimerCreateStatic( const char * const pcTimerName, /*lint !e971 Unqualified char types are allowed for strings and single characters only. */\r
- const TickType_t xTimerPeriodInTicks,\r
- const UBaseType_t uxAutoReload,\r
- void * const pvTimerID,\r
- TimerCallbackFunction_t pxCallbackFunction,\r
- StaticTimer_t *pxTimerBuffer )\r
- {\r
- Timer_t *pxNewTimer;\r
-\r
- #if( configASSERT_DEFINED == 1 )\r
- {\r
- /* Sanity check that the size of the structure used to declare a\r
- variable of type StaticTimer_t equals the size of the real timer\r
- structure. */\r
- volatile size_t xSize = sizeof( StaticTimer_t );\r
- configASSERT( xSize == sizeof( Timer_t ) );\r
- }\r
- #endif /* configASSERT_DEFINED */\r
-\r
- /* A pointer to a StaticTimer_t structure MUST be provided, use it. */\r
- configASSERT( pxTimerBuffer );\r
- pxNewTimer = ( Timer_t * ) pxTimerBuffer; /*lint !e740 Unusual cast is ok as the structures are designed to have the same alignment, and the size is checked by an assert. */\r
-\r
- if( pxNewTimer != NULL )\r
- {\r
- prvInitialiseNewTimer( pcTimerName, xTimerPeriodInTicks, uxAutoReload, pvTimerID, pxCallbackFunction, pxNewTimer );\r
-\r
- #if( configSUPPORT_DYNAMIC_ALLOCATION == 1 )\r
- {\r
- /* Timers can be created statically or dynamically so note this\r
- timer was created statically in case it is later deleted. */\r
- pxNewTimer->ucStaticallyAllocated = pdTRUE;\r
- }\r
- #endif /* configSUPPORT_DYNAMIC_ALLOCATION */\r
- }\r
-\r
- return pxNewTimer;\r
- }\r
-\r
-#endif /* configSUPPORT_STATIC_ALLOCATION */\r
-/*-----------------------------------------------------------*/\r
-\r
-static void prvInitialiseNewTimer( const char * const pcTimerName, /*lint !e971 Unqualified char types are allowed for strings and single characters only. */\r
- const TickType_t xTimerPeriodInTicks,\r
- const UBaseType_t uxAutoReload,\r
- void * const pvTimerID,\r
- TimerCallbackFunction_t pxCallbackFunction,\r
- Timer_t *pxNewTimer )\r
-{\r
- /* 0 is not a valid value for xTimerPeriodInTicks. */\r
- configASSERT( ( xTimerPeriodInTicks > 0 ) );\r
-\r
- if( pxNewTimer != NULL )\r
- {\r
- /* Ensure the infrastructure used by the timer service task has been\r
- created/initialised. */\r
- prvCheckForValidListAndQueue();\r
-\r
- /* Initialise the timer structure members using the function\r
- parameters. */\r
- pxNewTimer->pcTimerName = pcTimerName;\r
- pxNewTimer->xTimerPeriodInTicks = xTimerPeriodInTicks;\r
- pxNewTimer->uxAutoReload = uxAutoReload;\r
- pxNewTimer->pvTimerID = pvTimerID;\r
- pxNewTimer->pxCallbackFunction = pxCallbackFunction;\r
- vListInitialiseItem( &( pxNewTimer->xTimerListItem ) );\r
- traceTIMER_CREATE( pxNewTimer );\r
- }\r
-}\r
-/*-----------------------------------------------------------*/\r
-\r
-BaseType_t xTimerGenericCommand( TimerHandle_t xTimer, const BaseType_t xCommandID, const TickType_t xOptionalValue, BaseType_t * const pxHigherPriorityTaskWoken, const TickType_t xTicksToWait )\r
-{\r
-BaseType_t xReturn = pdFAIL;\r
-DaemonTaskMessage_t xMessage;\r
-\r
- configASSERT( xTimer );\r
-\r
- /* Send a message to the timer service task to perform a particular action\r
- on a particular timer definition. */\r
- if( xTimerQueue != NULL )\r
- {\r
- /* Send a command to the timer service task to start the xTimer timer. */\r
- xMessage.xMessageID = xCommandID;\r
- xMessage.u.xTimerParameters.xMessageValue = xOptionalValue;\r
- xMessage.u.xTimerParameters.pxTimer = ( Timer_t * ) xTimer;\r
-\r
- if( xCommandID < tmrFIRST_FROM_ISR_COMMAND )\r
- {\r
- if( xTaskGetSchedulerState() == taskSCHEDULER_RUNNING )\r
- {\r
- xReturn = xQueueSendToBack( xTimerQueue, &xMessage, xTicksToWait );\r
- }\r
- else\r
- {\r
- xReturn = xQueueSendToBack( xTimerQueue, &xMessage, tmrNO_DELAY );\r
- }\r
- }\r
- else\r
- {\r
- xReturn = xQueueSendToBackFromISR( xTimerQueue, &xMessage, pxHigherPriorityTaskWoken );\r
- }\r
-\r
- traceTIMER_COMMAND_SEND( xTimer, xCommandID, xOptionalValue, xReturn );\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
-\r
- return xReturn;\r
-}\r
-/*-----------------------------------------------------------*/\r
-\r
-TaskHandle_t xTimerGetTimerDaemonTaskHandle( void )\r
-{\r
- /* If xTimerGetTimerDaemonTaskHandle() is called before the scheduler has been\r
- started, then xTimerTaskHandle will be NULL. */\r
- configASSERT( ( xTimerTaskHandle != NULL ) );\r
- return xTimerTaskHandle;\r
-}\r
-/*-----------------------------------------------------------*/\r
-\r
-TickType_t xTimerGetPeriod( TimerHandle_t xTimer )\r
-{\r
-Timer_t *pxTimer = ( Timer_t * ) xTimer;\r
-\r
- configASSERT( xTimer );\r
- return pxTimer->xTimerPeriodInTicks;\r
-}\r
-/*-----------------------------------------------------------*/\r
-\r
-TickType_t xTimerGetExpiryTime( TimerHandle_t xTimer )\r
-{\r
-Timer_t * pxTimer = ( Timer_t * ) xTimer;\r
-TickType_t xReturn;\r
-\r
- configASSERT( xTimer );\r
- xReturn = listGET_LIST_ITEM_VALUE( &( pxTimer->xTimerListItem ) );\r
- return xReturn;\r
-}\r
-/*-----------------------------------------------------------*/\r
-\r
-const char * pcTimerGetName( TimerHandle_t xTimer ) /*lint !e971 Unqualified char types are allowed for strings and single characters only. */\r
-{\r
-Timer_t *pxTimer = ( Timer_t * ) xTimer;\r
-\r
- configASSERT( xTimer );\r
- return pxTimer->pcTimerName;\r
-}\r
-/*-----------------------------------------------------------*/\r
-\r
-static void prvProcessExpiredTimer( const TickType_t xNextExpireTime, const TickType_t xTimeNow )\r
-{\r
-BaseType_t xResult;\r
-Timer_t * const pxTimer = ( Timer_t * ) listGET_OWNER_OF_HEAD_ENTRY( pxCurrentTimerList );\r
-\r
- /* Remove the timer from the list of active timers. A check has already\r
- been performed to ensure the list is not empty. */\r
- ( void ) uxListRemove( &( pxTimer->xTimerListItem ) );\r
- traceTIMER_EXPIRED( pxTimer );\r
-\r
- /* If the timer is an auto reload timer then calculate the next\r
- expiry time and re-insert the timer in the list of active timers. */\r
- if( pxTimer->uxAutoReload == ( UBaseType_t ) pdTRUE )\r
- {\r
- /* The timer is inserted into a list using a time relative to anything\r
- other than the current time. It will therefore be inserted into the\r
- correct list relative to the time this task thinks it is now. */\r
- if( prvInsertTimerInActiveList( pxTimer, ( xNextExpireTime + pxTimer->xTimerPeriodInTicks ), xTimeNow, xNextExpireTime ) != pdFALSE )\r
- {\r
- /* The timer expired before it was added to the active timer\r
- list. Reload it now. */\r
- xResult = xTimerGenericCommand( pxTimer, tmrCOMMAND_START_DONT_TRACE, xNextExpireTime, NULL, tmrNO_DELAY );\r
- configASSERT( xResult );\r
- ( void ) xResult;\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
-\r
- /* Call the timer callback. */\r
- pxTimer->pxCallbackFunction( ( TimerHandle_t ) pxTimer );\r
-}\r
-/*-----------------------------------------------------------*/\r
-\r
-static void prvTimerTask( void *pvParameters )\r
-{\r
-TickType_t xNextExpireTime;\r
-BaseType_t xListWasEmpty;\r
-\r
- /* Just to avoid compiler warnings. */\r
- ( void ) pvParameters;\r
-\r
- #if( configUSE_DAEMON_TASK_STARTUP_HOOK == 1 )\r
- {\r
- extern void vApplicationDaemonTaskStartupHook( void );\r
-\r
- /* Allow the application writer to execute some code in the context of\r
- this task at the point the task starts executing. This is useful if the\r
- application includes initialisation code that would benefit from\r
- executing after the scheduler has been started. */\r
- vApplicationDaemonTaskStartupHook();\r
- }\r
- #endif /* configUSE_DAEMON_TASK_STARTUP_HOOK */\r
-\r
- for( ;; )\r
- {\r
- /* Query the timers list to see if it contains any timers, and if so,\r
- obtain the time at which the next timer will expire. */\r
- xNextExpireTime = prvGetNextExpireTime( &xListWasEmpty );\r
-\r
- /* If a timer has expired, process it. Otherwise, block this task\r
- until either a timer does expire, or a command is received. */\r
- prvProcessTimerOrBlockTask( xNextExpireTime, xListWasEmpty );\r
-\r
- /* Empty the command queue. */\r
- prvProcessReceivedCommands();\r
- }\r
-}\r
-/*-----------------------------------------------------------*/\r
-\r
-static void prvProcessTimerOrBlockTask( const TickType_t xNextExpireTime, BaseType_t xListWasEmpty )\r
-{\r
-TickType_t xTimeNow;\r
-BaseType_t xTimerListsWereSwitched;\r
-\r
- vTaskSuspendAll();\r
- {\r
- /* Obtain the time now to make an assessment as to whether the timer\r
- has expired or not. If obtaining the time causes the lists to switch\r
- then don't process this timer as any timers that remained in the list\r
- when the lists were switched will have been processed within the\r
- prvSampleTimeNow() function. */\r
- xTimeNow = prvSampleTimeNow( &xTimerListsWereSwitched );\r
- if( xTimerListsWereSwitched == pdFALSE )\r
- {\r
- /* The tick count has not overflowed, has the timer expired? */\r
- if( ( xListWasEmpty == pdFALSE ) && ( xNextExpireTime <= xTimeNow ) )\r
- {\r
- ( void ) xTaskResumeAll();\r
- prvProcessExpiredTimer( xNextExpireTime, xTimeNow );\r
- }\r
- else\r
- {\r
- /* The tick count has not overflowed, and the next expire\r
- time has not been reached yet. This task should therefore\r
- block to wait for the next expire time or a command to be\r
- received - whichever comes first. The following line cannot\r
- be reached unless xNextExpireTime > xTimeNow, except in the\r
- case when the current timer list is empty. */\r
- if( xListWasEmpty != pdFALSE )\r
- {\r
- /* The current timer list is empty - is the overflow list\r
- also empty? */\r
- xListWasEmpty = listLIST_IS_EMPTY( pxOverflowTimerList );\r
- }\r
-\r
- vQueueWaitForMessageRestricted( xTimerQueue, ( xNextExpireTime - xTimeNow ), xListWasEmpty );\r
-\r
- if( xTaskResumeAll() == pdFALSE )\r
- {\r
- /* Yield to wait for either a command to arrive, or the\r
- block time to expire. If a command arrived between the\r
- critical section being exited and this yield then the yield\r
- will not cause the task to block. */\r
- portYIELD_WITHIN_API();\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- }\r
- else\r
- {\r
- ( void ) xTaskResumeAll();\r
- }\r
- }\r
-}\r
-/*-----------------------------------------------------------*/\r
-\r
-static TickType_t prvGetNextExpireTime( BaseType_t * const pxListWasEmpty )\r
-{\r
-TickType_t xNextExpireTime;\r
-\r
- /* Timers are listed in expiry time order, with the head of the list\r
- referencing the task that will expire first. Obtain the time at which\r
- the timer with the nearest expiry time will expire. If there are no\r
- active timers then just set the next expire time to 0. That will cause\r
- this task to unblock when the tick count overflows, at which point the\r
- timer lists will be switched and the next expiry time can be\r
- re-assessed. */\r
- *pxListWasEmpty = listLIST_IS_EMPTY( pxCurrentTimerList );\r
- if( *pxListWasEmpty == pdFALSE )\r
- {\r
- xNextExpireTime = listGET_ITEM_VALUE_OF_HEAD_ENTRY( pxCurrentTimerList );\r
- }\r
- else\r
- {\r
- /* Ensure the task unblocks when the tick count rolls over. */\r
- xNextExpireTime = ( TickType_t ) 0U;\r
- }\r
-\r
- return xNextExpireTime;\r
-}\r
-/*-----------------------------------------------------------*/\r
-\r
-static TickType_t prvSampleTimeNow( BaseType_t * const pxTimerListsWereSwitched )\r
-{\r
-TickType_t xTimeNow;\r
-PRIVILEGED_DATA static TickType_t xLastTime = ( TickType_t ) 0U; /*lint !e956 Variable is only accessible to one task. */\r
-\r
- xTimeNow = xTaskGetTickCount();\r
-\r
- if( xTimeNow < xLastTime )\r
- {\r
- prvSwitchTimerLists();\r
- *pxTimerListsWereSwitched = pdTRUE;\r
- }\r
- else\r
- {\r
- *pxTimerListsWereSwitched = pdFALSE;\r
- }\r
-\r
- xLastTime = xTimeNow;\r
-\r
- return xTimeNow;\r
-}\r
-/*-----------------------------------------------------------*/\r
-\r
-static BaseType_t prvInsertTimerInActiveList( Timer_t * const pxTimer, const TickType_t xNextExpiryTime, const TickType_t xTimeNow, const TickType_t xCommandTime )\r
-{\r
-BaseType_t xProcessTimerNow = pdFALSE;\r
-\r
- listSET_LIST_ITEM_VALUE( &( pxTimer->xTimerListItem ), xNextExpiryTime );\r
- listSET_LIST_ITEM_OWNER( &( pxTimer->xTimerListItem ), pxTimer );\r
-\r
- if( xNextExpiryTime <= xTimeNow )\r
- {\r
- /* Has the expiry time elapsed between the command to start/reset a\r
- timer was issued, and the time the command was processed? */\r
- if( ( ( TickType_t ) ( xTimeNow - xCommandTime ) ) >= pxTimer->xTimerPeriodInTicks ) /*lint !e961 MISRA exception as the casts are only redundant for some ports. */\r
- {\r
- /* The time between a command being issued and the command being\r
- processed actually exceeds the timers period. */\r
- xProcessTimerNow = pdTRUE;\r
- }\r
- else\r
- {\r
- vListInsert( pxOverflowTimerList, &( pxTimer->xTimerListItem ) );\r
- }\r
- }\r
- else\r
- {\r
- if( ( xTimeNow < xCommandTime ) && ( xNextExpiryTime >= xCommandTime ) )\r
- {\r
- /* If, since the command was issued, the tick count has overflowed\r
- but the expiry time has not, then the timer must have already passed\r
- its expiry time and should be processed immediately. */\r
- xProcessTimerNow = pdTRUE;\r
- }\r
- else\r
- {\r
- vListInsert( pxCurrentTimerList, &( pxTimer->xTimerListItem ) );\r
- }\r
- }\r
-\r
- return xProcessTimerNow;\r
-}\r
-/*-----------------------------------------------------------*/\r
-\r
-static void prvProcessReceivedCommands( void )\r
-{\r
-DaemonTaskMessage_t xMessage;\r
-Timer_t *pxTimer;\r
-BaseType_t xTimerListsWereSwitched, xResult;\r
-TickType_t xTimeNow;\r
-\r
- while( xQueueReceive( xTimerQueue, &xMessage, tmrNO_DELAY ) != pdFAIL ) /*lint !e603 xMessage does not have to be initialised as it is passed out, not in, and it is not used unless xQueueReceive() returns pdTRUE. */\r
- {\r
- #if ( INCLUDE_xTimerPendFunctionCall == 1 )\r
- {\r
- /* Negative commands are pended function calls rather than timer\r
- commands. */\r
- if( xMessage.xMessageID < ( BaseType_t ) 0 )\r
- {\r
- const CallbackParameters_t * const pxCallback = &( xMessage.u.xCallbackParameters );\r
-\r
- /* The timer uses the xCallbackParameters member to request a\r
- callback be executed. Check the callback is not NULL. */\r
- configASSERT( pxCallback );\r
-\r
- /* Call the function. */\r
- pxCallback->pxCallbackFunction( pxCallback->pvParameter1, pxCallback->ulParameter2 );\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- #endif /* INCLUDE_xTimerPendFunctionCall */\r
-\r
- /* Commands that are positive are timer commands rather than pended\r
- function calls. */\r
- if( xMessage.xMessageID >= ( BaseType_t ) 0 )\r
- {\r
- /* The messages uses the xTimerParameters member to work on a\r
- software timer. */\r
- pxTimer = xMessage.u.xTimerParameters.pxTimer;\r
-\r
- if( listIS_CONTAINED_WITHIN( NULL, &( pxTimer->xTimerListItem ) ) == pdFALSE ) /*lint !e961. The cast is only redundant when NULL is passed into the macro. */\r
- {\r
- /* The timer is in a list, remove it. */\r
- ( void ) uxListRemove( &( pxTimer->xTimerListItem ) );\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
-\r
- traceTIMER_COMMAND_RECEIVED( pxTimer, xMessage.xMessageID, xMessage.u.xTimerParameters.xMessageValue );\r
-\r
- /* In this case the xTimerListsWereSwitched parameter is not used, but\r
- it must be present in the function call. prvSampleTimeNow() must be\r
- called after the message is received from xTimerQueue so there is no\r
- possibility of a higher priority task adding a message to the message\r
- queue with a time that is ahead of the timer daemon task (because it\r
- pre-empted the timer daemon task after the xTimeNow value was set). */\r
- xTimeNow = prvSampleTimeNow( &xTimerListsWereSwitched );\r
-\r
- switch( xMessage.xMessageID )\r
- {\r
- case tmrCOMMAND_START :\r
- case tmrCOMMAND_START_FROM_ISR :\r
- case tmrCOMMAND_RESET :\r
- case tmrCOMMAND_RESET_FROM_ISR :\r
- case tmrCOMMAND_START_DONT_TRACE :\r
- /* Start or restart a timer. */\r
- if( prvInsertTimerInActiveList( pxTimer, xMessage.u.xTimerParameters.xMessageValue + pxTimer->xTimerPeriodInTicks, xTimeNow, xMessage.u.xTimerParameters.xMessageValue ) != pdFALSE )\r
- {\r
- /* The timer expired before it was added to the active\r
- timer list. Process it now. */\r
- pxTimer->pxCallbackFunction( ( TimerHandle_t ) pxTimer );\r
- traceTIMER_EXPIRED( pxTimer );\r
-\r
- if( pxTimer->uxAutoReload == ( UBaseType_t ) pdTRUE )\r
- {\r
- xResult = xTimerGenericCommand( pxTimer, tmrCOMMAND_START_DONT_TRACE, xMessage.u.xTimerParameters.xMessageValue + pxTimer->xTimerPeriodInTicks, NULL, tmrNO_DELAY );\r
- configASSERT( xResult );\r
- ( void ) xResult;\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- break;\r
-\r
- case tmrCOMMAND_STOP :\r
- case tmrCOMMAND_STOP_FROM_ISR :\r
- /* The timer has already been removed from the active list.\r
- There is nothing to do here. */\r
- break;\r
-\r
- case tmrCOMMAND_CHANGE_PERIOD :\r
- case tmrCOMMAND_CHANGE_PERIOD_FROM_ISR :\r
- pxTimer->xTimerPeriodInTicks = xMessage.u.xTimerParameters.xMessageValue;\r
- configASSERT( ( pxTimer->xTimerPeriodInTicks > 0 ) );\r
-\r
- /* The new period does not really have a reference, and can\r
- be longer or shorter than the old one. The command time is\r
- therefore set to the current time, and as the period cannot\r
- be zero the next expiry time can only be in the future,\r
- meaning (unlike for the xTimerStart() case above) there is\r
- no fail case that needs to be handled here. */\r
- ( void ) prvInsertTimerInActiveList( pxTimer, ( xTimeNow + pxTimer->xTimerPeriodInTicks ), xTimeNow, xTimeNow );\r
- break;\r
-\r
- case tmrCOMMAND_DELETE :\r
- /* The timer has already been removed from the active list,\r
- just free up the memory if the memory was dynamically\r
- allocated. */\r
- #if( ( configSUPPORT_DYNAMIC_ALLOCATION == 1 ) && ( configSUPPORT_STATIC_ALLOCATION == 0 ) )\r
- {\r
- /* The timer can only have been allocated dynamically -\r
- free it again. */\r
- vPortFree( pxTimer );\r
- }\r
- #elif( ( configSUPPORT_DYNAMIC_ALLOCATION == 1 ) && ( configSUPPORT_STATIC_ALLOCATION == 1 ) )\r
- {\r
- /* The timer could have been allocated statically or\r
- dynamically, so check before attempting to free the\r
- memory. */\r
- if( pxTimer->ucStaticallyAllocated == ( uint8_t ) pdFALSE )\r
- {\r
- vPortFree( pxTimer );\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- #endif /* configSUPPORT_DYNAMIC_ALLOCATION */\r
- break;\r
-\r
- default :\r
- /* Don't expect to get here. */\r
- break;\r
- }\r
- }\r
- }\r
-}\r
-/*-----------------------------------------------------------*/\r
-\r
-static void prvSwitchTimerLists( void )\r
-{\r
-TickType_t xNextExpireTime, xReloadTime;\r
-List_t *pxTemp;\r
-Timer_t *pxTimer;\r
-BaseType_t xResult;\r
-\r
- /* The tick count has overflowed. The timer lists must be switched.\r
- If there are any timers still referenced from the current timer list\r
- then they must have expired and should be processed before the lists\r
- are switched. */\r
- while( listLIST_IS_EMPTY( pxCurrentTimerList ) == pdFALSE )\r
- {\r
- xNextExpireTime = listGET_ITEM_VALUE_OF_HEAD_ENTRY( pxCurrentTimerList );\r
-\r
- /* Remove the timer from the list. */\r
- pxTimer = ( Timer_t * ) listGET_OWNER_OF_HEAD_ENTRY( pxCurrentTimerList );\r
- ( void ) uxListRemove( &( pxTimer->xTimerListItem ) );\r
- traceTIMER_EXPIRED( pxTimer );\r
-\r
- /* Execute its callback, then send a command to restart the timer if\r
- it is an auto-reload timer. It cannot be restarted here as the lists\r
- have not yet been switched. */\r
- pxTimer->pxCallbackFunction( ( TimerHandle_t ) pxTimer );\r
-\r
- if( pxTimer->uxAutoReload == ( UBaseType_t ) pdTRUE )\r
- {\r
- /* Calculate the reload value, and if the reload value results in\r
- the timer going into the same timer list then it has already expired\r
- and the timer should be re-inserted into the current list so it is\r
- processed again within this loop. Otherwise a command should be sent\r
- to restart the timer to ensure it is only inserted into a list after\r
- the lists have been swapped. */\r
- xReloadTime = ( xNextExpireTime + pxTimer->xTimerPeriodInTicks );\r
- if( xReloadTime > xNextExpireTime )\r
- {\r
- listSET_LIST_ITEM_VALUE( &( pxTimer->xTimerListItem ), xReloadTime );\r
- listSET_LIST_ITEM_OWNER( &( pxTimer->xTimerListItem ), pxTimer );\r
- vListInsert( pxCurrentTimerList, &( pxTimer->xTimerListItem ) );\r
- }\r
- else\r
- {\r
- xResult = xTimerGenericCommand( pxTimer, tmrCOMMAND_START_DONT_TRACE, xNextExpireTime, NULL, tmrNO_DELAY );\r
- configASSERT( xResult );\r
- ( void ) xResult;\r
- }\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
-\r
- pxTemp = pxCurrentTimerList;\r
- pxCurrentTimerList = pxOverflowTimerList;\r
- pxOverflowTimerList = pxTemp;\r
-}\r
-/*-----------------------------------------------------------*/\r
-\r
-static void prvCheckForValidListAndQueue( void )\r
-{\r
- /* Check that the list from which active timers are referenced, and the\r
- queue used to communicate with the timer service, have been\r
- initialised. */\r
- taskENTER_CRITICAL();\r
- {\r
- if( xTimerQueue == NULL )\r
- {\r
- vListInitialise( &xActiveTimerList1 );\r
- vListInitialise( &xActiveTimerList2 );\r
- pxCurrentTimerList = &xActiveTimerList1;\r
- pxOverflowTimerList = &xActiveTimerList2;\r
-\r
- #if( configSUPPORT_STATIC_ALLOCATION == 1 )\r
- {\r
- /* The timer queue is allocated statically in case\r
- configSUPPORT_DYNAMIC_ALLOCATION is 0. */\r
- static StaticQueue_t xStaticTimerQueue; /*lint !e956 Ok to declare in this manner to prevent additional conditional compilation guards in other locations. */\r
- static uint8_t ucStaticTimerQueueStorage[ ( size_t ) configTIMER_QUEUE_LENGTH * sizeof( DaemonTaskMessage_t ) ]; /*lint !e956 Ok to declare in this manner to prevent additional conditional compilation guards in other locations. */\r
-\r
- xTimerQueue = xQueueCreateStatic( ( UBaseType_t ) configTIMER_QUEUE_LENGTH, ( UBaseType_t ) sizeof( DaemonTaskMessage_t ), &( ucStaticTimerQueueStorage[ 0 ] ), &xStaticTimerQueue );\r
- }\r
- #else\r
- {\r
- xTimerQueue = xQueueCreate( ( UBaseType_t ) configTIMER_QUEUE_LENGTH, sizeof( DaemonTaskMessage_t ) );\r
- }\r
- #endif\r
-\r
- #if ( configQUEUE_REGISTRY_SIZE > 0 )\r
- {\r
- if( xTimerQueue != NULL )\r
- {\r
- vQueueAddToRegistry( xTimerQueue, "TmrQ" );\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- #endif /* configQUEUE_REGISTRY_SIZE */\r
- }\r
- else\r
- {\r
- mtCOVERAGE_TEST_MARKER();\r
- }\r
- }\r
- taskEXIT_CRITICAL();\r
-}\r
-/*-----------------------------------------------------------*/\r
-\r
-BaseType_t xTimerIsTimerActive( TimerHandle_t xTimer )\r
-{\r
-BaseType_t xTimerIsInActiveList;\r
-Timer_t *pxTimer = ( Timer_t * ) xTimer;\r
-\r
- configASSERT( xTimer );\r
-\r
- /* Is the timer in the list of active timers? */\r
- taskENTER_CRITICAL();\r
- {\r
- /* Checking to see if it is in the NULL list in effect checks to see if\r
- it is referenced from either the current or the overflow timer lists in\r
- one go, but the logic has to be reversed, hence the '!'. */\r
- xTimerIsInActiveList = ( BaseType_t ) !( listIS_CONTAINED_WITHIN( NULL, &( pxTimer->xTimerListItem ) ) ); /*lint !e961. Cast is only redundant when NULL is passed into the macro. */\r
- }\r
- taskEXIT_CRITICAL();\r
-\r
- return xTimerIsInActiveList;\r
-} /*lint !e818 Can't be pointer to const due to the typedef. */\r
-/*-----------------------------------------------------------*/\r
-\r
-void *pvTimerGetTimerID( const TimerHandle_t xTimer )\r
-{\r
-Timer_t * const pxTimer = ( Timer_t * ) xTimer;\r
-void *pvReturn;\r
-\r
- configASSERT( xTimer );\r
-\r
- taskENTER_CRITICAL();\r
- {\r
- pvReturn = pxTimer->pvTimerID;\r
- }\r
- taskEXIT_CRITICAL();\r
-\r
- return pvReturn;\r
-}\r
-/*-----------------------------------------------------------*/\r
-\r
-void vTimerSetTimerID( TimerHandle_t xTimer, void *pvNewID )\r
-{\r
-Timer_t * const pxTimer = ( Timer_t * ) xTimer;\r
-\r
- configASSERT( xTimer );\r
-\r
- taskENTER_CRITICAL();\r
- {\r
- pxTimer->pvTimerID = pvNewID;\r
- }\r
- taskEXIT_CRITICAL();\r
-}\r
-/*-----------------------------------------------------------*/\r
-\r
-#if( INCLUDE_xTimerPendFunctionCall == 1 )\r
-\r
- BaseType_t xTimerPendFunctionCallFromISR( PendedFunction_t xFunctionToPend, void *pvParameter1, uint32_t ulParameter2, BaseType_t *pxHigherPriorityTaskWoken )\r
- {\r
- DaemonTaskMessage_t xMessage;\r
- BaseType_t xReturn;\r
-\r
- /* Complete the message with the function parameters and post it to the\r
- daemon task. */\r
- xMessage.xMessageID = tmrCOMMAND_EXECUTE_CALLBACK_FROM_ISR;\r
- xMessage.u.xCallbackParameters.pxCallbackFunction = xFunctionToPend;\r
- xMessage.u.xCallbackParameters.pvParameter1 = pvParameter1;\r
- xMessage.u.xCallbackParameters.ulParameter2 = ulParameter2;\r
-\r
- xReturn = xQueueSendFromISR( xTimerQueue, &xMessage, pxHigherPriorityTaskWoken );\r
-\r
- tracePEND_FUNC_CALL_FROM_ISR( xFunctionToPend, pvParameter1, ulParameter2, xReturn );\r
-\r
- return xReturn;\r
- }\r
-\r
-#endif /* INCLUDE_xTimerPendFunctionCall */\r
-/*-----------------------------------------------------------*/\r
-\r
-#if( INCLUDE_xTimerPendFunctionCall == 1 )\r
-\r
- BaseType_t xTimerPendFunctionCall( PendedFunction_t xFunctionToPend, void *pvParameter1, uint32_t ulParameter2, TickType_t xTicksToWait )\r
- {\r
- DaemonTaskMessage_t xMessage;\r
- BaseType_t xReturn;\r
-\r
- /* This function can only be called after a timer has been created or\r
- after the scheduler has been started because, until then, the timer\r
- queue does not exist. */\r
- configASSERT( xTimerQueue );\r
-\r
- /* Complete the message with the function parameters and post it to the\r
- daemon task. */\r
- xMessage.xMessageID = tmrCOMMAND_EXECUTE_CALLBACK;\r
- xMessage.u.xCallbackParameters.pxCallbackFunction = xFunctionToPend;\r
- xMessage.u.xCallbackParameters.pvParameter1 = pvParameter1;\r
- xMessage.u.xCallbackParameters.ulParameter2 = ulParameter2;\r
-\r
- xReturn = xQueueSendToBack( xTimerQueue, &xMessage, xTicksToWait );\r
-\r
- tracePEND_FUNC_CALL( xFunctionToPend, pvParameter1, ulParameter2, xReturn );\r
-\r
- return xReturn;\r
- }\r
-\r
-#endif /* INCLUDE_xTimerPendFunctionCall */\r
-/*-----------------------------------------------------------*/\r
-\r
-#if ( configUSE_TRACE_FACILITY == 1 )\r
-\r
- UBaseType_t uxTimerGetTimerNumber( TimerHandle_t xTimer )\r
- {\r
- return ( ( Timer_t * ) xTimer )->uxTimerNumber;\r
- }\r
-\r
-#endif /* configUSE_TRACE_FACILITY */\r
-/*-----------------------------------------------------------*/\r
-\r
-#if ( configUSE_TRACE_FACILITY == 1 )\r
-\r
- void vTimerSetTimerNumber( TimerHandle_t xTimer, UBaseType_t uxTimerNumber )\r
- {\r
- ( ( Timer_t * ) xTimer )->uxTimerNumber = uxTimerNumber;\r
- }\r
-\r
-#endif /* configUSE_TRACE_FACILITY */\r
-/*-----------------------------------------------------------*/\r
-\r
-/* This entire source file will be skipped if the application is not configured\r
-to include software timer functionality. If you want to include software timer\r
-functionality then ensure configUSE_TIMERS is set to 1 in FreeRTOSConfig.h. */\r
-#endif /* configUSE_TIMERS == 1 */\r
-\r
-\r
-\r
+++ /dev/null
-/*
- * ------------------------------------------------------------------------
- * File Name: main.c
- * Author: Zhao Yanbai
- * 2018-07-07 15:09:03 Saturday CST
- * Description: none
- * ------------------------------------------------------------------------
- */
-#include<stdio.h>
-
-int main(int argc, char *argv[]){
-
- return 0;
-}
\ No newline at end of file
+++ /dev/null
-menu "Example Configuration"
-
-config EXAMPLE_CONF_VAL
- int "example configuration value"
- range 0 34
- default 3
- help
- example configuration value
-
-endmenu
+++ /dev/null
-# Functionality common to both top-level project makefile (project.mk)
-# and component makefiles (component_wrapper.mk)
-#
-
-# Include project config makefile, if it exists.
-#
-# (Note that we only rebuild this makefile automatically for some
-# targets, see project_config.mk for details.)
-SDKCONFIG_MAKEFILE ?= $(abspath $(BUILD_DIR_BASE)/include/config/auto.conf)
--include $(SDKCONFIG_MAKEFILE)
-export SDKCONFIG_MAKEFILE # sub-makes (like bootloader) will reuse this path
-
-# BATCH_BUILD flag disables interactive terminal features, defaults to verbose build
-ifdef BATCH_BUILD
-V ?= 1
-endif
-
-#Handling of V=1/VERBOSE=1 flag
-#
-# if V=1, $(summary) does nothing and $(details) will echo extra details
-# if V is unset or not 1, $(summary) echoes a summary and $(details) does nothing
-VERBOSE ?=
-V ?= $(VERBOSE)
-ifeq ("$(V)","1")
-summary := @true
-details := @echo
-else
-summary := @echo
-details := @true
-
-# disable echoing of commands, directory names
-MAKEFLAGS += --silent
-endif # $(V)==1
-
-ifdef CONFIG_MAKE_WARN_UNDEFINED_VARIABLES
-MAKEFLAGS += --warn-undefined-variables
-endif
-
-# General make utilities
-
-# convenience variable for printing an 80 asterisk wide separator line
-SEPARATOR:="*******************************************************************************"
-
-# macro to remove quotes from an argument, ie $(call dequote,$(CONFIG_BLAH))
-define dequote
-$(subst ",,$(1))
-endef
-# " comment kept here to keep syntax highlighting happy
-
-
-# macro to keep an absolute path as-is, but resolve a relative path
-# against a particular parent directory
-#
-# $(1) path to resolve
-# $(2) directory to resolve non-absolute path against
-#
-# Path and directory don't have to exist (definition of a "relative
-# path" is one that doesn't start with /)
-#
-# $(2) can contain a trailing forward slash or not, result will not
-# double any path slashes.
-#
-# example $(call resolvepath,$(CONFIG_PATH),$(CONFIG_DIR))
-define resolvepath
-$(abspath $(foreach dir,$(1),$(if $(filter /%,$(dir)),$(dir),$(subst //,/,$(2)/$(dir)))))
-endef
-
-
-# macro to include a target only if it's on the list of targets that make
-# was invoked with
-#
-# This allows you to have something like an "order-only phony prerequisite",
-# ie a prerequisite that determines an order phony targets have to run in.
-#
-# Because normal order-only prerequisites don't work with phony targets.
-#
-# example $(call prereq_if_explicit,erase_flash)
-define prereq_if_explicit
-$(filter $(1),$(MAKECMDGOALS))
-endef
-
-# macro to kill duplicate items in a list without messing up the sort order of the list.
-# Will only keep the unique items; if there are non-unique items in the list, it will remove
-# the later recurring ones so only the first one remains.
-# Copied from http://stackoverflow.com/questions/16144115/makefile-remove-duplicate-words-without-sorting
-define uniq
-$(if $1,$(firstword $1) $(call uniq,$(filter-out $(firstword $1),$1)))
-endef
-
-# macro to strip leading ../s from a path
-# Given $(1) which is a directory, remove any leading ../s from it
-# (recursively keeps removing ../ until not found)
-# if the path contains nothing but ../.., a single . is returned (cwd)
-define stripLeadingParentDirs
-$(foreach path,$(1),$(if $(subst ..,,$(path)),$(if $(filter ../%,$(path)),$(call stripLeadingParentDirs,$(patsubst ../%,%,$(path))),$(path)),.))
-endef
+++ /dev/null
-# Component wrapper makefile
-#
-# This makefile gets called recursively from the project make, once for each component.
-# COMPONENT_MAKEFILE is set to point at the component.mk file for the component itself,
-# which is included as part of this process (after default variables are defined).
-#
-# This makefile comprises multiple stages, marked in blocked comments below.
-#
-# CWD is the build directory of the component.
-
-ifndef PROJECT_PATH
-$(error Make was invoked from $(CURDIR). However please do not run make from the sdk or a component directory; invoke make from the project directory. See the ESP-IDF README for details.)
-endif
-
-
-################################################################################
-# 1) Set default variables for the component build (including configuration
-# loaded from sdkconfig.)
-################################################################################
-
-# Find the path to the component
-COMPONENT_PATH := $(abspath $(dir $(COMPONENT_MAKEFILE)))
-export COMPONENT_PATH
-
-# COMPONENT_BUILD_DIR is otherwise known as CWD for the build
-COMPONENT_BUILD_DIR := $(abspath .)
-
-# include elements common to both project & component makefiles
-# (includes project configuration set via menuconfig)
-include $(RTOS_PATH)/make/common.mk
-
-# Some of the following defaults may be overriden by the component's component.mk makefile,
-# during the next step:
-
-# Absolute path of the .a file
-COMPONENT_LIBRARY = lib$(COMPONENT_NAME).a
-
-# Source dirs a component has. Default to root directory of component.
-COMPONENT_SRCDIRS = .
-
-#Names of binary & text files to embed as raw content in the component library
-COMPONENT_EMBED_FILES ?=
-COMPONENT_EMBED_TXTFILES ?=
-
-# By default, include only the include/ dir.
-COMPONENT_ADD_INCLUDEDIRS = include
-COMPONENT_ADD_LDFLAGS = -l$(COMPONENT_NAME)
-
-# Define optional compiling macros
-define compile_exclude
-COMPONENT_OBJEXCLUDE += $(1)
-endef
-
-define compile_include
-COMPONENT_OBJINCLUDE += $(1)
-endef
-
-define compile_only_if
-$(eval $(if $(1), $(call compile_include, $(2)), $(call compile_exclude, $(2))))
-endef
-
-define compile_only_if_not
-$(eval $(if $(1), $(call compile_exclude, $(2)), $(call compile_include, $(2))))
-endef
-
-COMPONENT_ADD_LINKER_DEPS ?=
-COMPONENT_DEPENDS ?=
-COMPONENT_EXTRA_CLEAN ?=
-COMPONENT_EXTRA_INCLUDES ?=
-COMPONENT_OBJEXCLUDE ?=
-COMPONENT_OBJINCLUDE ?=
-COMPONENT_SUBMODULES ?=
-
-################################################################################
-# 2) Include the component.mk for the specific component (COMPONENT_MAKEFILE) to
-# override variables & optionally define custom targets. Also include global
-# component makefiles.
-################################################################################
-
-
-# Include any Makefile.componentbuild file letting components add
-# configuration at the global component level
-
-# Save component_path; we pass it to the called Makefile.componentbuild
-# as COMPILING_COMPONENT_PATH, and we use it to restore the current
-# COMPONENT_PATH later.
-COMPILING_COMPONENT_PATH := $(COMPONENT_PATH)
-
-define includeCompBuildMakefile
-$(if $(V),$(info including $(1)/Makefile.componentbuild...))
-COMPONENT_PATH := $(1)
-include $(1)/Makefile.componentbuild
-endef
-$(foreach componentpath,$(COMPONENT_PATHS), \
- $(if $(wildcard $(componentpath)/Makefile.componentbuild), \
- $(eval $(call includeCompBuildMakefile,$(componentpath)))))
-
-#Restore COMPONENT_PATH to what it was
-COMPONENT_PATH := $(COMPILING_COMPONENT_PATH)
-
-
-# Include component.mk for this component.
-include $(COMPONENT_MAKEFILE)
-
-
-################################################################################
-# 3) Set variables that depend on values that may changed by component.mk
-################################################################################
-
-ifndef COMPONENT_CONFIG_ONLY # Skip steps 3-5 if COMPONENT_CONFIG_ONLY is set
-
-# Object files which need to be linked into the library
-# By default we take all .c, .cpp, .cc & .S files in COMPONENT_SRCDIRS.
-ifndef COMPONENT_OBJS
-# Find all source files in all COMPONENT_SRCDIRS
-COMPONENT_OBJS := $(foreach compsrcdir,$(COMPONENT_SRCDIRS),$(patsubst %.c,%.o,$(wildcard $(COMPONENT_PATH)/$(compsrcdir)/*.c)))
-COMPONENT_OBJS += $(foreach compsrcdir,$(COMPONENT_SRCDIRS),$(patsubst %.cpp,%.o,$(wildcard $(COMPONENT_PATH)/$(compsrcdir)/*.cpp)))
-COMPONENT_OBJS += $(foreach compsrcdir,$(COMPONENT_SRCDIRS),$(patsubst %.cc,%.o,$(wildcard $(COMPONENT_PATH)/$(compsrcdir)/*.cc)))
-COMPONENT_OBJS += $(foreach compsrcdir,$(COMPONENT_SRCDIRS),$(patsubst %.S,%.o,$(wildcard $(COMPONENT_PATH)/$(compsrcdir)/*.S)))
-# Make relative by removing COMPONENT_PATH from all found object paths
-COMPONENT_OBJS := $(patsubst $(COMPONENT_PATH)/%,%,$(COMPONENT_OBJS))
-else
-# Add in components defined by conditional compiling macros
-COMPONENT_OBJS += $(COMPONENT_OBJINCLUDE)
-endif
-# Remove any leading ../ from paths, so everything builds inside build dir
-COMPONENT_OBJS := $(call stripLeadingParentDirs,$(COMPONENT_OBJS))
-
-# Do the same for COMPONENT_OBJEXCLUDE (used below)
-COMPONENT_OBJEXCLUDE := $(call stripLeadingParentDirs,$(COMPONENT_OBJEXCLUDE))
-
-# COMPONENT_OBJDIRS is COMPONENT_SRCDIRS with the same transform applied
-COMPONENT_OBJDIRS := $(call stripLeadingParentDirs,$(COMPONENT_SRCDIRS))
-
-# Remove items disabled by optional compilation
-COMPONENT_OBJS := $(foreach obj,$(COMPONENT_OBJS),$(if $(filter $(abspath $(obj)),$(abspath $(COMPONENT_OBJEXCLUDE))), ,$(obj)))
-
-# Remove duplicates
-COMPONENT_OBJS := $(call uniq,$(COMPONENT_OBJS))
-
-# Object files with embedded binaries to add to the component library
-# Correspond to the files named in COMPONENT_EMBED_FILES & COMPONENT_EMBED_TXTFILES
-COMPONENT_EMBED_OBJS ?= $(addsuffix .bin.o,$(notdir $(COMPONENT_EMBED_FILES))) $(addsuffix .txt.o,$(notdir $(COMPONENT_EMBED_TXTFILES)))
-
-# If we're called to compile something, we'll get passed the COMPONENT_INCLUDES
-# variable with all the include dirs from all the components in random order. This
-# means we can accidentally grab a header from another component before grabbing our own.
-# To make sure that does not happen, re-order the includes so ours come first.
-COMPONENT_PRIV_INCLUDEDIRS ?=
-OWN_INCLUDES:=$(abspath $(addprefix $(COMPONENT_PATH)/,$(COMPONENT_PRIV_INCLUDEDIRS) $(COMPONENT_ADD_INCLUDEDIRS)))
-COMPONENT_INCLUDES := $(OWN_INCLUDES) $(filter-out $(OWN_INCLUDES),$(COMPONENT_INCLUDES))
-
-
-################################################################################
-# 4) Define a target to generate component_project_vars.mk Makefile which
-# contains common per-component settings which are included directly in the
-# top-level project make
-#
-# (Skipped if COMPONENT_CONFIG_ONLY is set.)
-################################################################################
-
-# macro to generate variable-relative paths inside component_project_vars.mk, whenever possible
-# ie put literal $(RTOS_PATH), $(PROJECT_PATH) and $(BUILD_DIR_BASE) into the generated
-# makefiles where possible.
-#
-# This means if directories move (breaking absolute paths), don't need to 'make clean'
-define MakeVariablePath
-$(subst $(RTOS_PATH),$$(RTOS_PATH),$(subst $(PROJECT_PATH),$$(PROJECT_PATH),$(subst $(BUILD_DIR_BASE),$$(BUILD_DIR_BASE),$(1))))
-endef
-
-# component_project_vars.mk target for the component. This is used to
-# take component.mk variables COMPONENT_ADD_INCLUDEDIRS,
-# COMPONENT_ADD_LDFLAGS, COMPONENT_DEPENDS and COMPONENT_SUBMODULES
-# and inject those into the project make pass.
-#
-# The target here has no dependencies, as the parent target in
-# project.mk evaluates dependencies before calling down to here. See
-# GenerateComponentTargets macro in project.mk.
-#
-# If you are thinking of editing the output of this target for a
-# component-specific feature, please don't! What you want is a
-# Makefile.projbuild for your component (see docs/build-system.rst for
-# more.)
-#
-# Note: The :: target here is not a mistake. This target should always be
-# executed, as dependencies are checked by the parent project-level make target.
-# See https://www.gnu.org/software/make/manual/make.html#index-_003a_003a-rules-_0028double_002dcolon_0029
-component_project_vars.mk::
- $(details) "Building component project variables list $(abspath $@)"
- @echo '# Automatically generated build file. Do not edit.' > $@
- @echo 'COMPONENT_INCLUDES += $(call MakeVariablePath,$(abspath $(addprefix $(COMPONENT_PATH)/,$(COMPONENT_ADD_INCLUDEDIRS))))' >> $@
- @echo 'COMPONENT_LDFLAGS += $(call MakeVariablePath,-L$(COMPONENT_BUILD_DIR) $(COMPONENT_ADD_LDFLAGS))' >> $@
- @echo 'COMPONENT_LINKER_DEPS += $(call MakeVariablePath,$(call resolvepath,$(COMPONENT_ADD_LINKER_DEPS),$(COMPONENT_PATH)))' >> $@
- @echo 'COMPONENT_SUBMODULES += $(call MakeVariablePath,$(abspath $(addprefix $(COMPONENT_PATH)/,$(COMPONENT_SUBMODULES))))' >> $@
- @echo 'COMPONENT_LIBRARIES += $(COMPONENT_NAME)' >> $@
- @echo 'component-$(COMPONENT_NAME)-build: $(addprefix component-,$(addsuffix -build,$(COMPONENT_DEPENDS)))' >> $@
-
-################################################################################
-# 5) Where COMPONENT_OWNBUILDTARGET / COMPONENT_OWNCLEANTARGET
-# is not set by component.mk, define default build, clean, etc. targets
-#
-# (Skipped if COMPONENT_CONFIG_ONLY is set.)
-################################################################################
-
-# Default build behaviour: define a phony build target and a COMPONENT_LIBRARY link target.
-ifndef COMPONENT_OWNBUILDTARGET
-.PHONY: build
-build: $(COMPONENT_LIBRARY)
-
-# Build the archive. We remove the archive first, otherwise ar will get confused if we update
-# an archive when multiple filenames have the same name (src1/test.o and src2/test.o)
-$(COMPONENT_LIBRARY): $(COMPONENT_OBJS) $(COMPONENT_EMBED_OBJS)
- $(summary) AR $(patsubst $(PWD)/%,%,$(CURDIR))/$@
- rm -f $@
- $(AR) cru $@ $^
-endif
-
-# If COMPONENT_OWNCLEANTARGET is not set, define a phony clean target
-ifndef COMPONENT_OWNCLEANTARGET
-CLEAN_FILES := $(COMPONENT_LIBRARY) $(COMPONENT_OBJS) $(COMPONENT_OBJS:.o=.d) $(COMPONENT_OBJEXCLUDE) $(COMPONENT_OBJEXCLUDE:.o=.d) $(COMPONENT_EMBED_OBJS) $(COMPONENT_EXTRA_CLEAN) component_project_vars.mk
-.PHONY: clean
-clean:
- $(summary) RM $(CLEAN_FILES)
- rm -f $(CLEAN_FILES)
-endif
-
-DEBUG_FLAGS ?= -ggdb
-
-# Include all dependency files already generated
--include $(COMPONENT_OBJS:.o=.d)
-
-# This is a fix for situation where the project or IDF dir moves, and instead
-# of rebuilding the target the build fails until make clean is run
-#
-# It adds an empty dependency rule for the (possibly non-existent) source file itself,
-# which prevents it not being found from failing the build
-#
-# $1 == Source File, $2 == .o file used for .d file name
-define AppendSourceToDependencies
-echo "$1:" >> $$(patsubst %.o,%.d,$2)
-endef
-
-
-# This pattern is generated for each COMPONENT_SRCDIR to compile the files in it.
-define GenerateCompileTargets
-# $(1) - directory containing source files, relative to $(COMPONENT_PATH) - one of $(COMPONENT_SRCDIRS)
-# $(2) - output build directory, which is $(1) with any leading ".."s converted to "."s to ensure output is always under build/
-#
-
-$(2)/%.o: $$(COMPONENT_PATH)/$(1)/%.c $(COMMON_MAKEFILES) $(COMPONENT_MAKEFILE) | $(COMPONENT_OBJDIRS)
- $$(summary) CC $$(patsubst $$(PWD)/%,%,$$(CURDIR))/$$@
- $$(CC) $$(CFLAGS) $$(CPPFLAGS) $$(addprefix -I ,$$(COMPONENT_INCLUDES)) $$(addprefix -I ,$$(COMPONENT_EXTRA_INCLUDES)) -I $(1) -c $$(abspath $$<) -o $$@
- $(call AppendSourceToDependencies,$$<,$$@)
-
-$(2)/%.o: $$(COMPONENT_PATH)/$(1)/%.cpp $(COMMON_MAKEFILES) $(COMPONENT_MAKEFILE) | $(COMPONENT_OBJDIRS)
- $$(summary) CXX $$(patsubst $$(PWD)/%,%,$$(CURDIR))/$$@
- $$(CXX) $$(CXXFLAGS) $$(CPPFLAGS) $$(addprefix -I ,$$(COMPONENT_INCLUDES)) $$(addprefix -I ,$$(COMPONENT_EXTRA_INCLUDES)) -I $(1) -c $$(abspath $$<) -o $$@
- $(call AppendSourceToDependencies,$$<,$$@)
-
-$(2)/%.o: $$(COMPONENT_PATH)/$(1)/%.cc $(COMMON_MAKEFILES) $(COMPONENT_MAKEFILE) | $(COMPONENT_OBJDIRS)
- $$(summary) CXX $$(patsubst $$(PWD)/%,%,$$(CURDIR))/$$@
- $$(CXX) $$(CXXFLAGS) $$(CPPFLAGS) $$(addprefix -I ,$$(COMPONENT_INCLUDES)) $$(addprefix -I ,$$(COMPONENT_EXTRA_INCLUDES)) -I $(1) -c $$(abspath $$<) -o $$@
- $(call AppendSourceToDependencies,$$<,$$@)
-
-$(2)/%.o: $$(COMPONENT_PATH)/$(1)/%.S $(COMMON_MAKEFILES) $(COMPONENT_MAKEFILE) | $(COMPONENT_OBJDIRS)
- $$(summary) AS $$(patsubst $$(PWD)/%,%,$$(CURDIR))/$$@
- $$(CC) $$(CPPFLAGS) $$(DEBUG_FLAGS) $$(addprefix -I ,$$(COMPONENT_INCLUDES)) $$(addprefix -I ,$$(COMPONENT_EXTRA_INCLUDES)) -I $(1) -c $$(abspath $$<) -o $$@
- $(call AppendSourceToDependencies,$$<,$$@)
-
-# CWD is build dir, create the build subdirectory if it doesn't exist
-#
-# (NB: Each .o file depends on all relative component build dirs $(COMPONENT_OBJDIRS), including $(2), to work
-# around a behaviour make 3.81 where the first pattern (randomly) seems to be matched rather than the best fit. ie if
-# you have objects a/y.o and a/b/c.o then c.o can be matched with $(1)=a & %=b/c, meaning that subdir 'a/b' needs to be
-# created but wouldn't be created if $(2)=a. Make 4.x doesn't have this problem, it seems to preferentially
-# choose the better match ie $(2)=a/b and %=c )
-#
-# Note: This may cause some issues for out-of-tree source files and make 3.81 :/
-#
-$(2):
- mkdir -p $(2)
-endef
-
-# Generate all the compile target patterns
-$(foreach srcdir,$(COMPONENT_SRCDIRS), $(eval $(call GenerateCompileTargets,$(srcdir),$(call stripLeadingParentDirs,$(srcdir)))))
-
-## Support for embedding binary files into the ELF as symbols
-
-OBJCOPY_EMBED_ARGS := --input-target binary --output-target elf32-xtensa-le --binary-architecture xtensa --rename-section .data=.rodata.embedded
-
-# Generate pattern for embedding text or binary files into the app
-# $(1) is name of file (as relative path inside component)
-# $(2) is txt or bin depending on file contents
-#
-# txt files are null-terminated before being embedded (otherwise
-# identical behaviour.)
-#
-define GenerateEmbedTarget
-
-# copy the input file into the build dir (using a subdirectory
-# in case the file already exists elsewhere in the build dir)
-embed_bin/$$(notdir $(1)): $(call resolvepath,$(1),$(COMPONENT_PATH)) | embed_bin
- cp $$< $$@
-
-embed_txt/$$(notdir $(1)): $(call resolvepath,$(1),$(COMPONENT_PATH)) | embed_txt
- cp $$< $$@
- printf '\0' >> $$@ # null-terminate text files
-
-# messing about with the embed_X subdirectory then using 'cd' for objcopy is because the
-# full path passed to OBJCOPY makes it into the name of the symbols in the .o file
-$$(notdir $(1)).$(2).o: embed_$(2)/$$(notdir $(1))
- $(summary) EMBED $$(patsubst $$(PWD)/%,%,$$(CURDIR))/$$@
- cd embed_$(2); $(OBJCOPY) $(OBJCOPY_EMBED_ARGS) $$(notdir $$<) ../$$@
-
-CLEAN_FILES += embed_$(2)/$$(notdir $(1))
-endef
-
-embed_txt embed_bin:
- mkdir -p $@
-
-# generate targets to embed binary & text files
-$(foreach binfile,$(COMPONENT_EMBED_FILES), $(eval $(call GenerateEmbedTarget,$(binfile),bin)))
-
-$(foreach txtfile,$(COMPONENT_EMBED_TXTFILES), $(eval $(call GenerateEmbedTarget,$(txtfile),txt)))
-
-else # COMPONENT_CONFIG_ONLY is set
-
-build:
- $(details) "No build needed for $(COMPONENT_NAME) (COMPONENT_CONFIG_ONLY)"
-
-clean:
- $(summary) RM component_project_vars.mk
- rm -f component_project_vars.mk
-
-component_project_vars.mk:: # no need to add variables via component.mk
- @echo '# COMPONENT_CONFIG_ONLY target sets no variables here' > $@
-
-endif # COMPONENT_CONFIG_ONLY
-
+++ /dev/null
-details := @echo
-summary := @true
-HOSTCC := gcc
-HOSTCXX := g++
-HOSTLD := ld
-HOSTAR := ar
-HOSTOBJCOPY := objcopy
-HOSTSIZE := size
-
-CONFIG_TOOLPREFIX := xtensa-esp32-elf-
-CC := $(CONFIG_TOOLPREFIX)gcc
-CXX := $(CONFIG_TOOLPREFIX)c++
-LD := $(CONFIG_TOOLPREFIX)ld
-AR := $(CONFIG_TOOLPREFIX)ar
-OBJCOPY := $(CONFIG_TOOLPREFIX)objcopy
-SIZE := $(CONFIG_TOOLPREFIX)size
-export CC CXX LD AR OBJCOPY SIZE
-
-.PHONY: all_binaries clean
-all: all_binaries
-
- # ?= 的意思是如果没有赋值过则赋值?=后面的值
-OS ?=
-
- # ifeq 的意思是判断是否相等
-ifeq ("$(OS)", "Windows_NT")
-$(error "Unsupport build platform")
-else
- # wildcard 展开通配符
- # realpath 对于名称中的每个文件名返回规范绝对名称。规范名称不包含任何.或..成分，也没有任何重复的路径分隔符（/）或符号链接
-export RTOS_PATH := $(realpath $(wildcard $(RTOS_PATH)))
-endif
-
-ifndef RTOS_PATH
-$(error "RTOS_PATH not define")
-endif
-
-ifndef PROJECT_PATH
- # MAKEFILE_LIST 列出make用到的所有文件
- # firstword 取第一个单词
- # dir 求路径
- # abspath 求绝对路径
- # export定义一个变量、下级makefile可以访问, export VAR := 'var' <==> VAR := 'var' 和 export VAR 两条命令
-PROJECT_PATH := $(abspath $(dir $(firstword $(MAKEFILE_LIST))))
-export PROJECT_PATH
-else
-$(error "PROJECT_PATH was polluted")
-endif
-
-ifndef BUILD_DIR_BASE
-export BUILD_DIR_BASE := $(PROJECT_PATH)/build
-endif
-
-ifndef COMPONENT_DIRS
-export COMPONENT_DIRS := $(RTOS_PATH)/components $(PROJECT_PATH)/components $(PROJECT_PATH)/main
-endif
-
-#ifndef COMPONENTS
-COMPONENTS := $(dir $(foreach cd,$(COMPONENT_DIRS), \
- $(wildcard $(cd)/*/component.mk) $(wildcard $(cd)/component.mk)))
-
-COMPONENTS := $(sort $(foreach comp,$(COMPONENTS),$(lastword $(subst /, ,$(comp)))))
-export COMPONENTS
-#endif
-
-COMPONENT_PATHS := $(foreach comp,$(COMPONENTS),$(firstword $(foreach cd,$(COMPONENT_DIRS),$(wildcard $(dir $(cd))$(comp) $(cd)/$(comp)))))
-COMPONENT_KCONFIGS := $(foreach component,$(COMPONENT_PATHS),$(wildcard $(component)/Kconfig))
- # COMPONENT_KCONFIGS_PROJBUILD 会在$(RTOS_PATH)/Kconfig里用到
-COMPONENT_KCONFIGS_PROJBUILD := $(foreach component,$(COMPONENT_PATHS),$(wildcard $(component)/Kconfig.projbuild))
-
-SDKCONFIG ?= $(PROJECT_PATH)/sdkconfig
-KCONFIG_TOOL_DIR=$(RTOS_PATH)/tools/kconfig
-
-COMMON_MAKEFILES := $(abspath $(RTOS_PATH)/make/project.mk $(firstword $(MAKEFILE_LIST)))
-export COMMON_MAKEFILES
-
-COMPONENT_INCLUDES :=
-COMPONENT_LDFLAGS :=
-COMPONENT_SUBMODULES :=
-COMPONENT_LIBRARIES :=
-COMPONENT_PROJECT_VARS := $(addsuffix /component_project_vars.mk,$(notdir $(COMPONENT_PATHS) ))
-COMPONENT_PROJECT_VARS := $(addprefix $(BUILD_DIR_BASE)/,$(COMPONENT_PROJECT_VARS))
-# this line is -include instead of include to prevent a spurious error message on make 3.81
--include $(COMPONENT_PROJECT_VARS)
-
-
-# Workaround to run make parallel (-j). mconf and conf cannot be made simultaneously
-$(KCONFIG_TOOL_DIR)/mconf: $(KCONFIG_TOOL_DIR)/conf
-
-# reset MAKEFLAGS as the menuconfig makefile uses implicit compile rules
-$(KCONFIG_TOOL_DIR)/mconf $(KCONFIG_TOOL_DIR)/conf: $(wildcard $(KCONFIG_TOOL_DIR)/*.c)
- MAKEFLAGS="" CC=$(HOSTCC) LD=$(HOSTLD) \
- $(MAKE) -C $(KCONFIG_TOOL_DIR)
-
-
-APP_ELF:=$(BUILD_DIR_BASE)/$(PROJECT_NAME).elf
-APP_MAP:=$(APP_ELF:.elf=.map)
-APP_BIN:=$(APP_ELF:.elf=.bin)
-
-all_binaries: $(APP_ELF)
- @echo "end"
-
-fff := $(foreach libcomp,$(COMPONENT_LIBRARIES),$(BUILD_DIR_BASE)/$(libcomp)/lib$(libcomp).a)
-
-LDFLAGS ?= -nostdlib \
- -u call_user_start_cpu0 \
- $(EXTRA_LDFLAGS) \
- -Wl,--gc-sections \
- -Wl,-static \
- -Wl,--start-group \
- $(COMPONENT_LDFLAGS) \
- -lgcc \
- -lstdc++ \
- -lgcov \
- -Wl,--end-group \
- -Wl,-EL
-$(APP_ELF): $(foreach libcomp,$(COMPONENT_LIBRARIES),$(BUILD_DIR_BASE)/$(libcomp)/lib$(libcomp).a) $(COMPONENT_PROJECT_VARS)
- $(summary) LD $(patsubst $(PWD)/%,%,$@)
- $(CC) $(LDFLAGS) -o $@ -Wl,-Map=$(APP_MAP)
-
-
-define RunConf
- mkdir -p $(BUILD_DIR_BASE)/include/config
- cd $(BUILD_DIR_BASE); KCONFIG_AUTOHEADER=$(abspath $(BUILD_DIR_BASE)/include/sdkconfig.h) \
- COMPONENT_KCONFIGS="$(COMPONENT_KCONFIGS)" KCONFIG_CONFIG=$(SDKCONFIG) \
- COMPONENT_KCONFIGS_PROJBUILD="$(COMPONENT_KCONFIGS_PROJBUILD)" \
- $(KCONFIG_TOOL_DIR)/$(1) $(RTOS_PATH)/Kconfig
-endef
-
-.PHONY: menuconfig
-menuconfig: $(KCONFIG_TOOL_DIR)/mconf $(KCONFIG_TOOL_DIR)/conf
- $(call RunConf,mconf)
- $(call RunConf,conf --silentoldconfig)
-
-app-clean: $(addprefix component-,$(addsuffix -clean,$(notdir $(COMPONENT_PATHS))))
- $(summary) RM $(APP_ELF)
- rm -f $(APP_ELF) $(APP_BIN) $(APP_MAP)
-
-clean: app-clean
-
-
-
-
-# Macro for the recursive sub-make for each component
-# $(1) - component directory
-# $(2) - component name only
-#
-# Is recursively expanded by the GenerateComponentTargets macro
-define ComponentMake
-+$(MAKE) -C $(BUILD_DIR_BASE)/$(2) -f $(RTOS_PATH)/make/component_wrapper.mk COMPONENT_MAKEFILE=$(1)/component.mk COMPONENT_NAME=$(2)
-endef
-
-# Generate top-level component-specific targets for each component
-# $(1) - path to component dir
-# $(2) - name of component
-#
-define GenerateComponentTargets
-.PHONY: component-$(2)-build component-$(2)-clean
-
-component-$(2)-build: $(call prereq_if_explicit, component-$(2)-clean) | $(BUILD_DIR_BASE)/$(2)
- $(call ComponentMake,$(1),$(2)) build
-
-component-$(2)-clean: | $(BUILD_DIR_BASE)/$(2) $(BUILD_DIR_BASE)/$(2)/component_project_vars.mk
- $(call ComponentMake,$(1),$(2)) clean
-
-$(BUILD_DIR_BASE)/$(2):
- @mkdir -p $(BUILD_DIR_BASE)/$(2)
-
-
-$(BUILD_DIR_BASE)/$(2)/lib$(2).a: component-$(2)-build
- $(details) "Target '$$^' responsible for '$$@'" # echo which build target built this file
-
-$(BUILD_DIR_BASE)/$(2)/component_project_vars.mk: $(1)/component.mk $(COMMON_MAKEFILES) $(SDKCONFIG_MAKEFILE) | $(BUILD_DIR_BASE)/$(2)
- $(call ComponentMake,$(1),$(2)) component_project_vars.mk
-endef
-$(foreach component,$(COMPONENT_PATHS),$(eval $(call GenerateComponentTargets,$(component),$(notdir $(component)))))
+++ /dev/null
-/*
- * ------------------------------------------------------------------------
- * File Name: rtos.c
- * Author: Zhao Yanbai
- * 2018-07-26 15:08:13 Thursday CST
- * Description: none
- * ------------------------------------------------------------------------
- */
-#include<stdio.h>
-#include "rtos_config.h"
-#include "utils.h"
-
-int main(int argc, char *argv[]){
-// printf("rtos: version %u.%u\n", RTOS_VERSION_MAJOR, RTOS_VERSION_MINOR);
- debug();
-// asm_debug();
- return 0;
-}
+++ /dev/null
-#pragma once
-
-#define RTOS_VERSION_MAJOR @RTOS_VERSION_MAJOR@
-#define RTOS_VERSION_MINOR @RTOS_VERSION_MINOR@
+++ /dev/null
-#
-# Automatically generated file; DO NOT EDIT.
-# Linux Kernel Configuration
-#
-
-#
-# RTOS Configuration
-#
-CONFIG_BLINK_GPIO=2
+++ /dev/null
-#
-# Automatically generated file; DO NOT EDIT.
-# Linux Kernel Configuration
-#
-
-#
-# RTOS Configuration
-#
-CONFIG_BLINK_GPIO=23
+++ /dev/null
-# ===========================================================================
-# Kernel configuration targets
-# These targets are used from top-level makefile
-
-PHONY += xconfig gconfig menuconfig config silentoldconfig \
- localmodconfig localyesconfig clean
-
-ifdef KBUILD_KCONFIG
-Kconfig := $(KBUILD_KCONFIG)
-else
-Kconfig := Kconfig
-endif
-
-ifeq ($(quiet),silent_)
-silent := -s
-endif
-
-# We need this, in case the user has it in its environment
-unexport CONFIG_
-
-# Unset some environment variables set in the project environment
-CFLAGS :=
-CPPFLAGS :=
-LDFLAGS :=
-
-# Workaround for a bug on Windows if the mingw32 host compilers
-# are installed in addition to the MSYS ones. The kconfig tools
-# need to be compiled using the MSYS compiler.
-#
-# See https://github.com/espressif/esp-idf/issues/1296
-ifdef MSYSTEM
-ifeq ("$(MSYSTEM)", "MINGW32")
-ifeq ("$(CC)", "cc")
-CC := /usr/bin/gcc
-endif
-ifeq ("$(LD)", "ld")
-LD := /usr/bin/ld
-endif
-endif # MING32
-endif # MSYSTEM
-
-default: mconf conf
-
-xconfig: qconf
- $< $(silent) $(Kconfig)
-
-gconfig: gconf
- $< $(silent) $(Kconfig)
-
-menuconfig: mconf
- $< $(silent) $(Kconfig)
-
-config: conf
- $< $(silent) --oldaskconfig $(Kconfig)
-
-nconfig: nconf
- $< $(silent) $(Kconfig)
-
-silentoldconfig: conf
- mkdir -p include/config include/generated
- $< $(silent) --$@ $(Kconfig)
-
-localyesconfig localmodconfig: streamline_config.pl conf
- mkdir -p include/config include/generated
- perl $< --$@ . $(Kconfig) > .tmp.config
- if [ -f .config ]; then \
- cmp -s .tmp.config .config || \
- (mv -f .config .config.old.1; \
- mv -f .tmp.config .config; \
- conf $(silent) --silentoldconfig $(Kconfig); \
- mv -f .config.old.1 .config.old) \
- else \
- mv -f .tmp.config .config; \
- conf $(silent) --silentoldconfig $(Kconfig); \
- fi
- rm -f .tmp.config
-
-
-# These targets map 1:1 to the commandline options of 'conf'
-simple-targets := oldconfig allnoconfig allyesconfig allmodconfig \
- alldefconfig randconfig listnewconfig olddefconfig
-PHONY += $(simple-targets)
-
-$(simple-targets): conf
- $< $(silent) --$@ $(Kconfig)
-
-PHONY += oldnoconfig savedefconfig defconfig
-
-# oldnoconfig is an alias of olddefconfig, because people already are dependent
-# on its behavior (sets new symbols to their default value but not 'n') with the
-# counter-intuitive name.
-oldnoconfig: olddefconfig
-
-savedefconfig: conf
- $< $(silent) --$@=defconfig $(Kconfig)
-
-defconfig: conf
-ifeq ($(KBUILD_DEFCONFIG),)
- $< $(silent) --defconfig $(Kconfig)
-else
-ifneq ($(wildcard $(srctree)/arch/$(SRCARCH)/configs/$(KBUILD_DEFCONFIG)),)
- @$(kecho) "*** Default configuration is based on '$(KBUILD_DEFCONFIG)'"
- $< $(silent) --defconfig=arch/$(SRCARCH)/configs/$(KBUILD_DEFCONFIG) $(Kconfig)
-else
- @$(kecho) "*** Default configuration is based on target '$(KBUILD_DEFCONFIG)'"
- $(MAKE) -f $(srctree)/Makefile $(KBUILD_DEFCONFIG)
-endif
-endif
-
-%_defconfig: conf
- $< $(silent) --defconfig=arch/$(SRCARCH)/configs/$@ $(Kconfig)
-
-configfiles=$(wildcard $(srctree)/kernel/configs/$@ $(srctree)/arch/$(SRCARCH)/configs/$@)
-
-%.config: conf
- $(if $(call configfiles),, $(error No configuration exists for this target on this architecture))
- $(CONFIG_SHELL) $(srctree)/scripts/kconfig/merge_config.sh -m .config $(configfiles)
- +yes "" | $(MAKE) -f $(srctree)/Makefile oldconfig
-
-PHONY += kvmconfig
-kvmconfig: kvm_guest.config
- @:
-
-PHONY += xenconfig
-xenconfig: xen.config
- @:
-
-PHONY += tinyconfig
-tinyconfig:
- $(MAKE) -f $(srctree)/Makefile allnoconfig tiny.config
-
-# Help text used by make help
-help:
- @echo ' config - Update current config utilising a line-oriented program'
- @echo ' nconfig - Update current config utilising a ncurses menu based'
- @echo ' program'
- @echo ' menuconfig - Update current config utilising a menu based program'
- @echo ' xconfig - Update current config utilising a Qt based front-end'
- @echo ' gconfig - Update current config utilising a GTK+ based front-end'
- @echo ' oldconfig - Update current config utilising a provided .config as base'
- @echo ' localmodconfig - Update current config disabling modules not loaded'
- @echo ' localyesconfig - Update current config converting local mods to core'
- @echo ' silentoldconfig - Same as oldconfig, but quietly, additionally update deps'
- @echo ' defconfig - New config with default from ARCH supplied defconfig'
- @echo ' savedefconfig - Save current config as ./defconfig (minimal config)'
- @echo ' allnoconfig - New config where all options are answered with no'
- @echo ' allyesconfig - New config where all options are accepted with yes'
- @echo ' allmodconfig - New config selecting modules when possible'
- @echo ' alldefconfig - New config with all symbols set to default'
- @echo ' randconfig - New config with random answer to all options'
- @echo ' listnewconfig - List new options'
- @echo ' olddefconfig - Same as silentoldconfig but sets new symbols to their'
- @echo ' default value'
- @echo ' kvmconfig - Enable additional options for kvm guest kernel support'
- @echo ' xenconfig - Enable additional options for xen dom0 and guest kernel support'
- @echo ' tinyconfig - Configure the tiniest possible kernel'
-
-# lxdialog stuff
-check-lxdialog := lxdialog/check-lxdialog.sh
-
-# Use recursively expanded variables so we do not call gcc unless
-# we really need to do so. (Do not call gcc as part of make mrproper)
-CFLAGS += $(shell $(CONFIG_SHELL) $(check-lxdialog) -ccflags) \
- -DLOCALE -MD
-
-# ===========================================================================
-# Shared Makefile for the various kconfig executables:
-# conf: Used for defconfig, oldconfig and related targets
-# nconf: Used for the nconfig target.
-# Utilizes ncurses
-# mconf: Used for the menuconfig target
-# Utilizes the lxdialog package
-# qconf: Used for the xconfig target
-# Based on Qt which needs to be installed to compile it
-# gconf: Used for the gconfig target
-# Based on GTK+ which needs to be installed to compile it
-# object files used by all kconfig flavours
-
-lxdialog := lxdialog/checklist.o lxdialog/util.o lxdialog/inputbox.o
-lxdialog += lxdialog/textbox.o lxdialog/yesno.o lxdialog/menubox.o
-
-conf-objs := conf.o zconf.tab.o
-mconf-objs := mconf.o zconf.tab.o $(lxdialog)
-nconf-objs := nconf.o zconf.tab.o nconf.gui.o
-kxgettext-objs := kxgettext.o zconf.tab.o
-qconf-cxxobjs := qconf.o
-qconf-objs := zconf.tab.o
-gconf-objs := gconf.o zconf.tab.o
-
-hostprogs-y := conf nconf mconf kxgettext qconf gconf
-
-all-objs := $(conf-objs) $(mconf-objs) $(lxdialog)
-all-deps := $(all-objs:.o=.d)
-
-clean-files := qconf.moc .tmp_qtcheck .tmp_gtkcheck
-clean-files += zconf.tab.c zconf.lex.c zconf.hash.c gconf.glade.h
-clean-files += $(all-objs) $(all-deps) conf mconf
-
-# Check that we have the required ncurses stuff installed for lxdialog (menuconfig)
-PHONY += dochecklxdialog
-$(addprefix ,$(lxdialog)): dochecklxdialog
-dochecklxdialog:
- $(CONFIG_SHELL) $(check-lxdialog) -check $(CC) $(CFLAGS) $(LOADLIBES_mconf)
-
-always := dochecklxdialog
-
-# Add environment specific flags
-EXTRACFLAGS += $(shell $(CONFIG_SHELL) $(srctree)/$(src)/check.sh $(CC) $(CFLAGS))
-
-# generated files seem to need this to find local include files
-CFLAGS_zconf.lex.o := -I$(src)
-CFLAGS_zconf.tab.o := -I$(src)
-
-LEX_PREFIX_zconf := zconf
-YACC_PREFIX_zconf := zconf
-
-LOADLIBES_qconf = $(KC_QT_LIBS)
-CXXFLAGS_qconf.o = $(KC_QT_CFLAGS)
-
-LOADLIBES_gconf = `pkg-config --libs gtk+-2.0 gmodule-2.0 libglade-2.0`
-CFLAGS_gconf.o = `pkg-config --cflags gtk+-2.0 gmodule-2.0 libglade-2.0` \
- -Wno-missing-prototypes
-
-LOADLIBES_mconf = $(shell $(CONFIG_SHELL) $(check-lxdialog) -ldflags $(CC))
-
-LOADLIBES_conf = $(LOADLIBES_mconf)
-
-LOADLIBES_nconf = $(shell \
- pkg-config --libs menuw panelw ncursesw 2>/dev/null \
- || pkg-config --libs menu panel ncurses 2>/dev/null \
- || echo "-lmenu -lpanel -lncurses" )
-
-ifeq ("$(OS)","Windows_NT")
-# Windows toolchains don't seem to count libintl
-# as a system library
-LOADLIBES_mconf += -lintl
-LOADLIBES_nconf += -lintl
-endif
-
-qconf.o: .tmp_qtcheck
-
-ifeq ($(MAKECMDGOALS),xconfig)
-.tmp_qtcheck: $(src)/Makefile
--include .tmp_qtcheck
-
-# Qt needs some extra effort...
-.tmp_qtcheck:
- @set -e; $(kecho) " CHECK qt"; \
- if pkg-config --exists Qt5Core; then \
- cflags="-std=c++11 -fPIC `pkg-config --cflags Qt5Core Qt5Gui Qt5Widgets`"; \
- libs=`pkg-config --libs Qt5Core Qt5Gui Qt5Widgets`; \
- moc=`pkg-config --variable=host_bins Qt5Core`/moc; \
- elif pkg-config --exists QtCore; then \
- cflags=`pkg-config --cflags QtCore QtGui`; \
- libs=`pkg-config --libs QtCore QtGui`; \
- moc=`pkg-config --variable=moc_location QtCore`; \
- else \
- echo >&2 "*"; \
- echo >&2 "* Could not find Qt via pkg-config."; \
- echo >&2 "* Please install either Qt 4.8 or 5.x. and make sure it's in PKG_CONFIG_PATH"; \
- echo >&2 "*"; \
- exit 1; \
- fi; \
- echo "KC_QT_CFLAGS=$$cflags" > $@; \
- echo "KC_QT_LIBS=$$libs" >> $@; \
- echo "KC_QT_MOC=$$moc" >> $@
-endif
-
-gconf.o: .tmp_gtkcheck
-
-ifeq ($(MAKECMDGOALS),gconfig)
--include .tmp_gtkcheck
-
-# GTK+ needs some extra effort, too...
-.tmp_gtkcheck:
- @if `pkg-config --exists gtk+-2.0 gmodule-2.0 libglade-2.0`; then \
- if `pkg-config --atleast-version=2.0.0 gtk+-2.0`; then \
- touch $@; \
- else \
- echo >&2 "*"; \
- echo >&2 "* GTK+ is present but version >= 2.0.0 is required."; \
- echo >&2 "*"; \
- false; \
- fi \
- else \
- echo >&2 "*"; \
- echo >&2 "* Unable to find the GTK+ installation. Please make sure that"; \
- echo >&2 "* the GTK+ 2.0 development package is correctly installed..."; \
- echo >&2 "* You need gtk+-2.0, glib-2.0 and libglade-2.0."; \
- echo >&2 "*"; \
- false; \
- fi
-endif
-
-zconf.tab.o: zconf.lex.c zconf.hash.c
-
-qconf.o: qconf.moc
-
-quiet_cmd_moc = MOC $@
- cmd_moc = $(KC_QT_MOC) -i $< -o $@
-
-%.moc: $(src)/%.h .tmp_qtcheck
- $(call cmd,moc)
-
-# Extract gconf menu items for i18n support
-gconf.glade.h: gconf.glade
- intltool-extract --type=gettext/glade --srcdir=$(srctree) \
- gconf.glade
-
-
-mconf: $(mconf-objs)
- $(CC) -o $@ $(mconf-objs) $(LOADLIBES_mconf)
-
-conf: $(conf-objs)
- $(CC) -o $@ $(conf-objs) $(LOADLIBES_conf)
-
-zconf.tab.c: zconf.lex.c
-
-zconf.lex.c: zconf.l
- flex -L -P zconf -o zconf.lex.c zconf.l
-
-zconf.hash.c: zconf.gperf
-# strip CRs on Windows systems where gperf will otherwise barf on them
- sed -E "s/\\x0D$$//" zconf.gperf | gperf -t --output-file zconf.hash.c -a -C -E -g -k '1,3,$$' -p -t
-
-zconf.tab.c: zconf.y
- bison -t -l -p zconf -o zconf.tab.c zconf.y
-
-clean:
- rm -f $(clean-files)
-
--include $(all-deps)
-
+++ /dev/null
-scripts/kconfig/lxdialog/checklist.c
-scripts/kconfig/lxdialog/inputbox.c
-scripts/kconfig/lxdialog/menubox.c
-scripts/kconfig/lxdialog/textbox.c
-scripts/kconfig/lxdialog/util.c
-scripts/kconfig/lxdialog/yesno.c
-scripts/kconfig/mconf.c
-scripts/kconfig/conf.c
-scripts/kconfig/confdata.c
-scripts/kconfig/gconf.c
-scripts/kconfig/gconf.glade.h
-scripts/kconfig/qconf.cc
+++ /dev/null
-#!/bin/sh
-# Needed for systems without gettext
-$* -x c -o /dev/null - > /dev/null 2>&1 << EOF
-#include <libintl.h>
-int main()
-{
- gettext("");
- return 0;
-}
-EOF
-if [ ! "$?" -eq "0" ]; then
- echo -DKBUILD_NO_NLS;
-fi
+++ /dev/null
-/*
- * Copyright (C) 2002 Roman Zippel <zippel@linux-m68k.org>
- * Released under the terms of the GNU GPL v2.0.
- */
-
-#include <locale.h>
-#include <ctype.h>
-#include <limits.h>
-#include <stdio.h>
-#include <stdlib.h>
-#include <string.h>
-#include <time.h>
-#include <unistd.h>
-#include <getopt.h>
-#include <sys/stat.h>
-#include <sys/time.h>
-#include <errno.h>
-
-#include "lkc.h"
-
-static void conf(struct menu *menu);
-static void check_conf(struct menu *menu);
-static void xfgets(char *str, int size, FILE *in);
-
-enum input_mode {
- oldaskconfig,
- silentoldconfig,
- oldconfig,
- allnoconfig,
- allyesconfig,
- allmodconfig,
- alldefconfig,
- randconfig,
- defconfig,
- savedefconfig,
- listnewconfig,
- olddefconfig,
-} input_mode = oldaskconfig;
-
-static int indent = 1;
-static int tty_stdio;
-static int valid_stdin = 1;
-static int sync_kconfig;
-static int conf_cnt;
-static char line[PATH_MAX];
-static struct menu *rootEntry;
-
-static void print_help(struct menu *menu)
-{
- struct gstr help = str_new();
-
- menu_get_ext_help(menu, &help);
-
- printf("\n%s\n", str_get(&help));
- str_free(&help);
-}
-
-static void strip(char *str)
-{
- char *p = str;
- int l;
-
- while ((isspace(*p)))
- p++;
- l = strlen(p);
- if (p != str)
- memmove(str, p, l + 1);
- if (!l)
- return;
- p = str + l - 1;
- while ((isspace(*p)))
- *p-- = 0;
-}
-
-static void check_stdin(void)
-{
- if (!valid_stdin) {
- printf(_("aborted!\n\n"));
- printf(_("Console input/output is redirected. "));
- printf(_("Run 'make oldconfig' to update configuration.\n\n"));
- exit(1);
- }
-}
-
-static int conf_askvalue(struct symbol *sym, const char *def)
-{
- enum symbol_type type = sym_get_type(sym);
-
- if (!sym_has_value(sym))
- printf(_("(NEW) "));
-
- line[0] = '\n';
- line[1] = 0;
-
- if (!sym_is_changable(sym)) {
- printf("%s\n", def);
- line[0] = '\n';
- line[1] = 0;
- return 0;
- }
-
- switch (input_mode) {
- case oldconfig:
- case silentoldconfig:
- if (sym_has_value(sym)) {
- printf("%s\n", def);
- return 0;
- }
- check_stdin();
- /* fall through */
- case oldaskconfig:
- fflush(stdout);
- xfgets(line, sizeof(line), stdin);
- if (!tty_stdio)
- printf("\n");
- return 1;
- default:
- break;
- }
-
- switch (type) {
- case S_INT:
- case S_HEX:
- case S_STRING:
- printf("%s\n", def);
- return 1;
- default:
- ;
- }
- printf("%s", line);
- return 1;
-}
-
-static int conf_string(struct menu *menu)
-{
- struct symbol *sym = menu->sym;
- const char *def;
-
- while (1) {
- printf("%*s%s ", indent - 1, "", _(menu->prompt->text));
- printf("(%s) ", sym->name);
- def = sym_get_string_value(sym);
- if (sym_get_string_value(sym))
- printf("[%s] ", def);
- if (!conf_askvalue(sym, def))
- return 0;
- switch (line[0]) {
- case '\n':
- break;
- case '?':
- /* print help */
- if (line[1] == '\n') {
- print_help(menu);
- def = NULL;
- break;
- }
- /* fall through */
- default:
- line[strlen(line)-1] = 0;
- def = line;
- }
- if (def && sym_set_string_value(sym, def))
- return 0;
- }
-}
-
-static int conf_sym(struct menu *menu)
-{
- struct symbol *sym = menu->sym;
- tristate oldval, newval;
-
- while (1) {
- printf("%*s%s ", indent - 1, "", _(menu->prompt->text));
- if (sym->name)
- printf("(%s) ", sym->name);
- putchar('[');
- oldval = sym_get_tristate_value(sym);
- switch (oldval) {
- case no:
- putchar('N');
- break;
- case mod:
- putchar('M');
- break;
- case yes:
- putchar('Y');
- break;
- }
- if (oldval != no && sym_tristate_within_range(sym, no))
- printf("/n");
- if (oldval != mod && sym_tristate_within_range(sym, mod))
- printf("/m");
- if (oldval != yes && sym_tristate_within_range(sym, yes))
- printf("/y");
- if (menu_has_help(menu))
- printf("/?");
- printf("] ");
- if (!conf_askvalue(sym, sym_get_string_value(sym)))
- return 0;
- strip(line);
-
- switch (line[0]) {
- case 'n':
- case 'N':
- newval = no;
- if (!line[1] || !strcmp(&line[1], "o"))
- break;
- continue;
- case 'm':
- case 'M':
- newval = mod;
- if (!line[1])
- break;
- continue;
- case 'y':
- case 'Y':
- newval = yes;
- if (!line[1] || !strcmp(&line[1], "es"))
- break;
- continue;
- case 0:
- newval = oldval;
- break;
- case '?':
- goto help;
- default:
- continue;
- }
- if (sym_set_tristate_value(sym, newval))
- return 0;
-help:
- print_help(menu);
- }
-}
-
-static int conf_choice(struct menu *menu)
-{
- struct symbol *sym, *def_sym;
- struct menu *child;
- bool is_new;
-
- sym = menu->sym;
- is_new = !sym_has_value(sym);
- if (sym_is_changable(sym)) {
- conf_sym(menu);
- sym_calc_value(sym);
- switch (sym_get_tristate_value(sym)) {
- case no:
- return 1;
- case mod:
- return 0;
- case yes:
- break;
- }
- } else {
- switch (sym_get_tristate_value(sym)) {
- case no:
- return 1;
- case mod:
- printf("%*s%s\n", indent - 1, "", _(menu_get_prompt(menu)));
- return 0;
- case yes:
- break;
- }
- }
-
- while (1) {
- int cnt, def;
-
- printf("%*s%s\n", indent - 1, "", _(menu_get_prompt(menu)));
- def_sym = sym_get_choice_value(sym);
- cnt = def = 0;
- line[0] = 0;
- for (child = menu->list; child; child = child->next) {
- if (!menu_is_visible(child))
- continue;
- if (!child->sym) {
- printf("%*c %s\n", indent, '*', _(menu_get_prompt(child)));
- continue;
- }
- cnt++;
- if (child->sym == def_sym) {
- def = cnt;
- printf("%*c", indent, '>');
- } else
- printf("%*c", indent, ' ');
- printf(" %d. %s", cnt, _(menu_get_prompt(child)));
- if (child->sym->name)
- printf(" (%s)", child->sym->name);
- if (!sym_has_value(child->sym))
- printf(_(" (NEW)"));
- printf("\n");
- }
- printf(_("%*schoice"), indent - 1, "");
- if (cnt == 1) {
- printf("[1]: 1\n");
- goto conf_childs;
- }
- printf("[1-%d", cnt);
- if (menu_has_help(menu))
- printf("?");
- printf("]: ");
- switch (input_mode) {
- case oldconfig:
- case silentoldconfig:
- if (!is_new) {
- cnt = def;
- printf("%d\n", cnt);
- break;
- }
- check_stdin();
- /* fall through */
- case oldaskconfig:
- fflush(stdout);
- xfgets(line, sizeof(line), stdin);
- strip(line);
- if (line[0] == '?') {
- print_help(menu);
- continue;
- }
- if (!line[0])
- cnt = def;
- else if (isdigit(line[0]))
- cnt = atoi(line);
- else
- continue;
- break;
- default:
- break;
- }
-
- conf_childs:
- for (child = menu->list; child; child = child->next) {
- if (!child->sym || !menu_is_visible(child))
- continue;
- if (!--cnt)
- break;
- }
- if (!child)
- continue;
- if (line[0] && line[strlen(line) - 1] == '?') {
- print_help(child);
- continue;
- }
- sym_set_choice_value(sym, child->sym);
- for (child = child->list; child; child = child->next) {
- indent += 2;
- conf(child);
- indent -= 2;
- }
- return 1;
- }
-}
-
-static void conf(struct menu *menu)
-{
- struct symbol *sym;
- struct property *prop;
- struct menu *child;
-
- if (!menu_is_visible(menu))
- return;
-
- sym = menu->sym;
- prop = menu->prompt;
- if (prop) {
- const char *prompt;
-
- switch (prop->type) {
- case P_MENU:
- if ((input_mode == silentoldconfig ||
- input_mode == listnewconfig ||
- input_mode == olddefconfig) &&
- rootEntry != menu) {
- check_conf(menu);
- return;
- }
- /* fall through */
- case P_COMMENT:
- prompt = menu_get_prompt(menu);
- if (prompt)
- printf("%*c\n%*c %s\n%*c\n",
- indent, '*',
- indent, '*', _(prompt),
- indent, '*');
- default:
- ;
- }
- }
-
- if (!sym)
- goto conf_childs;
-
- if (sym_is_choice(sym)) {
- conf_choice(menu);
- if (sym->curr.tri != mod)
- return;
- goto conf_childs;
- }
-
- switch (sym->type) {
- case S_INT:
- case S_HEX:
- case S_STRING:
- conf_string(menu);
- break;
- default:
- conf_sym(menu);
- break;
- }
-
-conf_childs:
- if (sym)
- indent += 2;
- for (child = menu->list; child; child = child->next)
- conf(child);
- if (sym)
- indent -= 2;
-}
-
-static void check_conf(struct menu *menu)
-{
- struct symbol *sym;
- struct menu *child;
-
- if (!menu_is_visible(menu))
- return;
-
- sym = menu->sym;
- if (sym && !sym_has_value(sym)) {
- if (sym_is_changable(sym) ||
- (sym_is_choice(sym) && sym_get_tristate_value(sym) == yes)) {
- if (input_mode == listnewconfig) {
- if (sym->name && !sym_is_choice_value(sym)) {
- printf("%s%s\n", CONFIG_, sym->name);
- }
- } else if (input_mode != olddefconfig) {
- if (!conf_cnt++)
- printf(_("*\n* Restart config...\n*\n"));
- rootEntry = menu_get_parent_menu(menu);
- conf(rootEntry);
- }
- }
- }
-
- for (child = menu->list; child; child = child->next)
- check_conf(child);
-}
-
-static struct option long_opts[] = {
- {"oldaskconfig", no_argument, NULL, oldaskconfig},
- {"oldconfig", no_argument, NULL, oldconfig},
- {"silentoldconfig", no_argument, NULL, silentoldconfig},
- {"defconfig", optional_argument, NULL, defconfig},
- {"savedefconfig", required_argument, NULL, savedefconfig},
- {"allnoconfig", no_argument, NULL, allnoconfig},
- {"allyesconfig", no_argument, NULL, allyesconfig},
- {"allmodconfig", no_argument, NULL, allmodconfig},
- {"alldefconfig", no_argument, NULL, alldefconfig},
- {"randconfig", no_argument, NULL, randconfig},
- {"listnewconfig", no_argument, NULL, listnewconfig},
- {"olddefconfig", no_argument, NULL, olddefconfig},
- /*
- * oldnoconfig is an alias of olddefconfig, because people already
- * are dependent on its behavior(sets new symbols to their default
- * value but not 'n') with the counter-intuitive name.
- */
- {"oldnoconfig", no_argument, NULL, olddefconfig},
- {NULL, 0, NULL, 0}
-};
-
-static void conf_usage(const char *progname)
-{
-
- printf("Usage: %s [-s] [option] <kconfig-file>\n", progname);
- printf("[option] is _one_ of the following:\n");
- printf(" --listnewconfig List new options\n");
- printf(" --oldaskconfig Start a new configuration using a line-oriented program\n");
- printf(" --oldconfig Update a configuration using a provided .config as base\n");
- printf(" --silentoldconfig Same as oldconfig, but quietly, additionally update deps\n");
- printf(" --olddefconfig Same as silentoldconfig but sets new symbols to their default value\n");
- printf(" --oldnoconfig An alias of olddefconfig\n");
- printf(" --defconfig <file> New config with default defined in <file>\n");
- printf(" --savedefconfig <file> Save the minimal current configuration to <file>\n");
- printf(" --allnoconfig New config where all options are answered with no\n");
- printf(" --allyesconfig New config where all options are answered with yes\n");
- printf(" --allmodconfig New config where all options are answered with mod\n");
- printf(" --alldefconfig New config with all symbols set to default\n");
- printf(" --randconfig New config with random answer to all options\n");
-}
-
-int main(int ac, char **av)
-{
- const char *progname = av[0];
- int opt;
- const char *name, *defconfig_file = NULL /* gcc uninit */;
- struct stat tmpstat;
-
- setlocale(LC_ALL, "");
- bindtextdomain(PACKAGE, LOCALEDIR);
- textdomain(PACKAGE);
-
- tty_stdio = isatty(0) && isatty(1) && isatty(2);
-
- while ((opt = getopt_long(ac, av, "s", long_opts, NULL)) != -1) {
- if (opt == 's') {
- conf_set_message_callback(NULL);
- continue;
- }
- input_mode = (enum input_mode)opt;
- switch (opt) {
- case silentoldconfig:
- sync_kconfig = 1;
- break;
- case defconfig:
- case savedefconfig:
- defconfig_file = optarg;
- break;
- case randconfig:
- {
- struct timeval now;
- unsigned int seed;
- char *seed_env;
-
- /*
- * Use microseconds derived seed,
- * compensate for systems where it may be zero
- */
- gettimeofday(&now, NULL);
- seed = (unsigned int)((now.tv_sec + 1) * (now.tv_usec + 1));
-
- seed_env = getenv("KCONFIG_SEED");
- if( seed_env && *seed_env ) {
- char *endp;
- int tmp = (int)strtol(seed_env, &endp, 0);
- if (*endp == '\0') {
- seed = tmp;
- }
- }
- fprintf( stderr, "KCONFIG_SEED=0x%X\n", seed );
- srand(seed);
- break;
- }
- case oldaskconfig:
- case oldconfig:
- case allnoconfig:
- case allyesconfig:
- case allmodconfig:
- case alldefconfig:
- case listnewconfig:
- case olddefconfig:
- break;
- case '?':
- conf_usage(progname);
- exit(1);
- break;
- }
- }
- if (ac == optind) {
- printf(_("%s: Kconfig file missing\n"), av[0]);
- conf_usage(progname);
- exit(1);
- }
- name = av[optind];
- conf_parse(name);
- //zconfdump(stdout);
- if (sync_kconfig) {
- name = conf_get_configname();
- if (stat(name, &tmpstat)) {
- fprintf(stderr, _("***\n"
- "*** Configuration file \"%s\" not found!\n"
- "***\n"
- "*** Please run some configurator (e.g. \"make oldconfig\" or\n"
- "*** \"make menuconfig\" or \"make xconfig\").\n"
- "***\n"), name);
- exit(1);
- }
- }
-
- switch (input_mode) {
- case defconfig:
- if (!defconfig_file)
- defconfig_file = conf_get_default_confname();
- if (conf_read(defconfig_file)) {
- printf(_("***\n"
- "*** Can't find default configuration \"%s\"!\n"
- "***\n"), defconfig_file);
- exit(1);
- }
- break;
- case savedefconfig:
- case silentoldconfig:
- case oldaskconfig:
- case oldconfig:
- case listnewconfig:
- case olddefconfig:
- conf_read(NULL);
- break;
- case allnoconfig:
- case allyesconfig:
- case allmodconfig:
- case alldefconfig:
- case randconfig:
- name = getenv("KCONFIG_ALLCONFIG");
- if (!name)
- break;
- if ((strcmp(name, "") != 0) && (strcmp(name, "1") != 0)) {
- if (conf_read_simple(name, S_DEF_USER)) {
- fprintf(stderr,
- _("*** Can't read seed configuration \"%s\"!\n"),
- name);
- exit(1);
- }
- break;
- }
- switch (input_mode) {
- case allnoconfig: name = "allno.config"; break;
- case allyesconfig: name = "allyes.config"; break;
- case allmodconfig: name = "allmod.config"; break;
- case alldefconfig: name = "alldef.config"; break;
- case randconfig: name = "allrandom.config"; break;
- default: break;
- }
- if (conf_read_simple(name, S_DEF_USER) &&
- conf_read_simple("all.config", S_DEF_USER)) {
- fprintf(stderr,
- _("*** KCONFIG_ALLCONFIG set, but no \"%s\" or \"all.config\" file found\n"),
- name);
- exit(1);
- }
- break;
- default:
- break;
- }
-
- if (sync_kconfig) {
- if (conf_get_changed()) {
- name = getenv("KCONFIG_NOSILENTUPDATE");
- if (name && *name) {
- fprintf(stderr,
- _("\n*** The configuration requires explicit update.\n\n"));
- return 1;
- }
- }
- valid_stdin = tty_stdio;
- }
-
- switch (input_mode) {
- case allnoconfig:
- conf_set_all_new_symbols(def_no);
- break;
- case allyesconfig:
- conf_set_all_new_symbols(def_yes);
- break;
- case allmodconfig:
- conf_set_all_new_symbols(def_mod);
- break;
- case alldefconfig:
- conf_set_all_new_symbols(def_default);
- break;
- case randconfig:
- /* Really nothing to do in this loop */
- while (conf_set_all_new_symbols(def_random)) ;
- break;
- case defconfig:
- conf_set_all_new_symbols(def_default);
- break;
- case savedefconfig:
- break;
- case oldaskconfig:
- rootEntry = &rootmenu;
- conf(&rootmenu);
- input_mode = silentoldconfig;
- /* fall through */
- case oldconfig:
- case listnewconfig:
- case olddefconfig:
- case silentoldconfig:
- /* Update until a loop caused no more changes */
- do {
- conf_cnt = 0;
- check_conf(&rootmenu);
- } while (conf_cnt &&
- (input_mode != listnewconfig &&
- input_mode != olddefconfig));
- break;
- }
-
- if (sync_kconfig) {
- /* silentoldconfig is used during the build so we shall update autoconf.
- * All other commands are only used to generate a config.
- */
- if (conf_get_changed() && conf_write(NULL)) {
- fprintf(stderr, _("\n*** Error during writing of the configuration.\n\n"));
- exit(1);
- }
- if (conf_write_autoconf()) {
- fprintf(stderr, _("\n*** Error during update of the configuration.\n\n"));
- return 1;
- }
- } else if (input_mode == savedefconfig) {
- if (conf_write_defconfig(defconfig_file)) {
- fprintf(stderr, _("n*** Error while saving defconfig to: %s\n\n"),
- defconfig_file);
- return 1;
- }
- } else if (input_mode != listnewconfig) {
- if (conf_write(NULL)) {
- fprintf(stderr, _("\n*** Error during writing of the configuration.\n\n"));
- exit(1);
- }
- }
- return 0;
-}
-
-/*
- * Helper function to facilitate fgets() by Jean Sacren.
- */
-void xfgets(char *str, int size, FILE *in)
-{
- if (fgets(str, size, in) == NULL)
- fprintf(stderr, "\nError in reading or end of file.\n");
-}
+++ /dev/null
-/*
- * Copyright (C) 2002 Roman Zippel <zippel@linux-m68k.org>
- * Released under the terms of the GNU GPL v2.0.
- */
-
-#include <sys/stat.h>
-#include <ctype.h>
-#include <errno.h>
-#include <fcntl.h>
-#include <stdarg.h>
-#include <stdio.h>
-#include <stdlib.h>
-#include <string.h>
-#include <time.h>
-#include <unistd.h>
-
-#include "lkc.h"
-
-struct conf_printer {
- void (*print_symbol)(FILE *, struct symbol *, const char *, void *);
- void (*print_comment)(FILE *, const char *, void *);
-};
-
-static void conf_warning(const char *fmt, ...)
- __attribute__ ((format (printf, 1, 2)));
-
-static void conf_message(const char *fmt, ...)
- __attribute__ ((format (printf, 1, 2)));
-
-static const char *conf_filename;
-static int conf_lineno, conf_warnings, conf_unsaved;
-
-const char conf_defname[] = "arch/$ARCH/defconfig";
-
-static void conf_warning(const char *fmt, ...)
-{
- va_list ap;
- va_start(ap, fmt);
- fprintf(stderr, "%s:%d:warning: ", conf_filename, conf_lineno);
- vfprintf(stderr, fmt, ap);
- fprintf(stderr, "\n");
- va_end(ap);
- conf_warnings++;
-}
-
-static void conf_default_message_callback(const char *fmt, va_list ap)
-{
- printf("#\n# ");
- vprintf(fmt, ap);
- printf("\n#\n");
-}
-
-static void (*conf_message_callback) (const char *fmt, va_list ap) =
- conf_default_message_callback;
-void conf_set_message_callback(void (*fn) (const char *fmt, va_list ap))
-{
- conf_message_callback = fn;
-}
-
-static void conf_message(const char *fmt, ...)
-{
- va_list ap;
-
- va_start(ap, fmt);
- if (conf_message_callback)
- conf_message_callback(fmt, ap);
- va_end(ap);
-}
-
-const char *conf_get_configname(void)
-{
- char *name = getenv("KCONFIG_CONFIG");
-
- return name ? name : ".config";
-}
-
-const char *conf_get_autoconfig_name(void)
-{
- char *name = getenv("KCONFIG_AUTOCONFIG");
-
- return name ? name : "include/config/auto.conf";
-}
-
-static char *conf_expand_value(const char *in)
-{
- struct symbol *sym;
- const char *src;
- static char res_value[SYMBOL_MAXLENGTH];
- char *dst, name[SYMBOL_MAXLENGTH];
-
- res_value[0] = 0;
- dst = name;
- while ((src = strchr(in, '$'))) {
- strncat(res_value, in, src - in);
- src++;
- dst = name;
- while (isalnum(*src) || *src == '_')
- *dst++ = *src++;
- *dst = 0;
- sym = sym_lookup(name, 0);
- sym_calc_value(sym);
- strcat(res_value, sym_get_string_value(sym));
- in = src;
- }
- strcat(res_value, in);
-
- return res_value;
-}
-
-char *conf_get_default_confname(void)
-{
- struct stat buf;
- static char fullname[PATH_MAX+1];
- char *env, *name;
-
- name = conf_expand_value(conf_defname);
- env = getenv(SRCTREE);
- if (env) {
- sprintf(fullname, "%s/%s", env, name);
- if (!stat(fullname, &buf))
- return fullname;
- }
- return name;
-}
-
-static int conf_set_sym_val(struct symbol *sym, int def, int def_flags, char *p)
-{
- char *p2;
-
- switch (sym->type) {
- case S_TRISTATE:
- if (p[0] == 'm') {
- sym->def[def].tri = mod;
- sym->flags |= def_flags;
- break;
- }
- /* fall through */
- case S_BOOLEAN:
- if (p[0] == 'y') {
- sym->def[def].tri = yes;
- sym->flags |= def_flags;
- break;
- }
- if (p[0] == 'n' || p[0] == '\0') {
- sym->def[def].tri = no;
- sym->flags |= def_flags;
- break;
- }
- if (def != S_DEF_AUTO)
- conf_warning("symbol value '%s' invalid for %s",
- p, sym->name);
- return 1;
- case S_OTHER:
- if (*p != '"') {
- for (p2 = p; *p2 && !isspace(*p2); p2++)
- ;
- sym->type = S_STRING;
- goto done;
- }
- /* fall through */
- case S_STRING:
- if (*p++ != '"')
- break;
- for (p2 = p; (p2 = strpbrk(p2, "\"\\")); p2++) {
- if (*p2 == '"') {
- *p2 = 0;
- break;
- }
- memmove(p2, p2 + 1, strlen(p2));
- }
- if (!p2) {
- if (def != S_DEF_AUTO)
- conf_warning("invalid string found");
- return 1;
- }
- /* fall through */
- case S_INT:
- case S_HEX:
- done:
- if (sym_string_valid(sym, p)) {
- sym->def[def].val = strdup(p);
- sym->flags |= def_flags;
- } else {
- if (def != S_DEF_AUTO)
- conf_warning("symbol value '%s' invalid for %s",
- p, sym->name);
- return 1;
- }
- break;
- default:
- ;
- }
- return 0;
-}
-
-#define LINE_GROWTH 16
-static int add_byte(int c, char **lineptr, size_t slen, size_t *n)
-{
- char *nline;
- size_t new_size = slen + 1;
- if (new_size > *n) {
- new_size += LINE_GROWTH - 1;
- new_size *= 2;
- nline = realloc(*lineptr, new_size);
- if (!nline)
- return -1;
-
- *lineptr = nline;
- *n = new_size;
- }
-
- (*lineptr)[slen] = c;
-
- return 0;
-}
-
-static ssize_t compat_getline(char **lineptr, size_t *n, FILE *stream)
-{
- char *line = *lineptr;
- size_t slen = 0;
-
- for (;;) {
- int c = getc(stream);
-
- switch (c) {
- case '\n':
- if (add_byte(c, &line, slen, n) < 0)
- goto e_out;
- slen++;
- /* fall through */
- case EOF:
- if (add_byte('\0', &line, slen, n) < 0)
- goto e_out;
- *lineptr = line;
- if (slen == 0)
- return -1;
- return slen;
- default:
- if (add_byte(c, &line, slen, n) < 0)
- goto e_out;
- slen++;
- }
- }
-
-e_out:
- line[slen-1] = '\0';
- *lineptr = line;
- return -1;
-}
-
-int conf_read_simple(const char *name, int def)
-{
- FILE *in = NULL;
- char *line = NULL;
- size_t line_asize = 0;
- char *p, *p2;
- struct symbol *sym;
- int i, def_flags;
-
- if (name) {
- in = zconf_fopen(name);
- } else {
- struct property *prop;
-
- name = conf_get_configname();
- in = zconf_fopen(name);
- if (in)
- goto load;
- sym_add_change_count(1);
- if (!sym_defconfig_list)
- return 1;
-
- for_all_defaults(sym_defconfig_list, prop) {
- if (expr_calc_value(prop->visible.expr) == no ||
- prop->expr->type != E_SYMBOL)
- continue;
- name = conf_expand_value(prop->expr->left.sym->name);
- in = zconf_fopen(name);
- if (in) {
- conf_message(_("using defaults found in %s"),
- name);
- goto load;
- }
- }
- }
- if (!in)
- return 1;
-
-load:
- conf_filename = name;
- conf_lineno = 0;
- conf_warnings = 0;
- conf_unsaved = 0;
-
- def_flags = SYMBOL_DEF << def;
- for_all_symbols(i, sym) {
- sym->flags |= SYMBOL_CHANGED;
- sym->flags &= ~(def_flags|SYMBOL_VALID);
- if (sym_is_choice(sym))
- sym->flags |= def_flags;
- switch (sym->type) {
- case S_INT:
- case S_HEX:
- case S_STRING:
- if (sym->def[def].val)
- free(sym->def[def].val);
- /* fall through */
- default:
- sym->def[def].val = NULL;
- sym->def[def].tri = no;
- }
- }
-
- while (compat_getline(&line, &line_asize, in) != -1) {
- conf_lineno++;
- sym = NULL;
- if (line[0] == '#') {
- if (memcmp(line + 2, CONFIG_, strlen(CONFIG_)))
- continue;
- p = strchr(line + 2 + strlen(CONFIG_), ' ');
- if (!p)
- continue;
- *p++ = 0;
- if (strncmp(p, "is not set", 10))
- continue;
- if (def == S_DEF_USER) {
- sym = sym_find(line + 2 + strlen(CONFIG_));
- if (!sym) {
- sym_add_change_count(1);
- goto setsym;
- }
- } else {
- sym = sym_lookup(line + 2 + strlen(CONFIG_), 0);
- if (sym->type == S_UNKNOWN)
- sym->type = S_BOOLEAN;
- }
- if (sym->flags & def_flags) {
- conf_warning("override: reassigning to symbol %s", sym->name);
- }
- switch (sym->type) {
- case S_BOOLEAN:
- case S_TRISTATE:
- sym->def[def].tri = no;
- sym->flags |= def_flags;
- break;
- default:
- ;
- }
- } else if (memcmp(line, CONFIG_, strlen(CONFIG_)) == 0) {
- p = strchr(line + strlen(CONFIG_), '=');
- if (!p)
- continue;
- *p++ = 0;
- p2 = strchr(p, '\n');
- if (p2) {
- *p2-- = 0;
- if (*p2 == '\r')
- *p2 = 0;
- }
- if (def == S_DEF_USER) {
- sym = sym_find(line + strlen(CONFIG_));
- if (!sym) {
- sym_add_change_count(1);
- goto setsym;
- }
- } else {
- sym = sym_lookup(line + strlen(CONFIG_), 0);
- if (sym->type == S_UNKNOWN)
- sym->type = S_OTHER;
- }
- if (sym->flags & def_flags) {
- conf_warning("override: reassigning to symbol %s", sym->name);
- }
- if (conf_set_sym_val(sym, def, def_flags, p))
- continue;
- } else {
- if (line[0] != '\r' && line[0] != '\n')
- conf_warning("unexpected data");
- continue;
- }
-setsym:
- if (sym && sym_is_choice_value(sym)) {
- struct symbol *cs = prop_get_symbol(sym_get_choice_prop(sym));
- switch (sym->def[def].tri) {
- case no:
- break;
- case mod:
- if (cs->def[def].tri == yes) {
- conf_warning("%s creates inconsistent choice state", sym->name);
- cs->flags &= ~def_flags;
- }
- break;
- case yes:
- if (cs->def[def].tri != no)
- conf_warning("override: %s changes choice state", sym->name);
- cs->def[def].val = sym;
- break;
- }
- cs->def[def].tri = EXPR_OR(cs->def[def].tri, sym->def[def].tri);
- }
- }
- free(line);
- fclose(in);
- return 0;
-}
-
-int conf_read(const char *name)
-{
- struct symbol *sym;
- int i;
-
- sym_set_change_count(0);
-
- if (conf_read_simple(name, S_DEF_USER)) {
- sym_calc_value(modules_sym);
- return 1;
- }
-
- sym_calc_value(modules_sym);
-
- for_all_symbols(i, sym) {
- sym_calc_value(sym);
- if (sym_is_choice(sym) || (sym->flags & SYMBOL_AUTO))
- continue;
- if (sym_has_value(sym) && (sym->flags & SYMBOL_WRITE)) {
- /* check that calculated value agrees with saved value */
- switch (sym->type) {
- case S_BOOLEAN:
- case S_TRISTATE:
- if (sym->def[S_DEF_USER].tri != sym_get_tristate_value(sym))
- break;
- if (!sym_is_choice(sym))
- continue;
- /* fall through */
- default:
- if (!strcmp(sym->curr.val, sym->def[S_DEF_USER].val))
- continue;
- break;
- }
- } else if (!sym_has_value(sym) && !(sym->flags & SYMBOL_WRITE))
- /* no previous value and not saved */
- continue;
- conf_unsaved++;
- /* maybe print value in verbose mode... */
- }
-
- for_all_symbols(i, sym) {
- if (sym_has_value(sym) && !sym_is_choice_value(sym)) {
- /* Reset values of generates values, so they'll appear
- * as new, if they should become visible, but that
- * doesn't quite work if the Kconfig and the saved
- * configuration disagree.
- */
- if (sym->visible == no && !conf_unsaved)
- sym->flags &= ~SYMBOL_DEF_USER;
- switch (sym->type) {
- case S_STRING:
- case S_INT:
- case S_HEX:
- /* Reset a string value if it's out of range */
- if (sym_string_within_range(sym, sym->def[S_DEF_USER].val))
- break;
- sym->flags &= ~(SYMBOL_VALID|SYMBOL_DEF_USER);
- conf_unsaved++;
- break;
- default:
- break;
- }
- }
- }
-
- sym_add_change_count(conf_warnings || conf_unsaved);
-
- return 0;
-}
-
-/*
- * Kconfig configuration printer
- *
- * This printer is used when generating the resulting configuration after
- * kconfig invocation and `defconfig' files. Unset symbol might be omitted by
- * passing a non-NULL argument to the printer.
- *
- */
-static void
-kconfig_print_symbol(FILE *fp, struct symbol *sym, const char *value, void *arg)
-{
-
- switch (sym->type) {
- case S_BOOLEAN:
- case S_TRISTATE:
- if (*value == 'n') {
- value = "";
- }
- break;
- default:
- break;
- }
-
- fprintf(fp, "%s%s=%s\n", CONFIG_, sym->name, value);
-}
-
-static void
-kconfig_print_comment(FILE *fp, const char *value, void *arg)
-{
- const char *p = value;
- size_t l;
-
- for (;;) {
- l = strcspn(p, "\n");
- fprintf(fp, "#");
- if (l) {
- fprintf(fp, " ");
- xfwrite(p, l, 1, fp);
- p += l;
- }
- fprintf(fp, "\n");
- if (*p++ == '\0')
- break;
- }
-}
-
-static struct conf_printer kconfig_printer_cb =
-{
- .print_symbol = kconfig_print_symbol,
- .print_comment = kconfig_print_comment,
-};
-
-/*
- * Header printer
- *
- * This printer is used when generating the `include/generated/autoconf.h' file.
- */
-static void
-header_print_symbol(FILE *fp, struct symbol *sym, const char *value, void *arg)
-{
-
- switch (sym->type) {
- case S_BOOLEAN:
- case S_TRISTATE: {
- const char *suffix = "";
-
- switch (*value) {
- case 'n':
- break;
- case 'm':
- suffix = "_MODULE";
- /* fall through */
- default:
- fprintf(fp, "#define %s%s%s 1\n",
- CONFIG_, sym->name, suffix);
- }
- break;
- }
- case S_HEX: {
- const char *prefix = "";
-
- if (value[0] != '0' || (value[1] != 'x' && value[1] != 'X'))
- prefix = "0x";
- fprintf(fp, "#define %s%s %s%s\n",
- CONFIG_, sym->name, prefix, value);
- break;
- }
- case S_STRING:
- case S_INT:
- fprintf(fp, "#define %s%s %s\n",
- CONFIG_, sym->name, value);
- break;
- default:
- break;
- }
-
-}
-
-static void
-header_print_comment(FILE *fp, const char *value, void *arg)
-{
- const char *p = value;
- size_t l;
-
- fprintf(fp, "/*\n");
- for (;;) {
- l = strcspn(p, "\n");
- fprintf(fp, " *");
- if (l) {
- fprintf(fp, " ");
- xfwrite(p, l, 1, fp);
- p += l;
- }
- fprintf(fp, "\n");
- if (*p++ == '\0')
- break;
- }
- fprintf(fp, " */\n");
-}
-
-static struct conf_printer header_printer_cb =
-{
- .print_symbol = header_print_symbol,
- .print_comment = header_print_comment,
-};
-
-/*
- * Tristate printer
- *
- * This printer is used when generating the `include/config/tristate.conf' file.
- */
-static void
-tristate_print_symbol(FILE *fp, struct symbol *sym, const char *value, void *arg)
-{
-
- if (sym->type == S_TRISTATE && *value != 'n')
- fprintf(fp, "%s%s=%c\n", CONFIG_, sym->name, (char)toupper(*value));
-}
-
-static struct conf_printer tristate_printer_cb =
-{
- .print_symbol = tristate_print_symbol,
- .print_comment = kconfig_print_comment,
-};
-
-static void conf_write_symbol(FILE *fp, struct symbol *sym,
- struct conf_printer *printer, void *printer_arg)
-{
- const char *str;
-
- switch (sym->type) {
- case S_OTHER:
- case S_UNKNOWN:
- break;
- case S_STRING:
- str = sym_get_string_value(sym);
- str = sym_escape_string_value(str);
- printer->print_symbol(fp, sym, str, printer_arg);
- free((void *)str);
- break;
- default:
- str = sym_get_string_value(sym);
- printer->print_symbol(fp, sym, str, printer_arg);
- }
-}
-
-static void
-conf_write_heading(FILE *fp, struct conf_printer *printer, void *printer_arg)
-{
- char buf[256];
-
- snprintf(buf, sizeof(buf),
- "\n"
- "Automatically generated file; DO NOT EDIT.\n"
- "%s\n",
- rootmenu.prompt->text);
-
- printer->print_comment(fp, buf, printer_arg);
-}
-
-/*
- * Write out a minimal config.
- * All values that has default values are skipped as this is redundant.
- */
-int conf_write_defconfig(const char *filename)
-{
- struct symbol *sym;
- struct menu *menu;
- FILE *out;
-
- out = fopen(filename, "w");
- if (!out)
- return 1;
-
- sym_clear_all_valid();
-
- /* Traverse all menus to find all relevant symbols */
- menu = rootmenu.list;
-
- while (menu != NULL)
- {
- sym = menu->sym;
- if (sym == NULL) {
- if (!menu_is_visible(menu))
- goto next_menu;
- } else if (!sym_is_choice(sym)) {
- sym_calc_value(sym);
- if (!(sym->flags & SYMBOL_WRITE))
- goto next_menu;
- sym->flags &= ~SYMBOL_WRITE;
- /* If we cannot change the symbol - skip */
- if (!sym_is_changable(sym))
- goto next_menu;
- /* If symbol equals to default value - skip */
- if (strcmp(sym_get_string_value(sym), sym_get_string_default(sym)) == 0)
- goto next_menu;
-
- /*
- * If symbol is a choice value and equals to the
- * default for a choice - skip.
- * But only if value is bool and equal to "y" and
- * choice is not "optional".
- * (If choice is "optional" then all values can be "n")
- */
- if (sym_is_choice_value(sym)) {
- struct symbol *cs;
- struct symbol *ds;
-
- cs = prop_get_symbol(sym_get_choice_prop(sym));
- ds = sym_choice_default(cs);
- if (!sym_is_optional(cs) && sym == ds) {
- if ((sym->type == S_BOOLEAN) &&
- sym_get_tristate_value(sym) == yes)
- goto next_menu;
- }
- }
- conf_write_symbol(out, sym, &kconfig_printer_cb, NULL);
- }
-next_menu:
- if (menu->list != NULL) {
- menu = menu->list;
- }
- else if (menu->next != NULL) {
- menu = menu->next;
- } else {
- while ((menu = menu->parent)) {
- if (menu->next != NULL) {
- menu = menu->next;
- break;
- }
- }
- }
- }
- fclose(out);
- return 0;
-}
-
-int conf_write(const char *name)
-{
- FILE *out;
- struct symbol *sym;
- struct menu *menu;
- const char *basename;
- const char *str;
- char dirname[PATH_MAX+1], tmpname[PATH_MAX+1], newname[PATH_MAX+1];
- char *env;
-
- dirname[0] = 0;
- if (name && name[0]) {
- struct stat st;
- char *slash;
-
- if (!stat(name, &st) && S_ISDIR(st.st_mode)) {
- strcpy(dirname, name);
- strcat(dirname, "/");
- basename = conf_get_configname();
- } else if ((slash = strrchr(name, '/'))) {
- int size = slash - name + 1;
- memcpy(dirname, name, size);
- dirname[size] = 0;
- if (slash[1])
- basename = slash + 1;
- else
- basename = conf_get_configname();
- } else
- basename = name;
- } else
- basename = conf_get_configname();
-
- sprintf(newname, "%s%s", dirname, basename);
- env = getenv("KCONFIG_OVERWRITECONFIG");
- if (!env || !*env) {
- sprintf(tmpname, "%s.tmpconfig.%d", newname, (int)getpid());
- out = fopen(tmpname, "w");
- } else {
- *tmpname = 0;
- out = fopen(newname, "w");
- }
- if (!out)
- return 1;
-
- conf_write_heading(out, &kconfig_printer_cb, NULL);
-
- if (!conf_get_changed())
- sym_clear_all_valid();
-
- menu = rootmenu.list;
- while (menu) {
- sym = menu->sym;
- if (!sym) {
- if (!menu_is_visible(menu))
- goto next;
- str = menu_get_prompt(menu);
- fprintf(out, "\n"
- "#\n"
- "# %s\n"
- "#\n", str);
- } else if (!(sym->flags & SYMBOL_CHOICE)) {
- sym_calc_value(sym);
- if (!(sym->flags & SYMBOL_WRITE))
- goto next;
- sym->flags &= ~SYMBOL_WRITE;
-
- conf_write_symbol(out, sym, &kconfig_printer_cb, NULL);
- }
-
-next:
- if (menu->list) {
- menu = menu->list;
- continue;
- }
- if (menu->next)
- menu = menu->next;
- else while ((menu = menu->parent)) {
- if (menu->next) {
- menu = menu->next;
- break;
- }
- }
- }
- fclose(out);
-
- if (*tmpname) {
- strcat(dirname, basename);
- strcat(dirname, ".old");
- rename(newname, dirname);
- if (rename(tmpname, newname))
- return 1;
- }
-
- conf_message(_("configuration written to %s"), newname);
-
- sym_set_change_count(0);
-
- return 0;
-}
-
-static int conf_split_config(void)
-{
- const char *name;
- char path[PATH_MAX+1];
- char *s, *d, c;
- struct symbol *sym;
- struct stat sb;
- int res, i, fd;
-
- name = conf_get_autoconfig_name();
- conf_read_simple(name, S_DEF_AUTO);
- sym_calc_value(modules_sym);
-
- if (chdir("include/config"))
- return 1;
-
- res = 0;
- for_all_symbols(i, sym) {
- sym_calc_value(sym);
- if ((sym->flags & SYMBOL_AUTO) || !sym->name)
- continue;
- if (sym->flags & SYMBOL_WRITE) {
- if (sym->flags & SYMBOL_DEF_AUTO) {
- /*
- * symbol has old and new value,
- * so compare them...
- */
- switch (sym->type) {
- case S_BOOLEAN:
- case S_TRISTATE:
- if (sym_get_tristate_value(sym) ==
- sym->def[S_DEF_AUTO].tri)
- continue;
- break;
- case S_STRING:
- case S_HEX:
- case S_INT:
- if (!strcmp(sym_get_string_value(sym),
- sym->def[S_DEF_AUTO].val))
- continue;
- break;
- default:
- break;
- }
- } else {
- /*
- * If there is no old value, only 'no' (unset)
- * is allowed as new value.
- */
- switch (sym->type) {
- case S_BOOLEAN:
- case S_TRISTATE:
- if (sym_get_tristate_value(sym) == no)
- continue;
- break;
- default:
- break;
- }
- }
- } else if (!(sym->flags & SYMBOL_DEF_AUTO))
- /* There is neither an old nor a new value. */
- continue;
- /* else
- * There is an old value, but no new value ('no' (unset)
- * isn't saved in auto.conf, so the old value is always
- * different from 'no').
- */
-
- /* Replace all '_' and append ".h" */
- s = sym->name;
- d = path;
- while ((c = *s++)) {
- c = tolower(c);
- *d++ = (c == '_') ? '/' : c;
- }
- strcpy(d, ".h");
-
- /* Assume directory path already exists. */
- fd = open(path, O_WRONLY | O_CREAT | O_TRUNC, 0644);
- if (fd == -1) {
- if (errno != ENOENT) {
- res = 1;
- break;
- }
- /*
- * Create directory components,
- * unless they exist already.
- */
- d = path;
- while ((d = strchr(d, '/'))) {
- *d = 0;
- if (stat(path, &sb) && mkdir(path, 0755)) {
- res = 1;
- goto out;
- }
- *d++ = '/';
- }
- /* Try it again. */
- fd = open(path, O_WRONLY | O_CREAT | O_TRUNC, 0644);
- if (fd == -1) {
- res = 1;
- break;
- }
- }
- close(fd);
- }
-out:
- if (chdir("../.."))
- return 1;
-
- return res;
-}
-
-int conf_write_autoconf(void)
-{
- struct symbol *sym;
- const char *name;
- FILE *out, *tristate, *out_h;
- int i;
-
- sym_clear_all_valid();
-
- file_write_dep("include/config/auto.conf.cmd");
-
- if (conf_split_config())
- return 1;
-
- out = fopen(".tmpconfig", "w");
- if (!out)
- return 1;
-
- tristate = fopen(".tmpconfig_tristate", "w");
- if (!tristate) {
- fclose(out);
- return 1;
- }
-
- out_h = fopen(".tmpconfig.h", "w");
- if (!out_h) {
- fclose(out);
- fclose(tristate);
- return 1;
- }
-
- conf_write_heading(out, &kconfig_printer_cb, NULL);
-
- conf_write_heading(tristate, &tristate_printer_cb, NULL);
-
- conf_write_heading(out_h, &header_printer_cb, NULL);
-
- /* write symbols to auto.conf, tristate and header files */
- for_all_symbols(i, sym) {
- if (!sym->name) continue;
- if ((sym->flags & SYMBOL_WRITE) ||
- /*
- * If the symbol is disabled by dependency we still want it in auto.conf
- * so that all possible variables are always defined.
- */
- (sym->dir_dep.expr != NULL && sym->dir_dep.tri == no)) {
- conf_write_symbol(out, sym, &kconfig_printer_cb, NULL);
- }
- if (sym->flags & SYMBOL_WRITE) {
- conf_write_symbol(tristate, sym, &tristate_printer_cb, NULL);
- conf_write_symbol(out_h, sym, &header_printer_cb, NULL);
- }
- }
- fclose(out);
- fclose(tristate);
- fclose(out_h);
-
- name = getenv("KCONFIG_AUTOHEADER");
- if (!name)
- name = "include/generated/autoconf.h";
- if (rename(".tmpconfig.h", name))
- return 1;
- name = getenv("KCONFIG_TRISTATE");
- if (!name)
- name = "include/config/tristate.conf";
- if (rename(".tmpconfig_tristate", name))
- return 1;
- name = conf_get_autoconfig_name();
- /*
- * This must be the last step, kbuild has a dependency on auto.conf
- * and this marks the successful completion of the previous steps.
- */
- if (rename(".tmpconfig", name))
- return 1;
-
- return 0;
-}
-
-static int sym_change_count;
-static void (*conf_changed_callback)(void);
-
-void sym_set_change_count(int count)
-{
- int _sym_change_count = sym_change_count;
- sym_change_count = count;
- if (conf_changed_callback &&
- (bool)_sym_change_count != (bool)count)
- conf_changed_callback();
-}
-
-void sym_add_change_count(int count)
-{
- sym_set_change_count(count + sym_change_count);
-}
-
-bool conf_get_changed(void)
-{
- return sym_change_count;
-}
-
-void conf_set_changed_callback(void (*fn)(void))
-{
- conf_changed_callback = fn;
-}
-
-static bool randomize_choice_values(struct symbol *csym)
-{
- struct property *prop;
- struct symbol *sym;
- struct expr *e;
- int cnt, def;
-
- /*
- * If choice is mod then we may have more items selected
- * and if no then no-one.
- * In both cases stop.
- */
- if (csym->curr.tri != yes)
- return false;
-
- prop = sym_get_choice_prop(csym);
-
- /* count entries in choice block */
- cnt = 0;
- expr_list_for_each_sym(prop->expr, e, sym)
- cnt++;
-
- /*
- * find a random value and set it to yes,
- * set the rest to no so we have only one set
- */
- def = (rand() % cnt);
-
- cnt = 0;
- expr_list_for_each_sym(prop->expr, e, sym) {
- if (def == cnt++) {
- sym->def[S_DEF_USER].tri = yes;
- csym->def[S_DEF_USER].val = sym;
- }
- else {
- sym->def[S_DEF_USER].tri = no;
- }
- sym->flags |= SYMBOL_DEF_USER;
- /* clear VALID to get value calculated */
- sym->flags &= ~SYMBOL_VALID;
- }
- csym->flags |= SYMBOL_DEF_USER;
- /* clear VALID to get value calculated */
- csym->flags &= ~(SYMBOL_VALID);
-
- return true;
-}
-
-void set_all_choice_values(struct symbol *csym)
-{
- struct property *prop;
- struct symbol *sym;
- struct expr *e;
-
- prop = sym_get_choice_prop(csym);
-
- /*
- * Set all non-assinged choice values to no
- */
- expr_list_for_each_sym(prop->expr, e, sym) {
- if (!sym_has_value(sym))
- sym->def[S_DEF_USER].tri = no;
- }
- csym->flags |= SYMBOL_DEF_USER;
- /* clear VALID to get value calculated */
- csym->flags &= ~(SYMBOL_VALID | SYMBOL_NEED_SET_CHOICE_VALUES);
-}
-
-bool conf_set_all_new_symbols(enum conf_def_mode mode)
-{
- struct symbol *sym, *csym;
- int i, cnt, pby, pty, ptm; /* pby: probability of boolean = y
- * pty: probability of tristate = y
- * ptm: probability of tristate = m
- */
-
- pby = 50; pty = ptm = 33; /* can't go as the default in switch-case
- * below, otherwise gcc whines about
- * -Wmaybe-uninitialized */
- if (mode == def_random) {
- int n, p[3];
- char *env = getenv("KCONFIG_PROBABILITY");
- n = 0;
- while( env && *env ) {
- char *endp;
- int tmp = strtol( env, &endp, 10 );
- if( tmp >= 0 && tmp <= 100 ) {
- p[n++] = tmp;
- } else {
- errno = ERANGE;
- perror( "KCONFIG_PROBABILITY" );
- exit( 1 );
- }
- env = (*endp == ':') ? endp+1 : endp;
- if( n >=3 ) {
- break;
- }
- }
- switch( n ) {
- case 1:
- pby = p[0]; ptm = pby/2; pty = pby-ptm;
- break;
- case 2:
- pty = p[0]; ptm = p[1]; pby = pty + ptm;
- break;
- case 3:
- pby = p[0]; pty = p[1]; ptm = p[2];
- break;
- }
-
- if( pty+ptm > 100 ) {
- errno = ERANGE;
- perror( "KCONFIG_PROBABILITY" );
- exit( 1 );
- }
- }
- bool has_changed = false;
-
- for_all_symbols(i, sym) {
- if (sym_has_value(sym) || (sym->flags & SYMBOL_VALID))
- continue;
- switch (sym_get_type(sym)) {
- case S_BOOLEAN:
- case S_TRISTATE:
- has_changed = true;
- switch (mode) {
- case def_yes:
- sym->def[S_DEF_USER].tri = yes;
- break;
- case def_mod:
- sym->def[S_DEF_USER].tri = mod;
- break;
- case def_no:
- if (sym->flags & SYMBOL_ALLNOCONFIG_Y)
- sym->def[S_DEF_USER].tri = yes;
- else
- sym->def[S_DEF_USER].tri = no;
- break;
- case def_random:
- sym->def[S_DEF_USER].tri = no;
- cnt = rand() % 100;
- if (sym->type == S_TRISTATE) {
- if (cnt < pty)
- sym->def[S_DEF_USER].tri = yes;
- else if (cnt < (pty+ptm))
- sym->def[S_DEF_USER].tri = mod;
- } else if (cnt < pby)
- sym->def[S_DEF_USER].tri = yes;
- break;
- default:
- continue;
- }
- if (!(sym_is_choice(sym) && mode == def_random))
- sym->flags |= SYMBOL_DEF_USER;
- break;
- default:
- break;
- }
-
- }
-
- sym_clear_all_valid();
-
- /*
- * We have different type of choice blocks.
- * If curr.tri equals to mod then we can select several
- * choice symbols in one block.
- * In this case we do nothing.
- * If curr.tri equals yes then only one symbol can be
- * selected in a choice block and we set it to yes,
- * and the rest to no.
- */
- if (mode != def_random) {
- for_all_symbols(i, csym) {
- if ((sym_is_choice(csym) && !sym_has_value(csym)) ||
- sym_is_choice_value(csym))
- csym->flags |= SYMBOL_NEED_SET_CHOICE_VALUES;
- }
- }
-
- for_all_symbols(i, csym) {
- if (sym_has_value(csym) || !sym_is_choice(csym))
- continue;
-
- sym_calc_value(csym);
- if (mode == def_random)
- has_changed = randomize_choice_values(csym);
- else {
- set_all_choice_values(csym);
- has_changed = true;
- }
- }
-
- return has_changed;
-}
+++ /dev/null
-/*
- * Copyright (C) 2002 Roman Zippel <zippel@linux-m68k.org>
- * Released under the terms of the GNU GPL v2.0.
- */
-
-#include <stdio.h>
-#include <stdlib.h>
-#include <string.h>
-
-#include "lkc.h"
-
-#define DEBUG_EXPR 0
-
-static int expr_eq(struct expr *e1, struct expr *e2);
-static struct expr *expr_eliminate_yn(struct expr *e);
-
-struct expr *expr_alloc_symbol(struct symbol *sym)
-{
- struct expr *e = xcalloc(1, sizeof(*e));
- e->type = E_SYMBOL;
- e->left.sym = sym;
- return e;
-}
-
-struct expr *expr_alloc_one(enum expr_type type, struct expr *ce)
-{
- struct expr *e = xcalloc(1, sizeof(*e));
- e->type = type;
- e->left.expr = ce;
- return e;
-}
-
-struct expr *expr_alloc_two(enum expr_type type, struct expr *e1, struct expr *e2)
-{
- struct expr *e = xcalloc(1, sizeof(*e));
- e->type = type;
- e->left.expr = e1;
- e->right.expr = e2;
- return e;
-}
-
-struct expr *expr_alloc_comp(enum expr_type type, struct symbol *s1, struct symbol *s2)
-{
- struct expr *e = xcalloc(1, sizeof(*e));
- e->type = type;
- e->left.sym = s1;
- e->right.sym = s2;
- return e;
-}
-
-struct expr *expr_alloc_and(struct expr *e1, struct expr *e2)
-{
- if (!e1)
- return e2;
- return e2 ? expr_alloc_two(E_AND, e1, e2) : e1;
-}
-
-struct expr *expr_alloc_or(struct expr *e1, struct expr *e2)
-{
- if (!e1)
- return e2;
- return e2 ? expr_alloc_two(E_OR, e1, e2) : e1;
-}
-
-struct expr *expr_copy(const struct expr *org)
-{
- struct expr *e;
-
- if (!org)
- return NULL;
-
- e = xmalloc(sizeof(*org));
- memcpy(e, org, sizeof(*org));
- switch (org->type) {
- case E_SYMBOL:
- e->left = org->left;
- break;
- case E_NOT:
- e->left.expr = expr_copy(org->left.expr);
- break;
- case E_EQUAL:
- case E_GEQ:
- case E_GTH:
- case E_LEQ:
- case E_LTH:
- case E_UNEQUAL:
- e->left.sym = org->left.sym;
- e->right.sym = org->right.sym;
- break;
- case E_AND:
- case E_OR:
- case E_LIST:
- e->left.expr = expr_copy(org->left.expr);
- e->right.expr = expr_copy(org->right.expr);
- break;
- default:
- printf("can't copy type %d\n", e->type);
- free(e);
- e = NULL;
- break;
- }
-
- return e;
-}
-
-void expr_free(struct expr *e)
-{
- if (!e)
- return;
-
- switch (e->type) {
- case E_SYMBOL:
- break;
- case E_NOT:
- expr_free(e->left.expr);
- return;
- case E_EQUAL:
- case E_GEQ:
- case E_GTH:
- case E_LEQ:
- case E_LTH:
- case E_UNEQUAL:
- break;
- case E_OR:
- case E_AND:
- expr_free(e->left.expr);
- expr_free(e->right.expr);
- break;
- default:
- printf("how to free type %d?\n", e->type);
- break;
- }
- free(e);
-}
-
-static int trans_count;
-
-#define e1 (*ep1)
-#define e2 (*ep2)
-
-static void __expr_eliminate_eq(enum expr_type type, struct expr **ep1, struct expr **ep2)
-{
- if (e1->type == type) {
- __expr_eliminate_eq(type, &e1->left.expr, &e2);
- __expr_eliminate_eq(type, &e1->right.expr, &e2);
- return;
- }
- if (e2->type == type) {
- __expr_eliminate_eq(type, &e1, &e2->left.expr);
- __expr_eliminate_eq(type, &e1, &e2->right.expr);
- return;
- }
- if (e1->type == E_SYMBOL && e2->type == E_SYMBOL &&
- e1->left.sym == e2->left.sym &&
- (e1->left.sym == &symbol_yes || e1->left.sym == &symbol_no))
- return;
- if (!expr_eq(e1, e2))
- return;
- trans_count++;
- expr_free(e1); expr_free(e2);
- switch (type) {
- case E_OR:
- e1 = expr_alloc_symbol(&symbol_no);
- e2 = expr_alloc_symbol(&symbol_no);
- break;
- case E_AND:
- e1 = expr_alloc_symbol(&symbol_yes);
- e2 = expr_alloc_symbol(&symbol_yes);
- break;
- default:
- ;
- }
-}
-
-void expr_eliminate_eq(struct expr **ep1, struct expr **ep2)
-{
- if (!e1 || !e2)
- return;
- switch (e1->type) {
- case E_OR:
- case E_AND:
- __expr_eliminate_eq(e1->type, ep1, ep2);
- default:
- ;
- }
- if (e1->type != e2->type) switch (e2->type) {
- case E_OR:
- case E_AND:
- __expr_eliminate_eq(e2->type, ep1, ep2);
- default:
- ;
- }
- e1 = expr_eliminate_yn(e1);
- e2 = expr_eliminate_yn(e2);
-}
-
-#undef e1
-#undef e2
-
-static int expr_eq(struct expr *e1, struct expr *e2)
-{
- int res, old_count;
-
- if (e1->type != e2->type)
- return 0;
- switch (e1->type) {
- case E_EQUAL:
- case E_GEQ:
- case E_GTH:
- case E_LEQ:
- case E_LTH:
- case E_UNEQUAL:
- return e1->left.sym == e2->left.sym && e1->right.sym == e2->right.sym;
- case E_SYMBOL:
- return e1->left.sym == e2->left.sym;
- case E_NOT:
- return expr_eq(e1->left.expr, e2->left.expr);
- case E_AND:
- case E_OR:
- e1 = expr_copy(e1);
- e2 = expr_copy(e2);
- old_count = trans_count;
- expr_eliminate_eq(&e1, &e2);
- res = (e1->type == E_SYMBOL && e2->type == E_SYMBOL &&
- e1->left.sym == e2->left.sym);
- expr_free(e1);
- expr_free(e2);
- trans_count = old_count;
- return res;
- case E_LIST:
- case E_RANGE:
- case E_NONE:
- /* panic */;
- }
-
- if (DEBUG_EXPR) {
- expr_fprint(e1, stdout);
- printf(" = ");
- expr_fprint(e2, stdout);
- printf(" ?\n");
- }
-
- return 0;
-}
-
-static struct expr *expr_eliminate_yn(struct expr *e)
-{
- struct expr *tmp;
-
- if (e) switch (e->type) {
- case E_AND:
- e->left.expr = expr_eliminate_yn(e->left.expr);
- e->right.expr = expr_eliminate_yn(e->right.expr);
- if (e->left.expr->type == E_SYMBOL) {
- if (e->left.expr->left.sym == &symbol_no) {
- expr_free(e->left.expr);
- expr_free(e->right.expr);
- e->type = E_SYMBOL;
- e->left.sym = &symbol_no;
- e->right.expr = NULL;
- return e;
- } else if (e->left.expr->left.sym == &symbol_yes) {
- free(e->left.expr);
- tmp = e->right.expr;
- *e = *(e->right.expr);
- free(tmp);
- return e;
- }
- }
- if (e->right.expr->type == E_SYMBOL) {
- if (e->right.expr->left.sym == &symbol_no) {
- expr_free(e->left.expr);
- expr_free(e->right.expr);
- e->type = E_SYMBOL;
- e->left.sym = &symbol_no;
- e->right.expr = NULL;
- return e;
- } else if (e->right.expr->left.sym == &symbol_yes) {
- free(e->right.expr);
- tmp = e->left.expr;
- *e = *(e->left.expr);
- free(tmp);
- return e;
- }
- }
- break;
- case E_OR:
- e->left.expr = expr_eliminate_yn(e->left.expr);
- e->right.expr = expr_eliminate_yn(e->right.expr);
- if (e->left.expr->type == E_SYMBOL) {
- if (e->left.expr->left.sym == &symbol_no) {
- free(e->left.expr);
- tmp = e->right.expr;
- *e = *(e->right.expr);
- free(tmp);
- return e;
- } else if (e->left.expr->left.sym == &symbol_yes) {
- expr_free(e->left.expr);
- expr_free(e->right.expr);
- e->type = E_SYMBOL;
- e->left.sym = &symbol_yes;
- e->right.expr = NULL;
- return e;
- }
- }
- if (e->right.expr->type == E_SYMBOL) {
- if (e->right.expr->left.sym == &symbol_no) {
- free(e->right.expr);
- tmp = e->left.expr;
- *e = *(e->left.expr);
- free(tmp);
- return e;
- } else if (e->right.expr->left.sym == &symbol_yes) {
- expr_free(e->left.expr);
- expr_free(e->right.expr);
- e->type = E_SYMBOL;
- e->left.sym = &symbol_yes;
- e->right.expr = NULL;
- return e;
- }
- }
- break;
- default:
- ;
- }
- return e;
-}
-
-/*
- * bool FOO!=n => FOO
- */
-struct expr *expr_trans_bool(struct expr *e)
-{
- if (!e)
- return NULL;
- switch (e->type) {
- case E_AND:
- case E_OR:
- case E_NOT:
- e->left.expr = expr_trans_bool(e->left.expr);
- e->right.expr = expr_trans_bool(e->right.expr);
- break;
- case E_UNEQUAL:
- // FOO!=n -> FOO
- if (e->left.sym->type == S_TRISTATE) {
- if (e->right.sym == &symbol_no) {
- e->type = E_SYMBOL;
- e->right.sym = NULL;
- }
- }
- break;
- default:
- ;
- }
- return e;
-}
-
-/*
- * e1 || e2 -> ?
- */
-static struct expr *expr_join_or(struct expr *e1, struct expr *e2)
-{
- struct expr *tmp;
- struct symbol *sym1, *sym2;
-
- if (expr_eq(e1, e2))
- return expr_copy(e1);
- if (e1->type != E_EQUAL && e1->type != E_UNEQUAL && e1->type != E_SYMBOL && e1->type != E_NOT)
- return NULL;
- if (e2->type != E_EQUAL && e2->type != E_UNEQUAL && e2->type != E_SYMBOL && e2->type != E_NOT)
- return NULL;
- if (e1->type == E_NOT) {
- tmp = e1->left.expr;
- if (tmp->type != E_EQUAL && tmp->type != E_UNEQUAL && tmp->type != E_SYMBOL)
- return NULL;
- sym1 = tmp->left.sym;
- } else
- sym1 = e1->left.sym;
- if (e2->type == E_NOT) {
- if (e2->left.expr->type != E_SYMBOL)
- return NULL;
- sym2 = e2->left.expr->left.sym;
- } else
- sym2 = e2->left.sym;
- if (sym1 != sym2)
- return NULL;
- if (sym1->type != S_BOOLEAN && sym1->type != S_TRISTATE)
- return NULL;
- if (sym1->type == S_TRISTATE) {
- if (e1->type == E_EQUAL && e2->type == E_EQUAL &&
- ((e1->right.sym == &symbol_yes && e2->right.sym == &symbol_mod) ||
- (e1->right.sym == &symbol_mod && e2->right.sym == &symbol_yes))) {
- // (a='y') || (a='m') -> (a!='n')
- return expr_alloc_comp(E_UNEQUAL, sym1, &symbol_no);
- }
- if (e1->type == E_EQUAL && e2->type == E_EQUAL &&
- ((e1->right.sym == &symbol_yes && e2->right.sym == &symbol_no) ||
- (e1->right.sym == &symbol_no && e2->right.sym == &symbol_yes))) {
- // (a='y') || (a='n') -> (a!='m')
- return expr_alloc_comp(E_UNEQUAL, sym1, &symbol_mod);
- }
- if (e1->type == E_EQUAL && e2->type == E_EQUAL &&
- ((e1->right.sym == &symbol_mod && e2->right.sym == &symbol_no) ||
- (e1->right.sym == &symbol_no && e2->right.sym == &symbol_mod))) {
- // (a='m') || (a='n') -> (a!='y')
- return expr_alloc_comp(E_UNEQUAL, sym1, &symbol_yes);
- }
- }
- if (sym1->type == S_BOOLEAN && sym1 == sym2) {
- if ((e1->type == E_NOT && e1->left.expr->type == E_SYMBOL && e2->type == E_SYMBOL) ||
- (e2->type == E_NOT && e2->left.expr->type == E_SYMBOL && e1->type == E_SYMBOL))
- return expr_alloc_symbol(&symbol_yes);
- }
-
- if (DEBUG_EXPR) {
- printf("optimize (");
- expr_fprint(e1, stdout);
- printf(") || (");
- expr_fprint(e2, stdout);
- printf(")?\n");
- }
- return NULL;
-}
-
-static struct expr *expr_join_and(struct expr *e1, struct expr *e2)
-{
- struct expr *tmp;
- struct symbol *sym1, *sym2;
-
- if (expr_eq(e1, e2))
- return expr_copy(e1);
- if (e1->type != E_EQUAL && e1->type != E_UNEQUAL && e1->type != E_SYMBOL && e1->type != E_NOT)
- return NULL;
- if (e2->type != E_EQUAL && e2->type != E_UNEQUAL && e2->type != E_SYMBOL && e2->type != E_NOT)
- return NULL;
- if (e1->type == E_NOT) {
- tmp = e1->left.expr;
- if (tmp->type != E_EQUAL && tmp->type != E_UNEQUAL && tmp->type != E_SYMBOL)
- return NULL;
- sym1 = tmp->left.sym;
- } else
- sym1 = e1->left.sym;
- if (e2->type == E_NOT) {
- if (e2->left.expr->type != E_SYMBOL)
- return NULL;
- sym2 = e2->left.expr->left.sym;
- } else
- sym2 = e2->left.sym;
- if (sym1 != sym2)
- return NULL;
- if (sym1->type != S_BOOLEAN && sym1->type != S_TRISTATE)
- return NULL;
-
- if ((e1->type == E_SYMBOL && e2->type == E_EQUAL && e2->right.sym == &symbol_yes) ||
- (e2->type == E_SYMBOL && e1->type == E_EQUAL && e1->right.sym == &symbol_yes))
- // (a) && (a='y') -> (a='y')
- return expr_alloc_comp(E_EQUAL, sym1, &symbol_yes);
-
- if ((e1->type == E_SYMBOL && e2->type == E_UNEQUAL && e2->right.sym == &symbol_no) ||
- (e2->type == E_SYMBOL && e1->type == E_UNEQUAL && e1->right.sym == &symbol_no))
- // (a) && (a!='n') -> (a)
- return expr_alloc_symbol(sym1);
-
- if ((e1->type == E_SYMBOL && e2->type == E_UNEQUAL && e2->right.sym == &symbol_mod) ||
- (e2->type == E_SYMBOL && e1->type == E_UNEQUAL && e1->right.sym == &symbol_mod))
- // (a) && (a!='m') -> (a='y')
- return expr_alloc_comp(E_EQUAL, sym1, &symbol_yes);
-
- if (sym1->type == S_TRISTATE) {
- if (e1->type == E_EQUAL && e2->type == E_UNEQUAL) {
- // (a='b') && (a!='c') -> 'b'='c' ? 'n' : a='b'
- sym2 = e1->right.sym;
- if ((e2->right.sym->flags & SYMBOL_CONST) && (sym2->flags & SYMBOL_CONST))
- return sym2 != e2->right.sym ? expr_alloc_comp(E_EQUAL, sym1, sym2)
- : expr_alloc_symbol(&symbol_no);
- }
- if (e1->type == E_UNEQUAL && e2->type == E_EQUAL) {
- // (a='b') && (a!='c') -> 'b'='c' ? 'n' : a='b'
- sym2 = e2->right.sym;
- if ((e1->right.sym->flags & SYMBOL_CONST) && (sym2->flags & SYMBOL_CONST))
- return sym2 != e1->right.sym ? expr_alloc_comp(E_EQUAL, sym1, sym2)
- : expr_alloc_symbol(&symbol_no);
- }
- if (e1->type == E_UNEQUAL && e2->type == E_UNEQUAL &&
- ((e1->right.sym == &symbol_yes && e2->right.sym == &symbol_no) ||
- (e1->right.sym == &symbol_no && e2->right.sym == &symbol_yes)))
- // (a!='y') && (a!='n') -> (a='m')
- return expr_alloc_comp(E_EQUAL, sym1, &symbol_mod);
-
- if (e1->type == E_UNEQUAL && e2->type == E_UNEQUAL &&
- ((e1->right.sym == &symbol_yes && e2->right.sym == &symbol_mod) ||
- (e1->right.sym == &symbol_mod && e2->right.sym == &symbol_yes)))
- // (a!='y') && (a!='m') -> (a='n')
- return expr_alloc_comp(E_EQUAL, sym1, &symbol_no);
-
- if (e1->type == E_UNEQUAL && e2->type == E_UNEQUAL &&
- ((e1->right.sym == &symbol_mod && e2->right.sym == &symbol_no) ||
- (e1->right.sym == &symbol_no && e2->right.sym == &symbol_mod)))
- // (a!='m') && (a!='n') -> (a='m')
- return expr_alloc_comp(E_EQUAL, sym1, &symbol_yes);
-
- if ((e1->type == E_SYMBOL && e2->type == E_EQUAL && e2->right.sym == &symbol_mod) ||
- (e2->type == E_SYMBOL && e1->type == E_EQUAL && e1->right.sym == &symbol_mod) ||
- (e1->type == E_SYMBOL && e2->type == E_UNEQUAL && e2->right.sym == &symbol_yes) ||
- (e2->type == E_SYMBOL && e1->type == E_UNEQUAL && e1->right.sym == &symbol_yes))
- return NULL;
- }
-
- if (DEBUG_EXPR) {
- printf("optimize (");
- expr_fprint(e1, stdout);
- printf(") && (");
- expr_fprint(e2, stdout);
- printf(")?\n");
- }
- return NULL;
-}
-
-static void expr_eliminate_dups1(enum expr_type type, struct expr **ep1, struct expr **ep2)
-{
-#define e1 (*ep1)
-#define e2 (*ep2)
- struct expr *tmp;
-
- if (e1->type == type) {
- expr_eliminate_dups1(type, &e1->left.expr, &e2);
- expr_eliminate_dups1(type, &e1->right.expr, &e2);
- return;
- }
- if (e2->type == type) {
- expr_eliminate_dups1(type, &e1, &e2->left.expr);
- expr_eliminate_dups1(type, &e1, &e2->right.expr);
- return;
- }
- if (e1 == e2)
- return;
-
- switch (e1->type) {
- case E_OR: case E_AND:
- expr_eliminate_dups1(e1->type, &e1, &e1);
- default:
- ;
- }
-
- switch (type) {
- case E_OR:
- tmp = expr_join_or(e1, e2);
- if (tmp) {
- expr_free(e1); expr_free(e2);
- e1 = expr_alloc_symbol(&symbol_no);
- e2 = tmp;
- trans_count++;
- }
- break;
- case E_AND:
- tmp = expr_join_and(e1, e2);
- if (tmp) {
- expr_free(e1); expr_free(e2);
- e1 = expr_alloc_symbol(&symbol_yes);
- e2 = tmp;
- trans_count++;
- }
- break;
- default:
- ;
- }
-#undef e1
-#undef e2
-}
-
-struct expr *expr_eliminate_dups(struct expr *e)
-{
- int oldcount;
- if (!e)
- return e;
-
- oldcount = trans_count;
- while (1) {
- trans_count = 0;
- switch (e->type) {
- case E_OR: case E_AND:
- expr_eliminate_dups1(e->type, &e, &e);
- default:
- ;
- }
- if (!trans_count)
- break;
- e = expr_eliminate_yn(e);
- }
- trans_count = oldcount;
- return e;
-}
-
-struct expr *expr_transform(struct expr *e)
-{
- struct expr *tmp;
-
- if (!e)
- return NULL;
- switch (e->type) {
- case E_EQUAL:
- case E_GEQ:
- case E_GTH:
- case E_LEQ:
- case E_LTH:
- case E_UNEQUAL:
- case E_SYMBOL:
- case E_LIST:
- break;
- default:
- e->left.expr = expr_transform(e->left.expr);
- e->right.expr = expr_transform(e->right.expr);
- }
-
- switch (e->type) {
- case E_EQUAL:
- if (e->left.sym->type != S_BOOLEAN)
- break;
- if (e->right.sym == &symbol_no) {
- e->type = E_NOT;
- e->left.expr = expr_alloc_symbol(e->left.sym);
- e->right.sym = NULL;
- break;
- }
- if (e->right.sym == &symbol_mod) {
- printf("boolean symbol %s tested for 'm'? test forced to 'n'\n", e->left.sym->name);
- e->type = E_SYMBOL;
- e->left.sym = &symbol_no;
- e->right.sym = NULL;
- break;
- }
- if (e->right.sym == &symbol_yes) {
- e->type = E_SYMBOL;
- e->right.sym = NULL;
- break;
- }
- break;
- case E_UNEQUAL:
- if (e->left.sym->type != S_BOOLEAN)
- break;
- if (e->right.sym == &symbol_no) {
- e->type = E_SYMBOL;
- e->right.sym = NULL;
- break;
- }
- if (e->right.sym == &symbol_mod) {
- printf("boolean symbol %s tested for 'm'? test forced to 'y'\n", e->left.sym->name);
- e->type = E_SYMBOL;
- e->left.sym = &symbol_yes;
- e->right.sym = NULL;
- break;
- }
- if (e->right.sym == &symbol_yes) {
- e->type = E_NOT;
- e->left.expr = expr_alloc_symbol(e->left.sym);
- e->right.sym = NULL;
- break;
- }
- break;
- case E_NOT:
- switch (e->left.expr->type) {
- case E_NOT:
- // !!a -> a
- tmp = e->left.expr->left.expr;
- free(e->left.expr);
- free(e);
- e = tmp;
- e = expr_transform(e);
- break;
- case E_EQUAL:
- case E_UNEQUAL:
- // !a='x' -> a!='x'
- tmp = e->left.expr;
- free(e);
- e = tmp;
- e->type = e->type == E_EQUAL ? E_UNEQUAL : E_EQUAL;
- break;
- case E_LEQ:
- case E_GEQ:
- // !a<='x' -> a>'x'
- tmp = e->left.expr;
- free(e);
- e = tmp;
- e->type = e->type == E_LEQ ? E_GTH : E_LTH;
- break;
- case E_LTH:
- case E_GTH:
- // !a<'x' -> a>='x'
- tmp = e->left.expr;
- free(e);
- e = tmp;
- e->type = e->type == E_LTH ? E_GEQ : E_LEQ;
- break;
- case E_OR:
- // !(a || b) -> !a && !b
- tmp = e->left.expr;
- e->type = E_AND;
- e->right.expr = expr_alloc_one(E_NOT, tmp->right.expr);
- tmp->type = E_NOT;
- tmp->right.expr = NULL;
- e = expr_transform(e);
- break;
- case E_AND:
- // !(a && b) -> !a || !b
- tmp = e->left.expr;
- e->type = E_OR;
- e->right.expr = expr_alloc_one(E_NOT, tmp->right.expr);
- tmp->type = E_NOT;
- tmp->right.expr = NULL;
- e = expr_transform(e);
- break;
- case E_SYMBOL:
- if (e->left.expr->left.sym == &symbol_yes) {
- // !'y' -> 'n'
- tmp = e->left.expr;
- free(e);
- e = tmp;
- e->type = E_SYMBOL;
- e->left.sym = &symbol_no;
- break;
- }
- if (e->left.expr->left.sym == &symbol_mod) {
- // !'m' -> 'm'
- tmp = e->left.expr;
- free(e);
- e = tmp;
- e->type = E_SYMBOL;
- e->left.sym = &symbol_mod;
- break;
- }
- if (e->left.expr->left.sym == &symbol_no) {
- // !'n' -> 'y'
- tmp = e->left.expr;
- free(e);
- e = tmp;
- e->type = E_SYMBOL;
- e->left.sym = &symbol_yes;
- break;
- }
- break;
- default:
- ;
- }
- break;
- default:
- ;
- }
- return e;
-}
-
-int expr_contains_symbol(struct expr *dep, struct symbol *sym)
-{
- if (!dep)
- return 0;
-
- switch (dep->type) {
- case E_AND:
- case E_OR:
- return expr_contains_symbol(dep->left.expr, sym) ||
- expr_contains_symbol(dep->right.expr, sym);
- case E_SYMBOL:
- return dep->left.sym == sym;
- case E_EQUAL:
- case E_GEQ:
- case E_GTH:
- case E_LEQ:
- case E_LTH:
- case E_UNEQUAL:
- return dep->left.sym == sym ||
- dep->right.sym == sym;
- case E_NOT:
- return expr_contains_symbol(dep->left.expr, sym);
- default:
- ;
- }
- return 0;
-}
-
-bool expr_depends_symbol(struct expr *dep, struct symbol *sym)
-{
- if (!dep)
- return false;
-
- switch (dep->type) {
- case E_AND:
- return expr_depends_symbol(dep->left.expr, sym) ||
- expr_depends_symbol(dep->right.expr, sym);
- case E_SYMBOL:
- return dep->left.sym == sym;
- case E_EQUAL:
- if (dep->left.sym == sym) {
- if (dep->right.sym == &symbol_yes || dep->right.sym == &symbol_mod)
- return true;
- }
- break;
- case E_UNEQUAL:
- if (dep->left.sym == sym) {
- if (dep->right.sym == &symbol_no)
- return true;
- }
- break;
- default:
- ;
- }
- return false;
-}
-
-struct expr *expr_trans_compare(struct expr *e, enum expr_type type, struct symbol *sym)
-{
- struct expr *e1, *e2;
-
- if (!e) {
- e = expr_alloc_symbol(sym);
- if (type == E_UNEQUAL)
- e = expr_alloc_one(E_NOT, e);
- return e;
- }
- switch (e->type) {
- case E_AND:
- e1 = expr_trans_compare(e->left.expr, E_EQUAL, sym);
- e2 = expr_trans_compare(e->right.expr, E_EQUAL, sym);
- if (sym == &symbol_yes)
- e = expr_alloc_two(E_AND, e1, e2);
- if (sym == &symbol_no)
- e = expr_alloc_two(E_OR, e1, e2);
- if (type == E_UNEQUAL)
- e = expr_alloc_one(E_NOT, e);
- return e;
- case E_OR:
- e1 = expr_trans_compare(e->left.expr, E_EQUAL, sym);
- e2 = expr_trans_compare(e->right.expr, E_EQUAL, sym);
- if (sym == &symbol_yes)
- e = expr_alloc_two(E_OR, e1, e2);
- if (sym == &symbol_no)
- e = expr_alloc_two(E_AND, e1, e2);
- if (type == E_UNEQUAL)
- e = expr_alloc_one(E_NOT, e);
- return e;
- case E_NOT:
- return expr_trans_compare(e->left.expr, type == E_EQUAL ? E_UNEQUAL : E_EQUAL, sym);
- case E_UNEQUAL:
- case E_LTH:
- case E_LEQ:
- case E_GTH:
- case E_GEQ:
- case E_EQUAL:
- if (type == E_EQUAL) {
- if (sym == &symbol_yes)
- return expr_copy(e);
- if (sym == &symbol_mod)
- return expr_alloc_symbol(&symbol_no);
- if (sym == &symbol_no)
- return expr_alloc_one(E_NOT, expr_copy(e));
- } else {
- if (sym == &symbol_yes)
- return expr_alloc_one(E_NOT, expr_copy(e));
- if (sym == &symbol_mod)
- return expr_alloc_symbol(&symbol_yes);
- if (sym == &symbol_no)
- return expr_copy(e);
- }
- break;
- case E_SYMBOL:
- return expr_alloc_comp(type, e->left.sym, sym);
- case E_LIST:
- case E_RANGE:
- case E_NONE:
- /* panic */;
- }
- return NULL;
-}
-
-enum string_value_kind {
- k_string,
- k_signed,
- k_unsigned,
- k_invalid
-};
-
-union string_value {
- unsigned long long u;
- signed long long s;
-};
-
-static enum string_value_kind expr_parse_string(const char *str,
- enum symbol_type type,
- union string_value *val)
-{
- char *tail;
- enum string_value_kind kind;
-
- errno = 0;
- switch (type) {
- case S_BOOLEAN:
- case S_TRISTATE:
- return k_string;
- case S_INT:
- val->s = strtoll(str, &tail, 10);
- kind = k_signed;
- break;
- case S_HEX:
- val->u = strtoull(str, &tail, 16);
- kind = k_unsigned;
- break;
- case S_STRING:
- case S_UNKNOWN:
- val->s = strtoll(str, &tail, 0);
- kind = k_signed;
- break;
- default:
- return k_invalid;
- }
- return !errno && !*tail && tail > str && isxdigit(tail[-1])
- ? kind : k_string;
-}
-
-tristate expr_calc_value(struct expr *e)
-{
- tristate val1, val2;
- const char *str1, *str2;
- enum string_value_kind k1 = k_string, k2 = k_string;
- union string_value lval = {}, rval = {};
- int res;
-
- if (!e)
- return yes;
-
- switch (e->type) {
- case E_SYMBOL:
- sym_calc_value(e->left.sym);
- return e->left.sym->curr.tri;
- case E_AND:
- val1 = expr_calc_value(e->left.expr);
- val2 = expr_calc_value(e->right.expr);
- return EXPR_AND(val1, val2);
- case E_OR:
- val1 = expr_calc_value(e->left.expr);
- val2 = expr_calc_value(e->right.expr);
- return EXPR_OR(val1, val2);
- case E_NOT:
- val1 = expr_calc_value(e->left.expr);
- return EXPR_NOT(val1);
- case E_EQUAL:
- case E_GEQ:
- case E_GTH:
- case E_LEQ:
- case E_LTH:
- case E_UNEQUAL:
- break;
- default:
- printf("expr_calc_value: %d?\n", e->type);
- return no;
- }
-
- sym_calc_value(e->left.sym);
- sym_calc_value(e->right.sym);
- str1 = sym_get_string_value(e->left.sym);
- str2 = sym_get_string_value(e->right.sym);
-
- if (e->left.sym->type != S_STRING || e->right.sym->type != S_STRING) {
- k1 = expr_parse_string(str1, e->left.sym->type, &lval);
- k2 = expr_parse_string(str2, e->right.sym->type, &rval);
- }
-
- if (k1 == k_string || k2 == k_string)
- res = strcmp(str1, str2);
- else if (k1 == k_invalid || k2 == k_invalid) {
- if (e->type != E_EQUAL && e->type != E_UNEQUAL) {
- printf("Cannot compare \"%s\" and \"%s\"\n", str1, str2);
- return no;
- }
- res = strcmp(str1, str2);
- } else if (k1 == k_unsigned || k2 == k_unsigned)
- res = (lval.u > rval.u) - (lval.u < rval.u);
- else /* if (k1 == k_signed && k2 == k_signed) */
- res = (lval.s > rval.s) - (lval.s < rval.s);
-
- switch(e->type) {
- case E_EQUAL:
- return res ? no : yes;
- case E_GEQ:
- return res >= 0 ? yes : no;
- case E_GTH:
- return res > 0 ? yes : no;
- case E_LEQ:
- return res <= 0 ? yes : no;
- case E_LTH:
- return res < 0 ? yes : no;
- case E_UNEQUAL:
- return res ? yes : no;
- default:
- printf("expr_calc_value: relation %d?\n", e->type);
- return no;
- }
-}
-
-static int expr_compare_type(enum expr_type t1, enum expr_type t2)
-{
- if (t1 == t2)
- return 0;
- switch (t1) {
- case E_LEQ:
- case E_LTH:
- case E_GEQ:
- case E_GTH:
- if (t2 == E_EQUAL || t2 == E_UNEQUAL)
- return 1;
- case E_EQUAL:
- case E_UNEQUAL:
- if (t2 == E_NOT)
- return 1;
- case E_NOT:
- if (t2 == E_AND)
- return 1;
- case E_AND:
- if (t2 == E_OR)
- return 1;
- case E_OR:
- if (t2 == E_LIST)
- return 1;
- case E_LIST:
- if (t2 == 0)
- return 1;
- default:
- return -1;
- }
- printf("[%dgt%d?]", t1, t2);
- return 0;
-}
-
-static inline struct expr *
-expr_get_leftmost_symbol(const struct expr *e)
-{
-
- if (e == NULL)
- return NULL;
-
- while (e->type != E_SYMBOL)
- e = e->left.expr;
-
- return expr_copy(e);
-}
-
-/*
- * Given expression `e1' and `e2', returns the leaf of the longest
- * sub-expression of `e1' not containing 'e2.
- */
-struct expr *expr_simplify_unmet_dep(struct expr *e1, struct expr *e2)
-{
- struct expr *ret;
-
- switch (e1->type) {
- case E_OR:
- return expr_alloc_and(
- expr_simplify_unmet_dep(e1->left.expr, e2),
- expr_simplify_unmet_dep(e1->right.expr, e2));
- case E_AND: {
- struct expr *e;
- e = expr_alloc_and(expr_copy(e1), expr_copy(e2));
- e = expr_eliminate_dups(e);
- ret = (!expr_eq(e, e1)) ? e1 : NULL;
- expr_free(e);
- break;
- }
- default:
- ret = e1;
- break;
- }
-
- return expr_get_leftmost_symbol(ret);
-}
-
-void expr_print(struct expr *e, void (*fn)(void *, struct symbol *, const char *), void *data, int prevtoken)
-{
- if (!e) {
- fn(data, NULL, "y");
- return;
- }
-
- if (expr_compare_type(prevtoken, e->type) > 0)
- fn(data, NULL, "(");
- switch (e->type) {
- case E_SYMBOL:
- if (e->left.sym->name)
- fn(data, e->left.sym, e->left.sym->name);
- else
- fn(data, NULL, "<choice>");
- break;
- case E_NOT:
- fn(data, NULL, "!");
- expr_print(e->left.expr, fn, data, E_NOT);
- break;
- case E_EQUAL:
- if (e->left.sym->name)
- fn(data, e->left.sym, e->left.sym->name);
- else
- fn(data, NULL, "<choice>");
- fn(data, NULL, "=");
- fn(data, e->right.sym, e->right.sym->name);
- break;
- case E_LEQ:
- case E_LTH:
- if (e->left.sym->name)
- fn(data, e->left.sym, e->left.sym->name);
- else
- fn(data, NULL, "<choice>");
- fn(data, NULL, e->type == E_LEQ ? "<=" : "<");
- fn(data, e->right.sym, e->right.sym->name);
- break;
- case E_GEQ:
- case E_GTH:
- if (e->left.sym->name)
- fn(data, e->left.sym, e->left.sym->name);
- else
- fn(data, NULL, "<choice>");
- fn(data, NULL, e->type == E_GEQ ? ">=" : ">");
- fn(data, e->right.sym, e->right.sym->name);
- break;
- case E_UNEQUAL:
- if (e->left.sym->name)
- fn(data, e->left.sym, e->left.sym->name);
- else
- fn(data, NULL, "<choice>");
- fn(data, NULL, "!=");
- fn(data, e->right.sym, e->right.sym->name);
- break;
- case E_OR:
- expr_print(e->left.expr, fn, data, E_OR);
- fn(data, NULL, " || ");
- expr_print(e->right.expr, fn, data, E_OR);
- break;
- case E_AND:
- expr_print(e->left.expr, fn, data, E_AND);
- fn(data, NULL, " && ");
- expr_print(e->right.expr, fn, data, E_AND);
- break;
- case E_LIST:
- fn(data, e->right.sym, e->right.sym->name);
- if (e->left.expr) {
- fn(data, NULL, " ^ ");
- expr_print(e->left.expr, fn, data, E_LIST);
- }
- break;
- case E_RANGE:
- fn(data, NULL, "[");
- fn(data, e->left.sym, e->left.sym->name);
- fn(data, NULL, " ");
- fn(data, e->right.sym, e->right.sym->name);
- fn(data, NULL, "]");
- break;
- default:
- {
- char buf[32];
- sprintf(buf, "<unknown type %d>", e->type);
- fn(data, NULL, buf);
- break;
- }
- }
- if (expr_compare_type(prevtoken, e->type) > 0)
- fn(data, NULL, ")");
-}
-
-static void expr_print_file_helper(void *data, struct symbol *sym, const char *str)
-{
- xfwrite(str, strlen(str), 1, data);
-}
-
-void expr_fprint(struct expr *e, FILE *out)
-{
- expr_print(e, expr_print_file_helper, out, E_NONE);
-}
-
-static void expr_print_gstr_helper(void *data, struct symbol *sym, const char *str)
-{
- struct gstr *gs = (struct gstr*)data;
- const char *sym_str = NULL;
-
- if (sym)
- sym_str = sym_get_string_value(sym);
-
- if (gs->max_width) {
- unsigned extra_length = strlen(str);
- const char *last_cr = strrchr(gs->s, '\n');
- unsigned last_line_length;
-
- if (sym_str)
- extra_length += 4 + strlen(sym_str);
-
- if (!last_cr)
- last_cr = gs->s;
-
- last_line_length = strlen(gs->s) - (last_cr - gs->s);
-
- if ((last_line_length + extra_length) > gs->max_width)
- str_append(gs, "\\\n");
- }
-
- str_append(gs, str);
- if (sym && sym->type != S_UNKNOWN)
- str_printf(gs, " [=%s]", sym_str);
-}
-
-void expr_gstr_print(struct expr *e, struct gstr *gs)
-{
- expr_print(e, expr_print_gstr_helper, gs, E_NONE);
-}
+++ /dev/null
-/*
- * Copyright (C) 2002 Roman Zippel <zippel@linux-m68k.org>
- * Released under the terms of the GNU GPL v2.0.
- */
-
-#ifndef EXPR_H
-#define EXPR_H
-
-#ifdef __cplusplus
-extern "C" {
-#endif
-
-#include <assert.h>
-#include <stdio.h>
-#include "list.h"
-#ifndef __cplusplus
-#include <stdbool.h>
-#endif
-
-struct file {
- struct file *next;
- struct file *parent;
- const char *name;
- int lineno;
-};
-
-typedef enum tristate {
- no, mod, yes
-} tristate;
-
-enum expr_type {
- E_NONE, E_OR, E_AND, E_NOT,
- E_EQUAL, E_UNEQUAL, E_LTH, E_LEQ, E_GTH, E_GEQ,
- E_LIST, E_SYMBOL, E_RANGE
-};
-
-union expr_data {
- struct expr *expr;
- struct symbol *sym;
-};
-
-struct expr {
- enum expr_type type;
- union expr_data left, right;
-};
-
-#define EXPR_OR(dep1, dep2) (((dep1)>(dep2))?(dep1):(dep2))
-#define EXPR_AND(dep1, dep2) (((dep1)<(dep2))?(dep1):(dep2))
-#define EXPR_NOT(dep) (2-(dep))
-
-#define expr_list_for_each_sym(l, e, s) \
- for (e = (l); e && (s = e->right.sym); e = e->left.expr)
-
-struct expr_value {
- struct expr *expr;
- tristate tri;
-};
-
-struct symbol_value {
- void *val;
- tristate tri;
-};
-
-enum symbol_type {
- S_UNKNOWN, S_BOOLEAN, S_TRISTATE, S_INT, S_HEX, S_STRING, S_OTHER
-};
-
-/* enum values are used as index to symbol.def[] */
-enum {
- S_DEF_USER, /* main user value */
- S_DEF_AUTO, /* values read from auto.conf */
- S_DEF_DEF3, /* Reserved for UI usage */
- S_DEF_DEF4, /* Reserved for UI usage */
- S_DEF_COUNT
-};
-
-struct symbol {
- struct symbol *next;
- char *name;
- enum symbol_type type;
- struct symbol_value curr;
- struct symbol_value def[S_DEF_COUNT];
- tristate visible;
- int flags;
- struct property *prop;
- struct expr_value dir_dep;
- struct expr_value rev_dep;
-};
-
-#define for_all_symbols(i, sym) for (i = 0; i < SYMBOL_HASHSIZE; i++) for (sym = symbol_hash[i]; sym; sym = sym->next) if (sym->type != S_OTHER)
-
-#define SYMBOL_CONST 0x0001 /* symbol is const */
-#define SYMBOL_CHECK 0x0008 /* used during dependency checking */
-#define SYMBOL_CHOICE 0x0010 /* start of a choice block (null name) */
-#define SYMBOL_CHOICEVAL 0x0020 /* used as a value in a choice block */
-#define SYMBOL_VALID 0x0080 /* set when symbol.curr is calculated */
-#define SYMBOL_OPTIONAL 0x0100 /* choice is optional - values can be 'n' */
-#define SYMBOL_WRITE 0x0200 /* write symbol to file (KCONFIG_CONFIG) */
-#define SYMBOL_CHANGED 0x0400 /* ? */
-#define SYMBOL_AUTO 0x1000 /* value from environment variable */
-#define SYMBOL_CHECKED 0x2000 /* used during dependency checking */
-#define SYMBOL_WARNED 0x8000 /* warning has been issued */
-
-/* Set when symbol.def[] is used */
-#define SYMBOL_DEF 0x10000 /* First bit of SYMBOL_DEF */
-#define SYMBOL_DEF_USER 0x10000 /* symbol.def[S_DEF_USER] is valid */
-#define SYMBOL_DEF_AUTO 0x20000 /* symbol.def[S_DEF_AUTO] is valid */
-#define SYMBOL_DEF3 0x40000 /* symbol.def[S_DEF_3] is valid */
-#define SYMBOL_DEF4 0x80000 /* symbol.def[S_DEF_4] is valid */
-
-/* choice values need to be set before calculating this symbol value */
-#define SYMBOL_NEED_SET_CHOICE_VALUES 0x100000
-
-/* Set symbol to y if allnoconfig; used for symbols that hide others */
-#define SYMBOL_ALLNOCONFIG_Y 0x200000
-
-#define SYMBOL_MAXLENGTH 256
-#define SYMBOL_HASHSIZE 9973
-
-/* A property represent the config options that can be associated
- * with a config "symbol".
- * Sample:
- * config FOO
- * default y
- * prompt "foo prompt"
- * select BAR
- * config BAZ
- * int "BAZ Value"
- * range 1..255
- */
-enum prop_type {
- P_UNKNOWN,
- P_PROMPT, /* prompt "foo prompt" or "BAZ Value" */
- P_COMMENT, /* text associated with a comment */
- P_MENU, /* prompt associated with a menuconfig option */
- P_DEFAULT, /* default y */
- P_CHOICE, /* choice value */
- P_SELECT, /* select BAR */
- P_RANGE, /* range 7..100 (for a symbol) */
- P_ENV, /* value from environment variable */
- P_SYMBOL, /* where a symbol is defined */
-};
-
-struct property {
- struct property *next; /* next property - null if last */
- struct symbol *sym; /* the symbol for which the property is associated */
- enum prop_type type; /* type of property */
- const char *text; /* the prompt value - P_PROMPT, P_MENU, P_COMMENT */
- struct expr_value visible;
- struct expr *expr; /* the optional conditional part of the property */
- struct menu *menu; /* the menu the property are associated with
- * valid for: P_SELECT, P_RANGE, P_CHOICE,
- * P_PROMPT, P_DEFAULT, P_MENU, P_COMMENT */
- struct file *file; /* what file was this property defined */
- int lineno; /* what lineno was this property defined */
-};
-
-#define for_all_properties(sym, st, tok) \
- for (st = sym->prop; st; st = st->next) \
- if (st->type == (tok))
-#define for_all_defaults(sym, st) for_all_properties(sym, st, P_DEFAULT)
-#define for_all_choices(sym, st) for_all_properties(sym, st, P_CHOICE)
-#define for_all_prompts(sym, st) \
- for (st = sym->prop; st; st = st->next) \
- if (st->text)
-
-struct menu {
- struct menu *next;
- struct menu *parent;
- struct menu *list;
- struct symbol *sym;
- struct property *prompt;
- struct expr *visibility;
- struct expr *dep;
- unsigned int flags;
- char *help;
- struct file *file;
- int lineno;
- void *data;
-};
-
-#define MENU_CHANGED 0x0001
-#define MENU_ROOT 0x0002
-
-struct jump_key {
- struct list_head entries;
- size_t offset;
- struct menu *target;
- int index;
-};
-
-#define JUMP_NB 9
-
-extern struct file *file_list;
-extern struct file *current_file;
-struct file *lookup_file(const char *name);
-
-extern struct symbol symbol_yes, symbol_no, symbol_mod;
-extern struct symbol *modules_sym;
-extern struct symbol *sym_defconfig_list;
-extern int cdebug;
-struct expr *expr_alloc_symbol(struct symbol *sym);
-struct expr *expr_alloc_one(enum expr_type type, struct expr *ce);
-struct expr *expr_alloc_two(enum expr_type type, struct expr *e1, struct expr *e2);
-struct expr *expr_alloc_comp(enum expr_type type, struct symbol *s1, struct symbol *s2);
-struct expr *expr_alloc_and(struct expr *e1, struct expr *e2);
-struct expr *expr_alloc_or(struct expr *e1, struct expr *e2);
-struct expr *expr_copy(const struct expr *org);
-void expr_free(struct expr *e);
-void expr_eliminate_eq(struct expr **ep1, struct expr **ep2);
-tristate expr_calc_value(struct expr *e);
-struct expr *expr_trans_bool(struct expr *e);
-struct expr *expr_eliminate_dups(struct expr *e);
-struct expr *expr_transform(struct expr *e);
-int expr_contains_symbol(struct expr *dep, struct symbol *sym);
-bool expr_depends_symbol(struct expr *dep, struct symbol *sym);
-struct expr *expr_trans_compare(struct expr *e, enum expr_type type, struct symbol *sym);
-struct expr *expr_simplify_unmet_dep(struct expr *e1, struct expr *e2);
-
-void expr_fprint(struct expr *e, FILE *out);
-struct gstr; /* forward */
-void expr_gstr_print(struct expr *e, struct gstr *gs);
-
-static inline int expr_is_yes(struct expr *e)
-{
- return !e || (e->type == E_SYMBOL && e->left.sym == &symbol_yes);
-}
-
-static inline int expr_is_no(struct expr *e)
-{
- return e && (e->type == E_SYMBOL && e->left.sym == &symbol_no);
-}
-
-#ifdef __cplusplus
-}
-#endif
-
-#endif /* EXPR_H */
+++ /dev/null
-/* Hey EMACS -*- linux-c -*- */
-/*
- *
- * Copyright (C) 2002-2003 Romain Lievin <roms@tilp.info>
- * Released under the terms of the GNU GPL v2.0.
- *
- */
-
-#ifdef HAVE_CONFIG_H
-# include <config.h>
-#endif
-
-#include <stdlib.h>
-#include "lkc.h"
-#include "images.c"
-
-#include <glade/glade.h>
-#include <gtk/gtk.h>
-#include <glib.h>
-#include <gdk/gdkkeysyms.h>
-
-#include <stdio.h>
-#include <string.h>
-#include <unistd.h>
-#include <time.h>
-
-//#define DEBUG
-
-enum {
- SINGLE_VIEW, SPLIT_VIEW, FULL_VIEW
-};
-
-enum {
- OPT_NORMAL, OPT_ALL, OPT_PROMPT
-};
-
-static gint view_mode = FULL_VIEW;
-static gboolean show_name = TRUE;
-static gboolean show_range = TRUE;
-static gboolean show_value = TRUE;
-static gboolean resizeable = FALSE;
-static int opt_mode = OPT_NORMAL;
-
-GtkWidget *main_wnd = NULL;
-GtkWidget *tree1_w = NULL; // left frame
-GtkWidget *tree2_w = NULL; // right frame
-GtkWidget *text_w = NULL;
-GtkWidget *hpaned = NULL;
-GtkWidget *vpaned = NULL;
-GtkWidget *back_btn = NULL;
-GtkWidget *save_btn = NULL;
-GtkWidget *save_menu_item = NULL;
-
-GtkTextTag *tag1, *tag2;
-GdkColor color;
-
-GtkTreeStore *tree1, *tree2, *tree;
-GtkTreeModel *model1, *model2;
-static GtkTreeIter *parents[256];
-static gint indent;
-
-static struct menu *current; // current node for SINGLE view
-static struct menu *browsed; // browsed node for SPLIT view
-
-enum {
- COL_OPTION, COL_NAME, COL_NO, COL_MOD, COL_YES, COL_VALUE,
- COL_MENU, COL_COLOR, COL_EDIT, COL_PIXBUF,
- COL_PIXVIS, COL_BTNVIS, COL_BTNACT, COL_BTNINC, COL_BTNRAD,
- COL_NUMBER
-};
-
-static void display_list(void);
-static void display_tree(struct menu *menu);
-static void display_tree_part(void);
-static void update_tree(struct menu *src, GtkTreeIter * dst);
-static void set_node(GtkTreeIter * node, struct menu *menu, gchar ** row);
-static gchar **fill_row(struct menu *menu);
-static void conf_changed(void);
-
-/* Helping/Debugging Functions */
-
-const char *dbg_sym_flags(int val)
-{
- static char buf[256];
-
- bzero(buf, 256);
-
- if (val & SYMBOL_CONST)
- strcat(buf, "const/");
- if (val & SYMBOL_CHECK)
- strcat(buf, "check/");
- if (val & SYMBOL_CHOICE)
- strcat(buf, "choice/");
- if (val & SYMBOL_CHOICEVAL)
- strcat(buf, "choiceval/");
- if (val & SYMBOL_VALID)
- strcat(buf, "valid/");
- if (val & SYMBOL_OPTIONAL)
- strcat(buf, "optional/");
- if (val & SYMBOL_WRITE)
- strcat(buf, "write/");
- if (val & SYMBOL_CHANGED)
- strcat(buf, "changed/");
- if (val & SYMBOL_AUTO)
- strcat(buf, "auto/");
-
- buf[strlen(buf) - 1] = '\0';
-
- return buf;
-}
-
-void replace_button_icon(GladeXML * xml, GdkDrawable * window,
- GtkStyle * style, gchar * btn_name, gchar ** xpm)
-{
- GdkPixmap *pixmap;
- GdkBitmap *mask;
- GtkToolButton *button;
- GtkWidget *image;
-
- pixmap = gdk_pixmap_create_from_xpm_d(window, &mask,
- &style->bg[GTK_STATE_NORMAL],
- xpm);
-
- button = GTK_TOOL_BUTTON(glade_xml_get_widget(xml, btn_name));
- image = gtk_image_new_from_pixmap(pixmap, mask);
- gtk_widget_show(image);
- gtk_tool_button_set_icon_widget(button, image);
-}
-
-/* Main Window Initialization */
-void init_main_window(const gchar * glade_file)
-{
- GladeXML *xml;
- GtkWidget *widget;
- GtkTextBuffer *txtbuf;
- GtkStyle *style;
-
- xml = glade_xml_new(glade_file, "window1", NULL);
- if (!xml)
- g_error(_("GUI loading failed !\n"));
- glade_xml_signal_autoconnect(xml);
-
- main_wnd = glade_xml_get_widget(xml, "window1");
- hpaned = glade_xml_get_widget(xml, "hpaned1");
- vpaned = glade_xml_get_widget(xml, "vpaned1");
- tree1_w = glade_xml_get_widget(xml, "treeview1");
- tree2_w = glade_xml_get_widget(xml, "treeview2");
- text_w = glade_xml_get_widget(xml, "textview3");
-
- back_btn = glade_xml_get_widget(xml, "button1");
- gtk_widget_set_sensitive(back_btn, FALSE);
-
- widget = glade_xml_get_widget(xml, "show_name1");
- gtk_check_menu_item_set_active((GtkCheckMenuItem *) widget,
- show_name);
-
- widget = glade_xml_get_widget(xml, "show_range1");
- gtk_check_menu_item_set_active((GtkCheckMenuItem *) widget,
- show_range);
-
- widget = glade_xml_get_widget(xml, "show_data1");
- gtk_check_menu_item_set_active((GtkCheckMenuItem *) widget,
- show_value);
-
- save_btn = glade_xml_get_widget(xml, "button3");
- save_menu_item = glade_xml_get_widget(xml, "save1");
- conf_set_changed_callback(conf_changed);
-
- style = gtk_widget_get_style(main_wnd);
- widget = glade_xml_get_widget(xml, "toolbar1");
-
- replace_button_icon(xml, main_wnd->window, style,
- "button4", (gchar **) xpm_single_view);
- replace_button_icon(xml, main_wnd->window, style,
- "button5", (gchar **) xpm_split_view);
- replace_button_icon(xml, main_wnd->window, style,
- "button6", (gchar **) xpm_tree_view);
-
- txtbuf = gtk_text_view_get_buffer(GTK_TEXT_VIEW(text_w));
- tag1 = gtk_text_buffer_create_tag(txtbuf, "mytag1",
- "foreground", "red",
- "weight", PANGO_WEIGHT_BOLD,
- NULL);
- tag2 = gtk_text_buffer_create_tag(txtbuf, "mytag2",
- /*"style", PANGO_STYLE_OBLIQUE, */
- NULL);
-
- gtk_window_set_title(GTK_WINDOW(main_wnd), rootmenu.prompt->text);
-
- gtk_widget_show(main_wnd);
-}
-
-void init_tree_model(void)
-{
- gint i;
-
- tree = tree2 = gtk_tree_store_new(COL_NUMBER,
- G_TYPE_STRING, G_TYPE_STRING,
- G_TYPE_STRING, G_TYPE_STRING,
- G_TYPE_STRING, G_TYPE_STRING,
- G_TYPE_POINTER, GDK_TYPE_COLOR,
- G_TYPE_BOOLEAN, GDK_TYPE_PIXBUF,
- G_TYPE_BOOLEAN, G_TYPE_BOOLEAN,
- G_TYPE_BOOLEAN, G_TYPE_BOOLEAN,
- G_TYPE_BOOLEAN);
- model2 = GTK_TREE_MODEL(tree2);
-
- for (parents[0] = NULL, i = 1; i < 256; i++)
- parents[i] = (GtkTreeIter *) g_malloc(sizeof(GtkTreeIter));
-
- tree1 = gtk_tree_store_new(COL_NUMBER,
- G_TYPE_STRING, G_TYPE_STRING,
- G_TYPE_STRING, G_TYPE_STRING,
- G_TYPE_STRING, G_TYPE_STRING,
- G_TYPE_POINTER, GDK_TYPE_COLOR,
- G_TYPE_BOOLEAN, GDK_TYPE_PIXBUF,
- G_TYPE_BOOLEAN, G_TYPE_BOOLEAN,
- G_TYPE_BOOLEAN, G_TYPE_BOOLEAN,
- G_TYPE_BOOLEAN);
- model1 = GTK_TREE_MODEL(tree1);
-}
-
-void init_left_tree(void)
-{
- GtkTreeView *view = GTK_TREE_VIEW(tree1_w);
- GtkCellRenderer *renderer;
- GtkTreeSelection *sel;
- GtkTreeViewColumn *column;
-
- gtk_tree_view_set_model(view, model1);
- gtk_tree_view_set_headers_visible(view, TRUE);
- gtk_tree_view_set_rules_hint(view, TRUE);
-
- column = gtk_tree_view_column_new();
- gtk_tree_view_append_column(view, column);
- gtk_tree_view_column_set_title(column, _("Options"));
-
- renderer = gtk_cell_renderer_toggle_new();
- gtk_tree_view_column_pack_start(GTK_TREE_VIEW_COLUMN(column),
- renderer, FALSE);
- gtk_tree_view_column_set_attributes(GTK_TREE_VIEW_COLUMN(column),
- renderer,
- "active", COL_BTNACT,
- "inconsistent", COL_BTNINC,
- "visible", COL_BTNVIS,
- "radio", COL_BTNRAD, NULL);
- renderer = gtk_cell_renderer_text_new();
- gtk_tree_view_column_pack_start(GTK_TREE_VIEW_COLUMN(column),
- renderer, FALSE);
- gtk_tree_view_column_set_attributes(GTK_TREE_VIEW_COLUMN(column),
- renderer,
- "text", COL_OPTION,
- "foreground-gdk",
- COL_COLOR, NULL);
-
- sel = gtk_tree_view_get_selection(view);
- gtk_tree_selection_set_mode(sel, GTK_SELECTION_SINGLE);
- gtk_widget_realize(tree1_w);
-}
-
-static void renderer_edited(GtkCellRendererText * cell,
- const gchar * path_string,
- const gchar * new_text, gpointer user_data);
-
-void init_right_tree(void)
-{
- GtkTreeView *view = GTK_TREE_VIEW(tree2_w);
- GtkCellRenderer *renderer;
- GtkTreeSelection *sel;
- GtkTreeViewColumn *column;
- gint i;
-
- gtk_tree_view_set_model(view, model2);
- gtk_tree_view_set_headers_visible(view, TRUE);
- gtk_tree_view_set_rules_hint(view, TRUE);
-
- column = gtk_tree_view_column_new();
- gtk_tree_view_append_column(view, column);
- gtk_tree_view_column_set_title(column, _("Options"));
-
- renderer = gtk_cell_renderer_pixbuf_new();
- gtk_tree_view_column_pack_start(GTK_TREE_VIEW_COLUMN(column),
- renderer, FALSE);
- gtk_tree_view_column_set_attributes(GTK_TREE_VIEW_COLUMN(column),
- renderer,
- "pixbuf", COL_PIXBUF,
- "visible", COL_PIXVIS, NULL);
- renderer = gtk_cell_renderer_toggle_new();
- gtk_tree_view_column_pack_start(GTK_TREE_VIEW_COLUMN(column),
- renderer, FALSE);
- gtk_tree_view_column_set_attributes(GTK_TREE_VIEW_COLUMN(column),
- renderer,
- "active", COL_BTNACT,
- "inconsistent", COL_BTNINC,
- "visible", COL_BTNVIS,
- "radio", COL_BTNRAD, NULL);
- renderer = gtk_cell_renderer_text_new();
- gtk_tree_view_column_pack_start(GTK_TREE_VIEW_COLUMN(column),
- renderer, FALSE);
- gtk_tree_view_column_set_attributes(GTK_TREE_VIEW_COLUMN(column),
- renderer,
- "text", COL_OPTION,
- "foreground-gdk",
- COL_COLOR, NULL);
-
- renderer = gtk_cell_renderer_text_new();
- gtk_tree_view_insert_column_with_attributes(view, -1,
- _("Name"), renderer,
- "text", COL_NAME,
- "foreground-gdk",
- COL_COLOR, NULL);
- renderer = gtk_cell_renderer_text_new();
- gtk_tree_view_insert_column_with_attributes(view, -1,
- "N", renderer,
- "text", COL_NO,
- "foreground-gdk",
- COL_COLOR, NULL);
- renderer = gtk_cell_renderer_text_new();
- gtk_tree_view_insert_column_with_attributes(view, -1,
- "M", renderer,
- "text", COL_MOD,
- "foreground-gdk",
- COL_COLOR, NULL);
- renderer = gtk_cell_renderer_text_new();
- gtk_tree_view_insert_column_with_attributes(view, -1,
- "Y", renderer,
- "text", COL_YES,
- "foreground-gdk",
- COL_COLOR, NULL);
- renderer = gtk_cell_renderer_text_new();
- gtk_tree_view_insert_column_with_attributes(view, -1,
- _("Value"), renderer,
- "text", COL_VALUE,
- "editable",
- COL_EDIT,
- "foreground-gdk",
- COL_COLOR, NULL);
- g_signal_connect(G_OBJECT(renderer), "edited",
- G_CALLBACK(renderer_edited), NULL);
-
- column = gtk_tree_view_get_column(view, COL_NAME);
- gtk_tree_view_column_set_visible(column, show_name);
- column = gtk_tree_view_get_column(view, COL_NO);
- gtk_tree_view_column_set_visible(column, show_range);
- column = gtk_tree_view_get_column(view, COL_MOD);
- gtk_tree_view_column_set_visible(column, show_range);
- column = gtk_tree_view_get_column(view, COL_YES);
- gtk_tree_view_column_set_visible(column, show_range);
- column = gtk_tree_view_get_column(view, COL_VALUE);
- gtk_tree_view_column_set_visible(column, show_value);
-
- if (resizeable) {
- for (i = 0; i < COL_VALUE; i++) {
- column = gtk_tree_view_get_column(view, i);
- gtk_tree_view_column_set_resizable(column, TRUE);
- }
- }
-
- sel = gtk_tree_view_get_selection(view);
- gtk_tree_selection_set_mode(sel, GTK_SELECTION_SINGLE);
-}
-
-
-/* Utility Functions */
-
-
-static void text_insert_help(struct menu *menu)
-{
- GtkTextBuffer *buffer;
- GtkTextIter start, end;
- const char *prompt = _(menu_get_prompt(menu));
- struct gstr help = str_new();
-
- menu_get_ext_help(menu, &help);
-
- buffer = gtk_text_view_get_buffer(GTK_TEXT_VIEW(text_w));
- gtk_text_buffer_get_bounds(buffer, &start, &end);
- gtk_text_buffer_delete(buffer, &start, &end);
- gtk_text_view_set_left_margin(GTK_TEXT_VIEW(text_w), 15);
-
- gtk_text_buffer_get_end_iter(buffer, &end);
- gtk_text_buffer_insert_with_tags(buffer, &end, prompt, -1, tag1,
- NULL);
- gtk_text_buffer_insert_at_cursor(buffer, "\n\n", 2);
- gtk_text_buffer_get_end_iter(buffer, &end);
- gtk_text_buffer_insert_with_tags(buffer, &end, str_get(&help), -1, tag2,
- NULL);
- str_free(&help);
-}
-
-
-static void text_insert_msg(const char *title, const char *message)
-{
- GtkTextBuffer *buffer;
- GtkTextIter start, end;
- const char *msg = message;
-
- buffer = gtk_text_view_get_buffer(GTK_TEXT_VIEW(text_w));
- gtk_text_buffer_get_bounds(buffer, &start, &end);
- gtk_text_buffer_delete(buffer, &start, &end);
- gtk_text_view_set_left_margin(GTK_TEXT_VIEW(text_w), 15);
-
- gtk_text_buffer_get_end_iter(buffer, &end);
- gtk_text_buffer_insert_with_tags(buffer, &end, title, -1, tag1,
- NULL);
- gtk_text_buffer_insert_at_cursor(buffer, "\n\n", 2);
- gtk_text_buffer_get_end_iter(buffer, &end);
- gtk_text_buffer_insert_with_tags(buffer, &end, msg, -1, tag2,
- NULL);
-}
-
-
-/* Main Windows Callbacks */
-
-void on_save_activate(GtkMenuItem * menuitem, gpointer user_data);
-gboolean on_window1_delete_event(GtkWidget * widget, GdkEvent * event,
- gpointer user_data)
-{
- GtkWidget *dialog, *label;
- gint result;
-
- if (!conf_get_changed())
- return FALSE;
-
- dialog = gtk_dialog_new_with_buttons(_("Warning !"),
- GTK_WINDOW(main_wnd),
- (GtkDialogFlags)
- (GTK_DIALOG_MODAL |
- GTK_DIALOG_DESTROY_WITH_PARENT),
- GTK_STOCK_OK,
- GTK_RESPONSE_YES,
- GTK_STOCK_NO,
- GTK_RESPONSE_NO,
- GTK_STOCK_CANCEL,
- GTK_RESPONSE_CANCEL, NULL);
- gtk_dialog_set_default_response(GTK_DIALOG(dialog),
- GTK_RESPONSE_CANCEL);
-
- label = gtk_label_new(_("\nSave configuration ?\n"));
- gtk_container_add(GTK_CONTAINER(GTK_DIALOG(dialog)->vbox), label);
- gtk_widget_show(label);
-
- result = gtk_dialog_run(GTK_DIALOG(dialog));
- switch (result) {
- case GTK_RESPONSE_YES:
- on_save_activate(NULL, NULL);
- return FALSE;
- case GTK_RESPONSE_NO:
- return FALSE;
- case GTK_RESPONSE_CANCEL:
- case GTK_RESPONSE_DELETE_EVENT:
- default:
- gtk_widget_destroy(dialog);
- return TRUE;
- }
-
- return FALSE;
-}
-
-
-void on_window1_destroy(GtkObject * object, gpointer user_data)
-{
- gtk_main_quit();
-}
-
-
-void
-on_window1_size_request(GtkWidget * widget,
- GtkRequisition * requisition, gpointer user_data)
-{
- static gint old_h;
- gint w, h;
-
- if (widget->window == NULL)
- gtk_window_get_default_size(GTK_WINDOW(main_wnd), &w, &h);
- else
- gdk_window_get_size(widget->window, &w, &h);
-
- if (h == old_h)
- return;
- old_h = h;
-
- gtk_paned_set_position(GTK_PANED(vpaned), 2 * h / 3);
-}
-
-
-/* Menu & Toolbar Callbacks */
-
-
-static void
-load_filename(GtkFileSelection * file_selector, gpointer user_data)
-{
- const gchar *fn;
-
- fn = gtk_file_selection_get_filename(GTK_FILE_SELECTION
- (user_data));
-
- if (conf_read(fn))
- text_insert_msg(_("Error"), _("Unable to load configuration !"));
- else
- display_tree(&rootmenu);
-}
-
-void on_load1_activate(GtkMenuItem * menuitem, gpointer user_data)
-{
- GtkWidget *fs;
-
- fs = gtk_file_selection_new(_("Load file..."));
- g_signal_connect(GTK_OBJECT(GTK_FILE_SELECTION(fs)->ok_button),
- "clicked",
- G_CALLBACK(load_filename), (gpointer) fs);
- g_signal_connect_swapped(GTK_OBJECT
- (GTK_FILE_SELECTION(fs)->ok_button),
- "clicked", G_CALLBACK(gtk_widget_destroy),
- (gpointer) fs);
- g_signal_connect_swapped(GTK_OBJECT
- (GTK_FILE_SELECTION(fs)->cancel_button),
- "clicked", G_CALLBACK(gtk_widget_destroy),
- (gpointer) fs);
- gtk_widget_show(fs);
-}
-
-
-void on_save_activate(GtkMenuItem * menuitem, gpointer user_data)
-{
- if (conf_write(NULL))
- text_insert_msg(_("Error"), _("Unable to save configuration !"));
-}
-
-
-static void
-store_filename(GtkFileSelection * file_selector, gpointer user_data)
-{
- const gchar *fn;
-
- fn = gtk_file_selection_get_filename(GTK_FILE_SELECTION
- (user_data));
-
- if (conf_write(fn))
- text_insert_msg(_("Error"), _("Unable to save configuration !"));
-
- gtk_widget_destroy(GTK_WIDGET(user_data));
-}
-
-void on_save_as1_activate(GtkMenuItem * menuitem, gpointer user_data)
-{
- GtkWidget *fs;
-
- fs = gtk_file_selection_new(_("Save file as..."));
- g_signal_connect(GTK_OBJECT(GTK_FILE_SELECTION(fs)->ok_button),
- "clicked",
- G_CALLBACK(store_filename), (gpointer) fs);
- g_signal_connect_swapped(GTK_OBJECT
- (GTK_FILE_SELECTION(fs)->ok_button),
- "clicked", G_CALLBACK(gtk_widget_destroy),
- (gpointer) fs);
- g_signal_connect_swapped(GTK_OBJECT
- (GTK_FILE_SELECTION(fs)->cancel_button),
- "clicked", G_CALLBACK(gtk_widget_destroy),
- (gpointer) fs);
- gtk_widget_show(fs);
-}
-
-
-void on_quit1_activate(GtkMenuItem * menuitem, gpointer user_data)
-{
- if (!on_window1_delete_event(NULL, NULL, NULL))
- gtk_widget_destroy(GTK_WIDGET(main_wnd));
-}
-
-
-void on_show_name1_activate(GtkMenuItem * menuitem, gpointer user_data)
-{
- GtkTreeViewColumn *col;
-
- show_name = GTK_CHECK_MENU_ITEM(menuitem)->active;
- col = gtk_tree_view_get_column(GTK_TREE_VIEW(tree2_w), COL_NAME);
- if (col)
- gtk_tree_view_column_set_visible(col, show_name);
-}
-
-
-void on_show_range1_activate(GtkMenuItem * menuitem, gpointer user_data)
-{
- GtkTreeViewColumn *col;
-
- show_range = GTK_CHECK_MENU_ITEM(menuitem)->active;
- col = gtk_tree_view_get_column(GTK_TREE_VIEW(tree2_w), COL_NO);
- if (col)
- gtk_tree_view_column_set_visible(col, show_range);
- col = gtk_tree_view_get_column(GTK_TREE_VIEW(tree2_w), COL_MOD);
- if (col)
- gtk_tree_view_column_set_visible(col, show_range);
- col = gtk_tree_view_get_column(GTK_TREE_VIEW(tree2_w), COL_YES);
- if (col)
- gtk_tree_view_column_set_visible(col, show_range);
-
-}
-
-
-void on_show_data1_activate(GtkMenuItem * menuitem, gpointer user_data)
-{
- GtkTreeViewColumn *col;
-
- show_value = GTK_CHECK_MENU_ITEM(menuitem)->active;
- col = gtk_tree_view_get_column(GTK_TREE_VIEW(tree2_w), COL_VALUE);
- if (col)
- gtk_tree_view_column_set_visible(col, show_value);
-}
-
-
-void
-on_set_option_mode1_activate(GtkMenuItem *menuitem, gpointer user_data)
-{
- opt_mode = OPT_NORMAL;
- gtk_tree_store_clear(tree2);
- display_tree(&rootmenu); /* instead of update_tree to speed-up */
-}
-
-
-void
-on_set_option_mode2_activate(GtkMenuItem *menuitem, gpointer user_data)
-{
- opt_mode = OPT_ALL;
- gtk_tree_store_clear(tree2);
- display_tree(&rootmenu); /* instead of update_tree to speed-up */
-}
-
-
-void
-on_set_option_mode3_activate(GtkMenuItem *menuitem, gpointer user_data)
-{
- opt_mode = OPT_PROMPT;
- gtk_tree_store_clear(tree2);
- display_tree(&rootmenu); /* instead of update_tree to speed-up */
-}
-
-
-void on_introduction1_activate(GtkMenuItem * menuitem, gpointer user_data)
-{
- GtkWidget *dialog;
- const gchar *intro_text = _(
- "Welcome to gkc, the GTK+ graphical configuration tool\n"
- "For each option, a blank box indicates the feature is disabled, a\n"
- "check indicates it is enabled, and a dot indicates that it is to\n"
- "be compiled as a module. Clicking on the box will cycle through the three states.\n"
- "\n"
- "If you do not see an option (e.g., a device driver) that you\n"
- "believe should be present, try turning on Show All Options\n"
- "under the Options menu.\n"
- "Although there is no cross reference yet to help you figure out\n"
- "what other options must be enabled to support the option you\n"
- "are interested in, you can still view the help of a grayed-out\n"
- "option.\n"
- "\n"
- "Toggling Show Debug Info under the Options menu will show \n"
- "the dependencies, which you can then match by examining other options.");
-
- dialog = gtk_message_dialog_new(GTK_WINDOW(main_wnd),
- GTK_DIALOG_DESTROY_WITH_PARENT,
- GTK_MESSAGE_INFO,
- GTK_BUTTONS_CLOSE, "%s", intro_text);
- g_signal_connect_swapped(GTK_OBJECT(dialog), "response",
- G_CALLBACK(gtk_widget_destroy),
- GTK_OBJECT(dialog));
- gtk_widget_show_all(dialog);
-}
-
-
-void on_about1_activate(GtkMenuItem * menuitem, gpointer user_data)
-{
- GtkWidget *dialog;
- const gchar *about_text =
- _("gkc is copyright (c) 2002 Romain Lievin <roms@lpg.ticalc.org>.\n"
- "Based on the source code from Roman Zippel.\n");
-
- dialog = gtk_message_dialog_new(GTK_WINDOW(main_wnd),
- GTK_DIALOG_DESTROY_WITH_PARENT,
- GTK_MESSAGE_INFO,
- GTK_BUTTONS_CLOSE, "%s", about_text);
- g_signal_connect_swapped(GTK_OBJECT(dialog), "response",
- G_CALLBACK(gtk_widget_destroy),
- GTK_OBJECT(dialog));
- gtk_widget_show_all(dialog);
-}
-
-
-void on_license1_activate(GtkMenuItem * menuitem, gpointer user_data)
-{
- GtkWidget *dialog;
- const gchar *license_text =
- _("gkc is released under the terms of the GNU GPL v2.\n"
- "For more information, please see the source code or\n"
- "visit http://www.fsf.org/licenses/licenses.html\n");
-
- dialog = gtk_message_dialog_new(GTK_WINDOW(main_wnd),
- GTK_DIALOG_DESTROY_WITH_PARENT,
- GTK_MESSAGE_INFO,
- GTK_BUTTONS_CLOSE, "%s", license_text);
- g_signal_connect_swapped(GTK_OBJECT(dialog), "response",
- G_CALLBACK(gtk_widget_destroy),
- GTK_OBJECT(dialog));
- gtk_widget_show_all(dialog);
-}
-
-
-void on_back_clicked(GtkButton * button, gpointer user_data)
-{
- enum prop_type ptype;
-
- current = current->parent;
- ptype = current->prompt ? current->prompt->type : P_UNKNOWN;
- if (ptype != P_MENU)
- current = current->parent;
- display_tree_part();
-
- if (current == &rootmenu)
- gtk_widget_set_sensitive(back_btn, FALSE);
-}
-
-
-void on_load_clicked(GtkButton * button, gpointer user_data)
-{
- on_load1_activate(NULL, user_data);
-}
-
-
-void on_single_clicked(GtkButton * button, gpointer user_data)
-{
- view_mode = SINGLE_VIEW;
- gtk_widget_hide(tree1_w);
- current = &rootmenu;
- display_tree_part();
-}
-
-
-void on_split_clicked(GtkButton * button, gpointer user_data)
-{
- gint w, h;
- view_mode = SPLIT_VIEW;
- gtk_widget_show(tree1_w);
- gtk_window_get_default_size(GTK_WINDOW(main_wnd), &w, &h);
- gtk_paned_set_position(GTK_PANED(hpaned), w / 2);
- if (tree2)
- gtk_tree_store_clear(tree2);
- display_list();
-
- /* Disable back btn, like in full mode. */
- gtk_widget_set_sensitive(back_btn, FALSE);
-}
-
-
-void on_full_clicked(GtkButton * button, gpointer user_data)
-{
- view_mode = FULL_VIEW;
- gtk_widget_hide(tree1_w);
- if (tree2)
- gtk_tree_store_clear(tree2);
- display_tree(&rootmenu);
- gtk_widget_set_sensitive(back_btn, FALSE);
-}
-
-
-void on_collapse_clicked(GtkButton * button, gpointer user_data)
-{
- gtk_tree_view_collapse_all(GTK_TREE_VIEW(tree2_w));
-}
-
-
-void on_expand_clicked(GtkButton * button, gpointer user_data)
-{
- gtk_tree_view_expand_all(GTK_TREE_VIEW(tree2_w));
-}
-
-
-/* CTree Callbacks */
-
-/* Change hex/int/string value in the cell */
-static void renderer_edited(GtkCellRendererText * cell,
- const gchar * path_string,
- const gchar * new_text, gpointer user_data)
-{
- GtkTreePath *path = gtk_tree_path_new_from_string(path_string);
- GtkTreeIter iter;
- const char *old_def, *new_def;
- struct menu *menu;
- struct symbol *sym;
-
- if (!gtk_tree_model_get_iter(model2, &iter, path))
- return;
-
- gtk_tree_model_get(model2, &iter, COL_MENU, &menu, -1);
- sym = menu->sym;
-
- gtk_tree_model_get(model2, &iter, COL_VALUE, &old_def, -1);
- new_def = new_text;
-
- sym_set_string_value(sym, new_def);
-
- update_tree(&rootmenu, NULL);
-
- gtk_tree_path_free(path);
-}
-
-/* Change the value of a symbol and update the tree */
-static void change_sym_value(struct menu *menu, gint col)
-{
- struct symbol *sym = menu->sym;
- tristate newval;
-
- if (!sym)
- return;
-
- if (col == COL_NO)
- newval = no;
- else if (col == COL_MOD)
- newval = mod;
- else if (col == COL_YES)
- newval = yes;
- else
- return;
-
- switch (sym_get_type(sym)) {
- case S_BOOLEAN:
- case S_TRISTATE:
- if (!sym_tristate_within_range(sym, newval))
- newval = yes;
- sym_set_tristate_value(sym, newval);
- if (view_mode == FULL_VIEW)
- update_tree(&rootmenu, NULL);
- else if (view_mode == SPLIT_VIEW) {
- update_tree(browsed, NULL);
- display_list();
- }
- else if (view_mode == SINGLE_VIEW)
- display_tree_part(); //fixme: keep exp/coll
- break;
- case S_INT:
- case S_HEX:
- case S_STRING:
- default:
- break;
- }
-}
-
-static void toggle_sym_value(struct menu *menu)
-{
- if (!menu->sym)
- return;
-
- sym_toggle_tristate_value(menu->sym);
- if (view_mode == FULL_VIEW)
- update_tree(&rootmenu, NULL);
- else if (view_mode == SPLIT_VIEW) {
- update_tree(browsed, NULL);
- display_list();
- }
- else if (view_mode == SINGLE_VIEW)
- display_tree_part(); //fixme: keep exp/coll
-}
-
-static gint column2index(GtkTreeViewColumn * column)
-{
- gint i;
-
- for (i = 0; i < COL_NUMBER; i++) {
- GtkTreeViewColumn *col;
-
- col = gtk_tree_view_get_column(GTK_TREE_VIEW(tree2_w), i);
- if (col == column)
- return i;
- }
-
- return -1;
-}
-
-
-/* User click: update choice (full) or goes down (single) */
-gboolean
-on_treeview2_button_press_event(GtkWidget * widget,
- GdkEventButton * event, gpointer user_data)
-{
- GtkTreeView *view = GTK_TREE_VIEW(widget);
- GtkTreePath *path;
- GtkTreeViewColumn *column;
- GtkTreeIter iter;
- struct menu *menu;
- gint col;
-
-#if GTK_CHECK_VERSION(2,1,4) // bug in ctree with earlier version of GTK
- gint tx = (gint) event->x;
- gint ty = (gint) event->y;
- gint cx, cy;
-
- gtk_tree_view_get_path_at_pos(view, tx, ty, &path, &column, &cx,
- &cy);
-#else
- gtk_tree_view_get_cursor(view, &path, &column);
-#endif
- if (path == NULL)
- return FALSE;
-
- if (!gtk_tree_model_get_iter(model2, &iter, path))
- return FALSE;
- gtk_tree_model_get(model2, &iter, COL_MENU, &menu, -1);
-
- col = column2index(column);
- if (event->type == GDK_2BUTTON_PRESS) {
- enum prop_type ptype;
- ptype = menu->prompt ? menu->prompt->type : P_UNKNOWN;
-
- if (ptype == P_MENU && view_mode != FULL_VIEW && col == COL_OPTION) {
- // goes down into menu
- current = menu;
- display_tree_part();
- gtk_widget_set_sensitive(back_btn, TRUE);
- } else if ((col == COL_OPTION)) {
- toggle_sym_value(menu);
- gtk_tree_view_expand_row(view, path, TRUE);
- }
- } else {
- if (col == COL_VALUE) {
- toggle_sym_value(menu);
- gtk_tree_view_expand_row(view, path, TRUE);
- } else if (col == COL_NO || col == COL_MOD
- || col == COL_YES) {
- change_sym_value(menu, col);
- gtk_tree_view_expand_row(view, path, TRUE);
- }
- }
-
- return FALSE;
-}
-
-/* Key pressed: update choice */
-gboolean
-on_treeview2_key_press_event(GtkWidget * widget,
- GdkEventKey * event, gpointer user_data)
-{
- GtkTreeView *view = GTK_TREE_VIEW(widget);
- GtkTreePath *path;
- GtkTreeViewColumn *column;
- GtkTreeIter iter;
- struct menu *menu;
- gint col;
-
- gtk_tree_view_get_cursor(view, &path, &column);
- if (path == NULL)
- return FALSE;
-
- if (event->keyval == GDK_space) {
- if (gtk_tree_view_row_expanded(view, path))
- gtk_tree_view_collapse_row(view, path);
- else
- gtk_tree_view_expand_row(view, path, FALSE);
- return TRUE;
- }
- if (event->keyval == GDK_KP_Enter) {
- }
- if (widget == tree1_w)
- return FALSE;
-
- gtk_tree_model_get_iter(model2, &iter, path);
- gtk_tree_model_get(model2, &iter, COL_MENU, &menu, -1);
-
- if (!strcasecmp(event->string, "n"))
- col = COL_NO;
- else if (!strcasecmp(event->string, "m"))
- col = COL_MOD;
- else if (!strcasecmp(event->string, "y"))
- col = COL_YES;
- else
- col = -1;
- change_sym_value(menu, col);
-
- return FALSE;
-}
-
-
-/* Row selection changed: update help */
-void
-on_treeview2_cursor_changed(GtkTreeView * treeview, gpointer user_data)
-{
- GtkTreeSelection *selection;
- GtkTreeIter iter;
- struct menu *menu;
-
- selection = gtk_tree_view_get_selection(treeview);
- if (gtk_tree_selection_get_selected(selection, &model2, &iter)) {
- gtk_tree_model_get(model2, &iter, COL_MENU, &menu, -1);
- text_insert_help(menu);
- }
-}
-
-
-/* User click: display sub-tree in the right frame. */
-gboolean
-on_treeview1_button_press_event(GtkWidget * widget,
- GdkEventButton * event, gpointer user_data)
-{
- GtkTreeView *view = GTK_TREE_VIEW(widget);
- GtkTreePath *path;
- GtkTreeViewColumn *column;
- GtkTreeIter iter;
- struct menu *menu;
-
- gint tx = (gint) event->x;
- gint ty = (gint) event->y;
- gint cx, cy;
-
- gtk_tree_view_get_path_at_pos(view, tx, ty, &path, &column, &cx,
- &cy);
- if (path == NULL)
- return FALSE;
-
- gtk_tree_model_get_iter(model1, &iter, path);
- gtk_tree_model_get(model1, &iter, COL_MENU, &menu, -1);
-
- if (event->type == GDK_2BUTTON_PRESS) {
- toggle_sym_value(menu);
- current = menu;
- display_tree_part();
- } else {
- browsed = menu;
- display_tree_part();
- }
-
- gtk_widget_realize(tree2_w);
- gtk_tree_view_set_cursor(view, path, NULL, FALSE);
- gtk_widget_grab_focus(tree2_w);
-
- return FALSE;
-}
-
-
-/* Fill a row of strings */
-static gchar **fill_row(struct menu *menu)
-{
- static gchar *row[COL_NUMBER];
- struct symbol *sym = menu->sym;
- const char *def;
- int stype;
- tristate val;
- enum prop_type ptype;
- int i;
-
- for (i = COL_OPTION; i <= COL_COLOR; i++)
- g_free(row[i]);
- bzero(row, sizeof(row));
-
- row[COL_OPTION] =
- g_strdup_printf("%s %s", _(menu_get_prompt(menu)),
- sym && !sym_has_value(sym) ? "(NEW)" : "");
-
- if (opt_mode == OPT_ALL && !menu_is_visible(menu))
- row[COL_COLOR] = g_strdup("DarkGray");
- else if (opt_mode == OPT_PROMPT &&
- menu_has_prompt(menu) && !menu_is_visible(menu))
- row[COL_COLOR] = g_strdup("DarkGray");
- else
- row[COL_COLOR] = g_strdup("Black");
-
- ptype = menu->prompt ? menu->prompt->type : P_UNKNOWN;
- switch (ptype) {
- case P_MENU:
- row[COL_PIXBUF] = (gchar *) xpm_menu;
- if (view_mode == SINGLE_VIEW)
- row[COL_PIXVIS] = GINT_TO_POINTER(TRUE);
- row[COL_BTNVIS] = GINT_TO_POINTER(FALSE);
- break;
- case P_COMMENT:
- row[COL_PIXBUF] = (gchar *) xpm_void;
- row[COL_PIXVIS] = GINT_TO_POINTER(FALSE);
- row[COL_BTNVIS] = GINT_TO_POINTER(FALSE);
- break;
- default:
- row[COL_PIXBUF] = (gchar *) xpm_void;
- row[COL_PIXVIS] = GINT_TO_POINTER(FALSE);
- row[COL_BTNVIS] = GINT_TO_POINTER(TRUE);
- break;
- }
-
- if (!sym)
- return row;
- row[COL_NAME] = g_strdup(sym->name);
-
- sym_calc_value(sym);
- sym->flags &= ~SYMBOL_CHANGED;
-
- if (sym_is_choice(sym)) { // parse childs for getting final value
- struct menu *child;
- struct symbol *def_sym = sym_get_choice_value(sym);
- struct menu *def_menu = NULL;
-
- row[COL_BTNVIS] = GINT_TO_POINTER(FALSE);
-
- for (child = menu->list; child; child = child->next) {
- if (menu_is_visible(child)
- && child->sym == def_sym)
- def_menu = child;
- }
-
- if (def_menu)
- row[COL_VALUE] =
- g_strdup(_(menu_get_prompt(def_menu)));
- }
- if (sym->flags & SYMBOL_CHOICEVAL)
- row[COL_BTNRAD] = GINT_TO_POINTER(TRUE);
-
- stype = sym_get_type(sym);
- switch (stype) {
- case S_BOOLEAN:
- if (GPOINTER_TO_INT(row[COL_PIXVIS]) == FALSE)
- row[COL_BTNVIS] = GINT_TO_POINTER(TRUE);
- if (sym_is_choice(sym))
- break;
- /* fall through */
- case S_TRISTATE:
- val = sym_get_tristate_value(sym);
- switch (val) {
- case no:
- row[COL_NO] = g_strdup("N");
- row[COL_VALUE] = g_strdup("N");
- row[COL_BTNACT] = GINT_TO_POINTER(FALSE);
- row[COL_BTNINC] = GINT_TO_POINTER(FALSE);
- break;
- case mod:
- row[COL_MOD] = g_strdup("M");
- row[COL_VALUE] = g_strdup("M");
- row[COL_BTNINC] = GINT_TO_POINTER(TRUE);
- break;
- case yes:
- row[COL_YES] = g_strdup("Y");
- row[COL_VALUE] = g_strdup("Y");
- row[COL_BTNACT] = GINT_TO_POINTER(TRUE);
- row[COL_BTNINC] = GINT_TO_POINTER(FALSE);
- break;
- }
-
- if (val != no && sym_tristate_within_range(sym, no))
- row[COL_NO] = g_strdup("_");
- if (val != mod && sym_tristate_within_range(sym, mod))
- row[COL_MOD] = g_strdup("_");
- if (val != yes && sym_tristate_within_range(sym, yes))
- row[COL_YES] = g_strdup("_");
- break;
- case S_INT:
- case S_HEX:
- case S_STRING:
- def = sym_get_string_value(sym);
- row[COL_VALUE] = g_strdup(def);
- row[COL_EDIT] = GINT_TO_POINTER(TRUE);
- row[COL_BTNVIS] = GINT_TO_POINTER(FALSE);
- break;
- }
-
- return row;
-}
-
-
-/* Set the node content with a row of strings */
-static void set_node(GtkTreeIter * node, struct menu *menu, gchar ** row)
-{
- GdkColor color;
- gboolean success;
- GdkPixbuf *pix;
-
- pix = gdk_pixbuf_new_from_xpm_data((const char **)
- row[COL_PIXBUF]);
-
- gdk_color_parse(row[COL_COLOR], &color);
- gdk_colormap_alloc_colors(gdk_colormap_get_system(), &color, 1,
- FALSE, FALSE, &success);
-
- gtk_tree_store_set(tree, node,
- COL_OPTION, row[COL_OPTION],
- COL_NAME, row[COL_NAME],
- COL_NO, row[COL_NO],
- COL_MOD, row[COL_MOD],
- COL_YES, row[COL_YES],
- COL_VALUE, row[COL_VALUE],
- COL_MENU, (gpointer) menu,
- COL_COLOR, &color,
- COL_EDIT, GPOINTER_TO_INT(row[COL_EDIT]),
- COL_PIXBUF, pix,
- COL_PIXVIS, GPOINTER_TO_INT(row[COL_PIXVIS]),
- COL_BTNVIS, GPOINTER_TO_INT(row[COL_BTNVIS]),
- COL_BTNACT, GPOINTER_TO_INT(row[COL_BTNACT]),
- COL_BTNINC, GPOINTER_TO_INT(row[COL_BTNINC]),
- COL_BTNRAD, GPOINTER_TO_INT(row[COL_BTNRAD]),
- -1);
-
- g_object_unref(pix);
-}
-
-
-/* Add a node to the tree */
-static void place_node(struct menu *menu, char **row)
-{
- GtkTreeIter *parent = parents[indent - 1];
- GtkTreeIter *node = parents[indent];
-
- gtk_tree_store_append(tree, node, parent);
- set_node(node, menu, row);
-}
-
-
-/* Find a node in the GTK+ tree */
-static GtkTreeIter found;
-
-/*
- * Find a menu in the GtkTree starting at parent.
- */
-GtkTreeIter *gtktree_iter_find_node(GtkTreeIter * parent,
- struct menu *tofind)
-{
- GtkTreeIter iter;
- GtkTreeIter *child = &iter;
- gboolean valid;
- GtkTreeIter *ret;
-
- valid = gtk_tree_model_iter_children(model2, child, parent);
- while (valid) {
- struct menu *menu;
-
- gtk_tree_model_get(model2, child, 6, &menu, -1);
-
- if (menu == tofind) {
- memcpy(&found, child, sizeof(GtkTreeIter));
- return &found;
- }
-
- ret = gtktree_iter_find_node(child, tofind);
- if (ret)
- return ret;
-
- valid = gtk_tree_model_iter_next(model2, child);
- }
-
- return NULL;
-}
-
-
-/*
- * Update the tree by adding/removing entries
- * Does not change other nodes
- */
-static void update_tree(struct menu *src, GtkTreeIter * dst)
-{
- struct menu *child1;
- GtkTreeIter iter, tmp;
- GtkTreeIter *child2 = &iter;
- gboolean valid;
- GtkTreeIter *sibling;
- struct symbol *sym;
- struct menu *menu1, *menu2;
-
- if (src == &rootmenu)
- indent = 1;
-
- valid = gtk_tree_model_iter_children(model2, child2, dst);
- for (child1 = src->list; child1; child1 = child1->next) {
-
- sym = child1->sym;
-
- reparse:
- menu1 = child1;
- if (valid)
- gtk_tree_model_get(model2, child2, COL_MENU,
- &menu2, -1);
- else
- menu2 = NULL; // force adding of a first child
-
-#ifdef DEBUG
- printf("%*c%s | %s\n", indent, ' ',
- menu1 ? menu_get_prompt(menu1) : "nil",
- menu2 ? menu_get_prompt(menu2) : "nil");
-#endif
-
- if ((opt_mode == OPT_NORMAL && !menu_is_visible(child1)) ||
- (opt_mode == OPT_PROMPT && !menu_has_prompt(child1)) ||
- (opt_mode == OPT_ALL && !menu_get_prompt(child1))) {
-
- /* remove node */
- if (gtktree_iter_find_node(dst, menu1) != NULL) {
- memcpy(&tmp, child2, sizeof(GtkTreeIter));
- valid = gtk_tree_model_iter_next(model2,
- child2);
- gtk_tree_store_remove(tree2, &tmp);
- if (!valid)
- return; /* next parent */
- else
- goto reparse; /* next child */
- } else
- continue;
- }
-
- if (menu1 != menu2) {
- if (gtktree_iter_find_node(dst, menu1) == NULL) { // add node
- if (!valid && !menu2)
- sibling = NULL;
- else
- sibling = child2;
- gtk_tree_store_insert_before(tree2,
- child2,
- dst, sibling);
- set_node(child2, menu1, fill_row(menu1));
- if (menu2 == NULL)
- valid = TRUE;
- } else { // remove node
- memcpy(&tmp, child2, sizeof(GtkTreeIter));
- valid = gtk_tree_model_iter_next(model2,
- child2);
- gtk_tree_store_remove(tree2, &tmp);
- if (!valid)
- return; // next parent
- else
- goto reparse; // next child
- }
- } else if (sym && (sym->flags & SYMBOL_CHANGED)) {
- set_node(child2, menu1, fill_row(menu1));
- }
-
- indent++;
- update_tree(child1, child2);
- indent--;
-
- valid = gtk_tree_model_iter_next(model2, child2);
- }
-}
-
-
-/* Display the whole tree (single/split/full view) */
-static void display_tree(struct menu *menu)
-{
- struct symbol *sym;
- struct property *prop;
- struct menu *child;
- enum prop_type ptype;
-
- if (menu == &rootmenu) {
- indent = 1;
- current = &rootmenu;
- }
-
- for (child = menu->list; child; child = child->next) {
- prop = child->prompt;
- sym = child->sym;
- ptype = prop ? prop->type : P_UNKNOWN;
-
- if (sym)
- sym->flags &= ~SYMBOL_CHANGED;
-
- if ((view_mode == SPLIT_VIEW)
- && !(child->flags & MENU_ROOT) && (tree == tree1))
- continue;
-
- if ((view_mode == SPLIT_VIEW) && (child->flags & MENU_ROOT)
- && (tree == tree2))
- continue;
-
- if ((opt_mode == OPT_NORMAL && menu_is_visible(child)) ||
- (opt_mode == OPT_PROMPT && menu_has_prompt(child)) ||
- (opt_mode == OPT_ALL && menu_get_prompt(child)))
- place_node(child, fill_row(child));
-#ifdef DEBUG
- printf("%*c%s: ", indent, ' ', menu_get_prompt(child));
- printf("%s", child->flags & MENU_ROOT ? "rootmenu | " : "");
- printf("%s", prop_get_type_name(ptype));
- printf(" | ");
- if (sym) {
- printf("%s", sym_type_name(sym->type));
- printf(" | ");
- printf("%s", dbg_sym_flags(sym->flags));
- printf("\n");
- } else
- printf("\n");
-#endif
- if ((view_mode != FULL_VIEW) && (ptype == P_MENU)
- && (tree == tree2))
- continue;
-/*
- if (((menu != &rootmenu) && !(menu->flags & MENU_ROOT))
- || (view_mode == FULL_VIEW)
- || (view_mode == SPLIT_VIEW))*/
-
- /* Change paned position if the view is not in 'split mode' */
- if (view_mode == SINGLE_VIEW || view_mode == FULL_VIEW) {
- gtk_paned_set_position(GTK_PANED(hpaned), 0);
- }
-
- if (((view_mode == SINGLE_VIEW) && (menu->flags & MENU_ROOT))
- || (view_mode == FULL_VIEW)
- || (view_mode == SPLIT_VIEW)) {
- indent++;
- display_tree(child);
- indent--;
- }
- }
-}
-
-/* Display a part of the tree starting at current node (single/split view) */
-static void display_tree_part(void)
-{
- if (tree2)
- gtk_tree_store_clear(tree2);
- if (view_mode == SINGLE_VIEW)
- display_tree(current);
- else if (view_mode == SPLIT_VIEW)
- display_tree(browsed);
- gtk_tree_view_expand_all(GTK_TREE_VIEW(tree2_w));
-}
-
-/* Display the list in the left frame (split view) */
-static void display_list(void)
-{
- if (tree1)
- gtk_tree_store_clear(tree1);
-
- tree = tree1;
- display_tree(&rootmenu);
- gtk_tree_view_expand_all(GTK_TREE_VIEW(tree1_w));
- tree = tree2;
-}
-
-void fixup_rootmenu(struct menu *menu)
-{
- struct menu *child;
- static int menu_cnt = 0;
-
- menu->flags |= MENU_ROOT;
- for (child = menu->list; child; child = child->next) {
- if (child->prompt && child->prompt->type == P_MENU) {
- menu_cnt++;
- fixup_rootmenu(child);
- menu_cnt--;
- } else if (!menu_cnt)
- fixup_rootmenu(child);
- }
-}
-
-
-/* Main */
-int main(int ac, char *av[])
-{
- const char *name;
- char *env;
- gchar *glade_file;
-
- bindtextdomain(PACKAGE, LOCALEDIR);
- bind_textdomain_codeset(PACKAGE, "UTF-8");
- textdomain(PACKAGE);
-
- /* GTK stuffs */
- gtk_set_locale();
- gtk_init(&ac, &av);
- glade_init();
-
- //add_pixmap_directory (PACKAGE_DATA_DIR "/" PACKAGE "/pixmaps");
- //add_pixmap_directory (PACKAGE_SOURCE_DIR "/pixmaps");
-
- /* Determine GUI path */
- env = getenv(SRCTREE);
- if (env)
- glade_file = g_strconcat(env, "/scripts/kconfig/gconf.glade", NULL);
- else if (av[0][0] == '/')
- glade_file = g_strconcat(av[0], ".glade", NULL);
- else
- glade_file = g_strconcat(g_get_current_dir(), "/", av[0], ".glade", NULL);
-
- /* Conf stuffs */
- if (ac > 1 && av[1][0] == '-') {
- switch (av[1][1]) {
- case 'a':
- //showAll = 1;
- break;
- case 's':
- conf_set_message_callback(NULL);
- break;
- case 'h':
- case '?':
- printf("%s [-s] <config>\n", av[0]);
- exit(0);
- }
- name = av[2];
- } else
- name = av[1];
-
- conf_parse(name);
- fixup_rootmenu(&rootmenu);
- conf_read(NULL);
-
- /* Load the interface and connect signals */
- init_main_window(glade_file);
- init_tree_model();
- init_left_tree();
- init_right_tree();
-
- switch (view_mode) {
- case SINGLE_VIEW:
- display_tree_part();
- break;
- case SPLIT_VIEW:
- display_list();
- break;
- case FULL_VIEW:
- display_tree(&rootmenu);
- break;
- }
-
- gtk_main();
-
- return 0;
-}
-
-static void conf_changed(void)
-{
- bool changed = conf_get_changed();
- gtk_widget_set_sensitive(save_btn, changed);
- gtk_widget_set_sensitive(save_menu_item, changed);
-}
+++ /dev/null
-<?xml version="1.0" standalone="no"?> <!--*- mode: xml -*-->
-
-<glade-interface>
-
-<widget class="GtkWindow" id="window1">
- <property name="visible">True</property>
- <property name="title" translatable="yes">Gtk Kernel Configurator</property>
- <property name="type">GTK_WINDOW_TOPLEVEL</property>
- <property name="window_position">GTK_WIN_POS_NONE</property>
- <property name="modal">False</property>
- <property name="default_width">640</property>
- <property name="default_height">480</property>
- <property name="resizable">True</property>
- <property name="destroy_with_parent">False</property>
- <property name="decorated">True</property>
- <property name="skip_taskbar_hint">False</property>
- <property name="skip_pager_hint">False</property>
- <property name="type_hint">GDK_WINDOW_TYPE_HINT_NORMAL</property>
- <property name="gravity">GDK_GRAVITY_NORTH_WEST</property>
- <signal name="destroy" handler="on_window1_destroy" object="window1"/>
- <signal name="size_request" handler="on_window1_size_request" object="vpaned1" last_modification_time="Fri, 11 Jan 2002 16:17:11 GMT"/>
- <signal name="delete_event" handler="on_window1_delete_event" object="window1" last_modification_time="Sun, 09 Mar 2003 19:42:46 GMT"/>
-
- <child>
- <widget class="GtkVBox" id="vbox1">
- <property name="visible">True</property>
- <property name="homogeneous">False</property>
- <property name="spacing">0</property>
-
- <child>
- <widget class="GtkMenuBar" id="menubar1">
- <property name="visible">True</property>
-
- <child>
- <widget class="GtkMenuItem" id="file1">
- <property name="visible">True</property>
- <property name="label" translatable="yes">_File</property>
- <property name="use_underline">True</property>
-
- <child>
- <widget class="GtkMenu" id="file1_menu">
-
- <child>
- <widget class="GtkImageMenuItem" id="load1">
- <property name="visible">True</property>
- <property name="tooltip" translatable="yes">Load a config file</property>
- <property name="label" translatable="yes">_Load</property>
- <property name="use_underline">True</property>
- <signal name="activate" handler="on_load1_activate"/>
- <accelerator key="L" modifiers="GDK_CONTROL_MASK" signal="activate"/>
-
- <child internal-child="image">
- <widget class="GtkImage" id="image39">
- <property name="visible">True</property>
- <property name="stock">gtk-open</property>
- <property name="icon_size">1</property>
- <property name="xalign">0.5</property>
- <property name="yalign">0.5</property>
- <property name="xpad">0</property>
- <property name="ypad">0</property>
- </widget>
- </child>
- </widget>
- </child>
-
- <child>
- <widget class="GtkImageMenuItem" id="save1">
- <property name="visible">True</property>
- <property name="tooltip" translatable="yes">Save the config in .config</property>
- <property name="label" translatable="yes">_Save</property>
- <property name="use_underline">True</property>
- <signal name="activate" handler="on_save_activate"/>
- <accelerator key="S" modifiers="GDK_CONTROL_MASK" signal="activate"/>
-
- <child internal-child="image">
- <widget class="GtkImage" id="image40">
- <property name="visible">True</property>
- <property name="stock">gtk-save</property>
- <property name="icon_size">1</property>
- <property name="xalign">0.5</property>
- <property name="yalign">0.5</property>
- <property name="xpad">0</property>
- <property name="ypad">0</property>
- </widget>
- </child>
- </widget>
- </child>
-
- <child>
- <widget class="GtkImageMenuItem" id="save_as1">
- <property name="visible">True</property>
- <property name="tooltip" translatable="yes">Save the config in a file</property>
- <property name="label" translatable="yes">Save _as</property>
- <property name="use_underline">True</property>
- <signal name="activate" handler="on_save_as1_activate"/>
-
- <child internal-child="image">
- <widget class="GtkImage" id="image41">
- <property name="visible">True</property>
- <property name="stock">gtk-save-as</property>
- <property name="icon_size">1</property>
- <property name="xalign">0.5</property>
- <property name="yalign">0.5</property>
- <property name="xpad">0</property>
- <property name="ypad">0</property>
- </widget>
- </child>
- </widget>
- </child>
-
- <child>
- <widget class="GtkSeparatorMenuItem" id="separator1">
- <property name="visible">True</property>
- </widget>
- </child>
-
- <child>
- <widget class="GtkImageMenuItem" id="quit1">
- <property name="visible">True</property>
- <property name="label" translatable="yes">_Quit</property>
- <property name="use_underline">True</property>
- <signal name="activate" handler="on_quit1_activate"/>
- <accelerator key="Q" modifiers="GDK_CONTROL_MASK" signal="activate"/>
-
- <child internal-child="image">
- <widget class="GtkImage" id="image42">
- <property name="visible">True</property>
- <property name="stock">gtk-quit</property>
- <property name="icon_size">1</property>
- <property name="xalign">0.5</property>
- <property name="yalign">0.5</property>
- <property name="xpad">0</property>
- <property name="ypad">0</property>
- </widget>
- </child>
- </widget>
- </child>
- </widget>
- </child>
- </widget>
- </child>
-
- <child>
- <widget class="GtkMenuItem" id="options1">
- <property name="visible">True</property>
- <property name="label" translatable="yes">_Options</property>
- <property name="use_underline">True</property>
-
- <child>
- <widget class="GtkMenu" id="options1_menu">
-
- <child>
- <widget class="GtkCheckMenuItem" id="show_name1">
- <property name="visible">True</property>
- <property name="tooltip" translatable="yes">Show name</property>
- <property name="label" translatable="yes">Show _name</property>
- <property name="use_underline">True</property>
- <property name="active">False</property>
- <signal name="activate" handler="on_show_name1_activate"/>
- </widget>
- </child>
-
- <child>
- <widget class="GtkCheckMenuItem" id="show_range1">
- <property name="visible">True</property>
- <property name="tooltip" translatable="yes">Show range (Y/M/N)</property>
- <property name="label" translatable="yes">Show _range</property>
- <property name="use_underline">True</property>
- <property name="active">False</property>
- <signal name="activate" handler="on_show_range1_activate"/>
- </widget>
- </child>
-
- <child>
- <widget class="GtkCheckMenuItem" id="show_data1">
- <property name="visible">True</property>
- <property name="tooltip" translatable="yes">Show value of the option</property>
- <property name="label" translatable="yes">Show _data</property>
- <property name="use_underline">True</property>
- <property name="active">False</property>
- <signal name="activate" handler="on_show_data1_activate"/>
- </widget>
- </child>
-
- <child>
- <widget class="GtkSeparatorMenuItem" id="separator2">
- <property name="visible">True</property>
- </widget>
- </child>
-
- <child>
- <widget class="GtkRadioMenuItem" id="set_option_mode1">
- <property name="visible">True</property>
- <property name="tooltip" translatable="yes">Show normal options</property>
- <property name="label" translatable="yes">Show normal options</property>
- <property name="use_underline">True</property>
- <property name="active">True</property>
- <signal name="activate" handler="on_set_option_mode1_activate"/>
- </widget>
- </child>
-
- <child>
- <widget class="GtkRadioMenuItem" id="set_option_mode2">
- <property name="visible">True</property>
- <property name="tooltip" translatable="yes">Show all options</property>
- <property name="label" translatable="yes">Show all _options</property>
- <property name="use_underline">True</property>
- <property name="active">False</property>
- <property name="group">set_option_mode1</property>
- <signal name="activate" handler="on_set_option_mode2_activate"/>
- </widget>
- </child>
-
- <child>
- <widget class="GtkRadioMenuItem" id="set_option_mode3">
- <property name="visible">True</property>
- <property name="tooltip" translatable="yes">Show all options with prompts</property>
- <property name="label" translatable="yes">Show all prompt options</property>
- <property name="use_underline">True</property>
- <property name="active">False</property>
- <property name="group">set_option_mode1</property>
- <signal name="activate" handler="on_set_option_mode3_activate"/>
- </widget>
- </child>
-
- </widget>
- </child>
- </widget>
- </child>
-
- <child>
- <widget class="GtkMenuItem" id="help1">
- <property name="visible">True</property>
- <property name="label" translatable="yes">_Help</property>
- <property name="use_underline">True</property>
-
- <child>
- <widget class="GtkMenu" id="help1_menu">
-
- <child>
- <widget class="GtkImageMenuItem" id="introduction1">
- <property name="visible">True</property>
- <property name="label" translatable="yes">_Introduction</property>
- <property name="use_underline">True</property>
- <signal name="activate" handler="on_introduction1_activate" last_modification_time="Fri, 15 Nov 2002 20:26:30 GMT"/>
- <accelerator key="I" modifiers="GDK_CONTROL_MASK" signal="activate"/>
-
- <child internal-child="image">
- <widget class="GtkImage" id="image43">
- <property name="visible">True</property>
- <property name="stock">gtk-dialog-question</property>
- <property name="icon_size">1</property>
- <property name="xalign">0.5</property>
- <property name="yalign">0.5</property>
- <property name="xpad">0</property>
- <property name="ypad">0</property>
- </widget>
- </child>
- </widget>
- </child>
-
- <child>
- <widget class="GtkImageMenuItem" id="about1">
- <property name="visible">True</property>
- <property name="label" translatable="yes">_About</property>
- <property name="use_underline">True</property>
- <signal name="activate" handler="on_about1_activate" last_modification_time="Fri, 15 Nov 2002 20:26:30 GMT"/>
- <accelerator key="A" modifiers="GDK_CONTROL_MASK" signal="activate"/>
-
- <child internal-child="image">
- <widget class="GtkImage" id="image44">
- <property name="visible">True</property>
- <property name="stock">gtk-properties</property>
- <property name="icon_size">1</property>
- <property name="xalign">0.5</property>
- <property name="yalign">0.5</property>
- <property name="xpad">0</property>
- <property name="ypad">0</property>
- </widget>
- </child>
- </widget>
- </child>
-
- <child>
- <widget class="GtkImageMenuItem" id="license1">
- <property name="visible">True</property>
- <property name="label" translatable="yes">_License</property>
- <property name="use_underline">True</property>
- <signal name="activate" handler="on_license1_activate" last_modification_time="Fri, 15 Nov 2002 20:26:30 GMT"/>
-
- <child internal-child="image">
- <widget class="GtkImage" id="image45">
- <property name="visible">True</property>
- <property name="stock">gtk-justify-fill</property>
- <property name="icon_size">1</property>
- <property name="xalign">0.5</property>
- <property name="yalign">0.5</property>
- <property name="xpad">0</property>
- <property name="ypad">0</property>
- </widget>
- </child>
- </widget>
- </child>
- </widget>
- </child>
- </widget>
- </child>
- </widget>
- <packing>
- <property name="padding">0</property>
- <property name="expand">False</property>
- <property name="fill">False</property>
- </packing>
- </child>
-
- <child>
- <widget class="GtkHandleBox" id="handlebox1">
- <property name="visible">True</property>
- <property name="shadow_type">GTK_SHADOW_OUT</property>
- <property name="handle_position">GTK_POS_LEFT</property>
- <property name="snap_edge">GTK_POS_TOP</property>
-
- <child>
- <widget class="GtkToolbar" id="toolbar1">
- <property name="visible">True</property>
- <property name="orientation">GTK_ORIENTATION_HORIZONTAL</property>
- <property name="toolbar_style">GTK_TOOLBAR_BOTH</property>
- <property name="tooltips">True</property>
- <property name="show_arrow">True</property>
-
- <child>
- <widget class="GtkToolButton" id="button1">
- <property name="visible">True</property>
- <property name="tooltip" translatable="yes">Goes up of one level (single view)</property>
- <property name="label" translatable="yes">Back</property>
- <property name="use_underline">True</property>
- <property name="stock_id">gtk-undo</property>
- <property name="visible_horizontal">True</property>
- <property name="visible_vertical">True</property>
- <property name="is_important">False</property>
- <signal name="clicked" handler="on_back_clicked"/>
- </widget>
- <packing>
- <property name="expand">False</property>
- <property name="homogeneous">True</property>
- </packing>
- </child>
-
- <child>
- <widget class="GtkToolItem" id="toolitem1">
- <property name="visible">True</property>
- <property name="visible_horizontal">True</property>
- <property name="visible_vertical">True</property>
- <property name="is_important">False</property>
-
- <child>
- <widget class="GtkVSeparator" id="vseparator1">
- <property name="visible">True</property>
- </widget>
- </child>
- </widget>
- <packing>
- <property name="expand">False</property>
- <property name="homogeneous">False</property>
- </packing>
- </child>
-
- <child>
- <widget class="GtkToolButton" id="button2">
- <property name="visible">True</property>
- <property name="tooltip" translatable="yes">Load a config file</property>
- <property name="label" translatable="yes">Load</property>
- <property name="use_underline">True</property>
- <property name="stock_id">gtk-open</property>
- <property name="visible_horizontal">True</property>
- <property name="visible_vertical">True</property>
- <property name="is_important">False</property>
- <signal name="clicked" handler="on_load_clicked"/>
- </widget>
- <packing>
- <property name="expand">False</property>
- <property name="homogeneous">True</property>
- </packing>
- </child>
-
- <child>
- <widget class="GtkToolButton" id="button3">
- <property name="visible">True</property>
- <property name="tooltip" translatable="yes">Save a config file</property>
- <property name="label" translatable="yes">Save</property>
- <property name="use_underline">True</property>
- <property name="stock_id">gtk-save</property>
- <property name="visible_horizontal">True</property>
- <property name="visible_vertical">True</property>
- <property name="is_important">False</property>
- <signal name="clicked" handler="on_save_activate"/>
- </widget>
- <packing>
- <property name="expand">False</property>
- <property name="homogeneous">True</property>
- </packing>
- </child>
-
- <child>
- <widget class="GtkToolItem" id="toolitem2">
- <property name="visible">True</property>
- <property name="visible_horizontal">True</property>
- <property name="visible_vertical">True</property>
- <property name="is_important">False</property>
-
- <child>
- <widget class="GtkVSeparator" id="vseparator2">
- <property name="visible">True</property>
- </widget>
- </child>
- </widget>
- <packing>
- <property name="expand">False</property>
- <property name="homogeneous">False</property>
- </packing>
- </child>
-
- <child>
- <widget class="GtkToolButton" id="button4">
- <property name="visible">True</property>
- <property name="tooltip" translatable="yes">Single view</property>
- <property name="label" translatable="yes">Single</property>
- <property name="use_underline">True</property>
- <property name="stock_id">gtk-missing-image</property>
- <property name="visible_horizontal">True</property>
- <property name="visible_vertical">True</property>
- <property name="is_important">False</property>
- <signal name="clicked" handler="on_single_clicked" last_modification_time="Sun, 12 Jan 2003 14:28:39 GMT"/>
- </widget>
- <packing>
- <property name="expand">False</property>
- <property name="homogeneous">True</property>
- </packing>
- </child>
-
- <child>
- <widget class="GtkToolButton" id="button5">
- <property name="visible">True</property>
- <property name="tooltip" translatable="yes">Split view</property>
- <property name="label" translatable="yes">Split</property>
- <property name="use_underline">True</property>
- <property name="stock_id">gtk-missing-image</property>
- <property name="visible_horizontal">True</property>
- <property name="visible_vertical">True</property>
- <property name="is_important">False</property>
- <signal name="clicked" handler="on_split_clicked" last_modification_time="Sun, 12 Jan 2003 14:28:45 GMT"/>
- </widget>
- <packing>
- <property name="expand">False</property>
- <property name="homogeneous">True</property>
- </packing>
- </child>
-
- <child>
- <widget class="GtkToolButton" id="button6">
- <property name="visible">True</property>
- <property name="tooltip" translatable="yes">Full view</property>
- <property name="label" translatable="yes">Full</property>
- <property name="use_underline">True</property>
- <property name="stock_id">gtk-missing-image</property>
- <property name="visible_horizontal">True</property>
- <property name="visible_vertical">True</property>
- <property name="is_important">False</property>
- <signal name="clicked" handler="on_full_clicked" last_modification_time="Sun, 12 Jan 2003 14:28:50 GMT"/>
- </widget>
- <packing>
- <property name="expand">False</property>
- <property name="homogeneous">True</property>
- </packing>
- </child>
-
- <child>
- <widget class="GtkToolItem" id="toolitem3">
- <property name="visible">True</property>
- <property name="visible_horizontal">True</property>
- <property name="visible_vertical">True</property>
- <property name="is_important">False</property>
-
- <child>
- <widget class="GtkVSeparator" id="vseparator3">
- <property name="visible">True</property>
- </widget>
- </child>
- </widget>
- <packing>
- <property name="expand">False</property>
- <property name="homogeneous">False</property>
- </packing>
- </child>
-
- <child>
- <widget class="GtkToolButton" id="button7">
- <property name="visible">True</property>
- <property name="tooltip" translatable="yes">Collapse the whole tree in the right frame</property>
- <property name="label" translatable="yes">Collapse</property>
- <property name="use_underline">True</property>
- <property name="stock_id">gtk-remove</property>
- <property name="visible_horizontal">True</property>
- <property name="visible_vertical">True</property>
- <property name="is_important">False</property>
- <signal name="clicked" handler="on_collapse_clicked"/>
- </widget>
- <packing>
- <property name="expand">False</property>
- <property name="homogeneous">True</property>
- </packing>
- </child>
-
- <child>
- <widget class="GtkToolButton" id="button8">
- <property name="visible">True</property>
- <property name="tooltip" translatable="yes">Expand the whole tree in the right frame</property>
- <property name="label" translatable="yes">Expand</property>
- <property name="use_underline">True</property>
- <property name="stock_id">gtk-add</property>
- <property name="visible_horizontal">True</property>
- <property name="visible_vertical">True</property>
- <property name="is_important">False</property>
- <signal name="clicked" handler="on_expand_clicked"/>
- </widget>
- <packing>
- <property name="expand">False</property>
- <property name="homogeneous">True</property>
- </packing>
- </child>
- </widget>
- </child>
- </widget>
- <packing>
- <property name="padding">0</property>
- <property name="expand">False</property>
- <property name="fill">False</property>
- </packing>
- </child>
-
- <child>
- <widget class="GtkHPaned" id="hpaned1">
- <property name="width_request">1</property>
- <property name="visible">True</property>
- <property name="can_focus">True</property>
- <property name="position">0</property>
-
- <child>
- <widget class="GtkScrolledWindow" id="scrolledwindow1">
- <property name="visible">True</property>
- <property name="hscrollbar_policy">GTK_POLICY_AUTOMATIC</property>
- <property name="vscrollbar_policy">GTK_POLICY_AUTOMATIC</property>
- <property name="shadow_type">GTK_SHADOW_IN</property>
- <property name="window_placement">GTK_CORNER_TOP_LEFT</property>
-
- <child>
- <widget class="GtkTreeView" id="treeview1">
- <property name="visible">True</property>
- <property name="can_focus">True</property>
- <property name="headers_visible">True</property>
- <property name="rules_hint">False</property>
- <property name="reorderable">False</property>
- <property name="enable_search">False</property>
- <signal name="cursor_changed" handler="on_treeview2_cursor_changed" last_modification_time="Sun, 12 Jan 2003 15:58:22 GMT"/>
- <signal name="button_press_event" handler="on_treeview1_button_press_event" last_modification_time="Sun, 12 Jan 2003 16:03:52 GMT"/>
- <signal name="key_press_event" handler="on_treeview2_key_press_event" last_modification_time="Sun, 12 Jan 2003 16:11:44 GMT"/>
- </widget>
- </child>
- </widget>
- <packing>
- <property name="shrink">True</property>
- <property name="resize">False</property>
- </packing>
- </child>
-
- <child>
- <widget class="GtkVPaned" id="vpaned1">
- <property name="visible">True</property>
- <property name="can_focus">True</property>
- <property name="position">0</property>
-
- <child>
- <widget class="GtkScrolledWindow" id="scrolledwindow2">
- <property name="visible">True</property>
- <property name="hscrollbar_policy">GTK_POLICY_AUTOMATIC</property>
- <property name="vscrollbar_policy">GTK_POLICY_AUTOMATIC</property>
- <property name="shadow_type">GTK_SHADOW_IN</property>
- <property name="window_placement">GTK_CORNER_TOP_LEFT</property>
-
- <child>
- <widget class="GtkTreeView" id="treeview2">
- <property name="visible">True</property>
- <property name="can_focus">True</property>
- <property name="has_focus">True</property>
- <property name="headers_visible">True</property>
- <property name="rules_hint">False</property>
- <property name="reorderable">False</property>
- <property name="enable_search">False</property>
- <signal name="cursor_changed" handler="on_treeview2_cursor_changed" last_modification_time="Sun, 12 Jan 2003 15:57:55 GMT"/>
- <signal name="button_press_event" handler="on_treeview2_button_press_event" last_modification_time="Sun, 12 Jan 2003 15:57:58 GMT"/>
- <signal name="key_press_event" handler="on_treeview2_key_press_event" last_modification_time="Sun, 12 Jan 2003 15:58:01 GMT"/>
- </widget>
- </child>
- </widget>
- <packing>
- <property name="shrink">True</property>
- <property name="resize">False</property>
- </packing>
- </child>
-
- <child>
- <widget class="GtkScrolledWindow" id="scrolledwindow3">
- <property name="visible">True</property>
- <property name="hscrollbar_policy">GTK_POLICY_NEVER</property>
- <property name="vscrollbar_policy">GTK_POLICY_AUTOMATIC</property>
- <property name="shadow_type">GTK_SHADOW_IN</property>
- <property name="window_placement">GTK_CORNER_TOP_LEFT</property>
-
- <child>
- <widget class="GtkTextView" id="textview3">
- <property name="visible">True</property>
- <property name="can_focus">True</property>
- <property name="editable">False</property>
- <property name="overwrite">False</property>
- <property name="accepts_tab">True</property>
- <property name="justification">GTK_JUSTIFY_LEFT</property>
- <property name="wrap_mode">GTK_WRAP_WORD</property>
- <property name="cursor_visible">True</property>
- <property name="pixels_above_lines">0</property>
- <property name="pixels_below_lines">0</property>
- <property name="pixels_inside_wrap">0</property>
- <property name="left_margin">0</property>
- <property name="right_margin">0</property>
- <property name="indent">0</property>
- <property name="text" translatable="yes">Sorry, no help available for this option yet.</property>
- </widget>
- </child>
- </widget>
- <packing>
- <property name="shrink">True</property>
- <property name="resize">True</property>
- </packing>
- </child>
- </widget>
- <packing>
- <property name="shrink">True</property>
- <property name="resize">True</property>
- </packing>
- </child>
- </widget>
- <packing>
- <property name="padding">0</property>
- <property name="expand">True</property>
- <property name="fill">True</property>
- </packing>
- </child>
- </widget>
- </child>
-</widget>
-
-</glade-interface>
+++ /dev/null
-/*
- * Copyright (C) 2002 Roman Zippel <zippel@linux-m68k.org>
- * Released under the terms of the GNU GPL v2.0.
- */
-
-static const char *xpm_load[] = {
-"22 22 5 1",
-". c None",
-"# c #000000",
-"c c #838100",
-"a c #ffff00",
-"b c #ffffff",
-"......................",
-"......................",
-"......................",
-"............####....#.",
-"...........#....##.##.",
-"..................###.",
-".................####.",
-".####...........#####.",
-"#abab##########.......",
-"#babababababab#.......",
-"#ababababababa#.......",
-"#babababababab#.......",
-"#ababab###############",
-"#babab##cccccccccccc##",
-"#abab##cccccccccccc##.",
-"#bab##cccccccccccc##..",
-"#ab##cccccccccccc##...",
-"#b##cccccccccccc##....",
-"###cccccccccccc##.....",
-"##cccccccccccc##......",
-"###############.......",
-"......................"};
-
-static const char *xpm_save[] = {
-"22 22 5 1",
-". c None",
-"# c #000000",
-"a c #838100",
-"b c #c5c2c5",
-"c c #cdb6d5",
-"......................",
-".####################.",
-".#aa#bbbbbbbbbbbb#bb#.",
-".#aa#bbbbbbbbbbbb#bb#.",
-".#aa#bbbbbbbbbcbb####.",
-".#aa#bbbccbbbbbbb#aa#.",
-".#aa#bbbccbbbbbbb#aa#.",
-".#aa#bbbbbbbbbbbb#aa#.",
-".#aa#bbbbbbbbbbbb#aa#.",
-".#aa#bbbbbbbbbbbb#aa#.",
-".#aa#bbbbbbbbbbbb#aa#.",
-".#aaa############aaa#.",
-".#aaaaaaaaaaaaaaaaaa#.",
-".#aaaaaaaaaaaaaaaaaa#.",
-".#aaa#############aa#.",
-".#aaa#########bbb#aa#.",
-".#aaa#########bbb#aa#.",
-".#aaa#########bbb#aa#.",
-".#aaa#########bbb#aa#.",
-".#aaa#########bbb#aa#.",
-"..##################..",
-"......................"};
-
-static const char *xpm_back[] = {
-"22 22 3 1",
-". c None",
-"# c #000083",
-"a c #838183",
-"......................",
-"......................",
-"......................",
-"......................",
-"......................",
-"...........######a....",
-"..#......##########...",
-"..##...####......##a..",
-"..###.###.........##..",
-"..######..........##..",
-"..#####...........##..",
-"..######..........##..",
-"..#######.........##..",
-"..########.......##a..",
-"...............a###...",
-"...............###....",
-"......................",
-"......................",
-"......................",
-"......................",
-"......................",
-"......................"};
-
-static const char *xpm_tree_view[] = {
-"22 22 2 1",
-". c None",
-"# c #000000",
-"......................",
-"......................",
-"......#...............",
-"......#...............",
-"......#...............",
-"......#...............",
-"......#...............",
-"......########........",
-"......#...............",
-"......#...............",
-"......#...............",
-"......#...............",
-"......#...............",
-"......########........",
-"......#...............",
-"......#...............",
-"......#...............",
-"......#...............",
-"......#...............",
-"......########........",
-"......................",
-"......................"};
-
-static const char *xpm_single_view[] = {
-"22 22 2 1",
-". c None",
-"# c #000000",
-"......................",
-"......................",
-"..........#...........",
-"..........#...........",
-"..........#...........",
-"..........#...........",
-"..........#...........",
-"..........#...........",
-"..........#...........",
-"..........#...........",
-"..........#...........",
-"..........#...........",
-"..........#...........",
-"..........#...........",
-"..........#...........",
-"..........#...........",
-"..........#...........",
-"..........#...........",
-"..........#...........",
-"..........#...........",
-"......................",
-"......................"};
-
-static const char *xpm_split_view[] = {
-"22 22 2 1",
-". c None",
-"# c #000000",
-"......................",
-"......................",
-"......#......#........",
-"......#......#........",
-"......#......#........",
-"......#......#........",
-"......#......#........",
-"......#......#........",
-"......#......#........",
-"......#......#........",
-"......#......#........",
-"......#......#........",
-"......#......#........",
-"......#......#........",
-"......#......#........",
-"......#......#........",
-"......#......#........",
-"......#......#........",
-"......#......#........",
-"......#......#........",
-"......................",
-"......................"};
-
-static const char *xpm_symbol_no[] = {
-"12 12 2 1",
-" c white",
-". c black",
-" ",
-" .......... ",
-" . . ",
-" . . ",
-" . . ",
-" . . ",
-" . . ",
-" . . ",
-" . . ",
-" . . ",
-" .......... ",
-" "};
-
-static const char *xpm_symbol_mod[] = {
-"12 12 2 1",
-" c white",
-". c black",
-" ",
-" .......... ",
-" . . ",
-" . . ",
-" . .. . ",
-" . .... . ",
-" . .... . ",
-" . .. . ",
-" . . ",
-" . . ",
-" .......... ",
-" "};
-
-static const char *xpm_symbol_yes[] = {
-"12 12 2 1",
-" c white",
-". c black",
-" ",
-" .......... ",
-" . . ",
-" . . ",
-" . . . ",
-" . .. . ",
-" . . .. . ",
-" . .... . ",
-" . .. . ",
-" . . ",
-" .......... ",
-" "};
-
-static const char *xpm_choice_no[] = {
-"12 12 2 1",
-" c white",
-". c black",
-" ",
-" .... ",
-" .. .. ",
-" . . ",
-" . . ",
-" . . ",
-" . . ",
-" . . ",
-" . . ",
-" .. .. ",
-" .... ",
-" "};
-
-static const char *xpm_choice_yes[] = {
-"12 12 2 1",
-" c white",
-". c black",
-" ",
-" .... ",
-" .. .. ",
-" . . ",
-" . .. . ",
-" . .... . ",
-" . .... . ",
-" . .. . ",
-" . . ",
-" .. .. ",
-" .... ",
-" "};
-
-static const char *xpm_menu[] = {
-"12 12 2 1",
-" c white",
-". c black",
-" ",
-" .......... ",
-" . . ",
-" . .. . ",
-" . .... . ",
-" . ...... . ",
-" . ...... . ",
-" . .... . ",
-" . .. . ",
-" . . ",
-" .......... ",
-" "};
-
-static const char *xpm_menu_inv[] = {
-"12 12 2 1",
-" c white",
-". c black",
-" ",
-" .......... ",
-" .......... ",
-" .. ...... ",
-" .. .... ",
-" .. .. ",
-" .. .. ",
-" .. .... ",
-" .. ...... ",
-" .......... ",
-" .......... ",
-" "};
-
-static const char *xpm_menuback[] = {
-"12 12 2 1",
-" c white",
-". c black",
-" ",
-" .......... ",
-" . . ",
-" . .. . ",
-" . .... . ",
-" . ...... . ",
-" . ...... . ",
-" . .... . ",
-" . .. . ",
-" . . ",
-" .......... ",
-" "};
-
-static const char *xpm_void[] = {
-"12 12 2 1",
-" c white",
-". c black",
-" ",
-" ",
-" ",
-" ",
-" ",
-" ",
-" ",
-" ",
-" ",
-" ",
-" ",
-" "};
+++ /dev/null
-Introduction
-------------
-
-The configuration database is a collection of configuration options
-organized in a tree structure:
-
- +- Code maturity level options
- | +- Prompt for development and/or incomplete code/drivers
- +- General setup
- | +- Networking support
- | +- System V IPC
- | +- BSD Process Accounting
- | +- Sysctl support
- +- Loadable module support
- | +- Enable loadable module support
- | +- Set version information on all module symbols
- | +- Kernel module loader
- +- ...
-
-Every entry has its own dependencies. These dependencies are used
-to determine the visibility of an entry. Any child entry is only
-visible if its parent entry is also visible.
-
-Menu entries
-------------
-
-Most entries define a config option; all other entries help to organize
-them. A single configuration option is defined like this:
-
-config MODVERSIONS
- bool "Set version information on all module symbols"
- depends on MODULES
- help
- Usually, modules have to be recompiled whenever you switch to a new
- kernel. ...
-
-Every line starts with a key word and can be followed by multiple
-arguments. "config" starts a new config entry. The following lines
-define attributes for this config option. Attributes can be the type of
-the config option, input prompt, dependencies, help text and default
-values. A config option can be defined multiple times with the same
-name, but every definition can have only a single input prompt and the
-type must not conflict.
-
-Menu attributes
----------------
-
-A menu entry can have a number of attributes. Not all of them are
-applicable everywhere (see syntax).
-
-- type definition: "bool"/"tristate"/"string"/"hex"/"int"
- Every config option must have a type. There are only two basic types:
- tristate and string; the other types are based on these two. The type
- definition optionally accepts an input prompt, so these two examples
- are equivalent:
-
- bool "Networking support"
- and
- bool
- prompt "Networking support"
-
-- input prompt: "prompt" <prompt> ["if" <expr>]
- Every menu entry can have at most one prompt, which is used to display
- to the user. Optionally dependencies only for this prompt can be added
- with "if".
-
-- default value: "default" <expr> ["if" <expr>]
- A config option can have any number of default values. If multiple
- default values are visible, only the first defined one is active.
- Default values are not limited to the menu entry where they are
- defined. This means the default can be defined somewhere else or be
- overridden by an earlier definition.
- The default value is only assigned to the config symbol if no other
- value was set by the user (via the input prompt above). If an input
- prompt is visible the default value is presented to the user and can
- be overridden by him.
- Optionally, dependencies only for this default value can be added with
- "if".
-
-- type definition + default value:
- "def_bool"/"def_tristate" <expr> ["if" <expr>]
- This is a shorthand notation for a type definition plus a value.
- Optionally dependencies for this default value can be added with "if".
-
-- dependencies: "depends on" <expr>
- This defines a dependency for this menu entry. If multiple
- dependencies are defined, they are connected with '&&'. Dependencies
- are applied to all other options within this menu entry (which also
- accept an "if" expression), so these two examples are equivalent:
-
- bool "foo" if BAR
- default y if BAR
- and
- depends on BAR
- bool "foo"
- default y
-
-- reverse dependencies: "select" <symbol> ["if" <expr>]
- While normal dependencies reduce the upper limit of a symbol (see
- below), reverse dependencies can be used to force a lower limit of
- another symbol. The value of the current menu symbol is used as the
- minimal value <symbol> can be set to. If <symbol> is selected multiple
- times, the limit is set to the largest selection.
- Reverse dependencies can only be used with boolean or tristate
- symbols.
- Note:
- select should be used with care. select will force
- a symbol to a value without visiting the dependencies.
- By abusing select you are able to select a symbol FOO even
- if FOO depends on BAR that is not set.
- In general use select only for non-visible symbols
- (no prompts anywhere) and for symbols with no dependencies.
- That will limit the usefulness but on the other hand avoid
- the illegal configurations all over.
-
-- limiting menu display: "visible if" <expr>
- This attribute is only applicable to menu blocks, if the condition is
- false, the menu block is not displayed to the user (the symbols
- contained there can still be selected by other symbols, though). It is
- similar to a conditional "prompt" attribute for individual menu
- entries. Default value of "visible" is true.
-
-- numerical ranges: "range" <symbol> <symbol> ["if" <expr>]
- This allows to limit the range of possible input values for int
- and hex symbols. The user can only input a value which is larger than
- or equal to the first symbol and smaller than or equal to the second
- symbol.
-
-- help text: "help" or "---help---"
- This defines a help text. The end of the help text is determined by
- the indentation level, this means it ends at the first line which has
- a smaller indentation than the first line of the help text.
- "---help---" and "help" do not differ in behaviour, "---help---" is
- used to help visually separate configuration logic from help within
- the file as an aid to developers.
-
-- misc options: "option" <symbol>[=<value>]
- Various less common options can be defined via this option syntax,
- which can modify the behaviour of the menu entry and its config
- symbol. These options are currently possible:
-
- - "defconfig_list"
- This declares a list of default entries which can be used when
- looking for the default configuration (which is used when the main
- .config doesn't exists yet.)
-
- - "modules"
- This declares the symbol to be used as the MODULES symbol, which
- enables the third modular state for all config symbols.
- At most one symbol may have the "modules" option set.
-
- - "env"=<value>
- This imports the environment variable into Kconfig. It behaves like
- a default, except that the value comes from the environment, this
- also means that the behaviour when mixing it with normal defaults is
- undefined at this point. The symbol is currently not exported back
- to the build environment (if this is desired, it can be done via
- another symbol).
-
- - "allnoconfig_y"
- This declares the symbol as one that should have the value y when
- using "allnoconfig". Used for symbols that hide other symbols.
-
-Menu dependencies
------------------
-
-Dependencies define the visibility of a menu entry and can also reduce
-the input range of tristate symbols. The tristate logic used in the
-expressions uses one more state than normal boolean logic to express the
-module state. Dependency expressions have the following syntax:
-
-<expr> ::= <symbol> (1)
- <symbol> '=' <symbol> (2)
- <symbol> '!=' <symbol> (3)
- '(' <expr> ')' (4)
- '!' <expr> (5)
- <expr> '&&' <expr> (6)
- <expr> '||' <expr> (7)
-
-Expressions are listed in decreasing order of precedence.
-
-(1) Convert the symbol into an expression. Boolean and tristate symbols
- are simply converted into the respective expression values. All
- other symbol types result in 'n'.
-(2) If the values of both symbols are equal, it returns 'y',
- otherwise 'n'.
-(3) If the values of both symbols are equal, it returns 'n',
- otherwise 'y'.
-(4) Returns the value of the expression. Used to override precedence.
-(5) Returns the result of (2-/expr/).
-(6) Returns the result of min(/expr/, /expr/).
-(7) Returns the result of max(/expr/, /expr/).
-
-An expression can have a value of 'n', 'm' or 'y' (or 0, 1, 2
-respectively for calculations). A menu entry becomes visible when its
-expression evaluates to 'm' or 'y'.
-
-There are two types of symbols: constant and non-constant symbols.
-Non-constant symbols are the most common ones and are defined with the
-'config' statement. Non-constant symbols consist entirely of alphanumeric
-characters or underscores.
-Constant symbols are only part of expressions. Constant symbols are
-always surrounded by single or double quotes. Within the quote, any
-other character is allowed and the quotes can be escaped using '\'.
-
-Menu structure
---------------
-
-The position of a menu entry in the tree is determined in two ways. First
-it can be specified explicitly:
-
-menu "Network device support"
- depends on NET
-
-config NETDEVICES
- ...
-
-endmenu
-
-All entries within the "menu" ... "endmenu" block become a submenu of
-"Network device support". All subentries inherit the dependencies from
-the menu entry, e.g. this means the dependency "NET" is added to the
-dependency list of the config option NETDEVICES.
-
-The other way to generate the menu structure is done by analyzing the
-dependencies. If a menu entry somehow depends on the previous entry, it
-can be made a submenu of it. First, the previous (parent) symbol must
-be part of the dependency list and then one of these two conditions
-must be true:
-- the child entry must become invisible, if the parent is set to 'n'
-- the child entry must only be visible, if the parent is visible
-
-config MODULES
- bool "Enable loadable module support"
-
-config MODVERSIONS
- bool "Set version information on all module symbols"
- depends on MODULES
-
-comment "module support disabled"
- depends on !MODULES
-
-MODVERSIONS directly depends on MODULES, this means it's only visible if
-MODULES is different from 'n'. The comment on the other hand is always
-visible when MODULES is visible (the (empty) dependency of MODULES is
-also part of the comment dependencies).
-
-
-Kconfig syntax
---------------
-
-The configuration file describes a series of menu entries, where every
-line starts with a keyword (except help texts). The following keywords
-end a menu entry:
-- config
-- menuconfig
-- choice/endchoice
-- comment
-- menu/endmenu
-- if/endif
-- source
-The first five also start the definition of a menu entry.
-
-config:
-
- "config" <symbol>
- <config options>
-
-This defines a config symbol <symbol> and accepts any of above
-attributes as options.
-
-menuconfig:
- "menuconfig" <symbol>
- <config options>
-
-This is similar to the simple config entry above, but it also gives a
-hint to front ends, that all suboptions should be displayed as a
-separate list of options.
-
-choices:
-
- "choice" [symbol]
- <choice options>
- <choice block>
- "endchoice"
-
-This defines a choice group and accepts any of the above attributes as
-options. A choice can only be of type bool or tristate, while a boolean
-choice only allows a single config entry to be selected, a tristate
-choice also allows any number of config entries to be set to 'm'. This
-can be used if multiple drivers for a single hardware exists and only a
-single driver can be compiled/loaded into the kernel, but all drivers
-can be compiled as modules.
-A choice accepts another option "optional", which allows to set the
-choice to 'n' and no entry needs to be selected.
-If no [symbol] is associated with a choice, then you can not have multiple
-definitions of that choice. If a [symbol] is associated to the choice,
-then you may define the same choice (ie. with the same entries) in another
-place.
-
-comment:
-
- "comment" <prompt>
- <comment options>
-
-This defines a comment which is displayed to the user during the
-configuration process and is also echoed to the output files. The only
-possible options are dependencies.
-
-menu:
-
- "menu" <prompt>
- <menu options>
- <menu block>
- "endmenu"
-
-This defines a menu block, see "Menu structure" above for more
-information. The only possible options are dependencies and "visible"
-attributes.
-
-if:
-
- "if" <expr>
- <if block>
- "endif"
-
-This defines an if block. The dependency expression <expr> is appended
-to all enclosed menu entries.
-
-source:
-
- "source" <prompt>
-
-This reads the specified configuration file. This file is always parsed.
-
-mainmenu:
-
- "mainmenu" <prompt>
-
-This sets the config program's title bar if the config program chooses
-to use it. It should be placed at the top of the configuration, before any
-other statement.
-
-
-Kconfig hints
--------------
-This is a collection of Kconfig tips, most of which aren't obvious at
-first glance and most of which have become idioms in several Kconfig
-files.
-
-Adding common features and make the usage configurable
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-It is a common idiom to implement a feature/functionality that are
-relevant for some architectures but not all.
-The recommended way to do so is to use a config variable named HAVE_*
-that is defined in a common Kconfig file and selected by the relevant
-architectures.
-An example is the generic IOMAP functionality.
-
-We would in lib/Kconfig see:
-
-# Generic IOMAP is used to ...
-config HAVE_GENERIC_IOMAP
-
-config GENERIC_IOMAP
- depends on HAVE_GENERIC_IOMAP && FOO
-
-And in lib/Makefile we would see:
-obj-$(CONFIG_GENERIC_IOMAP) += iomap.o
-
-For each architecture using the generic IOMAP functionality we would see:
-
-config X86
- select ...
- select HAVE_GENERIC_IOMAP
- select ...
-
-Note: we use the existing config option and avoid creating a new
-config variable to select HAVE_GENERIC_IOMAP.
-
-Note: the use of the internal config variable HAVE_GENERIC_IOMAP, it is
-introduced to overcome the limitation of select which will force a
-config option to 'y' no matter the dependencies.
-The dependencies are moved to the symbol GENERIC_IOMAP and we avoid the
-situation where select forces a symbol equals to 'y'.
-
-Build as module only
-~~~~~~~~~~~~~~~~~~~~
-To restrict a component build to module-only, qualify its config symbol
-with "depends on m". E.g.:
-
-config FOO
- depends on BAR && m
-
-limits FOO to module (=m) or disabled (=n).
-
-Kconfig recursive dependency limitations
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-If you've hit the Kconfig error: "recursive dependency detected" you've run
-into a recursive dependency issue with Kconfig, a recursive dependency can be
-summarized as a circular dependency. The kconfig tools need to ensure that
-Kconfig files comply with specified configuration requirements. In order to do
-that kconfig must determine the values that are possible for all Kconfig
-symbols, this is currently not possible if there is a circular relation
-between two or more Kconfig symbols. For more details refer to the "Simple
-Kconfig recursive issue" subsection below. Kconfig does not do recursive
-dependency resolution; this has a few implications for Kconfig file writers.
-We'll first explain why this issues exists and then provide an example
-technical limitation which this brings upon Kconfig developers. Eager
-developers wishing to try to address this limitation should read the next
-subsections.
-
-Simple Kconfig recursive issue
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-Read: Documentation/kbuild/Kconfig.recursion-issue-01
-
-Test with:
-
-make KBUILD_KCONFIG=Documentation/kbuild/Kconfig.recursion-issue-01 allnoconfig
-
-Cumulative Kconfig recursive issue
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-Read: Documentation/kbuild/Kconfig.recursion-issue-02
-
-Test with:
-
-make KBUILD_KCONFIG=Documentation/kbuild/Kconfig.recursion-issue-02 allnoconfig
-
-Practical solutions to kconfig recursive issue
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-Developers who run into the recursive Kconfig issue have three options
-at their disposal. We document them below and also provide a list of
-historical issues resolved through these different solutions.
-
- a) Remove any superfluous "select FOO" or "depends on FOO"
- b) Match dependency semantics:
- b1) Swap all "select FOO" to "depends on FOO" or,
- b2) Swap all "depends on FOO" to "select FOO"
-
-The resolution to a) can be tested with the sample Kconfig file
-Documentation/kbuild/Kconfig.recursion-issue-01 through the removal
-of the "select CORE" from CORE_BELL_A_ADVANCED as that is implicit already
-since CORE_BELL_A depends on CORE. At times it may not be possible to remove
-some dependency criteria, for such cases you can work with solution b).
-
-The two different resolutions for b) can be tested in the sample Kconfig file
-Documentation/kbuild/Kconfig.recursion-issue-02.
-
-Below is a list of examples of prior fixes for these types of recursive issues;
-all errors appear to involve one or more select's and one or more "depends on".
-
-commit fix
-====== ===
-06b718c01208 select A -> depends on A
-c22eacfe82f9 depends on A -> depends on B
-6a91e854442c select A -> depends on A
-118c565a8f2e select A -> select B
-f004e5594705 select A -> depends on A
-c7861f37b4c6 depends on A -> (null)
-80c69915e5fb select A -> (null) (1)
-c2218e26c0d0 select A -> depends on A (1)
-d6ae99d04e1c select A -> depends on A
-95ca19cf8cbf select A -> depends on A
-8f057d7bca54 depends on A -> (null)
-8f057d7bca54 depends on A -> select A
-a0701f04846e select A -> depends on A
-0c8b92f7f259 depends on A -> (null)
-e4e9e0540928 select A -> depends on A (2)
-7453ea886e87 depends on A > (null) (1)
-7b1fff7e4fdf select A -> depends on A
-86c747d2a4f0 select A -> depends on A
-d9f9ab51e55e select A -> depends on A
-0c51a4d8abd6 depends on A -> select A (3)
-e98062ed6dc4 select A -> depends on A (3)
-91e5d284a7f1 select A -> (null)
-
-(1) Partial (or no) quote of error.
-(2) That seems to be the gist of that fix.
-(3) Same error.
-
-Future kconfig work
-~~~~~~~~~~~~~~~~~~~
-
-Work on kconfig is welcomed on both areas of clarifying semantics and on
-evaluating the use of a full SAT solver for it. A full SAT solver can be
-desirable to enable more complex dependency mappings and / or queries,
-for instance on possible use case for a SAT solver could be that of handling
-the current known recursive dependency issues. It is not known if this would
-address such issues but such evaluation is desirable. If support for a full SAT
-solver proves too complex or that it cannot address recursive dependency issues
-Kconfig should have at least clear and well defined semantics which also
-addresses and documents limitations or requirements such as the ones dealing
-with recursive dependencies.
-
-Further work on both of these areas is welcomed on Kconfig. We elaborate
-on both of these in the next two subsections.
-
-Semantics of Kconfig
-~~~~~~~~~~~~~~~~~~~~
-
-The use of Kconfig is broad, Linux is now only one of Kconfig's users:
-one study has completed a broad analysis of Kconfig use in 12 projects [0].
-Despite its widespread use, and although this document does a reasonable job
-in documenting basic Kconfig syntax a more precise definition of Kconfig
-semantics is welcomed. One project deduced Kconfig semantics through
-the use of the xconfig configurator [1]. Work should be done to confirm if
-the deduced semantics matches our intended Kconfig design goals.
-
-Having well defined semantics can be useful for tools for practical
-evaluation of depenencies, for instance one such use known case was work to
-express in boolean abstraction of the inferred semantics of Kconfig to
-translate Kconfig logic into boolean formulas and run a SAT solver on this to
-find dead code / features (always inactive), 114 dead features were found in
-Linux using this methodology [1] (Section 8: Threats to validity).
-
-Confirming this could prove useful as Kconfig stands as one of the the leading
-industrial variability modeling languages [1] [2]. Its study would help
-evaluate practical uses of such languages, their use was only theoretical
-and real world requirements were not well understood. As it stands though
-only reverse engineering techniques have been used to deduce semantics from
-variability modeling languages such as Kconfig [3].
-
-[0] http://www.eng.uwaterloo.ca/~shshe/kconfig_semantics.pdf
-[1] http://gsd.uwaterloo.ca/sites/default/files/vm-2013-berger.pdf
-[2] http://gsd.uwaterloo.ca/sites/default/files/ase241-berger_0.pdf
-[3] http://gsd.uwaterloo.ca/sites/default/files/icse2011.pdf
-
-Full SAT solver for Kconfig
-~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-Although SAT solvers [0] haven't yet been used by Kconfig directly, as noted in
-the previous subsection, work has been done however to express in boolean
-abstraction the inferred semantics of Kconfig to translate Kconfig logic into
-boolean formulas and run a SAT solver on it [1]. Another known related project
-is CADOS [2] (former VAMOS [3]) and the tools, mainly undertaker [4], which has
-been introduced first with [5]. The basic concept of undertaker is to exract
-variability models from Kconfig, and put them together with a propositional
-formula extracted from CPP #ifdefs and build-rules into a SAT solver in order
-to find dead code, dead files, and dead symbols. If using a SAT solver is
-desirable on Kconfig one approach would be to evaluate repurposing such efforts
-somehow on Kconfig. There is enough interest from mentors of existing projects
-to not only help advise how to integrate this work upstream but also help
-maintain it long term. Interested developers should visit:
-
-http://kernelnewbies.org/KernelProjects/kconfig-sat
-
-[0] http://www.cs.cornell.edu/~sabhar/chapters/SATSolvers-KR-Handbook.pdf
-[1] http://gsd.uwaterloo.ca/sites/default/files/vm-2013-berger.pdf
-[2] https://cados.cs.fau.de
-[3] https://vamos.cs.fau.de
-[4] https://undertaker.cs.fau.de
-[5] https://www4.cs.fau.de/Publications/2011/tartler_11_eurosys.pdf
+++ /dev/null
-/*
- * Arnaldo Carvalho de Melo <acme@conectiva.com.br>, 2005
- *
- * Released under the terms of the GNU GPL v2.0
- */
-
-#include <stdlib.h>
-#include <string.h>
-
-#include "lkc.h"
-
-static char *escape(const char* text, char *bf, int len)
-{
- char *bfp = bf;
- int multiline = strchr(text, '\n') != NULL;
- int eol = 0;
- int textlen = strlen(text);
-
- if ((textlen > 0) && (text[textlen-1] == '\n'))
- eol = 1;
-
- *bfp++ = '"';
- --len;
-
- if (multiline) {
- *bfp++ = '"';
- *bfp++ = '\n';
- *bfp++ = '"';
- len -= 3;
- }
-
- while (*text != '\0' && len > 1) {
- if (*text == '"')
- *bfp++ = '\\';
- else if (*text == '\n') {
- *bfp++ = '\\';
- *bfp++ = 'n';
- *bfp++ = '"';
- *bfp++ = '\n';
- *bfp++ = '"';
- len -= 5;
- ++text;
- goto next;
- }
- else if (*text == '\\') {
- *bfp++ = '\\';
- len--;
- }
- *bfp++ = *text++;
-next:
- --len;
- }
-
- if (multiline && eol)
- bfp -= 3;
-
- *bfp++ = '"';
- *bfp = '\0';
-
- return bf;
-}
-
-struct file_line {
- struct file_line *next;
- const char *file;
- int lineno;
-};
-
-static struct file_line *file_line__new(const char *file, int lineno)
-{
- struct file_line *self = malloc(sizeof(*self));
-
- if (self == NULL)
- goto out;
-
- self->file = file;
- self->lineno = lineno;
- self->next = NULL;
-out:
- return self;
-}
-
-struct message {
- const char *msg;
- const char *option;
- struct message *next;
- struct file_line *files;
-};
-
-static struct message *message__list;
-
-static struct message *message__new(const char *msg, char *option,
- const char *file, int lineno)
-{
- struct message *self = malloc(sizeof(*self));
-
- if (self == NULL)
- goto out;
-
- self->files = file_line__new(file, lineno);
- if (self->files == NULL)
- goto out_fail;
-
- self->msg = strdup(msg);
- if (self->msg == NULL)
- goto out_fail_msg;
-
- self->option = option;
- self->next = NULL;
-out:
- return self;
-out_fail_msg:
- free(self->files);
-out_fail:
- free(self);
- self = NULL;
- goto out;
-}
-
-static struct message *mesage__find(const char *msg)
-{
- struct message *m = message__list;
-
- while (m != NULL) {
- if (strcmp(m->msg, msg) == 0)
- break;
- m = m->next;
- }
-
- return m;
-}
-
-static int message__add_file_line(struct message *self, const char *file,
- int lineno)
-{
- int rc = -1;
- struct file_line *fl = file_line__new(file, lineno);
-
- if (fl == NULL)
- goto out;
-
- fl->next = self->files;
- self->files = fl;
- rc = 0;
-out:
- return rc;
-}
-
-static int message__add(const char *msg, char *option, const char *file,
- int lineno)
-{
- int rc = 0;
- char bf[16384];
- char *escaped = escape(msg, bf, sizeof(bf));
- struct message *m = mesage__find(escaped);
-
- if (m != NULL)
- rc = message__add_file_line(m, file, lineno);
- else {
- m = message__new(escaped, option, file, lineno);
-
- if (m != NULL) {
- m->next = message__list;
- message__list = m;
- } else
- rc = -1;
- }
- return rc;
-}
-
-static void menu_build_message_list(struct menu *menu)
-{
- struct menu *child;
-
- message__add(menu_get_prompt(menu), NULL,
- menu->file == NULL ? "Root Menu" : menu->file->name,
- menu->lineno);
-
- if (menu->sym != NULL && menu_has_help(menu))
- message__add(menu_get_help(menu), menu->sym->name,
- menu->file == NULL ? "Root Menu" : menu->file->name,
- menu->lineno);
-
- for (child = menu->list; child != NULL; child = child->next)
- if (child->prompt != NULL)
- menu_build_message_list(child);
-}
-
-static void message__print_file_lineno(struct message *self)
-{
- struct file_line *fl = self->files;
-
- putchar('\n');
- if (self->option != NULL)
- printf("# %s:00000\n", self->option);
-
- printf("#: %s:%d", fl->file, fl->lineno);
- fl = fl->next;
-
- while (fl != NULL) {
- printf(", %s:%d", fl->file, fl->lineno);
- fl = fl->next;
- }
-
- putchar('\n');
-}
-
-static void message__print_gettext_msgid_msgstr(struct message *self)
-{
- message__print_file_lineno(self);
-
- printf("msgid %s\n"
- "msgstr \"\"\n", self->msg);
-}
-
-static void menu__xgettext(void)
-{
- struct message *m = message__list;
-
- while (m != NULL) {
- /* skip empty lines ("") */
- if (strlen(m->msg) > sizeof("\"\""))
- message__print_gettext_msgid_msgstr(m);
- m = m->next;
- }
-}
-
-int main(int ac, char **av)
-{
- conf_parse(av[1]);
-
- menu_build_message_list(menu_get_root_menu(NULL));
- menu__xgettext();
- return 0;
-}
+++ /dev/null
-#ifndef LIST_H
-#define LIST_H
-
-/*
- * Copied from include/linux/...
- */
-
-#undef offsetof
-#define offsetof(TYPE, MEMBER) ((size_t) &((TYPE *)0)->MEMBER)
-
-/**
- * container_of - cast a member of a structure out to the containing structure
- * @ptr: the pointer to the member.
- * @type: the type of the container struct this is embedded in.
- * @member: the name of the member within the struct.
- *
- */
-#define container_of(ptr, type, member) ({ \
- const typeof( ((type *)0)->member ) *__mptr = (ptr); \
- (type *)( (char *)__mptr - offsetof(type,member) );})
-
-
-struct list_head {
- struct list_head *next, *prev;
-};
-
-
-#define LIST_HEAD_INIT(name) { &(name), &(name) }
-
-#define LIST_HEAD(name) \
- struct list_head name = LIST_HEAD_INIT(name)
-
-/**
- * list_entry - get the struct for this entry
- * @ptr: the &struct list_head pointer.
- * @type: the type of the struct this is embedded in.
- * @member: the name of the list_head within the struct.
- */
-#define list_entry(ptr, type, member) \
- container_of(ptr, type, member)
-
-/**
- * list_for_each_entry - iterate over list of given type
- * @pos: the type * to use as a loop cursor.
- * @head: the head for your list.
- * @member: the name of the list_head within the struct.
- */
-#define list_for_each_entry(pos, head, member) \
- for (pos = list_entry((head)->next, typeof(*pos), member); \
- &pos->member != (head); \
- pos = list_entry(pos->member.next, typeof(*pos), member))
-
-/**
- * list_for_each_entry_safe - iterate over list of given type safe against removal of list entry
- * @pos: the type * to use as a loop cursor.
- * @n: another type * to use as temporary storage
- * @head: the head for your list.
- * @member: the name of the list_head within the struct.
- */
-#define list_for_each_entry_safe(pos, n, head, member) \
- for (pos = list_entry((head)->next, typeof(*pos), member), \
- n = list_entry(pos->member.next, typeof(*pos), member); \
- &pos->member != (head); \
- pos = n, n = list_entry(n->member.next, typeof(*n), member))
-
-/**
- * list_empty - tests whether a list is empty
- * @head: the list to test.
- */
-static inline int list_empty(const struct list_head *head)
-{
- return head->next == head;
-}
-
-/*
- * Insert a new entry between two known consecutive entries.
- *
- * This is only for internal list manipulation where we know
- * the prev/next entries already!
- */
-static inline void __list_add(struct list_head *_new,
- struct list_head *prev,
- struct list_head *next)
-{
- next->prev = _new;
- _new->next = next;
- _new->prev = prev;
- prev->next = _new;
-}
-
-/**
- * list_add_tail - add a new entry
- * @new: new entry to be added
- * @head: list head to add it before
- *
- * Insert a new entry before the specified head.
- * This is useful for implementing queues.
- */
-static inline void list_add_tail(struct list_head *_new, struct list_head *head)
-{
- __list_add(_new, head->prev, head);
-}
-
-/*
- * Delete a list entry by making the prev/next entries
- * point to each other.
- *
- * This is only for internal list manipulation where we know
- * the prev/next entries already!
- */
-static inline void __list_del(struct list_head *prev, struct list_head *next)
-{
- next->prev = prev;
- prev->next = next;
-}
-
-#define LIST_POISON1 ((void *) 0x00100100)
-#define LIST_POISON2 ((void *) 0x00200200)
-/**
- * list_del - deletes entry from list.
- * @entry: the element to delete from the list.
- * Note: list_empty() on entry does not return true after this, the entry is
- * in an undefined state.
- */
-static inline void list_del(struct list_head *entry)
-{
- __list_del(entry->prev, entry->next);
- entry->next = (struct list_head*)LIST_POISON1;
- entry->prev = (struct list_head*)LIST_POISON2;
-}
-#endif
+++ /dev/null
-/*
- * Copyright (C) 2002 Roman Zippel <zippel@linux-m68k.org>
- * Released under the terms of the GNU GPL v2.0.
- */
-
-#ifndef LKC_H
-#define LKC_H
-
-#include "expr.h"
-
-#ifndef KBUILD_NO_NLS
-# include <libintl.h>
-#else
-static inline const char *gettext(const char *txt) { return txt; }
-static inline void textdomain(const char *domainname) {}
-static inline void bindtextdomain(const char *name, const char *dir) {}
-static inline char *bind_textdomain_codeset(const char *dn, char *c) { return c; }
-#endif
-
-#ifdef __cplusplus
-extern "C" {
-#endif
-
-#include "lkc_proto.h"
-
-#define SRCTREE "srctree"
-
-#ifndef PACKAGE
-#define PACKAGE "linux"
-#endif
-
-#define LOCALEDIR "/usr/share/locale"
-
-#define _(text) gettext(text)
-#define N_(text) (text)
-
-#ifndef CONFIG_
-#define CONFIG_ "CONFIG_"
-#endif
-static inline const char *CONFIG_prefix(void)
-{
- return getenv( "CONFIG_" ) ?: CONFIG_;
-}
-#undef CONFIG_
-#define CONFIG_ CONFIG_prefix()
-
-#define TF_COMMAND 0x0001
-#define TF_PARAM 0x0002
-#define TF_OPTION 0x0004
-
-enum conf_def_mode {
- def_default,
- def_yes,
- def_mod,
- def_no,
- def_random
-};
-
-#define T_OPT_MODULES 1
-#define T_OPT_DEFCONFIG_LIST 2
-#define T_OPT_ENV 3
-#define T_OPT_ALLNOCONFIG_Y 4
-
-struct kconf_id {
- int name;
- int token;
- unsigned int flags;
- enum symbol_type stype;
-};
-
-void zconfdump(FILE *out);
-void zconf_starthelp(void);
-FILE *zconf_fopen(const char *name);
-void zconf_initscan(const char *name);
-void zconf_nextfile(const char *name);
-void zconf_nextfiles(const char *name);
-int zconf_lineno(void);
-const char *zconf_curname(void);
-
-/* confdata.c */
-const char *conf_get_configname(void);
-const char *conf_get_autoconfig_name(void);
-char *conf_get_default_confname(void);
-void sym_set_change_count(int count);
-void sym_add_change_count(int count);
-bool conf_set_all_new_symbols(enum conf_def_mode mode);
-void set_all_choice_values(struct symbol *csym);
-
-/* confdata.c and expr.c */
-static inline void xfwrite(const void *str, size_t len, size_t count, FILE *out)
-{
- assert(len != 0);
-
- if (fwrite(str, len, count, out) != count)
- fprintf(stderr, "Error in writing or end of file.\n");
-}
-
-/* menu.c */
-void _menu_init(void);
-void menu_warn(struct menu *menu, const char *fmt, ...);
-struct menu *menu_add_menu(void);
-void menu_end_menu(void);
-void menu_add_entry(struct symbol *sym);
-void menu_end_entry(void);
-void menu_add_dep(struct expr *dep);
-void menu_add_visibility(struct expr *dep);
-struct property *menu_add_prompt(enum prop_type type, char *prompt, struct expr *dep);
-void menu_add_expr(enum prop_type type, struct expr *expr, struct expr *dep);
-void menu_add_symbol(enum prop_type type, struct symbol *sym, struct expr *dep);
-void menu_add_option(int token, char *arg);
-void menu_finalize(struct menu *parent);
-void menu_set_type(int type);
-
-/* util.c */
-struct file *file_lookup(const char *name);
-int file_write_dep(const char *name);
-void *xmalloc(size_t size);
-void *xcalloc(size_t nmemb, size_t size);
-
-struct gstr {
- size_t len;
- char *s;
- /*
- * when max_width is not zero long lines in string s (if any) get
- * wrapped not to exceed the max_width value
- */
- int max_width;
-};
-struct gstr str_new(void);
-void str_free(struct gstr *gs);
-void str_append(struct gstr *gs, const char *s);
-void str_printf(struct gstr *gs, const char *fmt, ...);
-const char *str_get(struct gstr *gs);
-
-/* symbol.c */
-extern struct expr *sym_env_list;
-
-void sym_init(void);
-void sym_clear_all_valid(void);
-struct symbol *sym_choice_default(struct symbol *sym);
-const char *sym_get_string_default(struct symbol *sym);
-struct symbol *sym_check_deps(struct symbol *sym);
-struct property *prop_alloc(enum prop_type type, struct symbol *sym);
-struct symbol *prop_get_symbol(struct property *prop);
-struct property *sym_get_env_prop(struct symbol *sym);
-
-static inline tristate sym_get_tristate_value(struct symbol *sym)
-{
- return sym->curr.tri;
-}
-
-
-static inline struct symbol *sym_get_choice_value(struct symbol *sym)
-{
- return (struct symbol *)sym->curr.val;
-}
-
-static inline bool sym_set_choice_value(struct symbol *ch, struct symbol *chval)
-{
- return sym_set_tristate_value(chval, yes);
-}
-
-static inline bool sym_is_choice(struct symbol *sym)
-{
- return sym->flags & SYMBOL_CHOICE ? true : false;
-}
-
-static inline bool sym_is_choice_value(struct symbol *sym)
-{
- return sym->flags & SYMBOL_CHOICEVAL ? true : false;
-}
-
-static inline bool sym_is_optional(struct symbol *sym)
-{
- return sym->flags & SYMBOL_OPTIONAL ? true : false;
-}
-
-static inline bool sym_has_value(struct symbol *sym)
-{
- return sym->flags & SYMBOL_DEF_USER ? true : false;
-}
-
-#ifdef __cplusplus
-}
-#endif
-
-#endif /* LKC_H */
+++ /dev/null
-#include <stdarg.h>
-
-/* confdata.c */
-void conf_parse(const char *name);
-int conf_read(const char *name);
-int conf_read_simple(const char *name, int);
-int conf_write_defconfig(const char *name);
-int conf_write(const char *name);
-int conf_write_autoconf(void);
-bool conf_get_changed(void);
-void conf_set_changed_callback(void (*fn)(void));
-void conf_set_message_callback(void (*fn)(const char *fmt, va_list ap));
-
-/* menu.c */
-extern struct menu rootmenu;
-
-bool menu_is_empty(struct menu *menu);
-bool menu_is_visible(struct menu *menu);
-bool menu_has_prompt(struct menu *menu);
-const char * menu_get_prompt(struct menu *menu);
-struct menu * menu_get_root_menu(struct menu *menu);
-struct menu * menu_get_parent_menu(struct menu *menu);
-bool menu_has_help(struct menu *menu);
-const char * menu_get_help(struct menu *menu);
-struct gstr get_relations_str(struct symbol **sym_arr, struct list_head *head);
-void menu_get_ext_help(struct menu *menu, struct gstr *help);
-
-/* symbol.c */
-extern struct symbol * symbol_hash[SYMBOL_HASHSIZE];
-
-struct symbol * sym_lookup(const char *name, int flags);
-struct symbol * sym_find(const char *name);
-const char * sym_expand_string_value(const char *in);
-const char * sym_escape_string_value(const char *in);
-struct symbol ** sym_re_search(const char *pattern);
-const char * sym_type_name(enum symbol_type type);
-void sym_calc_value(struct symbol *sym);
-enum symbol_type sym_get_type(struct symbol *sym);
-bool sym_tristate_within_range(struct symbol *sym,tristate tri);
-bool sym_set_tristate_value(struct symbol *sym,tristate tri);
-tristate sym_toggle_tristate_value(struct symbol *sym);
-bool sym_string_valid(struct symbol *sym, const char *newval);
-bool sym_string_within_range(struct symbol *sym, const char *str);
-bool sym_set_string_value(struct symbol *sym, const char *newval);
-bool sym_is_changable(struct symbol *sym);
-struct property * sym_get_choice_prop(struct symbol *sym);
-const char * sym_get_string_value(struct symbol *sym);
-
-const char * prop_get_type_name(enum prop_type type);
-
-/* expr.c */
-void expr_print(struct expr *e, void (*fn)(void *, struct symbol *, const char *), void *data, int prevtoken);
+++ /dev/null
-#
-# Generated files
-#
-lxdialog
+++ /dev/null
-This is NOT the official version of dialog. This version has been
-significantly modified from the original. It is for use by the Linux
-kernel configuration script. Please do not bother Savio Lam with
-questions about this program.
+++ /dev/null
-#!/bin/bash
-# Check ncurses compatibility
-
-# What library to link
-ldflags()
-{
- if [ $(uname -s) == "Darwin" ]; then
- #OSX seems to need ncurses too
- echo -n "-lncurses "
- fi
- pkg-config --libs ncursesw 2>/dev/null && exit
- pkg-config --libs ncurses 2>/dev/null && exit
- for ext in so a dll.a dylib ; do
- for lib in ncursesw ncurses curses ; do
- $cc -print-file-name=lib${lib}.${ext} $extra_libs | grep -q /
- if [ $? -eq 0 ]; then
- echo "-l${lib}"
- exit
- fi
- done
- done
- exit 1
-}
-
-# Where is ncurses.h?
-ccflags()
-{
- if pkg-config --cflags ncursesw 2>/dev/null; then
- echo '-DCURSES_LOC="<ncurses.h>" -DNCURSES_WIDECHAR=1'
- elif pkg-config --cflags ncurses 2>/dev/null; then
- echo '-DCURSES_LOC="<ncurses.h>"'
- elif [ -f /usr/include/ncursesw/curses.h ]; then
- echo '-I/usr/include/ncursesw -DCURSES_LOC="<curses.h>"'
- echo ' -DNCURSES_WIDECHAR=1'
- elif [ -f /usr/include/ncurses/ncurses.h ]; then
- echo '-I/usr/include/ncurses -DCURSES_LOC="<ncurses.h>"'
- elif [ -f /usr/include/ncurses/curses.h ]; then
- echo '-I/usr/include/ncurses -DCURSES_LOC="<curses.h>"'
- elif [ -f /usr/include/ncurses.h ]; then
- echo '-DCURSES_LOC="<ncurses.h>"'
- else
- echo '-DCURSES_LOC="<curses.h>"'
- fi
- if [ $(uname -s) == "Darwin" ]; then
- #OSX doesn't have libintl
- echo -n "-DKBUILD_NO_NLS -Wno-format-security "
- fi
-}
-
-# Temp file, try to clean up after us
-tmp=.lxdialog.tmp
-trap "rm -f $tmp ${tmp%.tmp}.d" 0 1 2 3 15
-
-# Check if we can link to ncurses
-check() {
- $cc -x c - -o $tmp 2>/dev/null <<'EOF'
-#include CURSES_LOC
-main() {}
-EOF
- if [ $? != 0 ]; then
- echo " *** Unable to find the ncurses libraries or the" 1>&2
- echo " *** required header files." 1>&2
- echo " *** 'make menuconfig' requires the ncurses libraries." 1>&2
- echo " *** " 1>&2
- echo " *** Install ncurses (ncurses-devel) and try again." 1>&2
- echo " *** " 1>&2
- exit 1
- fi
-}
-
-usage() {
- printf "Usage: $0 [-check compiler options|-ccflags|-ldflags compiler options]\n"
-}
-
-if [ $# -eq 0 ]; then
- usage
- exit 1
-fi
-
-cc=""
-case "$1" in
- "-check")
- shift
- cc="$@"
- check
- ;;
- "-ccflags")
- ccflags
- ;;
- "-ldflags")
- shift
- cc="$@"
- ldflags
- ;;
- "*")
- usage
- exit 1
- ;;
-esac
+++ /dev/null
-/*
- * checklist.c -- implements the checklist box
- *
- * ORIGINAL AUTHOR: Savio Lam (lam836@cs.cuhk.hk)
- * Stuart Herbert - S.Herbert@sheffield.ac.uk: radiolist extension
- * Alessandro Rubini - rubini@ipvvis.unipv.it: merged the two
- * MODIFIED FOR LINUX KERNEL CONFIG BY: William Roadcap (roadcap@cfw.com)
- *
- * This program is free software; you can redistribute it and/or
- * modify it under the terms of the GNU General Public License
- * as published by the Free Software Foundation; either version 2
- * of the License, or (at your option) any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- * GNU General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software
- * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
- */
-
-#include "dialog.h"
-
-static int list_width, check_x, item_x;
-
-/*
- * Print list item
- */
-static void print_item(WINDOW * win, int choice, int selected)
-{
- int i;
- char *list_item = malloc(list_width + 1);
-
- strncpy(list_item, item_str(), list_width - item_x);
- list_item[list_width - item_x] = '\0';
-
- /* Clear 'residue' of last item */
- wattrset(win, dlg.menubox.atr);
- wmove(win, choice, 0);
- for (i = 0; i < list_width; i++)
- waddch(win, ' ');
-
- wmove(win, choice, check_x);
- wattrset(win, selected ? dlg.check_selected.atr
- : dlg.check.atr);
- if (!item_is_tag(':'))
- wprintw(win, "(%c)", item_is_tag('X') ? 'X' : ' ');
-
- wattrset(win, selected ? dlg.tag_selected.atr : dlg.tag.atr);
- mvwaddch(win, choice, item_x, list_item[0]);
- wattrset(win, selected ? dlg.item_selected.atr : dlg.item.atr);
- waddstr(win, list_item + 1);
- if (selected) {
- wmove(win, choice, check_x + 1);
- wrefresh(win);
- }
- free(list_item);
-}
-
-/*
- * Print the scroll indicators.
- */
-static void print_arrows(WINDOW * win, int choice, int item_no, int scroll,
- int y, int x, int height)
-{
- wmove(win, y, x);
-
- if (scroll > 0) {
- wattrset(win, dlg.uarrow.atr);
- waddch(win, ACS_UARROW);
- waddstr(win, "(-)");
- } else {
- wattrset(win, dlg.menubox.atr);
- waddch(win, ACS_HLINE);
- waddch(win, ACS_HLINE);
- waddch(win, ACS_HLINE);
- waddch(win, ACS_HLINE);
- }
-
- y = y + height + 1;
- wmove(win, y, x);
-
- if ((height < item_no) && (scroll + choice < item_no - 1)) {
- wattrset(win, dlg.darrow.atr);
- waddch(win, ACS_DARROW);
- waddstr(win, "(+)");
- } else {
- wattrset(win, dlg.menubox_border.atr);
- waddch(win, ACS_HLINE);
- waddch(win, ACS_HLINE);
- waddch(win, ACS_HLINE);
- waddch(win, ACS_HLINE);
- }
-}
-
-/*
- * Display the termination buttons
- */
-static void print_buttons(WINDOW * dialog, int height, int width, int selected)
-{
- int x = width / 2 - 11;
- int y = height - 2;
-
- print_button(dialog, gettext("Select"), y, x, selected == 0);
- print_button(dialog, gettext(" Help "), y, x + 14, selected == 1);
-
- wmove(dialog, y, x + 1 + 14 * selected);
- wrefresh(dialog);
-}
-
-/*
- * Display a dialog box with a list of options that can be turned on or off
- * in the style of radiolist (only one option turned on at a time).
- */
-int dialog_checklist(const char *title, const char *prompt, int height,
- int width, int list_height)
-{
- int i, x, y, box_x, box_y;
- int key = 0, button = 0, choice = 0, scroll = 0, max_choice;
- WINDOW *dialog, *list;
-
- /* which item to highlight */
- item_foreach() {
- if (item_is_tag('X'))
- choice = item_n();
- if (item_is_selected()) {
- choice = item_n();
- break;
- }
- }
-
-do_resize:
- if (getmaxy(stdscr) < (height + CHECKLIST_HEIGTH_MIN))
- return -ERRDISPLAYTOOSMALL;
- if (getmaxx(stdscr) < (width + CHECKLIST_WIDTH_MIN))
- return -ERRDISPLAYTOOSMALL;
-
- max_choice = MIN(list_height, item_count());
-
- /* center dialog box on screen */
- x = (getmaxx(stdscr) - width) / 2;
- y = (getmaxy(stdscr) - height) / 2;
-
- draw_shadow(stdscr, y, x, height, width);
-
- dialog = newwin(height, width, y, x);
- keypad(dialog, TRUE);
-
- draw_box(dialog, 0, 0, height, width,
- dlg.dialog.atr, dlg.border.atr);
- wattrset(dialog, dlg.border.atr);
- mvwaddch(dialog, height - 3, 0, ACS_LTEE);
- for (i = 0; i < width - 2; i++)
- waddch(dialog, ACS_HLINE);
- wattrset(dialog, dlg.dialog.atr);
- waddch(dialog, ACS_RTEE);
-
- print_title(dialog, title, width);
-
- wattrset(dialog, dlg.dialog.atr);
- print_autowrap(dialog, prompt, width - 2, 1, 3);
-
- list_width = width - 6;
- box_y = height - list_height - 5;
- box_x = (width - list_width) / 2 - 1;
-
- /* create new window for the list */
- list = subwin(dialog, list_height, list_width, y + box_y + 1,
- x + box_x + 1);
-
- keypad(list, TRUE);
-
- /* draw a box around the list items */
- draw_box(dialog, box_y, box_x, list_height + 2, list_width + 2,
- dlg.menubox_border.atr, dlg.menubox.atr);
-
- /* Find length of longest item in order to center checklist */
- check_x = 0;
- item_foreach()
- check_x = MAX(check_x, strlen(item_str()) + 4);
- check_x = MIN(check_x, list_width);
-
- check_x = (list_width - check_x) / 2;
- item_x = check_x + 4;
-
- if (choice >= list_height) {
- scroll = choice - list_height + 1;
- choice -= scroll;
- }
-
- /* Print the list */
- for (i = 0; i < max_choice; i++) {
- item_set(scroll + i);
- print_item(list, i, i == choice);
- }
-
- print_arrows(dialog, choice, item_count(), scroll,
- box_y, box_x + check_x + 5, list_height);
-
- print_buttons(dialog, height, width, 0);
-
- wnoutrefresh(dialog);
- wnoutrefresh(list);
- doupdate();
-
- while (key != KEY_ESC) {
- key = wgetch(dialog);
-
- for (i = 0; i < max_choice; i++) {
- item_set(i + scroll);
- if (toupper(key) == toupper(item_str()[0]))
- break;
- }
-
- if (i < max_choice || key == KEY_UP || key == KEY_DOWN ||
- key == '+' || key == '-') {
- if (key == KEY_UP || key == '-') {
- if (!choice) {
- if (!scroll)
- continue;
- /* Scroll list down */
- if (list_height > 1) {
- /* De-highlight current first item */
- item_set(scroll);
- print_item(list, 0, FALSE);
- scrollok(list, TRUE);
- wscrl(list, -1);
- scrollok(list, FALSE);
- }
- scroll--;
- item_set(scroll);
- print_item(list, 0, TRUE);
- print_arrows(dialog, choice, item_count(),
- scroll, box_y, box_x + check_x + 5, list_height);
-
- wnoutrefresh(dialog);
- wrefresh(list);
-
- continue; /* wait for another key press */
- } else
- i = choice - 1;
- } else if (key == KEY_DOWN || key == '+') {
- if (choice == max_choice - 1) {
- if (scroll + choice >= item_count() - 1)
- continue;
- /* Scroll list up */
- if (list_height > 1) {
- /* De-highlight current last item before scrolling up */
- item_set(scroll + max_choice - 1);
- print_item(list,
- max_choice - 1,
- FALSE);
- scrollok(list, TRUE);
- wscrl(list, 1);
- scrollok(list, FALSE);
- }
- scroll++;
- item_set(scroll + max_choice - 1);
- print_item(list, max_choice - 1, TRUE);
-
- print_arrows(dialog, choice, item_count(),
- scroll, box_y, box_x + check_x + 5, list_height);
-
- wnoutrefresh(dialog);
- wrefresh(list);
-
- continue; /* wait for another key press */
- } else
- i = choice + 1;
- }
- if (i != choice) {
- /* De-highlight current item */
- item_set(scroll + choice);
- print_item(list, choice, FALSE);
- /* Highlight new item */
- choice = i;
- item_set(scroll + choice);
- print_item(list, choice, TRUE);
- wnoutrefresh(dialog);
- wrefresh(list);
- }
- continue; /* wait for another key press */
- }
- switch (key) {
- case 'H':
- case 'h':
- case '?':
- button = 1;
- /* fall-through */
- case 'S':
- case 's':
- case ' ':
- case '\n':
- item_foreach()
- item_set_selected(0);
- item_set(scroll + choice);
- item_set_selected(1);
- delwin(list);
- delwin(dialog);
- return button;
- case TAB:
- case KEY_LEFT:
- case KEY_RIGHT:
- button = ((key == KEY_LEFT ? --button : ++button) < 0)
- ? 1 : (button > 1 ? 0 : button);
-
- print_buttons(dialog, height, width, button);
- wrefresh(dialog);
- break;
- case 'X':
- case 'x':
- key = KEY_ESC;
- break;
- case KEY_ESC:
- key = on_key_esc(dialog);
- break;
- case KEY_RESIZE:
- delwin(list);
- delwin(dialog);
- on_key_resize();
- goto do_resize;
- }
-
- /* Now, update everything... */
- doupdate();
- }
- delwin(list);
- delwin(dialog);
- return key; /* ESC pressed */
-}
+++ /dev/null
-/*
- * dialog.h -- common declarations for all dialog modules
- *
- * AUTHOR: Savio Lam (lam836@cs.cuhk.hk)
- *
- * This program is free software; you can redistribute it and/or
- * modify it under the terms of the GNU General Public License
- * as published by the Free Software Foundation; either version 2
- * of the License, or (at your option) any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- * GNU General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software
- * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
- */
-
-#include <sys/types.h>
-#include <fcntl.h>
-#include <unistd.h>
-#include <ctype.h>
-#include <stdlib.h>
-#include <string.h>
-#include <stdbool.h>
-
-#ifndef KBUILD_NO_NLS
-# include <libintl.h>
-#else
-# define gettext(Msgid) ((const char *) (Msgid))
-#endif
-
-#ifdef __sun__
-#define CURS_MACROS
-#endif
-#include CURSES_LOC
-
-/*
- * Colors in ncurses 1.9.9e do not work properly since foreground and
- * background colors are OR'd rather than separately masked. This version
- * of dialog was hacked to work with ncurses 1.9.9e, making it incompatible
- * with standard curses. The simplest fix (to make this work with standard
- * curses) uses the wbkgdset() function, not used in the original hack.
- * Turn it off if we're building with 1.9.9e, since it just confuses things.
- */
-#if defined(NCURSES_VERSION) && defined(_NEED_WRAP) && !defined(GCC_PRINTFLIKE)
-#define OLD_NCURSES 1
-#undef wbkgdset
-#define wbkgdset(w,p) /*nothing */
-#else
-#define OLD_NCURSES 0
-#endif
-
-#define TR(params) _tracef params
-
-#define KEY_ESC 27
-#define TAB 9
-#define MAX_LEN 2048
-#define BUF_SIZE (10*1024)
-#define MIN(x,y) (x < y ? x : y)
-#define MAX(x,y) (x > y ? x : y)
-
-#ifndef ACS_ULCORNER
-#define ACS_ULCORNER '+'
-#endif
-#ifndef ACS_LLCORNER
-#define ACS_LLCORNER '+'
-#endif
-#ifndef ACS_URCORNER
-#define ACS_URCORNER '+'
-#endif
-#ifndef ACS_LRCORNER
-#define ACS_LRCORNER '+'
-#endif
-#ifndef ACS_HLINE
-#define ACS_HLINE '-'
-#endif
-#ifndef ACS_VLINE
-#define ACS_VLINE '|'
-#endif
-#ifndef ACS_LTEE
-#define ACS_LTEE '+'
-#endif
-#ifndef ACS_RTEE
-#define ACS_RTEE '+'
-#endif
-#ifndef ACS_UARROW
-#define ACS_UARROW '^'
-#endif
-#ifndef ACS_DARROW
-#define ACS_DARROW 'v'
-#endif
-
-/* error return codes */
-#define ERRDISPLAYTOOSMALL (KEY_MAX + 1)
-
-/*
- * Color definitions
- */
-struct dialog_color {
- chtype atr; /* Color attribute */
- int fg; /* foreground */
- int bg; /* background */
- int hl; /* highlight this item */
-};
-
-struct subtitle_list {
- struct subtitle_list *next;
- const char *text;
-};
-
-struct dialog_info {
- const char *backtitle;
- struct subtitle_list *subtitles;
- struct dialog_color screen;
- struct dialog_color shadow;
- struct dialog_color dialog;
- struct dialog_color title;
- struct dialog_color border;
- struct dialog_color button_active;
- struct dialog_color button_inactive;
- struct dialog_color button_key_active;
- struct dialog_color button_key_inactive;
- struct dialog_color button_label_active;
- struct dialog_color button_label_inactive;
- struct dialog_color inputbox;
- struct dialog_color inputbox_border;
- struct dialog_color searchbox;
- struct dialog_color searchbox_title;
- struct dialog_color searchbox_border;
- struct dialog_color position_indicator;
- struct dialog_color menubox;
- struct dialog_color menubox_border;
- struct dialog_color item;
- struct dialog_color item_selected;
- struct dialog_color tag;
- struct dialog_color tag_selected;
- struct dialog_color tag_key;
- struct dialog_color tag_key_selected;
- struct dialog_color check;
- struct dialog_color check_selected;
- struct dialog_color uarrow;
- struct dialog_color darrow;
-};
-
-/*
- * Global variables
- */
-extern struct dialog_info dlg;
-extern char dialog_input_result[];
-extern int saved_x, saved_y; /* Needed in signal handler in mconf.c */
-
-/*
- * Function prototypes
- */
-
-/* item list as used by checklist and menubox */
-void item_reset(void);
-void item_make(const char *fmt, ...);
-void item_add_str(const char *fmt, ...);
-void item_set_tag(char tag);
-void item_set_data(void *p);
-void item_set_selected(int val);
-int item_activate_selected(void);
-void *item_data(void);
-char item_tag(void);
-
-/* item list manipulation for lxdialog use */
-#define MAXITEMSTR 200
-struct dialog_item {
- char str[MAXITEMSTR]; /* prompt displayed */
- char tag;
- void *data; /* pointer to menu item - used by menubox+checklist */
- int selected; /* Set to 1 by dialog_*() function if selected. */
-};
-
-/* list of lialog_items */
-struct dialog_list {
- struct dialog_item node;
- struct dialog_list *next;
-};
-
-extern struct dialog_list *item_cur;
-extern struct dialog_list item_nil;
-extern struct dialog_list *item_head;
-
-int item_count(void);
-void item_set(int n);
-int item_n(void);
-const char *item_str(void);
-int item_is_selected(void);
-int item_is_tag(char tag);
-#define item_foreach() \
- for (item_cur = item_head ? item_head: item_cur; \
- item_cur && (item_cur != &item_nil); item_cur = item_cur->next)
-
-/* generic key handlers */
-int on_key_esc(WINDOW *win);
-int on_key_resize(void);
-
-/* minimum (re)size values */
-#define CHECKLIST_HEIGTH_MIN 6 /* For dialog_checklist() */
-#define CHECKLIST_WIDTH_MIN 6
-#define INPUTBOX_HEIGTH_MIN 2 /* For dialog_inputbox() */
-#define INPUTBOX_WIDTH_MIN 2
-#define MENUBOX_HEIGTH_MIN 15 /* For dialog_menu() */
-#define MENUBOX_WIDTH_MIN 65
-#define TEXTBOX_HEIGTH_MIN 8 /* For dialog_textbox() */
-#define TEXTBOX_WIDTH_MIN 8
-#define YESNO_HEIGTH_MIN 4 /* For dialog_yesno() */
-#define YESNO_WIDTH_MIN 4
-#define WINDOW_HEIGTH_MIN 19 /* For init_dialog() */
-#define WINDOW_WIDTH_MIN 80
-
-int init_dialog(const char *backtitle);
-void set_dialog_backtitle(const char *backtitle);
-void set_dialog_subtitles(struct subtitle_list *subtitles);
-void end_dialog(int x, int y);
-void attr_clear(WINDOW * win, int height, int width, chtype attr);
-void dialog_clear(void);
-void print_autowrap(WINDOW * win, const char *prompt, int width, int y, int x);
-void print_button(WINDOW * win, const char *label, int y, int x, int selected);
-void print_title(WINDOW *dialog, const char *title, int width);
-void draw_box(WINDOW * win, int y, int x, int height, int width, chtype box,
- chtype border);
-void draw_shadow(WINDOW * win, int y, int x, int height, int width);
-
-int first_alpha(const char *string, const char *exempt);
-int dialog_yesno(const char *title, const char *prompt, int height, int width);
-int dialog_msgbox(const char *title, const char *prompt, int height,
- int width, int pause);
-
-
-typedef void (*update_text_fn)(char *buf, size_t start, size_t end, void
- *_data);
-int dialog_textbox(const char *title, char *tbuf, int initial_height,
- int initial_width, int *keys, int *_vscroll, int *_hscroll,
- update_text_fn update_text, void *data);
-int dialog_menu(const char *title, const char *prompt,
- const void *selected, int *s_scroll);
-int dialog_checklist(const char *title, const char *prompt, int height,
- int width, int list_height);
-int dialog_inputbox(const char *title, const char *prompt, int height,
- int width, const char *init);
-
-/*
- * This is the base for fictitious keys, which activate
- * the buttons.
- *
- * Mouse-generated keys are the following:
- * -- the first 32 are used as numbers, in addition to '0'-'9'
- * -- the lowercase are used to signal mouse-enter events (M_EVENT + 'o')
- * -- uppercase chars are used to invoke the button (M_EVENT + 'O')
- */
-#define M_EVENT (KEY_MAX+1)
+++ /dev/null
-/*
- * inputbox.c -- implements the input box
- *
- * ORIGINAL AUTHOR: Savio Lam (lam836@cs.cuhk.hk)
- * MODIFIED FOR LINUX KERNEL CONFIG BY: William Roadcap (roadcap@cfw.com)
- *
- * This program is free software; you can redistribute it and/or
- * modify it under the terms of the GNU General Public License
- * as published by the Free Software Foundation; either version 2
- * of the License, or (at your option) any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- * GNU General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software
- * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
- */
-
-#include "dialog.h"
-
-char dialog_input_result[MAX_LEN + 1];
-
-/*
- * Print the termination buttons
- */
-static void print_buttons(WINDOW * dialog, int height, int width, int selected)
-{
- int x = width / 2 - 11;
- int y = height - 2;
-
- print_button(dialog, gettext(" Ok "), y, x, selected == 0);
- print_button(dialog, gettext(" Help "), y, x + 14, selected == 1);
-
- wmove(dialog, y, x + 1 + 14 * selected);
- wrefresh(dialog);
-}
-
-/*
- * Display a dialog box for inputing a string
- */
-int dialog_inputbox(const char *title, const char *prompt, int height, int width,
- const char *init)
-{
- int i, x, y, box_y, box_x, box_width;
- int input_x = 0, key = 0, button = -1;
- int show_x, len, pos;
- char *instr = dialog_input_result;
- WINDOW *dialog;
-
- if (!init)
- instr[0] = '\0';
- else
- strcpy(instr, init);
-
-do_resize:
- if (getmaxy(stdscr) <= (height - INPUTBOX_HEIGTH_MIN))
- return -ERRDISPLAYTOOSMALL;
- if (getmaxx(stdscr) <= (width - INPUTBOX_WIDTH_MIN))
- return -ERRDISPLAYTOOSMALL;
-
- /* center dialog box on screen */
- x = (getmaxx(stdscr) - width) / 2;
- y = (getmaxy(stdscr) - height) / 2;
-
- draw_shadow(stdscr, y, x, height, width);
-
- dialog = newwin(height, width, y, x);
- keypad(dialog, TRUE);
-
- draw_box(dialog, 0, 0, height, width,
- dlg.dialog.atr, dlg.border.atr);
- wattrset(dialog, dlg.border.atr);
- mvwaddch(dialog, height - 3, 0, ACS_LTEE);
- for (i = 0; i < width - 2; i++)
- waddch(dialog, ACS_HLINE);
- wattrset(dialog, dlg.dialog.atr);
- waddch(dialog, ACS_RTEE);
-
- print_title(dialog, title, width);
-
- wattrset(dialog, dlg.dialog.atr);
- print_autowrap(dialog, prompt, width - 2, 1, 3);
-
- /* Draw the input field box */
- box_width = width - 6;
- getyx(dialog, y, x);
- box_y = y + 2;
- box_x = (width - box_width) / 2;
- draw_box(dialog, y + 1, box_x - 1, 3, box_width + 2,
- dlg.dialog.atr, dlg.border.atr);
-
- print_buttons(dialog, height, width, 0);
-
- /* Set up the initial value */
- wmove(dialog, box_y, box_x);
- wattrset(dialog, dlg.inputbox.atr);
-
- len = strlen(instr);
- pos = len;
-
- if (len >= box_width) {
- show_x = len - box_width + 1;
- input_x = box_width - 1;
- for (i = 0; i < box_width - 1; i++)
- waddch(dialog, instr[show_x + i]);
- } else {
- show_x = 0;
- input_x = len;
- waddstr(dialog, instr);
- }
-
- wmove(dialog, box_y, box_x + input_x);
-
- wrefresh(dialog);
-
- while (key != KEY_ESC) {
- key = wgetch(dialog);
-
- if (button == -1) { /* Input box selected */
- switch (key) {
- case TAB:
- case KEY_UP:
- case KEY_DOWN:
- break;
- case KEY_BACKSPACE:
- case 127:
- if (pos) {
- wattrset(dialog, dlg.inputbox.atr);
- if (input_x == 0) {
- show_x--;
- } else
- input_x--;
-
- if (pos < len) {
- for (i = pos - 1; i < len; i++) {
- instr[i] = instr[i+1];
- }
- }
-
- pos--;
- len--;
- instr[len] = '\0';
- wmove(dialog, box_y, box_x);
- for (i = 0; i < box_width; i++) {
- if (!instr[show_x + i]) {
- waddch(dialog, ' ');
- break;
- }
- waddch(dialog, instr[show_x + i]);
- }
- wmove(dialog, box_y, input_x + box_x);
- wrefresh(dialog);
- }
- continue;
- case KEY_LEFT:
- if (pos > 0) {
- if (input_x > 0) {
- wmove(dialog, box_y, --input_x + box_x);
- } else if (input_x == 0) {
- show_x--;
- wmove(dialog, box_y, box_x);
- for (i = 0; i < box_width; i++) {
- if (!instr[show_x + i]) {
- waddch(dialog, ' ');
- break;
- }
- waddch(dialog, instr[show_x + i]);
- }
- wmove(dialog, box_y, box_x);
- }
- pos--;
- }
- continue;
- case KEY_RIGHT:
- if (pos < len) {
- if (input_x < box_width - 1) {
- wmove(dialog, box_y, ++input_x + box_x);
- } else if (input_x == box_width - 1) {
- show_x++;
- wmove(dialog, box_y, box_x);
- for (i = 0; i < box_width; i++) {
- if (!instr[show_x + i]) {
- waddch(dialog, ' ');
- break;
- }
- waddch(dialog, instr[show_x + i]);
- }
- wmove(dialog, box_y, input_x + box_x);
- }
- pos++;
- }
- continue;
- default:
- if (key < 0x100 && isprint(key)) {
- if (len < MAX_LEN) {
- wattrset(dialog, dlg.inputbox.atr);
- if (pos < len) {
- for (i = len; i > pos; i--)
- instr[i] = instr[i-1];
- instr[pos] = key;
- } else {
- instr[len] = key;
- }
- pos++;
- len++;
- instr[len] = '\0';
-
- if (input_x == box_width - 1) {
- show_x++;
- } else {
- input_x++;
- }
-
- wmove(dialog, box_y, box_x);
- for (i = 0; i < box_width; i++) {
- if (!instr[show_x + i]) {
- waddch(dialog, ' ');
- break;
- }
- waddch(dialog, instr[show_x + i]);
- }
- wmove(dialog, box_y, input_x + box_x);
- wrefresh(dialog);
- } else
- flash(); /* Alarm user about overflow */
- continue;
- }
- }
- }
- switch (key) {
- case 'O':
- case 'o':
- delwin(dialog);
- return 0;
- case 'H':
- case 'h':
- delwin(dialog);
- return 1;
- case KEY_UP:
- case KEY_LEFT:
- switch (button) {
- case -1:
- button = 1; /* Indicates "Help" button is selected */
- print_buttons(dialog, height, width, 1);
- break;
- case 0:
- button = -1; /* Indicates input box is selected */
- print_buttons(dialog, height, width, 0);
- wmove(dialog, box_y, box_x + input_x);
- wrefresh(dialog);
- break;
- case 1:
- button = 0; /* Indicates "OK" button is selected */
- print_buttons(dialog, height, width, 0);
- break;
- }
- break;
- case TAB:
- case KEY_DOWN:
- case KEY_RIGHT:
- switch (button) {
- case -1:
- button = 0; /* Indicates "OK" button is selected */
- print_buttons(dialog, height, width, 0);
- break;
- case 0:
- button = 1; /* Indicates "Help" button is selected */
- print_buttons(dialog, height, width, 1);
- break;
- case 1:
- button = -1; /* Indicates input box is selected */
- print_buttons(dialog, height, width, 0);
- wmove(dialog, box_y, box_x + input_x);
- wrefresh(dialog);
- break;
- }
- break;
- case ' ':
- case '\n':
- delwin(dialog);
- return (button == -1 ? 0 : button);
- case 'X':
- case 'x':
- key = KEY_ESC;
- break;
- case KEY_ESC:
- key = on_key_esc(dialog);
- break;
- case KEY_RESIZE:
- delwin(dialog);
- on_key_resize();
- goto do_resize;
- }
- }
-
- delwin(dialog);
- return KEY_ESC; /* ESC pressed */
-}
+++ /dev/null
-/*
- * menubox.c -- implements the menu box
- *
- * ORIGINAL AUTHOR: Savio Lam (lam836@cs.cuhk.hk)
- * MODIFIED FOR LINUX KERNEL CONFIG BY: William Roadcap (roadcapw@cfw.com)
- *
- * This program is free software; you can redistribute it and/or
- * modify it under the terms of the GNU General Public License
- * as published by the Free Software Foundation; either version 2
- * of the License, or (at your option) any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- * GNU General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software
- * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
- */
-
-/*
- * Changes by Clifford Wolf (god@clifford.at)
- *
- * [ 1998-06-13 ]
- *
- * *) A bugfix for the Page-Down problem
- *
- * *) Formerly when I used Page Down and Page Up, the cursor would be set
- * to the first position in the menu box. Now lxdialog is a bit
- * smarter and works more like other menu systems (just have a look at
- * it).
- *
- * *) Formerly if I selected something my scrolling would be broken because
- * lxdialog is re-invoked by the Menuconfig shell script, can't
- * remember the last scrolling position, and just sets it so that the
- * cursor is at the bottom of the box. Now it writes the temporary file
- * lxdialog.scrltmp which contains this information. The file is
- * deleted by lxdialog if the user leaves a submenu or enters a new
- * one, but it would be nice if Menuconfig could make another "rm -f"
- * just to be sure. Just try it out - you will recognise a difference!
- *
- * [ 1998-06-14 ]
- *
- * *) Now lxdialog is crash-safe against broken "lxdialog.scrltmp" files
- * and menus change their size on the fly.
- *
- * *) If for some reason the last scrolling position is not saved by
- * lxdialog, it sets the scrolling so that the selected item is in the
- * middle of the menu box, not at the bottom.
- *
- * 02 January 1999, Michael Elizabeth Chastain (mec@shout.net)
- * Reset 'scroll' to 0 if the value from lxdialog.scrltmp is bogus.
- * This fixes a bug in Menuconfig where using ' ' to descend into menus
- * would leave mis-synchronized lxdialog.scrltmp files lying around,
- * fscanf would read in 'scroll', and eventually that value would get used.
- */
-
-#include "dialog.h"
-
-static int menu_width, item_x;
-
-/*
- * Print menu item
- */
-static void do_print_item(WINDOW * win, const char *item, int line_y,
- int selected, int hotkey)
-{
- int j;
- char *menu_item = malloc(menu_width + 1);
-
- strncpy(menu_item, item, menu_width - item_x);
- menu_item[menu_width - item_x] = '\0';
- j = first_alpha(menu_item, "YyNnMmHh");
-
- /* Clear 'residue' of last item */
- wattrset(win, dlg.menubox.atr);
- wmove(win, line_y, 0);
-#if OLD_NCURSES
- {
- int i;
- for (i = 0; i < menu_width; i++)
- waddch(win, ' ');
- }
-#else
- wclrtoeol(win);
-#endif
- wattrset(win, selected ? dlg.item_selected.atr : dlg.item.atr);
- mvwaddstr(win, line_y, item_x, menu_item);
- if (hotkey) {
- wattrset(win, selected ? dlg.tag_key_selected.atr
- : dlg.tag_key.atr);
- mvwaddch(win, line_y, item_x + j, menu_item[j]);
- }
- if (selected) {
- wmove(win, line_y, item_x + 1);
- }
- free(menu_item);
- wrefresh(win);
-}
-
-#define print_item(index, choice, selected) \
-do { \
- item_set(index); \
- do_print_item(menu, item_str(), choice, selected, !item_is_tag(':')); \
-} while (0)
-
-/*
- * Print the scroll indicators.
- */
-static void print_arrows(WINDOW * win, int item_no, int scroll, int y, int x,
- int height)
-{
- int cur_y, cur_x;
-
- getyx(win, cur_y, cur_x);
-
- wmove(win, y, x);
-
- if (scroll > 0) {
- wattrset(win, dlg.uarrow.atr);
- waddch(win, ACS_UARROW);
- waddstr(win, "(-)");
- } else {
- wattrset(win, dlg.menubox.atr);
- waddch(win, ACS_HLINE);
- waddch(win, ACS_HLINE);
- waddch(win, ACS_HLINE);
- waddch(win, ACS_HLINE);
- }
-
- y = y + height + 1;
- wmove(win, y, x);
- wrefresh(win);
-
- if ((height < item_no) && (scroll + height < item_no)) {
- wattrset(win, dlg.darrow.atr);
- waddch(win, ACS_DARROW);
- waddstr(win, "(+)");
- } else {
- wattrset(win, dlg.menubox_border.atr);
- waddch(win, ACS_HLINE);
- waddch(win, ACS_HLINE);
- waddch(win, ACS_HLINE);
- waddch(win, ACS_HLINE);
- }
-
- wmove(win, cur_y, cur_x);
- wrefresh(win);
-}
-
-/*
- * Display the termination buttons.
- */
-static void print_buttons(WINDOW * win, int height, int width, int selected)
-{
- int x = width / 2 - 28;
- int y = height - 2;
-
- print_button(win, gettext("Select"), y, x, selected == 0);
- print_button(win, gettext(" Exit "), y, x + 12, selected == 1);
- print_button(win, gettext(" Help "), y, x + 24, selected == 2);
- print_button(win, gettext(" Save "), y, x + 36, selected == 3);
- print_button(win, gettext(" Load "), y, x + 48, selected == 4);
-
- wmove(win, y, x + 1 + 12 * selected);
- wrefresh(win);
-}
-
-/* scroll up n lines (n may be negative) */
-static void do_scroll(WINDOW *win, int *scroll, int n)
-{
- /* Scroll menu up */
- scrollok(win, TRUE);
- wscrl(win, n);
- scrollok(win, FALSE);
- *scroll = *scroll + n;
- wrefresh(win);
-}
-
-/*
- * Display a menu for choosing among a number of options
- */
-int dialog_menu(const char *title, const char *prompt,
- const void *selected, int *s_scroll)
-{
- int i, j, x, y, box_x, box_y;
- int height, width, menu_height;
- int key = 0, button = 0, scroll = 0, choice = 0;
- int first_item = 0, max_choice;
- WINDOW *dialog, *menu;
-
-do_resize:
- height = getmaxy(stdscr);
- width = getmaxx(stdscr);
- if (height < MENUBOX_HEIGTH_MIN || width < MENUBOX_WIDTH_MIN)
- return -ERRDISPLAYTOOSMALL;
-
- height -= 4;
- width -= 5;
- menu_height = height - 10;
-
- max_choice = MIN(menu_height, item_count());
-
- /* center dialog box on screen */
- x = (getmaxx(stdscr) - width) / 2;
- y = (getmaxy(stdscr) - height) / 2;
-
- draw_shadow(stdscr, y, x, height, width);
-
- dialog = newwin(height, width, y, x);
- keypad(dialog, TRUE);
-
- draw_box(dialog, 0, 0, height, width,
- dlg.dialog.atr, dlg.border.atr);
- wattrset(dialog, dlg.border.atr);
- mvwaddch(dialog, height - 3, 0, ACS_LTEE);
- for (i = 0; i < width - 2; i++)
- waddch(dialog, ACS_HLINE);
- wattrset(dialog, dlg.dialog.atr);
- wbkgdset(dialog, dlg.dialog.atr & A_COLOR);
- waddch(dialog, ACS_RTEE);
-
- print_title(dialog, title, width);
-
- wattrset(dialog, dlg.dialog.atr);
- print_autowrap(dialog, prompt, width - 2, 1, 3);
-
- menu_width = width - 6;
- box_y = height - menu_height - 5;
- box_x = (width - menu_width) / 2 - 1;
-
- /* create new window for the menu */
- menu = subwin(dialog, menu_height, menu_width,
- y + box_y + 1, x + box_x + 1);
- keypad(menu, TRUE);
-
- /* draw a box around the menu items */
- draw_box(dialog, box_y, box_x, menu_height + 2, menu_width + 2,
- dlg.menubox_border.atr, dlg.menubox.atr);
-
- if (menu_width >= 80)
- item_x = (menu_width - 70) / 2;
- else
- item_x = 4;
-
- /* Set choice to default item */
- item_foreach()
- if (selected && (selected == item_data()))
- choice = item_n();
- /* get the saved scroll info */
- scroll = *s_scroll;
- if ((scroll <= choice) && (scroll + max_choice > choice) &&
- (scroll >= 0) && (scroll + max_choice <= item_count())) {
- first_item = scroll;
- choice = choice - scroll;
- } else {
- scroll = 0;
- }
- if ((choice >= max_choice)) {
- if (choice >= item_count() - max_choice / 2)
- scroll = first_item = item_count() - max_choice;
- else
- scroll = first_item = choice - max_choice / 2;
- choice = choice - scroll;
- }
-
- /* Print the menu */
- for (i = 0; i < max_choice; i++) {
- print_item(first_item + i, i, i == choice);
- }
-
- wnoutrefresh(menu);
-
- print_arrows(dialog, item_count(), scroll,
- box_y, box_x + item_x + 1, menu_height);
-
- print_buttons(dialog, height, width, 0);
- wmove(menu, choice, item_x + 1);
- wrefresh(menu);
-
- while (key != KEY_ESC) {
- key = wgetch(menu);
-
- if (key < 256 && isalpha(key))
- key = tolower(key);
-
- if (strchr("ynmh", key))
- i = max_choice;
- else {
- for (i = choice + 1; i < max_choice; i++) {
- item_set(scroll + i);
- j = first_alpha(item_str(), "YyNnMmHh");
- if (key == tolower(item_str()[j]))
- break;
- }
- if (i == max_choice)
- for (i = 0; i < max_choice; i++) {
- item_set(scroll + i);
- j = first_alpha(item_str(), "YyNnMmHh");
- if (key == tolower(item_str()[j]))
- break;
- }
- }
-
- if (item_count() != 0 &&
- (i < max_choice ||
- key == KEY_UP || key == KEY_DOWN ||
- key == '-' || key == '+' ||
- key == KEY_PPAGE || key == KEY_NPAGE)) {
- /* Remove highligt of current item */
- print_item(scroll + choice, choice, FALSE);
-
- if (key == KEY_UP || key == '-') {
- if (choice < 2 && scroll) {
- /* Scroll menu down */
- do_scroll(menu, &scroll, -1);
-
- print_item(scroll, 0, FALSE);
- } else
- choice = MAX(choice - 1, 0);
-
- } else if (key == KEY_DOWN || key == '+') {
- print_item(scroll+choice, choice, FALSE);
-
- if ((choice > max_choice - 3) &&
- (scroll + max_choice < item_count())) {
- /* Scroll menu up */
- do_scroll(menu, &scroll, 1);
-
- print_item(scroll+max_choice - 1,
- max_choice - 1, FALSE);
- } else
- choice = MIN(choice + 1, max_choice - 1);
-
- } else if (key == KEY_PPAGE) {
- scrollok(menu, TRUE);
- for (i = 0; (i < max_choice); i++) {
- if (scroll > 0) {
- do_scroll(menu, &scroll, -1);
- print_item(scroll, 0, FALSE);
- } else {
- if (choice > 0)
- choice--;
- }
- }
-
- } else if (key == KEY_NPAGE) {
- for (i = 0; (i < max_choice); i++) {
- if (scroll + max_choice < item_count()) {
- do_scroll(menu, &scroll, 1);
- print_item(scroll+max_choice-1,
- max_choice - 1, FALSE);
- } else {
- if (choice + 1 < max_choice)
- choice++;
- }
- }
- } else
- choice = i;
-
- print_item(scroll + choice, choice, TRUE);
-
- print_arrows(dialog, item_count(), scroll,
- box_y, box_x + item_x + 1, menu_height);
-
- wnoutrefresh(dialog);
- wrefresh(menu);
-
- continue; /* wait for another key press */
- }
-
- switch (key) {
- case KEY_LEFT:
- case TAB:
- case KEY_RIGHT:
- button = ((key == KEY_LEFT ? --button : ++button) < 0)
- ? 4 : (button > 4 ? 0 : button);
-
- print_buttons(dialog, height, width, button);
- wrefresh(menu);
- break;
- case ' ':
- case 's':
- case 'y':
- case 'n':
- case 'm':
- case '/':
- case 'h':
- case '?':
- case 'z':
- case '\n':
- /* save scroll info */
- *s_scroll = scroll;
- delwin(menu);
- delwin(dialog);
- item_set(scroll + choice);
- item_set_selected(1);
- switch (key) {
- case 'h':
- case '?':
- return 2;
- case 's':
- case 'y':
- return 5;
- case 'n':
- return 6;
- case 'm':
- return 7;
- case ' ':
- return 8;
- case '/':
- return 9;
- case 'z':
- return 10;
- case '\n':
- return button;
- }
- return 0;
- case 'e':
- case 'x':
- key = KEY_ESC;
- break;
- case KEY_ESC:
- key = on_key_esc(menu);
- break;
- case KEY_RESIZE:
- on_key_resize();
- delwin(menu);
- delwin(dialog);
- goto do_resize;
- }
- }
- delwin(menu);
- delwin(dialog);
- return key; /* ESC pressed */
-}
+++ /dev/null
-/*
- * textbox.c -- implements the text box
- *
- * ORIGINAL AUTHOR: Savio Lam (lam836@cs.cuhk.hk)
- * MODIFIED FOR LINUX KERNEL CONFIG BY: William Roadcap (roadcap@cfw.com)
- *
- * This program is free software; you can redistribute it and/or
- * modify it under the terms of the GNU General Public License
- * as published by the Free Software Foundation; either version 2
- * of the License, or (at your option) any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- * GNU General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software
- * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
- */
-
-#include "dialog.h"
-
-static void back_lines(int n);
-static void print_page(WINDOW *win, int height, int width, update_text_fn
- update_text, void *data);
-static void print_line(WINDOW *win, int row, int width);
-static char *get_line(void);
-static void print_position(WINDOW * win);
-
-static int hscroll;
-static int begin_reached, end_reached, page_length;
-static char *buf;
-static char *page;
-
-/*
- * refresh window content
- */
-static void refresh_text_box(WINDOW *dialog, WINDOW *box, int boxh, int boxw,
- int cur_y, int cur_x, update_text_fn update_text,
- void *data)
-{
- print_page(box, boxh, boxw, update_text, data);
- print_position(dialog);
- wmove(dialog, cur_y, cur_x); /* Restore cursor position */
- wrefresh(dialog);
-}
-
-
-/*
- * Display text from a file in a dialog box.
- *
- * keys is a null-terminated array
- * update_text() may not add or remove any '\n' or '\0' in tbuf
- */
-int dialog_textbox(const char *title, char *tbuf, int initial_height,
- int initial_width, int *keys, int *_vscroll, int *_hscroll,
- update_text_fn update_text, void *data)
-{
- int i, x, y, cur_x, cur_y, key = 0;
- int height, width, boxh, boxw;
- WINDOW *dialog, *box;
- bool done = false;
-
- begin_reached = 1;
- end_reached = 0;
- page_length = 0;
- hscroll = 0;
- buf = tbuf;
- page = buf; /* page is pointer to start of page to be displayed */
-
- if (_vscroll && *_vscroll) {
- begin_reached = 0;
-
- for (i = 0; i < *_vscroll; i++)
- get_line();
- }
- if (_hscroll)
- hscroll = *_hscroll;
-
-do_resize:
- getmaxyx(stdscr, height, width);
- if (height < TEXTBOX_HEIGTH_MIN || width < TEXTBOX_WIDTH_MIN)
- return -ERRDISPLAYTOOSMALL;
- if (initial_height != 0)
- height = initial_height;
- else
- if (height > 4)
- height -= 4;
- else
- height = 0;
- if (initial_width != 0)
- width = initial_width;
- else
- if (width > 5)
- width -= 5;
- else
- width = 0;
-
- /* center dialog box on screen */
- x = (getmaxx(stdscr) - width) / 2;
- y = (getmaxy(stdscr) - height) / 2;
-
- draw_shadow(stdscr, y, x, height, width);
-
- dialog = newwin(height, width, y, x);
- keypad(dialog, TRUE);
-
- /* Create window for box region, used for scrolling text */
- boxh = height - 4;
- boxw = width - 2;
- box = subwin(dialog, boxh, boxw, y + 1, x + 1);
- wattrset(box, dlg.dialog.atr);
- wbkgdset(box, dlg.dialog.atr & A_COLOR);
-
- keypad(box, TRUE);
-
- /* register the new window, along with its borders */
- draw_box(dialog, 0, 0, height, width,
- dlg.dialog.atr, dlg.border.atr);
-
- wattrset(dialog, dlg.border.atr);
- mvwaddch(dialog, height - 3, 0, ACS_LTEE);
- for (i = 0; i < width - 2; i++)
- waddch(dialog, ACS_HLINE);
- wattrset(dialog, dlg.dialog.atr);
- wbkgdset(dialog, dlg.dialog.atr & A_COLOR);
- waddch(dialog, ACS_RTEE);
-
- print_title(dialog, title, width);
-
- print_button(dialog, gettext(" Exit "), height - 2, width / 2 - 4, TRUE);
- wnoutrefresh(dialog);
- getyx(dialog, cur_y, cur_x); /* Save cursor position */
-
- /* Print first page of text */
- attr_clear(box, boxh, boxw, dlg.dialog.atr);
- refresh_text_box(dialog, box, boxh, boxw, cur_y, cur_x, update_text,
- data);
-
- while (!done) {
- key = wgetch(dialog);
- switch (key) {
- case 'E': /* Exit */
- case 'e':
- case 'X':
- case 'x':
- case 'q':
- case '\n':
- done = true;
- break;
- case 'g': /* First page */
- case KEY_HOME:
- if (!begin_reached) {
- begin_reached = 1;
- page = buf;
- refresh_text_box(dialog, box, boxh, boxw,
- cur_y, cur_x, update_text,
- data);
- }
- break;
- case 'G': /* Last page */
- case KEY_END:
-
- end_reached = 1;
- /* point to last char in buf */
- page = buf + strlen(buf);
- back_lines(boxh);
- refresh_text_box(dialog, box, boxh, boxw, cur_y,
- cur_x, update_text, data);
- break;
- case 'K': /* Previous line */
- case 'k':
- case KEY_UP:
- if (begin_reached)
- break;
-
- back_lines(page_length + 1);
- refresh_text_box(dialog, box, boxh, boxw, cur_y,
- cur_x, update_text, data);
- break;
- case 'B': /* Previous page */
- case 'b':
- case 'u':
- case KEY_PPAGE:
- if (begin_reached)
- break;
- back_lines(page_length + boxh);
- refresh_text_box(dialog, box, boxh, boxw, cur_y,
- cur_x, update_text, data);
- break;
- case 'J': /* Next line */
- case 'j':
- case KEY_DOWN:
- if (end_reached)
- break;
-
- back_lines(page_length - 1);
- refresh_text_box(dialog, box, boxh, boxw, cur_y,
- cur_x, update_text, data);
- break;
- case KEY_NPAGE: /* Next page */
- case ' ':
- case 'd':
- if (end_reached)
- break;
-
- begin_reached = 0;
- refresh_text_box(dialog, box, boxh, boxw, cur_y,
- cur_x, update_text, data);
- break;
- case '0': /* Beginning of line */
- case 'H': /* Scroll left */
- case 'h':
- case KEY_LEFT:
- if (hscroll <= 0)
- break;
-
- if (key == '0')
- hscroll = 0;
- else
- hscroll--;
- /* Reprint current page to scroll horizontally */
- back_lines(page_length);
- refresh_text_box(dialog, box, boxh, boxw, cur_y,
- cur_x, update_text, data);
- break;
- case 'L': /* Scroll right */
- case 'l':
- case KEY_RIGHT:
- if (hscroll >= MAX_LEN)
- break;
- hscroll++;
- /* Reprint current page to scroll horizontally */
- back_lines(page_length);
- refresh_text_box(dialog, box, boxh, boxw, cur_y,
- cur_x, update_text, data);
- break;
- case KEY_ESC:
- if (on_key_esc(dialog) == KEY_ESC)
- done = true;
- break;
- case KEY_RESIZE:
- back_lines(height);
- delwin(box);
- delwin(dialog);
- on_key_resize();
- goto do_resize;
- default:
- for (i = 0; keys[i]; i++) {
- if (key == keys[i]) {
- done = true;
- break;
- }
- }
- }
- }
- delwin(box);
- delwin(dialog);
- if (_vscroll) {
- const char *s;
-
- s = buf;
- *_vscroll = 0;
- back_lines(page_length);
- while (s < page && (s = strchr(s, '\n'))) {
- (*_vscroll)++;
- s++;
- }
- }
- if (_hscroll)
- *_hscroll = hscroll;
- return key;
-}
-
-/*
- * Go back 'n' lines in text. Called by dialog_textbox().
- * 'page' will be updated to point to the desired line in 'buf'.
- */
-static void back_lines(int n)
-{
- int i;
-
- begin_reached = 0;
- /* Go back 'n' lines */
- for (i = 0; i < n; i++) {
- if (*page == '\0') {
- if (end_reached) {
- end_reached = 0;
- continue;
- }
- }
- if (page == buf) {
- begin_reached = 1;
- return;
- }
- page--;
- do {
- if (page == buf) {
- begin_reached = 1;
- return;
- }
- page--;
- } while (*page != '\n');
- page++;
- }
-}
-
-/*
- * Print a new page of text.
- */
-static void print_page(WINDOW *win, int height, int width, update_text_fn
- update_text, void *data)
-{
- int i, passed_end = 0;
-
- if (update_text) {
- char *end;
-
- for (i = 0; i < height; i++)
- get_line();
- end = page;
- back_lines(height);
- update_text(buf, page - buf, end - buf, data);
- }
-
- page_length = 0;
- for (i = 0; i < height; i++) {
- print_line(win, i, width);
- if (!passed_end)
- page_length++;
- if (end_reached && !passed_end)
- passed_end = 1;
- }
- wnoutrefresh(win);
-}
-
-/*
- * Print a new line of text.
- */
-static void print_line(WINDOW * win, int row, int width)
-{
- char *line;
-
- line = get_line();
- line += MIN(strlen(line), hscroll); /* Scroll horizontally */
- wmove(win, row, 0); /* move cursor to correct line */
- waddch(win, ' ');
- waddnstr(win, line, MIN(strlen(line), width - 2));
-
- /* Clear 'residue' of previous line */
-#if OLD_NCURSES
- {
- int x = getcurx(win);
- int i;
- for (i = 0; i < width - x; i++)
- waddch(win, ' ');
- }
-#else
- wclrtoeol(win);
-#endif
-}
-
-/*
- * Return current line of text. Called by dialog_textbox() and print_line().
- * 'page' should point to start of current line before calling, and will be
- * updated to point to start of next line.
- */
-static char *get_line(void)
-{
- int i = 0;
- static char line[MAX_LEN + 1];
-
- end_reached = 0;
- while (*page != '\n') {
- if (*page == '\0') {
- end_reached = 1;
- break;
- } else if (i < MAX_LEN)
- line[i++] = *(page++);
- else {
- /* Truncate lines longer than MAX_LEN characters */
- if (i == MAX_LEN)
- line[i++] = '\0';
- page++;
- }
- }
- if (i <= MAX_LEN)
- line[i] = '\0';
- if (!end_reached)
- page++; /* move past '\n' */
-
- return line;
-}
-
-/*
- * Print current position
- */
-static void print_position(WINDOW * win)
-{
- int percent;
-
- wattrset(win, dlg.position_indicator.atr);
- wbkgdset(win, dlg.position_indicator.atr & A_COLOR);
- percent = (page - buf) * 100 / strlen(buf);
- wmove(win, getmaxy(win) - 3, getmaxx(win) - 9);
- wprintw(win, "(%3d%%)", percent);
-}
+++ /dev/null
-/*
- * util.c
- *
- * ORIGINAL AUTHOR: Savio Lam (lam836@cs.cuhk.hk)
- * MODIFIED FOR LINUX KERNEL CONFIG BY: William Roadcap (roadcap@cfw.com)
- *
- * This program is free software; you can redistribute it and/or
- * modify it under the terms of the GNU General Public License
- * as published by the Free Software Foundation; either version 2
- * of the License, or (at your option) any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- * GNU General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software
- * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
- */
-
-#include <stdarg.h>
-
-#include "dialog.h"
-
-/* Needed in signal handler in mconf.c */
-int saved_x, saved_y;
-
-struct dialog_info dlg;
-
-static void set_mono_theme(void)
-{
- dlg.screen.atr = A_NORMAL;
- dlg.shadow.atr = A_NORMAL;
- dlg.dialog.atr = A_NORMAL;
- dlg.title.atr = A_BOLD;
- dlg.border.atr = A_NORMAL;
- dlg.button_active.atr = A_REVERSE;
- dlg.button_inactive.atr = A_DIM;
- dlg.button_key_active.atr = A_REVERSE;
- dlg.button_key_inactive.atr = A_BOLD;
- dlg.button_label_active.atr = A_REVERSE;
- dlg.button_label_inactive.atr = A_NORMAL;
- dlg.inputbox.atr = A_NORMAL;
- dlg.inputbox_border.atr = A_NORMAL;
- dlg.searchbox.atr = A_NORMAL;
- dlg.searchbox_title.atr = A_BOLD;
- dlg.searchbox_border.atr = A_NORMAL;
- dlg.position_indicator.atr = A_BOLD;
- dlg.menubox.atr = A_NORMAL;
- dlg.menubox_border.atr = A_NORMAL;
- dlg.item.atr = A_NORMAL;
- dlg.item_selected.atr = A_REVERSE;
- dlg.tag.atr = A_BOLD;
- dlg.tag_selected.atr = A_REVERSE;
- dlg.tag_key.atr = A_BOLD;
- dlg.tag_key_selected.atr = A_REVERSE;
- dlg.check.atr = A_BOLD;
- dlg.check_selected.atr = A_REVERSE;
- dlg.uarrow.atr = A_BOLD;
- dlg.darrow.atr = A_BOLD;
-}
-
-#define DLG_COLOR(dialog, f, b, h) \
-do { \
- dlg.dialog.fg = (f); \
- dlg.dialog.bg = (b); \
- dlg.dialog.hl = (h); \
-} while (0)
-
-static void set_classic_theme(void)
-{
- DLG_COLOR(screen, COLOR_CYAN, COLOR_BLUE, true);
- DLG_COLOR(shadow, COLOR_BLACK, COLOR_BLACK, true);
- DLG_COLOR(dialog, COLOR_BLACK, COLOR_WHITE, false);
- DLG_COLOR(title, COLOR_YELLOW, COLOR_WHITE, true);
- DLG_COLOR(border, COLOR_WHITE, COLOR_WHITE, true);
- DLG_COLOR(button_active, COLOR_WHITE, COLOR_BLUE, true);
- DLG_COLOR(button_inactive, COLOR_BLACK, COLOR_WHITE, false);
- DLG_COLOR(button_key_active, COLOR_WHITE, COLOR_BLUE, true);
- DLG_COLOR(button_key_inactive, COLOR_RED, COLOR_WHITE, false);
- DLG_COLOR(button_label_active, COLOR_YELLOW, COLOR_BLUE, true);
- DLG_COLOR(button_label_inactive, COLOR_BLACK, COLOR_WHITE, true);
- DLG_COLOR(inputbox, COLOR_BLACK, COLOR_WHITE, false);
- DLG_COLOR(inputbox_border, COLOR_BLACK, COLOR_WHITE, false);
- DLG_COLOR(searchbox, COLOR_BLACK, COLOR_WHITE, false);
- DLG_COLOR(searchbox_title, COLOR_YELLOW, COLOR_WHITE, true);
- DLG_COLOR(searchbox_border, COLOR_WHITE, COLOR_WHITE, true);
- DLG_COLOR(position_indicator, COLOR_YELLOW, COLOR_WHITE, true);
- DLG_COLOR(menubox, COLOR_BLACK, COLOR_WHITE, false);
- DLG_COLOR(menubox_border, COLOR_WHITE, COLOR_WHITE, true);
- DLG_COLOR(item, COLOR_BLACK, COLOR_WHITE, false);
- DLG_COLOR(item_selected, COLOR_WHITE, COLOR_BLUE, true);
- DLG_COLOR(tag, COLOR_YELLOW, COLOR_WHITE, true);
- DLG_COLOR(tag_selected, COLOR_YELLOW, COLOR_BLUE, true);
- DLG_COLOR(tag_key, COLOR_YELLOW, COLOR_WHITE, true);
- DLG_COLOR(tag_key_selected, COLOR_YELLOW, COLOR_BLUE, true);
- DLG_COLOR(check, COLOR_BLACK, COLOR_WHITE, false);
- DLG_COLOR(check_selected, COLOR_WHITE, COLOR_BLUE, true);
- DLG_COLOR(uarrow, COLOR_GREEN, COLOR_WHITE, true);
- DLG_COLOR(darrow, COLOR_GREEN, COLOR_WHITE, true);
-}
-
-static void set_blackbg_theme(void)
-{
- DLG_COLOR(screen, COLOR_RED, COLOR_BLACK, true);
- DLG_COLOR(shadow, COLOR_BLACK, COLOR_BLACK, false);
- DLG_COLOR(dialog, COLOR_WHITE, COLOR_BLACK, false);
- DLG_COLOR(title, COLOR_RED, COLOR_BLACK, false);
- DLG_COLOR(border, COLOR_BLACK, COLOR_BLACK, true);
-
- DLG_COLOR(button_active, COLOR_YELLOW, COLOR_RED, false);
- DLG_COLOR(button_inactive, COLOR_YELLOW, COLOR_BLACK, false);
- DLG_COLOR(button_key_active, COLOR_YELLOW, COLOR_RED, true);
- DLG_COLOR(button_key_inactive, COLOR_RED, COLOR_BLACK, false);
- DLG_COLOR(button_label_active, COLOR_WHITE, COLOR_RED, false);
- DLG_COLOR(button_label_inactive, COLOR_BLACK, COLOR_BLACK, true);
-
- DLG_COLOR(inputbox, COLOR_YELLOW, COLOR_BLACK, false);
- DLG_COLOR(inputbox_border, COLOR_YELLOW, COLOR_BLACK, false);
-
- DLG_COLOR(searchbox, COLOR_YELLOW, COLOR_BLACK, false);
- DLG_COLOR(searchbox_title, COLOR_YELLOW, COLOR_BLACK, true);
- DLG_COLOR(searchbox_border, COLOR_BLACK, COLOR_BLACK, true);
-
- DLG_COLOR(position_indicator, COLOR_RED, COLOR_BLACK, false);
-
- DLG_COLOR(menubox, COLOR_YELLOW, COLOR_BLACK, false);
- DLG_COLOR(menubox_border, COLOR_BLACK, COLOR_BLACK, true);
-
- DLG_COLOR(item, COLOR_WHITE, COLOR_BLACK, false);
- DLG_COLOR(item_selected, COLOR_WHITE, COLOR_RED, false);
-
- DLG_COLOR(tag, COLOR_RED, COLOR_BLACK, false);
- DLG_COLOR(tag_selected, COLOR_YELLOW, COLOR_RED, true);
- DLG_COLOR(tag_key, COLOR_RED, COLOR_BLACK, false);
- DLG_COLOR(tag_key_selected, COLOR_YELLOW, COLOR_RED, true);
-
- DLG_COLOR(check, COLOR_YELLOW, COLOR_BLACK, false);
- DLG_COLOR(check_selected, COLOR_YELLOW, COLOR_RED, true);
-
- DLG_COLOR(uarrow, COLOR_RED, COLOR_BLACK, false);
- DLG_COLOR(darrow, COLOR_RED, COLOR_BLACK, false);
-}
-
-static void set_bluetitle_theme(void)
-{
- set_classic_theme();
- DLG_COLOR(title, COLOR_BLUE, COLOR_WHITE, true);
- DLG_COLOR(button_key_active, COLOR_YELLOW, COLOR_BLUE, true);
- DLG_COLOR(button_label_active, COLOR_WHITE, COLOR_BLUE, true);
- DLG_COLOR(searchbox_title, COLOR_BLUE, COLOR_WHITE, true);
- DLG_COLOR(position_indicator, COLOR_BLUE, COLOR_WHITE, true);
- DLG_COLOR(tag, COLOR_BLUE, COLOR_WHITE, true);
- DLG_COLOR(tag_key, COLOR_BLUE, COLOR_WHITE, true);
-
-}
-
-/*
- * Select color theme
- */
-static int set_theme(const char *theme)
-{
- int use_color = 1;
- if (!theme)
- set_bluetitle_theme();
- else if (strcmp(theme, "classic") == 0)
- set_classic_theme();
- else if (strcmp(theme, "bluetitle") == 0)
- set_bluetitle_theme();
- else if (strcmp(theme, "blackbg") == 0)
- set_blackbg_theme();
- else if (strcmp(theme, "mono") == 0)
- use_color = 0;
-
- return use_color;
-}
-
-static void init_one_color(struct dialog_color *color)
-{
- static int pair = 0;
-
- pair++;
- init_pair(pair, color->fg, color->bg);
- if (color->hl)
- color->atr = A_BOLD | COLOR_PAIR(pair);
- else
- color->atr = COLOR_PAIR(pair);
-}
-
-static void init_dialog_colors(void)
-{
- init_one_color(&dlg.screen);
- init_one_color(&dlg.shadow);
- init_one_color(&dlg.dialog);
- init_one_color(&dlg.title);
- init_one_color(&dlg.border);
- init_one_color(&dlg.button_active);
- init_one_color(&dlg.button_inactive);
- init_one_color(&dlg.button_key_active);
- init_one_color(&dlg.button_key_inactive);
- init_one_color(&dlg.button_label_active);
- init_one_color(&dlg.button_label_inactive);
- init_one_color(&dlg.inputbox);
- init_one_color(&dlg.inputbox_border);
- init_one_color(&dlg.searchbox);
- init_one_color(&dlg.searchbox_title);
- init_one_color(&dlg.searchbox_border);
- init_one_color(&dlg.position_indicator);
- init_one_color(&dlg.menubox);
- init_one_color(&dlg.menubox_border);
- init_one_color(&dlg.item);
- init_one_color(&dlg.item_selected);
- init_one_color(&dlg.tag);
- init_one_color(&dlg.tag_selected);
- init_one_color(&dlg.tag_key);
- init_one_color(&dlg.tag_key_selected);
- init_one_color(&dlg.check);
- init_one_color(&dlg.check_selected);
- init_one_color(&dlg.uarrow);
- init_one_color(&dlg.darrow);
-}
-
-/*
- * Setup for color display
- */
-static void color_setup(const char *theme)
-{
- int use_color;
-
- use_color = set_theme(theme);
- if (use_color && has_colors()) {
- start_color();
- init_dialog_colors();
- } else
- set_mono_theme();
-}
-
-/*
- * Set window to attribute 'attr'
- */
-void attr_clear(WINDOW * win, int height, int width, chtype attr)
-{
- int i, j;
-
- wattrset(win, attr);
- for (i = 0; i < height; i++) {
- wmove(win, i, 0);
- for (j = 0; j < width; j++)
- waddch(win, ' ');
- }
- touchwin(win);
-}
-
-void dialog_clear(void)
-{
- int lines, columns;
-
- lines = getmaxy(stdscr);
- columns = getmaxx(stdscr);
-
- attr_clear(stdscr, lines, columns, dlg.screen.atr);
- /* Display background title if it exists ... - SLH */
- if (dlg.backtitle != NULL) {
- int i, len = 0, skip = 0;
- struct subtitle_list *pos;
-
- wattrset(stdscr, dlg.screen.atr);
- mvwaddstr(stdscr, 0, 1, (char *)dlg.backtitle);
-
- for (pos = dlg.subtitles; pos != NULL; pos = pos->next) {
- /* 3 is for the arrow and spaces */
- len += strlen(pos->text) + 3;
- }
-
- wmove(stdscr, 1, 1);
- if (len > columns - 2) {
- const char *ellipsis = "[...] ";
- waddstr(stdscr, ellipsis);
- skip = len - (columns - 2 - strlen(ellipsis));
- }
-
- for (pos = dlg.subtitles; pos != NULL; pos = pos->next) {
- if (skip == 0)
- waddch(stdscr, ACS_RARROW);
- else
- skip--;
-
- if (skip == 0)
- waddch(stdscr, ' ');
- else
- skip--;
-
- if (skip < strlen(pos->text)) {
- waddstr(stdscr, pos->text + skip);
- skip = 0;
- } else
- skip -= strlen(pos->text);
-
- if (skip == 0)
- waddch(stdscr, ' ');
- else
- skip--;
- }
-
- for (i = len + 1; i < columns - 1; i++)
- waddch(stdscr, ACS_HLINE);
- }
- wnoutrefresh(stdscr);
-}
-
-/*
- * Do some initialization for dialog
- */
-int init_dialog(const char *backtitle)
-{
- int height, width;
-
- initscr(); /* Init curses */
-
- /* Get current cursor position for signal handler in mconf.c */
- getyx(stdscr, saved_y, saved_x);
-
- getmaxyx(stdscr, height, width);
- if (height < WINDOW_HEIGTH_MIN || width < WINDOW_WIDTH_MIN) {
- endwin();
- return -ERRDISPLAYTOOSMALL;
- }
-
- dlg.backtitle = backtitle;
- color_setup(getenv("MENUCONFIG_COLOR"));
-
- keypad(stdscr, TRUE);
- cbreak();
- noecho();
- dialog_clear();
-
- return 0;
-}
-
-void set_dialog_backtitle(const char *backtitle)
-{
- dlg.backtitle = backtitle;
-}
-
-void set_dialog_subtitles(struct subtitle_list *subtitles)
-{
- dlg.subtitles = subtitles;
-}
-
-/*
- * End using dialog functions.
- */
-void end_dialog(int x, int y)
-{
- /* move cursor back to original position */
- move(y, x);
- refresh();
- endwin();
-}
-
-/* Print the title of the dialog. Center the title and truncate
- * tile if wider than dialog (- 2 chars).
- **/
-void print_title(WINDOW *dialog, const char *title, int width)
-{
- if (title) {
- int tlen = MIN(width - 2, strlen(title));
- wattrset(dialog, dlg.title.atr);
- mvwaddch(dialog, 0, (width - tlen) / 2 - 1, ' ');
- mvwaddnstr(dialog, 0, (width - tlen)/2, title, tlen);
- waddch(dialog, ' ');
- }
-}
-
-/*
- * Print a string of text in a window, automatically wrap around to the
- * next line if the string is too long to fit on one line. Newline
- * characters '\n' are propperly processed. We start on a new line
- * if there is no room for at least 4 nonblanks following a double-space.
- */
-void print_autowrap(WINDOW * win, const char *prompt, int width, int y, int x)
-{
- int newl, cur_x, cur_y;
- int prompt_len, room, wlen;
- char tempstr[MAX_LEN + 1], *word, *sp, *sp2, *newline_separator = 0;
-
- strcpy(tempstr, prompt);
-
- prompt_len = strlen(tempstr);
-
- if (prompt_len <= width - x * 2) { /* If prompt is short */
- wmove(win, y, (width - prompt_len) / 2);
- waddstr(win, tempstr);
- } else {
- cur_x = x;
- cur_y = y;
- newl = 1;
- word = tempstr;
- while (word && *word) {
- sp = strpbrk(word, "\n ");
- if (sp && *sp == '\n')
- newline_separator = sp;
-
- if (sp)
- *sp++ = 0;
-
- /* Wrap to next line if either the word does not fit,
- or it is the first word of a new sentence, and it is
- short, and the next word does not fit. */
- room = width - cur_x;
- wlen = strlen(word);
- if (wlen > room ||
- (newl && wlen < 4 && sp
- && wlen + 1 + strlen(sp) > room
- && (!(sp2 = strpbrk(sp, "\n "))
- || wlen + 1 + (sp2 - sp) > room))) {
- cur_y++;
- cur_x = x;
- }
- wmove(win, cur_y, cur_x);
- waddstr(win, word);
- getyx(win, cur_y, cur_x);
-
- /* Move to the next line if the word separator was a newline */
- if (newline_separator) {
- cur_y++;
- cur_x = x;
- newline_separator = 0;
- } else
- cur_x++;
-
- if (sp && *sp == ' ') {
- cur_x++; /* double space */
- while (*++sp == ' ') ;
- newl = 1;
- } else
- newl = 0;
- word = sp;
- }
- }
-}
-
-/*
- * Print a button
- */
-void print_button(WINDOW * win, const char *label, int y, int x, int selected)
-{
- int i, temp;
-
- wmove(win, y, x);
- wattrset(win, selected ? dlg.button_active.atr
- : dlg.button_inactive.atr);
- waddstr(win, "<");
- temp = strspn(label, " ");
- label += temp;
- wattrset(win, selected ? dlg.button_label_active.atr
- : dlg.button_label_inactive.atr);
- for (i = 0; i < temp; i++)
- waddch(win, ' ');
- wattrset(win, selected ? dlg.button_key_active.atr
- : dlg.button_key_inactive.atr);
- waddch(win, label[0]);
- wattrset(win, selected ? dlg.button_label_active.atr
- : dlg.button_label_inactive.atr);
- waddstr(win, (char *)label + 1);
- wattrset(win, selected ? dlg.button_active.atr
- : dlg.button_inactive.atr);
- waddstr(win, ">");
- wmove(win, y, x + temp + 1);
-}
-
-/*
- * Draw a rectangular box with line drawing characters
- */
-void
-draw_box(WINDOW * win, int y, int x, int height, int width,
- chtype box, chtype border)
-{
- int i, j;
-
- wattrset(win, 0);
- for (i = 0; i < height; i++) {
- wmove(win, y + i, x);
- for (j = 0; j < width; j++)
- if (!i && !j)
- waddch(win, border | ACS_ULCORNER);
- else if (i == height - 1 && !j)
- waddch(win, border | ACS_LLCORNER);
- else if (!i && j == width - 1)
- waddch(win, box | ACS_URCORNER);
- else if (i == height - 1 && j == width - 1)
- waddch(win, box | ACS_LRCORNER);
- else if (!i)
- waddch(win, border | ACS_HLINE);
- else if (i == height - 1)
- waddch(win, box | ACS_HLINE);
- else if (!j)
- waddch(win, border | ACS_VLINE);
- else if (j == width - 1)
- waddch(win, box | ACS_VLINE);
- else
- waddch(win, box | ' ');
- }
-}
-
-/*
- * Draw shadows along the right and bottom edge to give a more 3D look
- * to the boxes
- */
-void draw_shadow(WINDOW * win, int y, int x, int height, int width)
-{
- int i;
-
- if (has_colors()) { /* Whether terminal supports color? */
- wattrset(win, dlg.shadow.atr);
- wmove(win, y + height, x + 2);
- for (i = 0; i < width; i++)
- waddch(win, winch(win) & A_CHARTEXT);
- for (i = y + 1; i < y + height + 1; i++) {
- wmove(win, i, x + width);
- waddch(win, winch(win) & A_CHARTEXT);
- waddch(win, winch(win) & A_CHARTEXT);
- }
- wnoutrefresh(win);
- }
-}
-
-/*
- * Return the position of the first alphabetic character in a string.
- */
-int first_alpha(const char *string, const char *exempt)
-{
- int i, in_paren = 0, c;
-
- for (i = 0; i < strlen(string); i++) {
- c = tolower(string[i]);
-
- if (strchr("<[(", c))
- ++in_paren;
- if (strchr(">])", c) && in_paren > 0)
- --in_paren;
-
- if ((!in_paren) && isalpha(c) && strchr(exempt, c) == 0)
- return i;
- }
-
- return 0;
-}
-
-/*
- * ncurses uses ESC to detect escaped char sequences. This resutl in
- * a small timeout before ESC is actually delivered to the application.
- * lxdialog suggest <ESC> <ESC> which is correctly translated to two
- * times esc. But then we need to ignore the second esc to avoid stepping
- * out one menu too much. Filter away all escaped key sequences since
- * keypad(FALSE) turn off ncurses support for escape sequences - and thats
- * needed to make notimeout() do as expected.
- */
-int on_key_esc(WINDOW *win)
-{
- int key;
- int key2;
- int key3;
-
- nodelay(win, TRUE);
- keypad(win, FALSE);
- key = wgetch(win);
- key2 = wgetch(win);
- do {
- key3 = wgetch(win);
- } while (key3 != ERR);
- nodelay(win, FALSE);
- keypad(win, TRUE);
- if (key == KEY_ESC && key2 == ERR)
- return KEY_ESC;
- else if (key != ERR && key != KEY_ESC && key2 == ERR)
- ungetch(key);
-
- return -1;
-}
-
-/* redraw screen in new size */
-int on_key_resize(void)
-{
- dialog_clear();
- return KEY_RESIZE;
-}
-
-struct dialog_list *item_cur;
-struct dialog_list item_nil;
-struct dialog_list *item_head;
-
-void item_reset(void)
-{
- struct dialog_list *p, *next;
-
- for (p = item_head; p; p = next) {
- next = p->next;
- free(p);
- }
- item_head = NULL;
- item_cur = &item_nil;
-}
-
-void item_make(const char *fmt, ...)
-{
- va_list ap;
- struct dialog_list *p = malloc(sizeof(*p));
-
- if (item_head)
- item_cur->next = p;
- else
- item_head = p;
- item_cur = p;
- memset(p, 0, sizeof(*p));
-
- va_start(ap, fmt);
- vsnprintf(item_cur->node.str, sizeof(item_cur->node.str), fmt, ap);
- va_end(ap);
-}
-
-void item_add_str(const char *fmt, ...)
-{
- va_list ap;
- size_t avail;
-
- avail = sizeof(item_cur->node.str) - strlen(item_cur->node.str);
-
- va_start(ap, fmt);
- vsnprintf(item_cur->node.str + strlen(item_cur->node.str),
- avail, fmt, ap);
- item_cur->node.str[sizeof(item_cur->node.str) - 1] = '\0';
- va_end(ap);
-}
-
-void item_set_tag(char tag)
-{
- item_cur->node.tag = tag;
-}
-void item_set_data(void *ptr)
-{
- item_cur->node.data = ptr;
-}
-
-void item_set_selected(int val)
-{
- item_cur->node.selected = val;
-}
-
-int item_activate_selected(void)
-{
- item_foreach()
- if (item_is_selected())
- return 1;
- return 0;
-}
-
-void *item_data(void)
-{
- return item_cur->node.data;
-}
-
-char item_tag(void)
-{
- return item_cur->node.tag;
-}
-
-int item_count(void)
-{
- int n = 0;
- struct dialog_list *p;
-
- for (p = item_head; p; p = p->next)
- n++;
- return n;
-}
-
-void item_set(int n)
-{
- int i = 0;
- item_foreach()
- if (i++ == n)
- return;
-}
-
-int item_n(void)
-{
- int n = 0;
- struct dialog_list *p;
-
- for (p = item_head; p; p = p->next) {
- if (p == item_cur)
- return n;
- n++;
- }
- return 0;
-}
-
-const char *item_str(void)
-{
- return item_cur->node.str;
-}
-
-int item_is_selected(void)
-{
- return (item_cur->node.selected != 0);
-}
-
-int item_is_tag(char tag)
-{
- return (item_cur->node.tag == tag);
-}
+++ /dev/null
-/*
- * yesno.c -- implements the yes/no box
- *
- * ORIGINAL AUTHOR: Savio Lam (lam836@cs.cuhk.hk)
- * MODIFIED FOR LINUX KERNEL CONFIG BY: William Roadcap (roadcap@cfw.com)
- *
- * This program is free software; you can redistribute it and/or
- * modify it under the terms of the GNU General Public License
- * as published by the Free Software Foundation; either version 2
- * of the License, or (at your option) any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- * GNU General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software
- * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
- */
-
-#include "dialog.h"
-
-/*
- * Display termination buttons
- */
-static void print_buttons(WINDOW * dialog, int height, int width, int selected)
-{
- int x = width / 2 - 10;
- int y = height - 2;
-
- print_button(dialog, gettext(" Yes "), y, x, selected == 0);
- print_button(dialog, gettext(" No "), y, x + 13, selected == 1);
-
- wmove(dialog, y, x + 1 + 13 * selected);
- wrefresh(dialog);
-}
-
-/*
- * Display a dialog box with two buttons - Yes and No
- */
-int dialog_yesno(const char *title, const char *prompt, int height, int width)
-{
- int i, x, y, key = 0, button = 0;
- WINDOW *dialog;
-
-do_resize:
- if (getmaxy(stdscr) < (height + YESNO_HEIGTH_MIN))
- return -ERRDISPLAYTOOSMALL;
- if (getmaxx(stdscr) < (width + YESNO_WIDTH_MIN))
- return -ERRDISPLAYTOOSMALL;
-
- /* center dialog box on screen */
- x = (getmaxx(stdscr) - width) / 2;
- y = (getmaxy(stdscr) - height) / 2;
-
- draw_shadow(stdscr, y, x, height, width);
-
- dialog = newwin(height, width, y, x);
- keypad(dialog, TRUE);
-
- draw_box(dialog, 0, 0, height, width,
- dlg.dialog.atr, dlg.border.atr);
- wattrset(dialog, dlg.border.atr);
- mvwaddch(dialog, height - 3, 0, ACS_LTEE);
- for (i = 0; i < width - 2; i++)
- waddch(dialog, ACS_HLINE);
- wattrset(dialog, dlg.dialog.atr);
- waddch(dialog, ACS_RTEE);
-
- print_title(dialog, title, width);
-
- wattrset(dialog, dlg.dialog.atr);
- print_autowrap(dialog, prompt, width - 2, 1, 3);
-
- print_buttons(dialog, height, width, 0);
-
- while (key != KEY_ESC) {
- key = wgetch(dialog);
- switch (key) {
- case 'Y':
- case 'y':
- delwin(dialog);
- return 0;
- case 'N':
- case 'n':
- delwin(dialog);
- return 1;
-
- case TAB:
- case KEY_LEFT:
- case KEY_RIGHT:
- button = ((key == KEY_LEFT ? --button : ++button) < 0) ? 1 : (button > 1 ? 0 : button);
-
- print_buttons(dialog, height, width, button);
- wrefresh(dialog);
- break;
- case ' ':
- case '\n':
- delwin(dialog);
- return button;
- case KEY_ESC:
- key = on_key_esc(dialog);
- break;
- case KEY_RESIZE:
- delwin(dialog);
- on_key_resize();
- goto do_resize;
- }
- }
-
- delwin(dialog);
- return key; /* ESC pressed */
-}
+++ /dev/null
-/*
- * Copyright (C) 2002 Roman Zippel <zippel@linux-m68k.org>
- * Released under the terms of the GNU GPL v2.0.
- *
- * Introduced single menu mode (show all sub-menus in one large tree).
- * 2002-11-06 Petr Baudis <pasky@ucw.cz>
- *
- * i18n, 2005, Arnaldo Carvalho de Melo <acme@conectiva.com.br>
- */
-
-#include <ctype.h>
-#include <errno.h>
-#include <fcntl.h>
-#include <limits.h>
-#include <stdarg.h>
-#include <stdlib.h>
-#include <string.h>
-#include <signal.h>
-#include <unistd.h>
-#include <locale.h>
-
-#include "lkc.h"
-#include "lxdialog/dialog.h"
-
-static const char mconf_readme[] = N_(
-"Overview\n"
-"--------\n"
-"This interface lets you select features and parameters for the build.\n"
-"Features can either be built-in, modularized, or ignored. Parameters\n"
-"must be entered in as decimal or hexadecimal numbers or text.\n"
-"\n"
-"Menu items beginning with following braces represent features that\n"
-" [ ] can be built in or removed\n"
-" < > can be built in, modularized or removed\n"
-" { } can be built in or modularized (selected by other feature)\n"
-" - - are selected by other feature,\n"
-"while *, M or whitespace inside braces means to build in, build as\n"
-"a module or to exclude the feature respectively.\n"
-"\n"
-"To change any of these features, highlight it with the cursor\n"
-"keys and press <Y> to build it in, <M> to make it a module or\n"
-"<N> to remove it. You may also press the <Space Bar> to cycle\n"
-"through the available options (i.e. Y->N->M->Y).\n"
-"\n"
-"Some additional keyboard hints:\n"
-"\n"
-"Menus\n"
-"----------\n"
-"o Use the Up/Down arrow keys (cursor keys) to highlight the item you\n"
-" wish to change or the submenu you wish to select and press <Enter>.\n"
-" Submenus are designated by \"--->\", empty ones by \"----\".\n"
-"\n"
-" Shortcut: Press the option's highlighted letter (hotkey).\n"
-" Pressing a hotkey more than once will sequence\n"
-" through all visible items which use that hotkey.\n"
-"\n"
-" You may also use the <PAGE UP> and <PAGE DOWN> keys to scroll\n"
-" unseen options into view.\n"
-"\n"
-"o To exit a menu use the cursor keys to highlight the <Exit> button\n"
-" and press <ENTER>.\n"
-"\n"
-" Shortcut: Press <ESC><ESC> or <E> or <X> if there is no hotkey\n"
-" using those letters. You may press a single <ESC>, but\n"
-" there is a delayed response which you may find annoying.\n"
-"\n"
-" Also, the <TAB> and cursor keys will cycle between <Select>,\n"
-" <Exit>, <Help>, <Save>, and <Load>.\n"
-"\n"
-"o To get help with an item, use the cursor keys to highlight <Help>\n"
-" and press <ENTER>.\n"
-"\n"
-" Shortcut: Press <H> or <?>.\n"
-"\n"
-"o To toggle the display of hidden options, press <Z>.\n"
-"\n"
-"\n"
-"Radiolists (Choice lists)\n"
-"-----------\n"
-"o Use the cursor keys to select the option you wish to set and press\n"
-" <S> or the <SPACE BAR>.\n"
-"\n"
-" Shortcut: Press the first letter of the option you wish to set then\n"
-" press <S> or <SPACE BAR>.\n"
-"\n"
-"o To see available help for the item, use the cursor keys to highlight\n"
-" <Help> and Press <ENTER>.\n"
-"\n"
-" Shortcut: Press <H> or <?>.\n"
-"\n"
-" Also, the <TAB> and cursor keys will cycle between <Select> and\n"
-" <Help>\n"
-"\n"
-"\n"
-"Data Entry\n"
-"-----------\n"
-"o Enter the requested information and press <ENTER>\n"
-" If you are entering hexadecimal values, it is not necessary to\n"
-" add the '0x' prefix to the entry.\n"
-"\n"
-"o For help, use the <TAB> or cursor keys to highlight the help option\n"
-" and press <ENTER>. You can try <TAB><H> as well.\n"
-"\n"
-"\n"
-"Text Box (Help Window)\n"
-"--------\n"
-"o Use the cursor keys to scroll up/down/left/right. The VI editor\n"
-" keys h,j,k,l function here as do <u>, <d>, <SPACE BAR> and <B> for\n"
-" those who are familiar with less and lynx.\n"
-"\n"
-"o Press <E>, <X>, <q>, <Enter> or <Esc><Esc> to exit.\n"
-"\n"
-"\n"
-"Alternate Configuration Files\n"
-"-----------------------------\n"
-"Menuconfig supports the use of alternate configuration files for\n"
-"those who, for various reasons, find it necessary to switch\n"
-"between different configurations.\n"
-"\n"
-"The <Save> button will let you save the current configuration to\n"
-"a file of your choosing. Use the <Load> button to load a previously\n"
-"saved alternate configuration.\n"
-"\n"
-"Even if you don't use alternate configuration files, but you find\n"
-"during a Menuconfig session that you have completely messed up your\n"
-"settings, you may use the <Load> button to restore your previously\n"
-"saved settings from \".config\" without restarting Menuconfig.\n"
-"\n"
-"Other information\n"
-"-----------------\n"
-"If you use Menuconfig in an XTERM window, make sure you have your\n"
-"$TERM variable set to point to an xterm definition which supports\n"
-"color. Otherwise, Menuconfig will look rather bad. Menuconfig will\n"
-"not display correctly in an RXVT window because rxvt displays only one\n"
-"intensity of color, bright.\n"
-"\n"
-"Menuconfig will display larger menus on screens or xterms which are\n"
-"set to display more than the standard 25 row by 80 column geometry.\n"
-"In order for this to work, the \"stty size\" command must be able to\n"
-"display the screen's current row and column geometry. I STRONGLY\n"
-"RECOMMEND that you make sure you do NOT have the shell variables\n"
-"LINES and COLUMNS exported into your environment. Some distributions\n"
-"export those variables via /etc/profile. Some ncurses programs can\n"
-"become confused when those variables (LINES & COLUMNS) don't reflect\n"
-"the true screen size.\n"
-"\n"
-"Optional personality available\n"
-"------------------------------\n"
-"If you prefer to have all of the options listed in a single menu,\n"
-"rather than the default multimenu hierarchy, run the menuconfig with\n"
-"MENUCONFIG_MODE environment variable set to single_menu. Example:\n"
-"\n"
-"make MENUCONFIG_MODE=single_menu menuconfig\n"
-"\n"
-"<Enter> will then unroll the appropriate category, or enfold it if it\n"
-"is already unrolled.\n"
-"\n"
-"Note that this mode can eventually be a little more CPU expensive\n"
-"(especially with a larger number of unrolled categories) than the\n"
-"default mode.\n"
-"\n"
-"Different color themes available\n"
-"--------------------------------\n"
-"It is possible to select different color themes using the variable\n"
-"MENUCONFIG_COLOR. To select a theme use:\n"
-"\n"
-"make MENUCONFIG_COLOR=<theme> menuconfig\n"
-"\n"
-"Available themes are\n"
-" mono => selects colors suitable for monochrome displays\n"
-" blackbg => selects a color scheme with black background\n"
-" classic => theme with blue background. The classic look\n"
-" bluetitle => an LCD friendly version of classic. (default)\n"
-"\n"),
-menu_instructions[] = N_(
- "Arrow keys navigate the menu. "
- "<Enter> selects submenus ---> (or empty submenus ----). "
- "Highlighted letters are hotkeys. "
- "Pressing <Y> includes, <N> excludes, <M> modularizes features. "
- "Press <Esc><Esc> to exit, <?> for Help, </> for Search. "
- "Legend: [*] built-in [ ] excluded <M> module < > module capable"),
-radiolist_instructions[] = N_(
- "Use the arrow keys to navigate this window or "
- "press the hotkey of the item you wish to select "
- "followed by the <SPACE BAR>. "
- "Press <?> for additional information about this option."),
-inputbox_instructions_int[] = N_(
- "Please enter a decimal value. "
- "Fractions will not be accepted. "
- "Use the <TAB> key to move from the input field to the buttons below it."),
-inputbox_instructions_hex[] = N_(
- "Please enter a hexadecimal value. "
- "Use the <TAB> key to move from the input field to the buttons below it."),
-inputbox_instructions_string[] = N_(
- "Please enter a string value. "
- "Use the <TAB> key to move from the input field to the buttons below it."),
-setmod_text[] = N_(
- "This feature depends on another which has been configured as a module.\n"
- "As a result, this feature will be built as a module."),
-load_config_text[] = N_(
- "Enter the name of the configuration file you wish to load. "
- "Accept the name shown to restore the configuration you "
- "last retrieved. Leave blank to abort."),
-load_config_help[] = N_(
- "\n"
- "For various reasons, one may wish to keep several different\n"
- "configurations available on a single machine.\n"
- "\n"
- "If you have saved a previous configuration in a file other than the\n"
- "default one, entering its name here will allow you to modify that\n"
- "configuration.\n"
- "\n"
- "If you are uncertain, then you have probably never used alternate\n"
- "configuration files. You should therefore leave this blank to abort.\n"),
-save_config_text[] = N_(
- "Enter a filename to which this configuration should be saved "
- "as an alternate. Leave blank to abort."),
-save_config_help[] = N_(
- "\n"
- "For various reasons, one may wish to keep different configurations\n"
- "available on a single machine.\n"
- "\n"
- "Entering a file name here will allow you to later retrieve, modify\n"
- "and use the current configuration as an alternate to whatever\n"
- "configuration options you have selected at that time.\n"
- "\n"
- "If you are uncertain what all this means then you should probably\n"
- "leave this blank.\n"),
-search_help[] = N_(
- "\n"
- "Search for symbols and display their relations.\n"
- "Regular expressions are allowed.\n"
- "Example: search for \"^FOO\"\n"
- "Result:\n"
- "-----------------------------------------------------------------\n"
- "Symbol: FOO [=m]\n"
- "Type : tristate\n"
- "Prompt: Foo bus is used to drive the bar HW\n"
- " Location:\n"
- " -> Bus options (PCI, PCMCIA, EISA, ISA)\n"
- " -> PCI support (PCI [=y])\n"
- "(1) -> PCI access mode (<choice> [=y])\n"
- " Defined at drivers/pci/Kconfig:47\n"
- " Depends on: X86_LOCAL_APIC && X86_IO_APIC || IA64\n"
- " Selects: LIBCRC32\n"
- " Selected by: BAR [=n]\n"
- "-----------------------------------------------------------------\n"
- "o The line 'Type:' shows the type of the configuration option for\n"
- " this symbol (boolean, tristate, string, ...)\n"
- "o The line 'Prompt:' shows the text used in the menu structure for\n"
- " this symbol\n"
- "o The 'Defined at' line tells at what file / line number the symbol\n"
- " is defined\n"
- "o The 'Depends on:' line tells what symbols need to be defined for\n"
- " this symbol to be visible in the menu (selectable)\n"
- "o The 'Location:' lines tells where in the menu structure this symbol\n"
- " is located\n"
- " A location followed by a [=y] indicates that this is a\n"
- " selectable menu item - and the current value is displayed inside\n"
- " brackets.\n"
- " Press the key in the (#) prefix to jump directly to that\n"
- " location. You will be returned to the current search results\n"
- " after exiting this new menu.\n"
- "o The 'Selects:' line tells what symbols will be automatically\n"
- " selected if this symbol is selected (y or m)\n"
- "o The 'Selected by' line tells what symbol has selected this symbol\n"
- "\n"
- "Only relevant lines are shown.\n"
- "\n\n"
- "Search examples:\n"
- "Examples: USB => find all symbols containing USB\n"
- " ^USB => find all symbols starting with USB\n"
- " USB$ => find all symbols ending with USB\n"
- "\n");
-
-static int indent;
-static struct menu *current_menu;
-static int child_count;
-static int single_menu_mode;
-static int show_all_options;
-static int save_and_exit;
-static int silent;
-
-static void conf(struct menu *menu, struct menu *active_menu);
-static void conf_choice(struct menu *menu);
-static void conf_string(struct menu *menu);
-static void conf_load(void);
-static void conf_save(void);
-static int show_textbox_ext(const char *title, char *text, int r, int c,
- int *keys, int *vscroll, int *hscroll,
- update_text_fn update_text, void *data);
-static void show_textbox(const char *title, const char *text, int r, int c);
-static void show_helptext(const char *title, const char *text);
-static void show_help(struct menu *menu);
-
-static char filename[PATH_MAX+1];
-static void set_config_filename(const char *config_filename)
-{
- static char menu_backtitle[PATH_MAX+128];
- int size;
-
- size = snprintf(menu_backtitle, sizeof(menu_backtitle),
- "%s - %s", config_filename, rootmenu.prompt->text);
- if (size >= sizeof(menu_backtitle))
- menu_backtitle[sizeof(menu_backtitle)-1] = '\0';
- set_dialog_backtitle(menu_backtitle);
-
- size = snprintf(filename, sizeof(filename), "%s", config_filename);
- if (size >= sizeof(filename))
- filename[sizeof(filename)-1] = '\0';
-}
-
-struct subtitle_part {
- struct list_head entries;
- const char *text;
-};
-static LIST_HEAD(trail);
-
-static struct subtitle_list *subtitles;
-static void set_subtitle(void)
-{
- struct subtitle_part *sp;
- struct subtitle_list *pos, *tmp;
-
- for (pos = subtitles; pos != NULL; pos = tmp) {
- tmp = pos->next;
- free(pos);
- }
-
- subtitles = NULL;
- list_for_each_entry(sp, &trail, entries) {
- if (sp->text) {
- if (pos) {
- pos->next = xcalloc(1, sizeof(*pos));
- pos = pos->next;
- } else {
- subtitles = pos = xcalloc(1, sizeof(*pos));
- }
- pos->text = sp->text;
- }
- }
-
- set_dialog_subtitles(subtitles);
-}
-
-static void reset_subtitle(void)
-{
- struct subtitle_list *pos, *tmp;
-
- for (pos = subtitles; pos != NULL; pos = tmp) {
- tmp = pos->next;
- free(pos);
- }
- subtitles = NULL;
- set_dialog_subtitles(subtitles);
-}
-
-struct search_data {
- struct list_head *head;
- struct menu **targets;
- int *keys;
-};
-
-static void update_text(char *buf, size_t start, size_t end, void *_data)
-{
- struct search_data *data = _data;
- struct jump_key *pos;
- int k = 0;
-
- list_for_each_entry(pos, data->head, entries) {
- if (pos->offset >= start && pos->offset < end) {
- char header[4];
-
- if (k < JUMP_NB) {
- int key = '0' + (pos->index % JUMP_NB) + 1;
-
- sprintf(header, "(%c)", key);
- data->keys[k] = key;
- data->targets[k] = pos->target;
- k++;
- } else {
- sprintf(header, " ");
- }
-
- memcpy(buf + pos->offset, header, sizeof(header) - 1);
- }
- }
- data->keys[k] = 0;
-}
-
-static void search_conf(void)
-{
- struct symbol **sym_arr;
- struct gstr res;
- struct gstr title;
- char *dialog_input;
- int dres, vscroll = 0, hscroll = 0;
- bool again;
- struct gstr sttext;
- struct subtitle_part stpart;
-
- title = str_new();
- str_printf( &title, _("Enter (sub)string or regexp to search for "
- "(with or without \"%s\")"), CONFIG_);
-
-again:
- dialog_clear();
- dres = dialog_inputbox(_("Search Configuration Parameter"),
- str_get(&title),
- 10, 75, "");
- switch (dres) {
- case 0:
- break;
- case 1:
- show_helptext(_("Search Configuration"), search_help);
- goto again;
- default:
- str_free(&title);
- return;
- }
-
- /* strip the prefix if necessary */
- dialog_input = dialog_input_result;
- if (strncasecmp(dialog_input_result, CONFIG_, strlen(CONFIG_)) == 0)
- dialog_input += strlen(CONFIG_);
-
- sttext = str_new();
- str_printf(&sttext, "Search (%s)", dialog_input_result);
- stpart.text = str_get(&sttext);
- list_add_tail(&stpart.entries, &trail);
-
- sym_arr = sym_re_search(dialog_input);
- do {
- LIST_HEAD(head);
- struct menu *targets[JUMP_NB];
- int keys[JUMP_NB + 1], i;
- struct search_data data = {
- .head = &head,
- .targets = targets,
- .keys = keys,
- };
- struct jump_key *pos, *tmp;
-
- res = get_relations_str(sym_arr, &head);
- set_subtitle();
- dres = show_textbox_ext(_("Search Results"), (char *)
- str_get(&res), 0, 0, keys, &vscroll,
- &hscroll, &update_text, (void *)
- &data);
- again = false;
- for (i = 0; i < JUMP_NB && keys[i]; i++)
- if (dres == keys[i]) {
- conf(targets[i]->parent, targets[i]);
- again = true;
- }
- str_free(&res);
- list_for_each_entry_safe(pos, tmp, &head, entries)
- free(pos);
- } while (again);
- free(sym_arr);
- str_free(&title);
- list_del(trail.prev);
- str_free(&sttext);
-}
-
-static void build_conf(struct menu *menu)
-{
- struct symbol *sym;
- struct property *prop;
- struct menu *child;
- int type, tmp, doint = 2;
- tristate val;
- char ch;
- bool visible;
-
- /*
- * note: menu_is_visible() has side effect that it will
- * recalc the value of the symbol.
- */
- visible = menu_is_visible(menu);
- if (show_all_options && !menu_has_prompt(menu))
- return;
- else if (!show_all_options && !visible)
- return;
-
- sym = menu->sym;
- prop = menu->prompt;
- if (!sym) {
- if (prop && menu != current_menu) {
- const char *prompt = menu_get_prompt(menu);
- switch (prop->type) {
- case P_MENU:
- child_count++;
- prompt = _(prompt);
- if (single_menu_mode) {
- item_make("%s%*c%s",
- menu->data ? "-->" : "++>",
- indent + 1, ' ', prompt);
- } else
- item_make(" %*c%s %s",
- indent + 1, ' ', prompt,
- menu_is_empty(menu) ? "----" : "--->");
- item_set_tag('m');
- item_set_data(menu);
- if (single_menu_mode && menu->data)
- goto conf_childs;
- return;
- case P_COMMENT:
- if (prompt) {
- child_count++;
- item_make(" %*c*** %s ***", indent + 1, ' ', _(prompt));
- item_set_tag(':');
- item_set_data(menu);
- }
- break;
- default:
- if (prompt) {
- child_count++;
- item_make("---%*c%s", indent + 1, ' ', _(prompt));
- item_set_tag(':');
- item_set_data(menu);
- }
- }
- } else
- doint = 0;
- goto conf_childs;
- }
-
- type = sym_get_type(sym);
- if (sym_is_choice(sym)) {
- struct symbol *def_sym = sym_get_choice_value(sym);
- struct menu *def_menu = NULL;
-
- child_count++;
- for (child = menu->list; child; child = child->next) {
- if (menu_is_visible(child) && child->sym == def_sym)
- def_menu = child;
- }
-
- val = sym_get_tristate_value(sym);
- if (sym_is_changable(sym)) {
- switch (type) {
- case S_BOOLEAN:
- item_make("[%c]", val == no ? ' ' : '*');
- break;
- case S_TRISTATE:
- switch (val) {
- case yes: ch = '*'; break;
- case mod: ch = 'M'; break;
- default: ch = ' '; break;
- }
- item_make("<%c>", ch);
- break;
- }
- item_set_tag('t');
- item_set_data(menu);
- } else {
- item_make(" ");
- item_set_tag(def_menu ? 't' : ':');
- item_set_data(menu);
- }
-
- item_add_str("%*c%s", indent + 1, ' ', _(menu_get_prompt(menu)));
- if (val == yes) {
- if (def_menu) {
- item_add_str(" (%s)", _(menu_get_prompt(def_menu)));
- item_add_str(" --->");
- if (def_menu->list) {
- indent += 2;
- build_conf(def_menu);
- indent -= 2;
- }
- }
- return;
- }
- } else {
- if (menu == current_menu) {
- item_make("---%*c%s", indent + 1, ' ', _(menu_get_prompt(menu)));
- item_set_tag(':');
- item_set_data(menu);
- goto conf_childs;
- }
- child_count++;
- val = sym_get_tristate_value(sym);
- if (sym_is_choice_value(sym) && val == yes) {
- item_make(" ");
- item_set_tag(':');
- item_set_data(menu);
- } else {
- switch (type) {
- case S_BOOLEAN:
- if (sym_is_changable(sym))
- item_make("[%c]", val == no ? ' ' : '*');
- else
- item_make("-%c-", val == no ? ' ' : '*');
- item_set_tag('t');
- item_set_data(menu);
- break;
- case S_TRISTATE:
- switch (val) {
- case yes: ch = '*'; break;
- case mod: ch = 'M'; break;
- default: ch = ' '; break;
- }
- if (sym_is_changable(sym)) {
- if (sym->rev_dep.tri == mod)
- item_make("{%c}", ch);
- else
- item_make("<%c>", ch);
- } else
- item_make("-%c-", ch);
- item_set_tag('t');
- item_set_data(menu);
- break;
- default:
- tmp = 2 + strlen(sym_get_string_value(sym)); /* () = 2 */
- item_make("(%s)", sym_get_string_value(sym));
- tmp = indent - tmp + 4;
- if (tmp < 0)
- tmp = 0;
- item_add_str("%*c%s%s", tmp, ' ', _(menu_get_prompt(menu)),
- (sym_has_value(sym) || !sym_is_changable(sym)) ?
- "" : _(" (NEW)"));
- item_set_tag('s');
- item_set_data(menu);
- goto conf_childs;
- }
- }
- item_add_str("%*c%s%s", indent + 1, ' ', _(menu_get_prompt(menu)),
- (sym_has_value(sym) || !sym_is_changable(sym)) ?
- "" : _(" (NEW)"));
- if (menu->prompt->type == P_MENU) {
- item_add_str(" %s", menu_is_empty(menu) ? "----" : "--->");
- return;
- }
- }
-
-conf_childs:
- indent += doint;
- for (child = menu->list; child; child = child->next)
- build_conf(child);
- indent -= doint;
-}
-
-static void conf(struct menu *menu, struct menu *active_menu)
-{
- struct menu *submenu;
- const char *prompt = menu_get_prompt(menu);
- struct subtitle_part stpart;
- struct symbol *sym;
- int res;
- int s_scroll = 0;
-
- if (menu != &rootmenu)
- stpart.text = menu_get_prompt(menu);
- else
- stpart.text = NULL;
- list_add_tail(&stpart.entries, &trail);
-
- while (1) {
- item_reset();
- current_menu = menu;
- build_conf(menu);
- if (!child_count)
- break;
- set_subtitle();
- dialog_clear();
- res = dialog_menu(prompt ? _(prompt) : _("Main Menu"),
- _(menu_instructions),
- active_menu, &s_scroll);
- if (res == 1 || res == KEY_ESC || res == -ERRDISPLAYTOOSMALL)
- break;
- if (item_count() != 0) {
- if (!item_activate_selected())
- continue;
- if (!item_tag())
- continue;
- }
- submenu = item_data();
- active_menu = item_data();
- if (submenu)
- sym = submenu->sym;
- else
- sym = NULL;
-
- switch (res) {
- case 0:
- switch (item_tag()) {
- case 'm':
- if (single_menu_mode)
- submenu->data = (void *) (long) !submenu->data;
- else
- conf(submenu, NULL);
- break;
- case 't':
- if (sym_is_choice(sym) && sym_get_tristate_value(sym) == yes)
- conf_choice(submenu);
- else if (submenu->prompt->type == P_MENU)
- conf(submenu, NULL);
- break;
- case 's':
- conf_string(submenu);
- break;
- }
- break;
- case 2:
- if (sym)
- show_help(submenu);
- else {
- reset_subtitle();
- show_helptext(_("README"), _(mconf_readme));
- }
- break;
- case 3:
- reset_subtitle();
- conf_save();
- break;
- case 4:
- reset_subtitle();
- conf_load();
- break;
- case 5:
- if (item_is_tag('t')) {
- if (sym_set_tristate_value(sym, yes))
- break;
- if (sym_set_tristate_value(sym, mod))
- show_textbox(NULL, setmod_text, 6, 74);
- }
- break;
- case 6:
- if (item_is_tag('t'))
- sym_set_tristate_value(sym, no);
- break;
- case 7:
- if (item_is_tag('t'))
- sym_set_tristate_value(sym, mod);
- break;
- case 8:
- if (item_is_tag('t'))
- sym_toggle_tristate_value(sym);
- else if (item_is_tag('m'))
- conf(submenu, NULL);
- break;
- case 9:
- search_conf();
- break;
- case 10:
- show_all_options = !show_all_options;
- break;
- }
- }
-
- list_del(trail.prev);
-}
-
-static int show_textbox_ext(const char *title, char *text, int r, int c, int
- *keys, int *vscroll, int *hscroll, update_text_fn
- update_text, void *data)
-{
- dialog_clear();
- return dialog_textbox(title, text, r, c, keys, vscroll, hscroll,
- update_text, data);
-}
-
-static void show_textbox(const char *title, const char *text, int r, int c)
-{
- show_textbox_ext(title, (char *) text, r, c, (int []) {0}, NULL, NULL,
- NULL, NULL);
-}
-
-static void show_helptext(const char *title, const char *text)
-{
- show_textbox(title, text, 0, 0);
-}
-
-static void conf_message_callback(const char *fmt, va_list ap)
-{
- char buf[PATH_MAX+1];
-
- vsnprintf(buf, sizeof(buf), fmt, ap);
- if (save_and_exit) {
- if (!silent)
- printf("%s", buf);
- } else {
- show_textbox(NULL, buf, 6, 60);
- }
-}
-
-static void show_help(struct menu *menu)
-{
- struct gstr help = str_new();
-
- help.max_width = getmaxx(stdscr) - 10;
- menu_get_ext_help(menu, &help);
-
- show_helptext(_(menu_get_prompt(menu)), str_get(&help));
- str_free(&help);
-}
-
-static void conf_choice(struct menu *menu)
-{
- const char *prompt = _(menu_get_prompt(menu));
- struct menu *child;
- struct symbol *active;
-
- active = sym_get_choice_value(menu->sym);
- while (1) {
- int res;
- int selected;
- item_reset();
-
- current_menu = menu;
- for (child = menu->list; child; child = child->next) {
- if (!menu_is_visible(child))
- continue;
- if (child->sym)
- item_make("%s", _(menu_get_prompt(child)));
- else {
- item_make("*** %s ***", _(menu_get_prompt(child)));
- item_set_tag(':');
- }
- item_set_data(child);
- if (child->sym == active)
- item_set_selected(1);
- if (child->sym == sym_get_choice_value(menu->sym))
- item_set_tag('X');
- }
- dialog_clear();
- res = dialog_checklist(prompt ? _(prompt) : _("Main Menu"),
- _(radiolist_instructions),
- MENUBOX_HEIGTH_MIN,
- MENUBOX_WIDTH_MIN,
- CHECKLIST_HEIGTH_MIN);
- selected = item_activate_selected();
- switch (res) {
- case 0:
- if (selected) {
- child = item_data();
- if (!child->sym)
- break;
-
- sym_set_tristate_value(child->sym, yes);
- }
- return;
- case 1:
- if (selected) {
- child = item_data();
- show_help(child);
- active = child->sym;
- } else
- show_help(menu);
- break;
- case KEY_ESC:
- return;
- case -ERRDISPLAYTOOSMALL:
- return;
- }
- }
-}
-
-static void conf_string(struct menu *menu)
-{
- const char *prompt = menu_get_prompt(menu);
-
- while (1) {
- int res;
- const char *heading;
-
- switch (sym_get_type(menu->sym)) {
- case S_INT:
- heading = _(inputbox_instructions_int);
- break;
- case S_HEX:
- heading = _(inputbox_instructions_hex);
- break;
- case S_STRING:
- heading = _(inputbox_instructions_string);
- break;
- default:
- heading = _("Internal mconf error!");
- }
- dialog_clear();
- res = dialog_inputbox(prompt ? _(prompt) : _("Main Menu"),
- heading, 10, 75,
- sym_get_string_value(menu->sym));
- switch (res) {
- case 0:
- if (sym_set_string_value(menu->sym, dialog_input_result))
- return;
- show_textbox(NULL, _("You have made an invalid entry."), 5, 43);
- break;
- case 1:
- show_help(menu);
- break;
- case KEY_ESC:
- return;
- }
- }
-}
-
-static void conf_load(void)
-{
-
- while (1) {
- int res;
- dialog_clear();
- res = dialog_inputbox(NULL, load_config_text,
- 11, 55, filename);
- switch(res) {
- case 0:
- if (!dialog_input_result[0])
- return;
- if (!conf_read(dialog_input_result)) {
- set_config_filename(dialog_input_result);
- sym_set_change_count(1);
- return;
- }
- show_textbox(NULL, _("File does not exist!"), 5, 38);
- break;
- case 1:
- show_helptext(_("Load Alternate Configuration"), load_config_help);
- break;
- case KEY_ESC:
- return;
- }
- }
-}
-
-static void conf_save(void)
-{
- while (1) {
- int res;
- dialog_clear();
- res = dialog_inputbox(NULL, save_config_text,
- 11, 55, filename);
- switch(res) {
- case 0:
- if (!dialog_input_result[0])
- return;
- if (!conf_write(dialog_input_result)) {
- set_config_filename(dialog_input_result);
- return;
- }
- show_textbox(NULL, _("Can't create file! Probably a nonexistent directory."), 5, 60);
- break;
- case 1:
- show_helptext(_("Save Alternate Configuration"), save_config_help);
- break;
- case KEY_ESC:
- return;
- }
- }
-}
-
-static int handle_exit(void)
-{
- int res;
-
- save_and_exit = 1;
- reset_subtitle();
- dialog_clear();
- if (conf_get_changed())
- res = dialog_yesno(NULL,
- _("Do you wish to save your new configuration?\n"
- "(Press <ESC><ESC> to continue kernel configuration.)"),
- 6, 60);
- else
- res = -1;
-
- end_dialog(saved_x, saved_y);
-
- switch (res) {
- case 0:
- if (conf_write(filename)) {
- fprintf(stderr, _("\n\n"
- "Error while writing of the configuration.\n"
- "Your configuration changes were NOT saved."
- "\n\n"));
- return 1;
- }
- /* fall through */
- case -1:
- if (!silent)
- printf(_("\n\n"
- "*** End of the configuration.\n"
- "*** Execute 'make' to start the build or try 'make help'."
- "\n\n"));
- res = 0;
- break;
- default:
- if (!silent)
- fprintf(stderr, _("\n\n"
- "Your configuration changes were NOT saved."
- "\n\n"));
- if (res != KEY_ESC)
- res = 0;
- }
-
- return res;
-}
-
-static void sig_handler(int signo)
-{
- exit(handle_exit());
-}
-
-int main(int ac, char **av)
-{
- char *mode;
- int res;
-
- setlocale(LC_ALL, "");
- bindtextdomain(PACKAGE, LOCALEDIR);
- textdomain(PACKAGE);
-
- signal(SIGINT, sig_handler);
-
- if (ac > 1 && strcmp(av[1], "-s") == 0) {
- silent = 1;
- /* Silence conf_read() until the real callback is set up */
- conf_set_message_callback(NULL);
- av++;
- }
- conf_parse(av[1]);
- conf_read(NULL);
-
- mode = getenv("MENUCONFIG_MODE");
- if (mode) {
- if (!strcasecmp(mode, "single_menu"))
- single_menu_mode = 1;
- }
-
- if (init_dialog(NULL)) {
- fprintf(stderr, N_("Your display is too small to run Menuconfig!\n"));
- fprintf(stderr, N_("It must be at least 19 lines by 80 columns.\n"));
- return 1;
- }
-
- set_config_filename(conf_get_configname());
- conf_set_message_callback(conf_message_callback);
- do {
- conf(&rootmenu, NULL);
- res = handle_exit();
- } while (res == KEY_ESC);
-
- return res;
-}
+++ /dev/null
-/*
- * Copyright (C) 2002 Roman Zippel <zippel@linux-m68k.org>
- * Released under the terms of the GNU GPL v2.0.
- */
-
-#include <ctype.h>
-#include <stdarg.h>
-#include <stdlib.h>
-#include <string.h>
-
-#include "lkc.h"
-
-static const char nohelp_text[] = "There is no help available for this option.";
-
-struct menu rootmenu;
-static struct menu **last_entry_ptr;
-
-struct file *file_list;
-struct file *current_file;
-
-void menu_warn(struct menu *menu, const char *fmt, ...)
-{
- va_list ap;
- va_start(ap, fmt);
- fprintf(stderr, "%s:%d:warning: ", menu->file->name, menu->lineno);
- vfprintf(stderr, fmt, ap);
- fprintf(stderr, "\n");
- va_end(ap);
-}
-
-static void prop_warn(struct property *prop, const char *fmt, ...)
-{
- va_list ap;
- va_start(ap, fmt);
- fprintf(stderr, "%s:%d:warning: ", prop->file->name, prop->lineno);
- vfprintf(stderr, fmt, ap);
- fprintf(stderr, "\n");
- va_end(ap);
-}
-
-void _menu_init(void)
-{
- current_entry = current_menu = &rootmenu;
- last_entry_ptr = &rootmenu.list;
-}
-
-void menu_add_entry(struct symbol *sym)
-{
- struct menu *menu;
-
- menu = xmalloc(sizeof(*menu));
- memset(menu, 0, sizeof(*menu));
- menu->sym = sym;
- menu->parent = current_menu;
- menu->file = current_file;
- menu->lineno = zconf_lineno();
-
- *last_entry_ptr = menu;
- last_entry_ptr = &menu->next;
- current_entry = menu;
- if (sym)
- menu_add_symbol(P_SYMBOL, sym, NULL);
-}
-
-void menu_end_entry(void)
-{
-}
-
-struct menu *menu_add_menu(void)
-{
- menu_end_entry();
- last_entry_ptr = ¤t_entry->list;
- return current_menu = current_entry;
-}
-
-void menu_end_menu(void)
-{
- last_entry_ptr = ¤t_menu->next;
- current_menu = current_menu->parent;
-}
-
-static struct expr *menu_check_dep(struct expr *e)
-{
- if (!e)
- return e;
-
- switch (e->type) {
- case E_NOT:
- e->left.expr = menu_check_dep(e->left.expr);
- break;
- case E_OR:
- case E_AND:
- e->left.expr = menu_check_dep(e->left.expr);
- e->right.expr = menu_check_dep(e->right.expr);
- break;
- case E_SYMBOL:
- /* change 'm' into 'm' && MODULES */
- if (e->left.sym == &symbol_mod)
- return expr_alloc_and(e, expr_alloc_symbol(modules_sym));
- break;
- default:
- break;
- }
- return e;
-}
-
-void menu_add_dep(struct expr *dep)
-{
- current_entry->dep = expr_alloc_and(current_entry->dep, menu_check_dep(dep));
-}
-
-void menu_set_type(int type)
-{
- struct symbol *sym = current_entry->sym;
-
- if (sym->type == type)
- return;
- if (sym->type == S_UNKNOWN) {
- sym->type = type;
- return;
- }
- menu_warn(current_entry,
- "ignoring type redefinition of '%s' from '%s' to '%s'",
- sym->name ? sym->name : "<choice>",
- sym_type_name(sym->type), sym_type_name(type));
-}
-
-static struct property *menu_add_prop(enum prop_type type, char *prompt, struct expr *expr, struct expr *dep)
-{
- struct property *prop = prop_alloc(type, current_entry->sym);
-
- prop->menu = current_entry;
- prop->expr = expr;
- prop->visible.expr = menu_check_dep(dep);
-
- if (prompt) {
- if (isspace(*prompt)) {
- prop_warn(prop, "leading whitespace ignored");
- while (isspace(*prompt))
- prompt++;
- }
- if (current_entry->prompt && current_entry != &rootmenu)
- prop_warn(prop, "prompt redefined");
-
- /* Apply all upper menus' visibilities to actual prompts. */
- if(type == P_PROMPT) {
- struct menu *menu = current_entry;
-
- while ((menu = menu->parent) != NULL) {
- struct expr *dup_expr;
-
- if (!menu->visibility)
- continue;
- /*
- * Do not add a reference to the
- * menu's visibility expression but
- * use a copy of it. Otherwise the
- * expression reduction functions
- * will modify expressions that have
- * multiple references which can
- * cause unwanted side effects.
- */
- dup_expr = expr_copy(menu->visibility);
-
- prop->visible.expr
- = expr_alloc_and(prop->visible.expr,
- dup_expr);
- }
- }
-
- current_entry->prompt = prop;
- }
- prop->text = prompt;
-
- return prop;
-}
-
-struct property *menu_add_prompt(enum prop_type type, char *prompt, struct expr *dep)
-{
- return menu_add_prop(type, prompt, NULL, dep);
-}
-
-void menu_add_visibility(struct expr *expr)
-{
- current_entry->visibility = expr_alloc_and(current_entry->visibility,
- expr);
-}
-
-void menu_add_expr(enum prop_type type, struct expr *expr, struct expr *dep)
-{
- menu_add_prop(type, NULL, expr, dep);
-}
-
-void menu_add_symbol(enum prop_type type, struct symbol *sym, struct expr *dep)
-{
- menu_add_prop(type, NULL, expr_alloc_symbol(sym), dep);
-}
-
-void menu_add_option(int token, char *arg)
-{
- switch (token) {
- case T_OPT_MODULES:
- if (modules_sym)
- zconf_error("symbol '%s' redefines option 'modules'"
- " already defined by symbol '%s'",
- current_entry->sym->name,
- modules_sym->name
- );
- modules_sym = current_entry->sym;
- break;
- case T_OPT_DEFCONFIG_LIST:
- if (!sym_defconfig_list)
- sym_defconfig_list = current_entry->sym;
- else if (sym_defconfig_list != current_entry->sym)
- zconf_error("trying to redefine defconfig symbol");
- break;
- case T_OPT_ENV:
- prop_add_env(arg);
- break;
- case T_OPT_ALLNOCONFIG_Y:
- current_entry->sym->flags |= SYMBOL_ALLNOCONFIG_Y;
- break;
- }
-}
-
-static int menu_validate_number(struct symbol *sym, struct symbol *sym2)
-{
- return sym2->type == S_INT || sym2->type == S_HEX ||
- (sym2->type == S_UNKNOWN && sym_string_valid(sym, sym2->name));
-}
-
-static void sym_check_prop(struct symbol *sym)
-{
- struct property *prop;
- struct symbol *sym2;
- for (prop = sym->prop; prop; prop = prop->next) {
- switch (prop->type) {
- case P_DEFAULT:
- if ((sym->type == S_STRING || sym->type == S_INT || sym->type == S_HEX) &&
- prop->expr->type != E_SYMBOL)
- prop_warn(prop,
- "default for config symbol '%s'"
- " must be a single symbol", sym->name);
- if (prop->expr->type != E_SYMBOL)
- break;
- sym2 = prop_get_symbol(prop);
- if (sym->type == S_HEX || sym->type == S_INT) {
- if (!menu_validate_number(sym, sym2))
- prop_warn(prop,
- "'%s': number is invalid",
- sym->name);
- }
- break;
- case P_SELECT:
- sym2 = prop_get_symbol(prop);
- if (sym->type != S_BOOLEAN && sym->type != S_TRISTATE)
- prop_warn(prop,
- "config symbol '%s' uses select, but is "
- "not boolean or tristate", sym->name);
- else if (sym2->type != S_UNKNOWN &&
- sym2->type != S_BOOLEAN &&
- sym2->type != S_TRISTATE)
- prop_warn(prop,
- "'%s' has wrong type. 'select' only "
- "accept arguments of boolean and "
- "tristate type", sym2->name);
- break;
- case P_RANGE:
- if (sym->type != S_INT && sym->type != S_HEX)
- prop_warn(prop, "range is only allowed "
- "for int or hex symbols");
- if (!menu_validate_number(sym, prop->expr->left.sym) ||
- !menu_validate_number(sym, prop->expr->right.sym))
- prop_warn(prop, "range is invalid");
- break;
- default:
- ;
- }
- }
-}
-
-void menu_finalize(struct menu *parent)
-{
- struct menu *menu, *last_menu;
- struct symbol *sym;
- struct property *prop;
- struct expr *parentdep, *basedep, *dep, *dep2, **ep;
-
- sym = parent->sym;
- if (parent->list) {
- if (sym && sym_is_choice(sym)) {
- if (sym->type == S_UNKNOWN) {
- /* find the first choice value to find out choice type */
- current_entry = parent;
- for (menu = parent->list; menu; menu = menu->next) {
- if (menu->sym && menu->sym->type != S_UNKNOWN) {
- menu_set_type(menu->sym->type);
- break;
- }
- }
- }
- /* set the type of the remaining choice values */
- for (menu = parent->list; menu; menu = menu->next) {
- current_entry = menu;
- if (menu->sym && menu->sym->type == S_UNKNOWN)
- menu_set_type(sym->type);
- }
- parentdep = expr_alloc_symbol(sym);
- } else if (parent->prompt)
- parentdep = parent->prompt->visible.expr;
- else
- parentdep = parent->dep;
-
- for (menu = parent->list; menu; menu = menu->next) {
- basedep = expr_transform(menu->dep);
- basedep = expr_alloc_and(expr_copy(parentdep), basedep);
- basedep = expr_eliminate_dups(basedep);
- menu->dep = basedep;
- if (menu->sym)
- prop = menu->sym->prop;
- else
- prop = menu->prompt;
- for (; prop; prop = prop->next) {
- if (prop->menu != menu)
- continue;
- dep = expr_transform(prop->visible.expr);
- dep = expr_alloc_and(expr_copy(basedep), dep);
- dep = expr_eliminate_dups(dep);
- if (menu->sym && menu->sym->type != S_TRISTATE)
- dep = expr_trans_bool(dep);
- prop->visible.expr = dep;
- if (prop->type == P_SELECT) {
- struct symbol *es = prop_get_symbol(prop);
- es->rev_dep.expr = expr_alloc_or(es->rev_dep.expr,
- expr_alloc_and(expr_alloc_symbol(menu->sym), expr_copy(dep)));
- }
- }
- }
- for (menu = parent->list; menu; menu = menu->next)
- menu_finalize(menu);
- } else if (sym) {
- basedep = parent->prompt ? parent->prompt->visible.expr : NULL;
- basedep = expr_trans_compare(basedep, E_UNEQUAL, &symbol_no);
- basedep = expr_eliminate_dups(expr_transform(basedep));
- last_menu = NULL;
- for (menu = parent->next; menu; menu = menu->next) {
- dep = menu->prompt ? menu->prompt->visible.expr : menu->dep;
- if (!expr_contains_symbol(dep, sym))
- break;
- if (expr_depends_symbol(dep, sym))
- goto next;
- dep = expr_trans_compare(dep, E_UNEQUAL, &symbol_no);
- dep = expr_eliminate_dups(expr_transform(dep));
- dep2 = expr_copy(basedep);
- expr_eliminate_eq(&dep, &dep2);
- expr_free(dep);
- if (!expr_is_yes(dep2)) {
- expr_free(dep2);
- break;
- }
- expr_free(dep2);
- next:
- menu_finalize(menu);
- menu->parent = parent;
- last_menu = menu;
- }
- if (last_menu) {
- parent->list = parent->next;
- parent->next = last_menu->next;
- last_menu->next = NULL;
- }
-
- sym->dir_dep.expr = expr_alloc_or(sym->dir_dep.expr, parent->dep);
- }
- for (menu = parent->list; menu; menu = menu->next) {
- if (sym && sym_is_choice(sym) &&
- menu->sym && !sym_is_choice_value(menu->sym)) {
- current_entry = menu;
- menu->sym->flags |= SYMBOL_CHOICEVAL;
- if (!menu->prompt)
- menu_warn(menu, "choice value must have a prompt");
- for (prop = menu->sym->prop; prop; prop = prop->next) {
- if (prop->type == P_DEFAULT)
- prop_warn(prop, "defaults for choice "
- "values not supported");
- if (prop->menu == menu)
- continue;
- if (prop->type == P_PROMPT &&
- prop->menu->parent->sym != sym)
- prop_warn(prop, "choice value used outside its choice group");
- }
- /* Non-tristate choice values of tristate choices must
- * depend on the choice being set to Y. The choice
- * values' dependencies were propagated to their
- * properties above, so the change here must be re-
- * propagated.
- */
- if (sym->type == S_TRISTATE && menu->sym->type != S_TRISTATE) {
- basedep = expr_alloc_comp(E_EQUAL, sym, &symbol_yes);
- menu->dep = expr_alloc_and(basedep, menu->dep);
- for (prop = menu->sym->prop; prop; prop = prop->next) {
- if (prop->menu != menu)
- continue;
- prop->visible.expr = expr_alloc_and(expr_copy(basedep),
- prop->visible.expr);
- }
- }
- menu_add_symbol(P_CHOICE, sym, NULL);
- prop = sym_get_choice_prop(sym);
- for (ep = &prop->expr; *ep; ep = &(*ep)->left.expr)
- ;
- *ep = expr_alloc_one(E_LIST, NULL);
- (*ep)->right.sym = menu->sym;
- }
- if (menu->list && (!menu->prompt || !menu->prompt->text)) {
- for (last_menu = menu->list; ; last_menu = last_menu->next) {
- last_menu->parent = parent;
- if (!last_menu->next)
- break;
- }
- last_menu->next = menu->next;
- menu->next = menu->list;
- menu->list = NULL;
- }
- }
-
- if (sym && !(sym->flags & SYMBOL_WARNED)) {
- if (sym->type == S_UNKNOWN)
- menu_warn(parent, "config symbol defined without type");
-
- if (sym_is_choice(sym) && !parent->prompt)
- menu_warn(parent, "choice must have a prompt");
-
- /* Check properties connected to this symbol */
- sym_check_prop(sym);
- sym->flags |= SYMBOL_WARNED;
- }
-
- if (sym && !sym_is_optional(sym) && parent->prompt) {
- sym->rev_dep.expr = expr_alloc_or(sym->rev_dep.expr,
- expr_alloc_and(parent->prompt->visible.expr,
- expr_alloc_symbol(&symbol_mod)));
- }
-}
-
-bool menu_has_prompt(struct menu *menu)
-{
- if (!menu->prompt)
- return false;
- return true;
-}
-
-/*
- * Determine if a menu is empty.
- * A menu is considered empty if it contains no or only
- * invisible entries.
- */
-bool menu_is_empty(struct menu *menu)
-{
- struct menu *child;
-
- for (child = menu->list; child; child = child->next) {
- if (menu_is_visible(child))
- return(false);
- }
- return(true);
-}
-
-bool menu_is_visible(struct menu *menu)
-{
- struct menu *child;
- struct symbol *sym;
- tristate visible;
-
- if (!menu->prompt)
- return false;
-
- if (menu->visibility) {
- if (expr_calc_value(menu->visibility) == no)
- return false;
- }
-
- sym = menu->sym;
- if (sym) {
- sym_calc_value(sym);
- visible = menu->prompt->visible.tri;
- } else
- visible = menu->prompt->visible.tri = expr_calc_value(menu->prompt->visible.expr);
-
- if (visible != no)
- return true;
-
- if (!sym || sym_get_tristate_value(menu->sym) == no)
- return false;
-
- for (child = menu->list; child; child = child->next) {
- if (menu_is_visible(child)) {
- if (sym)
- sym->flags |= SYMBOL_DEF_USER;
- return true;
- }
- }
-
- return false;
-}
-
-const char *menu_get_prompt(struct menu *menu)
-{
- if (menu->prompt)
- return menu->prompt->text;
- else if (menu->sym)
- return menu->sym->name;
- return NULL;
-}
-
-struct menu *menu_get_root_menu(struct menu *menu)
-{
- return &rootmenu;
-}
-
-struct menu *menu_get_parent_menu(struct menu *menu)
-{
- enum prop_type type;
-
- for (; menu != &rootmenu; menu = menu->parent) {
- type = menu->prompt ? menu->prompt->type : 0;
- if (type == P_MENU)
- break;
- }
- return menu;
-}
-
-bool menu_has_help(struct menu *menu)
-{
- return menu->help != NULL;
-}
-
-const char *menu_get_help(struct menu *menu)
-{
- if (menu->help)
- return menu->help;
- else
- return "";
-}
-
-static void get_prompt_str(struct gstr *r, struct property *prop,
- struct list_head *head)
-{
- int i, j;
- struct menu *submenu[8], *menu, *location = NULL;
- struct jump_key *jump = NULL;
-
- str_printf(r, _("Prompt: %s\n"), _(prop->text));
- menu = prop->menu->parent;
- for (i = 0; menu != &rootmenu && i < 8; menu = menu->parent) {
- bool accessible = menu_is_visible(menu);
-
- submenu[i++] = menu;
- if (location == NULL && accessible)
- location = menu;
- }
- if (head && location) {
- jump = xmalloc(sizeof(struct jump_key));
-
- if (menu_is_visible(prop->menu)) {
- /*
- * There is not enough room to put the hint at the
- * beginning of the "Prompt" line. Put the hint on the
- * last "Location" line even when it would belong on
- * the former.
- */
- jump->target = prop->menu;
- } else
- jump->target = location;
-
- if (list_empty(head))
- jump->index = 0;
- else
- jump->index = list_entry(head->prev, struct jump_key,
- entries)->index + 1;
-
- list_add_tail(&jump->entries, head);
- }
-
- if (i > 0) {
- str_printf(r, _(" Location:\n"));
- for (j = 4; --i >= 0; j += 2) {
- menu = submenu[i];
- if (jump && menu == location)
- jump->offset = strlen(r->s);
- str_printf(r, "%*c-> %s", j, ' ',
- _(menu_get_prompt(menu)));
- if (menu->sym) {
- str_printf(r, " (%s [=%s])", menu->sym->name ?
- menu->sym->name : _("<choice>"),
- sym_get_string_value(menu->sym));
- }
- str_append(r, "\n");
- }
- }
-}
-
-/*
- * get property of type P_SYMBOL
- */
-static struct property *get_symbol_prop(struct symbol *sym)
-{
- struct property *prop = NULL;
-
- for_all_properties(sym, prop, P_SYMBOL)
- break;
- return prop;
-}
-
-/*
- * head is optional and may be NULL
- */
-static void get_symbol_str(struct gstr *r, struct symbol *sym,
- struct list_head *head)
-{
- bool hit;
- struct property *prop;
-
- if (sym && sym->name) {
- str_printf(r, "Symbol: %s [=%s]\n", sym->name,
- sym_get_string_value(sym));
- str_printf(r, "Type : %s\n", sym_type_name(sym->type));
- if (sym->type == S_INT || sym->type == S_HEX) {
- prop = sym_get_range_prop(sym);
- if (prop) {
- str_printf(r, "Range : ");
- expr_gstr_print(prop->expr, r);
- str_append(r, "\n");
- }
- }
- }
- for_all_prompts(sym, prop)
- get_prompt_str(r, prop, head);
-
- prop = get_symbol_prop(sym);
- if (prop) {
- str_printf(r, _(" Defined at %s:%d\n"), prop->menu->file->name,
- prop->menu->lineno);
- if (!expr_is_yes(prop->visible.expr)) {
- str_append(r, _(" Depends on: "));
- expr_gstr_print(prop->visible.expr, r);
- str_append(r, "\n");
- }
- }
-
- hit = false;
- for_all_properties(sym, prop, P_SELECT) {
- if (!hit) {
- str_append(r, " Selects: ");
- hit = true;
- } else
- str_printf(r, " && ");
- expr_gstr_print(prop->expr, r);
- }
- if (hit)
- str_append(r, "\n");
- if (sym->rev_dep.expr) {
- str_append(r, _(" Selected by: "));
- expr_gstr_print(sym->rev_dep.expr, r);
- str_append(r, "\n");
- }
- str_append(r, "\n\n");
-}
-
-struct gstr get_relations_str(struct symbol **sym_arr, struct list_head *head)
-{
- struct symbol *sym;
- struct gstr res = str_new();
- int i;
-
- for (i = 0; sym_arr && (sym = sym_arr[i]); i++)
- get_symbol_str(&res, sym, head);
- if (!i)
- str_append(&res, _("No matches found.\n"));
- return res;
-}
-
-
-void menu_get_ext_help(struct menu *menu, struct gstr *help)
-{
- struct symbol *sym = menu->sym;
- const char *help_text = nohelp_text;
-
- if (menu_has_help(menu)) {
- if (sym->name)
- str_printf(help, "%s%s:\n\n", CONFIG_, sym->name);
- help_text = menu_get_help(menu);
- }
- str_printf(help, "%s\n", _(help_text));
- if (sym)
- get_symbol_str(help, sym, NULL);
-}
+++ /dev/null
-#!/bin/sh
-# merge_config.sh - Takes a list of config fragment values, and merges
-# them one by one. Provides warnings on overridden values, and specified
-# values that did not make it to the resulting .config file (due to missed
-# dependencies or config symbol removal).
-#
-# Portions reused from kconf_check and generate_cfg:
-# http://git.yoctoproject.org/cgit/cgit.cgi/yocto-kernel-tools/tree/tools/kconf_check
-# http://git.yoctoproject.org/cgit/cgit.cgi/yocto-kernel-tools/tree/tools/generate_cfg
-#
-# Copyright (c) 2009-2010 Wind River Systems, Inc.
-# Copyright 2011 Linaro
-#
-# This program is free software; you can redistribute it and/or modify
-# it under the terms of the GNU General Public License version 2 as
-# published by the Free Software Foundation.
-#
-# This program is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
-# See the GNU General Public License for more details.
-
-clean_up() {
- rm -f $TMP_FILE
- exit
-}
-trap clean_up HUP INT TERM
-
-usage() {
- echo "Usage: $0 [OPTIONS] [CONFIG [...]]"
- echo " -h display this help text"
- echo " -m only merge the fragments, do not execute the make command"
- echo " -n use allnoconfig instead of alldefconfig"
- echo " -r list redundant entries when merging fragments"
- echo " -O dir to put generated output files. Consider setting \$KCONFIG_CONFIG instead."
-}
-
-RUNMAKE=true
-ALLTARGET=alldefconfig
-WARNREDUN=false
-OUTPUT=.
-
-while true; do
- case $1 in
- "-n")
- ALLTARGET=allnoconfig
- shift
- continue
- ;;
- "-m")
- RUNMAKE=false
- shift
- continue
- ;;
- "-h")
- usage
- exit
- ;;
- "-r")
- WARNREDUN=true
- shift
- continue
- ;;
- "-O")
- if [ -d $2 ];then
- OUTPUT=$(echo $2 | sed 's/\/*$//')
- else
- echo "output directory $2 does not exist" 1>&2
- exit 1
- fi
- shift 2
- continue
- ;;
- *)
- break
- ;;
- esac
-done
-
-if [ "$#" -lt 1 ] ; then
- usage
- exit
-fi
-
-if [ -z "$KCONFIG_CONFIG" ]; then
- if [ "$OUTPUT" != . ]; then
- KCONFIG_CONFIG=$(readlink -m -- "$OUTPUT/.config")
- else
- KCONFIG_CONFIG=.config
- fi
-fi
-
-INITFILE=$1
-shift;
-
-if [ ! -r "$INITFILE" ]; then
- echo "The base file '$INITFILE' does not exist. Exit." >&2
- exit 1
-fi
-
-MERGE_LIST=$*
-SED_CONFIG_EXP="s/^\(# \)\{0,1\}\(CONFIG_[a-zA-Z0-9_]*\)[= ].*/\2/p"
-TMP_FILE=$(mktemp ./.tmp.config.XXXXXXXXXX)
-
-echo "Using $INITFILE as base"
-cat $INITFILE > $TMP_FILE
-
-# Merge files, printing warnings on overridden values
-for MERGE_FILE in $MERGE_LIST ; do
- echo "Merging $MERGE_FILE"
- if [ ! -r "$MERGE_FILE" ]; then
- echo "The merge file '$MERGE_FILE' does not exist. Exit." >&2
- exit 1
- fi
- CFG_LIST=$(sed -n "$SED_CONFIG_EXP" $MERGE_FILE)
-
- for CFG in $CFG_LIST ; do
- grep -q -w $CFG $TMP_FILE || continue
- PREV_VAL=$(grep -w $CFG $TMP_FILE)
- NEW_VAL=$(grep -w $CFG $MERGE_FILE)
- if [ "x$PREV_VAL" != "x$NEW_VAL" ] ; then
- echo Value of $CFG is redefined by fragment $MERGE_FILE:
- echo Previous value: $PREV_VAL
- echo New value: $NEW_VAL
- echo
- elif [ "$WARNREDUN" = "true" ]; then
- echo Value of $CFG is redundant by fragment $MERGE_FILE:
- fi
- sed -i "/$CFG[ =]/d" $TMP_FILE
- done
- cat $MERGE_FILE >> $TMP_FILE
-done
-
-if [ "$RUNMAKE" = "false" ]; then
- cp -T -- "$TMP_FILE" "$KCONFIG_CONFIG"
- echo "#"
- echo "# merged configuration written to $KCONFIG_CONFIG (needs make)"
- echo "#"
- clean_up
- exit
-fi
-
-# If we have an output dir, setup the O= argument, otherwise leave
-# it blank, since O=. will create an unnecessary ./source softlink
-OUTPUT_ARG=""
-if [ "$OUTPUT" != "." ] ; then
- OUTPUT_ARG="O=$OUTPUT"
-fi
-
-
-# Use the merged file as the starting point for:
-# alldefconfig: Fills in any missing symbols with Kconfig default
-# allnoconfig: Fills in any missing symbols with # CONFIG_* is not set
-make KCONFIG_ALLCONFIG=$TMP_FILE $OUTPUT_ARG $ALLTARGET
-
-
-# Check all specified config values took (might have missed-dependency issues)
-for CFG in $(sed -n "$SED_CONFIG_EXP" $TMP_FILE); do
-
- REQUESTED_VAL=$(grep -w -e "$CFG" $TMP_FILE)
- ACTUAL_VAL=$(grep -w -e "$CFG" "$KCONFIG_CONFIG")
- if [ "x$REQUESTED_VAL" != "x$ACTUAL_VAL" ] ; then
- echo "Value requested for $CFG not in final .config"
- echo "Requested value: $REQUESTED_VAL"
- echo "Actual value: $ACTUAL_VAL"
- echo ""
- fi
-done
-
-clean_up
+++ /dev/null
-/*
- * Copyright (C) 2008 Nir Tzachar <nir.tzachar@gmail.com?
- * Released under the terms of the GNU GPL v2.0.
- *
- * Derived from menuconfig.
- *
- */
-#define _GNU_SOURCE
-#include <string.h>
-#include <stdlib.h>
-
-#include "lkc.h"
-#include "nconf.h"
-#include <ctype.h>
-
-static const char nconf_global_help[] = N_(
-"Help windows\n"
-"------------\n"
-"o Global help: Unless in a data entry window, pressing <F1> will give \n"
-" you the global help window, which you are just reading.\n"
-"\n"
-"o A short version of the global help is available by pressing <F3>.\n"
-"\n"
-"o Local help: To get help related to the current menu entry, use any\n"
-" of <?> <h>, or if in a data entry window then press <F1>.\n"
-"\n"
-"\n"
-"Menu entries\n"
-"------------\n"
-"This interface lets you select features and parameters for the kernel\n"
-"build. Kernel features can either be built-in, modularized, or removed.\n"
-"Parameters must be entered as text or decimal or hexadecimal numbers.\n"
-"\n"
-"Menu entries beginning with following braces represent features that\n"
-" [ ] can be built in or removed\n"
-" < > can be built in, modularized or removed\n"
-" { } can be built in or modularized, are selected by another feature\n"
-" - - are selected by another feature\n"
-" XXX cannot be selected. Symbol Info <F2> tells you why.\n"
-"*, M or whitespace inside braces means to build in, build as a module\n"
-"or to exclude the feature respectively.\n"
-"\n"
-"To change any of these features, highlight it with the movement keys\n"
-"listed below and press <y> to build it in, <m> to make it a module or\n"
-"<n> to remove it. You may press the <Space> key to cycle through the\n"
-"available options.\n"
-"\n"
-"A trailing \"--->\" designates a submenu, a trailing \"----\" an\n"
-"empty submenu.\n"
-"\n"
-"Menu navigation keys\n"
-"----------------------------------------------------------------------\n"
-"Linewise up <Up>\n"
-"Linewise down <Down>\n"
-"Pagewise up <Page Up>\n"
-"Pagewise down <Page Down>\n"
-"First entry <Home>\n"
-"Last entry <End>\n"
-"Enter a submenu <Right> <Enter>\n"
-"Go back to parent menu <Left> <Esc> <F5>\n"
-"Close a help window <Enter> <Esc> <F5>\n"
-"Close entry window, apply <Enter>\n"
-"Close entry window, forget <Esc> <F5>\n"
-"Start incremental, case-insensitive search for STRING in menu entries,\n"
-" no regex support, STRING is displayed in upper left corner\n"
-" </>STRING\n"
-" Remove last character <Backspace>\n"
-" Jump to next hit <Down>\n"
-" Jump to previous hit <Up>\n"
-"Exit menu search mode </> <Esc>\n"
-"Search for configuration variables with or without leading CONFIG_\n"
-" <F8>RegExpr<Enter>\n"
-"Verbose search help <F8><F1>\n"
-"----------------------------------------------------------------------\n"
-"\n"
-"Unless in a data entry window, key <1> may be used instead of <F1>,\n"
-"<2> instead of <F2>, etc.\n"
-"\n"
-"\n"
-"Radiolist (Choice list)\n"
-"-----------------------\n"
-"Use the movement keys listed above to select the option you wish to set\n"
-"and press <Space>.\n"
-"\n"
-"\n"
-"Data entry\n"
-"----------\n"
-"Enter the requested information and press <Enter>. Hexadecimal values\n"
-"may be entered without the \"0x\" prefix.\n"
-"\n"
-"\n"
-"Text Box (Help Window)\n"
-"----------------------\n"
-"Use movement keys as listed in table above.\n"
-"\n"
-"Press any of <Enter> <Esc> <q> <F5> <F9> to exit.\n"
-"\n"
-"\n"
-"Alternate configuration files\n"
-"-----------------------------\n"
-"nconfig supports switching between different configurations.\n"
-"Press <F6> to save your current configuration. Press <F7> and enter\n"
-"a file name to load a previously saved configuration.\n"
-"\n"
-"\n"
-"Terminal configuration\n"
-"----------------------\n"
-"If you use nconfig in a xterm window, make sure your TERM environment\n"
-"variable specifies a terminal configuration which supports at least\n"
-"16 colors. Otherwise nconfig will look rather bad.\n"
-"\n"
-"If the \"stty size\" command reports the current terminalsize correctly,\n"
-"nconfig will adapt to sizes larger than the traditional 80x25 \"standard\"\n"
-"and display longer menus properly.\n"
-"\n"
-"\n"
-"Single menu mode\n"
-"----------------\n"
-"If you prefer to have all of the menu entries listed in a single menu,\n"
-"rather than the default multimenu hierarchy, run nconfig with\n"
-"NCONFIG_MODE environment variable set to single_menu. Example:\n"
-"\n"
-"make NCONFIG_MODE=single_menu nconfig\n"
-"\n"
-"<Enter> will then unfold the appropriate category, or fold it if it\n"
-"is already unfolded. Folded menu entries will be designated by a\n"
-"leading \"++>\" and unfolded entries by a leading \"-->\".\n"
-"\n"
-"Note that this mode can eventually be a little more CPU expensive than\n"
-"the default mode, especially with a larger number of unfolded submenus.\n"
-"\n"),
-menu_no_f_instructions[] = N_(
-"Legend: [*] built-in [ ] excluded <M> module < > module capable.\n"
-"Submenus are designated by a trailing \"--->\", empty ones by \"----\".\n"
-"\n"
-"Use the following keys to navigate the menus:\n"
-"Move up or down with <Up> and <Down>.\n"
-"Enter a submenu with <Enter> or <Right>.\n"
-"Exit a submenu to its parent menu with <Esc> or <Left>.\n"
-"Pressing <y> includes, <n> excludes, <m> modularizes features.\n"
-"Pressing <Space> cycles through the available options.\n"
-"To search for menu entries press </>.\n"
-"<Esc> always leaves the current window.\n"
-"\n"
-"You do not have function keys support.\n"
-"Press <1> instead of <F1>, <2> instead of <F2>, etc.\n"
-"For verbose global help use key <1>.\n"
-"For help related to the current menu entry press <?> or <h>.\n"),
-menu_instructions[] = N_(
-"Legend: [*] built-in [ ] excluded <M> module < > module capable.\n"
-"Submenus are designated by a trailing \"--->\", empty ones by \"----\".\n"
-"\n"
-"Use the following keys to navigate the menus:\n"
-"Move up or down with <Up> or <Down>.\n"
-"Enter a submenu with <Enter> or <Right>.\n"
-"Exit a submenu to its parent menu with <Esc> or <Left>.\n"
-"Pressing <y> includes, <n> excludes, <m> modularizes features.\n"
-"Pressing <Space> cycles through the available options.\n"
-"To search for menu entries press </>.\n"
-"<Esc> always leaves the current window.\n"
-"\n"
-"Pressing <1> may be used instead of <F1>, <2> instead of <F2>, etc.\n"
-"For verbose global help press <F1>.\n"
-"For help related to the current menu entry press <?> or <h>.\n"),
-radiolist_instructions[] = N_(
-"Press <Up>, <Down>, <Home> or <End> to navigate a radiolist, select\n"
-"with <Space>.\n"
-"For help related to the current entry press <?> or <h>.\n"
-"For global help press <F1>.\n"),
-inputbox_instructions_int[] = N_(
-"Please enter a decimal value.\n"
-"Fractions will not be accepted.\n"
-"Press <Enter> to apply, <Esc> to cancel."),
-inputbox_instructions_hex[] = N_(
-"Please enter a hexadecimal value.\n"
-"Press <Enter> to apply, <Esc> to cancel."),
-inputbox_instructions_string[] = N_(
-"Please enter a string value.\n"
-"Press <Enter> to apply, <Esc> to cancel."),
-setmod_text[] = N_(
-"This feature depends on another feature which has been configured as a\n"
-"module. As a result, the current feature will be built as a module too."),
-load_config_text[] = N_(
-"Enter the name of the configuration file you wish to load.\n"
-"Accept the name shown to restore the configuration you last\n"
-"retrieved. Leave empty to abort."),
-load_config_help[] = N_(
-"For various reasons, one may wish to keep several different\n"
-"configurations available on a single machine.\n"
-"\n"
-"If you have saved a previous configuration in a file other than the\n"
-"default one, entering its name here will allow you to load and modify\n"
-"that configuration.\n"
-"\n"
-"Leave empty to abort.\n"),
-save_config_text[] = N_(
-"Enter a filename to which this configuration should be saved\n"
-"as an alternate. Leave empty to abort."),
-save_config_help[] = N_(
-"For various reasons, one may wish to keep several different\n"
-"configurations available on a single machine.\n"
-"\n"
-"Entering a file name here will allow you to later retrieve, modify\n"
-"and use the current configuration as an alternate to whatever\n"
-"configuration options you have selected at that time.\n"
-"\n"
-"Leave empty to abort.\n"),
-search_help[] = N_(
-"Search for symbols (configuration variable names CONFIG_*) and display\n"
-"their relations. Regular expressions are supported.\n"
-"Example: Search for \"^FOO\".\n"
-"Result:\n"
-"-----------------------------------------------------------------\n"
-"Symbol: FOO [ = m]\n"
-"Prompt: Foo bus is used to drive the bar HW\n"
-"Defined at drivers/pci/Kconfig:47\n"
-"Depends on: X86_LOCAL_APIC && X86_IO_APIC || IA64\n"
-"Location:\n"
-" -> Bus options (PCI, PCMCIA, EISA, ISA)\n"
-" -> PCI support (PCI [ = y])\n"
-" -> PCI access mode (<choice> [ = y])\n"
-"Selects: LIBCRC32\n"
-"Selected by: BAR\n"
-"-----------------------------------------------------------------\n"
-"o The line 'Prompt:' shows the text displayed for this symbol in\n"
-" the menu hierarchy.\n"
-"o The 'Defined at' line tells at what file / line number the symbol is\n"
-" defined.\n"
-"o The 'Depends on:' line lists symbols that need to be defined for\n"
-" this symbol to be visible and selectable in the menu.\n"
-"o The 'Location:' lines tell, where in the menu structure this symbol\n"
-" is located. A location followed by a [ = y] indicates that this is\n"
-" a selectable menu item, and the current value is displayed inside\n"
-" brackets.\n"
-"o The 'Selects:' line tells, what symbol will be automatically selected\n"
-" if this symbol is selected (y or m).\n"
-"o The 'Selected by' line tells what symbol has selected this symbol.\n"
-"\n"
-"Only relevant lines are shown.\n"
-"\n\n"
-"Search examples:\n"
-"USB => find all symbols containing USB\n"
-"^USB => find all symbols starting with USB\n"
-"USB$ => find all symbols ending with USB\n"
-"\n");
-
-struct mitem {
- char str[256];
- char tag;
- void *usrptr;
- int is_visible;
-};
-
-#define MAX_MENU_ITEMS 4096
-static int show_all_items;
-static int indent;
-static struct menu *current_menu;
-static int child_count;
-static int single_menu_mode;
-/* the window in which all information appears */
-static WINDOW *main_window;
-/* the largest size of the menu window */
-static int mwin_max_lines;
-static int mwin_max_cols;
-/* the window in which we show option buttons */
-static MENU *curses_menu;
-static ITEM *curses_menu_items[MAX_MENU_ITEMS];
-static struct mitem k_menu_items[MAX_MENU_ITEMS];
-static int items_num;
-static int global_exit;
-/* the currently selected button */
-const char *current_instructions = menu_instructions;
-
-static char *dialog_input_result;
-static int dialog_input_result_len;
-
-static void conf(struct menu *menu);
-static void conf_choice(struct menu *menu);
-static void conf_string(struct menu *menu);
-static void conf_load(void);
-static void conf_save(void);
-static void show_help(struct menu *menu);
-static int do_exit(void);
-static void setup_windows(void);
-static void search_conf(void);
-
-typedef void (*function_key_handler_t)(int *key, struct menu *menu);
-static void handle_f1(int *key, struct menu *current_item);
-static void handle_f2(int *key, struct menu *current_item);
-static void handle_f3(int *key, struct menu *current_item);
-static void handle_f4(int *key, struct menu *current_item);
-static void handle_f5(int *key, struct menu *current_item);
-static void handle_f6(int *key, struct menu *current_item);
-static void handle_f7(int *key, struct menu *current_item);
-static void handle_f8(int *key, struct menu *current_item);
-static void handle_f9(int *key, struct menu *current_item);
-
-struct function_keys {
- const char *key_str;
- const char *func;
- function_key key;
- function_key_handler_t handler;
-};
-
-static const int function_keys_num = 9;
-struct function_keys function_keys[] = {
- {
- .key_str = "F1",
- .func = "Help",
- .key = F_HELP,
- .handler = handle_f1,
- },
- {
- .key_str = "F2",
- .func = "SymInfo",
- .key = F_SYMBOL,
- .handler = handle_f2,
- },
- {
- .key_str = "F3",
- .func = "Help 2",
- .key = F_INSTS,
- .handler = handle_f3,
- },
- {
- .key_str = "F4",
- .func = "ShowAll",
- .key = F_CONF,
- .handler = handle_f4,
- },
- {
- .key_str = "F5",
- .func = "Back",
- .key = F_BACK,
- .handler = handle_f5,
- },
- {
- .key_str = "F6",
- .func = "Save",
- .key = F_SAVE,
- .handler = handle_f6,
- },
- {
- .key_str = "F7",
- .func = "Load",
- .key = F_LOAD,
- .handler = handle_f7,
- },
- {
- .key_str = "F8",
- .func = "SymSearch",
- .key = F_SEARCH,
- .handler = handle_f8,
- },
- {
- .key_str = "F9",
- .func = "Exit",
- .key = F_EXIT,
- .handler = handle_f9,
- },
-};
-
-static void print_function_line(void)
-{
- int i;
- int offset = 1;
- const int skip = 1;
- int lines = getmaxy(stdscr);
-
- for (i = 0; i < function_keys_num; i++) {
- (void) wattrset(main_window, attributes[FUNCTION_HIGHLIGHT]);
- mvwprintw(main_window, lines-3, offset,
- "%s",
- function_keys[i].key_str);
- (void) wattrset(main_window, attributes[FUNCTION_TEXT]);
- offset += strlen(function_keys[i].key_str);
- mvwprintw(main_window, lines-3,
- offset, "%s",
- function_keys[i].func);
- offset += strlen(function_keys[i].func) + skip;
- }
- (void) wattrset(main_window, attributes[NORMAL]);
-}
-
-/* help */
-static void handle_f1(int *key, struct menu *current_item)
-{
- show_scroll_win(main_window,
- _("Global help"), _(nconf_global_help));
- return;
-}
-
-/* symbole help */
-static void handle_f2(int *key, struct menu *current_item)
-{
- show_help(current_item);
- return;
-}
-
-/* instructions */
-static void handle_f3(int *key, struct menu *current_item)
-{
- show_scroll_win(main_window,
- _("Short help"),
- _(current_instructions));
- return;
-}
-
-/* config */
-static void handle_f4(int *key, struct menu *current_item)
-{
- int res = btn_dialog(main_window,
- _("Show all symbols?"),
- 2,
- " <Show All> ",
- "<Don't show all>");
- if (res == 0)
- show_all_items = 1;
- else if (res == 1)
- show_all_items = 0;
-
- return;
-}
-
-/* back */
-static void handle_f5(int *key, struct menu *current_item)
-{
- *key = KEY_LEFT;
- return;
-}
-
-/* save */
-static void handle_f6(int *key, struct menu *current_item)
-{
- conf_save();
- return;
-}
-
-/* load */
-static void handle_f7(int *key, struct menu *current_item)
-{
- conf_load();
- return;
-}
-
-/* search */
-static void handle_f8(int *key, struct menu *current_item)
-{
- search_conf();
- return;
-}
-
-/* exit */
-static void handle_f9(int *key, struct menu *current_item)
-{
- do_exit();
- return;
-}
-
-/* return != 0 to indicate the key was handles */
-static int process_special_keys(int *key, struct menu *menu)
-{
- int i;
-
- if (*key == KEY_RESIZE) {
- setup_windows();
- return 1;
- }
-
- for (i = 0; i < function_keys_num; i++) {
- if (*key == KEY_F(function_keys[i].key) ||
- *key == '0' + function_keys[i].key){
- function_keys[i].handler(key, menu);
- return 1;
- }
- }
-
- return 0;
-}
-
-static void clean_items(void)
-{
- int i;
- for (i = 0; curses_menu_items[i]; i++)
- free_item(curses_menu_items[i]);
- bzero(curses_menu_items, sizeof(curses_menu_items));
- bzero(k_menu_items, sizeof(k_menu_items));
- items_num = 0;
-}
-
-typedef enum {MATCH_TINKER_PATTERN_UP, MATCH_TINKER_PATTERN_DOWN,
- FIND_NEXT_MATCH_DOWN, FIND_NEXT_MATCH_UP} match_f;
-
-/* return the index of the matched item, or -1 if no such item exists */
-static int get_mext_match(const char *match_str, match_f flag)
-{
- int match_start = item_index(current_item(curses_menu));
- int index;
-
- if (flag == FIND_NEXT_MATCH_DOWN)
- ++match_start;
- else if (flag == FIND_NEXT_MATCH_UP)
- --match_start;
-
- index = match_start;
- index = (index + items_num) % items_num;
- while (true) {
- char *str = k_menu_items[index].str;
- if (strcasestr(str, match_str) != 0)
- return index;
- if (flag == FIND_NEXT_MATCH_UP ||
- flag == MATCH_TINKER_PATTERN_UP)
- --index;
- else
- ++index;
- index = (index + items_num) % items_num;
- if (index == match_start)
- return -1;
- }
-}
-
-/* Make a new item. */
-static void item_make(struct menu *menu, char tag, const char *fmt, ...)
-{
- va_list ap;
-
- if (items_num > MAX_MENU_ITEMS-1)
- return;
-
- bzero(&k_menu_items[items_num], sizeof(k_menu_items[0]));
- k_menu_items[items_num].tag = tag;
- k_menu_items[items_num].usrptr = menu;
- if (menu != NULL)
- k_menu_items[items_num].is_visible =
- menu_is_visible(menu);
- else
- k_menu_items[items_num].is_visible = 1;
-
- va_start(ap, fmt);
- vsnprintf(k_menu_items[items_num].str,
- sizeof(k_menu_items[items_num].str),
- fmt, ap);
- va_end(ap);
-
- if (!k_menu_items[items_num].is_visible)
- memcpy(k_menu_items[items_num].str, "XXX", 3);
-
- curses_menu_items[items_num] = new_item(
- k_menu_items[items_num].str,
- k_menu_items[items_num].str);
- set_item_userptr(curses_menu_items[items_num],
- &k_menu_items[items_num]);
- /*
- if (!k_menu_items[items_num].is_visible)
- item_opts_off(curses_menu_items[items_num], O_SELECTABLE);
- */
-
- items_num++;
- curses_menu_items[items_num] = NULL;
-}
-
-/* very hackish. adds a string to the last item added */
-static void item_add_str(const char *fmt, ...)
-{
- va_list ap;
- int index = items_num-1;
- char new_str[256];
- char tmp_str[256];
-
- if (index < 0)
- return;
-
- va_start(ap, fmt);
- vsnprintf(new_str, sizeof(new_str), fmt, ap);
- va_end(ap);
- snprintf(tmp_str, sizeof(tmp_str), "%s%s",
- k_menu_items[index].str, new_str);
- strncpy(k_menu_items[index].str,
- tmp_str,
- sizeof(k_menu_items[index].str));
-
- free_item(curses_menu_items[index]);
- curses_menu_items[index] = new_item(
- k_menu_items[index].str,
- k_menu_items[index].str);
- set_item_userptr(curses_menu_items[index],
- &k_menu_items[index]);
-}
-
-/* get the tag of the currently selected item */
-static char item_tag(void)
-{
- ITEM *cur;
- struct mitem *mcur;
-
- cur = current_item(curses_menu);
- if (cur == NULL)
- return 0;
- mcur = (struct mitem *) item_userptr(cur);
- return mcur->tag;
-}
-
-static int curses_item_index(void)
-{
- return item_index(current_item(curses_menu));
-}
-
-static void *item_data(void)
-{
- ITEM *cur;
- struct mitem *mcur;
-
- cur = current_item(curses_menu);
- if (!cur)
- return NULL;
- mcur = (struct mitem *) item_userptr(cur);
- return mcur->usrptr;
-
-}
-
-static int item_is_tag(char tag)
-{
- return item_tag() == tag;
-}
-
-static char filename[PATH_MAX+1];
-static char menu_backtitle[PATH_MAX+128];
-static const char *set_config_filename(const char *config_filename)
-{
- int size;
-
- size = snprintf(menu_backtitle, sizeof(menu_backtitle),
- "%s - %s", config_filename, rootmenu.prompt->text);
- if (size >= sizeof(menu_backtitle))
- menu_backtitle[sizeof(menu_backtitle)-1] = '\0';
-
- size = snprintf(filename, sizeof(filename), "%s", config_filename);
- if (size >= sizeof(filename))
- filename[sizeof(filename)-1] = '\0';
- return menu_backtitle;
-}
-
-/* return = 0 means we are successful.
- * -1 means go on doing what you were doing
- */
-static int do_exit(void)
-{
- int res;
- if (!conf_get_changed()) {
- global_exit = 1;
- return 0;
- }
- res = btn_dialog(main_window,
- _("Do you wish to save your new configuration?\n"
- "<ESC> to cancel and resume nconfig."),
- 2,
- " <save> ",
- "<don't save>");
- if (res == KEY_EXIT) {
- global_exit = 0;
- return -1;
- }
-
- /* if we got here, the user really wants to exit */
- switch (res) {
- case 0:
- res = conf_write(filename);
- if (res)
- btn_dialog(
- main_window,
- _("Error during writing of configuration.\n"
- "Your configuration changes were NOT saved."),
- 1,
- "<OK>");
- break;
- default:
- btn_dialog(
- main_window,
- _("Your configuration changes were NOT saved."),
- 1,
- "<OK>");
- break;
- }
- global_exit = 1;
- return 0;
-}
-
-
-static void search_conf(void)
-{
- struct symbol **sym_arr;
- struct gstr res;
- struct gstr title;
- char *dialog_input;
- int dres;
-
- title = str_new();
- str_printf( &title, _("Enter (sub)string or regexp to search for "
- "(with or without \"%s\")"), CONFIG_);
-
-again:
- dres = dialog_inputbox(main_window,
- _("Search Configuration Parameter"),
- str_get(&title),
- "", &dialog_input_result, &dialog_input_result_len);
- switch (dres) {
- case 0:
- break;
- case 1:
- show_scroll_win(main_window,
- _("Search Configuration"), search_help);
- goto again;
- default:
- str_free(&title);
- return;
- }
-
- /* strip the prefix if necessary */
- dialog_input = dialog_input_result;
- if (strncasecmp(dialog_input_result, CONFIG_, strlen(CONFIG_)) == 0)
- dialog_input += strlen(CONFIG_);
-
- sym_arr = sym_re_search(dialog_input);
- res = get_relations_str(sym_arr, NULL);
- free(sym_arr);
- show_scroll_win(main_window,
- _("Search Results"), str_get(&res));
- str_free(&res);
- str_free(&title);
-}
-
-
-static void build_conf(struct menu *menu)
-{
- struct symbol *sym;
- struct property *prop;
- struct menu *child;
- int type, tmp, doint = 2;
- tristate val;
- char ch;
-
- if (!menu || (!show_all_items && !menu_is_visible(menu)))
- return;
-
- sym = menu->sym;
- prop = menu->prompt;
- if (!sym) {
- if (prop && menu != current_menu) {
- const char *prompt = menu_get_prompt(menu);
- enum prop_type ptype;
- ptype = menu->prompt ? menu->prompt->type : P_UNKNOWN;
- switch (ptype) {
- case P_MENU:
- child_count++;
- prompt = _(prompt);
- if (single_menu_mode) {
- item_make(menu, 'm',
- "%s%*c%s",
- menu->data ? "-->" : "++>",
- indent + 1, ' ', prompt);
- } else
- item_make(menu, 'm',
- " %*c%s %s",
- indent + 1, ' ', prompt,
- menu_is_empty(menu) ? "----" : "--->");
-
- if (single_menu_mode && menu->data)
- goto conf_childs;
- return;
- case P_COMMENT:
- if (prompt) {
- child_count++;
- item_make(menu, ':',
- " %*c*** %s ***",
- indent + 1, ' ',
- _(prompt));
- }
- break;
- default:
- if (prompt) {
- child_count++;
- item_make(menu, ':', "---%*c%s",
- indent + 1, ' ',
- _(prompt));
- }
- }
- } else
- doint = 0;
- goto conf_childs;
- }
-
- type = sym_get_type(sym);
- if (sym_is_choice(sym)) {
- struct symbol *def_sym = sym_get_choice_value(sym);
- struct menu *def_menu = NULL;
-
- child_count++;
- for (child = menu->list; child; child = child->next) {
- if (menu_is_visible(child) && child->sym == def_sym)
- def_menu = child;
- }
-
- val = sym_get_tristate_value(sym);
- if (sym_is_changable(sym)) {
- switch (type) {
- case S_BOOLEAN:
- item_make(menu, 't', "[%c]",
- val == no ? ' ' : '*');
- break;
- case S_TRISTATE:
- switch (val) {
- case yes:
- ch = '*';
- break;
- case mod:
- ch = 'M';
- break;
- default:
- ch = ' ';
- break;
- }
- item_make(menu, 't', "<%c>", ch);
- break;
- }
- } else {
- item_make(menu, def_menu ? 't' : ':', " ");
- }
-
- item_add_str("%*c%s", indent + 1,
- ' ', _(menu_get_prompt(menu)));
- if (val == yes) {
- if (def_menu) {
- item_add_str(" (%s)",
- _(menu_get_prompt(def_menu)));
- item_add_str(" --->");
- if (def_menu->list) {
- indent += 2;
- build_conf(def_menu);
- indent -= 2;
- }
- }
- return;
- }
- } else {
- if (menu == current_menu) {
- item_make(menu, ':',
- "---%*c%s", indent + 1,
- ' ', _(menu_get_prompt(menu)));
- goto conf_childs;
- }
- child_count++;
- val = sym_get_tristate_value(sym);
- if (sym_is_choice_value(sym) && val == yes) {
- item_make(menu, ':', " ");
- } else {
- switch (type) {
- case S_BOOLEAN:
- if (sym_is_changable(sym))
- item_make(menu, 't', "[%c]",
- val == no ? ' ' : '*');
- else
- item_make(menu, 't', "-%c-",
- val == no ? ' ' : '*');
- break;
- case S_TRISTATE:
- switch (val) {
- case yes:
- ch = '*';
- break;
- case mod:
- ch = 'M';
- break;
- default:
- ch = ' ';
- break;
- }
- if (sym_is_changable(sym)) {
- if (sym->rev_dep.tri == mod)
- item_make(menu,
- 't', "{%c}", ch);
- else
- item_make(menu,
- 't', "<%c>", ch);
- } else
- item_make(menu, 't', "-%c-", ch);
- break;
- default:
- tmp = 2 + strlen(sym_get_string_value(sym));
- item_make(menu, 's', " (%s)",
- sym_get_string_value(sym));
- tmp = indent - tmp + 4;
- if (tmp < 0)
- tmp = 0;
- item_add_str("%*c%s%s", tmp, ' ',
- _(menu_get_prompt(menu)),
- (sym_has_value(sym) ||
- !sym_is_changable(sym)) ? "" :
- _(" (NEW)"));
- goto conf_childs;
- }
- }
- item_add_str("%*c%s%s", indent + 1, ' ',
- _(menu_get_prompt(menu)),
- (sym_has_value(sym) || !sym_is_changable(sym)) ?
- "" : _(" (NEW)"));
- if (menu->prompt && menu->prompt->type == P_MENU) {
- item_add_str(" %s", menu_is_empty(menu) ? "----" : "--->");
- return;
- }
- }
-
-conf_childs:
- indent += doint;
- for (child = menu->list; child; child = child->next)
- build_conf(child);
- indent -= doint;
-}
-
-static void reset_menu(void)
-{
- unpost_menu(curses_menu);
- clean_items();
-}
-
-/* adjust the menu to show this item.
- * prefer not to scroll the menu if possible*/
-static void center_item(int selected_index, int *last_top_row)
-{
- int toprow;
-
- set_top_row(curses_menu, *last_top_row);
- toprow = top_row(curses_menu);
- if (selected_index < toprow ||
- selected_index >= toprow+mwin_max_lines) {
- toprow = max(selected_index-mwin_max_lines/2, 0);
- if (toprow >= item_count(curses_menu)-mwin_max_lines)
- toprow = item_count(curses_menu)-mwin_max_lines;
- set_top_row(curses_menu, toprow);
- }
- set_current_item(curses_menu,
- curses_menu_items[selected_index]);
- *last_top_row = toprow;
- post_menu(curses_menu);
- refresh_all_windows(main_window);
-}
-
-/* this function assumes reset_menu has been called before */
-static void show_menu(const char *prompt, const char *instructions,
- int selected_index, int *last_top_row)
-{
- int maxx, maxy;
- WINDOW *menu_window;
-
- current_instructions = instructions;
-
- clear();
- (void) wattrset(main_window, attributes[NORMAL]);
- print_in_middle(stdscr, 1, 0, getmaxx(stdscr),
- menu_backtitle,
- attributes[MAIN_HEADING]);
-
- (void) wattrset(main_window, attributes[MAIN_MENU_BOX]);
- box(main_window, 0, 0);
- (void) wattrset(main_window, attributes[MAIN_MENU_HEADING]);
- mvwprintw(main_window, 0, 3, " %s ", prompt);
- (void) wattrset(main_window, attributes[NORMAL]);
-
- set_menu_items(curses_menu, curses_menu_items);
-
- /* position the menu at the middle of the screen */
- scale_menu(curses_menu, &maxy, &maxx);
- maxx = min(maxx, mwin_max_cols-2);
- maxy = mwin_max_lines;
- menu_window = derwin(main_window,
- maxy,
- maxx,
- 2,
- (mwin_max_cols-maxx)/2);
- keypad(menu_window, TRUE);
- set_menu_win(curses_menu, menu_window);
- set_menu_sub(curses_menu, menu_window);
-
- /* must reassert this after changing items, otherwise returns to a
- * default of 16
- */
- set_menu_format(curses_menu, maxy, 1);
- center_item(selected_index, last_top_row);
- set_menu_format(curses_menu, maxy, 1);
-
- print_function_line();
-
- /* Post the menu */
- post_menu(curses_menu);
- refresh_all_windows(main_window);
-}
-
-static void adj_match_dir(match_f *match_direction)
-{
- if (*match_direction == FIND_NEXT_MATCH_DOWN)
- *match_direction =
- MATCH_TINKER_PATTERN_DOWN;
- else if (*match_direction == FIND_NEXT_MATCH_UP)
- *match_direction =
- MATCH_TINKER_PATTERN_UP;
- /* else, do no change.. */
-}
-
-struct match_state
-{
- int in_search;
- match_f match_direction;
- char pattern[256];
-};
-
-/* Return 0 means I have handled the key. In such a case, ans should hold the
- * item to center, or -1 otherwise.
- * Else return -1 .
- */
-static int do_match(int key, struct match_state *state, int *ans)
-{
- char c = (char) key;
- int terminate_search = 0;
- *ans = -1;
- if (key == '/' || (state->in_search && key == 27)) {
- move(0, 0);
- refresh();
- clrtoeol();
- state->in_search = 1-state->in_search;
- bzero(state->pattern, sizeof(state->pattern));
- state->match_direction = MATCH_TINKER_PATTERN_DOWN;
- return 0;
- } else if (!state->in_search)
- return 1;
-
- if (isalnum(c) || isgraph(c) || c == ' ') {
- state->pattern[strlen(state->pattern)] = c;
- state->pattern[strlen(state->pattern)] = '\0';
- adj_match_dir(&state->match_direction);
- *ans = get_mext_match(state->pattern,
- state->match_direction);
- } else if (key == KEY_DOWN) {
- state->match_direction = FIND_NEXT_MATCH_DOWN;
- *ans = get_mext_match(state->pattern,
- state->match_direction);
- } else if (key == KEY_UP) {
- state->match_direction = FIND_NEXT_MATCH_UP;
- *ans = get_mext_match(state->pattern,
- state->match_direction);
- } else if (key == KEY_BACKSPACE || key == 127) {
- state->pattern[strlen(state->pattern)-1] = '\0';
- adj_match_dir(&state->match_direction);
- } else
- terminate_search = 1;
-
- if (terminate_search) {
- state->in_search = 0;
- bzero(state->pattern, sizeof(state->pattern));
- move(0, 0);
- refresh();
- clrtoeol();
- return -1;
- }
- return 0;
-}
-
-static void conf(struct menu *menu)
-{
- struct menu *submenu = 0;
- const char *prompt = menu_get_prompt(menu);
- struct symbol *sym;
- int res;
- int current_index = 0;
- int last_top_row = 0;
- struct match_state match_state = {
- .in_search = 0,
- .match_direction = MATCH_TINKER_PATTERN_DOWN,
- .pattern = "",
- };
-
- while (!global_exit) {
- reset_menu();
- current_menu = menu;
- build_conf(menu);
- if (!child_count)
- break;
-
- show_menu(prompt ? _(prompt) : _("Main Menu"),
- _(menu_instructions),
- current_index, &last_top_row);
- keypad((menu_win(curses_menu)), TRUE);
- while (!global_exit) {
- if (match_state.in_search) {
- mvprintw(0, 0,
- "searching: %s", match_state.pattern);
- clrtoeol();
- }
- refresh_all_windows(main_window);
- res = wgetch(menu_win(curses_menu));
- if (!res)
- break;
- if (do_match(res, &match_state, ¤t_index) == 0) {
- if (current_index != -1)
- center_item(current_index,
- &last_top_row);
- continue;
- }
- if (process_special_keys(&res,
- (struct menu *) item_data()))
- break;
- switch (res) {
- case KEY_DOWN:
- menu_driver(curses_menu, REQ_DOWN_ITEM);
- break;
- case KEY_UP:
- menu_driver(curses_menu, REQ_UP_ITEM);
- break;
- case KEY_NPAGE:
- menu_driver(curses_menu, REQ_SCR_DPAGE);
- break;
- case KEY_PPAGE:
- menu_driver(curses_menu, REQ_SCR_UPAGE);
- break;
- case KEY_HOME:
- menu_driver(curses_menu, REQ_FIRST_ITEM);
- break;
- case KEY_END:
- menu_driver(curses_menu, REQ_LAST_ITEM);
- break;
- case 'h':
- case '?':
- show_help((struct menu *) item_data());
- break;
- }
- if (res == 10 || res == 27 ||
- res == 32 || res == 'n' || res == 'y' ||
- res == KEY_LEFT || res == KEY_RIGHT ||
- res == 'm')
- break;
- refresh_all_windows(main_window);
- }
-
- refresh_all_windows(main_window);
- /* if ESC or left*/
- if (res == 27 || (menu != &rootmenu && res == KEY_LEFT))
- break;
-
- /* remember location in the menu */
- last_top_row = top_row(curses_menu);
- current_index = curses_item_index();
-
- if (!item_tag())
- continue;
-
- submenu = (struct menu *) item_data();
- if (!submenu || !menu_is_visible(submenu))
- continue;
- sym = submenu->sym;
-
- switch (res) {
- case ' ':
- if (item_is_tag('t'))
- sym_toggle_tristate_value(sym);
- else if (item_is_tag('m'))
- conf(submenu);
- break;
- case KEY_RIGHT:
- case 10: /* ENTER WAS PRESSED */
- switch (item_tag()) {
- case 'm':
- if (single_menu_mode)
- submenu->data =
- (void *) (long) !submenu->data;
- else
- conf(submenu);
- break;
- case 't':
- if (sym_is_choice(sym) &&
- sym_get_tristate_value(sym) == yes)
- conf_choice(submenu);
- else if (submenu->prompt &&
- submenu->prompt->type == P_MENU)
- conf(submenu);
- else if (res == 10)
- sym_toggle_tristate_value(sym);
- break;
- case 's':
- conf_string(submenu);
- break;
- }
- break;
- case 'y':
- if (item_is_tag('t')) {
- if (sym_set_tristate_value(sym, yes))
- break;
- if (sym_set_tristate_value(sym, mod))
- btn_dialog(main_window, setmod_text, 0);
- }
- break;
- case 'n':
- if (item_is_tag('t'))
- sym_set_tristate_value(sym, no);
- break;
- case 'm':
- if (item_is_tag('t'))
- sym_set_tristate_value(sym, mod);
- break;
- }
- }
-}
-
-static void conf_message_callback(const char *fmt, va_list ap)
-{
- char buf[1024];
-
- vsnprintf(buf, sizeof(buf), fmt, ap);
- btn_dialog(main_window, buf, 1, "<OK>");
-}
-
-static void show_help(struct menu *menu)
-{
- struct gstr help;
-
- if (!menu)
- return;
-
- help = str_new();
- menu_get_ext_help(menu, &help);
- show_scroll_win(main_window, _(menu_get_prompt(menu)), str_get(&help));
- str_free(&help);
-}
-
-static void conf_choice(struct menu *menu)
-{
- const char *prompt = _(menu_get_prompt(menu));
- struct menu *child = 0;
- struct symbol *active;
- int selected_index = 0;
- int last_top_row = 0;
- int res, i = 0;
- struct match_state match_state = {
- .in_search = 0,
- .match_direction = MATCH_TINKER_PATTERN_DOWN,
- .pattern = "",
- };
-
- active = sym_get_choice_value(menu->sym);
- /* this is mostly duplicated from the conf() function. */
- while (!global_exit) {
- reset_menu();
-
- for (i = 0, child = menu->list; child; child = child->next) {
- if (!show_all_items && !menu_is_visible(child))
- continue;
-
- if (child->sym == sym_get_choice_value(menu->sym))
- item_make(child, ':', "<X> %s",
- _(menu_get_prompt(child)));
- else if (child->sym)
- item_make(child, ':', " %s",
- _(menu_get_prompt(child)));
- else
- item_make(child, ':', "*** %s ***",
- _(menu_get_prompt(child)));
-
- if (child->sym == active){
- last_top_row = top_row(curses_menu);
- selected_index = i;
- }
- i++;
- }
- show_menu(prompt ? _(prompt) : _("Choice Menu"),
- _(radiolist_instructions),
- selected_index,
- &last_top_row);
- while (!global_exit) {
- if (match_state.in_search) {
- mvprintw(0, 0, "searching: %s",
- match_state.pattern);
- clrtoeol();
- }
- refresh_all_windows(main_window);
- res = wgetch(menu_win(curses_menu));
- if (!res)
- break;
- if (do_match(res, &match_state, &selected_index) == 0) {
- if (selected_index != -1)
- center_item(selected_index,
- &last_top_row);
- continue;
- }
- if (process_special_keys(
- &res,
- (struct menu *) item_data()))
- break;
- switch (res) {
- case KEY_DOWN:
- menu_driver(curses_menu, REQ_DOWN_ITEM);
- break;
- case KEY_UP:
- menu_driver(curses_menu, REQ_UP_ITEM);
- break;
- case KEY_NPAGE:
- menu_driver(curses_menu, REQ_SCR_DPAGE);
- break;
- case KEY_PPAGE:
- menu_driver(curses_menu, REQ_SCR_UPAGE);
- break;
- case KEY_HOME:
- menu_driver(curses_menu, REQ_FIRST_ITEM);
- break;
- case KEY_END:
- menu_driver(curses_menu, REQ_LAST_ITEM);
- break;
- case 'h':
- case '?':
- show_help((struct menu *) item_data());
- break;
- }
- if (res == 10 || res == 27 || res == ' ' ||
- res == KEY_LEFT){
- break;
- }
- refresh_all_windows(main_window);
- }
- /* if ESC or left */
- if (res == 27 || res == KEY_LEFT)
- break;
-
- child = item_data();
- if (!child || !menu_is_visible(child) || !child->sym)
- continue;
- switch (res) {
- case ' ':
- case 10:
- case KEY_RIGHT:
- sym_set_tristate_value(child->sym, yes);
- return;
- case 'h':
- case '?':
- show_help(child);
- active = child->sym;
- break;
- case KEY_EXIT:
- return;
- }
- }
-}
-
-static void conf_string(struct menu *menu)
-{
- const char *prompt = menu_get_prompt(menu);
-
- while (1) {
- int res;
- const char *heading;
-
- switch (sym_get_type(menu->sym)) {
- case S_INT:
- heading = _(inputbox_instructions_int);
- break;
- case S_HEX:
- heading = _(inputbox_instructions_hex);
- break;
- case S_STRING:
- heading = _(inputbox_instructions_string);
- break;
- default:
- heading = _("Internal nconf error!");
- }
- res = dialog_inputbox(main_window,
- prompt ? _(prompt) : _("Main Menu"),
- heading,
- sym_get_string_value(menu->sym),
- &dialog_input_result,
- &dialog_input_result_len);
- switch (res) {
- case 0:
- if (sym_set_string_value(menu->sym,
- dialog_input_result))
- return;
- btn_dialog(main_window,
- _("You have made an invalid entry."), 0);
- break;
- case 1:
- show_help(menu);
- break;
- case KEY_EXIT:
- return;
- }
- }
-}
-
-static void conf_load(void)
-{
- while (1) {
- int res;
- res = dialog_inputbox(main_window,
- NULL, load_config_text,
- filename,
- &dialog_input_result,
- &dialog_input_result_len);
- switch (res) {
- case 0:
- if (!dialog_input_result[0])
- return;
- if (!conf_read(dialog_input_result)) {
- set_config_filename(dialog_input_result);
- sym_set_change_count(1);
- return;
- }
- btn_dialog(main_window, _("File does not exist!"), 0);
- break;
- case 1:
- show_scroll_win(main_window,
- _("Load Alternate Configuration"),
- load_config_help);
- break;
- case KEY_EXIT:
- return;
- }
- }
-}
-
-static void conf_save(void)
-{
- while (1) {
- int res;
- res = dialog_inputbox(main_window,
- NULL, save_config_text,
- filename,
- &dialog_input_result,
- &dialog_input_result_len);
- switch (res) {
- case 0:
- if (!dialog_input_result[0])
- return;
- res = conf_write(dialog_input_result);
- if (!res) {
- set_config_filename(dialog_input_result);
- return;
- }
- btn_dialog(main_window, _("Can't create file! "
- "Probably a nonexistent directory."),
- 1, "<OK>");
- break;
- case 1:
- show_scroll_win(main_window,
- _("Save Alternate Configuration"),
- save_config_help);
- break;
- case KEY_EXIT:
- return;
- }
- }
-}
-
-void setup_windows(void)
-{
- int lines, columns;
-
- getmaxyx(stdscr, lines, columns);
-
- if (main_window != NULL)
- delwin(main_window);
-
- /* set up the menu and menu window */
- main_window = newwin(lines-2, columns-2, 2, 1);
- keypad(main_window, TRUE);
- mwin_max_lines = lines-7;
- mwin_max_cols = columns-6;
-
- /* panels order is from bottom to top */
- new_panel(main_window);
-}
-
-int main(int ac, char **av)
-{
- int lines, columns;
- char *mode;
-
- setlocale(LC_ALL, "");
- bindtextdomain(PACKAGE, LOCALEDIR);
- textdomain(PACKAGE);
-
- if (ac > 1 && strcmp(av[1], "-s") == 0) {
- /* Silence conf_read() until the real callback is set up */
- conf_set_message_callback(NULL);
- av++;
- }
- conf_parse(av[1]);
- conf_read(NULL);
-
- mode = getenv("NCONFIG_MODE");
- if (mode) {
- if (!strcasecmp(mode, "single_menu"))
- single_menu_mode = 1;
- }
-
- /* Initialize curses */
- initscr();
- /* set color theme */
- set_colors();
-
- cbreak();
- noecho();
- keypad(stdscr, TRUE);
- curs_set(0);
-
- getmaxyx(stdscr, lines, columns);
- if (columns < 75 || lines < 20) {
- endwin();
- printf("Your terminal should have at "
- "least 20 lines and 75 columns\n");
- return 1;
- }
-
- notimeout(stdscr, FALSE);
-#if NCURSES_REENTRANT
- set_escdelay(1);
-#else
- ESCDELAY = 1;
-#endif
-
- /* set btns menu */
- curses_menu = new_menu(curses_menu_items);
- menu_opts_off(curses_menu, O_SHOWDESC);
- menu_opts_on(curses_menu, O_SHOWMATCH);
- menu_opts_on(curses_menu, O_ONEVALUE);
- menu_opts_on(curses_menu, O_NONCYCLIC);
- menu_opts_on(curses_menu, O_IGNORECASE);
- set_menu_mark(curses_menu, " ");
- set_menu_fore(curses_menu, attributes[MAIN_MENU_FORE]);
- set_menu_back(curses_menu, attributes[MAIN_MENU_BACK]);
- set_menu_grey(curses_menu, attributes[MAIN_MENU_GREY]);
-
- set_config_filename(conf_get_configname());
- setup_windows();
-
- /* check for KEY_FUNC(1) */
- if (has_key(KEY_F(1)) == FALSE) {
- show_scroll_win(main_window,
- _("Instructions"),
- _(menu_no_f_instructions));
- }
-
- conf_set_message_callback(conf_message_callback);
- /* do the work */
- while (!global_exit) {
- conf(&rootmenu);
- if (!global_exit && do_exit() == 0)
- break;
- }
- /* ok, we are done */
- unpost_menu(curses_menu);
- free_menu(curses_menu);
- delwin(main_window);
- clear();
- refresh();
- endwin();
- return 0;
-}
+++ /dev/null
-/*
- * Copyright (C) 2008 Nir Tzachar <nir.tzachar@gmail.com?
- * Released under the terms of the GNU GPL v2.0.
- *
- * Derived from menuconfig.
- *
- */
-#include "nconf.h"
-
-/* a list of all the different widgets we use */
-attributes_t attributes[ATTR_MAX+1] = {0};
-
-/* available colors:
- COLOR_BLACK 0
- COLOR_RED 1
- COLOR_GREEN 2
- COLOR_YELLOW 3
- COLOR_BLUE 4
- COLOR_MAGENTA 5
- COLOR_CYAN 6
- COLOR_WHITE 7
- */
-static void set_normal_colors(void)
-{
- init_pair(NORMAL, -1, -1);
- init_pair(MAIN_HEADING, COLOR_MAGENTA, -1);
-
- /* FORE is for the selected item */
- init_pair(MAIN_MENU_FORE, -1, -1);
- /* BACK for all the rest */
- init_pair(MAIN_MENU_BACK, -1, -1);
- init_pair(MAIN_MENU_GREY, -1, -1);
- init_pair(MAIN_MENU_HEADING, COLOR_GREEN, -1);
- init_pair(MAIN_MENU_BOX, COLOR_YELLOW, -1);
-
- init_pair(SCROLLWIN_TEXT, -1, -1);
- init_pair(SCROLLWIN_HEADING, COLOR_GREEN, -1);
- init_pair(SCROLLWIN_BOX, COLOR_YELLOW, -1);
-
- init_pair(DIALOG_TEXT, -1, -1);
- init_pair(DIALOG_BOX, COLOR_YELLOW, -1);
- init_pair(DIALOG_MENU_BACK, COLOR_YELLOW, -1);
- init_pair(DIALOG_MENU_FORE, COLOR_RED, -1);
-
- init_pair(INPUT_BOX, COLOR_YELLOW, -1);
- init_pair(INPUT_HEADING, COLOR_GREEN, -1);
- init_pair(INPUT_TEXT, -1, -1);
- init_pair(INPUT_FIELD, -1, -1);
-
- init_pair(FUNCTION_HIGHLIGHT, -1, -1);
- init_pair(FUNCTION_TEXT, COLOR_YELLOW, -1);
-}
-
-/* available attributes:
- A_NORMAL Normal display (no highlight)
- A_STANDOUT Best highlighting mode of the terminal.
- A_UNDERLINE Underlining
- A_REVERSE Reverse video
- A_BLINK Blinking
- A_DIM Half bright
- A_BOLD Extra bright or bold
- A_PROTECT Protected mode
- A_INVIS Invisible or blank mode
- A_ALTCHARSET Alternate character set
- A_CHARTEXT Bit-mask to extract a character
- COLOR_PAIR(n) Color-pair number n
- */
-static void normal_color_theme(void)
-{
- /* automatically add color... */
-#define mkattr(name, attr) do { \
-attributes[name] = attr | COLOR_PAIR(name); } while (0)
- mkattr(NORMAL, NORMAL);
- mkattr(MAIN_HEADING, A_BOLD | A_UNDERLINE);
-
- mkattr(MAIN_MENU_FORE, A_REVERSE);
- mkattr(MAIN_MENU_BACK, A_NORMAL);
- mkattr(MAIN_MENU_GREY, A_NORMAL);
- mkattr(MAIN_MENU_HEADING, A_BOLD);
- mkattr(MAIN_MENU_BOX, A_NORMAL);
-
- mkattr(SCROLLWIN_TEXT, A_NORMAL);
- mkattr(SCROLLWIN_HEADING, A_BOLD);
- mkattr(SCROLLWIN_BOX, A_BOLD);
-
- mkattr(DIALOG_TEXT, A_BOLD);
- mkattr(DIALOG_BOX, A_BOLD);
- mkattr(DIALOG_MENU_FORE, A_STANDOUT);
- mkattr(DIALOG_MENU_BACK, A_NORMAL);
-
- mkattr(INPUT_BOX, A_NORMAL);
- mkattr(INPUT_HEADING, A_BOLD);
- mkattr(INPUT_TEXT, A_NORMAL);
- mkattr(INPUT_FIELD, A_UNDERLINE);
-
- mkattr(FUNCTION_HIGHLIGHT, A_BOLD);
- mkattr(FUNCTION_TEXT, A_REVERSE);
-}
-
-static void no_colors_theme(void)
-{
- /* automatically add highlight, no color */
-#define mkattrn(name, attr) { attributes[name] = attr; }
-
- mkattrn(NORMAL, NORMAL);
- mkattrn(MAIN_HEADING, A_BOLD | A_UNDERLINE);
-
- mkattrn(MAIN_MENU_FORE, A_STANDOUT);
- mkattrn(MAIN_MENU_BACK, A_NORMAL);
- mkattrn(MAIN_MENU_GREY, A_NORMAL);
- mkattrn(MAIN_MENU_HEADING, A_BOLD);
- mkattrn(MAIN_MENU_BOX, A_NORMAL);
-
- mkattrn(SCROLLWIN_TEXT, A_NORMAL);
- mkattrn(SCROLLWIN_HEADING, A_BOLD);
- mkattrn(SCROLLWIN_BOX, A_BOLD);
-
- mkattrn(DIALOG_TEXT, A_NORMAL);
- mkattrn(DIALOG_BOX, A_BOLD);
- mkattrn(DIALOG_MENU_FORE, A_STANDOUT);
- mkattrn(DIALOG_MENU_BACK, A_NORMAL);
-
- mkattrn(INPUT_BOX, A_BOLD);
- mkattrn(INPUT_HEADING, A_BOLD);
- mkattrn(INPUT_TEXT, A_NORMAL);
- mkattrn(INPUT_FIELD, A_UNDERLINE);
-
- mkattrn(FUNCTION_HIGHLIGHT, A_BOLD);
- mkattrn(FUNCTION_TEXT, A_REVERSE);
-}
-
-void set_colors()
-{
- start_color();
- use_default_colors();
- set_normal_colors();
- if (has_colors()) {
- normal_color_theme();
- } else {
- /* give defaults */
- no_colors_theme();
- }
-}
-
-
-/* this changes the windows attributes !!! */
-void print_in_middle(WINDOW *win,
- int starty,
- int startx,
- int width,
- const char *string,
- chtype color)
-{ int length, x, y;
- float temp;
-
-
- if (win == NULL)
- win = stdscr;
- getyx(win, y, x);
- if (startx != 0)
- x = startx;
- if (starty != 0)
- y = starty;
- if (width == 0)
- width = 80;
-
- length = strlen(string);
- temp = (width - length) / 2;
- x = startx + (int)temp;
- (void) wattrset(win, color);
- mvwprintw(win, y, x, "%s", string);
- refresh();
-}
-
-int get_line_no(const char *text)
-{
- int i;
- int total = 1;
-
- if (!text)
- return 0;
-
- for (i = 0; text[i] != '\0'; i++)
- if (text[i] == '\n')
- total++;
- return total;
-}
-
-const char *get_line(const char *text, int line_no)
-{
- int i;
- int lines = 0;
-
- if (!text)
- return 0;
-
- for (i = 0; text[i] != '\0' && lines < line_no; i++)
- if (text[i] == '\n')
- lines++;
- return text+i;
-}
-
-int get_line_length(const char *line)
-{
- int res = 0;
- while (*line != '\0' && *line != '\n') {
- line++;
- res++;
- }
- return res;
-}
-
-/* print all lines to the window. */
-void fill_window(WINDOW *win, const char *text)
-{
- int x, y;
- int total_lines = get_line_no(text);
- int i;
-
- getmaxyx(win, y, x);
- /* do not go over end of line */
- total_lines = min(total_lines, y);
- for (i = 0; i < total_lines; i++) {
- char tmp[x+10];
- const char *line = get_line(text, i);
- int len = get_line_length(line);
- strncpy(tmp, line, min(len, x));
- tmp[len] = '\0';
- mvwprintw(win, i, 0, "%s", tmp);
- }
-}
-
-/* get the message, and buttons.
- * each button must be a char*
- * return the selected button
- *
- * this dialog is used for 2 different things:
- * 1) show a text box, no buttons.
- * 2) show a dialog, with horizontal buttons
- */
-int btn_dialog(WINDOW *main_window, const char *msg, int btn_num, ...)
-{
- va_list ap;
- char *btn;
- int btns_width = 0;
- int msg_lines = 0;
- int msg_width = 0;
- int total_width;
- int win_rows = 0;
- WINDOW *win;
- WINDOW *msg_win;
- WINDOW *menu_win;
- MENU *menu;
- ITEM *btns[btn_num+1];
- int i, x, y;
- int res = -1;
-
-
- va_start(ap, btn_num);
- for (i = 0; i < btn_num; i++) {
- btn = va_arg(ap, char *);
- btns[i] = new_item(btn, "");
- btns_width += strlen(btn)+1;
- }
- va_end(ap);
- btns[btn_num] = NULL;
-
- /* find the widest line of msg: */
- msg_lines = get_line_no(msg);
- for (i = 0; i < msg_lines; i++) {
- const char *line = get_line(msg, i);
- int len = get_line_length(line);
- if (msg_width < len)
- msg_width = len;
- }
-
- total_width = max(msg_width, btns_width);
- /* place dialog in middle of screen */
- y = (getmaxy(stdscr)-(msg_lines+4))/2;
- x = (getmaxx(stdscr)-(total_width+4))/2;
-
-
- /* create the windows */
- if (btn_num > 0)
- win_rows = msg_lines+4;
- else
- win_rows = msg_lines+2;
-
- win = newwin(win_rows, total_width+4, y, x);
- keypad(win, TRUE);
- menu_win = derwin(win, 1, btns_width, win_rows-2,
- 1+(total_width+2-btns_width)/2);
- menu = new_menu(btns);
- msg_win = derwin(win, win_rows-2, msg_width, 1,
- 1+(total_width+2-msg_width)/2);
-
- set_menu_fore(menu, attributes[DIALOG_MENU_FORE]);
- set_menu_back(menu, attributes[DIALOG_MENU_BACK]);
-
- (void) wattrset(win, attributes[DIALOG_BOX]);
- box(win, 0, 0);
-
- /* print message */
- (void) wattrset(msg_win, attributes[DIALOG_TEXT]);
- fill_window(msg_win, msg);
-
- set_menu_win(menu, win);
- set_menu_sub(menu, menu_win);
- set_menu_format(menu, 1, btn_num);
- menu_opts_off(menu, O_SHOWDESC);
- menu_opts_off(menu, O_SHOWMATCH);
- menu_opts_on(menu, O_ONEVALUE);
- menu_opts_on(menu, O_NONCYCLIC);
- set_menu_mark(menu, "");
- post_menu(menu);
-
-
- touchwin(win);
- refresh_all_windows(main_window);
- while ((res = wgetch(win))) {
- switch (res) {
- case KEY_LEFT:
- menu_driver(menu, REQ_LEFT_ITEM);
- break;
- case KEY_RIGHT:
- menu_driver(menu, REQ_RIGHT_ITEM);
- break;
- case 10: /* ENTER */
- case 27: /* ESCAPE */
- case ' ':
- case KEY_F(F_BACK):
- case KEY_F(F_EXIT):
- break;
- }
- touchwin(win);
- refresh_all_windows(main_window);
-
- if (res == 10 || res == ' ') {
- res = item_index(current_item(menu));
- break;
- } else if (res == 27 || res == KEY_F(F_BACK) ||
- res == KEY_F(F_EXIT)) {
- res = KEY_EXIT;
- break;
- }
- }
-
- unpost_menu(menu);
- free_menu(menu);
- for (i = 0; i < btn_num; i++)
- free_item(btns[i]);
-
- delwin(win);
- return res;
-}
-
-int dialog_inputbox(WINDOW *main_window,
- const char *title, const char *prompt,
- const char *init, char **resultp, int *result_len)
-{
- int prompt_lines = 0;
- int prompt_width = 0;
- WINDOW *win;
- WINDOW *prompt_win;
- WINDOW *form_win;
- PANEL *panel;
- int i, x, y;
- int res = -1;
- int cursor_position = strlen(init);
- int cursor_form_win;
- char *result = *resultp;
-
- if (strlen(init)+1 > *result_len) {
- *result_len = strlen(init)+1;
- *resultp = result = realloc(result, *result_len);
- }
-
- /* find the widest line of msg: */
- prompt_lines = get_line_no(prompt);
- for (i = 0; i < prompt_lines; i++) {
- const char *line = get_line(prompt, i);
- int len = get_line_length(line);
- prompt_width = max(prompt_width, len);
- }
-
- if (title)
- prompt_width = max(prompt_width, strlen(title));
-
- /* place dialog in middle of screen */
- y = (getmaxy(stdscr)-(prompt_lines+4))/2;
- x = (getmaxx(stdscr)-(prompt_width+4))/2;
-
- strncpy(result, init, *result_len);
-
- /* create the windows */
- win = newwin(prompt_lines+6, prompt_width+7, y, x);
- prompt_win = derwin(win, prompt_lines+1, prompt_width, 2, 2);
- form_win = derwin(win, 1, prompt_width, prompt_lines+3, 2);
- keypad(form_win, TRUE);
-
- (void) wattrset(form_win, attributes[INPUT_FIELD]);
-
- (void) wattrset(win, attributes[INPUT_BOX]);
- box(win, 0, 0);
- (void) wattrset(win, attributes[INPUT_HEADING]);
- if (title)
- mvwprintw(win, 0, 3, "%s", title);
-
- /* print message */
- (void) wattrset(prompt_win, attributes[INPUT_TEXT]);
- fill_window(prompt_win, prompt);
-
- mvwprintw(form_win, 0, 0, "%*s", prompt_width, " ");
- cursor_form_win = min(cursor_position, prompt_width-1);
- mvwprintw(form_win, 0, 0, "%s",
- result + cursor_position-cursor_form_win);
-
- /* create panels */
- panel = new_panel(win);
-
- /* show the cursor */
- curs_set(1);
-
- touchwin(win);
- refresh_all_windows(main_window);
- while ((res = wgetch(form_win))) {
- int len = strlen(result);
- switch (res) {
- case 10: /* ENTER */
- case 27: /* ESCAPE */
- case KEY_F(F_HELP):
- case KEY_F(F_EXIT):
- case KEY_F(F_BACK):
- break;
- case 127:
- case KEY_BACKSPACE:
- if (cursor_position > 0) {
- memmove(&result[cursor_position-1],
- &result[cursor_position],
- len-cursor_position+1);
- cursor_position--;
- cursor_form_win--;
- len--;
- }
- break;
- case KEY_DC:
- if (cursor_position >= 0 && cursor_position < len) {
- memmove(&result[cursor_position],
- &result[cursor_position+1],
- len-cursor_position+1);
- len--;
- }
- break;
- case KEY_UP:
- case KEY_RIGHT:
- if (cursor_position < len) {
- cursor_position++;
- cursor_form_win++;
- }
- break;
- case KEY_DOWN:
- case KEY_LEFT:
- if (cursor_position > 0) {
- cursor_position--;
- cursor_form_win--;
- }
- break;
- case KEY_HOME:
- cursor_position = 0;
- cursor_form_win = 0;
- break;
- case KEY_END:
- cursor_position = len;
- cursor_form_win = min(cursor_position, prompt_width-1);
- break;
- default:
- if ((isgraph(res) || isspace(res))) {
- /* one for new char, one for '\0' */
- if (len+2 > *result_len) {
- *result_len = len+2;
- *resultp = result = realloc(result,
- *result_len);
- }
- /* insert the char at the proper position */
- memmove(&result[cursor_position+1],
- &result[cursor_position],
- len-cursor_position+1);
- result[cursor_position] = res;
- cursor_position++;
- cursor_form_win++;
- len++;
- } else {
- mvprintw(0, 0, "unknown key: %d\n", res);
- }
- break;
- }
- if (cursor_form_win < 0)
- cursor_form_win = 0;
- else if (cursor_form_win > prompt_width-1)
- cursor_form_win = prompt_width-1;
-
- wmove(form_win, 0, 0);
- wclrtoeol(form_win);
- mvwprintw(form_win, 0, 0, "%*s", prompt_width, " ");
- mvwprintw(form_win, 0, 0, "%s",
- result + cursor_position-cursor_form_win);
- wmove(form_win, 0, cursor_form_win);
- touchwin(win);
- refresh_all_windows(main_window);
-
- if (res == 10) {
- res = 0;
- break;
- } else if (res == 27 || res == KEY_F(F_BACK) ||
- res == KEY_F(F_EXIT)) {
- res = KEY_EXIT;
- break;
- } else if (res == KEY_F(F_HELP)) {
- res = 1;
- break;
- }
- }
-
- /* hide the cursor */
- curs_set(0);
- del_panel(panel);
- delwin(prompt_win);
- delwin(form_win);
- delwin(win);
- return res;
-}
-
-/* refresh all windows in the correct order */
-void refresh_all_windows(WINDOW *main_window)
-{
- update_panels();
- touchwin(main_window);
- refresh();
-}
-
-/* layman's scrollable window... */
-void show_scroll_win(WINDOW *main_window,
- const char *title,
- const char *text)
-{
- int res;
- int total_lines = get_line_no(text);
- int x, y, lines, columns;
- int start_x = 0, start_y = 0;
- int text_lines = 0, text_cols = 0;
- int total_cols = 0;
- int win_cols = 0;
- int win_lines = 0;
- int i = 0;
- WINDOW *win;
- WINDOW *pad;
- PANEL *panel;
-
- getmaxyx(stdscr, lines, columns);
-
- /* find the widest line of msg: */
- total_lines = get_line_no(text);
- for (i = 0; i < total_lines; i++) {
- const char *line = get_line(text, i);
- int len = get_line_length(line);
- total_cols = max(total_cols, len+2);
- }
-
- /* create the pad */
- pad = newpad(total_lines+10, total_cols+10);
- (void) wattrset(pad, attributes[SCROLLWIN_TEXT]);
- fill_window(pad, text);
-
- win_lines = min(total_lines+4, lines-2);
- win_cols = min(total_cols+2, columns-2);
- text_lines = max(win_lines-4, 0);
- text_cols = max(win_cols-2, 0);
-
- /* place window in middle of screen */
- y = (lines-win_lines)/2;
- x = (columns-win_cols)/2;
-
- win = newwin(win_lines, win_cols, y, x);
- keypad(win, TRUE);
- /* show the help in the help window, and show the help panel */
- (void) wattrset(win, attributes[SCROLLWIN_BOX]);
- box(win, 0, 0);
- (void) wattrset(win, attributes[SCROLLWIN_HEADING]);
- mvwprintw(win, 0, 3, " %s ", title);
- panel = new_panel(win);
-
- /* handle scrolling */
- do {
-
- copywin(pad, win, start_y, start_x, 2, 2, text_lines,
- text_cols, 0);
- print_in_middle(win,
- text_lines+2,
- 0,
- text_cols,
- "<OK>",
- attributes[DIALOG_MENU_FORE]);
- wrefresh(win);
-
- res = wgetch(win);
- switch (res) {
- case KEY_NPAGE:
- case ' ':
- case 'd':
- start_y += text_lines-2;
- break;
- case KEY_PPAGE:
- case 'u':
- start_y -= text_lines+2;
- break;
- case KEY_HOME:
- start_y = 0;
- break;
- case KEY_END:
- start_y = total_lines-text_lines;
- break;
- case KEY_DOWN:
- case 'j':
- start_y++;
- break;
- case KEY_UP:
- case 'k':
- start_y--;
- break;
- case KEY_LEFT:
- case 'h':
- start_x--;
- break;
- case KEY_RIGHT:
- case 'l':
- start_x++;
- break;
- }
- if (res == 10 || res == 27 || res == 'q' ||
- res == KEY_F(F_HELP) || res == KEY_F(F_BACK) ||
- res == KEY_F(F_EXIT))
- break;
- if (start_y < 0)
- start_y = 0;
- if (start_y >= total_lines-text_lines)
- start_y = total_lines-text_lines;
- if (start_x < 0)
- start_x = 0;
- if (start_x >= total_cols-text_cols)
- start_x = total_cols-text_cols;
- } while (res);
-
- del_panel(panel);
- delwin(win);
- refresh_all_windows(main_window);
-}
+++ /dev/null
-/*
- * Copyright (C) 2008 Nir Tzachar <nir.tzachar@gmail.com?
- * Released under the terms of the GNU GPL v2.0.
- *
- * Derived from menuconfig.
- *
- */
-
-#include <ctype.h>
-#include <errno.h>
-#include <fcntl.h>
-#include <limits.h>
-#include <stdarg.h>
-#include <stdlib.h>
-#include <string.h>
-#include <unistd.h>
-#include <locale.h>
-#include <curses.h>
-#include <menu.h>
-#include <panel.h>
-#include <form.h>
-
-#include <stdio.h>
-#include <time.h>
-#include <sys/time.h>
-
-#include "ncurses.h"
-
-#define max(a, b) ({\
- typeof(a) _a = a;\
- typeof(b) _b = b;\
- _a > _b ? _a : _b; })
-
-#define min(a, b) ({\
- typeof(a) _a = a;\
- typeof(b) _b = b;\
- _a < _b ? _a : _b; })
-
-typedef enum {
- NORMAL = 1,
- MAIN_HEADING,
- MAIN_MENU_BOX,
- MAIN_MENU_FORE,
- MAIN_MENU_BACK,
- MAIN_MENU_GREY,
- MAIN_MENU_HEADING,
- SCROLLWIN_TEXT,
- SCROLLWIN_HEADING,
- SCROLLWIN_BOX,
- DIALOG_TEXT,
- DIALOG_MENU_FORE,
- DIALOG_MENU_BACK,
- DIALOG_BOX,
- INPUT_BOX,
- INPUT_HEADING,
- INPUT_TEXT,
- INPUT_FIELD,
- FUNCTION_TEXT,
- FUNCTION_HIGHLIGHT,
- ATTR_MAX
-} attributes_t;
-extern attributes_t attributes[];
-
-typedef enum {
- F_HELP = 1,
- F_SYMBOL = 2,
- F_INSTS = 3,
- F_CONF = 4,
- F_BACK = 5,
- F_SAVE = 6,
- F_LOAD = 7,
- F_SEARCH = 8,
- F_EXIT = 9,
-} function_key;
-
-void set_colors(void);
-
-/* this changes the windows attributes !!! */
-void print_in_middle(WINDOW *win,
- int starty,
- int startx,
- int width,
- const char *string,
- chtype color);
-int get_line_length(const char *line);
-int get_line_no(const char *text);
-const char *get_line(const char *text, int line_no);
-void fill_window(WINDOW *win, const char *text);
-int btn_dialog(WINDOW *main_window, const char *msg, int btn_num, ...);
-int dialog_inputbox(WINDOW *main_window,
- const char *title, const char *prompt,
- const char *init, char **resultp, int *result_len);
-void refresh_all_windows(WINDOW *main_window);
-void show_scroll_win(WINDOW *main_window,
- const char *title,
- const char *text);
+++ /dev/null
-/*
- * Copyright (C) 2002 Roman Zippel <zippel@linux-m68k.org>
- * Copyright (C) 2015 Boris Barbulovski <bbarbulovski@gmail.com>
- * Released under the terms of the GNU GPL v2.0.
- */
-
-#include <qglobal.h>
-
-#include <QMainWindow>
-#include <QList>
-#include <qtextbrowser.h>
-#include <QAction>
-#include <QFileDialog>
-#include <QMenu>
-
-#include <qapplication.h>
-#include <qdesktopwidget.h>
-#include <qtoolbar.h>
-#include <qlayout.h>
-#include <qsplitter.h>
-#include <qlineedit.h>
-#include <qlabel.h>
-#include <qpushbutton.h>
-#include <qmenubar.h>
-#include <qmessagebox.h>
-#include <qregexp.h>
-#include <qevent.h>
-
-#include <stdlib.h>
-
-#include "lkc.h"
-#include "qconf.h"
-
-#include "qconf.moc"
-#include "images.c"
-
-#ifdef _
-# undef _
-# define _ qgettext
-#endif
-
-static QApplication *configApp;
-static ConfigSettings *configSettings;
-
-QAction *ConfigMainWindow::saveAction;
-
-static inline QString qgettext(const char* str)
-{
- return QString::fromLocal8Bit(gettext(str));
-}
-
-static inline QString qgettext(const QString& str)
-{
- return QString::fromLocal8Bit(gettext(str.toLatin1()));
-}
-
-ConfigSettings::ConfigSettings()
- : QSettings("kernel.org", "qconf")
-{
-}
-
-/**
- * Reads a list of integer values from the application settings.
- */
-QList<int> ConfigSettings::readSizes(const QString& key, bool *ok)
-{
- QList<int> result;
- QStringList entryList = value(key).toStringList();
- QStringList::Iterator it;
-
- for (it = entryList.begin(); it != entryList.end(); ++it)
- result.push_back((*it).toInt());
-
- return result;
-}
-
-/**
- * Writes a list of integer values to the application settings.
- */
-bool ConfigSettings::writeSizes(const QString& key, const QList<int>& value)
-{
- QStringList stringList;
- QList<int>::ConstIterator it;
-
- for (it = value.begin(); it != value.end(); ++it)
- stringList.push_back(QString::number(*it));
- setValue(key, stringList);
-
- return true;
-}
-
-
-/*
- * set the new data
- * TODO check the value
- */
-void ConfigItem::okRename(int col)
-{
-}
-
-/*
- * update the displayed of a menu entry
- */
-void ConfigItem::updateMenu(void)
-{
- ConfigList* list;
- struct symbol* sym;
- struct property *prop;
- QString prompt;
- int type;
- tristate expr;
-
- list = listView();
- if (goParent) {
- setPixmap(promptColIdx, list->menuBackPix);
- prompt = "..";
- goto set_prompt;
- }
-
- sym = menu->sym;
- prop = menu->prompt;
- prompt = _(menu_get_prompt(menu));
-
- if (prop) switch (prop->type) {
- case P_MENU:
- if (list->mode == singleMode || list->mode == symbolMode) {
- /* a menuconfig entry is displayed differently
- * depending whether it's at the view root or a child.
- */
- if (sym && list->rootEntry == menu)
- break;
- setPixmap(promptColIdx, list->menuPix);
- } else {
- if (sym)
- break;
- setPixmap(promptColIdx, QIcon());
- }
- goto set_prompt;
- case P_COMMENT:
- setPixmap(promptColIdx, QIcon());
- goto set_prompt;
- default:
- ;
- }
- if (!sym)
- goto set_prompt;
-
- setText(nameColIdx, QString::fromLocal8Bit(sym->name));
-
- type = sym_get_type(sym);
- switch (type) {
- case S_BOOLEAN:
- case S_TRISTATE:
- char ch;
-
- if (!sym_is_changable(sym) && list->optMode == normalOpt) {
- setPixmap(promptColIdx, QIcon());
- setText(noColIdx, QString::null);
- setText(modColIdx, QString::null);
- setText(yesColIdx, QString::null);
- break;
- }
- expr = sym_get_tristate_value(sym);
- switch (expr) {
- case yes:
- if (sym_is_choice_value(sym) && type == S_BOOLEAN)
- setPixmap(promptColIdx, list->choiceYesPix);
- else
- setPixmap(promptColIdx, list->symbolYesPix);
- setText(yesColIdx, "Y");
- ch = 'Y';
- break;
- case mod:
- setPixmap(promptColIdx, list->symbolModPix);
- setText(modColIdx, "M");
- ch = 'M';
- break;
- default:
- if (sym_is_choice_value(sym) && type == S_BOOLEAN)
- setPixmap(promptColIdx, list->choiceNoPix);
- else
- setPixmap(promptColIdx, list->symbolNoPix);
- setText(noColIdx, "N");
- ch = 'N';
- break;
- }
- if (expr != no)
- setText(noColIdx, sym_tristate_within_range(sym, no) ? "_" : 0);
- if (expr != mod)
- setText(modColIdx, sym_tristate_within_range(sym, mod) ? "_" : 0);
- if (expr != yes)
- setText(yesColIdx, sym_tristate_within_range(sym, yes) ? "_" : 0);
-
- setText(dataColIdx, QChar(ch));
- break;
- case S_INT:
- case S_HEX:
- case S_STRING:
- const char* data;
-
- data = sym_get_string_value(sym);
-
- setText(dataColIdx, data);
- if (type == S_STRING)
- prompt = QString("%1: %2").arg(prompt).arg(data);
- else
- prompt = QString("(%2) %1").arg(prompt).arg(data);
- break;
- }
- if (!sym_has_value(sym) && visible)
- prompt += _(" (NEW)");
-set_prompt:
- setText(promptColIdx, prompt);
-}
-
-void ConfigItem::testUpdateMenu(bool v)
-{
- ConfigItem* i;
-
- visible = v;
- if (!menu)
- return;
-
- sym_calc_value(menu->sym);
- if (menu->flags & MENU_CHANGED) {
- /* the menu entry changed, so update all list items */
- menu->flags &= ~MENU_CHANGED;
- for (i = (ConfigItem*)menu->data; i; i = i->nextItem)
- i->updateMenu();
- } else if (listView()->updateAll)
- updateMenu();
-}
-
-
-/*
- * construct a menu entry
- */
-void ConfigItem::init(void)
-{
- if (menu) {
- ConfigList* list = listView();
- nextItem = (ConfigItem*)menu->data;
- menu->data = this;
-
- if (list->mode != fullMode)
- setExpanded(true);
- sym_calc_value(menu->sym);
- }
- updateMenu();
-}
-
-/*
- * destruct a menu entry
- */
-ConfigItem::~ConfigItem(void)
-{
- if (menu) {
- ConfigItem** ip = (ConfigItem**)&menu->data;
- for (; *ip; ip = &(*ip)->nextItem) {
- if (*ip == this) {
- *ip = nextItem;
- break;
- }
- }
- }
-}
-
-ConfigLineEdit::ConfigLineEdit(ConfigView* parent)
- : Parent(parent)
-{
- connect(this, SIGNAL(editingFinished()), SLOT(hide()));
-}
-
-void ConfigLineEdit::show(ConfigItem* i)
-{
- item = i;
- if (sym_get_string_value(item->menu->sym))
- setText(QString::fromLocal8Bit(sym_get_string_value(item->menu->sym)));
- else
- setText(QString::null);
- Parent::show();
- setFocus();
-}
-
-void ConfigLineEdit::keyPressEvent(QKeyEvent* e)
-{
- switch (e->key()) {
- case Qt::Key_Escape:
- break;
- case Qt::Key_Return:
- case Qt::Key_Enter:
- sym_set_string_value(item->menu->sym, text().toLatin1());
- parent()->updateList(item);
- break;
- default:
- Parent::keyPressEvent(e);
- return;
- }
- e->accept();
- parent()->list->setFocus();
- hide();
-}
-
-ConfigList::ConfigList(ConfigView* p, const char *name)
- : Parent(p),
- updateAll(false),
- symbolYesPix(xpm_symbol_yes), symbolModPix(xpm_symbol_mod), symbolNoPix(xpm_symbol_no),
- choiceYesPix(xpm_choice_yes), choiceNoPix(xpm_choice_no),
- menuPix(xpm_menu), menuInvPix(xpm_menu_inv), menuBackPix(xpm_menuback), voidPix(xpm_void),
- showName(false), showRange(false), showData(false), mode(singleMode), optMode(normalOpt),
- rootEntry(0), headerPopup(0)
-{
- int i;
-
- setObjectName(name);
- setSortingEnabled(false);
- setRootIsDecorated(true);
-
- setVerticalScrollMode(ScrollPerPixel);
- setHorizontalScrollMode(ScrollPerPixel);
-
- setHeaderLabels(QStringList() << _("Option") << _("Name") << "N" << "M" << "Y" << _("Value"));
-
- connect(this, SIGNAL(itemSelectionChanged(void)),
- SLOT(updateSelection(void)));
-
- if (name) {
- configSettings->beginGroup(name);
- showName = configSettings->value("/showName", false).toBool();
- showRange = configSettings->value("/showRange", false).toBool();
- showData = configSettings->value("/showData", false).toBool();
- optMode = (enum optionMode)configSettings->value("/optionMode", 0).toInt();
- configSettings->endGroup();
- connect(configApp, SIGNAL(aboutToQuit()), SLOT(saveSettings()));
- }
-
- addColumn(promptColIdx);
-
- reinit();
-}
-
-bool ConfigList::menuSkip(struct menu *menu)
-{
- if (optMode == normalOpt && menu_is_visible(menu))
- return false;
- if (optMode == promptOpt && menu_has_prompt(menu))
- return false;
- if (optMode == allOpt)
- return false;
- return true;
-}
-
-void ConfigList::reinit(void)
-{
- removeColumn(dataColIdx);
- removeColumn(yesColIdx);
- removeColumn(modColIdx);
- removeColumn(noColIdx);
- removeColumn(nameColIdx);
-
- if (showName)
- addColumn(nameColIdx);
- if (showRange) {
- addColumn(noColIdx);
- addColumn(modColIdx);
- addColumn(yesColIdx);
- }
- if (showData)
- addColumn(dataColIdx);
-
- updateListAll();
-}
-
-void ConfigList::saveSettings(void)
-{
- if (!objectName().isEmpty()) {
- configSettings->beginGroup(objectName());
- configSettings->setValue("/showName", showName);
- configSettings->setValue("/showRange", showRange);
- configSettings->setValue("/showData", showData);
- configSettings->setValue("/optionMode", (int)optMode);
- configSettings->endGroup();
- }
-}
-
-ConfigItem* ConfigList::findConfigItem(struct menu *menu)
-{
- ConfigItem* item = (ConfigItem*)menu->data;
-
- for (; item; item = item->nextItem) {
- if (this == item->listView())
- break;
- }
-
- return item;
-}
-
-void ConfigList::updateSelection(void)
-{
- struct menu *menu;
- enum prop_type type;
-
- if (selectedItems().count() == 0)
- return;
-
- ConfigItem* item = (ConfigItem*)selectedItems().first();
- if (!item)
- return;
-
- menu = item->menu;
- emit menuChanged(menu);
- if (!menu)
- return;
- type = menu->prompt ? menu->prompt->type : P_UNKNOWN;
- if (mode == menuMode && type == P_MENU)
- emit menuSelected(menu);
-}
-
-void ConfigList::updateList(ConfigItem* item)
-{
- ConfigItem* last = 0;
-
- if (!rootEntry) {
- if (mode != listMode)
- goto update;
- QTreeWidgetItemIterator it(this);
- ConfigItem* item;
-
- while (*it) {
- item = (ConfigItem*)(*it);
- if (!item->menu)
- continue;
- item->testUpdateMenu(menu_is_visible(item->menu));
-
- ++it;
- }
- return;
- }
-
- if (rootEntry != &rootmenu && (mode == singleMode ||
- (mode == symbolMode && rootEntry->parent != &rootmenu))) {
- item = (ConfigItem *)topLevelItem(0);
- if (!item)
- item = new ConfigItem(this, 0, true);
- last = item;
- }
- if ((mode == singleMode || (mode == symbolMode && !(rootEntry->flags & MENU_ROOT))) &&
- rootEntry->sym && rootEntry->prompt) {
- item = last ? last->nextSibling() : firstChild();
- if (!item)
- item = new ConfigItem(this, last, rootEntry, true);
- else
- item->testUpdateMenu(true);
-
- updateMenuList(item, rootEntry);
- update();
- resizeColumnToContents(0);
- return;
- }
-update:
- updateMenuList(this, rootEntry);
- update();
- resizeColumnToContents(0);
-}
-
-void ConfigList::setValue(ConfigItem* item, tristate val)
-{
- struct symbol* sym;
- int type;
- tristate oldval;
-
- sym = item->menu ? item->menu->sym : 0;
- if (!sym)
- return;
-
- type = sym_get_type(sym);
- switch (type) {
- case S_BOOLEAN:
- case S_TRISTATE:
- oldval = sym_get_tristate_value(sym);
-
- if (!sym_set_tristate_value(sym, val))
- return;
- if (oldval == no && item->menu->list)
- item->setExpanded(true);
- parent()->updateList(item);
- break;
- }
-}
-
-void ConfigList::changeValue(ConfigItem* item)
-{
- struct symbol* sym;
- struct menu* menu;
- int type, oldexpr, newexpr;
-
- menu = item->menu;
- if (!menu)
- return;
- sym = menu->sym;
- if (!sym) {
- if (item->menu->list)
- item->setExpanded(!item->isExpanded());
- return;
- }
-
- type = sym_get_type(sym);
- switch (type) {
- case S_BOOLEAN:
- case S_TRISTATE:
- oldexpr = sym_get_tristate_value(sym);
- newexpr = sym_toggle_tristate_value(sym);
- if (item->menu->list) {
- if (oldexpr == newexpr)
- item->setExpanded(!item->isExpanded());
- else if (oldexpr == no)
- item->setExpanded(true);
- }
- if (oldexpr != newexpr)
- parent()->updateList(item);
- break;
- case S_INT:
- case S_HEX:
- case S_STRING:
- parent()->lineEdit->show(item);
- break;
- }
-}
-
-void ConfigList::setRootMenu(struct menu *menu)
-{
- enum prop_type type;
-
- if (rootEntry == menu)
- return;
- type = menu && menu->prompt ? menu->prompt->type : P_UNKNOWN;
- if (type != P_MENU)
- return;
- updateMenuList(this, 0);
- rootEntry = menu;
- updateListAll();
- if (currentItem()) {
- currentItem()->setSelected(hasFocus());
- scrollToItem(currentItem());
- }
-}
-
-void ConfigList::setParentMenu(void)
-{
- ConfigItem* item;
- struct menu *oldroot;
-
- oldroot = rootEntry;
- if (rootEntry == &rootmenu)
- return;
- setRootMenu(menu_get_parent_menu(rootEntry->parent));
-
- QTreeWidgetItemIterator it(this);
- while (*it) {
- item = (ConfigItem *)(*it);
- if (item->menu == oldroot) {
- setCurrentItem(item);
- scrollToItem(item);
- break;
- }
-
- ++it;
- }
-}
-
-/*
- * update all the children of a menu entry
- * removes/adds the entries from the parent widget as necessary
- *
- * parent: either the menu list widget or a menu entry widget
- * menu: entry to be updated
- */
-void ConfigList::updateMenuList(ConfigItem *parent, struct menu* menu)
-{
- struct menu* child;
- ConfigItem* item;
- ConfigItem* last;
- bool visible;
- enum prop_type type;
-
- if (!menu) {
- while (parent->childCount() > 0)
- {
- delete parent->takeChild(0);
- }
-
- return;
- }
-
- last = parent->firstChild();
- if (last && !last->goParent)
- last = 0;
- for (child = menu->list; child; child = child->next) {
- item = last ? last->nextSibling() : parent->firstChild();
- type = child->prompt ? child->prompt->type : P_UNKNOWN;
-
- switch (mode) {
- case menuMode:
- if (!(child->flags & MENU_ROOT))
- goto hide;
- break;
- case symbolMode:
- if (child->flags & MENU_ROOT)
- goto hide;
- break;
- default:
- break;
- }
-
- visible = menu_is_visible(child);
- if (!menuSkip(child)) {
- if (!child->sym && !child->list && !child->prompt)
- continue;
- if (!item || item->menu != child)
- item = new ConfigItem(parent, last, child, visible);
- else
- item->testUpdateMenu(visible);
-
- if (mode == fullMode || mode == menuMode || type != P_MENU)
- updateMenuList(item, child);
- else
- updateMenuList(item, 0);
- last = item;
- continue;
- }
- hide:
- if (item && item->menu == child) {
- last = parent->firstChild();
- if (last == item)
- last = 0;
- else while (last->nextSibling() != item)
- last = last->nextSibling();
- delete item;
- }
- }
-}
-
-void ConfigList::updateMenuList(ConfigList *parent, struct menu* menu)
-{
- struct menu* child;
- ConfigItem* item;
- ConfigItem* last;
- bool visible;
- enum prop_type type;
-
- if (!menu) {
- while (parent->topLevelItemCount() > 0)
- {
- delete parent->takeTopLevelItem(0);
- }
-
- return;
- }
-
- last = (ConfigItem*)parent->topLevelItem(0);
- if (last && !last->goParent)
- last = 0;
- for (child = menu->list; child; child = child->next) {
- item = last ? last->nextSibling() : (ConfigItem*)parent->topLevelItem(0);
- type = child->prompt ? child->prompt->type : P_UNKNOWN;
-
- switch (mode) {
- case menuMode:
- if (!(child->flags & MENU_ROOT))
- goto hide;
- break;
- case symbolMode:
- if (child->flags & MENU_ROOT)
- goto hide;
- break;
- default:
- break;
- }
-
- visible = menu_is_visible(child);
- if (!menuSkip(child)) {
- if (!child->sym && !child->list && !child->prompt)
- continue;
- if (!item || item->menu != child)
- item = new ConfigItem(parent, last, child, visible);
- else
- item->testUpdateMenu(visible);
-
- if (mode == fullMode || mode == menuMode || type != P_MENU)
- updateMenuList(item, child);
- else
- updateMenuList(item, 0);
- last = item;
- continue;
- }
- hide:
- if (item && item->menu == child) {
- last = (ConfigItem*)parent->topLevelItem(0);
- if (last == item)
- last = 0;
- else while (last->nextSibling() != item)
- last = last->nextSibling();
- delete item;
- }
- }
-}
-
-void ConfigList::keyPressEvent(QKeyEvent* ev)
-{
- QTreeWidgetItem* i = currentItem();
- ConfigItem* item;
- struct menu *menu;
- enum prop_type type;
-
- if (ev->key() == Qt::Key_Escape && mode != fullMode && mode != listMode) {
- emit parentSelected();
- ev->accept();
- return;
- }
-
- if (!i) {
- Parent::keyPressEvent(ev);
- return;
- }
- item = (ConfigItem*)i;
-
- switch (ev->key()) {
- case Qt::Key_Return:
- case Qt::Key_Enter:
- if (item->goParent) {
- emit parentSelected();
- break;
- }
- menu = item->menu;
- if (!menu)
- break;
- type = menu->prompt ? menu->prompt->type : P_UNKNOWN;
- if (type == P_MENU && rootEntry != menu &&
- mode != fullMode && mode != menuMode) {
- emit menuSelected(menu);
- break;
- }
- case Qt::Key_Space:
- changeValue(item);
- break;
- case Qt::Key_N:
- setValue(item, no);
- break;
- case Qt::Key_M:
- setValue(item, mod);
- break;
- case Qt::Key_Y:
- setValue(item, yes);
- break;
- default:
- Parent::keyPressEvent(ev);
- return;
- }
- ev->accept();
-}
-
-void ConfigList::mousePressEvent(QMouseEvent* e)
-{
- //QPoint p(contentsToViewport(e->pos()));
- //printf("contentsMousePressEvent: %d,%d\n", p.x(), p.y());
- Parent::mousePressEvent(e);
-}
-
-void ConfigList::mouseReleaseEvent(QMouseEvent* e)
-{
- QPoint p = e->pos();
- ConfigItem* item = (ConfigItem*)itemAt(p);
- struct menu *menu;
- enum prop_type ptype;
- QIcon icon;
- int idx, x;
-
- if (!item)
- goto skip;
-
- menu = item->menu;
- x = header()->offset() + p.x();
- idx = header()->logicalIndexAt(x);
- switch (idx) {
- case promptColIdx:
- icon = item->pixmap(promptColIdx);
- if (!icon.isNull()) {
- int off = header()->sectionPosition(0) + visualRect(indexAt(p)).x() + 4; // 4 is Hardcoded image offset. There might be a way to do it properly.
- if (x >= off && x < off + icon.availableSizes().first().width()) {
- if (item->goParent) {
- emit parentSelected();
- break;
- } else if (!menu)
- break;
- ptype = menu->prompt ? menu->prompt->type : P_UNKNOWN;
- if (ptype == P_MENU && rootEntry != menu &&
- mode != fullMode && mode != menuMode)
- emit menuSelected(menu);
- else
- changeValue(item);
- }
- }
- break;
- case noColIdx:
- setValue(item, no);
- break;
- case modColIdx:
- setValue(item, mod);
- break;
- case yesColIdx:
- setValue(item, yes);
- break;
- case dataColIdx:
- changeValue(item);
- break;
- }
-
-skip:
- //printf("contentsMouseReleaseEvent: %d,%d\n", p.x(), p.y());
- Parent::mouseReleaseEvent(e);
-}
-
-void ConfigList::mouseMoveEvent(QMouseEvent* e)
-{
- //QPoint p(contentsToViewport(e->pos()));
- //printf("contentsMouseMoveEvent: %d,%d\n", p.x(), p.y());
- Parent::mouseMoveEvent(e);
-}
-
-void ConfigList::mouseDoubleClickEvent(QMouseEvent* e)
-{
- QPoint p = e->pos(); // TODO: Check if this works(was contentsToViewport).
- ConfigItem* item = (ConfigItem*)itemAt(p);
- struct menu *menu;
- enum prop_type ptype;
-
- if (!item)
- goto skip;
- if (item->goParent) {
- emit parentSelected();
- goto skip;
- }
- menu = item->menu;
- if (!menu)
- goto skip;
- ptype = menu->prompt ? menu->prompt->type : P_UNKNOWN;
- if (ptype == P_MENU && (mode == singleMode || mode == symbolMode))
- emit menuSelected(menu);
- else if (menu->sym)
- changeValue(item);
-
-skip:
- //printf("contentsMouseDoubleClickEvent: %d,%d\n", p.x(), p.y());
- Parent::mouseDoubleClickEvent(e);
-}
-
-void ConfigList::focusInEvent(QFocusEvent *e)
-{
- struct menu *menu = NULL;
-
- Parent::focusInEvent(e);
-
- ConfigItem* item = (ConfigItem *)currentItem();
- if (item) {
- item->setSelected(true);
- menu = item->menu;
- }
- emit gotFocus(menu);
-}
-
-void ConfigList::contextMenuEvent(QContextMenuEvent *e)
-{
- if (e->y() <= header()->geometry().bottom()) {
- if (!headerPopup) {
- QAction *action;
-
- headerPopup = new QMenu(this);
- action = new QAction(_("Show Name"), this);
- action->setCheckable(true);
- connect(action, SIGNAL(toggled(bool)),
- parent(), SLOT(setShowName(bool)));
- connect(parent(), SIGNAL(showNameChanged(bool)),
- action, SLOT(setOn(bool)));
- action->setChecked(showName);
- headerPopup->addAction(action);
- action = new QAction(_("Show Range"), this);
- action->setCheckable(true);
- connect(action, SIGNAL(toggled(bool)),
- parent(), SLOT(setShowRange(bool)));
- connect(parent(), SIGNAL(showRangeChanged(bool)),
- action, SLOT(setOn(bool)));
- action->setChecked(showRange);
- headerPopup->addAction(action);
- action = new QAction(_("Show Data"), this);
- action->setCheckable(true);
- connect(action, SIGNAL(toggled(bool)),
- parent(), SLOT(setShowData(bool)));
- connect(parent(), SIGNAL(showDataChanged(bool)),
- action, SLOT(setOn(bool)));
- action->setChecked(showData);
- headerPopup->addAction(action);
- }
- headerPopup->exec(e->globalPos());
- e->accept();
- } else
- e->ignore();
-}
-
-ConfigView*ConfigView::viewList;
-QAction *ConfigView::showNormalAction;
-QAction *ConfigView::showAllAction;
-QAction *ConfigView::showPromptAction;
-
-ConfigView::ConfigView(QWidget* parent, const char *name)
- : Parent(parent)
-{
- setObjectName(name);
- QVBoxLayout *verticalLayout = new QVBoxLayout(this);
- verticalLayout->setContentsMargins(0, 0, 0, 0);
-
- list = new ConfigList(this);
- verticalLayout->addWidget(list);
- lineEdit = new ConfigLineEdit(this);
- lineEdit->hide();
- verticalLayout->addWidget(lineEdit);
-
- this->nextView = viewList;
- viewList = this;
-}
-
-ConfigView::~ConfigView(void)
-{
- ConfigView** vp;
-
- for (vp = &viewList; *vp; vp = &(*vp)->nextView) {
- if (*vp == this) {
- *vp = nextView;
- break;
- }
- }
-}
-
-void ConfigView::setOptionMode(QAction *act)
-{
- if (act == showNormalAction)
- list->optMode = normalOpt;
- else if (act == showAllAction)
- list->optMode = allOpt;
- else
- list->optMode = promptOpt;
-
- list->updateListAll();
-}
-
-void ConfigView::setShowName(bool b)
-{
- if (list->showName != b) {
- list->showName = b;
- list->reinit();
- emit showNameChanged(b);
- }
-}
-
-void ConfigView::setShowRange(bool b)
-{
- if (list->showRange != b) {
- list->showRange = b;
- list->reinit();
- emit showRangeChanged(b);
- }
-}
-
-void ConfigView::setShowData(bool b)
-{
- if (list->showData != b) {
- list->showData = b;
- list->reinit();
- emit showDataChanged(b);
- }
-}
-
-void ConfigList::setAllOpen(bool open)
-{
- QTreeWidgetItemIterator it(this);
-
- while (*it) {
- (*it)->setExpanded(open);
-
- ++it;
- }
-}
-
-void ConfigView::updateList(ConfigItem* item)
-{
- ConfigView* v;
-
- for (v = viewList; v; v = v->nextView)
- v->list->updateList(item);
-}
-
-void ConfigView::updateListAll(void)
-{
- ConfigView* v;
-
- for (v = viewList; v; v = v->nextView)
- v->list->updateListAll();
-}
-
-ConfigInfoView::ConfigInfoView(QWidget* parent, const char *name)
- : Parent(parent), sym(0), _menu(0)
-{
- setObjectName(name);
-
-
- if (!objectName().isEmpty()) {
- configSettings->beginGroup(objectName());
- _showDebug = configSettings->value("/showDebug", false).toBool();
- configSettings->endGroup();
- connect(configApp, SIGNAL(aboutToQuit()), SLOT(saveSettings()));
- }
-}
-
-void ConfigInfoView::saveSettings(void)
-{
- if (!objectName().isEmpty()) {
- configSettings->beginGroup(objectName());
- configSettings->setValue("/showDebug", showDebug());
- configSettings->endGroup();
- }
-}
-
-void ConfigInfoView::setShowDebug(bool b)
-{
- if (_showDebug != b) {
- _showDebug = b;
- if (_menu)
- menuInfo();
- else if (sym)
- symbolInfo();
- emit showDebugChanged(b);
- }
-}
-
-void ConfigInfoView::setInfo(struct menu *m)
-{
- if (_menu == m)
- return;
- _menu = m;
- sym = NULL;
- if (!_menu)
- clear();
- else
- menuInfo();
-}
-
-void ConfigInfoView::symbolInfo(void)
-{
- QString str;
-
- str += "<big>Symbol: <b>";
- str += print_filter(sym->name);
- str += "</b></big><br><br>value: ";
- str += print_filter(sym_get_string_value(sym));
- str += "<br>visibility: ";
- str += sym->visible == yes ? "y" : sym->visible == mod ? "m" : "n";
- str += "<br>";
- str += debug_info(sym);
-
- setText(str);
-}
-
-void ConfigInfoView::menuInfo(void)
-{
- struct symbol* sym;
- QString head, debug, help;
-
- sym = _menu->sym;
- if (sym) {
- if (_menu->prompt) {
- head += "<big><b>";
- head += print_filter(_(_menu->prompt->text));
- head += "</b></big>";
- if (sym->name) {
- head += " (";
- if (showDebug())
- head += QString().sprintf("<a href=\"s%p\">", sym);
- head += print_filter(sym->name);
- if (showDebug())
- head += "</a>";
- head += ")";
- }
- } else if (sym->name) {
- head += "<big><b>";
- if (showDebug())
- head += QString().sprintf("<a href=\"s%p\">", sym);
- head += print_filter(sym->name);
- if (showDebug())
- head += "</a>";
- head += "</b></big>";
- }
- head += "<br><br>";
-
- if (showDebug())
- debug = debug_info(sym);
-
- struct gstr help_gstr = str_new();
- menu_get_ext_help(_menu, &help_gstr);
- help = print_filter(str_get(&help_gstr));
- str_free(&help_gstr);
- } else if (_menu->prompt) {
- head += "<big><b>";
- head += print_filter(_(_menu->prompt->text));
- head += "</b></big><br><br>";
- if (showDebug()) {
- if (_menu->prompt->visible.expr) {
- debug += " dep: ";
- expr_print(_menu->prompt->visible.expr, expr_print_help, &debug, E_NONE);
- debug += "<br><br>";
- }
- }
- }
- if (showDebug())
- debug += QString().sprintf("defined at %s:%d<br><br>", _menu->file->name, _menu->lineno);
-
- setText(head + debug + help);
-}
-
-QString ConfigInfoView::debug_info(struct symbol *sym)
-{
- QString debug;
-
- debug += "type: ";
- debug += print_filter(sym_type_name(sym->type));
- if (sym_is_choice(sym))
- debug += " (choice)";
- debug += "<br>";
- if (sym->rev_dep.expr) {
- debug += "reverse dep: ";
- expr_print(sym->rev_dep.expr, expr_print_help, &debug, E_NONE);
- debug += "<br>";
- }
- for (struct property *prop = sym->prop; prop; prop = prop->next) {
- switch (prop->type) {
- case P_PROMPT:
- case P_MENU:
- debug += QString().sprintf("prompt: <a href=\"m%p\">", prop->menu);
- debug += print_filter(_(prop->text));
- debug += "</a><br>";
- break;
- case P_DEFAULT:
- case P_SELECT:
- case P_RANGE:
- case P_ENV:
- debug += prop_get_type_name(prop->type);
- debug += ": ";
- expr_print(prop->expr, expr_print_help, &debug, E_NONE);
- debug += "<br>";
- break;
- case P_CHOICE:
- if (sym_is_choice(sym)) {
- debug += "choice: ";
- expr_print(prop->expr, expr_print_help, &debug, E_NONE);
- debug += "<br>";
- }
- break;
- default:
- debug += "unknown property: ";
- debug += prop_get_type_name(prop->type);
- debug += "<br>";
- }
- if (prop->visible.expr) {
- debug += " dep: ";
- expr_print(prop->visible.expr, expr_print_help, &debug, E_NONE);
- debug += "<br>";
- }
- }
- debug += "<br>";
-
- return debug;
-}
-
-QString ConfigInfoView::print_filter(const QString &str)
-{
- QRegExp re("[<>&\"\\n]");
- QString res = str;
- for (int i = 0; (i = res.indexOf(re, i)) >= 0;) {
- switch (res[i].toLatin1()) {
- case '<':
- res.replace(i, 1, "<");
- i += 4;
- break;
- case '>':
- res.replace(i, 1, ">");
- i += 4;
- break;
- case '&':
- res.replace(i, 1, "&");
- i += 5;
- break;
- case '"':
- res.replace(i, 1, """);
- i += 6;
- break;
- case '\n':
- res.replace(i, 1, "<br>");
- i += 4;
- break;
- }
- }
- return res;
-}
-
-void ConfigInfoView::expr_print_help(void *data, struct symbol *sym, const char *str)
-{
- QString* text = reinterpret_cast<QString*>(data);
- QString str2 = print_filter(str);
-
- if (sym && sym->name && !(sym->flags & SYMBOL_CONST)) {
- *text += QString().sprintf("<a href=\"s%p\">", sym);
- *text += str2;
- *text += "</a>";
- } else
- *text += str2;
-}
-
-QMenu* ConfigInfoView::createStandardContextMenu(const QPoint & pos)
-{
- QMenu* popup = Parent::createStandardContextMenu(pos);
- QAction* action = new QAction(_("Show Debug Info"), popup);
- action->setCheckable(true);
- connect(action, SIGNAL(toggled(bool)), SLOT(setShowDebug(bool)));
- connect(this, SIGNAL(showDebugChanged(bool)), action, SLOT(setOn(bool)));
- action->setChecked(showDebug());
- popup->addSeparator();
- popup->addAction(action);
- return popup;
-}
-
-void ConfigInfoView::contextMenuEvent(QContextMenuEvent *e)
-{
- Parent::contextMenuEvent(e);
-}
-
-ConfigSearchWindow::ConfigSearchWindow(ConfigMainWindow* parent, const char *name)
- : Parent(parent), result(NULL)
-{
- setObjectName(name);
- setWindowTitle("Search Config");
-
- QVBoxLayout* layout1 = new QVBoxLayout(this);
- layout1->setContentsMargins(11, 11, 11, 11);
- layout1->setSpacing(6);
- QHBoxLayout* layout2 = new QHBoxLayout(0);
- layout2->setContentsMargins(0, 0, 0, 0);
- layout2->setSpacing(6);
- layout2->addWidget(new QLabel(_("Find:"), this));
- editField = new QLineEdit(this);
- connect(editField, SIGNAL(returnPressed()), SLOT(search()));
- layout2->addWidget(editField);
- searchButton = new QPushButton(_("Search"), this);
- searchButton->setAutoDefault(false);
- connect(searchButton, SIGNAL(clicked()), SLOT(search()));
- layout2->addWidget(searchButton);
- layout1->addLayout(layout2);
-
- split = new QSplitter(this);
- split->setOrientation(Qt::Vertical);
- list = new ConfigView(split, name);
- list->list->mode = listMode;
- info = new ConfigInfoView(split, name);
- connect(list->list, SIGNAL(menuChanged(struct menu *)),
- info, SLOT(setInfo(struct menu *)));
- connect(list->list, SIGNAL(menuChanged(struct menu *)),
- parent, SLOT(setMenuLink(struct menu *)));
-
- layout1->addWidget(split);
-
- if (name) {
- QVariant x, y;
- int width, height;
- bool ok;
-
- configSettings->beginGroup(name);
- width = configSettings->value("/window width", parent->width() / 2).toInt();
- height = configSettings->value("/window height", parent->height() / 2).toInt();
- resize(width, height);
- x = configSettings->value("/window x");
- y = configSettings->value("/window y");
- if ((x.isValid())&&(y.isValid()))
- move(x.toInt(), y.toInt());
- QList<int> sizes = configSettings->readSizes("/split", &ok);
- if (ok)
- split->setSizes(sizes);
- configSettings->endGroup();
- connect(configApp, SIGNAL(aboutToQuit()), SLOT(saveSettings()));
- }
-}
-
-void ConfigSearchWindow::saveSettings(void)
-{
- if (!objectName().isEmpty()) {
- configSettings->beginGroup(objectName());
- configSettings->setValue("/window x", pos().x());
- configSettings->setValue("/window y", pos().y());
- configSettings->setValue("/window width", size().width());
- configSettings->setValue("/window height", size().height());
- configSettings->writeSizes("/split", split->sizes());
- configSettings->endGroup();
- }
-}
-
-void ConfigSearchWindow::search(void)
-{
- struct symbol **p;
- struct property *prop;
- ConfigItem *lastItem = NULL;
-
- free(result);
- list->list->clear();
- info->clear();
-
- result = sym_re_search(editField->text().toLatin1());
- if (!result)
- return;
- for (p = result; *p; p++) {
- for_all_prompts((*p), prop)
- lastItem = new ConfigItem(list->list, lastItem, prop->menu,
- menu_is_visible(prop->menu));
- }
-}
-
-/*
- * Construct the complete config widget
- */
-ConfigMainWindow::ConfigMainWindow(void)
- : searchWindow(0)
-{
- QMenuBar* menu;
- bool ok = true;
- QVariant x, y;
- int width, height;
- char title[256];
-
- QDesktopWidget *d = configApp->desktop();
- snprintf(title, sizeof(title), "%s%s",
- rootmenu.prompt->text,
- ""
- );
- setWindowTitle(title);
-
- width = configSettings->value("/window width", d->width() - 64).toInt();
- height = configSettings->value("/window height", d->height() - 64).toInt();
- resize(width, height);
- x = configSettings->value("/window x");
- y = configSettings->value("/window y");
- if ((x.isValid())&&(y.isValid()))
- move(x.toInt(), y.toInt());
-
- split1 = new QSplitter(this);
- split1->setOrientation(Qt::Horizontal);
- setCentralWidget(split1);
-
- menuView = new ConfigView(split1, "menu");
- menuList = menuView->list;
-
- split2 = new QSplitter(split1);
- split2->setOrientation(Qt::Vertical);
-
- // create config tree
- configView = new ConfigView(split2, "config");
- configList = configView->list;
-
- helpText = new ConfigInfoView(split2, "help");
-
- setTabOrder(configList, helpText);
- configList->setFocus();
-
- menu = menuBar();
- toolBar = new QToolBar("Tools", this);
- addToolBar(toolBar);
-
- backAction = new QAction(QPixmap(xpm_back), _("Back"), this);
- connect(backAction, SIGNAL(triggered(bool)), SLOT(goBack()));
- backAction->setEnabled(false);
- QAction *quitAction = new QAction(_("&Quit"), this);
- quitAction->setShortcut(Qt::CTRL + Qt::Key_Q);
- connect(quitAction, SIGNAL(triggered(bool)), SLOT(close()));
- QAction *loadAction = new QAction(QPixmap(xpm_load), _("&Load"), this);
- loadAction->setShortcut(Qt::CTRL + Qt::Key_L);
- connect(loadAction, SIGNAL(triggered(bool)), SLOT(loadConfig()));
- saveAction = new QAction(QPixmap(xpm_save), _("&Save"), this);
- saveAction->setShortcut(Qt::CTRL + Qt::Key_S);
- connect(saveAction, SIGNAL(triggered(bool)), SLOT(saveConfig()));
- conf_set_changed_callback(conf_changed);
- // Set saveAction's initial state
- conf_changed();
- QAction *saveAsAction = new QAction(_("Save &As..."), this);
- connect(saveAsAction, SIGNAL(triggered(bool)), SLOT(saveConfigAs()));
- QAction *searchAction = new QAction(_("&Find"), this);
- searchAction->setShortcut(Qt::CTRL + Qt::Key_F);
- connect(searchAction, SIGNAL(triggered(bool)), SLOT(searchConfig()));
- singleViewAction = new QAction(QPixmap(xpm_single_view), _("Single View"), this);
- singleViewAction->setCheckable(true);
- connect(singleViewAction, SIGNAL(triggered(bool)), SLOT(showSingleView()));
- splitViewAction = new QAction(QPixmap(xpm_split_view), _("Split View"), this);
- splitViewAction->setCheckable(true);
- connect(splitViewAction, SIGNAL(triggered(bool)), SLOT(showSplitView()));
- fullViewAction = new QAction(QPixmap(xpm_tree_view), _("Full View"), this);
- fullViewAction->setCheckable(true);
- connect(fullViewAction, SIGNAL(triggered(bool)), SLOT(showFullView()));
-
- QAction *showNameAction = new QAction(_("Show Name"), this);
- showNameAction->setCheckable(true);
- connect(showNameAction, SIGNAL(toggled(bool)), configView, SLOT(setShowName(bool)));
- showNameAction->setChecked(configView->showName());
- QAction *showRangeAction = new QAction(_("Show Range"), this);
- showRangeAction->setCheckable(true);
- connect(showRangeAction, SIGNAL(toggled(bool)), configView, SLOT(setShowRange(bool)));
- QAction *showDataAction = new QAction(_("Show Data"), this);
- showDataAction->setCheckable(true);
- connect(showDataAction, SIGNAL(toggled(bool)), configView, SLOT(setShowData(bool)));
-
- QActionGroup *optGroup = new QActionGroup(this);
- optGroup->setExclusive(true);
- connect(optGroup, SIGNAL(triggered(QAction*)), configView,
- SLOT(setOptionMode(QAction *)));
- connect(optGroup, SIGNAL(triggered(QAction *)), menuView,
- SLOT(setOptionMode(QAction *)));
-
- configView->showNormalAction = new QAction(_("Show Normal Options"), optGroup);
- configView->showAllAction = new QAction(_("Show All Options"), optGroup);
- configView->showPromptAction = new QAction(_("Show Prompt Options"), optGroup);
- configView->showNormalAction->setCheckable(true);
- configView->showAllAction->setCheckable(true);
- configView->showPromptAction->setCheckable(true);
-
- QAction *showDebugAction = new QAction( _("Show Debug Info"), this);
- showDebugAction->setCheckable(true);
- connect(showDebugAction, SIGNAL(toggled(bool)), helpText, SLOT(setShowDebug(bool)));
- showDebugAction->setChecked(helpText->showDebug());
-
- QAction *showIntroAction = new QAction( _("Introduction"), this);
- connect(showIntroAction, SIGNAL(triggered(bool)), SLOT(showIntro()));
- QAction *showAboutAction = new QAction( _("About"), this);
- connect(showAboutAction, SIGNAL(triggered(bool)), SLOT(showAbout()));
-
- // init tool bar
- toolBar->addAction(backAction);
- toolBar->addSeparator();
- toolBar->addAction(loadAction);
- toolBar->addAction(saveAction);
- toolBar->addSeparator();
- toolBar->addAction(singleViewAction);
- toolBar->addAction(splitViewAction);
- toolBar->addAction(fullViewAction);
-
- // create config menu
- QMenu* config = menu->addMenu(_("&File"));
- config->addAction(loadAction);
- config->addAction(saveAction);
- config->addAction(saveAsAction);
- config->addSeparator();
- config->addAction(quitAction);
-
- // create edit menu
- QMenu* editMenu = menu->addMenu(_("&Edit"));
- editMenu->addAction(searchAction);
-
- // create options menu
- QMenu* optionMenu = menu->addMenu(_("&Option"));
- optionMenu->addAction(showNameAction);
- optionMenu->addAction(showRangeAction);
- optionMenu->addAction(showDataAction);
- optionMenu->addSeparator();
- optionMenu->addActions(optGroup->actions());
- optionMenu->addSeparator();
-
- // create help menu
- menu->addSeparator();
- QMenu* helpMenu = menu->addMenu(_("&Help"));
- helpMenu->addAction(showIntroAction);
- helpMenu->addAction(showAboutAction);
-
- connect(configList, SIGNAL(menuChanged(struct menu *)),
- helpText, SLOT(setInfo(struct menu *)));
- connect(configList, SIGNAL(menuSelected(struct menu *)),
- SLOT(changeMenu(struct menu *)));
- connect(configList, SIGNAL(parentSelected()),
- SLOT(goBack()));
- connect(menuList, SIGNAL(menuChanged(struct menu *)),
- helpText, SLOT(setInfo(struct menu *)));
- connect(menuList, SIGNAL(menuSelected(struct menu *)),
- SLOT(changeMenu(struct menu *)));
-
- connect(configList, SIGNAL(gotFocus(struct menu *)),
- helpText, SLOT(setInfo(struct menu *)));
- connect(menuList, SIGNAL(gotFocus(struct menu *)),
- helpText, SLOT(setInfo(struct menu *)));
- connect(menuList, SIGNAL(gotFocus(struct menu *)),
- SLOT(listFocusChanged(void)));
- connect(helpText, SIGNAL(menuSelected(struct menu *)),
- SLOT(setMenuLink(struct menu *)));
-
- QString listMode = configSettings->value("/listMode", "symbol").toString();
- if (listMode == "single")
- showSingleView();
- else if (listMode == "full")
- showFullView();
- else /*if (listMode == "split")*/
- showSplitView();
-
- // UI setup done, restore splitter positions
- QList<int> sizes = configSettings->readSizes("/split1", &ok);
- if (ok)
- split1->setSizes(sizes);
-
- sizes = configSettings->readSizes("/split2", &ok);
- if (ok)
- split2->setSizes(sizes);
-}
-
-void ConfigMainWindow::loadConfig(void)
-{
- QString s = QFileDialog::getOpenFileName(this, "", conf_get_configname());
- if (s.isNull())
- return;
- if (conf_read(QFile::encodeName(s)))
- QMessageBox::information(this, "qconf", _("Unable to load configuration!"));
- ConfigView::updateListAll();
-}
-
-bool ConfigMainWindow::saveConfig(void)
-{
- if (conf_write(NULL)) {
- QMessageBox::information(this, "qconf", _("Unable to save configuration!"));
- return false;
- }
- return true;
-}
-
-void ConfigMainWindow::saveConfigAs(void)
-{
- QString s = QFileDialog::getSaveFileName(this, "", conf_get_configname());
- if (s.isNull())
- return;
- saveConfig();
-}
-
-void ConfigMainWindow::searchConfig(void)
-{
- if (!searchWindow)
- searchWindow = new ConfigSearchWindow(this, "search");
- searchWindow->show();
-}
-
-void ConfigMainWindow::changeMenu(struct menu *menu)
-{
- configList->setRootMenu(menu);
- if (configList->rootEntry->parent == &rootmenu)
- backAction->setEnabled(false);
- else
- backAction->setEnabled(true);
-}
-
-void ConfigMainWindow::setMenuLink(struct menu *menu)
-{
- struct menu *parent;
- ConfigList* list = NULL;
- ConfigItem* item;
-
- if (configList->menuSkip(menu))
- return;
-
- switch (configList->mode) {
- case singleMode:
- list = configList;
- parent = menu_get_parent_menu(menu);
- if (!parent)
- return;
- list->setRootMenu(parent);
- break;
- case symbolMode:
- if (menu->flags & MENU_ROOT) {
- configList->setRootMenu(menu);
- configList->clearSelection();
- list = menuList;
- } else {
- list = configList;
- parent = menu_get_parent_menu(menu->parent);
- if (!parent)
- return;
- item = menuList->findConfigItem(parent);
- if (item) {
- item->setSelected(true);
- menuList->scrollToItem(item);
- }
- list->setRootMenu(parent);
- }
- break;
- case fullMode:
- list = configList;
- break;
- default:
- break;
- }
-
- if (list) {
- item = list->findConfigItem(menu);
- if (item) {
- item->setSelected(true);
- list->scrollToItem(item);
- list->setFocus();
- }
- }
-}
-
-void ConfigMainWindow::listFocusChanged(void)
-{
- if (menuList->mode == menuMode)
- configList->clearSelection();
-}
-
-void ConfigMainWindow::goBack(void)
-{
- ConfigItem* item, *oldSelection;
-
- configList->setParentMenu();
- if (configList->rootEntry == &rootmenu)
- backAction->setEnabled(false);
-
- if (menuList->selectedItems().count() == 0)
- return;
-
- item = (ConfigItem*)menuList->selectedItems().first();
- oldSelection = item;
- while (item) {
- if (item->menu == configList->rootEntry) {
- oldSelection->setSelected(false);
- item->setSelected(true);
- break;
- }
- item = (ConfigItem*)item->parent();
- }
-}
-
-void ConfigMainWindow::showSingleView(void)
-{
- singleViewAction->setEnabled(false);
- singleViewAction->setChecked(true);
- splitViewAction->setEnabled(true);
- splitViewAction->setChecked(false);
- fullViewAction->setEnabled(true);
- fullViewAction->setChecked(false);
-
- menuView->hide();
- menuList->setRootMenu(0);
- configList->mode = singleMode;
- if (configList->rootEntry == &rootmenu)
- configList->updateListAll();
- else
- configList->setRootMenu(&rootmenu);
- configList->setFocus();
-}
-
-void ConfigMainWindow::showSplitView(void)
-{
- singleViewAction->setEnabled(true);
- singleViewAction->setChecked(false);
- splitViewAction->setEnabled(false);
- splitViewAction->setChecked(true);
- fullViewAction->setEnabled(true);
- fullViewAction->setChecked(false);
-
- configList->mode = symbolMode;
- if (configList->rootEntry == &rootmenu)
- configList->updateListAll();
- else
- configList->setRootMenu(&rootmenu);
- configList->setAllOpen(true);
- configApp->processEvents();
- menuList->mode = menuMode;
- menuList->setRootMenu(&rootmenu);
- menuList->setAllOpen(true);
- menuView->show();
- menuList->setFocus();
-}
-
-void ConfigMainWindow::showFullView(void)
-{
- singleViewAction->setEnabled(true);
- singleViewAction->setChecked(false);
- splitViewAction->setEnabled(true);
- splitViewAction->setChecked(false);
- fullViewAction->setEnabled(false);
- fullViewAction->setChecked(true);
-
- menuView->hide();
- menuList->setRootMenu(0);
- configList->mode = fullMode;
- if (configList->rootEntry == &rootmenu)
- configList->updateListAll();
- else
- configList->setRootMenu(&rootmenu);
- configList->setFocus();
-}
-
-/*
- * ask for saving configuration before quitting
- * TODO ask only when something changed
- */
-void ConfigMainWindow::closeEvent(QCloseEvent* e)
-{
- if (!conf_get_changed()) {
- e->accept();
- return;
- }
- QMessageBox mb("qconf", _("Save configuration?"), QMessageBox::Warning,
- QMessageBox::Yes | QMessageBox::Default, QMessageBox::No, QMessageBox::Cancel | QMessageBox::Escape);
- mb.setButtonText(QMessageBox::Yes, _("&Save Changes"));
- mb.setButtonText(QMessageBox::No, _("&Discard Changes"));
- mb.setButtonText(QMessageBox::Cancel, _("Cancel Exit"));
- switch (mb.exec()) {
- case QMessageBox::Yes:
- if (saveConfig())
- e->accept();
- else
- e->ignore();
- break;
- case QMessageBox::No:
- e->accept();
- break;
- case QMessageBox::Cancel:
- e->ignore();
- break;
- }
-}
-
-void ConfigMainWindow::showIntro(void)
-{
- static const QString str = _("Welcome to the qconf graphical configuration tool.\n\n"
- "For each option, a blank box indicates the feature is disabled, a check\n"
- "indicates it is enabled, and a dot indicates that it is to be compiled\n"
- "as a module. Clicking on the box will cycle through the three states.\n\n"
- "If you do not see an option (e.g., a device driver) that you believe\n"
- "should be present, try turning on Show All Options under the Options menu.\n"
- "Although there is no cross reference yet to help you figure out what other\n"
- "options must be enabled to support the option you are interested in, you can\n"
- "still view the help of a grayed-out option.\n\n"
- "Toggling Show Debug Info under the Options menu will show the dependencies,\n"
- "which you can then match by examining other options.\n\n");
-
- QMessageBox::information(this, "qconf", str);
-}
-
-void ConfigMainWindow::showAbout(void)
-{
- static const QString str = _("qconf is Copyright (C) 2002 Roman Zippel <zippel@linux-m68k.org>.\n"
- "Copyright (C) 2015 Boris Barbulovski <bbarbulovski@gmail.com>.\n\n"
- "Bug reports and feature request can also be entered at http://bugzilla.kernel.org/\n");
-
- QMessageBox::information(this, "qconf", str);
-}
-
-void ConfigMainWindow::saveSettings(void)
-{
- configSettings->setValue("/window x", pos().x());
- configSettings->setValue("/window y", pos().y());
- configSettings->setValue("/window width", size().width());
- configSettings->setValue("/window height", size().height());
-
- QString entry;
- switch(configList->mode) {
- case singleMode :
- entry = "single";
- break;
-
- case symbolMode :
- entry = "split";
- break;
-
- case fullMode :
- entry = "full";
- break;
-
- default:
- break;
- }
- configSettings->setValue("/listMode", entry);
-
- configSettings->writeSizes("/split1", split1->sizes());
- configSettings->writeSizes("/split2", split2->sizes());
-}
-
-void ConfigMainWindow::conf_changed(void)
-{
- if (saveAction)
- saveAction->setEnabled(conf_get_changed());
-}
-
-void fixup_rootmenu(struct menu *menu)
-{
- struct menu *child;
- static int menu_cnt = 0;
-
- menu->flags |= MENU_ROOT;
- for (child = menu->list; child; child = child->next) {
- if (child->prompt && child->prompt->type == P_MENU) {
- menu_cnt++;
- fixup_rootmenu(child);
- menu_cnt--;
- } else if (!menu_cnt)
- fixup_rootmenu(child);
- }
-}
-
-static const char *progname;
-
-static void usage(void)
-{
- printf(_("%s [-s] <config>\n").toLatin1().constData(), progname);
- exit(0);
-}
-
-int main(int ac, char** av)
-{
- ConfigMainWindow* v;
- const char *name;
-
- bindtextdomain(PACKAGE, LOCALEDIR);
- textdomain(PACKAGE);
-
- progname = av[0];
- configApp = new QApplication(ac, av);
- if (ac > 1 && av[1][0] == '-') {
- switch (av[1][1]) {
- case 's':
- conf_set_message_callback(NULL);
- break;
- case 'h':
- case '?':
- usage();
- }
- name = av[2];
- } else
- name = av[1];
- if (!name)
- usage();
-
- conf_parse(name);
- fixup_rootmenu(&rootmenu);
- conf_read(NULL);
- //zconfdump(stdout);
-
- configSettings = new ConfigSettings();
- configSettings->beginGroup("/kconfig/qconf");
- v = new ConfigMainWindow();
-
- //zconfdump(stdout);
- configApp->connect(configApp, SIGNAL(lastWindowClosed()), SLOT(quit()));
- configApp->connect(configApp, SIGNAL(aboutToQuit()), v, SLOT(saveSettings()));
- v->show();
- configApp->exec();
-
- configSettings->endGroup();
- delete configSettings;
- delete v;
- delete configApp;
-
- return 0;
-}
+++ /dev/null
-/*
- * Copyright (C) 2002 Roman Zippel <zippel@linux-m68k.org>
- * Released under the terms of the GNU GPL v2.0.
- */
-
-#include <QTextBrowser>
-#include <QTreeWidget>
-#include <QMainWindow>
-#include <QHeaderView>
-#include <qsettings.h>
-#include <QPushButton>
-#include <QSettings>
-#include <QLineEdit>
-#include <QSplitter>
-#include <QCheckBox>
-#include <QDialog>
-#include "expr.h"
-
-class ConfigView;
-class ConfigList;
-class ConfigItem;
-class ConfigLineEdit;
-class ConfigMainWindow;
-
-class ConfigSettings : public QSettings {
-public:
- ConfigSettings();
- QList<int> readSizes(const QString& key, bool *ok);
- bool writeSizes(const QString& key, const QList<int>& value);
-};
-
-enum colIdx {
- promptColIdx, nameColIdx, noColIdx, modColIdx, yesColIdx, dataColIdx, colNr
-};
-enum listMode {
- singleMode, menuMode, symbolMode, fullMode, listMode
-};
-enum optionMode {
- normalOpt = 0, allOpt, promptOpt
-};
-
-class ConfigList : public QTreeWidget {
- Q_OBJECT
- typedef class QTreeWidget Parent;
-public:
- ConfigList(ConfigView* p, const char *name = 0);
- void reinit(void);
- ConfigView* parent(void) const
- {
- return (ConfigView*)Parent::parent();
- }
- ConfigItem* findConfigItem(struct menu *);
-
-protected:
- void keyPressEvent(QKeyEvent *e);
- void mousePressEvent(QMouseEvent *e);
- void mouseReleaseEvent(QMouseEvent *e);
- void mouseMoveEvent(QMouseEvent *e);
- void mouseDoubleClickEvent(QMouseEvent *e);
- void focusInEvent(QFocusEvent *e);
- void contextMenuEvent(QContextMenuEvent *e);
-
-public slots:
- void setRootMenu(struct menu *menu);
-
- void updateList(ConfigItem *item);
- void setValue(ConfigItem* item, tristate val);
- void changeValue(ConfigItem* item);
- void updateSelection(void);
- void saveSettings(void);
-signals:
- void menuChanged(struct menu *menu);
- void menuSelected(struct menu *menu);
- void parentSelected(void);
- void gotFocus(struct menu *);
-
-public:
- void updateListAll(void)
- {
- updateAll = true;
- updateList(NULL);
- updateAll = false;
- }
- ConfigList* listView()
- {
- return this;
- }
- ConfigItem* firstChild() const
- {
- return (ConfigItem *)children().first();
- }
- void addColumn(colIdx idx)
- {
- showColumn(idx);
- }
- void removeColumn(colIdx idx)
- {
- hideColumn(idx);
- }
- void setAllOpen(bool open);
- void setParentMenu(void);
-
- bool menuSkip(struct menu *);
-
- void updateMenuList(ConfigItem *parent, struct menu*);
- void updateMenuList(ConfigList *parent, struct menu*);
-
- bool updateAll;
-
- QPixmap symbolYesPix, symbolModPix, symbolNoPix;
- QPixmap choiceYesPix, choiceNoPix;
- QPixmap menuPix, menuInvPix, menuBackPix, voidPix;
-
- bool showName, showRange, showData;
- enum listMode mode;
- enum optionMode optMode;
- struct menu *rootEntry;
- QPalette disabledColorGroup;
- QPalette inactivedColorGroup;
- QMenu* headerPopup;
-};
-
-class ConfigItem : public QTreeWidgetItem {
- typedef class QTreeWidgetItem Parent;
-public:
- ConfigItem(ConfigList *parent, ConfigItem *after, struct menu *m, bool v)
- : Parent(parent, after), nextItem(0), menu(m), visible(v), goParent(false)
- {
- init();
- }
- ConfigItem(ConfigItem *parent, ConfigItem *after, struct menu *m, bool v)
- : Parent(parent, after), nextItem(0), menu(m), visible(v), goParent(false)
- {
- init();
- }
- ConfigItem(ConfigList *parent, ConfigItem *after, bool v)
- : Parent(parent, after), nextItem(0), menu(0), visible(v), goParent(true)
- {
- init();
- }
- ~ConfigItem(void);
- void init(void);
- void okRename(int col);
- void updateMenu(void);
- void testUpdateMenu(bool v);
- ConfigList* listView() const
- {
- return (ConfigList*)Parent::treeWidget();
- }
- ConfigItem* firstChild() const
- {
- return (ConfigItem *)Parent::child(0);
- }
- ConfigItem* nextSibling()
- {
- ConfigItem *ret = NULL;
- ConfigItem *_parent = (ConfigItem *)parent();
-
- if(_parent) {
- ret = (ConfigItem *)_parent->child(_parent->indexOfChild(this)+1);
- } else {
- QTreeWidget *_treeWidget = treeWidget();
- ret = (ConfigItem *)_treeWidget->topLevelItem(_treeWidget->indexOfTopLevelItem(this)+1);
- }
-
- return ret;
- }
- void setText(colIdx idx, const QString& text)
- {
- Parent::setText(idx, text);
- }
- QString text(colIdx idx) const
- {
- return Parent::text(idx);
- }
- void setPixmap(colIdx idx, const QIcon &icon)
- {
- Parent::setIcon(idx, icon);
- }
- const QIcon pixmap(colIdx idx) const
- {
- return icon(idx);
- }
- // TODO: Implement paintCell
-
- ConfigItem* nextItem;
- struct menu *menu;
- bool visible;
- bool goParent;
-};
-
-class ConfigLineEdit : public QLineEdit {
- Q_OBJECT
- typedef class QLineEdit Parent;
-public:
- ConfigLineEdit(ConfigView* parent);
- ConfigView* parent(void) const
- {
- return (ConfigView*)Parent::parent();
- }
- void show(ConfigItem *i);
- void keyPressEvent(QKeyEvent *e);
-
-public:
- ConfigItem *item;
-};
-
-class ConfigView : public QWidget {
- Q_OBJECT
- typedef class QWidget Parent;
-public:
- ConfigView(QWidget* parent, const char *name = 0);
- ~ConfigView(void);
- static void updateList(ConfigItem* item);
- static void updateListAll(void);
-
- bool showName(void) const { return list->showName; }
- bool showRange(void) const { return list->showRange; }
- bool showData(void) const { return list->showData; }
-public slots:
- void setShowName(bool);
- void setShowRange(bool);
- void setShowData(bool);
- void setOptionMode(QAction *);
-signals:
- void showNameChanged(bool);
- void showRangeChanged(bool);
- void showDataChanged(bool);
-public:
- ConfigList* list;
- ConfigLineEdit* lineEdit;
-
- static ConfigView* viewList;
- ConfigView* nextView;
-
- static QAction *showNormalAction;
- static QAction *showAllAction;
- static QAction *showPromptAction;
-};
-
-class ConfigInfoView : public QTextBrowser {
- Q_OBJECT
- typedef class QTextBrowser Parent;
-public:
- ConfigInfoView(QWidget* parent, const char *name = 0);
- bool showDebug(void) const { return _showDebug; }
-
-public slots:
- void setInfo(struct menu *menu);
- void saveSettings(void);
- void setShowDebug(bool);
-
-signals:
- void showDebugChanged(bool);
- void menuSelected(struct menu *);
-
-protected:
- void symbolInfo(void);
- void menuInfo(void);
- QString debug_info(struct symbol *sym);
- static QString print_filter(const QString &str);
- static void expr_print_help(void *data, struct symbol *sym, const char *str);
- QMenu *createStandardContextMenu(const QPoint & pos);
- void contextMenuEvent(QContextMenuEvent *e);
-
- struct symbol *sym;
- struct menu *_menu;
- bool _showDebug;
-};
-
-class ConfigSearchWindow : public QDialog {
- Q_OBJECT
- typedef class QDialog Parent;
-public:
- ConfigSearchWindow(ConfigMainWindow* parent, const char *name = 0);
-
-public slots:
- void saveSettings(void);
- void search(void);
-
-protected:
- QLineEdit* editField;
- QPushButton* searchButton;
- QSplitter* split;
- ConfigView* list;
- ConfigInfoView* info;
-
- struct symbol **result;
-};
-
-class ConfigMainWindow : public QMainWindow {
- Q_OBJECT
-
- static QAction *saveAction;
- static void conf_changed(void);
-public:
- ConfigMainWindow(void);
-public slots:
- void changeMenu(struct menu *);
- void setMenuLink(struct menu *);
- void listFocusChanged(void);
- void goBack(void);
- void loadConfig(void);
- bool saveConfig(void);
- void saveConfigAs(void);
- void searchConfig(void);
- void showSingleView(void);
- void showSplitView(void);
- void showFullView(void);
- void showIntro(void);
- void showAbout(void);
- void saveSettings(void);
-
-protected:
- void closeEvent(QCloseEvent *e);
-
- ConfigSearchWindow *searchWindow;
- ConfigView *menuView;
- ConfigList *menuList;
- ConfigView *configView;
- ConfigList *configList;
- ConfigInfoView *helpText;
- QToolBar *toolBar;
- QAction *backAction;
- QAction *singleViewAction;
- QAction *splitViewAction;
- QAction *fullViewAction;
- QSplitter *split1;
- QSplitter *split2;
-};
+++ /dev/null
-#!/usr/bin/perl -w
-#
-# Copyright 2005-2009 - Steven Rostedt
-# Licensed under the terms of the GNU GPL License version 2
-#
-# It's simple enough to figure out how this works.
-# If not, then you can ask me at stripconfig@goodmis.org
-#
-# What it does?
-#
-# If you have installed a Linux kernel from a distribution
-# that turns on way too many modules than you need, and
-# you only want the modules you use, then this program
-# is perfect for you.
-#
-# It gives you the ability to turn off all the modules that are
-# not loaded on your system.
-#
-# Howto:
-#
-# 1. Boot up the kernel that you want to stream line the config on.
-# 2. Change directory to the directory holding the source of the
-# kernel that you just booted.
-# 3. Copy the configuraton file to this directory as .config
-# 4. Have all your devices that you need modules for connected and
-# operational (make sure that their corresponding modules are loaded)
-# 5. Run this script redirecting the output to some other file
-# like config_strip.
-# 6. Back up your old config (if you want too).
-# 7. copy the config_strip file to .config
-# 8. Run "make oldconfig"
-#
-# Now your kernel is ready to be built with only the modules that
-# are loaded.
-#
-# Here's what I did with my Debian distribution.
-#
-# cd /usr/src/linux-2.6.10
-# cp /boot/config-2.6.10-1-686-smp .config
-# ~/bin/streamline_config > config_strip
-# mv .config config_sav
-# mv config_strip .config
-# make oldconfig
-#
-use strict;
-use Getopt::Long;
-
-# set the environment variable LOCALMODCONFIG_DEBUG to get
-# debug output.
-my $debugprint = 0;
-$debugprint = 1 if (defined($ENV{LOCALMODCONFIG_DEBUG}));
-
-sub dprint {
- return if (!$debugprint);
- print STDERR @_;
-}
-
-my $config = ".config";
-
-my $uname = `uname -r`;
-chomp $uname;
-
-my @searchconfigs = (
- {
- "file" => ".config",
- "exec" => "cat",
- },
- {
- "file" => "/proc/config.gz",
- "exec" => "zcat",
- },
- {
- "file" => "/boot/config-$uname",
- "exec" => "cat",
- },
- {
- "file" => "/boot/vmlinuz-$uname",
- "exec" => "scripts/extract-ikconfig",
- "test" => "scripts/extract-ikconfig",
- },
- {
- "file" => "vmlinux",
- "exec" => "scripts/extract-ikconfig",
- "test" => "scripts/extract-ikconfig",
- },
- {
- "file" => "/lib/modules/$uname/kernel/kernel/configs.ko",
- "exec" => "scripts/extract-ikconfig",
- "test" => "scripts/extract-ikconfig",
- },
- {
- "file" => "kernel/configs.ko",
- "exec" => "scripts/extract-ikconfig",
- "test" => "scripts/extract-ikconfig",
- },
- {
- "file" => "kernel/configs.o",
- "exec" => "scripts/extract-ikconfig",
- "test" => "scripts/extract-ikconfig",
- },
-);
-
-sub read_config {
- foreach my $conf (@searchconfigs) {
- my $file = $conf->{"file"};
-
- next if ( ! -f "$file");
-
- if (defined($conf->{"test"})) {
- `$conf->{"test"} $conf->{"file"} 2>/dev/null`;
- next if ($?);
- }
-
- my $exec = $conf->{"exec"};
-
- print STDERR "using config: '$file'\n";
-
- open(my $infile, '-|', "$exec $file") || die "Failed to run $exec $file";
- my @x = <$infile>;
- close $infile;
- return @x;
- }
- die "No config file found";
-}
-
-my @config_file = read_config;
-
-# Parse options
-my $localmodconfig = 0;
-my $localyesconfig = 0;
-
-GetOptions("localmodconfig" => \$localmodconfig,
- "localyesconfig" => \$localyesconfig);
-
-# Get the build source and top level Kconfig file (passed in)
-my $ksource = ($ARGV[0] ? $ARGV[0] : '.');
-my $kconfig = $ARGV[1];
-my $lsmod_file = $ENV{'LSMOD'};
-
-my @makefiles = `find $ksource -name Makefile -or -name Kbuild 2>/dev/null`;
-chomp @makefiles;
-
-my %depends;
-my %selects;
-my %prompts;
-my %objects;
-my $var;
-my $iflevel = 0;
-my @ifdeps;
-
-# prevent recursion
-my %read_kconfigs;
-
-sub read_kconfig {
- my ($kconfig) = @_;
-
- my $state = "NONE";
- my $config;
-
- my $cont = 0;
- my $line;
-
- my $source = "$ksource/$kconfig";
- my $last_source = "";
-
- # Check for any environment variables used
- while ($source =~ /\$(\w+)/ && $last_source ne $source) {
- my $env = $1;
- $last_source = $source;
- $source =~ s/\$$env/$ENV{$env}/;
- }
-
- open(my $kinfile, '<', $source) || die "Can't open $kconfig";
- while (<$kinfile>) {
- chomp;
-
- # Make sure that lines ending with \ continue
- if ($cont) {
- $_ = $line . " " . $_;
- }
-
- if (s/\\$//) {
- $cont = 1;
- $line = $_;
- next;
- }
-
- $cont = 0;
-
- # collect any Kconfig sources
- if (/^source\s*"(.*)"/) {
- my $kconfig = $1;
- # prevent reading twice.
- if (!defined($read_kconfigs{$kconfig})) {
- $read_kconfigs{$kconfig} = 1;
- read_kconfig($kconfig);
- }
- next;
- }
-
- # configs found
- if (/^\s*(menu)?config\s+(\S+)\s*$/) {
- $state = "NEW";
- $config = $2;
-
- # Add depends for 'if' nesting
- for (my $i = 0; $i < $iflevel; $i++) {
- if ($i) {
- $depends{$config} .= " " . $ifdeps[$i];
- } else {
- $depends{$config} = $ifdeps[$i];
- }
- $state = "DEP";
- }
-
- # collect the depends for the config
- } elsif ($state eq "NEW" && /^\s*depends\s+on\s+(.*)$/) {
- $state = "DEP";
- $depends{$config} = $1;
- } elsif ($state eq "DEP" && /^\s*depends\s+on\s+(.*)$/) {
- $depends{$config} .= " " . $1;
- } elsif ($state eq "DEP" && /^\s*def(_(bool|tristate)|ault)\s+(\S.*)$/) {
- my $dep = $3;
- if ($dep !~ /^\s*(y|m|n)\s*$/) {
- $dep =~ s/.*\sif\s+//;
- $depends{$config} .= " " . $dep;
- dprint "Added default depends $dep to $config\n";
- }
-
- # Get the configs that select this config
- } elsif ($state ne "NONE" && /^\s*select\s+(\S+)/) {
- my $conf = $1;
- if (defined($selects{$conf})) {
- $selects{$conf} .= " " . $config;
- } else {
- $selects{$conf} = $config;
- }
-
- # configs without prompts must be selected
- } elsif ($state ne "NONE" && /^\s*tristate\s\S/) {
- # note if the config has a prompt
- $prompts{$config} = 1;
-
- # Check for if statements
- } elsif (/^if\s+(.*\S)\s*$/) {
- my $deps = $1;
- # remove beginning and ending non text
- $deps =~ s/^[^a-zA-Z0-9_]*//;
- $deps =~ s/[^a-zA-Z0-9_]*$//;
-
- my @deps = split /[^a-zA-Z0-9_]+/, $deps;
-
- $ifdeps[$iflevel++] = join ':', @deps;
-
- } elsif (/^endif/) {
-
- $iflevel-- if ($iflevel);
-
- # stop on "help"
- } elsif (/^\s*help\s*$/) {
- $state = "NONE";
- }
- }
- close($kinfile);
-}
-
-if ($kconfig) {
- read_kconfig($kconfig);
-}
-
-# Makefiles can use variables to define their dependencies
-sub convert_vars {
- my ($line, %vars) = @_;
-
- my $process = "";
-
- while ($line =~ s/^(.*?)(\$\((.*?)\))//) {
- my $start = $1;
- my $variable = $2;
- my $var = $3;
-
- if (defined($vars{$var})) {
- $process .= $start . $vars{$var};
- } else {
- $process .= $start . $variable;
- }
- }
-
- $process .= $line;
-
- return $process;
-}
-
-# Read all Makefiles to map the configs to the objects
-foreach my $makefile (@makefiles) {
-
- my $line = "";
- my %make_vars;
-
- open(my $infile, '<', $makefile) || die "Can't open $makefile";
- while (<$infile>) {
- # if this line ends with a backslash, continue
- chomp;
- if (/^(.*)\\$/) {
- $line .= $1;
- next;
- }
-
- $line .= $_;
- $_ = $line;
- $line = "";
-
- my $objs;
-
- # Convert variables in a line (could define configs)
- $_ = convert_vars($_, %make_vars);
-
- # collect objects after obj-$(CONFIG_FOO_BAR)
- if (/obj-\$\((CONFIG_[^\)]*)\)\s*[+:]?=\s*(.*)/) {
- $var = $1;
- $objs = $2;
-
- # check if variables are set
- } elsif (/^\s*(\S+)\s*[:]?=\s*(.*\S)/) {
- $make_vars{$1} = $2;
- }
- if (defined($objs)) {
- foreach my $obj (split /\s+/,$objs) {
- $obj =~ s/-/_/g;
- if ($obj =~ /(.*)\.o$/) {
- # Objects may be enabled by more than one config.
- # Store configs in an array.
- my @arr;
-
- if (defined($objects{$1})) {
- @arr = @{$objects{$1}};
- }
-
- $arr[$#arr+1] = $var;
-
- # The objects have a hash mapping to a reference
- # of an array of configs.
- $objects{$1} = \@arr;
- }
- }
- }
- }
- close($infile);
-}
-
-my %modules;
-my $linfile;
-
-if (defined($lsmod_file)) {
- if ( ! -f $lsmod_file) {
- if ( -f $ENV{'objtree'}."/".$lsmod_file) {
- $lsmod_file = $ENV{'objtree'}."/".$lsmod_file;
- } else {
- die "$lsmod_file not found";
- }
- }
-
- my $otype = ( -x $lsmod_file) ? '-|' : '<';
- open($linfile, $otype, $lsmod_file);
-
-} else {
-
- # see what modules are loaded on this system
- my $lsmod;
-
- foreach my $dir ( ("/sbin", "/bin", "/usr/sbin", "/usr/bin") ) {
- if ( -x "$dir/lsmod" ) {
- $lsmod = "$dir/lsmod";
- last;
- }
-}
- if (!defined($lsmod)) {
- # try just the path
- $lsmod = "lsmod";
- }
-
- open($linfile, '-|', $lsmod) || die "Can not call lsmod with $lsmod";
-}
-
-while (<$linfile>) {
- next if (/^Module/); # Skip the first line.
- if (/^(\S+)/) {
- $modules{$1} = 1;
- }
-}
-close ($linfile);
-
-# add to the configs hash all configs that are needed to enable
-# a loaded module. This is a direct obj-${CONFIG_FOO} += bar.o
-# where we know we need bar.o so we add FOO to the list.
-my %configs;
-foreach my $module (keys(%modules)) {
- if (defined($objects{$module})) {
- my @arr = @{$objects{$module}};
- foreach my $conf (@arr) {
- $configs{$conf} = $module;
- dprint "$conf added by direct ($module)\n";
- if ($debugprint) {
- my $c=$conf;
- $c =~ s/^CONFIG_//;
- if (defined($depends{$c})) {
- dprint " deps = $depends{$c}\n";
- } else {
- dprint " no deps\n";
- }
- }
- }
- } else {
- # Most likely, someone has a custom (binary?) module loaded.
- print STDERR "$module config not found!!\n";
- }
-}
-
-# Read the current config, and see what is enabled. We want to
-# ignore configs that we would not enable anyway.
-
-my %orig_configs;
-my $valid = "A-Za-z_0-9";
-
-foreach my $line (@config_file) {
- $_ = $line;
-
- if (/(CONFIG_[$valid]*)=(m|y)/) {
- $orig_configs{$1} = $2;
- }
-}
-
-my $repeat = 1;
-
-my $depconfig;
-
-#
-# Note, we do not care about operands (like: &&, ||, !) we want to add any
-# config that is in the depend list of another config. This script does
-# not enable configs that are not already enabled. If we come across a
-# config A that depends on !B, we can still add B to the list of depends
-# to keep on. If A was on in the original config, B would not have been
-# and B would not be turned on by this script.
-#
-sub parse_config_depends
-{
- my ($p) = @_;
-
- while ($p =~ /[$valid]/) {
-
- if ($p =~ /^[^$valid]*([$valid]+)/) {
- my $conf = "CONFIG_" . $1;
-
- $p =~ s/^[^$valid]*[$valid]+//;
-
- # We only need to process if the depend config is a module
- if (!defined($orig_configs{$conf}) || !$orig_configs{conf} eq "m") {
- next;
- }
-
- if (!defined($configs{$conf})) {
- # We must make sure that this config has its
- # dependencies met.
- $repeat = 1; # do again
- dprint "$conf selected by depend $depconfig\n";
- $configs{$conf} = 1;
- }
- } else {
- die "this should never happen";
- }
- }
-}
-
-# Select is treated a bit differently than depends. We call this
-# when a config has no prompt and requires another config to be
-# selected. We use to just select all configs that selected this
-# config, but found that that can balloon into enabling hundreds
-# of configs that we do not care about.
-#
-# The idea is we look at all the configs that select it. If one
-# is already in our list of configs to enable, then there's nothing
-# else to do. If there isn't, we pick the first config that was
-# enabled in the orignal config and use that.
-sub parse_config_selects
-{
- my ($config, $p) = @_;
-
- my $next_config;
-
- while ($p =~ /[$valid]/) {
-
- if ($p =~ /^[^$valid]*([$valid]+)/) {
- my $conf = "CONFIG_" . $1;
-
- $p =~ s/^[^$valid]*[$valid]+//;
-
- # Make sure that this config exists in the current .config file
- if (!defined($orig_configs{$conf})) {
- dprint "$conf not set for $config select\n";
- next;
- }
-
- # Check if something other than a module selects this config
- if (defined($orig_configs{$conf}) && $orig_configs{$conf} ne "m") {
- dprint "$conf (non module) selects config, we are good\n";
- # we are good with this
- return;
- }
- if (defined($configs{$conf})) {
- dprint "$conf selects $config so we are good\n";
- # A set config selects this config, we are good
- return;
- }
- # Set this config to be selected
- if (!defined($next_config)) {
- $next_config = $conf;
- }
- } else {
- die "this should never happen";
- }
- }
-
- # If no possible config selected this, then something happened.
- if (!defined($next_config)) {
- print STDERR "WARNING: $config is required, but nothing in the\n";
- print STDERR " current config selects it.\n";
- return;
- }
-
- # If we are here, then we found no config that is set and
- # selects this config. Repeat.
- $repeat = 1;
- # Make this config need to be selected
- $configs{$next_config} = 1;
- dprint "$next_config selected by select $config\n";
-}
-
-my %process_selects;
-
-# loop through all configs, select their dependencies.
-sub loop_depend {
- $repeat = 1;
-
- while ($repeat) {
- $repeat = 0;
-
- forloop:
- foreach my $config (keys %configs) {
-
- # If this config is not a module, we do not need to process it
- if (defined($orig_configs{$config}) && $orig_configs{$config} ne "m") {
- next forloop;
- }
-
- $config =~ s/^CONFIG_//;
- $depconfig = $config;
-
- if (defined($depends{$config})) {
- # This config has dependencies. Make sure they are also included
- parse_config_depends $depends{$config};
- }
-
- # If the config has no prompt, then we need to check if a config
- # that is enabled selected it. Or if we need to enable one.
- if (!defined($prompts{$config}) && defined($selects{$config})) {
- $process_selects{$config} = 1;
- }
- }
- }
-}
-
-sub loop_select {
-
- foreach my $config (keys %process_selects) {
- $config =~ s/^CONFIG_//;
-
- dprint "Process select $config\n";
-
- # config has no prompt and must be selected.
- parse_config_selects $config, $selects{$config};
- }
-}
-
-while ($repeat) {
- # Get the first set of configs and their dependencies.
- loop_depend;
-
- $repeat = 0;
-
- # Now we need to see if we have to check selects;
- loop_select;
-}
-
-my %setconfigs;
-
-# Finally, read the .config file and turn off any module enabled that
-# we could not find a reason to keep enabled.
-foreach my $line (@config_file) {
- $_ = $line;
-
- if (/CONFIG_IKCONFIG/) {
- if (/# CONFIG_IKCONFIG is not set/) {
- # enable IKCONFIG at least as a module
- print "CONFIG_IKCONFIG=m\n";
- # don't ask about PROC
- print "# CONFIG_IKCONFIG_PROC is not set\n";
- } else {
- print;
- }
- next;
- }
-
- if (/^(CONFIG.*)=(m|y)/) {
- if (defined($configs{$1})) {
- if ($localyesconfig) {
- $setconfigs{$1} = 'y';
- print "$1=y\n";
- next;
- } else {
- $setconfigs{$1} = $2;
- }
- } elsif ($2 eq "m") {
- print "# $1 is not set\n";
- next;
- }
- }
- print;
-}
-
-# Integrity check, make sure all modules that we want enabled do
-# indeed have their configs set.
-loop:
-foreach my $module (keys(%modules)) {
- if (defined($objects{$module})) {
- my @arr = @{$objects{$module}};
- foreach my $conf (@arr) {
- if (defined($setconfigs{$conf})) {
- next loop;
- }
- }
- print STDERR "module $module did not have configs";
- foreach my $conf (@arr) {
- print STDERR " " , $conf;
- }
- print STDERR "\n";
- }
-}
+++ /dev/null
-/*
- * Copyright (C) 2002 Roman Zippel <zippel@linux-m68k.org>
- * Released under the terms of the GNU GPL v2.0.
- */
-
-#include <ctype.h>
-#include <stdlib.h>
-#include <string.h>
-#include <regex.h>
-#include <sys/utsname.h>
-
-#include "lkc.h"
-
-struct symbol symbol_yes = {
- .name = "y",
- .curr = { "y", yes },
- .flags = SYMBOL_CONST|SYMBOL_VALID,
-}, symbol_mod = {
- .name = "m",
- .curr = { "m", mod },
- .flags = SYMBOL_CONST|SYMBOL_VALID,
-}, symbol_no = {
- .name = "n",
- .curr = { "n", no },
- .flags = SYMBOL_CONST|SYMBOL_VALID,
-}, symbol_empty = {
- .name = "",
- .curr = { "", no },
- .flags = SYMBOL_VALID,
-};
-
-struct symbol *sym_defconfig_list;
-struct symbol *modules_sym;
-tristate modules_val;
-
-struct expr *sym_env_list;
-
-static void sym_add_default(struct symbol *sym, const char *def)
-{
- struct property *prop = prop_alloc(P_DEFAULT, sym);
-
- prop->expr = expr_alloc_symbol(sym_lookup(def, SYMBOL_CONST));
-}
-
-void sym_init(void)
-{
- struct symbol *sym;
- struct utsname uts;
- static bool inited = false;
-
- if (inited)
- return;
- inited = true;
-
- uname(&uts);
-
- sym = sym_lookup("UNAME_RELEASE", 0);
- sym->type = S_STRING;
- sym->flags |= SYMBOL_AUTO;
- sym_add_default(sym, uts.release);
-}
-
-enum symbol_type sym_get_type(struct symbol *sym)
-{
- enum symbol_type type = sym->type;
-
- if (type == S_TRISTATE) {
- if (sym_is_choice_value(sym) && sym->visible == yes)
- type = S_BOOLEAN;
- else if (modules_val == no)
- type = S_BOOLEAN;
- }
- return type;
-}
-
-const char *sym_type_name(enum symbol_type type)
-{
- switch (type) {
- case S_BOOLEAN:
- return "boolean";
- case S_TRISTATE:
- return "tristate";
- case S_INT:
- return "integer";
- case S_HEX:
- return "hex";
- case S_STRING:
- return "string";
- case S_UNKNOWN:
- return "unknown";
- case S_OTHER:
- break;
- }
- return "???";
-}
-
-struct property *sym_get_choice_prop(struct symbol *sym)
-{
- struct property *prop;
-
- for_all_choices(sym, prop)
- return prop;
- return NULL;
-}
-
-struct property *sym_get_env_prop(struct symbol *sym)
-{
- struct property *prop;
-
- for_all_properties(sym, prop, P_ENV)
- return prop;
- return NULL;
-}
-
-static struct property *sym_get_default_prop(struct symbol *sym)
-{
- struct property *prop;
-
- for_all_defaults(sym, prop) {
- prop->visible.tri = expr_calc_value(prop->visible.expr);
- if (prop->visible.tri != no)
- return prop;
- }
- return NULL;
-}
-
-static struct property *sym_get_range_prop(struct symbol *sym)
-{
- struct property *prop;
-
- for_all_properties(sym, prop, P_RANGE) {
- prop->visible.tri = expr_calc_value(prop->visible.expr);
- if (prop->visible.tri != no)
- return prop;
- }
- return NULL;
-}
-
-static long long sym_get_range_val(struct symbol *sym, int base)
-{
- sym_calc_value(sym);
- switch (sym->type) {
- case S_INT:
- base = 10;
- break;
- case S_HEX:
- base = 16;
- break;
- default:
- break;
- }
- return strtoll(sym->curr.val, NULL, base);
-}
-
-static void sym_validate_range(struct symbol *sym)
-{
- struct property *prop;
- int base;
- long long val, val2;
- char str[64];
-
- switch (sym->type) {
- case S_INT:
- base = 10;
- break;
- case S_HEX:
- base = 16;
- break;
- default:
- return;
- }
- prop = sym_get_range_prop(sym);
- if (!prop)
- return;
- val = strtoll(sym->curr.val, NULL, base);
- val2 = sym_get_range_val(prop->expr->left.sym, base);
- if (val >= val2) {
- val2 = sym_get_range_val(prop->expr->right.sym, base);
- if (val <= val2)
- return;
- }
- if (sym->type == S_INT)
- sprintf(str, "%lld", val2);
- else
- sprintf(str, "0x%llx", val2);
- sym->curr.val = strdup(str);
-}
-
-static void sym_set_changed(struct symbol *sym)
-{
- struct property *prop;
-
- sym->flags |= SYMBOL_CHANGED;
- for (prop = sym->prop; prop; prop = prop->next) {
- if (prop->menu)
- prop->menu->flags |= MENU_CHANGED;
- }
-}
-
-static void sym_set_all_changed(void)
-{
- struct symbol *sym;
- int i;
-
- for_all_symbols(i, sym)
- sym_set_changed(sym);
-}
-
-static void sym_calc_visibility(struct symbol *sym)
-{
- struct property *prop;
- tristate tri;
-
- /* any prompt visible? */
- tri = no;
- for_all_prompts(sym, prop) {
- prop->visible.tri = expr_calc_value(prop->visible.expr);
- tri = EXPR_OR(tri, prop->visible.tri);
- }
- if (tri == mod && (sym->type != S_TRISTATE || modules_val == no))
- tri = yes;
- if (sym->visible != tri) {
- sym->visible = tri;
- sym_set_changed(sym);
- }
- if (sym_is_choice_value(sym))
- return;
- /* defaulting to "yes" if no explicit "depends on" are given */
- tri = yes;
- if (sym->dir_dep.expr)
- tri = expr_calc_value(sym->dir_dep.expr);
- if (tri == mod)
- tri = yes;
- if (sym->dir_dep.tri != tri) {
- sym->dir_dep.tri = tri;
- sym_set_changed(sym);
- }
- tri = no;
- if (sym->rev_dep.expr)
- tri = expr_calc_value(sym->rev_dep.expr);
- if (tri == mod && sym_get_type(sym) == S_BOOLEAN)
- tri = yes;
- if (sym->rev_dep.tri != tri) {
- sym->rev_dep.tri = tri;
- sym_set_changed(sym);
- }
-}
-
-/*
- * Find the default symbol for a choice.
- * First try the default values for the choice symbol
- * Next locate the first visible choice value
- * Return NULL if none was found
- */
-struct symbol *sym_choice_default(struct symbol *sym)
-{
- struct symbol *def_sym;
- struct property *prop;
- struct expr *e;
-
- /* any of the defaults visible? */
- for_all_defaults(sym, prop) {
- prop->visible.tri = expr_calc_value(prop->visible.expr);
- if (prop->visible.tri == no)
- continue;
- def_sym = prop_get_symbol(prop);
- if (def_sym->visible != no)
- return def_sym;
- }
-
- /* just get the first visible value */
- prop = sym_get_choice_prop(sym);
- expr_list_for_each_sym(prop->expr, e, def_sym)
- if (def_sym->visible != no)
- return def_sym;
-
- /* failed to locate any defaults */
- return NULL;
-}
-
-static struct symbol *sym_calc_choice(struct symbol *sym)
-{
- struct symbol *def_sym;
- struct property *prop;
- struct expr *e;
- int flags;
-
- /* first calculate all choice values' visibilities */
- flags = sym->flags;
- prop = sym_get_choice_prop(sym);
- expr_list_for_each_sym(prop->expr, e, def_sym) {
- sym_calc_visibility(def_sym);
- if (def_sym->visible != no)
- flags &= def_sym->flags;
- }
-
- sym->flags &= flags | ~SYMBOL_DEF_USER;
-
- /* is the user choice visible? */
- def_sym = sym->def[S_DEF_USER].val;
- if (def_sym && def_sym->visible != no)
- return def_sym;
-
- def_sym = sym_choice_default(sym);
-
- if (def_sym == NULL)
- /* no choice? reset tristate value */
- sym->curr.tri = no;
-
- return def_sym;
-}
-
-void sym_calc_value(struct symbol *sym)
-{
- struct symbol_value newval, oldval;
- struct property *prop;
- struct expr *e;
-
- if (!sym)
- return;
-
- if (sym->flags & SYMBOL_VALID)
- return;
-
- if (sym_is_choice_value(sym) &&
- sym->flags & SYMBOL_NEED_SET_CHOICE_VALUES) {
- sym->flags &= ~SYMBOL_NEED_SET_CHOICE_VALUES;
- prop = sym_get_choice_prop(sym);
- sym_calc_value(prop_get_symbol(prop));
- }
-
- sym->flags |= SYMBOL_VALID;
-
- oldval = sym->curr;
-
- switch (sym->type) {
- case S_INT:
- case S_HEX:
- case S_STRING:
- newval = symbol_empty.curr;
- break;
- case S_BOOLEAN:
- case S_TRISTATE:
- newval = symbol_no.curr;
- break;
- default:
- sym->curr.val = sym->name;
- sym->curr.tri = no;
- return;
- }
- if (!sym_is_choice_value(sym))
- sym->flags &= ~SYMBOL_WRITE;
-
- sym_calc_visibility(sym);
-
- /* set default if recursively called */
- sym->curr = newval;
-
- switch (sym_get_type(sym)) {
- case S_BOOLEAN:
- case S_TRISTATE:
- if (sym_is_choice_value(sym) && sym->visible == yes) {
- prop = sym_get_choice_prop(sym);
- newval.tri = (prop_get_symbol(prop)->curr.val == sym) ? yes : no;
- } else {
- if (sym->visible != no) {
- /* if the symbol is visible use the user value
- * if available, otherwise try the default value
- */
- sym->flags |= SYMBOL_WRITE;
- if (sym_has_value(sym)) {
- newval.tri = EXPR_AND(sym->def[S_DEF_USER].tri,
- sym->visible);
- goto calc_newval;
- }
- }
- if (sym->rev_dep.tri != no)
- sym->flags |= SYMBOL_WRITE;
- if (!sym_is_choice(sym)) {
- prop = sym_get_default_prop(sym);
- if (prop) {
- sym->flags |= SYMBOL_WRITE;
- newval.tri = EXPR_AND(expr_calc_value(prop->expr),
- prop->visible.tri);
- }
- }
- calc_newval:
- if (sym->dir_dep.tri == no && sym->rev_dep.tri != no) {
- struct expr *e;
- e = expr_simplify_unmet_dep(sym->rev_dep.expr,
- sym->dir_dep.expr);
- fprintf(stderr, "warning: (");
- expr_fprint(e, stderr);
- fprintf(stderr, ") selects %s which has unmet direct dependencies (",
- sym->name);
- expr_fprint(sym->dir_dep.expr, stderr);
- fprintf(stderr, ")\n");
- expr_free(e);
- }
- newval.tri = EXPR_OR(newval.tri, sym->rev_dep.tri);
- }
- if (newval.tri == mod && sym_get_type(sym) == S_BOOLEAN)
- newval.tri = yes;
- break;
- case S_STRING:
- case S_HEX:
- case S_INT:
- if (sym->visible != no) {
- sym->flags |= SYMBOL_WRITE;
- if (sym_has_value(sym)) {
- newval.val = sym->def[S_DEF_USER].val;
- break;
- }
- }
- prop = sym_get_default_prop(sym);
- if (prop) {
- struct symbol *ds = prop_get_symbol(prop);
- if (ds) {
- sym->flags |= SYMBOL_WRITE;
- sym_calc_value(ds);
- newval.val = ds->curr.val;
- }
- }
- break;
- default:
- ;
- }
-
- sym->curr = newval;
- if (sym_is_choice(sym) && newval.tri == yes)
- sym->curr.val = sym_calc_choice(sym);
- sym_validate_range(sym);
-
- if (memcmp(&oldval, &sym->curr, sizeof(oldval))) {
- sym_set_changed(sym);
- if (modules_sym == sym) {
- sym_set_all_changed();
- modules_val = modules_sym->curr.tri;
- }
- }
-
- if (sym_is_choice(sym)) {
- struct symbol *choice_sym;
-
- prop = sym_get_choice_prop(sym);
- expr_list_for_each_sym(prop->expr, e, choice_sym) {
- if ((sym->flags & SYMBOL_WRITE) &&
- choice_sym->visible != no)
- choice_sym->flags |= SYMBOL_WRITE;
- if (sym->flags & SYMBOL_CHANGED)
- sym_set_changed(choice_sym);
- }
- }
-
- if (sym->flags & SYMBOL_AUTO)
- sym->flags &= ~SYMBOL_WRITE;
-
- if (sym->flags & SYMBOL_NEED_SET_CHOICE_VALUES)
- set_all_choice_values(sym);
-}
-
-void sym_clear_all_valid(void)
-{
- struct symbol *sym;
- int i;
-
- for_all_symbols(i, sym)
- sym->flags &= ~SYMBOL_VALID;
- sym_add_change_count(1);
- sym_calc_value(modules_sym);
-}
-
-bool sym_tristate_within_range(struct symbol *sym, tristate val)
-{
- int type = sym_get_type(sym);
-
- if (sym->visible == no)
- return false;
-
- if (type != S_BOOLEAN && type != S_TRISTATE)
- return false;
-
- if (type == S_BOOLEAN && val == mod)
- return false;
- if (sym->visible <= sym->rev_dep.tri)
- return false;
- if (sym_is_choice_value(sym) && sym->visible == yes)
- return val == yes;
- return val >= sym->rev_dep.tri && val <= sym->visible;
-}
-
-bool sym_set_tristate_value(struct symbol *sym, tristate val)
-{
- tristate oldval = sym_get_tristate_value(sym);
-
- if (oldval != val && !sym_tristate_within_range(sym, val))
- return false;
-
- if (!(sym->flags & SYMBOL_DEF_USER)) {
- sym->flags |= SYMBOL_DEF_USER;
- sym_set_changed(sym);
- }
- /*
- * setting a choice value also resets the new flag of the choice
- * symbol and all other choice values.
- */
- if (sym_is_choice_value(sym) && val == yes) {
- struct symbol *cs = prop_get_symbol(sym_get_choice_prop(sym));
- struct property *prop;
- struct expr *e;
-
- cs->def[S_DEF_USER].val = sym;
- cs->flags |= SYMBOL_DEF_USER;
- prop = sym_get_choice_prop(cs);
- for (e = prop->expr; e; e = e->left.expr) {
- if (e->right.sym->visible != no)
- e->right.sym->flags |= SYMBOL_DEF_USER;
- }
- }
-
- sym->def[S_DEF_USER].tri = val;
- if (oldval != val)
- sym_clear_all_valid();
-
- return true;
-}
-
-tristate sym_toggle_tristate_value(struct symbol *sym)
-{
- tristate oldval, newval;
-
- oldval = newval = sym_get_tristate_value(sym);
- do {
- switch (newval) {
- case no:
- newval = mod;
- break;
- case mod:
- newval = yes;
- break;
- case yes:
- newval = no;
- break;
- }
- if (sym_set_tristate_value(sym, newval))
- break;
- } while (oldval != newval);
- return newval;
-}
-
-bool sym_string_valid(struct symbol *sym, const char *str)
-{
- signed char ch;
-
- switch (sym->type) {
- case S_STRING:
- return true;
- case S_INT:
- ch = *str++;
- if (ch == '-')
- ch = *str++;
- if (!isdigit(ch))
- return false;
- if (ch == '0' && *str != 0)
- return false;
- while ((ch = *str++)) {
- if (!isdigit(ch))
- return false;
- }
- return true;
- case S_HEX:
- if (str[0] == '0' && (str[1] == 'x' || str[1] == 'X'))
- str += 2;
- ch = *str++;
- do {
- if (!isxdigit(ch))
- return false;
- } while ((ch = *str++));
- return true;
- case S_BOOLEAN:
- case S_TRISTATE:
- switch (str[0]) {
- case 'y': case 'Y':
- case 'm': case 'M':
- case 'n': case 'N':
- return true;
- }
- return false;
- default:
- return false;
- }
-}
-
-bool sym_string_within_range(struct symbol *sym, const char *str)
-{
- struct property *prop;
- long long val;
-
- switch (sym->type) {
- case S_STRING:
- return sym_string_valid(sym, str);
- case S_INT:
- if (!sym_string_valid(sym, str))
- return false;
- prop = sym_get_range_prop(sym);
- if (!prop)
- return true;
- val = strtoll(str, NULL, 10);
- return val >= sym_get_range_val(prop->expr->left.sym, 10) &&
- val <= sym_get_range_val(prop->expr->right.sym, 10);
- case S_HEX:
- if (!sym_string_valid(sym, str))
- return false;
- prop = sym_get_range_prop(sym);
- if (!prop)
- return true;
- val = strtoll(str, NULL, 16);
- return val >= sym_get_range_val(prop->expr->left.sym, 16) &&
- val <= sym_get_range_val(prop->expr->right.sym, 16);
- case S_BOOLEAN:
- case S_TRISTATE:
- switch (str[0]) {
- case 'y': case 'Y':
- return sym_tristate_within_range(sym, yes);
- case 'm': case 'M':
- return sym_tristate_within_range(sym, mod);
- case 'n': case 'N':
- return sym_tristate_within_range(sym, no);
- }
- return false;
- default:
- return false;
- }
-}
-
-bool sym_set_string_value(struct symbol *sym, const char *newval)
-{
- const char *oldval;
- char *val;
- int size;
-
- switch (sym->type) {
- case S_BOOLEAN:
- case S_TRISTATE:
- switch (newval[0]) {
- case 'y': case 'Y':
- return sym_set_tristate_value(sym, yes);
- case 'm': case 'M':
- return sym_set_tristate_value(sym, mod);
- case 'n': case 'N':
- return sym_set_tristate_value(sym, no);
- }
- return false;
- default:
- ;
- }
-
- if (!sym_string_within_range(sym, newval))
- return false;
-
- if (!(sym->flags & SYMBOL_DEF_USER)) {
- sym->flags |= SYMBOL_DEF_USER;
- sym_set_changed(sym);
- }
-
- oldval = sym->def[S_DEF_USER].val;
- size = strlen(newval) + 1;
- if (sym->type == S_HEX && (newval[0] != '0' || (newval[1] != 'x' && newval[1] != 'X'))) {
- size += 2;
- sym->def[S_DEF_USER].val = val = xmalloc(size);
- *val++ = '0';
- *val++ = 'x';
- } else if (!oldval || strcmp(oldval, newval))
- sym->def[S_DEF_USER].val = val = xmalloc(size);
- else
- return true;
-
- strcpy(val, newval);
- free((void *)oldval);
- sym_clear_all_valid();
-
- return true;
-}
-
-/*
- * Find the default value associated to a symbol.
- * For tristate symbol handle the modules=n case
- * in which case "m" becomes "y".
- * If the symbol does not have any default then fallback
- * to the fixed default values.
- */
-const char *sym_get_string_default(struct symbol *sym)
-{
- struct property *prop;
- struct symbol *ds;
- const char *str;
- tristate val;
-
- sym_calc_visibility(sym);
- sym_calc_value(modules_sym);
- val = symbol_no.curr.tri;
- str = symbol_empty.curr.val;
-
- /* If symbol has a default value look it up */
- prop = sym_get_default_prop(sym);
- if (prop != NULL) {
- switch (sym->type) {
- case S_BOOLEAN:
- case S_TRISTATE:
- /* The visibility may limit the value from yes => mod */
- val = EXPR_AND(expr_calc_value(prop->expr), prop->visible.tri);
- break;
- default:
- /*
- * The following fails to handle the situation
- * where a default value is further limited by
- * the valid range.
- */
- ds = prop_get_symbol(prop);
- if (ds != NULL) {
- sym_calc_value(ds);
- str = (const char *)ds->curr.val;
- }
- }
- }
-
- /* Handle select statements */
- val = EXPR_OR(val, sym->rev_dep.tri);
-
- /* transpose mod to yes if modules are not enabled */
- if (val == mod)
- if (!sym_is_choice_value(sym) && modules_sym->curr.tri == no)
- val = yes;
-
- /* transpose mod to yes if type is bool */
- if (sym->type == S_BOOLEAN && val == mod)
- val = yes;
-
- switch (sym->type) {
- case S_BOOLEAN:
- case S_TRISTATE:
- switch (val) {
- case no: return "n";
- case mod: return "m";
- case yes: return "y";
- }
- case S_INT:
- case S_HEX:
- return str;
- case S_STRING:
- return str;
- case S_OTHER:
- case S_UNKNOWN:
- break;
- }
- return "";
-}
-
-const char *sym_get_string_value(struct symbol *sym)
-{
- tristate val;
-
- switch (sym->type) {
- case S_BOOLEAN:
- case S_TRISTATE:
- val = sym_get_tristate_value(sym);
- switch (val) {
- case no:
- return "n";
- case mod:
- sym_calc_value(modules_sym);
- return (modules_sym->curr.tri == no) ? "n" : "m";
- case yes:
- return "y";
- }
- break;
- default:
- ;
- }
- return (const char *)sym->curr.val;
-}
-
-bool sym_is_changable(struct symbol *sym)
-{
- return sym->visible > sym->rev_dep.tri;
-}
-
-static unsigned strhash(const char *s)
-{
- /* fnv32 hash */
- unsigned hash = 2166136261U;
- for (; *s; s++)
- hash = (hash ^ *s) * 0x01000193;
- return hash;
-}
-
-struct symbol *sym_lookup(const char *name, int flags)
-{
- struct symbol *symbol;
- char *new_name;
- int hash;
-
- if (name) {
- if (name[0] && !name[1]) {
- switch (name[0]) {
- case 'y': return &symbol_yes;
- case 'm': return &symbol_mod;
- case 'n': return &symbol_no;
- }
- }
- hash = strhash(name) % SYMBOL_HASHSIZE;
-
- for (symbol = symbol_hash[hash]; symbol; symbol = symbol->next) {
- if (symbol->name &&
- !strcmp(symbol->name, name) &&
- (flags ? symbol->flags & flags
- : !(symbol->flags & (SYMBOL_CONST|SYMBOL_CHOICE))))
- return symbol;
- }
- new_name = strdup(name);
- } else {
- new_name = NULL;
- hash = 0;
- }
-
- symbol = xmalloc(sizeof(*symbol));
- memset(symbol, 0, sizeof(*symbol));
- symbol->name = new_name;
- symbol->type = S_UNKNOWN;
- symbol->flags |= flags;
-
- symbol->next = symbol_hash[hash];
- symbol_hash[hash] = symbol;
-
- return symbol;
-}
-
-struct symbol *sym_find(const char *name)
-{
- struct symbol *symbol = NULL;
- int hash = 0;
-
- if (!name)
- return NULL;
-
- if (name[0] && !name[1]) {
- switch (name[0]) {
- case 'y': return &symbol_yes;
- case 'm': return &symbol_mod;
- case 'n': return &symbol_no;
- }
- }
- hash = strhash(name) % SYMBOL_HASHSIZE;
-
- for (symbol = symbol_hash[hash]; symbol; symbol = symbol->next) {
- if (symbol->name &&
- !strcmp(symbol->name, name) &&
- !(symbol->flags & SYMBOL_CONST))
- break;
- }
-
- return symbol;
-}
-
-/*
- * Expand symbol's names embedded in the string given in argument. Symbols'
- * name to be expanded shall be prefixed by a '$'. Unknown symbol expands to
- * the empty string.
- */
-const char *sym_expand_string_value(const char *in)
-{
- const char *src;
- char *res;
- size_t reslen;
-
- reslen = strlen(in) + 1;
- res = xmalloc(reslen);
- res[0] = '\0';
-
- while ((src = strchr(in, '$'))) {
- char *p, name[SYMBOL_MAXLENGTH];
- const char *symval = "";
- struct symbol *sym;
- size_t newlen;
-
- strncat(res, in, src - in);
- src++;
-
- p = name;
- while (isalnum(*src) || *src == '_')
- *p++ = *src++;
- *p = '\0';
-
- sym = sym_find(name);
- if (sym != NULL) {
- sym_calc_value(sym);
- symval = sym_get_string_value(sym);
- }
-
- newlen = strlen(res) + strlen(symval) + strlen(src) + 1;
- if (newlen > reslen) {
- reslen = newlen;
- res = realloc(res, reslen);
- }
-
- strcat(res, symval);
- in = src;
- }
- strcat(res, in);
-
- return res;
-}
-
-const char *sym_escape_string_value(const char *in)
-{
- const char *p;
- size_t reslen;
- char *res;
- size_t l;
-
- reslen = strlen(in) + strlen("\"\"") + 1;
-
- p = in;
- for (;;) {
- l = strcspn(p, "\"\\");
- p += l;
-
- if (p[0] == '\0')
- break;
-
- reslen++;
- p++;
- }
-
- res = xmalloc(reslen);
- res[0] = '\0';
-
- strcat(res, "\"");
-
- p = in;
- for (;;) {
- l = strcspn(p, "\"\\");
- strncat(res, p, l);
- p += l;
-
- if (p[0] == '\0')
- break;
-
- strcat(res, "\\");
- strncat(res, p++, 1);
- }
-
- strcat(res, "\"");
- return res;
-}
-
-struct sym_match {
- struct symbol *sym;
- off_t so, eo;
-};
-
-/* Compare matched symbols as thus:
- * - first, symbols that match exactly
- * - then, alphabetical sort
- */
-static int sym_rel_comp(const void *sym1, const void *sym2)
-{
- const struct sym_match *s1 = sym1;
- const struct sym_match *s2 = sym2;
- int exact1, exact2;
-
- /* Exact match:
- * - if matched length on symbol s1 is the length of that symbol,
- * then this symbol should come first;
- * - if matched length on symbol s2 is the length of that symbol,
- * then this symbol should come first.
- * Note: since the search can be a regexp, both symbols may match
- * exactly; if this is the case, we can't decide which comes first,
- * and we fallback to sorting alphabetically.
- */
- exact1 = (s1->eo - s1->so) == strlen(s1->sym->name);
- exact2 = (s2->eo - s2->so) == strlen(s2->sym->name);
- if (exact1 && !exact2)
- return -1;
- if (!exact1 && exact2)
- return 1;
-
- /* As a fallback, sort symbols alphabetically */
- return strcmp(s1->sym->name, s2->sym->name);
-}
-
-struct symbol **sym_re_search(const char *pattern)
-{
- struct symbol *sym, **sym_arr = NULL;
- struct sym_match *sym_match_arr = NULL;
- int i, cnt, size;
- regex_t re;
- regmatch_t match[1];
-
- cnt = size = 0;
- /* Skip if empty */
- if (strlen(pattern) == 0)
- return NULL;
- if (regcomp(&re, pattern, REG_EXTENDED|REG_ICASE))
- return NULL;
-
- for_all_symbols(i, sym) {
- if (sym->flags & SYMBOL_CONST || !sym->name)
- continue;
- if (regexec(&re, sym->name, 1, match, 0))
- continue;
- if (cnt >= size) {
- void *tmp;
- size += 16;
- tmp = realloc(sym_match_arr, size * sizeof(struct sym_match));
- if (!tmp)
- goto sym_re_search_free;
- sym_match_arr = tmp;
- }
- sym_calc_value(sym);
- /* As regexec returned 0, we know we have a match, so
- * we can use match[0].rm_[se]o without further checks
- */
- sym_match_arr[cnt].so = match[0].rm_so;
- sym_match_arr[cnt].eo = match[0].rm_eo;
- sym_match_arr[cnt++].sym = sym;
- }
- if (sym_match_arr) {
- qsort(sym_match_arr, cnt, sizeof(struct sym_match), sym_rel_comp);
- sym_arr = malloc((cnt+1) * sizeof(struct symbol));
- if (!sym_arr)
- goto sym_re_search_free;
- for (i = 0; i < cnt; i++)
- sym_arr[i] = sym_match_arr[i].sym;
- sym_arr[cnt] = NULL;
- }
-sym_re_search_free:
- /* sym_match_arr can be NULL if no match, but free(NULL) is OK */
- free(sym_match_arr);
- regfree(&re);
-
- return sym_arr;
-}
-
-/*
- * When we check for recursive dependencies we use a stack to save
- * current state so we can print out relevant info to user.
- * The entries are located on the call stack so no need to free memory.
- * Note insert() remove() must always match to properly clear the stack.
- */
-static struct dep_stack {
- struct dep_stack *prev, *next;
- struct symbol *sym;
- struct property *prop;
- struct expr *expr;
-} *check_top;
-
-static void dep_stack_insert(struct dep_stack *stack, struct symbol *sym)
-{
- memset(stack, 0, sizeof(*stack));
- if (check_top)
- check_top->next = stack;
- stack->prev = check_top;
- stack->sym = sym;
- check_top = stack;
-}
-
-static void dep_stack_remove(void)
-{
- check_top = check_top->prev;
- if (check_top)
- check_top->next = NULL;
-}
-
-/*
- * Called when we have detected a recursive dependency.
- * check_top point to the top of the stact so we use
- * the ->prev pointer to locate the bottom of the stack.
- */
-static void sym_check_print_recursive(struct symbol *last_sym)
-{
- struct dep_stack *stack;
- struct symbol *sym, *next_sym;
- struct menu *menu = NULL;
- struct property *prop;
- struct dep_stack cv_stack;
-
- if (sym_is_choice_value(last_sym)) {
- dep_stack_insert(&cv_stack, last_sym);
- last_sym = prop_get_symbol(sym_get_choice_prop(last_sym));
- }
-
- for (stack = check_top; stack != NULL; stack = stack->prev)
- if (stack->sym == last_sym)
- break;
- if (!stack) {
- fprintf(stderr, "unexpected recursive dependency error\n");
- return;
- }
-
- for (; stack; stack = stack->next) {
- sym = stack->sym;
- next_sym = stack->next ? stack->next->sym : last_sym;
- prop = stack->prop;
- if (prop == NULL)
- prop = stack->sym->prop;
-
- /* for choice values find the menu entry (used below) */
- if (sym_is_choice(sym) || sym_is_choice_value(sym)) {
- for (prop = sym->prop; prop; prop = prop->next) {
- menu = prop->menu;
- if (prop->menu)
- break;
- }
- }
- if (stack->sym == last_sym)
- fprintf(stderr, "%s:%d:error: recursive dependency detected!\n",
- prop->file->name, prop->lineno);
- fprintf(stderr, "For a resolution refer to Documentation/kbuild/kconfig-language.txt\n");
- fprintf(stderr, "subsection \"Kconfig recursive dependency limitations\"\n");
- if (stack->expr) {
- fprintf(stderr, "%s:%d:\tsymbol %s %s value contains %s\n",
- prop->file->name, prop->lineno,
- sym->name ? sym->name : "<choice>",
- prop_get_type_name(prop->type),
- next_sym->name ? next_sym->name : "<choice>");
- } else if (stack->prop) {
- fprintf(stderr, "%s:%d:\tsymbol %s depends on %s\n",
- prop->file->name, prop->lineno,
- sym->name ? sym->name : "<choice>",
- next_sym->name ? next_sym->name : "<choice>");
- } else if (sym_is_choice(sym)) {
- fprintf(stderr, "%s:%d:\tchoice %s contains symbol %s\n",
- menu->file->name, menu->lineno,
- sym->name ? sym->name : "<choice>",
- next_sym->name ? next_sym->name : "<choice>");
- } else if (sym_is_choice_value(sym)) {
- fprintf(stderr, "%s:%d:\tsymbol %s is part of choice %s\n",
- menu->file->name, menu->lineno,
- sym->name ? sym->name : "<choice>",
- next_sym->name ? next_sym->name : "<choice>");
- } else {
- fprintf(stderr, "%s:%d:\tsymbol %s is selected by %s\n",
- prop->file->name, prop->lineno,
- sym->name ? sym->name : "<choice>",
- next_sym->name ? next_sym->name : "<choice>");
- }
- }
-
- if (check_top == &cv_stack)
- dep_stack_remove();
-}
-
-static struct symbol *sym_check_expr_deps(struct expr *e)
-{
- struct symbol *sym;
-
- if (!e)
- return NULL;
- switch (e->type) {
- case E_OR:
- case E_AND:
- sym = sym_check_expr_deps(e->left.expr);
- if (sym)
- return sym;
- return sym_check_expr_deps(e->right.expr);
- case E_NOT:
- return sym_check_expr_deps(e->left.expr);
- case E_EQUAL:
- case E_GEQ:
- case E_GTH:
- case E_LEQ:
- case E_LTH:
- case E_UNEQUAL:
- sym = sym_check_deps(e->left.sym);
- if (sym)
- return sym;
- return sym_check_deps(e->right.sym);
- case E_SYMBOL:
- return sym_check_deps(e->left.sym);
- default:
- break;
- }
- printf("Oops! How to check %d?\n", e->type);
- return NULL;
-}
-
-/* return NULL when dependencies are OK */
-static struct symbol *sym_check_sym_deps(struct symbol *sym)
-{
- struct symbol *sym2;
- struct property *prop;
- struct dep_stack stack;
-
- dep_stack_insert(&stack, sym);
-
- sym2 = sym_check_expr_deps(sym->rev_dep.expr);
- if (sym2)
- goto out;
-
- for (prop = sym->prop; prop; prop = prop->next) {
- if (prop->type == P_CHOICE || prop->type == P_SELECT)
- continue;
- stack.prop = prop;
- sym2 = sym_check_expr_deps(prop->visible.expr);
- if (sym2)
- break;
- if (prop->type != P_DEFAULT || sym_is_choice(sym))
- continue;
- stack.expr = prop->expr;
- sym2 = sym_check_expr_deps(prop->expr);
- if (sym2)
- break;
- stack.expr = NULL;
- }
-
-out:
- dep_stack_remove();
-
- return sym2;
-}
-
-static struct symbol *sym_check_choice_deps(struct symbol *choice)
-{
- struct symbol *sym, *sym2;
- struct property *prop;
- struct expr *e;
- struct dep_stack stack;
-
- dep_stack_insert(&stack, choice);
-
- prop = sym_get_choice_prop(choice);
- expr_list_for_each_sym(prop->expr, e, sym)
- sym->flags |= (SYMBOL_CHECK | SYMBOL_CHECKED);
-
- choice->flags |= (SYMBOL_CHECK | SYMBOL_CHECKED);
- sym2 = sym_check_sym_deps(choice);
- choice->flags &= ~SYMBOL_CHECK;
- if (sym2)
- goto out;
-
- expr_list_for_each_sym(prop->expr, e, sym) {
- sym2 = sym_check_sym_deps(sym);
- if (sym2)
- break;
- }
-out:
- expr_list_for_each_sym(prop->expr, e, sym)
- sym->flags &= ~SYMBOL_CHECK;
-
- if (sym2 && sym_is_choice_value(sym2) &&
- prop_get_symbol(sym_get_choice_prop(sym2)) == choice)
- sym2 = choice;
-
- dep_stack_remove();
-
- return sym2;
-}
-
-struct symbol *sym_check_deps(struct symbol *sym)
-{
- struct symbol *sym2;
- struct property *prop;
-
- if (sym->flags & SYMBOL_CHECK) {
- sym_check_print_recursive(sym);
- return sym;
- }
- if (sym->flags & SYMBOL_CHECKED)
- return NULL;
-
- if (sym_is_choice_value(sym)) {
- struct dep_stack stack;
-
- /* for choice groups start the check with main choice symbol */
- dep_stack_insert(&stack, sym);
- prop = sym_get_choice_prop(sym);
- sym2 = sym_check_deps(prop_get_symbol(prop));
- dep_stack_remove();
- } else if (sym_is_choice(sym)) {
- sym2 = sym_check_choice_deps(sym);
- } else {
- sym->flags |= (SYMBOL_CHECK | SYMBOL_CHECKED);
- sym2 = sym_check_sym_deps(sym);
- sym->flags &= ~SYMBOL_CHECK;
- }
-
- if (sym2 && sym2 == sym)
- sym2 = NULL;
-
- return sym2;
-}
-
-struct property *prop_alloc(enum prop_type type, struct symbol *sym)
-{
- struct property *prop;
- struct property **propp;
-
- prop = xmalloc(sizeof(*prop));
- memset(prop, 0, sizeof(*prop));
- prop->type = type;
- prop->sym = sym;
- prop->file = current_file;
- prop->lineno = zconf_lineno();
-
- /* append property to the prop list of symbol */
- if (sym) {
- for (propp = &sym->prop; *propp; propp = &(*propp)->next)
- ;
- *propp = prop;
- }
-
- return prop;
-}
-
-struct symbol *prop_get_symbol(struct property *prop)
-{
- if (prop->expr && (prop->expr->type == E_SYMBOL ||
- prop->expr->type == E_LIST))
- return prop->expr->left.sym;
- return NULL;
-}
-
-const char *prop_get_type_name(enum prop_type type)
-{
- switch (type) {
- case P_PROMPT:
- return "prompt";
- case P_ENV:
- return "env";
- case P_COMMENT:
- return "comment";
- case P_MENU:
- return "menu";
- case P_DEFAULT:
- return "default";
- case P_CHOICE:
- return "choice";
- case P_SELECT:
- return "select";
- case P_RANGE:
- return "range";
- case P_SYMBOL:
- return "symbol";
- case P_UNKNOWN:
- break;
- }
- return "unknown";
-}
-
-static void prop_add_env(const char *env)
-{
- struct symbol *sym, *sym2;
- struct property *prop;
- char *p;
-
- sym = current_entry->sym;
- sym->flags |= SYMBOL_AUTO;
- for_all_properties(sym, prop, P_ENV) {
- sym2 = prop_get_symbol(prop);
- if (strcmp(sym2->name, env))
- menu_warn(current_entry, "redefining environment symbol from %s",
- sym2->name);
- return;
- }
-
- prop = prop_alloc(P_ENV, sym);
- prop->expr = expr_alloc_symbol(sym_lookup(env, SYMBOL_CONST));
-
- sym_env_list = expr_alloc_one(E_LIST, sym_env_list);
- sym_env_list->right.sym = sym;
-
- p = getenv(env);
- if (p)
- sym_add_default(sym, p);
- else
- menu_warn(current_entry, "environment variable %s undefined", env);
-}
+++ /dev/null
-/*
- * Copyright (C) 2002-2005 Roman Zippel <zippel@linux-m68k.org>
- * Copyright (C) 2002-2005 Sam Ravnborg <sam@ravnborg.org>
- *
- * Released under the terms of the GNU GPL v2.0.
- */
-
-#include <stdarg.h>
-#include <stdlib.h>
-#include <string.h>
-#include "lkc.h"
-
-/* file already present in list? If not add it */
-struct file *file_lookup(const char *name)
-{
- struct file *file;
- const char *file_name = sym_expand_string_value(name);
-
- for (file = file_list; file; file = file->next) {
- if (!strcmp(name, file->name)) {
- free((void *)file_name);
- return file;
- }
- }
-
- file = xmalloc(sizeof(*file));
- memset(file, 0, sizeof(*file));
- file->name = file_name;
- file->next = file_list;
- file_list = file;
- return file;
-}
-
-/* write a dependency file as used by kbuild to track dependencies */
-int file_write_dep(const char *name)
-{
- struct symbol *sym, *env_sym;
- struct expr *e;
- struct file *file;
- FILE *out;
-
- if (!name)
- name = ".kconfig.d";
- out = fopen("..config.tmp", "w");
- if (!out)
- return 1;
- fprintf(out, "deps_config := \\\n");
- for (file = file_list; file; file = file->next) {
- if (file->next)
- fprintf(out, "\t%s \\\n", file->name);
- else
- fprintf(out, "\t%s\n", file->name);
- }
- fprintf(out, "\n%s: \\\n"
- "\t$(deps_config)\n\n", conf_get_autoconfig_name());
-
- expr_list_for_each_sym(sym_env_list, e, sym) {
- struct property *prop;
- const char *value;
-
- prop = sym_get_env_prop(sym);
- env_sym = prop_get_symbol(prop);
- if (!env_sym)
- continue;
- value = getenv(env_sym->name);
- if (!value)
- value = "";
- fprintf(out, "ifneq \"$(%s)\" \"%s\"\n", env_sym->name, value);
- fprintf(out, "%s: FORCE\n", conf_get_autoconfig_name());
- fprintf(out, "endif\n");
- }
-
- fprintf(out, "\n$(deps_config): ;\n");
- fclose(out);
- rename("..config.tmp", name);
- return 0;
-}
-
-
-/* Allocate initial growable string */
-struct gstr str_new(void)
-{
- struct gstr gs;
- gs.s = xmalloc(sizeof(char) * 64);
- gs.len = 64;
- gs.max_width = 0;
- strcpy(gs.s, "\0");
- return gs;
-}
-
-/* Free storage for growable string */
-void str_free(struct gstr *gs)
-{
- if (gs->s)
- free(gs->s);
- gs->s = NULL;
- gs->len = 0;
-}
-
-/* Append to growable string */
-void str_append(struct gstr *gs, const char *s)
-{
- size_t l;
- if (s) {
- l = strlen(gs->s) + strlen(s) + 1;
- if (l > gs->len) {
- gs->s = realloc(gs->s, l);
- gs->len = l;
- }
- strcat(gs->s, s);
- }
-}
-
-/* Append printf formatted string to growable string */
-void str_printf(struct gstr *gs, const char *fmt, ...)
-{
- va_list ap;
- char s[10000]; /* big enough... */
- va_start(ap, fmt);
- vsnprintf(s, sizeof(s), fmt, ap);
- str_append(gs, s);
- va_end(ap);
-}
-
-/* Retrieve value of growable string */
-const char *str_get(struct gstr *gs)
-{
- return gs->s;
-}
-
-void *xmalloc(size_t size)
-{
- void *p = malloc(size);
- if (p)
- return p;
- fprintf(stderr, "Out of memory.\n");
- exit(1);
-}
-
-void *xcalloc(size_t nmemb, size_t size)
-{
- void *p = calloc(nmemb, size);
- if (p)
- return p;
- fprintf(stderr, "Out of memory.\n");
- exit(1);
-}
+++ /dev/null
-%language=ANSI-C
-%define hash-function-name kconf_id_hash
-%define lookup-function-name kconf_id_lookup
-%define string-pool-name kconf_id_strings
-%compare-strncmp
-%enum
-%pic
-%struct-type
-
-struct kconf_id;
-
-%%
-mainmenu, T_MAINMENU, TF_COMMAND
-menu, T_MENU, TF_COMMAND
-endmenu, T_ENDMENU, TF_COMMAND
-source, T_SOURCE, TF_COMMAND
-choice, T_CHOICE, TF_COMMAND
-endchoice, T_ENDCHOICE, TF_COMMAND
-comment, T_COMMENT, TF_COMMAND
-config, T_CONFIG, TF_COMMAND
-menuconfig, T_MENUCONFIG, TF_COMMAND
-help, T_HELP, TF_COMMAND
----help---, T_HELP, TF_COMMAND
-if, T_IF, TF_COMMAND|TF_PARAM
-endif, T_ENDIF, TF_COMMAND
-depends, T_DEPENDS, TF_COMMAND
-optional, T_OPTIONAL, TF_COMMAND
-default, T_DEFAULT, TF_COMMAND, S_UNKNOWN
-prompt, T_PROMPT, TF_COMMAND
-tristate, T_TYPE, TF_COMMAND, S_TRISTATE
-def_tristate, T_DEFAULT, TF_COMMAND, S_TRISTATE
-bool, T_TYPE, TF_COMMAND, S_BOOLEAN
-boolean, T_TYPE, TF_COMMAND, S_BOOLEAN
-def_bool, T_DEFAULT, TF_COMMAND, S_BOOLEAN
-int, T_TYPE, TF_COMMAND, S_INT
-hex, T_TYPE, TF_COMMAND, S_HEX
-string, T_TYPE, TF_COMMAND, S_STRING
-select, T_SELECT, TF_COMMAND
-range, T_RANGE, TF_COMMAND
-visible, T_VISIBLE, TF_COMMAND
-option, T_OPTION, TF_COMMAND
-on, T_ON, TF_PARAM
-modules, T_OPT_MODULES, TF_OPTION
-defconfig_list, T_OPT_DEFCONFIG_LIST,TF_OPTION
-env, T_OPT_ENV, TF_OPTION
-allnoconfig_y, T_OPT_ALLNOCONFIG_Y,TF_OPTION
-%%
+++ /dev/null
-/* ANSI-C code produced by gperf version 3.0.3 */
-/* Command-line: /Applications/Xcode.app/Contents/Developer/Toolchains/XcodeDefault.xctoolchain/usr/bin/gperf -t --output-file zconf.hash.c -a -C -E -g -k '1,3,$' -p -t */
-
-#if !((' ' == 32) && ('!' == 33) && ('"' == 34) && ('#' == 35) \
- && ('%' == 37) && ('&' == 38) && ('\'' == 39) && ('(' == 40) \
- && (')' == 41) && ('*' == 42) && ('+' == 43) && (',' == 44) \
- && ('-' == 45) && ('.' == 46) && ('/' == 47) && ('0' == 48) \
- && ('1' == 49) && ('2' == 50) && ('3' == 51) && ('4' == 52) \
- && ('5' == 53) && ('6' == 54) && ('7' == 55) && ('8' == 56) \
- && ('9' == 57) && (':' == 58) && (';' == 59) && ('<' == 60) \
- && ('=' == 61) && ('>' == 62) && ('?' == 63) && ('A' == 65) \
- && ('B' == 66) && ('C' == 67) && ('D' == 68) && ('E' == 69) \
- && ('F' == 70) && ('G' == 71) && ('H' == 72) && ('I' == 73) \
- && ('J' == 74) && ('K' == 75) && ('L' == 76) && ('M' == 77) \
- && ('N' == 78) && ('O' == 79) && ('P' == 80) && ('Q' == 81) \
- && ('R' == 82) && ('S' == 83) && ('T' == 84) && ('U' == 85) \
- && ('V' == 86) && ('W' == 87) && ('X' == 88) && ('Y' == 89) \
- && ('Z' == 90) && ('[' == 91) && ('\\' == 92) && (']' == 93) \
- && ('^' == 94) && ('_' == 95) && ('a' == 97) && ('b' == 98) \
- && ('c' == 99) && ('d' == 100) && ('e' == 101) && ('f' == 102) \
- && ('g' == 103) && ('h' == 104) && ('i' == 105) && ('j' == 106) \
- && ('k' == 107) && ('l' == 108) && ('m' == 109) && ('n' == 110) \
- && ('o' == 111) && ('p' == 112) && ('q' == 113) && ('r' == 114) \
- && ('s' == 115) && ('t' == 116) && ('u' == 117) && ('v' == 118) \
- && ('w' == 119) && ('x' == 120) && ('y' == 121) && ('z' == 122) \
- && ('{' == 123) && ('|' == 124) && ('}' == 125) && ('~' == 126))
-/* The character set is not based on ISO-646. */
-#error "gperf generated tables don't work with this execution character set. Please report a bug to <bug-gnu-gperf@gnu.org>."
-#endif
-
-struct kconf_id;
-/* maximum key range = 71, duplicates = 0 */
-
-#ifdef __GNUC__
-__inline
-#else
-#ifdef __cplusplus
-inline
-#endif
-#endif
-static unsigned int
-kconf_id_hash (register const char *str, register unsigned int len)
-{
- static const unsigned char asso_values[] =
- {
- 73, 73, 73, 73, 73, 73, 73, 73, 73, 73,
- 73, 73, 73, 73, 73, 73, 73, 73, 73, 73,
- 73, 73, 73, 73, 73, 73, 73, 73, 73, 73,
- 73, 73, 73, 73, 73, 73, 73, 73, 73, 73,
- 73, 73, 73, 73, 73, 0, 73, 73, 73, 73,
- 73, 73, 73, 73, 73, 73, 73, 73, 73, 73,
- 73, 73, 73, 73, 73, 73, 73, 73, 73, 73,
- 73, 73, 73, 73, 73, 73, 73, 73, 73, 73,
- 73, 73, 73, 73, 73, 73, 73, 73, 73, 73,
- 73, 73, 73, 73, 73, 73, 73, 5, 25, 25,
- 0, 0, 0, 5, 0, 0, 73, 73, 5, 0,
- 10, 5, 45, 73, 20, 20, 0, 15, 15, 73,
- 20, 5, 73, 73, 73, 73, 73, 73, 73, 73,
- 73, 73, 73, 73, 73, 73, 73, 73, 73, 73,
- 73, 73, 73, 73, 73, 73, 73, 73, 73, 73,
- 73, 73, 73, 73, 73, 73, 73, 73, 73, 73,
- 73, 73, 73, 73, 73, 73, 73, 73, 73, 73,
- 73, 73, 73, 73, 73, 73, 73, 73, 73, 73,
- 73, 73, 73, 73, 73, 73, 73, 73, 73, 73,
- 73, 73, 73, 73, 73, 73, 73, 73, 73, 73,
- 73, 73, 73, 73, 73, 73, 73, 73, 73, 73,
- 73, 73, 73, 73, 73, 73, 73, 73, 73, 73,
- 73, 73, 73, 73, 73, 73, 73, 73, 73, 73,
- 73, 73, 73, 73, 73, 73, 73, 73, 73, 73,
- 73, 73, 73, 73, 73, 73, 73, 73, 73, 73,
- 73, 73, 73, 73, 73, 73
- };
- register unsigned int hval = len;
-
- switch (hval)
- {
- default:
- hval += asso_values[(unsigned char)str[2]];
- /*FALLTHROUGH*/
- case 2:
- case 1:
- hval += asso_values[(unsigned char)str[0]];
- break;
- }
- return hval + asso_values[(unsigned char)str[len - 1]];
-}
-
-struct kconf_id_strings_t
- {
- char kconf_id_strings_str2[sizeof("if")];
- char kconf_id_strings_str3[sizeof("int")];
- char kconf_id_strings_str5[sizeof("endif")];
- char kconf_id_strings_str7[sizeof("default")];
- char kconf_id_strings_str8[sizeof("tristate")];
- char kconf_id_strings_str9[sizeof("endchoice")];
- char kconf_id_strings_str10[sizeof("---help---")];
- char kconf_id_strings_str12[sizeof("def_tristate")];
- char kconf_id_strings_str13[sizeof("def_bool")];
- char kconf_id_strings_str14[sizeof("defconfig_list")];
- char kconf_id_strings_str17[sizeof("on")];
- char kconf_id_strings_str18[sizeof("optional")];
- char kconf_id_strings_str21[sizeof("option")];
- char kconf_id_strings_str22[sizeof("endmenu")];
- char kconf_id_strings_str23[sizeof("mainmenu")];
- char kconf_id_strings_str25[sizeof("menuconfig")];
- char kconf_id_strings_str27[sizeof("modules")];
- char kconf_id_strings_str28[sizeof("allnoconfig_y")];
- char kconf_id_strings_str29[sizeof("menu")];
- char kconf_id_strings_str31[sizeof("select")];
- char kconf_id_strings_str32[sizeof("comment")];
- char kconf_id_strings_str33[sizeof("env")];
- char kconf_id_strings_str35[sizeof("range")];
- char kconf_id_strings_str36[sizeof("choice")];
- char kconf_id_strings_str39[sizeof("bool")];
- char kconf_id_strings_str41[sizeof("source")];
- char kconf_id_strings_str42[sizeof("visible")];
- char kconf_id_strings_str43[sizeof("hex")];
- char kconf_id_strings_str46[sizeof("config")];
- char kconf_id_strings_str47[sizeof("boolean")];
- char kconf_id_strings_str51[sizeof("string")];
- char kconf_id_strings_str54[sizeof("help")];
- char kconf_id_strings_str56[sizeof("prompt")];
- char kconf_id_strings_str72[sizeof("depends")];
- };
-static const struct kconf_id_strings_t kconf_id_strings_contents =
- {
- "if",
- "int",
- "endif",
- "default",
- "tristate",
- "endchoice",
- "---help---",
- "def_tristate",
- "def_bool",
- "defconfig_list",
- "on",
- "optional",
- "option",
- "endmenu",
- "mainmenu",
- "menuconfig",
- "modules",
- "allnoconfig_y",
- "menu",
- "select",
- "comment",
- "env",
- "range",
- "choice",
- "bool",
- "source",
- "visible",
- "hex",
- "config",
- "boolean",
- "string",
- "help",
- "prompt",
- "depends"
- };
-#define kconf_id_strings ((const char *) &kconf_id_strings_contents)
-const struct kconf_id *
-kconf_id_lookup (register const char *str, register unsigned int len)
-{
- enum
- {
- TOTAL_KEYWORDS = 34,
- MIN_WORD_LENGTH = 2,
- MAX_WORD_LENGTH = 14,
- MIN_HASH_VALUE = 2,
- MAX_HASH_VALUE = 72
- };
-
- static const struct kconf_id wordlist[] =
- {
- {-1}, {-1},
- {offsetof(struct kconf_id_strings_t, kconf_id_strings_str2), T_IF, TF_COMMAND|TF_PARAM},
- {offsetof(struct kconf_id_strings_t, kconf_id_strings_str3), T_TYPE, TF_COMMAND, S_INT},
- {-1},
- {offsetof(struct kconf_id_strings_t, kconf_id_strings_str5), T_ENDIF, TF_COMMAND},
- {-1},
- {offsetof(struct kconf_id_strings_t, kconf_id_strings_str7), T_DEFAULT, TF_COMMAND, S_UNKNOWN},
- {offsetof(struct kconf_id_strings_t, kconf_id_strings_str8), T_TYPE, TF_COMMAND, S_TRISTATE},
- {offsetof(struct kconf_id_strings_t, kconf_id_strings_str9), T_ENDCHOICE, TF_COMMAND},
- {offsetof(struct kconf_id_strings_t, kconf_id_strings_str10), T_HELP, TF_COMMAND},
- {-1},
- {offsetof(struct kconf_id_strings_t, kconf_id_strings_str12), T_DEFAULT, TF_COMMAND, S_TRISTATE},
- {offsetof(struct kconf_id_strings_t, kconf_id_strings_str13), T_DEFAULT, TF_COMMAND, S_BOOLEAN},
- {offsetof(struct kconf_id_strings_t, kconf_id_strings_str14), T_OPT_DEFCONFIG_LIST,TF_OPTION},
- {-1}, {-1},
- {offsetof(struct kconf_id_strings_t, kconf_id_strings_str17), T_ON, TF_PARAM},
- {offsetof(struct kconf_id_strings_t, kconf_id_strings_str18), T_OPTIONAL, TF_COMMAND},
- {-1}, {-1},
- {offsetof(struct kconf_id_strings_t, kconf_id_strings_str21), T_OPTION, TF_COMMAND},
- {offsetof(struct kconf_id_strings_t, kconf_id_strings_str22), T_ENDMENU, TF_COMMAND},
- {offsetof(struct kconf_id_strings_t, kconf_id_strings_str23), T_MAINMENU, TF_COMMAND},
- {-1},
- {offsetof(struct kconf_id_strings_t, kconf_id_strings_str25), T_MENUCONFIG, TF_COMMAND},
- {-1},
- {offsetof(struct kconf_id_strings_t, kconf_id_strings_str27), T_OPT_MODULES, TF_OPTION},
- {offsetof(struct kconf_id_strings_t, kconf_id_strings_str28), T_OPT_ALLNOCONFIG_Y,TF_OPTION},
- {offsetof(struct kconf_id_strings_t, kconf_id_strings_str29), T_MENU, TF_COMMAND},
- {-1},
- {offsetof(struct kconf_id_strings_t, kconf_id_strings_str31), T_SELECT, TF_COMMAND},
- {offsetof(struct kconf_id_strings_t, kconf_id_strings_str32), T_COMMENT, TF_COMMAND},
- {offsetof(struct kconf_id_strings_t, kconf_id_strings_str33), T_OPT_ENV, TF_OPTION},
- {-1},
- {offsetof(struct kconf_id_strings_t, kconf_id_strings_str35), T_RANGE, TF_COMMAND},
- {offsetof(struct kconf_id_strings_t, kconf_id_strings_str36), T_CHOICE, TF_COMMAND},
- {-1}, {-1},
- {offsetof(struct kconf_id_strings_t, kconf_id_strings_str39), T_TYPE, TF_COMMAND, S_BOOLEAN},
- {-1},
- {offsetof(struct kconf_id_strings_t, kconf_id_strings_str41), T_SOURCE, TF_COMMAND},
- {offsetof(struct kconf_id_strings_t, kconf_id_strings_str42), T_VISIBLE, TF_COMMAND},
- {offsetof(struct kconf_id_strings_t, kconf_id_strings_str43), T_TYPE, TF_COMMAND, S_HEX},
- {-1}, {-1},
- {offsetof(struct kconf_id_strings_t, kconf_id_strings_str46), T_CONFIG, TF_COMMAND},
- {offsetof(struct kconf_id_strings_t, kconf_id_strings_str47), T_TYPE, TF_COMMAND, S_BOOLEAN},
- {-1}, {-1}, {-1},
- {offsetof(struct kconf_id_strings_t, kconf_id_strings_str51), T_TYPE, TF_COMMAND, S_STRING},
- {-1}, {-1},
- {offsetof(struct kconf_id_strings_t, kconf_id_strings_str54), T_HELP, TF_COMMAND},
- {-1},
- {offsetof(struct kconf_id_strings_t, kconf_id_strings_str56), T_PROMPT, TF_COMMAND},
- {-1}, {-1}, {-1}, {-1}, {-1}, {-1}, {-1}, {-1}, {-1},
- {-1}, {-1}, {-1}, {-1}, {-1}, {-1},
- {offsetof(struct kconf_id_strings_t, kconf_id_strings_str72), T_DEPENDS, TF_COMMAND}
- };
-
- if (len <= MAX_WORD_LENGTH && len >= MIN_WORD_LENGTH)
- {
- unsigned int key = kconf_id_hash (str, len);
-
- if (key <= MAX_HASH_VALUE)
- {
- register int o = wordlist[key].name;
- if (o >= 0)
- {
- register const char *s = o + kconf_id_strings;
-
- if (*str == *s && !strncmp (str + 1, s + 1, len - 1) && s[len] == '\0')
- return &wordlist[key];
- }
- }
- }
- return 0;
-}
-
+++ /dev/null
-%option nostdinit noyywrap never-interactive full ecs
-%option 8bit perf-report perf-report
-%option noinput
-%x COMMAND HELP STRING PARAM
-%{
-/*
- * Copyright (C) 2002 Roman Zippel <zippel@linux-m68k.org>
- * Released under the terms of the GNU GPL v2.0.
- */
-
-#include <limits.h>
-#include <stdio.h>
-#include <stdlib.h>
-#include <string.h>
-#include <unistd.h>
-#include <wordexp.h>
-
-#include "lkc.h"
-
-#define START_STRSIZE 16
-
-static struct {
- struct file *file;
- int lineno;
-} current_pos;
-
-static char *text;
-static int text_size, text_asize;
-
-struct buffer {
- struct buffer *parent;
- YY_BUFFER_STATE state;
-};
-
-struct buffer *current_buf;
-
-static int last_ts, first_ts;
-
-static void zconf_endhelp(void);
-static void zconf_endfile(void);
-
-static void new_string(void)
-{
- text = xmalloc(START_STRSIZE);
- text_asize = START_STRSIZE;
- text_size = 0;
- *text = 0;
-}
-
-static void append_string(const char *str, int size)
-{
- int new_size = text_size + size + 1;
- if (new_size > text_asize) {
- new_size += START_STRSIZE - 1;
- new_size &= -START_STRSIZE;
- text = realloc(text, new_size);
- text_asize = new_size;
- }
- memcpy(text + text_size, str, size);
- text_size += size;
- text[text_size] = 0;
-}
-
-static void alloc_string(const char *str, int size)
-{
- text = xmalloc(size + 1);
- memcpy(text, str, size);
- text[size] = 0;
-}
-
-static void warn_ignored_character(char chr)
-{
- fprintf(stderr,
- "%s:%d:warning: ignoring unsupported character '%c'\n",
- zconf_curname(), zconf_lineno(), chr);
-}
-%}
-
-n [A-Za-z0-9_-]
-
-%%
- int str = 0;
- int ts, i;
-
-[ \t]*#.*\n |
-[ \t]*\n {
- current_file->lineno++;
- return T_EOL;
-}
-[ \t]*#.*
-
-
-[ \t]+ {
- BEGIN(COMMAND);
-}
-
-. {
- unput(yytext[0]);
- BEGIN(COMMAND);
-}
-
-
-<COMMAND>{
- {n}+ {
- const struct kconf_id *id = kconf_id_lookup(yytext, yyleng);
- BEGIN(PARAM);
- current_pos.file = current_file;
- current_pos.lineno = current_file->lineno;
- if (id && id->flags & TF_COMMAND) {
- zconflval.id = id;
- return id->token;
- }
- alloc_string(yytext, yyleng);
- zconflval.string = text;
- return T_WORD;
- }
- [^\r\n] warn_ignored_character(*yytext);
- \r?\n {
- BEGIN(INITIAL);
- current_file->lineno++;
- return T_EOL;
- }
-}
-
-<PARAM>{
- "&&" return T_AND;
- "||" return T_OR;
- "(" return T_OPEN_PAREN;
- ")" return T_CLOSE_PAREN;
- "!" return T_NOT;
- "=" return T_EQUAL;
- "!=" return T_UNEQUAL;
- "<=" return T_LESS_EQUAL;
- ">=" return T_GREATER_EQUAL;
- "<" return T_LESS;
- ">" return T_GREATER;
- \"|\' {
- str = yytext[0];
- new_string();
- BEGIN(STRING);
- }
- \r?\n BEGIN(INITIAL); current_file->lineno++; return T_EOL;
- ({n}|[/.])+ {
- const struct kconf_id *id = kconf_id_lookup(yytext, yyleng);
- if (id && id->flags & TF_PARAM) {
- zconflval.id = id;
- return id->token;
- }
- alloc_string(yytext, yyleng);
- zconflval.string = text;
- return T_WORD;
- }
- #.* /* comment */
- \\\n current_file->lineno++;
- [[:blank:]]+
- . warn_ignored_character(*yytext);
- <<EOF>> {
- BEGIN(INITIAL);
- }
-}
-
-<STRING>{
- [^'"\\\n]+/\n {
- append_string(yytext, yyleng);
- zconflval.string = text;
- return T_WORD_QUOTE;
- }
- [^'"\\\n]+ {
- append_string(yytext, yyleng);
- }
- \\.?/\n {
- append_string(yytext + 1, yyleng - 1);
- zconflval.string = text;
- return T_WORD_QUOTE;
- }
- \\.? {
- append_string(yytext + 1, yyleng - 1);
- }
- \'|\" {
- if (str == yytext[0]) {
- BEGIN(PARAM);
- zconflval.string = text;
- return T_WORD_QUOTE;
- } else
- append_string(yytext, 1);
- }
- \r?\n {
- printf("%s:%d:warning: multi-line strings not supported\n", zconf_curname(), zconf_lineno());
- current_file->lineno++;
- BEGIN(INITIAL);
- return T_EOL;
- }
- <<EOF>> {
- BEGIN(INITIAL);
- }
-}
-
-<HELP>{
- [ \t]+ {
- ts = 0;
- for (i = 0; i < yyleng; i++) {
- if (yytext[i] == '\t')
- ts = (ts & ~7) + 8;
- else
- ts++;
- }
- last_ts = ts;
- if (first_ts) {
- if (ts < first_ts) {
- zconf_endhelp();
- return T_HELPTEXT;
- }
- ts -= first_ts;
- while (ts > 8) {
- append_string(" ", 8);
- ts -= 8;
- }
- append_string(" ", ts);
- }
- }
- [ \t]*\r?\n/[^ \t\r\n] {
- current_file->lineno++;
- zconf_endhelp();
- return T_HELPTEXT;
- }
- [ \t]*\r?\n {
- current_file->lineno++;
- append_string("\n", 1);
- }
- [^ \t\r?\n].* {
- while (yyleng) {
- if ((yytext[yyleng-1] != ' ') && (yytext[yyleng-1] != '\t'))
- break;
- yyleng--;
- }
- append_string(yytext, yyleng);
- if (!first_ts)
- first_ts = last_ts;
- }
- <<EOF>> {
- zconf_endhelp();
- return T_HELPTEXT;
- }
-}
-
-<<EOF>> {
- if (current_file) {
- zconf_endfile();
- return T_EOL;
- }
- fclose(yyin);
- yyterminate();
-}
-
-%%
-void zconf_starthelp(void)
-{
- new_string();
- last_ts = first_ts = 0;
- BEGIN(HELP);
-}
-
-static void zconf_endhelp(void)
-{
- zconflval.string = text;
- BEGIN(INITIAL);
-}
-
-
-/*
- * Try to open specified file with following names:
- * ./name
- * $(srctree)/name
- * The latter is used when srctree is separate from objtree
- * when compiling the kernel.
- * Return NULL if file is not found.
- */
-FILE *zconf_fopen(const char *name)
-{
- char *env, fullname[PATH_MAX+1];
- FILE *f;
-
- f = fopen(name, "r");
- if (!f && name != NULL && name[0] != '/') {
- env = getenv(SRCTREE);
- if (env) {
- sprintf(fullname, "%s/%s", env, name);
- f = fopen(fullname, "r");
- }
- }
- return f;
-}
-
-void zconf_initscan(const char *name)
-{
- yyin = zconf_fopen(name);
- if (!yyin) {
- printf("can't find file %s\n", name);
- exit(1);
- }
-
- current_buf = xmalloc(sizeof(*current_buf));
- memset(current_buf, 0, sizeof(*current_buf));
-
- current_file = file_lookup(name);
- current_file->lineno = 1;
-}
-
-void zconf_nextfile(const char *name)
-{
- struct file *iter;
- struct file *file = file_lookup(name);
- struct buffer *buf = xmalloc(sizeof(*buf));
- memset(buf, 0, sizeof(*buf));
-
- current_buf->state = YY_CURRENT_BUFFER;
- yyin = zconf_fopen(file->name);
- if (!yyin) {
- printf("%s:%d: can't open file \"%s\"\n",
- zconf_curname(), zconf_lineno(), file->name);
- exit(1);
- }
- yy_switch_to_buffer(yy_create_buffer(yyin, YY_BUF_SIZE));
- buf->parent = current_buf;
- current_buf = buf;
-
- for (iter = current_file->parent; iter; iter = iter->parent ) {
- if (!strcmp(current_file->name,iter->name) ) {
- printf("%s:%d: recursive inclusion detected. "
- "Inclusion path:\n current file : '%s'\n",
- zconf_curname(), zconf_lineno(),
- zconf_curname());
- iter = current_file->parent;
- while (iter && \
- strcmp(iter->name,current_file->name)) {
- printf(" included from: '%s:%d'\n",
- iter->name, iter->lineno-1);
- iter = iter->parent;
- }
- if (iter)
- printf(" included from: '%s:%d'\n",
- iter->name, iter->lineno+1);
- exit(1);
- }
- }
- file->lineno = 1;
- file->parent = current_file;
- current_file = file;
-}
-
-void zconf_nextfiles(const char *wildcard)
-{
- wordexp_t p;
- char **w;
- int i;
-
- wordexp(wildcard, &p, 0);
- w = p.we_wordv;
-
- for (i = p.we_wordc - 1; i >= 0; i--)
- zconf_nextfile(w[i]);
-
- wordfree(&p);
-}
-
-static void zconf_endfile(void)
-{
- struct buffer *parent;
-
- current_file = current_file->parent;
-
- parent = current_buf->parent;
- if (parent) {
- fclose(yyin);
- yy_delete_buffer(YY_CURRENT_BUFFER);
- yy_switch_to_buffer(parent->state);
- }
- free(current_buf);
- current_buf = parent;
-}
-
-int zconf_lineno(void)
-{
- return current_pos.lineno;
-}
-
-const char *zconf_curname(void)
-{
- return current_pos.file ? current_pos.file->name : "<none>";
-}
+++ /dev/null
-
-#line 3 "zconf.lex.c"
-
-#define YY_INT_ALIGNED short int
-
-/* A lexical scanner generated by flex */
-
-#define yy_create_buffer zconf_create_buffer
-#define yy_delete_buffer zconf_delete_buffer
-#define yy_flex_debug zconf_flex_debug
-#define yy_init_buffer zconf_init_buffer
-#define yy_flush_buffer zconf_flush_buffer
-#define yy_load_buffer_state zconf_load_buffer_state
-#define yy_switch_to_buffer zconf_switch_to_buffer
-#define yyin zconfin
-#define yyleng zconfleng
-#define yylex zconflex
-#define yylineno zconflineno
-#define yyout zconfout
-#define yyrestart zconfrestart
-#define yytext zconftext
-#define yywrap zconfwrap
-#define yyalloc zconfalloc
-#define yyrealloc zconfrealloc
-#define yyfree zconffree
-
-#define FLEX_SCANNER
-#define YY_FLEX_MAJOR_VERSION 2
-#define YY_FLEX_MINOR_VERSION 5
-#define YY_FLEX_SUBMINOR_VERSION 35
-#if YY_FLEX_SUBMINOR_VERSION > 0
-#define FLEX_BETA
-#endif
-
-/* First, we deal with platform-specific or compiler-specific issues. */
-
-/* begin standard C headers. */
-#include <stdio.h>
-#include <string.h>
-#include <errno.h>
-#include <stdlib.h>
-
-/* end standard C headers. */
-
-/* flex integer type definitions */
-
-#ifndef FLEXINT_H
-#define FLEXINT_H
-
-/* C99 systems have <inttypes.h>. Non-C99 systems may or may not. */
-
-#if defined (__STDC_VERSION__) && __STDC_VERSION__ >= 199901L
-
-/* C99 says to define __STDC_LIMIT_MACROS before including stdint.h,
- * if you want the limit (max/min) macros for int types.
- */
-#ifndef __STDC_LIMIT_MACROS
-#define __STDC_LIMIT_MACROS 1
-#endif
-
-#include <inttypes.h>
-typedef int8_t flex_int8_t;
-typedef uint8_t flex_uint8_t;
-typedef int16_t flex_int16_t;
-typedef uint16_t flex_uint16_t;
-typedef int32_t flex_int32_t;
-typedef uint32_t flex_uint32_t;
-typedef uint64_t flex_uint64_t;
-#else
-typedef signed char flex_int8_t;
-typedef short int flex_int16_t;
-typedef int flex_int32_t;
-typedef unsigned char flex_uint8_t;
-typedef unsigned short int flex_uint16_t;
-typedef unsigned int flex_uint32_t;
-#endif /* ! C99 */
-
-/* Limits of integral types. */
-#ifndef INT8_MIN
-#define INT8_MIN (-128)
-#endif
-#ifndef INT16_MIN
-#define INT16_MIN (-32767-1)
-#endif
-#ifndef INT32_MIN
-#define INT32_MIN (-2147483647-1)
-#endif
-#ifndef INT8_MAX
-#define INT8_MAX (127)
-#endif
-#ifndef INT16_MAX
-#define INT16_MAX (32767)
-#endif
-#ifndef INT32_MAX
-#define INT32_MAX (2147483647)
-#endif
-#ifndef UINT8_MAX
-#define UINT8_MAX (255U)
-#endif
-#ifndef UINT16_MAX
-#define UINT16_MAX (65535U)
-#endif
-#ifndef UINT32_MAX
-#define UINT32_MAX (4294967295U)
-#endif
-
-#endif /* ! FLEXINT_H */
-
-#ifdef __cplusplus
-
-/* The "const" storage-class-modifier is valid. */
-#define YY_USE_CONST
-
-#else /* ! __cplusplus */
-
-/* C99 requires __STDC__ to be defined as 1. */
-#if defined (__STDC__)
-
-#define YY_USE_CONST
-
-#endif /* defined (__STDC__) */
-#endif /* ! __cplusplus */
-
-#ifdef YY_USE_CONST
-#define yyconst const
-#else
-#define yyconst
-#endif
-
-/* Returned upon end-of-file. */
-#define YY_NULL 0
-
-/* Promotes a possibly negative, possibly signed char to an unsigned
- * integer for use as an array index. If the signed char is negative,
- * we want to instead treat it as an 8-bit unsigned char, hence the
- * double cast.
- */
-#define YY_SC_TO_UI(c) ((unsigned int) (unsigned char) c)
-
-/* Enter a start condition. This macro really ought to take a parameter,
- * but we do it the disgusting crufty way forced on us by the ()-less
- * definition of BEGIN.
- */
-#define BEGIN (yy_start) = 1 + 2 *
-
-/* Translate the current start state into a value that can be later handed
- * to BEGIN to return to the state. The YYSTATE alias is for lex
- * compatibility.
- */
-#define YY_START (((yy_start) - 1) / 2)
-#define YYSTATE YY_START
-
-/* Action number for EOF rule of a given start state. */
-#define YY_STATE_EOF(state) (YY_END_OF_BUFFER + state + 1)
-
-/* Special action meaning "start processing a new file". */
-#define YY_NEW_FILE zconfrestart(zconfin )
-
-#define YY_END_OF_BUFFER_CHAR 0
-
-/* Size of default input buffer. */
-#ifndef YY_BUF_SIZE
-#define YY_BUF_SIZE 16384
-#endif
-
-/* The state buf must be large enough to hold one state per character in the main buffer.
- */
-#define YY_STATE_BUF_SIZE ((YY_BUF_SIZE + 2) * sizeof(yy_state_type))
-
-#ifndef YY_TYPEDEF_YY_BUFFER_STATE
-#define YY_TYPEDEF_YY_BUFFER_STATE
-typedef struct yy_buffer_state *YY_BUFFER_STATE;
-#endif
-
-#ifndef YY_TYPEDEF_YY_SIZE_T
-#define YY_TYPEDEF_YY_SIZE_T
-typedef size_t yy_size_t;
-#endif
-
-extern yy_size_t zconfleng;
-
-extern FILE *zconfin, *zconfout;
-
-#define EOB_ACT_CONTINUE_SCAN 0
-#define EOB_ACT_END_OF_FILE 1
-#define EOB_ACT_LAST_MATCH 2
-
- #define YY_LESS_LINENO(n)
-
-/* Return all but the first "n" matched characters back to the input stream. */
-#define yyless(n) \
- do \
- { \
- /* Undo effects of setting up zconftext. */ \
- int yyless_macro_arg = (n); \
- YY_LESS_LINENO(yyless_macro_arg);\
- *yy_cp = (yy_hold_char); \
- YY_RESTORE_YY_MORE_OFFSET \
- (yy_c_buf_p) = yy_cp = yy_bp + yyless_macro_arg - YY_MORE_ADJ; \
- YY_DO_BEFORE_ACTION; /* set up zconftext again */ \
- } \
- while ( 0 )
-
-#define unput(c) yyunput( c, (yytext_ptr) )
-
-#ifndef YY_STRUCT_YY_BUFFER_STATE
-#define YY_STRUCT_YY_BUFFER_STATE
-struct yy_buffer_state
- {
- FILE *yy_input_file;
-
- char *yy_ch_buf; /* input buffer */
- char *yy_buf_pos; /* current position in input buffer */
-
- /* Size of input buffer in bytes, not including room for EOB
- * characters.
- */
- yy_size_t yy_buf_size;
-
- /* Number of characters read into yy_ch_buf, not including EOB
- * characters.
- */
- yy_size_t yy_n_chars;
-
- /* Whether we "own" the buffer - i.e., we know we created it,
- * and can realloc() it to grow it, and should free() it to
- * delete it.
- */
- int yy_is_our_buffer;
-
- /* Whether this is an "interactive" input source; if so, and
- * if we're using stdio for input, then we want to use getc()
- * instead of fread(), to make sure we stop fetching input after
- * each newline.
- */
- int yy_is_interactive;
-
- /* Whether we're considered to be at the beginning of a line.
- * If so, '^' rules will be active on the next match, otherwise
- * not.
- */
- int yy_at_bol;
-
- int yy_bs_lineno; /**< The line count. */
- int yy_bs_column; /**< The column count. */
-
- /* Whether to try to fill the input buffer when we reach the
- * end of it.
- */
- int yy_fill_buffer;
-
- int yy_buffer_status;
-
-#define YY_BUFFER_NEW 0
-#define YY_BUFFER_NORMAL 1
- /* When an EOF's been seen but there's still some text to process
- * then we mark the buffer as YY_EOF_PENDING, to indicate that we
- * shouldn't try reading from the input source any more. We might
- * still have a bunch of tokens to match, though, because of
- * possible backing-up.
- *
- * When we actually see the EOF, we change the status to "new"
- * (via zconfrestart()), so that the user can continue scanning by
- * just pointing zconfin at a new input file.
- */
-#define YY_BUFFER_EOF_PENDING 2
-
- };
-#endif /* !YY_STRUCT_YY_BUFFER_STATE */
-
-/* Stack of input buffers. */
-static size_t yy_buffer_stack_top = 0; /**< index of top of stack. */
-static size_t yy_buffer_stack_max = 0; /**< capacity of stack. */
-static YY_BUFFER_STATE * yy_buffer_stack = 0; /**< Stack as an array. */
-
-/* We provide macros for accessing buffer states in case in the
- * future we want to put the buffer states in a more general
- * "scanner state".
- *
- * Returns the top of the stack, or NULL.
- */
-#define YY_CURRENT_BUFFER ( (yy_buffer_stack) \
- ? (yy_buffer_stack)[(yy_buffer_stack_top)] \
- : NULL)
-
-/* Same as previous macro, but useful when we know that the buffer stack is not
- * NULL or when we need an lvalue. For internal use only.
- */
-#define YY_CURRENT_BUFFER_LVALUE (yy_buffer_stack)[(yy_buffer_stack_top)]
-
-/* yy_hold_char holds the character lost when zconftext is formed. */
-static char yy_hold_char;
-static yy_size_t yy_n_chars; /* number of characters read into yy_ch_buf */
-yy_size_t zconfleng;
-
-/* Points to current character in buffer. */
-static char *yy_c_buf_p = (char *) 0;
-static int yy_init = 0; /* whether we need to initialize */
-static int yy_start = 0; /* start state number */
-
-/* Flag which is used to allow zconfwrap()'s to do buffer switches
- * instead of setting up a fresh zconfin. A bit of a hack ...
- */
-static int yy_did_buffer_switch_on_eof;
-
-void zconfrestart (FILE *input_file );
-void zconf_switch_to_buffer (YY_BUFFER_STATE new_buffer );
-YY_BUFFER_STATE zconf_create_buffer (FILE *file,int size );
-void zconf_delete_buffer (YY_BUFFER_STATE b );
-void zconf_flush_buffer (YY_BUFFER_STATE b );
-void zconfpush_buffer_state (YY_BUFFER_STATE new_buffer );
-void zconfpop_buffer_state (void );
-
-static void zconfensure_buffer_stack (void );
-static void zconf_load_buffer_state (void );
-static void zconf_init_buffer (YY_BUFFER_STATE b,FILE *file );
-
-#define YY_FLUSH_BUFFER zconf_flush_buffer(YY_CURRENT_BUFFER )
-
-YY_BUFFER_STATE zconf_scan_buffer (char *base,yy_size_t size );
-YY_BUFFER_STATE zconf_scan_string (yyconst char *yy_str );
-YY_BUFFER_STATE zconf_scan_bytes (yyconst char *bytes,yy_size_t len );
-
-void *zconfalloc (yy_size_t );
-void *zconfrealloc (void *,yy_size_t );
-void zconffree (void * );
-
-#define yy_new_buffer zconf_create_buffer
-
-#define yy_set_interactive(is_interactive) \
- { \
- if ( ! YY_CURRENT_BUFFER ){ \
- zconfensure_buffer_stack (); \
- YY_CURRENT_BUFFER_LVALUE = \
- zconf_create_buffer(zconfin,YY_BUF_SIZE ); \
- } \
- YY_CURRENT_BUFFER_LVALUE->yy_is_interactive = is_interactive; \
- }
-
-#define yy_set_bol(at_bol) \
- { \
- if ( ! YY_CURRENT_BUFFER ){\
- zconfensure_buffer_stack (); \
- YY_CURRENT_BUFFER_LVALUE = \
- zconf_create_buffer(zconfin,YY_BUF_SIZE ); \
- } \
- YY_CURRENT_BUFFER_LVALUE->yy_at_bol = at_bol; \
- }
-
-#define YY_AT_BOL() (YY_CURRENT_BUFFER_LVALUE->yy_at_bol)
-
-/* Begin user sect3 */
-
-#define zconfwrap(n) 1
-#define YY_SKIP_YYWRAP
-
-typedef unsigned char YY_CHAR;
-
-FILE *zconfin = (FILE *) 0, *zconfout = (FILE *) 0;
-
-typedef int yy_state_type;
-
-extern int zconflineno;
-
-int zconflineno = 1;
-
-extern char *zconftext;
-#define yytext_ptr zconftext
-static yyconst flex_int16_t yy_nxt[][20] =
- {
- {
- 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
- 0, 0, 0, 0, 0, 0, 0, 0, 0, 0
- },
-
- {
- 11, 12, 13, 14, 12, 12, 12, 15, 12, 12,
- 12, 12, 12, 12, 12, 12, 12, 12, 12, 12
- },
-
- {
- 11, 12, 13, 14, 12, 12, 12, 15, 12, 12,
- 12, 12, 12, 12, 12, 12, 12, 12, 12, 12
- },
-
- {
- 11, 16, 16, 17, 18, 16, 16, 16, 16, 16,
- 16, 16, 19, 16, 16, 16, 16, 16, 16, 16
- },
-
- {
- 11, 16, 16, 17, 18, 16, 16, 16, 16, 16,
- 16, 16, 19, 16, 16, 16, 16, 16, 16, 16
-
- },
-
- {
- 11, 20, 21, 22, 23, 20, 20, 20, 20, 20,
- 20, 20, 20, 20, 20, 20, 20, 24, 20, 20
- },
-
- {
- 11, 20, 21, 22, 23, 20, 20, 20, 20, 20,
- 20, 20, 20, 20, 20, 20, 20, 24, 20, 20
- },
-
- {
- 11, 25, 25, 26, 27, 25, 28, 25, 25, 28,
- 25, 25, 25, 25, 25, 25, 25, 25, 29, 25
- },
-
- {
- 11, 25, 25, 26, 27, 25, 28, 25, 25, 28,
- 25, 25, 25, 25, 25, 25, 25, 25, 29, 25
- },
-
- {
- 11, 30, 31, 32, 33, 34, 35, 36, 37, 35,
- 38, 39, 40, 40, 41, 42, 43, 30, 44, 45
-
- },
-
- {
- 11, 30, 31, 32, 33, 34, 35, 36, 37, 35,
- 38, 39, 40, 40, 41, 42, 43, 30, 44, 45
- },
-
- {
- -11, -11, -11, -11, -11, -11, -11, -11, -11, -11,
- -11, -11, -11, -11, -11, -11, -11, -11, -11, -11
- },
-
- {
- 11, -12, -12, -12, -12, -12, -12, -12, -12, -12,
- -12, -12, -12, -12, -12, -12, -12, -12, -12, -12
- },
-
- {
- 11, -13, 46, 47, -13, -13, -13, 48, -13, -13,
- -13, -13, -13, -13, -13, -13, -13, -13, -13, -13
- },
-
- {
- 11, -14, -14, -14, -14, -14, -14, -14, -14, -14,
- -14, -14, -14, -14, -14, -14, -14, -14, -14, -14
-
- },
-
- {
- 11, 49, 49, 50, 49, 49, 49, 49, 49, 49,
- 49, 49, 49, 49, 49, 49, 49, 49, 49, 49
- },
-
- {
- 11, -16, -16, -16, -16, -16, -16, -16, -16, -16,
- -16, -16, -16, -16, -16, -16, -16, -16, -16, -16
- },
-
- {
- 11, -17, -17, -17, -17, -17, -17, -17, -17, -17,
- -17, -17, -17, -17, -17, -17, -17, -17, -17, -17
- },
-
- {
- 11, -18, -18, 51, -18, -18, -18, -18, -18, -18,
- -18, -18, -18, -18, -18, -18, -18, -18, -18, -18
- },
-
- {
- 11, -19, -19, -19, -19, -19, -19, -19, -19, -19,
- -19, -19, 52, -19, -19, -19, -19, -19, -19, -19
-
- },
-
- {
- 11, 53, 53, -20, 53, 53, 53, 53, 53, 53,
- 53, 53, 53, 53, 53, 53, 53, 53, 53, 53
- },
-
- {
- 11, -21, 54, 55, 56, -21, -21, -21, -21, -21,
- -21, -21, -21, -21, -21, -21, -21, -21, -21, -21
- },
-
- {
- 11, 57, -22, -22, -22, 57, 57, 57, 57, 57,
- 57, 57, 57, 57, 57, 57, 57, 57, 57, 57
- },
-
- {
- 11, -23, -23, 55, -23, -23, -23, -23, -23, -23,
- -23, -23, -23, -23, -23, -23, -23, -23, -23, -23
- },
-
- {
- 11, -24, -24, -24, -24, -24, -24, -24, -24, -24,
- -24, -24, -24, -24, -24, -24, -24, -24, -24, -24
-
- },
-
- {
- 11, 58, 58, 59, 58, 58, -25, 58, 58, -25,
- 58, 58, 58, 58, 58, 58, 58, 58, -25, 58
- },
-
- {
- 11, -26, -26, -26, -26, -26, -26, -26, -26, -26,
- -26, -26, -26, -26, -26, -26, -26, -26, -26, -26
- },
-
- {
- 11, 58, 58, 60, 58, 58, -27, 58, 58, -27,
- 58, 58, 58, 58, 58, 58, 58, 58, -27, 58
- },
-
- {
- 11, -28, -28, -28, -28, -28, -28, -28, -28, -28,
- -28, -28, -28, -28, -28, -28, -28, -28, -28, -28
- },
-
- {
- 11, 61, 61, 62, 61, 61, 61, 61, 61, 61,
- 61, 61, 61, 61, 61, 61, 61, 61, 61, 61
-
- },
-
- {
- 11, -30, -30, -30, -30, -30, -30, -30, -30, -30,
- -30, -30, -30, -30, -30, -30, -30, -30, -30, -30
- },
-
- {
- 11, -31, 63, -31, -31, -31, -31, -31, -31, -31,
- -31, -31, -31, -31, -31, -31, -31, -31, -31, -31
- },
-
- {
- 11, -32, -32, -32, -32, -32, -32, -32, -32, -32,
- -32, -32, -32, -32, -32, -32, -32, -32, -32, -32
- },
-
- {
- 11, -33, -33, 64, -33, -33, -33, -33, -33, -33,
- -33, -33, -33, -33, -33, -33, -33, -33, -33, -33
- },
-
- {
- 11, -34, -34, -34, -34, -34, -34, -34, -34, -34,
- -34, -34, -34, -34, -34, 65, -34, -34, -34, -34
-
- },
-
- {
- 11, -35, -35, -35, -35, -35, -35, -35, -35, -35,
- -35, -35, -35, -35, -35, -35, -35, -35, -35, -35
- },
-
- {
- 11, 66, 66, -36, 66, 66, 66, 66, 66, 66,
- 66, 66, 66, 66, 66, 66, 66, 66, 66, 66
- },
-
- {
- 11, -37, -37, -37, -37, -37, -37, -37, 67, -37,
- -37, -37, -37, -37, -37, -37, -37, -37, -37, -37
- },
-
- {
- 11, -38, -38, -38, -38, -38, -38, -38, -38, -38,
- -38, -38, -38, -38, -38, -38, -38, -38, -38, -38
- },
-
- {
- 11, -39, -39, -39, -39, -39, -39, -39, -39, -39,
- -39, -39, -39, -39, -39, -39, -39, -39, -39, -39
-
- },
-
- {
- 11, -40, -40, -40, -40, -40, -40, -40, -40, -40,
- -40, -40, 68, 68, -40, -40, -40, -40, -40, -40
- },
-
- {
- 11, -41, -41, -41, -41, -41, -41, -41, -41, -41,
- -41, -41, -41, -41, -41, 69, -41, -41, -41, -41
- },
-
- {
- 11, -42, -42, -42, -42, -42, -42, -42, -42, -42,
- -42, -42, -42, -42, -42, -42, -42, -42, -42, -42
- },
-
- {
- 11, -43, -43, -43, -43, -43, -43, -43, -43, -43,
- -43, -43, -43, -43, -43, 70, -43, -43, -43, -43
- },
-
- {
- 11, -44, -44, 71, -44, -44, -44, -44, -44, -44,
- -44, -44, -44, -44, -44, -44, -44, -44, -44, -44
-
- },
-
- {
- 11, -45, -45, -45, -45, -45, -45, -45, -45, -45,
- -45, -45, -45, -45, -45, -45, -45, -45, -45, 72
- },
-
- {
- 11, -46, 46, 47, -46, -46, -46, 48, -46, -46,
- -46, -46, -46, -46, -46, -46, -46, -46, -46, -46
- },
-
- {
- 11, -47, -47, -47, -47, -47, -47, -47, -47, -47,
- -47, -47, -47, -47, -47, -47, -47, -47, -47, -47
- },
-
- {
- 11, 49, 49, 50, 49, 49, 49, 49, 49, 49,
- 49, 49, 49, 49, 49, 49, 49, 49, 49, 49
- },
-
- {
- 11, 49, 49, 50, 49, 49, 49, 49, 49, 49,
- 49, 49, 49, 49, 49, 49, 49, 49, 49, 49
-
- },
-
- {
- 11, -50, -50, -50, -50, -50, -50, -50, -50, -50,
- -50, -50, -50, -50, -50, -50, -50, -50, -50, -50
- },
-
- {
- 11, -51, -51, -51, -51, -51, -51, -51, -51, -51,
- -51, -51, -51, -51, -51, -51, -51, -51, -51, -51
- },
-
- {
- 11, -52, -52, -52, -52, -52, -52, -52, -52, -52,
- -52, -52, 52, -52, -52, -52, -52, -52, -52, -52
- },
-
- {
- 11, 53, 53, -53, 53, 53, 53, 53, 53, 53,
- 53, 53, 53, 53, 53, 53, 53, 53, 53, 53
- },
-
- {
- 11, -54, 54, 55, 56, -54, -54, -54, -54, -54,
- -54, -54, -54, -54, -54, -54, -54, -54, -54, -54
-
- },
-
- {
- 11, 57, -55, -55, -55, 57, 57, 57, 57, 57,
- 57, 57, 57, 57, 57, 57, 57, 57, 57, 57
- },
-
- {
- 11, -56, -56, 55, -56, -56, -56, -56, -56, -56,
- -56, -56, -56, -56, -56, -56, -56, -56, -56, -56
- },
-
- {
- 11, -57, -57, -57, -57, -57, -57, -57, -57, -57,
- -57, -57, -57, -57, -57, -57, -57, -57, -57, -57
- },
-
- {
- 11, 58, 58, 59, 58, 58, -58, 58, 58, -58,
- 58, 58, 58, 58, 58, 58, 58, 58, -58, 58
- },
-
- {
- 11, -59, -59, -59, -59, -59, -59, -59, -59, -59,
- -59, -59, -59, -59, -59, -59, -59, -59, -59, -59
-
- },
-
- {
- 11, -60, -60, -60, -60, -60, -60, -60, -60, -60,
- -60, -60, -60, -60, -60, -60, -60, -60, -60, -60
- },
-
- {
- 11, -61, -61, 62, -61, -61, -61, -61, -61, -61,
- -61, -61, -61, -61, -61, -61, -61, -61, -61, -61
- },
-
- {
- 11, -62, -62, -62, -62, -62, -62, -62, -62, -62,
- -62, -62, -62, -62, -62, -62, -62, -62, -62, -62
- },
-
- {
- 11, -63, 63, -63, -63, -63, -63, -63, -63, -63,
- -63, -63, -63, -63, -63, -63, -63, -63, -63, -63
- },
-
- {
- 11, -64, -64, -64, -64, -64, -64, -64, -64, -64,
- -64, -64, -64, -64, -64, -64, -64, -64, -64, -64
-
- },
-
- {
- 11, -65, -65, -65, -65, -65, -65, -65, -65, -65,
- -65, -65, -65, -65, -65, -65, -65, -65, -65, -65
- },
-
- {
- 11, 66, 66, -66, 66, 66, 66, 66, 66, 66,
- 66, 66, 66, 66, 66, 66, 66, 66, 66, 66
- },
-
- {
- 11, -67, -67, -67, -67, -67, -67, -67, -67, -67,
- -67, -67, -67, -67, -67, -67, -67, -67, -67, -67
- },
-
- {
- 11, -68, -68, -68, -68, -68, -68, -68, -68, -68,
- -68, -68, 68, 68, -68, -68, -68, -68, -68, -68
- },
-
- {
- 11, -69, -69, -69, -69, -69, -69, -69, -69, -69,
- -69, -69, -69, -69, -69, -69, -69, -69, -69, -69
-
- },
-
- {
- 11, -70, -70, -70, -70, -70, -70, -70, -70, -70,
- -70, -70, -70, -70, -70, -70, -70, -70, -70, -70
- },
-
- {
- 11, -71, -71, -71, -71, -71, -71, -71, -71, -71,
- -71, -71, -71, -71, -71, -71, -71, -71, -71, -71
- },
-
- {
- 11, -72, -72, -72, -72, -72, -72, -72, -72, -72,
- -72, -72, -72, -72, -72, -72, -72, -72, -72, -72
- },
-
- } ;
-
-static yy_state_type yy_get_previous_state (void );
-static yy_state_type yy_try_NUL_trans (yy_state_type current_state );
-static int yy_get_next_buffer (void );
-static void yy_fatal_error (yyconst char msg[] );
-
-/* Done after the current pattern has been matched and before the
- * corresponding action - sets up zconftext.
- */
-#define YY_DO_BEFORE_ACTION \
- (yytext_ptr) = yy_bp; \
- zconfleng = (yy_size_t) (yy_cp - yy_bp); \
- (yy_hold_char) = *yy_cp; \
- *yy_cp = '\0'; \
- (yy_c_buf_p) = yy_cp;
-
-#define YY_NUM_RULES 37
-#define YY_END_OF_BUFFER 38
-/* This struct is not used in this scanner,
- but its presence is necessary. */
-struct yy_trans_info
- {
- flex_int32_t yy_verify;
- flex_int32_t yy_nxt;
- };
-static yyconst flex_int16_t yy_accept[73] =
- { 0,
- 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
- 38, 5, 4, 2, 3, 7, 8, 37, 6, 36,
- 33, 35, 37, 37, 28, 32, 28, 31, 30, 26,
- 25, 21, 26, 13, 20, 23, 26, 11, 12, 22,
- 18, 14, 19, 26, 26, 4, 2, 3, 3, 1,
- 8, 6, 36, 33, 35, 0, 34, 28, 27, 27,
- 30, 29, 25, 21, 15, 23, 9, 22, 16, 17,
- 24, 10
- } ;
-
-static yyconst flex_int32_t yy_ec[256] =
- { 0,
- 1, 1, 1, 1, 1, 1, 1, 1, 2, 3,
- 1, 1, 4, 1, 1, 1, 1, 1, 1, 1,
- 1, 1, 1, 1, 1, 1, 1, 1, 1, 1,
- 1, 2, 5, 6, 7, 1, 1, 8, 9, 10,
- 11, 1, 1, 1, 12, 13, 13, 12, 12, 12,
- 12, 12, 12, 12, 12, 12, 12, 1, 1, 14,
- 15, 16, 17, 1, 12, 12, 12, 12, 12, 12,
- 12, 12, 12, 12, 12, 12, 12, 12, 12, 12,
- 12, 12, 12, 12, 12, 12, 12, 12, 12, 12,
- 1, 18, 1, 1, 12, 1, 12, 12, 12, 12,
-
- 12, 12, 12, 12, 12, 12, 12, 12, 12, 12,
- 12, 12, 12, 12, 12, 12, 12, 12, 12, 12,
- 12, 12, 1, 19, 1, 1, 1, 1, 1, 1,
- 1, 1, 1, 1, 1, 1, 1, 1, 1, 1,
- 1, 1, 1, 1, 1, 1, 1, 1, 1, 1,
- 1, 1, 1, 1, 1, 1, 1, 1, 1, 1,
- 1, 1, 1, 1, 1, 1, 1, 1, 1, 1,
- 1, 1, 1, 1, 1, 1, 1, 1, 1, 1,
- 1, 1, 1, 1, 1, 1, 1, 1, 1, 1,
- 1, 1, 1, 1, 1, 1, 1, 1, 1, 1,
-
- 1, 1, 1, 1, 1, 1, 1, 1, 1, 1,
- 1, 1, 1, 1, 1, 1, 1, 1, 1, 1,
- 1, 1, 1, 1, 1, 1, 1, 1, 1, 1,
- 1, 1, 1, 1, 1, 1, 1, 1, 1, 1,
- 1, 1, 1, 1, 1, 1, 1, 1, 1, 1,
- 1, 1, 1, 1, 1
- } ;
-
-static yy_state_type yy_last_accepting_state;
-static char *yy_last_accepting_cpos;
-
-extern int zconf_flex_debug;
-int zconf_flex_debug = 0;
-
-/* The intent behind this definition is that it'll catch
- * any uses of REJECT which flex missed.
- */
-#define REJECT reject_used_but_not_detected
-#define yymore() yymore_used_but_not_detected
-#define YY_MORE_ADJ 0
-#define YY_RESTORE_YY_MORE_OFFSET
-char *zconftext;
-#define YY_NO_INPUT 1
-
-/*
- * Copyright (C) 2002 Roman Zippel <zippel@linux-m68k.org>
- * Released under the terms of the GNU GPL v2.0.
- */
-
-#include <limits.h>
-#include <stdio.h>
-#include <stdlib.h>
-#include <string.h>
-#include <unistd.h>
-#include <wordexp.h>
-
-#include "lkc.h"
-
-#define START_STRSIZE 16
-
-static struct {
- struct file *file;
- int lineno;
-} current_pos;
-
-static char *text;
-static int text_size, text_asize;
-
-struct buffer {
- struct buffer *parent;
- YY_BUFFER_STATE state;
-};
-
-struct buffer *current_buf;
-
-static int last_ts, first_ts;
-
-static void zconf_endhelp(void);
-static void zconf_endfile(void);
-
-static void new_string(void)
-{
- text = xmalloc(START_STRSIZE);
- text_asize = START_STRSIZE;
- text_size = 0;
- *text = 0;
-}
-
-static void append_string(const char *str, int size)
-{
- int new_size = text_size + size + 1;
- if (new_size > text_asize) {
- new_size += START_STRSIZE - 1;
- new_size &= -START_STRSIZE;
- text = realloc(text, new_size);
- text_asize = new_size;
- }
- memcpy(text + text_size, str, size);
- text_size += size;
- text[text_size] = 0;
-}
-
-static void alloc_string(const char *str, int size)
-{
- text = xmalloc(size + 1);
- memcpy(text, str, size);
- text[size] = 0;
-}
-
-static void warn_ignored_character(char chr)
-{
- fprintf(stderr,
- "%s:%d:warning: ignoring unsupported character '%c'\n",
- zconf_curname(), zconf_lineno(), chr);
-}
-
-#define INITIAL 0
-#define COMMAND 1
-#define HELP 2
-#define STRING 3
-#define PARAM 4
-
-#ifndef YY_NO_UNISTD_H
-/* Special case for "unistd.h", since it is non-ANSI. We include it way
- * down here because we want the user's section 1 to have been scanned first.
- * The user has a chance to override it with an option.
- */
-#include <unistd.h>
-#endif
-
-#ifndef YY_EXTRA_TYPE
-#define YY_EXTRA_TYPE void *
-#endif
-
-static int yy_init_globals (void );
-
-/* Accessor methods to globals.
- These are made visible to non-reentrant scanners for convenience. */
-
-int zconflex_destroy (void );
-
-int zconfget_debug (void );
-
-void zconfset_debug (int debug_flag );
-
-YY_EXTRA_TYPE zconfget_extra (void );
-
-void zconfset_extra (YY_EXTRA_TYPE user_defined );
-
-FILE *zconfget_in (void );
-
-void zconfset_in (FILE * in_str );
-
-FILE *zconfget_out (void );
-
-void zconfset_out (FILE * out_str );
-
-yy_size_t zconfget_leng (void );
-
-char *zconfget_text (void );
-
-int zconfget_lineno (void );
-
-void zconfset_lineno (int line_number );
-
-/* Macros after this point can all be overridden by user definitions in
- * section 1.
- */
-
-#ifndef YY_SKIP_YYWRAP
-#ifdef __cplusplus
-extern "C" int zconfwrap (void );
-#else
-extern int zconfwrap (void );
-#endif
-#endif
-
- static void yyunput (int c,char *buf_ptr );
-
-#ifndef yytext_ptr
-static void yy_flex_strncpy (char *,yyconst char *,int );
-#endif
-
-#ifdef YY_NEED_STRLEN
-static int yy_flex_strlen (yyconst char * );
-#endif
-
-#ifndef YY_NO_INPUT
-
-#ifdef __cplusplus
-static int yyinput (void );
-#else
-static int input (void );
-#endif
-
-#endif
-
-/* Amount of stuff to slurp up with each read. */
-#ifndef YY_READ_BUF_SIZE
-#define YY_READ_BUF_SIZE 8192
-#endif
-
-/* Copy whatever the last rule matched to the standard output. */
-#ifndef ECHO
-/* This used to be an fputs(), but since the string might contain NUL's,
- * we now use fwrite().
- */
-#define ECHO fwrite( zconftext, zconfleng, 1, zconfout )
-#endif
-
-/* Gets input and stuffs it into "buf". number of characters read, or YY_NULL,
- * is returned in "result".
- */
-#ifndef YY_INPUT
-#define YY_INPUT(buf,result,max_size) \
- errno=0; \
- while ( (result = read( fileno(zconfin), (char *) buf, max_size )) < 0 ) \
- { \
- if( errno != EINTR) \
- { \
- YY_FATAL_ERROR( "input in flex scanner failed" ); \
- break; \
- } \
- errno=0; \
- clearerr(zconfin); \
- }\
-\
-
-#endif
-
-/* No semi-colon after return; correct usage is to write "yyterminate();" -
- * we don't want an extra ';' after the "return" because that will cause
- * some compilers to complain about unreachable statements.
- */
-#ifndef yyterminate
-#define yyterminate() return YY_NULL
-#endif
-
-/* Number of entries by which start-condition stack grows. */
-#ifndef YY_START_STACK_INCR
-#define YY_START_STACK_INCR 25
-#endif
-
-/* Report a fatal error. */
-#ifndef YY_FATAL_ERROR
-#define YY_FATAL_ERROR(msg) yy_fatal_error( msg )
-#endif
-
-/* end tables serialization structures and prototypes */
-
-/* Default declaration of generated scanner - a define so the user can
- * easily add parameters.
- */
-#ifndef YY_DECL
-#define YY_DECL_IS_OURS 1
-
-extern int zconflex (void);
-
-#define YY_DECL int zconflex (void)
-#endif /* !YY_DECL */
-
-/* Code executed at the beginning of each rule, after zconftext and zconfleng
- * have been set up.
- */
-#ifndef YY_USER_ACTION
-#define YY_USER_ACTION
-#endif
-
-/* Code executed at the end of each rule. */
-#ifndef YY_BREAK
-#define YY_BREAK break;
-#endif
-
-#define YY_RULE_SETUP \
- YY_USER_ACTION
-
-/** The main scanner function which does all the work.
- */
-YY_DECL
-{
- register yy_state_type yy_current_state;
- register char *yy_cp, *yy_bp;
- register int yy_act;
-
- int str = 0;
- int ts, i;
-
- if ( !(yy_init) )
- {
- (yy_init) = 1;
-
-#ifdef YY_USER_INIT
- YY_USER_INIT;
-#endif
-
- if ( ! (yy_start) )
- (yy_start) = 1; /* first start state */
-
- if ( ! zconfin )
- zconfin = stdin;
-
- if ( ! zconfout )
- zconfout = stdout;
-
- if ( ! YY_CURRENT_BUFFER ) {
- zconfensure_buffer_stack ();
- YY_CURRENT_BUFFER_LVALUE =
- zconf_create_buffer(zconfin,YY_BUF_SIZE );
- }
-
- zconf_load_buffer_state( );
- }
-
- while ( 1 ) /* loops until end-of-file is reached */
- {
- yy_cp = (yy_c_buf_p);
-
- /* Support of zconftext. */
- *yy_cp = (yy_hold_char);
-
- /* yy_bp points to the position in yy_ch_buf of the start of
- * the current run.
- */
- yy_bp = yy_cp;
-
- yy_current_state = (yy_start);
-yy_match:
- while ( (yy_current_state = yy_nxt[yy_current_state][ yy_ec[YY_SC_TO_UI(*yy_cp)] ]) > 0 )
- {
- if ( yy_accept[yy_current_state] )
- {
- (yy_last_accepting_state) = yy_current_state;
- (yy_last_accepting_cpos) = yy_cp;
- }
-
- ++yy_cp;
- }
-
- yy_current_state = -yy_current_state;
-
-yy_find_action:
- yy_act = yy_accept[yy_current_state];
-
- YY_DO_BEFORE_ACTION;
-
-do_action: /* This label is used only to access EOF actions. */
-
- switch ( yy_act )
- { /* beginning of action switch */
- case 0: /* must back up */
- /* undo the effects of YY_DO_BEFORE_ACTION */
- *yy_cp = (yy_hold_char);
- yy_cp = (yy_last_accepting_cpos) + 1;
- yy_current_state = (yy_last_accepting_state);
- goto yy_find_action;
-
-case 1:
-/* rule 1 can match eol */
-case 2:
-/* rule 2 can match eol */
-YY_RULE_SETUP
-{
- current_file->lineno++;
- return T_EOL;
-}
- YY_BREAK
-case 3:
-YY_RULE_SETUP
-
- YY_BREAK
-case 4:
-YY_RULE_SETUP
-{
- BEGIN(COMMAND);
-}
- YY_BREAK
-case 5:
-YY_RULE_SETUP
-{
- unput(zconftext[0]);
- BEGIN(COMMAND);
-}
- YY_BREAK
-
-case 6:
-YY_RULE_SETUP
-{
- const struct kconf_id *id = kconf_id_lookup(zconftext, zconfleng);
- BEGIN(PARAM);
- current_pos.file = current_file;
- current_pos.lineno = current_file->lineno;
- if (id && id->flags & TF_COMMAND) {
- zconflval.id = id;
- return id->token;
- }
- alloc_string(zconftext, zconfleng);
- zconflval.string = text;
- return T_WORD;
- }
- YY_BREAK
-case 7:
-YY_RULE_SETUP
-warn_ignored_character(*zconftext);
- YY_BREAK
-case 8:
-/* rule 8 can match eol */
-YY_RULE_SETUP
-{
- BEGIN(INITIAL);
- current_file->lineno++;
- return T_EOL;
- }
- YY_BREAK
-
-case 9:
-YY_RULE_SETUP
-return T_AND;
- YY_BREAK
-case 10:
-YY_RULE_SETUP
-return T_OR;
- YY_BREAK
-case 11:
-YY_RULE_SETUP
-return T_OPEN_PAREN;
- YY_BREAK
-case 12:
-YY_RULE_SETUP
-return T_CLOSE_PAREN;
- YY_BREAK
-case 13:
-YY_RULE_SETUP
-return T_NOT;
- YY_BREAK
-case 14:
-YY_RULE_SETUP
-return T_EQUAL;
- YY_BREAK
-case 15:
-YY_RULE_SETUP
-return T_UNEQUAL;
- YY_BREAK
-case 16:
-YY_RULE_SETUP
-return T_LESS_EQUAL;
- YY_BREAK
-case 17:
-YY_RULE_SETUP
-return T_GREATER_EQUAL;
- YY_BREAK
-case 18:
-YY_RULE_SETUP
-return T_LESS;
- YY_BREAK
-case 19:
-YY_RULE_SETUP
-return T_GREATER;
- YY_BREAK
-case 20:
-YY_RULE_SETUP
-{
- str = zconftext[0];
- new_string();
- BEGIN(STRING);
- }
- YY_BREAK
-case 21:
-/* rule 21 can match eol */
-YY_RULE_SETUP
-BEGIN(INITIAL); current_file->lineno++; return T_EOL;
- YY_BREAK
-case 22:
-YY_RULE_SETUP
-{
- const struct kconf_id *id = kconf_id_lookup(zconftext, zconfleng);
- if (id && id->flags & TF_PARAM) {
- zconflval.id = id;
- return id->token;
- }
- alloc_string(zconftext, zconfleng);
- zconflval.string = text;
- return T_WORD;
- }
- YY_BREAK
-case 23:
-YY_RULE_SETUP
-/* comment */
- YY_BREAK
-case 24:
-/* rule 24 can match eol */
-YY_RULE_SETUP
-current_file->lineno++;
- YY_BREAK
-case 25:
-YY_RULE_SETUP
-
- YY_BREAK
-case 26:
-YY_RULE_SETUP
-warn_ignored_character(*zconftext);
- YY_BREAK
-case YY_STATE_EOF(PARAM):
-{
- BEGIN(INITIAL);
- }
- YY_BREAK
-
-case 27:
-/* rule 27 can match eol */
-*yy_cp = (yy_hold_char); /* undo effects of setting up zconftext */
-(yy_c_buf_p) = yy_cp -= 1;
-YY_DO_BEFORE_ACTION; /* set up zconftext again */
-YY_RULE_SETUP
-{
- append_string(zconftext, zconfleng);
- zconflval.string = text;
- return T_WORD_QUOTE;
- }
- YY_BREAK
-case 28:
-YY_RULE_SETUP
-{
- append_string(zconftext, zconfleng);
- }
- YY_BREAK
-case 29:
-/* rule 29 can match eol */
-*yy_cp = (yy_hold_char); /* undo effects of setting up zconftext */
-(yy_c_buf_p) = yy_cp -= 1;
-YY_DO_BEFORE_ACTION; /* set up zconftext again */
-YY_RULE_SETUP
-{
- append_string(zconftext + 1, zconfleng - 1);
- zconflval.string = text;
- return T_WORD_QUOTE;
- }
- YY_BREAK
-case 30:
-YY_RULE_SETUP
-{
- append_string(zconftext + 1, zconfleng - 1);
- }
- YY_BREAK
-case 31:
-YY_RULE_SETUP
-{
- if (str == zconftext[0]) {
- BEGIN(PARAM);
- zconflval.string = text;
- return T_WORD_QUOTE;
- } else
- append_string(zconftext, 1);
- }
- YY_BREAK
-case 32:
-/* rule 32 can match eol */
-YY_RULE_SETUP
-{
- printf("%s:%d:warning: multi-line strings not supported\n", zconf_curname(), zconf_lineno());
- current_file->lineno++;
- BEGIN(INITIAL);
- return T_EOL;
- }
- YY_BREAK
-case YY_STATE_EOF(STRING):
-{
- BEGIN(INITIAL);
- }
- YY_BREAK
-
-case 33:
-YY_RULE_SETUP
-{
- ts = 0;
- for (i = 0; i < zconfleng; i++) {
- if (zconftext[i] == '\t')
- ts = (ts & ~7) + 8;
- else
- ts++;
- }
- last_ts = ts;
- if (first_ts) {
- if (ts < first_ts) {
- zconf_endhelp();
- return T_HELPTEXT;
- }
- ts -= first_ts;
- while (ts > 8) {
- append_string(" ", 8);
- ts -= 8;
- }
- append_string(" ", ts);
- }
- }
- YY_BREAK
-case 34:
-/* rule 34 can match eol */
-*yy_cp = (yy_hold_char); /* undo effects of setting up zconftext */
-(yy_c_buf_p) = yy_cp -= 1;
-YY_DO_BEFORE_ACTION; /* set up zconftext again */
-YY_RULE_SETUP
-{
- current_file->lineno++;
- zconf_endhelp();
- return T_HELPTEXT;
- }
- YY_BREAK
-case 35:
-/* rule 35 can match eol */
-YY_RULE_SETUP
-{
- current_file->lineno++;
- append_string("\n", 1);
- }
- YY_BREAK
-case 36:
-YY_RULE_SETUP
-{
- while (zconfleng) {
- if ((zconftext[zconfleng-1] != ' ') && (zconftext[zconfleng-1] != '\t'))
- break;
- zconfleng--;
- }
- append_string(zconftext, zconfleng);
- if (!first_ts)
- first_ts = last_ts;
- }
- YY_BREAK
-case YY_STATE_EOF(HELP):
-{
- zconf_endhelp();
- return T_HELPTEXT;
- }
- YY_BREAK
-
-case YY_STATE_EOF(INITIAL):
-case YY_STATE_EOF(COMMAND):
-{
- if (current_file) {
- zconf_endfile();
- return T_EOL;
- }
- fclose(zconfin);
- yyterminate();
-}
- YY_BREAK
-case 37:
-YY_RULE_SETUP
-ECHO;
- YY_BREAK
-
- case YY_END_OF_BUFFER:
- {
- /* Amount of text matched not including the EOB char. */
- int yy_amount_of_matched_text = (int) (yy_cp - (yytext_ptr)) - 1;
-
- /* Undo the effects of YY_DO_BEFORE_ACTION. */
- *yy_cp = (yy_hold_char);
- YY_RESTORE_YY_MORE_OFFSET
-
- if ( YY_CURRENT_BUFFER_LVALUE->yy_buffer_status == YY_BUFFER_NEW )
- {
- /* We're scanning a new file or input source. It's
- * possible that this happened because the user
- * just pointed zconfin at a new source and called
- * zconflex(). If so, then we have to assure
- * consistency between YY_CURRENT_BUFFER and our
- * globals. Here is the right place to do so, because
- * this is the first action (other than possibly a
- * back-up) that will match for the new input source.
- */
- (yy_n_chars) = YY_CURRENT_BUFFER_LVALUE->yy_n_chars;
- YY_CURRENT_BUFFER_LVALUE->yy_input_file = zconfin;
- YY_CURRENT_BUFFER_LVALUE->yy_buffer_status = YY_BUFFER_NORMAL;
- }
-
- /* Note that here we test for yy_c_buf_p "<=" to the position
- * of the first EOB in the buffer, since yy_c_buf_p will
- * already have been incremented past the NUL character
- * (since all states make transitions on EOB to the
- * end-of-buffer state). Contrast this with the test
- * in input().
- */
- if ( (yy_c_buf_p) <= &YY_CURRENT_BUFFER_LVALUE->yy_ch_buf[(yy_n_chars)] )
- { /* This was really a NUL. */
- yy_state_type yy_next_state;
-
- (yy_c_buf_p) = (yytext_ptr) + yy_amount_of_matched_text;
-
- yy_current_state = yy_get_previous_state( );
-
- /* Okay, we're now positioned to make the NUL
- * transition. We couldn't have
- * yy_get_previous_state() go ahead and do it
- * for us because it doesn't know how to deal
- * with the possibility of jamming (and we don't
- * want to build jamming into it because then it
- * will run more slowly).
- */
-
- yy_next_state = yy_try_NUL_trans( yy_current_state );
-
- yy_bp = (yytext_ptr) + YY_MORE_ADJ;
-
- if ( yy_next_state )
- {
- /* Consume the NUL. */
- yy_cp = ++(yy_c_buf_p);
- yy_current_state = yy_next_state;
- goto yy_match;
- }
-
- else
- {
- yy_cp = (yy_c_buf_p);
- goto yy_find_action;
- }
- }
-
- else switch ( yy_get_next_buffer( ) )
- {
- case EOB_ACT_END_OF_FILE:
- {
- (yy_did_buffer_switch_on_eof) = 0;
-
- if ( zconfwrap( ) )
- {
- /* Note: because we've taken care in
- * yy_get_next_buffer() to have set up
- * zconftext, we can now set up
- * yy_c_buf_p so that if some total
- * hoser (like flex itself) wants to
- * call the scanner after we return the
- * YY_NULL, it'll still work - another
- * YY_NULL will get returned.
- */
- (yy_c_buf_p) = (yytext_ptr) + YY_MORE_ADJ;
-
- yy_act = YY_STATE_EOF(YY_START);
- goto do_action;
- }
-
- else
- {
- if ( ! (yy_did_buffer_switch_on_eof) )
- YY_NEW_FILE;
- }
- break;
- }
-
- case EOB_ACT_CONTINUE_SCAN:
- (yy_c_buf_p) =
- (yytext_ptr) + yy_amount_of_matched_text;
-
- yy_current_state = yy_get_previous_state( );
-
- yy_cp = (yy_c_buf_p);
- yy_bp = (yytext_ptr) + YY_MORE_ADJ;
- goto yy_match;
-
- case EOB_ACT_LAST_MATCH:
- (yy_c_buf_p) =
- &YY_CURRENT_BUFFER_LVALUE->yy_ch_buf[(yy_n_chars)];
-
- yy_current_state = yy_get_previous_state( );
-
- yy_cp = (yy_c_buf_p);
- yy_bp = (yytext_ptr) + YY_MORE_ADJ;
- goto yy_find_action;
- }
- break;
- }
-
- default:
- YY_FATAL_ERROR(
- "fatal flex scanner internal error--no action found" );
- } /* end of action switch */
- } /* end of scanning one token */
-} /* end of zconflex */
-
-/* yy_get_next_buffer - try to read in a new buffer
- *
- * Returns a code representing an action:
- * EOB_ACT_LAST_MATCH -
- * EOB_ACT_CONTINUE_SCAN - continue scanning from current position
- * EOB_ACT_END_OF_FILE - end of file
- */
-static int yy_get_next_buffer (void)
-{
- register char *dest = YY_CURRENT_BUFFER_LVALUE->yy_ch_buf;
- register char *source = (yytext_ptr);
- register int number_to_move, i;
- int ret_val;
-
- if ( (yy_c_buf_p) > &YY_CURRENT_BUFFER_LVALUE->yy_ch_buf[(yy_n_chars) + 1] )
- YY_FATAL_ERROR(
- "fatal flex scanner internal error--end of buffer missed" );
-
- if ( YY_CURRENT_BUFFER_LVALUE->yy_fill_buffer == 0 )
- { /* Don't try to fill the buffer, so this is an EOF. */
- if ( (yy_c_buf_p) - (yytext_ptr) - YY_MORE_ADJ == 1 )
- {
- /* We matched a single character, the EOB, so
- * treat this as a final EOF.
- */
- return EOB_ACT_END_OF_FILE;
- }
-
- else
- {
- /* We matched some text prior to the EOB, first
- * process it.
- */
- return EOB_ACT_LAST_MATCH;
- }
- }
-
- /* Try to read more data. */
-
- /* First move last chars to start of buffer. */
- number_to_move = (int) ((yy_c_buf_p) - (yytext_ptr)) - 1;
-
- for ( i = 0; i < number_to_move; ++i )
- *(dest++) = *(source++);
-
- if ( YY_CURRENT_BUFFER_LVALUE->yy_buffer_status == YY_BUFFER_EOF_PENDING )
- /* don't do the read, it's not guaranteed to return an EOF,
- * just force an EOF
- */
- YY_CURRENT_BUFFER_LVALUE->yy_n_chars = (yy_n_chars) = 0;
-
- else
- {
- yy_size_t num_to_read =
- YY_CURRENT_BUFFER_LVALUE->yy_buf_size - number_to_move - 1;
-
- while ( num_to_read <= 0 )
- { /* Not enough room in the buffer - grow it. */
-
- /* just a shorter name for the current buffer */
- YY_BUFFER_STATE b = YY_CURRENT_BUFFER;
-
- int yy_c_buf_p_offset =
- (int) ((yy_c_buf_p) - b->yy_ch_buf);
-
- if ( b->yy_is_our_buffer )
- {
- yy_size_t new_size = b->yy_buf_size * 2;
-
- if ( new_size <= 0 )
- b->yy_buf_size += b->yy_buf_size / 8;
- else
- b->yy_buf_size *= 2;
-
- b->yy_ch_buf = (char *)
- /* Include room in for 2 EOB chars. */
- zconfrealloc((void *) b->yy_ch_buf,b->yy_buf_size + 2 );
- }
- else
- /* Can't grow it, we don't own it. */
- b->yy_ch_buf = 0;
-
- if ( ! b->yy_ch_buf )
- YY_FATAL_ERROR(
- "fatal error - scanner input buffer overflow" );
-
- (yy_c_buf_p) = &b->yy_ch_buf[yy_c_buf_p_offset];
-
- num_to_read = YY_CURRENT_BUFFER_LVALUE->yy_buf_size -
- number_to_move - 1;
-
- }
-
- if ( num_to_read > YY_READ_BUF_SIZE )
- num_to_read = YY_READ_BUF_SIZE;
-
- /* Read in more data. */
- YY_INPUT( (&YY_CURRENT_BUFFER_LVALUE->yy_ch_buf[number_to_move]),
- (yy_n_chars), num_to_read );
-
- YY_CURRENT_BUFFER_LVALUE->yy_n_chars = (yy_n_chars);
- }
-
- if ( (yy_n_chars) == 0 )
- {
- if ( number_to_move == YY_MORE_ADJ )
- {
- ret_val = EOB_ACT_END_OF_FILE;
- zconfrestart(zconfin );
- }
-
- else
- {
- ret_val = EOB_ACT_LAST_MATCH;
- YY_CURRENT_BUFFER_LVALUE->yy_buffer_status =
- YY_BUFFER_EOF_PENDING;
- }
- }
-
- else
- ret_val = EOB_ACT_CONTINUE_SCAN;
-
- if ((yy_size_t) ((yy_n_chars) + number_to_move) > YY_CURRENT_BUFFER_LVALUE->yy_buf_size) {
- /* Extend the array by 50%, plus the number we really need. */
- yy_size_t new_size = (yy_n_chars) + number_to_move + ((yy_n_chars) >> 1);
- YY_CURRENT_BUFFER_LVALUE->yy_ch_buf = (char *) zconfrealloc((void *) YY_CURRENT_BUFFER_LVALUE->yy_ch_buf,new_size );
- if ( ! YY_CURRENT_BUFFER_LVALUE->yy_ch_buf )
- YY_FATAL_ERROR( "out of dynamic memory in yy_get_next_buffer()" );
- }
-
- (yy_n_chars) += number_to_move;
- YY_CURRENT_BUFFER_LVALUE->yy_ch_buf[(yy_n_chars)] = YY_END_OF_BUFFER_CHAR;
- YY_CURRENT_BUFFER_LVALUE->yy_ch_buf[(yy_n_chars) + 1] = YY_END_OF_BUFFER_CHAR;
-
- (yytext_ptr) = &YY_CURRENT_BUFFER_LVALUE->yy_ch_buf[0];
-
- return ret_val;
-}
-
-/* yy_get_previous_state - get the state just before the EOB char was reached */
-
- static yy_state_type yy_get_previous_state (void)
-{
- register yy_state_type yy_current_state;
- register char *yy_cp;
-
- yy_current_state = (yy_start);
-
- for ( yy_cp = (yytext_ptr) + YY_MORE_ADJ; yy_cp < (yy_c_buf_p); ++yy_cp )
- {
- yy_current_state = yy_nxt[yy_current_state][(*yy_cp ? yy_ec[YY_SC_TO_UI(*yy_cp)] : 1)];
- if ( yy_accept[yy_current_state] )
- {
- (yy_last_accepting_state) = yy_current_state;
- (yy_last_accepting_cpos) = yy_cp;
- }
- }
-
- return yy_current_state;
-}
-
-/* yy_try_NUL_trans - try to make a transition on the NUL character
- *
- * synopsis
- * next_state = yy_try_NUL_trans( current_state );
- */
- static yy_state_type yy_try_NUL_trans (yy_state_type yy_current_state )
-{
- register int yy_is_jam;
- register char *yy_cp = (yy_c_buf_p);
-
- yy_current_state = yy_nxt[yy_current_state][1];
- yy_is_jam = (yy_current_state <= 0);
-
- if ( ! yy_is_jam )
- {
- if ( yy_accept[yy_current_state] )
- {
- (yy_last_accepting_state) = yy_current_state;
- (yy_last_accepting_cpos) = yy_cp;
- }
- }
-
- return yy_is_jam ? 0 : yy_current_state;
-}
-
- static void yyunput (int c, register char * yy_bp )
-{
- register char *yy_cp;
-
- yy_cp = (yy_c_buf_p);
-
- /* undo effects of setting up zconftext */
- *yy_cp = (yy_hold_char);
-
- if ( yy_cp < YY_CURRENT_BUFFER_LVALUE->yy_ch_buf + 2 )
- { /* need to shift things up to make room */
- /* +2 for EOB chars. */
- register yy_size_t number_to_move = (yy_n_chars) + 2;
- register char *dest = &YY_CURRENT_BUFFER_LVALUE->yy_ch_buf[
- YY_CURRENT_BUFFER_LVALUE->yy_buf_size + 2];
- register char *source =
- &YY_CURRENT_BUFFER_LVALUE->yy_ch_buf[number_to_move];
-
- while ( source > YY_CURRENT_BUFFER_LVALUE->yy_ch_buf )
- *--dest = *--source;
-
- yy_cp += (int) (dest - source);
- yy_bp += (int) (dest - source);
- YY_CURRENT_BUFFER_LVALUE->yy_n_chars =
- (yy_n_chars) = YY_CURRENT_BUFFER_LVALUE->yy_buf_size;
-
- if ( yy_cp < YY_CURRENT_BUFFER_LVALUE->yy_ch_buf + 2 )
- YY_FATAL_ERROR( "flex scanner push-back overflow" );
- }
-
- *--yy_cp = (char) c;
-
- (yytext_ptr) = yy_bp;
- (yy_hold_char) = *yy_cp;
- (yy_c_buf_p) = yy_cp;
-}
-
-#ifndef YY_NO_INPUT
-#ifdef __cplusplus
- static int yyinput (void)
-#else
- static int input (void)
-#endif
-
-{
- int c;
-
- *(yy_c_buf_p) = (yy_hold_char);
-
- if ( *(yy_c_buf_p) == YY_END_OF_BUFFER_CHAR )
- {
- /* yy_c_buf_p now points to the character we want to return.
- * If this occurs *before* the EOB characters, then it's a
- * valid NUL; if not, then we've hit the end of the buffer.
- */
- if ( (yy_c_buf_p) < &YY_CURRENT_BUFFER_LVALUE->yy_ch_buf[(yy_n_chars)] )
- /* This was really a NUL. */
- *(yy_c_buf_p) = '\0';
-
- else
- { /* need more input */
- yy_size_t offset = (yy_c_buf_p) - (yytext_ptr);
- ++(yy_c_buf_p);
-
- switch ( yy_get_next_buffer( ) )
- {
- case EOB_ACT_LAST_MATCH:
- /* This happens because yy_g_n_b()
- * sees that we've accumulated a
- * token and flags that we need to
- * try matching the token before
- * proceeding. But for input(),
- * there's no matching to consider.
- * So convert the EOB_ACT_LAST_MATCH
- * to EOB_ACT_END_OF_FILE.
- */
-
- /* Reset buffer status. */
- zconfrestart(zconfin );
-
- /*FALLTHROUGH*/
-
- case EOB_ACT_END_OF_FILE:
- {
- if ( zconfwrap( ) )
- return 0;
-
- if ( ! (yy_did_buffer_switch_on_eof) )
- YY_NEW_FILE;
-#ifdef __cplusplus
- return yyinput();
-#else
- return input();
-#endif
- }
-
- case EOB_ACT_CONTINUE_SCAN:
- (yy_c_buf_p) = (yytext_ptr) + offset;
- break;
- }
- }
- }
-
- c = *(unsigned char *) (yy_c_buf_p); /* cast for 8-bit char's */
- *(yy_c_buf_p) = '\0'; /* preserve zconftext */
- (yy_hold_char) = *++(yy_c_buf_p);
-
- return c;
-}
-#endif /* ifndef YY_NO_INPUT */
-
-/** Immediately switch to a different input stream.
- * @param input_file A readable stream.
- *
- * @note This function does not reset the start condition to @c INITIAL .
- */
- void zconfrestart (FILE * input_file )
-{
-
- if ( ! YY_CURRENT_BUFFER ){
- zconfensure_buffer_stack ();
- YY_CURRENT_BUFFER_LVALUE =
- zconf_create_buffer(zconfin,YY_BUF_SIZE );
- }
-
- zconf_init_buffer(YY_CURRENT_BUFFER,input_file );
- zconf_load_buffer_state( );
-}
-
-/** Switch to a different input buffer.
- * @param new_buffer The new input buffer.
- *
- */
- void zconf_switch_to_buffer (YY_BUFFER_STATE new_buffer )
-{
-
- /* TODO. We should be able to replace this entire function body
- * with
- * zconfpop_buffer_state();
- * zconfpush_buffer_state(new_buffer);
- */
- zconfensure_buffer_stack ();
- if ( YY_CURRENT_BUFFER == new_buffer )
- return;
-
- if ( YY_CURRENT_BUFFER )
- {
- /* Flush out information for old buffer. */
- *(yy_c_buf_p) = (yy_hold_char);
- YY_CURRENT_BUFFER_LVALUE->yy_buf_pos = (yy_c_buf_p);
- YY_CURRENT_BUFFER_LVALUE->yy_n_chars = (yy_n_chars);
- }
-
- YY_CURRENT_BUFFER_LVALUE = new_buffer;
- zconf_load_buffer_state( );
-
- /* We don't actually know whether we did this switch during
- * EOF (zconfwrap()) processing, but the only time this flag
- * is looked at is after zconfwrap() is called, so it's safe
- * to go ahead and always set it.
- */
- (yy_did_buffer_switch_on_eof) = 1;
-}
-
-static void zconf_load_buffer_state (void)
-{
- (yy_n_chars) = YY_CURRENT_BUFFER_LVALUE->yy_n_chars;
- (yytext_ptr) = (yy_c_buf_p) = YY_CURRENT_BUFFER_LVALUE->yy_buf_pos;
- zconfin = YY_CURRENT_BUFFER_LVALUE->yy_input_file;
- (yy_hold_char) = *(yy_c_buf_p);
-}
-
-/** Allocate and initialize an input buffer state.
- * @param file A readable stream.
- * @param size The character buffer size in bytes. When in doubt, use @c YY_BUF_SIZE.
- *
- * @return the allocated buffer state.
- */
- YY_BUFFER_STATE zconf_create_buffer (FILE * file, int size )
-{
- YY_BUFFER_STATE b;
-
- b = (YY_BUFFER_STATE) zconfalloc(sizeof( struct yy_buffer_state ) );
- if ( ! b )
- YY_FATAL_ERROR( "out of dynamic memory in zconf_create_buffer()" );
-
- b->yy_buf_size = size;
-
- /* yy_ch_buf has to be 2 characters longer than the size given because
- * we need to put in 2 end-of-buffer characters.
- */
- b->yy_ch_buf = (char *) zconfalloc(b->yy_buf_size + 2 );
- if ( ! b->yy_ch_buf )
- YY_FATAL_ERROR( "out of dynamic memory in zconf_create_buffer()" );
-
- b->yy_is_our_buffer = 1;
-
- zconf_init_buffer(b,file );
-
- return b;
-}
-
-/** Destroy the buffer.
- * @param b a buffer created with zconf_create_buffer()
- *
- */
- void zconf_delete_buffer (YY_BUFFER_STATE b )
-{
-
- if ( ! b )
- return;
-
- if ( b == YY_CURRENT_BUFFER ) /* Not sure if we should pop here. */
- YY_CURRENT_BUFFER_LVALUE = (YY_BUFFER_STATE) 0;
-
- if ( b->yy_is_our_buffer )
- zconffree((void *) b->yy_ch_buf );
-
- zconffree((void *) b );
-}
-
-/* Initializes or reinitializes a buffer.
- * This function is sometimes called more than once on the same buffer,
- * such as during a zconfrestart() or at EOF.
- */
- static void zconf_init_buffer (YY_BUFFER_STATE b, FILE * file )
-
-{
- int oerrno = errno;
-
- zconf_flush_buffer(b );
-
- b->yy_input_file = file;
- b->yy_fill_buffer = 1;
-
- /* If b is the current buffer, then zconf_init_buffer was _probably_
- * called from zconfrestart() or through yy_get_next_buffer.
- * In that case, we don't want to reset the lineno or column.
- */
- if (b != YY_CURRENT_BUFFER){
- b->yy_bs_lineno = 1;
- b->yy_bs_column = 0;
- }
-
- b->yy_is_interactive = 0;
-
- errno = oerrno;
-}
-
-/** Discard all buffered characters. On the next scan, YY_INPUT will be called.
- * @param b the buffer state to be flushed, usually @c YY_CURRENT_BUFFER.
- *
- */
- void zconf_flush_buffer (YY_BUFFER_STATE b )
-{
- if ( ! b )
- return;
-
- b->yy_n_chars = 0;
-
- /* We always need two end-of-buffer characters. The first causes
- * a transition to the end-of-buffer state. The second causes
- * a jam in that state.
- */
- b->yy_ch_buf[0] = YY_END_OF_BUFFER_CHAR;
- b->yy_ch_buf[1] = YY_END_OF_BUFFER_CHAR;
-
- b->yy_buf_pos = &b->yy_ch_buf[0];
-
- b->yy_at_bol = 1;
- b->yy_buffer_status = YY_BUFFER_NEW;
-
- if ( b == YY_CURRENT_BUFFER )
- zconf_load_buffer_state( );
-}
-
-/** Pushes the new state onto the stack. The new state becomes
- * the current state. This function will allocate the stack
- * if necessary.
- * @param new_buffer The new state.
- *
- */
-void zconfpush_buffer_state (YY_BUFFER_STATE new_buffer )
-{
- if (new_buffer == NULL)
- return;
-
- zconfensure_buffer_stack();
-
- /* This block is copied from zconf_switch_to_buffer. */
- if ( YY_CURRENT_BUFFER )
- {
- /* Flush out information for old buffer. */
- *(yy_c_buf_p) = (yy_hold_char);
- YY_CURRENT_BUFFER_LVALUE->yy_buf_pos = (yy_c_buf_p);
- YY_CURRENT_BUFFER_LVALUE->yy_n_chars = (yy_n_chars);
- }
-
- /* Only push if top exists. Otherwise, replace top. */
- if (YY_CURRENT_BUFFER)
- (yy_buffer_stack_top)++;
- YY_CURRENT_BUFFER_LVALUE = new_buffer;
-
- /* copied from zconf_switch_to_buffer. */
- zconf_load_buffer_state( );
- (yy_did_buffer_switch_on_eof) = 1;
-}
-
-/** Removes and deletes the top of the stack, if present.
- * The next element becomes the new top.
- *
- */
-void zconfpop_buffer_state (void)
-{
- if (!YY_CURRENT_BUFFER)
- return;
-
- zconf_delete_buffer(YY_CURRENT_BUFFER );
- YY_CURRENT_BUFFER_LVALUE = NULL;
- if ((yy_buffer_stack_top) > 0)
- --(yy_buffer_stack_top);
-
- if (YY_CURRENT_BUFFER) {
- zconf_load_buffer_state( );
- (yy_did_buffer_switch_on_eof) = 1;
- }
-}
-
-/* Allocates the stack if it does not exist.
- * Guarantees space for at least one push.
- */
-static void zconfensure_buffer_stack (void)
-{
- yy_size_t num_to_alloc;
-
- if (!(yy_buffer_stack)) {
-
- /* First allocation is just for 2 elements, since we don't know if this
- * scanner will even need a stack. We use 2 instead of 1 to avoid an
- * immediate realloc on the next call.
- */
- num_to_alloc = 1;
- (yy_buffer_stack) = (struct yy_buffer_state**)zconfalloc
- (num_to_alloc * sizeof(struct yy_buffer_state*)
- );
- if ( ! (yy_buffer_stack) )
- YY_FATAL_ERROR( "out of dynamic memory in zconfensure_buffer_stack()" );
-
- memset((yy_buffer_stack), 0, num_to_alloc * sizeof(struct yy_buffer_state*));
-
- (yy_buffer_stack_max) = num_to_alloc;
- (yy_buffer_stack_top) = 0;
- return;
- }
-
- if ((yy_buffer_stack_top) >= ((yy_buffer_stack_max)) - 1){
-
- /* Increase the buffer to prepare for a possible push. */
- int grow_size = 8 /* arbitrary grow size */;
-
- num_to_alloc = (yy_buffer_stack_max) + grow_size;
- (yy_buffer_stack) = (struct yy_buffer_state**)zconfrealloc
- ((yy_buffer_stack),
- num_to_alloc * sizeof(struct yy_buffer_state*)
- );
- if ( ! (yy_buffer_stack) )
- YY_FATAL_ERROR( "out of dynamic memory in zconfensure_buffer_stack()" );
-
- /* zero only the new slots.*/
- memset((yy_buffer_stack) + (yy_buffer_stack_max), 0, grow_size * sizeof(struct yy_buffer_state*));
- (yy_buffer_stack_max) = num_to_alloc;
- }
-}
-
-/** Setup the input buffer state to scan directly from a user-specified character buffer.
- * @param base the character buffer
- * @param size the size in bytes of the character buffer
- *
- * @return the newly allocated buffer state object.
- */
-YY_BUFFER_STATE zconf_scan_buffer (char * base, yy_size_t size )
-{
- YY_BUFFER_STATE b;
-
- if ( size < 2 ||
- base[size-2] != YY_END_OF_BUFFER_CHAR ||
- base[size-1] != YY_END_OF_BUFFER_CHAR )
- /* They forgot to leave room for the EOB's. */
- return 0;
-
- b = (YY_BUFFER_STATE) zconfalloc(sizeof( struct yy_buffer_state ) );
- if ( ! b )
- YY_FATAL_ERROR( "out of dynamic memory in zconf_scan_buffer()" );
-
- b->yy_buf_size = size - 2; /* "- 2" to take care of EOB's */
- b->yy_buf_pos = b->yy_ch_buf = base;
- b->yy_is_our_buffer = 0;
- b->yy_input_file = 0;
- b->yy_n_chars = b->yy_buf_size;
- b->yy_is_interactive = 0;
- b->yy_at_bol = 1;
- b->yy_fill_buffer = 0;
- b->yy_buffer_status = YY_BUFFER_NEW;
-
- zconf_switch_to_buffer(b );
-
- return b;
-}
-
-/** Setup the input buffer state to scan a string. The next call to zconflex() will
- * scan from a @e copy of @a str.
- * @param yystr a NUL-terminated string to scan
- *
- * @return the newly allocated buffer state object.
- * @note If you want to scan bytes that may contain NUL values, then use
- * zconf_scan_bytes() instead.
- */
-YY_BUFFER_STATE zconf_scan_string (yyconst char * yystr )
-{
-
- return zconf_scan_bytes(yystr,strlen(yystr) );
-}
-
-/** Setup the input buffer state to scan the given bytes. The next call to zconflex() will
- * scan from a @e copy of @a bytes.
- * @param bytes the byte buffer to scan
- * @param len the number of bytes in the buffer pointed to by @a bytes.
- *
- * @return the newly allocated buffer state object.
- */
-YY_BUFFER_STATE zconf_scan_bytes (yyconst char * yybytes, yy_size_t _yybytes_len )
-{
- YY_BUFFER_STATE b;
- char *buf;
- yy_size_t n, i;
-
- /* Get memory for full buffer, including space for trailing EOB's. */
- n = _yybytes_len + 2;
- buf = (char *) zconfalloc(n );
- if ( ! buf )
- YY_FATAL_ERROR( "out of dynamic memory in zconf_scan_bytes()" );
-
- for ( i = 0; i < _yybytes_len; ++i )
- buf[i] = yybytes[i];
-
- buf[_yybytes_len] = buf[_yybytes_len+1] = YY_END_OF_BUFFER_CHAR;
-
- b = zconf_scan_buffer(buf,n );
- if ( ! b )
- YY_FATAL_ERROR( "bad buffer in zconf_scan_bytes()" );
-
- /* It's okay to grow etc. this buffer, and we should throw it
- * away when we're done.
- */
- b->yy_is_our_buffer = 1;
-
- return b;
-}
-
-#ifndef YY_EXIT_FAILURE
-#define YY_EXIT_FAILURE 2
-#endif
-
-static void yy_fatal_error (yyconst char* msg )
-{
- (void) fprintf( stderr, "%s\n", msg );
- exit( YY_EXIT_FAILURE );
-}
-
-/* Redefine yyless() so it works in section 3 code. */
-
-#undef yyless
-#define yyless(n) \
- do \
- { \
- /* Undo effects of setting up zconftext. */ \
- int yyless_macro_arg = (n); \
- YY_LESS_LINENO(yyless_macro_arg);\
- zconftext[zconfleng] = (yy_hold_char); \
- (yy_c_buf_p) = zconftext + yyless_macro_arg; \
- (yy_hold_char) = *(yy_c_buf_p); \
- *(yy_c_buf_p) = '\0'; \
- zconfleng = yyless_macro_arg; \
- } \
- while ( 0 )
-
-/* Accessor methods (get/set functions) to struct members. */
-
-/** Get the current line number.
- *
- */
-int zconfget_lineno (void)
-{
-
- return zconflineno;
-}
-
-/** Get the input stream.
- *
- */
-FILE *zconfget_in (void)
-{
- return zconfin;
-}
-
-/** Get the output stream.
- *
- */
-FILE *zconfget_out (void)
-{
- return zconfout;
-}
-
-/** Get the length of the current token.
- *
- */
-yy_size_t zconfget_leng (void)
-{
- return zconfleng;
-}
-
-/** Get the current token.
- *
- */
-
-char *zconfget_text (void)
-{
- return zconftext;
-}
-
-/** Set the current line number.
- * @param line_number
- *
- */
-void zconfset_lineno (int line_number )
-{
-
- zconflineno = line_number;
-}
-
-/** Set the input stream. This does not discard the current
- * input buffer.
- * @param in_str A readable stream.
- *
- * @see zconf_switch_to_buffer
- */
-void zconfset_in (FILE * in_str )
-{
- zconfin = in_str ;
-}
-
-void zconfset_out (FILE * out_str )
-{
- zconfout = out_str ;
-}
-
-int zconfget_debug (void)
-{
- return zconf_flex_debug;
-}
-
-void zconfset_debug (int bdebug )
-{
- zconf_flex_debug = bdebug ;
-}
-
-static int yy_init_globals (void)
-{
- /* Initialization is the same as for the non-reentrant scanner.
- * This function is called from zconflex_destroy(), so don't allocate here.
- */
-
- (yy_buffer_stack) = 0;
- (yy_buffer_stack_top) = 0;
- (yy_buffer_stack_max) = 0;
- (yy_c_buf_p) = (char *) 0;
- (yy_init) = 0;
- (yy_start) = 0;
-
-/* Defined in main.c */
-#ifdef YY_STDINIT
- zconfin = stdin;
- zconfout = stdout;
-#else
- zconfin = (FILE *) 0;
- zconfout = (FILE *) 0;
-#endif
-
- /* For future reference: Set errno on error, since we are called by
- * zconflex_init()
- */
- return 0;
-}
-
-/* zconflex_destroy is for both reentrant and non-reentrant scanners. */
-int zconflex_destroy (void)
-{
-
- /* Pop the buffer stack, destroying each element. */
- while(YY_CURRENT_BUFFER){
- zconf_delete_buffer(YY_CURRENT_BUFFER );
- YY_CURRENT_BUFFER_LVALUE = NULL;
- zconfpop_buffer_state();
- }
-
- /* Destroy the stack itself. */
- zconffree((yy_buffer_stack) );
- (yy_buffer_stack) = NULL;
-
- /* Reset the globals. This is important in a non-reentrant scanner so the next time
- * zconflex() is called, initialization will occur. */
- yy_init_globals( );
-
- return 0;
-}
-
-/*
- * Internal utility routines.
- */
-
-#ifndef yytext_ptr
-static void yy_flex_strncpy (char* s1, yyconst char * s2, int n )
-{
- register int i;
- for ( i = 0; i < n; ++i )
- s1[i] = s2[i];
-}
-#endif
-
-#ifdef YY_NEED_STRLEN
-static int yy_flex_strlen (yyconst char * s )
-{
- register int n;
- for ( n = 0; s[n]; ++n )
- ;
-
- return n;
-}
-#endif
-
-void *zconfalloc (yy_size_t size )
-{
- return (void *) malloc( size );
-}
-
-void *zconfrealloc (void * ptr, yy_size_t size )
-{
- /* The cast to (char *) in the following accommodates both
- * implementations that use char* generic pointers, and those
- * that use void* generic pointers. It works with the latter
- * because both ANSI C and C++ allow castless assignment from
- * any pointer type to void*, and deal with argument conversions
- * as though doing an assignment.
- */
- return (void *) realloc( (char *) ptr, size );
-}
-
-void zconffree (void * ptr )
-{
- free( (char *) ptr ); /* see zconfrealloc() for (char *) cast */
-}
-
-#define YYTABLES_NAME "yytables"
-
-void zconf_starthelp(void)
-{
- new_string();
- last_ts = first_ts = 0;
- BEGIN(HELP);
-}
-
-static void zconf_endhelp(void)
-{
- zconflval.string = text;
- BEGIN(INITIAL);
-}
-
-/*
- * Try to open specified file with following names:
- * ./name
- * $(srctree)/name
- * The latter is used when srctree is separate from objtree
- * when compiling the kernel.
- * Return NULL if file is not found.
- */
-FILE *zconf_fopen(const char *name)
-{
- char *env, fullname[PATH_MAX+1];
- FILE *f;
-
- f = fopen(name, "r");
- if (!f && name != NULL && name[0] != '/') {
- env = getenv(SRCTREE);
- if (env) {
- sprintf(fullname, "%s/%s", env, name);
- f = fopen(fullname, "r");
- }
- }
- return f;
-}
-
-void zconf_initscan(const char *name)
-{
- zconfin = zconf_fopen(name);
- if (!zconfin) {
- printf("can't find file %s\n", name);
- exit(1);
- }
-
- current_buf = xmalloc(sizeof(*current_buf));
- memset(current_buf, 0, sizeof(*current_buf));
-
- current_file = file_lookup(name);
- current_file->lineno = 1;
-}
-
-void zconf_nextfile(const char *name)
-{
- struct file *iter;
- struct file *file = file_lookup(name);
- struct buffer *buf = xmalloc(sizeof(*buf));
- memset(buf, 0, sizeof(*buf));
-
- current_buf->state = YY_CURRENT_BUFFER;
- zconfin = zconf_fopen(file->name);
- if (!zconfin) {
- printf("%s:%d: can't open file \"%s\"\n",
- zconf_curname(), zconf_lineno(), file->name);
- exit(1);
- }
- zconf_switch_to_buffer(zconf_create_buffer(zconfin,YY_BUF_SIZE));
- buf->parent = current_buf;
- current_buf = buf;
-
- for (iter = current_file->parent; iter; iter = iter->parent ) {
- if (!strcmp(current_file->name,iter->name) ) {
- printf("%s:%d: recursive inclusion detected. "
- "Inclusion path:\n current file : '%s'\n",
- zconf_curname(), zconf_lineno(),
- zconf_curname());
- iter = current_file->parent;
- while (iter && \
- strcmp(iter->name,current_file->name)) {
- printf(" included from: '%s:%d'\n",
- iter->name, iter->lineno-1);
- iter = iter->parent;
- }
- if (iter)
- printf(" included from: '%s:%d'\n",
- iter->name, iter->lineno+1);
- exit(1);
- }
- }
- file->lineno = 1;
- file->parent = current_file;
- current_file = file;
-}
-
-void zconf_nextfiles(const char *wildcard)
-{
- wordexp_t p;
- char **w;
- int i;
-
- wordexp(wildcard, &p, 0);
- w = p.we_wordv;
-
- for (i = p.we_wordc - 1; i >= 0; i--)
- zconf_nextfile(w[i]);
-
- wordfree(&p);
-}
-
-static void zconf_endfile(void)
-{
- struct buffer *parent;
-
- current_file = current_file->parent;
-
- parent = current_buf->parent;
- if (parent) {
- fclose(zconfin);
- zconf_delete_buffer(YY_CURRENT_BUFFER);
- zconf_switch_to_buffer(parent->state);
- }
- free(current_buf);
- current_buf = parent;
-}
-
-int zconf_lineno(void)
-{
- return current_pos.lineno;
-}
-
-const char *zconf_curname(void)
-{
- return current_pos.file ? current_pos.file->name : "<none>";
-}
-
+++ /dev/null
-/* A Bison parser, made by GNU Bison 2.3. */
-
-/* Skeleton implementation for Bison's Yacc-like parsers in C
-
- Copyright (C) 1984, 1989, 1990, 2000, 2001, 2002, 2003, 2004, 2005, 2006
- Free Software Foundation, Inc.
-
- This program is free software; you can redistribute it and/or modify
- it under the terms of the GNU General Public License as published by
- the Free Software Foundation; either version 2, or (at your option)
- any later version.
-
- This program is distributed in the hope that it will be useful,
- but WITHOUT ANY WARRANTY; without even the implied warranty of
- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- GNU General Public License for more details.
-
- You should have received a copy of the GNU General Public License
- along with this program; if not, write to the Free Software
- Foundation, Inc., 51 Franklin Street, Fifth Floor,
- Boston, MA 02110-1301, USA. */
-
-/* As a special exception, you may create a larger work that contains
- part or all of the Bison parser skeleton and distribute that work
- under terms of your choice, so long as that work isn't itself a
- parser generator using the skeleton or a modified version thereof
- as a parser skeleton. Alternatively, if you modify or redistribute
- the parser skeleton itself, you may (at your option) remove this
- special exception, which will cause the skeleton and the resulting
- Bison output files to be licensed under the GNU General Public
- License without this special exception.
-
- This special exception was added by the Free Software Foundation in
- version 2.2 of Bison. */
-
-/* C LALR(1) parser skeleton written by Richard Stallman, by
- simplifying the original so-called "semantic" parser. */
-
-/* All symbols defined below should begin with yy or YY, to avoid
- infringing on user name space. This should be done even for local
- variables, as they might otherwise be expanded by user macros.
- There are some unavoidable exceptions within include files to
- define necessary library symbols; they are noted "INFRINGES ON
- USER NAME SPACE" below. */
-
-/* Identify Bison output. */
-#define YYBISON 1
-
-/* Bison version. */
-#define YYBISON_VERSION "2.3"
-
-/* Skeleton name. */
-#define YYSKELETON_NAME "yacc.c"
-
-/* Pure parsers. */
-#define YYPURE 0
-
-/* Using locations. */
-#define YYLSP_NEEDED 0
-
-/* Substitute the variable and function names. */
-#define yyparse zconfparse
-#define yylex zconflex
-#define yyerror zconferror
-#define yylval zconflval
-#define yychar zconfchar
-#define yydebug zconfdebug
-#define yynerrs zconfnerrs
-
-
-/* Tokens. */
-#ifndef YYTOKENTYPE
-# define YYTOKENTYPE
- /* Put the tokens into the symbol table, so that GDB and other debuggers
- know about them. */
- enum yytokentype {
- T_MAINMENU = 258,
- T_MENU = 259,
- T_ENDMENU = 260,
- T_SOURCE = 261,
- T_CHOICE = 262,
- T_ENDCHOICE = 263,
- T_COMMENT = 264,
- T_CONFIG = 265,
- T_MENUCONFIG = 266,
- T_HELP = 267,
- T_HELPTEXT = 268,
- T_IF = 269,
- T_ENDIF = 270,
- T_DEPENDS = 271,
- T_OPTIONAL = 272,
- T_PROMPT = 273,
- T_TYPE = 274,
- T_DEFAULT = 275,
- T_SELECT = 276,
- T_RANGE = 277,
- T_VISIBLE = 278,
- T_OPTION = 279,
- T_ON = 280,
- T_WORD = 281,
- T_WORD_QUOTE = 282,
- T_UNEQUAL = 283,
- T_LESS = 284,
- T_LESS_EQUAL = 285,
- T_GREATER = 286,
- T_GREATER_EQUAL = 287,
- T_CLOSE_PAREN = 288,
- T_OPEN_PAREN = 289,
- T_EOL = 290,
- T_OR = 291,
- T_AND = 292,
- T_EQUAL = 293,
- T_NOT = 294
- };
-#endif
-/* Tokens. */
-#define T_MAINMENU 258
-#define T_MENU 259
-#define T_ENDMENU 260
-#define T_SOURCE 261
-#define T_CHOICE 262
-#define T_ENDCHOICE 263
-#define T_COMMENT 264
-#define T_CONFIG 265
-#define T_MENUCONFIG 266
-#define T_HELP 267
-#define T_HELPTEXT 268
-#define T_IF 269
-#define T_ENDIF 270
-#define T_DEPENDS 271
-#define T_OPTIONAL 272
-#define T_PROMPT 273
-#define T_TYPE 274
-#define T_DEFAULT 275
-#define T_SELECT 276
-#define T_RANGE 277
-#define T_VISIBLE 278
-#define T_OPTION 279
-#define T_ON 280
-#define T_WORD 281
-#define T_WORD_QUOTE 282
-#define T_UNEQUAL 283
-#define T_LESS 284
-#define T_LESS_EQUAL 285
-#define T_GREATER 286
-#define T_GREATER_EQUAL 287
-#define T_CLOSE_PAREN 288
-#define T_OPEN_PAREN 289
-#define T_EOL 290
-#define T_OR 291
-#define T_AND 292
-#define T_EQUAL 293
-#define T_NOT 294
-
-
-
-
-/* Copy the first part of user declarations. */
-
-
-/*
- * Copyright (C) 2002 Roman Zippel <zippel@linux-m68k.org>
- * Released under the terms of the GNU GPL v2.0.
- */
-
-#include <ctype.h>
-#include <stdarg.h>
-#include <stdio.h>
-#include <stdlib.h>
-#include <string.h>
-#include <stdbool.h>
-
-#include "lkc.h"
-
-#define printd(mask, fmt...) if (cdebug & (mask)) printf(fmt)
-
-#define PRINTD 0x0001
-#define DEBUG_PARSE 0x0002
-
-int cdebug = PRINTD;
-
-extern int zconflex(void);
-static void zconfprint(const char *err, ...);
-static void zconf_error(const char *err, ...);
-static void zconferror(const char *err);
-static bool zconf_endtoken(const struct kconf_id *id, int starttoken, int endtoken);
-
-struct symbol *symbol_hash[SYMBOL_HASHSIZE];
-
-static struct menu *current_menu, *current_entry;
-
-
-
-/* Enabling traces. */
-#ifndef YYDEBUG
-# define YYDEBUG 1
-#endif
-
-/* Enabling verbose error messages. */
-#ifdef YYERROR_VERBOSE
-# undef YYERROR_VERBOSE
-# define YYERROR_VERBOSE 1
-#else
-# define YYERROR_VERBOSE 0
-#endif
-
-/* Enabling the token table. */
-#ifndef YYTOKEN_TABLE
-# define YYTOKEN_TABLE 0
-#endif
-
-#if ! defined YYSTYPE && ! defined YYSTYPE_IS_DECLARED
-typedef union YYSTYPE
-
-{
- char *string;
- struct file *file;
- struct symbol *symbol;
- struct expr *expr;
- struct menu *menu;
- const struct kconf_id *id;
-}
-/* Line 193 of yacc.c. */
-
- YYSTYPE;
-# define yystype YYSTYPE /* obsolescent; will be withdrawn */
-# define YYSTYPE_IS_DECLARED 1
-# define YYSTYPE_IS_TRIVIAL 1
-#endif
-
-
-
-/* Copy the second part of user declarations. */
-
-
-/* Include zconf.hash.c here so it can see the token constants. */
-#include "zconf.hash.c"
-
-
-/* Line 216 of yacc.c. */
-
-
-#ifdef short
-# undef short
-#endif
-
-#ifdef YYTYPE_UINT8
-typedef YYTYPE_UINT8 yytype_uint8;
-#else
-typedef unsigned char yytype_uint8;
-#endif
-
-#ifdef YYTYPE_INT8
-typedef YYTYPE_INT8 yytype_int8;
-#elif (defined __STDC__ || defined __C99__FUNC__ \
- || defined __cplusplus || defined _MSC_VER)
-typedef signed char yytype_int8;
-#else
-typedef short int yytype_int8;
-#endif
-
-#ifdef YYTYPE_UINT16
-typedef YYTYPE_UINT16 yytype_uint16;
-#else
-typedef unsigned short int yytype_uint16;
-#endif
-
-#ifdef YYTYPE_INT16
-typedef YYTYPE_INT16 yytype_int16;
-#else
-typedef short int yytype_int16;
-#endif
-
-#ifndef YYSIZE_T
-# ifdef __SIZE_TYPE__
-# define YYSIZE_T __SIZE_TYPE__
-# elif defined size_t
-# define YYSIZE_T size_t
-# elif ! defined YYSIZE_T && (defined __STDC__ || defined __C99__FUNC__ \
- || defined __cplusplus || defined _MSC_VER)
-# include <stddef.h> /* INFRINGES ON USER NAME SPACE */
-# define YYSIZE_T size_t
-# else
-# define YYSIZE_T unsigned int
-# endif
-#endif
-
-#define YYSIZE_MAXIMUM ((YYSIZE_T) -1)
-
-#ifndef YY_
-# if defined YYENABLE_NLS && YYENABLE_NLS
-# if ENABLE_NLS
-# include <libintl.h> /* INFRINGES ON USER NAME SPACE */
-# define YY_(msgid) dgettext ("bison-runtime", msgid)
-# endif
-# endif
-# ifndef YY_
-# define YY_(msgid) msgid
-# endif
-#endif
-
-/* Suppress unused-variable warnings by "using" E. */
-#if ! defined lint || defined __GNUC__
-# define YYUSE(e) ((void) (e))
-#else
-# define YYUSE(e) /* empty */
-#endif
-
-/* Identity function, used to suppress warnings about constant conditions. */
-#ifndef lint
-# define YYID(n) (n)
-#else
-#if (defined __STDC__ || defined __C99__FUNC__ \
- || defined __cplusplus || defined _MSC_VER)
-static int
-YYID (int i)
-#else
-static int
-YYID (i)
- int i;
-#endif
-{
- return i;
-}
-#endif
-
-#if ! defined yyoverflow || YYERROR_VERBOSE
-
-/* The parser invokes alloca or malloc; define the necessary symbols. */
-
-# ifdef YYSTACK_USE_ALLOCA
-# if YYSTACK_USE_ALLOCA
-# ifdef __GNUC__
-# define YYSTACK_ALLOC __builtin_alloca
-# elif defined __BUILTIN_VA_ARG_INCR
-# include <alloca.h> /* INFRINGES ON USER NAME SPACE */
-# elif defined _AIX
-# define YYSTACK_ALLOC __alloca
-# elif defined _MSC_VER
-# include <malloc.h> /* INFRINGES ON USER NAME SPACE */
-# define alloca _alloca
-# else
-# define YYSTACK_ALLOC alloca
-# if ! defined _ALLOCA_H && ! defined _STDLIB_H && (defined __STDC__ || defined __C99__FUNC__ \
- || defined __cplusplus || defined _MSC_VER)
-# include <stdlib.h> /* INFRINGES ON USER NAME SPACE */
-# ifndef _STDLIB_H
-# define _STDLIB_H 1
-# endif
-# endif
-# endif
-# endif
-# endif
-
-# ifdef YYSTACK_ALLOC
- /* Pacify GCC's `empty if-body' warning. */
-# define YYSTACK_FREE(Ptr) do { /* empty */; } while (YYID (0))
-# ifndef YYSTACK_ALLOC_MAXIMUM
- /* The OS might guarantee only one guard page at the bottom of the stack,
- and a page size can be as small as 4096 bytes. So we cannot safely
- invoke alloca (N) if N exceeds 4096. Use a slightly smaller number
- to allow for a few compiler-allocated temporary stack slots. */
-# define YYSTACK_ALLOC_MAXIMUM 4032 /* reasonable circa 2006 */
-# endif
-# else
-# define YYSTACK_ALLOC YYMALLOC
-# define YYSTACK_FREE YYFREE
-# ifndef YYSTACK_ALLOC_MAXIMUM
-# define YYSTACK_ALLOC_MAXIMUM YYSIZE_MAXIMUM
-# endif
-# if (defined __cplusplus && ! defined _STDLIB_H \
- && ! ((defined YYMALLOC || defined malloc) \
- && (defined YYFREE || defined free)))
-# include <stdlib.h> /* INFRINGES ON USER NAME SPACE */
-# ifndef _STDLIB_H
-# define _STDLIB_H 1
-# endif
-# endif
-# ifndef YYMALLOC
-# define YYMALLOC malloc
-# if ! defined malloc && ! defined _STDLIB_H && (defined __STDC__ || defined __C99__FUNC__ \
- || defined __cplusplus || defined _MSC_VER)
-void *malloc (YYSIZE_T); /* INFRINGES ON USER NAME SPACE */
-# endif
-# endif
-# ifndef YYFREE
-# define YYFREE free
-# if ! defined free && ! defined _STDLIB_H && (defined __STDC__ || defined __C99__FUNC__ \
- || defined __cplusplus || defined _MSC_VER)
-void free (void *); /* INFRINGES ON USER NAME SPACE */
-# endif
-# endif
-# endif
-#endif /* ! defined yyoverflow || YYERROR_VERBOSE */
-
-
-#if (! defined yyoverflow \
- && (! defined __cplusplus \
- || (defined YYSTYPE_IS_TRIVIAL && YYSTYPE_IS_TRIVIAL)))
-
-/* A type that is properly aligned for any stack member. */
-union yyalloc
-{
- yytype_int16 yyss;
- YYSTYPE yyvs;
- };
-
-/* The size of the maximum gap between one aligned stack and the next. */
-# define YYSTACK_GAP_MAXIMUM (sizeof (union yyalloc) - 1)
-
-/* The size of an array large to enough to hold all stacks, each with
- N elements. */
-# define YYSTACK_BYTES(N) \
- ((N) * (sizeof (yytype_int16) + sizeof (YYSTYPE)) \
- + YYSTACK_GAP_MAXIMUM)
-
-/* Copy COUNT objects from FROM to TO. The source and destination do
- not overlap. */
-# ifndef YYCOPY
-# if defined __GNUC__ && 1 < __GNUC__
-# define YYCOPY(To, From, Count) \
- __builtin_memcpy (To, From, (Count) * sizeof (*(From)))
-# else
-# define YYCOPY(To, From, Count) \
- do \
- { \
- YYSIZE_T yyi; \
- for (yyi = 0; yyi < (Count); yyi++) \
- (To)[yyi] = (From)[yyi]; \
- } \
- while (YYID (0))
-# endif
-# endif
-
-/* Relocate STACK from its old location to the new one. The
- local variables YYSIZE and YYSTACKSIZE give the old and new number of
- elements in the stack, and YYPTR gives the new location of the
- stack. Advance YYPTR to a properly aligned location for the next
- stack. */
-# define YYSTACK_RELOCATE(Stack) \
- do \
- { \
- YYSIZE_T yynewbytes; \
- YYCOPY (&yyptr->Stack, Stack, yysize); \
- Stack = &yyptr->Stack; \
- yynewbytes = yystacksize * sizeof (*Stack) + YYSTACK_GAP_MAXIMUM; \
- yyptr += yynewbytes / sizeof (*yyptr); \
- } \
- while (YYID (0))
-
-#endif
-
-/* YYFINAL -- State number of the termination state. */
-#define YYFINAL 11
-/* YYLAST -- Last index in YYTABLE. */
-#define YYLAST 298
-
-/* YYNTOKENS -- Number of terminals. */
-#define YYNTOKENS 40
-/* YYNNTS -- Number of nonterminals. */
-#define YYNNTS 50
-/* YYNRULES -- Number of rules. */
-#define YYNRULES 122
-/* YYNRULES -- Number of states. */
-#define YYNSTATES 199
-
-/* YYTRANSLATE(YYLEX) -- Bison symbol number corresponding to YYLEX. */
-#define YYUNDEFTOK 2
-#define YYMAXUTOK 294
-
-#define YYTRANSLATE(YYX) \
- ((unsigned int) (YYX) <= YYMAXUTOK ? yytranslate[YYX] : YYUNDEFTOK)
-
-/* YYTRANSLATE[YYLEX] -- Bison symbol number corresponding to YYLEX. */
-static const yytype_uint8 yytranslate[] =
-{
- 0, 2, 2, 2, 2, 2, 2, 2, 2, 2,
- 2, 2, 2, 2, 2, 2, 2, 2, 2, 2,
- 2, 2, 2, 2, 2, 2, 2, 2, 2, 2,
- 2, 2, 2, 2, 2, 2, 2, 2, 2, 2,
- 2, 2, 2, 2, 2, 2, 2, 2, 2, 2,
- 2, 2, 2, 2, 2, 2, 2, 2, 2, 2,
- 2, 2, 2, 2, 2, 2, 2, 2, 2, 2,
- 2, 2, 2, 2, 2, 2, 2, 2, 2, 2,
- 2, 2, 2, 2, 2, 2, 2, 2, 2, 2,
- 2, 2, 2, 2, 2, 2, 2, 2, 2, 2,
- 2, 2, 2, 2, 2, 2, 2, 2, 2, 2,
- 2, 2, 2, 2, 2, 2, 2, 2, 2, 2,
- 2, 2, 2, 2, 2, 2, 2, 2, 2, 2,
- 2, 2, 2, 2, 2, 2, 2, 2, 2, 2,
- 2, 2, 2, 2, 2, 2, 2, 2, 2, 2,
- 2, 2, 2, 2, 2, 2, 2, 2, 2, 2,
- 2, 2, 2, 2, 2, 2, 2, 2, 2, 2,
- 2, 2, 2, 2, 2, 2, 2, 2, 2, 2,
- 2, 2, 2, 2, 2, 2, 2, 2, 2, 2,
- 2, 2, 2, 2, 2, 2, 2, 2, 2, 2,
- 2, 2, 2, 2, 2, 2, 2, 2, 2, 2,
- 2, 2, 2, 2, 2, 2, 2, 2, 2, 2,
- 2, 2, 2, 2, 2, 2, 2, 2, 2, 2,
- 2, 2, 2, 2, 2, 2, 2, 2, 2, 2,
- 2, 2, 2, 2, 2, 2, 2, 2, 2, 2,
- 2, 2, 2, 2, 2, 2, 1, 2, 3, 4,
- 5, 6, 7, 8, 9, 10, 11, 12, 13, 14,
- 15, 16, 17, 18, 19, 20, 21, 22, 23, 24,
- 25, 26, 27, 28, 29, 30, 31, 32, 33, 34,
- 35, 36, 37, 38, 39
-};
-
-#if YYDEBUG
-/* YYPRHS[YYN] -- Index of the first RHS symbol of rule number YYN in
- YYRHS. */
-static const yytype_uint16 yyprhs[] =
-{
- 0, 0, 3, 6, 8, 11, 13, 14, 17, 20,
- 23, 26, 31, 36, 40, 42, 44, 46, 48, 50,
- 52, 54, 56, 58, 60, 62, 64, 66, 68, 72,
- 75, 79, 82, 86, 89, 90, 93, 96, 99, 102,
- 105, 108, 112, 117, 122, 127, 133, 137, 138, 142,
- 143, 146, 150, 153, 155, 159, 160, 163, 166, 169,
- 172, 175, 180, 184, 187, 192, 193, 196, 200, 202,
- 206, 207, 210, 213, 216, 220, 224, 228, 230, 234,
- 235, 238, 241, 244, 248, 252, 255, 258, 261, 262,
- 265, 268, 271, 276, 277, 280, 283, 286, 287, 290,
- 292, 294, 297, 300, 303, 305, 308, 309, 312, 314,
- 318, 322, 326, 330, 334, 338, 342, 345, 349, 353,
- 355, 357, 358
-};
-
-/* YYRHS -- A `-1'-separated list of the rules' RHS. */
-static const yytype_int8 yyrhs[] =
-{
- 41, 0, -1, 85, 42, -1, 42, -1, 67, 43,
- -1, 43, -1, -1, 43, 45, -1, 43, 59, -1,
- 43, 71, -1, 43, 84, -1, 43, 26, 1, 35,
- -1, 43, 44, 1, 35, -1, 43, 1, 35, -1,
- 16, -1, 18, -1, 19, -1, 21, -1, 17, -1,
- 22, -1, 20, -1, 23, -1, 35, -1, 65, -1,
- 75, -1, 48, -1, 50, -1, 73, -1, 26, 1,
- 35, -1, 1, 35, -1, 10, 26, 35, -1, 47,
- 51, -1, 11, 26, 35, -1, 49, 51, -1, -1,
- 51, 52, -1, 51, 53, -1, 51, 79, -1, 51,
- 77, -1, 51, 46, -1, 51, 35, -1, 19, 82,
- 35, -1, 18, 83, 86, 35, -1, 20, 87, 86,
- 35, -1, 21, 26, 86, 35, -1, 22, 88, 88,
- 86, 35, -1, 24, 54, 35, -1, -1, 54, 26,
- 55, -1, -1, 38, 83, -1, 7, 89, 35, -1,
- 56, 60, -1, 84, -1, 57, 62, 58, -1, -1,
- 60, 61, -1, 60, 79, -1, 60, 77, -1, 60,
- 35, -1, 60, 46, -1, 18, 83, 86, 35, -1,
- 19, 82, 35, -1, 17, 35, -1, 20, 26, 86,
- 35, -1, -1, 62, 45, -1, 14, 87, 85, -1,
- 84, -1, 63, 66, 64, -1, -1, 66, 45, -1,
- 66, 71, -1, 66, 59, -1, 3, 83, 85, -1,
- 4, 83, 35, -1, 68, 80, 78, -1, 84, -1,
- 69, 72, 70, -1, -1, 72, 45, -1, 72, 71,
- -1, 72, 59, -1, 6, 83, 35, -1, 9, 83,
- 35, -1, 74, 78, -1, 12, 35, -1, 76, 13,
- -1, -1, 78, 79, -1, 78, 35, -1, 78, 46,
- -1, 16, 25, 87, 35, -1, -1, 80, 81, -1,
- 80, 35, -1, 23, 86, -1, -1, 83, 86, -1,
- 26, -1, 27, -1, 5, 35, -1, 8, 35, -1,
- 15, 35, -1, 35, -1, 85, 35, -1, -1, 14,
- 87, -1, 88, -1, 88, 29, 88, -1, 88, 30,
- 88, -1, 88, 31, 88, -1, 88, 32, 88, -1,
- 88, 38, 88, -1, 88, 28, 88, -1, 34, 87,
- 33, -1, 39, 87, -1, 87, 36, 87, -1, 87,
- 37, 87, -1, 26, -1, 27, -1, -1, 26, -1
-};
-
-/* YYRLINE[YYN] -- source line where rule number YYN was defined. */
-static const yytype_uint16 yyrline[] =
-{
- 0, 108, 108, 108, 110, 110, 112, 114, 115, 116,
- 117, 118, 119, 123, 127, 127, 127, 127, 127, 127,
- 127, 127, 131, 132, 133, 134, 135, 136, 140, 141,
- 147, 155, 161, 169, 179, 181, 182, 183, 184, 185,
- 186, 189, 197, 203, 213, 219, 225, 228, 230, 241,
- 242, 247, 256, 261, 269, 272, 274, 275, 276, 277,
- 278, 281, 287, 298, 304, 314, 316, 321, 329, 337,
- 340, 342, 343, 344, 349, 356, 363, 368, 376, 379,
- 381, 382, 383, 386, 394, 401, 408, 414, 421, 423,
- 424, 425, 428, 436, 438, 439, 442, 449, 451, 456,
- 457, 460, 461, 462, 466, 467, 470, 471, 474, 475,
- 476, 477, 478, 479, 480, 481, 482, 483, 484, 487,
- 488, 491, 492
-};
-#endif
-
-#if YYDEBUG || YYERROR_VERBOSE || YYTOKEN_TABLE
-/* YYTNAME[SYMBOL-NUM] -- String name of the symbol SYMBOL-NUM.
- First, the terminals, then, starting at YYNTOKENS, nonterminals. */
-static const char *const yytname[] =
-{
- "$end", "error", "$undefined", "T_MAINMENU", "T_MENU", "T_ENDMENU",
- "T_SOURCE", "T_CHOICE", "T_ENDCHOICE", "T_COMMENT", "T_CONFIG",
- "T_MENUCONFIG", "T_HELP", "T_HELPTEXT", "T_IF", "T_ENDIF", "T_DEPENDS",
- "T_OPTIONAL", "T_PROMPT", "T_TYPE", "T_DEFAULT", "T_SELECT", "T_RANGE",
- "T_VISIBLE", "T_OPTION", "T_ON", "T_WORD", "T_WORD_QUOTE", "T_UNEQUAL",
- "T_LESS", "T_LESS_EQUAL", "T_GREATER", "T_GREATER_EQUAL",
- "T_CLOSE_PAREN", "T_OPEN_PAREN", "T_EOL", "T_OR", "T_AND", "T_EQUAL",
- "T_NOT", "$accept", "input", "start", "stmt_list", "option_name",
- "common_stmt", "option_error", "config_entry_start", "config_stmt",
- "menuconfig_entry_start", "menuconfig_stmt", "config_option_list",
- "config_option", "symbol_option", "symbol_option_list",
- "symbol_option_arg", "choice", "choice_entry", "choice_end",
- "choice_stmt", "choice_option_list", "choice_option", "choice_block",
- "if_entry", "if_end", "if_stmt", "if_block", "mainmenu_stmt", "menu",
- "menu_entry", "menu_end", "menu_stmt", "menu_block", "source_stmt",
- "comment", "comment_stmt", "help_start", "help", "depends_list",
- "depends", "visibility_list", "visible", "prompt_stmt_opt", "prompt",
- "end", "nl", "if_expr", "expr", "symbol", "word_opt", 0
-};
-#endif
-
-# ifdef YYPRINT
-/* YYTOKNUM[YYLEX-NUM] -- Internal token number corresponding to
- token YYLEX-NUM. */
-static const yytype_uint16 yytoknum[] =
-{
- 0, 256, 257, 258, 259, 260, 261, 262, 263, 264,
- 265, 266, 267, 268, 269, 270, 271, 272, 273, 274,
- 275, 276, 277, 278, 279, 280, 281, 282, 283, 284,
- 285, 286, 287, 288, 289, 290, 291, 292, 293, 294
-};
-# endif
-
-/* YYR1[YYN] -- Symbol number of symbol that rule YYN derives. */
-static const yytype_uint8 yyr1[] =
-{
- 0, 40, 41, 41, 42, 42, 43, 43, 43, 43,
- 43, 43, 43, 43, 44, 44, 44, 44, 44, 44,
- 44, 44, 45, 45, 45, 45, 45, 45, 46, 46,
- 47, 48, 49, 50, 51, 51, 51, 51, 51, 51,
- 51, 52, 52, 52, 52, 52, 53, 54, 54, 55,
- 55, 56, 57, 58, 59, 60, 60, 60, 60, 60,
- 60, 61, 61, 61, 61, 62, 62, 63, 64, 65,
- 66, 66, 66, 66, 67, 68, 69, 70, 71, 72,
- 72, 72, 72, 73, 74, 75, 76, 77, 78, 78,
- 78, 78, 79, 80, 80, 80, 81, 82, 82, 83,
- 83, 84, 84, 84, 85, 85, 86, 86, 87, 87,
- 87, 87, 87, 87, 87, 87, 87, 87, 87, 88,
- 88, 89, 89
-};
-
-/* YYR2[YYN] -- Number of symbols composing right hand side of rule YYN. */
-static const yytype_uint8 yyr2[] =
-{
- 0, 2, 2, 1, 2, 1, 0, 2, 2, 2,
- 2, 4, 4, 3, 1, 1, 1, 1, 1, 1,
- 1, 1, 1, 1, 1, 1, 1, 1, 3, 2,
- 3, 2, 3, 2, 0, 2, 2, 2, 2, 2,
- 2, 3, 4, 4, 4, 5, 3, 0, 3, 0,
- 2, 3, 2, 1, 3, 0, 2, 2, 2, 2,
- 2, 4, 3, 2, 4, 0, 2, 3, 1, 3,
- 0, 2, 2, 2, 3, 3, 3, 1, 3, 0,
- 2, 2, 2, 3, 3, 2, 2, 2, 0, 2,
- 2, 2, 4, 0, 2, 2, 2, 0, 2, 1,
- 1, 2, 2, 2, 1, 2, 0, 2, 1, 3,
- 3, 3, 3, 3, 3, 3, 2, 3, 3, 1,
- 1, 0, 1
-};
-
-/* YYDEFACT[STATE-NAME] -- Default rule to reduce with in state
- STATE-NUM when YYTABLE doesn't specify something else to do. Zero
- means the default is an error. */
-static const yytype_uint8 yydefact[] =
-{
- 6, 0, 104, 0, 3, 0, 6, 6, 99, 100,
- 0, 1, 0, 0, 0, 0, 121, 0, 0, 0,
- 0, 0, 0, 14, 18, 15, 16, 20, 17, 19,
- 21, 0, 22, 0, 7, 34, 25, 34, 26, 55,
- 65, 8, 70, 23, 93, 79, 9, 27, 88, 24,
- 10, 0, 105, 2, 74, 13, 0, 101, 0, 122,
- 0, 102, 0, 0, 0, 119, 120, 0, 0, 0,
- 108, 103, 0, 0, 0, 0, 0, 0, 0, 88,
- 0, 0, 75, 83, 51, 84, 30, 32, 0, 116,
- 0, 0, 67, 0, 0, 0, 0, 0, 0, 11,
- 12, 0, 0, 0, 0, 97, 0, 0, 0, 47,
- 0, 40, 39, 35, 36, 0, 38, 37, 0, 0,
- 97, 0, 59, 60, 56, 58, 57, 66, 54, 53,
- 71, 73, 69, 72, 68, 106, 95, 0, 94, 80,
- 82, 78, 81, 77, 90, 91, 89, 115, 117, 118,
- 114, 109, 110, 111, 112, 113, 29, 86, 0, 106,
- 0, 106, 106, 106, 0, 0, 0, 87, 63, 106,
- 0, 106, 0, 96, 0, 0, 41, 98, 0, 0,
- 106, 49, 46, 28, 0, 62, 0, 107, 92, 42,
- 43, 44, 0, 0, 48, 61, 64, 45, 50
-};
-
-/* YYDEFGOTO[NTERM-NUM]. */
-static const yytype_int16 yydefgoto[] =
-{
- -1, 3, 4, 5, 33, 34, 112, 35, 36, 37,
- 38, 74, 113, 114, 165, 194, 39, 40, 128, 41,
- 76, 124, 77, 42, 132, 43, 78, 6, 44, 45,
- 141, 46, 80, 47, 48, 49, 115, 116, 81, 117,
- 79, 138, 160, 161, 50, 7, 173, 69, 70, 60
-};
-
-/* YYPACT[STATE-NUM] -- Index in YYTABLE of the portion describing
- STATE-NUM. */
-#define YYPACT_NINF -91
-static const yytype_int16 yypact[] =
-{
- 19, 37, -91, 13, -91, 79, -91, 20, -91, -91,
- -16, -91, 21, 37, 25, 37, 41, 36, 37, 78,
- 83, 31, 56, -91, -91, -91, -91, -91, -91, -91,
- -91, 116, -91, 127, -91, -91, -91, -91, -91, -91,
- -91, -91, -91, -91, -91, -91, -91, -91, -91, -91,
- -91, 147, -91, -91, 105, -91, 109, -91, 111, -91,
- 114, -91, 136, 137, 142, -91, -91, 31, 31, 76,
- 254, -91, 143, 146, 27, 115, 207, 258, 243, -14,
- 243, 179, -91, -91, -91, -91, -91, -91, -7, -91,
- 31, 31, 105, 51, 51, 51, 51, 51, 51, -91,
- -91, 156, 168, 181, 37, 37, 31, 178, 51, -91,
- 206, -91, -91, -91, -91, 196, -91, -91, 175, 37,
- 37, 185, -91, -91, -91, -91, -91, -91, -91, -91,
- -91, -91, -91, -91, -91, 214, -91, 230, -91, -91,
- -91, -91, -91, -91, -91, -91, -91, -91, 183, -91,
- -91, -91, -91, -91, -91, -91, -91, -91, 31, 214,
- 194, 214, 45, 214, 51, 26, 195, -91, -91, 214,
- 197, 214, 31, -91, 139, 208, -91, -91, 220, 224,
- 214, 222, -91, -91, 226, -91, 227, 123, -91, -91,
- -91, -91, 235, 37, -91, -91, -91, -91, -91
-};
-
-/* YYPGOTO[NTERM-NUM]. */
-static const yytype_int16 yypgoto[] =
-{
- -91, -91, 264, 268, -91, 30, -65, -91, -91, -91,
- -91, 238, -91, -91, -91, -91, -91, -91, -91, -12,
- -91, -91, -91, -91, -91, -91, -91, -91, -91, -91,
- -91, -5, -91, -91, -91, -91, -91, 200, 209, -61,
- -91, -91, 170, -1, 65, 0, 118, -66, -90, -91
-};
-
-/* YYTABLE[YYPACT[STATE-NUM]]. What to do in state STATE-NUM. If
- positive, shift that token. If negative, reduce the rule which
- number is the opposite. If zero, do what YYDEFACT says.
- If YYTABLE_NINF, syntax error. */
-#define YYTABLE_NINF -86
-static const yytype_int16 yytable[] =
-{
- 10, 88, 89, 150, 151, 152, 153, 154, 155, 135,
- 54, 123, 56, 11, 58, 126, 145, 62, 164, 2,
- 146, 136, 1, 1, 148, 149, 147, -31, 101, 90,
- 91, -31, -31, -31, -31, -31, -31, -31, -31, 102,
- 162, -31, -31, 103, -31, 104, 105, 106, 107, 108,
- -31, 109, 181, 110, 2, 52, 55, 65, 66, 172,
- 57, 182, 111, 8, 9, 67, 131, 59, 140, 92,
- 68, 61, 145, 133, 180, 142, 146, 65, 66, -5,
- 12, 90, 91, 13, 14, 15, 16, 17, 18, 19,
- 20, 71, 174, 21, 22, 23, 24, 25, 26, 27,
- 28, 29, 30, 159, 63, 31, 187, 127, 130, 64,
- 139, 2, 90, 91, 32, -33, 101, 72, 169, -33,
- -33, -33, -33, -33, -33, -33, -33, 102, 73, -33,
- -33, 103, -33, 104, 105, 106, 107, 108, -33, 109,
- 52, 110, 129, 134, 82, 143, 83, -4, 12, 84,
- 111, 13, 14, 15, 16, 17, 18, 19, 20, 90,
- 91, 21, 22, 23, 24, 25, 26, 27, 28, 29,
- 30, 85, 86, 31, 188, 90, 91, 87, 99, -85,
- 101, 100, 32, -85, -85, -85, -85, -85, -85, -85,
- -85, 156, 198, -85, -85, 103, -85, -85, -85, -85,
- -85, -85, -85, 157, 163, 110, 158, 166, 101, 167,
- 168, 171, -52, -52, 144, -52, -52, -52, -52, 102,
- 91, -52, -52, 103, 118, 119, 120, 121, 172, 176,
- 183, 101, 185, 110, -76, -76, -76, -76, -76, -76,
- -76, -76, 122, 189, -76, -76, 103, 13, 14, 15,
- 16, 17, 18, 19, 20, 190, 110, 21, 22, 191,
- 193, 195, 196, 14, 15, 144, 17, 18, 19, 20,
- 197, 53, 21, 22, 51, 75, 125, 175, 32, 177,
- 178, 179, 93, 94, 95, 96, 97, 184, 137, 186,
- 170, 0, 98, 32, 0, 0, 0, 0, 192
-};
-
-static const yytype_int16 yycheck[] =
-{
- 1, 67, 68, 93, 94, 95, 96, 97, 98, 23,
- 10, 76, 13, 0, 15, 76, 81, 18, 108, 35,
- 81, 35, 3, 3, 90, 91, 33, 0, 1, 36,
- 37, 4, 5, 6, 7, 8, 9, 10, 11, 12,
- 106, 14, 15, 16, 17, 18, 19, 20, 21, 22,
- 23, 24, 26, 26, 35, 35, 35, 26, 27, 14,
- 35, 35, 35, 26, 27, 34, 78, 26, 80, 69,
- 39, 35, 137, 78, 164, 80, 137, 26, 27, 0,
- 1, 36, 37, 4, 5, 6, 7, 8, 9, 10,
- 11, 35, 158, 14, 15, 16, 17, 18, 19, 20,
- 21, 22, 23, 104, 26, 26, 172, 77, 78, 26,
- 80, 35, 36, 37, 35, 0, 1, 1, 119, 4,
- 5, 6, 7, 8, 9, 10, 11, 12, 1, 14,
- 15, 16, 17, 18, 19, 20, 21, 22, 23, 24,
- 35, 26, 77, 78, 35, 80, 35, 0, 1, 35,
- 35, 4, 5, 6, 7, 8, 9, 10, 11, 36,
- 37, 14, 15, 16, 17, 18, 19, 20, 21, 22,
- 23, 35, 35, 26, 35, 36, 37, 35, 35, 0,
- 1, 35, 35, 4, 5, 6, 7, 8, 9, 10,
- 11, 35, 193, 14, 15, 16, 17, 18, 19, 20,
- 21, 22, 23, 35, 26, 26, 25, 1, 1, 13,
- 35, 26, 5, 6, 35, 8, 9, 10, 11, 12,
- 37, 14, 15, 16, 17, 18, 19, 20, 14, 35,
- 35, 1, 35, 26, 4, 5, 6, 7, 8, 9,
- 10, 11, 35, 35, 14, 15, 16, 4, 5, 6,
- 7, 8, 9, 10, 11, 35, 26, 14, 15, 35,
- 38, 35, 35, 5, 6, 35, 8, 9, 10, 11,
- 35, 7, 14, 15, 6, 37, 76, 159, 35, 161,
- 162, 163, 28, 29, 30, 31, 32, 169, 79, 171,
- 120, -1, 38, 35, -1, -1, -1, -1, 180
-};
-
-/* YYSTOS[STATE-NUM] -- The (internal number of the) accessing
- symbol of state STATE-NUM. */
-static const yytype_uint8 yystos[] =
-{
- 0, 3, 35, 41, 42, 43, 67, 85, 26, 27,
- 83, 0, 1, 4, 5, 6, 7, 8, 9, 10,
- 11, 14, 15, 16, 17, 18, 19, 20, 21, 22,
- 23, 26, 35, 44, 45, 47, 48, 49, 50, 56,
- 57, 59, 63, 65, 68, 69, 71, 73, 74, 75,
- 84, 43, 35, 42, 85, 35, 83, 35, 83, 26,
- 89, 35, 83, 26, 26, 26, 27, 34, 39, 87,
- 88, 35, 1, 1, 51, 51, 60, 62, 66, 80,
- 72, 78, 35, 35, 35, 35, 35, 35, 87, 87,
- 36, 37, 85, 28, 29, 30, 31, 32, 38, 35,
- 35, 1, 12, 16, 18, 19, 20, 21, 22, 24,
- 26, 35, 46, 52, 53, 76, 77, 79, 17, 18,
- 19, 20, 35, 46, 61, 77, 79, 45, 58, 84,
- 45, 59, 64, 71, 84, 23, 35, 78, 81, 45,
- 59, 70, 71, 84, 35, 46, 79, 33, 87, 87,
- 88, 88, 88, 88, 88, 88, 35, 35, 25, 83,
- 82, 83, 87, 26, 88, 54, 1, 13, 35, 83,
- 82, 26, 14, 86, 87, 86, 35, 86, 86, 86,
- 88, 26, 35, 35, 86, 35, 86, 87, 35, 35,
- 35, 35, 86, 38, 55, 35, 35, 35, 83
-};
-
-#define yyerrok (yyerrstatus = 0)
-#define yyclearin (yychar = YYEMPTY)
-#define YYEMPTY (-2)
-#define YYEOF 0
-
-#define YYACCEPT goto yyacceptlab
-#define YYABORT goto yyabortlab
-#define YYERROR goto yyerrorlab
-
-
-/* Like YYERROR except do call yyerror. This remains here temporarily
- to ease the transition to the new meaning of YYERROR, for GCC.
- Once GCC version 2 has supplanted version 1, this can go. */
-
-#define YYFAIL goto yyerrlab
-
-#define YYRECOVERING() (!!yyerrstatus)
-
-#define YYBACKUP(Token, Value) \
-do \
- if (yychar == YYEMPTY && yylen == 1) \
- { \
- yychar = (Token); \
- yylval = (Value); \
- yytoken = YYTRANSLATE (yychar); \
- YYPOPSTACK (1); \
- goto yybackup; \
- } \
- else \
- { \
- yyerror (YY_("syntax error: cannot back up")); \
- YYERROR; \
- } \
-while (YYID (0))
-
-
-#define YYTERROR 1
-#define YYERRCODE 256
-
-
-/* YYLLOC_DEFAULT -- Set CURRENT to span from RHS[1] to RHS[N].
- If N is 0, then set CURRENT to the empty location which ends
- the previous symbol: RHS[0] (always defined). */
-
-#define YYRHSLOC(Rhs, K) ((Rhs)[K])
-#ifndef YYLLOC_DEFAULT
-# define YYLLOC_DEFAULT(Current, Rhs, N) \
- do \
- if (YYID (N)) \
- { \
- (Current).first_line = YYRHSLOC (Rhs, 1).first_line; \
- (Current).first_column = YYRHSLOC (Rhs, 1).first_column; \
- (Current).last_line = YYRHSLOC (Rhs, N).last_line; \
- (Current).last_column = YYRHSLOC (Rhs, N).last_column; \
- } \
- else \
- { \
- (Current).first_line = (Current).last_line = \
- YYRHSLOC (Rhs, 0).last_line; \
- (Current).first_column = (Current).last_column = \
- YYRHSLOC (Rhs, 0).last_column; \
- } \
- while (YYID (0))
-#endif
-
-
-/* YY_LOCATION_PRINT -- Print the location on the stream.
- This macro was not mandated originally: define only if we know
- we won't break user code: when these are the locations we know. */
-
-#ifndef YY_LOCATION_PRINT
-# if defined YYLTYPE_IS_TRIVIAL && YYLTYPE_IS_TRIVIAL
-# define YY_LOCATION_PRINT(File, Loc) \
- fprintf (File, "%d.%d-%d.%d", \
- (Loc).first_line, (Loc).first_column, \
- (Loc).last_line, (Loc).last_column)
-# else
-# define YY_LOCATION_PRINT(File, Loc) ((void) 0)
-# endif
-#endif
-
-
-/* YYLEX -- calling `yylex' with the right arguments. */
-
-#ifdef YYLEX_PARAM
-# define YYLEX yylex (YYLEX_PARAM)
-#else
-# define YYLEX yylex ()
-#endif
-
-/* Enable debugging if requested. */
-#if YYDEBUG
-
-# ifndef YYFPRINTF
-# include <stdio.h> /* INFRINGES ON USER NAME SPACE */
-# define YYFPRINTF fprintf
-# endif
-
-# define YYDPRINTF(Args) \
-do { \
- if (yydebug) \
- YYFPRINTF Args; \
-} while (YYID (0))
-
-# define YY_SYMBOL_PRINT(Title, Type, Value, Location) \
-do { \
- if (yydebug) \
- { \
- YYFPRINTF (stderr, "%s ", Title); \
- yy_symbol_print (stderr, \
- Type, Value); \
- YYFPRINTF (stderr, "\n"); \
- } \
-} while (YYID (0))
-
-
-/*--------------------------------.
-| Print this symbol on YYOUTPUT. |
-`--------------------------------*/
-
-/*ARGSUSED*/
-#if (defined __STDC__ || defined __C99__FUNC__ \
- || defined __cplusplus || defined _MSC_VER)
-static void
-yy_symbol_value_print (FILE *yyoutput, int yytype, YYSTYPE const * const yyvaluep)
-#else
-static void
-yy_symbol_value_print (yyoutput, yytype, yyvaluep)
- FILE *yyoutput;
- int yytype;
- YYSTYPE const * const yyvaluep;
-#endif
-{
- if (!yyvaluep)
- return;
-# ifdef YYPRINT
- if (yytype < YYNTOKENS)
- YYPRINT (yyoutput, yytoknum[yytype], *yyvaluep);
-# else
- YYUSE (yyoutput);
-# endif
- switch (yytype)
- {
- default:
- break;
- }
-}
-
-
-/*--------------------------------.
-| Print this symbol on YYOUTPUT. |
-`--------------------------------*/
-
-#if (defined __STDC__ || defined __C99__FUNC__ \
- || defined __cplusplus || defined _MSC_VER)
-static void
-yy_symbol_print (FILE *yyoutput, int yytype, YYSTYPE const * const yyvaluep)
-#else
-static void
-yy_symbol_print (yyoutput, yytype, yyvaluep)
- FILE *yyoutput;
- int yytype;
- YYSTYPE const * const yyvaluep;
-#endif
-{
- if (yytype < YYNTOKENS)
- YYFPRINTF (yyoutput, "token %s (", yytname[yytype]);
- else
- YYFPRINTF (yyoutput, "nterm %s (", yytname[yytype]);
-
- yy_symbol_value_print (yyoutput, yytype, yyvaluep);
- YYFPRINTF (yyoutput, ")");
-}
-
-/*------------------------------------------------------------------.
-| yy_stack_print -- Print the state stack from its BOTTOM up to its |
-| TOP (included). |
-`------------------------------------------------------------------*/
-
-#if (defined __STDC__ || defined __C99__FUNC__ \
- || defined __cplusplus || defined _MSC_VER)
-static void
-yy_stack_print (yytype_int16 *bottom, yytype_int16 *top)
-#else
-static void
-yy_stack_print (bottom, top)
- yytype_int16 *bottom;
- yytype_int16 *top;
-#endif
-{
- YYFPRINTF (stderr, "Stack now");
- for (; bottom <= top; ++bottom)
- YYFPRINTF (stderr, " %d", *bottom);
- YYFPRINTF (stderr, "\n");
-}
-
-# define YY_STACK_PRINT(Bottom, Top) \
-do { \
- if (yydebug) \
- yy_stack_print ((Bottom), (Top)); \
-} while (YYID (0))
-
-
-/*------------------------------------------------.
-| Report that the YYRULE is going to be reduced. |
-`------------------------------------------------*/
-
-#if (defined __STDC__ || defined __C99__FUNC__ \
- || defined __cplusplus || defined _MSC_VER)
-static void
-yy_reduce_print (YYSTYPE *yyvsp, int yyrule)
-#else
-static void
-yy_reduce_print (yyvsp, yyrule)
- YYSTYPE *yyvsp;
- int yyrule;
-#endif
-{
- int yynrhs = yyr2[yyrule];
- int yyi;
- unsigned long int yylno = yyrline[yyrule];
- YYFPRINTF (stderr, "Reducing stack by rule %d (line %lu):\n",
- yyrule - 1, yylno);
- /* The symbols being reduced. */
- for (yyi = 0; yyi < yynrhs; yyi++)
- {
- fprintf (stderr, " $%d = ", yyi + 1);
- yy_symbol_print (stderr, yyrhs[yyprhs[yyrule] + yyi],
- &(yyvsp[(yyi + 1) - (yynrhs)])
- );
- fprintf (stderr, "\n");
- }
-}
-
-# define YY_REDUCE_PRINT(Rule) \
-do { \
- if (yydebug) \
- yy_reduce_print (yyvsp, Rule); \
-} while (YYID (0))
-
-/* Nonzero means print parse trace. It is left uninitialized so that
- multiple parsers can coexist. */
-int yydebug;
-#else /* !YYDEBUG */
-# define YYDPRINTF(Args)
-# define YY_SYMBOL_PRINT(Title, Type, Value, Location)
-# define YY_STACK_PRINT(Bottom, Top)
-# define YY_REDUCE_PRINT(Rule)
-#endif /* !YYDEBUG */
-
-
-/* YYINITDEPTH -- initial size of the parser's stacks. */
-#ifndef YYINITDEPTH
-# define YYINITDEPTH 200
-#endif
-
-/* YYMAXDEPTH -- maximum size the stacks can grow to (effective only
- if the built-in stack extension method is used).
-
- Do not make this value too large; the results are undefined if
- YYSTACK_ALLOC_MAXIMUM < YYSTACK_BYTES (YYMAXDEPTH)
- evaluated with infinite-precision integer arithmetic. */
-
-#ifndef YYMAXDEPTH
-# define YYMAXDEPTH 10000
-#endif
-
-\f
-
-#if YYERROR_VERBOSE
-
-# ifndef yystrlen
-# if defined __GLIBC__ && defined _STRING_H
-# define yystrlen strlen
-# else
-/* Return the length of YYSTR. */
-#if (defined __STDC__ || defined __C99__FUNC__ \
- || defined __cplusplus || defined _MSC_VER)
-static YYSIZE_T
-yystrlen (const char *yystr)
-#else
-static YYSIZE_T
-yystrlen (yystr)
- const char *yystr;
-#endif
-{
- YYSIZE_T yylen;
- for (yylen = 0; yystr[yylen]; yylen++)
- continue;
- return yylen;
-}
-# endif
-# endif
-
-# ifndef yystpcpy
-# if defined __GLIBC__ && defined _STRING_H && defined _GNU_SOURCE
-# define yystpcpy stpcpy
-# else
-/* Copy YYSRC to YYDEST, returning the address of the terminating '\0' in
- YYDEST. */
-#if (defined __STDC__ || defined __C99__FUNC__ \
- || defined __cplusplus || defined _MSC_VER)
-static char *
-yystpcpy (char *yydest, const char *yysrc)
-#else
-static char *
-yystpcpy (yydest, yysrc)
- char *yydest;
- const char *yysrc;
-#endif
-{
- char *yyd = yydest;
- const char *yys = yysrc;
-
- while ((*yyd++ = *yys++) != '\0')
- continue;
-
- return yyd - 1;
-}
-# endif
-# endif
-
-# ifndef yytnamerr
-/* Copy to YYRES the contents of YYSTR after stripping away unnecessary
- quotes and backslashes, so that it's suitable for yyerror. The
- heuristic is that double-quoting is unnecessary unless the string
- contains an apostrophe, a comma, or backslash (other than
- backslash-backslash). YYSTR is taken from yytname. If YYRES is
- null, do not copy; instead, return the length of what the result
- would have been. */
-static YYSIZE_T
-yytnamerr (char *yyres, const char *yystr)
-{
- if (*yystr == '"')
- {
- YYSIZE_T yyn = 0;
- char const *yyp = yystr;
-
- for (;;)
- switch (*++yyp)
- {
- case '\'':
- case ',':
- goto do_not_strip_quotes;
-
- case '\\':
- if (*++yyp != '\\')
- goto do_not_strip_quotes;
- /* Fall through. */
- default:
- if (yyres)
- yyres[yyn] = *yyp;
- yyn++;
- break;
-
- case '"':
- if (yyres)
- yyres[yyn] = '\0';
- return yyn;
- }
- do_not_strip_quotes: ;
- }
-
- if (! yyres)
- return yystrlen (yystr);
-
- return yystpcpy (yyres, yystr) - yyres;
-}
-# endif
-
-/* Copy into YYRESULT an error message about the unexpected token
- YYCHAR while in state YYSTATE. Return the number of bytes copied,
- including the terminating null byte. If YYRESULT is null, do not
- copy anything; just return the number of bytes that would be
- copied. As a special case, return 0 if an ordinary "syntax error"
- message will do. Return YYSIZE_MAXIMUM if overflow occurs during
- size calculation. */
-static YYSIZE_T
-yysyntax_error (char *yyresult, int yystate, int yychar)
-{
- int yyn = yypact[yystate];
-
- if (! (YYPACT_NINF < yyn && yyn <= YYLAST))
- return 0;
- else
- {
- int yytype = YYTRANSLATE (yychar);
- YYSIZE_T yysize0 = yytnamerr (0, yytname[yytype]);
- YYSIZE_T yysize = yysize0;
- YYSIZE_T yysize1;
- int yysize_overflow = 0;
- enum { YYERROR_VERBOSE_ARGS_MAXIMUM = 5 };
- char const *yyarg[YYERROR_VERBOSE_ARGS_MAXIMUM];
- int yyx;
-
-# if 0
- /* This is so xgettext sees the translatable formats that are
- constructed on the fly. */
- YY_("syntax error, unexpected %s");
- YY_("syntax error, unexpected %s, expecting %s");
- YY_("syntax error, unexpected %s, expecting %s or %s");
- YY_("syntax error, unexpected %s, expecting %s or %s or %s");
- YY_("syntax error, unexpected %s, expecting %s or %s or %s or %s");
-# endif
- char *yyfmt;
- char const *yyf;
- static char const yyunexpected[] = "syntax error, unexpected %s";
- static char const yyexpecting[] = ", expecting %s";
- static char const yyor[] = " or %s";
- char yyformat[sizeof yyunexpected
- + sizeof yyexpecting - 1
- + ((YYERROR_VERBOSE_ARGS_MAXIMUM - 2)
- * (sizeof yyor - 1))];
- char const *yyprefix = yyexpecting;
-
- /* Start YYX at -YYN if negative to avoid negative indexes in
- YYCHECK. */
- int yyxbegin = yyn < 0 ? -yyn : 0;
-
- /* Stay within bounds of both yycheck and yytname. */
- int yychecklim = YYLAST - yyn + 1;
- int yyxend = yychecklim < YYNTOKENS ? yychecklim : YYNTOKENS;
- int yycount = 1;
-
- yyarg[0] = yytname[yytype];
- yyfmt = yystpcpy (yyformat, yyunexpected);
-
- for (yyx = yyxbegin; yyx < yyxend; ++yyx)
- if (yycheck[yyx + yyn] == yyx && yyx != YYTERROR)
- {
- if (yycount == YYERROR_VERBOSE_ARGS_MAXIMUM)
- {
- yycount = 1;
- yysize = yysize0;
- yyformat[sizeof yyunexpected - 1] = '\0';
- break;
- }
- yyarg[yycount++] = yytname[yyx];
- yysize1 = yysize + yytnamerr (0, yytname[yyx]);
- yysize_overflow |= (yysize1 < yysize);
- yysize = yysize1;
- yyfmt = yystpcpy (yyfmt, yyprefix);
- yyprefix = yyor;
- }
-
- yyf = YY_(yyformat);
- yysize1 = yysize + yystrlen (yyf);
- yysize_overflow |= (yysize1 < yysize);
- yysize = yysize1;
-
- if (yysize_overflow)
- return YYSIZE_MAXIMUM;
-
- if (yyresult)
- {
- /* Avoid sprintf, as that infringes on the user's name space.
- Don't have undefined behavior even if the translation
- produced a string with the wrong number of "%s"s. */
- char *yyp = yyresult;
- int yyi = 0;
- while ((*yyp = *yyf) != '\0')
- {
- if (*yyp == '%' && yyf[1] == 's' && yyi < yycount)
- {
- yyp += yytnamerr (yyp, yyarg[yyi++]);
- yyf += 2;
- }
- else
- {
- yyp++;
- yyf++;
- }
- }
- }
- return yysize;
- }
-}
-#endif /* YYERROR_VERBOSE */
-\f
-
-/*-----------------------------------------------.
-| Release the memory associated to this symbol. |
-`-----------------------------------------------*/
-
-/*ARGSUSED*/
-#if (defined __STDC__ || defined __C99__FUNC__ \
- || defined __cplusplus || defined _MSC_VER)
-static void
-yydestruct (const char *yymsg, int yytype, YYSTYPE *yyvaluep)
-#else
-static void
-yydestruct (yymsg, yytype, yyvaluep)
- const char *yymsg;
- int yytype;
- YYSTYPE *yyvaluep;
-#endif
-{
- YYUSE (yyvaluep);
-
- if (!yymsg)
- yymsg = "Deleting";
- YY_SYMBOL_PRINT (yymsg, yytype, yyvaluep, yylocationp);
-
- switch (yytype)
- {
- case 57: /* "choice_entry" */
-
- {
- fprintf(stderr, "%s:%d: missing end statement for this entry\n",
- (yyvaluep->menu)->file->name, (yyvaluep->menu)->lineno);
- if (current_menu == (yyvaluep->menu))
- menu_end_menu();
-};
-
- break;
- case 63: /* "if_entry" */
-
- {
- fprintf(stderr, "%s:%d: missing end statement for this entry\n",
- (yyvaluep->menu)->file->name, (yyvaluep->menu)->lineno);
- if (current_menu == (yyvaluep->menu))
- menu_end_menu();
-};
-
- break;
- case 69: /* "menu_entry" */
-
- {
- fprintf(stderr, "%s:%d: missing end statement for this entry\n",
- (yyvaluep->menu)->file->name, (yyvaluep->menu)->lineno);
- if (current_menu == (yyvaluep->menu))
- menu_end_menu();
-};
-
- break;
-
- default:
- break;
- }
-}
-\f
-
-/* Prevent warnings from -Wmissing-prototypes. */
-
-#ifdef YYPARSE_PARAM
-#if defined __STDC__ || defined __cplusplus
-int yyparse (void *YYPARSE_PARAM);
-#else
-int yyparse ();
-#endif
-#else /* ! YYPARSE_PARAM */
-#if defined __STDC__ || defined __cplusplus
-int yyparse (void);
-#else
-int yyparse ();
-#endif
-#endif /* ! YYPARSE_PARAM */
-
-
-
-/* The look-ahead symbol. */
-int yychar;
-
-/* The semantic value of the look-ahead symbol. */
-YYSTYPE yylval;
-
-/* Number of syntax errors so far. */
-int yynerrs;
-
-
-
-/*----------.
-| yyparse. |
-`----------*/
-
-#ifdef YYPARSE_PARAM
-#if (defined __STDC__ || defined __C99__FUNC__ \
- || defined __cplusplus || defined _MSC_VER)
-int
-yyparse (void *YYPARSE_PARAM)
-#else
-int
-yyparse (YYPARSE_PARAM)
- void *YYPARSE_PARAM;
-#endif
-#else /* ! YYPARSE_PARAM */
-#if (defined __STDC__ || defined __C99__FUNC__ \
- || defined __cplusplus || defined _MSC_VER)
-int
-yyparse (void)
-#else
-int
-yyparse ()
-
-#endif
-#endif
-{
-
- int yystate;
- int yyn;
- int yyresult;
- /* Number of tokens to shift before error messages enabled. */
- int yyerrstatus;
- /* Look-ahead token as an internal (translated) token number. */
- int yytoken = 0;
-#if YYERROR_VERBOSE
- /* Buffer for error messages, and its allocated size. */
- char yymsgbuf[128];
- char *yymsg = yymsgbuf;
- YYSIZE_T yymsg_alloc = sizeof yymsgbuf;
-#endif
-
- /* Three stacks and their tools:
- `yyss': related to states,
- `yyvs': related to semantic values,
- `yyls': related to locations.
-
- Refer to the stacks thru separate pointers, to allow yyoverflow
- to reallocate them elsewhere. */
-
- /* The state stack. */
- yytype_int16 yyssa[YYINITDEPTH];
- yytype_int16 *yyss = yyssa;
- yytype_int16 *yyssp;
-
- /* The semantic value stack. */
- YYSTYPE yyvsa[YYINITDEPTH];
- YYSTYPE *yyvs = yyvsa;
- YYSTYPE *yyvsp;
-
-
-
-#define YYPOPSTACK(N) (yyvsp -= (N), yyssp -= (N))
-
- YYSIZE_T yystacksize = YYINITDEPTH;
-
- /* The variables used to return semantic value and location from the
- action routines. */
- YYSTYPE yyval;
-
-
- /* The number of symbols on the RHS of the reduced rule.
- Keep to zero when no symbol should be popped. */
- int yylen = 0;
-
- YYDPRINTF ((stderr, "Starting parse\n"));
-
- yystate = 0;
- yyerrstatus = 0;
- yynerrs = 0;
- yychar = YYEMPTY; /* Cause a token to be read. */
-
- /* Initialize stack pointers.
- Waste one element of value and location stack
- so that they stay on the same level as the state stack.
- The wasted elements are never initialized. */
-
- yyssp = yyss;
- yyvsp = yyvs;
-
- goto yysetstate;
-
-/*------------------------------------------------------------.
-| yynewstate -- Push a new state, which is found in yystate. |
-`------------------------------------------------------------*/
- yynewstate:
- /* In all cases, when you get here, the value and location stacks
- have just been pushed. So pushing a state here evens the stacks. */
- yyssp++;
-
- yysetstate:
- *yyssp = yystate;
-
- if (yyss + yystacksize - 1 <= yyssp)
- {
- /* Get the current used size of the three stacks, in elements. */
- YYSIZE_T yysize = yyssp - yyss + 1;
-
-#ifdef yyoverflow
- {
- /* Give user a chance to reallocate the stack. Use copies of
- these so that the &'s don't force the real ones into
- memory. */
- YYSTYPE *yyvs1 = yyvs;
- yytype_int16 *yyss1 = yyss;
-
-
- /* Each stack pointer address is followed by the size of the
- data in use in that stack, in bytes. This used to be a
- conditional around just the two extra args, but that might
- be undefined if yyoverflow is a macro. */
- yyoverflow (YY_("memory exhausted"),
- &yyss1, yysize * sizeof (*yyssp),
- &yyvs1, yysize * sizeof (*yyvsp),
-
- &yystacksize);
-
- yyss = yyss1;
- yyvs = yyvs1;
- }
-#else /* no yyoverflow */
-# ifndef YYSTACK_RELOCATE
- goto yyexhaustedlab;
-# else
- /* Extend the stack our own way. */
- if (YYMAXDEPTH <= yystacksize)
- goto yyexhaustedlab;
- yystacksize *= 2;
- if (YYMAXDEPTH < yystacksize)
- yystacksize = YYMAXDEPTH;
-
- {
- yytype_int16 *yyss1 = yyss;
- union yyalloc *yyptr =
- (union yyalloc *) YYSTACK_ALLOC (YYSTACK_BYTES (yystacksize));
- if (! yyptr)
- goto yyexhaustedlab;
- YYSTACK_RELOCATE (yyss);
- YYSTACK_RELOCATE (yyvs);
-
-# undef YYSTACK_RELOCATE
- if (yyss1 != yyssa)
- YYSTACK_FREE (yyss1);
- }
-# endif
-#endif /* no yyoverflow */
-
- yyssp = yyss + yysize - 1;
- yyvsp = yyvs + yysize - 1;
-
-
- YYDPRINTF ((stderr, "Stack size increased to %lu\n",
- (unsigned long int) yystacksize));
-
- if (yyss + yystacksize - 1 <= yyssp)
- YYABORT;
- }
-
- YYDPRINTF ((stderr, "Entering state %d\n", yystate));
-
- goto yybackup;
-
-/*-----------.
-| yybackup. |
-`-----------*/
-yybackup:
-
- /* Do appropriate processing given the current state. Read a
- look-ahead token if we need one and don't already have one. */
-
- /* First try to decide what to do without reference to look-ahead token. */
- yyn = yypact[yystate];
- if (yyn == YYPACT_NINF)
- goto yydefault;
-
- /* Not known => get a look-ahead token if don't already have one. */
-
- /* YYCHAR is either YYEMPTY or YYEOF or a valid look-ahead symbol. */
- if (yychar == YYEMPTY)
- {
- YYDPRINTF ((stderr, "Reading a token: "));
- yychar = YYLEX;
- }
-
- if (yychar <= YYEOF)
- {
- yychar = yytoken = YYEOF;
- YYDPRINTF ((stderr, "Now at end of input.\n"));
- }
- else
- {
- yytoken = YYTRANSLATE (yychar);
- YY_SYMBOL_PRINT ("Next token is", yytoken, &yylval, &yylloc);
- }
-
- /* If the proper action on seeing token YYTOKEN is to reduce or to
- detect an error, take that action. */
- yyn += yytoken;
- if (yyn < 0 || YYLAST < yyn || yycheck[yyn] != yytoken)
- goto yydefault;
- yyn = yytable[yyn];
- if (yyn <= 0)
- {
- if (yyn == 0 || yyn == YYTABLE_NINF)
- goto yyerrlab;
- yyn = -yyn;
- goto yyreduce;
- }
-
- if (yyn == YYFINAL)
- YYACCEPT;
-
- /* Count tokens shifted since error; after three, turn off error
- status. */
- if (yyerrstatus)
- yyerrstatus--;
-
- /* Shift the look-ahead token. */
- YY_SYMBOL_PRINT ("Shifting", yytoken, &yylval, &yylloc);
-
- /* Discard the shifted token unless it is eof. */
- if (yychar != YYEOF)
- yychar = YYEMPTY;
-
- yystate = yyn;
- *++yyvsp = yylval;
-
- goto yynewstate;
-
-
-/*-----------------------------------------------------------.
-| yydefault -- do the default action for the current state. |
-`-----------------------------------------------------------*/
-yydefault:
- yyn = yydefact[yystate];
- if (yyn == 0)
- goto yyerrlab;
- goto yyreduce;
-
-
-/*-----------------------------.
-| yyreduce -- Do a reduction. |
-`-----------------------------*/
-yyreduce:
- /* yyn is the number of a rule to reduce with. */
- yylen = yyr2[yyn];
-
- /* If YYLEN is nonzero, implement the default value of the action:
- `$$ = $1'.
-
- Otherwise, the following line sets YYVAL to garbage.
- This behavior is undocumented and Bison
- users should not rely upon it. Assigning to YYVAL
- unconditionally makes the parser a bit smaller, and it avoids a
- GCC warning that YYVAL may be used uninitialized. */
- yyval = yyvsp[1-yylen];
-
-
- YY_REDUCE_PRINT (yyn);
- switch (yyn)
- {
- case 10:
-
- { zconf_error("unexpected end statement"); ;}
- break;
-
- case 11:
-
- { zconf_error("unknown statement \"%s\"", (yyvsp[(2) - (4)].string)); ;}
- break;
-
- case 12:
-
- {
- zconf_error("unexpected option \"%s\"", kconf_id_strings + (yyvsp[(2) - (4)].id)->name);
-;}
- break;
-
- case 13:
-
- { zconf_error("invalid statement"); ;}
- break;
-
- case 28:
-
- { zconf_error("unknown option \"%s\"", (yyvsp[(1) - (3)].string)); ;}
- break;
-
- case 29:
-
- { zconf_error("invalid option"); ;}
- break;
-
- case 30:
-
- {
- struct symbol *sym = sym_lookup((yyvsp[(2) - (3)].string), 0);
- sym->flags |= SYMBOL_OPTIONAL;
- menu_add_entry(sym);
- printd(DEBUG_PARSE, "%s:%d:config %s\n", zconf_curname(), zconf_lineno(), (yyvsp[(2) - (3)].string));
-;}
- break;
-
- case 31:
-
- {
- menu_end_entry();
- printd(DEBUG_PARSE, "%s:%d:endconfig\n", zconf_curname(), zconf_lineno());
-;}
- break;
-
- case 32:
-
- {
- struct symbol *sym = sym_lookup((yyvsp[(2) - (3)].string), 0);
- sym->flags |= SYMBOL_OPTIONAL;
- menu_add_entry(sym);
- printd(DEBUG_PARSE, "%s:%d:menuconfig %s\n", zconf_curname(), zconf_lineno(), (yyvsp[(2) - (3)].string));
-;}
- break;
-
- case 33:
-
- {
- if (current_entry->prompt)
- current_entry->prompt->type = P_MENU;
- else
- zconfprint("warning: menuconfig statement without prompt");
- menu_end_entry();
- printd(DEBUG_PARSE, "%s:%d:endconfig\n", zconf_curname(), zconf_lineno());
-;}
- break;
-
- case 41:
-
- {
- menu_set_type((yyvsp[(1) - (3)].id)->stype);
- printd(DEBUG_PARSE, "%s:%d:type(%u)\n",
- zconf_curname(), zconf_lineno(),
- (yyvsp[(1) - (3)].id)->stype);
-;}
- break;
-
- case 42:
-
- {
- menu_add_prompt(P_PROMPT, (yyvsp[(2) - (4)].string), (yyvsp[(3) - (4)].expr));
- printd(DEBUG_PARSE, "%s:%d:prompt\n", zconf_curname(), zconf_lineno());
-;}
- break;
-
- case 43:
-
- {
- menu_add_expr(P_DEFAULT, (yyvsp[(2) - (4)].expr), (yyvsp[(3) - (4)].expr));
- if ((yyvsp[(1) - (4)].id)->stype != S_UNKNOWN)
- menu_set_type((yyvsp[(1) - (4)].id)->stype);
- printd(DEBUG_PARSE, "%s:%d:default(%u)\n",
- zconf_curname(), zconf_lineno(),
- (yyvsp[(1) - (4)].id)->stype);
-;}
- break;
-
- case 44:
-
- {
- menu_add_symbol(P_SELECT, sym_lookup((yyvsp[(2) - (4)].string), 0), (yyvsp[(3) - (4)].expr));
- printd(DEBUG_PARSE, "%s:%d:select\n", zconf_curname(), zconf_lineno());
-;}
- break;
-
- case 45:
-
- {
- menu_add_expr(P_RANGE, expr_alloc_comp(E_RANGE,(yyvsp[(2) - (5)].symbol), (yyvsp[(3) - (5)].symbol)), (yyvsp[(4) - (5)].expr));
- printd(DEBUG_PARSE, "%s:%d:range\n", zconf_curname(), zconf_lineno());
-;}
- break;
-
- case 48:
-
- {
- const struct kconf_id *id = kconf_id_lookup((yyvsp[(2) - (3)].string), strlen((yyvsp[(2) - (3)].string)));
- if (id && id->flags & TF_OPTION)
- menu_add_option(id->token, (yyvsp[(3) - (3)].string));
- else
- zconfprint("warning: ignoring unknown option %s", (yyvsp[(2) - (3)].string));
- free((yyvsp[(2) - (3)].string));
-;}
- break;
-
- case 49:
-
- { (yyval.string) = NULL; ;}
- break;
-
- case 50:
-
- { (yyval.string) = (yyvsp[(2) - (2)].string); ;}
- break;
-
- case 51:
-
- {
- struct symbol *sym = sym_lookup((yyvsp[(2) - (3)].string), SYMBOL_CHOICE);
- sym->flags |= SYMBOL_AUTO;
- menu_add_entry(sym);
- menu_add_expr(P_CHOICE, NULL, NULL);
- printd(DEBUG_PARSE, "%s:%d:choice\n", zconf_curname(), zconf_lineno());
-;}
- break;
-
- case 52:
-
- {
- (yyval.menu) = menu_add_menu();
-;}
- break;
-
- case 53:
-
- {
- if (zconf_endtoken((yyvsp[(1) - (1)].id), T_CHOICE, T_ENDCHOICE)) {
- menu_end_menu();
- printd(DEBUG_PARSE, "%s:%d:endchoice\n", zconf_curname(), zconf_lineno());
- }
-;}
- break;
-
- case 61:
-
- {
- menu_add_prompt(P_PROMPT, (yyvsp[(2) - (4)].string), (yyvsp[(3) - (4)].expr));
- printd(DEBUG_PARSE, "%s:%d:prompt\n", zconf_curname(), zconf_lineno());
-;}
- break;
-
- case 62:
-
- {
- if ((yyvsp[(1) - (3)].id)->stype == S_BOOLEAN || (yyvsp[(1) - (3)].id)->stype == S_TRISTATE) {
- menu_set_type((yyvsp[(1) - (3)].id)->stype);
- printd(DEBUG_PARSE, "%s:%d:type(%u)\n",
- zconf_curname(), zconf_lineno(),
- (yyvsp[(1) - (3)].id)->stype);
- } else
- YYERROR;
-;}
- break;
-
- case 63:
-
- {
- current_entry->sym->flags |= SYMBOL_OPTIONAL;
- printd(DEBUG_PARSE, "%s:%d:optional\n", zconf_curname(), zconf_lineno());
-;}
- break;
-
- case 64:
-
- {
- if ((yyvsp[(1) - (4)].id)->stype == S_UNKNOWN) {
- menu_add_symbol(P_DEFAULT, sym_lookup((yyvsp[(2) - (4)].string), 0), (yyvsp[(3) - (4)].expr));
- printd(DEBUG_PARSE, "%s:%d:default\n",
- zconf_curname(), zconf_lineno());
- } else
- YYERROR;
-;}
- break;
-
- case 67:
-
- {
- printd(DEBUG_PARSE, "%s:%d:if\n", zconf_curname(), zconf_lineno());
- menu_add_entry(NULL);
- menu_add_dep((yyvsp[(2) - (3)].expr));
- (yyval.menu) = menu_add_menu();
-;}
- break;
-
- case 68:
-
- {
- if (zconf_endtoken((yyvsp[(1) - (1)].id), T_IF, T_ENDIF)) {
- menu_end_menu();
- printd(DEBUG_PARSE, "%s:%d:endif\n", zconf_curname(), zconf_lineno());
- }
-;}
- break;
-
- case 74:
-
- {
- menu_add_prompt(P_MENU, (yyvsp[(2) - (3)].string), NULL);
-;}
- break;
-
- case 75:
-
- {
- menu_add_entry(NULL);
- menu_add_prompt(P_MENU, (yyvsp[(2) - (3)].string), NULL);
- printd(DEBUG_PARSE, "%s:%d:menu\n", zconf_curname(), zconf_lineno());
-;}
- break;
-
- case 76:
-
- {
- (yyval.menu) = menu_add_menu();
-;}
- break;
-
- case 77:
-
- {
- if (zconf_endtoken((yyvsp[(1) - (1)].id), T_MENU, T_ENDMENU)) {
- menu_end_menu();
- printd(DEBUG_PARSE, "%s:%d:endmenu\n", zconf_curname(), zconf_lineno());
- }
-;}
- break;
-
- case 83:
-
- {
- printd(DEBUG_PARSE, "%s:%d:source %s\n", zconf_curname(), zconf_lineno(), (yyvsp[(2) - (3)].string));
- zconf_nextfiles((yyvsp[(2) - (3)].string));
-;}
- break;
-
- case 84:
-
- {
- menu_add_entry(NULL);
- menu_add_prompt(P_COMMENT, (yyvsp[(2) - (3)].string), NULL);
- printd(DEBUG_PARSE, "%s:%d:comment\n", zconf_curname(), zconf_lineno());
-;}
- break;
-
- case 85:
-
- {
- menu_end_entry();
-;}
- break;
-
- case 86:
-
- {
- printd(DEBUG_PARSE, "%s:%d:help\n", zconf_curname(), zconf_lineno());
- zconf_starthelp();
-;}
- break;
-
- case 87:
-
- {
- current_entry->help = (yyvsp[(2) - (2)].string);
-;}
- break;
-
- case 92:
-
- {
- menu_add_dep((yyvsp[(3) - (4)].expr));
- printd(DEBUG_PARSE, "%s:%d:depends on\n", zconf_curname(), zconf_lineno());
-;}
- break;
-
- case 96:
-
- {
- menu_add_visibility((yyvsp[(2) - (2)].expr));
-;}
- break;
-
- case 98:
-
- {
- menu_add_prompt(P_PROMPT, (yyvsp[(1) - (2)].string), (yyvsp[(2) - (2)].expr));
-;}
- break;
-
- case 101:
-
- { (yyval.id) = (yyvsp[(1) - (2)].id); ;}
- break;
-
- case 102:
-
- { (yyval.id) = (yyvsp[(1) - (2)].id); ;}
- break;
-
- case 103:
-
- { (yyval.id) = (yyvsp[(1) - (2)].id); ;}
- break;
-
- case 106:
-
- { (yyval.expr) = NULL; ;}
- break;
-
- case 107:
-
- { (yyval.expr) = (yyvsp[(2) - (2)].expr); ;}
- break;
-
- case 108:
-
- { (yyval.expr) = expr_alloc_symbol((yyvsp[(1) - (1)].symbol)); ;}
- break;
-
- case 109:
-
- { (yyval.expr) = expr_alloc_comp(E_LTH, (yyvsp[(1) - (3)].symbol), (yyvsp[(3) - (3)].symbol)); ;}
- break;
-
- case 110:
-
- { (yyval.expr) = expr_alloc_comp(E_LEQ, (yyvsp[(1) - (3)].symbol), (yyvsp[(3) - (3)].symbol)); ;}
- break;
-
- case 111:
-
- { (yyval.expr) = expr_alloc_comp(E_GTH, (yyvsp[(1) - (3)].symbol), (yyvsp[(3) - (3)].symbol)); ;}
- break;
-
- case 112:
-
- { (yyval.expr) = expr_alloc_comp(E_GEQ, (yyvsp[(1) - (3)].symbol), (yyvsp[(3) - (3)].symbol)); ;}
- break;
-
- case 113:
-
- { (yyval.expr) = expr_alloc_comp(E_EQUAL, (yyvsp[(1) - (3)].symbol), (yyvsp[(3) - (3)].symbol)); ;}
- break;
-
- case 114:
-
- { (yyval.expr) = expr_alloc_comp(E_UNEQUAL, (yyvsp[(1) - (3)].symbol), (yyvsp[(3) - (3)].symbol)); ;}
- break;
-
- case 115:
-
- { (yyval.expr) = (yyvsp[(2) - (3)].expr); ;}
- break;
-
- case 116:
-
- { (yyval.expr) = expr_alloc_one(E_NOT, (yyvsp[(2) - (2)].expr)); ;}
- break;
-
- case 117:
-
- { (yyval.expr) = expr_alloc_two(E_OR, (yyvsp[(1) - (3)].expr), (yyvsp[(3) - (3)].expr)); ;}
- break;
-
- case 118:
-
- { (yyval.expr) = expr_alloc_two(E_AND, (yyvsp[(1) - (3)].expr), (yyvsp[(3) - (3)].expr)); ;}
- break;
-
- case 119:
-
- { (yyval.symbol) = sym_lookup((yyvsp[(1) - (1)].string), 0); free((yyvsp[(1) - (1)].string)); ;}
- break;
-
- case 120:
-
- { (yyval.symbol) = sym_lookup((yyvsp[(1) - (1)].string), SYMBOL_CONST); free((yyvsp[(1) - (1)].string)); ;}
- break;
-
- case 121:
-
- { (yyval.string) = NULL; ;}
- break;
-
-
-/* Line 1267 of yacc.c. */
-
- default: break;
- }
- YY_SYMBOL_PRINT ("-> $$ =", yyr1[yyn], &yyval, &yyloc);
-
- YYPOPSTACK (yylen);
- yylen = 0;
- YY_STACK_PRINT (yyss, yyssp);
-
- *++yyvsp = yyval;
-
-
- /* Now `shift' the result of the reduction. Determine what state
- that goes to, based on the state we popped back to and the rule
- number reduced by. */
-
- yyn = yyr1[yyn];
-
- yystate = yypgoto[yyn - YYNTOKENS] + *yyssp;
- if (0 <= yystate && yystate <= YYLAST && yycheck[yystate] == *yyssp)
- yystate = yytable[yystate];
- else
- yystate = yydefgoto[yyn - YYNTOKENS];
-
- goto yynewstate;
-
-
-/*------------------------------------.
-| yyerrlab -- here on detecting error |
-`------------------------------------*/
-yyerrlab:
- /* If not already recovering from an error, report this error. */
- if (!yyerrstatus)
- {
- ++yynerrs;
-#if ! YYERROR_VERBOSE
- yyerror (YY_("syntax error"));
-#else
- {
- YYSIZE_T yysize = yysyntax_error (0, yystate, yychar);
- if (yymsg_alloc < yysize && yymsg_alloc < YYSTACK_ALLOC_MAXIMUM)
- {
- YYSIZE_T yyalloc = 2 * yysize;
- if (! (yysize <= yyalloc && yyalloc <= YYSTACK_ALLOC_MAXIMUM))
- yyalloc = YYSTACK_ALLOC_MAXIMUM;
- if (yymsg != yymsgbuf)
- YYSTACK_FREE (yymsg);
- yymsg = (char *) YYSTACK_ALLOC (yyalloc);
- if (yymsg)
- yymsg_alloc = yyalloc;
- else
- {
- yymsg = yymsgbuf;
- yymsg_alloc = sizeof yymsgbuf;
- }
- }
-
- if (0 < yysize && yysize <= yymsg_alloc)
- {
- (void) yysyntax_error (yymsg, yystate, yychar);
- yyerror (yymsg);
- }
- else
- {
- yyerror (YY_("syntax error"));
- if (yysize != 0)
- goto yyexhaustedlab;
- }
- }
-#endif
- }
-
-
-
- if (yyerrstatus == 3)
- {
- /* If just tried and failed to reuse look-ahead token after an
- error, discard it. */
-
- if (yychar <= YYEOF)
- {
- /* Return failure if at end of input. */
- if (yychar == YYEOF)
- YYABORT;
- }
- else
- {
- yydestruct ("Error: discarding",
- yytoken, &yylval);
- yychar = YYEMPTY;
- }
- }
-
- /* Else will try to reuse look-ahead token after shifting the error
- token. */
- goto yyerrlab1;
-
-
-/*---------------------------------------------------.
-| yyerrorlab -- error raised explicitly by YYERROR. |
-`---------------------------------------------------*/
-yyerrorlab:
-
- /* Pacify compilers like GCC when the user code never invokes
- YYERROR and the label yyerrorlab therefore never appears in user
- code. */
- if (/*CONSTCOND*/ 0)
- goto yyerrorlab;
-
- /* Do not reclaim the symbols of the rule which action triggered
- this YYERROR. */
- YYPOPSTACK (yylen);
- yylen = 0;
- YY_STACK_PRINT (yyss, yyssp);
- yystate = *yyssp;
- goto yyerrlab1;
-
-
-/*-------------------------------------------------------------.
-| yyerrlab1 -- common code for both syntax error and YYERROR. |
-`-------------------------------------------------------------*/
-yyerrlab1:
- yyerrstatus = 3; /* Each real token shifted decrements this. */
-
- for (;;)
- {
- yyn = yypact[yystate];
- if (yyn != YYPACT_NINF)
- {
- yyn += YYTERROR;
- if (0 <= yyn && yyn <= YYLAST && yycheck[yyn] == YYTERROR)
- {
- yyn = yytable[yyn];
- if (0 < yyn)
- break;
- }
- }
-
- /* Pop the current state because it cannot handle the error token. */
- if (yyssp == yyss)
- YYABORT;
-
-
- yydestruct ("Error: popping",
- yystos[yystate], yyvsp);
- YYPOPSTACK (1);
- yystate = *yyssp;
- YY_STACK_PRINT (yyss, yyssp);
- }
-
- if (yyn == YYFINAL)
- YYACCEPT;
-
- *++yyvsp = yylval;
-
-
- /* Shift the error token. */
- YY_SYMBOL_PRINT ("Shifting", yystos[yyn], yyvsp, yylsp);
-
- yystate = yyn;
- goto yynewstate;
-
-
-/*-------------------------------------.
-| yyacceptlab -- YYACCEPT comes here. |
-`-------------------------------------*/
-yyacceptlab:
- yyresult = 0;
- goto yyreturn;
-
-/*-----------------------------------.
-| yyabortlab -- YYABORT comes here. |
-`-----------------------------------*/
-yyabortlab:
- yyresult = 1;
- goto yyreturn;
-
-#ifndef yyoverflow
-/*-------------------------------------------------.
-| yyexhaustedlab -- memory exhaustion comes here. |
-`-------------------------------------------------*/
-yyexhaustedlab:
- yyerror (YY_("memory exhausted"));
- yyresult = 2;
- /* Fall through. */
-#endif
-
-yyreturn:
- if (yychar != YYEOF && yychar != YYEMPTY)
- yydestruct ("Cleanup: discarding lookahead",
- yytoken, &yylval);
- /* Do not reclaim the symbols of the rule which action triggered
- this YYABORT or YYACCEPT. */
- YYPOPSTACK (yylen);
- YY_STACK_PRINT (yyss, yyssp);
- while (yyssp != yyss)
- {
- yydestruct ("Cleanup: popping",
- yystos[*yyssp], yyvsp);
- YYPOPSTACK (1);
- }
-#ifndef yyoverflow
- if (yyss != yyssa)
- YYSTACK_FREE (yyss);
-#endif
-#if YYERROR_VERBOSE
- if (yymsg != yymsgbuf)
- YYSTACK_FREE (yymsg);
-#endif
- /* Make sure YYID is used. */
- return YYID (yyresult);
-}
-
-
-
-
-
-void conf_parse(const char *name)
-{
- struct symbol *sym;
- int i;
-
- zconf_initscan(name);
-
- sym_init();
- _menu_init();
- rootmenu.prompt = menu_add_prompt(P_MENU, "Linux Kernel Configuration", NULL);
-
- if (getenv("ZCONF_DEBUG"))
- zconfdebug = 1;
- zconfparse();
- if (zconfnerrs)
- exit(1);
- if (!modules_sym)
- modules_sym = sym_find( "n" );
-
- rootmenu.prompt->text = _(rootmenu.prompt->text);
- rootmenu.prompt->text = sym_expand_string_value(rootmenu.prompt->text);
-
- menu_finalize(&rootmenu);
- for_all_symbols(i, sym) {
- if (sym_check_deps(sym))
- zconfnerrs++;
- }
- if (zconfnerrs)
- exit(1);
- sym_set_change_count(1);
-}
-
-static const char *zconf_tokenname(int token)
-{
- switch (token) {
- case T_MENU: return "menu";
- case T_ENDMENU: return "endmenu";
- case T_CHOICE: return "choice";
- case T_ENDCHOICE: return "endchoice";
- case T_IF: return "if";
- case T_ENDIF: return "endif";
- case T_DEPENDS: return "depends";
- case T_VISIBLE: return "visible";
- }
- return "<token>";
-}
-
-static bool zconf_endtoken(const struct kconf_id *id, int starttoken, int endtoken)
-{
- if (id->token != endtoken) {
- zconf_error("unexpected '%s' within %s block",
- kconf_id_strings + id->name, zconf_tokenname(starttoken));
- zconfnerrs++;
- return false;
- }
-#if 0
-//Wildcard breaks this somehow, so disabled for now. -JD
- if (current_menu->file != current_file) {
- zconf_error("'%s' in different file than '%s'",
- kconf_id_strings + id->name, zconf_tokenname(starttoken));
- fprintf(stderr, "%s:%d: location of the '%s'\n",
- current_menu->file->name, current_menu->lineno,
- zconf_tokenname(starttoken));
- zconfnerrs++;
- return false;
- }
-#endif
- return true;
-}
-
-static void zconfprint(const char *err, ...)
-{
- va_list ap;
-
- fprintf(stderr, "%s:%d: ", zconf_curname(), zconf_lineno());
- va_start(ap, err);
- vfprintf(stderr, err, ap);
- va_end(ap);
- fprintf(stderr, "\n");
-}
-
-static void zconf_error(const char *err, ...)
-{
- va_list ap;
-
- zconfnerrs++;
- fprintf(stderr, "%s:%d: ", zconf_curname(), zconf_lineno());
- va_start(ap, err);
- vfprintf(stderr, err, ap);
- va_end(ap);
- fprintf(stderr, "\n");
-}
-
-static void zconferror(const char *err)
-{
- fprintf(stderr, "%s:%d: %s\n", zconf_curname(), zconf_lineno() + 1, err);
-}
-
-static void print_quoted_string(FILE *out, const char *str)
-{
- const char *p;
- int len;
-
- putc('"', out);
- while ((p = strchr(str, '"'))) {
- len = p - str;
- if (len)
- fprintf(out, "%.*s", len, str);
- fputs("\\\"", out);
- str = p + 1;
- }
- fputs(str, out);
- putc('"', out);
-}
-
-static void print_symbol(FILE *out, struct menu *menu)
-{
- struct symbol *sym = menu->sym;
- struct property *prop;
-
- if (sym_is_choice(sym))
- fprintf(out, "\nchoice\n");
- else
- fprintf(out, "\nconfig %s\n", sym->name);
- switch (sym->type) {
- case S_BOOLEAN:
- fputs(" boolean\n", out);
- break;
- case S_TRISTATE:
- fputs(" tristate\n", out);
- break;
- case S_STRING:
- fputs(" string\n", out);
- break;
- case S_INT:
- fputs(" integer\n", out);
- break;
- case S_HEX:
- fputs(" hex\n", out);
- break;
- default:
- fputs(" ???\n", out);
- break;
- }
- for (prop = sym->prop; prop; prop = prop->next) {
- if (prop->menu != menu)
- continue;
- switch (prop->type) {
- case P_PROMPT:
- fputs(" prompt ", out);
- print_quoted_string(out, prop->text);
- if (!expr_is_yes(prop->visible.expr)) {
- fputs(" if ", out);
- expr_fprint(prop->visible.expr, out);
- }
- fputc('\n', out);
- break;
- case P_DEFAULT:
- fputs( " default ", out);
- expr_fprint(prop->expr, out);
- if (!expr_is_yes(prop->visible.expr)) {
- fputs(" if ", out);
- expr_fprint(prop->visible.expr, out);
- }
- fputc('\n', out);
- break;
- case P_CHOICE:
- fputs(" #choice value\n", out);
- break;
- case P_SELECT:
- fputs( " select ", out);
- expr_fprint(prop->expr, out);
- fputc('\n', out);
- break;
- case P_RANGE:
- fputs( " range ", out);
- expr_fprint(prop->expr, out);
- fputc('\n', out);
- break;
- case P_MENU:
- fputs( " menu ", out);
- print_quoted_string(out, prop->text);
- fputc('\n', out);
- break;
- default:
- fprintf(out, " unknown prop %d!\n", prop->type);
- break;
- }
- }
- if (menu->help) {
- int len = strlen(menu->help);
- while (menu->help[--len] == '\n')
- menu->help[len] = 0;
- fprintf(out, " help\n%s\n", menu->help);
- }
-}
-
-void zconfdump(FILE *out)
-{
- struct property *prop;
- struct symbol *sym;
- struct menu *menu;
-
- menu = rootmenu.list;
- while (menu) {
- if ((sym = menu->sym))
- print_symbol(out, menu);
- else if ((prop = menu->prompt)) {
- switch (prop->type) {
- case P_COMMENT:
- fputs("\ncomment ", out);
- print_quoted_string(out, prop->text);
- fputs("\n", out);
- break;
- case P_MENU:
- fputs("\nmenu ", out);
- print_quoted_string(out, prop->text);
- fputs("\n", out);
- break;
- default:
- ;
- }
- if (!expr_is_yes(prop->visible.expr)) {
- fputs(" depends ", out);
- expr_fprint(prop->visible.expr, out);
- fputc('\n', out);
- }
- }
-
- if (menu->list)
- menu = menu->list;
- else if (menu->next)
- menu = menu->next;
- else while ((menu = menu->parent)) {
- if (menu->prompt && menu->prompt->type == P_MENU)
- fputs("\nendmenu\n", out);
- if (menu->next) {
- menu = menu->next;
- break;
- }
- }
- }
-}
-
-#include "zconf.lex.c"
-#include "util.c"
-#include "confdata.c"
-#include "expr.c"
-#include "symbol.c"
-#include "menu.c"
-
+++ /dev/null
-%{
-/*
- * Copyright (C) 2002 Roman Zippel <zippel@linux-m68k.org>
- * Released under the terms of the GNU GPL v2.0.
- */
-
-#include <ctype.h>
-#include <stdarg.h>
-#include <stdio.h>
-#include <stdlib.h>
-#include <string.h>
-#include <stdbool.h>
-
-#include "lkc.h"
-
-#define printd(mask, fmt...) if (cdebug & (mask)) printf(fmt)
-
-#define PRINTD 0x0001
-#define DEBUG_PARSE 0x0002
-
-int cdebug = PRINTD;
-
-extern int zconflex(void);
-static void zconfprint(const char *err, ...);
-static void zconf_error(const char *err, ...);
-static void zconferror(const char *err);
-static bool zconf_endtoken(const struct kconf_id *id, int starttoken, int endtoken);
-
-struct symbol *symbol_hash[SYMBOL_HASHSIZE];
-
-static struct menu *current_menu, *current_entry;
-
-%}
-%expect 30
-
-%union
-{
- char *string;
- struct file *file;
- struct symbol *symbol;
- struct expr *expr;
- struct menu *menu;
- const struct kconf_id *id;
-}
-
-%token <id>T_MAINMENU
-%token <id>T_MENU
-%token <id>T_ENDMENU
-%token <id>T_SOURCE
-%token <id>T_CHOICE
-%token <id>T_ENDCHOICE
-%token <id>T_COMMENT
-%token <id>T_CONFIG
-%token <id>T_MENUCONFIG
-%token <id>T_HELP
-%token <string> T_HELPTEXT
-%token <id>T_IF
-%token <id>T_ENDIF
-%token <id>T_DEPENDS
-%token <id>T_OPTIONAL
-%token <id>T_PROMPT
-%token <id>T_TYPE
-%token <id>T_DEFAULT
-%token <id>T_SELECT
-%token <id>T_RANGE
-%token <id>T_VISIBLE
-%token <id>T_OPTION
-%token <id>T_ON
-%token <string> T_WORD
-%token <string> T_WORD_QUOTE
-%token T_UNEQUAL
-%token T_LESS
-%token T_LESS_EQUAL
-%token T_GREATER
-%token T_GREATER_EQUAL
-%token T_CLOSE_PAREN
-%token T_OPEN_PAREN
-%token T_EOL
-
-%left T_OR
-%left T_AND
-%left T_EQUAL T_UNEQUAL
-%left T_LESS T_LESS_EQUAL T_GREATER T_GREATER_EQUAL
-%nonassoc T_NOT
-
-%type <string> prompt
-%type <symbol> symbol
-%type <expr> expr
-%type <expr> if_expr
-%type <id> end
-%type <id> option_name
-%type <menu> if_entry menu_entry choice_entry
-%type <string> symbol_option_arg word_opt
-
-%destructor {
- fprintf(stderr, "%s:%d: missing end statement for this entry\n",
- $$->file->name, $$->lineno);
- if (current_menu == $$)
- menu_end_menu();
-} if_entry menu_entry choice_entry
-
-%{
-/* Include zconf.hash.c here so it can see the token constants. */
-#include "zconf.hash.c"
-%}
-
-%%
-input: nl start | start;
-
-start: mainmenu_stmt stmt_list | stmt_list;
-
-stmt_list:
- /* empty */
- | stmt_list common_stmt
- | stmt_list choice_stmt
- | stmt_list menu_stmt
- | stmt_list end { zconf_error("unexpected end statement"); }
- | stmt_list T_WORD error T_EOL { zconf_error("unknown statement \"%s\"", $2); }
- | stmt_list option_name error T_EOL
-{
- zconf_error("unexpected option \"%s\"", kconf_id_strings + $2->name);
-}
- | stmt_list error T_EOL { zconf_error("invalid statement"); }
-;
-
-option_name:
- T_DEPENDS | T_PROMPT | T_TYPE | T_SELECT | T_OPTIONAL | T_RANGE | T_DEFAULT | T_VISIBLE
-;
-
-common_stmt:
- T_EOL
- | if_stmt
- | comment_stmt
- | config_stmt
- | menuconfig_stmt
- | source_stmt
-;
-
-option_error:
- T_WORD error T_EOL { zconf_error("unknown option \"%s\"", $1); }
- | error T_EOL { zconf_error("invalid option"); }
-;
-
-
-/* config/menuconfig entry */
-
-config_entry_start: T_CONFIG T_WORD T_EOL
-{
- struct symbol *sym = sym_lookup($2, 0);
- sym->flags |= SYMBOL_OPTIONAL;
- menu_add_entry(sym);
- printd(DEBUG_PARSE, "%s:%d:config %s\n", zconf_curname(), zconf_lineno(), $2);
-};
-
-config_stmt: config_entry_start config_option_list
-{
- menu_end_entry();
- printd(DEBUG_PARSE, "%s:%d:endconfig\n", zconf_curname(), zconf_lineno());
-};
-
-menuconfig_entry_start: T_MENUCONFIG T_WORD T_EOL
-{
- struct symbol *sym = sym_lookup($2, 0);
- sym->flags |= SYMBOL_OPTIONAL;
- menu_add_entry(sym);
- printd(DEBUG_PARSE, "%s:%d:menuconfig %s\n", zconf_curname(), zconf_lineno(), $2);
-};
-
-menuconfig_stmt: menuconfig_entry_start config_option_list
-{
- if (current_entry->prompt)
- current_entry->prompt->type = P_MENU;
- else
- zconfprint("warning: menuconfig statement without prompt");
- menu_end_entry();
- printd(DEBUG_PARSE, "%s:%d:endconfig\n", zconf_curname(), zconf_lineno());
-};
-
-config_option_list:
- /* empty */
- | config_option_list config_option
- | config_option_list symbol_option
- | config_option_list depends
- | config_option_list help
- | config_option_list option_error
- | config_option_list T_EOL
-;
-
-config_option: T_TYPE prompt_stmt_opt T_EOL
-{
- menu_set_type($1->stype);
- printd(DEBUG_PARSE, "%s:%d:type(%u)\n",
- zconf_curname(), zconf_lineno(),
- $1->stype);
-};
-
-config_option: T_PROMPT prompt if_expr T_EOL
-{
- menu_add_prompt(P_PROMPT, $2, $3);
- printd(DEBUG_PARSE, "%s:%d:prompt\n", zconf_curname(), zconf_lineno());
-};
-
-config_option: T_DEFAULT expr if_expr T_EOL
-{
- menu_add_expr(P_DEFAULT, $2, $3);
- if ($1->stype != S_UNKNOWN)
- menu_set_type($1->stype);
- printd(DEBUG_PARSE, "%s:%d:default(%u)\n",
- zconf_curname(), zconf_lineno(),
- $1->stype);
-};
-
-config_option: T_SELECT T_WORD if_expr T_EOL
-{
- menu_add_symbol(P_SELECT, sym_lookup($2, 0), $3);
- printd(DEBUG_PARSE, "%s:%d:select\n", zconf_curname(), zconf_lineno());
-};
-
-config_option: T_RANGE symbol symbol if_expr T_EOL
-{
- menu_add_expr(P_RANGE, expr_alloc_comp(E_RANGE,$2, $3), $4);
- printd(DEBUG_PARSE, "%s:%d:range\n", zconf_curname(), zconf_lineno());
-};
-
-symbol_option: T_OPTION symbol_option_list T_EOL
-;
-
-symbol_option_list:
- /* empty */
- | symbol_option_list T_WORD symbol_option_arg
-{
- const struct kconf_id *id = kconf_id_lookup($2, strlen($2));
- if (id && id->flags & TF_OPTION)
- menu_add_option(id->token, $3);
- else
- zconfprint("warning: ignoring unknown option %s", $2);
- free($2);
-};
-
-symbol_option_arg:
- /* empty */ { $$ = NULL; }
- | T_EQUAL prompt { $$ = $2; }
-;
-
-/* choice entry */
-
-choice: T_CHOICE word_opt T_EOL
-{
- struct symbol *sym = sym_lookup($2, SYMBOL_CHOICE);
- sym->flags |= SYMBOL_AUTO;
- menu_add_entry(sym);
- menu_add_expr(P_CHOICE, NULL, NULL);
- printd(DEBUG_PARSE, "%s:%d:choice\n", zconf_curname(), zconf_lineno());
-};
-
-choice_entry: choice choice_option_list
-{
- $$ = menu_add_menu();
-};
-
-choice_end: end
-{
- if (zconf_endtoken($1, T_CHOICE, T_ENDCHOICE)) {
- menu_end_menu();
- printd(DEBUG_PARSE, "%s:%d:endchoice\n", zconf_curname(), zconf_lineno());
- }
-};
-
-choice_stmt: choice_entry choice_block choice_end
-;
-
-choice_option_list:
- /* empty */
- | choice_option_list choice_option
- | choice_option_list depends
- | choice_option_list help
- | choice_option_list T_EOL
- | choice_option_list option_error
-;
-
-choice_option: T_PROMPT prompt if_expr T_EOL
-{
- menu_add_prompt(P_PROMPT, $2, $3);
- printd(DEBUG_PARSE, "%s:%d:prompt\n", zconf_curname(), zconf_lineno());
-};
-
-choice_option: T_TYPE prompt_stmt_opt T_EOL
-{
- if ($1->stype == S_BOOLEAN || $1->stype == S_TRISTATE) {
- menu_set_type($1->stype);
- printd(DEBUG_PARSE, "%s:%d:type(%u)\n",
- zconf_curname(), zconf_lineno(),
- $1->stype);
- } else
- YYERROR;
-};
-
-choice_option: T_OPTIONAL T_EOL
-{
- current_entry->sym->flags |= SYMBOL_OPTIONAL;
- printd(DEBUG_PARSE, "%s:%d:optional\n", zconf_curname(), zconf_lineno());
-};
-
-choice_option: T_DEFAULT T_WORD if_expr T_EOL
-{
- if ($1->stype == S_UNKNOWN) {
- menu_add_symbol(P_DEFAULT, sym_lookup($2, 0), $3);
- printd(DEBUG_PARSE, "%s:%d:default\n",
- zconf_curname(), zconf_lineno());
- } else
- YYERROR;
-};
-
-choice_block:
- /* empty */
- | choice_block common_stmt
-;
-
-/* if entry */
-
-if_entry: T_IF expr nl
-{
- printd(DEBUG_PARSE, "%s:%d:if\n", zconf_curname(), zconf_lineno());
- menu_add_entry(NULL);
- menu_add_dep($2);
- $$ = menu_add_menu();
-};
-
-if_end: end
-{
- if (zconf_endtoken($1, T_IF, T_ENDIF)) {
- menu_end_menu();
- printd(DEBUG_PARSE, "%s:%d:endif\n", zconf_curname(), zconf_lineno());
- }
-};
-
-if_stmt: if_entry if_block if_end
-;
-
-if_block:
- /* empty */
- | if_block common_stmt
- | if_block menu_stmt
- | if_block choice_stmt
-;
-
-/* mainmenu entry */
-
-mainmenu_stmt: T_MAINMENU prompt nl
-{
- menu_add_prompt(P_MENU, $2, NULL);
-};
-
-/* menu entry */
-
-menu: T_MENU prompt T_EOL
-{
- menu_add_entry(NULL);
- menu_add_prompt(P_MENU, $2, NULL);
- printd(DEBUG_PARSE, "%s:%d:menu\n", zconf_curname(), zconf_lineno());
-};
-
-menu_entry: menu visibility_list depends_list
-{
- $$ = menu_add_menu();
-};
-
-menu_end: end
-{
- if (zconf_endtoken($1, T_MENU, T_ENDMENU)) {
- menu_end_menu();
- printd(DEBUG_PARSE, "%s:%d:endmenu\n", zconf_curname(), zconf_lineno());
- }
-};
-
-menu_stmt: menu_entry menu_block menu_end
-;
-
-menu_block:
- /* empty */
- | menu_block common_stmt
- | menu_block menu_stmt
- | menu_block choice_stmt
-;
-
-source_stmt: T_SOURCE prompt T_EOL
-{
- printd(DEBUG_PARSE, "%s:%d:source %s\n", zconf_curname(), zconf_lineno(), $2);
- zconf_nextfiles($2);
-};
-
-/* comment entry */
-
-comment: T_COMMENT prompt T_EOL
-{
- menu_add_entry(NULL);
- menu_add_prompt(P_COMMENT, $2, NULL);
- printd(DEBUG_PARSE, "%s:%d:comment\n", zconf_curname(), zconf_lineno());
-};
-
-comment_stmt: comment depends_list
-{
- menu_end_entry();
-};
-
-/* help option */
-
-help_start: T_HELP T_EOL
-{
- printd(DEBUG_PARSE, "%s:%d:help\n", zconf_curname(), zconf_lineno());
- zconf_starthelp();
-};
-
-help: help_start T_HELPTEXT
-{
- current_entry->help = $2;
-};
-
-/* depends option */
-
-depends_list:
- /* empty */
- | depends_list depends
- | depends_list T_EOL
- | depends_list option_error
-;
-
-depends: T_DEPENDS T_ON expr T_EOL
-{
- menu_add_dep($3);
- printd(DEBUG_PARSE, "%s:%d:depends on\n", zconf_curname(), zconf_lineno());
-};
-
-/* visibility option */
-
-visibility_list:
- /* empty */
- | visibility_list visible
- | visibility_list T_EOL
-;
-
-visible: T_VISIBLE if_expr
-{
- menu_add_visibility($2);
-};
-
-/* prompt statement */
-
-prompt_stmt_opt:
- /* empty */
- | prompt if_expr
-{
- menu_add_prompt(P_PROMPT, $1, $2);
-};
-
-prompt: T_WORD
- | T_WORD_QUOTE
-;
-
-end: T_ENDMENU T_EOL { $$ = $1; }
- | T_ENDCHOICE T_EOL { $$ = $1; }
- | T_ENDIF T_EOL { $$ = $1; }
-;
-
-nl:
- T_EOL
- | nl T_EOL
-;
-
-if_expr: /* empty */ { $$ = NULL; }
- | T_IF expr { $$ = $2; }
-;
-
-expr: symbol { $$ = expr_alloc_symbol($1); }
- | symbol T_LESS symbol { $$ = expr_alloc_comp(E_LTH, $1, $3); }
- | symbol T_LESS_EQUAL symbol { $$ = expr_alloc_comp(E_LEQ, $1, $3); }
- | symbol T_GREATER symbol { $$ = expr_alloc_comp(E_GTH, $1, $3); }
- | symbol T_GREATER_EQUAL symbol { $$ = expr_alloc_comp(E_GEQ, $1, $3); }
- | symbol T_EQUAL symbol { $$ = expr_alloc_comp(E_EQUAL, $1, $3); }
- | symbol T_UNEQUAL symbol { $$ = expr_alloc_comp(E_UNEQUAL, $1, $3); }
- | T_OPEN_PAREN expr T_CLOSE_PAREN { $$ = $2; }
- | T_NOT expr { $$ = expr_alloc_one(E_NOT, $2); }
- | expr T_OR expr { $$ = expr_alloc_two(E_OR, $1, $3); }
- | expr T_AND expr { $$ = expr_alloc_two(E_AND, $1, $3); }
-;
-
-symbol: T_WORD { $$ = sym_lookup($1, 0); free($1); }
- | T_WORD_QUOTE { $$ = sym_lookup($1, SYMBOL_CONST); free($1); }
-;
-
-word_opt: /* empty */ { $$ = NULL; }
- | T_WORD
-
-%%
-
-void conf_parse(const char *name)
-{
- struct symbol *sym;
- int i;
-
- zconf_initscan(name);
-
- sym_init();
- _menu_init();
- rootmenu.prompt = menu_add_prompt(P_MENU, "Linux Kernel Configuration", NULL);
-
- if (getenv("ZCONF_DEBUG"))
- zconfdebug = 1;
- zconfparse();
- if (zconfnerrs)
- exit(1);
- if (!modules_sym)
- modules_sym = sym_find( "n" );
-
- rootmenu.prompt->text = _(rootmenu.prompt->text);
- rootmenu.prompt->text = sym_expand_string_value(rootmenu.prompt->text);
-
- menu_finalize(&rootmenu);
- for_all_symbols(i, sym) {
- if (sym_check_deps(sym))
- zconfnerrs++;
- }
- if (zconfnerrs)
- exit(1);
- sym_set_change_count(1);
-}
-
-static const char *zconf_tokenname(int token)
-{
- switch (token) {
- case T_MENU: return "menu";
- case T_ENDMENU: return "endmenu";
- case T_CHOICE: return "choice";
- case T_ENDCHOICE: return "endchoice";
- case T_IF: return "if";
- case T_ENDIF: return "endif";
- case T_DEPENDS: return "depends";
- case T_VISIBLE: return "visible";
- }
- return "<token>";
-}
-
-static bool zconf_endtoken(const struct kconf_id *id, int starttoken, int endtoken)
-{
- if (id->token != endtoken) {
- zconf_error("unexpected '%s' within %s block",
- kconf_id_strings + id->name, zconf_tokenname(starttoken));
- zconfnerrs++;
- return false;
- }
-#if 0
-//Wildcard breaks this somehow, so disabled for now. -JD
- if (current_menu->file != current_file) {
- zconf_error("'%s' in different file than '%s'",
- kconf_id_strings + id->name, zconf_tokenname(starttoken));
- fprintf(stderr, "%s:%d: location of the '%s'\n",
- current_menu->file->name, current_menu->lineno,
- zconf_tokenname(starttoken));
- zconfnerrs++;
- return false;
- }
-#endif
- return true;
-}
-
-static void zconfprint(const char *err, ...)
-{
- va_list ap;
-
- fprintf(stderr, "%s:%d: ", zconf_curname(), zconf_lineno());
- va_start(ap, err);
- vfprintf(stderr, err, ap);
- va_end(ap);
- fprintf(stderr, "\n");
-}
-
-static void zconf_error(const char *err, ...)
-{
- va_list ap;
-
- zconfnerrs++;
- fprintf(stderr, "%s:%d: ", zconf_curname(), zconf_lineno());
- va_start(ap, err);
- vfprintf(stderr, err, ap);
- va_end(ap);
- fprintf(stderr, "\n");
-}
-
-static void zconferror(const char *err)
-{
- fprintf(stderr, "%s:%d: %s\n", zconf_curname(), zconf_lineno() + 1, err);
-}
-
-static void print_quoted_string(FILE *out, const char *str)
-{
- const char *p;
- int len;
-
- putc('"', out);
- while ((p = strchr(str, '"'))) {
- len = p - str;
- if (len)
- fprintf(out, "%.*s", len, str);
- fputs("\\\"", out);
- str = p + 1;
- }
- fputs(str, out);
- putc('"', out);
-}
-
-static void print_symbol(FILE *out, struct menu *menu)
-{
- struct symbol *sym = menu->sym;
- struct property *prop;
-
- if (sym_is_choice(sym))
- fprintf(out, "\nchoice\n");
- else
- fprintf(out, "\nconfig %s\n", sym->name);
- switch (sym->type) {
- case S_BOOLEAN:
- fputs(" boolean\n", out);
- break;
- case S_TRISTATE:
- fputs(" tristate\n", out);
- break;
- case S_STRING:
- fputs(" string\n", out);
- break;
- case S_INT:
- fputs(" integer\n", out);
- break;
- case S_HEX:
- fputs(" hex\n", out);
- break;
- default:
- fputs(" ???\n", out);
- break;
- }
- for (prop = sym->prop; prop; prop = prop->next) {
- if (prop->menu != menu)
- continue;
- switch (prop->type) {
- case P_PROMPT:
- fputs(" prompt ", out);
- print_quoted_string(out, prop->text);
- if (!expr_is_yes(prop->visible.expr)) {
- fputs(" if ", out);
- expr_fprint(prop->visible.expr, out);
- }
- fputc('\n', out);
- break;
- case P_DEFAULT:
- fputs( " default ", out);
- expr_fprint(prop->expr, out);
- if (!expr_is_yes(prop->visible.expr)) {
- fputs(" if ", out);
- expr_fprint(prop->visible.expr, out);
- }
- fputc('\n', out);
- break;
- case P_CHOICE:
- fputs(" #choice value\n", out);
- break;
- case P_SELECT:
- fputs( " select ", out);
- expr_fprint(prop->expr, out);
- fputc('\n', out);
- break;
- case P_RANGE:
- fputs( " range ", out);
- expr_fprint(prop->expr, out);
- fputc('\n', out);
- break;
- case P_MENU:
- fputs( " menu ", out);
- print_quoted_string(out, prop->text);
- fputc('\n', out);
- break;
- default:
- fprintf(out, " unknown prop %d!\n", prop->type);
- break;
- }
- }
- if (menu->help) {
- int len = strlen(menu->help);
- while (menu->help[--len] == '\n')
- menu->help[len] = 0;
- fprintf(out, " help\n%s\n", menu->help);
- }
-}
-
-void zconfdump(FILE *out)
-{
- struct property *prop;
- struct symbol *sym;
- struct menu *menu;
-
- menu = rootmenu.list;
- while (menu) {
- if ((sym = menu->sym))
- print_symbol(out, menu);
- else if ((prop = menu->prompt)) {
- switch (prop->type) {
- case P_COMMENT:
- fputs("\ncomment ", out);
- print_quoted_string(out, prop->text);
- fputs("\n", out);
- break;
- case P_MENU:
- fputs("\nmenu ", out);
- print_quoted_string(out, prop->text);
- fputs("\n", out);
- break;
- default:
- ;
- }
- if (!expr_is_yes(prop->visible.expr)) {
- fputs(" depends ", out);
- expr_fprint(prop->visible.expr, out);
- fputc('\n', out);
- }
- }
-
- if (menu->list)
- menu = menu->list;
- else if (menu->next)
- menu = menu->next;
- else while ((menu = menu->parent)) {
- if (menu->prompt && menu->prompt->type == P_MENU)
- fputs("\nendmenu\n", out);
- if (menu->next) {
- menu = menu->next;
- break;
- }
- }
- }
-}
-
-#include "zconf.lex.c"
-#include "util.c"
-#include "confdata.c"
-#include "expr.c"
-#include "symbol.c"
-#include "menu.c"
"°、请",
"温度、湿度、压力、强度、浓度、高度、深度、长度、厚度、弧度、速度、角速度、仰角、倾角",
"土壤、水分、空气、毒气、天然气、液体",
- "次数、计数器、循环",
+ "次数、计数器、循环、数据",
"强中弱",
"经度、纬度",
"车、船",
"太阳、月亮",
- "接收、发送、处理、等待、心跳、探测、启动、退出、运行、重启、进出、收发包、编解码、开关机、稍候",
+ "接收、发送、处理、等待、心跳、探测、启动、退出、运行、重启、进出、收发包、编解码、开关机、稍候、同步",
"占比、比率、比例、百分比",
"每个十百千万亿兆厘毫微纳皮",
"安培、伏特、欧姆、法拉、焦耳、赫兹、牛顿、瓦特、亨利、库伦、霍尔、字节、米、秒、帕斯卡、特斯拉、开尔文、克、分钟、时、日、月、年、世纪、星期",