task.h File Reference

Data Structures
struct	TimeOut_t
struct	MemoryRegion_t
struct	TaskParameters_t
struct	TaskStatus_t

Macros
#define	tskKERNEL_VERSION_NUMBER
#define	tskKERNEL_VERSION_MAJOR
#define	tskKERNEL_VERSION_MINOR
#define	tskKERNEL_VERSION_BUILD
#define	tskMPU_REGION_READ_ONLY
#define	tskMPU_REGION_READ_WRITE
#define	tskMPU_REGION_EXECUTE_NEVER
#define	tskMPU_REGION_NORMAL_MEMORY
#define	tskMPU_REGION_DEVICE_MEMORY
#define	tskIDLE_PRIORITY
#define	taskYIELD()
#define	taskENTER_CRITICAL()
#define	taskENTER_CRITICAL_FROM_ISR()
#define	taskEXIT_CRITICAL()
#define	taskEXIT_CRITICAL_FROM_ISR(x)
#define	taskDISABLE_INTERRUPTS()
#define	taskENABLE_INTERRUPTS()
#define	taskSCHEDULER_SUSPENDED
#define	taskSCHEDULER_NOT_STARTED
#define	taskSCHEDULER_RUNNING
#define	xTaskNotify(xTaskToNotify, ulValue, eAction)
#define	xTaskNotifyAndQuery(xTaskToNotify, ulValue, eAction, pulPreviousNotifyValue)
#define	xTaskNotifyFromISR(xTaskToNotify, ulValue, eAction, pxHigherPriorityTaskWoken)
#define	xTaskNotifyAndQueryFromISR(xTaskToNotify, ulValue, eAction, pulPreviousNotificationValue, pxHigherPriorityTaskWoken)
#define	xTaskNotifyGive(xTaskToNotify)

Typedefs
typedef struct tskTaskControlBlock *	TaskHandle_t
typedef BaseType_t(*	TaskHookFunction_t )(void *)

Enumerations
enum	eTaskState
enum	eNotifyAction
enum	eSleepModeStatus

