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.
fsm_rt_t	vsf_wdt_enable (vsf_wdt_t *wdt_ptr)
	enable interrupt masks of wdt instance.
fsm_rt_t	vsf_wdt_disable (vsf_wdt_t *wdt_ptr)
	disable interrupt masks of 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

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() to 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_enable()

fsm_rt_t vsf_wdt_enable

(

vsf_wdt_t *

wdt_ptr

)

enable interrupt masks of wdt instance.

Parameters

[in]	wdt_ptr	a pointer to structure vsf_wdt_t
[in]	irq_mask	one or more value of enum vsf_wdt_irq_mask_t

Returns

none.

vsf_wdt_disable()

fsm_rt_t vsf_wdt_disable

(

vsf_wdt_t *

wdt_ptr

)

disable interrupt masks of wdt instance.

Parameters

[in]	wdt_ptr	a pointer to structure vsf_wdt_t
[in]	irq_mask	one or more value of enum vsf_wdt_irq_mask_t, vsf_wdt_irq_mask_t

Returns

none.

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: return all capability of current wdt vsf_wdt_capability_t

vsf_wdt_feed()

void vsf_wdt_feed

(

vsf_wdt_t *

wdt_ptr

)

wdt feed

Parameters

[in]

wdt_ptr

a pointer to structure vsf_wdt_t