SystemPeripherals_RTC.h

Go to the documentation of this file.

// (c) IMT - Information Management Technology AG, CH-9470 Buchs, www.imt.ch.
 
#ifndef SYSTEMPERIPHERALS_RTC_H
#define SYSTEMPERIPHERALS_RTC_H
 
#include <Imt.Base.Core.Platform/Platform.h>
 
#include "SystemMemoryMap.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
typedef struct {
    uint32_t volatile CRH;
    uint32_t volatile CRL;
    uint32_t volatile PRLH;
    uint32_t volatile PRLL;
    uint32_t volatile DIVH;
    uint32_t volatile DIVL;
    uint32_t volatile CNTH;
    uint32_t volatile CNTL;
    uint32_t volatile ALRH;
    uint32_t volatile ALRL;
} RTC_ModuleRegisters;
 
#define RTC ((RTC_ModuleRegisters*)RTC_BASE)
 
typedef struct {
    uint32_t RESERVED0;
    uint32_t volatile DR1;
    uint32_t volatile DR2;
    uint32_t volatile DR3;
    uint32_t volatile DR4;
    uint32_t volatile DR5;
    uint32_t volatile DR6;
    uint32_t volatile DR7;
    uint32_t volatile DR8;
    uint32_t volatile DR9;
    uint32_t volatile DR10;
    uint32_t volatile RTCCR;
    uint32_t volatile CR;
    uint32_t volatile CSR;
    uint32_t RESERVED13[2];
    uint32_t volatile DR11;
    uint32_t volatile DR12;
    uint32_t volatile DR13;
    uint32_t volatile DR14;
    uint32_t volatile DR15;
    uint32_t volatile DR16;
    uint32_t volatile DR17;
    uint32_t volatile DR18;
    uint32_t volatile DR19;
    uint32_t volatile DR20;
    uint32_t volatile DR21;
    uint32_t volatile DR22;
    uint32_t volatile DR23;
    uint32_t volatile DR24;
    uint32_t volatile DR25;
    uint32_t volatile DR26;
    uint32_t volatile DR27;
    uint32_t volatile DR28;
    uint32_t volatile DR29;
    uint32_t volatile DR30;
    uint32_t volatile DR31;
    uint32_t volatile DR32;
    uint32_t volatile DR33;
    uint32_t volatile DR34;
    uint32_t volatile DR35;
    uint32_t volatile DR36;
    uint32_t volatile DR37;
    uint32_t volatile DR38;
    uint32_t volatile DR39;
    uint32_t volatile DR40;
    uint32_t volatile DR41;
    uint32_t volatile DR42;
} BKP_ModuleRegisters;
 
#define BKP ((BKP_ModuleRegisters*)BKP_BASE)
 
// Bit definition for BKP_RTCCR register
#define BKP_RTCCR_CCO ((uint32_t)0x00000080)  // Calibration Clock Output
#define BKP_RTCCR_ASOE ((uint32_t)0x00000100) // Alarm or Second Output Enable
#define BKP_RTCCR_ASOS ((uint32_t)0x00000200) // Alarm or Second Output Selection
 
#define RTC_AUTO_1_SECOND 0xFFFFFFFFU
 
typedef struct {
    uint8_t Hours;   // Specifies the RTC Time Hour. This parameter must be a number between Min_Data = 0 and Max_Data = 23
    uint8_t Minutes; // Specifies the RTC Time Minutes. This parameter must be a number between Min_Data = 0 and Max_Data = 59
    uint8_t Seconds; // Specifies the RTC Time Seconds. This parameter must be a number between Min_Data = 0 and Max_Data = 59
} RTC_Time;
 
typedef enum {
    RTC_STATE_RESET = 0x00U,   // RTC not yet initialized or disabled
    RTC_STATE_READY = 0x01U,   // RTC initialized and ready for use
    RTC_STATE_BUSY = 0x02U,    // RTC process is ongoing
    RTC_STATE_TIMEOUT = 0x03U, // RTC timeout state
    RTC_STATE_ERROR = 0x04U    // RTC error state
} RTC_RTCState;
 
typedef enum {
    RTC_OUTPUTSOURCE_NONE = 0x00000000U,
    RTC_OUTPUTSOURCE_CALIBCLOCK = BKP_RTCCR_CCO,
    RTC_OUTPUTSOURCE_ALARM = BKP_RTCCR_ASOE,
    RTC_OUTPUTSOURCE_SECOND = (BKP_RTCCR_ASOS | BKP_RTCCR_ASOE)
} RTC_OutputSource;
 
