| /** |
| ****************************************************************************** |
| * @file stm32l4xx_hal_rtc_ex.c |
| * @author MCD Application Team |
| * @brief Extended RTC HAL module driver. |
| * This file provides firmware functions to manage the following |
| * functionalities of the Real Time Clock (RTC) Extended peripheral: |
| * + RTC Time Stamp functions |
| * + RTC Tamper functions |
| * + RTC Wake-up functions |
| * + Extended Control functions |
| * + Extended RTC features functions |
| * |
| @verbatim |
| ============================================================================== |
| ##### 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 Wakeup configuration *** |
| ================================ |
| [..] |
| (+) To configure the RTC Wakeup Clock source and Counter use the HAL_RTCEx_SetWakeUpTimer() |
| function. You can also configure the RTC Wakeup timer with interrupt mode |
| using the HAL_RTCEx_SetWakeUpTimer_IT() function. |
| (+) To read the RTC WakeUp Counter register, use the HAL_RTCEx_GetWakeUpTimer() |
| function. |
| |
| *** Outputs configuration *** |
| ============================= |
| [..] The RTC has 2 different outputs: |
| (+) RTC_ALARM: this output is used to manage the RTC Alarm A, Alarm B |
| and WaKeUp signals. |
| To output the selected RTC signal, use the HAL_RTC_Init() function. |
| (+) RTC_CALIB: this output is 512Hz signal or 1Hz. |
| To enable the RTC_CALIB, use the HAL_RTCEx_SetCalibrationOutPut() function. |
| (+) Two pins can be used as RTC_ALARM or RTC_CALIB (PC13, PB2) managed on |
| the RTC_OR register. |
| (+) When the RTC_CALIB or RTC_ALARM output is selected, the RTC_OUT pin is |
| automatically configured in output alternate function. |
| |
| *** Smooth digital Calibration configuration *** |
| ================================================ |
| [..] |
| (+) Configure the RTC Original Digital Calibration Value and the corresponding |
| calibration cycle period (32s,16s and 8s) using the HAL_RTCEx_SetSmoothCalib() |
| function. |
| |
| *** TimeStamp configuration *** |
| =============================== |
| [..] |
| (+) Enable the RTC TimeStamp using the HAL_RTCEx_SetTimeStamp() function. |
| You can also configure the RTC TimeStamp with interrupt mode using the |
| HAL_RTCEx_SetTimeStamp_IT() function. |
| (+) To read the RTC TimeStamp Time and Date register, use the HAL_RTCEx_GetTimeStamp() |
| function. |
| |
| *** Internal TimeStamp configuration *** |
| =============================== |
| [..] |
| (+) Enable the RTC internal TimeStamp using the HAL_RTCEx_SetInternalTimeStamp() function. |
| User has to check internal timestamp occurrence using __HAL_RTC_INTERNAL_TIMESTAMP_GET_FLAG. |
| (+) To read the RTC TimeStamp Time and Date register, use the HAL_RTCEx_GetTimeStamp() |
| 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, NoErase, MaskFlag, precharge or discharge and |
| Pull-UP using the HAL_RTCEx_SetTamper() function. You can configure RTC Tamper |
| with interrupt mode using HAL_RTCEx_SetTamper_IT() function. |
| (+) The default configuration of the Tamper erases the backup registers. To avoid |
| erase, enable the NoErase field on the RTC_TAMPCR register. |
| |
| *** 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. |
| |
| @endverbatim |
| ****************************************************************************** |
| * @attention |
| * |
| * <h2><center>© COPYRIGHT(c) 2017 STMicroelectronics</center></h2> |
| * |
| * 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. |
| * |
| ****************************************************************************** |
| */ |
| |
| /* Includes ------------------------------------------------------------------*/ |
| #include "stm32l4xx_hal.h" |
| |
| /** @addtogroup STM32L4xx_HAL_Driver |
| * @{ |
| */ |
| |
| /** @defgroup RTCEx RTCEx |
| * @brief RTC Extended HAL module driver |
| * @{ |
| */ |
| |
| #ifdef HAL_RTC_MODULE_ENABLED |
| |
| /* Private typedef -----------------------------------------------------------*/ |
| /* Private define ------------------------------------------------------------*/ |
| #if defined(RTC_TAMPER1_SUPPORT) && defined(RTC_TAMPER3_SUPPORT) |
| #define RTC_TAMPCR_MASK ((uint32_t)RTC_TAMPCR_TAMPTS |\ |
| (uint32_t)RTC_TAMPCR_TAMPFREQ | (uint32_t)RTC_TAMPCR_TAMPFLT | (uint32_t)RTC_TAMPCR_TAMPPRCH |\ |
| (uint32_t)RTC_TAMPCR_TAMPPUDIS | (uint32_t)RTC_TAMPCR_TAMPIE |\ |
| (uint32_t)RTC_TAMPCR_TAMP1IE | (uint32_t)RTC_TAMPCR_TAMP1NOERASE | (uint32_t)RTC_TAMPCR_TAMP1MF |\ |
| (uint32_t)RTC_TAMPCR_TAMP2IE | (uint32_t)RTC_TAMPCR_TAMP2NOERASE | (uint32_t)RTC_TAMPCR_TAMP2MF |\ |
| (uint32_t)RTC_TAMPCR_TAMP3IE | (uint32_t)RTC_TAMPCR_TAMP3NOERASE | (uint32_t)RTC_TAMPCR_TAMP3MF) |
| #elif defined(RTC_TAMPER1_SUPPORT) |
| #define RTC_TAMPCR_MASK ((uint32_t)RTC_TAMPCR_TAMPTS |\ |
| (uint32_t)RTC_TAMPCR_TAMPFREQ | (uint32_t)RTC_TAMPCR_TAMPFLT | (uint32_t)RTC_TAMPCR_TAMPPRCH |\ |
| (uint32_t)RTC_TAMPCR_TAMPPUDIS | (uint32_t)RTC_TAMPCR_TAMPIE |\ |
| (uint32_t)RTC_TAMPCR_TAMP1IE | (uint32_t)RTC_TAMPCR_TAMP1NOERASE | (uint32_t)RTC_TAMPCR_TAMP1MF |\ |
| (uint32_t)RTC_TAMPCR_TAMP2IE | (uint32_t)RTC_TAMPCR_TAMP2NOERASE | (uint32_t)RTC_TAMPCR_TAMP2MF) |
| #elif defined(RTC_TAMPER3_SUPPORT) |
| #define RTC_TAMPCR_MASK ((uint32_t)RTC_TAMPCR_TAMPTS |\ |
| (uint32_t)RTC_TAMPCR_TAMPFREQ | (uint32_t)RTC_TAMPCR_TAMPFLT | (uint32_t)RTC_TAMPCR_TAMPPRCH |\ |
| (uint32_t)RTC_TAMPCR_TAMPPUDIS | (uint32_t)RTC_TAMPCR_TAMPIE |\ |
| (uint32_t)RTC_TAMPCR_TAMP2IE | (uint32_t)RTC_TAMPCR_TAMP2NOERASE | (uint32_t)RTC_TAMPCR_TAMP2MF |\ |
| (uint32_t)RTC_TAMPCR_TAMP3IE | (uint32_t)RTC_TAMPCR_TAMP3NOERASE | (uint32_t)RTC_TAMPCR_TAMP3MF) |
| #else |
| #define RTC_TAMPCR_MASK ((uint32_t)RTC_TAMPCR_TAMPTS |\ |
| (uint32_t)RTC_TAMPCR_TAMPFREQ | (uint32_t)RTC_TAMPCR_TAMPFLT | (uint32_t)RTC_TAMPCR_TAMPPRCH |\ |
| (uint32_t)RTC_TAMPCR_TAMPPUDIS | (uint32_t)RTC_TAMPCR_TAMPIE |\ |
| (uint32_t)RTC_TAMPCR_TAMP2IE | (uint32_t)RTC_TAMPCR_TAMP2NOERASE | (uint32_t)RTC_TAMPCR_TAMP2MF) |
| #endif /* RTC_TAMPER1_SUPPORT && RTC_TAMPER3_SUPPORT */ |
| |
| /* Private macro -------------------------------------------------------------*/ |
| /* Private variables ---------------------------------------------------------*/ |
| /* Private function prototypes -----------------------------------------------*/ |
| /* Exported functions --------------------------------------------------------*/ |
| |
| /** @defgroup RTCEx_Exported_Functions RTCEx Exported Functions |
| * @{ |
| */ |
| |
| |
| /** @defgroup RTCEx_Exported_Functions_Group1 RTC TimeStamp and Tamper functions |
| * @brief RTC TimeStamp and Tamper functions |
| * |
| @verbatim |
| =============================================================================== |
| ##### RTC TimeStamp and Tamper functions ##### |
| =============================================================================== |
| |
| [..] This section provide functions allowing to configure TimeStamp feature |
| |
| @endverbatim |
| * @{ |
| */ |
| |
| /** |
| * @brief Set TimeStamp. |
| * @note This API must be called before enabling the TimeStamp feature. |
| * @param hrtc: RTC handle |
| * @param TimeStampEdge: Specifies the pin edge on which the TimeStamp is |
| * activated. |
| * This parameter can be one of the following values: |
| * @arg RTC_TIMESTAMPEDGE_RISING: the Time stamp event occurs on the |
| * rising edge of the related pin. |
| * @arg RTC_TIMESTAMPEDGE_FALLING: the Time stamp event occurs on the |
| * falling edge of the related pin. |
| * @param RTC_TimeStampPin: specifies the RTC TimeStamp Pin. |
| * This parameter can be one of the following values: |
| * @arg RTC_TIMESTAMPPIN_DEFAULT: PC13 is selected as RTC TimeStamp Pin. |
| * The RTC TimeStamp Pin is per default PC13, but for reasons of |
| * compatibility, this parameter is required. |
| * @retval HAL status |
| */ |
| HAL_StatusTypeDef HAL_RTCEx_SetTimeStamp(RTC_HandleTypeDef *hrtc, uint32_t TimeStampEdge, uint32_t RTC_TimeStampPin) |
| { |
| uint32_t tmpreg = 0; |
| |
| /* Check the parameters */ |
| assert_param(IS_TIMESTAMP_EDGE(TimeStampEdge)); |
| assert_param(IS_RTC_TIMESTAMP_PIN(RTC_TimeStampPin)); |
| |
| /* Process Locked */ |
| __HAL_LOCK(hrtc); |
| |
| hrtc->State = HAL_RTC_STATE_BUSY; |
| |
| /* Get the RTC_CR register and clear the bits to be configured */ |
| tmpreg = (uint32_t)(hrtc->Instance->CR & (uint32_t)~(RTC_CR_TSEDGE | RTC_CR_TSE)); |
| |
| tmpreg|= TimeStampEdge; |
| |
| /* Disable the write protection for RTC registers */ |
| __HAL_RTC_WRITEPROTECTION_DISABLE(hrtc); |
| |
| /* Configure the Time Stamp TSEDGE and Enable bits */ |
| hrtc->Instance->CR = (uint32_t)tmpreg; |
| |
| __HAL_RTC_TIMESTAMP_ENABLE(hrtc); |
| |
| /* Enable the write protection for RTC registers */ |
| __HAL_RTC_WRITEPROTECTION_ENABLE(hrtc); |
| |
| /* Change RTC state */ |
| hrtc->State = HAL_RTC_STATE_READY; |
| |
| /* Process Unlocked */ |
| __HAL_UNLOCK(hrtc); |
| |
| return HAL_OK; |
| } |
| |
| /** |
| * @brief Set TimeStamp with Interrupt. |
| * @param hrtc: RTC handle |
| * @note This API must be called before enabling the TimeStamp feature. |
| * @param TimeStampEdge: Specifies the pin edge on which the TimeStamp is |
| * activated. |
| * This parameter can be one of the following values: |
| * @arg RTC_TIMESTAMPEDGE_RISING: the Time stamp event occurs on the |
| * rising edge of the related pin. |
| * @arg RTC_TIMESTAMPEDGE_FALLING: the Time stamp event occurs on the |
| * falling edge of the related pin. |
| * @param RTC_TimeStampPin: Specifies the RTC TimeStamp Pin. |
| * This parameter can be one of the following values: |
| * @arg RTC_TIMESTAMPPIN_DEFAULT: PC13 is selected as RTC TimeStamp Pin. |
| * The RTC TimeStamp Pin is per default PC13, but for reasons of |
| * compatibility, this parameter is required. |
| * @retval HAL status |
| */ |
| HAL_StatusTypeDef HAL_RTCEx_SetTimeStamp_IT(RTC_HandleTypeDef *hrtc, uint32_t TimeStampEdge, uint32_t RTC_TimeStampPin) |
| { |
| uint32_t tmpreg = 0; |
| |
| /* Check the parameters */ |
| assert_param(IS_TIMESTAMP_EDGE(TimeStampEdge)); |
| assert_param(IS_RTC_TIMESTAMP_PIN(RTC_TimeStampPin)); |
| |
| /* Process Locked */ |
| __HAL_LOCK(hrtc); |
| |
| hrtc->State = HAL_RTC_STATE_BUSY; |
| |
| /* Get the RTC_CR register and clear the bits to be configured */ |
| tmpreg = (uint32_t)(hrtc->Instance->CR & (uint32_t)~(RTC_CR_TSEDGE | RTC_CR_TSE)); |
| |
| tmpreg |= TimeStampEdge; |
| |
| /* Disable the write protection for RTC registers */ |
| __HAL_RTC_WRITEPROTECTION_DISABLE(hrtc); |
| |
| /* Configure the Time Stamp TSEDGE and Enable bits */ |
| hrtc->Instance->CR = (uint32_t)tmpreg; |
| |
| __HAL_RTC_TIMESTAMP_ENABLE(hrtc); |
| |
| /* Enable IT timestamp */ |
| __HAL_RTC_TIMESTAMP_ENABLE_IT(hrtc,RTC_IT_TS); |
| |
| /* RTC timestamp Interrupt Configuration: EXTI configuration */ |
| __HAL_RTC_TAMPER_TIMESTAMP_EXTI_ENABLE_IT(); |
| |
| __HAL_RTC_TAMPER_TIMESTAMP_EXTI_ENABLE_RISING_EDGE(); |
| |
| /* Enable the write protection for RTC registers */ |
| __HAL_RTC_WRITEPROTECTION_ENABLE(hrtc); |
| |
| hrtc->State = HAL_RTC_STATE_READY; |
| |
| /* Process Unlocked */ |
| __HAL_UNLOCK(hrtc); |
| |
| return HAL_OK; |
| } |
| |
| /** |
| * @brief Deactivate TimeStamp. |
| * @param hrtc: RTC handle |
| * @retval HAL status |
| */ |
| HAL_StatusTypeDef HAL_RTCEx_DeactivateTimeStamp(RTC_HandleTypeDef *hrtc) |
| { |
| uint32_t tmpreg = 0; |
| |
| /* Process Locked */ |
| __HAL_LOCK(hrtc); |
| |
| hrtc->State = HAL_RTC_STATE_BUSY; |
| |
| /* Disable the write protection for RTC registers */ |
| __HAL_RTC_WRITEPROTECTION_DISABLE(hrtc); |
| |
| /* In case of interrupt mode is used, the interrupt source must disabled */ |
| __HAL_RTC_TIMESTAMP_DISABLE_IT(hrtc, RTC_IT_TS); |
| |
| /* Get the RTC_CR register and clear the bits to be configured */ |
| tmpreg = (uint32_t)(hrtc->Instance->CR & (uint32_t)~(RTC_CR_TSEDGE | RTC_CR_TSE)); |
| |
| /* Configure the Time Stamp TSEDGE and Enable bits */ |
| hrtc->Instance->CR = (uint32_t)tmpreg; |
| |
| /* Enable the write protection for RTC registers */ |
| __HAL_RTC_WRITEPROTECTION_ENABLE(hrtc); |
| |
| hrtc->State = HAL_RTC_STATE_READY; |
| |
| /* Process Unlocked */ |
| __HAL_UNLOCK(hrtc); |
| |
| return HAL_OK; |
| } |
| |
| /** |
| * @brief Set Internal TimeStamp. |
| * @note This API must be called before enabling the internal TimeStamp feature. |
| * @param hrtc: pointer to a RTC_HandleTypeDef structure that contains |
| * the configuration information for RTC. |
| * @retval HAL status |
| */ |
| HAL_StatusTypeDef HAL_RTCEx_SetInternalTimeStamp(RTC_HandleTypeDef *hrtc) |
| { |
| /* Process Locked */ |
| __HAL_LOCK(hrtc); |
| |
| hrtc->State = HAL_RTC_STATE_BUSY; |
| |
| /* Disable the write protection for RTC registers */ |
| __HAL_RTC_WRITEPROTECTION_DISABLE(hrtc); |
| |
| /* Configure the internal Time Stamp Enable bits */ |
| __HAL_RTC_INTERNAL_TIMESTAMP_ENABLE(hrtc); |
| |
| /* Enable the write protection for RTC registers */ |
| __HAL_RTC_WRITEPROTECTION_ENABLE(hrtc); |
| |
| /* Change RTC state */ |
| hrtc->State = HAL_RTC_STATE_READY; |
| |
| /* Process Unlocked */ |
| __HAL_UNLOCK(hrtc); |
| |
| return HAL_OK; |
| } |
| |
| /** |
| * @brief Deactivate Internal TimeStamp. |
| * @param hrtc: pointer to a RTC_HandleTypeDef structure that contains |
| * the configuration information for RTC. |
| * @retval HAL status |
| */ |
| HAL_StatusTypeDef HAL_RTCEx_DeactivateInternalTimeStamp(RTC_HandleTypeDef *hrtc) |
| { |
| /* Process Locked */ |
| __HAL_LOCK(hrtc); |
| |
| hrtc->State = HAL_RTC_STATE_BUSY; |
| |
| /* Disable the write protection for RTC registers */ |
| __HAL_RTC_WRITEPROTECTION_DISABLE(hrtc); |
| |
| /* Configure the internal Time Stamp Enable bits */ |
| __HAL_RTC_INTERNAL_TIMESTAMP_DISABLE(hrtc); |
| |
| /* Enable the write protection for RTC registers */ |
| __HAL_RTC_WRITEPROTECTION_ENABLE(hrtc); |
| |
| hrtc->State = HAL_RTC_STATE_READY; |
| |
| /* Process Unlocked */ |
| __HAL_UNLOCK(hrtc); |
| |
| return HAL_OK; |
| } |
| |
| /** |
| * @brief Get the RTC TimeStamp value. |
| * @param hrtc: RTC handle |
| * @param sTimeStamp: Pointer to Time structure |
| * @param sTimeStampDate: Pointer to Date structure |
| * @param Format: specifies the format of the entered parameters. |
| * This parameter can be one of the following values: |
| * @arg RTC_FORMAT_BIN: Binary data format |
| * @arg RTC_FORMAT_BCD: BCD data format |
| * @retval HAL status |
| */ |
| HAL_StatusTypeDef HAL_RTCEx_GetTimeStamp(RTC_HandleTypeDef *hrtc, RTC_TimeTypeDef* sTimeStamp, RTC_DateTypeDef* sTimeStampDate, uint32_t Format) |
| { |
| uint32_t tmptime = 0, tmpdate = 0; |
| |
| /* Check the parameters */ |
| assert_param(IS_RTC_FORMAT(Format)); |
| |
| /* Get the TimeStamp time and date registers values */ |
| tmptime = (uint32_t)(hrtc->Instance->TSTR & RTC_TR_RESERVED_MASK); |
| tmpdate = (uint32_t)(hrtc->Instance->TSDR & RTC_DR_RESERVED_MASK); |
| |
| /* Fill the Time structure fields with the read parameters */ |
| sTimeStamp->Hours = (uint8_t)((tmptime & (RTC_TR_HT | RTC_TR_HU)) >> 16); |
| sTimeStamp->Minutes = (uint8_t)((tmptime & (RTC_TR_MNT | RTC_TR_MNU)) >> 8); |
| sTimeStamp->Seconds = (uint8_t)(tmptime & (RTC_TR_ST | RTC_TR_SU)); |
| sTimeStamp->TimeFormat = (uint8_t)((tmptime & (RTC_TR_PM)) >> 16); |
| sTimeStamp->SubSeconds = (uint32_t) hrtc->Instance->TSSSR; |
| |
| /* Fill the Date structure fields with the read parameters */ |
| sTimeStampDate->Year = 0; |
| sTimeStampDate->Month = (uint8_t)((tmpdate & (RTC_DR_MT | RTC_DR_MU)) >> 8); |
| sTimeStampDate->Date = (uint8_t)(tmpdate & (RTC_DR_DT | RTC_DR_DU)); |
| sTimeStampDate->WeekDay = (uint8_t)((tmpdate & (RTC_DR_WDU)) >> 13); |
| |
| /* Check the input parameters format */ |
| if(Format == RTC_FORMAT_BIN) |
| { |
| /* Convert the TimeStamp structure parameters to Binary format */ |
| sTimeStamp->Hours = (uint8_t)RTC_Bcd2ToByte(sTimeStamp->Hours); |
| sTimeStamp->Minutes = (uint8_t)RTC_Bcd2ToByte(sTimeStamp->Minutes); |
| sTimeStamp->Seconds = (uint8_t)RTC_Bcd2ToByte(sTimeStamp->Seconds); |
| |
| /* Convert the DateTimeStamp structure parameters to Binary format */ |
| sTimeStampDate->Month = (uint8_t)RTC_Bcd2ToByte(sTimeStampDate->Month); |
| sTimeStampDate->Date = (uint8_t)RTC_Bcd2ToByte(sTimeStampDate->Date); |
| sTimeStampDate->WeekDay = (uint8_t)RTC_Bcd2ToByte(sTimeStampDate->WeekDay); |
| } |
| |
| /* Clear the TIMESTAMP Flags */ |
| __HAL_RTC_INTERNAL_TIMESTAMP_CLEAR_FLAG(hrtc, RTC_FLAG_ITSF); |
| __HAL_RTC_TIMESTAMP_CLEAR_FLAG(hrtc, RTC_FLAG_TSF); |
| |
| return HAL_OK; |
| } |
| |
| /** |
| * @brief Set Tamper. |
| * @note By calling this API we disable the tamper interrupt for all tampers. |
| * @param hrtc: RTC handle |
| * @param sTamper: Pointer to Tamper Structure. |
| * @retval HAL status |
| */ |
| HAL_StatusTypeDef HAL_RTCEx_SetTamper(RTC_HandleTypeDef *hrtc, RTC_TamperTypeDef* sTamper) |
| { |
| uint32_t tmpreg = 0; |
| |
| /* Check the parameters */ |
| assert_param(IS_RTC_TAMPER(sTamper->Tamper)); |
| assert_param(IS_RTC_TAMPER_TRIGGER(sTamper->Trigger)); |
| assert_param(IS_RTC_TAMPER_ERASE_MODE(sTamper->NoErase)); |
| assert_param(IS_RTC_TAMPER_MASKFLAG_STATE(sTamper->MaskFlag)); |
| assert_param(IS_RTC_TAMPER_FILTER(sTamper->Filter)); |
| assert_param(IS_RTC_TAMPER_SAMPLING_FREQ(sTamper->SamplingFrequency)); |
| assert_param(IS_RTC_TAMPER_PRECHARGE_DURATION(sTamper->PrechargeDuration)); |
| assert_param(IS_RTC_TAMPER_PULLUP_STATE(sTamper->TamperPullUp)); |
| assert_param(IS_RTC_TAMPER_TIMESTAMPONTAMPER_DETECTION(sTamper->TimeStampOnTamperDetection)); |
| |
| /* Process Locked */ |
| __HAL_LOCK(hrtc); |
| |
| hrtc->State = HAL_RTC_STATE_BUSY; |
| |
| /* Configure the tamper trigger */ |
| if(sTamper->Trigger != RTC_TAMPERTRIGGER_RISINGEDGE) |
| { |
| sTamper->Trigger = (uint32_t)(sTamper->Tamper << 1); |
| } |
| |
| if(sTamper->NoErase != RTC_TAMPER_ERASE_BACKUP_ENABLE) |
| { |
| sTamper->NoErase = 0; |
| #if defined(RTC_TAMPER1_SUPPORT) |
| if((sTamper->Tamper & RTC_TAMPER_1) != 0) |
| { |
| sTamper->NoErase |= RTC_TAMPCR_TAMP1NOERASE; |
| } |
| #endif /* RTC_TAMPER1_SUPPORT */ |
| if((sTamper->Tamper & RTC_TAMPER_2) != 0) |
| { |
| sTamper->NoErase |= RTC_TAMPCR_TAMP2NOERASE; |
| } |
| #if defined(RTC_TAMPER3_SUPPORT) |
| if((sTamper->Tamper & RTC_TAMPER_3) != 0) |
| { |
| sTamper->NoErase |= RTC_TAMPCR_TAMP3NOERASE; |
| } |
| #endif /* RTC_TAMPER3_SUPPORT */ |
| } |
| |
| if(sTamper->MaskFlag != RTC_TAMPERMASK_FLAG_DISABLE) |
| { |
| sTamper->MaskFlag = 0; |
| #if defined(RTC_TAMPER1_SUPPORT) |
| if((sTamper->Tamper & RTC_TAMPER_1) != 0) |
| { |
| sTamper->MaskFlag |= RTC_TAMPCR_TAMP1MF; |
| } |
| #endif /* RTC_TAMPER1_SUPPORT */ |
| if((sTamper->Tamper & RTC_TAMPER_2) != 0) |
| { |
| sTamper->MaskFlag |= RTC_TAMPCR_TAMP2MF; |
| } |
| #if defined(RTC_TAMPER3_SUPPORT) |
| if((sTamper->Tamper & RTC_TAMPER_3) != 0) |
| { |
| sTamper->MaskFlag |= RTC_TAMPCR_TAMP3MF; |
| } |
| #endif /* RTC_TAMPER3_SUPPORT */ |
| } |
| |
| tmpreg = ((uint32_t)sTamper->Tamper | (uint32_t)sTamper->Trigger | (uint32_t)sTamper->NoErase |\ |
| (uint32_t)sTamper->MaskFlag | (uint32_t)sTamper->Filter | (uint32_t)sTamper->SamplingFrequency |\ |
| (uint32_t)sTamper->PrechargeDuration | (uint32_t)sTamper->TamperPullUp | sTamper->TimeStampOnTamperDetection); |
| |
| hrtc->Instance->TAMPCR &= (uint32_t)~((uint32_t)sTamper->Tamper | (uint32_t)(sTamper->Tamper << 1) | RTC_TAMPCR_MASK); |
| |
| hrtc->Instance->TAMPCR |= tmpreg; |
| |
| hrtc->State = HAL_RTC_STATE_READY; |
| |
| /* Process Unlocked */ |
| __HAL_UNLOCK(hrtc); |
| |
| return HAL_OK; |
| } |
| |
| /** |
| * @brief Set Tamper with interrupt. |
| * @note By calling this API we force the tamper interrupt for all tampers. |
| * @param hrtc: RTC handle |
| * @param sTamper: Pointer to RTC Tamper. |
| * @retval HAL status |
| */ |
| HAL_StatusTypeDef HAL_RTCEx_SetTamper_IT(RTC_HandleTypeDef *hrtc, RTC_TamperTypeDef* sTamper) |
| { |
| uint32_t tmpreg = 0; |
| |
| /* Check the parameters */ |
| assert_param(IS_RTC_TAMPER(sTamper->Tamper)); |
| assert_param(IS_RTC_TAMPER_INTERRUPT(sTamper->Interrupt)); |
| assert_param(IS_RTC_TAMPER_TRIGGER(sTamper->Trigger)); |
| assert_param(IS_RTC_TAMPER_ERASE_MODE(sTamper->NoErase)); |
| assert_param(IS_RTC_TAMPER_MASKFLAG_STATE(sTamper->MaskFlag)); |
| assert_param(IS_RTC_TAMPER_FILTER(sTamper->Filter)); |
| assert_param(IS_RTC_TAMPER_SAMPLING_FREQ(sTamper->SamplingFrequency)); |
| assert_param(IS_RTC_TAMPER_PRECHARGE_DURATION(sTamper->PrechargeDuration)); |
| assert_param(IS_RTC_TAMPER_PULLUP_STATE(sTamper->TamperPullUp)); |
| assert_param(IS_RTC_TAMPER_TIMESTAMPONTAMPER_DETECTION(sTamper->TimeStampOnTamperDetection)); |
| |
| /* Process Locked */ |
| __HAL_LOCK(hrtc); |
| |
| hrtc->State = HAL_RTC_STATE_BUSY; |
| |
| /* Configure the tamper trigger */ |
| if(sTamper->Trigger != RTC_TAMPERTRIGGER_RISINGEDGE) |
| { |
| sTamper->Trigger = (uint32_t)(sTamper->Tamper << 1); |
| } |
| |
| if(sTamper->NoErase != RTC_TAMPER_ERASE_BACKUP_ENABLE) |
| { |
| sTamper->NoErase = 0; |
| #if defined(RTC_TAMPER1_SUPPORT) |
| if((sTamper->Tamper & RTC_TAMPER_1) != 0) |
| { |
| sTamper->NoErase |= RTC_TAMPCR_TAMP1NOERASE; |
| } |
| #endif /* RTC_TAMPER1_SUPPORT */ |
| if((sTamper->Tamper & RTC_TAMPER_2) != 0) |
| { |
| sTamper->NoErase |= RTC_TAMPCR_TAMP2NOERASE; |
| } |
| #if defined(RTC_TAMPER3_SUPPORT) |
| if((sTamper->Tamper & RTC_TAMPER_3) != 0) |
| { |
| sTamper->NoErase |= RTC_TAMPCR_TAMP3NOERASE; |
| } |
| #endif /* RTC_TAMPER3_SUPPORT */ |
| } |
| |
| if(sTamper->MaskFlag != RTC_TAMPERMASK_FLAG_DISABLE) |
| { |
| sTamper->MaskFlag = 0; |
| #if defined(RTC_TAMPER1_SUPPORT) |
| if((sTamper->Tamper & RTC_TAMPER_1) != 0) |
| { |
| sTamper->MaskFlag |= RTC_TAMPCR_TAMP1MF; |
| } |
| #endif /* RTC_TAMPER1_SUPPORT */ |
| if((sTamper->Tamper & RTC_TAMPER_2) != 0) |
| { |
| sTamper->MaskFlag |= RTC_TAMPCR_TAMP2MF; |
| } |
| #if defined(RTC_TAMPER3_SUPPORT) |
| if((sTamper->Tamper & RTC_TAMPER_3) != 0) |
| { |
| sTamper->MaskFlag |= RTC_TAMPCR_TAMP3MF; |
| } |
| #endif /* RTC_TAMPER3_SUPPORT */ |
| } |
| |
| tmpreg = ((uint32_t)sTamper->Tamper | (uint32_t)sTamper->Interrupt | (uint32_t)sTamper->Trigger | (uint32_t)sTamper->NoErase |\ |
| (uint32_t)sTamper->MaskFlag | (uint32_t)sTamper->Filter | (uint32_t)sTamper->SamplingFrequency |\ |
| (uint32_t)sTamper->PrechargeDuration | (uint32_t)sTamper->TamperPullUp | sTamper->TimeStampOnTamperDetection); |
| |
| hrtc->Instance->TAMPCR &= (uint32_t)~((uint32_t)sTamper->Tamper | (uint32_t)(sTamper->Tamper << 1) | RTC_TAMPCR_MASK); |
| |
| hrtc->Instance->TAMPCR |= tmpreg; |
| |
| /* RTC Tamper Interrupt Configuration: EXTI configuration */ |
| __HAL_RTC_TAMPER_TIMESTAMP_EXTI_ENABLE_IT(); |
| |
| __HAL_RTC_TAMPER_TIMESTAMP_EXTI_ENABLE_RISING_EDGE(); |
| |
| hrtc->State = HAL_RTC_STATE_READY; |
| |
| /* Process Unlocked */ |
| __HAL_UNLOCK(hrtc); |
| |
| return HAL_OK; |
| } |
| |
| /** |
| * @brief Deactivate Tamper. |
| * @param hrtc: RTC handle |
| * @param Tamper: Selected tamper pin. |
| * This parameter can be any combination of RTC_TAMPER_1, RTC_TAMPER_2 and RTC_TAMPER_3. |
| * @retval HAL status |
| */ |
| HAL_StatusTypeDef HAL_RTCEx_DeactivateTamper(RTC_HandleTypeDef *hrtc, uint32_t Tamper) |
| { |
| assert_param(IS_RTC_TAMPER(Tamper)); |
| |
| /* Process Locked */ |
| __HAL_LOCK(hrtc); |
| |
| hrtc->State = HAL_RTC_STATE_BUSY; |
| |
| /* Disable the selected Tamper pin */ |
| hrtc->Instance->TAMPCR &= ((uint32_t)~Tamper); |
| |
| #if defined(RTC_TAMPER1_SUPPORT) |
| if ((Tamper & RTC_TAMPER_1) != 0) |
| { |
| /* Disable the Tamper1 interrupt */ |
| hrtc->Instance->TAMPCR &= ((uint32_t)~(RTC_IT_TAMP | RTC_IT_TAMP1)); |
| } |
| #endif /* RTC_TAMPER1_SUPPORT */ |
| if ((Tamper & RTC_TAMPER_2) != 0) |
| { |
| /* Disable the Tamper2 interrupt */ |
| hrtc->Instance->TAMPCR &= ((uint32_t)~(RTC_IT_TAMP | RTC_IT_TAMP2)); |
| } |
| #if defined(RTC_TAMPER3_SUPPORT) |
| if ((Tamper & RTC_TAMPER_3) != 0) |
| { |
| /* Disable the Tamper3 interrupt */ |
| hrtc->Instance->TAMPCR &= ((uint32_t)~(RTC_IT_TAMP | RTC_IT_TAMP3)); |
| } |
| #endif /* RTC_TAMPER3_SUPPORT */ |
| |
| hrtc->State = HAL_RTC_STATE_READY; |
| |
| /* Process Unlocked */ |
| __HAL_UNLOCK(hrtc); |
| |
| return HAL_OK; |
| } |
| |
| /** |
| * @brief Handle TimeStamp interrupt request. |
| * @param hrtc: RTC handle |
| * @retval None |
| */ |
| void HAL_RTCEx_TamperTimeStampIRQHandler(RTC_HandleTypeDef *hrtc) |
| { |
| /* Clear the EXTI's Flag for RTC TimeStamp and Tamper */ |
| __HAL_RTC_TAMPER_TIMESTAMP_EXTI_CLEAR_FLAG(); |
| |
| /* As Tampers and TimeStamp are sharing the same EXTI line, exit when no more pending event */ |
| while( |
| ((__HAL_RTC_TIMESTAMP_GET_IT_SOURCE(hrtc, RTC_IT_TS) != RESET) && (__HAL_RTC_TIMESTAMP_GET_FLAG(hrtc, RTC_FLAG_TSF) != RESET)) |
| #if defined(RTC_TAMPER1_SUPPORT) |
| || ((__HAL_RTC_TAMPER_GET_IT_SOURCE(hrtc, RTC_IT_TAMP | RTC_IT_TAMP1) != RESET) && (__HAL_RTC_TAMPER_GET_FLAG(hrtc, RTC_FLAG_TAMP1F) != RESET)) |
| #endif /* RTC_TAMPER1_SUPPORT */ |
| || ((__HAL_RTC_TAMPER_GET_IT_SOURCE(hrtc, RTC_IT_TAMP | RTC_IT_TAMP2) != RESET) && (__HAL_RTC_TAMPER_GET_FLAG(hrtc, RTC_FLAG_TAMP2F) != RESET)) |
| #if defined(RTC_TAMPER3_SUPPORT) |
| || ((__HAL_RTC_TAMPER_GET_IT_SOURCE(hrtc, RTC_IT_TAMP | RTC_IT_TAMP3) != RESET) && (__HAL_RTC_TAMPER_GET_FLAG(hrtc, RTC_FLAG_TAMP3F) != RESET)) |
| #endif /* RTC_TAMPER3_SUPPORT */ |
| ) |
| { |
| |
| /* Get the TimeStamp interrupt source enable status and pending flag status */ |
| if((__HAL_RTC_TIMESTAMP_GET_IT_SOURCE(hrtc, RTC_IT_TS) != RESET) && (__HAL_RTC_TIMESTAMP_GET_FLAG(hrtc, RTC_FLAG_TSF) != RESET)) |
| { |
| /* TIMESTAMP callback */ |
| HAL_RTCEx_TimeStampEventCallback(hrtc); |
| |
| /* Clear the TIMESTAMP interrupt pending bit (this will clear timestamp time and date registers) */ |
| __HAL_RTC_TIMESTAMP_CLEAR_FLAG(hrtc, RTC_FLAG_TSF); |
| } |
| |
| #if defined(RTC_TAMPER1_SUPPORT) |
| /* Get the Tamper1 interrupt source enable status and pending flag status */ |
| if((__HAL_RTC_TAMPER_GET_IT_SOURCE(hrtc, RTC_IT_TAMP | RTC_IT_TAMP1) != RESET) && (__HAL_RTC_TAMPER_GET_FLAG(hrtc, RTC_FLAG_TAMP1F) != RESET)) |
| { |
| /* Clear the Tamper1 interrupt pending bit */ |
| __HAL_RTC_TAMPER_CLEAR_FLAG(hrtc, RTC_FLAG_TAMP1F); |
| |
| /* Tamper1 callback */ |
| HAL_RTCEx_Tamper1EventCallback(hrtc); |
| } |
| #endif /* RTC_TAMPER1_SUPPORT */ |
| |
| /* Get the Tamper2 interrupt source enable status and pending flag status */ |
| if((__HAL_RTC_TAMPER_GET_IT_SOURCE(hrtc, RTC_IT_TAMP | RTC_IT_TAMP2) != RESET) && (__HAL_RTC_TAMPER_GET_FLAG(hrtc, RTC_FLAG_TAMP2F) != RESET)) |
| { |
| /* Clear the Tamper2 interrupt pending bit */ |
| __HAL_RTC_TAMPER_CLEAR_FLAG(hrtc, RTC_FLAG_TAMP2F); |
| |
| /* Tamper2 callback */ |
| HAL_RTCEx_Tamper2EventCallback(hrtc); |
| } |
| |
| #if defined(RTC_TAMPER3_SUPPORT) |
| /* Get the Tamper3 interrupts source enable status and pending flag status */ |
| if((__HAL_RTC_TAMPER_GET_IT_SOURCE(hrtc, RTC_IT_TAMP | RTC_IT_TAMP3) != RESET) && (__HAL_RTC_TAMPER_GET_FLAG(hrtc, RTC_FLAG_TAMP3F) != RESET)) |
| { |
| /* Clear the Tamper3 interrupt pending bit */ |
| __HAL_RTC_TAMPER_CLEAR_FLAG(hrtc, RTC_FLAG_TAMP3F); |
| |
| /* Tamper3 callback */ |
| HAL_RTCEx_Tamper3EventCallback(hrtc); |
| } |
| #endif /* RTC_TAMPER3_SUPPORT */ |
| |
| } |
| |
| /* Change RTC state */ |
| hrtc->State = HAL_RTC_STATE_READY; |
| } |
| |
| /** |
| * @brief TimeStamp callback. |
| * @param hrtc: RTC handle |
| * @retval None |
| */ |
| __weak void HAL_RTCEx_TimeStampEventCallback(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_RTCEx_TimeStampEventCallback could be implemented in the user file |
| */ |
| } |
| |
| #if defined(RTC_TAMPER1_SUPPORT) |
| /** |
| * @brief Tamper 1 callback. |
| * @param hrtc: RTC handle |
| * @retval None |
| */ |
| __weak void HAL_RTCEx_Tamper1EventCallback(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_RTCEx_Tamper1EventCallback could be implemented in the user file |
| */ |
| } |
| #endif /* RTC_TAMPER1_SUPPORT */ |
| |
| /** |
| * @brief Tamper 2 callback. |
| * @param hrtc: RTC handle |
| * @retval None |
| */ |
| __weak void HAL_RTCEx_Tamper2EventCallback(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_RTCEx_Tamper2EventCallback could be implemented in the user file |
| */ |
| } |
| |
| #if defined(RTC_TAMPER3_SUPPORT) |
| /** |
| * @brief Tamper 3 callback. |
| * @param hrtc: RTC handle |
| * @retval None |
| */ |
| __weak void HAL_RTCEx_Tamper3EventCallback(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_RTCEx_Tamper3EventCallback could be implemented in the user file |
| */ |
| } |
| #endif /* RTC_TAMPER3_SUPPORT */ |
| |
| /** |
| * @brief Handle TimeStamp polling request. |
| * @param hrtc: RTC handle |
| * @param Timeout: Timeout duration |
| * @retval HAL status |
| */ |
| HAL_StatusTypeDef HAL_RTCEx_PollForTimeStampEvent(RTC_HandleTypeDef *hrtc, uint32_t Timeout) |
| { |
| uint32_t tickstart = HAL_GetTick(); |
| |
| while(__HAL_RTC_TIMESTAMP_GET_FLAG(hrtc, RTC_FLAG_TSF) == RESET) |
| { |
| if(__HAL_RTC_TIMESTAMP_GET_FLAG(hrtc, RTC_FLAG_TSOVF) != RESET) |
| { |
| /* Clear the TIMESTAMP OverRun Flag */ |
| __HAL_RTC_TIMESTAMP_CLEAR_FLAG(hrtc, RTC_FLAG_TSOVF); |
| |
| /* Change TIMESTAMP state */ |
| hrtc->State = HAL_RTC_STATE_ERROR; |
| |
| return HAL_ERROR; |
| } |
| |
| if(Timeout != HAL_MAX_DELAY) |
| { |
| if((Timeout == 0)||((HAL_GetTick() - tickstart ) > Timeout)) |
| { |
| hrtc->State = HAL_RTC_STATE_TIMEOUT; |
| return HAL_TIMEOUT; |
| } |
| } |
| } |
| |
| /* Change RTC state */ |
| hrtc->State = HAL_RTC_STATE_READY; |
| |
| return HAL_OK; |
| } |
| |
| #if defined(RTC_TAMPER1_SUPPORT) |
| /** |
| * @brief Handle Tamper 1 Polling. |
| * @param hrtc: RTC handle |
| * @param Timeout: Timeout duration |
| * @retval HAL status |
| */ |
| HAL_StatusTypeDef HAL_RTCEx_PollForTamper1Event(RTC_HandleTypeDef *hrtc, uint32_t Timeout) |
| { |
| uint32_t tickstart = HAL_GetTick(); |
| |
| /* Get the status of the Interrupt */ |
| while(__HAL_RTC_TAMPER_GET_FLAG(hrtc, RTC_FLAG_TAMP1F)== RESET) |
| { |
| if(Timeout != HAL_MAX_DELAY) |
| { |
| if((Timeout == 0)||((HAL_GetTick() - tickstart ) > Timeout)) |
| { |
| hrtc->State = HAL_RTC_STATE_TIMEOUT; |
| return HAL_TIMEOUT; |
| } |
| } |
| } |
| |
| /* Clear the Tamper Flag */ |
| __HAL_RTC_TAMPER_CLEAR_FLAG(hrtc, RTC_FLAG_TAMP1F); |
| |
| /* Change RTC state */ |
| hrtc->State = HAL_RTC_STATE_READY; |
| |
| return HAL_OK; |
| } |
| #endif /* RTC_TAMPER1_SUPPORT */ |
| |
| /** |
| * @brief Handle Tamper 2 Polling. |
| * @param hrtc: RTC handle |
| * @param Timeout: Timeout duration |
| * @retval HAL status |
| */ |
| HAL_StatusTypeDef HAL_RTCEx_PollForTamper2Event(RTC_HandleTypeDef *hrtc, uint32_t Timeout) |
| { |
| uint32_t tickstart = HAL_GetTick(); |
| |
| /* Get the status of the Interrupt */ |
| while(__HAL_RTC_TAMPER_GET_FLAG(hrtc, RTC_FLAG_TAMP2F) == RESET) |
| { |
| if(Timeout != HAL_MAX_DELAY) |
| { |
| if((Timeout == 0)||((HAL_GetTick() - tickstart ) > Timeout)) |
| { |
| hrtc->State = HAL_RTC_STATE_TIMEOUT; |
| return HAL_TIMEOUT; |
| } |
| } |
| } |
| |
| /* Clear the Tamper Flag */ |
| __HAL_RTC_TAMPER_CLEAR_FLAG(hrtc, RTC_FLAG_TAMP2F); |
| |
| /* Change RTC state */ |
| hrtc->State = HAL_RTC_STATE_READY; |
| |
| return HAL_OK; |
| } |
| |
| #if defined(RTC_TAMPER3_SUPPORT) |
| /** |
| * @brief Handle Tamper 3 Polling. |
| * @param hrtc: RTC handle |
| * @param Timeout: Timeout duration |
| * @retval HAL status |
| */ |
| HAL_StatusTypeDef HAL_RTCEx_PollForTamper3Event(RTC_HandleTypeDef *hrtc, uint32_t Timeout) |
| { |
| uint32_t tickstart = HAL_GetTick(); |
| |
| /* Get the status of the Interrupt */ |
| while(__HAL_RTC_TAMPER_GET_FLAG(hrtc, RTC_FLAG_TAMP3F) == RESET) |
| { |
| if(Timeout != HAL_MAX_DELAY) |
| { |
| if((Timeout == 0)||((HAL_GetTick() - tickstart ) > Timeout)) |
| { |
| hrtc->State = HAL_RTC_STATE_TIMEOUT; |
| return HAL_TIMEOUT; |
| } |
| } |
| } |
| |
| /* Clear the Tamper Flag */ |
| __HAL_RTC_TAMPER_CLEAR_FLAG(hrtc, RTC_FLAG_TAMP3F); |
| |
| /* Change RTC state */ |
| hrtc->State = HAL_RTC_STATE_READY; |
| |
| return HAL_OK; |
| } |
| #endif /* RTC_TAMPER3_SUPPORT */ |
| |
| /** |
| * @} |
| */ |
| |
| /** @defgroup RTCEx_Exported_Functions_Group2 RTC Wake-up functions |
| * @brief RTC Wake-up functions |
| * |
| @verbatim |
| =============================================================================== |
| ##### RTC Wake-up functions ##### |
| =============================================================================== |
| |
| [..] This section provide functions allowing to configure Wake-up feature |
| |
| @endverbatim |
| * @{ |
| */ |
| |
| /** |
| * @brief Set wake up timer. |
| * @param hrtc: RTC handle |
| * @param WakeUpCounter: Wake up counter |
| * @param WakeUpClock: Wake up clock |
| * @retval HAL status |
| */ |
| HAL_StatusTypeDef HAL_RTCEx_SetWakeUpTimer(RTC_HandleTypeDef *hrtc, uint32_t WakeUpCounter, uint32_t WakeUpClock) |
| { |
| uint32_t tickstart = 0; |
| |
| /* Check the parameters */ |
| assert_param(IS_RTC_WAKEUP_CLOCK(WakeUpClock)); |
| assert_param(IS_RTC_WAKEUP_COUNTER(WakeUpCounter)); |
| |
| /* Process Locked */ |
| __HAL_LOCK(hrtc); |
| |
| hrtc->State = HAL_RTC_STATE_BUSY; |
| |
| /* Disable the write protection for RTC registers */ |
| __HAL_RTC_WRITEPROTECTION_DISABLE(hrtc); |
| |
| /*Check RTC WUTWF flag is reset only when wake up timer enabled*/ |
| if((hrtc->Instance->CR & RTC_CR_WUTE) != RESET) |
| { |
| tickstart = HAL_GetTick(); |
| |
| /* Wait till RTC WUTWF flag is reset and if Time out is reached exit */ |
| while(__HAL_RTC_WAKEUPTIMER_GET_FLAG(hrtc, RTC_FLAG_WUTWF) == SET) |
| { |
| if((HAL_GetTick() - tickstart ) > RTC_TIMEOUT_VALUE) |
| { |
| /* Enable the write protection for RTC registers */ |
| __HAL_RTC_WRITEPROTECTION_ENABLE(hrtc); |
| |
| hrtc->State = HAL_RTC_STATE_TIMEOUT; |
| |
| /* Process Unlocked */ |
| __HAL_UNLOCK(hrtc); |
| |
| return HAL_TIMEOUT; |
| } |
| } |
| } |
| |
| __HAL_RTC_WAKEUPTIMER_DISABLE(hrtc); |
| |
| tickstart = HAL_GetTick(); |
| |
| /* Wait till RTC WUTWF flag is set and if Time out is reached exit */ |
| while(__HAL_RTC_WAKEUPTIMER_GET_FLAG(hrtc, RTC_FLAG_WUTWF) == RESET) |
| { |
| if((HAL_GetTick() - tickstart ) > RTC_TIMEOUT_VALUE) |
| { |
| /* Enable the write protection for RTC registers */ |
| __HAL_RTC_WRITEPROTECTION_ENABLE(hrtc); |
| |
| hrtc->State = HAL_RTC_STATE_TIMEOUT; |
| |
| /* Process Unlocked */ |
| __HAL_UNLOCK(hrtc); |
| |
| return HAL_TIMEOUT; |
| } |
| } |
| |
| /* Clear the Wakeup Timer clock source bits in CR register */ |
| hrtc->Instance->CR &= (uint32_t)~RTC_CR_WUCKSEL; |
| |
| /* Configure the clock source */ |
| hrtc->Instance->CR |= (uint32_t)WakeUpClock; |
| |
| /* Configure the Wakeup Timer counter */ |
| hrtc->Instance->WUTR = (uint32_t)WakeUpCounter; |
| |
| /* Enable the Wakeup Timer */ |
| __HAL_RTC_WAKEUPTIMER_ENABLE(hrtc); |
| |
| /* Enable the write protection for RTC registers */ |
| __HAL_RTC_WRITEPROTECTION_ENABLE(hrtc); |
| |
| hrtc->State = HAL_RTC_STATE_READY; |
| |
| /* Process Unlocked */ |
| __HAL_UNLOCK(hrtc); |
| |
| return HAL_OK; |
| } |
| |
| /** |
| * @brief Set wake up timer with interrupt. |
| * @param hrtc: RTC handle |
| * @param WakeUpCounter: Wake up counter |
| * @param WakeUpClock: Wake up clock |
| * @retval HAL status |
| */ |
| HAL_StatusTypeDef HAL_RTCEx_SetWakeUpTimer_IT(RTC_HandleTypeDef *hrtc, uint32_t WakeUpCounter, uint32_t WakeUpClock) |
| { |
| uint32_t tickstart = 0; |
| |
| /* Check the parameters */ |
| assert_param(IS_RTC_WAKEUP_CLOCK(WakeUpClock)); |
| assert_param(IS_RTC_WAKEUP_COUNTER(WakeUpCounter)); |
| |
| /* Process Locked */ |
| __HAL_LOCK(hrtc); |
| |
| hrtc->State = HAL_RTC_STATE_BUSY; |
| |
| /* Disable the write protection for RTC registers */ |
| __HAL_RTC_WRITEPROTECTION_DISABLE(hrtc); |
| |
| /*Check RTC WUTWF flag is reset only when wake up timer enabled*/ |
| if((hrtc->Instance->CR & RTC_CR_WUTE) != RESET) |
| { |
| tickstart = HAL_GetTick(); |
| |
| /* Wait till RTC WUTWF flag is reset and if Time out is reached exit */ |
| while(__HAL_RTC_WAKEUPTIMER_GET_FLAG(hrtc, RTC_FLAG_WUTWF) == SET) |
| { |
| if((HAL_GetTick() - tickstart ) > RTC_TIMEOUT_VALUE) |
| { |
| /* Enable the write protection for RTC registers */ |
| __HAL_RTC_WRITEPROTECTION_ENABLE(hrtc); |
| |
| hrtc->State = HAL_RTC_STATE_TIMEOUT; |
| |
| /* Process Unlocked */ |
| __HAL_UNLOCK(hrtc); |
| |
| return HAL_TIMEOUT; |
| } |
| } |
| } |
| /* Disable the Wake-Up timer */ |
| __HAL_RTC_WAKEUPTIMER_DISABLE(hrtc); |
| |
| /* Clear flag Wake-Up */ |
| __HAL_RTC_WAKEUPTIMER_CLEAR_FLAG(hrtc, RTC_FLAG_WUTF); |
| |
| tickstart = HAL_GetTick(); |
| |
| /* Wait till RTC WUTWF flag is set and if Time out is reached exit */ |
| while(__HAL_RTC_WAKEUPTIMER_GET_FLAG(hrtc, RTC_FLAG_WUTWF) == RESET) |
| { |
| if((HAL_GetTick() - tickstart ) > RTC_TIMEOUT_VALUE) |
| { |
| /* Enable the write protection for RTC registers */ |
| __HAL_RTC_WRITEPROTECTION_ENABLE(hrtc); |
| |
| hrtc->State = HAL_RTC_STATE_TIMEOUT; |
| |
| /* Process Unlocked */ |
| __HAL_UNLOCK(hrtc); |
| |
| return HAL_TIMEOUT; |
| } |
| } |
| |
| /* Configure the Wakeup Timer counter */ |
| hrtc->Instance->WUTR = (uint32_t)WakeUpCounter; |
| |
| /* Clear the Wakeup Timer clock source bits in CR register */ |
| hrtc->Instance->CR &= (uint32_t)~RTC_CR_WUCKSEL; |
| |
| /* Configure the clock source */ |
| hrtc->Instance->CR |= (uint32_t)WakeUpClock; |
| |
| /* RTC WakeUpTimer Interrupt Configuration: EXTI configuration */ |
| __HAL_RTC_WAKEUPTIMER_EXTI_ENABLE_IT(); |
| |
| __HAL_RTC_WAKEUPTIMER_EXTI_ENABLE_RISING_EDGE(); |
| |
| /* Configure the Interrupt in the RTC_CR register */ |
| __HAL_RTC_WAKEUPTIMER_ENABLE_IT(hrtc,RTC_IT_WUT); |
| |
| /* Enable the Wakeup Timer */ |
| __HAL_RTC_WAKEUPTIMER_ENABLE(hrtc); |
| |
| /* Enable the write protection for RTC registers */ |
| __HAL_RTC_WRITEPROTECTION_ENABLE(hrtc); |
| |
| hrtc->State = HAL_RTC_STATE_READY; |
| |
| /* Process Unlocked */ |
| __HAL_UNLOCK(hrtc); |
| |
| return HAL_OK; |
| } |
| |
| /** |
| * @brief Deactivate wake up timer counter. |
| * @param hrtc: RTC handle |
| * @retval HAL status |
| */ |
| uint32_t HAL_RTCEx_DeactivateWakeUpTimer(RTC_HandleTypeDef *hrtc) |
| { |
| uint32_t tickstart = 0; |
| |
| /* Process Locked */ |
| __HAL_LOCK(hrtc); |
| |
| hrtc->State = HAL_RTC_STATE_BUSY; |
| |
| /* Disable the write protection for RTC registers */ |
| __HAL_RTC_WRITEPROTECTION_DISABLE(hrtc); |
| |
| /* Disable the Wakeup Timer */ |
| __HAL_RTC_WAKEUPTIMER_DISABLE(hrtc); |
| |
| /* In case of interrupt mode is used, the interrupt source must disabled */ |
| __HAL_RTC_WAKEUPTIMER_DISABLE_IT(hrtc,RTC_IT_WUT); |
| |
| tickstart = HAL_GetTick(); |
| /* Wait till RTC WUTWF flag is set and if Time out is reached exit */ |
| while(__HAL_RTC_WAKEUPTIMER_GET_FLAG(hrtc, RTC_FLAG_WUTWF) == RESET) |
| { |
| if((HAL_GetTick() - tickstart ) > RTC_TIMEOUT_VALUE) |
| { |
| /* Enable the write protection for RTC registers */ |
| __HAL_RTC_WRITEPROTECTION_ENABLE(hrtc); |
| |
| hrtc->State = HAL_RTC_STATE_TIMEOUT; |
| |
| /* Process Unlocked */ |
| __HAL_UNLOCK(hrtc); |
| |
| return HAL_TIMEOUT; |
| } |
| } |
| |
| /* Enable the write protection for RTC registers */ |
| __HAL_RTC_WRITEPROTECTION_ENABLE(hrtc); |
| |
| hrtc->State = HAL_RTC_STATE_READY; |
| |
| /* Process Unlocked */ |
| __HAL_UNLOCK(hrtc); |
| |
| return HAL_OK; |
| } |
| |
| /** |
| * @brief Get wake up timer counter. |
| * @param hrtc: RTC handle |
| * @retval Counter value |
| */ |
| uint32_t HAL_RTCEx_GetWakeUpTimer(RTC_HandleTypeDef *hrtc) |
| { |
| /* Get the counter value */ |
| return ((uint32_t)(hrtc->Instance->WUTR & RTC_WUTR_WUT)); |
| } |
| |
| /** |
| * @brief Handle Wake Up Timer interrupt request. |
| * @param hrtc: RTC handle |
| * @retval None |
| */ |
| void HAL_RTCEx_WakeUpTimerIRQHandler(RTC_HandleTypeDef *hrtc) |
| { |
| /* Clear the EXTI's line Flag for RTC WakeUpTimer */ |
| __HAL_RTC_WAKEUPTIMER_EXTI_CLEAR_FLAG(); |
| |
| /* Get the pending status of the WAKEUPTIMER Interrupt */ |
| if(__HAL_RTC_WAKEUPTIMER_GET_FLAG(hrtc, RTC_FLAG_WUTF) != RESET) |
| { |
| /* Clear the WAKEUPTIMER interrupt pending bit */ |
| __HAL_RTC_WAKEUPTIMER_CLEAR_FLAG(hrtc, RTC_FLAG_WUTF); |
| |
| /* WAKEUPTIMER callback */ |
| HAL_RTCEx_WakeUpTimerEventCallback(hrtc); |
| } |
| |
| /* Change RTC state */ |
| hrtc->State = HAL_RTC_STATE_READY; |
| } |
| |
| /** |
| * @brief Wake Up Timer callback. |
| * @param hrtc: RTC handle |
| * @retval None |
| */ |
| __weak void HAL_RTCEx_WakeUpTimerEventCallback(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_RTCEx_WakeUpTimerEventCallback could be implemented in the user file |
| */ |
| } |
| |
| /** |
| * @brief Handle Wake Up Timer Polling. |
| * @param hrtc: RTC handle |
| * @param Timeout: Timeout duration |
| * @retval HAL status |
| */ |
| HAL_StatusTypeDef HAL_RTCEx_PollForWakeUpTimerEvent(RTC_HandleTypeDef *hrtc, uint32_t Timeout) |
| { |
| uint32_t tickstart = HAL_GetTick(); |
| |
| while(__HAL_RTC_WAKEUPTIMER_GET_FLAG(hrtc, RTC_FLAG_WUTF) == RESET) |
| { |
| if(Timeout != HAL_MAX_DELAY) |
| { |
| if((Timeout == 0)||((HAL_GetTick() - tickstart ) > Timeout)) |
| { |
| hrtc->State = HAL_RTC_STATE_TIMEOUT; |
| |
| return HAL_TIMEOUT; |
| } |
| } |
| } |
| |
| /* Clear the WAKEUPTIMER Flag */ |
| __HAL_RTC_WAKEUPTIMER_CLEAR_FLAG(hrtc, RTC_FLAG_WUTF); |
| |
| /* Change RTC state */ |
| hrtc->State = HAL_RTC_STATE_READY; |
| |
| return HAL_OK; |
| } |
| |
| /** |
| * @} |
| */ |
| |
| |
| /** @defgroup RTCEx_Exported_Functions_Group3 Extended Peripheral Control functions |
| * @brief Extended Peripheral Control functions |
| * |
| @verbatim |
| =============================================================================== |
| ##### Extended Peripheral Control functions ##### |
| =============================================================================== |
| [..] |
| This subsection provides functions allowing to |
| (+) Write a data in a specified RTC Backup data register |
| (+) Read a data in a specified RTC Backup data register |
| (+) Set the Coarse calibration parameters. |
| (+) Deactivate the Coarse calibration parameters |
| (+) Set the Smooth calibration parameters. |
| (+) Configure the Synchronization Shift Control Settings. |
| (+) Configure the Calibration Pinout (RTC_CALIB) Selection (1Hz or 512Hz). |
| (+) Deactivate the Calibration Pinout (RTC_CALIB) Selection (1Hz or 512Hz). |
| (+) Enable the RTC reference clock detection. |
| (+) Disable the RTC reference clock detection. |
| (+) Enable the Bypass Shadow feature. |
| (+) Disable the Bypass Shadow feature. |
| |
| @endverbatim |
| * @{ |
| */ |
| |
| /** |
| * @brief Write a data in a specified RTC Backup data register. |
| * @param hrtc: RTC handle |
| * @param BackupRegister: RTC Backup data Register number. |
| * This parameter can be: RTC_BKP_DRx where x can be from 0 to 19 to |
| * specify the register. |
| * @param Data: Data to be written in the specified RTC Backup data register. |
| * @retval None |
| */ |
| void HAL_RTCEx_BKUPWrite(RTC_HandleTypeDef *hrtc, uint32_t BackupRegister, uint32_t Data) |
| { |
| uint32_t tmp = 0; |
| |
| /* Check the parameters */ |
| assert_param(IS_RTC_BKP(BackupRegister)); |
| |
| tmp = (uint32_t)&(hrtc->Instance->BKP0R); |
| tmp += (BackupRegister * 4); |
| |
| /* Write the specified register */ |
| *(__IO uint32_t *)tmp = (uint32_t)Data; |
| } |
| |
| /** |
| * @brief Read data from the specified RTC Backup data Register. |
| * @param hrtc: RTC handle |
| * @param BackupRegister: RTC Backup data Register number. |
| * This parameter can be: RTC_BKP_DRx where x can be from 0 to 19 to |
| * specify the register. |
| * @retval Read value |
| */ |
| uint32_t HAL_RTCEx_BKUPRead(RTC_HandleTypeDef *hrtc, uint32_t BackupRegister) |
| { |
| uint32_t tmp = 0; |
| |
| /* Check the parameters */ |
| assert_param(IS_RTC_BKP(BackupRegister)); |
| |
| tmp = (uint32_t)&(hrtc->Instance->BKP0R); |
| tmp += (BackupRegister * 4); |
| |
| /* Read the specified register */ |
| return (*(__IO uint32_t *)tmp); |
| } |
| |
| /** |
| * @brief Set the Smooth calibration parameters. |
| * @param hrtc: RTC handle |
| * @param SmoothCalibPeriod: Select the Smooth Calibration Period. |
| * This parameter can be can be one of the following values : |
| * @arg RTC_SMOOTHCALIB_PERIOD_32SEC: The smooth calibration period is 32s. |
| * @arg RTC_SMOOTHCALIB_PERIOD_16SEC: The smooth calibration period is 16s. |
| * @arg RTC_SMOOTHCALIB_PERIOD_8SEC: The smooth calibration period is 8s. |
| * @param SmoothCalibPlusPulses: Select to Set or reset the CALP bit. |
| * This parameter can be one of the following values: |
| * @arg RTC_SMOOTHCALIB_PLUSPULSES_SET: Add one RTCCLK pulse every 2*11 pulses. |
| * @arg RTC_SMOOTHCALIB_PLUSPULSES_RESET: No RTCCLK pulses are added. |
| * @param SmoothCalibMinusPulsesValue: Select the value of CALM[8:0] bits. |
| * This parameter can be one any value from 0 to 0x000001FF. |
| * @note To deactivate the smooth calibration, the field SmoothCalibPlusPulses |
| * must be equal to SMOOTHCALIB_PLUSPULSES_RESET and the field |
| * SmoothCalibMinusPulsesValue must be equal to 0. |
| * @retval HAL status |
| */ |
| HAL_StatusTypeDef HAL_RTCEx_SetSmoothCalib(RTC_HandleTypeDef* hrtc, uint32_t SmoothCalibPeriod, uint32_t SmoothCalibPlusPulses, uint32_t SmoothCalibMinusPulsesValue) |
| { |
| uint32_t tickstart = 0; |
| |
| /* Check the parameters */ |
| assert_param(IS_RTC_SMOOTH_CALIB_PERIOD(SmoothCalibPeriod)); |
| assert_param(IS_RTC_SMOOTH_CALIB_PLUS(SmoothCalibPlusPulses)); |
| assert_param(IS_RTC_SMOOTH_CALIB_MINUS(SmoothCalibMinusPulsesValue)); |
| |
| /* Process Locked */ |
| __HAL_LOCK(hrtc); |
| |
| hrtc->State = HAL_RTC_STATE_BUSY; |
| |
| /* Disable the write protection for RTC registers */ |
| __HAL_RTC_WRITEPROTECTION_DISABLE(hrtc); |
| |
| /* check if a calibration is pending*/ |
| if((hrtc->Instance->ISR & RTC_ISR_RECALPF) != RESET) |
| { |
| tickstart = HAL_GetTick(); |
| |
| /* check if a calibration is pending*/ |
| while((hrtc->Instance->ISR & RTC_ISR_RECALPF) != RESET) |
| { |
| if((HAL_GetTick() - tickstart ) > RTC_TIMEOUT_VALUE) |
| { |
| /* Enable the write protection for RTC registers */ |
| __HAL_RTC_WRITEPROTECTION_ENABLE(hrtc); |
| |
| /* Change RTC state */ |
| hrtc->State = HAL_RTC_STATE_TIMEOUT; |
| |
| /* Process Unlocked */ |
| __HAL_UNLOCK(hrtc); |
| |
| return HAL_TIMEOUT; |
| } |
| } |
| } |
| |
| /* Configure the Smooth calibration settings */ |
| hrtc->Instance->CALR = (uint32_t)((uint32_t)SmoothCalibPeriod | (uint32_t)SmoothCalibPlusPulses | (uint32_t)SmoothCalibMinusPulsesValue); |
| |
| /* Enable the write protection for RTC registers */ |
| __HAL_RTC_WRITEPROTECTION_ENABLE(hrtc); |
| |
| /* Change RTC state */ |
| hrtc->State = HAL_RTC_STATE_READY; |
| |
| /* Process Unlocked */ |
| __HAL_UNLOCK(hrtc); |
| |
| return HAL_OK; |
| } |
| |
| /** |
| * @brief Configure the Synchronization Shift Control Settings. |
| * @note When REFCKON is set, firmware must not write to Shift control register. |
| * @param hrtc: RTC handle |
| * @param ShiftAdd1S: Select to add or not 1 second to the time calendar. |
| * This parameter can be one of the following values : |
| * @arg RTC_SHIFTADD1S_SET: Add one second to the clock calendar. |
| * @arg RTC_SHIFTADD1S_RESET: No effect. |
| * @param ShiftSubFS: Select the number of Second Fractions to substitute. |
| * This parameter can be one any value from 0 to 0x7FFF. |
| * @retval HAL status |
| */ |
| HAL_StatusTypeDef HAL_RTCEx_SetSynchroShift(RTC_HandleTypeDef* hrtc, uint32_t ShiftAdd1S, uint32_t ShiftSubFS) |
| { |
| uint32_t tickstart = 0; |
| |
| /* Check the parameters */ |
| assert_param(IS_RTC_SHIFT_ADD1S(ShiftAdd1S)); |
| assert_param(IS_RTC_SHIFT_SUBFS(ShiftSubFS)); |
| |
| /* Process Locked */ |
| __HAL_LOCK(hrtc); |
| |
| hrtc->State = HAL_RTC_STATE_BUSY; |
| |
| /* Disable the write protection for RTC registers */ |
| __HAL_RTC_WRITEPROTECTION_DISABLE(hrtc); |
| |
| tickstart = HAL_GetTick(); |
| |
| /* Wait until the shift is completed*/ |
| while((hrtc->Instance->ISR & RTC_ISR_SHPF) != RESET) |
| { |
| if((HAL_GetTick() - tickstart ) > RTC_TIMEOUT_VALUE) |
| { |
| /* Enable the write protection for RTC registers */ |
| __HAL_RTC_WRITEPROTECTION_ENABLE(hrtc); |
| |
| hrtc->State = HAL_RTC_STATE_TIMEOUT; |
| |
| /* Process Unlocked */ |
| __HAL_UNLOCK(hrtc); |
| |
| return HAL_TIMEOUT; |
| } |
| } |
| |
| /* Check if the reference clock detection is disabled */ |
| if((hrtc->Instance->CR & RTC_CR_REFCKON) == RESET) |
| { |
| /* Configure the Shift settings */ |
| hrtc->Instance->SHIFTR = (uint32_t)(uint32_t)(ShiftSubFS) | (uint32_t)(ShiftAdd1S); |
| |
| /* If RTC_CR_BYPSHAD bit = 0, wait for synchro else this check is not needed */ |
| if((hrtc->Instance->CR & RTC_CR_BYPSHAD) == RESET) |
| { |
| if(HAL_RTC_WaitForSynchro(hrtc) != HAL_OK) |
| { |
| /* Enable the write protection for RTC registers */ |
| __HAL_RTC_WRITEPROTECTION_ENABLE(hrtc); |
| |
| hrtc->State = HAL_RTC_STATE_ERROR; |
| |
| /* Process Unlocked */ |
| __HAL_UNLOCK(hrtc); |
| |
| return HAL_ERROR; |
| } |
| } |
| } |
| else |
| { |
| /* Enable the write protection for RTC registers */ |
| __HAL_RTC_WRITEPROTECTION_ENABLE(hrtc); |
| |
| /* Change RTC state */ |
| hrtc->State = HAL_RTC_STATE_ERROR; |
| |
| /* Process Unlocked */ |
| __HAL_UNLOCK(hrtc); |
| |
| return HAL_ERROR; |
| } |
| |
| /* Enable the write protection for RTC registers */ |
| __HAL_RTC_WRITEPROTECTION_ENABLE(hrtc); |
| |
| /* Change RTC state */ |
| hrtc->State = HAL_RTC_STATE_READY; |
| |
| /* Process Unlocked */ |
| __HAL_UNLOCK(hrtc); |
| |
| return HAL_OK; |
| } |
| |
| /** |
| * @brief Configure the Calibration Pinout (RTC_CALIB) Selection (1Hz or 512Hz). |
| * @param hrtc: RTC handle |
| * @param CalibOutput : Select the Calibration output Selection . |
| * This parameter can be one of the following values: |
| * @arg RTC_CALIBOUTPUT_512HZ: A signal has a regular waveform at 512Hz. |
| * @arg RTC_CALIBOUTPUT_1HZ: A signal has a regular waveform at 1Hz. |
| * @retval HAL status |
| */ |
| HAL_StatusTypeDef HAL_RTCEx_SetCalibrationOutPut(RTC_HandleTypeDef* hrtc, uint32_t CalibOutput) |
| { |
| /* Check the parameters */ |
| assert_param(IS_RTC_CALIB_OUTPUT(CalibOutput)); |
| |
| /* Process Locked */ |
| __HAL_LOCK(hrtc); |
| |
| hrtc->State = HAL_RTC_STATE_BUSY; |
| |
| /* Disable the write protection for RTC registers */ |
| __HAL_RTC_WRITEPROTECTION_DISABLE(hrtc); |
| |
| /* Clear flags before config */ |
| hrtc->Instance->CR &= (uint32_t)~RTC_CR_COSEL; |
| |
| /* Configure the RTC_CR register */ |
| hrtc->Instance->CR |= (uint32_t)CalibOutput; |
| |
| __HAL_RTC_CALIBRATION_OUTPUT_ENABLE(hrtc); |
| |
| /* Enable the write protection for RTC registers */ |
| __HAL_RTC_WRITEPROTECTION_ENABLE(hrtc); |
| |
| /* Change RTC state */ |
| hrtc->State = HAL_RTC_STATE_READY; |
| |
| /* Process Unlocked */ |
| __HAL_UNLOCK(hrtc); |
| |
| return HAL_OK; |
| } |
| |
| /** |
| * @brief Deactivate the Calibration Pinout (RTC_CALIB) Selection (1Hz or 512Hz). |
| * @param hrtc: RTC handle |
| * @retval HAL status |
| */ |
| HAL_StatusTypeDef HAL_RTCEx_DeactivateCalibrationOutPut(RTC_HandleTypeDef* hrtc) |
| { |
| /* Process Locked */ |
| __HAL_LOCK(hrtc); |
| |
| hrtc->State = HAL_RTC_STATE_BUSY; |
| |
| /* Disable the write protection for RTC registers */ |
| __HAL_RTC_WRITEPROTECTION_DISABLE(hrtc); |
| |
| __HAL_RTC_CALIBRATION_OUTPUT_DISABLE(hrtc); |
| |
| /* Enable the write protection for RTC registers */ |
| __HAL_RTC_WRITEPROTECTION_ENABLE(hrtc); |
| |
| /* Change RTC state */ |
| hrtc->State = HAL_RTC_STATE_READY; |
| |
| /* Process Unlocked */ |
| __HAL_UNLOCK(hrtc); |
| |
| return HAL_OK; |
| } |
| |
| /** |
| * @brief Enable the RTC reference clock detection. |
| * @param hrtc: RTC handle |
| * @retval HAL status |
| */ |
| HAL_StatusTypeDef HAL_RTCEx_SetRefClock(RTC_HandleTypeDef* hrtc) |
| { |
| /* Process Locked */ |
| __HAL_LOCK(hrtc); |
| |
| hrtc->State = HAL_RTC_STATE_BUSY; |
| |
| /* Disable the write protection for RTC registers */ |
| __HAL_RTC_WRITEPROTECTION_DISABLE(hrtc); |
| |
| /* Set Initialization mode */ |
| if(RTC_EnterInitMode(hrtc) != HAL_OK) |
| { |
| /* Enable the write protection for RTC registers */ |
| __HAL_RTC_WRITEPROTECTION_ENABLE(hrtc); |
| |
| /* Set RTC state*/ |
| hrtc->State = HAL_RTC_STATE_ERROR; |
| |
| /* Process Unlocked */ |
| __HAL_UNLOCK(hrtc); |
| |
| return HAL_ERROR; |
| } |
| else |
| { |
| __HAL_RTC_CLOCKREF_DETECTION_ENABLE(hrtc); |
| |
| /* Exit Initialization mode */ |
| hrtc->Instance->ISR &= (uint32_t)~RTC_ISR_INIT; |
| } |
| |
| /* Enable the write protection for RTC registers */ |
| __HAL_RTC_WRITEPROTECTION_ENABLE(hrtc); |
| |
| /* Change RTC state */ |
| hrtc->State = HAL_RTC_STATE_READY; |
| |
| /* Process Unlocked */ |
| __HAL_UNLOCK(hrtc); |
| |
| return HAL_OK; |
| } |
| |
| /** |
| * @brief Disable the RTC reference clock detection. |
| * @param hrtc: RTC handle |
| * @retval HAL status |
| */ |
| HAL_StatusTypeDef HAL_RTCEx_DeactivateRefClock(RTC_HandleTypeDef* hrtc) |
| { |
| /* Process Locked */ |
| __HAL_LOCK(hrtc); |
| |
| hrtc->State = HAL_RTC_STATE_BUSY; |
| |
| /* Disable the write protection for RTC registers */ |
| __HAL_RTC_WRITEPROTECTION_DISABLE(hrtc); |
| |
| /* Set Initialization mode */ |
| if(RTC_EnterInitMode(hrtc) != HAL_OK) |
| { |
| /* Enable the write protection for RTC registers */ |
| __HAL_RTC_WRITEPROTECTION_ENABLE(hrtc); |
| |
| /* Set RTC state*/ |
| hrtc->State = HAL_RTC_STATE_ERROR; |
| |
| /* Process Unlocked */ |
| __HAL_UNLOCK(hrtc); |
| |
| return HAL_ERROR; |
| } |
| else |
| { |
| __HAL_RTC_CLOCKREF_DETECTION_DISABLE(hrtc); |
| |
| /* Exit Initialization mode */ |
| hrtc->Instance->ISR &= (uint32_t)~RTC_ISR_INIT; |
| } |
| |
| /* Enable the write protection for RTC registers */ |
| __HAL_RTC_WRITEPROTECTION_ENABLE(hrtc); |
| |
| /* Change RTC state */ |
| hrtc->State = HAL_RTC_STATE_READY; |
| |
| /* Process Unlocked */ |
| __HAL_UNLOCK(hrtc); |
| |
| return HAL_OK; |
| } |
| |
| /** |
| * @brief Enable the Bypass Shadow feature. |
| * @param hrtc: RTC handle |
| * @note When the Bypass Shadow is enabled the calendar value are taken |
| * directly from the Calendar counter. |
| * @retval HAL status |
| */ |
| HAL_StatusTypeDef HAL_RTCEx_EnableBypassShadow(RTC_HandleTypeDef* hrtc) |
| { |
| /* Process Locked */ |
| __HAL_LOCK(hrtc); |
| |
| hrtc->State = HAL_RTC_STATE_BUSY; |
| |
| /* Disable the write protection for RTC registers */ |
| __HAL_RTC_WRITEPROTECTION_DISABLE(hrtc); |
| |
| /* Set the BYPSHAD bit */ |
| hrtc->Instance->CR |= (uint8_t)RTC_CR_BYPSHAD; |
| |
| /* Enable the write protection for RTC registers */ |
| __HAL_RTC_WRITEPROTECTION_ENABLE(hrtc); |
| |
| /* Change RTC state */ |
| hrtc->State = HAL_RTC_STATE_READY; |
| |
| /* Process Unlocked */ |
| __HAL_UNLOCK(hrtc); |
| |
| return HAL_OK; |
| } |
| |
| /** |
| * @brief Disable the Bypass Shadow feature. |
| * @param hrtc: RTC handle |
| * @note When the Bypass Shadow is enabled the calendar value are taken |
| * directly from the Calendar counter. |
| * @retval HAL status |
| */ |
| HAL_StatusTypeDef HAL_RTCEx_DisableBypassShadow(RTC_HandleTypeDef* hrtc) |
| { |
| /* Process Locked */ |
| __HAL_LOCK(hrtc); |
| |
| hrtc->State = HAL_RTC_STATE_BUSY; |
| |
| /* Disable the write protection for RTC registers */ |
| __HAL_RTC_WRITEPROTECTION_DISABLE(hrtc); |
| |
| /* Reset the BYPSHAD bit */ |
| hrtc->Instance->CR &= ((uint8_t)~RTC_CR_BYPSHAD); |
| |
| /* Enable the write protection for RTC registers */ |
| __HAL_RTC_WRITEPROTECTION_ENABLE(hrtc); |
| |
| /* Change RTC state */ |
| hrtc->State = HAL_RTC_STATE_READY; |
| |
| /* Process Unlocked */ |
| __HAL_UNLOCK(hrtc); |
| |
| return HAL_OK; |
| } |
| |
| /** |
| * @} |
| */ |
| |
| /** @defgroup RTCEx_Exported_Functions_Group4 Extended features functions |
| * @brief Extended features functions |
| * |
| @verbatim |
| =============================================================================== |
| ##### Extended features functions ##### |
| =============================================================================== |
| [..] This section provides functions allowing to: |
| (+) RTC Alarm B callback |
| (+) RTC Poll for Alarm B request |
| |
| @endverbatim |
| * @{ |
| */ |
| |
| /** |
| * @brief Alarm B callback. |
| * @param hrtc: RTC handle |
| * @retval None |
| */ |
| __weak void HAL_RTCEx_AlarmBEventCallback(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_RTCEx_AlarmBEventCallback could be implemented in the user file |
| */ |
| } |
| |
| /** |
| * @brief Handle Alarm B Polling request. |
| * @param hrtc: RTC handle |
| * @param Timeout: Timeout duration |
| * @retval HAL status |
| */ |
| HAL_StatusTypeDef HAL_RTCEx_PollForAlarmBEvent(RTC_HandleTypeDef *hrtc, uint32_t Timeout) |
| { |
| uint32_t tickstart = HAL_GetTick(); |
| |
| while(__HAL_RTC_ALARM_GET_FLAG(hrtc, RTC_FLAG_ALRBF) == RESET) |
| { |
| if(Timeout != HAL_MAX_DELAY) |
| { |
| if((Timeout == 0)||((HAL_GetTick() - tickstart ) > Timeout)) |
| { |
| hrtc->State = HAL_RTC_STATE_TIMEOUT; |
| return HAL_TIMEOUT; |
| } |
| } |
| } |
| |
| /* Clear the Alarm Flag */ |
| __HAL_RTC_ALARM_CLEAR_FLAG(hrtc, RTC_FLAG_ALRBF); |
| |
| /* Change RTC state */ |
| hrtc->State = HAL_RTC_STATE_READY; |
| |
| return HAL_OK; |
| } |
| |
| /** |
| * @} |
| */ |
| |
| /** |
| * @} |
| */ |
| |
| #endif /* HAL_RTC_MODULE_ENABLED */ |
| /** |
| * @} |
| */ |
| |
| /** |
| * @} |
| */ |
| |
| /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/ |