Functions
void	vTaskAllocateMPURegions (TaskHandle_t xTask, const MemoryRegion_t *const pxRegions) PRIVILEGED_FUNCTION
void	vTaskDelete (TaskHandle_t xTaskToDelete) PRIVILEGED_FUNCTION
void	vTaskDelay (const TickType_t xTicksToDelay) PRIVILEGED_FUNCTION
void	vTaskDelayUntil (TickType_t *const pxPreviousWakeTime, const TickType_t xTimeIncrement) PRIVILEGED_FUNCTION
BaseType_t	xTaskAbortDelay (TaskHandle_t xTask) PRIVILEGED_FUNCTION
UBaseType_t	uxTaskPriorityGet (const TaskHandle_t xTask) PRIVILEGED_FUNCTION
UBaseType_t	uxTaskPriorityGetFromISR (const TaskHandle_t xTask) PRIVILEGED_FUNCTION
eTaskState	eTaskGetState (TaskHandle_t xTask) PRIVILEGED_FUNCTION
void	vTaskGetInfo (TaskHandle_t xTask, TaskStatus_t *pxTaskStatus, BaseType_t xGetFreeStackSpace, eTaskState eState) PRIVILEGED_FUNCTION
void	vTaskPrioritySet (TaskHandle_t xTask, UBaseType_t uxNewPriority) PRIVILEGED_FUNCTION
void	vTaskSuspend (TaskHandle_t xTaskToSuspend) PRIVILEGED_FUNCTION
void	vTaskResume (TaskHandle_t xTaskToResume) PRIVILEGED_FUNCTION
BaseType_t	xTaskResumeFromISR (TaskHandle_t xTaskToResume) PRIVILEGED_FUNCTION
void	vTaskStartScheduler (void) PRIVILEGED_FUNCTION
void	vTaskEndScheduler (void) PRIVILEGED_FUNCTION
void	vTaskSuspendAll (void) PRIVILEGED_FUNCTION
BaseType_t	xTaskResumeAll (void) PRIVILEGED_FUNCTION
TickType_t	xTaskGetTickCount (void) PRIVILEGED_FUNCTION
TickType_t	xTaskGetTickCountFromISR (void) PRIVILEGED_FUNCTION
UBaseType_t	uxTaskGetNumberOfTasks (void) PRIVILEGED_FUNCTION
char *	pcTaskGetName (TaskHandle_t xTaskToQuery) PRIVILEGED_FUNCTION
TaskHandle_t	xTaskGetHandle (const char *pcNameToQuery) PRIVILEGED_FUNCTION
UBaseType_t	uxTaskGetStackHighWaterMark (TaskHandle_t xTask) PRIVILEGED_FUNCTION
configSTACK_DEPTH_TYPE	uxTaskGetStackHighWaterMark2 (TaskHandle_t xTask) PRIVILEGED_FUNCTION
BaseType_t	xTaskCallApplicationTaskHook (TaskHandle_t xTask, void *pvParameter) PRIVILEGED_FUNCTION
TaskHandle_t	xTaskGetIdleTaskHandle (void) PRIVILEGED_FUNCTION
UBaseType_t	uxTaskGetSystemState (TaskStatus_t *const pxTaskStatusArray, const UBaseType_t uxArraySize, uint32_t *const pulTotalRunTime) PRIVILEGED_FUNCTION
void	vTaskList (char *pcWriteBuffer) PRIVILEGED_FUNCTION
void	vTaskGetRunTimeStats (char *pcWriteBuffer) PRIVILEGED_FUNCTION
uint32_t	ulTaskGetIdleRunTimeCounter (void) PRIVILEGED_FUNCTION
BaseType_t	xTaskGenericNotify (TaskHandle_t xTaskToNotify, uint32_t ulValue, eNotifyAction eAction, uint32_t *pulPreviousNotificationValue) PRIVILEGED_FUNCTION
BaseType_t	xTaskGenericNotifyFromISR (TaskHandle_t xTaskToNotify, uint32_t ulValue, eNotifyAction eAction, uint32_t *pulPreviousNotificationValue, BaseType_t *pxHigherPriorityTaskWoken) PRIVILEGED_FUNCTION
BaseType_t	xTaskNotifyWait (uint32_t ulBitsToClearOnEntry, uint32_t ulBitsToClearOnExit, uint32_t *pulNotificationValue, TickType_t xTicksToWait) PRIVILEGED_FUNCTION
void	vTaskNotifyGiveFromISR (TaskHandle_t xTaskToNotify, BaseType_t *pxHigherPriorityTaskWoken) PRIVILEGED_FUNCTION
uint32_t	ulTaskNotifyTake (BaseType_t xClearCountOnExit, TickType_t xTicksToWait) PRIVILEGED_FUNCTION
BaseType_t	xTaskNotifyStateClear (TaskHandle_t xTask)
BaseType_t	xTaskIncrementTick (void) PRIVILEGED_FUNCTION
void	vTaskPlaceOnEventList (List_t *const pxEventList, const TickType_t xTicksToWait) PRIVILEGED_FUNCTION
void	vTaskPlaceOnUnorderedEventList (List_t *pxEventList, const TickType_t xItemValue, const TickType_t xTicksToWait) PRIVILEGED_FUNCTION
void	vTaskPlaceOnEventListRestricted (List_t *const pxEventList, TickType_t xTicksToWait, const BaseType_t xWaitIndefinitely) PRIVILEGED_FUNCTION
BaseType_t	xTaskRemoveFromEventList (const List_t *const pxEventList) PRIVILEGED_FUNCTION
void	vTaskRemoveFromUnorderedEventList (ListItem_t *pxEventListItem, const TickType_t xItemValue) PRIVILEGED_FUNCTION
portDONT_DISCARD void	vTaskSwitchContext (void) PRIVILEGED_FUNCTION
TickType_t	uxTaskResetEventItemValue (void) PRIVILEGED_FUNCTION
TaskHandle_t	xTaskGetCurrentTaskHandle (void) PRIVILEGED_FUNCTION
void	vTaskSetTimeOutState (TimeOut_t *const pxTimeOut) PRIVILEGED_FUNCTION
BaseType_t	xTaskCheckForTimeOut (TimeOut_t *const pxTimeOut, TickType_t *const pxTicksToWait) PRIVILEGED_FUNCTION
void	vTaskMissedYield (void) PRIVILEGED_FUNCTION
BaseType_t	xTaskGetSchedulerState (void) PRIVILEGED_FUNCTION
BaseType_t	xTaskPriorityInherit (TaskHandle_t const pxMutexHolder) PRIVILEGED_FUNCTION
BaseType_t	xTaskPriorityDisinherit (TaskHandle_t const pxMutexHolder) PRIVILEGED_FUNCTION
void	vTaskPriorityDisinheritAfterTimeout (TaskHandle_t const pxMutexHolder, UBaseType_t uxHighestPriorityWaitingTask) PRIVILEGED_FUNCTION
UBaseType_t	uxTaskGetTaskNumber (TaskHandle_t xTask) PRIVILEGED_FUNCTION
void	vTaskSetTaskNumber (TaskHandle_t xTask, const UBaseType_t uxHandle) PRIVILEGED_FUNCTION
void	vTaskStepTick (const TickType_t xTicksToJump) PRIVILEGED_FUNCTION
BaseType_t	xTaskCatchUpTicks (TickType_t xTicksToCatchUp) PRIVILEGED_FUNCTION
eSleepModeStatus	eTaskConfirmSleepModeStatus (void) PRIVILEGED_FUNCTION
TaskHandle_t	pvTaskIncrementMutexHeldCount (void) PRIVILEGED_FUNCTION
void	vTaskInternalSetTimeOutState (TimeOut_t *const pxTimeOut) PRIVILEGED_FUNCTION

