1 /** 2 ****************************************************************************** 3 * @file stm32u5xx_hal_rtc.h 4 * @author MCD Application Team 5 * @brief Header file of RTC HAL module. 6 ****************************************************************************** 7 * @attention 8 * 9 * Copyright (c) 2021 STMicroelectronics. 10 * All rights reserved. 11 * 12 * This software is licensed under terms that can be found in the LICENSE file 13 * in the root directory of this software component. 14 * If no LICENSE file comes with this software, it is provided AS-IS. 15 * 16 ****************************************************************************** 17 */ 18 19 /* Define to prevent recursive inclusion -------------------------------------*/ 20 #ifndef STM32U5xx_HAL_RTC_H 21 #define STM32U5xx_HAL_RTC_H 22 23 #ifdef __cplusplus 24 extern "C" { 25 #endif 26 27 /* Includes ------------------------------------------------------------------*/ 28 #include "stm32u5xx_hal_def.h" 29 30 /** @addtogroup STM32U5xx_HAL_Driver 31 * @{ 32 */ 33 34 /** @defgroup RTC RTC 35 * @{ 36 */ 37 38 /* Exported types ------------------------------------------------------------*/ 39 /** @defgroup RTC_Exported_Types RTC Exported Types 40 * @{ 41 */ 42 43 /** 44 * @brief HAL State structures definition 45 */ 46 typedef enum 47 { 48 HAL_RTC_STATE_RESET = 0x00U, /*!< RTC not yet initialized or disabled */ 49 HAL_RTC_STATE_READY = 0x01U, /*!< RTC initialized and ready for use */ 50 HAL_RTC_STATE_BUSY = 0x02U, /*!< RTC process is ongoing */ 51 HAL_RTC_STATE_TIMEOUT = 0x03U, /*!< RTC timeout state */ 52 HAL_RTC_STATE_ERROR = 0x04U /*!< RTC error state */ 53 54 } HAL_RTCStateTypeDef; 55 56 /** 57 * @brief RTC Configuration Structure definition 58 */ 59 typedef struct 60 { 61 uint32_t HourFormat; /*!< Specifies the RTC Hour Format. 62 This parameter can be a value of @ref RTC_Hour_Formats */ 63 64 uint32_t AsynchPrediv; /*!< Specifies the RTC Asynchronous Predivider value. 65 This parameter must be a number between Min_Data = 0x00 and Max_Data = 0x7F */ 66 67 uint32_t SynchPrediv; /*!< Specifies the RTC Synchronous Predivider value. 68 This parameter must be a number between Min_Data = 0x00 and Max_Data = 0x7FFF */ 69 70 uint32_t OutPut; /*!< Specifies which signal will be routed to the RTC output. 71 This parameter can be a value of @ref RTCEx_Output_selection_Definitions */ 72 73 uint32_t OutPutRemap; /*!< Specifies the remap for RTC output. 74 This parameter can be a value of @ref RTC_Output_ALARM_OUT_Remap */ 75 76 uint32_t OutPutPolarity; /*!< Specifies the polarity of the output signal. 77 This parameter can be a value of @ref RTC_Output_Polarity_Definitions */ 78 79 uint32_t OutPutType; /*!< Specifies the RTC Output Pin mode. 80 This parameter can be a value of @ref RTC_Output_Type_ALARM_OUT */ 81 82 uint32_t OutPutPullUp; /*!< Specifies the RTC Output Pull-Up mode. 83 This parameter can be a value of @ref RTC_Output_PullUp_ALARM_OUT */ 84 85 uint32_t BinMode; /*!< Specifies the RTC binary mode. 86 This parameter can be a value of @ref RTCEx_Binary_Mode */ 87 88 uint32_t BinMixBcdU; /*!< Specifies the BCD calendar update if and only if BinMode = RTC_BINARY_MIX. 89 This parameter can be a value of @ref RTCEx_Binary_mix_BCDU */ 90 } RTC_InitTypeDef; 91 92 /** 93 * @brief RTC Time structure definition 94 */ 95 typedef struct 96 { 97 uint8_t Hours; /*!< Specifies the RTC Time Hour. 98 This parameter must be a number between: 99 Min_Data = 0 and Max_Data = 12 if the RTC_HourFormat_12 is selected. 100 This parameter must be a number between: 101 Min_Data = 0 and Max_Data = 23 if the RTC_HourFormat_24 is selected */ 102 103 uint8_t Minutes; /*!< Specifies the RTC Time Minutes. 104 This parameter must be a number between Min_Data = 0 and Max_Data = 59 */ 105 106 uint8_t Seconds; /*!< Specifies the RTC Time Seconds. 107 This parameter must be a number between Min_Data = 0 and Max_Data = 59 */ 108 109 uint8_t TimeFormat; /*!< Specifies the RTC AM/PM Time. 110 This parameter can be a value of @ref RTC_AM_PM_Definitions */ 111 112 uint32_t SubSeconds; /*!< Specifies the RTC_SSR RTC Sub Second register content. 113 This field is not used by HAL_RTC_SetTime. 114 If the free running 32 bit counter is not activated (mode binary none) 115 - This parameter corresponds to a time unit range 116 between [0-1] Second with [1 Sec / SecondFraction +1] granularity 117 else 118 - This parameter corresponds to the free running 32 bit counter. */ 119 120 uint32_t SecondFraction; /*!< Specifies the range or granularity of Sub Second register content 121 corresponding to Synchronous pre-scaler factor value (PREDIV_S) 122 This parameter corresponds to a time unit range between [0-1] Second 123 with [1 Sec / SecondFraction +1] granularity. 124 This field will be used only by HAL_RTC_GetTime function */ 125 126 uint32_t DayLightSaving; /*!< This interface is deprecated. To manage Daylight SavingTime,use HAL_RTC_DST_xxx functions */ 127 128 uint32_t StoreOperation; /*!< This interface is deprecated. To manage Daylight Saving Time, please use HAL_RTC_DST_xxx functions */ 129 } RTC_TimeTypeDef; 130 131 /** 132 * @brief RTC Date structure definition 133 */ 134 typedef struct 135 { 136 uint8_t WeekDay; /*!< Specifies the RTC Date WeekDay. 137 This parameter can be a value of @ref RTC_WeekDay_Definitions */ 138 139 uint8_t Month; /*!< Specifies the RTC Date Month (in BCD format). 140 This parameter can be a value of @ref RTC_Month_Date_Definitions */ 141 142 uint8_t Date; /*!< Specifies the RTC Date. 143 This parameter must be a number between Min_Data = 1 and Max_Data = 31 */ 144 145 uint8_t Year; /*!< Specifies the RTC Date Year. 146 This parameter must be a number between Min_Data = 0 and Max_Data = 99 */ 147 } RTC_DateTypeDef; 148 149 /** 150 * @brief RTC Alarm structure definition 151 */ 152 typedef struct 153 { 154 RTC_TimeTypeDef AlarmTime; /*!< Specifies the RTC Alarm Time members */ 155 156 uint32_t AlarmMask; /*!< Specifies the RTC Alarm Masks. 157 This parameter can be a value of @ref RTC_AlarmMask_Definitions */ 158 159 uint32_t AlarmSubSecondMask; /*!< Specifies the RTC Alarm SubSeconds Masks. 160 if Binary mode is RTC_BINARY_ONLY or is RTC_BINARY_MIX 161 This parameter can be a value of 162 @ref RTCEx_Alarm_Sub_Seconds_binary_Masks_Definitions 163 else if Binary mode is RTC_BINARY_NONE 164 This parameter can be a value of 165 @ref RTC_Alarm_Sub_Seconds_Masks_Definitions */ 166 167 uint32_t BinaryAutoClr; /*!< Clear synchronously counter (RTC_SSR) on binary alarm. 168 RTC_ALARMSUBSECONDBIN_AUTOCLR_YES must only be used if Binary mode 169 is RTC_BINARY_ONLY 170 This parameter can be a value of 171 @ref RTCEx_Alarm_Sub_Seconds_binary_Clear_Definitions */ 172 173 uint32_t AlarmDateWeekDaySel; /*!< Specifies the RTC Alarm is on Date or WeekDay. 174 This parameter can be a value of @ref RTC_AlarmDateWeekDay_Definitions */ 175 176 uint8_t AlarmDateWeekDay; /*!< Specifies the RTC Alarm Date/WeekDay. 177 If the Alarm Date is selected, this parameter must be set to a value 178 in the 1-31 range. 179 If the Alarm WeekDay is selected, this parameter can be a value of 180 @ref RTC_WeekDay_Definitions */ 181 182 uint32_t FlagAutoClr; /*!< Specifies the alarm trigger generation. This feature is meaningful 183 to avoid any RTC software execution after configuration. 184 This parameter can be a value of @ref RTC_ALARM_Flag_AutoClear_Definitions */ 185 186 uint32_t Alarm; /*!< Specifies the alarm . 187 This parameter can be a value of @ref RTC_Alarms_Definitions */ 188 } RTC_AlarmTypeDef; 189 190 /** 191 * @brief RTC Handle Structure definition 192 */ 193 #if (USE_HAL_RTC_REGISTER_CALLBACKS == 1) 194 typedef struct __RTC_HandleTypeDef 195 #else 196 typedef struct 197 #endif /* (USE_HAL_RTC_REGISTER_CALLBACKS) */ 198 { 199 RTC_TypeDef *Instance; /*!< Legacy register base address. Not used anymore, the driver directly uses cmsis base address */ 200 201 RTC_InitTypeDef Init; /*!< RTC required parameters */ 202 203 HAL_LockTypeDef Lock; /*!< RTC locking object */ 204 205 __IO HAL_RTCStateTypeDef State; /*!< Time communication state */ 206 207 #if (USE_HAL_RTC_REGISTER_CALLBACKS == 1) 208 void (* AlarmAEventCallback)(struct __RTC_HandleTypeDef *hrtc); /*!< RTC Alarm A Event callback */ 209 void (* AlarmBEventCallback)(struct __RTC_HandleTypeDef *hrtc); /*!< RTC Alarm B Event callback */ 210 void (* TimeStampEventCallback)(struct __RTC_HandleTypeDef *hrtc); /*!< RTC TimeStamp Event callback */ 211 void (* WakeUpTimerEventCallback)(struct __RTC_HandleTypeDef *hrtc); /*!< RTC WakeUpTimer Event callback */ 212 void (* SSRUEventCallback)(struct __RTC_HandleTypeDef *hrtc); /*!< RTC SSRU Event callback */ 213 void (* Tamper1EventCallback)(struct __RTC_HandleTypeDef *hrtc); /*!< RTC Tamper 1 Event callback */ 214 void (* Tamper2EventCallback)(struct __RTC_HandleTypeDef *hrtc); /*!< RTC Tamper 2 Event callback */ 215 void (* Tamper3EventCallback)(struct __RTC_HandleTypeDef *hrtc); /*!< RTC Tamper 3 Event callback */ 216 void (* Tamper4EventCallback)(struct __RTC_HandleTypeDef *hrtc); /*!< RTC Tamper 4 Event callback */ 217 void (* Tamper5EventCallback)(struct __RTC_HandleTypeDef *hrtc); /*!< RTC Tamper 5 Event callback */ 218 void (* Tamper6EventCallback)(struct __RTC_HandleTypeDef *hrtc); /*!< RTC Tamper 6 Event callback */ 219 void (* Tamper7EventCallback)(struct __RTC_HandleTypeDef *hrtc); /*!< RTC Tamper 7 Event callback */ 220 void (* Tamper8EventCallback)(struct __RTC_HandleTypeDef *hrtc); /*!< RTC Tamper 8 Event callback */ 221 void (* InternalTamper1EventCallback)(struct __RTC_HandleTypeDef *hrtc); /*!< RTC Internal Tamper 1 Event callback */ 222 void (* InternalTamper2EventCallback)(struct __RTC_HandleTypeDef *hrtc); /*!< RTC Internal Tamper 2 Event callback */ 223 void (* InternalTamper3EventCallback)(struct __RTC_HandleTypeDef *hrtc); /*!< RTC Internal Tamper 3 Event callback */ 224 void (* InternalTamper5EventCallback)(struct __RTC_HandleTypeDef *hrtc); /*!< RTC Internal Tamper 5 Event callback */ 225 void (* InternalTamper6EventCallback)(struct __RTC_HandleTypeDef *hrtc); /*!< RTC Internal Tamper 6 Event callback */ 226 void (* InternalTamper7EventCallback)(struct __RTC_HandleTypeDef *hrtc); /*!< RTC Internal Tamper 7 Event callback */ 227 void (* InternalTamper8EventCallback)(struct __RTC_HandleTypeDef *hrtc); /*!< RTC Internal Tamper 8 Event callback */ 228 void (* InternalTamper9EventCallback)(struct __RTC_HandleTypeDef *hrtc); /*!< RTC Internal Tamper 9 Event callback */ 229 void (* InternalTamper11EventCallback)(struct __RTC_HandleTypeDef *hrtc); /*!< RTC Internal Tamper 11 Event callback */ 230 void (* InternalTamper12EventCallback)(struct __RTC_HandleTypeDef *hrtc); /*!< RTC Internal Tamper 12 Event callback */ 231 void (* InternalTamper13EventCallback)(struct __RTC_HandleTypeDef *hrtc); /*!< RTC Internal Tamper 13 Event callback */ 232 void (* MspInitCallback)(struct __RTC_HandleTypeDef *hrtc); /*!< RTC Msp Init callback */ 233 void (* MspDeInitCallback)(struct __RTC_HandleTypeDef *hrtc); /*!< RTC Msp DeInit callback */ 234 235 #endif /* (USE_HAL_RTC_REGISTER_CALLBACKS) */ 236 237 } RTC_HandleTypeDef; 238 239 #if (USE_HAL_RTC_REGISTER_CALLBACKS == 1) 240 /** 241 * @brief HAL RTC Callback ID enumeration definition 242 */ 243 typedef enum 244 { 245 HAL_RTC_ALARM_A_EVENT_CB_ID = 0U, /*!< RTC Alarm A Event Callback ID */ 246 HAL_RTC_ALARM_B_EVENT_CB_ID = 1U, /*!< RTC Alarm B Event Callback ID */ 247 HAL_RTC_TIMESTAMP_EVENT_CB_ID = 2U, /*!< RTC TimeStamp Event Callback ID */ 248 HAL_RTC_WAKEUPTIMER_EVENT_CB_ID = 3U, /*!< RTC WakeUp Timer Event Callback ID */ 249 HAL_RTC_SSRU_EVENT_CB_ID = 4U, /*!< RTC SSRU Event Callback ID */ 250 HAL_RTC_TAMPER1_EVENT_CB_ID = 5U, /*!< RTC Tamper 1 Callback ID */ 251 HAL_RTC_TAMPER2_EVENT_CB_ID = 6U, /*!< RTC Tamper 2 Callback ID */ 252 HAL_RTC_TAMPER3_EVENT_CB_ID = 7U, /*!< RTC Tamper 3 Callback ID */ 253 HAL_RTC_TAMPER4_EVENT_CB_ID = 8U, /*!< RTC Tamper 4 Callback ID */ 254 HAL_RTC_TAMPER5_EVENT_CB_ID = 9U, /*!< RTC Tamper 5 Callback ID */ 255 HAL_RTC_TAMPER6_EVENT_CB_ID = 10U, /*!< RTC Tamper 6 Callback ID */ 256 HAL_RTC_TAMPER7_EVENT_CB_ID = 11U, /*!< RTC Tamper 7 Callback ID */ 257 HAL_RTC_TAMPER8_EVENT_CB_ID = 12U, /*!< RTC Tamper 8 Callback ID */ 258 HAL_RTC_INTERNAL_TAMPER1_EVENT_CB_ID = 13U, /*!< RTC Internal Tamper 1 Callback ID */ 259 HAL_RTC_INTERNAL_TAMPER2_EVENT_CB_ID = 14U, /*!< RTC Internal Tamper 2 Callback ID */ 260 HAL_RTC_INTERNAL_TAMPER3_EVENT_CB_ID = 15U, /*!< RTC Internal Tamper 3 Callback ID */ 261 HAL_RTC_INTERNAL_TAMPER5_EVENT_CB_ID = 16U, /*!< RTC Internal Tamper 5 Callback ID */ 262 HAL_RTC_INTERNAL_TAMPER6_EVENT_CB_ID = 17U, /*!< RTC Internal Tamper 6 Callback ID */ 263 HAL_RTC_INTERNAL_TAMPER7_EVENT_CB_ID = 18U, /*!< RTC Internal Tamper 7 Callback ID */ 264 HAL_RTC_INTERNAL_TAMPER8_EVENT_CB_ID = 19U, /*!< RTC Internal Tamper 8 Callback ID */ 265 HAL_RTC_INTERNAL_TAMPER9_EVENT_CB_ID = 20U, /*!< RTC Internal Tamper 9 Callback ID */ 266 HAL_RTC_INTERNAL_TAMPER11_EVENT_CB_ID = 21U, /*!< RTC Internal Tamper 11 Callback ID */ 267 HAL_RTC_INTERNAL_TAMPER12_EVENT_CB_ID = 22U, /*!< RTC Internal Tamper 12 Callback ID */ 268 HAL_RTC_INTERNAL_TAMPER13_EVENT_CB_ID = 23U, /*!< RTC Internal Tamper 13 Callback ID */ 269 HAL_RTC_MSPINIT_CB_ID = 24U, /*!< RTC Msp Init callback ID */ 270 HAL_RTC_MSPDEINIT_CB_ID = 25U /*!< RTC Msp DeInit callback ID */ 271 } HAL_RTC_CallbackIDTypeDef; 272 273 /** 274 * @brief HAL RTC Callback pointer definition 275 */ 276 typedef void (*pRTC_CallbackTypeDef)(RTC_HandleTypeDef *hrtc); /*!< pointer to an RTC callback function */ 277 #endif /* USE_HAL_RTC_REGISTER_CALLBACKS */ 278 279 /** 280 * @} 281 */ 282 283 /* Exported constants --------------------------------------------------------*/ 284 /** @defgroup RTC_Exported_Constants RTC Exported Constants 285 * @{ 286 */ 287 288 /** @defgroup RTC_Hour_Formats RTC Hour Formats 289 * @{ 290 */ 291 #define RTC_HOURFORMAT_24 0U 292 #define RTC_HOURFORMAT_12 RTC_CR_FMT 293 /** 294 * @} 295 */ 296 297 /** @defgroup RTCEx_Output_selection_Definitions RTCEx Output Selection Definition 298 * @{ 299 */ 300 #define RTC_OUTPUT_DISABLE 0U 301 #define RTC_OUTPUT_ALARMA RTC_CR_OSEL_0 302 #define RTC_OUTPUT_ALARMB RTC_CR_OSEL_1 303 #define RTC_OUTPUT_WAKEUP RTC_CR_OSEL 304 #define RTC_OUTPUT_TAMPER RTC_CR_TAMPOE 305 /** 306 * @} 307 */ 308 309 /** @defgroup RTC_Output_Polarity_Definitions RTC Output Polarity Definitions 310 * @{ 311 */ 312 #define RTC_OUTPUT_POLARITY_HIGH 0U 313 #define RTC_OUTPUT_POLARITY_LOW RTC_CR_POL 314 /** 315 * @} 316 */ 317 318 /** @defgroup RTC_Output_Type_ALARM_OUT RTC Output Type ALARM OUT 319 * @{ 320 */ 321 #define RTC_OUTPUT_TYPE_PUSHPULL 0U 322 #define RTC_OUTPUT_TYPE_OPENDRAIN RTC_CR_TAMPALRM_TYPE 323 /** 324 * @} 325 */ 326 327 /** @defgroup RTC_Output_PullUp_ALARM_OUT RTC Output Pull-Up ALARM OUT 328 * @{ 329 */ 330 #define RTC_OUTPUT_PULLUP_NONE 0U 331 #define RTC_OUTPUT_PULLUP_ON RTC_CR_TAMPALRM_PU 332 /** 333 * @} 334 */ 335 336 /** @defgroup RTC_Output_ALARM_OUT_Remap RTC Output ALARM OUT Remap 337 * @{ 338 */ 339 #define RTC_OUTPUT_REMAP_NONE 0U 340 #define RTC_OUTPUT_REMAP_POS1 RTC_CR_OUT2EN 341 /** 342 * @} 343 */ 344 345 /** @defgroup RTC_AM_PM_Definitions RTC AM PM Definitions 346 * @{ 347 */ 348 #define RTC_HOURFORMAT12_AM 0U 349 #define RTC_HOURFORMAT12_PM 1U 350 /** 351 * @} 352 */ 353 354 /** @defgroup RTC_DayLightSaving_Definitions RTC DayLightSaving Definitions 355 * @{ 356 */ 357 #define RTC_DAYLIGHTSAVING_SUB1H RTC_CR_SUB1H 358 #define RTC_DAYLIGHTSAVING_ADD1H RTC_CR_ADD1H 359 #define RTC_DAYLIGHTSAVING_NONE 0U 360 /** 361 * @} 362 */ 363 364 /** @defgroup RTC_StoreOperation_Definitions RTC StoreOperation Definitions 365 * @{ 366 */ 367 #define RTC_STOREOPERATION_RESET 0U 368 #define RTC_STOREOPERATION_SET RTC_CR_BKP 369 /** 370 * @} 371 */ 372 373 /** @defgroup RTC_Input_parameter_format_definitions RTC Input Parameter Format Definitions 374 * @{ 375 */ 376 #define RTC_FORMAT_BIN 0U 377 #define RTC_FORMAT_BCD 1U 378 /** 379 * @} 380 */ 381 382 /** @defgroup RTC_Month_Date_Definitions RTC Month Date Definitions 383 * @{ 384 */ 385 386 /* Coded in BCD format */ 387 #define RTC_MONTH_JANUARY ((uint8_t)0x01U) 388 #define RTC_MONTH_FEBRUARY ((uint8_t)0x02U) 389 #define RTC_MONTH_MARCH ((uint8_t)0x03U) 390 #define RTC_MONTH_APRIL ((uint8_t)0x04U) 391 #define RTC_MONTH_MAY ((uint8_t)0x05U) 392 #define RTC_MONTH_JUNE ((uint8_t)0x06U) 393 #define RTC_MONTH_JULY ((uint8_t)0x07U) 394 #define RTC_MONTH_AUGUST ((uint8_t)0x08U) 395 #define RTC_MONTH_SEPTEMBER ((uint8_t)0x09U) 396 #define RTC_MONTH_OCTOBER ((uint8_t)0x10U) 397 #define RTC_MONTH_NOVEMBER ((uint8_t)0x11U) 398 #define RTC_MONTH_DECEMBER ((uint8_t)0x12U) 399 400 /** 401 * @} 402 */ 403 404 /** @defgroup RTC_WeekDay_Definitions RTC WeekDay Definitions 405 * @{ 406 */ 407 #define RTC_WEEKDAY_MONDAY ((uint8_t)0x01U) 408 #define RTC_WEEKDAY_TUESDAY ((uint8_t)0x02U) 409 #define RTC_WEEKDAY_WEDNESDAY ((uint8_t)0x03U) 410 #define RTC_WEEKDAY_THURSDAY ((uint8_t)0x04U) 411 #define RTC_WEEKDAY_FRIDAY ((uint8_t)0x05U) 412 #define RTC_WEEKDAY_SATURDAY ((uint8_t)0x06U) 413 #define RTC_WEEKDAY_SUNDAY ((uint8_t)0x07U) 414 415 /** 416 * @} 417 */ 418 419 /** @defgroup RTC_AlarmDateWeekDay_Definitions RTC AlarmDateWeekDay Definitions 420 * @{ 421 */ 422 #define RTC_ALARMDATEWEEKDAYSEL_DATE 0U 423 #define RTC_ALARMDATEWEEKDAYSEL_WEEKDAY RTC_ALRMAR_WDSEL 424 425 /** 426 * @} 427 */ 428 429 /** @defgroup RTC_AlarmMask_Definitions RTC AlarmMask Definitions 430 * @{ 431 */ 432 #define RTC_ALARMMASK_NONE 0U 433 #define RTC_ALARMMASK_DATEWEEKDAY RTC_ALRMAR_MSK4 434 #define RTC_ALARMMASK_HOURS RTC_ALRMAR_MSK3 435 #define RTC_ALARMMASK_MINUTES RTC_ALRMAR_MSK2 436 #define RTC_ALARMMASK_SECONDS RTC_ALRMAR_MSK1 437 #define RTC_ALARMMASK_ALL (RTC_ALARMMASK_DATEWEEKDAY | RTC_ALARMMASK_HOURS | \ 438 RTC_ALARMMASK_MINUTES | RTC_ALARMMASK_SECONDS) 439 440 /** 441 * @} 442 */ 443 444 /** @defgroup RTC_Alarms_Definitions RTC Alarms Definitions 445 * @{ 446 */ 447 #define RTC_ALARM_A RTC_CR_ALRAE 448 #define RTC_ALARM_B RTC_CR_ALRBE 449 450 /** 451 * @} 452 */ 453 /** @defgroup RTC_ALARM_Flag_AutoClear_Definitions RTC Alarms Flag Auto Clear Definitions 454 * @{ 455 */ 456 #define ALARM_FLAG_AUTOCLR_ENABLE 1U 457 #define ALARM_FLAG_AUTOCLR_DISABLE 0U 458 /** 459 * @} 460 */ 461 462 /** @defgroup RTC_Alarm_Sub_Seconds_Masks_Definitions RTC Alarm Sub Seconds Masks Definitions 463 * @{ 464 */ 465 #define RTC_ALARMSUBSECONDMASK_ALL 0U /*!< All Alarm SS fields are masked. There is no comparison on sub seconds for Alarm */ 466 #define RTC_ALARMSUBSECONDMASK_SS14_1 RTC_ALRMASSR_MASKSS_0 /*!< SS[14:1] not used in Alarmcomparison. Only SS[0] is compared. */ 467 #define RTC_ALARMSUBSECONDMASK_SS14_2 RTC_ALRMASSR_MASKSS_1 /*!< SS[14:2] not used in Alarm comparison. Only SS[1:0] are compared */ 468 #define RTC_ALARMSUBSECONDMASK_SS14_3 (RTC_ALRMASSR_MASKSS_0 | RTC_ALRMASSR_MASKSS_1) /*!< SS[14:3] not used in Alarm comparison. Only SS[2:0] are compared */ 469 #define RTC_ALARMSUBSECONDMASK_SS14_4 RTC_ALRMASSR_MASKSS_2 /*!< SS[14:4] not used in Alarm comparison. Only SS[3:0] are compared */ 470 #define RTC_ALARMSUBSECONDMASK_SS14_5 (RTC_ALRMASSR_MASKSS_0 | RTC_ALRMASSR_MASKSS_2) /*!< SS[14:5] not used in Alarm comparison. Only SS[4:0] are compared */ 471 #define RTC_ALARMSUBSECONDMASK_SS14_6 (RTC_ALRMASSR_MASKSS_1 | RTC_ALRMASSR_MASKSS_2) /*!< SS[14:6] not used in Alarm comparison. Only SS[5:0] are compared */ 472 #define RTC_ALARMSUBSECONDMASK_SS14_7 (RTC_ALRMASSR_MASKSS_0 | RTC_ALRMASSR_MASKSS_1 | RTC_ALRMASSR_MASKSS_2) /*!< SS[14:7] not used in Alarm comparison. Only SS[6:0] are compared */ 473 #define RTC_ALARMSUBSECONDMASK_SS14_8 RTC_ALRMASSR_MASKSS_3 /*!< SS[14:8] not used in Alarm comparison. Only SS[7:0] are compared */ 474 #define RTC_ALARMSUBSECONDMASK_SS14_9 (RTC_ALRMASSR_MASKSS_0 | RTC_ALRMASSR_MASKSS_3) /*!< SS[14:9] not used in Alarm comparison. Only SS[8:0] are compared */ 475 #define RTC_ALARMSUBSECONDMASK_SS14_10 (RTC_ALRMASSR_MASKSS_1 | RTC_ALRMASSR_MASKSS_3) /*!< SS[14:10] not used in Alarm comparison. Only SS[9:0] are compared */ 476 #define RTC_ALARMSUBSECONDMASK_SS14_11 (RTC_ALRMASSR_MASKSS_0 | RTC_ALRMASSR_MASKSS_1 | RTC_ALRMASSR_MASKSS_3) /*!< SS[14:11] not used in Alarm comparison. Only SS[10:0] are compared */ 477 #define RTC_ALARMSUBSECONDMASK_SS14_12 (RTC_ALRMASSR_MASKSS_2 | RTC_ALRMASSR_MASKSS_3) /*!< SS[14:12] not used in Alarm comparison.Only SS[11:0] are compared */ 478 #define RTC_ALARMSUBSECONDMASK_SS14_13 (RTC_ALRMASSR_MASKSS_0 | RTC_ALRMASSR_MASKSS_2 | RTC_ALRMASSR_MASKSS_3) /*!< SS[14:13] not used in Alarm comparison. Only SS[12:0] are compared */ 479 #define RTC_ALARMSUBSECONDMASK_SS14 (RTC_ALRMASSR_MASKSS_1 | RTC_ALRMASSR_MASKSS_2 | RTC_ALRMASSR_MASKSS_3) /*!< SS[14] not used in Alarm comparison. Only SS[13:0] are compared */ 480 #define RTC_ALARMSUBSECONDMASK_NONE RTC_ALRMASSR_MASKSS /*!< SS[14:0] are compared and must match to activate alarm. */ 481 /** 482 * @} 483 */ 484 485 /** @defgroup RTC_Interrupts_Definitions RTC Interrupts Definitions 486 * @{ 487 */ 488 #define RTC_IT_TS RTC_CR_TSIE /*!< Enable Timestamp Interrupt */ 489 #define RTC_IT_WUT RTC_CR_WUTIE /*!< Enable Wakeup timer Interrupt */ 490 #define RTC_IT_SSRU RTC_CR_SSRUIE /*!< Enable SSR Underflow Interrupt */ 491 #define RTC_IT_ALRA RTC_CR_ALRAIE /*!< Enable Alarm A Interrupt */ 492 #define RTC_IT_ALRB RTC_CR_ALRBIE /*!< Enable Alarm B Interrupt */ 493 /** 494 * @} 495 */ 496 497 /** @defgroup RTC_Interruption_Mask RTC Interruptions Flag Mask 498 * @{ 499 */ 500 #define RTC_FLAG_MASK 0x001FU /*!< RTC flags mask */ 501 /** 502 * @} 503 */ 504 505 /** @defgroup RTC_Flags_Definitions RTC Flags Definitions 506 * Elements values convention: 000000XX000YYYYYb 507 * - YYYYY : Interrupt flag position in the XX register (5bits) 508 * - XX : Interrupt status register (2bits) 509 * - 01: ICSR register 510 * - 10: SR register 511 * @{ 512 */ 513 #define RTC_FLAG_RECALPF (0x00000100U | RTC_ICSR_RECALPF_Pos) /*!< Recalibration pending Flag */ 514 #define RTC_FLAG_INITF (0x00000100U | RTC_ICSR_INITF_Pos) /*!< Initialization flag */ 515 #define RTC_FLAG_RSF (0x00000100U | RTC_ICSR_RSF_Pos) /*!< Registers synchronization flag */ 516 #define RTC_FLAG_INITS (0x00000100U | RTC_ICSR_INITS_Pos) /*!< Initialization status flag */ 517 #define RTC_FLAG_SHPF (0x00000100U | RTC_ICSR_SHPF_Pos) /*!< Shift operation pending flag */ 518 #define RTC_FLAG_WUTWF (0x00000100U | RTC_ICSR_WUTWF_Pos) /*!< Wakeup timer write flag */ 519 #define RTC_FLAG_SSRUF (0x00000200U | RTC_SR_SSRUF_Pos) /*!< Clear SSR underflow flag */ 520 #define RTC_FLAG_ITSF (0x00000200U | RTC_SR_ITSF_Pos) /*!< Clear Internal Time-stamp flag */ 521 #define RTC_FLAG_TSOVF (0x00000200U | RTC_SR_TSOVF_Pos) /*!< Clear Time-stamp overflow flag */ 522 #define RTC_FLAG_TSF (0x00000200U | RTC_SR_TSF_Pos) /*!< Clear Time-stamp flag */ 523 #define RTC_FLAG_WUTF (0x00000200U | RTC_SR_WUTF_Pos) /*!< Clear Wakeup timer flag */ 524 #define RTC_FLAG_ALRBF (0x00000200U | RTC_SR_ALRBF_Pos) /*!< Clear Alarm B flag */ 525 #define RTC_FLAG_ALRAF (0x00000200U | RTC_SR_ALRAF_Pos) /*!< Clear Alarm A flag */ 526 /** 527 * @} 528 */ 529 530 /** @defgroup RTC_Clear_Flags_Definitions RTC Clear Flags Definitions 531 * @{ 532 */ 533 #define RTC_CLEAR_SSRUF RTC_SCR_CSSRUF /*!< Clear SSR underflow flag */ 534 #define RTC_CLEAR_ITSF RTC_SCR_CITSF /*!< Clear Internal Time-stamp flag */ 535 #define RTC_CLEAR_TSOVF RTC_SCR_CTSOVF /*!< Clear Time-stamp overflow flag */ 536 #define RTC_CLEAR_TSF RTC_SCR_CTSF /*!< Clear Time-stamp flag */ 537 #define RTC_CLEAR_WUTF RTC_SCR_CWUTF /*!< Clear Wakeup timer flag */ 538 #define RTC_CLEAR_ALRBF RTC_SCR_CALRBF /*!< Clear Alarm B flag */ 539 #define RTC_CLEAR_ALRAF RTC_SCR_CALRAF /*!< Clear Alarm A flag */ 540 /** 541 * @} 542 */ 543 544 /** 545 * @} 546 */ 547 548 /* Exported macros -----------------------------------------------------------*/ 549 /** @defgroup RTC_Exported_Macros RTC Exported Macros 550 * @{ 551 */ 552 553 /** @brief Reset RTC handle state 554 * @param __HANDLE__ RTC handle. 555 * @retval None 556 */ 557 #if (USE_HAL_RTC_REGISTER_CALLBACKS == 1) 558 #define __HAL_RTC_RESET_HANDLE_STATE(__HANDLE__) do{\ 559 (__HANDLE__)->State = HAL_RTC_STATE_RESET;\ 560 (__HANDLE__)->MspInitCallback = NULL;\ 561 (__HANDLE__)->MspDeInitCallback = NULL;\ 562 }while(0) 563 #else 564 #define __HAL_RTC_RESET_HANDLE_STATE(__HANDLE__) ((__HANDLE__)->State = HAL_RTC_STATE_RESET) 565 #endif /* USE_HAL_RTC_REGISTER_CALLBACKS */ 566 567 /** 568 * @brief Disable the write protection for RTC registers. 569 * @param __HANDLE__ specifies the RTC handle. 570 * @retval None 571 */ 572 #define __HAL_RTC_WRITEPROTECTION_DISABLE(__HANDLE__) \ 573 do{ \ 574 RTC->WPR = 0xCAU; \ 575 RTC->WPR = 0x53U; \ 576 } while(0U) 577 578 /** 579 * @brief Enable the write protection for RTC registers. 580 * @param __HANDLE__ specifies the RTC handle. 581 * @retval None 582 */ 583 #define __HAL_RTC_WRITEPROTECTION_ENABLE(__HANDLE__) \ 584 do{ \ 585 RTC->WPR = 0xFFU; \ 586 } while(0U) 587 588 /** 589 * @brief Add 1 hour (summer time change). 590 * @note This interface is deprecated. 591 * To manage Daylight Saving Time, please use HAL_RTC_DST_xxx functions 592 * @param __HANDLE__ specifies the RTC handle. 593 * @param __BKP__ Backup 594 * This parameter can be: 595 * @arg @ref RTC_STOREOPERATION_RESET 596 * @arg @ref RTC_STOREOPERATION_SET 597 * @retval None 598 */ 599 #define __HAL_RTC_DAYLIGHT_SAVING_TIME_ADD1H(__HANDLE__, __BKP__) \ 600 do { \ 601 __HAL_RTC_WRITEPROTECTION_DISABLE(__HANDLE__); \ 602 SET_BIT(RTC->CR, RTC_CR_ADD1H); \ 603 MODIFY_REG(RTC->CR, RTC_CR_BKP , (__BKP__)); \ 604 __HAL_RTC_WRITEPROTECTION_ENABLE(__HANDLE__); \ 605 } while(0); 606 607 /** 608 * @brief Subtract 1 hour (winter time change). 609 * @note This interface is deprecated. 610 * To manage Daylight Saving Time, please use HAL_RTC_DST_xxx functions 611 * @param __HANDLE__ specifies the RTC handle. 612 * @param __BKP__ Backup 613 * This parameter can be: 614 * @arg @ref RTC_STOREOPERATION_RESET 615 * @arg @ref RTC_STOREOPERATION_SET 616 * @retval None 617 */ 618 #define __HAL_RTC_DAYLIGHT_SAVING_TIME_SUB1H(__HANDLE__, __BKP__) \ 619 do { \ 620 __HAL_RTC_WRITEPROTECTION_DISABLE(__HANDLE__); \ 621 SET_BIT(RTC->CR, RTC_CR_SUB1H); \ 622 MODIFY_REG(RTC->CR, RTC_CR_BKP , (__BKP__)); \ 623 __HAL_RTC_WRITEPROTECTION_ENABLE(__HANDLE__); \ 624 } while(0); 625 626 /** 627 * @brief Enable the RTC ALARMA peripheral. 628 * @param __HANDLE__ specifies the RTC handle. 629 * @retval None 630 */ 631 #define __HAL_RTC_ALARMA_ENABLE(__HANDLE__) (RTC->CR |= (RTC_CR_ALRAE)) 632 633 /** 634 * @brief Disable the RTC ALARMA peripheral. 635 * @param __HANDLE__ specifies the RTC handle. 636 * @retval None 637 */ 638 #define __HAL_RTC_ALARMA_DISABLE(__HANDLE__) (RTC->CR &= ~(RTC_CR_ALRAE)) 639 640 /** 641 * @brief Enable the RTC ALARMB peripheral. 642 * @param __HANDLE__ specifies the RTC handle. 643 * @retval None 644 */ 645 #define __HAL_RTC_ALARMB_ENABLE(__HANDLE__) (RTC->CR |= (RTC_CR_ALRBE)) 646 647 /** 648 * @brief Disable the RTC ALARMB peripheral. 649 * @param __HANDLE__ specifies the RTC handle. 650 * @retval None 651 */ 652 #define __HAL_RTC_ALARMB_DISABLE(__HANDLE__) (RTC->CR &= ~(RTC_CR_ALRBE)) 653 654 /** 655 * @brief Enable the RTC Alarm interrupt. 656 * @param __HANDLE__ specifies the RTC handle. 657 * @param __INTERRUPT__ specifies the RTC Alarm interrupt sources to be enabled or disabled. 658 * This parameter can be any combination of the following values: 659 * @arg @ref RTC_IT_ALRA Alarm A interrupt 660 * @arg @ref RTC_IT_ALRB Alarm B interrupt 661 * @retval None 662 */ 663 #define __HAL_RTC_ALARM_ENABLE_IT(__HANDLE__, __INTERRUPT__)( \ 664 ((__INTERRUPT__) == RTC_IT_ALRA) ? (SET_BIT(RTC->CR, RTC_CR_ALRAIE)):\ 665 ((__INTERRUPT__) == RTC_IT_ALRB) ? (SET_BIT(RTC->CR, RTC_CR_ALRBIE)):\ 666 (0U)) /* Dummy action because is an invalid parameter value */ 667 668 /** 669 * @brief Disable the RTC Alarm interrupt. 670 * @param __HANDLE__ specifies the RTC handle. 671 * @param __INTERRUPT__ specifies the RTC Alarm interrupt sources to be enabled or disabled. 672 * This parameter can be any combination of the following values: 673 * @arg @ref RTC_IT_ALRA Alarm A interrupt 674 * @arg @ref RTC_IT_ALRB Alarm B interrupt 675 * @retval None 676 */ 677 #define __HAL_RTC_ALARM_DISABLE_IT(__HANDLE__, __INTERRUPT__)( \ 678 ((__INTERRUPT__) == RTC_IT_ALRA) ? (CLEAR_BIT(RTC->CR, RTC_CR_ALRAIE)):\ 679 ((__INTERRUPT__) == RTC_IT_ALRB) ? (CLEAR_BIT(RTC->CR, RTC_CR_ALRBIE)):\ 680 (0U)) /* Dummy action because is an invalid parameter value */ 681 682 /** 683 * @brief Check whether the specified RTC Alarm interrupt has occurred or not. 684 * @param __HANDLE__ specifies the RTC handle. 685 * @param __INTERRUPT__ specifies the RTC Alarm interrupt sources to check. 686 * This parameter can be: 687 * @arg @ref RTC_IT_ALRA Alarm A interrupt 688 * @arg @ref RTC_IT_ALRB Alarm B interrupt 689 * @retval The state of __INTERRUPT__ (TRUE or FALSE). 690 */ 691 #define __HAL_RTC_ALARM_GET_IT(__HANDLE__, __INTERRUPT__)( \ 692 ((__INTERRUPT__) == RTC_IT_ALRA) ? (READ_BIT(RTC->MISR, RTC_MISR_ALRAMF) == RTC_MISR_ALRAMF):\ 693 ((__INTERRUPT__) == RTC_IT_ALRB) ? (READ_BIT(RTC->MISR, RTC_MISR_ALRBMF) == RTC_MISR_ALRBMF):\ 694 (0U)) /* Return 0 because it is an invalid parameter value */ 695 696 /** 697 * @brief Check whether the specified RTC Alarm interrupt has been enabled or not. 698 * @param __HANDLE__ specifies the RTC handle. 699 * @param __INTERRUPT__ specifies the RTC Alarm interrupt sources to check. 700 * This parameter can be: 701 * @arg @ref RTC_IT_ALRA Alarm A interrupt 702 * @arg @ref RTC_IT_ALRB Alarm B interrupt 703 * @retval The state of __INTERRUPT__ (TRUE or FALSE). 704 */ 705 #define __HAL_RTC_ALARM_GET_IT_SOURCE(__HANDLE__, __INTERRUPT__)( \ 706 ((__INTERRUPT__) == RTC_IT_ALRA) ? (READ_BIT(RTC->CR, RTC_CR_ALRAIE) == RTC_CR_ALRAIE):\ 707 ((__INTERRUPT__) == RTC_IT_ALRB) ? (READ_BIT(RTC->CR, RTC_CR_ALRBIE) == RTC_CR_ALRBIE):\ 708 (0U)) /* Return 0 because it is an invalid parameter value */ 709 710 /** 711 * @brief Get the selected RTC Alarms flag status. 712 * @param __HANDLE__ specifies the RTC handle. 713 * @param __FLAG__ specifies the RTC Alarm Flag sources to check. 714 * This parameter can be: 715 * @arg @ref RTC_FLAG_ALRAF 716 * @arg @ref RTC_FLAG_ALRBF 717 * @retval The state of __FLAG__ (TRUE or FALSE). 718 */ 719 #define __HAL_RTC_ALARM_GET_FLAG(__HANDLE__, __FLAG__)( \ 720 ((__FLAG__) == RTC_FLAG_ALRAF) ? (READ_BIT(RTC->SR, RTC_SR_ALRAF) == RTC_SR_ALRAF):\ 721 ((__FLAG__) == RTC_FLAG_ALRBF) ? (READ_BIT(RTC->SR, RTC_SR_ALRBF) == RTC_SR_ALRBF):\ 722 (0U)) /* Return 0 because it is an invalid parameter value */ 723 724 /** 725 * @brief Clear the RTC Alarms pending flags. 726 * @param __HANDLE__ specifies the RTC handle. 727 * @param __FLAG__ specifies the RTC Alarm Flag sources to clear. 728 * This parameter can be: 729 * @arg @ref RTC_FLAG_ALRAF 730 * @arg @ref RTC_FLAG_ALRBF 731 * @retval None 732 */ 733 #define __HAL_RTC_ALARM_CLEAR_FLAG(__HANDLE__, __FLAG__)( \ 734 ((__FLAG__) == RTC_FLAG_ALRAF) ? (SET_BIT(RTC->SCR, RTC_SCR_CALRAF)):\ 735 ((__FLAG__) == RTC_FLAG_ALRBF) ? (SET_BIT(RTC->SCR, RTC_SCR_CALRBF)):\ 736 (0U)) /* Dummy action because is an invalid parameter value */ 737 738 /** 739 * @brief Check whether if the RTC Calendar is initialized. 740 * @param __HANDLE__ specifies the RTC handle. 741 * @retval The state of RTC Calendar initialization (TRUE or FALSE). 742 */ 743 #define __HAL_RTC_IS_CALENDAR_INITIALIZED(__HANDLE__) ((((RTC->ICSR) & (RTC_ICSR_INITS)) == RTC_ICSR_INITS)) 744 745 /** 746 * @brief Get RTC Binary mode. 747 * @param __HANDLE__ specifies the RTC handle. 748 * @retval The selected RTC Binary mode (RTC_BINARY_NONE, RTC_BINARY_ONLY, or RTC_BINARY_MIX). 749 */ 750 #define __HAL_RTC_GET_BINARY_MODE(__HANDLE__) (READ_REG(RTC->ICSR & RTC_ICSR_BIN)) 751 752 /** 753 * @} 754 */ 755 756 /* Include RTC HAL Extended module */ 757 #include "stm32u5xx_hal_rtc_ex.h" 758 759 /* Exported functions --------------------------------------------------------*/ 760 /** @defgroup RTC_Exported_Functions RTC Exported Functions 761 * @{ 762 */ 763 764 /** @defgroup RTC_Exported_Functions_Group1 Initialization and de-initialization functions 765 * @{ 766 */ 767 /* Initialization and de-initialization functions ****************************/ 768 HAL_StatusTypeDef HAL_RTC_Init(RTC_HandleTypeDef *hrtc); 769 HAL_StatusTypeDef HAL_RTC_DeInit(RTC_HandleTypeDef *hrtc); 770 771 void HAL_RTC_MspInit(RTC_HandleTypeDef *hrtc); 772 void HAL_RTC_MspDeInit(RTC_HandleTypeDef *hrtc); 773 774 /* Callbacks Register/UnRegister functions ***********************************/ 775 #if (USE_HAL_RTC_REGISTER_CALLBACKS == 1) 776 HAL_StatusTypeDef HAL_RTC_RegisterCallback(RTC_HandleTypeDef *hrtc, HAL_RTC_CallbackIDTypeDef CallbackID, 777 pRTC_CallbackTypeDef pCallback); 778 HAL_StatusTypeDef HAL_RTC_UnRegisterCallback(RTC_HandleTypeDef *hrtc, HAL_RTC_CallbackIDTypeDef CallbackID); 779 #endif /* USE_HAL_RTC_REGISTER_CALLBACKS */ 780 781 /** 782 * @} 783 */ 784 785 /** @defgroup RTC_Exported_Functions_Group2 RTC Time and Date functions 786 * @{ 787 */ 788 /* RTC Time and Date functions ************************************************/ 789 HAL_StatusTypeDef HAL_RTC_SetTime(RTC_HandleTypeDef *hrtc, RTC_TimeTypeDef *sTime, uint32_t Format); 790 HAL_StatusTypeDef HAL_RTC_GetTime(const RTC_HandleTypeDef *hrtc, RTC_TimeTypeDef *sTime, uint32_t Format); 791 HAL_StatusTypeDef HAL_RTC_SetDate(RTC_HandleTypeDef *hrtc, RTC_DateTypeDef *sDate, uint32_t Format); 792 HAL_StatusTypeDef HAL_RTC_GetDate(const RTC_HandleTypeDef *hrtc, RTC_DateTypeDef *sDate, uint32_t Format); 793 void HAL_RTC_DST_Add1Hour(const RTC_HandleTypeDef *hrtc); 794 void HAL_RTC_DST_Sub1Hour(const RTC_HandleTypeDef *hrtc); 795 void HAL_RTC_DST_SetStoreOperation(const RTC_HandleTypeDef *hrtc); 796 void HAL_RTC_DST_ClearStoreOperation(const RTC_HandleTypeDef *hrtc); 797 uint32_t HAL_RTC_DST_ReadStoreOperation(const RTC_HandleTypeDef *hrtc); 798 /** 799 * @} 800 */ 801 802 /** @defgroup RTC_Exported_Functions_Group3 RTC Alarm functions 803 * @{ 804 */ 805 /* RTC Alarm functions ********************************************************/ 806 HAL_StatusTypeDef HAL_RTC_SetAlarm(RTC_HandleTypeDef *hrtc, RTC_AlarmTypeDef *sAlarm, uint32_t Format); 807 HAL_StatusTypeDef HAL_RTC_SetAlarm_IT(RTC_HandleTypeDef *hrtc, RTC_AlarmTypeDef *sAlarm, uint32_t Format); 808 HAL_StatusTypeDef HAL_RTC_DeactivateAlarm(RTC_HandleTypeDef *hrtc, uint32_t Alarm); 809 HAL_StatusTypeDef HAL_RTC_GetAlarm(const RTC_HandleTypeDef *hrtc, RTC_AlarmTypeDef *sAlarm, uint32_t Alarm, 810 uint32_t Format); 811 void HAL_RTC_AlarmIRQHandler(RTC_HandleTypeDef *hrtc); 812 HAL_StatusTypeDef HAL_RTC_PollForAlarmAEvent(const RTC_HandleTypeDef *hrtc, uint32_t Timeout); 813 void HAL_RTC_AlarmAEventCallback(RTC_HandleTypeDef *hrtc); 814 /** 815 * @} 816 */ 817 818 /** @defgroup RTC_Exported_Functions_Group4 Peripheral Control functions 819 * @{ 820 */ 821 /* Peripheral Control functions ***********************************************/ 822 HAL_StatusTypeDef HAL_RTC_WaitForSynchro(RTC_HandleTypeDef *hrtc); 823 /** 824 * @} 825 */ 826 827 /** @defgroup RTC_Exported_Functions_Group5 Peripheral State functions 828 * @{ 829 */ 830 /* Peripheral State functions *************************************************/ 831 HAL_RTCStateTypeDef HAL_RTC_GetState(const RTC_HandleTypeDef *hrtc); 832 /** 833 * @} 834 */ 835 836 /** 837 * @} 838 */ 839 840 /* Private types -------------------------------------------------------------*/ 841 /* Private variables ---------------------------------------------------------*/ 842 /* Private constants ---------------------------------------------------------*/ 843 /** @defgroup RTC_Private_Constants RTC Private Constants 844 * @{ 845 */ 846 /* Masks Definition */ 847 #define RTC_TR_RESERVED_MASK (RTC_TR_PM | RTC_TR_HT | RTC_TR_HU | \ 848 RTC_TR_MNT | RTC_TR_MNU| RTC_TR_ST | \ 849 RTC_TR_SU) 850 #define RTC_DR_RESERVED_MASK (RTC_DR_YT | RTC_DR_YU | RTC_DR_WDU | \ 851 RTC_DR_MT | RTC_DR_MU | RTC_DR_DT | \ 852 RTC_DR_DU) 853 #define RTC_INIT_MASK 0xFFFFFFFFU 854 #define RTC_RSF_MASK (~(RTC_ICSR_INIT | RTC_ICSR_RSF)) 855 856 #define RTC_TIMEOUT_VALUE 1000U 857 858 /** 859 * @} 860 */ 861 862 /* Private macros ------------------------------------------------------------*/ 863 /** @defgroup RTC_Private_Macros RTC Private Macros 864 * @{ 865 */ 866 867 /** @defgroup RTC_IS_RTC_Definitions RTC Private macros to check input parameters 868 * @{ 869 */ 870 #define IS_RTC_OUTPUT(OUTPUT) (((OUTPUT) == RTC_OUTPUT_DISABLE) || \ 871 ((OUTPUT) == RTC_OUTPUT_ALARMA) || \ 872 ((OUTPUT) == RTC_OUTPUT_ALARMB) || \ 873 ((OUTPUT) == RTC_OUTPUT_WAKEUP) || \ 874 ((OUTPUT) == RTC_OUTPUT_TAMPER)) 875 876 #define IS_RTC_HOUR_FORMAT(FORMAT) (((FORMAT) == RTC_HOURFORMAT_12) || \ 877 ((FORMAT) == RTC_HOURFORMAT_24)) 878 879 #define IS_RTC_OUTPUT_POL(POL) (((POL) == RTC_OUTPUT_POLARITY_HIGH) || \ 880 ((POL) == RTC_OUTPUT_POLARITY_LOW)) 881 882 #define IS_RTC_OUTPUT_TYPE(TYPE) (((TYPE) == RTC_OUTPUT_TYPE_OPENDRAIN) || \ 883 ((TYPE) == RTC_OUTPUT_TYPE_PUSHPULL)) 884 885 #define IS_RTC_OUTPUT_PULLUP(TYPE) (((TYPE) == RTC_OUTPUT_PULLUP_NONE) || \ 886 ((TYPE) == RTC_OUTPUT_PULLUP_ON)) 887 888 #define IS_RTC_OUTPUT_REMAP(REMAP) (((REMAP) == RTC_OUTPUT_REMAP_NONE) || \ 889 ((REMAP) == RTC_OUTPUT_REMAP_POS1)) 890 891 #define IS_RTC_HOURFORMAT12(PM) (((PM) == RTC_HOURFORMAT12_AM) || \ 892 ((PM) == RTC_HOURFORMAT12_PM)) 893 894 #define IS_RTC_DAYLIGHT_SAVING(SAVE) (((SAVE) == RTC_DAYLIGHTSAVING_SUB1H) || \ 895 ((SAVE) == RTC_DAYLIGHTSAVING_ADD1H) || \ 896 ((SAVE) == RTC_DAYLIGHTSAVING_NONE)) 897 898 #define IS_RTC_STORE_OPERATION(OPERATION) (((OPERATION) == RTC_STOREOPERATION_RESET) || \ 899 ((OPERATION) == RTC_STOREOPERATION_SET)) 900 901 #define IS_RTC_FORMAT(FORMAT) (((FORMAT) == RTC_FORMAT_BIN) || \ 902 ((FORMAT) == RTC_FORMAT_BCD)) 903 904 #define IS_RTC_YEAR(YEAR) ((YEAR) <= 99U) 905 906 #define IS_RTC_MONTH(MONTH) (((MONTH) >= 1U) && ((MONTH) <= 12U)) 907 908 #define IS_RTC_DATE(DATE) (((DATE) >= 1U) && ((DATE) <= 31U)) 909 910 #define IS_RTC_WEEKDAY(WEEKDAY) (((WEEKDAY) == RTC_WEEKDAY_MONDAY) || \ 911 ((WEEKDAY) == RTC_WEEKDAY_TUESDAY) || \ 912 ((WEEKDAY) == RTC_WEEKDAY_WEDNESDAY) || \ 913 ((WEEKDAY) == RTC_WEEKDAY_THURSDAY) || \ 914 ((WEEKDAY) == RTC_WEEKDAY_FRIDAY) || \ 915 ((WEEKDAY) == RTC_WEEKDAY_SATURDAY) || \ 916 ((WEEKDAY) == RTC_WEEKDAY_SUNDAY)) 917 918 #define IS_RTC_ALARM_DATE_WEEKDAY_DATE(DATE) (((DATE) > 0U) && ((DATE) <= 31U)) 919 920 #define IS_RTC_ALARM_DATE_WEEKDAY_WEEKDAY(WEEKDAY) (((WEEKDAY) == RTC_WEEKDAY_MONDAY) || \ 921 ((WEEKDAY) == RTC_WEEKDAY_TUESDAY) || \ 922 ((WEEKDAY) == RTC_WEEKDAY_WEDNESDAY) || \ 923 ((WEEKDAY) == RTC_WEEKDAY_THURSDAY) || \ 924 ((WEEKDAY) == RTC_WEEKDAY_FRIDAY) || \ 925 ((WEEKDAY) == RTC_WEEKDAY_SATURDAY) || \ 926 ((WEEKDAY) == RTC_WEEKDAY_SUNDAY)) 927 928 #define IS_RTC_ALARM_DATE_WEEKDAY_SEL(SEL) (((SEL) == RTC_ALARMDATEWEEKDAYSEL_DATE) || \ 929 ((SEL) == RTC_ALARMDATEWEEKDAYSEL_WEEKDAY)) 930 931 #define IS_RTC_ALARM_MASK(MASK) (((MASK) & ~(RTC_ALARMMASK_ALL)) == 0UL) 932 933 #define IS_RTC_ALARM(ALARM) (((ALARM) == RTC_ALARM_A) || \ 934 ((ALARM) == RTC_ALARM_B)) 935 936 #define IS_RTC_ALARM_SUB_SECOND_VALUE(VALUE) ((VALUE) <= RTC_ALRMASSR_SS) 937 938 #define IS_RTC_ALARM_SUB_SECOND_MASK(MASK) (((MASK) == 0UL) || \ 939 (((MASK) >= RTC_ALARMSUBSECONDMASK_SS14_1) && \ 940 ((MASK) <= RTC_ALARMSUBSECONDMASK_NONE))) 941 942 #define IS_RTC_ASYNCH_PREDIV(PREDIV) ((PREDIV) <= (RTC_PRER_PREDIV_A >> RTC_PRER_PREDIV_A_Pos)) 943 944 #define IS_RTC_SYNCH_PREDIV(PREDIV) ((PREDIV) <= (RTC_PRER_PREDIV_S >> RTC_PRER_PREDIV_S_Pos)) 945 946 #define IS_RTC_HOUR12(HOUR) (((HOUR) > 0U) && ((HOUR) <= 12U)) 947 948 #define IS_RTC_HOUR24(HOUR) ((HOUR) <= 23U) 949 950 #define IS_RTC_MINUTES(MINUTES) ((MINUTES) <= 59U) 951 952 #define IS_RTC_SECONDS(SECONDS) ((SECONDS) <= 59U) 953 954 /** 955 * @} 956 */ 957 958 /** 959 * @} 960 */ 961 962 /* Private functions -------------------------------------------------------------*/ 963 /** @defgroup RTC_Private_Functions RTC Private Functions 964 * @{ 965 */ 966 HAL_StatusTypeDef RTC_EnterInitMode(RTC_HandleTypeDef *hrtc); 967 HAL_StatusTypeDef RTC_ExitInitMode(RTC_HandleTypeDef *hrtc); 968 uint8_t RTC_ByteToBcd2(uint8_t Value); 969 uint8_t RTC_Bcd2ToByte(uint8_t Value); 970 /** 971 * @} 972 */ 973 974 /** 975 * @} 976 */ 977 978 /** 979 * @} 980 */ 981 982 /** 983 * @} 984 */ 985 986 #ifdef __cplusplus 987 } 988 #endif 989 990 #endif /* STM32U5xx_HAL_RTC_H */ 991
