2 * FreeRTOS Kernel <DEVELOPMENT BRANCH>
\r
3 * Copyright (C) 2021 Amazon.com, Inc. or its affiliates. All Rights Reserved.
\r
5 * SPDX-License-Identifier: MIT
\r
7 * Permission is hereby granted, free of charge, to any person obtaining a copy of
\r
8 * this software and associated documentation files (the "Software"), to deal in
\r
9 * the Software without restriction, including without limitation the rights to
\r
10 * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
\r
11 * the Software, and to permit persons to whom the Software is furnished to do so,
\r
12 * subject to the following conditions:
\r
14 * The above copyright notice and this permission notice shall be included in all
\r
15 * copies or substantial portions of the Software.
\r
17 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
\r
18 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
\r
19 * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
\r
20 * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
\r
21 * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
\r
22 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
\r
24 * https://www.FreeRTOS.org
\r
25 * https://github.com/FreeRTOS
\r
29 /* Standard includes. */
\r
33 /* Defining MPU_WRAPPERS_INCLUDED_FROM_API_FILE prevents task.h from redefining
\r
34 * all the API functions to use the MPU wrappers. That should only be done when
\r
35 * task.h is included from an application file. */
\r
36 #define MPU_WRAPPERS_INCLUDED_FROM_API_FILE
\r
38 /* FreeRTOS includes. */
\r
39 #include "FreeRTOS.h"
\r
42 #include "stack_macros.h"
\r
44 /* Lint e9021, e961 and e750 are suppressed as a MISRA exception justified
\r
45 * because the MPU ports require MPU_WRAPPERS_INCLUDED_FROM_API_FILE to be defined
\r
46 * for the header files above, but not in this file, in order to generate the
\r
47 * correct privileged Vs unprivileged linkage and placement. */
\r
48 #undef MPU_WRAPPERS_INCLUDED_FROM_API_FILE /*lint !e961 !e750 !e9021. */
\r
50 /* Set configUSE_STATS_FORMATTING_FUNCTIONS to 2 to include the stats formatting
\r
51 * functions but without including stdio.h here. */
\r
52 #if ( configUSE_STATS_FORMATTING_FUNCTIONS == 1 )
\r
54 /* At the bottom of this file are two optional functions that can be used
\r
55 * to generate human readable text from the raw data generated by the
\r
56 * uxTaskGetSystemState() function. Note the formatting functions are provided
\r
57 * for convenience only, and are NOT considered part of the kernel. */
\r
59 #endif /* configUSE_STATS_FORMATTING_FUNCTIONS == 1 ) */
\r
61 #if ( configUSE_PREEMPTION == 0 )
\r
63 /* If the cooperative scheduler is being used then a yield should not be
\r
64 * performed just because a higher priority task has been woken. */
\r
65 #define taskYIELD_IF_USING_PREEMPTION()
\r
67 #define taskYIELD_IF_USING_PREEMPTION() portYIELD_WITHIN_API()
\r
70 /* Values that can be assigned to the ucNotifyState member of the TCB. */
\r
71 #define taskNOT_WAITING_NOTIFICATION ( ( uint8_t ) 0 ) /* Must be zero as it is the initialised value. */
\r
72 #define taskWAITING_NOTIFICATION ( ( uint8_t ) 1 )
\r
73 #define taskNOTIFICATION_RECEIVED ( ( uint8_t ) 2 )
\r
76 * The value used to fill the stack of a task when the task is created. This
\r
77 * is used purely for checking the high water mark for tasks.
\r
79 #define tskSTACK_FILL_BYTE ( 0xa5U )
\r
81 /* Bits used to record how a task's stack and TCB were allocated. */
\r
82 #define tskDYNAMICALLY_ALLOCATED_STACK_AND_TCB ( ( uint8_t ) 0 )
\r
83 #define tskSTATICALLY_ALLOCATED_STACK_ONLY ( ( uint8_t ) 1 )
\r
84 #define tskSTATICALLY_ALLOCATED_STACK_AND_TCB ( ( uint8_t ) 2 )
\r
86 /* If any of the following are set then task stacks are filled with a known
\r
87 * value so the high water mark can be determined. If none of the following are
\r
88 * set then don't fill the stack so there is no unnecessary dependency on memset. */
\r
89 #if ( ( configCHECK_FOR_STACK_OVERFLOW > 1 ) || ( configUSE_TRACE_FACILITY == 1 ) || ( INCLUDE_uxTaskGetStackHighWaterMark == 1 ) || ( INCLUDE_uxTaskGetStackHighWaterMark2 == 1 ) )
\r
90 #define tskSET_NEW_STACKS_TO_KNOWN_VALUE 1
\r
92 #define tskSET_NEW_STACKS_TO_KNOWN_VALUE 0
\r
96 * Macros used by vListTask to indicate which state a task is in.
\r
98 #define tskRUNNING_CHAR ( 'X' )
\r
99 #define tskBLOCKED_CHAR ( 'B' )
\r
100 #define tskREADY_CHAR ( 'R' )
\r
101 #define tskDELETED_CHAR ( 'D' )
\r
102 #define tskSUSPENDED_CHAR ( 'S' )
\r
105 * Some kernel aware debuggers require the data the debugger needs access to to
\r
106 * be global, rather than file scope.
\r
108 #ifdef portREMOVE_STATIC_QUALIFIER
\r
112 /* The name allocated to the Idle task. This can be overridden by defining
\r
113 * configIDLE_TASK_NAME in FreeRTOSConfig.h. */
\r
114 #ifndef configIDLE_TASK_NAME
\r
115 #define configIDLE_TASK_NAME "IDLE"
\r
118 #if ( configUSE_PORT_OPTIMISED_TASK_SELECTION == 0 )
\r
120 /* If configUSE_PORT_OPTIMISED_TASK_SELECTION is 0 then task selection is
\r
121 * performed in a generic way that is not optimised to any particular
\r
122 * microcontroller architecture. */
\r
124 /* uxTopReadyPriority holds the priority of the highest priority ready
\r
126 #define taskRECORD_READY_PRIORITY( uxPriority ) \
\r
128 if( ( uxPriority ) > uxTopReadyPriority ) \
\r
130 uxTopReadyPriority = ( uxPriority ); \
\r
132 } /* taskRECORD_READY_PRIORITY */
\r
134 /*-----------------------------------------------------------*/
\r
136 #define taskSELECT_HIGHEST_PRIORITY_TASK() \
\r
138 UBaseType_t uxTopPriority = uxTopReadyPriority; \
\r
140 /* Find the highest priority queue that contains ready tasks. */ \
\r
141 while( listLIST_IS_EMPTY( &( pxReadyTasksLists[ uxTopPriority ] ) ) ) \
\r
143 configASSERT( uxTopPriority ); \
\r
147 /* listGET_OWNER_OF_NEXT_ENTRY indexes through the list, so the tasks of \
\r
148 * the same priority get an equal share of the processor time. */ \
\r
149 listGET_OWNER_OF_NEXT_ENTRY( pxCurrentTCB, &( pxReadyTasksLists[ uxTopPriority ] ) ); \
\r
150 uxTopReadyPriority = uxTopPriority; \
\r
151 } /* taskSELECT_HIGHEST_PRIORITY_TASK */
\r
153 /*-----------------------------------------------------------*/
\r
155 /* Define away taskRESET_READY_PRIORITY() and portRESET_READY_PRIORITY() as
\r
156 * they are only required when a port optimised method of task selection is
\r
158 #define taskRESET_READY_PRIORITY( uxPriority )
\r
159 #define portRESET_READY_PRIORITY( uxPriority, uxTopReadyPriority )
\r
161 #else /* configUSE_PORT_OPTIMISED_TASK_SELECTION */
\r
163 /* If configUSE_PORT_OPTIMISED_TASK_SELECTION is 1 then task selection is
\r
164 * performed in a way that is tailored to the particular microcontroller
\r
165 * architecture being used. */
\r
167 /* A port optimised version is provided. Call the port defined macros. */
\r
168 #define taskRECORD_READY_PRIORITY( uxPriority ) portRECORD_READY_PRIORITY( uxPriority, uxTopReadyPriority )
\r
170 /*-----------------------------------------------------------*/
\r
172 #define taskSELECT_HIGHEST_PRIORITY_TASK() \
\r
174 UBaseType_t uxTopPriority; \
\r
176 /* Find the highest priority list that contains ready tasks. */ \
\r
177 portGET_HIGHEST_PRIORITY( uxTopPriority, uxTopReadyPriority ); \
\r
178 configASSERT( listCURRENT_LIST_LENGTH( &( pxReadyTasksLists[ uxTopPriority ] ) ) > 0 ); \
\r
179 listGET_OWNER_OF_NEXT_ENTRY( pxCurrentTCB, &( pxReadyTasksLists[ uxTopPriority ] ) ); \
\r
180 } /* taskSELECT_HIGHEST_PRIORITY_TASK() */
\r
182 /*-----------------------------------------------------------*/
\r
184 /* A port optimised version is provided, call it only if the TCB being reset
\r
185 * is being referenced from a ready list. If it is referenced from a delayed
\r
186 * or suspended list then it won't be in a ready list. */
\r
187 #define taskRESET_READY_PRIORITY( uxPriority ) \
\r
189 if( listCURRENT_LIST_LENGTH( &( pxReadyTasksLists[ ( uxPriority ) ] ) ) == ( UBaseType_t ) 0 ) \
\r
191 portRESET_READY_PRIORITY( ( uxPriority ), ( uxTopReadyPriority ) ); \
\r
195 #endif /* configUSE_PORT_OPTIMISED_TASK_SELECTION */
\r
197 /*-----------------------------------------------------------*/
\r
199 /* pxDelayedTaskList and pxOverflowDelayedTaskList are switched when the tick
\r
200 * count overflows. */
\r
201 #define taskSWITCH_DELAYED_LISTS() \
\r
205 /* The delayed tasks list should be empty when the lists are switched. */ \
\r
206 configASSERT( ( listLIST_IS_EMPTY( pxDelayedTaskList ) ) ); \
\r
208 pxTemp = pxDelayedTaskList; \
\r
209 pxDelayedTaskList = pxOverflowDelayedTaskList; \
\r
210 pxOverflowDelayedTaskList = pxTemp; \
\r
211 xNumOfOverflows++; \
\r
212 prvResetNextTaskUnblockTime(); \
\r
215 /*-----------------------------------------------------------*/
\r
218 * Place the task represented by pxTCB into the appropriate ready list for
\r
219 * the task. It is inserted at the end of the list.
\r
221 #define prvAddTaskToReadyList( pxTCB ) \
\r
222 traceMOVED_TASK_TO_READY_STATE( pxTCB ); \
\r
223 taskRECORD_READY_PRIORITY( ( pxTCB )->uxPriority ); \
\r
224 listINSERT_END( &( pxReadyTasksLists[ ( pxTCB )->uxPriority ] ), &( ( pxTCB )->xStateListItem ) ); \
\r
225 tracePOST_MOVED_TASK_TO_READY_STATE( pxTCB )
\r
226 /*-----------------------------------------------------------*/
\r
229 * Several functions take a TaskHandle_t parameter that can optionally be NULL,
\r
230 * where NULL is used to indicate that the handle of the currently executing
\r
231 * task should be used in place of the parameter. This macro simply checks to
\r
232 * see if the parameter is NULL and returns a pointer to the appropriate TCB.
\r
234 #define prvGetTCBFromHandle( pxHandle ) ( ( ( pxHandle ) == NULL ) ? pxCurrentTCB : ( pxHandle ) )
\r
236 /* The item value of the event list item is normally used to hold the priority
\r
237 * of the task to which it belongs (coded to allow it to be held in reverse
\r
238 * priority order). However, it is occasionally borrowed for other purposes. It
\r
239 * is important its value is not updated due to a task priority change while it is
\r
240 * being used for another purpose. The following bit definition is used to inform
\r
241 * the scheduler that the value should not be changed - in which case it is the
\r
242 * responsibility of whichever module is using the value to ensure it gets set back
\r
243 * to its original value when it is released. */
\r
244 #if ( configUSE_16_BIT_TICKS == 1 )
\r
245 #define taskEVENT_LIST_ITEM_VALUE_IN_USE 0x8000U
\r
247 #define taskEVENT_LIST_ITEM_VALUE_IN_USE 0x80000000UL
\r
251 * Task control block. A task control block (TCB) is allocated for each task,
\r
252 * and stores task state information, including a pointer to the task's context
\r
253 * (the task's run time environment, including register values)
\r
255 typedef struct tskTaskControlBlock /* The old naming convention is used to prevent breaking kernel aware debuggers. */
\r
257 volatile StackType_t * pxTopOfStack; /*< Points to the location of the last item placed on the tasks stack. THIS MUST BE THE FIRST MEMBER OF THE TCB STRUCT. */
\r
259 #if ( portUSING_MPU_WRAPPERS == 1 )
\r
260 xMPU_SETTINGS xMPUSettings; /*< The MPU settings are defined as part of the port layer. THIS MUST BE THE SECOND MEMBER OF THE TCB STRUCT. */
\r
263 ListItem_t xStateListItem; /*< The list that the state list item of a task is reference from denotes the state of that task (Ready, Blocked, Suspended ). */
\r
264 ListItem_t xEventListItem; /*< Used to reference a task from an event list. */
\r
265 UBaseType_t uxPriority; /*< The priority of the task. 0 is the lowest priority. */
\r
266 StackType_t * pxStack; /*< Points to the start of the stack. */
\r
267 char pcTaskName[ configMAX_TASK_NAME_LEN ]; /*< Descriptive name given to the task when created. Facilitates debugging only. */ /*lint !e971 Unqualified char types are allowed for strings and single characters only. */
\r
269 #if ( ( portSTACK_GROWTH > 0 ) || ( configRECORD_STACK_HIGH_ADDRESS == 1 ) )
\r
270 StackType_t * pxEndOfStack; /*< Points to the highest valid address for the stack. */
\r
273 #if ( portCRITICAL_NESTING_IN_TCB == 1 )
\r
274 UBaseType_t uxCriticalNesting; /*< Holds the critical section nesting depth for ports that do not maintain their own count in the port layer. */
\r
277 #if ( configUSE_TRACE_FACILITY == 1 )
\r
278 UBaseType_t uxTCBNumber; /*< Stores a number that increments each time a TCB is created. It allows debuggers to determine when a task has been deleted and then recreated. */
\r
279 UBaseType_t uxTaskNumber; /*< Stores a number specifically for use by third party trace code. */
\r
282 #if ( configUSE_MUTEXES == 1 )
\r
283 UBaseType_t uxBasePriority; /*< The priority last assigned to the task - used by the priority inheritance mechanism. */
\r
284 UBaseType_t uxMutexesHeld;
\r
287 #if ( configUSE_APPLICATION_TASK_TAG == 1 )
\r
288 TaskHookFunction_t pxTaskTag;
\r
291 #if ( configNUM_THREAD_LOCAL_STORAGE_POINTERS > 0 )
\r
292 void * pvThreadLocalStoragePointers[ configNUM_THREAD_LOCAL_STORAGE_POINTERS ];
\r
295 #if ( configGENERATE_RUN_TIME_STATS == 1 )
\r
296 configRUN_TIME_COUNTER_TYPE ulRunTimeCounter; /*< Stores the amount of time the task has spent in the Running state. */
\r
299 #if ( ( configUSE_NEWLIB_REENTRANT == 1 ) || ( configUSE_C_RUNTIME_TLS_SUPPORT == 1 ) )
\r
300 configTLS_BLOCK_TYPE xTLSBlock; /*< Memory block used as Thread Local Storage (TLS) Block for the task. */
\r
303 #if ( configUSE_TASK_NOTIFICATIONS == 1 )
\r
304 volatile uint32_t ulNotifiedValue[ configTASK_NOTIFICATION_ARRAY_ENTRIES ];
\r
305 volatile uint8_t ucNotifyState[ configTASK_NOTIFICATION_ARRAY_ENTRIES ];
\r
308 /* See the comments in FreeRTOS.h with the definition of
\r
309 * tskSTATIC_AND_DYNAMIC_ALLOCATION_POSSIBLE. */
\r
310 #if ( tskSTATIC_AND_DYNAMIC_ALLOCATION_POSSIBLE != 0 ) /*lint !e731 !e9029 Macro has been consolidated for readability reasons. */
\r
311 uint8_t ucStaticallyAllocated; /*< Set to pdTRUE if the task is a statically allocated to ensure no attempt is made to free the memory. */
\r
314 #if ( INCLUDE_xTaskAbortDelay == 1 )
\r
315 uint8_t ucDelayAborted;
\r
318 #if ( configUSE_POSIX_ERRNO == 1 )
\r
323 /* The old tskTCB name is maintained above then typedefed to the new TCB_t name
\r
324 * below to enable the use of older kernel aware debuggers. */
\r
325 typedef tskTCB TCB_t;
\r
327 /*lint -save -e956 A manual analysis and inspection has been used to determine
\r
328 * which static variables must be declared volatile. */
\r
329 portDONT_DISCARD PRIVILEGED_DATA TCB_t * volatile pxCurrentTCB = NULL;
\r
331 /* Lists for ready and blocked tasks. --------------------
\r
332 * xDelayedTaskList1 and xDelayedTaskList2 could be moved to function scope but
\r
333 * doing so breaks some kernel aware debuggers and debuggers that rely on removing
\r
334 * the static qualifier. */
\r
335 PRIVILEGED_DATA static List_t pxReadyTasksLists[ configMAX_PRIORITIES ]; /*< Prioritised ready tasks. */
\r
336 PRIVILEGED_DATA static List_t xDelayedTaskList1; /*< Delayed tasks. */
\r
337 PRIVILEGED_DATA static List_t xDelayedTaskList2; /*< Delayed tasks (two lists are used - one for delays that have overflowed the current tick count. */
\r
338 PRIVILEGED_DATA static List_t * volatile pxDelayedTaskList; /*< Points to the delayed task list currently being used. */
\r
339 PRIVILEGED_DATA static List_t * volatile pxOverflowDelayedTaskList; /*< Points to the delayed task list currently being used to hold tasks that have overflowed the current tick count. */
\r
340 PRIVILEGED_DATA static List_t xPendingReadyList; /*< Tasks that have been readied while the scheduler was suspended. They will be moved to the ready list when the scheduler is resumed. */
\r
342 #if ( INCLUDE_vTaskDelete == 1 )
\r
344 PRIVILEGED_DATA static List_t xTasksWaitingTermination; /*< Tasks that have been deleted - but their memory not yet freed. */
\r
345 PRIVILEGED_DATA static volatile UBaseType_t uxDeletedTasksWaitingCleanUp = ( UBaseType_t ) 0U;
\r
349 #if ( INCLUDE_vTaskSuspend == 1 )
\r
351 PRIVILEGED_DATA static List_t xSuspendedTaskList; /*< Tasks that are currently suspended. */
\r
355 /* Global POSIX errno. Its value is changed upon context switching to match
\r
356 * the errno of the currently running task. */
\r
357 #if ( configUSE_POSIX_ERRNO == 1 )
\r
358 int FreeRTOS_errno = 0;
\r
361 /* Other file private variables. --------------------------------*/
\r
362 PRIVILEGED_DATA static volatile UBaseType_t uxCurrentNumberOfTasks = ( UBaseType_t ) 0U;
\r
363 PRIVILEGED_DATA static volatile TickType_t xTickCount = ( TickType_t ) configINITIAL_TICK_COUNT;
\r
364 PRIVILEGED_DATA static volatile UBaseType_t uxTopReadyPriority = tskIDLE_PRIORITY;
\r
365 PRIVILEGED_DATA static volatile BaseType_t xSchedulerRunning = pdFALSE;
\r
366 PRIVILEGED_DATA static volatile TickType_t xPendedTicks = ( TickType_t ) 0U;
\r
367 PRIVILEGED_DATA static volatile BaseType_t xYieldPending = pdFALSE;
\r
368 PRIVILEGED_DATA static volatile BaseType_t xNumOfOverflows = ( BaseType_t ) 0;
\r
369 PRIVILEGED_DATA static UBaseType_t uxTaskNumber = ( UBaseType_t ) 0U;
\r
370 PRIVILEGED_DATA static volatile TickType_t xNextTaskUnblockTime = ( TickType_t ) 0U; /* Initialised to portMAX_DELAY before the scheduler starts. */
\r
371 PRIVILEGED_DATA static TaskHandle_t xIdleTaskHandle = NULL; /*< Holds the handle of the idle task. The idle task is created automatically when the scheduler is started. */
\r
373 /* Improve support for OpenOCD. The kernel tracks Ready tasks via priority lists.
\r
374 * For tracking the state of remote threads, OpenOCD uses uxTopUsedPriority
\r
375 * to determine the number of priority lists to read back from the remote target. */
\r
376 const volatile UBaseType_t uxTopUsedPriority = configMAX_PRIORITIES - 1U;
\r
378 /* Context switches are held pending while the scheduler is suspended. Also,
\r
379 * interrupts must not manipulate the xStateListItem of a TCB, or any of the
\r
380 * lists the xStateListItem can be referenced from, if the scheduler is suspended.
\r
381 * If an interrupt needs to unblock a task while the scheduler is suspended then it
\r
382 * moves the task's event list item into the xPendingReadyList, ready for the
\r
383 * kernel to move the task from the pending ready list into the real ready list
\r
384 * when the scheduler is unsuspended. The pending ready list itself can only be
\r
385 * accessed from a critical section. */
\r
386 PRIVILEGED_DATA static volatile UBaseType_t uxSchedulerSuspended = ( UBaseType_t ) pdFALSE;
\r
388 #if ( configGENERATE_RUN_TIME_STATS == 1 )
\r
390 /* Do not move these variables to function scope as doing so prevents the
\r
391 * code working with debuggers that need to remove the static qualifier. */
\r
392 PRIVILEGED_DATA static configRUN_TIME_COUNTER_TYPE ulTaskSwitchedInTime = 0UL; /*< Holds the value of a timer/counter the last time a task was switched in. */
\r
393 PRIVILEGED_DATA static volatile configRUN_TIME_COUNTER_TYPE ulTotalRunTime = 0UL; /*< Holds the total amount of execution time as defined by the run time counter clock. */
\r
399 /*-----------------------------------------------------------*/
\r
401 /* File private functions. --------------------------------*/
\r
404 * Utility task that simply returns pdTRUE if the task referenced by xTask is
\r
405 * currently in the Suspended state, or pdFALSE if the task referenced by xTask
\r
406 * is in any other state.
\r
408 #if ( INCLUDE_vTaskSuspend == 1 )
\r
410 static BaseType_t prvTaskIsTaskSuspended( const TaskHandle_t xTask ) PRIVILEGED_FUNCTION;
\r
412 #endif /* INCLUDE_vTaskSuspend */
\r
415 * Utility to ready all the lists used by the scheduler. This is called
\r
416 * automatically upon the creation of the first task.
\r
418 static void prvInitialiseTaskLists( void ) PRIVILEGED_FUNCTION;
\r
421 * The idle task, which as all tasks is implemented as a never ending loop.
\r
422 * The idle task is automatically created and added to the ready lists upon
\r
423 * creation of the first user task.
\r
425 * The portTASK_FUNCTION_PROTO() macro is used to allow port/compiler specific
\r
426 * language extensions. The equivalent prototype for this function is:
\r
428 * void prvIdleTask( void *pvParameters );
\r
431 static portTASK_FUNCTION_PROTO( prvIdleTask, pvParameters ) PRIVILEGED_FUNCTION;
\r
434 * Utility to free all memory allocated by the scheduler to hold a TCB,
\r
435 * including the stack pointed to by the TCB.
\r
437 * This does not free memory allocated by the task itself (i.e. memory
\r
438 * allocated by calls to pvPortMalloc from within the tasks application code).
\r
440 #if ( INCLUDE_vTaskDelete == 1 )
\r
442 static void prvDeleteTCB( TCB_t * pxTCB ) PRIVILEGED_FUNCTION;
\r
447 * Used only by the idle task. This checks to see if anything has been placed
\r
448 * in the list of tasks waiting to be deleted. If so the task is cleaned up
\r
449 * and its TCB deleted.
\r
451 static void prvCheckTasksWaitingTermination( void ) PRIVILEGED_FUNCTION;
\r
454 * The currently executing task is entering the Blocked state. Add the task to
\r
455 * either the current or the overflow delayed task list.
\r
457 static void prvAddCurrentTaskToDelayedList( TickType_t xTicksToWait,
\r
458 const BaseType_t xCanBlockIndefinitely ) PRIVILEGED_FUNCTION;
\r
461 * Fills an TaskStatus_t structure with information on each task that is
\r
462 * referenced from the pxList list (which may be a ready list, a delayed list,
\r
463 * a suspended list, etc.).
\r
465 * THIS FUNCTION IS INTENDED FOR DEBUGGING ONLY, AND SHOULD NOT BE CALLED FROM
\r
466 * NORMAL APPLICATION CODE.
\r
468 #if ( configUSE_TRACE_FACILITY == 1 )
\r
470 static UBaseType_t prvListTasksWithinSingleList( TaskStatus_t * pxTaskStatusArray,
\r
472 eTaskState eState ) PRIVILEGED_FUNCTION;
\r
477 * Searches pxList for a task with name pcNameToQuery - returning a handle to
\r
478 * the task if it is found, or NULL if the task is not found.
\r
480 #if ( INCLUDE_xTaskGetHandle == 1 )
\r
482 static TCB_t * prvSearchForNameWithinSingleList( List_t * pxList,
\r
483 const char pcNameToQuery[] ) PRIVILEGED_FUNCTION;
\r
488 * When a task is created, the stack of the task is filled with a known value.
\r
489 * This function determines the 'high water mark' of the task stack by
\r
490 * determining how much of the stack remains at the original preset value.
\r
492 #if ( ( configUSE_TRACE_FACILITY == 1 ) || ( INCLUDE_uxTaskGetStackHighWaterMark == 1 ) || ( INCLUDE_uxTaskGetStackHighWaterMark2 == 1 ) )
\r
494 static configSTACK_DEPTH_TYPE prvTaskCheckFreeStackSpace( const uint8_t * pucStackByte ) PRIVILEGED_FUNCTION;
\r
499 * Return the amount of time, in ticks, that will pass before the kernel will
\r
500 * next move a task from the Blocked state to the Running state.
\r
502 * This conditional compilation should use inequality to 0, not equality to 1.
\r
503 * This is to ensure portSUPPRESS_TICKS_AND_SLEEP() can be called when user
\r
504 * defined low power mode implementations require configUSE_TICKLESS_IDLE to be
\r
505 * set to a value other than 1.
\r
507 #if ( configUSE_TICKLESS_IDLE != 0 )
\r
509 static TickType_t prvGetExpectedIdleTime( void ) PRIVILEGED_FUNCTION;
\r
514 * Set xNextTaskUnblockTime to the time at which the next Blocked state task
\r
515 * will exit the Blocked state.
\r
517 static void prvResetNextTaskUnblockTime( void ) PRIVILEGED_FUNCTION;
\r
519 #if ( ( ( configUSE_TRACE_FACILITY == 1 ) || ( configGENERATE_RUN_TIME_STATS == 1 ) ) && \
\r
520 ( configUSE_STATS_FORMATTING_FUNCTIONS > 0 ) && \
\r
521 ( configSUPPORT_DYNAMIC_ALLOCATION == 1 ) )
\r
524 * Helper function used to pad task names with spaces when printing out
\r
525 * human readable tables of task information.
\r
527 static char * prvWriteNameToBuffer( char * pcBuffer,
\r
528 const char * pcTaskName ) PRIVILEGED_FUNCTION;
\r
533 * Called after a Task_t structure has been allocated either statically or
\r
534 * dynamically to fill in the structure's members.
\r
536 static void prvInitialiseNewTask( TaskFunction_t pxTaskCode,
\r
537 const char * const pcName, /*lint !e971 Unqualified char types are allowed for strings and single characters only. */
\r
538 const uint32_t ulStackDepth,
\r
539 void * const pvParameters,
\r
540 UBaseType_t uxPriority,
\r
541 TaskHandle_t * const pxCreatedTask,
\r
543 const MemoryRegion_t * const xRegions ) PRIVILEGED_FUNCTION;
\r
546 * Called after a new task has been created and initialised to place the task
\r
547 * under the control of the scheduler.
\r
549 static void prvAddNewTaskToReadyList( TCB_t * pxNewTCB ) PRIVILEGED_FUNCTION;
\r
552 * freertos_tasks_c_additions_init() should only be called if the user definable
\r
553 * macro FREERTOS_TASKS_C_ADDITIONS_INIT() is defined, as that is the only macro
\r
554 * called by the function.
\r
556 #ifdef FREERTOS_TASKS_C_ADDITIONS_INIT
\r
558 static void freertos_tasks_c_additions_init( void ) PRIVILEGED_FUNCTION;
\r
562 /*-----------------------------------------------------------*/
\r
564 #if ( configSUPPORT_STATIC_ALLOCATION == 1 )
\r
566 TaskHandle_t xTaskCreateStatic( TaskFunction_t pxTaskCode,
\r
567 const char * const pcName, /*lint !e971 Unqualified char types are allowed for strings and single characters only. */
\r
568 const uint32_t ulStackDepth,
\r
569 void * const pvParameters,
\r
570 UBaseType_t uxPriority,
\r
571 StackType_t * const puxStackBuffer,
\r
572 StaticTask_t * const pxTaskBuffer )
\r
575 TaskHandle_t xReturn;
\r
577 configASSERT( puxStackBuffer != NULL );
\r
578 configASSERT( pxTaskBuffer != NULL );
\r
580 #if ( configASSERT_DEFINED == 1 )
\r
582 /* Sanity check that the size of the structure used to declare a
\r
583 * variable of type StaticTask_t equals the size of the real task
\r
585 volatile size_t xSize = sizeof( StaticTask_t );
\r
586 configASSERT( xSize == sizeof( TCB_t ) );
\r
587 ( void ) xSize; /* Prevent lint warning when configASSERT() is not used. */
\r
589 #endif /* configASSERT_DEFINED */
\r
591 if( ( pxTaskBuffer != NULL ) && ( puxStackBuffer != NULL ) )
\r
593 /* The memory used for the task's TCB and stack are passed into this
\r
594 * function - use them. */
\r
595 pxNewTCB = ( TCB_t * ) pxTaskBuffer; /*lint !e740 !e9087 Unusual cast is ok as the structures are designed to have the same alignment, and the size is checked by an assert. */
\r
596 memset( ( void * ) pxNewTCB, 0x00, sizeof( TCB_t ) );
\r
597 pxNewTCB->pxStack = ( StackType_t * ) puxStackBuffer;
\r
599 #if ( tskSTATIC_AND_DYNAMIC_ALLOCATION_POSSIBLE != 0 ) /*lint !e731 !e9029 Macro has been consolidated for readability reasons. */
\r
601 /* Tasks can be created statically or dynamically, so note this
\r
602 * task was created statically in case the task is later deleted. */
\r
603 pxNewTCB->ucStaticallyAllocated = tskSTATICALLY_ALLOCATED_STACK_AND_TCB;
\r
605 #endif /* tskSTATIC_AND_DYNAMIC_ALLOCATION_POSSIBLE */
\r
607 prvInitialiseNewTask( pxTaskCode, pcName, ulStackDepth, pvParameters, uxPriority, &xReturn, pxNewTCB, NULL );
\r
608 prvAddNewTaskToReadyList( pxNewTCB );
\r
618 #endif /* SUPPORT_STATIC_ALLOCATION */
\r
619 /*-----------------------------------------------------------*/
\r
621 #if ( ( portUSING_MPU_WRAPPERS == 1 ) && ( configSUPPORT_STATIC_ALLOCATION == 1 ) )
\r
623 BaseType_t xTaskCreateRestrictedStatic( const TaskParameters_t * const pxTaskDefinition,
\r
624 TaskHandle_t * pxCreatedTask )
\r
627 BaseType_t xReturn = errCOULD_NOT_ALLOCATE_REQUIRED_MEMORY;
\r
629 configASSERT( pxTaskDefinition->puxStackBuffer != NULL );
\r
630 configASSERT( pxTaskDefinition->pxTaskBuffer != NULL );
\r
632 if( ( pxTaskDefinition->puxStackBuffer != NULL ) && ( pxTaskDefinition->pxTaskBuffer != NULL ) )
\r
634 /* Allocate space for the TCB. Where the memory comes from depends
\r
635 * on the implementation of the port malloc function and whether or
\r
636 * not static allocation is being used. */
\r
637 pxNewTCB = ( TCB_t * ) pxTaskDefinition->pxTaskBuffer;
\r
638 memset( ( void * ) pxNewTCB, 0x00, sizeof( TCB_t ) );
\r
640 /* Store the stack location in the TCB. */
\r
641 pxNewTCB->pxStack = pxTaskDefinition->puxStackBuffer;
\r
643 #if ( tskSTATIC_AND_DYNAMIC_ALLOCATION_POSSIBLE != 0 )
\r
645 /* Tasks can be created statically or dynamically, so note this
\r
646 * task was created statically in case the task is later deleted. */
\r
647 pxNewTCB->ucStaticallyAllocated = tskSTATICALLY_ALLOCATED_STACK_AND_TCB;
\r
649 #endif /* tskSTATIC_AND_DYNAMIC_ALLOCATION_POSSIBLE */
\r
651 prvInitialiseNewTask( pxTaskDefinition->pvTaskCode,
\r
652 pxTaskDefinition->pcName,
\r
653 ( uint32_t ) pxTaskDefinition->usStackDepth,
\r
654 pxTaskDefinition->pvParameters,
\r
655 pxTaskDefinition->uxPriority,
\r
656 pxCreatedTask, pxNewTCB,
\r
657 pxTaskDefinition->xRegions );
\r
659 prvAddNewTaskToReadyList( pxNewTCB );
\r
666 #endif /* ( portUSING_MPU_WRAPPERS == 1 ) && ( configSUPPORT_STATIC_ALLOCATION == 1 ) */
\r
667 /*-----------------------------------------------------------*/
\r
669 #if ( ( portUSING_MPU_WRAPPERS == 1 ) && ( configSUPPORT_DYNAMIC_ALLOCATION == 1 ) )
\r
671 BaseType_t xTaskCreateRestricted( const TaskParameters_t * const pxTaskDefinition,
\r
672 TaskHandle_t * pxCreatedTask )
\r
675 BaseType_t xReturn = errCOULD_NOT_ALLOCATE_REQUIRED_MEMORY;
\r
677 configASSERT( pxTaskDefinition->puxStackBuffer );
\r
679 if( pxTaskDefinition->puxStackBuffer != NULL )
\r
681 /* Allocate space for the TCB. Where the memory comes from depends
\r
682 * on the implementation of the port malloc function and whether or
\r
683 * not static allocation is being used. */
\r
684 pxNewTCB = ( TCB_t * ) pvPortMalloc( sizeof( TCB_t ) );
\r
686 if( pxNewTCB != NULL )
\r
688 memset( ( void * ) pxNewTCB, 0x00, sizeof( TCB_t ) );
\r
690 /* Store the stack location in the TCB. */
\r
691 pxNewTCB->pxStack = pxTaskDefinition->puxStackBuffer;
\r
693 #if ( tskSTATIC_AND_DYNAMIC_ALLOCATION_POSSIBLE != 0 )
\r
695 /* Tasks can be created statically or dynamically, so note
\r
696 * this task had a statically allocated stack in case it is
\r
697 * later deleted. The TCB was allocated dynamically. */
\r
698 pxNewTCB->ucStaticallyAllocated = tskSTATICALLY_ALLOCATED_STACK_ONLY;
\r
700 #endif /* tskSTATIC_AND_DYNAMIC_ALLOCATION_POSSIBLE */
\r
702 prvInitialiseNewTask( pxTaskDefinition->pvTaskCode,
\r
703 pxTaskDefinition->pcName,
\r
704 ( uint32_t ) pxTaskDefinition->usStackDepth,
\r
705 pxTaskDefinition->pvParameters,
\r
706 pxTaskDefinition->uxPriority,
\r
707 pxCreatedTask, pxNewTCB,
\r
708 pxTaskDefinition->xRegions );
\r
710 prvAddNewTaskToReadyList( pxNewTCB );
\r
718 #endif /* portUSING_MPU_WRAPPERS */
\r
719 /*-----------------------------------------------------------*/
\r
721 #if ( configSUPPORT_DYNAMIC_ALLOCATION == 1 )
\r
723 BaseType_t xTaskCreate( TaskFunction_t pxTaskCode,
\r
724 const char * const pcName, /*lint !e971 Unqualified char types are allowed for strings and single characters only. */
\r
725 const configSTACK_DEPTH_TYPE usStackDepth,
\r
726 void * const pvParameters,
\r
727 UBaseType_t uxPriority,
\r
728 TaskHandle_t * const pxCreatedTask )
\r
731 BaseType_t xReturn;
\r
733 /* If the stack grows down then allocate the stack then the TCB so the stack
\r
734 * does not grow into the TCB. Likewise if the stack grows up then allocate
\r
735 * the TCB then the stack. */
\r
736 #if ( portSTACK_GROWTH > 0 )
\r
738 /* Allocate space for the TCB. Where the memory comes from depends on
\r
739 * the implementation of the port malloc function and whether or not static
\r
740 * allocation is being used. */
\r
741 pxNewTCB = ( TCB_t * ) pvPortMalloc( sizeof( TCB_t ) );
\r
743 if( pxNewTCB != NULL )
\r
745 memset( ( void * ) pxNewTCB, 0x00, sizeof( TCB_t ) );
\r
747 /* Allocate space for the stack used by the task being created.
\r
748 * The base of the stack memory stored in the TCB so the task can
\r
749 * be deleted later if required. */
\r
750 pxNewTCB->pxStack = ( StackType_t * ) pvPortMallocStack( ( ( ( size_t ) usStackDepth ) * sizeof( StackType_t ) ) ); /*lint !e961 MISRA exception as the casts are only redundant for some ports. */
\r
752 if( pxNewTCB->pxStack == NULL )
\r
754 /* Could not allocate the stack. Delete the allocated TCB. */
\r
755 vPortFree( pxNewTCB );
\r
760 #else /* portSTACK_GROWTH */
\r
762 StackType_t * pxStack;
\r
764 /* Allocate space for the stack used by the task being created. */
\r
765 pxStack = pvPortMallocStack( ( ( ( size_t ) usStackDepth ) * sizeof( StackType_t ) ) ); /*lint !e9079 All values returned by pvPortMalloc() have at least the alignment required by the MCU's stack and this allocation is the stack. */
\r
767 if( pxStack != NULL )
\r
769 /* Allocate space for the TCB. */
\r
770 pxNewTCB = ( TCB_t * ) pvPortMalloc( sizeof( TCB_t ) ); /*lint !e9087 !e9079 All values returned by pvPortMalloc() have at least the alignment required by the MCU's stack, and the first member of TCB_t is always a pointer to the task's stack. */
\r
772 if( pxNewTCB != NULL )
\r
774 memset( ( void * ) pxNewTCB, 0x00, sizeof( TCB_t ) );
\r
776 /* Store the stack location in the TCB. */
\r
777 pxNewTCB->pxStack = pxStack;
\r
781 /* The stack cannot be used as the TCB was not created. Free
\r
783 vPortFreeStack( pxStack );
\r
791 #endif /* portSTACK_GROWTH */
\r
793 if( pxNewTCB != NULL )
\r
795 #if ( tskSTATIC_AND_DYNAMIC_ALLOCATION_POSSIBLE != 0 ) /*lint !e9029 !e731 Macro has been consolidated for readability reasons. */
\r
797 /* Tasks can be created statically or dynamically, so note this
\r
798 * task was created dynamically in case it is later deleted. */
\r
799 pxNewTCB->ucStaticallyAllocated = tskDYNAMICALLY_ALLOCATED_STACK_AND_TCB;
\r
801 #endif /* tskSTATIC_AND_DYNAMIC_ALLOCATION_POSSIBLE */
\r
803 prvInitialiseNewTask( pxTaskCode, pcName, ( uint32_t ) usStackDepth, pvParameters, uxPriority, pxCreatedTask, pxNewTCB, NULL );
\r
804 prvAddNewTaskToReadyList( pxNewTCB );
\r
809 xReturn = errCOULD_NOT_ALLOCATE_REQUIRED_MEMORY;
\r
815 #endif /* configSUPPORT_DYNAMIC_ALLOCATION */
\r
816 /*-----------------------------------------------------------*/
\r
818 static void prvInitialiseNewTask( TaskFunction_t pxTaskCode,
\r
819 const char * const pcName, /*lint !e971 Unqualified char types are allowed for strings and single characters only. */
\r
820 const uint32_t ulStackDepth,
\r
821 void * const pvParameters,
\r
822 UBaseType_t uxPriority,
\r
823 TaskHandle_t * const pxCreatedTask,
\r
825 const MemoryRegion_t * const xRegions )
\r
827 StackType_t * pxTopOfStack;
\r
830 #if ( portUSING_MPU_WRAPPERS == 1 )
\r
831 /* Should the task be created in privileged mode? */
\r
832 BaseType_t xRunPrivileged;
\r
834 if( ( uxPriority & portPRIVILEGE_BIT ) != 0U )
\r
836 xRunPrivileged = pdTRUE;
\r
840 xRunPrivileged = pdFALSE;
\r
842 uxPriority &= ~portPRIVILEGE_BIT;
\r
843 #endif /* portUSING_MPU_WRAPPERS == 1 */
\r
845 /* Avoid dependency on memset() if it is not required. */
\r
846 #if ( tskSET_NEW_STACKS_TO_KNOWN_VALUE == 1 )
\r
848 /* Fill the stack with a known value to assist debugging. */
\r
849 ( void ) memset( pxNewTCB->pxStack, ( int ) tskSTACK_FILL_BYTE, ( size_t ) ulStackDepth * sizeof( StackType_t ) );
\r
851 #endif /* tskSET_NEW_STACKS_TO_KNOWN_VALUE */
\r
853 /* Calculate the top of stack address. This depends on whether the stack
\r
854 * grows from high memory to low (as per the 80x86) or vice versa.
\r
855 * portSTACK_GROWTH is used to make the result positive or negative as required
\r
857 #if ( portSTACK_GROWTH < 0 )
\r
859 pxTopOfStack = &( pxNewTCB->pxStack[ ulStackDepth - ( uint32_t ) 1 ] );
\r
860 pxTopOfStack = ( StackType_t * ) ( ( ( portPOINTER_SIZE_TYPE ) pxTopOfStack ) & ( ~( ( portPOINTER_SIZE_TYPE ) portBYTE_ALIGNMENT_MASK ) ) ); /*lint !e923 !e9033 !e9078 MISRA exception. Avoiding casts between pointers and integers is not practical. Size differences accounted for using portPOINTER_SIZE_TYPE type. Checked by assert(). */
\r
862 /* Check the alignment of the calculated top of stack is correct. */
\r
863 configASSERT( ( ( ( portPOINTER_SIZE_TYPE ) pxTopOfStack & ( portPOINTER_SIZE_TYPE ) portBYTE_ALIGNMENT_MASK ) == 0UL ) );
\r
865 #if ( configRECORD_STACK_HIGH_ADDRESS == 1 )
\r
867 /* Also record the stack's high address, which may assist
\r
869 pxNewTCB->pxEndOfStack = pxTopOfStack;
\r
871 #endif /* configRECORD_STACK_HIGH_ADDRESS */
\r
873 #else /* portSTACK_GROWTH */
\r
875 pxTopOfStack = pxNewTCB->pxStack;
\r
877 /* Check the alignment of the stack buffer is correct. */
\r
878 configASSERT( ( ( ( portPOINTER_SIZE_TYPE ) pxNewTCB->pxStack & ( portPOINTER_SIZE_TYPE ) portBYTE_ALIGNMENT_MASK ) == 0UL ) );
\r
880 /* The other extreme of the stack space is required if stack checking is
\r
882 pxNewTCB->pxEndOfStack = pxNewTCB->pxStack + ( ulStackDepth - ( uint32_t ) 1 );
\r
884 #endif /* portSTACK_GROWTH */
\r
886 /* Store the task name in the TCB. */
\r
887 if( pcName != NULL )
\r
889 for( x = ( UBaseType_t ) 0; x < ( UBaseType_t ) configMAX_TASK_NAME_LEN; x++ )
\r
891 pxNewTCB->pcTaskName[ x ] = pcName[ x ];
\r
893 /* Don't copy all configMAX_TASK_NAME_LEN if the string is shorter than
\r
894 * configMAX_TASK_NAME_LEN characters just in case the memory after the
\r
895 * string is not accessible (extremely unlikely). */
\r
896 if( pcName[ x ] == ( char ) 0x00 )
\r
902 mtCOVERAGE_TEST_MARKER();
\r
906 /* Ensure the name string is terminated in the case that the string length
\r
907 * was greater or equal to configMAX_TASK_NAME_LEN. */
\r
908 pxNewTCB->pcTaskName[ configMAX_TASK_NAME_LEN - 1 ] = '\0';
\r
912 mtCOVERAGE_TEST_MARKER();
\r
915 /* This is used as an array index so must ensure it's not too large. */
\r
916 configASSERT( uxPriority < configMAX_PRIORITIES );
\r
918 if( uxPriority >= ( UBaseType_t ) configMAX_PRIORITIES )
\r
920 uxPriority = ( UBaseType_t ) configMAX_PRIORITIES - ( UBaseType_t ) 1U;
\r
924 mtCOVERAGE_TEST_MARKER();
\r
927 pxNewTCB->uxPriority = uxPriority;
\r
928 #if ( configUSE_MUTEXES == 1 )
\r
930 pxNewTCB->uxBasePriority = uxPriority;
\r
932 #endif /* configUSE_MUTEXES */
\r
934 vListInitialiseItem( &( pxNewTCB->xStateListItem ) );
\r
935 vListInitialiseItem( &( pxNewTCB->xEventListItem ) );
\r
937 /* Set the pxNewTCB as a link back from the ListItem_t. This is so we can get
\r
938 * back to the containing TCB from a generic item in a list. */
\r
939 listSET_LIST_ITEM_OWNER( &( pxNewTCB->xStateListItem ), pxNewTCB );
\r
941 /* Event lists are always in priority order. */
\r
942 listSET_LIST_ITEM_VALUE( &( pxNewTCB->xEventListItem ), ( TickType_t ) configMAX_PRIORITIES - ( TickType_t ) uxPriority ); /*lint !e961 MISRA exception as the casts are only redundant for some ports. */
\r
943 listSET_LIST_ITEM_OWNER( &( pxNewTCB->xEventListItem ), pxNewTCB );
\r
945 #if ( portUSING_MPU_WRAPPERS == 1 )
\r
947 vPortStoreTaskMPUSettings( &( pxNewTCB->xMPUSettings ), xRegions, pxNewTCB->pxStack, ulStackDepth );
\r
951 /* Avoid compiler warning about unreferenced parameter. */
\r
956 #if ( ( configUSE_NEWLIB_REENTRANT == 1 ) || ( configUSE_C_RUNTIME_TLS_SUPPORT == 1 ) )
\r
958 /* Allocate and initialize memory for the task's TLS Block. */
\r
959 configINIT_TLS_BLOCK( pxNewTCB->xTLSBlock );
\r
963 /* Initialize the TCB stack to look as if the task was already running,
\r
964 * but had been interrupted by the scheduler. The return address is set
\r
965 * to the start of the task function. Once the stack has been initialised
\r
966 * the top of stack variable is updated. */
\r
967 #if ( portUSING_MPU_WRAPPERS == 1 )
\r
969 /* If the port has capability to detect stack overflow,
\r
970 * pass the stack end address to the stack initialization
\r
971 * function as well. */
\r
972 #if ( portHAS_STACK_OVERFLOW_CHECKING == 1 )
\r
974 #if ( portSTACK_GROWTH < 0 )
\r
976 pxNewTCB->pxTopOfStack = pxPortInitialiseStack( pxTopOfStack, pxNewTCB->pxStack, pxTaskCode, pvParameters, xRunPrivileged );
\r
978 #else /* portSTACK_GROWTH */
\r
980 pxNewTCB->pxTopOfStack = pxPortInitialiseStack( pxTopOfStack, pxNewTCB->pxEndOfStack, pxTaskCode, pvParameters, xRunPrivileged );
\r
982 #endif /* portSTACK_GROWTH */
\r
984 #else /* portHAS_STACK_OVERFLOW_CHECKING */
\r
986 pxNewTCB->pxTopOfStack = pxPortInitialiseStack( pxTopOfStack, pxTaskCode, pvParameters, xRunPrivileged );
\r
988 #endif /* portHAS_STACK_OVERFLOW_CHECKING */
\r
990 #else /* portUSING_MPU_WRAPPERS */
\r
992 /* If the port has capability to detect stack overflow,
\r
993 * pass the stack end address to the stack initialization
\r
994 * function as well. */
\r
995 #if ( portHAS_STACK_OVERFLOW_CHECKING == 1 )
\r
997 #if ( portSTACK_GROWTH < 0 )
\r
999 pxNewTCB->pxTopOfStack = pxPortInitialiseStack( pxTopOfStack, pxNewTCB->pxStack, pxTaskCode, pvParameters );
\r
1001 #else /* portSTACK_GROWTH */
\r
1003 pxNewTCB->pxTopOfStack = pxPortInitialiseStack( pxTopOfStack, pxNewTCB->pxEndOfStack, pxTaskCode, pvParameters );
\r
1005 #endif /* portSTACK_GROWTH */
\r
1007 #else /* portHAS_STACK_OVERFLOW_CHECKING */
\r
1009 pxNewTCB->pxTopOfStack = pxPortInitialiseStack( pxTopOfStack, pxTaskCode, pvParameters );
\r
1011 #endif /* portHAS_STACK_OVERFLOW_CHECKING */
\r
1013 #endif /* portUSING_MPU_WRAPPERS */
\r
1015 if( pxCreatedTask != NULL )
\r
1017 /* Pass the handle out in an anonymous way. The handle can be used to
\r
1018 * change the created task's priority, delete the created task, etc.*/
\r
1019 *pxCreatedTask = ( TaskHandle_t ) pxNewTCB;
\r
1023 mtCOVERAGE_TEST_MARKER();
\r
1026 /*-----------------------------------------------------------*/
\r
1028 static void prvAddNewTaskToReadyList( TCB_t * pxNewTCB )
\r
1030 /* Ensure interrupts don't access the task lists while the lists are being
\r
1032 taskENTER_CRITICAL();
\r
1034 uxCurrentNumberOfTasks++;
\r
1036 if( pxCurrentTCB == NULL )
\r
1038 /* There are no other tasks, or all the other tasks are in
\r
1039 * the suspended state - make this the current task. */
\r
1040 pxCurrentTCB = pxNewTCB;
\r
1042 if( uxCurrentNumberOfTasks == ( UBaseType_t ) 1 )
\r
1044 /* This is the first task to be created so do the preliminary
\r
1045 * initialisation required. We will not recover if this call
\r
1046 * fails, but we will report the failure. */
\r
1047 prvInitialiseTaskLists();
\r
1051 mtCOVERAGE_TEST_MARKER();
\r
1056 /* If the scheduler is not already running, make this task the
\r
1057 * current task if it is the highest priority task to be created
\r
1059 if( xSchedulerRunning == pdFALSE )
\r
1061 if( pxCurrentTCB->uxPriority <= pxNewTCB->uxPriority )
\r
1063 pxCurrentTCB = pxNewTCB;
\r
1067 mtCOVERAGE_TEST_MARKER();
\r
1072 mtCOVERAGE_TEST_MARKER();
\r
1078 #if ( configUSE_TRACE_FACILITY == 1 )
\r
1080 /* Add a counter into the TCB for tracing only. */
\r
1081 pxNewTCB->uxTCBNumber = uxTaskNumber;
\r
1083 #endif /* configUSE_TRACE_FACILITY */
\r
1084 traceTASK_CREATE( pxNewTCB );
\r
1086 prvAddTaskToReadyList( pxNewTCB );
\r
1088 portSETUP_TCB( pxNewTCB );
\r
1090 taskEXIT_CRITICAL();
\r
1092 if( xSchedulerRunning != pdFALSE )
\r
1094 /* If the created task is of a higher priority than the current task
\r
1095 * then it should run now. */
\r
1096 if( pxCurrentTCB->uxPriority < pxNewTCB->uxPriority )
\r
1098 taskYIELD_IF_USING_PREEMPTION();
\r
1102 mtCOVERAGE_TEST_MARKER();
\r
1107 mtCOVERAGE_TEST_MARKER();
\r
1110 /*-----------------------------------------------------------*/
\r
1112 #if ( INCLUDE_vTaskDelete == 1 )
\r
1114 void vTaskDelete( TaskHandle_t xTaskToDelete )
\r
1118 taskENTER_CRITICAL();
\r
1120 /* If null is passed in here then it is the calling task that is
\r
1121 * being deleted. */
\r
1122 pxTCB = prvGetTCBFromHandle( xTaskToDelete );
\r
1124 /* Remove task from the ready/delayed list. */
\r
1125 if( uxListRemove( &( pxTCB->xStateListItem ) ) == ( UBaseType_t ) 0 )
\r
1127 taskRESET_READY_PRIORITY( pxTCB->uxPriority );
\r
1131 mtCOVERAGE_TEST_MARKER();
\r
1134 /* Is the task waiting on an event also? */
\r
1135 if( listLIST_ITEM_CONTAINER( &( pxTCB->xEventListItem ) ) != NULL )
\r
1137 ( void ) uxListRemove( &( pxTCB->xEventListItem ) );
\r
1141 mtCOVERAGE_TEST_MARKER();
\r
1144 /* Increment the uxTaskNumber also so kernel aware debuggers can
\r
1145 * detect that the task lists need re-generating. This is done before
\r
1146 * portPRE_TASK_DELETE_HOOK() as in the Windows port that macro will
\r
1150 if( pxTCB == pxCurrentTCB )
\r
1152 /* A task is deleting itself. This cannot complete within the
\r
1153 * task itself, as a context switch to another task is required.
\r
1154 * Place the task in the termination list. The idle task will
\r
1155 * check the termination list and free up any memory allocated by
\r
1156 * the scheduler for the TCB and stack of the deleted task. */
\r
1157 vListInsertEnd( &xTasksWaitingTermination, &( pxTCB->xStateListItem ) );
\r
1159 /* Increment the ucTasksDeleted variable so the idle task knows
\r
1160 * there is a task that has been deleted and that it should therefore
\r
1161 * check the xTasksWaitingTermination list. */
\r
1162 ++uxDeletedTasksWaitingCleanUp;
\r
1164 /* Call the delete hook before portPRE_TASK_DELETE_HOOK() as
\r
1165 * portPRE_TASK_DELETE_HOOK() does not return in the Win32 port. */
\r
1166 traceTASK_DELETE( pxTCB );
\r
1168 /* The pre-delete hook is primarily for the Windows simulator,
\r
1169 * in which Windows specific clean up operations are performed,
\r
1170 * after which it is not possible to yield away from this task -
\r
1171 * hence xYieldPending is used to latch that a context switch is
\r
1173 portPRE_TASK_DELETE_HOOK( pxTCB, &xYieldPending );
\r
1177 --uxCurrentNumberOfTasks;
\r
1178 traceTASK_DELETE( pxTCB );
\r
1180 /* Reset the next expected unblock time in case it referred to
\r
1181 * the task that has just been deleted. */
\r
1182 prvResetNextTaskUnblockTime();
\r
1185 taskEXIT_CRITICAL();
\r
1187 /* If the task is not deleting itself, call prvDeleteTCB from outside of
\r
1188 * critical section. If a task deletes itself, prvDeleteTCB is called
\r
1189 * from prvCheckTasksWaitingTermination which is called from Idle task. */
\r
1190 if( pxTCB != pxCurrentTCB )
\r
1192 prvDeleteTCB( pxTCB );
\r
1195 /* Force a reschedule if it is the currently running task that has just
\r
1196 * been deleted. */
\r
1197 if( xSchedulerRunning != pdFALSE )
\r
1199 if( pxTCB == pxCurrentTCB )
\r
1201 configASSERT( uxSchedulerSuspended == 0 );
\r
1202 portYIELD_WITHIN_API();
\r
1206 mtCOVERAGE_TEST_MARKER();
\r
1211 #endif /* INCLUDE_vTaskDelete */
\r
1212 /*-----------------------------------------------------------*/
\r
1214 #if ( INCLUDE_xTaskDelayUntil == 1 )
\r
1216 BaseType_t xTaskDelayUntil( TickType_t * const pxPreviousWakeTime,
\r
1217 const TickType_t xTimeIncrement )
\r
1219 TickType_t xTimeToWake;
\r
1220 BaseType_t xAlreadyYielded, xShouldDelay = pdFALSE;
\r
1222 configASSERT( pxPreviousWakeTime );
\r
1223 configASSERT( ( xTimeIncrement > 0U ) );
\r
1224 configASSERT( uxSchedulerSuspended == 0 );
\r
1226 vTaskSuspendAll();
\r
1228 /* Minor optimisation. The tick count cannot change in this
\r
1230 const TickType_t xConstTickCount = xTickCount;
\r
1232 /* Generate the tick time at which the task wants to wake. */
\r
1233 xTimeToWake = *pxPreviousWakeTime + xTimeIncrement;
\r
1235 if( xConstTickCount < *pxPreviousWakeTime )
\r
1237 /* The tick count has overflowed since this function was
\r
1238 * lasted called. In this case the only time we should ever
\r
1239 * actually delay is if the wake time has also overflowed,
\r
1240 * and the wake time is greater than the tick time. When this
\r
1241 * is the case it is as if neither time had overflowed. */
\r
1242 if( ( xTimeToWake < *pxPreviousWakeTime ) && ( xTimeToWake > xConstTickCount ) )
\r
1244 xShouldDelay = pdTRUE;
\r
1248 mtCOVERAGE_TEST_MARKER();
\r
1253 /* The tick time has not overflowed. In this case we will
\r
1254 * delay if either the wake time has overflowed, and/or the
\r
1255 * tick time is less than the wake time. */
\r
1256 if( ( xTimeToWake < *pxPreviousWakeTime ) || ( xTimeToWake > xConstTickCount ) )
\r
1258 xShouldDelay = pdTRUE;
\r
1262 mtCOVERAGE_TEST_MARKER();
\r
1266 /* Update the wake time ready for the next call. */
\r
1267 *pxPreviousWakeTime = xTimeToWake;
\r
1269 if( xShouldDelay != pdFALSE )
\r
1271 traceTASK_DELAY_UNTIL( xTimeToWake );
\r
1273 /* prvAddCurrentTaskToDelayedList() needs the block time, not
\r
1274 * the time to wake, so subtract the current tick count. */
\r
1275 prvAddCurrentTaskToDelayedList( xTimeToWake - xConstTickCount, pdFALSE );
\r
1279 mtCOVERAGE_TEST_MARKER();
\r
1282 xAlreadyYielded = xTaskResumeAll();
\r
1284 /* Force a reschedule if xTaskResumeAll has not already done so, we may
\r
1285 * have put ourselves to sleep. */
\r
1286 if( xAlreadyYielded == pdFALSE )
\r
1288 portYIELD_WITHIN_API();
\r
1292 mtCOVERAGE_TEST_MARKER();
\r
1295 return xShouldDelay;
\r
1298 #endif /* INCLUDE_xTaskDelayUntil */
\r
1299 /*-----------------------------------------------------------*/
\r
1301 #if ( INCLUDE_vTaskDelay == 1 )
\r
1303 void vTaskDelay( const TickType_t xTicksToDelay )
\r
1305 BaseType_t xAlreadyYielded = pdFALSE;
\r
1307 /* A delay time of zero just forces a reschedule. */
\r
1308 if( xTicksToDelay > ( TickType_t ) 0U )
\r
1310 configASSERT( uxSchedulerSuspended == 0 );
\r
1311 vTaskSuspendAll();
\r
1313 traceTASK_DELAY();
\r
1315 /* A task that is removed from the event list while the
\r
1316 * scheduler is suspended will not get placed in the ready
\r
1317 * list or removed from the blocked list until the scheduler
\r
1320 * This task cannot be in an event list as it is the currently
\r
1321 * executing task. */
\r
1322 prvAddCurrentTaskToDelayedList( xTicksToDelay, pdFALSE );
\r
1324 xAlreadyYielded = xTaskResumeAll();
\r
1328 mtCOVERAGE_TEST_MARKER();
\r
1331 /* Force a reschedule if xTaskResumeAll has not already done so, we may
\r
1332 * have put ourselves to sleep. */
\r
1333 if( xAlreadyYielded == pdFALSE )
\r
1335 portYIELD_WITHIN_API();
\r
1339 mtCOVERAGE_TEST_MARKER();
\r
1343 #endif /* INCLUDE_vTaskDelay */
\r
1344 /*-----------------------------------------------------------*/
\r
1346 #if ( ( INCLUDE_eTaskGetState == 1 ) || ( configUSE_TRACE_FACILITY == 1 ) || ( INCLUDE_xTaskAbortDelay == 1 ) )
\r
1348 eTaskState eTaskGetState( TaskHandle_t xTask )
\r
1350 eTaskState eReturn;
\r
1351 List_t const * pxStateList, * pxDelayedList, * pxOverflowedDelayedList;
\r
1352 const TCB_t * const pxTCB = xTask;
\r
1354 configASSERT( pxTCB );
\r
1356 if( pxTCB == pxCurrentTCB )
\r
1358 /* The task calling this function is querying its own state. */
\r
1359 eReturn = eRunning;
\r
1363 taskENTER_CRITICAL();
\r
1365 pxStateList = listLIST_ITEM_CONTAINER( &( pxTCB->xStateListItem ) );
\r
1366 pxDelayedList = pxDelayedTaskList;
\r
1367 pxOverflowedDelayedList = pxOverflowDelayedTaskList;
\r
1369 taskEXIT_CRITICAL();
\r
1371 if( ( pxStateList == pxDelayedList ) || ( pxStateList == pxOverflowedDelayedList ) )
\r
1373 /* The task being queried is referenced from one of the Blocked
\r
1375 eReturn = eBlocked;
\r
1378 #if ( INCLUDE_vTaskSuspend == 1 )
\r
1379 else if( pxStateList == &xSuspendedTaskList )
\r
1381 /* The task being queried is referenced from the suspended
\r
1382 * list. Is it genuinely suspended or is it blocked
\r
1383 * indefinitely? */
\r
1384 if( listLIST_ITEM_CONTAINER( &( pxTCB->xEventListItem ) ) == NULL )
\r
1386 #if ( configUSE_TASK_NOTIFICATIONS == 1 )
\r
1390 /* The task does not appear on the event list item of
\r
1391 * and of the RTOS objects, but could still be in the
\r
1392 * blocked state if it is waiting on its notification
\r
1393 * rather than waiting on an object. If not, is
\r
1395 eReturn = eSuspended;
\r
1397 for( x = 0; x < configTASK_NOTIFICATION_ARRAY_ENTRIES; x++ )
\r
1399 if( pxTCB->ucNotifyState[ x ] == taskWAITING_NOTIFICATION )
\r
1401 eReturn = eBlocked;
\r
1406 #else /* if ( configUSE_TASK_NOTIFICATIONS == 1 ) */
\r
1408 eReturn = eSuspended;
\r
1410 #endif /* if ( configUSE_TASK_NOTIFICATIONS == 1 ) */
\r
1414 eReturn = eBlocked;
\r
1417 #endif /* if ( INCLUDE_vTaskSuspend == 1 ) */
\r
1419 #if ( INCLUDE_vTaskDelete == 1 )
\r
1420 else if( ( pxStateList == &xTasksWaitingTermination ) || ( pxStateList == NULL ) )
\r
1422 /* The task being queried is referenced from the deleted
\r
1423 * tasks list, or it is not referenced from any lists at
\r
1425 eReturn = eDeleted;
\r
1429 else /*lint !e525 Negative indentation is intended to make use of pre-processor clearer. */
\r
1431 /* If the task is not in any other state, it must be in the
\r
1432 * Ready (including pending ready) state. */
\r
1438 } /*lint !e818 xTask cannot be a pointer to const because it is a typedef. */
\r
1440 #endif /* INCLUDE_eTaskGetState */
\r
1441 /*-----------------------------------------------------------*/
\r
1443 #if ( INCLUDE_uxTaskPriorityGet == 1 )
\r
1445 UBaseType_t uxTaskPriorityGet( const TaskHandle_t xTask )
\r
1447 TCB_t const * pxTCB;
\r
1448 UBaseType_t uxReturn;
\r
1450 taskENTER_CRITICAL();
\r
1452 /* If null is passed in here then it is the priority of the task
\r
1453 * that called uxTaskPriorityGet() that is being queried. */
\r
1454 pxTCB = prvGetTCBFromHandle( xTask );
\r
1455 uxReturn = pxTCB->uxPriority;
\r
1457 taskEXIT_CRITICAL();
\r
1462 #endif /* INCLUDE_uxTaskPriorityGet */
\r
1463 /*-----------------------------------------------------------*/
\r
1465 #if ( INCLUDE_uxTaskPriorityGet == 1 )
\r
1467 UBaseType_t uxTaskPriorityGetFromISR( const TaskHandle_t xTask )
\r
1469 TCB_t const * pxTCB;
\r
1470 UBaseType_t uxReturn, uxSavedInterruptState;
\r
1472 /* RTOS ports that support interrupt nesting have the concept of a
\r
1473 * maximum system call (or maximum API call) interrupt priority.
\r
1474 * Interrupts that are above the maximum system call priority are keep
\r
1475 * permanently enabled, even when the RTOS kernel is in a critical section,
\r
1476 * but cannot make any calls to FreeRTOS API functions. If configASSERT()
\r
1477 * is defined in FreeRTOSConfig.h then
\r
1478 * portASSERT_IF_INTERRUPT_PRIORITY_INVALID() will result in an assertion
\r
1479 * failure if a FreeRTOS API function is called from an interrupt that has
\r
1480 * been assigned a priority above the configured maximum system call
\r
1481 * priority. Only FreeRTOS functions that end in FromISR can be called
\r
1482 * from interrupts that have been assigned a priority at or (logically)
\r
1483 * below the maximum system call interrupt priority. FreeRTOS maintains a
\r
1484 * separate interrupt safe API to ensure interrupt entry is as fast and as
\r
1485 * simple as possible. More information (albeit Cortex-M specific) is
\r
1486 * provided on the following link:
\r
1487 * https://www.FreeRTOS.org/RTOS-Cortex-M3-M4.html */
\r
1488 portASSERT_IF_INTERRUPT_PRIORITY_INVALID();
\r
1490 uxSavedInterruptState = portSET_INTERRUPT_MASK_FROM_ISR();
\r
1492 /* If null is passed in here then it is the priority of the calling
\r
1493 * task that is being queried. */
\r
1494 pxTCB = prvGetTCBFromHandle( xTask );
\r
1495 uxReturn = pxTCB->uxPriority;
\r
1497 portCLEAR_INTERRUPT_MASK_FROM_ISR( uxSavedInterruptState );
\r
1502 #endif /* INCLUDE_uxTaskPriorityGet */
\r
1503 /*-----------------------------------------------------------*/
\r
1505 #if ( INCLUDE_vTaskPrioritySet == 1 )
\r
1507 void vTaskPrioritySet( TaskHandle_t xTask,
\r
1508 UBaseType_t uxNewPriority )
\r
1511 UBaseType_t uxCurrentBasePriority, uxPriorityUsedOnEntry;
\r
1512 BaseType_t xYieldRequired = pdFALSE;
\r
1514 configASSERT( uxNewPriority < configMAX_PRIORITIES );
\r
1516 /* Ensure the new priority is valid. */
\r
1517 if( uxNewPriority >= ( UBaseType_t ) configMAX_PRIORITIES )
\r
1519 uxNewPriority = ( UBaseType_t ) configMAX_PRIORITIES - ( UBaseType_t ) 1U;
\r
1523 mtCOVERAGE_TEST_MARKER();
\r
1526 taskENTER_CRITICAL();
\r
1528 /* If null is passed in here then it is the priority of the calling
\r
1529 * task that is being changed. */
\r
1530 pxTCB = prvGetTCBFromHandle( xTask );
\r
1532 traceTASK_PRIORITY_SET( pxTCB, uxNewPriority );
\r
1534 #if ( configUSE_MUTEXES == 1 )
\r
1536 uxCurrentBasePriority = pxTCB->uxBasePriority;
\r
1540 uxCurrentBasePriority = pxTCB->uxPriority;
\r
1544 if( uxCurrentBasePriority != uxNewPriority )
\r
1546 /* The priority change may have readied a task of higher
\r
1547 * priority than the calling task. */
\r
1548 if( uxNewPriority > uxCurrentBasePriority )
\r
1550 if( pxTCB != pxCurrentTCB )
\r
1552 /* The priority of a task other than the currently
\r
1553 * running task is being raised. Is the priority being
\r
1554 * raised above that of the running task? */
\r
1555 if( uxNewPriority >= pxCurrentTCB->uxPriority )
\r
1557 xYieldRequired = pdTRUE;
\r
1561 mtCOVERAGE_TEST_MARKER();
\r
1566 /* The priority of the running task is being raised,
\r
1567 * but the running task must already be the highest
\r
1568 * priority task able to run so no yield is required. */
\r
1571 else if( pxTCB == pxCurrentTCB )
\r
1573 /* Setting the priority of the running task down means
\r
1574 * there may now be another task of higher priority that
\r
1575 * is ready to execute. */
\r
1576 xYieldRequired = pdTRUE;
\r
1580 /* Setting the priority of any other task down does not
\r
1581 * require a yield as the running task must be above the
\r
1582 * new priority of the task being modified. */
\r
1585 /* Remember the ready list the task might be referenced from
\r
1586 * before its uxPriority member is changed so the
\r
1587 * taskRESET_READY_PRIORITY() macro can function correctly. */
\r
1588 uxPriorityUsedOnEntry = pxTCB->uxPriority;
\r
1590 #if ( configUSE_MUTEXES == 1 )
\r
1592 /* Only change the priority being used if the task is not
\r
1593 * currently using an inherited priority. */
\r
1594 if( pxTCB->uxBasePriority == pxTCB->uxPriority )
\r
1596 pxTCB->uxPriority = uxNewPriority;
\r
1600 mtCOVERAGE_TEST_MARKER();
\r
1603 /* The base priority gets set whatever. */
\r
1604 pxTCB->uxBasePriority = uxNewPriority;
\r
1606 #else /* if ( configUSE_MUTEXES == 1 ) */
\r
1608 pxTCB->uxPriority = uxNewPriority;
\r
1610 #endif /* if ( configUSE_MUTEXES == 1 ) */
\r
1612 /* Only reset the event list item value if the value is not
\r
1613 * being used for anything else. */
\r
1614 if( ( listGET_LIST_ITEM_VALUE( &( pxTCB->xEventListItem ) ) & taskEVENT_LIST_ITEM_VALUE_IN_USE ) == 0UL )
\r
1616 listSET_LIST_ITEM_VALUE( &( pxTCB->xEventListItem ), ( ( TickType_t ) configMAX_PRIORITIES - ( TickType_t ) uxNewPriority ) ); /*lint !e961 MISRA exception as the casts are only redundant for some ports. */
\r
1620 mtCOVERAGE_TEST_MARKER();
\r
1623 /* If the task is in the blocked or suspended list we need do
\r
1624 * nothing more than change its priority variable. However, if
\r
1625 * the task is in a ready list it needs to be removed and placed
\r
1626 * in the list appropriate to its new priority. */
\r
1627 if( listIS_CONTAINED_WITHIN( &( pxReadyTasksLists[ uxPriorityUsedOnEntry ] ), &( pxTCB->xStateListItem ) ) != pdFALSE )
\r
1629 /* The task is currently in its ready list - remove before
\r
1630 * adding it to its new ready list. As we are in a critical
\r
1631 * section we can do this even if the scheduler is suspended. */
\r
1632 if( uxListRemove( &( pxTCB->xStateListItem ) ) == ( UBaseType_t ) 0 )
\r
1634 /* It is known that the task is in its ready list so
\r
1635 * there is no need to check again and the port level
\r
1636 * reset macro can be called directly. */
\r
1637 portRESET_READY_PRIORITY( uxPriorityUsedOnEntry, uxTopReadyPriority );
\r
1641 mtCOVERAGE_TEST_MARKER();
\r
1644 prvAddTaskToReadyList( pxTCB );
\r
1648 mtCOVERAGE_TEST_MARKER();
\r
1651 if( xYieldRequired != pdFALSE )
\r
1653 taskYIELD_IF_USING_PREEMPTION();
\r
1657 mtCOVERAGE_TEST_MARKER();
\r
1660 /* Remove compiler warning about unused variables when the port
\r
1661 * optimised task selection is not being used. */
\r
1662 ( void ) uxPriorityUsedOnEntry;
\r
1665 taskEXIT_CRITICAL();
\r
1668 #endif /* INCLUDE_vTaskPrioritySet */
\r
1669 /*-----------------------------------------------------------*/
\r
1671 #if ( INCLUDE_vTaskSuspend == 1 )
\r
1673 void vTaskSuspend( TaskHandle_t xTaskToSuspend )
\r
1677 taskENTER_CRITICAL();
\r
1679 /* If null is passed in here then it is the running task that is
\r
1680 * being suspended. */
\r
1681 pxTCB = prvGetTCBFromHandle( xTaskToSuspend );
\r
1683 traceTASK_SUSPEND( pxTCB );
\r
1685 /* Remove task from the ready/delayed list and place in the
\r
1686 * suspended list. */
\r
1687 if( uxListRemove( &( pxTCB->xStateListItem ) ) == ( UBaseType_t ) 0 )
\r
1689 taskRESET_READY_PRIORITY( pxTCB->uxPriority );
\r
1693 mtCOVERAGE_TEST_MARKER();
\r
1696 /* Is the task waiting on an event also? */
\r
1697 if( listLIST_ITEM_CONTAINER( &( pxTCB->xEventListItem ) ) != NULL )
\r
1699 ( void ) uxListRemove( &( pxTCB->xEventListItem ) );
\r
1703 mtCOVERAGE_TEST_MARKER();
\r
1706 vListInsertEnd( &xSuspendedTaskList, &( pxTCB->xStateListItem ) );
\r
1708 #if ( configUSE_TASK_NOTIFICATIONS == 1 )
\r
1712 for( x = 0; x < configTASK_NOTIFICATION_ARRAY_ENTRIES; x++ )
\r
1714 if( pxTCB->ucNotifyState[ x ] == taskWAITING_NOTIFICATION )
\r
1716 /* The task was blocked to wait for a notification, but is
\r
1717 * now suspended, so no notification was received. */
\r
1718 pxTCB->ucNotifyState[ x ] = taskNOT_WAITING_NOTIFICATION;
\r
1722 #endif /* if ( configUSE_TASK_NOTIFICATIONS == 1 ) */
\r
1724 taskEXIT_CRITICAL();
\r
1726 if( xSchedulerRunning != pdFALSE )
\r
1728 /* Reset the next expected unblock time in case it referred to the
\r
1729 * task that is now in the Suspended state. */
\r
1730 taskENTER_CRITICAL();
\r
1732 prvResetNextTaskUnblockTime();
\r
1734 taskEXIT_CRITICAL();
\r
1738 mtCOVERAGE_TEST_MARKER();
\r
1741 if( pxTCB == pxCurrentTCB )
\r
1743 if( xSchedulerRunning != pdFALSE )
\r
1745 /* The current task has just been suspended. */
\r
1746 configASSERT( uxSchedulerSuspended == 0 );
\r
1747 portYIELD_WITHIN_API();
\r
1751 /* The scheduler is not running, but the task that was pointed
\r
1752 * to by pxCurrentTCB has just been suspended and pxCurrentTCB
\r
1753 * must be adjusted to point to a different task. */
\r
1754 if( listCURRENT_LIST_LENGTH( &xSuspendedTaskList ) == uxCurrentNumberOfTasks ) /*lint !e931 Right has no side effect, just volatile. */
\r
1756 /* No other tasks are ready, so set pxCurrentTCB back to
\r
1757 * NULL so when the next task is created pxCurrentTCB will
\r
1758 * be set to point to it no matter what its relative priority
\r
1760 pxCurrentTCB = NULL;
\r
1764 vTaskSwitchContext();
\r
1770 mtCOVERAGE_TEST_MARKER();
\r
1774 #endif /* INCLUDE_vTaskSuspend */
\r
1775 /*-----------------------------------------------------------*/
\r
1777 #if ( INCLUDE_vTaskSuspend == 1 )
\r
1779 static BaseType_t prvTaskIsTaskSuspended( const TaskHandle_t xTask )
\r
1781 BaseType_t xReturn = pdFALSE;
\r
1782 const TCB_t * const pxTCB = xTask;
\r
1784 /* Accesses xPendingReadyList so must be called from a critical
\r
1787 /* It does not make sense to check if the calling task is suspended. */
\r
1788 configASSERT( xTask );
\r
1790 /* Is the task being resumed actually in the suspended list? */
\r
1791 if( listIS_CONTAINED_WITHIN( &xSuspendedTaskList, &( pxTCB->xStateListItem ) ) != pdFALSE )
\r
1793 /* Has the task already been resumed from within an ISR? */
\r
1794 if( listIS_CONTAINED_WITHIN( &xPendingReadyList, &( pxTCB->xEventListItem ) ) == pdFALSE )
\r
1796 /* Is it in the suspended list because it is in the Suspended
\r
1797 * state, or because is is blocked with no timeout? */
\r
1798 if( listIS_CONTAINED_WITHIN( NULL, &( pxTCB->xEventListItem ) ) != pdFALSE ) /*lint !e961. The cast is only redundant when NULL is used. */
\r
1804 mtCOVERAGE_TEST_MARKER();
\r
1809 mtCOVERAGE_TEST_MARKER();
\r
1814 mtCOVERAGE_TEST_MARKER();
\r
1818 } /*lint !e818 xTask cannot be a pointer to const because it is a typedef. */
\r
1820 #endif /* INCLUDE_vTaskSuspend */
\r
1821 /*-----------------------------------------------------------*/
\r
1823 #if ( INCLUDE_vTaskSuspend == 1 )
\r
1825 void vTaskResume( TaskHandle_t xTaskToResume )
\r
1827 TCB_t * const pxTCB = xTaskToResume;
\r
1829 /* It does not make sense to resume the calling task. */
\r
1830 configASSERT( xTaskToResume );
\r
1832 /* The parameter cannot be NULL as it is impossible to resume the
\r
1833 * currently executing task. */
\r
1834 if( ( pxTCB != pxCurrentTCB ) && ( pxTCB != NULL ) )
\r
1836 taskENTER_CRITICAL();
\r
1838 if( prvTaskIsTaskSuspended( pxTCB ) != pdFALSE )
\r
1840 traceTASK_RESUME( pxTCB );
\r
1842 /* The ready list can be accessed even if the scheduler is
\r
1843 * suspended because this is inside a critical section. */
\r
1844 ( void ) uxListRemove( &( pxTCB->xStateListItem ) );
\r
1845 prvAddTaskToReadyList( pxTCB );
\r
1847 /* A higher priority task may have just been resumed. */
\r
1848 if( pxTCB->uxPriority >= pxCurrentTCB->uxPriority )
\r
1850 /* This yield may not cause the task just resumed to run,
\r
1851 * but will leave the lists in the correct state for the
\r
1853 taskYIELD_IF_USING_PREEMPTION();
\r
1857 mtCOVERAGE_TEST_MARKER();
\r
1862 mtCOVERAGE_TEST_MARKER();
\r
1865 taskEXIT_CRITICAL();
\r
1869 mtCOVERAGE_TEST_MARKER();
\r
1873 #endif /* INCLUDE_vTaskSuspend */
\r
1875 /*-----------------------------------------------------------*/
\r
1877 #if ( ( INCLUDE_xTaskResumeFromISR == 1 ) && ( INCLUDE_vTaskSuspend == 1 ) )
\r
1879 BaseType_t xTaskResumeFromISR( TaskHandle_t xTaskToResume )
\r
1881 BaseType_t xYieldRequired = pdFALSE;
\r
1882 TCB_t * const pxTCB = xTaskToResume;
\r
1883 UBaseType_t uxSavedInterruptStatus;
\r
1885 configASSERT( xTaskToResume );
\r
1887 /* RTOS ports that support interrupt nesting have the concept of a
\r
1888 * maximum system call (or maximum API call) interrupt priority.
\r
1889 * Interrupts that are above the maximum system call priority are keep
\r
1890 * permanently enabled, even when the RTOS kernel is in a critical section,
\r
1891 * but cannot make any calls to FreeRTOS API functions. If configASSERT()
\r
1892 * is defined in FreeRTOSConfig.h then
\r
1893 * portASSERT_IF_INTERRUPT_PRIORITY_INVALID() will result in an assertion
\r
1894 * failure if a FreeRTOS API function is called from an interrupt that has
\r
1895 * been assigned a priority above the configured maximum system call
\r
1896 * priority. Only FreeRTOS functions that end in FromISR can be called
\r
1897 * from interrupts that have been assigned a priority at or (logically)
\r
1898 * below the maximum system call interrupt priority. FreeRTOS maintains a
\r
1899 * separate interrupt safe API to ensure interrupt entry is as fast and as
\r
1900 * simple as possible. More information (albeit Cortex-M specific) is
\r
1901 * provided on the following link:
\r
1902 * https://www.FreeRTOS.org/RTOS-Cortex-M3-M4.html */
\r
1903 portASSERT_IF_INTERRUPT_PRIORITY_INVALID();
\r
1905 uxSavedInterruptStatus = portSET_INTERRUPT_MASK_FROM_ISR();
\r
1907 if( prvTaskIsTaskSuspended( pxTCB ) != pdFALSE )
\r
1909 traceTASK_RESUME_FROM_ISR( pxTCB );
\r
1911 /* Check the ready lists can be accessed. */
\r
1912 if( uxSchedulerSuspended == ( UBaseType_t ) pdFALSE )
\r
1914 /* Ready lists can be accessed so move the task from the
\r
1915 * suspended list to the ready list directly. */
\r
1916 if( pxTCB->uxPriority >= pxCurrentTCB->uxPriority )
\r
1918 xYieldRequired = pdTRUE;
\r
1920 /* Mark that a yield is pending in case the user is not
\r
1921 * using the return value to initiate a context switch
\r
1922 * from the ISR using portYIELD_FROM_ISR. */
\r
1923 xYieldPending = pdTRUE;
\r
1927 mtCOVERAGE_TEST_MARKER();
\r
1930 ( void ) uxListRemove( &( pxTCB->xStateListItem ) );
\r
1931 prvAddTaskToReadyList( pxTCB );
\r
1935 /* The delayed or ready lists cannot be accessed so the task
\r
1936 * is held in the pending ready list until the scheduler is
\r
1938 vListInsertEnd( &( xPendingReadyList ), &( pxTCB->xEventListItem ) );
\r
1943 mtCOVERAGE_TEST_MARKER();
\r
1946 portCLEAR_INTERRUPT_MASK_FROM_ISR( uxSavedInterruptStatus );
\r
1948 return xYieldRequired;
\r
1951 #endif /* ( ( INCLUDE_xTaskResumeFromISR == 1 ) && ( INCLUDE_vTaskSuspend == 1 ) ) */
\r
1952 /*-----------------------------------------------------------*/
\r
1954 void vTaskStartScheduler( void )
\r
1956 BaseType_t xReturn;
\r
1958 /* Add the idle task at the lowest priority. */
\r
1959 #if ( configSUPPORT_STATIC_ALLOCATION == 1 )
\r
1961 StaticTask_t * pxIdleTaskTCBBuffer = NULL;
\r
1962 StackType_t * pxIdleTaskStackBuffer = NULL;
\r
1963 uint32_t ulIdleTaskStackSize;
\r
1965 /* The Idle task is created using user provided RAM - obtain the
\r
1966 * address of the RAM then create the idle task. */
\r
1967 vApplicationGetIdleTaskMemory( &pxIdleTaskTCBBuffer, &pxIdleTaskStackBuffer, &ulIdleTaskStackSize );
\r
1968 xIdleTaskHandle = xTaskCreateStatic( prvIdleTask,
\r
1969 configIDLE_TASK_NAME,
\r
1970 ulIdleTaskStackSize,
\r
1971 ( void * ) NULL, /*lint !e961. The cast is not redundant for all compilers. */
\r
1972 portPRIVILEGE_BIT, /* In effect ( tskIDLE_PRIORITY | portPRIVILEGE_BIT ), but tskIDLE_PRIORITY is zero. */
\r
1973 pxIdleTaskStackBuffer,
\r
1974 pxIdleTaskTCBBuffer ); /*lint !e961 MISRA exception, justified as it is not a redundant explicit cast to all supported compilers. */
\r
1976 if( xIdleTaskHandle != NULL )
\r
1985 #else /* if ( configSUPPORT_STATIC_ALLOCATION == 1 ) */
\r
1987 /* The Idle task is being created using dynamically allocated RAM. */
\r
1988 xReturn = xTaskCreate( prvIdleTask,
\r
1989 configIDLE_TASK_NAME,
\r
1990 configMINIMAL_STACK_SIZE,
\r
1992 portPRIVILEGE_BIT, /* In effect ( tskIDLE_PRIORITY | portPRIVILEGE_BIT ), but tskIDLE_PRIORITY is zero. */
\r
1993 &xIdleTaskHandle ); /*lint !e961 MISRA exception, justified as it is not a redundant explicit cast to all supported compilers. */
\r
1995 #endif /* configSUPPORT_STATIC_ALLOCATION */
\r
1997 #if ( configUSE_TIMERS == 1 )
\r
1999 if( xReturn == pdPASS )
\r
2001 xReturn = xTimerCreateTimerTask();
\r
2005 mtCOVERAGE_TEST_MARKER();
\r
2008 #endif /* configUSE_TIMERS */
\r
2010 if( xReturn == pdPASS )
\r
2012 /* freertos_tasks_c_additions_init() should only be called if the user
\r
2013 * definable macro FREERTOS_TASKS_C_ADDITIONS_INIT() is defined, as that is
\r
2014 * the only macro called by the function. */
\r
2015 #ifdef FREERTOS_TASKS_C_ADDITIONS_INIT
\r
2017 freertos_tasks_c_additions_init();
\r
2021 /* Interrupts are turned off here, to ensure a tick does not occur
\r
2022 * before or during the call to xPortStartScheduler(). The stacks of
\r
2023 * the created tasks contain a status word with interrupts switched on
\r
2024 * so interrupts will automatically get re-enabled when the first task
\r
2025 * starts to run. */
\r
2026 portDISABLE_INTERRUPTS();
\r
2028 #if ( ( configUSE_NEWLIB_REENTRANT == 1 ) || ( configUSE_C_RUNTIME_TLS_SUPPORT == 1 ) )
\r
2030 /* Switch C-Runtime's TLS Block to point to the TLS
\r
2031 * block specific to the task that will run first. */
\r
2032 configSET_TLS_BLOCK( pxCurrentTCB->xTLSBlock );
\r
2036 xNextTaskUnblockTime = portMAX_DELAY;
\r
2037 xSchedulerRunning = pdTRUE;
\r
2038 xTickCount = ( TickType_t ) configINITIAL_TICK_COUNT;
\r
2040 /* If configGENERATE_RUN_TIME_STATS is defined then the following
\r
2041 * macro must be defined to configure the timer/counter used to generate
\r
2042 * the run time counter time base. NOTE: If configGENERATE_RUN_TIME_STATS
\r
2043 * is set to 0 and the following line fails to build then ensure you do not
\r
2044 * have portCONFIGURE_TIMER_FOR_RUN_TIME_STATS() defined in your
\r
2045 * FreeRTOSConfig.h file. */
\r
2046 portCONFIGURE_TIMER_FOR_RUN_TIME_STATS();
\r
2048 traceTASK_SWITCHED_IN();
\r
2050 /* Setting up the timer tick is hardware specific and thus in the
\r
2051 * portable interface. */
\r
2052 xPortStartScheduler();
\r
2054 /* In most cases, xPortStartScheduler() will not return. If it
\r
2055 * returns pdTRUE then there was not enough heap memory available
\r
2056 * to create either the Idle or the Timer task. If it returned
\r
2057 * pdFALSE, then the application called xTaskEndScheduler().
\r
2058 * Most ports don't implement xTaskEndScheduler() as there is
\r
2059 * nothing to return to. */
\r
2063 /* This line will only be reached if the kernel could not be started,
\r
2064 * because there was not enough FreeRTOS heap to create the idle task
\r
2065 * or the timer task. */
\r
2066 configASSERT( xReturn != errCOULD_NOT_ALLOCATE_REQUIRED_MEMORY );
\r
2069 /* Prevent compiler warnings if INCLUDE_xTaskGetIdleTaskHandle is set to 0,
\r
2070 * meaning xIdleTaskHandle is not used anywhere else. */
\r
2071 ( void ) xIdleTaskHandle;
\r
2073 /* OpenOCD makes use of uxTopUsedPriority for thread debugging. Prevent uxTopUsedPriority
\r
2074 * from getting optimized out as it is no longer used by the kernel. */
\r
2075 ( void ) uxTopUsedPriority;
\r
2077 /*-----------------------------------------------------------*/
\r
2079 void vTaskEndScheduler( void )
\r
2081 /* Stop the scheduler interrupts and call the portable scheduler end
\r
2082 * routine so the original ISRs can be restored if necessary. The port
\r
2083 * layer must ensure interrupts enable bit is left in the correct state. */
\r
2084 portDISABLE_INTERRUPTS();
\r
2085 xSchedulerRunning = pdFALSE;
\r
2086 vPortEndScheduler();
\r
2088 /*----------------------------------------------------------*/
\r
2090 void vTaskSuspendAll( void )
\r
2092 /* A critical section is not required as the variable is of type
\r
2093 * BaseType_t. Please read Richard Barry's reply in the following link to a
\r
2094 * post in the FreeRTOS support forum before reporting this as a bug! -
\r
2095 * https://goo.gl/wu4acr */
\r
2097 /* portSOFTWARE_BARRIER() is only implemented for emulated/simulated ports that
\r
2098 * do not otherwise exhibit real time behaviour. */
\r
2099 portSOFTWARE_BARRIER();
\r
2101 /* The scheduler is suspended if uxSchedulerSuspended is non-zero. An increment
\r
2102 * is used to allow calls to vTaskSuspendAll() to nest. */
\r
2103 ++uxSchedulerSuspended;
\r
2105 /* Enforces ordering for ports and optimised compilers that may otherwise place
\r
2106 * the above increment elsewhere. */
\r
2107 portMEMORY_BARRIER();
\r
2109 /*----------------------------------------------------------*/
\r
2111 #if ( configUSE_TICKLESS_IDLE != 0 )
\r
2113 static TickType_t prvGetExpectedIdleTime( void )
\r
2115 TickType_t xReturn;
\r
2116 UBaseType_t uxHigherPriorityReadyTasks = pdFALSE;
\r
2118 /* uxHigherPriorityReadyTasks takes care of the case where
\r
2119 * configUSE_PREEMPTION is 0, so there may be tasks above the idle priority
\r
2120 * task that are in the Ready state, even though the idle task is
\r
2122 #if ( configUSE_PORT_OPTIMISED_TASK_SELECTION == 0 )
\r
2124 if( uxTopReadyPriority > tskIDLE_PRIORITY )
\r
2126 uxHigherPriorityReadyTasks = pdTRUE;
\r
2131 const UBaseType_t uxLeastSignificantBit = ( UBaseType_t ) 0x01;
\r
2133 /* When port optimised task selection is used the uxTopReadyPriority
\r
2134 * variable is used as a bit map. If bits other than the least
\r
2135 * significant bit are set then there are tasks that have a priority
\r
2136 * above the idle priority that are in the Ready state. This takes
\r
2137 * care of the case where the co-operative scheduler is in use. */
\r
2138 if( uxTopReadyPriority > uxLeastSignificantBit )
\r
2140 uxHigherPriorityReadyTasks = pdTRUE;
\r
2143 #endif /* if ( configUSE_PORT_OPTIMISED_TASK_SELECTION == 0 ) */
\r
2145 if( pxCurrentTCB->uxPriority > tskIDLE_PRIORITY )
\r
2149 else if( listCURRENT_LIST_LENGTH( &( pxReadyTasksLists[ tskIDLE_PRIORITY ] ) ) > 1 )
\r
2151 /* There are other idle priority tasks in the ready state. If
\r
2152 * time slicing is used then the very next tick interrupt must be
\r
2156 else if( uxHigherPriorityReadyTasks != pdFALSE )
\r
2158 /* There are tasks in the Ready state that have a priority above the
\r
2159 * idle priority. This path can only be reached if
\r
2160 * configUSE_PREEMPTION is 0. */
\r
2165 xReturn = xNextTaskUnblockTime - xTickCount;
\r
2171 #endif /* configUSE_TICKLESS_IDLE */
\r
2172 /*----------------------------------------------------------*/
\r
2174 BaseType_t xTaskResumeAll( void )
\r
2176 TCB_t * pxTCB = NULL;
\r
2177 BaseType_t xAlreadyYielded = pdFALSE;
\r
2179 /* If uxSchedulerSuspended is zero then this function does not match a
\r
2180 * previous call to vTaskSuspendAll(). */
\r
2181 configASSERT( uxSchedulerSuspended );
\r
2183 /* It is possible that an ISR caused a task to be removed from an event
\r
2184 * list while the scheduler was suspended. If this was the case then the
\r
2185 * removed task will have been added to the xPendingReadyList. Once the
\r
2186 * scheduler has been resumed it is safe to move all the pending ready
\r
2187 * tasks from this list into their appropriate ready list. */
\r
2188 taskENTER_CRITICAL();
\r
2190 --uxSchedulerSuspended;
\r
2192 if( uxSchedulerSuspended == ( UBaseType_t ) pdFALSE )
\r
2194 if( uxCurrentNumberOfTasks > ( UBaseType_t ) 0U )
\r
2196 /* Move any readied tasks from the pending list into the
\r
2197 * appropriate ready list. */
\r
2198 while( listLIST_IS_EMPTY( &xPendingReadyList ) == pdFALSE )
\r
2200 pxTCB = listGET_OWNER_OF_HEAD_ENTRY( ( &xPendingReadyList ) ); /*lint !e9079 void * is used as this macro is used with timers and co-routines too. Alignment is known to be fine as the type of the pointer stored and retrieved is the same. */
\r
2201 listREMOVE_ITEM( &( pxTCB->xEventListItem ) );
\r
2202 portMEMORY_BARRIER();
\r
2203 listREMOVE_ITEM( &( pxTCB->xStateListItem ) );
\r
2204 prvAddTaskToReadyList( pxTCB );
\r
2206 /* If the moved task has a priority higher than or equal to
\r
2207 * the current task then a yield must be performed. */
\r
2208 if( pxTCB->uxPriority >= pxCurrentTCB->uxPriority )
\r
2210 xYieldPending = pdTRUE;
\r
2214 mtCOVERAGE_TEST_MARKER();
\r
2218 if( pxTCB != NULL )
\r
2220 /* A task was unblocked while the scheduler was suspended,
\r
2221 * which may have prevented the next unblock time from being
\r
2222 * re-calculated, in which case re-calculate it now. Mainly
\r
2223 * important for low power tickless implementations, where
\r
2224 * this can prevent an unnecessary exit from low power
\r
2226 prvResetNextTaskUnblockTime();
\r
2229 /* If any ticks occurred while the scheduler was suspended then
\r
2230 * they should be processed now. This ensures the tick count does
\r
2231 * not slip, and that any delayed tasks are resumed at the correct
\r
2234 TickType_t xPendedCounts = xPendedTicks; /* Non-volatile copy. */
\r
2236 if( xPendedCounts > ( TickType_t ) 0U )
\r
2240 if( xTaskIncrementTick() != pdFALSE )
\r
2242 xYieldPending = pdTRUE;
\r
2246 mtCOVERAGE_TEST_MARKER();
\r
2250 } while( xPendedCounts > ( TickType_t ) 0U );
\r
2256 mtCOVERAGE_TEST_MARKER();
\r
2260 if( xYieldPending != pdFALSE )
\r
2262 #if ( configUSE_PREEMPTION != 0 )
\r
2264 xAlreadyYielded = pdTRUE;
\r
2267 taskYIELD_IF_USING_PREEMPTION();
\r
2271 mtCOVERAGE_TEST_MARKER();
\r
2277 mtCOVERAGE_TEST_MARKER();
\r
2280 taskEXIT_CRITICAL();
\r
2282 return xAlreadyYielded;
\r
2284 /*-----------------------------------------------------------*/
\r
2286 TickType_t xTaskGetTickCount( void )
\r
2288 TickType_t xTicks;
\r
2290 /* Critical section required if running on a 16 bit processor. */
\r
2291 portTICK_TYPE_ENTER_CRITICAL();
\r
2293 xTicks = xTickCount;
\r
2295 portTICK_TYPE_EXIT_CRITICAL();
\r
2299 /*-----------------------------------------------------------*/
\r
2301 TickType_t xTaskGetTickCountFromISR( void )
\r
2303 TickType_t xReturn;
\r
2304 UBaseType_t uxSavedInterruptStatus;
\r
2306 /* RTOS ports that support interrupt nesting have the concept of a maximum
\r
2307 * system call (or maximum API call) interrupt priority. Interrupts that are
\r
2308 * above the maximum system call priority are kept permanently enabled, even
\r
2309 * when the RTOS kernel is in a critical section, but cannot make any calls to
\r
2310 * FreeRTOS API functions. If configASSERT() is defined in FreeRTOSConfig.h
\r
2311 * then portASSERT_IF_INTERRUPT_PRIORITY_INVALID() will result in an assertion
\r
2312 * failure if a FreeRTOS API function is called from an interrupt that has been
\r
2313 * assigned a priority above the configured maximum system call priority.
\r
2314 * Only FreeRTOS functions that end in FromISR can be called from interrupts
\r
2315 * that have been assigned a priority at or (logically) below the maximum
\r
2316 * system call interrupt priority. FreeRTOS maintains a separate interrupt
\r
2317 * safe API to ensure interrupt entry is as fast and as simple as possible.
\r
2318 * More information (albeit Cortex-M specific) is provided on the following
\r
2319 * link: https://www.FreeRTOS.org/RTOS-Cortex-M3-M4.html */
\r
2320 portASSERT_IF_INTERRUPT_PRIORITY_INVALID();
\r
2322 uxSavedInterruptStatus = portTICK_TYPE_SET_INTERRUPT_MASK_FROM_ISR();
\r
2324 xReturn = xTickCount;
\r
2326 portTICK_TYPE_CLEAR_INTERRUPT_MASK_FROM_ISR( uxSavedInterruptStatus );
\r
2330 /*-----------------------------------------------------------*/
\r
2332 UBaseType_t uxTaskGetNumberOfTasks( void )
\r
2334 /* A critical section is not required because the variables are of type
\r
2336 return uxCurrentNumberOfTasks;
\r
2338 /*-----------------------------------------------------------*/
\r
2340 char * pcTaskGetName( TaskHandle_t xTaskToQuery ) /*lint !e971 Unqualified char types are allowed for strings and single characters only. */
\r
2344 /* If null is passed in here then the name of the calling task is being
\r
2346 pxTCB = prvGetTCBFromHandle( xTaskToQuery );
\r
2347 configASSERT( pxTCB );
\r
2348 return &( pxTCB->pcTaskName[ 0 ] );
\r
2350 /*-----------------------------------------------------------*/
\r
2352 #if ( INCLUDE_xTaskGetHandle == 1 )
\r
2354 static TCB_t * prvSearchForNameWithinSingleList( List_t * pxList,
\r
2355 const char pcNameToQuery[] )
\r
2357 TCB_t * pxNextTCB, * pxFirstTCB, * pxReturn = NULL;
\r
2360 BaseType_t xBreakLoop;
\r
2362 /* This function is called with the scheduler suspended. */
\r
2364 if( listCURRENT_LIST_LENGTH( pxList ) > ( UBaseType_t ) 0 )
\r
2366 listGET_OWNER_OF_NEXT_ENTRY( pxFirstTCB, pxList ); /*lint !e9079 void * is used as this macro is used with timers and co-routines too. Alignment is known to be fine as the type of the pointer stored and retrieved is the same. */
\r
2370 listGET_OWNER_OF_NEXT_ENTRY( pxNextTCB, pxList ); /*lint !e9079 void * is used as this macro is used with timers and co-routines too. Alignment is known to be fine as the type of the pointer stored and retrieved is the same. */
\r
2372 /* Check each character in the name looking for a match or
\r
2374 xBreakLoop = pdFALSE;
\r
2376 for( x = ( UBaseType_t ) 0; x < ( UBaseType_t ) configMAX_TASK_NAME_LEN; x++ )
\r
2378 cNextChar = pxNextTCB->pcTaskName[ x ];
\r
2380 if( cNextChar != pcNameToQuery[ x ] )
\r
2382 /* Characters didn't match. */
\r
2383 xBreakLoop = pdTRUE;
\r
2385 else if( cNextChar == ( char ) 0x00 )
\r
2387 /* Both strings terminated, a match must have been
\r
2389 pxReturn = pxNextTCB;
\r
2390 xBreakLoop = pdTRUE;
\r
2394 mtCOVERAGE_TEST_MARKER();
\r
2397 if( xBreakLoop != pdFALSE )
\r
2403 if( pxReturn != NULL )
\r
2405 /* The handle has been found. */
\r
2408 } while( pxNextTCB != pxFirstTCB );
\r
2412 mtCOVERAGE_TEST_MARKER();
\r
2418 #endif /* INCLUDE_xTaskGetHandle */
\r
2419 /*-----------------------------------------------------------*/
\r
2421 #if ( INCLUDE_xTaskGetHandle == 1 )
\r
2423 TaskHandle_t xTaskGetHandle( const char * pcNameToQuery ) /*lint !e971 Unqualified char types are allowed for strings and single characters only. */
\r
2425 UBaseType_t uxQueue = configMAX_PRIORITIES;
\r
2428 /* Task names will be truncated to configMAX_TASK_NAME_LEN - 1 bytes. */
\r
2429 configASSERT( strlen( pcNameToQuery ) < configMAX_TASK_NAME_LEN );
\r
2431 vTaskSuspendAll();
\r
2433 /* Search the ready lists. */
\r
2437 pxTCB = prvSearchForNameWithinSingleList( ( List_t * ) &( pxReadyTasksLists[ uxQueue ] ), pcNameToQuery );
\r
2439 if( pxTCB != NULL )
\r
2441 /* Found the handle. */
\r
2444 } while( uxQueue > ( UBaseType_t ) tskIDLE_PRIORITY ); /*lint !e961 MISRA exception as the casts are only redundant for some ports. */
\r
2446 /* Search the delayed lists. */
\r
2447 if( pxTCB == NULL )
\r
2449 pxTCB = prvSearchForNameWithinSingleList( ( List_t * ) pxDelayedTaskList, pcNameToQuery );
\r
2452 if( pxTCB == NULL )
\r
2454 pxTCB = prvSearchForNameWithinSingleList( ( List_t * ) pxOverflowDelayedTaskList, pcNameToQuery );
\r
2457 #if ( INCLUDE_vTaskSuspend == 1 )
\r
2459 if( pxTCB == NULL )
\r
2461 /* Search the suspended list. */
\r
2462 pxTCB = prvSearchForNameWithinSingleList( &xSuspendedTaskList, pcNameToQuery );
\r
2467 #if ( INCLUDE_vTaskDelete == 1 )
\r
2469 if( pxTCB == NULL )
\r
2471 /* Search the deleted list. */
\r
2472 pxTCB = prvSearchForNameWithinSingleList( &xTasksWaitingTermination, pcNameToQuery );
\r
2477 ( void ) xTaskResumeAll();
\r
2482 #endif /* INCLUDE_xTaskGetHandle */
\r
2483 /*-----------------------------------------------------------*/
\r
2485 #if ( configUSE_TRACE_FACILITY == 1 )
\r
2487 UBaseType_t uxTaskGetSystemState( TaskStatus_t * const pxTaskStatusArray,
\r
2488 const UBaseType_t uxArraySize,
\r
2489 configRUN_TIME_COUNTER_TYPE * const pulTotalRunTime )
\r
2491 UBaseType_t uxTask = 0, uxQueue = configMAX_PRIORITIES;
\r
2493 vTaskSuspendAll();
\r
2495 /* Is there a space in the array for each task in the system? */
\r
2496 if( uxArraySize >= uxCurrentNumberOfTasks )
\r
2498 /* Fill in an TaskStatus_t structure with information on each
\r
2499 * task in the Ready state. */
\r
2503 uxTask += prvListTasksWithinSingleList( &( pxTaskStatusArray[ uxTask ] ), &( pxReadyTasksLists[ uxQueue ] ), eReady );
\r
2504 } while( uxQueue > ( UBaseType_t ) tskIDLE_PRIORITY ); /*lint !e961 MISRA exception as the casts are only redundant for some ports. */
\r
2506 /* Fill in an TaskStatus_t structure with information on each
\r
2507 * task in the Blocked state. */
\r
2508 uxTask += prvListTasksWithinSingleList( &( pxTaskStatusArray[ uxTask ] ), ( List_t * ) pxDelayedTaskList, eBlocked );
\r
2509 uxTask += prvListTasksWithinSingleList( &( pxTaskStatusArray[ uxTask ] ), ( List_t * ) pxOverflowDelayedTaskList, eBlocked );
\r
2511 #if ( INCLUDE_vTaskDelete == 1 )
\r
2513 /* Fill in an TaskStatus_t structure with information on
\r
2514 * each task that has been deleted but not yet cleaned up. */
\r
2515 uxTask += prvListTasksWithinSingleList( &( pxTaskStatusArray[ uxTask ] ), &xTasksWaitingTermination, eDeleted );
\r
2519 #if ( INCLUDE_vTaskSuspend == 1 )
\r
2521 /* Fill in an TaskStatus_t structure with information on
\r
2522 * each task in the Suspended state. */
\r
2523 uxTask += prvListTasksWithinSingleList( &( pxTaskStatusArray[ uxTask ] ), &xSuspendedTaskList, eSuspended );
\r
2527 #if ( configGENERATE_RUN_TIME_STATS == 1 )
\r
2529 if( pulTotalRunTime != NULL )
\r
2531 #ifdef portALT_GET_RUN_TIME_COUNTER_VALUE
\r
2532 portALT_GET_RUN_TIME_COUNTER_VALUE( ( *pulTotalRunTime ) );
\r
2534 *pulTotalRunTime = portGET_RUN_TIME_COUNTER_VALUE();
\r
2538 #else /* if ( configGENERATE_RUN_TIME_STATS == 1 ) */
\r
2540 if( pulTotalRunTime != NULL )
\r
2542 *pulTotalRunTime = 0;
\r
2545 #endif /* if ( configGENERATE_RUN_TIME_STATS == 1 ) */
\r
2549 mtCOVERAGE_TEST_MARKER();
\r
2552 ( void ) xTaskResumeAll();
\r
2557 #endif /* configUSE_TRACE_FACILITY */
\r
2558 /*----------------------------------------------------------*/
\r
2560 #if ( INCLUDE_xTaskGetIdleTaskHandle == 1 )
\r
2562 TaskHandle_t xTaskGetIdleTaskHandle( void )
\r
2564 /* If xTaskGetIdleTaskHandle() is called before the scheduler has been
\r
2565 * started, then xIdleTaskHandle will be NULL. */
\r
2566 configASSERT( ( xIdleTaskHandle != NULL ) );
\r
2567 return xIdleTaskHandle;
\r
2570 #endif /* INCLUDE_xTaskGetIdleTaskHandle */
\r
2571 /*----------------------------------------------------------*/
\r
2573 /* This conditional compilation should use inequality to 0, not equality to 1.
\r
2574 * This is to ensure vTaskStepTick() is available when user defined low power mode
\r
2575 * implementations require configUSE_TICKLESS_IDLE to be set to a value other than
\r
2577 #if ( configUSE_TICKLESS_IDLE != 0 )
\r
2579 void vTaskStepTick( TickType_t xTicksToJump )
\r
2581 /* Correct the tick count value after a period during which the tick
\r
2582 * was suppressed. Note this does *not* call the tick hook function for
\r
2583 * each stepped tick. */
\r
2584 configASSERT( ( xTickCount + xTicksToJump ) <= xNextTaskUnblockTime );
\r
2586 if( ( xTickCount + xTicksToJump ) == xNextTaskUnblockTime )
\r
2588 /* Arrange for xTickCount to reach xNextTaskUnblockTime in
\r
2589 * xTaskIncrementTick() when the scheduler resumes. This ensures
\r
2590 * that any delayed tasks are resumed at the correct time. */
\r
2591 configASSERT( uxSchedulerSuspended );
\r
2592 configASSERT( xTicksToJump != ( TickType_t ) 0 );
\r
2594 /* Prevent the tick interrupt modifying xPendedTicks simultaneously. */
\r
2595 taskENTER_CRITICAL();
\r
2599 taskEXIT_CRITICAL();
\r
2604 mtCOVERAGE_TEST_MARKER();
\r
2607 xTickCount += xTicksToJump;
\r
2608 traceINCREASE_TICK_COUNT( xTicksToJump );
\r
2611 #endif /* configUSE_TICKLESS_IDLE */
\r
2612 /*----------------------------------------------------------*/
\r
2614 BaseType_t xTaskCatchUpTicks( TickType_t xTicksToCatchUp )
\r
2616 BaseType_t xYieldOccurred;
\r
2618 /* Must not be called with the scheduler suspended as the implementation
\r
2619 * relies on xPendedTicks being wound down to 0 in xTaskResumeAll(). */
\r
2620 configASSERT( uxSchedulerSuspended == 0 );
\r
2622 /* Use xPendedTicks to mimic xTicksToCatchUp number of ticks occurring when
\r
2623 * the scheduler is suspended so the ticks are executed in xTaskResumeAll(). */
\r
2624 vTaskSuspendAll();
\r
2626 /* Prevent the tick interrupt modifying xPendedTicks simultaneously. */
\r
2627 taskENTER_CRITICAL();
\r
2629 xPendedTicks += xTicksToCatchUp;
\r
2631 taskEXIT_CRITICAL();
\r
2632 xYieldOccurred = xTaskResumeAll();
\r
2634 return xYieldOccurred;
\r
2636 /*----------------------------------------------------------*/
\r
2638 #if ( INCLUDE_xTaskAbortDelay == 1 )
\r
2640 BaseType_t xTaskAbortDelay( TaskHandle_t xTask )
\r
2642 TCB_t * pxTCB = xTask;
\r
2643 BaseType_t xReturn;
\r
2645 configASSERT( pxTCB );
\r
2647 vTaskSuspendAll();
\r
2649 /* A task can only be prematurely removed from the Blocked state if
\r
2650 * it is actually in the Blocked state. */
\r
2651 if( eTaskGetState( xTask ) == eBlocked )
\r
2655 /* Remove the reference to the task from the blocked list. An
\r
2656 * interrupt won't touch the xStateListItem because the
\r
2657 * scheduler is suspended. */
\r
2658 ( void ) uxListRemove( &( pxTCB->xStateListItem ) );
\r
2660 /* Is the task waiting on an event also? If so remove it from
\r
2661 * the event list too. Interrupts can touch the event list item,
\r
2662 * even though the scheduler is suspended, so a critical section
\r
2664 taskENTER_CRITICAL();
\r
2666 if( listLIST_ITEM_CONTAINER( &( pxTCB->xEventListItem ) ) != NULL )
\r
2668 ( void ) uxListRemove( &( pxTCB->xEventListItem ) );
\r
2670 /* This lets the task know it was forcibly removed from the
\r
2671 * blocked state so it should not re-evaluate its block time and
\r
2672 * then block again. */
\r
2673 pxTCB->ucDelayAborted = pdTRUE;
\r
2677 mtCOVERAGE_TEST_MARKER();
\r
2680 taskEXIT_CRITICAL();
\r
2682 /* Place the unblocked task into the appropriate ready list. */
\r
2683 prvAddTaskToReadyList( pxTCB );
\r
2685 /* A task being unblocked cannot cause an immediate context
\r
2686 * switch if preemption is turned off. */
\r
2687 #if ( configUSE_PREEMPTION == 1 )
\r
2689 /* Preemption is on, but a context switch should only be
\r
2690 * performed if the unblocked task has a priority that is
\r
2691 * higher than the currently executing task. */
\r
2692 if( pxTCB->uxPriority > pxCurrentTCB->uxPriority )
\r
2694 /* Pend the yield to be performed when the scheduler
\r
2695 * is unsuspended. */
\r
2696 xYieldPending = pdTRUE;
\r
2700 mtCOVERAGE_TEST_MARKER();
\r
2703 #endif /* configUSE_PREEMPTION */
\r
2710 ( void ) xTaskResumeAll();
\r
2715 #endif /* INCLUDE_xTaskAbortDelay */
\r
2716 /*----------------------------------------------------------*/
\r
2718 BaseType_t xTaskIncrementTick( void )
\r
2721 TickType_t xItemValue;
\r
2722 BaseType_t xSwitchRequired = pdFALSE;
\r
2724 /* Called by the portable layer each time a tick interrupt occurs.
\r
2725 * Increments the tick then checks to see if the new tick value will cause any
\r
2726 * tasks to be unblocked. */
\r
2727 traceTASK_INCREMENT_TICK( xTickCount );
\r
2729 if( uxSchedulerSuspended == ( UBaseType_t ) pdFALSE )
\r
2731 /* Minor optimisation. The tick count cannot change in this
\r
2733 const TickType_t xConstTickCount = xTickCount + ( TickType_t ) 1;
\r
2735 /* Increment the RTOS tick, switching the delayed and overflowed
\r
2736 * delayed lists if it wraps to 0. */
\r
2737 xTickCount = xConstTickCount;
\r
2739 if( xConstTickCount == ( TickType_t ) 0U ) /*lint !e774 'if' does not always evaluate to false as it is looking for an overflow. */
\r
2741 taskSWITCH_DELAYED_LISTS();
\r
2745 mtCOVERAGE_TEST_MARKER();
\r
2748 /* See if this tick has made a timeout expire. Tasks are stored in
\r
2749 * the queue in the order of their wake time - meaning once one task
\r
2750 * has been found whose block time has not expired there is no need to
\r
2751 * look any further down the list. */
\r
2752 if( xConstTickCount >= xNextTaskUnblockTime )
\r
2756 if( listLIST_IS_EMPTY( pxDelayedTaskList ) != pdFALSE )
\r
2758 /* The delayed list is empty. Set xNextTaskUnblockTime
\r
2759 * to the maximum possible value so it is extremely
\r
2760 * unlikely that the
\r
2761 * if( xTickCount >= xNextTaskUnblockTime ) test will pass
\r
2762 * next time through. */
\r
2763 xNextTaskUnblockTime = portMAX_DELAY; /*lint !e961 MISRA exception as the casts are only redundant for some ports. */
\r
2768 /* The delayed list is not empty, get the value of the
\r
2769 * item at the head of the delayed list. This is the time
\r
2770 * at which the task at the head of the delayed list must
\r
2771 * be removed from the Blocked state. */
\r
2772 pxTCB = listGET_OWNER_OF_HEAD_ENTRY( pxDelayedTaskList ); /*lint !e9079 void * is used as this macro is used with timers and co-routines too. Alignment is known to be fine as the type of the pointer stored and retrieved is the same. */
\r
2773 xItemValue = listGET_LIST_ITEM_VALUE( &( pxTCB->xStateListItem ) );
\r
2775 if( xConstTickCount < xItemValue )
\r
2777 /* It is not time to unblock this item yet, but the
\r
2778 * item value is the time at which the task at the head
\r
2779 * of the blocked list must be removed from the Blocked
\r
2780 * state - so record the item value in
\r
2781 * xNextTaskUnblockTime. */
\r
2782 xNextTaskUnblockTime = xItemValue;
\r
2783 break; /*lint !e9011 Code structure here is deemed easier to understand with multiple breaks. */
\r
2787 mtCOVERAGE_TEST_MARKER();
\r
2790 /* It is time to remove the item from the Blocked state. */
\r
2791 listREMOVE_ITEM( &( pxTCB->xStateListItem ) );
\r
2793 /* Is the task waiting on an event also? If so remove
\r
2794 * it from the event list. */
\r
2795 if( listLIST_ITEM_CONTAINER( &( pxTCB->xEventListItem ) ) != NULL )
\r
2797 listREMOVE_ITEM( &( pxTCB->xEventListItem ) );
\r
2801 mtCOVERAGE_TEST_MARKER();
\r
2804 /* Place the unblocked task into the appropriate ready
\r
2806 prvAddTaskToReadyList( pxTCB );
\r
2808 /* A task being unblocked cannot cause an immediate
\r
2809 * context switch if preemption is turned off. */
\r
2810 #if ( configUSE_PREEMPTION == 1 )
\r
2812 /* Preemption is on, but a context switch should
\r
2813 * only be performed if the unblocked task has a
\r
2814 * priority that is equal to or higher than the
\r
2815 * currently executing task. */
\r
2816 if( pxTCB->uxPriority >= pxCurrentTCB->uxPriority )
\r
2818 xSwitchRequired = pdTRUE;
\r
2822 mtCOVERAGE_TEST_MARKER();
\r
2825 #endif /* configUSE_PREEMPTION */
\r
2830 /* Tasks of equal priority to the currently running task will share
\r
2831 * processing time (time slice) if preemption is on, and the application
\r
2832 * writer has not explicitly turned time slicing off. */
\r
2833 #if ( ( configUSE_PREEMPTION == 1 ) && ( configUSE_TIME_SLICING == 1 ) )
\r
2835 if( listCURRENT_LIST_LENGTH( &( pxReadyTasksLists[ pxCurrentTCB->uxPriority ] ) ) > ( UBaseType_t ) 1 )
\r
2837 xSwitchRequired = pdTRUE;
\r
2841 mtCOVERAGE_TEST_MARKER();
\r
2844 #endif /* ( ( configUSE_PREEMPTION == 1 ) && ( configUSE_TIME_SLICING == 1 ) ) */
\r
2846 #if ( configUSE_TICK_HOOK == 1 )
\r
2848 /* Guard against the tick hook being called when the pended tick
\r
2849 * count is being unwound (when the scheduler is being unlocked). */
\r
2850 if( xPendedTicks == ( TickType_t ) 0 )
\r
2852 vApplicationTickHook();
\r
2856 mtCOVERAGE_TEST_MARKER();
\r
2859 #endif /* configUSE_TICK_HOOK */
\r
2861 #if ( configUSE_PREEMPTION == 1 )
\r
2863 if( xYieldPending != pdFALSE )
\r
2865 xSwitchRequired = pdTRUE;
\r
2869 mtCOVERAGE_TEST_MARKER();
\r
2872 #endif /* configUSE_PREEMPTION */
\r
2878 /* The tick hook gets called at regular intervals, even if the
\r
2879 * scheduler is locked. */
\r
2880 #if ( configUSE_TICK_HOOK == 1 )
\r
2882 vApplicationTickHook();
\r
2887 return xSwitchRequired;
\r
2889 /*-----------------------------------------------------------*/
\r
2891 #if ( configUSE_APPLICATION_TASK_TAG == 1 )
\r
2893 void vTaskSetApplicationTaskTag( TaskHandle_t xTask,
\r
2894 TaskHookFunction_t pxHookFunction )
\r
2898 /* If xTask is NULL then it is the task hook of the calling task that is
\r
2900 if( xTask == NULL )
\r
2902 xTCB = ( TCB_t * ) pxCurrentTCB;
\r
2909 /* Save the hook function in the TCB. A critical section is required as
\r
2910 * the value can be accessed from an interrupt. */
\r
2911 taskENTER_CRITICAL();
\r
2913 xTCB->pxTaskTag = pxHookFunction;
\r
2915 taskEXIT_CRITICAL();
\r
2918 #endif /* configUSE_APPLICATION_TASK_TAG */
\r
2919 /*-----------------------------------------------------------*/
\r
2921 #if ( configUSE_APPLICATION_TASK_TAG == 1 )
\r
2923 TaskHookFunction_t xTaskGetApplicationTaskTag( TaskHandle_t xTask )
\r
2926 TaskHookFunction_t xReturn;
\r
2928 /* If xTask is NULL then set the calling task's hook. */
\r
2929 pxTCB = prvGetTCBFromHandle( xTask );
\r
2931 /* Save the hook function in the TCB. A critical section is required as
\r
2932 * the value can be accessed from an interrupt. */
\r
2933 taskENTER_CRITICAL();
\r
2935 xReturn = pxTCB->pxTaskTag;
\r
2937 taskEXIT_CRITICAL();
\r
2942 #endif /* configUSE_APPLICATION_TASK_TAG */
\r
2943 /*-----------------------------------------------------------*/
\r
2945 #if ( configUSE_APPLICATION_TASK_TAG == 1 )
\r
2947 TaskHookFunction_t xTaskGetApplicationTaskTagFromISR( TaskHandle_t xTask )
\r
2950 TaskHookFunction_t xReturn;
\r
2951 UBaseType_t uxSavedInterruptStatus;
\r
2953 /* If xTask is NULL then set the calling task's hook. */
\r
2954 pxTCB = prvGetTCBFromHandle( xTask );
\r
2956 /* Save the hook function in the TCB. A critical section is required as
\r
2957 * the value can be accessed from an interrupt. */
\r
2958 uxSavedInterruptStatus = portSET_INTERRUPT_MASK_FROM_ISR();
\r
2960 xReturn = pxTCB->pxTaskTag;
\r
2962 portCLEAR_INTERRUPT_MASK_FROM_ISR( uxSavedInterruptStatus );
\r
2967 #endif /* configUSE_APPLICATION_TASK_TAG */
\r
2968 /*-----------------------------------------------------------*/
\r
2970 #if ( configUSE_APPLICATION_TASK_TAG == 1 )
\r
2972 BaseType_t xTaskCallApplicationTaskHook( TaskHandle_t xTask,
\r
2973 void * pvParameter )
\r
2976 BaseType_t xReturn;
\r
2978 /* If xTask is NULL then we are calling our own task hook. */
\r
2979 if( xTask == NULL )
\r
2981 xTCB = pxCurrentTCB;
\r
2988 if( xTCB->pxTaskTag != NULL )
\r
2990 xReturn = xTCB->pxTaskTag( pvParameter );
\r
3000 #endif /* configUSE_APPLICATION_TASK_TAG */
\r
3001 /*-----------------------------------------------------------*/
\r
3003 void vTaskSwitchContext( void )
\r
3005 if( uxSchedulerSuspended != ( UBaseType_t ) pdFALSE )
\r
3007 /* The scheduler is currently suspended - do not allow a context
\r
3009 xYieldPending = pdTRUE;
\r
3013 xYieldPending = pdFALSE;
\r
3014 traceTASK_SWITCHED_OUT();
\r
3016 #if ( configGENERATE_RUN_TIME_STATS == 1 )
\r
3018 #ifdef portALT_GET_RUN_TIME_COUNTER_VALUE
\r
3019 portALT_GET_RUN_TIME_COUNTER_VALUE( ulTotalRunTime );
\r
3021 ulTotalRunTime = portGET_RUN_TIME_COUNTER_VALUE();
\r
3024 /* Add the amount of time the task has been running to the
\r
3025 * accumulated time so far. The time the task started running was
\r
3026 * stored in ulTaskSwitchedInTime. Note that there is no overflow
\r
3027 * protection here so count values are only valid until the timer
\r
3028 * overflows. The guard against negative values is to protect
\r
3029 * against suspect run time stat counter implementations - which
\r
3030 * are provided by the application, not the kernel. */
\r
3031 if( ulTotalRunTime > ulTaskSwitchedInTime )
\r
3033 pxCurrentTCB->ulRunTimeCounter += ( ulTotalRunTime - ulTaskSwitchedInTime );
\r
3037 mtCOVERAGE_TEST_MARKER();
\r
3040 ulTaskSwitchedInTime = ulTotalRunTime;
\r
3042 #endif /* configGENERATE_RUN_TIME_STATS */
\r
3044 /* Check for stack overflow, if configured. */
\r
3045 taskCHECK_FOR_STACK_OVERFLOW();
\r
3047 /* Before the currently running task is switched out, save its errno. */
\r
3048 #if ( configUSE_POSIX_ERRNO == 1 )
\r
3050 pxCurrentTCB->iTaskErrno = FreeRTOS_errno;
\r
3054 /* Select a new task to run using either the generic C or port
\r
3055 * optimised asm code. */
\r
3056 taskSELECT_HIGHEST_PRIORITY_TASK(); /*lint !e9079 void * is used as this macro is used with timers and co-routines too. Alignment is known to be fine as the type of the pointer stored and retrieved is the same. */
\r
3057 traceTASK_SWITCHED_IN();
\r
3059 /* After the new task is switched in, update the global errno. */
\r
3060 #if ( configUSE_POSIX_ERRNO == 1 )
\r
3062 FreeRTOS_errno = pxCurrentTCB->iTaskErrno;
\r
3066 #if ( ( configUSE_NEWLIB_REENTRANT == 1 ) || ( configUSE_C_RUNTIME_TLS_SUPPORT == 1 ) )
\r
3068 /* Switch C-Runtime's TLS Block to point to the TLS
\r
3069 * Block specific to this task. */
\r
3070 configSET_TLS_BLOCK( pxCurrentTCB->xTLSBlock );
\r
3075 /*-----------------------------------------------------------*/
\r
3077 void vTaskPlaceOnEventList( List_t * const pxEventList,
\r
3078 const TickType_t xTicksToWait )
\r
3080 configASSERT( pxEventList );
\r
3082 /* THIS FUNCTION MUST BE CALLED WITH EITHER INTERRUPTS DISABLED OR THE
\r
3083 * SCHEDULER SUSPENDED AND THE QUEUE BEING ACCESSED LOCKED. */
\r
3085 /* Place the event list item of the TCB in the appropriate event list.
\r
3086 * This is placed in the list in priority order so the highest priority task
\r
3087 * is the first to be woken by the event.
\r
3089 * Note: Lists are sorted in ascending order by ListItem_t.xItemValue.
\r
3090 * Normally, the xItemValue of a TCB's ListItem_t members is:
\r
3091 * xItemValue = ( configMAX_PRIORITIES - uxPriority )
\r
3092 * Therefore, the event list is sorted in descending priority order.
\r
3094 * The queue that contains the event list is locked, preventing
\r
3095 * simultaneous access from interrupts. */
\r
3096 vListInsert( pxEventList, &( pxCurrentTCB->xEventListItem ) );
\r
3098 prvAddCurrentTaskToDelayedList( xTicksToWait, pdTRUE );
\r
3100 /*-----------------------------------------------------------*/
\r
3102 void vTaskPlaceOnUnorderedEventList( List_t * pxEventList,
\r
3103 const TickType_t xItemValue,
\r
3104 const TickType_t xTicksToWait )
\r
3106 configASSERT( pxEventList );
\r
3108 /* THIS FUNCTION MUST BE CALLED WITH THE SCHEDULER SUSPENDED. It is used by
\r
3109 * the event groups implementation. */
\r
3110 configASSERT( uxSchedulerSuspended != 0 );
\r
3112 /* Store the item value in the event list item. It is safe to access the
\r
3113 * event list item here as interrupts won't access the event list item of a
\r
3114 * task that is not in the Blocked state. */
\r
3115 listSET_LIST_ITEM_VALUE( &( pxCurrentTCB->xEventListItem ), xItemValue | taskEVENT_LIST_ITEM_VALUE_IN_USE );
\r
3117 /* Place the event list item of the TCB at the end of the appropriate event
\r
3118 * list. It is safe to access the event list here because it is part of an
\r
3119 * event group implementation - and interrupts don't access event groups
\r
3120 * directly (instead they access them indirectly by pending function calls to
\r
3121 * the task level). */
\r
3122 listINSERT_END( pxEventList, &( pxCurrentTCB->xEventListItem ) );
\r
3124 prvAddCurrentTaskToDelayedList( xTicksToWait, pdTRUE );
\r
3126 /*-----------------------------------------------------------*/
\r
3128 #if ( configUSE_TIMERS == 1 )
\r
3130 void vTaskPlaceOnEventListRestricted( List_t * const pxEventList,
\r
3131 TickType_t xTicksToWait,
\r
3132 const BaseType_t xWaitIndefinitely )
\r
3134 configASSERT( pxEventList );
\r
3136 /* This function should not be called by application code hence the
\r
3137 * 'Restricted' in its name. It is not part of the public API. It is
\r
3138 * designed for use by kernel code, and has special calling requirements -
\r
3139 * it should be called with the scheduler suspended. */
\r
3142 /* Place the event list item of the TCB in the appropriate event list.
\r
3143 * In this case it is assume that this is the only task that is going to
\r
3144 * be waiting on this event list, so the faster vListInsertEnd() function
\r
3145 * can be used in place of vListInsert. */
\r
3146 listINSERT_END( pxEventList, &( pxCurrentTCB->xEventListItem ) );
\r
3148 /* If the task should block indefinitely then set the block time to a
\r
3149 * value that will be recognised as an indefinite delay inside the
\r
3150 * prvAddCurrentTaskToDelayedList() function. */
\r
3151 if( xWaitIndefinitely != pdFALSE )
\r
3153 xTicksToWait = portMAX_DELAY;
\r
3156 traceTASK_DELAY_UNTIL( ( xTickCount + xTicksToWait ) );
\r
3157 prvAddCurrentTaskToDelayedList( xTicksToWait, xWaitIndefinitely );
\r
3160 #endif /* configUSE_TIMERS */
\r
3161 /*-----------------------------------------------------------*/
\r
3163 BaseType_t xTaskRemoveFromEventList( const List_t * const pxEventList )
\r
3165 TCB_t * pxUnblockedTCB;
\r
3166 BaseType_t xReturn;
\r
3168 /* THIS FUNCTION MUST BE CALLED FROM A CRITICAL SECTION. It can also be
\r
3169 * called from a critical section within an ISR. */
\r
3171 /* The event list is sorted in priority order, so the first in the list can
\r
3172 * be removed as it is known to be the highest priority. Remove the TCB from
\r
3173 * the delayed list, and add it to the ready list.
\r
3175 * If an event is for a queue that is locked then this function will never
\r
3176 * get called - the lock count on the queue will get modified instead. This
\r
3177 * means exclusive access to the event list is guaranteed here.
\r
3179 * This function assumes that a check has already been made to ensure that
\r
3180 * pxEventList is not empty. */
\r
3181 pxUnblockedTCB = listGET_OWNER_OF_HEAD_ENTRY( pxEventList ); /*lint !e9079 void * is used as this macro is used with timers and co-routines too. Alignment is known to be fine as the type of the pointer stored and retrieved is the same. */
\r
3182 configASSERT( pxUnblockedTCB );
\r
3183 listREMOVE_ITEM( &( pxUnblockedTCB->xEventListItem ) );
\r
3185 if( uxSchedulerSuspended == ( UBaseType_t ) pdFALSE )
\r
3187 listREMOVE_ITEM( &( pxUnblockedTCB->xStateListItem ) );
\r
3188 prvAddTaskToReadyList( pxUnblockedTCB );
\r
3190 #if ( configUSE_TICKLESS_IDLE != 0 )
\r
3192 /* If a task is blocked on a kernel object then xNextTaskUnblockTime
\r
3193 * might be set to the blocked task's time out time. If the task is
\r
3194 * unblocked for a reason other than a timeout xNextTaskUnblockTime is
\r
3195 * normally left unchanged, because it is automatically reset to a new
\r
3196 * value when the tick count equals xNextTaskUnblockTime. However if
\r
3197 * tickless idling is used it might be more important to enter sleep mode
\r
3198 * at the earliest possible time - so reset xNextTaskUnblockTime here to
\r
3199 * ensure it is updated at the earliest possible time. */
\r
3200 prvResetNextTaskUnblockTime();
\r
3206 /* The delayed and ready lists cannot be accessed, so hold this task
\r
3207 * pending until the scheduler is resumed. */
\r
3208 listINSERT_END( &( xPendingReadyList ), &( pxUnblockedTCB->xEventListItem ) );
\r
3211 if( pxUnblockedTCB->uxPriority > pxCurrentTCB->uxPriority )
\r
3213 /* Return true if the task removed from the event list has a higher
\r
3214 * priority than the calling task. This allows the calling task to know if
\r
3215 * it should force a context switch now. */
\r
3218 /* Mark that a yield is pending in case the user is not using the
\r
3219 * "xHigherPriorityTaskWoken" parameter to an ISR safe FreeRTOS function. */
\r
3220 xYieldPending = pdTRUE;
\r
3224 xReturn = pdFALSE;
\r
3229 /*-----------------------------------------------------------*/
\r
3231 void vTaskRemoveFromUnorderedEventList( ListItem_t * pxEventListItem,
\r
3232 const TickType_t xItemValue )
\r
3234 TCB_t * pxUnblockedTCB;
\r
3236 /* THIS FUNCTION MUST BE CALLED WITH THE SCHEDULER SUSPENDED. It is used by
\r
3237 * the event flags implementation. */
\r
3238 configASSERT( uxSchedulerSuspended != pdFALSE );
\r
3240 /* Store the new item value in the event list. */
\r
3241 listSET_LIST_ITEM_VALUE( pxEventListItem, xItemValue | taskEVENT_LIST_ITEM_VALUE_IN_USE );
\r
3243 /* Remove the event list form the event flag. Interrupts do not access
\r
3245 pxUnblockedTCB = listGET_LIST_ITEM_OWNER( pxEventListItem ); /*lint !e9079 void * is used as this macro is used with timers and co-routines too. Alignment is known to be fine as the type of the pointer stored and retrieved is the same. */
\r
3246 configASSERT( pxUnblockedTCB );
\r
3247 listREMOVE_ITEM( pxEventListItem );
\r
3249 #if ( configUSE_TICKLESS_IDLE != 0 )
\r
3251 /* If a task is blocked on a kernel object then xNextTaskUnblockTime
\r
3252 * might be set to the blocked task's time out time. If the task is
\r
3253 * unblocked for a reason other than a timeout xNextTaskUnblockTime is
\r
3254 * normally left unchanged, because it is automatically reset to a new
\r
3255 * value when the tick count equals xNextTaskUnblockTime. However if
\r
3256 * tickless idling is used it might be more important to enter sleep mode
\r
3257 * at the earliest possible time - so reset xNextTaskUnblockTime here to
\r
3258 * ensure it is updated at the earliest possible time. */
\r
3259 prvResetNextTaskUnblockTime();
\r
3263 /* Remove the task from the delayed list and add it to the ready list. The
\r
3264 * scheduler is suspended so interrupts will not be accessing the ready
\r
3266 listREMOVE_ITEM( &( pxUnblockedTCB->xStateListItem ) );
\r
3267 prvAddTaskToReadyList( pxUnblockedTCB );
\r
3269 if( pxUnblockedTCB->uxPriority > pxCurrentTCB->uxPriority )
\r
3271 /* The unblocked task has a priority above that of the calling task, so
\r
3272 * a context switch is required. This function is called with the
\r
3273 * scheduler suspended so xYieldPending is set so the context switch
\r
3274 * occurs immediately that the scheduler is resumed (unsuspended). */
\r
3275 xYieldPending = pdTRUE;
\r
3278 /*-----------------------------------------------------------*/
\r
3280 void vTaskSetTimeOutState( TimeOut_t * const pxTimeOut )
\r
3282 configASSERT( pxTimeOut );
\r
3283 taskENTER_CRITICAL();
\r
3285 pxTimeOut->xOverflowCount = xNumOfOverflows;
\r
3286 pxTimeOut->xTimeOnEntering = xTickCount;
\r
3288 taskEXIT_CRITICAL();
\r
3290 /*-----------------------------------------------------------*/
\r
3292 void vTaskInternalSetTimeOutState( TimeOut_t * const pxTimeOut )
\r
3294 /* For internal use only as it does not use a critical section. */
\r
3295 pxTimeOut->xOverflowCount = xNumOfOverflows;
\r
3296 pxTimeOut->xTimeOnEntering = xTickCount;
\r
3298 /*-----------------------------------------------------------*/
\r
3300 BaseType_t xTaskCheckForTimeOut( TimeOut_t * const pxTimeOut,
\r
3301 TickType_t * const pxTicksToWait )
\r
3303 BaseType_t xReturn;
\r
3305 configASSERT( pxTimeOut );
\r
3306 configASSERT( pxTicksToWait );
\r
3308 taskENTER_CRITICAL();
\r
3310 /* Minor optimisation. The tick count cannot change in this block. */
\r
3311 const TickType_t xConstTickCount = xTickCount;
\r
3312 const TickType_t xElapsedTime = xConstTickCount - pxTimeOut->xTimeOnEntering;
\r
3314 #if ( INCLUDE_xTaskAbortDelay == 1 )
\r
3315 if( pxCurrentTCB->ucDelayAborted != ( uint8_t ) pdFALSE )
\r
3317 /* The delay was aborted, which is not the same as a time out,
\r
3318 * but has the same result. */
\r
3319 pxCurrentTCB->ucDelayAborted = pdFALSE;
\r
3325 #if ( INCLUDE_vTaskSuspend == 1 )
\r
3326 if( *pxTicksToWait == portMAX_DELAY )
\r
3328 /* If INCLUDE_vTaskSuspend is set to 1 and the block time
\r
3329 * specified is the maximum block time then the task should block
\r
3330 * indefinitely, and therefore never time out. */
\r
3331 xReturn = pdFALSE;
\r
3336 if( ( xNumOfOverflows != pxTimeOut->xOverflowCount ) && ( xConstTickCount >= pxTimeOut->xTimeOnEntering ) ) /*lint !e525 Indentation preferred as is to make code within pre-processor directives clearer. */
\r
3338 /* The tick count is greater than the time at which
\r
3339 * vTaskSetTimeout() was called, but has also overflowed since
\r
3340 * vTaskSetTimeOut() was called. It must have wrapped all the way
\r
3341 * around and gone past again. This passed since vTaskSetTimeout()
\r
3344 *pxTicksToWait = ( TickType_t ) 0;
\r
3346 else if( xElapsedTime < *pxTicksToWait ) /*lint !e961 Explicit casting is only redundant with some compilers, whereas others require it to prevent integer conversion errors. */
\r
3348 /* Not a genuine timeout. Adjust parameters for time remaining. */
\r
3349 *pxTicksToWait -= xElapsedTime;
\r
3350 vTaskInternalSetTimeOutState( pxTimeOut );
\r
3351 xReturn = pdFALSE;
\r
3355 *pxTicksToWait = ( TickType_t ) 0;
\r
3359 taskEXIT_CRITICAL();
\r
3363 /*-----------------------------------------------------------*/
\r
3365 void vTaskMissedYield( void )
\r
3367 xYieldPending = pdTRUE;
\r
3369 /*-----------------------------------------------------------*/
\r
3371 #if ( configUSE_TRACE_FACILITY == 1 )
\r
3373 UBaseType_t uxTaskGetTaskNumber( TaskHandle_t xTask )
\r
3375 UBaseType_t uxReturn;
\r
3376 TCB_t const * pxTCB;
\r
3378 if( xTask != NULL )
\r
3381 uxReturn = pxTCB->uxTaskNumber;
\r
3391 #endif /* configUSE_TRACE_FACILITY */
\r
3392 /*-----------------------------------------------------------*/
\r
3394 #if ( configUSE_TRACE_FACILITY == 1 )
\r
3396 void vTaskSetTaskNumber( TaskHandle_t xTask,
\r
3397 const UBaseType_t uxHandle )
\r
3401 if( xTask != NULL )
\r
3404 pxTCB->uxTaskNumber = uxHandle;
\r
3408 #endif /* configUSE_TRACE_FACILITY */
\r
3411 * -----------------------------------------------------------
\r
3413 * ----------------------------------------------------------
\r
3415 * The portTASK_FUNCTION() macro is used to allow port/compiler specific
\r
3416 * language extensions. The equivalent prototype for this function is:
\r
3418 * void prvIdleTask( void *pvParameters );
\r
3421 static portTASK_FUNCTION( prvIdleTask, pvParameters )
\r
3423 /* Stop warnings. */
\r
3424 ( void ) pvParameters;
\r
3426 /** THIS IS THE RTOS IDLE TASK - WHICH IS CREATED AUTOMATICALLY WHEN THE
\r
3427 * SCHEDULER IS STARTED. **/
\r
3429 /* In case a task that has a secure context deletes itself, in which case
\r
3430 * the idle task is responsible for deleting the task's secure context, if
\r
3432 portALLOCATE_SECURE_CONTEXT( configMINIMAL_SECURE_STACK_SIZE );
\r
3436 /* See if any tasks have deleted themselves - if so then the idle task
\r
3437 * is responsible for freeing the deleted task's TCB and stack. */
\r
3438 prvCheckTasksWaitingTermination();
\r
3440 #if ( configUSE_PREEMPTION == 0 )
\r
3442 /* If we are not using preemption we keep forcing a task switch to
\r
3443 * see if any other task has become available. If we are using
\r
3444 * preemption we don't need to do this as any task becoming available
\r
3445 * will automatically get the processor anyway. */
\r
3448 #endif /* configUSE_PREEMPTION */
\r
3450 #if ( ( configUSE_PREEMPTION == 1 ) && ( configIDLE_SHOULD_YIELD == 1 ) )
\r
3452 /* When using preemption tasks of equal priority will be
\r
3453 * timesliced. If a task that is sharing the idle priority is ready
\r
3454 * to run then the idle task should yield before the end of the
\r
3457 * A critical region is not required here as we are just reading from
\r
3458 * the list, and an occasional incorrect value will not matter. If
\r
3459 * the ready list at the idle priority contains more than one task
\r
3460 * then a task other than the idle task is ready to execute. */
\r
3461 if( listCURRENT_LIST_LENGTH( &( pxReadyTasksLists[ tskIDLE_PRIORITY ] ) ) > ( UBaseType_t ) 1 )
\r
3467 mtCOVERAGE_TEST_MARKER();
\r
3470 #endif /* ( ( configUSE_PREEMPTION == 1 ) && ( configIDLE_SHOULD_YIELD == 1 ) ) */
\r
3472 #if ( configUSE_IDLE_HOOK == 1 )
\r
3474 extern void vApplicationIdleHook( void );
\r
3476 /* Call the user defined function from within the idle task. This
\r
3477 * allows the application designer to add background functionality
\r
3478 * without the overhead of a separate task.
\r
3479 * NOTE: vApplicationIdleHook() MUST NOT, UNDER ANY CIRCUMSTANCES,
\r
3480 * CALL A FUNCTION THAT MIGHT BLOCK. */
\r
3481 vApplicationIdleHook();
\r
3483 #endif /* configUSE_IDLE_HOOK */
\r
3485 /* This conditional compilation should use inequality to 0, not equality
\r
3486 * to 1. This is to ensure portSUPPRESS_TICKS_AND_SLEEP() is called when
\r
3487 * user defined low power mode implementations require
\r
3488 * configUSE_TICKLESS_IDLE to be set to a value other than 1. */
\r
3489 #if ( configUSE_TICKLESS_IDLE != 0 )
\r
3491 TickType_t xExpectedIdleTime;
\r
3493 /* It is not desirable to suspend then resume the scheduler on
\r
3494 * each iteration of the idle task. Therefore, a preliminary
\r
3495 * test of the expected idle time is performed without the
\r
3496 * scheduler suspended. The result here is not necessarily
\r
3498 xExpectedIdleTime = prvGetExpectedIdleTime();
\r
3500 if( xExpectedIdleTime >= configEXPECTED_IDLE_TIME_BEFORE_SLEEP )
\r
3502 vTaskSuspendAll();
\r
3504 /* Now the scheduler is suspended, the expected idle
\r
3505 * time can be sampled again, and this time its value can
\r
3507 configASSERT( xNextTaskUnblockTime >= xTickCount );
\r
3508 xExpectedIdleTime = prvGetExpectedIdleTime();
\r
3510 /* Define the following macro to set xExpectedIdleTime to 0
\r
3511 * if the application does not want
\r
3512 * portSUPPRESS_TICKS_AND_SLEEP() to be called. */
\r
3513 configPRE_SUPPRESS_TICKS_AND_SLEEP_PROCESSING( xExpectedIdleTime );
\r
3515 if( xExpectedIdleTime >= configEXPECTED_IDLE_TIME_BEFORE_SLEEP )
\r
3517 traceLOW_POWER_IDLE_BEGIN();
\r
3518 portSUPPRESS_TICKS_AND_SLEEP( xExpectedIdleTime );
\r
3519 traceLOW_POWER_IDLE_END();
\r
3523 mtCOVERAGE_TEST_MARKER();
\r
3526 ( void ) xTaskResumeAll();
\r
3530 mtCOVERAGE_TEST_MARKER();
\r
3533 #endif /* configUSE_TICKLESS_IDLE */
\r
3536 /*-----------------------------------------------------------*/
\r
3538 #if ( configUSE_TICKLESS_IDLE != 0 )
\r
3540 eSleepModeStatus eTaskConfirmSleepModeStatus( void )
\r
3542 #if ( INCLUDE_vTaskSuspend == 1 )
\r
3543 /* The idle task exists in addition to the application tasks. */
\r
3544 const UBaseType_t uxNonApplicationTasks = 1;
\r
3545 #endif /* INCLUDE_vTaskSuspend */
\r
3547 eSleepModeStatus eReturn = eStandardSleep;
\r
3549 /* This function must be called from a critical section. */
\r
3551 if( listCURRENT_LIST_LENGTH( &xPendingReadyList ) != 0 )
\r
3553 /* A task was made ready while the scheduler was suspended. */
\r
3554 eReturn = eAbortSleep;
\r
3556 else if( xYieldPending != pdFALSE )
\r
3558 /* A yield was pended while the scheduler was suspended. */
\r
3559 eReturn = eAbortSleep;
\r
3561 else if( xPendedTicks != 0 )
\r
3563 /* A tick interrupt has already occurred but was held pending
\r
3564 * because the scheduler is suspended. */
\r
3565 eReturn = eAbortSleep;
\r
3568 #if ( INCLUDE_vTaskSuspend == 1 )
\r
3569 else if( listCURRENT_LIST_LENGTH( &xSuspendedTaskList ) == ( uxCurrentNumberOfTasks - uxNonApplicationTasks ) )
\r
3571 /* If all the tasks are in the suspended list (which might mean they
\r
3572 * have an infinite block time rather than actually being suspended)
\r
3573 * then it is safe to turn all clocks off and just wait for external
\r
3575 eReturn = eNoTasksWaitingTimeout;
\r
3577 #endif /* INCLUDE_vTaskSuspend */
\r
3580 mtCOVERAGE_TEST_MARKER();
\r
3586 #endif /* configUSE_TICKLESS_IDLE */
\r
3587 /*-----------------------------------------------------------*/
\r
3589 #if ( configNUM_THREAD_LOCAL_STORAGE_POINTERS != 0 )
\r
3591 void vTaskSetThreadLocalStoragePointer( TaskHandle_t xTaskToSet,
\r
3592 BaseType_t xIndex,
\r
3597 if( xIndex < configNUM_THREAD_LOCAL_STORAGE_POINTERS )
\r
3599 pxTCB = prvGetTCBFromHandle( xTaskToSet );
\r
3600 configASSERT( pxTCB != NULL );
\r
3601 pxTCB->pvThreadLocalStoragePointers[ xIndex ] = pvValue;
\r
3605 #endif /* configNUM_THREAD_LOCAL_STORAGE_POINTERS */
\r
3606 /*-----------------------------------------------------------*/
\r
3608 #if ( configNUM_THREAD_LOCAL_STORAGE_POINTERS != 0 )
\r
3610 void * pvTaskGetThreadLocalStoragePointer( TaskHandle_t xTaskToQuery,
\r
3611 BaseType_t xIndex )
\r
3613 void * pvReturn = NULL;
\r
3616 if( xIndex < configNUM_THREAD_LOCAL_STORAGE_POINTERS )
\r
3618 pxTCB = prvGetTCBFromHandle( xTaskToQuery );
\r
3619 pvReturn = pxTCB->pvThreadLocalStoragePointers[ xIndex ];
\r
3629 #endif /* configNUM_THREAD_LOCAL_STORAGE_POINTERS */
\r
3630 /*-----------------------------------------------------------*/
\r
3632 #if ( portUSING_MPU_WRAPPERS == 1 )
\r
3634 void vTaskAllocateMPURegions( TaskHandle_t xTaskToModify,
\r
3635 const MemoryRegion_t * const xRegions )
\r
3639 /* If null is passed in here then we are modifying the MPU settings of
\r
3640 * the calling task. */
\r
3641 pxTCB = prvGetTCBFromHandle( xTaskToModify );
\r
3643 vPortStoreTaskMPUSettings( &( pxTCB->xMPUSettings ), xRegions, NULL, 0 );
\r
3646 #endif /* portUSING_MPU_WRAPPERS */
\r
3647 /*-----------------------------------------------------------*/
\r
3649 static void prvInitialiseTaskLists( void )
\r
3651 UBaseType_t uxPriority;
\r
3653 for( uxPriority = ( UBaseType_t ) 0U; uxPriority < ( UBaseType_t ) configMAX_PRIORITIES; uxPriority++ )
\r
3655 vListInitialise( &( pxReadyTasksLists[ uxPriority ] ) );
\r
3658 vListInitialise( &xDelayedTaskList1 );
\r
3659 vListInitialise( &xDelayedTaskList2 );
\r
3660 vListInitialise( &xPendingReadyList );
\r
3662 #if ( INCLUDE_vTaskDelete == 1 )
\r
3664 vListInitialise( &xTasksWaitingTermination );
\r
3666 #endif /* INCLUDE_vTaskDelete */
\r
3668 #if ( INCLUDE_vTaskSuspend == 1 )
\r
3670 vListInitialise( &xSuspendedTaskList );
\r
3672 #endif /* INCLUDE_vTaskSuspend */
\r
3674 /* Start with pxDelayedTaskList using list1 and the pxOverflowDelayedTaskList
\r
3676 pxDelayedTaskList = &xDelayedTaskList1;
\r
3677 pxOverflowDelayedTaskList = &xDelayedTaskList2;
\r
3679 /*-----------------------------------------------------------*/
\r
3681 static void prvCheckTasksWaitingTermination( void )
\r
3683 /** THIS FUNCTION IS CALLED FROM THE RTOS IDLE TASK **/
\r
3685 #if ( INCLUDE_vTaskDelete == 1 )
\r
3689 /* uxDeletedTasksWaitingCleanUp is used to prevent taskENTER_CRITICAL()
\r
3690 * being called too often in the idle task. */
\r
3691 while( uxDeletedTasksWaitingCleanUp > ( UBaseType_t ) 0U )
\r
3693 taskENTER_CRITICAL();
\r
3695 pxTCB = listGET_OWNER_OF_HEAD_ENTRY( ( &xTasksWaitingTermination ) ); /*lint !e9079 void * is used as this macro is used with timers and co-routines too. Alignment is known to be fine as the type of the pointer stored and retrieved is the same. */
\r
3696 ( void ) uxListRemove( &( pxTCB->xStateListItem ) );
\r
3697 --uxCurrentNumberOfTasks;
\r
3698 --uxDeletedTasksWaitingCleanUp;
\r
3700 taskEXIT_CRITICAL();
\r
3702 prvDeleteTCB( pxTCB );
\r
3705 #endif /* INCLUDE_vTaskDelete */
\r
3707 /*-----------------------------------------------------------*/
\r
3709 #if ( configUSE_TRACE_FACILITY == 1 )
\r
3711 void vTaskGetInfo( TaskHandle_t xTask,
\r
3712 TaskStatus_t * pxTaskStatus,
\r
3713 BaseType_t xGetFreeStackSpace,
\r
3714 eTaskState eState )
\r
3718 /* xTask is NULL then get the state of the calling task. */
\r
3719 pxTCB = prvGetTCBFromHandle( xTask );
\r
3721 pxTaskStatus->xHandle = ( TaskHandle_t ) pxTCB;
\r
3722 pxTaskStatus->pcTaskName = ( const char * ) &( pxTCB->pcTaskName[ 0 ] );
\r
3723 pxTaskStatus->uxCurrentPriority = pxTCB->uxPriority;
\r
3724 pxTaskStatus->pxStackBase = pxTCB->pxStack;
\r
3725 #if ( ( portSTACK_GROWTH > 0 ) && ( configRECORD_STACK_HIGH_ADDRESS == 1 ) )
\r
3726 pxTaskStatus->pxTopOfStack = pxTCB->pxTopOfStack;
\r
3727 pxTaskStatus->pxEndOfStack = pxTCB->pxEndOfStack;
\r
3729 pxTaskStatus->xTaskNumber = pxTCB->uxTCBNumber;
\r
3731 #if ( configUSE_MUTEXES == 1 )
\r
3733 pxTaskStatus->uxBasePriority = pxTCB->uxBasePriority;
\r
3737 pxTaskStatus->uxBasePriority = 0;
\r
3741 #if ( configGENERATE_RUN_TIME_STATS == 1 )
\r
3743 pxTaskStatus->ulRunTimeCounter = pxTCB->ulRunTimeCounter;
\r
3747 pxTaskStatus->ulRunTimeCounter = ( configRUN_TIME_COUNTER_TYPE ) 0;
\r
3751 /* Obtaining the task state is a little fiddly, so is only done if the
\r
3752 * value of eState passed into this function is eInvalid - otherwise the
\r
3753 * state is just set to whatever is passed in. */
\r
3754 if( eState != eInvalid )
\r
3756 if( pxTCB == pxCurrentTCB )
\r
3758 pxTaskStatus->eCurrentState = eRunning;
\r
3762 pxTaskStatus->eCurrentState = eState;
\r
3764 #if ( INCLUDE_vTaskSuspend == 1 )
\r
3766 /* If the task is in the suspended list then there is a
\r
3767 * chance it is actually just blocked indefinitely - so really
\r
3768 * it should be reported as being in the Blocked state. */
\r
3769 if( eState == eSuspended )
\r
3771 vTaskSuspendAll();
\r
3773 if( listLIST_ITEM_CONTAINER( &( pxTCB->xEventListItem ) ) != NULL )
\r
3775 pxTaskStatus->eCurrentState = eBlocked;
\r
3778 ( void ) xTaskResumeAll();
\r
3781 #endif /* INCLUDE_vTaskSuspend */
\r
3786 pxTaskStatus->eCurrentState = eTaskGetState( pxTCB );
\r
3789 /* Obtaining the stack space takes some time, so the xGetFreeStackSpace
\r
3790 * parameter is provided to allow it to be skipped. */
\r
3791 if( xGetFreeStackSpace != pdFALSE )
\r
3793 #if ( portSTACK_GROWTH > 0 )
\r
3795 pxTaskStatus->usStackHighWaterMark = prvTaskCheckFreeStackSpace( ( uint8_t * ) pxTCB->pxEndOfStack );
\r
3799 pxTaskStatus->usStackHighWaterMark = prvTaskCheckFreeStackSpace( ( uint8_t * ) pxTCB->pxStack );
\r
3805 pxTaskStatus->usStackHighWaterMark = 0;
\r
3809 #endif /* configUSE_TRACE_FACILITY */
\r
3810 /*-----------------------------------------------------------*/
\r
3812 #if ( configUSE_TRACE_FACILITY == 1 )
\r
3814 static UBaseType_t prvListTasksWithinSingleList( TaskStatus_t * pxTaskStatusArray,
\r
3816 eTaskState eState )
\r
3818 configLIST_VOLATILE TCB_t * pxNextTCB, * pxFirstTCB;
\r
3819 UBaseType_t uxTask = 0;
\r
3821 if( listCURRENT_LIST_LENGTH( pxList ) > ( UBaseType_t ) 0 )
\r
3823 listGET_OWNER_OF_NEXT_ENTRY( pxFirstTCB, pxList ); /*lint !e9079 void * is used as this macro is used with timers and co-routines too. Alignment is known to be fine as the type of the pointer stored and retrieved is the same. */
\r
3825 /* Populate an TaskStatus_t structure within the
\r
3826 * pxTaskStatusArray array for each task that is referenced from
\r
3827 * pxList. See the definition of TaskStatus_t in task.h for the
\r
3828 * meaning of each TaskStatus_t structure member. */
\r
3831 listGET_OWNER_OF_NEXT_ENTRY( pxNextTCB, pxList ); /*lint !e9079 void * is used as this macro is used with timers and co-routines too. Alignment is known to be fine as the type of the pointer stored and retrieved is the same. */
\r
3832 vTaskGetInfo( ( TaskHandle_t ) pxNextTCB, &( pxTaskStatusArray[ uxTask ] ), pdTRUE, eState );
\r
3834 } while( pxNextTCB != pxFirstTCB );
\r
3838 mtCOVERAGE_TEST_MARKER();
\r
3844 #endif /* configUSE_TRACE_FACILITY */
\r
3845 /*-----------------------------------------------------------*/
\r
3847 #if ( ( configUSE_TRACE_FACILITY == 1 ) || ( INCLUDE_uxTaskGetStackHighWaterMark == 1 ) || ( INCLUDE_uxTaskGetStackHighWaterMark2 == 1 ) )
\r
3849 static configSTACK_DEPTH_TYPE prvTaskCheckFreeStackSpace( const uint8_t * pucStackByte )
\r
3851 uint32_t ulCount = 0U;
\r
3853 while( *pucStackByte == ( uint8_t ) tskSTACK_FILL_BYTE )
\r
3855 pucStackByte -= portSTACK_GROWTH;
\r
3859 ulCount /= ( uint32_t ) sizeof( StackType_t ); /*lint !e961 Casting is not redundant on smaller architectures. */
\r
3861 return ( configSTACK_DEPTH_TYPE ) ulCount;
\r
3864 #endif /* ( ( configUSE_TRACE_FACILITY == 1 ) || ( INCLUDE_uxTaskGetStackHighWaterMark == 1 ) || ( INCLUDE_uxTaskGetStackHighWaterMark2 == 1 ) ) */
\r
3865 /*-----------------------------------------------------------*/
\r
3867 #if ( INCLUDE_uxTaskGetStackHighWaterMark2 == 1 )
\r
3869 /* uxTaskGetStackHighWaterMark() and uxTaskGetStackHighWaterMark2() are the
\r
3870 * same except for their return type. Using configSTACK_DEPTH_TYPE allows the
\r
3871 * user to determine the return type. It gets around the problem of the value
\r
3872 * overflowing on 8-bit types without breaking backward compatibility for
\r
3873 * applications that expect an 8-bit return type. */
\r
3874 configSTACK_DEPTH_TYPE uxTaskGetStackHighWaterMark2( TaskHandle_t xTask )
\r
3877 uint8_t * pucEndOfStack;
\r
3878 configSTACK_DEPTH_TYPE uxReturn;
\r
3880 /* uxTaskGetStackHighWaterMark() and uxTaskGetStackHighWaterMark2() are
\r
3881 * the same except for their return type. Using configSTACK_DEPTH_TYPE
\r
3882 * allows the user to determine the return type. It gets around the
\r
3883 * problem of the value overflowing on 8-bit types without breaking
\r
3884 * backward compatibility for applications that expect an 8-bit return
\r
3887 pxTCB = prvGetTCBFromHandle( xTask );
\r
3889 #if portSTACK_GROWTH < 0
\r
3891 pucEndOfStack = ( uint8_t * ) pxTCB->pxStack;
\r
3895 pucEndOfStack = ( uint8_t * ) pxTCB->pxEndOfStack;
\r
3899 uxReturn = prvTaskCheckFreeStackSpace( pucEndOfStack );
\r
3904 #endif /* INCLUDE_uxTaskGetStackHighWaterMark2 */
\r
3905 /*-----------------------------------------------------------*/
\r
3907 #if ( INCLUDE_uxTaskGetStackHighWaterMark == 1 )
\r
3909 UBaseType_t uxTaskGetStackHighWaterMark( TaskHandle_t xTask )
\r
3912 uint8_t * pucEndOfStack;
\r
3913 UBaseType_t uxReturn;
\r
3915 pxTCB = prvGetTCBFromHandle( xTask );
\r
3917 #if portSTACK_GROWTH < 0
\r
3919 pucEndOfStack = ( uint8_t * ) pxTCB->pxStack;
\r
3923 pucEndOfStack = ( uint8_t * ) pxTCB->pxEndOfStack;
\r
3927 uxReturn = ( UBaseType_t ) prvTaskCheckFreeStackSpace( pucEndOfStack );
\r
3932 #endif /* INCLUDE_uxTaskGetStackHighWaterMark */
\r
3933 /*-----------------------------------------------------------*/
\r
3935 #if ( INCLUDE_vTaskDelete == 1 )
\r
3937 static void prvDeleteTCB( TCB_t * pxTCB )
\r
3939 /* This call is required specifically for the TriCore port. It must be
\r
3940 * above the vPortFree() calls. The call is also used by ports/demos that
\r
3941 * want to allocate and clean RAM statically. */
\r
3942 portCLEAN_UP_TCB( pxTCB );
\r
3944 #if ( ( configUSE_NEWLIB_REENTRANT == 1 ) || ( configUSE_C_RUNTIME_TLS_SUPPORT == 1 ) )
\r
3946 /* Free up the memory allocated for the task's TLS Block. */
\r
3947 configDEINIT_TLS_BLOCK( pxCurrentTCB->xTLSBlock );
\r
3951 #if ( ( configSUPPORT_DYNAMIC_ALLOCATION == 1 ) && ( configSUPPORT_STATIC_ALLOCATION == 0 ) && ( portUSING_MPU_WRAPPERS == 0 ) )
\r
3953 /* The task can only have been allocated dynamically - free both
\r
3954 * the stack and TCB. */
\r
3955 vPortFreeStack( pxTCB->pxStack );
\r
3956 vPortFree( pxTCB );
\r
3958 #elif ( tskSTATIC_AND_DYNAMIC_ALLOCATION_POSSIBLE != 0 ) /*lint !e731 !e9029 Macro has been consolidated for readability reasons. */
\r
3960 /* The task could have been allocated statically or dynamically, so
\r
3961 * check what was statically allocated before trying to free the
\r
3963 if( pxTCB->ucStaticallyAllocated == tskDYNAMICALLY_ALLOCATED_STACK_AND_TCB )
\r
3965 /* Both the stack and TCB were allocated dynamically, so both
\r
3966 * must be freed. */
\r
3967 vPortFreeStack( pxTCB->pxStack );
\r
3968 vPortFree( pxTCB );
\r
3970 else if( pxTCB->ucStaticallyAllocated == tskSTATICALLY_ALLOCATED_STACK_ONLY )
\r
3972 /* Only the stack was statically allocated, so the TCB is the
\r
3973 * only memory that must be freed. */
\r
3974 vPortFree( pxTCB );
\r
3978 /* Neither the stack nor the TCB were allocated dynamically, so
\r
3979 * nothing needs to be freed. */
\r
3980 configASSERT( pxTCB->ucStaticallyAllocated == tskSTATICALLY_ALLOCATED_STACK_AND_TCB );
\r
3981 mtCOVERAGE_TEST_MARKER();
\r
3984 #endif /* configSUPPORT_DYNAMIC_ALLOCATION */
\r
3987 #endif /* INCLUDE_vTaskDelete */
\r
3988 /*-----------------------------------------------------------*/
\r
3990 static void prvResetNextTaskUnblockTime( void )
\r
3992 if( listLIST_IS_EMPTY( pxDelayedTaskList ) != pdFALSE )
\r
3994 /* The new current delayed list is empty. Set xNextTaskUnblockTime to
\r
3995 * the maximum possible value so it is extremely unlikely that the
\r
3996 * if( xTickCount >= xNextTaskUnblockTime ) test will pass until
\r
3997 * there is an item in the delayed list. */
\r
3998 xNextTaskUnblockTime = portMAX_DELAY;
\r
4002 /* The new current delayed list is not empty, get the value of
\r
4003 * the item at the head of the delayed list. This is the time at
\r
4004 * which the task at the head of the delayed list should be removed
\r
4005 * from the Blocked state. */
\r
4006 xNextTaskUnblockTime = listGET_ITEM_VALUE_OF_HEAD_ENTRY( pxDelayedTaskList );
\r
4009 /*-----------------------------------------------------------*/
\r
4011 #if ( ( INCLUDE_xTaskGetCurrentTaskHandle == 1 ) || ( configUSE_MUTEXES == 1 ) )
\r
4013 TaskHandle_t xTaskGetCurrentTaskHandle( void )
\r
4015 TaskHandle_t xReturn;
\r
4017 /* A critical section is not required as this is not called from
\r
4018 * an interrupt and the current TCB will always be the same for any
\r
4019 * individual execution thread. */
\r
4020 xReturn = pxCurrentTCB;
\r
4025 #endif /* ( ( INCLUDE_xTaskGetCurrentTaskHandle == 1 ) || ( configUSE_MUTEXES == 1 ) ) */
\r
4026 /*-----------------------------------------------------------*/
\r
4028 #if ( ( INCLUDE_xTaskGetSchedulerState == 1 ) || ( configUSE_TIMERS == 1 ) )
\r
4030 BaseType_t xTaskGetSchedulerState( void )
\r
4032 BaseType_t xReturn;
\r
4034 if( xSchedulerRunning == pdFALSE )
\r
4036 xReturn = taskSCHEDULER_NOT_STARTED;
\r
4040 if( uxSchedulerSuspended == ( UBaseType_t ) pdFALSE )
\r
4042 xReturn = taskSCHEDULER_RUNNING;
\r
4046 xReturn = taskSCHEDULER_SUSPENDED;
\r
4053 #endif /* ( ( INCLUDE_xTaskGetSchedulerState == 1 ) || ( configUSE_TIMERS == 1 ) ) */
\r
4054 /*-----------------------------------------------------------*/
\r
4056 #if ( configUSE_MUTEXES == 1 )
\r
4058 BaseType_t xTaskPriorityInherit( TaskHandle_t const pxMutexHolder )
\r
4060 TCB_t * const pxMutexHolderTCB = pxMutexHolder;
\r
4061 BaseType_t xReturn = pdFALSE;
\r
4063 /* If the mutex was given back by an interrupt while the queue was
\r
4064 * locked then the mutex holder might now be NULL. _RB_ Is this still
\r
4065 * needed as interrupts can no longer use mutexes? */
\r
4066 if( pxMutexHolder != NULL )
\r
4068 /* If the holder of the mutex has a priority below the priority of
\r
4069 * the task attempting to obtain the mutex then it will temporarily
\r
4070 * inherit the priority of the task attempting to obtain the mutex. */
\r
4071 if( pxMutexHolderTCB->uxPriority < pxCurrentTCB->uxPriority )
\r
4073 /* Adjust the mutex holder state to account for its new
\r
4074 * priority. Only reset the event list item value if the value is
\r
4075 * not being used for anything else. */
\r
4076 if( ( listGET_LIST_ITEM_VALUE( &( pxMutexHolderTCB->xEventListItem ) ) & taskEVENT_LIST_ITEM_VALUE_IN_USE ) == 0UL )
\r
4078 listSET_LIST_ITEM_VALUE( &( pxMutexHolderTCB->xEventListItem ), ( TickType_t ) configMAX_PRIORITIES - ( TickType_t ) pxCurrentTCB->uxPriority ); /*lint !e961 MISRA exception as the casts are only redundant for some ports. */
\r
4082 mtCOVERAGE_TEST_MARKER();
\r
4085 /* If the task being modified is in the ready state it will need
\r
4086 * to be moved into a new list. */
\r
4087 if( listIS_CONTAINED_WITHIN( &( pxReadyTasksLists[ pxMutexHolderTCB->uxPriority ] ), &( pxMutexHolderTCB->xStateListItem ) ) != pdFALSE )
\r
4089 if( uxListRemove( &( pxMutexHolderTCB->xStateListItem ) ) == ( UBaseType_t ) 0 )
\r
4091 /* It is known that the task is in its ready list so
\r
4092 * there is no need to check again and the port level
\r
4093 * reset macro can be called directly. */
\r
4094 portRESET_READY_PRIORITY( pxMutexHolderTCB->uxPriority, uxTopReadyPriority );
\r
4098 mtCOVERAGE_TEST_MARKER();
\r
4101 /* Inherit the priority before being moved into the new list. */
\r
4102 pxMutexHolderTCB->uxPriority = pxCurrentTCB->uxPriority;
\r
4103 prvAddTaskToReadyList( pxMutexHolderTCB );
\r
4107 /* Just inherit the priority. */
\r
4108 pxMutexHolderTCB->uxPriority = pxCurrentTCB->uxPriority;
\r
4111 traceTASK_PRIORITY_INHERIT( pxMutexHolderTCB, pxCurrentTCB->uxPriority );
\r
4113 /* Inheritance occurred. */
\r
4118 if( pxMutexHolderTCB->uxBasePriority < pxCurrentTCB->uxPriority )
\r
4120 /* The base priority of the mutex holder is lower than the
\r
4121 * priority of the task attempting to take the mutex, but the
\r
4122 * current priority of the mutex holder is not lower than the
\r
4123 * priority of the task attempting to take the mutex.
\r
4124 * Therefore the mutex holder must have already inherited a
\r
4125 * priority, but inheritance would have occurred if that had
\r
4126 * not been the case. */
\r
4131 mtCOVERAGE_TEST_MARKER();
\r
4137 mtCOVERAGE_TEST_MARKER();
\r
4143 #endif /* configUSE_MUTEXES */
\r
4144 /*-----------------------------------------------------------*/
\r
4146 #if ( configUSE_MUTEXES == 1 )
\r
4148 BaseType_t xTaskPriorityDisinherit( TaskHandle_t const pxMutexHolder )
\r
4150 TCB_t * const pxTCB = pxMutexHolder;
\r
4151 BaseType_t xReturn = pdFALSE;
\r
4153 if( pxMutexHolder != NULL )
\r
4155 /* A task can only have an inherited priority if it holds the mutex.
\r
4156 * If the mutex is held by a task then it cannot be given from an
\r
4157 * interrupt, and if a mutex is given by the holding task then it must
\r
4158 * be the running state task. */
\r
4159 configASSERT( pxTCB == pxCurrentTCB );
\r
4160 configASSERT( pxTCB->uxMutexesHeld );
\r
4161 ( pxTCB->uxMutexesHeld )--;
\r
4163 /* Has the holder of the mutex inherited the priority of another
\r
4165 if( pxTCB->uxPriority != pxTCB->uxBasePriority )
\r
4167 /* Only disinherit if no other mutexes are held. */
\r
4168 if( pxTCB->uxMutexesHeld == ( UBaseType_t ) 0 )
\r
4170 /* A task can only have an inherited priority if it holds
\r
4171 * the mutex. If the mutex is held by a task then it cannot be
\r
4172 * given from an interrupt, and if a mutex is given by the
\r
4173 * holding task then it must be the running state task. Remove
\r
4174 * the holding task from the ready list. */
\r
4175 if( uxListRemove( &( pxTCB->xStateListItem ) ) == ( UBaseType_t ) 0 )
\r
4177 portRESET_READY_PRIORITY( pxTCB->uxPriority, uxTopReadyPriority );
\r
4181 mtCOVERAGE_TEST_MARKER();
\r
4184 /* Disinherit the priority before adding the task into the
\r
4185 * new ready list. */
\r
4186 traceTASK_PRIORITY_DISINHERIT( pxTCB, pxTCB->uxBasePriority );
\r
4187 pxTCB->uxPriority = pxTCB->uxBasePriority;
\r
4189 /* Reset the event list item value. It cannot be in use for
\r
4190 * any other purpose if this task is running, and it must be
\r
4191 * running to give back the mutex. */
\r
4192 listSET_LIST_ITEM_VALUE( &( pxTCB->xEventListItem ), ( TickType_t ) configMAX_PRIORITIES - ( TickType_t ) pxTCB->uxPriority ); /*lint !e961 MISRA exception as the casts are only redundant for some ports. */
\r
4193 prvAddTaskToReadyList( pxTCB );
\r
4195 /* Return true to indicate that a context switch is required.
\r
4196 * This is only actually required in the corner case whereby
\r
4197 * multiple mutexes were held and the mutexes were given back
\r
4198 * in an order different to that in which they were taken.
\r
4199 * If a context switch did not occur when the first mutex was
\r
4200 * returned, even if a task was waiting on it, then a context
\r
4201 * switch should occur when the last mutex is returned whether
\r
4202 * a task is waiting on it or not. */
\r
4207 mtCOVERAGE_TEST_MARKER();
\r
4212 mtCOVERAGE_TEST_MARKER();
\r
4217 mtCOVERAGE_TEST_MARKER();
\r
4223 #endif /* configUSE_MUTEXES */
\r
4224 /*-----------------------------------------------------------*/
\r
4226 #if ( configUSE_MUTEXES == 1 )
\r
4228 void vTaskPriorityDisinheritAfterTimeout( TaskHandle_t const pxMutexHolder,
\r
4229 UBaseType_t uxHighestPriorityWaitingTask )
\r
4231 TCB_t * const pxTCB = pxMutexHolder;
\r
4232 UBaseType_t uxPriorityUsedOnEntry, uxPriorityToUse;
\r
4233 const UBaseType_t uxOnlyOneMutexHeld = ( UBaseType_t ) 1;
\r
4235 if( pxMutexHolder != NULL )
\r
4237 /* If pxMutexHolder is not NULL then the holder must hold at least
\r
4239 configASSERT( pxTCB->uxMutexesHeld );
\r
4241 /* Determine the priority to which the priority of the task that
\r
4242 * holds the mutex should be set. This will be the greater of the
\r
4243 * holding task's base priority and the priority of the highest
\r
4244 * priority task that is waiting to obtain the mutex. */
\r
4245 if( pxTCB->uxBasePriority < uxHighestPriorityWaitingTask )
\r
4247 uxPriorityToUse = uxHighestPriorityWaitingTask;
\r
4251 uxPriorityToUse = pxTCB->uxBasePriority;
\r
4254 /* Does the priority need to change? */
\r
4255 if( pxTCB->uxPriority != uxPriorityToUse )
\r
4257 /* Only disinherit if no other mutexes are held. This is a
\r
4258 * simplification in the priority inheritance implementation. If
\r
4259 * the task that holds the mutex is also holding other mutexes then
\r
4260 * the other mutexes may have caused the priority inheritance. */
\r
4261 if( pxTCB->uxMutexesHeld == uxOnlyOneMutexHeld )
\r
4263 /* If a task has timed out because it already holds the
\r
4264 * mutex it was trying to obtain then it cannot of inherited
\r
4265 * its own priority. */
\r
4266 configASSERT( pxTCB != pxCurrentTCB );
\r
4268 /* Disinherit the priority, remembering the previous
\r
4269 * priority to facilitate determining the subject task's
\r
4271 traceTASK_PRIORITY_DISINHERIT( pxTCB, uxPriorityToUse );
\r
4272 uxPriorityUsedOnEntry = pxTCB->uxPriority;
\r
4273 pxTCB->uxPriority = uxPriorityToUse;
\r
4275 /* Only reset the event list item value if the value is not
\r
4276 * being used for anything else. */
\r
4277 if( ( listGET_LIST_ITEM_VALUE( &( pxTCB->xEventListItem ) ) & taskEVENT_LIST_ITEM_VALUE_IN_USE ) == 0UL )
\r
4279 listSET_LIST_ITEM_VALUE( &( pxTCB->xEventListItem ), ( TickType_t ) configMAX_PRIORITIES - ( TickType_t ) uxPriorityToUse ); /*lint !e961 MISRA exception as the casts are only redundant for some ports. */
\r
4283 mtCOVERAGE_TEST_MARKER();
\r
4286 /* If the running task is not the task that holds the mutex
\r
4287 * then the task that holds the mutex could be in either the
\r
4288 * Ready, Blocked or Suspended states. Only remove the task
\r
4289 * from its current state list if it is in the Ready state as
\r
4290 * the task's priority is going to change and there is one
\r
4291 * Ready list per priority. */
\r
4292 if( listIS_CONTAINED_WITHIN( &( pxReadyTasksLists[ uxPriorityUsedOnEntry ] ), &( pxTCB->xStateListItem ) ) != pdFALSE )
\r
4294 if( uxListRemove( &( pxTCB->xStateListItem ) ) == ( UBaseType_t ) 0 )
\r
4296 /* It is known that the task is in its ready list so
\r
4297 * there is no need to check again and the port level
\r
4298 * reset macro can be called directly. */
\r
4299 portRESET_READY_PRIORITY( pxTCB->uxPriority, uxTopReadyPriority );
\r
4303 mtCOVERAGE_TEST_MARKER();
\r
4306 prvAddTaskToReadyList( pxTCB );
\r
4310 mtCOVERAGE_TEST_MARKER();
\r
4315 mtCOVERAGE_TEST_MARKER();
\r
4320 mtCOVERAGE_TEST_MARKER();
\r
4325 mtCOVERAGE_TEST_MARKER();
\r
4329 #endif /* configUSE_MUTEXES */
\r
4330 /*-----------------------------------------------------------*/
\r
4332 #if ( portCRITICAL_NESTING_IN_TCB == 1 )
\r
4334 void vTaskEnterCritical( void )
\r
4336 portDISABLE_INTERRUPTS();
\r
4338 if( xSchedulerRunning != pdFALSE )
\r
4340 ( pxCurrentTCB->uxCriticalNesting )++;
\r
4342 /* This is not the interrupt safe version of the enter critical
\r
4343 * function so assert() if it is being called from an interrupt
\r
4344 * context. Only API functions that end in "FromISR" can be used in an
\r
4345 * interrupt. Only assert if the critical nesting count is 1 to
\r
4346 * protect against recursive calls if the assert function also uses a
\r
4347 * critical section. */
\r
4348 if( pxCurrentTCB->uxCriticalNesting == 1 )
\r
4350 portASSERT_IF_IN_ISR();
\r
4355 mtCOVERAGE_TEST_MARKER();
\r
4359 #endif /* portCRITICAL_NESTING_IN_TCB */
\r
4360 /*-----------------------------------------------------------*/
\r
4362 #if ( portCRITICAL_NESTING_IN_TCB == 1 )
\r
4364 void vTaskExitCritical( void )
\r
4366 if( xSchedulerRunning != pdFALSE )
\r
4368 if( pxCurrentTCB->uxCriticalNesting > 0U )
\r
4370 ( pxCurrentTCB->uxCriticalNesting )--;
\r
4372 if( pxCurrentTCB->uxCriticalNesting == 0U )
\r
4374 portENABLE_INTERRUPTS();
\r
4378 mtCOVERAGE_TEST_MARKER();
\r
4383 mtCOVERAGE_TEST_MARKER();
\r
4388 mtCOVERAGE_TEST_MARKER();
\r
4392 #endif /* portCRITICAL_NESTING_IN_TCB */
\r
4393 /*-----------------------------------------------------------*/
\r
4395 #if ( ( ( configUSE_TRACE_FACILITY == 1 ) || ( configGENERATE_RUN_TIME_STATS == 1 ) ) && \
\r
4396 ( configUSE_STATS_FORMATTING_FUNCTIONS > 0 ) && \
\r
4397 ( configSUPPORT_DYNAMIC_ALLOCATION == 1 ) )
\r
4399 static char * prvWriteNameToBuffer( char * pcBuffer,
\r
4400 const char * pcTaskName )
\r
4404 /* Start by copying the entire string. */
\r
4405 strcpy( pcBuffer, pcTaskName );
\r
4407 /* Pad the end of the string with spaces to ensure columns line up when
\r
4409 for( x = strlen( pcBuffer ); x < ( size_t ) ( configMAX_TASK_NAME_LEN - 1 ); x++ )
\r
4411 pcBuffer[ x ] = ' ';
\r
4415 pcBuffer[ x ] = ( char ) 0x00;
\r
4417 /* Return the new end of string. */
\r
4418 return &( pcBuffer[ x ] );
\r
4421 #endif /* ( configUSE_TRACE_FACILITY == 1 ) && ( configUSE_STATS_FORMATTING_FUNCTIONS > 0 ) */
\r
4422 /*-----------------------------------------------------------*/
\r
4424 #if ( ( configUSE_TRACE_FACILITY == 1 ) && ( configUSE_STATS_FORMATTING_FUNCTIONS > 0 ) && ( configSUPPORT_DYNAMIC_ALLOCATION == 1 ) )
\r
4426 void vTaskList( char * pcWriteBuffer )
\r
4428 TaskStatus_t * pxTaskStatusArray;
\r
4429 UBaseType_t uxArraySize, x;
\r
4435 * This function is provided for convenience only, and is used by many
\r
4436 * of the demo applications. Do not consider it to be part of the
\r
4439 * vTaskList() calls uxTaskGetSystemState(), then formats part of the
\r
4440 * uxTaskGetSystemState() output into a human readable table that
\r
4441 * displays task: names, states, priority, stack usage and task number.
\r
4442 * Stack usage specified as the number of unused StackType_t words stack can hold
\r
4443 * on top of stack - not the number of bytes.
\r
4445 * vTaskList() has a dependency on the sprintf() C library function that
\r
4446 * might bloat the code size, use a lot of stack, and provide different
\r
4447 * results on different platforms. An alternative, tiny, third party,
\r
4448 * and limited functionality implementation of sprintf() is provided in
\r
4449 * many of the FreeRTOS/Demo sub-directories in a file called
\r
4450 * printf-stdarg.c (note printf-stdarg.c does not provide a full
\r
4451 * snprintf() implementation!).
\r
4453 * It is recommended that production systems call uxTaskGetSystemState()
\r
4454 * directly to get access to raw stats data, rather than indirectly
\r
4455 * through a call to vTaskList().
\r
4459 /* Make sure the write buffer does not contain a string. */
\r
4460 *pcWriteBuffer = ( char ) 0x00;
\r
4462 /* Take a snapshot of the number of tasks in case it changes while this
\r
4463 * function is executing. */
\r
4464 uxArraySize = uxCurrentNumberOfTasks;
\r
4466 /* Allocate an array index for each task. NOTE! if
\r
4467 * configSUPPORT_DYNAMIC_ALLOCATION is set to 0 then pvPortMalloc() will
\r
4468 * equate to NULL. */
\r
4469 pxTaskStatusArray = pvPortMalloc( uxCurrentNumberOfTasks * sizeof( TaskStatus_t ) ); /*lint !e9079 All values returned by pvPortMalloc() have at least the alignment required by the MCU's stack and this allocation allocates a struct that has the alignment requirements of a pointer. */
\r
4471 if( pxTaskStatusArray != NULL )
\r
4473 /* Generate the (binary) data. */
\r
4474 uxArraySize = uxTaskGetSystemState( pxTaskStatusArray, uxArraySize, NULL );
\r
4476 /* Create a human readable table from the binary data. */
\r
4477 for( x = 0; x < uxArraySize; x++ )
\r
4479 switch( pxTaskStatusArray[ x ].eCurrentState )
\r
4482 cStatus = tskRUNNING_CHAR;
\r
4486 cStatus = tskREADY_CHAR;
\r
4490 cStatus = tskBLOCKED_CHAR;
\r
4494 cStatus = tskSUSPENDED_CHAR;
\r
4498 cStatus = tskDELETED_CHAR;
\r
4501 case eInvalid: /* Fall through. */
\r
4502 default: /* Should not get here, but it is included
\r
4503 * to prevent static checking errors. */
\r
4504 cStatus = ( char ) 0x00;
\r
4508 /* Write the task name to the string, padding with spaces so it
\r
4509 * can be printed in tabular form more easily. */
\r
4510 pcWriteBuffer = prvWriteNameToBuffer( pcWriteBuffer, pxTaskStatusArray[ x ].pcTaskName );
\r
4512 /* Write the rest of the string. */
\r
4513 sprintf( pcWriteBuffer, "\t%c\t%u\t%u\t%u\r\n", cStatus, ( unsigned int ) pxTaskStatusArray[ x ].uxCurrentPriority, ( unsigned int ) pxTaskStatusArray[ x ].usStackHighWaterMark, ( unsigned int ) pxTaskStatusArray[ x ].xTaskNumber ); /*lint !e586 sprintf() allowed as this is compiled with many compilers and this is a utility function only - not part of the core kernel implementation. */
\r
4514 pcWriteBuffer += strlen( pcWriteBuffer ); /*lint !e9016 Pointer arithmetic ok on char pointers especially as in this case where it best denotes the intent of the code. */
\r
4517 /* Free the array again. NOTE! If configSUPPORT_DYNAMIC_ALLOCATION
\r
4518 * is 0 then vPortFree() will be #defined to nothing. */
\r
4519 vPortFree( pxTaskStatusArray );
\r
4523 mtCOVERAGE_TEST_MARKER();
\r
4527 #endif /* ( ( configUSE_TRACE_FACILITY == 1 ) && ( configUSE_STATS_FORMATTING_FUNCTIONS > 0 ) && ( configSUPPORT_DYNAMIC_ALLOCATION == 1 ) ) */
\r
4528 /*----------------------------------------------------------*/
\r
4530 #if ( ( configGENERATE_RUN_TIME_STATS == 1 ) && ( configUSE_STATS_FORMATTING_FUNCTIONS > 0 ) && ( configSUPPORT_DYNAMIC_ALLOCATION == 1 ) )
\r
4532 void vTaskGetRunTimeStats( char * pcWriteBuffer )
\r
4534 TaskStatus_t * pxTaskStatusArray;
\r
4535 UBaseType_t uxArraySize, x;
\r
4536 configRUN_TIME_COUNTER_TYPE ulTotalTime, ulStatsAsPercentage;
\r
4538 #if ( configUSE_TRACE_FACILITY != 1 )
\r
4540 #error configUSE_TRACE_FACILITY must also be set to 1 in FreeRTOSConfig.h to use vTaskGetRunTimeStats().
\r
4547 * This function is provided for convenience only, and is used by many
\r
4548 * of the demo applications. Do not consider it to be part of the
\r
4551 * vTaskGetRunTimeStats() calls uxTaskGetSystemState(), then formats part
\r
4552 * of the uxTaskGetSystemState() output into a human readable table that
\r
4553 * displays the amount of time each task has spent in the Running state
\r
4554 * in both absolute and percentage terms.
\r
4556 * vTaskGetRunTimeStats() has a dependency on the sprintf() C library
\r
4557 * function that might bloat the code size, use a lot of stack, and
\r
4558 * provide different results on different platforms. An alternative,
\r
4559 * tiny, third party, and limited functionality implementation of
\r
4560 * sprintf() is provided in many of the FreeRTOS/Demo sub-directories in
\r
4561 * a file called printf-stdarg.c (note printf-stdarg.c does not provide
\r
4562 * a full snprintf() implementation!).
\r
4564 * It is recommended that production systems call uxTaskGetSystemState()
\r
4565 * directly to get access to raw stats data, rather than indirectly
\r
4566 * through a call to vTaskGetRunTimeStats().
\r
4569 /* Make sure the write buffer does not contain a string. */
\r
4570 *pcWriteBuffer = ( char ) 0x00;
\r
4572 /* Take a snapshot of the number of tasks in case it changes while this
\r
4573 * function is executing. */
\r
4574 uxArraySize = uxCurrentNumberOfTasks;
\r
4576 /* Allocate an array index for each task. NOTE! If
\r
4577 * configSUPPORT_DYNAMIC_ALLOCATION is set to 0 then pvPortMalloc() will
\r
4578 * equate to NULL. */
\r
4579 pxTaskStatusArray = pvPortMalloc( uxCurrentNumberOfTasks * sizeof( TaskStatus_t ) ); /*lint !e9079 All values returned by pvPortMalloc() have at least the alignment required by the MCU's stack and this allocation allocates a struct that has the alignment requirements of a pointer. */
\r
4581 if( pxTaskStatusArray != NULL )
\r
4583 /* Generate the (binary) data. */
\r
4584 uxArraySize = uxTaskGetSystemState( pxTaskStatusArray, uxArraySize, &ulTotalTime );
\r
4586 /* For percentage calculations. */
\r
4587 ulTotalTime /= 100UL;
\r
4589 /* Avoid divide by zero errors. */
\r
4590 if( ulTotalTime > 0UL )
\r
4592 /* Create a human readable table from the binary data. */
\r
4593 for( x = 0; x < uxArraySize; x++ )
\r
4595 /* What percentage of the total run time has the task used?
\r
4596 * This will always be rounded down to the nearest integer.
\r
4597 * ulTotalRunTime has already been divided by 100. */
\r
4598 ulStatsAsPercentage = pxTaskStatusArray[ x ].ulRunTimeCounter / ulTotalTime;
\r
4600 /* Write the task name to the string, padding with
\r
4601 * spaces so it can be printed in tabular form more
\r
4603 pcWriteBuffer = prvWriteNameToBuffer( pcWriteBuffer, pxTaskStatusArray[ x ].pcTaskName );
\r
4605 if( ulStatsAsPercentage > 0UL )
\r
4607 #ifdef portLU_PRINTF_SPECIFIER_REQUIRED
\r
4609 sprintf( pcWriteBuffer, "\t%lu\t\t%lu%%\r\n", pxTaskStatusArray[ x ].ulRunTimeCounter, ulStatsAsPercentage );
\r
4613 /* sizeof( int ) == sizeof( long ) so a smaller
\r
4614 * printf() library can be used. */
\r
4615 sprintf( pcWriteBuffer, "\t%u\t\t%u%%\r\n", ( unsigned int ) pxTaskStatusArray[ x ].ulRunTimeCounter, ( unsigned int ) ulStatsAsPercentage ); /*lint !e586 sprintf() allowed as this is compiled with many compilers and this is a utility function only - not part of the core kernel implementation. */
\r
4621 /* If the percentage is zero here then the task has
\r
4622 * consumed less than 1% of the total run time. */
\r
4623 #ifdef portLU_PRINTF_SPECIFIER_REQUIRED
\r
4625 sprintf( pcWriteBuffer, "\t%lu\t\t<1%%\r\n", pxTaskStatusArray[ x ].ulRunTimeCounter );
\r
4629 /* sizeof( int ) == sizeof( long ) so a smaller
\r
4630 * printf() library can be used. */
\r
4631 sprintf( pcWriteBuffer, "\t%u\t\t<1%%\r\n", ( unsigned int ) pxTaskStatusArray[ x ].ulRunTimeCounter ); /*lint !e586 sprintf() allowed as this is compiled with many compilers and this is a utility function only - not part of the core kernel implementation. */
\r
4636 pcWriteBuffer += strlen( pcWriteBuffer ); /*lint !e9016 Pointer arithmetic ok on char pointers especially as in this case where it best denotes the intent of the code. */
\r
4641 mtCOVERAGE_TEST_MARKER();
\r
4644 /* Free the array again. NOTE! If configSUPPORT_DYNAMIC_ALLOCATION
\r
4645 * is 0 then vPortFree() will be #defined to nothing. */
\r
4646 vPortFree( pxTaskStatusArray );
\r
4650 mtCOVERAGE_TEST_MARKER();
\r
4654 #endif /* ( ( configGENERATE_RUN_TIME_STATS == 1 ) && ( configUSE_STATS_FORMATTING_FUNCTIONS > 0 ) && ( configSUPPORT_STATIC_ALLOCATION == 1 ) ) */
\r
4655 /*-----------------------------------------------------------*/
\r
4657 TickType_t uxTaskResetEventItemValue( void )
\r
4659 TickType_t uxReturn;
\r
4661 uxReturn = listGET_LIST_ITEM_VALUE( &( pxCurrentTCB->xEventListItem ) );
\r
4663 /* Reset the event list item to its normal value - so it can be used with
\r
4664 * queues and semaphores. */
\r
4665 listSET_LIST_ITEM_VALUE( &( pxCurrentTCB->xEventListItem ), ( ( TickType_t ) configMAX_PRIORITIES - ( TickType_t ) pxCurrentTCB->uxPriority ) ); /*lint !e961 MISRA exception as the casts are only redundant for some ports. */
\r
4669 /*-----------------------------------------------------------*/
\r
4671 #if ( configUSE_MUTEXES == 1 )
\r
4673 TaskHandle_t pvTaskIncrementMutexHeldCount( void )
\r
4675 /* If xSemaphoreCreateMutex() is called before any tasks have been created
\r
4676 * then pxCurrentTCB will be NULL. */
\r
4677 if( pxCurrentTCB != NULL )
\r
4679 ( pxCurrentTCB->uxMutexesHeld )++;
\r
4682 return pxCurrentTCB;
\r
4685 #endif /* configUSE_MUTEXES */
\r
4686 /*-----------------------------------------------------------*/
\r
4688 #if ( configUSE_TASK_NOTIFICATIONS == 1 )
\r
4690 uint32_t ulTaskGenericNotifyTake( UBaseType_t uxIndexToWait,
\r
4691 BaseType_t xClearCountOnExit,
\r
4692 TickType_t xTicksToWait )
\r
4694 uint32_t ulReturn;
\r
4696 configASSERT( uxIndexToWait < configTASK_NOTIFICATION_ARRAY_ENTRIES );
\r
4698 taskENTER_CRITICAL();
\r
4700 /* Only block if the notification count is not already non-zero. */
\r
4701 if( pxCurrentTCB->ulNotifiedValue[ uxIndexToWait ] == 0UL )
\r
4703 /* Mark this task as waiting for a notification. */
\r
4704 pxCurrentTCB->ucNotifyState[ uxIndexToWait ] = taskWAITING_NOTIFICATION;
\r
4706 if( xTicksToWait > ( TickType_t ) 0 )
\r
4708 prvAddCurrentTaskToDelayedList( xTicksToWait, pdTRUE );
\r
4709 traceTASK_NOTIFY_TAKE_BLOCK( uxIndexToWait );
\r
4711 /* All ports are written to allow a yield in a critical
\r
4712 * section (some will yield immediately, others wait until the
\r
4713 * critical section exits) - but it is not something that
\r
4714 * application code should ever do. */
\r
4715 portYIELD_WITHIN_API();
\r
4719 mtCOVERAGE_TEST_MARKER();
\r
4724 mtCOVERAGE_TEST_MARKER();
\r
4727 taskEXIT_CRITICAL();
\r
4729 taskENTER_CRITICAL();
\r
4731 traceTASK_NOTIFY_TAKE( uxIndexToWait );
\r
4732 ulReturn = pxCurrentTCB->ulNotifiedValue[ uxIndexToWait ];
\r
4734 if( ulReturn != 0UL )
\r
4736 if( xClearCountOnExit != pdFALSE )
\r
4738 pxCurrentTCB->ulNotifiedValue[ uxIndexToWait ] = 0UL;
\r
4742 pxCurrentTCB->ulNotifiedValue[ uxIndexToWait ] = ulReturn - ( uint32_t ) 1;
\r
4747 mtCOVERAGE_TEST_MARKER();
\r
4750 pxCurrentTCB->ucNotifyState[ uxIndexToWait ] = taskNOT_WAITING_NOTIFICATION;
\r
4752 taskEXIT_CRITICAL();
\r
4757 #endif /* configUSE_TASK_NOTIFICATIONS */
\r
4758 /*-----------------------------------------------------------*/
\r
4760 #if ( configUSE_TASK_NOTIFICATIONS == 1 )
\r
4762 BaseType_t xTaskGenericNotifyWait( UBaseType_t uxIndexToWait,
\r
4763 uint32_t ulBitsToClearOnEntry,
\r
4764 uint32_t ulBitsToClearOnExit,
\r
4765 uint32_t * pulNotificationValue,
\r
4766 TickType_t xTicksToWait )
\r
4768 BaseType_t xReturn;
\r
4770 configASSERT( uxIndexToWait < configTASK_NOTIFICATION_ARRAY_ENTRIES );
\r
4772 taskENTER_CRITICAL();
\r
4774 /* Only block if a notification is not already pending. */
\r
4775 if( pxCurrentTCB->ucNotifyState[ uxIndexToWait ] != taskNOTIFICATION_RECEIVED )
\r
4777 /* Clear bits in the task's notification value as bits may get
\r
4778 * set by the notifying task or interrupt. This can be used to
\r
4779 * clear the value to zero. */
\r
4780 pxCurrentTCB->ulNotifiedValue[ uxIndexToWait ] &= ~ulBitsToClearOnEntry;
\r
4782 /* Mark this task as waiting for a notification. */
\r
4783 pxCurrentTCB->ucNotifyState[ uxIndexToWait ] = taskWAITING_NOTIFICATION;
\r
4785 if( xTicksToWait > ( TickType_t ) 0 )
\r
4787 prvAddCurrentTaskToDelayedList( xTicksToWait, pdTRUE );
\r
4788 traceTASK_NOTIFY_WAIT_BLOCK( uxIndexToWait );
\r
4790 /* All ports are written to allow a yield in a critical
\r
4791 * section (some will yield immediately, others wait until the
\r
4792 * critical section exits) - but it is not something that
\r
4793 * application code should ever do. */
\r
4794 portYIELD_WITHIN_API();
\r
4798 mtCOVERAGE_TEST_MARKER();
\r
4803 mtCOVERAGE_TEST_MARKER();
\r
4806 taskEXIT_CRITICAL();
\r
4808 taskENTER_CRITICAL();
\r
4810 traceTASK_NOTIFY_WAIT( uxIndexToWait );
\r
4812 if( pulNotificationValue != NULL )
\r
4814 /* Output the current notification value, which may or may not
\r
4815 * have changed. */
\r
4816 *pulNotificationValue = pxCurrentTCB->ulNotifiedValue[ uxIndexToWait ];
\r
4819 /* If ucNotifyValue is set then either the task never entered the
\r
4820 * blocked state (because a notification was already pending) or the
\r
4821 * task unblocked because of a notification. Otherwise the task
\r
4822 * unblocked because of a timeout. */
\r
4823 if( pxCurrentTCB->ucNotifyState[ uxIndexToWait ] != taskNOTIFICATION_RECEIVED )
\r
4825 /* A notification was not received. */
\r
4826 xReturn = pdFALSE;
\r
4830 /* A notification was already pending or a notification was
\r
4831 * received while the task was waiting. */
\r
4832 pxCurrentTCB->ulNotifiedValue[ uxIndexToWait ] &= ~ulBitsToClearOnExit;
\r
4836 pxCurrentTCB->ucNotifyState[ uxIndexToWait ] = taskNOT_WAITING_NOTIFICATION;
\r
4838 taskEXIT_CRITICAL();
\r
4843 #endif /* configUSE_TASK_NOTIFICATIONS */
\r
4844 /*-----------------------------------------------------------*/
\r
4846 #if ( configUSE_TASK_NOTIFICATIONS == 1 )
\r
4848 BaseType_t xTaskGenericNotify( TaskHandle_t xTaskToNotify,
\r
4849 UBaseType_t uxIndexToNotify,
\r
4851 eNotifyAction eAction,
\r
4852 uint32_t * pulPreviousNotificationValue )
\r
4855 BaseType_t xReturn = pdPASS;
\r
4856 uint8_t ucOriginalNotifyState;
\r
4858 configASSERT( uxIndexToNotify < configTASK_NOTIFICATION_ARRAY_ENTRIES );
\r
4859 configASSERT( xTaskToNotify );
\r
4860 pxTCB = xTaskToNotify;
\r
4862 taskENTER_CRITICAL();
\r
4864 if( pulPreviousNotificationValue != NULL )
\r
4866 *pulPreviousNotificationValue = pxTCB->ulNotifiedValue[ uxIndexToNotify ];
\r
4869 ucOriginalNotifyState = pxTCB->ucNotifyState[ uxIndexToNotify ];
\r
4871 pxTCB->ucNotifyState[ uxIndexToNotify ] = taskNOTIFICATION_RECEIVED;
\r
4876 pxTCB->ulNotifiedValue[ uxIndexToNotify ] |= ulValue;
\r
4880 ( pxTCB->ulNotifiedValue[ uxIndexToNotify ] )++;
\r
4883 case eSetValueWithOverwrite:
\r
4884 pxTCB->ulNotifiedValue[ uxIndexToNotify ] = ulValue;
\r
4887 case eSetValueWithoutOverwrite:
\r
4889 if( ucOriginalNotifyState != taskNOTIFICATION_RECEIVED )
\r
4891 pxTCB->ulNotifiedValue[ uxIndexToNotify ] = ulValue;
\r
4895 /* The value could not be written to the task. */
\r
4903 /* The task is being notified without its notify value being
\r
4909 /* Should not get here if all enums are handled.
\r
4910 * Artificially force an assert by testing a value the
\r
4911 * compiler can't assume is const. */
\r
4912 configASSERT( xTickCount == ( TickType_t ) 0 );
\r
4917 traceTASK_NOTIFY( uxIndexToNotify );
\r
4919 /* If the task is in the blocked state specifically to wait for a
\r
4920 * notification then unblock it now. */
\r
4921 if( ucOriginalNotifyState == taskWAITING_NOTIFICATION )
\r
4923 listREMOVE_ITEM( &( pxTCB->xStateListItem ) );
\r
4924 prvAddTaskToReadyList( pxTCB );
\r
4926 /* The task should not have been on an event list. */
\r
4927 configASSERT( listLIST_ITEM_CONTAINER( &( pxTCB->xEventListItem ) ) == NULL );
\r
4929 #if ( configUSE_TICKLESS_IDLE != 0 )
\r
4931 /* If a task is blocked waiting for a notification then
\r
4932 * xNextTaskUnblockTime might be set to the blocked task's time
\r
4933 * out time. If the task is unblocked for a reason other than
\r
4934 * a timeout xNextTaskUnblockTime is normally left unchanged,
\r
4935 * because it will automatically get reset to a new value when
\r
4936 * the tick count equals xNextTaskUnblockTime. However if
\r
4937 * tickless idling is used it might be more important to enter
\r
4938 * sleep mode at the earliest possible time - so reset
\r
4939 * xNextTaskUnblockTime here to ensure it is updated at the
\r
4940 * earliest possible time. */
\r
4941 prvResetNextTaskUnblockTime();
\r
4945 if( pxTCB->uxPriority > pxCurrentTCB->uxPriority )
\r
4947 /* The notified task has a priority above the currently
\r
4948 * executing task so a yield is required. */
\r
4949 taskYIELD_IF_USING_PREEMPTION();
\r
4953 mtCOVERAGE_TEST_MARKER();
\r
4958 mtCOVERAGE_TEST_MARKER();
\r
4961 taskEXIT_CRITICAL();
\r
4966 #endif /* configUSE_TASK_NOTIFICATIONS */
\r
4967 /*-----------------------------------------------------------*/
\r
4969 #if ( configUSE_TASK_NOTIFICATIONS == 1 )
\r
4971 BaseType_t xTaskGenericNotifyFromISR( TaskHandle_t xTaskToNotify,
\r
4972 UBaseType_t uxIndexToNotify,
\r
4974 eNotifyAction eAction,
\r
4975 uint32_t * pulPreviousNotificationValue,
\r
4976 BaseType_t * pxHigherPriorityTaskWoken )
\r
4979 uint8_t ucOriginalNotifyState;
\r
4980 BaseType_t xReturn = pdPASS;
\r
4981 UBaseType_t uxSavedInterruptStatus;
\r
4983 configASSERT( xTaskToNotify );
\r
4984 configASSERT( uxIndexToNotify < configTASK_NOTIFICATION_ARRAY_ENTRIES );
\r
4986 /* RTOS ports that support interrupt nesting have the concept of a
\r
4987 * maximum system call (or maximum API call) interrupt priority.
\r
4988 * Interrupts that are above the maximum system call priority are keep
\r
4989 * permanently enabled, even when the RTOS kernel is in a critical section,
\r
4990 * but cannot make any calls to FreeRTOS API functions. If configASSERT()
\r
4991 * is defined in FreeRTOSConfig.h then
\r
4992 * portASSERT_IF_INTERRUPT_PRIORITY_INVALID() will result in an assertion
\r
4993 * failure if a FreeRTOS API function is called from an interrupt that has
\r
4994 * been assigned a priority above the configured maximum system call
\r
4995 * priority. Only FreeRTOS functions that end in FromISR can be called
\r
4996 * from interrupts that have been assigned a priority at or (logically)
\r
4997 * below the maximum system call interrupt priority. FreeRTOS maintains a
\r
4998 * separate interrupt safe API to ensure interrupt entry is as fast and as
\r
4999 * simple as possible. More information (albeit Cortex-M specific) is
\r
5000 * provided on the following link:
\r
5001 * https://www.FreeRTOS.org/RTOS-Cortex-M3-M4.html */
\r
5002 portASSERT_IF_INTERRUPT_PRIORITY_INVALID();
\r
5004 pxTCB = xTaskToNotify;
\r
5006 uxSavedInterruptStatus = portSET_INTERRUPT_MASK_FROM_ISR();
\r
5008 if( pulPreviousNotificationValue != NULL )
\r
5010 *pulPreviousNotificationValue = pxTCB->ulNotifiedValue[ uxIndexToNotify ];
\r
5013 ucOriginalNotifyState = pxTCB->ucNotifyState[ uxIndexToNotify ];
\r
5014 pxTCB->ucNotifyState[ uxIndexToNotify ] = taskNOTIFICATION_RECEIVED;
\r
5019 pxTCB->ulNotifiedValue[ uxIndexToNotify ] |= ulValue;
\r
5023 ( pxTCB->ulNotifiedValue[ uxIndexToNotify ] )++;
\r
5026 case eSetValueWithOverwrite:
\r
5027 pxTCB->ulNotifiedValue[ uxIndexToNotify ] = ulValue;
\r
5030 case eSetValueWithoutOverwrite:
\r
5032 if( ucOriginalNotifyState != taskNOTIFICATION_RECEIVED )
\r
5034 pxTCB->ulNotifiedValue[ uxIndexToNotify ] = ulValue;
\r
5038 /* The value could not be written to the task. */
\r
5046 /* The task is being notified without its notify value being
\r
5052 /* Should not get here if all enums are handled.
\r
5053 * Artificially force an assert by testing a value the
\r
5054 * compiler can't assume is const. */
\r
5055 configASSERT( xTickCount == ( TickType_t ) 0 );
\r
5059 traceTASK_NOTIFY_FROM_ISR( uxIndexToNotify );
\r
5061 /* If the task is in the blocked state specifically to wait for a
\r
5062 * notification then unblock it now. */
\r
5063 if( ucOriginalNotifyState == taskWAITING_NOTIFICATION )
\r
5065 /* The task should not have been on an event list. */
\r
5066 configASSERT( listLIST_ITEM_CONTAINER( &( pxTCB->xEventListItem ) ) == NULL );
\r
5068 if( uxSchedulerSuspended == ( UBaseType_t ) pdFALSE )
\r
5070 listREMOVE_ITEM( &( pxTCB->xStateListItem ) );
\r
5071 prvAddTaskToReadyList( pxTCB );
\r
5075 /* The delayed and ready lists cannot be accessed, so hold
\r
5076 * this task pending until the scheduler is resumed. */
\r
5077 listINSERT_END( &( xPendingReadyList ), &( pxTCB->xEventListItem ) );
\r
5080 if( pxTCB->uxPriority > pxCurrentTCB->uxPriority )
\r
5082 /* The notified task has a priority above the currently
\r
5083 * executing task so a yield is required. */
\r
5084 if( pxHigherPriorityTaskWoken != NULL )
\r
5086 *pxHigherPriorityTaskWoken = pdTRUE;
\r
5089 /* Mark that a yield is pending in case the user is not
\r
5090 * using the "xHigherPriorityTaskWoken" parameter to an ISR
\r
5091 * safe FreeRTOS function. */
\r
5092 xYieldPending = pdTRUE;
\r
5096 mtCOVERAGE_TEST_MARKER();
\r
5100 portCLEAR_INTERRUPT_MASK_FROM_ISR( uxSavedInterruptStatus );
\r
5105 #endif /* configUSE_TASK_NOTIFICATIONS */
\r
5106 /*-----------------------------------------------------------*/
\r
5108 #if ( configUSE_TASK_NOTIFICATIONS == 1 )
\r
5110 void vTaskGenericNotifyGiveFromISR( TaskHandle_t xTaskToNotify,
\r
5111 UBaseType_t uxIndexToNotify,
\r
5112 BaseType_t * pxHigherPriorityTaskWoken )
\r
5115 uint8_t ucOriginalNotifyState;
\r
5116 UBaseType_t uxSavedInterruptStatus;
\r
5118 configASSERT( xTaskToNotify );
\r
5119 configASSERT( uxIndexToNotify < configTASK_NOTIFICATION_ARRAY_ENTRIES );
\r
5121 /* RTOS ports that support interrupt nesting have the concept of a
\r
5122 * maximum system call (or maximum API call) interrupt priority.
\r
5123 * Interrupts that are above the maximum system call priority are keep
\r
5124 * permanently enabled, even when the RTOS kernel is in a critical section,
\r
5125 * but cannot make any calls to FreeRTOS API functions. If configASSERT()
\r
5126 * is defined in FreeRTOSConfig.h then
\r
5127 * portASSERT_IF_INTERRUPT_PRIORITY_INVALID() will result in an assertion
\r
5128 * failure if a FreeRTOS API function is called from an interrupt that has
\r
5129 * been assigned a priority above the configured maximum system call
\r
5130 * priority. Only FreeRTOS functions that end in FromISR can be called
\r
5131 * from interrupts that have been assigned a priority at or (logically)
\r
5132 * below the maximum system call interrupt priority. FreeRTOS maintains a
\r
5133 * separate interrupt safe API to ensure interrupt entry is as fast and as
\r
5134 * simple as possible. More information (albeit Cortex-M specific) is
\r
5135 * provided on the following link:
\r
5136 * https://www.FreeRTOS.org/RTOS-Cortex-M3-M4.html */
\r
5137 portASSERT_IF_INTERRUPT_PRIORITY_INVALID();
\r
5139 pxTCB = xTaskToNotify;
\r
5141 uxSavedInterruptStatus = portSET_INTERRUPT_MASK_FROM_ISR();
\r
5143 ucOriginalNotifyState = pxTCB->ucNotifyState[ uxIndexToNotify ];
\r
5144 pxTCB->ucNotifyState[ uxIndexToNotify ] = taskNOTIFICATION_RECEIVED;
\r
5146 /* 'Giving' is equivalent to incrementing a count in a counting
\r
5148 ( pxTCB->ulNotifiedValue[ uxIndexToNotify ] )++;
\r
5150 traceTASK_NOTIFY_GIVE_FROM_ISR( uxIndexToNotify );
\r
5152 /* If the task is in the blocked state specifically to wait for a
\r
5153 * notification then unblock it now. */
\r
5154 if( ucOriginalNotifyState == taskWAITING_NOTIFICATION )
\r
5156 /* The task should not have been on an event list. */
\r
5157 configASSERT( listLIST_ITEM_CONTAINER( &( pxTCB->xEventListItem ) ) == NULL );
\r
5159 if( uxSchedulerSuspended == ( UBaseType_t ) pdFALSE )
\r
5161 listREMOVE_ITEM( &( pxTCB->xStateListItem ) );
\r
5162 prvAddTaskToReadyList( pxTCB );
\r
5166 /* The delayed and ready lists cannot be accessed, so hold
\r
5167 * this task pending until the scheduler is resumed. */
\r
5168 listINSERT_END( &( xPendingReadyList ), &( pxTCB->xEventListItem ) );
\r
5171 if( pxTCB->uxPriority > pxCurrentTCB->uxPriority )
\r
5173 /* The notified task has a priority above the currently
\r
5174 * executing task so a yield is required. */
\r
5175 if( pxHigherPriorityTaskWoken != NULL )
\r
5177 *pxHigherPriorityTaskWoken = pdTRUE;
\r
5180 /* Mark that a yield is pending in case the user is not
\r
5181 * using the "xHigherPriorityTaskWoken" parameter in an ISR
\r
5182 * safe FreeRTOS function. */
\r
5183 xYieldPending = pdTRUE;
\r
5187 mtCOVERAGE_TEST_MARKER();
\r
5191 portCLEAR_INTERRUPT_MASK_FROM_ISR( uxSavedInterruptStatus );
\r
5194 #endif /* configUSE_TASK_NOTIFICATIONS */
\r
5195 /*-----------------------------------------------------------*/
\r
5197 #if ( configUSE_TASK_NOTIFICATIONS == 1 )
\r
5199 BaseType_t xTaskGenericNotifyStateClear( TaskHandle_t xTask,
\r
5200 UBaseType_t uxIndexToClear )
\r
5203 BaseType_t xReturn;
\r
5205 configASSERT( uxIndexToClear < configTASK_NOTIFICATION_ARRAY_ENTRIES );
\r
5207 /* If null is passed in here then it is the calling task that is having
\r
5208 * its notification state cleared. */
\r
5209 pxTCB = prvGetTCBFromHandle( xTask );
\r
5211 taskENTER_CRITICAL();
\r
5213 if( pxTCB->ucNotifyState[ uxIndexToClear ] == taskNOTIFICATION_RECEIVED )
\r
5215 pxTCB->ucNotifyState[ uxIndexToClear ] = taskNOT_WAITING_NOTIFICATION;
\r
5223 taskEXIT_CRITICAL();
\r
5228 #endif /* configUSE_TASK_NOTIFICATIONS */
\r
5229 /*-----------------------------------------------------------*/
\r
5231 #if ( configUSE_TASK_NOTIFICATIONS == 1 )
\r
5233 uint32_t ulTaskGenericNotifyValueClear( TaskHandle_t xTask,
\r
5234 UBaseType_t uxIndexToClear,
\r
5235 uint32_t ulBitsToClear )
\r
5238 uint32_t ulReturn;
\r
5240 /* If null is passed in here then it is the calling task that is having
\r
5241 * its notification state cleared. */
\r
5242 pxTCB = prvGetTCBFromHandle( xTask );
\r
5244 taskENTER_CRITICAL();
\r
5246 /* Return the notification as it was before the bits were cleared,
\r
5247 * then clear the bit mask. */
\r
5248 ulReturn = pxTCB->ulNotifiedValue[ uxIndexToClear ];
\r
5249 pxTCB->ulNotifiedValue[ uxIndexToClear ] &= ~ulBitsToClear;
\r
5251 taskEXIT_CRITICAL();
\r
5256 #endif /* configUSE_TASK_NOTIFICATIONS */
\r
5257 /*-----------------------------------------------------------*/
\r
5259 #if ( ( configGENERATE_RUN_TIME_STATS == 1 ) && ( INCLUDE_xTaskGetIdleTaskHandle == 1 ) )
\r
5261 configRUN_TIME_COUNTER_TYPE ulTaskGetIdleRunTimeCounter( void )
\r
5263 return xIdleTaskHandle->ulRunTimeCounter;
\r
5267 /*-----------------------------------------------------------*/
\r
5269 #if ( ( configGENERATE_RUN_TIME_STATS == 1 ) && ( INCLUDE_xTaskGetIdleTaskHandle == 1 ) )
\r
5271 configRUN_TIME_COUNTER_TYPE ulTaskGetIdleRunTimePercent( void )
\r
5273 configRUN_TIME_COUNTER_TYPE ulTotalTime, ulReturn;
\r
5275 ulTotalTime = portGET_RUN_TIME_COUNTER_VALUE();
\r
5277 /* For percentage calculations. */
\r
5278 ulTotalTime /= ( configRUN_TIME_COUNTER_TYPE ) 100;
\r
5280 /* Avoid divide by zero errors. */
\r
5281 if( ulTotalTime > ( configRUN_TIME_COUNTER_TYPE ) 0 )
\r
5283 ulReturn = xIdleTaskHandle->ulRunTimeCounter / ulTotalTime;
\r
5293 #endif /* if ( ( configGENERATE_RUN_TIME_STATS == 1 ) && ( INCLUDE_xTaskGetIdleTaskHandle == 1 ) ) */
\r
5294 /*-----------------------------------------------------------*/
\r
5296 static void prvAddCurrentTaskToDelayedList( TickType_t xTicksToWait,
\r
5297 const BaseType_t xCanBlockIndefinitely )
\r
5299 TickType_t xTimeToWake;
\r
5300 const TickType_t xConstTickCount = xTickCount;
\r
5302 #if ( INCLUDE_xTaskAbortDelay == 1 )
\r
5304 /* About to enter a delayed list, so ensure the ucDelayAborted flag is
\r
5305 * reset to pdFALSE so it can be detected as having been set to pdTRUE
\r
5306 * when the task leaves the Blocked state. */
\r
5307 pxCurrentTCB->ucDelayAborted = pdFALSE;
\r
5311 /* Remove the task from the ready list before adding it to the blocked list
\r
5312 * as the same list item is used for both lists. */
\r
5313 if( uxListRemove( &( pxCurrentTCB->xStateListItem ) ) == ( UBaseType_t ) 0 )
\r
5315 /* The current task must be in a ready list, so there is no need to
\r
5316 * check, and the port reset macro can be called directly. */
\r
5317 portRESET_READY_PRIORITY( pxCurrentTCB->uxPriority, uxTopReadyPriority ); /*lint !e931 pxCurrentTCB cannot change as it is the calling task. pxCurrentTCB->uxPriority and uxTopReadyPriority cannot change as called with scheduler suspended or in a critical section. */
\r
5321 mtCOVERAGE_TEST_MARKER();
\r
5324 #if ( INCLUDE_vTaskSuspend == 1 )
\r
5326 if( ( xTicksToWait == portMAX_DELAY ) && ( xCanBlockIndefinitely != pdFALSE ) )
\r
5328 /* Add the task to the suspended task list instead of a delayed task
\r
5329 * list to ensure it is not woken by a timing event. It will block
\r
5330 * indefinitely. */
\r
5331 listINSERT_END( &xSuspendedTaskList, &( pxCurrentTCB->xStateListItem ) );
\r
5335 /* Calculate the time at which the task should be woken if the event
\r
5336 * does not occur. This may overflow but this doesn't matter, the
\r
5337 * kernel will manage it correctly. */
\r
5338 xTimeToWake = xConstTickCount + xTicksToWait;
\r
5340 /* The list item will be inserted in wake time order. */
\r
5341 listSET_LIST_ITEM_VALUE( &( pxCurrentTCB->xStateListItem ), xTimeToWake );
\r
5343 if( xTimeToWake < xConstTickCount )
\r
5345 /* Wake time has overflowed. Place this item in the overflow
\r
5347 vListInsert( pxOverflowDelayedTaskList, &( pxCurrentTCB->xStateListItem ) );
\r
5351 /* The wake time has not overflowed, so the current block list
\r
5353 vListInsert( pxDelayedTaskList, &( pxCurrentTCB->xStateListItem ) );
\r
5355 /* If the task entering the blocked state was placed at the
\r
5356 * head of the list of blocked tasks then xNextTaskUnblockTime
\r
5357 * needs to be updated too. */
\r
5358 if( xTimeToWake < xNextTaskUnblockTime )
\r
5360 xNextTaskUnblockTime = xTimeToWake;
\r
5364 mtCOVERAGE_TEST_MARKER();
\r
5369 #else /* INCLUDE_vTaskSuspend */
\r
5371 /* Calculate the time at which the task should be woken if the event
\r
5372 * does not occur. This may overflow but this doesn't matter, the kernel
\r
5373 * will manage it correctly. */
\r
5374 xTimeToWake = xConstTickCount + xTicksToWait;
\r
5376 /* The list item will be inserted in wake time order. */
\r
5377 listSET_LIST_ITEM_VALUE( &( pxCurrentTCB->xStateListItem ), xTimeToWake );
\r
5379 if( xTimeToWake < xConstTickCount )
\r
5381 /* Wake time has overflowed. Place this item in the overflow list. */
\r
5382 vListInsert( pxOverflowDelayedTaskList, &( pxCurrentTCB->xStateListItem ) );
\r
5386 /* The wake time has not overflowed, so the current block list is used. */
\r
5387 vListInsert( pxDelayedTaskList, &( pxCurrentTCB->xStateListItem ) );
\r
5389 /* If the task entering the blocked state was placed at the head of the
\r
5390 * list of blocked tasks then xNextTaskUnblockTime needs to be updated
\r
5392 if( xTimeToWake < xNextTaskUnblockTime )
\r
5394 xNextTaskUnblockTime = xTimeToWake;
\r
5398 mtCOVERAGE_TEST_MARKER();
\r
5402 /* Avoid compiler warning when INCLUDE_vTaskSuspend is not 1. */
\r
5403 ( void ) xCanBlockIndefinitely;
\r
5405 #endif /* INCLUDE_vTaskSuspend */
\r
5408 /* Code below here allows additional code to be inserted into this source file,
\r
5409 * especially where access to file scope functions and data is needed (for example
\r
5410 * when performing module tests). */
\r
5412 #ifdef FREERTOS_MODULE_TEST
\r
5413 #include "tasks_test_access_functions.h"
\r
5417 #if ( configINCLUDE_FREERTOS_TASK_C_ADDITIONS_H == 1 )
\r
5419 #include "freertos_tasks_c_additions.h"
\r
5421 #ifdef FREERTOS_TASKS_C_ADDITIONS_INIT
\r
5422 static void freertos_tasks_c_additions_init( void )
\r
5424 FREERTOS_TASKS_C_ADDITIONS_INIT();
\r
5428 #endif /* if ( configINCLUDE_FREERTOS_TASK_C_ADDITIONS_H == 1 ) */
\r
begriffs.com / projects / freertos / blob