STM32F4xx_HAL_Driver  1.8.3
+ Collaboration diagram for Configuration:

Functions

__STATIC_INLINE void LL_RTC_SetHourFormat (RTC_TypeDef *RTCx, uint32_t HourFormat)
 Set Hours format (24 hour/day or AM/PM hour format) More...
 
__STATIC_INLINE uint32_t LL_RTC_GetHourFormat (RTC_TypeDef *RTCx)
 Get Hours format (24 hour/day or AM/PM hour format) @rmtoll CR FMT LL_RTC_GetHourFormat. More...
 
__STATIC_INLINE void LL_RTC_SetAlarmOutEvent (RTC_TypeDef *RTCx, uint32_t AlarmOutput)
 Select the flag to be routed to RTC_ALARM output. More...
 
__STATIC_INLINE uint32_t LL_RTC_GetAlarmOutEvent (RTC_TypeDef *RTCx)
 Get the flag to be routed to RTC_ALARM output @rmtoll CR OSEL LL_RTC_GetAlarmOutEvent. More...
 
__STATIC_INLINE void LL_RTC_SetAlarmOutputType (RTC_TypeDef *RTCx, uint32_t Output)
 Set RTC_ALARM output type (ALARM in push-pull or open-drain output) More...
 
__STATIC_INLINE uint32_t LL_RTC_GetAlarmOutputType (RTC_TypeDef *RTCx)
 Get RTC_ALARM output type (ALARM in push-pull or open-drain output) More...
 
__STATIC_INLINE void LL_RTC_EnableInitMode (RTC_TypeDef *RTCx)
 Enable initialization mode. More...
 
__STATIC_INLINE void LL_RTC_DisableInitMode (RTC_TypeDef *RTCx)
 Disable initialization mode (Free running mode) @rmtoll ISR INIT LL_RTC_DisableInitMode. More...
 
__STATIC_INLINE void LL_RTC_SetOutputPolarity (RTC_TypeDef *RTCx, uint32_t Polarity)
 Set Output polarity (pin is low when ALRAF/ALRBF/WUTF is asserted) More...
 
__STATIC_INLINE uint32_t LL_RTC_GetOutputPolarity (RTC_TypeDef *RTCx)
 Get Output polarity @rmtoll CR POL LL_RTC_GetOutputPolarity. More...
 
__STATIC_INLINE void LL_RTC_EnableShadowRegBypass (RTC_TypeDef *RTCx)
 Enable Bypass the shadow registers. More...
 
__STATIC_INLINE void LL_RTC_DisableShadowRegBypass (RTC_TypeDef *RTCx)
 Disable Bypass the shadow registers @rmtoll CR BYPSHAD LL_RTC_DisableShadowRegBypass. More...
 
__STATIC_INLINE uint32_t LL_RTC_IsShadowRegBypassEnabled (RTC_TypeDef *RTCx)
 Check if Shadow registers bypass is enabled or not. @rmtoll CR BYPSHAD LL_RTC_IsShadowRegBypassEnabled. More...
 
__STATIC_INLINE void LL_RTC_EnableRefClock (RTC_TypeDef *RTCx)
 Enable RTC_REFIN reference clock detection (50 or 60 Hz) More...
 
__STATIC_INLINE void LL_RTC_DisableRefClock (RTC_TypeDef *RTCx)
 Disable RTC_REFIN reference clock detection (50 or 60 Hz) More...
 
__STATIC_INLINE void LL_RTC_SetAsynchPrescaler (RTC_TypeDef *RTCx, uint32_t AsynchPrescaler)
 Set Asynchronous prescaler factor @rmtoll PRER PREDIV_A LL_RTC_SetAsynchPrescaler. More...
 
__STATIC_INLINE void LL_RTC_SetSynchPrescaler (RTC_TypeDef *RTCx, uint32_t SynchPrescaler)
 Set Synchronous prescaler factor @rmtoll PRER PREDIV_S LL_RTC_SetSynchPrescaler. More...
 
__STATIC_INLINE uint32_t LL_RTC_GetAsynchPrescaler (RTC_TypeDef *RTCx)
 Get Asynchronous prescaler factor @rmtoll PRER PREDIV_A LL_RTC_GetAsynchPrescaler. More...
 
