CMSIS-FreeRTOS  
CMSIS-RTOS2 compliant FreeRTOS Implementation
Event Groups Functions

Events generated by event groups functions. More...

Functions

void EvrFreeRTOSEventGroups_EventGroupCreate (EventGroup_t pxEventGroup)
 Event on successful event groups object create (Op) More...
 
void EvrFreeRTOSEventGroups_EventGroupCreateFailed (void)
 Event on unsuccessful event groups object create (Error) More...
 
void EvrFreeRTOSEventGroups_EventGroupSyncBlock (EventGroup_t pxEventGroup, uint32_t uxBitsToSet, uint32_t uxBitsToWaitFor)
 Event on event groups sync wait start (Op) More...
 
void EvrFreeRTOSEventGroups_EventGroupSyncEnd (EventGroup_t pxEventGroup, uint32_t uxBitsToSet, uint32_t uxBitsToWaitFor, uint32_t xTimeoutOccurred)
 Event on event groups sync completed (Op) More...
 
void EvrFreeRTOSEventGroups_EventGroupWaitBitsBlock (EventGroup_t pxEventGroup, uint32_t uxBitsToWaitFor)
 Event on event groups bit wait start (Op) More...
 
void EvrFreeRTOSEventGroups_EventGroupWaitBitsEnd (EventGroup_t pxEventGroup, uint32_t uxBitsToWaitFor, uint32_t xTimeoutOccurred)
 Event on event groups bit wait completed (Op) More...
 
void EvrFreeRTOSEventGroups_EventGroupClearBits (EventGroup_t pxEventGroup, uint32_t uxBitsToClear)
 Event on event groups bit clear (Op) More...
 
void EvrFreeRTOSEventGroups_EventGroupClearBitsFromIsr (EventGroup_t pxEventGroup, uint32_t uxBitsToClear)
 Event on event groups bit clear call from ISR (Op) More...
 
void EvrFreeRTOSEventGroups_EventGroupSetBits (EventGroup_t pxEventGroup, uint32_t uxBitsToSet)
 Event on event groups bit set (Op) More...
 
void EvrFreeRTOSEventGroups_EventGroupSetBitsFromIsr (EventGroup_t pxEventGroup, uint32_t uxBitsToSet)
 Event on event groups bit set call from ISR (Op) More...
 
void EvrFreeRTOSEventGroups_EventGroupDelete (EventGroup_t pxEventGroup)
 Event on event groups object delete (Op) More...
 
void EvrFreeRTOSEventGroups_xEventGroupCreateStatic (StaticEventGroup_t *pxEventGroupBuffer)
 Event sent when function xEventGroupCreateStatic is called (API). More...
 
void EvrFreeRTOSEventGroups_xEventGroupCreateStatic_Return (EventGroupHandle_t xEventGroup)
 Event sent before function xEventGroupCreateStatic returns (Op). More...
 
void EvrFreeRTOSEventGroups_xEventGroupCreate (void)
 Event sent when function xEventGroupCreate is called (API). More...
 
void EvrFreeRTOSEventGroups_xEventGroupCreate_Return (EventGroupHandle_t xEventGroup)
 Event sent before function xEventGroupCreate returns (Op). More...
 
void EvrFreeRTOSEventGroups_xEventGroupSync (EventGroupHandle_t xEventGroup, const EventBits_t uxBitsToSet, const EventBits_t uxBitsToWaitFor, TickType_t xTicksToWait)
 Event sent when function xEventGroupSync is called (API). More...
 
void EvrFreeRTOSEventGroups_xEventGroupSync_Return (EventBits_t uxReturn)
 Event sent before function xEventGroupSync returns (Op). More...
 
void EvrFreeRTOSEventGroups_xEventGroupWaitBits (EventGroupHandle_t xEventGroup, const EventBits_t uxBitsToWaitFor, const BaseType_t xClearOnExit, const BaseType_t xWaitForAllBits, TickType_t xTicksToWait)
 Event sent when function xEventGroupWaitBits is called (API). More...
 
