task.h File Reference

#include "list.h"

Include dependency graph for task.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	xTIME_OUT
struct	xMEMORY_REGION
struct	xTASK_PARAMETERS
struct	xTASK_STATUS

Macros
#define	tskKERNEL_VERSION_NUMBER   "V10.6.2"
#define	tskKERNEL_VERSION_MAJOR   10
#define	tskKERNEL_VERSION_MINOR   6
#define	tskKERNEL_VERSION_BUILD   2
#define	tskMPU_REGION_READ_ONLY   ( 1UL << 0UL )
#define	tskMPU_REGION_READ_WRITE   ( 1UL << 1UL )
#define	tskMPU_REGION_EXECUTE_NEVER   ( 1UL << 2UL )
#define	tskMPU_REGION_NORMAL_MEMORY   ( 1UL << 3UL )
#define	tskMPU_REGION_DEVICE_MEMORY   ( 1UL << 4UL )
#define	tskMPU_READ_PERMISSION   ( 1UL << 0UL )
#define	tskMPU_WRITE_PERMISSION   ( 1UL << 1UL )
#define	tskDEFAULT_INDEX_TO_NOTIFY   ( 0 )
#define	tskIDLE_PRIORITY   ( ( UBaseType_t ) 0U )
	Defines the priority used by the idle task.
