[watchdog.h] Watchdog Timer Interface

Collaboration diagram for [watchdog.h] Watchdog Timer Interface:

Macros
#define	HOSTMCU_AON_CFGWICSNS_ELP_TMR_EN   (HOSTMCU_AON_CFGWICSNS_VAL_TMRREQ_EN << 0)
#define	HOSTMCU_AON_CFGWUTP_ELP_TMR_FAST   (HOSTMCU_AON_CFGWUTP_VAL_TMRREQ << 0)

Functions
__STATIC_INLINE void	WatchdogClearWakeUpEvent (void)
	Clears the timer wake-up event. More...
__STATIC_INLINE void	WatchdogDisableWakeUpEvent (void)
	Disables the timer wake-up event. More...
__STATIC_INLINE void	WatchdogDisableResetEvent (void)
	Disables the timer reset event. More...
__STATIC_INLINE void	WatchdogEnableWakeUpEvent (void)
	Enables the timer wake-up event. More...
__STATIC_INLINE void	WatchdogEnableResetEvent (void)
	Enables the timer reset event. More...
__STATIC_INLINE bool	WatchdogStatus (void)
	Reads the status of the timer. More...
__STATIC_INLINE void	WatchdogWaitUntilEnabled (void)
	Waits until the timer is enabled. More...
__STATIC_INLINE void	WatchdogWaitUntilDisabled (void)
	Waits until the timer is disabled. More...
__STATIC_INLINE void	WatchdogReset (void)
	Re-sets the timer back to zero. More...
__STATIC_INLINE void	WatchdogSetWakeUpThreshold (uint32_t ticks)
	Sets the wake-up threshold. More...
__STATIC_INLINE void	WatchdogSetResetThreshold (uint32_t ticks)
	Sets the reset threshold. More...
__STATIC_INLINE void	WatchdogSetSwMode (void)
	Configures the timer to work in software mode. More...
void	WatchdogStartSequence (void)
	Sequence to start the timer. More...
void	WatchdogStopSequence (void)
	Sequence to stop the timer. More...

Detailed Description

Macro Definition Documentation

HOSTMCU_AON_CFGWICSNS_ELP_TMR_EN

#define HOSTMCU_AON_CFGWICSNS_ELP_TMR_EN   (HOSTMCU_AON_CFGWICSNS_VAL_TMRREQ_EN << 0)

Referenced by WatchdogDisableWakeUpEvent(), and WatchdogEnableWakeUpEvent().

HOSTMCU_AON_CFGWUTP_ELP_TMR_FAST

#define HOSTMCU_AON_CFGWUTP_ELP_TMR_FAST   (HOSTMCU_AON_CFGWUTP_VAL_TMRREQ << 0)

Referenced by WatchdogEnableWakeUpEvent().

Function Documentation

WatchdogClearWakeUpEvent()

__STATIC_INLINE void WatchdogClearWakeUpEvent

(

void

)

Clears the timer wake-up event.

Returns

None

References HOSTMCU_AON_BASE, HOSTMCU_AON_O_TMRWUREQ, HOSTMCU_AON_TMRWUREQ_CLR_M, and HWREG.

WatchdogDisableWakeUpEvent()

__STATIC_INLINE void WatchdogDisableWakeUpEvent

(

void

)

Disables the timer wake-up event.

Returns

None

References HOSTMCU_AON_BASE, HOSTMCU_AON_CFGTMRWU_EN, HOSTMCU_AON_CFGWICSNS_ELP_TMR_EN, HOSTMCU_AON_O_CFGTMRWU, HOSTMCU_AON_O_CFGWICSNS, and HWREG.

WatchdogDisableResetEvent()

__STATIC_INLINE void WatchdogDisableResetEvent

(

void

)

Disables the timer reset event.

Returns

None

References HOSTMCU_AON_BASE, HOSTMCU_AON_CFGWDT_EN, HOSTMCU_AON_O_CFGWDT, and HWREG.

WatchdogEnableWakeUpEvent()

__STATIC_INLINE void WatchdogEnableWakeUpEvent

(

void

)

Enables the timer wake-up event.

This function configures the wake-up event as a fast wake-up source, as a sleep wake-up source and enables it.

Returns

None

References HOSTMCU_AON_BASE, HOSTMCU_AON_CFGTMRWU_EN, HOSTMCU_AON_CFGWICSNS_ELP_TMR_EN, HOSTMCU_AON_CFGWUTP_ELP_TMR_FAST, HOSTMCU_AON_O_CFGTMRWU, HOSTMCU_AON_O_CFGWICSNS, HOSTMCU_AON_O_CFGWUTP, and HWREG.

