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