STM32F439xx HAL User Manual
Functions
ALARMA
RTC Exported Functions

Functions

__STATIC_INLINE void LL_RTC_ALMA_Enable (RTC_TypeDef *RTCx)
 Enable Alarm A.
__STATIC_INLINE void LL_RTC_ALMA_Disable (RTC_TypeDef *RTCx)
 Disable Alarm A.
__STATIC_INLINE void LL_RTC_ALMA_SetMask (RTC_TypeDef *RTCx, uint32_t Mask)
 Specify the Alarm A masks.
__STATIC_INLINE uint32_t LL_RTC_ALMA_GetMask (RTC_TypeDef *RTCx)
 Get the Alarm A masks.
__STATIC_INLINE void LL_RTC_ALMA_EnableWeekday (RTC_TypeDef *RTCx)
 Enable AlarmA Week day selection (DU[3:0] represents the week day.
__STATIC_INLINE void LL_RTC_ALMA_DisableWeekday (RTC_TypeDef *RTCx)
 Disable AlarmA Week day selection (DU[3:0] represents the date )
__STATIC_INLINE void LL_RTC_ALMA_SetDay (RTC_TypeDef *RTCx, uint32_t Day)
 Set ALARM A Day in BCD format.
__STATIC_INLINE uint32_t LL_RTC_ALMA_GetDay (RTC_TypeDef *RTCx)
 Get ALARM A Day in BCD format.
__STATIC_INLINE void LL_RTC_ALMA_SetWeekDay (RTC_TypeDef *RTCx, uint32_t WeekDay)
 Set ALARM A Weekday.
__STATIC_INLINE uint32_t LL_RTC_ALMA_GetWeekDay (RTC_TypeDef *RTCx)
 Get ALARM A Weekday.
__STATIC_INLINE void LL_RTC_ALMA_SetTimeFormat (RTC_TypeDef *RTCx, uint32_t TimeFormat)
 Set Alarm A time format (AM/24-hour or PM notation)
__STATIC_INLINE uint32_t LL_RTC_ALMA_GetTimeFormat (RTC_TypeDef *RTCx)
 Get Alarm A time format (AM or PM notation)
__STATIC_INLINE void LL_RTC_ALMA_SetHour (RTC_TypeDef *RTCx, uint32_t Hours)
 Set ALARM A Hours in BCD format.
__STATIC_INLINE uint32_t LL_RTC_ALMA_GetHour (RTC_TypeDef *RTCx)
 Get ALARM A Hours in BCD format.
__STATIC_INLINE void LL_RTC_ALMA_SetMinute (RTC_TypeDef *RTCx, uint32_t Minutes)
 Set ALARM A Minutes in BCD format.
__STATIC_INLINE uint32_t LL_RTC_ALMA_GetMinute (RTC_TypeDef *RTCx)
 Get ALARM A Minutes in BCD format.
__STATIC_INLINE void LL_RTC_ALMA_SetSecond (RTC_TypeDef *RTCx, uint32_t Seconds)
 Set ALARM A Seconds in BCD format.
__STATIC_INLINE uint32_t LL_RTC_ALMA_GetSecond (RTC_TypeDef *RTCx)
 Get ALARM A Seconds in BCD format.
__STATIC_INLINE void LL_RTC_ALMA_ConfigTime (RTC_TypeDef *RTCx, uint32_t Format12_24, uint32_t Hours, uint32_t Minutes, uint32_t Seconds)
 Set Alarm A Time (hour, minute and second) in BCD format.
__STATIC_INLINE uint32_t LL_RTC_ALMA_GetTime (RTC_TypeDef *RTCx)
 Get Alarm B Time (hour, minute and second) in BCD format.
__STATIC_INLINE void LL_RTC_ALMA_SetSubSecondMask (RTC_TypeDef *RTCx, uint32_t Mask)
 Set Alarm A Mask the most-significant bits starting at this bit.
__STATIC_INLINE uint32_t LL_RTC_ALMA_GetSubSecondMask (RTC_TypeDef *RTCx)
 Get Alarm A Mask the most-significant bits starting at this bit.
__STATIC_INLINE void LL_RTC_ALMA_SetSubSecond (RTC_TypeDef *RTCx, uint32_t Subsecond)
 Set Alarm A Sub seconds value.
__STATIC_INLINE uint32_t LL_RTC_ALMA_GetSubSecond (RTC_TypeDef *RTCx)
 Get Alarm A Sub seconds value.

Function Documentation

__STATIC_INLINE void LL_RTC_ALMA_ConfigTime ( RTC_TypeDef *  RTCx,
uint32_t  Format12_24,
uint32_t  Hours,
uint32_t  Minutes,
uint32_t  Seconds 
)

Set Alarm A Time (hour, minute and second) in BCD format.

Reference Manual to LL API cross reference:
ALRMAR PM LL_RTC_ALMA_ConfigTime
ALRMAR HT LL_RTC_ALMA_ConfigTime
ALRMAR HU LL_RTC_ALMA_ConfigTime
ALRMAR MNT LL_RTC_ALMA_ConfigTime
ALRMAR MNU LL_RTC_ALMA_ConfigTime
ALRMAR ST LL_RTC_ALMA_ConfigTime
ALRMAR SU LL_RTC_ALMA_ConfigTime
Parameters:
RTCxRTC Instance
Format12_24This parameter can be one of the following values:
HoursValue between Min_Data=0x01 and Max_Data=0x12 or between Min_Data=0x00 and Max_Data=0x23
MinutesValue between Min_Data=0x00 and Max_Data=0x59
SecondsValue between Min_Data=0x00 and Max_Data=0x59
Return values:
None

Definition at line 1995 of file stm32f4xx_ll_rtc.h.

Referenced by LL_RTC_ALMA_Init().

__STATIC_INLINE void LL_RTC_ALMA_Disable ( RTC_TypeDef *  RTCx)

Disable Alarm A.

Note:
Bit is write-protected. LL_RTC_DisableWriteProtection function should be called before.
Reference Manual to LL API cross reference:
CR ALRAE LL_RTC_ALMA_Disable
Parameters:
RTCxRTC Instance
Return values:
None

Definition at line 1721 of file stm32f4xx_ll_rtc.h.

__STATIC_INLINE void LL_RTC_ALMA_DisableWeekday ( RTC_TypeDef *  RTCx)

Disable AlarmA Week day selection (DU[3:0] represents the date )

Reference Manual to LL API cross reference:
ALRMAR WDSEL LL_RTC_ALMA_DisableWeekday
Parameters:
RTCxRTC Instance
Return values:
None

Definition at line 1784 of file stm32f4xx_ll_rtc.h.

Referenced by LL_RTC_ALMA_Init().

__STATIC_INLINE void LL_RTC_ALMA_Enable ( RTC_TypeDef *  RTCx)

Enable Alarm A.

Note:
Bit is write-protected. LL_RTC_DisableWriteProtection function should be called before.
Reference Manual to LL API cross reference:
CR ALRAE LL_RTC_ALMA_Enable
Parameters:
RTCxRTC Instance
Return values:
None

Definition at line 1709 of file stm32f4xx_ll_rtc.h.

__STATIC_INLINE void LL_RTC_ALMA_EnableWeekday ( RTC_TypeDef *  RTCx)

Enable AlarmA Week day selection (DU[3:0] represents the week day.

DT[1:0] is do not care)

Reference Manual to LL API cross reference:
ALRMAR WDSEL LL_RTC_ALMA_EnableWeekday
Parameters:
RTCxRTC Instance
Return values:
None

Definition at line 1773 of file stm32f4xx_ll_rtc.h.

Referenced by LL_RTC_ALMA_Init().

__STATIC_INLINE uint32_t LL_RTC_ALMA_GetDay ( RTC_TypeDef *  RTCx)

Get ALARM A Day in BCD format.

Note:
helper macro __LL_RTC_CONVERT_BCD2BIN is available to convert Day from BCD to Binary format
Reference Manual to LL API cross reference:
ALRMAR DT LL_RTC_ALMA_GetDay
ALRMAR DU LL_RTC_ALMA_GetDay
Parameters:
RTCxRTC Instance
Return values:
Valuebetween Min_Data=0x01 and Max_Data=0x31

Definition at line 1812 of file stm32f4xx_ll_rtc.h.

__STATIC_INLINE uint32_t LL_RTC_ALMA_GetHour ( RTC_TypeDef *  RTCx)

Get ALARM A Hours in BCD format.

Note:
helper macro __LL_RTC_CONVERT_BCD2BIN is available to convert Hours from BCD to Binary format
Reference Manual to LL API cross reference:
ALRMAR HT LL_RTC_ALMA_GetHour
ALRMAR HU LL_RTC_ALMA_GetHour
Parameters:
RTCxRTC Instance
Return values:
Valuebetween Min_Data=0x01 and Max_Data=0x12 or between Min_Data=0x00 and Max_Data=0x23

Definition at line 1907 of file stm32f4xx_ll_rtc.h.

Referenced by LL_RTC_ALMA_GetTime().

__STATIC_INLINE uint32_t LL_RTC_ALMA_GetMask ( RTC_TypeDef *  RTCx)

Get the Alarm A masks.

Reference Manual to LL API cross reference:
ALRMAR MSK4 LL_RTC_ALMA_GetMask
ALRMAR MSK3 LL_RTC_ALMA_GetMask
ALRMAR MSK2 LL_RTC_ALMA_GetMask
ALRMAR MSK1 LL_RTC_ALMA_GetMask
Parameters:
RTCxRTC Instance
Return values:
Returnedvalue can be can be a combination of the following values:

Definition at line 1762 of file stm32f4xx_ll_rtc.h.

__STATIC_INLINE uint32_t LL_RTC_ALMA_GetMinute ( RTC_TypeDef *  RTCx)

Get ALARM A Minutes in BCD format.

Note:
helper macro __LL_RTC_CONVERT_BCD2BIN is available to convert Minutes from BCD to Binary format
Reference Manual to LL API cross reference:
ALRMAR MNT LL_RTC_ALMA_GetMinute
ALRMAR MNU LL_RTC_ALMA_GetMinute
Parameters:
RTCxRTC Instance
Return values:
Valuebetween Min_Data=0x00 and Max_Data=0x59

Definition at line 1938 of file stm32f4xx_ll_rtc.h.

Referenced by LL_RTC_ALMA_GetTime().

__STATIC_INLINE uint32_t LL_RTC_ALMA_GetSecond ( RTC_TypeDef *  RTCx)

Get ALARM A Seconds in BCD format.

Note:
helper macro __LL_RTC_CONVERT_BCD2BIN is available to convert Seconds from BCD to Binary format
Reference Manual to LL API cross reference:
ALRMAR ST LL_RTC_ALMA_GetSecond
ALRMAR SU LL_RTC_ALMA_GetSecond
Parameters:
RTCxRTC Instance
Return values:
Valuebetween Min_Data=0x00 and Max_Data=0x59

Definition at line 1969 of file stm32f4xx_ll_rtc.h.

Referenced by LL_RTC_ALMA_GetTime().

__STATIC_INLINE uint32_t LL_RTC_ALMA_GetSubSecond ( RTC_TypeDef *  RTCx)

Get Alarm A Sub seconds value.

Reference Manual to LL API cross reference:
ALRMASSR SS LL_RTC_ALMA_GetSubSecond
Parameters:
RTCxRTC Instance
Return values:
Valuebetween Min_Data=0x00 and Max_Data=0x7FFF

Definition at line 2067 of file stm32f4xx_ll_rtc.h.

__STATIC_INLINE uint32_t LL_RTC_ALMA_GetSubSecondMask ( RTC_TypeDef *  RTCx)

Get Alarm A Mask the most-significant bits starting at this bit.

Reference Manual to LL API cross reference:
ALRMASSR MASKSS LL_RTC_ALMA_GetSubSecondMask
Parameters:
RTCxRTC Instance
Return values:
Valuebetween Min_Data=0x00 and Max_Data=0xF

Definition at line 2044 of file stm32f4xx_ll_rtc.h.

__STATIC_INLINE uint32_t LL_RTC_ALMA_GetTime ( RTC_TypeDef *  RTCx)

Get Alarm B Time (hour, minute and second) in BCD format.

Note:
helper macros __LL_RTC_GET_HOUR, __LL_RTC_GET_MINUTE and __LL_RTC_GET_SECOND are available to get independently each parameter.
Reference Manual to LL API cross reference:
ALRMAR HT LL_RTC_ALMA_GetTime
ALRMAR HU LL_RTC_ALMA_GetTime
ALRMAR MNT LL_RTC_ALMA_GetTime
ALRMAR MNU LL_RTC_ALMA_GetTime
ALRMAR ST LL_RTC_ALMA_GetTime
ALRMAR SU LL_RTC_ALMA_GetTime
Parameters:
RTCxRTC Instance
Return values:
Combinationof hours, minutes and seconds.

Definition at line 2019 of file stm32f4xx_ll_rtc.h.

References LL_RTC_ALMA_GetHour(), LL_RTC_ALMA_GetMinute(), LL_RTC_ALMA_GetSecond(), RTC_OFFSET_HOUR, and RTC_OFFSET_MINUTE.

__STATIC_INLINE uint32_t LL_RTC_ALMA_GetTimeFormat ( RTC_TypeDef *  RTCx)

Get Alarm A time format (AM or PM notation)

Reference Manual to LL API cross reference:
ALRMAR PM LL_RTC_ALMA_GetTimeFormat
Parameters:
RTCxRTC Instance
Return values:
Returnedvalue can be one of the following values:

Definition at line 1879 of file stm32f4xx_ll_rtc.h.

__STATIC_INLINE uint32_t LL_RTC_ALMA_GetWeekDay ( RTC_TypeDef *  RTCx)

Get ALARM A Weekday.

Reference Manual to LL API cross reference:
ALRMAR DU LL_RTC_ALMA_GetWeekDay
Parameters:
RTCxRTC Instance
Return values:
Returnedvalue can be one of the following values:

Definition at line 1852 of file stm32f4xx_ll_rtc.h.

__STATIC_INLINE void LL_RTC_ALMA_SetDay ( RTC_TypeDef *  RTCx,
uint32_t  Day 
)

Set ALARM A Day in BCD format.

Note:
helper macro __LL_RTC_CONVERT_BIN2BCD is available to convert Day from binary to BCD format
Reference Manual to LL API cross reference:
ALRMAR DT LL_RTC_ALMA_SetDay
ALRMAR DU LL_RTC_ALMA_SetDay
Parameters:
RTCxRTC Instance
DayValue between Min_Data=0x01 and Max_Data=0x31
Return values:
None

Definition at line 1798 of file stm32f4xx_ll_rtc.h.

Referenced by LL_RTC_ALMA_Init().

__STATIC_INLINE void LL_RTC_ALMA_SetHour ( RTC_TypeDef *  RTCx,
uint32_t  Hours 
)

Set ALARM A Hours in BCD format.

Note:
helper macro __LL_RTC_CONVERT_BIN2BCD is available to convert Hours from binary to BCD format
Reference Manual to LL API cross reference:
ALRMAR HT LL_RTC_ALMA_SetHour
ALRMAR HU LL_RTC_ALMA_SetHour
Parameters:
RTCxRTC Instance
HoursValue between Min_Data=0x01 and Max_Data=0x12 or between Min_Data=0x00 and Max_Data=0x23
Return values:
None

Definition at line 1893 of file stm32f4xx_ll_rtc.h.

__STATIC_INLINE void LL_RTC_ALMA_SetMask ( RTC_TypeDef *  RTCx,
uint32_t  Mask 
)

Specify the Alarm A masks.

Reference Manual to LL API cross reference:
ALRMAR MSK4 LL_RTC_ALMA_SetMask
ALRMAR MSK3 LL_RTC_ALMA_SetMask
ALRMAR MSK2 LL_RTC_ALMA_SetMask
ALRMAR MSK1 LL_RTC_ALMA_SetMask
Parameters:
RTCxRTC Instance
MaskThis parameter can be a combination of the following values:
Return values:
None

Definition at line 1742 of file stm32f4xx_ll_rtc.h.

Referenced by LL_RTC_ALMA_Init().

__STATIC_INLINE void LL_RTC_ALMA_SetMinute ( RTC_TypeDef *  RTCx,
uint32_t  Minutes 
)

Set ALARM A Minutes in BCD format.

Note:
helper macro __LL_RTC_CONVERT_BIN2BCD is available to convert Minutes from binary to BCD format
Reference Manual to LL API cross reference:
ALRMAR MNT LL_RTC_ALMA_SetMinute
ALRMAR MNU LL_RTC_ALMA_SetMinute
Parameters:
RTCxRTC Instance
MinutesValue between Min_Data=0x00 and Max_Data=0x59
Return values:
None

Definition at line 1924 of file stm32f4xx_ll_rtc.h.

__STATIC_INLINE void LL_RTC_ALMA_SetSecond ( RTC_TypeDef *  RTCx,
uint32_t  Seconds 
)

Set ALARM A Seconds in BCD format.

Note:
helper macro __LL_RTC_CONVERT_BIN2BCD is available to convert Seconds from binary to BCD format
Reference Manual to LL API cross reference:
ALRMAR ST LL_RTC_ALMA_SetSecond
ALRMAR SU LL_RTC_ALMA_SetSecond
Parameters:
RTCxRTC Instance
SecondsValue between Min_Data=0x00 and Max_Data=0x59
Return values:
None

Definition at line 1955 of file stm32f4xx_ll_rtc.h.

__STATIC_INLINE void LL_RTC_ALMA_SetSubSecond ( RTC_TypeDef *  RTCx,
uint32_t  Subsecond 
)

Set Alarm A Sub seconds value.

Reference Manual to LL API cross reference:
ALRMASSR SS LL_RTC_ALMA_SetSubSecond
Parameters:
RTCxRTC Instance
SubsecondValue between Min_Data=0x00 and Max_Data=0x7FFF
Return values:
None

Definition at line 2056 of file stm32f4xx_ll_rtc.h.

__STATIC_INLINE void LL_RTC_ALMA_SetSubSecondMask ( RTC_TypeDef *  RTCx,
uint32_t  Mask 
)

Set Alarm A Mask the most-significant bits starting at this bit.

Note:
This register can be written only when ALRAE is reset in RTC_CR register, or in initialization mode.
Reference Manual to LL API cross reference:
ALRMASSR MASKSS LL_RTC_ALMA_SetSubSecondMask
Parameters:
RTCxRTC Instance
MaskValue between Min_Data=0x00 and Max_Data=0xF
Return values:
None

Definition at line 2033 of file stm32f4xx_ll_rtc.h.

__STATIC_INLINE void LL_RTC_ALMA_SetTimeFormat ( RTC_TypeDef *  RTCx,
uint32_t  TimeFormat 
)

Set Alarm A time format (AM/24-hour or PM notation)

Reference Manual to LL API cross reference:
ALRMAR PM LL_RTC_ALMA_SetTimeFormat
Parameters:
RTCxRTC Instance
TimeFormatThis parameter can be one of the following values:
Return values:
None

Definition at line 1866 of file stm32f4xx_ll_rtc.h.

__STATIC_INLINE void LL_RTC_ALMA_SetWeekDay ( RTC_TypeDef *  RTCx,
uint32_t  WeekDay 
)

Set ALARM A Weekday.

Reference Manual to LL API cross reference:
ALRMAR DU LL_RTC_ALMA_SetWeekDay
Parameters:
RTCxRTC Instance
WeekDayThis parameter can be one of the following values:
Return values:
None

Definition at line 1834 of file stm32f4xx_ll_rtc.h.

Referenced by LL_RTC_ALMA_Init().