STM32F103xB HAL User Manual: stm32f1xx_hal

RTC HAL module driver. This file provides firmware functions to manage the following functionalities of the Real Time Clock (RTC) peripheral: + Initialization and de-initialization functions + RTC Time and Date functions + RTC Alarm functions + Peripheral Control functions + Peripheral State functions. More...

#include "stm32f1xx_hal.h"

Go to the source code of this file.

Defines
#define	RTC_ALARM_RESETVALUE_REGISTER (uint16_t)0xFFFF
#define	RTC_ALARM_RESETVALUE 0xFFFFFFFFU
Functions
static uint32_t	RTC_ReadTimeCounter (RTC_HandleTypeDef *hrtc)
	Read the time counter available in RTC_CNT registers.
static HAL_StatusTypeDef	RTC_WriteTimeCounter (RTC_HandleTypeDef *hrtc, uint32_t TimeCounter)
	Write the time counter in RTC_CNT registers.
static uint32_t	RTC_ReadAlarmCounter (RTC_HandleTypeDef *hrtc)
	Read the time counter available in RTC_ALR registers.
static HAL_StatusTypeDef	RTC_WriteAlarmCounter (RTC_HandleTypeDef *hrtc, uint32_t AlarmCounter)
	Write the time counter in RTC_ALR registers.
static HAL_StatusTypeDef	RTC_EnterInitMode (RTC_HandleTypeDef *hrtc)
	Enters the RTC Initialization mode.
static HAL_StatusTypeDef	RTC_ExitInitMode (RTC_HandleTypeDef *hrtc)
	Exit the RTC Initialization mode.
static uint8_t	RTC_ByteToBcd2 (uint8_t Value)
	Converts a 2 digit decimal to BCD format.
static uint8_t	RTC_Bcd2ToByte (uint8_t Value)
	Converts from 2 digit BCD to Binary.
static uint8_t	RTC_IsLeapYear (uint16_t nYear)
	Check whether the passed year is Leap or not.
static void	RTC_DateUpdate (RTC_HandleTypeDef *hrtc, uint32_t DayElapsed)
	Updates date when time is 23:59:59.
static uint8_t	RTC_WeekDayNum (uint32_t nYear, uint8_t nMonth, uint8_t nDay)
	Determines the week number, the day number and the week day number.
HAL_StatusTypeDef	HAL_RTC_Init (RTC_HandleTypeDef *hrtc)
	Initializes the RTC peripheral.
HAL_StatusTypeDef	HAL_RTC_DeInit (RTC_HandleTypeDef *hrtc)
	DeInitializes the RTC peripheral.
HAL_StatusTypeDef	HAL_RTC_RegisterCallback (RTC_HandleTypeDef *hrtc, HAL_RTC_CallbackIDTypeDef CallbackID, pRTC_CallbackTypeDef pCallback)
	Register a User RTC Callback To be used instead of the weak predefined callback.
HAL_StatusTypeDef	HAL_RTC_UnRegisterCallback (RTC_HandleTypeDef *hrtc, HAL_RTC_CallbackIDTypeDef CallbackID)
	Unregister an RTC Callback RTC callabck is redirected to the weak predefined callback.
__weak void	HAL_RTC_MspInit (RTC_HandleTypeDef *hrtc)
	Initializes the RTC MSP.
__weak void	HAL_RTC_MspDeInit (RTC_HandleTypeDef *hrtc)
	DeInitializes the RTC MSP.
HAL_StatusTypeDef	HAL_RTC_SetTime (RTC_HandleTypeDef hrtc, RTC_TimeTypeDef sTime, uint32_t Format)
	Sets RTC current time.
HAL_StatusTypeDef	HAL_RTC_GetTime (RTC_HandleTypeDef hrtc, RTC_TimeTypeDef sTime, uint32_t Format)
	Gets RTC current time.
HAL_StatusTypeDef	HAL_RTC_SetDate (RTC_HandleTypeDef hrtc, RTC_DateTypeDef sDate, uint32_t Format)
	Sets RTC current date.
HAL_StatusTypeDef	HAL_RTC_GetDate (RTC_HandleTypeDef hrtc, RTC_DateTypeDef sDate, uint32_t Format)
	Gets RTC current date.
HAL_StatusTypeDef	HAL_RTC_SetAlarm (RTC_HandleTypeDef hrtc, RTC_AlarmTypeDef sAlarm, uint32_t Format)
	Sets the specified RTC Alarm.
HAL_StatusTypeDef	HAL_RTC_SetAlarm_IT (RTC_HandleTypeDef hrtc, RTC_AlarmTypeDef sAlarm, uint32_t Format)
	Sets the specified RTC Alarm with Interrupt.
