CMSIS-RTX  
Keil RTX5 Real-Time Operating System
 
Loading...
Searching...
No Matches
Functions
Thread Flags Functions
RTX v5 Specific API » Event functions

Events generated by thread flags functions. More...

Functions

void EvrRtxThreadFlagsError (osThreadId_t thread_id, int32_t status)
 Event on thread flags error (Error)
 
void EvrRtxThreadFlagsSet (osThreadId_t thread_id, uint32_t flags)
 Event on thread flags set (API)
 
void EvrRtxThreadFlagsSetDone (osThreadId_t thread_id, uint32_t thread_flags)
 Event on successful thread flags set (Op)
 
void EvrRtxThreadFlagsClear (uint32_t flags)
 Event on thread flags clear (API)
 
void EvrRtxThreadFlagsClearDone (uint32_t thread_flags)
 Event on successful thread flags clear (Op)
 
void EvrRtxThreadFlagsGet (uint32_t thread_flags)
 Event on thread flags retrieve (API)
 
void EvrRtxThreadFlagsWait (uint32_t flags, uint32_t options, uint32_t timeout)
 Event on wait for thread flags (API)
 
void EvrRtxThreadFlagsWaitPending (uint32_t flags, uint32_t options, uint32_t timeout)
 Event on pending wait for thread flags (Op)
 
void EvrRtxThreadFlagsWaitTimeout (osThreadId_t thread_id)
 Event on wait timeout for thread flags (Op)
 
void EvrRtxThreadFlagsWaitCompleted (uint32_t flags, uint32_t options, uint32_t thread_flags, osThreadId_t thread_id)
 Event on successful wait for thread flags (Op)
 
void EvrRtxThreadFlagsWaitNotCompleted (uint32_t flags, uint32_t options)
 Event on unsuccessful wait for thread flags (Op)
 

Description

Events generated by thread flags functions.

Function Documentation

◆ EvrRtxThreadFlagsError()

void EvrRtxThreadFlagsError ( osThreadId_t  thread_id,
int32_t  status 
)

Event on thread flags error (Error)

Parameters
[in]thread_idthread ID obtained by osThreadNew or osThreadGetId or NULL when ID is unknown.
[in]statusextended execution status.

The event ThreadFlagsError is generated when Thread Flags routines complete their execution due to an error.

The status parameter indicates the execution status and can be one of the osStatus_t codes or one of the extended execution status codes which are summarized in the table below.

Extended Status Code Description
osRtxErrorKernelNotReady Kernel scheduler is not in Ready state.
osRtxErrorKernelNotRunning Kernel scheduler is not executing - there is no running thread.
osRtxErrorInvalidControlBlock Object control block with invalid alignment or size was specified.
osRtxErrorInvalidDataMemory Object data memory with invalid alignment or size was specified.
osRtxErrorInvalidThreadStack Thread stack memory with invalid alignment or size was specified.
osRtxErrorInvalidPriority Invalid thread priority was specified.
osRtxErrorInvalidPrivilegedMode Privileged thread cannot be created - kernel protect privileged is active.
osRtxErrorThreadNotJoinable Specified thread is not joinable.
osRtxErrorMutexNotOwned Specified mutex is not owned by the current running thread.
osRtxErrorMutexNotLocked Specified mutex is not locked.
osRtxErrorMutexLockLimit Maximum number of recursive mutex locks reached.
osRtxErrorSemaphoreCountLimit Semaphore count limit reached.
osRtxErrorTZ_InitContext_S Secure context memory system initialization failed.
osRtxErrorTZ_AllocContext_S Secure context memory allocation failed.
osRtxErrorTZ_FreeContext_S Secure context memory deallocation failed.
osRtxErrorTZ_LoadContext_S Secure context load failed.
osRtxErrorTZ_SaveContext_S Secure context save failed.

Value in the Event Recorder shows:

  • thread_id : thread ID.
  • status : execution status code.

◆ EvrRtxThreadFlagsSet()

void EvrRtxThreadFlagsSet ( osThreadId_t  thread_id,
uint32_t  flags 
)

Event on thread flags set (API)

Parameters
[in]thread_idthread ID obtained by osThreadNew or osThreadGetId.
[in]flagsflags of the thread that shall be set.

The event ThreadFlagsSet is generated when the function osThreadFlagsSet is called.

Value in the Event Recorder shows:

  • thread_id : thread ID.
  • flags : flags that shall be set.

◆ EvrRtxThreadFlagsSetDone()

