firmware
IEM Firmware Documentation
Loading...
Searching...
No Matches
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.

Data Structures

struct  xTIME_OUT
struct  xMEMORY_REGION
struct  xTASK_PARAMETERS
struct  xTASK_STATUS

Macros

#define tskKERNEL_VERSION_NUMBER   "V11.1.0"
#define tskKERNEL_VERSION_MAJOR   11
#define tskKERNEL_VERSION_MINOR   1
#define tskKERNEL_VERSION_BUILD   0
#define tskMPU_REGION_READ_ONLY   ( 1U << 0U )
#define tskMPU_REGION_READ_WRITE   ( 1U << 1U )
#define tskMPU_REGION_EXECUTE_NEVER   ( 1U << 2U )
#define tskMPU_REGION_NORMAL_MEMORY   ( 1U << 3U )
#define tskMPU_REGION_DEVICE_MEMORY   ( 1U << 4U )
#define tskMPU_READ_PERMISSION   ( 1U << 0U )
#define tskMPU_WRITE_PERMISSION   ( 1U << 1U )
#define tskDEFAULT_INDEX_TO_NOTIFY   ( 0 )
#define tskIDLE_PRIORITY   ( ( UBaseType_t ) 0U )
#define tskNO_AFFINITY   ( ( UBaseType_t ) -1 )
#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 taskVALID_CORE_ID(xCoreID)
#define vTaskDelayUntil(pxPreviousWakeTime, xTimeIncrement)
#define vTaskList(pcWriteBuffer)
#define vTaskGetRunTimeStats(pcWriteBuffer)
#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)
#define taskYIELD_WITHIN_API()

Typedefs

typedef struct tskTaskControlBlockTaskHandle_t
typedef const struct tskTaskControlBlockConstTaskHandle_t
typedef BaseType_t(* TaskHookFunction_t) (void *arg)
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 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
UBaseType_t uxTaskPriorityGet (const TaskHandle_t xTask) PRIVILEGED_FUNCTION
UBaseType_t uxTaskPriorityGetFromISR (const TaskHandle_t xTask) PRIVILEGED_FUNCTION
UBaseType_t uxTaskBasePriorityGet (const TaskHandle_t xTask) PRIVILEGED_FUNCTION
UBaseType_t uxTaskBasePriorityGetFromISR (const TaskHandle_t xTask) 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
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
void vTaskResetState (void) 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 (BaseType_t xCoreID) PRIVILEGED_FUNCTION
TickType_t uxTaskResetEventItemValue (void) PRIVILEGED_FUNCTION
TaskHandle_t xTaskGetCurrentTaskHandle (void) PRIVILEGED_FUNCTION
TaskHandle_t xTaskGetCurrentTaskHandleForCore (BaseType_t xCoreID) 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
TaskHandle_t pvTaskIncrementMutexHeldCount (void) PRIVILEGED_FUNCTION
void vTaskInternalSetTimeOutState (TimeOut_t *const pxTimeOut) PRIVILEGED_FUNCTION

Macro Definition Documentation

◆ taskDISABLE_INTERRUPTS

#define taskDISABLE_INTERRUPTS ( )
Value:
#define portDISABLE_INTERRUPTS()
Definition portmacro.h:118

◆ taskENABLE_INTERRUPTS

#define taskENABLE_INTERRUPTS ( )
Value:
#define portENABLE_INTERRUPTS()
Definition portmacro.h:119

◆ taskENTER_CRITICAL

#define taskENTER_CRITICAL ( )
Value:
#define portENTER_CRITICAL()
Definition portmacro.h:120

◆ taskENTER_CRITICAL_FROM_ISR

#define taskENTER_CRITICAL_FROM_ISR ( )
Value:
portENTER_CRITICAL_FROM_ISR()

◆ taskEXIT_CRITICAL

#define taskEXIT_CRITICAL ( )
Value:
#define portEXIT_CRITICAL()
Definition portmacro.h:121

◆ taskEXIT_CRITICAL_FROM_ISR

