freertos-8.2.3/Source/include/task.h File Reference

#include "list.h"

Data Structures
struct	xMEMORY_REGION
struct	xTASK_PARAMETERS
struct	xTASK_STATUS
struct	xTIME_OUT

Macros
#define	taskDISABLE_INTERRUPTS()   portDISABLE_INTERRUPTS()
#define	taskENABLE_INTERRUPTS()   portENABLE_INTERRUPTS()
#define	taskENTER_CRITICAL()   portENTER_CRITICAL()
#define	taskENTER_CRITICAL_FROM_ISR()   portSET_INTERRUPT_MASK_FROM_ISR()
#define	taskEXIT_CRITICAL()   portEXIT_CRITICAL()
#define	taskEXIT_CRITICAL_FROM_ISR(x)   portCLEAR_INTERRUPT_MASK_FROM_ISR( x )
#define	taskSCHEDULER_NOT_STARTED   ( ( BaseType_t ) 1 )
#define	taskSCHEDULER_RUNNING   ( ( BaseType_t ) 2 )
#define	taskSCHEDULER_SUSPENDED   ( ( BaseType_t ) 0 )
#define	taskYIELD()   portYIELD()
#define	tskIDLE_PRIORITY   ( ( UBaseType_t ) 0U )
	Defines the priority used by the idle task. More...
#define	tskKERNEL_VERSION_BUILD   3
#define	tskKERNEL_VERSION_MAJOR   8
#define	tskKERNEL_VERSION_MINOR   2
#define	tskKERNEL_VERSION_NUMBER   "V8.2.3"
#define	xTaskCreate(pvTaskCode, pcName, usStackDepth, pvParameters, uxPriority, pxCreatedTask)   xTaskGenericCreate( ( pvTaskCode ), ( pcName ), ( usStackDepth ), ( pvParameters ), ( uxPriority ), ( pxCreatedTask ), ( NULL ), ( NULL ) )
#define	xTaskCreateRestricted(x, pxCreatedTask)   xTaskGenericCreate( ((x)->pvTaskCode), ((x)->pcName), ((x)->usStackDepth), ((x)->pvParameters), ((x)->uxPriority), (pxCreatedTask), ((x)->puxStackBuffer), ((x)->xRegions) )
#define	xTaskNotify(xTaskToNotify, ulValue, eAction)   xTaskGenericNotify( ( xTaskToNotify ), ( ulValue ), ( eAction ), NULL )
#define	xTaskNotifyAndQuery(xTaskToNotify, ulValue, eAction, pulPreviousNotifyValue)   xTaskGenericNotify( ( xTaskToNotify ), ( ulValue ), ( eAction ), ( pulPreviousNotifyValue ) )
#define	xTaskNotifyAndQueryFromISR(xTaskToNotify, ulValue, eAction, pulPreviousNotificationValue, pxHigherPriorityTaskWoken)   xTaskGenericNotifyFromISR( ( xTaskToNotify ), ( ulValue ), ( eAction ), ( pulPreviousNotificationValue ), ( pxHigherPriorityTaskWoken ) )
#define	xTaskNotifyFromISR(xTaskToNotify, ulValue, eAction, pxHigherPriorityTaskWoken)   xTaskGenericNotifyFromISR( ( xTaskToNotify ), ( ulValue ), ( eAction ), NULL, ( pxHigherPriorityTaskWoken ) )
#define	xTaskNotifyGive(xTaskToNotify)   xTaskGenericNotify( ( xTaskToNotify ), ( 0 ), eIncrement, NULL )

Typedefs
typedef struct xMEMORY_REGION	MemoryRegion_t
typedef void *	TaskHandle_t
typedef BaseType_t(*	TaskHookFunction_t )(void *)
typedef struct xTASK_PARAMETERS	TaskParameters_t
typedef struct xTASK_STATUS	TaskStatus_t
typedef struct xTIME_OUT	TimeOut_t

