2 FreeRTOS V9.0.0 - Copyright (C) 2016 Real Time Engineers Ltd.
\r
5 VISIT http://www.FreeRTOS.org TO ENSURE YOU ARE USING THE LATEST VERSION.
\r
7 This file is part of the FreeRTOS distribution.
\r
9 FreeRTOS is free software; you can redistribute it and/or modify it under
\r
10 the terms of the GNU General Public License (version 2) as published by the
\r
11 Free Software Foundation >>>> AND MODIFIED BY <<<< the FreeRTOS exception.
\r
13 ***************************************************************************
\r
14 >>! NOTE: The modification to the GPL is included to allow you to !<<
\r
15 >>! distribute a combined work that includes FreeRTOS without being !<<
\r
16 >>! obliged to provide the source code for proprietary components !<<
\r
17 >>! outside of the FreeRTOS kernel. !<<
\r
18 ***************************************************************************
\r
20 FreeRTOS is distributed in the hope that it will be useful, but WITHOUT ANY
\r
21 WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
\r
22 FOR A PARTICULAR PURPOSE. Full license text is available on the following
\r
23 link: http://www.freertos.org/a00114.html
\r
25 ***************************************************************************
\r
27 * FreeRTOS provides completely free yet professionally developed, *
\r
28 * robust, strictly quality controlled, supported, and cross *
\r
29 * platform software that is more than just the market leader, it *
\r
30 * is the industry's de facto standard. *
\r
32 * Help yourself get started quickly while simultaneously helping *
\r
33 * to support the FreeRTOS project by purchasing a FreeRTOS *
\r
34 * tutorial book, reference manual, or both: *
\r
35 * http://www.FreeRTOS.org/Documentation *
\r
37 ***************************************************************************
\r
39 http://www.FreeRTOS.org/FAQHelp.html - Having a problem? Start by reading
\r
40 the FAQ page "My application does not run, what could be wrong?". Have you
\r
41 defined configASSERT()?
\r
43 http://www.FreeRTOS.org/support - In return for receiving this top quality
\r
44 embedded software for free we request you assist our global community by
\r
45 participating in the support forum.
\r
47 http://www.FreeRTOS.org/training - Investing in training allows your team to
\r
48 be as productive as possible as early as possible. Now you can receive
\r
49 FreeRTOS training directly from Richard Barry, CEO of Real Time Engineers
\r
50 Ltd, and the world's leading authority on the world's leading RTOS.
\r
52 http://www.FreeRTOS.org/plus - A selection of FreeRTOS ecosystem products,
\r
53 including FreeRTOS+Trace - an indispensable productivity tool, a DOS
\r
54 compatible FAT file system, and our tiny thread aware UDP/IP stack.
\r
56 http://www.FreeRTOS.org/labs - Where new FreeRTOS products go to incubate.
\r
57 Come and try FreeRTOS+TCP, our new open source TCP/IP stack for FreeRTOS.
\r
59 http://www.OpenRTOS.com - Real Time Engineers ltd. license FreeRTOS to High
\r
60 Integrity Systems ltd. to sell under the OpenRTOS brand. Low cost OpenRTOS
\r
61 licenses offer ticketed support, indemnification and commercial middleware.
\r
63 http://www.SafeRTOS.com - High Integrity Systems also provide a safety
\r
64 engineered and independently SIL3 certified version for use in safety and
\r
65 mission critical applications that require provable dependability.
\r
70 /* Standard includes. */
\r
74 /* Defining MPU_WRAPPERS_INCLUDED_FROM_API_FILE prevents task.h from redefining
\r
75 all the API functions to use the MPU wrappers. That should only be done when
\r
76 task.h is included from an application file. */
\r
77 #define MPU_WRAPPERS_INCLUDED_FROM_API_FILE
\r
79 /* FreeRTOS includes. */
\r
80 #include "FreeRTOS.h"
\r
83 #include "StackMacros.h"
\r
85 /* Lint e961 and e750 are suppressed as a MISRA exception justified because the
\r
86 MPU ports require MPU_WRAPPERS_INCLUDED_FROM_API_FILE to be defined for the
\r
87 header files above, but not in this file, in order to generate the correct
\r
88 privileged Vs unprivileged linkage and placement. */
\r
89 #undef MPU_WRAPPERS_INCLUDED_FROM_API_FILE /*lint !e961 !e750. */
\r
91 /* Set configUSE_STATS_FORMATTING_FUNCTIONS to 2 to include the stats formatting
\r
92 functions but without including stdio.h here. */
\r
93 #if ( configUSE_STATS_FORMATTING_FUNCTIONS == 1 )
\r
94 /* At the bottom of this file are two optional functions that can be used
\r
95 to generate human readable text from the raw data generated by the
\r
96 uxTaskGetSystemState() function. Note the formatting functions are provided
\r
97 for convenience only, and are NOT considered part of the kernel. */
\r
99 #endif /* configUSE_STATS_FORMATTING_FUNCTIONS == 1 ) */
\r
101 #if( configUSE_PREEMPTION == 0 )
\r
102 /* If the cooperative scheduler is being used then a yield should not be
\r
103 performed just because a higher priority task has been woken. */
\r
104 #define taskYIELD_IF_USING_PREEMPTION()
\r
106 #define taskYIELD_IF_USING_PREEMPTION() portYIELD_WITHIN_API()
\r
109 /* Values that can be assigned to the ucNotifyState member of the TCB. */
\r
110 #define taskNOT_WAITING_NOTIFICATION ( ( uint8_t ) 0 )
\r
111 #define taskWAITING_NOTIFICATION ( ( uint8_t ) 1 )
\r
112 #define taskNOTIFICATION_RECEIVED ( ( uint8_t ) 2 )
\r
115 * The value used to fill the stack of a task when the task is created. This
\r
116 * is used purely for checking the high water mark for tasks.
\r
118 #define tskSTACK_FILL_BYTE ( 0xa5U )
\r
120 /* Sometimes the FreeRTOSConfig.h settings only allow a task to be created using
\r
121 dynamically allocated RAM, in which case when any task is deleted it is known
\r
122 that both the task's stack and TCB need to be freed. Sometimes the
\r
123 FreeRTOSConfig.h settings only allow a task to be created using statically
\r
124 allocated RAM, in which case when any task is deleted it is known that neither
\r
125 the task's stack or TCB should be freed. Sometimes the FreeRTOSConfig.h
\r
126 settings allow a task to be created using either statically or dynamically
\r
127 allocated RAM, in which case a member of the TCB is used to record whether the
\r
128 stack and/or TCB were allocated statically or dynamically, so when a task is
\r
129 deleted the RAM that was allocated dynamically is freed again and no attempt is
\r
130 made to free the RAM that was allocated statically.
\r
131 tskSTATIC_AND_DYNAMIC_ALLOCATION_POSSIBLE is only true if it is possible for a
\r
132 task to be created using either statically or dynamically allocated RAM. Note
\r
133 that if portUSING_MPU_WRAPPERS is 1 then a protected task can be created with
\r
134 a statically allocated stack and a dynamically allocated TCB.
\r
135 !!!NOTE!!! If the definition of tskSTATIC_AND_DYNAMIC_ALLOCATION_POSSIBLE is
\r
136 changed then the definition of StaticTask_t must also be updated. */
\r
137 #define tskSTATIC_AND_DYNAMIC_ALLOCATION_POSSIBLE ( ( configSUPPORT_STATIC_ALLOCATION == 1 ) && ( configSUPPORT_DYNAMIC_ALLOCATION == 1 ) )
\r
138 #define tskDYNAMICALLY_ALLOCATED_STACK_AND_TCB ( ( uint8_t ) 0 )
\r
139 #define tskSTATICALLY_ALLOCATED_STACK_ONLY ( ( uint8_t ) 1 )
\r
140 #define tskSTATICALLY_ALLOCATED_STACK_AND_TCB ( ( uint8_t ) 2 )
\r
142 /* If any of the following are set then task stacks are filled with a known
\r
143 value so the high water mark can be determined. If none of the following are
\r
144 set then don't fill the stack so there is no unnecessary dependency on memset. */
\r
145 #if( ( configCHECK_FOR_STACK_OVERFLOW > 1 ) || ( configUSE_TRACE_FACILITY == 1 ) || ( INCLUDE_uxTaskGetStackHighWaterMark == 1 ) )
\r
146 #define tskSET_NEW_STACKS_TO_KNOWN_VALUE 1
\r
148 #define tskSET_NEW_STACKS_TO_KNOWN_VALUE 0
\r
152 * Macros used by vListTask to indicate which state a task is in.
\r
154 #define tskBLOCKED_CHAR ( 'B' )
\r
155 #define tskREADY_CHAR ( 'R' )
\r
156 #define tskDELETED_CHAR ( 'D' )
\r
157 #define tskSUSPENDED_CHAR ( 'S' )
\r
160 * Some kernel aware debuggers require the data the debugger needs access to be
\r
161 * global, rather than file scope.
\r
163 #ifdef portREMOVE_STATIC_QUALIFIER
\r
167 #if ( configUSE_PORT_OPTIMISED_TASK_SELECTION == 0 )
\r
169 /* If configUSE_PORT_OPTIMISED_TASK_SELECTION is 0 then task selection is
\r
170 performed in a generic way that is not optimised to any particular
\r
171 microcontroller architecture. */
\r
173 /* uxTopReadyPriority holds the priority of the highest priority ready
\r
175 #define taskRECORD_READY_PRIORITY( uxPriority ) \
\r
177 if( ( uxPriority ) > uxTopReadyPriority ) \
\r
179 uxTopReadyPriority = ( uxPriority ); \
\r
181 } /* taskRECORD_READY_PRIORITY */
\r
183 /*-----------------------------------------------------------*/
\r
185 #define taskSELECT_HIGHEST_PRIORITY_TASK() \
\r
187 UBaseType_t uxTopPriority = uxTopReadyPriority; \
\r
189 /* Find the highest priority queue that contains ready tasks. */ \
\r
190 while( listLIST_IS_EMPTY( &( pxReadyTasksLists[ uxTopPriority ] ) ) ) \
\r
192 configASSERT( uxTopPriority ); \
\r
196 /* listGET_OWNER_OF_NEXT_ENTRY indexes through the list, so the tasks of \
\r
197 the same priority get an equal share of the processor time. */ \
\r
198 listGET_OWNER_OF_NEXT_ENTRY( pxCurrentTCB, &( pxReadyTasksLists[ uxTopPriority ] ) ); \
\r
199 uxTopReadyPriority = uxTopPriority; \
\r
200 } /* taskSELECT_HIGHEST_PRIORITY_TASK */
\r
202 /*-----------------------------------------------------------*/
\r
204 /* Define away taskRESET_READY_PRIORITY() and portRESET_READY_PRIORITY() as
\r
205 they are only required when a port optimised method of task selection is
\r
207 #define taskRESET_READY_PRIORITY( uxPriority )
\r
208 #define portRESET_READY_PRIORITY( uxPriority, uxTopReadyPriority )
\r
210 #else /* configUSE_PORT_OPTIMISED_TASK_SELECTION */
\r
212 /* If configUSE_PORT_OPTIMISED_TASK_SELECTION is 1 then task selection is
\r
213 performed in a way that is tailored to the particular microcontroller
\r
214 architecture being used. */
\r
216 /* A port optimised version is provided. Call the port defined macros. */
\r
217 #define taskRECORD_READY_PRIORITY( uxPriority ) portRECORD_READY_PRIORITY( uxPriority, uxTopReadyPriority )
\r
219 /*-----------------------------------------------------------*/
\r
221 #define taskSELECT_HIGHEST_PRIORITY_TASK() \
\r
223 UBaseType_t uxTopPriority; \
\r
225 /* Find the highest priority list that contains ready tasks. */ \
\r
226 portGET_HIGHEST_PRIORITY( uxTopPriority, uxTopReadyPriority ); \
\r
227 configASSERT( listCURRENT_LIST_LENGTH( &( pxReadyTasksLists[ uxTopPriority ] ) ) > 0 ); \
\r
228 listGET_OWNER_OF_NEXT_ENTRY( pxCurrentTCB, &( pxReadyTasksLists[ uxTopPriority ] ) ); \
\r
229 } /* taskSELECT_HIGHEST_PRIORITY_TASK() */
\r
231 /*-----------------------------------------------------------*/
\r
233 /* A port optimised version is provided, call it only if the TCB being reset
\r
234 is being referenced from a ready list. If it is referenced from a delayed
\r
235 or suspended list then it won't be in a ready list. */
\r
236 #define taskRESET_READY_PRIORITY( uxPriority ) \
\r
238 if( listCURRENT_LIST_LENGTH( &( pxReadyTasksLists[ ( uxPriority ) ] ) ) == ( UBaseType_t ) 0 ) \
\r
240 portRESET_READY_PRIORITY( ( uxPriority ), ( uxTopReadyPriority ) ); \
\r
244 #endif /* configUSE_PORT_OPTIMISED_TASK_SELECTION */
\r
246 /*-----------------------------------------------------------*/
\r
248 /* pxDelayedTaskList and pxOverflowDelayedTaskList are switched when the tick
\r
249 count overflows. */
\r
250 #define taskSWITCH_DELAYED_LISTS() \
\r
254 /* The delayed tasks list should be empty when the lists are switched. */ \
\r
255 configASSERT( ( listLIST_IS_EMPTY( pxDelayedTaskList ) ) ); \
\r
257 pxTemp = pxDelayedTaskList; \
\r
258 pxDelayedTaskList = pxOverflowDelayedTaskList; \
\r
259 pxOverflowDelayedTaskList = pxTemp; \
\r
260 xNumOfOverflows++; \
\r
261 prvResetNextTaskUnblockTime(); \
\r
264 /*-----------------------------------------------------------*/
\r
267 * Place the task represented by pxTCB into the appropriate ready list for
\r
268 * the task. It is inserted at the end of the list.
\r
270 #define prvAddTaskToReadyList( pxTCB ) \
\r
271 traceMOVED_TASK_TO_READY_STATE( pxTCB ); \
\r
272 taskRECORD_READY_PRIORITY( ( pxTCB )->uxPriority ); \
\r
273 vListInsertEnd( &( pxReadyTasksLists[ ( pxTCB )->uxPriority ] ), &( ( pxTCB )->xStateListItem ) ); \
\r
274 tracePOST_MOVED_TASK_TO_READY_STATE( pxTCB )
\r
275 /*-----------------------------------------------------------*/
\r
278 * Several functions take an TaskHandle_t parameter that can optionally be NULL,
\r
279 * where NULL is used to indicate that the handle of the currently executing
\r
280 * task should be used in place of the parameter. This macro simply checks to
\r
281 * see if the parameter is NULL and returns a pointer to the appropriate TCB.
\r
283 #define prvGetTCBFromHandle( pxHandle ) ( ( ( pxHandle ) == NULL ) ? ( TCB_t * ) pxCurrentTCB : ( TCB_t * ) ( pxHandle ) )
\r
285 /* The item value of the event list item is normally used to hold the priority
\r
286 of the task to which it belongs (coded to allow it to be held in reverse
\r
287 priority order). However, it is occasionally borrowed for other purposes. It
\r
288 is important its value is not updated due to a task priority change while it is
\r
289 being used for another purpose. The following bit definition is used to inform
\r
290 the scheduler that the value should not be changed - in which case it is the
\r
291 responsibility of whichever module is using the value to ensure it gets set back
\r
292 to its original value when it is released. */
\r
293 #if( configUSE_16_BIT_TICKS == 1 )
\r
294 #define taskEVENT_LIST_ITEM_VALUE_IN_USE 0x8000U
\r
296 #define taskEVENT_LIST_ITEM_VALUE_IN_USE 0x80000000UL
\r
300 * Task control block. A task control block (TCB) is allocated for each task,
\r
301 * and stores task state information, including a pointer to the task's context
\r
302 * (the task's run time environment, including register values)
\r
304 typedef struct tskTaskControlBlock
\r
306 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
308 #if ( portUSING_MPU_WRAPPERS == 1 )
\r
309 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
312 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
313 ListItem_t xEventListItem; /*< Used to reference a task from an event list. */
\r
314 UBaseType_t uxPriority; /*< The priority of the task. 0 is the lowest priority. */
\r
315 StackType_t *pxStack; /*< Points to the start of the stack. */
\r
316 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
318 #if ( ( portSTACK_GROWTH > 0 ) || ( configRECORD_STACK_HIGH_ADDRESS == 1 ) )
\r
319 StackType_t *pxEndOfStack; /*< Points to the highest valid address for the stack. */
\r
322 #if ( portCRITICAL_NESTING_IN_TCB == 1 )
\r
323 UBaseType_t uxCriticalNesting; /*< Holds the critical section nesting depth for ports that do not maintain their own count in the port layer. */
\r
326 #if ( configUSE_TRACE_FACILITY == 1 )
\r
327 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
328 UBaseType_t uxTaskNumber; /*< Stores a number specifically for use by third party trace code. */
\r
331 #if ( configUSE_MUTEXES == 1 )
\r
332 UBaseType_t uxBasePriority; /*< The priority last assigned to the task - used by the priority inheritance mechanism. */
\r
333 UBaseType_t uxMutexesHeld;
\r
336 #if ( configUSE_APPLICATION_TASK_TAG == 1 )
\r
337 TaskHookFunction_t pxTaskTag;
\r
340 #if( configNUM_THREAD_LOCAL_STORAGE_POINTERS > 0 )
\r
341 void *pvThreadLocalStoragePointers[ configNUM_THREAD_LOCAL_STORAGE_POINTERS ];
\r
344 #if( configGENERATE_RUN_TIME_STATS == 1 )
\r
345 uint32_t ulRunTimeCounter; /*< Stores the amount of time the task has spent in the Running state. */
\r
348 #if ( configUSE_NEWLIB_REENTRANT == 1 )
\r
349 /* Allocate a Newlib reent structure that is specific to this task.
\r
350 Note Newlib support has been included by popular demand, but is not
\r
351 used by the FreeRTOS maintainers themselves. FreeRTOS is not
\r
352 responsible for resulting newlib operation. User must be familiar with
\r
353 newlib and must provide system-wide implementations of the necessary
\r
354 stubs. Be warned that (at the time of writing) the current newlib design
\r
355 implements a system-wide malloc() that must be provided with locks. */
\r
356 struct _reent xNewLib_reent;
\r
359 #if( configUSE_TASK_NOTIFICATIONS == 1 )
\r
360 volatile uint32_t ulNotifiedValue;
\r
361 volatile uint8_t ucNotifyState;
\r
364 /* See the comments above the definition of
\r
365 tskSTATIC_AND_DYNAMIC_ALLOCATION_POSSIBLE. */
\r
366 #if( tskSTATIC_AND_DYNAMIC_ALLOCATION_POSSIBLE != 0 ) /*lint !e731 Macro has been consolidated for readability reasons. */
\r
367 uint8_t ucStaticallyAllocated; /*< Set to pdTRUE if the task is a statically allocated to ensure no attempt is made to free the memory. */
\r
370 #if( INCLUDE_xTaskAbortDelay == 1 )
\r
371 uint8_t ucDelayAborted;
\r
376 /* The old tskTCB name is maintained above then typedefed to the new TCB_t name
\r
377 below to enable the use of older kernel aware debuggers. */
\r
378 typedef tskTCB TCB_t;
\r
380 /*lint -save -e956 A manual analysis and inspection has been used to determine
\r
381 which static variables must be declared volatile. */
\r
383 PRIVILEGED_DATA TCB_t * volatile pxCurrentTCB = NULL;
\r
385 /* Lists for ready and blocked tasks. --------------------*/
\r
386 PRIVILEGED_DATA static List_t pxReadyTasksLists[ configMAX_PRIORITIES ];/*< Prioritised ready tasks. */
\r
387 PRIVILEGED_DATA static List_t xDelayedTaskList1; /*< Delayed tasks. */
\r
388 PRIVILEGED_DATA static List_t xDelayedTaskList2; /*< Delayed tasks (two lists are used - one for delays that have overflowed the current tick count. */
\r
389 PRIVILEGED_DATA static List_t * volatile pxDelayedTaskList; /*< Points to the delayed task list currently being used. */
\r
390 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
391 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
393 #if( INCLUDE_vTaskDelete == 1 )
\r
395 PRIVILEGED_DATA static List_t xTasksWaitingTermination; /*< Tasks that have been deleted - but their memory not yet freed. */
\r
396 PRIVILEGED_DATA static volatile UBaseType_t uxDeletedTasksWaitingCleanUp = ( UBaseType_t ) 0U;
\r
400 #if ( INCLUDE_vTaskSuspend == 1 )
\r
402 PRIVILEGED_DATA static List_t xSuspendedTaskList; /*< Tasks that are currently suspended. */
\r
406 /* Other file private variables. --------------------------------*/
\r
407 PRIVILEGED_DATA static volatile UBaseType_t uxCurrentNumberOfTasks = ( UBaseType_t ) 0U;
\r
408 PRIVILEGED_DATA static volatile TickType_t xTickCount = ( TickType_t ) 0U;
\r
409 PRIVILEGED_DATA static volatile UBaseType_t uxTopReadyPriority = tskIDLE_PRIORITY;
\r
410 PRIVILEGED_DATA static volatile BaseType_t xSchedulerRunning = pdFALSE;
\r
411 PRIVILEGED_DATA static volatile UBaseType_t uxPendedTicks = ( UBaseType_t ) 0U;
\r
412 PRIVILEGED_DATA static volatile BaseType_t xYieldPending = pdFALSE;
\r
413 PRIVILEGED_DATA static volatile BaseType_t xNumOfOverflows = ( BaseType_t ) 0;
\r
414 PRIVILEGED_DATA static UBaseType_t uxTaskNumber = ( UBaseType_t ) 0U;
\r
415 PRIVILEGED_DATA static volatile TickType_t xNextTaskUnblockTime = ( TickType_t ) 0U; /* Initialised to portMAX_DELAY before the scheduler starts. */
\r
416 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
418 /* Context switches are held pending while the scheduler is suspended. Also,
\r
419 interrupts must not manipulate the xStateListItem of a TCB, or any of the
\r
420 lists the xStateListItem can be referenced from, if the scheduler is suspended.
\r
421 If an interrupt needs to unblock a task while the scheduler is suspended then it
\r
422 moves the task's event list item into the xPendingReadyList, ready for the
\r
423 kernel to move the task from the pending ready list into the real ready list
\r
424 when the scheduler is unsuspended. The pending ready list itself can only be
\r
425 accessed from a critical section. */
\r
426 PRIVILEGED_DATA static volatile UBaseType_t uxSchedulerSuspended = ( UBaseType_t ) pdFALSE;
\r
428 #if ( configGENERATE_RUN_TIME_STATS == 1 )
\r
430 PRIVILEGED_DATA static uint32_t ulTaskSwitchedInTime = 0UL; /*< Holds the value of a timer/counter the last time a task was switched in. */
\r
431 PRIVILEGED_DATA static uint32_t ulTotalRunTime = 0UL; /*< Holds the total amount of execution time as defined by the run time counter clock. */
\r
437 /*-----------------------------------------------------------*/
\r
439 /* Callback function prototypes. --------------------------*/
\r
440 #if( configCHECK_FOR_STACK_OVERFLOW > 0 )
\r
442 extern void vApplicationStackOverflowHook( TaskHandle_t xTask, char *pcTaskName );
\r
446 #if( configUSE_TICK_HOOK > 0 )
\r
448 extern void vApplicationTickHook( void );
\r
452 #if( configSUPPORT_STATIC_ALLOCATION == 1 )
\r
454 extern void vApplicationGetIdleTaskMemory( StaticTask_t **ppxIdleTaskTCBBuffer, StackType_t **ppxIdleTaskStackBuffer, uint32_t *pulIdleTaskStackSize );
\r
458 /* File private functions. --------------------------------*/
\r
461 * Utility task that simply returns pdTRUE if the task referenced by xTask is
\r
462 * currently in the Suspended state, or pdFALSE if the task referenced by xTask
\r
463 * is in any other state.
\r
465 #if ( INCLUDE_vTaskSuspend == 1 )
\r
467 static BaseType_t prvTaskIsTaskSuspended( const TaskHandle_t xTask ) PRIVILEGED_FUNCTION;
\r
469 #endif /* INCLUDE_vTaskSuspend */
\r
472 * Utility to ready all the lists used by the scheduler. This is called
\r
473 * automatically upon the creation of the first task.
\r
475 static void prvInitialiseTaskLists( void ) PRIVILEGED_FUNCTION;
\r
478 * The idle task, which as all tasks is implemented as a never ending loop.
\r
479 * The idle task is automatically created and added to the ready lists upon
\r
480 * creation of the first user task.
\r
482 * The portTASK_FUNCTION_PROTO() macro is used to allow port/compiler specific
\r
483 * language extensions. The equivalent prototype for this function is:
\r
485 * void prvIdleTask( void *pvParameters );
\r
488 static portTASK_FUNCTION_PROTO( prvIdleTask, pvParameters );
\r
491 * Utility to free all memory allocated by the scheduler to hold a TCB,
\r
492 * including the stack pointed to by the TCB.
\r
494 * This does not free memory allocated by the task itself (i.e. memory
\r
495 * allocated by calls to pvPortMalloc from within the tasks application code).
\r
497 #if ( INCLUDE_vTaskDelete == 1 )
\r
499 static void prvDeleteTCB( TCB_t *pxTCB ) PRIVILEGED_FUNCTION;
\r
504 * Used only by the idle task. This checks to see if anything has been placed
\r
505 * in the list of tasks waiting to be deleted. If so the task is cleaned up
\r
506 * and its TCB deleted.
\r
508 static void prvCheckTasksWaitingTermination( void ) PRIVILEGED_FUNCTION;
\r
511 * The currently executing task is entering the Blocked state. Add the task to
\r
512 * either the current or the overflow delayed task list.
\r
514 static void prvAddCurrentTaskToDelayedList( TickType_t xTicksToWait, const BaseType_t xCanBlockIndefinitely ) PRIVILEGED_FUNCTION;
\r
517 * Fills an TaskStatus_t structure with information on each task that is
\r
518 * referenced from the pxList list (which may be a ready list, a delayed list,
\r
519 * a suspended list, etc.).
\r
521 * THIS FUNCTION IS INTENDED FOR DEBUGGING ONLY, AND SHOULD NOT BE CALLED FROM
\r
522 * NORMAL APPLICATION CODE.
\r
524 #if ( configUSE_TRACE_FACILITY == 1 )
\r
526 static UBaseType_t prvListTasksWithinSingleList( TaskStatus_t *pxTaskStatusArray, List_t *pxList, eTaskState eState ) PRIVILEGED_FUNCTION;
\r
531 * Searches pxList for a task with name pcNameToQuery - returning a handle to
\r
532 * the task if it is found, or NULL if the task is not found.
\r
534 #if ( INCLUDE_xTaskGetHandle == 1 )
\r
536 static TCB_t *prvSearchForNameWithinSingleList( List_t *pxList, const char pcNameToQuery[] ) PRIVILEGED_FUNCTION;
\r
541 * When a task is created, the stack of the task is filled with a known value.
\r
542 * This function determines the 'high water mark' of the task stack by
\r
543 * determining how much of the stack remains at the original preset value.
\r
545 #if ( ( configUSE_TRACE_FACILITY == 1 ) || ( INCLUDE_uxTaskGetStackHighWaterMark == 1 ) )
\r
547 static uint16_t prvTaskCheckFreeStackSpace( const uint8_t * pucStackByte ) PRIVILEGED_FUNCTION;
\r
552 * Return the amount of time, in ticks, that will pass before the kernel will
\r
553 * next move a task from the Blocked state to the Running state.
\r
555 * This conditional compilation should use inequality to 0, not equality to 1.
\r
556 * This is to ensure portSUPPRESS_TICKS_AND_SLEEP() can be called when user
\r
557 * defined low power mode implementations require configUSE_TICKLESS_IDLE to be
\r
558 * set to a value other than 1.
\r
560 #if ( configUSE_TICKLESS_IDLE != 0 )
\r
562 static TickType_t prvGetExpectedIdleTime( void ) PRIVILEGED_FUNCTION;
\r
567 * Set xNextTaskUnblockTime to the time at which the next Blocked state task
\r
568 * will exit the Blocked state.
\r
570 static void prvResetNextTaskUnblockTime( void );
\r
572 #if ( ( configUSE_TRACE_FACILITY == 1 ) && ( configUSE_STATS_FORMATTING_FUNCTIONS > 0 ) )
\r
575 * Helper function used to pad task names with spaces when printing out
\r
576 * human readable tables of task information.
\r
578 static char *prvWriteNameToBuffer( char *pcBuffer, const char *pcTaskName ) PRIVILEGED_FUNCTION;
\r
583 * Called after a Task_t structure has been allocated either statically or
\r
584 * dynamically to fill in the structure's members.
\r
586 static void prvInitialiseNewTask( TaskFunction_t pxTaskCode,
\r
587 const char * const pcName, /*lint !e971 Unqualified char types are allowed for strings and single characters only. */
\r
588 const uint32_t ulStackDepth,
\r
589 void * const pvParameters,
\r
590 UBaseType_t uxPriority,
\r
591 TaskHandle_t * const pxCreatedTask,
\r
593 const MemoryRegion_t * const xRegions ) PRIVILEGED_FUNCTION;
\r
596 * Called after a new task has been created and initialised to place the task
\r
597 * under the control of the scheduler.
\r
599 static void prvAddNewTaskToReadyList( TCB_t *pxNewTCB ) PRIVILEGED_FUNCTION;
\r
602 * freertos_tasks_c_additions_init() should only be called if the user definable
\r
603 * macro FREERTOS_TASKS_C_ADDITIONS_INIT() is defined, as that is the only macro
\r
604 * called by the function.
\r
606 #ifdef FREERTOS_TASKS_C_ADDITIONS_INIT
\r
608 static void freertos_tasks_c_additions_init( void ) PRIVILEGED_FUNCTION;
\r
612 /*-----------------------------------------------------------*/
\r
614 #if( configSUPPORT_STATIC_ALLOCATION == 1 )
\r
616 TaskHandle_t xTaskCreateStatic( TaskFunction_t pxTaskCode,
\r
617 const char * const pcName, /*lint !e971 Unqualified char types are allowed for strings and single characters only. */
\r
618 const uint32_t ulStackDepth,
\r
619 void * const pvParameters,
\r
620 UBaseType_t uxPriority,
\r
621 StackType_t * const puxStackBuffer,
\r
622 StaticTask_t * const pxTaskBuffer )
\r
625 TaskHandle_t xReturn;
\r
627 configASSERT( puxStackBuffer != NULL );
\r
628 configASSERT( pxTaskBuffer != NULL );
\r
630 #if( configASSERT_DEFINED == 1 )
\r
632 /* Sanity check that the size of the structure used to declare a
\r
633 variable of type StaticTask_t equals the size of the real task
\r
635 volatile size_t xSize = sizeof( StaticTask_t );
\r
636 configASSERT( xSize == sizeof( TCB_t ) );
\r
638 #endif /* configASSERT_DEFINED */
\r
641 if( ( pxTaskBuffer != NULL ) && ( puxStackBuffer != NULL ) )
\r
643 /* The memory used for the task's TCB and stack are passed into this
\r
644 function - use them. */
\r
645 pxNewTCB = ( TCB_t * ) pxTaskBuffer; /*lint !e740 Unusual cast is ok as the structures are designed to have the same alignment, and the size is checked by an assert. */
\r
646 pxNewTCB->pxStack = ( StackType_t * ) puxStackBuffer;
\r
648 #if( tskSTATIC_AND_DYNAMIC_ALLOCATION_POSSIBLE != 0 ) /*lint !e731 Macro has been consolidated for readability reasons. */
\r
650 /* Tasks can be created statically or dynamically, so note this
\r
651 task was created statically in case the task is later deleted. */
\r
652 pxNewTCB->ucStaticallyAllocated = tskSTATICALLY_ALLOCATED_STACK_AND_TCB;
\r
654 #endif /* configSUPPORT_DYNAMIC_ALLOCATION */
\r
656 prvInitialiseNewTask( pxTaskCode, pcName, ulStackDepth, pvParameters, uxPriority, &xReturn, pxNewTCB, NULL );
\r
657 prvAddNewTaskToReadyList( pxNewTCB );
\r
667 #endif /* SUPPORT_STATIC_ALLOCATION */
\r
668 /*-----------------------------------------------------------*/
\r
670 #if( ( portUSING_MPU_WRAPPERS == 1 ) && ( configSUPPORT_STATIC_ALLOCATION == 1 ) )
\r
672 BaseType_t xTaskCreateRestrictedStatic( const TaskParameters_t * const pxTaskDefinition, TaskHandle_t *pxCreatedTask )
\r
675 BaseType_t xReturn = errCOULD_NOT_ALLOCATE_REQUIRED_MEMORY;
\r
677 configASSERT( pxTaskDefinition->puxStackBuffer != NULL );
\r
678 configASSERT( pxTaskDefinition->pxTaskBuffer != NULL );
\r
680 if( ( pxTaskDefinition->puxStackBuffer != NULL ) && ( pxTaskDefinition->pxTaskBuffer != NULL ) )
\r
682 /* Allocate space for the TCB. Where the memory comes from depends
\r
683 on the implementation of the port malloc function and whether or
\r
684 not static allocation is being used. */
\r
685 pxNewTCB = ( TCB_t * ) pxTaskDefinition->pxTaskBuffer;
\r
687 /* Store the stack location in the TCB. */
\r
688 pxNewTCB->pxStack = pxTaskDefinition->puxStackBuffer;
\r
690 #if( tskSTATIC_AND_DYNAMIC_ALLOCATION_POSSIBLE != 0 )
\r
692 /* Tasks can be created statically or dynamically, so note this
\r
693 task was created statically in case the task is later deleted. */
\r
694 pxNewTCB->ucStaticallyAllocated = tskSTATICALLY_ALLOCATED_STACK_AND_TCB;
\r
696 #endif /* configSUPPORT_DYNAMIC_ALLOCATION */
\r
698 prvInitialiseNewTask( pxTaskDefinition->pvTaskCode,
\r
699 pxTaskDefinition->pcName,
\r
700 ( uint32_t ) pxTaskDefinition->usStackDepth,
\r
701 pxTaskDefinition->pvParameters,
\r
702 pxTaskDefinition->uxPriority,
\r
703 pxCreatedTask, pxNewTCB,
\r
704 pxTaskDefinition->xRegions );
\r
706 prvAddNewTaskToReadyList( pxNewTCB );
\r
713 #endif /* ( portUSING_MPU_WRAPPERS == 1 ) && ( configSUPPORT_STATIC_ALLOCATION == 1 ) */
\r
714 /*-----------------------------------------------------------*/
\r
716 #if( ( portUSING_MPU_WRAPPERS == 1 ) && ( configSUPPORT_DYNAMIC_ALLOCATION == 1 ) )
\r
718 BaseType_t xTaskCreateRestricted( const TaskParameters_t * const pxTaskDefinition, TaskHandle_t *pxCreatedTask )
\r
721 BaseType_t xReturn = errCOULD_NOT_ALLOCATE_REQUIRED_MEMORY;
\r
723 configASSERT( pxTaskDefinition->puxStackBuffer );
\r
725 if( pxTaskDefinition->puxStackBuffer != NULL )
\r
727 /* Allocate space for the TCB. Where the memory comes from depends
\r
728 on the implementation of the port malloc function and whether or
\r
729 not static allocation is being used. */
\r
730 pxNewTCB = ( TCB_t * ) pvPortMalloc( sizeof( TCB_t ) );
\r
732 if( pxNewTCB != NULL )
\r
734 /* Store the stack location in the TCB. */
\r
735 pxNewTCB->pxStack = pxTaskDefinition->puxStackBuffer;
\r
737 /* Tasks can be created statically or dynamically, so note
\r
738 this task had a statically allocated stack in case it is
\r
739 later deleted. The TCB was allocated dynamically. */
\r
740 pxNewTCB->ucStaticallyAllocated = tskSTATICALLY_ALLOCATED_STACK_ONLY;
\r
742 prvInitialiseNewTask( pxTaskDefinition->pvTaskCode,
\r
743 pxTaskDefinition->pcName,
\r
744 ( uint32_t ) pxTaskDefinition->usStackDepth,
\r
745 pxTaskDefinition->pvParameters,
\r
746 pxTaskDefinition->uxPriority,
\r
747 pxCreatedTask, pxNewTCB,
\r
748 pxTaskDefinition->xRegions );
\r
750 prvAddNewTaskToReadyList( pxNewTCB );
\r
758 #endif /* portUSING_MPU_WRAPPERS */
\r
759 /*-----------------------------------------------------------*/
\r
761 #if( configSUPPORT_DYNAMIC_ALLOCATION == 1 )
\r
763 BaseType_t xTaskCreate( TaskFunction_t pxTaskCode,
\r
764 const char * const pcName, /*lint !e971 Unqualified char types are allowed for strings and single characters only. */
\r
765 const uint16_t usStackDepth,
\r
766 void * const pvParameters,
\r
767 UBaseType_t uxPriority,
\r
768 TaskHandle_t * const pxCreatedTask )
\r
771 BaseType_t xReturn;
\r
773 /* If the stack grows down then allocate the stack then the TCB so the stack
\r
774 does not grow into the TCB. Likewise if the stack grows up then allocate
\r
775 the TCB then the stack. */
\r
776 #if( portSTACK_GROWTH > 0 )
\r
778 /* Allocate space for the TCB. Where the memory comes from depends on
\r
779 the implementation of the port malloc function and whether or not static
\r
780 allocation is being used. */
\r
781 pxNewTCB = ( TCB_t * ) pvPortMalloc( sizeof( TCB_t ) );
\r
783 if( pxNewTCB != NULL )
\r
785 /* Allocate space for the stack used by the task being created.
\r
786 The base of the stack memory stored in the TCB so the task can
\r
787 be deleted later if required. */
\r
788 pxNewTCB->pxStack = ( StackType_t * ) pvPortMalloc( ( ( ( size_t ) usStackDepth ) * sizeof( StackType_t ) ) ); /*lint !e961 MISRA exception as the casts are only redundant for some ports. */
\r
790 if( pxNewTCB->pxStack == NULL )
\r
792 /* Could not allocate the stack. Delete the allocated TCB. */
\r
793 vPortFree( pxNewTCB );
\r
798 #else /* portSTACK_GROWTH */
\r
800 StackType_t *pxStack;
\r
802 /* Allocate space for the stack used by the task being created. */
\r
803 pxStack = ( StackType_t * ) pvPortMalloc( ( ( ( size_t ) usStackDepth ) * sizeof( StackType_t ) ) ); /*lint !e961 MISRA exception as the casts are only redundant for some ports. */
\r
805 if( pxStack != NULL )
\r
807 /* Allocate space for the TCB. */
\r
808 pxNewTCB = ( TCB_t * ) pvPortMalloc( sizeof( TCB_t ) ); /*lint !e961 MISRA exception as the casts are only redundant for some paths. */
\r
810 if( pxNewTCB != NULL )
\r
812 /* Store the stack location in the TCB. */
\r
813 pxNewTCB->pxStack = pxStack;
\r
817 /* The stack cannot be used as the TCB was not created. Free
\r
819 vPortFree( pxStack );
\r
827 #endif /* portSTACK_GROWTH */
\r
829 if( pxNewTCB != NULL )
\r
831 #if( tskSTATIC_AND_DYNAMIC_ALLOCATION_POSSIBLE != 0 ) /*lint !e731 Macro has been consolidated for readability reasons. */
\r
833 /* Tasks can be created statically or dynamically, so note this
\r
834 task was created dynamically in case it is later deleted. */
\r
835 pxNewTCB->ucStaticallyAllocated = tskDYNAMICALLY_ALLOCATED_STACK_AND_TCB;
\r
837 #endif /* configSUPPORT_STATIC_ALLOCATION */
\r
839 prvInitialiseNewTask( pxTaskCode, pcName, ( uint32_t ) usStackDepth, pvParameters, uxPriority, pxCreatedTask, pxNewTCB, NULL );
\r
840 prvAddNewTaskToReadyList( pxNewTCB );
\r
845 xReturn = errCOULD_NOT_ALLOCATE_REQUIRED_MEMORY;
\r
851 #endif /* configSUPPORT_DYNAMIC_ALLOCATION */
\r
852 /*-----------------------------------------------------------*/
\r
854 static void prvInitialiseNewTask( TaskFunction_t pxTaskCode,
\r
855 const char * const pcName, /*lint !e971 Unqualified char types are allowed for strings and single characters only. */
\r
856 const uint32_t ulStackDepth,
\r
857 void * const pvParameters,
\r
858 UBaseType_t uxPriority,
\r
859 TaskHandle_t * const pxCreatedTask,
\r
861 const MemoryRegion_t * const xRegions )
\r
863 StackType_t *pxTopOfStack;
\r
866 #if( portUSING_MPU_WRAPPERS == 1 )
\r
867 /* Should the task be created in privileged mode? */
\r
868 BaseType_t xRunPrivileged;
\r
869 if( ( uxPriority & portPRIVILEGE_BIT ) != 0U )
\r
871 xRunPrivileged = pdTRUE;
\r
875 xRunPrivileged = pdFALSE;
\r
877 uxPriority &= ~portPRIVILEGE_BIT;
\r
878 #endif /* portUSING_MPU_WRAPPERS == 1 */
\r
880 /* Avoid dependency on memset() if it is not required. */
\r
881 #if( tskSET_NEW_STACKS_TO_KNOWN_VALUE == 1 )
\r
883 /* Fill the stack with a known value to assist debugging. */
\r
884 ( void ) memset( pxNewTCB->pxStack, ( int ) tskSTACK_FILL_BYTE, ( size_t ) ulStackDepth * sizeof( StackType_t ) );
\r
886 #endif /* tskSET_NEW_STACKS_TO_KNOWN_VALUE */
\r
888 /* Calculate the top of stack address. This depends on whether the stack
\r
889 grows from high memory to low (as per the 80x86) or vice versa.
\r
890 portSTACK_GROWTH is used to make the result positive or negative as required
\r
892 #if( portSTACK_GROWTH < 0 )
\r
894 pxTopOfStack = pxNewTCB->pxStack + ( ulStackDepth - ( uint32_t ) 1 );
\r
895 pxTopOfStack = ( StackType_t * ) ( ( ( portPOINTER_SIZE_TYPE ) pxTopOfStack ) & ( ~( ( portPOINTER_SIZE_TYPE ) portBYTE_ALIGNMENT_MASK ) ) ); /*lint !e923 MISRA exception. Avoiding casts between pointers and integers is not practical. Size differences accounted for using portPOINTER_SIZE_TYPE type. */
\r
897 /* Check the alignment of the calculated top of stack is correct. */
\r
898 configASSERT( ( ( ( portPOINTER_SIZE_TYPE ) pxTopOfStack & ( portPOINTER_SIZE_TYPE ) portBYTE_ALIGNMENT_MASK ) == 0UL ) );
\r
900 #if( configRECORD_STACK_HIGH_ADDRESS == 1 )
\r
902 /* Also record the stack's high address, which may assist
\r
904 pxNewTCB->pxEndOfStack = pxTopOfStack;
\r
906 #endif /* configRECORD_STACK_HIGH_ADDRESS */
\r
908 #else /* portSTACK_GROWTH */
\r
910 pxTopOfStack = pxNewTCB->pxStack;
\r
912 /* Check the alignment of the stack buffer is correct. */
\r
913 configASSERT( ( ( ( portPOINTER_SIZE_TYPE ) pxNewTCB->pxStack & ( portPOINTER_SIZE_TYPE ) portBYTE_ALIGNMENT_MASK ) == 0UL ) );
\r
915 /* The other extreme of the stack space is required if stack checking is
\r
917 pxNewTCB->pxEndOfStack = pxNewTCB->pxStack + ( ulStackDepth - ( uint32_t ) 1 );
\r
919 #endif /* portSTACK_GROWTH */
\r
921 /* Store the task name in the TCB. */
\r
922 for( x = ( UBaseType_t ) 0; x < ( UBaseType_t ) configMAX_TASK_NAME_LEN; x++ )
\r
924 pxNewTCB->pcTaskName[ x ] = pcName[ x ];
\r
926 /* Don't copy all configMAX_TASK_NAME_LEN if the string is shorter than
\r
927 configMAX_TASK_NAME_LEN characters just in case the memory after the
\r
928 string is not accessible (extremely unlikely). */
\r
929 if( pcName[ x ] == 0x00 )
\r
935 mtCOVERAGE_TEST_MARKER();
\r
939 /* Ensure the name string is terminated in the case that the string length
\r
940 was greater or equal to configMAX_TASK_NAME_LEN. */
\r
941 pxNewTCB->pcTaskName[ configMAX_TASK_NAME_LEN - 1 ] = '\0';
\r
943 /* This is used as an array index so must ensure it's not too large. First
\r
944 remove the privilege bit if one is present. */
\r
945 if( uxPriority >= ( UBaseType_t ) configMAX_PRIORITIES )
\r
947 uxPriority = ( UBaseType_t ) configMAX_PRIORITIES - ( UBaseType_t ) 1U;
\r
951 mtCOVERAGE_TEST_MARKER();
\r
954 pxNewTCB->uxPriority = uxPriority;
\r
955 #if ( configUSE_MUTEXES == 1 )
\r
957 pxNewTCB->uxBasePriority = uxPriority;
\r
958 pxNewTCB->uxMutexesHeld = 0;
\r
960 #endif /* configUSE_MUTEXES */
\r
962 vListInitialiseItem( &( pxNewTCB->xStateListItem ) );
\r
963 vListInitialiseItem( &( pxNewTCB->xEventListItem ) );
\r
965 /* Set the pxNewTCB as a link back from the ListItem_t. This is so we can get
\r
966 back to the containing TCB from a generic item in a list. */
\r
967 listSET_LIST_ITEM_OWNER( &( pxNewTCB->xStateListItem ), pxNewTCB );
\r
969 /* Event lists are always in priority order. */
\r
970 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
971 listSET_LIST_ITEM_OWNER( &( pxNewTCB->xEventListItem ), pxNewTCB );
\r
973 #if ( portCRITICAL_NESTING_IN_TCB == 1 )
\r
975 pxNewTCB->uxCriticalNesting = ( UBaseType_t ) 0U;
\r
977 #endif /* portCRITICAL_NESTING_IN_TCB */
\r
979 #if ( configUSE_APPLICATION_TASK_TAG == 1 )
\r
981 pxNewTCB->pxTaskTag = NULL;
\r
983 #endif /* configUSE_APPLICATION_TASK_TAG */
\r
985 #if ( configGENERATE_RUN_TIME_STATS == 1 )
\r
987 pxNewTCB->ulRunTimeCounter = 0UL;
\r
989 #endif /* configGENERATE_RUN_TIME_STATS */
\r
991 #if ( portUSING_MPU_WRAPPERS == 1 )
\r
993 vPortStoreTaskMPUSettings( &( pxNewTCB->xMPUSettings ), xRegions, pxNewTCB->pxStack, ulStackDepth );
\r
997 /* Avoid compiler warning about unreferenced parameter. */
\r
1002 #if( configNUM_THREAD_LOCAL_STORAGE_POINTERS != 0 )
\r
1004 for( x = 0; x < ( UBaseType_t ) configNUM_THREAD_LOCAL_STORAGE_POINTERS; x++ )
\r
1006 pxNewTCB->pvThreadLocalStoragePointers[ x ] = NULL;
\r
1011 #if ( configUSE_TASK_NOTIFICATIONS == 1 )
\r
1013 pxNewTCB->ulNotifiedValue = 0;
\r
1014 pxNewTCB->ucNotifyState = taskNOT_WAITING_NOTIFICATION;
\r
1018 #if ( configUSE_NEWLIB_REENTRANT == 1 )
\r
1020 /* Initialise this task's Newlib reent structure. */
\r
1021 _REENT_INIT_PTR( ( &( pxNewTCB->xNewLib_reent ) ) );
\r
1025 #if( INCLUDE_xTaskAbortDelay == 1 )
\r
1027 pxNewTCB->ucDelayAborted = pdFALSE;
\r
1031 /* Initialize the TCB stack to look as if the task was already running,
\r
1032 but had been interrupted by the scheduler. The return address is set
\r
1033 to the start of the task function. Once the stack has been initialised
\r
1034 the top of stack variable is updated. */
\r
1035 #if( portUSING_MPU_WRAPPERS == 1 )
\r
1037 pxNewTCB->pxTopOfStack = pxPortInitialiseStack( pxTopOfStack, pxTaskCode, pvParameters, xRunPrivileged );
\r
1039 #else /* portUSING_MPU_WRAPPERS */
\r
1041 pxNewTCB->pxTopOfStack = pxPortInitialiseStack( pxTopOfStack, pxTaskCode, pvParameters );
\r
1043 #endif /* portUSING_MPU_WRAPPERS */
\r
1045 if( ( void * ) pxCreatedTask != NULL )
\r
1047 /* Pass the handle out in an anonymous way. The handle can be used to
\r
1048 change the created task's priority, delete the created task, etc.*/
\r
1049 *pxCreatedTask = ( TaskHandle_t ) pxNewTCB;
\r
1053 mtCOVERAGE_TEST_MARKER();
\r
1056 /*-----------------------------------------------------------*/
\r
1058 static void prvAddNewTaskToReadyList( TCB_t *pxNewTCB )
\r
1060 /* Ensure interrupts don't access the task lists while the lists are being
\r
1062 taskENTER_CRITICAL();
\r
1064 uxCurrentNumberOfTasks++;
\r
1065 if( pxCurrentTCB == NULL )
\r
1067 /* There are no other tasks, or all the other tasks are in
\r
1068 the suspended state - make this the current task. */
\r
1069 pxCurrentTCB = pxNewTCB;
\r
1071 if( uxCurrentNumberOfTasks == ( UBaseType_t ) 1 )
\r
1073 /* This is the first task to be created so do the preliminary
\r
1074 initialisation required. We will not recover if this call
\r
1075 fails, but we will report the failure. */
\r
1076 prvInitialiseTaskLists();
\r
1080 mtCOVERAGE_TEST_MARKER();
\r
1085 /* If the scheduler is not already running, make this task the
\r
1086 current task if it is the highest priority task to be created
\r
1088 if( xSchedulerRunning == pdFALSE )
\r
1090 if( pxCurrentTCB->uxPriority <= pxNewTCB->uxPriority )
\r
1092 pxCurrentTCB = pxNewTCB;
\r
1096 mtCOVERAGE_TEST_MARKER();
\r
1101 mtCOVERAGE_TEST_MARKER();
\r
1107 #if ( configUSE_TRACE_FACILITY == 1 )
\r
1109 /* Add a counter into the TCB for tracing only. */
\r
1110 pxNewTCB->uxTCBNumber = uxTaskNumber;
\r
1112 #endif /* configUSE_TRACE_FACILITY */
\r
1113 traceTASK_CREATE( pxNewTCB );
\r
1115 prvAddTaskToReadyList( pxNewTCB );
\r
1117 portSETUP_TCB( pxNewTCB );
\r
1119 taskEXIT_CRITICAL();
\r
1121 if( xSchedulerRunning != pdFALSE )
\r
1123 /* If the created task is of a higher priority than the current task
\r
1124 then it should run now. */
\r
1125 if( pxCurrentTCB->uxPriority < pxNewTCB->uxPriority )
\r
1127 taskYIELD_IF_USING_PREEMPTION();
\r
1131 mtCOVERAGE_TEST_MARKER();
\r
1136 mtCOVERAGE_TEST_MARKER();
\r
1139 /*-----------------------------------------------------------*/
\r
1141 #if ( INCLUDE_vTaskDelete == 1 )
\r
1143 void vTaskDelete( TaskHandle_t xTaskToDelete )
\r
1147 taskENTER_CRITICAL();
\r
1149 /* If null is passed in here then it is the calling task that is
\r
1151 pxTCB = prvGetTCBFromHandle( xTaskToDelete );
\r
1153 /* Remove task from the ready list. */
\r
1154 if( uxListRemove( &( pxTCB->xStateListItem ) ) == ( UBaseType_t ) 0 )
\r
1156 taskRESET_READY_PRIORITY( pxTCB->uxPriority );
\r
1160 mtCOVERAGE_TEST_MARKER();
\r
1163 /* Is the task waiting on an event also? */
\r
1164 if( listLIST_ITEM_CONTAINER( &( pxTCB->xEventListItem ) ) != NULL )
\r
1166 ( void ) uxListRemove( &( pxTCB->xEventListItem ) );
\r
1170 mtCOVERAGE_TEST_MARKER();
\r
1173 /* Increment the uxTaskNumber also so kernel aware debuggers can
\r
1174 detect that the task lists need re-generating. This is done before
\r
1175 portPRE_TASK_DELETE_HOOK() as in the Windows port that macro will
\r
1179 if( pxTCB == pxCurrentTCB )
\r
1181 /* A task is deleting itself. This cannot complete within the
\r
1182 task itself, as a context switch to another task is required.
\r
1183 Place the task in the termination list. The idle task will
\r
1184 check the termination list and free up any memory allocated by
\r
1185 the scheduler for the TCB and stack of the deleted task. */
\r
1186 vListInsertEnd( &xTasksWaitingTermination, &( pxTCB->xStateListItem ) );
\r
1188 /* Increment the ucTasksDeleted variable so the idle task knows
\r
1189 there is a task that has been deleted and that it should therefore
\r
1190 check the xTasksWaitingTermination list. */
\r
1191 ++uxDeletedTasksWaitingCleanUp;
\r
1193 /* The pre-delete hook is primarily for the Windows simulator,
\r
1194 in which Windows specific clean up operations are performed,
\r
1195 after which it is not possible to yield away from this task -
\r
1196 hence xYieldPending is used to latch that a context switch is
\r
1198 portPRE_TASK_DELETE_HOOK( pxTCB, &xYieldPending );
\r
1202 --uxCurrentNumberOfTasks;
\r
1203 prvDeleteTCB( pxTCB );
\r
1205 /* Reset the next expected unblock time in case it referred to
\r
1206 the task that has just been deleted. */
\r
1207 prvResetNextTaskUnblockTime();
\r
1210 traceTASK_DELETE( pxTCB );
\r
1212 taskEXIT_CRITICAL();
\r
1214 /* Force a reschedule if it is the currently running task that has just
\r
1216 if( xSchedulerRunning != pdFALSE )
\r
1218 if( pxTCB == pxCurrentTCB )
\r
1220 configASSERT( uxSchedulerSuspended == 0 );
\r
1221 portYIELD_WITHIN_API();
\r
1225 mtCOVERAGE_TEST_MARKER();
\r
1230 #endif /* INCLUDE_vTaskDelete */
\r
1231 /*-----------------------------------------------------------*/
\r
1233 #if ( INCLUDE_vTaskDelayUntil == 1 )
\r
1235 void vTaskDelayUntil( TickType_t * const pxPreviousWakeTime, const TickType_t xTimeIncrement )
\r
1237 TickType_t xTimeToWake;
\r
1238 BaseType_t xAlreadyYielded, xShouldDelay = pdFALSE;
\r
1240 configASSERT( pxPreviousWakeTime );
\r
1241 configASSERT( ( xTimeIncrement > 0U ) );
\r
1242 configASSERT( uxSchedulerSuspended == 0 );
\r
1244 vTaskSuspendAll();
\r
1246 /* Minor optimisation. The tick count cannot change in this
\r
1248 const TickType_t xConstTickCount = xTickCount;
\r
1250 /* Generate the tick time at which the task wants to wake. */
\r
1251 xTimeToWake = *pxPreviousWakeTime + xTimeIncrement;
\r
1253 if( xConstTickCount < *pxPreviousWakeTime )
\r
1255 /* The tick count has overflowed since this function was
\r
1256 lasted called. In this case the only time we should ever
\r
1257 actually delay is if the wake time has also overflowed,
\r
1258 and the wake time is greater than the tick time. When this
\r
1259 is the case it is as if neither time had overflowed. */
\r
1260 if( ( xTimeToWake < *pxPreviousWakeTime ) && ( xTimeToWake > xConstTickCount ) )
\r
1262 xShouldDelay = pdTRUE;
\r
1266 mtCOVERAGE_TEST_MARKER();
\r
1271 /* The tick time has not overflowed. In this case we will
\r
1272 delay if either the wake time has overflowed, and/or the
\r
1273 tick time is less than the wake time. */
\r
1274 if( ( xTimeToWake < *pxPreviousWakeTime ) || ( xTimeToWake > xConstTickCount ) )
\r
1276 xShouldDelay = pdTRUE;
\r
1280 mtCOVERAGE_TEST_MARKER();
\r
1284 /* Update the wake time ready for the next call. */
\r
1285 *pxPreviousWakeTime = xTimeToWake;
\r
1287 if( xShouldDelay != pdFALSE )
\r
1289 traceTASK_DELAY_UNTIL( xTimeToWake );
\r
1291 /* prvAddCurrentTaskToDelayedList() needs the block time, not
\r
1292 the time to wake, so subtract the current tick count. */
\r
1293 prvAddCurrentTaskToDelayedList( xTimeToWake - xConstTickCount, pdFALSE );
\r
1297 mtCOVERAGE_TEST_MARKER();
\r
1300 xAlreadyYielded = xTaskResumeAll();
\r
1302 /* Force a reschedule if xTaskResumeAll has not already done so, we may
\r
1303 have put ourselves to sleep. */
\r
1304 if( xAlreadyYielded == pdFALSE )
\r
1306 portYIELD_WITHIN_API();
\r
1310 mtCOVERAGE_TEST_MARKER();
\r
1314 #endif /* INCLUDE_vTaskDelayUntil */
\r
1315 /*-----------------------------------------------------------*/
\r
1317 #if ( INCLUDE_vTaskDelay == 1 )
\r
1319 void vTaskDelay( const TickType_t xTicksToDelay )
\r
1321 BaseType_t xAlreadyYielded = pdFALSE;
\r
1323 /* A delay time of zero just forces a reschedule. */
\r
1324 if( xTicksToDelay > ( TickType_t ) 0U )
\r
1326 configASSERT( uxSchedulerSuspended == 0 );
\r
1327 vTaskSuspendAll();
\r
1329 traceTASK_DELAY();
\r
1331 /* A task that is removed from the event list while the
\r
1332 scheduler is suspended will not get placed in the ready
\r
1333 list or removed from the blocked list until the scheduler
\r
1336 This task cannot be in an event list as it is the currently
\r
1337 executing task. */
\r
1338 prvAddCurrentTaskToDelayedList( xTicksToDelay, pdFALSE );
\r
1340 xAlreadyYielded = xTaskResumeAll();
\r
1344 mtCOVERAGE_TEST_MARKER();
\r
1347 /* Force a reschedule if xTaskResumeAll has not already done so, we may
\r
1348 have put ourselves to sleep. */
\r
1349 if( xAlreadyYielded == pdFALSE )
\r
1351 portYIELD_WITHIN_API();
\r
1355 mtCOVERAGE_TEST_MARKER();
\r
1359 #endif /* INCLUDE_vTaskDelay */
\r
1360 /*-----------------------------------------------------------*/
\r
1362 #if( ( INCLUDE_eTaskGetState == 1 ) || ( configUSE_TRACE_FACILITY == 1 ) )
\r
1364 eTaskState eTaskGetState( TaskHandle_t xTask )
\r
1366 eTaskState eReturn;
\r
1367 List_t *pxStateList;
\r
1368 const TCB_t * const pxTCB = ( TCB_t * ) xTask;
\r
1370 configASSERT( pxTCB );
\r
1372 if( pxTCB == pxCurrentTCB )
\r
1374 /* The task calling this function is querying its own state. */
\r
1375 eReturn = eRunning;
\r
1379 taskENTER_CRITICAL();
\r
1381 pxStateList = ( List_t * ) listLIST_ITEM_CONTAINER( &( pxTCB->xStateListItem ) );
\r
1383 taskEXIT_CRITICAL();
\r
1385 if( ( pxStateList == pxDelayedTaskList ) || ( pxStateList == pxOverflowDelayedTaskList ) )
\r
1387 /* The task being queried is referenced from one of the Blocked
\r
1389 eReturn = eBlocked;
\r
1392 #if ( INCLUDE_vTaskSuspend == 1 )
\r
1393 else if( pxStateList == &xSuspendedTaskList )
\r
1395 /* The task being queried is referenced from the suspended
\r
1396 list. Is it genuinely suspended or is it block
\r
1398 if( listLIST_ITEM_CONTAINER( &( pxTCB->xEventListItem ) ) == NULL )
\r
1400 eReturn = eSuspended;
\r
1404 eReturn = eBlocked;
\r
1409 #if ( INCLUDE_vTaskDelete == 1 )
\r
1410 else if( ( pxStateList == &xTasksWaitingTermination ) || ( pxStateList == NULL ) )
\r
1412 /* The task being queried is referenced from the deleted
\r
1413 tasks list, or it is not referenced from any lists at
\r
1415 eReturn = eDeleted;
\r
1419 else /*lint !e525 Negative indentation is intended to make use of pre-processor clearer. */
\r
1421 /* If the task is not in any other state, it must be in the
\r
1422 Ready (including pending ready) state. */
\r
1428 } /*lint !e818 xTask cannot be a pointer to const because it is a typedef. */
\r
1430 #endif /* INCLUDE_eTaskGetState */
\r
1431 /*-----------------------------------------------------------*/
\r
1433 #if ( INCLUDE_uxTaskPriorityGet == 1 )
\r
1435 UBaseType_t uxTaskPriorityGet( TaskHandle_t xTask )
\r
1438 UBaseType_t uxReturn;
\r
1440 taskENTER_CRITICAL();
\r
1442 /* If null is passed in here then it is the priority of the that
\r
1443 called uxTaskPriorityGet() that is being queried. */
\r
1444 pxTCB = prvGetTCBFromHandle( xTask );
\r
1445 uxReturn = pxTCB->uxPriority;
\r
1447 taskEXIT_CRITICAL();
\r
1452 #endif /* INCLUDE_uxTaskPriorityGet */
\r
1453 /*-----------------------------------------------------------*/
\r
1455 #if ( INCLUDE_uxTaskPriorityGet == 1 )
\r
1457 UBaseType_t uxTaskPriorityGetFromISR( TaskHandle_t xTask )
\r
1460 UBaseType_t uxReturn, uxSavedInterruptState;
\r
1462 /* RTOS ports that support interrupt nesting have the concept of a
\r
1463 maximum system call (or maximum API call) interrupt priority.
\r
1464 Interrupts that are above the maximum system call priority are keep
\r
1465 permanently enabled, even when the RTOS kernel is in a critical section,
\r
1466 but cannot make any calls to FreeRTOS API functions. If configASSERT()
\r
1467 is defined in FreeRTOSConfig.h then
\r
1468 portASSERT_IF_INTERRUPT_PRIORITY_INVALID() will result in an assertion
\r
1469 failure if a FreeRTOS API function is called from an interrupt that has
\r
1470 been assigned a priority above the configured maximum system call
\r
1471 priority. Only FreeRTOS functions that end in FromISR can be called
\r
1472 from interrupts that have been assigned a priority at or (logically)
\r
1473 below the maximum system call interrupt priority. FreeRTOS maintains a
\r
1474 separate interrupt safe API to ensure interrupt entry is as fast and as
\r
1475 simple as possible. More information (albeit Cortex-M specific) is
\r
1476 provided on the following link:
\r
1477 http://www.freertos.org/RTOS-Cortex-M3-M4.html */
\r
1478 portASSERT_IF_INTERRUPT_PRIORITY_INVALID();
\r
1480 uxSavedInterruptState = portSET_INTERRUPT_MASK_FROM_ISR();
\r
1482 /* If null is passed in here then it is the priority of the calling
\r
1483 task that is being queried. */
\r
1484 pxTCB = prvGetTCBFromHandle( xTask );
\r
1485 uxReturn = pxTCB->uxPriority;
\r
1487 portCLEAR_INTERRUPT_MASK_FROM_ISR( uxSavedInterruptState );
\r
1492 #endif /* INCLUDE_uxTaskPriorityGet */
\r
1493 /*-----------------------------------------------------------*/
\r
1495 #if ( INCLUDE_vTaskPrioritySet == 1 )
\r
1497 void vTaskPrioritySet( TaskHandle_t xTask, UBaseType_t uxNewPriority )
\r
1500 UBaseType_t uxCurrentBasePriority, uxPriorityUsedOnEntry;
\r
1501 BaseType_t xYieldRequired = pdFALSE;
\r
1503 configASSERT( ( uxNewPriority < configMAX_PRIORITIES ) );
\r
1505 /* Ensure the new priority is valid. */
\r
1506 if( uxNewPriority >= ( UBaseType_t ) configMAX_PRIORITIES )
\r
1508 uxNewPriority = ( UBaseType_t ) configMAX_PRIORITIES - ( UBaseType_t ) 1U;
\r
1512 mtCOVERAGE_TEST_MARKER();
\r
1515 taskENTER_CRITICAL();
\r
1517 /* If null is passed in here then it is the priority of the calling
\r
1518 task that is being changed. */
\r
1519 pxTCB = prvGetTCBFromHandle( xTask );
\r
1521 traceTASK_PRIORITY_SET( pxTCB, uxNewPriority );
\r
1523 #if ( configUSE_MUTEXES == 1 )
\r
1525 uxCurrentBasePriority = pxTCB->uxBasePriority;
\r
1529 uxCurrentBasePriority = pxTCB->uxPriority;
\r
1533 if( uxCurrentBasePriority != uxNewPriority )
\r
1535 /* The priority change may have readied a task of higher
\r
1536 priority than the calling task. */
\r
1537 if( uxNewPriority > uxCurrentBasePriority )
\r
1539 if( pxTCB != pxCurrentTCB )
\r
1541 /* The priority of a task other than the currently
\r
1542 running task is being raised. Is the priority being
\r
1543 raised above that of the running task? */
\r
1544 if( uxNewPriority >= pxCurrentTCB->uxPriority )
\r
1546 xYieldRequired = pdTRUE;
\r
1550 mtCOVERAGE_TEST_MARKER();
\r
1555 /* The priority of the running task is being raised,
\r
1556 but the running task must already be the highest
\r
1557 priority task able to run so no yield is required. */
\r
1560 else if( pxTCB == pxCurrentTCB )
\r
1562 /* Setting the priority of the running task down means
\r
1563 there may now be another task of higher priority that
\r
1564 is ready to execute. */
\r
1565 xYieldRequired = pdTRUE;
\r
1569 /* Setting the priority of any other task down does not
\r
1570 require a yield as the running task must be above the
\r
1571 new priority of the task being modified. */
\r
1574 /* Remember the ready list the task might be referenced from
\r
1575 before its uxPriority member is changed so the
\r
1576 taskRESET_READY_PRIORITY() macro can function correctly. */
\r
1577 uxPriorityUsedOnEntry = pxTCB->uxPriority;
\r
1579 #if ( configUSE_MUTEXES == 1 )
\r
1581 /* Only change the priority being used if the task is not
\r
1582 currently using an inherited priority. */
\r
1583 if( pxTCB->uxBasePriority == pxTCB->uxPriority )
\r
1585 pxTCB->uxPriority = uxNewPriority;
\r
1589 mtCOVERAGE_TEST_MARKER();
\r
1592 /* The base priority gets set whatever. */
\r
1593 pxTCB->uxBasePriority = uxNewPriority;
\r
1597 pxTCB->uxPriority = uxNewPriority;
\r
1601 /* Only reset the event list item value if the value is not
\r
1602 being used for anything else. */
\r
1603 if( ( listGET_LIST_ITEM_VALUE( &( pxTCB->xEventListItem ) ) & taskEVENT_LIST_ITEM_VALUE_IN_USE ) == 0UL )
\r
1605 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
1609 mtCOVERAGE_TEST_MARKER();
\r
1612 /* If the task is in the blocked or suspended list we need do
\r
1613 nothing more than change it's priority variable. However, if
\r
1614 the task is in a ready list it needs to be removed and placed
\r
1615 in the list appropriate to its new priority. */
\r
1616 if( listIS_CONTAINED_WITHIN( &( pxReadyTasksLists[ uxPriorityUsedOnEntry ] ), &( pxTCB->xStateListItem ) ) != pdFALSE )
\r
1618 /* The task is currently in its ready list - remove before adding
\r
1619 it to it's new ready list. As we are in a critical section we
\r
1620 can do this even if the scheduler is suspended. */
\r
1621 if( uxListRemove( &( pxTCB->xStateListItem ) ) == ( UBaseType_t ) 0 )
\r
1623 /* It is known that the task is in its ready list so
\r
1624 there is no need to check again and the port level
\r
1625 reset macro can be called directly. */
\r
1626 portRESET_READY_PRIORITY( uxPriorityUsedOnEntry, uxTopReadyPriority );
\r
1630 mtCOVERAGE_TEST_MARKER();
\r
1632 prvAddTaskToReadyList( pxTCB );
\r
1636 mtCOVERAGE_TEST_MARKER();
\r
1639 if( xYieldRequired != pdFALSE )
\r
1641 taskYIELD_IF_USING_PREEMPTION();
\r
1645 mtCOVERAGE_TEST_MARKER();
\r
1648 /* Remove compiler warning about unused variables when the port
\r
1649 optimised task selection is not being used. */
\r
1650 ( void ) uxPriorityUsedOnEntry;
\r
1653 taskEXIT_CRITICAL();
\r
1656 #endif /* INCLUDE_vTaskPrioritySet */
\r
1657 /*-----------------------------------------------------------*/
\r
1659 #if ( INCLUDE_vTaskSuspend == 1 )
\r
1661 void vTaskSuspend( TaskHandle_t xTaskToSuspend )
\r
1665 taskENTER_CRITICAL();
\r
1667 /* If null is passed in here then it is the running task that is
\r
1668 being suspended. */
\r
1669 pxTCB = prvGetTCBFromHandle( xTaskToSuspend );
\r
1671 traceTASK_SUSPEND( pxTCB );
\r
1673 /* Remove task from the ready/delayed list and place in the
\r
1674 suspended list. */
\r
1675 if( uxListRemove( &( pxTCB->xStateListItem ) ) == ( UBaseType_t ) 0 )
\r
1677 taskRESET_READY_PRIORITY( pxTCB->uxPriority );
\r
1681 mtCOVERAGE_TEST_MARKER();
\r
1684 /* Is the task waiting on an event also? */
\r
1685 if( listLIST_ITEM_CONTAINER( &( pxTCB->xEventListItem ) ) != NULL )
\r
1687 ( void ) uxListRemove( &( pxTCB->xEventListItem ) );
\r
1691 mtCOVERAGE_TEST_MARKER();
\r
1694 vListInsertEnd( &xSuspendedTaskList, &( pxTCB->xStateListItem ) );
\r
1696 taskEXIT_CRITICAL();
\r
1698 if( xSchedulerRunning != pdFALSE )
\r
1700 /* Reset the next expected unblock time in case it referred to the
\r
1701 task that is now in the Suspended state. */
\r
1702 taskENTER_CRITICAL();
\r
1704 prvResetNextTaskUnblockTime();
\r
1706 taskEXIT_CRITICAL();
\r
1710 mtCOVERAGE_TEST_MARKER();
\r
1713 if( pxTCB == pxCurrentTCB )
\r
1715 if( xSchedulerRunning != pdFALSE )
\r
1717 /* The current task has just been suspended. */
\r
1718 configASSERT( uxSchedulerSuspended == 0 );
\r
1719 portYIELD_WITHIN_API();
\r
1723 /* The scheduler is not running, but the task that was pointed
\r
1724 to by pxCurrentTCB has just been suspended and pxCurrentTCB
\r
1725 must be adjusted to point to a different task. */
\r
1726 if( listCURRENT_LIST_LENGTH( &xSuspendedTaskList ) == uxCurrentNumberOfTasks )
\r
1728 /* No other tasks are ready, so set pxCurrentTCB back to
\r
1729 NULL so when the next task is created pxCurrentTCB will
\r
1730 be set to point to it no matter what its relative priority
\r
1732 pxCurrentTCB = NULL;
\r
1736 vTaskSwitchContext();
\r
1742 mtCOVERAGE_TEST_MARKER();
\r
1746 #endif /* INCLUDE_vTaskSuspend */
\r
1747 /*-----------------------------------------------------------*/
\r
1749 #if ( INCLUDE_vTaskSuspend == 1 )
\r
1751 static BaseType_t prvTaskIsTaskSuspended( const TaskHandle_t xTask )
\r
1753 BaseType_t xReturn = pdFALSE;
\r
1754 const TCB_t * const pxTCB = ( TCB_t * ) xTask;
\r
1756 /* Accesses xPendingReadyList so must be called from a critical
\r
1759 /* It does not make sense to check if the calling task is suspended. */
\r
1760 configASSERT( xTask );
\r
1762 /* Is the task being resumed actually in the suspended list? */
\r
1763 if( listIS_CONTAINED_WITHIN( &xSuspendedTaskList, &( pxTCB->xStateListItem ) ) != pdFALSE )
\r
1765 /* Has the task already been resumed from within an ISR? */
\r
1766 if( listIS_CONTAINED_WITHIN( &xPendingReadyList, &( pxTCB->xEventListItem ) ) == pdFALSE )
\r
1768 /* Is it in the suspended list because it is in the Suspended
\r
1769 state, or because is is blocked with no timeout? */
\r
1770 if( listIS_CONTAINED_WITHIN( NULL, &( pxTCB->xEventListItem ) ) != pdFALSE ) /*lint !e961. The cast is only redundant when NULL is used. */
\r
1776 mtCOVERAGE_TEST_MARKER();
\r
1781 mtCOVERAGE_TEST_MARKER();
\r
1786 mtCOVERAGE_TEST_MARKER();
\r
1790 } /*lint !e818 xTask cannot be a pointer to const because it is a typedef. */
\r
1792 #endif /* INCLUDE_vTaskSuspend */
\r
1793 /*-----------------------------------------------------------*/
\r
1795 #if ( INCLUDE_vTaskSuspend == 1 )
\r
1797 void vTaskResume( TaskHandle_t xTaskToResume )
\r
1799 TCB_t * const pxTCB = ( TCB_t * ) xTaskToResume;
\r
1801 /* It does not make sense to resume the calling task. */
\r
1802 configASSERT( xTaskToResume );
\r
1804 /* The parameter cannot be NULL as it is impossible to resume the
\r
1805 currently executing task. */
\r
1806 if( ( pxTCB != NULL ) && ( pxTCB != pxCurrentTCB ) )
\r
1808 taskENTER_CRITICAL();
\r
1810 if( prvTaskIsTaskSuspended( pxTCB ) != pdFALSE )
\r
1812 traceTASK_RESUME( pxTCB );
\r
1814 /* As we are in a critical section we can access the ready
\r
1815 lists even if the scheduler is suspended. */
\r
1816 ( void ) uxListRemove( &( pxTCB->xStateListItem ) );
\r
1817 prvAddTaskToReadyList( pxTCB );
\r
1819 /* We may have just resumed a higher priority task. */
\r
1820 if( pxTCB->uxPriority >= pxCurrentTCB->uxPriority )
\r
1822 /* This yield may not cause the task just resumed to run,
\r
1823 but will leave the lists in the correct state for the
\r
1825 taskYIELD_IF_USING_PREEMPTION();
\r
1829 mtCOVERAGE_TEST_MARKER();
\r
1834 mtCOVERAGE_TEST_MARKER();
\r
1837 taskEXIT_CRITICAL();
\r
1841 mtCOVERAGE_TEST_MARKER();
\r
1845 #endif /* INCLUDE_vTaskSuspend */
\r
1847 /*-----------------------------------------------------------*/
\r
1849 #if ( ( INCLUDE_xTaskResumeFromISR == 1 ) && ( INCLUDE_vTaskSuspend == 1 ) )
\r
1851 BaseType_t xTaskResumeFromISR( TaskHandle_t xTaskToResume )
\r
1853 BaseType_t xYieldRequired = pdFALSE;
\r
1854 TCB_t * const pxTCB = ( TCB_t * ) xTaskToResume;
\r
1855 UBaseType_t uxSavedInterruptStatus;
\r
1857 configASSERT( xTaskToResume );
\r
1859 /* RTOS ports that support interrupt nesting have the concept of a
\r
1860 maximum system call (or maximum API call) interrupt priority.
\r
1861 Interrupts that are above the maximum system call priority are keep
\r
1862 permanently enabled, even when the RTOS kernel is in a critical section,
\r
1863 but cannot make any calls to FreeRTOS API functions. If configASSERT()
\r
1864 is defined in FreeRTOSConfig.h then
\r
1865 portASSERT_IF_INTERRUPT_PRIORITY_INVALID() will result in an assertion
\r
1866 failure if a FreeRTOS API function is called from an interrupt that has
\r
1867 been assigned a priority above the configured maximum system call
\r
1868 priority. Only FreeRTOS functions that end in FromISR can be called
\r
1869 from interrupts that have been assigned a priority at or (logically)
\r
1870 below the maximum system call interrupt priority. FreeRTOS maintains a
\r
1871 separate interrupt safe API to ensure interrupt entry is as fast and as
\r
1872 simple as possible. More information (albeit Cortex-M specific) is
\r
1873 provided on the following link:
\r
1874 http://www.freertos.org/RTOS-Cortex-M3-M4.html */
\r
1875 portASSERT_IF_INTERRUPT_PRIORITY_INVALID();
\r
1877 uxSavedInterruptStatus = portSET_INTERRUPT_MASK_FROM_ISR();
\r
1879 if( prvTaskIsTaskSuspended( pxTCB ) != pdFALSE )
\r
1881 traceTASK_RESUME_FROM_ISR( pxTCB );
\r
1883 /* Check the ready lists can be accessed. */
\r
1884 if( uxSchedulerSuspended == ( UBaseType_t ) pdFALSE )
\r
1886 /* Ready lists can be accessed so move the task from the
\r
1887 suspended list to the ready list directly. */
\r
1888 if( pxTCB->uxPriority >= pxCurrentTCB->uxPriority )
\r
1890 xYieldRequired = pdTRUE;
\r
1894 mtCOVERAGE_TEST_MARKER();
\r
1897 ( void ) uxListRemove( &( pxTCB->xStateListItem ) );
\r
1898 prvAddTaskToReadyList( pxTCB );
\r
1902 /* The delayed or ready lists cannot be accessed so the task
\r
1903 is held in the pending ready list until the scheduler is
\r
1905 vListInsertEnd( &( xPendingReadyList ), &( pxTCB->xEventListItem ) );
\r
1910 mtCOVERAGE_TEST_MARKER();
\r
1913 portCLEAR_INTERRUPT_MASK_FROM_ISR( uxSavedInterruptStatus );
\r
1915 return xYieldRequired;
\r
1918 #endif /* ( ( INCLUDE_xTaskResumeFromISR == 1 ) && ( INCLUDE_vTaskSuspend == 1 ) ) */
\r
1919 /*-----------------------------------------------------------*/
\r
1921 void vTaskStartScheduler( void )
\r
1923 BaseType_t xReturn;
\r
1925 /* Add the idle task at the lowest priority. */
\r
1926 #if( configSUPPORT_STATIC_ALLOCATION == 1 )
\r
1928 StaticTask_t *pxIdleTaskTCBBuffer = NULL;
\r
1929 StackType_t *pxIdleTaskStackBuffer = NULL;
\r
1930 uint32_t ulIdleTaskStackSize;
\r
1932 /* The Idle task is created using user provided RAM - obtain the
\r
1933 address of the RAM then create the idle task. */
\r
1934 vApplicationGetIdleTaskMemory( &pxIdleTaskTCBBuffer, &pxIdleTaskStackBuffer, &ulIdleTaskStackSize );
\r
1935 xIdleTaskHandle = xTaskCreateStatic( prvIdleTask,
\r
1937 ulIdleTaskStackSize,
\r
1938 ( void * ) NULL, /*lint !e961. The cast is not redundant for all compilers. */
\r
1939 ( tskIDLE_PRIORITY | portPRIVILEGE_BIT ),
\r
1940 pxIdleTaskStackBuffer,
\r
1941 pxIdleTaskTCBBuffer ); /*lint !e961 MISRA exception, justified as it is not a redundant explicit cast to all supported compilers. */
\r
1943 if( xIdleTaskHandle != NULL )
\r
1954 /* The Idle task is being created using dynamically allocated RAM. */
\r
1955 xReturn = xTaskCreate( prvIdleTask,
\r
1956 "IDLE", configMINIMAL_STACK_SIZE,
\r
1958 ( tskIDLE_PRIORITY | portPRIVILEGE_BIT ),
\r
1959 &xIdleTaskHandle ); /*lint !e961 MISRA exception, justified as it is not a redundant explicit cast to all supported compilers. */
\r
1961 #endif /* configSUPPORT_STATIC_ALLOCATION */
\r
1963 #if ( configUSE_TIMERS == 1 )
\r
1965 if( xReturn == pdPASS )
\r
1967 xReturn = xTimerCreateTimerTask();
\r
1971 mtCOVERAGE_TEST_MARKER();
\r
1974 #endif /* configUSE_TIMERS */
\r
1976 if( xReturn == pdPASS )
\r
1978 /* freertos_tasks_c_additions_init() should only be called if the user
\r
1979 definable macro FREERTOS_TASKS_C_ADDITIONS_INIT() is defined, as that is
\r
1980 the only macro called by the function. */
\r
1981 #ifdef FREERTOS_TASKS_C_ADDITIONS_INIT
\r
1983 freertos_tasks_c_additions_init();
\r
1987 /* Interrupts are turned off here, to ensure a tick does not occur
\r
1988 before or during the call to xPortStartScheduler(). The stacks of
\r
1989 the created tasks contain a status word with interrupts switched on
\r
1990 so interrupts will automatically get re-enabled when the first task
\r
1992 portDISABLE_INTERRUPTS();
\r
1994 #if ( configUSE_NEWLIB_REENTRANT == 1 )
\r
1996 /* Switch Newlib's _impure_ptr variable to point to the _reent
\r
1997 structure specific to the task that will run first. */
\r
1998 _impure_ptr = &( pxCurrentTCB->xNewLib_reent );
\r
2000 #endif /* configUSE_NEWLIB_REENTRANT */
\r
2002 xNextTaskUnblockTime = portMAX_DELAY;
\r
2003 xSchedulerRunning = pdTRUE;
\r
2004 xTickCount = ( TickType_t ) 0U;
\r
2006 /* If configGENERATE_RUN_TIME_STATS is defined then the following
\r
2007 macro must be defined to configure the timer/counter used to generate
\r
2008 the run time counter time base. NOTE: If configGENERATE_RUN_TIME_STATS
\r
2009 is set to 0 and the following line fails to build then ensure you do not
\r
2010 have portCONFIGURE_TIMER_FOR_RUN_TIME_STATS() defined in your
\r
2011 FreeRTOSConfig.h file. */
\r
2012 portCONFIGURE_TIMER_FOR_RUN_TIME_STATS();
\r
2014 /* Setting up the timer tick is hardware specific and thus in the
\r
2015 portable interface. */
\r
2016 if( xPortStartScheduler() != pdFALSE )
\r
2018 /* Should not reach here as if the scheduler is running the
\r
2019 function will not return. */
\r
2023 /* Should only reach here if a task calls xTaskEndScheduler(). */
\r
2028 /* This line will only be reached if the kernel could not be started,
\r
2029 because there was not enough FreeRTOS heap to create the idle task
\r
2030 or the timer task. */
\r
2031 configASSERT( xReturn != errCOULD_NOT_ALLOCATE_REQUIRED_MEMORY );
\r
2034 /* Prevent compiler warnings if INCLUDE_xTaskGetIdleTaskHandle is set to 0,
\r
2035 meaning xIdleTaskHandle is not used anywhere else. */
\r
2036 ( void ) xIdleTaskHandle;
\r
2038 /*-----------------------------------------------------------*/
\r
2040 void vTaskEndScheduler( void )
\r
2042 /* Stop the scheduler interrupts and call the portable scheduler end
\r
2043 routine so the original ISRs can be restored if necessary. The port
\r
2044 layer must ensure interrupts enable bit is left in the correct state. */
\r
2045 portDISABLE_INTERRUPTS();
\r
2046 xSchedulerRunning = pdFALSE;
\r
2047 vPortEndScheduler();
\r
2049 /*----------------------------------------------------------*/
\r
2051 void vTaskSuspendAll( void )
\r
2053 /* A critical section is not required as the variable is of type
\r
2054 BaseType_t. Please read Richard Barry's reply in the following link to a
\r
2055 post in the FreeRTOS support forum before reporting this as a bug! -
\r
2056 http://goo.gl/wu4acr */
\r
2057 ++uxSchedulerSuspended;
\r
2059 /*----------------------------------------------------------*/
\r
2061 #if ( configUSE_TICKLESS_IDLE != 0 )
\r
2063 static TickType_t prvGetExpectedIdleTime( void )
\r
2065 TickType_t xReturn;
\r
2066 UBaseType_t uxHigherPriorityReadyTasks = pdFALSE;
\r
2068 /* uxHigherPriorityReadyTasks takes care of the case where
\r
2069 configUSE_PREEMPTION is 0, so there may be tasks above the idle priority
\r
2070 task that are in the Ready state, even though the idle task is
\r
2072 #if( configUSE_PORT_OPTIMISED_TASK_SELECTION == 0 )
\r
2074 if( uxTopReadyPriority > tskIDLE_PRIORITY )
\r
2076 uxHigherPriorityReadyTasks = pdTRUE;
\r
2081 const UBaseType_t uxLeastSignificantBit = ( UBaseType_t ) 0x01;
\r
2083 /* When port optimised task selection is used the uxTopReadyPriority
\r
2084 variable is used as a bit map. If bits other than the least
\r
2085 significant bit are set then there are tasks that have a priority
\r
2086 above the idle priority that are in the Ready state. This takes
\r
2087 care of the case where the co-operative scheduler is in use. */
\r
2088 if( uxTopReadyPriority > uxLeastSignificantBit )
\r
2090 uxHigherPriorityReadyTasks = pdTRUE;
\r
2095 if( pxCurrentTCB->uxPriority > tskIDLE_PRIORITY )
\r
2099 else if( listCURRENT_LIST_LENGTH( &( pxReadyTasksLists[ tskIDLE_PRIORITY ] ) ) > 1 )
\r
2101 /* There are other idle priority tasks in the ready state. If
\r
2102 time slicing is used then the very next tick interrupt must be
\r
2106 else if( uxHigherPriorityReadyTasks != pdFALSE )
\r
2108 /* There are tasks in the Ready state that have a priority above the
\r
2109 idle priority. This path can only be reached if
\r
2110 configUSE_PREEMPTION is 0. */
\r
2115 xReturn = xNextTaskUnblockTime - xTickCount;
\r
2121 #endif /* configUSE_TICKLESS_IDLE */
\r
2122 /*----------------------------------------------------------*/
\r
2124 BaseType_t xTaskResumeAll( void )
\r
2126 TCB_t *pxTCB = NULL;
\r
2127 BaseType_t xAlreadyYielded = pdFALSE;
\r
2129 /* If uxSchedulerSuspended is zero then this function does not match a
\r
2130 previous call to vTaskSuspendAll(). */
\r
2131 configASSERT( uxSchedulerSuspended );
\r
2133 /* It is possible that an ISR caused a task to be removed from an event
\r
2134 list while the scheduler was suspended. If this was the case then the
\r
2135 removed task will have been added to the xPendingReadyList. Once the
\r
2136 scheduler has been resumed it is safe to move all the pending ready
\r
2137 tasks from this list into their appropriate ready list. */
\r
2138 taskENTER_CRITICAL();
\r
2140 --uxSchedulerSuspended;
\r
2142 if( uxSchedulerSuspended == ( UBaseType_t ) pdFALSE )
\r
2144 if( uxCurrentNumberOfTasks > ( UBaseType_t ) 0U )
\r
2146 /* Move any readied tasks from the pending list into the
\r
2147 appropriate ready list. */
\r
2148 while( listLIST_IS_EMPTY( &xPendingReadyList ) == pdFALSE )
\r
2150 pxTCB = ( TCB_t * ) listGET_OWNER_OF_HEAD_ENTRY( ( &xPendingReadyList ) );
\r
2151 ( void ) uxListRemove( &( pxTCB->xEventListItem ) );
\r
2152 ( void ) uxListRemove( &( pxTCB->xStateListItem ) );
\r
2153 prvAddTaskToReadyList( pxTCB );
\r
2155 /* If the moved task has a priority higher than the current
\r
2156 task then a yield must be performed. */
\r
2157 if( pxTCB->uxPriority >= pxCurrentTCB->uxPriority )
\r
2159 xYieldPending = pdTRUE;
\r
2163 mtCOVERAGE_TEST_MARKER();
\r
2167 if( pxTCB != NULL )
\r
2169 /* A task was unblocked while the scheduler was suspended,
\r
2170 which may have prevented the next unblock time from being
\r
2171 re-calculated, in which case re-calculate it now. Mainly
\r
2172 important for low power tickless implementations, where
\r
2173 this can prevent an unnecessary exit from low power
\r
2175 prvResetNextTaskUnblockTime();
\r
2178 /* If any ticks occurred while the scheduler was suspended then
\r
2179 they should be processed now. This ensures the tick count does
\r
2180 not slip, and that any delayed tasks are resumed at the correct
\r
2183 UBaseType_t uxPendedCounts = uxPendedTicks; /* Non-volatile copy. */
\r
2185 if( uxPendedCounts > ( UBaseType_t ) 0U )
\r
2189 if( xTaskIncrementTick() != pdFALSE )
\r
2191 xYieldPending = pdTRUE;
\r
2195 mtCOVERAGE_TEST_MARKER();
\r
2198 } while( uxPendedCounts > ( UBaseType_t ) 0U );
\r
2200 uxPendedTicks = 0;
\r
2204 mtCOVERAGE_TEST_MARKER();
\r
2208 if( xYieldPending != pdFALSE )
\r
2210 #if( configUSE_PREEMPTION != 0 )
\r
2212 xAlreadyYielded = pdTRUE;
\r
2215 taskYIELD_IF_USING_PREEMPTION();
\r
2219 mtCOVERAGE_TEST_MARKER();
\r
2225 mtCOVERAGE_TEST_MARKER();
\r
2228 taskEXIT_CRITICAL();
\r
2230 return xAlreadyYielded;
\r
2232 /*-----------------------------------------------------------*/
\r
2234 TickType_t xTaskGetTickCount( void )
\r
2236 TickType_t xTicks;
\r
2238 /* Critical section required if running on a 16 bit processor. */
\r
2239 portTICK_TYPE_ENTER_CRITICAL();
\r
2241 xTicks = xTickCount;
\r
2243 portTICK_TYPE_EXIT_CRITICAL();
\r
2247 /*-----------------------------------------------------------*/
\r
2249 TickType_t xTaskGetTickCountFromISR( void )
\r
2251 TickType_t xReturn;
\r
2252 UBaseType_t uxSavedInterruptStatus;
\r
2254 /* RTOS ports that support interrupt nesting have the concept of a maximum
\r
2255 system call (or maximum API call) interrupt priority. Interrupts that are
\r
2256 above the maximum system call priority are kept permanently enabled, even
\r
2257 when the RTOS kernel is in a critical section, but cannot make any calls to
\r
2258 FreeRTOS API functions. If configASSERT() is defined in FreeRTOSConfig.h
\r
2259 then portASSERT_IF_INTERRUPT_PRIORITY_INVALID() will result in an assertion
\r
2260 failure if a FreeRTOS API function is called from an interrupt that has been
\r
2261 assigned a priority above the configured maximum system call priority.
\r
2262 Only FreeRTOS functions that end in FromISR can be called from interrupts
\r
2263 that have been assigned a priority at or (logically) below the maximum
\r
2264 system call interrupt priority. FreeRTOS maintains a separate interrupt
\r
2265 safe API to ensure interrupt entry is as fast and as simple as possible.
\r
2266 More information (albeit Cortex-M specific) is provided on the following
\r
2267 link: http://www.freertos.org/RTOS-Cortex-M3-M4.html */
\r
2268 portASSERT_IF_INTERRUPT_PRIORITY_INVALID();
\r
2270 uxSavedInterruptStatus = portTICK_TYPE_SET_INTERRUPT_MASK_FROM_ISR();
\r
2272 xReturn = xTickCount;
\r
2274 portTICK_TYPE_CLEAR_INTERRUPT_MASK_FROM_ISR( uxSavedInterruptStatus );
\r
2278 /*-----------------------------------------------------------*/
\r
2280 UBaseType_t uxTaskGetNumberOfTasks( void )
\r
2282 /* A critical section is not required because the variables are of type
\r
2284 return uxCurrentNumberOfTasks;
\r
2286 /*-----------------------------------------------------------*/
\r
2288 char *pcTaskGetName( TaskHandle_t xTaskToQuery ) /*lint !e971 Unqualified char types are allowed for strings and single characters only. */
\r
2292 /* If null is passed in here then the name of the calling task is being
\r
2294 pxTCB = prvGetTCBFromHandle( xTaskToQuery );
\r
2295 configASSERT( pxTCB );
\r
2296 return &( pxTCB->pcTaskName[ 0 ] );
\r
2298 /*-----------------------------------------------------------*/
\r
2300 #if ( INCLUDE_xTaskGetHandle == 1 )
\r
2302 static TCB_t *prvSearchForNameWithinSingleList( List_t *pxList, const char pcNameToQuery[] )
\r
2304 TCB_t *pxNextTCB, *pxFirstTCB, *pxReturn = NULL;
\r
2308 /* This function is called with the scheduler suspended. */
\r
2310 if( listCURRENT_LIST_LENGTH( pxList ) > ( UBaseType_t ) 0 )
\r
2312 listGET_OWNER_OF_NEXT_ENTRY( pxFirstTCB, pxList );
\r
2316 listGET_OWNER_OF_NEXT_ENTRY( pxNextTCB, pxList );
\r
2318 /* Check each character in the name looking for a match or
\r
2320 for( x = ( UBaseType_t ) 0; x < ( UBaseType_t ) configMAX_TASK_NAME_LEN; x++ )
\r
2322 cNextChar = pxNextTCB->pcTaskName[ x ];
\r
2324 if( cNextChar != pcNameToQuery[ x ] )
\r
2326 /* Characters didn't match. */
\r
2329 else if( cNextChar == 0x00 )
\r
2331 /* Both strings terminated, a match must have been
\r
2333 pxReturn = pxNextTCB;
\r
2338 mtCOVERAGE_TEST_MARKER();
\r
2342 if( pxReturn != NULL )
\r
2344 /* The handle has been found. */
\r
2348 } while( pxNextTCB != pxFirstTCB );
\r
2352 mtCOVERAGE_TEST_MARKER();
\r
2358 #endif /* INCLUDE_xTaskGetHandle */
\r
2359 /*-----------------------------------------------------------*/
\r
2361 #if ( INCLUDE_xTaskGetHandle == 1 )
\r
2363 TaskHandle_t xTaskGetHandle( const char *pcNameToQuery ) /*lint !e971 Unqualified char types are allowed for strings and single characters only. */
\r
2365 UBaseType_t uxQueue = configMAX_PRIORITIES;
\r
2368 /* Task names will be truncated to configMAX_TASK_NAME_LEN - 1 bytes. */
\r
2369 configASSERT( strlen( pcNameToQuery ) < configMAX_TASK_NAME_LEN );
\r
2371 vTaskSuspendAll();
\r
2373 /* Search the ready lists. */
\r
2377 pxTCB = prvSearchForNameWithinSingleList( ( List_t * ) &( pxReadyTasksLists[ uxQueue ] ), pcNameToQuery );
\r
2379 if( pxTCB != NULL )
\r
2381 /* Found the handle. */
\r
2385 } while( uxQueue > ( UBaseType_t ) tskIDLE_PRIORITY ); /*lint !e961 MISRA exception as the casts are only redundant for some ports. */
\r
2387 /* Search the delayed lists. */
\r
2388 if( pxTCB == NULL )
\r
2390 pxTCB = prvSearchForNameWithinSingleList( ( List_t * ) pxDelayedTaskList, pcNameToQuery );
\r
2393 if( pxTCB == NULL )
\r
2395 pxTCB = prvSearchForNameWithinSingleList( ( List_t * ) pxOverflowDelayedTaskList, pcNameToQuery );
\r
2398 #if ( INCLUDE_vTaskSuspend == 1 )
\r
2400 if( pxTCB == NULL )
\r
2402 /* Search the suspended list. */
\r
2403 pxTCB = prvSearchForNameWithinSingleList( &xSuspendedTaskList, pcNameToQuery );
\r
2408 #if( INCLUDE_vTaskDelete == 1 )
\r
2410 if( pxTCB == NULL )
\r
2412 /* Search the deleted list. */
\r
2413 pxTCB = prvSearchForNameWithinSingleList( &xTasksWaitingTermination, pcNameToQuery );
\r
2418 ( void ) xTaskResumeAll();
\r
2420 return ( TaskHandle_t ) pxTCB;
\r
2423 #endif /* INCLUDE_xTaskGetHandle */
\r
2424 /*-----------------------------------------------------------*/
\r
2426 #if ( configUSE_TRACE_FACILITY == 1 )
\r
2428 UBaseType_t uxTaskGetSystemState( TaskStatus_t * const pxTaskStatusArray, const UBaseType_t uxArraySize, uint32_t * const pulTotalRunTime )
\r
2430 UBaseType_t uxTask = 0, uxQueue = configMAX_PRIORITIES;
\r
2432 vTaskSuspendAll();
\r
2434 /* Is there a space in the array for each task in the system? */
\r
2435 if( uxArraySize >= uxCurrentNumberOfTasks )
\r
2437 /* Fill in an TaskStatus_t structure with information on each
\r
2438 task in the Ready state. */
\r
2442 uxTask += prvListTasksWithinSingleList( &( pxTaskStatusArray[ uxTask ] ), &( pxReadyTasksLists[ uxQueue ] ), eReady );
\r
2444 } while( uxQueue > ( UBaseType_t ) tskIDLE_PRIORITY ); /*lint !e961 MISRA exception as the casts are only redundant for some ports. */
\r
2446 /* Fill in an TaskStatus_t structure with information on each
\r
2447 task in the Blocked state. */
\r
2448 uxTask += prvListTasksWithinSingleList( &( pxTaskStatusArray[ uxTask ] ), ( List_t * ) pxDelayedTaskList, eBlocked );
\r
2449 uxTask += prvListTasksWithinSingleList( &( pxTaskStatusArray[ uxTask ] ), ( List_t * ) pxOverflowDelayedTaskList, eBlocked );
\r
2451 #if( INCLUDE_vTaskDelete == 1 )
\r
2453 /* Fill in an TaskStatus_t structure with information on
\r
2454 each task that has been deleted but not yet cleaned up. */
\r
2455 uxTask += prvListTasksWithinSingleList( &( pxTaskStatusArray[ uxTask ] ), &xTasksWaitingTermination, eDeleted );
\r
2459 #if ( INCLUDE_vTaskSuspend == 1 )
\r
2461 /* Fill in an TaskStatus_t structure with information on
\r
2462 each task in the Suspended state. */
\r
2463 uxTask += prvListTasksWithinSingleList( &( pxTaskStatusArray[ uxTask ] ), &xSuspendedTaskList, eSuspended );
\r
2467 #if ( configGENERATE_RUN_TIME_STATS == 1)
\r
2469 if( pulTotalRunTime != NULL )
\r
2471 #ifdef portALT_GET_RUN_TIME_COUNTER_VALUE
\r
2472 portALT_GET_RUN_TIME_COUNTER_VALUE( ( *pulTotalRunTime ) );
\r
2474 *pulTotalRunTime = portGET_RUN_TIME_COUNTER_VALUE();
\r
2480 if( pulTotalRunTime != NULL )
\r
2482 *pulTotalRunTime = 0;
\r
2489 mtCOVERAGE_TEST_MARKER();
\r
2492 ( void ) xTaskResumeAll();
\r
2497 #endif /* configUSE_TRACE_FACILITY */
\r
2498 /*----------------------------------------------------------*/
\r
2500 #if ( INCLUDE_xTaskGetIdleTaskHandle == 1 )
\r
2502 TaskHandle_t xTaskGetIdleTaskHandle( void )
\r
2504 /* If xTaskGetIdleTaskHandle() is called before the scheduler has been
\r
2505 started, then xIdleTaskHandle will be NULL. */
\r
2506 configASSERT( ( xIdleTaskHandle != NULL ) );
\r
2507 return xIdleTaskHandle;
\r
2510 #endif /* INCLUDE_xTaskGetIdleTaskHandle */
\r
2511 /*----------------------------------------------------------*/
\r
2513 /* This conditional compilation should use inequality to 0, not equality to 1.
\r
2514 This is to ensure vTaskStepTick() is available when user defined low power mode
\r
2515 implementations require configUSE_TICKLESS_IDLE to be set to a value other than
\r
2517 #if ( configUSE_TICKLESS_IDLE != 0 )
\r
2519 void vTaskStepTick( const TickType_t xTicksToJump )
\r
2521 /* Correct the tick count value after a period during which the tick
\r
2522 was suppressed. Note this does *not* call the tick hook function for
\r
2523 each stepped tick. */
\r
2524 configASSERT( ( xTickCount + xTicksToJump ) <= xNextTaskUnblockTime );
\r
2525 xTickCount += xTicksToJump;
\r
2526 traceINCREASE_TICK_COUNT( xTicksToJump );
\r
2529 #endif /* configUSE_TICKLESS_IDLE */
\r
2530 /*----------------------------------------------------------*/
\r
2532 #if ( INCLUDE_xTaskAbortDelay == 1 )
\r
2534 BaseType_t xTaskAbortDelay( TaskHandle_t xTask )
\r
2536 TCB_t *pxTCB = ( TCB_t * ) xTask;
\r
2537 BaseType_t xReturn = pdFALSE;
\r
2539 configASSERT( pxTCB );
\r
2541 vTaskSuspendAll();
\r
2543 /* A task can only be prematurely removed from the Blocked state if
\r
2544 it is actually in the Blocked state. */
\r
2545 if( eTaskGetState( xTask ) == eBlocked )
\r
2547 /* Remove the reference to the task from the blocked list. An
\r
2548 interrupt won't touch the xStateListItem because the
\r
2549 scheduler is suspended. */
\r
2550 ( void ) uxListRemove( &( pxTCB->xStateListItem ) );
\r
2552 /* Is the task waiting on an event also? If so remove it from
\r
2553 the event list too. Interrupts can touch the event list item,
\r
2554 even though the scheduler is suspended, so a critical section
\r
2556 taskENTER_CRITICAL();
\r
2558 if( listLIST_ITEM_CONTAINER( &( pxTCB->xEventListItem ) ) != NULL )
\r
2560 ( void ) uxListRemove( &( pxTCB->xEventListItem ) );
\r
2561 pxTCB->ucDelayAborted = pdTRUE;
\r
2565 mtCOVERAGE_TEST_MARKER();
\r
2568 taskEXIT_CRITICAL();
\r
2570 /* Place the unblocked task into the appropriate ready list. */
\r
2571 prvAddTaskToReadyList( pxTCB );
\r
2573 /* A task being unblocked cannot cause an immediate context
\r
2574 switch if preemption is turned off. */
\r
2575 #if ( configUSE_PREEMPTION == 1 )
\r
2577 /* Preemption is on, but a context switch should only be
\r
2578 performed if the unblocked task has a priority that is
\r
2579 equal to or higher than the currently executing task. */
\r
2580 if( pxTCB->uxPriority > pxCurrentTCB->uxPriority )
\r
2582 /* Pend the yield to be performed when the scheduler
\r
2583 is unsuspended. */
\r
2584 xYieldPending = pdTRUE;
\r
2588 mtCOVERAGE_TEST_MARKER();
\r
2591 #endif /* configUSE_PREEMPTION */
\r
2595 mtCOVERAGE_TEST_MARKER();
\r
2598 ( void ) xTaskResumeAll();
\r
2603 #endif /* INCLUDE_xTaskAbortDelay */
\r
2604 /*----------------------------------------------------------*/
\r
2606 BaseType_t xTaskIncrementTick( void )
\r
2609 TickType_t xItemValue;
\r
2610 BaseType_t xSwitchRequired = pdFALSE;
\r
2612 /* Called by the portable layer each time a tick interrupt occurs.
\r
2613 Increments the tick then checks to see if the new tick value will cause any
\r
2614 tasks to be unblocked. */
\r
2615 traceTASK_INCREMENT_TICK( xTickCount );
\r
2616 if( uxSchedulerSuspended == ( UBaseType_t ) pdFALSE )
\r
2618 /* Minor optimisation. The tick count cannot change in this
\r
2620 const TickType_t xConstTickCount = xTickCount + ( TickType_t ) 1;
\r
2622 /* Increment the RTOS tick, switching the delayed and overflowed
\r
2623 delayed lists if it wraps to 0. */
\r
2624 xTickCount = xConstTickCount;
\r
2626 if( xConstTickCount == ( TickType_t ) 0U ) /*lint !e774 'if' does not always evaluate to false as it is looking for an overflow. */
\r
2628 taskSWITCH_DELAYED_LISTS();
\r
2632 mtCOVERAGE_TEST_MARKER();
\r
2635 /* See if this tick has made a timeout expire. Tasks are stored in
\r
2636 the queue in the order of their wake time - meaning once one task
\r
2637 has been found whose block time has not expired there is no need to
\r
2638 look any further down the list. */
\r
2639 if( xConstTickCount >= xNextTaskUnblockTime )
\r
2643 if( listLIST_IS_EMPTY( pxDelayedTaskList ) != pdFALSE )
\r
2645 /* The delayed list is empty. Set xNextTaskUnblockTime
\r
2646 to the maximum possible value so it is extremely
\r
2648 if( xTickCount >= xNextTaskUnblockTime ) test will pass
\r
2649 next time through. */
\r
2650 xNextTaskUnblockTime = portMAX_DELAY; /*lint !e961 MISRA exception as the casts are only redundant for some ports. */
\r
2655 /* The delayed list is not empty, get the value of the
\r
2656 item at the head of the delayed list. This is the time
\r
2657 at which the task at the head of the delayed list must
\r
2658 be removed from the Blocked state. */
\r
2659 pxTCB = ( TCB_t * ) listGET_OWNER_OF_HEAD_ENTRY( pxDelayedTaskList );
\r
2660 xItemValue = listGET_LIST_ITEM_VALUE( &( pxTCB->xStateListItem ) );
\r
2662 if( xConstTickCount < xItemValue )
\r
2664 /* It is not time to unblock this item yet, but the
\r
2665 item value is the time at which the task at the head
\r
2666 of the blocked list must be removed from the Blocked
\r
2667 state - so record the item value in
\r
2668 xNextTaskUnblockTime. */
\r
2669 xNextTaskUnblockTime = xItemValue;
\r
2674 mtCOVERAGE_TEST_MARKER();
\r
2677 /* It is time to remove the item from the Blocked state. */
\r
2678 ( void ) uxListRemove( &( pxTCB->xStateListItem ) );
\r
2680 /* Is the task waiting on an event also? If so remove
\r
2681 it from the event list. */
\r
2682 if( listLIST_ITEM_CONTAINER( &( pxTCB->xEventListItem ) ) != NULL )
\r
2684 ( void ) uxListRemove( &( pxTCB->xEventListItem ) );
\r
2688 mtCOVERAGE_TEST_MARKER();
\r
2691 /* Place the unblocked task into the appropriate ready
\r
2693 prvAddTaskToReadyList( pxTCB );
\r
2695 /* A task being unblocked cannot cause an immediate
\r
2696 context switch if preemption is turned off. */
\r
2697 #if ( configUSE_PREEMPTION == 1 )
\r
2699 /* Preemption is on, but a context switch should
\r
2700 only be performed if the unblocked task has a
\r
2701 priority that is equal to or higher than the
\r
2702 currently executing task. */
\r
2703 if( pxTCB->uxPriority >= pxCurrentTCB->uxPriority )
\r
2705 xSwitchRequired = pdTRUE;
\r
2709 mtCOVERAGE_TEST_MARKER();
\r
2712 #endif /* configUSE_PREEMPTION */
\r
2717 /* Tasks of equal priority to the currently running task will share
\r
2718 processing time (time slice) if preemption is on, and the application
\r
2719 writer has not explicitly turned time slicing off. */
\r
2720 #if ( ( configUSE_PREEMPTION == 1 ) && ( configUSE_TIME_SLICING == 1 ) )
\r
2722 if( listCURRENT_LIST_LENGTH( &( pxReadyTasksLists[ pxCurrentTCB->uxPriority ] ) ) > ( UBaseType_t ) 1 )
\r
2724 xSwitchRequired = pdTRUE;
\r
2728 mtCOVERAGE_TEST_MARKER();
\r
2731 #endif /* ( ( configUSE_PREEMPTION == 1 ) && ( configUSE_TIME_SLICING == 1 ) ) */
\r
2733 #if ( configUSE_TICK_HOOK == 1 )
\r
2735 /* Guard against the tick hook being called when the pended tick
\r
2736 count is being unwound (when the scheduler is being unlocked). */
\r
2737 if( uxPendedTicks == ( UBaseType_t ) 0U )
\r
2739 vApplicationTickHook();
\r
2743 mtCOVERAGE_TEST_MARKER();
\r
2746 #endif /* configUSE_TICK_HOOK */
\r
2752 /* The tick hook gets called at regular intervals, even if the
\r
2753 scheduler is locked. */
\r
2754 #if ( configUSE_TICK_HOOK == 1 )
\r
2756 vApplicationTickHook();
\r
2761 #if ( configUSE_PREEMPTION == 1 )
\r
2763 if( xYieldPending != pdFALSE )
\r
2765 xSwitchRequired = pdTRUE;
\r
2769 mtCOVERAGE_TEST_MARKER();
\r
2772 #endif /* configUSE_PREEMPTION */
\r
2774 return xSwitchRequired;
\r
2776 /*-----------------------------------------------------------*/
\r
2778 #if ( configUSE_APPLICATION_TASK_TAG == 1 )
\r
2780 void vTaskSetApplicationTaskTag( TaskHandle_t xTask, TaskHookFunction_t pxHookFunction )
\r
2784 /* If xTask is NULL then it is the task hook of the calling task that is
\r
2786 if( xTask == NULL )
\r
2788 xTCB = ( TCB_t * ) pxCurrentTCB;
\r
2792 xTCB = ( TCB_t * ) xTask;
\r
2795 /* Save the hook function in the TCB. A critical section is required as
\r
2796 the value can be accessed from an interrupt. */
\r
2797 taskENTER_CRITICAL();
\r
2798 xTCB->pxTaskTag = pxHookFunction;
\r
2799 taskEXIT_CRITICAL();
\r
2802 #endif /* configUSE_APPLICATION_TASK_TAG */
\r
2803 /*-----------------------------------------------------------*/
\r
2805 #if ( configUSE_APPLICATION_TASK_TAG == 1 )
\r
2807 TaskHookFunction_t xTaskGetApplicationTaskTag( TaskHandle_t xTask )
\r
2810 TaskHookFunction_t xReturn;
\r
2812 /* If xTask is NULL then we are setting our own task hook. */
\r
2813 if( xTask == NULL )
\r
2815 xTCB = ( TCB_t * ) pxCurrentTCB;
\r
2819 xTCB = ( TCB_t * ) xTask;
\r
2822 /* Save the hook function in the TCB. A critical section is required as
\r
2823 the value can be accessed from an interrupt. */
\r
2824 taskENTER_CRITICAL();
\r
2826 xReturn = xTCB->pxTaskTag;
\r
2828 taskEXIT_CRITICAL();
\r
2833 #endif /* configUSE_APPLICATION_TASK_TAG */
\r
2834 /*-----------------------------------------------------------*/
\r
2836 #if ( configUSE_APPLICATION_TASK_TAG == 1 )
\r
2838 BaseType_t xTaskCallApplicationTaskHook( TaskHandle_t xTask, void *pvParameter )
\r
2841 BaseType_t xReturn;
\r
2843 /* If xTask is NULL then we are calling our own task hook. */
\r
2844 if( xTask == NULL )
\r
2846 xTCB = ( TCB_t * ) pxCurrentTCB;
\r
2850 xTCB = ( TCB_t * ) xTask;
\r
2853 if( xTCB->pxTaskTag != NULL )
\r
2855 xReturn = xTCB->pxTaskTag( pvParameter );
\r
2865 #endif /* configUSE_APPLICATION_TASK_TAG */
\r
2866 /*-----------------------------------------------------------*/
\r
2868 void vTaskSwitchContext( void )
\r
2870 if( uxSchedulerSuspended != ( UBaseType_t ) pdFALSE )
\r
2872 /* The scheduler is currently suspended - do not allow a context
\r
2874 xYieldPending = pdTRUE;
\r
2878 xYieldPending = pdFALSE;
\r
2879 traceTASK_SWITCHED_OUT();
\r
2881 #if ( configGENERATE_RUN_TIME_STATS == 1 )
\r
2883 #ifdef portALT_GET_RUN_TIME_COUNTER_VALUE
\r
2884 portALT_GET_RUN_TIME_COUNTER_VALUE( ulTotalRunTime );
\r
2886 ulTotalRunTime = portGET_RUN_TIME_COUNTER_VALUE();
\r
2889 /* Add the amount of time the task has been running to the
\r
2890 accumulated time so far. The time the task started running was
\r
2891 stored in ulTaskSwitchedInTime. Note that there is no overflow
\r
2892 protection here so count values are only valid until the timer
\r
2893 overflows. The guard against negative values is to protect
\r
2894 against suspect run time stat counter implementations - which
\r
2895 are provided by the application, not the kernel. */
\r
2896 if( ulTotalRunTime > ulTaskSwitchedInTime )
\r
2898 pxCurrentTCB->ulRunTimeCounter += ( ulTotalRunTime - ulTaskSwitchedInTime );
\r
2902 mtCOVERAGE_TEST_MARKER();
\r
2904 ulTaskSwitchedInTime = ulTotalRunTime;
\r
2906 #endif /* configGENERATE_RUN_TIME_STATS */
\r
2908 /* Check for stack overflow, if configured. */
\r
2909 taskCHECK_FOR_STACK_OVERFLOW();
\r
2911 /* Select a new task to run using either the generic C or port
\r
2912 optimised asm code. */
\r
2913 taskSELECT_HIGHEST_PRIORITY_TASK();
\r
2914 traceTASK_SWITCHED_IN();
\r
2916 #if ( configUSE_NEWLIB_REENTRANT == 1 )
\r
2918 /* Switch Newlib's _impure_ptr variable to point to the _reent
\r
2919 structure specific to this task. */
\r
2920 _impure_ptr = &( pxCurrentTCB->xNewLib_reent );
\r
2922 #endif /* configUSE_NEWLIB_REENTRANT */
\r
2925 /*-----------------------------------------------------------*/
\r
2927 void vTaskPlaceOnEventList( List_t * const pxEventList, const TickType_t xTicksToWait )
\r
2929 configASSERT( pxEventList );
\r
2931 /* THIS FUNCTION MUST BE CALLED WITH EITHER INTERRUPTS DISABLED OR THE
\r
2932 SCHEDULER SUSPENDED AND THE QUEUE BEING ACCESSED LOCKED. */
\r
2934 /* Place the event list item of the TCB in the appropriate event list.
\r
2935 This is placed in the list in priority order so the highest priority task
\r
2936 is the first to be woken by the event. The queue that contains the event
\r
2937 list is locked, preventing simultaneous access from interrupts. */
\r
2938 vListInsert( pxEventList, &( pxCurrentTCB->xEventListItem ) );
\r
2940 prvAddCurrentTaskToDelayedList( xTicksToWait, pdTRUE );
\r
2942 /*-----------------------------------------------------------*/
\r
2944 void vTaskPlaceOnUnorderedEventList( List_t * pxEventList, const TickType_t xItemValue, const TickType_t xTicksToWait )
\r
2946 configASSERT( pxEventList );
\r
2948 /* THIS FUNCTION MUST BE CALLED WITH THE SCHEDULER SUSPENDED. It is used by
\r
2949 the event groups implementation. */
\r
2950 configASSERT( uxSchedulerSuspended != 0 );
\r
2952 /* Store the item value in the event list item. It is safe to access the
\r
2953 event list item here as interrupts won't access the event list item of a
\r
2954 task that is not in the Blocked state. */
\r
2955 listSET_LIST_ITEM_VALUE( &( pxCurrentTCB->xEventListItem ), xItemValue | taskEVENT_LIST_ITEM_VALUE_IN_USE );
\r
2957 /* Place the event list item of the TCB at the end of the appropriate event
\r
2958 list. It is safe to access the event list here because it is part of an
\r
2959 event group implementation - and interrupts don't access event groups
\r
2960 directly (instead they access them indirectly by pending function calls to
\r
2961 the task level). */
\r
2962 vListInsertEnd( pxEventList, &( pxCurrentTCB->xEventListItem ) );
\r
2964 prvAddCurrentTaskToDelayedList( xTicksToWait, pdTRUE );
\r
2966 /*-----------------------------------------------------------*/
\r
2968 #if( configUSE_TIMERS == 1 )
\r
2970 void vTaskPlaceOnEventListRestricted( List_t * const pxEventList, TickType_t xTicksToWait, const BaseType_t xWaitIndefinitely )
\r
2972 configASSERT( pxEventList );
\r
2974 /* This function should not be called by application code hence the
\r
2975 'Restricted' in its name. It is not part of the public API. It is
\r
2976 designed for use by kernel code, and has special calling requirements -
\r
2977 it should be called with the scheduler suspended. */
\r
2980 /* Place the event list item of the TCB in the appropriate event list.
\r
2981 In this case it is assume that this is the only task that is going to
\r
2982 be waiting on this event list, so the faster vListInsertEnd() function
\r
2983 can be used in place of vListInsert. */
\r
2984 vListInsertEnd( pxEventList, &( pxCurrentTCB->xEventListItem ) );
\r
2986 /* If the task should block indefinitely then set the block time to a
\r
2987 value that will be recognised as an indefinite delay inside the
\r
2988 prvAddCurrentTaskToDelayedList() function. */
\r
2989 if( xWaitIndefinitely != pdFALSE )
\r
2991 xTicksToWait = portMAX_DELAY;
\r
2994 traceTASK_DELAY_UNTIL( ( xTickCount + xTicksToWait ) );
\r
2995 prvAddCurrentTaskToDelayedList( xTicksToWait, xWaitIndefinitely );
\r
2998 #endif /* configUSE_TIMERS */
\r
2999 /*-----------------------------------------------------------*/
\r
3001 BaseType_t xTaskRemoveFromEventList( const List_t * const pxEventList )
\r
3003 TCB_t *pxUnblockedTCB;
\r
3004 BaseType_t xReturn;
\r
3006 /* THIS FUNCTION MUST BE CALLED FROM A CRITICAL SECTION. It can also be
\r
3007 called from a critical section within an ISR. */
\r
3009 /* The event list is sorted in priority order, so the first in the list can
\r
3010 be removed as it is known to be the highest priority. Remove the TCB from
\r
3011 the delayed list, and add it to the ready list.
\r
3013 If an event is for a queue that is locked then this function will never
\r
3014 get called - the lock count on the queue will get modified instead. This
\r
3015 means exclusive access to the event list is guaranteed here.
\r
3017 This function assumes that a check has already been made to ensure that
\r
3018 pxEventList is not empty. */
\r
3019 pxUnblockedTCB = ( TCB_t * ) listGET_OWNER_OF_HEAD_ENTRY( pxEventList );
\r
3020 configASSERT( pxUnblockedTCB );
\r
3021 ( void ) uxListRemove( &( pxUnblockedTCB->xEventListItem ) );
\r
3023 if( uxSchedulerSuspended == ( UBaseType_t ) pdFALSE )
\r
3025 ( void ) uxListRemove( &( pxUnblockedTCB->xStateListItem ) );
\r
3026 prvAddTaskToReadyList( pxUnblockedTCB );
\r
3030 /* The delayed and ready lists cannot be accessed, so hold this task
\r
3031 pending until the scheduler is resumed. */
\r
3032 vListInsertEnd( &( xPendingReadyList ), &( pxUnblockedTCB->xEventListItem ) );
\r
3035 if( pxUnblockedTCB->uxPriority > pxCurrentTCB->uxPriority )
\r
3037 /* Return true if the task removed from the event list has a higher
\r
3038 priority than the calling task. This allows the calling task to know if
\r
3039 it should force a context switch now. */
\r
3042 /* Mark that a yield is pending in case the user is not using the
\r
3043 "xHigherPriorityTaskWoken" parameter to an ISR safe FreeRTOS function. */
\r
3044 xYieldPending = pdTRUE;
\r
3048 xReturn = pdFALSE;
\r
3051 #if( configUSE_TICKLESS_IDLE != 0 )
\r
3053 /* If a task is blocked on a kernel object then xNextTaskUnblockTime
\r
3054 might be set to the blocked task's time out time. If the task is
\r
3055 unblocked for a reason other than a timeout xNextTaskUnblockTime is
\r
3056 normally left unchanged, because it is automatically reset to a new
\r
3057 value when the tick count equals xNextTaskUnblockTime. However if
\r
3058 tickless idling is used it might be more important to enter sleep mode
\r
3059 at the earliest possible time - so reset xNextTaskUnblockTime here to
\r
3060 ensure it is updated at the earliest possible time. */
\r
3061 prvResetNextTaskUnblockTime();
\r
3067 /*-----------------------------------------------------------*/
\r
3069 void vTaskRemoveFromUnorderedEventList( ListItem_t * pxEventListItem, const TickType_t xItemValue )
\r
3071 TCB_t *pxUnblockedTCB;
\r
3073 /* THIS FUNCTION MUST BE CALLED WITH THE SCHEDULER SUSPENDED. It is used by
\r
3074 the event flags implementation. */
\r
3075 configASSERT( uxSchedulerSuspended != pdFALSE );
\r
3077 /* Store the new item value in the event list. */
\r
3078 listSET_LIST_ITEM_VALUE( pxEventListItem, xItemValue | taskEVENT_LIST_ITEM_VALUE_IN_USE );
\r
3080 /* Remove the event list form the event flag. Interrupts do not access
\r
3082 pxUnblockedTCB = ( TCB_t * ) listGET_LIST_ITEM_OWNER( pxEventListItem );
\r
3083 configASSERT( pxUnblockedTCB );
\r
3084 ( void ) uxListRemove( pxEventListItem );
\r
3086 /* Remove the task from the delayed list and add it to the ready list. The
\r
3087 scheduler is suspended so interrupts will not be accessing the ready
\r
3089 ( void ) uxListRemove( &( pxUnblockedTCB->xStateListItem ) );
\r
3090 prvAddTaskToReadyList( pxUnblockedTCB );
\r
3092 if( pxUnblockedTCB->uxPriority > pxCurrentTCB->uxPriority )
\r
3094 /* The unblocked task has a priority above that of the calling task, so
\r
3095 a context switch is required. This function is called with the
\r
3096 scheduler suspended so xYieldPending is set so the context switch
\r
3097 occurs immediately that the scheduler is resumed (unsuspended). */
\r
3098 xYieldPending = pdTRUE;
\r
3101 /*-----------------------------------------------------------*/
\r
3103 void vTaskSetTimeOutState( TimeOut_t * const pxTimeOut )
\r
3105 configASSERT( pxTimeOut );
\r
3106 pxTimeOut->xOverflowCount = xNumOfOverflows;
\r
3107 pxTimeOut->xTimeOnEntering = xTickCount;
\r
3109 /*-----------------------------------------------------------*/
\r
3111 BaseType_t xTaskCheckForTimeOut( TimeOut_t * const pxTimeOut, TickType_t * const pxTicksToWait )
\r
3113 BaseType_t xReturn;
\r
3115 configASSERT( pxTimeOut );
\r
3116 configASSERT( pxTicksToWait );
\r
3118 taskENTER_CRITICAL();
\r
3120 /* Minor optimisation. The tick count cannot change in this block. */
\r
3121 const TickType_t xConstTickCount = xTickCount;
\r
3123 #if( INCLUDE_xTaskAbortDelay == 1 )
\r
3124 if( pxCurrentTCB->ucDelayAborted != pdFALSE )
\r
3126 /* The delay was aborted, which is not the same as a time out,
\r
3127 but has the same result. */
\r
3128 pxCurrentTCB->ucDelayAborted = pdFALSE;
\r
3134 #if ( INCLUDE_vTaskSuspend == 1 )
\r
3135 if( *pxTicksToWait == portMAX_DELAY )
\r
3137 /* If INCLUDE_vTaskSuspend is set to 1 and the block time
\r
3138 specified is the maximum block time then the task should block
\r
3139 indefinitely, and therefore never time out. */
\r
3140 xReturn = pdFALSE;
\r
3145 if( ( xNumOfOverflows != pxTimeOut->xOverflowCount ) && ( xConstTickCount >= pxTimeOut->xTimeOnEntering ) ) /*lint !e525 Indentation preferred as is to make code within pre-processor directives clearer. */
\r
3147 /* The tick count is greater than the time at which
\r
3148 vTaskSetTimeout() was called, but has also overflowed since
\r
3149 vTaskSetTimeOut() was called. It must have wrapped all the way
\r
3150 around and gone past again. This passed since vTaskSetTimeout()
\r
3154 else if( ( ( TickType_t ) ( xConstTickCount - pxTimeOut->xTimeOnEntering ) ) < *pxTicksToWait ) /*lint !e961 Explicit casting is only redundant with some compilers, whereas others require it to prevent integer conversion errors. */
\r
3156 /* Not a genuine timeout. Adjust parameters for time remaining. */
\r
3157 *pxTicksToWait -= ( xConstTickCount - pxTimeOut->xTimeOnEntering );
\r
3158 vTaskSetTimeOutState( pxTimeOut );
\r
3159 xReturn = pdFALSE;
\r
3166 taskEXIT_CRITICAL();
\r
3170 /*-----------------------------------------------------------*/
\r
3172 void vTaskMissedYield( void )
\r
3174 xYieldPending = pdTRUE;
\r
3176 /*-----------------------------------------------------------*/
\r
3178 #if ( configUSE_TRACE_FACILITY == 1 )
\r
3180 UBaseType_t uxTaskGetTaskNumber( TaskHandle_t xTask )
\r
3182 UBaseType_t uxReturn;
\r
3185 if( xTask != NULL )
\r
3187 pxTCB = ( TCB_t * ) xTask;
\r
3188 uxReturn = pxTCB->uxTaskNumber;
\r
3198 #endif /* configUSE_TRACE_FACILITY */
\r
3199 /*-----------------------------------------------------------*/
\r
3201 #if ( configUSE_TRACE_FACILITY == 1 )
\r
3203 void vTaskSetTaskNumber( TaskHandle_t xTask, const UBaseType_t uxHandle )
\r
3207 if( xTask != NULL )
\r
3209 pxTCB = ( TCB_t * ) xTask;
\r
3210 pxTCB->uxTaskNumber = uxHandle;
\r
3214 #endif /* configUSE_TRACE_FACILITY */
\r
3217 * -----------------------------------------------------------
\r
3219 * ----------------------------------------------------------
\r
3221 * The portTASK_FUNCTION() macro is used to allow port/compiler specific
\r
3222 * language extensions. The equivalent prototype for this function is:
\r
3224 * void prvIdleTask( void *pvParameters );
\r
3227 static portTASK_FUNCTION( prvIdleTask, pvParameters )
\r
3229 /* Stop warnings. */
\r
3230 ( void ) pvParameters;
\r
3232 /** THIS IS THE RTOS IDLE TASK - WHICH IS CREATED AUTOMATICALLY WHEN THE
\r
3233 SCHEDULER IS STARTED. **/
\r
3237 /* See if any tasks have deleted themselves - if so then the idle task
\r
3238 is responsible for freeing the deleted task's TCB and stack. */
\r
3239 prvCheckTasksWaitingTermination();
\r
3241 #if ( configUSE_PREEMPTION == 0 )
\r
3243 /* If we are not using preemption we keep forcing a task switch to
\r
3244 see if any other task has become available. If we are using
\r
3245 preemption we don't need to do this as any task becoming available
\r
3246 will automatically get the processor anyway. */
\r
3249 #endif /* configUSE_PREEMPTION */
\r
3251 #if ( ( configUSE_PREEMPTION == 1 ) && ( configIDLE_SHOULD_YIELD == 1 ) )
\r
3253 /* When using preemption tasks of equal priority will be
\r
3254 timesliced. If a task that is sharing the idle priority is ready
\r
3255 to run then the idle task should yield before the end of the
\r
3258 A critical region is not required here as we are just reading from
\r
3259 the list, and an occasional incorrect value will not matter. If
\r
3260 the ready list at the idle priority contains more than one task
\r
3261 then a task other than the idle task is ready to execute. */
\r
3262 if( listCURRENT_LIST_LENGTH( &( pxReadyTasksLists[ tskIDLE_PRIORITY ] ) ) > ( UBaseType_t ) 1 )
\r
3268 mtCOVERAGE_TEST_MARKER();
\r
3271 #endif /* ( ( configUSE_PREEMPTION == 1 ) && ( configIDLE_SHOULD_YIELD == 1 ) ) */
\r
3273 #if ( configUSE_IDLE_HOOK == 1 )
\r
3275 extern void vApplicationIdleHook( void );
\r
3277 /* Call the user defined function from within the idle task. This
\r
3278 allows the application designer to add background functionality
\r
3279 without the overhead of a separate task.
\r
3280 NOTE: vApplicationIdleHook() MUST NOT, UNDER ANY CIRCUMSTANCES,
\r
3281 CALL A FUNCTION THAT MIGHT BLOCK. */
\r
3282 vApplicationIdleHook();
\r
3284 #endif /* configUSE_IDLE_HOOK */
\r
3286 /* This conditional compilation should use inequality to 0, not equality
\r
3287 to 1. This is to ensure portSUPPRESS_TICKS_AND_SLEEP() is called when
\r
3288 user defined low power mode implementations require
\r
3289 configUSE_TICKLESS_IDLE to be set to a value other than 1. */
\r
3290 #if ( configUSE_TICKLESS_IDLE != 0 )
\r
3292 TickType_t xExpectedIdleTime;
\r
3294 /* It is not desirable to suspend then resume the scheduler on
\r
3295 each iteration of the idle task. Therefore, a preliminary
\r
3296 test of the expected idle time is performed without the
\r
3297 scheduler suspended. The result here is not necessarily
\r
3299 xExpectedIdleTime = prvGetExpectedIdleTime();
\r
3301 if( xExpectedIdleTime >= configEXPECTED_IDLE_TIME_BEFORE_SLEEP )
\r
3303 vTaskSuspendAll();
\r
3305 /* Now the scheduler is suspended, the expected idle
\r
3306 time can be sampled again, and this time its value can
\r
3308 configASSERT( xNextTaskUnblockTime >= xTickCount );
\r
3309 xExpectedIdleTime = prvGetExpectedIdleTime();
\r
3311 if( xExpectedIdleTime >= configEXPECTED_IDLE_TIME_BEFORE_SLEEP )
\r
3313 traceLOW_POWER_IDLE_BEGIN();
\r
3314 portSUPPRESS_TICKS_AND_SLEEP( xExpectedIdleTime );
\r
3315 traceLOW_POWER_IDLE_END();
\r
3319 mtCOVERAGE_TEST_MARKER();
\r
3322 ( void ) xTaskResumeAll();
\r
3326 mtCOVERAGE_TEST_MARKER();
\r
3329 #endif /* configUSE_TICKLESS_IDLE */
\r
3332 /*-----------------------------------------------------------*/
\r
3334 #if( configUSE_TICKLESS_IDLE != 0 )
\r
3336 eSleepModeStatus eTaskConfirmSleepModeStatus( void )
\r
3338 /* The idle task exists in addition to the application tasks. */
\r
3339 const UBaseType_t uxNonApplicationTasks = 1;
\r
3340 eSleepModeStatus eReturn = eStandardSleep;
\r
3342 if( listCURRENT_LIST_LENGTH( &xPendingReadyList ) != 0 )
\r
3344 /* A task was made ready while the scheduler was suspended. */
\r
3345 eReturn = eAbortSleep;
\r
3347 else if( xYieldPending != pdFALSE )
\r
3349 /* A yield was pended while the scheduler was suspended. */
\r
3350 eReturn = eAbortSleep;
\r
3354 /* If all the tasks are in the suspended list (which might mean they
\r
3355 have an infinite block time rather than actually being suspended)
\r
3356 then it is safe to turn all clocks off and just wait for external
\r
3358 if( listCURRENT_LIST_LENGTH( &xSuspendedTaskList ) == ( uxCurrentNumberOfTasks - uxNonApplicationTasks ) )
\r
3360 eReturn = eNoTasksWaitingTimeout;
\r
3364 mtCOVERAGE_TEST_MARKER();
\r
3371 #endif /* configUSE_TICKLESS_IDLE */
\r
3372 /*-----------------------------------------------------------*/
\r
3374 #if ( configNUM_THREAD_LOCAL_STORAGE_POINTERS != 0 )
\r
3376 void vTaskSetThreadLocalStoragePointer( TaskHandle_t xTaskToSet, BaseType_t xIndex, void *pvValue )
\r
3380 if( xIndex < configNUM_THREAD_LOCAL_STORAGE_POINTERS )
\r
3382 pxTCB = prvGetTCBFromHandle( xTaskToSet );
\r
3383 pxTCB->pvThreadLocalStoragePointers[ xIndex ] = pvValue;
\r
3387 #endif /* configNUM_THREAD_LOCAL_STORAGE_POINTERS */
\r
3388 /*-----------------------------------------------------------*/
\r
3390 #if ( configNUM_THREAD_LOCAL_STORAGE_POINTERS != 0 )
\r
3392 void *pvTaskGetThreadLocalStoragePointer( TaskHandle_t xTaskToQuery, BaseType_t xIndex )
\r
3394 void *pvReturn = NULL;
\r
3397 if( xIndex < configNUM_THREAD_LOCAL_STORAGE_POINTERS )
\r
3399 pxTCB = prvGetTCBFromHandle( xTaskToQuery );
\r
3400 pvReturn = pxTCB->pvThreadLocalStoragePointers[ xIndex ];
\r
3410 #endif /* configNUM_THREAD_LOCAL_STORAGE_POINTERS */
\r
3411 /*-----------------------------------------------------------*/
\r
3413 #if ( portUSING_MPU_WRAPPERS == 1 )
\r
3415 void vTaskAllocateMPURegions( TaskHandle_t xTaskToModify, const MemoryRegion_t * const xRegions )
\r
3419 /* If null is passed in here then we are modifying the MPU settings of
\r
3420 the calling task. */
\r
3421 pxTCB = prvGetTCBFromHandle( xTaskToModify );
\r
3423 vPortStoreTaskMPUSettings( &( pxTCB->xMPUSettings ), xRegions, NULL, 0 );
\r
3426 #endif /* portUSING_MPU_WRAPPERS */
\r
3427 /*-----------------------------------------------------------*/
\r
3429 static void prvInitialiseTaskLists( void )
\r
3431 UBaseType_t uxPriority;
\r
3433 for( uxPriority = ( UBaseType_t ) 0U; uxPriority < ( UBaseType_t ) configMAX_PRIORITIES; uxPriority++ )
\r
3435 vListInitialise( &( pxReadyTasksLists[ uxPriority ] ) );
\r
3438 vListInitialise( &xDelayedTaskList1 );
\r
3439 vListInitialise( &xDelayedTaskList2 );
\r
3440 vListInitialise( &xPendingReadyList );
\r
3442 #if ( INCLUDE_vTaskDelete == 1 )
\r
3444 vListInitialise( &xTasksWaitingTermination );
\r
3446 #endif /* INCLUDE_vTaskDelete */
\r
3448 #if ( INCLUDE_vTaskSuspend == 1 )
\r
3450 vListInitialise( &xSuspendedTaskList );
\r
3452 #endif /* INCLUDE_vTaskSuspend */
\r
3454 /* Start with pxDelayedTaskList using list1 and the pxOverflowDelayedTaskList
\r
3456 pxDelayedTaskList = &xDelayedTaskList1;
\r
3457 pxOverflowDelayedTaskList = &xDelayedTaskList2;
\r
3459 /*-----------------------------------------------------------*/
\r
3461 static void prvCheckTasksWaitingTermination( void )
\r
3464 /** THIS FUNCTION IS CALLED FROM THE RTOS IDLE TASK **/
\r
3466 #if ( INCLUDE_vTaskDelete == 1 )
\r
3468 BaseType_t xListIsEmpty;
\r
3470 /* ucTasksDeleted is used to prevent vTaskSuspendAll() being called
\r
3471 too often in the idle task. */
\r
3472 while( uxDeletedTasksWaitingCleanUp > ( UBaseType_t ) 0U )
\r
3474 vTaskSuspendAll();
\r
3476 xListIsEmpty = listLIST_IS_EMPTY( &xTasksWaitingTermination );
\r
3478 ( void ) xTaskResumeAll();
\r
3480 if( xListIsEmpty == pdFALSE )
\r
3484 taskENTER_CRITICAL();
\r
3486 pxTCB = ( TCB_t * ) listGET_OWNER_OF_HEAD_ENTRY( ( &xTasksWaitingTermination ) );
\r
3487 ( void ) uxListRemove( &( pxTCB->xStateListItem ) );
\r
3488 --uxCurrentNumberOfTasks;
\r
3489 --uxDeletedTasksWaitingCleanUp;
\r
3491 taskEXIT_CRITICAL();
\r
3493 prvDeleteTCB( pxTCB );
\r
3497 mtCOVERAGE_TEST_MARKER();
\r
3501 #endif /* INCLUDE_vTaskDelete */
\r
3503 /*-----------------------------------------------------------*/
\r
3505 #if( configUSE_TRACE_FACILITY == 1 )
\r
3507 void vTaskGetInfo( TaskHandle_t xTask, TaskStatus_t *pxTaskStatus, BaseType_t xGetFreeStackSpace, eTaskState eState )
\r
3511 /* xTask is NULL then get the state of the calling task. */
\r
3512 pxTCB = prvGetTCBFromHandle( xTask );
\r
3514 pxTaskStatus->xHandle = ( TaskHandle_t ) pxTCB;
\r
3515 pxTaskStatus->pcTaskName = ( const char * ) &( pxTCB->pcTaskName [ 0 ] );
\r
3516 pxTaskStatus->uxCurrentPriority = pxTCB->uxPriority;
\r
3517 pxTaskStatus->pxStackBase = pxTCB->pxStack;
\r
3518 pxTaskStatus->xTaskNumber = pxTCB->uxTCBNumber;
\r
3520 #if ( INCLUDE_vTaskSuspend == 1 )
\r
3522 /* If the task is in the suspended list then there is a chance it is
\r
3523 actually just blocked indefinitely - so really it should be reported as
\r
3524 being in the Blocked state. */
\r
3525 if( pxTaskStatus->eCurrentState == eSuspended )
\r
3527 vTaskSuspendAll();
\r
3529 if( listLIST_ITEM_CONTAINER( &( pxTCB->xEventListItem ) ) != NULL )
\r
3531 pxTaskStatus->eCurrentState = eBlocked;
\r
3534 ( void ) xTaskResumeAll();
\r
3537 #endif /* INCLUDE_vTaskSuspend */
\r
3539 #if ( configUSE_MUTEXES == 1 )
\r
3541 pxTaskStatus->uxBasePriority = pxTCB->uxBasePriority;
\r
3545 pxTaskStatus->uxBasePriority = 0;
\r
3549 #if ( configGENERATE_RUN_TIME_STATS == 1 )
\r
3551 pxTaskStatus->ulRunTimeCounter = pxTCB->ulRunTimeCounter;
\r
3555 pxTaskStatus->ulRunTimeCounter = 0;
\r
3559 /* Obtaining the task state is a little fiddly, so is only done if the value
\r
3560 of eState passed into this function is eInvalid - otherwise the state is
\r
3561 just set to whatever is passed in. */
\r
3562 if( eState != eInvalid )
\r
3564 pxTaskStatus->eCurrentState = eState;
\r
3568 pxTaskStatus->eCurrentState = eTaskGetState( xTask );
\r
3571 /* Obtaining the stack space takes some time, so the xGetFreeStackSpace
\r
3572 parameter is provided to allow it to be skipped. */
\r
3573 if( xGetFreeStackSpace != pdFALSE )
\r
3575 #if ( portSTACK_GROWTH > 0 )
\r
3577 pxTaskStatus->usStackHighWaterMark = prvTaskCheckFreeStackSpace( ( uint8_t * ) pxTCB->pxEndOfStack );
\r
3581 pxTaskStatus->usStackHighWaterMark = prvTaskCheckFreeStackSpace( ( uint8_t * ) pxTCB->pxStack );
\r
3587 pxTaskStatus->usStackHighWaterMark = 0;
\r
3591 #endif /* configUSE_TRACE_FACILITY */
\r
3592 /*-----------------------------------------------------------*/
\r
3594 #if ( configUSE_TRACE_FACILITY == 1 )
\r
3596 static UBaseType_t prvListTasksWithinSingleList( TaskStatus_t *pxTaskStatusArray, List_t *pxList, eTaskState eState )
\r
3598 configLIST_VOLATILE TCB_t *pxNextTCB, *pxFirstTCB;
\r
3599 UBaseType_t uxTask = 0;
\r
3601 if( listCURRENT_LIST_LENGTH( pxList ) > ( UBaseType_t ) 0 )
\r
3603 listGET_OWNER_OF_NEXT_ENTRY( pxFirstTCB, pxList );
\r
3605 /* Populate an TaskStatus_t structure within the
\r
3606 pxTaskStatusArray array for each task that is referenced from
\r
3607 pxList. See the definition of TaskStatus_t in task.h for the
\r
3608 meaning of each TaskStatus_t structure member. */
\r
3611 listGET_OWNER_OF_NEXT_ENTRY( pxNextTCB, pxList );
\r
3612 vTaskGetInfo( ( TaskHandle_t ) pxNextTCB, &( pxTaskStatusArray[ uxTask ] ), pdTRUE, eState );
\r
3614 } while( pxNextTCB != pxFirstTCB );
\r
3618 mtCOVERAGE_TEST_MARKER();
\r
3624 #endif /* configUSE_TRACE_FACILITY */
\r
3625 /*-----------------------------------------------------------*/
\r
3627 #if ( ( configUSE_TRACE_FACILITY == 1 ) || ( INCLUDE_uxTaskGetStackHighWaterMark == 1 ) )
\r
3629 static uint16_t prvTaskCheckFreeStackSpace( const uint8_t * pucStackByte )
\r
3631 uint32_t ulCount = 0U;
\r
3633 while( *pucStackByte == ( uint8_t ) tskSTACK_FILL_BYTE )
\r
3635 pucStackByte -= portSTACK_GROWTH;
\r
3639 ulCount /= ( uint32_t ) sizeof( StackType_t ); /*lint !e961 Casting is not redundant on smaller architectures. */
\r
3641 return ( uint16_t ) ulCount;
\r
3644 #endif /* ( ( configUSE_TRACE_FACILITY == 1 ) || ( INCLUDE_uxTaskGetStackHighWaterMark == 1 ) ) */
\r
3645 /*-----------------------------------------------------------*/
\r
3647 #if ( INCLUDE_uxTaskGetStackHighWaterMark == 1 )
\r
3649 UBaseType_t uxTaskGetStackHighWaterMark( TaskHandle_t xTask )
\r
3652 uint8_t *pucEndOfStack;
\r
3653 UBaseType_t uxReturn;
\r
3655 pxTCB = prvGetTCBFromHandle( xTask );
\r
3657 #if portSTACK_GROWTH < 0
\r
3659 pucEndOfStack = ( uint8_t * ) pxTCB->pxStack;
\r
3663 pucEndOfStack = ( uint8_t * ) pxTCB->pxEndOfStack;
\r
3667 uxReturn = ( UBaseType_t ) prvTaskCheckFreeStackSpace( pucEndOfStack );
\r
3672 #endif /* INCLUDE_uxTaskGetStackHighWaterMark */
\r
3673 /*-----------------------------------------------------------*/
\r
3675 #if ( INCLUDE_vTaskDelete == 1 )
\r
3677 static void prvDeleteTCB( TCB_t *pxTCB )
\r
3679 /* This call is required specifically for the TriCore port. It must be
\r
3680 above the vPortFree() calls. The call is also used by ports/demos that
\r
3681 want to allocate and clean RAM statically. */
\r
3682 portCLEAN_UP_TCB( pxTCB );
\r
3684 /* Free up the memory allocated by the scheduler for the task. It is up
\r
3685 to the task to free any memory allocated at the application level. */
\r
3686 #if ( configUSE_NEWLIB_REENTRANT == 1 )
\r
3688 _reclaim_reent( &( pxTCB->xNewLib_reent ) );
\r
3690 #endif /* configUSE_NEWLIB_REENTRANT */
\r
3692 #if( ( configSUPPORT_DYNAMIC_ALLOCATION == 1 ) && ( configSUPPORT_STATIC_ALLOCATION == 0 ) && ( portUSING_MPU_WRAPPERS == 0 ) )
\r
3694 /* The task can only have been allocated dynamically - free both
\r
3695 the stack and TCB. */
\r
3696 vPortFree( pxTCB->pxStack );
\r
3697 vPortFree( pxTCB );
\r
3699 #elif( tskSTATIC_AND_DYNAMIC_ALLOCATION_POSSIBLE != 0 ) /*lint !e731 Macro has been consolidated for readability reasons. */
\r
3701 /* The task could have been allocated statically or dynamically, so
\r
3702 check what was statically allocated before trying to free the
\r
3704 if( pxTCB->ucStaticallyAllocated == tskDYNAMICALLY_ALLOCATED_STACK_AND_TCB )
\r
3706 /* Both the stack and TCB were allocated dynamically, so both
\r
3708 vPortFree( pxTCB->pxStack );
\r
3709 vPortFree( pxTCB );
\r
3711 else if( pxTCB->ucStaticallyAllocated == tskSTATICALLY_ALLOCATED_STACK_ONLY )
\r
3713 /* Only the stack was statically allocated, so the TCB is the
\r
3714 only memory that must be freed. */
\r
3715 vPortFree( pxTCB );
\r
3719 /* Neither the stack nor the TCB were allocated dynamically, so
\r
3720 nothing needs to be freed. */
\r
3721 configASSERT( pxTCB->ucStaticallyAllocated == tskSTATICALLY_ALLOCATED_STACK_AND_TCB )
\r
3722 mtCOVERAGE_TEST_MARKER();
\r
3725 #endif /* configSUPPORT_DYNAMIC_ALLOCATION */
\r
3728 #endif /* INCLUDE_vTaskDelete */
\r
3729 /*-----------------------------------------------------------*/
\r
3731 static void prvResetNextTaskUnblockTime( void )
\r
3735 if( listLIST_IS_EMPTY( pxDelayedTaskList ) != pdFALSE )
\r
3737 /* The new current delayed list is empty. Set xNextTaskUnblockTime to
\r
3738 the maximum possible value so it is extremely unlikely that the
\r
3739 if( xTickCount >= xNextTaskUnblockTime ) test will pass until
\r
3740 there is an item in the delayed list. */
\r
3741 xNextTaskUnblockTime = portMAX_DELAY;
\r
3745 /* The new current delayed list is not empty, get the value of
\r
3746 the item at the head of the delayed list. This is the time at
\r
3747 which the task at the head of the delayed list should be removed
\r
3748 from the Blocked state. */
\r
3749 ( pxTCB ) = ( TCB_t * ) listGET_OWNER_OF_HEAD_ENTRY( pxDelayedTaskList );
\r
3750 xNextTaskUnblockTime = listGET_LIST_ITEM_VALUE( &( ( pxTCB )->xStateListItem ) );
\r
3753 /*-----------------------------------------------------------*/
\r
3755 #if ( ( INCLUDE_xTaskGetCurrentTaskHandle == 1 ) || ( configUSE_MUTEXES == 1 ) )
\r
3757 TaskHandle_t xTaskGetCurrentTaskHandle( void )
\r
3759 TaskHandle_t xReturn;
\r
3761 /* A critical section is not required as this is not called from
\r
3762 an interrupt and the current TCB will always be the same for any
\r
3763 individual execution thread. */
\r
3764 xReturn = pxCurrentTCB;
\r
3769 #endif /* ( ( INCLUDE_xTaskGetCurrentTaskHandle == 1 ) || ( configUSE_MUTEXES == 1 ) ) */
\r
3770 /*-----------------------------------------------------------*/
\r
3772 #if ( ( INCLUDE_xTaskGetSchedulerState == 1 ) || ( configUSE_TIMERS == 1 ) )
\r
3774 BaseType_t xTaskGetSchedulerState( void )
\r
3776 BaseType_t xReturn;
\r
3778 if( xSchedulerRunning == pdFALSE )
\r
3780 xReturn = taskSCHEDULER_NOT_STARTED;
\r
3784 if( uxSchedulerSuspended == ( UBaseType_t ) pdFALSE )
\r
3786 xReturn = taskSCHEDULER_RUNNING;
\r
3790 xReturn = taskSCHEDULER_SUSPENDED;
\r
3797 #endif /* ( ( INCLUDE_xTaskGetSchedulerState == 1 ) || ( configUSE_TIMERS == 1 ) ) */
\r
3798 /*-----------------------------------------------------------*/
\r
3800 #if ( configUSE_MUTEXES == 1 )
\r
3802 void vTaskPriorityInherit( TaskHandle_t const pxMutexHolder )
\r
3804 TCB_t * const pxTCB = ( TCB_t * ) pxMutexHolder;
\r
3806 /* If the mutex was given back by an interrupt while the queue was
\r
3807 locked then the mutex holder might now be NULL. */
\r
3808 if( pxMutexHolder != NULL )
\r
3810 /* If the holder of the mutex has a priority below the priority of
\r
3811 the task attempting to obtain the mutex then it will temporarily
\r
3812 inherit the priority of the task attempting to obtain the mutex. */
\r
3813 if( pxTCB->uxPriority < pxCurrentTCB->uxPriority )
\r
3815 /* Adjust the mutex holder state to account for its new
\r
3816 priority. Only reset the event list item value if the value is
\r
3817 not being used for anything else. */
\r
3818 if( ( listGET_LIST_ITEM_VALUE( &( pxTCB->xEventListItem ) ) & taskEVENT_LIST_ITEM_VALUE_IN_USE ) == 0UL )
\r
3820 listSET_LIST_ITEM_VALUE( &( pxTCB->xEventListItem ), ( TickType_t ) configMAX_PRIORITIES - ( TickType_t ) pxCurrentTCB->uxPriority ); /*lint !e961 MISRA exception as the casts are only redundant for some ports. */
\r
3824 mtCOVERAGE_TEST_MARKER();
\r
3827 /* If the task being modified is in the ready state it will need
\r
3828 to be moved into a new list. */
\r
3829 if( listIS_CONTAINED_WITHIN( &( pxReadyTasksLists[ pxTCB->uxPriority ] ), &( pxTCB->xStateListItem ) ) != pdFALSE )
\r
3831 if( uxListRemove( &( pxTCB->xStateListItem ) ) == ( UBaseType_t ) 0 )
\r
3833 taskRESET_READY_PRIORITY( pxTCB->uxPriority );
\r
3837 mtCOVERAGE_TEST_MARKER();
\r
3840 /* Inherit the priority before being moved into the new list. */
\r
3841 pxTCB->uxPriority = pxCurrentTCB->uxPriority;
\r
3842 prvAddTaskToReadyList( pxTCB );
\r
3846 /* Just inherit the priority. */
\r
3847 pxTCB->uxPriority = pxCurrentTCB->uxPriority;
\r
3850 traceTASK_PRIORITY_INHERIT( pxTCB, pxCurrentTCB->uxPriority );
\r
3854 mtCOVERAGE_TEST_MARKER();
\r
3859 mtCOVERAGE_TEST_MARKER();
\r
3863 #endif /* configUSE_MUTEXES */
\r
3864 /*-----------------------------------------------------------*/
\r
3866 #if ( configUSE_MUTEXES == 1 )
\r
3868 BaseType_t xTaskPriorityDisinherit( TaskHandle_t const pxMutexHolder )
\r
3870 TCB_t * const pxTCB = ( TCB_t * ) pxMutexHolder;
\r
3871 BaseType_t xReturn = pdFALSE;
\r
3873 if( pxMutexHolder != NULL )
\r
3875 /* A task can only have an inherited priority if it holds the mutex.
\r
3876 If the mutex is held by a task then it cannot be given from an
\r
3877 interrupt, and if a mutex is given by the holding task then it must
\r
3878 be the running state task. */
\r
3879 configASSERT( pxTCB == pxCurrentTCB );
\r
3881 configASSERT( pxTCB->uxMutexesHeld );
\r
3882 ( pxTCB->uxMutexesHeld )--;
\r
3884 /* Has the holder of the mutex inherited the priority of another
\r
3886 if( pxTCB->uxPriority != pxTCB->uxBasePriority )
\r
3888 /* Only disinherit if no other mutexes are held. */
\r
3889 if( pxTCB->uxMutexesHeld == ( UBaseType_t ) 0 )
\r
3891 /* A task can only have an inherited priority if it holds
\r
3892 the mutex. If the mutex is held by a task then it cannot be
\r
3893 given from an interrupt, and if a mutex is given by the
\r
3894 holding task then it must be the running state task. Remove
\r
3895 the holding task from the ready list. */
\r
3896 if( uxListRemove( &( pxTCB->xStateListItem ) ) == ( UBaseType_t ) 0 )
\r
3898 taskRESET_READY_PRIORITY( pxTCB->uxPriority );
\r
3902 mtCOVERAGE_TEST_MARKER();
\r
3905 /* Disinherit the priority before adding the task into the
\r
3906 new ready list. */
\r
3907 traceTASK_PRIORITY_DISINHERIT( pxTCB, pxTCB->uxBasePriority );
\r
3908 pxTCB->uxPriority = pxTCB->uxBasePriority;
\r
3910 /* Reset the event list item value. It cannot be in use for
\r
3911 any other purpose if this task is running, and it must be
\r
3912 running to give back the mutex. */
\r
3913 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
3914 prvAddTaskToReadyList( pxTCB );
\r
3916 /* Return true to indicate that a context switch is required.
\r
3917 This is only actually required in the corner case whereby
\r
3918 multiple mutexes were held and the mutexes were given back
\r
3919 in an order different to that in which they were taken.
\r
3920 If a context switch did not occur when the first mutex was
\r
3921 returned, even if a task was waiting on it, then a context
\r
3922 switch should occur when the last mutex is returned whether
\r
3923 a task is waiting on it or not. */
\r
3928 mtCOVERAGE_TEST_MARKER();
\r
3933 mtCOVERAGE_TEST_MARKER();
\r
3938 mtCOVERAGE_TEST_MARKER();
\r
3944 #endif /* configUSE_MUTEXES */
\r
3945 /*-----------------------------------------------------------*/
\r
3947 #if ( portCRITICAL_NESTING_IN_TCB == 1 )
\r
3949 void vTaskEnterCritical( void )
\r
3951 portDISABLE_INTERRUPTS();
\r
3953 if( xSchedulerRunning != pdFALSE )
\r
3955 ( pxCurrentTCB->uxCriticalNesting )++;
\r
3957 /* This is not the interrupt safe version of the enter critical
\r
3958 function so assert() if it is being called from an interrupt
\r
3959 context. Only API functions that end in "FromISR" can be used in an
\r
3960 interrupt. Only assert if the critical nesting count is 1 to
\r
3961 protect against recursive calls if the assert function also uses a
\r
3962 critical section. */
\r
3963 if( pxCurrentTCB->uxCriticalNesting == 1 )
\r
3965 portASSERT_IF_IN_ISR();
\r
3970 mtCOVERAGE_TEST_MARKER();
\r
3974 #endif /* portCRITICAL_NESTING_IN_TCB */
\r
3975 /*-----------------------------------------------------------*/
\r
3977 #if ( portCRITICAL_NESTING_IN_TCB == 1 )
\r
3979 void vTaskExitCritical( void )
\r
3981 if( xSchedulerRunning != pdFALSE )
\r
3983 if( pxCurrentTCB->uxCriticalNesting > 0U )
\r
3985 ( pxCurrentTCB->uxCriticalNesting )--;
\r
3987 if( pxCurrentTCB->uxCriticalNesting == 0U )
\r
3989 portENABLE_INTERRUPTS();
\r
3993 mtCOVERAGE_TEST_MARKER();
\r
3998 mtCOVERAGE_TEST_MARKER();
\r
4003 mtCOVERAGE_TEST_MARKER();
\r
4007 #endif /* portCRITICAL_NESTING_IN_TCB */
\r
4008 /*-----------------------------------------------------------*/
\r
4010 #if ( ( configUSE_TRACE_FACILITY == 1 ) && ( configUSE_STATS_FORMATTING_FUNCTIONS > 0 ) )
\r
4012 static char *prvWriteNameToBuffer( char *pcBuffer, const char *pcTaskName )
\r
4016 /* Start by copying the entire string. */
\r
4017 strcpy( pcBuffer, pcTaskName );
\r
4019 /* Pad the end of the string with spaces to ensure columns line up when
\r
4021 for( x = strlen( pcBuffer ); x < ( size_t ) ( configMAX_TASK_NAME_LEN - 1 ); x++ )
\r
4023 pcBuffer[ x ] = ' ';
\r
4027 pcBuffer[ x ] = 0x00;
\r
4029 /* Return the new end of string. */
\r
4030 return &( pcBuffer[ x ] );
\r
4033 #endif /* ( configUSE_TRACE_FACILITY == 1 ) && ( configUSE_STATS_FORMATTING_FUNCTIONS > 0 ) */
\r
4034 /*-----------------------------------------------------------*/
\r
4036 #if ( ( configUSE_TRACE_FACILITY == 1 ) && ( configUSE_STATS_FORMATTING_FUNCTIONS > 0 ) && ( configSUPPORT_DYNAMIC_ALLOCATION == 1 ) )
\r
4038 void vTaskList( char * pcWriteBuffer )
\r
4040 TaskStatus_t *pxTaskStatusArray;
\r
4041 volatile UBaseType_t uxArraySize, x;
\r
4047 * This function is provided for convenience only, and is used by many
\r
4048 * of the demo applications. Do not consider it to be part of the
\r
4051 * vTaskList() calls uxTaskGetSystemState(), then formats part of the
\r
4052 * uxTaskGetSystemState() output into a human readable table that
\r
4053 * displays task names, states and stack usage.
\r
4055 * vTaskList() has a dependency on the sprintf() C library function that
\r
4056 * might bloat the code size, use a lot of stack, and provide different
\r
4057 * results on different platforms. An alternative, tiny, third party,
\r
4058 * and limited functionality implementation of sprintf() is provided in
\r
4059 * many of the FreeRTOS/Demo sub-directories in a file called
\r
4060 * printf-stdarg.c (note printf-stdarg.c does not provide a full
\r
4061 * snprintf() implementation!).
\r
4063 * It is recommended that production systems call uxTaskGetSystemState()
\r
4064 * directly to get access to raw stats data, rather than indirectly
\r
4065 * through a call to vTaskList().
\r
4069 /* Make sure the write buffer does not contain a string. */
\r
4070 *pcWriteBuffer = 0x00;
\r
4072 /* Take a snapshot of the number of tasks in case it changes while this
\r
4073 function is executing. */
\r
4074 uxArraySize = uxCurrentNumberOfTasks;
\r
4076 /* Allocate an array index for each task. NOTE! if
\r
4077 configSUPPORT_DYNAMIC_ALLOCATION is set to 0 then pvPortMalloc() will
\r
4078 equate to NULL. */
\r
4079 pxTaskStatusArray = pvPortMalloc( uxCurrentNumberOfTasks * sizeof( TaskStatus_t ) );
\r
4081 if( pxTaskStatusArray != NULL )
\r
4083 /* Generate the (binary) data. */
\r
4084 uxArraySize = uxTaskGetSystemState( pxTaskStatusArray, uxArraySize, NULL );
\r
4086 /* Create a human readable table from the binary data. */
\r
4087 for( x = 0; x < uxArraySize; x++ )
\r
4089 switch( pxTaskStatusArray[ x ].eCurrentState )
\r
4091 case eReady: cStatus = tskREADY_CHAR;
\r
4094 case eBlocked: cStatus = tskBLOCKED_CHAR;
\r
4097 case eSuspended: cStatus = tskSUSPENDED_CHAR;
\r
4100 case eDeleted: cStatus = tskDELETED_CHAR;
\r
4103 default: /* Should not get here, but it is included
\r
4104 to prevent static checking errors. */
\r
4109 /* Write the task name to the string, padding with spaces so it
\r
4110 can be printed in tabular form more easily. */
\r
4111 pcWriteBuffer = prvWriteNameToBuffer( pcWriteBuffer, pxTaskStatusArray[ x ].pcTaskName );
\r
4113 /* Write the rest of the string. */
\r
4114 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 );
\r
4115 pcWriteBuffer += strlen( pcWriteBuffer );
\r
4118 /* Free the array again. NOTE! If configSUPPORT_DYNAMIC_ALLOCATION
\r
4119 is 0 then vPortFree() will be #defined to nothing. */
\r
4120 vPortFree( pxTaskStatusArray );
\r
4124 mtCOVERAGE_TEST_MARKER();
\r
4128 #endif /* ( ( configUSE_TRACE_FACILITY == 1 ) && ( configUSE_STATS_FORMATTING_FUNCTIONS > 0 ) && ( configSUPPORT_DYNAMIC_ALLOCATION == 1 ) ) */
\r
4129 /*----------------------------------------------------------*/
\r
4131 #if ( ( configGENERATE_RUN_TIME_STATS == 1 ) && ( configUSE_STATS_FORMATTING_FUNCTIONS > 0 ) && ( configSUPPORT_DYNAMIC_ALLOCATION == 1 ) )
\r
4133 void vTaskGetRunTimeStats( char *pcWriteBuffer )
\r
4135 TaskStatus_t *pxTaskStatusArray;
\r
4136 volatile UBaseType_t uxArraySize, x;
\r
4137 uint32_t ulTotalTime, ulStatsAsPercentage;
\r
4139 #if( configUSE_TRACE_FACILITY != 1 )
\r
4141 #error configUSE_TRACE_FACILITY must also be set to 1 in FreeRTOSConfig.h to use vTaskGetRunTimeStats().
\r
4148 * This function is provided for convenience only, and is used by many
\r
4149 * of the demo applications. Do not consider it to be part of the
\r
4152 * vTaskGetRunTimeStats() calls uxTaskGetSystemState(), then formats part
\r
4153 * of the uxTaskGetSystemState() output into a human readable table that
\r
4154 * displays the amount of time each task has spent in the Running state
\r
4155 * in both absolute and percentage terms.
\r
4157 * vTaskGetRunTimeStats() has a dependency on the sprintf() C library
\r
4158 * function that might bloat the code size, use a lot of stack, and
\r
4159 * provide different results on different platforms. An alternative,
\r
4160 * tiny, third party, and limited functionality implementation of
\r
4161 * sprintf() is provided in many of the FreeRTOS/Demo sub-directories in
\r
4162 * a file called printf-stdarg.c (note printf-stdarg.c does not provide
\r
4163 * a full snprintf() implementation!).
\r
4165 * It is recommended that production systems call uxTaskGetSystemState()
\r
4166 * directly to get access to raw stats data, rather than indirectly
\r
4167 * through a call to vTaskGetRunTimeStats().
\r
4170 /* Make sure the write buffer does not contain a string. */
\r
4171 *pcWriteBuffer = 0x00;
\r
4173 /* Take a snapshot of the number of tasks in case it changes while this
\r
4174 function is executing. */
\r
4175 uxArraySize = uxCurrentNumberOfTasks;
\r
4177 /* Allocate an array index for each task. NOTE! If
\r
4178 configSUPPORT_DYNAMIC_ALLOCATION is set to 0 then pvPortMalloc() will
\r
4179 equate to NULL. */
\r
4180 pxTaskStatusArray = pvPortMalloc( uxCurrentNumberOfTasks * sizeof( TaskStatus_t ) );
\r
4182 if( pxTaskStatusArray != NULL )
\r
4184 /* Generate the (binary) data. */
\r
4185 uxArraySize = uxTaskGetSystemState( pxTaskStatusArray, uxArraySize, &ulTotalTime );
\r
4187 /* For percentage calculations. */
\r
4188 ulTotalTime /= 100UL;
\r
4190 /* Avoid divide by zero errors. */
\r
4191 if( ulTotalTime > 0 )
\r
4193 /* Create a human readable table from the binary data. */
\r
4194 for( x = 0; x < uxArraySize; x++ )
\r
4196 /* What percentage of the total run time has the task used?
\r
4197 This will always be rounded down to the nearest integer.
\r
4198 ulTotalRunTimeDiv100 has already been divided by 100. */
\r
4199 ulStatsAsPercentage = pxTaskStatusArray[ x ].ulRunTimeCounter / ulTotalTime;
\r
4201 /* Write the task name to the string, padding with
\r
4202 spaces so it can be printed in tabular form more
\r
4204 pcWriteBuffer = prvWriteNameToBuffer( pcWriteBuffer, pxTaskStatusArray[ x ].pcTaskName );
\r
4206 if( ulStatsAsPercentage > 0UL )
\r
4208 #ifdef portLU_PRINTF_SPECIFIER_REQUIRED
\r
4210 sprintf( pcWriteBuffer, "\t%lu\t\t%lu%%\r\n", pxTaskStatusArray[ x ].ulRunTimeCounter, ulStatsAsPercentage );
\r
4214 /* sizeof( int ) == sizeof( long ) so a smaller
\r
4215 printf() library can be used. */
\r
4216 sprintf( pcWriteBuffer, "\t%u\t\t%u%%\r\n", ( unsigned int ) pxTaskStatusArray[ x ].ulRunTimeCounter, ( unsigned int ) ulStatsAsPercentage );
\r
4222 /* If the percentage is zero here then the task has
\r
4223 consumed less than 1% of the total run time. */
\r
4224 #ifdef portLU_PRINTF_SPECIFIER_REQUIRED
\r
4226 sprintf( pcWriteBuffer, "\t%lu\t\t<1%%\r\n", pxTaskStatusArray[ x ].ulRunTimeCounter );
\r
4230 /* sizeof( int ) == sizeof( long ) so a smaller
\r
4231 printf() library can be used. */
\r
4232 sprintf( pcWriteBuffer, "\t%u\t\t<1%%\r\n", ( unsigned int ) pxTaskStatusArray[ x ].ulRunTimeCounter );
\r
4237 pcWriteBuffer += strlen( pcWriteBuffer );
\r
4242 mtCOVERAGE_TEST_MARKER();
\r
4245 /* Free the array again. NOTE! If configSUPPORT_DYNAMIC_ALLOCATION
\r
4246 is 0 then vPortFree() will be #defined to nothing. */
\r
4247 vPortFree( pxTaskStatusArray );
\r
4251 mtCOVERAGE_TEST_MARKER();
\r
4255 #endif /* ( ( configGENERATE_RUN_TIME_STATS == 1 ) && ( configUSE_STATS_FORMATTING_FUNCTIONS > 0 ) && ( configSUPPORT_STATIC_ALLOCATION == 1 ) ) */
\r
4256 /*-----------------------------------------------------------*/
\r
4258 TickType_t uxTaskResetEventItemValue( void )
\r
4260 TickType_t uxReturn;
\r
4262 uxReturn = listGET_LIST_ITEM_VALUE( &( pxCurrentTCB->xEventListItem ) );
\r
4264 /* Reset the event list item to its normal value - so it can be used with
\r
4265 queues and semaphores. */
\r
4266 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
4270 /*-----------------------------------------------------------*/
\r
4272 #if ( configUSE_MUTEXES == 1 )
\r
4274 void *pvTaskIncrementMutexHeldCount( void )
\r
4276 /* If xSemaphoreCreateMutex() is called before any tasks have been created
\r
4277 then pxCurrentTCB will be NULL. */
\r
4278 if( pxCurrentTCB != NULL )
\r
4280 ( pxCurrentTCB->uxMutexesHeld )++;
\r
4283 return pxCurrentTCB;
\r
4286 #endif /* configUSE_MUTEXES */
\r
4287 /*-----------------------------------------------------------*/
\r
4289 #if( configUSE_TASK_NOTIFICATIONS == 1 )
\r
4291 uint32_t ulTaskNotifyTake( BaseType_t xClearCountOnExit, TickType_t xTicksToWait )
\r
4293 uint32_t ulReturn;
\r
4295 taskENTER_CRITICAL();
\r
4297 /* Only block if the notification count is not already non-zero. */
\r
4298 if( pxCurrentTCB->ulNotifiedValue == 0UL )
\r
4300 /* Mark this task as waiting for a notification. */
\r
4301 pxCurrentTCB->ucNotifyState = taskWAITING_NOTIFICATION;
\r
4303 if( xTicksToWait > ( TickType_t ) 0 )
\r
4305 prvAddCurrentTaskToDelayedList( xTicksToWait, pdTRUE );
\r
4306 traceTASK_NOTIFY_TAKE_BLOCK();
\r
4308 /* All ports are written to allow a yield in a critical
\r
4309 section (some will yield immediately, others wait until the
\r
4310 critical section exits) - but it is not something that
\r
4311 application code should ever do. */
\r
4312 portYIELD_WITHIN_API();
\r
4316 mtCOVERAGE_TEST_MARKER();
\r
4321 mtCOVERAGE_TEST_MARKER();
\r
4324 taskEXIT_CRITICAL();
\r
4326 taskENTER_CRITICAL();
\r
4328 traceTASK_NOTIFY_TAKE();
\r
4329 ulReturn = pxCurrentTCB->ulNotifiedValue;
\r
4331 if( ulReturn != 0UL )
\r
4333 if( xClearCountOnExit != pdFALSE )
\r
4335 pxCurrentTCB->ulNotifiedValue = 0UL;
\r
4339 pxCurrentTCB->ulNotifiedValue = ulReturn - ( uint32_t ) 1;
\r
4344 mtCOVERAGE_TEST_MARKER();
\r
4347 pxCurrentTCB->ucNotifyState = taskNOT_WAITING_NOTIFICATION;
\r
4349 taskEXIT_CRITICAL();
\r
4354 #endif /* configUSE_TASK_NOTIFICATIONS */
\r
4355 /*-----------------------------------------------------------*/
\r
4357 #if( configUSE_TASK_NOTIFICATIONS == 1 )
\r
4359 BaseType_t xTaskNotifyWait( uint32_t ulBitsToClearOnEntry, uint32_t ulBitsToClearOnExit, uint32_t *pulNotificationValue, TickType_t xTicksToWait )
\r
4361 BaseType_t xReturn;
\r
4363 taskENTER_CRITICAL();
\r
4365 /* Only block if a notification is not already pending. */
\r
4366 if( pxCurrentTCB->ucNotifyState != taskNOTIFICATION_RECEIVED )
\r
4368 /* Clear bits in the task's notification value as bits may get
\r
4369 set by the notifying task or interrupt. This can be used to
\r
4370 clear the value to zero. */
\r
4371 pxCurrentTCB->ulNotifiedValue &= ~ulBitsToClearOnEntry;
\r
4373 /* Mark this task as waiting for a notification. */
\r
4374 pxCurrentTCB->ucNotifyState = taskWAITING_NOTIFICATION;
\r
4376 if( xTicksToWait > ( TickType_t ) 0 )
\r
4378 prvAddCurrentTaskToDelayedList( xTicksToWait, pdTRUE );
\r
4379 traceTASK_NOTIFY_WAIT_BLOCK();
\r
4381 /* All ports are written to allow a yield in a critical
\r
4382 section (some will yield immediately, others wait until the
\r
4383 critical section exits) - but it is not something that
\r
4384 application code should ever do. */
\r
4385 portYIELD_WITHIN_API();
\r
4389 mtCOVERAGE_TEST_MARKER();
\r
4394 mtCOVERAGE_TEST_MARKER();
\r
4397 taskEXIT_CRITICAL();
\r
4399 taskENTER_CRITICAL();
\r
4401 traceTASK_NOTIFY_WAIT();
\r
4403 if( pulNotificationValue != NULL )
\r
4405 /* Output the current notification value, which may or may not
\r
4407 *pulNotificationValue = pxCurrentTCB->ulNotifiedValue;
\r
4410 /* If ucNotifyValue is set then either the task never entered the
\r
4411 blocked state (because a notification was already pending) or the
\r
4412 task unblocked because of a notification. Otherwise the task
\r
4413 unblocked because of a timeout. */
\r
4414 if( pxCurrentTCB->ucNotifyState == taskWAITING_NOTIFICATION )
\r
4416 /* A notification was not received. */
\r
4417 xReturn = pdFALSE;
\r
4421 /* A notification was already pending or a notification was
\r
4422 received while the task was waiting. */
\r
4423 pxCurrentTCB->ulNotifiedValue &= ~ulBitsToClearOnExit;
\r
4427 pxCurrentTCB->ucNotifyState = taskNOT_WAITING_NOTIFICATION;
\r
4429 taskEXIT_CRITICAL();
\r
4434 #endif /* configUSE_TASK_NOTIFICATIONS */
\r
4435 /*-----------------------------------------------------------*/
\r
4437 #if( configUSE_TASK_NOTIFICATIONS == 1 )
\r
4439 BaseType_t xTaskGenericNotify( TaskHandle_t xTaskToNotify, uint32_t ulValue, eNotifyAction eAction, uint32_t *pulPreviousNotificationValue )
\r
4442 BaseType_t xReturn = pdPASS;
\r
4443 uint8_t ucOriginalNotifyState;
\r
4445 configASSERT( xTaskToNotify );
\r
4446 pxTCB = ( TCB_t * ) xTaskToNotify;
\r
4448 taskENTER_CRITICAL();
\r
4450 if( pulPreviousNotificationValue != NULL )
\r
4452 *pulPreviousNotificationValue = pxTCB->ulNotifiedValue;
\r
4455 ucOriginalNotifyState = pxTCB->ucNotifyState;
\r
4457 pxTCB->ucNotifyState = taskNOTIFICATION_RECEIVED;
\r
4462 pxTCB->ulNotifiedValue |= ulValue;
\r
4466 ( pxTCB->ulNotifiedValue )++;
\r
4469 case eSetValueWithOverwrite :
\r
4470 pxTCB->ulNotifiedValue = ulValue;
\r
4473 case eSetValueWithoutOverwrite :
\r
4474 if( ucOriginalNotifyState != taskNOTIFICATION_RECEIVED )
\r
4476 pxTCB->ulNotifiedValue = ulValue;
\r
4480 /* The value could not be written to the task. */
\r
4486 /* The task is being notified without its notify value being
\r
4491 traceTASK_NOTIFY();
\r
4493 /* If the task is in the blocked state specifically to wait for a
\r
4494 notification then unblock it now. */
\r
4495 if( ucOriginalNotifyState == taskWAITING_NOTIFICATION )
\r
4497 ( void ) uxListRemove( &( pxTCB->xStateListItem ) );
\r
4498 prvAddTaskToReadyList( pxTCB );
\r
4500 /* The task should not have been on an event list. */
\r
4501 configASSERT( listLIST_ITEM_CONTAINER( &( pxTCB->xEventListItem ) ) == NULL );
\r
4503 #if( configUSE_TICKLESS_IDLE != 0 )
\r
4505 /* If a task is blocked waiting for a notification then
\r
4506 xNextTaskUnblockTime might be set to the blocked task's time
\r
4507 out time. If the task is unblocked for a reason other than
\r
4508 a timeout xNextTaskUnblockTime is normally left unchanged,
\r
4509 because it will automatically get reset to a new value when
\r
4510 the tick count equals xNextTaskUnblockTime. However if
\r
4511 tickless idling is used it might be more important to enter
\r
4512 sleep mode at the earliest possible time - so reset
\r
4513 xNextTaskUnblockTime here to ensure it is updated at the
\r
4514 earliest possible time. */
\r
4515 prvResetNextTaskUnblockTime();
\r
4519 if( pxTCB->uxPriority > pxCurrentTCB->uxPriority )
\r
4521 /* The notified task has a priority above the currently
\r
4522 executing task so a yield is required. */
\r
4523 taskYIELD_IF_USING_PREEMPTION();
\r
4527 mtCOVERAGE_TEST_MARKER();
\r
4532 mtCOVERAGE_TEST_MARKER();
\r
4535 taskEXIT_CRITICAL();
\r
4540 #endif /* configUSE_TASK_NOTIFICATIONS */
\r
4541 /*-----------------------------------------------------------*/
\r
4543 #if( configUSE_TASK_NOTIFICATIONS == 1 )
\r
4545 BaseType_t xTaskGenericNotifyFromISR( TaskHandle_t xTaskToNotify, uint32_t ulValue, eNotifyAction eAction, uint32_t *pulPreviousNotificationValue, BaseType_t *pxHigherPriorityTaskWoken )
\r
4548 uint8_t ucOriginalNotifyState;
\r
4549 BaseType_t xReturn = pdPASS;
\r
4550 UBaseType_t uxSavedInterruptStatus;
\r
4552 configASSERT( xTaskToNotify );
\r
4554 /* RTOS ports that support interrupt nesting have the concept of a
\r
4555 maximum system call (or maximum API call) interrupt priority.
\r
4556 Interrupts that are above the maximum system call priority are keep
\r
4557 permanently enabled, even when the RTOS kernel is in a critical section,
\r
4558 but cannot make any calls to FreeRTOS API functions. If configASSERT()
\r
4559 is defined in FreeRTOSConfig.h then
\r
4560 portASSERT_IF_INTERRUPT_PRIORITY_INVALID() will result in an assertion
\r
4561 failure if a FreeRTOS API function is called from an interrupt that has
\r
4562 been assigned a priority above the configured maximum system call
\r
4563 priority. Only FreeRTOS functions that end in FromISR can be called
\r
4564 from interrupts that have been assigned a priority at or (logically)
\r
4565 below the maximum system call interrupt priority. FreeRTOS maintains a
\r
4566 separate interrupt safe API to ensure interrupt entry is as fast and as
\r
4567 simple as possible. More information (albeit Cortex-M specific) is
\r
4568 provided on the following link:
\r
4569 http://www.freertos.org/RTOS-Cortex-M3-M4.html */
\r
4570 portASSERT_IF_INTERRUPT_PRIORITY_INVALID();
\r
4572 pxTCB = ( TCB_t * ) xTaskToNotify;
\r
4574 uxSavedInterruptStatus = portSET_INTERRUPT_MASK_FROM_ISR();
\r
4576 if( pulPreviousNotificationValue != NULL )
\r
4578 *pulPreviousNotificationValue = pxTCB->ulNotifiedValue;
\r
4581 ucOriginalNotifyState = pxTCB->ucNotifyState;
\r
4582 pxTCB->ucNotifyState = taskNOTIFICATION_RECEIVED;
\r
4587 pxTCB->ulNotifiedValue |= ulValue;
\r
4591 ( pxTCB->ulNotifiedValue )++;
\r
4594 case eSetValueWithOverwrite :
\r
4595 pxTCB->ulNotifiedValue = ulValue;
\r
4598 case eSetValueWithoutOverwrite :
\r
4599 if( ucOriginalNotifyState != taskNOTIFICATION_RECEIVED )
\r
4601 pxTCB->ulNotifiedValue = ulValue;
\r
4605 /* The value could not be written to the task. */
\r
4611 /* The task is being notified without its notify value being
\r
4616 traceTASK_NOTIFY_FROM_ISR();
\r
4618 /* If the task is in the blocked state specifically to wait for a
\r
4619 notification then unblock it now. */
\r
4620 if( ucOriginalNotifyState == taskWAITING_NOTIFICATION )
\r
4622 /* The task should not have been on an event list. */
\r
4623 configASSERT( listLIST_ITEM_CONTAINER( &( pxTCB->xEventListItem ) ) == NULL );
\r
4625 if( uxSchedulerSuspended == ( UBaseType_t ) pdFALSE )
\r
4627 ( void ) uxListRemove( &( pxTCB->xStateListItem ) );
\r
4628 prvAddTaskToReadyList( pxTCB );
\r
4632 /* The delayed and ready lists cannot be accessed, so hold
\r
4633 this task pending until the scheduler is resumed. */
\r
4634 vListInsertEnd( &( xPendingReadyList ), &( pxTCB->xEventListItem ) );
\r
4637 if( pxTCB->uxPriority > pxCurrentTCB->uxPriority )
\r
4639 /* The notified task has a priority above the currently
\r
4640 executing task so a yield is required. */
\r
4641 if( pxHigherPriorityTaskWoken != NULL )
\r
4643 *pxHigherPriorityTaskWoken = pdTRUE;
\r
4647 /* Mark that a yield is pending in case the user is not
\r
4648 using the "xHigherPriorityTaskWoken" parameter to an ISR
\r
4649 safe FreeRTOS function. */
\r
4650 xYieldPending = pdTRUE;
\r
4655 mtCOVERAGE_TEST_MARKER();
\r
4659 portCLEAR_INTERRUPT_MASK_FROM_ISR( uxSavedInterruptStatus );
\r
4664 #endif /* configUSE_TASK_NOTIFICATIONS */
\r
4665 /*-----------------------------------------------------------*/
\r
4667 #if( configUSE_TASK_NOTIFICATIONS == 1 )
\r
4669 void vTaskNotifyGiveFromISR( TaskHandle_t xTaskToNotify, BaseType_t *pxHigherPriorityTaskWoken )
\r
4672 uint8_t ucOriginalNotifyState;
\r
4673 UBaseType_t uxSavedInterruptStatus;
\r
4675 configASSERT( xTaskToNotify );
\r
4677 /* RTOS ports that support interrupt nesting have the concept of a
\r
4678 maximum system call (or maximum API call) interrupt priority.
\r
4679 Interrupts that are above the maximum system call priority are keep
\r
4680 permanently enabled, even when the RTOS kernel is in a critical section,
\r
4681 but cannot make any calls to FreeRTOS API functions. If configASSERT()
\r
4682 is defined in FreeRTOSConfig.h then
\r
4683 portASSERT_IF_INTERRUPT_PRIORITY_INVALID() will result in an assertion
\r
4684 failure if a FreeRTOS API function is called from an interrupt that has
\r
4685 been assigned a priority above the configured maximum system call
\r
4686 priority. Only FreeRTOS functions that end in FromISR can be called
\r
4687 from interrupts that have been assigned a priority at or (logically)
\r
4688 below the maximum system call interrupt priority. FreeRTOS maintains a
\r
4689 separate interrupt safe API to ensure interrupt entry is as fast and as
\r
4690 simple as possible. More information (albeit Cortex-M specific) is
\r
4691 provided on the following link:
\r
4692 http://www.freertos.org/RTOS-Cortex-M3-M4.html */
\r
4693 portASSERT_IF_INTERRUPT_PRIORITY_INVALID();
\r
4695 pxTCB = ( TCB_t * ) xTaskToNotify;
\r
4697 uxSavedInterruptStatus = portSET_INTERRUPT_MASK_FROM_ISR();
\r
4699 ucOriginalNotifyState = pxTCB->ucNotifyState;
\r
4700 pxTCB->ucNotifyState = taskNOTIFICATION_RECEIVED;
\r
4702 /* 'Giving' is equivalent to incrementing a count in a counting
\r
4704 ( pxTCB->ulNotifiedValue )++;
\r
4706 traceTASK_NOTIFY_GIVE_FROM_ISR();
\r
4708 /* If the task is in the blocked state specifically to wait for a
\r
4709 notification then unblock it now. */
\r
4710 if( ucOriginalNotifyState == taskWAITING_NOTIFICATION )
\r
4712 /* The task should not have been on an event list. */
\r
4713 configASSERT( listLIST_ITEM_CONTAINER( &( pxTCB->xEventListItem ) ) == NULL );
\r
4715 if( uxSchedulerSuspended == ( UBaseType_t ) pdFALSE )
\r
4717 ( void ) uxListRemove( &( pxTCB->xStateListItem ) );
\r
4718 prvAddTaskToReadyList( pxTCB );
\r
4722 /* The delayed and ready lists cannot be accessed, so hold
\r
4723 this task pending until the scheduler is resumed. */
\r
4724 vListInsertEnd( &( xPendingReadyList ), &( pxTCB->xEventListItem ) );
\r
4727 if( pxTCB->uxPriority > pxCurrentTCB->uxPriority )
\r
4729 /* The notified task has a priority above the currently
\r
4730 executing task so a yield is required. */
\r
4731 if( pxHigherPriorityTaskWoken != NULL )
\r
4733 *pxHigherPriorityTaskWoken = pdTRUE;
\r
4737 /* Mark that a yield is pending in case the user is not
\r
4738 using the "xHigherPriorityTaskWoken" parameter in an ISR
\r
4739 safe FreeRTOS function. */
\r
4740 xYieldPending = pdTRUE;
\r
4745 mtCOVERAGE_TEST_MARKER();
\r
4749 portCLEAR_INTERRUPT_MASK_FROM_ISR( uxSavedInterruptStatus );
\r
4752 #endif /* configUSE_TASK_NOTIFICATIONS */
\r
4754 /*-----------------------------------------------------------*/
\r
4756 #if( configUSE_TASK_NOTIFICATIONS == 1 )
\r
4758 BaseType_t xTaskNotifyStateClear( TaskHandle_t xTask )
\r
4761 BaseType_t xReturn;
\r
4763 /* If null is passed in here then it is the calling task that is having
\r
4764 its notification state cleared. */
\r
4765 pxTCB = prvGetTCBFromHandle( xTask );
\r
4767 taskENTER_CRITICAL();
\r
4769 if( pxTCB->ucNotifyState == taskNOTIFICATION_RECEIVED )
\r
4771 pxTCB->ucNotifyState = taskNOT_WAITING_NOTIFICATION;
\r
4779 taskEXIT_CRITICAL();
\r
4784 #endif /* configUSE_TASK_NOTIFICATIONS */
\r
4785 /*-----------------------------------------------------------*/
\r
4788 static void prvAddCurrentTaskToDelayedList( TickType_t xTicksToWait, const BaseType_t xCanBlockIndefinitely )
\r
4790 TickType_t xTimeToWake;
\r
4791 const TickType_t xConstTickCount = xTickCount;
\r
4793 #if( INCLUDE_xTaskAbortDelay == 1 )
\r
4795 /* About to enter a delayed list, so ensure the ucDelayAborted flag is
\r
4796 reset to pdFALSE so it can be detected as having been set to pdTRUE
\r
4797 when the task leaves the Blocked state. */
\r
4798 pxCurrentTCB->ucDelayAborted = pdFALSE;
\r
4802 /* Remove the task from the ready list before adding it to the blocked list
\r
4803 as the same list item is used for both lists. */
\r
4804 if( uxListRemove( &( pxCurrentTCB->xStateListItem ) ) == ( UBaseType_t ) 0 )
\r
4806 /* The current task must be in a ready list, so there is no need to
\r
4807 check, and the port reset macro can be called directly. */
\r
4808 portRESET_READY_PRIORITY( pxCurrentTCB->uxPriority, uxTopReadyPriority );
\r
4812 mtCOVERAGE_TEST_MARKER();
\r
4815 #if ( INCLUDE_vTaskSuspend == 1 )
\r
4817 if( ( xTicksToWait == portMAX_DELAY ) && ( xCanBlockIndefinitely != pdFALSE ) )
\r
4819 /* Add the task to the suspended task list instead of a delayed task
\r
4820 list to ensure it is not woken by a timing event. It will block
\r
4822 vListInsertEnd( &xSuspendedTaskList, &( pxCurrentTCB->xStateListItem ) );
\r
4826 /* Calculate the time at which the task should be woken if the event
\r
4827 does not occur. This may overflow but this doesn't matter, the
\r
4828 kernel will manage it correctly. */
\r
4829 xTimeToWake = xConstTickCount + xTicksToWait;
\r
4831 /* The list item will be inserted in wake time order. */
\r
4832 listSET_LIST_ITEM_VALUE( &( pxCurrentTCB->xStateListItem ), xTimeToWake );
\r
4834 if( xTimeToWake < xConstTickCount )
\r
4836 /* Wake time has overflowed. Place this item in the overflow
\r
4838 vListInsert( pxOverflowDelayedTaskList, &( pxCurrentTCB->xStateListItem ) );
\r
4842 /* The wake time has not overflowed, so the current block list
\r
4844 vListInsert( pxDelayedTaskList, &( pxCurrentTCB->xStateListItem ) );
\r
4846 /* If the task entering the blocked state was placed at the
\r
4847 head of the list of blocked tasks then xNextTaskUnblockTime
\r
4848 needs to be updated too. */
\r
4849 if( xTimeToWake < xNextTaskUnblockTime )
\r
4851 xNextTaskUnblockTime = xTimeToWake;
\r
4855 mtCOVERAGE_TEST_MARKER();
\r
4860 #else /* INCLUDE_vTaskSuspend */
\r
4862 /* Calculate the time at which the task should be woken if the event
\r
4863 does not occur. This may overflow but this doesn't matter, the kernel
\r
4864 will manage it correctly. */
\r
4865 xTimeToWake = xConstTickCount + xTicksToWait;
\r
4867 /* The list item will be inserted in wake time order. */
\r
4868 listSET_LIST_ITEM_VALUE( &( pxCurrentTCB->xStateListItem ), xTimeToWake );
\r
4870 if( xTimeToWake < xConstTickCount )
\r
4872 /* Wake time has overflowed. Place this item in the overflow list. */
\r
4873 vListInsert( pxOverflowDelayedTaskList, &( pxCurrentTCB->xStateListItem ) );
\r
4877 /* The wake time has not overflowed, so the current block list is used. */
\r
4878 vListInsert( pxDelayedTaskList, &( pxCurrentTCB->xStateListItem ) );
\r
4880 /* If the task entering the blocked state was placed at the head of the
\r
4881 list of blocked tasks then xNextTaskUnblockTime needs to be updated
\r
4883 if( xTimeToWake < xNextTaskUnblockTime )
\r
4885 xNextTaskUnblockTime = xTimeToWake;
\r
4889 mtCOVERAGE_TEST_MARKER();
\r
4893 /* Avoid compiler warning when INCLUDE_vTaskSuspend is not 1. */
\r
4894 ( void ) xCanBlockIndefinitely;
\r
4896 #endif /* INCLUDE_vTaskSuspend */
\r
4899 /* Code below here allows additional code to be inserted into this source file,
\r
4900 especially where access to file scope functions and data is needed (for example
\r
4901 when performing module tests). */
\r
4903 #ifdef FREERTOS_MODULE_TEST
\r
4904 #include "tasks_test_access_functions.h"
\r
4908 #if( configINCLUDE_FREERTOS_TASK_C_ADDITIONS_H == 1 )
\r
4910 #include "freertos_tasks_c_additions.h"
\r
4912 static void freertos_tasks_c_additions_init( void )
\r
4914 #ifdef FREERTOS_TASKS_C_ADDITIONS_INIT
\r
4915 FREERTOS_TASKS_C_ADDITIONS_INIT();
\r
projects / freertos / blob