Hal Drivers for L4

Dependents:   BSP OneHopeOnePrayer FINAL_AUDIO_RECORD AudioDemo

Fork of STM32L4xx_HAL_Driver by Senior Design: Sound Monitor

Embed: (wiki syntax)

« Back to documentation index

Timestamp

Functions

__STATIC_INLINE void LL_RTC_TS_EnableInternalEvent (RTC_TypeDef *RTCx)
 Enable internal event timestamp.
__STATIC_INLINE void LL_RTC_TS_DisableInternalEvent (RTC_TypeDef *RTCx)
 Disable internal event timestamp.
__STATIC_INLINE void LL_RTC_TS_Enable (RTC_TypeDef *RTCx)
 Enable Timestamp.
__STATIC_INLINE void LL_RTC_TS_Disable (RTC_TypeDef *RTCx)
 Disable Timestamp.
__STATIC_INLINE void LL_RTC_TS_SetActiveEdge (RTC_TypeDef *RTCx, uint32_t Edge)
 Set Time-stamp event active edge.
__STATIC_INLINE uint32_t LL_RTC_TS_GetActiveEdge (RTC_TypeDef *RTCx)
 Get Time-stamp event active edge.
__STATIC_INLINE uint32_t LL_RTC_TS_GetTimeFormat (RTC_TypeDef *RTCx)
 Get Timestamp AM/PM notation (AM or 24-hour format) TSTR PM LL_RTC_TS_GetTimeFormat.
__STATIC_INLINE uint32_t LL_RTC_TS_GetHour (RTC_TypeDef *RTCx)
 Get Timestamp Hour in BCD format.
__STATIC_INLINE uint32_t LL_RTC_TS_GetMinute (RTC_TypeDef *RTCx)
 Get Timestamp Minute in BCD format.
__STATIC_INLINE uint32_t LL_RTC_TS_GetSecond (RTC_TypeDef *RTCx)
 Get Timestamp Second in BCD format.
__STATIC_INLINE uint32_t LL_RTC_TS_GetTime (RTC_TypeDef *RTCx)
 Get Timestamp time (hour, minute and second) in BCD format.
__STATIC_INLINE uint32_t LL_RTC_TS_GetWeekDay (RTC_TypeDef *RTCx)
 Get Timestamp Week day TSDR WDU LL_RTC_TS_GetWeekDay.
__STATIC_INLINE uint32_t LL_RTC_TS_GetMonth (RTC_TypeDef *RTCx)
 Get Timestamp Month in BCD format.
__STATIC_INLINE uint32_t LL_RTC_TS_GetDay (RTC_TypeDef *RTCx)
 Get Timestamp Day in BCD format.
__STATIC_INLINE uint32_t LL_RTC_TS_GetDate (RTC_TypeDef *RTCx)
 Get Timestamp date (WeekDay, Day and Month) in BCD format.
__STATIC_INLINE uint32_t LL_RTC_TS_GetSubSecond (RTC_TypeDef *RTCx)
 Get time-stamp sub second value TSSSR SS LL_RTC_TS_GetSubSecond.
__STATIC_INLINE void LL_RTC_TS_EnableOnTamper (RTC_TypeDef *RTCx)
 Activate timestamp on tamper detection event TAMPCR TAMPTS LL_RTC_TS_EnableOnTamper.
__STATIC_INLINE void LL_RTC_TS_DisableOnTamper (RTC_TypeDef *RTCx)
 Disable timestamp on tamper detection event TAMPCR TAMPTS LL_RTC_TS_DisableOnTamper.

Function Documentation

__STATIC_INLINE void LL_RTC_TS_Disable ( RTC_TypeDef *  RTCx )

Disable Timestamp.

Note:
Bit is write-protected. LL_RTC_DisableWriteProtection function should be called before. CR TSE LL_RTC_TS_Disable
Parameters:
RTCxRTC Instance
Return values:
None

Definition at line 2294 of file stm32l4xx_ll_rtc.h.

__STATIC_INLINE void LL_RTC_TS_DisableInternalEvent ( RTC_TypeDef *  RTCx )

Disable internal event timestamp.

