STM32L4xx_HAL_Driver  1.14.0
Data Structures | Typedefs | Enumerations
RTC Exported Types
STM32L4xx_HAL_Driver » RTC

Data Structures

struct  RTC_InitTypeDef
 RTC Configuration Structure definition. More...
 
struct  RTC_TimeTypeDef
 RTC Time structure definition. More...
 
struct  RTC_DateTypeDef
 RTC Date structure definition. More...
 
struct  RTC_AlarmTypeDef
 RTC Alarm structure definition. More...
 
struct  __RTC_HandleTypeDef
 RTC Handle Structure definition. More...
 

Typedefs

typedef struct __RTC_HandleTypeDef RTC_HandleTypeDef
 RTC Handle Structure definition. More...
 
typedef void(* pRTC_CallbackTypeDef) (RTC_HandleTypeDef *hrtc)
 HAL RTC Callback pointer definition. More...
 

Enumerations

enum  HAL_RTCStateTypeDef {
  HAL_RTC_STATE_RESET = 0x00U, HAL_RTC_STATE_READY = 0x01U, HAL_RTC_STATE_BUSY = 0x02U, HAL_RTC_STATE_TIMEOUT = 0x03U,
  HAL_RTC_STATE_ERROR = 0x04U
}
 HAL State structures definition. More...
 
enum  HAL_RTC_CallbackIDTypeDef {
  HAL_RTC_ALARM_A_EVENT_CB_ID = 0u, HAL_RTC_ALARM_B_EVENT_CB_ID = 1u, HAL_RTC_TIMESTAMP_EVENT_CB_ID = 2u, HAL_RTC_WAKEUPTIMER_EVENT_CB_ID = 3u,
  HAL_RTC_TAMPER1_EVENT_CB_ID = 4u, HAL_RTC_TAMPER2_EVENT_CB_ID = 5u, HAL_RTC_TAMPER3_EVENT_CB_ID = 6u, HAL_RTC_MSPINIT_CB_ID = 7u,
  HAL_RTC_MSPDEINIT_CB_ID = 8u
}
 HAL RTC Callback ID enumeration definition. More...
 

Detailed Description

Data Structure Documentation

◆ RTC_InitTypeDef

struct RTC_InitTypeDef

RTC Configuration Structure definition.

Definition at line 60 of file stm32l4xx_hal_rtc.h.

Data Fields
uint32_t AsynchPrediv

Specifies the RTC Asynchronous Predivider value. This parameter must be a number between Min_Data = 0x00 and Max_Data = 0x7F

uint32_t HourFormat

Specifies the RTC Hour Format. This parameter can be a value of RTC_Hour_Formats

uint32_t OutPut

Specifies which signal will be routed to the RTC output. This parameter can be a value of RTCEx Output Selection Definitions

uint32_t OutPutPolarity

Specifies the polarity of the output signal. This parameter can be a value of RTC Output Polarity Definitions

uint32_t OutPutPullUp

Specifies the RTC Output Pull-Up mode. This parameter can be a value of RTC Output Pull-Up ALARM OUT

uint32_t OutPutRemap

Specifies the remap for RTC output. This parameter can be a value of RTC Output ALARM OUT Remap

uint32_t OutPutType

Specifies the RTC Output Pin mode. This parameter can be a value of RTC Output Type ALARM OUT

uint32_t SynchPrediv

Specifies the RTC Synchronous Predivider value. This parameter must be a number between Min_Data = 0x00 and Max_Data = 0x7FFF

◆ RTC_TimeTypeDef

struct RTC_TimeTypeDef

RTC Time structure definition.

Definition at line 91 of file stm32l4xx_hal_rtc.h.

Data Fields
uint32_t DayLightSaving

Specifies RTC_DayLightSaveOperation: the value of hour adjustment. This parameter can be a value of RTC DayLightSaving Definitions

uint8_t Hours

Specifies the RTC Time Hour. This parameter must be a number between Min_Data = 0 and Max_Data = 12 if the RTC_HourFormat_12 is selected. This parameter must be a number between Min_Data = 0 and Max_Data = 23 if the RTC_HourFormat_24 is selected

uint8_t Minutes

Specifies the RTC Time Minutes. This parameter must be a number between Min_Data = 0 and Max_Data = 59

uint32_t SecondFraction

