]> git.sur5r.net Git - freertos/blob - FreeRTOS/Source/tasks.c
Next revision of queue set implementation.
[freertos] / FreeRTOS / Source / tasks.c
1 /*\r
2     FreeRTOS V7.3.0 - Copyright (C) 2012 Real Time Engineers Ltd.\r
3 \r
4     FEATURES AND PORTS ARE ADDED TO FREERTOS ALL THE TIME.  PLEASE VISIT\r
5     http://www.FreeRTOS.org TO ENSURE YOU ARE USING THE LATEST VERSION.\r
6 \r
7     ***************************************************************************\r
8      *                                                                       *\r
9      *    FreeRTOS tutorial books are available in pdf and paperback.        *\r
10      *    Complete, revised, and edited pdf reference manuals are also       *\r
11      *    available.                                                         *\r
12      *                                                                       *\r
13      *    Purchasing FreeRTOS documentation will not only help you, by       *\r
14      *    ensuring you get running as quickly as possible and with an        *\r
15      *    in-depth knowledge of how to use FreeRTOS, it will also help       *\r
16      *    the FreeRTOS project to continue with its mission of providing     *\r
17      *    professional grade, cross platform, de facto standard solutions    *\r
18      *    for microcontrollers - completely free of charge!                  *\r
19      *                                                                       *\r
20      *    >>> See http://www.FreeRTOS.org/Documentation for details. <<<     *\r
21      *                                                                       *\r
22      *    Thank you for using FreeRTOS, and thank you for your support!      *\r
23      *                                                                       *\r
24     ***************************************************************************\r
25 \r
26 \r
27     This file is part of the FreeRTOS distribution.\r
28 \r
29     FreeRTOS is free software; you can redistribute it and/or modify it under\r
30     the terms of the GNU General Public License (version 2) as published by the\r
31     Free Software Foundation AND MODIFIED BY the FreeRTOS exception.\r
32     >>>NOTE<<< The modification to the GPL is included to allow you to\r
33     distribute a combined work that includes FreeRTOS without being obliged to\r
34     provide the source code for proprietary components outside of the FreeRTOS\r
35     kernel.  FreeRTOS is distributed in the hope that it will be useful, but\r
36     WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY\r
37     or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for\r
38     more details. You should have received a copy of the GNU General Public\r
39     License and the FreeRTOS license exception along with FreeRTOS; if not it\r
40     can be viewed here: http://www.freertos.org/a00114.html and also obtained\r
41     by writing to Richard Barry, contact details for whom are available on the\r
42     FreeRTOS WEB site.\r
43 \r
44     1 tab == 4 spaces!\r
45 \r
46     ***************************************************************************\r
47      *                                                                       *\r
48      *    Having a problem?  Start by reading the FAQ "My application does   *\r
49      *    not run, what could be wrong?"                                     *\r
50      *                                                                       *\r
51      *    http://www.FreeRTOS.org/FAQHelp.html                               *\r
52      *                                                                       *\r
53     ***************************************************************************\r
54 \r
55 \r
56     http://www.FreeRTOS.org - Documentation, training, latest versions, license\r
57     and contact details.\r
58 \r
59     http://www.FreeRTOS.org/plus - A selection of FreeRTOS ecosystem products,\r
60     including FreeRTOS+Trace - an indispensable productivity tool.\r
61 \r
62     Real Time Engineers ltd license FreeRTOS to High Integrity Systems, who sell\r
63     the code with commercial support, indemnification, and middleware, under\r
64     the OpenRTOS brand: http://www.OpenRTOS.com.  High Integrity Systems also\r
65     provide a safety engineered and independently SIL3 certified version under\r
66     the SafeRTOS brand: http://www.SafeRTOS.com.\r
67 */\r
68 \r
69 /* Standard includes. */\r
70 #include <stdio.h>\r
71 #include <stdlib.h>\r
72 #include <string.h>\r
73 \r
74 /* Defining MPU_WRAPPERS_INCLUDED_FROM_API_FILE prevents task.h from redefining\r
75 all the API functions to use the MPU wrappers.  That should only be done when\r
76 task.h is included from an application file. */\r
77 #define MPU_WRAPPERS_INCLUDED_FROM_API_FILE\r
78 \r
79 /* FreeRTOS includes. */\r
80 #include "FreeRTOS.h"\r
81 #include "task.h"\r
82 #include "timers.h"\r
83 #include "StackMacros.h"\r
84 \r
85 #undef MPU_WRAPPERS_INCLUDED_FROM_API_FILE\r
86 \r
87 /*\r
88  * Defines the size, in words, of the stack allocated to the idle task.\r
89  */\r
90 #define tskIDLE_STACK_SIZE      configMINIMAL_STACK_SIZE\r
91 \r
92 /*\r
93  * Task control block.  A task control block (TCB) is allocated for each task,\r
94  * and stores task state information, including a pointer to the task's context\r
95  * (the task's run time environment, including register values)\r
96  */\r
97 typedef struct tskTaskControlBlock\r
98 {\r
99         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 TCB STRUCT. */\r
100 \r
101         #if ( portUSING_MPU_WRAPPERS == 1 )\r
102                 xMPU_SETTINGS xMPUSettings;                             /*< The MPU settings are defined as part of the port layer.  THIS MUST BE THE SECOND MEMBER OF THE TCB STRUCT. */\r
103         #endif\r
104 \r
105         xListItem                               xGenericListItem;               /*< The list that the state list item of a task is reference from denotes the state of that task (Ready, Blocked, Suspended ). */\r
106         xListItem                               xEventListItem;         /*< Used to reference a task from an event list. */\r
107         unsigned portBASE_TYPE  uxPriority;                     /*< The priority of the task.  0 is the lowest priority. */\r
108         portSTACK_TYPE                  *pxStack;                       /*< Points to the start of the stack. */\r
109         signed char                             pcTaskName[ configMAX_TASK_NAME_LEN ];/*< Descriptive name given to the task when created.  Facilitates debugging only. */\r
110 \r
111         #if ( portSTACK_GROWTH > 0 )\r
112                 portSTACK_TYPE *pxEndOfStack;                   /*< Points to the end of the stack on architectures where the stack grows up from low memory. */\r
113         #endif\r
114 \r
115         #if ( portCRITICAL_NESTING_IN_TCB == 1 )\r
116                 unsigned portBASE_TYPE uxCriticalNesting; /*< Holds the critical section nesting depth for ports that do not maintain their own count in the port layer. */\r
117         #endif\r
118 \r
119         #if ( configUSE_TRACE_FACILITY == 1 )\r
120                 unsigned portBASE_TYPE  uxTCBNumber;    /*< Stores a number that increments each time a TCB is created.  It allows debuggers to determine when a task has been deleted and then recreated. */\r
121                 unsigned portBASE_TYPE  uxTaskNumber;   /*< Stores a number specifically for use by third party trace code. */\r
122         #endif\r
123 \r
124         #if ( configUSE_MUTEXES == 1 )\r
125                 unsigned portBASE_TYPE uxBasePriority;  /*< The priority last assigned to the task - used by the priority inheritance mechanism. */\r
126         #endif\r
127 \r
128         #if ( configUSE_APPLICATION_TASK_TAG == 1 )\r
129                 pdTASK_HOOK_CODE pxTaskTag;\r
130         #endif\r
131 \r
132         #if ( configGENERATE_RUN_TIME_STATS == 1 )\r
133                 unsigned long ulRunTimeCounter;                 /*< Stores the amount of time the task has spent in the Running state. */\r
134         #endif\r
135 \r
136 } tskTCB;\r
137 \r
138 \r
139 /*\r
140  * Some kernel aware debuggers require the data the debugger needs access to to\r
141  * be global, rather than file scope.\r
142  */\r
143 #ifdef portREMOVE_STATIC_QUALIFIER\r
144         #define static\r
145 #endif\r
146 \r
147 /*lint -e956 */\r
148 PRIVILEGED_DATA tskTCB * volatile pxCurrentTCB = NULL;\r
149 \r
150 /* Lists for ready and blocked tasks. --------------------*/\r
151 PRIVILEGED_DATA static xList pxReadyTasksLists[ configMAX_PRIORITIES ]; /*< Prioritised ready tasks. */\r
152 PRIVILEGED_DATA static xList xDelayedTaskList1;                                                 /*< Delayed tasks. */\r
153 PRIVILEGED_DATA static xList xDelayedTaskList2;                                                 /*< Delayed tasks (two lists are used - one for delays that have overflowed the current tick count. */\r
154 PRIVILEGED_DATA static xList * volatile pxDelayedTaskList ;                             /*< Points to the delayed task list currently being used. */\r
155 PRIVILEGED_DATA static xList * volatile pxOverflowDelayedTaskList;              /*< Points to the delayed task list currently being used to hold tasks that have overflowed the current tick count. */\r
156 PRIVILEGED_DATA 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
157 \r
158 #if ( INCLUDE_vTaskDelete == 1 )\r
159 \r
160         PRIVILEGED_DATA static xList xTasksWaitingTermination;                          /*< Tasks that have been deleted - but the their memory not yet freed. */\r
161         PRIVILEGED_DATA static volatile unsigned portBASE_TYPE uxTasksDeleted = ( unsigned portBASE_TYPE ) 0U;\r
162 \r
163 #endif\r
164 \r
165 #if ( INCLUDE_vTaskSuspend == 1 )\r
166 \r
167         PRIVILEGED_DATA static xList xSuspendedTaskList;                                        /*< Tasks that are currently suspended. */\r
168 \r
169 #endif\r
170 \r
171 #if ( INCLUDE_xTaskGetIdleTaskHandle == 1 )\r
172 \r
173         PRIVILEGED_DATA static xTaskHandle xIdleTaskHandle = NULL;                      /*< Holds the handle of the idle task.  The idle task is created automatically when the scheduler is started. */\r
174 \r
175 #endif\r
176 \r
177 /* File private variables. --------------------------------*/\r
178 PRIVILEGED_DATA static volatile unsigned portBASE_TYPE uxCurrentNumberOfTasks   = ( unsigned portBASE_TYPE ) 0U;\r
179 PRIVILEGED_DATA static volatile portTickType xTickCount                                                 = ( portTickType ) 0U;\r
180 PRIVILEGED_DATA static unsigned portBASE_TYPE uxTopUsedPriority                                 = tskIDLE_PRIORITY;\r
181 PRIVILEGED_DATA static volatile unsigned portBASE_TYPE uxTopReadyPriority               = tskIDLE_PRIORITY;\r
182 PRIVILEGED_DATA static volatile signed portBASE_TYPE xSchedulerRunning                  = pdFALSE;\r
183 PRIVILEGED_DATA static volatile unsigned portBASE_TYPE uxSchedulerSuspended             = ( unsigned portBASE_TYPE ) pdFALSE;\r
184 PRIVILEGED_DATA static volatile unsigned portBASE_TYPE uxMissedTicks                    = ( unsigned portBASE_TYPE ) 0U;\r
185 PRIVILEGED_DATA static volatile portBASE_TYPE xMissedYield                                              = ( portBASE_TYPE ) pdFALSE;\r
186 PRIVILEGED_DATA static volatile portBASE_TYPE xNumOfOverflows                                   = ( portBASE_TYPE ) 0;\r
187 PRIVILEGED_DATA static unsigned portBASE_TYPE uxTaskNumber                                              = ( unsigned portBASE_TYPE ) 0U;\r
188 PRIVILEGED_DATA static volatile portTickType xNextTaskUnblockTime                               = ( portTickType ) portMAX_DELAY;\r
189 \r
190 #if ( configGENERATE_RUN_TIME_STATS == 1 )\r
191 \r
192         PRIVILEGED_DATA static char pcStatsString[ 50 ] ;\r
193         PRIVILEGED_DATA static unsigned long ulTaskSwitchedInTime = 0UL;        /*< Holds the value of a timer/counter the last time a task was switched in. */\r
194         PRIVILEGED_DATA static unsigned long ulTotalRunTime;                            /*< Holds the total amount of execution time as defined by the run time counter clock. */\r
195         static void prvGenerateRunTimeStatsForTasksInList( const signed char *pcWriteBuffer, xList *pxList, unsigned long ulTotalRunTimeDiv100 ) PRIVILEGED_FUNCTION;\r
196 \r
197 #endif\r
198 \r
199 /* Debugging and trace facilities private variables and macros. ------------*/\r
200 \r
201 /*\r
202  * The value used to fill the stack of a task when the task is created.  This\r
203  * is used purely for checking the high water mark for tasks.\r
204  */\r
205 #define tskSTACK_FILL_BYTE      ( 0xa5U )\r
206 \r
207 /*\r
208  * Macros used by vListTask to indicate which state a task is in.\r
209  */\r
210 #define tskBLOCKED_CHAR         ( ( signed char ) 'B' )\r
211 #define tskREADY_CHAR           ( ( signed char ) 'R' )\r
212 #define tskDELETED_CHAR         ( ( signed char ) 'D' )\r
213 #define tskSUSPENDED_CHAR       ( ( signed char ) 'S' )\r
214 \r
215 /*-----------------------------------------------------------*/\r
216 \r
217 #if ( configUSE_PORT_OPTIMISED_TASK_SELECTION == 0 )\r
218 \r
219         /* If configUSE_PORT_OPTIMISED_TASK_SELECTION is 0 then task selection is\r
220         performed in a generic way that is not optimised to any particular\r
221         microcontroller architecture. */\r
222 \r
223         /* uxTopReadyPriority holds the priority of the highest priority ready\r
224         state task. */\r
225         #define taskRECORD_READY_PRIORITY( uxPriority )                                                                                                                                         \\r
226         {                                                                                                                                                                                                                                       \\r
227                 if( ( uxPriority ) > uxTopReadyPriority )                                                                                                                                               \\r
228                 {                                                                                                                                                                                                                               \\r
229                         uxTopReadyPriority = ( uxPriority );                                                                                                                                            \\r
230                 }                                                                                                                                                                                                                               \\r
231         } /* taskRECORD_READY_PRIORITY */\r
232 \r
233         /*-----------------------------------------------------------*/\r
234 \r
235         #define taskSELECT_HIGHEST_PRIORITY_TASK()                                                                                                                                                      \\r
236         {                                                                                                                                                                                                                                       \\r
237                 /* Find the highest priority queue that contains ready tasks. */                                                                                                \\r
238                 while( listLIST_IS_EMPTY( &( pxReadyTasksLists[ uxTopReadyPriority ] ) ) )                                                                              \\r
239                 {                                                                                                                                                                                                                               \\r
240                         configASSERT( uxTopReadyPriority );                                                                                                                                                     \\r
241                         --uxTopReadyPriority;                                                                                                                                                                           \\r
242                 }                                                                                                                                                                                                                               \\r
243                                                                                                                                                                                                                                                 \\r
244                 /* listGET_OWNER_OF_NEXT_ENTRY indexes through the list, so the tasks of                                                                                \\r
245                 the     same priority get an equal share of the processor time. */                                                                                                      \\r
246                 listGET_OWNER_OF_NEXT_ENTRY( pxCurrentTCB, &( pxReadyTasksLists[ uxTopReadyPriority ] ) );                                              \\r
247         } /* taskSELECT_HIGHEST_PRIORITY_TASK */\r
248 \r
249         /*-----------------------------------------------------------*/\r
250 \r
251         /* Define away taskRESET_READY_PRIORITY() and portRESET_READY_PRIORITY() as\r
252         they are only required when a port optimised method of task selection is\r
253         being used. */\r
254         #define taskRESET_READY_PRIORITY( uxPriority )\r
255         #define portRESET_READY_PRIORITY( uxPriority, uxTopReadyPriority )\r
256 \r
257 #else /* configUSE_PORT_OPTIMISED_TASK_SELECTION */\r
258 \r
259         /* If configUSE_PORT_OPTIMISED_TASK_SELECTION is 1 then task selection is\r
260         performed in a way that is tailored to the particular microcontroller\r
261         architecture being used. */\r
262 \r
263         /* A port optimised version is provided.  Call the port defined macros. */\r
264         #define taskRECORD_READY_PRIORITY( uxPriority ) portRECORD_READY_PRIORITY( uxPriority, uxTopReadyPriority )\r
265 \r
266         /*-----------------------------------------------------------*/\r
267 \r
268         #define taskSELECT_HIGHEST_PRIORITY_TASK()                                                                                                              \\r
269         {                                                                                                                                                                                               \\r
270         unsigned portBASE_TYPE uxTopPriority;                                                                                                                   \\r
271                                                                                                                                                                                                         \\r
272                 /* Find the highest priority queue that contains ready tasks. */                                                        \\r
273                 portGET_HIGHEST_PRIORITY( uxTopPriority, uxTopReadyPriority );                                                          \\r
274                 configASSERT( listCURRENT_LIST_LENGTH( &( pxReadyTasksLists[ uxTopPriority ] ) ) > 0 );         \\r
275                 listGET_OWNER_OF_NEXT_ENTRY( pxCurrentTCB, &( pxReadyTasksLists[ uxTopPriority ] ) );           \\r
276         } /* taskSELECT_HIGHEST_PRIORITY_TASK() */\r
277 \r
278         /*-----------------------------------------------------------*/\r
279 \r
280         /* A port optimised version is provided, call it only if the TCB being reset\r
281         is being referenced from a ready list.  If it is referenced from a delayed\r
282         or suspended list then it won't be in a ready list. */\r
283         #define taskRESET_READY_PRIORITY( uxPriority )                                                                                                  \\r
284         {                                                                                                                                                                                               \\r
285                 if( listCURRENT_LIST_LENGTH( &( pxReadyTasksLists[ ( uxPriority ) ] ) ) == 0 )                          \\r
286                 {                                                                                                                                                                                       \\r
287                         portRESET_READY_PRIORITY( ( uxPriority ), ( uxTopReadyPriority ) );                                             \\r
288                 }                                                                                                                                                                                       \\r
289         }\r
290 \r
291 #endif /* configUSE_PORT_OPTIMISED_TASK_SELECTION */\r
292 \r
293 /*\r
294  * Place the task represented by pxTCB into the appropriate ready queue for\r
295  * the task.  It is inserted at the end of the list.  One quirk of this is\r
296  * that if the task being inserted is at the same priority as the currently\r
297  * executing task, then it will only be rescheduled after the currently\r
298  * executing task has been rescheduled.\r
299  */\r
300 #define prvAddTaskToReadyQueue( pxTCB )                                                                                                                                                         \\r
301         traceMOVED_TASK_TO_READY_STATE( pxTCB )                                                                                                                                                 \\r
302         taskRECORD_READY_PRIORITY( ( pxTCB )->uxPriority );                                                                                                                             \\r
303         vListInsertEnd( ( xList * ) &( pxReadyTasksLists[ ( pxTCB )->uxPriority ] ), &( ( pxTCB )->xGenericListItem ) )\r
304 /*-----------------------------------------------------------*/\r
305 \r
306 /*\r
307  * Macro that looks at the list of tasks that are currently delayed to see if\r
308  * any require waking.\r
309  *\r
310  * Tasks are stored in the queue in the order of their wake time - meaning\r
311  * once one tasks has been found whose timer has not expired we need not look\r
312  * any further down the list.\r
313  */\r
314 #define prvCheckDelayedTasks()                                                                                                                  \\r
315 {                                                                                                                                                                               \\r
316 portTickType xItemValue;                                                                                                                                \\r
317                                                                                                                                                                                 \\r
318         /* Is the tick count greater than or equal to the wake time of the first                        \\r
319         task referenced from the delayed tasks list? */                                                                         \\r
320         if( xTickCount >= xNextTaskUnblockTime )                                                                                        \\r
321         {                                                                                                                                                                       \\r
322                 for( ;; )                                                                                                                                               \\r
323                 {                                                                                                                                                               \\r
324                         if( listLIST_IS_EMPTY( pxDelayedTaskList ) != pdFALSE )                                         \\r
325                         {                                                                                                                                                       \\r
326                                 /* The delayed list is empty.  Set xNextTaskUnblockTime to the                  \\r
327                                 maximum possible value so it is extremely unlikely that the                             \\r
328                                 if( xTickCount >= xNextTaskUnblockTime ) test will pass next                    \\r
329                                 time through. */                                                                                                                \\r
330                                 xNextTaskUnblockTime = portMAX_DELAY;                                                                   \\r
331                                 break;                                                                                                                                  \\r
332                         }                                                                                                                                                       \\r
333                         else                                                                                                                                            \\r
334                         {                                                                                                                                                       \\r
335                                 /* The delayed list is not empty, get the value of the item at                  \\r
336                                 the head of the delayed list.  This is the time at which the                    \\r
337                                 task at the head of the delayed list should be removed from                             \\r
338                                 the Blocked state. */                                                                                                   \\r
339                                 pxTCB = ( tskTCB * ) listGET_OWNER_OF_HEAD_ENTRY( pxDelayedTaskList );  \\r
340                                 xItemValue = listGET_LIST_ITEM_VALUE( &( pxTCB->xGenericListItem ) );   \\r
341                                                                                                                                                                                 \\r
342                                 if( xTickCount < xItemValue )                                                                                   \\r
343                                 {                                                                                                                                               \\r
344                                         /* It is not time to unblock this item yet, but the item                        \\r
345                                         value is the time at which the task at the head of the                          \\r
346                                         blocked list should be removed from the Blocked state -                         \\r
347                                         so record the item value in xNextTaskUnblockTime. */                            \\r
348                                         xNextTaskUnblockTime = xItemValue;                                                                      \\r
349                                         break;                                                                                                                          \\r
350                                 }                                                                                                                                               \\r
351                                                                                                                                                                                 \\r
352                                 /* It is time to remove the item from the Blocked state. */                             \\r
353                                 uxListRemove( &( pxTCB->xGenericListItem ) );                                                   \\r
354                                                                                                                                                                                 \\r
355                                 /* Is the task waiting on an event also? */                                                             \\r
356                                 if( pxTCB->xEventListItem.pvContainer != NULL )                                                 \\r
357                                 {                                                                                                                                               \\r
358                                         uxListRemove( &( pxTCB->xEventListItem ) );                                                     \\r
359                                 }                                                                                                                                               \\r
360                                 prvAddTaskToReadyQueue( pxTCB );                                                                                \\r
361                         }                                                                                                                                                       \\r
362                 }                                                                                                                                                               \\r
363         }                                                                                                                                                                       \\r
364 }\r
365 /*-----------------------------------------------------------*/\r
366 \r
367 /*\r
368  * Several functions take an xTaskHandle parameter that can optionally be NULL,\r
369  * where NULL is used to indicate that the handle of the currently executing\r
370  * task should be used in place of the parameter.  This macro simply checks to\r
371  * see if the parameter is NULL and returns a pointer to the appropriate TCB.\r
372  */\r
373 #define prvGetTCBFromHandle( pxHandle ) ( ( ( pxHandle ) == NULL ) ? ( tskTCB * ) pxCurrentTCB : ( tskTCB * ) ( pxHandle ) )\r
374 \r
375 /* Callback function prototypes. --------------------------*/\r
376 extern void vApplicationStackOverflowHook( xTaskHandle pxTask, signed char *pcTaskName );\r
377 extern void vApplicationTickHook( void );\r
378 \r
379 /* File private functions. --------------------------------*/\r
380 \r
381 /*\r
382  * Utility to ready a TCB for a given task.  Mainly just copies the parameters\r
383  * into the TCB structure.\r
384  */\r
385 static void prvInitialiseTCBVariables( tskTCB *pxTCB, const signed char * const pcName, unsigned portBASE_TYPE uxPriority, const xMemoryRegion * const xRegions, unsigned short usStackDepth ) PRIVILEGED_FUNCTION;\r
386 \r
387 /*\r
388  * Utility to ready all the lists used by the scheduler.  This is called\r
389  * automatically upon the creation of the first task.\r
390  */\r
391 static void prvInitialiseTaskLists( void ) PRIVILEGED_FUNCTION;\r
392 \r
393 /*\r
394  * The idle task, which as all tasks is implemented as a never ending loop.\r
395  * The idle task is automatically created and added to the ready lists upon\r
396  * creation of the first user task.\r
397  *\r
398  * The portTASK_FUNCTION_PROTO() macro is used to allow port/compiler specific\r
399  * language extensions.  The equivalent prototype for this function is:\r
400  *\r
401  * void prvIdleTask( void *pvParameters );\r
402  *\r
403  */\r
404 static portTASK_FUNCTION_PROTO( prvIdleTask, pvParameters );\r
405 \r
406 /*\r
407  * Utility to free all memory allocated by the scheduler to hold a TCB,\r
408  * including the stack pointed to by the TCB.\r
409  *\r
410  * This does not free memory allocated by the task itself (i.e. memory\r
411  * allocated by calls to pvPortMalloc from within the tasks application code).\r
412  */\r
413 #if ( INCLUDE_vTaskDelete == 1 )\r
414 \r
415         static void prvDeleteTCB( tskTCB *pxTCB ) PRIVILEGED_FUNCTION;\r
416 \r
417 #endif\r
418 \r
419 /*\r
420  * Used only by the idle task.  This checks to see if anything has been placed\r
421  * in the list of tasks waiting to be deleted.  If so the task is cleaned up\r
422  * and its TCB deleted.\r
423  */\r
424 static void prvCheckTasksWaitingTermination( void ) PRIVILEGED_FUNCTION;\r
425 \r
426 /*\r
427  * The currently executing task is entering the Blocked state.  Add the task to\r
428  * either the current or the overflow delayed task list.\r
429  */\r
430 static void prvAddCurrentTaskToDelayedList( portTickType xTimeToWake ) PRIVILEGED_FUNCTION;\r
431 \r
432 /*\r
433  * Allocates memory from the heap for a TCB and associated stack.  Checks the\r
434  * allocation was successful.\r
435  */\r
436 static tskTCB *prvAllocateTCBAndStack( unsigned short usStackDepth, portSTACK_TYPE *puxStackBuffer ) PRIVILEGED_FUNCTION;\r
437 \r
438 /*\r
439  * Called from vTaskList.  vListTasks details all the tasks currently under\r
440  * control of the scheduler.  The tasks may be in one of a number of lists.\r
441  * prvListTaskWithinSingleList accepts a list and details the tasks from\r
442  * within just that list.\r
443  *\r
444  * THIS FUNCTION IS INTENDED FOR DEBUGGING ONLY, AND SHOULD NOT BE CALLED FROM\r
445  * NORMAL APPLICATION CODE.\r
446  */\r
447 #if ( configUSE_TRACE_FACILITY == 1 )\r
448 \r
449         static void prvListTaskWithinSingleList( const signed char *pcWriteBuffer, xList *pxList, signed char cStatus ) PRIVILEGED_FUNCTION;\r
450 \r
451 #endif\r
452 \r
453 /*\r
454  * When a task is created, the stack of the task is filled with a known value.\r
455  * This function determines the 'high water mark' of the task stack by\r
456  * determining how much of the stack remains at the original preset value.\r
457  */\r
458 #if ( ( configUSE_TRACE_FACILITY == 1 ) || ( INCLUDE_uxTaskGetStackHighWaterMark == 1 ) )\r
459 \r
460         static unsigned short usTaskCheckFreeStackSpace( const unsigned char * pucStackByte ) PRIVILEGED_FUNCTION;\r
461 \r
462 #endif\r
463 \r
464 /*\r
465  * Return the amount of time, in ticks, that will pass before the kernel will\r
466  * next move a task from the Blocked state to the Running state.\r
467  *\r
468  * This conditional compilation should use inequality to 0, not equality to 1.\r
469  * This is to ensure portSUPPRESS_TICKS_AND_SLEEP() can be called when user\r
470  * defined low power mode implementations require configUSE_TICKLESS_IDLE to be\r
471  * set to a value other than 1.\r
472  */\r
473 #if ( configUSE_TICKLESS_IDLE != 0 )\r
474 \r
475         static portTickType prvGetExpectedIdleTime( void ) PRIVILEGED_FUNCTION;\r
476 \r
477 #endif\r
478 \r
479 /*lint +e956 */\r
480 \r
481 signed portBASE_TYPE xTaskGenericCreate( pdTASK_CODE pxTaskCode, const signed char * const pcName, unsigned short usStackDepth, void *pvParameters, unsigned portBASE_TYPE uxPriority, xTaskHandle *pxCreatedTask, portSTACK_TYPE *puxStackBuffer, const xMemoryRegion * const xRegions )\r
482 {\r
483 signed portBASE_TYPE xReturn;\r
484 tskTCB * pxNewTCB;\r
485 \r
486         configASSERT( pxTaskCode );\r
487         configASSERT( ( ( uxPriority & ( ~portPRIVILEGE_BIT ) ) < configMAX_PRIORITIES ) );\r
488 \r
489         /* Allocate the memory required by the TCB and stack for the new task,\r
490         checking that the allocation was successful. */\r
491         pxNewTCB = prvAllocateTCBAndStack( usStackDepth, puxStackBuffer );\r
492 \r
493         if( pxNewTCB != NULL )\r
494         {\r
495                 portSTACK_TYPE *pxTopOfStack;\r
496 \r
497                 #if( portUSING_MPU_WRAPPERS == 1 )\r
498                         /* Should the task be created in privileged mode? */\r
499                         portBASE_TYPE xRunPrivileged;\r
500                         if( ( uxPriority & portPRIVILEGE_BIT ) != 0U )\r
501                         {\r
502                                 xRunPrivileged = pdTRUE;\r
503                         }\r
504                         else\r
505                         {\r
506                                 xRunPrivileged = pdFALSE;\r
507                         }\r
508                         uxPriority &= ~portPRIVILEGE_BIT;\r
509                 #endif /* portUSING_MPU_WRAPPERS == 1 */\r
510 \r
511                 /* Calculate the top of stack address.  This depends on whether the\r
512                 stack grows from high memory to low (as per the 80x86) or visa versa.\r
513                 portSTACK_GROWTH is used to make the result positive or negative as\r
514                 required by the port. */\r
515                 #if( portSTACK_GROWTH < 0 )\r
516                 {\r
517                         pxTopOfStack = pxNewTCB->pxStack + ( usStackDepth - ( unsigned short ) 1 );\r
518                         pxTopOfStack = ( portSTACK_TYPE * ) ( ( ( portPOINTER_SIZE_TYPE ) pxTopOfStack ) & ( ( portPOINTER_SIZE_TYPE ) ~portBYTE_ALIGNMENT_MASK  ) );\r
519 \r
520                         /* Check the alignment of the calculated top of stack is correct. */\r
521                         configASSERT( ( ( ( unsigned long ) pxTopOfStack & ( unsigned long ) portBYTE_ALIGNMENT_MASK ) == 0UL ) );\r
522                 }\r
523                 #else /* portSTACK_GROWTH */\r
524                 {\r
525                         pxTopOfStack = pxNewTCB->pxStack;\r
526 \r
527                         /* Check the alignment of the stack buffer is correct. */\r
528                         configASSERT( ( ( ( unsigned long ) pxNewTCB->pxStack & ( unsigned long ) portBYTE_ALIGNMENT_MASK ) == 0UL ) );\r
529 \r
530                         /* If we want to use stack checking on architectures that use\r
531                         a positive stack growth direction then we also need to store the\r
532                         other extreme of the stack space. */\r
533                         pxNewTCB->pxEndOfStack = pxNewTCB->pxStack + ( usStackDepth - 1 );\r
534                 }\r
535                 #endif /* portSTACK_GROWTH */\r
536 \r
537                 /* Setup the newly allocated TCB with the initial state of the task. */\r
538                 prvInitialiseTCBVariables( pxNewTCB, pcName, uxPriority, xRegions, usStackDepth );\r
539 \r
540                 /* Initialize the TCB stack to look as if the task was already running,\r
541                 but had been interrupted by the scheduler.  The return address is set\r
542                 to the start of the task function. Once the stack has been initialised\r
543                 the     top of stack variable is updated. */\r
544                 #if( portUSING_MPU_WRAPPERS == 1 )\r
545                 {\r
546                         pxNewTCB->pxTopOfStack = pxPortInitialiseStack( pxTopOfStack, pxTaskCode, pvParameters, xRunPrivileged );\r
547                 }\r
548                 #else /* portUSING_MPU_WRAPPERS */\r
549                 {\r
550                         pxNewTCB->pxTopOfStack = pxPortInitialiseStack( pxTopOfStack, pxTaskCode, pvParameters );\r
551                 }\r
552                 #endif /* portUSING_MPU_WRAPPERS */\r
553 \r
554                 /* Check the alignment of the initialised stack. */\r
555                 portALIGNMENT_ASSERT_pxCurrentTCB( ( ( ( unsigned long ) pxNewTCB->pxTopOfStack & ( unsigned long ) portBYTE_ALIGNMENT_MASK ) == 0UL ) );\r
556 \r
557                 if( ( void * ) pxCreatedTask != NULL )\r
558                 {\r
559                         /* Pass the TCB out - in an anonymous way.  The calling function/\r
560                         task can use this as a handle to delete the task later if\r
561                         required.*/\r
562                         *pxCreatedTask = ( xTaskHandle ) pxNewTCB;\r
563                 }\r
564 \r
565                 /* We are going to manipulate the task queues to add this task to a\r
566                 ready list, so must make sure no interrupts occur. */\r
567                 taskENTER_CRITICAL();\r
568                 {\r
569                         uxCurrentNumberOfTasks++;\r
570                         if( pxCurrentTCB == NULL )\r
571                         {\r
572                                 /* There are no other tasks, or all the other tasks are in\r
573                                 the suspended state - make this the current task. */\r
574                                 pxCurrentTCB =  pxNewTCB;\r
575 \r
576                                 if( uxCurrentNumberOfTasks == ( unsigned portBASE_TYPE ) 1 )\r
577                                 {\r
578                                         /* This is the first task to be created so do the preliminary\r
579                                         initialisation required.  We will not recover if this call\r
580                                         fails, but we will report the failure. */\r
581                                         prvInitialiseTaskLists();\r
582                                 }\r
583                         }\r
584                         else\r
585                         {\r
586                                 /* If the scheduler is not already running, make this task the\r
587                                 current task if it is the highest priority task to be created\r
588                                 so far. */\r
589                                 if( xSchedulerRunning == pdFALSE )\r
590                                 {\r
591                                         if( pxCurrentTCB->uxPriority <= uxPriority )\r
592                                         {\r
593                                                 pxCurrentTCB = pxNewTCB;\r
594                                         }\r
595                                 }\r
596                         }\r
597 \r
598                         /* Remember the top priority to make context switching faster.  Use\r
599                         the priority in pxNewTCB as this has been capped to a valid value. */\r
600                         if( pxNewTCB->uxPriority > uxTopUsedPriority )\r
601                         {\r
602                                 uxTopUsedPriority = pxNewTCB->uxPriority;\r
603                         }\r
604 \r
605                         #if ( configUSE_TRACE_FACILITY == 1 )\r
606                         {\r
607                                 /* Add a counter into the TCB for tracing only. */\r
608                                 pxNewTCB->uxTCBNumber = uxTaskNumber;\r
609                         }\r
610                         #endif /* configUSE_TRACE_FACILITY */\r
611                         uxTaskNumber++;\r
612                         traceTASK_CREATE( pxNewTCB );\r
613 \r
614                         prvAddTaskToReadyQueue( pxNewTCB );\r
615 \r
616                         xReturn = pdPASS;\r
617                         portSETUP_TCB( pxNewTCB );\r
618                 }\r
619                 taskEXIT_CRITICAL();\r
620         }\r
621         else\r
622         {\r
623                 xReturn = errCOULD_NOT_ALLOCATE_REQUIRED_MEMORY;\r
624                 traceTASK_CREATE_FAILED();\r
625         }\r
626 \r
627         if( xReturn == pdPASS )\r
628         {\r
629                 if( xSchedulerRunning != pdFALSE )\r
630                 {\r
631                         /* If the created task is of a higher priority than the current task\r
632                         then it should run now. */\r
633                         if( pxCurrentTCB->uxPriority < uxPriority )\r
634                         {\r
635                                 portYIELD_WITHIN_API();\r
636                         }\r
637                 }\r
638         }\r
639 \r
640         return xReturn;\r
641 }\r
642 /*-----------------------------------------------------------*/\r
643 \r
644 #if ( INCLUDE_vTaskDelete == 1 )\r
645 \r
646         void vTaskDelete( xTaskHandle pxTaskToDelete )\r
647         {\r
648         tskTCB *pxTCB;\r
649 \r
650                 taskENTER_CRITICAL();\r
651                 {\r
652                         /* Ensure a yield is performed if the current task is being\r
653                         deleted. */\r
654                         if( pxTaskToDelete == pxCurrentTCB )\r
655                         {\r
656                                 pxTaskToDelete = NULL;\r
657                         }\r
658 \r
659                         /* If null is passed in here then we are deleting ourselves. */\r
660                         pxTCB = prvGetTCBFromHandle( pxTaskToDelete );\r
661 \r
662                         /* Remove task from the ready list and place in the     termination list.\r
663                         This will stop the task from be scheduled.  The idle task will check\r
664                         the termination list and free up any memory allocated by the\r
665                         scheduler for the TCB and stack. */\r
666                         if( uxListRemove( ( xListItem * ) &( pxTCB->xGenericListItem ) ) == 0 )\r
667                         {\r
668                                 taskRESET_READY_PRIORITY( pxTCB->uxPriority );\r
669                         }\r
670 \r
671                         /* Is the task waiting on an event also? */\r
672                         if( pxTCB->xEventListItem.pvContainer != NULL )\r
673                         {\r
674                                 uxListRemove( &( pxTCB->xEventListItem ) );\r
675                         }\r
676 \r
677                         vListInsertEnd( ( xList * ) &xTasksWaitingTermination, &( pxTCB->xGenericListItem ) );\r
678 \r
679                         /* Increment the ucTasksDeleted variable so the idle task knows\r
680                         there is a task that has been deleted and that it should therefore\r
681                         check the xTasksWaitingTermination list. */\r
682                         ++uxTasksDeleted;\r
683 \r
684                         /* Increment the uxTaskNumberVariable also so kernel aware debuggers\r
685                         can detect that the task lists need re-generating. */\r
686                         uxTaskNumber++;\r
687 \r
688                         traceTASK_DELETE( pxTCB );\r
689                 }\r
690                 taskEXIT_CRITICAL();\r
691 \r
692                 /* Force a reschedule if we have just deleted the current task. */\r
693                 if( xSchedulerRunning != pdFALSE )\r
694                 {\r
695                         if( ( void * ) pxTaskToDelete == NULL )\r
696                         {\r
697                                 portYIELD_WITHIN_API();\r
698                         }\r
699                 }\r
700         }\r
701 \r
702 #endif /* INCLUDE_vTaskDelete */\r
703 /*-----------------------------------------------------------*/\r
704 \r
705 #if ( INCLUDE_vTaskDelayUntil == 1 )\r
706 \r
707         void vTaskDelayUntil( portTickType * const pxPreviousWakeTime, portTickType xTimeIncrement )\r
708         {\r
709         portTickType xTimeToWake;\r
710         portBASE_TYPE xAlreadyYielded, xShouldDelay = pdFALSE;\r
711 \r
712                 configASSERT( pxPreviousWakeTime );\r
713                 configASSERT( ( xTimeIncrement > 0U ) );\r
714 \r
715                 vTaskSuspendAll();\r
716                 {\r
717                         /* Generate the tick time at which the task wants to wake. */\r
718                         xTimeToWake = *pxPreviousWakeTime + xTimeIncrement;\r
719 \r
720                         if( xTickCount < *pxPreviousWakeTime )\r
721                         {\r
722                                 /* The tick count has overflowed since this function was\r
723                                 lasted called.  In this case the only time we should ever\r
724                                 actually delay is if the wake time has also     overflowed,\r
725                                 and the wake time is greater than the tick time.  When this\r
726                                 is the case it is as if neither time had overflowed. */\r
727                                 if( ( xTimeToWake < *pxPreviousWakeTime ) && ( xTimeToWake > xTickCount ) )\r
728                                 {\r
729                                         xShouldDelay = pdTRUE;\r
730                                 }\r
731                         }\r
732                         else\r
733                         {\r
734                                 /* The tick time has not overflowed.  In this case we will\r
735                                 delay if either the wake time has overflowed, and/or the\r
736                                 tick time is less than the wake time. */\r
737                                 if( ( xTimeToWake < *pxPreviousWakeTime ) || ( xTimeToWake > xTickCount ) )\r
738                                 {\r
739                                         xShouldDelay = pdTRUE;\r
740                                 }\r
741                         }\r
742 \r
743                         /* Update the wake time ready for the next call. */\r
744                         *pxPreviousWakeTime = xTimeToWake;\r
745 \r
746                         if( xShouldDelay != pdFALSE )\r
747                         {\r
748                                 traceTASK_DELAY_UNTIL();\r
749 \r
750                                 /* We must remove ourselves from the ready list before adding\r
751                                 ourselves to the blocked list as the same list item is used for\r
752                                 both lists. */\r
753                                 if( uxListRemove( ( xListItem * ) &( pxCurrentTCB->xGenericListItem ) ) == 0 )\r
754                                 {\r
755                                         /* The current task must be in a ready list, so there is\r
756                                         no need to check, and the port reset macro can be called\r
757                                         directly. */\r
758                                         portRESET_READY_PRIORITY( pxCurrentTCB->uxPriority, uxTopReadyPriority );\r
759                                 }\r
760 \r
761                                 prvAddCurrentTaskToDelayedList( xTimeToWake );\r
762                         }\r
763                 }\r
764                 xAlreadyYielded = xTaskResumeAll();\r
765 \r
766                 /* Force a reschedule if xTaskResumeAll has not already done so, we may\r
767                 have put ourselves to sleep. */\r
768                 if( xAlreadyYielded == pdFALSE )\r
769                 {\r
770                         portYIELD_WITHIN_API();\r
771                 }\r
772         }\r
773 \r
774 #endif /* INCLUDE_vTaskDelayUntil */\r
775 /*-----------------------------------------------------------*/\r
776 \r
777 #if ( INCLUDE_vTaskDelay == 1 )\r
778 \r
779         void vTaskDelay( portTickType xTicksToDelay )\r
780         {\r
781         portTickType xTimeToWake;\r
782         signed portBASE_TYPE xAlreadyYielded = pdFALSE;\r
783 \r
784                 /* A delay time of zero just forces a reschedule. */\r
785                 if( xTicksToDelay > ( portTickType ) 0U )\r
786                 {\r
787                         vTaskSuspendAll();\r
788                         {\r
789                                 traceTASK_DELAY();\r
790 \r
791                                 /* A task that is removed from the event list while the\r
792                                 scheduler is suspended will not get placed in the ready\r
793                                 list or removed from the blocked list until the scheduler\r
794                                 is resumed.\r
795 \r
796                                 This task cannot be in an event list as it is the currently\r
797                                 executing task. */\r
798 \r
799                                 /* Calculate the time to wake - this may overflow but this is\r
800                                 not a problem. */\r
801                                 xTimeToWake = xTickCount + xTicksToDelay;\r
802 \r
803                                 /* We must remove ourselves from the ready list before adding\r
804                                 ourselves to the blocked list as the same list item is used for\r
805                                 both lists. */\r
806                                 if( uxListRemove( ( xListItem * ) &( pxCurrentTCB->xGenericListItem ) ) == 0 )\r
807                                 {\r
808                                         /* The current task must be in a ready list, so there is\r
809                                         no need to check, and the port reset macro can be called\r
810                                         directly. */\r
811                                         portRESET_READY_PRIORITY( pxCurrentTCB->uxPriority, uxTopReadyPriority );\r
812                                 }\r
813                                 prvAddCurrentTaskToDelayedList( xTimeToWake );\r
814                         }\r
815                         xAlreadyYielded = xTaskResumeAll();\r
816                 }\r
817 \r
818                 /* Force a reschedule if xTaskResumeAll has not already done so, we may\r
819                 have put ourselves to sleep. */\r
820                 if( xAlreadyYielded == pdFALSE )\r
821                 {\r
822                         portYIELD_WITHIN_API();\r
823                 }\r
824         }\r
825 \r
826 #endif /* INCLUDE_vTaskDelay */\r
827 /*-----------------------------------------------------------*/\r
828 \r
829 #if ( INCLUDE_eTaskGetState == 1 )\r
830 \r
831         eTaskState eTaskGetState( xTaskHandle pxTask )\r
832         {\r
833         eTaskState eReturn;\r
834         xList *pxStateList;\r
835         tskTCB *pxTCB;\r
836 \r
837                 pxTCB = ( tskTCB * ) pxTask;\r
838 \r
839                 if( pxTCB == pxCurrentTCB )\r
840                 {\r
841                         /* The task calling this function is querying its own state. */\r
842                         eReturn = eRunning;\r
843                 }\r
844                 else\r
845                 {\r
846                         taskENTER_CRITICAL();\r
847                         {\r
848                                 pxStateList = ( xList * ) listLIST_ITEM_CONTAINER( &( pxTCB->xGenericListItem ) );\r
849                         }\r
850                         taskEXIT_CRITICAL();\r
851 \r
852                         if( ( pxStateList == pxDelayedTaskList ) || ( pxStateList == pxOverflowDelayedTaskList ) )\r
853                         {\r
854                                 /* The task being queried is referenced from one of the Blocked\r
855                                 lists. */\r
856                                 eReturn = eBlocked;\r
857                         }\r
858 \r
859                         #if ( INCLUDE_vTaskSuspend == 1 )\r
860                                 else if( pxStateList == &xSuspendedTaskList )\r
861                                 {\r
862                                         /* The task being queried is referenced from the suspended\r
863                                         list. */\r
864                                         eReturn = eSuspended;\r
865                                 }\r
866                         #endif\r
867 \r
868                         #if ( INCLUDE_vTaskDelete == 1 )\r
869                                 else if( pxStateList == &xTasksWaitingTermination )\r
870                                 {\r
871                                         /* The task being queried is referenced from the deleted\r
872                                         tasks list. */\r
873                                         eReturn = eDeleted;\r
874                                 }\r
875                         #endif\r
876 \r
877                         else\r
878                         {\r
879                                 /* If the task is not in any other state, it must be in the\r
880                                 Ready (including pending ready) state. */\r
881                                 eReturn = eReady;\r
882                         }\r
883                 }\r
884 \r
885                 return eReturn;\r
886         }\r
887 \r
888 #endif /* INCLUDE_eTaskGetState */\r
889 /*-----------------------------------------------------------*/\r
890 \r
891 #if ( INCLUDE_uxTaskPriorityGet == 1 )\r
892 \r
893         unsigned portBASE_TYPE uxTaskPriorityGet( xTaskHandle pxTask )\r
894         {\r
895         tskTCB *pxTCB;\r
896         unsigned portBASE_TYPE uxReturn;\r
897 \r
898                 taskENTER_CRITICAL();\r
899                 {\r
900                         /* If null is passed in here then we are changing the\r
901                         priority of the calling function. */\r
902                         pxTCB = prvGetTCBFromHandle( pxTask );\r
903                         uxReturn = pxTCB->uxPriority;\r
904                 }\r
905                 taskEXIT_CRITICAL();\r
906 \r
907                 return uxReturn;\r
908         }\r
909 \r
910 #endif /* INCLUDE_uxTaskPriorityGet */\r
911 /*-----------------------------------------------------------*/\r
912 \r
913 #if ( INCLUDE_vTaskPrioritySet == 1 )\r
914 \r
915         void vTaskPrioritySet( xTaskHandle pxTask, unsigned portBASE_TYPE uxNewPriority )\r
916         {\r
917         tskTCB *pxTCB;\r
918         unsigned portBASE_TYPE uxCurrentPriority, uxPriorityUsedOnEntry;\r
919         portBASE_TYPE xYieldRequired = pdFALSE;\r
920 \r
921                 configASSERT( ( uxNewPriority < configMAX_PRIORITIES ) );\r
922 \r
923                 /* Ensure the new priority is valid. */\r
924                 if( uxNewPriority >= configMAX_PRIORITIES )\r
925                 {\r
926                         uxNewPriority = configMAX_PRIORITIES - ( unsigned portBASE_TYPE ) 1U;\r
927                 }\r
928 \r
929                 taskENTER_CRITICAL();\r
930                 {\r
931                         if( pxTask == pxCurrentTCB )\r
932                         {\r
933                                 pxTask = NULL;\r
934                         }\r
935 \r
936                         /* If null is passed in here then we are changing the\r
937                         priority of the calling function. */\r
938                         pxTCB = prvGetTCBFromHandle( pxTask );\r
939 \r
940                         traceTASK_PRIORITY_SET( pxTCB, uxNewPriority );\r
941 \r
942                         #if ( configUSE_MUTEXES == 1 )\r
943                         {\r
944                                 uxCurrentPriority = pxTCB->uxBasePriority;\r
945                         }\r
946                         #else\r
947                         {\r
948                                 uxCurrentPriority = pxTCB->uxPriority;\r
949                         }\r
950                         #endif\r
951 \r
952                         if( uxCurrentPriority != uxNewPriority )\r
953                         {\r
954                                 /* The priority change may have readied a task of higher\r
955                                 priority than the calling task. */\r
956                                 if( uxNewPriority > uxCurrentPriority )\r
957                                 {\r
958                                         if( pxTask != NULL )\r
959                                         {\r
960                                                 /* The priority of another task is being raised.  If we\r
961                                                 were raising the priority of the currently running task\r
962                                                 there would be no need to switch as it must have already\r
963                                                 been the highest priority task. */\r
964                                                 xYieldRequired = pdTRUE;\r
965                                         }\r
966                                 }\r
967                                 else if( pxTask == NULL )\r
968                                 {\r
969                                         /* Setting our own priority down means there may now be another\r
970                                         task of higher priority that is ready to execute. */\r
971                                         xYieldRequired = pdTRUE;\r
972                                 }\r
973 \r
974                                 /* Remember the ready list the task might be referenced from\r
975                                 before its uxPriority member is changed so the\r
976                                 taskRESET_READY_PRIORITY() macro can function correctly. */\r
977                                 uxPriorityUsedOnEntry = pxTCB->uxPriority;\r
978 \r
979                                 #if ( configUSE_MUTEXES == 1 )\r
980                                 {\r
981                                         /* Only change the priority being used if the task is not\r
982                                         currently using an inherited priority. */\r
983                                         if( pxTCB->uxBasePriority == pxTCB->uxPriority )\r
984                                         {\r
985                                                 pxTCB->uxPriority = uxNewPriority;\r
986                                         }\r
987 \r
988                                         /* The base priority gets set whatever. */\r
989                                         pxTCB->uxBasePriority = uxNewPriority;\r
990                                 }\r
991                                 #else\r
992                                 {\r
993                                         pxTCB->uxPriority = uxNewPriority;\r
994                                 }\r
995                                 #endif\r
996 \r
997                                 listSET_LIST_ITEM_VALUE( &( pxTCB->xEventListItem ), ( configMAX_PRIORITIES - ( portTickType ) uxNewPriority ) );\r
998 \r
999                                 /* If the task is in the blocked or suspended list we need do\r
1000                                 nothing more than change it's priority variable. However, if\r
1001                                 the task is in a ready list it needs to be removed and placed\r
1002                                 in the queue appropriate to its new priority. */\r
1003                                 if( listIS_CONTAINED_WITHIN( &( pxReadyTasksLists[ uxCurrentPriority ] ), &( pxTCB->xGenericListItem ) ) )\r
1004                                 {\r
1005                                         /* The task is currently in its ready list - remove before adding\r
1006                                         it to it's new ready list.  As we are in a critical section we\r
1007                                         can do this even if the scheduler is suspended. */\r
1008                                         if( uxListRemove( ( xListItem * ) &( pxTCB->xGenericListItem ) ) == 0 )\r
1009                                         {\r
1010                                                 taskRESET_READY_PRIORITY( uxPriorityUsedOnEntry );\r
1011                                         }\r
1012                                         prvAddTaskToReadyQueue( pxTCB );\r
1013                                 }\r
1014 \r
1015                                 if( xYieldRequired == pdTRUE )\r
1016                                 {\r
1017                                         portYIELD_WITHIN_API();\r
1018                                 }\r
1019                         }\r
1020                 }\r
1021                 taskEXIT_CRITICAL();\r
1022 \r
1023                 /* Remove compiler warning about unused parameter when the port\r
1024                 optimised task selection is not being used. */\r
1025                 ( void ) uxPriorityUsedOnEntry;\r
1026         }\r
1027 \r
1028 #endif /* INCLUDE_vTaskPrioritySet */\r
1029 /*-----------------------------------------------------------*/\r
1030 \r
1031 #if ( INCLUDE_vTaskSuspend == 1 )\r
1032 \r
1033         void vTaskSuspend( xTaskHandle pxTaskToSuspend )\r
1034         {\r
1035         tskTCB *pxTCB;\r
1036 \r
1037                 taskENTER_CRITICAL();\r
1038                 {\r
1039                         /* Ensure a yield is performed if the current task is being\r
1040                         suspended. */\r
1041                         if( pxTaskToSuspend == pxCurrentTCB )\r
1042                         {\r
1043                                 pxTaskToSuspend = NULL;\r
1044                         }\r
1045 \r
1046                         /* If null is passed in here then we are suspending ourselves. */\r
1047                         pxTCB = prvGetTCBFromHandle( pxTaskToSuspend );\r
1048 \r
1049                         traceTASK_SUSPEND( pxTCB );\r
1050 \r
1051                         /* Remove task from the ready/delayed list and place in the     suspended list. */\r
1052                         if( uxListRemove( ( xListItem * ) &( pxTCB->xGenericListItem ) ) == 0 )\r
1053                         {\r
1054                                 taskRESET_READY_PRIORITY( pxTCB->uxPriority );\r
1055                         }\r
1056 \r
1057                         /* Is the task waiting on an event also? */\r
1058                         if( pxTCB->xEventListItem.pvContainer != NULL )\r
1059                         {\r
1060                                 uxListRemove( &( pxTCB->xEventListItem ) );\r
1061                         }\r
1062 \r
1063                         vListInsertEnd( ( xList * ) &xSuspendedTaskList, &( pxTCB->xGenericListItem ) );\r
1064                 }\r
1065                 taskEXIT_CRITICAL();\r
1066 \r
1067                 if( ( void * ) pxTaskToSuspend == NULL )\r
1068                 {\r
1069                         if( xSchedulerRunning != pdFALSE )\r
1070                         {\r
1071                                 /* We have just suspended the current task. */\r
1072                                 portYIELD_WITHIN_API();\r
1073                         }\r
1074                         else\r
1075                         {\r
1076                                 /* The scheduler is not running, but the task that was pointed\r
1077                                 to by pxCurrentTCB has just been suspended and pxCurrentTCB\r
1078                                 must be adjusted to point to a different task. */\r
1079                                 if( listCURRENT_LIST_LENGTH( &xSuspendedTaskList ) == uxCurrentNumberOfTasks )\r
1080                                 {\r
1081                                         /* No other tasks are ready, so set pxCurrentTCB back to\r
1082                                         NULL so when the next task is created pxCurrentTCB will\r
1083                                         be set to point to it no matter what its relative priority\r
1084                                         is. */\r
1085                                         pxCurrentTCB = NULL;\r
1086                                 }\r
1087                                 else\r
1088                                 {\r
1089                                         vTaskSwitchContext();\r
1090                                 }\r
1091                         }\r
1092                 }\r
1093         }\r
1094 \r
1095 #endif /* INCLUDE_vTaskSuspend */\r
1096 /*-----------------------------------------------------------*/\r
1097 \r
1098 #if ( INCLUDE_vTaskSuspend == 1 )\r
1099 \r
1100         signed portBASE_TYPE xTaskIsTaskSuspended( xTaskHandle xTask )\r
1101         {\r
1102         portBASE_TYPE xReturn = pdFALSE;\r
1103         const tskTCB * const pxTCB = ( tskTCB * ) xTask;\r
1104 \r
1105                 /* It does not make sense to check if the calling task is suspended. */\r
1106                 configASSERT( xTask );\r
1107 \r
1108                 /* Is the task we are attempting to resume actually in the\r
1109                 suspended list? */\r
1110                 if( listIS_CONTAINED_WITHIN( &xSuspendedTaskList, &( pxTCB->xGenericListItem ) ) != pdFALSE )\r
1111                 {\r
1112                         /* Has the task already been resumed from within an ISR? */\r
1113                         if( listIS_CONTAINED_WITHIN( &xPendingReadyList, &( pxTCB->xEventListItem ) ) != pdTRUE )\r
1114                         {\r
1115                                 /* Is it in the suspended list because it is in the\r
1116                                 Suspended state?  It is possible to be in the suspended\r
1117                                 list because it is blocked on a task with no timeout\r
1118                                 specified. */\r
1119                                 if( listIS_CONTAINED_WITHIN( NULL, &( pxTCB->xEventListItem ) ) == pdTRUE )\r
1120                                 {\r
1121                                         xReturn = pdTRUE;\r
1122                                 }\r
1123                         }\r
1124                 }\r
1125 \r
1126                 return xReturn;\r
1127         }\r
1128 \r
1129 #endif /* INCLUDE_vTaskSuspend */\r
1130 /*-----------------------------------------------------------*/\r
1131 \r
1132 #if ( INCLUDE_vTaskSuspend == 1 )\r
1133 \r
1134         void vTaskResume( xTaskHandle pxTaskToResume )\r
1135         {\r
1136         tskTCB *pxTCB;\r
1137 \r
1138                 /* It does not make sense to resume the calling task. */\r
1139                 configASSERT( pxTaskToResume );\r
1140 \r
1141                 /* Remove the task from whichever list it is currently in, and place\r
1142                 it in the ready list. */\r
1143                 pxTCB = ( tskTCB * ) pxTaskToResume;\r
1144 \r
1145                 /* The parameter cannot be NULL as it is impossible to resume the\r
1146                 currently executing task. */\r
1147                 if( ( pxTCB != NULL ) && ( pxTCB != pxCurrentTCB ) )\r
1148                 {\r
1149                         taskENTER_CRITICAL();\r
1150                         {\r
1151                                 if( xTaskIsTaskSuspended( pxTCB ) == pdTRUE )\r
1152                                 {\r
1153                                         traceTASK_RESUME( pxTCB );\r
1154 \r
1155                                         /* As we are in a critical section we can access the ready\r
1156                                         lists even if the scheduler is suspended. */\r
1157                                         uxListRemove(  &( pxTCB->xGenericListItem ) );\r
1158                                         prvAddTaskToReadyQueue( pxTCB );\r
1159 \r
1160                                         /* We may have just resumed a higher priority task. */\r
1161                                         if( pxTCB->uxPriority >= pxCurrentTCB->uxPriority )\r
1162                                         {\r
1163                                                 /* This yield may not cause the task just resumed to run, but\r
1164                                                 will leave the lists in the correct state for the next yield. */\r
1165                                                 portYIELD_WITHIN_API();\r
1166                                         }\r
1167                                 }\r
1168                         }\r
1169                         taskEXIT_CRITICAL();\r
1170                 }\r
1171         }\r
1172 \r
1173 #endif /* INCLUDE_vTaskSuspend */\r
1174 \r
1175 /*-----------------------------------------------------------*/\r
1176 \r
1177 #if ( ( INCLUDE_xTaskResumeFromISR == 1 ) && ( INCLUDE_vTaskSuspend == 1 ) )\r
1178 \r
1179         portBASE_TYPE xTaskResumeFromISR( xTaskHandle pxTaskToResume )\r
1180         {\r
1181         portBASE_TYPE xYieldRequired = pdFALSE;\r
1182         tskTCB *pxTCB;\r
1183         unsigned portBASE_TYPE uxSavedInterruptStatus;\r
1184 \r
1185                 configASSERT( pxTaskToResume );\r
1186 \r
1187                 pxTCB = ( tskTCB * ) pxTaskToResume;\r
1188 \r
1189                 uxSavedInterruptStatus = portSET_INTERRUPT_MASK_FROM_ISR();\r
1190                 {\r
1191                         if( xTaskIsTaskSuspended( pxTCB ) == pdTRUE )\r
1192                         {\r
1193                                 traceTASK_RESUME_FROM_ISR( pxTCB );\r
1194 \r
1195                                 if( uxSchedulerSuspended == ( unsigned portBASE_TYPE ) pdFALSE )\r
1196                                 {\r
1197                                         xYieldRequired = ( pxTCB->uxPriority >= pxCurrentTCB->uxPriority );\r
1198                                         uxListRemove(  &( pxTCB->xGenericListItem ) );\r
1199                                         prvAddTaskToReadyQueue( pxTCB );\r
1200                                 }\r
1201                                 else\r
1202                                 {\r
1203                                         /* We cannot access the delayed or ready lists, so will hold this\r
1204                                         task pending until the scheduler is resumed, at which point a\r
1205                                         yield will be performed if necessary. */\r
1206                                         vListInsertEnd( ( xList * ) &( xPendingReadyList ), &( pxTCB->xEventListItem ) );\r
1207                                 }\r
1208                         }\r
1209                 }\r
1210                 portCLEAR_INTERRUPT_MASK_FROM_ISR( uxSavedInterruptStatus );\r
1211 \r
1212                 return xYieldRequired;\r
1213         }\r
1214 \r
1215 #endif /* ( ( INCLUDE_xTaskResumeFromISR == 1 ) && ( INCLUDE_vTaskSuspend == 1 ) ) */\r
1216 /*-----------------------------------------------------------*/\r
1217 \r
1218 void vTaskStartScheduler( void )\r
1219 {\r
1220 portBASE_TYPE xReturn;\r
1221 \r
1222         /* Add the idle task at the lowest priority. */\r
1223         #if ( INCLUDE_xTaskGetIdleTaskHandle == 1 )\r
1224         {\r
1225                 /* Create the idle task, storing its handle in xIdleTaskHandle so it can\r
1226                 be returned by the xTaskGetIdleTaskHandle() function. */\r
1227                 xReturn = xTaskCreate( prvIdleTask, ( signed char * ) "IDLE", tskIDLE_STACK_SIZE, ( void * ) NULL, ( tskIDLE_PRIORITY | portPRIVILEGE_BIT ), &xIdleTaskHandle );\r
1228         }\r
1229         #else\r
1230         {\r
1231                 /* Create the idle task without storing its handle. */\r
1232                 xReturn = xTaskCreate( prvIdleTask, ( signed char * ) "IDLE", tskIDLE_STACK_SIZE, ( void * ) NULL, ( tskIDLE_PRIORITY | portPRIVILEGE_BIT ), NULL );\r
1233         }\r
1234         #endif /* INCLUDE_xTaskGetIdleTaskHandle */\r
1235 \r
1236         #if ( configUSE_TIMERS == 1 )\r
1237         {\r
1238                 if( xReturn == pdPASS )\r
1239                 {\r
1240                         xReturn = xTimerCreateTimerTask();\r
1241                 }\r
1242         }\r
1243         #endif /* configUSE_TIMERS */\r
1244 \r
1245         if( xReturn == pdPASS )\r
1246         {\r
1247                 /* Interrupts are turned off here, to ensure a tick does not occur\r
1248                 before or during the call to xPortStartScheduler().  The stacks of\r
1249                 the created tasks contain a status word with interrupts switched on\r
1250                 so interrupts will automatically get re-enabled when the first task\r
1251                 starts to run.\r
1252 \r
1253                 STEPPING THROUGH HERE USING A DEBUGGER CAN CAUSE BIG PROBLEMS IF THE\r
1254                 DEBUGGER ALLOWS INTERRUPTS TO BE PROCESSED. */\r
1255                 portDISABLE_INTERRUPTS();\r
1256 \r
1257                 xSchedulerRunning = pdTRUE;\r
1258                 xTickCount = ( portTickType ) 0U;\r
1259 \r
1260                 /* If configGENERATE_RUN_TIME_STATS is defined then the following\r
1261                 macro must be defined to configure the timer/counter used to generate\r
1262                 the run time counter time base. */\r
1263                 portCONFIGURE_TIMER_FOR_RUN_TIME_STATS();\r
1264 \r
1265                 /* Setting up the timer tick is hardware specific and thus in the\r
1266                 portable interface. */\r
1267                 if( xPortStartScheduler() != pdFALSE )\r
1268                 {\r
1269                         /* Should not reach here as if the scheduler is running the\r
1270                         function will not return. */\r
1271                 }\r
1272                 else\r
1273                 {\r
1274                         /* Should only reach here if a task calls xTaskEndScheduler(). */\r
1275                 }\r
1276         }\r
1277 \r
1278         /* This line will only be reached if the kernel could not be started, or\r
1279         vTaskEndScheduler() was called (vTaskEndScheduler() is not implemented for\r
1280         most ports). */\r
1281         configASSERT( xReturn );\r
1282 }\r
1283 /*-----------------------------------------------------------*/\r
1284 \r
1285 void vTaskEndScheduler( void )\r
1286 {\r
1287         /* Stop the scheduler interrupts and call the portable scheduler end\r
1288         routine so the original ISRs can be restored if necessary.  The port\r
1289         layer must ensure interrupts enable     bit is left in the correct state. */\r
1290         portDISABLE_INTERRUPTS();\r
1291         xSchedulerRunning = pdFALSE;\r
1292         vPortEndScheduler();\r
1293 }\r
1294 /*----------------------------------------------------------*/\r
1295 \r
1296 void vTaskSuspendAll( void )\r
1297 {\r
1298         /* A critical section is not required as the variable is of type\r
1299         portBASE_TYPE. */\r
1300         ++uxSchedulerSuspended;\r
1301 }\r
1302 /*----------------------------------------------------------*/\r
1303 \r
1304 #if ( configUSE_TICKLESS_IDLE != 0 )\r
1305 \r
1306         static portTickType prvGetExpectedIdleTime( void )\r
1307         {\r
1308         portTickType xReturn;\r
1309 \r
1310                 if( pxCurrentTCB->uxPriority > tskIDLE_PRIORITY )\r
1311                 {\r
1312                         xReturn = 0;\r
1313                 }\r
1314                 else if( listCURRENT_LIST_LENGTH( &( pxReadyTasksLists[ tskIDLE_PRIORITY ] ) ) > 1 )\r
1315                 {\r
1316                         /* There are other idle priority tasks in the ready state.  If\r
1317                         time slicing is used then the very next tick interrupt must be\r
1318                         processed. */\r
1319                         xReturn = 0;\r
1320                 }\r
1321                 else\r
1322                 {\r
1323                         xReturn = xNextTaskUnblockTime - xTickCount;\r
1324                 }\r
1325 \r
1326                 return xReturn;\r
1327         }\r
1328 \r
1329 #endif /* configUSE_TICKLESS_IDLE */\r
1330 /*----------------------------------------------------------*/\r
1331 \r
1332 signed portBASE_TYPE xTaskResumeAll( void )\r
1333 {\r
1334 register tskTCB *pxTCB;\r
1335 signed portBASE_TYPE xAlreadyYielded = pdFALSE;\r
1336 \r
1337         /* If uxSchedulerSuspended is zero then this function does not match a\r
1338         previous call to vTaskSuspendAll(). */\r
1339         configASSERT( uxSchedulerSuspended );\r
1340 \r
1341         /* It is possible that an ISR caused a task to be removed from an event\r
1342         list while the scheduler was suspended.  If this was the case then the\r
1343         removed task will have been added to the xPendingReadyList.  Once the\r
1344         scheduler has been resumed it is safe to move all the pending ready\r
1345         tasks from this list into their appropriate ready list. */\r
1346         taskENTER_CRITICAL();\r
1347         {\r
1348                 --uxSchedulerSuspended;\r
1349 \r
1350                 if( uxSchedulerSuspended == ( unsigned portBASE_TYPE ) pdFALSE )\r
1351                 {\r
1352                         if( uxCurrentNumberOfTasks > ( unsigned portBASE_TYPE ) 0U )\r
1353                         {\r
1354                                 portBASE_TYPE xYieldRequired = pdFALSE;\r
1355 \r
1356                                 /* Move any readied tasks from the pending list into the\r
1357                                 appropriate ready list. */\r
1358                                 while( listLIST_IS_EMPTY( ( xList * ) &xPendingReadyList ) == pdFALSE )\r
1359                                 {\r
1360                                         pxTCB = ( tskTCB * ) listGET_OWNER_OF_HEAD_ENTRY(  ( ( xList * ) &xPendingReadyList ) );\r
1361                                         uxListRemove( &( pxTCB->xEventListItem ) );\r
1362                                         uxListRemove( &( pxTCB->xGenericListItem ) );\r
1363                                         prvAddTaskToReadyQueue( pxTCB );\r
1364 \r
1365                                         /* If we have moved a task that has a priority higher than\r
1366                                         the current task then we should yield. */\r
1367                                         if( pxTCB->uxPriority >= pxCurrentTCB->uxPriority )\r
1368                                         {\r
1369                                                 xYieldRequired = pdTRUE;\r
1370                                         }\r
1371                                 }\r
1372 \r
1373                                 /* If any ticks occurred while the scheduler was suspended then\r
1374                                 they should be processed now.  This ensures the tick count does not\r
1375                                 slip, and that any delayed tasks are resumed at the correct time. */\r
1376                                 if( uxMissedTicks > ( unsigned portBASE_TYPE ) 0U )\r
1377                                 {\r
1378                                         while( uxMissedTicks > ( unsigned portBASE_TYPE ) 0U )\r
1379                                         {\r
1380                                                 vTaskIncrementTick();\r
1381                                                 --uxMissedTicks;\r
1382                                         }\r
1383 \r
1384                                         /* As we have processed some ticks it is appropriate to yield\r
1385                                         to ensure the highest priority task that is ready to run is\r
1386                                         the task actually running. */\r
1387                                         #if configUSE_PREEMPTION == 1\r
1388                                         {\r
1389                                                 xYieldRequired = pdTRUE;\r
1390                                         }\r
1391                                         #endif\r
1392                                 }\r
1393 \r
1394                                 if( ( xYieldRequired == pdTRUE ) || ( xMissedYield == pdTRUE ) )\r
1395                                 {\r
1396                                         xAlreadyYielded = pdTRUE;\r
1397                                         xMissedYield = pdFALSE;\r
1398                                         portYIELD_WITHIN_API();\r
1399                                 }\r
1400                         }\r
1401                 }\r
1402         }\r
1403         taskEXIT_CRITICAL();\r
1404 \r
1405         return xAlreadyYielded;\r
1406 }\r
1407 /*-----------------------------------------------------------*/\r
1408 \r
1409 portTickType xTaskGetTickCount( void )\r
1410 {\r
1411 portTickType xTicks;\r
1412 \r
1413         /* Critical section required if running on a 16 bit processor. */\r
1414         taskENTER_CRITICAL();\r
1415         {\r
1416                 xTicks = xTickCount;\r
1417         }\r
1418         taskEXIT_CRITICAL();\r
1419 \r
1420         return xTicks;\r
1421 }\r
1422 /*-----------------------------------------------------------*/\r
1423 \r
1424 portTickType xTaskGetTickCountFromISR( void )\r
1425 {\r
1426 portTickType xReturn;\r
1427 unsigned portBASE_TYPE uxSavedInterruptStatus;\r
1428 \r
1429         uxSavedInterruptStatus = portSET_INTERRUPT_MASK_FROM_ISR();\r
1430         xReturn = xTickCount;\r
1431         portCLEAR_INTERRUPT_MASK_FROM_ISR( uxSavedInterruptStatus );\r
1432 \r
1433         return xReturn;\r
1434 }\r
1435 /*-----------------------------------------------------------*/\r
1436 \r
1437 unsigned portBASE_TYPE uxTaskGetNumberOfTasks( void )\r
1438 {\r
1439         /* A critical section is not required because the variables are of type\r
1440         portBASE_TYPE. */\r
1441         return uxCurrentNumberOfTasks;\r
1442 }\r
1443 /*-----------------------------------------------------------*/\r
1444 \r
1445 #if ( INCLUDE_pcTaskGetTaskName == 1 )\r
1446 \r
1447         signed char *pcTaskGetTaskName( xTaskHandle xTaskToQuery )\r
1448         {\r
1449         tskTCB *pxTCB;\r
1450 \r
1451                 /* If null is passed in here then the name of the calling task is being queried. */\r
1452                 pxTCB = prvGetTCBFromHandle( xTaskToQuery );\r
1453                 configASSERT( pxTCB );\r
1454                 return &( pxTCB->pcTaskName[ 0 ] );\r
1455         }\r
1456 \r
1457 #endif /* INCLUDE_pcTaskGetTaskName */\r
1458 /*-----------------------------------------------------------*/\r
1459 \r
1460 #if ( configUSE_TRACE_FACILITY == 1 )\r
1461 \r
1462         void vTaskList( signed char *pcWriteBuffer )\r
1463         {\r
1464         unsigned portBASE_TYPE uxQueue;\r
1465 \r
1466                 /* This is a VERY costly function that should be used for debug only.\r
1467                 It leaves interrupts disabled for a LONG time. */\r
1468 \r
1469                 vTaskSuspendAll();\r
1470                 {\r
1471                         /* Run through all the lists that could potentially contain a TCB and\r
1472                         report the task name, state and stack high water mark. */\r
1473 \r
1474                         *pcWriteBuffer = ( signed char ) 0x00;\r
1475                         strcat( ( char * ) pcWriteBuffer, ( const char * ) "\r\n" );\r
1476 \r
1477                         uxQueue = uxTopUsedPriority + ( unsigned portBASE_TYPE ) 1U;\r
1478 \r
1479                         do\r
1480                         {\r
1481                                 uxQueue--;\r
1482 \r
1483                                 if( listLIST_IS_EMPTY( &( pxReadyTasksLists[ uxQueue ] ) ) == pdFALSE )\r
1484                                 {\r
1485                                         prvListTaskWithinSingleList( pcWriteBuffer, ( xList * ) &( pxReadyTasksLists[ uxQueue ] ), tskREADY_CHAR );\r
1486                                 }\r
1487                         }while( uxQueue > ( unsigned short ) tskIDLE_PRIORITY );\r
1488 \r
1489                         if( listLIST_IS_EMPTY( pxDelayedTaskList ) == pdFALSE )\r
1490                         {\r
1491                                 prvListTaskWithinSingleList( pcWriteBuffer, ( xList * ) pxDelayedTaskList, tskBLOCKED_CHAR );\r
1492                         }\r
1493 \r
1494                         if( listLIST_IS_EMPTY( pxOverflowDelayedTaskList ) == pdFALSE )\r
1495                         {\r
1496                                 prvListTaskWithinSingleList( pcWriteBuffer, ( xList * ) pxOverflowDelayedTaskList, tskBLOCKED_CHAR );\r
1497                         }\r
1498 \r
1499                         #if( INCLUDE_vTaskDelete == 1 )\r
1500                         {\r
1501                                 if( listLIST_IS_EMPTY( &xTasksWaitingTermination ) == pdFALSE )\r
1502                                 {\r
1503                                         prvListTaskWithinSingleList( pcWriteBuffer, &xTasksWaitingTermination, tskDELETED_CHAR );\r
1504                                 }\r
1505                         }\r
1506                         #endif\r
1507 \r
1508                         #if ( INCLUDE_vTaskSuspend == 1 )\r
1509                         {\r
1510                                 if( listLIST_IS_EMPTY( &xSuspendedTaskList ) == pdFALSE )\r
1511                                 {\r
1512                                         prvListTaskWithinSingleList( pcWriteBuffer, &xSuspendedTaskList, tskSUSPENDED_CHAR );\r
1513                                 }\r
1514                         }\r
1515                         #endif\r
1516                 }\r
1517                 xTaskResumeAll();\r
1518         }\r
1519 \r
1520 #endif /* configUSE_TRACE_FACILITY */\r
1521 /*----------------------------------------------------------*/\r
1522 \r
1523 #if ( configGENERATE_RUN_TIME_STATS == 1 )\r
1524 \r
1525         void vTaskGetRunTimeStats( signed char *pcWriteBuffer )\r
1526         {\r
1527         unsigned portBASE_TYPE uxQueue;\r
1528         unsigned long ulTotalRunTimeDiv100;\r
1529 \r
1530                 /* This is a VERY costly function that should be used for debug only.\r
1531                 It leaves interrupts disabled for a LONG time. */\r
1532 \r
1533                 vTaskSuspendAll();\r
1534                 {\r
1535                         #ifdef portALT_GET_RUN_TIME_COUNTER_VALUE\r
1536                                 portALT_GET_RUN_TIME_COUNTER_VALUE( ulTotalRunTime );\r
1537                         #else\r
1538                                 ulTotalRunTime = portGET_RUN_TIME_COUNTER_VALUE();\r
1539                         #endif\r
1540 \r
1541                         /* Divide ulTotalRunTime by 100 to make the percentage caluclations\r
1542                         simpler in the prvGenerateRunTimeStatsForTasksInList() function. */\r
1543                         ulTotalRunTimeDiv100 = ulTotalRunTime / 100UL;\r
1544 \r
1545                         /* Run through all the lists that could potentially contain a TCB,\r
1546                         generating a table of run timer percentages in the provided\r
1547                         buffer. */\r
1548 \r
1549                         *pcWriteBuffer = ( signed char ) 0x00;\r
1550                         strcat( ( char * ) pcWriteBuffer, ( const char * ) "\r\n" );\r
1551 \r
1552                         uxQueue = uxTopUsedPriority + ( unsigned portBASE_TYPE ) 1U;\r
1553 \r
1554                         do\r
1555                         {\r
1556                                 uxQueue--;\r
1557 \r
1558                                 if( listLIST_IS_EMPTY( &( pxReadyTasksLists[ uxQueue ] ) ) == pdFALSE )\r
1559                                 {\r
1560                                         prvGenerateRunTimeStatsForTasksInList( pcWriteBuffer, ( xList * ) &( pxReadyTasksLists[ uxQueue ] ), ulTotalRunTimeDiv100 );\r
1561                                 }\r
1562                         }while( uxQueue > ( unsigned short ) tskIDLE_PRIORITY );\r
1563 \r
1564                         if( listLIST_IS_EMPTY( pxDelayedTaskList ) == pdFALSE )\r
1565                         {\r
1566                                 prvGenerateRunTimeStatsForTasksInList( pcWriteBuffer, ( xList * ) pxDelayedTaskList, ulTotalRunTimeDiv100 );\r
1567                         }\r
1568 \r
1569                         if( listLIST_IS_EMPTY( pxOverflowDelayedTaskList ) == pdFALSE )\r
1570                         {\r
1571                                 prvGenerateRunTimeStatsForTasksInList( pcWriteBuffer, ( xList * ) pxOverflowDelayedTaskList, ulTotalRunTimeDiv100 );\r
1572                         }\r
1573 \r
1574                         #if ( INCLUDE_vTaskDelete == 1 )\r
1575                         {\r
1576                                 if( listLIST_IS_EMPTY( &xTasksWaitingTermination ) == pdFALSE )\r
1577                                 {\r
1578                                         prvGenerateRunTimeStatsForTasksInList( pcWriteBuffer, &xTasksWaitingTermination, ulTotalRunTimeDiv100 );\r
1579                                 }\r
1580                         }\r
1581                         #endif\r
1582 \r
1583                         #if ( INCLUDE_vTaskSuspend == 1 )\r
1584                         {\r
1585                                 if( listLIST_IS_EMPTY( &xSuspendedTaskList ) == pdFALSE )\r
1586                                 {\r
1587                                         prvGenerateRunTimeStatsForTasksInList( pcWriteBuffer, &xSuspendedTaskList, ulTotalRunTimeDiv100 );\r
1588                                 }\r
1589                         }\r
1590                         #endif\r
1591                 }\r
1592                 xTaskResumeAll();\r
1593         }\r
1594 \r
1595 #endif /* configGENERATE_RUN_TIME_STATS */\r
1596 /*----------------------------------------------------------*/\r
1597 \r
1598 #if ( INCLUDE_xTaskGetIdleTaskHandle == 1 )\r
1599 \r
1600         xTaskHandle xTaskGetIdleTaskHandle( void )\r
1601         {\r
1602                 /* If xTaskGetIdleTaskHandle() is called before the scheduler has been\r
1603                 started, then xIdleTaskHandle will be NULL. */\r
1604                 configASSERT( ( xIdleTaskHandle != NULL ) );\r
1605                 return xIdleTaskHandle;\r
1606         }\r
1607 \r
1608 #endif /* INCLUDE_xTaskGetIdleTaskHandle */\r
1609 /*----------------------------------------------------------*/\r
1610 \r
1611 /* This conditional compilation should use inequality to 0, not equality to 1.\r
1612 This is to ensure vTaskStepTick() is available when user defined low power mode\r
1613 implementations require configUSE_TICKLESS_IDLE to be set to a value other than\r
1614 1. */\r
1615 #if ( configUSE_TICKLESS_IDLE != 0 )\r
1616 \r
1617         void vTaskStepTick( portTickType xTicksToJump )\r
1618         {\r
1619                 configASSERT( ( xTickCount + xTicksToJump ) <= xNextTaskUnblockTime );\r
1620                 xTickCount += xTicksToJump;\r
1621         }\r
1622 \r
1623 #endif /* configUSE_TICKLESS_IDLE */\r
1624 /*----------------------------------------------------------*/\r
1625 \r
1626 void vTaskIncrementTick( void )\r
1627 {\r
1628 tskTCB * pxTCB;\r
1629 \r
1630         /* Called by the portable layer each time a tick interrupt occurs.\r
1631         Increments the tick then checks to see if the new tick value will cause any\r
1632         tasks to be unblocked. */\r
1633         traceTASK_INCREMENT_TICK( xTickCount );\r
1634         if( uxSchedulerSuspended == ( unsigned portBASE_TYPE ) pdFALSE )\r
1635         {\r
1636                 ++xTickCount;\r
1637                 if( xTickCount == ( portTickType ) 0U )\r
1638                 {\r
1639                         xList *pxTemp;\r
1640 \r
1641                         /* Tick count has overflowed so we need to swap the delay lists.\r
1642                         If there are any items in pxDelayedTaskList here then there is\r
1643                         an error! */\r
1644                         configASSERT( ( listLIST_IS_EMPTY( pxDelayedTaskList ) ) );\r
1645 \r
1646                         pxTemp = pxDelayedTaskList;\r
1647                         pxDelayedTaskList = pxOverflowDelayedTaskList;\r
1648                         pxOverflowDelayedTaskList = pxTemp;\r
1649                         xNumOfOverflows++;\r
1650 \r
1651                         if( listLIST_IS_EMPTY( pxDelayedTaskList ) != pdFALSE )\r
1652                         {\r
1653                                 /* The new current delayed list is empty.  Set\r
1654                                 xNextTaskUnblockTime to the maximum possible value so it is\r
1655                                 extremely unlikely that the\r
1656                                 if( xTickCount >= xNextTaskUnblockTime ) test will pass until\r
1657                                 there is an item in the delayed list. */\r
1658                                 xNextTaskUnblockTime = portMAX_DELAY;\r
1659                         }\r
1660                         else\r
1661                         {\r
1662                                 /* The new current delayed list is not empty, get the value of\r
1663                                 the item at the head of the delayed list.  This is the time at\r
1664                                 which the task at the head of the delayed list should be removed\r
1665                                 from the Blocked state. */\r
1666                                 pxTCB = ( tskTCB * ) listGET_OWNER_OF_HEAD_ENTRY( pxDelayedTaskList );\r
1667                                 xNextTaskUnblockTime = listGET_LIST_ITEM_VALUE( &( pxTCB->xGenericListItem ) );\r
1668                         }\r
1669                 }\r
1670 \r
1671                 /* See if this tick has made a timeout expire. */\r
1672                 prvCheckDelayedTasks();\r
1673         }\r
1674         else\r
1675         {\r
1676                 ++uxMissedTicks;\r
1677 \r
1678                 /* The tick hook gets called at regular intervals, even if the\r
1679                 scheduler is locked. */\r
1680                 #if ( configUSE_TICK_HOOK == 1 )\r
1681                 {\r
1682                         vApplicationTickHook();\r
1683                 }\r
1684                 #endif\r
1685         }\r
1686 \r
1687         #if ( configUSE_TICK_HOOK == 1 )\r
1688         {\r
1689                 /* Guard against the tick hook being called when the missed tick\r
1690                 count is being unwound (when the scheduler is being unlocked. */\r
1691                 if( uxMissedTicks == ( unsigned portBASE_TYPE ) 0U )\r
1692                 {\r
1693                         vApplicationTickHook();\r
1694                 }\r
1695         }\r
1696         #endif /* configUSE_TICK_HOOK */\r
1697 }\r
1698 /*-----------------------------------------------------------*/\r
1699 \r
1700 #if ( configUSE_APPLICATION_TASK_TAG == 1 )\r
1701 \r
1702         void vTaskSetApplicationTaskTag( xTaskHandle xTask, pdTASK_HOOK_CODE pxHookFunction )\r
1703         {\r
1704         tskTCB *xTCB;\r
1705 \r
1706                 /* If xTask is NULL then we are setting our own task hook. */\r
1707                 if( xTask == NULL )\r
1708                 {\r
1709                         xTCB = ( tskTCB * ) pxCurrentTCB;\r
1710                 }\r
1711                 else\r
1712                 {\r
1713                         xTCB = ( tskTCB * ) xTask;\r
1714                 }\r
1715 \r
1716                 /* Save the hook function in the TCB.  A critical section is required as\r
1717                 the value can be accessed from an interrupt. */\r
1718                 taskENTER_CRITICAL();\r
1719                         xTCB->pxTaskTag = pxHookFunction;\r
1720                 taskEXIT_CRITICAL();\r
1721         }\r
1722 \r
1723 #endif /* configUSE_APPLICATION_TASK_TAG */\r
1724 /*-----------------------------------------------------------*/\r
1725 \r
1726 #if ( configUSE_APPLICATION_TASK_TAG == 1 )\r
1727 \r
1728         pdTASK_HOOK_CODE xTaskGetApplicationTaskTag( xTaskHandle xTask )\r
1729         {\r
1730         tskTCB *xTCB;\r
1731         pdTASK_HOOK_CODE xReturn;\r
1732 \r
1733                 /* If xTask is NULL then we are setting our own task hook. */\r
1734                 if( xTask == NULL )\r
1735                 {\r
1736                         xTCB = ( tskTCB * ) pxCurrentTCB;\r
1737                 }\r
1738                 else\r
1739                 {\r
1740                         xTCB = ( tskTCB * ) xTask;\r
1741                 }\r
1742 \r
1743                 /* Save the hook function in the TCB.  A critical section is required as\r
1744                 the value can be accessed from an interrupt. */\r
1745                 taskENTER_CRITICAL();\r
1746                         xReturn = xTCB->pxTaskTag;\r
1747                 taskEXIT_CRITICAL();\r
1748 \r
1749                 return xReturn;\r
1750         }\r
1751 \r
1752 #endif /* configUSE_APPLICATION_TASK_TAG */\r
1753 /*-----------------------------------------------------------*/\r
1754 \r
1755 #if ( configUSE_APPLICATION_TASK_TAG == 1 )\r
1756 \r
1757         portBASE_TYPE xTaskCallApplicationTaskHook( xTaskHandle xTask, void *pvParameter )\r
1758         {\r
1759         tskTCB *xTCB;\r
1760         portBASE_TYPE xReturn;\r
1761 \r
1762                 /* If xTask is NULL then we are calling our own task hook. */\r
1763                 if( xTask == NULL )\r
1764                 {\r
1765                         xTCB = ( tskTCB * ) pxCurrentTCB;\r
1766                 }\r
1767                 else\r
1768                 {\r
1769                         xTCB = ( tskTCB * ) xTask;\r
1770                 }\r
1771 \r
1772                 if( xTCB->pxTaskTag != NULL )\r
1773                 {\r
1774                         xReturn = xTCB->pxTaskTag( pvParameter );\r
1775                 }\r
1776                 else\r
1777                 {\r
1778                         xReturn = pdFAIL;\r
1779                 }\r
1780 \r
1781                 return xReturn;\r
1782         }\r
1783 \r
1784 #endif /* configUSE_APPLICATION_TASK_TAG */\r
1785 /*-----------------------------------------------------------*/\r
1786 \r
1787 void vTaskSwitchContext( void )\r
1788 {\r
1789         if( uxSchedulerSuspended != ( unsigned portBASE_TYPE ) pdFALSE )\r
1790         {\r
1791                 /* The scheduler is currently suspended - do not allow a context\r
1792                 switch. */\r
1793                 xMissedYield = pdTRUE;\r
1794         }\r
1795         else\r
1796         {\r
1797                 traceTASK_SWITCHED_OUT();\r
1798 \r
1799                 #if ( configGENERATE_RUN_TIME_STATS == 1 )\r
1800                 {\r
1801                                 #ifdef portALT_GET_RUN_TIME_COUNTER_VALUE\r
1802                                         portALT_GET_RUN_TIME_COUNTER_VALUE( ulTotalRunTime );\r
1803                                 #else\r
1804                                         ulTotalRunTime = portGET_RUN_TIME_COUNTER_VALUE();\r
1805                                 #endif\r
1806 \r
1807                                 /* Add the amount of time the task has been running to the accumulated\r
1808                                 time so far.  The time the task started running was stored in\r
1809                                 ulTaskSwitchedInTime.  Note that there is no overflow protection here\r
1810                                 so count values are only valid until the timer overflows.  Generally\r
1811                                 this will be about 1 hour assuming a 1uS timer increment. */\r
1812                                 pxCurrentTCB->ulRunTimeCounter += ( ulTotalRunTime - ulTaskSwitchedInTime );\r
1813                                 ulTaskSwitchedInTime = ulTotalRunTime;\r
1814                 }\r
1815                 #endif /* configGENERATE_RUN_TIME_STATS */\r
1816 \r
1817                 taskFIRST_CHECK_FOR_STACK_OVERFLOW();\r
1818                 taskSECOND_CHECK_FOR_STACK_OVERFLOW();\r
1819 \r
1820                 taskSELECT_HIGHEST_PRIORITY_TASK();\r
1821 \r
1822                 traceTASK_SWITCHED_IN();\r
1823         }\r
1824 }\r
1825 /*-----------------------------------------------------------*/\r
1826 \r
1827 void vTaskPlaceOnEventList( const xList * const pxEventList, portTickType xTicksToWait )\r
1828 {\r
1829 portTickType xTimeToWake;\r
1830 \r
1831         configASSERT( pxEventList );\r
1832 \r
1833         /* THIS FUNCTION MUST BE CALLED WITH INTERRUPTS DISABLED OR THE\r
1834         SCHEDULER SUSPENDED. */\r
1835 \r
1836         /* Place the event list item of the TCB in the appropriate event list.\r
1837         This is placed in the list in priority order so the highest priority task\r
1838         is the first to be woken by the event. */\r
1839         vListInsert( ( xList * ) pxEventList, ( xListItem * ) &( pxCurrentTCB->xEventListItem ) );\r
1840 \r
1841         /* We must remove ourselves from the ready list before adding ourselves\r
1842         to the blocked list as the same list item is used for both lists.  We have\r
1843         exclusive access to the ready lists as the scheduler is locked. */\r
1844         if( uxListRemove( ( xListItem * ) &( pxCurrentTCB->xGenericListItem ) ) == 0 )\r
1845         {\r
1846                 /* The current task must be in a ready list, so there is no need to\r
1847                 check, and the port reset macro can be called directly. */\r
1848                 portRESET_READY_PRIORITY( pxCurrentTCB->uxPriority, uxTopReadyPriority );\r
1849         }\r
1850 \r
1851         #if ( INCLUDE_vTaskSuspend == 1 )\r
1852         {\r
1853                 if( xTicksToWait == portMAX_DELAY )\r
1854                 {\r
1855                         /* Add ourselves to the suspended task list instead of a delayed task\r
1856                         list to ensure we are not woken by a timing event.  We will block\r
1857                         indefinitely. */\r
1858                         vListInsertEnd( ( xList * ) &xSuspendedTaskList, ( xListItem * ) &( pxCurrentTCB->xGenericListItem ) );\r
1859                 }\r
1860                 else\r
1861                 {\r
1862                         /* Calculate the time at which the task should be woken if the event does\r
1863                         not occur.  This may overflow but this doesn't matter. */\r
1864                         xTimeToWake = xTickCount + xTicksToWait;\r
1865                         prvAddCurrentTaskToDelayedList( xTimeToWake );\r
1866                 }\r
1867         }\r
1868         #else /* INCLUDE_vTaskSuspend */\r
1869         {\r
1870                         /* Calculate the time at which the task should be woken if the event does\r
1871                         not occur.  This may overflow but this doesn't matter. */\r
1872                         xTimeToWake = xTickCount + xTicksToWait;\r
1873                         prvAddCurrentTaskToDelayedList( xTimeToWake );\r
1874         }\r
1875         #endif /* INCLUDE_vTaskSuspend */\r
1876 }\r
1877 /*-----------------------------------------------------------*/\r
1878 \r
1879 #if configUSE_TIMERS == 1\r
1880 \r
1881         void vTaskPlaceOnEventListRestricted( const xList * const pxEventList, portTickType xTicksToWait )\r
1882         {\r
1883         portTickType xTimeToWake;\r
1884 \r
1885                 configASSERT( pxEventList );\r
1886 \r
1887                 /* This function should not be called by application code hence the\r
1888                 'Restricted' in its name.  It is not part of the public API.  It is\r
1889                 designed for use by kernel code, and has special calling requirements -\r
1890                 it should be called from a critical section. */\r
1891 \r
1892 \r
1893                 /* Place the event list item of the TCB in the appropriate event list.\r
1894                 In this case it is assume that this is the only task that is going to\r
1895                 be waiting on this event list, so the faster vListInsertEnd() function\r
1896                 can be used in place of vListInsert. */\r
1897                 vListInsertEnd( ( xList * ) pxEventList, ( xListItem * ) &( pxCurrentTCB->xEventListItem ) );\r
1898 \r
1899                 /* We must remove this task from the ready list before adding it to the\r
1900                 blocked list as the same list item is used for both lists.  This\r
1901                 function is called form a critical section. */\r
1902                 if( uxListRemove( ( xListItem * ) &( pxCurrentTCB->xGenericListItem ) ) == 0 )\r
1903                 {\r
1904                         /* The current task must be in a ready list, so there is no need to\r
1905                         check, and the port reset macro can be called directly. */\r
1906                         portRESET_READY_PRIORITY( pxCurrentTCB->uxPriority, uxTopReadyPriority );\r
1907                 }\r
1908 \r
1909                 /* Calculate the time at which the task should be woken if the event does\r
1910                 not occur.  This may overflow but this doesn't matter. */\r
1911                 xTimeToWake = xTickCount + xTicksToWait;\r
1912 \r
1913                 traceTASK_DELAY_UNTIL();\r
1914                 prvAddCurrentTaskToDelayedList( xTimeToWake );\r
1915         }\r
1916 \r
1917 #endif /* configUSE_TIMERS */\r
1918 /*-----------------------------------------------------------*/\r
1919 \r
1920 signed portBASE_TYPE xTaskRemoveFromEventList( const xList * const pxEventList )\r
1921 {\r
1922 tskTCB *pxUnblockedTCB;\r
1923 portBASE_TYPE xReturn;\r
1924 \r
1925         /* THIS FUNCTION MUST BE CALLED WITH INTERRUPTS DISABLED OR THE\r
1926         SCHEDULER SUSPENDED.  It can also be called from within an ISR. */\r
1927 \r
1928         /* The event list is sorted in priority order, so we can remove the\r
1929         first in the list, remove the TCB from the delayed list, and add\r
1930         it to the ready list.\r
1931 \r
1932         If an event is for a queue that is locked then this function will never\r
1933         get called - the lock count on the queue will get modified instead.  This\r
1934         means we can always expect exclusive access to the event list here.\r
1935 \r
1936         This function assumes that a check has already been made to ensure that\r
1937         pxEventList is not empty. */\r
1938         pxUnblockedTCB = ( tskTCB * ) listGET_OWNER_OF_HEAD_ENTRY( pxEventList );\r
1939         configASSERT( pxUnblockedTCB );\r
1940         uxListRemove( &( pxUnblockedTCB->xEventListItem ) );\r
1941 \r
1942         if( uxSchedulerSuspended == ( unsigned portBASE_TYPE ) pdFALSE )\r
1943         {\r
1944                 uxListRemove( &( pxUnblockedTCB->xGenericListItem ) );\r
1945                 prvAddTaskToReadyQueue( pxUnblockedTCB );\r
1946         }\r
1947         else\r
1948         {\r
1949                 /* We cannot access the delayed or ready lists, so will hold this\r
1950                 task pending until the scheduler is resumed. */\r
1951                 vListInsertEnd( ( xList * ) &( xPendingReadyList ), &( pxUnblockedTCB->xEventListItem ) );\r
1952         }\r
1953 \r
1954         if( pxUnblockedTCB->uxPriority >= pxCurrentTCB->uxPriority )\r
1955         {\r
1956                 /* Return true if the task removed from the event list has\r
1957                 a higher priority than the calling task.  This allows\r
1958                 the calling task to know if it should force a context\r
1959                 switch now. */\r
1960                 xReturn = pdTRUE;\r
1961         }\r
1962         else\r
1963         {\r
1964                 xReturn = pdFALSE;\r
1965         }\r
1966 \r
1967         return xReturn;\r
1968 }\r
1969 /*-----------------------------------------------------------*/\r
1970 \r
1971 void vTaskSetTimeOutState( xTimeOutType * const pxTimeOut )\r
1972 {\r
1973         configASSERT( pxTimeOut );\r
1974         pxTimeOut->xOverflowCount = xNumOfOverflows;\r
1975         pxTimeOut->xTimeOnEntering = xTickCount;\r
1976 }\r
1977 /*-----------------------------------------------------------*/\r
1978 \r
1979 portBASE_TYPE xTaskCheckForTimeOut( xTimeOutType * const pxTimeOut, portTickType * const pxTicksToWait )\r
1980 {\r
1981 portBASE_TYPE xReturn;\r
1982 \r
1983         configASSERT( pxTimeOut );\r
1984         configASSERT( pxTicksToWait );\r
1985 \r
1986         taskENTER_CRITICAL();\r
1987         {\r
1988                 #if ( INCLUDE_vTaskSuspend == 1 )\r
1989                         /* If INCLUDE_vTaskSuspend is set to 1 and the block time specified is\r
1990                         the maximum block time then the task should block indefinitely, and\r
1991                         therefore never time out. */\r
1992                         if( *pxTicksToWait == portMAX_DELAY )\r
1993                         {\r
1994                                 xReturn = pdFALSE;\r
1995                         }\r
1996                         else /* We are not blocking indefinitely, perform the checks below. */\r
1997                 #endif\r
1998 \r
1999                 if( ( xNumOfOverflows != pxTimeOut->xOverflowCount ) && ( ( portTickType ) xTickCount >= ( portTickType ) pxTimeOut->xTimeOnEntering ) )\r
2000                 {\r
2001                         /* The tick count is greater than the time at which vTaskSetTimeout()\r
2002                         was called, but has also overflowed since vTaskSetTimeOut() was called.\r
2003                         It must have wrapped all the way around and gone past us again. This\r
2004                         passed since vTaskSetTimeout() was called. */\r
2005                         xReturn = pdTRUE;\r
2006                 }\r
2007                 else if( ( ( portTickType ) ( ( portTickType ) xTickCount - ( portTickType ) pxTimeOut->xTimeOnEntering ) ) < ( portTickType ) *pxTicksToWait )\r
2008                 {\r
2009                         /* Not a genuine timeout. Adjust parameters for time remaining. */\r
2010                         *pxTicksToWait -= ( ( portTickType ) xTickCount - ( portTickType ) pxTimeOut->xTimeOnEntering );\r
2011                         vTaskSetTimeOutState( pxTimeOut );\r
2012                         xReturn = pdFALSE;\r
2013                 }\r
2014                 else\r
2015                 {\r
2016                         xReturn = pdTRUE;\r
2017                 }\r
2018         }\r
2019         taskEXIT_CRITICAL();\r
2020 \r
2021         return xReturn;\r
2022 }\r
2023 /*-----------------------------------------------------------*/\r
2024 \r
2025 void vTaskMissedYield( void )\r
2026 {\r
2027         xMissedYield = pdTRUE;\r
2028 }\r
2029 /*-----------------------------------------------------------*/\r
2030 \r
2031 #if ( configUSE_TRACE_FACILITY == 1 )\r
2032 \r
2033         unsigned portBASE_TYPE uxTaskGetTaskNumber( xTaskHandle xTask )\r
2034         {\r
2035         unsigned portBASE_TYPE uxReturn;\r
2036         tskTCB *pxTCB;\r
2037 \r
2038                 if( xTask != NULL )\r
2039                 {\r
2040                         pxTCB = ( tskTCB * ) xTask;\r
2041                         uxReturn = pxTCB->uxTaskNumber;\r
2042                 }\r
2043                 else\r
2044                 {\r
2045                         uxReturn = 0U;\r
2046                 }\r
2047 \r
2048                 return uxReturn;\r
2049         }\r
2050 \r
2051 #endif /* configUSE_TRACE_FACILITY */\r
2052 /*-----------------------------------------------------------*/\r
2053 \r
2054 #if ( configUSE_TRACE_FACILITY == 1 )\r
2055 \r
2056         void vTaskSetTaskNumber( xTaskHandle xTask, unsigned portBASE_TYPE uxHandle )\r
2057         {\r
2058         tskTCB *pxTCB;\r
2059 \r
2060                 if( xTask != NULL )\r
2061                 {\r
2062                         pxTCB = ( tskTCB * ) xTask;\r
2063                         pxTCB->uxTaskNumber = uxHandle;\r
2064                 }\r
2065         }\r
2066 \r
2067 #endif /* configUSE_TRACE_FACILITY */\r
2068 \r
2069 /*\r
2070  * -----------------------------------------------------------\r
2071  * The Idle task.\r
2072  * ----------------------------------------------------------\r
2073  *\r
2074  * The portTASK_FUNCTION() macro is used to allow port/compiler specific\r
2075  * language extensions.  The equivalent prototype for this function is:\r
2076  *\r
2077  * void prvIdleTask( void *pvParameters );\r
2078  *\r
2079  */\r
2080 static portTASK_FUNCTION( prvIdleTask, pvParameters )\r
2081 {\r
2082         /* Stop warnings. */\r
2083         ( void ) pvParameters;\r
2084 \r
2085         for( ;; )\r
2086         {\r
2087                 /* See if any tasks have been deleted. */\r
2088                 prvCheckTasksWaitingTermination();\r
2089 \r
2090                 #if ( configUSE_PREEMPTION == 0 )\r
2091                 {\r
2092                         /* If we are not using preemption we keep forcing a task switch to\r
2093                         see if any other task has become available.  If we are using\r
2094                         preemption we don't need to do this as any task becoming available\r
2095                         will automatically get the processor anyway. */\r
2096                         taskYIELD();\r
2097                 }\r
2098                 #endif /* configUSE_PREEMPTION */\r
2099 \r
2100                 #if ( ( configUSE_PREEMPTION == 1 ) && ( configIDLE_SHOULD_YIELD == 1 ) )\r
2101                 {\r
2102                         /* When using preemption tasks of equal priority will be\r
2103                         timesliced.  If a task that is sharing the idle priority is ready\r
2104                         to run then the idle task should yield before the end of the\r
2105                         timeslice.\r
2106 \r
2107                         A critical region is not required here as we are just reading from\r
2108                         the list, and an occasional incorrect value will not matter.  If\r
2109                         the ready list at the idle priority contains more than one task\r
2110                         then a task other than the idle task is ready to execute. */\r
2111                         if( listCURRENT_LIST_LENGTH( &( pxReadyTasksLists[ tskIDLE_PRIORITY ] ) ) > ( unsigned portBASE_TYPE ) 1 )\r
2112                         {\r
2113                                 taskYIELD();\r
2114                         }\r
2115                 }\r
2116                 #endif /* ( ( configUSE_PREEMPTION == 1 ) && ( configIDLE_SHOULD_YIELD == 1 ) ) */\r
2117 \r
2118                 #if ( configUSE_IDLE_HOOK == 1 )\r
2119                 {\r
2120                         extern void vApplicationIdleHook( void );\r
2121 \r
2122                         /* Call the user defined function from within the idle task.  This\r
2123                         allows the application designer to add background functionality\r
2124                         without the overhead of a separate task.\r
2125                         NOTE: vApplicationIdleHook() MUST NOT, UNDER ANY CIRCUMSTANCES,\r
2126                         CALL A FUNCTION THAT MIGHT BLOCK. */\r
2127                         vApplicationIdleHook();\r
2128                 }\r
2129                 #endif /* configUSE_IDLE_HOOK */\r
2130 \r
2131                 /* This conditional compilation should use inequality to 0, not equality\r
2132                 to 1.  This is to ensure portSUPPRESS_TICKS_AND_SLEEP() is called when\r
2133                 user defined low power mode     implementations require\r
2134                 configUSE_TICKLESS_IDLE to be set to a value other than 1. */\r
2135                 #if ( configUSE_TICKLESS_IDLE != 0 )\r
2136                 {\r
2137                 portTickType xExpectedIdleTime;\r
2138                         /* It is not desirable to suspend then resume the scheduler on\r
2139                         each iteration of the idle task.  Therefore, a preliminary\r
2140                         test of the expected idle time is performed without the\r
2141                         scheduler suspended.  The result here is not necessarily\r
2142                         valid. */\r
2143                         xExpectedIdleTime = prvGetExpectedIdleTime();\r
2144 \r
2145                         if( xExpectedIdleTime >= configEXPECTED_IDLE_TIME_BEFORE_SLEEP )\r
2146                         {\r
2147                                 vTaskSuspendAll();\r
2148                                 {\r
2149                                         /* Now the scheduler is suspended, the expected idle\r
2150                                         time can be sampled again, and this time its value can\r
2151                                         be used. */\r
2152                                         configASSERT( xNextTaskUnblockTime >= xTickCount );\r
2153                                         xExpectedIdleTime = prvGetExpectedIdleTime();\r
2154 \r
2155                                         if( xExpectedIdleTime >= configEXPECTED_IDLE_TIME_BEFORE_SLEEP )\r
2156                                         {\r
2157                                                 portSUPPRESS_TICKS_AND_SLEEP( xExpectedIdleTime );\r
2158                                         }\r
2159                                 }\r
2160                                 xTaskResumeAll();\r
2161                         }\r
2162                 }\r
2163                 #endif /* configUSE_TICKLESS_IDLE */\r
2164         }\r
2165 } /*lint !e715 pvParameters is not accessed but all task functions require the same prototype. */\r
2166 /*-----------------------------------------------------------*/\r
2167 \r
2168 static void prvInitialiseTCBVariables( tskTCB *pxTCB, const signed char * const pcName, unsigned portBASE_TYPE uxPriority, const xMemoryRegion * const xRegions, unsigned short usStackDepth )\r
2169 {\r
2170         /* Store the function name in the TCB. */\r
2171         #if configMAX_TASK_NAME_LEN > 1\r
2172         {\r
2173                 /* Don't bring strncpy into the build unnecessarily. */\r
2174                 strncpy( ( char * ) pxTCB->pcTaskName, ( const char * ) pcName, ( unsigned short ) configMAX_TASK_NAME_LEN );\r
2175         }\r
2176         #endif /* configMAX_TASK_NAME_LEN */\r
2177         pxTCB->pcTaskName[ ( unsigned short ) configMAX_TASK_NAME_LEN - ( unsigned short ) 1 ] = ( signed char ) '\0';\r
2178 \r
2179         /* This is used as an array index so must ensure it's not too large.  First\r
2180         remove the privilege bit if one is present. */\r
2181         if( uxPriority >= configMAX_PRIORITIES )\r
2182         {\r
2183                 uxPriority = configMAX_PRIORITIES - ( unsigned portBASE_TYPE ) 1U;\r
2184         }\r
2185 \r
2186         pxTCB->uxPriority = uxPriority;\r
2187         #if ( configUSE_MUTEXES == 1 )\r
2188         {\r
2189                 pxTCB->uxBasePriority = uxPriority;\r
2190         }\r
2191         #endif /* configUSE_MUTEXES */\r
2192 \r
2193         vListInitialiseItem( &( pxTCB->xGenericListItem ) );\r
2194         vListInitialiseItem( &( pxTCB->xEventListItem ) );\r
2195 \r
2196         /* Set the pxTCB as a link back from the xListItem.  This is so we can get\r
2197         back to the containing TCB from a generic item in a list. */\r
2198         listSET_LIST_ITEM_OWNER( &( pxTCB->xGenericListItem ), pxTCB );\r
2199 \r
2200         /* Event lists are always in priority order. */\r
2201         listSET_LIST_ITEM_VALUE( &( pxTCB->xEventListItem ), configMAX_PRIORITIES - ( portTickType ) uxPriority );\r
2202         listSET_LIST_ITEM_OWNER( &( pxTCB->xEventListItem ), pxTCB );\r
2203 \r
2204         #if ( portCRITICAL_NESTING_IN_TCB == 1 )\r
2205         {\r
2206                 pxTCB->uxCriticalNesting = ( unsigned portBASE_TYPE ) 0U;\r
2207         }\r
2208         #endif /* portCRITICAL_NESTING_IN_TCB */\r
2209 \r
2210         #if ( configUSE_APPLICATION_TASK_TAG == 1 )\r
2211         {\r
2212                 pxTCB->pxTaskTag = NULL;\r
2213         }\r
2214         #endif /* configUSE_APPLICATION_TASK_TAG */\r
2215 \r
2216         #if ( configGENERATE_RUN_TIME_STATS == 1 )\r
2217         {\r
2218                 pxTCB->ulRunTimeCounter = 0UL;\r
2219         }\r
2220         #endif /* configGENERATE_RUN_TIME_STATS */\r
2221 \r
2222         #if ( portUSING_MPU_WRAPPERS == 1 )\r
2223         {\r
2224                 vPortStoreTaskMPUSettings( &( pxTCB->xMPUSettings ), xRegions, pxTCB->pxStack, usStackDepth );\r
2225         }\r
2226         #else /* portUSING_MPU_WRAPPERS */\r
2227         {\r
2228                 ( void ) xRegions;\r
2229                 ( void ) usStackDepth;\r
2230         }\r
2231         #endif /* portUSING_MPU_WRAPPERS */\r
2232 }\r
2233 /*-----------------------------------------------------------*/\r
2234 \r
2235 #if ( portUSING_MPU_WRAPPERS == 1 )\r
2236 \r
2237         void vTaskAllocateMPURegions( xTaskHandle xTaskToModify, const xMemoryRegion * const xRegions )\r
2238         {\r
2239         tskTCB *pxTCB;\r
2240 \r
2241                 if( xTaskToModify == pxCurrentTCB )\r
2242                 {\r
2243                         xTaskToModify = NULL;\r
2244                 }\r
2245 \r
2246                 /* If null is passed in here then we are deleting ourselves. */\r
2247                 pxTCB = prvGetTCBFromHandle( xTaskToModify );\r
2248 \r
2249         vPortStoreTaskMPUSettings( &( pxTCB->xMPUSettings ), xRegions, NULL, 0 );\r
2250         }\r
2251         \r
2252 #endif /* portUSING_MPU_WRAPPERS */\r
2253 /*-----------------------------------------------------------*/\r
2254 \r
2255 static void prvInitialiseTaskLists( void )\r
2256 {\r
2257 unsigned portBASE_TYPE uxPriority;\r
2258 \r
2259         for( uxPriority = ( unsigned portBASE_TYPE ) 0U; uxPriority < configMAX_PRIORITIES; uxPriority++ )\r
2260         {\r
2261                 vListInitialise( ( xList * ) &( pxReadyTasksLists[ uxPriority ] ) );\r
2262         }\r
2263 \r
2264         vListInitialise( ( xList * ) &xDelayedTaskList1 );\r
2265         vListInitialise( ( xList * ) &xDelayedTaskList2 );\r
2266         vListInitialise( ( xList * ) &xPendingReadyList );\r
2267 \r
2268         #if ( INCLUDE_vTaskDelete == 1 )\r
2269         {\r
2270                 vListInitialise( ( xList * ) &xTasksWaitingTermination );\r
2271         }\r
2272         #endif /* INCLUDE_vTaskDelete */\r
2273 \r
2274         #if ( INCLUDE_vTaskSuspend == 1 )\r
2275         {\r
2276                 vListInitialise( ( xList * ) &xSuspendedTaskList );\r
2277         }\r
2278         #endif /* INCLUDE_vTaskSuspend */\r
2279 \r
2280         /* Start with pxDelayedTaskList using list1 and the pxOverflowDelayedTaskList\r
2281         using list2. */\r
2282         pxDelayedTaskList = &xDelayedTaskList1;\r
2283         pxOverflowDelayedTaskList = &xDelayedTaskList2;\r
2284 }\r
2285 /*-----------------------------------------------------------*/\r
2286 \r
2287 static void prvCheckTasksWaitingTermination( void )\r
2288 {\r
2289         #if ( INCLUDE_vTaskDelete == 1 )\r
2290         {\r
2291                 portBASE_TYPE xListIsEmpty;\r
2292 \r
2293                 /* ucTasksDeleted is used to prevent vTaskSuspendAll() being called\r
2294                 too often in the idle task. */\r
2295                 while( uxTasksDeleted > ( unsigned portBASE_TYPE ) 0U )\r
2296                 {\r
2297                         vTaskSuspendAll();\r
2298                                 xListIsEmpty = listLIST_IS_EMPTY( &xTasksWaitingTermination );\r
2299                         xTaskResumeAll();\r
2300 \r
2301                         if( xListIsEmpty == pdFALSE )\r
2302                         {\r
2303                                 tskTCB *pxTCB;\r
2304 \r
2305                                 taskENTER_CRITICAL();\r
2306                                 {\r
2307                                         pxTCB = ( tskTCB * ) listGET_OWNER_OF_HEAD_ENTRY( ( ( xList * ) &xTasksWaitingTermination ) );\r
2308                                         uxListRemove( &( pxTCB->xGenericListItem ) );\r
2309                                         --uxCurrentNumberOfTasks;\r
2310                                         --uxTasksDeleted;\r
2311                                 }\r
2312                                 taskEXIT_CRITICAL();\r
2313 \r
2314                                 prvDeleteTCB( pxTCB );\r
2315                         }\r
2316                 }\r
2317         }\r
2318         #endif /* vTaskDelete */\r
2319 }\r
2320 /*-----------------------------------------------------------*/\r
2321 \r
2322 static void prvAddCurrentTaskToDelayedList( portTickType xTimeToWake )\r
2323 {\r
2324         /* The list item will be inserted in wake time order. */\r
2325         listSET_LIST_ITEM_VALUE( &( pxCurrentTCB->xGenericListItem ), xTimeToWake );\r
2326 \r
2327         if( xTimeToWake < xTickCount )\r
2328         {\r
2329                 /* Wake time has overflowed.  Place this item in the overflow list. */\r
2330                 vListInsert( ( xList * ) pxOverflowDelayedTaskList, ( xListItem * ) &( pxCurrentTCB->xGenericListItem ) );\r
2331         }\r
2332         else\r
2333         {\r
2334                 /* The wake time has not overflowed, so we can use the current block list. */\r
2335                 vListInsert( ( xList * ) pxDelayedTaskList, ( xListItem * ) &( pxCurrentTCB->xGenericListItem ) );\r
2336 \r
2337                 /* If the task entering the blocked state was placed at the head of the\r
2338                 list of blocked tasks then xNextTaskUnblockTime needs to be updated\r
2339                 too. */\r
2340                 if( xTimeToWake < xNextTaskUnblockTime )\r
2341                 {\r
2342                         xNextTaskUnblockTime = xTimeToWake;\r
2343                 }\r
2344         }\r
2345 }\r
2346 /*-----------------------------------------------------------*/\r
2347 \r
2348 static tskTCB *prvAllocateTCBAndStack( unsigned short usStackDepth, portSTACK_TYPE *puxStackBuffer )\r
2349 {\r
2350 tskTCB *pxNewTCB;\r
2351 \r
2352         /* Allocate space for the TCB.  Where the memory comes from depends on\r
2353         the implementation of the port malloc function. */\r
2354         pxNewTCB = ( tskTCB * ) pvPortMalloc( sizeof( tskTCB ) );\r
2355 \r
2356         if( pxNewTCB != NULL )\r
2357         {\r
2358                 /* Allocate space for the stack used by the task being created.\r
2359                 The base of the stack memory stored in the TCB so the task can\r
2360                 be deleted later if required. */\r
2361                 pxNewTCB->pxStack = ( portSTACK_TYPE * ) pvPortMallocAligned( ( ( ( size_t )usStackDepth ) * sizeof( portSTACK_TYPE ) ), puxStackBuffer );\r
2362 \r
2363                 if( pxNewTCB->pxStack == NULL )\r
2364                 {\r
2365                         /* Could not allocate the stack.  Delete the allocated TCB. */\r
2366                         vPortFree( pxNewTCB );\r
2367                         pxNewTCB = NULL;\r
2368                 }\r
2369                 else\r
2370                 {\r
2371                         /* Just to help debugging. */\r
2372                         memset( pxNewTCB->pxStack, ( int ) tskSTACK_FILL_BYTE, ( size_t ) usStackDepth * sizeof( portSTACK_TYPE ) );\r
2373                 }\r
2374         }\r
2375 \r
2376         return pxNewTCB;\r
2377 }\r
2378 /*-----------------------------------------------------------*/\r
2379 \r
2380 #if ( configUSE_TRACE_FACILITY == 1 )\r
2381 \r
2382         static void prvListTaskWithinSingleList( const signed char *pcWriteBuffer, xList *pxList, signed char cStatus )\r
2383         {\r
2384         volatile tskTCB *pxNextTCB, *pxFirstTCB;\r
2385         unsigned short usStackRemaining;\r
2386         PRIVILEGED_DATA static char pcStatusString[ configMAX_TASK_NAME_LEN + 30 ];\r
2387 \r
2388                 /* Write the details of all the TCB's in pxList into the buffer. */\r
2389                 listGET_OWNER_OF_NEXT_ENTRY( pxFirstTCB, pxList );\r
2390                 do\r
2391                 {\r
2392                         listGET_OWNER_OF_NEXT_ENTRY( pxNextTCB, pxList );\r
2393                         #if ( portSTACK_GROWTH > 0 )\r
2394                         {\r
2395                                 usStackRemaining = usTaskCheckFreeStackSpace( ( unsigned char * ) pxNextTCB->pxEndOfStack );\r
2396                         }\r
2397                         #else\r
2398                         {\r
2399                                 usStackRemaining = usTaskCheckFreeStackSpace( ( unsigned char * ) pxNextTCB->pxStack );\r
2400                         }\r
2401                         #endif\r
2402 \r
2403                         sprintf( pcStatusString, ( char * ) "%s\t\t%c\t%u\t%u\t%u\r\n", pxNextTCB->pcTaskName, cStatus, ( unsigned int ) pxNextTCB->uxPriority, ( unsigned int ) usStackRemaining, ( unsigned int ) pxNextTCB->uxTCBNumber );\r
2404                         strcat( ( char * ) pcWriteBuffer, ( char * ) pcStatusString );\r
2405 \r
2406                 } while( pxNextTCB != pxFirstTCB );\r
2407         }\r
2408 \r
2409 #endif /* configUSE_TRACE_FACILITY */\r
2410 /*-----------------------------------------------------------*/\r
2411 \r
2412 #if ( configGENERATE_RUN_TIME_STATS == 1 )\r
2413 \r
2414         static void prvGenerateRunTimeStatsForTasksInList( const signed char *pcWriteBuffer, xList *pxList, unsigned long ulTotalRunTimeDiv100 )\r
2415         {\r
2416         volatile tskTCB *pxNextTCB, *pxFirstTCB;\r
2417         unsigned long ulStatsAsPercentage;\r
2418 \r
2419                 /* Write the run time stats of all the TCB's in pxList into the buffer. */\r
2420                 listGET_OWNER_OF_NEXT_ENTRY( pxFirstTCB, pxList );\r
2421                 do\r
2422                 {\r
2423                         /* Get next TCB in from the list. */\r
2424                         listGET_OWNER_OF_NEXT_ENTRY( pxNextTCB, pxList );\r
2425 \r
2426                         /* Divide by zero check. */\r
2427                         if( ulTotalRunTimeDiv100 > 0UL )\r
2428                         {\r
2429                                 /* Has the task run at all? */\r
2430                                 if( pxNextTCB->ulRunTimeCounter == 0UL )\r
2431                                 {\r
2432                                         /* The task has used no CPU time at all. */\r
2433                                         sprintf( pcStatsString, ( char * ) "%s\t\t0\t\t0%%\r\n", pxNextTCB->pcTaskName );\r
2434                                 }\r
2435                                 else\r
2436                                 {\r
2437                                         /* What percentage of the total run time has the task used?\r
2438                                         This will always be rounded down to the nearest integer.\r
2439                                         ulTotalRunTimeDiv100 has already been divided by 100. */\r
2440                                         ulStatsAsPercentage = pxNextTCB->ulRunTimeCounter / ulTotalRunTimeDiv100;\r
2441 \r
2442                                         if( ulStatsAsPercentage > 0UL )\r
2443                                         {\r
2444                                                 #ifdef portLU_PRINTF_SPECIFIER_REQUIRED\r
2445                                                 {\r
2446                                                         sprintf( pcStatsString, ( char * ) "%s\t\t%lu\t\t%lu%%\r\n", pxNextTCB->pcTaskName, pxNextTCB->ulRunTimeCounter, ulStatsAsPercentage );\r
2447                                                 }\r
2448                                                 #else\r
2449                                                 {\r
2450                                                         /* sizeof( int ) == sizeof( long ) so a smaller\r
2451                                                         printf() library can be used. */\r
2452                                                         sprintf( pcStatsString, ( char * ) "%s\t\t%u\t\t%u%%\r\n", pxNextTCB->pcTaskName, ( unsigned int ) pxNextTCB->ulRunTimeCounter, ( unsigned int ) ulStatsAsPercentage );\r
2453                                                 }\r
2454                                                 #endif\r
2455                                         }\r
2456                                         else\r
2457                                         {\r
2458                                                 /* If the percentage is zero here then the task has\r
2459                                                 consumed less than 1% of the total run time. */\r
2460                                                 #ifdef portLU_PRINTF_SPECIFIER_REQUIRED\r
2461                                                 {\r
2462                                                         sprintf( pcStatsString, ( char * ) "%s\t\t%lu\t\t<1%%\r\n", pxNextTCB->pcTaskName, pxNextTCB->ulRunTimeCounter );\r
2463                                                 }\r
2464                                                 #else\r
2465                                                 {\r
2466                                                         /* sizeof( int ) == sizeof( long ) so a smaller\r
2467                                                         printf() library can be used. */\r
2468                                                         sprintf( pcStatsString, ( char * ) "%s\t\t%u\t\t<1%%\r\n", pxNextTCB->pcTaskName, ( unsigned int ) pxNextTCB->ulRunTimeCounter );\r
2469                                                 }\r
2470                                                 #endif\r
2471                                         }\r
2472                                 }\r
2473 \r
2474                                 strcat( ( char * ) pcWriteBuffer, ( char * ) pcStatsString );\r
2475                         }\r
2476 \r
2477                 } while( pxNextTCB != pxFirstTCB );\r
2478         }\r
2479 \r
2480 #endif /* configGENERATE_RUN_TIME_STATS */\r
2481 /*-----------------------------------------------------------*/\r
2482 \r
2483 #if ( ( configUSE_TRACE_FACILITY == 1 ) || ( INCLUDE_uxTaskGetStackHighWaterMark == 1 ) )\r
2484 \r
2485         static unsigned short usTaskCheckFreeStackSpace( const unsigned char * pucStackByte )\r
2486         {\r
2487         register unsigned short usCount = 0U;\r
2488 \r
2489                 while( *pucStackByte == tskSTACK_FILL_BYTE )\r
2490                 {\r
2491                         pucStackByte -= portSTACK_GROWTH;\r
2492                         usCount++;\r
2493                 }\r
2494 \r
2495                 usCount /= sizeof( portSTACK_TYPE );\r
2496 \r
2497                 return usCount;\r
2498         }\r
2499 \r
2500 #endif /* ( ( configUSE_TRACE_FACILITY == 1 ) || ( INCLUDE_uxTaskGetStackHighWaterMark == 1 ) ) */\r
2501 /*-----------------------------------------------------------*/\r
2502 \r
2503 #if ( INCLUDE_uxTaskGetStackHighWaterMark == 1 )\r
2504 \r
2505         unsigned portBASE_TYPE uxTaskGetStackHighWaterMark( xTaskHandle xTask )\r
2506         {\r
2507         tskTCB *pxTCB;\r
2508         unsigned char *pcEndOfStack;\r
2509         unsigned portBASE_TYPE uxReturn;\r
2510 \r
2511                 pxTCB = prvGetTCBFromHandle( xTask );\r
2512 \r
2513                 #if portSTACK_GROWTH < 0\r
2514                 {\r
2515                         pcEndOfStack = ( unsigned char * ) pxTCB->pxStack;\r
2516                 }\r
2517                 #else\r
2518                 {\r
2519                         pcEndOfStack = ( unsigned char * ) pxTCB->pxEndOfStack;\r
2520                 }\r
2521                 #endif\r
2522 \r
2523                 uxReturn = ( unsigned portBASE_TYPE ) usTaskCheckFreeStackSpace( pcEndOfStack );\r
2524 \r
2525                 return uxReturn;\r
2526         }\r
2527 \r
2528 #endif /* INCLUDE_uxTaskGetStackHighWaterMark */\r
2529 /*-----------------------------------------------------------*/\r
2530 \r
2531 #if ( INCLUDE_vTaskDelete == 1 )\r
2532 \r
2533         static void prvDeleteTCB( tskTCB *pxTCB )\r
2534         {\r
2535                 /* This call is required specifically for the TriCore port.  It must be\r
2536                 above the vPortFree() calls.  The call is also used by ports/demos that\r
2537                 want to allocate and clean RAM statically. */\r
2538                 portCLEAN_UP_TCB( pxTCB );\r
2539 \r
2540                 /* Free up the memory allocated by the scheduler for the task.  It is up to\r
2541                 the task to free any memory allocated at the application level. */\r
2542                 vPortFreeAligned( pxTCB->pxStack );\r
2543                 vPortFree( pxTCB );\r
2544         }\r
2545 \r
2546 #endif /* INCLUDE_vTaskDelete */\r
2547 /*-----------------------------------------------------------*/\r
2548 \r
2549 #if ( ( INCLUDE_xTaskGetCurrentTaskHandle == 1 ) || ( configUSE_MUTEXES == 1 ) )\r
2550 \r
2551         xTaskHandle xTaskGetCurrentTaskHandle( void )\r
2552         {\r
2553         xTaskHandle xReturn;\r
2554 \r
2555                 /* A critical section is not required as this is not called from\r
2556                 an interrupt and the current TCB will always be the same for any\r
2557                 individual execution thread. */\r
2558                 xReturn = pxCurrentTCB;\r
2559 \r
2560                 return xReturn;\r
2561         }\r
2562 \r
2563 #endif /* ( ( INCLUDE_xTaskGetCurrentTaskHandle == 1 ) || ( configUSE_MUTEXES == 1 ) ) */\r
2564 /*-----------------------------------------------------------*/\r
2565 \r
2566 #if ( ( INCLUDE_xTaskGetSchedulerState == 1 ) || ( configUSE_TIMERS == 1 ) )\r
2567 \r
2568         portBASE_TYPE xTaskGetSchedulerState( void )\r
2569         {\r
2570         portBASE_TYPE xReturn;\r
2571 \r
2572                 if( xSchedulerRunning == pdFALSE )\r
2573                 {\r
2574                         xReturn = taskSCHEDULER_NOT_STARTED;\r
2575                 }\r
2576                 else\r
2577                 {\r
2578                         if( uxSchedulerSuspended == ( unsigned portBASE_TYPE ) pdFALSE )\r
2579                         {\r
2580                                 xReturn = taskSCHEDULER_RUNNING;\r
2581                         }\r
2582                         else\r
2583                         {\r
2584                                 xReturn = taskSCHEDULER_SUSPENDED;\r
2585                         }\r
2586                 }\r
2587 \r
2588                 return xReturn;\r
2589         }\r
2590 \r
2591 #endif /* ( ( INCLUDE_xTaskGetSchedulerState == 1 ) || ( configUSE_TIMERS == 1 ) ) */\r
2592 /*-----------------------------------------------------------*/\r
2593 \r
2594 #if ( configUSE_MUTEXES == 1 )\r
2595 \r
2596         void vTaskPriorityInherit( xTaskHandle * const pxMutexHolder )\r
2597         {\r
2598         tskTCB * const pxTCB = ( tskTCB * ) pxMutexHolder;\r
2599 \r
2600                 /* If the mutex was given back by an interrupt while the queue was\r
2601                 locked then the mutex holder might now be NULL. */\r
2602                 if( pxMutexHolder != NULL )\r
2603                 {\r
2604                         if( pxTCB->uxPriority < pxCurrentTCB->uxPriority )\r
2605                         {\r
2606                                 /* Adjust the mutex holder state to account for its new priority. */\r
2607                                 listSET_LIST_ITEM_VALUE( &( pxTCB->xEventListItem ), configMAX_PRIORITIES - ( portTickType ) pxCurrentTCB->uxPriority );\r
2608 \r
2609                                 /* If the task being modified is in the ready state it will need to\r
2610                                 be moved into a new list. */\r
2611                                 if( listIS_CONTAINED_WITHIN( &( pxReadyTasksLists[ pxTCB->uxPriority ] ), &( pxTCB->xGenericListItem ) ) != pdFALSE )\r
2612                                 {\r
2613                                         if( uxListRemove( ( xListItem * ) &( pxTCB->xGenericListItem ) ) == 0 )\r
2614                                         {\r
2615                                                 taskRESET_READY_PRIORITY( pxTCB->uxPriority );\r
2616                                         }\r
2617 \r
2618                                         /* Inherit the priority before being moved into the new list. */\r
2619                                         pxTCB->uxPriority = pxCurrentTCB->uxPriority;\r
2620                                         prvAddTaskToReadyQueue( pxTCB );\r
2621                                 }\r
2622                                 else\r
2623                                 {\r
2624                                         /* Just inherit the priority. */\r
2625                                         pxTCB->uxPriority = pxCurrentTCB->uxPriority;\r
2626                                 }\r
2627 \r
2628                                 traceTASK_PRIORITY_INHERIT( pxTCB, pxCurrentTCB->uxPriority );\r
2629                         }\r
2630                 }\r
2631         }\r
2632 \r
2633 #endif /* configUSE_MUTEXES */\r
2634 /*-----------------------------------------------------------*/\r
2635 \r
2636 #if ( configUSE_MUTEXES == 1 )\r
2637 \r
2638         void vTaskPriorityDisinherit( xTaskHandle * const pxMutexHolder )\r
2639         {\r
2640         tskTCB * const pxTCB = ( tskTCB * ) pxMutexHolder;\r
2641 \r
2642                 if( pxMutexHolder != NULL )\r
2643                 {\r
2644                         if( pxTCB->uxPriority != pxTCB->uxBasePriority )\r
2645                         {\r
2646                                 /* We must be the running task to be able to give the mutex back.\r
2647                                 Remove ourselves from the ready list we currently appear in. */\r
2648                                 if( uxListRemove( ( xListItem * ) &( pxTCB->xGenericListItem ) ) == 0 )\r
2649                                 {\r
2650                                         taskRESET_READY_PRIORITY( pxTCB->uxPriority );\r
2651                                 }\r
2652 \r
2653                                 /* Disinherit the priority before adding the task into the new\r
2654                                 ready list. */\r
2655                                 traceTASK_PRIORITY_DISINHERIT( pxTCB, pxTCB->uxBasePriority );\r
2656                                 pxTCB->uxPriority = pxTCB->uxBasePriority;\r
2657                                 listSET_LIST_ITEM_VALUE( &( pxTCB->xEventListItem ), configMAX_PRIORITIES - ( portTickType ) pxTCB->uxPriority );\r
2658                                 prvAddTaskToReadyQueue( pxTCB );\r
2659                         }\r
2660                 }\r
2661         }\r
2662 \r
2663 #endif /* configUSE_MUTEXES */\r
2664 /*-----------------------------------------------------------*/\r
2665 \r
2666 #if ( portCRITICAL_NESTING_IN_TCB == 1 )\r
2667 \r
2668         void vTaskEnterCritical( void )\r
2669         {\r
2670                 portDISABLE_INTERRUPTS();\r
2671 \r
2672                 if( xSchedulerRunning != pdFALSE )\r
2673                 {\r
2674                         ( pxCurrentTCB->uxCriticalNesting )++;\r
2675                 }\r
2676         }\r
2677 \r
2678 #endif /* portCRITICAL_NESTING_IN_TCB */\r
2679 /*-----------------------------------------------------------*/\r
2680 \r
2681 #if ( portCRITICAL_NESTING_IN_TCB == 1 )\r
2682 \r
2683         void vTaskExitCritical( void )\r
2684         {\r
2685                 if( xSchedulerRunning != pdFALSE )\r
2686                 {\r
2687                         if( pxCurrentTCB->uxCriticalNesting > 0U )\r
2688                         {\r
2689                                 ( pxCurrentTCB->uxCriticalNesting )--;\r
2690 \r
2691                                 if( pxCurrentTCB->uxCriticalNesting == 0U )\r
2692                                 {\r
2693                                         portENABLE_INTERRUPTS();\r
2694                                 }\r
2695                         }\r
2696                 }\r
2697         } \r
2698 \r
2699 #endif /* portCRITICAL_NESTING_IN_TCB */\r
2700 /*-----------------------------------------------------------*/\r
2701 \r
2702 \r
2703 \r
2704 \r