HAL_StatusTypeDef	HAL_RTC_GetAlarm (RTC_HandleTypeDef hrtc, RTC_AlarmTypeDef sAlarm, uint32_t Alarm, uint32_t Format)
	Gets the RTC Alarm value and masks.
HAL_StatusTypeDef	HAL_RTC_DeactivateAlarm (RTC_HandleTypeDef *hrtc, uint32_t Alarm)
	Deactive the specified RTC Alarm.
void	HAL_RTC_AlarmIRQHandler (RTC_HandleTypeDef *hrtc)
	This function handles Alarm interrupt request.
__weak void	HAL_RTC_AlarmAEventCallback (RTC_HandleTypeDef *hrtc)
	Alarm A callback.
HAL_StatusTypeDef	HAL_RTC_PollForAlarmAEvent (RTC_HandleTypeDef *hrtc, uint32_t Timeout)
	This function handles AlarmA Polling request.
HAL_RTCStateTypeDef	HAL_RTC_GetState (RTC_HandleTypeDef *hrtc)
	Returns the RTC state.
HAL_StatusTypeDef	HAL_RTC_WaitForSynchro (RTC_HandleTypeDef *hrtc)
	Waits until the RTC registers (RTC_CNT, RTC_ALR and RTC_PRL) are synchronized with RTC APB clock.

Detailed Description

Author:

MCD Application Team

  ==============================================================================
                  ##### How to use this driver #####
  ==================================================================
  [..]
    (+) Enable the RTC domain access (see description in the section above).
    (+) Configure the RTC Prescaler (Asynchronous prescaler to generate RTC 1Hz time base)
        using the HAL_RTC_Init() function.

  *** Time and Date configuration ***
  ===================================
  [..]
    (+) To configure the RTC Calendar (Time and Date) use the HAL_RTC_SetTime()
        and HAL_RTC_SetDate() functions.
    (+) To read the RTC Calendar, use the HAL_RTC_GetTime() and HAL_RTC_GetDate() functions.

  *** Alarm configuration ***
  ===========================
  [..]
    (+) To configure the RTC Alarm use the HAL_RTC_SetAlarm() function.
        You can also configure the RTC Alarm with interrupt mode using the HAL_RTC_SetAlarm_IT() function.
    (+) To read the RTC Alarm, use the HAL_RTC_GetAlarm() function.

  *** Tamper configuration ***
  ============================
  [..]
    (+) Enable the RTC Tamper and configure the Tamper Level using the
        HAL_RTCEx_SetTamper() function. You can configure RTC Tamper with interrupt
        mode using HAL_RTCEx_SetTamper_IT() function.
    (+) The TAMPER1 alternate function can be mapped to PC13

  *** Backup Data Registers configuration ***
  ===========================================
  [..]
    (+) To write to the RTC Backup Data registers, use the HAL_RTCEx_BKUPWrite()
        function.
    (+) To read the RTC Backup Data registers, use the HAL_RTCEx_BKUPRead()
        function.

                  ##### WARNING: Drivers Restrictions  #####
  ==================================================================
  [..] RTC version used on STM32F1 families is version V1. All the features supported by V2
       (other families) will be not supported on F1.
  [..] As on V2, main RTC features are managed by HW. But on F1, date feature is completely
       managed by SW.
  [..] Then, there are some restrictions compared to other families:
    (+) Only format 24 hours supported in HAL (format 12 hours not supported)
    (+) Date is saved in SRAM. Then, when MCU is in STOP or STANDBY mode, date will be lost.
        User should implement a way to save date before entering in low power mode (an
        example is provided with firmware package based on backup registers)
    (+) Date is automatically updated each time a HAL_RTC_GetTime or HAL_RTC_GetDate is called.
    (+) Alarm detection is limited to 1 day. It will expire only 1 time (no alarm repetition, need
        to program a new alarm)

              ##### Backup Domain Operating Condition #####
  ==============================================================================
  [..] The real-time clock (RTC) and the RTC backup registers can be powered
       from the VBAT voltage when the main VDD supply is powered off.
       To retain the content of the RTC backup registers and supply the RTC
       when VDD is turned off, VBAT pin can be connected to an optional
       standby voltage supplied by a battery or by another source.

  [..] To allow the RTC operating even when the main digital supply (VDD) is turned
       off, the VBAT pin powers the following blocks:
    (#) The RTC
    (#) The LSE oscillator
    (#) The backup SRAM when the low power backup regulator is enabled
    (#) PC13 to PC15 I/Os, plus PI8 I/O (when available)

  [..] When the backup domain is supplied by VDD (analog switch connected to VDD),
       the following pins are available:
    (+) PC13 can be used as a Tamper pin

  [..] When the backup domain is supplied by VBAT (analog switch connected to VBAT
       because VDD is not present), the following pins are available:
    (+) PC13 can be used as the Tamper pin

                   ##### Backup Domain Reset #####
  ==================================================================
  [..] The backup domain reset sets all RTC registers and the RCC_BDCR register
       to their reset values.
  [..] A backup domain reset is generated when one of the following events occurs:
    (#) Software reset, triggered by setting the BDRST bit in the
        RCC Backup domain control register (RCC_BDCR).
    (#) VDD or VBAT power on, if both supplies have previously been powered off.
    (#) Tamper detection event resets all data backup registers.

                   ##### Backup Domain Access #####
  ==================================================================
  [..] After reset, the backup domain (RTC registers, RTC backup data
       registers and backup SRAM) is protected against possible unwanted write
       accesses.
  [..] To enable access to the RTC Domain and RTC registers, proceed as follows:
    (+) Call the function HAL_RCCEx_PeriphCLKConfig in using RCC_PERIPHCLK_RTC for
        PeriphClockSelection and select RTCClockSelection (LSE, LSI or HSE)
    (+) Enable the BKP clock in using __HAL_RCC_BKP_CLK_ENABLE()

                  ##### RTC and low power modes #####
  ==================================================================
  [..] The MCU can be woken up from a low power mode by an RTC alternate
       function.
  [..] The RTC alternate functions are the RTC alarms (Alarm A),
       and RTC tamper event detection.
       These RTC alternate functions can wake up the system from the Stop and
       Standby low power modes.
  [..] The system can also wake up from low power modes without depending
       on an external interrupt (Auto-wakeup mode), by using the RTC alarm.

  *** Callback registration ***
  =============================================
  [..]
  The compilation define  USE_HAL_RTC_REGISTER_CALLBACKS when set to 1
  allows the user to configure dynamically the driver callbacks.
  Use Function @ref HAL_RTC_RegisterCallback() to register an interrupt callback.
  
  [..]
  Function @ref HAL_RTC_RegisterCallback() allows to register following callbacks:
    (+) AlarmAEventCallback          : RTC Alarm A Event callback.
    (+) Tamper1EventCallback         : RTC Tamper 1 Event callback.
    (+) MspInitCallback              : RTC MspInit callback.
    (+) MspDeInitCallback            : RTC MspDeInit callback.
  [..]	  
  This function takes as parameters the HAL peripheral handle, the Callback ID
  and a pointer to the user callback function.
  
  [..]
  Use function @ref HAL_RTC_UnRegisterCallback() to reset a callback to the default
  weak function.
  @ref HAL_RTC_UnRegisterCallback() takes as parameters the HAL peripheral handle,
  and the Callback ID.
  This function allows to reset following callbacks:
    (+) AlarmAEventCallback          : RTC Alarm A Event callback.
    (+) Tamper1EventCallback         : RTC Tamper 1 Event callback.
    (+) MspInitCallback              : RTC MspInit callback.
    (+) MspDeInitCallback            : RTC MspDeInit callback.
  [..]
  By default, after the @ref HAL_RTC_Init() and when the state is HAL_RTC_STATE_RESET,
  all callbacks are set to the corresponding weak functions :
  example @ref AlarmAEventCallback().
  Exception done for MspInit and MspDeInit callbacks that are reset to the legacy weak function
  in the @ref HAL_RTC_Init()/@ref HAL_RTC_DeInit() only when these callbacks are null
  (not registered beforehand).
  If not, MspInit or MspDeInit are not null, @ref HAL_RTC_Init()/@ref HAL_RTC_DeInit()
  keep and use the user MspInit/MspDeInit callbacks (registered beforehand)
  [..]
  Callbacks can be registered/unregistered in HAL_RTC_STATE_READY state only.
  Exception done MspInit/MspDeInit that can be registered/unregistered
  in HAL_RTC_STATE_READY or HAL_RTC_STATE_RESET state,
  thus registered (user) MspInit/DeInit callbacks can be used during the Init/DeInit.
  In that case first register the MspInit/MspDeInit user callbacks
  using @ref HAL_RTC_RegisterCallback() before calling @ref HAL_RTC_DeInit()
  or @ref HAL_RTC_Init() function.
  [..]
  When The compilation define USE_HAL_RTC_REGISTER_CALLBACKS is set to 0 or
  not defined, the callback registration feature is not available and all callbacks
  are set to the corresponding weak functions.

Attention:

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.c.

Defines

Functions

Detailed Description

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