stm32f4xx_hal_rtc_ex.h File Reference

Header file of RTC HAL Extended module. More...

#include "stm32f4xx_hal_def.h"

Include dependency graph for stm32f4xx_hal_rtc_ex.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	RTC_TamperTypeDef
	RTC Tamper structure definition. More...

Macros
#define	RTC_BKP_DR0   0x00000000U
#define	RTC_BKP_DR1   0x00000001U
#define	RTC_BKP_DR2   0x00000002U
#define	RTC_BKP_DR3   0x00000003U
#define	RTC_BKP_DR4   0x00000004U
#define	RTC_BKP_DR5   0x00000005U
#define	RTC_BKP_DR6   0x00000006U
#define	RTC_BKP_DR7   0x00000007U
#define	RTC_BKP_DR8   0x00000008U
#define	RTC_BKP_DR9   0x00000009U
#define	RTC_BKP_DR10   0x0000000AU
#define	RTC_BKP_DR11   0x0000000BU
#define	RTC_BKP_DR12   0x0000000CU
#define	RTC_BKP_DR13   0x0000000DU
#define	RTC_BKP_DR14   0x0000000EU
#define	RTC_BKP_DR15   0x0000000FU
#define	RTC_BKP_DR16   0x00000010U
#define	RTC_BKP_DR17   0x00000011U
#define	RTC_BKP_DR18   0x00000012U
#define	RTC_BKP_DR19   0x00000013U
#define	RTC_TIMESTAMPEDGE_RISING   0x00000000U
#define	RTC_TIMESTAMPEDGE_FALLING   RTC_CR_TSEDGE
#define	RTC_TIMESTAMPPIN_DEFAULT   0x00000000U
#define	RTC_TAMPER_1   RTC_TAFCR_TAMP1E
#define	RTC_TAMPERPIN_DEFAULT   0x00000000U
#define	RTC_IT_TAMP   RTC_TAFCR_TAMPIE
#define	RTC_TAMPERTRIGGER_RISINGEDGE   0x00000000U
#define	RTC_TAMPERTRIGGER_FALLINGEDGE   0x00000002U
#define	RTC_TAMPERTRIGGER_LOWLEVEL   RTC_TAMPERTRIGGER_RISINGEDGE
#define	RTC_TAMPERTRIGGER_HIGHLEVEL   RTC_TAMPERTRIGGER_FALLINGEDGE
#define	RTC_TAMPERFILTER_DISABLE   0x00000000U
#define	RTC_TAMPERFILTER_2SAMPLE   RTC_TAFCR_TAMPFLT_0
#define	RTC_TAMPERFILTER_4SAMPLE   RTC_TAFCR_TAMPFLT_1
#define	RTC_TAMPERFILTER_8SAMPLE   RTC_TAFCR_TAMPFLT
#define	RTC_TAMPERFILTER_MASK   RTC_TAFCR_TAMPFLT
#define	RTC_TAMPERSAMPLINGFREQ_RTCCLK_DIV32768   0x00000000U
#define	RTC_TAMPERSAMPLINGFREQ_RTCCLK_DIV16384   RTC_TAFCR_TAMPFREQ_0
#define	RTC_TAMPERSAMPLINGFREQ_RTCCLK_DIV8192   RTC_TAFCR_TAMPFREQ_1
#define	RTC_TAMPERSAMPLINGFREQ_RTCCLK_DIV4096   (RTC_TAFCR_TAMPFREQ_0 | RTC_TAFCR_TAMPFREQ_1)
#define	RTC_TAMPERSAMPLINGFREQ_RTCCLK_DIV2048   RTC_TAFCR_TAMPFREQ_2
#define	RTC_TAMPERSAMPLINGFREQ_RTCCLK_DIV1024   (RTC_TAFCR_TAMPFREQ_0 | RTC_TAFCR_TAMPFREQ_2)
#define	RTC_TAMPERSAMPLINGFREQ_RTCCLK_DIV512   (RTC_TAFCR_TAMPFREQ_1 | RTC_TAFCR_TAMPFREQ_2)
#define	RTC_TAMPERSAMPLINGFREQ_RTCCLK_DIV256   RTC_TAFCR_TAMPFREQ
#define	RTC_TAMPERSAMPLINGFREQ_RTCCLK_MASK   RTC_TAFCR_TAMPFREQ
#define	RTC_TAMPERPRECHARGEDURATION_1RTCCLK   0x00000000U
#define	RTC_TAMPERPRECHARGEDURATION_2RTCCLK   RTC_TAFCR_TAMPPRCH_0
#define	RTC_TAMPERPRECHARGEDURATION_4RTCCLK   RTC_TAFCR_TAMPPRCH_1
#define	RTC_TAMPERPRECHARGEDURATION_8RTCCLK   RTC_TAFCR_TAMPPRCH
#define	RTC_TAMPERPRECHARGEDURATION_MASK   RTC_TAFCR_TAMPPRCH
#define	RTC_TAMPER_PULLUP_ENABLE   0x00000000U
#define	RTC_TAMPER_PULLUP_DISABLE   RTC_TAFCR_TAMPPUDIS
#define	RTC_TAMPER_PULLUP_MASK   RTC_TAFCR_TAMPPUDIS
#define	RTC_TIMESTAMPONTAMPERDETECTION_ENABLE   RTC_TAFCR_TAMPTS
#define	RTC_TIMESTAMPONTAMPERDETECTION_DISABLE   0x00000000U
#define	RTC_TIMESTAMPONTAMPERDETECTION_MASK   RTC_TAFCR_TAMPTS
#define	RTC_WAKEUPCLOCK_RTCCLK_DIV16   0x00000000U
#define	RTC_WAKEUPCLOCK_RTCCLK_DIV8   RTC_CR_WUCKSEL_0
#define	RTC_WAKEUPCLOCK_RTCCLK_DIV4   RTC_CR_WUCKSEL_1
#define	RTC_WAKEUPCLOCK_RTCCLK_DIV2   (RTC_CR_WUCKSEL_0 | RTC_CR_WUCKSEL_1)
#define	RTC_WAKEUPCLOCK_CK_SPRE_16BITS   RTC_CR_WUCKSEL_2
#define	RTC_WAKEUPCLOCK_CK_SPRE_17BITS   (RTC_CR_WUCKSEL_1 | RTC_CR_WUCKSEL_2)
#define	RTC_CALIBSIGN_POSITIVE   0x00000000U
#define	RTC_CALIBSIGN_NEGATIVE   RTC_CALIBR_DCS
#define	RTC_SMOOTHCALIB_PERIOD_32SEC   0x00000000U
#define	RTC_SMOOTHCALIB_PERIOD_16SEC   RTC_CALR_CALW16
#define	RTC_SMOOTHCALIB_PERIOD_8SEC   RTC_CALR_CALW8
#define	RTC_SMOOTHCALIB_PLUSPULSES_SET   RTC_CALR_CALP
#define	RTC_SMOOTHCALIB_PLUSPULSES_RESET   0x00000000U
#define	RTC_SHIFTADD1S_RESET   0x00000000U
#define	RTC_SHIFTADD1S_SET   RTC_SHIFTR_ADD1S
#define	RTC_CALIBOUTPUT_512HZ   0x00000000U
#define	RTC_CALIBOUTPUT_1HZ   RTC_CR_COSEL
#define	__HAL_RTC_WAKEUPTIMER_ENABLE(__HANDLE__)
	Enable the RTC WakeUp Timer peripheral.
