RTC Configuration Driver for STM32F4 Devices. More...

#include "common/phal_F4/phal_F4.h"

Include dependency graph for rtc.h:

This graph shows which files directly or indirectly include this file:

Classes
struct	RTC_date_t

struct	RTC_time_t

struct	RTC_timestamp_t

Macros
#define	RTC_ASYNC_PRESCAL (255U)

#define	RTC_SYNC_PRESCAL (124U)

#define	RTC_CONV_TO_BCD(v)

Enumerations
enum	RTC_MONTH_t { RTC_MONTH_UNKNOWN = 0x0 , RTC_MONTH_JANUARY = 0x1 , RTC_MONTH_FEBRUARY = 0x2 , RTC_MONTH_MARCH = 0x3 , RTC_MONTH_APRIL = 0x4 , RTC_MONTH_MAY = 0x5 , RTC_MONTH_JUNE = 0x6 , RTC_MONTH_JULY = 0x7 , RTC_MONTH_AUGUST = 0x8 , RTC_MONTH_SEPTEMBER = 0x9 , RTC_MONTH_OCTOBER = 0x10 , RTC_MONTH_NOVEMBER = 0x11 , RTC_MONTH_DECEMBER = 0x12 }

enum	RTC_WEEKDAY_t { RTC_WEEKDAY_UNKNOWN = 0x0 , RTC_WEEKDAY_MONDAY = 0x1 , RTC_WEEKDAY_TUESDAY = 0x2 , RTC_WEEKDAY_WEDNESDAY = 0x3 , RTC_WEEKDAY_THURSDAY = 0x4 , RTC_WEEKDAY_FRIDAY = 0x5 , RTC_WEEKDAY_SATURDAY = 0x6 , RTC_WEEKDAY_SUNDAY = 0x7 }

enum	RTC_TIME_FORMAT_t { RTC_FORMAT_24_HOUR = 0U , RTC_FORMAT_AM_PM }

Functions
bool	PHAL_getTimeRTC (RTC_timestamp_t *currentTimestamp)

uint8_t	PHAL_configureRTC (RTC_timestamp_t *initial_time, bool force_time)

Detailed Description

RTC Configuration Driver for STM32F4 Devices.

Author: Chris McGalliard (cmcga.nosp@m.lli@.nosp@m.purdu.nosp@m.e.ed.nosp@m.u)

Version: 0.1

Date: 2024-01-12

Copyright: Copyright (c) 2024

Macro Definition Documentation

◆ RTC_ASYNC_PRESCAL

#define RTC_ASYNC_PRESCAL (255U)

◆ RTC_CONV_TO_BCD

#define RTC_CONV_TO_BCD ( v )

Value:

(((v / 10) << 4) | (v % 10))

◆ RTC_SYNC_PRESCAL

#define RTC_SYNC_PRESCAL (124U)

Enumeration Type Documentation

◆ RTC_MONTH_t

enum RTC_MONTH_t

Enumerator
RTC_MONTH_UNKNOWN
RTC_MONTH_JANUARY
RTC_MONTH_FEBRUARY
RTC_MONTH_MARCH
RTC_MONTH_APRIL
RTC_MONTH_MAY
RTC_MONTH_JUNE
RTC_MONTH_JULY
RTC_MONTH_AUGUST
RTC_MONTH_SEPTEMBER
RTC_MONTH_OCTOBER
RTC_MONTH_NOVEMBER
RTC_MONTH_DECEMBER

◆ RTC_TIME_FORMAT_t

enum RTC_TIME_FORMAT_t

Enumerator
RTC_FORMAT_24_HOUR
RTC_FORMAT_AM_PM

◆ RTC_WEEKDAY_t

enum RTC_WEEKDAY_t

Enumerator
RTC_WEEKDAY_UNKNOWN
RTC_WEEKDAY_MONDAY
RTC_WEEKDAY_TUESDAY
RTC_WEEKDAY_WEDNESDAY
RTC_WEEKDAY_THURSDAY
RTC_WEEKDAY_FRIDAY
RTC_WEEKDAY_SATURDAY
RTC_WEEKDAY_SUNDAY

Function Documentation

◆ PHAL_configureRTC()

uint8_t PHAL_configureRTC	(	RTC_timestamp_t *	initial_time,
		bool	force_time )

Here is the caller graph for this function:

◆ PHAL_getTimeRTC()

bool PHAL_getTimeRTC ( RTC_timestamp_t * currentTimestamp )