void EvrFreeRTOSEventGroups_xEventGroupWaitBits_Return (EventBits_t uxReturn)
 Event sent before function xEventGroupWaitBits returns (Op). More...
 
void EvrFreeRTOSEventGroups_xEventGroupClearBits (EventGroupHandle_t xEventGroup, const EventBits_t uxBitsToClear)
 Event sent when function xEventGroupClearBits is called (API). More...
 
void EvrFreeRTOSEventGroups_xEventGroupClearBits_Return (EventBits_t uxReturn)
 Event sent before function xEventGroupClearBits returns (Op). More...
 
void EvrFreeRTOSEventGroups_xEventGroupClearBitsFromISR (EventGroupHandle_t xEventGroup, const EventBits_t uxBitsToClear)
 Event sent when function xEventGroupClearBitsFromISR is called (API). More...
 
void EvrFreeRTOSEventGroups_xEventGroupClearBitsFromISR_Return (BaseType_t xReturn)
 Event sent before function xEventGroupClearBitsFromISR returns (Op). More...
 
void EvrFreeRTOSEventGroups_xEventGroupGetBitsFromISR (EventGroupHandle_t xEventGroup)
 Event sent when function xEventGroupGetBitsFromISR is called (API). More...
 
void EvrFreeRTOSEventGroups_xEventGroupGetBitsFromISR_Return (EventBits_t uxReturn)
 Event sent before function xEventGroupGetBitsFromISR returns (Op). More...
 
void EvrFreeRTOSEventGroups_xEventGroupSetBits (EventGroupHandle_t xEventGroup, const EventBits_t uxBitsToSet)
 Event sent when function xEventGroupSetBits is called (API). More...
 
void EvrFreeRTOSEventGroups_xEventGroupSetBits_Return (EventBits_t uxReturn)
 Event sent before function xEventGroupSetBits returns (Op). More...
 
void EvrFreeRTOSEventGroups_vEventGroupDelete (EventGroupHandle_t xEventGroup)
 Event sent when function vEventGroupDelete is called (API). More...
 
void EvrFreeRTOSEventGroups_vEventGroupDelete_Return (void)
 Event sent before function vEventGroupDelete returns (Op). More...
 
void EvrFreeRTOSEventGroups_xEventGroupGetStaticBuffer_Return (BaseType_t xReturn)
 Event sent before function xEventGroupGetStaticBuffer returns (Op). More...
 
void EvrFreeRTOSEventGroups_vEventGroupSetBitsCallback (void *pvEventGroup, uint32_t ulBitsToSet)
 Event sent when function vEventGroupSetBitsCallback is called (API). More...
 
void EvrFreeRTOSEventGroups_vEventGroupSetBitsCallback_Return (void)
 Event sent before function vEventGroupSetBitsCallback returns (Op). More...
 
void EvrFreeRTOSEventGroups_vEventGroupClearBitsCallback (void *pvEventGroup, uint32_t ulBitsToClear)
 Event sent when function vEventGroupClearBitsCallback is called (API). More...
 
void EvrFreeRTOSEventGroups_vEventGroupClearBitsCallback_Return (void)
 Event sent before function vEventGroupClearBitsCallback returns (Op). More...
 
void EvrFreeRTOSEventGroups_xEventGroupSetBitsFromISR (EventGroupHandle_t xEventGroup, const EventBits_t uxBitsToSet, BaseType_t *pxHigherPriorityTaskWoken)
 Event sent when function xEventGroupSetBitsFromISR is called (API). More...
 
void EvrFreeRTOSEventGroups_xEventGroupSetBitsFromISR_Return (BaseType_t xReturn)
 Event sent before function xEventGroupSetBitsFromISR returns (Op). More...
 
void EvrFreeRTOSEventGroups_uxEventGroupGetNumber (void *xEventGroup)
 Event sent when function uxEventGroupGetNumber is called (API). More...
 
void EvrFreeRTOSEventGroups_uxEventGroupGetNumber_Return (UBaseType_t xReturn)
 Event sent before function uxEventGroupGetNumber returns (Op). More...
 
