Events generated by thread functions. More...

Functions
void	EvrRtxThreadError (osThreadId_t thread_id, int32_t status)
	Event on thread error (Error)

void	EvrRtxThreadNew (osThreadFunc_t func, void argument, const osThreadAttr_t attr)
	Event on thread create and intialize (API)

void	EvrRtxThreadCreated (osThreadId_t thread_id, uint32_t thread_addr, const char *name)
	Event on successful thread create (Op)

void	EvrRtxThreadGetName (osThreadId_t thread_id, const char *name)
	Event on thread name retrieve (API)

void	EvrRtxThreadGetClass (osThreadId_t thread_id, uint32_t safety_class)
	Event on thread safety class retrieve (API)

void	EvrRtxThreadGetZone (osThreadId_t thread_id, uint32_t zone)
	Event on thread zone retrieve (API)

void	EvrRtxThreadGetId (osThreadId_t thread_id)
	Event on current running thread ID retrieve (API)

void	EvrRtxThreadGetState (osThreadId_t thread_id, osThreadState_t state)
	Event on thread state retrieve (API)

void	EvrRtxThreadGetStackSize (osThreadId_t thread_id, uint32_t stack_size)
	Event on thread stack size retrieve (API)

void	EvrRtxThreadGetStackSpace (osThreadId_t thread_id, uint32_t stack_space)
	Event on available stack space retrieve (API)

void	EvrRtxThreadSetPriority (osThreadId_t thread_id, osPriority_t priority)
	Event on thread priority set (API)

void	EvrRtxThreadPriorityUpdated (osThreadId_t thread_id, osPriority_t priority)
	Event on thread priority updated (Op)

void	EvrRtxThreadGetPriority (osThreadId_t thread_id, osPriority_t priority)
	Event on thread priority retrieve (API)

void	EvrRtxThreadYield (void)
	Event on thread yield (API)

void	EvrRtxThreadSuspend (osThreadId_t thread_id)
	Event on thread suspend (API)

void	EvrRtxThreadSuspended (osThreadId_t thread_id)
	Event on successful thread suspend (Op)

void	EvrRtxThreadResume (osThreadId_t thread_id)
	Event on thread resume (API)

void	EvrRtxThreadResumed (osThreadId_t thread_id)
	Event on successful thread resume (Op)

void	EvrRtxThreadDetach (osThreadId_t thread_id)
	Event on thread detach (API)

void	EvrRtxThreadDetached (osThreadId_t thread_id)
	Event on successful thread detach (Op)

void	EvrRtxThreadJoin (osThreadId_t thread_id)
	Event on thread join (API)

void	EvrRtxThreadJoinPending (osThreadId_t thread_id)
	Event on pending thread join (Op)

void	EvrRtxThreadJoined (osThreadId_t thread_id)
	Event on successful thread join (Op)

void	EvrRtxThreadBlocked (osThreadId_t thread_id, uint32_t timeout)
	Event on thread execution block (Detail)

void	EvrRtxThreadUnblocked (osThreadId_t thread_id, uint32_t ret_val)
	Event on thread execution unblock (Detail)

void	EvrRtxThreadPreempted (osThreadId_t thread_id)
	Event on running thread pre-emption (Detail)

void	EvrRtxThreadSwitched (osThreadId_t thread_id)
	Event on running thread switch (Op)

void	EvrRtxThreadExit (void)
	Event on thread exit (API)

void	EvrRtxThreadTerminate (osThreadId_t thread_id)
	Event on thread terminate (API)

void	EvrRtxThreadDestroyed (osThreadId_t thread_id)
	Event on successful thread terminate (Op)

void	EvrRtxThreadFeedWatchdog (uint32_t ticks)
	Event on thread feed watchdog (API)

void	EvrRtxThreadFeedWatchdogDone (void)
	Event on thread feed watchdog done (Op)

void	EvrRtxThreadProtectPrivileged (void)
	Event on protect the creation of privileged threads (API)

