STM32H735xx HAL User Manual
Functions
Extended RTC Tamper functions
RTC Exported Functions

Extended RTC Tamper functions. More...

Functions

HAL_StatusTypeDef HAL_RTCEx_SetTamper (RTC_HandleTypeDef *hrtc, RTC_TamperTypeDef *sTamper)
 Set Tamper.
HAL_StatusTypeDef HAL_RTCEx_SetTamper_IT (RTC_HandleTypeDef *hrtc, RTC_TamperTypeDef *sTamper)
 Set Tamper with interrupt.
HAL_StatusTypeDef HAL_RTCEx_DeactivateTamper (RTC_HandleTypeDef *hrtc, uint32_t Tamper)
 Deactivate Tamper.
__weak void HAL_RTCEx_Tamper1EventCallback (RTC_HandleTypeDef *hrtc)
 Tamper 1 callback.
__weak void HAL_RTCEx_Tamper2EventCallback (RTC_HandleTypeDef *hrtc)
 Tamper 2 callback.
__weak void HAL_RTCEx_Tamper3EventCallback (RTC_HandleTypeDef *hrtc)
 Tamper 3 callback.
__weak void HAL_RTCEx_InternalTamper1EventCallback (RTC_HandleTypeDef *hrtc)
 Internal Tamper 1 callback.
__weak void HAL_RTCEx_InternalTamper2EventCallback (RTC_HandleTypeDef *hrtc)
 Internal Tamper 2 callback.
__weak void HAL_RTCEx_InternalTamper3EventCallback (RTC_HandleTypeDef *hrtc)
 Internal Tamper 3 callback.
__weak void HAL_RTCEx_InternalTamper4EventCallback (RTC_HandleTypeDef *hrtc)
 Internal Tamper 4 callback.
__weak void HAL_RTCEx_InternalTamper5EventCallback (RTC_HandleTypeDef *hrtc)
 Internal Tamper 5 callback.
__weak void HAL_RTCEx_InternalTamper6EventCallback (RTC_HandleTypeDef *hrtc)
 Internal Tamper 6 callback.
__weak void HAL_RTCEx_InternalTamper8EventCallback (RTC_HandleTypeDef *hrtc)
 Internal Tamper 8 callback.
HAL_StatusTypeDef HAL_RTCEx_PollForTamper1Event (RTC_HandleTypeDef *hrtc, uint32_t Timeout)
 Handle Tamper1 Polling.
HAL_StatusTypeDef HAL_RTCEx_PollForTamper2Event (RTC_HandleTypeDef *hrtc, uint32_t Timeout)
 Handle Tamper2 Polling.
HAL_StatusTypeDef HAL_RTCEx_PollForTamper3Event (RTC_HandleTypeDef *hrtc, uint32_t Timeout)
 Handle Tamper3 Polling.

Detailed Description

Extended RTC Tamper functions.

 ==============================================================================
                        ##### Tamper functions #####
 ==============================================================================
 [..]
  (+) Before calling any tamper or internal tamper function, you have to call first
      HAL_RTC_Init() function.
  (+) In that ine you can select to output tamper event on RTC pin.
 [..]
  (+) Enable the Tamper and configure the Tamper filter count, trigger Edge
      or Level according to the Tamper filter (if equal to 0 Edge else Level)
      value, sampling frequency, NoErase, MaskFlag, precharge or discharge and
      Pull-UP, timestamp using the HAL_RTCEx_SetTamper() function.
      You can configure Tamper with interrupt mode using HAL_RTCEx_SetTamper_IT() function.
  (+) The default configuration of the Tamper erases the backup registers. To avoid
      erase, enable the NoErase field on the TAMP_TAMPCR register.
 [..]
  (+) Enable Internal Tamper and configure it with interrupt, timestamp using
      the HAL_RTCEx_SetInternalTamper() function.


Function Documentation

HAL_StatusTypeDef HAL_RTCEx_DeactivateTamper ( RTC_HandleTypeDef hrtc,
uint32_t  Tamper 
)

Deactivate Tamper.

Parameters:
hrtcRTC handle
TamperSelected tamper pin. This parameter can be any combination of the following values:
  • RTC_TAMPER_1
  • RTC_TAMPER_2
  • RTC_TAMPER_3
Return values:
HALstatus

Definition at line 991 of file stm32h7xx_hal_rtc_ex.c.

References assert_param, HAL_RTC_STATE_BUSY, HAL_RTC_STATE_READY, __RTC_HandleTypeDef::Instance, IS_RTC_TAMPER, RTC_IT_TAMP, RTC_IT_TAMP1, RTC_IT_TAMP2, RTC_IT_TAMP3, RTC_TAMPER_1, RTC_TAMPER_2, RTC_TAMPER_3, and __RTC_HandleTypeDef::State.

Internal Tamper 1 callback.

Parameters:
hrtcRTC handle
Return values:
None

Definition at line 1671 of file stm32h7xx_hal_rtc_ex.c.

Referenced by HAL_RTC_Init(), and HAL_RTC_UnRegisterCallback().