Enumerations
enum	eNotifyAction {   eNoAction = 0,   eSetBits,   eIncrement,   eSetValueWithOverwrite,   eSetValueWithoutOverwrite,   eNoAction = 0,   eSetBits,   eIncrement,   eSetValueWithOverwrite,   eSetValueWithoutOverwrite }
enum	eSleepModeStatus {   eAbortSleep = 0,   eStandardSleep,   eNoTasksWaitingTimeout,   eAbortSleep = 0,   eStandardSleep,   eNoTasksWaitingTimeout,   eAbortSleep = 0,   eStandardSleep,   eNoTasksWaitingTimeout,   eAbortSleep = 0,   eStandardSleep,   eNoTasksWaitingTimeout,   eAbortSleep = 0,   eStandardSleep,   eNoTasksWaitingTimeout }
enum	eTaskState {   eRunning = 0,   eReady,   eBlocked,   eSuspended,   eDeleted,   eRunning = 0,   eReady,   eBlocked,   eSuspended,   eDeleted,   eRunning = 0,   eReady,   eBlocked,   eSuspended,   eDeleted,   eRunning = 0,   eReady,   eBlocked,   eSuspended,   eDeleted,   eInvalid,   eRunning = 0,   eReady,   eBlocked,   eSuspended,   eDeleted,   eRunning = 0,   eReady,   eBlocked,   eSuspended,   eDeleted }

Functions
eSleepModeStatus	eTaskConfirmSleepModeStatus (void) PRIVILEGED_FUNCTION
eTaskState	eTaskGetState (TaskHandle_t xTask) PRIVILEGED_FUNCTION
	task. More...
char *	pcTaskGetTaskName (TaskHandle_t xTaskToQuery) PRIVILEGED_FUNCTION
void *	pvTaskIncrementMutexHeldCount (void) PRIVILEGED_FUNCTION
uint32_t	ulTaskNotifyTake (BaseType_t xClearCountOnExit, TickType_t xTicksToWait) PRIVILEGED_FUNCTION
UBaseType_t	uxTaskGetNumberOfTasks (void) PRIVILEGED_FUNCTION
UBaseType_t	uxTaskGetStackHighWaterMark (TaskHandle_t xTask) PRIVILEGED_FUNCTION
	task.h More...
UBaseType_t	uxTaskGetSystemState (TaskStatus_t *const pxTaskStatusArray, const UBaseType_t uxArraySize, uint32_t *const pulTotalRunTime) PRIVILEGED_FUNCTION
	configUSE_TRACE_FACILITY must be defined as 1 in FreeRTOSConfig.h for uxTaskGetSystemState() to be available. More...
UBaseType_t	uxTaskGetTaskNumber (TaskHandle_t xTask) PRIVILEGED_FUNCTION
UBaseType_t	uxTaskPriorityGet (TaskHandle_t xTask) PRIVILEGED_FUNCTION
UBaseType_t	uxTaskPriorityGetFromISR (TaskHandle_t xTask) PRIVILEGED_FUNCTION
	task. More...