void	EvrRtxThreadPrivilegedProtected (void)
	Event on successful protect the creation of privileged threads (Op)

void	EvrRtxThreadGetCount (uint32_t count)
	Event on active thread count retrieve (API)

void	EvrRtxThreadEnumerate (osThreadId_t *thread_array, uint32_t array_items, uint32_t count)
	Event on active threads enumerate (API)

void	EvrRtxThreadSuspendClass (uint32_t safety_class, uint32_t mode)
	Event on thread safety class suspend (API)

void	EvrRtxThreadResumeClass (uint32_t safety_class, uint32_t mode)
	Event on thread safety class resume (API)

void	EvrRtxThreadTerminateZone (uint32_t zone)
	Event on thread zone terminate (API)

void	EvrRtxThreadWatchdogExpired (osThreadId_t thread_id)
	Event on thread watchdog expired (Error)

Description

Events generated by thread functions.

Function Documentation

◆ EvrRtxThreadError()

void EvrRtxThreadError	(	osThreadId_t	thread_id,
		int32_t	status
	)

Event on thread error (Error)

Parameters

[in]	thread_id	thread ID obtained by osThreadNew or osThreadGetId or NULL when ID is unknown.
[in]	status	extended execution status.

The event ThreadError is generated when Thread Management 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.

◆ EvrRtxThreadNew()

void EvrRtxThreadNew	(	osThreadFunc_t	func,
		void *	argument,
		const osThreadAttr_t *	attr
	)

Event on thread create and intialize (API)

Parameters

[in]	func	thread function.
[in]	argument	pointer that is passed to the thread function as start argument.
[in]	attr	thread attributes.

The event ThreadNew is generated when the function osThreadNew is called.

Value in the Event Recorder shows:

func : memory address of thread function.
argument : memory address of thread function start argument.
attr : memory address of Thread attributes or 0 when they are not specified.

◆ EvrRtxThreadCreated()

void EvrRtxThreadCreated	(	osThreadId_t	thread_id,
		uint32_t	thread_addr,
		const char *	name
	)

Event on successful thread create (Op)

Parameters

[in]	thread_id	thread ID obtained by osThreadNew or osThreadGetId.
[in]	thread_addr	thread entry address.
[in]	name	pointer to thread object name.

The event ThreadCreated is generated when the function osThreadNew successfully creates a thread object.

Value in the Event Recorder shows:

thread_id : thread ID.

◆ EvrRtxThreadGetName()

void EvrRtxThreadGetName	(	osThreadId_t	thread_id,
		const char *	name
	)

Event on thread name retrieve (API)

Parameters

[in]	thread_id	thread ID obtained by osThreadNew or osThreadGetId.
[in]	name	pointer to thread object name.

The event ThreadGetName is generated when the function osThreadGetName is called and its execution result is known.

Value in the Event Recorder shows:

thread_id : thread ID.
name : retrieved memory address of name string (0 in case of a failure).

◆ EvrRtxThreadGetClass()

void EvrRtxThreadGetClass	(	osThreadId_t	thread_id,
		uint32_t	safety_class
	)

Event on thread safety class retrieve (API)

Parameters

[in]	thread_id	thread ID obtained by osThreadNew or osThreadGetId.
[in]	safety_class	thread safety class.

The event ThreadGetClass is generated when the function osThreadGetClass is called and its execution result is known.

Value in the Event Recorder shows:

thread_id : thread ID.
safety_class : retrieved safety class value (osErrorId in case of a failure).

◆ EvrRtxThreadGetZone()

void EvrRtxThreadGetZone	(	osThreadId_t	thread_id,
		uint32_t	zone
	)

Event on thread zone retrieve (API)

Parameters

[in]	thread_id	thread ID obtained by osThreadNew or osThreadGetId.
[in]	zone	thread zone.

The event ThreadGetZone is generated when the function osThreadGetZone is called and its execution result is known.

Value in the Event Recorder shows:

thread_id : thread ID.
zone : retrieved MPU Protected Zone value (osErrorId in case of a failure).

