Nothing Special / mbed-STM32F103C8

Fork of mbed-STM32F103C8_org by Nothing Special

Committer:
mega64
Date:
Thu Mar 16 06:15:53 2017 +0000
Revision:
146:03e976389d16
fully rebuild, now based on mbed-dev v160

Who changed what in which revision?

UserRevisionLine numberNew contents of line
mega64 146:03e976389d16 1 /**
mega64 146:03e976389d16 2 ******************************************************************************
mega64 146:03e976389d16 3 * @file stm32f1xx_hal_rtc.h
mega64 146:03e976389d16 4 * @author MCD Application Team
mega64 146:03e976389d16 5 * @version V1.0.5
mega64 146:03e976389d16 6 * @date 06-December-2016
mega64 146:03e976389d16 7 * @brief Header file of RTC HAL module.
mega64 146:03e976389d16 8 ******************************************************************************
mega64 146:03e976389d16 9 * @attention
mega64 146:03e976389d16 10 *
mega64 146:03e976389d16 11 * <h2><center>&copy; COPYRIGHT(c) 2016 STMicroelectronics</center></h2>
mega64 146:03e976389d16 12 *
mega64 146:03e976389d16 13 * Redistribution and use in source and binary forms, with or without modification,
mega64 146:03e976389d16 14 * are permitted provided that the following conditions are met:
mega64 146:03e976389d16 15 * 1. Redistributions of source code must retain the above copyright notice,
mega64 146:03e976389d16 16 * this list of conditions and the following disclaimer.
mega64 146:03e976389d16 17 * 2. Redistributions in binary form must reproduce the above copyright notice,
mega64 146:03e976389d16 18 * this list of conditions and the following disclaimer in the documentation
mega64 146:03e976389d16 19 * and/or other materials provided with the distribution.
mega64 146:03e976389d16 20 * 3. Neither the name of STMicroelectronics nor the names of its contributors
mega64 146:03e976389d16 21 * may be used to endorse or promote products derived from this software
mega64 146:03e976389d16 22 * without specific prior written permission.
mega64 146:03e976389d16 23 *
mega64 146:03e976389d16 24 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
mega64 146:03e976389d16 25 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
mega64 146:03e976389d16 26 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
mega64 146:03e976389d16 27 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
mega64 146:03e976389d16 28 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
mega64 146:03e976389d16 29 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
mega64 146:03e976389d16 30 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
mega64 146:03e976389d16 31 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
mega64 146:03e976389d16 32 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
mega64 146:03e976389d16 33 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
mega64 146:03e976389d16 34 *
mega64 146:03e976389d16 35 ******************************************************************************
mega64 146:03e976389d16 36 */
mega64 146:03e976389d16 37
mega64 146:03e976389d16 38 /* Define to prevent recursive inclusion -------------------------------------*/
mega64 146:03e976389d16 39 #ifndef __STM32F1xx_HAL_RTC_H
mega64 146:03e976389d16 40 #define __STM32F1xx_HAL_RTC_H
mega64 146:03e976389d16 41
mega64 146:03e976389d16 42 #ifdef __cplusplus
mega64 146:03e976389d16 43 extern "C" {
mega64 146:03e976389d16 44 #endif
mega64 146:03e976389d16 45
mega64 146:03e976389d16 46 /* Includes ------------------------------------------------------------------*/
mega64 146:03e976389d16 47 #include "stm32f1xx_hal_def.h"
mega64 146:03e976389d16 48
mega64 146:03e976389d16 49 /** @addtogroup STM32F1xx_HAL_Driver
mega64 146:03e976389d16 50 * @{
mega64 146:03e976389d16 51 */
mega64 146:03e976389d16 52
mega64 146:03e976389d16 53 /** @addtogroup RTC
mega64 146:03e976389d16 54 * @{
mega64 146:03e976389d16 55 */
mega64 146:03e976389d16 56
mega64 146:03e976389d16 57 /** @addtogroup RTC_Private_Macros
mega64 146:03e976389d16 58 * @{
mega64 146:03e976389d16 59 */
mega64 146:03e976389d16 60
mega64 146:03e976389d16 61 #define IS_RTC_ASYNCH_PREDIV(PREDIV) (((PREDIV) <= (uint32_t)0xFFFFF) || ((PREDIV) == RTC_AUTO_1_SECOND))
mega64 146:03e976389d16 62 #define IS_RTC_HOUR24(HOUR) ((HOUR) <= (uint32_t)23)
mega64 146:03e976389d16 63 #define IS_RTC_MINUTES(MINUTES) ((MINUTES) <= (uint32_t)59)
mega64 146:03e976389d16 64 #define IS_RTC_SECONDS(SECONDS) ((SECONDS) <= (uint32_t)59)
mega64 146:03e976389d16 65 #define IS_RTC_FORMAT(FORMAT) (((FORMAT) == RTC_FORMAT_BIN) || ((FORMAT) == RTC_FORMAT_BCD))
mega64 146:03e976389d16 66 #define IS_RTC_YEAR(YEAR) ((YEAR) <= (uint32_t)99)
mega64 146:03e976389d16 67 #define IS_RTC_MONTH(MONTH) (((MONTH) >= (uint32_t)1) && ((MONTH) <= (uint32_t)12))
mega64 146:03e976389d16 68 #define IS_RTC_DATE(DATE) (((DATE) >= (uint32_t)1) && ((DATE) <= (uint32_t)31))
mega64 146:03e976389d16 69 #define IS_RTC_ALARM(ALARM) ((ALARM) == RTC_ALARM_A)
mega64 146:03e976389d16 70 #define IS_RTC_CALIB_OUTPUT(__OUTPUT__) (((__OUTPUT__) == RTC_OUTPUTSOURCE_NONE) || \
mega64 146:03e976389d16 71 ((__OUTPUT__) == RTC_OUTPUTSOURCE_CALIBCLOCK) || \
mega64 146:03e976389d16 72 ((__OUTPUT__) == RTC_OUTPUTSOURCE_ALARM) || \
mega64 146:03e976389d16 73 ((__OUTPUT__) == RTC_OUTPUTSOURCE_SECOND))
mega64 146:03e976389d16 74
mega64 146:03e976389d16 75
mega64 146:03e976389d16 76 /**
mega64 146:03e976389d16 77 * @}
mega64 146:03e976389d16 78 */
mega64 146:03e976389d16 79
mega64 146:03e976389d16 80 /** @addtogroup RTC_Private_Constants
mega64 146:03e976389d16 81 * @{
mega64 146:03e976389d16 82 */
mega64 146:03e976389d16 83 /** @defgroup RTC_Timeout_Value Default Timeout Value
mega64 146:03e976389d16 84 * @{
mega64 146:03e976389d16 85 */
mega64 146:03e976389d16 86 #define RTC_TIMEOUT_VALUE 1000
mega64 146:03e976389d16 87 /**
mega64 146:03e976389d16 88 * @}
mega64 146:03e976389d16 89 */
mega64 146:03e976389d16 90
mega64 146:03e976389d16 91 /** @defgroup RTC_EXTI_Line_Event RTC EXTI Line event
mega64 146:03e976389d16 92 * @{
mega64 146:03e976389d16 93 */
mega64 146:03e976389d16 94 #define RTC_EXTI_LINE_ALARM_EVENT ((uint32_t)EXTI_IMR_MR17) /*!< External interrupt line 17 Connected to the RTC Alarm event */
mega64 146:03e976389d16 95 /**
mega64 146:03e976389d16 96 * @}
mega64 146:03e976389d16 97 */
mega64 146:03e976389d16 98
mega64 146:03e976389d16 99
mega64 146:03e976389d16 100 /**
mega64 146:03e976389d16 101 * @}
mega64 146:03e976389d16 102 */
mega64 146:03e976389d16 103
mega64 146:03e976389d16 104 /* Exported types ------------------------------------------------------------*/
mega64 146:03e976389d16 105 /** @defgroup RTC_Exported_Types RTC Exported Types
mega64 146:03e976389d16 106 * @{
mega64 146:03e976389d16 107 */
mega64 146:03e976389d16 108 /**
mega64 146:03e976389d16 109 * @brief RTC Time structure definition
mega64 146:03e976389d16 110 */
mega64 146:03e976389d16 111 typedef struct
mega64 146:03e976389d16 112 {
mega64 146:03e976389d16 113 uint8_t Hours; /*!< Specifies the RTC Time Hour.
mega64 146:03e976389d16 114 This parameter must be a number between Min_Data = 0 and Max_Data = 23 */
mega64 146:03e976389d16 115
mega64 146:03e976389d16 116 uint8_t Minutes; /*!< Specifies the RTC Time Minutes.
mega64 146:03e976389d16 117 This parameter must be a number between Min_Data = 0 and Max_Data = 59 */
mega64 146:03e976389d16 118
mega64 146:03e976389d16 119 uint8_t Seconds; /*!< Specifies the RTC Time Seconds.
mega64 146:03e976389d16 120 This parameter must be a number between Min_Data = 0 and Max_Data = 59 */
mega64 146:03e976389d16 121
mega64 146:03e976389d16 122 }RTC_TimeTypeDef;
mega64 146:03e976389d16 123
mega64 146:03e976389d16 124 /**
mega64 146:03e976389d16 125 * @brief RTC Alarm structure definition
mega64 146:03e976389d16 126 */
mega64 146:03e976389d16 127 typedef struct
mega64 146:03e976389d16 128 {
mega64 146:03e976389d16 129 RTC_TimeTypeDef AlarmTime; /*!< Specifies the RTC Alarm Time members */
mega64 146:03e976389d16 130
mega64 146:03e976389d16 131 uint32_t Alarm; /*!< Specifies the alarm ID (only 1 alarm ID for STM32F1).
mega64 146:03e976389d16 132 This parameter can be a value of @ref RTC_Alarms_Definitions */
mega64 146:03e976389d16 133 }RTC_AlarmTypeDef;
mega64 146:03e976389d16 134
mega64 146:03e976389d16 135 /**
mega64 146:03e976389d16 136 * @brief HAL State structures definition
mega64 146:03e976389d16 137 */
mega64 146:03e976389d16 138 typedef enum
mega64 146:03e976389d16 139 {
mega64 146:03e976389d16 140 HAL_RTC_STATE_RESET = 0x00, /*!< RTC not yet initialized or disabled */
mega64 146:03e976389d16 141 HAL_RTC_STATE_READY = 0x01, /*!< RTC initialized and ready for use */
mega64 146:03e976389d16 142 HAL_RTC_STATE_BUSY = 0x02, /*!< RTC process is ongoing */
mega64 146:03e976389d16 143 HAL_RTC_STATE_TIMEOUT = 0x03, /*!< RTC timeout state */
mega64 146:03e976389d16 144 HAL_RTC_STATE_ERROR = 0x04 /*!< RTC error state */
mega64 146:03e976389d16 145
mega64 146:03e976389d16 146 }HAL_RTCStateTypeDef;
mega64 146:03e976389d16 147
mega64 146:03e976389d16 148 /**
mega64 146:03e976389d16 149 * @brief RTC Configuration Structure definition
mega64 146:03e976389d16 150 */
mega64 146:03e976389d16 151 typedef struct
mega64 146:03e976389d16 152 {
mega64 146:03e976389d16 153 uint32_t AsynchPrediv; /*!< Specifies the RTC Asynchronous Predivider value.
mega64 146:03e976389d16 154 This parameter must be a number between Min_Data = 0x00 and Max_Data = 0xFFFFF or RTC_AUTO_1_SECOND
mega64 146:03e976389d16 155 If RTC_AUTO_1_SECOND is selected, AsynchPrediv will be set automatically to get 1sec timebase */
mega64 146:03e976389d16 156
mega64 146:03e976389d16 157 uint32_t OutPut; /*!< Specifies which signal will be routed to the RTC Tamper pin.
mega64 146:03e976389d16 158 This parameter can be a value of @ref RTC_output_source_to_output_on_the_Tamper_pin */
mega64 146:03e976389d16 159
mega64 146:03e976389d16 160 }RTC_InitTypeDef;
mega64 146:03e976389d16 161
mega64 146:03e976389d16 162 /**
mega64 146:03e976389d16 163 * @brief RTC Date structure definition
mega64 146:03e976389d16 164 */
mega64 146:03e976389d16 165 typedef struct
mega64 146:03e976389d16 166 {
mega64 146:03e976389d16 167 uint8_t WeekDay; /*!< Specifies the RTC Date WeekDay (not necessary for HAL_RTC_SetDate).
mega64 146:03e976389d16 168 This parameter can be a value of @ref RTC_WeekDay_Definitions */
mega64 146:03e976389d16 169
mega64 146:03e976389d16 170 uint8_t Month; /*!< Specifies the RTC Date Month (in BCD format).
mega64 146:03e976389d16 171 This parameter can be a value of @ref RTC_Month_Date_Definitions */
mega64 146:03e976389d16 172
mega64 146:03e976389d16 173 uint8_t Date; /*!< Specifies the RTC Date.
mega64 146:03e976389d16 174 This parameter must be a number between Min_Data = 1 and Max_Data = 31 */
mega64 146:03e976389d16 175
mega64 146:03e976389d16 176 uint8_t Year; /*!< Specifies the RTC Date Year.
mega64 146:03e976389d16 177 This parameter must be a number between Min_Data = 0 and Max_Data = 99 */
mega64 146:03e976389d16 178
mega64 146:03e976389d16 179 }RTC_DateTypeDef;
mega64 146:03e976389d16 180
mega64 146:03e976389d16 181 /**
mega64 146:03e976389d16 182 * @brief Time Handle Structure definition
mega64 146:03e976389d16 183 */
mega64 146:03e976389d16 184 typedef struct
mega64 146:03e976389d16 185 {
mega64 146:03e976389d16 186 RTC_TypeDef *Instance; /*!< Register base address */
mega64 146:03e976389d16 187
mega64 146:03e976389d16 188 RTC_InitTypeDef Init; /*!< RTC required parameters */
mega64 146:03e976389d16 189
mega64 146:03e976389d16 190 RTC_DateTypeDef DateToUpdate; /*!< Current date set by user and updated automatically */
mega64 146:03e976389d16 191
mega64 146:03e976389d16 192 HAL_LockTypeDef Lock; /*!< RTC locking object */
mega64 146:03e976389d16 193
mega64 146:03e976389d16 194 __IO HAL_RTCStateTypeDef State; /*!< Time communication state */
mega64 146:03e976389d16 195
mega64 146:03e976389d16 196 }RTC_HandleTypeDef;
mega64 146:03e976389d16 197
mega64 146:03e976389d16 198 /**
mega64 146:03e976389d16 199 * @}
mega64 146:03e976389d16 200 */
mega64 146:03e976389d16 201
mega64 146:03e976389d16 202 /* Exported constants --------------------------------------------------------*/
mega64 146:03e976389d16 203 /** @defgroup RTC_Exported_Constants RTC Exported Constants
mega64 146:03e976389d16 204 * @{
mega64 146:03e976389d16 205 */
mega64 146:03e976389d16 206
mega64 146:03e976389d16 207 /** @defgroup RTC_Automatic_Prediv_1_Second Automatic calculation of prediv for 1sec timebase
mega64 146:03e976389d16 208 * @{
mega64 146:03e976389d16 209 */
mega64 146:03e976389d16 210 #define RTC_AUTO_1_SECOND ((uint32_t)0xFFFFFFFF)
mega64 146:03e976389d16 211
mega64 146:03e976389d16 212 /**
mega64 146:03e976389d16 213 * @}
mega64 146:03e976389d16 214 */
mega64 146:03e976389d16 215
mega64 146:03e976389d16 216 /** @defgroup RTC_Input_parameter_format_definitions Input Parameter Format
mega64 146:03e976389d16 217 * @{
mega64 146:03e976389d16 218 */
mega64 146:03e976389d16 219 #define RTC_FORMAT_BIN ((uint32_t)0x000000000)
mega64 146:03e976389d16 220 #define RTC_FORMAT_BCD ((uint32_t)0x000000001)
mega64 146:03e976389d16 221
mega64 146:03e976389d16 222 /**
mega64 146:03e976389d16 223 * @}
mega64 146:03e976389d16 224 */
mega64 146:03e976389d16 225
mega64 146:03e976389d16 226 /** @defgroup RTC_Month_Date_Definitions Month Definitions
mega64 146:03e976389d16 227 * @{
mega64 146:03e976389d16 228 */
mega64 146:03e976389d16 229
mega64 146:03e976389d16 230 /* Coded in BCD format */
mega64 146:03e976389d16 231 #define RTC_MONTH_JANUARY ((uint8_t)0x01)
mega64 146:03e976389d16 232 #define RTC_MONTH_FEBRUARY ((uint8_t)0x02)
mega64 146:03e976389d16 233 #define RTC_MONTH_MARCH ((uint8_t)0x03)
mega64 146:03e976389d16 234 #define RTC_MONTH_APRIL ((uint8_t)0x04)
mega64 146:03e976389d16 235 #define RTC_MONTH_MAY ((uint8_t)0x05)
mega64 146:03e976389d16 236 #define RTC_MONTH_JUNE ((uint8_t)0x06)
mega64 146:03e976389d16 237 #define RTC_MONTH_JULY ((uint8_t)0x07)
mega64 146:03e976389d16 238 #define RTC_MONTH_AUGUST ((uint8_t)0x08)
mega64 146:03e976389d16 239 #define RTC_MONTH_SEPTEMBER ((uint8_t)0x09)
mega64 146:03e976389d16 240 #define RTC_MONTH_OCTOBER ((uint8_t)0x10)
mega64 146:03e976389d16 241 #define RTC_MONTH_NOVEMBER ((uint8_t)0x11)
mega64 146:03e976389d16 242 #define RTC_MONTH_DECEMBER ((uint8_t)0x12)
mega64 146:03e976389d16 243
mega64 146:03e976389d16 244 /**
mega64 146:03e976389d16 245 * @}
mega64 146:03e976389d16 246 */
mega64 146:03e976389d16 247
mega64 146:03e976389d16 248 /** @defgroup RTC_WeekDay_Definitions WeekDay Definitions
mega64 146:03e976389d16 249 * @{
mega64 146:03e976389d16 250 */
mega64 146:03e976389d16 251 #define RTC_WEEKDAY_MONDAY ((uint8_t)0x01)
mega64 146:03e976389d16 252 #define RTC_WEEKDAY_TUESDAY ((uint8_t)0x02)
mega64 146:03e976389d16 253 #define RTC_WEEKDAY_WEDNESDAY ((uint8_t)0x03)
mega64 146:03e976389d16 254 #define RTC_WEEKDAY_THURSDAY ((uint8_t)0x04)
mega64 146:03e976389d16 255 #define RTC_WEEKDAY_FRIDAY ((uint8_t)0x05)
mega64 146:03e976389d16 256 #define RTC_WEEKDAY_SATURDAY ((uint8_t)0x06)
mega64 146:03e976389d16 257 #define RTC_WEEKDAY_SUNDAY ((uint8_t)0x00)
mega64 146:03e976389d16 258
mega64 146:03e976389d16 259 /**
mega64 146:03e976389d16 260 * @}
mega64 146:03e976389d16 261 */
mega64 146:03e976389d16 262
mega64 146:03e976389d16 263 /** @defgroup RTC_Alarms_Definitions Alarms Definitions
mega64 146:03e976389d16 264 * @{
mega64 146:03e976389d16 265 */
mega64 146:03e976389d16 266 #define RTC_ALARM_A 0 /*!< Specify alarm ID (mainly for legacy purposes) */
mega64 146:03e976389d16 267
mega64 146:03e976389d16 268 /**
mega64 146:03e976389d16 269 * @}
mega64 146:03e976389d16 270 */
mega64 146:03e976389d16 271
mega64 146:03e976389d16 272
mega64 146:03e976389d16 273 /** @defgroup RTC_output_source_to_output_on_the_Tamper_pin Output source to output on the Tamper pin
mega64 146:03e976389d16 274 * @{
mega64 146:03e976389d16 275 */
mega64 146:03e976389d16 276
mega64 146:03e976389d16 277 #define RTC_OUTPUTSOURCE_NONE ((uint32_t)0x00000000) /*!< No output on the TAMPER pin */
mega64 146:03e976389d16 278 #define RTC_OUTPUTSOURCE_CALIBCLOCK BKP_RTCCR_CCO /*!< RTC clock with a frequency divided by 64 on the TAMPER pin */
mega64 146:03e976389d16 279 #define RTC_OUTPUTSOURCE_ALARM BKP_RTCCR_ASOE /*!< Alarm pulse signal on the TAMPER pin */
mega64 146:03e976389d16 280 #define RTC_OUTPUTSOURCE_SECOND (BKP_RTCCR_ASOS | BKP_RTCCR_ASOE) /*!< Second pulse signal on the TAMPER pin */
mega64 146:03e976389d16 281
mega64 146:03e976389d16 282 /**
mega64 146:03e976389d16 283 * @}
mega64 146:03e976389d16 284 */
mega64 146:03e976389d16 285
mega64 146:03e976389d16 286 /** @defgroup RTC_Interrupts_Definitions Interrupts Definitions
mega64 146:03e976389d16 287 * @{
mega64 146:03e976389d16 288 */
mega64 146:03e976389d16 289 #define RTC_IT_OW RTC_CRH_OWIE /*!< Overflow interrupt */
mega64 146:03e976389d16 290 #define RTC_IT_ALRA RTC_CRH_ALRIE /*!< Alarm interrupt */
mega64 146:03e976389d16 291 #define RTC_IT_SEC RTC_CRH_SECIE /*!< Second interrupt */
mega64 146:03e976389d16 292 #define RTC_IT_TAMP1 BKP_CSR_TPIE /*!< TAMPER Pin interrupt enable */
mega64 146:03e976389d16 293 /**
mega64 146:03e976389d16 294 * @}
mega64 146:03e976389d16 295 */
mega64 146:03e976389d16 296
mega64 146:03e976389d16 297 /** @defgroup RTC_Flags_Definitions Flags Definitions
mega64 146:03e976389d16 298 * @{
mega64 146:03e976389d16 299 */
mega64 146:03e976389d16 300 #define RTC_FLAG_RTOFF RTC_CRL_RTOFF /*!< RTC Operation OFF flag */
mega64 146:03e976389d16 301 #define RTC_FLAG_RSF RTC_CRL_RSF /*!< Registers Synchronized flag */
mega64 146:03e976389d16 302 #define RTC_FLAG_OW RTC_CRL_OWF /*!< Overflow flag */
mega64 146:03e976389d16 303 #define RTC_FLAG_ALRAF RTC_CRL_ALRF /*!< Alarm flag */
mega64 146:03e976389d16 304 #define RTC_FLAG_SEC RTC_CRL_SECF /*!< Second flag */
mega64 146:03e976389d16 305 #define RTC_FLAG_TAMP1F BKP_CSR_TEF /*!< Tamper Interrupt Flag */
mega64 146:03e976389d16 306
mega64 146:03e976389d16 307 /**
mega64 146:03e976389d16 308 * @}
mega64 146:03e976389d16 309 */
mega64 146:03e976389d16 310
mega64 146:03e976389d16 311 /**
mega64 146:03e976389d16 312 * @}
mega64 146:03e976389d16 313 */
mega64 146:03e976389d16 314
mega64 146:03e976389d16 315 /* Exported macro ------------------------------------------------------------*/
mega64 146:03e976389d16 316 /** @defgroup RTC_Exported_macros RTC Exported Macros
mega64 146:03e976389d16 317 * @{
mega64 146:03e976389d16 318 */
mega64 146:03e976389d16 319
mega64 146:03e976389d16 320 /** @brief Reset RTC handle state
mega64 146:03e976389d16 321 * @param __HANDLE__: RTC handle.
mega64 146:03e976389d16 322 * @retval None
mega64 146:03e976389d16 323 */
mega64 146:03e976389d16 324 #define __HAL_RTC_RESET_HANDLE_STATE(__HANDLE__) ((__HANDLE__)->State = HAL_RTC_STATE_RESET)
mega64 146:03e976389d16 325
mega64 146:03e976389d16 326 /**
mega64 146:03e976389d16 327 * @brief Disable the write protection for RTC registers.
mega64 146:03e976389d16 328 * @param __HANDLE__: specifies the RTC handle.
mega64 146:03e976389d16 329 * @retval None
mega64 146:03e976389d16 330 */
mega64 146:03e976389d16 331 #define __HAL_RTC_WRITEPROTECTION_DISABLE(__HANDLE__) SET_BIT((__HANDLE__)->Instance->CRL, RTC_CRL_CNF)
mega64 146:03e976389d16 332
mega64 146:03e976389d16 333 /**
mega64 146:03e976389d16 334 * @brief Enable the write protection for RTC registers.
mega64 146:03e976389d16 335 * @param __HANDLE__: specifies the RTC handle.
mega64 146:03e976389d16 336 * @retval None
mega64 146:03e976389d16 337 */
mega64 146:03e976389d16 338 #define __HAL_RTC_WRITEPROTECTION_ENABLE(__HANDLE__) CLEAR_BIT((__HANDLE__)->Instance->CRL, RTC_CRL_CNF)
mega64 146:03e976389d16 339
mega64 146:03e976389d16 340 /**
mega64 146:03e976389d16 341 * @brief Enable the RTC Alarm interrupt.
mega64 146:03e976389d16 342 * @param __HANDLE__: specifies the RTC handle.
mega64 146:03e976389d16 343 * @param __INTERRUPT__: specifies the RTC Alarm interrupt sources to be enabled or disabled.
mega64 146:03e976389d16 344 * This parameter can be any combination of the following values:
mega64 146:03e976389d16 345 * @arg RTC_IT_ALRA: Alarm A interrupt
mega64 146:03e976389d16 346 * @retval None
mega64 146:03e976389d16 347 */
mega64 146:03e976389d16 348 #define __HAL_RTC_ALARM_ENABLE_IT(__HANDLE__, __INTERRUPT__) SET_BIT((__HANDLE__)->Instance->CRH, (__INTERRUPT__))
mega64 146:03e976389d16 349
mega64 146:03e976389d16 350 /**
mega64 146:03e976389d16 351 * @brief Disable the RTC Alarm interrupt.
mega64 146:03e976389d16 352 * @param __HANDLE__: specifies the RTC handle.
mega64 146:03e976389d16 353 * @param __INTERRUPT__: specifies the RTC Alarm interrupt sources to be enabled or disabled.
mega64 146:03e976389d16 354 * This parameter can be any combination of the following values:
mega64 146:03e976389d16 355 * @arg RTC_IT_ALRA: Alarm A interrupt
mega64 146:03e976389d16 356 * @retval None
mega64 146:03e976389d16 357 */
mega64 146:03e976389d16 358 #define __HAL_RTC_ALARM_DISABLE_IT(__HANDLE__, __INTERRUPT__) CLEAR_BIT((__HANDLE__)->Instance->CRH, (__INTERRUPT__))
mega64 146:03e976389d16 359
mega64 146:03e976389d16 360 /**
mega64 146:03e976389d16 361 * @brief Check whether the specified RTC Alarm interrupt has been enabled or not.
mega64 146:03e976389d16 362 * @param __HANDLE__: specifies the RTC handle.
mega64 146:03e976389d16 363 * @param __INTERRUPT__: specifies the RTC Alarm interrupt sources to be checked
mega64 146:03e976389d16 364 * This parameter can be:
mega64 146:03e976389d16 365 * @arg RTC_IT_ALRA: Alarm A interrupt
mega64 146:03e976389d16 366 * @retval None
mega64 146:03e976389d16 367 */
mega64 146:03e976389d16 368 #define __HAL_RTC_ALARM_GET_IT_SOURCE(__HANDLE__, __INTERRUPT__) ((((((__HANDLE__)->Instance->CRH)& ((__INTERRUPT__)))) != RESET)? SET : RESET)
mega64 146:03e976389d16 369
mega64 146:03e976389d16 370 /**
mega64 146:03e976389d16 371 * @brief Get the selected RTC Alarm's flag status.
mega64 146:03e976389d16 372 * @param __HANDLE__: specifies the RTC handle.
mega64 146:03e976389d16 373 * @param __FLAG__: specifies the RTC Alarm Flag sources to be enabled or disabled.
mega64 146:03e976389d16 374 * This parameter can be:
mega64 146:03e976389d16 375 * @arg RTC_FLAG_ALRAF
mega64 146:03e976389d16 376 * @retval None
mega64 146:03e976389d16 377 */
mega64 146:03e976389d16 378 #define __HAL_RTC_ALARM_GET_FLAG(__HANDLE__, __FLAG__) (((((__HANDLE__)->Instance->CRL) & (__FLAG__)) != RESET)? SET : RESET)
mega64 146:03e976389d16 379
mega64 146:03e976389d16 380 /**
mega64 146:03e976389d16 381 * @brief Check whether the specified RTC Alarm interrupt has occurred or not.
mega64 146:03e976389d16 382 * @param __HANDLE__: specifies the RTC handle.
mega64 146:03e976389d16 383 * @param __INTERRUPT__: specifies the RTC Alarm interrupt sources to check.
mega64 146:03e976389d16 384 * This parameter can be:
mega64 146:03e976389d16 385 * @arg RTC_IT_ALRA: Alarm A interrupt
mega64 146:03e976389d16 386 * @retval None
mega64 146:03e976389d16 387 */
mega64 146:03e976389d16 388 #define __HAL_RTC_ALARM_GET_IT(__HANDLE__, __INTERRUPT__) (((((__HANDLE__)->Instance->CRL) & (__INTERRUPT__)) != RESET)? SET : RESET)
mega64 146:03e976389d16 389
mega64 146:03e976389d16 390 /**
mega64 146:03e976389d16 391 * @brief Clear the RTC Alarm's pending flags.
mega64 146:03e976389d16 392 * @param __HANDLE__: specifies the RTC handle.
mega64 146:03e976389d16 393 * @param __FLAG__: specifies the RTC Alarm Flag sources to be enabled or disabled.
mega64 146:03e976389d16 394 * This parameter can be:
mega64 146:03e976389d16 395 * @arg RTC_FLAG_ALRAF
mega64 146:03e976389d16 396 * @retval None
mega64 146:03e976389d16 397 */
mega64 146:03e976389d16 398 #define __HAL_RTC_ALARM_CLEAR_FLAG(__HANDLE__, __FLAG__) ((__HANDLE__)->Instance->CRL) = ~(__FLAG__)
mega64 146:03e976389d16 399
mega64 146:03e976389d16 400 /**
mega64 146:03e976389d16 401 * @brief Enable interrupt on ALARM Exti Line 17.
mega64 146:03e976389d16 402 * @retval None.
mega64 146:03e976389d16 403 */
mega64 146:03e976389d16 404 #define __HAL_RTC_ALARM_EXTI_ENABLE_IT() SET_BIT(EXTI->IMR, RTC_EXTI_LINE_ALARM_EVENT)
mega64 146:03e976389d16 405
mega64 146:03e976389d16 406 /**
mega64 146:03e976389d16 407 * @brief Disable interrupt on ALARM Exti Line 17.
mega64 146:03e976389d16 408 * @retval None.
mega64 146:03e976389d16 409 */
mega64 146:03e976389d16 410 #define __HAL_RTC_ALARM_EXTI_DISABLE_IT() CLEAR_BIT(EXTI->IMR, RTC_EXTI_LINE_ALARM_EVENT)
mega64 146:03e976389d16 411
mega64 146:03e976389d16 412 /**
mega64 146:03e976389d16 413 * @brief Enable event on ALARM Exti Line 17.
mega64 146:03e976389d16 414 * @retval None.
mega64 146:03e976389d16 415 */
mega64 146:03e976389d16 416 #define __HAL_RTC_ALARM_EXTI_ENABLE_EVENT() SET_BIT(EXTI->EMR, RTC_EXTI_LINE_ALARM_EVENT)
mega64 146:03e976389d16 417
mega64 146:03e976389d16 418 /**
mega64 146:03e976389d16 419 * @brief Disable event on ALARM Exti Line 17.
mega64 146:03e976389d16 420 * @retval None.
mega64 146:03e976389d16 421 */
mega64 146:03e976389d16 422 #define __HAL_RTC_ALARM_EXTI_DISABLE_EVENT() CLEAR_BIT(EXTI->EMR, RTC_EXTI_LINE_ALARM_EVENT)
mega64 146:03e976389d16 423
mega64 146:03e976389d16 424
mega64 146:03e976389d16 425 /**
mega64 146:03e976389d16 426 * @brief ALARM EXTI line configuration: set falling edge trigger.
mega64 146:03e976389d16 427 * @retval None.
mega64 146:03e976389d16 428 */
mega64 146:03e976389d16 429 #define __HAL_RTC_ALARM_EXTI_ENABLE_FALLING_EDGE() SET_BIT(EXTI->FTSR, RTC_EXTI_LINE_ALARM_EVENT)
mega64 146:03e976389d16 430
mega64 146:03e976389d16 431
mega64 146:03e976389d16 432 /**
mega64 146:03e976389d16 433 * @brief Disable the ALARM Extended Interrupt Falling Trigger.
mega64 146:03e976389d16 434 * @retval None.
mega64 146:03e976389d16 435 */
mega64 146:03e976389d16 436 #define __HAL_RTC_ALARM_EXTI_DISABLE_FALLING_EDGE() CLEAR_BIT(EXTI->FTSR, RTC_EXTI_LINE_ALARM_EVENT)
mega64 146:03e976389d16 437
mega64 146:03e976389d16 438
mega64 146:03e976389d16 439 /**
mega64 146:03e976389d16 440 * @brief ALARM EXTI line configuration: set rising edge trigger.
mega64 146:03e976389d16 441 * @retval None.
mega64 146:03e976389d16 442 */
mega64 146:03e976389d16 443 #define __HAL_RTC_ALARM_EXTI_ENABLE_RISING_EDGE() SET_BIT(EXTI->RTSR, RTC_EXTI_LINE_ALARM_EVENT)
mega64 146:03e976389d16 444
mega64 146:03e976389d16 445 /**
mega64 146:03e976389d16 446 * @brief Disable the ALARM Extended Interrupt Rising Trigger.
mega64 146:03e976389d16 447 * This parameter can be:
mega64 146:03e976389d16 448 * @retval None.
mega64 146:03e976389d16 449 */
mega64 146:03e976389d16 450 #define __HAL_RTC_ALARM_EXTI_DISABLE_RISING_EDGE() CLEAR_BIT(EXTI->RTSR, RTC_EXTI_LINE_ALARM_EVENT)
mega64 146:03e976389d16 451
mega64 146:03e976389d16 452 /**
mega64 146:03e976389d16 453 * @brief ALARM EXTI line configuration: set rising & falling edge trigger.
mega64 146:03e976389d16 454 * @retval None.
mega64 146:03e976389d16 455 */
mega64 146:03e976389d16 456 #define __HAL_RTC_ALARM_EXTI_ENABLE_RISING_FALLING_EDGE() __HAL_RTC_ALARM_EXTI_ENABLE_RISING_EDGE();__HAL_RTC_ALARM_EXTI_ENABLE_FALLING_EDGE();
mega64 146:03e976389d16 457
mega64 146:03e976389d16 458 /**
mega64 146:03e976389d16 459 * @brief Disable the ALARM Extended Interrupt Rising & Falling Trigger.
mega64 146:03e976389d16 460 * This parameter can be:
mega64 146:03e976389d16 461 * @retval None.
mega64 146:03e976389d16 462 */
mega64 146:03e976389d16 463 #define __HAL_RTC_ALARM_EXTI_DISABLE_RISING_FALLING_EDGE() __HAL_RTC_ALARM_EXTI_DISABLE_RISING_EDGE();__HAL_RTC_ALARM_EXTI_DISABLE_FALLING_EDGE()();
mega64 146:03e976389d16 464
mega64 146:03e976389d16 465 /**
mega64 146:03e976389d16 466 * @brief Check whether the specified ALARM EXTI interrupt flag is set or not.
mega64 146:03e976389d16 467 * @retval EXTI ALARM Line Status.
mega64 146:03e976389d16 468 */
mega64 146:03e976389d16 469 #define __HAL_RTC_ALARM_EXTI_GET_FLAG() (EXTI->PR & (RTC_EXTI_LINE_ALARM_EVENT))
mega64 146:03e976389d16 470
mega64 146:03e976389d16 471 /**
mega64 146:03e976389d16 472 * @brief Clear the ALARM EXTI flag.
mega64 146:03e976389d16 473 * @retval None.
mega64 146:03e976389d16 474 */
mega64 146:03e976389d16 475 #define __HAL_RTC_ALARM_EXTI_CLEAR_FLAG() (EXTI->PR = (RTC_EXTI_LINE_ALARM_EVENT))
mega64 146:03e976389d16 476
mega64 146:03e976389d16 477 /**
mega64 146:03e976389d16 478 * @brief Generate a Software interrupt on selected EXTI line.
mega64 146:03e976389d16 479 * @retval None.
mega64 146:03e976389d16 480 */
mega64 146:03e976389d16 481 #define __HAL_RTC_ALARM_EXTI_GENERATE_SWIT() SET_BIT(EXTI->SWIER, RTC_EXTI_LINE_ALARM_EVENT)
mega64 146:03e976389d16 482 /**
mega64 146:03e976389d16 483 * @}
mega64 146:03e976389d16 484 */
mega64 146:03e976389d16 485
mega64 146:03e976389d16 486 /* Include RTC HAL Extension module */
mega64 146:03e976389d16 487 #include "stm32f1xx_hal_rtc_ex.h"
mega64 146:03e976389d16 488
mega64 146:03e976389d16 489 /* Exported functions --------------------------------------------------------*/
mega64 146:03e976389d16 490 /** @addtogroup RTC_Exported_Functions
mega64 146:03e976389d16 491 * @{
mega64 146:03e976389d16 492 */
mega64 146:03e976389d16 493
mega64 146:03e976389d16 494
mega64 146:03e976389d16 495 /* Initialization and de-initialization functions ****************************/
mega64 146:03e976389d16 496 /** @addtogroup RTC_Exported_Functions_Group1
mega64 146:03e976389d16 497 * @{
mega64 146:03e976389d16 498 */
mega64 146:03e976389d16 499 HAL_StatusTypeDef HAL_RTC_Init(RTC_HandleTypeDef *hrtc);
mega64 146:03e976389d16 500 HAL_StatusTypeDef HAL_RTC_DeInit(RTC_HandleTypeDef *hrtc);
mega64 146:03e976389d16 501 void HAL_RTC_MspInit(RTC_HandleTypeDef *hrtc);
mega64 146:03e976389d16 502 void HAL_RTC_MspDeInit(RTC_HandleTypeDef *hrtc);
mega64 146:03e976389d16 503 /**
mega64 146:03e976389d16 504 * @}
mega64 146:03e976389d16 505 */
mega64 146:03e976389d16 506
mega64 146:03e976389d16 507 /* RTC Time and Date functions ************************************************/
mega64 146:03e976389d16 508 /** @addtogroup RTC_Exported_Functions_Group2
mega64 146:03e976389d16 509 * @{
mega64 146:03e976389d16 510 */
mega64 146:03e976389d16 511 HAL_StatusTypeDef HAL_RTC_SetTime(RTC_HandleTypeDef *hrtc, RTC_TimeTypeDef *sTime, uint32_t Format);
mega64 146:03e976389d16 512 HAL_StatusTypeDef HAL_RTC_GetTime(RTC_HandleTypeDef *hrtc, RTC_TimeTypeDef *sTime, uint32_t Format);
mega64 146:03e976389d16 513 HAL_StatusTypeDef HAL_RTC_SetDate(RTC_HandleTypeDef *hrtc, RTC_DateTypeDef *sDate, uint32_t Format);
mega64 146:03e976389d16 514 HAL_StatusTypeDef HAL_RTC_GetDate(RTC_HandleTypeDef *hrtc, RTC_DateTypeDef *sDate, uint32_t Format);
mega64 146:03e976389d16 515 /**
mega64 146:03e976389d16 516 * @}
mega64 146:03e976389d16 517 */
mega64 146:03e976389d16 518
mega64 146:03e976389d16 519 /* RTC Alarm functions ********************************************************/
mega64 146:03e976389d16 520 /** @addtogroup RTC_Exported_Functions_Group3
mega64 146:03e976389d16 521 * @{
mega64 146:03e976389d16 522 */
mega64 146:03e976389d16 523 HAL_StatusTypeDef HAL_RTC_SetAlarm(RTC_HandleTypeDef *hrtc, RTC_AlarmTypeDef *sAlarm, uint32_t Format);
mega64 146:03e976389d16 524 HAL_StatusTypeDef HAL_RTC_SetAlarm_IT(RTC_HandleTypeDef *hrtc, RTC_AlarmTypeDef *sAlarm, uint32_t Format);
mega64 146:03e976389d16 525 HAL_StatusTypeDef HAL_RTC_DeactivateAlarm(RTC_HandleTypeDef *hrtc, uint32_t Alarm);
mega64 146:03e976389d16 526 HAL_StatusTypeDef HAL_RTC_GetAlarm(RTC_HandleTypeDef *hrtc, RTC_AlarmTypeDef *sAlarm, uint32_t Alarm, uint32_t Format);
mega64 146:03e976389d16 527 void HAL_RTC_AlarmIRQHandler(RTC_HandleTypeDef *hrtc);
mega64 146:03e976389d16 528 HAL_StatusTypeDef HAL_RTC_PollForAlarmAEvent(RTC_HandleTypeDef *hrtc, uint32_t Timeout);
mega64 146:03e976389d16 529 void HAL_RTC_AlarmAEventCallback(RTC_HandleTypeDef *hrtc);
mega64 146:03e976389d16 530 /**
mega64 146:03e976389d16 531 * @}
mega64 146:03e976389d16 532 */
mega64 146:03e976389d16 533
mega64 146:03e976389d16 534 /* Peripheral State functions *************************************************/
mega64 146:03e976389d16 535 /** @addtogroup RTC_Exported_Functions_Group4
mega64 146:03e976389d16 536 * @{
mega64 146:03e976389d16 537 */
mega64 146:03e976389d16 538 HAL_RTCStateTypeDef HAL_RTC_GetState(RTC_HandleTypeDef *hrtc);
mega64 146:03e976389d16 539 /**
mega64 146:03e976389d16 540 * @}
mega64 146:03e976389d16 541 */
mega64 146:03e976389d16 542
mega64 146:03e976389d16 543 /* Peripheral Control functions ***********************************************/
mega64 146:03e976389d16 544 /** @addtogroup RTC_Exported_Functions_Group5
mega64 146:03e976389d16 545 * @{
mega64 146:03e976389d16 546 */
mega64 146:03e976389d16 547 HAL_StatusTypeDef HAL_RTC_WaitForSynchro(RTC_HandleTypeDef* hrtc);
mega64 146:03e976389d16 548 /**
mega64 146:03e976389d16 549 * @}
mega64 146:03e976389d16 550 */
mega64 146:03e976389d16 551
mega64 146:03e976389d16 552 /**
mega64 146:03e976389d16 553 * @}
mega64 146:03e976389d16 554 */
mega64 146:03e976389d16 555
mega64 146:03e976389d16 556 /**
mega64 146:03e976389d16 557 * @}
mega64 146:03e976389d16 558 */
mega64 146:03e976389d16 559
mega64 146:03e976389d16 560 /**
mega64 146:03e976389d16 561 * @}
mega64 146:03e976389d16 562 */
mega64 146:03e976389d16 563
mega64 146:03e976389d16 564 #ifdef __cplusplus
mega64 146:03e976389d16 565 }
mega64 146:03e976389d16 566 #endif
mega64 146:03e976389d16 567
mega64 146:03e976389d16 568 #endif /* __STM32F1xx_HAL_RTC_H */
mega64 146:03e976389d16 569
mega64 146:03e976389d16 570 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/