TUKS MCU Introductory course / TUKS-COURSE-2-LED
Embed: (wiki syntax)

« Back to documentation index

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

Function Documentation

__STATIC_INLINE void LL_RTC_DisableInitMode ( RTC_TypeDef *  RTCx )

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

Parameters:
RTCxRTC Instance
Return values:
None

Definition at line 943 of file stm32l4xx_ll_rtc.h.

__STATIC_INLINE void LL_RTC_DisableOutRemap ( RTC_TypeDef *  RTCx )

Disable RTC_OUT remap OR OUT_RMP LL_RTC_DisableOutRemap.

Parameters:
RTCxRTC Instance
Return values:
None

Definition at line 1123 of file stm32l4xx_ll_rtc.h.

__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) CR REFCKON LL_RTC_DisableRefClock
Parameters:
RTCxRTC Instance
Return values:
None

Definition at line 1032 of file stm32l4xx_ll_rtc.h.

__STATIC_INLINE void LL_RTC_DisableShadowRegBypass ( RTC_TypeDef *  RTCx )

Disable Bypass the shadow registers CR BYPSHAD LL_RTC_DisableShadowRegBypass.

Parameters:
RTCxRTC Instance
Return values:
None

Definition at line 995 of file stm32l4xx_ll_rtc.h.

__STATIC_INLINE void LL_RTC_DisableWriteProtection ( RTC_TypeDef *  RTCx )

Disable the write protection for RTC registers.

WPR KEY LL_RTC_DisableWriteProtection

Parameters:
RTCxRTC Instance
Return values:
None

Definition at line 1100 of file stm32l4xx_ll_rtc.h.

__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. ISR INIT LL_RTC_EnableInitMode
Parameters:
RTCxRTC Instance
Return values:
None

Definition at line 931 of file stm32l4xx_ll_rtc.h.

__STATIC_INLINE void LL_RTC_EnableOutRemap ( RTC_TypeDef *  RTCx )

Enable RTC_OUT remap OR OUT_RMP LL_RTC_EnableOutRemap.

Parameters:
RTCxRTC Instance
Return values:
None

Definition at line 1112 of file stm32l4xx_ll_rtc.h.

__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) CR REFCKON LL_RTC_EnableRefClock
Parameters:
RTCxRTC Instance
Return values:
None

Definition at line 1019 of file stm32l4xx_ll_rtc.h.

__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. CR BYPSHAD LL_RTC_EnableShadowRegBypass
Parameters:
RTCxRTC Instance
Return values:
None

Definition at line 984 of file stm32l4xx_ll_rtc.h.

__STATIC_INLINE void LL_RTC_EnableWriteProtection ( RTC_TypeDef *  RTCx )

Enable the write protection for RTC registers.

WPR KEY LL_RTC_EnableWriteProtection

Parameters:
RTCxRTC Instance
Return values:
None

Definition at line 1089 of file stm32l4xx_ll_rtc.h.

__STATIC_INLINE uint32_t LL_RTC_GetAlarmOutEvent ( RTC_TypeDef *  RTCx )

Get the flag to be routed to RTC_ALARM output 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 888 of file stm32l4xx_ll_rtc.h.

__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 OR 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 917 of file stm32l4xx_ll_rtc.h.

__STATIC_INLINE uint32_t LL_RTC_GetAsynchPrescaler ( RTC_TypeDef *  RTCx )

Get Asynchronous prescaler factor PRER PREDIV_A LL_RTC_GetAsynchPrescaler.

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

Definition at line 1067 of file stm32l4xx_ll_rtc.h.

__STATIC_INLINE uint32_t LL_RTC_GetHourFormat ( RTC_TypeDef *  RTCx )

Get Hours format (24 hour/day or AM/PM hour format) 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 856 of file stm32l4xx_ll_rtc.h.

__STATIC_INLINE uint32_t LL_RTC_GetOutputPolarity ( RTC_TypeDef *  RTCx )

Get Output polarity 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 972 of file stm32l4xx_ll_rtc.h.

__STATIC_INLINE uint32_t LL_RTC_GetSynchPrescaler ( RTC_TypeDef *  RTCx )

Get Synchronous prescaler factor PRER PREDIV_S LL_RTC_GetSynchPrescaler.

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

Definition at line 1078 of file stm32l4xx_ll_rtc.h.

__STATIC_INLINE uint32_t LL_RTC_IsShadowRegBypassEnabled ( RTC_TypeDef *  RTCx )

Check if Shadow registers bypass is enabled or not.

CR BYPSHAD LL_RTC_IsShadowRegBypassEnabled

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

Definition at line 1006 of file stm32l4xx_ll_rtc.h.

__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. 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 873 of file stm32l4xx_ll_rtc.h.

__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 OR 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 903 of file stm32l4xx_ll_rtc.h.

__STATIC_INLINE void LL_RTC_SetAsynchPrescaler ( RTC_TypeDef *  RTCx,
uint32_t  AsynchPrescaler 
)

Set Asynchronous prescaler factor PRER PREDIV_A LL_RTC_SetAsynchPrescaler.

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

Definition at line 1044 of file stm32l4xx_ll_rtc.h.

__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) 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 843 of file stm32l4xx_ll_rtc.h.

__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. 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 959 of file stm32l4xx_ll_rtc.h.

__STATIC_INLINE void LL_RTC_SetSynchPrescaler ( RTC_TypeDef *  RTCx,
uint32_t  SynchPrescaler 
)

Set Synchronous prescaler factor PRER PREDIV_S LL_RTC_SetSynchPrescaler.

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

Definition at line 1056 of file stm32l4xx_ll_rtc.h.