Macro Definition Documentation

#define taskDISABLE_INTERRUPTS

(

)

#define taskENABLE_INTERRUPTS

(

)

#define taskENTER_CRITICAL

(

)

Referenced by prvAddNewTaskToReadyList(), prvCheckTasksWaitingTermination(), prvIsQueueEmpty(), prvIsQueueFull(), prvUnlockQueue(), uxQueueMessagesWaiting(), uxQueueSpacesAvailable(), vPortGetHeapStats(), vTaskSetTimeOutState(), xEventGroupClearBits(), xEventGroupSync(), xEventGroupWaitBits(), xQueueGenericReset(), xQueueGenericSend(), xQueuePeek(), xQueueReceive(), xQueueSemaphoreTake(), xStreamBufferReceive(), xStreamBufferReset(), xStreamBufferSend(), xTaskCheckForTimeOut(), and xTaskResumeAll().

#define taskENTER_CRITICAL_FROM_ISR

(

)

#define taskEXIT_CRITICAL

(

)

Referenced by prvAddNewTaskToReadyList(), prvCheckTasksWaitingTermination(), prvIsQueueEmpty(), prvIsQueueFull(), prvUnlockQueue(), uxQueueMessagesWaiting(), uxQueueSpacesAvailable(), vPortGetHeapStats(), vTaskSetTimeOutState(), xEventGroupClearBits(), xEventGroupSync(), xEventGroupWaitBits(), xQueueGenericReset(), xQueueGenericSend(), xQueuePeek(), xQueueReceive(), xQueueSemaphoreTake(), xStreamBufferReceive(), xStreamBufferReset(), xStreamBufferSend(), xTaskCheckForTimeOut(), and xTaskResumeAll().

#define taskEXIT_CRITICAL_FROM_ISR

(

x

)

#define taskSCHEDULER_NOT_STARTED

#define taskSCHEDULER_RUNNING

#define taskSCHEDULER_SUSPENDED

Referenced by xEventGroupSync(), xEventGroupWaitBits(), xQueueGenericSend(), xQueuePeek(), xQueueReceive(), and xQueueSemaphoreTake().

#define taskYIELD

(

)

Referenced by __os_native_yield(), and portTASK_FUNCTION().

#define tskIDLE_PRIORITY

Defines the priority used by the idle task. This must not be modified.

Referenced by __os_native_kickoff().

#define tskKERNEL_VERSION_BUILD

#define tskKERNEL_VERSION_MAJOR

#define tskKERNEL_VERSION_MINOR

#define tskKERNEL_VERSION_NUMBER

#define tskMPU_REGION_DEVICE_MEMORY

#define tskMPU_REGION_EXECUTE_NEVER

#define tskMPU_REGION_NORMAL_MEMORY

#define tskMPU_REGION_READ_ONLY

#define tskMPU_REGION_READ_WRITE

#define xTaskNotify	(		xTaskToNotify,
			ulValue,
			eAction
	)

#define xTaskNotifyAndQuery	(		xTaskToNotify,
			ulValue,
			eAction,
			pulPreviousNotifyValue
	)

#define xTaskNotifyAndQueryFromISR	(		xTaskToNotify,
			ulValue,
			eAction,
			pulPreviousNotificationValue,
			pxHigherPriorityTaskWoken
	)

#define xTaskNotifyFromISR	(		xTaskToNotify,
			ulValue,
			eAction,
			pxHigherPriorityTaskWoken
	)

Referenced by xStreamBufferReceiveCompletedFromISR(), and xStreamBufferSendCompletedFromISR().

#define xTaskNotifyGive

(

xTaskToNotify

)

Typedef Documentation

typedef struct tskTaskControlBlock* TaskHandle_t

typedef BaseType_t(* TaskHookFunction_t)(void *)

Enumeration Type Documentation

enum eNotifyAction

