RTC TimeStamp and Tamper functions. More...

Functions
HAL_StatusTypeDef	HAL_RTCEx_SetTimeStamp (RTC_HandleTypeDef *hrtc, uint32_t TimeStampEdge, uint32_t RTC_TimeStampPin)
	Sets TimeStamp.
HAL_StatusTypeDef	HAL_RTCEx_SetTimeStamp_IT (RTC_HandleTypeDef *hrtc, uint32_t TimeStampEdge, uint32_t RTC_TimeStampPin)
	Sets TimeStamp with Interrupt.
HAL_StatusTypeDef	HAL_RTCEx_DeactivateTimeStamp (RTC_HandleTypeDef *hrtc)
	Deactivates TimeStamp.
HAL_StatusTypeDef	HAL_RTCEx_GetTimeStamp (RTC_HandleTypeDef hrtc, RTC_TimeTypeDef sTimeStamp, RTC_DateTypeDef *sTimeStampDate, uint32_t Format)
	Gets the RTC TimeStamp value.
HAL_StatusTypeDef	HAL_RTCEx_SetTamper (RTC_HandleTypeDef hrtc, RTC_TamperTypeDef sTamper)
	Sets Tamper.
HAL_StatusTypeDef	HAL_RTCEx_SetTamper_IT (RTC_HandleTypeDef hrtc, RTC_TamperTypeDef sTamper)
	Sets Tamper with interrupt.
HAL_StatusTypeDef	HAL_RTCEx_DeactivateTamper (RTC_HandleTypeDef *hrtc, uint32_t Tamper)
	Deactivates Tamper.
void	HAL_RTCEx_TamperTimeStampIRQHandler (RTC_HandleTypeDef *hrtc)
	This function handles TimeStamp interrupt request.
__weak void	HAL_RTCEx_TimeStampEventCallback (RTC_HandleTypeDef *hrtc)
	TimeStamp callback.
__weak void	HAL_RTCEx_Tamper1EventCallback (RTC_HandleTypeDef *hrtc)
	Tamper 1 callback.
__weak void	HAL_RTCEx_Tamper2EventCallback (RTC_HandleTypeDef *hrtc)
	Tamper 2 callback.
HAL_StatusTypeDef	HAL_RTCEx_PollForTimeStampEvent (RTC_HandleTypeDef *hrtc, uint32_t Timeout)
	This function handles TimeStamp polling request.
HAL_StatusTypeDef	HAL_RTCEx_PollForTamper1Event (RTC_HandleTypeDef *hrtc, uint32_t Timeout)
	This function handles Tamper1 Polling.
HAL_StatusTypeDef	HAL_RTCEx_PollForTamper2Event (RTC_HandleTypeDef *hrtc, uint32_t Timeout)
	This function handles Tamper2 Polling.

Detailed Description

RTC TimeStamp and Tamper functions.

 ===============================================================================
                 ##### RTC TimeStamp and Tamper functions #####
 ===============================================================================

 [..] This section provides functions allowing to configure TimeStamp feature

Function Documentation

HAL_StatusTypeDef HAL_RTCEx_DeactivateTamper	(	RTC_HandleTypeDef *	hrtc,
		uint32_t	Tamper
	)

Deactivates Tamper.

Parameters:

hrtc	pointer to a RTC_HandleTypeDef structure that contains the configuration information for RTC.
Tamper	Selected tamper pin. This parameter can be RTC_Tamper_1 and/or RTC_TAMPER_2.

Return values:

HAL status

Definition at line 474 of file stm32f4xx_hal_rtc_ex.c.

References assert_param, HAL_RTC_STATE_BUSY, HAL_RTC_STATE_READY, __RTC_HandleTypeDef::Instance, IS_RTC_TAMPER, and __RTC_HandleTypeDef::State.

HAL_StatusTypeDef HAL_RTCEx_DeactivateTimeStamp ( RTC_HandleTypeDef * hrtc )

Deactivates TimeStamp.

Parameters:

hrtc	pointer to a RTC_HandleTypeDef structure that contains the configuration information for RTC.

Return values:

HAL status

Definition at line 258 of file stm32f4xx_hal_rtc_ex.c.

References __HAL_RTC_TIMESTAMP_DISABLE_IT, __HAL_RTC_WRITEPROTECTION_DISABLE, __HAL_RTC_WRITEPROTECTION_ENABLE, HAL_RTC_STATE_BUSY, HAL_RTC_STATE_READY, __RTC_HandleTypeDef::Instance, RTC_IT_TS, and __RTC_HandleTypeDef::State.

HAL_StatusTypeDef HAL_RTCEx_GetTimeStamp	(	RTC_HandleTypeDef *	hrtc,
		RTC_TimeTypeDef *	sTimeStamp,
		RTC_DateTypeDef *	sTimeStampDate,
		uint32_t	Format
	)