void EvrFreeRTOSEventGroups_vEventGroupSetNumber (void *xEventGroup, UBaseType_t uxEventGroupNumber)
 Event sent when function vEventGroupSetNumber is called (API). More...
 
void EvrFreeRTOSEventGroups_vEventGroupSetNumber_Return (void)
 Event sent before function vEventGroupSetNumber returns (Op). More...
 

Description

Events generated by event groups functions.

Function Documentation

◆ EvrFreeRTOSEventGroups_EventGroupClearBits()

void EvrFreeRTOSEventGroups_EventGroupClearBits ( EventGroup_t  pxEventGroup,
uint32_t  uxBitsToClear 
)

Event on event groups bit clear (Op)

Parameters
[in]pxEventGrouppointer to Event Groups object handle.
[in]uxBitsToClearevent bits that shall be cleared.

The event EventGroupClearBits is generated when the function xEventGroupClearBits is called.

Value in the Event Recorder shows:

  • pxEventGroup : pointer to Event Groups object handle (control block address)
  • uxBitsToClear : event bits that shall be cleared.

◆ EvrFreeRTOSEventGroups_EventGroupClearBitsFromIsr()

void EvrFreeRTOSEventGroups_EventGroupClearBitsFromIsr ( EventGroup_t  pxEventGroup,
uint32_t  uxBitsToClear 
)

Event on event groups bit clear call from ISR (Op)

Parameters
[in]pxEventGrouppointer to Event Groups object handle.
[in]uxBitsToClearevent bits that shall be cleared.

The event EventGroupClearBitsFromIsr is generated when the function xEventGroupClearBitsFromISR is called.

Value in the Event Recorder shows:

  • pxEventGroup : pointer to Event Groups object handle (control block address)
  • uxBitsToClear : event bits that shall be cleared.

◆ EvrFreeRTOSEventGroups_EventGroupCreate()

void EvrFreeRTOSEventGroups_EventGroupCreate ( EventGroup_t  pxEventGroup)

Event on successful event groups object create (Op)

Parameters
[in]pxEventGrouppointer to Event Groups object handle.

The event EventGroupCreate is generated when Event Groups object is successfully created.

Value in the Event Recorder shows:

  • pxEventGroup : pointer to Event Groups object handle (control block address)

◆ EvrFreeRTOSEventGroups_EventGroupCreateFailed()

void EvrFreeRTOSEventGroups_EventGroupCreateFailed ( void  )

Event on unsuccessful event groups object create (Error)

The event EventGroupCreateFailed is generated when Event Groups object create fails due to insufficient heap memory.

◆ EvrFreeRTOSEventGroups_EventGroupDelete()

void EvrFreeRTOSEventGroups_EventGroupDelete ( EventGroup_t  pxEventGroup)

Event on event groups object delete (Op)

Parameters
[in]pxEventGrouppointer to Event Groups object handle.

The event EventGroupDelete is generated when Event Group object is successfully added to object delete queue.

Value in the Event Recorder shows:

  • pxEventGroup : pointer to Event Groups object handle (control block address)

◆ EvrFreeRTOSEventGroups_EventGroupSetBits()

void EvrFreeRTOSEventGroups_EventGroupSetBits ( EventGroup_t  pxEventGroup,
uint32_t  uxBitsToSet 
)

Event on event groups bit set (Op)

Parameters
[in]pxEventGrouppointer to Event Groups object handle.
[in]uxBitsToSetevent bits that shall be set.

The event EventGroupSetBits is generated when the function xEventGroupSetBits is called.

Value in the Event Recorder shows:

  • pxEventGroup : pointer to Event Groups object handle (control block address)
  • uxBitsToSet : event bits that shall be set.

◆ EvrFreeRTOSEventGroups_EventGroupSetBitsFromIsr()

void EvrFreeRTOSEventGroups_EventGroupSetBitsFromIsr ( EventGroup_t  pxEventGroup,
uint32_t  uxBitsToSet 
)

Event on event groups bit set call from ISR (Op)

Parameters
[in]pxEventGrouppointer to Event Groups object handle.
[in]uxBitsToSetevent bits that shall be set.