#define taskEXIT_CRITICAL_FROM_ISR ( x)
Value:
portEXIT_CRITICAL_FROM_ISR( x )

◆ taskSCHEDULER_NOT_STARTED

#define taskSCHEDULER_NOT_STARTED   ( ( BaseType_t ) 1 )

◆ taskSCHEDULER_RUNNING

#define taskSCHEDULER_RUNNING   ( ( BaseType_t ) 2 )

◆ taskSCHEDULER_SUSPENDED

#define taskSCHEDULER_SUSPENDED   ( ( BaseType_t ) 0 )

◆ taskVALID_CORE_ID

#define taskVALID_CORE_ID ( xCoreID)
Value:
( ( ( ( ( BaseType_t ) 0 <= ( xCoreID ) ) && ( ( xCoreID ) < ( BaseType_t ) configNUMBER_OF_CORES ) ) ) ? ( pdTRUE ) : ( pdFALSE ) )
#define configNUMBER_OF_CORES
Definition FreeRTOS.h:96
long BaseType_t
Definition portmacro.h:59
#define pdFALSE
Definition projdefs.h:52
#define pdTRUE
Definition projdefs.h:53

◆ taskYIELD

#define taskYIELD ( )
Value:
#define portYIELD()
Definition portmacro.h:85

◆ taskYIELD_WITHIN_API

#define taskYIELD_WITHIN_API ( )
Value:
vTaskYieldWithinAPI()

◆ tskDEFAULT_INDEX_TO_NOTIFY

#define tskDEFAULT_INDEX_TO_NOTIFY   ( 0 )

◆ tskKERNEL_VERSION_BUILD

#define tskKERNEL_VERSION_BUILD   0

◆ tskKERNEL_VERSION_MAJOR

#define tskKERNEL_VERSION_MAJOR   11

◆ tskKERNEL_VERSION_MINOR

#define tskKERNEL_VERSION_MINOR   1

◆ tskKERNEL_VERSION_NUMBER

#define tskKERNEL_VERSION_NUMBER   "V11.1.0"

◆ tskMPU_READ_PERMISSION

#define tskMPU_READ_PERMISSION   ( 1U << 0U )

◆ tskMPU_REGION_DEVICE_MEMORY

#define tskMPU_REGION_DEVICE_MEMORY   ( 1U << 4U )

◆ tskMPU_REGION_EXECUTE_NEVER

#define tskMPU_REGION_EXECUTE_NEVER   ( 1U << 2U )

◆ tskMPU_REGION_NORMAL_MEMORY

#define tskMPU_REGION_NORMAL_MEMORY   ( 1U << 3U )

◆ tskMPU_REGION_READ_ONLY

#define tskMPU_REGION_READ_ONLY   ( 1U << 0U )

◆ tskMPU_REGION_READ_WRITE

#define tskMPU_REGION_READ_WRITE   ( 1U << 1U )

◆ tskMPU_WRITE_PERMISSION

#define tskMPU_WRITE_PERMISSION   ( 1U << 1U )

◆ ulTaskNotifyTake

#define ulTaskNotifyTake ( xClearCountOnExit,
xTicksToWait )
Value:
ulTaskGenericNotifyTake( ( tskDEFAULT_INDEX_TO_NOTIFY ), ( xClearCountOnExit ), ( xTicksToWait ) )
uint32_t ulTaskGenericNotifyTake(UBaseType_t uxIndexToWaitOn, BaseType_t xClearCountOnExit, TickType_t xTicksToWait) PRIVILEGED_FUNCTION
#define tskDEFAULT_INDEX_TO_NOTIFY
Definition task.h:79

◆ ulTaskNotifyTakeIndexed

#define ulTaskNotifyTakeIndexed ( uxIndexToWaitOn,
xClearCountOnExit,
xTicksToWait )
Value:
ulTaskGenericNotifyTake( ( uxIndexToWaitOn ), ( xClearCountOnExit ), ( xTicksToWait ) )

◆ ulTaskNotifyValueClear

