STM32F4xx HAL Documentation
Hardware Abstraction Layer for STM32F4 familiy
Loading...
Searching...
No Matches
Collaboration diagram for RTCEx Tamper:

Macros

#define __HAL_RTC_TAMPER1_ENABLE(__HANDLE__)
 Enable the RTC Tamper1 input detection.
 
#define __HAL_RTC_TAMPER1_DISABLE(__HANDLE__)
 Disable the RTC Tamper1 input detection.
 
#define __HAL_RTC_TAMPER_ENABLE_IT(__HANDLE__, __INTERRUPT__)
 Enable the RTC Tamper interrupt.
 
#define __HAL_RTC_TAMPER_DISABLE_IT(__HANDLE__, __INTERRUPT__)
 Disable the RTC Tamper interrupt.
 
#define __HAL_RTC_TAMPER_GET_IT_SOURCE(__HANDLE__, __INTERRUPT__)
 Check whether the specified RTC Tamper interrupt has been enabled or not.
 
#define __HAL_RTC_TAMPER_GET_FLAG(__HANDLE__, __FLAG__)
 Get the selected RTC Tamper's flag status.
 
#define __HAL_RTC_TAMPER_CLEAR_FLAG(__HANDLE__, __FLAG__)
 Clear the RTC Tamper's pending flags.
 

Detailed Description

Macro Definition Documentation

◆ __HAL_RTC_TAMPER1_ENABLE

#define __HAL_RTC_TAMPER1_ENABLE ( __HANDLE__)

#include <stm32f4xx_hal_rtc_ex.h>

Value:
((__HANDLE__)->Instance->TAFCR |= (RTC_TAFCR_TAMP1E))

Enable the RTC Tamper1 input detection.

Parameters
__HANDLE__specifies the RTC handle.
Return values
None

Definition at line 593 of file stm32f4xx_hal_rtc_ex.h.

◆ __HAL_RTC_TAMPER1_DISABLE

#define __HAL_RTC_TAMPER1_DISABLE ( __HANDLE__)

#include <stm32f4xx_hal_rtc_ex.h>

Value:
((__HANDLE__)->Instance->TAFCR &= ~(RTC_TAFCR_TAMP1E))

Disable the RTC Tamper1 input detection.

Parameters
__HANDLE__specifies the RTC handle.
Return values
None

Definition at line 600 of file stm32f4xx_hal_rtc_ex.h.

◆ __HAL_RTC_TAMPER_ENABLE_IT

#define __HAL_RTC_TAMPER_ENABLE_IT ( __HANDLE__,
__INTERRUPT__ )

#include <stm32f4xx_hal_rtc_ex.h>

Value:
((__HANDLE__)->Instance->TAFCR |= (__INTERRUPT__))

Enable the RTC Tamper interrupt.

Parameters
__HANDLE__specifies the RTC handle.
__INTERRUPT__specifies the RTC Tamper interrupt sources to be enabled. This parameter can be any combination of the following values:
  • RTC_IT_TAMP: Tamper global interrupt
Return values
None

Definition at line 626 of file stm32f4xx_hal_rtc_ex.h.

◆ __HAL_RTC_TAMPER_DISABLE_IT

#define __HAL_RTC_TAMPER_DISABLE_IT ( __HANDLE__,
__INTERRUPT__ )

#include <stm32f4xx_hal_rtc_ex.h>

Value:
((__HANDLE__)->Instance->TAFCR &= ~(__INTERRUPT__))

Disable the RTC Tamper interrupt.

Parameters
__HANDLE__specifies the RTC handle.
__INTERRUPT__specifies the RTC Tamper interrupt sources to be disabled. This parameter can be any combination of the following values:
  • RTC_IT_TAMP: Tamper global interrupt
Return values
None

Definition at line 636 of file stm32f4xx_hal_rtc_ex.h.

◆ __HAL_RTC_TAMPER_GET_IT_SOURCE

#define __HAL_RTC_TAMPER_GET_IT_SOURCE ( __HANDLE__,
__INTERRUPT__ )

#include <stm32f4xx_hal_rtc_ex.h>

Value:
(((((__HANDLE__)->Instance->TAFCR) & (__INTERRUPT__)) != 0U) ? 1U : 0U)

Check whether the specified RTC Tamper interrupt has been enabled or not.

Parameters
__HANDLE__specifies the RTC handle.
__INTERRUPT__specifies the RTC Tamper interrupt source to check. This parameter can be:
  • RTC_IT_TAMP: Tamper global interrupt
Return values
None

Definition at line 646 of file stm32f4xx_hal_rtc_ex.h.

Referenced by HAL_RTCEx_TamperTimeStampIRQHandler().

◆ __HAL_RTC_TAMPER_GET_FLAG

#define __HAL_RTC_TAMPER_GET_FLAG ( __HANDLE__,
__FLAG__ )

#include <stm32f4xx_hal_rtc_ex.h>

Value:
(((((__HANDLE__)->Instance->ISR) & (__FLAG__)) != 0U)? 1U : 0U)

Get the selected RTC Tamper's flag status.

Parameters
__HANDLE__specifies the RTC handle.
__FLAG__specifies the RTC Tamper flag to be checked. This parameter can be:
  • RTC_FLAG_TAMP1F: Tamper 1 interrupt flag
  • RTC_FLAG_TAMP2F: Tamper 2 interrupt flag
Note
RTC_FLAG_TAMP2F is not applicable to all devices.
Return values
None

Definition at line 658 of file stm32f4xx_hal_rtc_ex.h.

Referenced by HAL_RTCEx_PollForTamper1Event(), and HAL_RTCEx_TamperTimeStampIRQHandler().

◆ __HAL_RTC_TAMPER_CLEAR_FLAG

#define __HAL_RTC_TAMPER_CLEAR_FLAG ( __HANDLE__,
__FLAG__ )

#include <stm32f4xx_hal_rtc_ex.h>

Value:
((__HANDLE__)->Instance->ISR) = (~((__FLAG__) | RTC_ISR_INIT)|((__HANDLE__)->Instance->ISR & RTC_ISR_INIT))

Clear the RTC Tamper's pending flags.

Parameters
__HANDLE__specifies the RTC handle.
__FLAG__specifies the RTC Tamper Flag to clear. This parameter can be:
  • RTC_FLAG_TAMP1F: Tamper 1 interrupt flag
  • RTC_FLAG_TAMP2F: Tamper 2 interrupt flag
Note
RTC_FLAG_TAMP2F is not applicable to all devices.
Return values
None

Definition at line 670 of file stm32f4xx_hal_rtc_ex.h.

Referenced by HAL_RTCEx_PollForTamper1Event(), and HAL_RTCEx_TamperTimeStampIRQHandler().