#define	__HAL_RTC_WAKEUPTIMER_DISABLE(__HANDLE__)
	Disable the RTC Wakeup Timer peripheral.
#define	__HAL_RTC_WAKEUPTIMER_ENABLE_IT(__HANDLE__, __INTERRUPT__)
	Enable the RTC Wakeup Timer interrupt.
#define	__HAL_RTC_WAKEUPTIMER_DISABLE_IT(__HANDLE__, __INTERRUPT__)
	Disable the RTC Wakeup Timer interrupt.
#define	__HAL_RTC_WAKEUPTIMER_GET_IT(__HANDLE__, __INTERRUPT__)
	Check whether the specified RTC Wakeup Timer interrupt has occurred or not.
#define	__HAL_RTC_WAKEUPTIMER_GET_IT_SOURCE(__HANDLE__, __INTERRUPT__)
	Check whether the specified RTC Wakeup timer interrupt has been enabled or not.
#define	__HAL_RTC_WAKEUPTIMER_GET_FLAG(__HANDLE__, __FLAG__)
	Get the selected RTC Wakeup Timer's flag status.
#define	__HAL_RTC_WAKEUPTIMER_CLEAR_FLAG(__HANDLE__, __FLAG__)
	Clear the RTC Wakeup timer's pending flags.
#define	__HAL_RTC_WAKEUPTIMER_EXTI_ENABLE_IT()
	Enable interrupt on the RTC Wakeup Timer associated EXTI line.