#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   ( ( BaseType_t ) 0 )
#define	taskSCHEDULER_NOT_STARTED   ( ( BaseType_t ) 1 )
#define	taskSCHEDULER_RUNNING   ( ( BaseType_t ) 2 )
#define	vTaskDelayUntil(pxPreviousWakeTime, xTimeIncrement)
#define	xTaskNotify(xTaskToNotify, ulValue, eAction)
#define	xTaskNotifyIndexed(xTaskToNotify, uxIndexToNotify, ulValue, eAction)
#define	xTaskNotifyAndQuery(xTaskToNotify, ulValue, eAction, pulPreviousNotifyValue)
#define	xTaskNotifyAndQueryIndexed(xTaskToNotify, uxIndexToNotify, ulValue, eAction, pulPreviousNotifyValue)
#define	xTaskNotifyFromISR(xTaskToNotify, ulValue, eAction, pxHigherPriorityTaskWoken)
#define	xTaskNotifyIndexedFromISR(xTaskToNotify, uxIndexToNotify, ulValue, eAction, pxHigherPriorityTaskWoken)
#define	xTaskNotifyAndQueryIndexedFromISR(xTaskToNotify, uxIndexToNotify, ulValue, eAction, pulPreviousNotificationValue, pxHigherPriorityTaskWoken)
#define	xTaskNotifyAndQueryFromISR(xTaskToNotify, ulValue, eAction, pulPreviousNotificationValue, pxHigherPriorityTaskWoken)
#define	xTaskNotifyWait(ulBitsToClearOnEntry, ulBitsToClearOnExit, pulNotificationValue, xTicksToWait)
#define	xTaskNotifyWaitIndexed(uxIndexToWaitOn, ulBitsToClearOnEntry, ulBitsToClearOnExit, pulNotificationValue, xTicksToWait)
#define	xTaskNotifyGive(xTaskToNotify)
#define	xTaskNotifyGiveIndexed(xTaskToNotify, uxIndexToNotify)
#define	vTaskNotifyGiveFromISR(xTaskToNotify, pxHigherPriorityTaskWoken)
#define	vTaskNotifyGiveIndexedFromISR(xTaskToNotify, uxIndexToNotify, pxHigherPriorityTaskWoken)
#define	ulTaskNotifyTake(xClearCountOnExit, xTicksToWait)
#define	ulTaskNotifyTakeIndexed(uxIndexToWaitOn, xClearCountOnExit, xTicksToWait)
#define	xTaskNotifyStateClear(xTask)
#define	xTaskNotifyStateClearIndexed(xTask, uxIndexToClear)
#define	ulTaskNotifyValueClear(xTask, ulBitsToClear)
#define	ulTaskNotifyValueClearIndexed(xTask, uxIndexToClear, ulBitsToClear)

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

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

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
BaseType_t	xTaskDelayUntil (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
	task.
eTaskState	eTaskGetState (TaskHandle_t xTask) PRIVILEGED_FUNCTION
	task.
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
	task.h
configSTACK_DEPTH_TYPE	uxTaskGetStackHighWaterMark2 (TaskHandle_t xTask) PRIVILEGED_FUNCTION
	task.h
BaseType_t	xTaskCallApplicationTaskHook (TaskHandle_t xTask, void *pvParameter) PRIVILEGED_FUNCTION
	task.h
TaskHandle_t	xTaskGetIdleTaskHandle (void) PRIVILEGED_FUNCTION
	xTaskGetIdleTaskHandle() is only available if INCLUDE_xTaskGetIdleTaskHandle is set to 1 in FreeRTOSConfig.h.
UBaseType_t	uxTaskGetSystemState (TaskStatus_t *const pxTaskStatusArray, const UBaseType_t uxArraySize, configRUN_TIME_COUNTER_TYPE *const pulTotalRunTime) PRIVILEGED_FUNCTION
	configUSE_TRACE_FACILITY must be defined as 1 in FreeRTOSConfig.h for uxTaskGetSystemState() to be available.
void	vTaskList (char *pcWriteBuffer) PRIVILEGED_FUNCTION
void	vTaskGetRunTimeStats (char *pcWriteBuffer) PRIVILEGED_FUNCTION
configRUN_TIME_COUNTER_TYPE	ulTaskGetRunTimeCounter (const TaskHandle_t xTask) PRIVILEGED_FUNCTION
configRUN_TIME_COUNTER_TYPE	ulTaskGetRunTimePercent (const TaskHandle_t xTask) PRIVILEGED_FUNCTION
configRUN_TIME_COUNTER_TYPE	ulTaskGetIdleRunTimeCounter (void) PRIVILEGED_FUNCTION
configRUN_TIME_COUNTER_TYPE	ulTaskGetIdleRunTimePercent (void) PRIVILEGED_FUNCTION
BaseType_t	xTaskGenericNotify (TaskHandle_t xTaskToNotify, UBaseType_t uxIndexToNotify, uint32_t ulValue, eNotifyAction eAction, uint32_t *pulPreviousNotificationValue) PRIVILEGED_FUNCTION
BaseType_t	xTaskGenericNotifyFromISR (TaskHandle_t xTaskToNotify, UBaseType_t uxIndexToNotify, uint32_t ulValue, eNotifyAction eAction, uint32_t *pulPreviousNotificationValue, BaseType_t *pxHigherPriorityTaskWoken) PRIVILEGED_FUNCTION
BaseType_t	xTaskGenericNotifyWait (UBaseType_t uxIndexToWaitOn, uint32_t ulBitsToClearOnEntry, uint32_t ulBitsToClearOnExit, uint32_t *pulNotificationValue, TickType_t xTicksToWait) PRIVILEGED_FUNCTION
void	vTaskGenericNotifyGiveFromISR (TaskHandle_t xTaskToNotify, UBaseType_t uxIndexToNotify, BaseType_t *pxHigherPriorityTaskWoken) PRIVILEGED_FUNCTION
uint32_t	ulTaskGenericNotifyTake (UBaseType_t uxIndexToWaitOn, BaseType_t xClearCountOnExit, TickType_t xTicksToWait) PRIVILEGED_FUNCTION
BaseType_t	xTaskGenericNotifyStateClear (TaskHandle_t xTask, UBaseType_t uxIndexToClear) PRIVILEGED_FUNCTION
uint32_t	ulTaskGenericNotifyValueClear (TaskHandle_t xTask, UBaseType_t uxIndexToClear, uint32_t ulBitsToClear) PRIVILEGED_FUNCTION
void	vTaskSetTimeOutState (TimeOut_t *const pxTimeOut) PRIVILEGED_FUNCTION
BaseType_t	xTaskCheckForTimeOut (TimeOut_t *const pxTimeOut, TickType_t *const pxTicksToWait) PRIVILEGED_FUNCTION
BaseType_t	xTaskCatchUpTicks (TickType_t xTicksToCatchUp) PRIVILEGED_FUNCTION
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	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 (TickType_t xTicksToJump) PRIVILEGED_FUNCTION
eSleepModeStatus	eTaskConfirmSleepModeStatus (void) PRIVILEGED_FUNCTION
TaskHandle_t	pvTaskIncrementMutexHeldCount (void) PRIVILEGED_FUNCTION
void	vTaskInternalSetTimeOutState (TimeOut_t *const pxTimeOut) PRIVILEGED_FUNCTION

Macro Definition Documentation

taskDISABLE_INTERRUPTS

#define taskDISABLE_INTERRUPTS

(

)

Value:

portDISABLE_INTERRUPTS()

Definition at line 241 of file task.h.

taskENABLE_INTERRUPTS

#define taskENABLE_INTERRUPTS

(

)

Value:

portENABLE_INTERRUPTS()

Definition at line 251 of file task.h.

taskENTER_CRITICAL

#define taskENTER_CRITICAL

(

)

Value:

portENTER_CRITICAL()

Definition at line 215 of file task.h.

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

taskENTER_CRITICAL_FROM_ISR

#define taskENTER_CRITICAL_FROM_ISR

(

)

Value:

portSET_INTERRUPT_MASK_FROM_ISR()

Definition at line 216 of file task.h.

Referenced by osMessageQueueGetSpace().

taskEXIT_CRITICAL

#define taskEXIT_CRITICAL

(

)

Value:

portEXIT_CRITICAL()

Definition at line 230 of file task.h.

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

taskEXIT_CRITICAL_FROM_ISR

#define taskEXIT_CRITICAL_FROM_ISR

(

x

)

Value:

portCLEAR_INTERRUPT_MASK_FROM_ISR( x )

Definition at line 231 of file task.h.

Referenced by osMessageQueueGetSpace().

taskSCHEDULER_NOT_STARTED

#define taskSCHEDULER_NOT_STARTED   ( ( BaseType_t ) 1 )

Definition at line 257 of file task.h.

Referenced by IRQ_Context(), osKernelGetState(), osKernelInitialize(), osKernelLock(), osKernelRestoreLock(), osKernelStart(), and osKernelUnlock().

taskSCHEDULER_RUNNING

#define taskSCHEDULER_RUNNING   ( ( BaseType_t ) 2 )

Definition at line 258 of file task.h.

Referenced by osKernelGetState(), osKernelLock(), osKernelRestoreLock(), and osKernelUnlock().

taskSCHEDULER_SUSPENDED

#define taskSCHEDULER_SUSPENDED   ( ( BaseType_t ) 0 )

Definition at line 256 of file task.h.

Referenced by osKernelGetState(), osKernelLock(), osKernelRestoreLock(), osKernelUnlock(), xEventGroupSync(), xEventGroupWaitBits(), xQueueGenericSend(), xQueuePeek(), xQueueReceive(), and xQueueSemaphoreTake().

taskYIELD

#define taskYIELD

(

)

Value:

portYIELD()

Definition at line 201 of file task.h.

Referenced by osThreadYield(), and portTASK_FUNCTION().

tskDEFAULT_INDEX_TO_NOTIFY

#define tskDEFAULT_INDEX_TO_NOTIFY   ( 0 )

Definition at line 79 of file task.h.

tskIDLE_PRIORITY

#define tskIDLE_PRIORITY   ( ( UBaseType_t ) 0U )

Defines the priority used by the idle task.

This must not be modified.

Definition at line 191 of file task.h.

Referenced by portTASK_FUNCTION().

tskKERNEL_VERSION_BUILD

#define tskKERNEL_VERSION_BUILD   2

Definition at line 59 of file task.h.

tskKERNEL_VERSION_MAJOR

#define tskKERNEL_VERSION_MAJOR   10

Definition at line 57 of file task.h.

tskKERNEL_VERSION_MINOR

#define tskKERNEL_VERSION_MINOR   6

Definition at line 58 of file task.h.

tskKERNEL_VERSION_NUMBER

#define tskKERNEL_VERSION_NUMBER   "V10.6.2"

Definition at line 56 of file task.h.

tskMPU_READ_PERMISSION

#define tskMPU_READ_PERMISSION   ( 1UL << 0UL )

Definition at line 71 of file task.h.

tskMPU_REGION_DEVICE_MEMORY

#define tskMPU_REGION_DEVICE_MEMORY   ( 1UL << 4UL )

Definition at line 67 of file task.h.

tskMPU_REGION_EXECUTE_NEVER

#define tskMPU_REGION_EXECUTE_NEVER   ( 1UL << 2UL )

Definition at line 65 of file task.h.

tskMPU_REGION_NORMAL_MEMORY

#define tskMPU_REGION_NORMAL_MEMORY   ( 1UL << 3UL )

Definition at line 66 of file task.h.

tskMPU_REGION_READ_ONLY

#define tskMPU_REGION_READ_ONLY   ( 1UL << 0UL )

Definition at line 63 of file task.h.

tskMPU_REGION_READ_WRITE

#define tskMPU_REGION_READ_WRITE   ( 1UL << 1UL )

Definition at line 64 of file task.h.

tskMPU_WRITE_PERMISSION

#define tskMPU_WRITE_PERMISSION   ( 1UL << 1UL )

Definition at line 72 of file task.h.

ulTaskNotifyTake

#define ulTaskNotifyTake	(		xClearCountOnExit,
			xTicksToWait )