Specifies the range or granularity of Sub Second register content corresponding to Synchronous pre-scaler factor value (PREDIV_S) This parameter corresponds to a time unit range between [0-1] Second with [1 Sec / SecondFraction +1] granularity. This field will be used only by HAL_RTC_GetTime function

uint8_t Seconds

Specifies the RTC Time Seconds. This parameter must be a number between Min_Data = 0 and Max_Data = 59

uint32_t StoreOperation

Specifies RTC_StoreOperation value to be written in the BKP bit in CR register to store the operation. This parameter can be a value of RTC StoreOperation Definitions

uint32_t SubSeconds

Specifies the RTC_SSR RTC Sub Second register content. This parameter corresponds to a time unit range between [0-1] Second with [1 Sec / SecondFraction +1] granularity

uint8_t TimeFormat

Specifies the RTC AM/PM Time. This parameter can be a value of RTC AM PM Definitions

◆ RTC_DateTypeDef

struct RTC_DateTypeDef

RTC Date structure definition.

Definition at line 127 of file stm32l4xx_hal_rtc.h.

Data Fields
uint8_t Date

Specifies the RTC Date. This parameter must be a number between Min_Data = 1 and Max_Data = 31

uint8_t Month

Specifies the RTC Date Month (in BCD format). This parameter can be a value of RTC Month Date Definitions (in BCD format)

uint8_t WeekDay

Specifies the RTC Date WeekDay. This parameter can be a value of RTC WeekDay Definitions

uint8_t Year

Specifies the RTC Date Year. This parameter must be a number between Min_Data = 0 and Max_Data = 99

◆ RTC_AlarmTypeDef

struct RTC_AlarmTypeDef

RTC Alarm structure definition.

Definition at line 146 of file stm32l4xx_hal_rtc.h.

Data Fields
uint32_t Alarm

Specifies the alarm . This parameter can be a value of RTC Alarms Definitions

uint8_t AlarmDateWeekDay

Specifies the RTC Alarm Date/WeekDay. If the Alarm Date is selected, this parameter must be set to a value in the 1-31 range. If the Alarm WeekDay is selected, this parameter can be a value of RTC WeekDay Definitions

uint32_t AlarmDateWeekDaySel

Specifies the RTC Alarm is on Date or WeekDay. This parameter can be a value of RTC AlarmDateWeekDay Definitions

uint32_t AlarmMask

Specifies the RTC Alarm Masks. This parameter can be a value of RTC AlarmMask Definitions

uint32_t AlarmSubSecondMask

Specifies the RTC Alarm SubSeconds Masks. This parameter can be a value of RTC Alarm Sub Seconds Masks Definitions

RTC_TimeTypeDef AlarmTime

Specifies the RTC Alarm Time members

◆ __RTC_HandleTypeDef

struct __RTC_HandleTypeDef

RTC Handle Structure definition.

Definition at line 170 of file stm32l4xx_hal_rtc.h.

Data Fields

RTC_TypeDef * Instance
 
uint32_t TampOffset
 
RTC_InitTypeDef Init
 
HAL_LockTypeDef Lock
 
__IO HAL_RTCStateTypeDef State
 
void(* AlarmAEventCallback )(struct __RTC_HandleTypeDef *hrtc)
 
void(* AlarmBEventCallback )(struct __RTC_HandleTypeDef *hrtc)
 
void(* TimeStampEventCallback )(struct __RTC_HandleTypeDef *hrtc)
 
void(* WakeUpTimerEventCallback )(struct __RTC_HandleTypeDef *hrtc)
 
void(* Tamper1EventCallback )(struct __RTC_HandleTypeDef *hrtc)
 
void(* Tamper2EventCallback )(struct __RTC_HandleTypeDef *hrtc)
 
void(* Tamper3EventCallback )(struct __RTC_HandleTypeDef *hrtc)
 
void(* MspInitCallback )(struct __RTC_HandleTypeDef *hrtc)
 
void(* MspDeInitCallback )(struct __RTC_HandleTypeDef *hrtc)
 

Field Documentation

◆ AlarmAEventCallback

void(* __RTC_HandleTypeDef::AlarmAEventCallback) (struct __RTC_HandleTypeDef *hrtc)

RTC Alarm A Event callback

Definition at line 184 of file stm32l4xx_hal_rtc.h.

◆ AlarmBEventCallback

