RTCEx Timestamp

Collaboration diagram for RTCEx Timestamp:

Macros
#define	__HAL_RTC_TIMESTAMP_ENABLE(__HANDLE__)
	Enable the RTC Timestamp peripheral.
#define	__HAL_RTC_TIMESTAMP_DISABLE(__HANDLE__)
	Disable the RTC Timestamp peripheral.
#define	__HAL_RTC_TIMESTAMP_ENABLE_IT(__HANDLE__, __INTERRUPT__)
	Enable the RTC Timestamp interrupt.
#define	__HAL_RTC_TIMESTAMP_DISABLE_IT(__HANDLE__, __INTERRUPT__)
	Disable the RTC Timestamp interrupt.
#define	__HAL_RTC_TIMESTAMP_GET_IT(__HANDLE__, __INTERRUPT__)
	Check whether the specified RTC Timestamp interrupt has occurred or not.
#define	__HAL_RTC_TIMESTAMP_GET_IT_SOURCE(__HANDLE__, __INTERRUPT__)
	Check whether the specified RTC Timestamp interrupt has been enabled or not.
#define	__HAL_RTC_TIMESTAMP_GET_FLAG(__HANDLE__, __FLAG__)
	Get the selected RTC Timestamp's flag status.
#define	__HAL_RTC_TIMESTAMP_CLEAR_FLAG(__HANDLE__, __FLAG__)
	Clear the RTC Timestamp's pending flags.

Detailed Description

Macro Definition Documentation

__HAL_RTC_TIMESTAMP_ENABLE

#define __HAL_RTC_TIMESTAMP_ENABLE

(

__HANDLE__

)

#include <stm32f4xx_hal_rtc_ex.h>

Value:

((__HANDLE__)->Instance->CR |= (RTC_CR_TSE))

Enable the RTC Timestamp peripheral.

Parameters

__HANDLE__

specifies the RTC handle.

Return values

None

Definition at line 507 of file stm32f4xx_hal_rtc_ex.h.

Referenced by HAL_RTCEx_SetTimeStamp(), and HAL_RTCEx_SetTimeStamp_IT().

__HAL_RTC_TIMESTAMP_DISABLE

#define __HAL_RTC_TIMESTAMP_DISABLE

(

__HANDLE__

)

#include <stm32f4xx_hal_rtc_ex.h>

Value:

((__HANDLE__)->Instance->CR &= ~(RTC_CR_TSE))

Disable the RTC Timestamp peripheral.

Parameters

__HANDLE__

specifies the RTC handle.

Return values

None

Definition at line 514 of file stm32f4xx_hal_rtc_ex.h.

__HAL_RTC_TIMESTAMP_ENABLE_IT

#define __HAL_RTC_TIMESTAMP_ENABLE_IT	(		__HANDLE__,
			__INTERRUPT__ )

#include <stm32f4xx_hal_rtc_ex.h>

Value:

((__HANDLE__)->Instance->CR |= (__INTERRUPT__))

Enable the RTC Timestamp interrupt.

Parameters

__HANDLE__	specifies the RTC handle.
__INTERRUPT__	specifies the RTC Timestamp interrupt sources to be enabled or disabled. This parameter can be: RTC_IT_TS: TimeStamp interrupt

Return values

None

Definition at line 524 of file stm32f4xx_hal_rtc_ex.h.

Referenced by HAL_RTCEx_SetTimeStamp_IT().

__HAL_RTC_TIMESTAMP_DISABLE_IT

#define __HAL_RTC_TIMESTAMP_DISABLE_IT	(		__HANDLE__,
			__INTERRUPT__ )

#include <stm32f4xx_hal_rtc_ex.h>

Value:

((__HANDLE__)->Instance->CR &= ~(__INTERRUPT__))

Disable the RTC Timestamp interrupt.

Parameters

__HANDLE__	specifies the RTC handle.
__INTERRUPT__	specifies the RTC Timestamp interrupt sources to be enabled or disabled. This parameter can be: RTC_IT_TS: TimeStamp interrupt

Return values

None

Definition at line 534 of file stm32f4xx_hal_rtc_ex.h.

Referenced by HAL_RTCEx_DeactivateTimeStamp().

__HAL_RTC_TIMESTAMP_GET_IT

#define __HAL_RTC_TIMESTAMP_GET_IT	(		__HANDLE__,
			__INTERRUPT__ )

#include <stm32f4xx_hal_rtc_ex.h>

Value:

(((((__HANDLE__)->Instance->ISR) & ((__INTERRUPT__) >> 4U)) != 0U) ? 1U : 0U)

Check whether the specified RTC Timestamp interrupt has occurred or not.

Parameters

__HANDLE__	specifies the RTC handle.
__INTERRUPT__	specifies the RTC Timestamp interrupt to check. This parameter can be: RTC_IT_TS: TimeStamp interrupt

Return values

None

Definition at line 544 of file stm32f4xx_hal_rtc_ex.h.

__HAL_RTC_TIMESTAMP_GET_IT_SOURCE

#define __HAL_RTC_TIMESTAMP_GET_IT_SOURCE	(		__HANDLE__,
			__INTERRUPT__ )

#include <stm32f4xx_hal_rtc_ex.h>

Value:

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

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

Parameters

__HANDLE__	specifies the RTC handle.
__INTERRUPT__	specifies the RTC Timestamp interrupt source to check. This parameter can be: RTC_IT_TS: TimeStamp interrupt

Return values

None

Definition at line 554 of file stm32f4xx_hal_rtc_ex.h.

Referenced by HAL_RTCEx_TamperTimeStampIRQHandler().

__HAL_RTC_TIMESTAMP_GET_FLAG

#define __HAL_RTC_TIMESTAMP_GET_FLAG	(		__HANDLE__,
			__FLAG__ )

#include <stm32f4xx_hal_rtc_ex.h>

Value:

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

Get the selected RTC Timestamp's flag status.

Parameters

__HANDLE__	specifies the RTC handle.
__FLAG__	specifies the RTC Timestamp flag to check. This parameter can be: RTC_FLAG_TSF: Timestamp interrupt flag RTC_FLAG_TSOVF: Timestamp overflow flag

Return values

None

Definition at line 565 of file stm32f4xx_hal_rtc_ex.h.

Referenced by HAL_RTCEx_PollForTimeStampEvent(), and HAL_RTCEx_TamperTimeStampIRQHandler().

__HAL_RTC_TIMESTAMP_CLEAR_FLAG

#define __HAL_RTC_TIMESTAMP_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 Timestamp's pending flags.

Parameters

__HANDLE__	specifies the RTC handle.
__FLAG__	specifies the RTC Timestamp flag to clear. This parameter can be: RTC_FLAG_TSF: Timestamp interrupt flag RTC_FLAG_TSOVF: Timestamp overflow flag

Return values

None

Definition at line 576 of file stm32f4xx_hal_rtc_ex.h.

Referenced by HAL_RTCEx_GetTimeStamp(), HAL_RTCEx_PollForTimeStampEvent(), HAL_RTCEx_SetTimeStamp(), HAL_RTCEx_SetTimeStamp_IT(), and HAL_RTCEx_TamperTimeStampIRQHandler().