__STATIC_INLINE uint32_t LL_RTC_GetSynchPrescaler (RTC_TypeDef *RTCx)
 Get Synchronous prescaler factor @rmtoll PRER PREDIV_S LL_RTC_GetSynchPrescaler. More...
 
__STATIC_INLINE void LL_RTC_EnableWriteProtection (RTC_TypeDef *RTCx)
 Enable the write protection for RTC registers. @rmtoll WPR KEY LL_RTC_EnableWriteProtection. More...
 
__STATIC_INLINE void LL_RTC_DisableWriteProtection (RTC_TypeDef *RTCx)
 Disable the write protection for RTC registers. @rmtoll WPR KEY LL_RTC_DisableWriteProtection. More...
 

Detailed Description

Function Documentation

◆ LL_RTC_DisableInitMode()

__STATIC_INLINE void LL_RTC_DisableInitMode ( RTC_TypeDef *  RTCx)

Disable initialization mode (Free running mode) @rmtoll ISR INIT LL_RTC_DisableInitMode.

Parameters
RTCxRTC Instance
Return values
None

Definition at line 844 of file stm32f4xx_ll_rtc.h.

◆ LL_RTC_DisableRefClock()

__STATIC_INLINE void LL_RTC_DisableRefClock ( RTC_TypeDef *  RTCx)

Disable RTC_REFIN reference clock detection (50 or 60 Hz)

Note
Bit is write-protected. LL_RTC_DisableWriteProtection function should be called before.
It can be written in initialization mode only (LL_RTC_EnableInitMode function) @rmtoll CR REFCKON LL_RTC_DisableRefClock
Parameters
RTCxRTC Instance
Return values
None

Definition at line 933 of file stm32f4xx_ll_rtc.h.

◆ LL_RTC_DisableShadowRegBypass()

__STATIC_INLINE void LL_RTC_DisableShadowRegBypass ( RTC_TypeDef *  RTCx)

Disable Bypass the shadow registers @rmtoll CR BYPSHAD LL_RTC_DisableShadowRegBypass.

Parameters
RTCxRTC Instance
Return values
None

Definition at line 896 of file stm32f4xx_ll_rtc.h.

◆ LL_RTC_DisableWriteProtection()

__STATIC_INLINE void LL_RTC_DisableWriteProtection ( RTC_TypeDef *  RTCx)

Disable the write protection for RTC registers. @rmtoll WPR KEY LL_RTC_DisableWriteProtection.

Parameters
RTCxRTC Instance
Return values
None

Definition at line 1001 of file stm32f4xx_ll_rtc.h.

◆ LL_RTC_EnableInitMode()

__STATIC_INLINE void LL_RTC_EnableInitMode ( RTC_TypeDef *  RTCx)

Enable initialization mode.

Note
Initialization mode is used to program time and date register (RTC_TR and RTC_DR) and prescaler register (RTC_PRER). Counters are stopped and start counting from the new value when INIT is reset. @rmtoll ISR INIT LL_RTC_EnableInitMode
Parameters
RTCxRTC Instance
Return values
None

Definition at line 832 of file stm32f4xx_ll_rtc.h.

◆ LL_RTC_EnableRefClock()

__STATIC_INLINE void LL_RTC_EnableRefClock ( RTC_TypeDef *  RTCx)

Enable RTC_REFIN reference clock detection (50 or 60 Hz)

Note
Bit is write-protected. LL_RTC_DisableWriteProtection function should be called before.
It can be written in initialization mode only (LL_RTC_EnableInitMode function) @rmtoll CR REFCKON LL_RTC_EnableRefClock
Parameters
RTCxRTC Instance
Return values
None

Definition at line 920 of file stm32f4xx_ll_rtc.h.

◆ LL_RTC_EnableShadowRegBypass()

__STATIC_INLINE void LL_RTC_EnableShadowRegBypass ( RTC_TypeDef *  RTCx)

Enable Bypass the shadow registers.

Note
Bit is write-protected. LL_RTC_DisableWriteProtection function should be called before. @rmtoll CR BYPSHAD LL_RTC_EnableShadowRegBypass
Parameters
RTCxRTC Instance
Return values
None

Definition at line 885 of file stm32f4xx_ll_rtc.h.

◆ LL_RTC_EnableWriteProtection()

__STATIC_INLINE void LL_RTC_EnableWriteProtection ( RTC_TypeDef *  RTCx)