The event EventGroupSetBitsFromIsr is generated when the function xEventGroupSetBitsFromISR is called.

Value in the Event Recorder shows:

  • pxEventGroup : pointer to Event Groups object handle (control block address)
  • uxBitsToSet : event bits that shall be set.

◆ EvrFreeRTOSEventGroups_EventGroupSyncBlock()

void EvrFreeRTOSEventGroups_EventGroupSyncBlock ( EventGroup_t  pxEventGroup,
uint32_t  uxBitsToSet,
uint32_t  uxBitsToWaitFor 
)

Event on event groups sync wait start (Op)

Parameters
[in]pxEventGrouppointer to Event Groups object handle.
[in]uxBitsToSetevent bits that shall be set.
[in]uxBitsToWaitForevent bits to wait for.

The event EventGroupSyncBlock is generated before the function xEventGroupSync enters blocked state.

Value in the Event Recorder shows:

  • pxEventGroup : pointer to Event Groups object handle (control block address)
  • uxBitsToSet : event bits that shall be set.
  • uxBitsToWaitFor : event bits to wait for.

◆ EvrFreeRTOSEventGroups_EventGroupSyncEnd()

void EvrFreeRTOSEventGroups_EventGroupSyncEnd ( EventGroup_t  pxEventGroup,
uint32_t  uxBitsToSet,
uint32_t  uxBitsToWaitFor,
uint32_t  xTimeoutOccurred 
)

Event on event groups sync completed (Op)

Parameters
[in]pxEventGrouppointer to Event Groups object handle.
[in]uxBitsToSetevent bits that shall be set.
[in]uxBitsToWaitForevent bits to wait for.
[in]xTimeoutOccurredtimeout value.

The event EventGroupSyncEnd is generated before the function xEventGroupSync returns.

Value in the Event Recorder shows:

  • pxEventGroup : pointer to Event Groups object handle (control block address)
  • uxBitsToSet : event bits that shall be set.
  • uxBitsToWaitFor : event bits to wait for.
  • xTimeoutOccurred : timeout value (0=timeout occurred, 1=no timeout)

◆ EvrFreeRTOSEventGroups_EventGroupWaitBitsBlock()

void EvrFreeRTOSEventGroups_EventGroupWaitBitsBlock ( EventGroup_t  pxEventGroup,
uint32_t  uxBitsToWaitFor 
)

Event on event groups bit wait start (Op)

Parameters
[in]pxEventGrouppointer to Event Groups object handle.
[in]uxBitsToWaitForevent bits to wait for.

The event EventGroupWaitBitsBlock is generated before the function xEventGroupWaitBits enters blocked state.

Value in the Event Recorder shows:

  • pxEventGroup : pointer to Event Groups object handle (control block address)
  • uxBitsToWaitFor : event bits to wait for.

◆ EvrFreeRTOSEventGroups_EventGroupWaitBitsEnd()

void EvrFreeRTOSEventGroups_EventGroupWaitBitsEnd ( EventGroup_t  pxEventGroup,
uint32_t  uxBitsToWaitFor,
uint32_t  xTimeoutOccurred 
)

Event on event groups bit wait completed (Op)

Parameters
[in]pxEventGrouppointer to Event Groups object handle.
[in]uxBitsToWaitForevent bits to wait for.
[in]xTimeoutOccurredtimeout value.

The event EventGroupWaitBitsEnd is generated before the function xEventGroupWaitBits returns.

Value in the Event Recorder shows:

  • pxEventGroup : pointer to Event Groups object handle (control block address)
  • uxBitsToWaitFor : event bits to wait for.
  • xTimeoutOccurred : timeout value (0=timeout occurred, 1=no timeout)

◆ EvrFreeRTOSEventGroups_uxEventGroupGetNumber()

void EvrFreeRTOSEventGroups_uxEventGroupGetNumber ( void *  xEventGroup)

Event sent when function uxEventGroupGetNumber is called (API).

Parameters
[in]xEventGrouppointer to Event Groups object handle.

The event uxEventGroupGetNumber is generated when function uxEventGroupGetNumber is called.

