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