WatchdogEnableResetEvent()

__STATIC_INLINE void WatchdogEnableResetEvent

(

void

)

Enables the timer reset event.

Returns

None

References HOSTMCU_AON_BASE, HOSTMCU_AON_CFGWDT_EN, HOSTMCU_AON_O_CFGWDT, and HWREG.

WatchdogStatus()

__STATIC_INLINE bool WatchdogStatus

(

void

)

Reads the status of the timer.

Returns

Returns if the timer is enabled or not

References HOSTMCU_AON_BASE, HOSTMCU_AON_ELPTMREN_VAL_M, HOSTMCU_AON_ELPTMREN_VAL_S, HOSTMCU_AON_O_ELPTMREN, and HWREG.

Referenced by WatchdogWaitUntilDisabled(), and WatchdogWaitUntilEnabled().

WatchdogWaitUntilEnabled()

__STATIC_INLINE void WatchdogWaitUntilEnabled

(

void

)

Waits until the timer is enabled.

Returns

None

References HOSTMCU_AON_ELPTMREN_VAL_EN, and WatchdogStatus().

Referenced by WatchdogStartSequence().

WatchdogWaitUntilDisabled()

__STATIC_INLINE void WatchdogWaitUntilDisabled

(

void

)

Waits until the timer is disabled.

Returns

None

References HOSTMCU_AON_ELPTMREN_VAL_DIS, and WatchdogStatus().

Referenced by WatchdogStopSequence().

WatchdogReset()

__STATIC_INLINE void WatchdogReset

(

void

)

Re-sets the timer back to zero.

Returns

None

References HOSTMCU_AON_BASE, HOSTMCU_AON_ELPTMREN_ELPTMRLD, HOSTMCU_AON_O_ELPTMREN, and HWREG.

Referenced by WatchdogStartSequence().

WatchdogSetWakeUpThreshold()

__STATIC_INLINE void WatchdogSetWakeUpThreshold

(

uint32_t

ticks

)

Sets the wake-up threshold.

Note

This function aligns the wake-up threshold resolution to match the reset resolution. Therefore, the resolution of one tick is 7.8125 ms.

Parameters

[in]

ticks

is the time in reset threshold ticks. Must be greater than 1.

Returns

None

References HOSTMCU_AON_BASE, HOSTMCU_AON_CFGTMRWU_THR_M, HOSTMCU_AON_CFGWDT_THR_M, HOSTMCU_AON_CFGWDT_THR_S, HOSTMCU_AON_O_CFGTMRWU, and HWREG.

WatchdogSetResetThreshold()

__STATIC_INLINE void WatchdogSetResetThreshold

(

uint32_t

ticks

)

Sets the reset threshold.

Note

The resolution of one tick is 7.8125 ms.

Parameters

[in]

ticks

is the time in reset threshold ticks. Must be greater than 1.

Returns

None

References HOSTMCU_AON_BASE, HOSTMCU_AON_CFGWDT_THR_M, HOSTMCU_AON_CFGWDT_THR_S, HOSTMCU_AON_O_CFGWDT, and HWREG.

WatchdogSetSwMode()

__STATIC_INLINE void WatchdogSetSwMode

(

void

)

Configures the timer to work in software mode.

This function configures the timer to be operational during sleep and wake-up. This requires to manually control the timer.

Returns

None

References HOSTMCU_AON_BASE, HOSTMCU_AON_ELPTMREN_TMRSWCTL_SW, HOSTMCU_AON_O_ELPTMREN, HWREG, WatchdogStartSequence(), and WatchdogStopSequence().

WatchdogStartSequence()

void WatchdogStartSequence

(

void

)

Sequence to start the timer.

This function implements the sequence to start the timer as required by the hardware.

Returns

None

References HOSTMCU_AON_BASE, HOSTMCU_AON_ELPTMREN_ELPTMRRST, HOSTMCU_AON_ELPTMREN_ELPTMRSET, HOSTMCU_AON_O_ELPTMREN, HWREG, WatchdogReset(), and WatchdogWaitUntilEnabled().

Referenced by WatchdogSetSwMode().

WatchdogStopSequence()

void WatchdogStopSequence

(

void

)

Sequence to stop the timer.

This function implements the sequence to stop the timer as required by the hardware.

Returns

None

References HOSTMCU_AON_BASE, HOSTMCU_AON_ELPTMREN_ELPTMRRST, HOSTMCU_AON_O_ELPTMREN, HWREG, and WatchdogWaitUntilDisabled().

Referenced by WatchdogSetSwMode().