void(* __RTC_HandleTypeDef::AlarmBEventCallback) (struct __RTC_HandleTypeDef *hrtc)

RTC Alarm B Event callback

Definition at line 185 of file stm32l4xx_hal_rtc.h.

◆ Init

RTC_InitTypeDef __RTC_HandleTypeDef::Init

RTC required parameters

Definition at line 177 of file stm32l4xx_hal_rtc.h.

◆ Instance

RTC_TypeDef* __RTC_HandleTypeDef::Instance

Register base address

Definition at line 172 of file stm32l4xx_hal_rtc.h.

◆ Lock

HAL_LockTypeDef __RTC_HandleTypeDef::Lock

RTC locking object

Definition at line 179 of file stm32l4xx_hal_rtc.h.

◆ MspDeInitCallback

void(* __RTC_HandleTypeDef::MspDeInitCallback) (struct __RTC_HandleTypeDef *hrtc)

RTC Msp DeInit callback

Definition at line 196 of file stm32l4xx_hal_rtc.h.

◆ MspInitCallback

void(* __RTC_HandleTypeDef::MspInitCallback) (struct __RTC_HandleTypeDef *hrtc)

RTC Msp Init callback

Definition at line 195 of file stm32l4xx_hal_rtc.h.

◆ State

__IO HAL_RTCStateTypeDef __RTC_HandleTypeDef::State

Time communication state

Definition at line 181 of file stm32l4xx_hal_rtc.h.

◆ Tamper1EventCallback

void(* __RTC_HandleTypeDef::Tamper1EventCallback) (struct __RTC_HandleTypeDef *hrtc)

RTC Tamper 1 Event callback

Definition at line 189 of file stm32l4xx_hal_rtc.h.

◆ Tamper2EventCallback

void(* __RTC_HandleTypeDef::Tamper2EventCallback) (struct __RTC_HandleTypeDef *hrtc)

RTC Tamper 2 Event callback

Definition at line 191 of file stm32l4xx_hal_rtc.h.

◆ Tamper3EventCallback

void(* __RTC_HandleTypeDef::Tamper3EventCallback) (struct __RTC_HandleTypeDef *hrtc)

RTC Tamper 3 Event callback

Definition at line 193 of file stm32l4xx_hal_rtc.h.

◆ TampOffset

uint32_t __RTC_HandleTypeDef::TampOffset

Offset to TAMP instance

Definition at line 175 of file stm32l4xx_hal_rtc.h.

◆ TimeStampEventCallback

void(* __RTC_HandleTypeDef::TimeStampEventCallback) (struct __RTC_HandleTypeDef *hrtc)

RTC TimeStamp Event callback

Definition at line 186 of file stm32l4xx_hal_rtc.h.

◆ WakeUpTimerEventCallback

void(* __RTC_HandleTypeDef::WakeUpTimerEventCallback) (struct __RTC_HandleTypeDef *hrtc)

RTC WakeUpTimer Event callback

Definition at line 187 of file stm32l4xx_hal_rtc.h.

Typedef Documentation

◆ pRTC_CallbackTypeDef

typedef void(* pRTC_CallbackTypeDef) (RTC_HandleTypeDef *hrtc)

HAL RTC Callback pointer definition.

pointer to an RTC callback function

Definition at line 225 of file stm32l4xx_hal_rtc.h.

◆ RTC_HandleTypeDef

typedef struct __RTC_HandleTypeDef RTC_HandleTypeDef

RTC Handle Structure definition.

Enumeration Type Documentation

◆ HAL_RTC_CallbackIDTypeDef

enum HAL_RTC_CallbackIDTypeDef

HAL RTC Callback ID enumeration definition.

Enumerator
HAL_RTC_ALARM_A_EVENT_CB_ID 

RTC Alarm A Event Callback ID

HAL_RTC_ALARM_B_EVENT_CB_ID 

RTC Alarm B Event Callback ID

HAL_RTC_TIMESTAMP_EVENT_CB_ID 

RTC TimeStamp Event Callback ID

HAL_RTC_WAKEUPTIMER_EVENT_CB_ID 

RTC WakeUp Timer Event Callback ID

HAL_RTC_TAMPER1_EVENT_CB_ID 

RTC Tamper 1 Callback ID

HAL_RTC_TAMPER2_EVENT_CB_ID 

RTC Tamper 2 Callback ID

