CMSIS-RTOS2 文档翻译 之 参考（RTX5 特定的 API 之 事件功能（内核函数））

内核函数

事件功能

内核函数生成的事件。更多...

函数
void	EvrRtxKernelError (int32_t status)
	关于 RTOS 内核错误的事件（错误）更多...
void	EvrRtxKernelInitialize (void)
	RTOS 内核初始化事件（API）更多...
void	EvrRtxKernelInitializeCompleted (void)
	成功的 RTOS 内核初始化事件（Op）更多...
void	EvrRtxKernelGetInfo (osVersion_t *version, char *id_buf, uint32_t id_size)
	RTOS 内核信息检索事件（API）更多...
void	EvrRtxKernelInfoRetrieved (osVersion_t *version, char *id_buf)
	成功的 RTOS 内核信息检索事件（Op）更多...
void	EvrRtxKernelGetState (osKernelState_t state)
	关于当前 RTOS 内核状态检索的事件（API）更多...
void	EvrRtxKernelStart (void)
	RTOS 上的事件内核调度程序启动（API）更多...
void	EvrRtxKernelStarted (void)
	成功的 RTOS 内核调度程序启动事件（Op）更多...
void	EvrRtxKernelLock (void)
	RTOS 上的事件内核调度程序锁定（API）更多...
void	EvrRtxKernelLocked (int32_t lock)
	成功的 RTOS 内核调度程序锁定事件（Op）更多...
void	EvrRtxKernelUnlock (void)
	RTOS 内核调度程序解锁事件（API）更多...
void	EvrRtxKernelUnlocked (int32_t lock)
	成功的 RTOS 内核调度程序解锁事件（Op）更多...
void	EvrRtxKernelRestoreLock (int32_t lock)
	RTOS 上的事件内核调度程序锁定状态恢复（API）更多...
void	EvrRtxKernelLockRestored (int32_t lock)
	成功的 RTOS 内核调度程序锁定状态恢复事件（Op）更多...
void	EvrRtxKernelSuspend (void)
	RTOS 上的事件内核调度程序暂停（API）更多...
void	EvrRtxKernelSuspended (uint32_t sleep_ticks)
	成功的 RTOS 内核调度程序暂停事件（Op）更多...
void	EvrRtxKernelResume (uint32_t sleep_ticks)
	RTOS 内核调度程序恢复事件（API）更多...
void	EvrRtxKernelResumed (void)
	成功的 RTOS 内核调度程序恢复事件（Op）更多...
void	EvrRtxKernelGetTickCount (uint32_t count)
	关于 RTOS 核心滴答计数检索的事件（API）更多...
void	EvrRtxKernelGetTickFreq (uint32_t freq)
	关于 RTOS 内核滴答频率检索的事件（API）更多...
void	EvrRtxKernelGetSysTimerCount (uint32_t count)
	RTOS 内核系统定时器计数检索事件（API）更多...
void	EvrRtxKernelGetSysTimerFreq (uint32_t freq)
	RTOS 内核系统定时器频率检索事件（API）更多...

描述

函数文档

void EvrRtxKernelError

(

int32_t

status

)

参数

[in]

status

延长执行状态。

当内核信息和控制例程由于错误而完成它们的执行时，会生成事件 KernelError 。

status 参数指示执行状态，可以是 osStatus_t 代码之一或下表中汇总的扩展执行状态代码之一。

扩展状态码	描述
osRtxErrorKernelNotReady	内核调度程序未处于就绪状态。
osRtxErrorKernelNotRunning	内核调度程序未执行 - 没有正在运行的线程。
osRtxErrorInvalidControlBlock	指定了具有无效对齐或大小的对象控制块。
osRtxErrorInvalidDataMemory	指定了具有无效对齐或大小的对象数据存储器。
osRtxErrorInvalidThreadStack	线程堆栈内存的无效对齐或大小被指定。
osRtxErrorInvalidPriority	指定了无效的线程优先级。
osRtxErrorThreadNotJoinable	指定的线程不可连接。
osRtxErrorMutexNotOwned	指定的互斥锁不属于当前正在运行的线程。
osRtxErrorMutexNotLocked	指定的互斥锁未锁定。
osRtxErrorMutexLockLimit	达到递归互斥锁的最大数目。
osRtxErrorSemaphoreCountLimit	达到了信号量计数限制。
osRtxErrorTZ_InitContext_S	安全上下文内存系统初始化失败
osRtxErrorTZ_AllocContext_S	安全上下文内存分配失败。
osRtxErrorTZ_FreeContext_S	安全上下文内存释放失败。
osRtxErrorTZ_LoadContext_S	安全上下文加载失败。
osRtxErrorTZ_SaveContext_S	安全上下文保存失败。

事件记录器中的值显示：

• status : 执行状态代码。

void EvrRtxKernelInitialize

(

void

)

事件 KernelInitialize 在调用函数 osKernelInitialize 时生成。

void EvrRtxKernelInitializeCompleted

(

void

)

当函数 osKernelInitialize 成功初始化 RTOS 内核时，会生成事件 KernelInitializeCompleted 。

void EvrRtxKernelGetInfo	(	osVersion_t *	version,
		char *	id_buf,
		uint32_t	id_size
	)

参数

[in]	version	指向缓冲区的指针以检索版本信息。
[in]	id_buf	指向检索内核标识字符串的缓冲区的指针。
[in]	id_size	内核标识字符串的缓冲区大小。

事件 KernelGetInfo 在调用函数 osKernelGetInfo 时生成。

