Events generated by semaphore functions. More...

Functions
void	EvrRtxSemaphoreError (osSemaphoreId_t semaphore_id, int32_t status)
	Event on semaphore error (Error)

void	EvrRtxSemaphoreNew (uint32_t max_count, uint32_t initial_count, const osSemaphoreAttr_t *attr)
	Event on semaphore create and initialize (API)

void	EvrRtxSemaphoreCreated (osSemaphoreId_t semaphore_id, const char *name)
	Event on successful semaphore create (Op)

void	EvrRtxSemaphoreGetName (osSemaphoreId_t semaphore_id, const char *name)
	Event on semaphore name retrieve (API)

void	EvrRtxSemaphoreAcquire (osSemaphoreId_t semaphore_id, uint32_t timeout)
	Event on semaphore acquire (API)

void	EvrRtxSemaphoreAcquirePending (osSemaphoreId_t semaphore_id, uint32_t timeout)
	Event on pending semaphore acquire (Op)

void	EvrRtxSemaphoreAcquireTimeout (osSemaphoreId_t semaphore_id)
	Event on semaphore acquire timeout (Op)

void	EvrRtxSemaphoreAcquired (osSemaphoreId_t semaphore_id, uint32_t tokens)
	Event on successful semaphore acquire (Op)

void	EvrRtxSemaphoreNotAcquired (osSemaphoreId_t semaphore_id)
	Event on unsuccessful semaphore acquire (Op)

void	EvrRtxSemaphoreRelease (osSemaphoreId_t semaphore_id)
	Event on semaphore release (API)

void	EvrRtxSemaphoreReleased (osSemaphoreId_t semaphore_id, uint32_t tokens)
	Event on successful semaphore release (Op)

void	EvrRtxSemaphoreGetCount (osSemaphoreId_t semaphore_id, uint32_t count)
	Event on semaphore token count retrieval (API)

void	EvrRtxSemaphoreDelete (osSemaphoreId_t semaphore_id)
	Event on semaphore delete (API)

void	EvrRtxSemaphoreDestroyed (osSemaphoreId_t semaphore_id)
	Event on successful semaphore delete (Op)

Description

Events generated by semaphore functions.

Function Documentation

◆ EvrRtxSemaphoreError()

void EvrRtxSemaphoreError	(	osSemaphoreId_t	semaphore_id,
		int32_t	status
	)

Event on semaphore error (Error)

Parameters

[in]	semaphore_id	semaphore ID obtained by osSemaphoreNew or NULL when ID is unknown.
[in]	status	extended execution status.

The event SemaphoreError is generated when Semaphores 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:

semaphore_id : semaphore ID.
status : execution status code.

◆ EvrRtxSemaphoreNew()

void EvrRtxSemaphoreNew	(	uint32_t	max_count,
		uint32_t	initial_count,
		const osSemaphoreAttr_t *	attr
	)

Event on semaphore create and initialize (API)

Parameters

[in]	max_count	maximum number of available tokens.
[in]	initial_count	initial number of available tokens.
[in]	attr	semaphore attributes.

The event SemaphoreNew is generated when the function osSemaphoreNew is called.

Value in the Event Recorder shows:

max_count : maximum number of available tokens.
initial_count : initial number of available tokens.
attr : memory address of Semaphore attributes or 0 when they are not specified.

◆ EvrRtxSemaphoreCreated()

void EvrRtxSemaphoreCreated	(	osSemaphoreId_t	semaphore_id,
		const char *	name
	)

Event on successful semaphore create (Op)

Parameters

[in]	semaphore_id	semaphore ID obtained by osSemaphoreNew.
[in]	name	pointer to semaphore object name.

The event SemaphoreCreated is generated when the function osSemaphoreNew successfully creates a semaphore object.

Value in the Event Recorder shows:

semaphore_id : semaphore ID.

◆ EvrRtxSemaphoreGetName()

void EvrRtxSemaphoreGetName	(	osSemaphoreId_t	semaphore_id,
		const char *	name
	)

Event on semaphore name retrieve (API)

Parameters

[in]	semaphore_id	semaphore ID obtained by osSemaphoreNew.
[in]	name	pointer to semaphore object name.

The event SemaphoreGetName is generated when the function osSemaphoreGetName is called and its execution result is known.

Value in the Event Recorder shows:

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

◆ EvrRtxSemaphoreAcquire()

void EvrRtxSemaphoreAcquire	(	osSemaphoreId_t	semaphore_id,
		uint32_t	timeout
	)

Event on semaphore acquire (API)

Parameters

[in]	semaphore_id	semaphore ID obtained by osSemaphoreNew.
[in]	timeout	Timeout Value or 0 in case of no time-out.

The event SemaphoreAcquire is generated when the function osSemaphoreAcquire is called.

Value in the Event Recorder shows:

semaphore_id : semaphore ID.
timeout : Timeout Value.

◆ EvrRtxSemaphoreAcquirePending()

void EvrRtxSemaphoreAcquirePending	(	osSemaphoreId_t	semaphore_id,
		uint32_t	timeout
	)

Event on pending semaphore acquire (Op)

