Utilities API#

APP_RTOS_ASSERT_CRITICAL()#

Description#

Assert given expression. In case of failure, calls RTOS_CFG_RTOS_ASSERT_CRITICAL_FAILED_END_CALL(ret_val) if defined, CPU_SW_EXCEPTION(ret_val) if not.

Files#

lib_mem.h/lib_mem.c

Prototype#

    APP_RTOS_ASSERT_CRITICAL (expr, ret_val)

Arguments#

expr

Expression to assert. If expression is false, the assert fail call will be made.

ret_val

Value that would be returned from the function, ';' if void.

Returned Value#

None.

Notes / Warnings#

  1. Usage of assert is as follows: APP_RTOS_ASSERT_CRITICAL((p_buf != DEF_NULL), ;);

APP_RTOS_ASSERT_DBG()#

Description#

Assert given expression. In case of failure, calls RTOS_CFG_RTOS_ASSERT_DBG_FAILED_END_CALL(ret_val) if defined, CPU_SW_EXCEPTION(ret_val) if not.

Files#

lib_mem.h/lib_mem.c

Prototype#

    APP_RTOS_ASSERT_DBG (expr, ret_val)

Arguments#

expr

Expression to assert. If expression is false, the assert fail call will be made.

ret_val

Value that would be returned from the function, ';' if void.

Returned Value#

None.

Notes / Warnings#

  1. Usage of assert is as follows: APP_RTOS_ASSERT_DBG((p_buf != DEF_NULL), DEF_NULL);

APP_RTOS_ASSERT_CRITICAL_FAIL()#

Description#

Calls END_CALL as configured by user. No check is made.

Files#

lib_mem.h/lib_mem.c

Prototype#

    APP_RTOS_ASSERT_CRITICAL_FAIL (ret_val)

Arguments#

ret_val

Value that would be returned from the function, ';' if void.

Returned Value#

None.

Notes / Warnings#

None.

APP_RTOS_ASSERT_DBG_FAIL()#

Description#

Checks if assert is enabled for current module. Calls END_CALL as configured by user. No check is made.

Files#

lib_mem.h/lib_mem.c

Prototype#

    APP_RTOS_ASSERT_DBG_FAIL (ret_val)

Arguments#

ret_val

Value that would be returned from the function, ';' if void.

Returned Value#

None.

Notes / Warnings#

None.

RTOS_Version()#

Description#

Obtain current version of Micrium OS.

Files#

rtos_version.h/rtos_utils.c

Prototype#

CPU_INT32U  RTOS_Version (void)

Arguments#

None.

Returned Value#

Version number of Micrium OS (Vx.yy.zz) multiplied by 10000.

Notes / Warnings#

None.