Value:

    ulTaskGenericNotifyTake( ( tskDEFAULT_INDEX_TO_NOTIFY ), ( xClearCountOnExit ), ( xTicksToWait ) )

Definition at line 2727 of file task.h.

ulTaskNotifyTakeIndexed

#define ulTaskNotifyTakeIndexed	(		uxIndexToWaitOn,
			xClearCountOnExit,
			xTicksToWait )

Value:

    ulTaskGenericNotifyTake( ( uxIndexToWaitOn ), ( xClearCountOnExit ), ( xTicksToWait ) )

Definition at line 2729 of file task.h.

ulTaskNotifyValueClear

#define ulTaskNotifyValueClear	(		xTask,
			ulBitsToClear )

Value:

    ulTaskGenericNotifyValueClear( ( xTask ), ( tskDEFAULT_INDEX_TO_NOTIFY ), ( ulBitsToClear ) )

Definition at line 2857 of file task.h.

ulTaskNotifyValueClearIndexed

#define ulTaskNotifyValueClearIndexed	(		xTask,
			uxIndexToClear,
			ulBitsToClear )

Value:

    ulTaskGenericNotifyValueClear( ( xTask ), ( uxIndexToClear ), ( ulBitsToClear ) )

Definition at line 2859 of file task.h.

vTaskDelayUntil