◆ EvrRtxThreadGetId()

void EvrRtxThreadGetId ( osThreadId_t thread_id )

Event on current running thread ID retrieve (API)

Parameters

[in] thread_id thread ID obtained by osThreadNew or osThreadGetId.

The event ThreadGetId is generated when the function osThreadGetId is called and its execution result is known.

Value in the Event Recorder shows:

thread_id : retrieved thread (0 in case of a failure).

◆ EvrRtxThreadGetState()

void EvrRtxThreadGetState	(	osThreadId_t	thread_id,
		osThreadState_t	state
	)

Event on thread state retrieve (API)

Parameters

[in]	thread_id	thread ID obtained by osThreadNew or osThreadGetId.
[in]	state	current thread state of the specified thread.

The event ThreadGetState is generated when the function osThreadGetState is called and its execution result is known.

Value in the Event Recorder shows:

thread_id : thread ID.
state : retrieved current thread state.

◆ EvrRtxThreadGetStackSize()

void EvrRtxThreadGetStackSize	(	osThreadId_t	thread_id,
		uint32_t	stack_size
	)

Event on thread stack size retrieve (API)

Parameters

[in]	thread_id	thread ID obtained by osThreadNew or osThreadGetId.
[in]	stack_size	stack size in bytes.

The event ThreadGetStackSize is generated when the function osThreadGetStackSize is called and its execution result is known.

Value in the Event Recorder shows:

thread_id : thread ID.
stack_size : retrieved remaining stack space in bytes (0 in case of a failure).

◆ EvrRtxThreadGetStackSpace()

void EvrRtxThreadGetStackSpace	(	osThreadId_t	thread_id,
		uint32_t	stack_space
	)

Event on available stack space retrieve (API)

Parameters

[in]	thread_id	thread ID obtained by osThreadNew or osThreadGetId.
[in]	stack_space	remaining stack space in bytes.

The event ThreadGetStackSpace is generated when the function osThreadGetStackSpace is called and its execution result is known.

Value in the Event Recorder shows:

thread_id : thread ID.
stack_space : retrieved remaining stack space in bytes (0 in case of a failure).

◆ EvrRtxThreadSetPriority()

void EvrRtxThreadSetPriority	(	osThreadId_t	thread_id,
		osPriority_t	priority
	)

Event on thread priority set (API)

Parameters

[in]	thread_id	thread ID obtained by osThreadNew or osThreadGetId.
[in]	priority	new priority value for the thread function.

The event ThreadSetPriority is generated when the function osThreadSetPriority is called.

Value in the Event Recorder shows:

thread_id : thread ID.
priority : new priority value for the thread function.

◆ EvrRtxThreadPriorityUpdated()

void EvrRtxThreadPriorityUpdated	(	osThreadId_t	thread_id,
		osPriority_t	priority
	)

Event on thread priority updated (Op)

Parameters

[in]	thread_id	thread ID obtained by osThreadNew or osThreadGetId.
[in]	priority	new priority value for the thread function.

The event ThreadPriorityUpdated is generated when the function osThreadSetPriority successfully updated the specified thread priority.

Value in the Event Recorder shows:

thread_id : thread ID.
priority : new priority value for the thread function.

◆ EvrRtxThreadGetPriority()

void EvrRtxThreadGetPriority	(	osThreadId_t	thread_id,
		osPriority_t	priority
	)

Event on thread priority retrieve (API)

Parameters

[in]	thread_id	thread ID obtained by osThreadNew or osThreadGetId.
[in]	priority	current priority value of the specified thread.

The event ThreadGetPriority is generated when the function osThreadGetPriority is called and its execution result is known.

Value in the Event Recorder shows:

thread_id : thread ID.
priority : current priority value of the specified thread.

◆ EvrRtxThreadYield()

void EvrRtxThreadYield ( void )

Event on thread yield (API)

The event ThreadYield is generated when the function osThreadYield is called.

◆ EvrRtxThreadSuspend()