TickType_t	uxTaskResetEventItemValue (void) PRIVILEGED_FUNCTION
void	vTaskAllocateMPURegions (TaskHandle_t xTask, const MemoryRegion_t *const pxRegions) PRIVILEGED_FUNCTION
void	vTaskDelay (const TickType_t xTicksToDelay) PRIVILEGED_FUNCTION
void	vTaskDelayUntil (TickType_t *const pxPreviousWakeTime, const TickType_t xTimeIncrement) PRIVILEGED_FUNCTION
void	vTaskDelete (TaskHandle_t xTaskToDelete) PRIVILEGED_FUNCTION
void	vTaskEndScheduler (void) PRIVILEGED_FUNCTION
void	vTaskGetRunTimeStats (char *pcWriteBuffer) PRIVILEGED_FUNCTION
void	vTaskList (char *pcWriteBuffer) PRIVILEGED_FUNCTION
void	vTaskMissedYield (void) PRIVILEGED_FUNCTION
void	vTaskNotifyGiveFromISR (TaskHandle_t xTaskToNotify, BaseType_t *pxHigherPriorityTaskWoken) PRIVILEGED_FUNCTION
void	vTaskPlaceOnEventList (List_t *const pxEventList, const TickType_t xTicksToWait) PRIVILEGED_FUNCTION
void	vTaskPlaceOnEventListRestricted (List_t *const pxEventList, const TickType_t xTicksToWait, const BaseType_t xWaitIndefinitely) PRIVILEGED_FUNCTION
void	vTaskPlaceOnUnorderedEventList (List_t *pxEventList, const TickType_t xItemValue, const TickType_t xTicksToWait) PRIVILEGED_FUNCTION
void	vTaskPriorityInherit (TaskHandle_t const pxMutexHolder) PRIVILEGED_FUNCTION
void	vTaskPrioritySet (TaskHandle_t xTask, UBaseType_t uxNewPriority) PRIVILEGED_FUNCTION
void	vTaskResume (TaskHandle_t xTaskToResume) PRIVILEGED_FUNCTION
void	vTaskSetTaskNumber (TaskHandle_t xTask, const UBaseType_t uxHandle) PRIVILEGED_FUNCTION
void	vTaskSetTimeOutState (TimeOut_t *const pxTimeOut) PRIVILEGED_FUNCTION
void	vTaskStartScheduler (void) PRIVILEGED_FUNCTION
void	vTaskStepTick (const TickType_t xTicksToJump) PRIVILEGED_FUNCTION
void	vTaskSuspend (TaskHandle_t xTaskToSuspend) PRIVILEGED_FUNCTION
void	vTaskSuspendAll (void) PRIVILEGED_FUNCTION
void	vTaskSwitchContext (void) PRIVILEGED_FUNCTION
BaseType_t	xTaskCallApplicationTaskHook (TaskHandle_t xTask, void *pvParameter) PRIVILEGED_FUNCTION
	task.h More...
BaseType_t	xTaskCheckForTimeOut (TimeOut_t *const pxTimeOut, TickType_t *const pxTicksToWait) PRIVILEGED_FUNCTION
BaseType_t	xTaskGenericCreate (TaskFunction_t pxTaskCode, const char *const pcName, const uint16_t usStackDepth, void *const pvParameters, UBaseType_t uxPriority, TaskHandle_t *const pxCreatedTask, StackType_t *const puxStackBuffer, const MemoryRegion_t *const xRegions) 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
TaskHandle_t	xTaskGetCurrentTaskHandle (void) PRIVILEGED_FUNCTION
TaskHandle_t	xTaskGetIdleTaskHandle (void) PRIVILEGED_FUNCTION
	xTaskGetIdleTaskHandle() is only available if INCLUDE_xTaskGetIdleTaskHandle is set to 1 in FreeRTOSConfig.h. More...
BaseType_t	xTaskGetSchedulerState (void) PRIVILEGED_FUNCTION
TickType_t	xTaskGetTickCount (void) PRIVILEGED_FUNCTION
TickType_t	xTaskGetTickCountFromISR (void) PRIVILEGED_FUNCTION
BaseType_t	xTaskIncrementTick (void) PRIVILEGED_FUNCTION
BaseType_t	xTaskNotifyStateClear (TaskHandle_t xTask)
BaseType_t	xTaskNotifyWait (uint32_t ulBitsToClearOnEntry, uint32_t ulBitsToClearOnExit, uint32_t *pulNotificationValue, TickType_t xTicksToWait) PRIVILEGED_FUNCTION
BaseType_t	xTaskPriorityDisinherit (TaskHandle_t const pxMutexHolder) PRIVILEGED_FUNCTION
BaseType_t	xTaskRemoveFromEventList (const List_t *const pxEventList) PRIVILEGED_FUNCTION
BaseType_t	xTaskRemoveFromUnorderedEventList (ListItem_t *pxEventListItem, const TickType_t xItemValue) PRIVILEGED_FUNCTION
BaseType_t	xTaskResumeAll (void) PRIVILEGED_FUNCTION
BaseType_t	xTaskResumeFromISR (TaskHandle_t xTaskToResume) PRIVILEGED_FUNCTION