#define ulTaskNotifyValueClear ( xTask,
ulBitsToClear )
Value:
ulTaskGenericNotifyValueClear( ( xTask ), ( tskDEFAULT_INDEX_TO_NOTIFY ), ( ulBitsToClear ) )
uint32_t ulTaskGenericNotifyValueClear(TaskHandle_t xTask, UBaseType_t uxIndexToClear, uint32_t ulBitsToClear) PRIVILEGED_FUNCTION

◆ ulTaskNotifyValueClearIndexed

#define ulTaskNotifyValueClearIndexed ( xTask,
uxIndexToClear,
ulBitsToClear )
Value:
ulTaskGenericNotifyValueClear( ( xTask ), ( uxIndexToClear ), ( ulBitsToClear ) )

◆ vTaskDelayUntil

#define vTaskDelayUntil ( pxPreviousWakeTime,
xTimeIncrement )
Value:
do { \
( void ) xTaskDelayUntil( ( pxPreviousWakeTime ), ( xTimeIncrement ) ); \
} while( 0 )
BaseType_t xTaskDelayUntil(TickType_t *const pxPreviousWakeTime, const TickType_t xTimeIncrement) PRIVILEGED_FUNCTION

◆ vTaskGetRunTimeStats

#define vTaskGetRunTimeStats ( pcWriteBuffer)
Value:
vTaskGetRunTimeStatistics( ( pcWriteBuffer ), configSTATS_BUFFER_MAX_LENGTH )
#define configSTATS_BUFFER_MAX_LENGTH
Definition FreeRTOSConfig.h:164

◆ vTaskList

#define vTaskList ( pcWriteBuffer)
Value:
vTaskListTasks( ( pcWriteBuffer ), configSTATS_BUFFER_MAX_LENGTH )

◆ vTaskNotifyGiveFromISR

#define vTaskNotifyGiveFromISR ( xTaskToNotify,
pxHigherPriorityTaskWoken )
Value:
vTaskGenericNotifyGiveFromISR( ( xTaskToNotify ), ( tskDEFAULT_INDEX_TO_NOTIFY ), ( pxHigherPriorityTaskWoken ) )
void vTaskGenericNotifyGiveFromISR(TaskHandle_t xTaskToNotify, UBaseType_t uxIndexToNotify, BaseType_t *pxHigherPriorityTaskWoken) PRIVILEGED_FUNCTION

◆ vTaskNotifyGiveIndexedFromISR

#define vTaskNotifyGiveIndexedFromISR ( xTaskToNotify,
uxIndexToNotify,
pxHigherPriorityTaskWoken )
Value:
vTaskGenericNotifyGiveFromISR( ( xTaskToNotify ), ( uxIndexToNotify ), ( pxHigherPriorityTaskWoken ) )

◆ xTaskNotify

#define xTaskNotify ( xTaskToNotify,
ulValue,
eAction )
Value:
xTaskGenericNotify( ( xTaskToNotify ), ( tskDEFAULT_INDEX_TO_NOTIFY ), ( ulValue ), ( eAction ), NULL )
BaseType_t xTaskGenericNotify(TaskHandle_t xTaskToNotify, UBaseType_t uxIndexToNotify, uint32_t ulValue, eNotifyAction eAction, uint32_t *pulPreviousNotificationValue) PRIVILEGED_FUNCTION

◆ xTaskNotifyAndQuery

#define xTaskNotifyAndQuery ( xTaskToNotify,
ulValue,
eAction,
pulPreviousNotifyValue )
Value:
xTaskGenericNotify( ( xTaskToNotify ), ( tskDEFAULT_INDEX_TO_NOTIFY ), ( ulValue ), ( eAction ), ( pulPreviousNotifyValue ) )

◆ xTaskNotifyAndQueryFromISR

