os_flag.c
上传用户:zbk8730
上传日期:2017-08-10
资源大小:12168k
文件大小:54k
源码类别:

uCOS

开发平台:

C/C++

  1. /*
  2. *********************************************************************************************************
  3. *                                                uC/OS-II
  4. *                                          The Real-Time Kernel
  5. *                                         EVENT FLAG  MANAGEMENT
  6. *
  7. *                          (c) Copyright 2001-2006, Jean J. Labrosse, Weston, FL
  8. *                                           All Rights Reserved
  9. *
  10. * File    : OS_FLAG.C
  11. * By      : Jean J. Labrosse
  12. * Version : V2.83
  13. *********************************************************************************************************
  14. */
  15. #ifndef  OS_MASTER_FILE
  16. #include <ucos_ii.h>
  17. #endif
  18. #if (OS_VERSION >= 251) && (OS_FLAG_EN > 0) && (OS_MAX_FLAGS > 0)
  19. /*
  20. *********************************************************************************************************
  21. *                                            LOCAL PROTOTYPES
  22. *********************************************************************************************************
  23. */
  24. static  void     OS_FlagBlock(OS_FLAG_GRP *pgrp, OS_FLAG_NODE *pnode, OS_FLAGS flags, INT8U wait_type, INT16U timeout);
  25. static  BOOLEAN  OS_FlagTaskRdy(OS_FLAG_NODE *pnode, OS_FLAGS flags_rdy);
  26. /*$PAGE*/
  27. /*
  28. *********************************************************************************************************
  29. *                              CHECK THE STATUS OF FLAGS IN AN EVENT FLAG GROUP
  30. *
  31. * Description: This function is called to check the status of a combination of bits to be set or cleared
  32. *              in an event flag group.  Your application can check for ANY bit to be set/cleared or ALL
  33. *              bits to be set/cleared.
  34. *
  35. *              This call does not block if the desired flags are not present.
  36. *
  37. * Arguments  : pgrp          is a pointer to the desired event flag group.
  38. *
  39. *              flags         Is a bit pattern indicating which bit(s) (i.e. flags) you wish to check.
  40. *                            The bits you want are specified by setting the corresponding bits in
  41. *                            'flags'.  e.g. if your application wants to wait for bits 0 and 1 then
  42. *                            'flags' would contain 0x03.
  43. *
  44. *              wait_type     specifies whether you want ALL bits to be set/cleared or ANY of the bits
  45. *                            to be set/cleared.
  46. *                            You can specify the following argument:
  47. *
  48. *                            OS_FLAG_WAIT_CLR_ALL   You will check ALL bits in 'flags' to be clear (0)
  49. *                            OS_FLAG_WAIT_CLR_ANY   You will check ANY bit  in 'flags' to be clear (0)
  50. *                            OS_FLAG_WAIT_SET_ALL   You will check ALL bits in 'flags' to be set   (1)
  51. *                            OS_FLAG_WAIT_SET_ANY   You will check ANY bit  in 'flags' to be set   (1)
  52. *
  53. *                            NOTE: Add OS_FLAG_CONSUME if you want the event flag to be 'consumed' by
  54. *                                  the call.  Example, to wait for any flag in a group AND then clear
  55. *                                  the flags that are present, set 'wait_type' to:
  56. *
  57. *                                  OS_FLAG_WAIT_SET_ANY + OS_FLAG_CONSUME
  58. *
  59. *              err           is a pointer to an error code and can be:
  60. *                            OS_NO_ERR              No error
  61. *                            OS_ERR_EVENT_TYPE      You are not pointing to an event flag group
  62. *                            OS_FLAG_ERR_WAIT_TYPE  You didn't specify a proper 'wait_type' argument.
  63. *                            OS_FLAG_INVALID_PGRP   You passed a NULL pointer instead of the event flag
  64. *                                                   group handle.
  65. *                            OS_FLAG_ERR_NOT_RDY    The desired flags you are waiting for are not
  66. *                                                   available.
  67. *
  68. * Returns    : The flags in the event flag group that made the task ready or, 0 if a timeout or an error
  69. *              occurred.
  70. *
  71. * Called from: Task or ISR
  72. *
  73. * Note(s)    : 1) IMPORTANT, the behavior of this function has changed from PREVIOUS versions.  The
  74. *                 function NOW returns the flags that were ready INSTEAD of the current state of the
  75. *                 event flags.
  76. *********************************************************************************************************
  77. */
  78. #if OS_FLAG_ACCEPT_EN > 0
  79. OS_FLAGS  OSFlagAccept (OS_FLAG_GRP *pgrp, OS_FLAGS flags, INT8U wait_type, INT8U *err)
  80. {
  81.     OS_FLAGS      flags_rdy;
  82.     INT8U         result;
  83.     BOOLEAN       consume;
  84. #if OS_CRITICAL_METHOD == 3                                /* Allocate storage for CPU status register */
  85.     OS_CPU_SR     cpu_sr = 0;
  86. #endif
  87. #if OS_ARG_CHK_EN > 0
  88.     if (err == (INT8U *)0) {                               /* Validate 'err'                           */
  89.         return ((OS_FLAGS)0);
  90.     }
  91.     if (pgrp == (OS_FLAG_GRP *)0) {                        /* Validate 'pgrp'                          */
  92.         *err = OS_FLAG_INVALID_PGRP;
  93.         return ((OS_FLAGS)0);
  94.     }
  95. #endif
  96.     if (pgrp->OSFlagType != OS_EVENT_TYPE_FLAG) {          /* Validate event block type                */
  97.         *err = OS_ERR_EVENT_TYPE;
  98.         return ((OS_FLAGS)0);
  99.     }
  100.     result = (INT8U)(wait_type & OS_FLAG_CONSUME);
  101.     if (result != (INT8U)0) {                              /* See if we need to consume the flags      */
  102.         wait_type &= ~OS_FLAG_CONSUME;
  103.         consume    = OS_TRUE;
  104.     } else {
  105.         consume    = OS_FALSE;
  106.     }
  107. /*$PAGE*/
  108.     *err = OS_NO_ERR;                                      /* Assume NO error until proven otherwise.  */
  109.     OS_ENTER_CRITICAL();
  110.     switch (wait_type) {
  111.         case OS_FLAG_WAIT_SET_ALL:                         /* See if all required flags are set        */
  112.              flags_rdy = (OS_FLAGS)(pgrp->OSFlagFlags & flags);     /* Extract only the bits we want   */
  113.              if (flags_rdy == flags) {                     /* Must match ALL the bits that we want     */
  114.                  if (consume == OS_TRUE) {                 /* See if we need to consume the flags      */
  115.                      pgrp->OSFlagFlags &= ~flags_rdy;      /* Clear ONLY the flags that we wanted      */
  116.                  }
  117.              } else {
  118.                  *err  = OS_FLAG_ERR_NOT_RDY;
  119.              }
  120.              OS_EXIT_CRITICAL();
  121.              break;
  122.         case OS_FLAG_WAIT_SET_ANY:
  123.              flags_rdy = (OS_FLAGS)(pgrp->OSFlagFlags & flags);     /* Extract only the bits we want   */
  124.              if (flags_rdy != (OS_FLAGS)0) {               /* See if any flag set                      */
  125.                  if (consume == OS_TRUE) {                 /* See if we need to consume the flags      */
  126.                      pgrp->OSFlagFlags &= ~flags_rdy;      /* Clear ONLY the flags that we got         */
  127.                  }
  128.              } else {
  129.                  *err  = OS_FLAG_ERR_NOT_RDY;
  130.              }
  131.              OS_EXIT_CRITICAL();
  132.              break;
  133. #if OS_FLAG_WAIT_CLR_EN > 0
  134.         case OS_FLAG_WAIT_CLR_ALL:                         /* See if all required flags are cleared    */
  135.              flags_rdy = (OS_FLAGS)(~pgrp->OSFlagFlags & flags);  /* Extract only the bits we want     */
  136.              if (flags_rdy == flags) {                     /* Must match ALL the bits that we want     */
  137.                  if (consume == OS_TRUE) {                 /* See if we need to consume the flags      */
  138.                      pgrp->OSFlagFlags |= flags_rdy;       /* Set ONLY the flags that we wanted        */
  139.                  }
  140.              } else {
  141.                  *err  = OS_FLAG_ERR_NOT_RDY;
  142.              }
  143.              OS_EXIT_CRITICAL();
  144.              break;
  145.         case OS_FLAG_WAIT_CLR_ANY:
  146.              flags_rdy = (OS_FLAGS)(~pgrp->OSFlagFlags & flags); /* Extract only the bits we want      */
  147.              if (flags_rdy != (OS_FLAGS)0) {               /* See if any flag cleared                  */
  148.                  if (consume == OS_TRUE) {                 /* See if we need to consume the flags      */
  149.                      pgrp->OSFlagFlags |= flags_rdy;       /* Set ONLY the flags that we got           */
  150.                  }
  151.              } else {
  152.                  *err  = OS_FLAG_ERR_NOT_RDY;
  153.              }
  154.              OS_EXIT_CRITICAL();
  155.              break;
  156. #endif
  157.         default:
  158.              OS_EXIT_CRITICAL();
  159.              flags_rdy = (OS_FLAGS)0;
  160.              *err      = OS_FLAG_ERR_WAIT_TYPE;
  161.              break;
  162.     }
  163.     return (flags_rdy);
  164. }
  165. #endif
  166. /*$PAGE*/
  167. /*
  168. *********************************************************************************************************
  169. *                                           CREATE AN EVENT FLAG
  170. *
  171. * Description: This function is called to create an event flag group.
  172. *
  173. * Arguments  : flags         Contains the initial value to store in the event flag group.
  174. *
  175. *              err           is a pointer to an error code which will be returned to your application:
  176. *                               OS_NO_ERR                if the call was successful.
  177. *                               OS_ERR_CREATE_ISR        if you attempted to create an Event Flag from an
  178. *                                                        ISR.
  179. *                               OS_FLAG_GRP_DEPLETED     if there are no more event flag groups
  180. *
  181. * Returns    : A pointer to an event flag group or a NULL pointer if no more groups are available.
  182. *
  183. * Called from: Task ONLY
  184. *********************************************************************************************************
  185. */
  186. OS_FLAG_GRP  *OSFlagCreate (OS_FLAGS flags, INT8U *err)
  187. {
  188.     OS_FLAG_GRP *pgrp;
  189. #if OS_CRITICAL_METHOD == 3                         /* Allocate storage for CPU status register        */
  190.     OS_CPU_SR    cpu_sr = 0;
  191. #endif
  192. #if OS_ARG_CHK_EN > 0
  193.     if (err == (INT8U *)0) {                        /* Validate 'err'                                  */
  194.         return ((OS_FLAG_GRP *)0);
  195.     }
  196. #endif
  197.     if (OSIntNesting > 0) {                         /* See if called from ISR ...                      */
  198.         *err = OS_ERR_CREATE_ISR;                   /* ... can't CREATE from an ISR                    */
  199.         return ((OS_FLAG_GRP *)0);
  200.     }
  201.     OS_ENTER_CRITICAL();
  202.     pgrp = OSFlagFreeList;                          /* Get next free event flag                        */
  203.     if (pgrp != (OS_FLAG_GRP *)0) {                 /* See if we have event flag groups available      */
  204.                                                     /* Adjust free list                                */
  205.         OSFlagFreeList       = (OS_FLAG_GRP *)OSFlagFreeList->OSFlagWaitList;
  206.         pgrp->OSFlagType     = OS_EVENT_TYPE_FLAG;  /* Set to event flag group type                    */
  207.         pgrp->OSFlagFlags    = flags;               /* Set to desired initial value                    */
  208.         pgrp->OSFlagWaitList = (void *)0;           /* Clear list of tasks waiting on flags            */
  209. #if OS_FLAG_NAME_SIZE > 1
  210.         pgrp->OSFlagName[0]  = '?';
  211.         pgrp->OSFlagName[1]  = OS_ASCII_NUL;
  212. #endif
  213.         OS_EXIT_CRITICAL();
  214.         *err                 = OS_NO_ERR;
  215.     } else {
  216.         OS_EXIT_CRITICAL();
  217.         *err                 = OS_FLAG_GRP_DEPLETED;
  218.     }
  219.     return (pgrp);                                  /* Return pointer to event flag group              */
  220. }
  221. /*$PAGE*/
  222. /*
  223. *********************************************************************************************************
  224. *                                     DELETE AN EVENT FLAG GROUP
  225. *
  226. * Description: This function deletes an event flag group and readies all tasks pending on the event flag
  227. *              group.
  228. *
  229. * Arguments  : pgrp          is a pointer to the desired event flag group.
  230. *
  231. *              opt           determines delete options as follows:
  232. *                            opt == OS_DEL_NO_PEND   Deletes the event flag group ONLY if no task pending
  233. *                            opt == OS_DEL_ALWAYS    Deletes the event flag group even if tasks are
  234. *                                                    waiting.  In this case, all the tasks pending will be
  235. *                                                    readied.
  236. *
  237. *              err           is a pointer to an error code that can contain one of the following values:
  238. *                            OS_NO_ERR               The call was successful and the event flag group was
  239. *                                                    deleted
  240. *                            OS_ERR_DEL_ISR          If you attempted to delete the event flag group from
  241. *                                                    an ISR
  242. *                            OS_FLAG_INVALID_PGRP    If 'pgrp' is a NULL pointer.
  243. *                            OS_ERR_EVENT_TYPE       If you didn't pass a pointer to an event flag group
  244. *                            OS_ERR_INVALID_OPT      An invalid option was specified
  245. *                            OS_ERR_TASK_WAITING     One or more tasks were waiting on the event flag
  246. *                                                    group.
  247. *
  248. * Returns    : pgrp          upon error
  249. *              (OS_EVENT *)0 if the event flag group was successfully deleted.
  250. *
  251. * Note(s)    : 1) This function must be used with care.  Tasks that would normally expect the presence of
  252. *                 the event flag group MUST check the return code of OSFlagAccept() and OSFlagPend().
  253. *              2) This call can potentially disable interrupts for a long time.  The interrupt disable
  254. *                 time is directly proportional to the number of tasks waiting on the event flag group.
  255. *********************************************************************************************************
  256. */
  257. #if OS_FLAG_DEL_EN > 0
  258. OS_FLAG_GRP  *OSFlagDel (OS_FLAG_GRP *pgrp, INT8U opt, INT8U *err)
  259. {
  260.     BOOLEAN       tasks_waiting;
  261.     OS_FLAG_NODE *pnode;
  262.     OS_FLAG_GRP  *pgrp_return;
  263. #if OS_CRITICAL_METHOD == 3                                /* Allocate storage for CPU status register */
  264.     OS_CPU_SR     cpu_sr = 0;
  265. #endif
  266. #if OS_ARG_CHK_EN > 0
  267.     if (err == (INT8U *)0) {                               /* Validate 'err'                           */
  268.         return (pgrp);
  269.     }
  270.     if (pgrp == (OS_FLAG_GRP *)0) {                        /* Validate 'pgrp'                          */
  271.         *err = OS_FLAG_INVALID_PGRP;
  272.         return (pgrp);
  273.     }
  274. #endif
  275.     if (OSIntNesting > 0) {                                /* See if called from ISR ...               */
  276.         *err = OS_ERR_DEL_ISR;                             /* ... can't DELETE from an ISR             */
  277.         return (pgrp);
  278.     }
  279.     if (pgrp->OSFlagType != OS_EVENT_TYPE_FLAG) {          /* Validate event group type                */
  280.         *err = OS_ERR_EVENT_TYPE;
  281.         return (pgrp);
  282.     }
  283.     OS_ENTER_CRITICAL();
  284.     if (pgrp->OSFlagWaitList != (void *)0) {               /* See if any tasks waiting on event flags  */
  285.         tasks_waiting = OS_TRUE;                           /* Yes                                      */
  286.     } else {
  287.         tasks_waiting = OS_FALSE;                          /* No                                       */
  288.     }
  289.     switch (opt) {
  290.         case OS_DEL_NO_PEND:                               /* Delete group if no task waiting          */
  291.              if (tasks_waiting == OS_FALSE) {
  292. #if OS_FLAG_NAME_SIZE > 1
  293.                  pgrp->OSFlagName[0]  = '?';               /* Unknown name                             */
  294.                  pgrp->OSFlagName[1]  = OS_ASCII_NUL;
  295. #endif
  296.                  pgrp->OSFlagType     = OS_EVENT_TYPE_UNUSED;
  297.                  pgrp->OSFlagWaitList = (void *)OSFlagFreeList; /* Return group to free list           */
  298.                  pgrp->OSFlagFlags    = (OS_FLAGS)0;
  299.                  OSFlagFreeList       = pgrp;
  300.                  OS_EXIT_CRITICAL();
  301.                  *err                 = OS_NO_ERR;
  302.                  pgrp_return          = (OS_FLAG_GRP *)0;  /* Event Flag Group has been deleted        */
  303.              } else {
  304.                  OS_EXIT_CRITICAL();
  305.                  *err                 = OS_ERR_TASK_WAITING;
  306.                  pgrp_return          = pgrp;
  307.              }
  308.              break;
  309.         case OS_DEL_ALWAYS:                                /* Always delete the event flag group       */
  310.              pnode = (OS_FLAG_NODE *)pgrp->OSFlagWaitList;
  311.              while (pnode != (OS_FLAG_NODE *)0) {          /* Ready ALL tasks waiting for flags        */
  312.                  (void)OS_FlagTaskRdy(pnode, (OS_FLAGS)0);
  313.                  pnode = (OS_FLAG_NODE *)pnode->OSFlagNodeNext;
  314.              }
  315. #if OS_FLAG_NAME_SIZE > 1
  316.              pgrp->OSFlagName[0]  = '?';                   /* Unknown name                             */
  317.              pgrp->OSFlagName[1]  = OS_ASCII_NUL;
  318. #endif
  319.              pgrp->OSFlagType     = OS_EVENT_TYPE_UNUSED;
  320.              pgrp->OSFlagWaitList = (void *)OSFlagFreeList;/* Return group to free list                */
  321.              pgrp->OSFlagFlags    = (OS_FLAGS)0;
  322.              OSFlagFreeList       = pgrp;
  323.              OS_EXIT_CRITICAL();
  324.              if (tasks_waiting == OS_TRUE) {               /* Reschedule only if task(s) were waiting  */
  325.                  OS_Sched();                               /* Find highest priority task ready to run  */
  326.              }
  327.              *err = OS_NO_ERR;
  328.              pgrp_return          = (OS_FLAG_GRP *)0;      /* Event Flag Group has been deleted        */
  329.              break;
  330.         default:
  331.              OS_EXIT_CRITICAL();
  332.              *err                 = OS_ERR_INVALID_OPT;
  333.              pgrp_return          = pgrp;
  334.              break;
  335.     }
  336.     return (pgrp_return);
  337. }
  338. #endif
  339. /*$PAGE*/
  340. /*
  341. *********************************************************************************************************
  342. *                                 GET THE NAME OF AN EVENT FLAG GROUP
  343. *
  344. * Description: This function is used to obtain the name assigned to an event flag group
  345. *
  346. * Arguments  : pgrp      is a pointer to the event flag group.
  347. *
  348. *              pname     is a pointer to an ASCII string that will receive the name of the event flag
  349. *                        group.  The string must be able to hold at least OS_FLAG_NAME_SIZE characters.
  350. *
  351. *              err       is a pointer to an error code that can contain one of the following values:
  352. *
  353. *                        OS_NO_ERR                  if the requested task is resumed
  354. *                        OS_ERR_EVENT_TYPE          if 'pevent' is not pointing to an event flag group
  355. *                        OS_ERR_PNAME_NULL          You passed a NULL pointer for 'pname'
  356. *                        OS_FLAG_INVALID_PGRP       if you passed a NULL pointer for 'pgrp'
  357. *
  358. * Returns    : The length of the string or 0 if the 'pgrp' is a NULL pointer.
  359. *********************************************************************************************************
  360. */
  361. #if OS_FLAG_NAME_SIZE > 1
  362. INT8U  OSFlagNameGet (OS_FLAG_GRP *pgrp, INT8U *pname, INT8U *err)
  363. {
  364.     INT8U      len;
  365. #if OS_CRITICAL_METHOD == 3                      /* Allocate storage for CPU status register           */
  366.     OS_CPU_SR  cpu_sr = 0;
  367. #endif
  368.     OS_ENTER_CRITICAL();
  369. #if OS_ARG_CHK_EN > 0
  370.     if (err == (INT8U *)0) {                     /* Validate 'err'                                     */
  371.         OS_EXIT_CRITICAL();
  372.         return (0);
  373.     }
  374.     if (pgrp == (OS_FLAG_GRP *)0) {              /* Is 'pgrp' a NULL pointer?                          */
  375.         OS_EXIT_CRITICAL();                      /* Yes                                                */
  376.         *err = OS_FLAG_INVALID_PGRP;
  377.         return (0);
  378.     }
  379.     if (pname == (INT8U *)0) {                    /* Is 'pname' a NULL pointer?                         */
  380.         OS_EXIT_CRITICAL();                      /* Yes                                                */
  381.         *err = OS_ERR_PNAME_NULL;
  382.         return (0);
  383.     }
  384. #endif
  385.     if (pgrp->OSFlagType != OS_EVENT_TYPE_FLAG) {
  386.         OS_EXIT_CRITICAL();
  387.         *err = OS_ERR_EVENT_TYPE;
  388.         return (0);
  389.     }
  390.     len  = OS_StrCopy(pname, pgrp->OSFlagName);  /* Copy name from OS_FLAG_GRP                         */
  391.     OS_EXIT_CRITICAL();
  392.     *err = OS_NO_ERR;
  393.     return (len);
  394. }
  395. #endif
  396. /*$PAGE*/
  397. /*
  398. *********************************************************************************************************
  399. *                                 ASSIGN A NAME TO AN EVENT FLAG GROUP
  400. *
  401. * Description: This function assigns a name to an event flag group.
  402. *
  403. * Arguments  : pgrp      is a pointer to the event flag group.
  404. *
  405. *              pname     is a pointer to an ASCII string that will be used as the name of the event flag
  406. *                        group.  The string must be able to hold at least OS_FLAG_NAME_SIZE characters.
  407. *
  408. *              err       is a pointer to an error code that can contain one of the following values:
  409. *
  410. *                        OS_NO_ERR                  if the requested task is resumed
  411. *                        OS_ERR_EVENT_TYPE          if 'pevent' is not pointing to an event flag group
  412. *                        OS_ERR_PNAME_NULL          You passed a NULL pointer for 'pname'
  413. *                        OS_FLAG_INVALID_PGRP       if you passed a NULL pointer for 'pgrp'
  414. *
  415. * Returns    : None
  416. *********************************************************************************************************
  417. */
  418. #if OS_FLAG_NAME_SIZE > 1
  419. void  OSFlagNameSet (OS_FLAG_GRP *pgrp, INT8U *pname, INT8U *err)
  420. {
  421.     INT8U      len;
  422. #if OS_CRITICAL_METHOD == 3                      /* Allocate storage for CPU status register           */
  423.     OS_CPU_SR  cpu_sr = 0;
  424. #endif
  425.     OS_ENTER_CRITICAL();
  426. #if OS_ARG_CHK_EN > 0
  427.     if (err == (INT8U *)0) {                     /* Validate 'err'                                     */
  428.         OS_EXIT_CRITICAL();
  429.         return;
  430.     }
  431.     if (pgrp == (OS_FLAG_GRP *)0) {              /* Is 'pgrp' a NULL pointer?                          */
  432.         OS_EXIT_CRITICAL();                      /* Yes                                                */
  433.         *err = OS_FLAG_INVALID_PGRP;
  434.         return;
  435.     }
  436.     if (pname == (INT8U *)0) {                    /* Is 'pname' a NULL pointer?                         */
  437.         OS_EXIT_CRITICAL();                      /* Yes                                                */
  438.         *err = OS_ERR_PNAME_NULL;
  439.         return;
  440.     }
  441. #endif
  442.     if (pgrp->OSFlagType != OS_EVENT_TYPE_FLAG) {
  443.         OS_EXIT_CRITICAL();
  444.         *err = OS_ERR_EVENT_TYPE;
  445.         return;
  446.     }
  447.     len = OS_StrLen(pname);                      /* Can we fit the string in the storage area?         */
  448.     if (len > (OS_FLAG_NAME_SIZE - 1)) {         /* No                                                 */
  449.         OS_EXIT_CRITICAL();
  450.         *err = OS_ERR_FLAG_NAME_TOO_LONG;
  451.         return;
  452.     }
  453.     (void)OS_StrCopy(pgrp->OSFlagName, pname);   /* Yes, copy name from OS_FLAG_GRP                    */
  454.     OS_EXIT_CRITICAL();
  455.     *err = OS_NO_ERR;
  456.     return;
  457. }
  458. #endif
  459. /*$PAGE*/
  460. /*
  461. *********************************************************************************************************
  462. *                                        WAIT ON AN EVENT FLAG GROUP
  463. *
  464. * Description: This function is called to wait for a combination of bits to be set in an event flag
  465. *              group.  Your application can wait for ANY bit to be set or ALL bits to be set.
  466. *
  467. * Arguments  : pgrp          is a pointer to the desired event flag group.
  468. *
  469. *              flags         Is a bit pattern indicating which bit(s) (i.e. flags) you wish to wait for.
  470. *                            The bits you want are specified by setting the corresponding bits in
  471. *                            'flags'.  e.g. if your application wants to wait for bits 0 and 1 then
  472. *                            'flags' would contain 0x03.
  473. *
  474. *              wait_type     specifies whether you want ALL bits to be set or ANY of the bits to be set.
  475. *                            You can specify the following argument:
  476. *
  477. *                            OS_FLAG_WAIT_CLR_ALL   You will wait for ALL bits in 'mask' to be clear (0)
  478. *                            OS_FLAG_WAIT_SET_ALL   You will wait for ALL bits in 'mask' to be set   (1)
  479. *                            OS_FLAG_WAIT_CLR_ANY   You will wait for ANY bit  in 'mask' to be clear (0)
  480. *                            OS_FLAG_WAIT_SET_ANY   You will wait for ANY bit  in 'mask' to be set   (1)
  481. *
  482. *                            NOTE: Add OS_FLAG_CONSUME if you want the event flag to be 'consumed' by
  483. *                                  the call.  Example, to wait for any flag in a group AND then clear
  484. *                                  the flags that are present, set 'wait_type' to:
  485. *
  486. *                                  OS_FLAG_WAIT_SET_ANY + OS_FLAG_CONSUME
  487. *
  488. *              timeout       is an optional timeout (in clock ticks) that your task will wait for the
  489. *                            desired bit combination.  If you specify 0, however, your task will wait
  490. *                            forever at the specified event flag group or, until a message arrives.
  491. *
  492. *              err           is a pointer to an error code and can be:
  493. *                            OS_NO_ERR              The desired bits have been set within the specified
  494. *                                                   'timeout'.
  495. *                            OS_ERR_PEND_ISR        If you tried to PEND from an ISR
  496. *                            OS_FLAG_INVALID_PGRP   If 'pgrp' is a NULL pointer.
  497. *                            OS_ERR_EVENT_TYPE      You are not pointing to an event flag group
  498. *                            OS_TIMEOUT             The bit(s) have not been set in the specified
  499. *                                                   'timeout'.
  500. *                            OS_FLAG_ERR_WAIT_TYPE  You didn't specify a proper 'wait_type' argument.
  501. *
  502. * Returns    : The flags in the event flag group that made the task ready or, 0 if a timeout or an error
  503. *              occurred.
  504. *
  505. * Called from: Task ONLY
  506. *
  507. * Note(s)    : 1) IMPORTANT, the behavior of this function has changed from PREVIOUS versions.  The
  508. *                 function NOW returns the flags that were ready INSTEAD of the current state of the
  509. *                 event flags.
  510. *********************************************************************************************************
  511. */
  512. OS_FLAGS  OSFlagPend (OS_FLAG_GRP *pgrp, OS_FLAGS flags, INT8U wait_type, INT16U timeout, INT8U *err)
  513. {
  514.     OS_FLAG_NODE  node;
  515.     OS_FLAGS      flags_rdy;
  516.     INT8U         result;
  517.     BOOLEAN       consume;
  518. #if OS_CRITICAL_METHOD == 3                                /* Allocate storage for CPU status register */
  519.     OS_CPU_SR     cpu_sr = 0;
  520. #endif
  521. #if OS_ARG_CHK_EN > 0
  522.     if (err == (INT8U *)0) {                               /* Validate 'err'                           */
  523.         return ((OS_FLAGS)0);
  524.     }
  525.     if (pgrp == (OS_FLAG_GRP *)0) {                        /* Validate 'pgrp'                          */
  526.         *err = OS_FLAG_INVALID_PGRP;
  527.         return ((OS_FLAGS)0);
  528.     }
  529. #endif
  530.     if (OSIntNesting > 0) {                                /* See if called from ISR ...               */
  531.         *err = OS_ERR_PEND_ISR;                            /* ... can't PEND from an ISR               */
  532.         return ((OS_FLAGS)0);
  533.     }
  534.     if (OSLockNesting > 0) {                               /* See if called with scheduler locked ...  */
  535.         *err = OS_ERR_PEND_LOCKED;                         /* ... can't PEND when locked               */
  536.         return ((OS_FLAGS)0);
  537.     }
  538.     if (pgrp->OSFlagType != OS_EVENT_TYPE_FLAG) {          /* Validate event block type                */
  539.         *err = OS_ERR_EVENT_TYPE;
  540.         return ((OS_FLAGS)0);
  541.     }
  542.     result = (INT8U)(wait_type & OS_FLAG_CONSUME);
  543.     if (result != (INT8U)0) {                             /* See if we need to consume the flags      */
  544.         wait_type &= ~OS_FLAG_CONSUME;
  545.         consume    = OS_TRUE;
  546.     } else {
  547.         consume    = OS_FALSE;
  548.     }
  549. /*$PAGE*/
  550.     OS_ENTER_CRITICAL();
  551.     switch (wait_type) {
  552.         case OS_FLAG_WAIT_SET_ALL:                         /* See if all required flags are set        */
  553.              flags_rdy = (OS_FLAGS)(pgrp->OSFlagFlags & flags);   /* Extract only the bits we want     */
  554.              if (flags_rdy == flags) {                     /* Must match ALL the bits that we want     */
  555.                  if (consume == OS_TRUE) {                 /* See if we need to consume the flags      */
  556.                      pgrp->OSFlagFlags &= ~flags_rdy;      /* Clear ONLY the flags that we wanted      */
  557.                  }
  558.                  OSTCBCur->OSTCBFlagsRdy = flags_rdy;      /* Save flags that were ready               */
  559.                  OS_EXIT_CRITICAL();                       /* Yes, condition met, return to caller     */
  560.                  *err                    = OS_NO_ERR;
  561.                  return (flags_rdy);
  562.              } else {                                      /* Block task until events occur or timeout */
  563.                  OS_FlagBlock(pgrp, &node, flags, wait_type, timeout);
  564.                  OS_EXIT_CRITICAL();
  565.              }
  566.              break;
  567.         case OS_FLAG_WAIT_SET_ANY:
  568.              flags_rdy = (OS_FLAGS)(pgrp->OSFlagFlags & flags);    /* Extract only the bits we want    */
  569.              if (flags_rdy != (OS_FLAGS)0) {               /* See if any flag set                      */
  570.                  if (consume == OS_TRUE) {                 /* See if we need to consume the flags      */
  571.                      pgrp->OSFlagFlags &= ~flags_rdy;      /* Clear ONLY the flags that we got         */
  572.                  }
  573.                  OSTCBCur->OSTCBFlagsRdy = flags_rdy;      /* Save flags that were ready               */
  574.                  OS_EXIT_CRITICAL();                       /* Yes, condition met, return to caller     */
  575.                  *err                    = OS_NO_ERR;
  576.                  return (flags_rdy);
  577.              } else {                                      /* Block task until events occur or timeout */
  578.                  OS_FlagBlock(pgrp, &node, flags, wait_type, timeout);
  579.                  OS_EXIT_CRITICAL();
  580.              }
  581.              break;
  582. #if OS_FLAG_WAIT_CLR_EN > 0
  583.         case OS_FLAG_WAIT_CLR_ALL:                         /* See if all required flags are cleared    */
  584.              flags_rdy = (OS_FLAGS)(~pgrp->OSFlagFlags & flags);  /* Extract only the bits we want     */
  585.              if (flags_rdy == flags) {                     /* Must match ALL the bits that we want     */
  586.                  if (consume == OS_TRUE) {                 /* See if we need to consume the flags      */
  587.                      pgrp->OSFlagFlags |= flags_rdy;       /* Set ONLY the flags that we wanted        */
  588.                  }
  589.                  OSTCBCur->OSTCBFlagsRdy = flags_rdy;      /* Save flags that were ready               */
  590.                  OS_EXIT_CRITICAL();                       /* Yes, condition met, return to caller     */
  591.                  *err                    = OS_NO_ERR;
  592.                  return (flags_rdy);
  593.              } else {                                      /* Block task until events occur or timeout */
  594.                  OS_FlagBlock(pgrp, &node, flags, wait_type, timeout);
  595.                  OS_EXIT_CRITICAL();
  596.              }
  597.              break;
  598.         case OS_FLAG_WAIT_CLR_ANY:
  599.              flags_rdy = (OS_FLAGS)(~pgrp->OSFlagFlags & flags); /* Extract only the bits we want      */
  600.              if (flags_rdy != (OS_FLAGS)0) {               /* See if any flag cleared                  */
  601.                  if (consume == OS_TRUE) {                 /* See if we need to consume the flags      */
  602.                      pgrp->OSFlagFlags |= flags_rdy;       /* Set ONLY the flags that we got           */
  603.                  }
  604.                  OSTCBCur->OSTCBFlagsRdy = flags_rdy;      /* Save flags that were ready               */
  605.                  OS_EXIT_CRITICAL();                       /* Yes, condition met, return to caller     */
  606.                  *err                    = OS_NO_ERR;
  607.                  return (flags_rdy);
  608.              } else {                                      /* Block task until events occur or timeout */
  609.                  OS_FlagBlock(pgrp, &node, flags, wait_type, timeout);
  610.                  OS_EXIT_CRITICAL();
  611.              }
  612.              break;
  613. #endif
  614.         default:
  615.              OS_EXIT_CRITICAL();
  616.              flags_rdy = (OS_FLAGS)0;
  617.              *err      = OS_FLAG_ERR_WAIT_TYPE;
  618.              return (flags_rdy);
  619.     }
  620.     OS_Sched();                                            /* Find next HPT ready to run               */
  621.     OS_ENTER_CRITICAL();
  622.     if (OSTCBCur->OSTCBPendTO == OS_TRUE) {                /* Have we timed-out?                       */
  623.         OSTCBCur->OSTCBPendTO = OS_FALSE;
  624.         OS_FlagUnlink(&node);
  625.         OSTCBCur->OSTCBStat   = OS_STAT_RDY;               /* Yes, make task ready-to-run              */
  626.         OS_EXIT_CRITICAL();
  627.         flags_rdy             = (OS_FLAGS)0;
  628.         *err                  = OS_TIMEOUT;                /* Indicate that we timed-out waiting       */
  629.         return (flags_rdy);
  630.     }
  631.     flags_rdy = OSTCBCur->OSTCBFlagsRdy;
  632.     if (consume == OS_TRUE) {                              /* See if we need to consume the flags      */
  633.         switch (wait_type) {
  634.             case OS_FLAG_WAIT_SET_ALL:
  635.             case OS_FLAG_WAIT_SET_ANY:                     /* Clear ONLY the flags we got              */
  636.                  pgrp->OSFlagFlags &= ~flags_rdy;
  637.                  break;
  638. #if OS_FLAG_WAIT_CLR_EN > 0
  639.             case OS_FLAG_WAIT_CLR_ALL:
  640.             case OS_FLAG_WAIT_CLR_ANY:                     /* Set   ONLY the flags we got              */
  641.                  pgrp->OSFlagFlags |=  flags_rdy;
  642.                  break;
  643. #endif
  644.             default:
  645.                  OS_EXIT_CRITICAL();
  646.                  *err = OS_FLAG_ERR_WAIT_TYPE;
  647.                  return ((OS_FLAGS)0);
  648.         }
  649.     }
  650.     OS_EXIT_CRITICAL();
  651.     *err = OS_NO_ERR;                                      /* Event(s) must have occurred              */
  652.     return (flags_rdy);
  653. }
  654. /*$PAGE*/
  655. /*
  656. *********************************************************************************************************
  657. *                               GET FLAGS WHO CAUSED TASK TO BECOME READY
  658. *
  659. * Description: This function is called to obtain the flags that caused the task to become ready to run.
  660. *              In other words, this function allows you to tell "Who done it!".
  661. *
  662. * Arguments  : None
  663. *
  664. * Returns    : The flags that caused the task to be ready.
  665. *
  666. * Called from: Task ONLY
  667. *********************************************************************************************************
  668. */
  669. OS_FLAGS  OSFlagPendGetFlagsRdy (void)
  670. {
  671.     OS_FLAGS      flags;
  672. #if OS_CRITICAL_METHOD == 3                                /* Allocate storage for CPU status register */
  673.     OS_CPU_SR     cpu_sr = 0;
  674. #endif
  675.     OS_ENTER_CRITICAL();
  676.     flags = OSTCBCur->OSTCBFlagsRdy;
  677.     OS_EXIT_CRITICAL();
  678.     return (flags);
  679. }
  680. /*$PAGE*/
  681. /*
  682. *********************************************************************************************************
  683. *                                         POST EVENT FLAG BIT(S)
  684. *
  685. * Description: This function is called to set or clear some bits in an event flag group.  The bits to
  686. *              set or clear are specified by a 'bit mask'.
  687. *
  688. * Arguments  : pgrp          is a pointer to the desired event flag group.
  689. *
  690. *              flags         If 'opt' (see below) is OS_FLAG_SET, each bit that is set in 'flags' will
  691. *                            set the corresponding bit in the event flag group.  e.g. to set bits 0, 4
  692. *                            and 5 you would set 'flags' to:
  693. *
  694. *                                0x31     (note, bit 0 is least significant bit)
  695. *
  696. *                            If 'opt' (see below) is OS_FLAG_CLR, each bit that is set in 'flags' will
  697. *                            CLEAR the corresponding bit in the event flag group.  e.g. to clear bits 0,
  698. *                            4 and 5 you would specify 'flags' as:
  699. *
  700. *                                0x31     (note, bit 0 is least significant bit)
  701. *
  702. *              opt           indicates whether the flags will be:
  703. *                                set     (OS_FLAG_SET) or
  704. *                                cleared (OS_FLAG_CLR)
  705. *
  706. *              err           is a pointer to an error code and can be:
  707. *                            OS_NO_ERR              The call was successfull
  708. *                            OS_FLAG_INVALID_PGRP   You passed a NULL pointer
  709. *                            OS_ERR_EVENT_TYPE      You are not pointing to an event flag group
  710. *                            OS_FLAG_INVALID_OPT    You specified an invalid option
  711. *
  712. * Returns    : the new value of the event flags bits that are still set.
  713. *
  714. * Called From: Task or ISR
  715. *
  716. * WARNING(s) : 1) The execution time of this function depends on the number of tasks waiting on the event
  717. *                 flag group.
  718. *              2) The amount of time interrupts are DISABLED depends on the number of tasks waiting on
  719. *                 the event flag group.
  720. *********************************************************************************************************
  721. */
  722. OS_FLAGS  OSFlagPost (OS_FLAG_GRP *pgrp, OS_FLAGS flags, INT8U opt, INT8U *err)
  723. {
  724.     OS_FLAG_NODE *pnode;
  725.     BOOLEAN       sched;
  726.     OS_FLAGS      flags_cur;
  727.     OS_FLAGS      flags_rdy;
  728.     BOOLEAN       rdy;
  729. #if OS_CRITICAL_METHOD == 3                          /* Allocate storage for CPU status register       */
  730.     OS_CPU_SR     cpu_sr = 0;
  731. #endif
  732. #if OS_ARG_CHK_EN > 0
  733.     if (err == (INT8U *)0) {                         /* Validate 'err'                                 */
  734.         return ((OS_FLAGS)0);
  735.     }
  736.     if (pgrp == (OS_FLAG_GRP *)0) {                  /* Validate 'pgrp'                                */
  737.         *err = OS_FLAG_INVALID_PGRP;
  738.         return ((OS_FLAGS)0);
  739.     }
  740. #endif
  741.     if (pgrp->OSFlagType != OS_EVENT_TYPE_FLAG) {    /* Make sure we are pointing to an event flag grp */
  742.         *err = OS_ERR_EVENT_TYPE;
  743.         return ((OS_FLAGS)0);
  744.     }
  745. /*$PAGE*/
  746.     OS_ENTER_CRITICAL();
  747.     switch (opt) {
  748.         case OS_FLAG_CLR:
  749.              pgrp->OSFlagFlags &= ~flags;            /* Clear the flags specified in the group         */
  750.              break;
  751.         case OS_FLAG_SET:
  752.              pgrp->OSFlagFlags |=  flags;            /* Set   the flags specified in the group         */
  753.              break;
  754.         default:
  755.              OS_EXIT_CRITICAL();                     /* INVALID option                                 */
  756.              *err = OS_FLAG_INVALID_OPT;
  757.              return ((OS_FLAGS)0);
  758.     }
  759.     sched = OS_FALSE;                                /* Indicate that we don't need rescheduling       */
  760.     pnode = (OS_FLAG_NODE *)pgrp->OSFlagWaitList;
  761.     while (pnode != (OS_FLAG_NODE *)0) {             /* Go through all tasks waiting on event flag(s)  */
  762.         switch (pnode->OSFlagNodeWaitType) {
  763.             case OS_FLAG_WAIT_SET_ALL:               /* See if all req. flags are set for current node */
  764.                  flags_rdy = (OS_FLAGS)(pgrp->OSFlagFlags & pnode->OSFlagNodeFlags);
  765.                  if (flags_rdy == pnode->OSFlagNodeFlags) {
  766.                      rdy = OS_FlagTaskRdy(pnode, flags_rdy);  /* Make task RTR, event(s) Rx'd          */
  767.                      if (rdy == OS_TRUE) {
  768.                          sched = OS_TRUE;                     /* When done we will reschedule          */
  769.                      }
  770.                  }
  771.                  break;
  772.             case OS_FLAG_WAIT_SET_ANY:               /* See if any flag set                            */
  773.                  flags_rdy = (OS_FLAGS)(pgrp->OSFlagFlags & pnode->OSFlagNodeFlags);
  774.                  if (flags_rdy != (OS_FLAGS)0) {
  775.                      rdy = OS_FlagTaskRdy(pnode, flags_rdy);  /* Make task RTR, event(s) Rx'd          */
  776.                      if (rdy == OS_TRUE) {
  777.                          sched = OS_TRUE;                     /* When done we will reschedule          */
  778.                      }
  779.                  }
  780.                  break;
  781. #if OS_FLAG_WAIT_CLR_EN > 0
  782.             case OS_FLAG_WAIT_CLR_ALL:               /* See if all req. flags are set for current node */
  783.                  flags_rdy = (OS_FLAGS)(~pgrp->OSFlagFlags & pnode->OSFlagNodeFlags);
  784.                  if (flags_rdy == pnode->OSFlagNodeFlags) {
  785.                      rdy = OS_FlagTaskRdy(pnode, flags_rdy);  /* Make task RTR, event(s) Rx'd          */
  786.                      if (rdy == OS_TRUE) {
  787.                          sched = OS_TRUE;                     /* When done we will reschedule          */
  788.                      }
  789.                  }
  790.                  break;
  791.             case OS_FLAG_WAIT_CLR_ANY:               /* See if any flag set                            */
  792.                  flags_rdy = (OS_FLAGS)(~pgrp->OSFlagFlags & pnode->OSFlagNodeFlags);
  793.                  if (flags_rdy != (OS_FLAGS)0) {
  794.                      rdy = OS_FlagTaskRdy(pnode, flags_rdy);  /* Make task RTR, event(s) Rx'd          */
  795.                      if (rdy == OS_TRUE) {
  796.                          sched = OS_TRUE;                     /* When done we will reschedule          */
  797.                      }
  798.                  }
  799.                  break;
  800. #endif
  801.             default:
  802.                  OS_EXIT_CRITICAL();
  803.                  *err = OS_FLAG_ERR_WAIT_TYPE;
  804.                  return ((OS_FLAGS)0);
  805.         }
  806.         pnode = (OS_FLAG_NODE *)pnode->OSFlagNodeNext; /* Point to next task waiting for event flag(s) */
  807.     }
  808.     OS_EXIT_CRITICAL();
  809.     if (sched == OS_TRUE) {
  810.         OS_Sched();
  811.     }
  812.     OS_ENTER_CRITICAL();
  813.     flags_cur = pgrp->OSFlagFlags;
  814.     OS_EXIT_CRITICAL();
  815.     *err      = OS_NO_ERR;
  816.     return (flags_cur);
  817. }
  818. /*$PAGE*/
  819. /*
  820. *********************************************************************************************************
  821. *                                           QUERY EVENT FLAG
  822. *
  823. * Description: This function is used to check the value of the event flag group.
  824. *
  825. * Arguments  : pgrp         is a pointer to the desired event flag group.
  826. *
  827. *              err           is a pointer to an error code returned to the called:
  828. *                            OS_NO_ERR              The call was successfull
  829. *                            OS_FLAG_INVALID_PGRP   You passed a NULL pointer
  830. *                            OS_ERR_EVENT_TYPE      You are not pointing to an event flag group
  831. *
  832. * Returns    : The current value of the event flag group.
  833. *
  834. * Called From: Task or ISR
  835. *********************************************************************************************************
  836. */
  837. #if OS_FLAG_QUERY_EN > 0
  838. OS_FLAGS  OSFlagQuery (OS_FLAG_GRP *pgrp, INT8U *err)
  839. {
  840.     OS_FLAGS   flags;
  841. #if OS_CRITICAL_METHOD == 3                       /* Allocate storage for CPU status register          */
  842.     OS_CPU_SR  cpu_sr = 0;
  843. #endif
  844. #if OS_ARG_CHK_EN > 0
  845.     if (err == (INT8U *)0) {                      /* Validate 'err'                                    */
  846.         return ((OS_FLAGS)0);
  847.     }
  848.     if (pgrp == (OS_FLAG_GRP *)0) {               /* Validate 'pgrp'                                   */
  849.         *err = OS_FLAG_INVALID_PGRP;
  850.         return ((OS_FLAGS)0);
  851.     }
  852. #endif
  853.     if (pgrp->OSFlagType != OS_EVENT_TYPE_FLAG) { /* Validate event block type                         */
  854.         *err = OS_ERR_EVENT_TYPE;
  855.         return ((OS_FLAGS)0);
  856.     }
  857.     OS_ENTER_CRITICAL();
  858.     flags = pgrp->OSFlagFlags;
  859.     OS_EXIT_CRITICAL();
  860.     *err = OS_NO_ERR;
  861.     return (flags);                               /* Return the current value of the event flags       */
  862. }
  863. #endif
  864. /*$PAGE*/
  865. /*
  866. *********************************************************************************************************
  867. *                         SUSPEND TASK UNTIL EVENT FLAG(s) RECEIVED OR TIMEOUT OCCURS
  868. *
  869. * Description: This function is internal to uC/OS-II and is used to put a task to sleep until the desired
  870. *              event flag bit(s) are set.
  871. *
  872. * Arguments  : pgrp          is a pointer to the desired event flag group.
  873. *
  874. *              pnode         is a pointer to a structure which contains data about the task waiting for
  875. *                            event flag bit(s) to be set.
  876. *
  877. *              flags         Is a bit pattern indicating which bit(s) (i.e. flags) you wish to check.
  878. *                            The bits you want are specified by setting the corresponding bits in
  879. *                            'flags'.  e.g. if your application wants to wait for bits 0 and 1 then
  880. *                            'flags' would contain 0x03.
  881. *
  882. *              wait_type     specifies whether you want ALL bits to be set/cleared or ANY of the bits
  883. *                            to be set/cleared.
  884. *                            You can specify the following argument:
  885. *
  886. *                            OS_FLAG_WAIT_CLR_ALL   You will check ALL bits in 'mask' to be clear (0)
  887. *                            OS_FLAG_WAIT_CLR_ANY   You will check ANY bit  in 'mask' to be clear (0)
  888. *                            OS_FLAG_WAIT_SET_ALL   You will check ALL bits in 'mask' to be set   (1)
  889. *                            OS_FLAG_WAIT_SET_ANY   You will check ANY bit  in 'mask' to be set   (1)
  890. *
  891. *              timeout       is the desired amount of time that the task will wait for the event flag
  892. *                            bit(s) to be set.
  893. *
  894. * Returns    : none
  895. *
  896. * Called by  : OSFlagPend()  OS_FLAG.C
  897. *
  898. * Note(s)    : This function is INTERNAL to uC/OS-II and your application should not call it.
  899. *********************************************************************************************************
  900. */
  901. static  void  OS_FlagBlock (OS_FLAG_GRP *pgrp, OS_FLAG_NODE *pnode, OS_FLAGS flags, INT8U wait_type, INT16U timeout)
  902. {
  903.     OS_FLAG_NODE  *pnode_next;
  904.     INT8U          y;
  905.     OSTCBCur->OSTCBStat      |= OS_STAT_FLAG;
  906.     OSTCBCur->OSTCBPendTO     = OS_FALSE;
  907.     OSTCBCur->OSTCBDly        = timeout;              /* Store timeout in task's TCB                   */
  908.     OSTCBCur->OSTCBEventPtr   = (OS_EVENT *)0;
  909. #if OS_TASK_DEL_EN > 0
  910.     OSTCBCur->OSTCBFlagNode   = pnode;                /* TCB to link to node                           */
  911. #endif
  912.     pnode->OSFlagNodeFlags    = flags;                /* Save the flags that we need to wait for       */
  913.     pnode->OSFlagNodeWaitType = wait_type;            /* Save the type of wait we are doing            */
  914.     pnode->OSFlagNodeTCB      = (void *)OSTCBCur;     /* Link to task's TCB                            */
  915.     pnode->OSFlagNodeNext     = pgrp->OSFlagWaitList; /* Add node at beginning of event flag wait list */
  916.     pnode->OSFlagNodePrev     = (void *)0;
  917.     pnode->OSFlagNodeFlagGrp  = (void *)pgrp;         /* Link to Event Flag Group                      */
  918.     pnode_next                = (OS_FLAG_NODE *)pgrp->OSFlagWaitList;
  919.     if (pnode_next != (void *)0) {                    /* Is this the first NODE to insert?             */
  920.         pnode_next->OSFlagNodePrev = pnode;           /* No, link in doubly linked list                */
  921.     }
  922.     pgrp->OSFlagWaitList = (void *)pnode;
  923.     y            =  OSTCBCur->OSTCBY;                 /* Suspend current task until flag(s) received   */
  924.     OSRdyTbl[y] &= ~OSTCBCur->OSTCBBitX;
  925.     if (OSRdyTbl[y] == 0x00) {
  926.         OSRdyGrp &= ~OSTCBCur->OSTCBBitY;
  927.     }
  928. }
  929. /*$PAGE*/
  930. /*
  931. *********************************************************************************************************
  932. *                                    INITIALIZE THE EVENT FLAG MODULE
  933. *
  934. * Description: This function is called by uC/OS-II to initialize the event flag module.  Your application
  935. *              MUST NOT call this function.  In other words, this function is internal to uC/OS-II.
  936. *
  937. * Arguments  : none
  938. *
  939. * Returns    : none
  940. *
  941. * WARNING    : You MUST NOT call this function from your code.  This is an INTERNAL function to uC/OS-II.
  942. *********************************************************************************************************
  943. */
  944. void  OS_FlagInit (void)
  945. {
  946. #if OS_MAX_FLAGS == 1
  947.     OSFlagFreeList                 = (OS_FLAG_GRP *)&OSFlagTbl[0];  /* Only ONE event flag group!      */
  948.     OSFlagFreeList->OSFlagType     = OS_EVENT_TYPE_UNUSED;
  949.     OSFlagFreeList->OSFlagWaitList = (void *)0;
  950.     OSFlagFreeList->OSFlagFlags    = (OS_FLAGS)0;
  951. #if OS_FLAG_NAME_SIZE > 1
  952.     OSFlagFreeList->OSFlagName[0]  = '?';
  953.     OSFlagFreeList->OSFlagName[1]  = OS_ASCII_NUL;
  954. #endif
  955. #endif
  956. #if OS_MAX_FLAGS >= 2
  957.     INT16U       i;
  958.     OS_FLAG_GRP *pgrp1;
  959.     OS_FLAG_GRP *pgrp2;
  960.     OS_MemClr((INT8U *)&OSFlagTbl[0], sizeof(OSFlagTbl));           /* Clear the flag group table      */
  961.     pgrp1 = &OSFlagTbl[0];
  962.     pgrp2 = &OSFlagTbl[1];
  963.     for (i = 0; i < (OS_MAX_FLAGS - 1); i++) {                      /* Init. list of free EVENT FLAGS  */
  964.         pgrp1->OSFlagType     = OS_EVENT_TYPE_UNUSED;
  965.         pgrp1->OSFlagWaitList = (void *)pgrp2;
  966. #if OS_FLAG_NAME_SIZE > 1
  967.         pgrp1->OSFlagName[0]  = '?';                                /* Unknown name                    */
  968.         pgrp1->OSFlagName[1]  = OS_ASCII_NUL;
  969. #endif
  970.         pgrp1++;
  971.         pgrp2++;
  972.     }
  973.     pgrp1->OSFlagType     = OS_EVENT_TYPE_UNUSED;
  974.     pgrp1->OSFlagWaitList = (void *)0;
  975. #if OS_FLAG_NAME_SIZE > 1
  976.     pgrp1->OSFlagName[0]  = '?';                                    /* Unknown name                    */
  977.     pgrp1->OSFlagName[1]  = OS_ASCII_NUL;
  978. #endif
  979.     OSFlagFreeList        = &OSFlagTbl[0];
  980. #endif
  981. }
  982. /*$PAGE*/
  983. /*
  984. *********************************************************************************************************
  985. *                              MAKE TASK READY-TO-RUN, EVENT(s) OCCURRED
  986. *
  987. * Description: This function is internal to uC/OS-II and is used to make a task ready-to-run because the
  988. *              desired event flag bits have been set.
  989. *
  990. * Arguments  : pnode         is a pointer to a structure which contains data about the task waiting for
  991. *                            event flag bit(s) to be set.
  992. *
  993. *              flags_rdy     contains the bit pattern of the event flags that cause the task to become
  994. *                            ready-to-run.
  995. *
  996. * Returns    : OS_TRUE       If the task has been placed in the ready list and thus needs scheduling
  997. *              OS_FALSE      The task is still not ready to run and thus scheduling is not necessary
  998. *
  999. * Called by  : OSFlagsPost() OS_FLAG.C
  1000. *
  1001. * Note(s)    : 1) This function assumes that interrupts are disabled.
  1002. *              2) This function is INTERNAL to uC/OS-II and your application should not call it.
  1003. *********************************************************************************************************
  1004. */
  1005. static  BOOLEAN  OS_FlagTaskRdy (OS_FLAG_NODE *pnode, OS_FLAGS flags_rdy)
  1006. {
  1007.     OS_TCB   *ptcb;
  1008.     BOOLEAN   sched;
  1009.     ptcb                = (OS_TCB *)pnode->OSFlagNodeTCB;  /* Point to TCB of waiting task             */
  1010.     ptcb->OSTCBDly      = 0;
  1011.     ptcb->OSTCBFlagsRdy = flags_rdy;
  1012.     ptcb->OSTCBStat    &= ~OS_STAT_FLAG;
  1013.     ptcb->OSTCBPendTO   = OS_FALSE;
  1014.     if (ptcb->OSTCBStat == OS_STAT_RDY) {                  /* Task now ready?                          */
  1015.         OSRdyGrp               |= ptcb->OSTCBBitY;         /* Put task into ready list                 */
  1016.         OSRdyTbl[ptcb->OSTCBY] |= ptcb->OSTCBBitX;
  1017.         sched                   = OS_TRUE;
  1018.     } else {
  1019.         sched                   = OS_FALSE;
  1020.     }
  1021.     OS_FlagUnlink(pnode);
  1022.     return (sched);
  1023. }
  1024. /*$PAGE*/
  1025. /*
  1026. *********************************************************************************************************
  1027. *                                  UNLINK EVENT FLAG NODE FROM WAITING LIST
  1028. *
  1029. * Description: This function is internal to uC/OS-II and is used to unlink an event flag node from a
  1030. *              list of tasks waiting for the event flag.
  1031. *
  1032. * Arguments  : pnode         is a pointer to a structure which contains data about the task waiting for
  1033. *                            event flag bit(s) to be set.
  1034. *
  1035. * Returns    : none
  1036. *
  1037. * Called by  : OS_FlagTaskRdy() OS_FLAG.C
  1038. *              OSFlagPend()     OS_FLAG.C
  1039. *              OSTaskDel()      OS_TASK.C
  1040. *
  1041. * Note(s)    : 1) This function assumes that interrupts are disabled.
  1042. *              2) This function is INTERNAL to uC/OS-II and your application should not call it.
  1043. *********************************************************************************************************
  1044. */
  1045. void  OS_FlagUnlink (OS_FLAG_NODE *pnode)
  1046. {
  1047. #if OS_TASK_DEL_EN > 0
  1048.     OS_TCB       *ptcb;
  1049. #endif
  1050.     OS_FLAG_GRP  *pgrp;
  1051.     OS_FLAG_NODE *pnode_prev;
  1052.     OS_FLAG_NODE *pnode_next;
  1053.     pnode_prev = (OS_FLAG_NODE *)pnode->OSFlagNodePrev;
  1054.     pnode_next = (OS_FLAG_NODE *)pnode->OSFlagNodeNext;
  1055.     if (pnode_prev == (OS_FLAG_NODE *)0) {                      /* Is it first node in wait list?      */
  1056.         pgrp                 = (OS_FLAG_GRP *)pnode->OSFlagNodeFlagGrp;
  1057.         pgrp->OSFlagWaitList = (void *)pnode_next;              /*      Update list for new 1st node   */
  1058.         if (pnode_next != (OS_FLAG_NODE *)0) {
  1059.             pnode_next->OSFlagNodePrev = (OS_FLAG_NODE *)0;     /*      Link new 1st node PREV to NULL */
  1060.         }
  1061.     } else {                                                    /* No,  A node somewhere in the list   */
  1062.         pnode_prev->OSFlagNodeNext = pnode_next;                /*      Link around the node to unlink */
  1063.         if (pnode_next != (OS_FLAG_NODE *)0) {                  /*      Was this the LAST node?        */
  1064.             pnode_next->OSFlagNodePrev = pnode_prev;            /*      No, Link around current node   */
  1065.         }
  1066.     }
  1067. #if OS_TASK_DEL_EN > 0
  1068.     ptcb                = (OS_TCB *)pnode->OSFlagNodeTCB;
  1069.     ptcb->OSTCBFlagNode = (OS_FLAG_NODE *)0;
  1070. #endif
  1071. }
  1072. #endif