#define vTaskDelayUntil	(		pxPreviousWakeTime,
			xTimeIncrement )

Value:

    do {                                                                        \
        ( void ) xTaskDelayUntil( ( pxPreviousWakeTime ), ( xTimeIncrement ) ); \
    } while( 0 )

Definition at line 873 of file task.h.

vTaskNotifyGiveFromISR

#define vTaskNotifyGiveFromISR	(		xTaskToNotify,
			pxHigherPriorityTaskWoken )

Value:

    vTaskGenericNotifyGiveFromISR( ( xTaskToNotify ), ( tskDEFAULT_INDEX_TO_NOTIFY ), ( pxHigherPriorityTaskWoken ) )

Definition at line 2621 of file task.h.

vTaskNotifyGiveIndexedFromISR

#define vTaskNotifyGiveIndexedFromISR	(		xTaskToNotify,
			uxIndexToNotify,
			pxHigherPriorityTaskWoken )

Value:

    vTaskGenericNotifyGiveFromISR( ( xTaskToNotify ), ( uxIndexToNotify ), ( pxHigherPriorityTaskWoken ) )

Definition at line 2623 of file task.h.

xTaskNotify

#define xTaskNotify	(		xTaskToNotify,
			ulValue,
			eAction )

Value:

    xTaskGenericNotify( ( xTaskToNotify ), ( tskDEFAULT_INDEX_TO_NOTIFY ), ( ulValue ), ( eAction ), NULL )

Definition at line 2161 of file task.h.

xTaskNotifyAndQuery

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

Value:

    xTaskGenericNotify( ( xTaskToNotify ), ( tskDEFAULT_INDEX_TO_NOTIFY ), ( ulValue ), ( eAction ), ( pulPreviousNotifyValue ) )

Definition at line 2190 of file task.h.

xTaskNotifyAndQueryFromISR

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

Value:

    xTaskGenericNotifyFromISR( ( xTaskToNotify ), ( tskDEFAULT_INDEX_TO_NOTIFY ), ( ulValue ), ( eAction ), ( pulPreviousNotificationValue ), ( pxHigherPriorityTaskWoken ) )

Definition at line 2345 of file task.h.

xTaskNotifyAndQueryIndexed

#define xTaskNotifyAndQueryIndexed	(		xTaskToNotify,
			uxIndexToNotify,
			ulValue,
			eAction,
			pulPreviousNotifyValue )

Value:

    xTaskGenericNotify( ( xTaskToNotify ), ( uxIndexToNotify ), ( ulValue ), ( eAction ), ( pulPreviousNotifyValue ) )

Definition at line 2192 of file task.h.

xTaskNotifyAndQueryIndexedFromISR

#define xTaskNotifyAndQueryIndexedFromISR	(		xTaskToNotify,
			uxIndexToNotify,
			ulValue,
			eAction,
			pulPreviousNotificationValue,
			pxHigherPriorityTaskWoken )

Value:

    xTaskGenericNotifyFromISR( ( xTaskToNotify ), ( uxIndexToNotify ), ( ulValue ), ( eAction ), ( pulPreviousNotificationValue ), ( pxHigherPriorityTaskWoken ) )

Definition at line 2343 of file task.h.

xTaskNotifyFromISR

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

Value:

    xTaskGenericNotifyFromISR( ( xTaskToNotify ), ( tskDEFAULT_INDEX_TO_NOTIFY ), ( ulValue ), ( eAction ), NULL, ( pxHigherPriorityTaskWoken ) )

Definition at line 2314 of file task.h.

Referenced by xStreamBufferReceiveCompletedFromISR(), and xStreamBufferSendCompletedFromISR().

xTaskNotifyGive

#define xTaskNotifyGive

(

xTaskToNotify

)

Value:

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

Definition at line 2534 of file task.h.

xTaskNotifyGiveIndexed

#define xTaskNotifyGiveIndexed	(		xTaskToNotify,
			uxIndexToNotify )

Value:

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

Definition at line 2536 of file task.h.

xTaskNotifyIndexed

#define xTaskNotifyIndexed	(		xTaskToNotify,
			uxIndexToNotify,
			ulValue,
			eAction )

Value:

    xTaskGenericNotify( ( xTaskToNotify ), ( uxIndexToNotify ), ( ulValue ), ( eAction ), NULL )

Definition at line 2163 of file task.h.

xTaskNotifyIndexedFromISR

#define xTaskNotifyIndexedFromISR	(		xTaskToNotify,
			uxIndexToNotify,
			ulValue,
			eAction,
			pxHigherPriorityTaskWoken )

