Important changes to repositories hosted on mbed.com
Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.
To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.
It is also possible to export all your personal repositories from the account settings page.
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 ) ALRMAR WDSEL LL_RTC_ALMA_DisableWeekday. | |
| __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 ALRMAR DU LL_RTC_ALMA_SetWeekDay. | |
| __STATIC_INLINE uint32_t | LL_RTC_ALMA_GetWeekDay (RTC_TypeDef *RTCx) |
| Get ALARM A Weekday ALRMAR DU LL_RTC_ALMA_GetWeekDay. | |
| __STATIC_INLINE void | LL_RTC_ALMA_SetTimeFormat (RTC_TypeDef *RTCx, uint32_t TimeFormat) |
| Set Alarm A time format (AM/24-hour or PM notation) ALRMAR PM LL_RTC_ALMA_SetTimeFormat. | |
| __STATIC_INLINE uint32_t | LL_RTC_ALMA_GetTimeFormat (RTC_TypeDef *RTCx) |
| Get Alarm A time format (AM or PM notation) ALRMAR PM LL_RTC_ALMA_GetTimeFormat. | |
| __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 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. | |
| __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 ALRMASSR MASKSS LL_RTC_ALMA_GetSubSecondMask. | |
| __STATIC_INLINE void | LL_RTC_ALMA_SetSubSecond (RTC_TypeDef *RTCx, uint32_t Subsecond) |
| Set Alarm A Sub seconds value ALRMASSR SS LL_RTC_ALMA_SetSubSecond. | |
| __STATIC_INLINE uint32_t | LL_RTC_ALMA_GetSubSecond (RTC_TypeDef *RTCx) |
| Get Alarm A Sub seconds value ALRMASSR SS LL_RTC_ALMA_GetSubSecond. | |
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 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:
-
RTCx RTC Instance Format12_24 This parameter can be one of the following values: - LL_RTC_ALMA_TIME_FORMAT_AM
- LL_RTC_ALMA_TIME_FORMAT_PM
Hours Value between Min_Data=0x01 and Max_Data=0x12 or between Min_Data=0x00 and Max_Data=0x23 Minutes Value between Min_Data=0x00 and Max_Data=0x59 Seconds Value between Min_Data=0x00 and Max_Data=0x59
- Return values:
-
None
Definition at line 1972 of file stm32l4xx_ll_rtc.h.
| __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. CR ALRAE LL_RTC_ALMA_Disable
- Parameters:
-
RTCx RTC Instance
- Return values:
-
None
Definition at line 1698 of file stm32l4xx_ll_rtc.h.
| __STATIC_INLINE void LL_RTC_ALMA_DisableWeekday | ( | RTC_TypeDef * | RTCx ) |
Disable AlarmA Week day selection (DU[3:0] represents the date ) ALRMAR WDSEL LL_RTC_ALMA_DisableWeekday.
- Parameters:
-
RTCx RTC Instance
- Return values:
-
None
Definition at line 1761 of file stm32l4xx_ll_rtc.h.
| __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. CR ALRAE LL_RTC_ALMA_Enable
- Parameters:
-
RTCx RTC Instance
- Return values:
-
None
Definition at line 1686 of file stm32l4xx_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) ALRMAR WDSEL LL_RTC_ALMA_EnableWeekday
- Parameters:
-
RTCx RTC Instance
- Return values:
-
None
Definition at line 1750 of file stm32l4xx_ll_rtc.h.
| __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 ALRMAR DT LL_RTC_ALMA_GetDay
ALRMAR DU LL_RTC_ALMA_GetDay
- Parameters:
-
RTCx RTC Instance
- Return values:
-
Value between Min_Data=0x01 and Max_Data=0x31
Definition at line 1789 of file stm32l4xx_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 ALRMAR HT LL_RTC_ALMA_GetHour
ALRMAR HU LL_RTC_ALMA_GetHour
- Parameters:
-
RTCx RTC Instance
- Return values:
-
Value between Min_Data=0x01 and Max_Data=0x12 or between Min_Data=0x00 and Max_Data=0x23
Definition at line 1884 of file stm32l4xx_ll_rtc.h.
| __STATIC_INLINE uint32_t LL_RTC_ALMA_GetMask | ( | RTC_TypeDef * | RTCx ) |
Get the Alarm A masks.
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:
-
RTCx RTC Instance
- Return values:
-
Returned value can be can be a combination of the following values: - LL_RTC_ALMA_MASK_NONE
- LL_RTC_ALMA_MASK_DATEWEEKDAY
- LL_RTC_ALMA_MASK_HOURS
- LL_RTC_ALMA_MASK_MINUTES
- LL_RTC_ALMA_MASK_SECONDS
- LL_RTC_ALMA_MASK_ALL
Definition at line 1739 of file stm32l4xx_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 ALRMAR MNT LL_RTC_ALMA_GetMinute
ALRMAR MNU LL_RTC_ALMA_GetMinute
- Parameters:
-
RTCx RTC Instance
- Return values:
-
Value between Min_Data=0x00 and Max_Data=0x59
Definition at line 1915 of file stm32l4xx_ll_rtc.h.
| __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 ALRMAR ST LL_RTC_ALMA_GetSecond
ALRMAR SU LL_RTC_ALMA_GetSecond
- Parameters:
-
RTCx RTC Instance
- Return values:
-
Value between Min_Data=0x00 and Max_Data=0x59
Definition at line 1946 of file stm32l4xx_ll_rtc.h.
| __STATIC_INLINE uint32_t LL_RTC_ALMA_GetSubSecond | ( | RTC_TypeDef * | RTCx ) |
Get Alarm A Sub seconds value ALRMASSR SS LL_RTC_ALMA_GetSubSecond.
- Parameters:
-
RTCx RTC Instance
- Return values:
-
Value between Min_Data=0x00 and Max_Data=0x7FFF
Definition at line 2044 of file stm32l4xx_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 ALRMASSR MASKSS LL_RTC_ALMA_GetSubSecondMask.
- Parameters:
-
RTCx RTC Instance
- Return values:
-
Value between Min_Data=0x00 and Max_Data=0xF
Definition at line 2021 of file stm32l4xx_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. 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:
-
RTCx RTC Instance
- Return values:
-
Combination of hours, minutes and seconds.
Definition at line 1996 of file stm32l4xx_ll_rtc.h.
| __STATIC_INLINE uint32_t LL_RTC_ALMA_GetTimeFormat | ( | RTC_TypeDef * | RTCx ) |
Get Alarm A time format (AM or PM notation) ALRMAR PM LL_RTC_ALMA_GetTimeFormat.
- Parameters:
-
RTCx RTC Instance
- Return values:
-
Returned value can be one of the following values: - LL_RTC_ALMA_TIME_FORMAT_AM
- LL_RTC_ALMA_TIME_FORMAT_PM
Definition at line 1856 of file stm32l4xx_ll_rtc.h.
| __STATIC_INLINE uint32_t LL_RTC_ALMA_GetWeekDay | ( | RTC_TypeDef * | RTCx ) |
Get ALARM A Weekday ALRMAR DU LL_RTC_ALMA_GetWeekDay.
- Parameters:
-
RTCx RTC Instance
- Return values:
-
Returned value can be one of the following values: - LL_RTC_WEEKDAY_MONDAY
- LL_RTC_WEEKDAY_TUESDAY
- LL_RTC_WEEKDAY_WEDNESDAY
- LL_RTC_WEEKDAY_THURSDAY
- LL_RTC_WEEKDAY_FRIDAY
- LL_RTC_WEEKDAY_SATURDAY
- LL_RTC_WEEKDAY_SUNDAY
Definition at line 1829 of file stm32l4xx_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 ALRMAR DT LL_RTC_ALMA_SetDay
ALRMAR DU LL_RTC_ALMA_SetDay
- Parameters:
-
RTCx RTC Instance Day Value between Min_Data=0x01 and Max_Data=0x31
- Return values:
-
None
Definition at line 1775 of file stm32l4xx_ll_rtc.h.
| __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 ALRMAR HT LL_RTC_ALMA_SetHour
ALRMAR HU LL_RTC_ALMA_SetHour
- Parameters:
-
RTCx RTC Instance Hours Value between Min_Data=0x01 and Max_Data=0x12 or between Min_Data=0x00 and Max_Data=0x23
- Return values:
-
None
Definition at line 1870 of file stm32l4xx_ll_rtc.h.
| __STATIC_INLINE void LL_RTC_ALMA_SetMask | ( | RTC_TypeDef * | RTCx, |
| uint32_t | Mask | ||
| ) |
Specify the Alarm A masks.
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:
-
RTCx RTC Instance Mask This parameter can be a combination of the following values: - LL_RTC_ALMA_MASK_NONE
- LL_RTC_ALMA_MASK_DATEWEEKDAY
- LL_RTC_ALMA_MASK_HOURS
- LL_RTC_ALMA_MASK_MINUTES
- LL_RTC_ALMA_MASK_SECONDS
- LL_RTC_ALMA_MASK_ALL
- Return values:
-
None
Definition at line 1719 of file stm32l4xx_ll_rtc.h.
| __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 ALRMAR MNT LL_RTC_ALMA_SetMinute
ALRMAR MNU LL_RTC_ALMA_SetMinute
- Parameters:
-
RTCx RTC Instance Minutes Value between Min_Data=0x00 and Max_Data=0x59
- Return values:
-
None
Definition at line 1901 of file stm32l4xx_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 ALRMAR ST LL_RTC_ALMA_SetSecond
ALRMAR SU LL_RTC_ALMA_SetSecond
- Parameters:
-
RTCx RTC Instance Seconds Value between Min_Data=0x00 and Max_Data=0x59
- Return values:
-
None
Definition at line 1932 of file stm32l4xx_ll_rtc.h.
| __STATIC_INLINE void LL_RTC_ALMA_SetSubSecond | ( | RTC_TypeDef * | RTCx, |
| uint32_t | Subsecond | ||
| ) |
Set Alarm A Sub seconds value ALRMASSR SS LL_RTC_ALMA_SetSubSecond.
- Parameters:
-
RTCx RTC Instance Subsecond Value between Min_Data=0x00 and Max_Data=0x7FFF
- Return values:
-
None
Definition at line 2033 of file stm32l4xx_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. ALRMASSR MASKSS LL_RTC_ALMA_SetSubSecondMask
- Parameters:
-
RTCx RTC Instance Mask Value between Min_Data=0x00 and Max_Data=0xF
- Return values:
-
None
Definition at line 2010 of file stm32l4xx_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) ALRMAR PM LL_RTC_ALMA_SetTimeFormat.
- Parameters:
-
RTCx RTC Instance TimeFormat This parameter can be one of the following values: - LL_RTC_ALMA_TIME_FORMAT_AM
- LL_RTC_ALMA_TIME_FORMAT_PM
- Return values:
-
None
Definition at line 1843 of file stm32l4xx_ll_rtc.h.
| __STATIC_INLINE void LL_RTC_ALMA_SetWeekDay | ( | RTC_TypeDef * | RTCx, |
| uint32_t | WeekDay | ||
| ) |
Set ALARM A Weekday ALRMAR DU LL_RTC_ALMA_SetWeekDay.
- Parameters:
-
RTCx RTC Instance WeekDay This parameter can be one of the following values: - LL_RTC_WEEKDAY_MONDAY
- LL_RTC_WEEKDAY_TUESDAY
- LL_RTC_WEEKDAY_WEDNESDAY
- LL_RTC_WEEKDAY_THURSDAY
- LL_RTC_WEEKDAY_FRIDAY
- LL_RTC_WEEKDAY_SATURDAY
- LL_RTC_WEEKDAY_SUNDAY
- Return values:
-
None
Definition at line 1811 of file stm32l4xx_ll_rtc.h.
Generated on Tue Jul 12 2022 11:00:15 by
1.7.2