stm32f1xx_hal_rtc_ex.h File Reference

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

#include "stm32f1xx_hal_def.h"

Go to the source code of this file.

Data Structures
struct	RTC_TamperTypeDef
	RTC Tamper structure definition. More...
Defines
#define	HAL_RTCEx_TamperTimeStampIRQHandler   HAL_RTCEx_TamperIRQHandler
#define	IS_RTC_TAMPER(__TAMPER__)   ((__TAMPER__) == RTC_TAMPER_1)
#define	IS_RTC_TAMPER_TRIGGER(__TRIGGER__)
#define	IS_RTC_BKP(BKP)   ((BKP) <= (uint32_t)RTC_BKP_NUMBER)
#define	IS_RTC_SMOOTH_CALIB_MINUS(__VALUE__)   ((__VALUE__) <= 0x0000007FU)
#define	RTC_TAMPER_1   BKP_CR_TPE
#define	RTC_TAMPERTRIGGER_LOWLEVEL   BKP_CR_TPAL
#define	RTC_TAMPERTRIGGER_HIGHLEVEL   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	__HAL_RTC_TAMPER_ENABLE_IT(__HANDLE__, __INTERRUPT__)   SET_BIT(BKP->CSR, (__INTERRUPT__))
	Enable the RTC Tamper interrupt.
#define	__HAL_RTC_TAMPER_DISABLE_IT(__HANDLE__, __INTERRUPT__)   CLEAR_BIT(BKP->CSR, (__INTERRUPT__))
	Disable the RTC Tamper interrupt.
#define	__HAL_RTC_TAMPER_GET_IT_SOURCE(__HANDLE__, __INTERRUPT__)   ((((BKP->CSR) & ((__INTERRUPT__))) != RESET)? SET : RESET)
	Check whether the specified RTC Tamper interrupt has been enabled or not.
#define	__HAL_RTC_TAMPER_GET_FLAG(__HANDLE__, __FLAG__)   ((((BKP->CSR) & (__FLAG__)) != RESET)? SET : RESET)
	Get the selected RTC Tamper's flag status.
#define	__HAL_RTC_TAMPER_GET_IT(__HANDLE__, __INTERRUPT__)   ((((BKP->CSR) & (BKP_CSR_TEF)) != RESET)? SET : RESET)
	Get the selected RTC Tamper's flag status.
#define	__HAL_RTC_TAMPER_CLEAR_FLAG(__HANDLE__, __FLAG__)   SET_BIT(BKP->CSR, BKP_CSR_CTE | BKP_CSR_CTI)
	Clear the RTC Tamper's pending flags.
#define	__HAL_RTC_SECOND_ENABLE_IT(__HANDLE__, __INTERRUPT__)   SET_BIT((__HANDLE__)->Instance->CRH, (__INTERRUPT__))
	Enable the RTC Second interrupt.
#define	__HAL_RTC_SECOND_DISABLE_IT(__HANDLE__, __INTERRUPT__)   CLEAR_BIT((__HANDLE__)->Instance->CRH, (__INTERRUPT__))
	Disable the RTC Second interrupt.
#define	__HAL_RTC_SECOND_GET_IT_SOURCE(__HANDLE__, __INTERRUPT__)   ((((((__HANDLE__)->Instance->CRH)& ((__INTERRUPT__)))) != RESET)? SET : RESET)
	Check whether the specified RTC Second interrupt has occurred or not.
#define	__HAL_RTC_SECOND_GET_FLAG(__HANDLE__, __FLAG__)   (((((__HANDLE__)->Instance->CRL) & (__FLAG__)) != RESET)? SET : RESET)
	Get the selected RTC Second's flag status.
#define	__HAL_RTC_SECOND_CLEAR_FLAG(__HANDLE__, __FLAG__)   ((__HANDLE__)->Instance->CRL) &= ~(__FLAG__)
	Clear the RTC Second's pending flags.
#define	__HAL_RTC_OVERFLOW_ENABLE_IT(__HANDLE__, __INTERRUPT__)   SET_BIT((__HANDLE__)->Instance->CRH, (__INTERRUPT__))
	Enable the RTC Overflow interrupt.
#define	__HAL_RTC_OVERFLOW_DISABLE_IT(__HANDLE__, __INTERRUPT__)   CLEAR_BIT((__HANDLE__)->Instance->CRH, (__INTERRUPT__))
	Disable the RTC Overflow interrupt.
#define	__HAL_RTC_OVERFLOW_GET_IT_SOURCE(__HANDLE__, __INTERRUPT__)   ((((((__HANDLE__)->Instance->CRH)& ((__INTERRUPT__))) ) != RESET)? SET : RESET)
	Check whether the specified RTC Overflow interrupt has occurred or not.
#define	__HAL_RTC_OVERFLOW_GET_FLAG(__HANDLE__, __FLAG__)   (((((__HANDLE__)->Instance->CRL) & (__FLAG__)) != RESET)? SET : RESET)
	Get the selected RTC Overflow's flag status.
#define	__HAL_RTC_OVERFLOW_CLEAR_FLAG(__HANDLE__, __FLAG__)   ((__HANDLE__)->Instance->CRL) = ~(__FLAG__)
	Clear the RTC Overflow's pending flags.
Functions
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_TamperIRQHandler (RTC_HandleTypeDef *hrtc)
	This function handles Tamper interrupt request.
__weak void	HAL_RTCEx_Tamper1EventCallback (RTC_HandleTypeDef *hrtc)
	Tamper 1 callback.
HAL_StatusTypeDef	HAL_RTCEx_PollForTamper1Event (RTC_HandleTypeDef *hrtc, uint32_t Timeout)
	This function handles Tamper1 Polling.
HAL_StatusTypeDef	HAL_RTCEx_SetSecond_IT (RTC_HandleTypeDef *hrtc)
	Sets Interrupt for second.
HAL_StatusTypeDef	HAL_RTCEx_DeactivateSecond (RTC_HandleTypeDef *hrtc)
	Deactivates Second.
void	HAL_RTCEx_RTCIRQHandler (RTC_HandleTypeDef *hrtc)
	This function handles second interrupt request.
__weak void	HAL_RTCEx_RTCEventCallback (RTC_HandleTypeDef *hrtc)
	Second event callback.
__weak void	HAL_RTCEx_RTCEventErrorCallback (RTC_HandleTypeDef *hrtc)
	Second event error callback.
void	HAL_RTCEx_BKUPWrite (RTC_HandleTypeDef *hrtc, uint32_t BackupRegister, uint32_t Data)
	Writes a data in a specified RTC Backup data register.
uint32_t	HAL_RTCEx_BKUPRead (RTC_HandleTypeDef *hrtc, uint32_t BackupRegister)
	Reads data from the specified RTC Backup data Register.
HAL_StatusTypeDef	HAL_RTCEx_SetSmoothCalib (RTC_HandleTypeDef *hrtc, uint32_t SmoothCalibPeriod, uint32_t SmoothCalibPlusPulses, uint32_t SmouthCalibMinusPulsesValue)
	Sets the Smooth calibration parameters.

---

Detailed Description

Header file of RTC HAL Extension module.

Author:

MCD Application Team

Attention:

© Copyright (c) 2016 STMicroelectronics. All rights reserved.

This software component is licensed by ST under BSD 3-Clause license, the "License"; You may not use this file except in compliance with the License. You may obtain a copy of the License at: opensource.org/licenses/BSD-3-Clause

Definition in file stm32f1xx_hal_rtc_ex.h.