.

Dependents:   RTC

Committer:
jhon309
Date:
Thu Aug 13 00:20:09 2015 +0000
Revision:
0:88e313c910d0
RTC Example

Who changed what in which revision?

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