Value:

    xTaskGenericNotifyFromISR( ( xTaskToNotify ), ( uxIndexToNotify ), ( ulValue ), ( eAction ), NULL, ( pxHigherPriorityTaskWoken ) )

Definition at line 2316 of file task.h.

xTaskNotifyStateClear

#define xTaskNotifyStateClear

(

xTask

)

Value:

    xTaskGenericNotifyStateClear( ( xTask ), ( tskDEFAULT_INDEX_TO_NOTIFY ) )

Definition at line 2791 of file task.h.

Referenced by xStreamBufferReceive(), and xStreamBufferSend().

xTaskNotifyStateClearIndexed

#define xTaskNotifyStateClearIndexed	(		xTask,
			uxIndexToClear )

Value:

    xTaskGenericNotifyStateClear( ( xTask ), ( uxIndexToClear ) )

Definition at line 2793 of file task.h.

xTaskNotifyWait

#define xTaskNotifyWait	(		ulBitsToClearOnEntry,
			ulBitsToClearOnExit,
			pulNotificationValue,
			xTicksToWait )

Value:

    xTaskGenericNotifyWait( tskDEFAULT_INDEX_TO_NOTIFY, ( ulBitsToClearOnEntry ), ( ulBitsToClearOnExit ), ( pulNotificationValue ), ( xTicksToWait ) )

Definition at line 2457 of file task.h.

Referenced by xStreamBufferReceive(), and xStreamBufferSend().

xTaskNotifyWaitIndexed

#define xTaskNotifyWaitIndexed	(		uxIndexToWaitOn,
			ulBitsToClearOnEntry,
			ulBitsToClearOnExit,
			pulNotificationValue,
			xTicksToWait )

Value:

    xTaskGenericNotifyWait( ( uxIndexToWaitOn ), ( ulBitsToClearOnEntry ), ( ulBitsToClearOnExit ), ( pulNotificationValue ), ( xTicksToWait ) )

Definition at line 2459 of file task.h.

Typedef Documentation

MemoryRegion_t

typedef struct xMEMORY_REGION MemoryRegion_t

TaskHandle_t

typedef struct tskTaskControlBlock* TaskHandle_t

Definition at line 92 of file task.h.

TaskHookFunction_t

typedef BaseType_t(* TaskHookFunction_t) (void *)

Definition at line 98 of file task.h.

TaskParameters_t

typedef struct xTASK_PARAMETERS TaskParameters_t

TaskStatus_t

typedef struct xTASK_STATUS TaskStatus_t

TimeOut_t

typedef struct xTIME_OUT TimeOut_t

Enumeration Type Documentation

eNotifyAction

enum eNotifyAction

Enumerator
eNoAction
eSetBits
eIncrement
eSetValueWithOverwrite
eSetValueWithoutOverwrite

Definition at line 112 of file task.h.

eSleepModeStatus

enum eSleepModeStatus

Enumerator
eAbortSleep
eStandardSleep

Definition at line 177 of file task.h.

eTaskState

enum eTaskState

Enumerator
eRunning
eReady
eBlocked
eSuspended
eDeleted
eInvalid

Definition at line 101 of file task.h.

Function Documentation

eTaskConfirmSleepModeStatus()

eSleepModeStatus eTaskConfirmSleepModeStatus

(

void

)

References PRIVILEGED_FUNCTION.

eTaskGetState()

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.

References PRIVILEGED_FUNCTION.

Referenced by osThreadGetState(), and osThreadTerminate().

pcTaskGetName()

char * pcTaskGetName

(

TaskHandle_t

xTaskToQuery

)

Definition at line 2353 of file tasks.c.

References configASSERT, tskTaskControlBlock::pcTaskName, and prvGetTCBFromHandle.

Referenced by osThreadGetName().

pvTaskIncrementMutexHeldCount()

TaskHandle_t pvTaskIncrementMutexHeldCount

(

void

)

References PRIVILEGED_FUNCTION.

Referenced by xQueueSemaphoreTake().

ulTaskGenericNotifyTake()

uint32_t ulTaskGenericNotifyTake	(	UBaseType_t	uxIndexToWaitOn,
		BaseType_t	xClearCountOnExit,
		TickType_t	xTicksToWait )

References PRIVILEGED_FUNCTION.

ulTaskGenericNotifyValueClear()

uint32_t ulTaskGenericNotifyValueClear	(	TaskHandle_t	xTask,
		UBaseType_t	uxIndexToClear,
		uint32_t	ulBitsToClear )

References PRIVILEGED_FUNCTION.

ulTaskGetIdleRunTimeCounter()

configRUN_TIME_COUNTER_TYPE ulTaskGetIdleRunTimeCounter

(

void

)

References configRUN_TIME_COUNTER_TYPE, and PRIVILEGED_FUNCTION.

ulTaskGetIdleRunTimePercent()

configRUN_TIME_COUNTER_TYPE ulTaskGetIdleRunTimePercent

(

void

)