Internal Tamper 2 callback.

Parameters:
hrtcRTC handle
Return values:
None

Definition at line 1686 of file stm32h7xx_hal_rtc_ex.c.

Referenced by HAL_RTC_Init(), and HAL_RTC_UnRegisterCallback().

Internal Tamper 3 callback.

Parameters:
hrtcRTC handle
Return values:
None

Definition at line 1701 of file stm32h7xx_hal_rtc_ex.c.

Referenced by HAL_RTC_Init(), and HAL_RTC_UnRegisterCallback().

Internal Tamper 4 callback.

Parameters:
hrtcRTC handle
Return values:
None

Definition at line 1716 of file stm32h7xx_hal_rtc_ex.c.

Referenced by HAL_RTC_Init(), and HAL_RTC_UnRegisterCallback().

Internal Tamper 5 callback.

Parameters:
hrtcRTC handle
Return values:
None

Definition at line 1731 of file stm32h7xx_hal_rtc_ex.c.

Referenced by HAL_RTC_Init(), and HAL_RTC_UnRegisterCallback().

Internal Tamper 6 callback.

Parameters:
hrtcRTC handle
Return values:
None

Definition at line 1746 of file stm32h7xx_hal_rtc_ex.c.

Referenced by HAL_RTC_Init(), and HAL_RTC_UnRegisterCallback().

Internal Tamper 8 callback.

Parameters:
hrtcRTC handle
Return values:
None

Definition at line 1761 of file stm32h7xx_hal_rtc_ex.c.

Referenced by HAL_RTC_Init(), and HAL_RTC_UnRegisterCallback().

HAL_StatusTypeDef HAL_RTCEx_PollForTamper1Event ( RTC_HandleTypeDef hrtc,
uint32_t  Timeout 
)

Handle Tamper1 Polling.

Parameters:
hrtcRTC handle
TimeoutTimeout duration
Return values:
HALstatus

Definition at line 1836 of file stm32h7xx_hal_rtc_ex.c.

References __HAL_RTC_TAMPER_CLEAR_FLAG, __HAL_RTC_TAMPER_GET_FLAG, HAL_GetTick(), HAL_RTC_STATE_READY, HAL_RTC_STATE_TIMEOUT, RTC_FLAG_TAMP1F, and __RTC_HandleTypeDef::State.

HAL_StatusTypeDef HAL_RTCEx_PollForTamper2Event ( RTC_HandleTypeDef hrtc,
uint32_t  Timeout 
)

Handle Tamper2 Polling.

Parameters:
hrtcRTC handle
TimeoutTimeout duration
Return values:
HALstatus

Definition at line 1870 of file stm32h7xx_hal_rtc_ex.c.

References __HAL_RTC_TAMPER_CLEAR_FLAG, __HAL_RTC_TAMPER_GET_FLAG, HAL_GetTick(), HAL_RTC_STATE_READY, HAL_RTC_STATE_TIMEOUT, RTC_FLAG_TAMP2F, and __RTC_HandleTypeDef::State.

HAL_StatusTypeDef HAL_RTCEx_PollForTamper3Event ( RTC_HandleTypeDef hrtc,
uint32_t  Timeout 
)

Handle Tamper3 Polling.

Parameters:
hrtcRTC handle
TimeoutTimeout duration
Return values:
HALstatus

Definition at line 1904 of file stm32h7xx_hal_rtc_ex.c.

References __HAL_RTC_TAMPER_CLEAR_FLAG, __HAL_RTC_TAMPER_GET_FLAG, HAL_GetTick(), HAL_RTC_STATE_READY, HAL_RTC_STATE_TIMEOUT, RTC_FLAG_TAMP3F, and __RTC_HandleTypeDef::State.

HAL_StatusTypeDef HAL_RTCEx_SetTamper ( RTC_HandleTypeDef hrtc,
RTC_TamperTypeDef sTamper 
)
HAL_StatusTypeDef HAL_RTCEx_SetTamper_IT ( RTC_HandleTypeDef hrtc,
RTC_TamperTypeDef sTamper 
)

Tamper 1 callback.

Parameters:
hrtcRTC handle
Return values:
None

Definition at line 1621 of file stm32h7xx_hal_rtc_ex.c.

Referenced by HAL_RTC_Init(), HAL_RTC_UnRegisterCallback(), and HAL_RTCEx_TamperTimeStampIRQHandler().

Tamper 2 callback.

Parameters:
hrtcRTC handle
Return values:
None

Definition at line 1638 of file stm32h7xx_hal_rtc_ex.c.

Referenced by HAL_RTC_Init(), HAL_RTC_UnRegisterCallback(), and HAL_RTCEx_TamperTimeStampIRQHandler().

Tamper 3 callback.

Parameters:
hrtcRTC handle
Return values:
None

Definition at line 1655 of file stm32h7xx_hal_rtc_ex.c.

Referenced by HAL_RTC_Init(), HAL_RTC_UnRegisterCallback(), and HAL_RTCEx_TamperTimeStampIRQHandler().