Jhon Plantikow / I2C_EEPROM

I2C_EEPROM

TARGET_NUCLEO_F072RB/stm32f0xx_hal_iwdg.h@0:ac8863619623, 2015-08-13 (annotated)

Committer:
jhon309
Date:
Thu Aug 13 00:23:16 2015 +0000
Revision:
0:ac8863619623
I2C

Who changed what in which revision?

UserRevisionLine numberNew contents of line
jhon309 0:ac8863619623 1 /**
jhon309 0:ac8863619623 2 ******************************************************************************
jhon309 0:ac8863619623 3 * @file stm32f0xx_hal_iwdg.h
jhon309 0:ac8863619623 4 * @author MCD Application Team
jhon309 0:ac8863619623 5 * @version V1.2.0
jhon309 0:ac8863619623 6 * @date 11-December-2014
jhon309 0:ac8863619623 7 * @brief Header file of IWDG HAL module.
jhon309 0:ac8863619623 8 ******************************************************************************
jhon309 0:ac8863619623 9 * @attention
jhon309 0:ac8863619623 10 *
jhon309 0:ac8863619623 11 * <h2><center>&copy; COPYRIGHT(c) 2014 STMicroelectronics</center></h2>
jhon309 0:ac8863619623 12 *
jhon309 0:ac8863619623 13 * Redistribution and use in source and binary forms, with or without modification,
jhon309 0:ac8863619623 14 * are permitted provided that the following conditions are met:
jhon309 0:ac8863619623 15 * 1. Redistributions of source code must retain the above copyright notice,
jhon309 0:ac8863619623 16 * this list of conditions and the following disclaimer.
jhon309 0:ac8863619623 17 * 2. Redistributions in binary form must reproduce the above copyright notice,
jhon309 0:ac8863619623 18 * this list of conditions and the following disclaimer in the documentation
jhon309 0:ac8863619623 19 * and/or other materials provided with the distribution.
jhon309 0:ac8863619623 20 * 3. Neither the name of STMicroelectronics nor the names of its contributors
jhon309 0:ac8863619623 21 * may be used to endorse or promote products derived from this software
jhon309 0:ac8863619623 22 * without specific prior written permission.
jhon309 0:ac8863619623 23 *
jhon309 0:ac8863619623 24 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
jhon309 0:ac8863619623 25 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
jhon309 0:ac8863619623 26 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
jhon309 0:ac8863619623 27 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
jhon309 0:ac8863619623 28 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
jhon309 0:ac8863619623 29 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
jhon309 0:ac8863619623 30 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
jhon309 0:ac8863619623 31 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
jhon309 0:ac8863619623 32 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
jhon309 0:ac8863619623 33 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
jhon309 0:ac8863619623 34 *
jhon309 0:ac8863619623 35 ******************************************************************************
jhon309 0:ac8863619623 36 */
jhon309 0:ac8863619623 37
jhon309 0:ac8863619623 38 /* Define to prevent recursive inclusion -------------------------------------*/
jhon309 0:ac8863619623 39 #ifndef __STM32F0xx_HAL_IWDG_H
jhon309 0:ac8863619623 40 #define __STM32F0xx_HAL_IWDG_H
jhon309 0:ac8863619623 41
jhon309 0:ac8863619623 42 #ifdef __cplusplus
jhon309 0:ac8863619623 43 extern "C" {
jhon309 0:ac8863619623 44 #endif
jhon309 0:ac8863619623 45
jhon309 0:ac8863619623 46 /* Includes ------------------------------------------------------------------*/
jhon309 0:ac8863619623 47 #include "stm32f0xx_hal_def.h"
jhon309 0:ac8863619623 48
jhon309 0:ac8863619623 49 /** @addtogroup STM32F0xx_HAL_Driver
jhon309 0:ac8863619623 50 * @{
jhon309 0:ac8863619623 51 */
jhon309 0:ac8863619623 52
jhon309 0:ac8863619623 53 /** @addtogroup IWDG
jhon309 0:ac8863619623 54 * @{
jhon309 0:ac8863619623 55 */
jhon309 0:ac8863619623 56
jhon309 0:ac8863619623 57 /* Exported types ------------------------------------------------------------*/
jhon309 0:ac8863619623 58
jhon309 0:ac8863619623 59 /** @defgroup IWDG_Exported_Types IWDG Exported Types
jhon309 0:ac8863619623 60 * @{
jhon309 0:ac8863619623 61 */
jhon309 0:ac8863619623 62
jhon309 0:ac8863619623 63 /**
jhon309 0:ac8863619623 64 * @brief IWDG HAL State Structure definition
jhon309 0:ac8863619623 65 */
jhon309 0:ac8863619623 66 typedef enum
jhon309 0:ac8863619623 67 {
jhon309 0:ac8863619623 68 HAL_IWDG_STATE_RESET = 0x00, /*!< IWDG not yet initialized or disabled */
jhon309 0:ac8863619623 69 HAL_IWDG_STATE_READY = 0x01, /*!< IWDG initialized and ready for use */
jhon309 0:ac8863619623 70 HAL_IWDG_STATE_BUSY = 0x02, /*!< IWDG internal process is ongoing */
jhon309 0:ac8863619623 71 HAL_IWDG_STATE_TIMEOUT = 0x03, /*!< IWDG timeout state */
jhon309 0:ac8863619623 72 HAL_IWDG_STATE_ERROR = 0x04 /*!< IWDG error state */
jhon309 0:ac8863619623 73
jhon309 0:ac8863619623 74 }HAL_IWDG_StateTypeDef;
jhon309 0:ac8863619623 75
jhon309 0:ac8863619623 76 /**
jhon309 0:ac8863619623 77 * @brief IWDG Init structure definition
jhon309 0:ac8863619623 78 */
jhon309 0:ac8863619623 79 typedef struct
jhon309 0:ac8863619623 80 {
jhon309 0:ac8863619623 81 uint32_t Prescaler; /*!< Select the prescaler of the IWDG.
jhon309 0:ac8863619623 82 This parameter can be a value of @ref IWDG_Prescaler */
jhon309 0:ac8863619623 83
jhon309 0:ac8863619623 84 uint32_t Reload; /*!< Specifies the IWDG down-counter reload value.
jhon309 0:ac8863619623 85 This parameter must be a number between Min_Data = 0 and Max_Data = 0x0FFF */
jhon309 0:ac8863619623 86
jhon309 0:ac8863619623 87 uint32_t Window; /*!< Specifies the window value to be compared to the down-counter.
jhon309 0:ac8863619623 88 This parameter must be a number between Min_Data = 0 and Max_Data = 0x0FFF */
jhon309 0:ac8863619623 89
jhon309 0:ac8863619623 90 } IWDG_InitTypeDef;
jhon309 0:ac8863619623 91
jhon309 0:ac8863619623 92 /**
jhon309 0:ac8863619623 93 * @brief IWDG Handle Structure definition
jhon309 0:ac8863619623 94 */
jhon309 0:ac8863619623 95 typedef struct
jhon309 0:ac8863619623 96 {
jhon309 0:ac8863619623 97 IWDG_TypeDef *Instance; /*!< Register base address */
jhon309 0:ac8863619623 98
jhon309 0:ac8863619623 99 IWDG_InitTypeDef Init; /*!< IWDG required parameters */
jhon309 0:ac8863619623 100
jhon309 0:ac8863619623 101 HAL_LockTypeDef Lock; /*!< IWDG Locking object */
jhon309 0:ac8863619623 102
jhon309 0:ac8863619623 103 __IO HAL_IWDG_StateTypeDef State; /*!< IWDG communication state */
jhon309 0:ac8863619623 104
jhon309 0:ac8863619623 105 }IWDG_HandleTypeDef;
jhon309 0:ac8863619623 106
jhon309 0:ac8863619623 107 /**
jhon309 0:ac8863619623 108 * @}
jhon309 0:ac8863619623 109 */
jhon309 0:ac8863619623 110
jhon309 0:ac8863619623 111 /* Exported constants --------------------------------------------------------*/
jhon309 0:ac8863619623 112
jhon309 0:ac8863619623 113 /** @defgroup IWDG_Exported_Constants IWDG Exported Constants
jhon309 0:ac8863619623 114 * @{
jhon309 0:ac8863619623 115 */
jhon309 0:ac8863619623 116
jhon309 0:ac8863619623 117 /** @defgroup IWDG_Registers_BitMask IWDG Registers BitMask
jhon309 0:ac8863619623 118 * @brief IWDG registers bit mask
jhon309 0:ac8863619623 119 * @{
jhon309 0:ac8863619623 120 */
jhon309 0:ac8863619623 121 /* --- KR Register ---*/
jhon309 0:ac8863619623 122 /* KR register bit mask */
jhon309 0:ac8863619623 123 #define KR_KEY_RELOAD ((uint32_t)0xAAAA) /*!< IWDG Reload Counter Enable */
jhon309 0:ac8863619623 124 #define KR_KEY_ENABLE ((uint32_t)0xCCCC) /*!< IWDG Peripheral Enable */
jhon309 0:ac8863619623 125 #define KR_KEY_EWA ((uint32_t)0x5555) /*!< IWDG KR Write Access Enable */
jhon309 0:ac8863619623 126 #define KR_KEY_DWA ((uint32_t)0x0000) /*!< IWDG KR Write Access Disable */
jhon309 0:ac8863619623 127
jhon309 0:ac8863619623 128 #define IS_IWDG_KR(__KR__) (((__KR__) == KR_KEY_RELOAD) || \
jhon309 0:ac8863619623 129 ((__KR__) == KR_KEY_ENABLE))|| \
jhon309 0:ac8863619623 130 ((__KR__) == KR_KEY_EWA)) || \
jhon309 0:ac8863619623 131 ((__KR__) == KR_KEY_DWA))
jhon309 0:ac8863619623 132 /**
jhon309 0:ac8863619623 133 * @}
jhon309 0:ac8863619623 134 */
jhon309 0:ac8863619623 135
jhon309 0:ac8863619623 136 /** @defgroup IWDG_Flag_definition IWDG Flag definition
jhon309 0:ac8863619623 137 * @{
jhon309 0:ac8863619623 138 */
jhon309 0:ac8863619623 139 #define IWDG_FLAG_PVU ((uint32_t)IWDG_SR_PVU) /*!< Watchdog counter prescaler value update Flag */
jhon309 0:ac8863619623 140 #define IWDG_FLAG_RVU ((uint32_t)IWDG_SR_RVU) /*!< Watchdog counter reload value update Flag */
jhon309 0:ac8863619623 141 #define IWDG_FLAG_WVU ((uint32_t)IWDG_SR_WVU) /*!< Watchdog counter window value update Flag */
jhon309 0:ac8863619623 142
jhon309 0:ac8863619623 143 /**
jhon309 0:ac8863619623 144 * @}
jhon309 0:ac8863619623 145 */
jhon309 0:ac8863619623 146
jhon309 0:ac8863619623 147 /** @defgroup IWDG_Prescaler IWDG Prescaler
jhon309 0:ac8863619623 148 * @{
jhon309 0:ac8863619623 149 */
jhon309 0:ac8863619623 150 #define IWDG_PRESCALER_4 ((uint8_t)0x00) /*!< IWDG prescaler set to 4 */
jhon309 0:ac8863619623 151 #define IWDG_PRESCALER_8 ((uint8_t)(IWDG_PR_PR_0)) /*!< IWDG prescaler set to 8 */
jhon309 0:ac8863619623 152 #define IWDG_PRESCALER_16 ((uint8_t)(IWDG_PR_PR_1)) /*!< IWDG prescaler set to 16 */
jhon309 0:ac8863619623 153 #define IWDG_PRESCALER_32 ((uint8_t)(IWDG_PR_PR_1 | IWDG_PR_PR_0)) /*!< IWDG prescaler set to 32 */
jhon309 0:ac8863619623 154 #define IWDG_PRESCALER_64 ((uint8_t)(IWDG_PR_PR_2)) /*!< IWDG prescaler set to 64 */
jhon309 0:ac8863619623 155 #define IWDG_PRESCALER_128 ((uint8_t)(IWDG_PR_PR_2 | IWDG_PR_PR_0)) /*!< IWDG prescaler set to 128 */
jhon309 0:ac8863619623 156 #define IWDG_PRESCALER_256 ((uint8_t)(IWDG_PR_PR_2 | IWDG_PR_PR_1)) /*!< IWDG prescaler set to 256 */
jhon309 0:ac8863619623 157
jhon309 0:ac8863619623 158 #define IS_IWDG_PRESCALER(__PRESCALER__) (((__PRESCALER__) == IWDG_PRESCALER_4) || \
jhon309 0:ac8863619623 159 ((__PRESCALER__) == IWDG_PRESCALER_8) || \
jhon309 0:ac8863619623 160 ((__PRESCALER__) == IWDG_PRESCALER_16) || \
jhon309 0:ac8863619623 161 ((__PRESCALER__) == IWDG_PRESCALER_32) || \
jhon309 0:ac8863619623 162 ((__PRESCALER__) == IWDG_PRESCALER_64) || \
jhon309 0:ac8863619623 163 ((__PRESCALER__) == IWDG_PRESCALER_128)|| \
jhon309 0:ac8863619623 164 ((__PRESCALER__) == IWDG_PRESCALER_256))
jhon309 0:ac8863619623 165
jhon309 0:ac8863619623 166 /**
jhon309 0:ac8863619623 167 * @}
jhon309 0:ac8863619623 168 */
jhon309 0:ac8863619623 169
jhon309 0:ac8863619623 170 /** @defgroup IWDG_Reload_Value IWDG Reload Value
jhon309 0:ac8863619623 171 * @{
jhon309 0:ac8863619623 172 */
jhon309 0:ac8863619623 173 #define IS_IWDG_RELOAD(__RELOAD__) ((__RELOAD__) <= 0xFFF)
jhon309 0:ac8863619623 174 /**
jhon309 0:ac8863619623 175 * @}
jhon309 0:ac8863619623 176 */
jhon309 0:ac8863619623 177
jhon309 0:ac8863619623 178 /** @defgroup IWDG_CounterWindow_Value IWDG CounterWindow Value
jhon309 0:ac8863619623 179 * @{
jhon309 0:ac8863619623 180 */
jhon309 0:ac8863619623 181 #define IS_IWDG_WINDOW(__VALUE__) ((__VALUE__) <= 0xFFF)
jhon309 0:ac8863619623 182 /**
jhon309 0:ac8863619623 183 * @}
jhon309 0:ac8863619623 184 */
jhon309 0:ac8863619623 185 /** @defgroup IWDG_Window_option IWDG Window option
jhon309 0:ac8863619623 186 * @{
jhon309 0:ac8863619623 187 */
jhon309 0:ac8863619623 188 #define IWDG_WINDOW_DISABLE 0xFFF
jhon309 0:ac8863619623 189 /**
jhon309 0:ac8863619623 190 * @}
jhon309 0:ac8863619623 191 */
jhon309 0:ac8863619623 192
jhon309 0:ac8863619623 193 /**
jhon309 0:ac8863619623 194 * @}
jhon309 0:ac8863619623 195 */
jhon309 0:ac8863619623 196
jhon309 0:ac8863619623 197 /* Exported macros -----------------------------------------------------------*/
jhon309 0:ac8863619623 198
jhon309 0:ac8863619623 199 /** @defgroup IWDG_Exported_Macros IWDG Exported Macros
jhon309 0:ac8863619623 200 * @{
jhon309 0:ac8863619623 201 */
jhon309 0:ac8863619623 202
jhon309 0:ac8863619623 203 /** @brief Reset IWDG handle state
jhon309 0:ac8863619623 204 * @param __HANDLE__: IWDG handle.
jhon309 0:ac8863619623 205 * @retval None
jhon309 0:ac8863619623 206 */
jhon309 0:ac8863619623 207 #define __HAL_IWDG_RESET_HANDLE_STATE(__HANDLE__) ((__HANDLE__)->State = HAL_IWDG_STATE_RESET)
jhon309 0:ac8863619623 208
jhon309 0:ac8863619623 209 /**
jhon309 0:ac8863619623 210 * @brief Enables the IWDG peripheral.
jhon309 0:ac8863619623 211 * @param __HANDLE__: IWDG handle
jhon309 0:ac8863619623 212 * @retval None
jhon309 0:ac8863619623 213 */
jhon309 0:ac8863619623 214 #define __HAL_IWDG_START(__HANDLE__) WRITE_REG((__HANDLE__)->Instance->KR, KR_KEY_ENABLE)
jhon309 0:ac8863619623 215
jhon309 0:ac8863619623 216 /**
jhon309 0:ac8863619623 217 * @brief Reloads IWDG counter with value defined in the reload register
jhon309 0:ac8863619623 218 * (write access to IWDG_PR and IWDG_RLR registers disabled).
jhon309 0:ac8863619623 219 * @param __HANDLE__: IWDG handle
jhon309 0:ac8863619623 220 * @retval None
jhon309 0:ac8863619623 221 */
jhon309 0:ac8863619623 222 #define __HAL_IWDG_RELOAD_COUNTER(__HANDLE__) WRITE_REG((__HANDLE__)->Instance->KR, KR_KEY_RELOAD)
jhon309 0:ac8863619623 223
jhon309 0:ac8863619623 224 /**
jhon309 0:ac8863619623 225 * @brief Enable write access to IWDG_PR, IWDG_RLR and IWDG_WINR registers.
jhon309 0:ac8863619623 226 * @param __HANDLE__: IWDG handle
jhon309 0:ac8863619623 227 * @retval None
jhon309 0:ac8863619623 228 */
jhon309 0:ac8863619623 229 #define __HAL_IWDG_ENABLE_WRITE_ACCESS(__HANDLE__) WRITE_REG((__HANDLE__)->Instance->KR, KR_KEY_EWA)
jhon309 0:ac8863619623 230
jhon309 0:ac8863619623 231 /**
jhon309 0:ac8863619623 232 * @brief Disable write access to IWDG_PR, IWDG_RLR and IWDG_WINR registers.
jhon309 0:ac8863619623 233 * @param __HANDLE__: IWDG handle
jhon309 0:ac8863619623 234 * @retval None
jhon309 0:ac8863619623 235 */
jhon309 0:ac8863619623 236 #define __HAL_IWDG_DISABLE_WRITE_ACCESS(__HANDLE__) WRITE_REG((__HANDLE__)->Instance->KR, KR_KEY_DWA)
jhon309 0:ac8863619623 237
jhon309 0:ac8863619623 238 /**
jhon309 0:ac8863619623 239 * @brief Gets the selected IWDG's flag status.
jhon309 0:ac8863619623 240 * @param __HANDLE__: IWDG handle
jhon309 0:ac8863619623 241 * @param __FLAG__: specifies the flag to check.
jhon309 0:ac8863619623 242 * This parameter can be one of the following values:
jhon309 0:ac8863619623 243 * @arg IWDG_FLAG_PVU: Watchdog counter reload value update flag
jhon309 0:ac8863619623 244 * @arg IWDG_FLAG_RVU: Watchdog counter prescaler value flag
jhon309 0:ac8863619623 245 * @arg IWDG_FLAG_WVU: Watchdog counter window value flag
jhon309 0:ac8863619623 246 * @retval The new state of __FLAG__ (TRUE or FALSE).
jhon309 0:ac8863619623 247 */
jhon309 0:ac8863619623 248 #define __HAL_IWDG_GET_FLAG(__HANDLE__, __FLAG__) (((__HANDLE__)->Instance->SR & (__FLAG__)) == (__FLAG__))
jhon309 0:ac8863619623 249
jhon309 0:ac8863619623 250 /**
jhon309 0:ac8863619623 251 * @}
jhon309 0:ac8863619623 252 */
jhon309 0:ac8863619623 253
jhon309 0:ac8863619623 254 /* Exported functions --------------------------------------------------------*/
jhon309 0:ac8863619623 255
jhon309 0:ac8863619623 256 /** @addtogroup IWDG_Exported_Functions
jhon309 0:ac8863619623 257 * @{
jhon309 0:ac8863619623 258 */
jhon309 0:ac8863619623 259
jhon309 0:ac8863619623 260 /** @addtogroup IWDG_Exported_Functions_Group1
jhon309 0:ac8863619623 261 * @{
jhon309 0:ac8863619623 262 */
jhon309 0:ac8863619623 263 /* Initialization/de-initialization functions ********************************/
jhon309 0:ac8863619623 264 HAL_StatusTypeDef HAL_IWDG_Init(IWDG_HandleTypeDef *hiwdg);
jhon309 0:ac8863619623 265 void HAL_IWDG_MspInit(IWDG_HandleTypeDef *hiwdg);
jhon309 0:ac8863619623 266
jhon309 0:ac8863619623 267 /**
jhon309 0:ac8863619623 268 * @}
jhon309 0:ac8863619623 269 */
jhon309 0:ac8863619623 270
jhon309 0:ac8863619623 271 /** @addtogroup IWDG_Exported_Functions_Group2
jhon309 0:ac8863619623 272 * @{
jhon309 0:ac8863619623 273 */
jhon309 0:ac8863619623 274 /* I/O operation functions ****************************************************/
jhon309 0:ac8863619623 275 HAL_StatusTypeDef HAL_IWDG_Start(IWDG_HandleTypeDef *hiwdg);
jhon309 0:ac8863619623 276 HAL_StatusTypeDef HAL_IWDG_Refresh(IWDG_HandleTypeDef *hiwdg);
jhon309 0:ac8863619623 277
jhon309 0:ac8863619623 278 /**
jhon309 0:ac8863619623 279 * @}
jhon309 0:ac8863619623 280 */
jhon309 0:ac8863619623 281
jhon309 0:ac8863619623 282 /** @addtogroup IWDG_Exported_Functions_Group3
jhon309 0:ac8863619623 283 * @{
jhon309 0:ac8863619623 284 */
jhon309 0:ac8863619623 285 /* Peripheral State functions ************************************************/
jhon309 0:ac8863619623 286 HAL_IWDG_StateTypeDef HAL_IWDG_GetState(IWDG_HandleTypeDef *hiwdg);
jhon309 0:ac8863619623 287
jhon309 0:ac8863619623 288 /**
jhon309 0:ac8863619623 289 * @}
jhon309 0:ac8863619623 290 */
jhon309 0:ac8863619623 291
jhon309 0:ac8863619623 292 /**
jhon309 0:ac8863619623 293 * @}
jhon309 0:ac8863619623 294 */
jhon309 0:ac8863619623 295
jhon309 0:ac8863619623 296 /**
jhon309 0:ac8863619623 297 * @}
jhon309 0:ac8863619623 298 */
jhon309 0:ac8863619623 299
jhon309 0:ac8863619623 300 /**
jhon309 0:ac8863619623 301 * @}
jhon309 0:ac8863619623 302 */
jhon309 0:ac8863619623 303
jhon309 0:ac8863619623 304 #ifdef __cplusplus
jhon309 0:ac8863619623 305 }
jhon309 0:ac8863619623 306 #endif
jhon309 0:ac8863619623 307
jhon309 0:ac8863619623 308 #endif /* __STM32F0xx_HAL_IWDG_H */
jhon309 0:ac8863619623 309
jhon309 0:ac8863619623 310 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/
jhon309 0:ac8863619623 311