#define xTaskNotifyAndQueryFromISR ( xTaskToNotify,
ulValue,
eAction,
pulPreviousNotificationValue,
pxHigherPriorityTaskWoken )
Value:
xTaskGenericNotifyFromISR( ( xTaskToNotify ), ( tskDEFAULT_INDEX_TO_NOTIFY ), ( ulValue ), ( eAction ), ( pulPreviousNotificationValue ), ( pxHigherPriorityTaskWoken ) )
BaseType_t xTaskGenericNotifyFromISR(TaskHandle_t xTaskToNotify, UBaseType_t uxIndexToNotify, uint32_t ulValue, eNotifyAction eAction, uint32_t *pulPreviousNotificationValue, BaseType_t *pxHigherPriorityTaskWoken) PRIVILEGED_FUNCTION

◆ xTaskNotifyAndQueryIndexed

#define xTaskNotifyAndQueryIndexed ( xTaskToNotify,
uxIndexToNotify,
ulValue,
eAction,
pulPreviousNotifyValue )
Value:
xTaskGenericNotify( ( xTaskToNotify ), ( uxIndexToNotify ), ( ulValue ), ( eAction ), ( pulPreviousNotifyValue ) )

◆ xTaskNotifyAndQueryIndexedFromISR

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

◆ xTaskNotifyFromISR

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

◆ xTaskNotifyGive

#define xTaskNotifyGive ( xTaskToNotify)
Value:
xTaskGenericNotify( ( xTaskToNotify ), ( tskDEFAULT_INDEX_TO_NOTIFY ), ( 0 ), eIncrement, NULL )
@ eIncrement
Definition task.h:117

◆ xTaskNotifyGiveIndexed

#define xTaskNotifyGiveIndexed ( xTaskToNotify,
uxIndexToNotify )
Value:
xTaskGenericNotify( ( xTaskToNotify ), ( uxIndexToNotify ), ( 0 ), eIncrement, NULL )

◆ xTaskNotifyIndexed

#define xTaskNotifyIndexed ( xTaskToNotify,
uxIndexToNotify,
ulValue,
eAction )
Value:
xTaskGenericNotify( ( xTaskToNotify ), ( uxIndexToNotify ), ( ulValue ), ( eAction ), NULL )

◆ xTaskNotifyIndexedFromISR

#define xTaskNotifyIndexedFromISR ( xTaskToNotify,
uxIndexToNotify,
ulValue,
eAction,
pxHigherPriorityTaskWoken )
Value:
xTaskGenericNotifyFromISR( ( xTaskToNotify ), ( uxIndexToNotify ), ( ulValue ), ( eAction ), NULL, ( pxHigherPriorityTaskWoken ) )

◆ xTaskNotifyStateClear

#define xTaskNotifyStateClear ( xTask)
Value:
BaseType_t xTaskGenericNotifyStateClear(TaskHandle_t xTask, UBaseType_t uxIndexToClear) PRIVILEGED_FUNCTION

◆ xTaskNotifyStateClearIndexed

#define xTaskNotifyStateClearIndexed ( xTask,
uxIndexToClear )
Value:
xTaskGenericNotifyStateClear( ( xTask ), ( uxIndexToClear ) )

◆ xTaskNotifyWait

#define xTaskNotifyWait ( ulBitsToClearOnEntry,
ulBitsToClearOnExit,
pulNotificationValue,
xTicksToWait )
Value:
xTaskGenericNotifyWait( tskDEFAULT_INDEX_TO_NOTIFY, ( ulBitsToClearOnEntry ), ( ulBitsToClearOnExit ), ( pulNotificationValue ), ( xTicksToWait ) )
BaseType_t xTaskGenericNotifyWait(UBaseType_t uxIndexToWaitOn, uint32_t ulBitsToClearOnEntry, uint32_t ulBitsToClearOnExit, uint32_t *pulNotificationValue, TickType_t xTicksToWait) PRIVILEGED_FUNCTION

◆ xTaskNotifyWaitIndexed

#define xTaskNotifyWaitIndexed ( uxIndexToWaitOn,
ulBitsToClearOnEntry,
ulBitsToClearOnExit,
pulNotificationValue,
xTicksToWait )
Value:
xTaskGenericNotifyWait( ( uxIndexToWaitOn ), ( ulBitsToClearOnEntry ), ( ulBitsToClearOnExit ), ( pulNotificationValue ), ( xTicksToWait ) )

