Filippo Casamassima / mbed

my fork

Dependents:   Nucleo_blueNRG

Fork of mbed by mbed official

TARGET_NUCLEO_F072RB/stm32f0xx_hal_iwdg.h@85:024bf7f99721, 2014-06-11 (annotated)

Committer:
bogdanm
Date:
Wed Jun 11 15:14:05 2014 +0100
Revision:
85:024bf7f99721
Child:
92:4fc01daae5a5
Release 85 of the mbed library



Main changes:



- K64F Ethernet fixes

- Updated tests

- Fixes for various mbed targets

- Code cleanup: fixed warnings, more consistent code style

- GCC support for K64F



There is a known issue with the I2C interface on some ST targets. If you

find the I2C interface problematic on your ST board, please log a bug

against this on mbed.org.

Who changed what in which revision?

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