Enumerator
eNoAction
eSetBits
eIncrement
eSetValueWithOverwrite
eSetValueWithoutOverwrite

enum eSleepModeStatus

Enumerator
eAbortSleep
eStandardSleep
eNoTasksWaitingTimeout

enum eTaskState

Enumerator
eRunning
eReady
eBlocked
eSuspended
eDeleted
eInvalid

Function Documentation

eSleepModeStatus eTaskConfirmSleepModeStatus

(

void

)

eTaskState eTaskGetState

(

TaskHandle_t

xTask

)

task. h

eTaskState eTaskGetState( TaskHandle_t xTask );

INCLUDE_eTaskGetState must be defined as 1 for this function to be available. See the configuration section for more information.

Obtain the state of any task. States are encoded by the eTaskState enumerated type.

Parameters

xTask

Handle of the task to be queried.

Returns

The state of xTask at the time the function was called. Note the state of the task might change between the function being called, and the functions return value being tested by the calling task.

char* pcTaskGetName

(

TaskHandle_t

xTaskToQuery

)

References configASSERT, tskTCB::pcTaskName, and prvGetTCBFromHandle.

Referenced by MPU_pcTaskGetName().

TaskHandle_t pvTaskIncrementMutexHeldCount

(

void

)

Referenced by xQueueSemaphoreTake().

uint32_t ulTaskGetIdleRunTimeCounter

(

void

)

uint32_t ulTaskNotifyTake	(	BaseType_t	xClearCountOnExit,
		TickType_t	xTicksToWait
	)

UBaseType_t uxTaskGetNumberOfTasks

(

void

)

References uxCurrentNumberOfTasks.

Referenced by MPU_uxTaskGetNumberOfTasks().

UBaseType_t uxTaskGetStackHighWaterMark

(

TaskHandle_t

xTask

)

task.h

UBaseType_t uxTaskGetStackHighWaterMark( TaskHandle_t xTask );

INCLUDE_uxTaskGetStackHighWaterMark must be set to 1 in FreeRTOSConfig.h for this function to be available.

Returns the high water mark of the stack associated with xTask. That is, the minimum free stack space there has been (in words, so on a 32 bit machine a value of 1 means 4 bytes) since the task started. The smaller the returned number the closer the task has come to overflowing its stack.

uxTaskGetStackHighWaterMark() and uxTaskGetStackHighWaterMark2() are the same except for their return type. Using configSTACK_DEPTH_TYPE allows the user to determine the return type. It gets around the problem of the value overflowing on 8-bit types without breaking backward compatibility for applications that expect an 8-bit return type.

Parameters

xTask

Handle of the task associated with the stack to be checked. Set xTask to NULL to check the stack of the calling task.

Returns

The smallest amount of free stack space there has been (in words, so actual spaces on the stack rather than bytes) since the task referenced by xTask was created.

configSTACK_DEPTH_TYPE uxTaskGetStackHighWaterMark2

(

TaskHandle_t

xTask

)

task.h

configSTACK_DEPTH_TYPE uxTaskGetStackHighWaterMark2( TaskHandle_t xTask );

INCLUDE_uxTaskGetStackHighWaterMark2 must be set to 1 in FreeRTOSConfig.h for this function to be available.

Returns the high water mark of the stack associated with xTask. That is, the minimum free stack space there has been (in words, so on a 32 bit machine a value of 1 means 4 bytes) since the task started. The smaller the returned number the closer the task has come to overflowing its stack.

uxTaskGetStackHighWaterMark() and uxTaskGetStackHighWaterMark2() are the same except for their return type. Using configSTACK_DEPTH_TYPE allows the user to determine the return type. It gets around the problem of the value overflowing on 8-bit types without breaking backward compatibility for applications that expect an 8-bit return type.

Parameters

xTask

Handle of the task associated with the stack to be checked. Set xTask to NULL to check the stack of the calling task.

Returns

The smallest amount of free stack space there has been (in words, so actual spaces on the stack rather than bytes) since the task referenced by xTask was created.

UBaseType_t uxTaskGetSystemState	(	TaskStatus_t *const	pxTaskStatusArray,
		const UBaseType_t	uxArraySize,
		uint32_t *const	pulTotalRunTime
	)

configUSE_TRACE_FACILITY must be defined as 1 in FreeRTOSConfig.h for uxTaskGetSystemState() to be available.

uxTaskGetSystemState() populates an TaskStatus_t structure for each task in the system. TaskStatus_t structures contain, among other things, members for the task handle, task name, task priority, task state, and total amount of run time consumed by the task. See the TaskStatus_t structure definition in this file for the full member list.

NOTE: This function is intended for debugging use only as its use results in the scheduler remaining suspended for an extended period.

Parameters

pxTaskStatusArray	A pointer to an array of TaskStatus_t structures. The array must contain at least one TaskStatus_t structure for each task that is under the control of the RTOS. The number of tasks under the control of the RTOS can be determined using the uxTaskGetNumberOfTasks() API function.
uxArraySize	The size of the array pointed to by the pxTaskStatusArray parameter. The size is specified as the number of indexes in the array, or the number of TaskStatus_t structures contained in the array, not by the number of bytes in the array.
pulTotalRunTime	If configGENERATE_RUN_TIME_STATS is set to 1 in FreeRTOSConfig.h then *pulTotalRunTime is set by uxTaskGetSystemState() to the total run time (as defined by the run time stats clock, see http://www.freertos.org/rtos-run-time-stats.html) since the target booted. pulTotalRunTime can be set to NULL to omit the total run time information.

Returns

The number of TaskStatus_t structures that were populated by uxTaskGetSystemState(). This should equal the number returned by the uxTaskGetNumberOfTasks() API function, but will be zero if the value passed in the uxArraySize parameter was too small.

Example usage:

This example demonstrates how a human readable table of run time stats
information is generated from raw data provided by uxTaskGetSystemState().
The human readable table is written to pcWriteBuffer
        void vTaskGetRunTimeStats( char *pcWriteBuffer )
        {
        TaskStatus_t *pxTaskStatusArray;
        volatile UBaseType_t uxArraySize, x;
        uint32_t ulTotalRunTime, ulStatsAsPercentage;

Make sure the write buffer does not contain a string.
                 pcWriteBuffer = 0x00;

Take a snapshot of the number of tasks in case it changes while this
function is executing.
                uxArraySize = uxTaskGetNumberOfTasks();

Allocate a TaskStatus_t structure for each task.  An array could be
allocated statically at compile time.
                pxTaskStatusArray = pvPortMalloc( uxArraySize * sizeof( TaskStatus_t ) );

                if( pxTaskStatusArray != NULL )
                {
Generate raw status information about each task.
                        uxArraySize = uxTaskGetSystemState( pxTaskStatusArray, uxArraySize, &ulTotalRunTime );

For percentage calculations.
                        ulTotalRunTime /= 100UL;

Avoid divide by zero errors.
                        if( ulTotalRunTime > 0 )
                        {
For each populated position in the pxTaskStatusArray array,
format the raw data as human readable ASCII data
                                for( x = 0; x < uxArraySize; x++ )
                                {
What percentage of the total run time has the task used?
This will always be rounded down to the nearest integer.
ulTotalRunTimeDiv100 has already been divided by 100.
                                        ulStatsAsPercentage = pxTaskStatusArray[ x ].ulRunTimeCounter / ulTotalRunTime;

                                        if( ulStatsAsPercentage > 0UL )
                                        {
                                                sprintf( pcWriteBuffer, "%s\t\t%lu\t\t%lu%%\r\n", pxTaskStatusArray[ x ].pcTaskName, pxTaskStatusArray[ x ].ulRunTimeCounter, ulStatsAsPercentage );
                                        }
                                        else
                                        {
If the percentage is zero here then the task has
consumed less than 1% of the total run time.
                                                sprintf( pcWriteBuffer, "%s\t\t%lu\t\t<1%%\r\n", pxTaskStatusArray[ x ].pcTaskName, pxTaskStatusArray[ x ].ulRunTimeCounter );
                                        }

                                        pcWriteBuffer += strlen( ( char * ) pcWriteBuffer );
                                }
                        }

The array is no longer needed, free the memory it consumes.
                        vPortFree( pxTaskStatusArray );
                }
        }
        

UBaseType_t uxTaskGetTaskNumber

(

TaskHandle_t

xTask

)

UBaseType_t uxTaskPriorityGet

(

const TaskHandle_t

xTask

)

UBaseType_t uxTaskPriorityGetFromISR

(

const TaskHandle_t

xTask

)

task. h

UBaseType_t uxTaskPriorityGetFromISR( const TaskHandle_t xTask );

A version of uxTaskPriorityGet() that can be used from an ISR.

TickType_t uxTaskResetEventItemValue

(

void

)

References listGET_LIST_ITEM_VALUE, listSET_LIST_ITEM_VALUE, pxCurrentTCB, tskTCB::uxPriority, and tskTCB::xEventListItem.

Referenced by xEventGroupSync(), and xEventGroupWaitBits().

void vTaskAllocateMPURegions	(	TaskHandle_t	xTask,
		const MemoryRegion_t *const	pxRegions
	)

Referenced by MPU_vTaskAllocateMPURegions().

void vTaskDelay

(

const TickType_t

xTicksToDelay

)

Referenced by pi_time_wait_us().

void vTaskDelayUntil	(	TickType_t *const	pxPreviousWakeTime,
		const TickType_t	xTimeIncrement
	)

void vTaskDelete

(

TaskHandle_t

xTaskToDelete

)

Referenced by __os_native_task_suspend().

void vTaskEndScheduler

(

void

)

References pdFALSE, portDISABLE_INTERRUPTS, vPortEndScheduler(), and xSchedulerRunning.

void vTaskGetInfo	(	TaskHandle_t	xTask,
		TaskStatus_t *	pxTaskStatus,
		BaseType_t	xGetFreeStackSpace,
		eTaskState	eState
	)

void vTaskGetRunTimeStats

(

char *

pcWriteBuffer

)

void vTaskInternalSetTimeOutState

(

TimeOut_t *const

pxTimeOut

)

References xNumOfOverflows, TimeOut_t::xOverflowCount, xTickCount, and TimeOut_t::xTimeOnEntering.

Referenced by xQueueGenericSend(), xQueuePeek(), xQueueReceive(), xQueueSemaphoreTake(), and xTaskCheckForTimeOut().

void vTaskList

(

char *

pcWriteBuffer

)

void vTaskMissedYield

(

void

)

References pdTRUE, and xYieldPending.

Referenced by prvUnlockQueue().

void vTaskNotifyGiveFromISR	(	TaskHandle_t	xTaskToNotify,
		BaseType_t *	pxHigherPriorityTaskWoken
	)

void vTaskPlaceOnEventList	(	List_t *const	pxEventList,
		const TickType_t	xTicksToWait
	)

References configASSERT, pdTRUE, prvAddCurrentTaskToDelayedList(), pxCurrentTCB, vListInsert(), and tskTCB::xEventListItem.

Referenced by xQueueGenericSend(), xQueuePeek(), xQueueReceive(), and xQueueSemaphoreTake().

void vTaskPlaceOnEventListRestricted	(	List_t *const	pxEventList,
		TickType_t	xTicksToWait,
		const BaseType_t	xWaitIndefinitely
	)

void vTaskPlaceOnUnorderedEventList	(	List_t *	pxEventList,
		const TickType_t	xItemValue,
		const TickType_t	xTicksToWait
	)

References configASSERT, listSET_LIST_ITEM_VALUE, pdTRUE, prvAddCurrentTaskToDelayedList(), pxCurrentTCB, taskEVENT_LIST_ITEM_VALUE_IN_USE, uxSchedulerSuspended, vListInsertEnd(), and tskTCB::xEventListItem.

Referenced by xEventGroupSync(), and xEventGroupWaitBits().

void vTaskPriorityDisinheritAfterTimeout	(	TaskHandle_t const	pxMutexHolder,
		UBaseType_t	uxHighestPriorityWaitingTask
	)

Referenced by xQueueSemaphoreTake().

void vTaskPrioritySet	(	TaskHandle_t	xTask,
		UBaseType_t	uxNewPriority
	)

void vTaskRemoveFromUnorderedEventList	(	ListItem_t *	pxEventListItem,
		const TickType_t	xItemValue
	)

References configASSERT, listGET_LIST_ITEM_OWNER, listSET_LIST_ITEM_VALUE, pdTRUE, prvAddTaskToReadyList, pxCurrentTCB, taskEVENT_LIST_ITEM_VALUE_IN_USE, uxListRemove(), tskTCB::uxPriority, uxSchedulerSuspended, tskTCB::xStateListItem, and xYieldPending.

Referenced by vEventGroupDelete(), and xEventGroupSetBits().

void vTaskResume

(

TaskHandle_t

xTaskToResume

)

void vTaskSetTaskNumber	(	TaskHandle_t	xTask,
		const UBaseType_t	uxHandle
	)

void vTaskSetTimeOutState

(

TimeOut_t *const

pxTimeOut

)

References configASSERT, taskENTER_CRITICAL, taskEXIT_CRITICAL, xNumOfOverflows, TimeOut_t::xOverflowCount, xTickCount, and TimeOut_t::xTimeOnEntering.

Referenced by MPU_vTaskSetTimeOutState(), and xStreamBufferSend().

void vTaskStartScheduler

(

void

)

References configASSERT, configIDLE_TASK_NAME, configINITIAL_TICK_COUNT, configMINIMAL_STACK_SIZE, errCOULD_NOT_ALLOCATE_REQUIRED_MEMORY, mtCOVERAGE_TEST_MARKER, pdFAIL, pdPASS, pdTRUE, portCONFIGURE_TIMER_FOR_RUN_TIME_STATS, portDISABLE_INTERRUPTS, portMAX_DELAY, pxCurrentTCB, traceTASK_SWITCHED_IN, xIdleTaskHandle, xNextTaskUnblockTime, xPortStartScheduler(), xSchedulerRunning, xTickCount, and xTimerCreateTimerTask().

Referenced by __os_native_kickoff().

void vTaskStepTick

(

const TickType_t

xTicksToJump

)

void vTaskSuspend

(

TaskHandle_t

xTaskToSuspend

)

Referenced by __os_native_task_suspend().

void vTaskSuspendAll

(

void

)

References portMEMORY_BARRIER, and uxSchedulerSuspended.

Referenced by MPU_vTaskSuspendAll(), portTASK_FUNCTION(), pvPortMalloc(), vEventGroupDelete(), vPortFree(), vPortGetHeapStats(), xEventGroupSetBits(), xEventGroupSync(), xEventGroupWaitBits(), xQueueGenericSend(), xQueuePeek(), xQueueReceive(), xQueueSemaphoreTake(), and xTaskCatchUpTicks().

portDONT_DISCARD void vTaskSwitchContext

(

void

)

References mtCOVERAGE_TEST_MARKER, pdFALSE, pdTRUE, pxCurrentTCB, taskCHECK_FOR_STACK_OVERFLOW, taskSELECT_HIGHEST_PRIORITY_TASK, traceTASK_SWITCHED_IN, traceTASK_SWITCHED_OUT, uxSchedulerSuspended, and xYieldPending.

BaseType_t xTaskAbortDelay

(

TaskHandle_t

xTask

)

BaseType_t xTaskCallApplicationTaskHook	(	TaskHandle_t	xTask,
		void *	pvParameter
	)

task.h

BaseType_t xTaskCallApplicationTaskHook( TaskHandle_t xTask, void *pvParameter );

Calls the hook function associated with xTask. Passing xTask as NULL has the effect of calling the Running tasks (the calling task) hook function.

pvParameter is passed to the hook function for the task to interpret as it wants. The return value is the value returned by the task hook function registered by the user.

BaseType_t xTaskCatchUpTicks

(

TickType_t

xTicksToCatchUp

)

References configASSERT, pdFALSE, uxSchedulerSuspended, vTaskSuspendAll(), xPendedTicks, and xTaskResumeAll().

Referenced by MPU_xTaskCatchUpTicks().

BaseType_t xTaskCheckForTimeOut	(	TimeOut_t *const	pxTimeOut,
		TickType_t *const	pxTicksToWait
	)

References configASSERT, pdFALSE, pdTRUE, portMAX_DELAY, pxCurrentTCB, taskENTER_CRITICAL, taskEXIT_CRITICAL, vTaskInternalSetTimeOutState(), xNumOfOverflows, TimeOut_t::xOverflowCount, xTickCount, and TimeOut_t::xTimeOnEntering.

Referenced by MPU_xTaskCheckForTimeOut(), xQueueGenericSend(), xQueuePeek(), xQueueReceive(), xQueueSemaphoreTake(), and xStreamBufferSend().

BaseType_t xTaskGenericNotify	(	TaskHandle_t	xTaskToNotify,
		uint32_t	ulValue,
		eNotifyAction	eAction,
		uint32_t *	pulPreviousNotificationValue
	)

BaseType_t xTaskGenericNotifyFromISR	(	TaskHandle_t	xTaskToNotify,
		uint32_t	ulValue,
		eNotifyAction	eAction,
		uint32_t *	pulPreviousNotificationValue,
		BaseType_t *	pxHigherPriorityTaskWoken
	)

TaskHandle_t xTaskGetCurrentTaskHandle

(

void

)

Referenced by xStreamBufferReceive(), and xStreamBufferSend().

TaskHandle_t xTaskGetHandle

(

const char *

pcNameToQuery

)

TaskHandle_t xTaskGetIdleTaskHandle

(

void

)

xTaskGetIdleTaskHandle() is only available if INCLUDE_xTaskGetIdleTaskHandle is set to 1 in FreeRTOSConfig.h.

Simply returns the handle of the idle task. It is not valid to call xTaskGetIdleTaskHandle() before the scheduler has been started.

BaseType_t xTaskGetSchedulerState

(

void

)

Referenced by xEventGroupSync(), xEventGroupWaitBits(), xQueueGenericSend(), xQueuePeek(), xQueueReceive(), and xQueueSemaphoreTake().

TickType_t xTaskGetTickCount

(

void

)

References portTICK_TYPE_ENTER_CRITICAL, portTICK_TYPE_EXIT_CRITICAL, and xTickCount.

Referenced by MPU_xTaskGetTickCount().

TickType_t xTaskGetTickCountFromISR

(

void

)

References portASSERT_IF_INTERRUPT_PRIORITY_INVALID, portTICK_TYPE_CLEAR_INTERRUPT_MASK_FROM_ISR, portTICK_TYPE_SET_INTERRUPT_MASK_FROM_ISR, and xTickCount.

Referenced by uTaskCheckQuantum().

BaseType_t xTaskIncrementTick

(

void

)

References listCURRENT_LIST_LENGTH, listGET_LIST_ITEM_VALUE, listGET_OWNER_OF_HEAD_ENTRY, listLIST_IS_EMPTY, listLIST_ITEM_CONTAINER, mtCOVERAGE_TEST_MARKER, pdFALSE, pdTRUE, portMAX_DELAY, prvAddTaskToReadyList, pxCurrentTCB, pxDelayedTaskList, pxReadyTasksLists, taskSWITCH_DELAYED_LISTS, traceTASK_INCREMENT_TICK, uxListRemove(), tskTCB::uxPriority, uxSchedulerSuspended, tskTCB::xEventListItem, xNextTaskUnblockTime, xPendedTicks, tskTCB::xStateListItem, xTickCount, and xYieldPending.

Referenced by xTaskResumeAll().

BaseType_t xTaskNotifyStateClear

(

TaskHandle_t

xTask

)

Referenced by xStreamBufferReceive(), and xStreamBufferSend().

BaseType_t xTaskNotifyWait	(	uint32_t	ulBitsToClearOnEntry,
		uint32_t	ulBitsToClearOnExit,
		uint32_t *	pulNotificationValue,
		TickType_t	xTicksToWait
	)

Referenced by xStreamBufferReceive(), and xStreamBufferSend().

BaseType_t xTaskPriorityDisinherit

(

TaskHandle_t const

pxMutexHolder

)

Referenced by prvCopyDataToQueue().

BaseType_t xTaskPriorityInherit

(

TaskHandle_t const

pxMutexHolder

)

Referenced by xQueueSemaphoreTake().

BaseType_t xTaskRemoveFromEventList

(

const List_t *const

pxEventList

)

References configASSERT, listGET_OWNER_OF_HEAD_ENTRY, pdFALSE, pdTRUE, prvAddTaskToReadyList, prvResetNextTaskUnblockTime(), pxCurrentTCB, uxListRemove(), tskTCB::uxPriority, uxSchedulerSuspended, vListInsertEnd(), tskTCB::xEventListItem, xPendingReadyList, tskTCB::xStateListItem, and xYieldPending.

Referenced by prvUnlockQueue(), xQueueGenericReset(), xQueueGenericSend(), xQueueGenericSendFromISR(), xQueueGiveFromISR(), xQueuePeek(), xQueueReceive(), xQueueReceiveFromISR(), and xQueueSemaphoreTake().

BaseType_t xTaskResumeAll

(

void

)

References configASSERT, listGET_OWNER_OF_HEAD_ENTRY, listLIST_IS_EMPTY, mtCOVERAGE_TEST_MARKER, pdFALSE, pdTRUE, prvAddTaskToReadyList, prvResetNextTaskUnblockTime(), pxCurrentTCB, taskENTER_CRITICAL, taskEXIT_CRITICAL, taskYIELD_IF_USING_PREEMPTION, uxCurrentNumberOfTasks, uxListRemove(), tskTCB::uxPriority, uxSchedulerSuspended, tskTCB::xEventListItem, xNextTaskUnblockTime, xPendedTicks, xPendingReadyList, tskTCB::xStateListItem, xTaskIncrementTick(), xTickCount, and xYieldPending.

Referenced by MPU_xTaskResumeAll(), portTASK_FUNCTION(), pvPortMalloc(), vEventGroupDelete(), vPortFree(), vPortGetHeapStats(), xEventGroupSetBits(), xEventGroupSync(), xEventGroupWaitBits(), xQueueGenericSend(), xQueuePeek(), xQueueReceive(), xQueueSemaphoreTake(), and xTaskCatchUpTicks().

BaseType_t xTaskResumeFromISR

(

TaskHandle_t

xTaskToResume

)