STM32F439xx HAL User Manual: stm32f4xx_hal_rtc

RTC HAL module driver. This file provides firmware functions to manage the following functionalities of the Real Time Clock (RTC) Extension peripheral: + RTC Time Stamp functions + RTC Tamper functions + RTC Wake-up functions + Extension Control functions + Extension RTC features functions. More...

#include "stm32f4xx_hal.h"

Go to the source code of this file.

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.
HAL_StatusTypeDef	HAL_RTCEx_SetWakeUpTimer (RTC_HandleTypeDef *hrtc, uint32_t WakeUpCounter, uint32_t WakeUpClock)
	Sets wake up timer.
HAL_StatusTypeDef	HAL_RTCEx_SetWakeUpTimer_IT (RTC_HandleTypeDef *hrtc, uint32_t WakeUpCounter, uint32_t WakeUpClock)
	Sets wake up timer with interrupt.
uint32_t	HAL_RTCEx_DeactivateWakeUpTimer (RTC_HandleTypeDef *hrtc)
	Deactivates wake up timer counter.
uint32_t	HAL_RTCEx_GetWakeUpTimer (RTC_HandleTypeDef *hrtc)
	Gets wake up timer counter.
void	HAL_RTCEx_WakeUpTimerIRQHandler (RTC_HandleTypeDef *hrtc)
	This function handles Wake Up Timer interrupt request.
__weak void	HAL_RTCEx_WakeUpTimerEventCallback (RTC_HandleTypeDef *hrtc)
	Wake Up Timer callback.
HAL_StatusTypeDef	HAL_RTCEx_PollForWakeUpTimerEvent (RTC_HandleTypeDef *hrtc, uint32_t Timeout)
	This function handles Wake Up Timer Polling.
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_SetCoarseCalib (RTC_HandleTypeDef *hrtc, uint32_t CalibSign, uint32_t Value)
	Sets the Coarse calibration parameters.
HAL_StatusTypeDef	HAL_RTCEx_DeactivateCoarseCalib (RTC_HandleTypeDef *hrtc)
	Deactivates the Coarse calibration parameters.
HAL_StatusTypeDef	HAL_RTCEx_SetSmoothCalib (RTC_HandleTypeDef *hrtc, uint32_t SmoothCalibPeriod, uint32_t SmoothCalibPlusPulses, uint32_t SmouthCalibMinusPulsesValue)
	Sets the Smooth calibration parameters.
HAL_StatusTypeDef	HAL_RTCEx_SetSynchroShift (RTC_HandleTypeDef *hrtc, uint32_t ShiftAdd1S, uint32_t ShiftSubFS)
	Configures the Synchronization Shift Control Settings.
HAL_StatusTypeDef	HAL_RTCEx_SetCalibrationOutPut (RTC_HandleTypeDef *hrtc, uint32_t CalibOutput)
	Configures the Calibration Pinout (RTC_CALIB) Selection (1Hz or 512Hz).
HAL_StatusTypeDef	HAL_RTCEx_DeactivateCalibrationOutPut (RTC_HandleTypeDef *hrtc)
	Deactivates the Calibration Pinout (RTC_CALIB) Selection (1Hz or 512Hz).
HAL_StatusTypeDef	HAL_RTCEx_SetRefClock (RTC_HandleTypeDef *hrtc)
	Enables the RTC reference clock detection.
HAL_StatusTypeDef	HAL_RTCEx_DeactivateRefClock (RTC_HandleTypeDef *hrtc)
	Disable the RTC reference clock detection.
HAL_StatusTypeDef	HAL_RTCEx_EnableBypassShadow (RTC_HandleTypeDef *hrtc)
	Enables the Bypass Shadow feature.
HAL_StatusTypeDef	HAL_RTCEx_DisableBypassShadow (RTC_HandleTypeDef *hrtc)
	Disables the Bypass Shadow feature.
__weak void	HAL_RTCEx_AlarmBEventCallback (RTC_HandleTypeDef *hrtc)
	Alarm B callback.
HAL_StatusTypeDef	HAL_RTCEx_PollForAlarmBEvent (RTC_HandleTypeDef *hrtc, uint32_t Timeout)
	This function handles AlarmB Polling request.

Detailed Description

Author:

MCD Application Team

  ==============================================================================
                  ##### How to use this driver #####
  ==============================================================================
  [..] 
    (+) Enable the RTC domain access.
    (+) Configure the RTC Prescaler (Asynchronous and Synchronous) and RTC hour 
        format using the HAL_RTC_Init() function.
  
  *** RTC Wake-up configuration ***
  ================================
  [..] 
    (+) To configure the RTC Wake-up Clock source and Counter use the HAL_RTC_SetWakeUpTimer()
        function. You can also configure the RTC Wake-up timer in interrupt mode 
        using the HAL_RTC_SetWakeUpTimer_IT() function.
    (+) To read the RTC Wake-up Counter register, use the HAL_RTC_GetWakeUpTimer() 
        function.
  
  *** TimeStamp configuration ***
  ===============================
  [..]
    (+) Configure the RTC_AFx trigger and enable the RTC TimeStamp using the 
        HAL_RTC_SetTimeStamp() function. You can also configure the RTC TimeStamp with 
        interrupt mode using the HAL_RTC_SetTimeStamp_IT() function.
    (+) To read the RTC TimeStamp Time and Date register, use the HAL_RTC_GetTimeStamp()
        function.
    (+) The TIMESTAMP alternate function can be mapped either to RTC_AF1 (PC13)
        or RTC_AF2 (PI8 or PA0 only for STM32F446xx devices) depending on the value of TSINSEL bit in 
        RTC_TAFCR register. The corresponding pin is also selected by HAL_RTC_SetTimeStamp()
        or HAL_RTC_SetTimeStamp_IT() function.
  
  *** Tamper configuration ***
  ============================
  [..]
    (+) Enable the RTC Tamper and configure the Tamper filter count, trigger Edge 
        or Level according to the Tamper filter (if equal to 0 Edge else Level) 
        value, sampling frequency, precharge or discharge and Pull-UP using the 
        HAL_RTC_SetTamper() function. You can configure RTC Tamper in interrupt 
        mode using HAL_RTC_SetTamper_IT() function.
    (+) The TAMPER1 alternate function can be mapped either to RTC_AF1 (PC13)
        or RTC_AF2 (PI8 or PA0 only for STM32F446xx devices) depending on the value of TAMP1INSEL bit in 
        RTC_TAFCR register. The corresponding pin is also selected by HAL_RTC_SetTamper()
        or HAL_RTC_SetTamper_IT() function.
  
  *** Backup Data Registers configuration ***
  ===========================================
  [..]
    (+) To write to the RTC Backup Data registers, use the HAL_RTC_BKUPWrite()
        function.  
    (+) To read the RTC Backup Data registers, use the HAL_RTC_BKUPRead()
        function.

Attention:

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. 3. Neither the name of STMicroelectronics nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Definition in file stm32f4xx_hal_rtc_ex.c.

Functions

Detailed Description

© COPYRIGHT(c) 2017 STMicroelectronics