|
VSF Documented
|
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 a RTC instance. | |
| fsm_rt_t | vsf_rtc_disable (vsf_rtc_t *rtc_ptr) |
| Disable a RTC instance. | |
| vsf_err_t | vsf_rtc_get (vsf_rtc_t *rtc_ptr, vsf_rtc_tm_t *rtc_tm) |
| Get RTC date and time. | |
| vsf_err_t | vsf_rtc_set (vsf_rtc_t *rtc_ptr, const vsf_rtc_tm_t *rtc_tm) |
| Set RTC date and 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 time in seconds and milliseconds. | |
| vsf_err_t | vsf_rtc_set_time (vsf_rtc_t *rtc_ptr, vsf_rtc_time_t second, vsf_rtc_time_t millisecond) |
| Set RTC time in seconds and milliseconds. | |
| vsf_rtc_capability_t | vsf_rtc_capability (vsf_rtc_t *rtc_ptr) |
| Get the capability of RTC instance. | |
| vsf_err_t | vsf_rtc_get_configuration (vsf_rtc_t *rtc_ptr, vsf_rtc_cfg_t *cfg_ptr) |
| Get the current configuration of an 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) |
| #define VSF_RTC_CFG_FUNCTION_RENAME DISABLED |
| vsf_err_t vsf_rtc_init | ( | vsf_rtc_t * | rtc_ptr, |
| vsf_rtc_cfg_t * | cfg_ptr | ||
| ) |
Initialize a RTC instance.
| [in] | rtc_ptr | Pointer to structure vsf_rtc_t |
| [in] | cfg_ptr | Pointer to configuration structure vsf_rtc_cfg_t |
| void vsf_rtc_fini | ( | vsf_rtc_t * | rtc_ptr | ) |
Enable a RTC instance.
| [in] | rtc_ptr | Pointer to structure vsf_rtc_t |
Disable a RTC instance.
| [in] | rtc_ptr | Pointer to structure vsf_rtc_t |
| vsf_err_t vsf_rtc_get | ( | vsf_rtc_t * | rtc_ptr, |
| vsf_rtc_tm_t * | rtc_tm | ||
| ) |
Get RTC date and time.
| [in] | rtc_ptr | Pointer to structure vsf_rtc_t |
| [out] | rtc_tm | Date and time (year, month, day, hour, minute, second, etc.) |
| vsf_err_t vsf_rtc_set | ( | vsf_rtc_t * | rtc_ptr, |
| const vsf_rtc_tm_t * | rtc_tm | ||
| ) |
Set RTC date and time.
| [in] | rtc_ptr | Pointer to structure vsf_rtc_t |
| [in] | rtc_tm | Date and time (year, month, day, hour, minute, second, etc.) |
| 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 time in seconds and milliseconds.
| [in] | rtc_ptr | Pointer to structure vsf_rtc_t |
| [out] | second_ptr | Seconds |
| [out] | millisecond_ptr | Milliseconds |
| vsf_err_t vsf_rtc_set_time | ( | vsf_rtc_t * | rtc_ptr, |
| vsf_rtc_time_t | seconds, | ||
| vsf_rtc_time_t | milliseconds | ||
| ) |
Set RTC time in seconds and milliseconds.
| [in] | rtc_ptr | Pointer to structure vsf_rtc_t |
| [in] | seconds | Seconds |
| [in] | milliseconds | Milliseconds |
| vsf_rtc_capability_t vsf_rtc_capability | ( | vsf_rtc_t * | rtc_ptr | ) |
Get the capability of RTC instance.
| [in] | rtc_ptr | Pointer to structure vsf_rtc_t |
| vsf_err_t vsf_rtc_get_configuration | ( | vsf_rtc_t * | rtc_ptr, |
| vsf_rtc_cfg_t * | cfg_ptr | ||
| ) |
Get the current configuration of an RTC instance.
| [in] | rtc_ptr | pointer to structure vsf_rtc_t |
| [out] | cfg_ptr | pointer to configuration structure vsf_rtc_cfg_t to store the current configuration |
| 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 | ) |