Note:
Bit is write-protected. LL_RTC_DisableWriteProtection function should be called before. CR ITSE LL_RTC_TS_DisableInternalEvent
Parameters:
RTCxRTC Instance
Return values:
None

Definition at line 2270 of file stm32l4xx_ll_rtc.h.

__STATIC_INLINE void LL_RTC_TS_DisableOnTamper ( RTC_TypeDef *  RTCx )

Disable timestamp on tamper detection event TAMPCR TAMPTS LL_RTC_TS_DisableOnTamper.

Parameters:
RTCxRTC Instance
Return values:
None

Definition at line 2501 of file stm32l4xx_ll_rtc.h.

__STATIC_INLINE void LL_RTC_TS_Enable ( RTC_TypeDef *  RTCx )

Enable Timestamp.

Note:
Bit is write-protected. LL_RTC_DisableWriteProtection function should be called before. CR TSE LL_RTC_TS_Enable
Parameters:
RTCxRTC Instance
Return values:
None

Definition at line 2282 of file stm32l4xx_ll_rtc.h.

__STATIC_INLINE void LL_RTC_TS_EnableInternalEvent ( RTC_TypeDef *  RTCx )

Enable internal event timestamp.

Note:
Bit is write-protected. LL_RTC_DisableWriteProtection function should be called before. CR ITSE LL_RTC_TS_EnableInternalEvent
Parameters:
RTCxRTC Instance
Return values:
None

Definition at line 2258 of file stm32l4xx_ll_rtc.h.

__STATIC_INLINE void LL_RTC_TS_EnableOnTamper ( RTC_TypeDef *  RTCx )

Activate timestamp on tamper detection event TAMPCR TAMPTS LL_RTC_TS_EnableOnTamper.

Parameters:
RTCxRTC Instance
Return values:
None

Definition at line 2490 of file stm32l4xx_ll_rtc.h.

__STATIC_INLINE uint32_t LL_RTC_TS_GetActiveEdge ( RTC_TypeDef *  RTCx )

Get Time-stamp event active edge.

Note:
Bit is write-protected. LL_RTC_DisableWriteProtection function should be called before. CR TSEDGE LL_RTC_TS_GetActiveEdge
Parameters:
RTCxRTC Instance
Return values:
Returnedvalue can be one of the following values:

  • LL_RTC_TIMESTAMP_EDGE_RISING
  • LL_RTC_TIMESTAMP_EDGE_FALLING

Definition at line 2324 of file stm32l4xx_ll_rtc.h.

__STATIC_INLINE uint32_t LL_RTC_TS_GetDate ( RTC_TypeDef *  RTCx )

Get Timestamp date (WeekDay, Day and Month) in BCD format.

Note:
helper macros __LL_RTC_GET_WEEKDAY, __LL_RTC_GET_MONTH, and __LL_RTC_GET_DAY are available to get independently each parameter. TSDR WDU LL_RTC_TS_GetDate
TSDR MT LL_RTC_TS_GetDate
TSDR MU LL_RTC_TS_GetDate
TSDR DT LL_RTC_TS_GetDate
TSDR DU LL_RTC_TS_GetDate
Parameters:
RTCxRTC Instance
Return values:
Combinationof Weekday, Day and Month

Definition at line 2468 of file stm32l4xx_ll_rtc.h.

__STATIC_INLINE uint32_t LL_RTC_TS_GetDay ( RTC_TypeDef *  RTCx )

Get Timestamp Day in BCD format.

Note:
helper macro __LL_RTC_CONVERT_BCD2BIN is available to convert Day from BCD to Binary format TSDR DT LL_RTC_TS_GetDay
TSDR DU LL_RTC_TS_GetDay
Parameters:
RTCxRTC Instance
Return values:
0x01.. .0x31

Definition at line 2451 of file stm32l4xx_ll_rtc.h.

__STATIC_INLINE uint32_t LL_RTC_TS_GetHour ( RTC_TypeDef *  RTCx )

Get Timestamp Hour in BCD format.

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

Definition at line 2350 of file stm32l4xx_ll_rtc.h.

