os_flag.c 55 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305
  1. /*
  2. *********************************************************************************************************
  3. * uC/OS-III
  4. * The Real-Time Kernel
  5. *
  6. * Copyright 2009-2022 Silicon Laboratories Inc. www.silabs.com
  7. *
  8. * SPDX-License-Identifier: APACHE-2.0
  9. *
  10. * This software is subject to an open source license and is distributed by
  11. * Silicon Laboratories Inc. pursuant to the terms of the Apache License,
  12. * Version 2.0 available at www.apache.org/licenses/LICENSE-2.0.
  13. *
  14. *********************************************************************************************************
  15. */
  16. /*
  17. *********************************************************************************************************
  18. * EVENT FLAG MANAGEMENT
  19. *
  20. * File : os_flag.c
  21. * Version : V3.08.02
  22. *********************************************************************************************************
  23. */
  24. #define MICRIUM_SOURCE
  25. #include "os.h"
  26. #ifdef VSC_INCLUDE_SOURCE_FILE_NAMES
  27. const CPU_CHAR *os_flag__c = "$Id: $";
  28. #endif
  29. #if (OS_CFG_FLAG_EN > 0u)
  30. /*
  31. ************************************************************************************************************************
  32. * CREATE AN EVENT FLAG
  33. *
  34. * Description: This function is called to create an event flag group.
  35. *
  36. * Arguments : p_grp is a pointer to the event flag group to create
  37. *
  38. * p_name is the name of the event flag group
  39. *
  40. * flags contains the initial value to store in the event flag group (typically 0).
  41. *
  42. * p_err is a pointer to an error code which will be returned to your application:
  43. *
  44. * OS_ERR_NONE If the call was successful
  45. * OS_ERR_CREATE_ISR If you attempted to create an Event Flag from an ISR
  46. * OS_ERR_ILLEGAL_CREATE_RUN_TIME If you are trying to create the Event Flag after you
  47. * called OSSafetyCriticalStart().
  48. * OS_ERR_OBJ_PTR_NULL If 'p_grp' is a NULL pointer
  49. * OS_ERR_OBJ_CREATED If the event flag was already created
  50. *
  51. * Returns : none
  52. ************************************************************************************************************************
  53. */
  54. void OSFlagCreate (OS_FLAG_GRP *p_grp,
  55. CPU_CHAR *p_name,
  56. OS_FLAGS flags,
  57. OS_ERR *p_err)
  58. {
  59. CPU_SR_ALLOC();
  60. #ifdef OS_SAFETY_CRITICAL
  61. if (p_err == (OS_ERR *)0) {
  62. OS_SAFETY_CRITICAL_EXCEPTION();
  63. return;
  64. }
  65. #endif
  66. #ifdef OS_SAFETY_CRITICAL_IEC61508
  67. if (OSSafetyCriticalStartFlag == OS_TRUE) {
  68. *p_err = OS_ERR_ILLEGAL_CREATE_RUN_TIME;
  69. return;
  70. }
  71. #endif
  72. #if (OS_CFG_CALLED_FROM_ISR_CHK_EN > 0u)
  73. if (OSIntNestingCtr > 0u) { /* See if called from ISR ... */
  74. *p_err = OS_ERR_CREATE_ISR; /* ... can't CREATE from an ISR */
  75. return;
  76. }
  77. #endif
  78. #if (OS_CFG_ARG_CHK_EN > 0u)
  79. if (p_grp == (OS_FLAG_GRP *)0) { /* Validate 'p_grp' */
  80. *p_err = OS_ERR_OBJ_PTR_NULL;
  81. return;
  82. }
  83. #endif
  84. CPU_CRITICAL_ENTER();
  85. #if (OS_OBJ_TYPE_REQ > 0u)
  86. #if (OS_CFG_OBJ_CREATED_CHK_EN > 0u)
  87. if (p_grp->Type == OS_OBJ_TYPE_FLAG) {
  88. CPU_CRITICAL_EXIT();
  89. *p_err = OS_ERR_OBJ_CREATED;
  90. return;
  91. }
  92. #endif
  93. p_grp->Type = OS_OBJ_TYPE_FLAG; /* Set to event flag group type */
  94. #endif
  95. #if (OS_CFG_DBG_EN > 0u)
  96. p_grp->NamePtr = p_name;
  97. #else
  98. (void)p_name;
  99. #endif
  100. p_grp->Flags = flags; /* Set to desired initial value */
  101. #if (OS_CFG_TS_EN > 0u)
  102. p_grp->TS = 0u;
  103. #endif
  104. OS_PendListInit(&p_grp->PendList);
  105. #if (OS_CFG_DBG_EN > 0u)
  106. OS_FlagDbgListAdd(p_grp);
  107. OSFlagQty++;
  108. #endif
  109. OS_TRACE_FLAG_CREATE(p_grp, p_name);
  110. CPU_CRITICAL_EXIT();
  111. *p_err = OS_ERR_NONE;
  112. }
  113. /*
  114. ************************************************************************************************************************
  115. * DELETE AN EVENT FLAG GROUP
  116. *
  117. * Description: This function deletes an event flag group and readies all tasks pending on the event flag group.
  118. *
  119. * Arguments : p_grp is a pointer to the desired event flag group.
  120. *
  121. * opt determines delete options as follows:
  122. *
  123. * OS_OPT_DEL_NO_PEND Deletes the event flag group ONLY if no task pending
  124. * OS_OPT_DEL_ALWAYS Deletes the event flag group even if tasks are waiting.
  125. * In this case, all the tasks pending will be readied.
  126. *
  127. * p_err is a pointer to an error code that can contain one of the following values:
  128. *
  129. * OS_ERR_NONE The call was successful and the event flag group was deleted
  130. * OS_ERR_DEL_ISR If you attempted to delete the event flag group from an ISR
  131. * OS_ERR_ILLEGAL_DEL_RUN_TIME If you are trying to delete the event flag group after you
  132. * called OSStart()
  133. * OS_ERR_OBJ_PTR_NULL If 'p_grp' is a NULL pointer
  134. * OS_ERR_OBJ_TYPE If you didn't pass a pointer to an event flag group
  135. * OS_ERR_OPT_INVALID An invalid option was specified
  136. * OS_ERR_OS_NOT_RUNNING If uC/OS-III is not running yet
  137. * OS_ERR_TASK_WAITING One or more tasks were waiting on the event flag group
  138. *
  139. * Returns : == 0 if no tasks were waiting on the event flag group, or upon error.
  140. * > 0 if one or more tasks waiting on the event flag group are now readied and informed.
  141. *
  142. * Note(s) : 1) This function must be used with care. Tasks that would normally expect the presence of the event flag
  143. * group MUST check the return code of OSFlagPost and OSFlagPend().
  144. ************************************************************************************************************************
  145. */
  146. #if (OS_CFG_FLAG_DEL_EN > 0u)
  147. OS_OBJ_QTY OSFlagDel (OS_FLAG_GRP *p_grp,
  148. OS_OPT opt,
  149. OS_ERR *p_err)
  150. {
  151. OS_OBJ_QTY nbr_tasks;
  152. OS_PEND_LIST *p_pend_list;
  153. OS_TCB *p_tcb;
  154. CPU_TS ts;
  155. CPU_SR_ALLOC();
  156. #ifdef OS_SAFETY_CRITICAL
  157. if (p_err == (OS_ERR *)0) {
  158. OS_SAFETY_CRITICAL_EXCEPTION();
  159. return (0u);
  160. }
  161. #endif
  162. OS_TRACE_FLAG_DEL_ENTER(p_grp, opt);
  163. #ifdef OS_SAFETY_CRITICAL_IEC61508
  164. if (OSSafetyCriticalStartFlag == OS_TRUE) {
  165. OS_TRACE_FLAG_DEL_EXIT(OS_ERR_ILLEGAL_DEL_RUN_TIME);
  166. *p_err = OS_ERR_ILLEGAL_DEL_RUN_TIME;
  167. return (0u);
  168. }
  169. #endif
  170. #if (OS_CFG_CALLED_FROM_ISR_CHK_EN > 0u)
  171. if (OSIntNestingCtr > 0u) { /* See if called from ISR ... */
  172. *p_err = OS_ERR_DEL_ISR; /* ... can't DELETE from an ISR */
  173. OS_TRACE_FLAG_DEL_EXIT(OS_ERR_DEL_ISR);
  174. return (0u);
  175. }
  176. #endif
  177. #if (OS_CFG_INVALID_OS_CALLS_CHK_EN > 0u)
  178. if (OSRunning != OS_STATE_OS_RUNNING) { /* Is the kernel running? */
  179. OS_TRACE_FLAG_DEL_EXIT(OS_ERR_OS_NOT_RUNNING);
  180. *p_err = OS_ERR_OS_NOT_RUNNING;
  181. return (0u);
  182. }
  183. #endif
  184. #if (OS_CFG_ARG_CHK_EN > 0u)
  185. if (p_grp == (OS_FLAG_GRP *)0) { /* Validate 'p_grp' */
  186. OS_TRACE_FLAG_DEL_EXIT(OS_ERR_OBJ_PTR_NULL);
  187. *p_err = OS_ERR_OBJ_PTR_NULL;
  188. return (0u);
  189. }
  190. #endif
  191. #if (OS_CFG_OBJ_TYPE_CHK_EN > 0u)
  192. if (p_grp->Type != OS_OBJ_TYPE_FLAG) { /* Validate event group object */
  193. OS_TRACE_FLAG_DEL_EXIT(OS_ERR_OBJ_TYPE);
  194. *p_err = OS_ERR_OBJ_TYPE;
  195. return (0u);
  196. }
  197. #endif
  198. CPU_CRITICAL_ENTER();
  199. p_pend_list = &p_grp->PendList;
  200. nbr_tasks = 0u;
  201. switch (opt) {
  202. case OS_OPT_DEL_NO_PEND: /* Delete group if no task waiting */
  203. if (p_pend_list->HeadPtr == (OS_TCB *)0) {
  204. #if (OS_CFG_DBG_EN > 0u)
  205. OS_FlagDbgListRemove(p_grp);
  206. OSFlagQty--;
  207. #endif
  208. OS_TRACE_FLAG_DEL(p_grp);
  209. OS_FlagClr(p_grp);
  210. CPU_CRITICAL_EXIT();
  211. *p_err = OS_ERR_NONE;
  212. } else {
  213. CPU_CRITICAL_EXIT();
  214. *p_err = OS_ERR_TASK_WAITING;
  215. }
  216. break;
  217. case OS_OPT_DEL_ALWAYS: /* Always delete the event flag group */
  218. #if (OS_CFG_TS_EN > 0u)
  219. ts = OS_TS_GET(); /* Get local time stamp so all tasks get the same time */
  220. #else
  221. ts = 0u;
  222. #endif
  223. while (p_pend_list->HeadPtr != (OS_TCB *)0) { /* Remove all tasks from the pend list */
  224. p_tcb = p_pend_list->HeadPtr;
  225. OS_PendAbort(p_tcb,
  226. ts,
  227. OS_STATUS_PEND_DEL);
  228. nbr_tasks++;
  229. }
  230. #if (OS_CFG_DBG_EN > 0u)
  231. OS_FlagDbgListRemove(p_grp);
  232. OSFlagQty--;
  233. #endif
  234. OS_TRACE_FLAG_DEL(p_grp);
  235. OS_FlagClr(p_grp);
  236. CPU_CRITICAL_EXIT();
  237. OSSched(); /* Find highest priority task ready to run */
  238. *p_err = OS_ERR_NONE;
  239. break;
  240. default:
  241. CPU_CRITICAL_EXIT();
  242. *p_err = OS_ERR_OPT_INVALID;
  243. break;
  244. }
  245. OS_TRACE_FLAG_DEL_EXIT(*p_err);
  246. return (nbr_tasks);
  247. }
  248. #endif
  249. /*
  250. ************************************************************************************************************************
  251. * WAIT ON AN EVENT FLAG GROUP
  252. *
  253. * Description: This function is called to wait for a combination of bits to be set in an event flag group. Your
  254. * application can wait for ANY bit to be set or ALL bits to be set.
  255. *
  256. * Arguments : p_grp is a pointer to the desired event flag group.
  257. *
  258. * flags Is a bit pattern indicating which bit(s) (i.e. flags) you wish to wait for.
  259. * The bits you want are specified by setting the corresponding bits in 'flags'.
  260. * e.g. if your application wants to wait for bits 0 and 1 then 'flags' would contain 0x03.
  261. *
  262. * timeout is an optional timeout (in clock ticks) that your task will wait for the
  263. * desired bit combination. If you specify 0, however, your task will wait
  264. * forever at the specified event flag group or, until a message arrives.
  265. *
  266. * opt specifies whether you want ALL bits to be set or ANY of the bits to be set.
  267. * You can specify the 'ONE' of the following arguments:
  268. *
  269. * OS_OPT_PEND_FLAG_CLR_ALL You will wait for ALL bits in 'flags' to be clear (0)
  270. * OS_OPT_PEND_FLAG_CLR_ANY You will wait for ANY bit in 'flags' to be clear (0)
  271. * OS_OPT_PEND_FLAG_SET_ALL You will wait for ALL bits in 'flags' to be set (1)
  272. * OS_OPT_PEND_FLAG_SET_ANY You will wait for ANY bit in 'flags' to be set (1)
  273. *
  274. * You can 'ADD' OS_OPT_PEND_FLAG_CONSUME if you want the event flag to be 'consumed' by
  275. * the call. Example, to wait for any flag in a group AND then clear
  276. * the flags that are present, set 'wait_opt' to:
  277. *
  278. * OS_OPT_PEND_FLAG_SET_ANY + OS_OPT_PEND_FLAG_CONSUME
  279. *
  280. * You can also 'ADD' the type of pend with 'ONE' of the two option:
  281. *
  282. * OS_OPT_PEND_NON_BLOCKING Task will NOT block if flags are not available
  283. * OS_OPT_PEND_BLOCKING Task will block if flags are not available
  284. *
  285. * p_ts is a pointer to a variable that will receive the timestamp of when the event flag group was
  286. * posted, aborted or the event flag group deleted. If you pass a NULL pointer (i.e. (CPU_TS *)0)
  287. * then you will not get the timestamp. In other words, passing a NULL pointer is valid and
  288. * indicates that you don't need the timestamp.
  289. *
  290. * p_err is a pointer to an error code and can be:
  291. *
  292. * OS_ERR_NONE The desired bits have been set within the specified 'timeout'
  293. * OS_ERR_OBJ_DEL If the event group was deleted
  294. * OS_ERR_OBJ_PTR_NULL If 'p_grp' is a NULL pointer.
  295. * OS_ERR_OBJ_TYPE You are not pointing to an event flag group
  296. * OS_ERR_OPT_INVALID You didn't specify a proper 'opt' argument
  297. * OS_ERR_OS_NOT_RUNNING If uC/OS-III is not running yet
  298. * OS_ERR_PEND_ABORT The wait on the flag was aborted
  299. * OS_ERR_PEND_ISR If you tried to PEND from an ISR
  300. * OS_ERR_PEND_WOULD_BLOCK If you specified non-blocking but the flags were not
  301. * available
  302. * OS_ERR_SCHED_LOCKED If you called this function when the scheduler is locked
  303. * OS_ERR_STATUS_INVALID If the pend status has an invalid value
  304. * OS_ERR_TIMEOUT The bit(s) have not been set in the specified 'timeout'
  305. * OS_ERR_TICK_DISABLED If kernel ticks are disabled and a timeout is specified
  306. *
  307. * Returns : The flags in the event flag group that made the task ready or, 0 if a timeout or an error
  308. * occurred.
  309. *
  310. * Note(s) : This API 'MUST NOT' be called from a timer callback function.
  311. ************************************************************************************************************************
  312. */
  313. OS_FLAGS OSFlagPend (OS_FLAG_GRP *p_grp,
  314. OS_FLAGS flags,
  315. OS_TICK timeout,
  316. OS_OPT opt,
  317. CPU_TS *p_ts,
  318. OS_ERR *p_err)
  319. {
  320. CPU_BOOLEAN consume;
  321. OS_FLAGS flags_rdy;
  322. OS_OPT mode;
  323. CPU_SR_ALLOC();
  324. #ifdef OS_SAFETY_CRITICAL
  325. if (p_err == (OS_ERR *)0) {
  326. OS_SAFETY_CRITICAL_EXCEPTION();
  327. return (0u);
  328. }
  329. #endif
  330. OS_TRACE_FLAG_PEND_ENTER(p_grp, flags, timeout, opt, p_ts);
  331. #if (OS_CFG_TICK_EN == 0u)
  332. if (timeout != 0u) {
  333. *p_err = OS_ERR_TICK_DISABLED;
  334. OS_TRACE_FLAG_PEND_FAILED(p_grp);
  335. OS_TRACE_FLAG_PEND_EXIT(OS_ERR_TICK_DISABLED);
  336. return ((OS_FLAGS)0);
  337. }
  338. #endif
  339. #if (OS_CFG_CALLED_FROM_ISR_CHK_EN > 0u)
  340. if (OSIntNestingCtr > 0u) { /* See if called from ISR ... */
  341. if ((opt & OS_OPT_PEND_NON_BLOCKING) != OS_OPT_PEND_NON_BLOCKING) {
  342. *p_err = OS_ERR_PEND_ISR; /* ... can't PEND from an ISR */
  343. OS_TRACE_FLAG_PEND_FAILED(p_grp);
  344. OS_TRACE_FLAG_PEND_EXIT(OS_ERR_PEND_ISR);
  345. return ((OS_FLAGS)0);
  346. }
  347. }
  348. #endif
  349. #if (OS_CFG_INVALID_OS_CALLS_CHK_EN > 0u)
  350. if (OSRunning != OS_STATE_OS_RUNNING) { /* Is the kernel running? */
  351. OS_TRACE_FLAG_PEND_EXIT(OS_ERR_OS_NOT_RUNNING);
  352. *p_err = OS_ERR_OS_NOT_RUNNING;
  353. return (0u);
  354. }
  355. #endif
  356. #if (OS_CFG_ARG_CHK_EN > 0u)
  357. if (p_grp == (OS_FLAG_GRP *)0) { /* Validate 'p_grp' */
  358. OS_TRACE_FLAG_PEND_FAILED(p_grp);
  359. OS_TRACE_FLAG_PEND_EXIT(OS_ERR_OBJ_PTR_NULL);
  360. *p_err = OS_ERR_OBJ_PTR_NULL;
  361. return (0u);
  362. }
  363. switch (opt) { /* Validate 'opt' */
  364. case OS_OPT_PEND_FLAG_CLR_ALL:
  365. case OS_OPT_PEND_FLAG_CLR_ANY:
  366. case OS_OPT_PEND_FLAG_SET_ALL:
  367. case OS_OPT_PEND_FLAG_SET_ANY:
  368. case OS_OPT_PEND_FLAG_CLR_ALL | OS_OPT_PEND_FLAG_CONSUME:
  369. case OS_OPT_PEND_FLAG_CLR_ANY | OS_OPT_PEND_FLAG_CONSUME:
  370. case OS_OPT_PEND_FLAG_SET_ALL | OS_OPT_PEND_FLAG_CONSUME:
  371. case OS_OPT_PEND_FLAG_SET_ANY | OS_OPT_PEND_FLAG_CONSUME:
  372. case OS_OPT_PEND_FLAG_CLR_ALL | OS_OPT_PEND_NON_BLOCKING:
  373. case OS_OPT_PEND_FLAG_CLR_ANY | OS_OPT_PEND_NON_BLOCKING:
  374. case OS_OPT_PEND_FLAG_SET_ALL | OS_OPT_PEND_NON_BLOCKING:
  375. case OS_OPT_PEND_FLAG_SET_ANY | OS_OPT_PEND_NON_BLOCKING:
  376. case OS_OPT_PEND_FLAG_CLR_ALL | (OS_OPT)(OS_OPT_PEND_FLAG_CONSUME | OS_OPT_PEND_NON_BLOCKING):
  377. case OS_OPT_PEND_FLAG_CLR_ANY | (OS_OPT)(OS_OPT_PEND_FLAG_CONSUME | OS_OPT_PEND_NON_BLOCKING):
  378. case OS_OPT_PEND_FLAG_SET_ALL | (OS_OPT)(OS_OPT_PEND_FLAG_CONSUME | OS_OPT_PEND_NON_BLOCKING):
  379. case OS_OPT_PEND_FLAG_SET_ANY | (OS_OPT)(OS_OPT_PEND_FLAG_CONSUME | OS_OPT_PEND_NON_BLOCKING):
  380. break;
  381. default:
  382. OS_TRACE_FLAG_PEND_FAILED(p_grp);
  383. OS_TRACE_FLAG_PEND_EXIT(OS_ERR_OPT_INVALID);
  384. *p_err = OS_ERR_OPT_INVALID;
  385. return (0u);
  386. }
  387. #endif
  388. #if (OS_CFG_OBJ_TYPE_CHK_EN > 0u)
  389. if (p_grp->Type != OS_OBJ_TYPE_FLAG) { /* Validate that we are pointing at an event flag */
  390. OS_TRACE_FLAG_PEND_FAILED(p_grp);
  391. OS_TRACE_FLAG_PEND_EXIT(OS_ERR_OBJ_TYPE);
  392. *p_err = OS_ERR_OBJ_TYPE;
  393. return (0u);
  394. }
  395. #endif
  396. if ((opt & OS_OPT_PEND_FLAG_CONSUME) != 0u) { /* See if we need to consume the flags */
  397. consume = OS_TRUE;
  398. } else {
  399. consume = OS_FALSE;
  400. }
  401. if (p_ts != (CPU_TS *)0) {
  402. *p_ts = 0u; /* Initialize the returned timestamp */
  403. }
  404. mode = opt & OS_OPT_PEND_FLAG_MASK;
  405. CPU_CRITICAL_ENTER();
  406. switch (mode) {
  407. case OS_OPT_PEND_FLAG_SET_ALL: /* See if all required flags are set */
  408. flags_rdy = (p_grp->Flags & flags); /* Extract only the bits we want */
  409. if (flags_rdy == flags) { /* Must match ALL the bits that we want */
  410. if (consume == OS_TRUE) { /* See if we need to consume the flags */
  411. p_grp->Flags &= ~flags_rdy; /* Clear ONLY the flags that we wanted */
  412. }
  413. OSTCBCurPtr->FlagsRdy = flags_rdy; /* Save flags that were ready */
  414. #if (OS_CFG_TS_EN > 0u)
  415. if (p_ts != (CPU_TS *)0) {
  416. *p_ts = p_grp->TS;
  417. }
  418. #endif
  419. CPU_CRITICAL_EXIT(); /* Yes, condition met, return to caller */
  420. OS_TRACE_FLAG_PEND(p_grp);
  421. OS_TRACE_FLAG_PEND_EXIT(OS_ERR_NONE);
  422. *p_err = OS_ERR_NONE;
  423. return (flags_rdy);
  424. } else { /* Block task until events occur or timeout */
  425. if ((opt & OS_OPT_PEND_NON_BLOCKING) != 0u) {
  426. CPU_CRITICAL_EXIT();
  427. OS_TRACE_FLAG_PEND_FAILED(p_grp);
  428. OS_TRACE_FLAG_PEND_EXIT(OS_ERR_PEND_WOULD_BLOCK);
  429. *p_err = OS_ERR_PEND_WOULD_BLOCK; /* Specified non-blocking so task would block */
  430. return ((OS_FLAGS)0);
  431. } else { /* Specified blocking so check is scheduler is locked */
  432. if (OSSchedLockNestingCtr > 0u) { /* See if called with scheduler locked ... */
  433. CPU_CRITICAL_EXIT();
  434. OS_TRACE_FLAG_PEND_FAILED(p_grp);
  435. OS_TRACE_FLAG_PEND_EXIT(OS_ERR_SCHED_LOCKED);
  436. *p_err = OS_ERR_SCHED_LOCKED; /* ... can't PEND when locked */
  437. return (0u);
  438. }
  439. }
  440. /* Lock the scheduler/re-enable interrupts */
  441. OS_FlagBlock(p_grp,
  442. flags,
  443. opt,
  444. timeout);
  445. CPU_CRITICAL_EXIT();
  446. }
  447. break;
  448. case OS_OPT_PEND_FLAG_SET_ANY:
  449. flags_rdy = (p_grp->Flags & flags); /* Extract only the bits we want */
  450. if (flags_rdy != 0u) { /* See if any flag set */
  451. if (consume == OS_TRUE) { /* See if we need to consume the flags */
  452. p_grp->Flags &= ~flags_rdy; /* Clear ONLY the flags that we got */
  453. }
  454. OSTCBCurPtr->FlagsRdy = flags_rdy; /* Save flags that were ready */
  455. #if (OS_CFG_TS_EN > 0u)
  456. if (p_ts != (CPU_TS *)0) {
  457. *p_ts = p_grp->TS;
  458. }
  459. #endif
  460. CPU_CRITICAL_EXIT(); /* Yes, condition met, return to caller */
  461. OS_TRACE_FLAG_PEND(p_grp);
  462. OS_TRACE_FLAG_PEND_EXIT(OS_ERR_NONE);
  463. *p_err = OS_ERR_NONE;
  464. return (flags_rdy);
  465. } else { /* Block task until events occur or timeout */
  466. if ((opt & OS_OPT_PEND_NON_BLOCKING) != 0u) {
  467. CPU_CRITICAL_EXIT();
  468. OS_TRACE_FLAG_PEND_EXIT(OS_ERR_PEND_WOULD_BLOCK);
  469. *p_err = OS_ERR_PEND_WOULD_BLOCK; /* Specified non-blocking so task would block */
  470. return ((OS_FLAGS)0);
  471. } else { /* Specified blocking so check is scheduler is locked */
  472. if (OSSchedLockNestingCtr > 0u) { /* See if called with scheduler locked ... */
  473. CPU_CRITICAL_EXIT();
  474. OS_TRACE_FLAG_PEND_EXIT(OS_ERR_SCHED_LOCKED);
  475. *p_err = OS_ERR_SCHED_LOCKED; /* ... can't PEND when locked */
  476. return ((OS_FLAGS)0);
  477. }
  478. }
  479. OS_FlagBlock(p_grp,
  480. flags,
  481. opt,
  482. timeout);
  483. CPU_CRITICAL_EXIT();
  484. }
  485. break;
  486. #if (OS_CFG_FLAG_MODE_CLR_EN > 0u)
  487. case OS_OPT_PEND_FLAG_CLR_ALL: /* See if all required flags are cleared */
  488. flags_rdy = (OS_FLAGS)(~p_grp->Flags & flags); /* Extract only the bits we want */
  489. if (flags_rdy == flags) { /* Must match ALL the bits that we want */
  490. if (consume == OS_TRUE) { /* See if we need to consume the flags */
  491. p_grp->Flags |= flags_rdy; /* Set ONLY the flags that we wanted */
  492. }
  493. OSTCBCurPtr->FlagsRdy = flags_rdy; /* Save flags that were ready */
  494. #if (OS_CFG_TS_EN > 0u)
  495. if (p_ts != (CPU_TS *)0) {
  496. *p_ts = p_grp->TS;
  497. }
  498. #endif
  499. CPU_CRITICAL_EXIT(); /* Yes, condition met, return to caller */
  500. OS_TRACE_FLAG_PEND(p_grp);
  501. OS_TRACE_FLAG_PEND_EXIT(OS_ERR_NONE);
  502. *p_err = OS_ERR_NONE;
  503. return (flags_rdy);
  504. } else { /* Block task until events occur or timeout */
  505. if ((opt & OS_OPT_PEND_NON_BLOCKING) != 0u) {
  506. CPU_CRITICAL_EXIT();
  507. OS_TRACE_FLAG_PEND_EXIT(OS_ERR_PEND_WOULD_BLOCK);
  508. *p_err = OS_ERR_PEND_WOULD_BLOCK; /* Specified non-blocking so task would block */
  509. return ((OS_FLAGS)0);
  510. } else { /* Specified blocking so check is scheduler is locked */
  511. if (OSSchedLockNestingCtr > 0u) { /* See if called with scheduler locked ... */
  512. CPU_CRITICAL_EXIT();
  513. OS_TRACE_FLAG_PEND_EXIT(OS_ERR_SCHED_LOCKED);
  514. *p_err = OS_ERR_SCHED_LOCKED; /* ... can't PEND when locked */
  515. return (0);
  516. }
  517. }
  518. OS_FlagBlock(p_grp,
  519. flags,
  520. opt,
  521. timeout);
  522. CPU_CRITICAL_EXIT();
  523. }
  524. break;
  525. case OS_OPT_PEND_FLAG_CLR_ANY:
  526. flags_rdy = (~p_grp->Flags & flags); /* Extract only the bits we want */
  527. if (flags_rdy != 0u) { /* See if any flag cleared */
  528. if (consume == OS_TRUE) { /* See if we need to consume the flags */
  529. p_grp->Flags |= flags_rdy; /* Set ONLY the flags that we got */
  530. }
  531. OSTCBCurPtr->FlagsRdy = flags_rdy; /* Save flags that were ready */
  532. #if (OS_CFG_TS_EN > 0u)
  533. if (p_ts != (CPU_TS *)0) {
  534. *p_ts = p_grp->TS;
  535. }
  536. #endif
  537. CPU_CRITICAL_EXIT(); /* Yes, condition met, return to caller */
  538. OS_TRACE_FLAG_PEND(p_grp);
  539. OS_TRACE_FLAG_PEND_EXIT(OS_ERR_NONE);
  540. *p_err = OS_ERR_NONE;
  541. return (flags_rdy);
  542. } else { /* Block task until events occur or timeout */
  543. if ((opt & OS_OPT_PEND_NON_BLOCKING) != 0u) {
  544. CPU_CRITICAL_EXIT();
  545. OS_TRACE_FLAG_PEND_EXIT(OS_ERR_PEND_WOULD_BLOCK);
  546. *p_err = OS_ERR_PEND_WOULD_BLOCK; /* Specified non-blocking so task would block */
  547. return ((OS_FLAGS)0);
  548. } else { /* Specified blocking so check is scheduler is locked */
  549. if (OSSchedLockNestingCtr > 0u) { /* See if called with scheduler locked ... */
  550. CPU_CRITICAL_EXIT();
  551. OS_TRACE_FLAG_PEND_EXIT(OS_ERR_SCHED_LOCKED);
  552. *p_err = OS_ERR_SCHED_LOCKED; /* ... can't PEND when locked */
  553. return (0u);
  554. }
  555. }
  556. OS_FlagBlock(p_grp,
  557. flags,
  558. opt,
  559. timeout);
  560. CPU_CRITICAL_EXIT();
  561. }
  562. break;
  563. #endif
  564. default:
  565. CPU_CRITICAL_EXIT();
  566. OS_TRACE_FLAG_PEND_FAILED(p_grp);
  567. OS_TRACE_FLAG_PEND_EXIT(OS_ERR_OPT_INVALID);
  568. *p_err = OS_ERR_OPT_INVALID;
  569. return (0u);
  570. }
  571. OS_TRACE_FLAG_PEND_BLOCK(p_grp);
  572. OSSched(); /* Find next HPT ready to run */
  573. CPU_CRITICAL_ENTER();
  574. switch (OSTCBCurPtr->PendStatus) {
  575. case OS_STATUS_PEND_OK: /* We got the event flags */
  576. #if (OS_CFG_TS_EN > 0u)
  577. if (p_ts != (CPU_TS *)0) {
  578. *p_ts = OSTCBCurPtr->TS;
  579. }
  580. #endif
  581. OS_TRACE_FLAG_PEND(p_grp);
  582. *p_err = OS_ERR_NONE;
  583. break;
  584. case OS_STATUS_PEND_ABORT: /* Indicate that we aborted */
  585. #if (OS_CFG_TS_EN > 0u)
  586. if (p_ts != (CPU_TS *)0) {
  587. *p_ts = OSTCBCurPtr->TS;
  588. }
  589. #endif
  590. CPU_CRITICAL_EXIT();
  591. OS_TRACE_FLAG_PEND_FAILED(p_grp);
  592. *p_err = OS_ERR_PEND_ABORT;
  593. break;
  594. case OS_STATUS_PEND_TIMEOUT: /* Indicate that we didn't get semaphore within timeout */
  595. if (p_ts != (CPU_TS *)0) {
  596. *p_ts = 0u;
  597. }
  598. CPU_CRITICAL_EXIT();
  599. OS_TRACE_FLAG_PEND_FAILED(p_grp);
  600. *p_err = OS_ERR_TIMEOUT;
  601. break;
  602. case OS_STATUS_PEND_DEL: /* Indicate that object pended on has been deleted */
  603. #if (OS_CFG_TS_EN > 0u)
  604. if (p_ts != (CPU_TS *)0) {
  605. *p_ts = OSTCBCurPtr->TS;
  606. }
  607. #endif
  608. CPU_CRITICAL_EXIT();
  609. OS_TRACE_FLAG_PEND_FAILED(p_grp);
  610. *p_err = OS_ERR_OBJ_DEL;
  611. break;
  612. default:
  613. CPU_CRITICAL_EXIT();
  614. OS_TRACE_FLAG_PEND_FAILED(p_grp);
  615. *p_err = OS_ERR_STATUS_INVALID;
  616. break;
  617. }
  618. if (*p_err != OS_ERR_NONE) {
  619. OS_TRACE_FLAG_PEND_EXIT(*p_err);
  620. return (0u);
  621. }
  622. flags_rdy = OSTCBCurPtr->FlagsRdy;
  623. if (consume == OS_TRUE) { /* See if we need to consume the flags */
  624. switch (mode) {
  625. case OS_OPT_PEND_FLAG_SET_ALL:
  626. case OS_OPT_PEND_FLAG_SET_ANY: /* Clear ONLY the flags we got */
  627. p_grp->Flags &= ~flags_rdy;
  628. break;
  629. #if (OS_CFG_FLAG_MODE_CLR_EN > 0u)
  630. case OS_OPT_PEND_FLAG_CLR_ALL:
  631. case OS_OPT_PEND_FLAG_CLR_ANY: /* Set ONLY the flags we got */
  632. p_grp->Flags |= flags_rdy;
  633. break;
  634. #endif
  635. default:
  636. CPU_CRITICAL_EXIT();
  637. OS_TRACE_FLAG_PEND_EXIT(OS_ERR_OPT_INVALID);
  638. *p_err = OS_ERR_OPT_INVALID;
  639. return (0u);
  640. }
  641. }
  642. CPU_CRITICAL_EXIT();
  643. OS_TRACE_FLAG_PEND_EXIT(OS_ERR_NONE);
  644. *p_err = OS_ERR_NONE; /* Event(s) must have occurred */
  645. return (flags_rdy);
  646. }
  647. /*
  648. ************************************************************************************************************************
  649. * ABORT WAITING ON AN EVENT FLAG GROUP
  650. *
  651. * Description: This function aborts & readies any tasks currently waiting on an event flag group. This function should
  652. * be used to fault-abort the wait on the event flag group, rather than to normally post to the event flag
  653. * group OSFlagPost().
  654. *
  655. * Arguments : p_grp is a pointer to the event flag group
  656. *
  657. * opt determines the type of ABORT performed:
  658. *
  659. * OS_OPT_PEND_ABORT_1 ABORT wait for a single task (HPT) waiting on the event flag
  660. * OS_OPT_PEND_ABORT_ALL ABORT wait for ALL tasks that are waiting on the event flag
  661. * OS_OPT_POST_NO_SCHED Do not call the scheduler
  662. *
  663. * p_err is a pointer to a variable that will contain an error code returned by this function.
  664. *
  665. * OS_ERR_NONE At least one task waiting on the event flag group and was
  666. * readied and informed of the aborted wait; check return value
  667. * for the number of tasks whose wait on the event flag group
  668. * was aborted
  669. * OS_ERR_OBJ_PTR_NULL If 'p_grp' is a NULL pointer
  670. * OS_ERR_OBJ_TYPE If 'p_grp' is not pointing at an event flag group
  671. * OS_ERR_OPT_INVALID If you specified an invalid option
  672. * OS_ERR_OS_NOT_RUNNING If uC/OS-III is not running yet
  673. * OS_ERR_PEND_ABORT_ISR If you called this function from an ISR
  674. * OS_ERR_PEND_ABORT_NONE No task were pending
  675. *
  676. * Returns : == 0 if no tasks were waiting on the event flag group, or upon error.
  677. * > 0 if one or more tasks waiting on the event flag group are now readied and informed.
  678. *
  679. * Note(s) : none
  680. ************************************************************************************************************************
  681. */
  682. #if (OS_CFG_FLAG_PEND_ABORT_EN > 0u)
  683. OS_OBJ_QTY OSFlagPendAbort (OS_FLAG_GRP *p_grp,
  684. OS_OPT opt,
  685. OS_ERR *p_err)
  686. {
  687. OS_PEND_LIST *p_pend_list;
  688. OS_TCB *p_tcb;
  689. CPU_TS ts;
  690. OS_OBJ_QTY nbr_tasks;
  691. CPU_SR_ALLOC();
  692. #ifdef OS_SAFETY_CRITICAL
  693. if (p_err == (OS_ERR *)0) {
  694. OS_SAFETY_CRITICAL_EXCEPTION();
  695. return ((OS_OBJ_QTY)0u);
  696. }
  697. #endif
  698. #if (OS_CFG_CALLED_FROM_ISR_CHK_EN > 0u)
  699. if (OSIntNestingCtr > 0u) { /* Not allowed to Pend Abort from an ISR */
  700. *p_err = OS_ERR_PEND_ABORT_ISR;
  701. return (0u);
  702. }
  703. #endif
  704. #if (OS_CFG_INVALID_OS_CALLS_CHK_EN > 0u)
  705. if (OSRunning != OS_STATE_OS_RUNNING) { /* Is the kernel running? */
  706. *p_err = OS_ERR_OS_NOT_RUNNING;
  707. return (0u);
  708. }
  709. #endif
  710. #if (OS_CFG_ARG_CHK_EN > 0u)
  711. if (p_grp == (OS_FLAG_GRP *)0) { /* Validate 'p_grp' */
  712. *p_err = OS_ERR_OBJ_PTR_NULL;
  713. return (0u);
  714. }
  715. switch (opt) { /* Validate 'opt' */
  716. case OS_OPT_PEND_ABORT_1:
  717. case OS_OPT_PEND_ABORT_ALL:
  718. case OS_OPT_PEND_ABORT_1 | OS_OPT_POST_NO_SCHED:
  719. case OS_OPT_PEND_ABORT_ALL | OS_OPT_POST_NO_SCHED:
  720. break;
  721. default:
  722. *p_err = OS_ERR_OPT_INVALID;
  723. return (0u);
  724. }
  725. #endif
  726. #if (OS_CFG_OBJ_TYPE_CHK_EN > 0u)
  727. if (p_grp->Type != OS_OBJ_TYPE_FLAG) { /* Make sure event flag group was created */
  728. *p_err = OS_ERR_OBJ_TYPE;
  729. return (0u);
  730. }
  731. #endif
  732. CPU_CRITICAL_ENTER();
  733. p_pend_list = &p_grp->PendList;
  734. if (p_pend_list->HeadPtr == (OS_TCB *)0) { /* Any task waiting on flag group? */
  735. CPU_CRITICAL_EXIT(); /* No */
  736. *p_err = OS_ERR_PEND_ABORT_NONE;
  737. return (0u);
  738. }
  739. nbr_tasks = 0u;
  740. #if (OS_CFG_TS_EN > 0u)
  741. ts = OS_TS_GET(); /* Get local time stamp so all tasks get the same time */
  742. #else
  743. ts = 0u;
  744. #endif
  745. while (p_pend_list->HeadPtr != (OS_TCB *)0) {
  746. p_tcb = p_pend_list->HeadPtr;
  747. OS_PendAbort(p_tcb,
  748. ts,
  749. OS_STATUS_PEND_ABORT);
  750. nbr_tasks++;
  751. if (opt != OS_OPT_PEND_ABORT_ALL) { /* Pend abort all tasks waiting? */
  752. break; /* No */
  753. }
  754. }
  755. CPU_CRITICAL_EXIT();
  756. if ((opt & OS_OPT_POST_NO_SCHED) == 0u) {
  757. OSSched(); /* Run the scheduler */
  758. }
  759. *p_err = OS_ERR_NONE;
  760. return (nbr_tasks);
  761. }
  762. #endif
  763. /*
  764. ************************************************************************************************************************
  765. * GET FLAGS WHO CAUSED TASK TO BECOME READY
  766. *
  767. * Description: This function is called to obtain the flags that caused the task to become ready to run.
  768. * In other words, this function allows you to tell "Who done it!".
  769. *
  770. * Arguments : p_err is a pointer to an error code
  771. *
  772. * OS_ERR_NONE If the call was successful
  773. * OS_ERR_OS_NOT_RUNNING If uC/OS-III is not running yet
  774. * OS_ERR_PEND_ISR If called from an ISR
  775. *
  776. * Returns : The flags that caused the task to be ready.
  777. *
  778. * Note(s) : none
  779. ************************************************************************************************************************
  780. */
  781. OS_FLAGS OSFlagPendGetFlagsRdy (OS_ERR *p_err)
  782. {
  783. OS_FLAGS flags;
  784. CPU_SR_ALLOC();
  785. #ifdef OS_SAFETY_CRITICAL
  786. if (p_err == (OS_ERR *)0) {
  787. OS_SAFETY_CRITICAL_EXCEPTION();
  788. return ((OS_FLAGS)0);
  789. }
  790. #endif
  791. #if (OS_CFG_INVALID_OS_CALLS_CHK_EN > 0u)
  792. if (OSRunning != OS_STATE_OS_RUNNING) { /* Is the kernel running? */
  793. *p_err = OS_ERR_OS_NOT_RUNNING;
  794. return (0u);
  795. }
  796. #endif
  797. #if (OS_CFG_CALLED_FROM_ISR_CHK_EN > 0u)
  798. if (OSIntNestingCtr > 0u) { /* See if called from ISR ... */
  799. *p_err = OS_ERR_PEND_ISR; /* ... can't get from an ISR */
  800. return (0u);
  801. }
  802. #endif
  803. CPU_CRITICAL_ENTER();
  804. flags = OSTCBCurPtr->FlagsRdy;
  805. CPU_CRITICAL_EXIT();
  806. *p_err = OS_ERR_NONE;
  807. return (flags);
  808. }
  809. /*
  810. ************************************************************************************************************************
  811. * POST EVENT FLAG BIT(S)
  812. *
  813. * Description: This function is called to set or clear some bits in an event flag group. The bits to set or clear are
  814. * specified by a 'bit mask'.
  815. *
  816. * Arguments : p_grp is a pointer to the desired event flag group.
  817. *
  818. * flags If 'opt' (see below) is OS_OPT_POST_FLAG_SET, each bit that is set in 'flags' will
  819. * set the corresponding bit in the event flag group. e.g. to set bits 0, 4
  820. * and 5 you would set 'flags' to:
  821. *
  822. * 0x31 (note, bit 0 is least significant bit)
  823. *
  824. * If 'opt' (see below) is OS_OPT_POST_FLAG_CLR, each bit that is set in 'flags' will
  825. * CLEAR the corresponding bit in the event flag group. e.g. to clear bits 0,
  826. * 4 and 5 you would specify 'flags' as:
  827. *
  828. * 0x31 (note, bit 0 is least significant bit)
  829. *
  830. * opt indicates whether the flags will be:
  831. *
  832. * OS_OPT_POST_FLAG_SET set
  833. * OS_OPT_POST_FLAG_CLR cleared
  834. *
  835. * you can also 'add' OS_OPT_POST_NO_SCHED to prevent the scheduler from being called.
  836. *
  837. * p_err is a pointer to an error code and can be:
  838. *
  839. * OS_ERR_NONE The call was successful
  840. * OS_ERR_OBJ_PTR_NULL You passed a NULL pointer
  841. * OS_ERR_OBJ_TYPE You are not pointing to an event flag group
  842. * OS_ERR_OPT_INVALID You specified an invalid option
  843. * OS_ERR_OS_NOT_RUNNING If uC/OS-III is not running yet
  844. *
  845. * Returns : the new value of the event flags bits that are still set.
  846. *
  847. * Note(s) : 1) The execution time of this function depends on the number of tasks waiting on the event flag group.
  848. ************************************************************************************************************************
  849. */
  850. OS_FLAGS OSFlagPost (OS_FLAG_GRP *p_grp,
  851. OS_FLAGS flags,
  852. OS_OPT opt,
  853. OS_ERR *p_err)
  854. {
  855. OS_FLAGS flags_cur;
  856. OS_FLAGS flags_rdy;
  857. OS_OPT mode;
  858. OS_PEND_LIST *p_pend_list;
  859. OS_TCB *p_tcb;
  860. OS_TCB *p_tcb_next;
  861. CPU_TS ts;
  862. CPU_SR_ALLOC();
  863. #ifdef OS_SAFETY_CRITICAL
  864. if (p_err == (OS_ERR *)0) {
  865. OS_SAFETY_CRITICAL_EXCEPTION();
  866. return (0u);
  867. }
  868. #endif
  869. OS_TRACE_FLAG_POST_ENTER(p_grp, flags, opt);
  870. #if (OS_CFG_INVALID_OS_CALLS_CHK_EN > 0u)
  871. if (OSRunning != OS_STATE_OS_RUNNING) { /* Is the kernel running? */
  872. OS_TRACE_FLAG_POST_EXIT(OS_ERR_OS_NOT_RUNNING);
  873. *p_err = OS_ERR_OS_NOT_RUNNING;
  874. return (0u);
  875. }
  876. #endif
  877. #if (OS_CFG_ARG_CHK_EN > 0u)
  878. if (p_grp == (OS_FLAG_GRP *)0) { /* Validate 'p_grp' */
  879. OS_TRACE_FLAG_POST_FAILED(p_grp);
  880. OS_TRACE_FLAG_POST_EXIT(OS_ERR_OBJ_PTR_NULL);
  881. *p_err = OS_ERR_OBJ_PTR_NULL;
  882. return (0u);
  883. }
  884. #endif
  885. #if (OS_CFG_OBJ_TYPE_CHK_EN > 0u)
  886. if (p_grp->Type != OS_OBJ_TYPE_FLAG) { /* Make sure we are pointing to an event flag grp */
  887. OS_TRACE_FLAG_POST_FAILED(p_grp);
  888. OS_TRACE_FLAG_POST_EXIT(OS_ERR_OBJ_TYPE);
  889. *p_err = OS_ERR_OBJ_TYPE;
  890. return (0u);
  891. }
  892. #endif
  893. #if (OS_CFG_TS_EN > 0u)
  894. ts = OS_TS_GET(); /* Get timestamp */
  895. #else
  896. ts = 0u;
  897. #endif
  898. OS_TRACE_FLAG_POST(p_grp);
  899. switch (opt) {
  900. case OS_OPT_POST_FLAG_SET:
  901. case OS_OPT_POST_FLAG_SET | OS_OPT_POST_NO_SCHED:
  902. CPU_CRITICAL_ENTER();
  903. p_grp->Flags |= flags; /* Set the flags specified in the group */
  904. break;
  905. case OS_OPT_POST_FLAG_CLR:
  906. case OS_OPT_POST_FLAG_CLR | OS_OPT_POST_NO_SCHED:
  907. CPU_CRITICAL_ENTER();
  908. p_grp->Flags &= ~flags; /* Clear the flags specified in the group */
  909. break;
  910. default:
  911. *p_err = OS_ERR_OPT_INVALID; /* INVALID option */
  912. OS_TRACE_FLAG_POST_EXIT(*p_err);
  913. return (0u);
  914. }
  915. #if (OS_CFG_TS_EN > 0u)
  916. p_grp->TS = ts;
  917. #endif
  918. p_pend_list = &p_grp->PendList;
  919. if (p_pend_list->HeadPtr == (OS_TCB *)0) { /* Any task waiting on event flag group? */
  920. CPU_CRITICAL_EXIT(); /* No */
  921. *p_err = OS_ERR_NONE;
  922. OS_TRACE_FLAG_POST_EXIT(*p_err);
  923. return (p_grp->Flags);
  924. }
  925. p_tcb = p_pend_list->HeadPtr;
  926. while (p_tcb != (OS_TCB *)0) { /* Go through all tasks waiting on event flag(s) */
  927. p_tcb_next = p_tcb->PendNextPtr;
  928. mode = p_tcb->FlagsOpt & OS_OPT_PEND_FLAG_MASK;
  929. switch (mode) {
  930. case OS_OPT_PEND_FLAG_SET_ALL: /* See if all req. flags are set for current node */
  931. flags_rdy = (p_grp->Flags & p_tcb->FlagsPend);
  932. if (flags_rdy == p_tcb->FlagsPend) {
  933. OS_FlagTaskRdy(p_tcb, /* Make task RTR, event(s) Rx'd */
  934. flags_rdy,
  935. ts);
  936. }
  937. break;
  938. case OS_OPT_PEND_FLAG_SET_ANY: /* See if any flag set */
  939. flags_rdy = (p_grp->Flags & p_tcb->FlagsPend);
  940. if (flags_rdy != 0u) {
  941. OS_FlagTaskRdy(p_tcb, /* Make task RTR, event(s) Rx'd */
  942. flags_rdy,
  943. ts);
  944. }
  945. break;
  946. #if (OS_CFG_FLAG_MODE_CLR_EN > 0u)
  947. case OS_OPT_PEND_FLAG_CLR_ALL: /* See if all req. flags are set for current node */
  948. flags_rdy = (OS_FLAGS)(~p_grp->Flags & p_tcb->FlagsPend);
  949. if (flags_rdy == p_tcb->FlagsPend) {
  950. OS_FlagTaskRdy(p_tcb, /* Make task RTR, event(s) Rx'd */
  951. flags_rdy,
  952. ts);
  953. }
  954. break;
  955. case OS_OPT_PEND_FLAG_CLR_ANY: /* See if any flag set */
  956. flags_rdy = (OS_FLAGS)(~p_grp->Flags & p_tcb->FlagsPend);
  957. if (flags_rdy != 0u) {
  958. OS_FlagTaskRdy(p_tcb, /* Make task RTR, event(s) Rx'd */
  959. flags_rdy,
  960. ts);
  961. }
  962. break;
  963. #endif
  964. default:
  965. CPU_CRITICAL_EXIT();
  966. *p_err = OS_ERR_FLAG_PEND_OPT;
  967. OS_TRACE_FLAG_POST_EXIT(*p_err);
  968. return (0u);
  969. }
  970. /* Point to next task waiting for event flag(s) */
  971. p_tcb = p_tcb_next;
  972. }
  973. CPU_CRITICAL_EXIT();
  974. if ((opt & OS_OPT_POST_NO_SCHED) == 0u) {
  975. OSSched();
  976. }
  977. CPU_CRITICAL_ENTER();
  978. flags_cur = p_grp->Flags;
  979. CPU_CRITICAL_EXIT();
  980. *p_err = OS_ERR_NONE;
  981. OS_TRACE_FLAG_POST_EXIT(*p_err);
  982. return (flags_cur);
  983. }
  984. /*
  985. ************************************************************************************************************************
  986. * SUSPEND TASK UNTIL EVENT FLAG(s) RECEIVED OR TIMEOUT OCCURS
  987. *
  988. * Description: This function is internal to uC/OS-III and is used to put a task to sleep until the desired
  989. * event flag bit(s) are set.
  990. *
  991. * Arguments : p_grp is a pointer to the desired event flag group.
  992. * -----
  993. *
  994. * flags Is a bit pattern indicating which bit(s) (i.e. flags) you wish to check.
  995. * The bits you want are specified by setting the corresponding bits in
  996. * 'flags'. e.g. if your application wants to wait for bits 0 and 1 then
  997. * 'flags' would contain 0x03.
  998. *
  999. * opt specifies whether you want ALL bits to be set/cleared or ANY of the bits
  1000. * to be set/cleared.
  1001. * You can specify the following argument:
  1002. *
  1003. * OS_OPT_PEND_FLAG_CLR_ALL You will check ALL bits in 'mask' to be clear (0)
  1004. * OS_OPT_PEND_FLAG_CLR_ANY You will check ANY bit in 'mask' to be clear (0)
  1005. * OS_OPT_PEND_FLAG_SET_ALL You will check ALL bits in 'mask' to be set (1)
  1006. * OS_OPT_PEND_FLAG_SET_ANY You will check ANY bit in 'mask' to be set (1)
  1007. *
  1008. * timeout is the desired amount of time that the task will wait for the event flag
  1009. * bit(s) to be set.
  1010. *
  1011. * Returns : none
  1012. *
  1013. * Note(s) : This function is INTERNAL to uC/OS-III and your application should not call it.
  1014. ************************************************************************************************************************
  1015. */
  1016. void OS_FlagBlock (OS_FLAG_GRP *p_grp,
  1017. OS_FLAGS flags,
  1018. OS_OPT opt,
  1019. OS_TICK timeout)
  1020. {
  1021. OSTCBCurPtr->FlagsPend = flags; /* Save the flags that we need to wait for */
  1022. OSTCBCurPtr->FlagsOpt = opt; /* Save the type of wait we are doing */
  1023. OSTCBCurPtr->FlagsRdy = 0u;
  1024. OS_Pend((OS_PEND_OBJ *)((void *)p_grp),
  1025. OSTCBCurPtr,
  1026. OS_TASK_PEND_ON_FLAG,
  1027. timeout);
  1028. }
  1029. /*
  1030. ************************************************************************************************************************
  1031. * CLEAR THE CONTENTS OF AN EVENT FLAG GROUP
  1032. *
  1033. * Description: This function is called by OSFlagDel() to clear the contents of an event flag group
  1034. *
  1035. * Argument(s): p_grp is a pointer to the event flag group to clear
  1036. * -----
  1037. *
  1038. * Returns : none
  1039. *
  1040. * Note(s) : This function is INTERNAL to uC/OS-III and your application should not call it.
  1041. ************************************************************************************************************************
  1042. */
  1043. void OS_FlagClr (OS_FLAG_GRP *p_grp)
  1044. {
  1045. OS_PEND_LIST *p_pend_list;
  1046. #if (OS_OBJ_TYPE_REQ > 0u)
  1047. p_grp->Type = OS_OBJ_TYPE_NONE;
  1048. #endif
  1049. #if (OS_CFG_DBG_EN > 0u)
  1050. p_grp->NamePtr = (CPU_CHAR *)((void *)"?FLAG"); /* Unknown name */
  1051. #endif
  1052. p_grp->Flags = 0u;
  1053. p_pend_list = &p_grp->PendList;
  1054. OS_PendListInit(p_pend_list);
  1055. }
  1056. /*
  1057. ************************************************************************************************************************
  1058. * ADD/REMOVE EVENT FLAG GROUP TO/FROM DEBUG LIST
  1059. *
  1060. * Description: These functions are called by uC/OS-III to add or remove an event flag group from the event flag debug
  1061. * list.
  1062. *
  1063. * Arguments : p_grp is a pointer to the event flag group to add/remove
  1064. *
  1065. * Returns : none
  1066. *
  1067. * Note(s) : These functions are INTERNAL to uC/OS-III and your application should not call it.
  1068. ************************************************************************************************************************
  1069. */
  1070. #if (OS_CFG_DBG_EN > 0u)
  1071. void OS_FlagDbgListAdd (OS_FLAG_GRP *p_grp)
  1072. {
  1073. p_grp->DbgNamePtr = (CPU_CHAR *)((void *)" ");
  1074. p_grp->DbgPrevPtr = (OS_FLAG_GRP *)0;
  1075. if (OSFlagDbgListPtr == (OS_FLAG_GRP *)0) {
  1076. p_grp->DbgNextPtr = (OS_FLAG_GRP *)0;
  1077. } else {
  1078. p_grp->DbgNextPtr = OSFlagDbgListPtr;
  1079. OSFlagDbgListPtr->DbgPrevPtr = p_grp;
  1080. }
  1081. OSFlagDbgListPtr = p_grp;
  1082. }
  1083. void OS_FlagDbgListRemove (OS_FLAG_GRP *p_grp)
  1084. {
  1085. OS_FLAG_GRP *p_grp_next;
  1086. OS_FLAG_GRP *p_grp_prev;
  1087. p_grp_prev = p_grp->DbgPrevPtr;
  1088. p_grp_next = p_grp->DbgNextPtr;
  1089. if (p_grp_prev == (OS_FLAG_GRP *)0) {
  1090. OSFlagDbgListPtr = p_grp_next;
  1091. if (p_grp_next != (OS_FLAG_GRP *)0) {
  1092. p_grp_next->DbgPrevPtr = (OS_FLAG_GRP *)0;
  1093. }
  1094. p_grp->DbgNextPtr = (OS_FLAG_GRP *)0;
  1095. } else if (p_grp_next == (OS_FLAG_GRP *)0) {
  1096. p_grp_prev->DbgNextPtr = (OS_FLAG_GRP *)0;
  1097. p_grp->DbgPrevPtr = (OS_FLAG_GRP *)0;
  1098. } else {
  1099. p_grp_prev->DbgNextPtr = p_grp_next;
  1100. p_grp_next->DbgPrevPtr = p_grp_prev;
  1101. p_grp->DbgNextPtr = (OS_FLAG_GRP *)0;
  1102. p_grp->DbgPrevPtr = (OS_FLAG_GRP *)0;
  1103. }
  1104. }
  1105. #endif
  1106. /*
  1107. ************************************************************************************************************************
  1108. * MAKE TASK READY-TO-RUN, EVENT(s) OCCURRED
  1109. *
  1110. * Description: This function is internal to uC/OS-III and is used to make a task ready-to-run because the desired event
  1111. * flag bits have been set.
  1112. *
  1113. * Arguments : p_tcb is a pointer to the OS_TCB of the task to remove
  1114. * -----
  1115. *
  1116. * flags_rdy contains the bit pattern of the event flags that cause the task to become ready-to-run.
  1117. *
  1118. * ts is a timestamp associated with the post
  1119. *
  1120. * Returns : none
  1121. *
  1122. * Note(s) : This function is INTERNAL to uC/OS-III and your application should not call it.
  1123. ************************************************************************************************************************
  1124. */
  1125. void OS_FlagTaskRdy (OS_TCB *p_tcb,
  1126. OS_FLAGS flags_rdy,
  1127. CPU_TS ts)
  1128. {
  1129. #if (OS_CFG_TS_EN == 0u)
  1130. (void)ts; /* Prevent compiler warning for not using 'ts' */
  1131. #endif
  1132. p_tcb->FlagsRdy = flags_rdy;
  1133. p_tcb->PendStatus = OS_STATUS_PEND_OK; /* Clear pend status */
  1134. p_tcb->PendOn = OS_TASK_PEND_ON_NOTHING; /* Indicate no longer pending */
  1135. #if (OS_CFG_TS_EN > 0u)
  1136. p_tcb->TS = ts;
  1137. #endif
  1138. switch (p_tcb->TaskState) {
  1139. case OS_TASK_STATE_PEND:
  1140. case OS_TASK_STATE_PEND_TIMEOUT:
  1141. #if (OS_CFG_TICK_EN > 0u)
  1142. if (p_tcb->TaskState == OS_TASK_STATE_PEND_TIMEOUT) {
  1143. OS_TickListRemove(p_tcb); /* Remove from tick list */
  1144. }
  1145. #endif
  1146. OS_RdyListInsert(p_tcb); /* Insert the task in the ready list */
  1147. p_tcb->TaskState = OS_TASK_STATE_RDY;
  1148. break;
  1149. case OS_TASK_STATE_PEND_SUSPENDED:
  1150. case OS_TASK_STATE_PEND_TIMEOUT_SUSPENDED:
  1151. #if (OS_CFG_TICK_EN > 0u)
  1152. if (p_tcb->TaskState == OS_TASK_STATE_PEND_TIMEOUT_SUSPENDED) {
  1153. OS_TickListRemove(p_tcb); /* Remove from tick list */
  1154. }
  1155. #endif
  1156. p_tcb->TaskState = OS_TASK_STATE_SUSPENDED;
  1157. break;
  1158. case OS_TASK_STATE_RDY:
  1159. case OS_TASK_STATE_DLY:
  1160. case OS_TASK_STATE_DLY_SUSPENDED:
  1161. case OS_TASK_STATE_SUSPENDED:
  1162. default:
  1163. /* Default case. */
  1164. break;
  1165. }
  1166. OS_PendListRemove(p_tcb);
  1167. }
  1168. #endif