Value in the Event Recorder shows:

  • xEventGroup : pointer to Event Groups object handle.

◆ EvrFreeRTOSEventGroups_uxEventGroupGetNumber_Return()

void EvrFreeRTOSEventGroups_uxEventGroupGetNumber_Return ( UBaseType_t  xReturn)

Event sent before function uxEventGroupGetNumber returns (Op).

Parameters
[in]xReturnEvent Groups object number.

The event uxEventGroupGetNumber_Return is generated before function uxEventGroupGetNumber returns.

Value in the Event Recorder shows:

  • xReturn : Event Groups object number.

◆ EvrFreeRTOSEventGroups_vEventGroupClearBitsCallback()

void EvrFreeRTOSEventGroups_vEventGroupClearBitsCallback ( void *  pvEventGroup,
uint32_t  ulBitsToClear 
)

Event sent when function vEventGroupClearBitsCallback is called (API).

Parameters
[in]pvEventGrouppointer to Event Groups object handle.
[in]ulBitsToClearbits to clear.

The event vEventGroupClearBitsCallback is generated when function vEventGroupClearBitsCallback is called.

Value in the Event Recorder shows:

  • pvEventGroup : pointer to Event Groups object handle.
  • ulBitsToClear : bits to clear.

◆ EvrFreeRTOSEventGroups_vEventGroupClearBitsCallback_Return()

void EvrFreeRTOSEventGroups_vEventGroupClearBitsCallback_Return ( void  )

Event sent before function vEventGroupClearBitsCallback returns (Op).

The event vEventGroupClearBitsCallback_Return is generated before function vEventGroupClearBitsCallback returns.

Value in the Event Recorder shows:

  • no value shown

◆ EvrFreeRTOSEventGroups_vEventGroupDelete()

void EvrFreeRTOSEventGroups_vEventGroupDelete ( EventGroupHandle_t  xEventGroup)

Event sent when function vEventGroupDelete is called (API).

Parameters
[in]xEventGrouppointer to Event Groups object handle.

The event vEventGroupDelete is generated when function vEventGroupDelete is called.

Value in the Event Recorder shows:

  • xEventGroup : pointer to Event Groups object handle.

◆ EvrFreeRTOSEventGroups_vEventGroupDelete_Return()

void EvrFreeRTOSEventGroups_vEventGroupDelete_Return ( void  )

Event sent before function vEventGroupDelete returns (Op).

The event vEventGroupDelete_Return is generated before function vEventGroupDelete returns.

Value in the Event Recorder shows:

  • no value shown

◆ EvrFreeRTOSEventGroups_vEventGroupSetBitsCallback()

void EvrFreeRTOSEventGroups_vEventGroupSetBitsCallback ( void *  pvEventGroup,
uint32_t  ulBitsToSet 
)

Event sent when function vEventGroupSetBitsCallback is called (API).

Parameters
[in]pvEventGrouppointer to Event Groups object handle.
[in]ulBitsToSetbits to set.

The event vEventGroupSetBitsCallback is generated when function vEventGroupSetBitsCallback is called.

Value in the Event Recorder shows:

  • pvEventGroup : pointer to Event Groups object handle.
  • ulBitsToSet : bits to set.

◆ EvrFreeRTOSEventGroups_vEventGroupSetBitsCallback_Return()

void EvrFreeRTOSEventGroups_vEventGroupSetBitsCallback_Return ( void  )

Event sent before function vEventGroupSetBitsCallback returns (Op).

The event vEventGroupSetBitsCallback_Return is generated before function vEventGroupSetBitsCallback returns.

Value in the Event Recorder shows:

  • no value shown

◆ EvrFreeRTOSEventGroups_vEventGroupSetNumber()

void EvrFreeRTOSEventGroups_vEventGroupSetNumber ( void *  xEventGroup,
UBaseType_t  uxEventGroupNumber 
)

Event sent when function vEventGroupSetNumber is called (API).

Parameters
[in]xEventGrouppointer to Event Groups object handle.
[in]uxEventGroupNumbernumber to assign to the Event Groups object.

