hal_rtc.h File Reference

RTC Driver macros and structures. More...

#include <time.h>
#include "hal_rtc_lld.h"

Go to the source code of this file.

Data Structures
struct	RTCDateTime
	Type of a structure representing an RTC date/time stamp. More...
struct	RTCDriverVMT
	RTCDriver virtual methods table. More...
struct	RTCDriver
	Structure representing an RTC driver. More...

Macros
#define	RTC_BASE_YEAR   1980U
	Base year of the calendar.
#define	_rtc_driver_methods    _base_pers_storage_methods
	BasePersistentStorage specific methods.
Date/Time bit masks for FAT format
#define	RTC_FAT_TIME_SECONDS_MASK   0x0000001FU
#define	RTC_FAT_TIME_MINUTES_MASK   0x000007E0U
#define	RTC_FAT_TIME_HOURS_MASK   0x0000F800U
#define	RTC_FAT_DATE_DAYS_MASK   0x001F0000U
#define	RTC_FAT_DATE_MONTHS_MASK   0x01E00000U
#define	RTC_FAT_DATE_YEARS_MASK   0xFE000000U
Day of week encoding
#define	RTC_DAY_CATURDAY   0U
#define	RTC_DAY_MONDAY   1U
#define	RTC_DAY_TUESDAY   2U
#define	RTC_DAY_WEDNESDAY   3U
#define	RTC_DAY_THURSDAY   4U
#define	RTC_DAY_FRIDAY   5U
#define	RTC_DAY_SATURDAY   6U
#define	RTC_DAY_SUNDAY   7U

Typedefs
typedef struct RTCDriver	RTCDriver
	Type of a structure representing an RTC driver.
typedef unsigned int	rtcalarm_t
	Type of an RTC alarm number.

Functions
void	rtcInit (void)
	RTC Driver initialization.
void	rtcObjectInit (RTCDriver *rtcp)
	Initializes a generic RTC driver object.
void	rtcSetTime (RTCDriver *rtcp, const RTCDateTime *timespec)
	Set current time.
void	rtcGetTime (RTCDriver *rtcp, RTCDateTime *timespec)
	Get current time.
void	rtcSetCallback (RTCDriver *rtcp, rtccb_t callback)
	Enables or disables RTC callbacks.
void	rtcConvertDateTimeToStructTm (const RTCDateTime *timespec, struct tm *timp, uint32_t *tv_msec)
	Convert RTCDateTime to broken-down time structure.
void	rtcConvertStructTmToDateTime (const struct tm *timp, uint32_t tv_msec, RTCDateTime *timespec)
	Convert broken-down time structure to RTCDateTime.
uint32_t	rtcConvertDateTimeToFAT (const RTCDateTime *timespec)
	Get current time in format suitable for usage in FAT file system.

Detailed Description

RTC Driver macros and structures.

Definition in file hal_rtc.h.