2 * FreeRTOS Kernel <DEVELOPMENT BRANCH>
3 * Copyright (C) 2021 Amazon.com, Inc. or its affiliates. All Rights Reserved.
5 * SPDX-License-Identifier: MIT
7 * Permission is hereby granted, free of charge, to any person obtaining a copy of
8 * this software and associated documentation files (the "Software"), to deal in
9 * the Software without restriction, including without limitation the rights to
10 * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
11 * the Software, and to permit persons to whom the Software is furnished to do so,
12 * subject to the following conditions:
14 * The above copyright notice and this permission notice shall be included in all
15 * copies or substantial portions of the Software.
17 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
19 * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
20 * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
21 * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
22 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
24 * https://www.FreeRTOS.org
25 * https://github.com/FreeRTOS
29 /* Standard includes. */
33 /* Defining MPU_WRAPPERS_INCLUDED_FROM_API_FILE prevents task.h from redefining
34 * all the API functions to use the MPU wrappers. That should only be done when
35 * task.h is included from an application file. */
36 #define MPU_WRAPPERS_INCLUDED_FROM_API_FILE
38 /* FreeRTOS includes. */
42 #include "stack_macros.h"
44 /* Lint e9021, e961 and e750 are suppressed as a MISRA exception justified
45 * because the MPU ports require MPU_WRAPPERS_INCLUDED_FROM_API_FILE to be defined
46 * for the header files above, but not in this file, in order to generate the
47 * correct privileged Vs unprivileged linkage and placement. */
48 #undef MPU_WRAPPERS_INCLUDED_FROM_API_FILE /*lint !e961 !e750 !e9021. */
50 /* Set configUSE_STATS_FORMATTING_FUNCTIONS to 2 to include the stats formatting
51 * functions but without including stdio.h here. */
52 #if ( configUSE_STATS_FORMATTING_FUNCTIONS == 1 )
54 /* At the bottom of this file are two optional functions that can be used
55 * to generate human readable text from the raw data generated by the
56 * uxTaskGetSystemState() function. Note the formatting functions are provided
57 * for convenience only, and are NOT considered part of the kernel. */
59 #endif /* configUSE_STATS_FORMATTING_FUNCTIONS == 1 ) */
61 #if ( configUSE_PREEMPTION == 0 )
63 /* If the cooperative scheduler is being used then a yield should not be
64 * performed just because a higher priority task has been woken. */
65 #define taskYIELD_TASK_CORE_IF_USING_PREEMPTION( pxTCB )
66 #define taskYIELD_ANY_CORE_IF_USING_PREEMPTION( pxTCB )
69 #if ( configNUMBER_OF_CORES == 1 )
71 /* This macro requests the running task pxTCB to yield. In single core
72 * scheduler, a running task always runs on core 0 and portYIELD_WITHIN_API()
73 * can be used to request the task running on core 0 to yield. Therefore, pxTCB
74 * is not used in this macro. */
75 #define taskYIELD_TASK_CORE_IF_USING_PREEMPTION( pxTCB ) \
78 portYIELD_WITHIN_API(); \
81 #define taskYIELD_ANY_CORE_IF_USING_PREEMPTION( pxTCB ) \
83 if( pxCurrentTCB->uxPriority < ( pxTCB )->uxPriority ) \
85 portYIELD_WITHIN_API(); \
89 mtCOVERAGE_TEST_MARKER(); \
93 #else /* if ( configNUMBER_OF_CORES == 1 ) */
95 /* Yield the core on which this task is running. */
96 #define taskYIELD_TASK_CORE_IF_USING_PREEMPTION( pxTCB ) prvYieldCore( ( pxTCB )->xTaskRunState )
98 /* Yield for the task if a running task has priority lower than this task. */
99 #define taskYIELD_ANY_CORE_IF_USING_PREEMPTION( pxTCB ) prvYieldForTask( pxTCB )
101 #endif /* #if ( configNUMBER_OF_CORES == 1 ) */
103 #endif /* if ( configUSE_PREEMPTION == 0 ) */
105 /* Values that can be assigned to the ucNotifyState member of the TCB. */
106 #define taskNOT_WAITING_NOTIFICATION ( ( uint8_t ) 0 ) /* Must be zero as it is the initialised value. */
107 #define taskWAITING_NOTIFICATION ( ( uint8_t ) 1 )
108 #define taskNOTIFICATION_RECEIVED ( ( uint8_t ) 2 )
111 * The value used to fill the stack of a task when the task is created. This
112 * is used purely for checking the high water mark for tasks.
114 #define tskSTACK_FILL_BYTE ( 0xa5U )
116 /* Bits used to record how a task's stack and TCB were allocated. */
117 #define tskDYNAMICALLY_ALLOCATED_STACK_AND_TCB ( ( uint8_t ) 0 )
118 #define tskSTATICALLY_ALLOCATED_STACK_ONLY ( ( uint8_t ) 1 )
119 #define tskSTATICALLY_ALLOCATED_STACK_AND_TCB ( ( uint8_t ) 2 )
121 /* If any of the following are set then task stacks are filled with a known
122 * value so the high water mark can be determined. If none of the following are
123 * set then don't fill the stack so there is no unnecessary dependency on memset. */
124 #if ( ( configCHECK_FOR_STACK_OVERFLOW > 1 ) || ( configUSE_TRACE_FACILITY == 1 ) || ( INCLUDE_uxTaskGetStackHighWaterMark == 1 ) || ( INCLUDE_uxTaskGetStackHighWaterMark2 == 1 ) )
125 #define tskSET_NEW_STACKS_TO_KNOWN_VALUE 1
127 #define tskSET_NEW_STACKS_TO_KNOWN_VALUE 0
131 * Macros used by vListTask to indicate which state a task is in.
133 #define tskRUNNING_CHAR ( 'X' )
134 #define tskBLOCKED_CHAR ( 'B' )
135 #define tskREADY_CHAR ( 'R' )
136 #define tskDELETED_CHAR ( 'D' )
137 #define tskSUSPENDED_CHAR ( 'S' )
140 * Some kernel aware debuggers require the data the debugger needs access to to
141 * be global, rather than file scope.
143 #ifdef portREMOVE_STATIC_QUALIFIER
147 /* The name allocated to the Idle task. This can be overridden by defining
148 * configIDLE_TASK_NAME in FreeRTOSConfig.h. */
149 #ifndef configIDLE_TASK_NAME
150 #define configIDLE_TASK_NAME "IDLE"
153 #if ( configUSE_PORT_OPTIMISED_TASK_SELECTION == 0 )
155 /* If configUSE_PORT_OPTIMISED_TASK_SELECTION is 0 then task selection is
156 * performed in a generic way that is not optimised to any particular
157 * microcontroller architecture. */
159 /* uxTopReadyPriority holds the priority of the highest priority ready
161 #define taskRECORD_READY_PRIORITY( uxPriority ) \
163 if( ( uxPriority ) > uxTopReadyPriority ) \
165 uxTopReadyPriority = ( uxPriority ); \
167 } while( 0 ) /* taskRECORD_READY_PRIORITY */
169 /*-----------------------------------------------------------*/
171 #if ( configNUMBER_OF_CORES == 1 )
172 #define taskSELECT_HIGHEST_PRIORITY_TASK() \
174 UBaseType_t uxTopPriority = uxTopReadyPriority; \
176 /* Find the highest priority queue that contains ready tasks. */ \
177 while( listLIST_IS_EMPTY( &( pxReadyTasksLists[ uxTopPriority ] ) ) ) \
179 configASSERT( uxTopPriority ); \
183 /* listGET_OWNER_OF_NEXT_ENTRY indexes through the list, so the tasks of \
184 * the same priority get an equal share of the processor time. */ \
185 listGET_OWNER_OF_NEXT_ENTRY( pxCurrentTCB, &( pxReadyTasksLists[ uxTopPriority ] ) ); \
186 uxTopReadyPriority = uxTopPriority; \
187 } while( 0 ) /* taskSELECT_HIGHEST_PRIORITY_TASK */
188 #else /* if ( configNUMBER_OF_CORES == 1 ) */
190 #define taskSELECT_HIGHEST_PRIORITY_TASK( xCoreID ) prvSelectHighestPriorityTask( xCoreID )
192 #endif /* if ( configNUMBER_OF_CORES == 1 ) */
194 /*-----------------------------------------------------------*/
196 /* Define away taskRESET_READY_PRIORITY() and portRESET_READY_PRIORITY() as
197 * they are only required when a port optimised method of task selection is
199 #define taskRESET_READY_PRIORITY( uxPriority )
200 #define portRESET_READY_PRIORITY( uxPriority, uxTopReadyPriority )
202 #else /* configUSE_PORT_OPTIMISED_TASK_SELECTION */
204 /* If configUSE_PORT_OPTIMISED_TASK_SELECTION is 1 then task selection is
205 * performed in a way that is tailored to the particular microcontroller
206 * architecture being used. */
208 /* A port optimised version is provided. Call the port defined macros. */
209 #define taskRECORD_READY_PRIORITY( uxPriority ) portRECORD_READY_PRIORITY( ( uxPriority ), uxTopReadyPriority )
211 /*-----------------------------------------------------------*/
213 #define taskSELECT_HIGHEST_PRIORITY_TASK() \
215 UBaseType_t uxTopPriority; \
217 /* Find the highest priority list that contains ready tasks. */ \
218 portGET_HIGHEST_PRIORITY( uxTopPriority, uxTopReadyPriority ); \
219 configASSERT( listCURRENT_LIST_LENGTH( &( pxReadyTasksLists[ uxTopPriority ] ) ) > 0 ); \
220 listGET_OWNER_OF_NEXT_ENTRY( pxCurrentTCB, &( pxReadyTasksLists[ uxTopPriority ] ) ); \
223 /*-----------------------------------------------------------*/
225 /* A port optimised version is provided, call it only if the TCB being reset
226 * is being referenced from a ready list. If it is referenced from a delayed
227 * or suspended list then it won't be in a ready list. */
228 #define taskRESET_READY_PRIORITY( uxPriority ) \
230 if( listCURRENT_LIST_LENGTH( &( pxReadyTasksLists[ ( uxPriority ) ] ) ) == ( UBaseType_t ) 0 ) \
232 portRESET_READY_PRIORITY( ( uxPriority ), ( uxTopReadyPriority ) ); \
236 #endif /* configUSE_PORT_OPTIMISED_TASK_SELECTION */
238 /*-----------------------------------------------------------*/
240 /* pxDelayedTaskList and pxOverflowDelayedTaskList are switched when the tick
241 * count overflows. */
242 #define taskSWITCH_DELAYED_LISTS() \
246 /* The delayed tasks list should be empty when the lists are switched. */ \
247 configASSERT( ( listLIST_IS_EMPTY( pxDelayedTaskList ) ) ); \
249 pxTemp = pxDelayedTaskList; \
250 pxDelayedTaskList = pxOverflowDelayedTaskList; \
251 pxOverflowDelayedTaskList = pxTemp; \
253 prvResetNextTaskUnblockTime(); \
256 /*-----------------------------------------------------------*/
259 * Place the task represented by pxTCB into the appropriate ready list for
260 * the task. It is inserted at the end of the list.
262 #define prvAddTaskToReadyList( pxTCB ) \
264 traceMOVED_TASK_TO_READY_STATE( pxTCB ); \
265 taskRECORD_READY_PRIORITY( ( pxTCB )->uxPriority ); \
266 listINSERT_END( &( pxReadyTasksLists[ ( pxTCB )->uxPriority ] ), &( ( pxTCB )->xStateListItem ) ); \
267 tracePOST_MOVED_TASK_TO_READY_STATE( pxTCB ); \
269 /*-----------------------------------------------------------*/
272 * Several functions take a TaskHandle_t parameter that can optionally be NULL,
273 * where NULL is used to indicate that the handle of the currently executing
274 * task should be used in place of the parameter. This macro simply checks to
275 * see if the parameter is NULL and returns a pointer to the appropriate TCB.
277 #define prvGetTCBFromHandle( pxHandle ) ( ( ( pxHandle ) == NULL ) ? pxCurrentTCB : ( pxHandle ) )
279 /* The item value of the event list item is normally used to hold the priority
280 * of the task to which it belongs (coded to allow it to be held in reverse
281 * priority order). However, it is occasionally borrowed for other purposes. It
282 * is important its value is not updated due to a task priority change while it is
283 * being used for another purpose. The following bit definition is used to inform
284 * the scheduler that the value should not be changed - in which case it is the
285 * responsibility of whichever module is using the value to ensure it gets set back
286 * to its original value when it is released. */
287 #if ( configTICK_TYPE_WIDTH_IN_BITS == TICK_TYPE_WIDTH_16_BITS )
288 #define taskEVENT_LIST_ITEM_VALUE_IN_USE 0x8000U
289 #elif ( configTICK_TYPE_WIDTH_IN_BITS == TICK_TYPE_WIDTH_32_BITS )
290 #define taskEVENT_LIST_ITEM_VALUE_IN_USE 0x80000000UL
291 #elif ( configTICK_TYPE_WIDTH_IN_BITS == TICK_TYPE_WIDTH_64_BITS )
292 #define taskEVENT_LIST_ITEM_VALUE_IN_USE 0x8000000000000000ULL
295 /* Indicates that the task is not actively running on any core. */
296 #define taskTASK_NOT_RUNNING ( ( BaseType_t ) ( -1 ) )
298 /* Indicates that the task is actively running but scheduled to yield. */
299 #define taskTASK_SCHEDULED_TO_YIELD ( ( BaseType_t ) ( -2 ) )
301 /* Returns pdTRUE if the task is actively running and not scheduled to yield. */
302 #if ( configNUMBER_OF_CORES == 1 )
303 #define taskTASK_IS_RUNNING( pxTCB ) ( ( ( pxTCB ) == pxCurrentTCB ) ? ( pdTRUE ) : ( pdFALSE ) )
304 #define taskTASK_IS_RUNNING_OR_SCHEDULED_TO_YIELD( pxTCB ) ( ( ( pxTCB ) == pxCurrentTCB ) ? ( pdTRUE ) : ( pdFALSE ) )
306 #define taskTASK_IS_RUNNING( pxTCB ) ( ( ( ( pxTCB )->xTaskRunState >= ( BaseType_t ) 0 ) && ( ( pxTCB )->xTaskRunState < ( BaseType_t ) configNUMBER_OF_CORES ) ) ? ( pdTRUE ) : ( pdFALSE ) )
307 #define taskTASK_IS_RUNNING_OR_SCHEDULED_TO_YIELD( pxTCB ) ( ( ( pxTCB )->xTaskRunState != taskTASK_NOT_RUNNING ) ? ( pdTRUE ) : ( pdFALSE ) )
310 /* Indicates that the task is an Idle task. */
311 #define taskATTRIBUTE_IS_IDLE ( UBaseType_t ) ( 1UL << 0UL )
313 #if ( ( configNUMBER_OF_CORES > 1 ) && ( portCRITICAL_NESTING_IN_TCB == 1 ) )
314 #define portGET_CRITICAL_NESTING_COUNT() ( pxCurrentTCBs[ portGET_CORE_ID() ]->uxCriticalNesting )
315 #define portSET_CRITICAL_NESTING_COUNT( x ) ( pxCurrentTCBs[ portGET_CORE_ID() ]->uxCriticalNesting = ( x ) )
316 #define portINCREMENT_CRITICAL_NESTING_COUNT() ( pxCurrentTCBs[ portGET_CORE_ID() ]->uxCriticalNesting++ )
317 #define portDECREMENT_CRITICAL_NESTING_COUNT() ( pxCurrentTCBs[ portGET_CORE_ID() ]->uxCriticalNesting-- )
318 #endif /* #if ( ( configNUMBER_OF_CORES > 1 ) && ( portCRITICAL_NESTING_IN_TCB == 1 ) ) */
320 #define taskBITS_PER_BYTE ( ( size_t ) 8 )
322 #if ( configNUMBER_OF_CORES > 1 )
324 /* Yields the given core. This must be called from a critical section and xCoreID
325 * must be valid. This macro is not required in single core since there is only
326 * one core to yield. */
327 #define prvYieldCore( xCoreID ) \
329 if( xCoreID == ( BaseType_t ) portGET_CORE_ID() ) \
331 /* Pending a yield for this core since it is in the critical section. */ \
332 xYieldPendings[ xCoreID ] = pdTRUE; \
336 /* Request other core to yield if it is not requested before. */ \
337 if( pxCurrentTCBs[ xCoreID ]->xTaskRunState != taskTASK_SCHEDULED_TO_YIELD ) \
339 portYIELD_CORE( xCoreID ); \
340 pxCurrentTCBs[ xCoreID ]->xTaskRunState = taskTASK_SCHEDULED_TO_YIELD; \
344 #endif /* #if ( configNUMBER_OF_CORES > 1 ) */
345 /*-----------------------------------------------------------*/
348 * Task control block. A task control block (TCB) is allocated for each task,
349 * and stores task state information, including a pointer to the task's context
350 * (the task's run time environment, including register values)
352 typedef struct tskTaskControlBlock /* The old naming convention is used to prevent breaking kernel aware debuggers. */
354 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. */
356 #if ( portUSING_MPU_WRAPPERS == 1 )
357 xMPU_SETTINGS xMPUSettings; /**< The MPU settings are defined as part of the port layer. THIS MUST BE THE SECOND MEMBER OF THE TCB STRUCT. */
360 #if ( configUSE_CORE_AFFINITY == 1 ) && ( configNUMBER_OF_CORES > 1 )
361 UBaseType_t uxCoreAffinityMask; /**< Used to link the task to certain cores. UBaseType_t must have greater than or equal to the number of bits as configNUMBER_OF_CORES. */
364 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 ). */
365 ListItem_t xEventListItem; /**< Used to reference a task from an event list. */
366 UBaseType_t uxPriority; /**< The priority of the task. 0 is the lowest priority. */
367 StackType_t * pxStack; /**< Points to the start of the stack. */
368 #if ( configNUMBER_OF_CORES > 1 )
369 volatile BaseType_t xTaskRunState; /**< Used to identify the core the task is running on, if the task is running. Otherwise, identifies the task's state - not running or yielding. */
370 UBaseType_t uxTaskAttributes; /**< Task's attributes - currently used to identify the idle tasks. */
372 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. */
374 #if ( configUSE_TASK_PREEMPTION_DISABLE == 1 )
375 BaseType_t xPreemptionDisable; /**< Used to prevent the task from being preempted. */
378 #if ( ( portSTACK_GROWTH > 0 ) || ( configRECORD_STACK_HIGH_ADDRESS == 1 ) )
379 StackType_t * pxEndOfStack; /**< Points to the highest valid address for the stack. */
382 #if ( portCRITICAL_NESTING_IN_TCB == 1 )
383 UBaseType_t uxCriticalNesting; /**< Holds the critical section nesting depth for ports that do not maintain their own count in the port layer. */
386 #if ( configUSE_TRACE_FACILITY == 1 )
387 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. */
388 UBaseType_t uxTaskNumber; /**< Stores a number specifically for use by third party trace code. */
391 #if ( configUSE_MUTEXES == 1 )
392 UBaseType_t uxBasePriority; /**< The priority last assigned to the task - used by the priority inheritance mechanism. */
393 UBaseType_t uxMutexesHeld;
396 #if ( configUSE_APPLICATION_TASK_TAG == 1 )
397 TaskHookFunction_t pxTaskTag;
400 #if ( configNUM_THREAD_LOCAL_STORAGE_POINTERS > 0 )
401 void * pvThreadLocalStoragePointers[ configNUM_THREAD_LOCAL_STORAGE_POINTERS ];
404 #if ( configGENERATE_RUN_TIME_STATS == 1 )
405 configRUN_TIME_COUNTER_TYPE ulRunTimeCounter; /**< Stores the amount of time the task has spent in the Running state. */
408 #if ( configUSE_C_RUNTIME_TLS_SUPPORT == 1 )
409 configTLS_BLOCK_TYPE xTLSBlock; /**< Memory block used as Thread Local Storage (TLS) Block for the task. */
412 #if ( configUSE_TASK_NOTIFICATIONS == 1 )
413 volatile uint32_t ulNotifiedValue[ configTASK_NOTIFICATION_ARRAY_ENTRIES ];
414 volatile uint8_t ucNotifyState[ configTASK_NOTIFICATION_ARRAY_ENTRIES ];
417 /* See the comments in FreeRTOS.h with the definition of
418 * tskSTATIC_AND_DYNAMIC_ALLOCATION_POSSIBLE. */
419 #if ( tskSTATIC_AND_DYNAMIC_ALLOCATION_POSSIBLE != 0 ) /*lint !e731 !e9029 Macro has been consolidated for readability reasons. */
420 uint8_t ucStaticallyAllocated; /**< Set to pdTRUE if the task is a statically allocated to ensure no attempt is made to free the memory. */
423 #if ( INCLUDE_xTaskAbortDelay == 1 )
424 uint8_t ucDelayAborted;
427 #if ( configUSE_POSIX_ERRNO == 1 )
432 /* The old tskTCB name is maintained above then typedefed to the new TCB_t name
433 * below to enable the use of older kernel aware debuggers. */
434 typedef tskTCB TCB_t;
436 /*lint -save -e956 A manual analysis and inspection has been used to determine
437 * which static variables must be declared volatile. */
438 #if ( configNUMBER_OF_CORES == 1 )
439 portDONT_DISCARD PRIVILEGED_DATA TCB_t * volatile pxCurrentTCB = NULL;
441 /* MISRA Ref 8.4.1 [Declaration shall be visible] */
442 /* More details at: https://github.com/FreeRTOS/FreeRTOS-Kernel/blob/main/MISRA.md#rule-84 */
443 /* coverity[misra_c_2012_rule_8_4_violation] */
444 portDONT_DISCARD PRIVILEGED_DATA TCB_t * volatile pxCurrentTCBs[ configNUMBER_OF_CORES ];
445 #define pxCurrentTCB xTaskGetCurrentTaskHandle()
448 /* Lists for ready and blocked tasks. --------------------
449 * xDelayedTaskList1 and xDelayedTaskList2 could be moved to function scope but
450 * doing so breaks some kernel aware debuggers and debuggers that rely on removing
451 * the static qualifier. */
452 PRIVILEGED_DATA static List_t pxReadyTasksLists[ configMAX_PRIORITIES ]; /**< Prioritised ready tasks. */
453 PRIVILEGED_DATA static List_t xDelayedTaskList1; /**< Delayed tasks. */
454 PRIVILEGED_DATA static List_t xDelayedTaskList2; /**< Delayed tasks (two lists are used - one for delays that have overflowed the current tick count. */
455 PRIVILEGED_DATA static List_t * volatile pxDelayedTaskList; /**< Points to the delayed task list currently being used. */
456 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. */
457 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. */
459 #if ( INCLUDE_vTaskDelete == 1 )
461 PRIVILEGED_DATA static List_t xTasksWaitingTermination; /**< Tasks that have been deleted - but their memory not yet freed. */
462 PRIVILEGED_DATA static volatile UBaseType_t uxDeletedTasksWaitingCleanUp = ( UBaseType_t ) 0U;
466 #if ( INCLUDE_vTaskSuspend == 1 )
468 PRIVILEGED_DATA static List_t xSuspendedTaskList; /**< Tasks that are currently suspended. */
472 /* Global POSIX errno. Its value is changed upon context switching to match
473 * the errno of the currently running task. */
474 #if ( configUSE_POSIX_ERRNO == 1 )
475 int FreeRTOS_errno = 0;
478 /* Other file private variables. --------------------------------*/
479 PRIVILEGED_DATA static volatile UBaseType_t uxCurrentNumberOfTasks = ( UBaseType_t ) 0U;
480 PRIVILEGED_DATA static volatile TickType_t xTickCount = ( TickType_t ) configINITIAL_TICK_COUNT;
481 PRIVILEGED_DATA static volatile UBaseType_t uxTopReadyPriority = tskIDLE_PRIORITY;
482 PRIVILEGED_DATA static volatile BaseType_t xSchedulerRunning = pdFALSE;
483 PRIVILEGED_DATA static volatile TickType_t xPendedTicks = ( TickType_t ) 0U;
484 PRIVILEGED_DATA static volatile BaseType_t xYieldPendings[ configNUMBER_OF_CORES ] = { pdFALSE };
485 PRIVILEGED_DATA static volatile BaseType_t xNumOfOverflows = ( BaseType_t ) 0;
486 PRIVILEGED_DATA static UBaseType_t uxTaskNumber = ( UBaseType_t ) 0U;
487 PRIVILEGED_DATA static volatile TickType_t xNextTaskUnblockTime = ( TickType_t ) 0U; /* Initialised to portMAX_DELAY before the scheduler starts. */
488 PRIVILEGED_DATA static TaskHandle_t xIdleTaskHandles[ configNUMBER_OF_CORES ]; /**< Holds the handles of the idle tasks. The idle tasks are created automatically when the scheduler is started. */
490 /* Improve support for OpenOCD. The kernel tracks Ready tasks via priority lists.
491 * For tracking the state of remote threads, OpenOCD uses uxTopUsedPriority
492 * to determine the number of priority lists to read back from the remote target. */
493 const volatile UBaseType_t uxTopUsedPriority = configMAX_PRIORITIES - 1U;
495 /* Context switches are held pending while the scheduler is suspended. Also,
496 * interrupts must not manipulate the xStateListItem of a TCB, or any of the
497 * lists the xStateListItem can be referenced from, if the scheduler is suspended.
498 * If an interrupt needs to unblock a task while the scheduler is suspended then it
499 * moves the task's event list item into the xPendingReadyList, ready for the
500 * kernel to move the task from the pending ready list into the real ready list
501 * when the scheduler is unsuspended. The pending ready list itself can only be
502 * accessed from a critical section.
504 * Updates to uxSchedulerSuspended must be protected by both the task lock and the ISR lock
505 * and must not be done from an ISR. Reads must be protected by either lock and may be done
506 * from either an ISR or a task. */
507 PRIVILEGED_DATA static volatile UBaseType_t uxSchedulerSuspended = ( UBaseType_t ) 0U;
509 #if ( configGENERATE_RUN_TIME_STATS == 1 )
511 /* Do not move these variables to function scope as doing so prevents the
512 * code working with debuggers that need to remove the static qualifier. */
513 PRIVILEGED_DATA static configRUN_TIME_COUNTER_TYPE ulTaskSwitchedInTime[ configNUMBER_OF_CORES ] = { 0U }; /**< Holds the value of a timer/counter the last time a task was switched in. */
514 PRIVILEGED_DATA static volatile configRUN_TIME_COUNTER_TYPE ulTotalRunTime[ configNUMBER_OF_CORES ] = { 0U }; /**< Holds the total amount of execution time as defined by the run time counter clock. */
520 /*-----------------------------------------------------------*/
522 /* File private functions. --------------------------------*/
525 * Creates the idle tasks during scheduler start.
527 static BaseType_t prvCreateIdleTasks( void );
529 #if ( configNUMBER_OF_CORES > 1 )
532 * Checks to see if another task moved the current task out of the ready
533 * list while it was waiting to enter a critical section and yields, if so.
535 static void prvCheckForRunStateChange( void );
536 #endif /* #if ( configNUMBER_OF_CORES > 1 ) */
538 #if ( configNUMBER_OF_CORES > 1 )
541 * Yields a core, or cores if multiple priorities are not allowed to run
542 * simultaneously, to allow the task pxTCB to run.
544 static void prvYieldForTask( const TCB_t * pxTCB );
545 #endif /* #if ( configNUMBER_OF_CORES > 1 ) */
547 #if ( configNUMBER_OF_CORES > 1 )
550 * Selects the highest priority available task for the given core.
552 static void prvSelectHighestPriorityTask( BaseType_t xCoreID );
553 #endif /* #if ( configNUMBER_OF_CORES > 1 ) */
556 * Utility task that simply returns pdTRUE if the task referenced by xTask is
557 * currently in the Suspended state, or pdFALSE if the task referenced by xTask
558 * is in any other state.
560 #if ( INCLUDE_vTaskSuspend == 1 )
562 static BaseType_t prvTaskIsTaskSuspended( const TaskHandle_t xTask ) PRIVILEGED_FUNCTION;
564 #endif /* INCLUDE_vTaskSuspend */
567 * Utility to ready all the lists used by the scheduler. This is called
568 * automatically upon the creation of the first task.
570 static void prvInitialiseTaskLists( void ) PRIVILEGED_FUNCTION;
573 * The idle task, which as all tasks is implemented as a never ending loop.
574 * The idle task is automatically created and added to the ready lists upon
575 * creation of the first user task.
577 * In the FreeRTOS SMP, configNUMBER_OF_CORES - 1 passive idle tasks are also
578 * created to ensure that each core has an idle task to run when no other
579 * task is available to run.
581 * The portTASK_FUNCTION_PROTO() macro is used to allow port/compiler specific
582 * language extensions. The equivalent prototype for these functions are:
584 * void prvIdleTask( void *pvParameters );
585 * void prvPassiveIdleTask( void *pvParameters );
588 static portTASK_FUNCTION_PROTO( prvIdleTask, pvParameters ) PRIVILEGED_FUNCTION;
589 #if ( configNUMBER_OF_CORES > 1 )
590 static portTASK_FUNCTION_PROTO( prvPassiveIdleTask, pvParameters ) PRIVILEGED_FUNCTION;
594 * Utility to free all memory allocated by the scheduler to hold a TCB,
595 * including the stack pointed to by the TCB.
597 * This does not free memory allocated by the task itself (i.e. memory
598 * allocated by calls to pvPortMalloc from within the tasks application code).
600 #if ( INCLUDE_vTaskDelete == 1 )
602 static void prvDeleteTCB( TCB_t * pxTCB ) PRIVILEGED_FUNCTION;
607 * Used only by the idle task. This checks to see if anything has been placed
608 * in the list of tasks waiting to be deleted. If so the task is cleaned up
609 * and its TCB deleted.
611 static void prvCheckTasksWaitingTermination( void ) PRIVILEGED_FUNCTION;
614 * The currently executing task is entering the Blocked state. Add the task to
615 * either the current or the overflow delayed task list.
617 static void prvAddCurrentTaskToDelayedList( TickType_t xTicksToWait,
618 const BaseType_t xCanBlockIndefinitely ) PRIVILEGED_FUNCTION;
621 * Fills an TaskStatus_t structure with information on each task that is
622 * referenced from the pxList list (which may be a ready list, a delayed list,
623 * a suspended list, etc.).
625 * THIS FUNCTION IS INTENDED FOR DEBUGGING ONLY, AND SHOULD NOT BE CALLED FROM
626 * NORMAL APPLICATION CODE.
628 #if ( configUSE_TRACE_FACILITY == 1 )
630 static UBaseType_t prvListTasksWithinSingleList( TaskStatus_t * pxTaskStatusArray,
632 eTaskState eState ) PRIVILEGED_FUNCTION;
637 * Searches pxList for a task with name pcNameToQuery - returning a handle to
638 * the task if it is found, or NULL if the task is not found.
640 #if ( INCLUDE_xTaskGetHandle == 1 )
642 static TCB_t * prvSearchForNameWithinSingleList( List_t * pxList,
643 const char pcNameToQuery[] ) PRIVILEGED_FUNCTION;
648 * When a task is created, the stack of the task is filled with a known value.
649 * This function determines the 'high water mark' of the task stack by
650 * determining how much of the stack remains at the original preset value.
652 #if ( ( configUSE_TRACE_FACILITY == 1 ) || ( INCLUDE_uxTaskGetStackHighWaterMark == 1 ) || ( INCLUDE_uxTaskGetStackHighWaterMark2 == 1 ) )
654 static configSTACK_DEPTH_TYPE prvTaskCheckFreeStackSpace( const uint8_t * pucStackByte ) PRIVILEGED_FUNCTION;
659 * Return the amount of time, in ticks, that will pass before the kernel will
660 * next move a task from the Blocked state to the Running state.
662 * This conditional compilation should use inequality to 0, not equality to 1.
663 * This is to ensure portSUPPRESS_TICKS_AND_SLEEP() can be called when user
664 * defined low power mode implementations require configUSE_TICKLESS_IDLE to be
665 * set to a value other than 1.
667 #if ( configUSE_TICKLESS_IDLE != 0 )
669 static TickType_t prvGetExpectedIdleTime( void ) PRIVILEGED_FUNCTION;
674 * Set xNextTaskUnblockTime to the time at which the next Blocked state task
675 * will exit the Blocked state.
677 static void prvResetNextTaskUnblockTime( void ) PRIVILEGED_FUNCTION;
679 #if ( configUSE_STATS_FORMATTING_FUNCTIONS > 0 )
682 * Helper function used to pad task names with spaces when printing out
683 * human readable tables of task information.
685 static char * prvWriteNameToBuffer( char * pcBuffer,
686 const char * pcTaskName ) PRIVILEGED_FUNCTION;
691 * Called after a Task_t structure has been allocated either statically or
692 * dynamically to fill in the structure's members.
694 static void prvInitialiseNewTask( TaskFunction_t pxTaskCode,
695 const char * const pcName, /*lint !e971 Unqualified char types are allowed for strings and single characters only. */
696 const uint32_t ulStackDepth,
697 void * const pvParameters,
698 UBaseType_t uxPriority,
699 TaskHandle_t * const pxCreatedTask,
701 const MemoryRegion_t * const xRegions ) PRIVILEGED_FUNCTION;
704 * Called after a new task has been created and initialised to place the task
705 * under the control of the scheduler.
707 static void prvAddNewTaskToReadyList( TCB_t * pxNewTCB ) PRIVILEGED_FUNCTION;
710 * Create a task with static buffer for both TCB and stack. Returns a handle to
711 * the task if it is created successfully. Otherwise, returns NULL.
713 #if ( configSUPPORT_STATIC_ALLOCATION == 1 )
714 static TCB_t * prvCreateStaticTask( TaskFunction_t pxTaskCode,
715 const char * const pcName, /*lint !e971 Unqualified char types are allowed for strings and single characters only. */
716 const uint32_t ulStackDepth,
717 void * const pvParameters,
718 UBaseType_t uxPriority,
719 StackType_t * const puxStackBuffer,
720 StaticTask_t * const pxTaskBuffer,
721 TaskHandle_t * const pxCreatedTask ) PRIVILEGED_FUNCTION;
722 #endif /* #if ( configSUPPORT_STATIC_ALLOCATION == 1 ) */
725 * Create a restricted task with static buffer for both TCB and stack. Returns
726 * a handle to the task if it is created successfully. Otherwise, returns NULL.
728 #if ( ( portUSING_MPU_WRAPPERS == 1 ) && ( configSUPPORT_STATIC_ALLOCATION == 1 ) )
729 static TCB_t * prvCreateRestrictedStaticTask( const TaskParameters_t * const pxTaskDefinition,
730 TaskHandle_t * const pxCreatedTask ) PRIVILEGED_FUNCTION;
731 #endif /* #if ( ( portUSING_MPU_WRAPPERS == 1 ) && ( configSUPPORT_STATIC_ALLOCATION == 1 ) ) */
734 * Create a restricted task with static buffer for task stack and allocated buffer
735 * for TCB. Returns a handle to the task if it is created successfully. Otherwise,
738 #if ( ( portUSING_MPU_WRAPPERS == 1 ) && ( configSUPPORT_DYNAMIC_ALLOCATION == 1 ) )
739 static TCB_t * prvCreateRestrictedTask( const TaskParameters_t * const pxTaskDefinition,
740 TaskHandle_t * const pxCreatedTask ) PRIVILEGED_FUNCTION;
741 #endif /* #if ( ( portUSING_MPU_WRAPPERS == 1 ) && ( configSUPPORT_DYNAMIC_ALLOCATION == 1 ) ) */
744 * Create a task with allocated buffer for both TCB and stack. Returns a handle to
745 * the task if it is created successfully. Otherwise, returns NULL.
747 #if ( configSUPPORT_DYNAMIC_ALLOCATION == 1 )
748 static TCB_t * prvCreateTask( TaskFunction_t pxTaskCode,
749 const char * const pcName, /*lint !e971 Unqualified char types are allowed for strings and single characters only. */
750 const configSTACK_DEPTH_TYPE usStackDepth,
751 void * const pvParameters,
752 UBaseType_t uxPriority,
753 TaskHandle_t * const pxCreatedTask ) PRIVILEGED_FUNCTION;
754 #endif /* #if ( configSUPPORT_DYNAMIC_ALLOCATION == 1 ) */
757 * freertos_tasks_c_additions_init() should only be called if the user definable
758 * macro FREERTOS_TASKS_C_ADDITIONS_INIT() is defined, as that is the only macro
759 * called by the function.
761 #ifdef FREERTOS_TASKS_C_ADDITIONS_INIT
763 static void freertos_tasks_c_additions_init( void ) PRIVILEGED_FUNCTION;
767 #if ( configUSE_PASSIVE_IDLE_HOOK == 1 )
768 extern void vApplicationPassiveIdleHook( void );
769 #endif /* #if ( configUSE_PASSIVE_IDLE_HOOK == 1 ) */
771 #if ( ( configUSE_TRACE_FACILITY == 1 ) && ( configUSE_STATS_FORMATTING_FUNCTIONS > 0 ) )
774 * Convert the snprintf return value to the number of characters
775 * written. The following are the possible cases:
777 * 1. The buffer supplied to snprintf is large enough to hold the
778 * generated string. The return value in this case is the number
779 * of characters actually written, not counting the terminating
781 * 2. The buffer supplied to snprintf is NOT large enough to hold
782 * the generated string. The return value in this case is the
783 * number of characters that would have been written if the
784 * buffer had been sufficiently large, not counting the
785 * terminating null character.
786 * 3. Encoding error. The return value in this case is a negative
789 * From 1 and 2 above ==> Only when the return value is non-negative
790 * and less than the supplied buffer length, the string has been
791 * completely written.
793 static size_t prvSnprintfReturnValueToCharsWritten( int iSnprintfReturnValue,
796 #endif /* #if ( ( configUSE_TRACE_FACILITY == 1 ) && ( configUSE_STATS_FORMATTING_FUNCTIONS > 0 ) ) */
797 /*-----------------------------------------------------------*/
799 #if ( configNUMBER_OF_CORES > 1 )
800 static void prvCheckForRunStateChange( void )
802 UBaseType_t uxPrevCriticalNesting;
803 const TCB_t * pxThisTCB;
805 /* This must only be called from within a task. */
806 portASSERT_IF_IN_ISR();
808 /* This function is always called with interrupts disabled
809 * so this is safe. */
810 pxThisTCB = pxCurrentTCBs[ portGET_CORE_ID() ];
812 while( pxThisTCB->xTaskRunState == taskTASK_SCHEDULED_TO_YIELD )
814 /* We are only here if we just entered a critical section
815 * or if we just suspended the scheduler, and another task
816 * has requested that we yield.
818 * This is slightly complicated since we need to save and restore
819 * the suspension and critical nesting counts, as well as release
820 * and reacquire the correct locks. And then, do it all over again
821 * if our state changed again during the reacquisition. */
822 uxPrevCriticalNesting = portGET_CRITICAL_NESTING_COUNT();
824 if( uxPrevCriticalNesting > 0U )
826 portSET_CRITICAL_NESTING_COUNT( 0U );
827 portRELEASE_ISR_LOCK();
831 /* The scheduler is suspended. uxSchedulerSuspended is updated
832 * only when the task is not requested to yield. */
833 mtCOVERAGE_TEST_MARKER();
836 portRELEASE_TASK_LOCK();
837 portMEMORY_BARRIER();
838 configASSERT( pxThisTCB->xTaskRunState == taskTASK_SCHEDULED_TO_YIELD );
840 portENABLE_INTERRUPTS();
842 /* Enabling interrupts should cause this core to immediately
843 * service the pending interrupt and yield. If the run state is still
844 * yielding here then that is a problem. */
845 configASSERT( pxThisTCB->xTaskRunState != taskTASK_SCHEDULED_TO_YIELD );
847 portDISABLE_INTERRUPTS();
851 portSET_CRITICAL_NESTING_COUNT( uxPrevCriticalNesting );
853 if( uxPrevCriticalNesting == 0U )
855 portRELEASE_ISR_LOCK();
859 #endif /* #if ( configNUMBER_OF_CORES > 1 ) */
861 /*-----------------------------------------------------------*/
863 #if ( configNUMBER_OF_CORES > 1 )
864 static void prvYieldForTask( const TCB_t * pxTCB )
866 BaseType_t xLowestPriorityToPreempt;
867 BaseType_t xCurrentCoreTaskPriority;
868 BaseType_t xLowestPriorityCore = ( BaseType_t ) -1;
871 #if ( configRUN_MULTIPLE_PRIORITIES == 0 )
872 BaseType_t xYieldCount = 0;
873 #endif /* #if ( configRUN_MULTIPLE_PRIORITIES == 0 ) */
875 /* This must be called from a critical section. */
876 configASSERT( portGET_CRITICAL_NESTING_COUNT() > 0U );
878 #if ( configRUN_MULTIPLE_PRIORITIES == 0 )
880 /* No task should yield for this one if it is a lower priority
881 * than priority level of currently ready tasks. */
882 if( pxTCB->uxPriority >= uxTopReadyPriority )
884 /* Yield is not required for a task which is already running. */
885 if( taskTASK_IS_RUNNING( pxTCB ) == pdFALSE )
888 xLowestPriorityToPreempt = ( BaseType_t ) pxTCB->uxPriority;
890 /* xLowestPriorityToPreempt will be decremented to -1 if the priority of pxTCB
891 * is 0. This is ok as we will give system idle tasks a priority of -1 below. */
892 --xLowestPriorityToPreempt;
894 for( xCoreID = ( BaseType_t ) 0; xCoreID < ( BaseType_t ) configNUMBER_OF_CORES; xCoreID++ )
896 xCurrentCoreTaskPriority = ( BaseType_t ) pxCurrentTCBs[ xCoreID ]->uxPriority;
898 /* System idle tasks are being assigned a priority of tskIDLE_PRIORITY - 1 here. */
899 if( ( pxCurrentTCBs[ xCoreID ]->uxTaskAttributes & taskATTRIBUTE_IS_IDLE ) != 0U )
901 xCurrentCoreTaskPriority = xCurrentCoreTaskPriority - 1;
904 if( ( taskTASK_IS_RUNNING( pxCurrentTCBs[ xCoreID ] ) != pdFALSE ) && ( xYieldPendings[ xCoreID ] == pdFALSE ) )
906 #if ( configRUN_MULTIPLE_PRIORITIES == 0 )
907 if( taskTASK_IS_RUNNING( pxTCB ) == pdFALSE )
910 if( xCurrentCoreTaskPriority <= xLowestPriorityToPreempt )
912 #if ( configUSE_CORE_AFFINITY == 1 )
913 if( ( pxTCB->uxCoreAffinityMask & ( ( UBaseType_t ) 1U << ( UBaseType_t ) xCoreID ) ) != 0U )
916 #if ( configUSE_TASK_PREEMPTION_DISABLE == 1 )
917 if( pxCurrentTCBs[ xCoreID ]->xPreemptionDisable == pdFALSE )
920 xLowestPriorityToPreempt = xCurrentCoreTaskPriority;
921 xLowestPriorityCore = xCoreID;
927 mtCOVERAGE_TEST_MARKER();
931 #if ( configRUN_MULTIPLE_PRIORITIES == 0 )
933 /* Yield all currently running non-idle tasks with a priority lower than
934 * the task that needs to run. */
935 if( ( xCurrentCoreTaskPriority > ( ( BaseType_t ) tskIDLE_PRIORITY - 1 ) ) &&
936 ( xCurrentCoreTaskPriority < ( BaseType_t ) pxTCB->uxPriority ) )
938 prvYieldCore( xCoreID );
943 mtCOVERAGE_TEST_MARKER();
946 #endif /* #if ( configRUN_MULTIPLE_PRIORITIES == 0 ) */
950 mtCOVERAGE_TEST_MARKER();
954 #if ( configRUN_MULTIPLE_PRIORITIES == 0 )
955 if( ( xYieldCount == 0 ) && ( xLowestPriorityCore >= 0 ) )
956 #else /* #if ( configRUN_MULTIPLE_PRIORITIES == 0 ) */
957 if( xLowestPriorityCore >= 0 )
958 #endif /* #if ( configRUN_MULTIPLE_PRIORITIES == 0 ) */
960 prvYieldCore( xLowestPriorityCore );
963 #if ( configRUN_MULTIPLE_PRIORITIES == 0 )
964 /* Verify that the calling core always yields to higher priority tasks. */
965 if( ( ( pxCurrentTCBs[ portGET_CORE_ID() ]->uxTaskAttributes & taskATTRIBUTE_IS_IDLE ) == 0 ) &&
966 ( pxTCB->uxPriority > pxCurrentTCBs[ portGET_CORE_ID() ]->uxPriority ) )
968 configASSERT( ( xYieldPendings[ portGET_CORE_ID() ] == pdTRUE ) ||
969 ( taskTASK_IS_RUNNING( pxCurrentTCBs[ portGET_CORE_ID() ] ) == pdFALSE ) );
974 #endif /* #if ( configNUMBER_OF_CORES > 1 ) */
975 /*-----------------------------------------------------------*/
977 #if ( configNUMBER_OF_CORES > 1 )
978 static void prvSelectHighestPriorityTask( BaseType_t xCoreID )
980 UBaseType_t uxCurrentPriority = uxTopReadyPriority;
981 BaseType_t xTaskScheduled = pdFALSE;
982 BaseType_t xDecrementTopPriority = pdTRUE;
984 #if ( configUSE_CORE_AFFINITY == 1 )
985 const TCB_t * pxPreviousTCB = NULL;
987 #if ( configRUN_MULTIPLE_PRIORITIES == 0 )
988 BaseType_t xPriorityDropped = pdFALSE;
991 /* This function should be called when scheduler is running. */
992 configASSERT( xSchedulerRunning == pdTRUE );
994 /* A new task is created and a running task with the same priority yields
995 * itself to run the new task. When a running task yields itself, it is still
996 * in the ready list. This running task will be selected before the new task
997 * since the new task is always added to the end of the ready list.
998 * The other problem is that the running task still in the same position of
999 * the ready list when it yields itself. It is possible that it will be selected
1000 * earlier then other tasks which waits longer than this task.
1002 * To fix these problems, the running task should be put to the end of the
1003 * ready list before searching for the ready task in the ready list. */
1004 if( listIS_CONTAINED_WITHIN( &( pxReadyTasksLists[ pxCurrentTCBs[ xCoreID ]->uxPriority ] ),
1005 &pxCurrentTCBs[ xCoreID ]->xStateListItem ) == pdTRUE )
1007 ( void ) uxListRemove( &pxCurrentTCBs[ xCoreID ]->xStateListItem );
1008 vListInsertEnd( &( pxReadyTasksLists[ pxCurrentTCBs[ xCoreID ]->uxPriority ] ),
1009 &pxCurrentTCBs[ xCoreID ]->xStateListItem );
1012 while( xTaskScheduled == pdFALSE )
1014 #if ( configRUN_MULTIPLE_PRIORITIES == 0 )
1016 if( uxCurrentPriority < uxTopReadyPriority )
1018 /* We can't schedule any tasks, other than idle, that have a
1019 * priority lower than the priority of a task currently running
1020 * on another core. */
1021 uxCurrentPriority = tskIDLE_PRIORITY;
1026 if( listLIST_IS_EMPTY( &( pxReadyTasksLists[ uxCurrentPriority ] ) ) == pdFALSE )
1028 const List_t * const pxReadyList = &( pxReadyTasksLists[ uxCurrentPriority ] );
1029 const ListItem_t * pxEndMarker = listGET_END_MARKER( pxReadyList );
1030 ListItem_t * pxIterator;
1032 /* The ready task list for uxCurrentPriority is not empty, so uxTopReadyPriority
1033 * must not be decremented any further. */
1034 xDecrementTopPriority = pdFALSE;
1036 for( pxIterator = listGET_HEAD_ENTRY( pxReadyList ); pxIterator != pxEndMarker; pxIterator = listGET_NEXT( pxIterator ) )
1038 TCB_t * pxTCB = ( TCB_t * ) listGET_LIST_ITEM_OWNER( pxIterator );
1040 #if ( configRUN_MULTIPLE_PRIORITIES == 0 )
1042 /* When falling back to the idle priority because only one priority
1043 * level is allowed to run at a time, we should ONLY schedule the true
1044 * idle tasks, not user tasks at the idle priority. */
1045 if( uxCurrentPriority < uxTopReadyPriority )
1047 if( ( pxTCB->uxTaskAttributes & taskATTRIBUTE_IS_IDLE ) == 0 )
1053 #endif /* #if ( configRUN_MULTIPLE_PRIORITIES == 0 ) */
1055 if( pxTCB->xTaskRunState == taskTASK_NOT_RUNNING )
1057 #if ( configUSE_CORE_AFFINITY == 1 )
1058 if( ( pxTCB->uxCoreAffinityMask & ( ( UBaseType_t ) 1U << ( UBaseType_t ) xCoreID ) ) != 0U )
1061 /* If the task is not being executed by any core swap it in. */
1062 pxCurrentTCBs[ xCoreID ]->xTaskRunState = taskTASK_NOT_RUNNING;
1063 #if ( configUSE_CORE_AFFINITY == 1 )
1064 pxPreviousTCB = pxCurrentTCBs[ xCoreID ];
1066 pxTCB->xTaskRunState = xCoreID;
1067 pxCurrentTCBs[ xCoreID ] = pxTCB;
1068 xTaskScheduled = pdTRUE;
1071 else if( pxTCB == pxCurrentTCBs[ xCoreID ] )
1073 configASSERT( ( pxTCB->xTaskRunState == xCoreID ) || ( pxTCB->xTaskRunState == taskTASK_SCHEDULED_TO_YIELD ) );
1075 #if ( configUSE_CORE_AFFINITY == 1 )
1076 if( ( pxTCB->uxCoreAffinityMask & ( ( UBaseType_t ) 1U << ( UBaseType_t ) xCoreID ) ) != 0U )
1079 /* The task is already running on this core, mark it as scheduled. */
1080 pxTCB->xTaskRunState = xCoreID;
1081 xTaskScheduled = pdTRUE;
1086 /* This task is running on the core other than xCoreID. */
1087 mtCOVERAGE_TEST_MARKER();
1090 if( xTaskScheduled != pdFALSE )
1092 /* A task has been selected to run on this core. */
1099 if( xDecrementTopPriority != pdFALSE )
1101 uxTopReadyPriority--;
1102 #if ( configRUN_MULTIPLE_PRIORITIES == 0 )
1104 xPriorityDropped = pdTRUE;
1110 /* There are configNUMBER_OF_CORES Idle tasks created when scheduler started.
1111 * The scheduler should be able to select a task to run when uxCurrentPriority
1112 * is tskIDLE_PRIORITY. uxCurrentPriority is never decreased to value blow
1113 * tskIDLE_PRIORITY. */
1114 if( uxCurrentPriority > tskIDLE_PRIORITY )
1116 uxCurrentPriority--;
1120 /* This function is called when idle task is not created. Break the
1121 * loop to prevent uxCurrentPriority overrun. */
1126 #if ( configRUN_MULTIPLE_PRIORITIES == 0 )
1128 if( xTaskScheduled == pdTRUE )
1130 if( xPriorityDropped != pdFALSE )
1132 /* There may be several ready tasks that were being prevented from running because there was
1133 * a higher priority task running. Now that the last of the higher priority tasks is no longer
1134 * running, make sure all the other idle tasks yield. */
1137 for( x = ( BaseType_t ) 0; x < ( BaseType_t ) configNUMBER_OF_CORES; x++ )
1139 if( ( pxCurrentTCBs[ x ]->uxTaskAttributes & taskATTRIBUTE_IS_IDLE ) != 0 )
1147 #endif /* #if ( configRUN_MULTIPLE_PRIORITIES == 0 ) */
1149 #if ( configUSE_CORE_AFFINITY == 1 )
1151 if( xTaskScheduled == pdTRUE )
1153 if( ( pxPreviousTCB != NULL ) && ( listIS_CONTAINED_WITHIN( &( pxReadyTasksLists[ pxPreviousTCB->uxPriority ] ), &( pxPreviousTCB->xStateListItem ) ) != pdFALSE ) )
1155 /* A ready task was just evicted from this core. See if it can be
1156 * scheduled on any other core. */
1157 UBaseType_t uxCoreMap = pxPreviousTCB->uxCoreAffinityMask;
1158 BaseType_t xLowestPriority = ( BaseType_t ) pxPreviousTCB->uxPriority;
1159 BaseType_t xLowestPriorityCore = -1;
1162 if( ( pxPreviousTCB->uxTaskAttributes & taskATTRIBUTE_IS_IDLE ) != 0U )
1164 xLowestPriority = xLowestPriority - 1;
1167 if( ( uxCoreMap & ( ( UBaseType_t ) 1U << ( UBaseType_t ) xCoreID ) ) != 0U )
1169 /* pxPreviousTCB was removed from this core and this core is not excluded
1170 * from it's core affinity mask.
1172 * pxPreviousTCB is preempted by the new higher priority task
1173 * pxCurrentTCBs[ xCoreID ]. When searching a new core for pxPreviousTCB,
1174 * we do not need to look at the cores on which pxCurrentTCBs[ xCoreID ]
1175 * is allowed to run. The reason is - when more than one cores are
1176 * eligible for an incoming task, we preempt the core with the minimum
1177 * priority task. Because this core (i.e. xCoreID) was preempted for
1178 * pxCurrentTCBs[ xCoreID ], this means that all the others cores
1179 * where pxCurrentTCBs[ xCoreID ] can run, are running tasks with priority
1180 * no lower than pxPreviousTCB's priority. Therefore, the only cores where
1181 * which can be preempted for pxPreviousTCB are the ones where
1182 * pxCurrentTCBs[ xCoreID ] is not allowed to run (and obviously,
1183 * pxPreviousTCB is allowed to run).
1185 * This is an optimization which reduces the number of cores needed to be
1186 * searched for pxPreviousTCB to run. */
1187 uxCoreMap &= ~( pxCurrentTCBs[ xCoreID ]->uxCoreAffinityMask );
1191 /* pxPreviousTCB's core affinity mask is changed and it is no longer
1192 * allowed to run on this core. Searching all the cores in pxPreviousTCB's
1193 * new core affinity mask to find a core on which it can run. */
1196 uxCoreMap &= ( ( 1U << configNUMBER_OF_CORES ) - 1U );
1198 for( x = ( ( BaseType_t ) configNUMBER_OF_CORES - 1 ); x >= ( BaseType_t ) 0; x-- )
1200 UBaseType_t uxCore = ( UBaseType_t ) x;
1201 BaseType_t xTaskPriority;
1203 if( ( uxCoreMap & ( ( UBaseType_t ) 1U << uxCore ) ) != 0U )
1205 xTaskPriority = ( BaseType_t ) pxCurrentTCBs[ uxCore ]->uxPriority;
1207 if( ( pxCurrentTCBs[ uxCore ]->uxTaskAttributes & taskATTRIBUTE_IS_IDLE ) != 0U )
1209 xTaskPriority = xTaskPriority - ( BaseType_t ) 1;
1212 uxCoreMap &= ~( ( UBaseType_t ) 1U << uxCore );
1214 if( ( xTaskPriority < xLowestPriority ) &&
1215 ( taskTASK_IS_RUNNING( pxCurrentTCBs[ uxCore ] ) != pdFALSE ) &&
1216 ( xYieldPendings[ uxCore ] == pdFALSE ) )
1218 #if ( configUSE_TASK_PREEMPTION_DISABLE == 1 )
1219 if( pxCurrentTCBs[ uxCore ]->xPreemptionDisable == pdFALSE )
1222 xLowestPriority = xTaskPriority;
1223 xLowestPriorityCore = ( BaseType_t ) uxCore;
1229 if( xLowestPriorityCore >= 0 )
1231 prvYieldCore( xLowestPriorityCore );
1236 #endif /* #if ( configUSE_CORE_AFFINITY == 1 ) */
1239 #endif /* ( configNUMBER_OF_CORES > 1 ) */
1241 /*-----------------------------------------------------------*/
1243 #if ( configSUPPORT_STATIC_ALLOCATION == 1 )
1245 static TCB_t * prvCreateStaticTask( TaskFunction_t pxTaskCode,
1246 const char * const pcName, /*lint !e971 Unqualified char types are allowed for strings and single characters only. */
1247 const uint32_t ulStackDepth,
1248 void * const pvParameters,
1249 UBaseType_t uxPriority,
1250 StackType_t * const puxStackBuffer,
1251 StaticTask_t * const pxTaskBuffer,
1252 TaskHandle_t * const pxCreatedTask )
1256 configASSERT( puxStackBuffer != NULL );
1257 configASSERT( pxTaskBuffer != NULL );
1259 #if ( configASSERT_DEFINED == 1 )
1261 /* Sanity check that the size of the structure used to declare a
1262 * variable of type StaticTask_t equals the size of the real task
1264 volatile size_t xSize = sizeof( StaticTask_t );
1265 configASSERT( xSize == sizeof( TCB_t ) );
1266 ( void ) xSize; /* Prevent lint warning when configASSERT() is not used. */
1268 #endif /* configASSERT_DEFINED */
1270 if( ( pxTaskBuffer != NULL ) && ( puxStackBuffer != NULL ) )
1272 /* The memory used for the task's TCB and stack are passed into this
1273 * function - use them. */
1274 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. */
1275 ( void ) memset( ( void * ) pxNewTCB, 0x00, sizeof( TCB_t ) );
1276 pxNewTCB->pxStack = ( StackType_t * ) puxStackBuffer;
1278 #if ( tskSTATIC_AND_DYNAMIC_ALLOCATION_POSSIBLE != 0 ) /*lint !e731 !e9029 Macro has been consolidated for readability reasons. */
1280 /* Tasks can be created statically or dynamically, so note this
1281 * task was created statically in case the task is later deleted. */
1282 pxNewTCB->ucStaticallyAllocated = tskSTATICALLY_ALLOCATED_STACK_AND_TCB;
1284 #endif /* tskSTATIC_AND_DYNAMIC_ALLOCATION_POSSIBLE */
1286 prvInitialiseNewTask( pxTaskCode, pcName, ulStackDepth, pvParameters, uxPriority, pxCreatedTask, pxNewTCB, NULL );
1295 /*-----------------------------------------------------------*/
1297 TaskHandle_t xTaskCreateStatic( TaskFunction_t pxTaskCode,
1298 const char * const pcName, /*lint !e971 Unqualified char types are allowed for strings and single characters only. */
1299 const uint32_t ulStackDepth,
1300 void * const pvParameters,
1301 UBaseType_t uxPriority,
1302 StackType_t * const puxStackBuffer,
1303 StaticTask_t * const pxTaskBuffer )
1305 TaskHandle_t xReturn = NULL;
1308 traceENTER_xTaskCreateStatic( pxTaskCode, pcName, ulStackDepth, pvParameters, uxPriority, puxStackBuffer, pxTaskBuffer );
1310 pxNewTCB = prvCreateStaticTask( pxTaskCode, pcName, ulStackDepth, pvParameters, uxPriority, puxStackBuffer, pxTaskBuffer, &xReturn );
1312 if( pxNewTCB != NULL )
1314 #if ( ( configNUMBER_OF_CORES > 1 ) && ( configUSE_CORE_AFFINITY == 1 ) )
1316 /* Set the task's affinity before scheduling it. */
1317 pxNewTCB->uxCoreAffinityMask = tskNO_AFFINITY;
1321 prvAddNewTaskToReadyList( pxNewTCB );
1325 mtCOVERAGE_TEST_MARKER();
1328 traceRETURN_xTaskCreateStatic( xReturn );
1332 /*-----------------------------------------------------------*/
1334 #if ( ( configNUMBER_OF_CORES > 1 ) && ( configUSE_CORE_AFFINITY == 1 ) )
1335 TaskHandle_t xTaskCreateStaticAffinitySet( TaskFunction_t pxTaskCode,
1336 const char * const pcName, /*lint !e971 Unqualified char types are allowed for strings and single characters only. */
1337 const uint32_t ulStackDepth,
1338 void * const pvParameters,
1339 UBaseType_t uxPriority,
1340 StackType_t * const puxStackBuffer,
1341 StaticTask_t * const pxTaskBuffer,
1342 UBaseType_t uxCoreAffinityMask )
1344 TaskHandle_t xReturn = NULL;
1347 traceENTER_xTaskCreateStaticAffinitySet( pxTaskCode, pcName, ulStackDepth, pvParameters, uxPriority, puxStackBuffer, pxTaskBuffer, uxCoreAffinityMask );
1349 pxNewTCB = prvCreateStaticTask( pxTaskCode, pcName, ulStackDepth, pvParameters, uxPriority, puxStackBuffer, pxTaskBuffer, &xReturn );
1351 if( pxNewTCB != NULL )
1353 /* Set the task's affinity before scheduling it. */
1354 pxNewTCB->uxCoreAffinityMask = uxCoreAffinityMask;
1356 prvAddNewTaskToReadyList( pxNewTCB );
1360 mtCOVERAGE_TEST_MARKER();
1363 traceRETURN_xTaskCreateStaticAffinitySet( xReturn );
1367 #endif /* #if ( ( configNUMBER_OF_CORES > 1 ) && ( configUSE_CORE_AFFINITY == 1 ) ) */
1369 #endif /* SUPPORT_STATIC_ALLOCATION */
1370 /*-----------------------------------------------------------*/
1372 #if ( ( portUSING_MPU_WRAPPERS == 1 ) && ( configSUPPORT_STATIC_ALLOCATION == 1 ) )
1373 static TCB_t * prvCreateRestrictedStaticTask( const TaskParameters_t * const pxTaskDefinition,
1374 TaskHandle_t * const pxCreatedTask )
1378 configASSERT( pxTaskDefinition->puxStackBuffer != NULL );
1379 configASSERT( pxTaskDefinition->pxTaskBuffer != NULL );
1381 if( ( pxTaskDefinition->puxStackBuffer != NULL ) && ( pxTaskDefinition->pxTaskBuffer != NULL ) )
1383 /* Allocate space for the TCB. Where the memory comes from depends
1384 * on the implementation of the port malloc function and whether or
1385 * not static allocation is being used. */
1386 pxNewTCB = ( TCB_t * ) pxTaskDefinition->pxTaskBuffer;
1387 ( void ) memset( ( void * ) pxNewTCB, 0x00, sizeof( TCB_t ) );
1389 /* Store the stack location in the TCB. */
1390 pxNewTCB->pxStack = pxTaskDefinition->puxStackBuffer;
1392 #if ( tskSTATIC_AND_DYNAMIC_ALLOCATION_POSSIBLE != 0 )
1394 /* Tasks can be created statically or dynamically, so note this
1395 * task was created statically in case the task is later deleted. */
1396 pxNewTCB->ucStaticallyAllocated = tskSTATICALLY_ALLOCATED_STACK_AND_TCB;
1398 #endif /* tskSTATIC_AND_DYNAMIC_ALLOCATION_POSSIBLE */
1400 prvInitialiseNewTask( pxTaskDefinition->pvTaskCode,
1401 pxTaskDefinition->pcName,
1402 ( uint32_t ) pxTaskDefinition->usStackDepth,
1403 pxTaskDefinition->pvParameters,
1404 pxTaskDefinition->uxPriority,
1405 pxCreatedTask, pxNewTCB,
1406 pxTaskDefinition->xRegions );
1415 /*-----------------------------------------------------------*/
1417 BaseType_t xTaskCreateRestrictedStatic( const TaskParameters_t * const pxTaskDefinition,
1418 TaskHandle_t * pxCreatedTask )
1423 traceENTER_xTaskCreateRestrictedStatic( pxTaskDefinition, pxCreatedTask );
1425 configASSERT( pxTaskDefinition != NULL );
1427 pxNewTCB = prvCreateRestrictedStaticTask( pxTaskDefinition, pxCreatedTask );
1429 if( pxNewTCB != NULL )
1431 #if ( ( configNUMBER_OF_CORES > 1 ) && ( configUSE_CORE_AFFINITY == 1 ) )
1433 /* Set the task's affinity before scheduling it. */
1434 pxNewTCB->uxCoreAffinityMask = tskNO_AFFINITY;
1438 prvAddNewTaskToReadyList( pxNewTCB );
1443 xReturn = errCOULD_NOT_ALLOCATE_REQUIRED_MEMORY;
1446 traceRETURN_xTaskCreateRestrictedStatic( xReturn );
1450 /*-----------------------------------------------------------*/
1452 #if ( ( configNUMBER_OF_CORES > 1 ) && ( configUSE_CORE_AFFINITY == 1 ) )
1453 BaseType_t xTaskCreateRestrictedStaticAffinitySet( const TaskParameters_t * const pxTaskDefinition,
1454 UBaseType_t uxCoreAffinityMask,
1455 TaskHandle_t * pxCreatedTask )
1460 traceENTER_xTaskCreateRestrictedStaticAffinitySet( pxTaskDefinition, uxCoreAffinityMask, pxCreatedTask );
1462 configASSERT( pxTaskDefinition != NULL );
1464 pxNewTCB = prvCreateRestrictedStaticTask( pxTaskDefinition, pxCreatedTask );
1466 if( pxNewTCB != NULL )
1468 /* Set the task's affinity before scheduling it. */
1469 pxNewTCB->uxCoreAffinityMask = uxCoreAffinityMask;
1471 prvAddNewTaskToReadyList( pxNewTCB );
1476 xReturn = errCOULD_NOT_ALLOCATE_REQUIRED_MEMORY;
1479 traceRETURN_xTaskCreateRestrictedStaticAffinitySet( xReturn );
1483 #endif /* #if ( ( configNUMBER_OF_CORES > 1 ) && ( configUSE_CORE_AFFINITY == 1 ) ) */
1485 #endif /* ( portUSING_MPU_WRAPPERS == 1 ) && ( configSUPPORT_STATIC_ALLOCATION == 1 ) */
1486 /*-----------------------------------------------------------*/
1488 #if ( ( portUSING_MPU_WRAPPERS == 1 ) && ( configSUPPORT_DYNAMIC_ALLOCATION == 1 ) )
1489 static TCB_t * prvCreateRestrictedTask( const TaskParameters_t * const pxTaskDefinition,
1490 TaskHandle_t * const pxCreatedTask )
1494 configASSERT( pxTaskDefinition->puxStackBuffer );
1496 if( pxTaskDefinition->puxStackBuffer != NULL )
1498 pxNewTCB = ( TCB_t * ) pvPortMalloc( sizeof( TCB_t ) );
1500 if( pxNewTCB != NULL )
1502 ( void ) memset( ( void * ) pxNewTCB, 0x00, sizeof( TCB_t ) );
1504 /* Store the stack location in the TCB. */
1505 pxNewTCB->pxStack = pxTaskDefinition->puxStackBuffer;
1507 #if ( tskSTATIC_AND_DYNAMIC_ALLOCATION_POSSIBLE != 0 )
1509 /* Tasks can be created statically or dynamically, so note
1510 * this task had a statically allocated stack in case it is
1511 * later deleted. The TCB was allocated dynamically. */
1512 pxNewTCB->ucStaticallyAllocated = tskSTATICALLY_ALLOCATED_STACK_ONLY;
1514 #endif /* tskSTATIC_AND_DYNAMIC_ALLOCATION_POSSIBLE */
1516 prvInitialiseNewTask( pxTaskDefinition->pvTaskCode,
1517 pxTaskDefinition->pcName,
1518 ( uint32_t ) pxTaskDefinition->usStackDepth,
1519 pxTaskDefinition->pvParameters,
1520 pxTaskDefinition->uxPriority,
1521 pxCreatedTask, pxNewTCB,
1522 pxTaskDefinition->xRegions );
1532 /*-----------------------------------------------------------*/
1534 BaseType_t xTaskCreateRestricted( const TaskParameters_t * const pxTaskDefinition,
1535 TaskHandle_t * pxCreatedTask )
1540 traceENTER_xTaskCreateRestricted( pxTaskDefinition, pxCreatedTask );
1542 pxNewTCB = prvCreateRestrictedTask( pxTaskDefinition, pxCreatedTask );
1544 if( pxNewTCB != NULL )
1546 #if ( ( configNUMBER_OF_CORES > 1 ) && ( configUSE_CORE_AFFINITY == 1 ) )
1548 /* Set the task's affinity before scheduling it. */
1549 pxNewTCB->uxCoreAffinityMask = tskNO_AFFINITY;
1551 #endif /* #if ( ( configNUMBER_OF_CORES > 1 ) && ( configUSE_CORE_AFFINITY == 1 ) ) */
1553 prvAddNewTaskToReadyList( pxNewTCB );
1559 xReturn = errCOULD_NOT_ALLOCATE_REQUIRED_MEMORY;
1562 traceRETURN_xTaskCreateRestricted( xReturn );
1566 /*-----------------------------------------------------------*/
1568 #if ( ( configNUMBER_OF_CORES > 1 ) && ( configUSE_CORE_AFFINITY == 1 ) )
1569 BaseType_t xTaskCreateRestrictedAffinitySet( const TaskParameters_t * const pxTaskDefinition,
1570 UBaseType_t uxCoreAffinityMask,
1571 TaskHandle_t * pxCreatedTask )
1576 traceENTER_xTaskCreateRestrictedAffinitySet( pxTaskDefinition, uxCoreAffinityMask, pxCreatedTask );
1578 pxNewTCB = prvCreateRestrictedTask( pxTaskDefinition, pxCreatedTask );
1580 if( pxNewTCB != NULL )
1582 /* Set the task's affinity before scheduling it. */
1583 pxNewTCB->uxCoreAffinityMask = uxCoreAffinityMask;
1585 prvAddNewTaskToReadyList( pxNewTCB );
1591 xReturn = errCOULD_NOT_ALLOCATE_REQUIRED_MEMORY;
1594 traceRETURN_xTaskCreateRestrictedAffinitySet( xReturn );
1598 #endif /* #if ( ( configNUMBER_OF_CORES > 1 ) && ( configUSE_CORE_AFFINITY == 1 ) ) */
1601 #endif /* portUSING_MPU_WRAPPERS */
1602 /*-----------------------------------------------------------*/
1604 #if ( configSUPPORT_DYNAMIC_ALLOCATION == 1 )
1605 static TCB_t * prvCreateTask( TaskFunction_t pxTaskCode,
1606 const char * const pcName, /*lint !e971 Unqualified char types are allowed for strings and single characters only. */
1607 const configSTACK_DEPTH_TYPE usStackDepth,
1608 void * const pvParameters,
1609 UBaseType_t uxPriority,
1610 TaskHandle_t * const pxCreatedTask )
1614 /* If the stack grows down then allocate the stack then the TCB so the stack
1615 * does not grow into the TCB. Likewise if the stack grows up then allocate
1616 * the TCB then the stack. */
1617 #if ( portSTACK_GROWTH > 0 )
1619 /* Allocate space for the TCB. Where the memory comes from depends on
1620 * the implementation of the port malloc function and whether or not static
1621 * allocation is being used. */
1622 pxNewTCB = ( TCB_t * ) pvPortMalloc( sizeof( TCB_t ) );
1624 if( pxNewTCB != NULL )
1626 ( void ) memset( ( void * ) pxNewTCB, 0x00, sizeof( TCB_t ) );
1628 /* Allocate space for the stack used by the task being created.
1629 * The base of the stack memory stored in the TCB so the task can
1630 * be deleted later if required. */
1631 pxNewTCB->pxStack = ( StackType_t * ) pvPortMallocStack( ( ( ( size_t ) usStackDepth ) * sizeof( StackType_t ) ) ); /*lint !e961 MISRA exception as the casts are only redundant for some ports. */
1633 if( pxNewTCB->pxStack == NULL )
1635 /* Could not allocate the stack. Delete the allocated TCB. */
1636 vPortFree( pxNewTCB );
1641 #else /* portSTACK_GROWTH */
1643 StackType_t * pxStack;
1645 /* Allocate space for the stack used by the task being created. */
1646 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. */
1648 if( pxStack != NULL )
1650 /* Allocate space for the TCB. */
1651 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. */
1653 if( pxNewTCB != NULL )
1655 ( void ) memset( ( void * ) pxNewTCB, 0x00, sizeof( TCB_t ) );
1657 /* Store the stack location in the TCB. */
1658 pxNewTCB->pxStack = pxStack;
1662 /* The stack cannot be used as the TCB was not created. Free
1664 vPortFreeStack( pxStack );
1672 #endif /* portSTACK_GROWTH */
1674 if( pxNewTCB != NULL )
1676 #if ( tskSTATIC_AND_DYNAMIC_ALLOCATION_POSSIBLE != 0 ) /*lint !e9029 !e731 Macro has been consolidated for readability reasons. */
1678 /* Tasks can be created statically or dynamically, so note this
1679 * task was created dynamically in case it is later deleted. */
1680 pxNewTCB->ucStaticallyAllocated = tskDYNAMICALLY_ALLOCATED_STACK_AND_TCB;
1682 #endif /* tskSTATIC_AND_DYNAMIC_ALLOCATION_POSSIBLE */
1684 prvInitialiseNewTask( pxTaskCode, pcName, ( uint32_t ) usStackDepth, pvParameters, uxPriority, pxCreatedTask, pxNewTCB, NULL );
1689 /*-----------------------------------------------------------*/
1691 BaseType_t xTaskCreate( TaskFunction_t pxTaskCode,
1692 const char * const pcName, /*lint !e971 Unqualified char types are allowed for strings and single characters only. */
1693 const configSTACK_DEPTH_TYPE usStackDepth,
1694 void * const pvParameters,
1695 UBaseType_t uxPriority,
1696 TaskHandle_t * const pxCreatedTask )
1701 traceENTER_xTaskCreate( pxTaskCode, pcName, usStackDepth, pvParameters, uxPriority, pxCreatedTask );
1703 pxNewTCB = prvCreateTask( pxTaskCode, pcName, usStackDepth, pvParameters, uxPriority, pxCreatedTask );
1705 if( pxNewTCB != NULL )
1707 #if ( ( configNUMBER_OF_CORES > 1 ) && ( configUSE_CORE_AFFINITY == 1 ) )
1709 /* Set the task's affinity before scheduling it. */
1710 pxNewTCB->uxCoreAffinityMask = tskNO_AFFINITY;
1714 prvAddNewTaskToReadyList( pxNewTCB );
1719 xReturn = errCOULD_NOT_ALLOCATE_REQUIRED_MEMORY;
1722 traceRETURN_xTaskCreate( xReturn );
1726 /*-----------------------------------------------------------*/
1728 #if ( ( configNUMBER_OF_CORES > 1 ) && ( configUSE_CORE_AFFINITY == 1 ) )
1729 BaseType_t xTaskCreateAffinitySet( TaskFunction_t pxTaskCode,
1730 const char * const pcName, /*lint !e971 Unqualified char types are allowed for strings and single characters only. */
1731 const configSTACK_DEPTH_TYPE usStackDepth,
1732 void * const pvParameters,
1733 UBaseType_t uxPriority,
1734 UBaseType_t uxCoreAffinityMask,
1735 TaskHandle_t * const pxCreatedTask )
1740 traceENTER_xTaskCreateAffinitySet( pxTaskCode, pcName, usStackDepth, pvParameters, uxPriority, uxCoreAffinityMask, pxCreatedTask );
1742 pxNewTCB = prvCreateTask( pxTaskCode, pcName, usStackDepth, pvParameters, uxPriority, pxCreatedTask );
1744 if( pxNewTCB != NULL )
1746 /* Set the task's affinity before scheduling it. */
1747 pxNewTCB->uxCoreAffinityMask = uxCoreAffinityMask;
1749 prvAddNewTaskToReadyList( pxNewTCB );
1754 xReturn = errCOULD_NOT_ALLOCATE_REQUIRED_MEMORY;
1757 traceRETURN_xTaskCreateAffinitySet( xReturn );
1761 #endif /* #if ( ( configNUMBER_OF_CORES > 1 ) && ( configUSE_CORE_AFFINITY == 1 ) ) */
1763 #endif /* configSUPPORT_DYNAMIC_ALLOCATION */
1764 /*-----------------------------------------------------------*/
1766 static void prvInitialiseNewTask( TaskFunction_t pxTaskCode,
1767 const char * const pcName, /*lint !e971 Unqualified char types are allowed for strings and single characters only. */
1768 const uint32_t ulStackDepth,
1769 void * const pvParameters,
1770 UBaseType_t uxPriority,
1771 TaskHandle_t * const pxCreatedTask,
1773 const MemoryRegion_t * const xRegions )
1775 StackType_t * pxTopOfStack;
1778 #if ( portUSING_MPU_WRAPPERS == 1 )
1779 /* Should the task be created in privileged mode? */
1780 BaseType_t xRunPrivileged;
1782 if( ( uxPriority & portPRIVILEGE_BIT ) != 0U )
1784 xRunPrivileged = pdTRUE;
1788 xRunPrivileged = pdFALSE;
1790 uxPriority &= ~portPRIVILEGE_BIT;
1791 #endif /* portUSING_MPU_WRAPPERS == 1 */
1793 /* Avoid dependency on memset() if it is not required. */
1794 #if ( tskSET_NEW_STACKS_TO_KNOWN_VALUE == 1 )
1796 /* Fill the stack with a known value to assist debugging. */
1797 ( void ) memset( pxNewTCB->pxStack, ( int ) tskSTACK_FILL_BYTE, ( size_t ) ulStackDepth * sizeof( StackType_t ) );
1799 #endif /* tskSET_NEW_STACKS_TO_KNOWN_VALUE */
1801 /* Calculate the top of stack address. This depends on whether the stack
1802 * grows from high memory to low (as per the 80x86) or vice versa.
1803 * portSTACK_GROWTH is used to make the result positive or negative as required
1805 #if ( portSTACK_GROWTH < 0 )
1807 pxTopOfStack = &( pxNewTCB->pxStack[ ulStackDepth - ( uint32_t ) 1 ] );
1808 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(). */
1810 /* Check the alignment of the calculated top of stack is correct. */
1811 configASSERT( ( ( ( portPOINTER_SIZE_TYPE ) pxTopOfStack & ( portPOINTER_SIZE_TYPE ) portBYTE_ALIGNMENT_MASK ) == 0UL ) );
1813 #if ( configRECORD_STACK_HIGH_ADDRESS == 1 )
1815 /* Also record the stack's high address, which may assist
1817 pxNewTCB->pxEndOfStack = pxTopOfStack;
1819 #endif /* configRECORD_STACK_HIGH_ADDRESS */
1821 #else /* portSTACK_GROWTH */
1823 pxTopOfStack = pxNewTCB->pxStack;
1824 pxTopOfStack = ( StackType_t * ) ( ( ( ( portPOINTER_SIZE_TYPE ) pxTopOfStack ) + portBYTE_ALIGNMENT_MASK ) & ( ~( ( 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(). */
1826 /* Check the alignment of the calculated top of stack is correct. */
1827 configASSERT( ( ( ( portPOINTER_SIZE_TYPE ) pxTopOfStack & ( portPOINTER_SIZE_TYPE ) portBYTE_ALIGNMENT_MASK ) == 0UL ) );
1829 /* The other extreme of the stack space is required if stack checking is
1831 pxNewTCB->pxEndOfStack = pxNewTCB->pxStack + ( ulStackDepth - ( uint32_t ) 1 );
1833 #endif /* portSTACK_GROWTH */
1835 /* Store the task name in the TCB. */
1836 if( pcName != NULL )
1838 for( x = ( UBaseType_t ) 0; x < ( UBaseType_t ) configMAX_TASK_NAME_LEN; x++ )
1840 pxNewTCB->pcTaskName[ x ] = pcName[ x ];
1842 /* Don't copy all configMAX_TASK_NAME_LEN if the string is shorter than
1843 * configMAX_TASK_NAME_LEN characters just in case the memory after the
1844 * string is not accessible (extremely unlikely). */
1845 if( pcName[ x ] == ( char ) 0x00 )
1851 mtCOVERAGE_TEST_MARKER();
1855 /* Ensure the name string is terminated in the case that the string length
1856 * was greater or equal to configMAX_TASK_NAME_LEN. */
1857 pxNewTCB->pcTaskName[ configMAX_TASK_NAME_LEN - 1 ] = '\0';
1861 mtCOVERAGE_TEST_MARKER();
1864 /* This is used as an array index so must ensure it's not too large. */
1865 configASSERT( uxPriority < configMAX_PRIORITIES );
1867 if( uxPriority >= ( UBaseType_t ) configMAX_PRIORITIES )
1869 uxPriority = ( UBaseType_t ) configMAX_PRIORITIES - ( UBaseType_t ) 1U;
1873 mtCOVERAGE_TEST_MARKER();
1876 pxNewTCB->uxPriority = uxPriority;
1877 #if ( configUSE_MUTEXES == 1 )
1879 pxNewTCB->uxBasePriority = uxPriority;
1881 #endif /* configUSE_MUTEXES */
1883 vListInitialiseItem( &( pxNewTCB->xStateListItem ) );
1884 vListInitialiseItem( &( pxNewTCB->xEventListItem ) );
1886 /* Set the pxNewTCB as a link back from the ListItem_t. This is so we can get
1887 * back to the containing TCB from a generic item in a list. */
1888 listSET_LIST_ITEM_OWNER( &( pxNewTCB->xStateListItem ), pxNewTCB );
1890 /* Event lists are always in priority order. */
1891 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. */
1892 listSET_LIST_ITEM_OWNER( &( pxNewTCB->xEventListItem ), pxNewTCB );
1894 #if ( portUSING_MPU_WRAPPERS == 1 )
1896 vPortStoreTaskMPUSettings( &( pxNewTCB->xMPUSettings ), xRegions, pxNewTCB->pxStack, ulStackDepth );
1900 /* Avoid compiler warning about unreferenced parameter. */
1905 #if ( configUSE_C_RUNTIME_TLS_SUPPORT == 1 )
1907 /* Allocate and initialize memory for the task's TLS Block. */
1908 configINIT_TLS_BLOCK( pxNewTCB->xTLSBlock, pxTopOfStack );
1912 /* Initialize the TCB stack to look as if the task was already running,
1913 * but had been interrupted by the scheduler. The return address is set
1914 * to the start of the task function. Once the stack has been initialised
1915 * the top of stack variable is updated. */
1916 #if ( portUSING_MPU_WRAPPERS == 1 )
1918 /* If the port has capability to detect stack overflow,
1919 * pass the stack end address to the stack initialization
1920 * function as well. */
1921 #if ( portHAS_STACK_OVERFLOW_CHECKING == 1 )
1923 #if ( portSTACK_GROWTH < 0 )
1925 pxNewTCB->pxTopOfStack = pxPortInitialiseStack( pxTopOfStack, pxNewTCB->pxStack, pxTaskCode, pvParameters, xRunPrivileged, &( pxNewTCB->xMPUSettings ) );
1927 #else /* portSTACK_GROWTH */
1929 pxNewTCB->pxTopOfStack = pxPortInitialiseStack( pxTopOfStack, pxNewTCB->pxEndOfStack, pxTaskCode, pvParameters, xRunPrivileged, &( pxNewTCB->xMPUSettings ) );
1931 #endif /* portSTACK_GROWTH */
1933 #else /* portHAS_STACK_OVERFLOW_CHECKING */
1935 pxNewTCB->pxTopOfStack = pxPortInitialiseStack( pxTopOfStack, pxTaskCode, pvParameters, xRunPrivileged, &( pxNewTCB->xMPUSettings ) );
1937 #endif /* portHAS_STACK_OVERFLOW_CHECKING */
1939 #else /* portUSING_MPU_WRAPPERS */
1941 /* If the port has capability to detect stack overflow,
1942 * pass the stack end address to the stack initialization
1943 * function as well. */
1944 #if ( portHAS_STACK_OVERFLOW_CHECKING == 1 )
1946 #if ( portSTACK_GROWTH < 0 )
1948 pxNewTCB->pxTopOfStack = pxPortInitialiseStack( pxTopOfStack, pxNewTCB->pxStack, pxTaskCode, pvParameters );
1950 #else /* portSTACK_GROWTH */
1952 pxNewTCB->pxTopOfStack = pxPortInitialiseStack( pxTopOfStack, pxNewTCB->pxEndOfStack, pxTaskCode, pvParameters );
1954 #endif /* portSTACK_GROWTH */
1956 #else /* portHAS_STACK_OVERFLOW_CHECKING */
1958 pxNewTCB->pxTopOfStack = pxPortInitialiseStack( pxTopOfStack, pxTaskCode, pvParameters );
1960 #endif /* portHAS_STACK_OVERFLOW_CHECKING */
1962 #endif /* portUSING_MPU_WRAPPERS */
1964 /* Initialize task state and task attributes. */
1965 #if ( configNUMBER_OF_CORES > 1 )
1967 pxNewTCB->xTaskRunState = taskTASK_NOT_RUNNING;
1969 /* Is this an idle task? */
1970 if( ( ( TaskFunction_t ) pxTaskCode == ( TaskFunction_t ) prvIdleTask ) || ( ( TaskFunction_t ) pxTaskCode == ( TaskFunction_t ) prvPassiveIdleTask ) )
1972 pxNewTCB->uxTaskAttributes |= taskATTRIBUTE_IS_IDLE;
1975 #endif /* #if ( configNUMBER_OF_CORES > 1 ) */
1977 if( pxCreatedTask != NULL )
1979 /* Pass the handle out in an anonymous way. The handle can be used to
1980 * change the created task's priority, delete the created task, etc.*/
1981 *pxCreatedTask = ( TaskHandle_t ) pxNewTCB;
1985 mtCOVERAGE_TEST_MARKER();
1988 /*-----------------------------------------------------------*/
1990 #if ( configNUMBER_OF_CORES == 1 )
1992 static void prvAddNewTaskToReadyList( TCB_t * pxNewTCB )
1994 /* Ensure interrupts don't access the task lists while the lists are being
1996 taskENTER_CRITICAL();
1998 uxCurrentNumberOfTasks++;
2000 if( pxCurrentTCB == NULL )
2002 /* There are no other tasks, or all the other tasks are in
2003 * the suspended state - make this the current task. */
2004 pxCurrentTCB = pxNewTCB;
2006 if( uxCurrentNumberOfTasks == ( UBaseType_t ) 1 )
2008 /* This is the first task to be created so do the preliminary
2009 * initialisation required. We will not recover if this call
2010 * fails, but we will report the failure. */
2011 prvInitialiseTaskLists();
2015 mtCOVERAGE_TEST_MARKER();
2020 /* If the scheduler is not already running, make this task the
2021 * current task if it is the highest priority task to be created
2023 if( xSchedulerRunning == pdFALSE )
2025 if( pxCurrentTCB->uxPriority <= pxNewTCB->uxPriority )
2027 pxCurrentTCB = pxNewTCB;
2031 mtCOVERAGE_TEST_MARKER();
2036 mtCOVERAGE_TEST_MARKER();
2042 #if ( configUSE_TRACE_FACILITY == 1 )
2044 /* Add a counter into the TCB for tracing only. */
2045 pxNewTCB->uxTCBNumber = uxTaskNumber;
2047 #endif /* configUSE_TRACE_FACILITY */
2048 traceTASK_CREATE( pxNewTCB );
2050 prvAddTaskToReadyList( pxNewTCB );
2052 portSETUP_TCB( pxNewTCB );
2054 taskEXIT_CRITICAL();
2056 if( xSchedulerRunning != pdFALSE )
2058 /* If the created task is of a higher priority than the current task
2059 * then it should run now. */
2060 taskYIELD_ANY_CORE_IF_USING_PREEMPTION( pxNewTCB );
2064 mtCOVERAGE_TEST_MARKER();
2068 #else /* #if ( configNUMBER_OF_CORES == 1 ) */
2070 static void prvAddNewTaskToReadyList( TCB_t * pxNewTCB )
2072 /* Ensure interrupts don't access the task lists while the lists are being
2074 taskENTER_CRITICAL();
2076 uxCurrentNumberOfTasks++;
2078 if( xSchedulerRunning == pdFALSE )
2080 if( uxCurrentNumberOfTasks == ( UBaseType_t ) 1 )
2082 /* This is the first task to be created so do the preliminary
2083 * initialisation required. We will not recover if this call
2084 * fails, but we will report the failure. */
2085 prvInitialiseTaskLists();
2089 mtCOVERAGE_TEST_MARKER();
2092 if( ( pxNewTCB->uxTaskAttributes & taskATTRIBUTE_IS_IDLE ) != 0U )
2096 /* Check if a core is free. */
2097 for( xCoreID = ( BaseType_t ) 0; xCoreID < ( BaseType_t ) configNUMBER_OF_CORES; xCoreID++ )
2099 if( pxCurrentTCBs[ xCoreID ] == NULL )
2101 pxNewTCB->xTaskRunState = xCoreID;
2102 pxCurrentTCBs[ xCoreID ] = pxNewTCB;
2107 mtCOVERAGE_TEST_MARKER();
2113 mtCOVERAGE_TEST_MARKER();
2119 #if ( configUSE_TRACE_FACILITY == 1 )
2121 /* Add a counter into the TCB for tracing only. */
2122 pxNewTCB->uxTCBNumber = uxTaskNumber;
2124 #endif /* configUSE_TRACE_FACILITY */
2125 traceTASK_CREATE( pxNewTCB );
2127 prvAddTaskToReadyList( pxNewTCB );
2129 portSETUP_TCB( pxNewTCB );
2131 if( xSchedulerRunning != pdFALSE )
2133 /* If the created task is of a higher priority than another
2134 * currently running task and preemption is on then it should
2136 taskYIELD_ANY_CORE_IF_USING_PREEMPTION( pxNewTCB );
2140 mtCOVERAGE_TEST_MARKER();
2143 taskEXIT_CRITICAL();
2146 #endif /* #if ( configNUMBER_OF_CORES == 1 ) */
2147 /*-----------------------------------------------------------*/
2149 #if ( ( configUSE_TRACE_FACILITY == 1 ) && ( configUSE_STATS_FORMATTING_FUNCTIONS > 0 ) )
2151 static size_t prvSnprintfReturnValueToCharsWritten( int iSnprintfReturnValue,
2154 size_t uxCharsWritten;
2156 if( iSnprintfReturnValue < 0 )
2158 /* Encoding error - Return 0 to indicate that nothing
2159 * was written to the buffer. */
2162 else if( iSnprintfReturnValue >= ( int ) n )
2164 /* This is the case when the supplied buffer is not
2165 * large to hold the generated string. Return the
2166 * number of characters actually written without
2167 * counting the terminating NULL character. */
2168 uxCharsWritten = n - 1;
2172 /* Complete string was written to the buffer. */
2173 uxCharsWritten = ( size_t ) iSnprintfReturnValue;
2176 return uxCharsWritten;
2179 #endif /* #if ( ( configUSE_TRACE_FACILITY == 1 ) && ( configUSE_STATS_FORMATTING_FUNCTIONS > 0 ) ) */
2180 /*-----------------------------------------------------------*/
2182 #if ( INCLUDE_vTaskDelete == 1 )
2184 void vTaskDelete( TaskHandle_t xTaskToDelete )
2188 traceENTER_vTaskDelete( xTaskToDelete );
2190 taskENTER_CRITICAL();
2192 /* If null is passed in here then it is the calling task that is
2194 pxTCB = prvGetTCBFromHandle( xTaskToDelete );
2196 /* Remove task from the ready/delayed list. */
2197 if( uxListRemove( &( pxTCB->xStateListItem ) ) == ( UBaseType_t ) 0 )
2199 taskRESET_READY_PRIORITY( pxTCB->uxPriority );
2203 mtCOVERAGE_TEST_MARKER();
2206 /* Is the task waiting on an event also? */
2207 if( listLIST_ITEM_CONTAINER( &( pxTCB->xEventListItem ) ) != NULL )
2209 ( void ) uxListRemove( &( pxTCB->xEventListItem ) );
2213 mtCOVERAGE_TEST_MARKER();
2216 /* Increment the uxTaskNumber also so kernel aware debuggers can
2217 * detect that the task lists need re-generating. This is done before
2218 * portPRE_TASK_DELETE_HOOK() as in the Windows port that macro will
2222 /* If the task is running (or yielding), we must add it to the
2223 * termination list so that an idle task can delete it when it is
2224 * no longer running. */
2225 if( taskTASK_IS_RUNNING_OR_SCHEDULED_TO_YIELD( pxTCB ) != pdFALSE )
2227 /* A running task or a task which is scheduled to yield is being
2228 * deleted. This cannot complete when the task is still running
2229 * on a core, as a context switch to another task is required.
2230 * Place the task in the termination list. The idle task will check
2231 * the termination list and free up any memory allocated by the
2232 * scheduler for the TCB and stack of the deleted task. */
2233 vListInsertEnd( &xTasksWaitingTermination, &( pxTCB->xStateListItem ) );
2235 /* Increment the ucTasksDeleted variable so the idle task knows
2236 * there is a task that has been deleted and that it should therefore
2237 * check the xTasksWaitingTermination list. */
2238 ++uxDeletedTasksWaitingCleanUp;
2240 /* Call the delete hook before portPRE_TASK_DELETE_HOOK() as
2241 * portPRE_TASK_DELETE_HOOK() does not return in the Win32 port. */
2242 traceTASK_DELETE( pxTCB );
2244 /* The pre-delete hook is primarily for the Windows simulator,
2245 * in which Windows specific clean up operations are performed,
2246 * after which it is not possible to yield away from this task -
2247 * hence xYieldPending is used to latch that a context switch is
2249 #if ( configNUMBER_OF_CORES == 1 )
2250 portPRE_TASK_DELETE_HOOK( pxTCB, &( xYieldPendings[ 0 ] ) );
2252 portPRE_TASK_DELETE_HOOK( pxTCB, &( xYieldPendings[ pxTCB->xTaskRunState ] ) );
2257 --uxCurrentNumberOfTasks;
2258 traceTASK_DELETE( pxTCB );
2260 /* Reset the next expected unblock time in case it referred to
2261 * the task that has just been deleted. */
2262 prvResetNextTaskUnblockTime();
2266 #if ( configNUMBER_OF_CORES == 1 )
2268 taskEXIT_CRITICAL();
2270 /* If the task is not deleting itself, call prvDeleteTCB from outside of
2271 * critical section. If a task deletes itself, prvDeleteTCB is called
2272 * from prvCheckTasksWaitingTermination which is called from Idle task. */
2273 if( pxTCB != pxCurrentTCB )
2275 prvDeleteTCB( pxTCB );
2278 /* Force a reschedule if it is the currently running task that has just
2280 if( xSchedulerRunning != pdFALSE )
2282 if( pxTCB == pxCurrentTCB )
2284 configASSERT( uxSchedulerSuspended == 0 );
2285 portYIELD_WITHIN_API();
2289 mtCOVERAGE_TEST_MARKER();
2293 #else /* #if ( configNUMBER_OF_CORES == 1 ) */
2295 /* If a running task is not deleting itself, call prvDeleteTCB. If a running
2296 * task deletes itself, prvDeleteTCB is called from prvCheckTasksWaitingTermination
2297 * which is called from Idle task. */
2298 if( pxTCB->xTaskRunState == taskTASK_NOT_RUNNING )
2300 prvDeleteTCB( pxTCB );
2303 /* Force a reschedule if the task that has just been deleted was running. */
2304 if( ( xSchedulerRunning != pdFALSE ) && ( taskTASK_IS_RUNNING( pxTCB ) == pdTRUE ) )
2306 if( pxTCB->xTaskRunState == ( BaseType_t ) portGET_CORE_ID() )
2308 configASSERT( uxSchedulerSuspended == 0 );
2309 vTaskYieldWithinAPI();
2313 prvYieldCore( pxTCB->xTaskRunState );
2317 taskEXIT_CRITICAL();
2319 #endif /* #if ( configNUMBER_OF_CORES == 1 ) */
2321 traceRETURN_vTaskDelete();
2324 #endif /* INCLUDE_vTaskDelete */
2325 /*-----------------------------------------------------------*/
2327 #if ( INCLUDE_xTaskDelayUntil == 1 )
2329 BaseType_t xTaskDelayUntil( TickType_t * const pxPreviousWakeTime,
2330 const TickType_t xTimeIncrement )
2332 TickType_t xTimeToWake;
2333 BaseType_t xAlreadyYielded, xShouldDelay = pdFALSE;
2335 traceENTER_xTaskDelayUntil( pxPreviousWakeTime, xTimeIncrement );
2337 configASSERT( pxPreviousWakeTime );
2338 configASSERT( ( xTimeIncrement > 0U ) );
2342 /* Minor optimisation. The tick count cannot change in this
2344 const TickType_t xConstTickCount = xTickCount;
2346 configASSERT( uxSchedulerSuspended == 1U );
2348 /* Generate the tick time at which the task wants to wake. */
2349 xTimeToWake = *pxPreviousWakeTime + xTimeIncrement;
2351 if( xConstTickCount < *pxPreviousWakeTime )
2353 /* The tick count has overflowed since this function was
2354 * lasted called. In this case the only time we should ever
2355 * actually delay is if the wake time has also overflowed,
2356 * and the wake time is greater than the tick time. When this
2357 * is the case it is as if neither time had overflowed. */
2358 if( ( xTimeToWake < *pxPreviousWakeTime ) && ( xTimeToWake > xConstTickCount ) )
2360 xShouldDelay = pdTRUE;
2364 mtCOVERAGE_TEST_MARKER();
2369 /* The tick time has not overflowed. In this case we will
2370 * delay if either the wake time has overflowed, and/or the
2371 * tick time is less than the wake time. */
2372 if( ( xTimeToWake < *pxPreviousWakeTime ) || ( xTimeToWake > xConstTickCount ) )
2374 xShouldDelay = pdTRUE;
2378 mtCOVERAGE_TEST_MARKER();
2382 /* Update the wake time ready for the next call. */
2383 *pxPreviousWakeTime = xTimeToWake;
2385 if( xShouldDelay != pdFALSE )
2387 traceTASK_DELAY_UNTIL( xTimeToWake );
2389 /* prvAddCurrentTaskToDelayedList() needs the block time, not
2390 * the time to wake, so subtract the current tick count. */
2391 prvAddCurrentTaskToDelayedList( xTimeToWake - xConstTickCount, pdFALSE );
2395 mtCOVERAGE_TEST_MARKER();
2398 xAlreadyYielded = xTaskResumeAll();
2400 /* Force a reschedule if xTaskResumeAll has not already done so, we may
2401 * have put ourselves to sleep. */
2402 if( xAlreadyYielded == pdFALSE )
2404 taskYIELD_WITHIN_API();
2408 mtCOVERAGE_TEST_MARKER();
2411 traceRETURN_xTaskDelayUntil( xShouldDelay );
2413 return xShouldDelay;
2416 #endif /* INCLUDE_xTaskDelayUntil */
2417 /*-----------------------------------------------------------*/
2419 #if ( INCLUDE_vTaskDelay == 1 )
2421 void vTaskDelay( const TickType_t xTicksToDelay )
2423 BaseType_t xAlreadyYielded = pdFALSE;
2425 traceENTER_vTaskDelay( xTicksToDelay );
2427 /* A delay time of zero just forces a reschedule. */
2428 if( xTicksToDelay > ( TickType_t ) 0U )
2432 configASSERT( uxSchedulerSuspended == 1U );
2436 /* A task that is removed from the event list while the
2437 * scheduler is suspended will not get placed in the ready
2438 * list or removed from the blocked list until the scheduler
2441 * This task cannot be in an event list as it is the currently
2442 * executing task. */
2443 prvAddCurrentTaskToDelayedList( xTicksToDelay, pdFALSE );
2445 xAlreadyYielded = xTaskResumeAll();
2449 mtCOVERAGE_TEST_MARKER();
2452 /* Force a reschedule if xTaskResumeAll has not already done so, we may
2453 * have put ourselves to sleep. */
2454 if( xAlreadyYielded == pdFALSE )
2456 taskYIELD_WITHIN_API();
2460 mtCOVERAGE_TEST_MARKER();
2463 traceRETURN_vTaskDelay();
2466 #endif /* INCLUDE_vTaskDelay */
2467 /*-----------------------------------------------------------*/
2469 #if ( ( INCLUDE_eTaskGetState == 1 ) || ( configUSE_TRACE_FACILITY == 1 ) || ( INCLUDE_xTaskAbortDelay == 1 ) )
2471 eTaskState eTaskGetState( TaskHandle_t xTask )
2474 List_t const * pxStateList;
2475 List_t const * pxEventList;
2476 List_t const * pxDelayedList;
2477 List_t const * pxOverflowedDelayedList;
2478 const TCB_t * const pxTCB = xTask;
2480 traceENTER_eTaskGetState( xTask );
2482 configASSERT( pxTCB );
2484 #if ( configNUMBER_OF_CORES == 1 )
2485 if( pxTCB == pxCurrentTCB )
2487 /* The task calling this function is querying its own state. */
2493 taskENTER_CRITICAL();
2495 pxStateList = listLIST_ITEM_CONTAINER( &( pxTCB->xStateListItem ) );
2496 pxEventList = listLIST_ITEM_CONTAINER( &( pxTCB->xEventListItem ) );
2497 pxDelayedList = pxDelayedTaskList;
2498 pxOverflowedDelayedList = pxOverflowDelayedTaskList;
2500 taskEXIT_CRITICAL();
2502 if( pxEventList == &xPendingReadyList )
2504 /* The task has been placed on the pending ready list, so its
2505 * state is eReady regardless of what list the task's state list
2506 * item is currently placed on. */
2509 else if( ( pxStateList == pxDelayedList ) || ( pxStateList == pxOverflowedDelayedList ) )
2511 /* The task being queried is referenced from one of the Blocked
2516 #if ( INCLUDE_vTaskSuspend == 1 )
2517 else if( pxStateList == &xSuspendedTaskList )
2519 /* The task being queried is referenced from the suspended
2520 * list. Is it genuinely suspended or is it blocked
2522 if( listLIST_ITEM_CONTAINER( &( pxTCB->xEventListItem ) ) == NULL )
2524 #if ( configUSE_TASK_NOTIFICATIONS == 1 )
2528 /* The task does not appear on the event list item of
2529 * and of the RTOS objects, but could still be in the
2530 * blocked state if it is waiting on its notification
2531 * rather than waiting on an object. If not, is
2533 eReturn = eSuspended;
2535 for( x = ( BaseType_t ) 0; x < ( BaseType_t ) configTASK_NOTIFICATION_ARRAY_ENTRIES; x++ )
2537 if( pxTCB->ucNotifyState[ x ] == taskWAITING_NOTIFICATION )
2544 #else /* if ( configUSE_TASK_NOTIFICATIONS == 1 ) */
2546 eReturn = eSuspended;
2548 #endif /* if ( configUSE_TASK_NOTIFICATIONS == 1 ) */
2555 #endif /* if ( INCLUDE_vTaskSuspend == 1 ) */
2557 #if ( INCLUDE_vTaskDelete == 1 )
2558 else if( ( pxStateList == &xTasksWaitingTermination ) || ( pxStateList == NULL ) )
2560 /* The task being queried is referenced from the deleted
2561 * tasks list, or it is not referenced from any lists at
2567 else /*lint !e525 Negative indentation is intended to make use of pre-processor clearer. */
2569 #if ( configNUMBER_OF_CORES == 1 )
2571 /* If the task is not in any other state, it must be in the
2572 * Ready (including pending ready) state. */
2575 #else /* #if ( configNUMBER_OF_CORES == 1 ) */
2577 if( taskTASK_IS_RUNNING( pxTCB ) == pdTRUE )
2579 /* Is it actively running on a core? */
2584 /* If the task is not in any other state, it must be in the
2585 * Ready (including pending ready) state. */
2589 #endif /* #if ( configNUMBER_OF_CORES == 1 ) */
2593 traceRETURN_eTaskGetState( eReturn );
2596 } /*lint !e818 xTask cannot be a pointer to const because it is a typedef. */
2598 #endif /* INCLUDE_eTaskGetState */
2599 /*-----------------------------------------------------------*/
2601 #if ( INCLUDE_uxTaskPriorityGet == 1 )
2603 UBaseType_t uxTaskPriorityGet( const TaskHandle_t xTask )
2605 TCB_t const * pxTCB;
2606 UBaseType_t uxReturn;
2608 traceENTER_uxTaskPriorityGet( xTask );
2610 taskENTER_CRITICAL();
2612 /* If null is passed in here then it is the priority of the task
2613 * that called uxTaskPriorityGet() that is being queried. */
2614 pxTCB = prvGetTCBFromHandle( xTask );
2615 uxReturn = pxTCB->uxPriority;
2617 taskEXIT_CRITICAL();
2619 traceRETURN_uxTaskPriorityGet( uxReturn );
2624 #endif /* INCLUDE_uxTaskPriorityGet */
2625 /*-----------------------------------------------------------*/
2627 #if ( INCLUDE_uxTaskPriorityGet == 1 )
2629 UBaseType_t uxTaskPriorityGetFromISR( const TaskHandle_t xTask )
2631 TCB_t const * pxTCB;
2632 UBaseType_t uxReturn;
2633 UBaseType_t uxSavedInterruptStatus;
2635 traceENTER_uxTaskPriorityGetFromISR( xTask );
2637 /* RTOS ports that support interrupt nesting have the concept of a
2638 * maximum system call (or maximum API call) interrupt priority.
2639 * Interrupts that are above the maximum system call priority are keep
2640 * permanently enabled, even when the RTOS kernel is in a critical section,
2641 * but cannot make any calls to FreeRTOS API functions. If configASSERT()
2642 * is defined in FreeRTOSConfig.h then
2643 * portASSERT_IF_INTERRUPT_PRIORITY_INVALID() will result in an assertion
2644 * failure if a FreeRTOS API function is called from an interrupt that has
2645 * been assigned a priority above the configured maximum system call
2646 * priority. Only FreeRTOS functions that end in FromISR can be called
2647 * from interrupts that have been assigned a priority at or (logically)
2648 * below the maximum system call interrupt priority. FreeRTOS maintains a
2649 * separate interrupt safe API to ensure interrupt entry is as fast and as
2650 * simple as possible. More information (albeit Cortex-M specific) is
2651 * provided on the following link:
2652 * https://www.FreeRTOS.org/RTOS-Cortex-M3-M4.html */
2653 portASSERT_IF_INTERRUPT_PRIORITY_INVALID();
2655 uxSavedInterruptStatus = taskENTER_CRITICAL_FROM_ISR();
2657 /* If null is passed in here then it is the priority of the calling
2658 * task that is being queried. */
2659 pxTCB = prvGetTCBFromHandle( xTask );
2660 uxReturn = pxTCB->uxPriority;
2662 taskEXIT_CRITICAL_FROM_ISR( uxSavedInterruptStatus );
2664 traceRETURN_uxTaskPriorityGetFromISR( uxReturn );
2669 #endif /* INCLUDE_uxTaskPriorityGet */
2670 /*-----------------------------------------------------------*/
2672 #if ( ( INCLUDE_uxTaskPriorityGet == 1 ) && ( configUSE_MUTEXES == 1 ) )
2674 UBaseType_t uxTaskBasePriorityGet( const TaskHandle_t xTask )
2676 TCB_t const * pxTCB;
2677 UBaseType_t uxReturn;
2679 traceENTER_uxTaskBasePriorityGet( xTask );
2681 taskENTER_CRITICAL();
2683 /* If null is passed in here then it is the base priority of the task
2684 * that called uxTaskBasePriorityGet() that is being queried. */
2685 pxTCB = prvGetTCBFromHandle( xTask );
2686 uxReturn = pxTCB->uxBasePriority;
2688 taskEXIT_CRITICAL();
2690 traceRETURN_uxTaskBasePriorityGet( uxReturn );
2695 #endif /* #if ( ( INCLUDE_uxTaskPriorityGet == 1 ) && ( configUSE_MUTEXES == 1 ) ) */
2696 /*-----------------------------------------------------------*/
2698 #if ( ( INCLUDE_uxTaskPriorityGet == 1 ) && ( configUSE_MUTEXES == 1 ) )
2700 UBaseType_t uxTaskBasePriorityGetFromISR( const TaskHandle_t xTask )
2702 TCB_t const * pxTCB;
2703 UBaseType_t uxReturn;
2704 UBaseType_t uxSavedInterruptStatus;
2706 traceENTER_uxTaskBasePriorityGetFromISR( xTask );
2708 /* RTOS ports that support interrupt nesting have the concept of a
2709 * maximum system call (or maximum API call) interrupt priority.
2710 * Interrupts that are above the maximum system call priority are keep
2711 * permanently enabled, even when the RTOS kernel is in a critical section,
2712 * but cannot make any calls to FreeRTOS API functions. If configASSERT()
2713 * is defined in FreeRTOSConfig.h then
2714 * portASSERT_IF_INTERRUPT_PRIORITY_INVALID() will result in an assertion
2715 * failure if a FreeRTOS API function is called from an interrupt that has
2716 * been assigned a priority above the configured maximum system call
2717 * priority. Only FreeRTOS functions that end in FromISR can be called
2718 * from interrupts that have been assigned a priority at or (logically)
2719 * below the maximum system call interrupt priority. FreeRTOS maintains a
2720 * separate interrupt safe API to ensure interrupt entry is as fast and as
2721 * simple as possible. More information (albeit Cortex-M specific) is
2722 * provided on the following link:
2723 * https://www.FreeRTOS.org/RTOS-Cortex-M3-M4.html */
2724 portASSERT_IF_INTERRUPT_PRIORITY_INVALID();
2726 uxSavedInterruptStatus = taskENTER_CRITICAL_FROM_ISR();
2728 /* If null is passed in here then it is the base priority of the calling
2729 * task that is being queried. */
2730 pxTCB = prvGetTCBFromHandle( xTask );
2731 uxReturn = pxTCB->uxBasePriority;
2733 taskEXIT_CRITICAL_FROM_ISR( uxSavedInterruptStatus );
2735 traceRETURN_uxTaskBasePriorityGetFromISR( uxReturn );
2740 #endif /* #if ( ( INCLUDE_uxTaskPriorityGet == 1 ) && ( configUSE_MUTEXES == 1 ) ) */
2741 /*-----------------------------------------------------------*/
2743 #if ( INCLUDE_vTaskPrioritySet == 1 )
2745 void vTaskPrioritySet( TaskHandle_t xTask,
2746 UBaseType_t uxNewPriority )
2749 UBaseType_t uxCurrentBasePriority, uxPriorityUsedOnEntry;
2750 BaseType_t xYieldRequired = pdFALSE;
2752 #if ( configNUMBER_OF_CORES > 1 )
2753 BaseType_t xYieldForTask = pdFALSE;
2756 traceENTER_vTaskPrioritySet( xTask, uxNewPriority );
2758 configASSERT( uxNewPriority < configMAX_PRIORITIES );
2760 /* Ensure the new priority is valid. */
2761 if( uxNewPriority >= ( UBaseType_t ) configMAX_PRIORITIES )
2763 uxNewPriority = ( UBaseType_t ) configMAX_PRIORITIES - ( UBaseType_t ) 1U;
2767 mtCOVERAGE_TEST_MARKER();
2770 taskENTER_CRITICAL();
2772 /* If null is passed in here then it is the priority of the calling
2773 * task that is being changed. */
2774 pxTCB = prvGetTCBFromHandle( xTask );
2776 traceTASK_PRIORITY_SET( pxTCB, uxNewPriority );
2778 #if ( configUSE_MUTEXES == 1 )
2780 uxCurrentBasePriority = pxTCB->uxBasePriority;
2784 uxCurrentBasePriority = pxTCB->uxPriority;
2788 if( uxCurrentBasePriority != uxNewPriority )
2790 /* The priority change may have readied a task of higher
2791 * priority than a running task. */
2792 if( uxNewPriority > uxCurrentBasePriority )
2794 #if ( configNUMBER_OF_CORES == 1 )
2796 if( pxTCB != pxCurrentTCB )
2798 /* The priority of a task other than the currently
2799 * running task is being raised. Is the priority being
2800 * raised above that of the running task? */
2801 if( uxNewPriority > pxCurrentTCB->uxPriority )
2803 xYieldRequired = pdTRUE;
2807 mtCOVERAGE_TEST_MARKER();
2812 /* The priority of the running task is being raised,
2813 * but the running task must already be the highest
2814 * priority task able to run so no yield is required. */
2817 #else /* #if ( configNUMBER_OF_CORES == 1 ) */
2819 /* The priority of a task is being raised so
2820 * perform a yield for this task later. */
2821 xYieldForTask = pdTRUE;
2823 #endif /* #if ( configNUMBER_OF_CORES == 1 ) */
2825 else if( taskTASK_IS_RUNNING( pxTCB ) == pdTRUE )
2827 /* Setting the priority of a running task down means
2828 * there may now be another task of higher priority that
2829 * is ready to execute. */
2830 #if ( configUSE_TASK_PREEMPTION_DISABLE == 1 )
2831 if( pxTCB->xPreemptionDisable == pdFALSE )
2834 xYieldRequired = pdTRUE;
2839 /* Setting the priority of any other task down does not
2840 * require a yield as the running task must be above the
2841 * new priority of the task being modified. */
2844 /* Remember the ready list the task might be referenced from
2845 * before its uxPriority member is changed so the
2846 * taskRESET_READY_PRIORITY() macro can function correctly. */
2847 uxPriorityUsedOnEntry = pxTCB->uxPriority;
2849 #if ( configUSE_MUTEXES == 1 )
2851 /* Only change the priority being used if the task is not
2852 * currently using an inherited priority or the new priority
2853 * is bigger than the inherited priority. */
2854 if( ( pxTCB->uxBasePriority == pxTCB->uxPriority ) || ( uxNewPriority > pxTCB->uxPriority ) )
2856 pxTCB->uxPriority = uxNewPriority;
2860 mtCOVERAGE_TEST_MARKER();
2863 /* The base priority gets set whatever. */
2864 pxTCB->uxBasePriority = uxNewPriority;
2866 #else /* if ( configUSE_MUTEXES == 1 ) */
2868 pxTCB->uxPriority = uxNewPriority;
2870 #endif /* if ( configUSE_MUTEXES == 1 ) */
2872 /* Only reset the event list item value if the value is not
2873 * being used for anything else. */
2874 if( ( listGET_LIST_ITEM_VALUE( &( pxTCB->xEventListItem ) ) & taskEVENT_LIST_ITEM_VALUE_IN_USE ) == 0UL )
2876 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. */
2880 mtCOVERAGE_TEST_MARKER();
2883 /* If the task is in the blocked or suspended list we need do
2884 * nothing more than change its priority variable. However, if
2885 * the task is in a ready list it needs to be removed and placed
2886 * in the list appropriate to its new priority. */
2887 if( listIS_CONTAINED_WITHIN( &( pxReadyTasksLists[ uxPriorityUsedOnEntry ] ), &( pxTCB->xStateListItem ) ) != pdFALSE )
2889 /* The task is currently in its ready list - remove before
2890 * adding it to its new ready list. As we are in a critical
2891 * section we can do this even if the scheduler is suspended. */
2892 if( uxListRemove( &( pxTCB->xStateListItem ) ) == ( UBaseType_t ) 0 )
2894 /* It is known that the task is in its ready list so
2895 * there is no need to check again and the port level
2896 * reset macro can be called directly. */
2897 portRESET_READY_PRIORITY( uxPriorityUsedOnEntry, uxTopReadyPriority );
2901 mtCOVERAGE_TEST_MARKER();
2904 prvAddTaskToReadyList( pxTCB );
2908 #if ( configNUMBER_OF_CORES == 1 )
2910 mtCOVERAGE_TEST_MARKER();
2914 /* It's possible that xYieldForTask was already set to pdTRUE because
2915 * its priority is being raised. However, since it is not in a ready list
2916 * we don't actually need to yield for it. */
2917 xYieldForTask = pdFALSE;
2922 if( xYieldRequired != pdFALSE )
2924 /* The running task priority is set down. Request the task to yield. */
2925 taskYIELD_TASK_CORE_IF_USING_PREEMPTION( pxTCB );
2929 #if ( configNUMBER_OF_CORES > 1 )
2930 if( xYieldForTask != pdFALSE )
2932 /* The priority of the task is being raised. If a running
2933 * task has priority lower than this task, it should yield
2935 taskYIELD_ANY_CORE_IF_USING_PREEMPTION( pxTCB );
2938 #endif /* if ( configNUMBER_OF_CORES > 1 ) */
2940 mtCOVERAGE_TEST_MARKER();
2944 /* Remove compiler warning about unused variables when the port
2945 * optimised task selection is not being used. */
2946 ( void ) uxPriorityUsedOnEntry;
2949 taskEXIT_CRITICAL();
2951 traceRETURN_vTaskPrioritySet();
2954 #endif /* INCLUDE_vTaskPrioritySet */
2955 /*-----------------------------------------------------------*/
2957 #if ( ( configNUMBER_OF_CORES > 1 ) && ( configUSE_CORE_AFFINITY == 1 ) )
2958 void vTaskCoreAffinitySet( const TaskHandle_t xTask,
2959 UBaseType_t uxCoreAffinityMask )
2963 UBaseType_t uxPrevCoreAffinityMask;
2965 #if ( configUSE_PREEMPTION == 1 )
2966 UBaseType_t uxPrevNotAllowedCores;
2969 traceENTER_vTaskCoreAffinitySet( xTask, uxCoreAffinityMask );
2971 taskENTER_CRITICAL();
2973 pxTCB = prvGetTCBFromHandle( xTask );
2975 uxPrevCoreAffinityMask = pxTCB->uxCoreAffinityMask;
2976 pxTCB->uxCoreAffinityMask = uxCoreAffinityMask;
2978 if( xSchedulerRunning != pdFALSE )
2980 if( taskTASK_IS_RUNNING( pxTCB ) == pdTRUE )
2982 xCoreID = ( BaseType_t ) pxTCB->xTaskRunState;
2984 /* If the task can no longer run on the core it was running,
2985 * request the core to yield. */
2986 if( ( uxCoreAffinityMask & ( ( UBaseType_t ) 1U << ( UBaseType_t ) xCoreID ) ) == 0U )
2988 prvYieldCore( xCoreID );
2993 #if ( configUSE_PREEMPTION == 1 )
2995 /* Calculate the cores on which this task was not allowed to
2996 * run previously. */
2997 uxPrevNotAllowedCores = ( ~uxPrevCoreAffinityMask ) & ( ( 1U << configNUMBER_OF_CORES ) - 1U );
2999 /* Does the new core mask enables this task to run on any of the
3000 * previously not allowed cores? If yes, check if this task can be
3001 * scheduled on any of those cores. */
3002 if( ( uxPrevNotAllowedCores & uxCoreAffinityMask ) != 0U )
3004 prvYieldForTask( pxTCB );
3007 #else /* #if( configUSE_PREEMPTION == 1 ) */
3009 mtCOVERAGE_TEST_MARKER();
3011 #endif /* #if( configUSE_PREEMPTION == 1 ) */
3015 taskEXIT_CRITICAL();
3017 traceRETURN_vTaskCoreAffinitySet();
3019 #endif /* #if ( ( configNUMBER_OF_CORES > 1 ) && ( configUSE_CORE_AFFINITY == 1 ) ) */
3020 /*-----------------------------------------------------------*/
3022 #if ( ( configNUMBER_OF_CORES > 1 ) && ( configUSE_CORE_AFFINITY == 1 ) )
3023 UBaseType_t vTaskCoreAffinityGet( ConstTaskHandle_t xTask )
3025 const TCB_t * pxTCB;
3026 UBaseType_t uxCoreAffinityMask;
3028 traceENTER_vTaskCoreAffinityGet( xTask );
3030 taskENTER_CRITICAL();
3032 pxTCB = prvGetTCBFromHandle( xTask );
3033 uxCoreAffinityMask = pxTCB->uxCoreAffinityMask;
3035 taskEXIT_CRITICAL();
3037 traceRETURN_vTaskCoreAffinityGet( uxCoreAffinityMask );
3039 return uxCoreAffinityMask;
3041 #endif /* #if ( ( configNUMBER_OF_CORES > 1 ) && ( configUSE_CORE_AFFINITY == 1 ) ) */
3043 /*-----------------------------------------------------------*/
3045 #if ( configUSE_TASK_PREEMPTION_DISABLE == 1 )
3047 void vTaskPreemptionDisable( const TaskHandle_t xTask )
3051 traceENTER_vTaskPreemptionDisable( xTask );
3053 taskENTER_CRITICAL();
3055 pxTCB = prvGetTCBFromHandle( xTask );
3057 pxTCB->xPreemptionDisable = pdTRUE;
3059 taskEXIT_CRITICAL();
3061 traceRETURN_vTaskPreemptionDisable();
3064 #endif /* #if ( configUSE_TASK_PREEMPTION_DISABLE == 1 ) */
3065 /*-----------------------------------------------------------*/
3067 #if ( configUSE_TASK_PREEMPTION_DISABLE == 1 )
3069 void vTaskPreemptionEnable( const TaskHandle_t xTask )
3074 traceENTER_vTaskPreemptionEnable( xTask );
3076 taskENTER_CRITICAL();
3078 pxTCB = prvGetTCBFromHandle( xTask );
3080 pxTCB->xPreemptionDisable = pdFALSE;
3082 if( xSchedulerRunning != pdFALSE )
3084 if( taskTASK_IS_RUNNING( pxTCB ) == pdTRUE )
3086 xCoreID = ( BaseType_t ) pxTCB->xTaskRunState;
3087 prvYieldCore( xCoreID );
3091 taskEXIT_CRITICAL();
3093 traceRETURN_vTaskPreemptionEnable();
3096 #endif /* #if ( configUSE_TASK_PREEMPTION_DISABLE == 1 ) */
3097 /*-----------------------------------------------------------*/
3099 #if ( INCLUDE_vTaskSuspend == 1 )
3101 void vTaskSuspend( TaskHandle_t xTaskToSuspend )
3105 #if ( configNUMBER_OF_CORES > 1 )
3106 BaseType_t xTaskRunningOnCore;
3109 traceENTER_vTaskSuspend( xTaskToSuspend );
3111 taskENTER_CRITICAL();
3113 /* If null is passed in here then it is the running task that is
3114 * being suspended. */
3115 pxTCB = prvGetTCBFromHandle( xTaskToSuspend );
3117 traceTASK_SUSPEND( pxTCB );
3119 #if ( configNUMBER_OF_CORES > 1 )
3120 xTaskRunningOnCore = pxTCB->xTaskRunState;
3123 /* Remove task from the ready/delayed list and place in the
3124 * suspended list. */
3125 if( uxListRemove( &( pxTCB->xStateListItem ) ) == ( UBaseType_t ) 0 )
3127 taskRESET_READY_PRIORITY( pxTCB->uxPriority );
3131 mtCOVERAGE_TEST_MARKER();
3134 /* Is the task waiting on an event also? */
3135 if( listLIST_ITEM_CONTAINER( &( pxTCB->xEventListItem ) ) != NULL )
3137 ( void ) uxListRemove( &( pxTCB->xEventListItem ) );
3141 mtCOVERAGE_TEST_MARKER();
3144 vListInsertEnd( &xSuspendedTaskList, &( pxTCB->xStateListItem ) );
3146 #if ( configUSE_TASK_NOTIFICATIONS == 1 )
3150 for( x = ( BaseType_t ) 0; x < ( BaseType_t ) configTASK_NOTIFICATION_ARRAY_ENTRIES; x++ )
3152 if( pxTCB->ucNotifyState[ x ] == taskWAITING_NOTIFICATION )
3154 /* The task was blocked to wait for a notification, but is
3155 * now suspended, so no notification was received. */
3156 pxTCB->ucNotifyState[ x ] = taskNOT_WAITING_NOTIFICATION;
3160 #endif /* if ( configUSE_TASK_NOTIFICATIONS == 1 ) */
3163 #if ( configNUMBER_OF_CORES == 1 )
3165 taskEXIT_CRITICAL();
3167 if( xSchedulerRunning != pdFALSE )
3169 /* Reset the next expected unblock time in case it referred to the
3170 * task that is now in the Suspended state. */
3171 taskENTER_CRITICAL();
3173 prvResetNextTaskUnblockTime();
3175 taskEXIT_CRITICAL();
3179 mtCOVERAGE_TEST_MARKER();
3182 if( pxTCB == pxCurrentTCB )
3184 if( xSchedulerRunning != pdFALSE )
3186 /* The current task has just been suspended. */
3187 configASSERT( uxSchedulerSuspended == 0 );
3188 portYIELD_WITHIN_API();
3192 /* The scheduler is not running, but the task that was pointed
3193 * to by pxCurrentTCB has just been suspended and pxCurrentTCB
3194 * must be adjusted to point to a different task. */
3195 if( listCURRENT_LIST_LENGTH( &xSuspendedTaskList ) == uxCurrentNumberOfTasks ) /*lint !e931 Right has no side effect, just volatile. */
3197 /* No other tasks are ready, so set pxCurrentTCB back to
3198 * NULL so when the next task is created pxCurrentTCB will
3199 * be set to point to it no matter what its relative priority
3201 pxCurrentTCB = NULL;
3205 vTaskSwitchContext();
3211 mtCOVERAGE_TEST_MARKER();
3214 #else /* #if ( configNUMBER_OF_CORES == 1 ) */
3216 if( xSchedulerRunning != pdFALSE )
3218 /* Reset the next expected unblock time in case it referred to the
3219 * task that is now in the Suspended state. */
3220 prvResetNextTaskUnblockTime();
3224 mtCOVERAGE_TEST_MARKER();
3227 if( taskTASK_IS_RUNNING( pxTCB ) == pdTRUE )
3229 if( xSchedulerRunning != pdFALSE )
3231 if( xTaskRunningOnCore == ( BaseType_t ) portGET_CORE_ID() )
3233 /* The current task has just been suspended. */
3234 configASSERT( uxSchedulerSuspended == 0 );
3235 vTaskYieldWithinAPI();
3239 prvYieldCore( xTaskRunningOnCore );
3244 /* This code path is not possible because only Idle tasks are
3245 * assigned a core before the scheduler is started ( i.e.
3246 * taskTASK_IS_RUNNING is only true for idle tasks before
3247 * the scheduler is started ) and idle tasks cannot be
3249 mtCOVERAGE_TEST_MARKER();
3254 mtCOVERAGE_TEST_MARKER();
3257 taskEXIT_CRITICAL();
3259 #endif /* #if ( configNUMBER_OF_CORES == 1 ) */
3261 traceRETURN_vTaskSuspend();
3264 #endif /* INCLUDE_vTaskSuspend */
3265 /*-----------------------------------------------------------*/
3267 #if ( INCLUDE_vTaskSuspend == 1 )
3269 static BaseType_t prvTaskIsTaskSuspended( const TaskHandle_t xTask )
3271 BaseType_t xReturn = pdFALSE;
3272 const TCB_t * const pxTCB = xTask;
3274 /* Accesses xPendingReadyList so must be called from a critical
3277 /* It does not make sense to check if the calling task is suspended. */
3278 configASSERT( xTask );
3280 /* Is the task being resumed actually in the suspended list? */
3281 if( listIS_CONTAINED_WITHIN( &xSuspendedTaskList, &( pxTCB->xStateListItem ) ) != pdFALSE )
3283 /* Has the task already been resumed from within an ISR? */
3284 if( listIS_CONTAINED_WITHIN( &xPendingReadyList, &( pxTCB->xEventListItem ) ) == pdFALSE )
3286 /* Is it in the suspended list because it is in the Suspended
3287 * state, or because is is blocked with no timeout? */
3288 if( listIS_CONTAINED_WITHIN( NULL, &( pxTCB->xEventListItem ) ) != pdFALSE ) /*lint !e961. The cast is only redundant when NULL is used. */
3294 mtCOVERAGE_TEST_MARKER();
3299 mtCOVERAGE_TEST_MARKER();
3304 mtCOVERAGE_TEST_MARKER();
3308 } /*lint !e818 xTask cannot be a pointer to const because it is a typedef. */
3310 #endif /* INCLUDE_vTaskSuspend */
3311 /*-----------------------------------------------------------*/
3313 #if ( INCLUDE_vTaskSuspend == 1 )
3315 void vTaskResume( TaskHandle_t xTaskToResume )
3317 TCB_t * const pxTCB = xTaskToResume;
3319 traceENTER_vTaskResume( xTaskToResume );
3321 /* It does not make sense to resume the calling task. */
3322 configASSERT( xTaskToResume );
3324 #if ( configNUMBER_OF_CORES == 1 )
3326 /* The parameter cannot be NULL as it is impossible to resume the
3327 * currently executing task. */
3328 if( ( pxTCB != pxCurrentTCB ) && ( pxTCB != NULL ) )
3331 /* The parameter cannot be NULL as it is impossible to resume the
3332 * currently executing task. It is also impossible to resume a task
3333 * that is actively running on another core but it is not safe
3334 * to check their run state here. Therefore, we get into a critical
3335 * section and check if the task is actually suspended or not. */
3339 taskENTER_CRITICAL();
3341 if( prvTaskIsTaskSuspended( pxTCB ) != pdFALSE )
3343 traceTASK_RESUME( pxTCB );
3345 /* The ready list can be accessed even if the scheduler is
3346 * suspended because this is inside a critical section. */
3347 ( void ) uxListRemove( &( pxTCB->xStateListItem ) );
3348 prvAddTaskToReadyList( pxTCB );
3350 /* This yield may not cause the task just resumed to run,
3351 * but will leave the lists in the correct state for the
3353 taskYIELD_ANY_CORE_IF_USING_PREEMPTION( pxTCB );
3357 mtCOVERAGE_TEST_MARKER();
3360 taskEXIT_CRITICAL();
3364 mtCOVERAGE_TEST_MARKER();
3367 traceRETURN_vTaskResume();
3370 #endif /* INCLUDE_vTaskSuspend */
3372 /*-----------------------------------------------------------*/
3374 #if ( ( INCLUDE_xTaskResumeFromISR == 1 ) && ( INCLUDE_vTaskSuspend == 1 ) )
3376 BaseType_t xTaskResumeFromISR( TaskHandle_t xTaskToResume )
3378 BaseType_t xYieldRequired = pdFALSE;
3379 TCB_t * const pxTCB = xTaskToResume;
3380 UBaseType_t uxSavedInterruptStatus;
3382 traceENTER_xTaskResumeFromISR( xTaskToResume );
3384 configASSERT( xTaskToResume );
3386 /* RTOS ports that support interrupt nesting have the concept of a
3387 * maximum system call (or maximum API call) interrupt priority.
3388 * Interrupts that are above the maximum system call priority are keep
3389 * permanently enabled, even when the RTOS kernel is in a critical section,
3390 * but cannot make any calls to FreeRTOS API functions. If configASSERT()
3391 * is defined in FreeRTOSConfig.h then
3392 * portASSERT_IF_INTERRUPT_PRIORITY_INVALID() will result in an assertion
3393 * failure if a FreeRTOS API function is called from an interrupt that has
3394 * been assigned a priority above the configured maximum system call
3395 * priority. Only FreeRTOS functions that end in FromISR can be called
3396 * from interrupts that have been assigned a priority at or (logically)
3397 * below the maximum system call interrupt priority. FreeRTOS maintains a
3398 * separate interrupt safe API to ensure interrupt entry is as fast and as
3399 * simple as possible. More information (albeit Cortex-M specific) is
3400 * provided on the following link:
3401 * https://www.FreeRTOS.org/RTOS-Cortex-M3-M4.html */
3402 portASSERT_IF_INTERRUPT_PRIORITY_INVALID();
3404 uxSavedInterruptStatus = taskENTER_CRITICAL_FROM_ISR();
3406 if( prvTaskIsTaskSuspended( pxTCB ) != pdFALSE )
3408 traceTASK_RESUME_FROM_ISR( pxTCB );
3410 /* Check the ready lists can be accessed. */
3411 if( uxSchedulerSuspended == ( UBaseType_t ) 0U )
3413 #if ( configNUMBER_OF_CORES == 1 )
3415 /* Ready lists can be accessed so move the task from the
3416 * suspended list to the ready list directly. */
3417 if( pxTCB->uxPriority > pxCurrentTCB->uxPriority )
3419 xYieldRequired = pdTRUE;
3421 /* Mark that a yield is pending in case the user is not
3422 * using the return value to initiate a context switch
3423 * from the ISR using portYIELD_FROM_ISR. */
3424 xYieldPendings[ 0 ] = pdTRUE;
3428 mtCOVERAGE_TEST_MARKER();
3431 #endif /* #if ( configNUMBER_OF_CORES == 1 ) */
3433 ( void ) uxListRemove( &( pxTCB->xStateListItem ) );
3434 prvAddTaskToReadyList( pxTCB );
3438 /* The delayed or ready lists cannot be accessed so the task
3439 * is held in the pending ready list until the scheduler is
3441 vListInsertEnd( &( xPendingReadyList ), &( pxTCB->xEventListItem ) );
3444 #if ( ( configNUMBER_OF_CORES > 1 ) && ( configUSE_PREEMPTION == 1 ) )
3446 prvYieldForTask( pxTCB );
3448 if( xYieldPendings[ portGET_CORE_ID() ] != pdFALSE )
3450 xYieldRequired = pdTRUE;
3453 #endif /* #if ( ( configNUMBER_OF_CORES > 1 ) && ( configUSE_PREEMPTION == 1 ) ) */
3457 mtCOVERAGE_TEST_MARKER();
3460 taskEXIT_CRITICAL_FROM_ISR( uxSavedInterruptStatus );
3462 traceRETURN_xTaskResumeFromISR( xYieldRequired );
3464 return xYieldRequired;
3467 #endif /* ( ( INCLUDE_xTaskResumeFromISR == 1 ) && ( INCLUDE_vTaskSuspend == 1 ) ) */
3468 /*-----------------------------------------------------------*/
3470 static BaseType_t prvCreateIdleTasks( void )
3472 BaseType_t xReturn = pdPASS;
3474 char cIdleName[ configMAX_TASK_NAME_LEN ];
3475 TaskFunction_t pxIdleTaskFunction = NULL;
3476 BaseType_t xIdleTaskNameIndex;
3478 for( xIdleTaskNameIndex = ( BaseType_t ) 0; xIdleTaskNameIndex < ( BaseType_t ) configMAX_TASK_NAME_LEN; xIdleTaskNameIndex++ )
3480 cIdleName[ xIdleTaskNameIndex ] = configIDLE_TASK_NAME[ xIdleTaskNameIndex ];
3482 /* Don't copy all configMAX_TASK_NAME_LEN if the string is shorter than
3483 * configMAX_TASK_NAME_LEN characters just in case the memory after the
3484 * string is not accessible (extremely unlikely). */
3485 if( cIdleName[ xIdleTaskNameIndex ] == ( char ) 0x00 )
3491 mtCOVERAGE_TEST_MARKER();
3495 /* Add each idle task at the lowest priority. */
3496 for( xCoreID = ( BaseType_t ) 0; xCoreID < ( BaseType_t ) configNUMBER_OF_CORES; xCoreID++ )
3498 #if ( configNUMBER_OF_CORES == 1 )
3500 pxIdleTaskFunction = prvIdleTask;
3502 #else /* #if ( configNUMBER_OF_CORES == 1 ) */
3504 /* In the FreeRTOS SMP, configNUMBER_OF_CORES - 1 passive idle tasks
3505 * are also created to ensure that each core has an idle task to
3506 * run when no other task is available to run. */
3509 pxIdleTaskFunction = prvIdleTask;
3513 pxIdleTaskFunction = prvPassiveIdleTask;
3516 #endif /* #if ( configNUMBER_OF_CORES == 1 ) */
3518 /* Update the idle task name with suffix to differentiate the idle tasks.
3519 * This function is not required in single core FreeRTOS since there is
3520 * only one idle task. */
3521 #if ( configNUMBER_OF_CORES > 1 )
3523 /* Append the idle task number to the end of the name if there is space. */
3524 if( xIdleTaskNameIndex < ( BaseType_t ) configMAX_TASK_NAME_LEN )
3526 cIdleName[ xIdleTaskNameIndex ] = ( char ) ( xCoreID + '0' );
3528 /* And append a null character if there is space. */
3529 if( ( xIdleTaskNameIndex + 1 ) < ( BaseType_t ) configMAX_TASK_NAME_LEN )
3531 cIdleName[ xIdleTaskNameIndex + 1 ] = '\0';
3535 mtCOVERAGE_TEST_MARKER();
3540 mtCOVERAGE_TEST_MARKER();
3543 #endif /* if ( configNUMBER_OF_CORES > 1 ) */
3545 #if ( configSUPPORT_STATIC_ALLOCATION == 1 )
3547 StaticTask_t * pxIdleTaskTCBBuffer = NULL;
3548 StackType_t * pxIdleTaskStackBuffer = NULL;
3549 uint32_t ulIdleTaskStackSize;
3551 /* The Idle task is created using user provided RAM - obtain the
3552 * address of the RAM then create the idle task. */
3553 #if ( configNUMBER_OF_CORES == 1 )
3554 vApplicationGetIdleTaskMemory( &pxIdleTaskTCBBuffer, &pxIdleTaskStackBuffer, &ulIdleTaskStackSize );
3556 vApplicationGetIdleTaskMemory( &pxIdleTaskTCBBuffer, &pxIdleTaskStackBuffer, &ulIdleTaskStackSize, xCoreID );
3558 xIdleTaskHandles[ xCoreID ] = xTaskCreateStatic( pxIdleTaskFunction,
3560 ulIdleTaskStackSize,
3561 ( void * ) NULL, /*lint !e961. The cast is not redundant for all compilers. */
3562 portPRIVILEGE_BIT, /* In effect ( tskIDLE_PRIORITY | portPRIVILEGE_BIT ), but tskIDLE_PRIORITY is zero. */
3563 pxIdleTaskStackBuffer,
3564 pxIdleTaskTCBBuffer ); /*lint !e961 MISRA exception, justified as it is not a redundant explicit cast to all supported compilers. */
3566 if( xIdleTaskHandles[ xCoreID ] != NULL )
3575 #else /* if ( configSUPPORT_STATIC_ALLOCATION == 1 ) */
3577 /* The Idle task is being created using dynamically allocated RAM. */
3578 xReturn = xTaskCreate( pxIdleTaskFunction,
3580 configMINIMAL_STACK_SIZE,
3582 portPRIVILEGE_BIT, /* In effect ( tskIDLE_PRIORITY | portPRIVILEGE_BIT ), but tskIDLE_PRIORITY is zero. */
3583 &xIdleTaskHandles[ xCoreID ] ); /*lint !e961 MISRA exception, justified as it is not a redundant explicit cast to all supported compilers. */
3585 #endif /* configSUPPORT_STATIC_ALLOCATION */
3587 /* Break the loop if any of the idle task is failed to be created. */
3588 if( xReturn == pdFAIL )
3594 mtCOVERAGE_TEST_MARKER();
3601 /*-----------------------------------------------------------*/
3603 void vTaskStartScheduler( void )
3607 traceENTER_vTaskStartScheduler();
3609 #if ( configUSE_CORE_AFFINITY == 1 ) && ( configNUMBER_OF_CORES > 1 )
3611 /* Sanity check that the UBaseType_t must have greater than or equal to
3612 * the number of bits as confNUMBER_OF_CORES. */
3613 configASSERT( ( sizeof( UBaseType_t ) * taskBITS_PER_BYTE ) >= configNUMBER_OF_CORES );
3615 #endif /* #if ( configUSE_CORE_AFFINITY == 1 ) && ( configNUMBER_OF_CORES > 1 ) */
3617 xReturn = prvCreateIdleTasks();
3619 #if ( configUSE_TIMERS == 1 )
3621 if( xReturn == pdPASS )
3623 xReturn = xTimerCreateTimerTask();
3627 mtCOVERAGE_TEST_MARKER();
3630 #endif /* configUSE_TIMERS */
3632 if( xReturn == pdPASS )
3634 /* freertos_tasks_c_additions_init() should only be called if the user
3635 * definable macro FREERTOS_TASKS_C_ADDITIONS_INIT() is defined, as that is
3636 * the only macro called by the function. */
3637 #ifdef FREERTOS_TASKS_C_ADDITIONS_INIT
3639 freertos_tasks_c_additions_init();
3643 /* Interrupts are turned off here, to ensure a tick does not occur
3644 * before or during the call to xPortStartScheduler(). The stacks of
3645 * the created tasks contain a status word with interrupts switched on
3646 * so interrupts will automatically get re-enabled when the first task
3648 portDISABLE_INTERRUPTS();
3650 #if ( configUSE_C_RUNTIME_TLS_SUPPORT == 1 )
3652 /* Switch C-Runtime's TLS Block to point to the TLS
3653 * block specific to the task that will run first. */
3654 configSET_TLS_BLOCK( pxCurrentTCB->xTLSBlock );
3658 xNextTaskUnblockTime = portMAX_DELAY;
3659 xSchedulerRunning = pdTRUE;
3660 xTickCount = ( TickType_t ) configINITIAL_TICK_COUNT;
3662 /* If configGENERATE_RUN_TIME_STATS is defined then the following
3663 * macro must be defined to configure the timer/counter used to generate
3664 * the run time counter time base. NOTE: If configGENERATE_RUN_TIME_STATS
3665 * is set to 0 and the following line fails to build then ensure you do not
3666 * have portCONFIGURE_TIMER_FOR_RUN_TIME_STATS() defined in your
3667 * FreeRTOSConfig.h file. */
3668 portCONFIGURE_TIMER_FOR_RUN_TIME_STATS();
3670 traceTASK_SWITCHED_IN();
3672 /* Setting up the timer tick is hardware specific and thus in the
3673 * portable interface. */
3674 xPortStartScheduler();
3676 /* In most cases, xPortStartScheduler() will not return. If it
3677 * returns pdTRUE then there was not enough heap memory available
3678 * to create either the Idle or the Timer task. If it returned
3679 * pdFALSE, then the application called xTaskEndScheduler().
3680 * Most ports don't implement xTaskEndScheduler() as there is
3681 * nothing to return to. */
3685 /* This line will only be reached if the kernel could not be started,
3686 * because there was not enough FreeRTOS heap to create the idle task
3687 * or the timer task. */
3688 configASSERT( xReturn != errCOULD_NOT_ALLOCATE_REQUIRED_MEMORY );
3691 /* Prevent compiler warnings if INCLUDE_xTaskGetIdleTaskHandle is set to 0,
3692 * meaning xIdleTaskHandles are not used anywhere else. */
3693 ( void ) xIdleTaskHandles;
3695 /* OpenOCD makes use of uxTopUsedPriority for thread debugging. Prevent uxTopUsedPriority
3696 * from getting optimized out as it is no longer used by the kernel. */
3697 ( void ) uxTopUsedPriority;
3699 traceRETURN_vTaskStartScheduler();
3701 /*-----------------------------------------------------------*/
3703 void vTaskEndScheduler( void )
3705 traceENTER_vTaskEndScheduler();
3707 /* Stop the scheduler interrupts and call the portable scheduler end
3708 * routine so the original ISRs can be restored if necessary. The port
3709 * layer must ensure interrupts enable bit is left in the correct state. */
3710 portDISABLE_INTERRUPTS();
3711 xSchedulerRunning = pdFALSE;
3712 vPortEndScheduler();
3714 traceRETURN_vTaskEndScheduler();
3716 /*----------------------------------------------------------*/
3718 void vTaskSuspendAll( void )
3720 traceENTER_vTaskSuspendAll();
3722 #if ( configNUMBER_OF_CORES == 1 )
3724 /* A critical section is not required as the variable is of type
3725 * BaseType_t. Please read Richard Barry's reply in the following link to a
3726 * post in the FreeRTOS support forum before reporting this as a bug! -
3727 * https://goo.gl/wu4acr */
3729 /* portSOFTWARE_BARRIER() is only implemented for emulated/simulated ports that
3730 * do not otherwise exhibit real time behaviour. */
3731 portSOFTWARE_BARRIER();
3733 /* The scheduler is suspended if uxSchedulerSuspended is non-zero. An increment
3734 * is used to allow calls to vTaskSuspendAll() to nest. */
3735 ++uxSchedulerSuspended;
3737 /* Enforces ordering for ports and optimised compilers that may otherwise place
3738 * the above increment elsewhere. */
3739 portMEMORY_BARRIER();
3741 #else /* #if ( configNUMBER_OF_CORES == 1 ) */
3743 UBaseType_t ulState;
3745 /* This must only be called from within a task. */
3746 portASSERT_IF_IN_ISR();
3748 if( xSchedulerRunning != pdFALSE )
3750 /* Writes to uxSchedulerSuspended must be protected by both the task AND ISR locks.
3751 * We must disable interrupts before we grab the locks in the event that this task is
3752 * interrupted and switches context before incrementing uxSchedulerSuspended.
3753 * It is safe to re-enable interrupts after releasing the ISR lock and incrementing
3754 * uxSchedulerSuspended since that will prevent context switches. */
3755 ulState = portSET_INTERRUPT_MASK();
3757 /* portSOFRWARE_BARRIER() is only implemented for emulated/simulated ports that
3758 * do not otherwise exhibit real time behaviour. */
3759 portSOFTWARE_BARRIER();
3761 portGET_TASK_LOCK();
3763 /* uxSchedulerSuspended is increased after prvCheckForRunStateChange. The
3764 * purpose is to prevent altering the variable when fromISR APIs are readying
3766 if( uxSchedulerSuspended == 0U )
3768 if( portGET_CRITICAL_NESTING_COUNT() == 0U )
3770 prvCheckForRunStateChange();
3774 mtCOVERAGE_TEST_MARKER();
3779 mtCOVERAGE_TEST_MARKER();
3784 /* The scheduler is suspended if uxSchedulerSuspended is non-zero. An increment
3785 * is used to allow calls to vTaskSuspendAll() to nest. */
3786 ++uxSchedulerSuspended;
3787 portRELEASE_ISR_LOCK();
3789 portCLEAR_INTERRUPT_MASK( ulState );
3793 mtCOVERAGE_TEST_MARKER();
3796 #endif /* #if ( configNUMBER_OF_CORES == 1 ) */
3798 traceRETURN_vTaskSuspendAll();
3801 /*----------------------------------------------------------*/
3803 #if ( configUSE_TICKLESS_IDLE != 0 )
3805 static TickType_t prvGetExpectedIdleTime( void )
3808 UBaseType_t uxHigherPriorityReadyTasks = pdFALSE;
3810 /* uxHigherPriorityReadyTasks takes care of the case where
3811 * configUSE_PREEMPTION is 0, so there may be tasks above the idle priority
3812 * task that are in the Ready state, even though the idle task is
3814 #if ( configUSE_PORT_OPTIMISED_TASK_SELECTION == 0 )
3816 if( uxTopReadyPriority > tskIDLE_PRIORITY )
3818 uxHigherPriorityReadyTasks = pdTRUE;
3823 const UBaseType_t uxLeastSignificantBit = ( UBaseType_t ) 0x01;
3825 /* When port optimised task selection is used the uxTopReadyPriority
3826 * variable is used as a bit map. If bits other than the least
3827 * significant bit are set then there are tasks that have a priority
3828 * above the idle priority that are in the Ready state. This takes
3829 * care of the case where the co-operative scheduler is in use. */
3830 if( uxTopReadyPriority > uxLeastSignificantBit )
3832 uxHigherPriorityReadyTasks = pdTRUE;
3835 #endif /* if ( configUSE_PORT_OPTIMISED_TASK_SELECTION == 0 ) */
3837 if( pxCurrentTCB->uxPriority > tskIDLE_PRIORITY )
3841 else if( listCURRENT_LIST_LENGTH( &( pxReadyTasksLists[ tskIDLE_PRIORITY ] ) ) > 1 )
3843 /* There are other idle priority tasks in the ready state. If
3844 * time slicing is used then the very next tick interrupt must be
3848 else if( uxHigherPriorityReadyTasks != pdFALSE )
3850 /* There are tasks in the Ready state that have a priority above the
3851 * idle priority. This path can only be reached if
3852 * configUSE_PREEMPTION is 0. */
3857 xReturn = xNextTaskUnblockTime - xTickCount;
3863 #endif /* configUSE_TICKLESS_IDLE */
3864 /*----------------------------------------------------------*/
3866 BaseType_t xTaskResumeAll( void )
3868 TCB_t * pxTCB = NULL;
3869 BaseType_t xAlreadyYielded = pdFALSE;
3871 traceENTER_xTaskResumeAll();
3873 #if ( configNUMBER_OF_CORES > 1 )
3874 if( xSchedulerRunning != pdFALSE )
3877 /* It is possible that an ISR caused a task to be removed from an event
3878 * list while the scheduler was suspended. If this was the case then the
3879 * removed task will have been added to the xPendingReadyList. Once the
3880 * scheduler has been resumed it is safe to move all the pending ready
3881 * tasks from this list into their appropriate ready list. */
3882 taskENTER_CRITICAL();
3885 xCoreID = ( BaseType_t ) portGET_CORE_ID();
3887 /* If uxSchedulerSuspended is zero then this function does not match a
3888 * previous call to vTaskSuspendAll(). */
3889 configASSERT( uxSchedulerSuspended != 0U );
3891 --uxSchedulerSuspended;
3892 portRELEASE_TASK_LOCK();
3894 if( uxSchedulerSuspended == ( UBaseType_t ) 0U )
3896 if( uxCurrentNumberOfTasks > ( UBaseType_t ) 0U )
3898 /* Move any readied tasks from the pending list into the
3899 * appropriate ready list. */
3900 while( listLIST_IS_EMPTY( &xPendingReadyList ) == pdFALSE )
3902 pxTCB = listGET_OWNER_OF_HEAD_ENTRY( ( &xPendingReadyList ) ); /*lint !e9079 void * is used as this macro is used with timers too. Alignment is known to be fine as the type of the pointer stored and retrieved is the same. */
3903 listREMOVE_ITEM( &( pxTCB->xEventListItem ) );
3904 portMEMORY_BARRIER();
3905 listREMOVE_ITEM( &( pxTCB->xStateListItem ) );
3906 prvAddTaskToReadyList( pxTCB );
3908 #if ( configNUMBER_OF_CORES == 1 )
3910 /* If the moved task has a priority higher than the current
3911 * task then a yield must be performed. */
3912 if( pxTCB->uxPriority > pxCurrentTCB->uxPriority )
3914 xYieldPendings[ xCoreID ] = pdTRUE;
3918 mtCOVERAGE_TEST_MARKER();
3921 #else /* #if ( configNUMBER_OF_CORES == 1 ) */
3923 /* All appropriate tasks yield at the moment a task is added to xPendingReadyList.
3924 * If the current core yielded then vTaskSwitchContext() has already been called
3925 * which sets xYieldPendings for the current core to pdTRUE. */
3927 #endif /* #if ( configNUMBER_OF_CORES == 1 ) */
3932 /* A task was unblocked while the scheduler was suspended,
3933 * which may have prevented the next unblock time from being
3934 * re-calculated, in which case re-calculate it now. Mainly
3935 * important for low power tickless implementations, where
3936 * this can prevent an unnecessary exit from low power
3938 prvResetNextTaskUnblockTime();
3941 /* If any ticks occurred while the scheduler was suspended then
3942 * they should be processed now. This ensures the tick count does
3943 * not slip, and that any delayed tasks are resumed at the correct
3946 * It should be safe to call xTaskIncrementTick here from any core
3947 * since we are in a critical section and xTaskIncrementTick itself
3948 * protects itself within a critical section. Suspending the scheduler
3949 * from any core causes xTaskIncrementTick to increment uxPendedCounts. */
3951 TickType_t xPendedCounts = xPendedTicks; /* Non-volatile copy. */
3953 if( xPendedCounts > ( TickType_t ) 0U )
3957 if( xTaskIncrementTick() != pdFALSE )
3959 /* Other cores are interrupted from
3960 * within xTaskIncrementTick(). */
3961 xYieldPendings[ xCoreID ] = pdTRUE;
3965 mtCOVERAGE_TEST_MARKER();
3969 } while( xPendedCounts > ( TickType_t ) 0U );
3975 mtCOVERAGE_TEST_MARKER();
3979 if( xYieldPendings[ xCoreID ] != pdFALSE )
3981 #if ( configUSE_PREEMPTION != 0 )
3983 xAlreadyYielded = pdTRUE;
3985 #endif /* #if ( configUSE_PREEMPTION != 0 ) */
3987 #if ( configNUMBER_OF_CORES == 1 )
3989 taskYIELD_TASK_CORE_IF_USING_PREEMPTION( pxCurrentTCB );
3991 #endif /* #if ( configNUMBER_OF_CORES == 1 ) */
3995 mtCOVERAGE_TEST_MARKER();
4001 mtCOVERAGE_TEST_MARKER();
4004 taskEXIT_CRITICAL();
4007 traceRETURN_xTaskResumeAll( xAlreadyYielded );
4009 return xAlreadyYielded;
4011 /*-----------------------------------------------------------*/
4013 TickType_t xTaskGetTickCount( void )
4017 traceENTER_xTaskGetTickCount();
4019 /* Critical section required if running on a 16 bit processor. */
4020 portTICK_TYPE_ENTER_CRITICAL();
4022 xTicks = xTickCount;
4024 portTICK_TYPE_EXIT_CRITICAL();
4026 traceRETURN_xTaskGetTickCount( xTicks );
4030 /*-----------------------------------------------------------*/
4032 TickType_t xTaskGetTickCountFromISR( void )
4035 UBaseType_t uxSavedInterruptStatus;
4037 traceENTER_xTaskGetTickCountFromISR();
4039 /* RTOS ports that support interrupt nesting have the concept of a maximum
4040 * system call (or maximum API call) interrupt priority. Interrupts that are
4041 * above the maximum system call priority are kept permanently enabled, even
4042 * when the RTOS kernel is in a critical section, but cannot make any calls to
4043 * FreeRTOS API functions. If configASSERT() is defined in FreeRTOSConfig.h
4044 * then portASSERT_IF_INTERRUPT_PRIORITY_INVALID() will result in an assertion
4045 * failure if a FreeRTOS API function is called from an interrupt that has been
4046 * assigned a priority above the configured maximum system call priority.
4047 * Only FreeRTOS functions that end in FromISR can be called from interrupts
4048 * that have been assigned a priority at or (logically) below the maximum
4049 * system call interrupt priority. FreeRTOS maintains a separate interrupt
4050 * safe API to ensure interrupt entry is as fast and as simple as possible.
4051 * More information (albeit Cortex-M specific) is provided on the following
4052 * link: https://www.FreeRTOS.org/RTOS-Cortex-M3-M4.html */
4053 portASSERT_IF_INTERRUPT_PRIORITY_INVALID();
4055 uxSavedInterruptStatus = portTICK_TYPE_SET_INTERRUPT_MASK_FROM_ISR();
4057 xReturn = xTickCount;
4059 portTICK_TYPE_CLEAR_INTERRUPT_MASK_FROM_ISR( uxSavedInterruptStatus );
4061 traceRETURN_xTaskGetTickCountFromISR( xReturn );
4065 /*-----------------------------------------------------------*/
4067 UBaseType_t uxTaskGetNumberOfTasks( void )
4069 traceENTER_uxTaskGetNumberOfTasks();
4071 /* A critical section is not required because the variables are of type
4073 traceRETURN_uxTaskGetNumberOfTasks( uxCurrentNumberOfTasks );
4075 return uxCurrentNumberOfTasks;
4077 /*-----------------------------------------------------------*/
4079 char * pcTaskGetName( TaskHandle_t xTaskToQuery ) /*lint !e971 Unqualified char types are allowed for strings and single characters only. */
4083 traceENTER_pcTaskGetName( xTaskToQuery );
4085 /* If null is passed in here then the name of the calling task is being
4087 pxTCB = prvGetTCBFromHandle( xTaskToQuery );
4088 configASSERT( pxTCB );
4090 traceRETURN_pcTaskGetName( &( pxTCB->pcTaskName[ 0 ] ) );
4092 return &( pxTCB->pcTaskName[ 0 ] );
4094 /*-----------------------------------------------------------*/
4096 #if ( INCLUDE_xTaskGetHandle == 1 )
4098 #if ( configNUMBER_OF_CORES == 1 )
4099 static TCB_t * prvSearchForNameWithinSingleList( List_t * pxList,
4100 const char pcNameToQuery[] )
4104 TCB_t * pxReturn = NULL;
4107 BaseType_t xBreakLoop;
4109 /* This function is called with the scheduler suspended. */
4111 if( listCURRENT_LIST_LENGTH( pxList ) > ( UBaseType_t ) 0 )
4113 listGET_OWNER_OF_NEXT_ENTRY( pxFirstTCB, pxList ); /*lint !e9079 void * is used as this macro is used with timers too. Alignment is known to be fine as the type of the pointer stored and retrieved is the same. */
4117 listGET_OWNER_OF_NEXT_ENTRY( pxNextTCB, pxList ); /*lint !e9079 void * is used as this macro is used with timers too. Alignment is known to be fine as the type of the pointer stored and retrieved is the same. */
4119 /* Check each character in the name looking for a match or
4121 xBreakLoop = pdFALSE;
4123 for( x = ( UBaseType_t ) 0; x < ( UBaseType_t ) configMAX_TASK_NAME_LEN; x++ )
4125 cNextChar = pxNextTCB->pcTaskName[ x ];
4127 if( cNextChar != pcNameToQuery[ x ] )
4129 /* Characters didn't match. */
4130 xBreakLoop = pdTRUE;
4132 else if( cNextChar == ( char ) 0x00 )
4134 /* Both strings terminated, a match must have been
4136 pxReturn = pxNextTCB;
4137 xBreakLoop = pdTRUE;
4141 mtCOVERAGE_TEST_MARKER();
4144 if( xBreakLoop != pdFALSE )
4150 if( pxReturn != NULL )
4152 /* The handle has been found. */
4155 } while( pxNextTCB != pxFirstTCB );
4159 mtCOVERAGE_TEST_MARKER();
4164 #else /* if ( configNUMBER_OF_CORES == 1 ) */
4165 static TCB_t * prvSearchForNameWithinSingleList( List_t * pxList,
4166 const char pcNameToQuery[] )
4168 TCB_t * pxReturn = NULL;
4171 BaseType_t xBreakLoop;
4172 const ListItem_t * pxEndMarker = listGET_END_MARKER( pxList );
4173 ListItem_t * pxIterator;
4175 /* This function is called with the scheduler suspended. */
4177 if( listCURRENT_LIST_LENGTH( pxList ) > ( UBaseType_t ) 0 )
4179 for( pxIterator = listGET_HEAD_ENTRY( pxList ); pxIterator != pxEndMarker; pxIterator = listGET_NEXT( pxIterator ) )
4181 TCB_t * pxTCB = listGET_LIST_ITEM_OWNER( pxIterator );
4183 /* Check each character in the name looking for a match or
4185 xBreakLoop = pdFALSE;
4187 for( x = ( UBaseType_t ) 0; x < ( UBaseType_t ) configMAX_TASK_NAME_LEN; x++ )
4189 cNextChar = pxTCB->pcTaskName[ x ];
4191 if( cNextChar != pcNameToQuery[ x ] )
4193 /* Characters didn't match. */
4194 xBreakLoop = pdTRUE;
4196 else if( cNextChar == ( char ) 0x00 )
4198 /* Both strings terminated, a match must have been
4201 xBreakLoop = pdTRUE;
4205 mtCOVERAGE_TEST_MARKER();
4208 if( xBreakLoop != pdFALSE )
4214 if( pxReturn != NULL )
4216 /* The handle has been found. */
4223 mtCOVERAGE_TEST_MARKER();
4228 #endif /* #if ( configNUMBER_OF_CORES == 1 ) */
4230 #endif /* INCLUDE_xTaskGetHandle */
4231 /*-----------------------------------------------------------*/
4233 #if ( INCLUDE_xTaskGetHandle == 1 )
4235 TaskHandle_t xTaskGetHandle( const char * pcNameToQuery ) /*lint !e971 Unqualified char types are allowed for strings and single characters only. */
4237 UBaseType_t uxQueue = configMAX_PRIORITIES;
4240 traceENTER_xTaskGetHandle( pcNameToQuery );
4242 /* Task names will be truncated to configMAX_TASK_NAME_LEN - 1 bytes. */
4243 configASSERT( strlen( pcNameToQuery ) < configMAX_TASK_NAME_LEN );
4247 /* Search the ready lists. */
4251 pxTCB = prvSearchForNameWithinSingleList( ( List_t * ) &( pxReadyTasksLists[ uxQueue ] ), pcNameToQuery );
4255 /* Found the handle. */
4258 } while( uxQueue > ( UBaseType_t ) tskIDLE_PRIORITY ); /*lint !e961 MISRA exception as the casts are only redundant for some ports. */
4260 /* Search the delayed lists. */
4263 pxTCB = prvSearchForNameWithinSingleList( ( List_t * ) pxDelayedTaskList, pcNameToQuery );
4268 pxTCB = prvSearchForNameWithinSingleList( ( List_t * ) pxOverflowDelayedTaskList, pcNameToQuery );
4271 #if ( INCLUDE_vTaskSuspend == 1 )
4275 /* Search the suspended list. */
4276 pxTCB = prvSearchForNameWithinSingleList( &xSuspendedTaskList, pcNameToQuery );
4281 #if ( INCLUDE_vTaskDelete == 1 )
4285 /* Search the deleted list. */
4286 pxTCB = prvSearchForNameWithinSingleList( &xTasksWaitingTermination, pcNameToQuery );
4291 ( void ) xTaskResumeAll();
4293 traceRETURN_xTaskGetHandle( pxTCB );
4298 #endif /* INCLUDE_xTaskGetHandle */
4299 /*-----------------------------------------------------------*/
4301 #if ( configSUPPORT_STATIC_ALLOCATION == 1 )
4303 BaseType_t xTaskGetStaticBuffers( TaskHandle_t xTask,
4304 StackType_t ** ppuxStackBuffer,
4305 StaticTask_t ** ppxTaskBuffer )
4310 traceENTER_xTaskGetStaticBuffers( xTask, ppuxStackBuffer, ppxTaskBuffer );
4312 configASSERT( ppuxStackBuffer != NULL );
4313 configASSERT( ppxTaskBuffer != NULL );
4315 pxTCB = prvGetTCBFromHandle( xTask );
4317 #if ( tskSTATIC_AND_DYNAMIC_ALLOCATION_POSSIBLE == 1 )
4319 if( pxTCB->ucStaticallyAllocated == tskSTATICALLY_ALLOCATED_STACK_AND_TCB )
4321 *ppuxStackBuffer = pxTCB->pxStack;
4322 *ppxTaskBuffer = ( StaticTask_t * ) pxTCB;
4325 else if( pxTCB->ucStaticallyAllocated == tskSTATICALLY_ALLOCATED_STACK_ONLY )
4327 *ppuxStackBuffer = pxTCB->pxStack;
4328 *ppxTaskBuffer = NULL;
4336 #else /* tskSTATIC_AND_DYNAMIC_ALLOCATION_POSSIBLE == 1 */
4338 *ppuxStackBuffer = pxTCB->pxStack;
4339 *ppxTaskBuffer = ( StaticTask_t * ) pxTCB;
4342 #endif /* tskSTATIC_AND_DYNAMIC_ALLOCATION_POSSIBLE == 1 */
4344 traceRETURN_xTaskGetStaticBuffers( xReturn );
4349 #endif /* configSUPPORT_STATIC_ALLOCATION */
4350 /*-----------------------------------------------------------*/
4352 #if ( configUSE_TRACE_FACILITY == 1 )
4354 UBaseType_t uxTaskGetSystemState( TaskStatus_t * const pxTaskStatusArray,
4355 const UBaseType_t uxArraySize,
4356 configRUN_TIME_COUNTER_TYPE * const pulTotalRunTime )
4358 UBaseType_t uxTask = 0, uxQueue = configMAX_PRIORITIES;
4360 traceENTER_uxTaskGetSystemState( pxTaskStatusArray, uxArraySize, pulTotalRunTime );
4364 /* Is there a space in the array for each task in the system? */
4365 if( uxArraySize >= uxCurrentNumberOfTasks )
4367 /* Fill in an TaskStatus_t structure with information on each
4368 * task in the Ready state. */
4372 uxTask = ( UBaseType_t ) ( uxTask + prvListTasksWithinSingleList( &( pxTaskStatusArray[ uxTask ] ), &( pxReadyTasksLists[ uxQueue ] ), eReady ) );
4373 } while( uxQueue > ( UBaseType_t ) tskIDLE_PRIORITY ); /*lint !e961 MISRA exception as the casts are only redundant for some ports. */
4375 /* Fill in an TaskStatus_t structure with information on each
4376 * task in the Blocked state. */
4377 uxTask = ( UBaseType_t ) ( uxTask + prvListTasksWithinSingleList( &( pxTaskStatusArray[ uxTask ] ), ( List_t * ) pxDelayedTaskList, eBlocked ) );
4378 uxTask = ( UBaseType_t ) ( uxTask + prvListTasksWithinSingleList( &( pxTaskStatusArray[ uxTask ] ), ( List_t * ) pxOverflowDelayedTaskList, eBlocked ) );
4380 #if ( INCLUDE_vTaskDelete == 1 )
4382 /* Fill in an TaskStatus_t structure with information on
4383 * each task that has been deleted but not yet cleaned up. */
4384 uxTask = ( UBaseType_t ) ( uxTask + prvListTasksWithinSingleList( &( pxTaskStatusArray[ uxTask ] ), &xTasksWaitingTermination, eDeleted ) );
4388 #if ( INCLUDE_vTaskSuspend == 1 )
4390 /* Fill in an TaskStatus_t structure with information on
4391 * each task in the Suspended state. */
4392 uxTask = ( UBaseType_t ) ( uxTask + prvListTasksWithinSingleList( &( pxTaskStatusArray[ uxTask ] ), &xSuspendedTaskList, eSuspended ) );
4396 #if ( configGENERATE_RUN_TIME_STATS == 1 )
4398 if( pulTotalRunTime != NULL )
4400 #ifdef portALT_GET_RUN_TIME_COUNTER_VALUE
4401 portALT_GET_RUN_TIME_COUNTER_VALUE( ( *pulTotalRunTime ) );
4403 *pulTotalRunTime = ( configRUN_TIME_COUNTER_TYPE ) portGET_RUN_TIME_COUNTER_VALUE();
4407 #else /* if ( configGENERATE_RUN_TIME_STATS == 1 ) */
4409 if( pulTotalRunTime != NULL )
4411 *pulTotalRunTime = 0;
4414 #endif /* if ( configGENERATE_RUN_TIME_STATS == 1 ) */
4418 mtCOVERAGE_TEST_MARKER();
4421 ( void ) xTaskResumeAll();
4423 traceRETURN_uxTaskGetSystemState( uxTask );
4428 #endif /* configUSE_TRACE_FACILITY */
4429 /*----------------------------------------------------------*/
4431 #if ( INCLUDE_xTaskGetIdleTaskHandle == 1 )
4433 #if ( configNUMBER_OF_CORES == 1 )
4435 TaskHandle_t xTaskGetIdleTaskHandle( void )
4437 traceENTER_xTaskGetIdleTaskHandle();
4439 /* If xTaskGetIdleTaskHandle() is called before the scheduler has been
4440 * started, then xIdleTaskHandles will be NULL. */
4441 configASSERT( ( xIdleTaskHandles[ 0 ] != NULL ) );
4443 traceRETURN_xTaskGetIdleTaskHandle( xIdleTaskHandles[ 0 ] );
4445 return xIdleTaskHandles[ 0 ];
4448 #else /* if ( configNUMBER_OF_CORES == 1 ) */
4450 TaskHandle_t xTaskGetIdleTaskHandle( BaseType_t xCoreID )
4452 traceENTER_xTaskGetIdleTaskHandle( xCoreID );
4454 /* Ensure the core ID is valid. */
4455 configASSERT( taskVALID_CORE_ID( xCoreID ) == pdTRUE );
4457 /* If xTaskGetIdleTaskHandle() is called before the scheduler has been
4458 * started, then xIdleTaskHandles will be NULL. */
4459 configASSERT( ( xIdleTaskHandles[ xCoreID ] != NULL ) );
4461 traceRETURN_xTaskGetIdleTaskHandle( xIdleTaskHandles[ xCoreID ] );
4463 return xIdleTaskHandles[ xCoreID ];
4466 #endif /* if ( configNUMBER_OF_CORES == 1 ) */
4468 #endif /* INCLUDE_xTaskGetIdleTaskHandle */
4469 /*----------------------------------------------------------*/
4471 /* This conditional compilation should use inequality to 0, not equality to 1.
4472 * This is to ensure vTaskStepTick() is available when user defined low power mode
4473 * implementations require configUSE_TICKLESS_IDLE to be set to a value other than
4475 #if ( configUSE_TICKLESS_IDLE != 0 )
4477 void vTaskStepTick( TickType_t xTicksToJump )
4479 traceENTER_vTaskStepTick( xTicksToJump );
4481 /* Correct the tick count value after a period during which the tick
4482 * was suppressed. Note this does *not* call the tick hook function for
4483 * each stepped tick. */
4484 configASSERT( ( xTickCount + xTicksToJump ) <= xNextTaskUnblockTime );
4486 if( ( xTickCount + xTicksToJump ) == xNextTaskUnblockTime )
4488 /* Arrange for xTickCount to reach xNextTaskUnblockTime in
4489 * xTaskIncrementTick() when the scheduler resumes. This ensures
4490 * that any delayed tasks are resumed at the correct time. */
4491 configASSERT( uxSchedulerSuspended != ( UBaseType_t ) 0U );
4492 configASSERT( xTicksToJump != ( TickType_t ) 0 );
4494 /* Prevent the tick interrupt modifying xPendedTicks simultaneously. */
4495 taskENTER_CRITICAL();
4499 taskEXIT_CRITICAL();
4504 mtCOVERAGE_TEST_MARKER();
4507 xTickCount += xTicksToJump;
4509 traceINCREASE_TICK_COUNT( xTicksToJump );
4510 traceRETURN_vTaskStepTick();
4513 #endif /* configUSE_TICKLESS_IDLE */
4514 /*----------------------------------------------------------*/
4516 BaseType_t xTaskCatchUpTicks( TickType_t xTicksToCatchUp )
4518 BaseType_t xYieldOccurred;
4520 traceENTER_xTaskCatchUpTicks( xTicksToCatchUp );
4522 /* Must not be called with the scheduler suspended as the implementation
4523 * relies on xPendedTicks being wound down to 0 in xTaskResumeAll(). */
4524 configASSERT( uxSchedulerSuspended == ( UBaseType_t ) 0U );
4526 /* Use xPendedTicks to mimic xTicksToCatchUp number of ticks occurring when
4527 * the scheduler is suspended so the ticks are executed in xTaskResumeAll(). */
4530 /* Prevent the tick interrupt modifying xPendedTicks simultaneously. */
4531 taskENTER_CRITICAL();
4533 xPendedTicks += xTicksToCatchUp;
4535 taskEXIT_CRITICAL();
4536 xYieldOccurred = xTaskResumeAll();
4538 traceRETURN_xTaskCatchUpTicks( xYieldOccurred );
4540 return xYieldOccurred;
4542 /*----------------------------------------------------------*/
4544 #if ( INCLUDE_xTaskAbortDelay == 1 )
4546 BaseType_t xTaskAbortDelay( TaskHandle_t xTask )
4548 TCB_t * pxTCB = xTask;
4551 traceENTER_xTaskAbortDelay( xTask );
4553 configASSERT( pxTCB );
4557 /* A task can only be prematurely removed from the Blocked state if
4558 * it is actually in the Blocked state. */
4559 if( eTaskGetState( xTask ) == eBlocked )
4563 /* Remove the reference to the task from the blocked list. An
4564 * interrupt won't touch the xStateListItem because the
4565 * scheduler is suspended. */
4566 ( void ) uxListRemove( &( pxTCB->xStateListItem ) );
4568 /* Is the task waiting on an event also? If so remove it from
4569 * the event list too. Interrupts can touch the event list item,
4570 * even though the scheduler is suspended, so a critical section
4572 taskENTER_CRITICAL();
4574 if( listLIST_ITEM_CONTAINER( &( pxTCB->xEventListItem ) ) != NULL )
4576 ( void ) uxListRemove( &( pxTCB->xEventListItem ) );
4578 /* This lets the task know it was forcibly removed from the
4579 * blocked state so it should not re-evaluate its block time and
4580 * then block again. */
4581 pxTCB->ucDelayAborted = pdTRUE;
4585 mtCOVERAGE_TEST_MARKER();
4588 taskEXIT_CRITICAL();
4590 /* Place the unblocked task into the appropriate ready list. */
4591 prvAddTaskToReadyList( pxTCB );
4593 /* A task being unblocked cannot cause an immediate context
4594 * switch if preemption is turned off. */
4595 #if ( configUSE_PREEMPTION == 1 )
4597 #if ( configNUMBER_OF_CORES == 1 )
4599 /* Preemption is on, but a context switch should only be
4600 * performed if the unblocked task has a priority that is
4601 * higher than the currently executing task. */
4602 if( pxTCB->uxPriority > pxCurrentTCB->uxPriority )
4604 /* Pend the yield to be performed when the scheduler
4605 * is unsuspended. */
4606 xYieldPendings[ 0 ] = pdTRUE;
4610 mtCOVERAGE_TEST_MARKER();
4613 #else /* #if ( configNUMBER_OF_CORES == 1 ) */
4615 taskENTER_CRITICAL();
4617 prvYieldForTask( pxTCB );
4619 taskEXIT_CRITICAL();
4621 #endif /* #if ( configNUMBER_OF_CORES == 1 ) */
4623 #endif /* #if ( configUSE_PREEMPTION == 1 ) */
4630 ( void ) xTaskResumeAll();
4632 traceRETURN_xTaskAbortDelay( xReturn );
4637 #endif /* INCLUDE_xTaskAbortDelay */
4638 /*----------------------------------------------------------*/
4640 BaseType_t xTaskIncrementTick( void )
4643 TickType_t xItemValue;
4644 BaseType_t xSwitchRequired = pdFALSE;
4646 #if ( configUSE_PREEMPTION == 1 ) && ( configNUMBER_OF_CORES > 1 )
4647 BaseType_t xYieldRequiredForCore[ configNUMBER_OF_CORES ] = { pdFALSE };
4648 #endif /* #if ( configUSE_PREEMPTION == 1 ) && ( configNUMBER_OF_CORES > 1 ) */
4650 traceENTER_xTaskIncrementTick();
4652 /* Called by the portable layer each time a tick interrupt occurs.
4653 * Increments the tick then checks to see if the new tick value will cause any
4654 * tasks to be unblocked. */
4655 traceTASK_INCREMENT_TICK( xTickCount );
4657 /* Tick increment should occur on every kernel timer event. Core 0 has the
4658 * responsibility to increment the tick, or increment the pended ticks if the
4659 * scheduler is suspended. If pended ticks is greater than zero, the core that
4660 * calls xTaskResumeAll has the responsibility to increment the tick. */
4661 if( uxSchedulerSuspended == ( UBaseType_t ) 0U )
4663 /* Minor optimisation. The tick count cannot change in this
4665 const TickType_t xConstTickCount = xTickCount + ( TickType_t ) 1;
4667 /* Increment the RTOS tick, switching the delayed and overflowed
4668 * delayed lists if it wraps to 0. */
4669 xTickCount = xConstTickCount;
4671 if( xConstTickCount == ( TickType_t ) 0U ) /*lint !e774 'if' does not always evaluate to false as it is looking for an overflow. */
4673 taskSWITCH_DELAYED_LISTS();
4677 mtCOVERAGE_TEST_MARKER();
4680 /* See if this tick has made a timeout expire. Tasks are stored in
4681 * the queue in the order of their wake time - meaning once one task
4682 * has been found whose block time has not expired there is no need to
4683 * look any further down the list. */
4684 if( xConstTickCount >= xNextTaskUnblockTime )
4688 if( listLIST_IS_EMPTY( pxDelayedTaskList ) != pdFALSE )
4690 /* The delayed list is empty. Set xNextTaskUnblockTime
4691 * to the maximum possible value so it is extremely
4693 * if( xTickCount >= xNextTaskUnblockTime ) test will pass
4694 * next time through. */
4695 xNextTaskUnblockTime = portMAX_DELAY; /*lint !e961 MISRA exception as the casts are only redundant for some ports. */
4700 /* The delayed list is not empty, get the value of the
4701 * item at the head of the delayed list. This is the time
4702 * at which the task at the head of the delayed list must
4703 * be removed from the Blocked state. */
4704 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. */
4705 xItemValue = listGET_LIST_ITEM_VALUE( &( pxTCB->xStateListItem ) );
4707 if( xConstTickCount < xItemValue )
4709 /* It is not time to unblock this item yet, but the
4710 * item value is the time at which the task at the head
4711 * of the blocked list must be removed from the Blocked
4712 * state - so record the item value in
4713 * xNextTaskUnblockTime. */
4714 xNextTaskUnblockTime = xItemValue;
4715 break; /*lint !e9011 Code structure here is deemed easier to understand with multiple breaks. */
4719 mtCOVERAGE_TEST_MARKER();
4722 /* It is time to remove the item from the Blocked state. */
4723 listREMOVE_ITEM( &( pxTCB->xStateListItem ) );
4725 /* Is the task waiting on an event also? If so remove
4726 * it from the event list. */
4727 if( listLIST_ITEM_CONTAINER( &( pxTCB->xEventListItem ) ) != NULL )
4729 listREMOVE_ITEM( &( pxTCB->xEventListItem ) );
4733 mtCOVERAGE_TEST_MARKER();
4736 /* Place the unblocked task into the appropriate ready
4738 prvAddTaskToReadyList( pxTCB );
4740 /* A task being unblocked cannot cause an immediate
4741 * context switch if preemption is turned off. */
4742 #if ( configUSE_PREEMPTION == 1 )
4744 #if ( configNUMBER_OF_CORES == 1 )
4746 /* Preemption is on, but a context switch should
4747 * only be performed if the unblocked task's
4748 * priority is higher than the currently executing
4750 * The case of equal priority tasks sharing
4751 * processing time (which happens when both
4752 * preemption and time slicing are on) is
4754 if( pxTCB->uxPriority > pxCurrentTCB->uxPriority )
4756 xSwitchRequired = pdTRUE;
4760 mtCOVERAGE_TEST_MARKER();
4763 #else /* #if( configNUMBER_OF_CORES == 1 ) */
4765 prvYieldForTask( pxTCB );
4767 #endif /* #if( configNUMBER_OF_CORES == 1 ) */
4769 #endif /* #if ( configUSE_PREEMPTION == 1 ) */
4774 /* Tasks of equal priority to the currently running task will share
4775 * processing time (time slice) if preemption is on, and the application
4776 * writer has not explicitly turned time slicing off. */
4777 #if ( ( configUSE_PREEMPTION == 1 ) && ( configUSE_TIME_SLICING == 1 ) )
4779 #if ( configNUMBER_OF_CORES == 1 )
4781 if( listCURRENT_LIST_LENGTH( &( pxReadyTasksLists[ pxCurrentTCB->uxPriority ] ) ) > ( UBaseType_t ) 1 )
4783 xSwitchRequired = pdTRUE;
4787 mtCOVERAGE_TEST_MARKER();
4790 #else /* #if ( configNUMBER_OF_CORES == 1 ) */
4794 for( xCoreID = 0; xCoreID < ( ( BaseType_t ) configNUMBER_OF_CORES ); xCoreID++ )
4796 if( listCURRENT_LIST_LENGTH( &( pxReadyTasksLists[ pxCurrentTCBs[ xCoreID ]->uxPriority ] ) ) > 1 )
4798 xYieldRequiredForCore[ xCoreID ] = pdTRUE;
4802 mtCOVERAGE_TEST_MARKER();
4806 #endif /* #if ( configNUMBER_OF_CORES == 1 ) */
4808 #endif /* #if ( ( configUSE_PREEMPTION == 1 ) && ( configUSE_TIME_SLICING == 1 ) ) */
4810 #if ( configUSE_TICK_HOOK == 1 )
4812 /* Guard against the tick hook being called when the pended tick
4813 * count is being unwound (when the scheduler is being unlocked). */
4814 if( xPendedTicks == ( TickType_t ) 0 )
4816 vApplicationTickHook();
4820 mtCOVERAGE_TEST_MARKER();
4823 #endif /* configUSE_TICK_HOOK */
4825 #if ( configUSE_PREEMPTION == 1 )
4827 #if ( configNUMBER_OF_CORES == 1 )
4829 /* For single core the core ID is always 0. */
4830 if( xYieldPendings[ 0 ] != pdFALSE )
4832 xSwitchRequired = pdTRUE;
4836 mtCOVERAGE_TEST_MARKER();
4839 #else /* #if ( configNUMBER_OF_CORES == 1 ) */
4841 BaseType_t xCoreID, xCurrentCoreID;
4842 xCurrentCoreID = ( BaseType_t ) portGET_CORE_ID();
4844 for( xCoreID = 0; xCoreID < ( BaseType_t ) configNUMBER_OF_CORES; xCoreID++ )
4846 #if ( configUSE_TASK_PREEMPTION_DISABLE == 1 )
4847 if( pxCurrentTCBs[ xCoreID ]->xPreemptionDisable == pdFALSE )
4850 if( ( xYieldRequiredForCore[ xCoreID ] != pdFALSE ) || ( xYieldPendings[ xCoreID ] != pdFALSE ) )
4852 if( xCoreID == xCurrentCoreID )
4854 xSwitchRequired = pdTRUE;
4858 prvYieldCore( xCoreID );
4863 mtCOVERAGE_TEST_MARKER();
4868 #endif /* #if ( configNUMBER_OF_CORES == 1 ) */
4870 #endif /* #if ( configUSE_PREEMPTION == 1 ) */
4876 /* The tick hook gets called at regular intervals, even if the
4877 * scheduler is locked. */
4878 #if ( configUSE_TICK_HOOK == 1 )
4880 vApplicationTickHook();
4885 traceRETURN_xTaskIncrementTick( xSwitchRequired );
4887 return xSwitchRequired;
4889 /*-----------------------------------------------------------*/
4891 #if ( configUSE_APPLICATION_TASK_TAG == 1 )
4893 void vTaskSetApplicationTaskTag( TaskHandle_t xTask,
4894 TaskHookFunction_t pxHookFunction )
4898 traceENTER_vTaskSetApplicationTaskTag( xTask, pxHookFunction );
4900 /* If xTask is NULL then it is the task hook of the calling task that is
4904 xTCB = ( TCB_t * ) pxCurrentTCB;
4911 /* Save the hook function in the TCB. A critical section is required as
4912 * the value can be accessed from an interrupt. */
4913 taskENTER_CRITICAL();
4915 xTCB->pxTaskTag = pxHookFunction;
4917 taskEXIT_CRITICAL();
4919 traceRETURN_vTaskSetApplicationTaskTag();
4922 #endif /* configUSE_APPLICATION_TASK_TAG */
4923 /*-----------------------------------------------------------*/
4925 #if ( configUSE_APPLICATION_TASK_TAG == 1 )
4927 TaskHookFunction_t xTaskGetApplicationTaskTag( TaskHandle_t xTask )
4930 TaskHookFunction_t xReturn;
4932 traceENTER_xTaskGetApplicationTaskTag( xTask );
4934 /* If xTask is NULL then set the calling task's hook. */
4935 pxTCB = prvGetTCBFromHandle( xTask );
4937 /* Save the hook function in the TCB. A critical section is required as
4938 * the value can be accessed from an interrupt. */
4939 taskENTER_CRITICAL();
4941 xReturn = pxTCB->pxTaskTag;
4943 taskEXIT_CRITICAL();
4945 traceRETURN_xTaskGetApplicationTaskTag( xReturn );
4950 #endif /* configUSE_APPLICATION_TASK_TAG */
4951 /*-----------------------------------------------------------*/
4953 #if ( configUSE_APPLICATION_TASK_TAG == 1 )
4955 TaskHookFunction_t xTaskGetApplicationTaskTagFromISR( TaskHandle_t xTask )
4958 TaskHookFunction_t xReturn;
4959 UBaseType_t uxSavedInterruptStatus;
4961 traceENTER_xTaskGetApplicationTaskTagFromISR( xTask );
4963 /* If xTask is NULL then set the calling task's hook. */
4964 pxTCB = prvGetTCBFromHandle( xTask );
4966 /* Save the hook function in the TCB. A critical section is required as
4967 * the value can be accessed from an interrupt. */
4968 uxSavedInterruptStatus = taskENTER_CRITICAL_FROM_ISR();
4970 xReturn = pxTCB->pxTaskTag;
4972 taskEXIT_CRITICAL_FROM_ISR( uxSavedInterruptStatus );
4974 traceRETURN_xTaskGetApplicationTaskTagFromISR( xReturn );
4979 #endif /* configUSE_APPLICATION_TASK_TAG */
4980 /*-----------------------------------------------------------*/
4982 #if ( configUSE_APPLICATION_TASK_TAG == 1 )
4984 BaseType_t xTaskCallApplicationTaskHook( TaskHandle_t xTask,
4985 void * pvParameter )
4990 traceENTER_xTaskCallApplicationTaskHook( xTask, pvParameter );
4992 /* If xTask is NULL then we are calling our own task hook. */
4995 xTCB = pxCurrentTCB;
5002 if( xTCB->pxTaskTag != NULL )
5004 xReturn = xTCB->pxTaskTag( pvParameter );
5011 traceRETURN_xTaskCallApplicationTaskHook( xReturn );
5016 #endif /* configUSE_APPLICATION_TASK_TAG */
5017 /*-----------------------------------------------------------*/
5019 #if ( configNUMBER_OF_CORES == 1 )
5020 void vTaskSwitchContext( void )
5022 traceENTER_vTaskSwitchContext();
5024 if( uxSchedulerSuspended != ( UBaseType_t ) 0U )
5026 /* The scheduler is currently suspended - do not allow a context
5028 xYieldPendings[ 0 ] = pdTRUE;
5032 xYieldPendings[ 0 ] = pdFALSE;
5033 traceTASK_SWITCHED_OUT();
5035 #if ( configGENERATE_RUN_TIME_STATS == 1 )
5037 #ifdef portALT_GET_RUN_TIME_COUNTER_VALUE
5038 portALT_GET_RUN_TIME_COUNTER_VALUE( ulTotalRunTime[ 0 ] );
5040 ulTotalRunTime[ 0 ] = portGET_RUN_TIME_COUNTER_VALUE();
5043 /* Add the amount of time the task has been running to the
5044 * accumulated time so far. The time the task started running was
5045 * stored in ulTaskSwitchedInTime. Note that there is no overflow
5046 * protection here so count values are only valid until the timer
5047 * overflows. The guard against negative values is to protect
5048 * against suspect run time stat counter implementations - which
5049 * are provided by the application, not the kernel. */
5050 if( ulTotalRunTime[ 0 ] > ulTaskSwitchedInTime[ 0 ] )
5052 pxCurrentTCB->ulRunTimeCounter += ( ulTotalRunTime[ 0 ] - ulTaskSwitchedInTime[ 0 ] );
5056 mtCOVERAGE_TEST_MARKER();
5059 ulTaskSwitchedInTime[ 0 ] = ulTotalRunTime[ 0 ];
5061 #endif /* configGENERATE_RUN_TIME_STATS */
5063 /* Check for stack overflow, if configured. */
5064 taskCHECK_FOR_STACK_OVERFLOW();
5066 /* Before the currently running task is switched out, save its errno. */
5067 #if ( configUSE_POSIX_ERRNO == 1 )
5069 pxCurrentTCB->iTaskErrno = FreeRTOS_errno;
5073 /* Select a new task to run using either the generic C or port
5074 * optimised asm code. */
5075 taskSELECT_HIGHEST_PRIORITY_TASK(); /*lint !e9079 void * is used as this macro is used with timers too. Alignment is known to be fine as the type of the pointer stored and retrieved is the same. */
5076 traceTASK_SWITCHED_IN();
5078 /* After the new task is switched in, update the global errno. */
5079 #if ( configUSE_POSIX_ERRNO == 1 )
5081 FreeRTOS_errno = pxCurrentTCB->iTaskErrno;
5085 #if ( configUSE_C_RUNTIME_TLS_SUPPORT == 1 )
5087 /* Switch C-Runtime's TLS Block to point to the TLS
5088 * Block specific to this task. */
5089 configSET_TLS_BLOCK( pxCurrentTCB->xTLSBlock );
5094 traceRETURN_vTaskSwitchContext();
5096 #else /* if ( configNUMBER_OF_CORES == 1 ) */
5097 void vTaskSwitchContext( BaseType_t xCoreID )
5099 traceENTER_vTaskSwitchContext();
5101 /* Acquire both locks:
5102 * - The ISR lock protects the ready list from simultaneous access by
5103 * both other ISRs and tasks.
5104 * - We also take the task lock to pause here in case another core has
5105 * suspended the scheduler. We don't want to simply set xYieldPending
5106 * and move on if another core suspended the scheduler. We should only
5107 * do that if the current core has suspended the scheduler. */
5109 portGET_TASK_LOCK(); /* Must always acquire the task lock first. */
5112 /* vTaskSwitchContext() must never be called from within a critical section.
5113 * This is not necessarily true for single core FreeRTOS, but it is for this
5115 configASSERT( portGET_CRITICAL_NESTING_COUNT() == 0 );
5117 if( uxSchedulerSuspended != ( UBaseType_t ) 0U )
5119 /* The scheduler is currently suspended - do not allow a context
5121 xYieldPendings[ xCoreID ] = pdTRUE;
5125 xYieldPendings[ xCoreID ] = pdFALSE;
5126 traceTASK_SWITCHED_OUT();
5128 #if ( configGENERATE_RUN_TIME_STATS == 1 )
5130 #ifdef portALT_GET_RUN_TIME_COUNTER_VALUE
5131 portALT_GET_RUN_TIME_COUNTER_VALUE( ulTotalRunTime[ xCoreID ] );
5133 ulTotalRunTime[ xCoreID ] = portGET_RUN_TIME_COUNTER_VALUE();
5136 /* Add the amount of time the task has been running to the
5137 * accumulated time so far. The time the task started running was
5138 * stored in ulTaskSwitchedInTime. Note that there is no overflow
5139 * protection here so count values are only valid until the timer
5140 * overflows. The guard against negative values is to protect
5141 * against suspect run time stat counter implementations - which
5142 * are provided by the application, not the kernel. */
5143 if( ulTotalRunTime[ xCoreID ] > ulTaskSwitchedInTime[ xCoreID ] )
5145 pxCurrentTCB->ulRunTimeCounter += ( ulTotalRunTime[ xCoreID ] - ulTaskSwitchedInTime[ xCoreID ] );
5149 mtCOVERAGE_TEST_MARKER();
5152 ulTaskSwitchedInTime[ xCoreID ] = ulTotalRunTime[ xCoreID ];
5154 #endif /* configGENERATE_RUN_TIME_STATS */
5156 /* Check for stack overflow, if configured. */
5157 taskCHECK_FOR_STACK_OVERFLOW();
5159 /* Before the currently running task is switched out, save its errno. */
5160 #if ( configUSE_POSIX_ERRNO == 1 )
5162 pxCurrentTCB->iTaskErrno = FreeRTOS_errno;
5166 /* Select a new task to run. */
5167 taskSELECT_HIGHEST_PRIORITY_TASK( xCoreID );
5168 traceTASK_SWITCHED_IN();
5170 /* After the new task is switched in, update the global errno. */
5171 #if ( configUSE_POSIX_ERRNO == 1 )
5173 FreeRTOS_errno = pxCurrentTCB->iTaskErrno;
5177 #if ( configUSE_C_RUNTIME_TLS_SUPPORT == 1 )
5179 /* Switch C-Runtime's TLS Block to point to the TLS
5180 * Block specific to this task. */
5181 configSET_TLS_BLOCK( pxCurrentTCB->xTLSBlock );
5186 portRELEASE_ISR_LOCK();
5187 portRELEASE_TASK_LOCK();
5189 traceRETURN_vTaskSwitchContext();
5191 #endif /* if ( configNUMBER_OF_CORES > 1 ) */
5192 /*-----------------------------------------------------------*/
5194 void vTaskPlaceOnEventList( List_t * const pxEventList,
5195 const TickType_t xTicksToWait )
5197 traceENTER_vTaskPlaceOnEventList( pxEventList, xTicksToWait );
5199 configASSERT( pxEventList );
5201 /* THIS FUNCTION MUST BE CALLED WITH EITHER INTERRUPTS DISABLED OR THE
5202 * SCHEDULER SUSPENDED AND THE QUEUE BEING ACCESSED LOCKED. */
5204 /* Place the event list item of the TCB in the appropriate event list.
5205 * This is placed in the list in priority order so the highest priority task
5206 * is the first to be woken by the event.
5208 * Note: Lists are sorted in ascending order by ListItem_t.xItemValue.
5209 * Normally, the xItemValue of a TCB's ListItem_t members is:
5210 * xItemValue = ( configMAX_PRIORITIES - uxPriority )
5211 * Therefore, the event list is sorted in descending priority order.
5213 * The queue that contains the event list is locked, preventing
5214 * simultaneous access from interrupts. */
5215 vListInsert( pxEventList, &( pxCurrentTCB->xEventListItem ) );
5217 prvAddCurrentTaskToDelayedList( xTicksToWait, pdTRUE );
5219 traceRETURN_vTaskPlaceOnEventList();
5221 /*-----------------------------------------------------------*/
5223 void vTaskPlaceOnUnorderedEventList( List_t * pxEventList,
5224 const TickType_t xItemValue,
5225 const TickType_t xTicksToWait )
5227 traceENTER_vTaskPlaceOnUnorderedEventList( pxEventList, xItemValue, xTicksToWait );
5229 configASSERT( pxEventList );
5231 /* THIS FUNCTION MUST BE CALLED WITH THE SCHEDULER SUSPENDED. It is used by
5232 * the event groups implementation. */
5233 configASSERT( uxSchedulerSuspended != ( UBaseType_t ) 0U );
5235 /* Store the item value in the event list item. It is safe to access the
5236 * event list item here as interrupts won't access the event list item of a
5237 * task that is not in the Blocked state. */
5238 listSET_LIST_ITEM_VALUE( &( pxCurrentTCB->xEventListItem ), xItemValue | taskEVENT_LIST_ITEM_VALUE_IN_USE );
5240 /* Place the event list item of the TCB at the end of the appropriate event
5241 * list. It is safe to access the event list here because it is part of an
5242 * event group implementation - and interrupts don't access event groups
5243 * directly (instead they access them indirectly by pending function calls to
5244 * the task level). */
5245 listINSERT_END( pxEventList, &( pxCurrentTCB->xEventListItem ) );
5247 prvAddCurrentTaskToDelayedList( xTicksToWait, pdTRUE );
5249 traceRETURN_vTaskPlaceOnUnorderedEventList();
5251 /*-----------------------------------------------------------*/
5253 #if ( configUSE_TIMERS == 1 )
5255 void vTaskPlaceOnEventListRestricted( List_t * const pxEventList,
5256 TickType_t xTicksToWait,
5257 const BaseType_t xWaitIndefinitely )
5259 traceENTER_vTaskPlaceOnEventListRestricted( pxEventList, xTicksToWait, xWaitIndefinitely );
5261 configASSERT( pxEventList );
5263 /* This function should not be called by application code hence the
5264 * 'Restricted' in its name. It is not part of the public API. It is
5265 * designed for use by kernel code, and has special calling requirements -
5266 * it should be called with the scheduler suspended. */
5269 /* Place the event list item of the TCB in the appropriate event list.
5270 * In this case it is assume that this is the only task that is going to
5271 * be waiting on this event list, so the faster vListInsertEnd() function
5272 * can be used in place of vListInsert. */
5273 listINSERT_END( pxEventList, &( pxCurrentTCB->xEventListItem ) );
5275 /* If the task should block indefinitely then set the block time to a
5276 * value that will be recognised as an indefinite delay inside the
5277 * prvAddCurrentTaskToDelayedList() function. */
5278 if( xWaitIndefinitely != pdFALSE )
5280 xTicksToWait = portMAX_DELAY;
5283 traceTASK_DELAY_UNTIL( ( xTickCount + xTicksToWait ) );
5284 prvAddCurrentTaskToDelayedList( xTicksToWait, xWaitIndefinitely );
5286 traceRETURN_vTaskPlaceOnEventListRestricted();
5289 #endif /* configUSE_TIMERS */
5290 /*-----------------------------------------------------------*/
5292 BaseType_t xTaskRemoveFromEventList( const List_t * const pxEventList )
5294 TCB_t * pxUnblockedTCB;
5297 traceENTER_xTaskRemoveFromEventList( pxEventList );
5299 /* THIS FUNCTION MUST BE CALLED FROM A CRITICAL SECTION. It can also be
5300 * called from a critical section within an ISR. */
5302 /* The event list is sorted in priority order, so the first in the list can
5303 * be removed as it is known to be the highest priority. Remove the TCB from
5304 * the delayed list, and add it to the ready list.
5306 * If an event is for a queue that is locked then this function will never
5307 * get called - the lock count on the queue will get modified instead. This
5308 * means exclusive access to the event list is guaranteed here.
5310 * This function assumes that a check has already been made to ensure that
5311 * pxEventList is not empty. */
5312 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. */
5313 configASSERT( pxUnblockedTCB );
5314 listREMOVE_ITEM( &( pxUnblockedTCB->xEventListItem ) );
5316 if( uxSchedulerSuspended == ( UBaseType_t ) 0U )
5318 listREMOVE_ITEM( &( pxUnblockedTCB->xStateListItem ) );
5319 prvAddTaskToReadyList( pxUnblockedTCB );
5321 #if ( configUSE_TICKLESS_IDLE != 0 )
5323 /* If a task is blocked on a kernel object then xNextTaskUnblockTime
5324 * might be set to the blocked task's time out time. If the task is
5325 * unblocked for a reason other than a timeout xNextTaskUnblockTime is
5326 * normally left unchanged, because it is automatically reset to a new
5327 * value when the tick count equals xNextTaskUnblockTime. However if
5328 * tickless idling is used it might be more important to enter sleep mode
5329 * at the earliest possible time - so reset xNextTaskUnblockTime here to
5330 * ensure it is updated at the earliest possible time. */
5331 prvResetNextTaskUnblockTime();
5337 /* The delayed and ready lists cannot be accessed, so hold this task
5338 * pending until the scheduler is resumed. */
5339 listINSERT_END( &( xPendingReadyList ), &( pxUnblockedTCB->xEventListItem ) );
5342 #if ( configNUMBER_OF_CORES == 1 )
5344 if( pxUnblockedTCB->uxPriority > pxCurrentTCB->uxPriority )
5346 /* Return true if the task removed from the event list has a higher
5347 * priority than the calling task. This allows the calling task to know if
5348 * it should force a context switch now. */
5351 /* Mark that a yield is pending in case the user is not using the
5352 * "xHigherPriorityTaskWoken" parameter to an ISR safe FreeRTOS function. */
5353 xYieldPendings[ 0 ] = pdTRUE;
5360 #else /* #if ( configNUMBER_OF_CORES == 1 ) */
5364 #if ( configUSE_PREEMPTION == 1 )
5366 prvYieldForTask( pxUnblockedTCB );
5368 if( xYieldPendings[ portGET_CORE_ID() ] != pdFALSE )
5373 #endif /* #if ( configUSE_PREEMPTION == 1 ) */
5375 #endif /* #if ( configNUMBER_OF_CORES == 1 ) */
5377 traceRETURN_xTaskRemoveFromEventList( xReturn );
5380 /*-----------------------------------------------------------*/
5382 void vTaskRemoveFromUnorderedEventList( ListItem_t * pxEventListItem,
5383 const TickType_t xItemValue )
5385 TCB_t * pxUnblockedTCB;
5387 traceENTER_vTaskRemoveFromUnorderedEventList( pxEventListItem, xItemValue );
5389 /* THIS FUNCTION MUST BE CALLED WITH THE SCHEDULER SUSPENDED. It is used by
5390 * the event flags implementation. */
5391 configASSERT( uxSchedulerSuspended != ( UBaseType_t ) 0U );
5393 /* Store the new item value in the event list. */
5394 listSET_LIST_ITEM_VALUE( pxEventListItem, xItemValue | taskEVENT_LIST_ITEM_VALUE_IN_USE );
5396 /* Remove the event list form the event flag. Interrupts do not access
5398 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. */
5399 configASSERT( pxUnblockedTCB );
5400 listREMOVE_ITEM( pxEventListItem );
5402 #if ( configUSE_TICKLESS_IDLE != 0 )
5404 /* If a task is blocked on a kernel object then xNextTaskUnblockTime
5405 * might be set to the blocked task's time out time. If the task is
5406 * unblocked for a reason other than a timeout xNextTaskUnblockTime is
5407 * normally left unchanged, because it is automatically reset to a new
5408 * value when the tick count equals xNextTaskUnblockTime. However if
5409 * tickless idling is used it might be more important to enter sleep mode
5410 * at the earliest possible time - so reset xNextTaskUnblockTime here to
5411 * ensure it is updated at the earliest possible time. */
5412 prvResetNextTaskUnblockTime();
5416 /* Remove the task from the delayed list and add it to the ready list. The
5417 * scheduler is suspended so interrupts will not be accessing the ready
5419 listREMOVE_ITEM( &( pxUnblockedTCB->xStateListItem ) );
5420 prvAddTaskToReadyList( pxUnblockedTCB );
5422 #if ( configNUMBER_OF_CORES == 1 )
5424 if( pxUnblockedTCB->uxPriority > pxCurrentTCB->uxPriority )
5426 /* The unblocked task has a priority above that of the calling task, so
5427 * a context switch is required. This function is called with the
5428 * scheduler suspended so xYieldPending is set so the context switch
5429 * occurs immediately that the scheduler is resumed (unsuspended). */
5430 xYieldPendings[ 0 ] = pdTRUE;
5433 #else /* #if ( configNUMBER_OF_CORES == 1 ) */
5435 #if ( configUSE_PREEMPTION == 1 )
5437 taskENTER_CRITICAL();
5439 prvYieldForTask( pxUnblockedTCB );
5441 taskEXIT_CRITICAL();
5445 #endif /* #if ( configNUMBER_OF_CORES == 1 ) */
5447 traceRETURN_vTaskRemoveFromUnorderedEventList();
5449 /*-----------------------------------------------------------*/
5451 void vTaskSetTimeOutState( TimeOut_t * const pxTimeOut )
5453 traceENTER_vTaskSetTimeOutState( pxTimeOut );
5455 configASSERT( pxTimeOut );
5456 taskENTER_CRITICAL();
5458 pxTimeOut->xOverflowCount = xNumOfOverflows;
5459 pxTimeOut->xTimeOnEntering = xTickCount;
5461 taskEXIT_CRITICAL();
5463 traceRETURN_vTaskSetTimeOutState();
5465 /*-----------------------------------------------------------*/
5467 void vTaskInternalSetTimeOutState( TimeOut_t * const pxTimeOut )
5469 traceENTER_vTaskInternalSetTimeOutState( pxTimeOut );
5471 /* For internal use only as it does not use a critical section. */
5472 pxTimeOut->xOverflowCount = xNumOfOverflows;
5473 pxTimeOut->xTimeOnEntering = xTickCount;
5475 traceRETURN_vTaskInternalSetTimeOutState();
5477 /*-----------------------------------------------------------*/
5479 BaseType_t xTaskCheckForTimeOut( TimeOut_t * const pxTimeOut,
5480 TickType_t * const pxTicksToWait )
5484 traceENTER_xTaskCheckForTimeOut( pxTimeOut, pxTicksToWait );
5486 configASSERT( pxTimeOut );
5487 configASSERT( pxTicksToWait );
5489 taskENTER_CRITICAL();
5491 /* Minor optimisation. The tick count cannot change in this block. */
5492 const TickType_t xConstTickCount = xTickCount;
5493 const TickType_t xElapsedTime = xConstTickCount - pxTimeOut->xTimeOnEntering;
5495 #if ( INCLUDE_xTaskAbortDelay == 1 )
5496 if( pxCurrentTCB->ucDelayAborted != ( uint8_t ) pdFALSE )
5498 /* The delay was aborted, which is not the same as a time out,
5499 * but has the same result. */
5500 pxCurrentTCB->ucDelayAborted = pdFALSE;
5506 #if ( INCLUDE_vTaskSuspend == 1 )
5507 if( *pxTicksToWait == portMAX_DELAY )
5509 /* If INCLUDE_vTaskSuspend is set to 1 and the block time
5510 * specified is the maximum block time then the task should block
5511 * indefinitely, and therefore never time out. */
5517 if( ( xNumOfOverflows != pxTimeOut->xOverflowCount ) && ( xConstTickCount >= pxTimeOut->xTimeOnEntering ) ) /*lint !e525 Indentation preferred as is to make code within pre-processor directives clearer. */
5519 /* The tick count is greater than the time at which
5520 * vTaskSetTimeout() was called, but has also overflowed since
5521 * vTaskSetTimeOut() was called. It must have wrapped all the way
5522 * around and gone past again. This passed since vTaskSetTimeout()
5525 *pxTicksToWait = ( TickType_t ) 0;
5527 else if( xElapsedTime < *pxTicksToWait ) /*lint !e961 Explicit casting is only redundant with some compilers, whereas others require it to prevent integer conversion errors. */
5529 /* Not a genuine timeout. Adjust parameters for time remaining. */
5530 *pxTicksToWait -= xElapsedTime;
5531 vTaskInternalSetTimeOutState( pxTimeOut );
5536 *pxTicksToWait = ( TickType_t ) 0;
5540 taskEXIT_CRITICAL();
5542 traceRETURN_xTaskCheckForTimeOut( xReturn );
5546 /*-----------------------------------------------------------*/
5548 void vTaskMissedYield( void )
5550 traceENTER_vTaskMissedYield();
5552 /* Must be called from within a critical section. */
5553 xYieldPendings[ portGET_CORE_ID() ] = pdTRUE;
5555 traceRETURN_vTaskMissedYield();
5557 /*-----------------------------------------------------------*/
5559 #if ( configUSE_TRACE_FACILITY == 1 )
5561 UBaseType_t uxTaskGetTaskNumber( TaskHandle_t xTask )
5563 UBaseType_t uxReturn;
5564 TCB_t const * pxTCB;
5566 traceENTER_uxTaskGetTaskNumber( xTask );
5571 uxReturn = pxTCB->uxTaskNumber;
5578 traceRETURN_uxTaskGetTaskNumber( uxReturn );
5583 #endif /* configUSE_TRACE_FACILITY */
5584 /*-----------------------------------------------------------*/
5586 #if ( configUSE_TRACE_FACILITY == 1 )
5588 void vTaskSetTaskNumber( TaskHandle_t xTask,
5589 const UBaseType_t uxHandle )
5593 traceENTER_vTaskSetTaskNumber( xTask, uxHandle );
5598 pxTCB->uxTaskNumber = uxHandle;
5601 traceRETURN_vTaskSetTaskNumber();
5604 #endif /* configUSE_TRACE_FACILITY */
5605 /*-----------------------------------------------------------*/
5608 * -----------------------------------------------------------
5609 * The passive idle task.
5610 * ----------------------------------------------------------
5612 * The passive idle task is used for all the additional cores in a SMP
5613 * system. There must be only 1 active idle task and the rest are passive
5616 * The portTASK_FUNCTION() macro is used to allow port/compiler specific
5617 * language extensions. The equivalent prototype for this function is:
5619 * void prvPassiveIdleTask( void *pvParameters );
5622 #if ( configNUMBER_OF_CORES > 1 )
5623 static portTASK_FUNCTION( prvPassiveIdleTask, pvParameters )
5625 ( void ) pvParameters;
5629 for( ; configCONTROL_INFINITE_LOOP(); )
5631 #if ( configUSE_PREEMPTION == 0 )
5633 /* If we are not using preemption we keep forcing a task switch to
5634 * see if any other task has become available. If we are using
5635 * preemption we don't need to do this as any task becoming available
5636 * will automatically get the processor anyway. */
5639 #endif /* configUSE_PREEMPTION */
5641 #if ( ( configUSE_PREEMPTION == 1 ) && ( configIDLE_SHOULD_YIELD == 1 ) )
5643 /* When using preemption tasks of equal priority will be
5644 * timesliced. If a task that is sharing the idle priority is ready
5645 * to run then the idle task should yield before the end of the
5648 * A critical region is not required here as we are just reading from
5649 * the list, and an occasional incorrect value will not matter. If
5650 * the ready list at the idle priority contains one more task than the
5651 * number of idle tasks, which is equal to the configured numbers of cores
5652 * then a task other than the idle task is ready to execute. */
5653 if( listCURRENT_LIST_LENGTH( &( pxReadyTasksLists[ tskIDLE_PRIORITY ] ) ) > ( UBaseType_t ) configNUMBER_OF_CORES )
5659 mtCOVERAGE_TEST_MARKER();
5662 #endif /* ( ( configUSE_PREEMPTION == 1 ) && ( configIDLE_SHOULD_YIELD == 1 ) ) */
5664 #if ( configUSE_PASSIVE_IDLE_HOOK == 1 )
5666 /* Call the user defined function from within the idle task. This
5667 * allows the application designer to add background functionality
5668 * without the overhead of a separate task.
5670 * This hook is intended to manage core activity such as disabling cores that go idle.
5672 * NOTE: vApplicationPassiveIdleHook() MUST NOT, UNDER ANY CIRCUMSTANCES,
5673 * CALL A FUNCTION THAT MIGHT BLOCK. */
5674 vApplicationPassiveIdleHook();
5676 #endif /* configUSE_PASSIVE_IDLE_HOOK */
5679 #endif /* #if ( configNUMBER_OF_CORES > 1 ) */
5682 * -----------------------------------------------------------
5684 * ----------------------------------------------------------
5686 * The portTASK_FUNCTION() macro is used to allow port/compiler specific
5687 * language extensions. The equivalent prototype for this function is:
5689 * void prvIdleTask( void *pvParameters );
5693 static portTASK_FUNCTION( prvIdleTask, pvParameters )
5695 /* Stop warnings. */
5696 ( void ) pvParameters;
5698 /** THIS IS THE RTOS IDLE TASK - WHICH IS CREATED AUTOMATICALLY WHEN THE
5699 * SCHEDULER IS STARTED. **/
5701 /* In case a task that has a secure context deletes itself, in which case
5702 * the idle task is responsible for deleting the task's secure context, if
5704 portALLOCATE_SECURE_CONTEXT( configMINIMAL_SECURE_STACK_SIZE );
5706 #if ( configNUMBER_OF_CORES > 1 )
5708 /* SMP all cores start up in the idle task. This initial yield gets the application
5712 #endif /* #if ( configNUMBER_OF_CORES > 1 ) */
5714 for( ; configCONTROL_INFINITE_LOOP(); )
5716 /* See if any tasks have deleted themselves - if so then the idle task
5717 * is responsible for freeing the deleted task's TCB and stack. */
5718 prvCheckTasksWaitingTermination();
5720 #if ( configUSE_PREEMPTION == 0 )
5722 /* If we are not using preemption we keep forcing a task switch to
5723 * see if any other task has become available. If we are using
5724 * preemption we don't need to do this as any task becoming available
5725 * will automatically get the processor anyway. */
5728 #endif /* configUSE_PREEMPTION */
5730 #if ( ( configUSE_PREEMPTION == 1 ) && ( configIDLE_SHOULD_YIELD == 1 ) )
5732 /* When using preemption tasks of equal priority will be
5733 * timesliced. If a task that is sharing the idle priority is ready
5734 * to run then the idle task should yield before the end of the
5737 * A critical region is not required here as we are just reading from
5738 * the list, and an occasional incorrect value will not matter. If
5739 * the ready list at the idle priority contains one more task than the
5740 * number of idle tasks, which is equal to the configured numbers of cores
5741 * then a task other than the idle task is ready to execute. */
5742 if( listCURRENT_LIST_LENGTH( &( pxReadyTasksLists[ tskIDLE_PRIORITY ] ) ) > ( UBaseType_t ) configNUMBER_OF_CORES )
5748 mtCOVERAGE_TEST_MARKER();
5751 #endif /* ( ( configUSE_PREEMPTION == 1 ) && ( configIDLE_SHOULD_YIELD == 1 ) ) */
5753 #if ( configUSE_IDLE_HOOK == 1 )
5755 /* Call the user defined function from within the idle task. */
5756 vApplicationIdleHook();
5758 #endif /* configUSE_IDLE_HOOK */
5760 /* This conditional compilation should use inequality to 0, not equality
5761 * to 1. This is to ensure portSUPPRESS_TICKS_AND_SLEEP() is called when
5762 * user defined low power mode implementations require
5763 * configUSE_TICKLESS_IDLE to be set to a value other than 1. */
5764 #if ( configUSE_TICKLESS_IDLE != 0 )
5766 TickType_t xExpectedIdleTime;
5768 /* It is not desirable to suspend then resume the scheduler on
5769 * each iteration of the idle task. Therefore, a preliminary
5770 * test of the expected idle time is performed without the
5771 * scheduler suspended. The result here is not necessarily
5773 xExpectedIdleTime = prvGetExpectedIdleTime();
5775 if( xExpectedIdleTime >= configEXPECTED_IDLE_TIME_BEFORE_SLEEP )
5779 /* Now the scheduler is suspended, the expected idle
5780 * time can be sampled again, and this time its value can
5782 configASSERT( xNextTaskUnblockTime >= xTickCount );
5783 xExpectedIdleTime = prvGetExpectedIdleTime();
5785 /* Define the following macro to set xExpectedIdleTime to 0
5786 * if the application does not want
5787 * portSUPPRESS_TICKS_AND_SLEEP() to be called. */
5788 configPRE_SUPPRESS_TICKS_AND_SLEEP_PROCESSING( xExpectedIdleTime );
5790 if( xExpectedIdleTime >= configEXPECTED_IDLE_TIME_BEFORE_SLEEP )
5792 traceLOW_POWER_IDLE_BEGIN();
5793 portSUPPRESS_TICKS_AND_SLEEP( xExpectedIdleTime );
5794 traceLOW_POWER_IDLE_END();
5798 mtCOVERAGE_TEST_MARKER();
5801 ( void ) xTaskResumeAll();
5805 mtCOVERAGE_TEST_MARKER();
5808 #endif /* configUSE_TICKLESS_IDLE */
5810 #if ( ( configNUMBER_OF_CORES > 1 ) && ( configUSE_PASSIVE_IDLE_HOOK == 1 ) )
5812 /* Call the user defined function from within the idle task. This
5813 * allows the application designer to add background functionality
5814 * without the overhead of a separate task.
5816 * This hook is intended to manage core activity such as disabling cores that go idle.
5818 * NOTE: vApplicationPassiveIdleHook() MUST NOT, UNDER ANY CIRCUMSTANCES,
5819 * CALL A FUNCTION THAT MIGHT BLOCK. */
5820 vApplicationPassiveIdleHook();
5822 #endif /* #if ( ( configNUMBER_OF_CORES > 1 ) && ( configUSE_PASSIVE_IDLE_HOOK == 1 ) ) */
5825 /*-----------------------------------------------------------*/
5827 #if ( configUSE_TICKLESS_IDLE != 0 )
5829 eSleepModeStatus eTaskConfirmSleepModeStatus( void )
5831 #if ( INCLUDE_vTaskSuspend == 1 )
5832 /* The idle task exists in addition to the application tasks. */
5833 const UBaseType_t uxNonApplicationTasks = 1;
5834 #endif /* INCLUDE_vTaskSuspend */
5836 eSleepModeStatus eReturn = eStandardSleep;
5838 traceENTER_eTaskConfirmSleepModeStatus();
5840 /* This function must be called from a critical section. */
5842 if( listCURRENT_LIST_LENGTH( &xPendingReadyList ) != 0 )
5844 /* A task was made ready while the scheduler was suspended. */
5845 eReturn = eAbortSleep;
5847 else if( xYieldPendings[ portGET_CORE_ID() ] != pdFALSE )
5849 /* A yield was pended while the scheduler was suspended. */
5850 eReturn = eAbortSleep;
5852 else if( xPendedTicks != 0 )
5854 /* A tick interrupt has already occurred but was held pending
5855 * because the scheduler is suspended. */
5856 eReturn = eAbortSleep;
5859 #if ( INCLUDE_vTaskSuspend == 1 )
5860 else if( listCURRENT_LIST_LENGTH( &xSuspendedTaskList ) == ( uxCurrentNumberOfTasks - uxNonApplicationTasks ) )
5862 /* If all the tasks are in the suspended list (which might mean they
5863 * have an infinite block time rather than actually being suspended)
5864 * then it is safe to turn all clocks off and just wait for external
5866 eReturn = eNoTasksWaitingTimeout;
5868 #endif /* INCLUDE_vTaskSuspend */
5871 mtCOVERAGE_TEST_MARKER();
5874 traceRETURN_eTaskConfirmSleepModeStatus( eReturn );
5879 #endif /* configUSE_TICKLESS_IDLE */
5880 /*-----------------------------------------------------------*/
5882 #if ( configNUM_THREAD_LOCAL_STORAGE_POINTERS != 0 )
5884 void vTaskSetThreadLocalStoragePointer( TaskHandle_t xTaskToSet,
5890 traceENTER_vTaskSetThreadLocalStoragePointer( xTaskToSet, xIndex, pvValue );
5892 if( ( xIndex >= 0 ) &&
5893 ( xIndex < ( BaseType_t ) configNUM_THREAD_LOCAL_STORAGE_POINTERS ) )
5895 pxTCB = prvGetTCBFromHandle( xTaskToSet );
5896 configASSERT( pxTCB != NULL );
5897 pxTCB->pvThreadLocalStoragePointers[ xIndex ] = pvValue;
5900 traceRETURN_vTaskSetThreadLocalStoragePointer();
5903 #endif /* configNUM_THREAD_LOCAL_STORAGE_POINTERS */
5904 /*-----------------------------------------------------------*/
5906 #if ( configNUM_THREAD_LOCAL_STORAGE_POINTERS != 0 )
5908 void * pvTaskGetThreadLocalStoragePointer( TaskHandle_t xTaskToQuery,
5911 void * pvReturn = NULL;
5914 traceENTER_pvTaskGetThreadLocalStoragePointer( xTaskToQuery, xIndex );
5916 if( ( xIndex >= 0 ) &&
5917 ( xIndex < ( BaseType_t ) configNUM_THREAD_LOCAL_STORAGE_POINTERS ) )
5919 pxTCB = prvGetTCBFromHandle( xTaskToQuery );
5920 pvReturn = pxTCB->pvThreadLocalStoragePointers[ xIndex ];
5927 traceRETURN_pvTaskGetThreadLocalStoragePointer( pvReturn );
5932 #endif /* configNUM_THREAD_LOCAL_STORAGE_POINTERS */
5933 /*-----------------------------------------------------------*/
5935 #if ( portUSING_MPU_WRAPPERS == 1 )
5937 void vTaskAllocateMPURegions( TaskHandle_t xTaskToModify,
5938 const MemoryRegion_t * const pxRegions )
5942 traceENTER_vTaskAllocateMPURegions( xTaskToModify, pxRegions );
5944 /* If null is passed in here then we are modifying the MPU settings of
5945 * the calling task. */
5946 pxTCB = prvGetTCBFromHandle( xTaskToModify );
5948 vPortStoreTaskMPUSettings( &( pxTCB->xMPUSettings ), pxRegions, NULL, 0 );
5950 traceRETURN_vTaskAllocateMPURegions();
5953 #endif /* portUSING_MPU_WRAPPERS */
5954 /*-----------------------------------------------------------*/
5956 static void prvInitialiseTaskLists( void )
5958 UBaseType_t uxPriority;
5960 for( uxPriority = ( UBaseType_t ) 0U; uxPriority < ( UBaseType_t ) configMAX_PRIORITIES; uxPriority++ )
5962 vListInitialise( &( pxReadyTasksLists[ uxPriority ] ) );
5965 vListInitialise( &xDelayedTaskList1 );
5966 vListInitialise( &xDelayedTaskList2 );
5967 vListInitialise( &xPendingReadyList );
5969 #if ( INCLUDE_vTaskDelete == 1 )
5971 vListInitialise( &xTasksWaitingTermination );
5973 #endif /* INCLUDE_vTaskDelete */
5975 #if ( INCLUDE_vTaskSuspend == 1 )
5977 vListInitialise( &xSuspendedTaskList );
5979 #endif /* INCLUDE_vTaskSuspend */
5981 /* Start with pxDelayedTaskList using list1 and the pxOverflowDelayedTaskList
5983 pxDelayedTaskList = &xDelayedTaskList1;
5984 pxOverflowDelayedTaskList = &xDelayedTaskList2;
5986 /*-----------------------------------------------------------*/
5988 static void prvCheckTasksWaitingTermination( void )
5990 /** THIS FUNCTION IS CALLED FROM THE RTOS IDLE TASK **/
5992 #if ( INCLUDE_vTaskDelete == 1 )
5996 /* uxDeletedTasksWaitingCleanUp is used to prevent taskENTER_CRITICAL()
5997 * being called too often in the idle task. */
5998 while( uxDeletedTasksWaitingCleanUp > ( UBaseType_t ) 0U )
6000 #if ( configNUMBER_OF_CORES == 1 )
6002 taskENTER_CRITICAL();
6005 pxTCB = listGET_OWNER_OF_HEAD_ENTRY( ( &xTasksWaitingTermination ) ); /*lint !e9079 void * is used as this macro is used with timers too. Alignment is known to be fine as the type of the pointer stored and retrieved is the same. */
6006 ( void ) uxListRemove( &( pxTCB->xStateListItem ) );
6007 --uxCurrentNumberOfTasks;
6008 --uxDeletedTasksWaitingCleanUp;
6011 taskEXIT_CRITICAL();
6013 prvDeleteTCB( pxTCB );
6015 #else /* #if( configNUMBER_OF_CORES == 1 ) */
6019 taskENTER_CRITICAL();
6021 /* For SMP, multiple idles can be running simultaneously
6022 * and we need to check that other idles did not cleanup while we were
6023 * waiting to enter the critical section. */
6024 if( uxDeletedTasksWaitingCleanUp > ( UBaseType_t ) 0U )
6026 pxTCB = listGET_OWNER_OF_HEAD_ENTRY( ( &xTasksWaitingTermination ) ); /*lint !e9079 void * is used as this macro is used with timers too. Alignment is known to be fine as the type of the pointer stored and retrieved is the same. */
6028 if( pxTCB->xTaskRunState == taskTASK_NOT_RUNNING )
6030 ( void ) uxListRemove( &( pxTCB->xStateListItem ) );
6031 --uxCurrentNumberOfTasks;
6032 --uxDeletedTasksWaitingCleanUp;
6036 /* The TCB to be deleted still has not yet been switched out
6037 * by the scheduler, so we will just exit this loop early and
6038 * try again next time. */
6039 taskEXIT_CRITICAL();
6044 taskEXIT_CRITICAL();
6048 prvDeleteTCB( pxTCB );
6051 #endif /* #if( configNUMBER_OF_CORES == 1 ) */
6054 #endif /* INCLUDE_vTaskDelete */
6056 /*-----------------------------------------------------------*/
6058 #if ( configUSE_TRACE_FACILITY == 1 )
6060 void vTaskGetInfo( TaskHandle_t xTask,
6061 TaskStatus_t * pxTaskStatus,
6062 BaseType_t xGetFreeStackSpace,
6067 traceENTER_vTaskGetInfo( xTask, pxTaskStatus, xGetFreeStackSpace, eState );
6069 /* xTask is NULL then get the state of the calling task. */
6070 pxTCB = prvGetTCBFromHandle( xTask );
6072 pxTaskStatus->xHandle = pxTCB;
6073 pxTaskStatus->pcTaskName = ( const char * ) &( pxTCB->pcTaskName[ 0 ] );
6074 pxTaskStatus->uxCurrentPriority = pxTCB->uxPriority;
6075 pxTaskStatus->pxStackBase = pxTCB->pxStack;
6076 #if ( ( portSTACK_GROWTH > 0 ) || ( configRECORD_STACK_HIGH_ADDRESS == 1 ) )
6077 pxTaskStatus->pxTopOfStack = ( StackType_t * ) pxTCB->pxTopOfStack;
6078 pxTaskStatus->pxEndOfStack = pxTCB->pxEndOfStack;
6080 pxTaskStatus->xTaskNumber = pxTCB->uxTCBNumber;
6082 #if ( ( configUSE_CORE_AFFINITY == 1 ) && ( configNUMBER_OF_CORES > 1 ) )
6084 pxTaskStatus->uxCoreAffinityMask = pxTCB->uxCoreAffinityMask;
6088 #if ( configUSE_MUTEXES == 1 )
6090 pxTaskStatus->uxBasePriority = pxTCB->uxBasePriority;
6094 pxTaskStatus->uxBasePriority = 0;
6098 #if ( configGENERATE_RUN_TIME_STATS == 1 )
6100 pxTaskStatus->ulRunTimeCounter = pxTCB->ulRunTimeCounter;
6104 pxTaskStatus->ulRunTimeCounter = ( configRUN_TIME_COUNTER_TYPE ) 0;
6108 /* Obtaining the task state is a little fiddly, so is only done if the
6109 * value of eState passed into this function is eInvalid - otherwise the
6110 * state is just set to whatever is passed in. */
6111 if( eState != eInvalid )
6113 if( taskTASK_IS_RUNNING( pxTCB ) == pdTRUE )
6115 pxTaskStatus->eCurrentState = eRunning;
6119 pxTaskStatus->eCurrentState = eState;
6121 #if ( INCLUDE_vTaskSuspend == 1 )
6123 /* If the task is in the suspended list then there is a
6124 * chance it is actually just blocked indefinitely - so really
6125 * it should be reported as being in the Blocked state. */
6126 if( eState == eSuspended )
6130 if( listLIST_ITEM_CONTAINER( &( pxTCB->xEventListItem ) ) != NULL )
6132 pxTaskStatus->eCurrentState = eBlocked;
6135 ( void ) xTaskResumeAll();
6138 #endif /* INCLUDE_vTaskSuspend */
6140 /* Tasks can be in pending ready list and other state list at the
6141 * same time. These tasks are in ready state no matter what state
6142 * list the task is in. */
6143 taskENTER_CRITICAL();
6145 if( listIS_CONTAINED_WITHIN( &xPendingReadyList, &( pxTCB->xEventListItem ) ) != pdFALSE )
6147 pxTaskStatus->eCurrentState = eReady;
6150 taskEXIT_CRITICAL();
6155 pxTaskStatus->eCurrentState = eTaskGetState( pxTCB );
6158 /* Obtaining the stack space takes some time, so the xGetFreeStackSpace
6159 * parameter is provided to allow it to be skipped. */
6160 if( xGetFreeStackSpace != pdFALSE )
6162 #if ( portSTACK_GROWTH > 0 )
6164 pxTaskStatus->usStackHighWaterMark = prvTaskCheckFreeStackSpace( ( uint8_t * ) pxTCB->pxEndOfStack );
6168 pxTaskStatus->usStackHighWaterMark = prvTaskCheckFreeStackSpace( ( uint8_t * ) pxTCB->pxStack );
6174 pxTaskStatus->usStackHighWaterMark = 0;
6177 traceRETURN_vTaskGetInfo();
6180 #endif /* configUSE_TRACE_FACILITY */
6181 /*-----------------------------------------------------------*/
6183 #if ( configUSE_TRACE_FACILITY == 1 )
6185 static UBaseType_t prvListTasksWithinSingleList( TaskStatus_t * pxTaskStatusArray,
6189 configLIST_VOLATILE TCB_t * pxNextTCB;
6190 configLIST_VOLATILE TCB_t * pxFirstTCB;
6191 UBaseType_t uxTask = 0;
6193 if( listCURRENT_LIST_LENGTH( pxList ) > ( UBaseType_t ) 0 )
6195 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. */
6197 /* Populate an TaskStatus_t structure within the
6198 * pxTaskStatusArray array for each task that is referenced from
6199 * pxList. See the definition of TaskStatus_t in task.h for the
6200 * meaning of each TaskStatus_t structure member. */
6203 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. */
6204 vTaskGetInfo( ( TaskHandle_t ) pxNextTCB, &( pxTaskStatusArray[ uxTask ] ), pdTRUE, eState );
6206 } while( pxNextTCB != pxFirstTCB );
6210 mtCOVERAGE_TEST_MARKER();
6216 #endif /* configUSE_TRACE_FACILITY */
6217 /*-----------------------------------------------------------*/
6219 #if ( ( configUSE_TRACE_FACILITY == 1 ) || ( INCLUDE_uxTaskGetStackHighWaterMark == 1 ) || ( INCLUDE_uxTaskGetStackHighWaterMark2 == 1 ) )
6221 static configSTACK_DEPTH_TYPE prvTaskCheckFreeStackSpace( const uint8_t * pucStackByte )
6223 uint32_t ulCount = 0U;
6225 while( *pucStackByte == ( uint8_t ) tskSTACK_FILL_BYTE )
6227 pucStackByte -= portSTACK_GROWTH;
6231 ulCount /= ( uint32_t ) sizeof( StackType_t ); /*lint !e961 Casting is not redundant on smaller architectures. */
6233 return ( configSTACK_DEPTH_TYPE ) ulCount;
6236 #endif /* ( ( configUSE_TRACE_FACILITY == 1 ) || ( INCLUDE_uxTaskGetStackHighWaterMark == 1 ) || ( INCLUDE_uxTaskGetStackHighWaterMark2 == 1 ) ) */
6237 /*-----------------------------------------------------------*/
6239 #if ( INCLUDE_uxTaskGetStackHighWaterMark2 == 1 )
6241 /* uxTaskGetStackHighWaterMark() and uxTaskGetStackHighWaterMark2() are the
6242 * same except for their return type. Using configSTACK_DEPTH_TYPE allows the
6243 * user to determine the return type. It gets around the problem of the value
6244 * overflowing on 8-bit types without breaking backward compatibility for
6245 * applications that expect an 8-bit return type. */
6246 configSTACK_DEPTH_TYPE uxTaskGetStackHighWaterMark2( TaskHandle_t xTask )
6249 uint8_t * pucEndOfStack;
6250 configSTACK_DEPTH_TYPE uxReturn;
6252 traceENTER_uxTaskGetStackHighWaterMark2( xTask );
6254 /* uxTaskGetStackHighWaterMark() and uxTaskGetStackHighWaterMark2() are
6255 * the same except for their return type. Using configSTACK_DEPTH_TYPE
6256 * allows the user to determine the return type. It gets around the
6257 * problem of the value overflowing on 8-bit types without breaking
6258 * backward compatibility for applications that expect an 8-bit return
6261 pxTCB = prvGetTCBFromHandle( xTask );
6263 #if portSTACK_GROWTH < 0
6265 pucEndOfStack = ( uint8_t * ) pxTCB->pxStack;
6269 pucEndOfStack = ( uint8_t * ) pxTCB->pxEndOfStack;
6273 uxReturn = prvTaskCheckFreeStackSpace( pucEndOfStack );
6275 traceRETURN_uxTaskGetStackHighWaterMark2( uxReturn );
6280 #endif /* INCLUDE_uxTaskGetStackHighWaterMark2 */
6281 /*-----------------------------------------------------------*/
6283 #if ( INCLUDE_uxTaskGetStackHighWaterMark == 1 )
6285 UBaseType_t uxTaskGetStackHighWaterMark( TaskHandle_t xTask )
6288 uint8_t * pucEndOfStack;
6289 UBaseType_t uxReturn;
6291 traceENTER_uxTaskGetStackHighWaterMark( xTask );
6293 pxTCB = prvGetTCBFromHandle( xTask );
6295 #if portSTACK_GROWTH < 0
6297 pucEndOfStack = ( uint8_t * ) pxTCB->pxStack;
6301 pucEndOfStack = ( uint8_t * ) pxTCB->pxEndOfStack;
6305 uxReturn = ( UBaseType_t ) prvTaskCheckFreeStackSpace( pucEndOfStack );
6307 traceRETURN_uxTaskGetStackHighWaterMark( uxReturn );
6312 #endif /* INCLUDE_uxTaskGetStackHighWaterMark */
6313 /*-----------------------------------------------------------*/
6315 #if ( INCLUDE_vTaskDelete == 1 )
6317 static void prvDeleteTCB( TCB_t * pxTCB )
6319 /* This call is required specifically for the TriCore port. It must be
6320 * above the vPortFree() calls. The call is also used by ports/demos that
6321 * want to allocate and clean RAM statically. */
6322 portCLEAN_UP_TCB( pxTCB );
6324 #if ( configUSE_C_RUNTIME_TLS_SUPPORT == 1 )
6326 /* Free up the memory allocated for the task's TLS Block. */
6327 configDEINIT_TLS_BLOCK( pxTCB->xTLSBlock );
6331 #if ( ( configSUPPORT_DYNAMIC_ALLOCATION == 1 ) && ( configSUPPORT_STATIC_ALLOCATION == 0 ) && ( portUSING_MPU_WRAPPERS == 0 ) )
6333 /* The task can only have been allocated dynamically - free both
6334 * the stack and TCB. */
6335 vPortFreeStack( pxTCB->pxStack );
6338 #elif ( tskSTATIC_AND_DYNAMIC_ALLOCATION_POSSIBLE != 0 ) /*lint !e731 !e9029 Macro has been consolidated for readability reasons. */
6340 /* The task could have been allocated statically or dynamically, so
6341 * check what was statically allocated before trying to free the
6343 if( pxTCB->ucStaticallyAllocated == tskDYNAMICALLY_ALLOCATED_STACK_AND_TCB )
6345 /* Both the stack and TCB were allocated dynamically, so both
6347 vPortFreeStack( pxTCB->pxStack );
6350 else if( pxTCB->ucStaticallyAllocated == tskSTATICALLY_ALLOCATED_STACK_ONLY )
6352 /* Only the stack was statically allocated, so the TCB is the
6353 * only memory that must be freed. */
6358 /* Neither the stack nor the TCB were allocated dynamically, so
6359 * nothing needs to be freed. */
6360 configASSERT( pxTCB->ucStaticallyAllocated == tskSTATICALLY_ALLOCATED_STACK_AND_TCB );
6361 mtCOVERAGE_TEST_MARKER();
6364 #endif /* configSUPPORT_DYNAMIC_ALLOCATION */
6367 #endif /* INCLUDE_vTaskDelete */
6368 /*-----------------------------------------------------------*/
6370 static void prvResetNextTaskUnblockTime( void )
6372 if( listLIST_IS_EMPTY( pxDelayedTaskList ) != pdFALSE )
6374 /* The new current delayed list is empty. Set xNextTaskUnblockTime to
6375 * the maximum possible value so it is extremely unlikely that the
6376 * if( xTickCount >= xNextTaskUnblockTime ) test will pass until
6377 * there is an item in the delayed list. */
6378 xNextTaskUnblockTime = portMAX_DELAY;
6382 /* The new current delayed list is not empty, get the value of
6383 * the item at the head of the delayed list. This is the time at
6384 * which the task at the head of the delayed list should be removed
6385 * from the Blocked state. */
6386 xNextTaskUnblockTime = listGET_ITEM_VALUE_OF_HEAD_ENTRY( pxDelayedTaskList );
6389 /*-----------------------------------------------------------*/
6391 #if ( ( INCLUDE_xTaskGetCurrentTaskHandle == 1 ) || ( configUSE_MUTEXES == 1 ) ) || ( configNUMBER_OF_CORES > 1 )
6393 #if ( configNUMBER_OF_CORES == 1 )
6394 TaskHandle_t xTaskGetCurrentTaskHandle( void )
6396 TaskHandle_t xReturn;
6398 traceENTER_xTaskGetCurrentTaskHandle();
6400 /* A critical section is not required as this is not called from
6401 * an interrupt and the current TCB will always be the same for any
6402 * individual execution thread. */
6403 xReturn = pxCurrentTCB;
6405 traceRETURN_xTaskGetCurrentTaskHandle( xReturn );
6409 #else /* #if ( configNUMBER_OF_CORES == 1 ) */
6410 TaskHandle_t xTaskGetCurrentTaskHandle( void )
6412 TaskHandle_t xReturn;
6413 UBaseType_t uxSavedInterruptStatus;
6415 traceENTER_xTaskGetCurrentTaskHandle();
6417 uxSavedInterruptStatus = portSET_INTERRUPT_MASK();
6419 xReturn = pxCurrentTCBs[ portGET_CORE_ID() ];
6421 portCLEAR_INTERRUPT_MASK( uxSavedInterruptStatus );
6423 traceRETURN_xTaskGetCurrentTaskHandle( xReturn );
6428 TaskHandle_t xTaskGetCurrentTaskHandleCPU( BaseType_t xCoreID )
6430 TaskHandle_t xReturn = NULL;
6432 traceENTER_xTaskGetCurrentTaskHandleCPU( xCoreID );
6434 if( taskVALID_CORE_ID( xCoreID ) != pdFALSE )
6436 xReturn = pxCurrentTCBs[ xCoreID ];
6439 traceRETURN_xTaskGetCurrentTaskHandleCPU( xReturn );
6443 #endif /* #if ( configNUMBER_OF_CORES == 1 ) */
6445 #endif /* ( ( INCLUDE_xTaskGetCurrentTaskHandle == 1 ) || ( configUSE_MUTEXES == 1 ) ) */
6446 /*-----------------------------------------------------------*/
6448 #if ( ( INCLUDE_xTaskGetSchedulerState == 1 ) || ( configUSE_TIMERS == 1 ) )
6450 BaseType_t xTaskGetSchedulerState( void )
6454 traceENTER_xTaskGetSchedulerState();
6456 if( xSchedulerRunning == pdFALSE )
6458 xReturn = taskSCHEDULER_NOT_STARTED;
6462 #if ( configNUMBER_OF_CORES > 1 )
6463 taskENTER_CRITICAL();
6466 if( uxSchedulerSuspended == ( UBaseType_t ) 0U )
6468 xReturn = taskSCHEDULER_RUNNING;
6472 xReturn = taskSCHEDULER_SUSPENDED;
6475 #if ( configNUMBER_OF_CORES > 1 )
6476 taskEXIT_CRITICAL();
6480 traceRETURN_xTaskGetSchedulerState( xReturn );
6485 #endif /* ( ( INCLUDE_xTaskGetSchedulerState == 1 ) || ( configUSE_TIMERS == 1 ) ) */
6486 /*-----------------------------------------------------------*/
6488 #if ( configUSE_MUTEXES == 1 )
6490 BaseType_t xTaskPriorityInherit( TaskHandle_t const pxMutexHolder )
6492 TCB_t * const pxMutexHolderTCB = pxMutexHolder;
6493 BaseType_t xReturn = pdFALSE;
6495 traceENTER_xTaskPriorityInherit( pxMutexHolder );
6497 /* If the mutex is taken by an interrupt, the mutex holder is NULL. Priority
6498 * inheritance is not applied in this scenario. */
6499 if( pxMutexHolder != NULL )
6501 /* If the holder of the mutex has a priority below the priority of
6502 * the task attempting to obtain the mutex then it will temporarily
6503 * inherit the priority of the task attempting to obtain the mutex. */
6504 if( pxMutexHolderTCB->uxPriority < pxCurrentTCB->uxPriority )
6506 /* Adjust the mutex holder state to account for its new
6507 * priority. Only reset the event list item value if the value is
6508 * not being used for anything else. */
6509 if( ( listGET_LIST_ITEM_VALUE( &( pxMutexHolderTCB->xEventListItem ) ) & taskEVENT_LIST_ITEM_VALUE_IN_USE ) == 0UL )
6511 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. */
6515 mtCOVERAGE_TEST_MARKER();
6518 /* If the task being modified is in the ready state it will need
6519 * to be moved into a new list. */
6520 if( listIS_CONTAINED_WITHIN( &( pxReadyTasksLists[ pxMutexHolderTCB->uxPriority ] ), &( pxMutexHolderTCB->xStateListItem ) ) != pdFALSE )
6522 if( uxListRemove( &( pxMutexHolderTCB->xStateListItem ) ) == ( UBaseType_t ) 0 )
6524 /* It is known that the task is in its ready list so
6525 * there is no need to check again and the port level
6526 * reset macro can be called directly. */
6527 portRESET_READY_PRIORITY( pxMutexHolderTCB->uxPriority, uxTopReadyPriority );
6531 mtCOVERAGE_TEST_MARKER();
6534 /* Inherit the priority before being moved into the new list. */
6535 pxMutexHolderTCB->uxPriority = pxCurrentTCB->uxPriority;
6536 prvAddTaskToReadyList( pxMutexHolderTCB );
6537 #if ( configNUMBER_OF_CORES > 1 )
6539 /* The priority of the task is raised. Yield for this task
6540 * if it is not running. */
6541 if( taskTASK_IS_RUNNING( pxMutexHolderTCB ) != pdTRUE )
6543 prvYieldForTask( pxMutexHolderTCB );
6546 #endif /* if ( configNUMBER_OF_CORES > 1 ) */
6550 /* Just inherit the priority. */
6551 pxMutexHolderTCB->uxPriority = pxCurrentTCB->uxPriority;
6554 traceTASK_PRIORITY_INHERIT( pxMutexHolderTCB, pxCurrentTCB->uxPriority );
6556 /* Inheritance occurred. */
6561 if( pxMutexHolderTCB->uxBasePriority < pxCurrentTCB->uxPriority )
6563 /* The base priority of the mutex holder is lower than the
6564 * priority of the task attempting to take the mutex, but the
6565 * current priority of the mutex holder is not lower than the
6566 * priority of the task attempting to take the mutex.
6567 * Therefore the mutex holder must have already inherited a
6568 * priority, but inheritance would have occurred if that had
6569 * not been the case. */
6574 mtCOVERAGE_TEST_MARKER();
6580 mtCOVERAGE_TEST_MARKER();
6583 traceRETURN_xTaskPriorityInherit( xReturn );
6588 #endif /* configUSE_MUTEXES */
6589 /*-----------------------------------------------------------*/
6591 #if ( configUSE_MUTEXES == 1 )
6593 BaseType_t xTaskPriorityDisinherit( TaskHandle_t const pxMutexHolder )
6595 TCB_t * const pxTCB = pxMutexHolder;
6596 BaseType_t xReturn = pdFALSE;
6598 traceENTER_xTaskPriorityDisinherit( pxMutexHolder );
6600 if( pxMutexHolder != NULL )
6602 /* A task can only have an inherited priority if it holds the mutex.
6603 * If the mutex is held by a task then it cannot be given from an
6604 * interrupt, and if a mutex is given by the holding task then it must
6605 * be the running state task. */
6606 configASSERT( pxTCB == pxCurrentTCB );
6607 configASSERT( pxTCB->uxMutexesHeld );
6608 ( pxTCB->uxMutexesHeld )--;
6610 /* Has the holder of the mutex inherited the priority of another
6612 if( pxTCB->uxPriority != pxTCB->uxBasePriority )
6614 /* Only disinherit if no other mutexes are held. */
6615 if( pxTCB->uxMutexesHeld == ( UBaseType_t ) 0 )
6617 /* A task can only have an inherited priority if it holds
6618 * the mutex. If the mutex is held by a task then it cannot be
6619 * given from an interrupt, and if a mutex is given by the
6620 * holding task then it must be the running state task. Remove
6621 * the holding task from the ready list. */
6622 if( uxListRemove( &( pxTCB->xStateListItem ) ) == ( UBaseType_t ) 0 )
6624 portRESET_READY_PRIORITY( pxTCB->uxPriority, uxTopReadyPriority );
6628 mtCOVERAGE_TEST_MARKER();
6631 /* Disinherit the priority before adding the task into the
6632 * new ready list. */
6633 traceTASK_PRIORITY_DISINHERIT( pxTCB, pxTCB->uxBasePriority );
6634 pxTCB->uxPriority = pxTCB->uxBasePriority;
6636 /* Reset the event list item value. It cannot be in use for
6637 * any other purpose if this task is running, and it must be
6638 * running to give back the mutex. */
6639 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. */
6640 prvAddTaskToReadyList( pxTCB );
6641 #if ( configNUMBER_OF_CORES > 1 )
6643 /* The priority of the task is dropped. Yield the core on
6644 * which the task is running. */
6645 if( taskTASK_IS_RUNNING( pxTCB ) == pdTRUE )
6647 prvYieldCore( pxTCB->xTaskRunState );
6650 #endif /* if ( configNUMBER_OF_CORES > 1 ) */
6652 /* Return true to indicate that a context switch is required.
6653 * This is only actually required in the corner case whereby
6654 * multiple mutexes were held and the mutexes were given back
6655 * in an order different to that in which they were taken.
6656 * If a context switch did not occur when the first mutex was
6657 * returned, even if a task was waiting on it, then a context
6658 * switch should occur when the last mutex is returned whether
6659 * a task is waiting on it or not. */
6664 mtCOVERAGE_TEST_MARKER();
6669 mtCOVERAGE_TEST_MARKER();
6674 mtCOVERAGE_TEST_MARKER();
6677 traceRETURN_xTaskPriorityDisinherit( xReturn );
6682 #endif /* configUSE_MUTEXES */
6683 /*-----------------------------------------------------------*/
6685 #if ( configUSE_MUTEXES == 1 )
6687 void vTaskPriorityDisinheritAfterTimeout( TaskHandle_t const pxMutexHolder,
6688 UBaseType_t uxHighestPriorityWaitingTask )
6690 TCB_t * const pxTCB = pxMutexHolder;
6691 UBaseType_t uxPriorityUsedOnEntry, uxPriorityToUse;
6692 const UBaseType_t uxOnlyOneMutexHeld = ( UBaseType_t ) 1;
6694 traceENTER_vTaskPriorityDisinheritAfterTimeout( pxMutexHolder, uxHighestPriorityWaitingTask );
6696 if( pxMutexHolder != NULL )
6698 /* If pxMutexHolder is not NULL then the holder must hold at least
6700 configASSERT( pxTCB->uxMutexesHeld );
6702 /* Determine the priority to which the priority of the task that
6703 * holds the mutex should be set. This will be the greater of the
6704 * holding task's base priority and the priority of the highest
6705 * priority task that is waiting to obtain the mutex. */
6706 if( pxTCB->uxBasePriority < uxHighestPriorityWaitingTask )
6708 uxPriorityToUse = uxHighestPriorityWaitingTask;
6712 uxPriorityToUse = pxTCB->uxBasePriority;
6715 /* Does the priority need to change? */
6716 if( pxTCB->uxPriority != uxPriorityToUse )
6718 /* Only disinherit if no other mutexes are held. This is a
6719 * simplification in the priority inheritance implementation. If
6720 * the task that holds the mutex is also holding other mutexes then
6721 * the other mutexes may have caused the priority inheritance. */
6722 if( pxTCB->uxMutexesHeld == uxOnlyOneMutexHeld )
6724 /* If a task has timed out because it already holds the
6725 * mutex it was trying to obtain then it cannot of inherited
6726 * its own priority. */
6727 configASSERT( pxTCB != pxCurrentTCB );
6729 /* Disinherit the priority, remembering the previous
6730 * priority to facilitate determining the subject task's
6732 traceTASK_PRIORITY_DISINHERIT( pxTCB, uxPriorityToUse );
6733 uxPriorityUsedOnEntry = pxTCB->uxPriority;
6734 pxTCB->uxPriority = uxPriorityToUse;
6736 /* Only reset the event list item value if the value is not
6737 * being used for anything else. */
6738 if( ( listGET_LIST_ITEM_VALUE( &( pxTCB->xEventListItem ) ) & taskEVENT_LIST_ITEM_VALUE_IN_USE ) == 0UL )
6740 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. */
6744 mtCOVERAGE_TEST_MARKER();
6747 /* If the running task is not the task that holds the mutex
6748 * then the task that holds the mutex could be in either the
6749 * Ready, Blocked or Suspended states. Only remove the task
6750 * from its current state list if it is in the Ready state as
6751 * the task's priority is going to change and there is one
6752 * Ready list per priority. */
6753 if( listIS_CONTAINED_WITHIN( &( pxReadyTasksLists[ uxPriorityUsedOnEntry ] ), &( pxTCB->xStateListItem ) ) != pdFALSE )
6755 if( uxListRemove( &( pxTCB->xStateListItem ) ) == ( UBaseType_t ) 0 )
6757 /* It is known that the task is in its ready list so
6758 * there is no need to check again and the port level
6759 * reset macro can be called directly. */
6760 portRESET_READY_PRIORITY( pxTCB->uxPriority, uxTopReadyPriority );
6764 mtCOVERAGE_TEST_MARKER();
6767 prvAddTaskToReadyList( pxTCB );
6768 #if ( configNUMBER_OF_CORES > 1 )
6770 /* The priority of the task is dropped. Yield the core on
6771 * which the task is running. */
6772 if( taskTASK_IS_RUNNING( pxTCB ) == pdTRUE )
6774 prvYieldCore( pxTCB->xTaskRunState );
6777 #endif /* if ( configNUMBER_OF_CORES > 1 ) */
6781 mtCOVERAGE_TEST_MARKER();
6786 mtCOVERAGE_TEST_MARKER();
6791 mtCOVERAGE_TEST_MARKER();
6796 mtCOVERAGE_TEST_MARKER();
6799 traceRETURN_vTaskPriorityDisinheritAfterTimeout();
6802 #endif /* configUSE_MUTEXES */
6803 /*-----------------------------------------------------------*/
6805 #if ( configNUMBER_OF_CORES > 1 )
6807 /* If not in a critical section then yield immediately.
6808 * Otherwise set xYieldPendings to true to wait to
6809 * yield until exiting the critical section.
6811 void vTaskYieldWithinAPI( void )
6813 traceENTER_vTaskYieldWithinAPI();
6815 if( portGET_CRITICAL_NESTING_COUNT() == 0U )
6821 xYieldPendings[ portGET_CORE_ID() ] = pdTRUE;
6824 traceRETURN_vTaskYieldWithinAPI();
6826 #endif /* #if ( configNUMBER_OF_CORES > 1 ) */
6828 /*-----------------------------------------------------------*/
6830 #if ( ( portCRITICAL_NESTING_IN_TCB == 1 ) && ( configNUMBER_OF_CORES == 1 ) )
6832 void vTaskEnterCritical( void )
6834 traceENTER_vTaskEnterCritical();
6836 portDISABLE_INTERRUPTS();
6838 if( xSchedulerRunning != pdFALSE )
6840 ( pxCurrentTCB->uxCriticalNesting )++;
6842 /* This is not the interrupt safe version of the enter critical
6843 * function so assert() if it is being called from an interrupt
6844 * context. Only API functions that end in "FromISR" can be used in an
6845 * interrupt. Only assert if the critical nesting count is 1 to
6846 * protect against recursive calls if the assert function also uses a
6847 * critical section. */
6848 if( pxCurrentTCB->uxCriticalNesting == 1 )
6850 portASSERT_IF_IN_ISR();
6855 mtCOVERAGE_TEST_MARKER();
6858 traceRETURN_vTaskEnterCritical();
6861 #endif /* #if ( ( portCRITICAL_NESTING_IN_TCB == 1 ) && ( configNUMBER_OF_CORES == 1 ) ) */
6862 /*-----------------------------------------------------------*/
6864 #if ( configNUMBER_OF_CORES > 1 )
6866 void vTaskEnterCritical( void )
6868 traceENTER_vTaskEnterCritical();
6870 portDISABLE_INTERRUPTS();
6872 if( xSchedulerRunning != pdFALSE )
6874 if( portGET_CRITICAL_NESTING_COUNT() == 0U )
6876 portGET_TASK_LOCK();
6880 portINCREMENT_CRITICAL_NESTING_COUNT();
6882 /* This is not the interrupt safe version of the enter critical
6883 * function so assert() if it is being called from an interrupt
6884 * context. Only API functions that end in "FromISR" can be used in an
6885 * interrupt. Only assert if the critical nesting count is 1 to
6886 * protect against recursive calls if the assert function also uses a
6887 * critical section. */
6888 if( portGET_CRITICAL_NESTING_COUNT() == 1U )
6890 portASSERT_IF_IN_ISR();
6892 if( uxSchedulerSuspended == 0U )
6894 /* The only time there would be a problem is if this is called
6895 * before a context switch and vTaskExitCritical() is called
6896 * after pxCurrentTCB changes. Therefore this should not be
6897 * used within vTaskSwitchContext(). */
6898 prvCheckForRunStateChange();
6904 mtCOVERAGE_TEST_MARKER();
6907 traceRETURN_vTaskEnterCritical();
6910 #endif /* #if ( configNUMBER_OF_CORES > 1 ) */
6912 /*-----------------------------------------------------------*/
6914 #if ( configNUMBER_OF_CORES > 1 )
6916 UBaseType_t vTaskEnterCriticalFromISR( void )
6918 UBaseType_t uxSavedInterruptStatus = 0;
6920 traceENTER_vTaskEnterCriticalFromISR();
6922 if( xSchedulerRunning != pdFALSE )
6924 uxSavedInterruptStatus = portSET_INTERRUPT_MASK_FROM_ISR();
6926 if( portGET_CRITICAL_NESTING_COUNT() == 0U )
6931 portINCREMENT_CRITICAL_NESTING_COUNT();
6935 mtCOVERAGE_TEST_MARKER();
6938 traceRETURN_vTaskEnterCriticalFromISR( uxSavedInterruptStatus );
6940 return uxSavedInterruptStatus;
6943 #endif /* #if ( configNUMBER_OF_CORES > 1 ) */
6944 /*-----------------------------------------------------------*/
6946 #if ( ( portCRITICAL_NESTING_IN_TCB == 1 ) && ( configNUMBER_OF_CORES == 1 ) )
6948 void vTaskExitCritical( void )
6950 traceENTER_vTaskExitCritical();
6952 if( xSchedulerRunning != pdFALSE )
6954 /* If pxCurrentTCB->uxCriticalNesting is zero then this function
6955 * does not match a previous call to vTaskEnterCritical(). */
6956 configASSERT( pxCurrentTCB->uxCriticalNesting > 0U );
6958 /* This function should not be called in ISR. Use vTaskExitCriticalFromISR
6959 * to exit critical section from ISR. */
6960 portASSERT_IF_IN_ISR();
6962 if( pxCurrentTCB->uxCriticalNesting > 0U )
6964 ( pxCurrentTCB->uxCriticalNesting )--;
6966 if( pxCurrentTCB->uxCriticalNesting == 0U )
6968 portENABLE_INTERRUPTS();
6972 mtCOVERAGE_TEST_MARKER();
6977 mtCOVERAGE_TEST_MARKER();
6982 mtCOVERAGE_TEST_MARKER();
6985 traceRETURN_vTaskExitCritical();
6988 #endif /* #if ( ( portCRITICAL_NESTING_IN_TCB == 1 ) && ( configNUMBER_OF_CORES == 1 ) ) */
6989 /*-----------------------------------------------------------*/
6991 #if ( configNUMBER_OF_CORES > 1 )
6993 void vTaskExitCritical( void )
6995 traceENTER_vTaskExitCritical();
6997 if( xSchedulerRunning != pdFALSE )
6999 /* If critical nesting count is zero then this function
7000 * does not match a previous call to vTaskEnterCritical(). */
7001 configASSERT( portGET_CRITICAL_NESTING_COUNT() > 0U );
7003 /* This function should not be called in ISR. Use vTaskExitCriticalFromISR
7004 * to exit critical section from ISR. */
7005 portASSERT_IF_IN_ISR();
7007 if( portGET_CRITICAL_NESTING_COUNT() > 0U )
7009 portDECREMENT_CRITICAL_NESTING_COUNT();
7011 if( portGET_CRITICAL_NESTING_COUNT() == 0U )
7013 BaseType_t xYieldCurrentTask;
7015 /* Get the xYieldPending stats inside the critical section. */
7016 xYieldCurrentTask = xYieldPendings[ portGET_CORE_ID() ];
7018 portRELEASE_ISR_LOCK();
7019 portRELEASE_TASK_LOCK();
7020 portENABLE_INTERRUPTS();
7022 /* When a task yields in a critical section it just sets
7023 * xYieldPending to true. So now that we have exited the
7024 * critical section check if xYieldPending is true, and
7026 if( xYieldCurrentTask != pdFALSE )
7033 mtCOVERAGE_TEST_MARKER();
7038 mtCOVERAGE_TEST_MARKER();
7043 mtCOVERAGE_TEST_MARKER();
7046 traceRETURN_vTaskExitCritical();
7049 #endif /* #if ( configNUMBER_OF_CORES > 1 ) */
7050 /*-----------------------------------------------------------*/
7052 #if ( configNUMBER_OF_CORES > 1 )
7054 void vTaskExitCriticalFromISR( UBaseType_t uxSavedInterruptStatus )
7056 traceENTER_vTaskExitCriticalFromISR( uxSavedInterruptStatus );
7058 if( xSchedulerRunning != pdFALSE )
7060 /* If critical nesting count is zero then this function
7061 * does not match a previous call to vTaskEnterCritical(). */
7062 configASSERT( portGET_CRITICAL_NESTING_COUNT() > 0U );
7064 if( portGET_CRITICAL_NESTING_COUNT() > 0U )
7066 portDECREMENT_CRITICAL_NESTING_COUNT();
7068 if( portGET_CRITICAL_NESTING_COUNT() == 0U )
7070 portRELEASE_ISR_LOCK();
7071 portCLEAR_INTERRUPT_MASK_FROM_ISR( uxSavedInterruptStatus );
7075 mtCOVERAGE_TEST_MARKER();
7080 mtCOVERAGE_TEST_MARKER();
7085 mtCOVERAGE_TEST_MARKER();
7088 traceRETURN_vTaskExitCriticalFromISR();
7091 #endif /* #if ( configNUMBER_OF_CORES > 1 ) */
7092 /*-----------------------------------------------------------*/
7094 #if ( configUSE_STATS_FORMATTING_FUNCTIONS > 0 )
7096 static char * prvWriteNameToBuffer( char * pcBuffer,
7097 const char * pcTaskName )
7101 /* Start by copying the entire string. */
7102 ( void ) strcpy( pcBuffer, pcTaskName );
7104 /* Pad the end of the string with spaces to ensure columns line up when
7106 for( x = strlen( pcBuffer ); x < ( size_t ) ( ( size_t ) configMAX_TASK_NAME_LEN - 1U ); x++ )
7108 pcBuffer[ x ] = ' ';
7112 pcBuffer[ x ] = ( char ) 0x00;
7114 /* Return the new end of string. */
7115 return &( pcBuffer[ x ] );
7118 #endif /* ( configUSE_STATS_FORMATTING_FUNCTIONS > 0 ) */
7119 /*-----------------------------------------------------------*/
7121 #if ( ( configUSE_TRACE_FACILITY == 1 ) && ( configUSE_STATS_FORMATTING_FUNCTIONS > 0 ) )
7123 void vTaskListTasks( char * pcWriteBuffer,
7124 size_t uxBufferLength )
7126 TaskStatus_t * pxTaskStatusArray;
7127 size_t uxConsumedBufferLength = 0;
7128 size_t uxCharsWrittenBySnprintf;
7129 int iSnprintfReturnValue;
7130 BaseType_t xOutputBufferFull = pdFALSE;
7131 UBaseType_t uxArraySize, x;
7134 traceENTER_vTaskListTasks( pcWriteBuffer, uxBufferLength );
7139 * This function is provided for convenience only, and is used by many
7140 * of the demo applications. Do not consider it to be part of the
7143 * vTaskListTasks() calls uxTaskGetSystemState(), then formats part of the
7144 * uxTaskGetSystemState() output into a human readable table that
7145 * displays task: names, states, priority, stack usage and task number.
7146 * Stack usage specified as the number of unused StackType_t words stack can hold
7147 * on top of stack - not the number of bytes.
7149 * vTaskListTasks() has a dependency on the snprintf() C library function that
7150 * might bloat the code size, use a lot of stack, and provide different
7151 * results on different platforms. An alternative, tiny, third party,
7152 * and limited functionality implementation of snprintf() is provided in
7153 * many of the FreeRTOS/Demo sub-directories in a file called
7154 * printf-stdarg.c (note printf-stdarg.c does not provide a full
7155 * snprintf() implementation!).
7157 * It is recommended that production systems call uxTaskGetSystemState()
7158 * directly to get access to raw stats data, rather than indirectly
7159 * through a call to vTaskListTasks().
7163 /* Make sure the write buffer does not contain a string. */
7164 *pcWriteBuffer = ( char ) 0x00;
7166 /* Take a snapshot of the number of tasks in case it changes while this
7167 * function is executing. */
7168 uxArraySize = uxCurrentNumberOfTasks;
7170 /* Allocate an array index for each task. NOTE! if
7171 * configSUPPORT_DYNAMIC_ALLOCATION is set to 0 then pvPortMalloc() will
7172 * equate to NULL. */
7173 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. */
7175 if( pxTaskStatusArray != NULL )
7177 /* Generate the (binary) data. */
7178 uxArraySize = uxTaskGetSystemState( pxTaskStatusArray, uxArraySize, NULL );
7180 /* Create a human readable table from the binary data. */
7181 for( x = 0; ( x < uxArraySize ) && ( xOutputBufferFull == pdFALSE ); x++ )
7183 switch( pxTaskStatusArray[ x ].eCurrentState )
7186 cStatus = tskRUNNING_CHAR;
7190 cStatus = tskREADY_CHAR;
7194 cStatus = tskBLOCKED_CHAR;
7198 cStatus = tskSUSPENDED_CHAR;
7202 cStatus = tskDELETED_CHAR;
7205 case eInvalid: /* Fall through. */
7206 default: /* Should not get here, but it is included
7207 * to prevent static checking errors. */
7208 cStatus = ( char ) 0x00;
7212 /* Is there enough space in the buffer to hold task name? */
7213 if( ( uxConsumedBufferLength + configMAX_TASK_NAME_LEN ) <= uxBufferLength )
7215 /* Write the task name to the string, padding with spaces so it
7216 * can be printed in tabular form more easily. */
7217 pcWriteBuffer = prvWriteNameToBuffer( pcWriteBuffer, pxTaskStatusArray[ x ].pcTaskName );
7218 /* Do not count the terminating null character. */
7219 uxConsumedBufferLength = uxConsumedBufferLength + ( configMAX_TASK_NAME_LEN - 1 );
7221 /* Is there space left in the buffer? -1 is done because snprintf
7222 * writes a terminating null character. So we are essentially
7223 * checking if the buffer has space to write at least one non-null
7225 if( uxConsumedBufferLength < ( uxBufferLength - 1 ) )
7227 /* Write the rest of the string. */
7228 iSnprintfReturnValue = snprintf( pcWriteBuffer,
7229 uxBufferLength - uxConsumedBufferLength,
7230 "\t%c\t%u\t%u\t%u\r\n",
7232 ( unsigned int ) pxTaskStatusArray[ x ].uxCurrentPriority,
7233 ( unsigned int ) pxTaskStatusArray[ x ].usStackHighWaterMark,
7234 ( 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. */
7235 uxCharsWrittenBySnprintf = prvSnprintfReturnValueToCharsWritten( iSnprintfReturnValue, uxBufferLength - uxConsumedBufferLength );
7237 uxConsumedBufferLength += uxCharsWrittenBySnprintf;
7238 pcWriteBuffer += uxCharsWrittenBySnprintf; /*lint !e9016 Pointer arithmetic ok on char pointers especially as in this case where it best denotes the intent of the code. */
7242 xOutputBufferFull = pdTRUE;
7247 xOutputBufferFull = pdTRUE;
7251 /* Free the array again. NOTE! If configSUPPORT_DYNAMIC_ALLOCATION
7252 * is 0 then vPortFree() will be #defined to nothing. */
7253 vPortFree( pxTaskStatusArray );
7257 mtCOVERAGE_TEST_MARKER();
7260 traceRETURN_vTaskListTasks();
7263 #endif /* ( ( configUSE_TRACE_FACILITY == 1 ) && ( configUSE_STATS_FORMATTING_FUNCTIONS > 0 ) ) */
7264 /*----------------------------------------------------------*/
7266 #if ( ( configGENERATE_RUN_TIME_STATS == 1 ) && ( configUSE_STATS_FORMATTING_FUNCTIONS > 0 ) && ( configUSE_TRACE_FACILITY == 1 ) )
7268 void vTaskGetRunTimeStatistics( char * pcWriteBuffer,
7269 size_t uxBufferLength )
7271 TaskStatus_t * pxTaskStatusArray;
7272 size_t uxConsumedBufferLength = 0;
7273 size_t uxCharsWrittenBySnprintf;
7274 int iSnprintfReturnValue;
7275 BaseType_t xOutputBufferFull = pdFALSE;
7276 UBaseType_t uxArraySize, x;
7277 configRUN_TIME_COUNTER_TYPE ulTotalTime, ulStatsAsPercentage;
7279 traceENTER_vTaskGetRunTimeStatistics( pcWriteBuffer, uxBufferLength );
7284 * This function is provided for convenience only, and is used by many
7285 * of the demo applications. Do not consider it to be part of the
7288 * vTaskGetRunTimeStatistics() calls uxTaskGetSystemState(), then formats part
7289 * of the uxTaskGetSystemState() output into a human readable table that
7290 * displays the amount of time each task has spent in the Running state
7291 * in both absolute and percentage terms.
7293 * vTaskGetRunTimeStatistics() has a dependency on the snprintf() C library
7294 * function that might bloat the code size, use a lot of stack, and
7295 * provide different results on different platforms. An alternative,
7296 * tiny, third party, and limited functionality implementation of
7297 * snprintf() is provided in many of the FreeRTOS/Demo sub-directories in
7298 * a file called printf-stdarg.c (note printf-stdarg.c does not provide
7299 * a full snprintf() implementation!).
7301 * It is recommended that production systems call uxTaskGetSystemState()
7302 * directly to get access to raw stats data, rather than indirectly
7303 * through a call to vTaskGetRunTimeStatistics().
7306 /* Make sure the write buffer does not contain a string. */
7307 *pcWriteBuffer = ( char ) 0x00;
7309 /* Take a snapshot of the number of tasks in case it changes while this
7310 * function is executing. */
7311 uxArraySize = uxCurrentNumberOfTasks;
7313 /* Allocate an array index for each task. NOTE! If
7314 * configSUPPORT_DYNAMIC_ALLOCATION is set to 0 then pvPortMalloc() will
7315 * equate to NULL. */
7316 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. */
7318 if( pxTaskStatusArray != NULL )
7320 /* Generate the (binary) data. */
7321 uxArraySize = uxTaskGetSystemState( pxTaskStatusArray, uxArraySize, &ulTotalTime );
7323 /* For percentage calculations. */
7324 ulTotalTime /= 100UL;
7326 /* Avoid divide by zero errors. */
7327 if( ulTotalTime > 0UL )
7329 /* Create a human readable table from the binary data. */
7330 for( x = 0; ( x < uxArraySize ) && ( xOutputBufferFull == pdFALSE ); x++ )
7332 /* What percentage of the total run time has the task used?
7333 * This will always be rounded down to the nearest integer.
7334 * ulTotalRunTime has already been divided by 100. */
7335 ulStatsAsPercentage = pxTaskStatusArray[ x ].ulRunTimeCounter / ulTotalTime;
7337 /* Is there enough space in the buffer to hold task name? */
7338 if( ( uxConsumedBufferLength + configMAX_TASK_NAME_LEN ) <= uxBufferLength )
7340 /* Write the task name to the string, padding with
7341 * spaces so it can be printed in tabular form more
7343 pcWriteBuffer = prvWriteNameToBuffer( pcWriteBuffer, pxTaskStatusArray[ x ].pcTaskName );
7344 /* Do not count the terminating null character. */
7345 uxConsumedBufferLength = uxConsumedBufferLength + ( configMAX_TASK_NAME_LEN - 1 );
7347 /* Is there space left in the buffer? -1 is done because snprintf
7348 * writes a terminating null character. So we are essentially
7349 * checking if the buffer has space to write at least one non-null
7351 if( uxConsumedBufferLength < ( uxBufferLength - 1 ) )
7353 if( ulStatsAsPercentage > 0UL )
7355 #ifdef portLU_PRINTF_SPECIFIER_REQUIRED
7357 iSnprintfReturnValue = snprintf( pcWriteBuffer,
7358 uxBufferLength - uxConsumedBufferLength,
7359 "\t%lu\t\t%lu%%\r\n",
7360 pxTaskStatusArray[ x ].ulRunTimeCounter,
7361 ulStatsAsPercentage );
7365 /* sizeof( int ) == sizeof( long ) so a smaller
7366 * printf() library can be used. */
7367 iSnprintfReturnValue = snprintf( pcWriteBuffer,
7368 uxBufferLength - uxConsumedBufferLength,
7370 ( unsigned int ) pxTaskStatusArray[ x ].ulRunTimeCounter,
7371 ( 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. */
7373 #endif /* ifdef portLU_PRINTF_SPECIFIER_REQUIRED */
7377 /* If the percentage is zero here then the task has
7378 * consumed less than 1% of the total run time. */
7379 #ifdef portLU_PRINTF_SPECIFIER_REQUIRED
7381 iSnprintfReturnValue = snprintf( pcWriteBuffer,
7382 uxBufferLength - uxConsumedBufferLength,
7383 "\t%lu\t\t<1%%\r\n",
7384 pxTaskStatusArray[ x ].ulRunTimeCounter );
7388 /* sizeof( int ) == sizeof( long ) so a smaller
7389 * printf() library can be used. */
7390 iSnprintfReturnValue = snprintf( pcWriteBuffer,
7391 uxBufferLength - uxConsumedBufferLength,
7393 ( 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. */
7395 #endif /* ifdef portLU_PRINTF_SPECIFIER_REQUIRED */
7398 uxCharsWrittenBySnprintf = prvSnprintfReturnValueToCharsWritten( iSnprintfReturnValue, uxBufferLength - uxConsumedBufferLength );
7399 uxConsumedBufferLength += uxCharsWrittenBySnprintf;
7400 pcWriteBuffer += uxCharsWrittenBySnprintf; /*lint !e9016 Pointer arithmetic ok on char pointers especially as in this case where it best denotes the intent of the code. */
7404 xOutputBufferFull = pdTRUE;
7409 xOutputBufferFull = pdTRUE;
7415 mtCOVERAGE_TEST_MARKER();
7418 /* Free the array again. NOTE! If configSUPPORT_DYNAMIC_ALLOCATION
7419 * is 0 then vPortFree() will be #defined to nothing. */
7420 vPortFree( pxTaskStatusArray );
7424 mtCOVERAGE_TEST_MARKER();
7427 traceRETURN_vTaskGetRunTimeStatistics();
7430 #endif /* ( ( configGENERATE_RUN_TIME_STATS == 1 ) && ( configUSE_STATS_FORMATTING_FUNCTIONS > 0 ) ) */
7431 /*-----------------------------------------------------------*/
7433 TickType_t uxTaskResetEventItemValue( void )
7435 TickType_t uxReturn;
7437 traceENTER_uxTaskResetEventItemValue();
7439 uxReturn = listGET_LIST_ITEM_VALUE( &( pxCurrentTCB->xEventListItem ) );
7441 /* Reset the event list item to its normal value - so it can be used with
7442 * queues and semaphores. */
7443 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. */
7445 traceRETURN_uxTaskResetEventItemValue( uxReturn );
7449 /*-----------------------------------------------------------*/
7451 #if ( configUSE_MUTEXES == 1 )
7453 TaskHandle_t pvTaskIncrementMutexHeldCount( void )
7457 traceENTER_pvTaskIncrementMutexHeldCount();
7459 pxTCB = pxCurrentTCB;
7461 /* If xSemaphoreCreateMutex() is called before any tasks have been created
7462 * then pxCurrentTCB will be NULL. */
7465 ( pxTCB->uxMutexesHeld )++;
7468 traceRETURN_pvTaskIncrementMutexHeldCount( pxTCB );
7473 #endif /* configUSE_MUTEXES */
7474 /*-----------------------------------------------------------*/
7476 #if ( configUSE_TASK_NOTIFICATIONS == 1 )
7478 uint32_t ulTaskGenericNotifyTake( UBaseType_t uxIndexToWaitOn,
7479 BaseType_t xClearCountOnExit,
7480 TickType_t xTicksToWait )
7484 traceENTER_ulTaskGenericNotifyTake( uxIndexToWaitOn, xClearCountOnExit, xTicksToWait );
7486 configASSERT( uxIndexToWaitOn < configTASK_NOTIFICATION_ARRAY_ENTRIES );
7488 taskENTER_CRITICAL();
7490 /* Only block if the notification count is not already non-zero. */
7491 if( pxCurrentTCB->ulNotifiedValue[ uxIndexToWaitOn ] == 0UL )
7493 /* Mark this task as waiting for a notification. */
7494 pxCurrentTCB->ucNotifyState[ uxIndexToWaitOn ] = taskWAITING_NOTIFICATION;
7496 if( xTicksToWait > ( TickType_t ) 0 )
7498 prvAddCurrentTaskToDelayedList( xTicksToWait, pdTRUE );
7499 traceTASK_NOTIFY_TAKE_BLOCK( uxIndexToWaitOn );
7501 /* All ports are written to allow a yield in a critical
7502 * section (some will yield immediately, others wait until the
7503 * critical section exits) - but it is not something that
7504 * application code should ever do. */
7505 taskYIELD_WITHIN_API();
7509 mtCOVERAGE_TEST_MARKER();
7514 mtCOVERAGE_TEST_MARKER();
7517 taskEXIT_CRITICAL();
7519 taskENTER_CRITICAL();
7521 traceTASK_NOTIFY_TAKE( uxIndexToWaitOn );
7522 ulReturn = pxCurrentTCB->ulNotifiedValue[ uxIndexToWaitOn ];
7524 if( ulReturn != 0UL )
7526 if( xClearCountOnExit != pdFALSE )
7528 pxCurrentTCB->ulNotifiedValue[ uxIndexToWaitOn ] = 0UL;
7532 pxCurrentTCB->ulNotifiedValue[ uxIndexToWaitOn ] = ulReturn - ( uint32_t ) 1;
7537 mtCOVERAGE_TEST_MARKER();
7540 pxCurrentTCB->ucNotifyState[ uxIndexToWaitOn ] = taskNOT_WAITING_NOTIFICATION;
7542 taskEXIT_CRITICAL();
7544 traceRETURN_ulTaskGenericNotifyTake( ulReturn );
7549 #endif /* configUSE_TASK_NOTIFICATIONS */
7550 /*-----------------------------------------------------------*/
7552 #if ( configUSE_TASK_NOTIFICATIONS == 1 )
7554 BaseType_t xTaskGenericNotifyWait( UBaseType_t uxIndexToWaitOn,
7555 uint32_t ulBitsToClearOnEntry,
7556 uint32_t ulBitsToClearOnExit,
7557 uint32_t * pulNotificationValue,
7558 TickType_t xTicksToWait )
7562 traceENTER_xTaskGenericNotifyWait( uxIndexToWaitOn, ulBitsToClearOnEntry, ulBitsToClearOnExit, pulNotificationValue, xTicksToWait );
7564 configASSERT( uxIndexToWaitOn < configTASK_NOTIFICATION_ARRAY_ENTRIES );
7566 taskENTER_CRITICAL();
7568 /* Only block if a notification is not already pending. */
7569 if( pxCurrentTCB->ucNotifyState[ uxIndexToWaitOn ] != taskNOTIFICATION_RECEIVED )
7571 /* Clear bits in the task's notification value as bits may get
7572 * set by the notifying task or interrupt. This can be used to
7573 * clear the value to zero. */
7574 pxCurrentTCB->ulNotifiedValue[ uxIndexToWaitOn ] &= ~ulBitsToClearOnEntry;
7576 /* Mark this task as waiting for a notification. */
7577 pxCurrentTCB->ucNotifyState[ uxIndexToWaitOn ] = taskWAITING_NOTIFICATION;
7579 if( xTicksToWait > ( TickType_t ) 0 )
7581 prvAddCurrentTaskToDelayedList( xTicksToWait, pdTRUE );
7582 traceTASK_NOTIFY_WAIT_BLOCK( uxIndexToWaitOn );
7584 /* All ports are written to allow a yield in a critical
7585 * section (some will yield immediately, others wait until the
7586 * critical section exits) - but it is not something that
7587 * application code should ever do. */
7588 taskYIELD_WITHIN_API();
7592 mtCOVERAGE_TEST_MARKER();
7597 mtCOVERAGE_TEST_MARKER();
7600 taskEXIT_CRITICAL();
7602 taskENTER_CRITICAL();
7604 traceTASK_NOTIFY_WAIT( uxIndexToWaitOn );
7606 if( pulNotificationValue != NULL )
7608 /* Output the current notification value, which may or may not
7610 *pulNotificationValue = pxCurrentTCB->ulNotifiedValue[ uxIndexToWaitOn ];
7613 /* If ucNotifyValue is set then either the task never entered the
7614 * blocked state (because a notification was already pending) or the
7615 * task unblocked because of a notification. Otherwise the task
7616 * unblocked because of a timeout. */
7617 if( pxCurrentTCB->ucNotifyState[ uxIndexToWaitOn ] != taskNOTIFICATION_RECEIVED )
7619 /* A notification was not received. */
7624 /* A notification was already pending or a notification was
7625 * received while the task was waiting. */
7626 pxCurrentTCB->ulNotifiedValue[ uxIndexToWaitOn ] &= ~ulBitsToClearOnExit;
7630 pxCurrentTCB->ucNotifyState[ uxIndexToWaitOn ] = taskNOT_WAITING_NOTIFICATION;
7632 taskEXIT_CRITICAL();
7634 traceRETURN_xTaskGenericNotifyWait( xReturn );
7639 #endif /* configUSE_TASK_NOTIFICATIONS */
7640 /*-----------------------------------------------------------*/
7642 #if ( configUSE_TASK_NOTIFICATIONS == 1 )
7644 BaseType_t xTaskGenericNotify( TaskHandle_t xTaskToNotify,
7645 UBaseType_t uxIndexToNotify,
7647 eNotifyAction eAction,
7648 uint32_t * pulPreviousNotificationValue )
7651 BaseType_t xReturn = pdPASS;
7652 uint8_t ucOriginalNotifyState;
7654 traceENTER_xTaskGenericNotify( xTaskToNotify, uxIndexToNotify, ulValue, eAction, pulPreviousNotificationValue );
7656 configASSERT( uxIndexToNotify < configTASK_NOTIFICATION_ARRAY_ENTRIES );
7657 configASSERT( xTaskToNotify );
7658 pxTCB = xTaskToNotify;
7660 taskENTER_CRITICAL();
7662 if( pulPreviousNotificationValue != NULL )
7664 *pulPreviousNotificationValue = pxTCB->ulNotifiedValue[ uxIndexToNotify ];
7667 ucOriginalNotifyState = pxTCB->ucNotifyState[ uxIndexToNotify ];
7669 pxTCB->ucNotifyState[ uxIndexToNotify ] = taskNOTIFICATION_RECEIVED;
7674 pxTCB->ulNotifiedValue[ uxIndexToNotify ] |= ulValue;
7678 ( pxTCB->ulNotifiedValue[ uxIndexToNotify ] )++;
7681 case eSetValueWithOverwrite:
7682 pxTCB->ulNotifiedValue[ uxIndexToNotify ] = ulValue;
7685 case eSetValueWithoutOverwrite:
7687 if( ucOriginalNotifyState != taskNOTIFICATION_RECEIVED )
7689 pxTCB->ulNotifiedValue[ uxIndexToNotify ] = ulValue;
7693 /* The value could not be written to the task. */
7701 /* The task is being notified without its notify value being
7707 /* Should not get here if all enums are handled.
7708 * Artificially force an assert by testing a value the
7709 * compiler can't assume is const. */
7710 configASSERT( xTickCount == ( TickType_t ) 0 );
7715 traceTASK_NOTIFY( uxIndexToNotify );
7717 /* If the task is in the blocked state specifically to wait for a
7718 * notification then unblock it now. */
7719 if( ucOriginalNotifyState == taskWAITING_NOTIFICATION )
7721 listREMOVE_ITEM( &( pxTCB->xStateListItem ) );
7722 prvAddTaskToReadyList( pxTCB );
7724 /* The task should not have been on an event list. */
7725 configASSERT( listLIST_ITEM_CONTAINER( &( pxTCB->xEventListItem ) ) == NULL );
7727 #if ( configUSE_TICKLESS_IDLE != 0 )
7729 /* If a task is blocked waiting for a notification then
7730 * xNextTaskUnblockTime might be set to the blocked task's time
7731 * out time. If the task is unblocked for a reason other than
7732 * a timeout xNextTaskUnblockTime is normally left unchanged,
7733 * because it will automatically get reset to a new value when
7734 * the tick count equals xNextTaskUnblockTime. However if
7735 * tickless idling is used it might be more important to enter
7736 * sleep mode at the earliest possible time - so reset
7737 * xNextTaskUnblockTime here to ensure it is updated at the
7738 * earliest possible time. */
7739 prvResetNextTaskUnblockTime();
7743 /* Check if the notified task has a priority above the currently
7744 * executing task. */
7745 taskYIELD_ANY_CORE_IF_USING_PREEMPTION( pxTCB );
7749 mtCOVERAGE_TEST_MARKER();
7752 taskEXIT_CRITICAL();
7754 traceRETURN_xTaskGenericNotify( xReturn );
7759 #endif /* configUSE_TASK_NOTIFICATIONS */
7760 /*-----------------------------------------------------------*/
7762 #if ( configUSE_TASK_NOTIFICATIONS == 1 )
7764 BaseType_t xTaskGenericNotifyFromISR( TaskHandle_t xTaskToNotify,
7765 UBaseType_t uxIndexToNotify,
7767 eNotifyAction eAction,
7768 uint32_t * pulPreviousNotificationValue,
7769 BaseType_t * pxHigherPriorityTaskWoken )
7772 uint8_t ucOriginalNotifyState;
7773 BaseType_t xReturn = pdPASS;
7774 UBaseType_t uxSavedInterruptStatus;
7776 traceENTER_xTaskGenericNotifyFromISR( xTaskToNotify, uxIndexToNotify, ulValue, eAction, pulPreviousNotificationValue, pxHigherPriorityTaskWoken );
7778 configASSERT( xTaskToNotify );
7779 configASSERT( uxIndexToNotify < configTASK_NOTIFICATION_ARRAY_ENTRIES );
7781 /* RTOS ports that support interrupt nesting have the concept of a
7782 * maximum system call (or maximum API call) interrupt priority.
7783 * Interrupts that are above the maximum system call priority are keep
7784 * permanently enabled, even when the RTOS kernel is in a critical section,
7785 * but cannot make any calls to FreeRTOS API functions. If configASSERT()
7786 * is defined in FreeRTOSConfig.h then
7787 * portASSERT_IF_INTERRUPT_PRIORITY_INVALID() will result in an assertion
7788 * failure if a FreeRTOS API function is called from an interrupt that has
7789 * been assigned a priority above the configured maximum system call
7790 * priority. Only FreeRTOS functions that end in FromISR can be called
7791 * from interrupts that have been assigned a priority at or (logically)
7792 * below the maximum system call interrupt priority. FreeRTOS maintains a
7793 * separate interrupt safe API to ensure interrupt entry is as fast and as
7794 * simple as possible. More information (albeit Cortex-M specific) is
7795 * provided on the following link:
7796 * https://www.FreeRTOS.org/RTOS-Cortex-M3-M4.html */
7797 portASSERT_IF_INTERRUPT_PRIORITY_INVALID();
7799 pxTCB = xTaskToNotify;
7801 uxSavedInterruptStatus = taskENTER_CRITICAL_FROM_ISR();
7803 if( pulPreviousNotificationValue != NULL )
7805 *pulPreviousNotificationValue = pxTCB->ulNotifiedValue[ uxIndexToNotify ];
7808 ucOriginalNotifyState = pxTCB->ucNotifyState[ uxIndexToNotify ];
7809 pxTCB->ucNotifyState[ uxIndexToNotify ] = taskNOTIFICATION_RECEIVED;
7814 pxTCB->ulNotifiedValue[ uxIndexToNotify ] |= ulValue;
7818 ( pxTCB->ulNotifiedValue[ uxIndexToNotify ] )++;
7821 case eSetValueWithOverwrite:
7822 pxTCB->ulNotifiedValue[ uxIndexToNotify ] = ulValue;
7825 case eSetValueWithoutOverwrite:
7827 if( ucOriginalNotifyState != taskNOTIFICATION_RECEIVED )
7829 pxTCB->ulNotifiedValue[ uxIndexToNotify ] = ulValue;
7833 /* The value could not be written to the task. */
7841 /* The task is being notified without its notify value being
7847 /* Should not get here if all enums are handled.
7848 * Artificially force an assert by testing a value the
7849 * compiler can't assume is const. */
7850 configASSERT( xTickCount == ( TickType_t ) 0 );
7854 traceTASK_NOTIFY_FROM_ISR( uxIndexToNotify );
7856 /* If the task is in the blocked state specifically to wait for a
7857 * notification then unblock it now. */
7858 if( ucOriginalNotifyState == taskWAITING_NOTIFICATION )
7860 /* The task should not have been on an event list. */
7861 configASSERT( listLIST_ITEM_CONTAINER( &( pxTCB->xEventListItem ) ) == NULL );
7863 if( uxSchedulerSuspended == ( UBaseType_t ) 0U )
7865 listREMOVE_ITEM( &( pxTCB->xStateListItem ) );
7866 prvAddTaskToReadyList( pxTCB );
7870 /* The delayed and ready lists cannot be accessed, so hold
7871 * this task pending until the scheduler is resumed. */
7872 listINSERT_END( &( xPendingReadyList ), &( pxTCB->xEventListItem ) );
7875 #if ( configNUMBER_OF_CORES == 1 )
7877 if( pxTCB->uxPriority > pxCurrentTCB->uxPriority )
7879 /* The notified task has a priority above the currently
7880 * executing task so a yield is required. */
7881 if( pxHigherPriorityTaskWoken != NULL )
7883 *pxHigherPriorityTaskWoken = pdTRUE;
7886 /* Mark that a yield is pending in case the user is not
7887 * using the "xHigherPriorityTaskWoken" parameter to an ISR
7888 * safe FreeRTOS function. */
7889 xYieldPendings[ 0 ] = pdTRUE;
7893 mtCOVERAGE_TEST_MARKER();
7896 #else /* #if ( configNUMBER_OF_CORES == 1 ) */
7898 #if ( configUSE_PREEMPTION == 1 )
7900 prvYieldForTask( pxTCB );
7902 if( xYieldPendings[ portGET_CORE_ID() ] == pdTRUE )
7904 if( pxHigherPriorityTaskWoken != NULL )
7906 *pxHigherPriorityTaskWoken = pdTRUE;
7910 #endif /* if ( configUSE_PREEMPTION == 1 ) */
7912 #endif /* #if ( configNUMBER_OF_CORES == 1 ) */
7915 taskEXIT_CRITICAL_FROM_ISR( uxSavedInterruptStatus );
7917 traceRETURN_xTaskGenericNotifyFromISR( xReturn );
7922 #endif /* configUSE_TASK_NOTIFICATIONS */
7923 /*-----------------------------------------------------------*/
7925 #if ( configUSE_TASK_NOTIFICATIONS == 1 )
7927 void vTaskGenericNotifyGiveFromISR( TaskHandle_t xTaskToNotify,
7928 UBaseType_t uxIndexToNotify,
7929 BaseType_t * pxHigherPriorityTaskWoken )
7932 uint8_t ucOriginalNotifyState;
7933 UBaseType_t uxSavedInterruptStatus;
7935 traceENTER_vTaskGenericNotifyGiveFromISR( xTaskToNotify, uxIndexToNotify, pxHigherPriorityTaskWoken );
7937 configASSERT( xTaskToNotify );
7938 configASSERT( uxIndexToNotify < configTASK_NOTIFICATION_ARRAY_ENTRIES );
7940 /* RTOS ports that support interrupt nesting have the concept of a
7941 * maximum system call (or maximum API call) interrupt priority.
7942 * Interrupts that are above the maximum system call priority are keep
7943 * permanently enabled, even when the RTOS kernel is in a critical section,
7944 * but cannot make any calls to FreeRTOS API functions. If configASSERT()
7945 * is defined in FreeRTOSConfig.h then
7946 * portASSERT_IF_INTERRUPT_PRIORITY_INVALID() will result in an assertion
7947 * failure if a FreeRTOS API function is called from an interrupt that has
7948 * been assigned a priority above the configured maximum system call
7949 * priority. Only FreeRTOS functions that end in FromISR can be called
7950 * from interrupts that have been assigned a priority at or (logically)
7951 * below the maximum system call interrupt priority. FreeRTOS maintains a
7952 * separate interrupt safe API to ensure interrupt entry is as fast and as
7953 * simple as possible. More information (albeit Cortex-M specific) is
7954 * provided on the following link:
7955 * https://www.FreeRTOS.org/RTOS-Cortex-M3-M4.html */
7956 portASSERT_IF_INTERRUPT_PRIORITY_INVALID();
7958 pxTCB = xTaskToNotify;
7960 uxSavedInterruptStatus = taskENTER_CRITICAL_FROM_ISR();
7962 ucOriginalNotifyState = pxTCB->ucNotifyState[ uxIndexToNotify ];
7963 pxTCB->ucNotifyState[ uxIndexToNotify ] = taskNOTIFICATION_RECEIVED;
7965 /* 'Giving' is equivalent to incrementing a count in a counting
7967 ( pxTCB->ulNotifiedValue[ uxIndexToNotify ] )++;
7969 traceTASK_NOTIFY_GIVE_FROM_ISR( uxIndexToNotify );
7971 /* If the task is in the blocked state specifically to wait for a
7972 * notification then unblock it now. */
7973 if( ucOriginalNotifyState == taskWAITING_NOTIFICATION )
7975 /* The task should not have been on an event list. */
7976 configASSERT( listLIST_ITEM_CONTAINER( &( pxTCB->xEventListItem ) ) == NULL );
7978 if( uxSchedulerSuspended == ( UBaseType_t ) 0U )
7980 listREMOVE_ITEM( &( pxTCB->xStateListItem ) );
7981 prvAddTaskToReadyList( pxTCB );
7985 /* The delayed and ready lists cannot be accessed, so hold
7986 * this task pending until the scheduler is resumed. */
7987 listINSERT_END( &( xPendingReadyList ), &( pxTCB->xEventListItem ) );
7990 #if ( configNUMBER_OF_CORES == 1 )
7992 if( pxTCB->uxPriority > pxCurrentTCB->uxPriority )
7994 /* The notified task has a priority above the currently
7995 * executing task so a yield is required. */
7996 if( pxHigherPriorityTaskWoken != NULL )
7998 *pxHigherPriorityTaskWoken = pdTRUE;
8001 /* Mark that a yield is pending in case the user is not
8002 * using the "xHigherPriorityTaskWoken" parameter in an ISR
8003 * safe FreeRTOS function. */
8004 xYieldPendings[ 0 ] = pdTRUE;
8008 mtCOVERAGE_TEST_MARKER();
8011 #else /* #if ( configNUMBER_OF_CORES == 1 ) */
8013 #if ( configUSE_PREEMPTION == 1 )
8015 prvYieldForTask( pxTCB );
8017 if( xYieldPendings[ portGET_CORE_ID() ] == pdTRUE )
8019 if( pxHigherPriorityTaskWoken != NULL )
8021 *pxHigherPriorityTaskWoken = pdTRUE;
8025 #endif /* #if ( configUSE_PREEMPTION == 1 ) */
8027 #endif /* #if ( configNUMBER_OF_CORES == 1 ) */
8030 taskEXIT_CRITICAL_FROM_ISR( uxSavedInterruptStatus );
8032 traceRETURN_vTaskGenericNotifyGiveFromISR();
8035 #endif /* configUSE_TASK_NOTIFICATIONS */
8036 /*-----------------------------------------------------------*/
8038 #if ( configUSE_TASK_NOTIFICATIONS == 1 )
8040 BaseType_t xTaskGenericNotifyStateClear( TaskHandle_t xTask,
8041 UBaseType_t uxIndexToClear )
8046 traceENTER_xTaskGenericNotifyStateClear( xTask, uxIndexToClear );
8048 configASSERT( uxIndexToClear < configTASK_NOTIFICATION_ARRAY_ENTRIES );
8050 /* If null is passed in here then it is the calling task that is having
8051 * its notification state cleared. */
8052 pxTCB = prvGetTCBFromHandle( xTask );
8054 taskENTER_CRITICAL();
8056 if( pxTCB->ucNotifyState[ uxIndexToClear ] == taskNOTIFICATION_RECEIVED )
8058 pxTCB->ucNotifyState[ uxIndexToClear ] = taskNOT_WAITING_NOTIFICATION;
8066 taskEXIT_CRITICAL();
8068 traceRETURN_xTaskGenericNotifyStateClear( xReturn );
8073 #endif /* configUSE_TASK_NOTIFICATIONS */
8074 /*-----------------------------------------------------------*/
8076 #if ( configUSE_TASK_NOTIFICATIONS == 1 )
8078 uint32_t ulTaskGenericNotifyValueClear( TaskHandle_t xTask,
8079 UBaseType_t uxIndexToClear,
8080 uint32_t ulBitsToClear )
8085 traceENTER_ulTaskGenericNotifyValueClear( xTask, uxIndexToClear, ulBitsToClear );
8087 configASSERT( uxIndexToClear < configTASK_NOTIFICATION_ARRAY_ENTRIES );
8089 /* If null is passed in here then it is the calling task that is having
8090 * its notification state cleared. */
8091 pxTCB = prvGetTCBFromHandle( xTask );
8093 taskENTER_CRITICAL();
8095 /* Return the notification as it was before the bits were cleared,
8096 * then clear the bit mask. */
8097 ulReturn = pxTCB->ulNotifiedValue[ uxIndexToClear ];
8098 pxTCB->ulNotifiedValue[ uxIndexToClear ] &= ~ulBitsToClear;
8100 taskEXIT_CRITICAL();
8102 traceRETURN_ulTaskGenericNotifyValueClear( ulReturn );
8107 #endif /* configUSE_TASK_NOTIFICATIONS */
8108 /*-----------------------------------------------------------*/
8110 #if ( configGENERATE_RUN_TIME_STATS == 1 )
8112 configRUN_TIME_COUNTER_TYPE ulTaskGetRunTimeCounter( const TaskHandle_t xTask )
8116 traceENTER_ulTaskGetRunTimeCounter( xTask );
8118 pxTCB = prvGetTCBFromHandle( xTask );
8120 traceRETURN_ulTaskGetRunTimeCounter( pxTCB->ulRunTimeCounter );
8122 return pxTCB->ulRunTimeCounter;
8125 #endif /* if ( configGENERATE_RUN_TIME_STATS == 1 ) */
8126 /*-----------------------------------------------------------*/
8128 #if ( configGENERATE_RUN_TIME_STATS == 1 )
8130 configRUN_TIME_COUNTER_TYPE ulTaskGetRunTimePercent( const TaskHandle_t xTask )
8133 configRUN_TIME_COUNTER_TYPE ulTotalTime, ulReturn;
8135 traceENTER_ulTaskGetRunTimePercent( xTask );
8137 ulTotalTime = ( configRUN_TIME_COUNTER_TYPE ) portGET_RUN_TIME_COUNTER_VALUE();
8139 /* For percentage calculations. */
8140 ulTotalTime /= ( configRUN_TIME_COUNTER_TYPE ) 100;
8142 /* Avoid divide by zero errors. */
8143 if( ulTotalTime > ( configRUN_TIME_COUNTER_TYPE ) 0 )
8145 pxTCB = prvGetTCBFromHandle( xTask );
8146 ulReturn = pxTCB->ulRunTimeCounter / ulTotalTime;
8153 traceRETURN_ulTaskGetRunTimePercent( ulReturn );
8158 #endif /* if ( configGENERATE_RUN_TIME_STATS == 1 ) */
8159 /*-----------------------------------------------------------*/
8161 #if ( ( configGENERATE_RUN_TIME_STATS == 1 ) && ( INCLUDE_xTaskGetIdleTaskHandle == 1 ) )
8163 configRUN_TIME_COUNTER_TYPE ulTaskGetIdleRunTimeCounter( void )
8165 configRUN_TIME_COUNTER_TYPE ulReturn = 0;
8168 traceENTER_ulTaskGetIdleRunTimeCounter();
8170 for( i = 0; i < ( BaseType_t ) configNUMBER_OF_CORES; i++ )
8172 ulReturn += xIdleTaskHandles[ i ]->ulRunTimeCounter;
8175 traceRETURN_ulTaskGetIdleRunTimeCounter( ulReturn );
8180 #endif /* if ( ( configGENERATE_RUN_TIME_STATS == 1 ) && ( INCLUDE_xTaskGetIdleTaskHandle == 1 ) ) */
8181 /*-----------------------------------------------------------*/
8183 #if ( ( configGENERATE_RUN_TIME_STATS == 1 ) && ( INCLUDE_xTaskGetIdleTaskHandle == 1 ) )
8185 configRUN_TIME_COUNTER_TYPE ulTaskGetIdleRunTimePercent( void )
8187 configRUN_TIME_COUNTER_TYPE ulTotalTime, ulReturn;
8188 configRUN_TIME_COUNTER_TYPE ulRunTimeCounter = 0;
8191 traceENTER_ulTaskGetIdleRunTimePercent();
8193 ulTotalTime = portGET_RUN_TIME_COUNTER_VALUE() * configNUMBER_OF_CORES;
8195 /* For percentage calculations. */
8196 ulTotalTime /= ( configRUN_TIME_COUNTER_TYPE ) 100;
8198 /* Avoid divide by zero errors. */
8199 if( ulTotalTime > ( configRUN_TIME_COUNTER_TYPE ) 0 )
8201 for( i = 0; i < ( BaseType_t ) configNUMBER_OF_CORES; i++ )
8203 ulRunTimeCounter += xIdleTaskHandles[ i ]->ulRunTimeCounter;
8206 ulReturn = ulRunTimeCounter / ulTotalTime;
8213 traceRETURN_ulTaskGetIdleRunTimePercent( ulReturn );
8218 #endif /* if ( ( configGENERATE_RUN_TIME_STATS == 1 ) && ( INCLUDE_xTaskGetIdleTaskHandle == 1 ) ) */
8219 /*-----------------------------------------------------------*/
8221 static void prvAddCurrentTaskToDelayedList( TickType_t xTicksToWait,
8222 const BaseType_t xCanBlockIndefinitely )
8224 TickType_t xTimeToWake;
8225 const TickType_t xConstTickCount = xTickCount;
8227 #if ( INCLUDE_xTaskAbortDelay == 1 )
8229 /* About to enter a delayed list, so ensure the ucDelayAborted flag is
8230 * reset to pdFALSE so it can be detected as having been set to pdTRUE
8231 * when the task leaves the Blocked state. */
8232 pxCurrentTCB->ucDelayAborted = pdFALSE;
8236 /* Remove the task from the ready list before adding it to the blocked list
8237 * as the same list item is used for both lists. */
8238 if( uxListRemove( &( pxCurrentTCB->xStateListItem ) ) == ( UBaseType_t ) 0 )
8240 /* The current task must be in a ready list, so there is no need to
8241 * check, and the port reset macro can be called directly. */
8242 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. */
8246 mtCOVERAGE_TEST_MARKER();
8249 #if ( INCLUDE_vTaskSuspend == 1 )
8251 if( ( xTicksToWait == portMAX_DELAY ) && ( xCanBlockIndefinitely != pdFALSE ) )
8253 /* Add the task to the suspended task list instead of a delayed task
8254 * list to ensure it is not woken by a timing event. It will block
8256 listINSERT_END( &xSuspendedTaskList, &( pxCurrentTCB->xStateListItem ) );
8260 /* Calculate the time at which the task should be woken if the event
8261 * does not occur. This may overflow but this doesn't matter, the
8262 * kernel will manage it correctly. */
8263 xTimeToWake = xConstTickCount + xTicksToWait;
8265 /* The list item will be inserted in wake time order. */
8266 listSET_LIST_ITEM_VALUE( &( pxCurrentTCB->xStateListItem ), xTimeToWake );
8268 if( xTimeToWake < xConstTickCount )
8270 /* Wake time has overflowed. Place this item in the overflow
8272 traceMOVED_TASK_TO_OVERFLOW_DELAYED_LIST();
8273 vListInsert( pxOverflowDelayedTaskList, &( pxCurrentTCB->xStateListItem ) );
8277 /* The wake time has not overflowed, so the current block list
8279 traceMOVED_TASK_TO_DELAYED_LIST();
8280 vListInsert( pxDelayedTaskList, &( pxCurrentTCB->xStateListItem ) );
8282 /* If the task entering the blocked state was placed at the
8283 * head of the list of blocked tasks then xNextTaskUnblockTime
8284 * needs to be updated too. */
8285 if( xTimeToWake < xNextTaskUnblockTime )
8287 xNextTaskUnblockTime = xTimeToWake;
8291 mtCOVERAGE_TEST_MARKER();
8296 #else /* INCLUDE_vTaskSuspend */
8298 /* Calculate the time at which the task should be woken if the event
8299 * does not occur. This may overflow but this doesn't matter, the kernel
8300 * will manage it correctly. */
8301 xTimeToWake = xConstTickCount + xTicksToWait;
8303 /* The list item will be inserted in wake time order. */
8304 listSET_LIST_ITEM_VALUE( &( pxCurrentTCB->xStateListItem ), xTimeToWake );
8306 if( xTimeToWake < xConstTickCount )
8308 traceMOVED_TASK_TO_OVERFLOW_DELAYED_LIST();
8309 /* Wake time has overflowed. Place this item in the overflow list. */
8310 vListInsert( pxOverflowDelayedTaskList, &( pxCurrentTCB->xStateListItem ) );
8314 traceMOVED_TASK_TO_DELAYED_LIST();
8315 /* The wake time has not overflowed, so the current block list is used. */
8316 vListInsert( pxDelayedTaskList, &( pxCurrentTCB->xStateListItem ) );
8318 /* If the task entering the blocked state was placed at the head of the
8319 * list of blocked tasks then xNextTaskUnblockTime needs to be updated
8321 if( xTimeToWake < xNextTaskUnblockTime )
8323 xNextTaskUnblockTime = xTimeToWake;
8327 mtCOVERAGE_TEST_MARKER();
8331 /* Avoid compiler warning when INCLUDE_vTaskSuspend is not 1. */
8332 ( void ) xCanBlockIndefinitely;
8334 #endif /* INCLUDE_vTaskSuspend */
8336 /*-----------------------------------------------------------*/
8338 #if ( portUSING_MPU_WRAPPERS == 1 )
8340 xMPU_SETTINGS * xTaskGetMPUSettings( TaskHandle_t xTask )
8344 traceENTER_xTaskGetMPUSettings( xTask );
8346 pxTCB = prvGetTCBFromHandle( xTask );
8348 traceRETURN_xTaskGetMPUSettings( &( pxTCB->xMPUSettings ) );
8350 return &( pxTCB->xMPUSettings );
8353 #endif /* portUSING_MPU_WRAPPERS */
8354 /*-----------------------------------------------------------*/
8356 /* Code below here allows additional code to be inserted into this source file,
8357 * especially where access to file scope functions and data is needed (for example
8358 * when performing module tests). */
8360 #ifdef FREERTOS_MODULE_TEST
8361 #include "tasks_test_access_functions.h"
8365 #if ( configINCLUDE_FREERTOS_TASK_C_ADDITIONS_H == 1 )
8367 #include "freertos_tasks_c_additions.h"
8369 #ifdef FREERTOS_TASKS_C_ADDITIONS_INIT
8370 static void freertos_tasks_c_additions_init( void )
8372 FREERTOS_TASKS_C_ADDITIONS_INIT();
8376 #endif /* if ( configINCLUDE_FREERTOS_TASK_C_ADDITIONS_H == 1 ) */
8377 /*-----------------------------------------------------------*/
8379 #if ( ( configSUPPORT_STATIC_ALLOCATION == 1 ) && ( configKERNEL_PROVIDED_STATIC_MEMORY == 1 ) && ( portUSING_MPU_WRAPPERS == 0 ) )
8382 * This is the kernel provided implementation of vApplicationGetIdleTaskMemory()
8383 * to provide the memory that is used by the Idle task. It is used when
8384 * configKERNEL_PROVIDED_STATIC_MEMORY is set to 1. The application can provide
8385 * it's own implementation of vApplicationGetIdleTaskMemory by setting
8386 * configKERNEL_PROVIDED_STATIC_MEMORY to 0 or leaving it undefined.
8388 #if ( configNUMBER_OF_CORES == 1 )
8390 void vApplicationGetIdleTaskMemory( StaticTask_t ** ppxIdleTaskTCBBuffer,
8391 StackType_t ** ppxIdleTaskStackBuffer,
8392 uint32_t * pulIdleTaskStackSize )
8394 static StaticTask_t xIdleTaskTCB;
8395 static StackType_t uxIdleTaskStack[ configMINIMAL_STACK_SIZE ];
8397 *ppxIdleTaskTCBBuffer = &( xIdleTaskTCB );
8398 *ppxIdleTaskStackBuffer = &( uxIdleTaskStack[ 0 ] );
8399 *pulIdleTaskStackSize = configMINIMAL_STACK_SIZE;
8402 #else /* #if ( configNUMBER_OF_CORES == 1 ) */
8404 void vApplicationGetIdleTaskMemory( StaticTask_t ** ppxIdleTaskTCBBuffer,
8405 StackType_t ** ppxIdleTaskStackBuffer,
8406 uint32_t * pulIdleTaskStackSize,
8407 BaseType_t xCoreId )
8409 static StaticTask_t xIdleTaskTCBs[ configNUMBER_OF_CORES ];
8410 static StackType_t uxIdleTaskStacks[ configNUMBER_OF_CORES ][ configMINIMAL_STACK_SIZE ];
8412 *ppxIdleTaskTCBBuffer = &( xIdleTaskTCBs[ xCoreId ] );
8413 *ppxIdleTaskStackBuffer = &( uxIdleTaskStacks[ xCoreId ][ 0 ] );
8414 *pulIdleTaskStackSize = configMINIMAL_STACK_SIZE;
8417 #endif /* #if ( configNUMBER_OF_CORES == 1 ) */
8419 #endif /* #if ( ( configSUPPORT_STATIC_ALLOCATION == 1 ) && ( configKERNEL_PROVIDED_STATIC_MEMORY == 1 ) && ( portUSING_MPU_WRAPPERS == 0 ) ) */
8420 /*-----------------------------------------------------------*/
8422 #if ( ( configSUPPORT_STATIC_ALLOCATION == 1 ) && ( configKERNEL_PROVIDED_STATIC_MEMORY == 1 ) && ( portUSING_MPU_WRAPPERS == 0 ) )
8425 * This is the kernel provided implementation of vApplicationGetTimerTaskMemory()
8426 * to provide the memory that is used by the Timer service task. It is used when
8427 * configKERNEL_PROVIDED_STATIC_MEMORY is set to 1. The application can provide
8428 * it's own implementation of vApplicationGetTimerTaskMemory by setting
8429 * configKERNEL_PROVIDED_STATIC_MEMORY to 0 or leaving it undefined.
8431 void vApplicationGetTimerTaskMemory( StaticTask_t ** ppxTimerTaskTCBBuffer,
8432 StackType_t ** ppxTimerTaskStackBuffer,
8433 uint32_t * pulTimerTaskStackSize )
8435 static StaticTask_t xTimerTaskTCB;
8436 static StackType_t uxTimerTaskStack[ configTIMER_TASK_STACK_DEPTH ];
8438 *ppxTimerTaskTCBBuffer = &( xTimerTaskTCB );
8439 *ppxTimerTaskStackBuffer = &( uxTimerTaskStack[ 0 ] );
8440 *pulTimerTaskStackSize = configTIMER_TASK_STACK_DEPTH;
8443 #endif /* #if ( ( configSUPPORT_STATIC_ALLOCATION == 1 ) && ( configKERNEL_PROVIDED_STATIC_MEMORY == 1 ) && ( portUSING_MPU_WRAPPERS == 0 ) ) */
8444 /*-----------------------------------------------------------*/