Gets the RTC TimeStamp value.

Parameters:

hrtc	pointer to a RTC_HandleTypeDef structure that contains the configuration information for RTC.
sTimeStamp	Pointer to Time structure
sTimeStampDate	Pointer to Date structure
Format	specifies the format of the entered parameters. This parameter can be one of the following values: RTC_FORMAT_BIN: Binary data format RTC_FORMAT_BCD: BCD data format

Return values:

HAL status

Definition at line 302 of file stm32f4xx_hal_rtc_ex.c.

References __HAL_RTC_TIMESTAMP_CLEAR_FLAG, assert_param, RTC_DateTypeDef::Date, RTC_TimeTypeDef::Hours, __RTC_HandleTypeDef::Instance, IS_RTC_FORMAT, RTC_TimeTypeDef::Minutes, RTC_DateTypeDef::Month, RTC_Bcd2ToByte(), RTC_DR_RESERVED_MASK, RTC_FLAG_TSF, RTC_FORMAT_BIN, RTC_TR_RESERVED_MASK, RTC_TimeTypeDef::Seconds, RTC_TimeTypeDef::SubSeconds, RTC_TimeTypeDef::TimeFormat, RTC_DateTypeDef::WeekDay, and RTC_DateTypeDef::Year.

HAL_StatusTypeDef HAL_RTCEx_PollForTamper1Event	(	RTC_HandleTypeDef *	hrtc,
		uint32_t	Timeout
	)

This function handles Tamper1 Polling.

Parameters:

hrtc	pointer to a RTC_HandleTypeDef structure that contains the configuration information for RTC.
Timeout	Timeout duration

Return values:

HAL status

Definition at line 658 of file stm32f4xx_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
	)

This function handles Tamper2 Polling.

Parameters:

hrtc	pointer to a RTC_HandleTypeDef structure that contains the configuration information for RTC.
Timeout	Timeout duration

Return values:

HAL status

Definition at line 694 of file stm32f4xx_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_PollForTimeStampEvent	(	RTC_HandleTypeDef *	hrtc,
		uint32_t	Timeout
	)

This function handles TimeStamp polling request.

Parameters:

hrtc	pointer to a RTC_HandleTypeDef structure that contains the configuration information for RTC.
Timeout	Timeout duration

Return values:

HAL status

Definition at line 615 of file stm32f4xx_hal_rtc_ex.c.

References __HAL_RTC_TIMESTAMP_CLEAR_FLAG, __HAL_RTC_TIMESTAMP_GET_FLAG, HAL_GetTick(), HAL_RTC_STATE_ERROR, HAL_RTC_STATE_READY, HAL_RTC_STATE_TIMEOUT, RTC_FLAG_TSF, RTC_FLAG_TSOVF, and __RTC_HandleTypeDef::State.

HAL_StatusTypeDef HAL_RTCEx_SetTamper	(	RTC_HandleTypeDef *	hrtc,
		RTC_TamperTypeDef *	sTamper
	)

Sets Tamper.

Note:: By calling this API we disable the tamper interrupt for all tampers.

Parameters:

hrtc	pointer to a RTC_HandleTypeDef structure that contains the configuration information for RTC.
sTamper	Pointer to Tamper Structure.

Return values:

HAL status

Definition at line 354 of file stm32f4xx_hal_rtc_ex.c.

References assert_param, RTC_TamperTypeDef::Filter, HAL_RTC_STATE_BUSY, HAL_RTC_STATE_READY, __RTC_HandleTypeDef::Instance, IS_RTC_TAMPER, IS_RTC_TAMPER_FILTER, IS_RTC_TAMPER_PIN, IS_RTC_TAMPER_PRECHARGE_DURATION, IS_RTC_TAMPER_PULLUP_STATE, IS_RTC_TAMPER_SAMPLING_FREQ, IS_RTC_TAMPER_TIMESTAMPONTAMPER_DETECTION, IS_RTC_TAMPER_TRIGGER, RTC_TamperTypeDef::PinSelection, RTC_TamperTypeDef::PrechargeDuration, RTC_TAMPERTRIGGER_RISINGEDGE, RTC_TamperTypeDef::SamplingFrequency, __RTC_HandleTypeDef::State, RTC_TamperTypeDef::Tamper, RTC_TamperTypeDef::TamperPullUp, RTC_TamperTypeDef::TimeStampOnTamperDetection, and RTC_TamperTypeDef::Trigger.

HAL_StatusTypeDef HAL_RTCEx_SetTamper_IT	(	RTC_HandleTypeDef *	hrtc,
		RTC_TamperTypeDef *	sTamper
	)

Sets Tamper with interrupt.

Note:: By calling this API we force the tamper interrupt for all tampers.

Parameters:

hrtc	pointer to a RTC_HandleTypeDef structure that contains the configuration information for RTC.
sTamper	Pointer to RTC Tamper.

Return values:

HAL status

Definition at line 404 of file stm32f4xx_hal_rtc_ex.c.

References __HAL_RTC_TAMPER_CLEAR_FLAG, __HAL_RTC_TAMPER_TIMESTAMP_EXTI_ENABLE_IT, assert_param, RTC_TamperTypeDef::Filter, HAL_RTC_STATE_BUSY, HAL_RTC_STATE_READY, __RTC_HandleTypeDef::Instance, IS_RTC_TAMPER, IS_RTC_TAMPER_FILTER, IS_RTC_TAMPER_PIN, IS_RTC_TAMPER_PRECHARGE_DURATION, IS_RTC_TAMPER_PULLUP_STATE, IS_RTC_TAMPER_SAMPLING_FREQ, IS_RTC_TAMPER_TIMESTAMPONTAMPER_DETECTION, IS_RTC_TAMPER_TRIGGER, RTC_TamperTypeDef::PinSelection, RTC_TamperTypeDef::PrechargeDuration, RTC_EXTI_LINE_TAMPER_TIMESTAMP_EVENT, RTC_FLAG_TAMP1F, RTC_FLAG_TAMP2F, RTC_TAMPER_1, RTC_TAMPERTRIGGER_RISINGEDGE, RTC_TamperTypeDef::SamplingFrequency, __RTC_HandleTypeDef::State, RTC_TamperTypeDef::Tamper, RTC_TamperTypeDef::TamperPullUp, RTC_TamperTypeDef::TimeStampOnTamperDetection, and RTC_TamperTypeDef::Trigger.

HAL_StatusTypeDef HAL_RTCEx_SetTimeStamp	(	RTC_HandleTypeDef *	hrtc,
		uint32_t	TimeStampEdge,
		uint32_t	RTC_TimeStampPin
	)

Sets TimeStamp.

Note:: This API must be called before enabling the TimeStamp feature.

Parameters:

hrtc	pointer to a RTC_HandleTypeDef structure that contains the configuration information for RTC.
TimeStampEdge	Specifies the pin edge on which the TimeStamp is activated. This parameter can be one of the following values: RTC_TIMESTAMPEDGE_RISING: the Time stamp event occurs on the rising edge of the related pin. RTC_TIMESTAMPEDGE_FALLING: the Time stamp event occurs on the falling edge of the related pin.
RTC_TimeStampPin	specifies the RTC TimeStamp Pin. This parameter can be one of the following values: RTC_TIMESTAMPPIN_DEFAULT: PC13 is selected as RTC TimeStamp Pin. RTC_TIMESTAMPPIN_POS1: PI8/PA0 is selected as RTC TimeStamp Pin. (not applicable in the case of STM32F412xx, STM32F413xx and STM32F423xx devices) (PI8 for all STM32 devices except for STM32F446xx devices the PA0 is used) RTC_TIMESTAMPPIN_PA0: PA0 is selected as RTC TimeStamp Pin only for STM32F446xx devices

Return values:

HAL status

Definition at line 141 of file stm32f4xx_hal_rtc_ex.c.

References __HAL_RTC_TIMESTAMP_ENABLE, __HAL_RTC_WRITEPROTECTION_DISABLE, __HAL_RTC_WRITEPROTECTION_ENABLE, assert_param, HAL_RTC_STATE_BUSY, HAL_RTC_STATE_READY, __RTC_HandleTypeDef::Instance, IS_RTC_TIMESTAMP_PIN, IS_TIMESTAMP_EDGE, and __RTC_HandleTypeDef::State.

HAL_StatusTypeDef HAL_RTCEx_SetTimeStamp_IT	(	RTC_HandleTypeDef *	hrtc,
		uint32_t	TimeStampEdge,
		uint32_t	RTC_TimeStampPin
	)

Sets TimeStamp with Interrupt.

Parameters:

hrtc	pointer to a RTC_HandleTypeDef structure that contains the configuration information for RTC.

Note:: This API must be called before enabling the TimeStamp feature.

Parameters:

TimeStampEdge	Specifies the pin edge on which the TimeStamp is activated. This parameter can be one of the following values: RTC_TIMESTAMPEDGE_RISING: the Time stamp event occurs on the rising edge of the related pin. RTC_TIMESTAMPEDGE_FALLING: the Time stamp event occurs on the falling edge of the related pin.
RTC_TimeStampPin	Specifies the RTC TimeStamp Pin. This parameter can be one of the following values: RTC_TIMESTAMPPIN_DEFAULT: PC13 is selected as RTC TimeStamp Pin. RTC_TIMESTAMPPIN_PI8: PI8 is selected as RTC TimeStamp Pin. (not applicable in the case of STM32F446xx, STM32F412xx, STM32F413xx and STM32F423xx devices) RTC_TIMESTAMPPIN_PA0: PA0 is selected as RTC TimeStamp Pin only for STM32F446xx devices