The event vEventGroupSetNumber is generated when function vEventGroupSetNumber is called.

Value in the Event Recorder shows:

  • xEventGroup : pointer to Event Groups object handle.
  • uxEventGroupNumber : number to assign to the Event Groups object.

◆ EvrFreeRTOSEventGroups_vEventGroupSetNumber_Return()

void EvrFreeRTOSEventGroups_vEventGroupSetNumber_Return ( void  )

Event sent before function vEventGroupSetNumber returns (Op).

The event vEventGroupSetNumber_Return is generated before function vEventGroupSetNumber returns.

Value in the Event Recorder shows:

  • no value shown

◆ EvrFreeRTOSEventGroups_xEventGroupClearBits()

void EvrFreeRTOSEventGroups_xEventGroupClearBits ( EventGroupHandle_t  xEventGroup,
const EventBits_t  uxBitsToClear 
)

Event sent when function xEventGroupClearBits is called (API).

Parameters
[in]xEventGrouppointer to Event Groups object handle.
[in]uxBitsToClearthe bits to clear.

The event xEventGroupClearBits is generated when function xEventGroupClearBits is called.

Value in the Event Recorder shows:

  • xEventGroup : pointer to Event Groups object handle.
  • uxBitsToClear : the bits to clear.

◆ EvrFreeRTOSEventGroups_xEventGroupClearBits_Return()

void EvrFreeRTOSEventGroups_xEventGroupClearBits_Return ( EventBits_t  uxReturn)

Event sent before function xEventGroupClearBits returns (Op).

Parameters
[in]uxReturnthe bits before clearing.

The event xEventGroupClearBits_Return is generated before function xEventGroupClearBits returns.

Value in the Event Recorder shows:

  • uxReturn : the bits before clearing.

◆ EvrFreeRTOSEventGroups_xEventGroupClearBitsFromISR()

void EvrFreeRTOSEventGroups_xEventGroupClearBitsFromISR ( EventGroupHandle_t  xEventGroup,
const EventBits_t  uxBitsToClear 
)

Event sent when function xEventGroupClearBitsFromISR is called (API).

Parameters
[in]xEventGrouppointer to Event Groups object handle.
[in]uxBitsToClearthe bits to clear.

The event xEventGroupClearBitsFromISR is generated when function xEventGroupClearBitsFromISR is called.

Value in the Event Recorder shows:

  • xEventGroup : pointer to Event Groups object handle.
  • uxBitsToClear : the bits to clear.

◆ EvrFreeRTOSEventGroups_xEventGroupClearBitsFromISR_Return()

void EvrFreeRTOSEventGroups_xEventGroupClearBitsFromISR_Return ( BaseType_t  xReturn)

Event sent before function xEventGroupClearBitsFromISR returns (Op).

Parameters
[in]xReturnexecution status.

The event xEventGroupClearBitsFromISR_Return is generated before function xEventGroupClearBitsFromISR returns.

Value in the Event Recorder shows:

  • xReturn : execution status.

◆ EvrFreeRTOSEventGroups_xEventGroupCreate()

void EvrFreeRTOSEventGroups_xEventGroupCreate ( void  )

Event sent when function xEventGroupCreate is called (API).

The event is generated when function xEventGroupCreate is called.

Value in the Event Recorder shows:

  • no value shown

◆ EvrFreeRTOSEventGroups_xEventGroupCreate_Return()

void EvrFreeRTOSEventGroups_xEventGroupCreate_Return ( EventGroupHandle_t  xEventGroup)

Event sent before function xEventGroupCreate returns (Op).

Parameters
[in]xEventGrouppointer to Event Groups object handle.

The event xEventGroupCreate_Return is generated before function xEventGroupCreate returns.

Value in the Event Recorder shows:

  • xEventGroup : pointer to Event Groups object handle.

◆ EvrFreeRTOSEventGroups_xEventGroupCreateStatic()

void EvrFreeRTOSEventGroups_xEventGroupCreateStatic ( StaticEventGroup_t *  pxEventGroupBuffer)

Event sent when function xEventGroupCreateStatic is called (API).

