2 FreeRTOS V7.0.1 - Copyright (C) 2011 Real Time Engineers Ltd.
\r
5 FreeRTOS supports many tools and architectures. V7.0.0 is sponsored by:
\r
6 Atollic AB - Atollic provides professional embedded systems development
\r
7 tools for C/C++ development, code analysis and test automation.
\r
8 See http://www.atollic.com
\r
11 ***************************************************************************
\r
13 * FreeRTOS tutorial books are available in pdf and paperback. *
\r
14 * Complete, revised, and edited pdf reference manuals are also *
\r
17 * Purchasing FreeRTOS documentation will not only help you, by *
\r
18 * ensuring you get running as quickly as possible and with an *
\r
19 * in-depth knowledge of how to use FreeRTOS, it will also help *
\r
20 * the FreeRTOS project to continue with its mission of providing *
\r
21 * professional grade, cross platform, de facto standard solutions *
\r
22 * for microcontrollers - completely free of charge! *
\r
24 * >>> See http://www.FreeRTOS.org/Documentation for details. <<< *
\r
26 * Thank you for using FreeRTOS, and thank you for your support! *
\r
28 ***************************************************************************
\r
31 This file is part of the FreeRTOS distribution.
\r
33 FreeRTOS is free software; you can redistribute it and/or modify it under
\r
34 the terms of the GNU General Public License (version 2) as published by the
\r
35 Free Software Foundation AND MODIFIED BY the FreeRTOS exception.
\r
36 >>>NOTE<<< The modification to the GPL is included to allow you to
\r
37 distribute a combined work that includes FreeRTOS without being obliged to
\r
38 provide the source code for proprietary components outside of the FreeRTOS
\r
39 kernel. FreeRTOS is distributed in the hope that it will be useful, but
\r
40 WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
\r
41 or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
\r
42 more details. You should have received a copy of the GNU General Public
\r
43 License and the FreeRTOS license exception along with FreeRTOS; if not it
\r
44 can be viewed here: http://www.freertos.org/a00114.html and also obtained
\r
45 by writing to Richard Barry, contact details for whom are available on the
\r
50 http://www.FreeRTOS.org - Documentation, latest information, license and
\r
53 http://www.SafeRTOS.com - A version that is certified for use in safety
\r
56 http://www.OpenRTOS.com - Commercial support, development, porting,
\r
57 licensing and training services.
\r
65 /* Defining MPU_WRAPPERS_INCLUDED_FROM_API_FILE prevents task.h from redefining
\r
66 all the API functions to use the MPU wrappers. That should only be done when
\r
67 task.h is included from an application file. */
\r
68 #define MPU_WRAPPERS_INCLUDED_FROM_API_FILE
\r
70 #include "FreeRTOS.h"
\r
73 #include "StackMacros.h"
\r
75 #undef MPU_WRAPPERS_INCLUDED_FROM_API_FILE
\r
78 * Macro to define the amount of stack available to the idle task.
\r
80 #define tskIDLE_STACK_SIZE configMINIMAL_STACK_SIZE
\r
83 * Task control block. A task control block (TCB) is allocated to each task,
\r
84 * and stores the context of the task.
\r
86 typedef struct tskTaskControlBlock
\r
88 volatile portSTACK_TYPE *pxTopOfStack; /*< Points to the location of the last item placed on the tasks stack. THIS MUST BE THE FIRST MEMBER OF THE STRUCT. */
\r
90 #if ( portUSING_MPU_WRAPPERS == 1 )
\r
91 xMPU_SETTINGS xMPUSettings; /*< The MPU settings are defined as part of the port layer. THIS MUST BE THE SECOND MEMBER OF THE STRUCT. */
\r
94 xListItem xGenericListItem; /*< List item used to place the TCB in ready and blocked queues. */
\r
95 xListItem xEventListItem; /*< List item used to place the TCB in event lists. */
\r
96 unsigned portBASE_TYPE uxPriority; /*< The priority of the task where 0 is the lowest priority. */
\r
97 portSTACK_TYPE *pxStack; /*< Points to the start of the stack. */
\r
98 signed char pcTaskName[ configMAX_TASK_NAME_LEN ];/*< Descriptive name given to the task when created. Facilitates debugging only. */
\r
100 #if ( portSTACK_GROWTH > 0 )
\r
101 portSTACK_TYPE *pxEndOfStack; /*< Used for stack overflow checking on architectures where the stack grows up from low memory. */
\r
104 #if ( portCRITICAL_NESTING_IN_TCB == 1 )
\r
105 unsigned portBASE_TYPE uxCriticalNesting;
\r
108 #if ( configUSE_TRACE_FACILITY == 1 )
\r
109 unsigned portBASE_TYPE uxTCBNumber; /*< This is used for tracing the scheduler and making debugging easier only. */
\r
112 #if ( configUSE_MUTEXES == 1 )
\r
113 unsigned portBASE_TYPE uxBasePriority; /*< The priority last assigned to the task - used by the priority inheritance mechanism. */
\r
116 #if ( configUSE_APPLICATION_TASK_TAG == 1 )
\r
117 pdTASK_HOOK_CODE pxTaskTag;
\r
120 #if ( configGENERATE_RUN_TIME_STATS == 1 )
\r
121 unsigned long ulRunTimeCounter; /*< Used for calculating how much CPU time each task is utilising. */
\r
128 * Some kernel aware debuggers require data to be viewed to be global, rather
\r
131 #ifdef portREMOVE_STATIC_QUALIFIER
\r
136 PRIVILEGED_DATA tskTCB * volatile pxCurrentTCB = NULL;
\r
138 /* Lists for ready and blocked tasks. --------------------*/
\r
140 PRIVILEGED_DATA static xList pxReadyTasksLists[ configMAX_PRIORITIES ]; /*< Prioritised ready tasks. */
\r
141 PRIVILEGED_DATA static xList xDelayedTaskList1; /*< Delayed tasks. */
\r
142 PRIVILEGED_DATA static xList xDelayedTaskList2; /*< Delayed tasks (two lists are used - one for delays that have overflowed the current tick count. */
\r
143 PRIVILEGED_DATA static xList * volatile pxDelayedTaskList ; /*< Points to the delayed task list currently being used. */
\r
144 PRIVILEGED_DATA static xList * volatile pxOverflowDelayedTaskList; /*< Points to the delayed task list currently being used to hold tasks that have overflowed the current tick count. */
\r
145 PRIVILEGED_DATA static xList xPendingReadyList; /*< Tasks that have been readied while the scheduler was suspended. They will be moved to the ready queue when the scheduler is resumed. */
\r
147 #if ( INCLUDE_vTaskDelete == 1 )
\r
149 PRIVILEGED_DATA static xList xTasksWaitingTermination; /*< Tasks that have been deleted - but the their memory not yet freed. */
\r
150 PRIVILEGED_DATA static volatile unsigned portBASE_TYPE uxTasksDeleted = ( unsigned portBASE_TYPE ) 0U;
\r
154 #if ( INCLUDE_vTaskSuspend == 1 )
\r
156 PRIVILEGED_DATA static xList xSuspendedTaskList; /*< Tasks that are currently suspended. */
\r
160 #if ( INCLUDE_xTaskIdleTaskHandleGet == 1 )
\r
162 PRIVILEGED_DATA static xTaskHandle xIdleTaskHandle = NULL;
\r
166 /* File private variables. --------------------------------*/
\r
167 PRIVILEGED_DATA static volatile unsigned portBASE_TYPE uxCurrentNumberOfTasks = ( unsigned portBASE_TYPE ) 0U;
\r
168 PRIVILEGED_DATA static volatile portTickType xTickCount = ( portTickType ) 0U;
\r
169 PRIVILEGED_DATA static unsigned portBASE_TYPE uxTopUsedPriority = tskIDLE_PRIORITY;
\r
170 PRIVILEGED_DATA static volatile unsigned portBASE_TYPE uxTopReadyPriority = tskIDLE_PRIORITY;
\r
171 PRIVILEGED_DATA static volatile signed portBASE_TYPE xSchedulerRunning = pdFALSE;
\r
172 PRIVILEGED_DATA static volatile unsigned portBASE_TYPE uxSchedulerSuspended = ( unsigned portBASE_TYPE ) pdFALSE;
\r
173 PRIVILEGED_DATA static volatile unsigned portBASE_TYPE uxMissedTicks = ( unsigned portBASE_TYPE ) 0U;
\r
174 PRIVILEGED_DATA static volatile portBASE_TYPE xMissedYield = ( portBASE_TYPE ) pdFALSE;
\r
175 PRIVILEGED_DATA static volatile portBASE_TYPE xNumOfOverflows = ( portBASE_TYPE ) 0;
\r
176 PRIVILEGED_DATA static unsigned portBASE_TYPE uxTaskNumber = ( unsigned portBASE_TYPE ) 0U;
\r
177 PRIVILEGED_DATA static portTickType xNextTaskUnblockTime = ( portTickType ) portMAX_DELAY;
\r
179 #if ( configGENERATE_RUN_TIME_STATS == 1 )
\r
181 PRIVILEGED_DATA static char pcStatsString[ 50 ] ;
\r
182 PRIVILEGED_DATA static unsigned long ulTaskSwitchedInTime = 0UL; /*< Holds the value of a timer/counter the last time a task was switched in. */
\r
183 static void prvGenerateRunTimeStatsForTasksInList( const signed char *pcWriteBuffer, xList *pxList, unsigned long ulTotalRunTime ) PRIVILEGED_FUNCTION;
\r
187 /* Debugging and trace facilities private variables and macros. ------------*/
\r
190 * The value used to fill the stack of a task when the task is created. This
\r
191 * is used purely for checking the high water mark for tasks.
\r
193 #define tskSTACK_FILL_BYTE ( 0xa5U )
\r
196 * Macros used by vListTask to indicate which state a task is in.
\r
198 #define tskBLOCKED_CHAR ( ( signed char ) 'B' )
\r
199 #define tskREADY_CHAR ( ( signed char ) 'R' )
\r
200 #define tskDELETED_CHAR ( ( signed char ) 'D' )
\r
201 #define tskSUSPENDED_CHAR ( ( signed char ) 'S' )
\r
204 * Macros and private variables used by the trace facility.
\r
206 #if ( configUSE_TRACE_FACILITY == 1 )
\r
208 #define tskSIZE_OF_EACH_TRACE_LINE ( ( unsigned long ) ( sizeof( unsigned long ) + sizeof( unsigned long ) ) )
\r
209 PRIVILEGED_DATA static volatile signed char * volatile pcTraceBuffer;
\r
210 PRIVILEGED_DATA static signed char *pcTraceBufferStart;
\r
211 PRIVILEGED_DATA static signed char *pcTraceBufferEnd;
\r
212 PRIVILEGED_DATA static signed portBASE_TYPE xTracing = pdFALSE;
\r
213 static unsigned portBASE_TYPE uxPreviousTask = 255U;
\r
214 PRIVILEGED_DATA static char pcStatusString[ 50 ];
\r
218 /*-----------------------------------------------------------*/
\r
221 * Macro that writes a trace of scheduler activity to a buffer. This trace
\r
222 * shows which task is running when and is very useful as a debugging tool.
\r
223 * As this macro is called each context switch it is a good idea to undefine
\r
224 * it if not using the facility.
\r
226 #if ( configUSE_TRACE_FACILITY == 1 )
\r
228 #define vWriteTraceToBuffer() \
\r
230 if( xTracing != pdFALSE ) \
\r
232 if( uxPreviousTask != pxCurrentTCB->uxTCBNumber ) \
\r
234 if( ( pcTraceBuffer + tskSIZE_OF_EACH_TRACE_LINE ) < pcTraceBufferEnd ) \
\r
236 uxPreviousTask = pxCurrentTCB->uxTCBNumber; \
\r
237 *( unsigned long * ) pcTraceBuffer = ( unsigned long ) xTickCount; \
\r
238 pcTraceBuffer += sizeof( unsigned long ); \
\r
239 *( unsigned long * ) pcTraceBuffer = ( unsigned long ) uxPreviousTask; \
\r
240 pcTraceBuffer += sizeof( unsigned long ); \
\r
244 xTracing = pdFALSE; \
\r
252 #define vWriteTraceToBuffer()
\r
255 /*-----------------------------------------------------------*/
\r
258 * Place the task represented by pxTCB into the appropriate ready queue for
\r
259 * the task. It is inserted at the end of the list. One quirk of this is
\r
260 * that if the task being inserted is at the same priority as the currently
\r
261 * executing task, then it will only be rescheduled after the currently
\r
262 * executing task has been rescheduled.
\r
264 #define prvAddTaskToReadyQueue( pxTCB ) \
\r
265 if( ( pxTCB )->uxPriority > uxTopReadyPriority ) \
\r
267 uxTopReadyPriority = ( pxTCB )->uxPriority; \
\r
269 vListInsertEnd( ( xList * ) &( pxReadyTasksLists[ ( pxTCB )->uxPriority ] ), &( ( pxTCB )->xGenericListItem ) )
\r
270 /*-----------------------------------------------------------*/
\r
273 * Macro that looks at the list of tasks that are currently delayed to see if
\r
274 * any require waking.
\r
276 * Tasks are stored in the queue in the order of their wake time - meaning
\r
277 * once one tasks has been found whose timer has not expired we need not look
\r
278 * any further down the list.
\r
280 #define prvCheckDelayedTasks() \
\r
282 portTickType xItemValue; \
\r
284 /* Is the tick count greater than or equal to the wake time of the first \
\r
285 task referenced from the delayed tasks list? */ \
\r
286 if( xTickCount >= xNextTaskUnblockTime ) \
\r
290 if( listLIST_IS_EMPTY( pxDelayedTaskList ) != pdFALSE ) \
\r
292 /* The delayed list is empty. Set xNextTaskUnblockTime to the \
\r
293 maximum possible value so it is extremely unlikely that the \
\r
294 if( xTickCount >= xNextTaskUnblockTime ) test will pass next \
\r
296 xNextTaskUnblockTime = portMAX_DELAY; \
\r
301 /* The delayed list is not empty, get the value of the item at \
\r
302 the head of the delayed list. This is the time at which the \
\r
303 task at the head of the delayed list should be removed from \
\r
304 the Blocked state. */ \
\r
305 pxTCB = ( tskTCB * ) listGET_OWNER_OF_HEAD_ENTRY( pxDelayedTaskList ); \
\r
306 xItemValue = listGET_LIST_ITEM_VALUE( &( pxTCB->xGenericListItem ) ); \
\r
308 if( xTickCount < xItemValue ) \
\r
310 /* It is not time to unblock this item yet, but the item \
\r
311 value is the time at which the task at the head of the \
\r
312 blocked list should be removed from the Blocked state - \
\r
313 so record the item value in xNextTaskUnblockTime. */ \
\r
314 xNextTaskUnblockTime = xItemValue; \
\r
318 /* It is time to remove the item from the Blocked state. */ \
\r
319 vListRemove( &( pxTCB->xGenericListItem ) ); \
\r
321 /* Is the task waiting on an event also? */ \
\r
322 if( pxTCB->xEventListItem.pvContainer != NULL ) \
\r
324 vListRemove( &( pxTCB->xEventListItem ) ); \
\r
326 prvAddTaskToReadyQueue( pxTCB ); \
\r
331 /*-----------------------------------------------------------*/
\r
334 * Several functions take an xTaskHandle parameter that can optionally be NULL,
\r
335 * where NULL is used to indicate that the handle of the currently executing
\r
336 * task should be used in place of the parameter. This macro simply checks to
\r
337 * see if the parameter is NULL and returns a pointer to the appropriate TCB.
\r
339 #define prvGetTCBFromHandle( pxHandle ) ( ( ( pxHandle ) == NULL ) ? ( tskTCB * ) pxCurrentTCB : ( tskTCB * ) ( pxHandle ) )
\r
341 /* Callback function prototypes. --------------------------*/
\r
342 extern void vApplicationStackOverflowHook( xTaskHandle *pxTask, signed char *pcTaskName );
\r
343 extern void vApplicationTickHook( void );
\r
345 /* File private functions. --------------------------------*/
\r
348 * Utility to ready a TCB for a given task. Mainly just copies the parameters
\r
349 * into the TCB structure.
\r
351 static void prvInitialiseTCBVariables( tskTCB *pxTCB, const signed char * const pcName, unsigned portBASE_TYPE uxPriority, const xMemoryRegion * const xRegions, unsigned short usStackDepth ) PRIVILEGED_FUNCTION;
\r
354 * Utility to ready all the lists used by the scheduler. This is called
\r
355 * automatically upon the creation of the first task.
\r
357 static void prvInitialiseTaskLists( void ) PRIVILEGED_FUNCTION;
\r
360 * The idle task, which as all tasks is implemented as a never ending loop.
\r
361 * The idle task is automatically created and added to the ready lists upon
\r
362 * creation of the first user task.
\r
364 * The portTASK_FUNCTION_PROTO() macro is used to allow port/compiler specific
\r
365 * language extensions. The equivalent prototype for this function is:
\r
367 * void prvIdleTask( void *pvParameters );
\r
370 static portTASK_FUNCTION_PROTO( prvIdleTask, pvParameters );
\r
373 * Utility to free all memory allocated by the scheduler to hold a TCB,
\r
374 * including the stack pointed to by the TCB.
\r
376 * This does not free memory allocated by the task itself (i.e. memory
\r
377 * allocated by calls to pvPortMalloc from within the tasks application code).
\r
379 #if ( INCLUDE_vTaskDelete == 1 )
\r
381 static void prvDeleteTCB( tskTCB *pxTCB ) PRIVILEGED_FUNCTION;
\r
386 * Used only by the idle task. This checks to see if anything has been placed
\r
387 * in the list of tasks waiting to be deleted. If so the task is cleaned up
\r
388 * and its TCB deleted.
\r
390 static void prvCheckTasksWaitingTermination( void ) PRIVILEGED_FUNCTION;
\r
393 * The currently executing task is entering the Blocked state. Add the task to
\r
394 * either the current or the overflow delayed task list.
\r
396 static void prvAddCurrentTaskToDelayedList( portTickType xTimeToWake ) PRIVILEGED_FUNCTION;
\r
399 * Allocates memory from the heap for a TCB and associated stack. Checks the
\r
400 * allocation was successful.
\r
402 static tskTCB *prvAllocateTCBAndStack( unsigned short usStackDepth, portSTACK_TYPE *puxStackBuffer ) PRIVILEGED_FUNCTION;
\r
405 * Called from vTaskList. vListTasks details all the tasks currently under
\r
406 * control of the scheduler. The tasks may be in one of a number of lists.
\r
407 * prvListTaskWithinSingleList accepts a list and details the tasks from
\r
408 * within just that list.
\r
410 * THIS FUNCTION IS INTENDED FOR DEBUGGING ONLY, AND SHOULD NOT BE CALLED FROM
\r
411 * NORMAL APPLICATION CODE.
\r
413 #if ( configUSE_TRACE_FACILITY == 1 )
\r
415 static void prvListTaskWithinSingleList( const signed char *pcWriteBuffer, xList *pxList, signed char cStatus ) PRIVILEGED_FUNCTION;
\r
420 * When a task is created, the stack of the task is filled with a known value.
\r
421 * This function determines the 'high water mark' of the task stack by
\r
422 * determining how much of the stack remains at the original preset value.
\r
424 #if ( ( configUSE_TRACE_FACILITY == 1 ) || ( INCLUDE_uxTaskGetStackHighWaterMark == 1 ) )
\r
426 static unsigned short usTaskCheckFreeStackSpace( const unsigned char * pucStackByte ) PRIVILEGED_FUNCTION;
\r
435 /*-----------------------------------------------------------
\r
436 * TASK CREATION API documented in task.h
\r
437 *----------------------------------------------------------*/
\r
439 signed portBASE_TYPE xTaskGenericCreate( pdTASK_CODE pxTaskCode, const signed char * const pcName, unsigned short usStackDepth, void *pvParameters, unsigned portBASE_TYPE uxPriority, xTaskHandle *pxCreatedTask, portSTACK_TYPE *puxStackBuffer, const xMemoryRegion * const xRegions )
\r
441 signed portBASE_TYPE xReturn;
\r
444 configASSERT( pxTaskCode );
\r
445 configASSERT( ( uxPriority < configMAX_PRIORITIES ) );
\r
447 /* Allocate the memory required by the TCB and stack for the new task,
\r
448 checking that the allocation was successful. */
\r
449 pxNewTCB = prvAllocateTCBAndStack( usStackDepth, puxStackBuffer );
\r
451 if( pxNewTCB != NULL )
\r
453 portSTACK_TYPE *pxTopOfStack;
\r
455 #if( portUSING_MPU_WRAPPERS == 1 )
\r
456 /* Should the task be created in privileged mode? */
\r
457 portBASE_TYPE xRunPrivileged;
\r
458 if( ( uxPriority & portPRIVILEGE_BIT ) != 0U )
\r
460 xRunPrivileged = pdTRUE;
\r
464 xRunPrivileged = pdFALSE;
\r
466 uxPriority &= ~portPRIVILEGE_BIT;
\r
467 #endif /* portUSING_MPU_WRAPPERS == 1 */
\r
469 /* Calculate the top of stack address. This depends on whether the
\r
470 stack grows from high memory to low (as per the 80x86) or visa versa.
\r
471 portSTACK_GROWTH is used to make the result positive or negative as
\r
472 required by the port. */
\r
473 #if( portSTACK_GROWTH < 0 )
\r
475 pxTopOfStack = pxNewTCB->pxStack + ( usStackDepth - ( unsigned short ) 1 );
\r
476 pxTopOfStack = ( portSTACK_TYPE * ) ( ( ( unsigned long ) pxTopOfStack ) & ( ( unsigned long ) ~portBYTE_ALIGNMENT_MASK ) );
\r
478 /* Check the alignment of the calculated top of stack is correct. */
\r
479 configASSERT( ( ( ( unsigned long ) pxTopOfStack & ( unsigned long ) portBYTE_ALIGNMENT_MASK ) == 0UL ) );
\r
483 pxTopOfStack = pxNewTCB->pxStack;
\r
485 /* Check the alignment of the stack buffer is correct. */
\r
486 configASSERT( ( ( ( unsigned long ) pxNewTCB->pxStack & ( unsigned long ) portBYTE_ALIGNMENT_MASK ) == 0UL ) );
\r
488 /* If we want to use stack checking on architectures that use
\r
489 a positive stack growth direction then we also need to store the
\r
490 other extreme of the stack space. */
\r
491 pxNewTCB->pxEndOfStack = pxNewTCB->pxStack + ( usStackDepth - 1 );
\r
495 /* Setup the newly allocated TCB with the initial state of the task. */
\r
496 prvInitialiseTCBVariables( pxNewTCB, pcName, uxPriority, xRegions, usStackDepth );
\r
498 /* Initialize the TCB stack to look as if the task was already running,
\r
499 but had been interrupted by the scheduler. The return address is set
\r
500 to the start of the task function. Once the stack has been initialised
\r
501 the top of stack variable is updated. */
\r
502 #if( portUSING_MPU_WRAPPERS == 1 )
\r
504 pxNewTCB->pxTopOfStack = pxPortInitialiseStack( pxTopOfStack, pxTaskCode, pvParameters, xRunPrivileged );
\r
508 pxNewTCB->pxTopOfStack = pxPortInitialiseStack( pxTopOfStack, pxTaskCode, pvParameters );
\r
512 /* Check the alignment of the initialised stack. */
\r
513 configASSERT( ( ( ( unsigned long ) pxNewTCB->pxTopOfStack & ( unsigned long ) portBYTE_ALIGNMENT_MASK ) == 0UL ) );
\r
515 if( ( void * ) pxCreatedTask != NULL )
\r
517 /* Pass the TCB out - in an anonymous way. The calling function/
\r
518 task can use this as a handle to delete the task later if
\r
520 *pxCreatedTask = ( xTaskHandle ) pxNewTCB;
\r
523 /* We are going to manipulate the task queues to add this task to a
\r
524 ready list, so must make sure no interrupts occur. */
\r
525 taskENTER_CRITICAL();
\r
527 uxCurrentNumberOfTasks++;
\r
528 if( pxCurrentTCB == NULL )
\r
530 /* There are no other tasks, or all the other tasks are in
\r
531 the suspended state - make this the current task. */
\r
532 pxCurrentTCB = pxNewTCB;
\r
534 if( uxCurrentNumberOfTasks == ( unsigned portBASE_TYPE ) 1 )
\r
536 /* This is the first task to be created so do the preliminary
\r
537 initialisation required. We will not recover if this call
\r
538 fails, but we will report the failure. */
\r
539 prvInitialiseTaskLists();
\r
544 /* If the scheduler is not already running, make this task the
\r
545 current task if it is the highest priority task to be created
\r
547 if( xSchedulerRunning == pdFALSE )
\r
549 if( pxCurrentTCB->uxPriority <= uxPriority )
\r
551 pxCurrentTCB = pxNewTCB;
\r
556 /* Remember the top priority to make context switching faster. Use
\r
557 the priority in pxNewTCB as this has been capped to a valid value. */
\r
558 if( pxNewTCB->uxPriority > uxTopUsedPriority )
\r
560 uxTopUsedPriority = pxNewTCB->uxPriority;
\r
563 #if ( configUSE_TRACE_FACILITY == 1 )
\r
565 /* Add a counter into the TCB for tracing only. */
\r
566 pxNewTCB->uxTCBNumber = uxTaskNumber;
\r
571 prvAddTaskToReadyQueue( pxNewTCB );
\r
574 traceTASK_CREATE( pxNewTCB );
\r
576 taskEXIT_CRITICAL();
\r
580 xReturn = errCOULD_NOT_ALLOCATE_REQUIRED_MEMORY;
\r
581 traceTASK_CREATE_FAILED();
\r
584 if( xReturn == pdPASS )
\r
586 if( xSchedulerRunning != pdFALSE )
\r
588 /* If the created task is of a higher priority than the current task
\r
589 then it should run now. */
\r
590 if( pxCurrentTCB->uxPriority < uxPriority )
\r
592 portYIELD_WITHIN_API();
\r
599 /*-----------------------------------------------------------*/
\r
601 #if ( INCLUDE_vTaskDelete == 1 )
\r
603 void vTaskDelete( xTaskHandle pxTaskToDelete )
\r
607 taskENTER_CRITICAL();
\r
609 /* Ensure a yield is performed if the current task is being
\r
611 if( pxTaskToDelete == pxCurrentTCB )
\r
613 pxTaskToDelete = NULL;
\r
616 /* If null is passed in here then we are deleting ourselves. */
\r
617 pxTCB = prvGetTCBFromHandle( pxTaskToDelete );
\r
619 /* Remove task from the ready list and place in the termination list.
\r
620 This will stop the task from be scheduled. The idle task will check
\r
621 the termination list and free up any memory allocated by the
\r
622 scheduler for the TCB and stack. */
\r
623 vListRemove( &( pxTCB->xGenericListItem ) );
\r
625 /* Is the task waiting on an event also? */
\r
626 if( pxTCB->xEventListItem.pvContainer != NULL )
\r
628 vListRemove( &( pxTCB->xEventListItem ) );
\r
631 vListInsertEnd( ( xList * ) &xTasksWaitingTermination, &( pxTCB->xGenericListItem ) );
\r
633 /* Increment the ucTasksDeleted variable so the idle task knows
\r
634 there is a task that has been deleted and that it should therefore
\r
635 check the xTasksWaitingTermination list. */
\r
638 /* Increment the uxTaskNumberVariable also so kernel aware debuggers
\r
639 can detect that the task lists need re-generating. */
\r
642 traceTASK_DELETE( pxTCB );
\r
644 taskEXIT_CRITICAL();
\r
646 /* Force a reschedule if we have just deleted the current task. */
\r
647 if( xSchedulerRunning != pdFALSE )
\r
649 if( ( void * ) pxTaskToDelete == NULL )
\r
651 portYIELD_WITHIN_API();
\r
663 /*-----------------------------------------------------------
\r
664 * TASK CONTROL API documented in task.h
\r
665 *----------------------------------------------------------*/
\r
667 #if ( INCLUDE_vTaskDelayUntil == 1 )
\r
669 void vTaskDelayUntil( portTickType * const pxPreviousWakeTime, portTickType xTimeIncrement )
\r
671 portTickType xTimeToWake;
\r
672 portBASE_TYPE xAlreadyYielded, xShouldDelay = pdFALSE;
\r
674 configASSERT( pxPreviousWakeTime );
\r
675 configASSERT( ( xTimeIncrement > 0U ) );
\r
679 /* Generate the tick time at which the task wants to wake. */
\r
680 xTimeToWake = *pxPreviousWakeTime + xTimeIncrement;
\r
682 if( xTickCount < *pxPreviousWakeTime )
\r
684 /* The tick count has overflowed since this function was
\r
685 lasted called. In this case the only time we should ever
\r
686 actually delay is if the wake time has also overflowed,
\r
687 and the wake time is greater than the tick time. When this
\r
688 is the case it is as if neither time had overflowed. */
\r
689 if( ( xTimeToWake < *pxPreviousWakeTime ) && ( xTimeToWake > xTickCount ) )
\r
691 xShouldDelay = pdTRUE;
\r
696 /* The tick time has not overflowed. In this case we will
\r
697 delay if either the wake time has overflowed, and/or the
\r
698 tick time is less than the wake time. */
\r
699 if( ( xTimeToWake < *pxPreviousWakeTime ) || ( xTimeToWake > xTickCount ) )
\r
701 xShouldDelay = pdTRUE;
\r
705 /* Update the wake time ready for the next call. */
\r
706 *pxPreviousWakeTime = xTimeToWake;
\r
708 if( xShouldDelay != pdFALSE )
\r
710 traceTASK_DELAY_UNTIL();
\r
712 /* We must remove ourselves from the ready list before adding
\r
713 ourselves to the blocked list as the same list item is used for
\r
715 vListRemove( ( xListItem * ) &( pxCurrentTCB->xGenericListItem ) );
\r
716 prvAddCurrentTaskToDelayedList( xTimeToWake );
\r
719 xAlreadyYielded = xTaskResumeAll();
\r
721 /* Force a reschedule if xTaskResumeAll has not already done so, we may
\r
722 have put ourselves to sleep. */
\r
723 if( xAlreadyYielded == pdFALSE )
\r
725 portYIELD_WITHIN_API();
\r
730 /*-----------------------------------------------------------*/
\r
732 #if ( INCLUDE_vTaskDelay == 1 )
\r
734 void vTaskDelay( portTickType xTicksToDelay )
\r
736 portTickType xTimeToWake;
\r
737 signed portBASE_TYPE xAlreadyYielded = pdFALSE;
\r
739 /* A delay time of zero just forces a reschedule. */
\r
740 if( xTicksToDelay > ( portTickType ) 0U )
\r
746 /* A task that is removed from the event list while the
\r
747 scheduler is suspended will not get placed in the ready
\r
748 list or removed from the blocked list until the scheduler
\r
751 This task cannot be in an event list as it is the currently
\r
754 /* Calculate the time to wake - this may overflow but this is
\r
756 xTimeToWake = xTickCount + xTicksToDelay;
\r
758 /* We must remove ourselves from the ready list before adding
\r
759 ourselves to the blocked list as the same list item is used for
\r
761 vListRemove( ( xListItem * ) &( pxCurrentTCB->xGenericListItem ) );
\r
762 prvAddCurrentTaskToDelayedList( xTimeToWake );
\r
764 xAlreadyYielded = xTaskResumeAll();
\r
767 /* Force a reschedule if xTaskResumeAll has not already done so, we may
\r
768 have put ourselves to sleep. */
\r
769 if( xAlreadyYielded == pdFALSE )
\r
771 portYIELD_WITHIN_API();
\r
776 /*-----------------------------------------------------------*/
\r
778 #if ( INCLUDE_uxTaskPriorityGet == 1 )
\r
780 unsigned portBASE_TYPE uxTaskPriorityGet( xTaskHandle pxTask )
\r
783 unsigned portBASE_TYPE uxReturn;
\r
785 taskENTER_CRITICAL();
\r
787 /* If null is passed in here then we are changing the
\r
788 priority of the calling function. */
\r
789 pxTCB = prvGetTCBFromHandle( pxTask );
\r
790 uxReturn = pxTCB->uxPriority;
\r
792 taskEXIT_CRITICAL();
\r
798 /*-----------------------------------------------------------*/
\r
800 #if ( INCLUDE_vTaskPrioritySet == 1 )
\r
802 void vTaskPrioritySet( xTaskHandle pxTask, unsigned portBASE_TYPE uxNewPriority )
\r
805 unsigned portBASE_TYPE uxCurrentPriority;
\r
806 portBASE_TYPE xYieldRequired = pdFALSE;
\r
808 configASSERT( ( uxNewPriority < configMAX_PRIORITIES ) );
\r
810 /* Ensure the new priority is valid. */
\r
811 if( uxNewPriority >= configMAX_PRIORITIES )
\r
813 uxNewPriority = configMAX_PRIORITIES - ( unsigned portBASE_TYPE ) 1U;
\r
816 taskENTER_CRITICAL();
\r
818 if( pxTask == pxCurrentTCB )
\r
823 /* If null is passed in here then we are changing the
\r
824 priority of the calling function. */
\r
825 pxTCB = prvGetTCBFromHandle( pxTask );
\r
827 traceTASK_PRIORITY_SET( pxTask, uxNewPriority );
\r
829 #if ( configUSE_MUTEXES == 1 )
\r
831 uxCurrentPriority = pxTCB->uxBasePriority;
\r
835 uxCurrentPriority = pxTCB->uxPriority;
\r
839 if( uxCurrentPriority != uxNewPriority )
\r
841 /* The priority change may have readied a task of higher
\r
842 priority than the calling task. */
\r
843 if( uxNewPriority > uxCurrentPriority )
\r
845 if( pxTask != NULL )
\r
847 /* The priority of another task is being raised. If we
\r
848 were raising the priority of the currently running task
\r
849 there would be no need to switch as it must have already
\r
850 been the highest priority task. */
\r
851 xYieldRequired = pdTRUE;
\r
854 else if( pxTask == NULL )
\r
856 /* Setting our own priority down means there may now be another
\r
857 task of higher priority that is ready to execute. */
\r
858 xYieldRequired = pdTRUE;
\r
863 #if ( configUSE_MUTEXES == 1 )
\r
865 /* Only change the priority being used if the task is not
\r
866 currently using an inherited priority. */
\r
867 if( pxTCB->uxBasePriority == pxTCB->uxPriority )
\r
869 pxTCB->uxPriority = uxNewPriority;
\r
872 /* The base priority gets set whatever. */
\r
873 pxTCB->uxBasePriority = uxNewPriority;
\r
877 pxTCB->uxPriority = uxNewPriority;
\r
881 listSET_LIST_ITEM_VALUE( &( pxTCB->xEventListItem ), ( configMAX_PRIORITIES - ( portTickType ) uxNewPriority ) );
\r
883 /* If the task is in the blocked or suspended list we need do
\r
884 nothing more than change it's priority variable. However, if
\r
885 the task is in a ready list it needs to be removed and placed
\r
886 in the queue appropriate to its new priority. */
\r
887 if( listIS_CONTAINED_WITHIN( &( pxReadyTasksLists[ uxCurrentPriority ] ), &( pxTCB->xGenericListItem ) ) )
\r
889 /* The task is currently in its ready list - remove before adding
\r
890 it to it's new ready list. As we are in a critical section we
\r
891 can do this even if the scheduler is suspended. */
\r
892 vListRemove( &( pxTCB->xGenericListItem ) );
\r
893 prvAddTaskToReadyQueue( pxTCB );
\r
896 if( xYieldRequired == pdTRUE )
\r
898 portYIELD_WITHIN_API();
\r
902 taskEXIT_CRITICAL();
\r
906 /*-----------------------------------------------------------*/
\r
908 #if ( INCLUDE_vTaskSuspend == 1 )
\r
910 void vTaskSuspend( xTaskHandle pxTaskToSuspend )
\r
914 taskENTER_CRITICAL();
\r
916 /* Ensure a yield is performed if the current task is being
\r
918 if( pxTaskToSuspend == pxCurrentTCB )
\r
920 pxTaskToSuspend = NULL;
\r
923 /* If null is passed in here then we are suspending ourselves. */
\r
924 pxTCB = prvGetTCBFromHandle( pxTaskToSuspend );
\r
926 traceTASK_SUSPEND( pxTCB );
\r
928 /* Remove task from the ready/delayed list and place in the suspended list. */
\r
929 vListRemove( &( pxTCB->xGenericListItem ) );
\r
931 /* Is the task waiting on an event also? */
\r
932 if( pxTCB->xEventListItem.pvContainer != NULL )
\r
934 vListRemove( &( pxTCB->xEventListItem ) );
\r
937 vListInsertEnd( ( xList * ) &xSuspendedTaskList, &( pxTCB->xGenericListItem ) );
\r
939 taskEXIT_CRITICAL();
\r
941 if( ( void * ) pxTaskToSuspend == NULL )
\r
943 if( xSchedulerRunning != pdFALSE )
\r
945 /* We have just suspended the current task. */
\r
946 portYIELD_WITHIN_API();
\r
950 /* The scheduler is not running, but the task that was pointed
\r
951 to by pxCurrentTCB has just been suspended and pxCurrentTCB
\r
952 must be adjusted to point to a different task. */
\r
953 if( listCURRENT_LIST_LENGTH( &xSuspendedTaskList ) == uxCurrentNumberOfTasks )
\r
955 /* No other tasks are ready, so set pxCurrentTCB back to
\r
956 NULL so when the next task is created pxCurrentTCB will
\r
957 be set to point to it no matter what its relative priority
\r
959 pxCurrentTCB = NULL;
\r
963 vTaskSwitchContext();
\r
970 /*-----------------------------------------------------------*/
\r
972 #if ( INCLUDE_vTaskSuspend == 1 )
\r
974 signed portBASE_TYPE xTaskIsTaskSuspended( xTaskHandle xTask )
\r
976 portBASE_TYPE xReturn = pdFALSE;
\r
977 const tskTCB * const pxTCB = ( tskTCB * ) xTask;
\r
979 /* It does not make sense to check if the calling task is suspended. */
\r
980 configASSERT( xTask );
\r
982 /* Is the task we are attempting to resume actually in the
\r
984 if( listIS_CONTAINED_WITHIN( &xSuspendedTaskList, &( pxTCB->xGenericListItem ) ) != pdFALSE )
\r
986 /* Has the task already been resumed from within an ISR? */
\r
987 if( listIS_CONTAINED_WITHIN( &xPendingReadyList, &( pxTCB->xEventListItem ) ) != pdTRUE )
\r
989 /* Is it in the suspended list because it is in the
\r
990 Suspended state? It is possible to be in the suspended
\r
991 list because it is blocked on a task with no timeout
\r
993 if( listIS_CONTAINED_WITHIN( NULL, &( pxTCB->xEventListItem ) ) == pdTRUE )
\r
1004 /*-----------------------------------------------------------*/
\r
1006 #if ( INCLUDE_vTaskSuspend == 1 )
\r
1008 void vTaskResume( xTaskHandle pxTaskToResume )
\r
1012 /* It does not make sense to resume the calling task. */
\r
1013 configASSERT( pxTaskToResume );
\r
1015 /* Remove the task from whichever list it is currently in, and place
\r
1016 it in the ready list. */
\r
1017 pxTCB = ( tskTCB * ) pxTaskToResume;
\r
1019 /* The parameter cannot be NULL as it is impossible to resume the
\r
1020 currently executing task. */
\r
1021 if( ( pxTCB != NULL ) && ( pxTCB != pxCurrentTCB ) )
\r
1023 taskENTER_CRITICAL();
\r
1025 if( xTaskIsTaskSuspended( pxTCB ) == pdTRUE )
\r
1027 traceTASK_RESUME( pxTCB );
\r
1029 /* As we are in a critical section we can access the ready
\r
1030 lists even if the scheduler is suspended. */
\r
1031 vListRemove( &( pxTCB->xGenericListItem ) );
\r
1032 prvAddTaskToReadyQueue( pxTCB );
\r
1034 /* We may have just resumed a higher priority task. */
\r
1035 if( pxTCB->uxPriority >= pxCurrentTCB->uxPriority )
\r
1037 /* This yield may not cause the task just resumed to run, but
\r
1038 will leave the lists in the correct state for the next yield. */
\r
1039 portYIELD_WITHIN_API();
\r
1043 taskEXIT_CRITICAL();
\r
1049 /*-----------------------------------------------------------*/
\r
1051 #if ( ( INCLUDE_xTaskResumeFromISR == 1 ) && ( INCLUDE_vTaskSuspend == 1 ) )
\r
1053 portBASE_TYPE xTaskResumeFromISR( xTaskHandle pxTaskToResume )
\r
1055 portBASE_TYPE xYieldRequired = pdFALSE;
\r
1058 configASSERT( pxTaskToResume );
\r
1060 pxTCB = ( tskTCB * ) pxTaskToResume;
\r
1062 if( xTaskIsTaskSuspended( pxTCB ) == pdTRUE )
\r
1064 traceTASK_RESUME_FROM_ISR( pxTCB );
\r
1066 if( uxSchedulerSuspended == ( unsigned portBASE_TYPE ) pdFALSE )
\r
1068 xYieldRequired = ( pxTCB->uxPriority >= pxCurrentTCB->uxPriority );
\r
1069 vListRemove( &( pxTCB->xGenericListItem ) );
\r
1070 prvAddTaskToReadyQueue( pxTCB );
\r
1074 /* We cannot access the delayed or ready lists, so will hold this
\r
1075 task pending until the scheduler is resumed, at which point a
\r
1076 yield will be performed if necessary. */
\r
1077 vListInsertEnd( ( xList * ) &( xPendingReadyList ), &( pxTCB->xEventListItem ) );
\r
1081 return xYieldRequired;
\r
1089 /*-----------------------------------------------------------
\r
1090 * PUBLIC SCHEDULER CONTROL documented in task.h
\r
1091 *----------------------------------------------------------*/
\r
1094 void vTaskStartScheduler( void )
\r
1096 portBASE_TYPE xReturn;
\r
1098 /* Add the idle task at the lowest priority. */
\r
1099 #if ( INCLUDE_xTaskIdleTaskHandleGet == 1 )
\r
1101 /* Create the idle task, storing its handle in xIdleTaskHandle so it can
\r
1102 be returned by the xTaskIdleTaskHandleGet() function. */
\r
1103 xReturn = xTaskCreate( prvIdleTask, ( signed char * ) "IDLE", tskIDLE_STACK_SIZE, ( void * ) NULL, ( tskIDLE_PRIORITY | portPRIVILEGE_BIT ), &xIdleTaskHandle );
\r
1107 /* Create the idle task without storing its handle. */
\r
1108 xReturn = xTaskCreate( prvIdleTask, ( signed char * ) "IDLE", tskIDLE_STACK_SIZE, ( void * ) NULL, ( tskIDLE_PRIORITY | portPRIVILEGE_BIT ), NULL );
\r
1112 #if ( configUSE_TIMERS == 1 )
\r
1114 if( xReturn == pdPASS )
\r
1116 xReturn = xTimerCreateTimerTask();
\r
1121 if( xReturn == pdPASS )
\r
1123 /* Interrupts are turned off here, to ensure a tick does not occur
\r
1124 before or during the call to xPortStartScheduler(). The stacks of
\r
1125 the created tasks contain a status word with interrupts switched on
\r
1126 so interrupts will automatically get re-enabled when the first task
\r
1129 STEPPING THROUGH HERE USING A DEBUGGER CAN CAUSE BIG PROBLEMS IF THE
\r
1130 DEBUGGER ALLOWS INTERRUPTS TO BE PROCESSED. */
\r
1131 portDISABLE_INTERRUPTS();
\r
1133 xSchedulerRunning = pdTRUE;
\r
1134 xTickCount = ( portTickType ) 0U;
\r
1136 /* If configGENERATE_RUN_TIME_STATS is defined then the following
\r
1137 macro must be defined to configure the timer/counter used to generate
\r
1138 the run time counter time base. */
\r
1139 portCONFIGURE_TIMER_FOR_RUN_TIME_STATS();
\r
1141 /* Setting up the timer tick is hardware specific and thus in the
\r
1142 portable interface. */
\r
1143 if( xPortStartScheduler() != pdFALSE )
\r
1145 /* Should not reach here as if the scheduler is running the
\r
1146 function will not return. */
\r
1150 /* Should only reach here if a task calls xTaskEndScheduler(). */
\r
1154 /* This line will only be reached if the kernel could not be started. */
\r
1155 configASSERT( xReturn );
\r
1157 /*-----------------------------------------------------------*/
\r
1159 void vTaskEndScheduler( void )
\r
1161 /* Stop the scheduler interrupts and call the portable scheduler end
\r
1162 routine so the original ISRs can be restored if necessary. The port
\r
1163 layer must ensure interrupts enable bit is left in the correct state. */
\r
1164 portDISABLE_INTERRUPTS();
\r
1165 xSchedulerRunning = pdFALSE;
\r
1166 vPortEndScheduler();
\r
1168 /*----------------------------------------------------------*/
\r
1170 void vTaskSuspendAll( void )
\r
1172 /* A critical section is not required as the variable is of type
\r
1174 ++uxSchedulerSuspended;
\r
1176 /*----------------------------------------------------------*/
\r
1178 signed portBASE_TYPE xTaskResumeAll( void )
\r
1180 register tskTCB *pxTCB;
\r
1181 signed portBASE_TYPE xAlreadyYielded = pdFALSE;
\r
1183 /* If uxSchedulerSuspended is zero then this function does not match a
\r
1184 previous call to vTaskSuspendAll(). */
\r
1185 configASSERT( uxSchedulerSuspended );
\r
1187 /* It is possible that an ISR caused a task to be removed from an event
\r
1188 list while the scheduler was suspended. If this was the case then the
\r
1189 removed task will have been added to the xPendingReadyList. Once the
\r
1190 scheduler has been resumed it is safe to move all the pending ready
\r
1191 tasks from this list into their appropriate ready list. */
\r
1192 taskENTER_CRITICAL();
\r
1194 --uxSchedulerSuspended;
\r
1196 if( uxSchedulerSuspended == ( unsigned portBASE_TYPE ) pdFALSE )
\r
1198 if( uxCurrentNumberOfTasks > ( unsigned portBASE_TYPE ) 0U )
\r
1200 portBASE_TYPE xYieldRequired = pdFALSE;
\r
1202 /* Move any readied tasks from the pending list into the
\r
1203 appropriate ready list. */
\r
1204 while( listLIST_IS_EMPTY( ( xList * ) &xPendingReadyList ) == pdFALSE )
\r
1206 pxTCB = ( tskTCB * ) listGET_OWNER_OF_HEAD_ENTRY( ( ( xList * ) &xPendingReadyList ) );
\r
1207 vListRemove( &( pxTCB->xEventListItem ) );
\r
1208 vListRemove( &( pxTCB->xGenericListItem ) );
\r
1209 prvAddTaskToReadyQueue( pxTCB );
\r
1211 /* If we have moved a task that has a priority higher than
\r
1212 the current task then we should yield. */
\r
1213 if( pxTCB->uxPriority >= pxCurrentTCB->uxPriority )
\r
1215 xYieldRequired = pdTRUE;
\r
1219 /* If any ticks occurred while the scheduler was suspended then
\r
1220 they should be processed now. This ensures the tick count does not
\r
1221 slip, and that any delayed tasks are resumed at the correct time. */
\r
1222 if( uxMissedTicks > ( unsigned portBASE_TYPE ) 0U )
\r
1224 while( uxMissedTicks > ( unsigned portBASE_TYPE ) 0U )
\r
1226 vTaskIncrementTick();
\r
1230 /* As we have processed some ticks it is appropriate to yield
\r
1231 to ensure the highest priority task that is ready to run is
\r
1232 the task actually running. */
\r
1233 #if configUSE_PREEMPTION == 1
\r
1235 xYieldRequired = pdTRUE;
\r
1240 if( ( xYieldRequired == pdTRUE ) || ( xMissedYield == pdTRUE ) )
\r
1242 xAlreadyYielded = pdTRUE;
\r
1243 xMissedYield = pdFALSE;
\r
1244 portYIELD_WITHIN_API();
\r
1249 taskEXIT_CRITICAL();
\r
1251 return xAlreadyYielded;
\r
1259 /*-----------------------------------------------------------
\r
1260 * PUBLIC TASK UTILITIES documented in task.h
\r
1261 *----------------------------------------------------------*/
\r
1265 portTickType xTaskGetTickCount( void )
\r
1267 portTickType xTicks;
\r
1269 /* Critical section required if running on a 16 bit processor. */
\r
1270 taskENTER_CRITICAL();
\r
1272 xTicks = xTickCount;
\r
1274 taskEXIT_CRITICAL();
\r
1278 /*-----------------------------------------------------------*/
\r
1280 portTickType xTaskGetTickCountFromISR( void )
\r
1282 portTickType xReturn;
\r
1283 unsigned portBASE_TYPE uxSavedInterruptStatus;
\r
1285 uxSavedInterruptStatus = portSET_INTERRUPT_MASK_FROM_ISR();
\r
1286 xReturn = xTickCount;
\r
1287 portCLEAR_INTERRUPT_MASK_FROM_ISR( uxSavedInterruptStatus );
\r
1291 /*-----------------------------------------------------------*/
\r
1293 unsigned portBASE_TYPE uxTaskGetNumberOfTasks( void )
\r
1295 /* A critical section is not required because the variables are of type
\r
1297 return uxCurrentNumberOfTasks;
\r
1299 /*-----------------------------------------------------------*/
\r
1301 #if ( INCLUDE_pcTaskNameGet == 1 )
\r
1303 signed char *pcTaskNameGet( xTaskHandle xTaskToQuery )
\r
1307 /* If null is passed in here then the name of the calling task is being queried. */
\r
1308 pxTCB = prvGetTCBFromHandle( xTaskToQuery );
\r
1309 configASSERT( pxTCB );
\r
1310 return &( pxTCB->pcTaskName[ 0 ] );
\r
1314 /*-----------------------------------------------------------*/
\r
1316 #if ( configUSE_TRACE_FACILITY == 1 )
\r
1318 void vTaskList( signed char *pcWriteBuffer )
\r
1320 unsigned portBASE_TYPE uxQueue;
\r
1322 /* This is a VERY costly function that should be used for debug only.
\r
1323 It leaves interrupts disabled for a LONG time. */
\r
1325 vTaskSuspendAll();
\r
1327 /* Run through all the lists that could potentially contain a TCB and
\r
1328 report the task name, state and stack high water mark. */
\r
1330 *pcWriteBuffer = ( signed char ) 0x00;
\r
1331 strcat( ( char * ) pcWriteBuffer, ( const char * ) "\r\n" );
\r
1333 uxQueue = uxTopUsedPriority + ( unsigned portBASE_TYPE ) 1U;
\r
1339 if( listLIST_IS_EMPTY( &( pxReadyTasksLists[ uxQueue ] ) ) == pdFALSE )
\r
1341 prvListTaskWithinSingleList( pcWriteBuffer, ( xList * ) &( pxReadyTasksLists[ uxQueue ] ), tskREADY_CHAR );
\r
1343 }while( uxQueue > ( unsigned short ) tskIDLE_PRIORITY );
\r
1345 if( listLIST_IS_EMPTY( pxDelayedTaskList ) == pdFALSE )
\r
1347 prvListTaskWithinSingleList( pcWriteBuffer, ( xList * ) pxDelayedTaskList, tskBLOCKED_CHAR );
\r
1350 if( listLIST_IS_EMPTY( pxOverflowDelayedTaskList ) == pdFALSE )
\r
1352 prvListTaskWithinSingleList( pcWriteBuffer, ( xList * ) pxOverflowDelayedTaskList, tskBLOCKED_CHAR );
\r
1355 #if( INCLUDE_vTaskDelete == 1 )
\r
1357 if( listLIST_IS_EMPTY( &xTasksWaitingTermination ) == pdFALSE )
\r
1359 prvListTaskWithinSingleList( pcWriteBuffer, &xTasksWaitingTermination, tskDELETED_CHAR );
\r
1364 #if ( INCLUDE_vTaskSuspend == 1 )
\r
1366 if( listLIST_IS_EMPTY( &xSuspendedTaskList ) == pdFALSE )
\r
1368 prvListTaskWithinSingleList( pcWriteBuffer, &xSuspendedTaskList, tskSUSPENDED_CHAR );
\r
1377 /*----------------------------------------------------------*/
\r
1379 #if ( configGENERATE_RUN_TIME_STATS == 1 )
\r
1381 void vTaskGetRunTimeStats( signed char *pcWriteBuffer )
\r
1383 unsigned portBASE_TYPE uxQueue;
\r
1384 unsigned long ulTotalRunTime;
\r
1386 /* This is a VERY costly function that should be used for debug only.
\r
1387 It leaves interrupts disabled for a LONG time. */
\r
1389 vTaskSuspendAll();
\r
1391 #ifdef portALT_GET_RUN_TIME_COUNTER_VALUE
\r
1392 portALT_GET_RUN_TIME_COUNTER_VALUE( ulTotalRunTime );
\r
1394 ulTotalRunTime = portGET_RUN_TIME_COUNTER_VALUE();
\r
1397 /* Divide ulTotalRunTime by 100 to make the percentage caluclations
\r
1398 simpler in the prvGenerateRunTimeStatsForTasksInList() function. */
\r
1399 ulTotalRunTime /= 100UL;
\r
1401 /* Run through all the lists that could potentially contain a TCB,
\r
1402 generating a table of run timer percentages in the provided
\r
1405 *pcWriteBuffer = ( signed char ) 0x00;
\r
1406 strcat( ( char * ) pcWriteBuffer, ( const char * ) "\r\n" );
\r
1408 uxQueue = uxTopUsedPriority + ( unsigned portBASE_TYPE ) 1U;
\r
1414 if( listLIST_IS_EMPTY( &( pxReadyTasksLists[ uxQueue ] ) ) == pdFALSE )
\r
1416 prvGenerateRunTimeStatsForTasksInList( pcWriteBuffer, ( xList * ) &( pxReadyTasksLists[ uxQueue ] ), ulTotalRunTime );
\r
1418 }while( uxQueue > ( unsigned short ) tskIDLE_PRIORITY );
\r
1420 if( listLIST_IS_EMPTY( pxDelayedTaskList ) == pdFALSE )
\r
1422 prvGenerateRunTimeStatsForTasksInList( pcWriteBuffer, ( xList * ) pxDelayedTaskList, ulTotalRunTime );
\r
1425 if( listLIST_IS_EMPTY( pxOverflowDelayedTaskList ) == pdFALSE )
\r
1427 prvGenerateRunTimeStatsForTasksInList( pcWriteBuffer, ( xList * ) pxOverflowDelayedTaskList, ulTotalRunTime );
\r
1430 #if ( INCLUDE_vTaskDelete == 1 )
\r
1432 if( listLIST_IS_EMPTY( &xTasksWaitingTermination ) == pdFALSE )
\r
1434 prvGenerateRunTimeStatsForTasksInList( pcWriteBuffer, &xTasksWaitingTermination, ulTotalRunTime );
\r
1439 #if ( INCLUDE_vTaskSuspend == 1 )
\r
1441 if( listLIST_IS_EMPTY( &xSuspendedTaskList ) == pdFALSE )
\r
1443 prvGenerateRunTimeStatsForTasksInList( pcWriteBuffer, &xSuspendedTaskList, ulTotalRunTime );
\r
1452 /*----------------------------------------------------------*/
\r
1454 #if ( configUSE_TRACE_FACILITY == 1 )
\r
1456 void vTaskStartTrace( signed char * pcBuffer, unsigned long ulBufferSize )
\r
1458 configASSERT( pcBuffer );
\r
1459 configASSERT( ulBufferSize );
\r
1461 taskENTER_CRITICAL();
\r
1463 pcTraceBuffer = ( signed char * )pcBuffer;
\r
1464 pcTraceBufferStart = pcBuffer;
\r
1465 pcTraceBufferEnd = pcBuffer + ( ulBufferSize - tskSIZE_OF_EACH_TRACE_LINE );
\r
1466 xTracing = pdTRUE;
\r
1468 taskEXIT_CRITICAL();
\r
1472 /*----------------------------------------------------------*/
\r
1474 #if ( configUSE_TRACE_FACILITY == 1 )
\r
1476 unsigned long ulTaskEndTrace( void )
\r
1478 unsigned long ulBufferLength;
\r
1480 taskENTER_CRITICAL();
\r
1481 xTracing = pdFALSE;
\r
1482 taskEXIT_CRITICAL();
\r
1484 ulBufferLength = ( unsigned long ) ( pcTraceBuffer - pcTraceBufferStart );
\r
1486 return ulBufferLength;
\r
1490 /*----------------------------------------------------------*/
\r
1492 #if ( INCLUDE_xTaskIdleTaskHandleGet == 1 )
\r
1494 xTaskHandle xTaskIdleTaskHandleGet( void )
\r
1496 /* If xTaskIdleTaskHandleGet() is called before the scheduler has been
\r
1497 started, then xIdleTaskHandle will be NULL. */
\r
1498 configASSERT( ( xIdleTaskHandle != NULL ) );
\r
1499 return xIdleTaskHandle;
\r
1504 /*-----------------------------------------------------------
\r
1505 * SCHEDULER INTERNALS AVAILABLE FOR PORTING PURPOSES
\r
1506 * documented in task.h
\r
1507 *----------------------------------------------------------*/
\r
1509 void vTaskIncrementTick( void )
\r
1513 /* Called by the portable layer each time a tick interrupt occurs.
\r
1514 Increments the tick then checks to see if the new tick value will cause any
\r
1515 tasks to be unblocked. */
\r
1516 if( uxSchedulerSuspended == ( unsigned portBASE_TYPE ) pdFALSE )
\r
1519 if( xTickCount == ( portTickType ) 0U )
\r
1523 /* Tick count has overflowed so we need to swap the delay lists.
\r
1524 If there are any items in pxDelayedTaskList here then there is
\r
1526 configASSERT( ( listLIST_IS_EMPTY( pxDelayedTaskList ) ) );
\r
1528 pxTemp = pxDelayedTaskList;
\r
1529 pxDelayedTaskList = pxOverflowDelayedTaskList;
\r
1530 pxOverflowDelayedTaskList = pxTemp;
\r
1531 xNumOfOverflows++;
\r
1533 if( listLIST_IS_EMPTY( pxDelayedTaskList ) != pdFALSE )
\r
1535 /* The new current delayed list is empty. Set
\r
1536 xNextTaskUnblockTime to the maximum possible value so it is
\r
1537 extremely unlikely that the
\r
1538 if( xTickCount >= xNextTaskUnblockTime ) test will pass until
\r
1539 there is an item in the delayed list. */
\r
1540 xNextTaskUnblockTime = portMAX_DELAY;
\r
1544 /* The new current delayed list is not empty, get the value of
\r
1545 the item at the head of the delayed list. This is the time at
\r
1546 which the task at the head of the delayed list should be removed
\r
1547 from the Blocked state. */
\r
1548 pxTCB = ( tskTCB * ) listGET_OWNER_OF_HEAD_ENTRY( pxDelayedTaskList );
\r
1549 xNextTaskUnblockTime = listGET_LIST_ITEM_VALUE( &( pxTCB->xGenericListItem ) );
\r
1553 /* See if this tick has made a timeout expire. */
\r
1554 prvCheckDelayedTasks();
\r
1560 /* The tick hook gets called at regular intervals, even if the
\r
1561 scheduler is locked. */
\r
1562 #if ( configUSE_TICK_HOOK == 1 )
\r
1564 vApplicationTickHook();
\r
1569 #if ( configUSE_TICK_HOOK == 1 )
\r
1571 /* Guard against the tick hook being called when the missed tick
\r
1572 count is being unwound (when the scheduler is being unlocked. */
\r
1573 if( uxMissedTicks == ( unsigned portBASE_TYPE ) 0U )
\r
1575 vApplicationTickHook();
\r
1580 traceTASK_INCREMENT_TICK( xTickCount );
\r
1582 /*-----------------------------------------------------------*/
\r
1584 #if ( configUSE_APPLICATION_TASK_TAG == 1 )
\r
1586 void vTaskSetApplicationTaskTag( xTaskHandle xTask, pdTASK_HOOK_CODE pxHookFunction )
\r
1590 /* If xTask is NULL then we are setting our own task hook. */
\r
1591 if( xTask == NULL )
\r
1593 xTCB = ( tskTCB * ) pxCurrentTCB;
\r
1597 xTCB = ( tskTCB * ) xTask;
\r
1600 /* Save the hook function in the TCB. A critical section is required as
\r
1601 the value can be accessed from an interrupt. */
\r
1602 taskENTER_CRITICAL();
\r
1603 xTCB->pxTaskTag = pxHookFunction;
\r
1604 taskEXIT_CRITICAL();
\r
1608 /*-----------------------------------------------------------*/
\r
1610 #if ( configUSE_APPLICATION_TASK_TAG == 1 )
\r
1612 pdTASK_HOOK_CODE xTaskGetApplicationTaskTag( xTaskHandle xTask )
\r
1615 pdTASK_HOOK_CODE xReturn;
\r
1617 /* If xTask is NULL then we are setting our own task hook. */
\r
1618 if( xTask == NULL )
\r
1620 xTCB = ( tskTCB * ) pxCurrentTCB;
\r
1624 xTCB = ( tskTCB * ) xTask;
\r
1627 /* Save the hook function in the TCB. A critical section is required as
\r
1628 the value can be accessed from an interrupt. */
\r
1629 taskENTER_CRITICAL();
\r
1630 xReturn = xTCB->pxTaskTag;
\r
1631 taskEXIT_CRITICAL();
\r
1637 /*-----------------------------------------------------------*/
\r
1639 #if ( configUSE_APPLICATION_TASK_TAG == 1 )
\r
1641 portBASE_TYPE xTaskCallApplicationTaskHook( xTaskHandle xTask, void *pvParameter )
\r
1644 portBASE_TYPE xReturn;
\r
1646 /* If xTask is NULL then we are calling our own task hook. */
\r
1647 if( xTask == NULL )
\r
1649 xTCB = ( tskTCB * ) pxCurrentTCB;
\r
1653 xTCB = ( tskTCB * ) xTask;
\r
1656 if( xTCB->pxTaskTag != NULL )
\r
1658 xReturn = xTCB->pxTaskTag( pvParameter );
\r
1669 /*-----------------------------------------------------------*/
\r
1671 void vTaskSwitchContext( void )
\r
1673 if( uxSchedulerSuspended != ( unsigned portBASE_TYPE ) pdFALSE )
\r
1675 /* The scheduler is currently suspended - do not allow a context
\r
1677 xMissedYield = pdTRUE;
\r
1681 traceTASK_SWITCHED_OUT();
\r
1683 #if ( configGENERATE_RUN_TIME_STATS == 1 )
\r
1685 unsigned long ulTempCounter;
\r
1687 #ifdef portALT_GET_RUN_TIME_COUNTER_VALUE
\r
1688 portALT_GET_RUN_TIME_COUNTER_VALUE( ulTempCounter );
\r
1690 ulTempCounter = portGET_RUN_TIME_COUNTER_VALUE();
\r
1693 /* Add the amount of time the task has been running to the accumulated
\r
1694 time so far. The time the task started running was stored in
\r
1695 ulTaskSwitchedInTime. Note that there is no overflow protection here
\r
1696 so count values are only valid until the timer overflows. Generally
\r
1697 this will be about 1 hour assuming a 1uS timer increment. */
\r
1698 pxCurrentTCB->ulRunTimeCounter += ( ulTempCounter - ulTaskSwitchedInTime );
\r
1699 ulTaskSwitchedInTime = ulTempCounter;
\r
1703 taskFIRST_CHECK_FOR_STACK_OVERFLOW();
\r
1704 taskSECOND_CHECK_FOR_STACK_OVERFLOW();
\r
1706 /* Find the highest priority queue that contains ready tasks. */
\r
1707 while( listLIST_IS_EMPTY( &( pxReadyTasksLists[ uxTopReadyPriority ] ) ) )
\r
1709 configASSERT( uxTopReadyPriority );
\r
1710 --uxTopReadyPriority;
\r
1713 /* listGET_OWNER_OF_NEXT_ENTRY walks through the list, so the tasks of the
\r
1714 same priority get an equal share of the processor time. */
\r
1715 listGET_OWNER_OF_NEXT_ENTRY( pxCurrentTCB, &( pxReadyTasksLists[ uxTopReadyPriority ] ) );
\r
1717 traceTASK_SWITCHED_IN();
\r
1718 vWriteTraceToBuffer();
\r
1721 /*-----------------------------------------------------------*/
\r
1723 void vTaskPlaceOnEventList( const xList * const pxEventList, portTickType xTicksToWait )
\r
1725 portTickType xTimeToWake;
\r
1727 configASSERT( pxEventList );
\r
1729 /* THIS FUNCTION MUST BE CALLED WITH INTERRUPTS DISABLED OR THE
\r
1730 SCHEDULER SUSPENDED. */
\r
1732 /* Place the event list item of the TCB in the appropriate event list.
\r
1733 This is placed in the list in priority order so the highest priority task
\r
1734 is the first to be woken by the event. */
\r
1735 vListInsert( ( xList * ) pxEventList, ( xListItem * ) &( pxCurrentTCB->xEventListItem ) );
\r
1737 /* We must remove ourselves from the ready list before adding ourselves
\r
1738 to the blocked list as the same list item is used for both lists. We have
\r
1739 exclusive access to the ready lists as the scheduler is locked. */
\r
1740 vListRemove( ( xListItem * ) &( pxCurrentTCB->xGenericListItem ) );
\r
1743 #if ( INCLUDE_vTaskSuspend == 1 )
\r
1745 if( xTicksToWait == portMAX_DELAY )
\r
1747 /* Add ourselves to the suspended task list instead of a delayed task
\r
1748 list to ensure we are not woken by a timing event. We will block
\r
1750 vListInsertEnd( ( xList * ) &xSuspendedTaskList, ( xListItem * ) &( pxCurrentTCB->xGenericListItem ) );
\r
1754 /* Calculate the time at which the task should be woken if the event does
\r
1755 not occur. This may overflow but this doesn't matter. */
\r
1756 xTimeToWake = xTickCount + xTicksToWait;
\r
1757 prvAddCurrentTaskToDelayedList( xTimeToWake );
\r
1762 /* Calculate the time at which the task should be woken if the event does
\r
1763 not occur. This may overflow but this doesn't matter. */
\r
1764 xTimeToWake = xTickCount + xTicksToWait;
\r
1765 prvAddCurrentTaskToDelayedList( xTimeToWake );
\r
1769 /*-----------------------------------------------------------*/
\r
1771 #if configUSE_TIMERS == 1
\r
1773 void vTaskPlaceOnEventListRestricted( const xList * const pxEventList, portTickType xTicksToWait )
\r
1775 portTickType xTimeToWake;
\r
1777 configASSERT( pxEventList );
\r
1779 /* This function should not be called by application code hence the
\r
1780 'Restricted' in its name. It is not part of the public API. It is
\r
1781 designed for use by kernel code, and has special calling requirements -
\r
1782 it should be called from a critical section. */
\r
1785 /* Place the event list item of the TCB in the appropriate event list.
\r
1786 In this case it is assume that this is the only task that is going to
\r
1787 be waiting on this event list, so the faster vListInsertEnd() function
\r
1788 can be used in place of vListInsert. */
\r
1789 vListInsertEnd( ( xList * ) pxEventList, ( xListItem * ) &( pxCurrentTCB->xEventListItem ) );
\r
1791 /* We must remove this task from the ready list before adding it to the
\r
1792 blocked list as the same list item is used for both lists. This
\r
1793 function is called form a critical section. */
\r
1794 vListRemove( ( xListItem * ) &( pxCurrentTCB->xGenericListItem ) );
\r
1796 /* Calculate the time at which the task should be woken if the event does
\r
1797 not occur. This may overflow but this doesn't matter. */
\r
1798 xTimeToWake = xTickCount + xTicksToWait;
\r
1799 prvAddCurrentTaskToDelayedList( xTimeToWake );
\r
1802 #endif /* configUSE_TIMERS */
\r
1803 /*-----------------------------------------------------------*/
\r
1805 signed portBASE_TYPE xTaskRemoveFromEventList( const xList * const pxEventList )
\r
1807 tskTCB *pxUnblockedTCB;
\r
1808 portBASE_TYPE xReturn;
\r
1810 /* THIS FUNCTION MUST BE CALLED WITH INTERRUPTS DISABLED OR THE
\r
1811 SCHEDULER SUSPENDED. It can also be called from within an ISR. */
\r
1813 /* The event list is sorted in priority order, so we can remove the
\r
1814 first in the list, remove the TCB from the delayed list, and add
\r
1815 it to the ready list.
\r
1817 If an event is for a queue that is locked then this function will never
\r
1818 get called - the lock count on the queue will get modified instead. This
\r
1819 means we can always expect exclusive access to the event list here.
\r
1821 This function assumes that a check has already been made to ensure that
\r
1822 pxEventList is not empty. */
\r
1823 pxUnblockedTCB = ( tskTCB * ) listGET_OWNER_OF_HEAD_ENTRY( pxEventList );
\r
1824 configASSERT( pxUnblockedTCB );
\r
1825 vListRemove( &( pxUnblockedTCB->xEventListItem ) );
\r
1827 if( uxSchedulerSuspended == ( unsigned portBASE_TYPE ) pdFALSE )
\r
1829 vListRemove( &( pxUnblockedTCB->xGenericListItem ) );
\r
1830 prvAddTaskToReadyQueue( pxUnblockedTCB );
\r
1834 /* We cannot access the delayed or ready lists, so will hold this
\r
1835 task pending until the scheduler is resumed. */
\r
1836 vListInsertEnd( ( xList * ) &( xPendingReadyList ), &( pxUnblockedTCB->xEventListItem ) );
\r
1839 if( pxUnblockedTCB->uxPriority >= pxCurrentTCB->uxPriority )
\r
1841 /* Return true if the task removed from the event list has
\r
1842 a higher priority than the calling task. This allows
\r
1843 the calling task to know if it should force a context
\r
1849 xReturn = pdFALSE;
\r
1854 /*-----------------------------------------------------------*/
\r
1856 void vTaskSetTimeOutState( xTimeOutType * const pxTimeOut )
\r
1858 configASSERT( pxTimeOut );
\r
1859 pxTimeOut->xOverflowCount = xNumOfOverflows;
\r
1860 pxTimeOut->xTimeOnEntering = xTickCount;
\r
1862 /*-----------------------------------------------------------*/
\r
1864 portBASE_TYPE xTaskCheckForTimeOut( xTimeOutType * const pxTimeOut, portTickType * const pxTicksToWait )
\r
1866 portBASE_TYPE xReturn;
\r
1868 configASSERT( pxTimeOut );
\r
1869 configASSERT( pxTicksToWait );
\r
1871 taskENTER_CRITICAL();
\r
1873 #if ( INCLUDE_vTaskSuspend == 1 )
\r
1874 /* If INCLUDE_vTaskSuspend is set to 1 and the block time specified is
\r
1875 the maximum block time then the task should block indefinitely, and
\r
1876 therefore never time out. */
\r
1877 if( *pxTicksToWait == portMAX_DELAY )
\r
1879 xReturn = pdFALSE;
\r
1881 else /* We are not blocking indefinitely, perform the checks below. */
\r
1884 if( ( xNumOfOverflows != pxTimeOut->xOverflowCount ) && ( ( portTickType ) xTickCount >= ( portTickType ) pxTimeOut->xTimeOnEntering ) )
\r
1886 /* The tick count is greater than the time at which vTaskSetTimeout()
\r
1887 was called, but has also overflowed since vTaskSetTimeOut() was called.
\r
1888 It must have wrapped all the way around and gone past us again. This
\r
1889 passed since vTaskSetTimeout() was called. */
\r
1892 else if( ( ( portTickType ) ( ( portTickType ) xTickCount - ( portTickType ) pxTimeOut->xTimeOnEntering ) ) < ( portTickType ) *pxTicksToWait )
\r
1894 /* Not a genuine timeout. Adjust parameters for time remaining. */
\r
1895 *pxTicksToWait -= ( ( portTickType ) xTickCount - ( portTickType ) pxTimeOut->xTimeOnEntering );
\r
1896 vTaskSetTimeOutState( pxTimeOut );
\r
1897 xReturn = pdFALSE;
\r
1904 taskEXIT_CRITICAL();
\r
1908 /*-----------------------------------------------------------*/
\r
1910 void vTaskMissedYield( void )
\r
1912 xMissedYield = pdTRUE;
\r
1916 * -----------------------------------------------------------
\r
1918 * ----------------------------------------------------------
\r
1920 * The portTASK_FUNCTION() macro is used to allow port/compiler specific
\r
1921 * language extensions. The equivalent prototype for this function is:
\r
1923 * void prvIdleTask( void *pvParameters );
\r
1926 static portTASK_FUNCTION( prvIdleTask, pvParameters )
\r
1928 /* Stop warnings. */
\r
1929 ( void ) pvParameters;
\r
1933 /* See if any tasks have been deleted. */
\r
1934 prvCheckTasksWaitingTermination();
\r
1936 #if ( configUSE_PREEMPTION == 0 )
\r
1938 /* If we are not using preemption we keep forcing a task switch to
\r
1939 see if any other task has become available. If we are using
\r
1940 preemption we don't need to do this as any task becoming available
\r
1941 will automatically get the processor anyway. */
\r
1946 #if ( ( configUSE_PREEMPTION == 1 ) && ( configIDLE_SHOULD_YIELD == 1 ) )
\r
1948 /* When using preemption tasks of equal priority will be
\r
1949 timesliced. If a task that is sharing the idle priority is ready
\r
1950 to run then the idle task should yield before the end of the
\r
1953 A critical region is not required here as we are just reading from
\r
1954 the list, and an occasional incorrect value will not matter. If
\r
1955 the ready list at the idle priority contains more than one task
\r
1956 then a task other than the idle task is ready to execute. */
\r
1957 if( listCURRENT_LIST_LENGTH( &( pxReadyTasksLists[ tskIDLE_PRIORITY ] ) ) > ( unsigned portBASE_TYPE ) 1 )
\r
1964 #if ( configUSE_IDLE_HOOK == 1 )
\r
1966 extern void vApplicationIdleHook( void );
\r
1968 /* Call the user defined function from within the idle task. This
\r
1969 allows the application designer to add background functionality
\r
1970 without the overhead of a separate task.
\r
1971 NOTE: vApplicationIdleHook() MUST NOT, UNDER ANY CIRCUMSTANCES,
\r
1972 CALL A FUNCTION THAT MIGHT BLOCK. */
\r
1973 vApplicationIdleHook();
\r
1977 } /*lint !e715 pvParameters is not accessed but all task functions require the same prototype. */
\r
1985 /*-----------------------------------------------------------
\r
1986 * File private functions documented at the top of the file.
\r
1987 *----------------------------------------------------------*/
\r
1991 static void prvInitialiseTCBVariables( tskTCB *pxTCB, const signed char * const pcName, unsigned portBASE_TYPE uxPriority, const xMemoryRegion * const xRegions, unsigned short usStackDepth )
\r
1993 /* Store the function name in the TCB. */
\r
1994 #if configMAX_TASK_NAME_LEN > 1
\r
1996 /* Don't bring strncpy into the build unnecessarily. */
\r
1997 strncpy( ( char * ) pxTCB->pcTaskName, ( const char * ) pcName, ( unsigned short ) configMAX_TASK_NAME_LEN );
\r
2000 pxTCB->pcTaskName[ ( unsigned short ) configMAX_TASK_NAME_LEN - ( unsigned short ) 1 ] = ( signed char ) '\0';
\r
2002 /* This is used as an array index so must ensure it's not too large. First
\r
2003 remove the privilege bit if one is present. */
\r
2004 if( uxPriority >= configMAX_PRIORITIES )
\r
2006 uxPriority = configMAX_PRIORITIES - ( unsigned portBASE_TYPE ) 1U;
\r
2009 pxTCB->uxPriority = uxPriority;
\r
2010 #if ( configUSE_MUTEXES == 1 )
\r
2012 pxTCB->uxBasePriority = uxPriority;
\r
2016 vListInitialiseItem( &( pxTCB->xGenericListItem ) );
\r
2017 vListInitialiseItem( &( pxTCB->xEventListItem ) );
\r
2019 /* Set the pxTCB as a link back from the xListItem. This is so we can get
\r
2020 back to the containing TCB from a generic item in a list. */
\r
2021 listSET_LIST_ITEM_OWNER( &( pxTCB->xGenericListItem ), pxTCB );
\r
2023 /* Event lists are always in priority order. */
\r
2024 listSET_LIST_ITEM_VALUE( &( pxTCB->xEventListItem ), configMAX_PRIORITIES - ( portTickType ) uxPriority );
\r
2025 listSET_LIST_ITEM_OWNER( &( pxTCB->xEventListItem ), pxTCB );
\r
2027 #if ( portCRITICAL_NESTING_IN_TCB == 1 )
\r
2029 pxTCB->uxCriticalNesting = ( unsigned portBASE_TYPE ) 0U;
\r
2033 #if ( configUSE_APPLICATION_TASK_TAG == 1 )
\r
2035 pxTCB->pxTaskTag = NULL;
\r
2039 #if ( configGENERATE_RUN_TIME_STATS == 1 )
\r
2041 pxTCB->ulRunTimeCounter = 0UL;
\r
2045 #if ( portUSING_MPU_WRAPPERS == 1 )
\r
2047 vPortStoreTaskMPUSettings( &( pxTCB->xMPUSettings ), xRegions, pxTCB->pxStack, usStackDepth );
\r
2051 ( void ) xRegions;
\r
2052 ( void ) usStackDepth;
\r
2056 /*-----------------------------------------------------------*/
\r
2058 #if ( portUSING_MPU_WRAPPERS == 1 )
\r
2060 void vTaskAllocateMPURegions( xTaskHandle xTaskToModify, const xMemoryRegion * const xRegions )
\r
2064 if( xTaskToModify == pxCurrentTCB )
\r
2066 xTaskToModify = NULL;
\r
2069 /* If null is passed in here then we are deleting ourselves. */
\r
2070 pxTCB = prvGetTCBFromHandle( xTaskToModify );
\r
2072 vPortStoreTaskMPUSettings( &( pxTCB->xMPUSettings ), xRegions, NULL, 0 );
\r
2074 /*-----------------------------------------------------------*/
\r
2077 static void prvInitialiseTaskLists( void )
\r
2079 unsigned portBASE_TYPE uxPriority;
\r
2081 for( uxPriority = ( unsigned portBASE_TYPE ) 0U; uxPriority < configMAX_PRIORITIES; uxPriority++ )
\r
2083 vListInitialise( ( xList * ) &( pxReadyTasksLists[ uxPriority ] ) );
\r
2086 vListInitialise( ( xList * ) &xDelayedTaskList1 );
\r
2087 vListInitialise( ( xList * ) &xDelayedTaskList2 );
\r
2088 vListInitialise( ( xList * ) &xPendingReadyList );
\r
2090 #if ( INCLUDE_vTaskDelete == 1 )
\r
2092 vListInitialise( ( xList * ) &xTasksWaitingTermination );
\r
2096 #if ( INCLUDE_vTaskSuspend == 1 )
\r
2098 vListInitialise( ( xList * ) &xSuspendedTaskList );
\r
2102 /* Start with pxDelayedTaskList using list1 and the pxOverflowDelayedTaskList
\r
2104 pxDelayedTaskList = &xDelayedTaskList1;
\r
2105 pxOverflowDelayedTaskList = &xDelayedTaskList2;
\r
2107 /*-----------------------------------------------------------*/
\r
2109 static void prvCheckTasksWaitingTermination( void )
\r
2111 #if ( INCLUDE_vTaskDelete == 1 )
\r
2113 portBASE_TYPE xListIsEmpty;
\r
2115 /* ucTasksDeleted is used to prevent vTaskSuspendAll() being called
\r
2116 too often in the idle task. */
\r
2117 if( uxTasksDeleted > ( unsigned portBASE_TYPE ) 0U )
\r
2119 vTaskSuspendAll();
\r
2120 xListIsEmpty = listLIST_IS_EMPTY( &xTasksWaitingTermination );
\r
2123 if( xListIsEmpty == pdFALSE )
\r
2127 taskENTER_CRITICAL();
\r
2129 pxTCB = ( tskTCB * ) listGET_OWNER_OF_HEAD_ENTRY( ( ( xList * ) &xTasksWaitingTermination ) );
\r
2130 vListRemove( &( pxTCB->xGenericListItem ) );
\r
2131 --uxCurrentNumberOfTasks;
\r
2134 taskEXIT_CRITICAL();
\r
2136 prvDeleteTCB( pxTCB );
\r
2142 /*-----------------------------------------------------------*/
\r
2144 static void prvAddCurrentTaskToDelayedList( portTickType xTimeToWake )
\r
2146 /* The list item will be inserted in wake time order. */
\r
2147 listSET_LIST_ITEM_VALUE( &( pxCurrentTCB->xGenericListItem ), xTimeToWake );
\r
2149 if( xTimeToWake < xTickCount )
\r
2151 /* Wake time has overflowed. Place this item in the overflow list. */
\r
2152 vListInsert( ( xList * ) pxOverflowDelayedTaskList, ( xListItem * ) &( pxCurrentTCB->xGenericListItem ) );
\r
2156 /* The wake time has not overflowed, so we can use the current block list. */
\r
2157 vListInsert( ( xList * ) pxDelayedTaskList, ( xListItem * ) &( pxCurrentTCB->xGenericListItem ) );
\r
2159 /* If the task entering the blocked state was placed at the head of the
\r
2160 list of blocked tasks then xNextTaskUnblockTime needs to be updated
\r
2162 if( xTimeToWake < xNextTaskUnblockTime )
\r
2164 xNextTaskUnblockTime = xTimeToWake;
\r
2168 /*-----------------------------------------------------------*/
\r
2170 static tskTCB *prvAllocateTCBAndStack( unsigned short usStackDepth, portSTACK_TYPE *puxStackBuffer )
\r
2174 /* Allocate space for the TCB. Where the memory comes from depends on
\r
2175 the implementation of the port malloc function. */
\r
2176 pxNewTCB = ( tskTCB * ) pvPortMalloc( sizeof( tskTCB ) );
\r
2178 if( pxNewTCB != NULL )
\r
2180 /* Allocate space for the stack used by the task being created.
\r
2181 The base of the stack memory stored in the TCB so the task can
\r
2182 be deleted later if required. */
\r
2183 pxNewTCB->pxStack = ( portSTACK_TYPE * ) pvPortMallocAligned( ( ( ( size_t )usStackDepth ) * sizeof( portSTACK_TYPE ) ), puxStackBuffer );
\r
2185 if( pxNewTCB->pxStack == NULL )
\r
2187 /* Could not allocate the stack. Delete the allocated TCB. */
\r
2188 vPortFree( pxNewTCB );
\r
2193 /* Just to help debugging. */
\r
2194 memset( pxNewTCB->pxStack, ( int ) tskSTACK_FILL_BYTE, ( size_t ) usStackDepth * sizeof( portSTACK_TYPE ) );
\r
2200 /*-----------------------------------------------------------*/
\r
2202 #if ( configUSE_TRACE_FACILITY == 1 )
\r
2204 static void prvListTaskWithinSingleList( const signed char *pcWriteBuffer, xList *pxList, signed char cStatus )
\r
2206 volatile tskTCB *pxNextTCB, *pxFirstTCB;
\r
2207 unsigned short usStackRemaining;
\r
2209 /* Write the details of all the TCB's in pxList into the buffer. */
\r
2210 listGET_OWNER_OF_NEXT_ENTRY( pxFirstTCB, pxList );
\r
2213 listGET_OWNER_OF_NEXT_ENTRY( pxNextTCB, pxList );
\r
2214 #if ( portSTACK_GROWTH > 0 )
\r
2216 usStackRemaining = usTaskCheckFreeStackSpace( ( unsigned char * ) pxNextTCB->pxEndOfStack );
\r
2220 usStackRemaining = usTaskCheckFreeStackSpace( ( unsigned char * ) pxNextTCB->pxStack );
\r
2224 sprintf( pcStatusString, ( char * ) "%s\t\t%c\t%u\t%u\t%u\r\n", pxNextTCB->pcTaskName, cStatus, ( unsigned int ) pxNextTCB->uxPriority, usStackRemaining, ( unsigned int ) pxNextTCB->uxTCBNumber );
\r
2225 strcat( ( char * ) pcWriteBuffer, ( char * ) pcStatusString );
\r
2227 } while( pxNextTCB != pxFirstTCB );
\r
2231 /*-----------------------------------------------------------*/
\r
2233 #if ( configGENERATE_RUN_TIME_STATS == 1 )
\r
2235 static void prvGenerateRunTimeStatsForTasksInList( const signed char *pcWriteBuffer, xList *pxList, unsigned long ulTotalRunTime )
\r
2237 volatile tskTCB *pxNextTCB, *pxFirstTCB;
\r
2238 unsigned long ulStatsAsPercentage;
\r
2240 /* Write the run time stats of all the TCB's in pxList into the buffer. */
\r
2241 listGET_OWNER_OF_NEXT_ENTRY( pxFirstTCB, pxList );
\r
2244 /* Get next TCB in from the list. */
\r
2245 listGET_OWNER_OF_NEXT_ENTRY( pxNextTCB, pxList );
\r
2247 /* Divide by zero check. */
\r
2248 if( ulTotalRunTime > 0UL )
\r
2250 /* Has the task run at all? */
\r
2251 if( pxNextTCB->ulRunTimeCounter == 0UL )
\r
2253 /* The task has used no CPU time at all. */
\r
2254 sprintf( pcStatsString, ( char * ) "%s\t\t0\t\t0%%\r\n", pxNextTCB->pcTaskName );
\r
2258 /* What percentage of the total run time has the task used?
\r
2259 This will always be rounded down to the nearest integer.
\r
2260 ulTotalRunTime has already been divided by 100. */
\r
2261 ulStatsAsPercentage = pxNextTCB->ulRunTimeCounter / ulTotalRunTime;
\r
2263 if( ulStatsAsPercentage > 0UL )
\r
2265 #ifdef portLU_PRINTF_SPECIFIER_REQUIRED
\r
2267 sprintf( pcStatsString, ( char * ) "%s\t\t%lu\t\t%lu%%\r\n", pxNextTCB->pcTaskName, pxNextTCB->ulRunTimeCounter, ulStatsAsPercentage );
\r
2271 /* sizeof( int ) == sizeof( long ) so a smaller
\r
2272 printf() library can be used. */
\r
2273 sprintf( pcStatsString, ( char * ) "%s\t\t%u\t\t%u%%\r\n", pxNextTCB->pcTaskName, ( unsigned int ) pxNextTCB->ulRunTimeCounter, ( unsigned int ) ulStatsAsPercentage );
\r
2279 /* If the percentage is zero here then the task has
\r
2280 consumed less than 1% of the total run time. */
\r
2281 #ifdef portLU_PRINTF_SPECIFIER_REQUIRED
\r
2283 sprintf( pcStatsString, ( char * ) "%s\t\t%lu\t\t<1%%\r\n", pxNextTCB->pcTaskName, pxNextTCB->ulRunTimeCounter );
\r
2287 /* sizeof( int ) == sizeof( long ) so a smaller
\r
2288 printf() library can be used. */
\r
2289 sprintf( pcStatsString, ( char * ) "%s\t\t%u\t\t<1%%\r\n", pxNextTCB->pcTaskName, ( unsigned int ) pxNextTCB->ulRunTimeCounter );
\r
2295 strcat( ( char * ) pcWriteBuffer, ( char * ) pcStatsString );
\r
2298 } while( pxNextTCB != pxFirstTCB );
\r
2302 /*-----------------------------------------------------------*/
\r
2304 #if ( ( configUSE_TRACE_FACILITY == 1 ) || ( INCLUDE_uxTaskGetStackHighWaterMark == 1 ) )
\r
2306 static unsigned short usTaskCheckFreeStackSpace( const unsigned char * pucStackByte )
\r
2308 register unsigned short usCount = 0U;
\r
2310 while( *pucStackByte == tskSTACK_FILL_BYTE )
\r
2312 pucStackByte -= portSTACK_GROWTH;
\r
2316 usCount /= sizeof( portSTACK_TYPE );
\r
2322 /*-----------------------------------------------------------*/
\r
2324 #if ( INCLUDE_uxTaskGetStackHighWaterMark == 1 )
\r
2326 unsigned portBASE_TYPE uxTaskGetStackHighWaterMark( xTaskHandle xTask )
\r
2329 unsigned char *pcEndOfStack;
\r
2330 unsigned portBASE_TYPE uxReturn;
\r
2332 pxTCB = prvGetTCBFromHandle( xTask );
\r
2334 #if portSTACK_GROWTH < 0
\r
2336 pcEndOfStack = ( unsigned char * ) pxTCB->pxStack;
\r
2340 pcEndOfStack = ( unsigned char * ) pxTCB->pxEndOfStack;
\r
2344 uxReturn = ( unsigned portBASE_TYPE ) usTaskCheckFreeStackSpace( pcEndOfStack );
\r
2350 /*-----------------------------------------------------------*/
\r
2352 #if ( INCLUDE_vTaskDelete == 1 )
\r
2354 static void prvDeleteTCB( tskTCB *pxTCB )
\r
2356 /* Free up the memory allocated by the scheduler for the task. It is up to
\r
2357 the task to free any memory allocated at the application level. */
\r
2358 vPortFreeAligned( pxTCB->pxStack );
\r
2359 vPortFree( pxTCB );
\r
2365 /*-----------------------------------------------------------*/
\r
2367 #if ( ( INCLUDE_xTaskGetCurrentTaskHandle == 1 ) || ( configUSE_MUTEXES == 1 ) )
\r
2369 xTaskHandle xTaskGetCurrentTaskHandle( void )
\r
2371 xTaskHandle xReturn;
\r
2373 /* A critical section is not required as this is not called from
\r
2374 an interrupt and the current TCB will always be the same for any
\r
2375 individual execution thread. */
\r
2376 xReturn = pxCurrentTCB;
\r
2383 /*-----------------------------------------------------------*/
\r
2385 #if ( ( INCLUDE_xTaskGetSchedulerState == 1 ) || ( configUSE_TIMERS == 1 ) )
\r
2387 portBASE_TYPE xTaskGetSchedulerState( void )
\r
2389 portBASE_TYPE xReturn;
\r
2391 if( xSchedulerRunning == pdFALSE )
\r
2393 xReturn = taskSCHEDULER_NOT_STARTED;
\r
2397 if( uxSchedulerSuspended == ( unsigned portBASE_TYPE ) pdFALSE )
\r
2399 xReturn = taskSCHEDULER_RUNNING;
\r
2403 xReturn = taskSCHEDULER_SUSPENDED;
\r
2411 /*-----------------------------------------------------------*/
\r
2413 #if ( configUSE_MUTEXES == 1 )
\r
2415 void vTaskPriorityInherit( xTaskHandle * const pxMutexHolder )
\r
2417 tskTCB * const pxTCB = ( tskTCB * ) pxMutexHolder;
\r
2419 configASSERT( pxMutexHolder );
\r
2421 if( pxTCB->uxPriority < pxCurrentTCB->uxPriority )
\r
2423 /* Adjust the mutex holder state to account for its new priority. */
\r
2424 listSET_LIST_ITEM_VALUE( &( pxTCB->xEventListItem ), configMAX_PRIORITIES - ( portTickType ) pxCurrentTCB->uxPriority );
\r
2426 /* If the task being modified is in the ready state it will need to
\r
2427 be moved in to a new list. */
\r
2428 if( listIS_CONTAINED_WITHIN( &( pxReadyTasksLists[ pxTCB->uxPriority ] ), &( pxTCB->xGenericListItem ) ) != pdFALSE )
\r
2430 vListRemove( &( pxTCB->xGenericListItem ) );
\r
2432 /* Inherit the priority before being moved into the new list. */
\r
2433 pxTCB->uxPriority = pxCurrentTCB->uxPriority;
\r
2434 prvAddTaskToReadyQueue( pxTCB );
\r
2438 /* Just inherit the priority. */
\r
2439 pxTCB->uxPriority = pxCurrentTCB->uxPriority;
\r
2445 /*-----------------------------------------------------------*/
\r
2447 #if ( configUSE_MUTEXES == 1 )
\r
2449 void vTaskPriorityDisinherit( xTaskHandle * const pxMutexHolder )
\r
2451 tskTCB * const pxTCB = ( tskTCB * ) pxMutexHolder;
\r
2453 if( pxMutexHolder != NULL )
\r
2455 if( pxTCB->uxPriority != pxTCB->uxBasePriority )
\r
2457 /* We must be the running task to be able to give the mutex back.
\r
2458 Remove ourselves from the ready list we currently appear in. */
\r
2459 vListRemove( &( pxTCB->xGenericListItem ) );
\r
2461 /* Disinherit the priority before adding ourselves into the new
\r
2463 pxTCB->uxPriority = pxTCB->uxBasePriority;
\r
2464 listSET_LIST_ITEM_VALUE( &( pxTCB->xEventListItem ), configMAX_PRIORITIES - ( portTickType ) pxTCB->uxPriority );
\r
2465 prvAddTaskToReadyQueue( pxTCB );
\r
2471 /*-----------------------------------------------------------*/
\r
2473 #if ( portCRITICAL_NESTING_IN_TCB == 1 )
\r
2475 void vTaskEnterCritical( void )
\r
2477 portDISABLE_INTERRUPTS();
\r
2479 if( xSchedulerRunning != pdFALSE )
\r
2481 ( pxCurrentTCB->uxCriticalNesting )++;
\r
2486 /*-----------------------------------------------------------*/
\r
2488 #if ( portCRITICAL_NESTING_IN_TCB == 1 )
\r
2490 void vTaskExitCritical( void )
\r
2492 if( xSchedulerRunning != pdFALSE )
\r
2494 if( pxCurrentTCB->uxCriticalNesting > 0U )
\r
2496 ( pxCurrentTCB->uxCriticalNesting )--;
\r
2498 if( pxCurrentTCB->uxCriticalNesting == 0U )
\r
2500 portENABLE_INTERRUPTS();
\r
2507 /*-----------------------------------------------------------*/
\r
projects / freertos / blob