2 FreeRTOS V9.0.0rc1 - 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
121 * Macros used by vListTask to indicate which state a task is in.
\r
123 #define tskBLOCKED_CHAR ( 'B' )
\r
124 #define tskREADY_CHAR ( 'R' )
\r
125 #define tskDELETED_CHAR ( 'D' )
\r
126 #define tskSUSPENDED_CHAR ( 'S' )
\r
129 * Some kernel aware debuggers require the data the debugger needs access to be
\r
130 * global, rather than file scope.
\r
132 #ifdef portREMOVE_STATIC_QUALIFIER
\r
136 #if ( configUSE_PORT_OPTIMISED_TASK_SELECTION == 0 )
\r
138 /* If configUSE_PORT_OPTIMISED_TASK_SELECTION is 0 then task selection is
\r
139 performed in a generic way that is not optimised to any particular
\r
140 microcontroller architecture. */
\r
142 /* uxTopReadyPriority holds the priority of the highest priority ready
\r
144 #define taskRECORD_READY_PRIORITY( uxPriority ) \
\r
146 if( ( uxPriority ) > uxTopReadyPriority ) \
\r
148 uxTopReadyPriority = ( uxPriority ); \
\r
150 } /* taskRECORD_READY_PRIORITY */
\r
152 /*-----------------------------------------------------------*/
\r
154 #define taskSELECT_HIGHEST_PRIORITY_TASK() \
\r
156 UBaseType_t uxTopPriority = uxTopReadyPriority; \
\r
158 /* Find the highest priority queue that contains ready tasks. */ \
\r
159 while( listLIST_IS_EMPTY( &( pxReadyTasksLists[ uxTopPriority ] ) ) ) \
\r
161 configASSERT( uxTopPriority ); \
\r
165 /* listGET_OWNER_OF_NEXT_ENTRY indexes through the list, so the tasks of \
\r
166 the same priority get an equal share of the processor time. */ \
\r
167 listGET_OWNER_OF_NEXT_ENTRY( pxCurrentTCB, &( pxReadyTasksLists[ uxTopPriority ] ) ); \
\r
168 uxTopReadyPriority = uxTopPriority; \
\r
169 } /* taskSELECT_HIGHEST_PRIORITY_TASK */
\r
171 /*-----------------------------------------------------------*/
\r
173 /* Define away taskRESET_READY_PRIORITY() and portRESET_READY_PRIORITY() as
\r
174 they are only required when a port optimised method of task selection is
\r
176 #define taskRESET_READY_PRIORITY( uxPriority )
\r
177 #define portRESET_READY_PRIORITY( uxPriority, uxTopReadyPriority )
\r
179 #else /* configUSE_PORT_OPTIMISED_TASK_SELECTION */
\r
181 /* If configUSE_PORT_OPTIMISED_TASK_SELECTION is 1 then task selection is
\r
182 performed in a way that is tailored to the particular microcontroller
\r
183 architecture being used. */
\r
185 /* A port optimised version is provided. Call the port defined macros. */
\r
186 #define taskRECORD_READY_PRIORITY( uxPriority ) portRECORD_READY_PRIORITY( uxPriority, uxTopReadyPriority )
\r
188 /*-----------------------------------------------------------*/
\r
190 #define taskSELECT_HIGHEST_PRIORITY_TASK() \
\r
192 UBaseType_t uxTopPriority; \
\r
194 /* Find the highest priority list that contains ready tasks. */ \
\r
195 portGET_HIGHEST_PRIORITY( uxTopPriority, uxTopReadyPriority ); \
\r
196 configASSERT( listCURRENT_LIST_LENGTH( &( pxReadyTasksLists[ uxTopPriority ] ) ) > 0 ); \
\r
197 listGET_OWNER_OF_NEXT_ENTRY( pxCurrentTCB, &( pxReadyTasksLists[ uxTopPriority ] ) ); \
\r
198 } /* taskSELECT_HIGHEST_PRIORITY_TASK() */
\r
200 /*-----------------------------------------------------------*/
\r
202 /* A port optimised version is provided, call it only if the TCB being reset
\r
203 is being referenced from a ready list. If it is referenced from a delayed
\r
204 or suspended list then it won't be in a ready list. */
\r
205 #define taskRESET_READY_PRIORITY( uxPriority ) \
\r
207 if( listCURRENT_LIST_LENGTH( &( pxReadyTasksLists[ ( uxPriority ) ] ) ) == ( UBaseType_t ) 0 ) \
\r
209 portRESET_READY_PRIORITY( ( uxPriority ), ( uxTopReadyPriority ) ); \
\r
213 #endif /* configUSE_PORT_OPTIMISED_TASK_SELECTION */
\r
215 /*-----------------------------------------------------------*/
\r
217 /* pxDelayedTaskList and pxOverflowDelayedTaskList are switched when the tick
\r
218 count overflows. */
\r
219 #define taskSWITCH_DELAYED_LISTS() \
\r
223 /* The delayed tasks list should be empty when the lists are switched. */ \
\r
224 configASSERT( ( listLIST_IS_EMPTY( pxDelayedTaskList ) ) ); \
\r
226 pxTemp = pxDelayedTaskList; \
\r
227 pxDelayedTaskList = pxOverflowDelayedTaskList; \
\r
228 pxOverflowDelayedTaskList = pxTemp; \
\r
229 xNumOfOverflows++; \
\r
230 prvResetNextTaskUnblockTime(); \
\r
233 /*-----------------------------------------------------------*/
\r
236 * Place the task represented by pxTCB into the appropriate ready list for
\r
237 * the task. It is inserted at the end of the list.
\r
239 #define prvAddTaskToReadyList( pxTCB ) \
\r
240 traceMOVED_TASK_TO_READY_STATE( pxTCB ); \
\r
241 taskRECORD_READY_PRIORITY( ( pxTCB )->uxPriority ); \
\r
242 vListInsertEnd( &( pxReadyTasksLists[ ( pxTCB )->uxPriority ] ), &( ( pxTCB )->xStateListItem ) ); \
\r
243 tracePOST_MOVED_TASK_TO_READY_STATE( pxTCB )
\r
244 /*-----------------------------------------------------------*/
\r
247 * Several functions take an TaskHandle_t parameter that can optionally be NULL,
\r
248 * where NULL is used to indicate that the handle of the currently executing
\r
249 * task should be used in place of the parameter. This macro simply checks to
\r
250 * see if the parameter is NULL and returns a pointer to the appropriate TCB.
\r
252 #define prvGetTCBFromHandle( pxHandle ) ( ( ( pxHandle ) == NULL ) ? ( TCB_t * ) pxCurrentTCB : ( TCB_t * ) ( pxHandle ) )
\r
254 /* The item value of the event list item is normally used to hold the priority
\r
255 of the task to which it belongs (coded to allow it to be held in reverse
\r
256 priority order). However, it is occasionally borrowed for other purposes. It
\r
257 is important its value is not updated due to a task priority change while it is
\r
258 being used for another purpose. The following bit definition is used to inform
\r
259 the scheduler that the value should not be changed - in which case it is the
\r
260 responsibility of whichever module is using the value to ensure it gets set back
\r
261 to its original value when it is released. */
\r
262 #if( configUSE_16_BIT_TICKS == 1 )
\r
263 #define taskEVENT_LIST_ITEM_VALUE_IN_USE 0x8000U
\r
265 #define taskEVENT_LIST_ITEM_VALUE_IN_USE 0x80000000UL
\r
269 * Task control block. A task control block (TCB) is allocated for each task,
\r
270 * and stores task state information, including a pointer to the task's context
\r
271 * (the task's run time environment, including register values)
\r
273 typedef struct tskTaskControlBlock
\r
275 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
277 #if ( portUSING_MPU_WRAPPERS == 1 )
\r
278 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
281 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
282 ListItem_t xEventListItem; /*< Used to reference a task from an event list. */
\r
283 UBaseType_t uxPriority; /*< The priority of the task. 0 is the lowest priority. */
\r
284 StackType_t *pxStack; /*< Points to the start of the stack. */
\r
285 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
287 #if ( portSTACK_GROWTH > 0 )
\r
288 StackType_t *pxEndOfStack; /*< Points to the end of the stack on architectures where the stack grows up from low memory. */
\r
291 #if ( portCRITICAL_NESTING_IN_TCB == 1 )
\r
292 UBaseType_t uxCriticalNesting; /*< Holds the critical section nesting depth for ports that do not maintain their own count in the port layer. */
\r
295 #if ( configUSE_TRACE_FACILITY == 1 )
\r
296 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
297 UBaseType_t uxTaskNumber; /*< Stores a number specifically for use by third party trace code. */
\r
300 #if ( configUSE_MUTEXES == 1 )
\r
301 UBaseType_t uxBasePriority; /*< The priority last assigned to the task - used by the priority inheritance mechanism. */
\r
302 UBaseType_t uxMutexesHeld;
\r
305 #if ( configUSE_APPLICATION_TASK_TAG == 1 )
\r
306 TaskHookFunction_t pxTaskTag;
\r
309 #if( configNUM_THREAD_LOCAL_STORAGE_POINTERS > 0 )
\r
310 void *pvThreadLocalStoragePointers[ configNUM_THREAD_LOCAL_STORAGE_POINTERS ];
\r
313 #if( configGENERATE_RUN_TIME_STATS == 1 )
\r
314 uint32_t ulRunTimeCounter; /*< Stores the amount of time the task has spent in the Running state. */
\r
317 #if ( configUSE_NEWLIB_REENTRANT == 1 )
\r
318 /* Allocate a Newlib reent structure that is specific to this task.
\r
319 Note Newlib support has been included by popular demand, but is not
\r
320 used by the FreeRTOS maintainers themselves. FreeRTOS is not
\r
321 responsible for resulting newlib operation. User must be familiar with
\r
322 newlib and must provide system-wide implementations of the necessary
\r
323 stubs. Be warned that (at the time of writing) the current newlib design
\r
324 implements a system-wide malloc() that must be provided with locks. */
\r
325 struct _reent xNewLib_reent;
\r
328 #if( configUSE_TASK_NOTIFICATIONS == 1 )
\r
329 volatile uint32_t ulNotifiedValue;
\r
330 volatile uint8_t ucNotifyState;
\r
333 #if( ( configSUPPORT_STATIC_ALLOCATION == 1 ) && ( configSUPPORT_DYNAMIC_ALLOCATION == 1 ) )
\r
334 uint8_t ucStaticallyAllocated; /* Set to pdTRUE if the task is a statically allocated to ensure no attempt is made to free the memory. */
\r
337 #if( INCLUDE_xTaskAbortDelay == 1 )
\r
338 uint8_t ucDelayAborted;
\r
343 /* The old tskTCB name is maintained above then typedefed to the new TCB_t name
\r
344 below to enable the use of older kernel aware debuggers. */
\r
345 typedef tskTCB TCB_t;
\r
347 /*lint -e956 A manual analysis and inspection has been used to determine which
\r
348 static variables must be declared volatile. */
\r
350 PRIVILEGED_DATA TCB_t * volatile pxCurrentTCB = NULL;
\r
352 /* Lists for ready and blocked tasks. --------------------*/
\r
353 PRIVILEGED_DATA static List_t pxReadyTasksLists[ configMAX_PRIORITIES ];/*< Prioritised ready tasks. */
\r
354 PRIVILEGED_DATA static List_t xDelayedTaskList1; /*< Delayed tasks. */
\r
355 PRIVILEGED_DATA static List_t xDelayedTaskList2; /*< Delayed tasks (two lists are used - one for delays that have overflowed the current tick count. */
\r
356 PRIVILEGED_DATA static List_t * volatile pxDelayedTaskList; /*< Points to the delayed task list currently being used. */
\r
357 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
358 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
360 #if( INCLUDE_vTaskDelete == 1 )
\r
362 PRIVILEGED_DATA static List_t xTasksWaitingTermination; /*< Tasks that have been deleted - but their memory not yet freed. */
\r
363 PRIVILEGED_DATA static volatile UBaseType_t uxDeletedTasksWaitingCleanUp = ( UBaseType_t ) 0U;
\r
367 #if ( INCLUDE_vTaskSuspend == 1 )
\r
369 PRIVILEGED_DATA static List_t xSuspendedTaskList; /*< Tasks that are currently suspended. */
\r
373 /* Other file private variables. --------------------------------*/
\r
374 PRIVILEGED_DATA static volatile UBaseType_t uxCurrentNumberOfTasks = ( UBaseType_t ) 0U;
\r
375 PRIVILEGED_DATA static volatile TickType_t xTickCount = ( TickType_t ) 0U;
\r
376 PRIVILEGED_DATA static volatile UBaseType_t uxTopReadyPriority = tskIDLE_PRIORITY;
\r
377 PRIVILEGED_DATA static volatile BaseType_t xSchedulerRunning = pdFALSE;
\r
378 PRIVILEGED_DATA static volatile UBaseType_t uxPendedTicks = ( UBaseType_t ) 0U;
\r
379 PRIVILEGED_DATA static volatile BaseType_t xYieldPending = pdFALSE;
\r
380 PRIVILEGED_DATA static volatile BaseType_t xNumOfOverflows = ( BaseType_t ) 0;
\r
381 PRIVILEGED_DATA static UBaseType_t uxTaskNumber = ( UBaseType_t ) 0U;
\r
382 PRIVILEGED_DATA static volatile TickType_t xNextTaskUnblockTime = ( TickType_t ) 0U; /* Initialised to portMAX_DELAY before the scheduler starts. */
\r
383 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
385 /* Context switches are held pending while the scheduler is suspended. Also,
\r
386 interrupts must not manipulate the xStateListItem of a TCB, or any of the
\r
387 lists the xStateListItem can be referenced from, if the scheduler is suspended.
\r
388 If an interrupt needs to unblock a task while the scheduler is suspended then it
\r
389 moves the task's event list item into the xPendingReadyList, ready for the
\r
390 kernel to move the task from the pending ready list into the real ready list
\r
391 when the scheduler is unsuspended. The pending ready list itself can only be
\r
392 accessed from a critical section. */
\r
393 PRIVILEGED_DATA static volatile UBaseType_t uxSchedulerSuspended = ( UBaseType_t ) pdFALSE;
\r
395 #if ( configGENERATE_RUN_TIME_STATS == 1 )
\r
397 PRIVILEGED_DATA static uint32_t ulTaskSwitchedInTime = 0UL; /*< Holds the value of a timer/counter the last time a task was switched in. */
\r
398 PRIVILEGED_DATA static uint32_t ulTotalRunTime = 0UL; /*< Holds the total amount of execution time as defined by the run time counter clock. */
\r
404 /*-----------------------------------------------------------*/
\r
406 /* Callback function prototypes. --------------------------*/
\r
407 #if( configCHECK_FOR_STACK_OVERFLOW > 0 )
\r
408 extern void vApplicationStackOverflowHook( TaskHandle_t xTask, char *pcTaskName );
\r
411 #if( configUSE_TICK_HOOK > 0 )
\r
412 extern void vApplicationTickHook( void );
\r
415 #if( configSUPPORT_STATIC_ALLOCATION == 1 )
\r
416 extern void vApplicationGetIdleTaskMemory( StaticTask_t **ppxIdleTaskTCBBuffer, StackType_t **ppxIdleTaskStackBuffer, uint16_t *pusIdleTaskStackSize );
\r
419 /* File private functions. --------------------------------*/
\r
422 * Utility task that simply returns pdTRUE if the task referenced by xTask is
\r
423 * currently in the Suspended state, or pdFALSE if the task referenced by xTask
\r
424 * is in any other state.
\r
426 #if ( INCLUDE_vTaskSuspend == 1 )
\r
427 static BaseType_t prvTaskIsTaskSuspended( const TaskHandle_t xTask ) PRIVILEGED_FUNCTION;
\r
428 #endif /* INCLUDE_vTaskSuspend */
\r
431 * Utility to ready all the lists used by the scheduler. This is called
\r
432 * automatically upon the creation of the first task.
\r
434 static void prvInitialiseTaskLists( void ) PRIVILEGED_FUNCTION;
\r
437 * The idle task, which as all tasks is implemented as a never ending loop.
\r
438 * The idle task is automatically created and added to the ready lists upon
\r
439 * creation of the first user task.
\r
441 * The portTASK_FUNCTION_PROTO() macro is used to allow port/compiler specific
\r
442 * language extensions. The equivalent prototype for this function is:
\r
444 * void prvIdleTask( void *pvParameters );
\r
447 static portTASK_FUNCTION_PROTO( prvIdleTask, pvParameters );
\r
450 * Utility to free all memory allocated by the scheduler to hold a TCB,
\r
451 * including the stack pointed to by the TCB.
\r
453 * This does not free memory allocated by the task itself (i.e. memory
\r
454 * allocated by calls to pvPortMalloc from within the tasks application code).
\r
456 #if ( INCLUDE_vTaskDelete == 1 )
\r
458 static void prvDeleteTCB( TCB_t *pxTCB ) PRIVILEGED_FUNCTION;
\r
463 * Used only by the idle task. This checks to see if anything has been placed
\r
464 * in the list of tasks waiting to be deleted. If so the task is cleaned up
\r
465 * and its TCB deleted.
\r
467 static void prvCheckTasksWaitingTermination( void ) PRIVILEGED_FUNCTION;
\r
470 * The currently executing task is entering the Blocked state. Add the task to
\r
471 * either the current or the overflow delayed task list.
\r
473 static void prvAddCurrentTaskToDelayedList( TickType_t xTicksToWait, const BaseType_t xCanBlockIndefinitely ) PRIVILEGED_FUNCTION;
\r
476 * Fills an TaskStatus_t structure with information on each task that is
\r
477 * referenced from the pxList list (which may be a ready list, a delayed list,
\r
478 * a suspended list, etc.).
\r
480 * THIS FUNCTION IS INTENDED FOR DEBUGGING ONLY, AND SHOULD NOT BE CALLED FROM
\r
481 * NORMAL APPLICATION CODE.
\r
483 #if ( configUSE_TRACE_FACILITY == 1 )
\r
485 static UBaseType_t prvListTasksWithinSingleList( TaskStatus_t *pxTaskStatusArray, List_t *pxList, eTaskState eState ) PRIVILEGED_FUNCTION;
\r
490 * Searches pxList for a task with name pcNameToQuery - returning a handle to
\r
491 * the task if it is found, or NULL if the task is not found.
\r
493 #if ( INCLUDE_xTaskGetTaskHandle == 1 )
\r
495 static TCB_t *prvSearchForNameWithinSingleList( List_t *pxList, const char pcNameToQuery[] ) PRIVILEGED_FUNCTION;
\r
500 * When a task is created, the stack of the task is filled with a known value.
\r
501 * This function determines the 'high water mark' of the task stack by
\r
502 * determining how much of the stack remains at the original preset value.
\r
504 #if ( ( configUSE_TRACE_FACILITY == 1 ) || ( INCLUDE_uxTaskGetStackHighWaterMark == 1 ) )
\r
506 static uint16_t prvTaskCheckFreeStackSpace( const uint8_t * pucStackByte ) PRIVILEGED_FUNCTION;
\r
511 * Return the amount of time, in ticks, that will pass before the kernel will
\r
512 * next move a task from the Blocked state to the Running state.
\r
514 * This conditional compilation should use inequality to 0, not equality to 1.
\r
515 * This is to ensure portSUPPRESS_TICKS_AND_SLEEP() can be called when user
\r
516 * defined low power mode implementations require configUSE_TICKLESS_IDLE to be
\r
517 * set to a value other than 1.
\r
519 #if ( configUSE_TICKLESS_IDLE != 0 )
\r
521 static TickType_t prvGetExpectedIdleTime( void ) PRIVILEGED_FUNCTION;
\r
526 * Set xNextTaskUnblockTime to the time at which the next Blocked state task
\r
527 * will exit the Blocked state.
\r
529 static void prvResetNextTaskUnblockTime( void );
\r
531 #if ( ( configUSE_TRACE_FACILITY == 1 ) && ( configUSE_STATS_FORMATTING_FUNCTIONS > 0 ) )
\r
534 * Helper function used to pad task names with spaces when printing out
\r
535 * human readable tables of task information.
\r
537 static char *prvWriteNameToBuffer( char *pcBuffer, const char *pcTaskName ) PRIVILEGED_FUNCTION;
\r
542 * Called after a Task_t structure has been allocated either statically or
\r
543 * dynamically to fill in the structure's members.
\r
545 static void prvInitialiseNewTask( TaskFunction_t pxTaskCode, const char * const pcName, const uint16_t usStackDepth, void * const pvParameters, UBaseType_t uxPriority, TaskHandle_t * const pxCreatedTask, TCB_t *pxNewTCB ) PRIVILEGED_FUNCTION; /*lint !e971 Unqualified char types are allowed for strings and single characters only. */
\r
548 * Called after a new task has been created and initialised to place the task
\r
549 * under the control of the scheduler.
\r
551 static void prvAddNewTaskToReadyList( TCB_t *pxNewTCB ) PRIVILEGED_FUNCTION;
\r
553 /*-----------------------------------------------------------*/
\r
555 #if( configSUPPORT_STATIC_ALLOCATION == 1 )
\r
557 BaseType_t xTaskCreateStatic( TaskFunction_t pxTaskCode, const char * const pcName, const uint16_t usStackDepth, void * const pvParameters, UBaseType_t uxPriority, TaskHandle_t * const pxCreatedTask, StackType_t * const puxStackBuffer, StaticTask_t * const pxTaskBuffer ) /*lint !e971 Unqualified char types are allowed for strings and single characters only. */
\r
560 BaseType_t xReturn;
\r
562 configASSERT( puxStackBuffer != NULL );
\r
563 configASSERT( pxTaskBuffer != NULL );
\r
565 if( ( pxTaskBuffer != NULL ) && ( puxStackBuffer != NULL ) )
\r
567 /* The memory used for the task's TCB and stack are passed into this
\r
568 function - use them. */
\r
569 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
570 pxNewTCB->pxStack = ( StackType_t * ) puxStackBuffer;
\r
572 #if( configSUPPORT_DYNAMIC_ALLOCATION == 1 )
\r
574 /* Tasks can be created statically or dynamically, so note this
\r
575 task was created statically in case the task is later deleted. */
\r
576 pxNewTCB->ucStaticallyAllocated = pdTRUE;
\r
578 #endif /* configSUPPORT_DYNAMIC_ALLOCATION */
\r
580 prvInitialiseNewTask( pxTaskCode, pcName, usStackDepth, pvParameters, uxPriority, pxCreatedTask, pxNewTCB );
\r
581 prvAddNewTaskToReadyList( pxNewTCB );
\r
586 xReturn = errCOULD_NOT_ALLOCATE_REQUIRED_MEMORY;
\r
592 #endif /* SUPPORT_STATIC_ALLOCATION */
\r
593 /*-----------------------------------------------------------*/
\r
595 #if( configSUPPORT_DYNAMIC_ALLOCATION == 1 )
\r
597 BaseType_t xTaskCreate( TaskFunction_t pxTaskCode, const char * const pcName, const uint16_t usStackDepth, void * const pvParameters, UBaseType_t uxPriority, TaskHandle_t * const pxCreatedTask ) /*lint !e971 Unqualified char types are allowed for strings and single characters only. */
\r
600 BaseType_t xReturn;
\r
602 /* If the stack grows down then allocate the stack then the TCB so the stack
\r
603 does not grow into the TCB. Likewise if the stack grows up then allocate
\r
604 the TCB then the stack. */
\r
605 #if( portSTACK_GROWTH > 0 )
\r
607 /* Allocate space for the TCB. Where the memory comes from depends on
\r
608 the implementation of the port malloc function and whether or not static
\r
609 allocation is being used. */
\r
610 pxNewTCB = ( TCB_t * ) pvPortMalloc( sizeof( TCB_t ) );
\r
612 if( pxNewTCB != NULL )
\r
614 /* Allocate space for the stack used by the task being created.
\r
615 The base of the stack memory stored in the TCB so the task can
\r
616 be deleted later if required. */
\r
617 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
619 if( pxNewTCB->pxStack == NULL )
\r
621 /* Could not allocate the stack. Delete the allocated TCB. */
\r
622 vPortFree( pxNewTCB );
\r
627 #else /* portSTACK_GROWTH */
\r
629 StackType_t *pxStack;
\r
631 /* Allocate space for the stack used by the task being created. */
\r
632 pxStack = ( StackType_t * ) pvPortMalloc( ( ( ( size_t ) usStackDepth ) * sizeof( StackType_t ) ) ); /*lint !e961 MISRA exception as the casts are only redundant for some ports. */
\r
634 if( pxStack != NULL )
\r
636 /* Allocate space for the TCB. */
\r
637 pxNewTCB = ( TCB_t * ) pvPortMalloc( sizeof( TCB_t ) ); /*lint !e961 MISRA exception as the casts are only redundant for some paths. */
\r
639 if( pxNewTCB != NULL )
\r
641 /* Store the stack location in the TCB. */
\r
642 pxNewTCB->pxStack = pxStack;
\r
646 /* The stack cannot be used as the TCB was not created. Free
\r
648 vPortFree( pxStack );
\r
656 #endif /* portSTACK_GROWTH */
\r
658 if( pxNewTCB != NULL )
\r
660 #if( configSUPPORT_STATIC_ALLOCATION == 1 )
\r
662 /* Tasks can be created statically or dynamically, so note this
\r
663 task was created dynamically in case it is later deleted. */
\r
664 pxNewTCB->ucStaticallyAllocated = pdFALSE;
\r
666 #endif /* configSUPPORT_STATIC_ALLOCATION */
\r
668 prvInitialiseNewTask( pxTaskCode, pcName, usStackDepth, pvParameters, uxPriority, pxCreatedTask, pxNewTCB );
\r
669 prvAddNewTaskToReadyList( pxNewTCB );
\r
674 xReturn = errCOULD_NOT_ALLOCATE_REQUIRED_MEMORY;
\r
680 #endif /* configSUPPORT_DYNAMIC_ALLOCATION */
\r
681 /*-----------------------------------------------------------*/
\r
683 static void prvInitialiseNewTask( TaskFunction_t pxTaskCode, const char * const pcName, const uint16_t usStackDepth, void * const pvParameters, UBaseType_t uxPriority, TaskHandle_t * const pxCreatedTask, TCB_t *pxNewTCB ) /*lint !e971 Unqualified char types are allowed for strings and single characters only. */
\r
685 StackType_t *pxTopOfStack;
\r
688 #if( portUSING_MPU_WRAPPERS == 1 )
\r
689 /* Should the task be created in privileged mode? */
\r
690 BaseType_t xRunPrivileged;
\r
691 if( ( uxPriority & portPRIVILEGE_BIT ) != 0U )
\r
693 xRunPrivileged = pdTRUE;
\r
697 xRunPrivileged = pdFALSE;
\r
699 uxPriority &= ~portPRIVILEGE_BIT;
\r
700 #endif /* portUSING_MPU_WRAPPERS == 1 */
\r
702 /* Avoid dependency on memset() if it is not required. */
\r
703 #if( ( configCHECK_FOR_STACK_OVERFLOW > 1 ) || ( configUSE_TRACE_FACILITY == 1 ) || ( INCLUDE_uxTaskGetStackHighWaterMark == 1 ) )
\r
705 /* Fill the stack with a known value to assist debugging. */
\r
706 ( void ) memset( pxNewTCB->pxStack, ( int ) tskSTACK_FILL_BYTE, ( size_t ) usStackDepth * sizeof( StackType_t ) );
\r
708 #endif /* ( ( configCHECK_FOR_STACK_OVERFLOW > 1 ) || ( ( configUSE_TRACE_FACILITY == 1 ) || ( INCLUDE_uxTaskGetStackHighWaterMark == 1 ) ) ) */
\r
710 /* Calculate the top of stack address. This depends on whether the stack
\r
711 grows from high memory to low (as per the 80x86) or vice versa.
\r
712 portSTACK_GROWTH is used to make the result positive or negative as required
\r
714 #if( portSTACK_GROWTH < 0 )
\r
716 pxTopOfStack = pxNewTCB->pxStack + ( usStackDepth - ( uint16_t ) 1 );
\r
717 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
719 /* Check the alignment of the calculated top of stack is correct. */
\r
720 configASSERT( ( ( ( portPOINTER_SIZE_TYPE ) pxTopOfStack & ( portPOINTER_SIZE_TYPE ) portBYTE_ALIGNMENT_MASK ) == 0UL ) );
\r
722 #else /* portSTACK_GROWTH */
\r
724 pxTopOfStack = pxNewTCB->pxStack;
\r
726 /* Check the alignment of the stack buffer is correct. */
\r
727 configASSERT( ( ( ( portPOINTER_SIZE_TYPE ) pxNewTCB->pxStack & ( portPOINTER_SIZE_TYPE ) portBYTE_ALIGNMENT_MASK ) == 0UL ) );
\r
729 /* The other extreme of the stack space is required if stack checking is
\r
731 pxNewTCB->pxEndOfStack = pxNewTCB->pxStack + ( usStackDepth - ( uint16_t ) 1 );
\r
733 #endif /* portSTACK_GROWTH */
\r
735 /* Store the task name in the TCB. */
\r
736 for( x = ( UBaseType_t ) 0; x < ( UBaseType_t ) configMAX_TASK_NAME_LEN; x++ )
\r
738 pxNewTCB->pcTaskName[ x ] = pcName[ x ];
\r
740 /* Don't copy all configMAX_TASK_NAME_LEN if the string is shorter than
\r
741 configMAX_TASK_NAME_LEN characters just in case the memory after the
\r
742 string is not accessible (extremely unlikely). */
\r
743 if( pcName[ x ] == 0x00 )
\r
749 mtCOVERAGE_TEST_MARKER();
\r
753 /* Ensure the name string is terminated in the case that the string length
\r
754 was greater or equal to configMAX_TASK_NAME_LEN. */
\r
755 pxNewTCB->pcTaskName[ configMAX_TASK_NAME_LEN - 1 ] = '\0';
\r
757 /* This is used as an array index so must ensure it's not too large. First
\r
758 remove the privilege bit if one is present. */
\r
759 if( uxPriority >= ( UBaseType_t ) configMAX_PRIORITIES )
\r
761 uxPriority = ( UBaseType_t ) configMAX_PRIORITIES - ( UBaseType_t ) 1U;
\r
765 mtCOVERAGE_TEST_MARKER();
\r
768 pxNewTCB->uxPriority = uxPriority;
\r
769 #if ( configUSE_MUTEXES == 1 )
\r
771 pxNewTCB->uxBasePriority = uxPriority;
\r
772 pxNewTCB->uxMutexesHeld = 0;
\r
774 #endif /* configUSE_MUTEXES */
\r
776 vListInitialiseItem( &( pxNewTCB->xStateListItem ) );
\r
777 vListInitialiseItem( &( pxNewTCB->xEventListItem ) );
\r
779 /* Set the pxNewTCB as a link back from the ListItem_t. This is so we can get
\r
780 back to the containing TCB from a generic item in a list. */
\r
781 listSET_LIST_ITEM_OWNER( &( pxNewTCB->xStateListItem ), pxNewTCB );
\r
783 /* Event lists are always in priority order. */
\r
784 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
785 listSET_LIST_ITEM_OWNER( &( pxNewTCB->xEventListItem ), pxNewTCB );
\r
787 #if ( portCRITICAL_NESTING_IN_TCB == 1 )
\r
789 pxNewTCB->uxCriticalNesting = ( UBaseType_t ) 0U;
\r
791 #endif /* portCRITICAL_NESTING_IN_TCB */
\r
793 #if ( configUSE_APPLICATION_TASK_TAG == 1 )
\r
795 pxNewTCB->pxTaskTag = NULL;
\r
797 #endif /* configUSE_APPLICATION_TASK_TAG */
\r
799 #if ( configGENERATE_RUN_TIME_STATS == 1 )
\r
801 pxNewTCB->ulRunTimeCounter = 0UL;
\r
803 #endif /* configGENERATE_RUN_TIME_STATS */
\r
805 #if ( portUSING_MPU_WRAPPERS == 1 )
\r
807 vPortStoreTaskMPUSettings( &( pxNewTCB->xMPUSettings ), xRegions, pxNewTCB->pxStack, usStackDepth );
\r
811 #if( configNUM_THREAD_LOCAL_STORAGE_POINTERS != 0 )
\r
813 for( x = 0; x < ( UBaseType_t ) configNUM_THREAD_LOCAL_STORAGE_POINTERS; x++ )
\r
815 pxNewTCB->pvThreadLocalStoragePointers[ x ] = NULL;
\r
820 #if ( configUSE_TASK_NOTIFICATIONS == 1 )
\r
822 pxNewTCB->ulNotifiedValue = 0;
\r
823 pxNewTCB->ucNotifyState = taskNOT_WAITING_NOTIFICATION;
\r
827 #if ( configUSE_NEWLIB_REENTRANT == 1 )
\r
829 /* Initialise this task's Newlib reent structure. */
\r
830 _REENT_INIT_PTR( ( &( pxNewTCB->xNewLib_reent ) ) );
\r
834 #if( INCLUDE_xTaskAbortDelay == 1 )
\r
836 pxNewTCB->ucDelayAborted = pdFALSE;
\r
840 /* Initialize the TCB stack to look as if the task was already running,
\r
841 but had been interrupted by the scheduler. The return address is set
\r
842 to the start of the task function. Once the stack has been initialised
\r
843 the top of stack variable is updated. */
\r
844 #if( portUSING_MPU_WRAPPERS == 1 )
\r
846 pxNewTCB->pxTopOfStack = pxPortInitialiseStack( pxTopOfStack, pxTaskCode, pvParameters, xRunPrivileged );
\r
848 #else /* portUSING_MPU_WRAPPERS */
\r
850 pxNewTCB->pxTopOfStack = pxPortInitialiseStack( pxTopOfStack, pxTaskCode, pvParameters );
\r
852 #endif /* portUSING_MPU_WRAPPERS */
\r
854 if( ( void * ) pxCreatedTask != NULL )
\r
856 /* Pass the handle out in an anonymous way. The handle can be used to
\r
857 change the created task's priority, delete the created task, etc.*/
\r
858 *pxCreatedTask = ( TaskHandle_t ) pxNewTCB;
\r
862 mtCOVERAGE_TEST_MARKER();
\r
865 /*-----------------------------------------------------------*/
\r
867 static void prvAddNewTaskToReadyList( TCB_t *pxNewTCB )
\r
869 /* Ensure interrupts don't access the task lists while the lists are being
\r
871 taskENTER_CRITICAL();
\r
873 uxCurrentNumberOfTasks++;
\r
874 if( pxCurrentTCB == NULL )
\r
876 /* There are no other tasks, or all the other tasks are in
\r
877 the suspended state - make this the current task. */
\r
878 pxCurrentTCB = pxNewTCB;
\r
880 if( uxCurrentNumberOfTasks == ( UBaseType_t ) 1 )
\r
882 /* This is the first task to be created so do the preliminary
\r
883 initialisation required. We will not recover if this call
\r
884 fails, but we will report the failure. */
\r
885 prvInitialiseTaskLists();
\r
889 mtCOVERAGE_TEST_MARKER();
\r
894 /* If the scheduler is not already running, make this task the
\r
895 current task if it is the highest priority task to be created
\r
897 if( xSchedulerRunning == pdFALSE )
\r
899 if( pxCurrentTCB->uxPriority <= pxNewTCB->uxPriority )
\r
901 pxCurrentTCB = pxNewTCB;
\r
905 mtCOVERAGE_TEST_MARKER();
\r
910 mtCOVERAGE_TEST_MARKER();
\r
916 #if ( configUSE_TRACE_FACILITY == 1 )
\r
918 /* Add a counter into the TCB for tracing only. */
\r
919 pxNewTCB->uxTCBNumber = uxTaskNumber;
\r
921 #endif /* configUSE_TRACE_FACILITY */
\r
922 traceTASK_CREATE( pxNewTCB );
\r
924 prvAddTaskToReadyList( pxNewTCB );
\r
926 portSETUP_TCB( pxNewTCB );
\r
928 taskEXIT_CRITICAL();
\r
930 if( xSchedulerRunning != pdFALSE )
\r
932 /* If the created task is of a higher priority than the current task
\r
933 then it should run now. */
\r
934 if( pxCurrentTCB->uxPriority < pxNewTCB->uxPriority )
\r
936 taskYIELD_IF_USING_PREEMPTION();
\r
940 mtCOVERAGE_TEST_MARKER();
\r
945 mtCOVERAGE_TEST_MARKER();
\r
948 /*-----------------------------------------------------------*/
\r
950 #if ( INCLUDE_vTaskDelete == 1 )
\r
952 void vTaskDelete( TaskHandle_t xTaskToDelete )
\r
956 taskENTER_CRITICAL();
\r
958 /* If null is passed in here then it is the calling task that is
\r
960 pxTCB = prvGetTCBFromHandle( xTaskToDelete );
\r
962 /* Remove task from the ready list. */
\r
963 if( uxListRemove( &( pxTCB->xStateListItem ) ) == ( UBaseType_t ) 0 )
\r
965 taskRESET_READY_PRIORITY( pxTCB->uxPriority );
\r
969 mtCOVERAGE_TEST_MARKER();
\r
972 /* Is the task waiting on an event also? */
\r
973 if( listLIST_ITEM_CONTAINER( &( pxTCB->xEventListItem ) ) != NULL )
\r
975 ( void ) uxListRemove( &( pxTCB->xEventListItem ) );
\r
979 mtCOVERAGE_TEST_MARKER();
\r
982 if( pxTCB == pxCurrentTCB )
\r
984 /* A task is deleting itself. This cannot complete within the
\r
985 task itself, as a context switch to another task is required.
\r
986 Place the task in the termination list. The idle task will
\r
987 check the termination list and free up any memory allocated by
\r
988 the scheduler for the TCB and stack of the deleted task. */
\r
989 vListInsertEnd( &xTasksWaitingTermination, &( pxTCB->xStateListItem ) );
\r
991 /* Increment the ucTasksDeleted variable so the idle task knows
\r
992 there is a task that has been deleted and that it should therefore
\r
993 check the xTasksWaitingTermination list. */
\r
994 ++uxDeletedTasksWaitingCleanUp;
\r
998 --uxCurrentNumberOfTasks;
\r
999 prvDeleteTCB( pxTCB );
\r
1002 /* Increment the uxTaskNumber also so kernel aware debuggers can
\r
1003 detect that the task lists need re-generating. */
\r
1006 traceTASK_DELETE( pxTCB );
\r
1008 taskEXIT_CRITICAL();
\r
1010 /* Force a reschedule if it is the currently running task that has just
\r
1012 if( xSchedulerRunning != pdFALSE )
\r
1014 if( pxTCB == pxCurrentTCB )
\r
1016 configASSERT( uxSchedulerSuspended == 0 );
\r
1018 /* The pre-delete hook is primarily for the Windows simulator,
\r
1019 in which Windows specific clean up operations are performed,
\r
1020 after which it is not possible to yield away from this task -
\r
1021 hence xYieldPending is used to latch that a context switch is
\r
1023 portPRE_TASK_DELETE_HOOK( pxTCB, &xYieldPending );
\r
1024 portYIELD_WITHIN_API();
\r
1028 /* Reset the next expected unblock time in case it referred to
\r
1029 the task that has just been deleted. */
\r
1030 taskENTER_CRITICAL();
\r
1032 prvResetNextTaskUnblockTime();
\r
1034 taskEXIT_CRITICAL();
\r
1039 #endif /* INCLUDE_vTaskDelete */
\r
1040 /*-----------------------------------------------------------*/
\r
1042 #if ( INCLUDE_vTaskDelayUntil == 1 )
\r
1044 void vTaskDelayUntil( TickType_t * const pxPreviousWakeTime, const TickType_t xTimeIncrement )
\r
1046 TickType_t xTimeToWake;
\r
1047 BaseType_t xAlreadyYielded, xShouldDelay = pdFALSE;
\r
1049 configASSERT( pxPreviousWakeTime );
\r
1050 configASSERT( ( xTimeIncrement > 0U ) );
\r
1051 configASSERT( uxSchedulerSuspended == 0 );
\r
1053 vTaskSuspendAll();
\r
1055 /* Minor optimisation. The tick count cannot change in this
\r
1057 const TickType_t xConstTickCount = xTickCount;
\r
1059 /* Generate the tick time at which the task wants to wake. */
\r
1060 xTimeToWake = *pxPreviousWakeTime + xTimeIncrement;
\r
1062 if( xConstTickCount < *pxPreviousWakeTime )
\r
1064 /* The tick count has overflowed since this function was
\r
1065 lasted called. In this case the only time we should ever
\r
1066 actually delay is if the wake time has also overflowed,
\r
1067 and the wake time is greater than the tick time. When this
\r
1068 is the case it is as if neither time had overflowed. */
\r
1069 if( ( xTimeToWake < *pxPreviousWakeTime ) && ( xTimeToWake > xConstTickCount ) )
\r
1071 xShouldDelay = pdTRUE;
\r
1075 mtCOVERAGE_TEST_MARKER();
\r
1080 /* The tick time has not overflowed. In this case we will
\r
1081 delay if either the wake time has overflowed, and/or the
\r
1082 tick time is less than the wake time. */
\r
1083 if( ( xTimeToWake < *pxPreviousWakeTime ) || ( xTimeToWake > xConstTickCount ) )
\r
1085 xShouldDelay = pdTRUE;
\r
1089 mtCOVERAGE_TEST_MARKER();
\r
1093 /* Update the wake time ready for the next call. */
\r
1094 *pxPreviousWakeTime = xTimeToWake;
\r
1096 if( xShouldDelay != pdFALSE )
\r
1098 traceTASK_DELAY_UNTIL( xTimeToWake );
\r
1100 /* prvAddCurrentTaskToDelayedList() needs the block time, not
\r
1101 the time to wake, so subtract the current tick count. */
\r
1102 prvAddCurrentTaskToDelayedList( xTimeToWake - xConstTickCount, pdFALSE );
\r
1106 mtCOVERAGE_TEST_MARKER();
\r
1109 xAlreadyYielded = xTaskResumeAll();
\r
1111 /* Force a reschedule if xTaskResumeAll has not already done so, we may
\r
1112 have put ourselves to sleep. */
\r
1113 if( xAlreadyYielded == pdFALSE )
\r
1115 portYIELD_WITHIN_API();
\r
1119 mtCOVERAGE_TEST_MARKER();
\r
1123 #endif /* INCLUDE_vTaskDelayUntil */
\r
1124 /*-----------------------------------------------------------*/
\r
1126 #if ( INCLUDE_vTaskDelay == 1 )
\r
1128 void vTaskDelay( const TickType_t xTicksToDelay )
\r
1130 BaseType_t xAlreadyYielded = pdFALSE;
\r
1132 /* A delay time of zero just forces a reschedule. */
\r
1133 if( xTicksToDelay > ( TickType_t ) 0U )
\r
1135 configASSERT( uxSchedulerSuspended == 0 );
\r
1136 vTaskSuspendAll();
\r
1138 traceTASK_DELAY();
\r
1140 /* A task that is removed from the event list while the
\r
1141 scheduler is suspended will not get placed in the ready
\r
1142 list or removed from the blocked list until the scheduler
\r
1145 This task cannot be in an event list as it is the currently
\r
1146 executing task. */
\r
1147 prvAddCurrentTaskToDelayedList( xTicksToDelay, pdFALSE );
\r
1149 xAlreadyYielded = xTaskResumeAll();
\r
1153 mtCOVERAGE_TEST_MARKER();
\r
1156 /* Force a reschedule if xTaskResumeAll has not already done so, we may
\r
1157 have put ourselves to sleep. */
\r
1158 if( xAlreadyYielded == pdFALSE )
\r
1160 portYIELD_WITHIN_API();
\r
1164 mtCOVERAGE_TEST_MARKER();
\r
1168 #endif /* INCLUDE_vTaskDelay */
\r
1169 /*-----------------------------------------------------------*/
\r
1171 #if( ( INCLUDE_eTaskGetState == 1 ) || ( configUSE_TRACE_FACILITY == 1 ) )
\r
1173 eTaskState eTaskGetState( TaskHandle_t xTask )
\r
1175 eTaskState eReturn;
\r
1176 List_t *pxStateList;
\r
1177 const TCB_t * const pxTCB = ( TCB_t * ) xTask;
\r
1179 configASSERT( pxTCB );
\r
1181 if( pxTCB == pxCurrentTCB )
\r
1183 /* The task calling this function is querying its own state. */
\r
1184 eReturn = eRunning;
\r
1188 taskENTER_CRITICAL();
\r
1190 pxStateList = ( List_t * ) listLIST_ITEM_CONTAINER( &( pxTCB->xStateListItem ) );
\r
1192 taskEXIT_CRITICAL();
\r
1194 if( ( pxStateList == pxDelayedTaskList ) || ( pxStateList == pxOverflowDelayedTaskList ) )
\r
1196 /* The task being queried is referenced from one of the Blocked
\r
1198 eReturn = eBlocked;
\r
1201 #if ( INCLUDE_vTaskSuspend == 1 )
\r
1202 else if( pxStateList == &xSuspendedTaskList )
\r
1204 /* The task being queried is referenced from the suspended
\r
1205 list. Is it genuinely suspended or is it block
\r
1207 if( listLIST_ITEM_CONTAINER( &( pxTCB->xEventListItem ) ) == NULL )
\r
1209 eReturn = eSuspended;
\r
1213 eReturn = eBlocked;
\r
1218 #if ( INCLUDE_vTaskDelete == 1 )
\r
1219 else if( ( pxStateList == &xTasksWaitingTermination ) || ( pxStateList == NULL ) )
\r
1221 /* The task being queried is referenced from the deleted
\r
1222 tasks list, or it is not referenced from any lists at
\r
1224 eReturn = eDeleted;
\r
1228 else /*lint !e525 Negative indentation is intended to make use of pre-processor clearer. */
\r
1230 /* If the task is not in any other state, it must be in the
\r
1231 Ready (including pending ready) state. */
\r
1237 } /*lint !e818 xTask cannot be a pointer to const because it is a typedef. */
\r
1239 #endif /* INCLUDE_eTaskGetState */
\r
1240 /*-----------------------------------------------------------*/
\r
1242 #if ( INCLUDE_uxTaskPriorityGet == 1 )
\r
1244 UBaseType_t uxTaskPriorityGet( TaskHandle_t xTask )
\r
1247 UBaseType_t uxReturn;
\r
1249 taskENTER_CRITICAL();
\r
1251 /* If null is passed in here then it is the priority of the that
\r
1252 called uxTaskPriorityGet() that is being queried. */
\r
1253 pxTCB = prvGetTCBFromHandle( xTask );
\r
1254 uxReturn = pxTCB->uxPriority;
\r
1256 taskEXIT_CRITICAL();
\r
1261 #endif /* INCLUDE_uxTaskPriorityGet */
\r
1262 /*-----------------------------------------------------------*/
\r
1264 #if ( INCLUDE_uxTaskPriorityGet == 1 )
\r
1266 UBaseType_t uxTaskPriorityGetFromISR( TaskHandle_t xTask )
\r
1269 UBaseType_t uxReturn, uxSavedInterruptState;
\r
1271 /* RTOS ports that support interrupt nesting have the concept of a
\r
1272 maximum system call (or maximum API call) interrupt priority.
\r
1273 Interrupts that are above the maximum system call priority are keep
\r
1274 permanently enabled, even when the RTOS kernel is in a critical section,
\r
1275 but cannot make any calls to FreeRTOS API functions. If configASSERT()
\r
1276 is defined in FreeRTOSConfig.h then
\r
1277 portASSERT_IF_INTERRUPT_PRIORITY_INVALID() will result in an assertion
\r
1278 failure if a FreeRTOS API function is called from an interrupt that has
\r
1279 been assigned a priority above the configured maximum system call
\r
1280 priority. Only FreeRTOS functions that end in FromISR can be called
\r
1281 from interrupts that have been assigned a priority at or (logically)
\r
1282 below the maximum system call interrupt priority. FreeRTOS maintains a
\r
1283 separate interrupt safe API to ensure interrupt entry is as fast and as
\r
1284 simple as possible. More information (albeit Cortex-M specific) is
\r
1285 provided on the following link:
\r
1286 http://www.freertos.org/RTOS-Cortex-M3-M4.html */
\r
1287 portASSERT_IF_INTERRUPT_PRIORITY_INVALID();
\r
1289 uxSavedInterruptState = portSET_INTERRUPT_MASK_FROM_ISR();
\r
1291 /* If null is passed in here then it is the priority of the calling
\r
1292 task that is being queried. */
\r
1293 pxTCB = prvGetTCBFromHandle( xTask );
\r
1294 uxReturn = pxTCB->uxPriority;
\r
1296 portCLEAR_INTERRUPT_MASK_FROM_ISR( uxSavedInterruptState );
\r
1301 #endif /* INCLUDE_uxTaskPriorityGet */
\r
1302 /*-----------------------------------------------------------*/
\r
1304 #if ( INCLUDE_vTaskPrioritySet == 1 )
\r
1306 void vTaskPrioritySet( TaskHandle_t xTask, UBaseType_t uxNewPriority )
\r
1309 UBaseType_t uxCurrentBasePriority, uxPriorityUsedOnEntry;
\r
1310 BaseType_t xYieldRequired = pdFALSE;
\r
1312 configASSERT( ( uxNewPriority < configMAX_PRIORITIES ) );
\r
1314 /* Ensure the new priority is valid. */
\r
1315 if( uxNewPriority >= ( UBaseType_t ) configMAX_PRIORITIES )
\r
1317 uxNewPriority = ( UBaseType_t ) configMAX_PRIORITIES - ( UBaseType_t ) 1U;
\r
1321 mtCOVERAGE_TEST_MARKER();
\r
1324 taskENTER_CRITICAL();
\r
1326 /* If null is passed in here then it is the priority of the calling
\r
1327 task that is being changed. */
\r
1328 pxTCB = prvGetTCBFromHandle( xTask );
\r
1330 traceTASK_PRIORITY_SET( pxTCB, uxNewPriority );
\r
1332 #if ( configUSE_MUTEXES == 1 )
\r
1334 uxCurrentBasePriority = pxTCB->uxBasePriority;
\r
1338 uxCurrentBasePriority = pxTCB->uxPriority;
\r
1342 if( uxCurrentBasePriority != uxNewPriority )
\r
1344 /* The priority change may have readied a task of higher
\r
1345 priority than the calling task. */
\r
1346 if( uxNewPriority > uxCurrentBasePriority )
\r
1348 if( pxTCB != pxCurrentTCB )
\r
1350 /* The priority of a task other than the currently
\r
1351 running task is being raised. Is the priority being
\r
1352 raised above that of the running task? */
\r
1353 if( uxNewPriority >= pxCurrentTCB->uxPriority )
\r
1355 xYieldRequired = pdTRUE;
\r
1359 mtCOVERAGE_TEST_MARKER();
\r
1364 /* The priority of the running task is being raised,
\r
1365 but the running task must already be the highest
\r
1366 priority task able to run so no yield is required. */
\r
1369 else if( pxTCB == pxCurrentTCB )
\r
1371 /* Setting the priority of the running task down means
\r
1372 there may now be another task of higher priority that
\r
1373 is ready to execute. */
\r
1374 xYieldRequired = pdTRUE;
\r
1378 /* Setting the priority of any other task down does not
\r
1379 require a yield as the running task must be above the
\r
1380 new priority of the task being modified. */
\r
1383 /* Remember the ready list the task might be referenced from
\r
1384 before its uxPriority member is changed so the
\r
1385 taskRESET_READY_PRIORITY() macro can function correctly. */
\r
1386 uxPriorityUsedOnEntry = pxTCB->uxPriority;
\r
1388 #if ( configUSE_MUTEXES == 1 )
\r
1390 /* Only change the priority being used if the task is not
\r
1391 currently using an inherited priority. */
\r
1392 if( pxTCB->uxBasePriority == pxTCB->uxPriority )
\r
1394 pxTCB->uxPriority = uxNewPriority;
\r
1398 mtCOVERAGE_TEST_MARKER();
\r
1401 /* The base priority gets set whatever. */
\r
1402 pxTCB->uxBasePriority = uxNewPriority;
\r
1406 pxTCB->uxPriority = uxNewPriority;
\r
1410 /* Only reset the event list item value if the value is not
\r
1411 being used for anything else. */
\r
1412 if( ( listGET_LIST_ITEM_VALUE( &( pxTCB->xEventListItem ) ) & taskEVENT_LIST_ITEM_VALUE_IN_USE ) == 0UL )
\r
1414 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
1418 mtCOVERAGE_TEST_MARKER();
\r
1421 /* If the task is in the blocked or suspended list we need do
\r
1422 nothing more than change it's priority variable. However, if
\r
1423 the task is in a ready list it needs to be removed and placed
\r
1424 in the list appropriate to its new priority. */
\r
1425 if( listIS_CONTAINED_WITHIN( &( pxReadyTasksLists[ uxPriorityUsedOnEntry ] ), &( pxTCB->xStateListItem ) ) != pdFALSE )
\r
1427 /* The task is currently in its ready list - remove before adding
\r
1428 it to it's new ready list. As we are in a critical section we
\r
1429 can do this even if the scheduler is suspended. */
\r
1430 if( uxListRemove( &( pxTCB->xStateListItem ) ) == ( UBaseType_t ) 0 )
\r
1432 /* It is known that the task is in its ready list so
\r
1433 there is no need to check again and the port level
\r
1434 reset macro can be called directly. */
\r
1435 portRESET_READY_PRIORITY( uxPriorityUsedOnEntry, uxTopReadyPriority );
\r
1439 mtCOVERAGE_TEST_MARKER();
\r
1441 prvAddTaskToReadyList( pxTCB );
\r
1445 mtCOVERAGE_TEST_MARKER();
\r
1448 if( xYieldRequired != pdFALSE )
\r
1450 taskYIELD_IF_USING_PREEMPTION();
\r
1454 mtCOVERAGE_TEST_MARKER();
\r
1457 /* Remove compiler warning about unused variables when the port
\r
1458 optimised task selection is not being used. */
\r
1459 ( void ) uxPriorityUsedOnEntry;
\r
1462 taskEXIT_CRITICAL();
\r
1465 #endif /* INCLUDE_vTaskPrioritySet */
\r
1466 /*-----------------------------------------------------------*/
\r
1468 #if ( INCLUDE_vTaskSuspend == 1 )
\r
1470 void vTaskSuspend( TaskHandle_t xTaskToSuspend )
\r
1474 taskENTER_CRITICAL();
\r
1476 /* If null is passed in here then it is the running task that is
\r
1477 being suspended. */
\r
1478 pxTCB = prvGetTCBFromHandle( xTaskToSuspend );
\r
1480 traceTASK_SUSPEND( pxTCB );
\r
1482 /* Remove task from the ready/delayed list and place in the
\r
1483 suspended list. */
\r
1484 if( uxListRemove( &( pxTCB->xStateListItem ) ) == ( UBaseType_t ) 0 )
\r
1486 taskRESET_READY_PRIORITY( pxTCB->uxPriority );
\r
1490 mtCOVERAGE_TEST_MARKER();
\r
1493 /* Is the task waiting on an event also? */
\r
1494 if( listLIST_ITEM_CONTAINER( &( pxTCB->xEventListItem ) ) != NULL )
\r
1496 ( void ) uxListRemove( &( pxTCB->xEventListItem ) );
\r
1500 mtCOVERAGE_TEST_MARKER();
\r
1503 vListInsertEnd( &xSuspendedTaskList, &( pxTCB->xStateListItem ) );
\r
1505 taskEXIT_CRITICAL();
\r
1507 if( xSchedulerRunning != pdFALSE )
\r
1509 /* Reset the next expected unblock time in case it referred to the
\r
1510 task that is now in the Suspended state. */
\r
1511 taskENTER_CRITICAL();
\r
1513 prvResetNextTaskUnblockTime();
\r
1515 taskEXIT_CRITICAL();
\r
1519 mtCOVERAGE_TEST_MARKER();
\r
1522 if( pxTCB == pxCurrentTCB )
\r
1524 if( xSchedulerRunning != pdFALSE )
\r
1526 /* The current task has just been suspended. */
\r
1527 configASSERT( uxSchedulerSuspended == 0 );
\r
1528 portYIELD_WITHIN_API();
\r
1532 /* The scheduler is not running, but the task that was pointed
\r
1533 to by pxCurrentTCB has just been suspended and pxCurrentTCB
\r
1534 must be adjusted to point to a different task. */
\r
1535 if( listCURRENT_LIST_LENGTH( &xSuspendedTaskList ) == uxCurrentNumberOfTasks )
\r
1537 /* No other tasks are ready, so set pxCurrentTCB back to
\r
1538 NULL so when the next task is created pxCurrentTCB will
\r
1539 be set to point to it no matter what its relative priority
\r
1541 pxCurrentTCB = NULL;
\r
1545 vTaskSwitchContext();
\r
1551 mtCOVERAGE_TEST_MARKER();
\r
1555 #endif /* INCLUDE_vTaskSuspend */
\r
1556 /*-----------------------------------------------------------*/
\r
1558 #if ( INCLUDE_vTaskSuspend == 1 )
\r
1560 static BaseType_t prvTaskIsTaskSuspended( const TaskHandle_t xTask )
\r
1562 BaseType_t xReturn = pdFALSE;
\r
1563 const TCB_t * const pxTCB = ( TCB_t * ) xTask;
\r
1565 /* Accesses xPendingReadyList so must be called from a critical
\r
1568 /* It does not make sense to check if the calling task is suspended. */
\r
1569 configASSERT( xTask );
\r
1571 /* Is the task being resumed actually in the suspended list? */
\r
1572 if( listIS_CONTAINED_WITHIN( &xSuspendedTaskList, &( pxTCB->xStateListItem ) ) != pdFALSE )
\r
1574 /* Has the task already been resumed from within an ISR? */
\r
1575 if( listIS_CONTAINED_WITHIN( &xPendingReadyList, &( pxTCB->xEventListItem ) ) == pdFALSE )
\r
1577 /* Is it in the suspended list because it is in the Suspended
\r
1578 state, or because is is blocked with no timeout? */
\r
1579 if( listIS_CONTAINED_WITHIN( NULL, &( pxTCB->xEventListItem ) ) != pdFALSE )
\r
1585 mtCOVERAGE_TEST_MARKER();
\r
1590 mtCOVERAGE_TEST_MARKER();
\r
1595 mtCOVERAGE_TEST_MARKER();
\r
1599 } /*lint !e818 xTask cannot be a pointer to const because it is a typedef. */
\r
1601 #endif /* INCLUDE_vTaskSuspend */
\r
1602 /*-----------------------------------------------------------*/
\r
1604 #if ( INCLUDE_vTaskSuspend == 1 )
\r
1606 void vTaskResume( TaskHandle_t xTaskToResume )
\r
1608 TCB_t * const pxTCB = ( TCB_t * ) xTaskToResume;
\r
1610 /* It does not make sense to resume the calling task. */
\r
1611 configASSERT( xTaskToResume );
\r
1613 /* The parameter cannot be NULL as it is impossible to resume the
\r
1614 currently executing task. */
\r
1615 if( ( pxTCB != NULL ) && ( pxTCB != pxCurrentTCB ) )
\r
1617 taskENTER_CRITICAL();
\r
1619 if( prvTaskIsTaskSuspended( pxTCB ) != pdFALSE )
\r
1621 traceTASK_RESUME( pxTCB );
\r
1623 /* As we are in a critical section we can access the ready
\r
1624 lists even if the scheduler is suspended. */
\r
1625 ( void ) uxListRemove( &( pxTCB->xStateListItem ) );
\r
1626 prvAddTaskToReadyList( pxTCB );
\r
1628 /* We may have just resumed a higher priority task. */
\r
1629 if( pxTCB->uxPriority >= pxCurrentTCB->uxPriority )
\r
1631 /* This yield may not cause the task just resumed to run,
\r
1632 but will leave the lists in the correct state for the
\r
1634 taskYIELD_IF_USING_PREEMPTION();
\r
1638 mtCOVERAGE_TEST_MARKER();
\r
1643 mtCOVERAGE_TEST_MARKER();
\r
1646 taskEXIT_CRITICAL();
\r
1650 mtCOVERAGE_TEST_MARKER();
\r
1654 #endif /* INCLUDE_vTaskSuspend */
\r
1656 /*-----------------------------------------------------------*/
\r
1658 #if ( ( INCLUDE_xTaskResumeFromISR == 1 ) && ( INCLUDE_vTaskSuspend == 1 ) )
\r
1660 BaseType_t xTaskResumeFromISR( TaskHandle_t xTaskToResume )
\r
1662 BaseType_t xYieldRequired = pdFALSE;
\r
1663 TCB_t * const pxTCB = ( TCB_t * ) xTaskToResume;
\r
1664 UBaseType_t uxSavedInterruptStatus;
\r
1666 configASSERT( xTaskToResume );
\r
1668 /* RTOS ports that support interrupt nesting have the concept of a
\r
1669 maximum system call (or maximum API call) interrupt priority.
\r
1670 Interrupts that are above the maximum system call priority are keep
\r
1671 permanently enabled, even when the RTOS kernel is in a critical section,
\r
1672 but cannot make any calls to FreeRTOS API functions. If configASSERT()
\r
1673 is defined in FreeRTOSConfig.h then
\r
1674 portASSERT_IF_INTERRUPT_PRIORITY_INVALID() will result in an assertion
\r
1675 failure if a FreeRTOS API function is called from an interrupt that has
\r
1676 been assigned a priority above the configured maximum system call
\r
1677 priority. Only FreeRTOS functions that end in FromISR can be called
\r
1678 from interrupts that have been assigned a priority at or (logically)
\r
1679 below the maximum system call interrupt priority. FreeRTOS maintains a
\r
1680 separate interrupt safe API to ensure interrupt entry is as fast and as
\r
1681 simple as possible. More information (albeit Cortex-M specific) is
\r
1682 provided on the following link:
\r
1683 http://www.freertos.org/RTOS-Cortex-M3-M4.html */
\r
1684 portASSERT_IF_INTERRUPT_PRIORITY_INVALID();
\r
1686 uxSavedInterruptStatus = portSET_INTERRUPT_MASK_FROM_ISR();
\r
1688 if( prvTaskIsTaskSuspended( pxTCB ) != pdFALSE )
\r
1690 traceTASK_RESUME_FROM_ISR( pxTCB );
\r
1692 /* Check the ready lists can be accessed. */
\r
1693 if( uxSchedulerSuspended == ( UBaseType_t ) pdFALSE )
\r
1695 /* Ready lists can be accessed so move the task from the
\r
1696 suspended list to the ready list directly. */
\r
1697 if( pxTCB->uxPriority >= pxCurrentTCB->uxPriority )
\r
1699 xYieldRequired = pdTRUE;
\r
1703 mtCOVERAGE_TEST_MARKER();
\r
1706 ( void ) uxListRemove( &( pxTCB->xStateListItem ) );
\r
1707 prvAddTaskToReadyList( pxTCB );
\r
1711 /* The delayed or ready lists cannot be accessed so the task
\r
1712 is held in the pending ready list until the scheduler is
\r
1714 vListInsertEnd( &( xPendingReadyList ), &( pxTCB->xEventListItem ) );
\r
1719 mtCOVERAGE_TEST_MARKER();
\r
1722 portCLEAR_INTERRUPT_MASK_FROM_ISR( uxSavedInterruptStatus );
\r
1724 return xYieldRequired;
\r
1727 #endif /* ( ( INCLUDE_xTaskResumeFromISR == 1 ) && ( INCLUDE_vTaskSuspend == 1 ) ) */
\r
1728 /*-----------------------------------------------------------*/
\r
1730 void vTaskStartScheduler( void )
\r
1732 BaseType_t xReturn;
\r
1733 uint16_t usIdleTaskStackSize = configMINIMAL_STACK_SIZE;
\r
1735 /* Add the idle task at the lowest priority. */
\r
1736 #if( configSUPPORT_STATIC_ALLOCATION == 1 )
\r
1738 StaticTask_t *pxIdleTaskTCBBuffer = NULL;
\r
1739 StackType_t *pxIdleTaskStackBuffer = NULL;
\r
1741 /* The Idle task is created using user provided RAM - obtain the
\r
1742 address of the RAM then create the idle task. */
\r
1743 vApplicationGetIdleTaskMemory( &pxIdleTaskTCBBuffer, &pxIdleTaskStackBuffer, &usIdleTaskStackSize );
\r
1744 xReturn = xTaskCreateStatic( prvIdleTask, "IDLE", usIdleTaskStackSize, ( void * ) NULL, ( tskIDLE_PRIORITY | portPRIVILEGE_BIT ), &xIdleTaskHandle, pxIdleTaskStackBuffer, pxIdleTaskTCBBuffer ); /*lint !e961 MISRA exception, justified as it is not a redundant explicit cast to all supported compilers. */
\r
1748 /* The Idle task is being created using dynamically allocated RAM. */
\r
1749 xReturn = xTaskCreate( prvIdleTask, "IDLE", usIdleTaskStackSize, ( void * ) NULL, ( tskIDLE_PRIORITY | portPRIVILEGE_BIT ), &xIdleTaskHandle ); /*lint !e961 MISRA exception, justified as it is not a redundant explicit cast to all supported compilers. */
\r
1751 #endif /* configSUPPORT_STATIC_ALLOCATION */
\r
1753 #if ( configUSE_TIMERS == 1 )
\r
1755 if( xReturn == pdPASS )
\r
1757 xReturn = xTimerCreateTimerTask();
\r
1761 mtCOVERAGE_TEST_MARKER();
\r
1764 #endif /* configUSE_TIMERS */
\r
1766 if( xReturn == pdPASS )
\r
1768 /* Interrupts are turned off here, to ensure a tick does not occur
\r
1769 before or during the call to xPortStartScheduler(). The stacks of
\r
1770 the created tasks contain a status word with interrupts switched on
\r
1771 so interrupts will automatically get re-enabled when the first task
\r
1773 portDISABLE_INTERRUPTS();
\r
1775 #if ( configUSE_NEWLIB_REENTRANT == 1 )
\r
1777 /* Switch Newlib's _impure_ptr variable to point to the _reent
\r
1778 structure specific to the task that will run first. */
\r
1779 _impure_ptr = &( pxCurrentTCB->xNewLib_reent );
\r
1781 #endif /* configUSE_NEWLIB_REENTRANT */
\r
1783 xNextTaskUnblockTime = portMAX_DELAY;
\r
1784 xSchedulerRunning = pdTRUE;
\r
1785 xTickCount = ( TickType_t ) 0U;
\r
1787 /* If configGENERATE_RUN_TIME_STATS is defined then the following
\r
1788 macro must be defined to configure the timer/counter used to generate
\r
1789 the run time counter time base. */
\r
1790 portCONFIGURE_TIMER_FOR_RUN_TIME_STATS();
\r
1792 /* Setting up the timer tick is hardware specific and thus in the
\r
1793 portable interface. */
\r
1794 if( xPortStartScheduler() != pdFALSE )
\r
1796 /* Should not reach here as if the scheduler is running the
\r
1797 function will not return. */
\r
1801 /* Should only reach here if a task calls xTaskEndScheduler(). */
\r
1806 /* This line will only be reached if the kernel could not be started,
\r
1807 because there was not enough FreeRTOS heap to create the idle task
\r
1808 or the timer task. */
\r
1809 configASSERT( xReturn );
\r
1812 /* Prevent compiler warnings if INCLUDE_xTaskGetIdleTaskHandle is set to 0,
\r
1813 meaning xIdleTaskHandle is not used anywhere else. */
\r
1814 ( void ) xIdleTaskHandle;
\r
1816 /*-----------------------------------------------------------*/
\r
1818 void vTaskEndScheduler( void )
\r
1820 /* Stop the scheduler interrupts and call the portable scheduler end
\r
1821 routine so the original ISRs can be restored if necessary. The port
\r
1822 layer must ensure interrupts enable bit is left in the correct state. */
\r
1823 portDISABLE_INTERRUPTS();
\r
1824 xSchedulerRunning = pdFALSE;
\r
1825 vPortEndScheduler();
\r
1827 /*----------------------------------------------------------*/
\r
1829 void vTaskSuspendAll( void )
\r
1831 /* A critical section is not required as the variable is of type
\r
1832 BaseType_t. Please read Richard Barry's reply in the following link to a
\r
1833 post in the FreeRTOS support forum before reporting this as a bug! -
\r
1834 http://goo.gl/wu4acr */
\r
1835 ++uxSchedulerSuspended;
\r
1837 /*----------------------------------------------------------*/
\r
1839 #if ( configUSE_TICKLESS_IDLE != 0 )
\r
1841 static TickType_t prvGetExpectedIdleTime( void )
\r
1843 TickType_t xReturn;
\r
1844 UBaseType_t uxHigherPriorityReadyTasks = pdFALSE;
\r
1846 /* uxHigherPriorityReadyTasks takes care of the case where
\r
1847 configUSE_PREEMPTION is 0, so there may be tasks above the idle priority
\r
1848 task that are in the Ready state, even though the idle task is
\r
1850 #if( configUSE_PORT_OPTIMISED_TASK_SELECTION == 0 )
\r
1852 if( uxTopReadyPriority > tskIDLE_PRIORITY )
\r
1854 uxHigherPriorityReadyTasks = pdTRUE;
\r
1859 const UBaseType_t uxLeastSignificantBit = ( UBaseType_t ) 0x01;
\r
1861 /* When port optimised task selection is used the uxTopReadyPriority
\r
1862 variable is used as a bit map. If bits other than the least
\r
1863 significant bit are set then there are tasks that have a priority
\r
1864 above the idle priority that are in the Ready state. This takes
\r
1865 care of the case where the co-operative scheduler is in use. */
\r
1866 if( uxTopReadyPriority > uxLeastSignificantBit )
\r
1868 uxHigherPriorityReadyTasks = pdTRUE;
\r
1873 if( pxCurrentTCB->uxPriority > tskIDLE_PRIORITY )
\r
1877 else if( listCURRENT_LIST_LENGTH( &( pxReadyTasksLists[ tskIDLE_PRIORITY ] ) ) > 1 )
\r
1879 /* There are other idle priority tasks in the ready state. If
\r
1880 time slicing is used then the very next tick interrupt must be
\r
1884 else if( uxHigherPriorityReadyTasks != pdFALSE )
\r
1886 /* There are tasks in the Ready state that have a priority above the
\r
1887 idle priority. This path can only be reached if
\r
1888 configUSE_PREEMPTION is 0. */
\r
1893 xReturn = xNextTaskUnblockTime - xTickCount;
\r
1899 #endif /* configUSE_TICKLESS_IDLE */
\r
1900 /*----------------------------------------------------------*/
\r
1902 BaseType_t xTaskResumeAll( void )
\r
1904 TCB_t *pxTCB = NULL;
\r
1905 BaseType_t xAlreadyYielded = pdFALSE;
\r
1907 /* If uxSchedulerSuspended is zero then this function does not match a
\r
1908 previous call to vTaskSuspendAll(). */
\r
1909 configASSERT( uxSchedulerSuspended );
\r
1911 /* It is possible that an ISR caused a task to be removed from an event
\r
1912 list while the scheduler was suspended. If this was the case then the
\r
1913 removed task will have been added to the xPendingReadyList. Once the
\r
1914 scheduler has been resumed it is safe to move all the pending ready
\r
1915 tasks from this list into their appropriate ready list. */
\r
1916 taskENTER_CRITICAL();
\r
1918 --uxSchedulerSuspended;
\r
1920 if( uxSchedulerSuspended == ( UBaseType_t ) pdFALSE )
\r
1922 if( uxCurrentNumberOfTasks > ( UBaseType_t ) 0U )
\r
1924 /* Move any readied tasks from the pending list into the
\r
1925 appropriate ready list. */
\r
1926 while( listLIST_IS_EMPTY( &xPendingReadyList ) == pdFALSE )
\r
1928 pxTCB = ( TCB_t * ) listGET_OWNER_OF_HEAD_ENTRY( ( &xPendingReadyList ) );
\r
1929 ( void ) uxListRemove( &( pxTCB->xEventListItem ) );
\r
1930 ( void ) uxListRemove( &( pxTCB->xStateListItem ) );
\r
1931 prvAddTaskToReadyList( pxTCB );
\r
1933 /* If the moved task has a priority higher than the current
\r
1934 task then a yield must be performed. */
\r
1935 if( pxTCB->uxPriority >= pxCurrentTCB->uxPriority )
\r
1937 xYieldPending = pdTRUE;
\r
1941 mtCOVERAGE_TEST_MARKER();
\r
1945 if( pxTCB != NULL )
\r
1947 /* A task was unblocked while the scheduler was suspended,
\r
1948 which may have prevented the next unblock time from being
\r
1949 re-calculated, in which case re-calculate it now. Mainly
\r
1950 important for low power tickless implementations, where
\r
1951 this can prevent an unnecessary exit from low power
\r
1953 prvResetNextTaskUnblockTime();
\r
1956 /* If any ticks occurred while the scheduler was suspended then
\r
1957 they should be processed now. This ensures the tick count does
\r
1958 not slip, and that any delayed tasks are resumed at the correct
\r
1961 UBaseType_t uxPendedCounts = uxPendedTicks; /* Non-volatile copy. */
\r
1963 if( uxPendedCounts > ( UBaseType_t ) 0U )
\r
1967 if( xTaskIncrementTick() != pdFALSE )
\r
1969 xYieldPending = pdTRUE;
\r
1973 mtCOVERAGE_TEST_MARKER();
\r
1976 } while( uxPendedCounts > ( UBaseType_t ) 0U );
\r
1978 uxPendedTicks = 0;
\r
1982 mtCOVERAGE_TEST_MARKER();
\r
1986 if( xYieldPending != pdFALSE )
\r
1988 #if( configUSE_PREEMPTION != 0 )
\r
1990 xAlreadyYielded = pdTRUE;
\r
1993 taskYIELD_IF_USING_PREEMPTION();
\r
1997 mtCOVERAGE_TEST_MARKER();
\r
2003 mtCOVERAGE_TEST_MARKER();
\r
2006 taskEXIT_CRITICAL();
\r
2008 return xAlreadyYielded;
\r
2010 /*-----------------------------------------------------------*/
\r
2012 TickType_t xTaskGetTickCount( void )
\r
2014 TickType_t xTicks;
\r
2016 /* Critical section required if running on a 16 bit processor. */
\r
2017 portTICK_TYPE_ENTER_CRITICAL();
\r
2019 xTicks = xTickCount;
\r
2021 portTICK_TYPE_EXIT_CRITICAL();
\r
2025 /*-----------------------------------------------------------*/
\r
2027 TickType_t xTaskGetTickCountFromISR( void )
\r
2029 TickType_t xReturn;
\r
2030 UBaseType_t uxSavedInterruptStatus;
\r
2032 /* RTOS ports that support interrupt nesting have the concept of a maximum
\r
2033 system call (or maximum API call) interrupt priority. Interrupts that are
\r
2034 above the maximum system call priority are kept permanently enabled, even
\r
2035 when the RTOS kernel is in a critical section, but cannot make any calls to
\r
2036 FreeRTOS API functions. If configASSERT() is defined in FreeRTOSConfig.h
\r
2037 then portASSERT_IF_INTERRUPT_PRIORITY_INVALID() will result in an assertion
\r
2038 failure if a FreeRTOS API function is called from an interrupt that has been
\r
2039 assigned a priority above the configured maximum system call priority.
\r
2040 Only FreeRTOS functions that end in FromISR can be called from interrupts
\r
2041 that have been assigned a priority at or (logically) below the maximum
\r
2042 system call interrupt priority. FreeRTOS maintains a separate interrupt
\r
2043 safe API to ensure interrupt entry is as fast and as simple as possible.
\r
2044 More information (albeit Cortex-M specific) is provided on the following
\r
2045 link: http://www.freertos.org/RTOS-Cortex-M3-M4.html */
\r
2046 portASSERT_IF_INTERRUPT_PRIORITY_INVALID();
\r
2048 uxSavedInterruptStatus = portTICK_TYPE_SET_INTERRUPT_MASK_FROM_ISR();
\r
2050 xReturn = xTickCount;
\r
2052 portTICK_TYPE_CLEAR_INTERRUPT_MASK_FROM_ISR( uxSavedInterruptStatus );
\r
2056 /*-----------------------------------------------------------*/
\r
2058 UBaseType_t uxTaskGetNumberOfTasks( void )
\r
2060 /* A critical section is not required because the variables are of type
\r
2062 return uxCurrentNumberOfTasks;
\r
2064 /*-----------------------------------------------------------*/
\r
2066 #if ( INCLUDE_pcTaskGetTaskName == 1 )
\r
2068 char *pcTaskGetTaskName( TaskHandle_t xTaskToQuery ) /*lint !e971 Unqualified char types are allowed for strings and single characters only. */
\r
2072 /* If null is passed in here then the name of the calling task is being
\r
2074 pxTCB = prvGetTCBFromHandle( xTaskToQuery );
\r
2075 configASSERT( pxTCB );
\r
2076 return &( pxTCB->pcTaskName[ 0 ] );
\r
2079 #endif /* INCLUDE_pcTaskGetTaskName */
\r
2080 /*-----------------------------------------------------------*/
\r
2082 #if ( INCLUDE_xTaskGetTaskHandle == 1 )
\r
2084 static TCB_t *prvSearchForNameWithinSingleList( List_t *pxList, const char pcNameToQuery[] )
\r
2086 TCB_t *pxNextTCB, *pxFirstTCB, *pxReturn = NULL;
\r
2090 /* This function is called with the scheduler suspended. */
\r
2092 if( listCURRENT_LIST_LENGTH( pxList ) > ( UBaseType_t ) 0 )
\r
2094 listGET_OWNER_OF_NEXT_ENTRY( pxFirstTCB, pxList );
\r
2098 listGET_OWNER_OF_NEXT_ENTRY( pxNextTCB, pxList );
\r
2100 /* Check each character in the name looking for a match or
\r
2102 for( x = ( UBaseType_t ) 0; x < ( UBaseType_t ) configMAX_TASK_NAME_LEN; x++ )
\r
2104 cNextChar = pxNextTCB->pcTaskName[ x ];
\r
2106 if( cNextChar != pcNameToQuery[ x ] )
\r
2108 /* Characters didn't match. */
\r
2111 else if( cNextChar == 0x00 )
\r
2113 /* Both strings terminated, a match must have been
\r
2115 pxReturn = pxNextTCB;
\r
2120 mtCOVERAGE_TEST_MARKER();
\r
2124 if( pxReturn != NULL )
\r
2126 /* The handle has been found. */
\r
2130 } while( pxNextTCB != pxFirstTCB );
\r
2134 mtCOVERAGE_TEST_MARKER();
\r
2140 #endif /* INCLUDE_xTaskGetTaskHandle */
\r
2141 /*-----------------------------------------------------------*/
\r
2143 #if ( INCLUDE_xTaskGetTaskHandle == 1 )
\r
2145 TaskHandle_t xTaskGetTaskHandle( const char *pcNameToQuery ) /*lint !e971 Unqualified char types are allowed for strings and single characters only. */
\r
2147 UBaseType_t uxQueue = configMAX_PRIORITIES;
\r
2150 /* Task names will be truncated to configMAX_TASK_NAME_LEN - 1 bytes. */
\r
2151 configASSERT( strlen( pcNameToQuery ) < configMAX_TASK_NAME_LEN );
\r
2153 vTaskSuspendAll();
\r
2155 /* Search the ready lists. */
\r
2159 pxTCB = prvSearchForNameWithinSingleList( ( List_t * ) &( pxReadyTasksLists[ uxQueue ] ), pcNameToQuery );
\r
2161 if( pxTCB != NULL )
\r
2163 /* Found the handle. */
\r
2167 } while( uxQueue > ( UBaseType_t ) tskIDLE_PRIORITY ); /*lint !e961 MISRA exception as the casts are only redundant for some ports. */
\r
2169 /* Search the delayed lists. */
\r
2170 if( pxTCB == NULL )
\r
2172 pxTCB = prvSearchForNameWithinSingleList( ( List_t * ) pxDelayedTaskList, pcNameToQuery );
\r
2175 if( pxTCB == NULL )
\r
2177 pxTCB = prvSearchForNameWithinSingleList( ( List_t * ) pxOverflowDelayedTaskList, pcNameToQuery );
\r
2180 #if ( INCLUDE_vTaskSuspend == 1 )
\r
2182 if( pxTCB == NULL )
\r
2184 /* Search the suspended list. */
\r
2185 pxTCB = prvSearchForNameWithinSingleList( &xSuspendedTaskList, pcNameToQuery );
\r
2190 #if( INCLUDE_vTaskDelete == 1 )
\r
2192 if( pxTCB == NULL )
\r
2194 /* Search the deleted list. */
\r
2195 pxTCB = prvSearchForNameWithinSingleList( &xTasksWaitingTermination, pcNameToQuery );
\r
2200 ( void ) xTaskResumeAll();
\r
2202 return ( TaskHandle_t ) pxTCB;
\r
2205 #endif /* INCLUDE_xTaskGetTaskHandle */
\r
2206 /*-----------------------------------------------------------*/
\r
2208 #if ( configUSE_TRACE_FACILITY == 1 )
\r
2210 UBaseType_t uxTaskGetSystemState( TaskStatus_t * const pxTaskStatusArray, const UBaseType_t uxArraySize, uint32_t * const pulTotalRunTime )
\r
2212 UBaseType_t uxTask = 0, uxQueue = configMAX_PRIORITIES;
\r
2214 vTaskSuspendAll();
\r
2216 /* Is there a space in the array for each task in the system? */
\r
2217 if( uxArraySize >= uxCurrentNumberOfTasks )
\r
2219 /* Fill in an TaskStatus_t structure with information on each
\r
2220 task in the Ready state. */
\r
2224 uxTask += prvListTasksWithinSingleList( &( pxTaskStatusArray[ uxTask ] ), &( pxReadyTasksLists[ uxQueue ] ), eReady );
\r
2226 } while( uxQueue > ( UBaseType_t ) tskIDLE_PRIORITY ); /*lint !e961 MISRA exception as the casts are only redundant for some ports. */
\r
2228 /* Fill in an TaskStatus_t structure with information on each
\r
2229 task in the Blocked state. */
\r
2230 uxTask += prvListTasksWithinSingleList( &( pxTaskStatusArray[ uxTask ] ), ( List_t * ) pxDelayedTaskList, eBlocked );
\r
2231 uxTask += prvListTasksWithinSingleList( &( pxTaskStatusArray[ uxTask ] ), ( List_t * ) pxOverflowDelayedTaskList, eBlocked );
\r
2233 #if( INCLUDE_vTaskDelete == 1 )
\r
2235 /* Fill in an TaskStatus_t structure with information on
\r
2236 each task that has been deleted but not yet cleaned up. */
\r
2237 uxTask += prvListTasksWithinSingleList( &( pxTaskStatusArray[ uxTask ] ), &xTasksWaitingTermination, eDeleted );
\r
2241 #if ( INCLUDE_vTaskSuspend == 1 )
\r
2243 /* Fill in an TaskStatus_t structure with information on
\r
2244 each task in the Suspended state. */
\r
2245 uxTask += prvListTasksWithinSingleList( &( pxTaskStatusArray[ uxTask ] ), &xSuspendedTaskList, eSuspended );
\r
2249 #if ( configGENERATE_RUN_TIME_STATS == 1)
\r
2251 if( pulTotalRunTime != NULL )
\r
2253 #ifdef portALT_GET_RUN_TIME_COUNTER_VALUE
\r
2254 portALT_GET_RUN_TIME_COUNTER_VALUE( ( *pulTotalRunTime ) );
\r
2256 *pulTotalRunTime = portGET_RUN_TIME_COUNTER_VALUE();
\r
2262 if( pulTotalRunTime != NULL )
\r
2264 *pulTotalRunTime = 0;
\r
2271 mtCOVERAGE_TEST_MARKER();
\r
2274 ( void ) xTaskResumeAll();
\r
2279 #endif /* configUSE_TRACE_FACILITY */
\r
2280 /*----------------------------------------------------------*/
\r
2282 #if ( INCLUDE_xTaskGetIdleTaskHandle == 1 )
\r
2284 TaskHandle_t xTaskGetIdleTaskHandle( void )
\r
2286 /* If xTaskGetIdleTaskHandle() is called before the scheduler has been
\r
2287 started, then xIdleTaskHandle will be NULL. */
\r
2288 configASSERT( ( xIdleTaskHandle != NULL ) );
\r
2289 return xIdleTaskHandle;
\r
2292 #endif /* INCLUDE_xTaskGetIdleTaskHandle */
\r
2293 /*----------------------------------------------------------*/
\r
2295 /* This conditional compilation should use inequality to 0, not equality to 1.
\r
2296 This is to ensure vTaskStepTick() is available when user defined low power mode
\r
2297 implementations require configUSE_TICKLESS_IDLE to be set to a value other than
\r
2299 #if ( configUSE_TICKLESS_IDLE != 0 )
\r
2301 void vTaskStepTick( const TickType_t xTicksToJump )
\r
2303 /* Correct the tick count value after a period during which the tick
\r
2304 was suppressed. Note this does *not* call the tick hook function for
\r
2305 each stepped tick. */
\r
2306 configASSERT( ( xTickCount + xTicksToJump ) <= xNextTaskUnblockTime );
\r
2307 xTickCount += xTicksToJump;
\r
2308 traceINCREASE_TICK_COUNT( xTicksToJump );
\r
2311 #endif /* configUSE_TICKLESS_IDLE */
\r
2312 /*----------------------------------------------------------*/
\r
2314 #if ( INCLUDE_xTaskAbortDelay == 1 )
\r
2316 BaseType_t xTaskAbortDelay( TaskHandle_t xTask )
\r
2318 TCB_t *pxTCB = ( TCB_t * ) xTask;
\r
2319 BaseType_t xReturn = pdFALSE;
\r
2321 configASSERT( pxTCB );
\r
2323 vTaskSuspendAll();
\r
2325 /* A task can only be prematurely removed from the Blocked state if
\r
2326 it is actually in the Blocked state. */
\r
2327 if( eTaskGetState( xTask ) == eBlocked )
\r
2329 /* Remove the reference to the task from the blocked list. An
\r
2330 interrupt won't touch the xStateListItem because the
\r
2331 scheduler is suspended. */
\r
2332 ( void ) uxListRemove( &( pxTCB->xStateListItem ) );
\r
2334 /* Is the task waiting on an event also? If so remove it from
\r
2335 the event list too. Interrupts can touch the event list item,
\r
2336 even though the scheduler is suspended, so a critical section
\r
2338 taskENTER_CRITICAL();
\r
2340 if( listLIST_ITEM_CONTAINER( &( pxTCB->xEventListItem ) ) != NULL )
\r
2342 ( void ) uxListRemove( &( pxTCB->xEventListItem ) );
\r
2343 pxTCB->ucDelayAborted = pdTRUE;
\r
2347 mtCOVERAGE_TEST_MARKER();
\r
2350 taskEXIT_CRITICAL();
\r
2352 /* Place the unblocked task into the appropriate ready list. */
\r
2353 prvAddTaskToReadyList( pxTCB );
\r
2355 /* A task being unblocked cannot cause an immediate context
\r
2356 switch if preemption is turned off. */
\r
2357 #if ( configUSE_PREEMPTION == 1 )
\r
2359 /* Preemption is on, but a context switch should only be
\r
2360 performed if the unblocked task has a priority that is
\r
2361 equal to or higher than the currently executing task. */
\r
2362 if( pxTCB->uxPriority > pxCurrentTCB->uxPriority )
\r
2364 /* Pend the yield to be performed when the scheduler
\r
2365 is unsuspended. */
\r
2366 xYieldPending = pdTRUE;
\r
2370 mtCOVERAGE_TEST_MARKER();
\r
2373 #endif /* configUSE_PREEMPTION */
\r
2377 mtCOVERAGE_TEST_MARKER();
\r
2385 #endif /* INCLUDE_xTaskAbortDelay */
\r
2386 /*----------------------------------------------------------*/
\r
2388 BaseType_t xTaskIncrementTick( void )
\r
2391 TickType_t xItemValue;
\r
2392 BaseType_t xSwitchRequired = pdFALSE;
\r
2394 /* Called by the portable layer each time a tick interrupt occurs.
\r
2395 Increments the tick then checks to see if the new tick value will cause any
\r
2396 tasks to be unblocked. */
\r
2397 traceTASK_INCREMENT_TICK( xTickCount );
\r
2398 if( uxSchedulerSuspended == ( UBaseType_t ) pdFALSE )
\r
2400 /* Minor optimisation. The tick count cannot change in this
\r
2402 const TickType_t xConstTickCount = xTickCount + 1;
\r
2404 /* Increment the RTOS tick, switching the delayed and overflowed
\r
2405 delayed lists if it wraps to 0. */
\r
2406 xTickCount = xConstTickCount;
\r
2408 if( xConstTickCount == ( TickType_t ) 0U )
\r
2410 taskSWITCH_DELAYED_LISTS();
\r
2414 mtCOVERAGE_TEST_MARKER();
\r
2417 /* See if this tick has made a timeout expire. Tasks are stored in
\r
2418 the queue in the order of their wake time - meaning once one task
\r
2419 has been found whose block time has not expired there is no need to
\r
2420 look any further down the list. */
\r
2421 if( xConstTickCount >= xNextTaskUnblockTime )
\r
2425 if( listLIST_IS_EMPTY( pxDelayedTaskList ) != pdFALSE )
\r
2427 /* The delayed list is empty. Set xNextTaskUnblockTime
\r
2428 to the maximum possible value so it is extremely
\r
2430 if( xTickCount >= xNextTaskUnblockTime ) test will pass
\r
2431 next time through. */
\r
2432 xNextTaskUnblockTime = portMAX_DELAY; /*lint !e961 MISRA exception as the casts are only redundant for some ports. */
\r
2437 /* The delayed list is not empty, get the value of the
\r
2438 item at the head of the delayed list. This is the time
\r
2439 at which the task at the head of the delayed list must
\r
2440 be removed from the Blocked state. */
\r
2441 pxTCB = ( TCB_t * ) listGET_OWNER_OF_HEAD_ENTRY( pxDelayedTaskList );
\r
2442 xItemValue = listGET_LIST_ITEM_VALUE( &( pxTCB->xStateListItem ) );
\r
2444 if( xConstTickCount < xItemValue )
\r
2446 /* It is not time to unblock this item yet, but the
\r
2447 item value is the time at which the task at the head
\r
2448 of the blocked list must be removed from the Blocked
\r
2449 state - so record the item value in
\r
2450 xNextTaskUnblockTime. */
\r
2451 xNextTaskUnblockTime = xItemValue;
\r
2456 mtCOVERAGE_TEST_MARKER();
\r
2459 /* It is time to remove the item from the Blocked state. */
\r
2460 ( void ) uxListRemove( &( pxTCB->xStateListItem ) );
\r
2462 /* Is the task waiting on an event also? If so remove
\r
2463 it from the event list. */
\r
2464 if( listLIST_ITEM_CONTAINER( &( pxTCB->xEventListItem ) ) != NULL )
\r
2466 ( void ) uxListRemove( &( pxTCB->xEventListItem ) );
\r
2470 mtCOVERAGE_TEST_MARKER();
\r
2473 /* Place the unblocked task into the appropriate ready
\r
2475 prvAddTaskToReadyList( pxTCB );
\r
2477 /* A task being unblocked cannot cause an immediate
\r
2478 context switch if preemption is turned off. */
\r
2479 #if ( configUSE_PREEMPTION == 1 )
\r
2481 /* Preemption is on, but a context switch should
\r
2482 only be performed if the unblocked task has a
\r
2483 priority that is equal to or higher than the
\r
2484 currently executing task. */
\r
2485 if( pxTCB->uxPriority >= pxCurrentTCB->uxPriority )
\r
2487 xSwitchRequired = pdTRUE;
\r
2491 mtCOVERAGE_TEST_MARKER();
\r
2494 #endif /* configUSE_PREEMPTION */
\r
2499 /* Tasks of equal priority to the currently running task will share
\r
2500 processing time (time slice) if preemption is on, and the application
\r
2501 writer has not explicitly turned time slicing off. */
\r
2502 #if ( ( configUSE_PREEMPTION == 1 ) && ( configUSE_TIME_SLICING == 1 ) )
\r
2504 if( listCURRENT_LIST_LENGTH( &( pxReadyTasksLists[ pxCurrentTCB->uxPriority ] ) ) > ( UBaseType_t ) 1 )
\r
2506 xSwitchRequired = pdTRUE;
\r
2510 mtCOVERAGE_TEST_MARKER();
\r
2513 #endif /* ( ( configUSE_PREEMPTION == 1 ) && ( configUSE_TIME_SLICING == 1 ) ) */
\r
2515 #if ( configUSE_TICK_HOOK == 1 )
\r
2517 /* Guard against the tick hook being called when the pended tick
\r
2518 count is being unwound (when the scheduler is being unlocked). */
\r
2519 if( uxPendedTicks == ( UBaseType_t ) 0U )
\r
2521 vApplicationTickHook();
\r
2525 mtCOVERAGE_TEST_MARKER();
\r
2528 #endif /* configUSE_TICK_HOOK */
\r
2534 /* The tick hook gets called at regular intervals, even if the
\r
2535 scheduler is locked. */
\r
2536 #if ( configUSE_TICK_HOOK == 1 )
\r
2538 vApplicationTickHook();
\r
2543 #if ( configUSE_PREEMPTION == 1 )
\r
2545 if( xYieldPending != pdFALSE )
\r
2547 xSwitchRequired = pdTRUE;
\r
2551 mtCOVERAGE_TEST_MARKER();
\r
2554 #endif /* configUSE_PREEMPTION */
\r
2556 return xSwitchRequired;
\r
2558 /*-----------------------------------------------------------*/
\r
2560 #if ( configUSE_APPLICATION_TASK_TAG == 1 )
\r
2562 void vTaskSetApplicationTaskTag( TaskHandle_t xTask, TaskHookFunction_t pxHookFunction )
\r
2566 /* If xTask is NULL then it is the task hook of the calling task that is
\r
2568 if( xTask == NULL )
\r
2570 xTCB = ( TCB_t * ) pxCurrentTCB;
\r
2574 xTCB = ( TCB_t * ) xTask;
\r
2577 /* Save the hook function in the TCB. A critical section is required as
\r
2578 the value can be accessed from an interrupt. */
\r
2579 taskENTER_CRITICAL();
\r
2580 xTCB->pxTaskTag = pxHookFunction;
\r
2581 taskEXIT_CRITICAL();
\r
2584 #endif /* configUSE_APPLICATION_TASK_TAG */
\r
2585 /*-----------------------------------------------------------*/
\r
2587 #if ( configUSE_APPLICATION_TASK_TAG == 1 )
\r
2589 TaskHookFunction_t xTaskGetApplicationTaskTag( TaskHandle_t xTask )
\r
2592 TaskHookFunction_t xReturn;
\r
2594 /* If xTask is NULL then we are setting our own task hook. */
\r
2595 if( xTask == NULL )
\r
2597 xTCB = ( TCB_t * ) pxCurrentTCB;
\r
2601 xTCB = ( TCB_t * ) xTask;
\r
2604 /* Save the hook function in the TCB. A critical section is required as
\r
2605 the value can be accessed from an interrupt. */
\r
2606 taskENTER_CRITICAL();
\r
2608 xReturn = xTCB->pxTaskTag;
\r
2610 taskEXIT_CRITICAL();
\r
2615 #endif /* configUSE_APPLICATION_TASK_TAG */
\r
2616 /*-----------------------------------------------------------*/
\r
2618 #if ( configUSE_APPLICATION_TASK_TAG == 1 )
\r
2620 BaseType_t xTaskCallApplicationTaskHook( TaskHandle_t xTask, void *pvParameter )
\r
2623 BaseType_t xReturn;
\r
2625 /* If xTask is NULL then we are calling our own task hook. */
\r
2626 if( xTask == NULL )
\r
2628 xTCB = ( TCB_t * ) pxCurrentTCB;
\r
2632 xTCB = ( TCB_t * ) xTask;
\r
2635 if( xTCB->pxTaskTag != NULL )
\r
2637 xReturn = xTCB->pxTaskTag( pvParameter );
\r
2647 #endif /* configUSE_APPLICATION_TASK_TAG */
\r
2648 /*-----------------------------------------------------------*/
\r
2650 void vTaskSwitchContext( void )
\r
2652 if( uxSchedulerSuspended != ( UBaseType_t ) pdFALSE )
\r
2654 /* The scheduler is currently suspended - do not allow a context
\r
2656 xYieldPending = pdTRUE;
\r
2660 xYieldPending = pdFALSE;
\r
2661 traceTASK_SWITCHED_OUT();
\r
2663 #if ( configGENERATE_RUN_TIME_STATS == 1 )
\r
2665 #ifdef portALT_GET_RUN_TIME_COUNTER_VALUE
\r
2666 portALT_GET_RUN_TIME_COUNTER_VALUE( ulTotalRunTime );
\r
2668 ulTotalRunTime = portGET_RUN_TIME_COUNTER_VALUE();
\r
2671 /* Add the amount of time the task has been running to the
\r
2672 accumulated time so far. The time the task started running was
\r
2673 stored in ulTaskSwitchedInTime. Note that there is no overflow
\r
2674 protection here so count values are only valid until the timer
\r
2675 overflows. The guard against negative values is to protect
\r
2676 against suspect run time stat counter implementations - which
\r
2677 are provided by the application, not the kernel. */
\r
2678 if( ulTotalRunTime > ulTaskSwitchedInTime )
\r
2680 pxCurrentTCB->ulRunTimeCounter += ( ulTotalRunTime - ulTaskSwitchedInTime );
\r
2684 mtCOVERAGE_TEST_MARKER();
\r
2686 ulTaskSwitchedInTime = ulTotalRunTime;
\r
2688 #endif /* configGENERATE_RUN_TIME_STATS */
\r
2690 /* Check for stack overflow, if configured. */
\r
2691 taskCHECK_FOR_STACK_OVERFLOW();
\r
2693 /* Select a new task to run using either the generic C or port
\r
2694 optimised asm code. */
\r
2695 taskSELECT_HIGHEST_PRIORITY_TASK();
\r
2696 traceTASK_SWITCHED_IN();
\r
2698 #if ( configUSE_NEWLIB_REENTRANT == 1 )
\r
2700 /* Switch Newlib's _impure_ptr variable to point to the _reent
\r
2701 structure specific to this task. */
\r
2702 _impure_ptr = &( pxCurrentTCB->xNewLib_reent );
\r
2704 #endif /* configUSE_NEWLIB_REENTRANT */
\r
2707 /*-----------------------------------------------------------*/
\r
2709 void vTaskPlaceOnEventList( List_t * const pxEventList, const TickType_t xTicksToWait )
\r
2711 configASSERT( pxEventList );
\r
2713 /* THIS FUNCTION MUST BE CALLED WITH EITHER INTERRUPTS DISABLED OR THE
\r
2714 SCHEDULER SUSPENDED AND THE QUEUE BEING ACCESSED LOCKED. */
\r
2716 /* Place the event list item of the TCB in the appropriate event list.
\r
2717 This is placed in the list in priority order so the highest priority task
\r
2718 is the first to be woken by the event. The queue that contains the event
\r
2719 list is locked, preventing simultaneous access from interrupts. */
\r
2720 vListInsert( pxEventList, &( pxCurrentTCB->xEventListItem ) );
\r
2722 prvAddCurrentTaskToDelayedList( xTicksToWait, pdTRUE );
\r
2724 /*-----------------------------------------------------------*/
\r
2726 void vTaskPlaceOnUnorderedEventList( List_t * pxEventList, const TickType_t xItemValue, const TickType_t xTicksToWait )
\r
2728 configASSERT( pxEventList );
\r
2730 /* THIS FUNCTION MUST BE CALLED WITH THE SCHEDULER SUSPENDED. It is used by
\r
2731 the event groups implementation. */
\r
2732 configASSERT( uxSchedulerSuspended != 0 );
\r
2734 /* Store the item value in the event list item. It is safe to access the
\r
2735 event list item here as interrupts won't access the event list item of a
\r
2736 task that is not in the Blocked state. */
\r
2737 listSET_LIST_ITEM_VALUE( &( pxCurrentTCB->xEventListItem ), xItemValue | taskEVENT_LIST_ITEM_VALUE_IN_USE );
\r
2739 /* Place the event list item of the TCB at the end of the appropriate event
\r
2740 list. It is safe to access the event list here because it is part of an
\r
2741 event group implementation - and interrupts don't access event groups
\r
2742 directly (instead they access them indirectly by pending function calls to
\r
2743 the task level). */
\r
2744 vListInsertEnd( pxEventList, &( pxCurrentTCB->xEventListItem ) );
\r
2746 prvAddCurrentTaskToDelayedList( xTicksToWait, pdTRUE );
\r
2748 /*-----------------------------------------------------------*/
\r
2750 #if( configUSE_TIMERS == 1 )
\r
2752 void vTaskPlaceOnEventListRestricted( List_t * const pxEventList, TickType_t xTicksToWait, const BaseType_t xWaitIndefinitely )
\r
2754 configASSERT( pxEventList );
\r
2756 /* This function should not be called by application code hence the
\r
2757 'Restricted' in its name. It is not part of the public API. It is
\r
2758 designed for use by kernel code, and has special calling requirements -
\r
2759 it should be called with the scheduler suspended. */
\r
2762 /* Place the event list item of the TCB in the appropriate event list.
\r
2763 In this case it is assume that this is the only task that is going to
\r
2764 be waiting on this event list, so the faster vListInsertEnd() function
\r
2765 can be used in place of vListInsert. */
\r
2766 vListInsertEnd( pxEventList, &( pxCurrentTCB->xEventListItem ) );
\r
2768 /* If the task should block indefinitely then set the block time to a
\r
2769 value that will be recognised as an indefinite delay inside the
\r
2770 prvAddCurrentTaskToDelayedList() function. */
\r
2771 if( xWaitIndefinitely != pdFALSE )
\r
2773 xTicksToWait = portMAX_DELAY;
\r
2776 traceTASK_DELAY_UNTIL( ( xTickCount + xTicksToWait ) );
\r
2777 prvAddCurrentTaskToDelayedList( xTicksToWait, xWaitIndefinitely );
\r
2780 #endif /* configUSE_TIMERS */
\r
2781 /*-----------------------------------------------------------*/
\r
2783 BaseType_t xTaskRemoveFromEventList( const List_t * const pxEventList )
\r
2785 TCB_t *pxUnblockedTCB;
\r
2786 BaseType_t xReturn;
\r
2788 /* THIS FUNCTION MUST BE CALLED FROM A CRITICAL SECTION. It can also be
\r
2789 called from a critical section within an ISR. */
\r
2791 /* The event list is sorted in priority order, so the first in the list can
\r
2792 be removed as it is known to be the highest priority. Remove the TCB from
\r
2793 the delayed list, and add it to the ready list.
\r
2795 If an event is for a queue that is locked then this function will never
\r
2796 get called - the lock count on the queue will get modified instead. This
\r
2797 means exclusive access to the event list is guaranteed here.
\r
2799 This function assumes that a check has already been made to ensure that
\r
2800 pxEventList is not empty. */
\r
2801 pxUnblockedTCB = ( TCB_t * ) listGET_OWNER_OF_HEAD_ENTRY( pxEventList );
\r
2802 configASSERT( pxUnblockedTCB );
\r
2803 ( void ) uxListRemove( &( pxUnblockedTCB->xEventListItem ) );
\r
2805 if( uxSchedulerSuspended == ( UBaseType_t ) pdFALSE )
\r
2807 ( void ) uxListRemove( &( pxUnblockedTCB->xStateListItem ) );
\r
2808 prvAddTaskToReadyList( pxUnblockedTCB );
\r
2812 /* The delayed and ready lists cannot be accessed, so hold this task
\r
2813 pending until the scheduler is resumed. */
\r
2814 vListInsertEnd( &( xPendingReadyList ), &( pxUnblockedTCB->xEventListItem ) );
\r
2817 if( pxUnblockedTCB->uxPriority > pxCurrentTCB->uxPriority )
\r
2819 /* Return true if the task removed from the event list has a higher
\r
2820 priority than the calling task. This allows the calling task to know if
\r
2821 it should force a context switch now. */
\r
2824 /* Mark that a yield is pending in case the user is not using the
\r
2825 "xHigherPriorityTaskWoken" parameter to an ISR safe FreeRTOS function. */
\r
2826 xYieldPending = pdTRUE;
\r
2830 xReturn = pdFALSE;
\r
2833 #if( configUSE_TICKLESS_IDLE != 0 )
\r
2835 /* If a task is blocked on a kernel object then xNextTaskUnblockTime
\r
2836 might be set to the blocked task's time out time. If the task is
\r
2837 unblocked for a reason other than a timeout xNextTaskUnblockTime is
\r
2838 normally left unchanged, because it is automatically reset to a new
\r
2839 value when the tick count equals xNextTaskUnblockTime. However if
\r
2840 tickless idling is used it might be more important to enter sleep mode
\r
2841 at the earliest possible time - so reset xNextTaskUnblockTime here to
\r
2842 ensure it is updated at the earliest possible time. */
\r
2843 prvResetNextTaskUnblockTime();
\r
2849 /*-----------------------------------------------------------*/
\r
2851 BaseType_t xTaskRemoveFromUnorderedEventList( ListItem_t * pxEventListItem, const TickType_t xItemValue )
\r
2853 TCB_t *pxUnblockedTCB;
\r
2854 BaseType_t xReturn;
\r
2856 /* THIS FUNCTION MUST BE CALLED WITH THE SCHEDULER SUSPENDED. It is used by
\r
2857 the event flags implementation. */
\r
2858 configASSERT( uxSchedulerSuspended != pdFALSE );
\r
2860 /* Store the new item value in the event list. */
\r
2861 listSET_LIST_ITEM_VALUE( pxEventListItem, xItemValue | taskEVENT_LIST_ITEM_VALUE_IN_USE );
\r
2863 /* Remove the event list form the event flag. Interrupts do not access
\r
2865 pxUnblockedTCB = ( TCB_t * ) listGET_LIST_ITEM_OWNER( pxEventListItem );
\r
2866 configASSERT( pxUnblockedTCB );
\r
2867 ( void ) uxListRemove( pxEventListItem );
\r
2869 /* Remove the task from the delayed list and add it to the ready list. The
\r
2870 scheduler is suspended so interrupts will not be accessing the ready
\r
2872 ( void ) uxListRemove( &( pxUnblockedTCB->xStateListItem ) );
\r
2873 prvAddTaskToReadyList( pxUnblockedTCB );
\r
2875 if( pxUnblockedTCB->uxPriority > pxCurrentTCB->uxPriority )
\r
2877 /* Return true if the task removed from the event list has
\r
2878 a higher priority than the calling task. This allows
\r
2879 the calling task to know if it should force a context
\r
2883 /* Mark that a yield is pending in case the user is not using the
\r
2884 "xHigherPriorityTaskWoken" parameter to an ISR safe FreeRTOS function. */
\r
2885 xYieldPending = pdTRUE;
\r
2889 xReturn = pdFALSE;
\r
2894 /*-----------------------------------------------------------*/
\r
2896 void vTaskSetTimeOutState( TimeOut_t * const pxTimeOut )
\r
2898 configASSERT( pxTimeOut );
\r
2899 pxTimeOut->xOverflowCount = xNumOfOverflows;
\r
2900 pxTimeOut->xTimeOnEntering = xTickCount;
\r
2902 /*-----------------------------------------------------------*/
\r
2904 BaseType_t xTaskCheckForTimeOut( TimeOut_t * const pxTimeOut, TickType_t * const pxTicksToWait )
\r
2906 BaseType_t xReturn;
\r
2908 configASSERT( pxTimeOut );
\r
2909 configASSERT( pxTicksToWait );
\r
2911 taskENTER_CRITICAL();
\r
2913 /* Minor optimisation. The tick count cannot change in this block. */
\r
2914 const TickType_t xConstTickCount = xTickCount;
\r
2916 #if( INCLUDE_xTaskAbortDelay == 1 )
\r
2917 if( pxCurrentTCB->ucDelayAborted != pdFALSE )
\r
2919 /* The delay was aborted, which is not the same as a time out,
\r
2920 but has the same result. */
\r
2921 pxCurrentTCB->ucDelayAborted = pdFALSE;
\r
2927 #if ( INCLUDE_vTaskSuspend == 1 )
\r
2928 if( *pxTicksToWait == portMAX_DELAY )
\r
2930 /* If INCLUDE_vTaskSuspend is set to 1 and the block time
\r
2931 specified is the maximum block time then the task should block
\r
2932 indefinitely, and therefore never time out. */
\r
2933 xReturn = pdFALSE;
\r
2938 if( ( xNumOfOverflows != pxTimeOut->xOverflowCount ) && ( xConstTickCount >= pxTimeOut->xTimeOnEntering ) ) /*lint !e525 Indentation preferred as is to make code within pre-processor directives clearer. */
\r
2940 /* The tick count is greater than the time at which
\r
2941 vTaskSetTimeout() was called, but has also overflowed since
\r
2942 vTaskSetTimeOut() was called. It must have wrapped all the way
\r
2943 around and gone past again. This passed since vTaskSetTimeout()
\r
2947 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
2949 /* Not a genuine timeout. Adjust parameters for time remaining. */
\r
2950 *pxTicksToWait -= ( xConstTickCount - pxTimeOut->xTimeOnEntering );
\r
2951 vTaskSetTimeOutState( pxTimeOut );
\r
2952 xReturn = pdFALSE;
\r
2959 taskEXIT_CRITICAL();
\r
2963 /*-----------------------------------------------------------*/
\r
2965 void vTaskMissedYield( void )
\r
2967 xYieldPending = pdTRUE;
\r
2969 /*-----------------------------------------------------------*/
\r
2971 #if ( configUSE_TRACE_FACILITY == 1 )
\r
2973 UBaseType_t uxTaskGetTaskNumber( TaskHandle_t xTask )
\r
2975 UBaseType_t uxReturn;
\r
2978 if( xTask != NULL )
\r
2980 pxTCB = ( TCB_t * ) xTask;
\r
2981 uxReturn = pxTCB->uxTaskNumber;
\r
2991 #endif /* configUSE_TRACE_FACILITY */
\r
2992 /*-----------------------------------------------------------*/
\r
2994 #if ( configUSE_TRACE_FACILITY == 1 )
\r
2996 void vTaskSetTaskNumber( TaskHandle_t xTask, const UBaseType_t uxHandle )
\r
3000 if( xTask != NULL )
\r
3002 pxTCB = ( TCB_t * ) xTask;
\r
3003 pxTCB->uxTaskNumber = uxHandle;
\r
3007 #endif /* configUSE_TRACE_FACILITY */
\r
3010 * -----------------------------------------------------------
\r
3012 * ----------------------------------------------------------
\r
3014 * The portTASK_FUNCTION() macro is used to allow port/compiler specific
\r
3015 * language extensions. The equivalent prototype for this function is:
\r
3017 * void prvIdleTask( void *pvParameters );
\r
3020 static portTASK_FUNCTION( prvIdleTask, pvParameters )
\r
3022 /* Stop warnings. */
\r
3023 ( void ) pvParameters;
\r
3025 /** THIS IS THE RTOS IDLE TASK - WHICH IS CREATED AUTOMATICALLY WHEN THE
\r
3026 SCHEDULER IS STARTED. **/
\r
3030 /* See if any tasks have deleted themselves - if so then the idle task
\r
3031 is responsible for freeing the deleted task's TCB and stack. */
\r
3032 prvCheckTasksWaitingTermination();
\r
3034 #if ( configUSE_PREEMPTION == 0 )
\r
3036 /* If we are not using preemption we keep forcing a task switch to
\r
3037 see if any other task has become available. If we are using
\r
3038 preemption we don't need to do this as any task becoming available
\r
3039 will automatically get the processor anyway. */
\r
3042 #endif /* configUSE_PREEMPTION */
\r
3044 #if ( ( configUSE_PREEMPTION == 1 ) && ( configIDLE_SHOULD_YIELD == 1 ) )
\r
3046 /* When using preemption tasks of equal priority will be
\r
3047 timesliced. If a task that is sharing the idle priority is ready
\r
3048 to run then the idle task should yield before the end of the
\r
3051 A critical region is not required here as we are just reading from
\r
3052 the list, and an occasional incorrect value will not matter. If
\r
3053 the ready list at the idle priority contains more than one task
\r
3054 then a task other than the idle task is ready to execute. */
\r
3055 if( listCURRENT_LIST_LENGTH( &( pxReadyTasksLists[ tskIDLE_PRIORITY ] ) ) > ( UBaseType_t ) 1 )
\r
3061 mtCOVERAGE_TEST_MARKER();
\r
3064 #endif /* ( ( configUSE_PREEMPTION == 1 ) && ( configIDLE_SHOULD_YIELD == 1 ) ) */
\r
3066 #if ( configUSE_IDLE_HOOK == 1 )
\r
3068 extern void vApplicationIdleHook( void );
\r
3070 /* Call the user defined function from within the idle task. This
\r
3071 allows the application designer to add background functionality
\r
3072 without the overhead of a separate task.
\r
3073 NOTE: vApplicationIdleHook() MUST NOT, UNDER ANY CIRCUMSTANCES,
\r
3074 CALL A FUNCTION THAT MIGHT BLOCK. */
\r
3075 vApplicationIdleHook();
\r
3077 #endif /* configUSE_IDLE_HOOK */
\r
3079 /* This conditional compilation should use inequality to 0, not equality
\r
3080 to 1. This is to ensure portSUPPRESS_TICKS_AND_SLEEP() is called when
\r
3081 user defined low power mode implementations require
\r
3082 configUSE_TICKLESS_IDLE to be set to a value other than 1. */
\r
3083 #if ( configUSE_TICKLESS_IDLE != 0 )
\r
3085 TickType_t xExpectedIdleTime;
\r
3087 /* It is not desirable to suspend then resume the scheduler on
\r
3088 each iteration of the idle task. Therefore, a preliminary
\r
3089 test of the expected idle time is performed without the
\r
3090 scheduler suspended. The result here is not necessarily
\r
3092 xExpectedIdleTime = prvGetExpectedIdleTime();
\r
3094 if( xExpectedIdleTime >= configEXPECTED_IDLE_TIME_BEFORE_SLEEP )
\r
3096 vTaskSuspendAll();
\r
3098 /* Now the scheduler is suspended, the expected idle
\r
3099 time can be sampled again, and this time its value can
\r
3101 configASSERT( xNextTaskUnblockTime >= xTickCount );
\r
3102 xExpectedIdleTime = prvGetExpectedIdleTime();
\r
3104 if( xExpectedIdleTime >= configEXPECTED_IDLE_TIME_BEFORE_SLEEP )
\r
3106 traceLOW_POWER_IDLE_BEGIN();
\r
3107 portSUPPRESS_TICKS_AND_SLEEP( xExpectedIdleTime );
\r
3108 traceLOW_POWER_IDLE_END();
\r
3112 mtCOVERAGE_TEST_MARKER();
\r
3115 ( void ) xTaskResumeAll();
\r
3119 mtCOVERAGE_TEST_MARKER();
\r
3122 #endif /* configUSE_TICKLESS_IDLE */
\r
3125 /*-----------------------------------------------------------*/
\r
3127 #if( configUSE_TICKLESS_IDLE != 0 )
\r
3129 eSleepModeStatus eTaskConfirmSleepModeStatus( void )
\r
3131 /* The idle task exists in addition to the application tasks. */
\r
3132 const UBaseType_t uxNonApplicationTasks = 1;
\r
3133 eSleepModeStatus eReturn = eStandardSleep;
\r
3135 if( listCURRENT_LIST_LENGTH( &xPendingReadyList ) != 0 )
\r
3137 /* A task was made ready while the scheduler was suspended. */
\r
3138 eReturn = eAbortSleep;
\r
3140 else if( xYieldPending != pdFALSE )
\r
3142 /* A yield was pended while the scheduler was suspended. */
\r
3143 eReturn = eAbortSleep;
\r
3147 /* If all the tasks are in the suspended list (which might mean they
\r
3148 have an infinite block time rather than actually being suspended)
\r
3149 then it is safe to turn all clocks off and just wait for external
\r
3151 if( listCURRENT_LIST_LENGTH( &xSuspendedTaskList ) == ( uxCurrentNumberOfTasks - uxNonApplicationTasks ) )
\r
3153 eReturn = eNoTasksWaitingTimeout;
\r
3157 mtCOVERAGE_TEST_MARKER();
\r
3164 #endif /* configUSE_TICKLESS_IDLE */
\r
3165 /*-----------------------------------------------------------*/
\r
3167 #if ( configNUM_THREAD_LOCAL_STORAGE_POINTERS != 0 )
\r
3169 void vTaskSetThreadLocalStoragePointer( TaskHandle_t xTaskToSet, BaseType_t xIndex, void *pvValue )
\r
3173 if( xIndex < configNUM_THREAD_LOCAL_STORAGE_POINTERS )
\r
3175 pxTCB = prvGetTCBFromHandle( xTaskToSet );
\r
3176 pxTCB->pvThreadLocalStoragePointers[ xIndex ] = pvValue;
\r
3180 #endif /* configNUM_THREAD_LOCAL_STORAGE_POINTERS */
\r
3181 /*-----------------------------------------------------------*/
\r
3183 #if ( configNUM_THREAD_LOCAL_STORAGE_POINTERS != 0 )
\r
3185 void *pvTaskGetThreadLocalStoragePointer( TaskHandle_t xTaskToQuery, BaseType_t xIndex )
\r
3187 void *pvReturn = NULL;
\r
3190 if( xIndex < configNUM_THREAD_LOCAL_STORAGE_POINTERS )
\r
3192 pxTCB = prvGetTCBFromHandle( xTaskToQuery );
\r
3193 pvReturn = pxTCB->pvThreadLocalStoragePointers[ xIndex ];
\r
3203 #endif /* configNUM_THREAD_LOCAL_STORAGE_POINTERS */
\r
3204 /*-----------------------------------------------------------*/
\r
3206 #if ( portUSING_MPU_WRAPPERS == 1 )
\r
3208 void vTaskAllocateMPURegions( TaskHandle_t xTaskToModify, const MemoryRegion_t * const xRegions )
\r
3212 /* If null is passed in here then we are modifying the MPU settings of
\r
3213 the calling task. */
\r
3214 pxTCB = prvGetTCBFromHandle( xTaskToModify );
\r
3216 vPortStoreTaskMPUSettings( &( pxTCB->xMPUSettings ), xRegions, NULL, 0 );
\r
3219 #endif /* portUSING_MPU_WRAPPERS */
\r
3220 /*-----------------------------------------------------------*/
\r
3222 static void prvInitialiseTaskLists( void )
\r
3224 UBaseType_t uxPriority;
\r
3226 for( uxPriority = ( UBaseType_t ) 0U; uxPriority < ( UBaseType_t ) configMAX_PRIORITIES; uxPriority++ )
\r
3228 vListInitialise( &( pxReadyTasksLists[ uxPriority ] ) );
\r
3231 vListInitialise( &xDelayedTaskList1 );
\r
3232 vListInitialise( &xDelayedTaskList2 );
\r
3233 vListInitialise( &xPendingReadyList );
\r
3235 #if ( INCLUDE_vTaskDelete == 1 )
\r
3237 vListInitialise( &xTasksWaitingTermination );
\r
3239 #endif /* INCLUDE_vTaskDelete */
\r
3241 #if ( INCLUDE_vTaskSuspend == 1 )
\r
3243 vListInitialise( &xSuspendedTaskList );
\r
3245 #endif /* INCLUDE_vTaskSuspend */
\r
3247 /* Start with pxDelayedTaskList using list1 and the pxOverflowDelayedTaskList
\r
3249 pxDelayedTaskList = &xDelayedTaskList1;
\r
3250 pxOverflowDelayedTaskList = &xDelayedTaskList2;
\r
3252 /*-----------------------------------------------------------*/
\r
3254 static void prvCheckTasksWaitingTermination( void )
\r
3257 /** THIS FUNCTION IS CALLED FROM THE RTOS IDLE TASK **/
\r
3259 #if ( INCLUDE_vTaskDelete == 1 )
\r
3261 BaseType_t xListIsEmpty;
\r
3263 /* ucTasksDeleted is used to prevent vTaskSuspendAll() being called
\r
3264 too often in the idle task. */
\r
3265 while( uxDeletedTasksWaitingCleanUp > ( UBaseType_t ) 0U )
\r
3267 vTaskSuspendAll();
\r
3269 xListIsEmpty = listLIST_IS_EMPTY( &xTasksWaitingTermination );
\r
3271 ( void ) xTaskResumeAll();
\r
3273 if( xListIsEmpty == pdFALSE )
\r
3277 taskENTER_CRITICAL();
\r
3279 pxTCB = ( TCB_t * ) listGET_OWNER_OF_HEAD_ENTRY( ( &xTasksWaitingTermination ) );
\r
3280 ( void ) uxListRemove( &( pxTCB->xStateListItem ) );
\r
3281 --uxCurrentNumberOfTasks;
\r
3282 --uxDeletedTasksWaitingCleanUp;
\r
3284 taskEXIT_CRITICAL();
\r
3286 prvDeleteTCB( pxTCB );
\r
3290 mtCOVERAGE_TEST_MARKER();
\r
3294 #endif /* INCLUDE_vTaskDelete */
\r
3296 /*-----------------------------------------------------------*/
\r
3298 #if( configUSE_TRACE_FACILITY == 1 )
\r
3300 void vTaskGetTaskInfo( TaskHandle_t xTask, TaskStatus_t *pxTaskStatus, BaseType_t xGetFreeStackSpace, eTaskState eState )
\r
3304 /* xTask is NULL then get the state of the calling task. */
\r
3305 pxTCB = prvGetTCBFromHandle( xTask );
\r
3307 pxTaskStatus->xHandle = ( TaskHandle_t ) pxTCB;
\r
3308 pxTaskStatus->pcTaskName = ( const char * ) &( pxTCB->pcTaskName [ 0 ] );
\r
3309 pxTaskStatus->uxCurrentPriority = pxTCB->uxPriority;
\r
3310 pxTaskStatus->pxStackBase = pxTCB->pxStack;
\r
3311 pxTaskStatus->xTaskNumber = pxTCB->uxTCBNumber;
\r
3313 #if ( INCLUDE_vTaskSuspend == 1 )
\r
3315 /* If the task is in the suspended list then there is a chance it is
\r
3316 actually just blocked indefinitely - so really it should be reported as
\r
3317 being in the Blocked state. */
\r
3318 if( pxTaskStatus->eCurrentState == eSuspended )
\r
3320 vTaskSuspendAll();
\r
3322 if( listLIST_ITEM_CONTAINER( &( pxTCB->xEventListItem ) ) != NULL )
\r
3324 pxTaskStatus->eCurrentState = eBlocked;
\r
3330 #endif /* INCLUDE_vTaskSuspend */
\r
3332 #if ( configUSE_MUTEXES == 1 )
\r
3334 pxTaskStatus->uxBasePriority = pxTCB->uxBasePriority;
\r
3338 pxTaskStatus->uxBasePriority = 0;
\r
3342 #if ( configGENERATE_RUN_TIME_STATS == 1 )
\r
3344 pxTaskStatus->ulRunTimeCounter = pxTCB->ulRunTimeCounter;
\r
3348 pxTaskStatus->ulRunTimeCounter = 0;
\r
3352 /* Obtaining the task state is a little fiddly, so is only done if the value
\r
3353 of eState passed into this function is eInvalid - otherwise the state is
\r
3354 just set to whatever is passed in. */
\r
3355 if( eState != eInvalid )
\r
3357 pxTaskStatus->eCurrentState = eState;
\r
3361 pxTaskStatus->eCurrentState = eTaskGetState( xTask );
\r
3364 /* Obtaining the stack space takes some time, so the xGetFreeStackSpace
\r
3365 parameter is provided to allow it to be skipped. */
\r
3366 if( xGetFreeStackSpace != pdFALSE )
\r
3368 #if ( portSTACK_GROWTH > 0 )
\r
3370 pxTaskStatus->usStackHighWaterMark = prvTaskCheckFreeStackSpace( ( uint8_t * ) pxTCB->pxEndOfStack );
\r
3374 pxTaskStatus->usStackHighWaterMark = prvTaskCheckFreeStackSpace( ( uint8_t * ) pxTCB->pxStack );
\r
3380 pxTaskStatus->usStackHighWaterMark = 0;
\r
3384 #endif /* configUSE_TRACE_FACILITY */
\r
3385 /*-----------------------------------------------------------*/
\r
3387 #if ( configUSE_TRACE_FACILITY == 1 )
\r
3389 static UBaseType_t prvListTasksWithinSingleList( TaskStatus_t *pxTaskStatusArray, List_t *pxList, eTaskState eState )
\r
3391 volatile TCB_t *pxNextTCB, *pxFirstTCB;
\r
3392 UBaseType_t uxTask = 0;
\r
3394 if( listCURRENT_LIST_LENGTH( pxList ) > ( UBaseType_t ) 0 )
\r
3396 listGET_OWNER_OF_NEXT_ENTRY( pxFirstTCB, pxList );
\r
3398 /* Populate an TaskStatus_t structure within the
\r
3399 pxTaskStatusArray array for each task that is referenced from
\r
3400 pxList. See the definition of TaskStatus_t in task.h for the
\r
3401 meaning of each TaskStatus_t structure member. */
\r
3404 listGET_OWNER_OF_NEXT_ENTRY( pxNextTCB, pxList );
\r
3405 vTaskGetTaskInfo( ( TaskHandle_t ) pxNextTCB, &( pxTaskStatusArray[ uxTask ] ), pdTRUE, eState );
\r
3407 } while( pxNextTCB != pxFirstTCB );
\r
3411 mtCOVERAGE_TEST_MARKER();
\r
3417 #endif /* configUSE_TRACE_FACILITY */
\r
3418 /*-----------------------------------------------------------*/
\r
3420 #if ( ( configUSE_TRACE_FACILITY == 1 ) || ( INCLUDE_uxTaskGetStackHighWaterMark == 1 ) )
\r
3422 static uint16_t prvTaskCheckFreeStackSpace( const uint8_t * pucStackByte )
\r
3424 uint32_t ulCount = 0U;
\r
3426 while( *pucStackByte == ( uint8_t ) tskSTACK_FILL_BYTE )
\r
3428 pucStackByte -= portSTACK_GROWTH;
\r
3432 ulCount /= ( uint32_t ) sizeof( StackType_t ); /*lint !e961 Casting is not redundant on smaller architectures. */
\r
3434 return ( uint16_t ) ulCount;
\r
3437 #endif /* ( ( configUSE_TRACE_FACILITY == 1 ) || ( INCLUDE_uxTaskGetStackHighWaterMark == 1 ) ) */
\r
3438 /*-----------------------------------------------------------*/
\r
3440 #if ( INCLUDE_uxTaskGetStackHighWaterMark == 1 )
\r
3442 UBaseType_t uxTaskGetStackHighWaterMark( TaskHandle_t xTask )
\r
3445 uint8_t *pucEndOfStack;
\r
3446 UBaseType_t uxReturn;
\r
3448 pxTCB = prvGetTCBFromHandle( xTask );
\r
3450 #if portSTACK_GROWTH < 0
\r
3452 pucEndOfStack = ( uint8_t * ) pxTCB->pxStack;
\r
3456 pucEndOfStack = ( uint8_t * ) pxTCB->pxEndOfStack;
\r
3460 uxReturn = ( UBaseType_t ) prvTaskCheckFreeStackSpace( pucEndOfStack );
\r
3465 #endif /* INCLUDE_uxTaskGetStackHighWaterMark */
\r
3466 /*-----------------------------------------------------------*/
\r
3468 #if ( INCLUDE_vTaskDelete == 1 )
\r
3470 static void prvDeleteTCB( TCB_t *pxTCB )
\r
3472 /* This call is required specifically for the TriCore port. It must be
\r
3473 above the vPortFree() calls. The call is also used by ports/demos that
\r
3474 want to allocate and clean RAM statically. */
\r
3475 portCLEAN_UP_TCB( pxTCB );
\r
3477 /* Free up the memory allocated by the scheduler for the task. It is up
\r
3478 to the task to free any memory allocated at the application level. */
\r
3479 #if ( configUSE_NEWLIB_REENTRANT == 1 )
\r
3481 _reclaim_reent( &( pxTCB->xNewLib_reent ) );
\r
3483 #endif /* configUSE_NEWLIB_REENTRANT */
\r
3485 #if( ( configSUPPORT_DYNAMIC_ALLOCATION == 1 ) && ( configSUPPORT_STATIC_ALLOCATION == 0 ) )
\r
3487 /* The task can only have been allocated dynamically - free it
\r
3489 vPortFree( pxTCB->pxStack );
\r
3490 vPortFree( pxTCB );
\r
3492 #elif( ( configSUPPORT_DYNAMIC_ALLOCATION == 1 ) && ( configSUPPORT_STATIC_ALLOCATION == 1 ) )
\r
3494 /* The task could have been allocated statically or dynamically, so
\r
3495 check before attempting to free the memory. */
\r
3496 if( pxTCB->ucStaticallyAllocated == ( uint8_t ) pdFALSE )
\r
3498 vPortFree( pxTCB->pxStack );
\r
3499 vPortFree( pxTCB );
\r
3503 mtCOVERAGE_TEST_MARKER();
\r
3506 #endif /* configSUPPORT_DYNAMIC_ALLOCATION */
\r
3509 #endif /* INCLUDE_vTaskDelete */
\r
3510 /*-----------------------------------------------------------*/
\r
3512 static void prvResetNextTaskUnblockTime( void )
\r
3516 if( listLIST_IS_EMPTY( pxDelayedTaskList ) != pdFALSE )
\r
3518 /* The new current delayed list is empty. Set xNextTaskUnblockTime to
\r
3519 the maximum possible value so it is extremely unlikely that the
\r
3520 if( xTickCount >= xNextTaskUnblockTime ) test will pass until
\r
3521 there is an item in the delayed list. */
\r
3522 xNextTaskUnblockTime = portMAX_DELAY;
\r
3526 /* The new current delayed list is not empty, get the value of
\r
3527 the item at the head of the delayed list. This is the time at
\r
3528 which the task at the head of the delayed list should be removed
\r
3529 from the Blocked state. */
\r
3530 ( pxTCB ) = ( TCB_t * ) listGET_OWNER_OF_HEAD_ENTRY( pxDelayedTaskList );
\r
3531 xNextTaskUnblockTime = listGET_LIST_ITEM_VALUE( &( ( pxTCB )->xStateListItem ) );
\r
3534 /*-----------------------------------------------------------*/
\r
3536 #if ( ( INCLUDE_xTaskGetCurrentTaskHandle == 1 ) || ( configUSE_MUTEXES == 1 ) )
\r
3538 TaskHandle_t xTaskGetCurrentTaskHandle( void )
\r
3540 TaskHandle_t xReturn;
\r
3542 /* A critical section is not required as this is not called from
\r
3543 an interrupt and the current TCB will always be the same for any
\r
3544 individual execution thread. */
\r
3545 xReturn = pxCurrentTCB;
\r
3550 #endif /* ( ( INCLUDE_xTaskGetCurrentTaskHandle == 1 ) || ( configUSE_MUTEXES == 1 ) ) */
\r
3551 /*-----------------------------------------------------------*/
\r
3553 #if ( ( INCLUDE_xTaskGetSchedulerState == 1 ) || ( configUSE_TIMERS == 1 ) )
\r
3555 BaseType_t xTaskGetSchedulerState( void )
\r
3557 BaseType_t xReturn;
\r
3559 if( xSchedulerRunning == pdFALSE )
\r
3561 xReturn = taskSCHEDULER_NOT_STARTED;
\r
3565 if( uxSchedulerSuspended == ( UBaseType_t ) pdFALSE )
\r
3567 xReturn = taskSCHEDULER_RUNNING;
\r
3571 xReturn = taskSCHEDULER_SUSPENDED;
\r
3578 #endif /* ( ( INCLUDE_xTaskGetSchedulerState == 1 ) || ( configUSE_TIMERS == 1 ) ) */
\r
3579 /*-----------------------------------------------------------*/
\r
3581 #if ( configUSE_MUTEXES == 1 )
\r
3583 void vTaskPriorityInherit( TaskHandle_t const pxMutexHolder )
\r
3585 TCB_t * const pxTCB = ( TCB_t * ) pxMutexHolder;
\r
3587 /* If the mutex was given back by an interrupt while the queue was
\r
3588 locked then the mutex holder might now be NULL. */
\r
3589 if( pxMutexHolder != NULL )
\r
3591 /* If the holder of the mutex has a priority below the priority of
\r
3592 the task attempting to obtain the mutex then it will temporarily
\r
3593 inherit the priority of the task attempting to obtain the mutex. */
\r
3594 if( pxTCB->uxPriority < pxCurrentTCB->uxPriority )
\r
3596 /* Adjust the mutex holder state to account for its new
\r
3597 priority. Only reset the event list item value if the value is
\r
3598 not being used for anything else. */
\r
3599 if( ( listGET_LIST_ITEM_VALUE( &( pxTCB->xEventListItem ) ) & taskEVENT_LIST_ITEM_VALUE_IN_USE ) == 0UL )
\r
3601 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
3605 mtCOVERAGE_TEST_MARKER();
\r
3608 /* If the task being modified is in the ready state it will need
\r
3609 to be moved into a new list. */
\r
3610 if( listIS_CONTAINED_WITHIN( &( pxReadyTasksLists[ pxTCB->uxPriority ] ), &( pxTCB->xStateListItem ) ) != pdFALSE )
\r
3612 if( uxListRemove( &( pxTCB->xStateListItem ) ) == ( UBaseType_t ) 0 )
\r
3614 taskRESET_READY_PRIORITY( pxTCB->uxPriority );
\r
3618 mtCOVERAGE_TEST_MARKER();
\r
3621 /* Inherit the priority before being moved into the new list. */
\r
3622 pxTCB->uxPriority = pxCurrentTCB->uxPriority;
\r
3623 prvAddTaskToReadyList( pxTCB );
\r
3627 /* Just inherit the priority. */
\r
3628 pxTCB->uxPriority = pxCurrentTCB->uxPriority;
\r
3631 traceTASK_PRIORITY_INHERIT( pxTCB, pxCurrentTCB->uxPriority );
\r
3635 mtCOVERAGE_TEST_MARKER();
\r
3640 mtCOVERAGE_TEST_MARKER();
\r
3644 #endif /* configUSE_MUTEXES */
\r
3645 /*-----------------------------------------------------------*/
\r
3647 #if ( configUSE_MUTEXES == 1 )
\r
3649 BaseType_t xTaskPriorityDisinherit( TaskHandle_t const pxMutexHolder )
\r
3651 TCB_t * const pxTCB = ( TCB_t * ) pxMutexHolder;
\r
3652 BaseType_t xReturn = pdFALSE;
\r
3654 if( pxMutexHolder != NULL )
\r
3656 /* A task can only have an inherited priority if it holds the mutex.
\r
3657 If the mutex is held by a task then it cannot be given from an
\r
3658 interrupt, and if a mutex is given by the holding task then it must
\r
3659 be the running state task. */
\r
3660 configASSERT( pxTCB == pxCurrentTCB );
\r
3662 configASSERT( pxTCB->uxMutexesHeld );
\r
3663 ( pxTCB->uxMutexesHeld )--;
\r
3665 /* Has the holder of the mutex inherited the priority of another
\r
3667 if( pxTCB->uxPriority != pxTCB->uxBasePriority )
\r
3669 /* Only disinherit if no other mutexes are held. */
\r
3670 if( pxTCB->uxMutexesHeld == ( UBaseType_t ) 0 )
\r
3672 /* A task can only have an inherited priority if it holds
\r
3673 the mutex. If the mutex is held by a task then it cannot be
\r
3674 given from an interrupt, and if a mutex is given by the
\r
3675 holding task then it must be the running state task. Remove
\r
3676 the holding task from the ready list. */
\r
3677 if( uxListRemove( &( pxTCB->xStateListItem ) ) == ( UBaseType_t ) 0 )
\r
3679 taskRESET_READY_PRIORITY( pxTCB->uxPriority );
\r
3683 mtCOVERAGE_TEST_MARKER();
\r
3686 /* Disinherit the priority before adding the task into the
\r
3687 new ready list. */
\r
3688 traceTASK_PRIORITY_DISINHERIT( pxTCB, pxTCB->uxBasePriority );
\r
3689 pxTCB->uxPriority = pxTCB->uxBasePriority;
\r
3691 /* Reset the event list item value. It cannot be in use for
\r
3692 any other purpose if this task is running, and it must be
\r
3693 running to give back the mutex. */
\r
3694 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
3695 prvAddTaskToReadyList( pxTCB );
\r
3697 /* Return true to indicate that a context switch is required.
\r
3698 This is only actually required in the corner case whereby
\r
3699 multiple mutexes were held and the mutexes were given back
\r
3700 in an order different to that in which they were taken.
\r
3701 If a context switch did not occur when the first mutex was
\r
3702 returned, even if a task was waiting on it, then a context
\r
3703 switch should occur when the last mutex is returned whether
\r
3704 a task is waiting on it or not. */
\r
3709 mtCOVERAGE_TEST_MARKER();
\r
3714 mtCOVERAGE_TEST_MARKER();
\r
3719 mtCOVERAGE_TEST_MARKER();
\r
3725 #endif /* configUSE_MUTEXES */
\r
3726 /*-----------------------------------------------------------*/
\r
3728 #if ( portCRITICAL_NESTING_IN_TCB == 1 )
\r
3730 void vTaskEnterCritical( void )
\r
3732 portDISABLE_INTERRUPTS();
\r
3734 if( xSchedulerRunning != pdFALSE )
\r
3736 ( pxCurrentTCB->uxCriticalNesting )++;
\r
3738 /* This is not the interrupt safe version of the enter critical
\r
3739 function so assert() if it is being called from an interrupt
\r
3740 context. Only API functions that end in "FromISR" can be used in an
\r
3741 interrupt. Only assert if the critical nesting count is 1 to
\r
3742 protect against recursive calls if the assert function also uses a
\r
3743 critical section. */
\r
3744 if( pxCurrentTCB->uxCriticalNesting == 1 )
\r
3746 portASSERT_IF_IN_ISR();
\r
3751 mtCOVERAGE_TEST_MARKER();
\r
3755 #endif /* portCRITICAL_NESTING_IN_TCB */
\r
3756 /*-----------------------------------------------------------*/
\r
3758 #if ( portCRITICAL_NESTING_IN_TCB == 1 )
\r
3760 void vTaskExitCritical( void )
\r
3762 if( xSchedulerRunning != pdFALSE )
\r
3764 if( pxCurrentTCB->uxCriticalNesting > 0U )
\r
3766 ( pxCurrentTCB->uxCriticalNesting )--;
\r
3768 if( pxCurrentTCB->uxCriticalNesting == 0U )
\r
3770 portENABLE_INTERRUPTS();
\r
3774 mtCOVERAGE_TEST_MARKER();
\r
3779 mtCOVERAGE_TEST_MARKER();
\r
3784 mtCOVERAGE_TEST_MARKER();
\r
3788 #endif /* portCRITICAL_NESTING_IN_TCB */
\r
3789 /*-----------------------------------------------------------*/
\r
3791 #if ( ( configUSE_TRACE_FACILITY == 1 ) && ( configUSE_STATS_FORMATTING_FUNCTIONS > 0 ) )
\r
3793 static char *prvWriteNameToBuffer( char *pcBuffer, const char *pcTaskName )
\r
3797 /* Start by copying the entire string. */
\r
3798 strcpy( pcBuffer, pcTaskName );
\r
3800 /* Pad the end of the string with spaces to ensure columns line up when
\r
3802 for( x = strlen( pcBuffer ); x < ( size_t ) ( configMAX_TASK_NAME_LEN - 1 ); x++ )
\r
3804 pcBuffer[ x ] = ' ';
\r
3808 pcBuffer[ x ] = 0x00;
\r
3810 /* Return the new end of string. */
\r
3811 return &( pcBuffer[ x ] );
\r
3814 #endif /* ( configUSE_TRACE_FACILITY == 1 ) && ( configUSE_STATS_FORMATTING_FUNCTIONS > 0 ) */
\r
3815 /*-----------------------------------------------------------*/
\r
3817 #if ( ( configUSE_TRACE_FACILITY == 1 ) && ( configUSE_STATS_FORMATTING_FUNCTIONS > 0 ) )
\r
3819 void vTaskList( char * pcWriteBuffer )
\r
3821 TaskStatus_t *pxTaskStatusArray;
\r
3822 volatile UBaseType_t uxArraySize, x;
\r
3828 * This function is provided for convenience only, and is used by many
\r
3829 * of the demo applications. Do not consider it to be part of the
\r
3832 * vTaskList() calls uxTaskGetSystemState(), then formats part of the
\r
3833 * uxTaskGetSystemState() output into a human readable table that
\r
3834 * displays task names, states and stack usage.
\r
3836 * vTaskList() has a dependency on the sprintf() C library function that
\r
3837 * might bloat the code size, use a lot of stack, and provide different
\r
3838 * results on different platforms. An alternative, tiny, third party,
\r
3839 * and limited functionality implementation of sprintf() is provided in
\r
3840 * many of the FreeRTOS/Demo sub-directories in a file called
\r
3841 * printf-stdarg.c (note printf-stdarg.c does not provide a full
\r
3842 * snprintf() implementation!).
\r
3844 * It is recommended that production systems call uxTaskGetSystemState()
\r
3845 * directly to get access to raw stats data, rather than indirectly
\r
3846 * through a call to vTaskList().
\r
3850 /* Make sure the write buffer does not contain a string. */
\r
3851 *pcWriteBuffer = 0x00;
\r
3853 /* Take a snapshot of the number of tasks in case it changes while this
\r
3854 function is executing. */
\r
3855 uxArraySize = uxCurrentNumberOfTasks;
\r
3857 /* Allocate an array index for each task. NOTE! if
\r
3858 configSUPPORT_DYNAMIC_ALLOCATION is set to 0 then pvPortMalloc() will
\r
3859 equate to NULL. */
\r
3860 pxTaskStatusArray = pvPortMalloc( uxCurrentNumberOfTasks * sizeof( TaskStatus_t ) );
\r
3862 if( pxTaskStatusArray != NULL )
\r
3864 /* Generate the (binary) data. */
\r
3865 uxArraySize = uxTaskGetSystemState( pxTaskStatusArray, uxArraySize, NULL );
\r
3867 /* Create a human readable table from the binary data. */
\r
3868 for( x = 0; x < uxArraySize; x++ )
\r
3870 switch( pxTaskStatusArray[ x ].eCurrentState )
\r
3872 case eReady: cStatus = tskREADY_CHAR;
\r
3875 case eBlocked: cStatus = tskBLOCKED_CHAR;
\r
3878 case eSuspended: cStatus = tskSUSPENDED_CHAR;
\r
3881 case eDeleted: cStatus = tskDELETED_CHAR;
\r
3884 default: /* Should not get here, but it is included
\r
3885 to prevent static checking errors. */
\r
3890 /* Write the task name to the string, padding with spaces so it
\r
3891 can be printed in tabular form more easily. */
\r
3892 pcWriteBuffer = prvWriteNameToBuffer( pcWriteBuffer, pxTaskStatusArray[ x ].pcTaskName );
\r
3894 /* Write the rest of the string. */
\r
3895 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
3896 pcWriteBuffer += strlen( pcWriteBuffer );
\r
3899 /* Free the array again. NOTE! If configSUPPORT_DYNAMIC_ALLOCATION
\r
3900 is 0 then vPortFree() will be #defined to nothing. */
\r
3901 vPortFree( pxTaskStatusArray );
\r
3905 mtCOVERAGE_TEST_MARKER();
\r
3909 #endif /* ( ( configUSE_TRACE_FACILITY == 1 ) && ( configUSE_STATS_FORMATTING_FUNCTIONS > 0 ) ) */
\r
3910 /*----------------------------------------------------------*/
\r
3912 #if ( ( configGENERATE_RUN_TIME_STATS == 1 ) && ( configUSE_STATS_FORMATTING_FUNCTIONS > 0 ) )
\r
3914 void vTaskGetRunTimeStats( char *pcWriteBuffer )
\r
3916 TaskStatus_t *pxTaskStatusArray;
\r
3917 volatile UBaseType_t uxArraySize, x;
\r
3918 uint32_t ulTotalTime, ulStatsAsPercentage;
\r
3920 #if( configUSE_TRACE_FACILITY != 1 )
\r
3922 #error configUSE_TRACE_FACILITY must also be set to 1 in FreeRTOSConfig.h to use vTaskGetRunTimeStats().
\r
3929 * This function is provided for convenience only, and is used by many
\r
3930 * of the demo applications. Do not consider it to be part of the
\r
3933 * vTaskGetRunTimeStats() calls uxTaskGetSystemState(), then formats part
\r
3934 * of the uxTaskGetSystemState() output into a human readable table that
\r
3935 * displays the amount of time each task has spent in the Running state
\r
3936 * in both absolute and percentage terms.
\r
3938 * vTaskGetRunTimeStats() has a dependency on the sprintf() C library
\r
3939 * function that might bloat the code size, use a lot of stack, and
\r
3940 * provide different results on different platforms. An alternative,
\r
3941 * tiny, third party, and limited functionality implementation of
\r
3942 * sprintf() is provided in many of the FreeRTOS/Demo sub-directories in
\r
3943 * a file called printf-stdarg.c (note printf-stdarg.c does not provide
\r
3944 * a full snprintf() implementation!).
\r
3946 * It is recommended that production systems call uxTaskGetSystemState()
\r
3947 * directly to get access to raw stats data, rather than indirectly
\r
3948 * through a call to vTaskGetRunTimeStats().
\r
3951 /* Make sure the write buffer does not contain a string. */
\r
3952 *pcWriteBuffer = 0x00;
\r
3954 /* Take a snapshot of the number of tasks in case it changes while this
\r
3955 function is executing. */
\r
3956 uxArraySize = uxCurrentNumberOfTasks;
\r
3958 /* Allocate an array index for each task. NOTE! If
\r
3959 configSUPPORT_DYNAMIC_ALLOCATION is set to 0 then pvPortMalloc() will
\r
3960 equate to NULL. */
\r
3961 pxTaskStatusArray = pvPortMalloc( uxCurrentNumberOfTasks * sizeof( TaskStatus_t ) );
\r
3963 if( pxTaskStatusArray != NULL )
\r
3965 /* Generate the (binary) data. */
\r
3966 uxArraySize = uxTaskGetSystemState( pxTaskStatusArray, uxArraySize, &ulTotalTime );
\r
3968 /* For percentage calculations. */
\r
3969 ulTotalTime /= 100UL;
\r
3971 /* Avoid divide by zero errors. */
\r
3972 if( ulTotalTime > 0 )
\r
3974 /* Create a human readable table from the binary data. */
\r
3975 for( x = 0; x < uxArraySize; x++ )
\r
3977 /* What percentage of the total run time has the task used?
\r
3978 This will always be rounded down to the nearest integer.
\r
3979 ulTotalRunTimeDiv100 has already been divided by 100. */
\r
3980 ulStatsAsPercentage = pxTaskStatusArray[ x ].ulRunTimeCounter / ulTotalTime;
\r
3982 /* Write the task name to the string, padding with
\r
3983 spaces so it can be printed in tabular form more
\r
3985 pcWriteBuffer = prvWriteNameToBuffer( pcWriteBuffer, pxTaskStatusArray[ x ].pcTaskName );
\r
3987 if( ulStatsAsPercentage > 0UL )
\r
3989 #ifdef portLU_PRINTF_SPECIFIER_REQUIRED
\r
3991 sprintf( pcWriteBuffer, "\t%lu\t\t%lu%%\r\n", pxTaskStatusArray[ x ].ulRunTimeCounter, ulStatsAsPercentage );
\r
3995 /* sizeof( int ) == sizeof( long ) so a smaller
\r
3996 printf() library can be used. */
\r
3997 sprintf( pcWriteBuffer, "\t%u\t\t%u%%\r\n", ( unsigned int ) pxTaskStatusArray[ x ].ulRunTimeCounter, ( unsigned int ) ulStatsAsPercentage );
\r
4003 /* If the percentage is zero here then the task has
\r
4004 consumed less than 1% of the total run time. */
\r
4005 #ifdef portLU_PRINTF_SPECIFIER_REQUIRED
\r
4007 sprintf( pcWriteBuffer, "\t%lu\t\t<1%%\r\n", pxTaskStatusArray[ x ].ulRunTimeCounter );
\r
4011 /* sizeof( int ) == sizeof( long ) so a smaller
\r
4012 printf() library can be used. */
\r
4013 sprintf( pcWriteBuffer, "\t%u\t\t<1%%\r\n", ( unsigned int ) pxTaskStatusArray[ x ].ulRunTimeCounter );
\r
4018 pcWriteBuffer += strlen( pcWriteBuffer );
\r
4023 mtCOVERAGE_TEST_MARKER();
\r
4026 /* Free the array again. NOTE! If configSUPPORT_DYNAMIC_ALLOCATION
\r
4027 is 0 then vPortFree() will be #defined to nothing. */
\r
4028 vPortFree( pxTaskStatusArray );
\r
4032 mtCOVERAGE_TEST_MARKER();
\r
4036 #endif /* ( ( configGENERATE_RUN_TIME_STATS == 1 ) && ( configUSE_STATS_FORMATTING_FUNCTIONS > 0 ) ) */
\r
4037 /*-----------------------------------------------------------*/
\r
4039 TickType_t uxTaskResetEventItemValue( void )
\r
4041 TickType_t uxReturn;
\r
4043 uxReturn = listGET_LIST_ITEM_VALUE( &( pxCurrentTCB->xEventListItem ) );
\r
4045 /* Reset the event list item to its normal value - so it can be used with
\r
4046 queues and semaphores. */
\r
4047 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
4051 /*-----------------------------------------------------------*/
\r
4053 #if ( configUSE_MUTEXES == 1 )
\r
4055 void *pvTaskIncrementMutexHeldCount( void )
\r
4057 /* If xSemaphoreCreateMutex() is called before any tasks have been created
\r
4058 then pxCurrentTCB will be NULL. */
\r
4059 if( pxCurrentTCB != NULL )
\r
4061 ( pxCurrentTCB->uxMutexesHeld )++;
\r
4064 return pxCurrentTCB;
\r
4067 #endif /* configUSE_MUTEXES */
\r
4068 /*-----------------------------------------------------------*/
\r
4070 #if( configUSE_TASK_NOTIFICATIONS == 1 )
\r
4072 uint32_t ulTaskNotifyTake( BaseType_t xClearCountOnExit, TickType_t xTicksToWait )
\r
4074 uint32_t ulReturn;
\r
4076 taskENTER_CRITICAL();
\r
4078 /* Only block if the notification count is not already non-zero. */
\r
4079 if( pxCurrentTCB->ulNotifiedValue == 0UL )
\r
4081 /* Mark this task as waiting for a notification. */
\r
4082 pxCurrentTCB->ucNotifyState = taskWAITING_NOTIFICATION;
\r
4084 if( xTicksToWait > ( TickType_t ) 0 )
\r
4086 prvAddCurrentTaskToDelayedList( xTicksToWait, pdTRUE );
\r
4087 traceTASK_NOTIFY_TAKE_BLOCK();
\r
4089 /* All ports are written to allow a yield in a critical
\r
4090 section (some will yield immediately, others wait until the
\r
4091 critical section exits) - but it is not something that
\r
4092 application code should ever do. */
\r
4093 portYIELD_WITHIN_API();
\r
4097 mtCOVERAGE_TEST_MARKER();
\r
4102 mtCOVERAGE_TEST_MARKER();
\r
4105 taskEXIT_CRITICAL();
\r
4107 taskENTER_CRITICAL();
\r
4109 traceTASK_NOTIFY_TAKE();
\r
4110 ulReturn = pxCurrentTCB->ulNotifiedValue;
\r
4112 if( ulReturn != 0UL )
\r
4114 if( xClearCountOnExit != pdFALSE )
\r
4116 pxCurrentTCB->ulNotifiedValue = 0UL;
\r
4120 pxCurrentTCB->ulNotifiedValue = ulReturn - 1;
\r
4125 mtCOVERAGE_TEST_MARKER();
\r
4128 pxCurrentTCB->ucNotifyState = taskNOT_WAITING_NOTIFICATION;
\r
4130 taskEXIT_CRITICAL();
\r
4135 #endif /* configUSE_TASK_NOTIFICATIONS */
\r
4136 /*-----------------------------------------------------------*/
\r
4138 #if( configUSE_TASK_NOTIFICATIONS == 1 )
\r
4140 BaseType_t xTaskNotifyWait( uint32_t ulBitsToClearOnEntry, uint32_t ulBitsToClearOnExit, uint32_t *pulNotificationValue, TickType_t xTicksToWait )
\r
4142 BaseType_t xReturn;
\r
4144 taskENTER_CRITICAL();
\r
4146 /* Only block if a notification is not already pending. */
\r
4147 if( pxCurrentTCB->ucNotifyState != taskNOTIFICATION_RECEIVED )
\r
4149 /* Clear bits in the task's notification value as bits may get
\r
4150 set by the notifying task or interrupt. This can be used to
\r
4151 clear the value to zero. */
\r
4152 pxCurrentTCB->ulNotifiedValue &= ~ulBitsToClearOnEntry;
\r
4154 /* Mark this task as waiting for a notification. */
\r
4155 pxCurrentTCB->ucNotifyState = taskWAITING_NOTIFICATION;
\r
4157 if( xTicksToWait > ( TickType_t ) 0 )
\r
4159 prvAddCurrentTaskToDelayedList( xTicksToWait, pdTRUE );
\r
4160 traceTASK_NOTIFY_WAIT_BLOCK();
\r
4162 /* All ports are written to allow a yield in a critical
\r
4163 section (some will yield immediately, others wait until the
\r
4164 critical section exits) - but it is not something that
\r
4165 application code should ever do. */
\r
4166 portYIELD_WITHIN_API();
\r
4170 mtCOVERAGE_TEST_MARKER();
\r
4175 mtCOVERAGE_TEST_MARKER();
\r
4178 taskEXIT_CRITICAL();
\r
4180 taskENTER_CRITICAL();
\r
4182 traceTASK_NOTIFY_WAIT();
\r
4184 if( pulNotificationValue != NULL )
\r
4186 /* Output the current notification value, which may or may not
\r
4188 *pulNotificationValue = pxCurrentTCB->ulNotifiedValue;
\r
4191 /* If ucNotifyValue is set then either the task never entered the
\r
4192 blocked state (because a notification was already pending) or the
\r
4193 task unblocked because of a notification. Otherwise the task
\r
4194 unblocked because of a timeout. */
\r
4195 if( pxCurrentTCB->ucNotifyState == taskWAITING_NOTIFICATION )
\r
4197 /* A notification was not received. */
\r
4198 xReturn = pdFALSE;
\r
4202 /* A notification was already pending or a notification was
\r
4203 received while the task was waiting. */
\r
4204 pxCurrentTCB->ulNotifiedValue &= ~ulBitsToClearOnExit;
\r
4208 pxCurrentTCB->ucNotifyState = taskNOT_WAITING_NOTIFICATION;
\r
4210 taskEXIT_CRITICAL();
\r
4215 #endif /* configUSE_TASK_NOTIFICATIONS */
\r
4216 /*-----------------------------------------------------------*/
\r
4218 #if( configUSE_TASK_NOTIFICATIONS == 1 )
\r
4220 BaseType_t xTaskGenericNotify( TaskHandle_t xTaskToNotify, uint32_t ulValue, eNotifyAction eAction, uint32_t *pulPreviousNotificationValue )
\r
4223 BaseType_t xReturn = pdPASS;
\r
4224 uint8_t ucOriginalNotifyState;
\r
4226 configASSERT( xTaskToNotify );
\r
4227 pxTCB = ( TCB_t * ) xTaskToNotify;
\r
4229 taskENTER_CRITICAL();
\r
4231 if( pulPreviousNotificationValue != NULL )
\r
4233 *pulPreviousNotificationValue = pxTCB->ulNotifiedValue;
\r
4236 ucOriginalNotifyState = pxTCB->ucNotifyState;
\r
4238 pxTCB->ucNotifyState = taskNOTIFICATION_RECEIVED;
\r
4243 pxTCB->ulNotifiedValue |= ulValue;
\r
4247 ( pxTCB->ulNotifiedValue )++;
\r
4250 case eSetValueWithOverwrite :
\r
4251 pxTCB->ulNotifiedValue = ulValue;
\r
4254 case eSetValueWithoutOverwrite :
\r
4255 if( ucOriginalNotifyState != taskNOTIFICATION_RECEIVED )
\r
4257 pxTCB->ulNotifiedValue = ulValue;
\r
4261 /* The value could not be written to the task. */
\r
4267 /* The task is being notified without its notify value being
\r
4272 traceTASK_NOTIFY();
\r
4274 /* If the task is in the blocked state specifically to wait for a
\r
4275 notification then unblock it now. */
\r
4276 if( ucOriginalNotifyState == taskWAITING_NOTIFICATION )
\r
4278 ( void ) uxListRemove( &( pxTCB->xStateListItem ) );
\r
4279 prvAddTaskToReadyList( pxTCB );
\r
4281 /* The task should not have been on an event list. */
\r
4282 configASSERT( listLIST_ITEM_CONTAINER( &( pxTCB->xEventListItem ) ) == NULL );
\r
4284 #if( configUSE_TICKLESS_IDLE != 0 )
\r
4286 /* If a task is blocked waiting for a notification then
\r
4287 xNextTaskUnblockTime might be set to the blocked task's time
\r
4288 out time. If the task is unblocked for a reason other than
\r
4289 a timeout xNextTaskUnblockTime is normally left unchanged,
\r
4290 because it will automatically get reset to a new value when
\r
4291 the tick count equals xNextTaskUnblockTime. However if
\r
4292 tickless idling is used it might be more important to enter
\r
4293 sleep mode at the earliest possible time - so reset
\r
4294 xNextTaskUnblockTime here to ensure it is updated at the
\r
4295 earliest possible time. */
\r
4296 prvResetNextTaskUnblockTime();
\r
4300 if( pxTCB->uxPriority > pxCurrentTCB->uxPriority )
\r
4302 /* The notified task has a priority above the currently
\r
4303 executing task so a yield is required. */
\r
4304 taskYIELD_IF_USING_PREEMPTION();
\r
4308 mtCOVERAGE_TEST_MARKER();
\r
4313 mtCOVERAGE_TEST_MARKER();
\r
4316 taskEXIT_CRITICAL();
\r
4321 #endif /* configUSE_TASK_NOTIFICATIONS */
\r
4322 /*-----------------------------------------------------------*/
\r
4324 #if( configUSE_TASK_NOTIFICATIONS == 1 )
\r
4326 BaseType_t xTaskGenericNotifyFromISR( TaskHandle_t xTaskToNotify, uint32_t ulValue, eNotifyAction eAction, uint32_t *pulPreviousNotificationValue, BaseType_t *pxHigherPriorityTaskWoken )
\r
4329 uint8_t ucOriginalNotifyState;
\r
4330 BaseType_t xReturn = pdPASS;
\r
4331 UBaseType_t uxSavedInterruptStatus;
\r
4333 configASSERT( xTaskToNotify );
\r
4335 /* RTOS ports that support interrupt nesting have the concept of a
\r
4336 maximum system call (or maximum API call) interrupt priority.
\r
4337 Interrupts that are above the maximum system call priority are keep
\r
4338 permanently enabled, even when the RTOS kernel is in a critical section,
\r
4339 but cannot make any calls to FreeRTOS API functions. If configASSERT()
\r
4340 is defined in FreeRTOSConfig.h then
\r
4341 portASSERT_IF_INTERRUPT_PRIORITY_INVALID() will result in an assertion
\r
4342 failure if a FreeRTOS API function is called from an interrupt that has
\r
4343 been assigned a priority above the configured maximum system call
\r
4344 priority. Only FreeRTOS functions that end in FromISR can be called
\r
4345 from interrupts that have been assigned a priority at or (logically)
\r
4346 below the maximum system call interrupt priority. FreeRTOS maintains a
\r
4347 separate interrupt safe API to ensure interrupt entry is as fast and as
\r
4348 simple as possible. More information (albeit Cortex-M specific) is
\r
4349 provided on the following link:
\r
4350 http://www.freertos.org/RTOS-Cortex-M3-M4.html */
\r
4351 portASSERT_IF_INTERRUPT_PRIORITY_INVALID();
\r
4353 pxTCB = ( TCB_t * ) xTaskToNotify;
\r
4355 uxSavedInterruptStatus = portSET_INTERRUPT_MASK_FROM_ISR();
\r
4357 if( pulPreviousNotificationValue != NULL )
\r
4359 *pulPreviousNotificationValue = pxTCB->ulNotifiedValue;
\r
4362 ucOriginalNotifyState = pxTCB->ucNotifyState;
\r
4363 pxTCB->ucNotifyState = taskNOTIFICATION_RECEIVED;
\r
4368 pxTCB->ulNotifiedValue |= ulValue;
\r
4372 ( pxTCB->ulNotifiedValue )++;
\r
4375 case eSetValueWithOverwrite :
\r
4376 pxTCB->ulNotifiedValue = ulValue;
\r
4379 case eSetValueWithoutOverwrite :
\r
4380 if( ucOriginalNotifyState != taskNOTIFICATION_RECEIVED )
\r
4382 pxTCB->ulNotifiedValue = ulValue;
\r
4386 /* The value could not be written to the task. */
\r
4392 /* The task is being notified without its notify value being
\r
4397 traceTASK_NOTIFY_FROM_ISR();
\r
4399 /* If the task is in the blocked state specifically to wait for a
\r
4400 notification then unblock it now. */
\r
4401 if( ucOriginalNotifyState == taskWAITING_NOTIFICATION )
\r
4403 /* The task should not have been on an event list. */
\r
4404 configASSERT( listLIST_ITEM_CONTAINER( &( pxTCB->xEventListItem ) ) == NULL );
\r
4406 if( uxSchedulerSuspended == ( UBaseType_t ) pdFALSE )
\r
4408 ( void ) uxListRemove( &( pxTCB->xStateListItem ) );
\r
4409 prvAddTaskToReadyList( pxTCB );
\r
4413 /* The delayed and ready lists cannot be accessed, so hold
\r
4414 this task pending until the scheduler is resumed. */
\r
4415 vListInsertEnd( &( xPendingReadyList ), &( pxTCB->xEventListItem ) );
\r
4418 if( pxTCB->uxPriority > pxCurrentTCB->uxPriority )
\r
4420 /* The notified task has a priority above the currently
\r
4421 executing task so a yield is required. */
\r
4422 if( pxHigherPriorityTaskWoken != NULL )
\r
4424 *pxHigherPriorityTaskWoken = pdTRUE;
\r
4428 /* Mark that a yield is pending in case the user is not
\r
4429 using the "xHigherPriorityTaskWoken" parameter to an ISR
\r
4430 safe FreeRTOS function. */
\r
4431 xYieldPending = pdTRUE;
\r
4436 mtCOVERAGE_TEST_MARKER();
\r
4440 portCLEAR_INTERRUPT_MASK_FROM_ISR( uxSavedInterruptStatus );
\r
4445 #endif /* configUSE_TASK_NOTIFICATIONS */
\r
4446 /*-----------------------------------------------------------*/
\r
4448 #if( configUSE_TASK_NOTIFICATIONS == 1 )
\r
4450 void vTaskNotifyGiveFromISR( TaskHandle_t xTaskToNotify, BaseType_t *pxHigherPriorityTaskWoken )
\r
4453 uint8_t ucOriginalNotifyState;
\r
4454 UBaseType_t uxSavedInterruptStatus;
\r
4456 configASSERT( xTaskToNotify );
\r
4458 /* RTOS ports that support interrupt nesting have the concept of a
\r
4459 maximum system call (or maximum API call) interrupt priority.
\r
4460 Interrupts that are above the maximum system call priority are keep
\r
4461 permanently enabled, even when the RTOS kernel is in a critical section,
\r
4462 but cannot make any calls to FreeRTOS API functions. If configASSERT()
\r
4463 is defined in FreeRTOSConfig.h then
\r
4464 portASSERT_IF_INTERRUPT_PRIORITY_INVALID() will result in an assertion
\r
4465 failure if a FreeRTOS API function is called from an interrupt that has
\r
4466 been assigned a priority above the configured maximum system call
\r
4467 priority. Only FreeRTOS functions that end in FromISR can be called
\r
4468 from interrupts that have been assigned a priority at or (logically)
\r
4469 below the maximum system call interrupt priority. FreeRTOS maintains a
\r
4470 separate interrupt safe API to ensure interrupt entry is as fast and as
\r
4471 simple as possible. More information (albeit Cortex-M specific) is
\r
4472 provided on the following link:
\r
4473 http://www.freertos.org/RTOS-Cortex-M3-M4.html */
\r
4474 portASSERT_IF_INTERRUPT_PRIORITY_INVALID();
\r
4476 pxTCB = ( TCB_t * ) xTaskToNotify;
\r
4478 uxSavedInterruptStatus = portSET_INTERRUPT_MASK_FROM_ISR();
\r
4480 ucOriginalNotifyState = pxTCB->ucNotifyState;
\r
4481 pxTCB->ucNotifyState = taskNOTIFICATION_RECEIVED;
\r
4483 /* 'Giving' is equivalent to incrementing a count in a counting
\r
4485 ( pxTCB->ulNotifiedValue )++;
\r
4487 traceTASK_NOTIFY_GIVE_FROM_ISR();
\r
4489 /* If the task is in the blocked state specifically to wait for a
\r
4490 notification then unblock it now. */
\r
4491 if( ucOriginalNotifyState == taskWAITING_NOTIFICATION )
\r
4493 /* The task should not have been on an event list. */
\r
4494 configASSERT( listLIST_ITEM_CONTAINER( &( pxTCB->xEventListItem ) ) == NULL );
\r
4496 if( uxSchedulerSuspended == ( UBaseType_t ) pdFALSE )
\r
4498 ( void ) uxListRemove( &( pxTCB->xStateListItem ) );
\r
4499 prvAddTaskToReadyList( pxTCB );
\r
4503 /* The delayed and ready lists cannot be accessed, so hold
\r
4504 this task pending until the scheduler is resumed. */
\r
4505 vListInsertEnd( &( xPendingReadyList ), &( pxTCB->xEventListItem ) );
\r
4508 if( pxTCB->uxPriority > pxCurrentTCB->uxPriority )
\r
4510 /* The notified task has a priority above the currently
\r
4511 executing task so a yield is required. */
\r
4512 if( pxHigherPriorityTaskWoken != NULL )
\r
4514 *pxHigherPriorityTaskWoken = pdTRUE;
\r
4518 /* Mark that a yield is pending in case the user is not
\r
4519 using the "xHigherPriorityTaskWoken" parameter in an ISR
\r
4520 safe FreeRTOS function. */
\r
4521 xYieldPending = pdTRUE;
\r
4526 mtCOVERAGE_TEST_MARKER();
\r
4530 portCLEAR_INTERRUPT_MASK_FROM_ISR( uxSavedInterruptStatus );
\r
4533 #endif /* configUSE_TASK_NOTIFICATIONS */
\r
4535 /*-----------------------------------------------------------*/
\r
4537 #if( configUSE_TASK_NOTIFICATIONS == 1 )
\r
4539 BaseType_t xTaskNotifyStateClear( TaskHandle_t xTask )
\r
4542 BaseType_t xReturn;
\r
4544 /* If null is passed in here then it is the calling task that is having
\r
4545 its notification state cleared. */
\r
4546 pxTCB = prvGetTCBFromHandle( xTask );
\r
4548 taskENTER_CRITICAL();
\r
4550 if( pxTCB->ucNotifyState == taskNOTIFICATION_RECEIVED )
\r
4552 pxTCB->ucNotifyState = taskNOT_WAITING_NOTIFICATION;
\r
4560 taskEXIT_CRITICAL();
\r
4565 #endif /* configUSE_TASK_NOTIFICATIONS */
\r
4566 /*-----------------------------------------------------------*/
\r
4569 static void prvAddCurrentTaskToDelayedList( TickType_t xTicksToWait, const BaseType_t xCanBlockIndefinitely )
\r
4571 TickType_t xTimeToWake;
\r
4572 const TickType_t xConstTickCount = xTickCount;
\r
4574 #if( INCLUDE_xTaskAbortDelay == 1 )
\r
4576 /* About to enter a delayed list, so ensure the ucDelayAborted flag is
\r
4577 reset to pdFALSE so it can be detected as having been set to pdTRUE
\r
4578 when the task leaves the Blocked state. */
\r
4579 pxCurrentTCB->ucDelayAborted = pdFALSE;
\r
4583 /* Remove the task from the ready list before adding it to the blocked list
\r
4584 as the same list item is used for both lists. */
\r
4585 if( uxListRemove( &( pxCurrentTCB->xStateListItem ) ) == ( UBaseType_t ) 0 )
\r
4587 /* The current task must be in a ready list, so there is no need to
\r
4588 check, and the port reset macro can be called directly. */
\r
4589 portRESET_READY_PRIORITY( pxCurrentTCB->uxPriority, uxTopReadyPriority );
\r
4593 mtCOVERAGE_TEST_MARKER();
\r
4596 #if ( INCLUDE_vTaskSuspend == 1 )
\r
4598 if( ( xTicksToWait == portMAX_DELAY ) && ( xCanBlockIndefinitely != pdFALSE ) )
\r
4600 /* Add the task to the suspended task list instead of a delayed task
\r
4601 list to ensure it is not woken by a timing event. It will block
\r
4603 vListInsertEnd( &xSuspendedTaskList, &( pxCurrentTCB->xStateListItem ) );
\r
4607 /* Calculate the time at which the task should be woken if the event
\r
4608 does not occur. This may overflow but this doesn't matter, the
\r
4609 kernel will manage it correctly. */
\r
4610 xTimeToWake = xConstTickCount + xTicksToWait;
\r
4612 /* The list item will be inserted in wake time order. */
\r
4613 listSET_LIST_ITEM_VALUE( &( pxCurrentTCB->xStateListItem ), xTimeToWake );
\r
4615 if( xTimeToWake < xConstTickCount )
\r
4617 /* Wake time has overflowed. Place this item in the overflow
\r
4619 vListInsert( pxOverflowDelayedTaskList, &( pxCurrentTCB->xStateListItem ) );
\r
4623 /* The wake time has not overflowed, so the current block list
\r
4625 vListInsert( pxDelayedTaskList, &( pxCurrentTCB->xStateListItem ) );
\r
4627 /* If the task entering the blocked state was placed at the
\r
4628 head of the list of blocked tasks then xNextTaskUnblockTime
\r
4629 needs to be updated too. */
\r
4630 if( xTimeToWake < xNextTaskUnblockTime )
\r
4632 xNextTaskUnblockTime = xTimeToWake;
\r
4636 mtCOVERAGE_TEST_MARKER();
\r
4641 #else /* INCLUDE_vTaskSuspend */
\r
4643 /* Calculate the time at which the task should be woken if the event
\r
4644 does not occur. This may overflow but this doesn't matter, the kernel
\r
4645 will manage it correctly. */
\r
4646 xTimeToWake = xConstTickCount + xTicksToWait;
\r
4648 /* The list item will be inserted in wake time order. */
\r
4649 listSET_LIST_ITEM_VALUE( &( pxCurrentTCB->xStateListItem ), xTimeToWake );
\r
4651 if( xTimeToWake < xConstTickCount )
\r
4653 /* Wake time has overflowed. Place this item in the overflow list. */
\r
4654 vListInsert( pxOverflowDelayedTaskList, &( pxCurrentTCB->xStateListItem ) );
\r
4658 /* The wake time has not overflowed, so the current block list is used. */
\r
4659 vListInsert( pxDelayedTaskList, &( pxCurrentTCB->xStateListItem ) );
\r
4661 /* If the task entering the blocked state was placed at the head of the
\r
4662 list of blocked tasks then xNextTaskUnblockTime needs to be updated
\r
4664 if( xTimeToWake < xNextTaskUnblockTime )
\r
4666 xNextTaskUnblockTime = xTimeToWake;
\r
4670 mtCOVERAGE_TEST_MARKER();
\r
4674 /* Avoid compiler warning when INCLUDE_vTaskSuspend is not 1. */
\r
4675 ( void ) xCanBlockIndefinitely;
\r
4677 #endif /* INCLUDE_vTaskSuspend */
\r
4681 #ifdef FREERTOS_MODULE_TEST
\r
4682 #include "tasks_test_access_functions.h"
\r
projects / freertos / blob