2 FreeRTOS.org V5.3.0 - Copyright (C) 2003-2009 Richard Barry.
\r
4 This file is part of the FreeRTOS.org distribution.
\r
6 FreeRTOS.org is free software; you can redistribute it and/or modify it
\r
7 under the terms of the GNU General Public License (version 2) as published
\r
8 by the Free Software Foundation and modified by the FreeRTOS exception.
\r
9 **NOTE** The exception to the GPL is included to allow you to distribute a
\r
10 combined work that includes FreeRTOS.org without being obliged to provide
\r
11 the source code for any proprietary components. Alternative commercial
\r
12 license and support terms are also available upon request. See the
\r
13 licensing section of http://www.FreeRTOS.org for full details.
\r
15 FreeRTOS.org is distributed in the hope that it will be useful, but WITHOUT
\r
16 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
\r
17 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
\r
20 You should have received a copy of the GNU General Public License along
\r
21 with FreeRTOS.org; if not, write to the Free Software Foundation, Inc., 59
\r
22 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
\r
25 ***************************************************************************
\r
27 * Get the FreeRTOS eBook! See http://www.FreeRTOS.org/Documentation *
\r
29 * This is a concise, step by step, 'hands on' guide that describes both *
\r
30 * general multitasking concepts and FreeRTOS specifics. It presents and *
\r
31 * explains numerous examples that are written using the FreeRTOS API. *
\r
32 * Full source code for all the examples is provided in an accompanying *
\r
35 ***************************************************************************
\r
39 Please ensure to read the configuration and relevant port sections of the
\r
40 online documentation.
\r
42 http://www.FreeRTOS.org - Documentation, latest information, license and
\r
45 http://www.SafeRTOS.com - A version that is certified for use in safety
\r
48 http://www.OpenRTOS.com - Commercial support, development, porting,
\r
49 licensing and training services.
\r
57 #include "FreeRTOS.h"
\r
59 #include "StackMacros.h"
\r
62 * Macro to define the amount of stack available to the idle task.
\r
64 #define tskIDLE_STACK_SIZE configMINIMAL_STACK_SIZE
\r
67 * Task control block. A task control block (TCB) is allocated to each task,
\r
68 * and stores the context of the task.
\r
70 typedef struct tskTaskControlBlock
\r
72 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
73 xListItem xGenericListItem; /*< List item used to place the TCB in ready and blocked queues. */
\r
74 xListItem xEventListItem; /*< List item used to place the TCB in event lists. */
\r
75 unsigned portBASE_TYPE uxPriority; /*< The priority of the task where 0 is the lowest priority. */
\r
76 portSTACK_TYPE *pxStack; /*< Points to the start of the stack. */
\r
77 signed portCHAR pcTaskName[ configMAX_TASK_NAME_LEN ];/*< Descriptive name given to the task when created. Facilitates debugging only. */
\r
79 #if ( portSTACK_GROWTH > 0 )
\r
80 portSTACK_TYPE *pxEndOfStack; /*< Used for stack overflow checking on architectures where the stack grows up from low memory. */
\r
83 #if ( portCRITICAL_NESTING_IN_TCB == 1 )
\r
84 unsigned portBASE_TYPE uxCriticalNesting;
\r
87 #if ( configUSE_TRACE_FACILITY == 1 )
\r
88 unsigned portBASE_TYPE uxTCBNumber; /*< This is used for tracing the scheduler and making debugging easier only. */
\r
91 #if ( configUSE_MUTEXES == 1 )
\r
92 unsigned portBASE_TYPE uxBasePriority; /*< The priority last assigned to the task - used by the priority inheritance mechanism. */
\r
95 #if ( configUSE_APPLICATION_TASK_TAG == 1 )
\r
96 pdTASK_HOOK_CODE pxTaskTag;
\r
99 #if ( configGENERATE_RUN_TIME_STATS == 1 )
\r
100 unsigned portLONG ulRunTimeCounter; /*< Used for calculating how much CPU time each task is utilising. */
\r
106 * Some kernel aware debuggers require data to be viewed to be global, rather
\r
109 #ifdef portREMOVE_STATIC_QUALIFIER
\r
115 tskTCB * volatile pxCurrentTCB = NULL;
\r
117 /* Lists for ready and blocked tasks. --------------------*/
\r
119 static xList pxReadyTasksLists[ configMAX_PRIORITIES ]; /*< Prioritised ready tasks. */
\r
120 static xList xDelayedTaskList1; /*< Delayed tasks. */
\r
121 static xList xDelayedTaskList2; /*< Delayed tasks (two lists are used - one for delays that have overflowed the current tick count. */
\r
122 static xList * volatile pxDelayedTaskList; /*< Points to the delayed task list currently being used. */
\r
123 static xList * volatile pxOverflowDelayedTaskList; /*< Points to the delayed task list currently being used to hold tasks that have overflowed the current tick count. */
\r
124 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
126 #if ( INCLUDE_vTaskDelete == 1 )
\r
128 static volatile xList xTasksWaitingTermination; /*< Tasks that have been deleted - but the their memory not yet freed. */
\r
129 static volatile unsigned portBASE_TYPE uxTasksDeleted = ( unsigned portBASE_TYPE ) 0;
\r
133 #if ( INCLUDE_vTaskSuspend == 1 )
\r
135 static xList xSuspendedTaskList; /*< Tasks that are currently suspended. */
\r
139 /* File private variables. --------------------------------*/
\r
140 static volatile unsigned portBASE_TYPE uxCurrentNumberOfTasks = ( unsigned portBASE_TYPE ) 0;
\r
141 static volatile portTickType xTickCount = ( portTickType ) 0;
\r
142 static unsigned portBASE_TYPE uxTopUsedPriority = tskIDLE_PRIORITY;
\r
143 static volatile unsigned portBASE_TYPE uxTopReadyPriority = tskIDLE_PRIORITY;
\r
144 static volatile signed portBASE_TYPE xSchedulerRunning = pdFALSE;
\r
145 static volatile unsigned portBASE_TYPE uxSchedulerSuspended = ( unsigned portBASE_TYPE ) pdFALSE;
\r
146 static volatile unsigned portBASE_TYPE uxMissedTicks = ( unsigned portBASE_TYPE ) 0;
\r
147 static volatile portBASE_TYPE xMissedYield = ( portBASE_TYPE ) pdFALSE;
\r
148 static volatile portBASE_TYPE xNumOfOverflows = ( portBASE_TYPE ) 0;
\r
149 static unsigned portBASE_TYPE uxTaskNumber = ( unsigned portBASE_TYPE ) 0;
\r
151 #if ( configGENERATE_RUN_TIME_STATS == 1 )
\r
153 static portCHAR pcStatsString[ 50 ];
\r
154 static unsigned portLONG ulTaskSwitchedInTime = 0UL; /*< Holds the value of a timer/counter the last time a task was switched in. */
\r
155 static void prvGenerateRunTimeStatsForTasksInList( const signed portCHAR *pcWriteBuffer, xList *pxList, unsigned portLONG ulTotalRunTime );
\r
159 /* Debugging and trace facilities private variables and macros. ------------*/
\r
162 * The value used to fill the stack of a task when the task is created. This
\r
163 * is used purely for checking the high water mark for tasks.
\r
165 #define tskSTACK_FILL_BYTE ( 0xa5 )
\r
168 * Macros used by vListTask to indicate which state a task is in.
\r
170 #define tskBLOCKED_CHAR ( ( signed portCHAR ) 'B' )
\r
171 #define tskREADY_CHAR ( ( signed portCHAR ) 'R' )
\r
172 #define tskDELETED_CHAR ( ( signed portCHAR ) 'D' )
\r
173 #define tskSUSPENDED_CHAR ( ( signed portCHAR ) 'S' )
\r
176 * Macros and private variables used by the trace facility.
\r
178 #if ( configUSE_TRACE_FACILITY == 1 )
\r
180 #define tskSIZE_OF_EACH_TRACE_LINE ( ( unsigned portLONG ) ( sizeof( unsigned portLONG ) + sizeof( unsigned portLONG ) ) )
\r
181 static volatile signed portCHAR * volatile pcTraceBuffer;
\r
182 static signed portCHAR *pcTraceBufferStart;
\r
183 static signed portCHAR *pcTraceBufferEnd;
\r
184 static signed portBASE_TYPE xTracing = pdFALSE;
\r
185 static unsigned portBASE_TYPE uxPreviousTask = 255;
\r
186 static portCHAR pcStatusString[ 50 ];
\r
190 /*-----------------------------------------------------------*/
\r
193 * Macro that writes a trace of scheduler activity to a buffer. This trace
\r
194 * shows which task is running when and is very useful as a debugging tool.
\r
195 * As this macro is called each context switch it is a good idea to undefine
\r
196 * it if not using the facility.
\r
198 #if ( configUSE_TRACE_FACILITY == 1 )
\r
200 #define vWriteTraceToBuffer() \
\r
204 if( uxPreviousTask != pxCurrentTCB->uxTCBNumber ) \
\r
206 if( ( pcTraceBuffer + tskSIZE_OF_EACH_TRACE_LINE ) < pcTraceBufferEnd ) \
\r
208 uxPreviousTask = pxCurrentTCB->uxTCBNumber; \
\r
209 *( unsigned portLONG * ) pcTraceBuffer = ( unsigned portLONG ) xTickCount; \
\r
210 pcTraceBuffer += sizeof( unsigned portLONG ); \
\r
211 *( unsigned portLONG * ) pcTraceBuffer = ( unsigned portLONG ) uxPreviousTask; \
\r
212 pcTraceBuffer += sizeof( unsigned portLONG ); \
\r
216 xTracing = pdFALSE; \
\r
224 #define vWriteTraceToBuffer()
\r
227 /*-----------------------------------------------------------*/
\r
230 * Place the task represented by pxTCB into the appropriate ready queue for
\r
231 * the task. It is inserted at the end of the list. One quirk of this is
\r
232 * that if the task being inserted is at the same priority as the currently
\r
233 * executing task, then it will only be rescheduled after the currently
\r
234 * executing task has been rescheduled.
\r
236 #define prvAddTaskToReadyQueue( pxTCB ) \
\r
238 if( pxTCB->uxPriority > uxTopReadyPriority ) \
\r
240 uxTopReadyPriority = pxTCB->uxPriority; \
\r
242 vListInsertEnd( ( xList * ) &( pxReadyTasksLists[ pxTCB->uxPriority ] ), &( pxTCB->xGenericListItem ) ); \
\r
244 /*-----------------------------------------------------------*/
\r
247 * Macro that looks at the list of tasks that are currently delayed to see if
\r
248 * any require waking.
\r
250 * Tasks are stored in the queue in the order of their wake time - meaning
\r
251 * once one tasks has been found whose timer has not expired we need not look
\r
252 * any further down the list.
\r
254 #define prvCheckDelayedTasks() \
\r
256 register tskTCB *pxTCB; \
\r
258 while( ( pxTCB = ( tskTCB * ) listGET_OWNER_OF_HEAD_ENTRY( pxDelayedTaskList ) ) != NULL ) \
\r
260 if( xTickCount < listGET_LIST_ITEM_VALUE( &( pxTCB->xGenericListItem ) ) ) \
\r
264 vListRemove( &( pxTCB->xGenericListItem ) ); \
\r
265 /* Is the task waiting on an event also? */ \
\r
266 if( pxTCB->xEventListItem.pvContainer ) \
\r
268 vListRemove( &( pxTCB->xEventListItem ) ); \
\r
270 prvAddTaskToReadyQueue( pxTCB ); \
\r
273 /*-----------------------------------------------------------*/
\r
276 * Several functions take an xTaskHandle parameter that can optionally be NULL,
\r
277 * where NULL is used to indicate that the handle of the currently executing
\r
278 * task should be used in place of the parameter. This macro simply checks to
\r
279 * see if the parameter is NULL and returns a pointer to the appropriate TCB.
\r
281 #define prvGetTCBFromHandle( pxHandle ) ( ( pxHandle == NULL ) ? ( tskTCB * ) pxCurrentTCB : ( tskTCB * ) pxHandle )
\r
284 /* File private functions. --------------------------------*/
\r
287 * Utility to ready a TCB for a given task. Mainly just copies the parameters
\r
288 * into the TCB structure.
\r
290 static void prvInitialiseTCBVariables( tskTCB *pxTCB, const signed portCHAR * const pcName, unsigned portBASE_TYPE uxPriority );
\r
293 * Utility to ready all the lists used by the scheduler. This is called
\r
294 * automatically upon the creation of the first task.
\r
296 static void prvInitialiseTaskLists( void );
\r
299 * The idle task, which as all tasks is implemented as a never ending loop.
\r
300 * The idle task is automatically created and added to the ready lists upon
\r
301 * creation of the first user task.
\r
303 * The portTASK_FUNCTION_PROTO() macro is used to allow port/compiler specific
\r
304 * language extensions. The equivalent prototype for this function is:
\r
306 * void prvIdleTask( void *pvParameters );
\r
309 static portTASK_FUNCTION_PROTO( prvIdleTask, pvParameters );
\r
312 * Utility to free all memory allocated by the scheduler to hold a TCB,
\r
313 * including the stack pointed to by the TCB.
\r
315 * This does not free memory allocated by the task itself (i.e. memory
\r
316 * allocated by calls to pvPortMalloc from within the tasks application code).
\r
318 #if ( ( INCLUDE_vTaskDelete == 1 ) || ( INCLUDE_vTaskCleanUpResources == 1 ) )
\r
320 static void prvDeleteTCB( tskTCB *pxTCB );
\r
325 * Used only by the idle task. This checks to see if anything has been placed
\r
326 * in the list of tasks waiting to be deleted. If so the task is cleaned up
\r
327 * and its TCB deleted.
\r
329 static void prvCheckTasksWaitingTermination( void );
\r
332 * Allocates memory from the heap for a TCB and associated stack. Checks the
\r
333 * allocation was successful.
\r
335 static tskTCB *prvAllocateTCBAndStack( unsigned portSHORT usStackDepth );
\r
338 * Called from vTaskList. vListTasks details all the tasks currently under
\r
339 * control of the scheduler. The tasks may be in one of a number of lists.
\r
340 * prvListTaskWithinSingleList accepts a list and details the tasks from
\r
341 * within just that list.
\r
343 * THIS FUNCTION IS INTENDED FOR DEBUGGING ONLY, AND SHOULD NOT BE CALLED FROM
\r
344 * NORMAL APPLICATION CODE.
\r
346 #if ( configUSE_TRACE_FACILITY == 1 )
\r
348 static void prvListTaskWithinSingleList( const signed portCHAR *pcWriteBuffer, xList *pxList, signed portCHAR cStatus );
\r
353 * When a task is created, the stack of the task is filled with a known value.
\r
354 * This function determines the 'high water mark' of the task stack by
\r
355 * determining how much of the stack remains at the original preset value.
\r
357 #if ( ( configUSE_TRACE_FACILITY == 1 ) || ( INCLUDE_uxTaskGetStackHighWaterMark == 1 ) )
\r
359 unsigned portSHORT usTaskCheckFreeStackSpace( const unsigned portCHAR * pucStackByte );
\r
368 /*-----------------------------------------------------------
\r
369 * TASK CREATION API documented in task.h
\r
370 *----------------------------------------------------------*/
\r
372 signed portBASE_TYPE xTaskCreate( pdTASK_CODE pvTaskCode, const signed portCHAR * const pcName, unsigned portSHORT usStackDepth, void *pvParameters, unsigned portBASE_TYPE uxPriority, xTaskHandle *pxCreatedTask )
\r
374 signed portBASE_TYPE xReturn;
\r
377 /* Allocate the memory required by the TCB and stack for the new task.
\r
378 checking that the allocation was successful. */
\r
379 pxNewTCB = prvAllocateTCBAndStack( usStackDepth );
\r
381 if( pxNewTCB != NULL )
\r
383 portSTACK_TYPE *pxTopOfStack;
\r
385 /* Setup the newly allocated TCB with the initial state of the task. */
\r
386 prvInitialiseTCBVariables( pxNewTCB, pcName, uxPriority );
\r
388 /* Calculate the top of stack address. This depends on whether the
\r
389 stack grows from high memory to low (as per the 80x86) or visa versa.
\r
390 portSTACK_GROWTH is used to make the result positive or negative as
\r
391 required by the port. */
\r
392 #if portSTACK_GROWTH < 0
\r
394 pxTopOfStack = pxNewTCB->pxStack + ( usStackDepth - 1 );
\r
398 pxTopOfStack = pxNewTCB->pxStack;
\r
400 /* If we want to use stack checking on architectures that use
\r
401 a positive stack growth direction then we also need to store the
\r
402 other extreme of the stack space. */
\r
403 pxNewTCB->pxEndOfStack = pxNewTCB->pxStack + ( usStackDepth - 1 );
\r
407 /* Initialize the TCB stack to look as if the task was already running,
\r
408 but had been interrupted by the scheduler. The return address is set
\r
409 to the start of the task function. Once the stack has been initialised
\r
410 the top of stack variable is updated. */
\r
411 pxNewTCB->pxTopOfStack = pxPortInitialiseStack( pxTopOfStack, pvTaskCode, pvParameters );
\r
413 /* We are going to manipulate the task queues to add this task to a
\r
414 ready list, so must make sure no interrupts occur. */
\r
415 portENTER_CRITICAL();
\r
417 uxCurrentNumberOfTasks++;
\r
418 if( uxCurrentNumberOfTasks == ( unsigned portBASE_TYPE ) 1 )
\r
420 /* As this is the first task it must also be the current task. */
\r
421 pxCurrentTCB = pxNewTCB;
\r
423 /* This is the first task to be created so do the preliminary
\r
424 initialisation required. We will not recover if this call
\r
425 fails, but we will report the failure. */
\r
426 prvInitialiseTaskLists();
\r
430 /* If the scheduler is not already running, make this task the
\r
431 current task if it is the highest priority task to be created
\r
433 if( xSchedulerRunning == pdFALSE )
\r
435 if( pxCurrentTCB->uxPriority <= uxPriority )
\r
437 pxCurrentTCB = pxNewTCB;
\r
442 /* Remember the top priority to make context switching faster. Use
\r
443 the priority in pxNewTCB as this has been capped to a valid value. */
\r
444 if( pxNewTCB->uxPriority > uxTopUsedPriority )
\r
446 uxTopUsedPriority = pxNewTCB->uxPriority;
\r
449 #if ( configUSE_TRACE_FACILITY == 1 )
\r
451 /* Add a counter into the TCB for tracing only. */
\r
452 pxNewTCB->uxTCBNumber = uxTaskNumber;
\r
457 prvAddTaskToReadyQueue( pxNewTCB );
\r
460 traceTASK_CREATE( pxNewTCB );
\r
462 portEXIT_CRITICAL();
\r
466 xReturn = errCOULD_NOT_ALLOCATE_REQUIRED_MEMORY;
\r
467 traceTASK_CREATE_FAILED( pxNewTCB );
\r
470 if( xReturn == pdPASS )
\r
472 if( ( void * ) pxCreatedTask != NULL )
\r
474 /* Pass the TCB out - in an anonymous way. The calling function/
\r
475 task can use this as a handle to delete the task later if
\r
477 *pxCreatedTask = ( xTaskHandle ) pxNewTCB;
\r
480 if( xSchedulerRunning != pdFALSE )
\r
482 /* If the created task is of a higher priority than the current task
\r
483 then it should run now. */
\r
484 if( pxCurrentTCB->uxPriority < uxPriority )
\r
493 /*-----------------------------------------------------------*/
\r
495 #if ( INCLUDE_vTaskDelete == 1 )
\r
497 void vTaskDelete( xTaskHandle pxTaskToDelete )
\r
501 taskENTER_CRITICAL();
\r
503 /* Ensure a yield is performed if the current task is being
\r
505 if( pxTaskToDelete == pxCurrentTCB )
\r
507 pxTaskToDelete = NULL;
\r
510 /* If null is passed in here then we are deleting ourselves. */
\r
511 pxTCB = prvGetTCBFromHandle( pxTaskToDelete );
\r
513 /* Remove task from the ready list and place in the termination list.
\r
514 This will stop the task from be scheduled. The idle task will check
\r
515 the termination list and free up any memory allocated by the
\r
516 scheduler for the TCB and stack. */
\r
517 vListRemove( &( pxTCB->xGenericListItem ) );
\r
519 /* Is the task waiting on an event also? */
\r
520 if( pxTCB->xEventListItem.pvContainer )
\r
522 vListRemove( &( pxTCB->xEventListItem ) );
\r
525 vListInsertEnd( ( xList * ) &xTasksWaitingTermination, &( pxTCB->xGenericListItem ) );
\r
527 /* Increment the ucTasksDeleted variable so the idle task knows
\r
528 there is a task that has been deleted and that it should therefore
\r
529 check the xTasksWaitingTermination list. */
\r
532 /* Increment the uxTaskNumberVariable also so kernel aware debuggers
\r
533 can detect that the task lists need re-generating. */
\r
536 traceTASK_DELETE( pxTCB );
\r
538 taskEXIT_CRITICAL();
\r
540 /* Force a reschedule if we have just deleted the current task. */
\r
541 if( xSchedulerRunning != pdFALSE )
\r
543 if( ( void * ) pxTaskToDelete == NULL )
\r
557 /*-----------------------------------------------------------
\r
558 * TASK CONTROL API documented in task.h
\r
559 *----------------------------------------------------------*/
\r
561 #if ( INCLUDE_vTaskDelayUntil == 1 )
\r
563 void vTaskDelayUntil( portTickType * const pxPreviousWakeTime, portTickType xTimeIncrement )
\r
565 portTickType xTimeToWake;
\r
566 portBASE_TYPE xAlreadyYielded, xShouldDelay = pdFALSE;
\r
570 /* Generate the tick time at which the task wants to wake. */
\r
571 xTimeToWake = *pxPreviousWakeTime + xTimeIncrement;
\r
573 if( xTickCount < *pxPreviousWakeTime )
\r
575 /* The tick count has overflowed since this function was
\r
576 lasted called. In this case the only time we should ever
\r
577 actually delay is if the wake time has also overflowed,
\r
578 and the wake time is greater than the tick time. When this
\r
579 is the case it is as if neither time had overflowed. */
\r
580 if( ( xTimeToWake < *pxPreviousWakeTime ) && ( xTimeToWake > xTickCount ) )
\r
582 xShouldDelay = pdTRUE;
\r
587 /* The tick time has not overflowed. In this case we will
\r
588 delay if either the wake time has overflowed, and/or the
\r
589 tick time is less than the wake time. */
\r
590 if( ( xTimeToWake < *pxPreviousWakeTime ) || ( xTimeToWake > xTickCount ) )
\r
592 xShouldDelay = pdTRUE;
\r
596 /* Update the wake time ready for the next call. */
\r
597 *pxPreviousWakeTime = xTimeToWake;
\r
601 traceTASK_DELAY_UNTIL();
\r
603 /* We must remove ourselves from the ready list before adding
\r
604 ourselves to the blocked list as the same list item is used for
\r
606 vListRemove( ( xListItem * ) &( pxCurrentTCB->xGenericListItem ) );
\r
608 /* The list item will be inserted in wake time order. */
\r
609 listSET_LIST_ITEM_VALUE( &( pxCurrentTCB->xGenericListItem ), xTimeToWake );
\r
611 if( xTimeToWake < xTickCount )
\r
613 /* Wake time has overflowed. Place this item in the
\r
615 vListInsert( ( xList * ) pxOverflowDelayedTaskList, ( xListItem * ) &( pxCurrentTCB->xGenericListItem ) );
\r
619 /* The wake time has not overflowed, so we can use the
\r
620 current block list. */
\r
621 vListInsert( ( xList * ) pxDelayedTaskList, ( xListItem * ) &( pxCurrentTCB->xGenericListItem ) );
\r
625 xAlreadyYielded = xTaskResumeAll();
\r
627 /* Force a reschedule if xTaskResumeAll has not already done so, we may
\r
628 have put ourselves to sleep. */
\r
629 if( !xAlreadyYielded )
\r
636 /*-----------------------------------------------------------*/
\r
638 #if ( INCLUDE_vTaskDelay == 1 )
\r
640 void vTaskDelay( portTickType xTicksToDelay )
\r
642 portTickType xTimeToWake;
\r
643 signed portBASE_TYPE xAlreadyYielded = pdFALSE;
\r
645 /* A delay time of zero just forces a reschedule. */
\r
646 if( xTicksToDelay > ( portTickType ) 0 )
\r
652 /* A task that is removed from the event list while the
\r
653 scheduler is suspended will not get placed in the ready
\r
654 list or removed from the blocked list until the scheduler
\r
657 This task cannot be in an event list as it is the currently
\r
660 /* Calculate the time to wake - this may overflow but this is
\r
662 xTimeToWake = xTickCount + xTicksToDelay;
\r
664 /* We must remove ourselves from the ready list before adding
\r
665 ourselves to the blocked list as the same list item is used for
\r
667 vListRemove( ( xListItem * ) &( pxCurrentTCB->xGenericListItem ) );
\r
669 /* The list item will be inserted in wake time order. */
\r
670 listSET_LIST_ITEM_VALUE( &( pxCurrentTCB->xGenericListItem ), xTimeToWake );
\r
672 if( xTimeToWake < xTickCount )
\r
674 /* Wake time has overflowed. Place this item in the
\r
676 vListInsert( ( xList * ) pxOverflowDelayedTaskList, ( xListItem * ) &( pxCurrentTCB->xGenericListItem ) );
\r
680 /* The wake time has not overflowed, so we can use the
\r
681 current block list. */
\r
682 vListInsert( ( xList * ) pxDelayedTaskList, ( xListItem * ) &( pxCurrentTCB->xGenericListItem ) );
\r
685 xAlreadyYielded = xTaskResumeAll();
\r
688 /* Force a reschedule if xTaskResumeAll has not already done so, we may
\r
689 have put ourselves to sleep. */
\r
690 if( !xAlreadyYielded )
\r
697 /*-----------------------------------------------------------*/
\r
699 #if ( INCLUDE_uxTaskPriorityGet == 1 )
\r
701 unsigned portBASE_TYPE uxTaskPriorityGet( xTaskHandle pxTask )
\r
704 unsigned portBASE_TYPE uxReturn;
\r
706 taskENTER_CRITICAL();
\r
708 /* If null is passed in here then we are changing the
\r
709 priority of the calling function. */
\r
710 pxTCB = prvGetTCBFromHandle( pxTask );
\r
711 uxReturn = pxTCB->uxPriority;
\r
713 taskEXIT_CRITICAL();
\r
719 /*-----------------------------------------------------------*/
\r
721 #if ( INCLUDE_vTaskPrioritySet == 1 )
\r
723 void vTaskPrioritySet( xTaskHandle pxTask, unsigned portBASE_TYPE uxNewPriority )
\r
726 unsigned portBASE_TYPE uxCurrentPriority, xYieldRequired = pdFALSE;
\r
728 /* Ensure the new priority is valid. */
\r
729 if( uxNewPriority >= configMAX_PRIORITIES )
\r
731 uxNewPriority = configMAX_PRIORITIES - 1;
\r
734 taskENTER_CRITICAL();
\r
736 if( pxTask == pxCurrentTCB )
\r
741 /* If null is passed in here then we are changing the
\r
742 priority of the calling function. */
\r
743 pxTCB = prvGetTCBFromHandle( pxTask );
\r
745 traceTASK_PRIORITY_SET( pxTask, uxNewPriority );
\r
747 #if ( configUSE_MUTEXES == 1 )
\r
749 uxCurrentPriority = pxTCB->uxBasePriority;
\r
753 uxCurrentPriority = pxTCB->uxPriority;
\r
757 if( uxCurrentPriority != uxNewPriority )
\r
759 /* The priority change may have readied a task of higher
\r
760 priority than the calling task. */
\r
761 if( uxNewPriority > uxCurrentPriority )
\r
763 if( pxTask != NULL )
\r
765 /* The priority of another task is being raised. If we
\r
766 were raising the priority of the currently running task
\r
767 there would be no need to switch as it must have already
\r
768 been the highest priority task. */
\r
769 xYieldRequired = pdTRUE;
\r
772 else if( pxTask == NULL )
\r
774 /* Setting our own priority down means there may now be another
\r
775 task of higher priority that is ready to execute. */
\r
776 xYieldRequired = pdTRUE;
\r
781 #if ( configUSE_MUTEXES == 1 )
\r
783 /* Only change the priority being used if the task is not
\r
784 currently using an inherited priority. */
\r
785 if( pxTCB->uxBasePriority == pxTCB->uxPriority )
\r
787 pxTCB->uxPriority = uxNewPriority;
\r
790 /* The base priority gets set whatever. */
\r
791 pxTCB->uxBasePriority = uxNewPriority;
\r
795 pxTCB->uxPriority = uxNewPriority;
\r
799 listSET_LIST_ITEM_VALUE( &( pxTCB->xEventListItem ), ( configMAX_PRIORITIES - ( portTickType ) uxNewPriority ) );
\r
801 /* If the task is in the blocked or suspended list we need do
\r
802 nothing more than change it's priority variable. However, if
\r
803 the task is in a ready list it needs to be removed and placed
\r
804 in the queue appropriate to its new priority. */
\r
805 if( listIS_CONTAINED_WITHIN( &( pxReadyTasksLists[ uxCurrentPriority ] ), &( pxTCB->xGenericListItem ) ) )
\r
807 /* The task is currently in its ready list - remove before adding
\r
808 it to it's new ready list. As we are in a critical section we
\r
809 can do this even if the scheduler is suspended. */
\r
810 vListRemove( &( pxTCB->xGenericListItem ) );
\r
811 prvAddTaskToReadyQueue( pxTCB );
\r
814 if( xYieldRequired == pdTRUE )
\r
820 taskEXIT_CRITICAL();
\r
824 /*-----------------------------------------------------------*/
\r
826 #if ( INCLUDE_vTaskSuspend == 1 )
\r
828 void vTaskSuspend( xTaskHandle pxTaskToSuspend )
\r
832 taskENTER_CRITICAL();
\r
834 /* Ensure a yield is performed if the current task is being
\r
836 if( pxTaskToSuspend == pxCurrentTCB )
\r
838 pxTaskToSuspend = NULL;
\r
841 /* If null is passed in here then we are suspending ourselves. */
\r
842 pxTCB = prvGetTCBFromHandle( pxTaskToSuspend );
\r
844 traceTASK_SUSPEND( pxTCB );
\r
846 /* Remove task from the ready/delayed list and place in the suspended list. */
\r
847 vListRemove( &( pxTCB->xGenericListItem ) );
\r
849 /* Is the task waiting on an event also? */
\r
850 if( pxTCB->xEventListItem.pvContainer )
\r
852 vListRemove( &( pxTCB->xEventListItem ) );
\r
855 vListInsertEnd( ( xList * ) &xSuspendedTaskList, &( pxTCB->xGenericListItem ) );
\r
857 taskEXIT_CRITICAL();
\r
859 /* We may have just suspended the current task. */
\r
860 if( ( void * ) pxTaskToSuspend == NULL )
\r
867 /*-----------------------------------------------------------*/
\r
869 #if ( INCLUDE_vTaskSuspend == 1 )
\r
871 signed portBASE_TYPE xTaskIsTaskSuspended( xTaskHandle xTask )
\r
873 portBASE_TYPE xReturn = pdFALSE;
\r
874 const tskTCB * const pxTCB = ( tskTCB * ) xTask;
\r
876 /* Is the task we are attempting to resume actually in the
\r
878 if( listIS_CONTAINED_WITHIN( &xSuspendedTaskList, &( pxTCB->xGenericListItem ) ) != pdFALSE )
\r
880 /* Has the task already been resumed from within an ISR? */
\r
881 if( listIS_CONTAINED_WITHIN( &xPendingReadyList, &( pxTCB->xEventListItem ) ) != pdTRUE )
\r
883 /* Is it in the suspended list because it is in the
\r
884 Suspended state? It is possible to be in the suspended
\r
885 list because it is blocked on a task with no timeout
\r
887 if( listIS_CONTAINED_WITHIN( NULL, &( pxTCB->xEventListItem ) ) == pdTRUE )
\r
898 /*-----------------------------------------------------------*/
\r
900 #if ( INCLUDE_vTaskSuspend == 1 )
\r
902 void vTaskResume( xTaskHandle pxTaskToResume )
\r
906 /* Remove the task from whichever list it is currently in, and place
\r
907 it in the ready list. */
\r
908 pxTCB = ( tskTCB * ) pxTaskToResume;
\r
910 /* The parameter cannot be NULL as it is impossible to resume the
\r
911 currently executing task. */
\r
912 if( ( pxTCB != NULL ) && ( pxTCB != pxCurrentTCB ) )
\r
914 taskENTER_CRITICAL();
\r
916 if( xTaskIsTaskSuspended( pxTCB ) == pdTRUE )
\r
918 traceTASK_RESUME( pxTCB );
\r
920 /* As we are in a critical section we can access the ready
\r
921 lists even if the scheduler is suspended. */
\r
922 vListRemove( &( pxTCB->xGenericListItem ) );
\r
923 prvAddTaskToReadyQueue( pxTCB );
\r
925 /* We may have just resumed a higher priority task. */
\r
926 if( pxTCB->uxPriority >= pxCurrentTCB->uxPriority )
\r
928 /* This yield may not cause the task just resumed to run, but
\r
929 will leave the lists in the correct state for the next yield. */
\r
934 taskEXIT_CRITICAL();
\r
940 /*-----------------------------------------------------------*/
\r
942 #if ( ( INCLUDE_xTaskResumeFromISR == 1 ) && ( INCLUDE_vTaskSuspend == 1 ) )
\r
944 portBASE_TYPE xTaskResumeFromISR( xTaskHandle pxTaskToResume )
\r
946 portBASE_TYPE xYieldRequired = pdFALSE;
\r
949 pxTCB = ( tskTCB * ) pxTaskToResume;
\r
951 if( xTaskIsTaskSuspended( pxTCB ) == pdTRUE )
\r
953 traceTASK_RESUME_FROM_ISR( pxTCB );
\r
955 if( uxSchedulerSuspended == ( unsigned portBASE_TYPE ) pdFALSE )
\r
957 xYieldRequired = ( pxTCB->uxPriority >= pxCurrentTCB->uxPriority );
\r
958 vListRemove( &( pxTCB->xGenericListItem ) );
\r
959 prvAddTaskToReadyQueue( pxTCB );
\r
963 /* We cannot access the delayed or ready lists, so will hold this
\r
964 task pending until the scheduler is resumed, at which point a
\r
965 yield will be performed if necessary. */
\r
966 vListInsertEnd( ( xList * ) &( xPendingReadyList ), &( pxTCB->xEventListItem ) );
\r
970 return xYieldRequired;
\r
978 /*-----------------------------------------------------------
\r
979 * PUBLIC SCHEDULER CONTROL documented in task.h
\r
980 *----------------------------------------------------------*/
\r
983 void vTaskStartScheduler( void )
\r
985 portBASE_TYPE xReturn;
\r
987 /* Add the idle task at the lowest priority. */
\r
988 xReturn = xTaskCreate( prvIdleTask, ( signed portCHAR * ) "IDLE", tskIDLE_STACK_SIZE, ( void * ) NULL, tskIDLE_PRIORITY, ( xTaskHandle * ) NULL );
\r
990 if( xReturn == pdPASS )
\r
992 /* Interrupts are turned off here, to ensure a tick does not occur
\r
993 before or during the call to xPortStartScheduler(). The stacks of
\r
994 the created tasks contain a status word with interrupts switched on
\r
995 so interrupts will automatically get re-enabled when the first task
\r
998 STEPPING THROUGH HERE USING A DEBUGGER CAN CAUSE BIG PROBLEMS IF THE
\r
999 DEBUGGER ALLOWS INTERRUPTS TO BE PROCESSED. */
\r
1000 portDISABLE_INTERRUPTS();
\r
1002 xSchedulerRunning = pdTRUE;
\r
1003 xTickCount = ( portTickType ) 0;
\r
1005 /* If configGENERATE_RUN_TIME_STATS is defined then the following
\r
1006 macro must be defined to configure the timer/counter used to generate
\r
1007 the run time counter time base. */
\r
1008 portCONFIGURE_TIMER_FOR_RUN_TIME_STATS();
\r
1010 /* Setting up the timer tick is hardware specific and thus in the
\r
1011 portable interface. */
\r
1012 if( xPortStartScheduler() )
\r
1014 /* Should not reach here as if the scheduler is running the
\r
1015 function will not return. */
\r
1019 /* Should only reach here if a task calls xTaskEndScheduler(). */
\r
1023 /*-----------------------------------------------------------*/
\r
1025 void vTaskEndScheduler( void )
\r
1027 /* Stop the scheduler interrupts and call the portable scheduler end
\r
1028 routine so the original ISRs can be restored if necessary. The port
\r
1029 layer must ensure interrupts enable bit is left in the correct state. */
\r
1030 portDISABLE_INTERRUPTS();
\r
1031 xSchedulerRunning = pdFALSE;
\r
1032 vPortEndScheduler();
\r
1034 /*----------------------------------------------------------*/
\r
1036 void vTaskSuspendAll( void )
\r
1038 /* A critical section is not required as the variable is of type
\r
1040 ++uxSchedulerSuspended;
\r
1042 /*----------------------------------------------------------*/
\r
1044 signed portBASE_TYPE xTaskResumeAll( void )
\r
1046 register tskTCB *pxTCB;
\r
1047 signed portBASE_TYPE xAlreadyYielded = pdFALSE;
\r
1049 /* It is possible that an ISR caused a task to be removed from an event
\r
1050 list while the scheduler was suspended. If this was the case then the
\r
1051 removed task will have been added to the xPendingReadyList. Once the
\r
1052 scheduler has been resumed it is safe to move all the pending ready
\r
1053 tasks from this list into their appropriate ready list. */
\r
1054 portENTER_CRITICAL();
\r
1056 --uxSchedulerSuspended;
\r
1058 if( uxSchedulerSuspended == ( unsigned portBASE_TYPE ) pdFALSE )
\r
1060 if( uxCurrentNumberOfTasks > ( unsigned portBASE_TYPE ) 0 )
\r
1062 portBASE_TYPE xYieldRequired = pdFALSE;
\r
1064 /* Move any readied tasks from the pending list into the
\r
1065 appropriate ready list. */
\r
1066 while( ( pxTCB = ( tskTCB * ) listGET_OWNER_OF_HEAD_ENTRY( ( ( xList * ) &xPendingReadyList ) ) ) != NULL )
\r
1068 vListRemove( &( pxTCB->xEventListItem ) );
\r
1069 vListRemove( &( pxTCB->xGenericListItem ) );
\r
1070 prvAddTaskToReadyQueue( pxTCB );
\r
1072 /* If we have moved a task that has a priority higher than
\r
1073 the current task then we should yield. */
\r
1074 if( pxTCB->uxPriority >= pxCurrentTCB->uxPriority )
\r
1076 xYieldRequired = pdTRUE;
\r
1080 /* If any ticks occurred while the scheduler was suspended then
\r
1081 they should be processed now. This ensures the tick count does not
\r
1082 slip, and that any delayed tasks are resumed at the correct time. */
\r
1083 if( uxMissedTicks > ( unsigned portBASE_TYPE ) 0 )
\r
1085 while( uxMissedTicks > ( unsigned portBASE_TYPE ) 0 )
\r
1087 vTaskIncrementTick();
\r
1091 /* As we have processed some ticks it is appropriate to yield
\r
1092 to ensure the highest priority task that is ready to run is
\r
1093 the task actually running. */
\r
1094 #if configUSE_PREEMPTION == 1
\r
1096 xYieldRequired = pdTRUE;
\r
1101 if( ( xYieldRequired == pdTRUE ) || ( xMissedYield == pdTRUE ) )
\r
1103 xAlreadyYielded = pdTRUE;
\r
1104 xMissedYield = pdFALSE;
\r
1110 portEXIT_CRITICAL();
\r
1112 return xAlreadyYielded;
\r
1120 /*-----------------------------------------------------------
\r
1121 * PUBLIC TASK UTILITIES documented in task.h
\r
1122 *----------------------------------------------------------*/
\r
1126 portTickType xTaskGetTickCount( void )
\r
1128 portTickType xTicks;
\r
1130 /* Critical section required if running on a 16 bit processor. */
\r
1131 taskENTER_CRITICAL();
\r
1133 xTicks = xTickCount;
\r
1135 taskEXIT_CRITICAL();
\r
1139 /*-----------------------------------------------------------*/
\r
1141 unsigned portBASE_TYPE uxTaskGetNumberOfTasks( void )
\r
1143 /* A critical section is not required because the variables are of type
\r
1145 return uxCurrentNumberOfTasks;
\r
1147 /*-----------------------------------------------------------*/
\r
1149 #if ( configUSE_TRACE_FACILITY == 1 )
\r
1151 void vTaskList( signed portCHAR *pcWriteBuffer )
\r
1153 unsigned portBASE_TYPE uxQueue;
\r
1155 /* This is a VERY costly function that should be used for debug only.
\r
1156 It leaves interrupts disabled for a LONG time. */
\r
1158 vTaskSuspendAll();
\r
1160 /* Run through all the lists that could potentially contain a TCB and
\r
1161 report the task name, state and stack high water mark. */
\r
1163 pcWriteBuffer[ 0 ] = ( signed portCHAR ) 0x00;
\r
1164 strcat( ( portCHAR * ) pcWriteBuffer, ( const portCHAR * ) "\r\n" );
\r
1166 uxQueue = uxTopUsedPriority + 1;
\r
1172 if( !listLIST_IS_EMPTY( &( pxReadyTasksLists[ uxQueue ] ) ) )
\r
1174 prvListTaskWithinSingleList( pcWriteBuffer, ( xList * ) &( pxReadyTasksLists[ uxQueue ] ), tskREADY_CHAR );
\r
1176 }while( uxQueue > ( unsigned portSHORT ) tskIDLE_PRIORITY );
\r
1178 if( !listLIST_IS_EMPTY( pxDelayedTaskList ) )
\r
1180 prvListTaskWithinSingleList( pcWriteBuffer, ( xList * ) pxDelayedTaskList, tskBLOCKED_CHAR );
\r
1183 if( !listLIST_IS_EMPTY( pxOverflowDelayedTaskList ) )
\r
1185 prvListTaskWithinSingleList( pcWriteBuffer, ( xList * ) pxOverflowDelayedTaskList, tskBLOCKED_CHAR );
\r
1188 #if( INCLUDE_vTaskDelete == 1 )
\r
1190 if( !listLIST_IS_EMPTY( &xTasksWaitingTermination ) )
\r
1192 prvListTaskWithinSingleList( pcWriteBuffer, ( xList * ) &xTasksWaitingTermination, tskDELETED_CHAR );
\r
1197 #if ( INCLUDE_vTaskSuspend == 1 )
\r
1199 if( !listLIST_IS_EMPTY( &xSuspendedTaskList ) )
\r
1201 prvListTaskWithinSingleList( pcWriteBuffer, ( xList * ) &xSuspendedTaskList, tskSUSPENDED_CHAR );
\r
1210 /*----------------------------------------------------------*/
\r
1212 #if ( configGENERATE_RUN_TIME_STATS == 1 )
\r
1214 void vTaskGetRunTimeStats( signed portCHAR *pcWriteBuffer )
\r
1216 unsigned portBASE_TYPE uxQueue;
\r
1217 unsigned portLONG ulTotalRunTime = portGET_RUN_TIME_COUNTER_VALUE();
\r
1219 /* This is a VERY costly function that should be used for debug only.
\r
1220 It leaves interrupts disabled for a LONG time. */
\r
1222 vTaskSuspendAll();
\r
1224 /* Run through all the lists that could potentially contain a TCB,
\r
1225 generating a table of run timer percentages in the provided
\r
1228 pcWriteBuffer[ 0 ] = ( signed portCHAR ) 0x00;
\r
1229 strcat( ( portCHAR * ) pcWriteBuffer, ( const portCHAR * ) "\r\n" );
\r
1231 uxQueue = uxTopUsedPriority + 1;
\r
1237 if( !listLIST_IS_EMPTY( &( pxReadyTasksLists[ uxQueue ] ) ) )
\r
1239 prvGenerateRunTimeStatsForTasksInList( pcWriteBuffer, ( xList * ) &( pxReadyTasksLists[ uxQueue ] ), ulTotalRunTime );
\r
1241 }while( uxQueue > ( unsigned portSHORT ) tskIDLE_PRIORITY );
\r
1243 if( !listLIST_IS_EMPTY( pxDelayedTaskList ) )
\r
1245 prvGenerateRunTimeStatsForTasksInList( pcWriteBuffer, ( xList * ) pxDelayedTaskList, ulTotalRunTime );
\r
1248 if( !listLIST_IS_EMPTY( pxOverflowDelayedTaskList ) )
\r
1250 prvGenerateRunTimeStatsForTasksInList( pcWriteBuffer, ( xList * ) pxOverflowDelayedTaskList, ulTotalRunTime );
\r
1253 #if ( INCLUDE_vTaskDelete == 1 )
\r
1255 if( !listLIST_IS_EMPTY( &xTasksWaitingTermination ) )
\r
1257 prvGenerateRunTimeStatsForTasksInList( pcWriteBuffer, ( xList * ) &xTasksWaitingTermination, ulTotalRunTime );
\r
1262 #if ( INCLUDE_vTaskSuspend == 1 )
\r
1264 if( !listLIST_IS_EMPTY( &xSuspendedTaskList ) )
\r
1266 prvGenerateRunTimeStatsForTasksInList( pcWriteBuffer, ( xList * ) &xSuspendedTaskList, ulTotalRunTime );
\r
1275 /*----------------------------------------------------------*/
\r
1277 #if ( configUSE_TRACE_FACILITY == 1 )
\r
1279 void vTaskStartTrace( signed portCHAR * pcBuffer, unsigned portLONG ulBufferSize )
\r
1281 portENTER_CRITICAL();
\r
1283 pcTraceBuffer = ( signed portCHAR * )pcBuffer;
\r
1284 pcTraceBufferStart = pcBuffer;
\r
1285 pcTraceBufferEnd = pcBuffer + ( ulBufferSize - tskSIZE_OF_EACH_TRACE_LINE );
\r
1286 xTracing = pdTRUE;
\r
1288 portEXIT_CRITICAL();
\r
1292 /*----------------------------------------------------------*/
\r
1294 #if ( configUSE_TRACE_FACILITY == 1 )
\r
1296 unsigned portLONG ulTaskEndTrace( void )
\r
1298 unsigned portLONG ulBufferLength;
\r
1300 portENTER_CRITICAL();
\r
1301 xTracing = pdFALSE;
\r
1302 portEXIT_CRITICAL();
\r
1304 ulBufferLength = ( unsigned portLONG ) ( pcTraceBuffer - pcTraceBufferStart );
\r
1306 return ulBufferLength;
\r
1313 /*-----------------------------------------------------------
\r
1314 * SCHEDULER INTERNALS AVAILABLE FOR PORTING PURPOSES
\r
1315 * documented in task.h
\r
1316 *----------------------------------------------------------*/
\r
1319 void vTaskIncrementTick( void )
\r
1321 /* Called by the portable layer each time a tick interrupt occurs.
\r
1322 Increments the tick then checks to see if the new tick value will cause any
\r
1323 tasks to be unblocked. */
\r
1324 if( uxSchedulerSuspended == ( unsigned portBASE_TYPE ) pdFALSE )
\r
1327 if( xTickCount == ( portTickType ) 0 )
\r
1331 /* Tick count has overflowed so we need to swap the delay lists.
\r
1332 If there are any items in pxDelayedTaskList here then there is
\r
1334 pxTemp = pxDelayedTaskList;
\r
1335 pxDelayedTaskList = pxOverflowDelayedTaskList;
\r
1336 pxOverflowDelayedTaskList = pxTemp;
\r
1337 xNumOfOverflows++;
\r
1340 /* See if this tick has made a timeout expire. */
\r
1341 prvCheckDelayedTasks();
\r
1347 /* The tick hook gets called at regular intervals, even if the
\r
1348 scheduler is locked. */
\r
1349 #if ( configUSE_TICK_HOOK == 1 )
\r
1351 extern void vApplicationTickHook( void );
\r
1353 vApplicationTickHook();
\r
1358 #if ( configUSE_TICK_HOOK == 1 )
\r
1360 extern void vApplicationTickHook( void );
\r
1362 /* Guard against the tick hook being called when the missed tick
\r
1363 count is being unwound (when the scheduler is being unlocked. */
\r
1364 if( uxMissedTicks == 0 )
\r
1366 vApplicationTickHook();
\r
1371 traceTASK_INCREMENT_TICK( xTickCount );
\r
1373 /*-----------------------------------------------------------*/
\r
1375 #if ( ( INCLUDE_vTaskCleanUpResources == 1 ) && ( INCLUDE_vTaskSuspend == 1 ) )
\r
1377 void vTaskCleanUpResources( void )
\r
1379 unsigned portSHORT usQueue;
\r
1380 volatile tskTCB *pxTCB;
\r
1382 usQueue = ( unsigned portSHORT ) uxTopUsedPriority + ( unsigned portSHORT ) 1;
\r
1384 /* Remove any TCB's from the ready queues. */
\r
1389 while( !listLIST_IS_EMPTY( &( pxReadyTasksLists[ usQueue ] ) ) )
\r
1391 listGET_OWNER_OF_NEXT_ENTRY( pxTCB, &( pxReadyTasksLists[ usQueue ] ) );
\r
1392 vListRemove( ( xListItem * ) &( pxTCB->xGenericListItem ) );
\r
1394 prvDeleteTCB( ( tskTCB * ) pxTCB );
\r
1396 }while( usQueue > ( unsigned portSHORT ) tskIDLE_PRIORITY );
\r
1398 /* Remove any TCB's from the delayed queue. */
\r
1399 while( !listLIST_IS_EMPTY( &xDelayedTaskList1 ) )
\r
1401 listGET_OWNER_OF_NEXT_ENTRY( pxTCB, &xDelayedTaskList1 );
\r
1402 vListRemove( ( xListItem * ) &( pxTCB->xGenericListItem ) );
\r
1404 prvDeleteTCB( ( tskTCB * ) pxTCB );
\r
1407 /* Remove any TCB's from the overflow delayed queue. */
\r
1408 while( !listLIST_IS_EMPTY( &xDelayedTaskList2 ) )
\r
1410 listGET_OWNER_OF_NEXT_ENTRY( pxTCB, &xDelayedTaskList2 );
\r
1411 vListRemove( ( xListItem * ) &( pxTCB->xGenericListItem ) );
\r
1413 prvDeleteTCB( ( tskTCB * ) pxTCB );
\r
1416 while( !listLIST_IS_EMPTY( &xSuspendedTaskList ) )
\r
1418 listGET_OWNER_OF_NEXT_ENTRY( pxTCB, &xSuspendedTaskList );
\r
1419 vListRemove( ( xListItem * ) &( pxTCB->xGenericListItem ) );
\r
1421 prvDeleteTCB( ( tskTCB * ) pxTCB );
\r
1426 /*-----------------------------------------------------------*/
\r
1428 #if ( configUSE_APPLICATION_TASK_TAG == 1 )
\r
1430 void vTaskSetApplicationTaskTag( xTaskHandle xTask, pdTASK_HOOK_CODE pxTagValue )
\r
1434 /* If xTask is NULL then we are setting our own task hook. */
\r
1435 if( xTask == NULL )
\r
1437 xTCB = ( tskTCB * ) pxCurrentTCB;
\r
1441 xTCB = ( tskTCB * ) xTask;
\r
1444 /* Save the hook function in the TCB. A critical section is required as
\r
1445 the value can be accessed from an interrupt. */
\r
1446 portENTER_CRITICAL();
\r
1447 xTCB->pxTaskTag = pxTagValue;
\r
1448 portEXIT_CRITICAL();
\r
1452 /*-----------------------------------------------------------*/
\r
1454 #if ( configUSE_APPLICATION_TASK_TAG == 1 )
\r
1456 pdTASK_HOOK_CODE xTaskGetApplicationTaskTag( xTaskHandle xTask )
\r
1459 pdTASK_HOOK_CODE xReturn;
\r
1461 /* If xTask is NULL then we are setting our own task hook. */
\r
1462 if( xTask == NULL )
\r
1464 xTCB = ( tskTCB * ) pxCurrentTCB;
\r
1468 xTCB = ( tskTCB * ) xTask;
\r
1471 /* Save the hook function in the TCB. A critical section is required as
\r
1472 the value can be accessed from an interrupt. */
\r
1473 portENTER_CRITICAL();
\r
1474 xReturn = xTCB->pxTaskTag;
\r
1475 portEXIT_CRITICAL();
\r
1481 /*-----------------------------------------------------------*/
\r
1483 #if ( configUSE_APPLICATION_TASK_TAG == 1 )
\r
1485 portBASE_TYPE xTaskCallApplicationTaskHook( xTaskHandle xTask, void *pvParameter )
\r
1488 portBASE_TYPE xReturn;
\r
1490 /* If xTask is NULL then we are calling our own task hook. */
\r
1491 if( xTask == NULL )
\r
1493 xTCB = ( tskTCB * ) pxCurrentTCB;
\r
1497 xTCB = ( tskTCB * ) xTask;
\r
1500 if( xTCB->pxTaskTag != NULL )
\r
1502 xReturn = xTCB->pxTaskTag( pvParameter );
\r
1513 /*-----------------------------------------------------------*/
\r
1515 void vTaskSwitchContext( void )
\r
1517 if( uxSchedulerSuspended != ( unsigned portBASE_TYPE ) pdFALSE )
\r
1519 /* The scheduler is currently suspended - do not allow a context
\r
1521 xMissedYield = pdTRUE;
\r
1525 traceTASK_SWITCHED_OUT();
\r
1527 #if ( configGENERATE_RUN_TIME_STATS == 1 )
\r
1529 unsigned portLONG ulTempCounter = portGET_RUN_TIME_COUNTER_VALUE();
\r
1531 /* Add the amount of time the task has been running to the accumulated
\r
1532 time so far. The time the task started running was stored in
\r
1533 ulTaskSwitchedInTime. Note that there is no overflow protection here
\r
1534 so count values are only valid until the timer overflows. Generally
\r
1535 this will be about 1 hour assuming a 1uS timer increment. */
\r
1536 pxCurrentTCB->ulRunTimeCounter += ( ulTempCounter - ulTaskSwitchedInTime );
\r
1537 ulTaskSwitchedInTime = ulTempCounter;
\r
1541 taskFIRST_CHECK_FOR_STACK_OVERFLOW();
\r
1542 taskSECOND_CHECK_FOR_STACK_OVERFLOW();
\r
1544 /* Find the highest priority queue that contains ready tasks. */
\r
1545 while( listLIST_IS_EMPTY( &( pxReadyTasksLists[ uxTopReadyPriority ] ) ) )
\r
1547 --uxTopReadyPriority;
\r
1550 /* listGET_OWNER_OF_NEXT_ENTRY walks through the list, so the tasks of the
\r
1551 same priority get an equal share of the processor time. */
\r
1552 listGET_OWNER_OF_NEXT_ENTRY( pxCurrentTCB, &( pxReadyTasksLists[ uxTopReadyPriority ] ) );
\r
1554 traceTASK_SWITCHED_IN();
\r
1555 vWriteTraceToBuffer();
\r
1557 /*-----------------------------------------------------------*/
\r
1559 void vTaskPlaceOnEventList( const xList * const pxEventList, portTickType xTicksToWait )
\r
1561 portTickType xTimeToWake;
\r
1563 /* THIS FUNCTION MUST BE CALLED WITH INTERRUPTS DISABLED OR THE
\r
1564 SCHEDULER SUSPENDED. */
\r
1566 /* Place the event list item of the TCB in the appropriate event list.
\r
1567 This is placed in the list in priority order so the highest priority task
\r
1568 is the first to be woken by the event. */
\r
1569 vListInsert( ( xList * ) pxEventList, ( xListItem * ) &( pxCurrentTCB->xEventListItem ) );
\r
1571 /* We must remove ourselves from the ready list before adding ourselves
\r
1572 to the blocked list as the same list item is used for both lists. We have
\r
1573 exclusive access to the ready lists as the scheduler is locked. */
\r
1574 vListRemove( ( xListItem * ) &( pxCurrentTCB->xGenericListItem ) );
\r
1577 #if ( INCLUDE_vTaskSuspend == 1 )
\r
1579 if( xTicksToWait == portMAX_DELAY )
\r
1581 /* Add ourselves to the suspended task list instead of a delayed task
\r
1582 list to ensure we are not woken by a timing event. We will block
\r
1584 vListInsertEnd( ( xList * ) &xSuspendedTaskList, ( xListItem * ) &( pxCurrentTCB->xGenericListItem ) );
\r
1588 /* Calculate the time at which the task should be woken if the event does
\r
1589 not occur. This may overflow but this doesn't matter. */
\r
1590 xTimeToWake = xTickCount + xTicksToWait;
\r
1592 listSET_LIST_ITEM_VALUE( &( pxCurrentTCB->xGenericListItem ), xTimeToWake );
\r
1594 if( xTimeToWake < xTickCount )
\r
1596 /* Wake time has overflowed. Place this item in the overflow list. */
\r
1597 vListInsert( ( xList * ) pxOverflowDelayedTaskList, ( xListItem * ) &( pxCurrentTCB->xGenericListItem ) );
\r
1601 /* The wake time has not overflowed, so we can use the current block list. */
\r
1602 vListInsert( ( xList * ) pxDelayedTaskList, ( xListItem * ) &( pxCurrentTCB->xGenericListItem ) );
\r
1608 /* Calculate the time at which the task should be woken if the event does
\r
1609 not occur. This may overflow but this doesn't matter. */
\r
1610 xTimeToWake = xTickCount + xTicksToWait;
\r
1612 listSET_LIST_ITEM_VALUE( &( pxCurrentTCB->xGenericListItem ), xTimeToWake );
\r
1614 if( xTimeToWake < xTickCount )
\r
1616 /* Wake time has overflowed. Place this item in the overflow list. */
\r
1617 vListInsert( ( xList * ) pxOverflowDelayedTaskList, ( xListItem * ) &( pxCurrentTCB->xGenericListItem ) );
\r
1621 /* The wake time has not overflowed, so we can use the current block list. */
\r
1622 vListInsert( ( xList * ) pxDelayedTaskList, ( xListItem * ) &( pxCurrentTCB->xGenericListItem ) );
\r
1627 /*-----------------------------------------------------------*/
\r
1629 signed portBASE_TYPE xTaskRemoveFromEventList( const xList * const pxEventList )
\r
1631 tskTCB *pxUnblockedTCB;
\r
1632 portBASE_TYPE xReturn;
\r
1634 /* THIS FUNCTION MUST BE CALLED WITH INTERRUPTS DISABLED OR THE
\r
1635 SCHEDULER SUSPENDED. It can also be called from within an ISR. */
\r
1637 /* The event list is sorted in priority order, so we can remove the
\r
1638 first in the list, remove the TCB from the delayed list, and add
\r
1639 it to the ready list.
\r
1641 If an event is for a queue that is locked then this function will never
\r
1642 get called - the lock count on the queue will get modified instead. This
\r
1643 means we can always expect exclusive access to the event list here. */
\r
1644 pxUnblockedTCB = ( tskTCB * ) listGET_OWNER_OF_HEAD_ENTRY( pxEventList );
\r
1645 vListRemove( &( pxUnblockedTCB->xEventListItem ) );
\r
1647 if( uxSchedulerSuspended == ( unsigned portBASE_TYPE ) pdFALSE )
\r
1649 vListRemove( &( pxUnblockedTCB->xGenericListItem ) );
\r
1650 prvAddTaskToReadyQueue( pxUnblockedTCB );
\r
1654 /* We cannot access the delayed or ready lists, so will hold this
\r
1655 task pending until the scheduler is resumed. */
\r
1656 vListInsertEnd( ( xList * ) &( xPendingReadyList ), &( pxUnblockedTCB->xEventListItem ) );
\r
1659 if( pxUnblockedTCB->uxPriority >= pxCurrentTCB->uxPriority )
\r
1661 /* Return true if the task removed from the event list has
\r
1662 a higher priority than the calling task. This allows
\r
1663 the calling task to know if it should force a context
\r
1669 xReturn = pdFALSE;
\r
1674 /*-----------------------------------------------------------*/
\r
1676 void vTaskSetTimeOutState( xTimeOutType * const pxTimeOut )
\r
1678 pxTimeOut->xOverflowCount = xNumOfOverflows;
\r
1679 pxTimeOut->xTimeOnEntering = xTickCount;
\r
1681 /*-----------------------------------------------------------*/
\r
1683 portBASE_TYPE xTaskCheckForTimeOut( xTimeOutType * const pxTimeOut, portTickType * const pxTicksToWait )
\r
1685 portBASE_TYPE xReturn;
\r
1687 portENTER_CRITICAL();
\r
1689 #if ( INCLUDE_vTaskSuspend == 1 )
\r
1690 /* If INCLUDE_vTaskSuspend is set to 1 and the block time specified is
\r
1691 the maximum block time then the task should block indefinitely, and
\r
1692 therefore never time out. */
\r
1693 if( *pxTicksToWait == portMAX_DELAY )
\r
1695 xReturn = pdFALSE;
\r
1697 else /* We are not blocking indefinitely, perform the checks below. */
\r
1700 if( ( xNumOfOverflows != pxTimeOut->xOverflowCount ) && ( xTickCount >= pxTimeOut->xTimeOnEntering ) )
\r
1702 /* The tick count is greater than the time at which vTaskSetTimeout()
\r
1703 was called, but has also overflowed since vTaskSetTimeOut() was called.
\r
1704 It must have wrapped all the way around and gone past us again. This
\r
1705 passed since vTaskSetTimeout() was called. */
\r
1708 else if( ( xTickCount - pxTimeOut->xTimeOnEntering ) < *pxTicksToWait )
\r
1710 /* Not a genuine timeout. Adjust parameters for time remaining. */
\r
1711 *pxTicksToWait -= ( xTickCount - pxTimeOut->xTimeOnEntering );
\r
1712 vTaskSetTimeOutState( pxTimeOut );
\r
1713 xReturn = pdFALSE;
\r
1720 portEXIT_CRITICAL();
\r
1724 /*-----------------------------------------------------------*/
\r
1726 void vTaskMissedYield( void )
\r
1728 xMissedYield = pdTRUE;
\r
1732 * -----------------------------------------------------------
\r
1734 * ----------------------------------------------------------
\r
1736 * The portTASK_FUNCTION() macro is used to allow port/compiler specific
\r
1737 * language extensions. The equivalent prototype for this function is:
\r
1739 * void prvIdleTask( void *pvParameters );
\r
1742 static portTASK_FUNCTION( prvIdleTask, pvParameters )
\r
1744 /* Stop warnings. */
\r
1745 ( void ) pvParameters;
\r
1749 /* See if any tasks have been deleted. */
\r
1750 prvCheckTasksWaitingTermination();
\r
1752 #if ( configUSE_PREEMPTION == 0 )
\r
1754 /* If we are not using preemption we keep forcing a task switch to
\r
1755 see if any other task has become available. If we are using
\r
1756 preemption we don't need to do this as any task becoming available
\r
1757 will automatically get the processor anyway. */
\r
1762 #if ( ( configUSE_PREEMPTION == 1 ) && ( configIDLE_SHOULD_YIELD == 1 ) )
\r
1764 /* When using preemption tasks of equal priority will be
\r
1765 timesliced. If a task that is sharing the idle priority is ready
\r
1766 to run then the idle task should yield before the end of the
\r
1769 A critical region is not required here as we are just reading from
\r
1770 the list, and an occasional incorrect value will not matter. If
\r
1771 the ready list at the idle priority contains more than one task
\r
1772 then a task other than the idle task is ready to execute. */
\r
1773 if( listCURRENT_LIST_LENGTH( &( pxReadyTasksLists[ tskIDLE_PRIORITY ] ) ) > ( unsigned portBASE_TYPE ) 1 )
\r
1780 #if ( configUSE_IDLE_HOOK == 1 )
\r
1782 extern void vApplicationIdleHook( void );
\r
1784 /* Call the user defined function from within the idle task. This
\r
1785 allows the application designer to add background functionality
\r
1786 without the overhead of a separate task.
\r
1787 NOTE: vApplicationIdleHook() MUST NOT, UNDER ANY CIRCUMSTANCES,
\r
1788 CALL A FUNCTION THAT MIGHT BLOCK. */
\r
1789 vApplicationIdleHook();
\r
1793 } /*lint !e715 pvParameters is not accessed but all task functions require the same prototype. */
\r
1801 /*-----------------------------------------------------------
\r
1802 * File private functions documented at the top of the file.
\r
1803 *----------------------------------------------------------*/
\r
1807 static void prvInitialiseTCBVariables( tskTCB *pxTCB, const signed portCHAR * const pcName, unsigned portBASE_TYPE uxPriority )
\r
1809 /* Store the function name in the TCB. */
\r
1810 #if configMAX_TASK_NAME_LEN > 1
\r
1812 /* Don't bring strncpy into the build unnecessarily. */
\r
1813 strncpy( ( char * ) pxTCB->pcTaskName, ( const char * ) pcName, ( unsigned portSHORT ) configMAX_TASK_NAME_LEN );
\r
1816 pxTCB->pcTaskName[ ( unsigned portSHORT ) configMAX_TASK_NAME_LEN - ( unsigned portSHORT ) 1 ] = '\0';
\r
1818 /* This is used as an array index so must ensure it's not too large. */
\r
1819 if( uxPriority >= configMAX_PRIORITIES )
\r
1821 uxPriority = configMAX_PRIORITIES - 1;
\r
1824 pxTCB->uxPriority = uxPriority;
\r
1825 #if ( configUSE_MUTEXES == 1 )
\r
1827 pxTCB->uxBasePriority = uxPriority;
\r
1831 vListInitialiseItem( &( pxTCB->xGenericListItem ) );
\r
1832 vListInitialiseItem( &( pxTCB->xEventListItem ) );
\r
1834 /* Set the pxTCB as a link back from the xListItem. This is so we can get
\r
1835 back to the containing TCB from a generic item in a list. */
\r
1836 listSET_LIST_ITEM_OWNER( &( pxTCB->xGenericListItem ), pxTCB );
\r
1838 /* Event lists are always in priority order. */
\r
1839 listSET_LIST_ITEM_VALUE( &( pxTCB->xEventListItem ), configMAX_PRIORITIES - ( portTickType ) uxPriority );
\r
1840 listSET_LIST_ITEM_OWNER( &( pxTCB->xEventListItem ), pxTCB );
\r
1842 #if ( portCRITICAL_NESTING_IN_TCB == 1 )
\r
1844 pxTCB->uxCriticalNesting = ( unsigned portBASE_TYPE ) 0;
\r
1848 #if ( configUSE_APPLICATION_TASK_TAG == 1 )
\r
1850 pxTCB->pxTaskTag = NULL;
\r
1854 #if ( configGENERATE_RUN_TIME_STATS == 1 )
\r
1856 pxTCB->ulRunTimeCounter = 0UL;
\r
1860 /*-----------------------------------------------------------*/
\r
1862 static void prvInitialiseTaskLists( void )
\r
1864 unsigned portBASE_TYPE uxPriority;
\r
1866 for( uxPriority = 0; uxPriority < configMAX_PRIORITIES; uxPriority++ )
\r
1868 vListInitialise( ( xList * ) &( pxReadyTasksLists[ uxPriority ] ) );
\r
1871 vListInitialise( ( xList * ) &xDelayedTaskList1 );
\r
1872 vListInitialise( ( xList * ) &xDelayedTaskList2 );
\r
1873 vListInitialise( ( xList * ) &xPendingReadyList );
\r
1875 #if ( INCLUDE_vTaskDelete == 1 )
\r
1877 vListInitialise( ( xList * ) &xTasksWaitingTermination );
\r
1881 #if ( INCLUDE_vTaskSuspend == 1 )
\r
1883 vListInitialise( ( xList * ) &xSuspendedTaskList );
\r
1887 /* Start with pxDelayedTaskList using list1 and the pxOverflowDelayedTaskList
\r
1889 pxDelayedTaskList = &xDelayedTaskList1;
\r
1890 pxOverflowDelayedTaskList = &xDelayedTaskList2;
\r
1892 /*-----------------------------------------------------------*/
\r
1894 static void prvCheckTasksWaitingTermination( void )
\r
1896 #if ( INCLUDE_vTaskDelete == 1 )
\r
1898 portBASE_TYPE xListIsEmpty;
\r
1900 /* ucTasksDeleted is used to prevent vTaskSuspendAll() being called
\r
1901 too often in the idle task. */
\r
1902 if( uxTasksDeleted > ( unsigned portBASE_TYPE ) 0 )
\r
1904 vTaskSuspendAll();
\r
1905 xListIsEmpty = listLIST_IS_EMPTY( &xTasksWaitingTermination );
\r
1908 if( !xListIsEmpty )
\r
1912 portENTER_CRITICAL();
\r
1914 pxTCB = ( tskTCB * ) listGET_OWNER_OF_HEAD_ENTRY( ( ( xList * ) &xTasksWaitingTermination ) );
\r
1915 vListRemove( &( pxTCB->xGenericListItem ) );
\r
1916 --uxCurrentNumberOfTasks;
\r
1919 portEXIT_CRITICAL();
\r
1921 prvDeleteTCB( pxTCB );
\r
1927 /*-----------------------------------------------------------*/
\r
1929 static tskTCB *prvAllocateTCBAndStack( unsigned portSHORT usStackDepth )
\r
1933 /* Allocate space for the TCB. Where the memory comes from depends on
\r
1934 the implementation of the port malloc function. */
\r
1935 pxNewTCB = ( tskTCB * ) pvPortMalloc( sizeof( tskTCB ) );
\r
1937 if( pxNewTCB != NULL )
\r
1939 /* Allocate space for the stack used by the task being created.
\r
1940 The base of the stack memory stored in the TCB so the task can
\r
1941 be deleted later if required. */
\r
1942 pxNewTCB->pxStack = ( portSTACK_TYPE * ) pvPortMalloc( ( ( size_t )usStackDepth ) * sizeof( portSTACK_TYPE ) );
\r
1944 if( pxNewTCB->pxStack == NULL )
\r
1946 /* Could not allocate the stack. Delete the allocated TCB. */
\r
1947 vPortFree( pxNewTCB );
\r
1952 /* Just to help debugging. */
\r
1953 memset( pxNewTCB->pxStack, tskSTACK_FILL_BYTE, usStackDepth * sizeof( portSTACK_TYPE ) );
\r
1959 /*-----------------------------------------------------------*/
\r
1961 #if ( configUSE_TRACE_FACILITY == 1 )
\r
1963 static void prvListTaskWithinSingleList( const signed portCHAR *pcWriteBuffer, xList *pxList, signed portCHAR cStatus )
\r
1965 volatile tskTCB *pxNextTCB, *pxFirstTCB;
\r
1966 unsigned portSHORT usStackRemaining;
\r
1968 /* Write the details of all the TCB's in pxList into the buffer. */
\r
1969 listGET_OWNER_OF_NEXT_ENTRY( pxFirstTCB, pxList );
\r
1972 listGET_OWNER_OF_NEXT_ENTRY( pxNextTCB, pxList );
\r
1973 usStackRemaining = usTaskCheckFreeStackSpace( ( unsigned portCHAR * ) pxNextTCB->pxStack );
\r
1974 sprintf( pcStatusString, ( portCHAR * ) "%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
1975 strcat( ( portCHAR * ) pcWriteBuffer, ( portCHAR * ) pcStatusString );
\r
1977 } while( pxNextTCB != pxFirstTCB );
\r
1981 /*-----------------------------------------------------------*/
\r
1983 #if ( configGENERATE_RUN_TIME_STATS == 1 )
\r
1985 static void prvGenerateRunTimeStatsForTasksInList( const signed portCHAR *pcWriteBuffer, xList *pxList, unsigned portLONG ulTotalRunTime )
\r
1987 volatile tskTCB *pxNextTCB, *pxFirstTCB;
\r
1988 unsigned portLONG ulStatsAsPercentage;
\r
1990 /* Write the run time stats of all the TCB's in pxList into the buffer. */
\r
1991 listGET_OWNER_OF_NEXT_ENTRY( pxFirstTCB, pxList );
\r
1994 /* Get next TCB in from the list. */
\r
1995 listGET_OWNER_OF_NEXT_ENTRY( pxNextTCB, pxList );
\r
1997 /* Divide by zero check. */
\r
1998 if( ulTotalRunTime > 0UL )
\r
2000 /* Has the task run at all? */
\r
2001 if( pxNextTCB->ulRunTimeCounter == 0 )
\r
2003 /* The task has used no CPU time at all. */
\r
2004 sprintf( pcStatsString, ( portCHAR * ) "%s\t\t0\t\t0%%\r\n", pxNextTCB->pcTaskName );
\r
2008 /* What percentage of the total run time as the task used?
\r
2009 This will always be rounded down to the nearest integer. */
\r
2010 ulStatsAsPercentage = ( 100UL * pxNextTCB->ulRunTimeCounter ) / ulTotalRunTime;
\r
2012 if( ulStatsAsPercentage > 0UL )
\r
2014 sprintf( pcStatsString, ( portCHAR * ) "%s\t\t%u\t\t%u%%\r\n", pxNextTCB->pcTaskName, ( unsigned int ) pxNextTCB->ulRunTimeCounter, ( unsigned int ) ulStatsAsPercentage );
\r
2018 /* If the percentage is zero here then the task has
\r
2019 consumed less than 1% of the total run time. */
\r
2020 sprintf( pcStatsString, ( portCHAR * ) "%s\t\t%u\t\t<1%%\r\n", pxNextTCB->pcTaskName, ( unsigned int ) pxNextTCB->ulRunTimeCounter );
\r
2024 strcat( ( portCHAR * ) pcWriteBuffer, ( portCHAR * ) pcStatsString );
\r
2027 } while( pxNextTCB != pxFirstTCB );
\r
2031 /*-----------------------------------------------------------*/
\r
2033 #if ( ( configUSE_TRACE_FACILITY == 1 ) || ( INCLUDE_uxTaskGetStackHighWaterMark == 1 ) )
\r
2035 unsigned portSHORT usTaskCheckFreeStackSpace( const unsigned portCHAR * pucStackByte )
\r
2037 register unsigned portSHORT usCount = 0;
\r
2039 while( *pucStackByte == tskSTACK_FILL_BYTE )
\r
2041 pucStackByte -= portSTACK_GROWTH;
\r
2045 usCount /= sizeof( portSTACK_TYPE );
\r
2051 /*-----------------------------------------------------------*/
\r
2053 #if ( INCLUDE_uxTaskGetStackHighWaterMark == 1 )
\r
2055 unsigned portBASE_TYPE uxTaskGetStackHighWaterMark( xTaskHandle xTask )
\r
2058 unsigned portCHAR *pcEndOfStack;
\r
2060 pxTCB = prvGetTCBFromHandle( xTask );
\r
2062 #if portSTACK_GROWTH < 0
\r
2064 pcEndOfStack = ( unsigned portCHAR * ) pxTCB->pxStack;
\r
2068 pcEndOfStack = ( unsigned portCHAR * ) pxTCB->pxEndOfStack;
\r
2072 return usTaskCheckFreeStackSpace( pcEndOfStack );
\r
2076 /*-----------------------------------------------------------*/
\r
2078 #if ( ( INCLUDE_vTaskDelete == 1 ) || ( INCLUDE_vTaskCleanUpResources == 1 ) )
\r
2080 static void prvDeleteTCB( tskTCB *pxTCB )
\r
2082 /* Free up the memory allocated by the scheduler for the task. It is up to
\r
2083 the task to free any memory allocated at the application level. */
\r
2084 vPortFree( pxTCB->pxStack );
\r
2085 vPortFree( pxTCB );
\r
2091 /*-----------------------------------------------------------*/
\r
2093 #if ( INCLUDE_xTaskGetCurrentTaskHandle == 1 )
\r
2095 xTaskHandle xTaskGetCurrentTaskHandle( void )
\r
2097 /* A critical section is not required as this is not called from
\r
2098 an interrupt and the current TCB will always be the same for any
\r
2099 individual execution thread. */
\r
2100 return pxCurrentTCB;
\r
2105 /*-----------------------------------------------------------*/
\r
2107 #if ( INCLUDE_xTaskGetSchedulerState == 1 )
\r
2109 portBASE_TYPE xTaskGetSchedulerState( void )
\r
2111 portBASE_TYPE xReturn;
\r
2113 if( xSchedulerRunning == pdFALSE )
\r
2115 xReturn = taskSCHEDULER_NOT_STARTED;
\r
2119 if( uxSchedulerSuspended == ( unsigned portBASE_TYPE ) pdFALSE )
\r
2121 xReturn = taskSCHEDULER_RUNNING;
\r
2125 xReturn = taskSCHEDULER_SUSPENDED;
\r
2133 /*-----------------------------------------------------------*/
\r
2135 #if ( configUSE_MUTEXES == 1 )
\r
2137 void vTaskPriorityInherit( xTaskHandle * const pxMutexHolder )
\r
2139 tskTCB * const pxTCB = ( tskTCB * ) pxMutexHolder;
\r
2141 if( pxTCB->uxPriority < pxCurrentTCB->uxPriority )
\r
2143 /* Adjust the mutex holder state to account for its new priority. */
\r
2144 listSET_LIST_ITEM_VALUE( &( pxTCB->xEventListItem ), configMAX_PRIORITIES - ( portTickType ) pxCurrentTCB->uxPriority );
\r
2146 /* If the task being modified is in the ready state it will need to
\r
2147 be moved in to a new list. */
\r
2148 if( listIS_CONTAINED_WITHIN( &( pxReadyTasksLists[ pxTCB->uxPriority ] ), &( pxTCB->xGenericListItem ) ) )
\r
2150 vListRemove( &( pxTCB->xGenericListItem ) );
\r
2152 /* Inherit the priority before being moved into the new list. */
\r
2153 pxTCB->uxPriority = pxCurrentTCB->uxPriority;
\r
2154 prvAddTaskToReadyQueue( pxTCB );
\r
2158 /* Just inherit the priority. */
\r
2159 pxTCB->uxPriority = pxCurrentTCB->uxPriority;
\r
2165 /*-----------------------------------------------------------*/
\r
2167 #if ( configUSE_MUTEXES == 1 )
\r
2169 void vTaskPriorityDisinherit( xTaskHandle * const pxMutexHolder )
\r
2171 tskTCB * const pxTCB = ( tskTCB * ) pxMutexHolder;
\r
2173 if( pxMutexHolder != NULL )
\r
2175 if( pxTCB->uxPriority != pxTCB->uxBasePriority )
\r
2177 /* We must be the running task to be able to give the mutex back.
\r
2178 Remove ourselves from the ready list we currently appear in. */
\r
2179 vListRemove( &( pxTCB->xGenericListItem ) );
\r
2181 /* Disinherit the priority before adding ourselves into the new
\r
2183 pxTCB->uxPriority = pxTCB->uxBasePriority;
\r
2184 listSET_LIST_ITEM_VALUE( &( pxTCB->xEventListItem ), configMAX_PRIORITIES - ( portTickType ) pxTCB->uxPriority );
\r
2185 prvAddTaskToReadyQueue( pxTCB );
\r
2191 /*-----------------------------------------------------------*/
\r
2193 #if ( portCRITICAL_NESTING_IN_TCB == 1 )
\r
2195 void vTaskEnterCritical( void )
\r
2197 portDISABLE_INTERRUPTS();
\r
2199 if( xSchedulerRunning != pdFALSE )
\r
2201 pxCurrentTCB->uxCriticalNesting++;
\r
2206 /*-----------------------------------------------------------*/
\r
2208 #if ( portCRITICAL_NESTING_IN_TCB == 1 )
\r
2210 void vTaskExitCritical( void )
\r
2212 if( xSchedulerRunning != pdFALSE )
\r
2214 if( pxCurrentTCB->uxCriticalNesting > 0 )
\r
2216 pxCurrentTCB->uxCriticalNesting--;
\r
2218 if( pxCurrentTCB->uxCriticalNesting == 0 )
\r
2220 portENABLE_INTERRUPTS();
\r
2227 /*-----------------------------------------------------------*/
\r