rtc_common.c File Reference

#include "hal/vsf_hal_cfg.h"
#include "hal/driver/driver.h"

Macros
#define	VSF_RTC_CFG_FUNCTION_RENAME   DISABLED

Functions
vsf_err_t	vsf_rtc_init (vsf_rtc_t *rtc_ptr, vsf_rtc_cfg_t *cfg_ptr)
	initialize a rtc instance.
void	vsf_rtc_fini (vsf_rtc_t *rtc_ptr)
	finalize a rtc instance.
fsm_rt_t	vsf_rtc_enable (vsf_rtc_t *rtc_ptr)
	enable interrupt masks of rtc instance.
fsm_rt_t	vsf_rtc_disable (vsf_rtc_t *rtc_ptr)
	disable interrupt masks of rtc instance.
vsf_err_t	vsf_rtc_get (vsf_rtc_t *rtc_ptr, vsf_rtc_tm_t *rtc_tm)
	get rtc date time
vsf_err_t	vsf_rtc_set (vsf_rtc_t *rtc_ptr, const vsf_rtc_tm_t *rtc_tm)
	set rtc date time
vsf_err_t	vsf_rtc_get_time (vsf_rtc_t *rtc_ptr, vsf_rtc_time_t *second_ptr, vsf_rtc_time_t *millisecond_ptr)
	get rtc second and milli second of unix time
vsf_err_t	vsf_rtc_set_time (vsf_rtc_t *rtc_ptr, vsf_rtc_time_t second, vsf_rtc_time_t millisecond)
	set rtc date time
vsf_rtc_capability_t	vsf_rtc_capability (vsf_rtc_t *rtc_ptr)
	get the capability of rtc instance.
bool	vsf_rtc_tm_is_valid (const vsf_rtc_tm_t *rtc_tm)
bool	vsf_rtc_tm_is_epoch_time (const vsf_rtc_tm_t *rtc_tm)

Macro Definition Documentation

VSF_RTC_CFG_FUNCTION_RENAME

#define VSF_RTC_CFG_FUNCTION_RENAME   DISABLED

Function Documentation

vsf_rtc_init()

vsf_err_t vsf_rtc_init	(	vsf_rtc_t *	rtc_ptr,
		vsf_rtc_cfg_t *	cfg_ptr
	)

initialize a rtc instance.

Parameters

[in]	rtc_ptr	a pointer to structure vsf_rtc_t
[in]	cfg_ptr	a pointer to structure vsf_rtc_cfg_t

Returns

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

Note

It is not necessary to call vsf_rtc_fini() to deinitialization. vsf_rtc_init() should be called before any other rtc API except vsf_rtc_capability().

vsf_rtc_fini()

void vsf_rtc_fini

(

vsf_rtc_t *

rtc_ptr

)

finalize a rtc instance.

Parameters

[in]

rtc_ptr

a pointer to structure vsf_rtc_t

Returns

none

vsf_rtc_enable()

fsm_rt_t vsf_rtc_enable

(

vsf_rtc_t *

rtc_ptr

)

enable interrupt masks of rtc instance.

Parameters

[in]	rtc_ptr	a pointer to structure vsf_rtc_t
[in]	irq_mask	one or more value of enum vsf_rtc_irq_mask_t

Returns

none.

vsf_rtc_disable()

fsm_rt_t vsf_rtc_disable

(

vsf_rtc_t *

rtc_ptr

)

disable interrupt masks of rtc instance.

Parameters

[in]	rtc_ptr	a pointer to structure vsf_rtc_t
[in]	irq_mask	one or more value of enum vsf_rtc_irq_mask_t, vsf_rtc_irq_mask_t

Returns

none.

vsf_rtc_get()

vsf_err_t vsf_rtc_get	(	vsf_rtc_t *	rtc_ptr,
		vsf_rtc_tm_t *	rtc_tm
	)

get rtc date time

Parameters

[in]	rtc_ptr	a pointer to structure vsf_rtc_t
[in]	rtc_tm	a pointer to structure vsf_rtc_tm_t

Returns

vsf_err_t: VSF_ERR_NONE if rtc get data time was successful, or a negative error code

vsf_rtc_set()

vsf_err_t vsf_rtc_set	(	vsf_rtc_t *	rtc_ptr,
		const vsf_rtc_tm_t *	rtc_tm
	)

set rtc date time

Parameters

[in]	rtc_ptr	a pointer to structure vsf_rtc_t
[in]	rtc_tm	a pointer to structure vsf_rtc_tm_t

Returns

vsf_err_t: VSF_ERR_NONE if rtc set data time was successful, or a negative error code

vsf_rtc_get_time()

vsf_err_t vsf_rtc_get_time	(	vsf_rtc_t *	rtc_ptr,
		vsf_rtc_time_t *	second_ptr,
		vsf_rtc_time_t *	millisecond_ptr
	)

get rtc second and milli second of unix time

Parameters

[in]	rtc_ptr	a pointer to structure vsf_rtc_t
[in]	second_ptr	a pointer to type vsf_rtc_time_t
[in]	millisecond_ptr	a pointer to type vsf_rtc_time_t

Returns

vsf_err_t: VSF_ERR_NONE if rtc get second and millisecond successful, or a negative error code get rtc date time

Parameters

[in]	rtc_ptr	rtc instance
[out]	rtc	data time

vsf_rtc_set_time()

vsf_err_t vsf_rtc_set_time	(	vsf_rtc_t *	rtc_ptr,
		vsf_rtc_time_t	second,
		vsf_rtc_time_t	millisecond
	)

set rtc date time

Parameters

[in]	rtc_ptr	a pointer to structure vsf_rtc_t
[in]	rtc_tm	a pointer to structure vsf_rtc_tm_t

Returns

vsf_err_t: VSF_ERR_NONE if rtc set second and millisecond was successful, or a negative error code

vsf_rtc_capability()

vsf_rtc_capability_t vsf_rtc_capability

(

vsf_rtc_t *

rtc_ptr

)

get the capability of rtc instance.

Parameters

[in]

rtc_ptr

a pointer to structure vsf_rtc_t

Returns

vsf_rtc_capability_t: return all capability of current rtc vsf_rtc_capability_t

vsf_rtc_tm_is_valid()

bool vsf_rtc_tm_is_valid

(

const vsf_rtc_tm_t *

rtc_tm

)

vsf_rtc_tm_is_epoch_time()

bool vsf_rtc_tm_is_epoch_time

(

const vsf_rtc_tm_t *

rtc_tm

)