void EvrRtxThreadSuspend ( osThreadId_t thread_id )

Event on thread suspend (API)

Parameters

[in] thread_id thread ID obtained by osThreadNew or osThreadGetId.

The event ThreadSuspend is generated when the function osThreadSuspend is called.

Value in the Event Recorder shows:

thread_id : thread ID.

◆ EvrRtxThreadSuspended()

void EvrRtxThreadSuspended ( osThreadId_t thread_id )

Event on successful thread suspend (Op)

Parameters

[in] thread_id thread ID obtained by osThreadNew or osThreadGetId.

The event ThreadSuspended is generated when the function osThreadSuspend successfully suspends the specified thread.

Value in the Event Recorder shows:

thread_id : thread ID.

◆ EvrRtxThreadResume()

void EvrRtxThreadResume ( osThreadId_t thread_id )

Event on thread resume (API)

Parameters

[in] thread_id thread ID obtained by osThreadNew or osThreadGetId.

The event ThreadResume is generated when the function osThreadResume is called.

Value in the Event Recorder shows:

thread_id : thread ID.

◆ EvrRtxThreadResumed()

void EvrRtxThreadResumed ( osThreadId_t thread_id )

Event on successful thread resume (Op)

Parameters

[in] thread_id thread ID obtained by osThreadNew or osThreadGetId.

The event ThreadResumed is generated when the function osThreadResume successfully resumes the specified thread.

Value in the Event Recorder shows:

thread_id : thread ID.

◆ EvrRtxThreadDetach()

void EvrRtxThreadDetach ( osThreadId_t thread_id )

Event on thread detach (API)

Parameters

[in] thread_id thread ID obtained by osThreadNew or osThreadGetId.

The event ThreadDetach is generated when the function osThreadDetach is called.

Value in the Event Recorder shows:

thread_id : thread ID.

◆ EvrRtxThreadDetached()

void EvrRtxThreadDetached ( osThreadId_t thread_id )

Event on successful thread detach (Op)

Parameters

[in] thread_id thread ID obtained by osThreadNew or osThreadGetId.

The event ThreadDetached is generated when the function osThreadDetach successfully detaches the specified thread.

Value in the Event Recorder shows:

thread_id : thread ID.

◆ EvrRtxThreadJoin()

void EvrRtxThreadJoin ( osThreadId_t thread_id )

Event on thread join (API)

Parameters

[in] thread_id thread ID obtained by osThreadNew or osThreadGetId.

The event ThreadJoin is generated when the function osThreadJoin is called.

Value in the Event Recorder shows:

thread_id : thread ID.

◆ EvrRtxThreadJoinPending()

void EvrRtxThreadJoinPending ( osThreadId_t thread_id )

Event on pending thread join (Op)

Parameters

[in] thread_id thread ID obtained by osThreadNew or osThreadGetId.

The event ThreadJoinPending is generated when the function osThreadJoin suspends current running thread until the specified thread terminates.

Value in the Event Recorder shows:

thread_id : thread ID.

◆ EvrRtxThreadJoined()

void EvrRtxThreadJoined ( osThreadId_t thread_id )

Event on successful thread join (Op)

Parameters

[in] thread_id thread ID obtained by osThreadNew or osThreadGetId.

The event ThreadJoined is generated when the function osThreadJoin successfully joins the specified thread.

Value in the Event Recorder shows:

thread_id : thread ID.

◆ EvrRtxThreadBlocked()

void EvrRtxThreadBlocked	(	osThreadId_t	thread_id,
		uint32_t	timeout
	)

Event on thread execution block (Detail)

Parameters

[in]	thread_id	thread ID obtained by osThreadNew or osThreadGetId.
[in]	timeout	Timeout Value or 0 in case of no time-out.

The event ThreadBlocked is generated when the current running thread execution is blocked.

Value in the Event Recorder shows:

thread_id : thread ID.
timeout : Timeout Value.

◆ EvrRtxThreadUnblocked()