Parameters
[in]pxEventGroupBufferpointer to Event Groups data structure.

The event xEventGroupCreateStatic is generated when function xEventGroupCreateStatic is called.

Value in the Event Recorder shows:

  • pxEventGroupBuffer : pointer to Event Groups data structure.

◆ EvrFreeRTOSEventGroups_xEventGroupCreateStatic_Return()

void EvrFreeRTOSEventGroups_xEventGroupCreateStatic_Return ( EventGroupHandle_t  xEventGroup)

Event sent before function xEventGroupCreateStatic returns (Op).

Parameters
[in]xEventGrouppointer to Event Groups object handle.

The event xEventGroupCreateStatic_Return is generated before function xEventGroupCreateStatic returns.

Value in the Event Recorder shows:

  • xEventGroup : pointer to Event Groups object handle.

◆ EvrFreeRTOSEventGroups_xEventGroupGetBitsFromISR()

void EvrFreeRTOSEventGroups_xEventGroupGetBitsFromISR ( EventGroupHandle_t  xEventGroup)

Event sent when function xEventGroupGetBitsFromISR is called (API).

Parameters
[in]xEventGrouppointer to Event Groups object handle.

The event xEventGroupGetBitsFromISR is generated when function xEventGroupGetBitsFromISR is called.

Value in the Event Recorder shows:

  • xEventGroup : pointer to Event Groups object handle.

◆ EvrFreeRTOSEventGroups_xEventGroupGetBitsFromISR_Return()

void EvrFreeRTOSEventGroups_xEventGroupGetBitsFromISR_Return ( EventBits_t  uxReturn)

Event sent before function xEventGroupGetBitsFromISR returns (Op).

Parameters
[in]uxReturnthe set bits.

The event xEventGroupGetBitsFromISR_Return is generated before function xEventGroupGetBitsFromISR returns.

Value in the Event Recorder shows:

  • uxReturn : the set bits.

◆ EvrFreeRTOSEventGroups_xEventGroupGetStaticBuffer_Return()

void EvrFreeRTOSEventGroups_xEventGroupGetStaticBuffer_Return ( BaseType_t  xReturn)

Event sent before function xEventGroupGetStaticBuffer returns (Op).

Parameters
[in]xReturnexecution status.

The event xEventGroupGetStaticBuffer_Return is generated before function xEventGroupGetStaticBuffer returns.

Value in the Event Recorder shows:

  • xReturn : execution status.

◆ EvrFreeRTOSEventGroups_xEventGroupSetBits()

void EvrFreeRTOSEventGroups_xEventGroupSetBits ( EventGroupHandle_t  xEventGroup,
const EventBits_t  uxBitsToSet 
)

Event sent when function xEventGroupSetBits is called (API).

Parameters
[in]xEventGrouppointer to Event Groups object handle.
[in]uxBitsToSetthe bits to set.

The event xEventGroupSetBits is generated when function xEventGroupSetBits is called.

Value in the Event Recorder shows:

  • xEventGroup : pointer to Event Groups object handle.
  • uxBitsToSet : the bits to set.

◆ EvrFreeRTOSEventGroups_xEventGroupSetBits_Return()

void EvrFreeRTOSEventGroups_xEventGroupSetBits_Return ( EventBits_t  uxReturn)

Event sent before function xEventGroupSetBits returns (Op).

Parameters
[in]uxReturnthe bits set at the time function returns.

The event xEventGroupSetBits_Return is generated before function xEventGroupSetBits returns.

Value in the Event Recorder shows:

  • uxReturn : the bits set at the time function returns.

◆ EvrFreeRTOSEventGroups_xEventGroupSetBitsFromISR()

void EvrFreeRTOSEventGroups_xEventGroupSetBitsFromISR ( EventGroupHandle_t  xEventGroup,
const EventBits_t  uxBitsToSet,
BaseType_t *  pxHigherPriorityTaskWoken 
)

Event sent when function xEventGroupSetBitsFromISR is called (API).

Parameters
[in]xEventGrouppointer to Event Groups object handle.
[in]uxBitsToSetbits to set
[in]pxHigherPriorityTaskWokenpointer to variable where information if any task was woken will be stored.