#define taskDISABLE_INTERRUPTS

(

)

portDISABLE_INTERRUPTS()

#define taskENABLE_INTERRUPTS

(

)

portENABLE_INTERRUPTS()

#define taskENTER_CRITICAL

(

)

portENTER_CRITICAL()

#define taskENTER_CRITICAL_FROM_ISR

(

)

portSET_INTERRUPT_MASK_FROM_ISR()

#define taskEXIT_CRITICAL

(

)

portEXIT_CRITICAL()

#define taskEXIT_CRITICAL_FROM_ISR

(

x

)

portCLEAR_INTERRUPT_MASK_FROM_ISR( x )

#define taskSCHEDULER_NOT_STARTED   ( ( BaseType_t ) 1 )

#define taskSCHEDULER_RUNNING   ( ( BaseType_t ) 2 )

#define taskSCHEDULER_SUSPENDED   ( ( BaseType_t ) 0 )

#define taskYIELD

(

)

portYIELD()

#define tskIDLE_PRIORITY   ( ( UBaseType_t ) 0U )

Defines the priority used by the idle task.

This must not be modified.

#define tskKERNEL_VERSION_BUILD   3

#define tskKERNEL_VERSION_MAJOR   8

#define tskKERNEL_VERSION_MINOR   2

#define tskKERNEL_VERSION_NUMBER   "V8.2.3"

#define xTaskCreate	(		pvTaskCode,
			pcName,
			usStackDepth,
			pvParameters,
			uxPriority,
			pxCreatedTask
	)		xTaskGenericCreate( ( pvTaskCode ), ( pcName ), ( usStackDepth ), ( pvParameters ), ( uxPriority ), ( pxCreatedTask ), ( NULL ), ( NULL ) )

#define xTaskCreateRestricted	(		x,
			pxCreatedTask
	)		xTaskGenericCreate( ((x)->pvTaskCode), ((x)->pcName), ((x)->usStackDepth), ((x)->pvParameters), ((x)->uxPriority), (pxCreatedTask), ((x)->puxStackBuffer), ((x)->xRegions) )

#define xTaskNotify	(		xTaskToNotify,
			ulValue,
			eAction
	)		xTaskGenericNotify( ( xTaskToNotify ), ( ulValue ), ( eAction ), NULL )

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

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

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

#define xTaskNotifyGive

(

xTaskToNotify

)

xTaskGenericNotify( ( xTaskToNotify ), ( 0 ), eIncrement, NULL )

typedef struct xMEMORY_REGION MemoryRegion_t

typedef void* TaskHandle_t

typedef BaseType_t(* TaskHookFunction_t)(void *)

typedef struct xTASK_PARAMETERS TaskParameters_t

typedef struct xTASK_STATUS TaskStatus_t

typedef struct xTIME_OUT TimeOut_t

enum eNotifyAction

Enumerator
eNoAction
eSetBits
eIncrement
eSetValueWithOverwrite
eSetValueWithoutOverwrite
eNoAction
eSetBits
eIncrement
eSetValueWithOverwrite
eSetValueWithoutOverwrite

enum eSleepModeStatus

Enumerator
eAbortSleep
eStandardSleep
eNoTasksWaitingTimeout
eAbortSleep
eStandardSleep
eNoTasksWaitingTimeout
eAbortSleep
eStandardSleep
eNoTasksWaitingTimeout
eAbortSleep
eStandardSleep
eNoTasksWaitingTimeout
eAbortSleep
eStandardSleep
eNoTasksWaitingTimeout

