OS Hook

API 介绍

This section introduces OS hook reference api.

Typedefs

typedef void (*os_hook_idle_callback)(void)

typedef void (*os_hook_tick_callback)(void)

typedef void (*os_hook_malloc_fail_callback)(void)

typedef void (*os_hook_sleep_process_callback)(uint32_t expected_idle_time_ms)

typedef uint32_t (*os_hook_time_stamp_callback)(void)

typedef uint32_t (*os_hook_save_callback)(void)

typedef uint32_t (*os_hook_restore_callback)(void)

typedef void (*os_hook_failed_dump_cb)(void)

typedef void (*os_hook_sleep_fail_callback)(void)

typedef void (*os_hook_panic_callback)(unsigned int)

typedef int (*os_hook_print_callback)(const char*, va_list)

Functions

void os_hook_set_sleep_flags(uint8_t val)

This function is OS's flag set.

uint8_t os_hook_get_sleep_flags(void)

This function is OS's flag get.

uint8_t os_hook_failed_dump_register_callback(os_hook_failed_dump_cb cb)

This function is failed dump hook to register callback function.

参数:

cb -- is the failed dump hook callback.

返回:

uint8_t WQ_RET_OK for success else error.

uint8_t os_hook_idle_register_callback(os_hook_idle_callback cb)

This function is idle hook to register callback function.

参数:

cb -- is the idle hook callback.

返回:

uint8_t WQ_RET_OK for success else error.

uint8_t os_hook_tick_register_callback(os_hook_tick_callback cb)

This function is tick hook to register callback function.

参数:

cb -- is the tick hook callback.

返回:

uint8_t WQ_RET_OK for success else error.

uint8_t os_hook_malloc_fail_register_callback(os_hook_malloc_fail_callback cb)

This function is hook to malloc failed register callback function.

参数:

cb -- is the malloc failed callback.

返回:

uint8_t WQ_RET_OK for success else error.

uint8_t os_hook_panic_register_callback(os_hook_panic_callback cb)

This function is hook to os panic register callback function.

参数:

cb -- is the os panic callback.

返回:

uint8_t WQ_RET_OK for success else error.

uint8_t os_hook_idle_unregister_callback(os_hook_idle_callback cb)

This function is idle hook to unregister callback function.

参数:

cb -- is the idle hook callback.

返回:

uint8_t WQ_RET_OK for success else error.

uint8_t os_hook_tick_unregister_callback(os_hook_tick_callback cb)

This function is tick hook to unregister callback function.

参数:

cb -- is the tick hook callback.

返回:

uint8_t WQ_RET_OK for success else error.

uint8_t os_hook_malloc_fail_unregister_callback(void)

This function is hook to malloc failed unregister callback function.

返回:

uint8_t WQ_RET_OK for success else error.

uint8_t os_hook_sleep_register_callback(os_hook_sleep_process_callback cb)

This function is sleep register callback.

参数:

cb -- is the sleep process callback.

返回:

uint8_t WQ_RET_OK for success else error.

uint8_t os_hook_time_stamp_register_callback(os_hook_time_stamp_callback cb)

This function is time stamp register callback.

参数:

cb -- is the hook time stamp callback.

返回:

uint8_t WQ_RET_OK for success else error.

uint8_t os_hook_sys_save_register_callback(os_hook_save_callback cb)

This function is used to save system infoformation register callback.

参数:

cb -- is to save system infoformation callback.

返回:

uint8_t WQ_RET_OK for success else error.

uint8_t os_hook_sys_restore_register_callback(os_hook_restore_callback cb)

This function is used to restore system infoformation register callback.

参数:

cb -- is to restore system infoformation callback.

返回:

uint8_t WQ_RET_OK for success else error.

void os_hook_sleep_fail_regisiter_callback(os_hook_sleep_fail_callback cb)

This function is sleep failed register callback.

参数:

cb -- is the sleep process failed callback.

void os_hook_sleep_fail_handler(void)

This function is sleep failed handler.