tool/mbed/mbed-sdk/libraries/mbed/targets/cmsis/TARGET_STM/TARGET_STM32F0/stm32f0xx_hal_rtc.h

   1 /**
   2   ******************************************************************************
   3   * @file    stm32f0xx_hal_rtc.h
   4   * @author  MCD Application Team
   5   * @version V1.2.0
   6   * @date    11-December-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 __STM32F0xx_HAL_RTC_H
  40 #define __STM32F0xx_HAL_RTC_H
  41
  42 #ifdef __cplusplus
  43  extern "C" {
  44 #endif
  45
  46 /* Includes ------------------------------------------------------------------*/
  47 #include "stm32f0xx_hal_def.h"
  48
  49 /** @addtogroup STM32F0xx_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
 203 #define RTC_TIMEOUT_VALUE  1000
 204 /**
 205   * @}
 206   */
 207
 208 /** @defgroup RTC_Hour_Formats RTC Hour Formats
 209   * @{
 210   */
 211 #define RTC_HOURFORMAT_24              ((uint32_t)0x00000000)
 212 #define RTC_HOURFORMAT_12              ((uint32_t)0x00000040)
 213
 214 #define IS_RTC_HOUR_FORMAT(FORMAT)     (((FORMAT) == RTC_HOURFORMAT_12) || \
 215                                         ((FORMAT) == RTC_HOURFORMAT_24))
 216 /**
 217   * @}
 218   */
 219
 220 /** @defgroup RTC_Output_Polarity_Definitions RTC Output Polarity Definitions
 221   * @{
 222   */
 223 #define RTC_OUTPUT_POLARITY_HIGH       ((uint32_t)0x00000000)
 224 #define RTC_OUTPUT_POLARITY_LOW        ((uint32_t)0x00100000)
 225
 226 #define IS_RTC_OUTPUT_POL(POL) (((POL) == RTC_OUTPUT_POLARITY_HIGH) || \
 227                                 ((POL) == RTC_OUTPUT_POLARITY_LOW))
 228 /**
 229   * @}
 230   */
 231
 232 /** @defgroup RTC_Output_Type_ALARM_OUT RTC Output Type ALARM OUT
 233   * @{
 234   */
 235 #define RTC_OUTPUT_TYPE_OPENDRAIN      ((uint32_t)0x00000000)
 236 #define RTC_OUTPUT_TYPE_PUSHPULL       ((uint32_t)0x00040000)
 237
 238 #define IS_RTC_OUTPUT_TYPE(TYPE) (((TYPE) == RTC_OUTPUT_TYPE_OPENDRAIN) || \
 239                                   ((TYPE) == RTC_OUTPUT_TYPE_PUSHPULL))
 240
 241 /**
 242   * @}
 243   */
 244
 245 /** @defgroup RTC_Asynchronous_Predivider RTC Asynchronous Predivider
 246   * @{
 247   */
 248 #define IS_RTC_ASYNCH_PREDIV(PREDIV)   ((PREDIV) <= (uint32_t)0x7F)
 249 /**
 250   * @}
 251   */
 252
 253 /** @defgroup RTC_Synchronous_Predivider RTC Synchronous Predivider
 254   * @{
 255   */
 256 #define IS_RTC_SYNCH_PREDIV(PREDIV)    ((PREDIV) <= (uint32_t)0x7FFF)
 257 /**
 258   * @}
 259   */
 260
 261 /** @defgroup RTC_Time_Definitions RTC Time Definitions
 262   * @{
 263   */
 264 #define IS_RTC_HOUR12(HOUR)            (((HOUR) > (uint32_t)0) && ((HOUR) <= (uint32_t)12))
 265 #define IS_RTC_HOUR24(HOUR)            ((HOUR) <= (uint32_t)23)
 266 #define IS_RTC_MINUTES(MINUTES)        ((MINUTES) <= (uint32_t)59)
 267 #define IS_RTC_SECONDS(SECONDS)        ((SECONDS) <= (uint32_t)59)
 268 /**
 269   * @}
 270   */
 271
 272 /** @defgroup RTC_AM_PM_Definitions RTC AM PM Definitions
 273   * @{
 274   */
 275 #define RTC_HOURFORMAT12_AM            ((uint8_t)0x00)
 276 #define RTC_HOURFORMAT12_PM            ((uint8_t)0x40)
 277
 278 #define IS_RTC_HOURFORMAT12(PM)  (((PM) == RTC_HOURFORMAT12_AM) || ((PM) == RTC_HOURFORMAT12_PM))
 279 /**
 280   * @}
 281   */
 282
 283 /** @defgroup RTC_DayLightSaving_Definitions RTC DayLightSaving Definitions
 284   * @{
 285   */
 286 #define RTC_DAYLIGHTSAVING_SUB1H       ((uint32_t)0x00020000)
 287 #define RTC_DAYLIGHTSAVING_ADD1H       ((uint32_t)0x00010000)
 288 #define RTC_DAYLIGHTSAVING_NONE        ((uint32_t)0x00000000)
 289
 290 #define IS_RTC_DAYLIGHT_SAVING(SAVE) (((SAVE) == RTC_DAYLIGHTSAVING_SUB1H) || \
 291                                       ((SAVE) == RTC_DAYLIGHTSAVING_ADD1H) || \
 292                                       ((SAVE) == RTC_DAYLIGHTSAVING_NONE))
 293 /**
 294   * @}
 295   */
 296
 297 /** @defgroup RTC_StoreOperation_Definitions RTC StoreOperation Definitions
 298   * @{
 299   */
 300 #define RTC_STOREOPERATION_RESET        ((uint32_t)0x00000000)
 301 #define RTC_STOREOPERATION_SET          ((uint32_t)0x00040000)
 302
 303 #define IS_RTC_STORE_OPERATION(OPERATION) (((OPERATION) == RTC_STOREOPERATION_RESET) || \
 304                                            ((OPERATION) == RTC_STOREOPERATION_SET))
 305 /**
 306   * @}
 307   */
 308
 309 /** @defgroup RTC_Input_parameter_format_definitions RTC Input parameter format definitions
 310   * @{
 311   */
 312 #define FORMAT_BIN                      ((uint32_t)0x000000000)
 313 #define FORMAT_BCD                      ((uint32_t)0x000000001)
 314
 315 #define IS_RTC_FORMAT(FORMAT) (((FORMAT) == FORMAT_BIN) || ((FORMAT) == FORMAT_BCD))
 316 /**
 317   * @}
 318   */
 319
 320 /** @defgroup RTC_Year_Date_Definitions RTC Year Date Definitions
 321   * @{
 322   */
 323 #define IS_RTC_YEAR(YEAR)              ((YEAR) <= (uint32_t)99)
 324 /**
 325   * @}
 326   */
 327
 328 /** @defgroup RTC_Month_Date_Definitions RTC Month Date Definitions
 329   * @{
 330   */
 331
 332 /* Coded in BCD format */
 333 #define RTC_MONTH_JANUARY              ((uint8_t)0x01)
 334 #define RTC_MONTH_FEBRUARY             ((uint8_t)0x02)
 335 #define RTC_MONTH_MARCH                ((uint8_t)0x03)
 336 #define RTC_MONTH_APRIL                ((uint8_t)0x04)
 337 #define RTC_MONTH_MAY                  ((uint8_t)0x05)
 338 #define RTC_MONTH_JUNE                 ((uint8_t)0x06)
 339 #define RTC_MONTH_JULY                 ((uint8_t)0x07)
 340 #define RTC_MONTH_AUGUST               ((uint8_t)0x08)
 341 #define RTC_MONTH_SEPTEMBER            ((uint8_t)0x09)
 342 #define RTC_MONTH_OCTOBER              ((uint8_t)0x10)
 343 #define RTC_MONTH_NOVEMBER             ((uint8_t)0x11)
 344 #define RTC_MONTH_DECEMBER             ((uint8_t)0x12)
 345
 346 #define IS_RTC_MONTH(MONTH)            (((MONTH) >= (uint32_t)1) && ((MONTH) <= (uint32_t)12))
 347 #define IS_RTC_DATE(DATE)              (((DATE) >= (uint32_t)1) && ((DATE) <= (uint32_t)31))
 348 /**
 349   * @}
 350   */
 351
 352 /** @defgroup RTC_WeekDay_Definitions RTC WeekDay Definitions
 353   * @{
 354   */
 355 #define RTC_WEEKDAY_MONDAY             ((uint8_t)0x01)
 356 #define RTC_WEEKDAY_TUESDAY            ((uint8_t)0x02)
 357 #define RTC_WEEKDAY_WEDNESDAY          ((uint8_t)0x03)
 358 #define RTC_WEEKDAY_THURSDAY           ((uint8_t)0x04)
 359 #define RTC_WEEKDAY_FRIDAY             ((uint8_t)0x05)
 360 #define RTC_WEEKDAY_SATURDAY           ((uint8_t)0x06)
 361 #define RTC_WEEKDAY_SUNDAY             ((uint8_t)0x07)
 362
 363 #define IS_RTC_WEEKDAY(WEEKDAY) (((WEEKDAY) == RTC_WEEKDAY_MONDAY)    || \
 364                                  ((WEEKDAY) == RTC_WEEKDAY_TUESDAY)   || \
 365                                  ((WEEKDAY) == RTC_WEEKDAY_WEDNESDAY) || \
 366                                  ((WEEKDAY) == RTC_WEEKDAY_THURSDAY)  || \
 367                                  ((WEEKDAY) == RTC_WEEKDAY_FRIDAY)    || \
 368                                  ((WEEKDAY) == RTC_WEEKDAY_SATURDAY)  || \
 369                                  ((WEEKDAY) == RTC_WEEKDAY_SUNDAY))
 370 /**
 371   * @}
 372   */
 373
 374 /** @defgroup RTC_Alarm_Definitions RTC Alarm Definitions
 375   * @{
 376   */
 377 #define IS_RTC_ALARM_DATE_WEEKDAY_DATE(DATE) (((DATE) >(uint32_t) 0) && ((DATE) <= (uint32_t)31))
 378 #define IS_RTC_ALARM_DATE_WEEKDAY_WEEKDAY(WEEKDAY) (((WEEKDAY) == RTC_WEEKDAY_MONDAY)    || \
 379                                                     ((WEEKDAY) == RTC_WEEKDAY_TUESDAY)   || \
 380                                                     ((WEEKDAY) == RTC_WEEKDAY_WEDNESDAY) || \
 381                                                     ((WEEKDAY) == RTC_WEEKDAY_THURSDAY)  || \
 382                                                     ((WEEKDAY) == RTC_WEEKDAY_FRIDAY)    || \
 383                                                     ((WEEKDAY) == RTC_WEEKDAY_SATURDAY)  || \
 384                                                     ((WEEKDAY) == RTC_WEEKDAY_SUNDAY))
 385 /**
 386   * @}
 387   */
 388
 389 /** @defgroup RTC_AlarmDateWeekDay_Definitions RTC AlarmDateWeekDay Definitions
 390   * @{
 391   */
 392 #define RTC_ALARMDATEWEEKDAYSEL_DATE      ((uint32_t)0x00000000)
 393 #define RTC_ALARMDATEWEEKDAYSEL_WEEKDAY   ((uint32_t)0x40000000)
 394
 395 #define IS_RTC_ALARM_DATE_WEEKDAY_SEL(SEL) (((SEL) == RTC_ALARMDATEWEEKDAYSEL_DATE) || \
 396                                             ((SEL) == RTC_ALARMDATEWEEKDAYSEL_WEEKDAY))
 397 /**
 398   * @}
 399   */
 400
 401 /** @defgroup RTC_AlarmMask_Definitions RTC AlarmMask Definitions
 402   * @{
 403   */
 404 #define RTC_ALARMMASK_NONE                ((uint32_t)0x00000000)
 405 #define RTC_ALARMMASK_DATEWEEKDAY         RTC_ALRMAR_MSK4
 406 #define RTC_ALARMMASK_HOURS               RTC_ALRMAR_MSK3
 407 #define RTC_ALARMMASK_MINUTES             RTC_ALRMAR_MSK2
 408 #define RTC_ALARMMASK_SECONDS             RTC_ALRMAR_MSK1
 409 #define RTC_ALARMMASK_ALL                 ((uint32_t)0x80808080)
 410
 411 #define IS_ALARM_MASK(MASK)  (((MASK) & 0x7F7F7F7F) == (uint32_t)RESET)
 412 /**
 413   * @}
 414   */
 415
 416 /** @defgroup RTC_Alarms_Definitions RTC Alarms Definitions
 417   * @{
 418   */
 419 #define RTC_ALARM_A                       RTC_CR_ALRAE
 420
 421 #define IS_ALARM(ALARM)      ((ALARM) == RTC_ALARM_A)
 422 /**
 423   * @}
 424   */
 425
 426 /** @defgroup RTC_Alarm_Sub_Seconds_Value RTC Alarm Sub Seconds Value
 427   * @{
 428   */
 429 #define IS_RTC_ALARM_SUB_SECOND_VALUE(VALUE) ((VALUE) <= (uint32_t)0x00007FFF)
 430 /**
 431   * @}
 432   */
 433
 434   /** @defgroup RTC_Alarm_Sub_Seconds_Masks_Definitions RTC Alarm Sub Seconds Masks Definitions
 435   * @{
 436   */
 437 #define RTC_ALARMSUBSECONDMASK_ALL         ((uint32_t)0x00000000)  /*!< All Alarm SS fields are masked.
 438                                                                         There is no comparison on sub seconds
 439                                                                         for Alarm */
 440 #define RTC_ALARMSUBSECONDMASK_SS14_1      ((uint32_t)0x01000000)  /*!< SS[14:1] are don't care in Alarm
 441                                                                         comparison. Only SS[0] is compared.    */
 442 #define RTC_ALARMSUBSECONDMASK_SS14_2      ((uint32_t)0x02000000)  /*!< SS[14:2] are don't care in Alarm
 443                                                                         comparison. Only SS[1:0] are compared  */
 444 #define RTC_ALARMSUBSECONDMASK_SS14_3      ((uint32_t)0x03000000)  /*!< SS[14:3] are don't care in Alarm
 445                                                                         comparison. Only SS[2:0] are compared  */
 446 #define RTC_ALARMSUBSECONDMASK_SS14_4      ((uint32_t)0x04000000)  /*!< SS[14:4] are don't care in Alarm
 447                                                                         comparison. Only SS[3:0] are compared  */
 448 #define RTC_ALARMSUBSECONDMASK_SS14_5      ((uint32_t)0x05000000)  /*!< SS[14:5] are don't care in Alarm
 449                                                                         comparison. Only SS[4:0] are compared  */
 450 #define RTC_ALARMSUBSECONDMASK_SS14_6      ((uint32_t)0x06000000)  /*!< SS[14:6] are don't care in Alarm
 451                                                                         comparison. Only SS[5:0] are compared  */
 452 #define RTC_ALARMSUBSECONDMASK_SS14_7      ((uint32_t)0x07000000)  /*!< SS[14:7] are don't care in Alarm
 453                                                                         comparison. Only SS[6:0] are compared  */
 454 #define RTC_ALARMSUBSECONDMASK_SS14_8      ((uint32_t)0x08000000)  /*!< SS[14:8] are don't care in Alarm
 455                                                                         comparison. Only SS[7:0] are compared  */
 456 #define RTC_ALARMSUBSECONDMASK_SS14_9      ((uint32_t)0x09000000)  /*!< SS[14:9] are don't care in Alarm
 457                                                                         comparison. Only SS[8:0] are compared  */
 458 #define RTC_ALARMSUBSECONDMASK_SS14_10     ((uint32_t)0x0A000000)  /*!< SS[14:10] are don't care in Alarm
 459                                                                         comparison. Only SS[9:0] are compared  */
 460 #define RTC_ALARMSUBSECONDMASK_SS14_11     ((uint32_t)0x0B000000)  /*!< SS[14:11] are don't care in Alarm
 461                                                                         comparison. Only SS[10:0] are compared */
 462 #define RTC_ALARMSUBSECONDMASK_SS14_12     ((uint32_t)0x0C000000)  /*!< SS[14:12] are don't care in Alarm
 463                                                                         comparison.Only SS[11:0] are compared  */
 464 #define RTC_ALARMSUBSECONDMASK_SS14_13     ((uint32_t)0x0D000000)  /*!< SS[14:13] are don't care in Alarm
 465                                                                         comparison. Only SS[12:0] are compared */
 466 #define RTC_ALARMSUBSECONDMASK_SS14        ((uint32_t)0x0E000000)  /*!< SS[14] is don't care in Alarm
 467                                                                         comparison.Only SS[13:0] are compared  */
 468 #define RTC_ALARMSUBSECONDMASK_None        ((uint32_t)0x0F000000)  /*!< SS[14:0] are compared and must match
 469                                                                         to activate alarm. */
 470
 471 #define IS_RTC_ALARM_SUB_SECOND_MASK(MASK)   (((MASK) == RTC_ALARMSUBSECONDMASK_ALL) || \
 472                                               ((MASK) == RTC_ALARMSUBSECONDMASK_SS14_1) || \
 473                                               ((MASK) == RTC_ALARMSUBSECONDMASK_SS14_2) || \
 474                                               ((MASK) == RTC_ALARMSUBSECONDMASK_SS14_3) || \
 475                                               ((MASK) == RTC_ALARMSUBSECONDMASK_SS14_4) || \
 476                                               ((MASK) == RTC_ALARMSUBSECONDMASK_SS14_5) || \
 477                                               ((MASK) == RTC_ALARMSUBSECONDMASK_SS14_6) || \
 478                                               ((MASK) == RTC_ALARMSUBSECONDMASK_SS14_7) || \
 479                                               ((MASK) == RTC_ALARMSUBSECONDMASK_SS14_8) || \
 480                                               ((MASK) == RTC_ALARMSUBSECONDMASK_SS14_9) || \
 481                                               ((MASK) == RTC_ALARMSUBSECONDMASK_SS14_10) || \
 482                                               ((MASK) == RTC_ALARMSUBSECONDMASK_SS14_11) || \
 483                                               ((MASK) == RTC_ALARMSUBSECONDMASK_SS14_12) || \
 484                                               ((MASK) == RTC_ALARMSUBSECONDMASK_SS14_13) || \
 485                                               ((MASK) == RTC_ALARMSUBSECONDMASK_SS14) || \
 486                                               ((MASK) == RTC_ALARMSUBSECONDMASK_None))
 487 /**
 488   * @}
 489   */
 490
 491 /** @defgroup RTC_Interrupts_Definitions RTC Interrupts Definitions
 492   * @{
 493   */
 494 #define RTC_IT_TS                         ((uint32_t)0x00008000)
 495 #define RTC_IT_WUT                        ((uint32_t)0x00004000)
 496 #define RTC_IT_ALRA                       ((uint32_t)0x00001000)
 497 #define RTC_IT_TAMP                       ((uint32_t)0x00000004) /* Used only to Enable the Tamper Interrupt */
 498 #define RTC_IT_TAMP1                      ((uint32_t)0x00020000)
 499 #define RTC_IT_TAMP2                      ((uint32_t)0x00040000)
 500 #define RTC_IT_TAMP3                      ((uint32_t)0x00080000)
 501 /**
 502   * @}
 503   */
 504
 505 /** @defgroup RTC_Flags_Definitions RTC Flags Definitions
 506   * @{
 507   */
 508 #define RTC_FLAG_RECALPF                  ((uint32_t)0x00010000)
 509 #define RTC_FLAG_TAMP3F                   ((uint32_t)0x00008000)
 510 #define RTC_FLAG_TAMP2F                   ((uint32_t)0x00004000)
 511 #define RTC_FLAG_TAMP1F                   ((uint32_t)0x00002000)
 512 #define RTC_FLAG_TSOVF                    ((uint32_t)0x00001000)
 513 #define RTC_FLAG_TSF                      ((uint32_t)0x00000800)
 514 #define RTC_FLAG_WUTF                     ((uint32_t)0x00000400)
 515 #define RTC_FLAG_ALRAF                    ((uint32_t)0x00000100)
 516 #define RTC_FLAG_INITF                    ((uint32_t)0x00000040)
 517 #define RTC_FLAG_RSF                      ((uint32_t)0x00000020)
 518 #define RTC_FLAG_INITS                    ((uint32_t)0x00000010)
 519 #define RTC_FLAG_SHPF                     ((uint32_t)0x00000008)
 520 #define RTC_FLAG_WUTWF                    ((uint32_t)0x00000004)
 521 #define RTC_FLAG_ALRAWF                   ((uint32_t)0x00000001)
 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 #define __HAL_RTC_RESET_HANDLE_STATE(__HANDLE__) ((__HANDLE__)->State = HAL_RTC_STATE_RESET)
 540
 541 /**
 542   * @brief  Disable the write protection for RTC registers.
 543   * @param  __HANDLE__: specifies the RTC handle.
 544   * @retval None
 545   */
 546 #define __HAL_RTC_WRITEPROTECTION_DISABLE(__HANDLE__)             \
 547                         do{                                       \
 548                             (__HANDLE__)->Instance->WPR = 0xCA;   \
 549                             (__HANDLE__)->Instance->WPR = 0x53;   \
 550                           } while(0)
 551
 552 /**
 553   * @brief  Enable the write protection for RTC registers.
 554   * @param  __HANDLE__: specifies the RTC handle.
 555   * @retval None
 556   */
 557 #define __HAL_RTC_WRITEPROTECTION_ENABLE(__HANDLE__)              \
 558                         do{                                       \
 559                             (__HANDLE__)->Instance->WPR = 0xFF;   \
 560                           } while(0)
 561
 562 /**
 563   * @brief  Enable the RTC ALARMA peripheral.
 564   * @param  __HANDLE__: specifies the RTC handle.
 565   * @retval None
 566   */
 567 #define __HAL_RTC_ALARMA_ENABLE(__HANDLE__)                           ((__HANDLE__)->Instance->CR |= (RTC_CR_ALRAE))
 568
 569 /**
 570   * @brief  Disable the RTC ALARMA peripheral.
 571   * @param  __HANDLE__: specifies the RTC handle.
 572   * @retval None
 573   */
 574 #define __HAL_RTC_ALARMA_DISABLE(__HANDLE__)                          ((__HANDLE__)->Instance->CR &= ~(RTC_CR_ALRAE))
 575
 576 /**
 577   * @brief  Enable the RTC Alarm interrupt.
 578   * @param  __HANDLE__: specifies the RTC handle.
 579   * @param  __INTERRUPT__: specifies the RTC Alarm interrupt sources to be enabled or disabled.
 580   *          This parameter can be any combination of the following values:
 581   *             @arg RTC_IT_ALRA: Alarm A interrupt
 582   * @retval None
 583   */
 584 #define __HAL_RTC_ALARM_ENABLE_IT(__HANDLE__, __INTERRUPT__)          ((__HANDLE__)->Instance->CR |= (__INTERRUPT__))
 585
 586 /**
 587   * @brief  Disable the RTC Alarm interrupt.
 588   * @param  __HANDLE__: specifies the RTC handle.
 589   * @param  __INTERRUPT__: specifies the RTC Alarm interrupt sources to be enabled or disabled.
 590   *         This parameter can be any combination of the following values:
 591   *            @arg RTC_IT_ALRA: Alarm A interrupt
 592   * @retval None
 593   */
 594 #define __HAL_RTC_ALARM_DISABLE_IT(__HANDLE__, __INTERRUPT__)         ((__HANDLE__)->Instance->CR &= ~(__INTERRUPT__))
 595
 596 /**
 597   * @brief  Check whether the specified RTC Alarm interrupt has occurred or not.
 598   * @param  __HANDLE__: specifies the RTC handle.
 599   * @param  __FLAG__: specifies the RTC Alarm interrupt sources to be enabled or disabled.
 600   *         This parameter can be:
 601   *            @arg RTC_IT_ALRA: Alarm A interrupt
 602   * @retval None
 603   */
 604 #define __HAL_RTC_ALARM_GET_IT(__HANDLE__, __FLAG__)                  ((((((__HANDLE__)->Instance->ISR)& ((__FLAG__)>> 4)) & 0x0000FFFF) != RESET)? SET : RESET)
 605
 606 /**
 607   * @brief  Get the selected RTC Alarm's flag status.
 608   * @param  __HANDLE__: specifies the RTC handle.
 609   * @param  __FLAG__: specifies the RTC Alarm Flag sources to be enabled or disabled.
 610   *         This parameter can be:
 611   *            @arg RTC_FLAG_ALRAF
 612   *            @arg RTC_FLAG_ALRAWF
 613   * @retval None
 614   */
 615 #define __HAL_RTC_ALARM_GET_FLAG(__HANDLE__, __FLAG__)                (((((__HANDLE__)->Instance->ISR) & (__FLAG__)) != RESET)? SET : RESET)
 616
 617 /**
 618   * @brief  Clear the RTC Alarm's pending flags.
 619   * @param  __HANDLE__: specifies the RTC handle.
 620   * @param  __FLAG__: specifies the RTC Alarm Flag sources to be enabled or disabled.
 621   *         This parameter can be:
 622   *            @arg RTC_FLAG_ALRAF
 623   * @retval None
 624   */
 625 #define __HAL_RTC_ALARM_CLEAR_FLAG(__HANDLE__, __FLAG__)                  ((__HANDLE__)->Instance->ISR) = (~(((__FLAG__) | RTC_ISR_INIT)& 0x0000FFFF)|((__HANDLE__)->Instance->ISR & RTC_ISR_INIT))
 626
 627
 628 #define RTC_EXTI_LINE_ALARM_EVENT             ((uint32_t)0x00020000)  /*!< External interrupt line 17 Connected to the RTC Alarm event */
 629 #define RTC_EXTI_LINE_TAMPER_TIMESTAMP_EVENT  ((uint32_t)0x00080000)  /*!< External interrupt line 19 Connected to the RTC Tamper and Time Stamp events */
 630 #define RTC_EXTI_LINE_WAKEUPTIMER_EVENT       ((uint32_t)0x00100000)  /*!< External interrupt line 20 Connected to the RTC Wakeup event */
 631
 632 /**
 633   * @brief  Enable the RTC Exti line.
 634   * @param  __EXTILINE__: specifies the RTC Exti sources to be enabled or disabled.
 635   *         This parameter can be:
 636   *            @arg RTC_EXTI_LINE_ALARM_EVENT
 637   *            @arg RTC_EXTI_LINE_TAMPER_TIMESTAMP_EVENT
 638   *            @arg RTC_EXTI_LINE_WAKEUPTIMER_EVENT
 639   * @retval None
 640   */
 641 #define __HAL_RTC_EXTI_ENABLE_IT(__EXTILINE__)   (EXTI->IMR |= (__EXTILINE__))
 642
 643 /* alias define maintained for legacy */
 644 #define __HAL_RTC_ENABLE_IT   __HAL_RTC_EXTI_ENABLE_IT
 645
 646 /**
 647   * @brief  Disable the RTC Exti line.
 648   * @param  __EXTILINE__: specifies the RTC Exti sources to be enabled or disabled.
 649   *         This parameter can be:
 650   *            @arg RTC_EXTI_LINE_ALARM_EVENT
 651   *            @arg RTC_EXTI_LINE_TAMPER_TIMESTAMP_EVENT
 652   *            @arg RTC_EXTI_LINE_WAKEUPTIMER_EVENT
 653   * @retval None
 654   */
 655 #define __HAL_RTC_EXTI_DISABLE_IT(__EXTILINE__)  (EXTI->IMR &= ~(__EXTILINE__))
 656
 657 /* alias define maintained for legacy */
 658 #define __HAL_RTC_DISABLE_IT   __HAL_RTC_EXTI_DISABLE_IT
 659
 660 /**
 661   * @brief  Generates a Software interrupt on selected EXTI line.
 662   * @param  __EXTILINE__: specifies the RTC Exti sources to be enabled or disabled.
 663   *         This parameter can be:
 664   *            @arg RTC_EXTI_LINE_ALARM_EVENT
 665   *            @arg RTC_EXTI_LINE_TAMPER_TIMESTAMP_EVENT
 666   *            @arg RTC_EXTI_LINE_WAKEUPTIMER_EVENT
 667   * @retval None
 668   */
 669 #define __HAL_RTC_EXTI_GENERATE_SWIT(__EXTILINE__) (EXTI->SWIER |= (__EXTILINE__))
 670
 671 /**
 672   * @brief  Clear the RTC Exti flags.
 673   * @param  __FLAG__: specifies the RTC Exti sources to be enabled or disabled.
 674   *         This parameter can be:
 675   *            @arg RTC_EXTI_LINE_ALARM_EVENT
 676   *            @arg RTC_EXTI_LINE_TAMPER_TIMESTAMP_EVENT
 677   *            @arg RTC_EXTI_LINE_WAKEUPTIMER_EVENT
 678   * @retval None
 679   */
 680 #define __HAL_RTC_EXTI_CLEAR_FLAG(__FLAG__)  (EXTI->PR = (__FLAG__))
 681
 682 /* alias define maintained for legacy */
 683 #define __HAL_RTC_CLEAR_FLAG   __HAL_RTC_EXTI_CLEAR_FLAG
 684
 685 /**
 686   * @}
 687   */
 688
 689 /* Include RTC HAL Extension module */
 690 #include "stm32f0xx_hal_rtc_ex.h"
 691
 692 /* Exported functions --------------------------------------------------------*/
 693 /** @addtogroup RTC_Exported_Functions RTC Exported Functions
 694   * @{
 695   */
 696
 697 /** @addtogroup RTC_Exported_Functions_Group1
 698   * @{
 699   */
 700
 701 /* Initialization and de-initialization functions  ****************************/
 702 HAL_StatusTypeDef HAL_RTC_Init(RTC_HandleTypeDef *hrtc);
 703 HAL_StatusTypeDef HAL_RTC_DeInit(RTC_HandleTypeDef *hrtc);
 704 void              HAL_RTC_MspInit(RTC_HandleTypeDef *hrtc);
 705 void              HAL_RTC_MspDeInit(RTC_HandleTypeDef *hrtc);
 706 /**
 707   * @}
 708   */
 709
 710 /** @addtogroup RTC_Exported_Functions_Group2
 711   * @{
 712   */
 713
 714 /* RTC Time and Date functions ************************************************/
 715 HAL_StatusTypeDef HAL_RTC_SetTime(RTC_HandleTypeDef *hrtc, RTC_TimeTypeDef *sTime, uint32_t Format);
 716 HAL_StatusTypeDef HAL_RTC_GetTime(RTC_HandleTypeDef *hrtc, RTC_TimeTypeDef *sTime, uint32_t Format);
 717 HAL_StatusTypeDef HAL_RTC_SetDate(RTC_HandleTypeDef *hrtc, RTC_DateTypeDef *sDate, uint32_t Format);
 718 HAL_StatusTypeDef HAL_RTC_GetDate(RTC_HandleTypeDef *hrtc, RTC_DateTypeDef *sDate, uint32_t Format);
 719 /**
 720   * @}
 721   */
 722
 723 /** @addtogroup RTC_Exported_Functions_Group3
 724   * @{
 725   */
 726 /* RTC Alarm functions ********************************************************/
 727 HAL_StatusTypeDef HAL_RTC_SetAlarm(RTC_HandleTypeDef *hrtc, RTC_AlarmTypeDef *sAlarm, uint32_t Format);
 728 HAL_StatusTypeDef HAL_RTC_SetAlarm_IT(RTC_HandleTypeDef *hrtc, RTC_AlarmTypeDef *sAlarm, uint32_t Format);
 729 HAL_StatusTypeDef HAL_RTC_DeactivateAlarm(RTC_HandleTypeDef *hrtc, uint32_t Alarm);
 730 HAL_StatusTypeDef HAL_RTC_GetAlarm(RTC_HandleTypeDef *hrtc, RTC_AlarmTypeDef *sAlarm, uint32_t Alarm, uint32_t Format);
 731 void              HAL_RTC_AlarmIRQHandler(RTC_HandleTypeDef *hrtc);
 732 HAL_StatusTypeDef HAL_RTC_PollForAlarmAEvent(RTC_HandleTypeDef *hrtc, uint32_t Timeout);
 733 void              HAL_RTC_AlarmAEventCallback(RTC_HandleTypeDef *hrtc);
 734 /**
 735   * @}
 736   */
 737
 738 /** @addtogroup RTC_Exported_Functions_Group4
 739   * @{
 740   */
 741 /* Peripheral Control functions ***********************************************/
 742 HAL_StatusTypeDef   HAL_RTC_WaitForSynchro(RTC_HandleTypeDef* hrtc);
 743 /**
 744   * @}
 745   */
 746
 747 /** @addtogroup RTC_Exported_Functions_Group5
 748   * @{
 749   */
 750 /* Peripheral State functions *************************************************/
 751 HAL_RTCStateTypeDef HAL_RTC_GetState(RTC_HandleTypeDef *hrtc);
 752 /**
 753   * @}
 754   */
 755
 756 /**
 757   * @}
 758   */
 759
 760 /** @addtogroup RTC_Private_Functions
 761   * @{
 762   */
 763 HAL_StatusTypeDef  RTC_EnterInitMode(RTC_HandleTypeDef* hrtc);
 764 uint8_t            RTC_ByteToBcd2(uint8_t Value);
 765 uint8_t            RTC_Bcd2ToByte(uint8_t Value);
 766 /**
 767   * @}
 768   */
 769
 770 /**
 771   * @}
 772   */
 773
 774   /**
 775   * @}
 776   */
 777
 778 #ifdef __cplusplus
 779 }
 780 #endif
 781
 782 #endif /* __STM32F0xx_HAL_RTC_H */
 783
 784 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/
 785