Function

This section provides high level APIs to upper layer. More...

Overview

This section provides high level APIs to upper layer.

Functions
int	mtk_os_hal_eint_register (eint_number eint_num, eint_trigger_mode trigger_mode, void(*handle)(void))
	This function is used to register EINT. More...
int	mtk_os_hal_eint_unregister (eint_number eint_num)
	This function is used to unregister EINT. More...
int	mtk_os_hal_eint_set_debounce (eint_number eint_num, os_hal_eint_debounce_time debounce_time)
	This function is used to set EINT debounce time and enable it. More...
int	mtk_os_hal_eint_set_type (eint_number eint_num, eint_trigger_mode trigger_mode)
	This function is used to set EINT trigger type. More...
int	mtk_os_hal_eint_enable_debounce (eint_number eint_num)
	This function is used to enable debounce function. More...
int	mtk_os_hal_eint_disable_debounce (eint_number eint_num)
	This function is used to disable debounce function. More...

Function Documentation

int mtk_os_hal_eint_register	(	eint_number	eint_num,
		eint_trigger_mode	trigger_mode,
		void(*)(void)	handle
	)

This function is used to register EINT.

Usage: If User want use EINT, should call it to register EINT.

Parameters

[in]	eint_num	: eint_num is the EINT number, the value is HAL_EINT_NUMBER_0 ~ HAL_EINT_NUMBER_MAX-1.
[in]	trigger_mode	: EINT trigger mode.
[in]	handle	: The callback function when EINT is triggered.

Returns

Return value is positive number mean it is irq number. Return -EINVAL if eint_num or trigger_mode is invalid argument.

int mtk_os_hal_eint_unregister

(

eint_number

eint_num

)

This function is used to unregister EINT.

Usage: After register EINT, if user want close EINT function. User should call it to unregister eint.

Parameters

[in]

eint_num

: eint_num is the EINT number, the value is HAL_EINT_NUMBER_0 ~ HAL_EINT_NUMBER_MAX-1.

Returns

Return "0" if unregister success. Return -EINVAL if eint_num is invalid argument.

int mtk_os_hal_eint_set_debounce	(	eint_number	eint_num,
		os_hal_eint_debounce_time	debounce_time
	)

This function is used to set EINT debounce time and enable it.

Usage: After register EINT, if user want use debounce function, user should call it to set EINT debounce time and enable it.

Parameters

[in]	eint_num	: eint_num is the EINT number, the value is HAL_EINT_NUMBER_0 ~ HAL_EINT_NUMBER_MAX-1.
[in]	debounce_time	: debounce_time is the EINT debounce time, the value is OS_HAL_EINT_DB_TIME_1 ~ OS_HAL_EINT_DB_TIME_MAX.

Returns

Return "0" if set debounce success. Return -EINVAL if eint_num or debounce_time is invalid argument.

int mtk_os_hal_eint_set_type	(	eint_number	eint_num,
		eint_trigger_mode	trigger_mode
	)

This function is used to set EINT trigger type.

Usage: After register EINT, if user want to change trigger mode, User can call it to change EINT trigger mode.

Parameters

[in]	eint_num	: eint_num is the EINT number, the value is HAL_EINT_NUMBER_0 ~ HAL_EINT_NUMBER_MAX-1.
[in]	trigger_mode	: EINT trigger mode.

Returns

Return "0" if set type success. Return -EINVAL if eint_num or trigger_mode is invalid argument.

int mtk_os_hal_eint_enable_debounce

(

eint_number

eint_num

)

This function is used to enable debounce function.

Usage: After disable debounce, user can call it to enable debounce.

Parameters

[in]

eint_num

: eint_num is the EINT number, the value is HAL_EINT_NUMBER_0 ~ HAL_EINT_NUMBER_MAX-1.

Returns

Return "0" if enable debounce success. Return -EINVAL if eint_num is invalid argument.

int mtk_os_hal_eint_disable_debounce

(

eint_number

eint_num

)

This function is used to disable debounce function.

Usage:User can call it to disable debounce function.

Parameters

[in]

eint_num

: eint_num is the EINT number, the value is HAL_EINT_NUMBER_0 ~ HAL_EINT_NUMBER_MAX-1.

Returns

Return "0" if set type success. Return -EINVAL if eint_num is invalid argument.