OS_TASK.C
上传用户:tzjinxin1
上传日期:2022-08-08
资源大小:272k
文件大小:35k
开发平台:

Visual C++

  1. /*
  2. *********************************************************************************************************
  3. *                                                uC/OS-II
  4. *                                          The Real-Time Kernel
  5. *                                            TASK MANAGEMENT
  6. *
  7. *                          (c) Copyright 1992-2001, Jean J. Labrosse, Weston, FL
  8. *                                           All Rights Reserved
  9. *
  10. * File : OS_TASK.C
  11. * By   : Jean J. Labrosse
  12. *********************************************************************************************************
  13. */
  14. #ifndef  OS_MASTER_FILE
  15. #include "sourceincludes.h"
  16. #endif
  17. /*
  18. *********************************************************************************************************
  19. *                                        CHANGE PRIORITY OF A TASK
  20. *
  21. * Description: This function allows you to change the priority of a task dynamically.  Note that the new
  22. *              priority MUST be available.
  23. *
  24. * Arguments  : oldp     is the old priority
  25. *
  26. *              newp     is the new priority
  27. *
  28. * Returns    : OS_NO_ERR        is the call was successful
  29. *              OS_PRIO_INVALID  if the priority you specify is higher that the maximum allowed
  30. *                               (i.e. >= OS_LOWEST_PRIO)
  31. *              OS_PRIO_EXIST    if the new priority already exist.
  32. *              OS_PRIO_ERR      there is no task with the specified OLD priority (i.e. the OLD task does
  33. *                               not exist.
  34. *********************************************************************************************************
  35. */
  36. #if OS_TASK_CHANGE_PRIO_EN > 0
  37. INT8U  OSTaskChangePrio (INT8U oldprio, INT8U newprio) reentrant
  38. {
  39. #if OS_CRITICAL_METHOD == 3                      /* Allocate storage for CPU status register           */
  40.     OS_CPU_SR    cpu_sr;
  41. #endif
  42. #if OS_EVENT_EN > 0
  43.     OS_EVENT    *pevent;
  44. #endif
  45.     OS_TCB      *ptcb;
  46.     INT8U        x;
  47.     INT8U        y;
  48.     INT8U        bitx;
  49.     INT8U        bity;
  50. #if OS_ARG_CHK_EN > 0
  51.     if ((oldprio >= OS_LOWEST_PRIO && oldprio != OS_PRIO_SELF)  ||
  52.          newprio >= OS_LOWEST_PRIO) {
  53.         return (OS_PRIO_INVALID);
  54.     }
  55. #endif
  56.     OS_ENTER_CRITICAL();
  57.     if (OSTCBPrioTbl[newprio] != (OS_TCB *)0) {                 /* New priority must not already exist */
  58.         OS_EXIT_CRITICAL();
  59.         return (OS_PRIO_EXIST);
  60.     } else {
  61.         OSTCBPrioTbl[newprio] = (OS_TCB *)1;                    /* Reserve the entry to prevent others */
  62.         OS_EXIT_CRITICAL();
  63.         y    = newprio >> 3;                                    /* Precompute to reduce INT. latency   */
  64.         bity = OSMapTbl[y];
  65.         x    = newprio & 0x07;
  66.         bitx = OSMapTbl[x];
  67.         OS_ENTER_CRITICAL();
  68.         if (oldprio == OS_PRIO_SELF) {                          /* See if changing self                */
  69.             oldprio = OSTCBCur->OSTCBPrio;                      /* Yes, get priority                   */
  70.         }
  71.         if ((ptcb = OSTCBPrioTbl[oldprio]) != (OS_TCB *)0) {    /* Task to change must exist           */
  72.             OSTCBPrioTbl[oldprio] = (OS_TCB *)0;                /* Remove TCB from old priority        */
  73.             if ((OSRdyTbl[ptcb->OSTCBY] & ptcb->OSTCBBitX) != 0x00) {  /* If task is ready make it not */
  74.                 if ((OSRdyTbl[ptcb->OSTCBY] &= ~ptcb->OSTCBBitX) == 0x00) {
  75.                     OSRdyGrp &= ~ptcb->OSTCBBitY;
  76.                 }
  77.                 OSRdyGrp    |= bity;                            /* Make new priority ready to run      */
  78.                 OSRdyTbl[y] |= bitx;
  79. #if OS_EVENT_EN > 0
  80.             } else {
  81.                 if ((pevent = ptcb->OSTCBEventPtr) != (OS_EVENT *)0) { /* Remove from event wait list  */
  82.                     if ((pevent->OSEventTbl[ptcb->OSTCBY] &= ~ptcb->OSTCBBitX) == 0) {
  83.                         pevent->OSEventGrp &= ~ptcb->OSTCBBitY;
  84.                     }
  85.                     pevent->OSEventGrp    |= bity;              /* Add new priority to wait list       */
  86.                     pevent->OSEventTbl[y] |= bitx;
  87.                 }
  88. #endif
  89.             }
  90.             OSTCBPrioTbl[newprio] = ptcb;                       /* Place pointer to TCB @ new priority */
  91.             ptcb->OSTCBPrio       = newprio;                    /* Set new task priority               */
  92.             ptcb->OSTCBY          = y;
  93.             ptcb->OSTCBX          = x;
  94.             ptcb->OSTCBBitY       = bity;
  95.             ptcb->OSTCBBitX       = bitx;
  96.             OS_EXIT_CRITICAL();
  97.             OS_Sched();                                         /* Run highest priority task ready     */
  98.             return (OS_NO_ERR);
  99.         } else {
  100.             OSTCBPrioTbl[newprio] = (OS_TCB *)0;                /* Release the reserved prio.          */
  101.             OS_EXIT_CRITICAL();
  102.             return (OS_PRIO_ERR);                               /* Task to change didn't exist         */
  103.         }
  104.     }
  105. }
  106. #endif
  107. /*$PAGE*/
  108. /*
  109. *********************************************************************************************************
  110. *                                            CREATE A TASK
  111. *
  112. * Description: This function is used to have uC/OS-II manage the execution of a task.  Tasks can either
  113. *              be created prior to the start of multitasking or by a running task.  A task cannot be
  114. *              created by an ISR.
  115. *
  116. * Arguments  : task     is a pointer to the task's code
  117. *
  118. *              ppdata   is a pointer to an optional data area which can be used to pass parameters to
  119. *                       the task when the task first executes.  Where the task is concerned it thinks
  120. *                       it was invoked and passed the argument 'ppdata' as follows:
  121. *
  122. *                           void Task (void *ppdata)
  123. *                           {
  124. *                               for (;;) {
  125. *                                   Task code;
  126. *                               }
  127. *                           }
  128. *
  129. *              ptos     is a pointer to the task's top of stack.  If the configuration constant
  130. *                       OS_STK_GROWTH is set to 1, the stack is assumed to grow downward (i.e. from high
  131. *                       memory to low memory).  'pstk' will thus point to the highest (valid) memory
  132. *                       location of the stack.  If OS_STK_GROWTH is set to 0, 'pstk' will point to the
  133. *                       lowest memory location of the stack and the stack will grow with increasing
  134. *                       memory locations.
  135. *
  136. *              prio     is the task's priority.  A unique priority MUST be assigned to each task and the
  137. *                       lower the number, the higher the priority.
  138. *
  139. * Returns    : OS_NO_ERR        if the function was successful.
  140. *              OS_PRIO_EXIT     if the task priority already exist
  141. *                               (each task MUST have a unique priority).
  142. *              OS_PRIO_INVALID  if the priority you specify is higher that the maximum allowed
  143. *                               (i.e. >= OS_LOWEST_PRIO)
  144. *********************************************************************************************************
  145. */
  146. #if OS_TASK_CREATE_EN > 0
  147. INT8U  OSTaskCreate (void (*task)(void *pd) reentrant, void *ppdata, OS_STK *ptos, INT8U prio) reentrant
  148. {
  149. #if OS_CRITICAL_METHOD == 3                  /* Allocate storage for CPU status register               */
  150.     OS_CPU_SR  cpu_sr;
  151. #endif
  152.     OS_STK    *psp;
  153.     INT8U      err;
  154. #if OS_ARG_CHK_EN > 0
  155.     if (prio > OS_LOWEST_PRIO) {             /* Make sure priority is within allowable range           */
  156.         return (OS_PRIO_INVALID);
  157.     }
  158. #endif
  159.     OS_ENTER_CRITICAL();
  160.     if (OSTCBPrioTbl[prio] == (OS_TCB *)0) { /* Make sure task doesn't already exist at this priority  */
  161.         OSTCBPrioTbl[prio] = (OS_TCB *)1;    /* Reserve the priority to prevent others from doing ...  */
  162.                                              /* ... the same thing until task is created.              */
  163.         OS_EXIT_CRITICAL();
  164.         psp = (OS_STK *)OSTaskStkInit(task, ppdata, ptos, 0);    /* Initialize the task's stack         */
  165.         err = OS_TCBInit(prio, psp, (OS_STK *)0, 0, 0, (void *)0, 0);
  166.         if (err == OS_NO_ERR) {
  167.             OS_ENTER_CRITICAL();
  168.             OSTaskCtr++;                                        /* Increment the #tasks counter        */
  169.             OS_EXIT_CRITICAL();
  170.             if (OSRunning == TRUE) {         /* Find highest priority task if multitasking has started */
  171.                 OS_Sched();
  172.             }
  173.         } else {
  174.             OS_ENTER_CRITICAL();
  175.             OSTCBPrioTbl[prio] = (OS_TCB *)0;/* Make this priority available to others                 */
  176.             OS_EXIT_CRITICAL();
  177.         }
  178.         return (err);
  179.     }
  180.     OS_EXIT_CRITICAL();
  181.     return (OS_PRIO_EXIST);
  182. }
  183. #endif
  184. /*$PAGE*/
  185. /*
  186. *********************************************************************************************************
  187. *                                     CREATE A TASK (Extended Version)
  188. *
  189. * Description: This function is used to have uC/OS-II manage the execution of a task.  Tasks can either
  190. *              be created prior to the start of multitasking or by a running task.  A task cannot be
  191. *              created by an ISR.  This function is similar to OSTaskCreate() except that it allows
  192. *              additional information about a task to be specified.
  193. *
  194. * Arguments  : task     is a pointer to the task's code
  195. *
  196. *              ppdata   is a pointer to an optional data area which can be used to pass parameters to
  197. *                       the task when the task first executes.  Where the task is concerned it thinks
  198. *                       it was invoked and passed the argument 'pdata' as follows:
  199. *
  200. *                           void Task (void *ppdata)
  201. *                           {
  202. *                               for (;;) {
  203. *                                   Task code;
  204. *                               }
  205. *                           }
  206. *
  207. *              ptos     is a pointer to the task's top of stack.  If the configuration constant
  208. *                       OS_STK_GROWTH is set to 1, the stack is assumed to grow downward (i.e. from high
  209. *                       memory to low memory).  'pstk' will thus point to the highest (valid) memory
  210. *                       location of the stack.  If OS_STK_GROWTH is set to 0, 'pstk' will point to the
  211. *                       lowest memory location of the stack and the stack will grow with increasing
  212. *                       memory locations.  'pstk' MUST point to a valid 'free' data item.
  213. *
  214. *              prio     is the task's priority.  A unique priority MUST be assigned to each task and the
  215. *                       lower the number, the higher the priority.
  216. *
  217. *              id       is the task's ID (0..65535)
  218. *
  219. *              pbos     is a pointer to the task's bottom of stack.  If the configuration constant
  220. *                       OS_STK_GROWTH is set to 1, the stack is assumed to grow downward (i.e. from high
  221. *                       memory to low memory).  'pbos' will thus point to the LOWEST (valid) memory
  222. *                       location of the stack.  If OS_STK_GROWTH is set to 0, 'pbos' will point to the
  223. *                       HIGHEST memory location of the stack and the stack will grow with increasing
  224. *                       memory locations.  'pbos' MUST point to a valid 'free' data item.
  225. *
  226. *              stk_size is the size of the stack in number of elements.  If OS_STK is set to INT8U,
  227. *                       'stk_size' corresponds to the number of bytes available.  If OS_STK is set to
  228. *                       INT16U, 'stk_size' contains the number of 16-bit entries available.  Finally, if
  229. *                       OS_STK is set to INT32U, 'stk_size' contains the number of 32-bit entries
  230. *                       available on the stack.
  231. *
  232. *              pext     is a pointer to a user supplied memory location which is used as a TCB extension.
  233. *                       For example, this user memory can hold the contents of floating-point registers
  234. *                       during a context switch, the time each task takes to execute, the number of times
  235. *                       the task has been switched-in, etc.
  236. *
  237. *              opt      contains additional information (or options) about the behavior of the task.  The
  238. *                       LOWER 8-bits are reserved by uC/OS-II while the upper 8 bits can be application
  239. *                       specific.  See OS_TASK_OPT_??? in uCOS-II.H.
  240. *
  241. * Returns    : OS_NO_ERR        if the function was successful.
  242. *              OS_PRIO_EXIT     if the task priority already exist
  243. *                               (each task MUST have a unique priority).
  244. *              OS_PRIO_INVALID  if the priority you specify is higher that the maximum allowed
  245. *                               (i.e. > OS_LOWEST_PRIO)
  246. *********************************************************************************************************
  247. */
  248. /*$PAGE*/
  249. #if OS_TASK_CREATE_EXT_EN > 0
  250. INT8U  OSTaskCreateExt (void   (*task)(void *pd) reentrant,
  251.                         void    *ppdata,
  252.                         OS_STK  *ptos,
  253.                         INT8U    prio,
  254.                         INT16U   id,
  255.                         OS_STK  *pbos,
  256.                         INT32U   stk_size,
  257.                         void    *pext,
  258.                         INT16U   opt) reentrant
  259. {
  260. #if OS_CRITICAL_METHOD == 3                  /* Allocate storage for CPU status register               */
  261.     OS_CPU_SR  cpu_sr;
  262. #endif
  263.     OS_STK    *psp;
  264.     INT8U      err;
  265. #if OS_ARG_CHK_EN > 0
  266.     if (prio > OS_LOWEST_PRIO) {             /* Make sure priority is within allowable range           */
  267.         return (OS_PRIO_INVALID);
  268.     }
  269. #endif
  270.     OS_ENTER_CRITICAL();
  271.     if (OSTCBPrioTbl[prio] == (OS_TCB *)0) { /* Make sure task doesn't already exist at this priority  */
  272.         OSTCBPrioTbl[prio] = (OS_TCB *)1;    /* Reserve the priority to prevent others from doing ...  */
  273.                                              /* ... the same thing until task is created.              */
  274.         OS_EXIT_CRITICAL();
  275.         if (((opt & OS_TASK_OPT_STK_CHK) != 0x0000) ||   /* See if stack checking has been enabled     */
  276.             ((opt & OS_TASK_OPT_STK_CLR) != 0x0000)) {   /* See if stack needs to be cleared           */
  277.             #if OS_STK_GROWTH == 1
  278.             (void)memset(pbos, 0, stk_size * sizeof(OS_STK));
  279.             #else
  280.             (void)memset(ptos, 0, stk_size * sizeof(OS_STK));
  281.             #endif
  282.         }
  283.         psp = (OS_STK *)OSTaskStkInit(task, ppdata, ptos, opt); /* Initialize the task's stack          */
  284.         err = OS_TCBInit(prio, psp, pbos, id, stk_size, pext, opt);
  285.         if (err == OS_NO_ERR) {
  286.             OS_ENTER_CRITICAL();
  287.             OSTaskCtr++;                                       /* Increment the #tasks counter         */
  288.             OS_EXIT_CRITICAL();
  289.             if (OSRunning == TRUE) {                           /* Find HPT if multitasking has started */
  290.                 OS_Sched();
  291.             }
  292.         } else {
  293.             OS_ENTER_CRITICAL();
  294.             OSTCBPrioTbl[prio] = (OS_TCB *)0;                  /* Make this priority avail. to others  */
  295.             OS_EXIT_CRITICAL();
  296.         }
  297.         return (err);
  298.     }
  299.     OS_EXIT_CRITICAL();
  300.     return (OS_PRIO_EXIST);
  301. }
  302. #endif
  303. /*$PAGE*/
  304. /*
  305. *********************************************************************************************************
  306. *                                            DELETE A TASK
  307. *
  308. * Description: This function allows you to delete a task.  The calling task can delete itself by
  309. *              its own priority number.  The deleted task is returned to the dormant state and can be
  310. *              re-activated by creating the deleted task again.
  311. *
  312. * Arguments  : prio    is the priority of the task to delete.  Note that you can explicitely delete
  313. *                      the current task without knowing its priority level by setting 'prio' to
  314. *                      OS_PRIO_SELF.
  315. *
  316. * Returns    : OS_NO_ERR           if the call is successful
  317. *              OS_TASK_DEL_IDLE    if you attempted to delete uC/OS-II's idle task
  318. *              OS_PRIO_INVALID     if the priority you specify is higher that the maximum allowed
  319. *                                  (i.e. >= OS_LOWEST_PRIO) or, you have not specified OS_PRIO_SELF.
  320. *              OS_TASK_DEL_ERR     if the task you want to delete does not exist
  321. *              OS_TASK_DEL_ISR     if you tried to delete a task from an ISR
  322. *
  323. * Notes      : 1) To reduce interrupt latency, OSTaskDel() 'disables' the task:
  324. *                    a) by making it not ready
  325. *                    b) by removing it from any wait lists
  326. *                    c) by preventing OSTimeTick() from making the task ready to run.
  327. *                 The task can then be 'unlinked' from the miscellaneous structures in uC/OS-II.
  328. *              2) The function OS_Dummy() is called after OS_EXIT_CRITICAL() because, on most processors,
  329. *                 the next instruction following the enable interrupt instruction is ignored.  
  330. *              3) An ISR cannot delete a task.
  331. *              4) The lock nesting counter is incremented because, for a brief instant, if the current
  332. *                 task is being deleted, the current task would not be able to be rescheduled because it
  333. *                 is removed from the ready list.  Incrementing the nesting counter prevents another task
  334. *                 from being schedule.  This means that an ISR would return to the current task which is
  335. *                 being deleted.  The rest of the deletion would thus be able to be completed.
  336. *********************************************************************************************************
  337. */
  338. /*$PAGE*/
  339. #if OS_TASK_DEL_EN > 0
  340. INT8U  OSTaskDel (INT8U prio) reentrant
  341. {
  342. #if OS_CRITICAL_METHOD == 3                      /* Allocate storage for CPU status register           */
  343.     OS_CPU_SR     cpu_sr;
  344. #endif
  345. #if OS_EVENT_EN > 0
  346.     OS_EVENT     *pevent;
  347. #endif    
  348. #if (OS_VERSION >= 251) && (OS_FLAG_EN > 0) && (OS_MAX_FLAGS > 0)
  349.     OS_FLAG_NODE *pnode;
  350. #endif
  351.     OS_TCB       *ptcb;
  352.     if (OSIntNesting > 0) {                                     /* See if trying to delete from ISR    */
  353.         return (OS_TASK_DEL_ISR);
  354.     }
  355. #if OS_ARG_CHK_EN > 0
  356.     if (prio == OS_IDLE_PRIO) {                                 /* Not allowed to delete idle task     */
  357.         return (OS_TASK_DEL_IDLE);
  358.     }
  359.     if (prio >= OS_LOWEST_PRIO && prio != OS_PRIO_SELF) {       /* Task priority valid ?               */
  360.         return (OS_PRIO_INVALID);
  361.     }
  362. #endif
  363.     OS_ENTER_CRITICAL();
  364.     if (prio == OS_PRIO_SELF) {                                 /* See if requesting to delete self    */
  365.         prio = OSTCBCur->OSTCBPrio;                             /* Set priority to delete to current   */
  366.     }
  367.     if ((ptcb = OSTCBPrioTbl[prio]) != (OS_TCB *)0) {                /* Task to delete must exist      */
  368.         if ((OSRdyTbl[ptcb->OSTCBY] &= ~ptcb->OSTCBBitX) == 0x00) {  /* Make task not ready            */
  369.             OSRdyGrp &= ~ptcb->OSTCBBitY;
  370.         }
  371. #if OS_EVENT_EN > 0
  372.         pevent = ptcb->OSTCBEventPtr;
  373.         if (pevent != (OS_EVENT *)0) {                          /* If task is waiting on event         */
  374.             if ((pevent->OSEventTbl[ptcb->OSTCBY] &= ~ptcb->OSTCBBitX) == 0) { /* ... remove task from */
  375.                 pevent->OSEventGrp &= ~ptcb->OSTCBBitY;                        /* ... event ctrl block */
  376.             }
  377.         }
  378. #endif
  379. #if (OS_VERSION >= 251) && (OS_FLAG_EN > 0) && (OS_MAX_FLAGS > 0)
  380.         pnode = ptcb->OSTCBFlagNode;
  381.         if (pnode != (OS_FLAG_NODE *)0) {                       /* If task is waiting on event flag    */
  382.             OS_FlagUnlink(pnode);                               /* Remove from wait list               */
  383.         }
  384. #endif
  385.         ptcb->OSTCBDly  = 0;                                    /* Prevent OSTimeTick() from updating  */
  386.         ptcb->OSTCBStat = OS_STAT_RDY;                          /* Prevent task from being resumed     */
  387. if (OSLockNesting < 255) {
  388.             OSLockNesting++;
  389. }
  390.         OS_EXIT_CRITICAL();                                     /* Enabling INT. ignores next instruc. */
  391.         OS_Dummy();                                             /* ... Dummy ensures that INTs will be */
  392.         OS_ENTER_CRITICAL();                                    /* ... disabled HERE!                  */
  393. if (OSLockNesting > 0) {
  394.             OSLockNesting--;
  395. }
  396.         OSTaskDelHook(ptcb);                                    /* Call user defined hook              */
  397.         OSTaskCtr--;                                            /* One less task being managed         */
  398.         OSTCBPrioTbl[prio] = (OS_TCB *)0;                       /* Clear old priority entry            */
  399.         if (ptcb->OSTCBPrev == (OS_TCB *)0) {                   /* Remove from TCB chain               */
  400.             ptcb->OSTCBNext->OSTCBPrev = (OS_TCB *)0;
  401.             OSTCBList                  = ptcb->OSTCBNext;
  402.         } else {
  403.             ptcb->OSTCBPrev->OSTCBNext = ptcb->OSTCBNext;
  404.             ptcb->OSTCBNext->OSTCBPrev = ptcb->OSTCBPrev;
  405.         }
  406.         ptcb->OSTCBNext = OSTCBFreeList;                        /* Return TCB to free TCB list         */
  407.         OSTCBFreeList   = ptcb;
  408.         OS_EXIT_CRITICAL();
  409.         OS_Sched();                                             /* Find new highest priority task      */
  410.         return (OS_NO_ERR);
  411.     }
  412.     OS_EXIT_CRITICAL();
  413.     return (OS_TASK_DEL_ERR);
  414. }
  415. #endif
  416. /*$PAGE*/
  417. /*
  418. *********************************************************************************************************
  419. *                                    REQUEST THAT A TASK DELETE ITSELF
  420. *
  421. * Description: This function is used to:
  422. *                   a) notify a task to delete itself.
  423. *                   b) to see if a task requested that the current task delete itself.
  424. *              This function is a little tricky to understand.  Basically, you have a task that needs
  425. *              to be deleted however, this task has resources that it has allocated (memory buffers,
  426. *              semaphores, mailboxes, queues etc.).  The task cannot be deleted otherwise these
  427. *              resources would not be freed.  The requesting task calls OSTaskDelReq() to indicate that
  428. *              the task needs to be deleted.  Deleting of the task is however, deferred to the task to
  429. *              be deleted.  For example, suppose that task #10 needs to be deleted.  The requesting task
  430. *              example, task #5, would call OSTaskDelReq(10).  When task #10 gets to execute, it calls
  431. *              this function by specifying OS_PRIO_SELF and monitors the returned value.  If the return
  432. *              value is OS_TASK_DEL_REQ, another task requested a task delete.  Task #10 would look like
  433. *              this:
  434. *
  435. *                   void Task(void *data)
  436. *                   {
  437. *                       .
  438. *                       .
  439. *                       while (1) {
  440. *                           OSTimeDly(1);
  441. *                           if (OSTaskDelReq(OS_PRIO_SELF) == OS_TASK_DEL_REQ) {
  442. *                               Release any owned resources;
  443. *                               De-allocate any dynamic memory;
  444. *                               OSTaskDel(OS_PRIO_SELF);
  445. *                           }
  446. *                       }
  447. *                   }
  448. *
  449. * Arguments  : prio    is the priority of the task to request the delete from
  450. *
  451. * Returns    : OS_NO_ERR          if the task exist and the request has been registered
  452. *              OS_TASK_NOT_EXIST  if the task has been deleted.  This allows the caller to know whether
  453. *                                 the request has been executed.
  454. *              OS_TASK_DEL_IDLE   if you requested to delete uC/OS-II's idle task
  455. *              OS_PRIO_INVALID    if the priority you specify is higher that the maximum allowed
  456. *                                 (i.e. >= OS_LOWEST_PRIO) or, you have not specified OS_PRIO_SELF.
  457. *              OS_TASK_DEL_REQ    if a task (possibly another task) requested that the running task be
  458. *                                 deleted.
  459. *********************************************************************************************************
  460. */
  461. /*$PAGE*/
  462. #if OS_TASK_DEL_EN > 0
  463. INT8U  OSTaskDelReq (INT8U prio) reentrant
  464. {
  465. #if OS_CRITICAL_METHOD == 3                      /* Allocate storage for CPU status register           */
  466.     OS_CPU_SR  cpu_sr;
  467. #endif
  468.     BOOLEAN    stat;
  469.     INT8U      err;
  470.     OS_TCB    *ptcb;
  471. #if OS_ARG_CHK_EN > 0
  472.     if (prio == OS_IDLE_PRIO) {                                 /* Not allowed to delete idle task     */
  473.         return (OS_TASK_DEL_IDLE);
  474.     }
  475.     if (prio >= OS_LOWEST_PRIO && prio != OS_PRIO_SELF) {       /* Task priority valid ?               */
  476.         return (OS_PRIO_INVALID);
  477.     }
  478. #endif
  479.     if (prio == OS_PRIO_SELF) {                                 /* See if a task is requesting to ...  */
  480.         OS_ENTER_CRITICAL();                                    /* ... this task to delete itself      */
  481.         stat = OSTCBCur->OSTCBDelReq;                           /* Return request status to caller     */
  482.         OS_EXIT_CRITICAL();
  483.         return (stat);
  484.     }
  485.     OS_ENTER_CRITICAL();
  486.     if ((ptcb = OSTCBPrioTbl[prio]) != (OS_TCB *)0) {           /* Task to delete must exist           */
  487.         ptcb->OSTCBDelReq = OS_TASK_DEL_REQ;                    /* Set flag indicating task to be DEL. */
  488.         err               = OS_NO_ERR;
  489.     } else {
  490.         err               = OS_TASK_NOT_EXIST;                  /* Task must be deleted                */
  491.     }
  492.     OS_EXIT_CRITICAL();
  493.     return (err);
  494. }
  495. #endif
  496. /*$PAGE*/
  497. /*
  498. *********************************************************************************************************
  499. *                                        RESUME A SUSPENDED TASK
  500. *
  501. * Description: This function is called to resume a previously suspended task.  This is the only call that
  502. *              will remove an explicit task suspension.
  503. *
  504. * Arguments  : prio     is the priority of the task to resume.
  505. *
  506. * Returns    : OS_NO_ERR                if the requested task is resumed
  507. *              OS_PRIO_INVALID          if the priority you specify is higher that the maximum allowed
  508. *                                       (i.e. >= OS_LOWEST_PRIO)
  509. *              OS_TASK_RESUME_PRIO      if the task to resume does not exist
  510. *              OS_TASK_NOT_SUSPENDED    if the task to resume has not been suspended
  511. *********************************************************************************************************
  512. */
  513. #if OS_TASK_SUSPEND_EN > 0
  514. INT8U  OSTaskResume (INT8U prio) reentrant
  515. {
  516. #if OS_CRITICAL_METHOD == 3                      /* Allocate storage for CPU status register           */
  517.     OS_CPU_SR  cpu_sr;
  518. #endif
  519.     OS_TCB    *ptcb;
  520. #if OS_ARG_CHK_EN > 0
  521.     if (prio >= OS_LOWEST_PRIO) {                               /* Make sure task priority is valid    */
  522.         return (OS_PRIO_INVALID);
  523.     }
  524. #endif
  525.     OS_ENTER_CRITICAL();
  526.     if ((ptcb = OSTCBPrioTbl[prio]) == (OS_TCB *)0) {           /* Task to suspend must exist          */
  527.         OS_EXIT_CRITICAL();
  528.         return (OS_TASK_RESUME_PRIO);
  529.     }
  530.     if ((ptcb->OSTCBStat & OS_STAT_SUSPEND) != 0x00) {                     /* Task must be suspended   */
  531.         if (((ptcb->OSTCBStat &= ~OS_STAT_SUSPEND) == OS_STAT_RDY) &&      /* Remove suspension        */
  532.              (ptcb->OSTCBDly  == 0)) {                                     /* Must not be delayed      */
  533.             OSRdyGrp               |= ptcb->OSTCBBitY;                     /* Make task ready to run   */
  534.             OSRdyTbl[ptcb->OSTCBY] |= ptcb->OSTCBBitX;
  535.             OS_EXIT_CRITICAL();
  536.             OS_Sched();
  537.         } else {
  538.             OS_EXIT_CRITICAL();
  539.         }
  540.         return (OS_NO_ERR);
  541.     }
  542.     OS_EXIT_CRITICAL();
  543.     return (OS_TASK_NOT_SUSPENDED);
  544. }
  545. #endif
  546. /*$PAGE*/
  547. /*
  548. *********************************************************************************************************
  549. *                                             STACK CHECKING
  550. *
  551. * Description: This function is called to check the amount of free memory left on the specified task's
  552. *              stack.
  553. *
  554. * Arguments  : prio     is the task priority
  555. *
  556. *              ppdata    is a pointer to a data structure of type OS_STK_DATA.
  557. *
  558. * Returns    : OS_NO_ERR           upon success
  559. *              OS_PRIO_INVALID     if the priority you specify is higher that the maximum allowed
  560. *                                  (i.e. > OS_LOWEST_PRIO) or, you have not specified OS_PRIO_SELF.
  561. *              OS_TASK_NOT_EXIST   if the desired task has not been created
  562. *              OS_TASK_OPT_ERR     if you did NOT specified OS_TASK_OPT_STK_CHK when the task was created
  563. *********************************************************************************************************
  564. */
  565. #if OS_TASK_CREATE_EXT_EN > 0
  566. INT8U  OSTaskStkChk (INT8U prio, OS_STK_DATA *ppdata) reentrant
  567. {
  568. #if OS_CRITICAL_METHOD == 3                      /* Allocate storage for CPU status register           */
  569.     OS_CPU_SR  cpu_sr;
  570. #endif
  571.     OS_TCB    *ptcb;
  572.     OS_STK    *pchk;
  573.     INT32U     free;
  574.     INT32U     size;
  575. #if OS_ARG_CHK_EN > 0
  576.     if (prio > OS_LOWEST_PRIO && prio != OS_PRIO_SELF) {        /* Make sure task priority is valid    */
  577.         return (OS_PRIO_INVALID);
  578.     }
  579. #endif
  580.     ppdata->OSFree = 0;                                          /* Assume failure, set to 0 size       */
  581.     ppdata->OSUsed = 0;
  582.     OS_ENTER_CRITICAL();
  583.     if (prio == OS_PRIO_SELF) {                        /* See if check for SELF                        */
  584.         prio = OSTCBCur->OSTCBPrio;
  585.     }
  586.     ptcb = OSTCBPrioTbl[prio];
  587.     if (ptcb == (OS_TCB *)0) {                         /* Make sure task exist                         */
  588.         OS_EXIT_CRITICAL();
  589.         return (OS_TASK_NOT_EXIST);
  590.     }
  591.     if ((ptcb->OSTCBOpt & OS_TASK_OPT_STK_CHK) == 0) { /* Make sure stack checking option is set       */
  592.         OS_EXIT_CRITICAL();
  593.         return (OS_TASK_OPT_ERR);
  594.     }
  595.     free = 0;
  596.     size = ptcb->OSTCBStkSize;
  597.     pchk = ptcb->OSTCBStkBottom;
  598.     OS_EXIT_CRITICAL();
  599. #if OS_STK_GROWTH == 1
  600.     while (*pchk++ == (OS_STK)0) {                    /* Compute the number of zero entries on the stk */
  601.         free++;
  602.     }
  603. #else
  604.     while (*pchk-- == (OS_STK)0) {
  605.         free++;
  606.     }
  607. #endif
  608.     ppdata->OSFree = free * sizeof(OS_STK);            /* Compute number of free bytes on the stack     */
  609.     ppdata->OSUsed = (size - free) * sizeof(OS_STK);   /* Compute number of bytes used on the stack     */
  610.     return (OS_NO_ERR);
  611. }
  612. #endif
  613. /*$PAGE*/
  614. /*
  615. *********************************************************************************************************
  616. *                                            SUSPEND A TASK
  617. *
  618. * Description: This function is called to suspend a task.  The task can be the calling task if the
  619. *              priority passed to OSTaskSuspend() is the priority of the calling task or OS_PRIO_SELF.
  620. *
  621. * Arguments  : prio     is the priority of the task to suspend.  If you specify OS_PRIO_SELF, the
  622. *                       calling task will suspend itself and rescheduling will occur.
  623. *
  624. * Returns    : OS_NO_ERR                if the requested task is suspended
  625. *              OS_TASK_SUSPEND_IDLE     if you attempted to suspend the idle task which is not allowed.
  626. *              OS_PRIO_INVALID          if the priority you specify is higher that the maximum allowed
  627. *                                       (i.e. >= OS_LOWEST_PRIO) or, you have not specified OS_PRIO_SELF.
  628. *              OS_TASK_SUSPEND_PRIO     if the task to suspend does not exist
  629. *
  630. * Note       : You should use this function with great care.  If you suspend a task that is waiting for
  631. *              an event (i.e. a message, a semaphore, a queue ...) you will prevent this task from
  632. *              running when the event arrives.
  633. *********************************************************************************************************
  634. */
  635. #if OS_TASK_SUSPEND_EN > 0
  636. INT8U  OSTaskSuspend (INT8U prio) reentrant
  637. {
  638. #if OS_CRITICAL_METHOD == 3                      /* Allocate storage for CPU status register           */
  639.     OS_CPU_SR  cpu_sr;
  640. #endif
  641.     BOOLEAN    self;
  642.     OS_TCB    *ptcb;
  643. #if OS_ARG_CHK_EN > 0
  644.     if (prio == OS_IDLE_PRIO) {                                 /* Not allowed to suspend idle task    */
  645.         return (OS_TASK_SUSPEND_IDLE);
  646.     }
  647.     if (prio >= OS_LOWEST_PRIO && prio != OS_PRIO_SELF) {       /* Task priority valid ?               */
  648.         return (OS_PRIO_INVALID);
  649.     }
  650. #endif
  651.     OS_ENTER_CRITICAL();
  652.     if (prio == OS_PRIO_SELF) {                                 /* See if suspend SELF                 */
  653.         prio = OSTCBCur->OSTCBPrio;
  654.         self = TRUE;
  655.     } else if (prio == OSTCBCur->OSTCBPrio) {                   /* See if suspending self              */
  656.         self = TRUE;
  657.     } else {
  658.         self = FALSE;                                           /* No suspending another task          */
  659.     }
  660.     if ((ptcb = OSTCBPrioTbl[prio]) == (OS_TCB *)0) {           /* Task to suspend must exist          */
  661.         OS_EXIT_CRITICAL();
  662.         return (OS_TASK_SUSPEND_PRIO);
  663.     }
  664.     if ((OSRdyTbl[ptcb->OSTCBY] &= ~ptcb->OSTCBBitX) == 0x00) { /* Make task not ready                 */
  665.         OSRdyGrp &= ~ptcb->OSTCBBitY;
  666.     }
  667.     ptcb->OSTCBStat |= OS_STAT_SUSPEND;                         /* Status of task is 'SUSPENDED'       */
  668.     OS_EXIT_CRITICAL();
  669.     if (self == TRUE) {                                         /* Context switch only if SELF         */
  670.         OS_Sched();
  671.     }
  672.     return (OS_NO_ERR);
  673. }
  674. #endif
  675. /*$PAGE*/
  676. /*
  677. *********************************************************************************************************
  678. *                                            QUERY A TASK
  679. *
  680. * Description: This function is called to obtain a copy of the desired task's TCB.
  681. *
  682. * Arguments  : prio     is the priority of the task to obtain information from.
  683. *
  684. * Returns    : OS_NO_ERR       if the requested task is suspended
  685. *              OS_PRIO_INVALID if the priority you specify is higher that the maximum allowed
  686. *                              (i.e. > OS_LOWEST_PRIO) or, you have not specified OS_PRIO_SELF.
  687. *              OS_PRIO_ERR     if the desired task has not been created
  688. *********************************************************************************************************
  689. */
  690. #if OS_TASK_QUERY_EN > 0
  691. INT8U  OSTaskQuery (INT8U prio, OS_TCB *ppdata) reentrant
  692. {
  693. #if OS_CRITICAL_METHOD == 3                      /* Allocate storage for CPU status register           */
  694.     OS_CPU_SR  cpu_sr;
  695. #endif
  696.     OS_TCB    *ptcb;
  697. #if OS_ARG_CHK_EN > 0
  698.     if (prio > OS_LOWEST_PRIO && prio != OS_PRIO_SELF) {   /* Task priority valid ?                    */
  699.         return (OS_PRIO_INVALID);
  700.     }
  701. #endif
  702.     OS_ENTER_CRITICAL();
  703.     if (prio == OS_PRIO_SELF) {                            /* See if suspend SELF                      */
  704.         prio = OSTCBCur->OSTCBPrio;
  705.     }
  706.     if ((ptcb = OSTCBPrioTbl[prio]) == (OS_TCB *)0) {      /* Task to query must exist                 */
  707.         OS_EXIT_CRITICAL();
  708.         return (OS_PRIO_ERR);
  709.     }
  710.     memcpy(ppdata, ptcb, sizeof(OS_TCB));                  /* Copy TCB into user storage area          */
  711.     OS_EXIT_CRITICAL();
  712.     return (OS_NO_ERR);
  713. }
  714. #endif