__STATIC_INLINE uint32_t LL_RTC_TS_GetMinute ( RTC_TypeDef *  RTCx )

Get Timestamp Minute in BCD format.

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

Definition at line 2363 of file stm32l4xx_ll_rtc.h.

__STATIC_INLINE uint32_t LL_RTC_TS_GetMonth ( RTC_TypeDef *  RTCx )

Get Timestamp Month in BCD format.

Note:
helper macro __LL_RTC_CONVERT_BCD2BIN is available to convert Month from BCD to Binary format TSDR MT LL_RTC_TS_GetMonth
TSDR MU LL_RTC_TS_GetMonth
Parameters:
RTCxRTC Instance
Return values:
Returnedvalue can be one of the following values:

  • LL_RTC_MONTH_JANUARY
  • LL_RTC_MONTH_FEBRUARY
  • LL_RTC_MONTH_MARCH
  • LL_RTC_MONTH_APRIL
  • LL_RTC_MONTH_MAY
  • LL_RTC_MONTH_JUNE
  • LL_RTC_MONTH_JULY
  • LL_RTC_MONTH_AUGUST
  • LL_RTC_MONTH_SEPTEMBER
  • LL_RTC_MONTH_OCTOBER
  • LL_RTC_MONTH_NOVEMBER
  • LL_RTC_MONTH_DECEMBER

Definition at line 2438 of file stm32l4xx_ll_rtc.h.

__STATIC_INLINE uint32_t LL_RTC_TS_GetSecond ( RTC_TypeDef *  RTCx )

Get Timestamp Second in BCD format.

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

Definition at line 2376 of file stm32l4xx_ll_rtc.h.

__STATIC_INLINE uint32_t LL_RTC_TS_GetSubSecond ( RTC_TypeDef *  RTCx )

Get time-stamp sub second value TSSSR SS LL_RTC_TS_GetSubSecond.

Parameters:
RTCxRTC Instance
Return values:
0x00.. .0xFFFF

Definition at line 2479 of file stm32l4xx_ll_rtc.h.

__STATIC_INLINE uint32_t LL_RTC_TS_GetTime ( RTC_TypeDef *  RTCx )

Get Timestamp 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. TSTR HT LL_RTC_TS_GetTime
TSTR HU LL_RTC_TS_GetTime
TSTR MNT LL_RTC_TS_GetTime
TSTR MNU LL_RTC_TS_GetTime
TSTR ST LL_RTC_TS_GetTime
TSTR SU LL_RTC_TS_GetTime
Parameters:
RTCxRTC Instance
Return values:
Combinationof hours, minutes and seconds.

Definition at line 2394 of file stm32l4xx_ll_rtc.h.

__STATIC_INLINE uint32_t LL_RTC_TS_GetTimeFormat ( RTC_TypeDef *  RTCx )

Get Timestamp AM/PM notation (AM or 24-hour format) TSTR PM LL_RTC_TS_GetTimeFormat.

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

  • LL_RTC_TS_TIME_FORMAT_AM
  • LL_RTC_TS_TIME_FORMAT_PM

Definition at line 2337 of file stm32l4xx_ll_rtc.h.

__STATIC_INLINE uint32_t LL_RTC_TS_GetWeekDay ( RTC_TypeDef *  RTCx )

Get Timestamp Week day TSDR WDU LL_RTC_TS_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 2413 of file stm32l4xx_ll_rtc.h.

__STATIC_INLINE void LL_RTC_TS_SetActiveEdge ( RTC_TypeDef *  RTCx,
uint32_t  Edge 
)

Set Time-stamp event active edge.

Note:
Bit is write-protected. LL_RTC_DisableWriteProtection function should be called before.
TSE must be reset when TSEDGE is changed to avoid unwanted TSF setting CR TSEDGE LL_RTC_TS_SetActiveEdge
Parameters:
RTCxRTC Instance
EdgeThis parameter can be one of the following values:

  • LL_RTC_TIMESTAMP_EDGE_RISING
  • LL_RTC_TIMESTAMP_EDGE_FALLING
Return values:
None

Definition at line 2310 of file stm32l4xx_ll_rtc.h.