Typedef Documentation

◆ ConstTaskHandle_t

typedef const struct tskTaskControlBlock* ConstTaskHandle_t

◆ MemoryRegion_t

◆ TaskHandle_t

◆ TaskHookFunction_t

typedef BaseType_t(* TaskHookFunction_t) (void *arg)

◆ TaskParameters_t

◆ TaskStatus_t

typedef struct xTASK_STATUS TaskStatus_t

◆ TimeOut_t

typedef struct xTIME_OUT TimeOut_t

Enumeration Type Documentation

◆ eNotifyAction

Enumerator
eNoAction 
eSetBits 
eIncrement 
eSetValueWithOverwrite 
eSetValueWithoutOverwrite 

◆ eSleepModeStatus

Enumerator
eAbortSleep 
eStandardSleep 

◆ eTaskState

enum eTaskState
Enumerator
eRunning 
eReady 
eBlocked 
eSuspended 
eDeleted 
eInvalid 

Function Documentation

◆ pcTaskGetName()

char * pcTaskGetName ( TaskHandle_t xTaskToQuery)

◆ pvTaskIncrementMutexHeldCount()

TaskHandle_t pvTaskIncrementMutexHeldCount ( void )
Here is the caller graph for this function:

◆ ulTaskGenericNotifyTake()

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

◆ ulTaskGenericNotifyValueClear()

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

◆ uxTaskBasePriorityGet()

UBaseType_t uxTaskBasePriorityGet ( const TaskHandle_t xTask)

◆ uxTaskBasePriorityGetFromISR()

UBaseType_t uxTaskBasePriorityGetFromISR ( const TaskHandle_t xTask)

task. h

unsigned long UBaseType_t
Definition portmacro.h:60
struct tskTaskControlBlock * TaskHandle_t
Definition task.h:92
UBaseType_t uxTaskBasePriorityGetFromISR(const TaskHandle_t xTask) PRIVILEGED_FUNCTION

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

◆ uxTaskGetNumberOfTasks()

UBaseType_t uxTaskGetNumberOfTasks ( void )

◆ uxTaskPriorityGet()

UBaseType_t uxTaskPriorityGet ( const TaskHandle_t xTask)

◆ uxTaskPriorityGetFromISR()

UBaseType_t uxTaskPriorityGetFromISR ( const TaskHandle_t xTask)

task. h

UBaseType_t uxTaskPriorityGetFromISR(const TaskHandle_t xTask) PRIVILEGED_FUNCTION

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

◆ uxTaskResetEventItemValue()

TickType_t uxTaskResetEventItemValue ( void )

◆ vTaskDelay()

void vTaskDelay ( const TickType_t xTicksToDelay)

◆ vTaskDelete()

void vTaskDelete ( TaskHandle_t xTaskToDelete)
Here is the caller graph for this function:

◆ vTaskEndScheduler()

void vTaskEndScheduler ( void )
Here is the call graph for this function:

◆ vTaskGenericNotifyGiveFromISR()

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

◆ vTaskInternalSetTimeOutState()

void vTaskInternalSetTimeOutState ( TimeOut_t *const pxTimeOut)
Here is the caller graph for this function:

◆ vTaskMissedYield()

void vTaskMissedYield ( void )
Here is the caller graph for this function:

◆ vTaskPlaceOnEventList()

void vTaskPlaceOnEventList ( List_t *const pxEventList,
const TickType_t xTicksToWait )
Here is the call graph for this function:
Here is the caller graph for this function:

◆ vTaskPlaceOnEventListRestricted()

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

◆ vTaskPlaceOnUnorderedEventList()

void vTaskPlaceOnUnorderedEventList ( List_t * pxEventList,
const TickType_t xItemValue,
const TickType_t xTicksToWait )
Here is the call graph for this function:

