Elijah Orr / mbed-renbed

Fork of the official mbed C/C SDK provides the software platform and libraries to build your applications for RenBED.

Dependents:   1-RenBuggyTimed RenBED_RGB RenBED_RGB_PWM RenBED_RGB

Fork of mbed by mbed official

TARGET_ELMO_F411RE/stm32f4xx_hal_iwdg.h@121:672067c3ada4, 2016-04-14 (annotated)

Committer:
elijahorr
Date:
Thu Apr 14 07:28:54 2016 +0000
Revision:
121:672067c3ada4
Parent:
110:165afa46840b 
.

Who changed what in which revision?

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