2 FreeRTOS V6.1.0 - Copyright (C) 2010 Real Time Engineers Ltd.
\r
4 ***************************************************************************
\r
8 * + New to FreeRTOS, *
\r
9 * + Wanting to learn FreeRTOS or multitasking in general quickly *
\r
10 * + Looking for basic training, *
\r
11 * + Wanting to improve your FreeRTOS skills and productivity *
\r
13 * then take a look at the FreeRTOS books - available as PDF or paperback *
\r
15 * "Using the FreeRTOS Real Time Kernel - a Practical Guide" *
\r
16 * http://www.FreeRTOS.org/Documentation *
\r
18 * A pdf reference manual is also available. Both are usually delivered *
\r
19 * to your inbox within 20 minutes to two hours when purchased between 8am *
\r
20 * and 8pm GMT (although please allow up to 24 hours in case of *
\r
21 * exceptional circumstances). Thank you for your support! *
\r
23 ***************************************************************************
\r
25 This file is part of the FreeRTOS distribution.
\r
27 FreeRTOS is free software; you can redistribute it and/or modify it under
\r
28 the terms of the GNU General Public License (version 2) as published by the
\r
29 Free Software Foundation AND MODIFIED BY the FreeRTOS exception.
\r
30 ***NOTE*** The exception to the GPL is included to allow you to distribute
\r
31 a combined work that includes FreeRTOS without being obliged to provide the
\r
32 source code for proprietary components outside of the FreeRTOS kernel.
\r
33 FreeRTOS is distributed in the hope that it will be useful, but WITHOUT
\r
34 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
\r
35 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
\r
36 more details. You should have received a copy of the GNU General Public
\r
37 License and the FreeRTOS license exception along with FreeRTOS; if not it
\r
38 can be viewed here: http://www.freertos.org/a00114.html and also obtained
\r
39 by writing to Richard Barry, contact details for whom are available on the
\r
44 http://www.FreeRTOS.org - Documentation, latest information, license and
\r
47 http://www.SafeRTOS.com - A version that is certified for use in safety
\r
50 http://www.OpenRTOS.com - Commercial support, development, porting,
\r
51 licensing and training services.
\r
59 /* Defining MPU_WRAPPERS_INCLUDED_FROM_API_FILE prevents task.h from redefining
\r
60 all the API functions to use the MPU wrappers. That should only be done when
\r
61 task.h is included from an application file. */
\r
62 #define MPU_WRAPPERS_INCLUDED_FROM_API_FILE
\r
64 #include "FreeRTOS.h"
\r
66 #include "StackMacros.h"
\r
68 #undef MPU_WRAPPERS_INCLUDED_FROM_API_FILE
\r
71 * Macro to define the amount of stack available to the idle task.
\r
73 #define tskIDLE_STACK_SIZE configMINIMAL_STACK_SIZE
\r
76 * Task control block. A task control block (TCB) is allocated to each task,
\r
77 * and stores the context of the task.
\r
79 typedef struct tskTaskControlBlock
\r
81 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
83 #if ( portUSING_MPU_WRAPPERS == 1 )
\r
84 xMPU_SETTINGS xMPUSettings; /*< The MPU settings are defined as part of the port layer. THIS MUST BE THE SECOND MEMBER OF THE STRUCT. */
\r
87 xListItem xGenericListItem; /*< List item used to place the TCB in ready and blocked queues. */
\r
88 xListItem xEventListItem; /*< List item used to place the TCB in event lists. */
\r
89 unsigned portBASE_TYPE uxPriority; /*< The priority of the task where 0 is the lowest priority. */
\r
90 portSTACK_TYPE *pxStack; /*< Points to the start of the stack. */
\r
91 signed char pcTaskName[ configMAX_TASK_NAME_LEN ];/*< Descriptive name given to the task when created. Facilitates debugging only. */
\r
93 #if ( portSTACK_GROWTH > 0 )
\r
94 portSTACK_TYPE *pxEndOfStack; /*< Used for stack overflow checking on architectures where the stack grows up from low memory. */
\r
97 #if ( portCRITICAL_NESTING_IN_TCB == 1 )
\r
98 unsigned portBASE_TYPE uxCriticalNesting;
\r
101 #if ( configUSE_TRACE_FACILITY == 1 )
\r
102 unsigned portBASE_TYPE uxTCBNumber; /*< This is used for tracing the scheduler and making debugging easier only. */
\r
105 #if ( configUSE_MUTEXES == 1 )
\r
106 unsigned portBASE_TYPE uxBasePriority; /*< The priority last assigned to the task - used by the priority inheritance mechanism. */
\r
109 #if ( configUSE_APPLICATION_TASK_TAG == 1 )
\r
110 pdTASK_HOOK_CODE pxTaskTag;
\r
113 #if ( configGENERATE_RUN_TIME_STATS == 1 )
\r
114 unsigned long ulRunTimeCounter; /*< Used for calculating how much CPU time each task is utilising. */
\r
121 * Some kernel aware debuggers require data to be viewed to be global, rather
\r
124 #ifdef portREMOVE_STATIC_QUALIFIER
\r
129 PRIVILEGED_DATA tskTCB * volatile pxCurrentTCB = NULL;
\r
131 /* Lists for ready and blocked tasks. --------------------*/
\r
133 PRIVILEGED_DATA static xList pxReadyTasksLists[ configMAX_PRIORITIES ]; /*< Prioritised ready tasks. */
\r
134 PRIVILEGED_DATA static xList xDelayedTaskList1; /*< Delayed tasks. */
\r
135 PRIVILEGED_DATA static xList xDelayedTaskList2; /*< Delayed tasks (two lists are used - one for delays that have overflowed the current tick count. */
\r
136 PRIVILEGED_DATA static xList * volatile pxDelayedTaskList ; /*< Points to the delayed task list currently being used. */
\r
137 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
138 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
140 #if ( INCLUDE_vTaskDelete == 1 )
\r
142 PRIVILEGED_DATA static volatile xList xTasksWaitingTermination; /*< Tasks that have been deleted - but the their memory not yet freed. */
\r
143 PRIVILEGED_DATA static volatile unsigned portBASE_TYPE uxTasksDeleted = ( unsigned portBASE_TYPE ) 0;
\r
147 #if ( INCLUDE_vTaskSuspend == 1 )
\r
149 PRIVILEGED_DATA static xList xSuspendedTaskList; /*< Tasks that are currently suspended. */
\r
153 /* File private variables. --------------------------------*/
\r
154 PRIVILEGED_DATA static volatile unsigned portBASE_TYPE uxCurrentNumberOfTasks = ( unsigned portBASE_TYPE ) 0;
\r
155 PRIVILEGED_DATA static volatile portTickType xTickCount = ( portTickType ) 0;
\r
156 PRIVILEGED_DATA static unsigned portBASE_TYPE uxTopUsedPriority = tskIDLE_PRIORITY;
\r
157 PRIVILEGED_DATA static volatile unsigned portBASE_TYPE uxTopReadyPriority = tskIDLE_PRIORITY;
\r
158 PRIVILEGED_DATA static volatile signed portBASE_TYPE xSchedulerRunning = pdFALSE;
\r
159 PRIVILEGED_DATA static volatile unsigned portBASE_TYPE uxSchedulerSuspended = ( unsigned portBASE_TYPE ) pdFALSE;
\r
160 PRIVILEGED_DATA static volatile unsigned portBASE_TYPE uxMissedTicks = ( unsigned portBASE_TYPE ) 0;
\r
161 PRIVILEGED_DATA static volatile portBASE_TYPE xMissedYield = ( portBASE_TYPE ) pdFALSE;
\r
162 PRIVILEGED_DATA static volatile portBASE_TYPE xNumOfOverflows = ( portBASE_TYPE ) 0;
\r
163 PRIVILEGED_DATA static unsigned portBASE_TYPE uxTaskNumber = ( unsigned portBASE_TYPE ) 0;
\r
165 #if ( configGENERATE_RUN_TIME_STATS == 1 )
\r
167 PRIVILEGED_DATA static char pcStatsString[ 50 ] ;
\r
168 PRIVILEGED_DATA static unsigned long ulTaskSwitchedInTime = 0UL; /*< Holds the value of a timer/counter the last time a task was switched in. */
\r
169 static void prvGenerateRunTimeStatsForTasksInList( const signed char *pcWriteBuffer, xList *pxList, unsigned long ulTotalRunTime ) PRIVILEGED_FUNCTION;
\r
173 /* Debugging and trace facilities private variables and macros. ------------*/
\r
176 * The value used to fill the stack of a task when the task is created. This
\r
177 * is used purely for checking the high water mark for tasks.
\r
179 #define tskSTACK_FILL_BYTE ( 0xa5 )
\r
182 * Macros used by vListTask to indicate which state a task is in.
\r
184 #define tskBLOCKED_CHAR ( ( signed char ) 'B' )
\r
185 #define tskREADY_CHAR ( ( signed char ) 'R' )
\r
186 #define tskDELETED_CHAR ( ( signed char ) 'D' )
\r
187 #define tskSUSPENDED_CHAR ( ( signed char ) 'S' )
\r
190 * Macros and private variables used by the trace facility.
\r
192 #if ( configUSE_TRACE_FACILITY == 1 )
\r
194 #define tskSIZE_OF_EACH_TRACE_LINE ( ( unsigned long ) ( sizeof( unsigned long ) + sizeof( unsigned long ) ) )
\r
195 PRIVILEGED_DATA static volatile signed char * volatile pcTraceBuffer;
\r
196 PRIVILEGED_DATA static signed char *pcTraceBufferStart;
\r
197 PRIVILEGED_DATA static signed char *pcTraceBufferEnd;
\r
198 PRIVILEGED_DATA static signed portBASE_TYPE xTracing = pdFALSE;
\r
199 static unsigned portBASE_TYPE uxPreviousTask = 255;
\r
200 PRIVILEGED_DATA static char pcStatusString[ 50 ];
\r
204 /*-----------------------------------------------------------*/
\r
207 * Macro that writes a trace of scheduler activity to a buffer. This trace
\r
208 * shows which task is running when and is very useful as a debugging tool.
\r
209 * As this macro is called each context switch it is a good idea to undefine
\r
210 * it if not using the facility.
\r
212 #if ( configUSE_TRACE_FACILITY == 1 )
\r
214 #define vWriteTraceToBuffer() \
\r
218 if( uxPreviousTask != pxCurrentTCB->uxTCBNumber ) \
\r
220 if( ( pcTraceBuffer + tskSIZE_OF_EACH_TRACE_LINE ) < pcTraceBufferEnd ) \
\r
222 uxPreviousTask = pxCurrentTCB->uxTCBNumber; \
\r
223 *( unsigned long * ) pcTraceBuffer = ( unsigned long ) xTickCount; \
\r
224 pcTraceBuffer += sizeof( unsigned long ); \
\r
225 *( unsigned long * ) pcTraceBuffer = ( unsigned long ) uxPreviousTask; \
\r
226 pcTraceBuffer += sizeof( unsigned long ); \
\r
230 xTracing = pdFALSE; \
\r
238 #define vWriteTraceToBuffer()
\r
241 /*-----------------------------------------------------------*/
\r
244 * Place the task represented by pxTCB into the appropriate ready queue for
\r
245 * the task. It is inserted at the end of the list. One quirk of this is
\r
246 * that if the task being inserted is at the same priority as the currently
\r
247 * executing task, then it will only be rescheduled after the currently
\r
248 * executing task has been rescheduled.
\r
250 #define prvAddTaskToReadyQueue( pxTCB ) \
\r
252 if( pxTCB->uxPriority > uxTopReadyPriority ) \
\r
254 uxTopReadyPriority = pxTCB->uxPriority; \
\r
256 vListInsertEnd( ( xList * ) &( pxReadyTasksLists[ pxTCB->uxPriority ] ), &( pxTCB->xGenericListItem ) ); \
\r
258 /*-----------------------------------------------------------*/
\r
261 * Macro that looks at the list of tasks that are currently delayed to see if
\r
262 * any require waking.
\r
264 * Tasks are stored in the queue in the order of their wake time - meaning
\r
265 * once one tasks has been found whose timer has not expired we need not look
\r
266 * any further down the list.
\r
268 #define prvCheckDelayedTasks() \
\r
270 register tskTCB *pxTCB; \
\r
272 while( ( pxTCB = ( tskTCB * ) listGET_OWNER_OF_HEAD_ENTRY( pxDelayedTaskList ) ) != NULL ) \
\r
274 if( xTickCount < listGET_LIST_ITEM_VALUE( &( pxTCB->xGenericListItem ) ) ) \
\r
278 vListRemove( &( pxTCB->xGenericListItem ) ); \
\r
279 /* Is the task waiting on an event also? */ \
\r
280 if( pxTCB->xEventListItem.pvContainer ) \
\r
282 vListRemove( &( pxTCB->xEventListItem ) ); \
\r
284 prvAddTaskToReadyQueue( pxTCB ); \
\r
287 /*-----------------------------------------------------------*/
\r
290 * Several functions take an xTaskHandle parameter that can optionally be NULL,
\r
291 * where NULL is used to indicate that the handle of the currently executing
\r
292 * task should be used in place of the parameter. This macro simply checks to
\r
293 * see if the parameter is NULL and returns a pointer to the appropriate TCB.
\r
295 #define prvGetTCBFromHandle( pxHandle ) ( ( pxHandle == NULL ) ? ( tskTCB * ) pxCurrentTCB : ( tskTCB * ) pxHandle )
\r
298 /* File private functions. --------------------------------*/
\r
301 * Utility to ready a TCB for a given task. Mainly just copies the parameters
\r
302 * into the TCB structure.
\r
304 static void prvInitialiseTCBVariables( tskTCB *pxTCB, const signed char * const pcName, unsigned portBASE_TYPE uxPriority, const xMemoryRegion * const xRegions, unsigned short usStackDepth ) PRIVILEGED_FUNCTION;
\r
307 * Utility to ready all the lists used by the scheduler. This is called
\r
308 * automatically upon the creation of the first task.
\r
310 static void prvInitialiseTaskLists( void ) PRIVILEGED_FUNCTION;
\r
313 * The idle task, which as all tasks is implemented as a never ending loop.
\r
314 * The idle task is automatically created and added to the ready lists upon
\r
315 * creation of the first user task.
\r
317 * The portTASK_FUNCTION_PROTO() macro is used to allow port/compiler specific
\r
318 * language extensions. The equivalent prototype for this function is:
\r
320 * void prvIdleTask( void *pvParameters );
\r
323 static portTASK_FUNCTION_PROTO( prvIdleTask, pvParameters );
\r
326 * Utility to free all memory allocated by the scheduler to hold a TCB,
\r
327 * including the stack pointed to by the TCB.
\r
329 * This does not free memory allocated by the task itself (i.e. memory
\r
330 * allocated by calls to pvPortMalloc from within the tasks application code).
\r
332 #if ( ( INCLUDE_vTaskDelete == 1 ) || ( INCLUDE_vTaskCleanUpResources == 1 ) )
\r
334 static void prvDeleteTCB( tskTCB *pxTCB ) PRIVILEGED_FUNCTION;
\r
339 * Used only by the idle task. This checks to see if anything has been placed
\r
340 * in the list of tasks waiting to be deleted. If so the task is cleaned up
\r
341 * and its TCB deleted.
\r
343 static void prvCheckTasksWaitingTermination( void ) PRIVILEGED_FUNCTION;
\r
346 * Allocates memory from the heap for a TCB and associated stack. Checks the
\r
347 * allocation was successful.
\r
349 static tskTCB *prvAllocateTCBAndStack( unsigned short usStackDepth, portSTACK_TYPE *puxStackBuffer ) PRIVILEGED_FUNCTION;
\r
352 * Called from vTaskList. vListTasks details all the tasks currently under
\r
353 * control of the scheduler. The tasks may be in one of a number of lists.
\r
354 * prvListTaskWithinSingleList accepts a list and details the tasks from
\r
355 * within just that list.
\r
357 * THIS FUNCTION IS INTENDED FOR DEBUGGING ONLY, AND SHOULD NOT BE CALLED FROM
\r
358 * NORMAL APPLICATION CODE.
\r
360 #if ( configUSE_TRACE_FACILITY == 1 )
\r
362 static void prvListTaskWithinSingleList( const signed char *pcWriteBuffer, xList *pxList, signed char cStatus ) PRIVILEGED_FUNCTION;
\r
367 * When a task is created, the stack of the task is filled with a known value.
\r
368 * This function determines the 'high water mark' of the task stack by
\r
369 * determining how much of the stack remains at the original preset value.
\r
371 #if ( ( configUSE_TRACE_FACILITY == 1 ) || ( INCLUDE_uxTaskGetStackHighWaterMark == 1 ) )
\r
373 static unsigned short usTaskCheckFreeStackSpace( const unsigned char * pucStackByte ) PRIVILEGED_FUNCTION;
\r
382 /*-----------------------------------------------------------
\r
383 * TASK CREATION API documented in task.h
\r
384 *----------------------------------------------------------*/
\r
386 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
388 signed portBASE_TYPE xReturn;
\r
391 /* Allocate the memory required by the TCB and stack for the new task,
\r
392 checking that the allocation was successful. */
\r
393 pxNewTCB = prvAllocateTCBAndStack( usStackDepth, puxStackBuffer );
\r
395 if( pxNewTCB != NULL )
\r
397 portSTACK_TYPE *pxTopOfStack;
\r
399 #if( portUSING_MPU_WRAPPERS == 1 )
\r
400 /* Should the task be created in privileged mode? */
\r
401 portBASE_TYPE xRunPrivileged;
\r
402 if( ( uxPriority & portPRIVILEGE_BIT ) != 0x00 )
\r
404 xRunPrivileged = pdTRUE;
\r
408 xRunPrivileged = pdFALSE;
\r
410 uxPriority &= ~portPRIVILEGE_BIT;
\r
411 #endif /* portUSING_MPU_WRAPPERS == 1 */
\r
413 /* Calculate the top of stack address. This depends on whether the
\r
414 stack grows from high memory to low (as per the 80x86) or visa versa.
\r
415 portSTACK_GROWTH is used to make the result positive or negative as
\r
416 required by the port. */
\r
417 #if( portSTACK_GROWTH < 0 )
\r
419 pxTopOfStack = pxNewTCB->pxStack + ( usStackDepth - 1 );
\r
420 pxTopOfStack = ( portSTACK_TYPE * ) ( ( ( unsigned long ) pxTopOfStack ) & ( ( unsigned long ) ~portBYTE_ALIGNMENT_MASK ) );
\r
424 pxTopOfStack = pxNewTCB->pxStack;
\r
426 /* If we want to use stack checking on architectures that use
\r
427 a positive stack growth direction then we also need to store the
\r
428 other extreme of the stack space. */
\r
429 pxNewTCB->pxEndOfStack = pxNewTCB->pxStack + ( usStackDepth - 1 );
\r
433 /* Setup the newly allocated TCB with the initial state of the task. */
\r
434 prvInitialiseTCBVariables( pxNewTCB, pcName, uxPriority, xRegions, usStackDepth );
\r
436 /* Initialize the TCB stack to look as if the task was already running,
\r
437 but had been interrupted by the scheduler. The return address is set
\r
438 to the start of the task function. Once the stack has been initialised
\r
439 the top of stack variable is updated. */
\r
440 #if( portUSING_MPU_WRAPPERS == 1 )
\r
442 pxNewTCB->pxTopOfStack = pxPortInitialiseStack( pxTopOfStack, pxTaskCode, pvParameters, xRunPrivileged );
\r
446 pxNewTCB->pxTopOfStack = pxPortInitialiseStack( pxTopOfStack, pxTaskCode, pvParameters );
\r
450 if( ( void * ) pxCreatedTask != NULL )
\r
452 /* Pass the TCB out - in an anonymous way. The calling function/
\r
453 task can use this as a handle to delete the task later if
\r
455 *pxCreatedTask = ( xTaskHandle ) pxNewTCB;
\r
458 /* We are going to manipulate the task queues to add this task to a
\r
459 ready list, so must make sure no interrupts occur. */
\r
460 portENTER_CRITICAL();
\r
462 uxCurrentNumberOfTasks++;
\r
463 if( pxCurrentTCB == NULL )
\r
465 /* There are no other tasks, or all the other tasks are in
\r
466 the suspended state - make this the current task. */
\r
467 pxCurrentTCB = pxNewTCB;
\r
469 if( uxCurrentNumberOfTasks == ( unsigned portBASE_TYPE ) 1 )
\r
471 /* This is the first task to be created so do the preliminary
\r
472 initialisation required. We will not recover if this call
\r
473 fails, but we will report the failure. */
\r
474 prvInitialiseTaskLists();
\r
479 /* If the scheduler is not already running, make this task the
\r
480 current task if it is the highest priority task to be created
\r
482 if( xSchedulerRunning == pdFALSE )
\r
484 if( pxCurrentTCB->uxPriority <= uxPriority )
\r
486 pxCurrentTCB = pxNewTCB;
\r
491 /* Remember the top priority to make context switching faster. Use
\r
492 the priority in pxNewTCB as this has been capped to a valid value. */
\r
493 if( pxNewTCB->uxPriority > uxTopUsedPriority )
\r
495 uxTopUsedPriority = pxNewTCB->uxPriority;
\r
498 #if ( configUSE_TRACE_FACILITY == 1 )
\r
500 /* Add a counter into the TCB for tracing only. */
\r
501 pxNewTCB->uxTCBNumber = uxTaskNumber;
\r
506 prvAddTaskToReadyQueue( pxNewTCB );
\r
509 traceTASK_CREATE( pxNewTCB );
\r
511 portEXIT_CRITICAL();
\r
515 xReturn = errCOULD_NOT_ALLOCATE_REQUIRED_MEMORY;
\r
516 traceTASK_CREATE_FAILED();
\r
519 if( xReturn == pdPASS )
\r
521 if( xSchedulerRunning != pdFALSE )
\r
523 /* If the created task is of a higher priority than the current task
\r
524 then it should run now. */
\r
525 if( pxCurrentTCB->uxPriority < uxPriority )
\r
527 portYIELD_WITHIN_API();
\r
534 /*-----------------------------------------------------------*/
\r
536 #if ( INCLUDE_vTaskDelete == 1 )
\r
538 void vTaskDelete( xTaskHandle pxTaskToDelete )
\r
542 portENTER_CRITICAL();
\r
544 /* Ensure a yield is performed if the current task is being
\r
546 if( pxTaskToDelete == pxCurrentTCB )
\r
548 pxTaskToDelete = NULL;
\r
551 /* If null is passed in here then we are deleting ourselves. */
\r
552 pxTCB = prvGetTCBFromHandle( pxTaskToDelete );
\r
554 /* Remove task from the ready list and place in the termination list.
\r
555 This will stop the task from be scheduled. The idle task will check
\r
556 the termination list and free up any memory allocated by the
\r
557 scheduler for the TCB and stack. */
\r
558 vListRemove( &( pxTCB->xGenericListItem ) );
\r
560 /* Is the task waiting on an event also? */
\r
561 if( pxTCB->xEventListItem.pvContainer )
\r
563 vListRemove( &( pxTCB->xEventListItem ) );
\r
566 vListInsertEnd( ( xList * ) &xTasksWaitingTermination, &( pxTCB->xGenericListItem ) );
\r
568 /* Increment the ucTasksDeleted variable so the idle task knows
\r
569 there is a task that has been deleted and that it should therefore
\r
570 check the xTasksWaitingTermination list. */
\r
573 /* Increment the uxTaskNumberVariable also so kernel aware debuggers
\r
574 can detect that the task lists need re-generating. */
\r
577 traceTASK_DELETE( pxTCB );
\r
579 portEXIT_CRITICAL();
\r
581 /* Force a reschedule if we have just deleted the current task. */
\r
582 if( xSchedulerRunning != pdFALSE )
\r
584 if( ( void * ) pxTaskToDelete == NULL )
\r
586 portYIELD_WITHIN_API();
\r
598 /*-----------------------------------------------------------
\r
599 * TASK CONTROL API documented in task.h
\r
600 *----------------------------------------------------------*/
\r
602 #if ( INCLUDE_vTaskDelayUntil == 1 )
\r
604 void vTaskDelayUntil( portTickType * const pxPreviousWakeTime, portTickType xTimeIncrement )
\r
606 portTickType xTimeToWake;
\r
607 portBASE_TYPE xAlreadyYielded, xShouldDelay = pdFALSE;
\r
611 /* Generate the tick time at which the task wants to wake. */
\r
612 xTimeToWake = *pxPreviousWakeTime + xTimeIncrement;
\r
614 if( xTickCount < *pxPreviousWakeTime )
\r
616 /* The tick count has overflowed since this function was
\r
617 lasted called. In this case the only time we should ever
\r
618 actually delay is if the wake time has also overflowed,
\r
619 and the wake time is greater than the tick time. When this
\r
620 is the case it is as if neither time had overflowed. */
\r
621 if( ( xTimeToWake < *pxPreviousWakeTime ) && ( xTimeToWake > xTickCount ) )
\r
623 xShouldDelay = pdTRUE;
\r
628 /* The tick time has not overflowed. In this case we will
\r
629 delay if either the wake time has overflowed, and/or the
\r
630 tick time is less than the wake time. */
\r
631 if( ( xTimeToWake < *pxPreviousWakeTime ) || ( xTimeToWake > xTickCount ) )
\r
633 xShouldDelay = pdTRUE;
\r
637 /* Update the wake time ready for the next call. */
\r
638 *pxPreviousWakeTime = xTimeToWake;
\r
642 traceTASK_DELAY_UNTIL();
\r
644 /* We must remove ourselves from the ready list before adding
\r
645 ourselves to the blocked list as the same list item is used for
\r
647 vListRemove( ( xListItem * ) &( pxCurrentTCB->xGenericListItem ) );
\r
649 /* The list item will be inserted in wake time order. */
\r
650 listSET_LIST_ITEM_VALUE( &( pxCurrentTCB->xGenericListItem ), xTimeToWake );
\r
652 if( xTimeToWake < xTickCount )
\r
654 /* Wake time has overflowed. Place this item in the
\r
656 vListInsert( ( xList * ) pxOverflowDelayedTaskList, ( xListItem * ) &( pxCurrentTCB->xGenericListItem ) );
\r
660 /* The wake time has not overflowed, so we can use the
\r
661 current block list. */
\r
662 vListInsert( ( xList * ) pxDelayedTaskList, ( xListItem * ) &( pxCurrentTCB->xGenericListItem ) );
\r
666 xAlreadyYielded = xTaskResumeAll();
\r
668 /* Force a reschedule if xTaskResumeAll has not already done so, we may
\r
669 have put ourselves to sleep. */
\r
670 if( !xAlreadyYielded )
\r
672 portYIELD_WITHIN_API();
\r
677 /*-----------------------------------------------------------*/
\r
679 #if ( INCLUDE_vTaskDelay == 1 )
\r
681 void vTaskDelay( portTickType xTicksToDelay )
\r
683 portTickType xTimeToWake;
\r
684 signed portBASE_TYPE xAlreadyYielded = pdFALSE;
\r
686 /* A delay time of zero just forces a reschedule. */
\r
687 if( xTicksToDelay > ( portTickType ) 0 )
\r
693 /* A task that is removed from the event list while the
\r
694 scheduler is suspended will not get placed in the ready
\r
695 list or removed from the blocked list until the scheduler
\r
698 This task cannot be in an event list as it is the currently
\r
701 /* Calculate the time to wake - this may overflow but this is
\r
703 xTimeToWake = xTickCount + xTicksToDelay;
\r
705 /* We must remove ourselves from the ready list before adding
\r
706 ourselves to the blocked list as the same list item is used for
\r
708 vListRemove( ( xListItem * ) &( pxCurrentTCB->xGenericListItem ) );
\r
710 /* The list item will be inserted in wake time order. */
\r
711 listSET_LIST_ITEM_VALUE( &( pxCurrentTCB->xGenericListItem ), xTimeToWake );
\r
713 if( xTimeToWake < xTickCount )
\r
715 /* Wake time has overflowed. Place this item in the
\r
717 vListInsert( ( xList * ) pxOverflowDelayedTaskList, ( xListItem * ) &( pxCurrentTCB->xGenericListItem ) );
\r
721 /* The wake time has not overflowed, so we can use the
\r
722 current block list. */
\r
723 vListInsert( ( xList * ) pxDelayedTaskList, ( xListItem * ) &( pxCurrentTCB->xGenericListItem ) );
\r
726 xAlreadyYielded = xTaskResumeAll();
\r
729 /* Force a reschedule if xTaskResumeAll has not already done so, we may
\r
730 have put ourselves to sleep. */
\r
731 if( !xAlreadyYielded )
\r
733 portYIELD_WITHIN_API();
\r
738 /*-----------------------------------------------------------*/
\r
740 #if ( INCLUDE_uxTaskPriorityGet == 1 )
\r
742 unsigned portBASE_TYPE uxTaskPriorityGet( xTaskHandle pxTask )
\r
745 unsigned portBASE_TYPE uxReturn;
\r
747 portENTER_CRITICAL();
\r
749 /* If null is passed in here then we are changing the
\r
750 priority of the calling function. */
\r
751 pxTCB = prvGetTCBFromHandle( pxTask );
\r
752 uxReturn = pxTCB->uxPriority;
\r
754 portEXIT_CRITICAL();
\r
760 /*-----------------------------------------------------------*/
\r
762 #if ( INCLUDE_vTaskPrioritySet == 1 )
\r
764 void vTaskPrioritySet( xTaskHandle pxTask, unsigned portBASE_TYPE uxNewPriority )
\r
767 unsigned portBASE_TYPE uxCurrentPriority, xYieldRequired = pdFALSE;
\r
769 /* Ensure the new priority is valid. */
\r
770 if( uxNewPriority >= configMAX_PRIORITIES )
\r
772 uxNewPriority = configMAX_PRIORITIES - 1;
\r
775 portENTER_CRITICAL();
\r
777 if( pxTask == pxCurrentTCB )
\r
782 /* If null is passed in here then we are changing the
\r
783 priority of the calling function. */
\r
784 pxTCB = prvGetTCBFromHandle( pxTask );
\r
786 traceTASK_PRIORITY_SET( pxTask, uxNewPriority );
\r
788 #if ( configUSE_MUTEXES == 1 )
\r
790 uxCurrentPriority = pxTCB->uxBasePriority;
\r
794 uxCurrentPriority = pxTCB->uxPriority;
\r
798 if( uxCurrentPriority != uxNewPriority )
\r
800 /* The priority change may have readied a task of higher
\r
801 priority than the calling task. */
\r
802 if( uxNewPriority > uxCurrentPriority )
\r
804 if( pxTask != NULL )
\r
806 /* The priority of another task is being raised. If we
\r
807 were raising the priority of the currently running task
\r
808 there would be no need to switch as it must have already
\r
809 been the highest priority task. */
\r
810 xYieldRequired = pdTRUE;
\r
813 else if( pxTask == NULL )
\r
815 /* Setting our own priority down means there may now be another
\r
816 task of higher priority that is ready to execute. */
\r
817 xYieldRequired = pdTRUE;
\r
822 #if ( configUSE_MUTEXES == 1 )
\r
824 /* Only change the priority being used if the task is not
\r
825 currently using an inherited priority. */
\r
826 if( pxTCB->uxBasePriority == pxTCB->uxPriority )
\r
828 pxTCB->uxPriority = uxNewPriority;
\r
831 /* The base priority gets set whatever. */
\r
832 pxTCB->uxBasePriority = uxNewPriority;
\r
836 pxTCB->uxPriority = uxNewPriority;
\r
840 listSET_LIST_ITEM_VALUE( &( pxTCB->xEventListItem ), ( configMAX_PRIORITIES - ( portTickType ) uxNewPriority ) );
\r
842 /* If the task is in the blocked or suspended list we need do
\r
843 nothing more than change it's priority variable. However, if
\r
844 the task is in a ready list it needs to be removed and placed
\r
845 in the queue appropriate to its new priority. */
\r
846 if( listIS_CONTAINED_WITHIN( &( pxReadyTasksLists[ uxCurrentPriority ] ), &( pxTCB->xGenericListItem ) ) )
\r
848 /* The task is currently in its ready list - remove before adding
\r
849 it to it's new ready list. As we are in a critical section we
\r
850 can do this even if the scheduler is suspended. */
\r
851 vListRemove( &( pxTCB->xGenericListItem ) );
\r
852 prvAddTaskToReadyQueue( pxTCB );
\r
855 if( xYieldRequired == pdTRUE )
\r
857 portYIELD_WITHIN_API();
\r
861 portEXIT_CRITICAL();
\r
865 /*-----------------------------------------------------------*/
\r
867 #if ( INCLUDE_vTaskSuspend == 1 )
\r
869 void vTaskSuspend( xTaskHandle pxTaskToSuspend )
\r
873 portENTER_CRITICAL();
\r
875 /* Ensure a yield is performed if the current task is being
\r
877 if( pxTaskToSuspend == pxCurrentTCB )
\r
879 pxTaskToSuspend = NULL;
\r
882 /* If null is passed in here then we are suspending ourselves. */
\r
883 pxTCB = prvGetTCBFromHandle( pxTaskToSuspend );
\r
885 traceTASK_SUSPEND( pxTCB );
\r
887 /* Remove task from the ready/delayed list and place in the suspended list. */
\r
888 vListRemove( &( pxTCB->xGenericListItem ) );
\r
890 /* Is the task waiting on an event also? */
\r
891 if( pxTCB->xEventListItem.pvContainer )
\r
893 vListRemove( &( pxTCB->xEventListItem ) );
\r
896 vListInsertEnd( ( xList * ) &xSuspendedTaskList, &( pxTCB->xGenericListItem ) );
\r
898 portEXIT_CRITICAL();
\r
900 if( ( void * ) pxTaskToSuspend == NULL )
\r
902 if( xSchedulerRunning != pdFALSE )
\r
904 /* We have just suspended the current task. */
\r
905 portYIELD_WITHIN_API();
\r
909 /* The scheduler is not running, but the task that was pointed
\r
910 to by pxCurrentTCB has just been suspended and pxCurrentTCB
\r
911 must be adjusted to point to a different task. */
\r
912 if( uxCurrentNumberOfTasks == 1 )
\r
914 /* No other tasks are defined, so set pxCurrentTCB back to
\r
915 NULL so when the next task is created pxCurrentTCB will
\r
916 be set to point to it no matter what its relative priority
\r
918 pxCurrentTCB = NULL;
\r
922 vTaskSwitchContext();
\r
929 /*-----------------------------------------------------------*/
\r
931 #if ( INCLUDE_vTaskSuspend == 1 )
\r
933 signed portBASE_TYPE xTaskIsTaskSuspended( xTaskHandle xTask )
\r
935 portBASE_TYPE xReturn = pdFALSE;
\r
936 const tskTCB * const pxTCB = ( tskTCB * ) xTask;
\r
938 /* Is the task we are attempting to resume actually in the
\r
940 if( listIS_CONTAINED_WITHIN( &xSuspendedTaskList, &( pxTCB->xGenericListItem ) ) != pdFALSE )
\r
942 /* Has the task already been resumed from within an ISR? */
\r
943 if( listIS_CONTAINED_WITHIN( &xPendingReadyList, &( pxTCB->xEventListItem ) ) != pdTRUE )
\r
945 /* Is it in the suspended list because it is in the
\r
946 Suspended state? It is possible to be in the suspended
\r
947 list because it is blocked on a task with no timeout
\r
949 if( listIS_CONTAINED_WITHIN( NULL, &( pxTCB->xEventListItem ) ) == pdTRUE )
\r
960 /*-----------------------------------------------------------*/
\r
962 #if ( INCLUDE_vTaskSuspend == 1 )
\r
964 void vTaskResume( xTaskHandle pxTaskToResume )
\r
968 /* Remove the task from whichever list it is currently in, and place
\r
969 it in the ready list. */
\r
970 pxTCB = ( tskTCB * ) pxTaskToResume;
\r
972 /* The parameter cannot be NULL as it is impossible to resume the
\r
973 currently executing task. */
\r
974 if( ( pxTCB != NULL ) && ( pxTCB != pxCurrentTCB ) )
\r
976 portENTER_CRITICAL();
\r
978 if( xTaskIsTaskSuspended( pxTCB ) == pdTRUE )
\r
980 traceTASK_RESUME( pxTCB );
\r
982 /* As we are in a critical section we can access the ready
\r
983 lists even if the scheduler is suspended. */
\r
984 vListRemove( &( pxTCB->xGenericListItem ) );
\r
985 prvAddTaskToReadyQueue( pxTCB );
\r
987 /* We may have just resumed a higher priority task. */
\r
988 if( pxTCB->uxPriority >= pxCurrentTCB->uxPriority )
\r
990 /* This yield may not cause the task just resumed to run, but
\r
991 will leave the lists in the correct state for the next yield. */
\r
992 portYIELD_WITHIN_API();
\r
996 portEXIT_CRITICAL();
\r
1002 /*-----------------------------------------------------------*/
\r
1004 #if ( ( INCLUDE_xTaskResumeFromISR == 1 ) && ( INCLUDE_vTaskSuspend == 1 ) )
\r
1006 portBASE_TYPE xTaskResumeFromISR( xTaskHandle pxTaskToResume )
\r
1008 portBASE_TYPE xYieldRequired = pdFALSE;
\r
1011 pxTCB = ( tskTCB * ) pxTaskToResume;
\r
1013 if( xTaskIsTaskSuspended( pxTCB ) == pdTRUE )
\r
1015 traceTASK_RESUME_FROM_ISR( pxTCB );
\r
1017 if( uxSchedulerSuspended == ( unsigned portBASE_TYPE ) pdFALSE )
\r
1019 xYieldRequired = ( pxTCB->uxPriority >= pxCurrentTCB->uxPriority );
\r
1020 vListRemove( &( pxTCB->xGenericListItem ) );
\r
1021 prvAddTaskToReadyQueue( pxTCB );
\r
1025 /* We cannot access the delayed or ready lists, so will hold this
\r
1026 task pending until the scheduler is resumed, at which point a
\r
1027 yield will be performed if necessary. */
\r
1028 vListInsertEnd( ( xList * ) &( xPendingReadyList ), &( pxTCB->xEventListItem ) );
\r
1032 return xYieldRequired;
\r
1040 /*-----------------------------------------------------------
\r
1041 * PUBLIC SCHEDULER CONTROL documented in task.h
\r
1042 *----------------------------------------------------------*/
\r
1045 void vTaskStartScheduler( void )
\r
1047 portBASE_TYPE xReturn;
\r
1049 /* Add the idle task at the lowest priority. */
\r
1050 xReturn = xTaskCreate( prvIdleTask, ( signed char * ) "IDLE", tskIDLE_STACK_SIZE, ( void * ) NULL, ( tskIDLE_PRIORITY | portPRIVILEGE_BIT ), ( xTaskHandle * ) NULL );
\r
1052 if( xReturn == pdPASS )
\r
1054 /* Interrupts are turned off here, to ensure a tick does not occur
\r
1055 before or during the call to xPortStartScheduler(). The stacks of
\r
1056 the created tasks contain a status word with interrupts switched on
\r
1057 so interrupts will automatically get re-enabled when the first task
\r
1060 STEPPING THROUGH HERE USING A DEBUGGER CAN CAUSE BIG PROBLEMS IF THE
\r
1061 DEBUGGER ALLOWS INTERRUPTS TO BE PROCESSED. */
\r
1062 portDISABLE_INTERRUPTS();
\r
1064 xSchedulerRunning = pdTRUE;
\r
1065 xTickCount = ( portTickType ) 0;
\r
1067 /* If configGENERATE_RUN_TIME_STATS is defined then the following
\r
1068 macro must be defined to configure the timer/counter used to generate
\r
1069 the run time counter time base. */
\r
1070 portCONFIGURE_TIMER_FOR_RUN_TIME_STATS();
\r
1072 /* Setting up the timer tick is hardware specific and thus in the
\r
1073 portable interface. */
\r
1074 if( xPortStartScheduler() )
\r
1076 /* Should not reach here as if the scheduler is running the
\r
1077 function will not return. */
\r
1081 /* Should only reach here if a task calls xTaskEndScheduler(). */
\r
1085 /*-----------------------------------------------------------*/
\r
1087 void vTaskEndScheduler( void )
\r
1089 /* Stop the scheduler interrupts and call the portable scheduler end
\r
1090 routine so the original ISRs can be restored if necessary. The port
\r
1091 layer must ensure interrupts enable bit is left in the correct state. */
\r
1092 portDISABLE_INTERRUPTS();
\r
1093 xSchedulerRunning = pdFALSE;
\r
1094 vPortEndScheduler();
\r
1096 /*----------------------------------------------------------*/
\r
1098 void vTaskSuspendAll( void )
\r
1100 /* A critical section is not required as the variable is of type
\r
1102 ++uxSchedulerSuspended;
\r
1104 /*----------------------------------------------------------*/
\r
1106 signed portBASE_TYPE xTaskResumeAll( void )
\r
1108 register tskTCB *pxTCB;
\r
1109 signed portBASE_TYPE xAlreadyYielded = pdFALSE;
\r
1111 /* It is possible that an ISR caused a task to be removed from an event
\r
1112 list while the scheduler was suspended. If this was the case then the
\r
1113 removed task will have been added to the xPendingReadyList. Once the
\r
1114 scheduler has been resumed it is safe to move all the pending ready
\r
1115 tasks from this list into their appropriate ready list. */
\r
1116 portENTER_CRITICAL();
\r
1118 --uxSchedulerSuspended;
\r
1120 if( uxSchedulerSuspended == ( unsigned portBASE_TYPE ) pdFALSE )
\r
1122 if( uxCurrentNumberOfTasks > ( unsigned portBASE_TYPE ) 0 )
\r
1124 portBASE_TYPE xYieldRequired = pdFALSE;
\r
1126 /* Move any readied tasks from the pending list into the
\r
1127 appropriate ready list. */
\r
1128 while( ( pxTCB = ( tskTCB * ) listGET_OWNER_OF_HEAD_ENTRY( ( ( xList * ) &xPendingReadyList ) ) ) != NULL )
\r
1130 vListRemove( &( pxTCB->xEventListItem ) );
\r
1131 vListRemove( &( pxTCB->xGenericListItem ) );
\r
1132 prvAddTaskToReadyQueue( pxTCB );
\r
1134 /* If we have moved a task that has a priority higher than
\r
1135 the current task then we should yield. */
\r
1136 if( pxTCB->uxPriority >= pxCurrentTCB->uxPriority )
\r
1138 xYieldRequired = pdTRUE;
\r
1142 /* If any ticks occurred while the scheduler was suspended then
\r
1143 they should be processed now. This ensures the tick count does not
\r
1144 slip, and that any delayed tasks are resumed at the correct time. */
\r
1145 if( uxMissedTicks > ( unsigned portBASE_TYPE ) 0 )
\r
1147 while( uxMissedTicks > ( unsigned portBASE_TYPE ) 0 )
\r
1149 vTaskIncrementTick();
\r
1153 /* As we have processed some ticks it is appropriate to yield
\r
1154 to ensure the highest priority task that is ready to run is
\r
1155 the task actually running. */
\r
1156 #if configUSE_PREEMPTION == 1
\r
1158 xYieldRequired = pdTRUE;
\r
1163 if( ( xYieldRequired == pdTRUE ) || ( xMissedYield == pdTRUE ) )
\r
1165 xAlreadyYielded = pdTRUE;
\r
1166 xMissedYield = pdFALSE;
\r
1167 portYIELD_WITHIN_API();
\r
1172 portEXIT_CRITICAL();
\r
1174 return xAlreadyYielded;
\r
1182 /*-----------------------------------------------------------
\r
1183 * PUBLIC TASK UTILITIES documented in task.h
\r
1184 *----------------------------------------------------------*/
\r
1188 portTickType xTaskGetTickCount( void )
\r
1190 portTickType xTicks;
\r
1192 /* Critical section required if running on a 16 bit processor. */
\r
1193 portENTER_CRITICAL();
\r
1195 xTicks = xTickCount;
\r
1197 portEXIT_CRITICAL();
\r
1201 /*-----------------------------------------------------------*/
\r
1203 portTickType xTaskGetTickCountFromISR( void )
\r
1205 return xTickCount;
\r
1207 /*-----------------------------------------------------------*/
\r
1209 unsigned portBASE_TYPE uxTaskGetNumberOfTasks( void )
\r
1211 /* A critical section is not required because the variables are of type
\r
1213 return uxCurrentNumberOfTasks;
\r
1215 /*-----------------------------------------------------------*/
\r
1217 #if ( configUSE_TRACE_FACILITY == 1 )
\r
1219 void vTaskList( signed char *pcWriteBuffer )
\r
1221 unsigned portBASE_TYPE uxQueue;
\r
1223 /* This is a VERY costly function that should be used for debug only.
\r
1224 It leaves interrupts disabled for a LONG time. */
\r
1226 vTaskSuspendAll();
\r
1228 /* Run through all the lists that could potentially contain a TCB and
\r
1229 report the task name, state and stack high water mark. */
\r
1231 pcWriteBuffer[ 0 ] = ( signed char ) 0x00;
\r
1232 strcat( ( char * ) pcWriteBuffer, ( const char * ) "\r\n" );
\r
1234 uxQueue = uxTopUsedPriority + 1;
\r
1240 if( !listLIST_IS_EMPTY( &( pxReadyTasksLists[ uxQueue ] ) ) )
\r
1242 prvListTaskWithinSingleList( pcWriteBuffer, ( xList * ) &( pxReadyTasksLists[ uxQueue ] ), tskREADY_CHAR );
\r
1244 }while( uxQueue > ( unsigned short ) tskIDLE_PRIORITY );
\r
1246 if( !listLIST_IS_EMPTY( pxDelayedTaskList ) )
\r
1248 prvListTaskWithinSingleList( pcWriteBuffer, ( xList * ) pxDelayedTaskList, tskBLOCKED_CHAR );
\r
1251 if( !listLIST_IS_EMPTY( pxOverflowDelayedTaskList ) )
\r
1253 prvListTaskWithinSingleList( pcWriteBuffer, ( xList * ) pxOverflowDelayedTaskList, tskBLOCKED_CHAR );
\r
1256 #if( INCLUDE_vTaskDelete == 1 )
\r
1258 if( !listLIST_IS_EMPTY( &xTasksWaitingTermination ) )
\r
1260 prvListTaskWithinSingleList( pcWriteBuffer, ( xList * ) &xTasksWaitingTermination, tskDELETED_CHAR );
\r
1265 #if ( INCLUDE_vTaskSuspend == 1 )
\r
1267 if( !listLIST_IS_EMPTY( &xSuspendedTaskList ) )
\r
1269 prvListTaskWithinSingleList( pcWriteBuffer, ( xList * ) &xSuspendedTaskList, tskSUSPENDED_CHAR );
\r
1278 /*----------------------------------------------------------*/
\r
1280 #if ( configGENERATE_RUN_TIME_STATS == 1 )
\r
1282 void vTaskGetRunTimeStats( signed char *pcWriteBuffer )
\r
1284 unsigned portBASE_TYPE uxQueue;
\r
1285 unsigned long ulTotalRunTime;
\r
1287 /* This is a VERY costly function that should be used for debug only.
\r
1288 It leaves interrupts disabled for a LONG time. */
\r
1290 vTaskSuspendAll();
\r
1292 #ifdef portALT_GET_RUN_TIME_COUNTER_VALUE
\r
1293 portALT_GET_RUN_TIME_COUNTER_VALUE( ulTotalRunTime );
\r
1295 ulTotalRunTime = portGET_RUN_TIME_COUNTER_VALUE();
\r
1298 /* Run through all the lists that could potentially contain a TCB,
\r
1299 generating a table of run timer percentages in the provided
\r
1302 pcWriteBuffer[ 0 ] = ( signed char ) 0x00;
\r
1303 strcat( ( char * ) pcWriteBuffer, ( const char * ) "\r\n" );
\r
1305 uxQueue = uxTopUsedPriority + 1;
\r
1311 if( !listLIST_IS_EMPTY( &( pxReadyTasksLists[ uxQueue ] ) ) )
\r
1313 prvGenerateRunTimeStatsForTasksInList( pcWriteBuffer, ( xList * ) &( pxReadyTasksLists[ uxQueue ] ), ulTotalRunTime );
\r
1315 }while( uxQueue > ( unsigned short ) tskIDLE_PRIORITY );
\r
1317 if( !listLIST_IS_EMPTY( pxDelayedTaskList ) )
\r
1319 prvGenerateRunTimeStatsForTasksInList( pcWriteBuffer, ( xList * ) pxDelayedTaskList, ulTotalRunTime );
\r
1322 if( !listLIST_IS_EMPTY( pxOverflowDelayedTaskList ) )
\r
1324 prvGenerateRunTimeStatsForTasksInList( pcWriteBuffer, ( xList * ) pxOverflowDelayedTaskList, ulTotalRunTime );
\r
1327 #if ( INCLUDE_vTaskDelete == 1 )
\r
1329 if( !listLIST_IS_EMPTY( &xTasksWaitingTermination ) )
\r
1331 prvGenerateRunTimeStatsForTasksInList( pcWriteBuffer, ( xList * ) &xTasksWaitingTermination, ulTotalRunTime );
\r
1336 #if ( INCLUDE_vTaskSuspend == 1 )
\r
1338 if( !listLIST_IS_EMPTY( &xSuspendedTaskList ) )
\r
1340 prvGenerateRunTimeStatsForTasksInList( pcWriteBuffer, ( xList * ) &xSuspendedTaskList, ulTotalRunTime );
\r
1349 /*----------------------------------------------------------*/
\r
1351 #if ( configUSE_TRACE_FACILITY == 1 )
\r
1353 void vTaskStartTrace( signed char * pcBuffer, unsigned long ulBufferSize )
\r
1355 portENTER_CRITICAL();
\r
1357 pcTraceBuffer = ( signed char * )pcBuffer;
\r
1358 pcTraceBufferStart = pcBuffer;
\r
1359 pcTraceBufferEnd = pcBuffer + ( ulBufferSize - tskSIZE_OF_EACH_TRACE_LINE );
\r
1360 xTracing = pdTRUE;
\r
1362 portEXIT_CRITICAL();
\r
1366 /*----------------------------------------------------------*/
\r
1368 #if ( configUSE_TRACE_FACILITY == 1 )
\r
1370 unsigned long ulTaskEndTrace( void )
\r
1372 unsigned long ulBufferLength;
\r
1374 portENTER_CRITICAL();
\r
1375 xTracing = pdFALSE;
\r
1376 portEXIT_CRITICAL();
\r
1378 ulBufferLength = ( unsigned long ) ( pcTraceBuffer - pcTraceBufferStart );
\r
1380 return ulBufferLength;
\r
1387 /*-----------------------------------------------------------
\r
1388 * SCHEDULER INTERNALS AVAILABLE FOR PORTING PURPOSES
\r
1389 * documented in task.h
\r
1390 *----------------------------------------------------------*/
\r
1393 void vTaskIncrementTick( void )
\r
1395 /* Called by the portable layer each time a tick interrupt occurs.
\r
1396 Increments the tick then checks to see if the new tick value will cause any
\r
1397 tasks to be unblocked. */
\r
1398 if( uxSchedulerSuspended == ( unsigned portBASE_TYPE ) pdFALSE )
\r
1401 if( xTickCount == ( portTickType ) 0 )
\r
1405 /* Tick count has overflowed so we need to swap the delay lists.
\r
1406 If there are any items in pxDelayedTaskList here then there is
\r
1408 pxTemp = pxDelayedTaskList;
\r
1409 pxDelayedTaskList = pxOverflowDelayedTaskList;
\r
1410 pxOverflowDelayedTaskList = pxTemp;
\r
1411 xNumOfOverflows++;
\r
1414 /* See if this tick has made a timeout expire. */
\r
1415 prvCheckDelayedTasks();
\r
1421 /* The tick hook gets called at regular intervals, even if the
\r
1422 scheduler is locked. */
\r
1423 #if ( configUSE_TICK_HOOK == 1 )
\r
1425 extern void vApplicationTickHook( void );
\r
1427 vApplicationTickHook();
\r
1432 #if ( configUSE_TICK_HOOK == 1 )
\r
1434 extern void vApplicationTickHook( void );
\r
1436 /* Guard against the tick hook being called when the missed tick
\r
1437 count is being unwound (when the scheduler is being unlocked. */
\r
1438 if( uxMissedTicks == 0 )
\r
1440 vApplicationTickHook();
\r
1445 traceTASK_INCREMENT_TICK( xTickCount );
\r
1447 /*-----------------------------------------------------------*/
\r
1449 #if ( ( INCLUDE_vTaskCleanUpResources == 1 ) && ( INCLUDE_vTaskSuspend == 1 ) )
\r
1451 void vTaskCleanUpResources( void )
\r
1453 unsigned short usQueue;
\r
1454 volatile tskTCB *pxTCB;
\r
1456 usQueue = ( unsigned short ) uxTopUsedPriority + ( unsigned short ) 1;
\r
1458 /* Remove any TCB's from the ready queues. */
\r
1463 while( !listLIST_IS_EMPTY( &( pxReadyTasksLists[ usQueue ] ) ) )
\r
1465 listGET_OWNER_OF_NEXT_ENTRY( pxTCB, &( pxReadyTasksLists[ usQueue ] ) );
\r
1466 vListRemove( ( xListItem * ) &( pxTCB->xGenericListItem ) );
\r
1468 prvDeleteTCB( ( tskTCB * ) pxTCB );
\r
1470 }while( usQueue > ( unsigned short ) tskIDLE_PRIORITY );
\r
1472 /* Remove any TCB's from the delayed queue. */
\r
1473 while( !listLIST_IS_EMPTY( &xDelayedTaskList1 ) )
\r
1475 listGET_OWNER_OF_NEXT_ENTRY( pxTCB, &xDelayedTaskList1 );
\r
1476 vListRemove( ( xListItem * ) &( pxTCB->xGenericListItem ) );
\r
1478 prvDeleteTCB( ( tskTCB * ) pxTCB );
\r
1481 /* Remove any TCB's from the overflow delayed queue. */
\r
1482 while( !listLIST_IS_EMPTY( &xDelayedTaskList2 ) )
\r
1484 listGET_OWNER_OF_NEXT_ENTRY( pxTCB, &xDelayedTaskList2 );
\r
1485 vListRemove( ( xListItem * ) &( pxTCB->xGenericListItem ) );
\r
1487 prvDeleteTCB( ( tskTCB * ) pxTCB );
\r
1490 while( !listLIST_IS_EMPTY( &xSuspendedTaskList ) )
\r
1492 listGET_OWNER_OF_NEXT_ENTRY( pxTCB, &xSuspendedTaskList );
\r
1493 vListRemove( ( xListItem * ) &( pxTCB->xGenericListItem ) );
\r
1495 prvDeleteTCB( ( tskTCB * ) pxTCB );
\r
1500 /*-----------------------------------------------------------*/
\r
1502 #if ( configUSE_APPLICATION_TASK_TAG == 1 )
\r
1504 void vTaskSetApplicationTaskTag( xTaskHandle xTask, pdTASK_HOOK_CODE pxTagValue )
\r
1508 /* If xTask is NULL then we are setting our own task hook. */
\r
1509 if( xTask == NULL )
\r
1511 xTCB = ( tskTCB * ) pxCurrentTCB;
\r
1515 xTCB = ( tskTCB * ) xTask;
\r
1518 /* Save the hook function in the TCB. A critical section is required as
\r
1519 the value can be accessed from an interrupt. */
\r
1520 portENTER_CRITICAL();
\r
1521 xTCB->pxTaskTag = pxTagValue;
\r
1522 portEXIT_CRITICAL();
\r
1526 /*-----------------------------------------------------------*/
\r
1528 #if ( configUSE_APPLICATION_TASK_TAG == 1 )
\r
1530 pdTASK_HOOK_CODE xTaskGetApplicationTaskTag( xTaskHandle xTask )
\r
1533 pdTASK_HOOK_CODE xReturn;
\r
1535 /* If xTask is NULL then we are setting our own task hook. */
\r
1536 if( xTask == NULL )
\r
1538 xTCB = ( tskTCB * ) pxCurrentTCB;
\r
1542 xTCB = ( tskTCB * ) xTask;
\r
1545 /* Save the hook function in the TCB. A critical section is required as
\r
1546 the value can be accessed from an interrupt. */
\r
1547 portENTER_CRITICAL();
\r
1548 xReturn = xTCB->pxTaskTag;
\r
1549 portEXIT_CRITICAL();
\r
1555 /*-----------------------------------------------------------*/
\r
1557 #if ( configUSE_APPLICATION_TASK_TAG == 1 )
\r
1559 portBASE_TYPE xTaskCallApplicationTaskHook( xTaskHandle xTask, void *pvParameter )
\r
1562 portBASE_TYPE xReturn;
\r
1564 /* If xTask is NULL then we are calling our own task hook. */
\r
1565 if( xTask == NULL )
\r
1567 xTCB = ( tskTCB * ) pxCurrentTCB;
\r
1571 xTCB = ( tskTCB * ) xTask;
\r
1574 if( xTCB->pxTaskTag != NULL )
\r
1576 xReturn = xTCB->pxTaskTag( pvParameter );
\r
1587 /*-----------------------------------------------------------*/
\r
1589 void vTaskSwitchContext( void )
\r
1591 if( uxSchedulerSuspended != ( unsigned portBASE_TYPE ) pdFALSE )
\r
1593 /* The scheduler is currently suspended - do not allow a context
\r
1595 xMissedYield = pdTRUE;
\r
1599 traceTASK_SWITCHED_OUT();
\r
1601 #if ( configGENERATE_RUN_TIME_STATS == 1 )
\r
1603 unsigned long ulTempCounter;
\r
1605 #ifdef portALT_GET_RUN_TIME_COUNTER_VALUE
\r
1606 portALT_GET_RUN_TIME_COUNTER_VALUE( ulTempCounter );
\r
1608 ulTempCounter = portGET_RUN_TIME_COUNTER_VALUE();
\r
1611 /* Add the amount of time the task has been running to the accumulated
\r
1612 time so far. The time the task started running was stored in
\r
1613 ulTaskSwitchedInTime. Note that there is no overflow protection here
\r
1614 so count values are only valid until the timer overflows. Generally
\r
1615 this will be about 1 hour assuming a 1uS timer increment. */
\r
1616 pxCurrentTCB->ulRunTimeCounter += ( ulTempCounter - ulTaskSwitchedInTime );
\r
1617 ulTaskSwitchedInTime = ulTempCounter;
\r
1621 taskFIRST_CHECK_FOR_STACK_OVERFLOW();
\r
1622 taskSECOND_CHECK_FOR_STACK_OVERFLOW();
\r
1624 /* Find the highest priority queue that contains ready tasks. */
\r
1625 while( listLIST_IS_EMPTY( &( pxReadyTasksLists[ uxTopReadyPriority ] ) ) )
\r
1627 --uxTopReadyPriority;
\r
1630 /* listGET_OWNER_OF_NEXT_ENTRY walks through the list, so the tasks of the
\r
1631 same priority get an equal share of the processor time. */
\r
1632 listGET_OWNER_OF_NEXT_ENTRY( pxCurrentTCB, &( pxReadyTasksLists[ uxTopReadyPriority ] ) );
\r
1634 traceTASK_SWITCHED_IN();
\r
1635 vWriteTraceToBuffer();
\r
1637 /*-----------------------------------------------------------*/
\r
1639 void vTaskPlaceOnEventList( const xList * const pxEventList, portTickType xTicksToWait )
\r
1641 portTickType xTimeToWake;
\r
1643 /* THIS FUNCTION MUST BE CALLED WITH INTERRUPTS DISABLED OR THE
\r
1644 SCHEDULER SUSPENDED. */
\r
1646 /* Place the event list item of the TCB in the appropriate event list.
\r
1647 This is placed in the list in priority order so the highest priority task
\r
1648 is the first to be woken by the event. */
\r
1649 vListInsert( ( xList * ) pxEventList, ( xListItem * ) &( pxCurrentTCB->xEventListItem ) );
\r
1651 /* We must remove ourselves from the ready list before adding ourselves
\r
1652 to the blocked list as the same list item is used for both lists. We have
\r
1653 exclusive access to the ready lists as the scheduler is locked. */
\r
1654 vListRemove( ( xListItem * ) &( pxCurrentTCB->xGenericListItem ) );
\r
1657 #if ( INCLUDE_vTaskSuspend == 1 )
\r
1659 if( xTicksToWait == portMAX_DELAY )
\r
1661 /* Add ourselves to the suspended task list instead of a delayed task
\r
1662 list to ensure we are not woken by a timing event. We will block
\r
1664 vListInsertEnd( ( xList * ) &xSuspendedTaskList, ( xListItem * ) &( pxCurrentTCB->xGenericListItem ) );
\r
1668 /* Calculate the time at which the task should be woken if the event does
\r
1669 not occur. This may overflow but this doesn't matter. */
\r
1670 xTimeToWake = xTickCount + xTicksToWait;
\r
1672 listSET_LIST_ITEM_VALUE( &( pxCurrentTCB->xGenericListItem ), xTimeToWake );
\r
1674 if( xTimeToWake < xTickCount )
\r
1676 /* Wake time has overflowed. Place this item in the overflow list. */
\r
1677 vListInsert( ( xList * ) pxOverflowDelayedTaskList, ( xListItem * ) &( pxCurrentTCB->xGenericListItem ) );
\r
1681 /* The wake time has not overflowed, so we can use the current block list. */
\r
1682 vListInsert( ( xList * ) pxDelayedTaskList, ( xListItem * ) &( pxCurrentTCB->xGenericListItem ) );
\r
1688 /* Calculate the time at which the task should be woken if the event does
\r
1689 not occur. This may overflow but this doesn't matter. */
\r
1690 xTimeToWake = xTickCount + xTicksToWait;
\r
1692 listSET_LIST_ITEM_VALUE( &( pxCurrentTCB->xGenericListItem ), xTimeToWake );
\r
1694 if( xTimeToWake < xTickCount )
\r
1696 /* Wake time has overflowed. Place this item in the overflow list. */
\r
1697 vListInsert( ( xList * ) pxOverflowDelayedTaskList, ( xListItem * ) &( pxCurrentTCB->xGenericListItem ) );
\r
1701 /* The wake time has not overflowed, so we can use the current block list. */
\r
1702 vListInsert( ( xList * ) pxDelayedTaskList, ( xListItem * ) &( pxCurrentTCB->xGenericListItem ) );
\r
1707 /*-----------------------------------------------------------*/
\r
1709 signed portBASE_TYPE xTaskRemoveFromEventList( const xList * const pxEventList )
\r
1711 tskTCB *pxUnblockedTCB;
\r
1712 portBASE_TYPE xReturn;
\r
1714 /* THIS FUNCTION MUST BE CALLED WITH INTERRUPTS DISABLED OR THE
\r
1715 SCHEDULER SUSPENDED. It can also be called from within an ISR. */
\r
1717 /* The event list is sorted in priority order, so we can remove the
\r
1718 first in the list, remove the TCB from the delayed list, and add
\r
1719 it to the ready list.
\r
1721 If an event is for a queue that is locked then this function will never
\r
1722 get called - the lock count on the queue will get modified instead. This
\r
1723 means we can always expect exclusive access to the event list here. */
\r
1724 pxUnblockedTCB = ( tskTCB * ) listGET_OWNER_OF_HEAD_ENTRY( pxEventList );
\r
1725 vListRemove( &( pxUnblockedTCB->xEventListItem ) );
\r
1727 if( uxSchedulerSuspended == ( unsigned portBASE_TYPE ) pdFALSE )
\r
1729 vListRemove( &( pxUnblockedTCB->xGenericListItem ) );
\r
1730 prvAddTaskToReadyQueue( pxUnblockedTCB );
\r
1734 /* We cannot access the delayed or ready lists, so will hold this
\r
1735 task pending until the scheduler is resumed. */
\r
1736 vListInsertEnd( ( xList * ) &( xPendingReadyList ), &( pxUnblockedTCB->xEventListItem ) );
\r
1739 if( pxUnblockedTCB->uxPriority >= pxCurrentTCB->uxPriority )
\r
1741 /* Return true if the task removed from the event list has
\r
1742 a higher priority than the calling task. This allows
\r
1743 the calling task to know if it should force a context
\r
1749 xReturn = pdFALSE;
\r
1754 /*-----------------------------------------------------------*/
\r
1756 void vTaskSetTimeOutState( xTimeOutType * const pxTimeOut )
\r
1758 pxTimeOut->xOverflowCount = xNumOfOverflows;
\r
1759 pxTimeOut->xTimeOnEntering = xTickCount;
\r
1761 /*-----------------------------------------------------------*/
\r
1763 portBASE_TYPE xTaskCheckForTimeOut( xTimeOutType * const pxTimeOut, portTickType * const pxTicksToWait )
\r
1765 portBASE_TYPE xReturn;
\r
1767 portENTER_CRITICAL();
\r
1769 #if ( INCLUDE_vTaskSuspend == 1 )
\r
1770 /* If INCLUDE_vTaskSuspend is set to 1 and the block time specified is
\r
1771 the maximum block time then the task should block indefinitely, and
\r
1772 therefore never time out. */
\r
1773 if( *pxTicksToWait == portMAX_DELAY )
\r
1775 xReturn = pdFALSE;
\r
1777 else /* We are not blocking indefinitely, perform the checks below. */
\r
1780 if( ( xNumOfOverflows != pxTimeOut->xOverflowCount ) && ( ( portTickType ) xTickCount >= ( portTickType ) pxTimeOut->xTimeOnEntering ) )
\r
1782 /* The tick count is greater than the time at which vTaskSetTimeout()
\r
1783 was called, but has also overflowed since vTaskSetTimeOut() was called.
\r
1784 It must have wrapped all the way around and gone past us again. This
\r
1785 passed since vTaskSetTimeout() was called. */
\r
1788 else if( ( ( portTickType ) ( ( portTickType ) xTickCount - ( portTickType ) pxTimeOut->xTimeOnEntering ) ) < ( portTickType ) *pxTicksToWait )
\r
1790 /* Not a genuine timeout. Adjust parameters for time remaining. */
\r
1791 *pxTicksToWait -= ( ( portTickType ) xTickCount - ( portTickType ) pxTimeOut->xTimeOnEntering );
\r
1792 vTaskSetTimeOutState( pxTimeOut );
\r
1793 xReturn = pdFALSE;
\r
1800 portEXIT_CRITICAL();
\r
1804 /*-----------------------------------------------------------*/
\r
1806 void vTaskMissedYield( void )
\r
1808 xMissedYield = pdTRUE;
\r
1812 * -----------------------------------------------------------
\r
1814 * ----------------------------------------------------------
\r
1816 * The portTASK_FUNCTION() macro is used to allow port/compiler specific
\r
1817 * language extensions. The equivalent prototype for this function is:
\r
1819 * void prvIdleTask( void *pvParameters );
\r
1822 static portTASK_FUNCTION( prvIdleTask, pvParameters )
\r
1824 /* Stop warnings. */
\r
1825 ( void ) pvParameters;
\r
1829 /* See if any tasks have been deleted. */
\r
1830 prvCheckTasksWaitingTermination();
\r
1832 #if ( configUSE_PREEMPTION == 0 )
\r
1834 /* If we are not using preemption we keep forcing a task switch to
\r
1835 see if any other task has become available. If we are using
\r
1836 preemption we don't need to do this as any task becoming available
\r
1837 will automatically get the processor anyway. */
\r
1842 #if ( ( configUSE_PREEMPTION == 1 ) && ( configIDLE_SHOULD_YIELD == 1 ) )
\r
1844 /* When using preemption tasks of equal priority will be
\r
1845 timesliced. If a task that is sharing the idle priority is ready
\r
1846 to run then the idle task should yield before the end of the
\r
1849 A critical region is not required here as we are just reading from
\r
1850 the list, and an occasional incorrect value will not matter. If
\r
1851 the ready list at the idle priority contains more than one task
\r
1852 then a task other than the idle task is ready to execute. */
\r
1853 if( listCURRENT_LIST_LENGTH( &( pxReadyTasksLists[ tskIDLE_PRIORITY ] ) ) > ( unsigned portBASE_TYPE ) 1 )
\r
1860 #if ( configUSE_IDLE_HOOK == 1 )
\r
1862 extern void vApplicationIdleHook( void );
\r
1864 /* Call the user defined function from within the idle task. This
\r
1865 allows the application designer to add background functionality
\r
1866 without the overhead of a separate task.
\r
1867 NOTE: vApplicationIdleHook() MUST NOT, UNDER ANY CIRCUMSTANCES,
\r
1868 CALL A FUNCTION THAT MIGHT BLOCK. */
\r
1869 vApplicationIdleHook();
\r
1873 } /*lint !e715 pvParameters is not accessed but all task functions require the same prototype. */
\r
1881 /*-----------------------------------------------------------
\r
1882 * File private functions documented at the top of the file.
\r
1883 *----------------------------------------------------------*/
\r
1887 static void prvInitialiseTCBVariables( tskTCB *pxTCB, const signed char * const pcName, unsigned portBASE_TYPE uxPriority, const xMemoryRegion * const xRegions, unsigned short usStackDepth )
\r
1889 /* Store the function name in the TCB. */
\r
1890 #if configMAX_TASK_NAME_LEN > 1
\r
1892 /* Don't bring strncpy into the build unnecessarily. */
\r
1893 strncpy( ( char * ) pxTCB->pcTaskName, ( const char * ) pcName, ( unsigned short ) configMAX_TASK_NAME_LEN );
\r
1896 pxTCB->pcTaskName[ ( unsigned short ) configMAX_TASK_NAME_LEN - ( unsigned short ) 1 ] = '\0';
\r
1898 /* This is used as an array index so must ensure it's not too large. First
\r
1899 remove the privilege bit if one is present. */
\r
1900 if( uxPriority >= configMAX_PRIORITIES )
\r
1902 uxPriority = configMAX_PRIORITIES - 1;
\r
1905 pxTCB->uxPriority = uxPriority;
\r
1906 #if ( configUSE_MUTEXES == 1 )
\r
1908 pxTCB->uxBasePriority = uxPriority;
\r
1912 vListInitialiseItem( &( pxTCB->xGenericListItem ) );
\r
1913 vListInitialiseItem( &( pxTCB->xEventListItem ) );
\r
1915 /* Set the pxTCB as a link back from the xListItem. This is so we can get
\r
1916 back to the containing TCB from a generic item in a list. */
\r
1917 listSET_LIST_ITEM_OWNER( &( pxTCB->xGenericListItem ), pxTCB );
\r
1919 /* Event lists are always in priority order. */
\r
1920 listSET_LIST_ITEM_VALUE( &( pxTCB->xEventListItem ), configMAX_PRIORITIES - ( portTickType ) uxPriority );
\r
1921 listSET_LIST_ITEM_OWNER( &( pxTCB->xEventListItem ), pxTCB );
\r
1923 #if ( portCRITICAL_NESTING_IN_TCB == 1 )
\r
1925 pxTCB->uxCriticalNesting = ( unsigned portBASE_TYPE ) 0;
\r
1929 #if ( configUSE_APPLICATION_TASK_TAG == 1 )
\r
1931 pxTCB->pxTaskTag = NULL;
\r
1935 #if ( configGENERATE_RUN_TIME_STATS == 1 )
\r
1937 pxTCB->ulRunTimeCounter = 0UL;
\r
1941 #if ( portUSING_MPU_WRAPPERS == 1 )
\r
1943 vPortStoreTaskMPUSettings( &( pxTCB->xMPUSettings ), xRegions, pxTCB->pxStack, usStackDepth );
\r
1947 ( void ) xRegions;
\r
1948 ( void ) usStackDepth;
\r
1952 /*-----------------------------------------------------------*/
\r
1954 #if ( portUSING_MPU_WRAPPERS == 1 )
\r
1956 void vTaskAllocateMPURegions( xTaskHandle xTaskToModify, const xMemoryRegion * const xRegions )
\r
1960 if( xTaskToModify == pxCurrentTCB )
\r
1962 xTaskToModify = NULL;
\r
1965 /* If null is passed in here then we are deleting ourselves. */
\r
1966 pxTCB = prvGetTCBFromHandle( xTaskToModify );
\r
1968 vPortStoreTaskMPUSettings( &( pxTCB->xMPUSettings ), xRegions, NULL, 0 );
\r
1970 /*-----------------------------------------------------------*/
\r
1973 static void prvInitialiseTaskLists( void )
\r
1975 unsigned portBASE_TYPE uxPriority;
\r
1977 for( uxPriority = 0; uxPriority < configMAX_PRIORITIES; uxPriority++ )
\r
1979 vListInitialise( ( xList * ) &( pxReadyTasksLists[ uxPriority ] ) );
\r
1982 vListInitialise( ( xList * ) &xDelayedTaskList1 );
\r
1983 vListInitialise( ( xList * ) &xDelayedTaskList2 );
\r
1984 vListInitialise( ( xList * ) &xPendingReadyList );
\r
1986 #if ( INCLUDE_vTaskDelete == 1 )
\r
1988 vListInitialise( ( xList * ) &xTasksWaitingTermination );
\r
1992 #if ( INCLUDE_vTaskSuspend == 1 )
\r
1994 vListInitialise( ( xList * ) &xSuspendedTaskList );
\r
1998 /* Start with pxDelayedTaskList using list1 and the pxOverflowDelayedTaskList
\r
2000 pxDelayedTaskList = &xDelayedTaskList1;
\r
2001 pxOverflowDelayedTaskList = &xDelayedTaskList2;
\r
2003 /*-----------------------------------------------------------*/
\r
2005 static void prvCheckTasksWaitingTermination( void )
\r
2007 #if ( INCLUDE_vTaskDelete == 1 )
\r
2009 portBASE_TYPE xListIsEmpty;
\r
2011 /* ucTasksDeleted is used to prevent vTaskSuspendAll() being called
\r
2012 too often in the idle task. */
\r
2013 if( uxTasksDeleted > ( unsigned portBASE_TYPE ) 0 )
\r
2015 vTaskSuspendAll();
\r
2016 xListIsEmpty = listLIST_IS_EMPTY( &xTasksWaitingTermination );
\r
2019 if( !xListIsEmpty )
\r
2023 portENTER_CRITICAL();
\r
2025 pxTCB = ( tskTCB * ) listGET_OWNER_OF_HEAD_ENTRY( ( ( xList * ) &xTasksWaitingTermination ) );
\r
2026 vListRemove( &( pxTCB->xGenericListItem ) );
\r
2027 --uxCurrentNumberOfTasks;
\r
2030 portEXIT_CRITICAL();
\r
2032 prvDeleteTCB( pxTCB );
\r
2038 /*-----------------------------------------------------------*/
\r
2040 static tskTCB *prvAllocateTCBAndStack( unsigned short usStackDepth, portSTACK_TYPE *puxStackBuffer )
\r
2044 /* Allocate space for the TCB. Where the memory comes from depends on
\r
2045 the implementation of the port malloc function. */
\r
2046 pxNewTCB = ( tskTCB * ) pvPortMalloc( sizeof( tskTCB ) );
\r
2048 if( pxNewTCB != NULL )
\r
2050 /* Allocate space for the stack used by the task being created.
\r
2051 The base of the stack memory stored in the TCB so the task can
\r
2052 be deleted later if required. */
\r
2053 pxNewTCB->pxStack = ( portSTACK_TYPE * ) pvPortMallocAligned( ( ( ( size_t )usStackDepth ) * sizeof( portSTACK_TYPE ) ), puxStackBuffer );
\r
2055 if( pxNewTCB->pxStack == NULL )
\r
2057 /* Could not allocate the stack. Delete the allocated TCB. */
\r
2058 vPortFree( pxNewTCB );
\r
2063 /* Just to help debugging. */
\r
2064 memset( pxNewTCB->pxStack, tskSTACK_FILL_BYTE, usStackDepth * sizeof( portSTACK_TYPE ) );
\r
2070 /*-----------------------------------------------------------*/
\r
2072 #if ( configUSE_TRACE_FACILITY == 1 )
\r
2074 static void prvListTaskWithinSingleList( const signed char *pcWriteBuffer, xList *pxList, signed char cStatus )
\r
2076 volatile tskTCB *pxNextTCB, *pxFirstTCB;
\r
2077 unsigned short usStackRemaining;
\r
2079 /* Write the details of all the TCB's in pxList into the buffer. */
\r
2080 listGET_OWNER_OF_NEXT_ENTRY( pxFirstTCB, pxList );
\r
2083 listGET_OWNER_OF_NEXT_ENTRY( pxNextTCB, pxList );
\r
2084 #if ( portSTACK_GROWTH > 0 )
\r
2086 usStackRemaining = usTaskCheckFreeStackSpace( ( unsigned char * ) pxNextTCB->pxEndOfStack );
\r
2090 usStackRemaining = usTaskCheckFreeStackSpace( ( unsigned char * ) pxNextTCB->pxStack );
\r
2094 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
2095 strcat( ( char * ) pcWriteBuffer, ( char * ) pcStatusString );
\r
2097 } while( pxNextTCB != pxFirstTCB );
\r
2101 /*-----------------------------------------------------------*/
\r
2103 #if ( configGENERATE_RUN_TIME_STATS == 1 )
\r
2105 static void prvGenerateRunTimeStatsForTasksInList( const signed char *pcWriteBuffer, xList *pxList, unsigned long ulTotalRunTime )
\r
2107 volatile tskTCB *pxNextTCB, *pxFirstTCB;
\r
2108 unsigned long ulStatsAsPercentage;
\r
2110 /* Write the run time stats of all the TCB's in pxList into the buffer. */
\r
2111 listGET_OWNER_OF_NEXT_ENTRY( pxFirstTCB, pxList );
\r
2114 /* Get next TCB in from the list. */
\r
2115 listGET_OWNER_OF_NEXT_ENTRY( pxNextTCB, pxList );
\r
2117 /* Divide by zero check. */
\r
2118 if( ulTotalRunTime > 0UL )
\r
2120 /* Has the task run at all? */
\r
2121 if( pxNextTCB->ulRunTimeCounter == 0 )
\r
2123 /* The task has used no CPU time at all. */
\r
2124 sprintf( pcStatsString, ( char * ) "%s\t\t0\t\t0%%\r\n", pxNextTCB->pcTaskName );
\r
2128 /* What percentage of the total run time as the task used?
\r
2129 This will always be rounded down to the nearest integer. */
\r
2130 ulStatsAsPercentage = ( 100UL * pxNextTCB->ulRunTimeCounter ) / ulTotalRunTime;
\r
2132 if( ulStatsAsPercentage > 0UL )
\r
2134 sprintf( pcStatsString, ( char * ) "%s\t\t%lu\t\t%lu%%\r\n", pxNextTCB->pcTaskName, pxNextTCB->ulRunTimeCounter, ulStatsAsPercentage );
\r
2138 /* If the percentage is zero here then the task has
\r
2139 consumed less than 1% of the total run time. */
\r
2140 sprintf( pcStatsString, ( char * ) "%s\t\t%lu\t\t<1%%\r\n", pxNextTCB->pcTaskName, pxNextTCB->ulRunTimeCounter );
\r
2144 strcat( ( char * ) pcWriteBuffer, ( char * ) pcStatsString );
\r
2147 } while( pxNextTCB != pxFirstTCB );
\r
2151 /*-----------------------------------------------------------*/
\r
2153 #if ( ( configUSE_TRACE_FACILITY == 1 ) || ( INCLUDE_uxTaskGetStackHighWaterMark == 1 ) )
\r
2155 static unsigned short usTaskCheckFreeStackSpace( const unsigned char * pucStackByte )
\r
2157 register unsigned short usCount = 0;
\r
2159 while( *pucStackByte == tskSTACK_FILL_BYTE )
\r
2161 pucStackByte -= portSTACK_GROWTH;
\r
2165 usCount /= sizeof( portSTACK_TYPE );
\r
2171 /*-----------------------------------------------------------*/
\r
2173 #if ( INCLUDE_uxTaskGetStackHighWaterMark == 1 )
\r
2175 unsigned portBASE_TYPE uxTaskGetStackHighWaterMark( xTaskHandle xTask )
\r
2178 unsigned char *pcEndOfStack;
\r
2179 unsigned portBASE_TYPE uxReturn;
\r
2181 pxTCB = prvGetTCBFromHandle( xTask );
\r
2183 #if portSTACK_GROWTH < 0
\r
2185 pcEndOfStack = ( unsigned char * ) pxTCB->pxStack;
\r
2189 pcEndOfStack = ( unsigned char * ) pxTCB->pxEndOfStack;
\r
2193 uxReturn = ( unsigned portBASE_TYPE ) usTaskCheckFreeStackSpace( pcEndOfStack );
\r
2199 /*-----------------------------------------------------------*/
\r
2201 #if ( ( INCLUDE_vTaskDelete == 1 ) || ( INCLUDE_vTaskCleanUpResources == 1 ) )
\r
2203 static void prvDeleteTCB( tskTCB *pxTCB )
\r
2205 /* Free up the memory allocated by the scheduler for the task. It is up to
\r
2206 the task to free any memory allocated at the application level. */
\r
2207 vPortFreeAligned( pxTCB->pxStack );
\r
2208 vPortFree( pxTCB );
\r
2214 /*-----------------------------------------------------------*/
\r
2216 #if ( INCLUDE_xTaskGetCurrentTaskHandle == 1 )
\r
2218 xTaskHandle xTaskGetCurrentTaskHandle( void )
\r
2220 xTaskHandle xReturn;
\r
2222 /* A critical section is not required as this is not called from
\r
2223 an interrupt and the current TCB will always be the same for any
\r
2224 individual execution thread. */
\r
2225 xReturn = pxCurrentTCB;
\r
2232 /*-----------------------------------------------------------*/
\r
2234 #if ( INCLUDE_xTaskGetSchedulerState == 1 )
\r
2236 portBASE_TYPE xTaskGetSchedulerState( void )
\r
2238 portBASE_TYPE xReturn;
\r
2240 if( xSchedulerRunning == pdFALSE )
\r
2242 xReturn = taskSCHEDULER_NOT_STARTED;
\r
2246 if( uxSchedulerSuspended == ( unsigned portBASE_TYPE ) pdFALSE )
\r
2248 xReturn = taskSCHEDULER_RUNNING;
\r
2252 xReturn = taskSCHEDULER_SUSPENDED;
\r
2260 /*-----------------------------------------------------------*/
\r
2262 #if ( configUSE_MUTEXES == 1 )
\r
2264 void vTaskPriorityInherit( xTaskHandle * const pxMutexHolder )
\r
2266 tskTCB * const pxTCB = ( tskTCB * ) pxMutexHolder;
\r
2268 if( pxTCB->uxPriority < pxCurrentTCB->uxPriority )
\r
2270 /* Adjust the mutex holder state to account for its new priority. */
\r
2271 listSET_LIST_ITEM_VALUE( &( pxTCB->xEventListItem ), configMAX_PRIORITIES - ( portTickType ) pxCurrentTCB->uxPriority );
\r
2273 /* If the task being modified is in the ready state it will need to
\r
2274 be moved in to a new list. */
\r
2275 if( listIS_CONTAINED_WITHIN( &( pxReadyTasksLists[ pxTCB->uxPriority ] ), &( pxTCB->xGenericListItem ) ) )
\r
2277 vListRemove( &( pxTCB->xGenericListItem ) );
\r
2279 /* Inherit the priority before being moved into the new list. */
\r
2280 pxTCB->uxPriority = pxCurrentTCB->uxPriority;
\r
2281 prvAddTaskToReadyQueue( pxTCB );
\r
2285 /* Just inherit the priority. */
\r
2286 pxTCB->uxPriority = pxCurrentTCB->uxPriority;
\r
2292 /*-----------------------------------------------------------*/
\r
2294 #if ( configUSE_MUTEXES == 1 )
\r
2296 void vTaskPriorityDisinherit( xTaskHandle * const pxMutexHolder )
\r
2298 tskTCB * const pxTCB = ( tskTCB * ) pxMutexHolder;
\r
2300 if( pxMutexHolder != NULL )
\r
2302 if( pxTCB->uxPriority != pxTCB->uxBasePriority )
\r
2304 /* We must be the running task to be able to give the mutex back.
\r
2305 Remove ourselves from the ready list we currently appear in. */
\r
2306 vListRemove( &( pxTCB->xGenericListItem ) );
\r
2308 /* Disinherit the priority before adding ourselves into the new
\r
2310 pxTCB->uxPriority = pxTCB->uxBasePriority;
\r
2311 listSET_LIST_ITEM_VALUE( &( pxTCB->xEventListItem ), configMAX_PRIORITIES - ( portTickType ) pxTCB->uxPriority );
\r
2312 prvAddTaskToReadyQueue( pxTCB );
\r
2318 /*-----------------------------------------------------------*/
\r
2320 #if ( portCRITICAL_NESTING_IN_TCB == 1 )
\r
2322 void vTaskEnterCritical( void )
\r
2324 portDISABLE_INTERRUPTS();
\r
2326 if( xSchedulerRunning != pdFALSE )
\r
2328 ( pxCurrentTCB->uxCriticalNesting )++;
\r
2333 /*-----------------------------------------------------------*/
\r
2335 #if ( portCRITICAL_NESTING_IN_TCB == 1 )
\r
2337 void vTaskExitCritical( void )
\r
2339 if( xSchedulerRunning != pdFALSE )
\r
2341 if( pxCurrentTCB->uxCriticalNesting > 0 )
\r
2343 ( pxCurrentTCB->uxCriticalNesting )--;
\r
2345 if( pxCurrentTCB->uxCriticalNesting == 0 )
\r
2347 portENABLE_INTERRUPTS();
\r
2354 /*-----------------------------------------------------------*/
\r
projects / freertos / blob