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