Enable the write protection for RTC registers. @rmtoll WPR KEY LL_RTC_EnableWriteProtection.

Parameters
RTCxRTC Instance
Return values
None

Definition at line 990 of file stm32f4xx_ll_rtc.h.

◆ LL_RTC_GetAlarmOutEvent()

__STATIC_INLINE uint32_t LL_RTC_GetAlarmOutEvent ( RTC_TypeDef *  RTCx)

Get the flag to be routed to RTC_ALARM output @rmtoll CR OSEL LL_RTC_GetAlarmOutEvent.

Parameters
RTCxRTC Instance
Return values
Returnedvalue can be one of the following values:
  • LL_RTC_ALARMOUT_DISABLE
  • LL_RTC_ALARMOUT_ALMA
  • LL_RTC_ALARMOUT_ALMB
  • LL_RTC_ALARMOUT_WAKEUP

Definition at line 789 of file stm32f4xx_ll_rtc.h.

◆ LL_RTC_GetAlarmOutputType()

__STATIC_INLINE uint32_t LL_RTC_GetAlarmOutputType ( RTC_TypeDef *  RTCx)

Get RTC_ALARM output type (ALARM in push-pull or open-drain output)

Note
used only when RTC_ALARM is mapped on PC13 @rmtoll TAFCR ALARMOUTTYPE LL_RTC_GetAlarmOutputType
Parameters
RTCxRTC Instance
Return values
Returnedvalue can be one of the following values:
  • LL_RTC_ALARM_OUTPUTTYPE_OPENDRAIN
  • LL_RTC_ALARM_OUTPUTTYPE_PUSHPULL

Definition at line 818 of file stm32f4xx_ll_rtc.h.

◆ LL_RTC_GetAsynchPrescaler()

__STATIC_INLINE uint32_t LL_RTC_GetAsynchPrescaler ( RTC_TypeDef *  RTCx)

Get Asynchronous prescaler factor @rmtoll PRER PREDIV_A LL_RTC_GetAsynchPrescaler.

Parameters
RTCxRTC Instance
Return values
Valuebetween Min_Data = 0 and Max_Data = 0x7F

Definition at line 968 of file stm32f4xx_ll_rtc.h.

◆ LL_RTC_GetHourFormat()

__STATIC_INLINE uint32_t LL_RTC_GetHourFormat ( RTC_TypeDef *  RTCx)

Get Hours format (24 hour/day or AM/PM hour format) @rmtoll CR FMT LL_RTC_GetHourFormat.

Parameters
RTCxRTC Instance
Return values
Returnedvalue can be one of the following values:
  • LL_RTC_HOURFORMAT_24HOUR
  • LL_RTC_HOURFORMAT_AMPM

Definition at line 757 of file stm32f4xx_ll_rtc.h.

◆ LL_RTC_GetOutputPolarity()

__STATIC_INLINE uint32_t LL_RTC_GetOutputPolarity ( RTC_TypeDef *  RTCx)

Get Output polarity @rmtoll CR POL LL_RTC_GetOutputPolarity.

Parameters
RTCxRTC Instance
Return values
Returnedvalue can be one of the following values:
  • LL_RTC_OUTPUTPOLARITY_PIN_HIGH
  • LL_RTC_OUTPUTPOLARITY_PIN_LOW

Definition at line 873 of file stm32f4xx_ll_rtc.h.

◆ LL_RTC_GetSynchPrescaler()

__STATIC_INLINE uint32_t LL_RTC_GetSynchPrescaler ( RTC_TypeDef *  RTCx)

Get Synchronous prescaler factor @rmtoll PRER PREDIV_S LL_RTC_GetSynchPrescaler.

Parameters
RTCxRTC Instance
Return values
Valuebetween Min_Data = 0 and Max_Data = 0x7FFF

Definition at line 979 of file stm32f4xx_ll_rtc.h.

◆ LL_RTC_IsShadowRegBypassEnabled()

__STATIC_INLINE uint32_t LL_RTC_IsShadowRegBypassEnabled ( RTC_TypeDef *  RTCx)

Check if Shadow registers bypass is enabled or not. @rmtoll CR BYPSHAD LL_RTC_IsShadowRegBypassEnabled.

Parameters
RTCxRTC Instance
Return values
Stateof bit (1 or 0).

