]> git.sur5r.net Git - freertos/blob - Source/tasks.c
1c1013a1c0503978710a3051d192e123424e82bf
[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 )\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                 }\r
624                 portEXIT_CRITICAL();\r
625         }\r
626         else\r
627         {\r
628                 xReturn = errCOULD_NOT_ALLOCATE_REQUIRED_MEMORY;\r
629         }\r
630 \r
631         if( xReturn == pdPASS )\r
632         {\r
633                 if( ( void * ) pxCreatedTask != NULL )\r
634                 {\r
635                         /* Pass the TCB out - in an anonymous way.  The calling function/\r
636                         task can use this as a handle to delete the task later if\r
637                         required.*/\r
638                         *pxCreatedTask = ( xTaskHandle ) pxNewTCB;\r
639                 }\r
640 \r
641                 if( xSchedulerRunning != pdFALSE )\r
642                 {\r
643                         /* If the created task is of a higher priority than the current task\r
644                         then it should run now. */\r
645                         if( pxCurrentTCB->uxPriority < uxPriority )\r
646                         {\r
647                                 taskYIELD();\r
648                         }\r
649                 }\r
650         }\r
651 \r
652         return xReturn;\r
653 }\r
654 /*-----------------------------------------------------------*/\r
655 \r
656 #if ( INCLUDE_vTaskDelete == 1 )\r
657 \r
658         void vTaskDelete( xTaskHandle pxTaskToDelete )\r
659         {\r
660         tskTCB *pxTCB;\r
661 \r
662                 taskENTER_CRITICAL();\r
663                 {\r
664                         /* Ensure a yield is performed if the current task is being \r
665                         deleted. */\r
666                         if( pxTaskToDelete == pxCurrentTCB )\r
667                         {\r
668                                 pxTaskToDelete = NULL;\r
669                         }\r
670 \r
671                         /* If null is passed in here then we are deleting ourselves. */\r
672                         pxTCB = prvGetTCBFromHandle( pxTaskToDelete );\r
673 \r
674                         /* Remove task from the ready list and place in the     termination list.\r
675                         This will stop the task from be scheduled.  The idle task will check\r
676                         the termination list and free up any memory allocated by the\r
677                         scheduler for the TCB and stack. */\r
678                         vListRemove( &( pxTCB->xGenericListItem ) );\r
679 \r
680                         /* Is the task waiting on an event also? */                                                                                             \r
681                         if( pxTCB->xEventListItem.pvContainer )\r
682                         {\r
683                                 vListRemove( &( pxTCB->xEventListItem ) );\r
684                         }\r
685 \r
686                         vListInsertEnd( ( xList * ) &xTasksWaitingTermination, &( pxTCB->xGenericListItem ) );\r
687 \r
688                         /* Increment the ucTasksDeleted variable so the idle task knows\r
689                         there is a task that has been deleted and that it should therefore\r
690                         check the xTasksWaitingTermination list. */\r
691                         ++uxTasksDeleted;\r
692                 }\r
693                 taskEXIT_CRITICAL();\r
694 \r
695                 /* Force a reschedule if we have just deleted the current task. */\r
696                 if( xSchedulerRunning != pdFALSE ) \r
697                 {\r
698                         if( ( void * ) pxTaskToDelete == NULL )\r
699                         {\r
700                                 taskYIELD();\r
701                         }\r
702                 }\r
703         }\r
704 \r
705 #endif\r
706 \r
707 \r
708 \r
709 \r
710 \r
711 \r
712 /*-----------------------------------------------------------\r
713  * TASK CONTROL API documented in task.h\r
714  *----------------------------------------------------------*/\r
715 \r
716 #if ( INCLUDE_vTaskDelayUntil == 1 )\r
717 \r
718         void vTaskDelayUntil( portTickType * const pxPreviousWakeTime, portTickType xTimeIncrement )\r
719         {\r
720         portTickType xTimeToWake;\r
721         portBASE_TYPE xAlreadyYielded, xShouldDelay = pdFALSE;\r
722 \r
723                 vTaskSuspendAll();\r
724                 {\r
725                         /* Generate the tick time at which the task wants to wake. */\r
726                         xTimeToWake = *pxPreviousWakeTime + xTimeIncrement;\r
727 \r
728                         if( xTickCount < *pxPreviousWakeTime )\r
729                         {\r
730                                 /* The tick count has overflowed since this function was\r
731                                 lasted called.  In this case the only time we should ever\r
732                                 actually delay is if the wake time has also     overflowed,\r
733                                 and the wake time is greater than the tick time.  When this\r
734                                 is the case it is as if neither time had overflowed. */\r
735                                 if( ( xTimeToWake < *pxPreviousWakeTime ) && ( xTimeToWake > xTickCount ) )\r
736                                 {\r
737                                         xShouldDelay = pdTRUE;\r
738                                 }\r
739                         }\r
740                         else\r
741                         {\r
742                                 /* The tick time has not overflowed.  In this case we will\r
743                                 delay if either the wake time has overflowed, and/or the\r
744                                 tick time is less than the wake time. */\r
745                                 if( ( xTimeToWake < *pxPreviousWakeTime ) || ( xTimeToWake > xTickCount ) )\r
746                                 {\r
747                                         xShouldDelay = pdTRUE;\r
748                                 }\r
749                         }\r
750 \r
751                         /* Update the wake time ready for the next call. */\r
752                         *pxPreviousWakeTime = xTimeToWake;\r
753 \r
754                         if( xShouldDelay )\r
755                         {\r
756                                 /* We must remove ourselves from the ready list before adding\r
757                                 ourselves to the blocked list as the same list item is used for\r
758                                 both lists. */\r
759                                 vListRemove( ( xListItem * ) &( pxCurrentTCB->xGenericListItem ) );\r
760 \r
761                                 /* The list item will be inserted in wake time order. */\r
762                                 listSET_LIST_ITEM_VALUE( &( pxCurrentTCB->xGenericListItem ), xTimeToWake );\r
763 \r
764                                 if( xTimeToWake < xTickCount )\r
765                                 {\r
766                                         /* Wake time has overflowed.  Place this item in the\r
767                                         overflow list. */\r
768                                         vListInsert( ( xList * ) pxOverflowDelayedTaskList, ( xListItem * ) &( pxCurrentTCB->xGenericListItem ) );\r
769                                 }\r
770                                 else\r
771                                 {\r
772                                         /* The wake time has not overflowed, so we can use the\r
773                                         current block list. */\r
774                                         vListInsert( ( xList * ) pxDelayedTaskList, ( xListItem * ) &( pxCurrentTCB->xGenericListItem ) );\r
775                                 }\r
776                         }\r
777                 }\r
778                 xAlreadyYielded = xTaskResumeAll();\r
779 \r
780                 /* Force a reschedule if xTaskResumeAll has not already done so, we may\r
781                 have put ourselves to sleep. */\r
782                 if( !xAlreadyYielded )\r
783                 {\r
784                         taskYIELD();\r
785                 }\r
786         }       \r
787         \r
788 #endif\r
789 /*-----------------------------------------------------------*/\r
790 \r
791 #if ( INCLUDE_vTaskDelay == 1 )\r
792 \r
793         void vTaskDelay( portTickType xTicksToDelay )\r
794         {\r
795         portTickType xTimeToWake;\r
796         signed portBASE_TYPE xAlreadyYielded = pdFALSE;\r
797 \r
798                 /* A delay time of zero just forces a reschedule. */\r
799                 if( xTicksToDelay > ( portTickType ) 0 )\r
800                 {\r
801                         vTaskSuspendAll();\r
802                         {\r
803                                 /* A task that is removed from the event list while the\r
804                                 scheduler is suspended will not get placed in the ready\r
805                                 list or removed from the blocked list until the scheduler\r
806                                 is resumed.\r
807                                 \r
808                                 This task cannot be in an event list as it is the currently\r
809                                 executing task. */\r
810 \r
811                                 /* Calculate the time to wake - this may overflow but this is\r
812                                 not a problem. */\r
813                                 xTimeToWake = xTickCount + xTicksToDelay;\r
814 \r
815                                 /* We must remove ourselves from the ready list before adding\r
816                                 ourselves to the blocked list as the same list item is used for\r
817                                 both lists. */\r
818                                 vListRemove( ( xListItem * ) &( pxCurrentTCB->xGenericListItem ) );\r
819 \r
820                                 /* The list item will be inserted in wake time order. */\r
821                                 listSET_LIST_ITEM_VALUE( &( pxCurrentTCB->xGenericListItem ), xTimeToWake );\r
822 \r
823                                 if( xTimeToWake < xTickCount )\r
824                                 {\r
825                                         /* Wake time has overflowed.  Place this item in the\r
826                                         overflow list. */\r
827                                         vListInsert( ( xList * ) pxOverflowDelayedTaskList, ( xListItem * ) &( pxCurrentTCB->xGenericListItem ) );\r
828                                 }\r
829                                 else\r
830                                 {\r
831                                         /* The wake time has not overflowed, so we can use the\r
832                                         current block list. */\r
833                                         vListInsert( ( xList * ) pxDelayedTaskList, ( xListItem * ) &( pxCurrentTCB->xGenericListItem ) );\r
834                                 }\r
835                         }\r
836                         xAlreadyYielded = xTaskResumeAll();\r
837                 }\r
838                 \r
839                 /* Force a reschedule if xTaskResumeAll has not already done so, we may\r
840                 have put ourselves to sleep. */\r
841                 if( !xAlreadyYielded )\r
842                 {\r
843                         taskYIELD();\r
844                 }\r
845         }\r
846         \r
847 #endif\r
848 /*-----------------------------------------------------------*/\r
849 \r
850 #if ( INCLUDE_uxTaskPriorityGet == 1 )\r
851 \r
852         unsigned portBASE_TYPE uxTaskPriorityGet( xTaskHandle pxTask )\r
853         {\r
854         tskTCB *pxTCB;\r
855         unsigned portBASE_TYPE uxReturn;\r
856 \r
857                 taskENTER_CRITICAL();\r
858                 {\r
859                         /* If null is passed in here then we are changing the\r
860                         priority of the calling function. */\r
861                         pxTCB = prvGetTCBFromHandle( pxTask );\r
862                         uxReturn = pxTCB->uxPriority;\r
863                 }\r
864                 taskEXIT_CRITICAL();\r
865 \r
866                 return uxReturn;\r
867         }\r
868 \r
869 #endif\r
870 /*-----------------------------------------------------------*/\r
871 \r
872 #if ( INCLUDE_vTaskPrioritySet == 1 )\r
873 \r
874         void vTaskPrioritySet( xTaskHandle pxTask, unsigned portBASE_TYPE uxNewPriority )\r
875         {\r
876         tskTCB *pxTCB;\r
877         unsigned portBASE_TYPE uxCurrentPriority, xYieldRequired = pdFALSE;\r
878 \r
879                 /* Ensure the new priority is valid. */\r
880                 if( uxNewPriority >= configMAX_PRIORITIES )\r
881                 {\r
882                         uxNewPriority = configMAX_PRIORITIES - 1;\r
883                 }\r
884 \r
885                 taskENTER_CRITICAL();\r
886                 {\r
887                         /* If null is passed in here then we are changing the\r
888                         priority of the calling function. */\r
889                         pxTCB = prvGetTCBFromHandle( pxTask );\r
890                         \r
891                         #if ( configUSE_MUTEXES == 1 )\r
892                         {\r
893                                 uxCurrentPriority = pxTCB->uxBasePriority;\r
894                         }\r
895                         #else\r
896                         {\r
897                                 uxCurrentPriority = pxTCB->uxPriority;\r
898                         }\r
899                         #endif\r
900 \r
901                         if( uxCurrentPriority != uxNewPriority )\r
902                         {\r
903                                 /* The priority change may have readied a task of higher\r
904                                 priority than the calling task. */\r
905                                 if( uxNewPriority > uxCurrentPriority ) \r
906                                 {\r
907                                         if( pxTask != NULL )\r
908                                         {\r
909                                                 /* The priority of another task is being raised.  If we\r
910                                                 were raising the priority of the currently running task\r
911                                                 there would be no need to switch as it must have already\r
912                                                 been the highest priority task. */\r
913                                                 xYieldRequired = pdTRUE;\r
914                                         }\r
915                                 }\r
916                                 else if( pxTask == NULL )\r
917                                 {\r
918                                         /* Setting our own priority down means there may now be another\r
919                                         task of higher priority that is ready to execute. */\r
920                                         xYieldRequired = pdTRUE;\r
921                                 }\r
922                         \r
923                                 \r
924 \r
925                                 #if ( configUSE_MUTEXES == 1 )\r
926                                 {\r
927                                         /* Only change the priority being used if the task is not\r
928                                         currently using an inherited priority. */\r
929                                         if( pxTCB->uxBasePriority == pxTCB->uxPriority )\r
930                                         {\r
931                                                 pxTCB->uxPriority = uxNewPriority;\r
932                                         }\r
933                                         \r
934                                         /* The base priority gets set whatever. */\r
935                                         pxTCB->uxBasePriority = uxNewPriority;                                  \r
936                                 }\r
937                                 #else\r
938                                 {\r
939                                         pxTCB->uxPriority = uxNewPriority;\r
940                                 }\r
941                                 #endif\r
942 \r
943                                 listSET_LIST_ITEM_VALUE( &( pxTCB->xEventListItem ), ( configMAX_PRIORITIES - ( portTickType ) uxNewPriority ) );\r
944 \r
945                                 /* If the task is in the blocked or suspended list we need do\r
946                                 nothing more than change it's priority variable. However, if\r
947                                 the task is in a ready list it needs to be removed and placed\r
948                                 in the queue appropriate to its new priority. */\r
949                                 if( listIS_CONTAINED_WITHIN( &( pxReadyTasksLists[ uxCurrentPriority ] ), &( pxTCB->xGenericListItem ) ) )\r
950                                 {\r
951                                         /* The task is currently in its ready list - remove before adding\r
952                                         it to it's new ready list.  As we are in a critical section we\r
953                                         can do this even if the scheduler is suspended. */\r
954                                         vListRemove( &( pxTCB->xGenericListItem ) );\r
955                                         prvAddTaskToReadyQueue( pxTCB );\r
956                                 }                       \r
957                                 \r
958                                 if( xYieldRequired == pdTRUE )\r
959                                 {\r
960                                         taskYIELD();\r
961                                 }                               \r
962                         }\r
963                 }\r
964                 taskEXIT_CRITICAL();\r
965         }\r
966 \r
967 #endif\r
968 /*-----------------------------------------------------------*/\r
969 \r
970 #if ( INCLUDE_vTaskSuspend == 1 )\r
971 \r
972         void vTaskSuspend( xTaskHandle pxTaskToSuspend )\r
973         {\r
974         tskTCB *pxTCB;\r
975 \r
976                 taskENTER_CRITICAL();\r
977                 {\r
978                         /* Ensure a yield is performed if the current task is being \r
979                         suspended. */\r
980                         if( pxTaskToSuspend == pxCurrentTCB )\r
981                         {\r
982                                 pxTaskToSuspend = NULL;\r
983                         }\r
984 \r
985                         /* If null is passed in here then we are suspending ourselves. */\r
986                         pxTCB = prvGetTCBFromHandle( pxTaskToSuspend );\r
987 \r
988                         /* Remove task from the ready/delayed list and place in the     suspended list. */\r
989                         vListRemove( &( pxTCB->xGenericListItem ) );\r
990 \r
991                         /* Is the task waiting on an event also? */                                                                                             \r
992                         if( pxTCB->xEventListItem.pvContainer )\r
993                         {\r
994                                 vListRemove( &( pxTCB->xEventListItem ) );\r
995                         }\r
996 \r
997                         vListInsertEnd( ( xList * ) &xSuspendedTaskList, &( pxTCB->xGenericListItem ) );\r
998                 }\r
999                 taskEXIT_CRITICAL();\r
1000 \r
1001                 /* We may have just suspended the current task. */\r
1002                 if( ( void * ) pxTaskToSuspend == NULL )\r
1003                 {\r
1004                         taskYIELD();\r
1005                 }\r
1006         }\r
1007 \r
1008 #endif\r
1009 /*-----------------------------------------------------------*/\r
1010 \r
1011 #if ( INCLUDE_vTaskSuspend == 1 )\r
1012 \r
1013         static portBASE_TYPE prvIsTaskSuspended( const tskTCB * const pxTCB )\r
1014         {\r
1015         portBASE_TYPE xReturn = pdFALSE;\r
1016 \r
1017                 /* Is the task we are attempting to resume actually in the\r
1018                 suspended list? */\r
1019                 if( listIS_CONTAINED_WITHIN( &xSuspendedTaskList, &( pxTCB->xGenericListItem ) ) != pdFALSE )\r
1020                 {\r
1021                         /* Has the task already been resumed from within an ISR? */\r
1022                         if( listIS_CONTAINED_WITHIN( &xPendingReadyList, &( pxTCB->xEventListItem ) ) != pdTRUE )\r
1023                         {                       \r
1024                                 /* Is it in the suspended list because it is in the\r
1025                                 Suspended state?  It is possible to be in the suspended\r
1026                                 list because it is blocked on a task with no timeout\r
1027                                 specified. */\r
1028                                 if( listIS_CONTAINED_WITHIN( NULL, &( pxTCB->xEventListItem ) ) == pdTRUE )\r
1029                                 {\r
1030                                         xReturn = pdTRUE;\r
1031                                 }\r
1032                         }\r
1033                 }\r
1034 \r
1035                 return xReturn;\r
1036         }\r
1037 \r
1038 #endif\r
1039 /*-----------------------------------------------------------*/\r
1040 \r
1041 #if ( INCLUDE_vTaskSuspend == 1 )\r
1042 \r
1043         void vTaskResume( xTaskHandle pxTaskToResume )\r
1044         {\r
1045         tskTCB *pxTCB;\r
1046 \r
1047                 /* Remove the task from whichever list it is currently in, and place\r
1048                 it in the ready list. */\r
1049                 pxTCB = ( tskTCB * ) pxTaskToResume;\r
1050 \r
1051                 /* The parameter cannot be NULL as it is impossible to resume the\r
1052                 currently executing task. */\r
1053                 if( pxTCB != NULL )\r
1054                 {\r
1055                         taskENTER_CRITICAL();\r
1056                         {\r
1057                                 if( prvIsTaskSuspended( pxTCB ) == pdTRUE )\r
1058                                 {\r
1059                                         /* As we are in a critical section we can access the ready\r
1060                                         lists even if the scheduler is suspended. */\r
1061                                         vListRemove(  &( pxTCB->xGenericListItem ) );\r
1062                                         prvAddTaskToReadyQueue( pxTCB );\r
1063 \r
1064                                         /* We may have just resumed a higher priority task. */\r
1065                                         if( pxTCB->uxPriority >= pxCurrentTCB->uxPriority )\r
1066                                         {\r
1067                                                 /* This yield may not cause the task just resumed to run, but\r
1068                                                 will leave the lists in the correct state for the next yield. */\r
1069                                                 taskYIELD();\r
1070                                         }\r
1071                                 }\r
1072                         }\r
1073                         taskEXIT_CRITICAL();\r
1074                 }\r
1075         }\r
1076 \r
1077 #endif\r
1078 \r
1079 /*-----------------------------------------------------------*/\r
1080 \r
1081 #if ( ( INCLUDE_xTaskResumeFromISR == 1 ) && ( INCLUDE_vTaskSuspend == 1 ) )\r
1082 \r
1083         portBASE_TYPE xTaskResumeFromISR( xTaskHandle pxTaskToResume )\r
1084         {\r
1085         portBASE_TYPE xYieldRequired = pdFALSE;\r
1086         tskTCB *pxTCB;\r
1087 \r
1088                 pxTCB = ( tskTCB * ) pxTaskToResume;\r
1089 \r
1090                 if( prvIsTaskSuspended( pxTCB ) == pdTRUE )\r
1091                 {\r
1092                         if( uxSchedulerSuspended == ( unsigned portBASE_TYPE ) pdFALSE )\r
1093                         {\r
1094                                 xYieldRequired = ( pxTCB->uxPriority >= pxCurrentTCB->uxPriority );\r
1095                                 vListRemove(  &( pxTCB->xGenericListItem ) );   \r
1096                                 prvAddTaskToReadyQueue( pxTCB );\r
1097                         }\r
1098                         else\r
1099                         {\r
1100                                 /* We cannot access the delayed or ready lists, so will hold this\r
1101                                 task pending until the scheduler is resumed, at which point a\r
1102                                 yield will be performed if necessary. */\r
1103                                 vListInsertEnd( ( xList * ) &( xPendingReadyList ), &( pxTCB->xEventListItem ) );\r
1104                         }\r
1105                 }\r
1106 \r
1107                 return xYieldRequired;\r
1108         }\r
1109 \r
1110 #endif\r
1111 \r
1112 \r
1113 \r
1114 \r
1115 /*-----------------------------------------------------------\r
1116  * PUBLIC SCHEDULER CONTROL documented in task.h\r
1117  *----------------------------------------------------------*/\r
1118 \r
1119 \r
1120 void vTaskStartScheduler( void )\r
1121 {\r
1122 portBASE_TYPE xReturn;\r
1123 \r
1124         /* Add the idle task at the lowest priority. */\r
1125         xReturn = xTaskCreate( prvIdleTask, ( signed portCHAR * ) "IDLE", tskIDLE_STACK_SIZE, ( void * ) NULL, tskIDLE_PRIORITY, ( xTaskHandle * ) NULL );\r
1126 \r
1127         if( xReturn == pdPASS )\r
1128         {\r
1129                 /* Interrupts are turned off here, to ensure a tick does not occur\r
1130                 before or during the call to xPortStartScheduler().  The stacks of\r
1131                 the created tasks contain a status word with interrupts switched on\r
1132                 so interrupts will automatically get re-enabled when the first task\r
1133                 starts to run.\r
1134                 \r
1135                 STEPPING THROUGH HERE USING A DEBUGGER CAN CAUSE BIG PROBLEMS IF THE\r
1136                 DEBUGGER ALLOWS INTERRUPTS TO BE PROCESSED. */\r
1137                 portDISABLE_INTERRUPTS();\r
1138 \r
1139                 xSchedulerRunning = pdTRUE;\r
1140                 xTickCount = ( portTickType ) 0;\r
1141 \r
1142                 /* Setting up the timer tick is hardware specific and thus in the\r
1143                 portable interface. */\r
1144                 if( xPortStartScheduler() )\r
1145                 {\r
1146                         /* Should not reach here as if the scheduler is running the\r
1147                         function will not return. */\r
1148                 }\r
1149                 else\r
1150                 {\r
1151                         /* Should only reach here if a task calls xTaskEndScheduler(). */\r
1152                 }\r
1153         }\r
1154 }\r
1155 /*-----------------------------------------------------------*/\r
1156 \r
1157 void vTaskEndScheduler( void )\r
1158 {\r
1159         /* Stop the scheduler interrupts and call the portable scheduler end\r
1160         routine so the original ISRs can be restored if necessary.  The port\r
1161         layer must ensure interrupts enable     bit is left in the correct state. */\r
1162         portDISABLE_INTERRUPTS();\r
1163         xSchedulerRunning = pdFALSE;\r
1164         vPortEndScheduler();\r
1165 }\r
1166 /*----------------------------------------------------------*/\r
1167 \r
1168 void vTaskSuspendAll( void )\r
1169 {\r
1170         portENTER_CRITICAL();\r
1171                 ++uxSchedulerSuspended;\r
1172         portEXIT_CRITICAL();\r
1173 }\r
1174 /*----------------------------------------------------------*/\r
1175 \r
1176 signed portBASE_TYPE xTaskResumeAll( void )\r
1177 {\r
1178 register tskTCB *pxTCB;\r
1179 signed portBASE_TYPE xAlreadyYielded = pdFALSE;\r
1180 \r
1181         /* It is possible that an ISR caused a task to be removed from an event\r
1182         list while the scheduler was suspended.  If this was the case then the\r
1183         removed task will have been added to the xPendingReadyList.  Once the\r
1184         scheduler has been resumed it is safe to move all the pending ready\r
1185         tasks from this list into their appropriate ready list. */\r
1186         portENTER_CRITICAL();\r
1187         {\r
1188                 --uxSchedulerSuspended;\r
1189 \r
1190                 if( uxSchedulerSuspended == ( unsigned portBASE_TYPE ) pdFALSE )\r
1191                 {                       \r
1192                         if( uxCurrentNumberOfTasks > ( unsigned portBASE_TYPE ) 0 )\r
1193                         {\r
1194                                 portBASE_TYPE xYieldRequired = pdFALSE;\r
1195                                 \r
1196                                 /* Move any readied tasks from the pending list into the\r
1197                                 appropriate ready list. */\r
1198                                 while( ( pxTCB = ( tskTCB * ) listGET_OWNER_OF_HEAD_ENTRY(  ( ( xList * ) &xPendingReadyList ) ) ) != NULL )\r
1199                                 {\r
1200                                         vListRemove( &( pxTCB->xEventListItem ) );\r
1201                                         vListRemove( &( pxTCB->xGenericListItem ) );\r
1202                                         prvAddTaskToReadyQueue( pxTCB );\r
1203                                         \r
1204                                         /* If we have moved a task that has a priority higher than\r
1205                                         the current task then we should yield. */\r
1206                                         if( pxTCB->uxPriority >= pxCurrentTCB->uxPriority )\r
1207                                         {\r
1208                                                 xYieldRequired = pdTRUE;\r
1209                                         }\r
1210                                 }\r
1211 \r
1212                                 /* If any ticks occurred while the scheduler was suspended then\r
1213                                 they should be processed now.  This ensures the tick count does not\r
1214                                 slip, and that any delayed tasks are resumed at the correct time. */\r
1215                                 if( uxMissedTicks > ( unsigned portBASE_TYPE ) 0 )\r
1216                                 {\r
1217                                         while( uxMissedTicks > ( unsigned portBASE_TYPE ) 0 )\r
1218                                         {\r
1219                                                 vTaskIncrementTick();\r
1220                                                 --uxMissedTicks;\r
1221                                         }\r
1222 \r
1223                                         /* As we have processed some ticks it is appropriate to yield\r
1224                                         to ensure the highest priority task that is ready to run is\r
1225                                         the task actually running. */\r
1226                                         #if configUSE_PREEMPTION == 1\r
1227                                         {\r
1228                                                 xYieldRequired = pdTRUE;\r
1229                                         }\r
1230                                         #endif\r
1231                                 }\r
1232                                 \r
1233                                 if( ( xYieldRequired == pdTRUE ) || ( xMissedYield == pdTRUE ) )\r
1234                                 {\r
1235                                         xAlreadyYielded = pdTRUE;\r
1236                                         xMissedYield = pdFALSE;\r
1237                                         taskYIELD();\r
1238                                 }\r
1239                         }\r
1240                 }\r
1241         }\r
1242         portEXIT_CRITICAL();\r
1243 \r
1244         return xAlreadyYielded;\r
1245 }\r
1246 \r
1247 \r
1248 \r
1249 \r
1250 \r
1251 \r
1252 /*-----------------------------------------------------------\r
1253  * PUBLIC TASK UTILITIES documented in task.h\r
1254  *----------------------------------------------------------*/\r
1255 \r
1256 \r
1257 \r
1258 portTickType xTaskGetTickCount( void )\r
1259 {\r
1260 portTickType xTicks;\r
1261 \r
1262         /* Critical section required if running on a 16 bit processor. */\r
1263         taskENTER_CRITICAL();\r
1264         {\r
1265                 xTicks = xTickCount;\r
1266         }\r
1267         taskEXIT_CRITICAL();\r
1268 \r
1269         return xTicks;\r
1270 }\r
1271 /*-----------------------------------------------------------*/\r
1272 \r
1273 unsigned portBASE_TYPE uxTaskGetNumberOfTasks( void )\r
1274 {\r
1275 unsigned portBASE_TYPE uxNumberOfTasks;\r
1276 \r
1277         taskENTER_CRITICAL();\r
1278                 uxNumberOfTasks = uxCurrentNumberOfTasks;\r
1279         taskEXIT_CRITICAL();\r
1280 \r
1281         return uxNumberOfTasks;\r
1282 }\r
1283 /*-----------------------------------------------------------*/\r
1284 \r
1285 #if ( ( configUSE_TRACE_FACILITY == 1 ) && ( INCLUDE_vTaskDelete == 1 ) && ( INCLUDE_vTaskSuspend == 1 ) )\r
1286 \r
1287         void vTaskList( signed portCHAR *pcWriteBuffer )\r
1288         {\r
1289         unsigned portBASE_TYPE uxQueue;\r
1290 \r
1291                 /* This is a VERY costly function that should be used for debug only.\r
1292                 It leaves interrupts disabled for a LONG time. */\r
1293 \r
1294         vTaskSuspendAll();\r
1295                 {\r
1296                         /* Run through all the lists that could potentially contain a TCB and\r
1297                         report the task name, state and stack high water mark. */\r
1298 \r
1299                         pcWriteBuffer[ 0 ] = ( signed portCHAR ) 0x00;\r
1300                         strcat( ( portCHAR * ) pcWriteBuffer, ( const portCHAR * ) "\r\n" );\r
1301 \r
1302                         uxQueue = uxTopUsedPriority + 1;\r
1303 \r
1304                         do\r
1305                         {\r
1306                                 uxQueue--;\r
1307 \r
1308                                 if( !listLIST_IS_EMPTY( &( pxReadyTasksLists[ uxQueue ] ) ) )\r
1309                                 {\r
1310                                         prvListTaskWithinSingleList( pcWriteBuffer, ( xList * ) &( pxReadyTasksLists[ uxQueue ] ), tskREADY_CHAR );                     \r
1311                                 }\r
1312                         }while( uxQueue > ( unsigned portSHORT ) tskIDLE_PRIORITY );\r
1313 \r
1314                         if( !listLIST_IS_EMPTY( pxDelayedTaskList ) )\r
1315                         {\r
1316                                 prvListTaskWithinSingleList( pcWriteBuffer, ( xList * ) pxDelayedTaskList, tskBLOCKED_CHAR );\r
1317                         }\r
1318 \r
1319                         if( !listLIST_IS_EMPTY( pxOverflowDelayedTaskList ) )\r
1320                         {\r
1321                                 prvListTaskWithinSingleList( pcWriteBuffer, ( xList * ) pxOverflowDelayedTaskList, tskBLOCKED_CHAR );\r
1322                         }\r
1323 \r
1324                         if( !listLIST_IS_EMPTY( &xTasksWaitingTermination ) )\r
1325                         {\r
1326                                 prvListTaskWithinSingleList( pcWriteBuffer, ( xList * ) &xTasksWaitingTermination, tskDELETED_CHAR );\r
1327                         }\r
1328 \r
1329                         if( !listLIST_IS_EMPTY( &xSuspendedTaskList ) )\r
1330                         {\r
1331                                 prvListTaskWithinSingleList( pcWriteBuffer, ( xList * ) &xSuspendedTaskList, tskSUSPENDED_CHAR );\r
1332                         }\r
1333                 }\r
1334         xTaskResumeAll();\r
1335         }\r
1336 \r
1337 #endif\r
1338 /*----------------------------------------------------------*/\r
1339 \r
1340 #if ( configUSE_TRACE_FACILITY == 1 )\r
1341 \r
1342         void vTaskStartTrace( signed portCHAR * pcBuffer, unsigned portLONG ulBufferSize )\r
1343         {\r
1344                 portENTER_CRITICAL();\r
1345                 {\r
1346                         pcTraceBuffer = ( signed portCHAR * )pcBuffer;\r
1347                         pcTraceBufferStart = pcBuffer;\r
1348                         pcTraceBufferEnd = pcBuffer + ( ulBufferSize - tskSIZE_OF_EACH_TRACE_LINE );\r
1349                         xTracing = pdTRUE;\r
1350                 }\r
1351                 portEXIT_CRITICAL();\r
1352         }\r
1353 \r
1354 #endif\r
1355 /*----------------------------------------------------------*/\r
1356 \r
1357 #if ( configUSE_TRACE_FACILITY == 1 )\r
1358 \r
1359         unsigned portLONG ulTaskEndTrace( void )\r
1360         {\r
1361         unsigned portLONG ulBufferLength;\r
1362 \r
1363                 portENTER_CRITICAL();\r
1364                         xTracing = pdFALSE;\r
1365                 portEXIT_CRITICAL();\r
1366 \r
1367                 ulBufferLength = ( unsigned portLONG ) ( pcTraceBuffer - pcTraceBufferStart );\r
1368 \r
1369                 return ulBufferLength;\r
1370         }\r
1371 \r
1372 #endif\r
1373 \r
1374 \r
1375 \r
1376 /*-----------------------------------------------------------\r
1377  * SCHEDULER INTERNALS AVAILABLE FOR PORTING PURPOSES\r
1378  * documented in task.h\r
1379  *----------------------------------------------------------*/\r
1380 \r
1381 \r
1382 inline void vTaskIncrementTick( void )\r
1383 {\r
1384         /* Called by the portable layer each time a tick interrupt occurs.\r
1385         Increments the tick then checks to see if the new tick value will cause any\r
1386         tasks to be unblocked. */\r
1387         if( uxSchedulerSuspended == ( unsigned portBASE_TYPE ) pdFALSE )\r
1388         {\r
1389                 ++xTickCount;\r
1390                 if( xTickCount == ( portTickType ) 0 )\r
1391                 {\r
1392                         xList *pxTemp;\r
1393 \r
1394                         /* Tick count has overflowed so we need to swap the delay lists.  \r
1395                         If there are any items in pxDelayedTaskList here then there is \r
1396                         an error! */\r
1397                         pxTemp = pxDelayedTaskList;\r
1398                         pxDelayedTaskList = pxOverflowDelayedTaskList;\r
1399                         pxOverflowDelayedTaskList = pxTemp;\r
1400             xNumOfOverflows++;\r
1401                 }\r
1402 \r
1403                 /* See if this tick has made a timeout expire. */\r
1404                 prvCheckDelayedTasks();\r
1405         }\r
1406         else\r
1407         {\r
1408                 ++uxMissedTicks;\r
1409 \r
1410                 /* The tick hook gets called at regular intervals, even if the \r
1411                 scheduler is locked. */\r
1412                 #if ( configUSE_TICK_HOOK == 1 )\r
1413                 {\r
1414                         extern void vApplicationTickHook( void );\r
1415 \r
1416                         vApplicationTickHook();\r
1417                 }\r
1418                 #endif\r
1419         }\r
1420 \r
1421         #if ( configUSE_TICK_HOOK == 1 )\r
1422         {\r
1423                 extern void vApplicationTickHook( void );\r
1424 \r
1425                 /* Guard against the tick hook being called when the missed tick\r
1426                 count is being unwound (when the scheduler is being unlocked. */\r
1427                 if( uxMissedTicks == 0 )\r
1428                 {\r
1429                         vApplicationTickHook();\r
1430                 }\r
1431         }\r
1432         #endif\r
1433 }\r
1434 /*-----------------------------------------------------------*/\r
1435 \r
1436 #if ( ( INCLUDE_vTaskCleanUpResources == 1 ) && ( INCLUDE_vTaskSuspend == 1 ) )\r
1437 \r
1438         void vTaskCleanUpResources( void )\r
1439         {\r
1440         unsigned portSHORT usQueue;\r
1441         volatile tskTCB *pxTCB;\r
1442 \r
1443                 usQueue = ( unsigned portSHORT ) uxTopUsedPriority + ( unsigned portSHORT ) 1;\r
1444 \r
1445                 /* Remove any TCB's from the ready queues. */\r
1446                 do\r
1447                 {\r
1448                         usQueue--;\r
1449 \r
1450                         while( !listLIST_IS_EMPTY( &( pxReadyTasksLists[ usQueue ] ) ) )\r
1451                         {\r
1452                                 listGET_OWNER_OF_NEXT_ENTRY( pxTCB, &( pxReadyTasksLists[ usQueue ] ) );\r
1453                                 vListRemove( ( xListItem * ) &( pxTCB->xGenericListItem ) );\r
1454 \r
1455                                 prvDeleteTCB( ( tskTCB * ) pxTCB );\r
1456                         }\r
1457                 }while( usQueue > ( unsigned portSHORT ) tskIDLE_PRIORITY );\r
1458 \r
1459                 /* Remove any TCB's from the delayed queue. */\r
1460                 while( !listLIST_IS_EMPTY( &xDelayedTaskList1 ) )\r
1461                 {\r
1462                         listGET_OWNER_OF_NEXT_ENTRY( pxTCB, &xDelayedTaskList1 );\r
1463                         vListRemove( ( xListItem * ) &( pxTCB->xGenericListItem ) );\r
1464 \r
1465                         prvDeleteTCB( ( tskTCB * ) pxTCB );\r
1466                 }\r
1467 \r
1468                 /* Remove any TCB's from the overflow delayed queue. */\r
1469                 while( !listLIST_IS_EMPTY( &xDelayedTaskList2 ) )\r
1470                 {\r
1471                         listGET_OWNER_OF_NEXT_ENTRY( pxTCB, &xDelayedTaskList2 );\r
1472                         vListRemove( ( xListItem * ) &( pxTCB->xGenericListItem ) );\r
1473 \r
1474                         prvDeleteTCB( ( tskTCB * ) pxTCB );\r
1475                 }\r
1476 \r
1477                 while( !listLIST_IS_EMPTY( &xSuspendedTaskList ) )\r
1478                 {\r
1479                         listGET_OWNER_OF_NEXT_ENTRY( pxTCB, &xSuspendedTaskList );\r
1480                         vListRemove( ( xListItem * ) &( pxTCB->xGenericListItem ) );\r
1481 \r
1482                         prvDeleteTCB( ( tskTCB * ) pxTCB );\r
1483                 }               \r
1484         }\r
1485 \r
1486 #endif\r
1487 /*-----------------------------------------------------------*/\r
1488 \r
1489 void vTaskSwitchContext( void )\r
1490 {\r
1491         if( uxSchedulerSuspended != ( unsigned portBASE_TYPE ) pdFALSE )\r
1492         {\r
1493                 /* The scheduler is currently suspended - do not allow a context\r
1494                 switch. */\r
1495                 xMissedYield = pdTRUE;\r
1496                 return;\r
1497         }\r
1498 \r
1499         /* Find the highest priority queue that contains ready tasks. */\r
1500         while( listLIST_IS_EMPTY( &( pxReadyTasksLists[ uxTopReadyPriority ] ) ) )\r
1501         {\r
1502                 --uxTopReadyPriority;\r
1503         }\r
1504 \r
1505         /* listGET_OWNER_OF_NEXT_ENTRY walks through the list, so the tasks of the\r
1506         same priority get an equal share of the processor time. */\r
1507         listGET_OWNER_OF_NEXT_ENTRY( pxCurrentTCB, &( pxReadyTasksLists[ uxTopReadyPriority ] ) );\r
1508         vWriteTraceToBuffer();\r
1509 }\r
1510 /*-----------------------------------------------------------*/\r
1511 \r
1512 void vTaskPlaceOnEventList( const xList * const pxEventList, portTickType xTicksToWait )\r
1513 {\r
1514 portTickType xTimeToWake;\r
1515 \r
1516         /* THIS FUNCTION MUST BE CALLED WITH INTERRUPTS DISABLED OR THE\r
1517         SCHEDULER SUSPENDED. */\r
1518 \r
1519         /* Place the event list item of the TCB in the appropriate event list.\r
1520         This is placed in the list in priority order so the highest priority task\r
1521         is the first to be woken by the event. */\r
1522         vListInsert( ( xList * ) pxEventList, ( xListItem * ) &( pxCurrentTCB->xEventListItem ) );\r
1523 \r
1524         /* We must remove ourselves from the ready list before adding ourselves\r
1525         to the blocked list as the same list item is used for both lists.  We have\r
1526         exclusive access to the ready lists as the scheduler is locked. */\r
1527         vListRemove( ( xListItem * ) &( pxCurrentTCB->xGenericListItem ) );\r
1528 \r
1529 \r
1530         #if ( INCLUDE_vTaskSuspend == 1 )\r
1531         {                        \r
1532                 if( xTicksToWait == portMAX_DELAY )\r
1533                 {\r
1534                         /* Add ourselves to the suspended task list instead of a delayed task\r
1535                         list to ensure we are not woken by a timing event.  We will block\r
1536                         indefinitely. */\r
1537                         vListInsertEnd( ( xList * ) &xSuspendedTaskList, ( xListItem * ) &( pxCurrentTCB->xGenericListItem ) );\r
1538                 }\r
1539                 else\r
1540                 {\r
1541                         /* Calculate the time at which the task should be woken if the event does\r
1542                         not occur.  This may overflow but this doesn't matter. */\r
1543                         xTimeToWake = xTickCount + xTicksToWait;\r
1544                 \r
1545                         listSET_LIST_ITEM_VALUE( &( pxCurrentTCB->xGenericListItem ), xTimeToWake );\r
1546                 \r
1547                         if( xTimeToWake < xTickCount )\r
1548                         {\r
1549                                 /* Wake time has overflowed.  Place this item in the overflow list. */\r
1550                                 vListInsert( ( xList * ) pxOverflowDelayedTaskList, ( xListItem * ) &( pxCurrentTCB->xGenericListItem ) );\r
1551                         }\r
1552                         else\r
1553                         {\r
1554                                 /* The wake time has not overflowed, so we can use the current block list. */\r
1555                                 vListInsert( ( xList * ) pxDelayedTaskList, ( xListItem * ) &( pxCurrentTCB->xGenericListItem ) );\r
1556                         }\r
1557                 }\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         #endif\r
1579 }\r
1580 /*-----------------------------------------------------------*/\r
1581 \r
1582 signed portBASE_TYPE xTaskRemoveFromEventList( const xList * const pxEventList )\r
1583 {\r
1584 tskTCB *pxUnblockedTCB;\r
1585 portBASE_TYPE xReturn;\r
1586 \r
1587         /* THIS FUNCTION MUST BE CALLED WITH INTERRUPTS DISABLED OR THE\r
1588         SCHEDULER SUSPENDED.  It can also be called from within an ISR. */\r
1589 \r
1590         /* The event list is sorted in priority order, so we can remove the\r
1591         first in the list, remove the TCB from the delayed list, and add\r
1592         it to the ready list.\r
1593         \r
1594         If an event is for a queue that is locked then this function will never\r
1595         get called - the lock count on the queue will get modified instead.  This\r
1596         means we can always expect exclusive access to the event list here. */\r
1597         pxUnblockedTCB = ( tskTCB * ) listGET_OWNER_OF_HEAD_ENTRY( pxEventList );\r
1598         vListRemove( &( pxUnblockedTCB->xEventListItem ) );\r
1599 \r
1600         if( uxSchedulerSuspended == ( unsigned portBASE_TYPE ) pdFALSE )\r
1601         {\r
1602                 vListRemove( &( pxUnblockedTCB->xGenericListItem ) );\r
1603                 prvAddTaskToReadyQueue( pxUnblockedTCB );\r
1604         }\r
1605         else\r
1606         {\r
1607                 /* We cannot access the delayed or ready lists, so will hold this\r
1608                 task pending until the scheduler is resumed. */\r
1609                 vListInsertEnd( ( xList * ) &( xPendingReadyList ), &( pxUnblockedTCB->xEventListItem ) );\r
1610         }\r
1611 \r
1612         if( pxUnblockedTCB->uxPriority >= pxCurrentTCB->uxPriority )\r
1613         {\r
1614                 /* Return true if the task removed from the event list has\r
1615                 a higher priority than the calling task.  This allows\r
1616                 the calling task to know if it should force a context\r
1617                 switch now. */\r
1618                 xReturn = pdTRUE;\r
1619         }\r
1620         else\r
1621         {\r
1622                 xReturn = pdFALSE;\r
1623         }\r
1624 \r
1625         return xReturn;\r
1626 }\r
1627 /*-----------------------------------------------------------*/\r
1628 \r
1629 void vTaskSetTimeOutState( xTimeOutType * const pxTimeOut )\r
1630 {\r
1631     pxTimeOut->xOverflowCount = xNumOfOverflows;\r
1632     pxTimeOut->xTimeOnEntering = xTickCount;\r
1633 }\r
1634 /*-----------------------------------------------------------*/\r
1635 \r
1636 portBASE_TYPE xTaskCheckForTimeOut( xTimeOutType * const pxTimeOut, portTickType * const pxTicksToWait )\r
1637 {\r
1638 portBASE_TYPE xReturn;\r
1639 \r
1640         #if ( INCLUDE_vTaskSuspend == 1 )\r
1641                 /* If INCLUDE_vTaskSuspend is set to 1 and the block time specified is\r
1642                 the maximum block time then the task should block indefinitely, and\r
1643                 therefore never time out. */\r
1644                 if( *pxTicksToWait == portMAX_DELAY )\r
1645                 {\r
1646                         xReturn = pdFALSE;\r
1647                 }\r
1648                 else /* We are not blocking indefinitely, perform the checks below. */\r
1649         #endif\r
1650 \r
1651     if( ( xNumOfOverflows != pxTimeOut->xOverflowCount ) && ( xTickCount >= pxTimeOut->xTimeOnEntering ) )\r
1652     {\r
1653         /* The tick count is greater than the time at which vTaskSetTimeout()\r
1654                 was called, but has also overflowed since vTaskSetTimeOut() was called.\r
1655         It must have wrapped all the way around and gone past us again. This\r
1656         passed since vTaskSetTimeout() was called. */\r
1657         xReturn = pdTRUE;\r
1658     }\r
1659     else if( ( xTickCount - pxTimeOut->xTimeOnEntering ) < *pxTicksToWait )\r
1660     {\r
1661         /* Not a genuine timeout. Adjust parameters for time remaining. */\r
1662         *pxTicksToWait -= ( xTickCount - pxTimeOut->xTimeOnEntering );\r
1663         vTaskSetTimeOutState( pxTimeOut );\r
1664         xReturn = pdFALSE;\r
1665     }\r
1666     else\r
1667     {\r
1668         xReturn = pdTRUE;\r
1669     }\r
1670 \r
1671     return xReturn;\r
1672 }\r
1673 /*-----------------------------------------------------------*/\r
1674 \r
1675 void vTaskMissedYield( void )\r
1676 {\r
1677         xMissedYield = pdTRUE;\r
1678 }\r
1679 \r
1680 /*\r
1681  * -----------------------------------------------------------\r
1682  * The Idle task.\r
1683  * ----------------------------------------------------------\r
1684  *\r
1685  * The portTASK_FUNCTION() macro is used to allow port/compiler specific\r
1686  * language extensions.  The equivalent prototype for this function is:\r
1687  *\r
1688  * void prvIdleTask( void *pvParameters );\r
1689  *\r
1690  */\r
1691 static portTASK_FUNCTION( prvIdleTask, pvParameters )\r
1692 {\r
1693         /* Stop warnings. */\r
1694         ( void ) pvParameters;\r
1695 \r
1696         for( ;; )\r
1697         {\r
1698                 /* See if any tasks have been deleted. */\r
1699                 prvCheckTasksWaitingTermination();\r
1700 \r
1701                 #if ( configUSE_PREEMPTION == 0 )\r
1702                 {\r
1703                         /* If we are not using preemption we keep forcing a task switch to\r
1704                         see if any other task has become available.  If we are using\r
1705                         preemption we don't need to do this as any task becoming available\r
1706                         will automatically get the processor anyway. */\r
1707                         taskYIELD();    \r
1708                 }\r
1709                 #endif\r
1710 \r
1711                 #if ( ( configUSE_PREEMPTION == 1 ) && ( configIDLE_SHOULD_YIELD == 1 ) )\r
1712                 {\r
1713                         /* When using preemption tasks of equal priority will be\r
1714                         timesliced.  If a task that is sharing the idle priority is ready\r
1715                         to run then the idle task should yield before the end of the\r
1716                         timeslice.\r
1717                         \r
1718                         A critical region is not required here as we are just reading from\r
1719                         the list, and an occasional incorrect value will not matter.  If\r
1720                         the ready list at the idle priority contains more than one task\r
1721                         then a task other than the idle task is ready to execute. */\r
1722                         if( listCURRENT_LIST_LENGTH( &( pxReadyTasksLists[ tskIDLE_PRIORITY ] ) ) > ( unsigned portBASE_TYPE ) 1 )\r
1723                         {\r
1724                                 taskYIELD();\r
1725                         }\r
1726                 }\r
1727                 #endif\r
1728 \r
1729                 #if ( configUSE_IDLE_HOOK == 1 )\r
1730                 {\r
1731                         extern void vApplicationIdleHook( void );\r
1732 \r
1733                         /* Call the user defined function from within the idle task.  This\r
1734                         allows the application designer to add background functionality\r
1735                         without the overhead of a separate task.\r
1736                         NOTE: vApplicationIdleHook() MUST NOT, UNDER ANY CIRCUMSTANCES,\r
1737                         CALL A FUNCTION THAT MIGHT BLOCK. */\r
1738                         vApplicationIdleHook();\r
1739                 }\r
1740                 #endif\r
1741         }\r
1742 } /*lint !e715 pvParameters is not accessed but all task functions require the same prototype. */\r
1743 \r
1744 \r
1745 \r
1746 \r
1747 \r
1748 \r
1749 \r
1750 /*-----------------------------------------------------------\r
1751  * File private functions documented at the top of the file.\r
1752  *----------------------------------------------------------*/\r
1753 \r
1754 \r
1755 \r
1756 static void prvInitialiseTCBVariables( tskTCB *pxTCB, const signed portCHAR * const pcName, unsigned portBASE_TYPE uxPriority )\r
1757 {\r
1758         /* Store the function name in the TCB. */\r
1759         strncpy( ( char * ) pxTCB->pcTaskName, ( const char * ) pcName, ( unsigned portSHORT ) configMAX_TASK_NAME_LEN );\r
1760         pxTCB->pcTaskName[ ( unsigned portSHORT ) configMAX_TASK_NAME_LEN - ( unsigned portSHORT ) 1 ] = '\0';\r
1761 \r
1762         #if ( portCRITICAL_NESTING_IN_TCB == 1 )\r
1763         {\r
1764                 pxTCB->uxCriticalNesting = ( unsigned portBASE_TYPE ) 0;\r
1765         }\r
1766         #endif\r
1767 \r
1768         /* This is used as an array index so must ensure it's not too large. */\r
1769         if( uxPriority >= configMAX_PRIORITIES )\r
1770         {\r
1771                 uxPriority = configMAX_PRIORITIES - 1;\r
1772         }\r
1773 \r
1774         pxTCB->uxPriority = uxPriority;\r
1775         #if ( configUSE_MUTEXES == 1 )\r
1776         {\r
1777                 pxTCB->uxBasePriority = uxPriority;\r
1778         }\r
1779         #endif\r
1780 \r
1781         vListInitialiseItem( &( pxTCB->xGenericListItem ) );\r
1782         vListInitialiseItem( &( pxTCB->xEventListItem ) );\r
1783 \r
1784         /* Set the pxTCB as a link back from the xListItem.  This is so we can get\r
1785         back to the containing TCB from a generic item in a list. */\r
1786         listSET_LIST_ITEM_OWNER( &( pxTCB->xGenericListItem ), pxTCB );\r
1787 \r
1788         /* Event lists are always in priority order. */\r
1789         listSET_LIST_ITEM_VALUE( &( pxTCB->xEventListItem ), configMAX_PRIORITIES - ( portTickType ) uxPriority );\r
1790         listSET_LIST_ITEM_OWNER( &( pxTCB->xEventListItem ), pxTCB );\r
1791 }\r
1792 /*-----------------------------------------------------------*/\r
1793 \r
1794 static void prvInitialiseTaskLists( void )\r
1795 {\r
1796 unsigned portBASE_TYPE uxPriority;\r
1797 \r
1798         for( uxPriority = 0; uxPriority < configMAX_PRIORITIES; uxPriority++ )\r
1799         {\r
1800                 vListInitialise( ( xList * ) &( pxReadyTasksLists[ uxPriority ] ) );\r
1801         }\r
1802 \r
1803         vListInitialise( ( xList * ) &xDelayedTaskList1 );\r
1804         vListInitialise( ( xList * ) &xDelayedTaskList2 );\r
1805         vListInitialise( ( xList * ) &xPendingReadyList );\r
1806 \r
1807         #if ( INCLUDE_vTaskDelete == 1 )\r
1808         {\r
1809                 vListInitialise( ( xList * ) &xTasksWaitingTermination );\r
1810         }\r
1811         #endif\r
1812 \r
1813         #if ( INCLUDE_vTaskSuspend == 1 )\r
1814         {\r
1815                 vListInitialise( ( xList * ) &xSuspendedTaskList );\r
1816         }\r
1817         #endif\r
1818 \r
1819         /* Start with pxDelayedTaskList using list1 and the pxOverflowDelayedTaskList\r
1820         using list2. */\r
1821         pxDelayedTaskList = &xDelayedTaskList1;\r
1822         pxOverflowDelayedTaskList = &xDelayedTaskList2;\r
1823 }\r
1824 /*-----------------------------------------------------------*/\r
1825 \r
1826 static void prvCheckTasksWaitingTermination( void )\r
1827 {                                                       \r
1828         #if ( INCLUDE_vTaskDelete == 1 )\r
1829         {                               \r
1830                 portBASE_TYPE xListIsEmpty;\r
1831 \r
1832                 /* ucTasksDeleted is used to prevent vTaskSuspendAll() being called\r
1833                 too often in the idle task. */\r
1834                 if( uxTasksDeleted > ( unsigned portBASE_TYPE ) 0 )\r
1835                 {\r
1836                         vTaskSuspendAll();\r
1837                                 xListIsEmpty = listLIST_IS_EMPTY( &xTasksWaitingTermination );                          \r
1838                         xTaskResumeAll();\r
1839 \r
1840                         if( !xListIsEmpty )\r
1841                         {\r
1842                                 tskTCB *pxTCB;\r
1843 \r
1844                                 portENTER_CRITICAL();\r
1845                                 {                       \r
1846                                         pxTCB = ( tskTCB * ) listGET_OWNER_OF_HEAD_ENTRY( ( ( xList * ) &xTasksWaitingTermination ) );\r
1847                                         vListRemove( &( pxTCB->xGenericListItem ) );\r
1848                                         --uxCurrentNumberOfTasks;\r
1849                                         --uxTasksDeleted;\r
1850                                 }\r
1851                                 portEXIT_CRITICAL();\r
1852 \r
1853                                 prvDeleteTCB( pxTCB );\r
1854                         }\r
1855                 }\r
1856         }\r
1857         #endif\r
1858 }\r
1859 /*-----------------------------------------------------------*/\r
1860 \r
1861 static tskTCB *prvAllocateTCBAndStack( unsigned portSHORT usStackDepth )\r
1862 {\r
1863 tskTCB *pxNewTCB;\r
1864 \r
1865         /* Allocate space for the TCB.  Where the memory comes from depends on\r
1866         the implementation of the port malloc function. */\r
1867         pxNewTCB = ( tskTCB * ) pvPortMalloc( sizeof( tskTCB ) );\r
1868 \r
1869         if( pxNewTCB != NULL )\r
1870         {\r
1871                 /* Allocate space for the stack used by the task being created.\r
1872                 The base of the stack memory stored in the TCB so the task can\r
1873                 be deleted later if required. */\r
1874                 pxNewTCB->pxStack = ( portSTACK_TYPE * ) pvPortMalloc( ( ( size_t )usStackDepth ) * sizeof( portSTACK_TYPE ) );\r
1875 \r
1876                 if( pxNewTCB->pxStack == NULL )\r
1877                 {\r
1878                         /* Could not allocate the stack.  Delete the allocated TCB. */\r
1879                         vPortFree( pxNewTCB );                  \r
1880                         pxNewTCB = NULL;                        \r
1881                 }               \r
1882                 else\r
1883                 {\r
1884                         /* Just to help debugging. */\r
1885                         memset( pxNewTCB->pxStack, tskSTACK_FILL_BYTE, usStackDepth * sizeof( portSTACK_TYPE ) );\r
1886                 }\r
1887         }\r
1888 \r
1889         return pxNewTCB;\r
1890 }\r
1891 /*-----------------------------------------------------------*/\r
1892 \r
1893 #if ( configUSE_TRACE_FACILITY == 1 )\r
1894 \r
1895         static void prvListTaskWithinSingleList( const signed portCHAR *pcWriteBuffer, xList *pxList, signed portCHAR cStatus )\r
1896         {\r
1897         volatile tskTCB *pxNextTCB, *pxFirstTCB;\r
1898         static portCHAR pcStatusString[ 50 ];\r
1899         unsigned portSHORT usStackRemaining;\r
1900 \r
1901                 /* Write the details of all the TCB's in pxList into the buffer. */\r
1902                 listGET_OWNER_OF_NEXT_ENTRY( pxFirstTCB, pxList );\r
1903                 do\r
1904                 {\r
1905                         listGET_OWNER_OF_NEXT_ENTRY( pxNextTCB, pxList );\r
1906                         usStackRemaining = usTaskCheckFreeStackSpace( ( unsigned portCHAR * ) pxNextTCB->pxStack );\r
1907                         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
1908                         strcat( ( portCHAR * ) pcWriteBuffer, ( portCHAR * ) pcStatusString );\r
1909 \r
1910                 } while( pxNextTCB != pxFirstTCB );\r
1911         }\r
1912 \r
1913 #endif\r
1914 /*-----------------------------------------------------------*/\r
1915 \r
1916 #if ( configUSE_TRACE_FACILITY == 1 )\r
1917         unsigned portSHORT usTaskCheckFreeStackSpace( const unsigned portCHAR * pucStackByte )\r
1918         {\r
1919         register unsigned portSHORT usCount = 0;\r
1920 \r
1921                 while( *pucStackByte == tskSTACK_FILL_BYTE )\r
1922                 {\r
1923                         pucStackByte -= portSTACK_GROWTH;\r
1924                         usCount++;\r
1925                 }\r
1926 \r
1927                 usCount /= sizeof( portSTACK_TYPE );\r
1928 \r
1929                 return usCount;\r
1930         }\r
1931 #endif\r
1932 /*-----------------------------------------------------------*/\r
1933 \r
1934 \r
1935 \r
1936 #if ( ( INCLUDE_vTaskDelete == 1 ) || ( INCLUDE_vTaskCleanUpResources == 1 ) )\r
1937 \r
1938         static void prvDeleteTCB( tskTCB *pxTCB )\r
1939         {\r
1940                 /* Free up the memory allocated by the scheduler for the task.  It is up to\r
1941                 the task to free any memory allocated at the application level. */\r
1942                 vPortFree( pxTCB->pxStack );\r
1943                 vPortFree( pxTCB );\r
1944         }\r
1945 \r
1946 #endif\r
1947 \r
1948 \r
1949 /*-----------------------------------------------------------*/\r
1950 \r
1951 #if ( INCLUDE_xTaskGetCurrentTaskHandle == 1 )\r
1952 \r
1953         xTaskHandle xTaskGetCurrentTaskHandle( void )\r
1954         {\r
1955         xTaskHandle xReturn;\r
1956 \r
1957                 portENTER_CRITICAL();\r
1958                 {\r
1959                         xReturn = ( xTaskHandle ) pxCurrentTCB;\r
1960                 }\r
1961                 portEXIT_CRITICAL();\r
1962 \r
1963                 return xReturn;\r
1964         }\r
1965 \r
1966 #endif\r
1967 \r
1968 /*-----------------------------------------------------------*/\r
1969 \r
1970 #if ( INCLUDE_xTaskGetSchedulerState == 1 )\r
1971 \r
1972         portBASE_TYPE xTaskGetSchedulerState( void )\r
1973         {\r
1974         portBASE_TYPE xReturn;\r
1975         \r
1976                 if( xSchedulerRunning == pdFALSE )\r
1977                 {\r
1978                         xReturn = taskSCHEDULER_NOT_STARTED;\r
1979                 }\r
1980                 else\r
1981                 {\r
1982                         if( uxSchedulerSuspended == ( unsigned portBASE_TYPE ) pdFALSE )\r
1983                         {\r
1984                                 xReturn = taskSCHEDULER_RUNNING;\r
1985                         }\r
1986                         else\r
1987                         {\r
1988                                 xReturn = taskSCHEDULER_SUSPENDED;\r
1989                         }\r
1990                 }\r
1991                 \r
1992                 return xReturn;\r
1993         }\r
1994 \r
1995 #endif\r
1996 /*-----------------------------------------------------------*/\r
1997 \r
1998 #if ( configUSE_MUTEXES == 1 )\r
1999         \r
2000         void vTaskPriorityInherit( xTaskHandle * const pxMutexHolder )\r
2001         {\r
2002         tskTCB * const pxTCB = ( tskTCB * ) pxMutexHolder;\r
2003 \r
2004                 if( pxTCB->uxPriority < pxCurrentTCB->uxPriority )\r
2005                 {\r
2006                         /* Adjust the mutex holder state to account for its new priority. */\r
2007                         listSET_LIST_ITEM_VALUE( &( pxTCB->xEventListItem ), configMAX_PRIORITIES - ( portTickType ) pxCurrentTCB->uxPriority );\r
2008 \r
2009                         /* If the task being modified is in the ready state it will need to\r
2010                         be moved in to a new list. */\r
2011                         if( listIS_CONTAINED_WITHIN( &( pxReadyTasksLists[ pxTCB->uxPriority ] ), &( pxTCB->xGenericListItem ) ) )\r
2012                         {\r
2013                                 vListRemove( &( pxTCB->xGenericListItem ) );\r
2014 \r
2015                                 /* Inherit the priority before being moved into the new list. */\r
2016                                 pxTCB->uxPriority = pxCurrentTCB->uxPriority;\r
2017                                 prvAddTaskToReadyQueue( pxTCB );\r
2018                         }\r
2019                         else\r
2020                         {\r
2021                                 /* Just inherit the priority. */\r
2022                                 pxTCB->uxPriority = pxCurrentTCB->uxPriority;\r
2023                         }\r
2024                 }\r
2025         }\r
2026 \r
2027 #endif\r
2028 /*-----------------------------------------------------------*/\r
2029 \r
2030 #if ( configUSE_MUTEXES == 1 )  \r
2031 \r
2032         void vTaskPriorityDisinherit( xTaskHandle * const pxMutexHolder )\r
2033         {\r
2034         tskTCB * const pxTCB = ( tskTCB * ) pxMutexHolder;\r
2035 \r
2036                 if( pxMutexHolder != NULL )\r
2037                 {\r
2038                         if( pxTCB->uxPriority != pxTCB->uxBasePriority )\r
2039                         {\r
2040                                 /* We must be the running task to be able to give the mutex back.\r
2041                                 Remove ourselves from the ready list we currently appear in. */\r
2042                                 vListRemove( &( pxTCB->xGenericListItem ) );\r
2043 \r
2044                                 /* Disinherit the priority before adding ourselves into the new\r
2045                                 ready list. */\r
2046                                 pxTCB->uxPriority = pxTCB->uxBasePriority;\r
2047                                 listSET_LIST_ITEM_VALUE( &( pxTCB->xEventListItem ), configMAX_PRIORITIES - ( portTickType ) pxTCB->uxPriority );\r
2048                                 prvAddTaskToReadyQueue( pxTCB );\r
2049                         }\r
2050                 }\r
2051         }\r
2052 \r
2053 #endif\r
2054 /*-----------------------------------------------------------*/\r
2055 \r
2056 #if ( portCRITICAL_NESTING_IN_TCB == 1 )\r
2057 \r
2058         void vTaskEnterCritical( void )\r
2059         {\r
2060                 portDISABLE_INTERRUPTS();\r
2061 \r
2062                 if( xSchedulerRunning != pdFALSE )\r
2063                 {\r
2064                         pxCurrentTCB->uxCriticalNesting++;\r
2065                 }\r
2066         }\r
2067 \r
2068 #endif\r
2069 /*-----------------------------------------------------------*/\r
2070 \r
2071 #if ( portCRITICAL_NESTING_IN_TCB == 1 )\r
2072 \r
2073 void vTaskExitCritical( void )\r
2074 {\r
2075         if( xSchedulerRunning != pdFALSE )\r
2076         {\r
2077                 if( pxCurrentTCB->uxCriticalNesting > 0 )\r
2078                 {\r
2079                         pxCurrentTCB->uxCriticalNesting--;\r
2080 \r
2081                         if( pxCurrentTCB->uxCriticalNesting == 0 )\r
2082                         {\r
2083                                 portENABLE_INTERRUPTS();\r
2084                         }\r
2085                 }\r
2086         }\r
2087 }\r
2088 \r
2089 #endif\r
2090 /*-----------------------------------------------------------*/\r
2091 \r
2092 \r
2093         \r
2094 \r