]> git.sur5r.net Git - freertos/blob - Source/tasks.c
15e61cf1b886316a2d969a64d97e722d297b3210
[freertos] / Source / tasks.c
1 /*\r
2         FreeRTOS.org V4.7.2 - Copyright (C) 2003-2008 Richard Barry.\r
3 \r
4         This file is part of the FreeRTOS.org distribution.\r
5 \r
6         FreeRTOS.org is free software; you can redistribute it and/or modify\r
7         it under the terms of the GNU General Public License as published by\r
8         the Free Software Foundation; either version 2 of the License, or\r
9         (at your option) any later version.\r
10 \r
11         FreeRTOS.org is distributed in the hope that it will be useful,\r
12         but WITHOUT ANY WARRANTY; without even the implied warranty of\r
13         MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\r
14         GNU General Public License for more details.\r
15 \r
16         You should have received a copy of the GNU General Public License\r
17         along with FreeRTOS.org; if not, write to the Free Software\r
18         Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA\r
19 \r
20         A special exception to the GPL can be applied should you wish to distribute\r
21         a combined work that includes FreeRTOS.org, without being obliged to provide\r
22         the source code for any proprietary components.  See the licensing section\r
23         of http://www.FreeRTOS.org for full details of how and when the exception\r
24         can be applied.\r
25 \r
26         ***************************************************************************\r
27 \r
28         Please ensure to read the configuration and relevant port sections of the \r
29         online documentation.\r
30 \r
31         +++ http://www.FreeRTOS.org +++\r
32         Documentation, latest information, license and contact details.  \r
33 \r
34         +++ http://www.SafeRTOS.com +++\r
35         A version that is certified for use in safety critical systems.\r
36 \r
37         +++ http://www.OpenRTOS.com +++\r
38         Commercial support, development, porting, licensing and training services.\r
39 \r
40         ***************************************************************************\r
41 */\r
42 \r
43 /*\r
44 Changes from V1.00:\r
45         \r
46         + Call to portRESTORE_CONTEXT has been removed.  The first context\r
47           switch is now performed within sPortStartScheduler().\r
48 \r
49 Changes from V1.01:\r
50 \r
51         + More use of 8bit data types.\r
52         + Function name prefixes changed where the data type returned has changed.\r
53         + configUSE_TRACE_FACILITY is no longer defined by default.\r
54 \r
55 Changes from V1.2.0\r
56 \r
57         + Introduced ucTopReadyPriority.  This tracks the highest priority ready\r
58           queue that contains a valid TCB and thus makes the context switch\r
59           slightly faster.\r
60 \r
61         + prvAddTaskToReadyQueue() has been made a macro.\r
62 \r
63 Changes from V1.2.6\r
64 \r
65         + Added conditional compilation directives.\r
66         + Extended API.\r
67         + Rearranged function order.\r
68         + Creating a task now causes a context switch if the task being created\r
69           has a higher priority than the calling task - assuming the kernel is\r
70           running.\r
71         + vTaskDelete() now only causes a context switch if the calling task is\r
72           the task being deleted.\r
73 \r
74 Changes from V2.0.0\r
75 \r
76         + Allow the type of the tick count to be 16 or 32 bits.\r
77         + Introduce xPendingReadyList feature to allow the time interrupts have to\r
78           be disabled to be minimised.\r
79         + Remove the #if( INCLUDE_vTaskSuspendAll ) statements.  vTaskSuspendAll()\r
80           is now always included as it is used by the scheduler itself.\r
81 \r
82 Changes from V2.1.0\r
83 \r
84         + Bug fix - pxCurrentTCB is now initialised before the call to\r
85           prvInitializeTaskLists().  Previously pxCurrentTCB could be accessed\r
86           while null.\r
87 \r
88 Changed from V2.1.1\r
89 \r
90         + Change to where lStackSize is declared within sTaskCreate() to prevent\r
91           compiler warnings with 8051 port.\r
92 \r
93 Changes from V2.2.0\r
94 \r
95         + Explicit use of 'signed' qualifier on portCHAR types added.\r
96         + Changed odd calculation of initial pxTopOfStack value when\r
97           portSTACK_GROWTH < 0.\r
98         + Removed pcVersionNumber definition.\r
99 \r
100 Changes from V2.5.3\r
101 \r
102         + cTaskResumeAll() modified to ensure it can be called prior to the task\r
103           lists being initialised.\r
104 \r
105 Changes from V2.5.5\r
106 \r
107         + Added API function vTaskDelayUntil().\r
108         + Added INCLUDE_vTaskDelay conditional compilation.\r
109 \r
110 Changes from V2.6.0\r
111 \r
112         + Updated the vWriteTraceToBuffer macro to always be 4 byte aligned so it\r
113           can be used on ARM architectures.\r
114         + tskMAX_TASK_NAME_LEN definition replaced with the port specific\r
115           configMAX_TASK_NAME_LEN definition.\r
116         + Removed the call to strcpy when copying across the task name into the\r
117           TCB.\r
118         + Added ucTasksDeleted variable to prevent vTaskSuspendAll() being called\r
119           too often in the idle task.\r
120 \r
121 Changes between V3.0.0 and V2.6.1\r
122 \r
123         + When resuming the scheduler a yield is performed if either a tick has\r
124           been missed, or a task is moved from the pending ready list into a ready\r
125           list.  Previously a yield was not performed on this second condition.\r
126         + Introduced the type portBASE_TYPE.  This necessitates several API\r
127           changes.\r
128         + Removed the sUsingPreemption variable.  The constant defined in\r
129           portmacro.h is now used directly.\r
130         + The idle task can now include an optional hook function - and no longer\r
131           completes its time slice if other tasks with equal priority to it are\r
132           ready to run.\r
133         + See the FreeRTOS.org documentation for more information on V2.x.x to\r
134           V3.x.x modifications.\r
135 \r
136 Changes from V3.1.1\r
137 \r
138         + Modified vTaskPrioritySet() and vTaskResume() to allow these functions to\r
139           be called while the scheduler is suspended.\r
140         + Corrected the task ordering within event lists.\r
141 \r
142 Changes from V3.2.0\r
143 \r
144         + Added function xTaskGetCurrentTaskHandle().\r
145 \r
146 Changes from V3.2.4\r
147 \r
148         + Changed the volatile declarations on some variables to reflect the \r
149           changes to the list definitions.\r
150         + Changed the order of the TCB definition so there is commonality between\r
151           the task control block and a co-routine control block.\r
152         + Allow the scheduler to be started even if no tasks other than the idle\r
153           task has been created.  This allows co-routines to run even when no tasks\r
154           have been created.\r
155         + The need for a context switch is now signalled if a task woken by an \r
156           event has a priority greater or equal to the currently running task.\r
157           Previously this was only greater than.\r
158 \r
159 Changes from V4.0.0\r
160 \r
161         + Added the xMissedYield handling.\r
162 \r
163 Changes from V4.0.1\r
164 \r
165         + The function vTaskList() now suspends the scheduler rather than disabling\r
166           interrupts during the creation of the task list.  \r
167         + Allow a task to delete itself by passing in its own handle.  Previously \r
168           this could only be done by passing in NULL.\r
169         + The tick hook function is now called only within a tick isr.  Previously\r
170           it was also called when the tick function was called during the scheduler\r
171           unlocking process.\r
172 \r
173 Changes from V4.0.3\r
174 \r
175         + Extra checks have been placed in vTaskPrioritySet() to avoid unnecessary\r
176           yields.\r
177 \r
178 Changed from V4.0.4\r
179 \r
180         + Bug fix:  The 'value' of the event list item is updated when the priority\r
181           of a task is changed.  Previously only the priority of the TCB itself was\r
182           changed.\r
183         + When resuming a task a check is first made to see if the task is actually\r
184           suspended.\r
185         + vTaskPrioritySet() and vTaskResume() no longer use the event list item.\r
186           This has not been necessary since V4.0.1 when the xMissedYield handling\r
187           was added.\r
188         + Implement xTaskResumeFromISR().\r
189 \r
190 Changes from V4.0.5\r
191 \r
192         + Added utility functions and xOverflowCount variable to facilitate the\r
193           queue.c changes.\r
194 \r
195 Changes from V4.1.2\r
196         \r
197         + Tasks that block on events with a timeout of portMAX_DELAY are now\r
198           blocked indefinitely if configINCLUDE_vTaskSuspend is defined. \r
199           Previously portMAX_DELAY was just the longest block time possible.\r
200 \r
201 Changes from V4.1.3\r
202 \r
203         + Very small change made to xTaskCheckForTimeout() as a result of the \r
204         SafeRTOS testing.  This corrects the case where the function can return an\r
205         invalid value - but only in an extremely unlikely scenario.\r
206 \r
207 Changes since V4.3.1:\r
208 \r
209         + Added xTaskGetSchedulerState() function.\r
210         + Added prvIsTaskSuspended() to take into account the Occurrence of\r
211           vTaskResume() or vTaskResumeFromISR() being called passing in the\r
212           handle of a task that appears in the Suspended list only because it\r
213           is blocked on an event without a timeout being specified.\r
214         + Updated xTaskCheckForTimeout() to take into account that tasks blocked\r
215           using the Suspended list should never time out.\r
216 */\r
217 \r
218 #include <stdio.h>\r
219 #include <stdlib.h>\r
220 #include <string.h>\r
221 \r
222 #include "FreeRTOS.h"\r
223 #include "task.h"\r
224 \r
225 /*\r
226  * Macro to define the amount of stack available to the idle task.\r
227  */\r
228 #define tskIDLE_STACK_SIZE      configMINIMAL_STACK_SIZE\r
229 \r
230 \r
231 /*\r
232  * Default a definitions for backwards compatibility with old\r
233  * portmacro.h files.\r
234  */\r
235 #ifndef configMAX_TASK_NAME_LEN\r
236         #define configMAX_TASK_NAME_LEN 16\r
237 #endif\r
238 \r
239 #ifndef configIDLE_SHOULD_YIELD\r
240         #define configIDLE_SHOULD_YIELD         1\r
241 #endif\r
242 \r
243 #if configMAX_TASK_NAME_LEN < 1\r
244         #undef configMAX_TASK_NAME_LEN\r
245         #define configMAX_TASK_NAME_LEN 1\r
246 #endif\r
247 \r
248 #ifndef INCLUDE_xTaskResumeFromISR\r
249         #define INCLUDE_xTaskResumeFromISR 1\r
250 #endif\r
251 \r
252 #ifndef INCLUDE_xTaskGetSchedulerState\r
253         #define INCLUDE_xTaskGetSchedulerState 0\r
254 #endif\r
255 \r
256 /*\r
257  * Task control block.  A task control block (TCB) is allocated to each task,\r
258  * and stores the context of the task.\r
259  */\r
260 typedef struct tskTaskControlBlock\r
261 {\r
262         volatile portSTACK_TYPE *pxTopOfStack;          /*< Points to the location of the last item placed on the tasks stack.  THIS MUST BE THE FIRST MEMBER OF THE STRUCT. */\r
263         xListItem                               xGenericListItem;       /*< List item used to place the TCB in ready and blocked queues. */\r
264         xListItem                               xEventListItem;         /*< List item used to place the TCB in event lists. */\r
265         unsigned portBASE_TYPE  uxPriority;                     /*< The priority of the task where 0 is the lowest priority. */\r
266         portSTACK_TYPE                  *pxStack;                       /*< Points to the start of the stack. */\r
267         signed portCHAR                 pcTaskName[ configMAX_TASK_NAME_LEN ];/*< Descriptive name given to the task when created.  Facilitates debugging only. */\r
268 \r
269         #if ( portCRITICAL_NESTING_IN_TCB == 1 )\r
270                 unsigned portBASE_TYPE uxCriticalNesting;\r
271         #endif\r
272 \r
273         #if ( configUSE_TRACE_FACILITY == 1 )\r
274                 unsigned portBASE_TYPE  uxTCBNumber;            /*< This is used for tracing the scheduler and making debugging easier only. */\r
275         #endif  \r
276                 \r
277         #if ( configUSE_MUTEXES == 1 )\r
278                 unsigned portBASE_TYPE uxBasePriority;\r
279         #endif\r
280                 \r
281 } tskTCB;\r
282 \r
283 /*lint -e956 */\r
284 \r
285 tskTCB * volatile pxCurrentTCB = NULL;                                  \r
286 \r
287 /* Lists for ready and blocked tasks. --------------------*/\r
288 \r
289 static xList pxReadyTasksLists[ configMAX_PRIORITIES ]; /*< Prioritised ready tasks. */\r
290 static xList xDelayedTaskList1;                                                 /*< Delayed tasks. */\r
291 static xList xDelayedTaskList2;                                                 /*< Delayed tasks (two lists are used - one for delays that have overflowed the current tick count. */\r
292 static xList * volatile pxDelayedTaskList;                              /*< Points to the delayed task list currently being used. */\r
293 static xList * volatile pxOverflowDelayedTaskList;              /*< Points to the delayed task list currently being used to hold tasks that have overflowed the current tick count. */\r
294 static xList xPendingReadyList;                                                 /*< Tasks that have been readied while the scheduler was suspended.  They will be moved to the ready queue when the scheduler is resumed. */\r
295 \r
296 #if ( INCLUDE_vTaskDelete == 1 )\r
297 \r
298         static volatile xList xTasksWaitingTermination;         /*< Tasks that have been deleted - but the their memory not yet freed. */\r
299         static volatile unsigned portBASE_TYPE uxTasksDeleted = ( unsigned portBASE_TYPE ) 0;\r
300 \r
301 #endif\r
302 \r
303 #if ( INCLUDE_vTaskSuspend == 1 )\r
304 \r
305         static xList xSuspendedTaskList;                                        /*< Tasks that are currently suspended. */\r
306 \r
307 #endif\r
308 \r
309 /* File private variables. --------------------------------*/\r
310 static volatile unsigned portBASE_TYPE uxCurrentNumberOfTasks   = ( unsigned portBASE_TYPE ) 0;\r
311 static volatile portTickType xTickCount                                                 = ( portTickType ) 0;\r
312 static unsigned portBASE_TYPE uxTopUsedPriority                                 = tskIDLE_PRIORITY;\r
313 static volatile unsigned portBASE_TYPE uxTopReadyPriority               = tskIDLE_PRIORITY;\r
314 static volatile signed portBASE_TYPE xSchedulerRunning                  = pdFALSE;\r
315 static volatile unsigned portBASE_TYPE uxSchedulerSuspended             = ( unsigned portBASE_TYPE ) pdFALSE;\r
316 static volatile unsigned portBASE_TYPE uxMissedTicks                    = ( unsigned portBASE_TYPE ) 0;\r
317 static volatile portBASE_TYPE xMissedYield                                              = ( portBASE_TYPE ) pdFALSE;\r
318 static volatile portBASE_TYPE xNumOfOverflows                                   = ( portBASE_TYPE ) 0;\r
319 /* Debugging and trace facilities private variables and macros. ------------*/\r
320 \r
321 /*\r
322  * The value used to fill the stack of a task when the task is created.  This\r
323  * is used purely for checking the high water mark for tasks.\r
324  */\r
325 #define tskSTACK_FILL_BYTE      ( 0xa5 )\r
326 \r
327 /*\r
328  * Macros used by vListTask to indicate which state a task is in.\r
329  */\r
330 #define tskBLOCKED_CHAR         ( ( signed portCHAR ) 'B' )\r
331 #define tskREADY_CHAR           ( ( signed portCHAR ) 'R' )\r
332 #define tskDELETED_CHAR         ( ( signed portCHAR ) 'D' )\r
333 #define tskSUSPENDED_CHAR       ( ( signed portCHAR ) 'S' )\r
334 \r
335 /*\r
336  * Macros and private variables used by the trace facility.\r
337  */\r
338 #if ( configUSE_TRACE_FACILITY == 1 )\r
339 \r
340         #define tskSIZE_OF_EACH_TRACE_LINE                      ( ( unsigned portLONG ) ( sizeof( unsigned portLONG ) + sizeof( unsigned portLONG ) ) )\r
341         static volatile signed portCHAR * volatile pcTraceBuffer;\r
342         static signed portCHAR *pcTraceBufferStart;\r
343         static signed portCHAR *pcTraceBufferEnd;\r
344         static signed portBASE_TYPE xTracing = pdFALSE;\r
345 \r
346 #endif\r
347 \r
348 /*\r
349  * Macro that writes a trace of scheduler activity to a buffer.  This trace\r
350  * shows which task is running when and is very useful as a debugging tool.\r
351  * As this macro is called each context switch it is a good idea to undefine\r
352  * it if not using the facility.\r
353  */\r
354 #if ( configUSE_TRACE_FACILITY == 1 )\r
355 \r
356         #define vWriteTraceToBuffer()                                                                                                                                   \\r
357         {                                                                                                                                                                                               \\r
358                 if( xTracing )                                                                                                                                                          \\r
359                 {                                                                                                                                                                                       \\r
360                         static unsigned portBASE_TYPE uxPreviousTask = 255;                                                                             \\r
361                                                                                                                                                                                                         \\r
362                         if( uxPreviousTask != pxCurrentTCB->uxTCBNumber )                                                                               \\r
363                         {                                                                                                                                                                               \\r
364                                 if( ( pcTraceBuffer + tskSIZE_OF_EACH_TRACE_LINE ) < pcTraceBufferEnd )                         \\r
365                                 {                                                                                                                                                                       \\r
366                                         uxPreviousTask = pxCurrentTCB->uxTCBNumber;                                                                             \\r
367                                         *( unsigned portLONG * ) pcTraceBuffer = ( unsigned portLONG ) xTickCount;              \\r
368                                         pcTraceBuffer += sizeof( unsigned portLONG );                                                                   \\r
369                                         *( unsigned portLONG * ) pcTraceBuffer = ( unsigned portLONG ) uxPreviousTask;  \\r
370                                         pcTraceBuffer += sizeof( unsigned portLONG );                                                                   \\r
371                                 }                                                                                                                                                                       \\r
372                                 else                                                                                                                                                            \\r
373                                 {                                                                                                                                                                       \\r
374                                         xTracing = pdFALSE;                                                                                                                             \\r
375                                 }                                                                                                                                                                       \\r
376                         }                                                                                                                                                                               \\r
377                 }                                                                                                                                                                                       \\r
378         }\r
379 \r
380 #else\r
381 \r
382         #define vWriteTraceToBuffer()\r
383 \r
384 #endif\r
385 \r
386 \r
387 /*\r
388  * Place the task represented by pxTCB into the appropriate ready queue for\r
389  * the task.  It is inserted at the end of the list.  One quirk of this is\r
390  * that if the task being inserted is at the same priority as the currently\r
391  * executing task, then it will only be rescheduled after the currently\r
392  * executing task has been rescheduled.\r
393  */\r
394 #define prvAddTaskToReadyQueue( pxTCB )                                                                                                                                                 \\r
395 {                                                                                                                                                                                                                               \\r
396         if( pxTCB->uxPriority > uxTopReadyPriority )                                                                                                                            \\r
397         {                                                                                                                                                                                                                       \\r
398                 uxTopReadyPriority = pxTCB->uxPriority;                                                                                                                                 \\r
399         }                                                                                                                                                                                                                       \\r
400         vListInsertEnd( ( xList * ) &( pxReadyTasksLists[ pxTCB->uxPriority ] ), &( pxTCB->xGenericListItem ) );        \\r
401 }               \r
402 \r
403 /*\r
404  * Macro that looks at the list of tasks that are currently delayed to see if\r
405  * any require waking.\r
406  *\r
407  * Tasks are stored in the queue in the order of their wake time - meaning\r
408  * once one tasks has been found whose timer has not expired we need not look\r
409  * any further down the list.\r
410  */\r
411 #define prvCheckDelayedTasks()                                                                                                                                                                          \\r
412 {                                                                                                                                                                                                                                       \\r
413 register tskTCB *pxTCB;                                                                                                                                                                                         \\r
414                                                                                                                                                                                                                                         \\r
415         while( ( pxTCB = ( tskTCB * ) listGET_OWNER_OF_HEAD_ENTRY( pxDelayedTaskList ) ) != NULL )                                              \\r
416         {                                                                                                                                                                                                                               \\r
417                 if( xTickCount < listGET_LIST_ITEM_VALUE( &( pxTCB->xGenericListItem ) ) )                                                                      \\r
418                 {                                                                                                                                                                                                                       \\r
419                         break;                                                                                                                                                                                                  \\r
420                 }                                                                                                                                                                                                                       \\r
421                 vListRemove( &( pxTCB->xGenericListItem ) );                                                                                                                            \\r
422                 /* Is the task waiting on an event also? */                                                                                                                                     \\r
423                 if( pxTCB->xEventListItem.pvContainer )                                                                                                                                         \\r
424                 {                                                                                                                                                                                                                       \\r
425                         vListRemove( &( pxTCB->xEventListItem ) );                                                                                                                              \\r
426                 }                                                                                                                                                                                                                       \\r
427                 prvAddTaskToReadyQueue( pxTCB );                                                                                                                \\r
428         }                                                                                                                                                                                                                               \\r
429 }                                                                                                                                                                                       \r
430 \r
431 /*\r
432  * Several functions take an xTaskHandle parameter that can optionally be NULL,\r
433  * where NULL is used to indicate that the handle of the currently executing\r
434  * task should be used in place of the parameter.  This macro simply checks to\r
435  * see if the parameter is NULL and returns a pointer to the appropriate TCB.\r
436  */\r
437 #define prvGetTCBFromHandle( pxHandle ) ( ( pxHandle == NULL ) ? ( tskTCB * ) pxCurrentTCB : ( tskTCB * ) pxHandle )\r
438 \r
439 \r
440 /* File private functions. --------------------------------*/\r
441 \r
442 /*\r
443  * Utility to ready a TCB for a given task.  Mainly just copies the parameters\r
444  * into the TCB structure.\r
445  */\r
446 static void prvInitialiseTCBVariables( tskTCB *pxTCB, const signed portCHAR * const pcName, unsigned portBASE_TYPE uxPriority );\r
447 \r
448 /*\r
449  * Utility to ready all the lists used by the scheduler.  This is called\r
450  * automatically upon the creation of the first task.\r
451  */\r
452 static void prvInitialiseTaskLists( void );\r
453 \r
454 /*\r
455  * The idle task, which as all tasks is implemented as a never ending loop.\r
456  * The idle task is automatically created and added to the ready lists upon\r
457  * creation of the first user task.\r
458  *\r
459  * The portTASK_FUNCTION_PROTO() macro is used to allow port/compiler specific\r
460  * language extensions.  The equivalent prototype for this function is:\r
461  *\r
462  * void prvIdleTask( void *pvParameters );\r
463  *\r
464  */\r
465 static portTASK_FUNCTION_PROTO( prvIdleTask, pvParameters );\r
466 \r
467 /*\r
468  * Utility to free all memory allocated by the scheduler to hold a TCB,\r
469  * including the stack pointed to by the TCB.\r
470  *\r
471  * This does not free memory allocated by the task itself (i.e. memory\r
472  * allocated by calls to pvPortMalloc from within the tasks application code).\r
473  */\r
474 #if ( ( INCLUDE_vTaskDelete == 1 ) || ( INCLUDE_vTaskCleanUpResources == 1 ) )\r
475         static void prvDeleteTCB( tskTCB *pxTCB );\r
476 #endif\r
477 \r
478 /*\r
479  * Used only by the idle task.  This checks to see if anything has been placed\r
480  * in the list of tasks waiting to be deleted.  If so the task is cleaned up\r
481  * and its TCB deleted.\r
482  */\r
483 static void prvCheckTasksWaitingTermination( void );\r
484 \r
485 /*\r
486  * Allocates memory from the heap for a TCB and associated stack.  Checks the\r
487  * allocation was successful.\r
488  */\r
489 static tskTCB *prvAllocateTCBAndStack( unsigned portSHORT usStackDepth );\r
490 \r
491 /*\r
492  * Called from vTaskList.  vListTasks details all the tasks currently under\r
493  * control of the scheduler.  The tasks may be in one of a number of lists.\r
494  * prvListTaskWithinSingleList accepts a list and details the tasks from\r
495  * within just that list.\r
496  *\r
497  * THIS FUNCTION IS INTENDED FOR DEBUGGING ONLY, AND SHOULD NOT BE CALLED FROM\r
498  * NORMAL APPLICATION CODE.\r
499  */\r
500 #if ( configUSE_TRACE_FACILITY == 1 )\r
501 \r
502         static void prvListTaskWithinSingleList( const signed portCHAR *pcWriteBuffer, xList *pxList, signed portCHAR cStatus );\r
503 \r
504 #endif\r
505 \r
506 /*\r
507  * When a task is created, the stack of the task is filled with a known value.\r
508  * This function determines the 'high water mark' of the task stack by\r
509  * determining how much of the stack remains at the original preset value.\r
510  */\r
511 #if ( ( configUSE_TRACE_FACILITY == 1 ) || ( INCLUDE_uxGetStackHighWaterMark == 1 ) )\r
512 \r
513         unsigned portSHORT usTaskCheckFreeStackSpace( const unsigned portCHAR * pucStackByte );\r
514 \r
515 #endif\r
516 \r
517 /*\r
518  * Checks that a task being resumed (unsuspended) is actually in the Suspended\r
519  * state.\r
520  */\r
521 #if ( INCLUDE_vTaskSuspend == 1 )\r
522 \r
523         static portBASE_TYPE prvIsTaskSuspended( const tskTCB * const pxTCB );  \r
524 \r
525 #endif\r
526 \r
527 /*lint +e956 */\r
528 \r
529 \r
530 \r
531 \r
532 \r
533 /*-----------------------------------------------------------\r
534  * TASK CREATION API documented in task.h\r
535  *----------------------------------------------------------*/\r
536 \r
537 signed portBASE_TYPE xTaskCreate( pdTASK_CODE pvTaskCode, const signed portCHAR * const pcName, unsigned portSHORT usStackDepth, void *pvParameters, unsigned portBASE_TYPE uxPriority, xTaskHandle *pxCreatedTask )\r
538 {\r
539 signed portBASE_TYPE xReturn;\r
540 tskTCB * pxNewTCB;\r
541 #if ( configUSE_TRACE_FACILITY == 1 )\r
542         static unsigned portBASE_TYPE uxTaskNumber = 0; /*lint !e956 Static is deliberate - this is guarded before use. */\r
543 #endif\r
544 \r
545         /* Allocate the memory required by the TCB and stack for the new task.\r
546         checking that the allocation was successful. */\r
547         pxNewTCB = prvAllocateTCBAndStack( usStackDepth );\r
548 \r
549         if( pxNewTCB != NULL )\r
550         {               \r
551                 portSTACK_TYPE *pxTopOfStack;\r
552 \r
553                 /* Setup the newly allocated TCB with the initial state of the task. */\r
554                 prvInitialiseTCBVariables( pxNewTCB, pcName, uxPriority );\r
555 \r
556                 /* Calculate the top of stack address.  This depends on whether the\r
557                 stack grows from high memory to low (as per the 80x86) or visa versa.\r
558                 portSTACK_GROWTH is used to make the result positive or negative as\r
559                 required by the port. */\r
560                 #if portSTACK_GROWTH < 0\r
561                 {\r
562                         pxTopOfStack = pxNewTCB->pxStack + ( usStackDepth - 1 );\r
563                 }\r
564                 #else\r
565                 {\r
566                         pxTopOfStack = pxNewTCB->pxStack;       \r
567                 }\r
568                 #endif\r
569 \r
570                 /* Initialize the TCB stack to look as if the task was already running,\r
571                 but had been interrupted by the scheduler.  The return address is set\r
572                 to the start of the task function. Once the stack has been initialised\r
573                 the     top of stack variable is updated. */\r
574                 pxNewTCB->pxTopOfStack = pxPortInitialiseStack( pxTopOfStack, pvTaskCode, pvParameters );\r
575 \r
576                 /* We are going to manipulate the task queues to add this task to a\r
577                 ready list, so must make sure no interrupts occur. */\r
578                 portENTER_CRITICAL();\r
579                 {\r
580                         uxCurrentNumberOfTasks++;\r
581                         if( uxCurrentNumberOfTasks == ( unsigned portBASE_TYPE ) 1 )\r
582                         {\r
583                                 /* As this is the first task it must also be the current task. */\r
584                                 pxCurrentTCB =  pxNewTCB;\r
585 \r
586                                 /* This is the first task to be created so do the preliminary\r
587                                 initialisation required.  We will not recover if this call\r
588                                 fails, but we will report the failure. */\r
589                                 prvInitialiseTaskLists();\r
590                         }\r
591                         else\r
592                         {       \r
593                                 /* If the scheduler is not already running, make this task the\r
594                                 current task if it is the highest priority task to be created\r
595                                 so far. */\r
596                                 if( xSchedulerRunning == pdFALSE )\r
597                                 {\r
598                                         if( pxCurrentTCB->uxPriority <= uxPriority )\r
599                                         {\r
600                                                 pxCurrentTCB = pxNewTCB;        \r
601                                         }\r
602                                 }\r
603                         }                               \r
604 \r
605                         /* Remember the top priority to make context switching faster.  Use\r
606                         the priority in pxNewTCB as this has been capped to a valid value. */\r
607                         if( pxNewTCB->uxPriority > uxTopUsedPriority )\r
608                         {\r
609                                 uxTopUsedPriority = pxNewTCB->uxPriority;\r
610                         }\r
611 \r
612                         #if ( configUSE_TRACE_FACILITY == 1 )\r
613                         {\r
614                                 /* Add a counter into the TCB for tracing only. */\r
615                                 pxNewTCB->uxTCBNumber = uxTaskNumber;\r
616                                 uxTaskNumber++;\r
617                         }\r
618                         #endif\r
619 \r
620                         prvAddTaskToReadyQueue( pxNewTCB );\r
621 \r
622                         xReturn = pdPASS;\r
623                         traceTASK_CREATE( pxNewTCB );\r
624                 }\r
625                 portEXIT_CRITICAL();\r
626         }\r
627         else\r
628         {\r
629                 xReturn = errCOULD_NOT_ALLOCATE_REQUIRED_MEMORY;\r
630                 traceTASK_CREATE_FAILED( pxNewTCB );\r
631         }\r
632 \r
633         if( xReturn == pdPASS )\r
634         {\r
635                 if( ( void * ) pxCreatedTask != NULL )\r
636                 {\r
637                         /* Pass the TCB out - in an anonymous way.  The calling function/\r
638                         task can use this as a handle to delete the task later if\r
639                         required.*/\r
640                         *pxCreatedTask = ( xTaskHandle ) pxNewTCB;\r
641                 }\r
642 \r
643                 if( xSchedulerRunning != pdFALSE )\r
644                 {\r
645                         /* If the created task is of a higher priority than the current task\r
646                         then it should run now. */\r
647                         if( pxCurrentTCB->uxPriority < uxPriority )\r
648                         {\r
649                                 taskYIELD();\r
650                         }\r
651                 }\r
652         }\r
653 \r
654         return xReturn;\r
655 }\r
656 /*-----------------------------------------------------------*/\r
657 \r
658 #if ( INCLUDE_vTaskDelete == 1 )\r
659 \r
660         void vTaskDelete( xTaskHandle pxTaskToDelete )\r
661         {\r
662         tskTCB *pxTCB;\r
663 \r
664                 taskENTER_CRITICAL();\r
665                 {\r
666                         /* Ensure a yield is performed if the current task is being \r
667                         deleted. */\r
668                         if( pxTaskToDelete == pxCurrentTCB )\r
669                         {\r
670                                 pxTaskToDelete = NULL;\r
671                         }\r
672 \r
673                         /* If null is passed in here then we are deleting ourselves. */\r
674                         pxTCB = prvGetTCBFromHandle( pxTaskToDelete );\r
675 \r
676                         traceTASK_DELETE( pxTCB );\r
677 \r
678                         /* Remove task from the ready list and place in the     termination list.\r
679                         This will stop the task from be scheduled.  The idle task will check\r
680                         the termination list and free up any memory allocated by the\r
681                         scheduler for the TCB and stack. */\r
682                         vListRemove( &( pxTCB->xGenericListItem ) );\r
683 \r
684                         /* Is the task waiting on an event also? */                                                                                             \r
685                         if( pxTCB->xEventListItem.pvContainer )\r
686                         {\r
687                                 vListRemove( &( pxTCB->xEventListItem ) );\r
688                         }\r
689 \r
690                         vListInsertEnd( ( xList * ) &xTasksWaitingTermination, &( pxTCB->xGenericListItem ) );\r
691 \r
692                         /* Increment the ucTasksDeleted variable so the idle task knows\r
693                         there is a task that has been deleted and that it should therefore\r
694                         check the xTasksWaitingTermination list. */\r
695                         ++uxTasksDeleted;\r
696                 }\r
697                 taskEXIT_CRITICAL();\r
698 \r
699                 /* Force a reschedule if we have just deleted the current task. */\r
700                 if( xSchedulerRunning != pdFALSE ) \r
701                 {\r
702                         if( ( void * ) pxTaskToDelete == NULL )\r
703                         {\r
704                                 taskYIELD();\r
705                         }\r
706                 }\r
707         }\r
708 \r
709 #endif\r
710 \r
711 \r
712 \r
713 \r
714 \r
715 \r
716 /*-----------------------------------------------------------\r
717  * TASK CONTROL API documented in task.h\r
718  *----------------------------------------------------------*/\r
719 \r
720 #if ( INCLUDE_vTaskDelayUntil == 1 )\r
721 \r
722         void vTaskDelayUntil( portTickType * const pxPreviousWakeTime, portTickType xTimeIncrement )\r
723         {\r
724         portTickType xTimeToWake;\r
725         portBASE_TYPE xAlreadyYielded, xShouldDelay = pdFALSE;\r
726 \r
727                 vTaskSuspendAll();\r
728                 {\r
729                         /* Generate the tick time at which the task wants to wake. */\r
730                         xTimeToWake = *pxPreviousWakeTime + xTimeIncrement;\r
731 \r
732                         if( xTickCount < *pxPreviousWakeTime )\r
733                         {\r
734                                 /* The tick count has overflowed since this function was\r
735                                 lasted called.  In this case the only time we should ever\r
736                                 actually delay is if the wake time has also     overflowed,\r
737                                 and the wake time is greater than the tick time.  When this\r
738                                 is the case it is as if neither time had overflowed. */\r
739                                 if( ( xTimeToWake < *pxPreviousWakeTime ) && ( xTimeToWake > xTickCount ) )\r
740                                 {\r
741                                         xShouldDelay = pdTRUE;\r
742                                 }\r
743                         }\r
744                         else\r
745                         {\r
746                                 /* The tick time has not overflowed.  In this case we will\r
747                                 delay if either the wake time has overflowed, and/or the\r
748                                 tick time is less than the wake time. */\r
749                                 if( ( xTimeToWake < *pxPreviousWakeTime ) || ( xTimeToWake > xTickCount ) )\r
750                                 {\r
751                                         xShouldDelay = pdTRUE;\r
752                                 }\r
753                         }\r
754 \r
755                         /* Update the wake time ready for the next call. */\r
756                         *pxPreviousWakeTime = xTimeToWake;\r
757 \r
758                         if( xShouldDelay )\r
759                         {\r
760                                 traceTASK_DELAY_UNTIL();\r
761 \r
762                                 /* We must remove ourselves from the ready list before adding\r
763                                 ourselves to the blocked list as the same list item is used for\r
764                                 both lists. */\r
765                                 vListRemove( ( xListItem * ) &( pxCurrentTCB->xGenericListItem ) );\r
766 \r
767                                 /* The list item will be inserted in wake time order. */\r
768                                 listSET_LIST_ITEM_VALUE( &( pxCurrentTCB->xGenericListItem ), xTimeToWake );\r
769 \r
770                                 if( xTimeToWake < xTickCount )\r
771                                 {\r
772                                         /* Wake time has overflowed.  Place this item in the\r
773                                         overflow list. */\r
774                                         vListInsert( ( xList * ) pxOverflowDelayedTaskList, ( xListItem * ) &( pxCurrentTCB->xGenericListItem ) );\r
775                                 }\r
776                                 else\r
777                                 {\r
778                                         /* The wake time has not overflowed, so we can use the\r
779                                         current block list. */\r
780                                         vListInsert( ( xList * ) pxDelayedTaskList, ( xListItem * ) &( pxCurrentTCB->xGenericListItem ) );\r
781                                 }\r
782                         }\r
783                 }\r
784                 xAlreadyYielded = xTaskResumeAll();\r
785 \r
786                 /* Force a reschedule if xTaskResumeAll has not already done so, we may\r
787                 have put ourselves to sleep. */\r
788                 if( !xAlreadyYielded )\r
789                 {\r
790                         taskYIELD();\r
791                 }\r
792         }       \r
793         \r
794 #endif\r
795 /*-----------------------------------------------------------*/\r
796 \r
797 #if ( INCLUDE_vTaskDelay == 1 )\r
798 \r
799         void vTaskDelay( portTickType xTicksToDelay )\r
800         {\r
801         portTickType xTimeToWake;\r
802         signed portBASE_TYPE xAlreadyYielded = pdFALSE;\r
803 \r
804                 /* A delay time of zero just forces a reschedule. */\r
805                 if( xTicksToDelay > ( portTickType ) 0 )\r
806                 {\r
807                         vTaskSuspendAll();\r
808                         {\r
809                                 traceTASK_DELAY();\r
810 \r
811                                 /* A task that is removed from the event list while the\r
812                                 scheduler is suspended will not get placed in the ready\r
813                                 list or removed from the blocked list until the scheduler\r
814                                 is resumed.\r
815                                 \r
816                                 This task cannot be in an event list as it is the currently\r
817                                 executing task. */\r
818 \r
819                                 /* Calculate the time to wake - this may overflow but this is\r
820                                 not a problem. */\r
821                                 xTimeToWake = xTickCount + xTicksToDelay;\r
822 \r
823                                 /* We must remove ourselves from the ready list before adding\r
824                                 ourselves to the blocked list as the same list item is used for\r
825                                 both lists. */\r
826                                 vListRemove( ( xListItem * ) &( pxCurrentTCB->xGenericListItem ) );\r
827 \r
828                                 /* The list item will be inserted in wake time order. */\r
829                                 listSET_LIST_ITEM_VALUE( &( pxCurrentTCB->xGenericListItem ), xTimeToWake );\r
830 \r
831                                 if( xTimeToWake < xTickCount )\r
832                                 {\r
833                                         /* Wake time has overflowed.  Place this item in the\r
834                                         overflow list. */\r
835                                         vListInsert( ( xList * ) pxOverflowDelayedTaskList, ( xListItem * ) &( pxCurrentTCB->xGenericListItem ) );\r
836                                 }\r
837                                 else\r
838                                 {\r
839                                         /* The wake time has not overflowed, so we can use the\r
840                                         current block list. */\r
841                                         vListInsert( ( xList * ) pxDelayedTaskList, ( xListItem * ) &( pxCurrentTCB->xGenericListItem ) );\r
842                                 }\r
843                         }\r
844                         xAlreadyYielded = xTaskResumeAll();\r
845                 }\r
846                 \r
847                 /* Force a reschedule if xTaskResumeAll has not already done so, we may\r
848                 have put ourselves to sleep. */\r
849                 if( !xAlreadyYielded )\r
850                 {\r
851                         taskYIELD();\r
852                 }\r
853         }\r
854         \r
855 #endif\r
856 /*-----------------------------------------------------------*/\r
857 \r
858 #if ( INCLUDE_uxTaskPriorityGet == 1 )\r
859 \r
860         unsigned portBASE_TYPE uxTaskPriorityGet( xTaskHandle pxTask )\r
861         {\r
862         tskTCB *pxTCB;\r
863         unsigned portBASE_TYPE uxReturn;\r
864 \r
865                 taskENTER_CRITICAL();\r
866                 {\r
867                         /* If null is passed in here then we are changing the\r
868                         priority of the calling function. */\r
869                         pxTCB = prvGetTCBFromHandle( pxTask );\r
870                         uxReturn = pxTCB->uxPriority;\r
871                 }\r
872                 taskEXIT_CRITICAL();\r
873 \r
874                 return uxReturn;\r
875         }\r
876 \r
877 #endif\r
878 /*-----------------------------------------------------------*/\r
879 \r
880 #if ( INCLUDE_vTaskPrioritySet == 1 )\r
881 \r
882         void vTaskPrioritySet( xTaskHandle pxTask, unsigned portBASE_TYPE uxNewPriority )\r
883         {\r
884         tskTCB *pxTCB;\r
885         unsigned portBASE_TYPE uxCurrentPriority, xYieldRequired = pdFALSE;\r
886 \r
887                 /* Ensure the new priority is valid. */\r
888                 if( uxNewPriority >= configMAX_PRIORITIES )\r
889                 {\r
890                         uxNewPriority = configMAX_PRIORITIES - 1;\r
891                 }\r
892 \r
893                 taskENTER_CRITICAL();\r
894                 {\r
895                         /* If null is passed in here then we are changing the\r
896                         priority of the calling function. */\r
897                         pxTCB = prvGetTCBFromHandle( pxTask );\r
898                         \r
899                         traceTASK_PRIORITY_SET( pxTask, uxNewPriority );\r
900 \r
901                         #if ( configUSE_MUTEXES == 1 )\r
902                         {\r
903                                 uxCurrentPriority = pxTCB->uxBasePriority;\r
904                         }\r
905                         #else\r
906                         {\r
907                                 uxCurrentPriority = pxTCB->uxPriority;\r
908                         }\r
909                         #endif\r
910 \r
911                         if( uxCurrentPriority != uxNewPriority )\r
912                         {\r
913                                 /* The priority change may have readied a task of higher\r
914                                 priority than the calling task. */\r
915                                 if( uxNewPriority > uxCurrentPriority ) \r
916                                 {\r
917                                         if( pxTask != NULL )\r
918                                         {\r
919                                                 /* The priority of another task is being raised.  If we\r
920                                                 were raising the priority of the currently running task\r
921                                                 there would be no need to switch as it must have already\r
922                                                 been the highest priority task. */\r
923                                                 xYieldRequired = pdTRUE;\r
924                                         }\r
925                                 }\r
926                                 else if( pxTask == NULL )\r
927                                 {\r
928                                         /* Setting our own priority down means there may now be another\r
929                                         task of higher priority that is ready to execute. */\r
930                                         xYieldRequired = pdTRUE;\r
931                                 }\r
932                         \r
933                                 \r
934 \r
935                                 #if ( configUSE_MUTEXES == 1 )\r
936                                 {\r
937                                         /* Only change the priority being used if the task is not\r
938                                         currently using an inherited priority. */\r
939                                         if( pxTCB->uxBasePriority == pxTCB->uxPriority )\r
940                                         {\r
941                                                 pxTCB->uxPriority = uxNewPriority;\r
942                                         }\r
943                                         \r
944                                         /* The base priority gets set whatever. */\r
945                                         pxTCB->uxBasePriority = uxNewPriority;                                  \r
946                                 }\r
947                                 #else\r
948                                 {\r
949                                         pxTCB->uxPriority = uxNewPriority;\r
950                                 }\r
951                                 #endif\r
952 \r
953                                 listSET_LIST_ITEM_VALUE( &( pxTCB->xEventListItem ), ( configMAX_PRIORITIES - ( portTickType ) uxNewPriority ) );\r
954 \r
955                                 /* If the task is in the blocked or suspended list we need do\r
956                                 nothing more than change it's priority variable. However, if\r
957                                 the task is in a ready list it needs to be removed and placed\r
958                                 in the queue appropriate to its new priority. */\r
959                                 if( listIS_CONTAINED_WITHIN( &( pxReadyTasksLists[ uxCurrentPriority ] ), &( pxTCB->xGenericListItem ) ) )\r
960                                 {\r
961                                         /* The task is currently in its ready list - remove before adding\r
962                                         it to it's new ready list.  As we are in a critical section we\r
963                                         can do this even if the scheduler is suspended. */\r
964                                         vListRemove( &( pxTCB->xGenericListItem ) );\r
965                                         prvAddTaskToReadyQueue( pxTCB );\r
966                                 }                       \r
967                                 \r
968                                 if( xYieldRequired == pdTRUE )\r
969                                 {\r
970                                         taskYIELD();\r
971                                 }                               \r
972                         }\r
973                 }\r
974                 taskEXIT_CRITICAL();\r
975         }\r
976 \r
977 #endif\r
978 /*-----------------------------------------------------------*/\r
979 \r
980 #if ( INCLUDE_vTaskSuspend == 1 )\r
981 \r
982         void vTaskSuspend( xTaskHandle pxTaskToSuspend )\r
983         {\r
984         tskTCB *pxTCB;\r
985 \r
986                 taskENTER_CRITICAL();\r
987                 {\r
988                         /* Ensure a yield is performed if the current task is being \r
989                         suspended. */\r
990                         if( pxTaskToSuspend == pxCurrentTCB )\r
991                         {\r
992                                 pxTaskToSuspend = NULL;\r
993                         }\r
994 \r
995                         /* If null is passed in here then we are suspending ourselves. */\r
996                         pxTCB = prvGetTCBFromHandle( pxTaskToSuspend );\r
997 \r
998                         traceTASK_SUSPEND( pxTaskToSuspend );\r
999 \r
1000                         /* Remove task from the ready/delayed list and place in the     suspended list. */\r
1001                         vListRemove( &( pxTCB->xGenericListItem ) );\r
1002 \r
1003                         /* Is the task waiting on an event also? */                                                                                             \r
1004                         if( pxTCB->xEventListItem.pvContainer )\r
1005                         {\r
1006                                 vListRemove( &( pxTCB->xEventListItem ) );\r
1007                         }\r
1008 \r
1009                         vListInsertEnd( ( xList * ) &xSuspendedTaskList, &( pxTCB->xGenericListItem ) );\r
1010                 }\r
1011                 taskEXIT_CRITICAL();\r
1012 \r
1013                 /* We may have just suspended the current task. */\r
1014                 if( ( void * ) pxTaskToSuspend == NULL )\r
1015                 {\r
1016                         taskYIELD();\r
1017                 }\r
1018         }\r
1019 \r
1020 #endif\r
1021 /*-----------------------------------------------------------*/\r
1022 \r
1023 #if ( INCLUDE_vTaskSuspend == 1 )\r
1024 \r
1025         static portBASE_TYPE prvIsTaskSuspended( const tskTCB * const pxTCB )\r
1026         {\r
1027         portBASE_TYPE xReturn = pdFALSE;\r
1028 \r
1029                 /* Is the task we are attempting to resume actually in the\r
1030                 suspended list? */\r
1031                 if( listIS_CONTAINED_WITHIN( &xSuspendedTaskList, &( pxTCB->xGenericListItem ) ) != pdFALSE )\r
1032                 {\r
1033                         /* Has the task already been resumed from within an ISR? */\r
1034                         if( listIS_CONTAINED_WITHIN( &xPendingReadyList, &( pxTCB->xEventListItem ) ) != pdTRUE )\r
1035                         {                       \r
1036                                 /* Is it in the suspended list because it is in the\r
1037                                 Suspended state?  It is possible to be in the suspended\r
1038                                 list because it is blocked on a task with no timeout\r
1039                                 specified. */\r
1040                                 if( listIS_CONTAINED_WITHIN( NULL, &( pxTCB->xEventListItem ) ) == pdTRUE )\r
1041                                 {\r
1042                                         xReturn = pdTRUE;\r
1043                                 }\r
1044                         }\r
1045                 }\r
1046 \r
1047                 return xReturn;\r
1048         }\r
1049 \r
1050 #endif\r
1051 /*-----------------------------------------------------------*/\r
1052 \r
1053 #if ( INCLUDE_vTaskSuspend == 1 )\r
1054 \r
1055         void vTaskResume( xTaskHandle pxTaskToResume )\r
1056         {\r
1057         tskTCB *pxTCB;\r
1058 \r
1059                 /* Remove the task from whichever list it is currently in, and place\r
1060                 it in the ready list. */\r
1061                 pxTCB = ( tskTCB * ) pxTaskToResume;\r
1062 \r
1063                 /* The parameter cannot be NULL as it is impossible to resume the\r
1064                 currently executing task. */\r
1065                 if( pxTCB != NULL )\r
1066                 {\r
1067                         taskENTER_CRITICAL();\r
1068                         {\r
1069                                 if( prvIsTaskSuspended( pxTCB ) == pdTRUE )\r
1070                                 {\r
1071                                         traceTASK_RESUME( pxTCB );\r
1072 \r
1073                                         /* As we are in a critical section we can access the ready\r
1074                                         lists even if the scheduler is suspended. */\r
1075                                         vListRemove(  &( pxTCB->xGenericListItem ) );\r
1076                                         prvAddTaskToReadyQueue( pxTCB );\r
1077 \r
1078                                         /* We may have just resumed a higher priority task. */\r
1079                                         if( pxTCB->uxPriority >= pxCurrentTCB->uxPriority )\r
1080                                         {\r
1081                                                 /* This yield may not cause the task just resumed to run, but\r
1082                                                 will leave the lists in the correct state for the next yield. */\r
1083                                                 taskYIELD();\r
1084                                         }\r
1085                                 }\r
1086                         }\r
1087                         taskEXIT_CRITICAL();\r
1088                 }\r
1089         }\r
1090 \r
1091 #endif\r
1092 \r
1093 /*-----------------------------------------------------------*/\r
1094 \r
1095 #if ( ( INCLUDE_xTaskResumeFromISR == 1 ) && ( INCLUDE_vTaskSuspend == 1 ) )\r
1096 \r
1097         portBASE_TYPE xTaskResumeFromISR( xTaskHandle pxTaskToResume )\r
1098         {\r
1099         portBASE_TYPE xYieldRequired = pdFALSE;\r
1100         tskTCB *pxTCB;\r
1101 \r
1102                 pxTCB = ( tskTCB * ) pxTaskToResume;\r
1103 \r
1104                 if( prvIsTaskSuspended( pxTCB ) == pdTRUE )\r
1105                 {\r
1106                         traceTASK_RESUME_FROM_ISR( pxTCB );\r
1107 \r
1108                         if( uxSchedulerSuspended == ( unsigned portBASE_TYPE ) pdFALSE )\r
1109                         {\r
1110                                 xYieldRequired = ( pxTCB->uxPriority >= pxCurrentTCB->uxPriority );\r
1111                                 vListRemove(  &( pxTCB->xGenericListItem ) );   \r
1112                                 prvAddTaskToReadyQueue( pxTCB );\r
1113                         }\r
1114                         else\r
1115                         {\r
1116                                 /* We cannot access the delayed or ready lists, so will hold this\r
1117                                 task pending until the scheduler is resumed, at which point a\r
1118                                 yield will be performed if necessary. */\r
1119                                 vListInsertEnd( ( xList * ) &( xPendingReadyList ), &( pxTCB->xEventListItem ) );\r
1120                         }\r
1121                 }\r
1122 \r
1123                 return xYieldRequired;\r
1124         }\r
1125 \r
1126 #endif\r
1127 \r
1128 \r
1129 \r
1130 \r
1131 /*-----------------------------------------------------------\r
1132  * PUBLIC SCHEDULER CONTROL documented in task.h\r
1133  *----------------------------------------------------------*/\r
1134 \r
1135 \r
1136 void vTaskStartScheduler( void )\r
1137 {\r
1138 portBASE_TYPE xReturn;\r
1139 \r
1140         /* Add the idle task at the lowest priority. */\r
1141         xReturn = xTaskCreate( prvIdleTask, ( signed portCHAR * ) "IDLE", tskIDLE_STACK_SIZE, ( void * ) NULL, tskIDLE_PRIORITY, ( xTaskHandle * ) NULL );\r
1142 \r
1143         if( xReturn == pdPASS )\r
1144         {\r
1145                 /* Interrupts are turned off here, to ensure a tick does not occur\r
1146                 before or during the call to xPortStartScheduler().  The stacks of\r
1147                 the created tasks contain a status word with interrupts switched on\r
1148                 so interrupts will automatically get re-enabled when the first task\r
1149                 starts to run.\r
1150                 \r
1151                 STEPPING THROUGH HERE USING A DEBUGGER CAN CAUSE BIG PROBLEMS IF THE\r
1152                 DEBUGGER ALLOWS INTERRUPTS TO BE PROCESSED. */\r
1153                 portDISABLE_INTERRUPTS();\r
1154 \r
1155                 xSchedulerRunning = pdTRUE;\r
1156                 xTickCount = ( portTickType ) 0;\r
1157 \r
1158                 /* Setting up the timer tick is hardware specific and thus in the\r
1159                 portable interface. */\r
1160                 if( xPortStartScheduler() )\r
1161                 {\r
1162                         /* Should not reach here as if the scheduler is running the\r
1163                         function will not return. */\r
1164                 }\r
1165                 else\r
1166                 {\r
1167                         /* Should only reach here if a task calls xTaskEndScheduler(). */\r
1168                 }\r
1169         }\r
1170 }\r
1171 /*-----------------------------------------------------------*/\r
1172 \r
1173 void vTaskEndScheduler( void )\r
1174 {\r
1175         /* Stop the scheduler interrupts and call the portable scheduler end\r
1176         routine so the original ISRs can be restored if necessary.  The port\r
1177         layer must ensure interrupts enable     bit is left in the correct state. */\r
1178         portDISABLE_INTERRUPTS();\r
1179         xSchedulerRunning = pdFALSE;\r
1180         vPortEndScheduler();\r
1181 }\r
1182 /*----------------------------------------------------------*/\r
1183 \r
1184 void vTaskSuspendAll( void )\r
1185 {\r
1186         portENTER_CRITICAL();\r
1187                 ++uxSchedulerSuspended;\r
1188         portEXIT_CRITICAL();\r
1189 }\r
1190 /*----------------------------------------------------------*/\r
1191 \r
1192 signed portBASE_TYPE xTaskResumeAll( void )\r
1193 {\r
1194 register tskTCB *pxTCB;\r
1195 signed portBASE_TYPE xAlreadyYielded = pdFALSE;\r
1196 \r
1197         /* It is possible that an ISR caused a task to be removed from an event\r
1198         list while the scheduler was suspended.  If this was the case then the\r
1199         removed task will have been added to the xPendingReadyList.  Once the\r
1200         scheduler has been resumed it is safe to move all the pending ready\r
1201         tasks from this list into their appropriate ready list. */\r
1202         portENTER_CRITICAL();\r
1203         {\r
1204                 --uxSchedulerSuspended;\r
1205 \r
1206                 if( uxSchedulerSuspended == ( unsigned portBASE_TYPE ) pdFALSE )\r
1207                 {                       \r
1208                         if( uxCurrentNumberOfTasks > ( unsigned portBASE_TYPE ) 0 )\r
1209                         {\r
1210                                 portBASE_TYPE xYieldRequired = pdFALSE;\r
1211                                 \r
1212                                 /* Move any readied tasks from the pending list into the\r
1213                                 appropriate ready list. */\r
1214                                 while( ( pxTCB = ( tskTCB * ) listGET_OWNER_OF_HEAD_ENTRY(  ( ( xList * ) &xPendingReadyList ) ) ) != NULL )\r
1215                                 {\r
1216                                         vListRemove( &( pxTCB->xEventListItem ) );\r
1217                                         vListRemove( &( pxTCB->xGenericListItem ) );\r
1218                                         prvAddTaskToReadyQueue( pxTCB );\r
1219                                         \r
1220                                         /* If we have moved a task that has a priority higher than\r
1221                                         the current task then we should yield. */\r
1222                                         if( pxTCB->uxPriority >= pxCurrentTCB->uxPriority )\r
1223                                         {\r
1224                                                 xYieldRequired = pdTRUE;\r
1225                                         }\r
1226                                 }\r
1227 \r
1228                                 /* If any ticks occurred while the scheduler was suspended then\r
1229                                 they should be processed now.  This ensures the tick count does not\r
1230                                 slip, and that any delayed tasks are resumed at the correct time. */\r
1231                                 if( uxMissedTicks > ( unsigned portBASE_TYPE ) 0 )\r
1232                                 {\r
1233                                         while( uxMissedTicks > ( unsigned portBASE_TYPE ) 0 )\r
1234                                         {\r
1235                                                 vTaskIncrementTick();\r
1236                                                 --uxMissedTicks;\r
1237                                         }\r
1238 \r
1239                                         /* As we have processed some ticks it is appropriate to yield\r
1240                                         to ensure the highest priority task that is ready to run is\r
1241                                         the task actually running. */\r
1242                                         #if configUSE_PREEMPTION == 1\r
1243                                         {\r
1244                                                 xYieldRequired = pdTRUE;\r
1245                                         }\r
1246                                         #endif\r
1247                                 }\r
1248                                 \r
1249                                 if( ( xYieldRequired == pdTRUE ) || ( xMissedYield == pdTRUE ) )\r
1250                                 {\r
1251                                         xAlreadyYielded = pdTRUE;\r
1252                                         xMissedYield = pdFALSE;\r
1253                                         taskYIELD();\r
1254                                 }\r
1255                         }\r
1256                 }\r
1257         }\r
1258         portEXIT_CRITICAL();\r
1259 \r
1260         return xAlreadyYielded;\r
1261 }\r
1262 \r
1263 \r
1264 \r
1265 \r
1266 \r
1267 \r
1268 /*-----------------------------------------------------------\r
1269  * PUBLIC TASK UTILITIES documented in task.h\r
1270  *----------------------------------------------------------*/\r
1271 \r
1272 \r
1273 \r
1274 portTickType xTaskGetTickCount( void )\r
1275 {\r
1276 portTickType xTicks;\r
1277 \r
1278         /* Critical section required if running on a 16 bit processor. */\r
1279         taskENTER_CRITICAL();\r
1280         {\r
1281                 xTicks = xTickCount;\r
1282         }\r
1283         taskEXIT_CRITICAL();\r
1284 \r
1285         return xTicks;\r
1286 }\r
1287 /*-----------------------------------------------------------*/\r
1288 \r
1289 unsigned portBASE_TYPE uxTaskGetNumberOfTasks( void )\r
1290 {\r
1291 unsigned portBASE_TYPE uxNumberOfTasks;\r
1292 \r
1293         taskENTER_CRITICAL();\r
1294                 uxNumberOfTasks = uxCurrentNumberOfTasks;\r
1295         taskEXIT_CRITICAL();\r
1296 \r
1297         return uxNumberOfTasks;\r
1298 }\r
1299 /*-----------------------------------------------------------*/\r
1300 \r
1301 #if ( ( configUSE_TRACE_FACILITY == 1 ) && ( INCLUDE_vTaskDelete == 1 ) && ( INCLUDE_vTaskSuspend == 1 ) )\r
1302 \r
1303         void vTaskList( signed portCHAR *pcWriteBuffer )\r
1304         {\r
1305         unsigned portBASE_TYPE uxQueue;\r
1306 \r
1307                 /* This is a VERY costly function that should be used for debug only.\r
1308                 It leaves interrupts disabled for a LONG time. */\r
1309 \r
1310         vTaskSuspendAll();\r
1311                 {\r
1312                         /* Run through all the lists that could potentially contain a TCB and\r
1313                         report the task name, state and stack high water mark. */\r
1314 \r
1315                         pcWriteBuffer[ 0 ] = ( signed portCHAR ) 0x00;\r
1316                         strcat( ( portCHAR * ) pcWriteBuffer, ( const portCHAR * ) "\r\n" );\r
1317 \r
1318                         uxQueue = uxTopUsedPriority + 1;\r
1319 \r
1320                         do\r
1321                         {\r
1322                                 uxQueue--;\r
1323 \r
1324                                 if( !listLIST_IS_EMPTY( &( pxReadyTasksLists[ uxQueue ] ) ) )\r
1325                                 {\r
1326                                         prvListTaskWithinSingleList( pcWriteBuffer, ( xList * ) &( pxReadyTasksLists[ uxQueue ] ), tskREADY_CHAR );                     \r
1327                                 }\r
1328                         }while( uxQueue > ( unsigned portSHORT ) tskIDLE_PRIORITY );\r
1329 \r
1330                         if( !listLIST_IS_EMPTY( pxDelayedTaskList ) )\r
1331                         {\r
1332                                 prvListTaskWithinSingleList( pcWriteBuffer, ( xList * ) pxDelayedTaskList, tskBLOCKED_CHAR );\r
1333                         }\r
1334 \r
1335                         if( !listLIST_IS_EMPTY( pxOverflowDelayedTaskList ) )\r
1336                         {\r
1337                                 prvListTaskWithinSingleList( pcWriteBuffer, ( xList * ) pxOverflowDelayedTaskList, tskBLOCKED_CHAR );\r
1338                         }\r
1339 \r
1340                         if( !listLIST_IS_EMPTY( &xTasksWaitingTermination ) )\r
1341                         {\r
1342                                 prvListTaskWithinSingleList( pcWriteBuffer, ( xList * ) &xTasksWaitingTermination, tskDELETED_CHAR );\r
1343                         }\r
1344 \r
1345                         if( !listLIST_IS_EMPTY( &xSuspendedTaskList ) )\r
1346                         {\r
1347                                 prvListTaskWithinSingleList( pcWriteBuffer, ( xList * ) &xSuspendedTaskList, tskSUSPENDED_CHAR );\r
1348                         }\r
1349                 }\r
1350         xTaskResumeAll();\r
1351         }\r
1352 \r
1353 #endif\r
1354 /*----------------------------------------------------------*/\r
1355 \r
1356 #if ( configUSE_TRACE_FACILITY == 1 )\r
1357 \r
1358         void vTaskStartTrace( signed portCHAR * pcBuffer, unsigned portLONG ulBufferSize )\r
1359         {\r
1360                 portENTER_CRITICAL();\r
1361                 {\r
1362                         pcTraceBuffer = ( signed portCHAR * )pcBuffer;\r
1363                         pcTraceBufferStart = pcBuffer;\r
1364                         pcTraceBufferEnd = pcBuffer + ( ulBufferSize - tskSIZE_OF_EACH_TRACE_LINE );\r
1365                         xTracing = pdTRUE;\r
1366                 }\r
1367                 portEXIT_CRITICAL();\r
1368         }\r
1369 \r
1370 #endif\r
1371 /*----------------------------------------------------------*/\r
1372 \r
1373 #if ( configUSE_TRACE_FACILITY == 1 )\r
1374 \r
1375         unsigned portLONG ulTaskEndTrace( void )\r
1376         {\r
1377         unsigned portLONG ulBufferLength;\r
1378 \r
1379                 portENTER_CRITICAL();\r
1380                         xTracing = pdFALSE;\r
1381                 portEXIT_CRITICAL();\r
1382 \r
1383                 ulBufferLength = ( unsigned portLONG ) ( pcTraceBuffer - pcTraceBufferStart );\r
1384 \r
1385                 return ulBufferLength;\r
1386         }\r
1387 \r
1388 #endif\r
1389 \r
1390 \r
1391 \r
1392 /*-----------------------------------------------------------\r
1393  * SCHEDULER INTERNALS AVAILABLE FOR PORTING PURPOSES\r
1394  * documented in task.h\r
1395  *----------------------------------------------------------*/\r
1396 \r
1397 \r
1398 inline void vTaskIncrementTick( void )\r
1399 {\r
1400         /* Called by the portable layer each time a tick interrupt occurs.\r
1401         Increments the tick then checks to see if the new tick value will cause any\r
1402         tasks to be unblocked. */\r
1403         if( uxSchedulerSuspended == ( unsigned portBASE_TYPE ) pdFALSE )\r
1404         {\r
1405                 ++xTickCount;\r
1406                 if( xTickCount == ( portTickType ) 0 )\r
1407                 {\r
1408                         xList *pxTemp;\r
1409 \r
1410                         /* Tick count has overflowed so we need to swap the delay lists.  \r
1411                         If there are any items in pxDelayedTaskList here then there is \r
1412                         an error! */\r
1413                         pxTemp = pxDelayedTaskList;\r
1414                         pxDelayedTaskList = pxOverflowDelayedTaskList;\r
1415                         pxOverflowDelayedTaskList = pxTemp;\r
1416             xNumOfOverflows++;\r
1417                 }\r
1418 \r
1419                 /* See if this tick has made a timeout expire. */\r
1420                 prvCheckDelayedTasks();\r
1421         }\r
1422         else\r
1423         {\r
1424                 ++uxMissedTicks;\r
1425 \r
1426                 /* The tick hook gets called at regular intervals, even if the \r
1427                 scheduler is locked. */\r
1428                 #if ( configUSE_TICK_HOOK == 1 )\r
1429                 {\r
1430                         extern void vApplicationTickHook( void );\r
1431 \r
1432                         vApplicationTickHook();\r
1433                 }\r
1434                 #endif\r
1435         }\r
1436 \r
1437         #if ( configUSE_TICK_HOOK == 1 )\r
1438         {\r
1439                 extern void vApplicationTickHook( void );\r
1440 \r
1441                 /* Guard against the tick hook being called when the missed tick\r
1442                 count is being unwound (when the scheduler is being unlocked. */\r
1443                 if( uxMissedTicks == 0 )\r
1444                 {\r
1445                         vApplicationTickHook();\r
1446                 }\r
1447         }\r
1448         #endif\r
1449 \r
1450         traceTASK_INCREMENT_TICK( xTickCount );\r
1451 }\r
1452 /*-----------------------------------------------------------*/\r
1453 \r
1454 #if ( ( INCLUDE_vTaskCleanUpResources == 1 ) && ( INCLUDE_vTaskSuspend == 1 ) )\r
1455 \r
1456         void vTaskCleanUpResources( void )\r
1457         {\r
1458         unsigned portSHORT usQueue;\r
1459         volatile tskTCB *pxTCB;\r
1460 \r
1461                 usQueue = ( unsigned portSHORT ) uxTopUsedPriority + ( unsigned portSHORT ) 1;\r
1462 \r
1463                 /* Remove any TCB's from the ready queues. */\r
1464                 do\r
1465                 {\r
1466                         usQueue--;\r
1467 \r
1468                         while( !listLIST_IS_EMPTY( &( pxReadyTasksLists[ usQueue ] ) ) )\r
1469                         {\r
1470                                 listGET_OWNER_OF_NEXT_ENTRY( pxTCB, &( pxReadyTasksLists[ usQueue ] ) );\r
1471                                 vListRemove( ( xListItem * ) &( pxTCB->xGenericListItem ) );\r
1472 \r
1473                                 prvDeleteTCB( ( tskTCB * ) pxTCB );\r
1474                         }\r
1475                 }while( usQueue > ( unsigned portSHORT ) tskIDLE_PRIORITY );\r
1476 \r
1477                 /* Remove any TCB's from the delayed queue. */\r
1478                 while( !listLIST_IS_EMPTY( &xDelayedTaskList1 ) )\r
1479                 {\r
1480                         listGET_OWNER_OF_NEXT_ENTRY( pxTCB, &xDelayedTaskList1 );\r
1481                         vListRemove( ( xListItem * ) &( pxTCB->xGenericListItem ) );\r
1482 \r
1483                         prvDeleteTCB( ( tskTCB * ) pxTCB );\r
1484                 }\r
1485 \r
1486                 /* Remove any TCB's from the overflow delayed queue. */\r
1487                 while( !listLIST_IS_EMPTY( &xDelayedTaskList2 ) )\r
1488                 {\r
1489                         listGET_OWNER_OF_NEXT_ENTRY( pxTCB, &xDelayedTaskList2 );\r
1490                         vListRemove( ( xListItem * ) &( pxTCB->xGenericListItem ) );\r
1491 \r
1492                         prvDeleteTCB( ( tskTCB * ) pxTCB );\r
1493                 }\r
1494 \r
1495                 while( !listLIST_IS_EMPTY( &xSuspendedTaskList ) )\r
1496                 {\r
1497                         listGET_OWNER_OF_NEXT_ENTRY( pxTCB, &xSuspendedTaskList );\r
1498                         vListRemove( ( xListItem * ) &( pxTCB->xGenericListItem ) );\r
1499 \r
1500                         prvDeleteTCB( ( tskTCB * ) pxTCB );\r
1501                 }               \r
1502         }\r
1503 \r
1504 #endif\r
1505 /*-----------------------------------------------------------*/\r
1506 \r
1507 void vTaskSwitchContext( void )\r
1508 {\r
1509         if( uxSchedulerSuspended != ( unsigned portBASE_TYPE ) pdFALSE )\r
1510         {\r
1511                 /* The scheduler is currently suspended - do not allow a context\r
1512                 switch. */\r
1513                 xMissedYield = pdTRUE;\r
1514                 return;\r
1515         }\r
1516 \r
1517         /* Find the highest priority queue that contains ready tasks. */\r
1518         while( listLIST_IS_EMPTY( &( pxReadyTasksLists[ uxTopReadyPriority ] ) ) )\r
1519         {\r
1520                 --uxTopReadyPriority;\r
1521         }\r
1522 \r
1523         /* listGET_OWNER_OF_NEXT_ENTRY walks through the list, so the tasks of the\r
1524         same priority get an equal share of the processor time. */\r
1525         listGET_OWNER_OF_NEXT_ENTRY( pxCurrentTCB, &( pxReadyTasksLists[ uxTopReadyPriority ] ) );\r
1526 \r
1527         traceTASK_SWITCHED_IN();\r
1528         vWriteTraceToBuffer();\r
1529 }\r
1530 /*-----------------------------------------------------------*/\r
1531 \r
1532 void vTaskPlaceOnEventList( const xList * const pxEventList, portTickType xTicksToWait )\r
1533 {\r
1534 portTickType xTimeToWake;\r
1535 \r
1536         /* THIS FUNCTION MUST BE CALLED WITH INTERRUPTS DISABLED OR THE\r
1537         SCHEDULER SUSPENDED. */\r
1538 \r
1539         /* Place the event list item of the TCB in the appropriate event list.\r
1540         This is placed in the list in priority order so the highest priority task\r
1541         is the first to be woken by the event. */\r
1542         vListInsert( ( xList * ) pxEventList, ( xListItem * ) &( pxCurrentTCB->xEventListItem ) );\r
1543 \r
1544         /* We must remove ourselves from the ready list before adding ourselves\r
1545         to the blocked list as the same list item is used for both lists.  We have\r
1546         exclusive access to the ready lists as the scheduler is locked. */\r
1547         vListRemove( ( xListItem * ) &( pxCurrentTCB->xGenericListItem ) );\r
1548 \r
1549 \r
1550         #if ( INCLUDE_vTaskSuspend == 1 )\r
1551         {                        \r
1552                 if( xTicksToWait == portMAX_DELAY )\r
1553                 {\r
1554                         /* Add ourselves to the suspended task list instead of a delayed task\r
1555                         list to ensure we are not woken by a timing event.  We will block\r
1556                         indefinitely. */\r
1557                         vListInsertEnd( ( xList * ) &xSuspendedTaskList, ( xListItem * ) &( pxCurrentTCB->xGenericListItem ) );\r
1558                 }\r
1559                 else\r
1560                 {\r
1561                         /* Calculate the time at which the task should be woken if the event does\r
1562                         not occur.  This may overflow but this doesn't matter. */\r
1563                         xTimeToWake = xTickCount + xTicksToWait;\r
1564                 \r
1565                         listSET_LIST_ITEM_VALUE( &( pxCurrentTCB->xGenericListItem ), xTimeToWake );\r
1566                 \r
1567                         if( xTimeToWake < xTickCount )\r
1568                         {\r
1569                                 /* Wake time has overflowed.  Place this item in the overflow list. */\r
1570                                 vListInsert( ( xList * ) pxOverflowDelayedTaskList, ( xListItem * ) &( pxCurrentTCB->xGenericListItem ) );\r
1571                         }\r
1572                         else\r
1573                         {\r
1574                                 /* The wake time has not overflowed, so we can use the current block list. */\r
1575                                 vListInsert( ( xList * ) pxDelayedTaskList, ( xListItem * ) &( pxCurrentTCB->xGenericListItem ) );\r
1576                         }\r
1577                 }\r
1578         }\r
1579         #else\r
1580         {\r
1581                         /* Calculate the time at which the task should be woken if the event does\r
1582                         not occur.  This may overflow but this doesn't matter. */\r
1583                         xTimeToWake = xTickCount + xTicksToWait;\r
1584                 \r
1585                         listSET_LIST_ITEM_VALUE( &( pxCurrentTCB->xGenericListItem ), xTimeToWake );\r
1586                 \r
1587                         if( xTimeToWake < xTickCount )\r
1588                         {\r
1589                                 /* Wake time has overflowed.  Place this item in the overflow list. */\r
1590                                 vListInsert( ( xList * ) pxOverflowDelayedTaskList, ( xListItem * ) &( pxCurrentTCB->xGenericListItem ) );\r
1591                         }\r
1592                         else\r
1593                         {\r
1594                                 /* The wake time has not overflowed, so we can use the current block list. */\r
1595                                 vListInsert( ( xList * ) pxDelayedTaskList, ( xListItem * ) &( pxCurrentTCB->xGenericListItem ) );\r
1596                         }\r
1597         }\r
1598         #endif\r
1599 }\r
1600 /*-----------------------------------------------------------*/\r
1601 \r
1602 signed portBASE_TYPE xTaskRemoveFromEventList( const xList * const pxEventList )\r
1603 {\r
1604 tskTCB *pxUnblockedTCB;\r
1605 portBASE_TYPE xReturn;\r
1606 \r
1607         /* THIS FUNCTION MUST BE CALLED WITH INTERRUPTS DISABLED OR THE\r
1608         SCHEDULER SUSPENDED.  It can also be called from within an ISR. */\r
1609 \r
1610         /* The event list is sorted in priority order, so we can remove the\r
1611         first in the list, remove the TCB from the delayed list, and add\r
1612         it to the ready list.\r
1613         \r
1614         If an event is for a queue that is locked then this function will never\r
1615         get called - the lock count on the queue will get modified instead.  This\r
1616         means we can always expect exclusive access to the event list here. */\r
1617         pxUnblockedTCB = ( tskTCB * ) listGET_OWNER_OF_HEAD_ENTRY( pxEventList );\r
1618         vListRemove( &( pxUnblockedTCB->xEventListItem ) );\r
1619 \r
1620         if( uxSchedulerSuspended == ( unsigned portBASE_TYPE ) pdFALSE )\r
1621         {\r
1622                 vListRemove( &( pxUnblockedTCB->xGenericListItem ) );\r
1623                 prvAddTaskToReadyQueue( pxUnblockedTCB );\r
1624         }\r
1625         else\r
1626         {\r
1627                 /* We cannot access the delayed or ready lists, so will hold this\r
1628                 task pending until the scheduler is resumed. */\r
1629                 vListInsertEnd( ( xList * ) &( xPendingReadyList ), &( pxUnblockedTCB->xEventListItem ) );\r
1630         }\r
1631 \r
1632         if( pxUnblockedTCB->uxPriority >= pxCurrentTCB->uxPriority )\r
1633         {\r
1634                 /* Return true if the task removed from the event list has\r
1635                 a higher priority than the calling task.  This allows\r
1636                 the calling task to know if it should force a context\r
1637                 switch now. */\r
1638                 xReturn = pdTRUE;\r
1639         }\r
1640         else\r
1641         {\r
1642                 xReturn = pdFALSE;\r
1643         }\r
1644 \r
1645         return xReturn;\r
1646 }\r
1647 /*-----------------------------------------------------------*/\r
1648 \r
1649 void vTaskSetTimeOutState( xTimeOutType * const pxTimeOut )\r
1650 {\r
1651     pxTimeOut->xOverflowCount = xNumOfOverflows;\r
1652     pxTimeOut->xTimeOnEntering = xTickCount;\r
1653 }\r
1654 /*-----------------------------------------------------------*/\r
1655 \r
1656 portBASE_TYPE xTaskCheckForTimeOut( xTimeOutType * const pxTimeOut, portTickType * const pxTicksToWait )\r
1657 {\r
1658 portBASE_TYPE xReturn;\r
1659 \r
1660         #if ( INCLUDE_vTaskSuspend == 1 )\r
1661                 /* If INCLUDE_vTaskSuspend is set to 1 and the block time specified is\r
1662                 the maximum block time then the task should block indefinitely, and\r
1663                 therefore never time out. */\r
1664                 if( *pxTicksToWait == portMAX_DELAY )\r
1665                 {\r
1666                         xReturn = pdFALSE;\r
1667                 }\r
1668                 else /* We are not blocking indefinitely, perform the checks below. */\r
1669         #endif\r
1670 \r
1671     if( ( xNumOfOverflows != pxTimeOut->xOverflowCount ) && ( xTickCount >= pxTimeOut->xTimeOnEntering ) )\r
1672     {\r
1673         /* The tick count is greater than the time at which vTaskSetTimeout()\r
1674                 was called, but has also overflowed since vTaskSetTimeOut() was called.\r
1675         It must have wrapped all the way around and gone past us again. This\r
1676         passed since vTaskSetTimeout() was called. */\r
1677         xReturn = pdTRUE;\r
1678     }\r
1679     else if( ( xTickCount - pxTimeOut->xTimeOnEntering ) < *pxTicksToWait )\r
1680     {\r
1681         /* Not a genuine timeout. Adjust parameters for time remaining. */\r
1682         *pxTicksToWait -= ( xTickCount - pxTimeOut->xTimeOnEntering );\r
1683         vTaskSetTimeOutState( pxTimeOut );\r
1684         xReturn = pdFALSE;\r
1685     }\r
1686     else\r
1687     {\r
1688         xReturn = pdTRUE;\r
1689     }\r
1690 \r
1691     return xReturn;\r
1692 }\r
1693 /*-----------------------------------------------------------*/\r
1694 \r
1695 void vTaskMissedYield( void )\r
1696 {\r
1697         xMissedYield = pdTRUE;\r
1698 }\r
1699 \r
1700 /*\r
1701  * -----------------------------------------------------------\r
1702  * The Idle task.\r
1703  * ----------------------------------------------------------\r
1704  *\r
1705  * The portTASK_FUNCTION() macro is used to allow port/compiler specific\r
1706  * language extensions.  The equivalent prototype for this function is:\r
1707  *\r
1708  * void prvIdleTask( void *pvParameters );\r
1709  *\r
1710  */\r
1711 static portTASK_FUNCTION( prvIdleTask, pvParameters )\r
1712 {\r
1713         /* Stop warnings. */\r
1714         ( void ) pvParameters;\r
1715 \r
1716         for( ;; )\r
1717         {\r
1718                 /* See if any tasks have been deleted. */\r
1719                 prvCheckTasksWaitingTermination();\r
1720 \r
1721                 #if ( configUSE_PREEMPTION == 0 )\r
1722                 {\r
1723                         /* If we are not using preemption we keep forcing a task switch to\r
1724                         see if any other task has become available.  If we are using\r
1725                         preemption we don't need to do this as any task becoming available\r
1726                         will automatically get the processor anyway. */\r
1727                         taskYIELD();    \r
1728                 }\r
1729                 #endif\r
1730 \r
1731                 #if ( ( configUSE_PREEMPTION == 1 ) && ( configIDLE_SHOULD_YIELD == 1 ) )\r
1732                 {\r
1733                         /* When using preemption tasks of equal priority will be\r
1734                         timesliced.  If a task that is sharing the idle priority is ready\r
1735                         to run then the idle task should yield before the end of the\r
1736                         timeslice.\r
1737                         \r
1738                         A critical region is not required here as we are just reading from\r
1739                         the list, and an occasional incorrect value will not matter.  If\r
1740                         the ready list at the idle priority contains more than one task\r
1741                         then a task other than the idle task is ready to execute. */\r
1742                         if( listCURRENT_LIST_LENGTH( &( pxReadyTasksLists[ tskIDLE_PRIORITY ] ) ) > ( unsigned portBASE_TYPE ) 1 )\r
1743                         {\r
1744                                 taskYIELD();\r
1745                         }\r
1746                 }\r
1747                 #endif\r
1748 \r
1749                 #if ( configUSE_IDLE_HOOK == 1 )\r
1750                 {\r
1751                         extern void vApplicationIdleHook( void );\r
1752 \r
1753                         /* Call the user defined function from within the idle task.  This\r
1754                         allows the application designer to add background functionality\r
1755                         without the overhead of a separate task.\r
1756                         NOTE: vApplicationIdleHook() MUST NOT, UNDER ANY CIRCUMSTANCES,\r
1757                         CALL A FUNCTION THAT MIGHT BLOCK. */\r
1758                         vApplicationIdleHook();\r
1759                 }\r
1760                 #endif\r
1761         }\r
1762 } /*lint !e715 pvParameters is not accessed but all task functions require the same prototype. */\r
1763 \r
1764 \r
1765 \r
1766 \r
1767 \r
1768 \r
1769 \r
1770 /*-----------------------------------------------------------\r
1771  * File private functions documented at the top of the file.\r
1772  *----------------------------------------------------------*/\r
1773 \r
1774 \r
1775 \r
1776 static void prvInitialiseTCBVariables( tskTCB *pxTCB, const signed portCHAR * const pcName, unsigned portBASE_TYPE uxPriority )\r
1777 {\r
1778         /* Store the function name in the TCB. */\r
1779         strncpy( ( char * ) pxTCB->pcTaskName, ( const char * ) pcName, ( unsigned portSHORT ) configMAX_TASK_NAME_LEN );\r
1780         pxTCB->pcTaskName[ ( unsigned portSHORT ) configMAX_TASK_NAME_LEN - ( unsigned portSHORT ) 1 ] = '\0';\r
1781 \r
1782         #if ( portCRITICAL_NESTING_IN_TCB == 1 )\r
1783         {\r
1784                 pxTCB->uxCriticalNesting = ( unsigned portBASE_TYPE ) 0;\r
1785         }\r
1786         #endif\r
1787 \r
1788         /* This is used as an array index so must ensure it's not too large. */\r
1789         if( uxPriority >= configMAX_PRIORITIES )\r
1790         {\r
1791                 uxPriority = configMAX_PRIORITIES - 1;\r
1792         }\r
1793 \r
1794         pxTCB->uxPriority = uxPriority;\r
1795         #if ( configUSE_MUTEXES == 1 )\r
1796         {\r
1797                 pxTCB->uxBasePriority = uxPriority;\r
1798         }\r
1799         #endif\r
1800 \r
1801         vListInitialiseItem( &( pxTCB->xGenericListItem ) );\r
1802         vListInitialiseItem( &( pxTCB->xEventListItem ) );\r
1803 \r
1804         /* Set the pxTCB as a link back from the xListItem.  This is so we can get\r
1805         back to the containing TCB from a generic item in a list. */\r
1806         listSET_LIST_ITEM_OWNER( &( pxTCB->xGenericListItem ), pxTCB );\r
1807 \r
1808         /* Event lists are always in priority order. */\r
1809         listSET_LIST_ITEM_VALUE( &( pxTCB->xEventListItem ), configMAX_PRIORITIES - ( portTickType ) uxPriority );\r
1810         listSET_LIST_ITEM_OWNER( &( pxTCB->xEventListItem ), pxTCB );\r
1811 }\r
1812 /*-----------------------------------------------------------*/\r
1813 \r
1814 static void prvInitialiseTaskLists( void )\r
1815 {\r
1816 unsigned portBASE_TYPE uxPriority;\r
1817 \r
1818         for( uxPriority = 0; uxPriority < configMAX_PRIORITIES; uxPriority++ )\r
1819         {\r
1820                 vListInitialise( ( xList * ) &( pxReadyTasksLists[ uxPriority ] ) );\r
1821         }\r
1822 \r
1823         vListInitialise( ( xList * ) &xDelayedTaskList1 );\r
1824         vListInitialise( ( xList * ) &xDelayedTaskList2 );\r
1825         vListInitialise( ( xList * ) &xPendingReadyList );\r
1826 \r
1827         #if ( INCLUDE_vTaskDelete == 1 )\r
1828         {\r
1829                 vListInitialise( ( xList * ) &xTasksWaitingTermination );\r
1830         }\r
1831         #endif\r
1832 \r
1833         #if ( INCLUDE_vTaskSuspend == 1 )\r
1834         {\r
1835                 vListInitialise( ( xList * ) &xSuspendedTaskList );\r
1836         }\r
1837         #endif\r
1838 \r
1839         /* Start with pxDelayedTaskList using list1 and the pxOverflowDelayedTaskList\r
1840         using list2. */\r
1841         pxDelayedTaskList = &xDelayedTaskList1;\r
1842         pxOverflowDelayedTaskList = &xDelayedTaskList2;\r
1843 }\r
1844 /*-----------------------------------------------------------*/\r
1845 \r
1846 static void prvCheckTasksWaitingTermination( void )\r
1847 {                                                       \r
1848         #if ( INCLUDE_vTaskDelete == 1 )\r
1849         {                               \r
1850                 portBASE_TYPE xListIsEmpty;\r
1851 \r
1852                 /* ucTasksDeleted is used to prevent vTaskSuspendAll() being called\r
1853                 too often in the idle task. */\r
1854                 if( uxTasksDeleted > ( unsigned portBASE_TYPE ) 0 )\r
1855                 {\r
1856                         vTaskSuspendAll();\r
1857                                 xListIsEmpty = listLIST_IS_EMPTY( &xTasksWaitingTermination );                          \r
1858                         xTaskResumeAll();\r
1859 \r
1860                         if( !xListIsEmpty )\r
1861                         {\r
1862                                 tskTCB *pxTCB;\r
1863 \r
1864                                 portENTER_CRITICAL();\r
1865                                 {                       \r
1866                                         pxTCB = ( tskTCB * ) listGET_OWNER_OF_HEAD_ENTRY( ( ( xList * ) &xTasksWaitingTermination ) );\r
1867                                         vListRemove( &( pxTCB->xGenericListItem ) );\r
1868                                         --uxCurrentNumberOfTasks;\r
1869                                         --uxTasksDeleted;\r
1870                                 }\r
1871                                 portEXIT_CRITICAL();\r
1872 \r
1873                                 prvDeleteTCB( pxTCB );\r
1874                         }\r
1875                 }\r
1876         }\r
1877         #endif\r
1878 }\r
1879 /*-----------------------------------------------------------*/\r
1880 \r
1881 static tskTCB *prvAllocateTCBAndStack( unsigned portSHORT usStackDepth )\r
1882 {\r
1883 tskTCB *pxNewTCB;\r
1884 \r
1885         /* Allocate space for the TCB.  Where the memory comes from depends on\r
1886         the implementation of the port malloc function. */\r
1887         pxNewTCB = ( tskTCB * ) pvPortMalloc( sizeof( tskTCB ) );\r
1888 \r
1889         if( pxNewTCB != NULL )\r
1890         {\r
1891                 /* Allocate space for the stack used by the task being created.\r
1892                 The base of the stack memory stored in the TCB so the task can\r
1893                 be deleted later if required. */\r
1894                 pxNewTCB->pxStack = ( portSTACK_TYPE * ) pvPortMalloc( ( ( size_t )usStackDepth ) * sizeof( portSTACK_TYPE ) );\r
1895 \r
1896                 if( pxNewTCB->pxStack == NULL )\r
1897                 {\r
1898                         /* Could not allocate the stack.  Delete the allocated TCB. */\r
1899                         vPortFree( pxNewTCB );                  \r
1900                         pxNewTCB = NULL;                        \r
1901                 }               \r
1902                 else\r
1903                 {\r
1904                         /* Just to help debugging. */\r
1905                         memset( pxNewTCB->pxStack, tskSTACK_FILL_BYTE, usStackDepth * sizeof( portSTACK_TYPE ) );\r
1906                 }\r
1907         }\r
1908 \r
1909         return pxNewTCB;\r
1910 }\r
1911 /*-----------------------------------------------------------*/\r
1912 \r
1913 #if ( configUSE_TRACE_FACILITY == 1 )\r
1914 \r
1915         static void prvListTaskWithinSingleList( const signed portCHAR *pcWriteBuffer, xList *pxList, signed portCHAR cStatus )\r
1916         {\r
1917         volatile tskTCB *pxNextTCB, *pxFirstTCB;\r
1918         static portCHAR pcStatusString[ 50 ];\r
1919         unsigned portSHORT usStackRemaining;\r
1920 \r
1921                 /* Write the details of all the TCB's in pxList into the buffer. */\r
1922                 listGET_OWNER_OF_NEXT_ENTRY( pxFirstTCB, pxList );\r
1923                 do\r
1924                 {\r
1925                         listGET_OWNER_OF_NEXT_ENTRY( pxNextTCB, pxList );\r
1926                         usStackRemaining = usTaskCheckFreeStackSpace( ( unsigned portCHAR * ) pxNextTCB->pxStack );\r
1927                         sprintf( pcStatusString, ( portCHAR * ) "%s\t\t%c\t%u\t%u\t%u\r\n", pxNextTCB->pcTaskName, cStatus, ( unsigned int ) pxNextTCB->uxPriority, usStackRemaining, ( unsigned int ) pxNextTCB->uxTCBNumber );\r
1928                         strcat( ( portCHAR * ) pcWriteBuffer, ( portCHAR * ) pcStatusString );\r
1929 \r
1930                 } while( pxNextTCB != pxFirstTCB );\r
1931         }\r
1932 \r
1933 #endif\r
1934 /*-----------------------------------------------------------*/\r
1935 \r
1936 #if ( ( configUSE_TRACE_FACILITY == 1 ) || ( INCLUDE_uxGetStackHighWaterMark == 1 ) )\r
1937         unsigned portSHORT usTaskCheckFreeStackSpace( const unsigned portCHAR * pucStackByte )\r
1938         {\r
1939         register unsigned portSHORT usCount = 0;\r
1940 \r
1941                 while( *pucStackByte == tskSTACK_FILL_BYTE )\r
1942                 {\r
1943                         pucStackByte -= portSTACK_GROWTH;\r
1944                         usCount++;\r
1945                 }\r
1946 \r
1947                 usCount /= sizeof( portSTACK_TYPE );\r
1948 \r
1949                 return usCount;\r
1950         }\r
1951 #endif\r
1952 /*-----------------------------------------------------------*/\r
1953 \r
1954 #if ( INCLUDE_uxGetStackHighWaterMark == 1 )\r
1955         unsigned portBASE_TYPE uxGetStackHighWaterMark( void )\r
1956         {\r
1957                 return usTaskCheckFreeStackSpace( pxCurrentTCB->pxStack );\r
1958         }\r
1959 #endif\r
1960 /*-----------------------------------------------------------*/\r
1961 \r
1962 #if ( ( INCLUDE_vTaskDelete == 1 ) || ( INCLUDE_vTaskCleanUpResources == 1 ) )\r
1963 \r
1964         static void prvDeleteTCB( tskTCB *pxTCB )\r
1965         {\r
1966                 /* Free up the memory allocated by the scheduler for the task.  It is up to\r
1967                 the task to free any memory allocated at the application level. */\r
1968                 vPortFree( pxTCB->pxStack );\r
1969                 vPortFree( pxTCB );\r
1970         }\r
1971 \r
1972 #endif\r
1973 \r
1974 \r
1975 /*-----------------------------------------------------------*/\r
1976 \r
1977 #if ( INCLUDE_xTaskGetCurrentTaskHandle == 1 )\r
1978 \r
1979         xTaskHandle xTaskGetCurrentTaskHandle( void )\r
1980         {\r
1981         xTaskHandle xReturn;\r
1982 \r
1983                 portENTER_CRITICAL();\r
1984                 {\r
1985                         xReturn = ( xTaskHandle ) pxCurrentTCB;\r
1986                 }\r
1987                 portEXIT_CRITICAL();\r
1988 \r
1989                 return xReturn;\r
1990         }\r
1991 \r
1992 #endif\r
1993 \r
1994 /*-----------------------------------------------------------*/\r
1995 \r
1996 #if ( INCLUDE_xTaskGetSchedulerState == 1 )\r
1997 \r
1998         portBASE_TYPE xTaskGetSchedulerState( void )\r
1999         {\r
2000         portBASE_TYPE xReturn;\r
2001         \r
2002                 if( xSchedulerRunning == pdFALSE )\r
2003                 {\r
2004                         xReturn = taskSCHEDULER_NOT_STARTED;\r
2005                 }\r
2006                 else\r
2007                 {\r
2008                         if( uxSchedulerSuspended == ( unsigned portBASE_TYPE ) pdFALSE )\r
2009                         {\r
2010                                 xReturn = taskSCHEDULER_RUNNING;\r
2011                         }\r
2012                         else\r
2013                         {\r
2014                                 xReturn = taskSCHEDULER_SUSPENDED;\r
2015                         }\r
2016                 }\r
2017                 \r
2018                 return xReturn;\r
2019         }\r
2020 \r
2021 #endif\r
2022 /*-----------------------------------------------------------*/\r
2023 \r
2024 #if ( configUSE_MUTEXES == 1 )\r
2025         \r
2026         void vTaskPriorityInherit( xTaskHandle * const pxMutexHolder )\r
2027         {\r
2028         tskTCB * const pxTCB = ( tskTCB * ) pxMutexHolder;\r
2029 \r
2030                 if( pxTCB->uxPriority < pxCurrentTCB->uxPriority )\r
2031                 {\r
2032                         /* Adjust the mutex holder state to account for its new priority. */\r
2033                         listSET_LIST_ITEM_VALUE( &( pxTCB->xEventListItem ), configMAX_PRIORITIES - ( portTickType ) pxCurrentTCB->uxPriority );\r
2034 \r
2035                         /* If the task being modified is in the ready state it will need to\r
2036                         be moved in to a new list. */\r
2037                         if( listIS_CONTAINED_WITHIN( &( pxReadyTasksLists[ pxTCB->uxPriority ] ), &( pxTCB->xGenericListItem ) ) )\r
2038                         {\r
2039                                 vListRemove( &( pxTCB->xGenericListItem ) );\r
2040 \r
2041                                 /* Inherit the priority before being moved into the new list. */\r
2042                                 pxTCB->uxPriority = pxCurrentTCB->uxPriority;\r
2043                                 prvAddTaskToReadyQueue( pxTCB );\r
2044                         }\r
2045                         else\r
2046                         {\r
2047                                 /* Just inherit the priority. */\r
2048                                 pxTCB->uxPriority = pxCurrentTCB->uxPriority;\r
2049                         }\r
2050                 }\r
2051         }\r
2052 \r
2053 #endif\r
2054 /*-----------------------------------------------------------*/\r
2055 \r
2056 #if ( configUSE_MUTEXES == 1 )  \r
2057 \r
2058         void vTaskPriorityDisinherit( xTaskHandle * const pxMutexHolder )\r
2059         {\r
2060         tskTCB * const pxTCB = ( tskTCB * ) pxMutexHolder;\r
2061 \r
2062                 if( pxMutexHolder != NULL )\r
2063                 {\r
2064                         if( pxTCB->uxPriority != pxTCB->uxBasePriority )\r
2065                         {\r
2066                                 /* We must be the running task to be able to give the mutex back.\r
2067                                 Remove ourselves from the ready list we currently appear in. */\r
2068                                 vListRemove( &( pxTCB->xGenericListItem ) );\r
2069 \r
2070                                 /* Disinherit the priority before adding ourselves into the new\r
2071                                 ready list. */\r
2072                                 pxTCB->uxPriority = pxTCB->uxBasePriority;\r
2073                                 listSET_LIST_ITEM_VALUE( &( pxTCB->xEventListItem ), configMAX_PRIORITIES - ( portTickType ) pxTCB->uxPriority );\r
2074                                 prvAddTaskToReadyQueue( pxTCB );\r
2075                         }\r
2076                 }\r
2077         }\r
2078 \r
2079 #endif\r
2080 /*-----------------------------------------------------------*/\r
2081 \r
2082 #if ( portCRITICAL_NESTING_IN_TCB == 1 )\r
2083 \r
2084         void vTaskEnterCritical( void )\r
2085         {\r
2086                 portDISABLE_INTERRUPTS();\r
2087 \r
2088                 if( xSchedulerRunning != pdFALSE )\r
2089                 {\r
2090                         pxCurrentTCB->uxCriticalNesting++;\r
2091                 }\r
2092         }\r
2093 \r
2094 #endif\r
2095 /*-----------------------------------------------------------*/\r
2096 \r
2097 #if ( portCRITICAL_NESTING_IN_TCB == 1 )\r
2098 \r
2099 void vTaskExitCritical( void )\r
2100 {\r
2101         if( xSchedulerRunning != pdFALSE )\r
2102         {\r
2103                 if( pxCurrentTCB->uxCriticalNesting > 0 )\r
2104                 {\r
2105                         pxCurrentTCB->uxCriticalNesting--;\r
2106 \r
2107                         if( pxCurrentTCB->uxCriticalNesting == 0 )\r
2108                         {\r
2109                                 portENABLE_INTERRUPTS();\r
2110                         }\r
2111                 }\r
2112         }\r
2113 }\r
2114 \r
2115 #endif\r
2116 /*-----------------------------------------------------------*/\r
2117 \r
2118 \r
2119         \r
2120 \r