CamTimer/Drivers/STM32F1xx_HAL_Driver/Src/stm32f1xx_hal_rtc.c

1950 lines
59 KiB
C
Raw Normal View History

2020-01-15 18:02:31 +01:00
/**
******************************************************************************
* @file stm32f1xx_hal_rtc.c
* @author MCD Application Team
* @brief RTC HAL module driver.
2021-03-08 18:53:17 +01:00
* This file provides firmware functions to manage the following
2020-01-15 18:02:31 +01:00
* functionalities of the Real Time Clock (RTC) peripheral:
* + Initialization and de-initialization functions
* + RTC Time and Date functions
* + RTC Alarm functions
2021-03-08 18:53:17 +01:00
* + Peripheral Control functions
2020-01-15 18:02:31 +01:00
* + Peripheral State functions
2021-03-08 18:53:17 +01:00
*
2020-01-15 18:02:31 +01:00
@verbatim
==============================================================================
##### How to use this driver #####
==================================================================
2021-03-08 18:53:17 +01:00
[..]
2020-01-15 18:02:31 +01:00
(+) Enable the RTC domain access (see description in the section above).
2021-03-08 18:53:17 +01:00
(+) Configure the RTC Prescaler (Asynchronous prescaler to generate RTC 1Hz time base)
2020-01-15 18:02:31 +01:00
using the HAL_RTC_Init() function.
2021-03-08 18:53:17 +01:00
2020-01-15 18:02:31 +01:00
*** Time and Date configuration ***
===================================
2021-03-08 18:53:17 +01:00
[..]
(+) To configure the RTC Calendar (Time and Date) use the HAL_RTC_SetTime()
2020-01-15 18:02:31 +01:00
and HAL_RTC_SetDate() functions.
(+) To read the RTC Calendar, use the HAL_RTC_GetTime() and HAL_RTC_GetDate() functions.
2021-03-08 18:53:17 +01:00
2020-01-15 18:02:31 +01:00
*** Alarm configuration ***
===========================
[..]
2021-03-08 18:53:17 +01:00
(+) To configure the RTC Alarm use the HAL_RTC_SetAlarm() function.
2020-01-15 18:02:31 +01:00
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.
2021-03-08 18:53:17 +01:00
2020-01-15 18:02:31 +01:00
*** Tamper configuration ***
============================
[..]
2021-03-08 18:53:17 +01:00
(+) Enable the RTC Tamper and configure the Tamper Level using the
2020-01-15 18:02:31 +01:00
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()
2021-03-08 18:53:17 +01:00
function.
2020-01-15 18:02:31 +01:00
(+) To read the RTC Backup Data registers, use the HAL_RTCEx_BKUPRead()
function.
2021-03-08 18:53:17 +01:00
2020-01-15 18:02:31 +01:00
##### 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.
2021-03-08 18:53:17 +01:00
[..] As on V2, main RTC features are managed by HW. But on F1, date feature is completely
2020-01-15 18:02:31 +01:00
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.
2021-03-08 18:53:17 +01:00
User should implement a way to save date before entering in low power mode (an
2020-01-15 18:02:31 +01:00
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.
2021-03-08 18:53:17 +01:00
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
2020-01-15 18:02:31 +01:00
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:
2021-03-08 18:53:17 +01:00
(#) 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)
2020-01-15 18:02:31 +01:00
[..] 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
2021-03-08 18:53:17 +01:00
[..] When the backup domain is supplied by VBAT (analog switch connected to VBAT
2020-01-15 18:02:31 +01:00
because VDD is not present), the following pins are available:
2021-03-08 18:53:17 +01:00
(+) PC13 can be used as the Tamper pin
2020-01-15 18:02:31 +01:00
##### Backup Domain Reset #####
==================================================================
[..] The backup domain reset sets all RTC registers and the RCC_BDCR register
2021-03-08 18:53:17 +01:00
to their reset values.
2020-01-15 18:02:31 +01:00
[..] A backup domain reset is generated when one of the following events occurs:
2021-03-08 18:53:17 +01:00
(#) 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.
2020-01-15 18:02:31 +01:00
(#) Tamper detection event resets all data backup registers.
##### Backup Domain Access #####
==================================================================
2021-03-08 18:53:17 +01:00
[..] After reset, the backup domain (RTC registers, RTC backup data
registers and backup SRAM) is protected against possible unwanted write
accesses.
2020-01-15 18:02:31 +01:00
[..] 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()
2021-03-08 18:53:17 +01:00
2020-01-15 18:02:31 +01:00
##### RTC and low power modes #####
==================================================================
2021-03-08 18:53:17 +01:00
[..] The MCU can be woken up from a low power mode by an RTC alternate
2020-01-15 18:02:31 +01:00
function.
2021-03-08 18:53:17 +01:00
[..] The RTC alternate functions are the RTC alarms (Alarm A),
2020-01-15 18:02:31 +01:00
and RTC tamper event detection.
2021-03-08 18:53:17 +01:00
These RTC alternate functions can wake up the system from the Stop and
2020-01-15 18:02:31 +01:00
Standby low power modes.
2021-03-08 18:53:17 +01:00
[..] The system can also wake up from low power modes without depending
2020-01-15 18:02:31 +01:00
on an external interrupt (Auto-wakeup mode), by using the RTC alarm.
2021-03-08 18:53:17 +01:00
*** 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.
2020-01-15 18:02:31 +01:00
@endverbatim
******************************************************************************
* @attention
*
2021-03-08 18:53:17 +01:00
* <h2><center>&copy; Copyright (c) 2016 STMicroelectronics.
* All rights reserved.</center></h2>
2020-01-15 18:02:31 +01:00
*
2021-03-08 18:53:17 +01:00
* 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
2020-01-15 18:02:31 +01:00
*
******************************************************************************
2021-03-08 18:53:17 +01:00
*/
2020-01-15 18:02:31 +01:00
/* Includes ------------------------------------------------------------------*/
#include "stm32f1xx_hal.h"
/** @addtogroup STM32F1xx_HAL_Driver
* @{
*/
/** @defgroup RTC RTC
* @brief RTC HAL module driver
* @{
*/
#ifdef HAL_RTC_MODULE_ENABLED
/* Private typedef -----------------------------------------------------------*/
/* Private define ------------------------------------------------------------*/
/** @defgroup RTC_Private_Constants RTC Private Constants
* @{
*/
#define RTC_ALARM_RESETVALUE_REGISTER (uint16_t)0xFFFF
#define RTC_ALARM_RESETVALUE 0xFFFFFFFFU
/**
* @}
*/
/* Private macro -------------------------------------------------------------*/
/** @defgroup RTC_Private_Macros RTC Private Macros
* @{
*/
/**
* @}
*/
/* Private variables ---------------------------------------------------------*/
/* Private function prototypes -----------------------------------------------*/
/** @defgroup RTC_Private_Functions RTC Private Functions
* @{
*/
2021-03-08 18:53:17 +01:00
static uint32_t RTC_ReadTimeCounter(RTC_HandleTypeDef *hrtc);
static HAL_StatusTypeDef RTC_WriteTimeCounter(RTC_HandleTypeDef *hrtc, uint32_t TimeCounter);
static uint32_t RTC_ReadAlarmCounter(RTC_HandleTypeDef *hrtc);
static HAL_StatusTypeDef RTC_WriteAlarmCounter(RTC_HandleTypeDef *hrtc, uint32_t AlarmCounter);
static HAL_StatusTypeDef RTC_EnterInitMode(RTC_HandleTypeDef *hrtc);
static HAL_StatusTypeDef RTC_ExitInitMode(RTC_HandleTypeDef *hrtc);
2020-01-15 18:02:31 +01:00
static uint8_t RTC_ByteToBcd2(uint8_t Value);
static uint8_t RTC_Bcd2ToByte(uint8_t Value);
static uint8_t RTC_IsLeapYear(uint16_t nYear);
2021-03-08 18:53:17 +01:00
static void RTC_DateUpdate(RTC_HandleTypeDef *hrtc, uint32_t DayElapsed);
2020-01-15 18:02:31 +01:00
static uint8_t RTC_WeekDayNum(uint32_t nYear, uint8_t nMonth, uint8_t nDay);
/**
* @}
*/
/* Private functions ---------------------------------------------------------*/
/** @defgroup RTC_Exported_Functions RTC Exported Functions
* @{
*/
2021-03-08 18:53:17 +01:00
/** @defgroup RTC_Exported_Functions_Group1 Initialization and de-initialization functions
* @brief Initialization and Configuration functions
2020-01-15 18:02:31 +01:00
*
2021-03-08 18:53:17 +01:00
@verbatim
2020-01-15 18:02:31 +01:00
===============================================================================
##### Initialization and de-initialization functions #####
===============================================================================
2021-03-08 18:53:17 +01:00
[..] This section provides functions allowing to initialize and configure the
RTC Prescaler (Asynchronous), disable RTC registers Write protection,
enter and exit the RTC initialization mode,
2020-01-15 18:02:31 +01:00
RTC registers synchronization check and reference clock detection enable.
2021-03-08 18:53:17 +01:00
(#) The RTC Prescaler should be programmed to generate the RTC 1Hz time base.
2020-01-15 18:02:31 +01:00
(#) All RTC registers are Write protected. Writing to the RTC registers
is enabled by setting the CNF bit in the RTC_CRL register.
2021-03-08 18:53:17 +01:00
(#) To read the calendar after wakeup from low power modes (Standby or Stop)
the software must first wait for the RSF bit (Register Synchronized Flag)
2020-01-15 18:02:31 +01:00
in the RTC_CRL register to be set by hardware.
2021-03-08 18:53:17 +01:00
The HAL_RTC_WaitForSynchro() function implements the above software
2020-01-15 18:02:31 +01:00
sequence (RSF clear and RSF check).
2021-03-08 18:53:17 +01:00
2020-01-15 18:02:31 +01:00
@endverbatim
* @{
*/
/**
2021-03-08 18:53:17 +01:00
* @brief Initializes the RTC peripheral
2020-01-15 18:02:31 +01:00
* @param hrtc pointer to a RTC_HandleTypeDef structure that contains
* the configuration information for RTC.
* @retval HAL status
*/
HAL_StatusTypeDef HAL_RTC_Init(RTC_HandleTypeDef *hrtc)
{
uint32_t prescaler = 0U;
/* Check input parameters */
2021-03-08 18:53:17 +01:00
if (hrtc == NULL)
2020-01-15 18:02:31 +01:00
{
2021-03-08 18:53:17 +01:00
return HAL_ERROR;
2020-01-15 18:02:31 +01:00
}
2021-03-08 18:53:17 +01:00
2020-01-15 18:02:31 +01:00
/* Check the parameters */
assert_param(IS_RTC_ALL_INSTANCE(hrtc->Instance));
assert_param(IS_RTC_CALIB_OUTPUT(hrtc->Init.OutPut));
assert_param(IS_RTC_ASYNCH_PREDIV(hrtc->Init.AsynchPrediv));
2021-03-08 18:53:17 +01:00
#if (USE_HAL_RTC_REGISTER_CALLBACKS == 1)
if (hrtc->State == HAL_RTC_STATE_RESET)
{
/* Allocate lock resource and initialize it */
hrtc->Lock = HAL_UNLOCKED;
hrtc->AlarmAEventCallback = HAL_RTC_AlarmAEventCallback; /* Legacy weak AlarmAEventCallback */
hrtc->Tamper1EventCallback = HAL_RTCEx_Tamper1EventCallback; /* Legacy weak Tamper1EventCallback */
if (hrtc->MspInitCallback == NULL)
{
hrtc->MspInitCallback = HAL_RTC_MspInit;
}
/* Init the low level hardware */
hrtc->MspInitCallback(hrtc);
if (hrtc->MspDeInitCallback == NULL)
{
hrtc->MspDeInitCallback = HAL_RTC_MspDeInit;
}
}
#else
if (hrtc->State == HAL_RTC_STATE_RESET)
2020-01-15 18:02:31 +01:00
{
/* Allocate lock resource and initialize it */
hrtc->Lock = HAL_UNLOCKED;
2021-03-08 18:53:17 +01:00
2020-01-15 18:02:31 +01:00
/* Initialize RTC MSP */
HAL_RTC_MspInit(hrtc);
}
2021-03-08 18:53:17 +01:00
#endif /* (USE_HAL_RTC_REGISTER_CALLBACKS) */
/* Set RTC state */
hrtc->State = HAL_RTC_STATE_BUSY;
2020-01-15 18:02:31 +01:00
/* Waiting for synchro */
2021-03-08 18:53:17 +01:00
if (HAL_RTC_WaitForSynchro(hrtc) != HAL_OK)
2020-01-15 18:02:31 +01:00
{
/* Set RTC state */
hrtc->State = HAL_RTC_STATE_ERROR;
2021-03-08 18:53:17 +01:00
2020-01-15 18:02:31 +01:00
return HAL_ERROR;
2021-03-08 18:53:17 +01:00
}
2020-01-15 18:02:31 +01:00
/* Set Initialization mode */
2021-03-08 18:53:17 +01:00
if (RTC_EnterInitMode(hrtc) != HAL_OK)
2020-01-15 18:02:31 +01:00
{
/* Set RTC state */
hrtc->State = HAL_RTC_STATE_ERROR;
2021-03-08 18:53:17 +01:00
2020-01-15 18:02:31 +01:00
return HAL_ERROR;
2021-03-08 18:53:17 +01:00
}
2020-01-15 18:02:31 +01:00
else
2021-03-08 18:53:17 +01:00
{
2020-01-15 18:02:31 +01:00
/* Clear Flags Bits */
CLEAR_BIT(hrtc->Instance->CRL, (RTC_FLAG_OW | RTC_FLAG_ALRAF | RTC_FLAG_SEC));
2021-03-08 18:53:17 +01:00
if (hrtc->Init.OutPut != RTC_OUTPUTSOURCE_NONE)
2020-01-15 18:02:31 +01:00
{
/* Disable the selected Tamper pin */
CLEAR_BIT(BKP->CR, BKP_CR_TPE);
}
2021-03-08 18:53:17 +01:00
2020-01-15 18:02:31 +01:00
/* Set the signal which will be routed to RTC Tamper pin*/
MODIFY_REG(BKP->RTCCR, (BKP_RTCCR_CCO | BKP_RTCCR_ASOE | BKP_RTCCR_ASOS), hrtc->Init.OutPut);
if (hrtc->Init.AsynchPrediv != RTC_AUTO_1_SECOND)
{
/* RTC Prescaler provided directly by end-user*/
prescaler = hrtc->Init.AsynchPrediv;
}
else
{
/* RTC Prescaler will be automatically calculated to get 1 second timebase */
/* Get the RTCCLK frequency */
prescaler = HAL_RCCEx_GetPeriphCLKFreq(RCC_PERIPHCLK_RTC);
/* Check that RTC clock is enabled*/
if (prescaler == 0U)
{
/* Should not happen. Frequency is not available*/
hrtc->State = HAL_RTC_STATE_ERROR;
return HAL_ERROR;
}
else
{
/* RTC period = RTCCLK/(RTC_PR + 1) */
prescaler = prescaler - 1U;
}
}
2021-03-08 18:53:17 +01:00
2020-01-15 18:02:31 +01:00
/* Configure the RTC_PRLH / RTC_PRLL */
MODIFY_REG(hrtc->Instance->PRLH, RTC_PRLH_PRL, (prescaler >> 16U));
MODIFY_REG(hrtc->Instance->PRLL, RTC_PRLL_PRL, (prescaler & RTC_PRLL_PRL));
2021-03-08 18:53:17 +01:00
2020-01-15 18:02:31 +01:00
/* Wait for synchro */
2021-03-08 18:53:17 +01:00
if (RTC_ExitInitMode(hrtc) != HAL_OK)
{
2020-01-15 18:02:31 +01:00
hrtc->State = HAL_RTC_STATE_ERROR;
2021-03-08 18:53:17 +01:00
2020-01-15 18:02:31 +01:00
return HAL_ERROR;
}
2021-03-08 18:53:17 +01:00
2020-01-15 18:02:31 +01:00
/* Initialize date to 1st of January 2000 */
hrtc->DateToUpdate.Year = 0x00U;
hrtc->DateToUpdate.Month = RTC_MONTH_JANUARY;
hrtc->DateToUpdate.Date = 0x01U;
/* Set RTC state */
hrtc->State = HAL_RTC_STATE_READY;
2021-03-08 18:53:17 +01:00
2020-01-15 18:02:31 +01:00
return HAL_OK;
}
}
/**
2021-03-08 18:53:17 +01:00
* @brief DeInitializes the RTC peripheral
2020-01-15 18:02:31 +01:00
* @param hrtc pointer to a RTC_HandleTypeDef structure that contains
* the configuration information for RTC.
2021-03-08 18:53:17 +01:00
* @note This function does not reset the RTC Backup Data registers.
2020-01-15 18:02:31 +01:00
* @retval HAL status
*/
HAL_StatusTypeDef HAL_RTC_DeInit(RTC_HandleTypeDef *hrtc)
{
/* Check input parameters */
2021-03-08 18:53:17 +01:00
if (hrtc == NULL)
2020-01-15 18:02:31 +01:00
{
2021-03-08 18:53:17 +01:00
return HAL_ERROR;
2020-01-15 18:02:31 +01:00
}
2021-03-08 18:53:17 +01:00
2020-01-15 18:02:31 +01:00
/* Check the parameters */
assert_param(IS_RTC_ALL_INSTANCE(hrtc->Instance));
/* Set RTC state */
2021-03-08 18:53:17 +01:00
hrtc->State = HAL_RTC_STATE_BUSY;
2020-01-15 18:02:31 +01:00
/* Set Initialization mode */
2021-03-08 18:53:17 +01:00
if (RTC_EnterInitMode(hrtc) != HAL_OK)
2020-01-15 18:02:31 +01:00
{
/* Set RTC state */
hrtc->State = HAL_RTC_STATE_ERROR;
2021-03-08 18:53:17 +01:00
2020-01-15 18:02:31 +01:00
/* Release Lock */
__HAL_UNLOCK(hrtc);
return HAL_ERROR;
2021-03-08 18:53:17 +01:00
}
2020-01-15 18:02:31 +01:00
else
{
CLEAR_REG(hrtc->Instance->CNTL);
CLEAR_REG(hrtc->Instance->CNTH);
WRITE_REG(hrtc->Instance->PRLL, 0x00008000U);
CLEAR_REG(hrtc->Instance->PRLH);
/* Reset All CRH/CRL bits */
CLEAR_REG(hrtc->Instance->CRH);
CLEAR_REG(hrtc->Instance->CRL);
2021-03-08 18:53:17 +01:00
if (RTC_ExitInitMode(hrtc) != HAL_OK)
{
2020-01-15 18:02:31 +01:00
hrtc->State = HAL_RTC_STATE_ERROR;
2021-03-08 18:53:17 +01:00
/* Process Unlocked */
2020-01-15 18:02:31 +01:00
__HAL_UNLOCK(hrtc);
2021-03-08 18:53:17 +01:00
2020-01-15 18:02:31 +01:00
return HAL_ERROR;
}
}
/* Wait for synchro*/
HAL_RTC_WaitForSynchro(hrtc);
/* Clear RSF flag */
CLEAR_BIT(hrtc->Instance->CRL, RTC_FLAG_RSF);
2021-03-08 18:53:17 +01:00
#if (USE_HAL_RTC_REGISTER_CALLBACKS == 1)
if (hrtc->MspDeInitCallback == NULL)
{
hrtc->MspDeInitCallback = HAL_RTC_MspDeInit;
}
/* DeInit the low level hardware: CLOCK, NVIC.*/
hrtc->MspDeInitCallback(hrtc);
#else
2020-01-15 18:02:31 +01:00
/* De-Initialize RTC MSP */
HAL_RTC_MspDeInit(hrtc);
2021-03-08 18:53:17 +01:00
#endif /* (USE_HAL_RTC_REGISTER_CALLBACKS) */
hrtc->State = HAL_RTC_STATE_RESET;
2020-01-15 18:02:31 +01:00
/* Release Lock */
__HAL_UNLOCK(hrtc);
return HAL_OK;
}
2021-03-08 18:53:17 +01:00
#if (USE_HAL_RTC_REGISTER_CALLBACKS == 1)
/**
* @brief Register a User RTC Callback
* To be used instead of the weak predefined callback
* @param hrtc RTC handle
* @param CallbackID ID of the callback to be registered
* This parameter can be one of the following values:
* @arg @ref HAL_RTC_ALARM_A_EVENT_CB_ID Alarm A Event Callback ID
* @arg @ref HAL_RTC_TAMPER1_EVENT_CB_ID Tamper 1 Callback ID
* @arg @ref HAL_RTC_MSPINIT_CB_ID Msp Init callback ID
* @arg @ref HAL_RTC_MSPDEINIT_CB_ID Msp DeInit callback ID
* @param pCallback pointer to the Callback function
* @retval HAL status
*/
HAL_StatusTypeDef HAL_RTC_RegisterCallback(RTC_HandleTypeDef *hrtc, HAL_RTC_CallbackIDTypeDef CallbackID, pRTC_CallbackTypeDef pCallback)
{
HAL_StatusTypeDef status = HAL_OK;
if (pCallback == NULL)
{
return HAL_ERROR;
}
/* Process locked */
__HAL_LOCK(hrtc);
if (HAL_RTC_STATE_READY == hrtc->State)
{
switch (CallbackID)
{
case HAL_RTC_ALARM_A_EVENT_CB_ID :
hrtc->AlarmAEventCallback = pCallback;
break;
case HAL_RTC_TAMPER1_EVENT_CB_ID :
hrtc->Tamper1EventCallback = pCallback;
break;
case HAL_RTC_MSPINIT_CB_ID :
hrtc->MspInitCallback = pCallback;
break;
case HAL_RTC_MSPDEINIT_CB_ID :
hrtc->MspDeInitCallback = pCallback;
break;
default :
/* Return error status */
status = HAL_ERROR;
break;
}
}
else if (HAL_RTC_STATE_RESET == hrtc->State)
{
switch (CallbackID)
{
case HAL_RTC_MSPINIT_CB_ID :
hrtc->MspInitCallback = pCallback;
break;
case HAL_RTC_MSPDEINIT_CB_ID :
hrtc->MspDeInitCallback = pCallback;
break;
default :
/* Return error status */
status = HAL_ERROR;
break;
}
}
else
{
/* Return error status */
status = HAL_ERROR;
}
/* Release Lock */
__HAL_UNLOCK(hrtc);
return status;
}
/**
* @brief Unregister an RTC Callback
* RTC callabck is redirected to the weak predefined callback
* @param hrtc RTC handle
* @param CallbackID ID of the callback to be unregistered
* This parameter can be one of the following values:
* @arg @ref HAL_RTC_ALARM_A_EVENT_CB_ID Alarm A Event Callback ID
* @arg @ref HAL_RTC_TAMPER1_EVENT_CB_ID Tamper 1 Callback ID
* @arg @ref HAL_RTC_MSPINIT_CB_ID Msp Init callback ID
* @arg @ref HAL_RTC_MSPDEINIT_CB_ID Msp DeInit callback ID
* @retval HAL status
*/
HAL_StatusTypeDef HAL_RTC_UnRegisterCallback(RTC_HandleTypeDef *hrtc, HAL_RTC_CallbackIDTypeDef CallbackID)
{
HAL_StatusTypeDef status = HAL_OK;
/* Process locked */
__HAL_LOCK(hrtc);
if (HAL_RTC_STATE_READY == hrtc->State)
{
switch (CallbackID)
{
case HAL_RTC_ALARM_A_EVENT_CB_ID :
hrtc->AlarmAEventCallback = HAL_RTC_AlarmAEventCallback; /* Legacy weak AlarmAEventCallback */
break;
case HAL_RTC_TAMPER1_EVENT_CB_ID :
hrtc->Tamper1EventCallback = HAL_RTCEx_Tamper1EventCallback; /* Legacy weak Tamper1EventCallback */
break;
case HAL_RTC_MSPINIT_CB_ID :
hrtc->MspInitCallback = HAL_RTC_MspInit;
break;
case HAL_RTC_MSPDEINIT_CB_ID :
hrtc->MspDeInitCallback = HAL_RTC_MspDeInit;
break;
default :
/* Return error status */
status = HAL_ERROR;
break;
}
}
else if (HAL_RTC_STATE_RESET == hrtc->State)
{
switch (CallbackID)
{
case HAL_RTC_MSPINIT_CB_ID :
hrtc->MspInitCallback = HAL_RTC_MspInit;
break;
case HAL_RTC_MSPDEINIT_CB_ID :
hrtc->MspDeInitCallback = HAL_RTC_MspDeInit;
break;
default :
/* Return error status */
status = HAL_ERROR;
break;
}
}
else
{
/* Return error status */
status = HAL_ERROR;
}
/* Release Lock */
__HAL_UNLOCK(hrtc);
return status;
}
#endif /* USE_HAL_RTC_REGISTER_CALLBACKS */
2020-01-15 18:02:31 +01:00
/**
* @brief Initializes the RTC MSP.
* @param hrtc pointer to a RTC_HandleTypeDef structure that contains
2021-03-08 18:53:17 +01:00
* the configuration information for RTC.
2020-01-15 18:02:31 +01:00
* @retval None
*/
2021-03-08 18:53:17 +01:00
__weak void HAL_RTC_MspInit(RTC_HandleTypeDef *hrtc)
2020-01-15 18:02:31 +01:00
{
/* Prevent unused argument(s) compilation warning */
UNUSED(hrtc);
/* NOTE : This function Should not be modified, when the callback is needed,
the HAL_RTC_MspInit could be implemented in the user file
2021-03-08 18:53:17 +01:00
*/
2020-01-15 18:02:31 +01:00
}
/**
* @brief DeInitializes the RTC MSP.
* @param hrtc pointer to a RTC_HandleTypeDef structure that contains
2021-03-08 18:53:17 +01:00
* the configuration information for RTC.
2020-01-15 18:02:31 +01:00
* @retval None
*/
2021-03-08 18:53:17 +01:00
__weak void HAL_RTC_MspDeInit(RTC_HandleTypeDef *hrtc)
2020-01-15 18:02:31 +01:00
{
/* Prevent unused argument(s) compilation warning */
UNUSED(hrtc);
/* NOTE : This function Should not be modified, when the callback is needed,
the HAL_RTC_MspDeInit could be implemented in the user file
2021-03-08 18:53:17 +01:00
*/
2020-01-15 18:02:31 +01:00
}
/**
* @}
*/
/** @defgroup RTC_Exported_Functions_Group2 Time and Date functions
* @brief RTC Time and Date functions
*
2021-03-08 18:53:17 +01:00
@verbatim
2020-01-15 18:02:31 +01:00
===============================================================================
##### RTC Time and Date functions #####
2021-03-08 18:53:17 +01:00
===============================================================================
2020-01-15 18:02:31 +01:00
[..] This section provides functions allowing to configure Time and Date features
@endverbatim
* @{
*/
/**
* @brief Sets RTC current time.
* @param hrtc pointer to a RTC_HandleTypeDef structure that contains
* the configuration information for RTC.
* @param sTime: Pointer to Time structure
* @param Format: Specifies the format of the entered parameters.
* This parameter can be one of the following values:
2021-03-08 18:53:17 +01:00
* @arg RTC_FORMAT_BIN: Binary data format
2020-01-15 18:02:31 +01:00
* @arg RTC_FORMAT_BCD: BCD data format
* @retval HAL status
*/
HAL_StatusTypeDef HAL_RTC_SetTime(RTC_HandleTypeDef *hrtc, RTC_TimeTypeDef *sTime, uint32_t Format)
{
uint32_t counter_time = 0U, counter_alarm = 0U;
2021-03-08 18:53:17 +01:00
2020-01-15 18:02:31 +01:00
/* Check input parameters */
2021-03-08 18:53:17 +01:00
if ((hrtc == NULL) || (sTime == NULL))
2020-01-15 18:02:31 +01:00
{
2021-03-08 18:53:17 +01:00
return HAL_ERROR;
2020-01-15 18:02:31 +01:00
}
2021-03-08 18:53:17 +01:00
/* Check the parameters */
2020-01-15 18:02:31 +01:00
assert_param(IS_RTC_FORMAT(Format));
2021-03-08 18:53:17 +01:00
/* Process Locked */
2020-01-15 18:02:31 +01:00
__HAL_LOCK(hrtc);
2021-03-08 18:53:17 +01:00
2020-01-15 18:02:31 +01:00
hrtc->State = HAL_RTC_STATE_BUSY;
2021-03-08 18:53:17 +01:00
if (Format == RTC_FORMAT_BIN)
2020-01-15 18:02:31 +01:00
{
assert_param(IS_RTC_HOUR24(sTime->Hours));
assert_param(IS_RTC_MINUTES(sTime->Minutes));
assert_param(IS_RTC_SECONDS(sTime->Seconds));
counter_time = (uint32_t)(((uint32_t)sTime->Hours * 3600U) + \
2021-03-08 18:53:17 +01:00
((uint32_t)sTime->Minutes * 60U) + \
((uint32_t)sTime->Seconds));
2020-01-15 18:02:31 +01:00
}
else
{
assert_param(IS_RTC_HOUR24(RTC_Bcd2ToByte(sTime->Hours)));
assert_param(IS_RTC_MINUTES(RTC_Bcd2ToByte(sTime->Minutes)));
assert_param(IS_RTC_SECONDS(RTC_Bcd2ToByte(sTime->Seconds)));
counter_time = (((uint32_t)(RTC_Bcd2ToByte(sTime->Hours)) * 3600U) + \
2021-03-08 18:53:17 +01:00
((uint32_t)(RTC_Bcd2ToByte(sTime->Minutes)) * 60U) + \
((uint32_t)(RTC_Bcd2ToByte(sTime->Seconds))));
2020-01-15 18:02:31 +01:00
}
/* Write time counter in RTC registers */
if (RTC_WriteTimeCounter(hrtc, counter_time) != HAL_OK)
{
/* Set RTC state */
hrtc->State = HAL_RTC_STATE_ERROR;
2021-03-08 18:53:17 +01:00
/* Process Unlocked */
2020-01-15 18:02:31 +01:00
__HAL_UNLOCK(hrtc);
2021-03-08 18:53:17 +01:00
2020-01-15 18:02:31 +01:00
return HAL_ERROR;
}
else
{
/* Clear Second and overflow flags */
CLEAR_BIT(hrtc->Instance->CRL, (RTC_FLAG_SEC | RTC_FLAG_OW));
2021-03-08 18:53:17 +01:00
2020-01-15 18:02:31 +01:00
/* Read current Alarm counter in RTC registers */
counter_alarm = RTC_ReadAlarmCounter(hrtc);
/* Set again alarm to match with new time if enabled */
if (counter_alarm != RTC_ALARM_RESETVALUE)
{
2021-03-08 18:53:17 +01:00
if (counter_alarm < counter_time)
2020-01-15 18:02:31 +01:00
{
/* Add 1 day to alarm counter*/
counter_alarm += (uint32_t)(24U * 3600U);
2021-03-08 18:53:17 +01:00
2020-01-15 18:02:31 +01:00
/* Write new Alarm counter in RTC registers */
if (RTC_WriteAlarmCounter(hrtc, counter_alarm) != HAL_OK)
{
/* Set RTC state */
hrtc->State = HAL_RTC_STATE_ERROR;
2021-03-08 18:53:17 +01:00
/* Process Unlocked */
2020-01-15 18:02:31 +01:00
__HAL_UNLOCK(hrtc);
2021-03-08 18:53:17 +01:00
2020-01-15 18:02:31 +01:00
return HAL_ERROR;
}
}
}
2021-03-08 18:53:17 +01:00
2020-01-15 18:02:31 +01:00
hrtc->State = HAL_RTC_STATE_READY;
2021-03-08 18:53:17 +01:00
__HAL_UNLOCK(hrtc);
return HAL_OK;
2020-01-15 18:02:31 +01:00
}
}
/**
* @brief Gets RTC current time.
* @param hrtc pointer to a RTC_HandleTypeDef structure that contains
* the configuration information for RTC.
* @param sTime: Pointer to Time structure
* @param Format: Specifies the format of the entered parameters.
* This parameter can be one of the following values:
2021-03-08 18:53:17 +01:00
* @arg RTC_FORMAT_BIN: Binary data format
2020-01-15 18:02:31 +01:00
* @arg RTC_FORMAT_BCD: BCD data format
* @retval HAL status
*/
HAL_StatusTypeDef HAL_RTC_GetTime(RTC_HandleTypeDef *hrtc, RTC_TimeTypeDef *sTime, uint32_t Format)
{
uint32_t counter_time = 0U, counter_alarm = 0U, days_elapsed = 0U, hours = 0U;
2021-03-08 18:53:17 +01:00
2020-01-15 18:02:31 +01:00
/* Check input parameters */
2021-03-08 18:53:17 +01:00
if ((hrtc == NULL) || (sTime == NULL))
2020-01-15 18:02:31 +01:00
{
2021-03-08 18:53:17 +01:00
return HAL_ERROR;
2020-01-15 18:02:31 +01:00
}
/* Check the parameters */
assert_param(IS_RTC_FORMAT(Format));
/* Check if counter overflow occurred */
if (__HAL_RTC_OVERFLOW_GET_FLAG(hrtc, RTC_FLAG_OW))
{
2021-03-08 18:53:17 +01:00
return HAL_ERROR;
2020-01-15 18:02:31 +01:00
}
/* Read the time counter*/
counter_time = RTC_ReadTimeCounter(hrtc);
/* Fill the structure fields with the read parameters */
hours = counter_time / 3600U;
sTime->Minutes = (uint8_t)((counter_time % 3600U) / 60U);
sTime->Seconds = (uint8_t)((counter_time % 3600U) % 60U);
if (hours >= 24U)
{
/* Get number of days elapsed from last calculation */
days_elapsed = (hours / 24U);
/* Set Hours in RTC_TimeTypeDef structure*/
2021-03-08 18:53:17 +01:00
sTime->Hours = (hours % 24U);
2020-01-15 18:02:31 +01:00
/* Read Alarm counter in RTC registers */
counter_alarm = RTC_ReadAlarmCounter(hrtc);
/* Calculate remaining time to reach alarm (only if set and not yet expired)*/
if ((counter_alarm != RTC_ALARM_RESETVALUE) && (counter_alarm > counter_time))
{
counter_alarm -= counter_time;
}
2021-03-08 18:53:17 +01:00
else
2020-01-15 18:02:31 +01:00
{
/* In case of counter_alarm < counter_time */
/* Alarm expiration already occurred but alarm not deactivated */
counter_alarm = RTC_ALARM_RESETVALUE;
}
/* Set updated time in decreasing counter by number of days elapsed */
counter_time -= (days_elapsed * 24U * 3600U);
2021-03-08 18:53:17 +01:00
2020-01-15 18:02:31 +01:00
/* Write time counter in RTC registers */
if (RTC_WriteTimeCounter(hrtc, counter_time) != HAL_OK)
{
return HAL_ERROR;
}
/* Set updated alarm to be set */
if (counter_alarm != RTC_ALARM_RESETVALUE)
{
counter_alarm += counter_time;
2021-03-08 18:53:17 +01:00
2020-01-15 18:02:31 +01:00
/* Write time counter in RTC registers */
if (RTC_WriteAlarmCounter(hrtc, counter_alarm) != HAL_OK)
{
return HAL_ERROR;
}
}
else
{
/* Alarm already occurred. Set it to reset values to avoid unexpected expiration */
if (RTC_WriteAlarmCounter(hrtc, counter_alarm) != HAL_OK)
{
return HAL_ERROR;
}
}
2021-03-08 18:53:17 +01:00
2020-01-15 18:02:31 +01:00
/* Update date */
RTC_DateUpdate(hrtc, days_elapsed);
}
2021-03-08 18:53:17 +01:00
else
2020-01-15 18:02:31 +01:00
{
2021-03-08 18:53:17 +01:00
sTime->Hours = hours;
2020-01-15 18:02:31 +01:00
}
/* Check the input parameters format */
2021-03-08 18:53:17 +01:00
if (Format != RTC_FORMAT_BIN)
2020-01-15 18:02:31 +01:00
{
/* Convert the time structure parameters to BCD format */
sTime->Hours = (uint8_t)RTC_ByteToBcd2(sTime->Hours);
sTime->Minutes = (uint8_t)RTC_ByteToBcd2(sTime->Minutes);
2021-03-08 18:53:17 +01:00
sTime->Seconds = (uint8_t)RTC_ByteToBcd2(sTime->Seconds);
2020-01-15 18:02:31 +01:00
}
2021-03-08 18:53:17 +01:00
2020-01-15 18:02:31 +01:00
return HAL_OK;
}
/**
* @brief Sets RTC current date.
* @param hrtc pointer to a RTC_HandleTypeDef structure that contains
* the configuration information for RTC.
* @param sDate: Pointer to date structure
* @param Format: specifies the format of the entered parameters.
* This parameter can be one of the following values:
2021-03-08 18:53:17 +01:00
* @arg RTC_FORMAT_BIN: Binary data format
2020-01-15 18:02:31 +01:00
* @arg RTC_FORMAT_BCD: BCD data format
* @retval HAL status
*/
HAL_StatusTypeDef HAL_RTC_SetDate(RTC_HandleTypeDef *hrtc, RTC_DateTypeDef *sDate, uint32_t Format)
{
uint32_t counter_time = 0U, counter_alarm = 0U, hours = 0U;
2021-03-08 18:53:17 +01:00
2020-01-15 18:02:31 +01:00
/* Check input parameters */
2021-03-08 18:53:17 +01:00
if ((hrtc == NULL) || (sDate == NULL))
2020-01-15 18:02:31 +01:00
{
2021-03-08 18:53:17 +01:00
return HAL_ERROR;
2020-01-15 18:02:31 +01:00
}
2021-03-08 18:53:17 +01:00
2020-01-15 18:02:31 +01:00
/* Check the parameters */
assert_param(IS_RTC_FORMAT(Format));
2021-03-08 18:53:17 +01:00
/* Process Locked */
__HAL_LOCK(hrtc);
hrtc->State = HAL_RTC_STATE_BUSY;
if (Format == RTC_FORMAT_BIN)
{
2020-01-15 18:02:31 +01:00
assert_param(IS_RTC_YEAR(sDate->Year));
assert_param(IS_RTC_MONTH(sDate->Month));
2021-03-08 18:53:17 +01:00
assert_param(IS_RTC_DATE(sDate->Date));
2020-01-15 18:02:31 +01:00
/* Change the current date */
hrtc->DateToUpdate.Year = sDate->Year;
hrtc->DateToUpdate.Month = sDate->Month;
hrtc->DateToUpdate.Date = sDate->Date;
}
else
2021-03-08 18:53:17 +01:00
{
2020-01-15 18:02:31 +01:00
assert_param(IS_RTC_YEAR(RTC_Bcd2ToByte(sDate->Year)));
assert_param(IS_RTC_MONTH(RTC_Bcd2ToByte(sDate->Month)));
assert_param(IS_RTC_DATE(RTC_Bcd2ToByte(sDate->Date)));
2021-03-08 18:53:17 +01:00
2020-01-15 18:02:31 +01:00
/* Change the current date */
hrtc->DateToUpdate.Year = RTC_Bcd2ToByte(sDate->Year);
hrtc->DateToUpdate.Month = RTC_Bcd2ToByte(sDate->Month);
hrtc->DateToUpdate.Date = RTC_Bcd2ToByte(sDate->Date);
}
/* WeekDay set by user can be ignored because automatically calculated */
hrtc->DateToUpdate.WeekDay = RTC_WeekDayNum(hrtc->DateToUpdate.Year, hrtc->DateToUpdate.Month, hrtc->DateToUpdate.Date);
sDate->WeekDay = hrtc->DateToUpdate.WeekDay;
/* Reset time to be aligned on the same day */
/* Read the time counter*/
counter_time = RTC_ReadTimeCounter(hrtc);
/* Fill the structure fields with the read parameters */
hours = counter_time / 3600U;
if (hours > 24U)
{
/* Set updated time in decreasing counter by number of days elapsed */
counter_time -= ((hours / 24U) * 24U * 3600U);
/* Write time counter in RTC registers */
if (RTC_WriteTimeCounter(hrtc, counter_time) != HAL_OK)
{
/* Set RTC state */
hrtc->State = HAL_RTC_STATE_ERROR;
2021-03-08 18:53:17 +01:00
/* Process Unlocked */
2020-01-15 18:02:31 +01:00
__HAL_UNLOCK(hrtc);
2021-03-08 18:53:17 +01:00
2020-01-15 18:02:31 +01:00
return HAL_ERROR;
}
/* Read current Alarm counter in RTC registers */
counter_alarm = RTC_ReadAlarmCounter(hrtc);
/* Set again alarm to match with new time if enabled */
if (counter_alarm != RTC_ALARM_RESETVALUE)
{
2021-03-08 18:53:17 +01:00
if (counter_alarm < counter_time)
2020-01-15 18:02:31 +01:00
{
/* Add 1 day to alarm counter*/
counter_alarm += (uint32_t)(24U * 3600U);
2021-03-08 18:53:17 +01:00
2020-01-15 18:02:31 +01:00
/* Write new Alarm counter in RTC registers */
if (RTC_WriteAlarmCounter(hrtc, counter_alarm) != HAL_OK)
{
/* Set RTC state */
hrtc->State = HAL_RTC_STATE_ERROR;
2021-03-08 18:53:17 +01:00
/* Process Unlocked */
2020-01-15 18:02:31 +01:00
__HAL_UNLOCK(hrtc);
2021-03-08 18:53:17 +01:00
2020-01-15 18:02:31 +01:00
return HAL_ERROR;
}
}
}
2021-03-08 18:53:17 +01:00
2020-01-15 18:02:31 +01:00
}
hrtc->State = HAL_RTC_STATE_READY ;
2021-03-08 18:53:17 +01:00
/* Process Unlocked */
2020-01-15 18:02:31 +01:00
__HAL_UNLOCK(hrtc);
2021-03-08 18:53:17 +01:00
return HAL_OK;
2020-01-15 18:02:31 +01:00
}
/**
* @brief Gets RTC current date.
* @param hrtc pointer to a RTC_HandleTypeDef structure that contains
* the configuration information for RTC.
* @param sDate: Pointer to Date structure
* @param Format: Specifies the format of the entered parameters.
* This parameter can be one of the following values:
2021-03-08 18:53:17 +01:00
* @arg RTC_FORMAT_BIN: Binary data format
2020-01-15 18:02:31 +01:00
* @arg RTC_FORMAT_BCD: BCD data format
* @retval HAL status
*/
HAL_StatusTypeDef HAL_RTC_GetDate(RTC_HandleTypeDef *hrtc, RTC_DateTypeDef *sDate, uint32_t Format)
{
RTC_TimeTypeDef stime = {0U};
2021-03-08 18:53:17 +01:00
2020-01-15 18:02:31 +01:00
/* Check input parameters */
2021-03-08 18:53:17 +01:00
if ((hrtc == NULL) || (sDate == NULL))
2020-01-15 18:02:31 +01:00
{
2021-03-08 18:53:17 +01:00
return HAL_ERROR;
2020-01-15 18:02:31 +01:00
}
2021-03-08 18:53:17 +01:00
2020-01-15 18:02:31 +01:00
/* Check the parameters */
assert_param(IS_RTC_FORMAT(Format));
2021-03-08 18:53:17 +01:00
2020-01-15 18:02:31 +01:00
/* Call HAL_RTC_GetTime function to update date if counter higher than 24 hours */
if (HAL_RTC_GetTime(hrtc, &stime, RTC_FORMAT_BIN) != HAL_OK)
{
return HAL_ERROR;
}
/* Fill the structure fields with the read parameters */
sDate->WeekDay = hrtc->DateToUpdate.WeekDay;
sDate->Year = hrtc->DateToUpdate.Year;
sDate->Month = hrtc->DateToUpdate.Month;
sDate->Date = hrtc->DateToUpdate.Date;
/* Check the input parameters format */
2021-03-08 18:53:17 +01:00
if (Format != RTC_FORMAT_BIN)
{
2020-01-15 18:02:31 +01:00
/* Convert the date structure parameters to BCD format */
sDate->Year = (uint8_t)RTC_ByteToBcd2(sDate->Year);
sDate->Month = (uint8_t)RTC_ByteToBcd2(sDate->Month);
2021-03-08 18:53:17 +01:00
sDate->Date = (uint8_t)RTC_ByteToBcd2(sDate->Date);
2020-01-15 18:02:31 +01:00
}
return HAL_OK;
}
/**
* @}
*/
/** @defgroup RTC_Exported_Functions_Group3 Alarm functions
* @brief RTC Alarm functions
*
2021-03-08 18:53:17 +01:00
@verbatim
2020-01-15 18:02:31 +01:00
===============================================================================
##### RTC Alarm functions #####
2021-03-08 18:53:17 +01:00
===============================================================================
2020-01-15 18:02:31 +01:00
[..] This section provides functions allowing to configure Alarm feature
@endverbatim
* @{
*/
/**
* @brief Sets the specified RTC Alarm.
* @param hrtc pointer to a RTC_HandleTypeDef structure that contains
* the configuration information for RTC.
* @param sAlarm: Pointer to Alarm structure
* @param Format: Specifies the format of the entered parameters.
* This parameter can be one of the following values:
2021-03-08 18:53:17 +01:00
* @arg RTC_FORMAT_BIN: Binary data format
2020-01-15 18:02:31 +01:00
* @arg RTC_FORMAT_BCD: BCD data format
* @retval HAL status
*/
HAL_StatusTypeDef HAL_RTC_SetAlarm(RTC_HandleTypeDef *hrtc, RTC_AlarmTypeDef *sAlarm, uint32_t Format)
{
uint32_t counter_alarm = 0U, counter_time;
RTC_TimeTypeDef stime = {0U};
2021-03-08 18:53:17 +01:00
2020-01-15 18:02:31 +01:00
/* Check input parameters */
2021-03-08 18:53:17 +01:00
if ((hrtc == NULL) || (sAlarm == NULL))
2020-01-15 18:02:31 +01:00
{
2021-03-08 18:53:17 +01:00
return HAL_ERROR;
2020-01-15 18:02:31 +01:00
}
2021-03-08 18:53:17 +01:00
2020-01-15 18:02:31 +01:00
/* Check the parameters */
assert_param(IS_RTC_FORMAT(Format));
assert_param(IS_RTC_ALARM(sAlarm->Alarm));
2021-03-08 18:53:17 +01:00
/* Process Locked */
2020-01-15 18:02:31 +01:00
__HAL_LOCK(hrtc);
2021-03-08 18:53:17 +01:00
2020-01-15 18:02:31 +01:00
hrtc->State = HAL_RTC_STATE_BUSY;
2021-03-08 18:53:17 +01:00
2020-01-15 18:02:31 +01:00
/* Call HAL_RTC_GetTime function to update date if counter higher than 24 hours */
if (HAL_RTC_GetTime(hrtc, &stime, RTC_FORMAT_BIN) != HAL_OK)
{
return HAL_ERROR;
}
/* Convert time in seconds */
counter_time = (uint32_t)(((uint32_t)stime.Hours * 3600U) + \
2021-03-08 18:53:17 +01:00
((uint32_t)stime.Minutes * 60U) + \
((uint32_t)stime.Seconds));
2020-01-15 18:02:31 +01:00
2021-03-08 18:53:17 +01:00
if (Format == RTC_FORMAT_BIN)
2020-01-15 18:02:31 +01:00
{
assert_param(IS_RTC_HOUR24(sAlarm->AlarmTime.Hours));
assert_param(IS_RTC_MINUTES(sAlarm->AlarmTime.Minutes));
assert_param(IS_RTC_SECONDS(sAlarm->AlarmTime.Seconds));
2021-03-08 18:53:17 +01:00
2020-01-15 18:02:31 +01:00
counter_alarm = (uint32_t)(((uint32_t)sAlarm->AlarmTime.Hours * 3600U) + \
2021-03-08 18:53:17 +01:00
((uint32_t)sAlarm->AlarmTime.Minutes * 60U) + \
((uint32_t)sAlarm->AlarmTime.Seconds));
2020-01-15 18:02:31 +01:00
}
else
{
assert_param(IS_RTC_HOUR24(RTC_Bcd2ToByte(sAlarm->AlarmTime.Hours)));
assert_param(IS_RTC_MINUTES(RTC_Bcd2ToByte(sAlarm->AlarmTime.Minutes)));
assert_param(IS_RTC_SECONDS(RTC_Bcd2ToByte(sAlarm->AlarmTime.Seconds)));
2021-03-08 18:53:17 +01:00
2020-01-15 18:02:31 +01:00
counter_alarm = (((uint32_t)(RTC_Bcd2ToByte(sAlarm->AlarmTime.Hours)) * 3600U) + \
2021-03-08 18:53:17 +01:00
((uint32_t)(RTC_Bcd2ToByte(sAlarm->AlarmTime.Minutes)) * 60U) + \
((uint32_t)RTC_Bcd2ToByte(sAlarm->AlarmTime.Seconds)));
2020-01-15 18:02:31 +01:00
}
/* Check that requested alarm should expire in the same day (otherwise add 1 day) */
if (counter_alarm < counter_time)
{
/* Add 1 day to alarm counter*/
counter_alarm += (uint32_t)(24U * 3600U);
}
/* Write Alarm counter in RTC registers */
if (RTC_WriteAlarmCounter(hrtc, counter_alarm) != HAL_OK)
{
/* Set RTC state */
hrtc->State = HAL_RTC_STATE_ERROR;
2021-03-08 18:53:17 +01:00
/* Process Unlocked */
2020-01-15 18:02:31 +01:00
__HAL_UNLOCK(hrtc);
2021-03-08 18:53:17 +01:00
2020-01-15 18:02:31 +01:00
return HAL_ERROR;
}
else
{
hrtc->State = HAL_RTC_STATE_READY;
2021-03-08 18:53:17 +01:00
__HAL_UNLOCK(hrtc);
return HAL_OK;
2020-01-15 18:02:31 +01:00
}
}
/**
2021-03-08 18:53:17 +01:00
* @brief Sets the specified RTC Alarm with Interrupt
2020-01-15 18:02:31 +01:00
* @param hrtc pointer to a RTC_HandleTypeDef structure that contains
* the configuration information for RTC.
* @param sAlarm: Pointer to Alarm structure
* @param Format: Specifies the format of the entered parameters.
* This parameter can be one of the following values:
2021-03-08 18:53:17 +01:00
* @arg RTC_FORMAT_BIN: Binary data format
2020-01-15 18:02:31 +01:00
* @arg RTC_FORMAT_BCD: BCD data format
2021-03-08 18:53:17 +01:00
* @note The HAL_RTC_SetTime() must be called before enabling the Alarm feature.
2020-01-15 18:02:31 +01:00
* @retval HAL status
*/
HAL_StatusTypeDef HAL_RTC_SetAlarm_IT(RTC_HandleTypeDef *hrtc, RTC_AlarmTypeDef *sAlarm, uint32_t Format)
{
uint32_t counter_alarm = 0U, counter_time;
RTC_TimeTypeDef stime = {0U};
2021-03-08 18:53:17 +01:00
2020-01-15 18:02:31 +01:00
/* Check input parameters */
2021-03-08 18:53:17 +01:00
if ((hrtc == NULL) || (sAlarm == NULL))
2020-01-15 18:02:31 +01:00
{
2021-03-08 18:53:17 +01:00
return HAL_ERROR;
2020-01-15 18:02:31 +01:00
}
2021-03-08 18:53:17 +01:00
2020-01-15 18:02:31 +01:00
/* Check the parameters */
assert_param(IS_RTC_FORMAT(Format));
assert_param(IS_RTC_ALARM(sAlarm->Alarm));
2021-03-08 18:53:17 +01:00
/* Process Locked */
2020-01-15 18:02:31 +01:00
__HAL_LOCK(hrtc);
2021-03-08 18:53:17 +01:00
2020-01-15 18:02:31 +01:00
hrtc->State = HAL_RTC_STATE_BUSY;
2021-03-08 18:53:17 +01:00
2020-01-15 18:02:31 +01:00
/* Call HAL_RTC_GetTime function to update date if counter higher than 24 hours */
if (HAL_RTC_GetTime(hrtc, &stime, RTC_FORMAT_BIN) != HAL_OK)
{
return HAL_ERROR;
}
/* Convert time in seconds */
counter_time = (uint32_t)(((uint32_t)stime.Hours * 3600U) + \
2021-03-08 18:53:17 +01:00
((uint32_t)stime.Minutes * 60U) + \
((uint32_t)stime.Seconds));
2020-01-15 18:02:31 +01:00
2021-03-08 18:53:17 +01:00
if (Format == RTC_FORMAT_BIN)
2020-01-15 18:02:31 +01:00
{
assert_param(IS_RTC_HOUR24(sAlarm->AlarmTime.Hours));
assert_param(IS_RTC_MINUTES(sAlarm->AlarmTime.Minutes));
assert_param(IS_RTC_SECONDS(sAlarm->AlarmTime.Seconds));
2021-03-08 18:53:17 +01:00
2020-01-15 18:02:31 +01:00
counter_alarm = (uint32_t)(((uint32_t)sAlarm->AlarmTime.Hours * 3600U) + \
2021-03-08 18:53:17 +01:00
((uint32_t)sAlarm->AlarmTime.Minutes * 60U) + \
((uint32_t)sAlarm->AlarmTime.Seconds));
2020-01-15 18:02:31 +01:00
}
else
{
assert_param(IS_RTC_HOUR24(RTC_Bcd2ToByte(sAlarm->AlarmTime.Hours)));
assert_param(IS_RTC_MINUTES(RTC_Bcd2ToByte(sAlarm->AlarmTime.Minutes)));
assert_param(IS_RTC_SECONDS(RTC_Bcd2ToByte(sAlarm->AlarmTime.Seconds)));
2021-03-08 18:53:17 +01:00
2020-01-15 18:02:31 +01:00
counter_alarm = (((uint32_t)(RTC_Bcd2ToByte(sAlarm->AlarmTime.Hours)) * 3600U) + \
((uint32_t)(RTC_Bcd2ToByte(sAlarm->AlarmTime.Minutes)) * 60U) + \
2021-03-08 18:53:17 +01:00
((uint32_t)RTC_Bcd2ToByte(sAlarm->AlarmTime.Seconds)));
2020-01-15 18:02:31 +01:00
}
2021-03-08 18:53:17 +01:00
2020-01-15 18:02:31 +01:00
/* Check that requested alarm should expire in the same day (otherwise add 1 day) */
if (counter_alarm < counter_time)
{
/* Add 1 day to alarm counter*/
counter_alarm += (uint32_t)(24U * 3600U);
}
/* Write alarm counter in RTC registers */
if (RTC_WriteAlarmCounter(hrtc, counter_alarm) != HAL_OK)
{
/* Set RTC state */
hrtc->State = HAL_RTC_STATE_ERROR;
2021-03-08 18:53:17 +01:00
/* Process Unlocked */
2020-01-15 18:02:31 +01:00
__HAL_UNLOCK(hrtc);
2021-03-08 18:53:17 +01:00
2020-01-15 18:02:31 +01:00
return HAL_ERROR;
}
else
{
/* Clear flag alarm A */
__HAL_RTC_ALARM_CLEAR_FLAG(hrtc, RTC_FLAG_ALRAF);
2021-03-08 18:53:17 +01:00
2020-01-15 18:02:31 +01:00
/* Configure the Alarm interrupt */
2021-03-08 18:53:17 +01:00
__HAL_RTC_ALARM_ENABLE_IT(hrtc, RTC_IT_ALRA);
2020-01-15 18:02:31 +01:00
/* RTC Alarm Interrupt Configuration: EXTI configuration */
__HAL_RTC_ALARM_EXTI_ENABLE_IT();
2021-03-08 18:53:17 +01:00
2020-01-15 18:02:31 +01:00
__HAL_RTC_ALARM_EXTI_ENABLE_RISING_EDGE();
hrtc->State = HAL_RTC_STATE_READY;
2021-03-08 18:53:17 +01:00
__HAL_UNLOCK(hrtc);
return HAL_OK;
2020-01-15 18:02:31 +01:00
}
}
/**
* @brief Gets the RTC Alarm value and masks.
* @param hrtc pointer to a RTC_HandleTypeDef structure that contains
* the configuration information for RTC.
* @param sAlarm: Pointer to Date structure
* @param Alarm: Specifies the Alarm.
* This parameter can be one of the following values:
* @arg RTC_ALARM_A: Alarm
* @param Format: Specifies the format of the entered parameters.
* This parameter can be one of the following values:
2021-03-08 18:53:17 +01:00
* @arg RTC_FORMAT_BIN: Binary data format
2020-01-15 18:02:31 +01:00
* @arg RTC_FORMAT_BCD: BCD data format
* @retval HAL status
*/
HAL_StatusTypeDef HAL_RTC_GetAlarm(RTC_HandleTypeDef *hrtc, RTC_AlarmTypeDef *sAlarm, uint32_t Alarm, uint32_t Format)
{
uint32_t counter_alarm = 0U;
/* Prevent unused argument(s) compilation warning */
UNUSED(Alarm);
/* Check input parameters */
2021-03-08 18:53:17 +01:00
if ((hrtc == NULL) || (sAlarm == NULL))
2020-01-15 18:02:31 +01:00
{
return HAL_ERROR;
}
2021-03-08 18:53:17 +01:00
2020-01-15 18:02:31 +01:00
/* Check the parameters */
assert_param(IS_RTC_FORMAT(Format));
assert_param(IS_RTC_ALARM(Alarm));
2021-03-08 18:53:17 +01:00
2020-01-15 18:02:31 +01:00
/* Read Alarm counter in RTC registers */
counter_alarm = RTC_ReadAlarmCounter(hrtc);
/* Fill the structure with the read parameters */
/* Set hours in a day range (between 0 to 24)*/
sAlarm->AlarmTime.Hours = (uint32_t)((counter_alarm / 3600U) % 24U);
sAlarm->AlarmTime.Minutes = (uint32_t)((counter_alarm % 3600U) / 60U);
sAlarm->AlarmTime.Seconds = (uint32_t)((counter_alarm % 3600U) % 60U);
2021-03-08 18:53:17 +01:00
if (Format != RTC_FORMAT_BIN)
2020-01-15 18:02:31 +01:00
{
sAlarm->AlarmTime.Hours = RTC_ByteToBcd2(sAlarm->AlarmTime.Hours);
sAlarm->AlarmTime.Minutes = RTC_ByteToBcd2(sAlarm->AlarmTime.Minutes);
sAlarm->AlarmTime.Seconds = RTC_ByteToBcd2(sAlarm->AlarmTime.Seconds);
2021-03-08 18:53:17 +01:00
}
2020-01-15 18:02:31 +01:00
return HAL_OK;
}
/**
2021-03-08 18:53:17 +01:00
* @brief Deactive the specified RTC Alarm
2020-01-15 18:02:31 +01:00
* @param hrtc pointer to a RTC_HandleTypeDef structure that contains
* the configuration information for RTC.
* @param Alarm: Specifies the Alarm.
* This parameter can be one of the following values:
* @arg RTC_ALARM_A: AlarmA
* @retval HAL status
*/
HAL_StatusTypeDef HAL_RTC_DeactivateAlarm(RTC_HandleTypeDef *hrtc, uint32_t Alarm)
{
/* Prevent unused argument(s) compilation warning */
UNUSED(Alarm);
/* Check the parameters */
assert_param(IS_RTC_ALARM(Alarm));
2021-03-08 18:53:17 +01:00
2020-01-15 18:02:31 +01:00
/* Check input parameters */
2021-03-08 18:53:17 +01:00
if (hrtc == NULL)
2020-01-15 18:02:31 +01:00
{
2021-03-08 18:53:17 +01:00
return HAL_ERROR;
2020-01-15 18:02:31 +01:00
}
2021-03-08 18:53:17 +01:00
/* Process Locked */
2020-01-15 18:02:31 +01:00
__HAL_LOCK(hrtc);
2021-03-08 18:53:17 +01:00
2020-01-15 18:02:31 +01:00
hrtc->State = HAL_RTC_STATE_BUSY;
2021-03-08 18:53:17 +01:00
/* In case of interrupt mode is used, the interrupt source must disabled */
2020-01-15 18:02:31 +01:00
__HAL_RTC_ALARM_DISABLE_IT(hrtc, RTC_IT_ALRA);
2021-03-08 18:53:17 +01:00
2020-01-15 18:02:31 +01:00
/* Set Initialization mode */
2021-03-08 18:53:17 +01:00
if (RTC_EnterInitMode(hrtc) != HAL_OK)
2020-01-15 18:02:31 +01:00
{
/* Set RTC state */
hrtc->State = HAL_RTC_STATE_ERROR;
2021-03-08 18:53:17 +01:00
/* Process Unlocked */
2020-01-15 18:02:31 +01:00
__HAL_UNLOCK(hrtc);
2021-03-08 18:53:17 +01:00
2020-01-15 18:02:31 +01:00
return HAL_ERROR;
2021-03-08 18:53:17 +01:00
}
2020-01-15 18:02:31 +01:00
else
{
/* Clear flag alarm A */
__HAL_RTC_ALARM_CLEAR_FLAG(hrtc, RTC_FLAG_ALRAF);
2021-03-08 18:53:17 +01:00
2020-01-15 18:02:31 +01:00
/* Set to default values ALRH & ALRL registers */
WRITE_REG(hrtc->Instance->ALRH, RTC_ALARM_RESETVALUE_REGISTER);
WRITE_REG(hrtc->Instance->ALRL, RTC_ALARM_RESETVALUE_REGISTER);
/* RTC Alarm Interrupt Configuration: Disable EXTI configuration */
__HAL_RTC_ALARM_EXTI_DISABLE_IT();
2021-03-08 18:53:17 +01:00
2020-01-15 18:02:31 +01:00
/* Wait for synchro */
2021-03-08 18:53:17 +01:00
if (RTC_ExitInitMode(hrtc) != HAL_OK)
{
2020-01-15 18:02:31 +01:00
hrtc->State = HAL_RTC_STATE_ERROR;
2021-03-08 18:53:17 +01:00
/* Process Unlocked */
2020-01-15 18:02:31 +01:00
__HAL_UNLOCK(hrtc);
2021-03-08 18:53:17 +01:00
2020-01-15 18:02:31 +01:00
return HAL_ERROR;
}
}
2021-03-08 18:53:17 +01:00
hrtc->State = HAL_RTC_STATE_READY;
/* Process Unlocked */
__HAL_UNLOCK(hrtc);
return HAL_OK;
2020-01-15 18:02:31 +01:00
}
/**
* @brief This function handles Alarm interrupt request.
* @param hrtc pointer to a RTC_HandleTypeDef structure that contains
* the configuration information for RTC.
* @retval None
*/
2021-03-08 18:53:17 +01:00
void HAL_RTC_AlarmIRQHandler(RTC_HandleTypeDef *hrtc)
{
if (__HAL_RTC_ALARM_GET_IT_SOURCE(hrtc, RTC_IT_ALRA))
2020-01-15 18:02:31 +01:00
{
/* Get the status of the Interrupt */
2021-03-08 18:53:17 +01:00
if (__HAL_RTC_ALARM_GET_FLAG(hrtc, RTC_FLAG_ALRAF) != (uint32_t)RESET)
2020-01-15 18:02:31 +01:00
{
2021-03-08 18:53:17 +01:00
/* AlarmA callback */
#if (USE_HAL_RTC_REGISTER_CALLBACKS == 1)
hrtc->AlarmAEventCallback(hrtc);
#else
2020-01-15 18:02:31 +01:00
HAL_RTC_AlarmAEventCallback(hrtc);
2021-03-08 18:53:17 +01:00
#endif /* USE_HAL_RTC_REGISTER_CALLBACKS */
2020-01-15 18:02:31 +01:00
/* Clear the Alarm interrupt pending bit */
2021-03-08 18:53:17 +01:00
__HAL_RTC_ALARM_CLEAR_FLAG(hrtc, RTC_FLAG_ALRAF);
2020-01-15 18:02:31 +01:00
}
}
2021-03-08 18:53:17 +01:00
2020-01-15 18:02:31 +01:00
/* Clear the EXTI's line Flag for RTC Alarm */
__HAL_RTC_ALARM_EXTI_CLEAR_FLAG();
2021-03-08 18:53:17 +01:00
2020-01-15 18:02:31 +01:00
/* Change RTC state */
2021-03-08 18:53:17 +01:00
hrtc->State = HAL_RTC_STATE_READY;
2020-01-15 18:02:31 +01:00
}
/**
* @brief Alarm A callback.
* @param hrtc pointer to a RTC_HandleTypeDef structure that contains
* the configuration information for RTC.
* @retval None
*/
__weak void HAL_RTC_AlarmAEventCallback(RTC_HandleTypeDef *hrtc)
{
/* Prevent unused argument(s) compilation warning */
UNUSED(hrtc);
/* NOTE : This function Should not be modified, when the callback is needed,
the HAL_RTC_AlarmAEventCallback could be implemented in the user file
*/
}
/**
* @brief This function handles AlarmA Polling request.
* @param hrtc pointer to a RTC_HandleTypeDef structure that contains
* the configuration information for RTC.
* @param Timeout: Timeout duration
* @retval HAL status
*/
HAL_StatusTypeDef HAL_RTC_PollForAlarmAEvent(RTC_HandleTypeDef *hrtc, uint32_t Timeout)
2021-03-08 18:53:17 +01:00
{
uint32_t tickstart = HAL_GetTick();
2020-01-15 18:02:31 +01:00
/* Check input parameters */
2021-03-08 18:53:17 +01:00
if (hrtc == NULL)
2020-01-15 18:02:31 +01:00
{
2021-03-08 18:53:17 +01:00
return HAL_ERROR;
2020-01-15 18:02:31 +01:00
}
2021-03-08 18:53:17 +01:00
while (__HAL_RTC_ALARM_GET_FLAG(hrtc, RTC_FLAG_ALRAF) == RESET)
2020-01-15 18:02:31 +01:00
{
2021-03-08 18:53:17 +01:00
if (Timeout != HAL_MAX_DELAY)
2020-01-15 18:02:31 +01:00
{
2021-03-08 18:53:17 +01:00
if ((Timeout == 0) || ((HAL_GetTick() - tickstart) > Timeout))
2020-01-15 18:02:31 +01:00
{
hrtc->State = HAL_RTC_STATE_TIMEOUT;
return HAL_TIMEOUT;
}
}
}
2021-03-08 18:53:17 +01:00
2020-01-15 18:02:31 +01:00
/* Clear the Alarm interrupt pending bit */
__HAL_RTC_ALARM_CLEAR_FLAG(hrtc, RTC_FLAG_ALRAF);
2021-03-08 18:53:17 +01:00
2020-01-15 18:02:31 +01:00
/* Change RTC state */
2021-03-08 18:53:17 +01:00
hrtc->State = HAL_RTC_STATE_READY;
return HAL_OK;
2020-01-15 18:02:31 +01:00
}
/**
* @}
*/
2021-03-08 18:53:17 +01:00
/** @defgroup RTC_Exported_Functions_Group4 Peripheral State functions
* @brief Peripheral State functions
2020-01-15 18:02:31 +01:00
*
2021-03-08 18:53:17 +01:00
@verbatim
2020-01-15 18:02:31 +01:00
===============================================================================
##### Peripheral State functions #####
2021-03-08 18:53:17 +01:00
===============================================================================
2020-01-15 18:02:31 +01:00
[..]
This subsection provides functions allowing to
(+) Get RTC state
@endverbatim
* @{
*/
/**
* @brief Returns the RTC state.
* @param hrtc pointer to a RTC_HandleTypeDef structure that contains
* the configuration information for RTC.
* @retval HAL state
*/
2021-03-08 18:53:17 +01:00
HAL_RTCStateTypeDef HAL_RTC_GetState(RTC_HandleTypeDef *hrtc)
2020-01-15 18:02:31 +01:00
{
return hrtc->State;
}
/**
* @}
*/
2021-03-08 18:53:17 +01:00
/** @defgroup RTC_Exported_Functions_Group5 Peripheral Control functions
* @brief Peripheral Control functions
2020-01-15 18:02:31 +01:00
*
2021-03-08 18:53:17 +01:00
@verbatim
2020-01-15 18:02:31 +01:00
===============================================================================
##### Peripheral Control functions #####
2021-03-08 18:53:17 +01:00
===============================================================================
2020-01-15 18:02:31 +01:00
[..]
This subsection provides functions allowing to
(+) Wait for RTC Time and Date Synchronization
@endverbatim
* @{
*/
/**
* @brief Waits until the RTC registers (RTC_CNT, RTC_ALR and RTC_PRL)
* are synchronized with RTC APB clock.
* @note This function must be called before any read operation after an APB reset
* or an APB clock stop.
* @param hrtc pointer to a RTC_HandleTypeDef structure that contains
* the configuration information for RTC.
* @retval HAL status
*/
2021-03-08 18:53:17 +01:00
HAL_StatusTypeDef HAL_RTC_WaitForSynchro(RTC_HandleTypeDef *hrtc)
2020-01-15 18:02:31 +01:00
{
uint32_t tickstart = 0U;
2021-03-08 18:53:17 +01:00
2020-01-15 18:02:31 +01:00
/* Check input parameters */
2021-03-08 18:53:17 +01:00
if (hrtc == NULL)
2020-01-15 18:02:31 +01:00
{
2021-03-08 18:53:17 +01:00
return HAL_ERROR;
2020-01-15 18:02:31 +01:00
}
2021-03-08 18:53:17 +01:00
2020-01-15 18:02:31 +01:00
/* Clear RSF flag */
CLEAR_BIT(hrtc->Instance->CRL, RTC_FLAG_RSF);
2021-03-08 18:53:17 +01:00
2020-01-15 18:02:31 +01:00
tickstart = HAL_GetTick();
2021-03-08 18:53:17 +01:00
2020-01-15 18:02:31 +01:00
/* Wait the registers to be synchronised */
2021-03-08 18:53:17 +01:00
while ((hrtc->Instance->CRL & RTC_FLAG_RSF) == (uint32_t)RESET)
2020-01-15 18:02:31 +01:00
{
2021-03-08 18:53:17 +01:00
if ((HAL_GetTick() - tickstart) > RTC_TIMEOUT_VALUE)
{
2020-01-15 18:02:31 +01:00
return HAL_TIMEOUT;
2021-03-08 18:53:17 +01:00
}
2020-01-15 18:02:31 +01:00
}
2021-03-08 18:53:17 +01:00
2020-01-15 18:02:31 +01:00
return HAL_OK;
}
/**
* @}
*/
/**
* @}
*/
/** @addtogroup RTC_Private_Functions
* @{
*/
2021-03-08 18:53:17 +01:00
2020-01-15 18:02:31 +01:00
/**
* @brief Read the time counter available in RTC_CNT registers.
* @param hrtc pointer to a RTC_HandleTypeDef structure that contains
* the configuration information for RTC.
* @retval Time counter
*/
2021-03-08 18:53:17 +01:00
static uint32_t RTC_ReadTimeCounter(RTC_HandleTypeDef *hrtc)
2020-01-15 18:02:31 +01:00
{
uint16_t high1 = 0U, high2 = 0U, low = 0U;
uint32_t timecounter = 0U;
high1 = READ_REG(hrtc->Instance->CNTH & RTC_CNTH_RTC_CNT);
low = READ_REG(hrtc->Instance->CNTL & RTC_CNTL_RTC_CNT);
high2 = READ_REG(hrtc->Instance->CNTH & RTC_CNTH_RTC_CNT);
if (high1 != high2)
2021-03-08 18:53:17 +01:00
{
/* In this case the counter roll over during reading of CNTL and CNTH registers,
2020-01-15 18:02:31 +01:00
read again CNTL register then return the counter value */
timecounter = (((uint32_t) high2 << 16U) | READ_REG(hrtc->Instance->CNTL & RTC_CNTL_RTC_CNT));
}
else
2021-03-08 18:53:17 +01:00
{
/* No counter roll over during reading of CNTL and CNTH registers, counter
2020-01-15 18:02:31 +01:00
value is equal to first value of CNTL and CNTH */
timecounter = (((uint32_t) high1 << 16U) | low);
}
return timecounter;
}
/**
* @brief Write the time counter in RTC_CNT registers.
* @param hrtc pointer to a RTC_HandleTypeDef structure that contains
* the configuration information for RTC.
* @param TimeCounter: Counter to write in RTC_CNT registers
* @retval HAL status
*/
2021-03-08 18:53:17 +01:00
static HAL_StatusTypeDef RTC_WriteTimeCounter(RTC_HandleTypeDef *hrtc, uint32_t TimeCounter)
2020-01-15 18:02:31 +01:00
{
HAL_StatusTypeDef status = HAL_OK;
2021-03-08 18:53:17 +01:00
2020-01-15 18:02:31 +01:00
/* Set Initialization mode */
2021-03-08 18:53:17 +01:00
if (RTC_EnterInitMode(hrtc) != HAL_OK)
2020-01-15 18:02:31 +01:00
{
status = HAL_ERROR;
2021-03-08 18:53:17 +01:00
}
2020-01-15 18:02:31 +01:00
else
{
/* Set RTC COUNTER MSB word */
WRITE_REG(hrtc->Instance->CNTH, (TimeCounter >> 16U));
/* Set RTC COUNTER LSB word */
WRITE_REG(hrtc->Instance->CNTL, (TimeCounter & RTC_CNTL_RTC_CNT));
2021-03-08 18:53:17 +01:00
2020-01-15 18:02:31 +01:00
/* Wait for synchro */
2021-03-08 18:53:17 +01:00
if (RTC_ExitInitMode(hrtc) != HAL_OK)
{
2020-01-15 18:02:31 +01:00
status = HAL_ERROR;
}
}
return status;
}
/**
* @brief Read the time counter available in RTC_ALR registers.
* @param hrtc pointer to a RTC_HandleTypeDef structure that contains
* the configuration information for RTC.
* @retval Time counter
*/
2021-03-08 18:53:17 +01:00
static uint32_t RTC_ReadAlarmCounter(RTC_HandleTypeDef *hrtc)
2020-01-15 18:02:31 +01:00
{
uint16_t high1 = 0U, low = 0U;
high1 = READ_REG(hrtc->Instance->ALRH & RTC_CNTH_RTC_CNT);
low = READ_REG(hrtc->Instance->ALRL & RTC_CNTL_RTC_CNT);
return (((uint32_t) high1 << 16U) | low);
}
/**
* @brief Write the time counter in RTC_ALR registers.
* @param hrtc pointer to a RTC_HandleTypeDef structure that contains
* the configuration information for RTC.
* @param AlarmCounter: Counter to write in RTC_ALR registers
* @retval HAL status
*/
2021-03-08 18:53:17 +01:00
static HAL_StatusTypeDef RTC_WriteAlarmCounter(RTC_HandleTypeDef *hrtc, uint32_t AlarmCounter)
2020-01-15 18:02:31 +01:00
{
HAL_StatusTypeDef status = HAL_OK;
2021-03-08 18:53:17 +01:00
2020-01-15 18:02:31 +01:00
/* Set Initialization mode */
2021-03-08 18:53:17 +01:00
if (RTC_EnterInitMode(hrtc) != HAL_OK)
2020-01-15 18:02:31 +01:00
{
status = HAL_ERROR;
2021-03-08 18:53:17 +01:00
}
2020-01-15 18:02:31 +01:00
else
{
/* Set RTC COUNTER MSB word */
WRITE_REG(hrtc->Instance->ALRH, (AlarmCounter >> 16U));
/* Set RTC COUNTER LSB word */
WRITE_REG(hrtc->Instance->ALRL, (AlarmCounter & RTC_ALRL_RTC_ALR));
2021-03-08 18:53:17 +01:00
2020-01-15 18:02:31 +01:00
/* Wait for synchro */
2021-03-08 18:53:17 +01:00
if (RTC_ExitInitMode(hrtc) != HAL_OK)
{
2020-01-15 18:02:31 +01:00
status = HAL_ERROR;
}
}
return status;
}
/**
* @brief Enters the RTC Initialization mode.
* @param hrtc pointer to a RTC_HandleTypeDef structure that contains
* the configuration information for RTC.
* @retval HAL status
*/
2021-03-08 18:53:17 +01:00
static HAL_StatusTypeDef RTC_EnterInitMode(RTC_HandleTypeDef *hrtc)
2020-01-15 18:02:31 +01:00
{
uint32_t tickstart = 0U;
2021-03-08 18:53:17 +01:00
2020-01-15 18:02:31 +01:00
tickstart = HAL_GetTick();
/* Wait till RTC is in INIT state and if Time out is reached exit */
2021-03-08 18:53:17 +01:00
while ((hrtc->Instance->CRL & RTC_CRL_RTOFF) == (uint32_t)RESET)
2020-01-15 18:02:31 +01:00
{
2021-03-08 18:53:17 +01:00
if ((HAL_GetTick() - tickstart) > RTC_TIMEOUT_VALUE)
{
2020-01-15 18:02:31 +01:00
return HAL_TIMEOUT;
2021-03-08 18:53:17 +01:00
}
2020-01-15 18:02:31 +01:00
}
/* Disable the write protection for RTC registers */
__HAL_RTC_WRITEPROTECTION_DISABLE(hrtc);
2021-03-08 18:53:17 +01:00
return HAL_OK;
2020-01-15 18:02:31 +01:00
}
/**
* @brief Exit the RTC Initialization mode.
* @param hrtc pointer to a RTC_HandleTypeDef structure that contains
* the configuration information for RTC.
* @retval HAL status
*/
2021-03-08 18:53:17 +01:00
static HAL_StatusTypeDef RTC_ExitInitMode(RTC_HandleTypeDef *hrtc)
2020-01-15 18:02:31 +01:00
{
uint32_t tickstart = 0U;
2021-03-08 18:53:17 +01:00
2020-01-15 18:02:31 +01:00
/* Disable the write protection for RTC registers */
__HAL_RTC_WRITEPROTECTION_ENABLE(hrtc);
2021-03-08 18:53:17 +01:00
2020-01-15 18:02:31 +01:00
tickstart = HAL_GetTick();
/* Wait till RTC is in INIT state and if Time out is reached exit */
2021-03-08 18:53:17 +01:00
while ((hrtc->Instance->CRL & RTC_CRL_RTOFF) == (uint32_t)RESET)
2020-01-15 18:02:31 +01:00
{
2021-03-08 18:53:17 +01:00
if ((HAL_GetTick() - tickstart) > RTC_TIMEOUT_VALUE)
{
2020-01-15 18:02:31 +01:00
return HAL_TIMEOUT;
2021-03-08 18:53:17 +01:00
}
2020-01-15 18:02:31 +01:00
}
2021-03-08 18:53:17 +01:00
return HAL_OK;
2020-01-15 18:02:31 +01:00
}
/**
* @brief Converts a 2 digit decimal to BCD format.
* @param Value: Byte to be converted
* @retval Converted byte
*/
static uint8_t RTC_ByteToBcd2(uint8_t Value)
{
uint32_t bcdhigh = 0U;
2021-03-08 18:53:17 +01:00
while (Value >= 10U)
2020-01-15 18:02:31 +01:00
{
bcdhigh++;
Value -= 10U;
}
2021-03-08 18:53:17 +01:00
return ((uint8_t)(bcdhigh << 4U) | Value);
2020-01-15 18:02:31 +01:00
}
/**
* @brief Converts from 2 digit BCD to Binary.
* @param Value: BCD value to be converted
* @retval Converted word
*/
static uint8_t RTC_Bcd2ToByte(uint8_t Value)
{
uint32_t tmp = 0U;
tmp = ((uint8_t)(Value & (uint8_t)0xF0) >> (uint8_t)0x4) * 10U;
return (tmp + (Value & (uint8_t)0x0F));
}
/**
* @brief Updates date when time is 23:59:59.
* @param hrtc pointer to a RTC_HandleTypeDef structure that contains
* the configuration information for RTC.
* @param DayElapsed: Number of days elapsed from last date update
* @retval None
*/
2021-03-08 18:53:17 +01:00
static void RTC_DateUpdate(RTC_HandleTypeDef *hrtc, uint32_t DayElapsed)
2020-01-15 18:02:31 +01:00
{
uint32_t year = 0U, month = 0U, day = 0U;
uint32_t loop = 0U;
/* Get the current year*/
year = hrtc->DateToUpdate.Year;
/* Get the current month and day */
month = hrtc->DateToUpdate.Month;
day = hrtc->DateToUpdate.Date;
for (loop = 0U; loop < DayElapsed; loop++)
{
2021-03-08 18:53:17 +01:00
if ((month == 1U) || (month == 3U) || (month == 5U) || (month == 7U) || \
(month == 8U) || (month == 10U) || (month == 12U))
2020-01-15 18:02:31 +01:00
{
2021-03-08 18:53:17 +01:00
if (day < 31U)
2020-01-15 18:02:31 +01:00
{
day++;
}
/* Date structure member: day = 31 */
else
{
2021-03-08 18:53:17 +01:00
if (month != 12U)
2020-01-15 18:02:31 +01:00
{
month++;
day = 1U;
}
/* Date structure member: day = 31 & month =12 */
else
{
month = 1U;
day = 1U;
year++;
}
}
}
2021-03-08 18:53:17 +01:00
else if ((month == 4U) || (month == 6U) || (month == 9U) || (month == 11U))
2020-01-15 18:02:31 +01:00
{
2021-03-08 18:53:17 +01:00
if (day < 30U)
2020-01-15 18:02:31 +01:00
{
day++;
}
/* Date structure member: day = 30 */
else
{
month++;
day = 1U;
}
}
2021-03-08 18:53:17 +01:00
else if (month == 2U)
2020-01-15 18:02:31 +01:00
{
2021-03-08 18:53:17 +01:00
if (day < 28U)
2020-01-15 18:02:31 +01:00
{
day++;
}
2021-03-08 18:53:17 +01:00
else if (day == 28U)
2020-01-15 18:02:31 +01:00
{
/* Leap year */
2021-03-08 18:53:17 +01:00
if (RTC_IsLeapYear(year))
2020-01-15 18:02:31 +01:00
{
day++;
}
else
{
month++;
day = 1U;
}
}
2021-03-08 18:53:17 +01:00
else if (day == 29U)
2020-01-15 18:02:31 +01:00
{
month++;
day = 1U;
}
}
}
/* Update year */
hrtc->DateToUpdate.Year = year;
/* Update day and month */
hrtc->DateToUpdate.Month = month;
hrtc->DateToUpdate.Date = day;
/* Update day of the week */
hrtc->DateToUpdate.WeekDay = RTC_WeekDayNum(year, month, day);
}
/**
* @brief Check whether the passed year is Leap or not.
* @param nYear year to check
* @retval 1: leap year
* 0: not leap year
*/
static uint8_t RTC_IsLeapYear(uint16_t nYear)
{
2021-03-08 18:53:17 +01:00
if ((nYear % 4U) != 0U)
2020-01-15 18:02:31 +01:00
{
return 0U;
}
2021-03-08 18:53:17 +01:00
if ((nYear % 100U) != 0U)
2020-01-15 18:02:31 +01:00
{
return 1U;
}
2021-03-08 18:53:17 +01:00
if ((nYear % 400U) == 0U)
2020-01-15 18:02:31 +01:00
{
return 1U;
}
else
{
return 0U;
}
}
/**
* @brief Determines the week number, the day number and the week day number.
* @param nYear year to check
* @param nMonth Month to check
* @param nDay Day to check
* @note Day is calculated with hypothesis that year > 2000
* @retval Value which can take one of the following parameters:
* @arg RTC_WEEKDAY_MONDAY
* @arg RTC_WEEKDAY_TUESDAY
* @arg RTC_WEEKDAY_WEDNESDAY
* @arg RTC_WEEKDAY_THURSDAY
* @arg RTC_WEEKDAY_FRIDAY
* @arg RTC_WEEKDAY_SATURDAY
* @arg RTC_WEEKDAY_SUNDAY
*/
static uint8_t RTC_WeekDayNum(uint32_t nYear, uint8_t nMonth, uint8_t nDay)
{
uint32_t year = 0U, weekday = 0U;
year = 2000U + nYear;
2021-03-08 18:53:17 +01:00
if (nMonth < 3U)
2020-01-15 18:02:31 +01:00
{
/*D = { [(23 x month)/9] + day + 4 + year + [(year-1)/4] - [(year-1)/100] + [(year-1)/400] } mod 7*/
2021-03-08 18:53:17 +01:00
weekday = (((23U * nMonth) / 9U) + nDay + 4U + year + ((year - 1U) / 4U) - ((year - 1U) / 100U) + ((year - 1U) / 400U)) % 7U;
2020-01-15 18:02:31 +01:00
}
else
{
/*D = { [(23 x month)/9] + day + 4 + year + [year/4] - [year/100] + [year/400] - 2 } mod 7*/
2021-03-08 18:53:17 +01:00
weekday = (((23U * nMonth) / 9U) + nDay + 4U + year + (year / 4U) - (year / 100U) + (year / 400U) - 2U) % 7U;
2020-01-15 18:02:31 +01:00
}
return (uint8_t)weekday;
}
/**
* @}
*/
#endif /* HAL_RTC_MODULE_ENABLED */
/**
* @}
*/
/**
* @}
*/
/************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/