void EvrRtxThreadFlagsSetDone ( osThreadId_t  thread_id,
uint32_t  thread_flags 
)

Event on successful thread flags set (Op)

Parameters
[in]thread_idthread ID obtained by osThreadNew or osThreadGetId.
[in]thread_flagsthread flags after setting.

The event ThreadFlagsSetDone is generated when thread flags are successfully set.

Value in the Event Recorder shows:

  • thread_id : thread ID.
  • thread_flags : thread flags after setting.

◆ EvrRtxThreadFlagsClear()

void EvrRtxThreadFlagsClear ( uint32_t  flags)

Event on thread flags clear (API)

Parameters
[in]flagsflags of the thread that shall be cleared.

The event ThreadFlagsClear is generated when the function osThreadFlagsClear is called.

Value in the Event Recorder shows:

  • flags : flags that shall be cleared.

◆ EvrRtxThreadFlagsClearDone()

void EvrRtxThreadFlagsClearDone ( uint32_t  thread_flags)

Event on successful thread flags clear (Op)

Parameters
[in]thread_flagsthread flags before clearing.

The event ThreadFlagsClearDone is generated when the function osThreadFlagsClear successfully clears thread flags.

Value in the Event Recorder shows:

  • thread_flags : thread flags before clearing.

◆ EvrRtxThreadFlagsGet()

void EvrRtxThreadFlagsGet ( uint32_t  thread_flags)

Event on thread flags retrieve (API)

Parameters
[in]thread_flagscurrent thread flags.

The event ThreadFlagsGet is generated when the function osThreadFlagsGet is called and its execution result is known.

Value in the Event Recorder shows:

  • thread_flags : current thread flags.

◆ EvrRtxThreadFlagsWait()

void EvrRtxThreadFlagsWait ( uint32_t  flags,
uint32_t  options,
uint32_t  timeout 
)

Event on wait for thread flags (API)

Parameters
[in]flagsflags to wait for.
[in]optionsflags options (osFlagsXxxx).
[in]timeoutTimeout Value or 0 in case of no time-out.

The event ThreadFlagsWait is generated when the function osThreadFlagsWait is called.

Value in the Event Recorder shows:

◆ EvrRtxThreadFlagsWaitPending()

void EvrRtxThreadFlagsWaitPending ( uint32_t  flags,
uint32_t  options,
uint32_t  timeout 
)

Event on pending wait for thread flags (Op)

Parameters
[in]flagsflags to wait for.
[in]optionsflags options (osFlagsXxxx).
[in]timeoutTimeout Value or 0 in case of no time-out.

The event ThreadFlagsWaitPending is generated when the function osThreadFlagsWait starts waiting for thread flags to become signaled.

Value in the Event Recorder shows:

◆ EvrRtxThreadFlagsWaitTimeout()

void EvrRtxThreadFlagsWaitTimeout ( osThreadId_t  thread_id)

Event on wait timeout for thread flags (Op)

Parameters
[in]thread_idthread ID obtained by osThreadNew or osThreadGetId.

The event ThreadFlagsWaitTimeout is generated when wait for thread flags to become signaled is aborted due to expired wait timeout.

Value in the Event Recorder shows:

  • thread_id : thread ID.

◆ EvrRtxThreadFlagsWaitCompleted()

void EvrRtxThreadFlagsWaitCompleted ( uint32_t  flags,
uint32_t  options,
uint32_t  thread_flags,
osThreadId_t  thread_id 
)

Event on successful wait for thread flags (Op)

Parameters
[in]flagsflags to wait for.
[in]optionsflags options (osFlagsXxxx).
[in]thread_flagsthread flags before clearing.
[in]thread_idthread ID obtained by osThreadNew or osThreadGetId.

The event ThreadFlagsWaitCompleted is generated when waiting for thread flags ends because requested flags were signaled.

Value in the Event Recorder shows:

  • flags : flags thread was waiting for.
  • option : flags options (refer to thread flags options).
  • thread_flags : thread flags before clearing.
  • thread_id : thread ID.

◆ EvrRtxThreadFlagsWaitNotCompleted()

void EvrRtxThreadFlagsWaitNotCompleted ( uint32_t  flags,
uint32_t  options 
)

Event on unsuccessful wait for thread flags (Op)

Parameters
[in]flagsflags to wait for.
[in]optionsflags options (osFlagsXxxx).

The event ThreadFlagsWaitNotCompleted is generated when the function osThreadFlagsWait returns without timeout and specified thread flags were not signaled.

Value in the Event Recorder shows: