wdt_common.c File Reference

#include "hal/driver/driver.h"

Macros
#define	VSF_WDT_CFG_FUNCTION_RENAME   DISABLED

Functions
vsf_err_t	vsf_wdt_init (vsf_wdt_t *wdt_ptr, vsf_wdt_cfg_t *cfg_ptr)
	Initialize a WDT instance.
void	vsf_wdt_fini (vsf_wdt_t *wdt_ptr)
	Finalize a WDT instance.
vsf_err_t	vsf_wdt_get_configuration (vsf_wdt_t *wdt_ptr, vsf_wdt_cfg_t *cfg_ptr)
	Get the current configuration of a WDT instance.
fsm_rt_t	vsf_wdt_enable (vsf_wdt_t *wdt_ptr)
	Enable a WDT instance.
fsm_rt_t	vsf_wdt_disable (vsf_wdt_t *wdt_ptr)
	Disable a WDT instance.
vsf_wdt_capability_t	vsf_wdt_capability (vsf_wdt_t *wdt_ptr)
	Get the capability of WDT instance.
void	vsf_wdt_feed (vsf_wdt_t *wdt_ptr)
	WDT feed operation.

Macro Definition Documentation

VSF_WDT_CFG_FUNCTION_RENAME

#define VSF_WDT_CFG_FUNCTION_RENAME   DISABLED

Function Documentation

vsf_wdt_init()

vsf_err_t vsf_wdt_init	(	vsf_wdt_t *	wdt_ptr,
		vsf_wdt_cfg_t *	cfg_ptr
	)

Initialize a WDT instance.

Parameters

[in]	wdt_ptr	a pointer to structure vsf_wdt_t
[in]	cfg_ptr	a pointer to structure vsf_wdt_cfg_t

Returns

vsf_err_t: VSF_ERR_NONE if WDT was initialized, or a negative error code

Note

It is not necessary to call vsf_wdt_fini() for deinitialization. vsf_wdt_init() should be called before any other WDT API except vsf_wdt_capability().

vsf_wdt_fini()

void vsf_wdt_fini

(

vsf_wdt_t *

wdt_ptr

)

Finalize a WDT instance.

Parameters

[in]

wdt_ptr

a pointer to structure vsf_wdt_t

Returns

none

vsf_wdt_get_configuration()

vsf_err_t vsf_wdt_get_configuration	(	vsf_wdt_t *	wdt_ptr,
		vsf_wdt_cfg_t *	cfg_ptr
	)

Get the current configuration of a WDT instance.

Parameters

[in]	wdt_ptr	pointer to structure vsf_wdt_t
[out]	cfg_ptr	pointer to configuration structure vsf_wdt_cfg_t to store the current configuration

Returns

vsf_err_t: VSF_ERR_NONE if successful, otherwise return error code

Note

This function retrieves the current WDT configuration including timeout and interrupt settings. The WDT instance should be initialized before calling this function.

vsf_wdt_enable()

fsm_rt_t vsf_wdt_enable

(

vsf_wdt_t *

wdt_ptr

)

Enable a WDT instance.

Parameters

[in]

wdt_ptr

a pointer to structure vsf_wdt_t

Returns

fsm_rt_t: FSM_RT_CPL if WDT was enabled, fsm_rt_on_going if WDT is still enabling

vsf_wdt_disable()

fsm_rt_t vsf_wdt_disable

(

vsf_wdt_t *

wdt_ptr

)

Disable a WDT instance.

Parameters

[in]

wdt_ptr

a pointer to structure vsf_wdt_t

Returns

fsm_rt_t: FSM_RT_CPL if WDT was disabled, fsm_rt_on_going if WDT is still disabling

vsf_wdt_capability()

vsf_wdt_capability_t vsf_wdt_capability

(

vsf_wdt_t *

wdt_ptr

)

Get the capability of WDT instance.

Parameters

[in]

wdt_ptr

a pointer to structure vsf_wdt_t

Returns

vsf_wdt_capability_t: all capability of current WDT vsf_wdt_capability_t

vsf_wdt_feed()

void vsf_wdt_feed

(

vsf_wdt_t *

wdt_ptr

)

WDT feed operation.

Parameters

[in]

wdt_ptr

a pointer to structure vsf_wdt_t