tool/mbed/mbed-sdk/libraries/mbed/targets/cmsis/TARGET_STM/TARGET_STM32F3/stm32f3xx_hal_rtc.h

   1 /**
   2   ******************************************************************************
   3   * @file    stm32f3xx_hal_rtc.h
   4   * @author  MCD Application Team
   5   * @version V1.1.0
   6   * @date    12-Sept-2014
   7   * @brief   Header file of RTC HAL module.
   8   ******************************************************************************
   9   * @attention
  10   *
  11   * <h2><center>&copy; COPYRIGHT(c) 2014 STMicroelectronics</center></h2>
  12   *
  13   * Redistribution and use in source and binary forms, with or without modification,
  14   * are permitted provided that the following conditions are met:
  15   *   1. Redistributions of source code must retain the above copyright notice,
  16   *      this list of conditions and the following disclaimer.
  17   *   2. Redistributions in binary form must reproduce the above copyright notice,
  18   *      this list of conditions and the following disclaimer in the documentation
  19   *      and/or other materials provided with the distribution.
  20   *   3. Neither the name of STMicroelectronics nor the names of its contributors
  21   *      may be used to endorse or promote products derived from this software
  22   *      without specific prior written permission.
  23   *
  24   * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  25   * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  26   * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  27   * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
  28   * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  29   * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
  30   * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
  31   * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  32   * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  33   * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  34   *
  35   ******************************************************************************
  36   */
  37
  38 /* Define to prevent recursive inclusion -------------------------------------*/
  39 #ifndef __STM32F3xx_HAL_RTC_H
  40 #define __STM32F3xx_HAL_RTC_H
  41
  42 #ifdef __cplusplus
  43  extern "C" {
  44 #endif
  45
  46 /* Includes ------------------------------------------------------------------*/
  47 #include "stm32f3xx_hal_def.h"
  48
  49 /** @addtogroup STM32F3xx_HAL_Driver
  50   * @{
  51   */
  52
  53 /** @addtogroup RTC RTC HAL module driver
  54   * @{
  55   */
  56
  57 /* Exported types ------------------------------------------------------------*/
  58 /** @defgroup RTC_Exported_Types RTC Exported Types
  59   * @{
  60   */
  61
  62 /**
  63   * @brief  HAL State structures definition
  64   */
  65 typedef enum
  66 {
  67   HAL_RTC_STATE_RESET             = 0x00,  /*!< RTC not yet initialized or disabled */
  68   HAL_RTC_STATE_READY             = 0x01,  /*!< RTC initialized and ready for use   */
  69   HAL_RTC_STATE_BUSY              = 0x02,  /*!< RTC process is ongoing              */
  70   HAL_RTC_STATE_TIMEOUT           = 0x03,  /*!< RTC timeout state                   */
  71   HAL_RTC_STATE_ERROR             = 0x04   /*!< RTC error state                     */
  72
  73 }HAL_RTCStateTypeDef;
  74
  75 /**
  76   * @brief  RTC Configuration Structure definition
  77   */
  78 typedef struct
  79 {
  80   uint32_t HourFormat;      /*!< Specifies the RTC Hour Format.
  81                                  This parameter can be a value of @ref RTC_Hour_Formats */
  82
  83   uint32_t AsynchPrediv;    /*!< Specifies the RTC Asynchronous Predivider value.
  84                                  This parameter must be a number between Min_Data = 0x00 and Max_Data = 0x7F */
  85
  86   uint32_t SynchPrediv;     /*!< Specifies the RTC Synchronous Predivider value.
  87                                  This parameter must be a number between Min_Data = 0x00 and Max_Data = 0x7FFF */
  88
  89   uint32_t OutPut;          /*!< Specifies which signal will be routed to the RTC output.
  90                                  This parameter can be a value of @ref RTCEx_Output_selection_Definitions */
  91
  92   uint32_t OutPutPolarity;  /*!< Specifies the polarity of the output signal.
  93                                  This parameter can be a value of @ref RTC_Output_Polarity_Definitions */
  94
  95   uint32_t OutPutType;      /*!< Specifies the RTC Output Pin mode.
  96                                  This parameter can be a value of @ref RTC_Output_Type_ALARM_OUT */
  97 }RTC_InitTypeDef;
  98
  99 /**
 100   * @brief  RTC Time structure definition
 101   */
 102 typedef struct
 103 {
 104   uint8_t Hours;            /*!< Specifies the RTC Time Hour.
 105                                  This parameter must be a number between Min_Data = 0 and Max_Data = 12 if the RTC_HourFormat_12 is selected.
 106                                  This parameter must be a number between Min_Data = 0 and Max_Data = 23 if the RTC_HourFormat_24 is selected */
 107
 108   uint8_t Minutes;          /*!< Specifies the RTC Time Minutes.
 109                                  This parameter must be a number between Min_Data = 0 and Max_Data = 59 */
 110
 111   uint8_t Seconds;          /*!< Specifies the RTC Time Seconds.
 112                                  This parameter must be a number between Min_Data = 0 and Max_Data = 59 */
 113
 114   uint32_t SubSeconds;      /*!< Specifies the RTC Time SubSeconds.
 115                                  This parameter must be a number between Min_Data = 0 and Max_Data = 59 */
 116
 117   uint8_t TimeFormat;       /*!< Specifies the RTC AM/PM Time.
 118                                  This parameter can be a value of @ref RTC_AM_PM_Definitions */
 119
 120   uint32_t DayLightSaving;  /*!< Specifies RTC_DayLightSaveOperation: the value of hour adjustment.
 121                                  This parameter can be a value of @ref RTC_DayLightSaving_Definitions */
 122
 123   uint32_t StoreOperation;  /*!< Specifies RTC_StoreOperation value to be written in the BCK bit
 124                                  in CR register to store the operation.
 125                                  This parameter can be a value of @ref RTC_StoreOperation_Definitions */
 126 }RTC_TimeTypeDef;
 127
 128 /**
 129   * @brief  RTC Date structure definition
 130   */
 131 typedef struct
 132 {
 133   uint8_t WeekDay;  /*!< Specifies the RTC Date WeekDay.
 134                          This parameter can be a value of @ref RTC_WeekDay_Definitions */
 135
 136   uint8_t Month;    /*!< Specifies the RTC Date Month (in BCD format).
 137                          This parameter can be a value of @ref RTC_Month_Date_Definitions */
 138
 139   uint8_t Date;     /*!< Specifies the RTC Date.
 140                          This parameter must be a number between Min_Data = 1 and Max_Data = 31 */
 141
 142   uint8_t Year;     /*!< Specifies the RTC Date Year.
 143                          This parameter must be a number between Min_Data = 0 and Max_Data = 99 */
 144
 145 }RTC_DateTypeDef;
 146
 147 /**
 148   * @brief  RTC Alarm structure definition
 149   */
 150 typedef struct
 151 {
 152   RTC_TimeTypeDef AlarmTime;     /*!< Specifies the RTC Alarm Time members */
 153
 154   uint32_t AlarmMask;            /*!< Specifies the RTC Alarm Masks.
 155                                       This parameter can be a value of @ref RTC_AlarmMask_Definitions */
 156
 157   uint32_t AlarmSubSecondMask;   /*!< Specifies the RTC Alarm SubSeconds Masks.
 158                                       This parameter can be a value of @ref RTC_Alarm_Sub_Seconds_Masks_Definitions */
 159
 160   uint32_t AlarmDateWeekDaySel;  /*!< Specifies the RTC Alarm is on Date or WeekDay.
 161                                       This parameter can be a value of @ref RTC_AlarmDateWeekDay_Definitions */
 162
 163   uint8_t AlarmDateWeekDay;      /*!< Specifies the RTC Alarm Date/WeekDay.
 164                                       If the Alarm Date is selected, this parameter must be set to a value in the 1-31 range.
 165                                       If the Alarm WeekDay is selected, this parameter can be a value of @ref RTC_WeekDay_Definitions */
 166
 167   uint32_t Alarm;                /*!< Specifies the alarm .
 168                                       This parameter can be a value of @ref RTC_Alarms_Definitions */
 169 }RTC_AlarmTypeDef;
 170
 171 /**
 172   * @brief  Time Handle Structure definition
 173   */
 174 typedef struct
 175 {
 176   RTC_TypeDef               *Instance;  /*!< Register base address    */
 177
 178   RTC_InitTypeDef           Init;       /*!< RTC required parameters  */
 179
 180   HAL_LockTypeDef           Lock;       /*!< RTC locking object       */
 181
 182   __IO HAL_RTCStateTypeDef  State;      /*!< Time communication state */
 183
 184 }RTC_HandleTypeDef;
 185 /**
 186   * @}
 187   */
 188
 189 /* Exported constants --------------------------------------------------------*/
 190 /** @defgroup RTC_Exported_Constants RTC Exported Constants
 191   * @{
 192   */
 193
 194 /** @defgroup RTC_Mask_Definition RTC Mask Definition
 195   * @{
 196   */
 197 /* Masks Definition */
 198 #define RTC_TR_RESERVED_MASK    ((uint32_t)0x007F7F7F)
 199 #define RTC_DR_RESERVED_MASK    ((uint32_t)0x00FFFF3F)
 200 #define RTC_INIT_MASK           ((uint32_t)0xFFFFFFFF)
 201 #define RTC_RSF_MASK            ((uint32_t)0xFFFFFF5F)
 202 #define RTC_FLAGS_MASK          ((uint32_t)(RTC_FLAG_TSOVF | RTC_FLAG_TSF | RTC_FLAG_WUTF | \
 203                                             RTC_FLAG_ALRBF | RTC_FLAG_ALRAF | RTC_FLAG_INITF | \
 204                                             RTC_FLAG_RSF | RTC_FLAG_INITS | RTC_FLAG_WUTWF | \
 205                                             RTC_FLAG_ALRBWF | RTC_FLAG_ALRAWF | RTC_FLAG_TAMP1F | \
 206                                             RTC_FLAG_RECALPF | RTC_FLAG_SHPF))
 207
 208 #define RTC_TIMEOUT_VALUE  1000
 209 /**
 210   * @}
 211   */
 212
 213 /** @defgroup RTC_Hour_Formats RTC Hour Formats
 214   * @{
 215   */
 216 #define RTC_HOURFORMAT_24              ((uint32_t)0x00000000)
 217 #define RTC_HOURFORMAT_12              ((uint32_t)0x00000040)
 218
 219 #define IS_RTC_HOUR_FORMAT(FORMAT)     (((FORMAT) == RTC_HOURFORMAT_12) || \
 220                                         ((FORMAT) == RTC_HOURFORMAT_24))
 221 /**
 222   * @}
 223   */
 224
 225 /** @defgroup RTC_Output_Polarity_Definitions RTC Output Polarity Definitions
 226   * @{
 227   */
 228 #define RTC_OUTPUT_POLARITY_HIGH       ((uint32_t)0x00000000)
 229 #define RTC_OUTPUT_POLARITY_LOW        ((uint32_t)0x00100000)
 230
 231 #define IS_RTC_OUTPUT_POL(POL) (((POL) == RTC_OUTPUT_POLARITY_HIGH) || \
 232                                 ((POL) == RTC_OUTPUT_POLARITY_LOW))
 233 /**
 234   * @}
 235   */
 236
 237 /** @defgroup RTC_Output_Type_ALARM_OUT RTC Output Type ALARM OUT
 238   * @{
 239   */
 240 #define RTC_OUTPUT_TYPE_OPENDRAIN      ((uint32_t)0x00000000)
 241 #define RTC_OUTPUT_TYPE_PUSHPULL       ((uint32_t)0x00040000)
 242
 243 #define IS_RTC_OUTPUT_TYPE(TYPE) (((TYPE) == RTC_OUTPUT_TYPE_OPENDRAIN) || \
 244                                   ((TYPE) == RTC_OUTPUT_TYPE_PUSHPULL))
 245
 246 /**
 247   * @}
 248   */
 249
 250 /** @defgroup RTC_Asynchronous_Predivider RTC Asynchronous Predivider
 251   * @{
 252   */
 253 #define IS_RTC_ASYNCH_PREDIV(PREDIV)   ((PREDIV) <= (uint32_t)0x7F)
 254 /**
 255   * @}
 256   */
 257
 258 /** @defgroup RTC_Synchronous_Predivider RTC Synchronous Predivider
 259   * @{
 260   */
 261 #define IS_RTC_SYNCH_PREDIV(PREDIV)    ((PREDIV) <= (uint32_t)0x7FFF)
 262 /**
 263   * @}
 264   */
 265
 266 /** @defgroup RTC_Time_Definitions RTC Time Definitions
 267   * @{
 268   */
 269 #define IS_RTC_HOUR12(HOUR)            (((HOUR) > (uint32_t)0) && ((HOUR) <= (uint32_t)12))
 270 #define IS_RTC_HOUR24(HOUR)            ((HOUR) <= (uint32_t)23)
 271 #define IS_RTC_MINUTES(MINUTES)        ((MINUTES) <= (uint32_t)59)
 272 #define IS_RTC_SECONDS(SECONDS)        ((SECONDS) <= (uint32_t)59)
 273 /**
 274   * @}
 275   */
 276
 277 /** @defgroup RTC_AM_PM_Definitions RTC AM PM Definitions
 278   * @{
 279   */
 280 #define RTC_HOURFORMAT12_AM            ((uint8_t)0x00)
 281 #define RTC_HOURFORMAT12_PM            ((uint8_t)0x40)
 282
 283 #define IS_RTC_HOURFORMAT12(PM)  (((PM) == RTC_HOURFORMAT12_AM) || ((PM) == RTC_HOURFORMAT12_PM))
 284 /**
 285   * @}
 286   */
 287
 288 /** @defgroup RTC_DayLightSaving_Definitions RTC DayLightSaving Definitions
 289   * @{
 290   */
 291 #define RTC_DAYLIGHTSAVING_SUB1H       ((uint32_t)0x00020000)
 292 #define RTC_DAYLIGHTSAVING_ADD1H       ((uint32_t)0x00010000)
 293 #define RTC_DAYLIGHTSAVING_NONE        ((uint32_t)0x00000000)
 294
 295 #define IS_RTC_DAYLIGHT_SAVING(SAVE) (((SAVE) == RTC_DAYLIGHTSAVING_SUB1H) || \
 296                                       ((SAVE) == RTC_DAYLIGHTSAVING_ADD1H) || \
 297                                       ((SAVE) == RTC_DAYLIGHTSAVING_NONE))
 298 /**
 299   * @}
 300   */
 301
 302 /** @defgroup RTC_StoreOperation_Definitions RTC StoreOperation Definitions
 303   * @{
 304   */
 305 #define RTC_STOREOPERATION_RESET        ((uint32_t)0x00000000)
 306 #define RTC_STOREOPERATION_SET          ((uint32_t)0x00040000)
 307
 308 #define IS_RTC_STORE_OPERATION(OPERATION) (((OPERATION) == RTC_STOREOPERATION_RESET) || \
 309                                            ((OPERATION) == RTC_STOREOPERATION_SET))
 310 /**
 311   * @}
 312   */
 313
 314 /** @defgroup RTC_Input_parameter_format_definitions RTC Input parameter format definitions
 315   * @{
 316   */
 317 #define FORMAT_BIN                      ((uint32_t)0x000000000)
 318 #define FORMAT_BCD                      ((uint32_t)0x000000001)
 319
 320 #define IS_RTC_FORMAT(FORMAT) (((FORMAT) == FORMAT_BIN) || ((FORMAT) == FORMAT_BCD))
 321 /**
 322   * @}
 323   */
 324
 325 /** @defgroup RTC_Year_Date_Definitions RTC Year Date Definitions
 326   * @{
 327   */
 328 #define IS_RTC_YEAR(YEAR)              ((YEAR) <= (uint32_t)99)
 329 /**
 330   * @}
 331   */
 332
 333 /** @defgroup RTC_Month_Date_Definitions RTC Month Date Definitions
 334   * @{
 335   */
 336
 337 /* Coded in BCD format */
 338 #define RTC_MONTH_JANUARY              ((uint8_t)0x01)
 339 #define RTC_MONTH_FEBRUARY             ((uint8_t)0x02)
 340 #define RTC_MONTH_MARCH                ((uint8_t)0x03)
 341 #define RTC_MONTH_APRIL                ((uint8_t)0x04)
 342 #define RTC_MONTH_MAY                  ((uint8_t)0x05)
 343 #define RTC_MONTH_JUNE                 ((uint8_t)0x06)
 344 #define RTC_MONTH_JULY                 ((uint8_t)0x07)
 345 #define RTC_MONTH_AUGUST               ((uint8_t)0x08)
 346 #define RTC_MONTH_SEPTEMBER            ((uint8_t)0x09)
 347 #define RTC_MONTH_OCTOBER              ((uint8_t)0x10)
 348 #define RTC_MONTH_NOVEMBER             ((uint8_t)0x11)
 349 #define RTC_MONTH_DECEMBER             ((uint8_t)0x12)
 350
 351 #define IS_RTC_MONTH(MONTH)            (((MONTH) >= (uint32_t)1) && ((MONTH) <= (uint32_t)12))
 352 #define IS_RTC_DATE(DATE)              (((DATE) >= (uint32_t)1) && ((DATE) <= (uint32_t)31))
 353 /**
 354   * @}
 355   */
 356
 357 /** @defgroup RTC_WeekDay_Definitions RTC WeekDay Definitions
 358   * @{
 359   */
 360 #define RTC_WEEKDAY_MONDAY             ((uint8_t)0x01)
 361 #define RTC_WEEKDAY_TUESDAY            ((uint8_t)0x02)
 362 #define RTC_WEEKDAY_WEDNESDAY          ((uint8_t)0x03)
 363 #define RTC_WEEKDAY_THURSDAY           ((uint8_t)0x04)
 364 #define RTC_WEEKDAY_FRIDAY             ((uint8_t)0x05)
 365 #define RTC_WEEKDAY_SATURDAY           ((uint8_t)0x06)
 366 #define RTC_WEEKDAY_SUNDAY             ((uint8_t)0x07)
 367
 368 #define IS_RTC_WEEKDAY(WEEKDAY) (((WEEKDAY) == RTC_WEEKDAY_MONDAY)    || \
 369                                  ((WEEKDAY) == RTC_WEEKDAY_TUESDAY)   || \
 370                                  ((WEEKDAY) == RTC_WEEKDAY_WEDNESDAY) || \
 371                                  ((WEEKDAY) == RTC_WEEKDAY_THURSDAY)  || \
 372                                  ((WEEKDAY) == RTC_WEEKDAY_FRIDAY)    || \
 373                                  ((WEEKDAY) == RTC_WEEKDAY_SATURDAY)  || \
 374                                  ((WEEKDAY) == RTC_WEEKDAY_SUNDAY))
 375 /**
 376   * @}
 377   */
 378
 379 /** @defgroup RTC_Alarm_Definitions RTC Alarm Definitions
 380   * @{
 381   */
 382 #define IS_RTC_ALARM_DATE_WEEKDAY_DATE(DATE) (((DATE) >(uint32_t) 0) && ((DATE) <= (uint32_t)31))
 383 #define IS_RTC_ALARM_DATE_WEEKDAY_WEEKDAY(WEEKDAY) (((WEEKDAY) == RTC_WEEKDAY_MONDAY)    || \
 384                                                     ((WEEKDAY) == RTC_WEEKDAY_TUESDAY)   || \
 385                                                     ((WEEKDAY) == RTC_WEEKDAY_WEDNESDAY) || \
 386                                                     ((WEEKDAY) == RTC_WEEKDAY_THURSDAY)  || \
 387                                                     ((WEEKDAY) == RTC_WEEKDAY_FRIDAY)    || \
 388                                                     ((WEEKDAY) == RTC_WEEKDAY_SATURDAY)  || \
 389                                                     ((WEEKDAY) == RTC_WEEKDAY_SUNDAY))
 390 /**
 391   * @}
 392   */
 393
 394 /** @defgroup RTC_AlarmDateWeekDay_Definitions RTC AlarmDateWeekDay Definitions
 395   * @{
 396   */
 397 #define RTC_ALARMDATEWEEKDAYSEL_DATE      ((uint32_t)0x00000000)
 398 #define RTC_ALARMDATEWEEKDAYSEL_WEEKDAY   ((uint32_t)0x40000000)
 399
 400 #define IS_RTC_ALARM_DATE_WEEKDAY_SEL(SEL) (((SEL) == RTC_ALARMDATEWEEKDAYSEL_DATE) || \
 401                                             ((SEL) == RTC_ALARMDATEWEEKDAYSEL_WEEKDAY))
 402 /**
 403   * @}
 404   */
 405
 406 /** @defgroup RTC_AlarmMask_Definitions RTC AlarmMask Definitions
 407   * @{
 408   */
 409 #define RTC_ALARMMASK_NONE                ((uint32_t)0x00000000)
 410 #define RTC_ALARMMASK_DATEWEEKDAY         RTC_ALRMAR_MSK4
 411 #define RTC_ALARMMASK_HOURS               RTC_ALRMAR_MSK3
 412 #define RTC_ALARMMASK_MINUTES             RTC_ALRMAR_MSK2
 413 #define RTC_ALARMMASK_SECONDS             RTC_ALRMAR_MSK1
 414 #define RTC_ALARMMASK_ALL                 ((uint32_t)0x80808080)
 415
 416 #define IS_ALARM_MASK(MASK)  (((MASK) & 0x7F7F7F7F) == (uint32_t)RESET)
 417 /**
 418   * @}
 419   */
 420
 421 /** @defgroup RTC_Alarms_Definitions RTC Alarms Definitions
 422   * @{
 423   */
 424 #define RTC_ALARM_A                       RTC_CR_ALRAE
 425 #define RTC_ALARM_B                       RTC_CR_ALRBE
 426
 427 #define IS_ALARM(ALARM)      (((ALARM) == RTC_ALARM_A) || ((ALARM) == RTC_ALARM_B))
 428 /**
 429   * @}
 430   */
 431
 432 /** @defgroup RTC_Alarm_Sub_Seconds_Value RTC Alarm Sub Seconds Value
 433   * @{
 434   */
 435 #define IS_RTC_ALARM_SUB_SECOND_VALUE(VALUE) ((VALUE) <= (uint32_t)0x00007FFF)
 436 /**
 437   * @}
 438   */
 439
 440   /** @defgroup RTC_Alarm_Sub_Seconds_Masks_Definitions RTC Alarm Sub Seconds Masks Definitions
 441   * @{
 442   */
 443 #define RTC_ALARMSUBSECONDMASK_ALL         ((uint32_t)0x00000000)  /*!< All Alarm SS fields are masked.
 444                                                                         There is no comparison on sub seconds
 445                                                                         for Alarm */
 446 #define RTC_ALARMSUBSECONDMASK_SS14_1      ((uint32_t)0x01000000)  /*!< SS[14:1] are don't care in Alarm
 447                                                                         comparison. Only SS[0] is compared.    */
 448 #define RTC_ALARMSUBSECONDMASK_SS14_2      ((uint32_t)0x02000000)  /*!< SS[14:2] are don't care in Alarm
 449                                                                         comparison. Only SS[1:0] are compared  */
 450 #define RTC_ALARMSUBSECONDMASK_SS14_3      ((uint32_t)0x03000000)  /*!< SS[14:3] are don't care in Alarm
 451                                                                         comparison. Only SS[2:0] are compared  */
 452 #define RTC_ALARMSUBSECONDMASK_SS14_4      ((uint32_t)0x04000000)  /*!< SS[14:4] are don't care in Alarm
 453                                                                         comparison. Only SS[3:0] are compared  */
 454 #define RTC_ALARMSUBSECONDMASK_SS14_5      ((uint32_t)0x05000000)  /*!< SS[14:5] are don't care in Alarm
 455                                                                         comparison. Only SS[4:0] are compared  */
 456 #define RTC_ALARMSUBSECONDMASK_SS14_6      ((uint32_t)0x06000000)  /*!< SS[14:6] are don't care in Alarm
 457                                                                         comparison. Only SS[5:0] are compared  */
 458 #define RTC_ALARMSUBSECONDMASK_SS14_7      ((uint32_t)0x07000000)  /*!< SS[14:7] are don't care in Alarm
 459                                                                         comparison. Only SS[6:0] are compared  */
 460 #define RTC_ALARMSUBSECONDMASK_SS14_8      ((uint32_t)0x08000000)  /*!< SS[14:8] are don't care in Alarm
 461                                                                         comparison. Only SS[7:0] are compared  */
 462 #define RTC_ALARMSUBSECONDMASK_SS14_9      ((uint32_t)0x09000000)  /*!< SS[14:9] are don't care in Alarm
 463                                                                         comparison. Only SS[8:0] are compared  */
 464 #define RTC_ALARMSUBSECONDMASK_SS14_10     ((uint32_t)0x0A000000)  /*!< SS[14:10] are don't care in Alarm
 465                                                                         comparison. Only SS[9:0] are compared  */
 466 #define RTC_ALARMSUBSECONDMASK_SS14_11     ((uint32_t)0x0B000000)  /*!< SS[14:11] are don't care in Alarm
 467                                                                         comparison. Only SS[10:0] are compared */
 468 #define RTC_ALARMSUBSECONDMASK_SS14_12     ((uint32_t)0x0C000000)  /*!< SS[14:12] are don't care in Alarm
 469                                                                         comparison.Only SS[11:0] are compared  */
 470 #define RTC_ALARMSUBSECONDMASK_SS14_13     ((uint32_t)0x0D000000)  /*!< SS[14:13] are don't care in Alarm
 471                                                                         comparison. Only SS[12:0] are compared */
 472 #define RTC_ALARMSUBSECONDMASK_SS14        ((uint32_t)0x0E000000)  /*!< SS[14] is don't care in Alarm
 473                                                                         comparison.Only SS[13:0] are compared  */
 474 #define RTC_ALARMSUBSECONDMASK_None        ((uint32_t)0x0F000000)  /*!< SS[14:0] are compared and must match
 475                                                                         to activate alarm. */
 476
 477 #define IS_RTC_ALARM_SUB_SECOND_MASK(MASK)   (((MASK) == RTC_ALARMSUBSECONDMASK_ALL) || \
 478                                               ((MASK) == RTC_ALARMSUBSECONDMASK_SS14_1) || \
 479                                               ((MASK) == RTC_ALARMSUBSECONDMASK_SS14_2) || \
 480                                               ((MASK) == RTC_ALARMSUBSECONDMASK_SS14_3) || \
 481                                               ((MASK) == RTC_ALARMSUBSECONDMASK_SS14_4) || \
 482                                               ((MASK) == RTC_ALARMSUBSECONDMASK_SS14_5) || \
 483                                               ((MASK) == RTC_ALARMSUBSECONDMASK_SS14_6) || \
 484                                               ((MASK) == RTC_ALARMSUBSECONDMASK_SS14_7) || \
 485                                               ((MASK) == RTC_ALARMSUBSECONDMASK_SS14_8) || \
 486                                               ((MASK) == RTC_ALARMSUBSECONDMASK_SS14_9) || \
 487                                               ((MASK) == RTC_ALARMSUBSECONDMASK_SS14_10) || \
 488                                               ((MASK) == RTC_ALARMSUBSECONDMASK_SS14_11) || \
 489                                               ((MASK) == RTC_ALARMSUBSECONDMASK_SS14_12) || \
 490                                               ((MASK) == RTC_ALARMSUBSECONDMASK_SS14_13) || \
 491                                               ((MASK) == RTC_ALARMSUBSECONDMASK_SS14) || \
 492                                               ((MASK) == RTC_ALARMSUBSECONDMASK_None))
 493 /**
 494   * @}
 495   */
 496
 497 /** @defgroup RTC_Interrupts_Definitions RTC Interrupts Definitions
 498   * @{
 499   */
 500 #define RTC_IT_TS                         ((uint32_t)0x00008000)
 501 #define RTC_IT_WUT                        ((uint32_t)0x00004000)
 502 #define RTC_IT_ALRB                       ((uint32_t)0x00002000)
 503 #define RTC_IT_ALRA                       ((uint32_t)0x00001000)
 504 #define RTC_IT_TAMP                       ((uint32_t)0x00000004) /* Used only to Enable the Tamper Interrupt */
 505 #define RTC_IT_TAMP1                      ((uint32_t)0x00020000)
 506 #define RTC_IT_TAMP2                      ((uint32_t)0x00040000)
 507 #define RTC_IT_TAMP3                      ((uint32_t)0x00080000)
 508 /**
 509   * @}
 510   */
 511
 512 /** @defgroup RTC_Flags_Definitions RTC Flags Definitions
 513   * @{
 514   */
 515 #define RTC_FLAG_RECALPF                  ((uint32_t)0x00010000)
 516 #define RTC_FLAG_TAMP3F                   ((uint32_t)0x00008000)
 517 #define RTC_FLAG_TAMP2F                   ((uint32_t)0x00004000)
 518 #define RTC_FLAG_TAMP1F                   ((uint32_t)0x00002000)
 519 #define RTC_FLAG_TSOVF                    ((uint32_t)0x00001000)
 520 #define RTC_FLAG_TSF                      ((uint32_t)0x00000800)
 521 #define RTC_FLAG_WUTF                     ((uint32_t)0x00000400)
 522 #define RTC_FLAG_ALRBF                    ((uint32_t)0x00000200)
 523 #define RTC_FLAG_ALRAF                    ((uint32_t)0x00000100)
 524 #define RTC_FLAG_INITF                    ((uint32_t)0x00000040)
 525 #define RTC_FLAG_RSF                      ((uint32_t)0x00000020)
 526 #define RTC_FLAG_INITS                    ((uint32_t)0x00000010)
 527 #define RTC_FLAG_SHPF                     ((uint32_t)0x00000008)
 528 #define RTC_FLAG_WUTWF                    ((uint32_t)0x00000004)
 529 #define RTC_FLAG_ALRBWF                   ((uint32_t)0x00000002)
 530 #define RTC_FLAG_ALRAWF                   ((uint32_t)0x00000001)
 531 /**
 532   * @}
 533   */
 534
 535 /**
 536   * @}
 537   */
 538
 539 /* Exported macros -----------------------------------------------------------*/
 540 /** @defgroup RTC_Exported_Macros RTC Exported Macros
 541   * @{
 542   */
 543
 544 /** @brief  Reset RTC handle state
 545   * @param  __HANDLE__: RTC handle.
 546   * @retval None
 547   */
 548 #define __HAL_RTC_RESET_HANDLE_STATE(__HANDLE__) ((__HANDLE__)->State = HAL_RTC_STATE_RESET)
 549
 550 /**
 551   * @brief  Disable the write protection for RTC registers.
 552   * @param  __HANDLE__: specifies the RTC handle.
 553   * @retval None
 554   */
 555 #define __HAL_RTC_WRITEPROTECTION_DISABLE(__HANDLE__)             \
 556                         do{                                       \
 557                             (__HANDLE__)->Instance->WPR = 0xCA;   \
 558                             (__HANDLE__)->Instance->WPR = 0x53;   \
 559                           } while(0)
 560
 561 /**
 562   * @brief  Enable the write protection for RTC registers.
 563   * @param  __HANDLE__: specifies the RTC handle.
 564   * @retval None
 565   */
 566 #define __HAL_RTC_WRITEPROTECTION_ENABLE(__HANDLE__)              \
 567                         do{                                       \
 568                             (__HANDLE__)->Instance->WPR = 0xFF;   \
 569                           } while(0)
 570
 571 /**
 572   * @brief  Enable the RTC ALARMA peripheral.
 573   * @param  __HANDLE__: specifies the RTC handle.
 574   * @retval None
 575   */
 576 #define __HAL_RTC_ALARMA_ENABLE(__HANDLE__)                           ((__HANDLE__)->Instance->CR |= (RTC_CR_ALRAE))
 577
 578 /**
 579   * @brief  Disable the RTC ALARMA peripheral.
 580   * @param  __HANDLE__: specifies the RTC handle.
 581   * @retval None
 582   */
 583 #define __HAL_RTC_ALARMA_DISABLE(__HANDLE__)                          ((__HANDLE__)->Instance->CR &= ~(RTC_CR_ALRAE))
 584
 585 /**
 586   * @brief  Enable the RTC ALARMB peripheral.
 587   * @param  __HANDLE__: specifies the RTC handle.
 588   * @retval None
 589   */
 590 #define __HAL_RTC_ALARMB_ENABLE(__HANDLE__)                           ((__HANDLE__)->Instance->CR |= (RTC_CR_ALRBE))
 591
 592 /**
 593   * @brief  Disable the RTC ALARMB peripheral.
 594   * @param  __HANDLE__: specifies the RTC handle.
 595   * @retval None
 596   */
 597 #define __HAL_RTC_ALARMB_DISABLE(__HANDLE__)                          ((__HANDLE__)->Instance->CR &= ~(RTC_CR_ALRBE))
 598
 599 /**
 600   * @brief  Enable the RTC Alarm interrupt.
 601   * @param  __HANDLE__: specifies the RTC handle.
 602   * @param  __INTERRUPT__: specifies the RTC Alarm interrupt sources to be enabled or disabled.
 603   *          This parameter can be any combination of the following values:
 604   *             @arg RTC_IT_ALRA: Alarm A interrupt
 605   *             @arg RTC_IT_ALRB: Alarm B interrupt
 606   * @retval None
 607   */
 608 #define __HAL_RTC_ALARM_ENABLE_IT(__HANDLE__, __INTERRUPT__)          ((__HANDLE__)->Instance->CR |= (__INTERRUPT__))
 609
 610 /**
 611   * @brief  Disable the RTC Alarm interrupt.
 612   * @param  __HANDLE__: specifies the RTC handle.
 613   * @param  __INTERRUPT__: specifies the RTC Alarm interrupt sources to be enabled or disabled.
 614   *         This parameter can be any combination of the following values:
 615   *            @arg RTC_IT_ALRA: Alarm A interrupt
 616   *            @arg RTC_IT_ALRB: Alarm B interrupt
 617   * @retval None
 618   */
 619 #define __HAL_RTC_ALARM_DISABLE_IT(__HANDLE__, __INTERRUPT__)         ((__HANDLE__)->Instance->CR &= ~(__INTERRUPT__))
 620
 621 /**
 622   * @brief  Check whether the specified RTC Alarm interrupt has occurred or not.
 623   * @param  __HANDLE__: specifies the RTC handle.
 624   * @param  __FLAG__: specifies the RTC Alarm interrupt sources to be enabled or disabled.
 625   *         This parameter can be:
 626   *            @arg RTC_IT_ALRA: Alarm A interrupt
 627   *            @arg RTC_IT_ALRB: Alarm B interrupt
 628   * @retval None
 629   */
 630 #define __HAL_RTC_ALARM_GET_IT(__HANDLE__, __FLAG__)                  ((((((__HANDLE__)->Instance->ISR)& ((__FLAG__)>> 4)) & 0x0000FFFF) != RESET)? SET : RESET)
 631
 632 /**
 633   * @brief  Get the selected RTC Alarm's flag status.
 634   * @param  __HANDLE__: specifies the RTC handle.
 635   * @param  __FLAG__: specifies the RTC Alarm Flag sources to be enabled or disabled.
 636   *         This parameter can be:
 637   *            @arg RTC_FLAG_ALRAF
 638   *            @arg RTC_FLAG_ALRBF
 639   *            @arg RTC_FLAG_ALRAWF
 640   *            @arg RTC_FLAG_ALRBWF
 641   * @retval None
 642   */
 643 #define __HAL_RTC_ALARM_GET_FLAG(__HANDLE__, __FLAG__)                (((((__HANDLE__)->Instance->ISR) & (__FLAG__)) != RESET)? SET : RESET)
 644
 645 /**
 646   * @brief  Clear the RTC Alarm's pending flags.
 647   * @param  __HANDLE__: specifies the RTC handle.
 648   * @param  __FLAG__: specifies the RTC Alarm Flag sources to be enabled or disabled.
 649   *         This parameter can be:
 650   *            @arg RTC_FLAG_ALRAF
 651   *            @arg RTC_FLAG_ALRBF
 652   * @retval None
 653   */
 654 #define __HAL_RTC_ALARM_CLEAR_FLAG(__HANDLE__, __FLAG__)                  ((__HANDLE__)->Instance->ISR) = (~(((__FLAG__) | RTC_ISR_INIT)& 0x0000FFFF)|((__HANDLE__)->Instance->ISR & RTC_ISR_INIT))
 655
 656
 657 #define RTC_EXTI_LINE_ALARM_EVENT             ((uint32_t)0x00020000)  /*!< External interrupt line 17 Connected to the RTC Alarm event */
 658 #define RTC_EXTI_LINE_TAMPER_TIMESTAMP_EVENT  ((uint32_t)0x00080000)  /*!< External interrupt line 19 Connected to the RTC Tamper and Time Stamp events */
 659 #define RTC_EXTI_LINE_WAKEUPTIMER_EVENT       ((uint32_t)0x00100000)  /*!< External interrupt line 20 Connected to the RTC Wakeup event */
 660
 661 /**
 662   * @brief  Enable the RTC Exti line.
 663   * @param  __EXTILINE__: specifies the RTC Exti sources to be enabled or disabled.
 664   *         This parameter can be:
 665   *            @arg RTC_EXTI_LINE_ALARM_EVENT
 666   *            @arg RTC_EXTI_LINE_TAMPER_TIMESTAMP_EVENT
 667   *            @arg RTC_EXTI_LINE_WAKEUPTIMER_EVENT
 668   * @retval None
 669   */
 670 #define __HAL_RTC_EXTI_ENABLE_IT(__EXTILINE__)   (EXTI->IMR |= (__EXTILINE__))
 671
 672 /* alias define maintained for legacy */
 673 #define __HAL_RTC_ENABLE_IT   __HAL_RTC_EXTI_ENABLE_IT
 674
 675 /**
 676   * @brief  Disable the RTC Exti line.
 677   * @param  __EXTILINE__: specifies the RTC Exti sources to be enabled or disabled.
 678   *         This parameter can be:
 679   *            @arg RTC_EXTI_LINE_ALARM_EVENT
 680   *            @arg RTC_EXTI_LINE_TAMPER_TIMESTAMP_EVENT
 681   *            @arg RTC_EXTI_LINE_WAKEUPTIMER_EVENT
 682   * @retval None
 683   */
 684 #define __HAL_RTC_EXTI_DISABLE_IT(__EXTILINE__)  (EXTI->IMR &= ~(__EXTILINE__))
 685
 686 /* alias define maintained for legacy */
 687 #define __HAL_RTC_DISABLE_IT   __HAL_RTC_EXTI_DISABLE_IT
 688
 689 /**
 690   * @brief  Generates a Software interrupt on selected EXTI line.
 691   * @param  __EXTILINE__: specifies the RTC Exti sources to be enabled or disabled.
 692   *         This parameter can be:
 693   *            @arg RTC_EXTI_LINE_ALARM_EVENT
 694   *            @arg RTC_EXTI_LINE_TAMPER_TIMESTAMP_EVENT
 695   *            @arg RTC_EXTI_LINE_WAKEUPTIMER_EVENT
 696   * @retval None
 697   */
 698 #define __HAL_RTC_EXTI_GENERATE_SWIT(__EXTILINE__) (EXTI->SWIER |= (__EXTILINE__))
 699
 700 /**
 701   * @brief  Clear the RTC Exti flags.
 702   * @param  __FLAG__: specifies the RTC Exti sources to be enabled or disabled.
 703   *         This parameter can be:
 704   *            @arg RTC_EXTI_LINE_ALARM_EVENT
 705   *            @arg RTC_EXTI_LINE_TAMPER_TIMESTAMP_EVENT
 706   *            @arg RTC_EXTI_LINE_WAKEUPTIMER_EVENT
 707   * @retval None
 708   */
 709 #define __HAL_RTC_EXTI_CLEAR_FLAG(__FLAG__)  (EXTI->PR = (__FLAG__))
 710
 711 /* alias define maintained for legacy */
 712 #define __HAL_RTC_CLEAR_FLAG   __HAL_RTC_EXTI_CLEAR_FLAG
 713
 714 /**
 715   * @}
 716   */
 717
 718 /* Include RTC HAL Extended module */
 719 #include "stm32f3xx_hal_rtc_ex.h"
 720
 721 /* Exported functions --------------------------------------------------------*/
 722 /** @addtogroup RTC_Exported_Functions RTC Exported Functions
 723   * @{
 724   */
 725
 726 /** @addtogroup RTC_Exported_Functions_Group1 Initialization and de-initialization functions
 727   * @{
 728   */
 729
 730 /* Initialization and de-initialization functions  ****************************/
 731 HAL_StatusTypeDef HAL_RTC_Init(RTC_HandleTypeDef *hrtc);
 732 HAL_StatusTypeDef HAL_RTC_DeInit(RTC_HandleTypeDef *hrtc);
 733 void              HAL_RTC_MspInit(RTC_HandleTypeDef *hrtc);
 734 void              HAL_RTC_MspDeInit(RTC_HandleTypeDef *hrtc);
 735 /**
 736   * @}
 737   */
 738
 739 /** @addtogroup RTC_Exported_Functions_Group2 RTC Time and Date functions
 740   * @{
 741   */
 742
 743 /* RTC Time and Date functions ************************************************/
 744 HAL_StatusTypeDef HAL_RTC_SetTime(RTC_HandleTypeDef *hrtc, RTC_TimeTypeDef *sTime, uint32_t Format);
 745 HAL_StatusTypeDef HAL_RTC_GetTime(RTC_HandleTypeDef *hrtc, RTC_TimeTypeDef *sTime, uint32_t Format);
 746 HAL_StatusTypeDef HAL_RTC_SetDate(RTC_HandleTypeDef *hrtc, RTC_DateTypeDef *sDate, uint32_t Format);
 747 HAL_StatusTypeDef HAL_RTC_GetDate(RTC_HandleTypeDef *hrtc, RTC_DateTypeDef *sDate, uint32_t Format);
 748 /**
 749   * @}
 750   */
 751
 752 /** @addtogroup RTC_Exported_Functions_Group3 RTC Alarm functions
 753   * @{
 754   */
 755 /* RTC Alarm functions ********************************************************/
 756 HAL_StatusTypeDef HAL_RTC_SetAlarm(RTC_HandleTypeDef *hrtc, RTC_AlarmTypeDef *sAlarm, uint32_t Format);
 757 HAL_StatusTypeDef HAL_RTC_SetAlarm_IT(RTC_HandleTypeDef *hrtc, RTC_AlarmTypeDef *sAlarm, uint32_t Format);
 758 HAL_StatusTypeDef HAL_RTC_DeactivateAlarm(RTC_HandleTypeDef *hrtc, uint32_t Alarm);
 759 HAL_StatusTypeDef HAL_RTC_GetAlarm(RTC_HandleTypeDef *hrtc, RTC_AlarmTypeDef *sAlarm, uint32_t Alarm, uint32_t Format);
 760 void              HAL_RTC_AlarmIRQHandler(RTC_HandleTypeDef *hrtc);
 761 HAL_StatusTypeDef HAL_RTC_PollForAlarmAEvent(RTC_HandleTypeDef *hrtc, uint32_t Timeout);
 762 void              HAL_RTC_AlarmAEventCallback(RTC_HandleTypeDef *hrtc);
 763 /**
 764   * @}
 765   */
 766
 767 /** @addtogroup RTC_Exported_Functions_Group4 Peripheral Control functions
 768   * @{
 769   */
 770 /* Peripheral Control functions ***********************************************/
 771 HAL_StatusTypeDef   HAL_RTC_WaitForSynchro(RTC_HandleTypeDef* hrtc);
 772 /**
 773   * @}
 774   */
 775
 776 /** @addtogroup RTC_Exported_Functions_Group5 Peripheral State functions
 777   * @{
 778   */
 779 /* Peripheral State functions *************************************************/
 780 HAL_RTCStateTypeDef HAL_RTC_GetState(RTC_HandleTypeDef *hrtc);
 781 /**
 782   * @}
 783   */
 784
 785 /**
 786   * @}
 787   */
 788
 789 /** @addtogroup RTC_Private_Functions
 790   * @{
 791   */
 792 HAL_StatusTypeDef  RTC_EnterInitMode(RTC_HandleTypeDef* hrtc);
 793 uint8_t            RTC_ByteToBcd2(uint8_t Value);
 794 uint8_t            RTC_Bcd2ToByte(uint8_t Value);
 795 /**
 796   * @}
 797   */
 798
 799 /**
 800   * @}
 801   */
 802
 803 /**
 804   * @}
 805   */
 806
 807 #ifdef __cplusplus
 808 }
 809 #endif
 810
 811 #endif /* __STM32F3xx_HAL_RTC_H */
 812
 813 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/