]> begriffs open source - freertos/blob - tasks.c
add portDONT_DISCARD to pxCurrentTCB (#479)
[freertos] / tasks.c
1 /*\r
2  * FreeRTOS Kernel <DEVELOPMENT BRANCH>\r
3  * Copyright (C) 2021 Amazon.com, Inc. or its affiliates.  All Rights Reserved.\r
4  *\r
5  * SPDX-License-Identifier: MIT\r
6  *\r
7  * Permission is hereby granted, free of charge, to any person obtaining a copy of\r
8  * this software and associated documentation files (the "Software"), to deal in\r
9  * the Software without restriction, including without limitation the rights to\r
10  * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of\r
11  * the Software, and to permit persons to whom the Software is furnished to do so,\r
12  * subject to the following conditions:\r
13  *\r
14  * The above copyright notice and this permission notice shall be included in all\r
15  * copies or substantial portions of the Software.\r
16  *\r
17  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\r
18  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS\r
19  * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR\r
20  * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER\r
21  * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN\r
22  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\r
23  *\r
24  * https://www.FreeRTOS.org\r
25  * https://github.com/FreeRTOS\r
26  *\r
27  */\r
28 \r
29 /* Standard includes. */\r
30 #include <stdlib.h>\r
31 #include <string.h>\r
32 \r
33 /* Defining MPU_WRAPPERS_INCLUDED_FROM_API_FILE prevents task.h from redefining\r
34  * all the API functions to use the MPU wrappers.  That should only be done when\r
35  * task.h is included from an application file. */\r
36 #define MPU_WRAPPERS_INCLUDED_FROM_API_FILE\r
37 \r
38 /* FreeRTOS includes. */\r
39 #include "FreeRTOS.h"\r
40 #include "task.h"\r
41 #include "timers.h"\r
42 #include "stack_macros.h"\r
43 \r
44 /* Lint e9021, e961 and e750 are suppressed as a MISRA exception justified\r
45  * because the MPU ports require MPU_WRAPPERS_INCLUDED_FROM_API_FILE to be defined\r
46  * for the header files above, but not in this file, in order to generate the\r
47  * correct privileged Vs unprivileged linkage and placement. */\r
48 #undef MPU_WRAPPERS_INCLUDED_FROM_API_FILE /*lint !e961 !e750 !e9021. */\r
49 \r
50 /* Set configUSE_STATS_FORMATTING_FUNCTIONS to 2 to include the stats formatting\r
51  * functions but without including stdio.h here. */\r
52 #if ( configUSE_STATS_FORMATTING_FUNCTIONS == 1 )\r
53 \r
54 /* At the bottom of this file are two optional functions that can be used\r
55  * to generate human readable text from the raw data generated by the\r
56  * uxTaskGetSystemState() function.  Note the formatting functions are provided\r
57  * for convenience only, and are NOT considered part of the kernel. */\r
58     #include <stdio.h>\r
59 #endif /* configUSE_STATS_FORMATTING_FUNCTIONS == 1 ) */\r
60 \r
61 #if ( configUSE_PREEMPTION == 0 )\r
62 \r
63 /* If the cooperative scheduler is being used then a yield should not be\r
64  * performed just because a higher priority task has been woken. */\r
65     #define taskYIELD_IF_USING_PREEMPTION()\r
66 #else\r
67     #define taskYIELD_IF_USING_PREEMPTION()    portYIELD_WITHIN_API()\r
68 #endif\r
69 \r
70 /* Values that can be assigned to the ucNotifyState member of the TCB. */\r
71 #define taskNOT_WAITING_NOTIFICATION              ( ( uint8_t ) 0 ) /* Must be zero as it is the initialised value. */\r
72 #define taskWAITING_NOTIFICATION                  ( ( uint8_t ) 1 )\r
73 #define taskNOTIFICATION_RECEIVED                 ( ( uint8_t ) 2 )\r
74 \r
75 /*\r
76  * The value used to fill the stack of a task when the task is created.  This\r
77  * is used purely for checking the high water mark for tasks.\r
78  */\r
79 #define tskSTACK_FILL_BYTE                        ( 0xa5U )\r
80 \r
81 /* Bits used to record how a task's stack and TCB were allocated. */\r
82 #define tskDYNAMICALLY_ALLOCATED_STACK_AND_TCB    ( ( uint8_t ) 0 )\r
83 #define tskSTATICALLY_ALLOCATED_STACK_ONLY        ( ( uint8_t ) 1 )\r
84 #define tskSTATICALLY_ALLOCATED_STACK_AND_TCB     ( ( uint8_t ) 2 )\r
85 \r
86 /* If any of the following are set then task stacks are filled with a known\r
87  * value so the high water mark can be determined.  If none of the following are\r
88  * set then don't fill the stack so there is no unnecessary dependency on memset. */\r
89 #if ( ( configCHECK_FOR_STACK_OVERFLOW > 1 ) || ( configUSE_TRACE_FACILITY == 1 ) || ( INCLUDE_uxTaskGetStackHighWaterMark == 1 ) || ( INCLUDE_uxTaskGetStackHighWaterMark2 == 1 ) )\r
90     #define tskSET_NEW_STACKS_TO_KNOWN_VALUE    1\r
91 #else\r
92     #define tskSET_NEW_STACKS_TO_KNOWN_VALUE    0\r
93 #endif\r
94 \r
95 /*\r
96  * Macros used by vListTask to indicate which state a task is in.\r
97  */\r
98 #define tskRUNNING_CHAR      ( 'X' )\r
99 #define tskBLOCKED_CHAR      ( 'B' )\r
100 #define tskREADY_CHAR        ( 'R' )\r
101 #define tskDELETED_CHAR      ( 'D' )\r
102 #define tskSUSPENDED_CHAR    ( 'S' )\r
103 \r
104 /*\r
105  * Some kernel aware debuggers require the data the debugger needs access to to\r
106  * be global, rather than file scope.\r
107  */\r
108 #ifdef portREMOVE_STATIC_QUALIFIER\r
109     #define static\r
110 #endif\r
111 \r
112 /* The name allocated to the Idle task.  This can be overridden by defining\r
113  * configIDLE_TASK_NAME in FreeRTOSConfig.h. */\r
114 #ifndef configIDLE_TASK_NAME\r
115     #define configIDLE_TASK_NAME    "IDLE"\r
116 #endif\r
117 \r
118 #if ( configUSE_PORT_OPTIMISED_TASK_SELECTION == 0 )\r
119 \r
120 /* If configUSE_PORT_OPTIMISED_TASK_SELECTION is 0 then task selection is\r
121  * performed in a generic way that is not optimised to any particular\r
122  * microcontroller architecture. */\r
123 \r
124 /* uxTopReadyPriority holds the priority of the highest priority ready\r
125  * state task. */\r
126     #define taskRECORD_READY_PRIORITY( uxPriority ) \\r
127     {                                               \\r
128         if( ( uxPriority ) > uxTopReadyPriority )   \\r
129         {                                           \\r
130             uxTopReadyPriority = ( uxPriority );    \\r
131         }                                           \\r
132     } /* taskRECORD_READY_PRIORITY */\r
133 \r
134 /*-----------------------------------------------------------*/\r
135 \r
136     #define taskSELECT_HIGHEST_PRIORITY_TASK()                                \\r
137     {                                                                         \\r
138         UBaseType_t uxTopPriority = uxTopReadyPriority;                       \\r
139                                                                               \\r
140         /* Find the highest priority queue that contains ready tasks. */      \\r
141         while( listLIST_IS_EMPTY( &( pxReadyTasksLists[ uxTopPriority ] ) ) ) \\r
142         {                                                                     \\r
143             configASSERT( uxTopPriority );                                    \\r
144             --uxTopPriority;                                                  \\r
145         }                                                                     \\r
146                                                                               \\r
147         /* listGET_OWNER_OF_NEXT_ENTRY indexes through the list, so the tasks of \\r
148          * the  same priority get an equal share of the processor time. */                    \\r
149         listGET_OWNER_OF_NEXT_ENTRY( pxCurrentTCB, &( pxReadyTasksLists[ uxTopPriority ] ) ); \\r
150         uxTopReadyPriority = uxTopPriority;                                                   \\r
151     } /* taskSELECT_HIGHEST_PRIORITY_TASK */\r
152 \r
153 /*-----------------------------------------------------------*/\r
154 \r
155 /* Define away taskRESET_READY_PRIORITY() and portRESET_READY_PRIORITY() as\r
156  * they are only required when a port optimised method of task selection is\r
157  * being used. */\r
158     #define taskRESET_READY_PRIORITY( uxPriority )\r
159     #define portRESET_READY_PRIORITY( uxPriority, uxTopReadyPriority )\r
160 \r
161 #else /* configUSE_PORT_OPTIMISED_TASK_SELECTION */\r
162 \r
163 /* If configUSE_PORT_OPTIMISED_TASK_SELECTION is 1 then task selection is\r
164  * performed in a way that is tailored to the particular microcontroller\r
165  * architecture being used. */\r
166 \r
167 /* A port optimised version is provided.  Call the port defined macros. */\r
168     #define taskRECORD_READY_PRIORITY( uxPriority )    portRECORD_READY_PRIORITY( uxPriority, uxTopReadyPriority )\r
169 \r
170 /*-----------------------------------------------------------*/\r
171 \r
172     #define taskSELECT_HIGHEST_PRIORITY_TASK()                                                  \\r
173     {                                                                                           \\r
174         UBaseType_t uxTopPriority;                                                              \\r
175                                                                                                 \\r
176         /* Find the highest priority list that contains ready tasks. */                         \\r
177         portGET_HIGHEST_PRIORITY( uxTopPriority, uxTopReadyPriority );                          \\r
178         configASSERT( listCURRENT_LIST_LENGTH( &( pxReadyTasksLists[ uxTopPriority ] ) ) > 0 ); \\r
179         listGET_OWNER_OF_NEXT_ENTRY( pxCurrentTCB, &( pxReadyTasksLists[ uxTopPriority ] ) );   \\r
180     } /* taskSELECT_HIGHEST_PRIORITY_TASK() */\r
181 \r
182 /*-----------------------------------------------------------*/\r
183 \r
184 /* A port optimised version is provided, call it only if the TCB being reset\r
185  * is being referenced from a ready list.  If it is referenced from a delayed\r
186  * or suspended list then it won't be in a ready list. */\r
187     #define taskRESET_READY_PRIORITY( uxPriority )                                                     \\r
188     {                                                                                                  \\r
189         if( listCURRENT_LIST_LENGTH( &( pxReadyTasksLists[ ( uxPriority ) ] ) ) == ( UBaseType_t ) 0 ) \\r
190         {                                                                                              \\r
191             portRESET_READY_PRIORITY( ( uxPriority ), ( uxTopReadyPriority ) );                        \\r
192         }                                                                                              \\r
193     }\r
194 \r
195 #endif /* configUSE_PORT_OPTIMISED_TASK_SELECTION */\r
196 \r
197 /*-----------------------------------------------------------*/\r
198 \r
199 /* pxDelayedTaskList and pxOverflowDelayedTaskList are switched when the tick\r
200  * count overflows. */\r
201 #define taskSWITCH_DELAYED_LISTS()                                                \\r
202     {                                                                             \\r
203         List_t * pxTemp;                                                          \\r
204                                                                                   \\r
205         /* The delayed tasks list should be empty when the lists are switched. */ \\r
206         configASSERT( ( listLIST_IS_EMPTY( pxDelayedTaskList ) ) );               \\r
207                                                                                   \\r
208         pxTemp = pxDelayedTaskList;                                               \\r
209         pxDelayedTaskList = pxOverflowDelayedTaskList;                            \\r
210         pxOverflowDelayedTaskList = pxTemp;                                       \\r
211         xNumOfOverflows++;                                                        \\r
212         prvResetNextTaskUnblockTime();                                            \\r
213     }\r
214 \r
215 /*-----------------------------------------------------------*/\r
216 \r
217 /*\r
218  * Place the task represented by pxTCB into the appropriate ready list for\r
219  * the task.  It is inserted at the end of the list.\r
220  */\r
221 #define prvAddTaskToReadyList( pxTCB )                                                                 \\r
222     traceMOVED_TASK_TO_READY_STATE( pxTCB );                                                           \\r
223     taskRECORD_READY_PRIORITY( ( pxTCB )->uxPriority );                                                \\r
224     listINSERT_END( &( pxReadyTasksLists[ ( pxTCB )->uxPriority ] ), &( ( pxTCB )->xStateListItem ) ); \\r
225     tracePOST_MOVED_TASK_TO_READY_STATE( pxTCB )\r
226 /*-----------------------------------------------------------*/\r
227 \r
228 /*\r
229  * Several functions take a TaskHandle_t parameter that can optionally be NULL,\r
230  * where NULL is used to indicate that the handle of the currently executing\r
231  * task should be used in place of the parameter.  This macro simply checks to\r
232  * see if the parameter is NULL and returns a pointer to the appropriate TCB.\r
233  */\r
234 #define prvGetTCBFromHandle( pxHandle )    ( ( ( pxHandle ) == NULL ) ? pxCurrentTCB : ( pxHandle ) )\r
235 \r
236 /* The item value of the event list item is normally used to hold the priority\r
237  * of the task to which it belongs (coded to allow it to be held in reverse\r
238  * priority order).  However, it is occasionally borrowed for other purposes.  It\r
239  * is important its value is not updated due to a task priority change while it is\r
240  * being used for another purpose.  The following bit definition is used to inform\r
241  * the scheduler that the value should not be changed - in which case it is the\r
242  * responsibility of whichever module is using the value to ensure it gets set back\r
243  * to its original value when it is released. */\r
244 #if ( configUSE_16_BIT_TICKS == 1 )\r
245     #define taskEVENT_LIST_ITEM_VALUE_IN_USE    0x8000U\r
246 #else\r
247     #define taskEVENT_LIST_ITEM_VALUE_IN_USE    0x80000000UL\r
248 #endif\r
249 \r
250 /*\r
251  * Task control block.  A task control block (TCB) is allocated for each task,\r
252  * and stores task state information, including a pointer to the task's context\r
253  * (the task's run time environment, including register values)\r
254  */\r
255 typedef struct tskTaskControlBlock       /* The old naming convention is used to prevent breaking kernel aware debuggers. */\r
256 {\r
257     volatile StackType_t * 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
258 \r
259     #if ( portUSING_MPU_WRAPPERS == 1 )\r
260         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
261     #endif\r
262 \r
263     ListItem_t xStateListItem;                  /*< The list that the state list item of a task is reference from denotes the state of that task (Ready, Blocked, Suspended ). */\r
264     ListItem_t xEventListItem;                  /*< Used to reference a task from an event list. */\r
265     UBaseType_t uxPriority;                     /*< The priority of the task.  0 is the lowest priority. */\r
266     StackType_t * pxStack;                      /*< Points to the start of the stack. */\r
267     char pcTaskName[ configMAX_TASK_NAME_LEN ]; /*< Descriptive name given to the task when created.  Facilitates debugging only. */ /*lint !e971 Unqualified char types are allowed for strings and single characters only. */\r
268 \r
269     #if ( ( portSTACK_GROWTH > 0 ) || ( configRECORD_STACK_HIGH_ADDRESS == 1 ) )\r
270         StackType_t * pxEndOfStack; /*< Points to the highest valid address for the stack. */\r
271     #endif\r
272 \r
273     #if ( portCRITICAL_NESTING_IN_TCB == 1 )\r
274         UBaseType_t uxCriticalNesting; /*< Holds the critical section nesting depth for ports that do not maintain their own count in the port layer. */\r
275     #endif\r
276 \r
277     #if ( configUSE_TRACE_FACILITY == 1 )\r
278         UBaseType_t 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
279         UBaseType_t uxTaskNumber; /*< Stores a number specifically for use by third party trace code. */\r
280     #endif\r
281 \r
282     #if ( configUSE_MUTEXES == 1 )\r
283         UBaseType_t uxBasePriority; /*< The priority last assigned to the task - used by the priority inheritance mechanism. */\r
284         UBaseType_t uxMutexesHeld;\r
285     #endif\r
286 \r
287     #if ( configUSE_APPLICATION_TASK_TAG == 1 )\r
288         TaskHookFunction_t pxTaskTag;\r
289     #endif\r
290 \r
291     #if ( configNUM_THREAD_LOCAL_STORAGE_POINTERS > 0 )\r
292         void * pvThreadLocalStoragePointers[ configNUM_THREAD_LOCAL_STORAGE_POINTERS ];\r
293     #endif\r
294 \r
295     #if ( configGENERATE_RUN_TIME_STATS == 1 )\r
296         configRUN_TIME_COUNTER_TYPE ulRunTimeCounter; /*< Stores the amount of time the task has spent in the Running state. */\r
297     #endif\r
298 \r
299     #if ( configUSE_NEWLIB_REENTRANT == 1 )\r
300 \r
301         /* Allocate a Newlib reent structure that is specific to this task.\r
302          * Note Newlib support has been included by popular demand, but is not\r
303          * used by the FreeRTOS maintainers themselves.  FreeRTOS is not\r
304          * responsible for resulting newlib operation.  User must be familiar with\r
305          * newlib and must provide system-wide implementations of the necessary\r
306          * stubs. Be warned that (at the time of writing) the current newlib design\r
307          * implements a system-wide malloc() that must be provided with locks.\r
308          *\r
309          * See the third party link http://www.nadler.com/embedded/newlibAndFreeRTOS.html\r
310          * for additional information. */\r
311         struct  _reent xNewLib_reent;\r
312     #endif\r
313 \r
314     #if ( configUSE_TASK_NOTIFICATIONS == 1 )\r
315         volatile uint32_t ulNotifiedValue[ configTASK_NOTIFICATION_ARRAY_ENTRIES ];\r
316         volatile uint8_t ucNotifyState[ configTASK_NOTIFICATION_ARRAY_ENTRIES ];\r
317     #endif\r
318 \r
319     /* See the comments in FreeRTOS.h with the definition of\r
320      * tskSTATIC_AND_DYNAMIC_ALLOCATION_POSSIBLE. */\r
321     #if ( tskSTATIC_AND_DYNAMIC_ALLOCATION_POSSIBLE != 0 ) /*lint !e731 !e9029 Macro has been consolidated for readability reasons. */\r
322         uint8_t ucStaticallyAllocated;                     /*< Set to pdTRUE if the task is a statically allocated to ensure no attempt is made to free the memory. */\r
323     #endif\r
324 \r
325     #if ( INCLUDE_xTaskAbortDelay == 1 )\r
326         uint8_t ucDelayAborted;\r
327     #endif\r
328 \r
329     #if ( configUSE_POSIX_ERRNO == 1 )\r
330         int iTaskErrno;\r
331     #endif\r
332 } tskTCB;\r
333 \r
334 /* The old tskTCB name is maintained above then typedefed to the new TCB_t name\r
335  * below to enable the use of older kernel aware debuggers. */\r
336 typedef tskTCB TCB_t;\r
337 \r
338 /*lint -save -e956 A manual analysis and inspection has been used to determine\r
339  * which static variables must be declared volatile. */\r
340 portDONT_DISCARD PRIVILEGED_DATA TCB_t * volatile pxCurrentTCB = NULL;\r
341 \r
342 /* Lists for ready and blocked tasks. --------------------\r
343  * xDelayedTaskList1 and xDelayedTaskList2 could be moved to function scope but\r
344  * doing so breaks some kernel aware debuggers and debuggers that rely on removing\r
345  * the static qualifier. */\r
346 PRIVILEGED_DATA static List_t pxReadyTasksLists[ configMAX_PRIORITIES ]; /*< Prioritised ready tasks. */\r
347 PRIVILEGED_DATA static List_t xDelayedTaskList1;                         /*< Delayed tasks. */\r
348 PRIVILEGED_DATA static List_t xDelayedTaskList2;                         /*< Delayed tasks (two lists are used - one for delays that have overflowed the current tick count. */\r
349 PRIVILEGED_DATA static List_t * volatile pxDelayedTaskList;              /*< Points to the delayed task list currently being used. */\r
350 PRIVILEGED_DATA static List_t * volatile pxOverflowDelayedTaskList;      /*< Points to the delayed task list currently being used to hold tasks that have overflowed the current tick count. */\r
351 PRIVILEGED_DATA static List_t 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
352 \r
353 #if ( INCLUDE_vTaskDelete == 1 )\r
354 \r
355     PRIVILEGED_DATA static List_t xTasksWaitingTermination; /*< Tasks that have been deleted - but their memory not yet freed. */\r
356     PRIVILEGED_DATA static volatile UBaseType_t uxDeletedTasksWaitingCleanUp = ( UBaseType_t ) 0U;\r
357 \r
358 #endif\r
359 \r
360 #if ( INCLUDE_vTaskSuspend == 1 )\r
361 \r
362     PRIVILEGED_DATA static List_t xSuspendedTaskList; /*< Tasks that are currently suspended. */\r
363 \r
364 #endif\r
365 \r
366 /* Global POSIX errno. Its value is changed upon context switching to match\r
367  * the errno of the currently running task. */\r
368 #if ( configUSE_POSIX_ERRNO == 1 )\r
369     int FreeRTOS_errno = 0;\r
370 #endif\r
371 \r
372 /* Other file private variables. --------------------------------*/\r
373 PRIVILEGED_DATA static volatile UBaseType_t uxCurrentNumberOfTasks = ( UBaseType_t ) 0U;\r
374 PRIVILEGED_DATA static volatile TickType_t xTickCount = ( TickType_t ) configINITIAL_TICK_COUNT;\r
375 PRIVILEGED_DATA static volatile UBaseType_t uxTopReadyPriority = tskIDLE_PRIORITY;\r
376 PRIVILEGED_DATA static volatile BaseType_t xSchedulerRunning = pdFALSE;\r
377 PRIVILEGED_DATA static volatile TickType_t xPendedTicks = ( TickType_t ) 0U;\r
378 PRIVILEGED_DATA static volatile BaseType_t xYieldPending = pdFALSE;\r
379 PRIVILEGED_DATA static volatile BaseType_t xNumOfOverflows = ( BaseType_t ) 0;\r
380 PRIVILEGED_DATA static UBaseType_t uxTaskNumber = ( UBaseType_t ) 0U;\r
381 PRIVILEGED_DATA static volatile TickType_t xNextTaskUnblockTime = ( TickType_t ) 0U; /* Initialised to portMAX_DELAY before the scheduler starts. */\r
382 PRIVILEGED_DATA static TaskHandle_t xIdleTaskHandle = NULL;                          /*< Holds the handle of the idle task.  The idle task is created automatically when the scheduler is started. */\r
383 \r
384 /* Improve support for OpenOCD. The kernel tracks Ready tasks via priority lists.\r
385  * For tracking the state of remote threads, OpenOCD uses uxTopUsedPriority\r
386  * to determine the number of priority lists to read back from the remote target. */\r
387 const volatile UBaseType_t uxTopUsedPriority = configMAX_PRIORITIES - 1U;\r
388 \r
389 /* Context switches are held pending while the scheduler is suspended.  Also,\r
390  * interrupts must not manipulate the xStateListItem of a TCB, or any of the\r
391  * lists the xStateListItem can be referenced from, if the scheduler is suspended.\r
392  * If an interrupt needs to unblock a task while the scheduler is suspended then it\r
393  * moves the task's event list item into the xPendingReadyList, ready for the\r
394  * kernel to move the task from the pending ready list into the real ready list\r
395  * when the scheduler is unsuspended.  The pending ready list itself can only be\r
396  * accessed from a critical section. */\r
397 PRIVILEGED_DATA static volatile UBaseType_t uxSchedulerSuspended = ( UBaseType_t ) pdFALSE;\r
398 \r
399 #if ( configGENERATE_RUN_TIME_STATS == 1 )\r
400 \r
401 /* Do not move these variables to function scope as doing so prevents the\r
402  * code working with debuggers that need to remove the static qualifier. */\r
403     PRIVILEGED_DATA static configRUN_TIME_COUNTER_TYPE ulTaskSwitchedInTime = 0UL;    /*< Holds the value of a timer/counter the last time a task was switched in. */\r
404     PRIVILEGED_DATA static volatile configRUN_TIME_COUNTER_TYPE ulTotalRunTime = 0UL; /*< Holds the total amount of execution time as defined by the run time counter clock. */\r
405 \r
406 #endif\r
407 \r
408 /*lint -restore */\r
409 \r
410 /*-----------------------------------------------------------*/\r
411 \r
412 /* File private functions. --------------------------------*/\r
413 \r
414 /**\r
415  * Utility task that simply returns pdTRUE if the task referenced by xTask is\r
416  * currently in the Suspended state, or pdFALSE if the task referenced by xTask\r
417  * is in any other state.\r
418  */\r
419 #if ( INCLUDE_vTaskSuspend == 1 )\r
420 \r
421     static BaseType_t prvTaskIsTaskSuspended( const TaskHandle_t xTask ) PRIVILEGED_FUNCTION;\r
422 \r
423 #endif /* INCLUDE_vTaskSuspend */\r
424 \r
425 /*\r
426  * Utility to ready all the lists used by the scheduler.  This is called\r
427  * automatically upon the creation of the first task.\r
428  */\r
429 static void prvInitialiseTaskLists( void ) PRIVILEGED_FUNCTION;\r
430 \r
431 /*\r
432  * The idle task, which as all tasks is implemented as a never ending loop.\r
433  * The idle task is automatically created and added to the ready lists upon\r
434  * creation of the first user task.\r
435  *\r
436  * The portTASK_FUNCTION_PROTO() macro is used to allow port/compiler specific\r
437  * language extensions.  The equivalent prototype for this function is:\r
438  *\r
439  * void prvIdleTask( void *pvParameters );\r
440  *\r
441  */\r
442 static portTASK_FUNCTION_PROTO( prvIdleTask, pvParameters ) PRIVILEGED_FUNCTION;\r
443 \r
444 /*\r
445  * Utility to free all memory allocated by the scheduler to hold a TCB,\r
446  * including the stack pointed to by the TCB.\r
447  *\r
448  * This does not free memory allocated by the task itself (i.e. memory\r
449  * allocated by calls to pvPortMalloc from within the tasks application code).\r
450  */\r
451 #if ( INCLUDE_vTaskDelete == 1 )\r
452 \r
453     static void prvDeleteTCB( TCB_t * pxTCB ) PRIVILEGED_FUNCTION;\r
454 \r
455 #endif\r
456 \r
457 /*\r
458  * Used only by the idle task.  This checks to see if anything has been placed\r
459  * in the list of tasks waiting to be deleted.  If so the task is cleaned up\r
460  * and its TCB deleted.\r
461  */\r
462 static void prvCheckTasksWaitingTermination( void ) PRIVILEGED_FUNCTION;\r
463 \r
464 /*\r
465  * The currently executing task is entering the Blocked state.  Add the task to\r
466  * either the current or the overflow delayed task list.\r
467  */\r
468 static void prvAddCurrentTaskToDelayedList( TickType_t xTicksToWait,\r
469                                             const BaseType_t xCanBlockIndefinitely ) PRIVILEGED_FUNCTION;\r
470 \r
471 /*\r
472  * Fills an TaskStatus_t structure with information on each task that is\r
473  * referenced from the pxList list (which may be a ready list, a delayed list,\r
474  * a suspended list, etc.).\r
475  *\r
476  * THIS FUNCTION IS INTENDED FOR DEBUGGING ONLY, AND SHOULD NOT BE CALLED FROM\r
477  * NORMAL APPLICATION CODE.\r
478  */\r
479 #if ( configUSE_TRACE_FACILITY == 1 )\r
480 \r
481     static UBaseType_t prvListTasksWithinSingleList( TaskStatus_t * pxTaskStatusArray,\r
482                                                      List_t * pxList,\r
483                                                      eTaskState eState ) PRIVILEGED_FUNCTION;\r
484 \r
485 #endif\r
486 \r
487 /*\r
488  * Searches pxList for a task with name pcNameToQuery - returning a handle to\r
489  * the task if it is found, or NULL if the task is not found.\r
490  */\r
491 #if ( INCLUDE_xTaskGetHandle == 1 )\r
492 \r
493     static TCB_t * prvSearchForNameWithinSingleList( List_t * pxList,\r
494                                                      const char pcNameToQuery[] ) PRIVILEGED_FUNCTION;\r
495 \r
496 #endif\r
497 \r
498 /*\r
499  * When a task is created, the stack of the task is filled with a known value.\r
500  * This function determines the 'high water mark' of the task stack by\r
501  * determining how much of the stack remains at the original preset value.\r
502  */\r
503 #if ( ( configUSE_TRACE_FACILITY == 1 ) || ( INCLUDE_uxTaskGetStackHighWaterMark == 1 ) || ( INCLUDE_uxTaskGetStackHighWaterMark2 == 1 ) )\r
504 \r
505     static configSTACK_DEPTH_TYPE prvTaskCheckFreeStackSpace( const uint8_t * pucStackByte ) PRIVILEGED_FUNCTION;\r
506 \r
507 #endif\r
508 \r
509 /*\r
510  * Return the amount of time, in ticks, that will pass before the kernel will\r
511  * next move a task from the Blocked state to the Running state.\r
512  *\r
513  * This conditional compilation should use inequality to 0, not equality to 1.\r
514  * This is to ensure portSUPPRESS_TICKS_AND_SLEEP() can be called when user\r
515  * defined low power mode implementations require configUSE_TICKLESS_IDLE to be\r
516  * set to a value other than 1.\r
517  */\r
518 #if ( configUSE_TICKLESS_IDLE != 0 )\r
519 \r
520     static TickType_t prvGetExpectedIdleTime( void ) PRIVILEGED_FUNCTION;\r
521 \r
522 #endif\r
523 \r
524 /*\r
525  * Set xNextTaskUnblockTime to the time at which the next Blocked state task\r
526  * will exit the Blocked state.\r
527  */\r
528 static void prvResetNextTaskUnblockTime( void ) PRIVILEGED_FUNCTION;\r
529 \r
530 #if ( ( ( configUSE_TRACE_FACILITY == 1 ) || ( configGENERATE_RUN_TIME_STATS == 1 ) ) && \\r
531     ( configUSE_STATS_FORMATTING_FUNCTIONS > 0 ) &&                                      \\r
532     ( configSUPPORT_DYNAMIC_ALLOCATION == 1 ) )\r
533 \r
534 /*\r
535  * Helper function used to pad task names with spaces when printing out\r
536  * human readable tables of task information.\r
537  */\r
538     static char * prvWriteNameToBuffer( char * pcBuffer,\r
539                                         const char * pcTaskName ) PRIVILEGED_FUNCTION;\r
540 \r
541 #endif\r
542 \r
543 /*\r
544  * Called after a Task_t structure has been allocated either statically or\r
545  * dynamically to fill in the structure's members.\r
546  */\r
547 static void prvInitialiseNewTask( TaskFunction_t pxTaskCode,\r
548                                   const char * const pcName, /*lint !e971 Unqualified char types are allowed for strings and single characters only. */\r
549                                   const uint32_t ulStackDepth,\r
550                                   void * const pvParameters,\r
551                                   UBaseType_t uxPriority,\r
552                                   TaskHandle_t * const pxCreatedTask,\r
553                                   TCB_t * pxNewTCB,\r
554                                   const MemoryRegion_t * const xRegions ) PRIVILEGED_FUNCTION;\r
555 \r
556 /*\r
557  * Called after a new task has been created and initialised to place the task\r
558  * under the control of the scheduler.\r
559  */\r
560 static void prvAddNewTaskToReadyList( TCB_t * pxNewTCB ) PRIVILEGED_FUNCTION;\r
561 \r
562 /*\r
563  * freertos_tasks_c_additions_init() should only be called if the user definable\r
564  * macro FREERTOS_TASKS_C_ADDITIONS_INIT() is defined, as that is the only macro\r
565  * called by the function.\r
566  */\r
567 #ifdef FREERTOS_TASKS_C_ADDITIONS_INIT\r
568 \r
569     static void freertos_tasks_c_additions_init( void ) PRIVILEGED_FUNCTION;\r
570 \r
571 #endif\r
572 \r
573 /*-----------------------------------------------------------*/\r
574 \r
575 #if ( configSUPPORT_STATIC_ALLOCATION == 1 )\r
576 \r
577     TaskHandle_t xTaskCreateStatic( TaskFunction_t pxTaskCode,\r
578                                     const char * const pcName, /*lint !e971 Unqualified char types are allowed for strings and single characters only. */\r
579                                     const uint32_t ulStackDepth,\r
580                                     void * const pvParameters,\r
581                                     UBaseType_t uxPriority,\r
582                                     StackType_t * const puxStackBuffer,\r
583                                     StaticTask_t * const pxTaskBuffer )\r
584     {\r
585         TCB_t * pxNewTCB;\r
586         TaskHandle_t xReturn;\r
587 \r
588         configASSERT( puxStackBuffer != NULL );\r
589         configASSERT( pxTaskBuffer != NULL );\r
590 \r
591         #if ( configASSERT_DEFINED == 1 )\r
592         {\r
593             /* Sanity check that the size of the structure used to declare a\r
594              * variable of type StaticTask_t equals the size of the real task\r
595              * structure. */\r
596             volatile size_t xSize = sizeof( StaticTask_t );\r
597             configASSERT( xSize == sizeof( TCB_t ) );\r
598             ( void ) xSize; /* Prevent lint warning when configASSERT() is not used. */\r
599         }\r
600         #endif /* configASSERT_DEFINED */\r
601 \r
602         if( ( pxTaskBuffer != NULL ) && ( puxStackBuffer != NULL ) )\r
603         {\r
604             /* The memory used for the task's TCB and stack are passed into this\r
605              * function - use them. */\r
606             pxNewTCB = ( TCB_t * ) pxTaskBuffer; /*lint !e740 !e9087 Unusual cast is ok as the structures are designed to have the same alignment, and the size is checked by an assert. */\r
607             memset( ( void * ) pxNewTCB, 0x00, sizeof( TCB_t ) );\r
608             pxNewTCB->pxStack = ( StackType_t * ) puxStackBuffer;\r
609 \r
610             #if ( tskSTATIC_AND_DYNAMIC_ALLOCATION_POSSIBLE != 0 ) /*lint !e731 !e9029 Macro has been consolidated for readability reasons. */\r
611             {\r
612                 /* Tasks can be created statically or dynamically, so note this\r
613                  * task was created statically in case the task is later deleted. */\r
614                 pxNewTCB->ucStaticallyAllocated = tskSTATICALLY_ALLOCATED_STACK_AND_TCB;\r
615             }\r
616             #endif /* tskSTATIC_AND_DYNAMIC_ALLOCATION_POSSIBLE */\r
617 \r
618             prvInitialiseNewTask( pxTaskCode, pcName, ulStackDepth, pvParameters, uxPriority, &xReturn, pxNewTCB, NULL );\r
619             prvAddNewTaskToReadyList( pxNewTCB );\r
620         }\r
621         else\r
622         {\r
623             xReturn = NULL;\r
624         }\r
625 \r
626         return xReturn;\r
627     }\r
628 \r
629 #endif /* SUPPORT_STATIC_ALLOCATION */\r
630 /*-----------------------------------------------------------*/\r
631 \r
632 #if ( ( portUSING_MPU_WRAPPERS == 1 ) && ( configSUPPORT_STATIC_ALLOCATION == 1 ) )\r
633 \r
634     BaseType_t xTaskCreateRestrictedStatic( const TaskParameters_t * const pxTaskDefinition,\r
635                                             TaskHandle_t * pxCreatedTask )\r
636     {\r
637         TCB_t * pxNewTCB;\r
638         BaseType_t xReturn = errCOULD_NOT_ALLOCATE_REQUIRED_MEMORY;\r
639 \r
640         configASSERT( pxTaskDefinition->puxStackBuffer != NULL );\r
641         configASSERT( pxTaskDefinition->pxTaskBuffer != NULL );\r
642 \r
643         if( ( pxTaskDefinition->puxStackBuffer != NULL ) && ( pxTaskDefinition->pxTaskBuffer != NULL ) )\r
644         {\r
645             /* Allocate space for the TCB.  Where the memory comes from depends\r
646              * on the implementation of the port malloc function and whether or\r
647              * not static allocation is being used. */\r
648             pxNewTCB = ( TCB_t * ) pxTaskDefinition->pxTaskBuffer;\r
649             memset( ( void * ) pxNewTCB, 0x00, sizeof( TCB_t ) );\r
650 \r
651             /* Store the stack location in the TCB. */\r
652             pxNewTCB->pxStack = pxTaskDefinition->puxStackBuffer;\r
653 \r
654             #if ( tskSTATIC_AND_DYNAMIC_ALLOCATION_POSSIBLE != 0 )\r
655             {\r
656                 /* Tasks can be created statically or dynamically, so note this\r
657                  * task was created statically in case the task is later deleted. */\r
658                 pxNewTCB->ucStaticallyAllocated = tskSTATICALLY_ALLOCATED_STACK_AND_TCB;\r
659             }\r
660             #endif /* tskSTATIC_AND_DYNAMIC_ALLOCATION_POSSIBLE */\r
661 \r
662             prvInitialiseNewTask( pxTaskDefinition->pvTaskCode,\r
663                                   pxTaskDefinition->pcName,\r
664                                   ( uint32_t ) pxTaskDefinition->usStackDepth,\r
665                                   pxTaskDefinition->pvParameters,\r
666                                   pxTaskDefinition->uxPriority,\r
667                                   pxCreatedTask, pxNewTCB,\r
668                                   pxTaskDefinition->xRegions );\r
669 \r
670             prvAddNewTaskToReadyList( pxNewTCB );\r
671             xReturn = pdPASS;\r
672         }\r
673 \r
674         return xReturn;\r
675     }\r
676 \r
677 #endif /* ( portUSING_MPU_WRAPPERS == 1 ) && ( configSUPPORT_STATIC_ALLOCATION == 1 ) */\r
678 /*-----------------------------------------------------------*/\r
679 \r
680 #if ( ( portUSING_MPU_WRAPPERS == 1 ) && ( configSUPPORT_DYNAMIC_ALLOCATION == 1 ) )\r
681 \r
682     BaseType_t xTaskCreateRestricted( const TaskParameters_t * const pxTaskDefinition,\r
683                                       TaskHandle_t * pxCreatedTask )\r
684     {\r
685         TCB_t * pxNewTCB;\r
686         BaseType_t xReturn = errCOULD_NOT_ALLOCATE_REQUIRED_MEMORY;\r
687 \r
688         configASSERT( pxTaskDefinition->puxStackBuffer );\r
689 \r
690         if( pxTaskDefinition->puxStackBuffer != NULL )\r
691         {\r
692             /* Allocate space for the TCB.  Where the memory comes from depends\r
693              * on the implementation of the port malloc function and whether or\r
694              * not static allocation is being used. */\r
695             pxNewTCB = ( TCB_t * ) pvPortMalloc( sizeof( TCB_t ) );\r
696 \r
697             if( pxNewTCB != NULL )\r
698             {\r
699                 memset( ( void * ) pxNewTCB, 0x00, sizeof( TCB_t ) );\r
700 \r
701                 /* Store the stack location in the TCB. */\r
702                 pxNewTCB->pxStack = pxTaskDefinition->puxStackBuffer;\r
703 \r
704                 #if ( tskSTATIC_AND_DYNAMIC_ALLOCATION_POSSIBLE != 0 )\r
705                 {\r
706                     /* Tasks can be created statically or dynamically, so note\r
707                      * this task had a statically allocated stack in case it is\r
708                      * later deleted.  The TCB was allocated dynamically. */\r
709                     pxNewTCB->ucStaticallyAllocated = tskSTATICALLY_ALLOCATED_STACK_ONLY;\r
710                 }\r
711                 #endif /* tskSTATIC_AND_DYNAMIC_ALLOCATION_POSSIBLE */\r
712 \r
713                 prvInitialiseNewTask( pxTaskDefinition->pvTaskCode,\r
714                                       pxTaskDefinition->pcName,\r
715                                       ( uint32_t ) pxTaskDefinition->usStackDepth,\r
716                                       pxTaskDefinition->pvParameters,\r
717                                       pxTaskDefinition->uxPriority,\r
718                                       pxCreatedTask, pxNewTCB,\r
719                                       pxTaskDefinition->xRegions );\r
720 \r
721                 prvAddNewTaskToReadyList( pxNewTCB );\r
722                 xReturn = pdPASS;\r
723             }\r
724         }\r
725 \r
726         return xReturn;\r
727     }\r
728 \r
729 #endif /* portUSING_MPU_WRAPPERS */\r
730 /*-----------------------------------------------------------*/\r
731 \r
732 #if ( configSUPPORT_DYNAMIC_ALLOCATION == 1 )\r
733 \r
734     BaseType_t xTaskCreate( TaskFunction_t pxTaskCode,\r
735                             const char * const pcName, /*lint !e971 Unqualified char types are allowed for strings and single characters only. */\r
736                             const configSTACK_DEPTH_TYPE usStackDepth,\r
737                             void * const pvParameters,\r
738                             UBaseType_t uxPriority,\r
739                             TaskHandle_t * const pxCreatedTask )\r
740     {\r
741         TCB_t * pxNewTCB;\r
742         BaseType_t xReturn;\r
743 \r
744         /* If the stack grows down then allocate the stack then the TCB so the stack\r
745          * does not grow into the TCB.  Likewise if the stack grows up then allocate\r
746          * the TCB then the stack. */\r
747         #if ( portSTACK_GROWTH > 0 )\r
748         {\r
749             /* Allocate space for the TCB.  Where the memory comes from depends on\r
750              * the implementation of the port malloc function and whether or not static\r
751              * allocation is being used. */\r
752             pxNewTCB = ( TCB_t * ) pvPortMalloc( sizeof( TCB_t ) );\r
753 \r
754             if( pxNewTCB != NULL )\r
755             {\r
756                 memset( ( void * ) pxNewTCB, 0x00, sizeof( TCB_t ) );\r
757 \r
758                 /* Allocate space for the stack used by the task being created.\r
759                  * The base of the stack memory stored in the TCB so the task can\r
760                  * be deleted later if required. */\r
761                 pxNewTCB->pxStack = ( StackType_t * ) pvPortMallocStack( ( ( ( size_t ) usStackDepth ) * sizeof( StackType_t ) ) ); /*lint !e961 MISRA exception as the casts are only redundant for some ports. */\r
762 \r
763                 if( pxNewTCB->pxStack == NULL )\r
764                 {\r
765                     /* Could not allocate the stack.  Delete the allocated TCB. */\r
766                     vPortFree( pxNewTCB );\r
767                     pxNewTCB = NULL;\r
768                 }\r
769             }\r
770         }\r
771         #else /* portSTACK_GROWTH */\r
772         {\r
773             StackType_t * pxStack;\r
774 \r
775             /* Allocate space for the stack used by the task being created. */\r
776             pxStack = pvPortMallocStack( ( ( ( size_t ) usStackDepth ) * sizeof( StackType_t ) ) ); /*lint !e9079 All values returned by pvPortMalloc() have at least the alignment required by the MCU's stack and this allocation is the stack. */\r
777 \r
778             if( pxStack != NULL )\r
779             {\r
780                 /* Allocate space for the TCB. */\r
781                 pxNewTCB = ( TCB_t * ) pvPortMalloc( sizeof( TCB_t ) ); /*lint !e9087 !e9079 All values returned by pvPortMalloc() have at least the alignment required by the MCU's stack, and the first member of TCB_t is always a pointer to the task's stack. */\r
782 \r
783                 if( pxNewTCB != NULL )\r
784                 {\r
785                     memset( ( void * ) pxNewTCB, 0x00, sizeof( TCB_t ) );\r
786 \r
787                     /* Store the stack location in the TCB. */\r
788                     pxNewTCB->pxStack = pxStack;\r
789                 }\r
790                 else\r
791                 {\r
792                     /* The stack cannot be used as the TCB was not created.  Free\r
793                      * it again. */\r
794                     vPortFreeStack( pxStack );\r
795                 }\r
796             }\r
797             else\r
798             {\r
799                 pxNewTCB = NULL;\r
800             }\r
801         }\r
802         #endif /* portSTACK_GROWTH */\r
803 \r
804         if( pxNewTCB != NULL )\r
805         {\r
806             #if ( tskSTATIC_AND_DYNAMIC_ALLOCATION_POSSIBLE != 0 ) /*lint !e9029 !e731 Macro has been consolidated for readability reasons. */\r
807             {\r
808                 /* Tasks can be created statically or dynamically, so note this\r
809                  * task was created dynamically in case it is later deleted. */\r
810                 pxNewTCB->ucStaticallyAllocated = tskDYNAMICALLY_ALLOCATED_STACK_AND_TCB;\r
811             }\r
812             #endif /* tskSTATIC_AND_DYNAMIC_ALLOCATION_POSSIBLE */\r
813 \r
814             prvInitialiseNewTask( pxTaskCode, pcName, ( uint32_t ) usStackDepth, pvParameters, uxPriority, pxCreatedTask, pxNewTCB, NULL );\r
815             prvAddNewTaskToReadyList( pxNewTCB );\r
816             xReturn = pdPASS;\r
817         }\r
818         else\r
819         {\r
820             xReturn = errCOULD_NOT_ALLOCATE_REQUIRED_MEMORY;\r
821         }\r
822 \r
823         return xReturn;\r
824     }\r
825 \r
826 #endif /* configSUPPORT_DYNAMIC_ALLOCATION */\r
827 /*-----------------------------------------------------------*/\r
828 \r
829 static void prvInitialiseNewTask( TaskFunction_t pxTaskCode,\r
830                                   const char * const pcName, /*lint !e971 Unqualified char types are allowed for strings and single characters only. */\r
831                                   const uint32_t ulStackDepth,\r
832                                   void * const pvParameters,\r
833                                   UBaseType_t uxPriority,\r
834                                   TaskHandle_t * const pxCreatedTask,\r
835                                   TCB_t * pxNewTCB,\r
836                                   const MemoryRegion_t * const xRegions )\r
837 {\r
838     StackType_t * pxTopOfStack;\r
839     UBaseType_t x;\r
840 \r
841     #if ( portUSING_MPU_WRAPPERS == 1 )\r
842         /* Should the task be created in privileged mode? */\r
843         BaseType_t xRunPrivileged;\r
844 \r
845         if( ( uxPriority & portPRIVILEGE_BIT ) != 0U )\r
846         {\r
847             xRunPrivileged = pdTRUE;\r
848         }\r
849         else\r
850         {\r
851             xRunPrivileged = pdFALSE;\r
852         }\r
853         uxPriority &= ~portPRIVILEGE_BIT;\r
854     #endif /* portUSING_MPU_WRAPPERS == 1 */\r
855 \r
856     /* Avoid dependency on memset() if it is not required. */\r
857     #if ( tskSET_NEW_STACKS_TO_KNOWN_VALUE == 1 )\r
858     {\r
859         /* Fill the stack with a known value to assist debugging. */\r
860         ( void ) memset( pxNewTCB->pxStack, ( int ) tskSTACK_FILL_BYTE, ( size_t ) ulStackDepth * sizeof( StackType_t ) );\r
861     }\r
862     #endif /* tskSET_NEW_STACKS_TO_KNOWN_VALUE */\r
863 \r
864     /* Calculate the top of stack address.  This depends on whether the stack\r
865      * grows from high memory to low (as per the 80x86) or vice versa.\r
866      * portSTACK_GROWTH is used to make the result positive or negative as required\r
867      * by the port. */\r
868     #if ( portSTACK_GROWTH < 0 )\r
869     {\r
870         pxTopOfStack = &( pxNewTCB->pxStack[ ulStackDepth - ( uint32_t ) 1 ] );\r
871         pxTopOfStack = ( StackType_t * ) ( ( ( portPOINTER_SIZE_TYPE ) pxTopOfStack ) & ( ~( ( portPOINTER_SIZE_TYPE ) portBYTE_ALIGNMENT_MASK ) ) ); /*lint !e923 !e9033 !e9078 MISRA exception.  Avoiding casts between pointers and integers is not practical.  Size differences accounted for using portPOINTER_SIZE_TYPE type.  Checked by assert(). */\r
872 \r
873         /* Check the alignment of the calculated top of stack is correct. */\r
874         configASSERT( ( ( ( portPOINTER_SIZE_TYPE ) pxTopOfStack & ( portPOINTER_SIZE_TYPE ) portBYTE_ALIGNMENT_MASK ) == 0UL ) );\r
875 \r
876         #if ( configRECORD_STACK_HIGH_ADDRESS == 1 )\r
877         {\r
878             /* Also record the stack's high address, which may assist\r
879              * debugging. */\r
880             pxNewTCB->pxEndOfStack = pxTopOfStack;\r
881         }\r
882         #endif /* configRECORD_STACK_HIGH_ADDRESS */\r
883     }\r
884     #else /* portSTACK_GROWTH */\r
885     {\r
886         pxTopOfStack = pxNewTCB->pxStack;\r
887 \r
888         /* Check the alignment of the stack buffer is correct. */\r
889         configASSERT( ( ( ( portPOINTER_SIZE_TYPE ) pxNewTCB->pxStack & ( portPOINTER_SIZE_TYPE ) portBYTE_ALIGNMENT_MASK ) == 0UL ) );\r
890 \r
891         /* The other extreme of the stack space is required if stack checking is\r
892          * performed. */\r
893         pxNewTCB->pxEndOfStack = pxNewTCB->pxStack + ( ulStackDepth - ( uint32_t ) 1 );\r
894     }\r
895     #endif /* portSTACK_GROWTH */\r
896 \r
897     /* Store the task name in the TCB. */\r
898     if( pcName != NULL )\r
899     {\r
900         for( x = ( UBaseType_t ) 0; x < ( UBaseType_t ) configMAX_TASK_NAME_LEN; x++ )\r
901         {\r
902             pxNewTCB->pcTaskName[ x ] = pcName[ x ];\r
903 \r
904             /* Don't copy all configMAX_TASK_NAME_LEN if the string is shorter than\r
905              * configMAX_TASK_NAME_LEN characters just in case the memory after the\r
906              * string is not accessible (extremely unlikely). */\r
907             if( pcName[ x ] == ( char ) 0x00 )\r
908             {\r
909                 break;\r
910             }\r
911             else\r
912             {\r
913                 mtCOVERAGE_TEST_MARKER();\r
914             }\r
915         }\r
916 \r
917         /* Ensure the name string is terminated in the case that the string length\r
918          * was greater or equal to configMAX_TASK_NAME_LEN. */\r
919         pxNewTCB->pcTaskName[ configMAX_TASK_NAME_LEN - 1 ] = '\0';\r
920     }\r
921     else\r
922     {\r
923         mtCOVERAGE_TEST_MARKER();\r
924     }\r
925 \r
926     /* This is used as an array index so must ensure it's not too large. */\r
927     configASSERT( uxPriority < configMAX_PRIORITIES );\r
928 \r
929     if( uxPriority >= ( UBaseType_t ) configMAX_PRIORITIES )\r
930     {\r
931         uxPriority = ( UBaseType_t ) configMAX_PRIORITIES - ( UBaseType_t ) 1U;\r
932     }\r
933     else\r
934     {\r
935         mtCOVERAGE_TEST_MARKER();\r
936     }\r
937 \r
938     pxNewTCB->uxPriority = uxPriority;\r
939     #if ( configUSE_MUTEXES == 1 )\r
940     {\r
941         pxNewTCB->uxBasePriority = uxPriority;\r
942     }\r
943     #endif /* configUSE_MUTEXES */\r
944 \r
945     vListInitialiseItem( &( pxNewTCB->xStateListItem ) );\r
946     vListInitialiseItem( &( pxNewTCB->xEventListItem ) );\r
947 \r
948     /* Set the pxNewTCB as a link back from the ListItem_t.  This is so we can get\r
949      * back to  the containing TCB from a generic item in a list. */\r
950     listSET_LIST_ITEM_OWNER( &( pxNewTCB->xStateListItem ), pxNewTCB );\r
951 \r
952     /* Event lists are always in priority order. */\r
953     listSET_LIST_ITEM_VALUE( &( pxNewTCB->xEventListItem ), ( TickType_t ) configMAX_PRIORITIES - ( TickType_t ) uxPriority ); /*lint !e961 MISRA exception as the casts are only redundant for some ports. */\r
954     listSET_LIST_ITEM_OWNER( &( pxNewTCB->xEventListItem ), pxNewTCB );\r
955 \r
956     #if ( portUSING_MPU_WRAPPERS == 1 )\r
957     {\r
958         vPortStoreTaskMPUSettings( &( pxNewTCB->xMPUSettings ), xRegions, pxNewTCB->pxStack, ulStackDepth );\r
959     }\r
960     #else\r
961     {\r
962         /* Avoid compiler warning about unreferenced parameter. */\r
963         ( void ) xRegions;\r
964     }\r
965     #endif\r
966 \r
967     #if ( configUSE_NEWLIB_REENTRANT == 1 )\r
968     {\r
969         /* Initialise this task's Newlib reent structure.\r
970          * See the third party link http://www.nadler.com/embedded/newlibAndFreeRTOS.html\r
971          * for additional information. */\r
972         _REENT_INIT_PTR( ( &( pxNewTCB->xNewLib_reent ) ) );\r
973     }\r
974     #endif\r
975 \r
976     /* Initialize the TCB stack to look as if the task was already running,\r
977      * but had been interrupted by the scheduler.  The return address is set\r
978      * to the start of the task function. Once the stack has been initialised\r
979      * the top of stack variable is updated. */\r
980     #if ( portUSING_MPU_WRAPPERS == 1 )\r
981     {\r
982         /* If the port has capability to detect stack overflow,\r
983          * pass the stack end address to the stack initialization\r
984          * function as well. */\r
985         #if ( portHAS_STACK_OVERFLOW_CHECKING == 1 )\r
986         {\r
987             #if ( portSTACK_GROWTH < 0 )\r
988             {\r
989                 pxNewTCB->pxTopOfStack = pxPortInitialiseStack( pxTopOfStack, pxNewTCB->pxStack, pxTaskCode, pvParameters, xRunPrivileged );\r
990             }\r
991             #else /* portSTACK_GROWTH */\r
992             {\r
993                 pxNewTCB->pxTopOfStack = pxPortInitialiseStack( pxTopOfStack, pxNewTCB->pxEndOfStack, pxTaskCode, pvParameters, xRunPrivileged );\r
994             }\r
995             #endif /* portSTACK_GROWTH */\r
996         }\r
997         #else /* portHAS_STACK_OVERFLOW_CHECKING */\r
998         {\r
999             pxNewTCB->pxTopOfStack = pxPortInitialiseStack( pxTopOfStack, pxTaskCode, pvParameters, xRunPrivileged );\r
1000         }\r
1001         #endif /* portHAS_STACK_OVERFLOW_CHECKING */\r
1002     }\r
1003     #else /* portUSING_MPU_WRAPPERS */\r
1004     {\r
1005         /* If the port has capability to detect stack overflow,\r
1006          * pass the stack end address to the stack initialization\r
1007          * function as well. */\r
1008         #if ( portHAS_STACK_OVERFLOW_CHECKING == 1 )\r
1009         {\r
1010             #if ( portSTACK_GROWTH < 0 )\r
1011             {\r
1012                 pxNewTCB->pxTopOfStack = pxPortInitialiseStack( pxTopOfStack, pxNewTCB->pxStack, pxTaskCode, pvParameters );\r
1013             }\r
1014             #else /* portSTACK_GROWTH */\r
1015             {\r
1016                 pxNewTCB->pxTopOfStack = pxPortInitialiseStack( pxTopOfStack, pxNewTCB->pxEndOfStack, pxTaskCode, pvParameters );\r
1017             }\r
1018             #endif /* portSTACK_GROWTH */\r
1019         }\r
1020         #else /* portHAS_STACK_OVERFLOW_CHECKING */\r
1021         {\r
1022             pxNewTCB->pxTopOfStack = pxPortInitialiseStack( pxTopOfStack, pxTaskCode, pvParameters );\r
1023         }\r
1024         #endif /* portHAS_STACK_OVERFLOW_CHECKING */\r
1025     }\r
1026     #endif /* portUSING_MPU_WRAPPERS */\r
1027 \r
1028     if( pxCreatedTask != NULL )\r
1029     {\r
1030         /* Pass the handle out in an anonymous way.  The handle can be used to\r
1031          * change the created task's priority, delete the created task, etc.*/\r
1032         *pxCreatedTask = ( TaskHandle_t ) pxNewTCB;\r
1033     }\r
1034     else\r
1035     {\r
1036         mtCOVERAGE_TEST_MARKER();\r
1037     }\r
1038 }\r
1039 /*-----------------------------------------------------------*/\r
1040 \r
1041 static void prvAddNewTaskToReadyList( TCB_t * pxNewTCB )\r
1042 {\r
1043     /* Ensure interrupts don't access the task lists while the lists are being\r
1044      * updated. */\r
1045     taskENTER_CRITICAL();\r
1046     {\r
1047         uxCurrentNumberOfTasks++;\r
1048 \r
1049         if( pxCurrentTCB == NULL )\r
1050         {\r
1051             /* There are no other tasks, or all the other tasks are in\r
1052              * the suspended state - make this the current task. */\r
1053             pxCurrentTCB = pxNewTCB;\r
1054 \r
1055             if( uxCurrentNumberOfTasks == ( UBaseType_t ) 1 )\r
1056             {\r
1057                 /* This is the first task to be created so do the preliminary\r
1058                  * initialisation required.  We will not recover if this call\r
1059                  * fails, but we will report the failure. */\r
1060                 prvInitialiseTaskLists();\r
1061             }\r
1062             else\r
1063             {\r
1064                 mtCOVERAGE_TEST_MARKER();\r
1065             }\r
1066         }\r
1067         else\r
1068         {\r
1069             /* If the scheduler is not already running, make this task the\r
1070              * current task if it is the highest priority task to be created\r
1071              * so far. */\r
1072             if( xSchedulerRunning == pdFALSE )\r
1073             {\r
1074                 if( pxCurrentTCB->uxPriority <= pxNewTCB->uxPriority )\r
1075                 {\r
1076                     pxCurrentTCB = pxNewTCB;\r
1077                 }\r
1078                 else\r
1079                 {\r
1080                     mtCOVERAGE_TEST_MARKER();\r
1081                 }\r
1082             }\r
1083             else\r
1084             {\r
1085                 mtCOVERAGE_TEST_MARKER();\r
1086             }\r
1087         }\r
1088 \r
1089         uxTaskNumber++;\r
1090 \r
1091         #if ( configUSE_TRACE_FACILITY == 1 )\r
1092         {\r
1093             /* Add a counter into the TCB for tracing only. */\r
1094             pxNewTCB->uxTCBNumber = uxTaskNumber;\r
1095         }\r
1096         #endif /* configUSE_TRACE_FACILITY */\r
1097         traceTASK_CREATE( pxNewTCB );\r
1098 \r
1099         prvAddTaskToReadyList( pxNewTCB );\r
1100 \r
1101         portSETUP_TCB( pxNewTCB );\r
1102     }\r
1103     taskEXIT_CRITICAL();\r
1104 \r
1105     if( xSchedulerRunning != pdFALSE )\r
1106     {\r
1107         /* If the created task is of a higher priority than the current task\r
1108          * then it should run now. */\r
1109         if( pxCurrentTCB->uxPriority < pxNewTCB->uxPriority )\r
1110         {\r
1111             taskYIELD_IF_USING_PREEMPTION();\r
1112         }\r
1113         else\r
1114         {\r
1115             mtCOVERAGE_TEST_MARKER();\r
1116         }\r
1117     }\r
1118     else\r
1119     {\r
1120         mtCOVERAGE_TEST_MARKER();\r
1121     }\r
1122 }\r
1123 /*-----------------------------------------------------------*/\r
1124 \r
1125 #if ( INCLUDE_vTaskDelete == 1 )\r
1126 \r
1127     void vTaskDelete( TaskHandle_t xTaskToDelete )\r
1128     {\r
1129         TCB_t * pxTCB;\r
1130 \r
1131         taskENTER_CRITICAL();\r
1132         {\r
1133             /* If null is passed in here then it is the calling task that is\r
1134              * being deleted. */\r
1135             pxTCB = prvGetTCBFromHandle( xTaskToDelete );\r
1136 \r
1137             /* Remove task from the ready/delayed list. */\r
1138             if( uxListRemove( &( pxTCB->xStateListItem ) ) == ( UBaseType_t ) 0 )\r
1139             {\r
1140                 taskRESET_READY_PRIORITY( pxTCB->uxPriority );\r
1141             }\r
1142             else\r
1143             {\r
1144                 mtCOVERAGE_TEST_MARKER();\r
1145             }\r
1146 \r
1147             /* Is the task waiting on an event also? */\r
1148             if( listLIST_ITEM_CONTAINER( &( pxTCB->xEventListItem ) ) != NULL )\r
1149             {\r
1150                 ( void ) uxListRemove( &( pxTCB->xEventListItem ) );\r
1151             }\r
1152             else\r
1153             {\r
1154                 mtCOVERAGE_TEST_MARKER();\r
1155             }\r
1156 \r
1157             /* Increment the uxTaskNumber also so kernel aware debuggers can\r
1158              * detect that the task lists need re-generating.  This is done before\r
1159              * portPRE_TASK_DELETE_HOOK() as in the Windows port that macro will\r
1160              * not return. */\r
1161             uxTaskNumber++;\r
1162 \r
1163             if( pxTCB == pxCurrentTCB )\r
1164             {\r
1165                 /* A task is deleting itself.  This cannot complete within the\r
1166                  * task itself, as a context switch to another task is required.\r
1167                  * Place the task in the termination list.  The idle task will\r
1168                  * check the termination list and free up any memory allocated by\r
1169                  * the scheduler for the TCB and stack of the deleted task. */\r
1170                 vListInsertEnd( &xTasksWaitingTermination, &( pxTCB->xStateListItem ) );\r
1171 \r
1172                 /* Increment the ucTasksDeleted variable so the idle task knows\r
1173                  * there is a task that has been deleted and that it should therefore\r
1174                  * check the xTasksWaitingTermination list. */\r
1175                 ++uxDeletedTasksWaitingCleanUp;\r
1176 \r
1177                 /* Call the delete hook before portPRE_TASK_DELETE_HOOK() as\r
1178                  * portPRE_TASK_DELETE_HOOK() does not return in the Win32 port. */\r
1179                 traceTASK_DELETE( pxTCB );\r
1180 \r
1181                 /* The pre-delete hook is primarily for the Windows simulator,\r
1182                  * in which Windows specific clean up operations are performed,\r
1183                  * after which it is not possible to yield away from this task -\r
1184                  * hence xYieldPending is used to latch that a context switch is\r
1185                  * required. */\r
1186                 portPRE_TASK_DELETE_HOOK( pxTCB, &xYieldPending );\r
1187             }\r
1188             else\r
1189             {\r
1190                 --uxCurrentNumberOfTasks;\r
1191                 traceTASK_DELETE( pxTCB );\r
1192 \r
1193                 /* Reset the next expected unblock time in case it referred to\r
1194                  * the task that has just been deleted. */\r
1195                 prvResetNextTaskUnblockTime();\r
1196             }\r
1197         }\r
1198         taskEXIT_CRITICAL();\r
1199 \r
1200         /* If the task is not deleting itself, call prvDeleteTCB from outside of\r
1201          * critical section. If a task deletes itself, prvDeleteTCB is called\r
1202          * from prvCheckTasksWaitingTermination which is called from Idle task. */\r
1203         if( pxTCB != pxCurrentTCB )\r
1204         {\r
1205             prvDeleteTCB( pxTCB );\r
1206         }\r
1207 \r
1208         /* Force a reschedule if it is the currently running task that has just\r
1209          * been deleted. */\r
1210         if( xSchedulerRunning != pdFALSE )\r
1211         {\r
1212             if( pxTCB == pxCurrentTCB )\r
1213             {\r
1214                 configASSERT( uxSchedulerSuspended == 0 );\r
1215                 portYIELD_WITHIN_API();\r
1216             }\r
1217             else\r
1218             {\r
1219                 mtCOVERAGE_TEST_MARKER();\r
1220             }\r
1221         }\r
1222     }\r
1223 \r
1224 #endif /* INCLUDE_vTaskDelete */\r
1225 /*-----------------------------------------------------------*/\r
1226 \r
1227 #if ( INCLUDE_xTaskDelayUntil == 1 )\r
1228 \r
1229     BaseType_t xTaskDelayUntil( TickType_t * const pxPreviousWakeTime,\r
1230                                 const TickType_t xTimeIncrement )\r
1231     {\r
1232         TickType_t xTimeToWake;\r
1233         BaseType_t xAlreadyYielded, xShouldDelay = pdFALSE;\r
1234 \r
1235         configASSERT( pxPreviousWakeTime );\r
1236         configASSERT( ( xTimeIncrement > 0U ) );\r
1237         configASSERT( uxSchedulerSuspended == 0 );\r
1238 \r
1239         vTaskSuspendAll();\r
1240         {\r
1241             /* Minor optimisation.  The tick count cannot change in this\r
1242              * block. */\r
1243             const TickType_t xConstTickCount = xTickCount;\r
1244 \r
1245             /* Generate the tick time at which the task wants to wake. */\r
1246             xTimeToWake = *pxPreviousWakeTime + xTimeIncrement;\r
1247 \r
1248             if( xConstTickCount < *pxPreviousWakeTime )\r
1249             {\r
1250                 /* The tick count has overflowed since this function was\r
1251                  * lasted called.  In this case the only time we should ever\r
1252                  * actually delay is if the wake time has also  overflowed,\r
1253                  * and the wake time is greater than the tick time.  When this\r
1254                  * is the case it is as if neither time had overflowed. */\r
1255                 if( ( xTimeToWake < *pxPreviousWakeTime ) && ( xTimeToWake > xConstTickCount ) )\r
1256                 {\r
1257                     xShouldDelay = pdTRUE;\r
1258                 }\r
1259                 else\r
1260                 {\r
1261                     mtCOVERAGE_TEST_MARKER();\r
1262                 }\r
1263             }\r
1264             else\r
1265             {\r
1266                 /* The tick time has not overflowed.  In this case we will\r
1267                  * delay if either the wake time has overflowed, and/or the\r
1268                  * tick time is less than the wake time. */\r
1269                 if( ( xTimeToWake < *pxPreviousWakeTime ) || ( xTimeToWake > xConstTickCount ) )\r
1270                 {\r
1271                     xShouldDelay = pdTRUE;\r
1272                 }\r
1273                 else\r
1274                 {\r
1275                     mtCOVERAGE_TEST_MARKER();\r
1276                 }\r
1277             }\r
1278 \r
1279             /* Update the wake time ready for the next call. */\r
1280             *pxPreviousWakeTime = xTimeToWake;\r
1281 \r
1282             if( xShouldDelay != pdFALSE )\r
1283             {\r
1284                 traceTASK_DELAY_UNTIL( xTimeToWake );\r
1285 \r
1286                 /* prvAddCurrentTaskToDelayedList() needs the block time, not\r
1287                  * the time to wake, so subtract the current tick count. */\r
1288                 prvAddCurrentTaskToDelayedList( xTimeToWake - xConstTickCount, pdFALSE );\r
1289             }\r
1290             else\r
1291             {\r
1292                 mtCOVERAGE_TEST_MARKER();\r
1293             }\r
1294         }\r
1295         xAlreadyYielded = xTaskResumeAll();\r
1296 \r
1297         /* Force a reschedule if xTaskResumeAll has not already done so, we may\r
1298          * have put ourselves to sleep. */\r
1299         if( xAlreadyYielded == pdFALSE )\r
1300         {\r
1301             portYIELD_WITHIN_API();\r
1302         }\r
1303         else\r
1304         {\r
1305             mtCOVERAGE_TEST_MARKER();\r
1306         }\r
1307 \r
1308         return xShouldDelay;\r
1309     }\r
1310 \r
1311 #endif /* INCLUDE_xTaskDelayUntil */\r
1312 /*-----------------------------------------------------------*/\r
1313 \r
1314 #if ( INCLUDE_vTaskDelay == 1 )\r
1315 \r
1316     void vTaskDelay( const TickType_t xTicksToDelay )\r
1317     {\r
1318         BaseType_t xAlreadyYielded = pdFALSE;\r
1319 \r
1320         /* A delay time of zero just forces a reschedule. */\r
1321         if( xTicksToDelay > ( TickType_t ) 0U )\r
1322         {\r
1323             configASSERT( uxSchedulerSuspended == 0 );\r
1324             vTaskSuspendAll();\r
1325             {\r
1326                 traceTASK_DELAY();\r
1327 \r
1328                 /* A task that is removed from the event list while the\r
1329                  * scheduler is suspended will not get placed in the ready\r
1330                  * list or removed from the blocked list until the scheduler\r
1331                  * is resumed.\r
1332                  *\r
1333                  * This task cannot be in an event list as it is the currently\r
1334                  * executing task. */\r
1335                 prvAddCurrentTaskToDelayedList( xTicksToDelay, pdFALSE );\r
1336             }\r
1337             xAlreadyYielded = xTaskResumeAll();\r
1338         }\r
1339         else\r
1340         {\r
1341             mtCOVERAGE_TEST_MARKER();\r
1342         }\r
1343 \r
1344         /* Force a reschedule if xTaskResumeAll has not already done so, we may\r
1345          * have put ourselves to sleep. */\r
1346         if( xAlreadyYielded == pdFALSE )\r
1347         {\r
1348             portYIELD_WITHIN_API();\r
1349         }\r
1350         else\r
1351         {\r
1352             mtCOVERAGE_TEST_MARKER();\r
1353         }\r
1354     }\r
1355 \r
1356 #endif /* INCLUDE_vTaskDelay */\r
1357 /*-----------------------------------------------------------*/\r
1358 \r
1359 #if ( ( INCLUDE_eTaskGetState == 1 ) || ( configUSE_TRACE_FACILITY == 1 ) || ( INCLUDE_xTaskAbortDelay == 1 ) )\r
1360 \r
1361     eTaskState eTaskGetState( TaskHandle_t xTask )\r
1362     {\r
1363         eTaskState eReturn;\r
1364         List_t const * pxStateList, * pxDelayedList, * pxOverflowedDelayedList;\r
1365         const TCB_t * const pxTCB = xTask;\r
1366 \r
1367         configASSERT( pxTCB );\r
1368 \r
1369         if( pxTCB == pxCurrentTCB )\r
1370         {\r
1371             /* The task calling this function is querying its own state. */\r
1372             eReturn = eRunning;\r
1373         }\r
1374         else\r
1375         {\r
1376             taskENTER_CRITICAL();\r
1377             {\r
1378                 pxStateList = listLIST_ITEM_CONTAINER( &( pxTCB->xStateListItem ) );\r
1379                 pxDelayedList = pxDelayedTaskList;\r
1380                 pxOverflowedDelayedList = pxOverflowDelayedTaskList;\r
1381             }\r
1382             taskEXIT_CRITICAL();\r
1383 \r
1384             if( ( pxStateList == pxDelayedList ) || ( pxStateList == pxOverflowedDelayedList ) )\r
1385             {\r
1386                 /* The task being queried is referenced from one of the Blocked\r
1387                  * lists. */\r
1388                 eReturn = eBlocked;\r
1389             }\r
1390 \r
1391             #if ( INCLUDE_vTaskSuspend == 1 )\r
1392                 else if( pxStateList == &xSuspendedTaskList )\r
1393                 {\r
1394                     /* The task being queried is referenced from the suspended\r
1395                      * list.  Is it genuinely suspended or is it blocked\r
1396                      * indefinitely? */\r
1397                     if( listLIST_ITEM_CONTAINER( &( pxTCB->xEventListItem ) ) == NULL )\r
1398                     {\r
1399                         #if ( configUSE_TASK_NOTIFICATIONS == 1 )\r
1400                         {\r
1401                             BaseType_t x;\r
1402 \r
1403                             /* The task does not appear on the event list item of\r
1404                              * and of the RTOS objects, but could still be in the\r
1405                              * blocked state if it is waiting on its notification\r
1406                              * rather than waiting on an object.  If not, is\r
1407                              * suspended. */\r
1408                             eReturn = eSuspended;\r
1409 \r
1410                             for( x = 0; x < configTASK_NOTIFICATION_ARRAY_ENTRIES; x++ )\r
1411                             {\r
1412                                 if( pxTCB->ucNotifyState[ x ] == taskWAITING_NOTIFICATION )\r
1413                                 {\r
1414                                     eReturn = eBlocked;\r
1415                                     break;\r
1416                                 }\r
1417                             }\r
1418                         }\r
1419                         #else /* if ( configUSE_TASK_NOTIFICATIONS == 1 ) */\r
1420                         {\r
1421                             eReturn = eSuspended;\r
1422                         }\r
1423                         #endif /* if ( configUSE_TASK_NOTIFICATIONS == 1 ) */\r
1424                     }\r
1425                     else\r
1426                     {\r
1427                         eReturn = eBlocked;\r
1428                     }\r
1429                 }\r
1430             #endif /* if ( INCLUDE_vTaskSuspend == 1 ) */\r
1431 \r
1432             #if ( INCLUDE_vTaskDelete == 1 )\r
1433                 else if( ( pxStateList == &xTasksWaitingTermination ) || ( pxStateList == NULL ) )\r
1434                 {\r
1435                     /* The task being queried is referenced from the deleted\r
1436                      * tasks list, or it is not referenced from any lists at\r
1437                      * all. */\r
1438                     eReturn = eDeleted;\r
1439                 }\r
1440             #endif\r
1441 \r
1442             else /*lint !e525 Negative indentation is intended to make use of pre-processor clearer. */\r
1443             {\r
1444                 /* If the task is not in any other state, it must be in the\r
1445                  * Ready (including pending ready) state. */\r
1446                 eReturn = eReady;\r
1447             }\r
1448         }\r
1449 \r
1450         return eReturn;\r
1451     } /*lint !e818 xTask cannot be a pointer to const because it is a typedef. */\r
1452 \r
1453 #endif /* INCLUDE_eTaskGetState */\r
1454 /*-----------------------------------------------------------*/\r
1455 \r
1456 #if ( INCLUDE_uxTaskPriorityGet == 1 )\r
1457 \r
1458     UBaseType_t uxTaskPriorityGet( const TaskHandle_t xTask )\r
1459     {\r
1460         TCB_t const * pxTCB;\r
1461         UBaseType_t uxReturn;\r
1462 \r
1463         taskENTER_CRITICAL();\r
1464         {\r
1465             /* If null is passed in here then it is the priority of the task\r
1466              * that called uxTaskPriorityGet() that is being queried. */\r
1467             pxTCB = prvGetTCBFromHandle( xTask );\r
1468             uxReturn = pxTCB->uxPriority;\r
1469         }\r
1470         taskEXIT_CRITICAL();\r
1471 \r
1472         return uxReturn;\r
1473     }\r
1474 \r
1475 #endif /* INCLUDE_uxTaskPriorityGet */\r
1476 /*-----------------------------------------------------------*/\r
1477 \r
1478 #if ( INCLUDE_uxTaskPriorityGet == 1 )\r
1479 \r
1480     UBaseType_t uxTaskPriorityGetFromISR( const TaskHandle_t xTask )\r
1481     {\r
1482         TCB_t const * pxTCB;\r
1483         UBaseType_t uxReturn, uxSavedInterruptState;\r
1484 \r
1485         /* RTOS ports that support interrupt nesting have the concept of a\r
1486          * maximum  system call (or maximum API call) interrupt priority.\r
1487          * Interrupts that are  above the maximum system call priority are keep\r
1488          * permanently enabled, even when the RTOS kernel is in a critical section,\r
1489          * but cannot make any calls to FreeRTOS API functions.  If configASSERT()\r
1490          * is defined in FreeRTOSConfig.h then\r
1491          * portASSERT_IF_INTERRUPT_PRIORITY_INVALID() will result in an assertion\r
1492          * failure if a FreeRTOS API function is called from an interrupt that has\r
1493          * been assigned a priority above the configured maximum system call\r
1494          * priority.  Only FreeRTOS functions that end in FromISR can be called\r
1495          * from interrupts  that have been assigned a priority at or (logically)\r
1496          * below the maximum system call interrupt priority.  FreeRTOS maintains a\r
1497          * separate interrupt safe API to ensure interrupt entry is as fast and as\r
1498          * simple as possible.  More information (albeit Cortex-M specific) is\r
1499          * provided on the following link:\r
1500          * https://www.FreeRTOS.org/RTOS-Cortex-M3-M4.html */\r
1501         portASSERT_IF_INTERRUPT_PRIORITY_INVALID();\r
1502 \r
1503         uxSavedInterruptState = portSET_INTERRUPT_MASK_FROM_ISR();\r
1504         {\r
1505             /* If null is passed in here then it is the priority of the calling\r
1506              * task that is being queried. */\r
1507             pxTCB = prvGetTCBFromHandle( xTask );\r
1508             uxReturn = pxTCB->uxPriority;\r
1509         }\r
1510         portCLEAR_INTERRUPT_MASK_FROM_ISR( uxSavedInterruptState );\r
1511 \r
1512         return uxReturn;\r
1513     }\r
1514 \r
1515 #endif /* INCLUDE_uxTaskPriorityGet */\r
1516 /*-----------------------------------------------------------*/\r
1517 \r
1518 #if ( INCLUDE_vTaskPrioritySet == 1 )\r
1519 \r
1520     void vTaskPrioritySet( TaskHandle_t xTask,\r
1521                            UBaseType_t uxNewPriority )\r
1522     {\r
1523         TCB_t * pxTCB;\r
1524         UBaseType_t uxCurrentBasePriority, uxPriorityUsedOnEntry;\r
1525         BaseType_t xYieldRequired = pdFALSE;\r
1526 \r
1527         configASSERT( uxNewPriority < configMAX_PRIORITIES );\r
1528 \r
1529         /* Ensure the new priority is valid. */\r
1530         if( uxNewPriority >= ( UBaseType_t ) configMAX_PRIORITIES )\r
1531         {\r
1532             uxNewPriority = ( UBaseType_t ) configMAX_PRIORITIES - ( UBaseType_t ) 1U;\r
1533         }\r
1534         else\r
1535         {\r
1536             mtCOVERAGE_TEST_MARKER();\r
1537         }\r
1538 \r
1539         taskENTER_CRITICAL();\r
1540         {\r
1541             /* If null is passed in here then it is the priority of the calling\r
1542              * task that is being changed. */\r
1543             pxTCB = prvGetTCBFromHandle( xTask );\r
1544 \r
1545             traceTASK_PRIORITY_SET( pxTCB, uxNewPriority );\r
1546 \r
1547             #if ( configUSE_MUTEXES == 1 )\r
1548             {\r
1549                 uxCurrentBasePriority = pxTCB->uxBasePriority;\r
1550             }\r
1551             #else\r
1552             {\r
1553                 uxCurrentBasePriority = pxTCB->uxPriority;\r
1554             }\r
1555             #endif\r
1556 \r
1557             if( uxCurrentBasePriority != uxNewPriority )\r
1558             {\r
1559                 /* The priority change may have readied a task of higher\r
1560                  * priority than the calling task. */\r
1561                 if( uxNewPriority > uxCurrentBasePriority )\r
1562                 {\r
1563                     if( pxTCB != pxCurrentTCB )\r
1564                     {\r
1565                         /* The priority of a task other than the currently\r
1566                          * running task is being raised.  Is the priority being\r
1567                          * raised above that of the running task? */\r
1568                         if( uxNewPriority >= pxCurrentTCB->uxPriority )\r
1569                         {\r
1570                             xYieldRequired = pdTRUE;\r
1571                         }\r
1572                         else\r
1573                         {\r
1574                             mtCOVERAGE_TEST_MARKER();\r
1575                         }\r
1576                     }\r
1577                     else\r
1578                     {\r
1579                         /* The priority of the running task is being raised,\r
1580                          * but the running task must already be the highest\r
1581                          * priority task able to run so no yield is required. */\r
1582                     }\r
1583                 }\r
1584                 else if( pxTCB == pxCurrentTCB )\r
1585                 {\r
1586                     /* Setting the priority of the running task down means\r
1587                      * there may now be another task of higher priority that\r
1588                      * is ready to execute. */\r
1589                     xYieldRequired = pdTRUE;\r
1590                 }\r
1591                 else\r
1592                 {\r
1593                     /* Setting the priority of any other task down does not\r
1594                      * require a yield as the running task must be above the\r
1595                      * new priority of the task being modified. */\r
1596                 }\r
1597 \r
1598                 /* Remember the ready list the task might be referenced from\r
1599                  * before its uxPriority member is changed so the\r
1600                  * taskRESET_READY_PRIORITY() macro can function correctly. */\r
1601                 uxPriorityUsedOnEntry = pxTCB->uxPriority;\r
1602 \r
1603                 #if ( configUSE_MUTEXES == 1 )\r
1604                 {\r
1605                     /* Only change the priority being used if the task is not\r
1606                      * currently using an inherited priority. */\r
1607                     if( pxTCB->uxBasePriority == pxTCB->uxPriority )\r
1608                     {\r
1609                         pxTCB->uxPriority = uxNewPriority;\r
1610                     }\r
1611                     else\r
1612                     {\r
1613                         mtCOVERAGE_TEST_MARKER();\r
1614                     }\r
1615 \r
1616                     /* The base priority gets set whatever. */\r
1617                     pxTCB->uxBasePriority = uxNewPriority;\r
1618                 }\r
1619                 #else /* if ( configUSE_MUTEXES == 1 ) */\r
1620                 {\r
1621                     pxTCB->uxPriority = uxNewPriority;\r
1622                 }\r
1623                 #endif /* if ( configUSE_MUTEXES == 1 ) */\r
1624 \r
1625                 /* Only reset the event list item value if the value is not\r
1626                  * being used for anything else. */\r
1627                 if( ( listGET_LIST_ITEM_VALUE( &( pxTCB->xEventListItem ) ) & taskEVENT_LIST_ITEM_VALUE_IN_USE ) == 0UL )\r
1628                 {\r
1629                     listSET_LIST_ITEM_VALUE( &( pxTCB->xEventListItem ), ( ( TickType_t ) configMAX_PRIORITIES - ( TickType_t ) uxNewPriority ) ); /*lint !e961 MISRA exception as the casts are only redundant for some ports. */\r
1630                 }\r
1631                 else\r
1632                 {\r
1633                     mtCOVERAGE_TEST_MARKER();\r
1634                 }\r
1635 \r
1636                 /* If the task is in the blocked or suspended list we need do\r
1637                  * nothing more than change its priority variable. However, if\r
1638                  * the task is in a ready list it needs to be removed and placed\r
1639                  * in the list appropriate to its new priority. */\r
1640                 if( listIS_CONTAINED_WITHIN( &( pxReadyTasksLists[ uxPriorityUsedOnEntry ] ), &( pxTCB->xStateListItem ) ) != pdFALSE )\r
1641                 {\r
1642                     /* The task is currently in its ready list - remove before\r
1643                      * adding it to its new ready list.  As we are in a critical\r
1644                      * section we can do this even if the scheduler is suspended. */\r
1645                     if( uxListRemove( &( pxTCB->xStateListItem ) ) == ( UBaseType_t ) 0 )\r
1646                     {\r
1647                         /* It is known that the task is in its ready list so\r
1648                          * there is no need to check again and the port level\r
1649                          * reset macro can be called directly. */\r
1650                         portRESET_READY_PRIORITY( uxPriorityUsedOnEntry, uxTopReadyPriority );\r
1651                     }\r
1652                     else\r
1653                     {\r
1654                         mtCOVERAGE_TEST_MARKER();\r
1655                     }\r
1656 \r
1657                     prvAddTaskToReadyList( pxTCB );\r
1658                 }\r
1659                 else\r
1660                 {\r
1661                     mtCOVERAGE_TEST_MARKER();\r
1662                 }\r
1663 \r
1664                 if( xYieldRequired != pdFALSE )\r
1665                 {\r
1666                     taskYIELD_IF_USING_PREEMPTION();\r
1667                 }\r
1668                 else\r
1669                 {\r
1670                     mtCOVERAGE_TEST_MARKER();\r
1671                 }\r
1672 \r
1673                 /* Remove compiler warning about unused variables when the port\r
1674                  * optimised task selection is not being used. */\r
1675                 ( void ) uxPriorityUsedOnEntry;\r
1676             }\r
1677         }\r
1678         taskEXIT_CRITICAL();\r
1679     }\r
1680 \r
1681 #endif /* INCLUDE_vTaskPrioritySet */\r
1682 /*-----------------------------------------------------------*/\r
1683 \r
1684 #if ( INCLUDE_vTaskSuspend == 1 )\r
1685 \r
1686     void vTaskSuspend( TaskHandle_t xTaskToSuspend )\r
1687     {\r
1688         TCB_t * pxTCB;\r
1689 \r
1690         taskENTER_CRITICAL();\r
1691         {\r
1692             /* If null is passed in here then it is the running task that is\r
1693              * being suspended. */\r
1694             pxTCB = prvGetTCBFromHandle( xTaskToSuspend );\r
1695 \r
1696             traceTASK_SUSPEND( pxTCB );\r
1697 \r
1698             /* Remove task from the ready/delayed list and place in the\r
1699              * suspended list. */\r
1700             if( uxListRemove( &( pxTCB->xStateListItem ) ) == ( UBaseType_t ) 0 )\r
1701             {\r
1702                 taskRESET_READY_PRIORITY( pxTCB->uxPriority );\r
1703             }\r
1704             else\r
1705             {\r
1706                 mtCOVERAGE_TEST_MARKER();\r
1707             }\r
1708 \r
1709             /* Is the task waiting on an event also? */\r
1710             if( listLIST_ITEM_CONTAINER( &( pxTCB->xEventListItem ) ) != NULL )\r
1711             {\r
1712                 ( void ) uxListRemove( &( pxTCB->xEventListItem ) );\r
1713             }\r
1714             else\r
1715             {\r
1716                 mtCOVERAGE_TEST_MARKER();\r
1717             }\r
1718 \r
1719             vListInsertEnd( &xSuspendedTaskList, &( pxTCB->xStateListItem ) );\r
1720 \r
1721             #if ( configUSE_TASK_NOTIFICATIONS == 1 )\r
1722             {\r
1723                 BaseType_t x;\r
1724 \r
1725                 for( x = 0; x < configTASK_NOTIFICATION_ARRAY_ENTRIES; x++ )\r
1726                 {\r
1727                     if( pxTCB->ucNotifyState[ x ] == taskWAITING_NOTIFICATION )\r
1728                     {\r
1729                         /* The task was blocked to wait for a notification, but is\r
1730                          * now suspended, so no notification was received. */\r
1731                         pxTCB->ucNotifyState[ x ] = taskNOT_WAITING_NOTIFICATION;\r
1732                     }\r
1733                 }\r
1734             }\r
1735             #endif /* if ( configUSE_TASK_NOTIFICATIONS == 1 ) */\r
1736         }\r
1737         taskEXIT_CRITICAL();\r
1738 \r
1739         if( xSchedulerRunning != pdFALSE )\r
1740         {\r
1741             /* Reset the next expected unblock time in case it referred to the\r
1742              * task that is now in the Suspended state. */\r
1743             taskENTER_CRITICAL();\r
1744             {\r
1745                 prvResetNextTaskUnblockTime();\r
1746             }\r
1747             taskEXIT_CRITICAL();\r
1748         }\r
1749         else\r
1750         {\r
1751             mtCOVERAGE_TEST_MARKER();\r
1752         }\r
1753 \r
1754         if( pxTCB == pxCurrentTCB )\r
1755         {\r
1756             if( xSchedulerRunning != pdFALSE )\r
1757             {\r
1758                 /* The current task has just been suspended. */\r
1759                 configASSERT( uxSchedulerSuspended == 0 );\r
1760                 portYIELD_WITHIN_API();\r
1761             }\r
1762             else\r
1763             {\r
1764                 /* The scheduler is not running, but the task that was pointed\r
1765                  * to by pxCurrentTCB has just been suspended and pxCurrentTCB\r
1766                  * must be adjusted to point to a different task. */\r
1767                 if( listCURRENT_LIST_LENGTH( &xSuspendedTaskList ) == uxCurrentNumberOfTasks ) /*lint !e931 Right has no side effect, just volatile. */\r
1768                 {\r
1769                     /* No other tasks are ready, so set pxCurrentTCB back to\r
1770                      * NULL so when the next task is created pxCurrentTCB will\r
1771                      * be set to point to it no matter what its relative priority\r
1772                      * is. */\r
1773                     pxCurrentTCB = NULL;\r
1774                 }\r
1775                 else\r
1776                 {\r
1777                     vTaskSwitchContext();\r
1778                 }\r
1779             }\r
1780         }\r
1781         else\r
1782         {\r
1783             mtCOVERAGE_TEST_MARKER();\r
1784         }\r
1785     }\r
1786 \r
1787 #endif /* INCLUDE_vTaskSuspend */\r
1788 /*-----------------------------------------------------------*/\r
1789 \r
1790 #if ( INCLUDE_vTaskSuspend == 1 )\r
1791 \r
1792     static BaseType_t prvTaskIsTaskSuspended( const TaskHandle_t xTask )\r
1793     {\r
1794         BaseType_t xReturn = pdFALSE;\r
1795         const TCB_t * const pxTCB = xTask;\r
1796 \r
1797         /* Accesses xPendingReadyList so must be called from a critical\r
1798          * section. */\r
1799 \r
1800         /* It does not make sense to check if the calling task is suspended. */\r
1801         configASSERT( xTask );\r
1802 \r
1803         /* Is the task being resumed actually in the suspended list? */\r
1804         if( listIS_CONTAINED_WITHIN( &xSuspendedTaskList, &( pxTCB->xStateListItem ) ) != pdFALSE )\r
1805         {\r
1806             /* Has the task already been resumed from within an ISR? */\r
1807             if( listIS_CONTAINED_WITHIN( &xPendingReadyList, &( pxTCB->xEventListItem ) ) == pdFALSE )\r
1808             {\r
1809                 /* Is it in the suspended list because it is in the Suspended\r
1810                  * state, or because is is blocked with no timeout? */\r
1811                 if( listIS_CONTAINED_WITHIN( NULL, &( pxTCB->xEventListItem ) ) != pdFALSE ) /*lint !e961.  The cast is only redundant when NULL is used. */\r
1812                 {\r
1813                     xReturn = pdTRUE;\r
1814                 }\r
1815                 else\r
1816                 {\r
1817                     mtCOVERAGE_TEST_MARKER();\r
1818                 }\r
1819             }\r
1820             else\r
1821             {\r
1822                 mtCOVERAGE_TEST_MARKER();\r
1823             }\r
1824         }\r
1825         else\r
1826         {\r
1827             mtCOVERAGE_TEST_MARKER();\r
1828         }\r
1829 \r
1830         return xReturn;\r
1831     } /*lint !e818 xTask cannot be a pointer to const because it is a typedef. */\r
1832 \r
1833 #endif /* INCLUDE_vTaskSuspend */\r
1834 /*-----------------------------------------------------------*/\r
1835 \r
1836 #if ( INCLUDE_vTaskSuspend == 1 )\r
1837 \r
1838     void vTaskResume( TaskHandle_t xTaskToResume )\r
1839     {\r
1840         TCB_t * const pxTCB = xTaskToResume;\r
1841 \r
1842         /* It does not make sense to resume the calling task. */\r
1843         configASSERT( xTaskToResume );\r
1844 \r
1845         /* The parameter cannot be NULL as it is impossible to resume the\r
1846          * currently executing task. */\r
1847         if( ( pxTCB != pxCurrentTCB ) && ( pxTCB != NULL ) )\r
1848         {\r
1849             taskENTER_CRITICAL();\r
1850             {\r
1851                 if( prvTaskIsTaskSuspended( pxTCB ) != pdFALSE )\r
1852                 {\r
1853                     traceTASK_RESUME( pxTCB );\r
1854 \r
1855                     /* The ready list can be accessed even if the scheduler is\r
1856                      * suspended because this is inside a critical section. */\r
1857                     ( void ) uxListRemove( &( pxTCB->xStateListItem ) );\r
1858                     prvAddTaskToReadyList( pxTCB );\r
1859 \r
1860                     /* A higher priority task may have just been resumed. */\r
1861                     if( pxTCB->uxPriority >= pxCurrentTCB->uxPriority )\r
1862                     {\r
1863                         /* This yield may not cause the task just resumed to run,\r
1864                          * but will leave the lists in the correct state for the\r
1865                          * next yield. */\r
1866                         taskYIELD_IF_USING_PREEMPTION();\r
1867                     }\r
1868                     else\r
1869                     {\r
1870                         mtCOVERAGE_TEST_MARKER();\r
1871                     }\r
1872                 }\r
1873                 else\r
1874                 {\r
1875                     mtCOVERAGE_TEST_MARKER();\r
1876                 }\r
1877             }\r
1878             taskEXIT_CRITICAL();\r
1879         }\r
1880         else\r
1881         {\r
1882             mtCOVERAGE_TEST_MARKER();\r
1883         }\r
1884     }\r
1885 \r
1886 #endif /* INCLUDE_vTaskSuspend */\r
1887 \r
1888 /*-----------------------------------------------------------*/\r
1889 \r
1890 #if ( ( INCLUDE_xTaskResumeFromISR == 1 ) && ( INCLUDE_vTaskSuspend == 1 ) )\r
1891 \r
1892     BaseType_t xTaskResumeFromISR( TaskHandle_t xTaskToResume )\r
1893     {\r
1894         BaseType_t xYieldRequired = pdFALSE;\r
1895         TCB_t * const pxTCB = xTaskToResume;\r
1896         UBaseType_t uxSavedInterruptStatus;\r
1897 \r
1898         configASSERT( xTaskToResume );\r
1899 \r
1900         /* RTOS ports that support interrupt nesting have the concept of a\r
1901          * maximum  system call (or maximum API call) interrupt priority.\r
1902          * Interrupts that are  above the maximum system call priority are keep\r
1903          * permanently enabled, even when the RTOS kernel is in a critical section,\r
1904          * but cannot make any calls to FreeRTOS API functions.  If configASSERT()\r
1905          * is defined in FreeRTOSConfig.h then\r
1906          * portASSERT_IF_INTERRUPT_PRIORITY_INVALID() will result in an assertion\r
1907          * failure if a FreeRTOS API function is called from an interrupt that has\r
1908          * been assigned a priority above the configured maximum system call\r
1909          * priority.  Only FreeRTOS functions that end in FromISR can be called\r
1910          * from interrupts  that have been assigned a priority at or (logically)\r
1911          * below the maximum system call interrupt priority.  FreeRTOS maintains a\r
1912          * separate interrupt safe API to ensure interrupt entry is as fast and as\r
1913          * simple as possible.  More information (albeit Cortex-M specific) is\r
1914          * provided on the following link:\r
1915          * https://www.FreeRTOS.org/RTOS-Cortex-M3-M4.html */\r
1916         portASSERT_IF_INTERRUPT_PRIORITY_INVALID();\r
1917 \r
1918         uxSavedInterruptStatus = portSET_INTERRUPT_MASK_FROM_ISR();\r
1919         {\r
1920             if( prvTaskIsTaskSuspended( pxTCB ) != pdFALSE )\r
1921             {\r
1922                 traceTASK_RESUME_FROM_ISR( pxTCB );\r
1923 \r
1924                 /* Check the ready lists can be accessed. */\r
1925                 if( uxSchedulerSuspended == ( UBaseType_t ) pdFALSE )\r
1926                 {\r
1927                     /* Ready lists can be accessed so move the task from the\r
1928                      * suspended list to the ready list directly. */\r
1929                     if( pxTCB->uxPriority >= pxCurrentTCB->uxPriority )\r
1930                     {\r
1931                         xYieldRequired = pdTRUE;\r
1932 \r
1933                         /* Mark that a yield is pending in case the user is not\r
1934                          * using the return value to initiate a context switch\r
1935                          * from the ISR using portYIELD_FROM_ISR. */\r
1936                         xYieldPending = pdTRUE;\r
1937                     }\r
1938                     else\r
1939                     {\r
1940                         mtCOVERAGE_TEST_MARKER();\r
1941                     }\r
1942 \r
1943                     ( void ) uxListRemove( &( pxTCB->xStateListItem ) );\r
1944                     prvAddTaskToReadyList( pxTCB );\r
1945                 }\r
1946                 else\r
1947                 {\r
1948                     /* The delayed or ready lists cannot be accessed so the task\r
1949                      * is held in the pending ready list until the scheduler is\r
1950                      * unsuspended. */\r
1951                     vListInsertEnd( &( xPendingReadyList ), &( pxTCB->xEventListItem ) );\r
1952                 }\r
1953             }\r
1954             else\r
1955             {\r
1956                 mtCOVERAGE_TEST_MARKER();\r
1957             }\r
1958         }\r
1959         portCLEAR_INTERRUPT_MASK_FROM_ISR( uxSavedInterruptStatus );\r
1960 \r
1961         return xYieldRequired;\r
1962     }\r
1963 \r
1964 #endif /* ( ( INCLUDE_xTaskResumeFromISR == 1 ) && ( INCLUDE_vTaskSuspend == 1 ) ) */\r
1965 /*-----------------------------------------------------------*/\r
1966 \r
1967 void vTaskStartScheduler( void )\r
1968 {\r
1969     BaseType_t xReturn;\r
1970 \r
1971     /* Add the idle task at the lowest priority. */\r
1972     #if ( configSUPPORT_STATIC_ALLOCATION == 1 )\r
1973     {\r
1974         StaticTask_t * pxIdleTaskTCBBuffer = NULL;\r
1975         StackType_t * pxIdleTaskStackBuffer = NULL;\r
1976         uint32_t ulIdleTaskStackSize;\r
1977 \r
1978         /* The Idle task is created using user provided RAM - obtain the\r
1979          * address of the RAM then create the idle task. */\r
1980         vApplicationGetIdleTaskMemory( &pxIdleTaskTCBBuffer, &pxIdleTaskStackBuffer, &ulIdleTaskStackSize );\r
1981         xIdleTaskHandle = xTaskCreateStatic( prvIdleTask,\r
1982                                              configIDLE_TASK_NAME,\r
1983                                              ulIdleTaskStackSize,\r
1984                                              ( void * ) NULL,       /*lint !e961.  The cast is not redundant for all compilers. */\r
1985                                              portPRIVILEGE_BIT,     /* In effect ( tskIDLE_PRIORITY | portPRIVILEGE_BIT ), but tskIDLE_PRIORITY is zero. */\r
1986                                              pxIdleTaskStackBuffer,\r
1987                                              pxIdleTaskTCBBuffer ); /*lint !e961 MISRA exception, justified as it is not a redundant explicit cast to all supported compilers. */\r
1988 \r
1989         if( xIdleTaskHandle != NULL )\r
1990         {\r
1991             xReturn = pdPASS;\r
1992         }\r
1993         else\r
1994         {\r
1995             xReturn = pdFAIL;\r
1996         }\r
1997     }\r
1998     #else /* if ( configSUPPORT_STATIC_ALLOCATION == 1 ) */\r
1999     {\r
2000         /* The Idle task is being created using dynamically allocated RAM. */\r
2001         xReturn = xTaskCreate( prvIdleTask,\r
2002                                configIDLE_TASK_NAME,\r
2003                                configMINIMAL_STACK_SIZE,\r
2004                                ( void * ) NULL,\r
2005                                portPRIVILEGE_BIT,  /* In effect ( tskIDLE_PRIORITY | portPRIVILEGE_BIT ), but tskIDLE_PRIORITY is zero. */\r
2006                                &xIdleTaskHandle ); /*lint !e961 MISRA exception, justified as it is not a redundant explicit cast to all supported compilers. */\r
2007     }\r
2008     #endif /* configSUPPORT_STATIC_ALLOCATION */\r
2009 \r
2010     #if ( configUSE_TIMERS == 1 )\r
2011     {\r
2012         if( xReturn == pdPASS )\r
2013         {\r
2014             xReturn = xTimerCreateTimerTask();\r
2015         }\r
2016         else\r
2017         {\r
2018             mtCOVERAGE_TEST_MARKER();\r
2019         }\r
2020     }\r
2021     #endif /* configUSE_TIMERS */\r
2022 \r
2023     if( xReturn == pdPASS )\r
2024     {\r
2025         /* freertos_tasks_c_additions_init() should only be called if the user\r
2026          * definable macro FREERTOS_TASKS_C_ADDITIONS_INIT() is defined, as that is\r
2027          * the only macro called by the function. */\r
2028         #ifdef FREERTOS_TASKS_C_ADDITIONS_INIT\r
2029         {\r
2030             freertos_tasks_c_additions_init();\r
2031         }\r
2032         #endif\r
2033 \r
2034         /* Interrupts are turned off here, to ensure a tick does not occur\r
2035          * before or during the call to xPortStartScheduler().  The stacks of\r
2036          * the created tasks contain a status word with interrupts switched on\r
2037          * so interrupts will automatically get re-enabled when the first task\r
2038          * starts to run. */\r
2039         portDISABLE_INTERRUPTS();\r
2040 \r
2041         #if ( configUSE_NEWLIB_REENTRANT == 1 )\r
2042         {\r
2043             /* Switch Newlib's _impure_ptr variable to point to the _reent\r
2044              * structure specific to the task that will run first.\r
2045              * See the third party link http://www.nadler.com/embedded/newlibAndFreeRTOS.html\r
2046              * for additional information. */\r
2047             _impure_ptr = &( pxCurrentTCB->xNewLib_reent );\r
2048         }\r
2049         #endif /* configUSE_NEWLIB_REENTRANT */\r
2050 \r
2051         xNextTaskUnblockTime = portMAX_DELAY;\r
2052         xSchedulerRunning = pdTRUE;\r
2053         xTickCount = ( TickType_t ) configINITIAL_TICK_COUNT;\r
2054 \r
2055         /* If configGENERATE_RUN_TIME_STATS is defined then the following\r
2056          * macro must be defined to configure the timer/counter used to generate\r
2057          * the run time counter time base.   NOTE:  If configGENERATE_RUN_TIME_STATS\r
2058          * is set to 0 and the following line fails to build then ensure you do not\r
2059          * have portCONFIGURE_TIMER_FOR_RUN_TIME_STATS() defined in your\r
2060          * FreeRTOSConfig.h file. */\r
2061         portCONFIGURE_TIMER_FOR_RUN_TIME_STATS();\r
2062 \r
2063         traceTASK_SWITCHED_IN();\r
2064 \r
2065         /* Setting up the timer tick is hardware specific and thus in the\r
2066          * portable interface. */\r
2067         xPortStartScheduler();\r
2068 \r
2069         /* In most cases, xPortStartScheduler() will not return. If it\r
2070          * returns pdTRUE then there was not enough heap memory available\r
2071          * to create either the Idle or the Timer task. If it returned\r
2072          * pdFALSE, then the application called xTaskEndScheduler().\r
2073          * Most ports don't implement xTaskEndScheduler() as there is\r
2074          * nothing to return to. */\r
2075     }\r
2076     else\r
2077     {\r
2078         /* This line will only be reached if the kernel could not be started,\r
2079          * because there was not enough FreeRTOS heap to create the idle task\r
2080          * or the timer task. */\r
2081         configASSERT( xReturn != errCOULD_NOT_ALLOCATE_REQUIRED_MEMORY );\r
2082     }\r
2083 \r
2084     /* Prevent compiler warnings if INCLUDE_xTaskGetIdleTaskHandle is set to 0,\r
2085      * meaning xIdleTaskHandle is not used anywhere else. */\r
2086     ( void ) xIdleTaskHandle;\r
2087 \r
2088     /* OpenOCD makes use of uxTopUsedPriority for thread debugging. Prevent uxTopUsedPriority\r
2089      * from getting optimized out as it is no longer used by the kernel. */\r
2090     ( void ) uxTopUsedPriority;\r
2091 }\r
2092 /*-----------------------------------------------------------*/\r
2093 \r
2094 void vTaskEndScheduler( void )\r
2095 {\r
2096     /* Stop the scheduler interrupts and call the portable scheduler end\r
2097      * routine so the original ISRs can be restored if necessary.  The port\r
2098      * layer must ensure interrupts enable  bit is left in the correct state. */\r
2099     portDISABLE_INTERRUPTS();\r
2100     xSchedulerRunning = pdFALSE;\r
2101     vPortEndScheduler();\r
2102 }\r
2103 /*----------------------------------------------------------*/\r
2104 \r
2105 void vTaskSuspendAll( void )\r
2106 {\r
2107     /* A critical section is not required as the variable is of type\r
2108      * BaseType_t.  Please read Richard Barry's reply in the following link to a\r
2109      * post in the FreeRTOS support forum before reporting this as a bug! -\r
2110      * https://goo.gl/wu4acr */\r
2111 \r
2112     /* portSOFTWARE_BARRIER() is only implemented for emulated/simulated ports that\r
2113      * do not otherwise exhibit real time behaviour. */\r
2114     portSOFTWARE_BARRIER();\r
2115 \r
2116     /* The scheduler is suspended if uxSchedulerSuspended is non-zero.  An increment\r
2117      * is used to allow calls to vTaskSuspendAll() to nest. */\r
2118     ++uxSchedulerSuspended;\r
2119 \r
2120     /* Enforces ordering for ports and optimised compilers that may otherwise place\r
2121      * the above increment elsewhere. */\r
2122     portMEMORY_BARRIER();\r
2123 }\r
2124 /*----------------------------------------------------------*/\r
2125 \r
2126 #if ( configUSE_TICKLESS_IDLE != 0 )\r
2127 \r
2128     static TickType_t prvGetExpectedIdleTime( void )\r
2129     {\r
2130         TickType_t xReturn;\r
2131         UBaseType_t uxHigherPriorityReadyTasks = pdFALSE;\r
2132 \r
2133         /* uxHigherPriorityReadyTasks takes care of the case where\r
2134          * configUSE_PREEMPTION is 0, so there may be tasks above the idle priority\r
2135          * task that are in the Ready state, even though the idle task is\r
2136          * running. */\r
2137         #if ( configUSE_PORT_OPTIMISED_TASK_SELECTION == 0 )\r
2138         {\r
2139             if( uxTopReadyPriority > tskIDLE_PRIORITY )\r
2140             {\r
2141                 uxHigherPriorityReadyTasks = pdTRUE;\r
2142             }\r
2143         }\r
2144         #else\r
2145         {\r
2146             const UBaseType_t uxLeastSignificantBit = ( UBaseType_t ) 0x01;\r
2147 \r
2148             /* When port optimised task selection is used the uxTopReadyPriority\r
2149              * variable is used as a bit map.  If bits other than the least\r
2150              * significant bit are set then there are tasks that have a priority\r
2151              * above the idle priority that are in the Ready state.  This takes\r
2152              * care of the case where the co-operative scheduler is in use. */\r
2153             if( uxTopReadyPriority > uxLeastSignificantBit )\r
2154             {\r
2155                 uxHigherPriorityReadyTasks = pdTRUE;\r
2156             }\r
2157         }\r
2158         #endif /* if ( configUSE_PORT_OPTIMISED_TASK_SELECTION == 0 ) */\r
2159 \r
2160         if( pxCurrentTCB->uxPriority > tskIDLE_PRIORITY )\r
2161         {\r
2162             xReturn = 0;\r
2163         }\r
2164         else if( listCURRENT_LIST_LENGTH( &( pxReadyTasksLists[ tskIDLE_PRIORITY ] ) ) > 1 )\r
2165         {\r
2166             /* There are other idle priority tasks in the ready state.  If\r
2167              * time slicing is used then the very next tick interrupt must be\r
2168              * processed. */\r
2169             xReturn = 0;\r
2170         }\r
2171         else if( uxHigherPriorityReadyTasks != pdFALSE )\r
2172         {\r
2173             /* There are tasks in the Ready state that have a priority above the\r
2174              * idle priority.  This path can only be reached if\r
2175              * configUSE_PREEMPTION is 0. */\r
2176             xReturn = 0;\r
2177         }\r
2178         else\r
2179         {\r
2180             xReturn = xNextTaskUnblockTime - xTickCount;\r
2181         }\r
2182 \r
2183         return xReturn;\r
2184     }\r
2185 \r
2186 #endif /* configUSE_TICKLESS_IDLE */\r
2187 /*----------------------------------------------------------*/\r
2188 \r
2189 BaseType_t xTaskResumeAll( void )\r
2190 {\r
2191     TCB_t * pxTCB = NULL;\r
2192     BaseType_t xAlreadyYielded = pdFALSE;\r
2193 \r
2194     /* If uxSchedulerSuspended is zero then this function does not match a\r
2195      * previous call to vTaskSuspendAll(). */\r
2196     configASSERT( uxSchedulerSuspended );\r
2197 \r
2198     /* It is possible that an ISR caused a task to be removed from an event\r
2199      * list while the scheduler was suspended.  If this was the case then the\r
2200      * removed task will have been added to the xPendingReadyList.  Once the\r
2201      * scheduler has been resumed it is safe to move all the pending ready\r
2202      * tasks from this list into their appropriate ready list. */\r
2203     taskENTER_CRITICAL();\r
2204     {\r
2205         --uxSchedulerSuspended;\r
2206 \r
2207         if( uxSchedulerSuspended == ( UBaseType_t ) pdFALSE )\r
2208         {\r
2209             if( uxCurrentNumberOfTasks > ( UBaseType_t ) 0U )\r
2210             {\r
2211                 /* Move any readied tasks from the pending list into the\r
2212                  * appropriate ready list. */\r
2213                 while( listLIST_IS_EMPTY( &xPendingReadyList ) == pdFALSE )\r
2214                 {\r
2215                     pxTCB = listGET_OWNER_OF_HEAD_ENTRY( ( &xPendingReadyList ) ); /*lint !e9079 void * is used as this macro is used with timers and co-routines too.  Alignment is known to be fine as the type of the pointer stored and retrieved is the same. */\r
2216                     listREMOVE_ITEM( &( pxTCB->xEventListItem ) );\r
2217                     portMEMORY_BARRIER();\r
2218                     listREMOVE_ITEM( &( pxTCB->xStateListItem ) );\r
2219                     prvAddTaskToReadyList( pxTCB );\r
2220 \r
2221                     /* If the moved task has a priority higher than or equal to\r
2222                      * the current task then a yield must be performed. */\r
2223                     if( pxTCB->uxPriority >= pxCurrentTCB->uxPriority )\r
2224                     {\r
2225                         xYieldPending = pdTRUE;\r
2226                     }\r
2227                     else\r
2228                     {\r
2229                         mtCOVERAGE_TEST_MARKER();\r
2230                     }\r
2231                 }\r
2232 \r
2233                 if( pxTCB != NULL )\r
2234                 {\r
2235                     /* A task was unblocked while the scheduler was suspended,\r
2236                      * which may have prevented the next unblock time from being\r
2237                      * re-calculated, in which case re-calculate it now.  Mainly\r
2238                      * important for low power tickless implementations, where\r
2239                      * this can prevent an unnecessary exit from low power\r
2240                      * state. */\r
2241                     prvResetNextTaskUnblockTime();\r
2242                 }\r
2243 \r
2244                 /* If any ticks occurred while the scheduler was suspended then\r
2245                  * they should be processed now.  This ensures the tick count does\r
2246                  * not  slip, and that any delayed tasks are resumed at the correct\r
2247                  * time. */\r
2248                 {\r
2249                     TickType_t xPendedCounts = xPendedTicks; /* Non-volatile copy. */\r
2250 \r
2251                     if( xPendedCounts > ( TickType_t ) 0U )\r
2252                     {\r
2253                         do\r
2254                         {\r
2255                             if( xTaskIncrementTick() != pdFALSE )\r
2256                             {\r
2257                                 xYieldPending = pdTRUE;\r
2258                             }\r
2259                             else\r
2260                             {\r
2261                                 mtCOVERAGE_TEST_MARKER();\r
2262                             }\r
2263 \r
2264                             --xPendedCounts;\r
2265                         } while( xPendedCounts > ( TickType_t ) 0U );\r
2266 \r
2267                         xPendedTicks = 0;\r
2268                     }\r
2269                     else\r
2270                     {\r
2271                         mtCOVERAGE_TEST_MARKER();\r
2272                     }\r
2273                 }\r
2274 \r
2275                 if( xYieldPending != pdFALSE )\r
2276                 {\r
2277                     #if ( configUSE_PREEMPTION != 0 )\r
2278                     {\r
2279                         xAlreadyYielded = pdTRUE;\r
2280                     }\r
2281                     #endif\r
2282                     taskYIELD_IF_USING_PREEMPTION();\r
2283                 }\r
2284                 else\r
2285                 {\r
2286                     mtCOVERAGE_TEST_MARKER();\r
2287                 }\r
2288             }\r
2289         }\r
2290         else\r
2291         {\r
2292             mtCOVERAGE_TEST_MARKER();\r
2293         }\r
2294     }\r
2295     taskEXIT_CRITICAL();\r
2296 \r
2297     return xAlreadyYielded;\r
2298 }\r
2299 /*-----------------------------------------------------------*/\r
2300 \r
2301 TickType_t xTaskGetTickCount( void )\r
2302 {\r
2303     TickType_t xTicks;\r
2304 \r
2305     /* Critical section required if running on a 16 bit processor. */\r
2306     portTICK_TYPE_ENTER_CRITICAL();\r
2307     {\r
2308         xTicks = xTickCount;\r
2309     }\r
2310     portTICK_TYPE_EXIT_CRITICAL();\r
2311 \r
2312     return xTicks;\r
2313 }\r
2314 /*-----------------------------------------------------------*/\r
2315 \r
2316 TickType_t xTaskGetTickCountFromISR( void )\r
2317 {\r
2318     TickType_t xReturn;\r
2319     UBaseType_t uxSavedInterruptStatus;\r
2320 \r
2321     /* RTOS ports that support interrupt nesting have the concept of a maximum\r
2322      * system call (or maximum API call) interrupt priority.  Interrupts that are\r
2323      * above the maximum system call priority are kept permanently enabled, even\r
2324      * when the RTOS kernel is in a critical section, but cannot make any calls to\r
2325      * FreeRTOS API functions.  If configASSERT() is defined in FreeRTOSConfig.h\r
2326      * then portASSERT_IF_INTERRUPT_PRIORITY_INVALID() will result in an assertion\r
2327      * failure if a FreeRTOS API function is called from an interrupt that has been\r
2328      * assigned a priority above the configured maximum system call priority.\r
2329      * Only FreeRTOS functions that end in FromISR can be called from interrupts\r
2330      * that have been assigned a priority at or (logically) below the maximum\r
2331      * system call  interrupt priority.  FreeRTOS maintains a separate interrupt\r
2332      * safe API to ensure interrupt entry is as fast and as simple as possible.\r
2333      * More information (albeit Cortex-M specific) is provided on the following\r
2334      * link: https://www.FreeRTOS.org/RTOS-Cortex-M3-M4.html */\r
2335     portASSERT_IF_INTERRUPT_PRIORITY_INVALID();\r
2336 \r
2337     uxSavedInterruptStatus = portTICK_TYPE_SET_INTERRUPT_MASK_FROM_ISR();\r
2338     {\r
2339         xReturn = xTickCount;\r
2340     }\r
2341     portTICK_TYPE_CLEAR_INTERRUPT_MASK_FROM_ISR( uxSavedInterruptStatus );\r
2342 \r
2343     return xReturn;\r
2344 }\r
2345 /*-----------------------------------------------------------*/\r
2346 \r
2347 UBaseType_t uxTaskGetNumberOfTasks( void )\r
2348 {\r
2349     /* A critical section is not required because the variables are of type\r
2350      * BaseType_t. */\r
2351     return uxCurrentNumberOfTasks;\r
2352 }\r
2353 /*-----------------------------------------------------------*/\r
2354 \r
2355 char * pcTaskGetName( TaskHandle_t xTaskToQuery ) /*lint !e971 Unqualified char types are allowed for strings and single characters only. */\r
2356 {\r
2357     TCB_t * pxTCB;\r
2358 \r
2359     /* If null is passed in here then the name of the calling task is being\r
2360      * queried. */\r
2361     pxTCB = prvGetTCBFromHandle( xTaskToQuery );\r
2362     configASSERT( pxTCB );\r
2363     return &( pxTCB->pcTaskName[ 0 ] );\r
2364 }\r
2365 /*-----------------------------------------------------------*/\r
2366 \r
2367 #if ( INCLUDE_xTaskGetHandle == 1 )\r
2368 \r
2369     static TCB_t * prvSearchForNameWithinSingleList( List_t * pxList,\r
2370                                                      const char pcNameToQuery[] )\r
2371     {\r
2372         TCB_t * pxNextTCB, * pxFirstTCB, * pxReturn = NULL;\r
2373         UBaseType_t x;\r
2374         char cNextChar;\r
2375         BaseType_t xBreakLoop;\r
2376 \r
2377         /* This function is called with the scheduler suspended. */\r
2378 \r
2379         if( listCURRENT_LIST_LENGTH( pxList ) > ( UBaseType_t ) 0 )\r
2380         {\r
2381             listGET_OWNER_OF_NEXT_ENTRY( pxFirstTCB, pxList ); /*lint !e9079 void * is used as this macro is used with timers and co-routines too.  Alignment is known to be fine as the type of the pointer stored and retrieved is the same. */\r
2382 \r
2383             do\r
2384             {\r
2385                 listGET_OWNER_OF_NEXT_ENTRY( pxNextTCB, pxList ); /*lint !e9079 void * is used as this macro is used with timers and co-routines too.  Alignment is known to be fine as the type of the pointer stored and retrieved is the same. */\r
2386 \r
2387                 /* Check each character in the name looking for a match or\r
2388                  * mismatch. */\r
2389                 xBreakLoop = pdFALSE;\r
2390 \r
2391                 for( x = ( UBaseType_t ) 0; x < ( UBaseType_t ) configMAX_TASK_NAME_LEN; x++ )\r
2392                 {\r
2393                     cNextChar = pxNextTCB->pcTaskName[ x ];\r
2394 \r
2395                     if( cNextChar != pcNameToQuery[ x ] )\r
2396                     {\r
2397                         /* Characters didn't match. */\r
2398                         xBreakLoop = pdTRUE;\r
2399                     }\r
2400                     else if( cNextChar == ( char ) 0x00 )\r
2401                     {\r
2402                         /* Both strings terminated, a match must have been\r
2403                          * found. */\r
2404                         pxReturn = pxNextTCB;\r
2405                         xBreakLoop = pdTRUE;\r
2406                     }\r
2407                     else\r
2408                     {\r
2409                         mtCOVERAGE_TEST_MARKER();\r
2410                     }\r
2411 \r
2412                     if( xBreakLoop != pdFALSE )\r
2413                     {\r
2414                         break;\r
2415                     }\r
2416                 }\r
2417 \r
2418                 if( pxReturn != NULL )\r
2419                 {\r
2420                     /* The handle has been found. */\r
2421                     break;\r
2422                 }\r
2423             } while( pxNextTCB != pxFirstTCB );\r
2424         }\r
2425         else\r
2426         {\r
2427             mtCOVERAGE_TEST_MARKER();\r
2428         }\r
2429 \r
2430         return pxReturn;\r
2431     }\r
2432 \r
2433 #endif /* INCLUDE_xTaskGetHandle */\r
2434 /*-----------------------------------------------------------*/\r
2435 \r
2436 #if ( INCLUDE_xTaskGetHandle == 1 )\r
2437 \r
2438     TaskHandle_t xTaskGetHandle( const char * pcNameToQuery ) /*lint !e971 Unqualified char types are allowed for strings and single characters only. */\r
2439     {\r
2440         UBaseType_t uxQueue = configMAX_PRIORITIES;\r
2441         TCB_t * pxTCB;\r
2442 \r
2443         /* Task names will be truncated to configMAX_TASK_NAME_LEN - 1 bytes. */\r
2444         configASSERT( strlen( pcNameToQuery ) < configMAX_TASK_NAME_LEN );\r
2445 \r
2446         vTaskSuspendAll();\r
2447         {\r
2448             /* Search the ready lists. */\r
2449             do\r
2450             {\r
2451                 uxQueue--;\r
2452                 pxTCB = prvSearchForNameWithinSingleList( ( List_t * ) &( pxReadyTasksLists[ uxQueue ] ), pcNameToQuery );\r
2453 \r
2454                 if( pxTCB != NULL )\r
2455                 {\r
2456                     /* Found the handle. */\r
2457                     break;\r
2458                 }\r
2459             } while( uxQueue > ( UBaseType_t ) tskIDLE_PRIORITY ); /*lint !e961 MISRA exception as the casts are only redundant for some ports. */\r
2460 \r
2461             /* Search the delayed lists. */\r
2462             if( pxTCB == NULL )\r
2463             {\r
2464                 pxTCB = prvSearchForNameWithinSingleList( ( List_t * ) pxDelayedTaskList, pcNameToQuery );\r
2465             }\r
2466 \r
2467             if( pxTCB == NULL )\r
2468             {\r
2469                 pxTCB = prvSearchForNameWithinSingleList( ( List_t * ) pxOverflowDelayedTaskList, pcNameToQuery );\r
2470             }\r
2471 \r
2472             #if ( INCLUDE_vTaskSuspend == 1 )\r
2473             {\r
2474                 if( pxTCB == NULL )\r
2475                 {\r
2476                     /* Search the suspended list. */\r
2477                     pxTCB = prvSearchForNameWithinSingleList( &xSuspendedTaskList, pcNameToQuery );\r
2478                 }\r
2479             }\r
2480             #endif\r
2481 \r
2482             #if ( INCLUDE_vTaskDelete == 1 )\r
2483             {\r
2484                 if( pxTCB == NULL )\r
2485                 {\r
2486                     /* Search the deleted list. */\r
2487                     pxTCB = prvSearchForNameWithinSingleList( &xTasksWaitingTermination, pcNameToQuery );\r
2488                 }\r
2489             }\r
2490             #endif\r
2491         }\r
2492         ( void ) xTaskResumeAll();\r
2493 \r
2494         return pxTCB;\r
2495     }\r
2496 \r
2497 #endif /* INCLUDE_xTaskGetHandle */\r
2498 /*-----------------------------------------------------------*/\r
2499 \r
2500 #if ( configUSE_TRACE_FACILITY == 1 )\r
2501 \r
2502     UBaseType_t uxTaskGetSystemState( TaskStatus_t * const pxTaskStatusArray,\r
2503                                       const UBaseType_t uxArraySize,\r
2504                                       configRUN_TIME_COUNTER_TYPE * const pulTotalRunTime )\r
2505     {\r
2506         UBaseType_t uxTask = 0, uxQueue = configMAX_PRIORITIES;\r
2507 \r
2508         vTaskSuspendAll();\r
2509         {\r
2510             /* Is there a space in the array for each task in the system? */\r
2511             if( uxArraySize >= uxCurrentNumberOfTasks )\r
2512             {\r
2513                 /* Fill in an TaskStatus_t structure with information on each\r
2514                  * task in the Ready state. */\r
2515                 do\r
2516                 {\r
2517                     uxQueue--;\r
2518                     uxTask += prvListTasksWithinSingleList( &( pxTaskStatusArray[ uxTask ] ), &( pxReadyTasksLists[ uxQueue ] ), eReady );\r
2519                 } while( uxQueue > ( UBaseType_t ) tskIDLE_PRIORITY ); /*lint !e961 MISRA exception as the casts are only redundant for some ports. */\r
2520 \r
2521                 /* Fill in an TaskStatus_t structure with information on each\r
2522                  * task in the Blocked state. */\r
2523                 uxTask += prvListTasksWithinSingleList( &( pxTaskStatusArray[ uxTask ] ), ( List_t * ) pxDelayedTaskList, eBlocked );\r
2524                 uxTask += prvListTasksWithinSingleList( &( pxTaskStatusArray[ uxTask ] ), ( List_t * ) pxOverflowDelayedTaskList, eBlocked );\r
2525 \r
2526                 #if ( INCLUDE_vTaskDelete == 1 )\r
2527                 {\r
2528                     /* Fill in an TaskStatus_t structure with information on\r
2529                      * each task that has been deleted but not yet cleaned up. */\r
2530                     uxTask += prvListTasksWithinSingleList( &( pxTaskStatusArray[ uxTask ] ), &xTasksWaitingTermination, eDeleted );\r
2531                 }\r
2532                 #endif\r
2533 \r
2534                 #if ( INCLUDE_vTaskSuspend == 1 )\r
2535                 {\r
2536                     /* Fill in an TaskStatus_t structure with information on\r
2537                      * each task in the Suspended state. */\r
2538                     uxTask += prvListTasksWithinSingleList( &( pxTaskStatusArray[ uxTask ] ), &xSuspendedTaskList, eSuspended );\r
2539                 }\r
2540                 #endif\r
2541 \r
2542                 #if ( configGENERATE_RUN_TIME_STATS == 1 )\r
2543                 {\r
2544                     if( pulTotalRunTime != NULL )\r
2545                     {\r
2546                         #ifdef portALT_GET_RUN_TIME_COUNTER_VALUE\r
2547                             portALT_GET_RUN_TIME_COUNTER_VALUE( ( *pulTotalRunTime ) );\r
2548                         #else\r
2549                             *pulTotalRunTime = portGET_RUN_TIME_COUNTER_VALUE();\r
2550                         #endif\r
2551                     }\r
2552                 }\r
2553                 #else /* if ( configGENERATE_RUN_TIME_STATS == 1 ) */\r
2554                 {\r
2555                     if( pulTotalRunTime != NULL )\r
2556                     {\r
2557                         *pulTotalRunTime = 0;\r
2558                     }\r
2559                 }\r
2560                 #endif /* if ( configGENERATE_RUN_TIME_STATS == 1 ) */\r
2561             }\r
2562             else\r
2563             {\r
2564                 mtCOVERAGE_TEST_MARKER();\r
2565             }\r
2566         }\r
2567         ( void ) xTaskResumeAll();\r
2568 \r
2569         return uxTask;\r
2570     }\r
2571 \r
2572 #endif /* configUSE_TRACE_FACILITY */\r
2573 /*----------------------------------------------------------*/\r
2574 \r
2575 #if ( INCLUDE_xTaskGetIdleTaskHandle == 1 )\r
2576 \r
2577     TaskHandle_t xTaskGetIdleTaskHandle( void )\r
2578     {\r
2579         /* If xTaskGetIdleTaskHandle() is called before the scheduler has been\r
2580          * started, then xIdleTaskHandle will be NULL. */\r
2581         configASSERT( ( xIdleTaskHandle != NULL ) );\r
2582         return xIdleTaskHandle;\r
2583     }\r
2584 \r
2585 #endif /* INCLUDE_xTaskGetIdleTaskHandle */\r
2586 /*----------------------------------------------------------*/\r
2587 \r
2588 /* This conditional compilation should use inequality to 0, not equality to 1.\r
2589  * This is to ensure vTaskStepTick() is available when user defined low power mode\r
2590  * implementations require configUSE_TICKLESS_IDLE to be set to a value other than\r
2591  * 1. */\r
2592 #if ( configUSE_TICKLESS_IDLE != 0 )\r
2593 \r
2594     void vTaskStepTick( TickType_t xTicksToJump )\r
2595     {\r
2596         /* Correct the tick count value after a period during which the tick\r
2597          * was suppressed.  Note this does *not* call the tick hook function for\r
2598          * each stepped tick. */\r
2599         configASSERT( ( xTickCount + xTicksToJump ) <= xNextTaskUnblockTime );\r
2600 \r
2601         if( ( xTickCount + xTicksToJump ) == xNextTaskUnblockTime )\r
2602         {\r
2603             /* Arrange for xTickCount to reach xNextTaskUnblockTime in\r
2604              * xTaskIncrementTick() when the scheduler resumes.  This ensures\r
2605              * that any delayed tasks are resumed at the correct time. */\r
2606             configASSERT( uxSchedulerSuspended );\r
2607             configASSERT( xTicksToJump != ( TickType_t ) 0 );\r
2608 \r
2609             /* Prevent the tick interrupt modifying xPendedTicks simultaneously. */\r
2610             taskENTER_CRITICAL();\r
2611             {\r
2612                 xPendedTicks++;\r
2613             }\r
2614             taskEXIT_CRITICAL();\r
2615             xTicksToJump--;\r
2616         }\r
2617         else\r
2618         {\r
2619             mtCOVERAGE_TEST_MARKER();\r
2620         }\r
2621 \r
2622         xTickCount += xTicksToJump;\r
2623         traceINCREASE_TICK_COUNT( xTicksToJump );\r
2624     }\r
2625 \r
2626 #endif /* configUSE_TICKLESS_IDLE */\r
2627 /*----------------------------------------------------------*/\r
2628 \r
2629 BaseType_t xTaskCatchUpTicks( TickType_t xTicksToCatchUp )\r
2630 {\r
2631     BaseType_t xYieldOccurred;\r
2632 \r
2633     /* Must not be called with the scheduler suspended as the implementation\r
2634      * relies on xPendedTicks being wound down to 0 in xTaskResumeAll(). */\r
2635     configASSERT( uxSchedulerSuspended == 0 );\r
2636 \r
2637     /* Use xPendedTicks to mimic xTicksToCatchUp number of ticks occurring when\r
2638      * the scheduler is suspended so the ticks are executed in xTaskResumeAll(). */\r
2639     vTaskSuspendAll();\r
2640 \r
2641     /* Prevent the tick interrupt modifying xPendedTicks simultaneously. */\r
2642     taskENTER_CRITICAL();\r
2643     {\r
2644         xPendedTicks += xTicksToCatchUp;\r
2645     }\r
2646     taskEXIT_CRITICAL();\r
2647     xYieldOccurred = xTaskResumeAll();\r
2648 \r
2649     return xYieldOccurred;\r
2650 }\r
2651 /*----------------------------------------------------------*/\r
2652 \r
2653 #if ( INCLUDE_xTaskAbortDelay == 1 )\r
2654 \r
2655     BaseType_t xTaskAbortDelay( TaskHandle_t xTask )\r
2656     {\r
2657         TCB_t * pxTCB = xTask;\r
2658         BaseType_t xReturn;\r
2659 \r
2660         configASSERT( pxTCB );\r
2661 \r
2662         vTaskSuspendAll();\r
2663         {\r
2664             /* A task can only be prematurely removed from the Blocked state if\r
2665              * it is actually in the Blocked state. */\r
2666             if( eTaskGetState( xTask ) == eBlocked )\r
2667             {\r
2668                 xReturn = pdPASS;\r
2669 \r
2670                 /* Remove the reference to the task from the blocked list.  An\r
2671                  * interrupt won't touch the xStateListItem because the\r
2672                  * scheduler is suspended. */\r
2673                 ( void ) uxListRemove( &( pxTCB->xStateListItem ) );\r
2674 \r
2675                 /* Is the task waiting on an event also?  If so remove it from\r
2676                  * the event list too.  Interrupts can touch the event list item,\r
2677                  * even though the scheduler is suspended, so a critical section\r
2678                  * is used. */\r
2679                 taskENTER_CRITICAL();\r
2680                 {\r
2681                     if( listLIST_ITEM_CONTAINER( &( pxTCB->xEventListItem ) ) != NULL )\r
2682                     {\r
2683                         ( void ) uxListRemove( &( pxTCB->xEventListItem ) );\r
2684 \r
2685                         /* This lets the task know it was forcibly removed from the\r
2686                          * blocked state so it should not re-evaluate its block time and\r
2687                          * then block again. */\r
2688                         pxTCB->ucDelayAborted = pdTRUE;\r
2689                     }\r
2690                     else\r
2691                     {\r
2692                         mtCOVERAGE_TEST_MARKER();\r
2693                     }\r
2694                 }\r
2695                 taskEXIT_CRITICAL();\r
2696 \r
2697                 /* Place the unblocked task into the appropriate ready list. */\r
2698                 prvAddTaskToReadyList( pxTCB );\r
2699 \r
2700                 /* A task being unblocked cannot cause an immediate context\r
2701                  * switch if preemption is turned off. */\r
2702                 #if ( configUSE_PREEMPTION == 1 )\r
2703                 {\r
2704                     /* Preemption is on, but a context switch should only be\r
2705                      * performed if the unblocked task has a priority that is\r
2706                      * higher than the currently executing task. */\r
2707                     if( pxTCB->uxPriority > pxCurrentTCB->uxPriority )\r
2708                     {\r
2709                         /* Pend the yield to be performed when the scheduler\r
2710                          * is unsuspended. */\r
2711                         xYieldPending = pdTRUE;\r
2712                     }\r
2713                     else\r
2714                     {\r
2715                         mtCOVERAGE_TEST_MARKER();\r
2716                     }\r
2717                 }\r
2718                 #endif /* configUSE_PREEMPTION */\r
2719             }\r
2720             else\r
2721             {\r
2722                 xReturn = pdFAIL;\r
2723             }\r
2724         }\r
2725         ( void ) xTaskResumeAll();\r
2726 \r
2727         return xReturn;\r
2728     }\r
2729 \r
2730 #endif /* INCLUDE_xTaskAbortDelay */\r
2731 /*----------------------------------------------------------*/\r
2732 \r
2733 BaseType_t xTaskIncrementTick( void )\r
2734 {\r
2735     TCB_t * pxTCB;\r
2736     TickType_t xItemValue;\r
2737     BaseType_t xSwitchRequired = pdFALSE;\r
2738 \r
2739     /* Called by the portable layer each time a tick interrupt occurs.\r
2740      * Increments the tick then checks to see if the new tick value will cause any\r
2741      * tasks to be unblocked. */\r
2742     traceTASK_INCREMENT_TICK( xTickCount );\r
2743 \r
2744     if( uxSchedulerSuspended == ( UBaseType_t ) pdFALSE )\r
2745     {\r
2746         /* Minor optimisation.  The tick count cannot change in this\r
2747          * block. */\r
2748         const TickType_t xConstTickCount = xTickCount + ( TickType_t ) 1;\r
2749 \r
2750         /* Increment the RTOS tick, switching the delayed and overflowed\r
2751          * delayed lists if it wraps to 0. */\r
2752         xTickCount = xConstTickCount;\r
2753 \r
2754         if( xConstTickCount == ( TickType_t ) 0U ) /*lint !e774 'if' does not always evaluate to false as it is looking for an overflow. */\r
2755         {\r
2756             taskSWITCH_DELAYED_LISTS();\r
2757         }\r
2758         else\r
2759         {\r
2760             mtCOVERAGE_TEST_MARKER();\r
2761         }\r
2762 \r
2763         /* See if this tick has made a timeout expire.  Tasks are stored in\r
2764          * the  queue in the order of their wake time - meaning once one task\r
2765          * has been found whose block time has not expired there is no need to\r
2766          * look any further down the list. */\r
2767         if( xConstTickCount >= xNextTaskUnblockTime )\r
2768         {\r
2769             for( ; ; )\r
2770             {\r
2771                 if( listLIST_IS_EMPTY( pxDelayedTaskList ) != pdFALSE )\r
2772                 {\r
2773                     /* The delayed list is empty.  Set xNextTaskUnblockTime\r
2774                      * to the maximum possible value so it is extremely\r
2775                      * unlikely that the\r
2776                      * if( xTickCount >= xNextTaskUnblockTime ) test will pass\r
2777                      * next time through. */\r
2778                     xNextTaskUnblockTime = portMAX_DELAY; /*lint !e961 MISRA exception as the casts are only redundant for some ports. */\r
2779                     break;\r
2780                 }\r
2781                 else\r
2782                 {\r
2783                     /* The delayed list is not empty, get the value of the\r
2784                      * item at the head of the delayed list.  This is the time\r
2785                      * at which the task at the head of the delayed list must\r
2786                      * be removed from the Blocked state. */\r
2787                     pxTCB = listGET_OWNER_OF_HEAD_ENTRY( pxDelayedTaskList ); /*lint !e9079 void * is used as this macro is used with timers and co-routines too.  Alignment is known to be fine as the type of the pointer stored and retrieved is the same. */\r
2788                     xItemValue = listGET_LIST_ITEM_VALUE( &( pxTCB->xStateListItem ) );\r
2789 \r
2790                     if( xConstTickCount < xItemValue )\r
2791                     {\r
2792                         /* It is not time to unblock this item yet, but the\r
2793                          * item value is the time at which the task at the head\r
2794                          * of the blocked list must be removed from the Blocked\r
2795                          * state -  so record the item value in\r
2796                          * xNextTaskUnblockTime. */\r
2797                         xNextTaskUnblockTime = xItemValue;\r
2798                         break; /*lint !e9011 Code structure here is deemed easier to understand with multiple breaks. */\r
2799                     }\r
2800                     else\r
2801                     {\r
2802                         mtCOVERAGE_TEST_MARKER();\r
2803                     }\r
2804 \r
2805                     /* It is time to remove the item from the Blocked state. */\r
2806                     listREMOVE_ITEM( &( pxTCB->xStateListItem ) );\r
2807 \r
2808                     /* Is the task waiting on an event also?  If so remove\r
2809                      * it from the event list. */\r
2810                     if( listLIST_ITEM_CONTAINER( &( pxTCB->xEventListItem ) ) != NULL )\r
2811                     {\r
2812                         listREMOVE_ITEM( &( pxTCB->xEventListItem ) );\r
2813                     }\r
2814                     else\r
2815                     {\r
2816                         mtCOVERAGE_TEST_MARKER();\r
2817                     }\r
2818 \r
2819                     /* Place the unblocked task into the appropriate ready\r
2820                      * list. */\r
2821                     prvAddTaskToReadyList( pxTCB );\r
2822 \r
2823                     /* A task being unblocked cannot cause an immediate\r
2824                      * context switch if preemption is turned off. */\r
2825                     #if ( configUSE_PREEMPTION == 1 )\r
2826                     {\r
2827                         /* Preemption is on, but a context switch should\r
2828                          * only be performed if the unblocked task has a\r
2829                          * priority that is equal to or higher than the\r
2830                          * currently executing task. */\r
2831                         if( pxTCB->uxPriority >= pxCurrentTCB->uxPriority )\r
2832                         {\r
2833                             xSwitchRequired = pdTRUE;\r
2834                         }\r
2835                         else\r
2836                         {\r
2837                             mtCOVERAGE_TEST_MARKER();\r
2838                         }\r
2839                     }\r
2840                     #endif /* configUSE_PREEMPTION */\r
2841                 }\r
2842             }\r
2843         }\r
2844 \r
2845         /* Tasks of equal priority to the currently running task will share\r
2846          * processing time (time slice) if preemption is on, and the application\r
2847          * writer has not explicitly turned time slicing off. */\r
2848         #if ( ( configUSE_PREEMPTION == 1 ) && ( configUSE_TIME_SLICING == 1 ) )\r
2849         {\r
2850             if( listCURRENT_LIST_LENGTH( &( pxReadyTasksLists[ pxCurrentTCB->uxPriority ] ) ) > ( UBaseType_t ) 1 )\r
2851             {\r
2852                 xSwitchRequired = pdTRUE;\r
2853             }\r
2854             else\r
2855             {\r
2856                 mtCOVERAGE_TEST_MARKER();\r
2857             }\r
2858         }\r
2859         #endif /* ( ( configUSE_PREEMPTION == 1 ) && ( configUSE_TIME_SLICING == 1 ) ) */\r
2860 \r
2861         #if ( configUSE_TICK_HOOK == 1 )\r
2862         {\r
2863             /* Guard against the tick hook being called when the pended tick\r
2864              * count is being unwound (when the scheduler is being unlocked). */\r
2865             if( xPendedTicks == ( TickType_t ) 0 )\r
2866             {\r
2867                 vApplicationTickHook();\r
2868             }\r
2869             else\r
2870             {\r
2871                 mtCOVERAGE_TEST_MARKER();\r
2872             }\r
2873         }\r
2874         #endif /* configUSE_TICK_HOOK */\r
2875 \r
2876         #if ( configUSE_PREEMPTION == 1 )\r
2877         {\r
2878             if( xYieldPending != pdFALSE )\r
2879             {\r
2880                 xSwitchRequired = pdTRUE;\r
2881             }\r
2882             else\r
2883             {\r
2884                 mtCOVERAGE_TEST_MARKER();\r
2885             }\r
2886         }\r
2887         #endif /* configUSE_PREEMPTION */\r
2888     }\r
2889     else\r
2890     {\r
2891         ++xPendedTicks;\r
2892 \r
2893         /* The tick hook gets called at regular intervals, even if the\r
2894          * scheduler is locked. */\r
2895         #if ( configUSE_TICK_HOOK == 1 )\r
2896         {\r
2897             vApplicationTickHook();\r
2898         }\r
2899         #endif\r
2900     }\r
2901 \r
2902     return xSwitchRequired;\r
2903 }\r
2904 /*-----------------------------------------------------------*/\r
2905 \r
2906 #if ( configUSE_APPLICATION_TASK_TAG == 1 )\r
2907 \r
2908     void vTaskSetApplicationTaskTag( TaskHandle_t xTask,\r
2909                                      TaskHookFunction_t pxHookFunction )\r
2910     {\r
2911         TCB_t * xTCB;\r
2912 \r
2913         /* If xTask is NULL then it is the task hook of the calling task that is\r
2914          * getting set. */\r
2915         if( xTask == NULL )\r
2916         {\r
2917             xTCB = ( TCB_t * ) pxCurrentTCB;\r
2918         }\r
2919         else\r
2920         {\r
2921             xTCB = xTask;\r
2922         }\r
2923 \r
2924         /* Save the hook function in the TCB.  A critical section is required as\r
2925          * the value can be accessed from an interrupt. */\r
2926         taskENTER_CRITICAL();\r
2927         {\r
2928             xTCB->pxTaskTag = pxHookFunction;\r
2929         }\r
2930         taskEXIT_CRITICAL();\r
2931     }\r
2932 \r
2933 #endif /* configUSE_APPLICATION_TASK_TAG */\r
2934 /*-----------------------------------------------------------*/\r
2935 \r
2936 #if ( configUSE_APPLICATION_TASK_TAG == 1 )\r
2937 \r
2938     TaskHookFunction_t xTaskGetApplicationTaskTag( TaskHandle_t xTask )\r
2939     {\r
2940         TCB_t * pxTCB;\r
2941         TaskHookFunction_t xReturn;\r
2942 \r
2943         /* If xTask is NULL then set the calling task's hook. */\r
2944         pxTCB = prvGetTCBFromHandle( xTask );\r
2945 \r
2946         /* Save the hook function in the TCB.  A critical section is required as\r
2947          * the value can be accessed from an interrupt. */\r
2948         taskENTER_CRITICAL();\r
2949         {\r
2950             xReturn = pxTCB->pxTaskTag;\r
2951         }\r
2952         taskEXIT_CRITICAL();\r
2953 \r
2954         return xReturn;\r
2955     }\r
2956 \r
2957 #endif /* configUSE_APPLICATION_TASK_TAG */\r
2958 /*-----------------------------------------------------------*/\r
2959 \r
2960 #if ( configUSE_APPLICATION_TASK_TAG == 1 )\r
2961 \r
2962     TaskHookFunction_t xTaskGetApplicationTaskTagFromISR( TaskHandle_t xTask )\r
2963     {\r
2964         TCB_t * pxTCB;\r
2965         TaskHookFunction_t xReturn;\r
2966         UBaseType_t uxSavedInterruptStatus;\r
2967 \r
2968         /* If xTask is NULL then set the calling task's hook. */\r
2969         pxTCB = prvGetTCBFromHandle( xTask );\r
2970 \r
2971         /* Save the hook function in the TCB.  A critical section is required as\r
2972          * the value can be accessed from an interrupt. */\r
2973         uxSavedInterruptStatus = portSET_INTERRUPT_MASK_FROM_ISR();\r
2974         {\r
2975             xReturn = pxTCB->pxTaskTag;\r
2976         }\r
2977         portCLEAR_INTERRUPT_MASK_FROM_ISR( uxSavedInterruptStatus );\r
2978 \r
2979         return xReturn;\r
2980     }\r
2981 \r
2982 #endif /* configUSE_APPLICATION_TASK_TAG */\r
2983 /*-----------------------------------------------------------*/\r
2984 \r
2985 #if ( configUSE_APPLICATION_TASK_TAG == 1 )\r
2986 \r
2987     BaseType_t xTaskCallApplicationTaskHook( TaskHandle_t xTask,\r
2988                                              void * pvParameter )\r
2989     {\r
2990         TCB_t * xTCB;\r
2991         BaseType_t xReturn;\r
2992 \r
2993         /* If xTask is NULL then we are calling our own task hook. */\r
2994         if( xTask == NULL )\r
2995         {\r
2996             xTCB = pxCurrentTCB;\r
2997         }\r
2998         else\r
2999         {\r
3000             xTCB = xTask;\r
3001         }\r
3002 \r
3003         if( xTCB->pxTaskTag != NULL )\r
3004         {\r
3005             xReturn = xTCB->pxTaskTag( pvParameter );\r
3006         }\r
3007         else\r
3008         {\r
3009             xReturn = pdFAIL;\r
3010         }\r
3011 \r
3012         return xReturn;\r
3013     }\r
3014 \r
3015 #endif /* configUSE_APPLICATION_TASK_TAG */\r
3016 /*-----------------------------------------------------------*/\r
3017 \r
3018 void vTaskSwitchContext( void )\r
3019 {\r
3020     if( uxSchedulerSuspended != ( UBaseType_t ) pdFALSE )\r
3021     {\r
3022         /* The scheduler is currently suspended - do not allow a context\r
3023          * switch. */\r
3024         xYieldPending = pdTRUE;\r
3025     }\r
3026     else\r
3027     {\r
3028         xYieldPending = pdFALSE;\r
3029         traceTASK_SWITCHED_OUT();\r
3030 \r
3031         #if ( configGENERATE_RUN_TIME_STATS == 1 )\r
3032         {\r
3033             #ifdef portALT_GET_RUN_TIME_COUNTER_VALUE\r
3034                 portALT_GET_RUN_TIME_COUNTER_VALUE( ulTotalRunTime );\r
3035             #else\r
3036                 ulTotalRunTime = portGET_RUN_TIME_COUNTER_VALUE();\r
3037             #endif\r
3038 \r
3039             /* Add the amount of time the task has been running to the\r
3040              * accumulated time so far.  The time the task started running was\r
3041              * stored in ulTaskSwitchedInTime.  Note that there is no overflow\r
3042              * protection here so count values are only valid until the timer\r
3043              * overflows.  The guard against negative values is to protect\r
3044              * against suspect run time stat counter implementations - which\r
3045              * are provided by the application, not the kernel. */\r
3046             if( ulTotalRunTime > ulTaskSwitchedInTime )\r
3047             {\r
3048                 pxCurrentTCB->ulRunTimeCounter += ( ulTotalRunTime - ulTaskSwitchedInTime );\r
3049             }\r
3050             else\r
3051             {\r
3052                 mtCOVERAGE_TEST_MARKER();\r
3053             }\r
3054 \r
3055             ulTaskSwitchedInTime = ulTotalRunTime;\r
3056         }\r
3057         #endif /* configGENERATE_RUN_TIME_STATS */\r
3058 \r
3059         /* Check for stack overflow, if configured. */\r
3060         taskCHECK_FOR_STACK_OVERFLOW();\r
3061 \r
3062         /* Before the currently running task is switched out, save its errno. */\r
3063         #if ( configUSE_POSIX_ERRNO == 1 )\r
3064         {\r
3065             pxCurrentTCB->iTaskErrno = FreeRTOS_errno;\r
3066         }\r
3067         #endif\r
3068 \r
3069         /* Select a new task to run using either the generic C or port\r
3070          * optimised asm code. */\r
3071         taskSELECT_HIGHEST_PRIORITY_TASK(); /*lint !e9079 void * is used as this macro is used with timers and co-routines too.  Alignment is known to be fine as the type of the pointer stored and retrieved is the same. */\r
3072         traceTASK_SWITCHED_IN();\r
3073 \r
3074         /* After the new task is switched in, update the global errno. */\r
3075         #if ( configUSE_POSIX_ERRNO == 1 )\r
3076         {\r
3077             FreeRTOS_errno = pxCurrentTCB->iTaskErrno;\r
3078         }\r
3079         #endif\r
3080 \r
3081         #if ( configUSE_NEWLIB_REENTRANT == 1 )\r
3082         {\r
3083             /* Switch Newlib's _impure_ptr variable to point to the _reent\r
3084              * structure specific to this task.\r
3085              * See the third party link http://www.nadler.com/embedded/newlibAndFreeRTOS.html\r
3086              * for additional information. */\r
3087             _impure_ptr = &( pxCurrentTCB->xNewLib_reent );\r
3088         }\r
3089         #endif /* configUSE_NEWLIB_REENTRANT */\r
3090     }\r
3091 }\r
3092 /*-----------------------------------------------------------*/\r
3093 \r
3094 void vTaskPlaceOnEventList( List_t * const pxEventList,\r
3095                             const TickType_t xTicksToWait )\r
3096 {\r
3097     configASSERT( pxEventList );\r
3098 \r
3099     /* THIS FUNCTION MUST BE CALLED WITH EITHER INTERRUPTS DISABLED OR THE\r
3100      * SCHEDULER SUSPENDED AND THE QUEUE BEING ACCESSED LOCKED. */\r
3101 \r
3102     /* Place the event list item of the TCB in the appropriate event list.\r
3103      * This is placed in the list in priority order so the highest priority task\r
3104      * is the first to be woken by the event.\r
3105      *\r
3106      * Note: Lists are sorted in ascending order by ListItem_t.xItemValue.\r
3107      * Normally, the xItemValue of a TCB's ListItem_t members is:\r
3108      *      xItemValue = ( configMAX_PRIORITIES - uxPriority )\r
3109      * Therefore, the event list is sorted in descending priority order.\r
3110      *\r
3111      * The queue that contains the event list is locked, preventing\r
3112      * simultaneous access from interrupts. */\r
3113     vListInsert( pxEventList, &( pxCurrentTCB->xEventListItem ) );\r
3114 \r
3115     prvAddCurrentTaskToDelayedList( xTicksToWait, pdTRUE );\r
3116 }\r
3117 /*-----------------------------------------------------------*/\r
3118 \r
3119 void vTaskPlaceOnUnorderedEventList( List_t * pxEventList,\r
3120                                      const TickType_t xItemValue,\r
3121                                      const TickType_t xTicksToWait )\r
3122 {\r
3123     configASSERT( pxEventList );\r
3124 \r
3125     /* THIS FUNCTION MUST BE CALLED WITH THE SCHEDULER SUSPENDED.  It is used by\r
3126      * the event groups implementation. */\r
3127     configASSERT( uxSchedulerSuspended != 0 );\r
3128 \r
3129     /* Store the item value in the event list item.  It is safe to access the\r
3130      * event list item here as interrupts won't access the event list item of a\r
3131      * task that is not in the Blocked state. */\r
3132     listSET_LIST_ITEM_VALUE( &( pxCurrentTCB->xEventListItem ), xItemValue | taskEVENT_LIST_ITEM_VALUE_IN_USE );\r
3133 \r
3134     /* Place the event list item of the TCB at the end of the appropriate event\r
3135      * list.  It is safe to access the event list here because it is part of an\r
3136      * event group implementation - and interrupts don't access event groups\r
3137      * directly (instead they access them indirectly by pending function calls to\r
3138      * the task level). */\r
3139     listINSERT_END( pxEventList, &( pxCurrentTCB->xEventListItem ) );\r
3140 \r
3141     prvAddCurrentTaskToDelayedList( xTicksToWait, pdTRUE );\r
3142 }\r
3143 /*-----------------------------------------------------------*/\r
3144 \r
3145 #if ( configUSE_TIMERS == 1 )\r
3146 \r
3147     void vTaskPlaceOnEventListRestricted( List_t * const pxEventList,\r
3148                                           TickType_t xTicksToWait,\r
3149                                           const BaseType_t xWaitIndefinitely )\r
3150     {\r
3151         configASSERT( pxEventList );\r
3152 \r
3153         /* This function should not be called by application code hence the\r
3154          * 'Restricted' in its name.  It is not part of the public API.  It is\r
3155          * designed for use by kernel code, and has special calling requirements -\r
3156          * it should be called with the scheduler suspended. */\r
3157 \r
3158 \r
3159         /* Place the event list item of the TCB in the appropriate event list.\r
3160          * In this case it is assume that this is the only task that is going to\r
3161          * be waiting on this event list, so the faster vListInsertEnd() function\r
3162          * can be used in place of vListInsert. */\r
3163         listINSERT_END( pxEventList, &( pxCurrentTCB->xEventListItem ) );\r
3164 \r
3165         /* If the task should block indefinitely then set the block time to a\r
3166          * value that will be recognised as an indefinite delay inside the\r
3167          * prvAddCurrentTaskToDelayedList() function. */\r
3168         if( xWaitIndefinitely != pdFALSE )\r
3169         {\r
3170             xTicksToWait = portMAX_DELAY;\r
3171         }\r
3172 \r
3173         traceTASK_DELAY_UNTIL( ( xTickCount + xTicksToWait ) );\r
3174         prvAddCurrentTaskToDelayedList( xTicksToWait, xWaitIndefinitely );\r
3175     }\r
3176 \r
3177 #endif /* configUSE_TIMERS */\r
3178 /*-----------------------------------------------------------*/\r
3179 \r
3180 BaseType_t xTaskRemoveFromEventList( const List_t * const pxEventList )\r
3181 {\r
3182     TCB_t * pxUnblockedTCB;\r
3183     BaseType_t xReturn;\r
3184 \r
3185     /* THIS FUNCTION MUST BE CALLED FROM A CRITICAL SECTION.  It can also be\r
3186      * called from a critical section within an ISR. */\r
3187 \r
3188     /* The event list is sorted in priority order, so the first in the list can\r
3189      * be removed as it is known to be the highest priority.  Remove the TCB from\r
3190      * the delayed list, and add it to the ready list.\r
3191      *\r
3192      * If an event is for a queue that is locked then this function will never\r
3193      * get called - the lock count on the queue will get modified instead.  This\r
3194      * means exclusive access to the event list is guaranteed here.\r
3195      *\r
3196      * This function assumes that a check has already been made to ensure that\r
3197      * pxEventList is not empty. */\r
3198     pxUnblockedTCB = listGET_OWNER_OF_HEAD_ENTRY( pxEventList ); /*lint !e9079 void * is used as this macro is used with timers and co-routines too.  Alignment is known to be fine as the type of the pointer stored and retrieved is the same. */\r
3199     configASSERT( pxUnblockedTCB );\r
3200     listREMOVE_ITEM( &( pxUnblockedTCB->xEventListItem ) );\r
3201 \r
3202     if( uxSchedulerSuspended == ( UBaseType_t ) pdFALSE )\r
3203     {\r
3204         listREMOVE_ITEM( &( pxUnblockedTCB->xStateListItem ) );\r
3205         prvAddTaskToReadyList( pxUnblockedTCB );\r
3206 \r
3207         #if ( configUSE_TICKLESS_IDLE != 0 )\r
3208         {\r
3209             /* If a task is blocked on a kernel object then xNextTaskUnblockTime\r
3210              * might be set to the blocked task's time out time.  If the task is\r
3211              * unblocked for a reason other than a timeout xNextTaskUnblockTime is\r
3212              * normally left unchanged, because it is automatically reset to a new\r
3213              * value when the tick count equals xNextTaskUnblockTime.  However if\r
3214              * tickless idling is used it might be more important to enter sleep mode\r
3215              * at the earliest possible time - so reset xNextTaskUnblockTime here to\r
3216              * ensure it is updated at the earliest possible time. */\r
3217             prvResetNextTaskUnblockTime();\r
3218         }\r
3219         #endif\r
3220     }\r
3221     else\r
3222     {\r
3223         /* The delayed and ready lists cannot be accessed, so hold this task\r
3224          * pending until the scheduler is resumed. */\r
3225         listINSERT_END( &( xPendingReadyList ), &( pxUnblockedTCB->xEventListItem ) );\r
3226     }\r
3227 \r
3228     if( pxUnblockedTCB->uxPriority > pxCurrentTCB->uxPriority )\r
3229     {\r
3230         /* Return true if the task removed from the event list has a higher\r
3231          * priority than the calling task.  This allows the calling task to know if\r
3232          * it should force a context switch now. */\r
3233         xReturn = pdTRUE;\r
3234 \r
3235         /* Mark that a yield is pending in case the user is not using the\r
3236          * "xHigherPriorityTaskWoken" parameter to an ISR safe FreeRTOS function. */\r
3237         xYieldPending = pdTRUE;\r
3238     }\r
3239     else\r
3240     {\r
3241         xReturn = pdFALSE;\r
3242     }\r
3243 \r
3244     return xReturn;\r
3245 }\r
3246 /*-----------------------------------------------------------*/\r
3247 \r
3248 void vTaskRemoveFromUnorderedEventList( ListItem_t * pxEventListItem,\r
3249                                         const TickType_t xItemValue )\r
3250 {\r
3251     TCB_t * pxUnblockedTCB;\r
3252 \r
3253     /* THIS FUNCTION MUST BE CALLED WITH THE SCHEDULER SUSPENDED.  It is used by\r
3254      * the event flags implementation. */\r
3255     configASSERT( uxSchedulerSuspended != pdFALSE );\r
3256 \r
3257     /* Store the new item value in the event list. */\r
3258     listSET_LIST_ITEM_VALUE( pxEventListItem, xItemValue | taskEVENT_LIST_ITEM_VALUE_IN_USE );\r
3259 \r
3260     /* Remove the event list form the event flag.  Interrupts do not access\r
3261      * event flags. */\r
3262     pxUnblockedTCB = listGET_LIST_ITEM_OWNER( pxEventListItem ); /*lint !e9079 void * is used as this macro is used with timers and co-routines too.  Alignment is known to be fine as the type of the pointer stored and retrieved is the same. */\r
3263     configASSERT( pxUnblockedTCB );\r
3264     listREMOVE_ITEM( pxEventListItem );\r
3265 \r
3266     #if ( configUSE_TICKLESS_IDLE != 0 )\r
3267     {\r
3268         /* If a task is blocked on a kernel object then xNextTaskUnblockTime\r
3269          * might be set to the blocked task's time out time.  If the task is\r
3270          * unblocked for a reason other than a timeout xNextTaskUnblockTime is\r
3271          * normally left unchanged, because it is automatically reset to a new\r
3272          * value when the tick count equals xNextTaskUnblockTime.  However if\r
3273          * tickless idling is used it might be more important to enter sleep mode\r
3274          * at the earliest possible time - so reset xNextTaskUnblockTime here to\r
3275          * ensure it is updated at the earliest possible time. */\r
3276         prvResetNextTaskUnblockTime();\r
3277     }\r
3278     #endif\r
3279 \r
3280     /* Remove the task from the delayed list and add it to the ready list.  The\r
3281      * scheduler is suspended so interrupts will not be accessing the ready\r
3282      * lists. */\r
3283     listREMOVE_ITEM( &( pxUnblockedTCB->xStateListItem ) );\r
3284     prvAddTaskToReadyList( pxUnblockedTCB );\r
3285 \r
3286     if( pxUnblockedTCB->uxPriority > pxCurrentTCB->uxPriority )\r
3287     {\r
3288         /* The unblocked task has a priority above that of the calling task, so\r
3289          * a context switch is required.  This function is called with the\r
3290          * scheduler suspended so xYieldPending is set so the context switch\r
3291          * occurs immediately that the scheduler is resumed (unsuspended). */\r
3292         xYieldPending = pdTRUE;\r
3293     }\r
3294 }\r
3295 /*-----------------------------------------------------------*/\r
3296 \r
3297 void vTaskSetTimeOutState( TimeOut_t * const pxTimeOut )\r
3298 {\r
3299     configASSERT( pxTimeOut );\r
3300     taskENTER_CRITICAL();\r
3301     {\r
3302         pxTimeOut->xOverflowCount = xNumOfOverflows;\r
3303         pxTimeOut->xTimeOnEntering = xTickCount;\r
3304     }\r
3305     taskEXIT_CRITICAL();\r
3306 }\r
3307 /*-----------------------------------------------------------*/\r
3308 \r
3309 void vTaskInternalSetTimeOutState( TimeOut_t * const pxTimeOut )\r
3310 {\r
3311     /* For internal use only as it does not use a critical section. */\r
3312     pxTimeOut->xOverflowCount = xNumOfOverflows;\r
3313     pxTimeOut->xTimeOnEntering = xTickCount;\r
3314 }\r
3315 /*-----------------------------------------------------------*/\r
3316 \r
3317 BaseType_t xTaskCheckForTimeOut( TimeOut_t * const pxTimeOut,\r
3318                                  TickType_t * const pxTicksToWait )\r
3319 {\r
3320     BaseType_t xReturn;\r
3321 \r
3322     configASSERT( pxTimeOut );\r
3323     configASSERT( pxTicksToWait );\r
3324 \r
3325     taskENTER_CRITICAL();\r
3326     {\r
3327         /* Minor optimisation.  The tick count cannot change in this block. */\r
3328         const TickType_t xConstTickCount = xTickCount;\r
3329         const TickType_t xElapsedTime = xConstTickCount - pxTimeOut->xTimeOnEntering;\r
3330 \r
3331         #if ( INCLUDE_xTaskAbortDelay == 1 )\r
3332             if( pxCurrentTCB->ucDelayAborted != ( uint8_t ) pdFALSE )\r
3333             {\r
3334                 /* The delay was aborted, which is not the same as a time out,\r
3335                  * but has the same result. */\r
3336                 pxCurrentTCB->ucDelayAborted = pdFALSE;\r
3337                 xReturn = pdTRUE;\r
3338             }\r
3339             else\r
3340         #endif\r
3341 \r
3342         #if ( INCLUDE_vTaskSuspend == 1 )\r
3343             if( *pxTicksToWait == portMAX_DELAY )\r
3344             {\r
3345                 /* If INCLUDE_vTaskSuspend is set to 1 and the block time\r
3346                  * specified is the maximum block time then the task should block\r
3347                  * indefinitely, and therefore never time out. */\r
3348                 xReturn = pdFALSE;\r
3349             }\r
3350             else\r
3351         #endif\r
3352 \r
3353         if( ( xNumOfOverflows != pxTimeOut->xOverflowCount ) && ( xConstTickCount >= pxTimeOut->xTimeOnEntering ) ) /*lint !e525 Indentation preferred as is to make code within pre-processor directives clearer. */\r
3354         {\r
3355             /* The tick count is greater than the time at which\r
3356              * vTaskSetTimeout() was called, but has also overflowed since\r
3357              * vTaskSetTimeOut() was called.  It must have wrapped all the way\r
3358              * around and gone past again. This passed since vTaskSetTimeout()\r
3359              * was called. */\r
3360             xReturn = pdTRUE;\r
3361             *pxTicksToWait = ( TickType_t ) 0;\r
3362         }\r
3363         else if( xElapsedTime < *pxTicksToWait ) /*lint !e961 Explicit casting is only redundant with some compilers, whereas others require it to prevent integer conversion errors. */\r
3364         {\r
3365             /* Not a genuine timeout. Adjust parameters for time remaining. */\r
3366             *pxTicksToWait -= xElapsedTime;\r
3367             vTaskInternalSetTimeOutState( pxTimeOut );\r
3368             xReturn = pdFALSE;\r
3369         }\r
3370         else\r
3371         {\r
3372             *pxTicksToWait = ( TickType_t ) 0;\r
3373             xReturn = pdTRUE;\r
3374         }\r
3375     }\r
3376     taskEXIT_CRITICAL();\r
3377 \r
3378     return xReturn;\r
3379 }\r
3380 /*-----------------------------------------------------------*/\r
3381 \r
3382 void vTaskMissedYield( void )\r
3383 {\r
3384     xYieldPending = pdTRUE;\r
3385 }\r
3386 /*-----------------------------------------------------------*/\r
3387 \r
3388 #if ( configUSE_TRACE_FACILITY == 1 )\r
3389 \r
3390     UBaseType_t uxTaskGetTaskNumber( TaskHandle_t xTask )\r
3391     {\r
3392         UBaseType_t uxReturn;\r
3393         TCB_t const * pxTCB;\r
3394 \r
3395         if( xTask != NULL )\r
3396         {\r
3397             pxTCB = xTask;\r
3398             uxReturn = pxTCB->uxTaskNumber;\r
3399         }\r
3400         else\r
3401         {\r
3402             uxReturn = 0U;\r
3403         }\r
3404 \r
3405         return uxReturn;\r
3406     }\r
3407 \r
3408 #endif /* configUSE_TRACE_FACILITY */\r
3409 /*-----------------------------------------------------------*/\r
3410 \r
3411 #if ( configUSE_TRACE_FACILITY == 1 )\r
3412 \r
3413     void vTaskSetTaskNumber( TaskHandle_t xTask,\r
3414                              const UBaseType_t uxHandle )\r
3415     {\r
3416         TCB_t * pxTCB;\r
3417 \r
3418         if( xTask != NULL )\r
3419         {\r
3420             pxTCB = xTask;\r
3421             pxTCB->uxTaskNumber = uxHandle;\r
3422         }\r
3423     }\r
3424 \r
3425 #endif /* configUSE_TRACE_FACILITY */\r
3426 \r
3427 /*\r
3428  * -----------------------------------------------------------\r
3429  * The Idle task.\r
3430  * ----------------------------------------------------------\r
3431  *\r
3432  * The portTASK_FUNCTION() macro is used to allow port/compiler specific\r
3433  * language extensions.  The equivalent prototype for this function is:\r
3434  *\r
3435  * void prvIdleTask( void *pvParameters );\r
3436  *\r
3437  */\r
3438 static portTASK_FUNCTION( prvIdleTask, pvParameters )\r
3439 {\r
3440     /* Stop warnings. */\r
3441     ( void ) pvParameters;\r
3442 \r
3443     /** THIS IS THE RTOS IDLE TASK - WHICH IS CREATED AUTOMATICALLY WHEN THE\r
3444      * SCHEDULER IS STARTED. **/\r
3445 \r
3446     /* In case a task that has a secure context deletes itself, in which case\r
3447      * the idle task is responsible for deleting the task's secure context, if\r
3448      * any. */\r
3449     portALLOCATE_SECURE_CONTEXT( configMINIMAL_SECURE_STACK_SIZE );\r
3450 \r
3451     for( ; ; )\r
3452     {\r
3453         /* See if any tasks have deleted themselves - if so then the idle task\r
3454          * is responsible for freeing the deleted task's TCB and stack. */\r
3455         prvCheckTasksWaitingTermination();\r
3456 \r
3457         #if ( configUSE_PREEMPTION == 0 )\r
3458         {\r
3459             /* If we are not using preemption we keep forcing a task switch to\r
3460              * see if any other task has become available.  If we are using\r
3461              * preemption we don't need to do this as any task becoming available\r
3462              * will automatically get the processor anyway. */\r
3463             taskYIELD();\r
3464         }\r
3465         #endif /* configUSE_PREEMPTION */\r
3466 \r
3467         #if ( ( configUSE_PREEMPTION == 1 ) && ( configIDLE_SHOULD_YIELD == 1 ) )\r
3468         {\r
3469             /* When using preemption tasks of equal priority will be\r
3470              * timesliced.  If a task that is sharing the idle priority is ready\r
3471              * to run then the idle task should yield before the end of the\r
3472              * timeslice.\r
3473              *\r
3474              * A critical region is not required here as we are just reading from\r
3475              * the list, and an occasional incorrect value will not matter.  If\r
3476              * the ready list at the idle priority contains more than one task\r
3477              * then a task other than the idle task is ready to execute. */\r
3478             if( listCURRENT_LIST_LENGTH( &( pxReadyTasksLists[ tskIDLE_PRIORITY ] ) ) > ( UBaseType_t ) 1 )\r
3479             {\r
3480                 taskYIELD();\r
3481             }\r
3482             else\r
3483             {\r
3484                 mtCOVERAGE_TEST_MARKER();\r
3485             }\r
3486         }\r
3487         #endif /* ( ( configUSE_PREEMPTION == 1 ) && ( configIDLE_SHOULD_YIELD == 1 ) ) */\r
3488 \r
3489         #if ( configUSE_IDLE_HOOK == 1 )\r
3490         {\r
3491             extern void vApplicationIdleHook( void );\r
3492 \r
3493             /* Call the user defined function from within the idle task.  This\r
3494              * allows the application designer to add background functionality\r
3495              * without the overhead of a separate task.\r
3496              * NOTE: vApplicationIdleHook() MUST NOT, UNDER ANY CIRCUMSTANCES,\r
3497              * CALL A FUNCTION THAT MIGHT BLOCK. */\r
3498             vApplicationIdleHook();\r
3499         }\r
3500         #endif /* configUSE_IDLE_HOOK */\r
3501 \r
3502         /* This conditional compilation should use inequality to 0, not equality\r
3503          * to 1.  This is to ensure portSUPPRESS_TICKS_AND_SLEEP() is called when\r
3504          * user defined low power mode  implementations require\r
3505          * configUSE_TICKLESS_IDLE to be set to a value other than 1. */\r
3506         #if ( configUSE_TICKLESS_IDLE != 0 )\r
3507         {\r
3508             TickType_t xExpectedIdleTime;\r
3509 \r
3510             /* It is not desirable to suspend then resume the scheduler on\r
3511              * each iteration of the idle task.  Therefore, a preliminary\r
3512              * test of the expected idle time is performed without the\r
3513              * scheduler suspended.  The result here is not necessarily\r
3514              * valid. */\r
3515             xExpectedIdleTime = prvGetExpectedIdleTime();\r
3516 \r
3517             if( xExpectedIdleTime >= configEXPECTED_IDLE_TIME_BEFORE_SLEEP )\r
3518             {\r
3519                 vTaskSuspendAll();\r
3520                 {\r
3521                     /* Now the scheduler is suspended, the expected idle\r
3522                      * time can be sampled again, and this time its value can\r
3523                      * be used. */\r
3524                     configASSERT( xNextTaskUnblockTime >= xTickCount );\r
3525                     xExpectedIdleTime = prvGetExpectedIdleTime();\r
3526 \r
3527                     /* Define the following macro to set xExpectedIdleTime to 0\r
3528                      * if the application does not want\r
3529                      * portSUPPRESS_TICKS_AND_SLEEP() to be called. */\r
3530                     configPRE_SUPPRESS_TICKS_AND_SLEEP_PROCESSING( xExpectedIdleTime );\r
3531 \r
3532                     if( xExpectedIdleTime >= configEXPECTED_IDLE_TIME_BEFORE_SLEEP )\r
3533                     {\r
3534                         traceLOW_POWER_IDLE_BEGIN();\r
3535                         portSUPPRESS_TICKS_AND_SLEEP( xExpectedIdleTime );\r
3536                         traceLOW_POWER_IDLE_END();\r
3537                     }\r
3538                     else\r
3539                     {\r
3540                         mtCOVERAGE_TEST_MARKER();\r
3541                     }\r
3542                 }\r
3543                 ( void ) xTaskResumeAll();\r
3544             }\r
3545             else\r
3546             {\r
3547                 mtCOVERAGE_TEST_MARKER();\r
3548             }\r
3549         }\r
3550         #endif /* configUSE_TICKLESS_IDLE */\r
3551     }\r
3552 }\r
3553 /*-----------------------------------------------------------*/\r
3554 \r
3555 #if ( configUSE_TICKLESS_IDLE != 0 )\r
3556 \r
3557     eSleepModeStatus eTaskConfirmSleepModeStatus( void )\r
3558     {\r
3559         #if ( INCLUDE_vTaskSuspend == 1 )\r
3560             /* The idle task exists in addition to the application tasks. */\r
3561             const UBaseType_t uxNonApplicationTasks = 1;\r
3562         #endif /* INCLUDE_vTaskSuspend */\r
3563 \r
3564         eSleepModeStatus eReturn = eStandardSleep;\r
3565 \r
3566         /* This function must be called from a critical section. */\r
3567 \r
3568         if( listCURRENT_LIST_LENGTH( &xPendingReadyList ) != 0 )\r
3569         {\r
3570             /* A task was made ready while the scheduler was suspended. */\r
3571             eReturn = eAbortSleep;\r
3572         }\r
3573         else if( xYieldPending != pdFALSE )\r
3574         {\r
3575             /* A yield was pended while the scheduler was suspended. */\r
3576             eReturn = eAbortSleep;\r
3577         }\r
3578         else if( xPendedTicks != 0 )\r
3579         {\r
3580             /* A tick interrupt has already occurred but was held pending\r
3581              * because the scheduler is suspended. */\r
3582             eReturn = eAbortSleep;\r
3583         }\r
3584 \r
3585         #if ( INCLUDE_vTaskSuspend == 1 )\r
3586             else if( listCURRENT_LIST_LENGTH( &xSuspendedTaskList ) == ( uxCurrentNumberOfTasks - uxNonApplicationTasks ) )\r
3587             {\r
3588                 /* If all the tasks are in the suspended list (which might mean they\r
3589                  * have an infinite block time rather than actually being suspended)\r
3590                  * then it is safe to turn all clocks off and just wait for external\r
3591                  * interrupts. */\r
3592                 eReturn = eNoTasksWaitingTimeout;\r
3593             }\r
3594         #endif /* INCLUDE_vTaskSuspend */\r
3595         else\r
3596         {\r
3597             mtCOVERAGE_TEST_MARKER();\r
3598         }\r
3599 \r
3600         return eReturn;\r
3601     }\r
3602 \r
3603 #endif /* configUSE_TICKLESS_IDLE */\r
3604 /*-----------------------------------------------------------*/\r
3605 \r
3606 #if ( configNUM_THREAD_LOCAL_STORAGE_POINTERS != 0 )\r
3607 \r
3608     void vTaskSetThreadLocalStoragePointer( TaskHandle_t xTaskToSet,\r
3609                                             BaseType_t xIndex,\r
3610                                             void * pvValue )\r
3611     {\r
3612         TCB_t * pxTCB;\r
3613 \r
3614         if( xIndex < configNUM_THREAD_LOCAL_STORAGE_POINTERS )\r
3615         {\r
3616             pxTCB = prvGetTCBFromHandle( xTaskToSet );\r
3617             configASSERT( pxTCB != NULL );\r
3618             pxTCB->pvThreadLocalStoragePointers[ xIndex ] = pvValue;\r
3619         }\r
3620     }\r
3621 \r
3622 #endif /* configNUM_THREAD_LOCAL_STORAGE_POINTERS */\r
3623 /*-----------------------------------------------------------*/\r
3624 \r
3625 #if ( configNUM_THREAD_LOCAL_STORAGE_POINTERS != 0 )\r
3626 \r
3627     void * pvTaskGetThreadLocalStoragePointer( TaskHandle_t xTaskToQuery,\r
3628                                                BaseType_t xIndex )\r
3629     {\r
3630         void * pvReturn = NULL;\r
3631         TCB_t * pxTCB;\r
3632 \r
3633         if( xIndex < configNUM_THREAD_LOCAL_STORAGE_POINTERS )\r
3634         {\r
3635             pxTCB = prvGetTCBFromHandle( xTaskToQuery );\r
3636             pvReturn = pxTCB->pvThreadLocalStoragePointers[ xIndex ];\r
3637         }\r
3638         else\r
3639         {\r
3640             pvReturn = NULL;\r
3641         }\r
3642 \r
3643         return pvReturn;\r
3644     }\r
3645 \r
3646 #endif /* configNUM_THREAD_LOCAL_STORAGE_POINTERS */\r
3647 /*-----------------------------------------------------------*/\r
3648 \r
3649 #if ( portUSING_MPU_WRAPPERS == 1 )\r
3650 \r
3651     void vTaskAllocateMPURegions( TaskHandle_t xTaskToModify,\r
3652                                   const MemoryRegion_t * const xRegions )\r
3653     {\r
3654         TCB_t * pxTCB;\r
3655 \r
3656         /* If null is passed in here then we are modifying the MPU settings of\r
3657          * the calling task. */\r
3658         pxTCB = prvGetTCBFromHandle( xTaskToModify );\r
3659 \r
3660         vPortStoreTaskMPUSettings( &( pxTCB->xMPUSettings ), xRegions, NULL, 0 );\r
3661     }\r
3662 \r
3663 #endif /* portUSING_MPU_WRAPPERS */\r
3664 /*-----------------------------------------------------------*/\r
3665 \r
3666 static void prvInitialiseTaskLists( void )\r
3667 {\r
3668     UBaseType_t uxPriority;\r
3669 \r
3670     for( uxPriority = ( UBaseType_t ) 0U; uxPriority < ( UBaseType_t ) configMAX_PRIORITIES; uxPriority++ )\r
3671     {\r
3672         vListInitialise( &( pxReadyTasksLists[ uxPriority ] ) );\r
3673     }\r
3674 \r
3675     vListInitialise( &xDelayedTaskList1 );\r
3676     vListInitialise( &xDelayedTaskList2 );\r
3677     vListInitialise( &xPendingReadyList );\r
3678 \r
3679     #if ( INCLUDE_vTaskDelete == 1 )\r
3680     {\r
3681         vListInitialise( &xTasksWaitingTermination );\r
3682     }\r
3683     #endif /* INCLUDE_vTaskDelete */\r
3684 \r
3685     #if ( INCLUDE_vTaskSuspend == 1 )\r
3686     {\r
3687         vListInitialise( &xSuspendedTaskList );\r
3688     }\r
3689     #endif /* INCLUDE_vTaskSuspend */\r
3690 \r
3691     /* Start with pxDelayedTaskList using list1 and the pxOverflowDelayedTaskList\r
3692      * using list2. */\r
3693     pxDelayedTaskList = &xDelayedTaskList1;\r
3694     pxOverflowDelayedTaskList = &xDelayedTaskList2;\r
3695 }\r
3696 /*-----------------------------------------------------------*/\r
3697 \r
3698 static void prvCheckTasksWaitingTermination( void )\r
3699 {\r
3700     /** THIS FUNCTION IS CALLED FROM THE RTOS IDLE TASK **/\r
3701 \r
3702     #if ( INCLUDE_vTaskDelete == 1 )\r
3703     {\r
3704         TCB_t * pxTCB;\r
3705 \r
3706         /* uxDeletedTasksWaitingCleanUp is used to prevent taskENTER_CRITICAL()\r
3707          * being called too often in the idle task. */\r
3708         while( uxDeletedTasksWaitingCleanUp > ( UBaseType_t ) 0U )\r
3709         {\r
3710             taskENTER_CRITICAL();\r
3711             {\r
3712                 pxTCB = listGET_OWNER_OF_HEAD_ENTRY( ( &xTasksWaitingTermination ) ); /*lint !e9079 void * is used as this macro is used with timers and co-routines too.  Alignment is known to be fine as the type of the pointer stored and retrieved is the same. */\r
3713                 ( void ) uxListRemove( &( pxTCB->xStateListItem ) );\r
3714                 --uxCurrentNumberOfTasks;\r
3715                 --uxDeletedTasksWaitingCleanUp;\r
3716             }\r
3717             taskEXIT_CRITICAL();\r
3718 \r
3719             prvDeleteTCB( pxTCB );\r
3720         }\r
3721     }\r
3722     #endif /* INCLUDE_vTaskDelete */\r
3723 }\r
3724 /*-----------------------------------------------------------*/\r
3725 \r
3726 #if ( configUSE_TRACE_FACILITY == 1 )\r
3727 \r
3728     void vTaskGetInfo( TaskHandle_t xTask,\r
3729                        TaskStatus_t * pxTaskStatus,\r
3730                        BaseType_t xGetFreeStackSpace,\r
3731                        eTaskState eState )\r
3732     {\r
3733         TCB_t * pxTCB;\r
3734 \r
3735         /* xTask is NULL then get the state of the calling task. */\r
3736         pxTCB = prvGetTCBFromHandle( xTask );\r
3737 \r
3738         pxTaskStatus->xHandle = ( TaskHandle_t ) pxTCB;\r
3739         pxTaskStatus->pcTaskName = ( const char * ) &( pxTCB->pcTaskName[ 0 ] );\r
3740         pxTaskStatus->uxCurrentPriority = pxTCB->uxPriority;\r
3741         pxTaskStatus->pxStackBase = pxTCB->pxStack;\r
3742         #if ( ( portSTACK_GROWTH > 0 ) && ( configRECORD_STACK_HIGH_ADDRESS == 1 ) )\r
3743             pxTaskStatus->pxTopOfStack = pxTCB->pxTopOfStack;\r
3744             pxTaskStatus->pxEndOfStack = pxTCB->pxEndOfStack;\r
3745         #endif\r
3746         pxTaskStatus->xTaskNumber = pxTCB->uxTCBNumber;\r
3747 \r
3748         #if ( configUSE_MUTEXES == 1 )\r
3749         {\r
3750             pxTaskStatus->uxBasePriority = pxTCB->uxBasePriority;\r
3751         }\r
3752         #else\r
3753         {\r
3754             pxTaskStatus->uxBasePriority = 0;\r
3755         }\r
3756         #endif\r
3757 \r
3758         #if ( configGENERATE_RUN_TIME_STATS == 1 )\r
3759         {\r
3760             pxTaskStatus->ulRunTimeCounter = pxTCB->ulRunTimeCounter;\r
3761         }\r
3762         #else\r
3763         {\r
3764             pxTaskStatus->ulRunTimeCounter = ( configRUN_TIME_COUNTER_TYPE ) 0;\r
3765         }\r
3766         #endif\r
3767 \r
3768         /* Obtaining the task state is a little fiddly, so is only done if the\r
3769          * value of eState passed into this function is eInvalid - otherwise the\r
3770          * state is just set to whatever is passed in. */\r
3771         if( eState != eInvalid )\r
3772         {\r
3773             if( pxTCB == pxCurrentTCB )\r
3774             {\r
3775                 pxTaskStatus->eCurrentState = eRunning;\r
3776             }\r
3777             else\r
3778             {\r
3779                 pxTaskStatus->eCurrentState = eState;\r
3780 \r
3781                 #if ( INCLUDE_vTaskSuspend == 1 )\r
3782                 {\r
3783                     /* If the task is in the suspended list then there is a\r
3784                      *  chance it is actually just blocked indefinitely - so really\r
3785                      *  it should be reported as being in the Blocked state. */\r
3786                     if( eState == eSuspended )\r
3787                     {\r
3788                         vTaskSuspendAll();\r
3789                         {\r
3790                             if( listLIST_ITEM_CONTAINER( &( pxTCB->xEventListItem ) ) != NULL )\r
3791                             {\r
3792                                 pxTaskStatus->eCurrentState = eBlocked;\r
3793                             }\r
3794                         }\r
3795                         ( void ) xTaskResumeAll();\r
3796                     }\r
3797                 }\r
3798                 #endif /* INCLUDE_vTaskSuspend */\r
3799             }\r
3800         }\r
3801         else\r
3802         {\r
3803             pxTaskStatus->eCurrentState = eTaskGetState( pxTCB );\r
3804         }\r
3805 \r
3806         /* Obtaining the stack space takes some time, so the xGetFreeStackSpace\r
3807          * parameter is provided to allow it to be skipped. */\r
3808         if( xGetFreeStackSpace != pdFALSE )\r
3809         {\r
3810             #if ( portSTACK_GROWTH > 0 )\r
3811             {\r
3812                 pxTaskStatus->usStackHighWaterMark = prvTaskCheckFreeStackSpace( ( uint8_t * ) pxTCB->pxEndOfStack );\r
3813             }\r
3814             #else\r
3815             {\r
3816                 pxTaskStatus->usStackHighWaterMark = prvTaskCheckFreeStackSpace( ( uint8_t * ) pxTCB->pxStack );\r
3817             }\r
3818             #endif\r
3819         }\r
3820         else\r
3821         {\r
3822             pxTaskStatus->usStackHighWaterMark = 0;\r
3823         }\r
3824     }\r
3825 \r
3826 #endif /* configUSE_TRACE_FACILITY */\r
3827 /*-----------------------------------------------------------*/\r
3828 \r
3829 #if ( configUSE_TRACE_FACILITY == 1 )\r
3830 \r
3831     static UBaseType_t prvListTasksWithinSingleList( TaskStatus_t * pxTaskStatusArray,\r
3832                                                      List_t * pxList,\r
3833                                                      eTaskState eState )\r
3834     {\r
3835         configLIST_VOLATILE TCB_t * pxNextTCB, * pxFirstTCB;\r
3836         UBaseType_t uxTask = 0;\r
3837 \r
3838         if( listCURRENT_LIST_LENGTH( pxList ) > ( UBaseType_t ) 0 )\r
3839         {\r
3840             listGET_OWNER_OF_NEXT_ENTRY( pxFirstTCB, pxList ); /*lint !e9079 void * is used as this macro is used with timers and co-routines too.  Alignment is known to be fine as the type of the pointer stored and retrieved is the same. */\r
3841 \r
3842             /* Populate an TaskStatus_t structure within the\r
3843              * pxTaskStatusArray array for each task that is referenced from\r
3844              * pxList.  See the definition of TaskStatus_t in task.h for the\r
3845              * meaning of each TaskStatus_t structure member. */\r
3846             do\r
3847             {\r
3848                 listGET_OWNER_OF_NEXT_ENTRY( pxNextTCB, pxList ); /*lint !e9079 void * is used as this macro is used with timers and co-routines too.  Alignment is known to be fine as the type of the pointer stored and retrieved is the same. */\r
3849                 vTaskGetInfo( ( TaskHandle_t ) pxNextTCB, &( pxTaskStatusArray[ uxTask ] ), pdTRUE, eState );\r
3850                 uxTask++;\r
3851             } while( pxNextTCB != pxFirstTCB );\r
3852         }\r
3853         else\r
3854         {\r
3855             mtCOVERAGE_TEST_MARKER();\r
3856         }\r
3857 \r
3858         return uxTask;\r
3859     }\r
3860 \r
3861 #endif /* configUSE_TRACE_FACILITY */\r
3862 /*-----------------------------------------------------------*/\r
3863 \r
3864 #if ( ( configUSE_TRACE_FACILITY == 1 ) || ( INCLUDE_uxTaskGetStackHighWaterMark == 1 ) || ( INCLUDE_uxTaskGetStackHighWaterMark2 == 1 ) )\r
3865 \r
3866     static configSTACK_DEPTH_TYPE prvTaskCheckFreeStackSpace( const uint8_t * pucStackByte )\r
3867     {\r
3868         uint32_t ulCount = 0U;\r
3869 \r
3870         while( *pucStackByte == ( uint8_t ) tskSTACK_FILL_BYTE )\r
3871         {\r
3872             pucStackByte -= portSTACK_GROWTH;\r
3873             ulCount++;\r
3874         }\r
3875 \r
3876         ulCount /= ( uint32_t ) sizeof( StackType_t ); /*lint !e961 Casting is not redundant on smaller architectures. */\r
3877 \r
3878         return ( configSTACK_DEPTH_TYPE ) ulCount;\r
3879     }\r
3880 \r
3881 #endif /* ( ( configUSE_TRACE_FACILITY == 1 ) || ( INCLUDE_uxTaskGetStackHighWaterMark == 1 ) || ( INCLUDE_uxTaskGetStackHighWaterMark2 == 1 ) ) */\r
3882 /*-----------------------------------------------------------*/\r
3883 \r
3884 #if ( INCLUDE_uxTaskGetStackHighWaterMark2 == 1 )\r
3885 \r
3886 /* uxTaskGetStackHighWaterMark() and uxTaskGetStackHighWaterMark2() are the\r
3887  * same except for their return type.  Using configSTACK_DEPTH_TYPE allows the\r
3888  * user to determine the return type.  It gets around the problem of the value\r
3889  * overflowing on 8-bit types without breaking backward compatibility for\r
3890  * applications that expect an 8-bit return type. */\r
3891     configSTACK_DEPTH_TYPE uxTaskGetStackHighWaterMark2( TaskHandle_t xTask )\r
3892     {\r
3893         TCB_t * pxTCB;\r
3894         uint8_t * pucEndOfStack;\r
3895         configSTACK_DEPTH_TYPE uxReturn;\r
3896 \r
3897         /* uxTaskGetStackHighWaterMark() and uxTaskGetStackHighWaterMark2() are\r
3898          * the same except for their return type.  Using configSTACK_DEPTH_TYPE\r
3899          * allows the user to determine the return type.  It gets around the\r
3900          * problem of the value overflowing on 8-bit types without breaking\r
3901          * backward compatibility for applications that expect an 8-bit return\r
3902          * type. */\r
3903 \r
3904         pxTCB = prvGetTCBFromHandle( xTask );\r
3905 \r
3906         #if portSTACK_GROWTH < 0\r
3907         {\r
3908             pucEndOfStack = ( uint8_t * ) pxTCB->pxStack;\r
3909         }\r
3910         #else\r
3911         {\r
3912             pucEndOfStack = ( uint8_t * ) pxTCB->pxEndOfStack;\r
3913         }\r
3914         #endif\r
3915 \r
3916         uxReturn = prvTaskCheckFreeStackSpace( pucEndOfStack );\r
3917 \r
3918         return uxReturn;\r
3919     }\r
3920 \r
3921 #endif /* INCLUDE_uxTaskGetStackHighWaterMark2 */\r
3922 /*-----------------------------------------------------------*/\r
3923 \r
3924 #if ( INCLUDE_uxTaskGetStackHighWaterMark == 1 )\r
3925 \r
3926     UBaseType_t uxTaskGetStackHighWaterMark( TaskHandle_t xTask )\r
3927     {\r
3928         TCB_t * pxTCB;\r
3929         uint8_t * pucEndOfStack;\r
3930         UBaseType_t uxReturn;\r
3931 \r
3932         pxTCB = prvGetTCBFromHandle( xTask );\r
3933 \r
3934         #if portSTACK_GROWTH < 0\r
3935         {\r
3936             pucEndOfStack = ( uint8_t * ) pxTCB->pxStack;\r
3937         }\r
3938         #else\r
3939         {\r
3940             pucEndOfStack = ( uint8_t * ) pxTCB->pxEndOfStack;\r
3941         }\r
3942         #endif\r
3943 \r
3944         uxReturn = ( UBaseType_t ) prvTaskCheckFreeStackSpace( pucEndOfStack );\r
3945 \r
3946         return uxReturn;\r
3947     }\r
3948 \r
3949 #endif /* INCLUDE_uxTaskGetStackHighWaterMark */\r
3950 /*-----------------------------------------------------------*/\r
3951 \r
3952 #if ( INCLUDE_vTaskDelete == 1 )\r
3953 \r
3954     static void prvDeleteTCB( TCB_t * pxTCB )\r
3955     {\r
3956         /* This call is required specifically for the TriCore port.  It must be\r
3957          * above the vPortFree() calls.  The call is also used by ports/demos that\r
3958          * want to allocate and clean RAM statically. */\r
3959         portCLEAN_UP_TCB( pxTCB );\r
3960 \r
3961         /* Free up the memory allocated by the scheduler for the task.  It is up\r
3962          * to the task to free any memory allocated at the application level.\r
3963          * See the third party link http://www.nadler.com/embedded/newlibAndFreeRTOS.html\r
3964          * for additional information. */\r
3965         #if ( configUSE_NEWLIB_REENTRANT == 1 )\r
3966         {\r
3967             _reclaim_reent( &( pxTCB->xNewLib_reent ) );\r
3968         }\r
3969         #endif /* configUSE_NEWLIB_REENTRANT */\r
3970 \r
3971         #if ( ( configSUPPORT_DYNAMIC_ALLOCATION == 1 ) && ( configSUPPORT_STATIC_ALLOCATION == 0 ) && ( portUSING_MPU_WRAPPERS == 0 ) )\r
3972         {\r
3973             /* The task can only have been allocated dynamically - free both\r
3974              * the stack and TCB. */\r
3975             vPortFreeStack( pxTCB->pxStack );\r
3976             vPortFree( pxTCB );\r
3977         }\r
3978         #elif ( tskSTATIC_AND_DYNAMIC_ALLOCATION_POSSIBLE != 0 ) /*lint !e731 !e9029 Macro has been consolidated for readability reasons. */\r
3979         {\r
3980             /* The task could have been allocated statically or dynamically, so\r
3981              * check what was statically allocated before trying to free the\r
3982              * memory. */\r
3983             if( pxTCB->ucStaticallyAllocated == tskDYNAMICALLY_ALLOCATED_STACK_AND_TCB )\r
3984             {\r
3985                 /* Both the stack and TCB were allocated dynamically, so both\r
3986                  * must be freed. */\r
3987                 vPortFreeStack( pxTCB->pxStack );\r
3988                 vPortFree( pxTCB );\r
3989             }\r
3990             else if( pxTCB->ucStaticallyAllocated == tskSTATICALLY_ALLOCATED_STACK_ONLY )\r
3991             {\r
3992                 /* Only the stack was statically allocated, so the TCB is the\r
3993                  * only memory that must be freed. */\r
3994                 vPortFree( pxTCB );\r
3995             }\r
3996             else\r
3997             {\r
3998                 /* Neither the stack nor the TCB were allocated dynamically, so\r
3999                  * nothing needs to be freed. */\r
4000                 configASSERT( pxTCB->ucStaticallyAllocated == tskSTATICALLY_ALLOCATED_STACK_AND_TCB );\r
4001                 mtCOVERAGE_TEST_MARKER();\r
4002             }\r
4003         }\r
4004         #endif /* configSUPPORT_DYNAMIC_ALLOCATION */\r
4005     }\r
4006 \r
4007 #endif /* INCLUDE_vTaskDelete */\r
4008 /*-----------------------------------------------------------*/\r
4009 \r
4010 static void prvResetNextTaskUnblockTime( void )\r
4011 {\r
4012     if( listLIST_IS_EMPTY( pxDelayedTaskList ) != pdFALSE )\r
4013     {\r
4014         /* The new current delayed list is empty.  Set xNextTaskUnblockTime to\r
4015          * the maximum possible value so it is  extremely unlikely that the\r
4016          * if( xTickCount >= xNextTaskUnblockTime ) test will pass until\r
4017          * there is an item in the delayed list. */\r
4018         xNextTaskUnblockTime = portMAX_DELAY;\r
4019     }\r
4020     else\r
4021     {\r
4022         /* The new current delayed list is not empty, get the value of\r
4023          * the item at the head of the delayed list.  This is the time at\r
4024          * which the task at the head of the delayed list should be removed\r
4025          * from the Blocked state. */\r
4026         xNextTaskUnblockTime = listGET_ITEM_VALUE_OF_HEAD_ENTRY( pxDelayedTaskList );\r
4027     }\r
4028 }\r
4029 /*-----------------------------------------------------------*/\r
4030 \r
4031 #if ( ( INCLUDE_xTaskGetCurrentTaskHandle == 1 ) || ( configUSE_MUTEXES == 1 ) )\r
4032 \r
4033     TaskHandle_t xTaskGetCurrentTaskHandle( void )\r
4034     {\r
4035         TaskHandle_t xReturn;\r
4036 \r
4037         /* A critical section is not required as this is not called from\r
4038          * an interrupt and the current TCB will always be the same for any\r
4039          * individual execution thread. */\r
4040         xReturn = pxCurrentTCB;\r
4041 \r
4042         return xReturn;\r
4043     }\r
4044 \r
4045 #endif /* ( ( INCLUDE_xTaskGetCurrentTaskHandle == 1 ) || ( configUSE_MUTEXES == 1 ) ) */\r
4046 /*-----------------------------------------------------------*/\r
4047 \r
4048 #if ( ( INCLUDE_xTaskGetSchedulerState == 1 ) || ( configUSE_TIMERS == 1 ) )\r
4049 \r
4050     BaseType_t xTaskGetSchedulerState( void )\r
4051     {\r
4052         BaseType_t xReturn;\r
4053 \r
4054         if( xSchedulerRunning == pdFALSE )\r
4055         {\r
4056             xReturn = taskSCHEDULER_NOT_STARTED;\r
4057         }\r
4058         else\r
4059         {\r
4060             if( uxSchedulerSuspended == ( UBaseType_t ) pdFALSE )\r
4061             {\r
4062                 xReturn = taskSCHEDULER_RUNNING;\r
4063             }\r
4064             else\r
4065             {\r
4066                 xReturn = taskSCHEDULER_SUSPENDED;\r
4067             }\r
4068         }\r
4069 \r
4070         return xReturn;\r
4071     }\r
4072 \r
4073 #endif /* ( ( INCLUDE_xTaskGetSchedulerState == 1 ) || ( configUSE_TIMERS == 1 ) ) */\r
4074 /*-----------------------------------------------------------*/\r
4075 \r
4076 #if ( configUSE_MUTEXES == 1 )\r
4077 \r
4078     BaseType_t xTaskPriorityInherit( TaskHandle_t const pxMutexHolder )\r
4079     {\r
4080         TCB_t * const pxMutexHolderTCB = pxMutexHolder;\r
4081         BaseType_t xReturn = pdFALSE;\r
4082 \r
4083         /* If the mutex was given back by an interrupt while the queue was\r
4084          * locked then the mutex holder might now be NULL.  _RB_ Is this still\r
4085          * needed as interrupts can no longer use mutexes? */\r
4086         if( pxMutexHolder != NULL )\r
4087         {\r
4088             /* If the holder of the mutex has a priority below the priority of\r
4089              * the task attempting to obtain the mutex then it will temporarily\r
4090              * inherit the priority of the task attempting to obtain the mutex. */\r
4091             if( pxMutexHolderTCB->uxPriority < pxCurrentTCB->uxPriority )\r
4092             {\r
4093                 /* Adjust the mutex holder state to account for its new\r
4094                  * priority.  Only reset the event list item value if the value is\r
4095                  * not being used for anything else. */\r
4096                 if( ( listGET_LIST_ITEM_VALUE( &( pxMutexHolderTCB->xEventListItem ) ) & taskEVENT_LIST_ITEM_VALUE_IN_USE ) == 0UL )\r
4097                 {\r
4098                     listSET_LIST_ITEM_VALUE( &( pxMutexHolderTCB->xEventListItem ), ( TickType_t ) configMAX_PRIORITIES - ( TickType_t ) pxCurrentTCB->uxPriority ); /*lint !e961 MISRA exception as the casts are only redundant for some ports. */\r
4099                 }\r
4100                 else\r
4101                 {\r
4102                     mtCOVERAGE_TEST_MARKER();\r
4103                 }\r
4104 \r
4105                 /* If the task being modified is in the ready state it will need\r
4106                  * to be moved into a new list. */\r
4107                 if( listIS_CONTAINED_WITHIN( &( pxReadyTasksLists[ pxMutexHolderTCB->uxPriority ] ), &( pxMutexHolderTCB->xStateListItem ) ) != pdFALSE )\r
4108                 {\r
4109                     if( uxListRemove( &( pxMutexHolderTCB->xStateListItem ) ) == ( UBaseType_t ) 0 )\r
4110                     {\r
4111                         /* It is known that the task is in its ready list so\r
4112                          * there is no need to check again and the port level\r
4113                          * reset macro can be called directly. */\r
4114                         portRESET_READY_PRIORITY( pxMutexHolderTCB->uxPriority, uxTopReadyPriority );\r
4115                     }\r
4116                     else\r
4117                     {\r
4118                         mtCOVERAGE_TEST_MARKER();\r
4119                     }\r
4120 \r
4121                     /* Inherit the priority before being moved into the new list. */\r
4122                     pxMutexHolderTCB->uxPriority = pxCurrentTCB->uxPriority;\r
4123                     prvAddTaskToReadyList( pxMutexHolderTCB );\r
4124                 }\r
4125                 else\r
4126                 {\r
4127                     /* Just inherit the priority. */\r
4128                     pxMutexHolderTCB->uxPriority = pxCurrentTCB->uxPriority;\r
4129                 }\r
4130 \r
4131                 traceTASK_PRIORITY_INHERIT( pxMutexHolderTCB, pxCurrentTCB->uxPriority );\r
4132 \r
4133                 /* Inheritance occurred. */\r
4134                 xReturn = pdTRUE;\r
4135             }\r
4136             else\r
4137             {\r
4138                 if( pxMutexHolderTCB->uxBasePriority < pxCurrentTCB->uxPriority )\r
4139                 {\r
4140                     /* The base priority of the mutex holder is lower than the\r
4141                      * priority of the task attempting to take the mutex, but the\r
4142                      * current priority of the mutex holder is not lower than the\r
4143                      * priority of the task attempting to take the mutex.\r
4144                      * Therefore the mutex holder must have already inherited a\r
4145                      * priority, but inheritance would have occurred if that had\r
4146                      * not been the case. */\r
4147                     xReturn = pdTRUE;\r
4148                 }\r
4149                 else\r
4150                 {\r
4151                     mtCOVERAGE_TEST_MARKER();\r
4152                 }\r
4153             }\r
4154         }\r
4155         else\r
4156         {\r
4157             mtCOVERAGE_TEST_MARKER();\r
4158         }\r
4159 \r
4160         return xReturn;\r
4161     }\r
4162 \r
4163 #endif /* configUSE_MUTEXES */\r
4164 /*-----------------------------------------------------------*/\r
4165 \r
4166 #if ( configUSE_MUTEXES == 1 )\r
4167 \r
4168     BaseType_t xTaskPriorityDisinherit( TaskHandle_t const pxMutexHolder )\r
4169     {\r
4170         TCB_t * const pxTCB = pxMutexHolder;\r
4171         BaseType_t xReturn = pdFALSE;\r
4172 \r
4173         if( pxMutexHolder != NULL )\r
4174         {\r
4175             /* A task can only have an inherited priority if it holds the mutex.\r
4176              * If the mutex is held by a task then it cannot be given from an\r
4177              * interrupt, and if a mutex is given by the holding task then it must\r
4178              * be the running state task. */\r
4179             configASSERT( pxTCB == pxCurrentTCB );\r
4180             configASSERT( pxTCB->uxMutexesHeld );\r
4181             ( pxTCB->uxMutexesHeld )--;\r
4182 \r
4183             /* Has the holder of the mutex inherited the priority of another\r
4184              * task? */\r
4185             if( pxTCB->uxPriority != pxTCB->uxBasePriority )\r
4186             {\r
4187                 /* Only disinherit if no other mutexes are held. */\r
4188                 if( pxTCB->uxMutexesHeld == ( UBaseType_t ) 0 )\r
4189                 {\r
4190                     /* A task can only have an inherited priority if it holds\r
4191                      * the mutex.  If the mutex is held by a task then it cannot be\r
4192                      * given from an interrupt, and if a mutex is given by the\r
4193                      * holding task then it must be the running state task.  Remove\r
4194                      * the holding task from the ready list. */\r
4195                     if( uxListRemove( &( pxTCB->xStateListItem ) ) == ( UBaseType_t ) 0 )\r
4196                     {\r
4197                         portRESET_READY_PRIORITY( pxTCB->uxPriority, uxTopReadyPriority );\r
4198                     }\r
4199                     else\r
4200                     {\r
4201                         mtCOVERAGE_TEST_MARKER();\r
4202                     }\r
4203 \r
4204                     /* Disinherit the priority before adding the task into the\r
4205                      * new  ready list. */\r
4206                     traceTASK_PRIORITY_DISINHERIT( pxTCB, pxTCB->uxBasePriority );\r
4207                     pxTCB->uxPriority = pxTCB->uxBasePriority;\r
4208 \r
4209                     /* Reset the event list item value.  It cannot be in use for\r
4210                      * any other purpose if this task is running, and it must be\r
4211                      * running to give back the mutex. */\r
4212                     listSET_LIST_ITEM_VALUE( &( pxTCB->xEventListItem ), ( TickType_t ) configMAX_PRIORITIES - ( TickType_t ) pxTCB->uxPriority ); /*lint !e961 MISRA exception as the casts are only redundant for some ports. */\r
4213                     prvAddTaskToReadyList( pxTCB );\r
4214 \r
4215                     /* Return true to indicate that a context switch is required.\r
4216                      * This is only actually required in the corner case whereby\r
4217                      * multiple mutexes were held and the mutexes were given back\r
4218                      * in an order different to that in which they were taken.\r
4219                      * If a context switch did not occur when the first mutex was\r
4220                      * returned, even if a task was waiting on it, then a context\r
4221                      * switch should occur when the last mutex is returned whether\r
4222                      * a task is waiting on it or not. */\r
4223                     xReturn = pdTRUE;\r
4224                 }\r
4225                 else\r
4226                 {\r
4227                     mtCOVERAGE_TEST_MARKER();\r
4228                 }\r
4229             }\r
4230             else\r
4231             {\r
4232                 mtCOVERAGE_TEST_MARKER();\r
4233             }\r
4234         }\r
4235         else\r
4236         {\r
4237             mtCOVERAGE_TEST_MARKER();\r
4238         }\r
4239 \r
4240         return xReturn;\r
4241     }\r
4242 \r
4243 #endif /* configUSE_MUTEXES */\r
4244 /*-----------------------------------------------------------*/\r
4245 \r
4246 #if ( configUSE_MUTEXES == 1 )\r
4247 \r
4248     void vTaskPriorityDisinheritAfterTimeout( TaskHandle_t const pxMutexHolder,\r
4249                                               UBaseType_t uxHighestPriorityWaitingTask )\r
4250     {\r
4251         TCB_t * const pxTCB = pxMutexHolder;\r
4252         UBaseType_t uxPriorityUsedOnEntry, uxPriorityToUse;\r
4253         const UBaseType_t uxOnlyOneMutexHeld = ( UBaseType_t ) 1;\r
4254 \r
4255         if( pxMutexHolder != NULL )\r
4256         {\r
4257             /* If pxMutexHolder is not NULL then the holder must hold at least\r
4258              * one mutex. */\r
4259             configASSERT( pxTCB->uxMutexesHeld );\r
4260 \r
4261             /* Determine the priority to which the priority of the task that\r
4262              * holds the mutex should be set.  This will be the greater of the\r
4263              * holding task's base priority and the priority of the highest\r
4264              * priority task that is waiting to obtain the mutex. */\r
4265             if( pxTCB->uxBasePriority < uxHighestPriorityWaitingTask )\r
4266             {\r
4267                 uxPriorityToUse = uxHighestPriorityWaitingTask;\r
4268             }\r
4269             else\r
4270             {\r
4271                 uxPriorityToUse = pxTCB->uxBasePriority;\r
4272             }\r
4273 \r
4274             /* Does the priority need to change? */\r
4275             if( pxTCB->uxPriority != uxPriorityToUse )\r
4276             {\r
4277                 /* Only disinherit if no other mutexes are held.  This is a\r
4278                  * simplification in the priority inheritance implementation.  If\r
4279                  * the task that holds the mutex is also holding other mutexes then\r
4280                  * the other mutexes may have caused the priority inheritance. */\r
4281                 if( pxTCB->uxMutexesHeld == uxOnlyOneMutexHeld )\r
4282                 {\r
4283                     /* If a task has timed out because it already holds the\r
4284                      * mutex it was trying to obtain then it cannot of inherited\r
4285                      * its own priority. */\r
4286                     configASSERT( pxTCB != pxCurrentTCB );\r
4287 \r
4288                     /* Disinherit the priority, remembering the previous\r
4289                      * priority to facilitate determining the subject task's\r
4290                      * state. */\r
4291                     traceTASK_PRIORITY_DISINHERIT( pxTCB, uxPriorityToUse );\r
4292                     uxPriorityUsedOnEntry = pxTCB->uxPriority;\r
4293                     pxTCB->uxPriority = uxPriorityToUse;\r
4294 \r
4295                     /* Only reset the event list item value if the value is not\r
4296                      * being used for anything else. */\r
4297                     if( ( listGET_LIST_ITEM_VALUE( &( pxTCB->xEventListItem ) ) & taskEVENT_LIST_ITEM_VALUE_IN_USE ) == 0UL )\r
4298                     {\r
4299                         listSET_LIST_ITEM_VALUE( &( pxTCB->xEventListItem ), ( TickType_t ) configMAX_PRIORITIES - ( TickType_t ) uxPriorityToUse ); /*lint !e961 MISRA exception as the casts are only redundant for some ports. */\r
4300                     }\r
4301                     else\r
4302                     {\r
4303                         mtCOVERAGE_TEST_MARKER();\r
4304                     }\r
4305 \r
4306                     /* If the running task is not the task that holds the mutex\r
4307                      * then the task that holds the mutex could be in either the\r
4308                      * Ready, Blocked or Suspended states.  Only remove the task\r
4309                      * from its current state list if it is in the Ready state as\r
4310                      * the task's priority is going to change and there is one\r
4311                      * Ready list per priority. */\r
4312                     if( listIS_CONTAINED_WITHIN( &( pxReadyTasksLists[ uxPriorityUsedOnEntry ] ), &( pxTCB->xStateListItem ) ) != pdFALSE )\r
4313                     {\r
4314                         if( uxListRemove( &( pxTCB->xStateListItem ) ) == ( UBaseType_t ) 0 )\r
4315                         {\r
4316                             /* It is known that the task is in its ready list so\r
4317                              * there is no need to check again and the port level\r
4318                              * reset macro can be called directly. */\r
4319                             portRESET_READY_PRIORITY( pxTCB->uxPriority, uxTopReadyPriority );\r
4320                         }\r
4321                         else\r
4322                         {\r
4323                             mtCOVERAGE_TEST_MARKER();\r
4324                         }\r
4325 \r
4326                         prvAddTaskToReadyList( pxTCB );\r
4327                     }\r
4328                     else\r
4329                     {\r
4330                         mtCOVERAGE_TEST_MARKER();\r
4331                     }\r
4332                 }\r
4333                 else\r
4334                 {\r
4335                     mtCOVERAGE_TEST_MARKER();\r
4336                 }\r
4337             }\r
4338             else\r
4339             {\r
4340                 mtCOVERAGE_TEST_MARKER();\r
4341             }\r
4342         }\r
4343         else\r
4344         {\r
4345             mtCOVERAGE_TEST_MARKER();\r
4346         }\r
4347     }\r
4348 \r
4349 #endif /* configUSE_MUTEXES */\r
4350 /*-----------------------------------------------------------*/\r
4351 \r
4352 #if ( portCRITICAL_NESTING_IN_TCB == 1 )\r
4353 \r
4354     void vTaskEnterCritical( void )\r
4355     {\r
4356         portDISABLE_INTERRUPTS();\r
4357 \r
4358         if( xSchedulerRunning != pdFALSE )\r
4359         {\r
4360             ( pxCurrentTCB->uxCriticalNesting )++;\r
4361 \r
4362             /* This is not the interrupt safe version of the enter critical\r
4363              * function so  assert() if it is being called from an interrupt\r
4364              * context.  Only API functions that end in "FromISR" can be used in an\r
4365              * interrupt.  Only assert if the critical nesting count is 1 to\r
4366              * protect against recursive calls if the assert function also uses a\r
4367              * critical section. */\r
4368             if( pxCurrentTCB->uxCriticalNesting == 1 )\r
4369             {\r
4370                 portASSERT_IF_IN_ISR();\r
4371             }\r
4372         }\r
4373         else\r
4374         {\r
4375             mtCOVERAGE_TEST_MARKER();\r
4376         }\r
4377     }\r
4378 \r
4379 #endif /* portCRITICAL_NESTING_IN_TCB */\r
4380 /*-----------------------------------------------------------*/\r
4381 \r
4382 #if ( portCRITICAL_NESTING_IN_TCB == 1 )\r
4383 \r
4384     void vTaskExitCritical( void )\r
4385     {\r
4386         if( xSchedulerRunning != pdFALSE )\r
4387         {\r
4388             if( pxCurrentTCB->uxCriticalNesting > 0U )\r
4389             {\r
4390                 ( pxCurrentTCB->uxCriticalNesting )--;\r
4391 \r
4392                 if( pxCurrentTCB->uxCriticalNesting == 0U )\r
4393                 {\r
4394                     portENABLE_INTERRUPTS();\r
4395                 }\r
4396                 else\r
4397                 {\r
4398                     mtCOVERAGE_TEST_MARKER();\r
4399                 }\r
4400             }\r
4401             else\r
4402             {\r
4403                 mtCOVERAGE_TEST_MARKER();\r
4404             }\r
4405         }\r
4406         else\r
4407         {\r
4408             mtCOVERAGE_TEST_MARKER();\r
4409         }\r
4410     }\r
4411 \r
4412 #endif /* portCRITICAL_NESTING_IN_TCB */\r
4413 /*-----------------------------------------------------------*/\r
4414 \r
4415 #if ( ( ( configUSE_TRACE_FACILITY == 1 ) || ( configGENERATE_RUN_TIME_STATS == 1 ) ) && \\r
4416     ( configUSE_STATS_FORMATTING_FUNCTIONS > 0 ) &&                                      \\r
4417     ( configSUPPORT_DYNAMIC_ALLOCATION == 1 ) )\r
4418 \r
4419     static char * prvWriteNameToBuffer( char * pcBuffer,\r
4420                                         const char * pcTaskName )\r
4421     {\r
4422         size_t x;\r
4423 \r
4424         /* Start by copying the entire string. */\r
4425         strcpy( pcBuffer, pcTaskName );\r
4426 \r
4427         /* Pad the end of the string with spaces to ensure columns line up when\r
4428          * printed out. */\r
4429         for( x = strlen( pcBuffer ); x < ( size_t ) ( configMAX_TASK_NAME_LEN - 1 ); x++ )\r
4430         {\r
4431             pcBuffer[ x ] = ' ';\r
4432         }\r
4433 \r
4434         /* Terminate. */\r
4435         pcBuffer[ x ] = ( char ) 0x00;\r
4436 \r
4437         /* Return the new end of string. */\r
4438         return &( pcBuffer[ x ] );\r
4439     }\r
4440 \r
4441 #endif /* ( configUSE_TRACE_FACILITY == 1 ) && ( configUSE_STATS_FORMATTING_FUNCTIONS > 0 ) */\r
4442 /*-----------------------------------------------------------*/\r
4443 \r
4444 #if ( ( configUSE_TRACE_FACILITY == 1 ) && ( configUSE_STATS_FORMATTING_FUNCTIONS > 0 ) && ( configSUPPORT_DYNAMIC_ALLOCATION == 1 ) )\r
4445 \r
4446     void vTaskList( char * pcWriteBuffer )\r
4447     {\r
4448         TaskStatus_t * pxTaskStatusArray;\r
4449         UBaseType_t uxArraySize, x;\r
4450         char cStatus;\r
4451 \r
4452         /*\r
4453          * PLEASE NOTE:\r
4454          *\r
4455          * This function is provided for convenience only, and is used by many\r
4456          * of the demo applications.  Do not consider it to be part of the\r
4457          * scheduler.\r
4458          *\r
4459          * vTaskList() calls uxTaskGetSystemState(), then formats part of the\r
4460          * uxTaskGetSystemState() output into a human readable table that\r
4461          * displays task: names, states, priority, stack usage and task number.\r
4462          * Stack usage specified as the number of unused StackType_t words stack can hold\r
4463          * on top of stack - not the number of bytes.\r
4464          *\r
4465          * vTaskList() has a dependency on the sprintf() C library function that\r
4466          * might bloat the code size, use a lot of stack, and provide different\r
4467          * results on different platforms.  An alternative, tiny, third party,\r
4468          * and limited functionality implementation of sprintf() is provided in\r
4469          * many of the FreeRTOS/Demo sub-directories in a file called\r
4470          * printf-stdarg.c (note printf-stdarg.c does not provide a full\r
4471          * snprintf() implementation!).\r
4472          *\r
4473          * It is recommended that production systems call uxTaskGetSystemState()\r
4474          * directly to get access to raw stats data, rather than indirectly\r
4475          * through a call to vTaskList().\r
4476          */\r
4477 \r
4478 \r
4479         /* Make sure the write buffer does not contain a string. */\r
4480         *pcWriteBuffer = ( char ) 0x00;\r
4481 \r
4482         /* Take a snapshot of the number of tasks in case it changes while this\r
4483          * function is executing. */\r
4484         uxArraySize = uxCurrentNumberOfTasks;\r
4485 \r
4486         /* Allocate an array index for each task.  NOTE!  if\r
4487          * configSUPPORT_DYNAMIC_ALLOCATION is set to 0 then pvPortMalloc() will\r
4488          * equate to NULL. */\r
4489         pxTaskStatusArray = pvPortMalloc( uxCurrentNumberOfTasks * sizeof( TaskStatus_t ) ); /*lint !e9079 All values returned by pvPortMalloc() have at least the alignment required by the MCU's stack and this allocation allocates a struct that has the alignment requirements of a pointer. */\r
4490 \r
4491         if( pxTaskStatusArray != NULL )\r
4492         {\r
4493             /* Generate the (binary) data. */\r
4494             uxArraySize = uxTaskGetSystemState( pxTaskStatusArray, uxArraySize, NULL );\r
4495 \r
4496             /* Create a human readable table from the binary data. */\r
4497             for( x = 0; x < uxArraySize; x++ )\r
4498             {\r
4499                 switch( pxTaskStatusArray[ x ].eCurrentState )\r
4500                 {\r
4501                     case eRunning:\r
4502                         cStatus = tskRUNNING_CHAR;\r
4503                         break;\r
4504 \r
4505                     case eReady:\r
4506                         cStatus = tskREADY_CHAR;\r
4507                         break;\r
4508 \r
4509                     case eBlocked:\r
4510                         cStatus = tskBLOCKED_CHAR;\r
4511                         break;\r
4512 \r
4513                     case eSuspended:\r
4514                         cStatus = tskSUSPENDED_CHAR;\r
4515                         break;\r
4516 \r
4517                     case eDeleted:\r
4518                         cStatus = tskDELETED_CHAR;\r
4519                         break;\r
4520 \r
4521                     case eInvalid: /* Fall through. */\r
4522                     default:       /* Should not get here, but it is included\r
4523                                     * to prevent static checking errors. */\r
4524                         cStatus = ( char ) 0x00;\r
4525                         break;\r
4526                 }\r
4527 \r
4528                 /* Write the task name to the string, padding with spaces so it\r
4529                  * can be printed in tabular form more easily. */\r
4530                 pcWriteBuffer = prvWriteNameToBuffer( pcWriteBuffer, pxTaskStatusArray[ x ].pcTaskName );\r
4531 \r
4532                 /* Write the rest of the string. */\r
4533                 sprintf( pcWriteBuffer, "\t%c\t%u\t%u\t%u\r\n", cStatus, ( unsigned int ) pxTaskStatusArray[ x ].uxCurrentPriority, ( unsigned int ) pxTaskStatusArray[ x ].usStackHighWaterMark, ( unsigned int ) pxTaskStatusArray[ x ].xTaskNumber ); /*lint !e586 sprintf() allowed as this is compiled with many compilers and this is a utility function only - not part of the core kernel implementation. */\r
4534                 pcWriteBuffer += strlen( pcWriteBuffer );                                                                                                                                                                                                /*lint !e9016 Pointer arithmetic ok on char pointers especially as in this case where it best denotes the intent of the code. */\r
4535             }\r
4536 \r
4537             /* Free the array again.  NOTE!  If configSUPPORT_DYNAMIC_ALLOCATION\r
4538              * is 0 then vPortFree() will be #defined to nothing. */\r
4539             vPortFree( pxTaskStatusArray );\r
4540         }\r
4541         else\r
4542         {\r
4543             mtCOVERAGE_TEST_MARKER();\r
4544         }\r
4545     }\r
4546 \r
4547 #endif /* ( ( configUSE_TRACE_FACILITY == 1 ) && ( configUSE_STATS_FORMATTING_FUNCTIONS > 0 ) && ( configSUPPORT_DYNAMIC_ALLOCATION == 1 ) ) */\r
4548 /*----------------------------------------------------------*/\r
4549 \r
4550 #if ( ( configGENERATE_RUN_TIME_STATS == 1 ) && ( configUSE_STATS_FORMATTING_FUNCTIONS > 0 ) && ( configSUPPORT_DYNAMIC_ALLOCATION == 1 ) )\r
4551 \r
4552     void vTaskGetRunTimeStats( char * pcWriteBuffer )\r
4553     {\r
4554         TaskStatus_t * pxTaskStatusArray;\r
4555         UBaseType_t uxArraySize, x;\r
4556         configRUN_TIME_COUNTER_TYPE ulTotalTime, ulStatsAsPercentage;\r
4557 \r
4558         #if ( configUSE_TRACE_FACILITY != 1 )\r
4559         {\r
4560             #error configUSE_TRACE_FACILITY must also be set to 1 in FreeRTOSConfig.h to use vTaskGetRunTimeStats().\r
4561         }\r
4562         #endif\r
4563 \r
4564         /*\r
4565          * PLEASE NOTE:\r
4566          *\r
4567          * This function is provided for convenience only, and is used by many\r
4568          * of the demo applications.  Do not consider it to be part of the\r
4569          * scheduler.\r
4570          *\r
4571          * vTaskGetRunTimeStats() calls uxTaskGetSystemState(), then formats part\r
4572          * of the uxTaskGetSystemState() output into a human readable table that\r
4573          * displays the amount of time each task has spent in the Running state\r
4574          * in both absolute and percentage terms.\r
4575          *\r
4576          * vTaskGetRunTimeStats() has a dependency on the sprintf() C library\r
4577          * function that might bloat the code size, use a lot of stack, and\r
4578          * provide different results on different platforms.  An alternative,\r
4579          * tiny, third party, and limited functionality implementation of\r
4580          * sprintf() is provided in many of the FreeRTOS/Demo sub-directories in\r
4581          * a file called printf-stdarg.c (note printf-stdarg.c does not provide\r
4582          * a full snprintf() implementation!).\r
4583          *\r
4584          * It is recommended that production systems call uxTaskGetSystemState()\r
4585          * directly to get access to raw stats data, rather than indirectly\r
4586          * through a call to vTaskGetRunTimeStats().\r
4587          */\r
4588 \r
4589         /* Make sure the write buffer does not contain a string. */\r
4590         *pcWriteBuffer = ( char ) 0x00;\r
4591 \r
4592         /* Take a snapshot of the number of tasks in case it changes while this\r
4593          * function is executing. */\r
4594         uxArraySize = uxCurrentNumberOfTasks;\r
4595 \r
4596         /* Allocate an array index for each task.  NOTE!  If\r
4597          * configSUPPORT_DYNAMIC_ALLOCATION is set to 0 then pvPortMalloc() will\r
4598          * equate to NULL. */\r
4599         pxTaskStatusArray = pvPortMalloc( uxCurrentNumberOfTasks * sizeof( TaskStatus_t ) ); /*lint !e9079 All values returned by pvPortMalloc() have at least the alignment required by the MCU's stack and this allocation allocates a struct that has the alignment requirements of a pointer. */\r
4600 \r
4601         if( pxTaskStatusArray != NULL )\r
4602         {\r
4603             /* Generate the (binary) data. */\r
4604             uxArraySize = uxTaskGetSystemState( pxTaskStatusArray, uxArraySize, &ulTotalTime );\r
4605 \r
4606             /* For percentage calculations. */\r
4607             ulTotalTime /= 100UL;\r
4608 \r
4609             /* Avoid divide by zero errors. */\r
4610             if( ulTotalTime > 0UL )\r
4611             {\r
4612                 /* Create a human readable table from the binary data. */\r
4613                 for( x = 0; x < uxArraySize; x++ )\r
4614                 {\r
4615                     /* What percentage of the total run time has the task used?\r
4616                      * This will always be rounded down to the nearest integer.\r
4617                      * ulTotalRunTime has already been divided by 100. */\r
4618                     ulStatsAsPercentage = pxTaskStatusArray[ x ].ulRunTimeCounter / ulTotalTime;\r
4619 \r
4620                     /* Write the task name to the string, padding with\r
4621                      * spaces so it can be printed in tabular form more\r
4622                      * easily. */\r
4623                     pcWriteBuffer = prvWriteNameToBuffer( pcWriteBuffer, pxTaskStatusArray[ x ].pcTaskName );\r
4624 \r
4625                     if( ulStatsAsPercentage > 0UL )\r
4626                     {\r
4627                         #ifdef portLU_PRINTF_SPECIFIER_REQUIRED\r
4628                         {\r
4629                             sprintf( pcWriteBuffer, "\t%lu\t\t%lu%%\r\n", pxTaskStatusArray[ x ].ulRunTimeCounter, ulStatsAsPercentage );\r
4630                         }\r
4631                         #else\r
4632                         {\r
4633                             /* sizeof( int ) == sizeof( long ) so a smaller\r
4634                              * printf() library can be used. */\r
4635                             sprintf( pcWriteBuffer, "\t%u\t\t%u%%\r\n", ( unsigned int ) pxTaskStatusArray[ x ].ulRunTimeCounter, ( unsigned int ) ulStatsAsPercentage ); /*lint !e586 sprintf() allowed as this is compiled with many compilers and this is a utility function only - not part of the core kernel implementation. */\r
4636                         }\r
4637                         #endif\r
4638                     }\r
4639                     else\r
4640                     {\r
4641                         /* If the percentage is zero here then the task has\r
4642                          * consumed less than 1% of the total run time. */\r
4643                         #ifdef portLU_PRINTF_SPECIFIER_REQUIRED\r
4644                         {\r
4645                             sprintf( pcWriteBuffer, "\t%lu\t\t<1%%\r\n", pxTaskStatusArray[ x ].ulRunTimeCounter );\r
4646                         }\r
4647                         #else\r
4648                         {\r
4649                             /* sizeof( int ) == sizeof( long ) so a smaller\r
4650                              * printf() library can be used. */\r
4651                             sprintf( pcWriteBuffer, "\t%u\t\t<1%%\r\n", ( unsigned int ) pxTaskStatusArray[ x ].ulRunTimeCounter ); /*lint !e586 sprintf() allowed as this is compiled with many compilers and this is a utility function only - not part of the core kernel implementation. */\r
4652                         }\r
4653                         #endif\r
4654                     }\r
4655 \r
4656                     pcWriteBuffer += strlen( pcWriteBuffer ); /*lint !e9016 Pointer arithmetic ok on char pointers especially as in this case where it best denotes the intent of the code. */\r
4657                 }\r
4658             }\r
4659             else\r
4660             {\r
4661                 mtCOVERAGE_TEST_MARKER();\r
4662             }\r
4663 \r
4664             /* Free the array again.  NOTE!  If configSUPPORT_DYNAMIC_ALLOCATION\r
4665              * is 0 then vPortFree() will be #defined to nothing. */\r
4666             vPortFree( pxTaskStatusArray );\r
4667         }\r
4668         else\r
4669         {\r
4670             mtCOVERAGE_TEST_MARKER();\r
4671         }\r
4672     }\r
4673 \r
4674 #endif /* ( ( configGENERATE_RUN_TIME_STATS == 1 ) && ( configUSE_STATS_FORMATTING_FUNCTIONS > 0 ) && ( configSUPPORT_STATIC_ALLOCATION == 1 ) ) */\r
4675 /*-----------------------------------------------------------*/\r
4676 \r
4677 TickType_t uxTaskResetEventItemValue( void )\r
4678 {\r
4679     TickType_t uxReturn;\r
4680 \r
4681     uxReturn = listGET_LIST_ITEM_VALUE( &( pxCurrentTCB->xEventListItem ) );\r
4682 \r
4683     /* Reset the event list item to its normal value - so it can be used with\r
4684      * queues and semaphores. */\r
4685     listSET_LIST_ITEM_VALUE( &( pxCurrentTCB->xEventListItem ), ( ( TickType_t ) configMAX_PRIORITIES - ( TickType_t ) pxCurrentTCB->uxPriority ) ); /*lint !e961 MISRA exception as the casts are only redundant for some ports. */\r
4686 \r
4687     return uxReturn;\r
4688 }\r
4689 /*-----------------------------------------------------------*/\r
4690 \r
4691 #if ( configUSE_MUTEXES == 1 )\r
4692 \r
4693     TaskHandle_t pvTaskIncrementMutexHeldCount( void )\r
4694     {\r
4695         /* If xSemaphoreCreateMutex() is called before any tasks have been created\r
4696          * then pxCurrentTCB will be NULL. */\r
4697         if( pxCurrentTCB != NULL )\r
4698         {\r
4699             ( pxCurrentTCB->uxMutexesHeld )++;\r
4700         }\r
4701 \r
4702         return pxCurrentTCB;\r
4703     }\r
4704 \r
4705 #endif /* configUSE_MUTEXES */\r
4706 /*-----------------------------------------------------------*/\r
4707 \r
4708 #if ( configUSE_TASK_NOTIFICATIONS == 1 )\r
4709 \r
4710     uint32_t ulTaskGenericNotifyTake( UBaseType_t uxIndexToWait,\r
4711                                       BaseType_t xClearCountOnExit,\r
4712                                       TickType_t xTicksToWait )\r
4713     {\r
4714         uint32_t ulReturn;\r
4715 \r
4716         configASSERT( uxIndexToWait < configTASK_NOTIFICATION_ARRAY_ENTRIES );\r
4717 \r
4718         taskENTER_CRITICAL();\r
4719         {\r
4720             /* Only block if the notification count is not already non-zero. */\r
4721             if( pxCurrentTCB->ulNotifiedValue[ uxIndexToWait ] == 0UL )\r
4722             {\r
4723                 /* Mark this task as waiting for a notification. */\r
4724                 pxCurrentTCB->ucNotifyState[ uxIndexToWait ] = taskWAITING_NOTIFICATION;\r
4725 \r
4726                 if( xTicksToWait > ( TickType_t ) 0 )\r
4727                 {\r
4728                     prvAddCurrentTaskToDelayedList( xTicksToWait, pdTRUE );\r
4729                     traceTASK_NOTIFY_TAKE_BLOCK( uxIndexToWait );\r
4730 \r
4731                     /* All ports are written to allow a yield in a critical\r
4732                      * section (some will yield immediately, others wait until the\r
4733                      * critical section exits) - but it is not something that\r
4734                      * application code should ever do. */\r
4735                     portYIELD_WITHIN_API();\r
4736                 }\r
4737                 else\r
4738                 {\r
4739                     mtCOVERAGE_TEST_MARKER();\r
4740                 }\r
4741             }\r
4742             else\r
4743             {\r
4744                 mtCOVERAGE_TEST_MARKER();\r
4745             }\r
4746         }\r
4747         taskEXIT_CRITICAL();\r
4748 \r
4749         taskENTER_CRITICAL();\r
4750         {\r
4751             traceTASK_NOTIFY_TAKE( uxIndexToWait );\r
4752             ulReturn = pxCurrentTCB->ulNotifiedValue[ uxIndexToWait ];\r
4753 \r
4754             if( ulReturn != 0UL )\r
4755             {\r
4756                 if( xClearCountOnExit != pdFALSE )\r
4757                 {\r
4758                     pxCurrentTCB->ulNotifiedValue[ uxIndexToWait ] = 0UL;\r
4759                 }\r
4760                 else\r
4761                 {\r
4762                     pxCurrentTCB->ulNotifiedValue[ uxIndexToWait ] = ulReturn - ( uint32_t ) 1;\r
4763                 }\r
4764             }\r
4765             else\r
4766             {\r
4767                 mtCOVERAGE_TEST_MARKER();\r
4768             }\r
4769 \r
4770             pxCurrentTCB->ucNotifyState[ uxIndexToWait ] = taskNOT_WAITING_NOTIFICATION;\r
4771         }\r
4772         taskEXIT_CRITICAL();\r
4773 \r
4774         return ulReturn;\r
4775     }\r
4776 \r
4777 #endif /* configUSE_TASK_NOTIFICATIONS */\r
4778 /*-----------------------------------------------------------*/\r
4779 \r
4780 #if ( configUSE_TASK_NOTIFICATIONS == 1 )\r
4781 \r
4782     BaseType_t xTaskGenericNotifyWait( UBaseType_t uxIndexToWait,\r
4783                                        uint32_t ulBitsToClearOnEntry,\r
4784                                        uint32_t ulBitsToClearOnExit,\r
4785                                        uint32_t * pulNotificationValue,\r
4786                                        TickType_t xTicksToWait )\r
4787     {\r
4788         BaseType_t xReturn;\r
4789 \r
4790         configASSERT( uxIndexToWait < configTASK_NOTIFICATION_ARRAY_ENTRIES );\r
4791 \r
4792         taskENTER_CRITICAL();\r
4793         {\r
4794             /* Only block if a notification is not already pending. */\r
4795             if( pxCurrentTCB->ucNotifyState[ uxIndexToWait ] != taskNOTIFICATION_RECEIVED )\r
4796             {\r
4797                 /* Clear bits in the task's notification value as bits may get\r
4798                  * set  by the notifying task or interrupt.  This can be used to\r
4799                  * clear the value to zero. */\r
4800                 pxCurrentTCB->ulNotifiedValue[ uxIndexToWait ] &= ~ulBitsToClearOnEntry;\r
4801 \r
4802                 /* Mark this task as waiting for a notification. */\r
4803                 pxCurrentTCB->ucNotifyState[ uxIndexToWait ] = taskWAITING_NOTIFICATION;\r
4804 \r
4805                 if( xTicksToWait > ( TickType_t ) 0 )\r
4806                 {\r
4807                     prvAddCurrentTaskToDelayedList( xTicksToWait, pdTRUE );\r
4808                     traceTASK_NOTIFY_WAIT_BLOCK( uxIndexToWait );\r
4809 \r
4810                     /* All ports are written to allow a yield in a critical\r
4811                      * section (some will yield immediately, others wait until the\r
4812                      * critical section exits) - but it is not something that\r
4813                      * application code should ever do. */\r
4814                     portYIELD_WITHIN_API();\r
4815                 }\r
4816                 else\r
4817                 {\r
4818                     mtCOVERAGE_TEST_MARKER();\r
4819                 }\r
4820             }\r
4821             else\r
4822             {\r
4823                 mtCOVERAGE_TEST_MARKER();\r
4824             }\r
4825         }\r
4826         taskEXIT_CRITICAL();\r
4827 \r
4828         taskENTER_CRITICAL();\r
4829         {\r
4830             traceTASK_NOTIFY_WAIT( uxIndexToWait );\r
4831 \r
4832             if( pulNotificationValue != NULL )\r
4833             {\r
4834                 /* Output the current notification value, which may or may not\r
4835                  * have changed. */\r
4836                 *pulNotificationValue = pxCurrentTCB->ulNotifiedValue[ uxIndexToWait ];\r
4837             }\r
4838 \r
4839             /* If ucNotifyValue is set then either the task never entered the\r
4840              * blocked state (because a notification was already pending) or the\r
4841              * task unblocked because of a notification.  Otherwise the task\r
4842              * unblocked because of a timeout. */\r
4843             if( pxCurrentTCB->ucNotifyState[ uxIndexToWait ] != taskNOTIFICATION_RECEIVED )\r
4844             {\r
4845                 /* A notification was not received. */\r
4846                 xReturn = pdFALSE;\r
4847             }\r
4848             else\r
4849             {\r
4850                 /* A notification was already pending or a notification was\r
4851                  * received while the task was waiting. */\r
4852                 pxCurrentTCB->ulNotifiedValue[ uxIndexToWait ] &= ~ulBitsToClearOnExit;\r
4853                 xReturn = pdTRUE;\r
4854             }\r
4855 \r
4856             pxCurrentTCB->ucNotifyState[ uxIndexToWait ] = taskNOT_WAITING_NOTIFICATION;\r
4857         }\r
4858         taskEXIT_CRITICAL();\r
4859 \r
4860         return xReturn;\r
4861     }\r
4862 \r
4863 #endif /* configUSE_TASK_NOTIFICATIONS */\r
4864 /*-----------------------------------------------------------*/\r
4865 \r
4866 #if ( configUSE_TASK_NOTIFICATIONS == 1 )\r
4867 \r
4868     BaseType_t xTaskGenericNotify( TaskHandle_t xTaskToNotify,\r
4869                                    UBaseType_t uxIndexToNotify,\r
4870                                    uint32_t ulValue,\r
4871                                    eNotifyAction eAction,\r
4872                                    uint32_t * pulPreviousNotificationValue )\r
4873     {\r
4874         TCB_t * pxTCB;\r
4875         BaseType_t xReturn = pdPASS;\r
4876         uint8_t ucOriginalNotifyState;\r
4877 \r
4878         configASSERT( uxIndexToNotify < configTASK_NOTIFICATION_ARRAY_ENTRIES );\r
4879         configASSERT( xTaskToNotify );\r
4880         pxTCB = xTaskToNotify;\r
4881 \r
4882         taskENTER_CRITICAL();\r
4883         {\r
4884             if( pulPreviousNotificationValue != NULL )\r
4885             {\r
4886                 *pulPreviousNotificationValue = pxTCB->ulNotifiedValue[ uxIndexToNotify ];\r
4887             }\r
4888 \r
4889             ucOriginalNotifyState = pxTCB->ucNotifyState[ uxIndexToNotify ];\r
4890 \r
4891             pxTCB->ucNotifyState[ uxIndexToNotify ] = taskNOTIFICATION_RECEIVED;\r
4892 \r
4893             switch( eAction )\r
4894             {\r
4895                 case eSetBits:\r
4896                     pxTCB->ulNotifiedValue[ uxIndexToNotify ] |= ulValue;\r
4897                     break;\r
4898 \r
4899                 case eIncrement:\r
4900                     ( pxTCB->ulNotifiedValue[ uxIndexToNotify ] )++;\r
4901                     break;\r
4902 \r
4903                 case eSetValueWithOverwrite:\r
4904                     pxTCB->ulNotifiedValue[ uxIndexToNotify ] = ulValue;\r
4905                     break;\r
4906 \r
4907                 case eSetValueWithoutOverwrite:\r
4908 \r
4909                     if( ucOriginalNotifyState != taskNOTIFICATION_RECEIVED )\r
4910                     {\r
4911                         pxTCB->ulNotifiedValue[ uxIndexToNotify ] = ulValue;\r
4912                     }\r
4913                     else\r
4914                     {\r
4915                         /* The value could not be written to the task. */\r
4916                         xReturn = pdFAIL;\r
4917                     }\r
4918 \r
4919                     break;\r
4920 \r
4921                 case eNoAction:\r
4922 \r
4923                     /* The task is being notified without its notify value being\r
4924                      * updated. */\r
4925                     break;\r
4926 \r
4927                 default:\r
4928 \r
4929                     /* Should not get here if all enums are handled.\r
4930                      * Artificially force an assert by testing a value the\r
4931                      * compiler can't assume is const. */\r
4932                     configASSERT( xTickCount == ( TickType_t ) 0 );\r
4933 \r
4934                     break;\r
4935             }\r
4936 \r
4937             traceTASK_NOTIFY( uxIndexToNotify );\r
4938 \r
4939             /* If the task is in the blocked state specifically to wait for a\r
4940              * notification then unblock it now. */\r
4941             if( ucOriginalNotifyState == taskWAITING_NOTIFICATION )\r
4942             {\r
4943                 listREMOVE_ITEM( &( pxTCB->xStateListItem ) );\r
4944                 prvAddTaskToReadyList( pxTCB );\r
4945 \r
4946                 /* The task should not have been on an event list. */\r
4947                 configASSERT( listLIST_ITEM_CONTAINER( &( pxTCB->xEventListItem ) ) == NULL );\r
4948 \r
4949                 #if ( configUSE_TICKLESS_IDLE != 0 )\r
4950                 {\r
4951                     /* If a task is blocked waiting for a notification then\r
4952                      * xNextTaskUnblockTime might be set to the blocked task's time\r
4953                      * out time.  If the task is unblocked for a reason other than\r
4954                      * a timeout xNextTaskUnblockTime is normally left unchanged,\r
4955                      * because it will automatically get reset to a new value when\r
4956                      * the tick count equals xNextTaskUnblockTime.  However if\r
4957                      * tickless idling is used it might be more important to enter\r
4958                      * sleep mode at the earliest possible time - so reset\r
4959                      * xNextTaskUnblockTime here to ensure it is updated at the\r
4960                      * earliest possible time. */\r
4961                     prvResetNextTaskUnblockTime();\r
4962                 }\r
4963                 #endif\r
4964 \r
4965                 if( pxTCB->uxPriority > pxCurrentTCB->uxPriority )\r
4966                 {\r
4967                     /* The notified task has a priority above the currently\r
4968                      * executing task so a yield is required. */\r
4969                     taskYIELD_IF_USING_PREEMPTION();\r
4970                 }\r
4971                 else\r
4972                 {\r
4973                     mtCOVERAGE_TEST_MARKER();\r
4974                 }\r
4975             }\r
4976             else\r
4977             {\r
4978                 mtCOVERAGE_TEST_MARKER();\r
4979             }\r
4980         }\r
4981         taskEXIT_CRITICAL();\r
4982 \r
4983         return xReturn;\r
4984     }\r
4985 \r
4986 #endif /* configUSE_TASK_NOTIFICATIONS */\r
4987 /*-----------------------------------------------------------*/\r
4988 \r
4989 #if ( configUSE_TASK_NOTIFICATIONS == 1 )\r
4990 \r
4991     BaseType_t xTaskGenericNotifyFromISR( TaskHandle_t xTaskToNotify,\r
4992                                           UBaseType_t uxIndexToNotify,\r
4993                                           uint32_t ulValue,\r
4994                                           eNotifyAction eAction,\r
4995                                           uint32_t * pulPreviousNotificationValue,\r
4996                                           BaseType_t * pxHigherPriorityTaskWoken )\r
4997     {\r
4998         TCB_t * pxTCB;\r
4999         uint8_t ucOriginalNotifyState;\r
5000         BaseType_t xReturn = pdPASS;\r
5001         UBaseType_t uxSavedInterruptStatus;\r
5002 \r
5003         configASSERT( xTaskToNotify );\r
5004         configASSERT( uxIndexToNotify < configTASK_NOTIFICATION_ARRAY_ENTRIES );\r
5005 \r
5006         /* RTOS ports that support interrupt nesting have the concept of a\r
5007          * maximum  system call (or maximum API call) interrupt priority.\r
5008          * Interrupts that are  above the maximum system call priority are keep\r
5009          * permanently enabled, even when the RTOS kernel is in a critical section,\r
5010          * but cannot make any calls to FreeRTOS API functions.  If configASSERT()\r
5011          * is defined in FreeRTOSConfig.h then\r
5012          * portASSERT_IF_INTERRUPT_PRIORITY_INVALID() will result in an assertion\r
5013          * failure if a FreeRTOS API function is called from an interrupt that has\r
5014          * been assigned a priority above the configured maximum system call\r
5015          * priority.  Only FreeRTOS functions that end in FromISR can be called\r
5016          * from interrupts  that have been assigned a priority at or (logically)\r
5017          * below the maximum system call interrupt priority.  FreeRTOS maintains a\r
5018          * separate interrupt safe API to ensure interrupt entry is as fast and as\r
5019          * simple as possible.  More information (albeit Cortex-M specific) is\r
5020          * provided on the following link:\r
5021          * https://www.FreeRTOS.org/RTOS-Cortex-M3-M4.html */\r
5022         portASSERT_IF_INTERRUPT_PRIORITY_INVALID();\r
5023 \r
5024         pxTCB = xTaskToNotify;\r
5025 \r
5026         uxSavedInterruptStatus = portSET_INTERRUPT_MASK_FROM_ISR();\r
5027         {\r
5028             if( pulPreviousNotificationValue != NULL )\r
5029             {\r
5030                 *pulPreviousNotificationValue = pxTCB->ulNotifiedValue[ uxIndexToNotify ];\r
5031             }\r
5032 \r
5033             ucOriginalNotifyState = pxTCB->ucNotifyState[ uxIndexToNotify ];\r
5034             pxTCB->ucNotifyState[ uxIndexToNotify ] = taskNOTIFICATION_RECEIVED;\r
5035 \r
5036             switch( eAction )\r
5037             {\r
5038                 case eSetBits:\r
5039                     pxTCB->ulNotifiedValue[ uxIndexToNotify ] |= ulValue;\r
5040                     break;\r
5041 \r
5042                 case eIncrement:\r
5043                     ( pxTCB->ulNotifiedValue[ uxIndexToNotify ] )++;\r
5044                     break;\r
5045 \r
5046                 case eSetValueWithOverwrite:\r
5047                     pxTCB->ulNotifiedValue[ uxIndexToNotify ] = ulValue;\r
5048                     break;\r
5049 \r
5050                 case eSetValueWithoutOverwrite:\r
5051 \r
5052                     if( ucOriginalNotifyState != taskNOTIFICATION_RECEIVED )\r
5053                     {\r
5054                         pxTCB->ulNotifiedValue[ uxIndexToNotify ] = ulValue;\r
5055                     }\r
5056                     else\r
5057                     {\r
5058                         /* The value could not be written to the task. */\r
5059                         xReturn = pdFAIL;\r
5060                     }\r
5061 \r
5062                     break;\r
5063 \r
5064                 case eNoAction:\r
5065 \r
5066                     /* The task is being notified without its notify value being\r
5067                      * updated. */\r
5068                     break;\r
5069 \r
5070                 default:\r
5071 \r
5072                     /* Should not get here if all enums are handled.\r
5073                      * Artificially force an assert by testing a value the\r
5074                      * compiler can't assume is const. */\r
5075                     configASSERT( xTickCount == ( TickType_t ) 0 );\r
5076                     break;\r
5077             }\r
5078 \r
5079             traceTASK_NOTIFY_FROM_ISR( uxIndexToNotify );\r
5080 \r
5081             /* If the task is in the blocked state specifically to wait for a\r
5082              * notification then unblock it now. */\r
5083             if( ucOriginalNotifyState == taskWAITING_NOTIFICATION )\r
5084             {\r
5085                 /* The task should not have been on an event list. */\r
5086                 configASSERT( listLIST_ITEM_CONTAINER( &( pxTCB->xEventListItem ) ) == NULL );\r
5087 \r
5088                 if( uxSchedulerSuspended == ( UBaseType_t ) pdFALSE )\r
5089                 {\r
5090                     listREMOVE_ITEM( &( pxTCB->xStateListItem ) );\r
5091                     prvAddTaskToReadyList( pxTCB );\r
5092                 }\r
5093                 else\r
5094                 {\r
5095                     /* The delayed and ready lists cannot be accessed, so hold\r
5096                      * this task pending until the scheduler is resumed. */\r
5097                     listINSERT_END( &( xPendingReadyList ), &( pxTCB->xEventListItem ) );\r
5098                 }\r
5099 \r
5100                 if( pxTCB->uxPriority > pxCurrentTCB->uxPriority )\r
5101                 {\r
5102                     /* The notified task has a priority above the currently\r
5103                      * executing task so a yield is required. */\r
5104                     if( pxHigherPriorityTaskWoken != NULL )\r
5105                     {\r
5106                         *pxHigherPriorityTaskWoken = pdTRUE;\r
5107                     }\r
5108 \r
5109                     /* Mark that a yield is pending in case the user is not\r
5110                      * using the "xHigherPriorityTaskWoken" parameter to an ISR\r
5111                      * safe FreeRTOS function. */\r
5112                     xYieldPending = pdTRUE;\r
5113                 }\r
5114                 else\r
5115                 {\r
5116                     mtCOVERAGE_TEST_MARKER();\r
5117                 }\r
5118             }\r
5119         }\r
5120         portCLEAR_INTERRUPT_MASK_FROM_ISR( uxSavedInterruptStatus );\r
5121 \r
5122         return xReturn;\r
5123     }\r
5124 \r
5125 #endif /* configUSE_TASK_NOTIFICATIONS */\r
5126 /*-----------------------------------------------------------*/\r
5127 \r
5128 #if ( configUSE_TASK_NOTIFICATIONS == 1 )\r
5129 \r
5130     void vTaskGenericNotifyGiveFromISR( TaskHandle_t xTaskToNotify,\r
5131                                         UBaseType_t uxIndexToNotify,\r
5132                                         BaseType_t * pxHigherPriorityTaskWoken )\r
5133     {\r
5134         TCB_t * pxTCB;\r
5135         uint8_t ucOriginalNotifyState;\r
5136         UBaseType_t uxSavedInterruptStatus;\r
5137 \r
5138         configASSERT( xTaskToNotify );\r
5139         configASSERT( uxIndexToNotify < configTASK_NOTIFICATION_ARRAY_ENTRIES );\r
5140 \r
5141         /* RTOS ports that support interrupt nesting have the concept of a\r
5142          * maximum  system call (or maximum API call) interrupt priority.\r
5143          * Interrupts that are  above the maximum system call priority are keep\r
5144          * permanently enabled, even when the RTOS kernel is in a critical section,\r
5145          * but cannot make any calls to FreeRTOS API functions.  If configASSERT()\r
5146          * is defined in FreeRTOSConfig.h then\r
5147          * portASSERT_IF_INTERRUPT_PRIORITY_INVALID() will result in an assertion\r
5148          * failure if a FreeRTOS API function is called from an interrupt that has\r
5149          * been assigned a priority above the configured maximum system call\r
5150          * priority.  Only FreeRTOS functions that end in FromISR can be called\r
5151          * from interrupts  that have been assigned a priority at or (logically)\r
5152          * below the maximum system call interrupt priority.  FreeRTOS maintains a\r
5153          * separate interrupt safe API to ensure interrupt entry is as fast and as\r
5154          * simple as possible.  More information (albeit Cortex-M specific) is\r
5155          * provided on the following link:\r
5156          * https://www.FreeRTOS.org/RTOS-Cortex-M3-M4.html */\r
5157         portASSERT_IF_INTERRUPT_PRIORITY_INVALID();\r
5158 \r
5159         pxTCB = xTaskToNotify;\r
5160 \r
5161         uxSavedInterruptStatus = portSET_INTERRUPT_MASK_FROM_ISR();\r
5162         {\r
5163             ucOriginalNotifyState = pxTCB->ucNotifyState[ uxIndexToNotify ];\r
5164             pxTCB->ucNotifyState[ uxIndexToNotify ] = taskNOTIFICATION_RECEIVED;\r
5165 \r
5166             /* 'Giving' is equivalent to incrementing a count in a counting\r
5167              * semaphore. */\r
5168             ( pxTCB->ulNotifiedValue[ uxIndexToNotify ] )++;\r
5169 \r
5170             traceTASK_NOTIFY_GIVE_FROM_ISR( uxIndexToNotify );\r
5171 \r
5172             /* If the task is in the blocked state specifically to wait for a\r
5173              * notification then unblock it now. */\r
5174             if( ucOriginalNotifyState == taskWAITING_NOTIFICATION )\r
5175             {\r
5176                 /* The task should not have been on an event list. */\r
5177                 configASSERT( listLIST_ITEM_CONTAINER( &( pxTCB->xEventListItem ) ) == NULL );\r
5178 \r
5179                 if( uxSchedulerSuspended == ( UBaseType_t ) pdFALSE )\r
5180                 {\r
5181                     listREMOVE_ITEM( &( pxTCB->xStateListItem ) );\r
5182                     prvAddTaskToReadyList( pxTCB );\r
5183                 }\r
5184                 else\r
5185                 {\r
5186                     /* The delayed and ready lists cannot be accessed, so hold\r
5187                      * this task pending until the scheduler is resumed. */\r
5188                     listINSERT_END( &( xPendingReadyList ), &( pxTCB->xEventListItem ) );\r
5189                 }\r
5190 \r
5191                 if( pxTCB->uxPriority > pxCurrentTCB->uxPriority )\r
5192                 {\r
5193                     /* The notified task has a priority above the currently\r
5194                      * executing task so a yield is required. */\r
5195                     if( pxHigherPriorityTaskWoken != NULL )\r
5196                     {\r
5197                         *pxHigherPriorityTaskWoken = pdTRUE;\r
5198                     }\r
5199 \r
5200                     /* Mark that a yield is pending in case the user is not\r
5201                      * using the "xHigherPriorityTaskWoken" parameter in an ISR\r
5202                      * safe FreeRTOS function. */\r
5203                     xYieldPending = pdTRUE;\r
5204                 }\r
5205                 else\r
5206                 {\r
5207                     mtCOVERAGE_TEST_MARKER();\r
5208                 }\r
5209             }\r
5210         }\r
5211         portCLEAR_INTERRUPT_MASK_FROM_ISR( uxSavedInterruptStatus );\r
5212     }\r
5213 \r
5214 #endif /* configUSE_TASK_NOTIFICATIONS */\r
5215 /*-----------------------------------------------------------*/\r
5216 \r
5217 #if ( configUSE_TASK_NOTIFICATIONS == 1 )\r
5218 \r
5219     BaseType_t xTaskGenericNotifyStateClear( TaskHandle_t xTask,\r
5220                                              UBaseType_t uxIndexToClear )\r
5221     {\r
5222         TCB_t * pxTCB;\r
5223         BaseType_t xReturn;\r
5224 \r
5225         configASSERT( uxIndexToClear < configTASK_NOTIFICATION_ARRAY_ENTRIES );\r
5226 \r
5227         /* If null is passed in here then it is the calling task that is having\r
5228          * its notification state cleared. */\r
5229         pxTCB = prvGetTCBFromHandle( xTask );\r
5230 \r
5231         taskENTER_CRITICAL();\r
5232         {\r
5233             if( pxTCB->ucNotifyState[ uxIndexToClear ] == taskNOTIFICATION_RECEIVED )\r
5234             {\r
5235                 pxTCB->ucNotifyState[ uxIndexToClear ] = taskNOT_WAITING_NOTIFICATION;\r
5236                 xReturn = pdPASS;\r
5237             }\r
5238             else\r
5239             {\r
5240                 xReturn = pdFAIL;\r
5241             }\r
5242         }\r
5243         taskEXIT_CRITICAL();\r
5244 \r
5245         return xReturn;\r
5246     }\r
5247 \r
5248 #endif /* configUSE_TASK_NOTIFICATIONS */\r
5249 /*-----------------------------------------------------------*/\r
5250 \r
5251 #if ( configUSE_TASK_NOTIFICATIONS == 1 )\r
5252 \r
5253     uint32_t ulTaskGenericNotifyValueClear( TaskHandle_t xTask,\r
5254                                             UBaseType_t uxIndexToClear,\r
5255                                             uint32_t ulBitsToClear )\r
5256     {\r
5257         TCB_t * pxTCB;\r
5258         uint32_t ulReturn;\r
5259 \r
5260         /* If null is passed in here then it is the calling task that is having\r
5261          * its notification state cleared. */\r
5262         pxTCB = prvGetTCBFromHandle( xTask );\r
5263 \r
5264         taskENTER_CRITICAL();\r
5265         {\r
5266             /* Return the notification as it was before the bits were cleared,\r
5267              * then clear the bit mask. */\r
5268             ulReturn = pxTCB->ulNotifiedValue[ uxIndexToClear ];\r
5269             pxTCB->ulNotifiedValue[ uxIndexToClear ] &= ~ulBitsToClear;\r
5270         }\r
5271         taskEXIT_CRITICAL();\r
5272 \r
5273         return ulReturn;\r
5274     }\r
5275 \r
5276 #endif /* configUSE_TASK_NOTIFICATIONS */\r
5277 /*-----------------------------------------------------------*/\r
5278 \r
5279 #if ( ( configGENERATE_RUN_TIME_STATS == 1 ) && ( INCLUDE_xTaskGetIdleTaskHandle == 1 ) )\r
5280 \r
5281     configRUN_TIME_COUNTER_TYPE ulTaskGetIdleRunTimeCounter( void )\r
5282     {\r
5283         return xIdleTaskHandle->ulRunTimeCounter;\r
5284     }\r
5285 \r
5286 #endif\r
5287 /*-----------------------------------------------------------*/\r
5288 \r
5289 #if ( ( configGENERATE_RUN_TIME_STATS == 1 ) && ( INCLUDE_xTaskGetIdleTaskHandle == 1 ) )\r
5290 \r
5291     configRUN_TIME_COUNTER_TYPE ulTaskGetIdleRunTimePercent( void )\r
5292     {\r
5293         configRUN_TIME_COUNTER_TYPE ulTotalTime, ulReturn;\r
5294 \r
5295         ulTotalTime = portGET_RUN_TIME_COUNTER_VALUE();\r
5296 \r
5297         /* For percentage calculations. */\r
5298         ulTotalTime /= ( configRUN_TIME_COUNTER_TYPE ) 100;\r
5299 \r
5300         /* Avoid divide by zero errors. */\r
5301         if( ulTotalTime > ( configRUN_TIME_COUNTER_TYPE ) 0 )\r
5302         {\r
5303             ulReturn = xIdleTaskHandle->ulRunTimeCounter / ulTotalTime;\r
5304         }\r
5305         else\r
5306         {\r
5307             ulReturn = 0;\r
5308         }\r
5309 \r
5310         return ulReturn;\r
5311     }\r
5312 \r
5313 #endif /* if ( ( configGENERATE_RUN_TIME_STATS == 1 ) && ( INCLUDE_xTaskGetIdleTaskHandle == 1 ) ) */\r
5314 /*-----------------------------------------------------------*/\r
5315 \r
5316 static void prvAddCurrentTaskToDelayedList( TickType_t xTicksToWait,\r
5317                                             const BaseType_t xCanBlockIndefinitely )\r
5318 {\r
5319     TickType_t xTimeToWake;\r
5320     const TickType_t xConstTickCount = xTickCount;\r
5321 \r
5322     #if ( INCLUDE_xTaskAbortDelay == 1 )\r
5323     {\r
5324         /* About to enter a delayed list, so ensure the ucDelayAborted flag is\r
5325          * reset to pdFALSE so it can be detected as having been set to pdTRUE\r
5326          * when the task leaves the Blocked state. */\r
5327         pxCurrentTCB->ucDelayAborted = pdFALSE;\r
5328     }\r
5329     #endif\r
5330 \r
5331     /* Remove the task from the ready list before adding it to the blocked list\r
5332      * as the same list item is used for both lists. */\r
5333     if( uxListRemove( &( pxCurrentTCB->xStateListItem ) ) == ( UBaseType_t ) 0 )\r
5334     {\r
5335         /* The current task must be in a ready list, so there is no need to\r
5336          * check, and the port reset macro can be called directly. */\r
5337         portRESET_READY_PRIORITY( pxCurrentTCB->uxPriority, uxTopReadyPriority ); /*lint !e931 pxCurrentTCB cannot change as it is the calling task.  pxCurrentTCB->uxPriority and uxTopReadyPriority cannot change as called with scheduler suspended or in a critical section. */\r
5338     }\r
5339     else\r
5340     {\r
5341         mtCOVERAGE_TEST_MARKER();\r
5342     }\r
5343 \r
5344     #if ( INCLUDE_vTaskSuspend == 1 )\r
5345     {\r
5346         if( ( xTicksToWait == portMAX_DELAY ) && ( xCanBlockIndefinitely != pdFALSE ) )\r
5347         {\r
5348             /* Add the task to the suspended task list instead of a delayed task\r
5349              * list to ensure it is not woken by a timing event.  It will block\r
5350              * indefinitely. */\r
5351             listINSERT_END( &xSuspendedTaskList, &( pxCurrentTCB->xStateListItem ) );\r
5352         }\r
5353         else\r
5354         {\r
5355             /* Calculate the time at which the task should be woken if the event\r
5356              * does not occur.  This may overflow but this doesn't matter, the\r
5357              * kernel will manage it correctly. */\r
5358             xTimeToWake = xConstTickCount + xTicksToWait;\r
5359 \r
5360             /* The list item will be inserted in wake time order. */\r
5361             listSET_LIST_ITEM_VALUE( &( pxCurrentTCB->xStateListItem ), xTimeToWake );\r
5362 \r
5363             if( xTimeToWake < xConstTickCount )\r
5364             {\r
5365                 /* Wake time has overflowed.  Place this item in the overflow\r
5366                  * list. */\r
5367                 vListInsert( pxOverflowDelayedTaskList, &( pxCurrentTCB->xStateListItem ) );\r
5368             }\r
5369             else\r
5370             {\r
5371                 /* The wake time has not overflowed, so the current block list\r
5372                  * is used. */\r
5373                 vListInsert( pxDelayedTaskList, &( pxCurrentTCB->xStateListItem ) );\r
5374 \r
5375                 /* If the task entering the blocked state was placed at the\r
5376                  * head of the list of blocked tasks then xNextTaskUnblockTime\r
5377                  * needs to be updated too. */\r
5378                 if( xTimeToWake < xNextTaskUnblockTime )\r
5379                 {\r
5380                     xNextTaskUnblockTime = xTimeToWake;\r
5381                 }\r
5382                 else\r
5383                 {\r
5384                     mtCOVERAGE_TEST_MARKER();\r
5385                 }\r
5386             }\r
5387         }\r
5388     }\r
5389     #else /* INCLUDE_vTaskSuspend */\r
5390     {\r
5391         /* Calculate the time at which the task should be woken if the event\r
5392          * does not occur.  This may overflow but this doesn't matter, the kernel\r
5393          * will manage it correctly. */\r
5394         xTimeToWake = xConstTickCount + xTicksToWait;\r
5395 \r
5396         /* The list item will be inserted in wake time order. */\r
5397         listSET_LIST_ITEM_VALUE( &( pxCurrentTCB->xStateListItem ), xTimeToWake );\r
5398 \r
5399         if( xTimeToWake < xConstTickCount )\r
5400         {\r
5401             /* Wake time has overflowed.  Place this item in the overflow list. */\r
5402             vListInsert( pxOverflowDelayedTaskList, &( pxCurrentTCB->xStateListItem ) );\r
5403         }\r
5404         else\r
5405         {\r
5406             /* The wake time has not overflowed, so the current block list is used. */\r
5407             vListInsert( pxDelayedTaskList, &( pxCurrentTCB->xStateListItem ) );\r
5408 \r
5409             /* If the task entering the blocked state was placed at the head of the\r
5410              * list of blocked tasks then xNextTaskUnblockTime needs to be updated\r
5411              * too. */\r
5412             if( xTimeToWake < xNextTaskUnblockTime )\r
5413             {\r
5414                 xNextTaskUnblockTime = xTimeToWake;\r
5415             }\r
5416             else\r
5417             {\r
5418                 mtCOVERAGE_TEST_MARKER();\r
5419             }\r
5420         }\r
5421 \r
5422         /* Avoid compiler warning when INCLUDE_vTaskSuspend is not 1. */\r
5423         ( void ) xCanBlockIndefinitely;\r
5424     }\r
5425     #endif /* INCLUDE_vTaskSuspend */\r
5426 }\r
5427 \r
5428 /* Code below here allows additional code to be inserted into this source file,\r
5429  * especially where access to file scope functions and data is needed (for example\r
5430  * when performing module tests). */\r
5431 \r
5432 #ifdef FREERTOS_MODULE_TEST\r
5433     #include "tasks_test_access_functions.h"\r
5434 #endif\r
5435 \r
5436 \r
5437 #if ( configINCLUDE_FREERTOS_TASK_C_ADDITIONS_H == 1 )\r
5438 \r
5439     #include "freertos_tasks_c_additions.h"\r
5440 \r
5441     #ifdef FREERTOS_TASKS_C_ADDITIONS_INIT\r
5442         static void freertos_tasks_c_additions_init( void )\r
5443         {\r
5444             FREERTOS_TASKS_C_ADDITIONS_INIT();\r
5445         }\r
5446     #endif\r
5447 \r
5448 #endif /* if ( configINCLUDE_FREERTOS_TASK_C_ADDITIONS_H == 1 ) */\r