References configRUN_TIME_COUNTER_TYPE, and PRIVILEGED_FUNCTION.

ulTaskGetRunTimeCounter()

configRUN_TIME_COUNTER_TYPE ulTaskGetRunTimeCounter

(

const TaskHandle_t

xTask

)

References configRUN_TIME_COUNTER_TYPE, and PRIVILEGED_FUNCTION.

ulTaskGetRunTimePercent()

configRUN_TIME_COUNTER_TYPE ulTaskGetRunTimePercent

(

const TaskHandle_t

xTask

)

References configRUN_TIME_COUNTER_TYPE, and PRIVILEGED_FUNCTION.

uxTaskGetNumberOfTasks()

UBaseType_t uxTaskGetNumberOfTasks

(

void

)

Definition at line 2345 of file tasks.c.

References uxCurrentNumberOfTasks.

Referenced by osThreadEnumerate(), and osThreadGetCount().

uxTaskGetStackHighWaterMark()

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.

References PRIVILEGED_FUNCTION.

Referenced by osThreadGetStackSpace().

uxTaskGetStackHighWaterMark2()

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.

References configSTACK_DEPTH_TYPE, and PRIVILEGED_FUNCTION.

uxTaskGetSystemState()

UBaseType_t uxTaskGetSystemState	(	TaskStatus_t *const	pxTaskStatusArray,
		const UBaseType_t	uxArraySize,
		configRUN_TIME_COUNTER_TYPE *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 https://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;
 configRUN_TIME_COUNTER_TYPE 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 );
     }
 }

References configRUN_TIME_COUNTER_TYPE, and PRIVILEGED_FUNCTION.

Referenced by osThreadEnumerate().

uxTaskGetTaskNumber()

UBaseType_t uxTaskGetTaskNumber

(

TaskHandle_t

xTask

)

References PRIVILEGED_FUNCTION.

uxTaskPriorityGet()

UBaseType_t uxTaskPriorityGet

(

const TaskHandle_t

xTask

)

References PRIVILEGED_FUNCTION.

Referenced by osThreadGetPriority().

uxTaskPriorityGetFromISR()

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.

References PRIVILEGED_FUNCTION.

uxTaskResetEventItemValue()

TickType_t uxTaskResetEventItemValue

(

void

)

Definition at line 4725 of file tasks.c.

References configMAX_PRIORITIES, listGET_LIST_ITEM_VALUE, listSET_LIST_ITEM_VALUE, and pxCurrentTCB.

Referenced by xEventGroupSync(), and xEventGroupWaitBits().

vTaskAllocateMPURegions()

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

References PRIVILEGED_FUNCTION.

vTaskDelay()

void vTaskDelay

(

const TickType_t

xTicksToDelay

)

References PRIVILEGED_FUNCTION.

Referenced by osDelay().

vTaskDelete()

void vTaskDelete

(

TaskHandle_t

xTaskToDelete

)

References PRIVILEGED_FUNCTION.

Referenced by osThreadExit(), and osThreadTerminate().

vTaskEndScheduler()

void vTaskEndScheduler

(

void

)

Definition at line 2092 of file tasks.c.

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

vTaskGenericNotifyGiveFromISR()

void vTaskGenericNotifyGiveFromISR	(	TaskHandle_t	xTaskToNotify,
		UBaseType_t	uxIndexToNotify,
		BaseType_t *	pxHigherPriorityTaskWoken )

References PRIVILEGED_FUNCTION.

vTaskGetInfo()

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

References PRIVILEGED_FUNCTION.

vTaskGetRunTimeStats()

void vTaskGetRunTimeStats

(

char *

pcWriteBuffer

)

References PRIVILEGED_FUNCTION.

vTaskInternalSetTimeOutState()

void vTaskInternalSetTimeOutState

(

TimeOut_t *const

pxTimeOut

)

Definition at line 3358 of file tasks.c.

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

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

vTaskList()

void vTaskList

(

char *

pcWriteBuffer

)

References PRIVILEGED_FUNCTION.

vTaskMissedYield()

void vTaskMissedYield

(

void

)

Definition at line 3431 of file tasks.c.

References pdTRUE, and xYieldPending.

Referenced by prvUnlockQueue().

vTaskPlaceOnEventList()

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

Definition at line 3143 of file tasks.c.

References configASSERT, pdTRUE, prvAddCurrentTaskToDelayedList(), pxCurrentTCB, and vListInsert().

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

vTaskPlaceOnEventListRestricted()

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

References portDONT_DISCARD, and PRIVILEGED_FUNCTION.

vTaskPlaceOnUnorderedEventList()

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

Definition at line 3168 of file tasks.c.

References configASSERT, listINSERT_END, listSET_LIST_ITEM_VALUE, pdTRUE, prvAddCurrentTaskToDelayedList(), pxCurrentTCB, taskEVENT_LIST_ITEM_VALUE_IN_USE, and uxSchedulerSuspended.