#define	__HAL_RTC_WAKEUPTIMER_EXTI_DISABLE_IT()
	Disable interrupt on the RTC Wakeup Timer associated EXTI line.
#define	__HAL_RTC_WAKEUPTIMER_EXTI_ENABLE_EVENT()
	Enable event on the RTC Wakeup Timer associated EXTI line.
#define	__HAL_RTC_WAKEUPTIMER_EXTI_DISABLE_EVENT()
	Disable event on the RTC Wakeup Timer associated EXTI line.
#define	__HAL_RTC_WAKEUPTIMER_EXTI_ENABLE_FALLING_EDGE()
	Enable falling edge trigger on the RTC Wakeup Timer associated EXTI line.
#define	__HAL_RTC_WAKEUPTIMER_EXTI_DISABLE_FALLING_EDGE()
	Disable falling edge trigger on the RTC Wakeup Timer associated EXTI line.
#define	__HAL_RTC_WAKEUPTIMER_EXTI_ENABLE_RISING_EDGE()
	Enable rising edge trigger on the RTC Wakeup Timer associated EXTI line.
#define	__HAL_RTC_WAKEUPTIMER_EXTI_DISABLE_RISING_EDGE()
	Disable rising edge trigger on the RTC Wakeup Timer associated EXTI line.
#define	__HAL_RTC_WAKEUPTIMER_EXTI_ENABLE_RISING_FALLING_EDGE()
	Enable rising & falling edge trigger on the RTC Wakeup Timer associated EXTI line.
#define	__HAL_RTC_WAKEUPTIMER_EXTI_DISABLE_RISING_FALLING_EDGE()
	Disable rising & falling edge trigger on the RTC Wakeup Timer associated EXTI line. This parameter can be:
#define	__HAL_RTC_WAKEUPTIMER_EXTI_GET_FLAG()
	Check whether the RTC Wakeup Timer associated EXTI line interrupt flag is set or not.
#define	__HAL_RTC_WAKEUPTIMER_EXTI_CLEAR_FLAG()
	Clear the RTC Wakeup Timer associated EXTI line flag.
#define	__HAL_RTC_WAKEUPTIMER_EXTI_GENERATE_SWIT()
	Generate a Software interrupt on the RTC Wakeup Timer associated EXTI line.
#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.
#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.
#define	__HAL_RTC_TAMPER_TIMESTAMP_EXTI_ENABLE_IT()
	Enable interrupt on the RTC Tamper and Timestamp associated EXTI line.
#define	__HAL_RTC_TAMPER_TIMESTAMP_EXTI_DISABLE_IT()
	Disable interrupt on the RTC Tamper and Timestamp associated EXTI line.
#define	__HAL_RTC_TAMPER_TIMESTAMP_EXTI_ENABLE_EVENT()
	Enable event on the RTC Tamper and Timestamp associated EXTI line.
#define	__HAL_RTC_TAMPER_TIMESTAMP_EXTI_DISABLE_EVENT()
	Disable event on the RTC Tamper and Timestamp associated EXTI line.
#define	__HAL_RTC_TAMPER_TIMESTAMP_EXTI_ENABLE_FALLING_EDGE()
	Enable falling edge trigger on the RTC Tamper and Timestamp associated EXTI line.
#define	__HAL_RTC_TAMPER_TIMESTAMP_EXTI_DISABLE_FALLING_EDGE()
	Disable falling edge trigger on the RTC Tamper and Timestamp associated EXTI line.
#define	__HAL_RTC_TAMPER_TIMESTAMP_EXTI_ENABLE_RISING_EDGE()
	Enable rising edge trigger on the RTC Tamper and Timestamp associated EXTI line.
#define	__HAL_RTC_TAMPER_TIMESTAMP_EXTI_DISABLE_RISING_EDGE()
	Disable rising edge trigger on the RTC Tamper and Timestamp associated EXTI line.
#define	__HAL_RTC_TAMPER_TIMESTAMP_EXTI_ENABLE_RISING_FALLING_EDGE()
	Enable rising & falling edge trigger on the RTC Tamper and Timestamp associated EXTI line.
#define	__HAL_RTC_TAMPER_TIMESTAMP_EXTI_DISABLE_RISING_FALLING_EDGE()
	Disable rising & falling edge trigger on the RTC Tamper and Timestamp associated EXTI line. This parameter can be:
#define	__HAL_RTC_TAMPER_TIMESTAMP_EXTI_GET_FLAG()
	Check whether the RTC Tamper and Timestamp associated EXTI line interrupt flag is set or not.