Definition at line 907 of file stm32f4xx_ll_rtc.h.

◆ LL_RTC_SetAlarmOutEvent()

__STATIC_INLINE void LL_RTC_SetAlarmOutEvent ( RTC_TypeDef *  RTCx,
uint32_t  AlarmOutput 
)

Select the flag to be routed to RTC_ALARM output.

Note
Bit is write-protected. LL_RTC_DisableWriteProtection function should be called before. @rmtoll CR OSEL LL_RTC_SetAlarmOutEvent
Parameters
RTCxRTC Instance
AlarmOutputThis parameter can be one of the following values:
  • LL_RTC_ALARMOUT_DISABLE
  • LL_RTC_ALARMOUT_ALMA
  • LL_RTC_ALARMOUT_ALMB
  • LL_RTC_ALARMOUT_WAKEUP
Return values
None

Definition at line 774 of file stm32f4xx_ll_rtc.h.

◆ LL_RTC_SetAlarmOutputType()

__STATIC_INLINE void LL_RTC_SetAlarmOutputType ( RTC_TypeDef *  RTCx,
uint32_t  Output 
)

Set RTC_ALARM output type (ALARM in push-pull or open-drain output)

Note
Used only when RTC_ALARM is mapped on PC13 @rmtoll TAFCR ALARMOUTTYPE LL_RTC_SetAlarmOutputType
Parameters
RTCxRTC Instance
OutputThis parameter can be one of the following values:
  • LL_RTC_ALARM_OUTPUTTYPE_OPENDRAIN
  • LL_RTC_ALARM_OUTPUTTYPE_PUSHPULL
Return values
None

Definition at line 804 of file stm32f4xx_ll_rtc.h.

◆ LL_RTC_SetAsynchPrescaler()

__STATIC_INLINE void LL_RTC_SetAsynchPrescaler ( RTC_TypeDef *  RTCx,
uint32_t  AsynchPrescaler 
)

Set Asynchronous prescaler factor @rmtoll PRER PREDIV_A LL_RTC_SetAsynchPrescaler.

Parameters
RTCxRTC Instance
AsynchPrescalerValue between Min_Data = 0 and Max_Data = 0x7F
Return values
None

Definition at line 945 of file stm32f4xx_ll_rtc.h.

◆ LL_RTC_SetHourFormat()

__STATIC_INLINE void LL_RTC_SetHourFormat ( RTC_TypeDef *  RTCx,
uint32_t  HourFormat 
)

Set Hours format (24 hour/day or AM/PM hour format)

Note
Bit is write-protected. LL_RTC_DisableWriteProtection function should be called before.
It can be written in initialization mode only (LL_RTC_EnableInitMode function) @rmtoll CR FMT LL_RTC_SetHourFormat
Parameters
RTCxRTC Instance
HourFormatThis parameter can be one of the following values:
  • LL_RTC_HOURFORMAT_24HOUR
  • LL_RTC_HOURFORMAT_AMPM
Return values
None

Definition at line 744 of file stm32f4xx_ll_rtc.h.

◆ LL_RTC_SetOutputPolarity()

__STATIC_INLINE void LL_RTC_SetOutputPolarity ( RTC_TypeDef *  RTCx,
uint32_t  Polarity 
)

Set Output polarity (pin is low when ALRAF/ALRBF/WUTF is asserted)

Note
Bit is write-protected. LL_RTC_DisableWriteProtection function should be called before. @rmtoll CR POL LL_RTC_SetOutputPolarity
Parameters
RTCxRTC Instance
PolarityThis parameter can be one of the following values:
  • LL_RTC_OUTPUTPOLARITY_PIN_HIGH
  • LL_RTC_OUTPUTPOLARITY_PIN_LOW
Return values
None

Definition at line 860 of file stm32f4xx_ll_rtc.h.

◆ LL_RTC_SetSynchPrescaler()

__STATIC_INLINE void LL_RTC_SetSynchPrescaler ( RTC_TypeDef *  RTCx,
uint32_t  SynchPrescaler 
)

Set Synchronous prescaler factor @rmtoll PRER PREDIV_S LL_RTC_SetSynchPrescaler.

Parameters
RTCxRTC Instance
SynchPrescalerValue between Min_Data = 0 and Max_Data = 0x7FFF
Return values
None

Definition at line 957 of file stm32f4xx_ll_rtc.h.