Referenced by xEventGroupSync(), and xEventGroupWaitBits().

vTaskPriorityDisinheritAfterTimeout()

void vTaskPriorityDisinheritAfterTimeout	(	TaskHandle_t const	pxMutexHolder,
		UBaseType_t	uxHighestPriorityWaitingTask )

References PRIVILEGED_FUNCTION.

Referenced by xQueueSemaphoreTake().

vTaskPrioritySet()

void vTaskPrioritySet	(	TaskHandle_t	xTask,
		UBaseType_t	uxNewPriority )

References PRIVILEGED_FUNCTION.

Referenced by osThreadSetPriority().

vTaskRemoveFromUnorderedEventList()

void vTaskRemoveFromUnorderedEventList	(	ListItem_t *	pxEventListItem,
		const TickType_t	xItemValue )

Definition at line 3297 of file tasks.c.

References configASSERT, listGET_LIST_ITEM_OWNER, listREMOVE_ITEM, listSET_LIST_ITEM_VALUE, pdTRUE, prvAddTaskToReadyList, prvResetNextTaskUnblockTime(), pxCurrentTCB, taskEVENT_LIST_ITEM_VALUE_IN_USE, tskTaskControlBlock::uxPriority, uxSchedulerSuspended, tskTaskControlBlock::xStateListItem, and xYieldPending.

Referenced by vEventGroupDelete(), and xEventGroupSetBits().

vTaskResume()

void vTaskResume

(

TaskHandle_t

xTaskToResume

)

References PRIVILEGED_FUNCTION.

Referenced by osThreadResume().

vTaskSetTaskNumber()

void vTaskSetTaskNumber	(	TaskHandle_t	xTask,
		const UBaseType_t	uxHandle )

References PRIVILEGED_FUNCTION.

vTaskSetTimeOutState()

void vTaskSetTimeOutState

(

TimeOut_t *const

pxTimeOut

)

Definition at line 3346 of file tasks.c.

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

Referenced by xStreamBufferSend().

vTaskStartScheduler()

void vTaskStartScheduler

(

void

)

Definition at line 1967 of file tasks.c.

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

Referenced by osKernelStart().

vTaskStepTick()

void vTaskStepTick

(

TickType_t

xTicksToJump

)

References PRIVILEGED_FUNCTION.

vTaskSuspend()

void vTaskSuspend

(

TaskHandle_t

xTaskToSuspend

)

References PRIVILEGED_FUNCTION.

Referenced by osThreadSuspend().

vTaskSuspendAll()

void vTaskSuspendAll

(

void

)

Definition at line 2103 of file tasks.c.

References portMEMORY_BARRIER, portSOFTWARE_BARRIER, and uxSchedulerSuspended.

Referenced by board_sleep(), osKernelLock(), osKernelRestoreLock(), osThreadEnumerate(), portTASK_FUNCTION(), prvHeapInit(), vEventGroupDelete(), vPortFree(), vPortGetHeapStats(), xEventGroupSetBits(), xEventGroupSync(), xEventGroupWaitBits(), xQueueGenericSend(), xQueuePeek(), xQueueReceive(), xQueueSemaphoreTake(), and xTaskCatchUpTicks().

vTaskSwitchContext()

portDONT_DISCARD void vTaskSwitchContext

(

void

)

Definition at line 3069 of file tasks.c.

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

Referenced by xPortStartScheduler().

xTaskAbortDelay()

BaseType_t xTaskAbortDelay

(

TaskHandle_t

xTask

)

References PRIVILEGED_FUNCTION.

xTaskCallApplicationTaskHook()

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.

References PRIVILEGED_FUNCTION.

xTaskCatchUpTicks()

BaseType_t xTaskCatchUpTicks

(

TickType_t

xTicksToCatchUp

)

Definition at line 2676 of file tasks.c.

References configASSERT, taskENTER_CRITICAL, taskEXIT_CRITICAL, uxSchedulerSuspended, vTaskSuspendAll(), xPendedTicks, and xTaskResumeAll().

Referenced by board_sleep().

xTaskCheckForTimeOut()

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

Definition at line 3366 of file tasks.c.

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

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

xTaskDelayUntil()

BaseType_t xTaskDelayUntil	(	TickType_t *const	pxPreviousWakeTime,
		const TickType_t	xTimeIncrement )

References PRIVILEGED_FUNCTION.

Referenced by osDelayUntil().

xTaskGenericNotify()

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

References PRIVILEGED_FUNCTION.

xTaskGenericNotifyFromISR()

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

References PRIVILEGED_FUNCTION.

xTaskGenericNotifyStateClear()

BaseType_t xTaskGenericNotifyStateClear	(	TaskHandle_t	xTask,
		UBaseType_t	uxIndexToClear )

References PRIVILEGED_FUNCTION.

xTaskGenericNotifyWait()