#define	__HAL_RTC_TAMPER_TIMESTAMP_EXTI_CLEAR_FLAG()
	Clear the RTC Tamper and Timestamp associated EXTI line flag.
#define	__HAL_RTC_TAMPER_TIMESTAMP_EXTI_GENERATE_SWIT()
	Generate a Software interrupt on the RTC Tamper and Timestamp associated EXTI line.
#define	__HAL_RTC_COARSE_CALIB_ENABLE(__HANDLE__)
	Enable the Coarse calibration process.
#define	__HAL_RTC_COARSE_CALIB_DISABLE(__HANDLE__)
	Disable the Coarse calibration process.
#define	__HAL_RTC_CALIBRATION_OUTPUT_ENABLE(__HANDLE__)
	Enable the RTC calibration output.
#define	__HAL_RTC_CALIBRATION_OUTPUT_DISABLE(__HANDLE__)
	Disable the calibration output.
#define	__HAL_RTC_CLOCKREF_DETECTION_ENABLE(__HANDLE__)
	Enable the clock reference detection.
#define	__HAL_RTC_CLOCKREF_DETECTION_DISABLE(__HANDLE__)
	Disable the clock reference detection.
#define	__HAL_RTC_SHIFT_GET_FLAG(__HANDLE__, __FLAG__)
	Get the selected RTC shift operation's flag status.
#define	RTC_EXTI_LINE_TAMPER_TIMESTAMP_EVENT   EXTI_IMR_MR21
#define	RTC_EXTI_LINE_WAKEUPTIMER_EVENT   EXTI_IMR_MR22
#define	RTC_TAMPER_ENABLE_BITS_MASK   RTC_TAMPER_1
#define	RTC_TAMPER_FLAGS_MASK   RTC_FLAG_TAMP1F
#define	IS_RTC_BKP(BKP)
#define	IS_TIMESTAMP_EDGE(EDGE)
#define	IS_RTC_TAMPER(TAMPER)
#define	IS_RTC_TAMPER_PIN(PIN)
#define	IS_RTC_TIMESTAMP_PIN(PIN)
#define	IS_RTC_TAMPER_TRIGGER(TRIGGER)
#define	IS_RTC_TAMPER_FILTER(FILTER)
#define	IS_RTC_TAMPER_FILTER_CONFIG_CORRECT(FILTER, TRIGGER)
#define	IS_RTC_TAMPER_SAMPLING_FREQ(FREQ)
#define	IS_RTC_TAMPER_PRECHARGE_DURATION(DURATION)
#define	IS_RTC_TAMPER_PULLUP_STATE(STATE)
#define	IS_RTC_TAMPER_TIMESTAMPONTAMPER_DETECTION(DETECTION)
#define	IS_RTC_WAKEUP_CLOCK(CLOCK)
#define	IS_RTC_WAKEUP_COUNTER(COUNTER)
#define	IS_RTC_CALIB_SIGN(SIGN)
#define	IS_RTC_CALIB_VALUE(VALUE)
#define	IS_RTC_SMOOTH_CALIB_PERIOD(PERIOD)
#define	IS_RTC_SMOOTH_CALIB_PLUS(PLUS)
#define	IS_RTC_SMOOTH_CALIB_MINUS(VALUE)
#define	IS_RTC_SHIFT_ADD1S(SEL)
#define	IS_RTC_SHIFT_SUBFS(FS)
#define	IS_RTC_CALIB_OUTPUT(OUTPUT)

