Eric Lewiston / STM32L4xx_HAL_Driver

Dependents:   BSP OneHopeOnePrayer FINAL_AUDIO_RECORD AudioDemo

Fork of STM32L4xx_HAL_Driver by Senior Design: Sound Monitor

Embed: (wiki syntax)

« Back to documentation index

ALARMA

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 Format)
 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 Hour)
 Set ALARM A Hour in BCD format.
__STATIC_INLINE uint32_t LL_RTC_ALMA_GetHour (RTC_TypeDef *RTCx)
 Get ALARM A Hour in BCD format.
__STATIC_INLINE void LL_RTC_ALMA_SetMinute (RTC_TypeDef *RTCx, uint32_t Minute)
 Set ALARM A Minute in BCD format.
__STATIC_INLINE uint32_t LL_RTC_ALMA_GetMinute (RTC_TypeDef *RTCx)
 Get ALARM A Minute in BCD format.
__STATIC_INLINE void LL_RTC_ALMA_SetSecond (RTC_TypeDef *RTCx, uint32_t Second)
 Set ALARM A Second in BCD format.
__STATIC_INLINE uint32_t LL_RTC_ALMA_GetSecond (RTC_TypeDef *RTCx)
 Get ALARM A Second in BCD format.
__STATIC_INLINE void LL_RTC_ALMA_ConfigTime (RTC_TypeDef *RTCx, uint32_t Format12_24, uint32_t Hour, uint32_t Minute, uint32_t Second)
 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  Hour,
uint32_t  Minute,
uint32_t  Second 
)

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:
RTCxRTC Instance
Format12_24This parameter can be one of the following values:

  • LL_RTC_ALMA_TIME_FORMAT_AM
  • LL_RTC_ALMA_TIME_FORMAT_PM
Hour0x01. . .0x12 or 0x00. . .0x23
Minute0x00. . .0x59
Second0x00. . .0x59
Return values:
None

Definition at line 1788 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:
RTCxRTC Instance
Return values:
None

Definition at line 1514 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:
RTCxRTC Instance
Return values:
None

Definition at line 1577 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:
RTCxRTC Instance
Return values:
None

Definition at line 1502 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:
RTCxRTC Instance
Return values:
None

Definition at line 1566 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:
RTCxRTC Instance
Return values:
0x01.. .0x31

Definition at line 1605 of file stm32l4xx_ll_rtc.h.

__STATIC_INLINE uint32_t LL_RTC_ALMA_GetHour ( RTC_TypeDef *  RTCx )

Get ALARM A Hour in BCD format.

Note:
helper macro __LL_RTC_CONVERT_BCD2BIN is available to convert Hour from BCD to Binary format ALRMAR HT LL_RTC_ALMA_GetHour
ALRMAR HU LL_RTC_ALMA_GetHour
Parameters:
RTCxRTC Instance
Return values:
0x01.. .0x12 or 0x00. . .0x23

Definition at line 1700 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:
RTCxRTC Instance
Return values:
Returnedvalue 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 1555 of file stm32l4xx_ll_rtc.h.

__STATIC_INLINE uint32_t LL_RTC_ALMA_GetMinute ( RTC_TypeDef *  RTCx )

Get ALARM A Minute in BCD format.

Note:
helper macro __LL_RTC_CONVERT_BCD2BIN is available to convert Minute from BCD to Binary format ALRMAR MNT LL_RTC_ALMA_GetMinute
ALRMAR MNU LL_RTC_ALMA_GetMinute
Parameters:
RTCxRTC Instance
Return values:
0x00.. .0x59

Definition at line 1731 of file stm32l4xx_ll_rtc.h.

__STATIC_INLINE uint32_t LL_RTC_ALMA_GetSecond ( RTC_TypeDef *  RTCx )

Get ALARM A Second in BCD format.

Note:
helper macro __LL_RTC_CONVERT_BCD2BIN is available to convert Second from BCD to Binary format ALRMAR ST LL_RTC_ALMA_GetSecond
ALRMAR SU LL_RTC_ALMA_GetSecond
Parameters:
RTCxRTC Instance
Return values:
0x00.. .0x59

Definition at line 1762 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:
RTCxRTC Instance
Return values:
0.. .0x7FFF

Definition at line 1860 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:
RTCxRTC Instance
Return values:
0.. .0xF

Definition at line 1837 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:
RTCxRTC Instance
Return values:
Combinationof hours, minutes and seconds.

Definition at line 1812 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:
RTCxRTC Instance
Return values:
Returnedvalue can be one of the following values:

  • LL_RTC_ALMA_TIME_FORMAT_AM
  • LL_RTC_ALMA_TIME_FORMAT_PM

Definition at line 1672 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:
RTCxRTC Instance
Return values:
Returnedvalue 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 1645 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:
RTCxRTC Instance
Day0x01. . .0x31
Return values:
None

Definition at line 1591 of file stm32l4xx_ll_rtc.h.

__STATIC_INLINE void LL_RTC_ALMA_SetHour ( RTC_TypeDef *  RTCx,
uint32_t  Hour 
)

Set ALARM A Hour in BCD format.

Note:
helper macro __LL_RTC_CONVERT_BIN2BCD is available to convert Hour from binary to BCD format ALRMAR HT LL_RTC_ALMA_SetHour
ALRMAR HU LL_RTC_ALMA_SetHour
Parameters:
RTCxRTC Instance
Hour0x01. . .0x12 or 0x00. . .0x23
Return values:
None

Definition at line 1686 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:
RTCxRTC Instance
MaskThis 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 1535 of file stm32l4xx_ll_rtc.h.

__STATIC_INLINE void LL_RTC_ALMA_SetMinute ( RTC_TypeDef *  RTCx,
uint32_t  Minute 
)

Set ALARM A Minute in BCD format.

Note:
helper macro __LL_RTC_CONVERT_BIN2BCD is available to convert Minute from binary to BCD format ALRMAR MNT LL_RTC_ALMA_SetMinute
ALRMAR MNU LL_RTC_ALMA_SetMinute
Parameters:
RTCxRTC Instance
Minute0x00. . .0x59
Return values:
None

Definition at line 1717 of file stm32l4xx_ll_rtc.h.

__STATIC_INLINE void LL_RTC_ALMA_SetSecond ( RTC_TypeDef *  RTCx,
uint32_t  Second 
)

Set ALARM A Second in BCD format.

Note:
helper macro __LL_RTC_CONVERT_BIN2BCD is available to convert Second from binary to BCD format ALRMAR ST LL_RTC_ALMA_SetSecond
ALRMAR SU LL_RTC_ALMA_SetSecond
Parameters:
RTCxRTC Instance
Second0x00. . .0x59
Return values:
None

Definition at line 1748 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:
RTCxRTC Instance
Subsecond0. . .0x7FFF
Return values:
None

Definition at line 1849 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:
RTCxRTC Instance
Mask0. . .0xF
Return values:
None

Definition at line 1826 of file stm32l4xx_ll_rtc.h.

__STATIC_INLINE void LL_RTC_ALMA_SetTimeFormat ( RTC_TypeDef *  RTCx,
uint32_t  Format 
)

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

Parameters:
RTCxRTC Instance
FormatThis 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 1659 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:
RTCxRTC Instance
WeekDayThis 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 1627 of file stm32l4xx_ll_rtc.h.