void EvrRtxThreadUnblocked	(	osThreadId_t	thread_id,
		uint32_t	ret_val
	)

Event on thread execution unblock (Detail)

Parameters

[in]	thread_id	thread ID obtained by osThreadNew or osThreadGetId.
[in]	ret_val	extended execution status of the thread.

The event ThreadUnblocked is generated when the blocked thread execution is unblocked.

Value in the Event Recorder shows:

thread_id : thread ID.
ret_val :

◆ EvrRtxThreadPreempted()

void EvrRtxThreadPreempted ( osThreadId_t thread_id )

Event on running thread pre-emption (Detail)

Parameters

[in] thread_id thread ID obtained by osThreadNew or osThreadGetId.

The event ThreadPreempted is generated when current running thread execution is preempted.

Value in the Event Recorder shows:

thread_id : thread ID.

◆ EvrRtxThreadSwitched()

void EvrRtxThreadSwitched ( osThreadId_t thread_id )

Event on running thread switch (Op)

Parameters

[in] thread_id thread ID obtained by osThreadNew or osThreadGetId.

The event ThreadSwitched is generated when current running thread execution switches.

Value in the Event Recorder shows:

thread_id : thread ID.

◆ EvrRtxThreadExit()

void EvrRtxThreadExit ( void )

Event on thread exit (API)

The event ThreadExit is generated when the function osThreadExit is called.

◆ EvrRtxThreadTerminate()

void EvrRtxThreadTerminate ( osThreadId_t thread_id )

Event on thread terminate (API)

Parameters

[in] thread_id thread ID obtained by osThreadNew or osThreadGetId.

The event ThreadTerminate is generated when the function osThreadTerminate is called.

Value in the Event Recorder shows:

thread_id : thread ID.

◆ EvrRtxThreadDestroyed()

void EvrRtxThreadDestroyed ( osThreadId_t thread_id )

Event on successful thread terminate (Op)

Parameters

[in] thread_id thread ID obtained by osThreadNew or osThreadGetId.

The event ThreadDestroyed is generated when the function osThreadExit or osThreadTerminate successfully terminates the thread.

Value in the Event Recorder shows:

thread_id : thread ID.

◆ EvrRtxThreadFeedWatchdog()

void EvrRtxThreadFeedWatchdog ( uint32_t ticks )

Event on thread feed watchdog (API)

Parameters

[in] ticks timeout in number of ticks.

The event ThreadFeedWatchdog is generated when the function osThreadFeedWatchdog is called.

Value in the Event Recorder shows:

ticks : watchdog timeout in number of kernel ticks.

◆ EvrRtxThreadFeedWatchdogDone()

void EvrRtxThreadFeedWatchdogDone ( void )

Event on thread feed watchdog done (Op)

The event ThreadFeedWatchdogDone is generated when the function osThreadFeedWatchdog successfully feeds the watchdog timer.

◆ EvrRtxThreadProtectPrivileged()

void EvrRtxThreadProtectPrivileged ( void )

Event on protect the creation of privileged threads (API)

The event ThreadProtectPrivileged is generated when the function osThreadProtectPrivileged is called.

◆ EvrRtxThreadPrivilegedProtected()

void EvrRtxThreadPrivilegedProtected ( void )

Event on successful protect the creation of privileged threads (Op)

The event ThreadPrivilegedProtected is generated when the function osThreadProtectPrivileged successfully applies the new privileged thread creation protection.

◆ EvrRtxThreadGetCount()

void EvrRtxThreadGetCount ( uint32_t count )

Event on active thread count retrieve (API)

Parameters

[in] count number of active threads.

The event ThreadGetCount is generated when the function osThreadGetCount is called and its execution result is known.

Value in the Event Recorder shows:

count : retrieved number of active threads (0 in case of a failure).

◆ EvrRtxThreadEnumerate()

void EvrRtxThreadEnumerate	(	osThreadId_t *	thread_array,
		uint32_t	array_items,
		uint32_t	count
	)

Event on active threads enumerate (API)

Parameters