The event xEventGroupSetBitsFromISR is generated when function xEventGroupSetBitsFromISR is called.

Value in the Event Recorder shows:

  • xEventGroup : pointer to Event Groups object handle.
  • uxBitsToSet : bits to set
  • pxHigherPriorityTaskWoken : pointer to variable where information if any task was woken will be stored.

◆ EvrFreeRTOSEventGroups_xEventGroupSetBitsFromISR_Return()

void EvrFreeRTOSEventGroups_xEventGroupSetBitsFromISR_Return ( BaseType_t  xReturn)

Event sent before function xEventGroupSetBitsFromISR returns (Op).

Parameters
[in]xReturnexecution status.

The event xEventGroupSetBitsFromISR_Return is generated before function xEventGroupSetBitsFromISR returns.

Value in the Event Recorder shows:

  • xReturn : execution status.

◆ EvrFreeRTOSEventGroups_xEventGroupSync()

void EvrFreeRTOSEventGroups_xEventGroupSync ( EventGroupHandle_t  xEventGroup,
const EventBits_t  uxBitsToSet,
const EventBits_t  uxBitsToWaitFor,
TickType_t  xTicksToWait 
)

Event sent when function xEventGroupSync is called (API).

Parameters
[in]xEventGrouppointer to Event Groups object handle.
[in]uxBitsToSetbits to set in the Event Group before waiting.
[in]uxBitsToWaitForbits to wait for.
[in]xTicksToWaitamount of time to wait for.

The event xEventGroupSync is generated when function xEventGroupSync is called.

Value in the Event Recorder shows:

  • xEventGroup : pointer to Event Groups object handle.
  • uxBitsToSet : bits to set in the Event Group before waiting.
  • uxBitsToWaitFor : bits to wait for.
  • xTicksToWait : amount of time to wait for.

◆ EvrFreeRTOSEventGroups_xEventGroupSync_Return()

void EvrFreeRTOSEventGroups_xEventGroupSync_Return ( EventBits_t  uxReturn)

Event sent before function xEventGroupSync returns (Op).

Parameters
[in]uxReturnthe bits after wait or when block time expired.

The event xEventGroupSync_Return is generated before function xEventGroupSync returns.

Value in the Event Recorder shows:

  • uxReturn : the bits after wait or when block time expired.

◆ EvrFreeRTOSEventGroups_xEventGroupWaitBits()

void EvrFreeRTOSEventGroups_xEventGroupWaitBits ( EventGroupHandle_t  xEventGroup,
const EventBits_t  uxBitsToWaitFor,
const BaseType_t  xClearOnExit,
const BaseType_t  xWaitForAllBits,
TickType_t  xTicksToWait 
)

Event sent when function xEventGroupWaitBits is called (API).

Parameters
[in]xEventGrouppointer to Event Groups object handle.
[in]uxBitsToWaitForthe bits to wait for.
[in]xClearOnExitspecifies if the bits are cleared on exit.
[in]xWaitForAllBitsspecified if function waits until all bits are set.
[in]xTicksToWaitamount of time to wait for.

The event xEventGroupWaitBits is generated when function xEventGroupWaitBits is called.

Value in the Event Recorder shows:

  • xEventGroup : pointer to Event Groups object handle.
  • uxBitsToWaitFor : the bits to wait for.
  • xClearOnExit : specifies if the bits are cleared on exit.
  • xWaitForAllBits : specified if function waits until all bits are set.
  • xTicksToWait : amount of time to wait for.

◆ EvrFreeRTOSEventGroups_xEventGroupWaitBits_Return()

void EvrFreeRTOSEventGroups_xEventGroupWaitBits_Return ( EventBits_t  uxReturn)

Event sent before function xEventGroupWaitBits returns (Op).

Parameters
[in]uxReturnthe bits after wait or when block time expired.

The event xEventGroupWaitBits is generated before function xEventGroupWaitBits returns.

Value in the Event Recorder shows:

  • uxReturn : the bits after wait or when block time expired.