This section provides Fixed APIs (defined as Common Interface) to fully support three low power scenarios of ARM Cortex-M4F I/O subsystems. More...

Overview

This section provides Fixed APIs (defined as Common Interface) to fully support three low power scenarios of ARM Cortex-M4F I/O subsystems.

Functions
void	mtk_os_hal_lp_config_gpt3_timeout (uint32_t time_val)
	This function is used to configure timeout value of GPT3. More...

int	mtk_os_hal_lp_dslp_check (dslp_check stage)
	This function is used to check whether ARM Cortex-M4F I/O subsystems have entered DSLP. More...

int	mtk_os_hal_lp_enter (uint32_t wakeup_src, lp_scenario lp)
	This function is used to enter different low power scenarios. More...

Function Documentation

void mtk_os_hal_lp_config_gpt3_timeout ( uint32_t time_val )

This function is used to configure timeout value of GPT3.

Usage: It's called before selecting GPT3 as wakeup source.

Parameters

[in] time_val : GPT3 timeout value and unit is second.

int mtk_os_hal_lp_dslp_check ( dslp_check stage )

This function is used to check whether ARM Cortex-M4F I/O subsystems have entered DSLP.

Usage: It's called before entering DSLP and after exiting DSLP.

Parameters

[in] stage : Different DSLP stages.

Returns: Return "0" if DSLP status bit is operated successfully.
Return "-1" if the parameter stage is invalid.

This function is used to enter different low power scenarios.

Usage: It's called when ARM Cortex-M4F I/O subsystems need to enter low power scenario.

Parameters

[in]	wakeup_src	: Wakeup source used to wake up system. The supported wakeup sources are defined in lp_wakeup_src enumeration and more than one wakeup sources can be selected by bitwise OR operation at the same time.
[in]	lp	: Low power scenario that the system will enter.

Returns: Return "0" if the system enters low power scenario successfully.
Return "-1" if the parameter wakeup_src or lp is invalid.