[in]	thread_array	pointer to array for retrieving thread IDs.
[in]	array_items	maximum number of items in array for retrieving thread IDs.
[in]	count	number of enumerated threads.

The event ThreadEnumerate is generated when the function osThreadEnumerate is called and its execution result is known.

Value in the Event Recorder shows:

thread_array : memory address of array for retrieving thread IDs.
array_items : maximum number of items in thread_array.
count : number of enumerated threads (0 in case of a failure).

◆ EvrRtxThreadSuspendClass()

void EvrRtxThreadSuspendClass	(	uint32_t	safety_class,
		uint32_t	mode
	)

Event on thread safety class suspend (API)

Parameters

[in]	safety_class	safety class.
[in]	mode	safety mode.

The event ThreadSuspendClass is generated when the function osThreadSuspendClass is called.

Value in the Event Recorder shows:

safety_class : safety class value.
mode : operation mode.

◆ EvrRtxThreadResumeClass()

void EvrRtxThreadResumeClass	(	uint32_t	safety_class,
		uint32_t	mode
	)

Event on thread safety class resume (API)

Parameters

[in]	safety_class	safety class.
[in]	mode	safety mode.

The event ThreadResumeClass is generated when the function osThreadResumeClass is called.

Value in the Event Recorder shows:

safety_class : safety class value.
mode : operation mode.

◆ EvrRtxThreadTerminateZone()

void EvrRtxThreadTerminateZone ( uint32_t zone )

Event on thread zone terminate (API)

Parameters

[in] zone thread zone.

The event ThreadTerminateZone is generated when the function osThreadTerminateZone is called.

Value in the Event Recorder shows:

zone : MPU Protected Zone value.

◆ EvrRtxThreadWatchdogExpired()

void EvrRtxThreadWatchdogExpired ( osThreadId_t thread_id )

Event on thread watchdog expired (Error)

Parameters

[in] thread_id thread ID obtained by osThreadNew.

The event ThreadWatchdogExpired is generated when the thread watchdog timer expires.

Value in the Event Recorder shows:

thread_id : thread ID.

Functions

Description

Function Documentation

◆ EvrRtxThreadError()

◆ EvrRtxThreadNew()

◆ EvrRtxThreadCreated()

◆ EvrRtxThreadGetName()

◆ EvrRtxThreadGetClass()

◆ EvrRtxThreadGetZone()

◆ EvrRtxThreadGetId()

◆ EvrRtxThreadGetState()

◆ EvrRtxThreadGetStackSize()

◆ EvrRtxThreadGetStackSpace()

◆ EvrRtxThreadSetPriority()

◆ EvrRtxThreadPriorityUpdated()

◆ EvrRtxThreadGetPriority()

◆ EvrRtxThreadYield()

◆ EvrRtxThreadSuspend()

◆ EvrRtxThreadSuspended()

◆ EvrRtxThreadResume()

◆ EvrRtxThreadResumed()

◆ EvrRtxThreadDetach()

◆ EvrRtxThreadDetached()

◆ EvrRtxThreadJoin()

◆ EvrRtxThreadJoinPending()

◆ EvrRtxThreadJoined()

◆ EvrRtxThreadBlocked()

◆ EvrRtxThreadUnblocked()

◆ EvrRtxThreadPreempted()

◆ EvrRtxThreadSwitched()

◆ EvrRtxThreadExit()

◆ EvrRtxThreadTerminate()

◆ EvrRtxThreadDestroyed()

◆ EvrRtxThreadFeedWatchdog()

◆ EvrRtxThreadFeedWatchdogDone()

◆ EvrRtxThreadProtectPrivileged()

◆ EvrRtxThreadPrivilegedProtected()

◆ EvrRtxThreadGetCount()

◆ EvrRtxThreadEnumerate()

◆ EvrRtxThreadSuspendClass()

◆ EvrRtxThreadResumeClass()

◆ EvrRtxThreadTerminateZone()

◆ EvrRtxThreadWatchdogExpired()