1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038 |
- /**
- ******************************************************************************
- * @file stm32g4xx_hal_rtc.c
- * @author MCD Application Team
- * @brief RTC HAL module driver.
- * This file provides firmware functions to manage the following
- * functionalities of the Real-Time Clock (RTC) peripheral:
- * + Initialization/de-initialization functions
- * + Calendar (Time and Date) configuration
- * + Alarms (Alarm A and Alarm B) configuration
- * + WakeUp Timer configuration
- * + TimeStamp configuration
- * + Tampers configuration
- * + Backup Data Registers configuration
- * + RTC Tamper and TimeStamp Pins Selection
- * + Interrupts and flags management
- *
- ******************************************************************************
- * @attention
- *
- * Copyright (c) 2019 STMicroelectronics.
- * All rights reserved.
- *
- * This software is licensed under terms that can be found in the LICENSE file
- * in the root directory of this software component.
- * If no LICENSE file comes with this software, it is provided AS-IS.
- *
- ******************************************************************************
- @verbatim
- ===============================================================================
- ##### RTC Operating Condition #####
- ===============================================================================
- [..] The real-time clock (RTC) and the RTC backup registers can be powered
- from the VBAT voltage when the main VDD supply is powered off.
- To retain the content of the RTC backup registers and supply the RTC
- when VDD is turned off, VBAT pin can be connected to an optional
- standby voltage supplied by a battery or by another source.
- ##### Backup Domain Reset #####
- ===============================================================================
- [..] The backup domain reset sets all RTC registers and the RCC_BDCR register
- to their reset values.
- A backup domain reset is generated when one of the following events occurs:
- (#) Software reset, triggered by setting the BDRST bit in the
- RCC Backup domain control register (RCC_BDCR).
- (#) VDD or VBAT power on, if both supplies have previously been powered off.
- (#) Tamper detection event resets all data backup registers.
- ##### Backup Domain Access #####
- ==================================================================
- [..] After reset, the backup domain (RTC registers and RTC backup data registers)
- is protected against possible unwanted write accesses.
- [..] To enable access to the RTC Domain and RTC registers, proceed as follows:
- (+) Enable the Power Controller (PWR) APB1 interface clock using the
- __HAL_RCC_PWR_CLK_ENABLE() function.
- (+) Enable access to RTC domain using the HAL_PWR_EnableBkUpAccess() function.
- (+) Select the RTC clock source using the __HAL_RCC_RTC_CONFIG() function.
- (+) Enable RTC Clock using the __HAL_RCC_RTC_ENABLE() function.
- [..] To enable access to the RTC Domain and RTC registers, proceed as follows:
- (#) Call the function HAL_RCCEx_PeriphCLKConfig with RCC_PERIPHCLK_RTC for
- PeriphClockSelection and select RTCClockSelection (LSE, LSI or HSEdiv32)
- (#) Enable RTC Clock using the __HAL_RCC_RTC_ENABLE() macro.
- ##### How to use RTC Driver #####
- ===================================================================
- [..]
- (+) Enable the RTC domain access (see description in the section above).
- (+) Configure the RTC Prescaler (Asynchronous and Synchronous) and RTC hour
- format using the HAL_RTC_Init() function.
- *** Time and Date configuration ***
- ===================================
- [..]
- (+) To configure the RTC Calendar (Time and Date) use the HAL_RTC_SetTime()
- and HAL_RTC_SetDate() functions.
- (+) To read the RTC Calendar, use the HAL_RTC_GetTime() and HAL_RTC_GetDate() functions.
- *** Alarm configuration ***
- ===========================
- [..]
- (+) To configure the RTC Alarm use the HAL_RTC_SetAlarm() function.
- You can also configure the RTC Alarm with interrupt mode using the
- HAL_RTC_SetAlarm_IT() function.
- (+) To read the RTC Alarm, use the HAL_RTC_GetAlarm() function.
- ##### RTC and low power modes #####
- ==================================================================
- [..] The MCU can be woken up from a low power mode by an RTC alternate
- function.
- [..] The RTC alternate functions are the RTC alarms (Alarm A and Alarm B),
- RTC wakeup, RTC tamper event detection and RTC time stamp event detection.
- These RTC alternate functions can wake up the system from the Stop and
- Standby low power modes.
- [..] The system can also wake up from low power modes without depending
- on an external interrupt (Auto-wakeup mode), by using the RTC alarm
- or the RTC wakeup events.
- [..] The RTC provides a programmable time base for waking up from the
- Stop or Standby mode at regular intervals.
- Wakeup from STOP and STANDBY modes is possible only when the RTC clock source
- is LSE or LSI.
- *** Callback registration ***
- =============================================
- 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. This is the recommended configuration
- in order to optimize memory/code consumption footprint/performances.
- [..]
- The compilation define USE_RTC_REGISTER_CALLBACKS when set to 1
- allows the user to configure dynamically the driver callbacks.
- Use Function HAL_RTC_RegisterCallback() to register an interrupt callback.
- [..]
- Function HAL_RTC_RegisterCallback() allows to register following callbacks:
- (+) AlarmAEventCallback : RTC Alarm A Event callback.
- (+) AlarmBEventCallback : RTC Alarm B Event callback.
- (+) TimeStampEventCallback : RTC TimeStamp Event callback.
- (+) WakeUpTimerEventCallback : RTC WakeUpTimer Event callback.
- (+) Tamper1EventCallback : RTC Tamper 1 Event callback.
- (+) Tamper2EventCallback : RTC Tamper 2 Event callback.
- (+) Tamper3EventCallback : RTC Tamper 3 Event callback.
- (+) Tamper4EventCallback : RTC Tamper 4 Event callback.
- (+) Tamper5EventCallback : RTC Tamper 5 Event callback.
- (+) Tamper6EventCallback : RTC Tamper 6 Event callback.
- (+) Tamper7EventCallback : RTC Tamper 7 Event callback.
- (+) Tamper8EventCallback : RTC Tamper 8 Event callback.
- (+) InternalTamper1EventCallback : RTC InternalTamper 1 Event callback.
- (+) InternalTamper2EventCallback : RTC InternalTamper 2 Event callback.
- (+) InternalTamper3EventCallback : RTC InternalTamper 3 Event callback.
- (+) InternalTamper5EventCallback : RTC InternalTamper 5 Event callback.
- (+) InternalTamper8EventCallback : RTC InternalTamper 8 Event callback.
- #if defined (__ARM_FEATURE_CMSE) && (__ARM_FEATURE_CMSE == 3U)
- (+) AlarmAEventCallback_S : RTC Alarm A Event callback_S
- (+) AlarmBEventCallback_S : RTC Alarm B Event callback_S.
- (+) TimeStampEventCallback_S : RTC TimeStampEvent callback_S.
- (+) WakeUpTimerEventCallback_S : RTC WakeUpTimerEvent callback_S.
- (+) Tamper1EventCallback_S : RTC Tamper 1 Event callback_S.
- (+) Tamper2EventCallback_S : RTC Tamper 2 Event callback_S.
- (+) Tamper3EventCallback_S : RTC Tamper 3 Event callback_S.
- (+) Tamper4EventCallback_S : RTC Tamper 4 Event callback_S.
- (+) Tamper5EventCallback_S : RTC Tamper 5 Event callback_S.
- (+) Tamper6EventCallback_S : RTC Tamper 6 Event callback_S.
- (+) Tamper7EventCallback_S : RTC Tamper 7 Event callback_S.
- (+) Tamper8EventCallback_S : RTC Tamper 8 Event callback_S.
- (+) InternalTamper1EventCallback_S : RTC InternalTamper 1 Event callback_S.
- (+) InternalTamper2EventCallback_S : RTC InternalTamper 2 Event callback_S.
- (+) InternalTamper3EventCallback_S : RTC InternalTamper 3 Event callback_S.
- (+) InternalTamper5EventCallback_S : RTC InternalTamper 5 Event callback_S.
- (+) InternalTamper8EventCallback_S : RTC InternalTamper 8 Event callback_S.
- #endif
- (+) 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 HAL_RTC_UnRegisterCallback() to reset a callback to the default
- weak function.
- 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.
- (+) AlarmBEventCallback : RTC Alarm B Event callback.
- (+) TimeStampEventCallback : RTC TimeStamp Event callback.
- (+) WakeUpTimerEventCallback : RTC WakeUpTimer Event callback.
- (+) Tamper1EventCallback : RTC Tamper 1 Event callback.
- (+) Tamper2EventCallback : RTC Tamper 2 Event callback.
- (+) Tamper3EventCallback : RTC Tamper 3 Event callback.
- (+) Tamper4EventCallback : RTC Tamper 4 Event callback.
- (+) Tamper5EventCallback : RTC Tamper 5 Event callback.
- (+) Tamper6EventCallback : RTC Tamper 6 Event callback.
- (+) Tamper7EventCallback : RTC Tamper 7 Event callback.
- (+) Tamper8EventCallback : RTC Tamper 8 Event callback.
- (+) InternalTamper1EventCallback : RTC Internal Tamper 1 Event callback.
- (+) InternalTamper2EventCallback : RTC Internal Tamper 2 Event callback.
- (+) InternalTamper3EventCallback : RTC Internal Tamper 3 Event callback.
- (+) InternalTamper4EventCallback : RTC Internal Tamper 4 Event callback.
- (+) InternalTamper5EventCallback : RTC Internal Tamper 5 Event callback.
- (+) InternalTamper6EventCallback : RTC Internal Tamper 6 Event callback.
- (+) InternalTamper8EventCallback : RTC Internal Tamper 8 Event callback.
- #if defined (__ARM_FEATURE_CMSE) && (__ARM_FEATURE_CMSE == 3U)
- (+) AlarmAEventCallback_S : RTC Alarm A Event callback secure.
- (+) AlarmBEventCallback_S : RTC Alarm B Event callback secure.
- (+) TimeStampEventCallback_S : RTC TimeStamp Event callback secure.
- (+) WakeUpTimerEventCallback_S : RTC WakeUpTimer Event callback secure.
- (+) Tamper1EventCallback_S : RTC Tamper 1 Event callback secure.
- (+) Tamper2EventCallback_S : RTC Tamper 2 Event callback secure.
- (+) Tamper3EventCallback_S : RTC Tamper 3 Event callback secure.
- (+) Tamper4EventCallback_S : RTC Tamper 4 Event callback secure.
- (+) Tamper5EventCallback_S : RTC Tamper 5 Event callback secure.
- (+) Tamper6EventCallback_S : RTC Tamper 6 Event callback secure.
- (+) Tamper7EventCallback_S : RTC Tamper 7 Event callback secure.
- (+) Tamper8EventCallback_S : RTC Tamper 8 Event callback secure.
- (+) InternalTamper1EventCallback_S : RTC Internal Tamper 1 Event callback secure.
- (+) InternalTamper2EventCallback_S : RTC Internal Tamper 2 Event callback secure.
- (+) InternalTamper3EventCallback_S : RTC Internal Tamper 3 Event callback secure.
- (+) InternalTamper4EventCallback_S : RTC Internal Tamper 4 Event callback secure.
- (+) InternalTamper5EventCallback_S : RTC Internal Tamper 5 Event callback secure.
- (+) InternalTamper6EventCallback_S : RTC Internal Tamper 6 Event callback secure.
- (+) InternalTamper8EventCallback_S : RTC Internal Tamper 8 Event callback secure.
- #endif
- (+) MspInitCallback : RTC MspInit callback.
- (+) MspDeInitCallback : RTC MspDeInit callback.
- [..]
- By default, after the HAL_RTC_Init() and when the state is HAL_RTC_STATE_RESET,
- all callbacks are set to the corresponding weak functions :
- examples AlarmAEventCallback(), TimeStampEventCallback().
- Exception done for MspInit and MspDeInit callbacks that are reset to the legacy weak function
- in the HAL_RTC_Init()/HAL_RTC_DeInit() only when these callbacks are null
- (not registered beforehand).
- If not, MspInit or MspDeInit are not null, HAL_RTC_Init()/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 HAL_RTC_RegisterCallback() before calling HAL_RTC_DeInit()
- or 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.
- @endverbatim
- ******************************************************************************
- */
- /* Includes ------------------------------------------------------------------*/
- #include "stm32g4xx_hal.h"
- /** @addtogroup STM32G4xx_HAL_Driver
- * @{
- */
- /** @addtogroup RTC
- * @brief RTC HAL module driver
- * @{
- */
- #ifdef HAL_RTC_MODULE_ENABLED
- /* Private typedef -----------------------------------------------------------*/
- /* Private define ------------------------------------------------------------*/
- /* Private macro -------------------------------------------------------------*/
- /* Private variables ---------------------------------------------------------*/
- /* Private function prototypes -----------------------------------------------*/
- /* Exported functions --------------------------------------------------------*/
- /** @addtogroup RTC_Exported_Functions
- * @{
- */
- /** @addtogroup RTC_Exported_Functions_Group1
- * @brief Initialization and Configuration functions
- *
- @verbatim
- ===============================================================================
- ##### Initialization and de-initialization functions #####
- ===============================================================================
- [..] This section provides functions allowing to initialize and configure the
- RTC Prescaler (Synchronous and Asynchronous), RTC Hour format, disable
- RTC registers Write protection, enter and exit the RTC initialization mode,
- RTC registers synchronization check and reference clock detection enable.
- (#) The RTC Prescaler is programmed to generate the RTC 1Hz time base.
- It is split into 2 programmable prescalers to minimize power consumption.
- (++) A 7-bit asynchronous prescaler and a 15-bit synchronous prescaler.
- (++) When both prescalers are used, it is recommended to configure the
- asynchronous prescaler to a high value to minimize power consumption.
- (#) All RTC registers are Write protected. Writing to the RTC registers
- is enabled by writing a key into the Write Protection register, RTC_WPR.
- (#) To configure the RTC Calendar, user application should enter
- initialization mode. In this mode, the calendar counter is stopped
- and its value can be updated. When the initialization sequence is
- complete, the calendar restarts counting after 4 RTCCLK cycles.
- (#) To read the calendar through the shadow registers after Calendar
- initialization, calendar update or after wakeup from low power modes
- the software must first clear the RSF flag. The software must then
- wait until it is set again before reading the calendar, which means
- that the calendar registers have been correctly copied into the
- RTC_TR and RTC_DR shadow registers.The HAL_RTC_WaitForSynchro() function
- implements the above software sequence (RSF clear and RSF check).
- @endverbatim
- * @{
- */
- /**
- * @brief Initialize the RTC peripheral
- * @param hrtc RTC handle
- * @retval HAL status
- */
- HAL_StatusTypeDef HAL_RTC_Init(RTC_HandleTypeDef *hrtc)
- {
- HAL_StatusTypeDef status = HAL_ERROR;
- /* Check the RTC peripheral state */
- if (hrtc != NULL)
- {
- /* Check the parameters */
- assert_param(IS_RTC_HOUR_FORMAT(hrtc->Init.HourFormat));
- assert_param(IS_RTC_ASYNCH_PREDIV(hrtc->Init.AsynchPrediv));
- assert_param(IS_RTC_SYNCH_PREDIV(hrtc->Init.SynchPrediv));
- assert_param(IS_RTC_OUTPUT(hrtc->Init.OutPut));
- assert_param(IS_RTC_OUTPUT_REMAP(hrtc->Init.OutPutRemap));
- assert_param(IS_RTC_OUTPUT_POL(hrtc->Init.OutPutPolarity));
- assert_param(IS_RTC_OUTPUT_TYPE(hrtc->Init.OutPutType));
- assert_param(IS_RTC_OUTPUT_PULLUP(hrtc->Init.OutPutPullUp));
- #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->AlarmBEventCallback = HAL_RTCEx_AlarmBEventCallback; /* Legacy weak AlarmBEventCallback */
- hrtc->TimeStampEventCallback = HAL_RTCEx_TimeStampEventCallback; /* Legacy weak TimeStampEventCallback */
- hrtc->WakeUpTimerEventCallback = HAL_RTCEx_WakeUpTimerEventCallback; /* Legacy weak WakeUpTimerEventCallback */
- hrtc->Tamper1EventCallback = HAL_RTCEx_Tamper1EventCallback; /* Legacy weak Tamper1EventCallback */
- hrtc->Tamper2EventCallback = HAL_RTCEx_Tamper2EventCallback; /* Legacy weak Tamper2EventCallback */
- #if (RTC_TAMP_NB == 3)
- hrtc->Tamper3EventCallback = HAL_RTCEx_Tamper3EventCallback; /* Legacy weak Tamper3EventCallback */
- #endif /* RTC_TAMP_NB */
- #ifdef RTC_TAMP_INT_1_SUPPORT
- hrtc->InternalTamper1EventCallback = HAL_RTCEx_InternalTamper1EventCallback; /*!< Legacy weak InternalTamper1EventCallback */
- #endif /* RTC_TAMP_INT_1_SUPPORT */
- #ifdef RTC_TAMP_INT_2_SUPPORT
- hrtc->InternalTamper2EventCallback = HAL_RTCEx_InternalTamper2EventCallback; /*!< Legacy weak InternalTamper2EventCallback */
- #endif /* RTC_TAMP_INT_2_SUPPORT */
- hrtc->InternalTamper3EventCallback = HAL_RTCEx_InternalTamper3EventCallback; /*!< Legacy weak InternalTamper3EventCallback */
- hrtc->InternalTamper4EventCallback = HAL_RTCEx_InternalTamper4EventCallback; /*!< Legacy weak InternalTamper4EventCallback */
- hrtc->InternalTamper5EventCallback = HAL_RTCEx_InternalTamper5EventCallback; /*!< Legacy weak InternalTamper5EventCallback */
- #ifdef RTC_TAMP_INT_6_SUPPORT
- hrtc->InternalTamper6EventCallback = HAL_RTCEx_InternalTamper6EventCallback; /*!< Legacy weak InternalTamper6EventCallback */
- #endif /* RTC_TAMP_INT_6_SUPPORT */
- #ifdef RTC_TAMP_INT_7_SUPPORT
- hrtc->InternalTamper7EventCallback = HAL_RTCEx_InternalTamper7EventCallback; /*!< Legacy weak InternalTamper7EventCallback */
- #endif /* RTC_TAMP_INT_7_SUPPORT */
- 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)
- {
- /* Allocate lock resource and initialize it */
- hrtc->Lock = HAL_UNLOCKED;
- /* Initialize RTC MSP */
- HAL_RTC_MspInit(hrtc);
- }
- #endif /* (USE_HAL_RTC_REGISTER_CALLBACKS) */
- /* Set RTC state */
- hrtc->State = HAL_RTC_STATE_BUSY;
- /* Check whether the calendar needs to be initialized */
- if (__HAL_RTC_IS_CALENDAR_INITIALIZED(hrtc) == 0U)
- {
- /* Disable the write protection for RTC registers */
- __HAL_RTC_WRITEPROTECTION_DISABLE(hrtc);
- /* Enter Initialization mode */
- status = RTC_EnterInitMode(hrtc);
- if (status == HAL_OK)
- {
- /* Clear RTC_CR FMT, OSEL and POL Bits */
- CLEAR_BIT(hrtc->Instance->CR, (RTC_CR_FMT | RTC_CR_POL | RTC_CR_OSEL | RTC_CR_TAMPOE));
- /* Set RTC_CR register */
- SET_BIT(hrtc->Instance->CR, (hrtc->Init.HourFormat | hrtc->Init.OutPut | hrtc->Init.OutPutPolarity));
- /* Configure the RTC PRER */
- WRITE_REG(hrtc->Instance->PRER, ((hrtc->Init.SynchPrediv) | (hrtc->Init.AsynchPrediv << RTC_PRER_PREDIV_A_Pos)));
- /* Exit Initialization mode */
- status = RTC_ExitInitMode(hrtc);
- }
- if (status == HAL_OK)
- {
- MODIFY_REG(hrtc->Instance->CR, \
- RTC_CR_TAMPALRM_PU | RTC_CR_TAMPALRM_TYPE | RTC_CR_OUT2EN, \
- hrtc->Init.OutPutPullUp | hrtc->Init.OutPutType | hrtc->Init.OutPutRemap);
- }
- /* Enable the write protection for RTC registers */
- __HAL_RTC_WRITEPROTECTION_ENABLE(hrtc);
- }
- else
- {
- /* The calendar is already initialized */
- status = HAL_OK;
- }
- if (status == HAL_OK)
- {
- hrtc->State = HAL_RTC_STATE_READY;
- }
- }
- return status;
- }
- /**
- * @brief DeInitialize the RTC peripheral.
- * @note This function does not reset the RTC Backup Data registers.
- * @param hrtc RTC handle
- * @retval HAL status
- */
- HAL_StatusTypeDef HAL_RTC_DeInit(RTC_HandleTypeDef *hrtc)
- {
- HAL_StatusTypeDef status;
- /* Set RTC state */
- hrtc->State = HAL_RTC_STATE_BUSY;
- /* Disable the write protection for RTC registers */
- __HAL_RTC_WRITEPROTECTION_DISABLE(hrtc);
- status = RTC_EnterInitMode(hrtc);
- /* Set Initialization mode */
- if (status != HAL_OK)
- {
- /* Set RTC state */
- hrtc->State = HAL_RTC_STATE_ERROR;
- }
- else
- {
- /* Reset all RTC CR register bits */
- CLEAR_REG(hrtc->Instance->CR);
- WRITE_REG(hrtc->Instance->DR, (uint32_t)(RTC_DR_WDU_0 | RTC_DR_MU_0 | RTC_DR_DU_0));
- CLEAR_REG(hrtc->Instance->TR);
- WRITE_REG(hrtc->Instance->WUTR, RTC_WUTR_WUT);
- WRITE_REG(hrtc->Instance->PRER, ((uint32_t)(RTC_PRER_PREDIV_A | 0xFFU)));
- CLEAR_REG(hrtc->Instance->ALRMAR);
- CLEAR_REG(hrtc->Instance->ALRMBR);
- CLEAR_REG(hrtc->Instance->SHIFTR);
- CLEAR_REG(hrtc->Instance->CALR);
- CLEAR_REG(hrtc->Instance->ALRMASSR);
- CLEAR_REG(hrtc->Instance->ALRMBSSR);
- WRITE_REG(hrtc->Instance->SCR, RTC_SCR_CITSF | RTC_SCR_CTSOVF | RTC_SCR_CTSF | RTC_SCR_CWUTF | RTC_SCR_CALRBF | RTC_SCR_CALRAF);
- /* Exit initialization mode */
- CLEAR_BIT(hrtc->Instance->ICSR, RTC_ICSR_INIT);
- status = HAL_RTC_WaitForSynchro(hrtc);
- if (status != HAL_OK)
- {
- hrtc->State = HAL_RTC_STATE_ERROR;
- }
- else
- {
- /* Reset TAMP registers */
- WRITE_REG(TAMP->CR1, RTC_INT_TAMPER_ALL);
- CLEAR_REG(TAMP->CR2);
- CLEAR_REG(TAMP->FLTCR);
- }
- }
- /* Enable the write protection for RTC registers */
- __HAL_RTC_WRITEPROTECTION_ENABLE(hrtc);
- if (status == HAL_OK)
- {
- #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
- /* De-Initialize RTC MSP */
- HAL_RTC_MspDeInit(hrtc);
- #endif /* (USE_HAL_RTC_REGISTER_CALLBACKS) */
- hrtc->State = HAL_RTC_STATE_RESET;
- }
- /* Release Lock */
- __HAL_UNLOCK(hrtc);
- return status;
- }
- #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_ALARM_B_EVENT_CB_ID Alarm B Event Callback ID
- * @arg @ref HAL_RTC_TIMESTAMP_EVENT_CB_ID TimeStamp Event Callback ID
- * @arg @ref HAL_RTC_WAKEUPTIMER_EVENT_CB_ID WakeUp Timer Event Callback ID
- * @arg @ref HAL_RTC_TAMPER1_EVENT_CB_ID Tamper 1 Callback ID
- * @arg @ref HAL_RTC_TAMPER2_EVENT_CB_ID Tamper 2 Callback ID
- * @arg @ref HAL_RTC_TAMPER3_EVENT_CB_ID Tamper 3 Callback ID
- * @arg @ref HAL_RTC_INTERNAL_TAMPER1_EVENT_CB_ID Internal Tamper 1 Callback ID
- * @arg @ref HAL_RTC_INTERNAL_TAMPER2_EVENT_CB_ID Internal Tamper 2 Callback ID
- * @arg @ref HAL_RTC_INTERNAL_TAMPER3_EVENT_CB_ID Internal Tamper 3 Callback ID
- * @arg @ref HAL_RTC_INTERNAL_TAMPER4_EVENT_CB_ID Internal Tamper 4 Callback ID
- * @arg @ref HAL_RTC_INTERNAL_TAMPER5_EVENT_CB_ID Internal Tamper 5 Callback ID
- * @arg @ref HAL_RTC_INTERNAL_TAMPER6_EVENT_CB_ID Internal Tamper 6 Callback ID
- * @arg @ref HAL_RTC_INTERNAL_TAMPER7_EVENT_CB_ID Internal Tamper 7 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_ALARM_B_EVENT_CB_ID :
- hrtc->AlarmBEventCallback = pCallback;
- break;
- case HAL_RTC_TIMESTAMP_EVENT_CB_ID :
- hrtc->TimeStampEventCallback = pCallback;
- break;
- case HAL_RTC_WAKEUPTIMER_EVENT_CB_ID :
- hrtc->WakeUpTimerEventCallback = pCallback;
- break;
- case HAL_RTC_TAMPER1_EVENT_CB_ID :
- hrtc->Tamper1EventCallback = pCallback;
- break;
- case HAL_RTC_TAMPER2_EVENT_CB_ID :
- hrtc->Tamper2EventCallback = pCallback;
- break;
- #if (RTC_TAMP_NB == 3)
- case HAL_RTC_TAMPER3_EVENT_CB_ID :
- hrtc->Tamper3EventCallback = pCallback;
- break;
- #endif /* RTC_TAMP_NB */
- #ifdef RTC_TAMP_INT_1_SUPPORT
- case HAL_RTC_INTERNAL_TAMPER1_EVENT_CB_ID :
- hrtc->InternalTamper1EventCallback = pCallback;
- break;
- #endif /* RTC_TAMP_INT_1_SUPPORT */
- #ifdef RTC_TAMP_INT_2_SUPPORT
- case HAL_RTC_INTERNAL_TAMPER2_EVENT_CB_ID :
- hrtc->InternalTamper2EventCallback = pCallback;
- break;
- #endif /* RTC_TAMP_INT_2_SUPPORT */
- case HAL_RTC_INTERNAL_TAMPER3_EVENT_CB_ID :
- hrtc->InternalTamper3EventCallback = pCallback;
- break;
- case HAL_RTC_INTERNAL_TAMPER4_EVENT_CB_ID :
- hrtc->InternalTamper4EventCallback = pCallback;
- break;
- case HAL_RTC_INTERNAL_TAMPER5_EVENT_CB_ID :
- hrtc->InternalTamper5EventCallback = pCallback;
- break;
- #ifdef RTC_TAMP_INT_6_SUPPORT
- case HAL_RTC_INTERNAL_TAMPER6_EVENT_CB_ID :
- hrtc->InternalTamper6EventCallback = pCallback;
- break;
- #endif /* RTC_TAMP_INT_6_SUPPORT */
- #ifdef RTC_TAMP_INT_7_SUPPORT
- case HAL_RTC_INTERNAL_TAMPER7_EVENT_CB_ID :
- hrtc->InternalTamper7EventCallback = pCallback;
- break;
- #endif /* RTC_TAMP_INT_7_SUPPORT */
- 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 callback 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_ALARM_B_EVENT_CB_ID Alarm B Event Callback ID
- * @arg @ref HAL_RTC_TIMESTAMP_EVENT_CB_ID TimeStamp Event Callback ID
- * @arg @ref HAL_RTC_WAKEUPTIMER_EVENT_CB_ID WakeUp Timer Event Callback ID
- * @arg @ref HAL_RTC_TAMPER1_EVENT_CB_ID Tamper 1 Callback ID
- * @arg @ref HAL_RTC_TAMPER2_EVENT_CB_ID Tamper 2 Callback ID
- * @arg @ref HAL_RTC_TAMPER3_EVENT_CB_ID Tamper 3 Callback ID
- * @arg @ref HAL_RTC_INTERNAL_TAMPER1_EVENT_CB_ID Internal Tamper 1 Callback ID
- * @arg @ref HAL_RTC_INTERNAL_TAMPER2_EVENT_CB_ID Internal Tamper 2 Callback ID
- * @arg @ref HAL_RTC_INTERNAL_TAMPER3_EVENT_CB_ID Internal Tamper 3 Callback ID
- * @arg @ref HAL_RTC_INTERNAL_TAMPER4_EVENT_CB_ID Internal Tamper 4 Callback ID
- * @arg @ref HAL_RTC_INTERNAL_TAMPER5_EVENT_CB_ID Internal Tamper 5 Callback ID
- * @arg @ref HAL_RTC_INTERNAL_TAMPER6_EVENT_CB_ID Internal Tamper 6 Callback ID
- * @arg @ref HAL_RTC_INTERNAL_TAMPER7_EVENT_CB_ID Internal Tamper 7 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_ALARM_B_EVENT_CB_ID :
- hrtc->AlarmBEventCallback = HAL_RTCEx_AlarmBEventCallback; /* Legacy weak AlarmBEventCallback */
- break;
- case HAL_RTC_TIMESTAMP_EVENT_CB_ID :
- hrtc->TimeStampEventCallback = HAL_RTCEx_TimeStampEventCallback; /* Legacy weak TimeStampEventCallback */
- break;
- case HAL_RTC_WAKEUPTIMER_EVENT_CB_ID :
- hrtc->WakeUpTimerEventCallback = HAL_RTCEx_WakeUpTimerEventCallback; /* Legacy weak WakeUpTimerEventCallback */
- break;
- case HAL_RTC_TAMPER1_EVENT_CB_ID :
- hrtc->Tamper1EventCallback = HAL_RTCEx_Tamper1EventCallback; /* Legacy weak Tamper1EventCallback */
- break;
- case HAL_RTC_TAMPER2_EVENT_CB_ID :
- hrtc->Tamper2EventCallback = HAL_RTCEx_Tamper2EventCallback; /* Legacy weak Tamper2EventCallback */
- break;
- #if (RTC_TAMP_NB == 3)
- case HAL_RTC_TAMPER3_EVENT_CB_ID :
- hrtc->Tamper3EventCallback = HAL_RTCEx_Tamper3EventCallback; /* Legacy weak Tamper3EventCallback */
- break;
- #endif /* RTC_TAMP_NB */
- #ifdef RTC_TAMP_INT_1_SUPPORT
- case HAL_RTC_INTERNAL_TAMPER1_EVENT_CB_ID :
- hrtc->InternalTamper1EventCallback = HAL_RTCEx_InternalTamper1EventCallback; /* Legacy weak InternalTamper1EventCallback */
- break;
- #endif /* RTC_TAMP_INT_1_SUPPORT */
- #ifdef RTC_TAMP_INT_2_SUPPORT
- case HAL_RTC_INTERNAL_TAMPER2_EVENT_CB_ID :
- hrtc->InternalTamper2EventCallback = HAL_RTCEx_InternalTamper2EventCallback; /* Legacy weak InternalTamper2EventCallback */
- break;
- #endif /* RTC_TAMP_INT_2_SUPPORT */
- case HAL_RTC_INTERNAL_TAMPER3_EVENT_CB_ID :
- hrtc->InternalTamper3EventCallback = HAL_RTCEx_InternalTamper3EventCallback; /* Legacy weak InternalTamper3EventCallback */
- break;
- case HAL_RTC_INTERNAL_TAMPER4_EVENT_CB_ID :
- hrtc->InternalTamper4EventCallback = HAL_RTCEx_InternalTamper4EventCallback; /* Legacy weak InternalTamper4EventCallback */
- break;
- case HAL_RTC_INTERNAL_TAMPER5_EVENT_CB_ID :
- hrtc->InternalTamper5EventCallback = HAL_RTCEx_InternalTamper5EventCallback; /* Legacy weak InternalTamper5EventCallback */
- break;
- #ifdef RTC_TAMP_INT_6_SUPPORT
- case HAL_RTC_INTERNAL_TAMPER6_EVENT_CB_ID :
- hrtc->InternalTamper6EventCallback = HAL_RTCEx_InternalTamper6EventCallback; /* Legacy weak InternalTamper6EventCallback */
- break;
- #endif /* RTC_TAMP_INT_6_SUPPORT */
- #ifdef RTC_TAMP_INT_7_SUPPORT
- case HAL_RTC_INTERNAL_TAMPER7_EVENT_CB_ID :
- hrtc->InternalTamper7EventCallback = HAL_RTCEx_InternalTamper7EventCallback; /* Legacy weak InternalTamper7EventCallback */
- break;
- #endif /* RTC_TAMP_INT_7_SUPPORT */
- 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 */
- /**
- * @brief Initialize the RTC MSP.
- * @param hrtc RTC handle
- * @retval None
- */
- __weak void HAL_RTC_MspInit(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_MspInit could be implemented in the user file
- */
- }
- /**
- * @brief DeInitialize the RTC MSP.
- * @param hrtc RTC handle
- * @retval None
- */
- __weak void HAL_RTC_MspDeInit(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_MspDeInit could be implemented in the user file
- */
- }
- /**
- * @}
- */
- /** @addtogroup RTC_Exported_Functions_Group2
- * @brief RTC Time and Date functions
- *
- @verbatim
- ===============================================================================
- ##### RTC Time and Date functions #####
- ===============================================================================
- [..] This section provides functions allowing to configure Time and Date features
- @endverbatim
- * @{
- */
- /**
- * @brief Set RTC current time.
- * @param hrtc RTC handle
- * @param sTime Pointer to Time 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_RTC_SetTime(RTC_HandleTypeDef *hrtc, RTC_TimeTypeDef *sTime, uint32_t Format)
- {
- uint32_t tmpreg;
- HAL_StatusTypeDef status;
- /* Check the parameters */
- assert_param(IS_RTC_FORMAT(Format));
- assert_param(IS_RTC_DAYLIGHT_SAVING(sTime->DayLightSaving));
- assert_param(IS_RTC_STORE_OPERATION(sTime->StoreOperation));
- /* Process Locked */
- __HAL_LOCK(hrtc);
- hrtc->State = HAL_RTC_STATE_BUSY;
- /* Disable the write protection for RTC registers */
- __HAL_RTC_WRITEPROTECTION_DISABLE(hrtc);
- /* Enter Initialization mode */
- status = RTC_EnterInitMode(hrtc);
- if (status == HAL_OK)
- {
- if (Format == RTC_FORMAT_BIN)
- {
- if (READ_BIT(hrtc->Instance->CR, RTC_CR_FMT) != 0U)
- {
- assert_param(IS_RTC_HOUR12(sTime->Hours));
- assert_param(IS_RTC_HOURFORMAT12(sTime->TimeFormat));
- }
- else
- {
- sTime->TimeFormat = 0x00U;
- assert_param(IS_RTC_HOUR24(sTime->Hours));
- }
- assert_param(IS_RTC_MINUTES(sTime->Minutes));
- assert_param(IS_RTC_SECONDS(sTime->Seconds));
- tmpreg = (uint32_t)(((uint32_t)RTC_ByteToBcd2(sTime->Hours) << RTC_TR_HU_Pos) | \
- ((uint32_t)RTC_ByteToBcd2(sTime->Minutes) << RTC_TR_MNU_Pos) | \
- ((uint32_t)RTC_ByteToBcd2(sTime->Seconds) << RTC_TR_SU_Pos) | \
- (((uint32_t)sTime->TimeFormat) << RTC_TR_PM_Pos));
- }
- else
- {
- if (READ_BIT(hrtc->Instance->CR, RTC_CR_FMT) != 0U)
- {
- assert_param(IS_RTC_HOUR12(RTC_Bcd2ToByte(sTime->Hours)));
- assert_param(IS_RTC_HOURFORMAT12(sTime->TimeFormat));
- }
- else
- {
- sTime->TimeFormat = 0x00U;
- 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)));
- tmpreg = (((uint32_t)(sTime->Hours) << RTC_TR_HU_Pos) | \
- ((uint32_t)(sTime->Minutes) << RTC_TR_MNU_Pos) | \
- ((uint32_t)(sTime->Seconds) << RTC_TR_SU_Pos) | \
- ((uint32_t)(sTime->TimeFormat) << RTC_TR_PM_Pos));
- }
- /* Set the RTC_TR register */
- WRITE_REG(hrtc->Instance->TR, (tmpreg & RTC_TR_RESERVED_MASK));
- /* This interface is deprecated. To manage Daylight Saving Time, please use HAL_RTC_DST_xxx functions */
- CLEAR_BIT(hrtc->Instance->CR, RTC_CR_BKP);
- /* This interface is deprecated. To manage Daylight Saving Time, please use HAL_RTC_DST_xxx functions */
- SET_BIT(hrtc->Instance->CR, (sTime->DayLightSaving | sTime->StoreOperation));
- /* Exit Initialization mode */
- status = RTC_ExitInitMode(hrtc);
- }
- /* Enable the write protection for RTC registers */
- __HAL_RTC_WRITEPROTECTION_ENABLE(hrtc);
- if (status == HAL_OK)
- {
- hrtc->State = HAL_RTC_STATE_READY;
- }
- __HAL_UNLOCK(hrtc);
- return status;
- }
- /**
- * @brief Get RTC current time.
- * @note You can use SubSeconds and SecondFraction (sTime structure fields returned) to convert SubSeconds
- * value in second fraction ratio with time unit following generic formula:
- * Second fraction ratio * time_unit= [(SecondFraction-SubSeconds)/(SecondFraction+1)] * time_unit
- * This conversion can be performed only if no shift operation is pending (ie. SHFP=0) when PREDIV_S >= SS
- * @note You must call HAL_RTC_GetDate() after HAL_RTC_GetTime() to unlock the values
- * in the higher-order calendar shadow registers to ensure consistency between the time and date values.
- * Reading RTC current time locks the values in calendar shadow registers until Current date is read
- * to ensure consistency between the time and date values.
- * @param hrtc RTC handle
- * @param sTime Pointer to Time structure with Hours, Minutes and Seconds fields returned
- * with input format (BIN or BCD), also SubSeconds field returning the
- * RTC_SSR register content and SecondFraction field the Synchronous pre-scaler
- * factor to be used for second fraction ratio computation.
- * @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_RTC_GetTime(RTC_HandleTypeDef *hrtc, RTC_TimeTypeDef *sTime, uint32_t Format)
- {
- uint32_t tmpreg;
- /* Check the parameters */
- assert_param(IS_RTC_FORMAT(Format));
- /* Get subseconds structure field from the corresponding register*/
- sTime->SubSeconds = READ_REG(hrtc->Instance->SSR);
- /* Get SecondFraction structure field from the corresponding register field*/
- sTime->SecondFraction = (uint32_t)(READ_REG(hrtc->Instance->PRER) & RTC_PRER_PREDIV_S);
- /* Get the TR register */
- tmpreg = (uint32_t)(READ_REG(hrtc->Instance->TR) & RTC_TR_RESERVED_MASK);
- /* Fill the structure fields with the read parameters */
- sTime->Hours = (uint8_t)((tmpreg & (RTC_TR_HT | RTC_TR_HU)) >> RTC_TR_HU_Pos);
- sTime->Minutes = (uint8_t)((tmpreg & (RTC_TR_MNT | RTC_TR_MNU)) >> RTC_TR_MNU_Pos);
- sTime->Seconds = (uint8_t)((tmpreg & (RTC_TR_ST | RTC_TR_SU)) >> RTC_TR_SU_Pos);
- sTime->TimeFormat = (uint8_t)((tmpreg & (RTC_TR_PM)) >> RTC_TR_PM_Pos);
- /* Check the input parameters format */
- if (Format == RTC_FORMAT_BIN)
- {
- /* Convert the time structure parameters to Binary format */
- sTime->Hours = (uint8_t)RTC_Bcd2ToByte(sTime->Hours);
- sTime->Minutes = (uint8_t)RTC_Bcd2ToByte(sTime->Minutes);
- sTime->Seconds = (uint8_t)RTC_Bcd2ToByte(sTime->Seconds);
- }
- return HAL_OK;
- }
- /**
- * @brief Set RTC current date.
- * @param hrtc RTC handle
- * @param sDate 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_RTC_SetDate(RTC_HandleTypeDef *hrtc, RTC_DateTypeDef *sDate, uint32_t Format)
- {
- uint32_t datetmpreg;
- HAL_StatusTypeDef status;
- /* Check the parameters */
- assert_param(IS_RTC_FORMAT(Format));
- /* Process Locked */
- __HAL_LOCK(hrtc);
- hrtc->State = HAL_RTC_STATE_BUSY;
- if ((Format == RTC_FORMAT_BIN) && ((sDate->Month & 0x10U) == 0x10U))
- {
- sDate->Month = (uint8_t)((sDate->Month & (uint8_t)~(0x10U)) + (uint8_t)0x0AU);
- }
- assert_param(IS_RTC_WEEKDAY(sDate->WeekDay));
- if (Format == RTC_FORMAT_BIN)
- {
- assert_param(IS_RTC_YEAR(sDate->Year));
- assert_param(IS_RTC_MONTH(sDate->Month));
- assert_param(IS_RTC_DATE(sDate->Date));
- datetmpreg = (((uint32_t)RTC_ByteToBcd2(sDate->Year) << RTC_DR_YU_Pos) | \
- ((uint32_t)RTC_ByteToBcd2(sDate->Month) << RTC_DR_MU_Pos) | \
- ((uint32_t)RTC_ByteToBcd2(sDate->Date) << RTC_DR_DU_Pos) | \
- ((uint32_t)sDate->WeekDay << RTC_DR_WDU_Pos));
- }
- else
- {
- 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)));
- datetmpreg = ((((uint32_t)sDate->Year) << RTC_DR_YU_Pos) | \
- (((uint32_t)sDate->Month) << RTC_DR_MU_Pos) | \
- (((uint32_t)sDate->Date) << RTC_DR_DU_Pos) | \
- (((uint32_t)sDate->WeekDay) << RTC_DR_WDU_Pos));
- }
- /* Disable the write protection for RTC registers */
- __HAL_RTC_WRITEPROTECTION_DISABLE(hrtc);
- /* Enter Initialization mode */
- status = RTC_EnterInitMode(hrtc);
- if (status == HAL_OK)
- {
- /* Set the RTC_DR register */
- WRITE_REG(hrtc->Instance->DR, (uint32_t)(datetmpreg & RTC_DR_RESERVED_MASK));
- /* Exit Initialization mode */
- status = RTC_ExitInitMode(hrtc);
- }
-
- /* Enable the write protection for RTC registers */
- __HAL_RTC_WRITEPROTECTION_ENABLE(hrtc);
-
- if (status == HAL_OK)
- {
- hrtc->State = HAL_RTC_STATE_READY ;
- }
- /* Process Unlocked */
- __HAL_UNLOCK(hrtc);
- return status;
- }
- /**
- * @brief Get RTC current date.
- * @note You must call HAL_RTC_GetDate() after HAL_RTC_GetTime() to unlock the values
- * in the higher-order calendar shadow registers to ensure consistency between the time and date values.
- * Reading RTC current time locks the values in calendar shadow registers until Current date is read.
- * @param hrtc RTC handle
- * @param sDate 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_RTC_GetDate(RTC_HandleTypeDef *hrtc, RTC_DateTypeDef *sDate, uint32_t Format)
- {
- uint32_t datetmpreg;
- /* Check the parameters */
- assert_param(IS_RTC_FORMAT(Format));
- /* Get the DR register */
- datetmpreg = (uint32_t)(READ_REG(hrtc->Instance->DR) & RTC_DR_RESERVED_MASK);
- /* Fill the structure fields with the read parameters */
- sDate->Year = (uint8_t)((datetmpreg & (RTC_DR_YT | RTC_DR_YU)) >> RTC_DR_YU_Pos);
- sDate->Month = (uint8_t)((datetmpreg & (RTC_DR_MT | RTC_DR_MU)) >> RTC_DR_MU_Pos);
- sDate->Date = (uint8_t)((datetmpreg & (RTC_DR_DT | RTC_DR_DU)) >> RTC_DR_DU_Pos);
- sDate->WeekDay = (uint8_t)((datetmpreg & (RTC_DR_WDU)) >> RTC_DR_WDU_Pos);
- /* Check the input parameters format */
- if (Format == RTC_FORMAT_BIN)
- {
- /* Convert the date structure parameters to Binary format */
- sDate->Year = (uint8_t)RTC_Bcd2ToByte(sDate->Year);
- sDate->Month = (uint8_t)RTC_Bcd2ToByte(sDate->Month);
- sDate->Date = (uint8_t)RTC_Bcd2ToByte(sDate->Date);
- }
- return HAL_OK;
- }
- /**
- * @}
- */
- /** @addtogroup RTC_Exported_Functions_Group3
- * @brief RTC Alarm functions
- *
- @verbatim
- ===============================================================================
- ##### RTC Alarm functions #####
- ===============================================================================
- [..] This section provides functions allowing to configure Alarm feature
- @endverbatim
- * @{
- */
- /**
- * @brief Set the specified RTC Alarm.
- * @param hrtc RTC handle
- * @param sAlarm Pointer to Alarm 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_RTC_SetAlarm(RTC_HandleTypeDef *hrtc, RTC_AlarmTypeDef *sAlarm, uint32_t Format)
- {
- uint32_t tickstart;
- uint32_t tmpreg;
- uint32_t subsecondtmpreg;
- /* Check the parameters */
- assert_param(IS_RTC_FORMAT(Format));
- assert_param(IS_RTC_ALARM(sAlarm->Alarm));
- assert_param(IS_RTC_ALARM_MASK(sAlarm->AlarmMask));
- assert_param(IS_RTC_ALARM_DATE_WEEKDAY_SEL(sAlarm->AlarmDateWeekDaySel));
- assert_param(IS_RTC_ALARM_SUB_SECOND_VALUE(sAlarm->AlarmTime.SubSeconds));
- assert_param(IS_RTC_ALARM_SUB_SECOND_MASK(sAlarm->AlarmSubSecondMask));
- /* Process Locked */
- __HAL_LOCK(hrtc);
- hrtc->State = HAL_RTC_STATE_BUSY;
- if (Format == RTC_FORMAT_BIN)
- {
- if (READ_BIT(hrtc->Instance->CR, RTC_CR_FMT) != 0U)
- {
- assert_param(IS_RTC_HOUR12(sAlarm->AlarmTime.Hours));
- assert_param(IS_RTC_HOURFORMAT12(sAlarm->AlarmTime.TimeFormat));
- }
- else
- {
- sAlarm->AlarmTime.TimeFormat = 0x00U;
- assert_param(IS_RTC_HOUR24(sAlarm->AlarmTime.Hours));
- }
- assert_param(IS_RTC_MINUTES(sAlarm->AlarmTime.Minutes));
- assert_param(IS_RTC_SECONDS(sAlarm->AlarmTime.Seconds));
- #ifdef USE_FULL_ASSERT
- if (sAlarm->AlarmDateWeekDaySel == RTC_ALARMDATEWEEKDAYSEL_DATE)
- {
- assert_param(IS_RTC_ALARM_DATE_WEEKDAY_DATE(sAlarm->AlarmDateWeekDay));
- }
- else
- {
- assert_param(IS_RTC_ALARM_DATE_WEEKDAY_WEEKDAY(sAlarm->AlarmDateWeekDay));
- }
- #endif /* USE_FULL_ASSERT*/
- tmpreg = (((uint32_t)RTC_ByteToBcd2(sAlarm->AlarmTime.Hours) << RTC_ALRMAR_HU_Pos) | \
- ((uint32_t)RTC_ByteToBcd2(sAlarm->AlarmTime.Minutes) << RTC_ALRMAR_MNU_Pos) | \
- ((uint32_t)RTC_ByteToBcd2(sAlarm->AlarmTime.Seconds) << RTC_ALRMAR_SU_Pos) | \
- ((uint32_t)(sAlarm->AlarmTime.TimeFormat) << RTC_ALRMAR_PM_Pos) | \
- ((uint32_t)RTC_ByteToBcd2(sAlarm->AlarmDateWeekDay) << RTC_ALRMAR_DU_Pos) | \
- ((uint32_t)sAlarm->AlarmDateWeekDaySel) | \
- ((uint32_t)sAlarm->AlarmMask));
- }
- else /* Format BCD */
- {
- if (READ_BIT(hrtc->Instance->CR, RTC_CR_FMT) != 0U)
- {
- assert_param(IS_RTC_HOUR12(RTC_Bcd2ToByte(sAlarm->AlarmTime.Hours)));
- assert_param(IS_RTC_HOURFORMAT12(sAlarm->AlarmTime.TimeFormat));
- }
- else
- {
- sAlarm->AlarmTime.TimeFormat = 0x00U;
- 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)));
- #ifdef USE_FULL_ASSERT
- if (sAlarm->AlarmDateWeekDaySel == RTC_ALARMDATEWEEKDAYSEL_DATE)
- {
- assert_param(IS_RTC_ALARM_DATE_WEEKDAY_DATE(RTC_Bcd2ToByte(sAlarm->AlarmDateWeekDay)));
- }
- else
- {
- assert_param(IS_RTC_ALARM_DATE_WEEKDAY_WEEKDAY(RTC_Bcd2ToByte(sAlarm->AlarmDateWeekDay)));
- }
- #endif /* USE_FULL_ASSERT */
- tmpreg = (((uint32_t)(sAlarm->AlarmTime.Hours) << RTC_ALRMAR_HU_Pos) | \
- ((uint32_t)(sAlarm->AlarmTime.Minutes) << RTC_ALRMAR_MNU_Pos) | \
- ((uint32_t)(sAlarm->AlarmTime.Seconds) << RTC_ALRMAR_SU_Pos) | \
- ((uint32_t)(sAlarm->AlarmTime.TimeFormat) << RTC_ALRMAR_PM_Pos) | \
- ((uint32_t)(sAlarm->AlarmDateWeekDay) << RTC_ALRMAR_DU_Pos) | \
- ((uint32_t)sAlarm->AlarmDateWeekDaySel) | \
- ((uint32_t)sAlarm->AlarmMask));
- }
- /* Configure the Alarm A or Alarm B Sub Second registers */
- subsecondtmpreg = (uint32_t)((uint32_t)(sAlarm->AlarmTime.SubSeconds) | (uint32_t)(sAlarm->AlarmSubSecondMask));
- /* Disable the write protection for RTC registers */
- __HAL_RTC_WRITEPROTECTION_DISABLE(hrtc);
- /* Configure the Alarm register */
- if (sAlarm->Alarm == RTC_ALARM_A)
- {
- /* Disable the Alarm A interrupt */
- /* In case of interrupt mode is used, the interrupt source must disabled */
- CLEAR_BIT(hrtc->Instance->CR, (RTC_CR_ALRAE | RTC_CR_ALRAIE));
- /* Clear flag alarm A */
- WRITE_REG(hrtc->Instance->SCR, RTC_SCR_CALRAF);
- tickstart = HAL_GetTick();
- /* Wait till RTC ALRAWF flag is set and if Time out is reached exit */
- while (READ_BIT(hrtc->Instance->ICSR, RTC_ICSR_ALRAWF) == 0U)
- {
- 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;
- }
- }
- WRITE_REG(hrtc->Instance->ALRMAR, tmpreg);
- /* Configure the Alarm A Sub Second register */
- WRITE_REG(hrtc->Instance->ALRMASSR, subsecondtmpreg);
- /* Configure the Alarm state: Enable Alarm */
- SET_BIT(hrtc->Instance->CR, RTC_CR_ALRAE);
- }
- else
- {
- /* Disable the Alarm B interrupt */
- /* In case of interrupt mode is used, the interrupt source must disabled */
- CLEAR_BIT(hrtc->Instance->CR, (RTC_CR_ALRBE | RTC_CR_ALRBIE));
- /* Clear flag alarm B */
- WRITE_REG(hrtc->Instance->SCR, RTC_SCR_CALRBF);
- tickstart = HAL_GetTick();
- /* Wait till RTC ALRBWF flag is set and if Time out is reached exit */
- while (READ_BIT(hrtc->Instance->ICSR, RTC_ICSR_ALRBWF) == 0U)
- {
- 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;
- }
- }
- WRITE_REG(hrtc->Instance->ALRMBR, tmpreg);
- /* Configure the Alarm B Sub Second register */
- WRITE_REG(hrtc->Instance->ALRMBSSR, subsecondtmpreg);
- /* Configure the Alarm state: Enable Alarm */
- SET_BIT(hrtc->Instance->CR, RTC_CR_ALRBE);
- }
- /* 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 the specified RTC Alarm with Interrupt.
- * @note The Alarm register can only be written when the corresponding Alarm
- * is disabled (Use the HAL_RTC_DeactivateAlarm()).
- * @note The HAL_RTC_SetTime() must be called before enabling the Alarm feature.
- * @param hrtc RTC handle
- * @param sAlarm Pointer to Alarm 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_RTC_SetAlarm_IT(RTC_HandleTypeDef *hrtc, RTC_AlarmTypeDef *sAlarm, uint32_t Format)
- {
- uint32_t tickstart;
- uint32_t tmpreg;
- uint32_t subsecondtmpreg;
- /* Check the parameters */
- assert_param(IS_RTC_FORMAT(Format));
- assert_param(IS_RTC_ALARM(sAlarm->Alarm));
- assert_param(IS_RTC_ALARM_MASK(sAlarm->AlarmMask));
- assert_param(IS_RTC_ALARM_DATE_WEEKDAY_SEL(sAlarm->AlarmDateWeekDaySel));
- assert_param(IS_RTC_ALARM_SUB_SECOND_VALUE(sAlarm->AlarmTime.SubSeconds));
- assert_param(IS_RTC_ALARM_SUB_SECOND_MASK(sAlarm->AlarmSubSecondMask));
- /* Process Locked */
- __HAL_LOCK(hrtc);
- hrtc->State = HAL_RTC_STATE_BUSY;
- if (Format == RTC_FORMAT_BIN)
- {
- if (READ_BIT(hrtc->Instance->CR, RTC_CR_FMT) != 0U)
- {
- assert_param(IS_RTC_HOUR12(sAlarm->AlarmTime.Hours));
- assert_param(IS_RTC_HOURFORMAT12(sAlarm->AlarmTime.TimeFormat));
- }
- else
- {
- sAlarm->AlarmTime.TimeFormat = 0x00U;
- assert_param(IS_RTC_HOUR24(sAlarm->AlarmTime.Hours));
- }
- assert_param(IS_RTC_MINUTES(sAlarm->AlarmTime.Minutes));
- assert_param(IS_RTC_SECONDS(sAlarm->AlarmTime.Seconds));
- #ifdef USE_FULL_ASSERT
- if (sAlarm->AlarmDateWeekDaySel == RTC_ALARMDATEWEEKDAYSEL_DATE)
- {
- assert_param(IS_RTC_ALARM_DATE_WEEKDAY_DATE(sAlarm->AlarmDateWeekDay));
- }
- else
- {
- assert_param(IS_RTC_ALARM_DATE_WEEKDAY_WEEKDAY(sAlarm->AlarmDateWeekDay));
- }
- #endif /* USE_FULL_ASSERT */
- tmpreg = (((uint32_t)RTC_ByteToBcd2(sAlarm->AlarmTime.Hours) << RTC_ALRMAR_HU_Pos) | \
- ((uint32_t)RTC_ByteToBcd2(sAlarm->AlarmTime.Minutes) << RTC_ALRMAR_MNU_Pos) | \
- ((uint32_t)RTC_ByteToBcd2(sAlarm->AlarmTime.Seconds) << RTC_ALRMAR_SU_Pos) | \
- ((uint32_t)(sAlarm->AlarmTime.TimeFormat) << RTC_ALRMAR_PM_Pos) | \
- ((uint32_t)RTC_ByteToBcd2(sAlarm->AlarmDateWeekDay) << RTC_ALRMAR_DU_Pos) | \
- ((uint32_t)sAlarm->AlarmDateWeekDaySel) | \
- ((uint32_t)sAlarm->AlarmMask));
- }
- else /* Format BCD */
- {
- if (READ_BIT(hrtc->Instance->CR, RTC_CR_FMT) != 0U)
- {
- assert_param(IS_RTC_HOUR12(RTC_Bcd2ToByte(sAlarm->AlarmTime.Hours)));
- assert_param(IS_RTC_HOURFORMAT12(sAlarm->AlarmTime.TimeFormat));
- }
- else
- {
- sAlarm->AlarmTime.TimeFormat = 0x00U;
- 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)));
- #ifdef USE_FULL_ASSERT
- if (sAlarm->AlarmDateWeekDaySel == RTC_ALARMDATEWEEKDAYSEL_DATE)
- {
- assert_param(IS_RTC_ALARM_DATE_WEEKDAY_DATE(RTC_Bcd2ToByte(sAlarm->AlarmDateWeekDay)));
- }
- else
- {
- assert_param(IS_RTC_ALARM_DATE_WEEKDAY_WEEKDAY(RTC_Bcd2ToByte(sAlarm->AlarmDateWeekDay)));
- }
- #endif /* USE_FULL_ASSERT */
- tmpreg = (((uint32_t)(sAlarm->AlarmTime.Hours) << RTC_ALRMAR_HU_Pos) | \
- ((uint32_t)(sAlarm->AlarmTime.Minutes) << RTC_ALRMAR_MNU_Pos) | \
- ((uint32_t)(sAlarm->AlarmTime.Seconds) << RTC_ALRMAR_SU_Pos) | \
- ((uint32_t)(sAlarm->AlarmTime.TimeFormat) << RTC_ALRMAR_PM_Pos) | \
- ((uint32_t)(sAlarm->AlarmDateWeekDay) << RTC_ALRMAR_DU_Pos) | \
- ((uint32_t)sAlarm->AlarmDateWeekDaySel) | \
- ((uint32_t)sAlarm->AlarmMask));
- }
- /* Configure the Alarm A or Alarm B Sub Second registers */
- subsecondtmpreg = (uint32_t)((uint32_t)(sAlarm->AlarmTime.SubSeconds) | (uint32_t)(sAlarm->AlarmSubSecondMask));
- /* Disable the write protection for RTC registers */
- __HAL_RTC_WRITEPROTECTION_DISABLE(hrtc);
- /* Configure the Alarm register */
- if (sAlarm->Alarm == RTC_ALARM_A)
- {
- /* Disable the Alarm A interrupt */
- CLEAR_BIT(hrtc->Instance->CR, (RTC_CR_ALRAE | RTC_CR_ALRAIE));
- /* Clear flag alarm A */
- WRITE_REG(hrtc->Instance->SCR, RTC_SCR_CALRAF);
- __HAL_RTC_ALARM_EXTI_CLEAR_IT();
- tickstart = HAL_GetTick();
- /* Wait till RTC ALRAWF flag is set and if Time out is reached exit */
- while (READ_BIT(hrtc->Instance->ICSR, RTC_ICSR_ALRAWF) == 0U)
- {
- 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;
- }
- }
- WRITE_REG(hrtc->Instance->ALRMAR, tmpreg);
- /* Configure the Alarm A Sub Second register */
- WRITE_REG(hrtc->Instance->ALRMASSR, subsecondtmpreg);
- /* Configure the Alarm interrupt : Enable Alarm */
- SET_BIT(hrtc->Instance->CR, (RTC_CR_ALRAE | RTC_CR_ALRAIE));
- }
- else
- {
- /* Disable the Alarm B interrupt */
- CLEAR_BIT(hrtc->Instance->CR, (RTC_CR_ALRBE | RTC_CR_ALRBIE));
- /* Clear flag alarm B */
- WRITE_REG(hrtc->Instance->SCR, RTC_SCR_CALRBF);
- __HAL_RTC_ALARM_EXTI_CLEAR_IT();
- tickstart = HAL_GetTick();
- /* Wait till RTC ALRBWF flag is set and if Time out is reached exit */
- while (READ_BIT(hrtc->Instance->ICSR, RTC_ICSR_ALRBWF) == 0U)
- {
- 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;
- }
- }
- WRITE_REG(hrtc->Instance->ALRMBR, tmpreg);
- /* Configure the Alarm B Sub Second register */
- WRITE_REG(hrtc->Instance->ALRMBSSR, subsecondtmpreg);
- /* Configure the Alarm B interrupt : Enable Alarm */
- SET_BIT(hrtc->Instance->CR, (RTC_CR_ALRBE | RTC_CR_ALRBIE));
- }
- /* RTC Alarm Interrupt Configuration: EXTI configuration */
- __HAL_RTC_ALARM_EXTI_ENABLE_IT();
- __HAL_RTC_ALARM_EXTI_RISING_IT();
- /* 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 specified RTC Alarm.
- * @param hrtc RTC handle
- * @param Alarm Specifies the Alarm.
- * This parameter can be one of the following values:
- * @arg RTC_ALARM_A: AlarmA
- * @arg RTC_ALARM_B: AlarmB
- * @retval HAL status
- */
- HAL_StatusTypeDef HAL_RTC_DeactivateAlarm(RTC_HandleTypeDef *hrtc, uint32_t Alarm)
- {
- uint32_t tickstart;
- /* Check the parameters */
- assert_param(IS_RTC_ALARM(Alarm));
- /* Process Locked */
- __HAL_LOCK(hrtc);
- hrtc->State = HAL_RTC_STATE_BUSY;
- /* Disable the write protection for RTC registers */
- __HAL_RTC_WRITEPROTECTION_DISABLE(hrtc);
- if (Alarm == RTC_ALARM_A)
- {
- /* AlarmA */
- /* In case of interrupt mode is used, the interrupt source must disabled */
- CLEAR_BIT(hrtc->Instance->CR, RTC_CR_ALRAE | RTC_CR_ALRAIE);
- __HAL_RTC_ALARM_EXTI_CLEAR_IT();
- tickstart = HAL_GetTick();
- /* Wait till RTC ALRxWF flag is set and if Time out is reached exit */
- while (READ_BIT(hrtc->Instance->ICSR, RTC_ICSR_ALRAWF) == 0U)
- {
- 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;
- }
- }
- }
- else
- {
- /* AlarmB */
- /* In case of interrupt mode is used, the interrupt source must disabled */
- CLEAR_BIT(hrtc->Instance->CR, RTC_CR_ALRBE | RTC_CR_ALRBIE);
- __HAL_RTC_ALARM_EXTI_CLEAR_IT();
- tickstart = HAL_GetTick();
- /* Wait till RTC ALRxWF flag is set and if Time out is reached exit */
- while (READ_BIT(hrtc->Instance->ICSR, RTC_ICSR_ALRBWF) == 0U)
- {
- 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 the RTC Alarm value and masks.
- * @param hrtc RTC handle
- * @param sAlarm Pointer to Date structure
- * @param Alarm Specifies the Alarm.
- * This parameter can be one of the following values:
- * @arg RTC_ALARM_A: AlarmA
- * @arg RTC_ALARM_B: AlarmB
- * @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_RTC_GetAlarm(RTC_HandleTypeDef *hrtc, RTC_AlarmTypeDef *sAlarm, uint32_t Alarm, uint32_t Format)
- {
- uint32_t tmpreg, subsecondtmpreg;
- /* Check the parameters */
- assert_param(IS_RTC_FORMAT(Format));
- assert_param(IS_RTC_ALARM(Alarm));
- if (Alarm == RTC_ALARM_A)
- {
- /* AlarmA */
- sAlarm->Alarm = RTC_ALARM_A;
- tmpreg = READ_REG(hrtc->Instance->ALRMAR);
- subsecondtmpreg = (uint32_t)(READ_REG(hrtc->Instance->ALRMASSR) & RTC_ALRMASSR_SS);
- /* Fill the structure with the read parameters */
- sAlarm->AlarmTime.Hours = (uint8_t)((tmpreg & (RTC_ALRMAR_HT | RTC_ALRMAR_HU)) >> RTC_ALRMAR_HU_Pos);
- sAlarm->AlarmTime.Minutes = (uint8_t)((tmpreg & (RTC_ALRMAR_MNT | RTC_ALRMAR_MNU)) >> RTC_ALRMAR_MNU_Pos);
- sAlarm->AlarmTime.Seconds = (uint8_t)((tmpreg & (RTC_ALRMAR_ST | RTC_ALRMAR_SU)) >> RTC_ALRMAR_SU_Pos);
- sAlarm->AlarmTime.TimeFormat = (uint8_t)((tmpreg & RTC_ALRMAR_PM) >> RTC_ALRMAR_PM_Pos);
- sAlarm->AlarmTime.SubSeconds = (uint32_t) subsecondtmpreg;
- sAlarm->AlarmDateWeekDay = (uint8_t)((tmpreg & (RTC_ALRMAR_DT | RTC_ALRMAR_DU)) >> RTC_ALRMAR_DU_Pos);
- sAlarm->AlarmDateWeekDaySel = (uint32_t)(tmpreg & RTC_ALRMAR_WDSEL);
- sAlarm->AlarmMask = (uint32_t)(tmpreg & RTC_ALARMMASK_ALL);
- }
- else
- {
- sAlarm->Alarm = RTC_ALARM_B;
- tmpreg = READ_REG(hrtc->Instance->ALRMBR);
- subsecondtmpreg = (uint32_t)(READ_REG(hrtc->Instance->ALRMBSSR) & RTC_ALRMBSSR_SS);
- /* Fill the structure with the read parameters */
- sAlarm->AlarmTime.Hours = (uint8_t)((tmpreg & (RTC_ALRMBR_HT | RTC_ALRMBR_HU)) >> RTC_ALRMBR_HU_Pos);
- sAlarm->AlarmTime.Minutes = (uint8_t)((tmpreg & (RTC_ALRMBR_MNT | RTC_ALRMBR_MNU)) >> RTC_ALRMBR_MNU_Pos);
- sAlarm->AlarmTime.Seconds = (uint8_t)((tmpreg & (RTC_ALRMBR_ST | RTC_ALRMBR_SU)) >> RTC_ALRMBR_SU_Pos);
- sAlarm->AlarmTime.TimeFormat = (uint8_t)((tmpreg & RTC_ALRMBR_PM) >> RTC_ALRMBR_PM_Pos);
- sAlarm->AlarmTime.SubSeconds = (uint32_t) subsecondtmpreg;
- sAlarm->AlarmDateWeekDay = (uint8_t)((tmpreg & (RTC_ALRMBR_DT | RTC_ALRMBR_DU)) >> RTC_ALRMBR_DU_Pos);
- sAlarm->AlarmDateWeekDaySel = (uint32_t)(tmpreg & RTC_ALRMBR_WDSEL);
- sAlarm->AlarmMask = (uint32_t)(tmpreg & RTC_ALARMMASK_ALL);
- }
- if (Format == RTC_FORMAT_BIN)
- {
- sAlarm->AlarmTime.Hours = RTC_Bcd2ToByte(sAlarm->AlarmTime.Hours);
- sAlarm->AlarmTime.Minutes = RTC_Bcd2ToByte(sAlarm->AlarmTime.Minutes);
- sAlarm->AlarmTime.Seconds = RTC_Bcd2ToByte(sAlarm->AlarmTime.Seconds);
- sAlarm->AlarmDateWeekDay = RTC_Bcd2ToByte(sAlarm->AlarmDateWeekDay);
- }
- return HAL_OK;
- }
- /**
- * @brief Handle Alarm interrupt request.
- * @param hrtc RTC handle
- * @retval None
- */
- void HAL_RTC_AlarmIRQHandler(RTC_HandleTypeDef *hrtc)
- {
- /* Get interrupt status */
- uint32_t tmp = READ_REG(hrtc->Instance->MISR);
- if ((tmp & RTC_MISR_ALRAMF) != 0U)
- {
- /* Clear the AlarmA interrupt pending bit */
- WRITE_REG(hrtc->Instance->SCR, RTC_SCR_CALRAF);
- __HAL_RTC_ALARM_EXTI_CLEAR_IT();
- #if (USE_HAL_RTC_REGISTER_CALLBACKS == 1)
- /* Call Compare Match registered Callback */
- hrtc->AlarmAEventCallback(hrtc);
- #else
- HAL_RTC_AlarmAEventCallback(hrtc);
- #endif /* USE_HAL_RTC_REGISTER_CALLBACKS */
- }
- if ((tmp & RTC_MISR_ALRBMF) != 0U)
- {
- /* Clear the AlarmB interrupt pending bit */
- WRITE_REG(hrtc->Instance->SCR, RTC_SCR_CALRBF);
- __HAL_RTC_ALARM_EXTI_CLEAR_IT();
- #if (USE_HAL_RTC_REGISTER_CALLBACKS == 1)
- /* Call Compare Match registered Callback */
- hrtc->AlarmBEventCallback(hrtc);
- #else
- HAL_RTCEx_AlarmBEventCallback(hrtc);
- #endif /* USE_HAL_RTC_REGISTER_CALLBACKS */
- }
- /* Change RTC state */
- hrtc->State = HAL_RTC_STATE_READY;
- }
- /**
- * @brief Alarm A callback.
- * @param hrtc RTC handle
- * @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 Handle AlarmA Polling request.
- * @param hrtc RTC handle
- * @param Timeout Timeout duration
- * @retval HAL status
- */
- HAL_StatusTypeDef HAL_RTC_PollForAlarmAEvent(RTC_HandleTypeDef *hrtc, uint32_t Timeout)
- {
- uint32_t tickstart = HAL_GetTick();
- while (READ_BIT(hrtc->Instance->SR, RTC_SR_ALRAF) == 0U)
- {
- if (Timeout != HAL_MAX_DELAY)
- {
- if (((HAL_GetTick() - tickstart) > Timeout) || (Timeout == 0U))
- {
- hrtc->State = HAL_RTC_STATE_TIMEOUT;
- /* Process Unlocked */
- __HAL_UNLOCK(hrtc);
- return HAL_TIMEOUT;
- }
- }
- }
- /* Clear the Alarm interrupt pending bit */
- WRITE_REG(hrtc->Instance->SCR, RTC_SCR_CALRAF);
- /* Change RTC state */
- hrtc->State = HAL_RTC_STATE_READY;
- return HAL_OK;
- }
- /**
- * @}
- */
- /** @addtogroup RTC_Exported_Functions_Group4
- * @brief Peripheral Control functions
- *
- @verbatim
- ===============================================================================
- ##### Peripheral Control functions #####
- ===============================================================================
- [..]
- This subsection provides functions allowing to
- (+) Wait for RTC Time and Date Synchronization
- @endverbatim
- * @{
- */
- /**
- * @brief Wait until the RTC Time and Date registers (RTC_TR and RTC_DR) are
- * synchronized with RTC APB clock.
- * @note The RTC Resynchronization mode is write protected, use the
- * __HAL_RTC_WRITEPROTECTION_DISABLE() before calling this function.
- * @note To read the calendar through the shadow registers after Calendar
- * initialization, calendar update or after wakeup from low power modes
- * the software must first clear the RSF flag.
- * The software must then wait until it is set again before reading
- * the calendar, which means that the calendar registers have been
- * correctly copied into the RTC_TR and RTC_DR shadow registers.
- * @param hrtc RTC handle
- * @retval HAL status
- */
- HAL_StatusTypeDef HAL_RTC_WaitForSynchro(RTC_HandleTypeDef *hrtc)
- {
- uint32_t tickstart;
- /* Clear RSF flag, keep reserved bits at reset values (setting other flags has no effect) */
- hrtc->Instance->ICSR = ((uint32_t)(RTC_RSF_MASK & RTC_ICSR_RESERVED_MASK));
- tickstart = HAL_GetTick();
- /* Wait the registers to be synchronised */
- while (READ_BIT(hrtc->Instance->ICSR, RTC_ICSR_RSF) == 0U)
- {
- if ((HAL_GetTick() - tickstart) > RTC_TIMEOUT_VALUE)
- {
- return HAL_TIMEOUT;
- }
- }
- return HAL_OK;
- }
- /**
- * @}
- */
- /** @addtogroup RTC_Exported_Functions_Group5
- * @brief Peripheral State functions
- *
- @verbatim
- ===============================================================================
- ##### Peripheral State functions #####
- ===============================================================================
- [..]
- This subsection provides functions allowing to
- (+) Get RTC state
- @endverbatim
- * @{
- */
- /**
- * @brief Return the RTC handle state.
- * @param hrtc RTC handle
- * @retval HAL state
- */
- HAL_RTCStateTypeDef HAL_RTC_GetState(RTC_HandleTypeDef *hrtc)
- {
- /* Return RTC handle state */
- return hrtc->State;
- }
- /**
- * @}
- */
- /**
- * @}
- */
- /** @addtogroup RTC_Private_Functions
- * @{
- */
- /**
- * @brief Enter the RTC Initialization mode.
- * @note The RTC Initialization mode is write protected, use the
- * __HAL_RTC_WRITEPROTECTION_DISABLE() before calling this function.
- * @param hrtc RTC handle
- * @retval HAL status
- */
- HAL_StatusTypeDef RTC_EnterInitMode(RTC_HandleTypeDef *hrtc)
- {
- uint32_t tickstart;
- HAL_StatusTypeDef status = HAL_OK;
- /* Check if the Initialization mode is set */
- if (READ_BIT(hrtc->Instance->ICSR, RTC_ICSR_INITF) == 0U)
- {
- /* Set the Initialization mode */
- SET_BIT(hrtc->Instance->ICSR, RTC_ICSR_INIT);
- tickstart = HAL_GetTick();
- /* Wait till RTC is in INIT state and if Time out is reached exit */
- while ((READ_BIT(hrtc->Instance->ICSR, RTC_ICSR_INITF) == 0U) && (status != HAL_TIMEOUT))
- {
- if ((HAL_GetTick() - tickstart) > RTC_TIMEOUT_VALUE)
- {
- status = HAL_TIMEOUT;
- hrtc->State = HAL_RTC_STATE_TIMEOUT;
- }
- }
- }
- return status;
- }
- /**
- * @brief Exit the RTC Initialization mode.
- * @param hrtc RTC handle
- * @retval HAL status
- */
- HAL_StatusTypeDef RTC_ExitInitMode(RTC_HandleTypeDef *hrtc)
- {
- HAL_StatusTypeDef status = HAL_OK;
- /* Exit Initialization mode */
- CLEAR_BIT(hrtc->Instance->ICSR, RTC_ICSR_INIT);
- /* If CR_BYPSHAD bit = 0, wait for synchro */
- if (READ_BIT(hrtc->Instance->CR, RTC_CR_BYPSHAD) == 0U)
- {
- if (HAL_RTC_WaitForSynchro(hrtc) != HAL_OK)
- {
- hrtc->State = HAL_RTC_STATE_TIMEOUT;
- status = HAL_TIMEOUT;
- }
- }
- else /* WA 2.9.6 Calendar initialization may fail in case of consecutive INIT mode entry */
- {
- /* Clear BYPSHAD bit */
- CLEAR_BIT(hrtc->Instance->CR, RTC_CR_BYPSHAD);
- if (HAL_RTC_WaitForSynchro(hrtc) != HAL_OK)
- {
- hrtc->State = HAL_RTC_STATE_TIMEOUT;
- status = HAL_TIMEOUT;
- }
- /* Restore BYPSHAD bit */
- SET_BIT(hrtc->Instance->CR, RTC_CR_BYPSHAD);
- }
- return status;
- }
- /**
- * @brief Convert a 2 digit decimal to BCD format.
- * @param Value Byte to be converted
- * @retval Converted byte
- */
- uint8_t RTC_ByteToBcd2(uint8_t Value)
- {
- uint32_t bcdhigh = 0U;
- uint8_t tmp_Value = Value;
- while (tmp_Value >= 10U)
- {
- bcdhigh++;
- tmp_Value -= 10U;
- }
- return ((uint8_t)(bcdhigh << 4U) | tmp_Value);
- }
- /**
- * @brief Convert from 2 digit BCD to Binary.
- * @param Value BCD value to be converted
- * @retval Converted word
- */
- uint8_t RTC_Bcd2ToByte(uint8_t Value)
- {
- uint32_t tmp;
- tmp = (((uint32_t)Value & 0xF0U) >> 4) * 10U;
- return (uint8_t)(tmp + ((uint32_t)Value & 0x0FU));
- }
- /**
- * @brief Daylight Saving Time, Add one hour to the calendar in one single operation
- * without going through the initialization procedure.
- * @param hrtc RTC handle
- * @retval None
- */
- void HAL_RTC_DST_Add1Hour(RTC_HandleTypeDef *hrtc)
- {
- __HAL_RTC_WRITEPROTECTION_DISABLE(hrtc);
- SET_BIT(hrtc->Instance->CR, RTC_CR_ADD1H);
- __HAL_RTC_WRITEPROTECTION_ENABLE(hrtc);
- }
- /**
- * @brief Daylight Saving Time, Subtract one hour from the calendar in one
- * single operation without going through the initialization procedure.
- * @param hrtc RTC handle
- * @retval None
- */
- void HAL_RTC_DST_Sub1Hour(RTC_HandleTypeDef *hrtc)
- {
- __HAL_RTC_WRITEPROTECTION_DISABLE(hrtc);
- SET_BIT(hrtc->Instance->CR, RTC_CR_SUB1H);
- __HAL_RTC_WRITEPROTECTION_ENABLE(hrtc);
- }
- /**
- * @brief Daylight Saving Time, Set the store operation bit.
- * @note It can be used by the software in order to memorize the DST status.
- * @param hrtc RTC handle
- * @retval None
- */
- void HAL_RTC_DST_SetStoreOperation(RTC_HandleTypeDef *hrtc)
- {
- __HAL_RTC_WRITEPROTECTION_DISABLE(hrtc);
- SET_BIT(hrtc->Instance->CR, RTC_CR_BKP);
- __HAL_RTC_WRITEPROTECTION_ENABLE(hrtc);
- }
- /**
- * @brief Daylight Saving Time, Clear the store operation bit.
- * @param hrtc RTC handle
- * @retval None
- */
- void HAL_RTC_DST_ClearStoreOperation(RTC_HandleTypeDef *hrtc)
- {
- __HAL_RTC_WRITEPROTECTION_DISABLE(hrtc);
- CLEAR_BIT(hrtc->Instance->CR, RTC_CR_BKP);
- __HAL_RTC_WRITEPROTECTION_ENABLE(hrtc);
- }
- /**
- * @brief Daylight Saving Time, Read the store operation bit.
- * @param hrtc RTC handle
- * @retval operation see RTC_StoreOperation_Definitions
- */
- uint32_t HAL_RTC_DST_ReadStoreOperation(RTC_HandleTypeDef *hrtc)
- {
- return READ_BIT(hrtc->Instance->CR, RTC_CR_BKP);
- }
- /**
- * @}
- */
- #endif /* HAL_RTC_MODULE_ENABLED */
- /**
- * @}
- */
- /**
- * @}
- */
|