Functions
HAL_StatusTypeDef	HAL_RTCEx_SetTimeStamp (RTC_HandleTypeDef *hrtc, uint32_t RTC_TimeStampEdge, uint32_t RTC_TimeStampPin)
HAL_StatusTypeDef	HAL_RTCEx_SetTimeStamp_IT (RTC_HandleTypeDef *hrtc, uint32_t RTC_TimeStampEdge, uint32_t RTC_TimeStampPin)
HAL_StatusTypeDef	HAL_RTCEx_DeactivateTimeStamp (RTC_HandleTypeDef *hrtc)
HAL_StatusTypeDef	HAL_RTCEx_GetTimeStamp (RTC_HandleTypeDef *hrtc, RTC_TimeTypeDef *sTimeStamp, RTC_DateTypeDef *sTimeStampDate, uint32_t Format)
HAL_StatusTypeDef	HAL_RTCEx_SetTamper (RTC_HandleTypeDef *hrtc, RTC_TamperTypeDef *sTamper)
HAL_StatusTypeDef	HAL_RTCEx_SetTamper_IT (RTC_HandleTypeDef *hrtc, RTC_TamperTypeDef *sTamper)
HAL_StatusTypeDef	HAL_RTCEx_DeactivateTamper (RTC_HandleTypeDef *hrtc, uint32_t Tamper)
void	HAL_RTCEx_TamperTimeStampIRQHandler (RTC_HandleTypeDef *hrtc)
void	HAL_RTCEx_Tamper1EventCallback (RTC_HandleTypeDef *hrtc)
void	HAL_RTCEx_TimeStampEventCallback (RTC_HandleTypeDef *hrtc)
HAL_StatusTypeDef	HAL_RTCEx_PollForTimeStampEvent (RTC_HandleTypeDef *hrtc, uint32_t Timeout)
HAL_StatusTypeDef	HAL_RTCEx_PollForTamper1Event (RTC_HandleTypeDef *hrtc, uint32_t Timeout)
HAL_StatusTypeDef	HAL_RTCEx_SetWakeUpTimer (RTC_HandleTypeDef *hrtc, uint32_t WakeUpCounter, uint32_t WakeUpClock)
HAL_StatusTypeDef	HAL_RTCEx_SetWakeUpTimer_IT (RTC_HandleTypeDef *hrtc, uint32_t WakeUpCounter, uint32_t WakeUpClock)
HAL_StatusTypeDef	HAL_RTCEx_DeactivateWakeUpTimer (RTC_HandleTypeDef *hrtc)
uint32_t	HAL_RTCEx_GetWakeUpTimer (RTC_HandleTypeDef *hrtc)
void	HAL_RTCEx_WakeUpTimerIRQHandler (RTC_HandleTypeDef *hrtc)
void	HAL_RTCEx_WakeUpTimerEventCallback (RTC_HandleTypeDef *hrtc)
	Wake Up Timer Event Callback in non blocking mode.
HAL_StatusTypeDef	HAL_RTCEx_PollForWakeUpTimerEvent (RTC_HandleTypeDef *hrtc, uint32_t Timeout)
void	HAL_RTCEx_BKUPWrite (RTC_HandleTypeDef *hrtc, uint32_t BackupRegister, uint32_t Data)
uint32_t	HAL_RTCEx_BKUPRead (RTC_HandleTypeDef *hrtc, uint32_t BackupRegister)
HAL_StatusTypeDef	HAL_RTCEx_SetCoarseCalib (RTC_HandleTypeDef *hrtc, uint32_t CalibSign, uint32_t Value)
HAL_StatusTypeDef	HAL_RTCEx_DeactivateCoarseCalib (RTC_HandleTypeDef *hrtc)
HAL_StatusTypeDef	HAL_RTCEx_SetSmoothCalib (RTC_HandleTypeDef *hrtc, uint32_t SmoothCalibPeriod, uint32_t SmoothCalibPlusPulses, uint32_t SmoothCalibMinusPulsesValue)
HAL_StatusTypeDef	HAL_RTCEx_SetSynchroShift (RTC_HandleTypeDef *hrtc, uint32_t ShiftAdd1S, uint32_t ShiftSubFS)
HAL_StatusTypeDef	HAL_RTCEx_SetCalibrationOutPut (RTC_HandleTypeDef *hrtc, uint32_t CalibOutput)
HAL_StatusTypeDef	HAL_RTCEx_DeactivateCalibrationOutPut (RTC_HandleTypeDef *hrtc)
HAL_StatusTypeDef	HAL_RTCEx_SetRefClock (RTC_HandleTypeDef *hrtc)
HAL_StatusTypeDef	HAL_RTCEx_DeactivateRefClock (RTC_HandleTypeDef *hrtc)
HAL_StatusTypeDef	HAL_RTCEx_EnableBypassShadow (RTC_HandleTypeDef *hrtc)
HAL_StatusTypeDef	HAL_RTCEx_DisableBypassShadow (RTC_HandleTypeDef *hrtc)
void	HAL_RTCEx_AlarmBEventCallback (RTC_HandleTypeDef *hrtc)
HAL_StatusTypeDef	HAL_RTCEx_PollForAlarmBEvent (RTC_HandleTypeDef *hrtc, uint32_t Timeout)

Detailed Description

Header file of RTC HAL Extended module.

Author

MCD Application Team

Attention

Copyright (c) 2016 STMicroelectronics. All rights reserved.

This software is licensed under terms that can be found in the LICENSE file in the root directory of this software component. If no LICENSE file comes with this software, it is provided AS-IS.

Definition in file stm32f4xx_hal_rtc_ex.h.