typedef struct {
    uint32_t AsynchPrediv;   // Specifies the RTC Asynchronous Predivider value.
                             // This parameter must be a number between Min_Data = 0x00 and Max_Data = 0xFFFFF  or RTC_AUTO_1_SECOND
                             // If RTC_AUTO_1_SECOND is selected, AsynchPrediv will be set automatically to get 1sec timebase
    RTC_OutputSource OutPut; // Specifies which signal will be routed to the RTC Tamper pin.
                             // This parameter can be a value of @ref RTC_output_source_to_output_on_the_Tamper_pin
} RTC_Config;
 
typedef enum {
    RTC_MONTH_JANUARY = ((uint8_t)0x01),
    RTC_MONTH_FEBRUARY = ((uint8_t)0x02),
    RTC_MONTH_MARCH = ((uint8_t)0x03),
    RTC_MONTH_APRIL = ((uint8_t)0x04),
    RTC_MONTH_MAY = ((uint8_t)0x05),
    RTC_MONTH_JUNE = ((uint8_t)0x06),
    RTC_MONTH_JULY = ((uint8_t)0x07),
    RTC_MONTH_AUGUST = ((uint8_t)0x08),
    RTC_MONTH_SEPTEMBER = ((uint8_t)0x09),
    RTC_MONTH_OCTOBER = ((uint8_t)0x10),
    RTC_MONTH_NOVEMBER = ((uint8_t)0x11),
    RTC_MONTH_DECEMBER = ((uint8_t)0x12)
} RTC_Month;
 
typedef enum {
    RTC_WEEKDAY_MONDAY = ((uint8_t)0x01),
    RTC_WEEKDAY_TUESDAY = ((uint8_t)0x02),
    RTC_WEEKDAY_WEDNESDAY = ((uint8_t)0x03),
    RTC_WEEKDAY_THURSDAY = ((uint8_t)0x04),
    RTC_WEEKDAY_FRIDAY = ((uint8_t)0x05),
    RTC_WEEKDAY_SATURDAY = ((uint8_t)0x06),
    RTC_WEEKDAY_SUNDAY = ((uint8_t)0x07)
} RTC_Weekday;
 
typedef struct {
    RTC_Weekday WeekDay; // Specifies the RTC Date WeekDay (not necessary for HAL_RTC_SetDate).
    uint8_t Month;       // Specifies the RTC Date Month (in BCD format).
    uint8_t Day;         // Specifies the RTC Date Day.
    uint8_t Year;        // Specifies the RTC Date Year.
} RTC_Date;
 
typedef enum {
    RTC_UNLOCKED = 0x00U,
    RTC_LOCKED = 0x01U
} RTC_Lock;
 
typedef struct {
    RTC_ModuleRegisters* Instance; // Register base address
    RTC_Config Init;               // RTC required parameters
    RTC_Date DateToUpdate;         // Current date set by user and updated automatically
    RTC_Lock Lock;                 // RTC locking object
    RTC_RTCState volatile State;   // Time communication state
} RTC_Handle;
 
typedef enum {
    RTC_OK = 0,
    RTC_ERROR,
    RTC_BUSY,
    RTC_TIMEOUT
} RTC_Status;
 
typedef enum {
    RTC_FORMAT_BIN = 0x000000000U,
    RTC_FORMAT_BCD = 0x000000001U
} RTC_Format;
 
RTC_Status RTC_Init(RTC_Handle* hrtc);
 
RTC_Status RTC_DeInit(RTC_Handle* hrtc);
 
RTC_Status RTC_SetTime(RTC_Handle* hrtc, RTC_Time* sTime, RTC_Format Format);
 
RTC_Status RTC_GetTime(RTC_Handle* hrtc, RTC_Time* sTime, RTC_Format Format);
 
RTC_Status RTC_SetDate(RTC_Handle* hrtc, RTC_Date* sDate, RTC_Format Format);
 
RTC_Status RTC_GetDate(RTC_Handle* hrtc, RTC_Date* sDate, RTC_Format Format);
 
void RTC_StoreDateIntoBkpReg(RTC_Date const* dateRtc);
 
void RTC_LoadDateFromBkpReg(RTC_Date* dateRtc);
 
#ifdef __cplusplus
}
#endif
 
#endif /* SYSTEMPERIPHERALS_RTC_H */