Parameters

[in]	semaphore_id	semaphore ID obtained by osSemaphoreNew.
[in]	timeout	Timeout Value or 0 in case of no time-out.

The event SemaphoreAcquirePending is generated when the function osSemaphoreAcquire blocks current running thread and waits for semaphore token to become available.

Value in the Event Recorder shows:

semaphore_id : semaphore ID.
timeout : Timeout Value.

◆ EvrRtxSemaphoreAcquireTimeout()

void EvrRtxSemaphoreAcquireTimeout ( osSemaphoreId_t semaphore_id )

Event on semaphore acquire timeout (Op)

Parameters

[in] semaphore_id semaphore ID obtained by osSemaphoreNew.

The event SemaphoreAcquireTimeout is generated when wait for semaphore to become available is aborted due to expired wait timeout.

Value in the Event Recorder shows:

semaphore_id : semaphore ID.

◆ EvrRtxSemaphoreAcquired()

void EvrRtxSemaphoreAcquired	(	osSemaphoreId_t	semaphore_id,
		uint32_t	tokens
	)

Event on successful semaphore acquire (Op)

Parameters

[in]	semaphore_id	semaphore ID obtained by osSemaphoreNew.
[in]	tokens	number of available tokens.

The event SemaphoreAcquired is generated when the function osSemaphoreAcquire successfully acquires the semaphore token.

Value in the Event Recorder shows:

semaphore_id : semaphore ID.
tokens : available tokens.

◆ EvrRtxSemaphoreNotAcquired()

void EvrRtxSemaphoreNotAcquired ( osSemaphoreId_t semaphore_id )

Event on unsuccessful semaphore acquire (Op)

Parameters

[in] semaphore_id semaphore ID obtained by osSemaphoreNew.

The event SemaphoreNotAcquired is generated when the function osMutexAcquire returns without timeout and semaphore token was not acquired.

Value in the Event Recorder shows:

semaphore_id : semaphore ID.

◆ EvrRtxSemaphoreRelease()

void EvrRtxSemaphoreRelease ( osSemaphoreId_t semaphore_id )

Event on semaphore release (API)

Parameters

[in] semaphore_id semaphore ID obtained by osSemaphoreNew.

The event SemaphoreRelease is generated when the function osSemaphoreRelease is called.

Value in the Event Recorder shows:

semaphore_id : semaphore ID.

◆ EvrRtxSemaphoreReleased()

void EvrRtxSemaphoreReleased	(	osSemaphoreId_t	semaphore_id,
		uint32_t	tokens
	)

Event on successful semaphore release (Op)

Parameters

[in]	semaphore_id	semaphore ID obtained by osSemaphoreNew.
[in]	tokens	number of available tokens.

The event SemaphoreReleased is generated when the function osSemaphoreRelease successfully releases the semaphore token.

Value in the Event Recorder shows:

semaphore_id : semaphore ID.
tokens : available tokens.

◆ EvrRtxSemaphoreGetCount()

void EvrRtxSemaphoreGetCount	(	osSemaphoreId_t	semaphore_id,
		uint32_t	count
	)

Event on semaphore token count retrieval (API)

Parameters

[in]	semaphore_id	semaphore ID obtained by osSemaphoreNew.
[in]	count	current number of available tokens.

The event SemaphoreGetCount is generated when the function osSemaphoreGetCount is called and its execution result is known.

Value in the Event Recorder shows:

semaphore_id : semaphore ID.
count : retrieved current number of available tokens.

◆ EvrRtxSemaphoreDelete()

void EvrRtxSemaphoreDelete ( osSemaphoreId_t semaphore_id )

Event on semaphore delete (API)

Parameters

[in] semaphore_id semaphore ID obtained by osSemaphoreNew.

The event SemaphoreDelete is generated when the function osSemaphoreDelete is called.

Value in the Event Recorder shows:

semaphore_id : semaphore ID.

◆ EvrRtxSemaphoreDestroyed()

void EvrRtxSemaphoreDestroyed ( osSemaphoreId_t semaphore_id )

Event on successful semaphore delete (Op)

Parameters

[in] semaphore_id semaphore ID obtained by osSemaphoreNew.

The event SemaphoreDestroyed is generated when the function osSemaphoreDelete successfully deletes the semaphore object.

Value in the Event Recorder shows:

semaphore_id : semaphore ID.

Functions

Description

Function Documentation

◆ EvrRtxSemaphoreError()

◆ EvrRtxSemaphoreNew()

◆ EvrRtxSemaphoreCreated()

◆ EvrRtxSemaphoreGetName()

◆ EvrRtxSemaphoreAcquire()

◆ EvrRtxSemaphoreAcquirePending()

◆ EvrRtxSemaphoreAcquireTimeout()

◆ EvrRtxSemaphoreAcquired()

◆ EvrRtxSemaphoreNotAcquired()

◆ EvrRtxSemaphoreRelease()

◆ EvrRtxSemaphoreReleased()

◆ EvrRtxSemaphoreGetCount()

◆ EvrRtxSemaphoreDelete()

◆ EvrRtxSemaphoreDestroyed()