HAL_RTC_TAMPER3_EVENT_CB_ID 

RTC Tamper 3 Callback ID

HAL_RTC_MSPINIT_CB_ID 

RTC Msp Init callback ID

HAL_RTC_MSPDEINIT_CB_ID 

RTC Msp DeInit callback ID

Definition at line 205 of file stm32l4xx_hal_rtc.h.

206 {
207  HAL_RTC_ALARM_A_EVENT_CB_ID = 0u,
208  HAL_RTC_ALARM_B_EVENT_CB_ID = 1u,
209  HAL_RTC_TIMESTAMP_EVENT_CB_ID = 2u,
210  HAL_RTC_WAKEUPTIMER_EVENT_CB_ID = 3u,
211 #if defined(RTC_TAMPER1_SUPPORT)
212  HAL_RTC_TAMPER1_EVENT_CB_ID = 4u,
213 #endif /* RTC_TAMPER1_SUPPORT */
214  HAL_RTC_TAMPER2_EVENT_CB_ID = 5u,
215 #if defined(RTC_TAMPER3_SUPPORT)
216  HAL_RTC_TAMPER3_EVENT_CB_ID = 6u,
217 #endif /* RTC_TAMPER3_SUPPORT */
218  HAL_RTC_MSPINIT_CB_ID = 7u,
219  HAL_RTC_MSPDEINIT_CB_ID = 8u
220 } HAL_RTC_CallbackIDTypeDef;
HAL_RTC_TAMPER2_EVENT_CB_ID
Definition: stm32l4xx_hal_rtc.h:214
HAL_RTC_TAMPER1_EVENT_CB_ID
Definition: stm32l4xx_hal_rtc.h:212
HAL_RTC_MSPINIT_CB_ID
Definition: stm32l4xx_hal_rtc.h:218
HAL_RTC_ALARM_B_EVENT_CB_ID
Definition: stm32l4xx_hal_rtc.h:208
HAL_RTC_CallbackIDTypeDef
HAL_RTC_CallbackIDTypeDef
HAL RTC Callback ID enumeration definition.
Definition: stm32l4xx_hal_rtc.h:205
HAL_RTC_TIMESTAMP_EVENT_CB_ID
Definition: stm32l4xx_hal_rtc.h:209
HAL_RTC_ALARM_A_EVENT_CB_ID
Definition: stm32l4xx_hal_rtc.h:207
HAL_RTC_TAMPER3_EVENT_CB_ID
Definition: stm32l4xx_hal_rtc.h:216
HAL_RTC_WAKEUPTIMER_EVENT_CB_ID
Definition: stm32l4xx_hal_rtc.h:210
HAL_RTC_MSPDEINIT_CB_ID
Definition: stm32l4xx_hal_rtc.h:219

◆ HAL_RTCStateTypeDef

enum HAL_RTCStateTypeDef

HAL State structures definition.

Enumerator
HAL_RTC_STATE_RESET 

RTC not yet initialized or disabled

HAL_RTC_STATE_READY 

RTC initialized and ready for use

HAL_RTC_STATE_BUSY 

RTC process is ongoing

HAL_RTC_STATE_TIMEOUT 

RTC timeout state

HAL_RTC_STATE_ERROR 

RTC error state

Definition at line 47 of file stm32l4xx_hal_rtc.h.

48 {
49  HAL_RTC_STATE_RESET = 0x00U,
50  HAL_RTC_STATE_READY = 0x01U,
51  HAL_RTC_STATE_BUSY = 0x02U,
52  HAL_RTC_STATE_TIMEOUT = 0x03U,
53  HAL_RTC_STATE_ERROR = 0x04U
55 } HAL_RTCStateTypeDef;
HAL_RTC_STATE_ERROR
Definition: stm32l4xx_hal_rtc.h:53
HAL_RTC_STATE_READY
Definition: stm32l4xx_hal_rtc.h:50
HAL_RTC_STATE_TIMEOUT
Definition: stm32l4xx_hal_rtc.h:52
HAL_RTCStateTypeDef
HAL_RTCStateTypeDef
HAL State structures definition.
Definition: stm32l4xx_hal_rtc.h:47
HAL_RTC_STATE_RESET
Definition: stm32l4xx_hal_rtc.h:49
HAL_RTC_STATE_BUSY
Definition: stm32l4xx_hal_rtc.h:51