enum eTaskState

Enumerator
eRunning
eReady
eBlocked
eSuspended
eDeleted
eRunning
eReady
eBlocked
eSuspended
eDeleted
eRunning
eReady
eBlocked
eSuspended
eDeleted
eRunning
eReady
eBlocked
eSuspended
eDeleted
eInvalid
eRunning
eReady
eBlocked
eSuspended
eDeleted
eRunning
eReady
eBlocked
eSuspended
eDeleted

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* pcTaskGetTaskName

(

TaskHandle_t

xTaskToQuery

)

void* pvTaskIncrementMutexHeldCount

(

void

)

uint32_t ulTaskNotifyTake	(	BaseType_t	xClearCountOnExit,
		TickType_t	xTicksToWait
	)

UBaseType_t uxTaskGetNumberOfTasks

(

void

)

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.

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

(

TaskHandle_t

xTask

)

UBaseType_t uxTaskPriorityGetFromISR

(

TaskHandle_t

xTask

)

task.

h

UBaseType_t uxTaskPriorityGetFromISR( TaskHandle_t xTask );

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

TickType_t uxTaskResetEventItemValue

(

void

)

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

void vTaskDelay

(

const TickType_t

xTicksToDelay

)

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

void vTaskDelete

(

TaskHandle_t

xTaskToDelete

)

void vTaskEndScheduler

(

void

)

void vTaskGetRunTimeStats

(

char *

pcWriteBuffer

)

void vTaskList

(

char *

pcWriteBuffer

)

void vTaskMissedYield

(

void

)

void vTaskNotifyGiveFromISR	(	TaskHandle_t	xTaskToNotify,
		BaseType_t *	pxHigherPriorityTaskWoken
	)

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

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

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

void vTaskPriorityInherit

(

TaskHandle_t const

pxMutexHolder

)

void vTaskPrioritySet	(	TaskHandle_t	xTask,
		UBaseType_t	uxNewPriority
	)

void vTaskResume

(

TaskHandle_t

xTaskToResume

)

void vTaskSetTaskNumber	(	TaskHandle_t	xTask,
		const UBaseType_t	uxHandle
	)

void vTaskSetTimeOutState

(

TimeOut_t *const

pxTimeOut

)

void vTaskStartScheduler

(

void

)

void vTaskStepTick

(

const TickType_t

xTicksToJump

)

void vTaskSuspend

(

TaskHandle_t

xTaskToSuspend

)

void vTaskSuspendAll

(

void

)

void vTaskSwitchContext

(

void

)

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 xTaskCheckForTimeOut	(	TimeOut_t *const	pxTimeOut,
		TickType_t *const	pxTicksToWait
	)

BaseType_t xTaskGenericCreate	(	TaskFunction_t	pxTaskCode,
		const char *const	pcName,
		const uint16_t	usStackDepth,
		void *const	pvParameters,
		UBaseType_t	uxPriority,
		TaskHandle_t *const	pxCreatedTask,
		StackType_t *const	puxStackBuffer,
		const MemoryRegion_t *const	xRegions
	)

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

)

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

)

TickType_t xTaskGetTickCount

(

void

)

TickType_t xTaskGetTickCountFromISR

(

void

)

BaseType_t xTaskIncrementTick

(

void

)

BaseType_t xTaskNotifyStateClear

(

TaskHandle_t

xTask

)

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

BaseType_t xTaskPriorityDisinherit

(

TaskHandle_t const

pxMutexHolder

)

BaseType_t xTaskRemoveFromEventList

(

const List_t *const

pxEventList

)

BaseType_t xTaskRemoveFromUnorderedEventList	(	ListItem_t *	pxEventListItem,
		const TickType_t	xItemValue
	)

BaseType_t xTaskResumeAll

(

void

)

BaseType_t xTaskResumeFromISR

(

TaskHandle_t

xTaskToResume

)