os_mutex.c
上传用户:ht5068443
上传日期:2016-07-26
资源大小:802k
文件大小:37k
源码类别:

MacOS编程

开发平台:

C/C++

  1. /*
  2. *********************************************************************************************************
  3. *                                                uC/OS-II
  4. *                                          The Real-Time Kernel
  5. *                                  MUTUAL EXCLUSION SEMAPHORE MANAGEMENT
  6. *
  7. *                              (c) Copyright 1992-2009, Micrium, Weston, FL
  8. *                                           All Rights Reserved
  9. *
  10. * File    : OS_MUTEX.C
  11. * By      : Jean J. Labrosse
  12. * Version : V2.88
  13. *
  14. * LICENSING TERMS:
  15. * ---------------
  16. *   uC/OS-II is provided in source form for FREE evaluation, for educational use or for peaceful research.  
  17. * If you plan on using  uC/OS-II  in a commercial product you need to contact Micri祄 to properly license 
  18. * its use in your product. We provide ALL the source code for your convenience and to help you experience 
  19. * uC/OS-II.   The fact that the  source is provided does  NOT  mean that you can use it without  paying a 
  20. * licensing fee.
  21. *********************************************************************************************************
  22. */
  23. #ifndef  OS_MASTER_FILE
  24. #include <ucos_ii.h>
  25. #endif
  26. #if OS_MUTEX_EN > 0
  27. /*
  28. *********************************************************************************************************
  29. *                                            LOCAL CONSTANTS
  30. *********************************************************************************************************
  31. */
  32. #define  OS_MUTEX_KEEP_LOWER_8   ((INT16U)0x00FFu)
  33. #define  OS_MUTEX_KEEP_UPPER_8   ((INT16U)0xFF00u)
  34. #define  OS_MUTEX_AVAILABLE      ((INT16U)0x00FFu)
  35. /*
  36. *********************************************************************************************************
  37. *                                            LOCAL CONSTANTS
  38. *********************************************************************************************************
  39. */
  40. static  void  OSMutex_RdyAtPrio(OS_TCB *ptcb, INT8U prio);
  41. /*$PAGE*/
  42. /*
  43. *********************************************************************************************************
  44. *                                   ACCEPT MUTUAL EXCLUSION SEMAPHORE
  45. *
  46. * Description: This  function checks the mutual exclusion semaphore to see if a resource is available.
  47. *              Unlike OSMutexPend(), OSMutexAccept() does not suspend the calling task if the resource is
  48. *              not available or the event did not occur.
  49. *
  50. * Arguments  : pevent     is a pointer to the event control block
  51. *
  52. *              perr       is a pointer to an error code which will be returned to your application:
  53. *                            OS_ERR_NONE         if the call was successful.
  54. *                            OS_ERR_EVENT_TYPE   if 'pevent' is not a pointer to a mutex
  55. *                            OS_ERR_PEVENT_NULL  'pevent' is a NULL pointer
  56. *                            OS_ERR_PEND_ISR     if you called this function from an ISR
  57. *                            OS_ERR_PIP_LOWER    If the priority of the task that owns the Mutex is
  58. *                                                HIGHER (i.e. a lower number) than the PIP.  This error
  59. *                                                indicates that you did not set the PIP higher (lower
  60. *                                                number) than ALL the tasks that compete for the Mutex.
  61. *                                                Unfortunately, this is something that could not be
  62. *                                                detected when the Mutex is created because we don't know
  63. *                                                what tasks will be using the Mutex.
  64. *
  65. * Returns    : == OS_TRUE    if the resource is available, the mutual exclusion semaphore is acquired
  66. *              == OS_FALSE   a) if the resource is not available
  67. *                            b) you didn't pass a pointer to a mutual exclusion semaphore
  68. *                            c) you called this function from an ISR
  69. *
  70. * Warning(s) : This function CANNOT be called from an ISR because mutual exclusion semaphores are
  71. *              intended to be used by tasks only.
  72. *********************************************************************************************************
  73. */
  74. #if OS_MUTEX_ACCEPT_EN > 0
  75. BOOLEAN  OSMutexAccept (OS_EVENT  *pevent, 
  76.                         INT8U     *perr)
  77. {
  78.     INT8U      pip;                                    /* Priority Inheritance Priority (PIP)          */
  79. #if OS_CRITICAL_METHOD == 3                            /* Allocate storage for CPU status register     */
  80.     OS_CPU_SR  cpu_sr = 0;
  81. #endif
  82. #if OS_ARG_CHK_EN > 0
  83.     if (perr == (INT8U *)0) {                          /* Validate 'perr'                              */
  84.         return (OS_FALSE);
  85.     }
  86.     if (pevent == (OS_EVENT *)0) {                     /* Validate 'pevent'                            */
  87.         *perr = OS_ERR_PEVENT_NULL;
  88.         return (OS_FALSE);
  89.     }
  90. #endif
  91.     if (pevent->OSEventType != OS_EVENT_TYPE_MUTEX) {  /* Validate event block type                    */
  92.         *perr = OS_ERR_EVENT_TYPE;
  93.         return (OS_FALSE);
  94.     }
  95.     if (OSIntNesting > 0) {                            /* Make sure it's not called from an ISR        */
  96.         *perr = OS_ERR_PEND_ISR;
  97.         return (OS_FALSE);
  98.     }
  99.     OS_ENTER_CRITICAL();                               /* Get value (0 or 1) of Mutex                  */
  100.     pip = (INT8U)(pevent->OSEventCnt >> 8);            /* Get PIP from mutex                           */
  101.     if ((pevent->OSEventCnt & OS_MUTEX_KEEP_LOWER_8) == OS_MUTEX_AVAILABLE) {
  102.         pevent->OSEventCnt &= OS_MUTEX_KEEP_UPPER_8;   /*      Mask off LSByte (Acquire Mutex)         */
  103.         pevent->OSEventCnt |= OSTCBCur->OSTCBPrio;     /*      Save current task priority in LSByte    */
  104.         pevent->OSEventPtr  = (void *)OSTCBCur;        /*      Link TCB of task owning Mutex           */
  105.         if (OSTCBCur->OSTCBPrio <= pip) {              /*      PIP 'must' have a SMALLER prio ...      */
  106.             OS_EXIT_CRITICAL();                        /*      ... than current task!                  */
  107.             *perr = OS_ERR_PIP_LOWER;
  108.         } else {
  109.             OS_EXIT_CRITICAL();
  110.             *perr = OS_ERR_NONE;
  111.         }
  112.         return (OS_TRUE);
  113.     }
  114.     OS_EXIT_CRITICAL();
  115.     *perr = OS_ERR_NONE;
  116.     return (OS_FALSE);
  117. }
  118. #endif
  119. /*$PAGE*/
  120. /*
  121. *********************************************************************************************************
  122. *                                  CREATE A MUTUAL EXCLUSION SEMAPHORE
  123. *
  124. * Description: This function creates a mutual exclusion semaphore.
  125. *
  126. * Arguments  : prio          is the priority to use when accessing the mutual exclusion semaphore.  In
  127. *                            other words, when the semaphore is acquired and a higher priority task
  128. *                            attempts to obtain the semaphore then the priority of the task owning the
  129. *                            semaphore is raised to this priority.  It is assumed that you will specify
  130. *                            a priority that is LOWER in value than ANY of the tasks competing for the
  131. *                            mutex.
  132. *
  133. *              perr          is a pointer to an error code which will be returned to your application:
  134. *                               OS_ERR_NONE         if the call was successful.
  135. *                               OS_ERR_CREATE_ISR   if you attempted to create a MUTEX from an ISR
  136. *                               OS_ERR_PRIO_EXIST   if a task at the priority inheritance priority
  137. *                                                   already exist.
  138. *                               OS_ERR_PEVENT_NULL  No more event control blocks available.
  139. *                               OS_ERR_PRIO_INVALID if the priority you specify is higher that the
  140. *                                                   maximum allowed (i.e. > OS_LOWEST_PRIO)
  141. *
  142. * Returns    : != (void *)0  is a pointer to the event control clock (OS_EVENT) associated with the
  143. *                            created mutex.
  144. *              == (void *)0  if an error is detected.
  145. *
  146. * Note(s)    : 1) The LEAST significant 8 bits of '.OSEventCnt' are used to hold the priority number
  147. *                 of the task owning the mutex or 0xFF if no task owns the mutex.
  148. *
  149. *              2) The MOST  significant 8 bits of '.OSEventCnt' are used to hold the priority number
  150. *                 to use to reduce priority inversion.
  151. *********************************************************************************************************
  152. */
  153. OS_EVENT  *OSMutexCreate (INT8U   prio, 
  154.                           INT8U  *perr)
  155. {
  156.     OS_EVENT  *pevent;
  157. #if OS_CRITICAL_METHOD == 3                                /* Allocate storage for CPU status register */
  158.     OS_CPU_SR  cpu_sr = 0;
  159. #endif
  160. #if OS_ARG_CHK_EN > 0
  161.     if (perr == (INT8U *)0) {                              /* Validate 'perr'                          */
  162.         return ((OS_EVENT *)0);
  163.     }
  164.     if (prio >= OS_LOWEST_PRIO) {                          /* Validate PIP                             */
  165.         *perr = OS_ERR_PRIO_INVALID;
  166.         return ((OS_EVENT *)0);
  167.     }
  168. #endif
  169.     if (OSIntNesting > 0) {                                /* See if called from ISR ...               */
  170.         *perr = OS_ERR_CREATE_ISR;                         /* ... can't CREATE mutex from an ISR       */
  171.         return ((OS_EVENT *)0);
  172.     }
  173.     OS_ENTER_CRITICAL();
  174.     if (OSTCBPrioTbl[prio] != (OS_TCB *)0) {               /* Mutex priority must not already exist    */
  175.         OS_EXIT_CRITICAL();                                /* Task already exist at priority ...       */
  176.         *perr = OS_ERR_PRIO_EXIST;                         /* ... inheritance priority                 */
  177.         return ((OS_EVENT *)0);
  178.     }
  179.     OSTCBPrioTbl[prio] = OS_TCB_RESERVED;                  /* Reserve the table entry                  */
  180.     pevent             = OSEventFreeList;                  /* Get next free event control block        */
  181.     if (pevent == (OS_EVENT *)0) {                         /* See if an ECB was available              */
  182.         OSTCBPrioTbl[prio] = (OS_TCB *)0;                  /* No, Release the table entry              */
  183.         OS_EXIT_CRITICAL();
  184.         *perr              = OS_ERR_PEVENT_NULL;           /* No more event control blocks             */
  185.         return (pevent);
  186.     }
  187.     OSEventFreeList        = (OS_EVENT *)OSEventFreeList->OSEventPtr;   /* Adjust the free list        */
  188.     OS_EXIT_CRITICAL();
  189.     pevent->OSEventType    = OS_EVENT_TYPE_MUTEX;
  190.     pevent->OSEventCnt     = (INT16U)((INT16U)prio << 8) | OS_MUTEX_AVAILABLE; /* Resource is avail.   */
  191.     pevent->OSEventPtr     = (void *)0;                                 /* No task owning the mutex    */
  192. #if OS_EVENT_NAME_EN > 0
  193.     pevent->OSEventName    = "?";                                       /* Unknown name                */
  194. #endif
  195.     OS_EventWaitListInit(pevent);
  196.     *perr                  = OS_ERR_NONE;
  197.     return (pevent);
  198. }
  199. /*$PAGE*/
  200. /*
  201. *********************************************************************************************************
  202. *                                          DELETE A MUTEX
  203. *
  204. * Description: This function deletes a mutual exclusion semaphore and readies all tasks pending on the it.
  205. *
  206. * Arguments  : pevent        is a pointer to the event control block associated with the desired mutex.
  207. *
  208. *              opt           determines delete options as follows:
  209. *                            opt == OS_DEL_NO_PEND   Delete mutex ONLY if no task pending
  210. *                            opt == OS_DEL_ALWAYS    Deletes the mutex even if tasks are waiting.
  211. *                                                    In this case, all the tasks pending will be readied.
  212. *
  213. *              perr          is a pointer to an error code that can contain one of the following values:
  214. *                            OS_ERR_NONE             The call was successful and the mutex was deleted
  215. *                            OS_ERR_DEL_ISR          If you attempted to delete the MUTEX from an ISR
  216. *                            OS_ERR_INVALID_OPT      An invalid option was specified
  217. *                            OS_ERR_TASK_WAITING     One or more tasks were waiting on the mutex
  218. *                            OS_ERR_EVENT_TYPE       If you didn't pass a pointer to a mutex
  219. *                            OS_ERR_PEVENT_NULL      If 'pevent' is a NULL pointer.
  220. *
  221. * Returns    : pevent        upon error
  222. *              (OS_EVENT *)0 if the mutex was successfully deleted.
  223. *
  224. * Note(s)    : 1) This function must be used with care.  Tasks that would normally expect the presence of
  225. *                 the mutex MUST check the return code of OSMutexPend().
  226. *
  227. *              2) This call can potentially disable interrupts for a long time.  The interrupt disable
  228. *                 time is directly proportional to the number of tasks waiting on the mutex.
  229. *
  230. *              3) Because ALL tasks pending on the mutex will be readied, you MUST be careful because the
  231. *                 resource(s) will no longer be guarded by the mutex.
  232. *
  233. *              4) IMPORTANT: In the 'OS_DEL_ALWAYS' case, we assume that the owner of the Mutex (if there
  234. *                            is one) is ready-to-run and is thus NOT pending on another kernel object or
  235. *                            has delayed itself.  In other words, if a task owns the mutex being deleted,
  236. *                            that task will be made ready-to-run at its original priority.
  237. *********************************************************************************************************
  238. */
  239. #if OS_MUTEX_DEL_EN
  240. OS_EVENT  *OSMutexDel (OS_EVENT  *pevent, 
  241.                        INT8U      opt, 
  242.                        INT8U     *perr)
  243. {
  244.     BOOLEAN    tasks_waiting;
  245.     OS_EVENT  *pevent_return;
  246.     INT8U      pip;                                        /* Priority inheritance priority            */
  247.     INT8U      prio;
  248.     OS_TCB    *ptcb;
  249. #if OS_CRITICAL_METHOD == 3                                /* Allocate storage for CPU status register */
  250.     OS_CPU_SR  cpu_sr = 0;
  251. #endif
  252. #if OS_ARG_CHK_EN > 0
  253.     if (perr == (INT8U *)0) {                              /* Validate 'perr'                          */
  254.         return (pevent);
  255.     }
  256.     if (pevent == (OS_EVENT *)0) {                         /* Validate 'pevent'                        */
  257.         *perr = OS_ERR_PEVENT_NULL;
  258.         return (pevent);
  259.     }
  260. #endif
  261.     if (pevent->OSEventType != OS_EVENT_TYPE_MUTEX) {      /* Validate event block type                */
  262.         *perr = OS_ERR_EVENT_TYPE;
  263.         return (pevent);
  264.     }
  265.     if (OSIntNesting > 0) {                                /* See if called from ISR ...               */
  266.         *perr = OS_ERR_DEL_ISR;                             /* ... can't DELETE from an ISR             */
  267.         return (pevent);
  268.     }
  269.     OS_ENTER_CRITICAL();
  270.     if (pevent->OSEventGrp != 0) {                         /* See if any tasks waiting on mutex        */
  271.         tasks_waiting = OS_TRUE;                           /* Yes                                      */
  272.     } else {
  273.         tasks_waiting = OS_FALSE;                          /* No                                       */
  274.     }
  275.     switch (opt) {
  276.         case OS_DEL_NO_PEND:                               /* DELETE MUTEX ONLY IF NO TASK WAITING --- */
  277.              if (tasks_waiting == OS_FALSE) {
  278. #if OS_EVENT_NAME_EN > 0
  279.                  pevent->OSEventName = "?";                /* Unknown name                             */
  280. #endif
  281.                  pip                 = (INT8U)(pevent->OSEventCnt >> 8);
  282.                  OSTCBPrioTbl[pip]   = (OS_TCB *)0;        /* Free up the PIP                          */
  283.                  pevent->OSEventType = OS_EVENT_TYPE_UNUSED;
  284.                  pevent->OSEventPtr  = OSEventFreeList;    /* Return Event Control Block to free list  */
  285.                  pevent->OSEventCnt  = 0;
  286.                  OSEventFreeList     = pevent;
  287.                  OS_EXIT_CRITICAL();
  288.                  *perr               = OS_ERR_NONE;
  289.                  pevent_return       = (OS_EVENT *)0;      /* Mutex has been deleted                   */
  290.              } else {
  291.                  OS_EXIT_CRITICAL();
  292.                  *perr               = OS_ERR_TASK_WAITING;
  293.                  pevent_return       = pevent;
  294.              }
  295.              break;
  296.         case OS_DEL_ALWAYS:                                /* ALWAYS DELETE THE MUTEX ---------------- */
  297.              pip  = (INT8U)(pevent->OSEventCnt >> 8);                     /* Get PIP of mutex          */
  298.              prio = (INT8U)(pevent->OSEventCnt & OS_MUTEX_KEEP_LOWER_8);  /* Get owner's original prio */
  299.              ptcb = (OS_TCB *)pevent->OSEventPtr;
  300.              if (ptcb != (OS_TCB *)0) {                    /* See if any task owns the mutex           */
  301.                  if (ptcb->OSTCBPrio == pip) {             /* See if original prio was changed         */
  302.                      OSMutex_RdyAtPrio(ptcb, prio);        /* Yes, Restore the task's original prio    */
  303.                  }
  304.              }
  305.              while (pevent->OSEventGrp != 0) {             /* Ready ALL tasks waiting for mutex        */
  306.                  (void)OS_EventTaskRdy(pevent, (void *)0, OS_STAT_MUTEX, OS_STAT_PEND_OK);
  307.              }
  308. #if OS_EVENT_NAME_EN > 0
  309.              pevent->OSEventName = "?";                    /* Unknown name                             */
  310. #endif
  311.              pip                 = (INT8U)(pevent->OSEventCnt >> 8);
  312.              OSTCBPrioTbl[pip]   = (OS_TCB *)0;            /* Free up the PIP                          */
  313.              pevent->OSEventType = OS_EVENT_TYPE_UNUSED;
  314.              pevent->OSEventPtr  = OSEventFreeList;        /* Return Event Control Block to free list  */
  315.              pevent->OSEventCnt  = 0;
  316.              OSEventFreeList     = pevent;                 /* Get next free event control block        */
  317.              OS_EXIT_CRITICAL();
  318.              if (tasks_waiting == OS_TRUE) {               /* Reschedule only if task(s) were waiting  */
  319.                  OS_Sched();                               /* Find highest priority task ready to run  */
  320.              }
  321.              *perr         = OS_ERR_NONE;
  322.              pevent_return = (OS_EVENT *)0;                /* Mutex has been deleted                   */
  323.              break;
  324.         default:
  325.              OS_EXIT_CRITICAL();
  326.              *perr         = OS_ERR_INVALID_OPT;
  327.              pevent_return = pevent;
  328.              break;
  329.     }
  330.     return (pevent_return);
  331. }
  332. #endif
  333. /*$PAGE*/
  334. /*
  335. *********************************************************************************************************
  336. *                                  PEND ON MUTUAL EXCLUSION SEMAPHORE
  337. *
  338. * Description: This function waits for a mutual exclusion semaphore.
  339. *
  340. * Arguments  : pevent        is a pointer to the event control block associated with the desired
  341. *                            mutex.
  342. *
  343. *              timeout       is an optional timeout period (in clock ticks).  If non-zero, your task will
  344. *                            wait for the resource up to the amount of time specified by this argument.
  345. *                            If you specify 0, however, your task will wait forever at the specified
  346. *                            mutex or, until the resource becomes available.
  347. *
  348. *              perr          is a pointer to where an error message will be deposited.  Possible error
  349. *                            messages are:
  350. *                               OS_ERR_NONE        The call was successful and your task owns the mutex
  351. *                               OS_ERR_TIMEOUT     The mutex was not available within the specified 'timeout'.
  352. *                               OS_ERR_PEND_ABORT  The wait on the mutex was aborted.
  353. *                               OS_ERR_EVENT_TYPE  If you didn't pass a pointer to a mutex
  354. *                               OS_ERR_PEVENT_NULL 'pevent' is a NULL pointer
  355. *                               OS_ERR_PEND_ISR    If you called this function from an ISR and the result
  356. *                                                  would lead to a suspension.
  357. *                               OS_ERR_PIP_LOWER   If the priority of the task that owns the Mutex is
  358. *                                                  HIGHER (i.e. a lower number) than the PIP.  This error
  359. *                                                  indicates that you did not set the PIP higher (lower
  360. *                                                  number) than ALL the tasks that compete for the Mutex.
  361. *                                                  Unfortunately, this is something that could not be
  362. *                                                  detected when the Mutex is created because we don't know
  363. *                                                  what tasks will be using the Mutex.
  364. *                               OS_ERR_PEND_LOCKED If you called this function when the scheduler is locked
  365. *
  366. * Returns    : none
  367. *
  368. * Note(s)    : 1) The task that owns the Mutex MUST NOT pend on any other event while it owns the mutex.
  369. *
  370. *              2) You MUST NOT change the priority of the task that owns the mutex
  371. *********************************************************************************************************
  372. */
  373. void  OSMutexPend (OS_EVENT  *pevent, 
  374.                    INT32U     timeout, 
  375.                    INT8U     *perr)
  376. {
  377.     INT8U      pip;                                        /* Priority Inheritance Priority (PIP)      */
  378.     INT8U      mprio;                                      /* Mutex owner priority                     */
  379.     BOOLEAN    rdy;                                        /* Flag indicating task was ready           */
  380.     OS_TCB    *ptcb;
  381.     OS_EVENT  *pevent2;
  382.     INT8U      y;
  383. #if OS_CRITICAL_METHOD == 3                                /* Allocate storage for CPU status register */
  384.     OS_CPU_SR  cpu_sr = 0;
  385. #endif
  386. #if OS_ARG_CHK_EN > 0
  387.     if (perr == (INT8U *)0) {                              /* Validate 'perr'                          */
  388.         return;
  389.     }
  390.     if (pevent == (OS_EVENT *)0) {                         /* Validate 'pevent'                        */
  391.         *perr = OS_ERR_PEVENT_NULL;
  392.         return;
  393.     }
  394. #endif
  395.     if (pevent->OSEventType != OS_EVENT_TYPE_MUTEX) {      /* Validate event block type                */
  396.         *perr = OS_ERR_EVENT_TYPE;
  397.         return;
  398.     }
  399.     if (OSIntNesting > 0) {                                /* See if called from ISR ...               */
  400.         *perr = OS_ERR_PEND_ISR;                           /* ... can't PEND from an ISR               */
  401.         return;
  402.     }
  403.     if (OSLockNesting > 0) {                               /* See if called with scheduler locked ...  */
  404.         *perr = OS_ERR_PEND_LOCKED;                        /* ... can't PEND when locked               */
  405.         return;
  406.     }
  407. /*$PAGE*/
  408.     OS_ENTER_CRITICAL();
  409.     pip = (INT8U)(pevent->OSEventCnt >> 8);                /* Get PIP from mutex                       */
  410.                                                            /* Is Mutex available?                      */
  411.     if ((INT8U)(pevent->OSEventCnt & OS_MUTEX_KEEP_LOWER_8) == OS_MUTEX_AVAILABLE) {
  412.         pevent->OSEventCnt &= OS_MUTEX_KEEP_UPPER_8;       /* Yes, Acquire the resource                */
  413.         pevent->OSEventCnt |= OSTCBCur->OSTCBPrio;         /*      Save priority of owning task        */
  414.         pevent->OSEventPtr  = (void *)OSTCBCur;            /*      Point to owning task's OS_TCB       */
  415.         if (OSTCBCur->OSTCBPrio <= pip) {                  /*      PIP 'must' have a SMALLER prio ...  */
  416.             OS_EXIT_CRITICAL();                            /*      ... than current task!              */
  417.             *perr = OS_ERR_PIP_LOWER;
  418.         } else {
  419.             OS_EXIT_CRITICAL();
  420.             *perr = OS_ERR_NONE;
  421.         }
  422.         return;
  423.     }
  424.     mprio = (INT8U)(pevent->OSEventCnt & OS_MUTEX_KEEP_LOWER_8);  /* No, Get priority of mutex owner   */
  425.     ptcb  = (OS_TCB *)(pevent->OSEventPtr);                       /*     Point to TCB of mutex owner   */
  426.     if (ptcb->OSTCBPrio > pip) {                                  /*     Need to promote prio of owner?*/
  427.         if (mprio > OSTCBCur->OSTCBPrio) {
  428.             y = ptcb->OSTCBY;
  429.             if ((OSRdyTbl[y] & ptcb->OSTCBBitX) != 0) {           /*     See if mutex owner is ready   */
  430.                 OSRdyTbl[y] &= ~ptcb->OSTCBBitX;                  /*     Yes, Remove owner from Rdy ...*/
  431.                 if (OSRdyTbl[y] == 0) {                           /*          ... list at current prio */
  432.                     OSRdyGrp &= ~ptcb->OSTCBBitY;
  433.                 }
  434.                 rdy = OS_TRUE;
  435.             } else {
  436.                 pevent2 = ptcb->OSTCBEventPtr;
  437.                 if (pevent2 != (OS_EVENT *)0) {                   /* Remove from event wait list       */
  438.                     if ((pevent2->OSEventTbl[ptcb->OSTCBY] &= ~ptcb->OSTCBBitX) == 0) {
  439.                         pevent2->OSEventGrp &= ~ptcb->OSTCBBitY;
  440.                     }
  441.                 }
  442.                 rdy = OS_FALSE;                            /* No                                       */
  443.             }
  444.             ptcb->OSTCBPrio = pip;                         /* Change owner task prio to PIP            */
  445. #if OS_LOWEST_PRIO <= 63
  446.             ptcb->OSTCBY    = (INT8U)( ptcb->OSTCBPrio >> 3);
  447.             ptcb->OSTCBX    = (INT8U)( ptcb->OSTCBPrio & 0x07);
  448.             ptcb->OSTCBBitY = (INT8U)(1 << ptcb->OSTCBY);
  449.             ptcb->OSTCBBitX = (INT8U)(1 << ptcb->OSTCBX);
  450. #else
  451.             ptcb->OSTCBY    = (INT8U)((ptcb->OSTCBPrio >> 4) & 0xFF);
  452.             ptcb->OSTCBX    = (INT8U)( ptcb->OSTCBPrio & 0x0F);
  453.             ptcb->OSTCBBitY = (INT16U)(1 << ptcb->OSTCBY);
  454.             ptcb->OSTCBBitX = (INT16U)(1 << ptcb->OSTCBX);
  455. #endif
  456.             if (rdy == OS_TRUE) {                          /* If task was ready at owner's priority ...*/
  457.                 OSRdyGrp               |= ptcb->OSTCBBitY; /* ... make it ready at new priority.       */
  458.                 OSRdyTbl[ptcb->OSTCBY] |= ptcb->OSTCBBitX;
  459.             } else {
  460.                 pevent2 = ptcb->OSTCBEventPtr;
  461.                 if (pevent2 != (OS_EVENT *)0) {            /* Add to event wait list                   */
  462.                     pevent2->OSEventGrp               |= ptcb->OSTCBBitY;
  463.                     pevent2->OSEventTbl[ptcb->OSTCBY] |= ptcb->OSTCBBitX;
  464.                 }
  465.             }
  466.             OSTCBPrioTbl[pip] = ptcb;
  467.         }
  468.     }
  469.     OSTCBCur->OSTCBStat     |= OS_STAT_MUTEX;         /* Mutex not available, pend current task        */
  470.     OSTCBCur->OSTCBStatPend  = OS_STAT_PEND_OK;
  471.     OSTCBCur->OSTCBDly       = timeout;               /* Store timeout in current task's TCB           */
  472.     OS_EventTaskWait(pevent);                         /* Suspend task until event or timeout occurs    */
  473.     OS_EXIT_CRITICAL();
  474.     OS_Sched();                                       /* Find next highest priority task ready         */
  475.     OS_ENTER_CRITICAL();
  476.     switch (OSTCBCur->OSTCBStatPend) {                /* See if we timed-out or aborted                */
  477.         case OS_STAT_PEND_OK:
  478.              *perr = OS_ERR_NONE;
  479.              break;
  480.         case OS_STAT_PEND_ABORT:
  481.              *perr = OS_ERR_PEND_ABORT;               /* Indicate that we aborted getting mutex        */
  482.              break;
  483.              
  484.         case OS_STAT_PEND_TO:
  485.         default:
  486.              OS_EventTaskRemove(OSTCBCur, pevent);
  487.              *perr = OS_ERR_TIMEOUT;                  /* Indicate that we didn't get mutex within TO   */
  488.              break;
  489.     }
  490.     OSTCBCur->OSTCBStat          =  OS_STAT_RDY;      /* Set   task  status to ready                   */
  491.     OSTCBCur->OSTCBStatPend      =  OS_STAT_PEND_OK;  /* Clear pend  status                            */
  492.     OSTCBCur->OSTCBEventPtr      = (OS_EVENT  *)0;    /* Clear event pointers                          */
  493. #if (OS_EVENT_MULTI_EN > 0)
  494.     OSTCBCur->OSTCBEventMultiPtr = (OS_EVENT **)0;
  495. #endif
  496.     OS_EXIT_CRITICAL();
  497. }
  498. /*$PAGE*/
  499. /*
  500. *********************************************************************************************************
  501. *                                  POST TO A MUTUAL EXCLUSION SEMAPHORE
  502. *
  503. * Description: This function signals a mutual exclusion semaphore
  504. *
  505. * Arguments  : pevent              is a pointer to the event control block associated with the desired
  506. *                                  mutex.
  507. *
  508. * Returns    : OS_ERR_NONE             The call was successful and the mutex was signaled.
  509. *              OS_ERR_EVENT_TYPE       If you didn't pass a pointer to a mutex
  510. *              OS_ERR_PEVENT_NULL      'pevent' is a NULL pointer
  511. *              OS_ERR_POST_ISR         Attempted to post from an ISR (not valid for MUTEXes)
  512. *              OS_ERR_NOT_MUTEX_OWNER  The task that did the post is NOT the owner of the MUTEX.
  513. *              OS_ERR_PIP_LOWER        If the priority of the new task that owns the Mutex is
  514. *                                      HIGHER (i.e. a lower number) than the PIP.  This error
  515. *                                      indicates that you did not set the PIP higher (lower
  516. *                                      number) than ALL the tasks that compete for the Mutex.
  517. *                                      Unfortunately, this is something that could not be
  518. *                                      detected when the Mutex is created because we don't know
  519. *                                      what tasks will be using the Mutex.
  520. *********************************************************************************************************
  521. */
  522. INT8U  OSMutexPost (OS_EVENT *pevent)
  523. {
  524.     INT8U      pip;                                   /* Priority inheritance priority                 */
  525.     INT8U      prio;
  526. #if OS_CRITICAL_METHOD == 3                           /* Allocate storage for CPU status register      */
  527.     OS_CPU_SR  cpu_sr = 0;
  528. #endif
  529.     if (OSIntNesting > 0) {                           /* See if called from ISR ...                    */
  530.         return (OS_ERR_POST_ISR);                     /* ... can't POST mutex from an ISR              */
  531.     }
  532. #if OS_ARG_CHK_EN > 0
  533.     if (pevent == (OS_EVENT *)0) {                    /* Validate 'pevent'                             */
  534.         return (OS_ERR_PEVENT_NULL);
  535.     }
  536. #endif
  537.     if (pevent->OSEventType != OS_EVENT_TYPE_MUTEX) { /* Validate event block type                     */
  538.         return (OS_ERR_EVENT_TYPE);
  539.     }
  540.     OS_ENTER_CRITICAL();
  541.     pip  = (INT8U)(pevent->OSEventCnt >> 8);          /* Get priority inheritance priority of mutex    */
  542.     prio = (INT8U)(pevent->OSEventCnt & OS_MUTEX_KEEP_LOWER_8);  /* Get owner's original priority      */
  543.     if (OSTCBCur != (OS_TCB *)pevent->OSEventPtr) {   /* See if posting task owns the MUTEX            */
  544.         OS_EXIT_CRITICAL();
  545.         return (OS_ERR_NOT_MUTEX_OWNER);
  546.     }
  547.     if (OSTCBCur->OSTCBPrio == pip) {                 /* Did we have to raise current task's priority? */
  548.         OSMutex_RdyAtPrio(OSTCBCur, prio);            /* Restore the task's original priority          */
  549.     }
  550.     OSTCBPrioTbl[pip] = OS_TCB_RESERVED;              /* Reserve table entry                           */
  551.     if (pevent->OSEventGrp != 0) {                    /* Any task waiting for the mutex?               */
  552.                                                       /* Yes, Make HPT waiting for mutex ready         */
  553.         prio                = OS_EventTaskRdy(pevent, (void *)0, OS_STAT_MUTEX, OS_STAT_PEND_OK);
  554.         pevent->OSEventCnt &= OS_MUTEX_KEEP_UPPER_8;  /*      Save priority of mutex's new owner       */
  555.         pevent->OSEventCnt |= prio;
  556.         pevent->OSEventPtr  = OSTCBPrioTbl[prio];     /*      Link to new mutex owner's OS_TCB         */
  557.         if (prio <= pip) {                            /*      PIP 'must' have a SMALLER prio ...       */
  558.             OS_EXIT_CRITICAL();                       /*      ... than current task!                   */
  559.             OS_Sched();                               /*      Find highest priority task ready to run  */
  560.             return (OS_ERR_PIP_LOWER);
  561.         } else {
  562.             OS_EXIT_CRITICAL();
  563.             OS_Sched();                               /*      Find highest priority task ready to run  */
  564.             return (OS_ERR_NONE);
  565.         }
  566.     }
  567.     pevent->OSEventCnt |= OS_MUTEX_AVAILABLE;         /* No,  Mutex is now available                   */
  568.     pevent->OSEventPtr  = (void *)0;
  569.     OS_EXIT_CRITICAL();
  570.     return (OS_ERR_NONE);
  571. }
  572. /*$PAGE*/
  573. /*
  574. *********************************************************************************************************
  575. *                                     QUERY A MUTUAL EXCLUSION SEMAPHORE
  576. *
  577. * Description: This function obtains information about a mutex
  578. *
  579. * Arguments  : pevent          is a pointer to the event control block associated with the desired mutex
  580. *
  581. *              p_mutex_data    is a pointer to a structure that will contain information about the mutex
  582. *
  583. * Returns    : OS_ERR_NONE          The call was successful and the message was sent
  584. *              OS_ERR_QUERY_ISR     If you called this function from an ISR
  585. *              OS_ERR_PEVENT_NULL   If 'pevent'       is a NULL pointer
  586. *              OS_ERR_PDATA_NULL    If 'p_mutex_data' is a NULL pointer
  587. *              OS_ERR_EVENT_TYPE    If you are attempting to obtain data from a non mutex.
  588. *********************************************************************************************************
  589. */
  590. #if OS_MUTEX_QUERY_EN > 0
  591. INT8U  OSMutexQuery (OS_EVENT       *pevent, 
  592.                      OS_MUTEX_DATA  *p_mutex_data)
  593. {
  594.     INT8U      i;
  595. #if OS_LOWEST_PRIO <= 63
  596.     INT8U     *psrc;
  597.     INT8U     *pdest;
  598. #else
  599.     INT16U    *psrc;
  600.     INT16U    *pdest;
  601. #endif
  602. #if OS_CRITICAL_METHOD == 3                      /* Allocate storage for CPU status register           */
  603.     OS_CPU_SR  cpu_sr = 0;
  604. #endif
  605.     if (OSIntNesting > 0) {                                /* See if called from ISR ...               */
  606.         return (OS_ERR_QUERY_ISR);                         /* ... can't QUERY mutex from an ISR        */
  607.     }
  608. #if OS_ARG_CHK_EN > 0
  609.     if (pevent == (OS_EVENT *)0) {                         /* Validate 'pevent'                        */
  610.         return (OS_ERR_PEVENT_NULL);
  611.     }
  612.     if (p_mutex_data == (OS_MUTEX_DATA *)0) {              /* Validate 'p_mutex_data'                  */
  613.         return (OS_ERR_PDATA_NULL);
  614.     }
  615. #endif
  616.     if (pevent->OSEventType != OS_EVENT_TYPE_MUTEX) {      /* Validate event block type                */
  617.         return (OS_ERR_EVENT_TYPE);
  618.     }
  619.     OS_ENTER_CRITICAL();
  620.     p_mutex_data->OSMutexPIP  = (INT8U)(pevent->OSEventCnt >> 8);
  621.     p_mutex_data->OSOwnerPrio = (INT8U)(pevent->OSEventCnt & OS_MUTEX_KEEP_LOWER_8);
  622.     if (p_mutex_data->OSOwnerPrio == 0xFF) {
  623.         p_mutex_data->OSValue = OS_TRUE;
  624.     } else {
  625.         p_mutex_data->OSValue = OS_FALSE;
  626.     }
  627.     p_mutex_data->OSEventGrp  = pevent->OSEventGrp;        /* Copy wait list                           */
  628.     psrc                      = &pevent->OSEventTbl[0];
  629.     pdest                     = &p_mutex_data->OSEventTbl[0];
  630.     for (i = 0; i < OS_EVENT_TBL_SIZE; i++) {
  631.         *pdest++ = *psrc++;
  632.     }
  633.     OS_EXIT_CRITICAL();
  634.     return (OS_ERR_NONE);
  635. }
  636. #endif                                                     /* OS_MUTEX_QUERY_EN                        */
  637. /*$PAGE*/
  638. /*
  639. *********************************************************************************************************
  640. *                                RESTORE A TASK BACK TO ITS ORIGINAL PRIORITY
  641. *
  642. * Description: This function makes a task ready at the specified priority
  643. *
  644. * Arguments  : ptcb            is a pointer to OS_TCB of the task to make ready
  645. *
  646. *              prio            is the desired priority
  647. *
  648. * Returns    : none
  649. *********************************************************************************************************
  650. */
  651. static  void  OSMutex_RdyAtPrio (OS_TCB  *ptcb, 
  652.                                  INT8U    prio)
  653. {
  654.     INT8U   y;
  655.     y            =  ptcb->OSTCBY;                          /* Remove owner from ready list at 'pip'    */
  656.     OSRdyTbl[y] &= ~ptcb->OSTCBBitX;
  657.     if (OSRdyTbl[y] == 0) {
  658.         OSRdyGrp &= ~ptcb->OSTCBBitY;
  659.     }
  660.     ptcb->OSTCBPrio         = prio;
  661. #if OS_LOWEST_PRIO <= 63
  662.     ptcb->OSTCBY            = (INT8U)((prio >> (INT8U)3) & (INT8U)0x07);
  663.     ptcb->OSTCBX            = (INT8U) (prio & (INT8U)0x07);
  664.     ptcb->OSTCBBitY         = (INT8U)(1 << ptcb->OSTCBY);
  665.     ptcb->OSTCBBitX         = (INT8U)(1 << ptcb->OSTCBX);
  666. #else
  667.     ptcb->OSTCBY            = (INT8U)((prio >> (INT8U)4) & (INT8U)0x0F);
  668.     ptcb->OSTCBX            = (INT8U) (prio & (INT8U)0x0F);
  669.     ptcb->OSTCBBitY         = (INT16U)(1 << ptcb->OSTCBY);
  670.     ptcb->OSTCBBitX         = (INT16U)(1 << ptcb->OSTCBX);
  671. #endif
  672.     OSRdyGrp               |= ptcb->OSTCBBitY;             /* Make task ready at original priority     */
  673.     OSRdyTbl[ptcb->OSTCBY] |= ptcb->OSTCBBitX;
  674.     OSTCBPrioTbl[prio]      = ptcb;
  675. }
  676. #endif                                                     /* OS_MUTEX_EN                              */