事件记录器中的值显示：

• version : 用于检索版本信息的缓冲区的内存地址。
• id_buf : 用于检索内核标识字符串的缓冲区的内存地址。
• id_size : id_buf 的大小以字节为单位。

void EvrRtxKernelInfoRetrieved	(	osVersion_t *	version,
		char *	id_buf
	)

参数

[in]	version	指向缓冲区的指针以检索版本信息。
[in]	id_buf	指向检索内核标识字符串的缓冲区的指针。

当函数 osKernelGetInfo 成功检索内核信息时，会生成事件 KernelInfoRetrieved 。

事件记录器中的值显示：

• version : 用于检索版本信息的缓冲区的内存地址。
• id_buf : 用于检索内核标识字符串的缓冲区的内存地址。

void EvrRtxKernelGetState

(

osKernelState_t

state

)

参数

[in]

state

当前 RTOS 内核状态。

事件 KernelGetState 在调用函数 osKernelGetState 并且其执行结果已知时生成。

事件记录器中的值显示：

• state : 检索当前的 RTOS 内核状态。

void EvrRtxKernelStart

(

void

)

事件 KernelStart 在调用函数 osKernelStart 时生成。

void EvrRtxKernelStarted

(

void

)

当函数 osKernelStart 成功启动 RTOS 内核执行时，会生成事件 KernelStarted 。

void EvrRtxKernelLock

(

void

)

事件 KernelLock 在调用函数 osKernelLock 时生成。

void EvrRtxKernelLocked

(

int32_t

lock

)

参数

[in]

lock

之前的锁定状态（1 - 锁定，0 - 未锁定）。

事件 KernelLocked 在函数 osKernelLock 成功完成执行时生成。

事件记录器中的值显示：

• lock : 之前的锁定状态（1 - 锁定，0 - 未锁定）。

void EvrRtxKernelUnlock

(

void

)

事件 KernelUnlock 在调用函数 osKernelUnlock 时生成。

void EvrRtxKernelUnlocked

(

int32_t

lock

)

参数

[in]

lock

之前的锁定状态（1 - 锁定，0 - 未锁定）。

事件 KernelUnlocked 在函数 osKernelUnlock 成功完成执行时生成。

事件记录器中的值显示：

• lock : 之前的锁定状态（1 - 锁定，0 - 未锁定）。

void EvrRtxKernelRestoreLock

(

int32_t

lock

)

参数

[in]

lock

锁状态由 osKernelLock 或 osKernelUnlock 获取。

当调用函数 osKernelRestoreLock 时，会生成 KernelRestoreLock 事件。

事件记录器中的值显示：

• lock : 锁状态由 osKernelLock 或 osKernelUnlock 获取。

void EvrRtxKernelLockRestored

(

int32_t

lock

)

参数

[in]

lock

新的锁定状态（1 - 锁定，0 - 未锁定）。

当函数 osKernelRestoreLock 成功完成执行时，将生成 KernelLockRestored 事件。

事件记录器中的值显示：

• lock : 新的锁定状态（1 - 锁定，0 - 未锁定）。

void EvrRtxKernelSuspend

(

void

)

事件 KernelSuspend 在调用函数 osKernelSuspend 时生成。

void EvrRtxKernelSuspended

(

uint32_t

sleep_ticks

)

参数

[in]

sleep_ticks

时间以刻度表示，系统可以睡多久或关闭电源。

当函数 osKernelSuspend 成功挂起 RTOS 内核执行时，生成 KernelSuspended 事件。

事件记录器中的值显示：

• sleep_ticks : 时间以刻度表示，系统可以睡多久或关闭电源。

void EvrRtxKernelResume

(

uint32_t

sleep_ticks

)

参数

[in]

sleep_ticks

时间以刻度表示，系统处于睡眠或关机模式的时间。

事件 KernelResume 在调用函数 osKernelResume 时生成。

事件记录器中的值显示：

• sleep_ticks : 时间以刻度表示，系统处于睡眠或关机模式的时间。

void EvrRtxKernelResumed

(

void

)

当功能 osKernelResume 成功恢复 RTOS 内核执行时，会生成事件 KernelResumed 。

void EvrRtxKernelGetTickCount

(

uint32_t

count

)

参数

[in]

count

RTOS 内核当前滴答计数。

事件 KernelGetTickCount 在调用函数 osKernelGetTickCount 时生成。

事件记录器中的值显示：

• count : 检索到的内核当前节拍数。

void EvrRtxKernelGetTickFreq

(

uint32_t

freq

)

参数

[in]

freq

内核滴答的频率。

事件 KernelGetTickFreq 在函数 osKernelGetTickFreq 被调用时生成。

事件记录器中的值显示：

• freq : 以 Hz 为单位检索内核刻度的频率。

void EvrRtxKernelGetSysTimerCount

(

uint32_t

count

)

参数

[in]

count

RTOS 内核当前系统定时器计数为 32 位值。

事件 KernelGetSysTimerCount 在调用函数 osKernelGetSysTimerCount 时生成。

事件记录器中的值显示：

• count : 检索到的内核当前系统定时器计数为 32 位值。

void EvrRtxKernelGetSysTimerFreq

(

uint32_t

freq

)

参数

[in]

freq

系统定时器的频率。

事件 KernelGetSysTimerFreq 在调用函数 osKernelGetSysTimerFreq 时生成。

事件记录器中的值显示：

• freq : 以 Hz 为单位检索系统定时器的频率。