◆ vTaskPriorityDisinheritAfterTimeout()

void vTaskPriorityDisinheritAfterTimeout ( TaskHandle_t const pxMutexHolder,
UBaseType_t uxHighestPriorityWaitingTask )
Here is the caller graph for this function:

◆ vTaskPrioritySet()

void vTaskPrioritySet ( TaskHandle_t xTask,
UBaseType_t uxNewPriority )

◆ vTaskRemoveFromUnorderedEventList()

void vTaskRemoveFromUnorderedEventList ( ListItem_t * pxEventListItem,
const TickType_t xItemValue )
Here is the call graph for this function:

◆ vTaskResetState()

void vTaskResetState ( void )

◆ vTaskResume()

void vTaskResume ( TaskHandle_t xTaskToResume)

◆ vTaskSetTimeOutState()

void vTaskSetTimeOutState ( TimeOut_t *const pxTimeOut)

◆ vTaskStartScheduler()

void vTaskStartScheduler ( void )
Here is the call graph for this function:
Here is the caller graph for this function:

◆ vTaskSuspend()

void vTaskSuspend ( TaskHandle_t xTaskToSuspend)

◆ vTaskSuspendAll()

void vTaskSuspendAll ( void )
Here is the caller graph for this function:

◆ vTaskSwitchContext()

portDONT_DISCARD void vTaskSwitchContext ( BaseType_t xCoreID)
Here is the caller graph for this function:

◆ xTaskCatchUpTicks()

BaseType_t xTaskCatchUpTicks ( TickType_t xTicksToCatchUp)
Here is the call graph for this function:

◆ xTaskCheckForTimeOut()

BaseType_t xTaskCheckForTimeOut ( TimeOut_t *const pxTimeOut,
TickType_t *const pxTicksToWait )
Here is the call graph for this function:
Here is the caller graph for this function:

◆ xTaskDelayUntil()

BaseType_t xTaskDelayUntil ( TickType_t *const pxPreviousWakeTime,
const TickType_t xTimeIncrement )
Here is the caller graph for this function:

◆ xTaskGenericNotify()

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

◆ xTaskGenericNotifyFromISR()

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

◆ xTaskGenericNotifyStateClear()

BaseType_t xTaskGenericNotifyStateClear ( TaskHandle_t xTask,
UBaseType_t uxIndexToClear )

◆ xTaskGenericNotifyWait()

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

◆ xTaskGetCurrentTaskHandle()

TaskHandle_t xTaskGetCurrentTaskHandle ( void )
Here is the caller graph for this function:

◆ xTaskGetCurrentTaskHandleForCore()

TaskHandle_t xTaskGetCurrentTaskHandleForCore ( BaseType_t xCoreID)

◆ xTaskGetSchedulerState()

BaseType_t xTaskGetSchedulerState ( void )
Here is the caller graph for this function:

◆ xTaskGetTickCount()

TickType_t xTaskGetTickCount ( void )
Here is the caller graph for this function:

◆ xTaskGetTickCountFromISR()

TickType_t xTaskGetTickCountFromISR ( void )

◆ xTaskIncrementTick()

BaseType_t xTaskIncrementTick ( void )
Here is the caller graph for this function:

◆ xTaskPriorityDisinherit()

BaseType_t xTaskPriorityDisinherit ( TaskHandle_t const pxMutexHolder)
Here is the caller graph for this function:

◆ xTaskPriorityInherit()

BaseType_t xTaskPriorityInherit ( TaskHandle_t const pxMutexHolder)
Here is the caller graph for this function:

◆ xTaskRemoveFromEventList()

BaseType_t xTaskRemoveFromEventList ( const List_t *const pxEventList)
Here is the call graph for this function:
Here is the caller graph for this function:

◆ xTaskResumeAll()

BaseType_t xTaskResumeAll ( void )
Here is the call graph for this function:
Here is the caller graph for this function:

◆ xTaskResumeFromISR()

BaseType_t xTaskResumeFromISR ( TaskHandle_t xTaskToResume)