BaseType_t xTaskGenericNotifyWait	(	UBaseType_t	uxIndexToWaitOn,
		uint32_t	ulBitsToClearOnEntry,
		uint32_t	ulBitsToClearOnExit,
		uint32_t *	pulNotificationValue,
		TickType_t	xTicksToWait )

References PRIVILEGED_FUNCTION.

xTaskGetCurrentTaskHandle()

TaskHandle_t xTaskGetCurrentTaskHandle

(

void

)

References PRIVILEGED_FUNCTION.

Referenced by osThreadGetId(), xStreamBufferReceive(), and xStreamBufferSend().

xTaskGetHandle()

TaskHandle_t xTaskGetHandle

(

const char *

pcNameToQuery

)

References PRIVILEGED_FUNCTION.

xTaskGetIdleTaskHandle()

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.

References PRIVILEGED_FUNCTION.

xTaskGetSchedulerState()

BaseType_t xTaskGetSchedulerState

(

void

)

References PRIVILEGED_FUNCTION.

Referenced by IRQ_Context(), osKernelGetState(), osKernelInitialize(), osKernelLock(), osKernelRestoreLock(), osKernelStart(), osKernelUnlock(), xEventGroupSync(), xEventGroupWaitBits(), xQueueGenericSend(), xQueuePeek(), xQueueReceive(), and xQueueSemaphoreTake().

xTaskGetTickCount()

TickType_t xTaskGetTickCount

(

void

)

Definition at line 2299 of file tasks.c.

References portTICK_TYPE_ENTER_CRITICAL, portTICK_TYPE_EXIT_CRITICAL, and xTickCount.

Referenced by osDelayUntil(), osKernelGetSysTimerCount(), and osKernelGetTickCount().

xTaskGetTickCountFromISR()

TickType_t xTaskGetTickCountFromISR

(

void

)

Definition at line 2314 of file tasks.c.

References portTICK_TYPE_CLEAR_INTERRUPT_MASK_FROM_ISR, portTICK_TYPE_SET_INTERRUPT_MASK_FROM_ISR, and xTickCount.

Referenced by osKernelGetTickCount().

xTaskIncrementTick()

BaseType_t xTaskIncrementTick

(

void

)

Definition at line 2780 of file tasks.c.

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

Referenced by xPortSysTickHandler(), and xTaskResumeAll().

xTaskPriorityDisinherit()

BaseType_t xTaskPriorityDisinherit

(

TaskHandle_t const

pxMutexHolder

)

References PRIVILEGED_FUNCTION.

Referenced by prvCopyDataToQueue().

xTaskPriorityInherit()

BaseType_t xTaskPriorityInherit

(

TaskHandle_t const

pxMutexHolder

)

References PRIVILEGED_FUNCTION.

Referenced by xQueueSemaphoreTake().

xTaskRemoveFromEventList()

BaseType_t xTaskRemoveFromEventList

(

const List_t *const

pxEventList

)

Definition at line 3229 of file tasks.c.

References configASSERT, listGET_OWNER_OF_HEAD_ENTRY, listINSERT_END, listREMOVE_ITEM, pdFALSE, pdTRUE, prvAddTaskToReadyList, prvResetNextTaskUnblockTime(), pxCurrentTCB, tskTaskControlBlock::uxPriority, uxSchedulerSuspended, tskTaskControlBlock::xEventListItem, xPendingReadyList, tskTaskControlBlock::xStateListItem, and xYieldPending.

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

xTaskResumeAll()

BaseType_t xTaskResumeAll

(

void

)

Definition at line 2187 of file tasks.c.

References configASSERT, listGET_OWNER_OF_HEAD_ENTRY, listLIST_IS_EMPTY, listREMOVE_ITEM, mtCOVERAGE_TEST_MARKER, NULL, pdFALSE, pdTRUE, portMEMORY_BARRIER, prvAddTaskToReadyList, prvResetNextTaskUnblockTime(), pxCurrentTCB, taskENTER_CRITICAL, taskEXIT_CRITICAL, taskYIELD_IF_USING_PREEMPTION, uxCurrentNumberOfTasks, tskTaskControlBlock::uxPriority, uxSchedulerSuspended, tskTaskControlBlock::xEventListItem, xPendedTicks, xPendingReadyList, tskTaskControlBlock::xStateListItem, xTaskIncrementTick(), and xYieldPending.

Referenced by board_sleep(), osKernelRestoreLock(), osKernelUnlock(), osThreadEnumerate(), portTASK_FUNCTION(), prvHeapInit(), vEventGroupDelete(), vPortFree(), vPortGetHeapStats(), xEventGroupSetBits(), xEventGroupSync(), xEventGroupWaitBits(), xQueueGenericSend(), xQueuePeek(), xQueueReceive(), xQueueSemaphoreTake(), and xTaskCatchUpTicks().

xTaskResumeFromISR()

BaseType_t xTaskResumeFromISR

(

TaskHandle_t

xTaskToResume

)

References PRIVILEGED_FUNCTION.