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_ARCH_MAX/stm32f4xx_hal_iwdg.h@89:552587b429a1, 2014-09-12 (annotated)

Committer:
bogdanm
Date:
Fri Sep 12 16:41:52 2014 +0100
Revision:
89:552587b429a1
Child:
92:4fc01daae5a5
Release 89 of the mbed library



Main changes:



- low power optimizations for Nordic targets

- code structure changes for Freescale K64F targets

- bug fixes in various backends

Who changed what in which revision?

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