meh

Fork of mbed by mbed official

Committer:
bogdanm
Date:
Wed Jul 02 13:22:23 2014 +0100
Revision:
86:04dd9b1680ae
Child:
92:4fc01daae5a5
Release 86 of the mbed library

Main changes:


- bug fixes in various backends
- mbed "error" replaced by assert logic (mbed_assert)
- new ST Nucleo targets

Who changed what in which revision?

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