shao ziyang / mbed-src-kl05

mbed library sources

Dependents:   frdm_kl05z_gpio_test

Fork of mbed-src by mbed official

targets/cmsis/TARGET_STM/TARGET_NUCLEO_F411RE/stm32f4xx_hal_wwdg.h@235:685d5f11838f, 2014-06-23 (annotated)

Committer:
mbed_official
Date:
Mon Jun 23 14:00:09 2014 +0100
Revision:
235:685d5f11838f
Synchronized with git revision 9728c76667962b289ee9c4c687ef9f115db48cd3



Full URL: https://github.com/mbedmicro/mbed/commit/9728c76667962b289ee9c4c687ef9f115db48cd3/



[NUCLEO_F411RE] Add all target files

Who changed what in which revision?

UserRevisionLine numberNew contents of line
mbed_official 235:685d5f11838f 1 /**
mbed_official 235:685d5f11838f 2 ******************************************************************************
mbed_official 235:685d5f11838f 3 * @file stm32f4xx_hal_wwdg.h
mbed_official 235:685d5f11838f 4 * @author MCD Application Team
mbed_official 235:685d5f11838f 5 * @version V1.1.0
mbed_official 235:685d5f11838f 6 * @date 19-June-2014
mbed_official 235:685d5f11838f 7 * @brief Header file of WWDG HAL module.
mbed_official 235:685d5f11838f 8 ******************************************************************************
mbed_official 235:685d5f11838f 9 * @attention
mbed_official 235:685d5f11838f 10 *
mbed_official 235:685d5f11838f 11 * <h2><center>&copy; COPYRIGHT(c) 2014 STMicroelectronics</center></h2>
mbed_official 235:685d5f11838f 12 *
mbed_official 235:685d5f11838f 13 * Redistribution and use in source and binary forms, with or without modification,
mbed_official 235:685d5f11838f 14 * are permitted provided that the following conditions are met:
mbed_official 235:685d5f11838f 15 * 1. Redistributions of source code must retain the above copyright notice,
mbed_official 235:685d5f11838f 16 * this list of conditions and the following disclaimer.
mbed_official 235:685d5f11838f 17 * 2. Redistributions in binary form must reproduce the above copyright notice,
mbed_official 235:685d5f11838f 18 * this list of conditions and the following disclaimer in the documentation
mbed_official 235:685d5f11838f 19 * and/or other materials provided with the distribution.
mbed_official 235:685d5f11838f 20 * 3. Neither the name of STMicroelectronics nor the names of its contributors
mbed_official 235:685d5f11838f 21 * may be used to endorse or promote products derived from this software
mbed_official 235:685d5f11838f 22 * without specific prior written permission.
mbed_official 235:685d5f11838f 23 *
mbed_official 235:685d5f11838f 24 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
mbed_official 235:685d5f11838f 25 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
mbed_official 235:685d5f11838f 26 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
mbed_official 235:685d5f11838f 27 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
mbed_official 235:685d5f11838f 28 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
mbed_official 235:685d5f11838f 29 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
mbed_official 235:685d5f11838f 30 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
mbed_official 235:685d5f11838f 31 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
mbed_official 235:685d5f11838f 32 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
mbed_official 235:685d5f11838f 33 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
mbed_official 235:685d5f11838f 34 *
mbed_official 235:685d5f11838f 35 ******************************************************************************
mbed_official 235:685d5f11838f 36 */
mbed_official 235:685d5f11838f 37
mbed_official 235:685d5f11838f 38 /* Define to prevent recursive inclusion -------------------------------------*/
mbed_official 235:685d5f11838f 39 #ifndef __STM32F4xx_HAL_WWDG_H
mbed_official 235:685d5f11838f 40 #define __STM32F4xx_HAL_WWDG_H
mbed_official 235:685d5f11838f 41
mbed_official 235:685d5f11838f 42 #ifdef __cplusplus
mbed_official 235:685d5f11838f 43 extern "C" {
mbed_official 235:685d5f11838f 44 #endif
mbed_official 235:685d5f11838f 45
mbed_official 235:685d5f11838f 46 /* Includes ------------------------------------------------------------------*/
mbed_official 235:685d5f11838f 47 #include "stm32f4xx_hal_def.h"
mbed_official 235:685d5f11838f 48
mbed_official 235:685d5f11838f 49 /** @addtogroup STM32F4xx_HAL_Driver
mbed_official 235:685d5f11838f 50 * @{
mbed_official 235:685d5f11838f 51 */
mbed_official 235:685d5f11838f 52
mbed_official 235:685d5f11838f 53 /** @addtogroup WWDG
mbed_official 235:685d5f11838f 54 * @{
mbed_official 235:685d5f11838f 55 */
mbed_official 235:685d5f11838f 56
mbed_official 235:685d5f11838f 57 /* Exported types ------------------------------------------------------------*/
mbed_official 235:685d5f11838f 58
mbed_official 235:685d5f11838f 59 /**
mbed_official 235:685d5f11838f 60 * @brief WWDG HAL State Structure definition
mbed_official 235:685d5f11838f 61 */
mbed_official 235:685d5f11838f 62 typedef enum
mbed_official 235:685d5f11838f 63 {
mbed_official 235:685d5f11838f 64 HAL_WWDG_STATE_RESET = 0x00, /*!< WWDG not yet initialized or disabled */
mbed_official 235:685d5f11838f 65 HAL_WWDG_STATE_READY = 0x01, /*!< WWDG initialized and ready for use */
mbed_official 235:685d5f11838f 66 HAL_WWDG_STATE_BUSY = 0x02, /*!< WWDG internal process is ongoing */
mbed_official 235:685d5f11838f 67 HAL_WWDG_STATE_TIMEOUT = 0x03, /*!< WWDG timeout state */
mbed_official 235:685d5f11838f 68 HAL_WWDG_STATE_ERROR = 0x04 /*!< WWDG error state */
mbed_official 235:685d5f11838f 69 }HAL_WWDG_StateTypeDef;
mbed_official 235:685d5f11838f 70
mbed_official 235:685d5f11838f 71 /**
mbed_official 235:685d5f11838f 72 * @brief WWDG Init structure definition
mbed_official 235:685d5f11838f 73 */
mbed_official 235:685d5f11838f 74 typedef struct
mbed_official 235:685d5f11838f 75 {
mbed_official 235:685d5f11838f 76 uint32_t Prescaler; /*!< Specifies the prescaler value of the WWDG.
mbed_official 235:685d5f11838f 77 This parameter can be a value of @ref WWDG_Prescaler */
mbed_official 235:685d5f11838f 78
mbed_official 235:685d5f11838f 79 uint32_t Window; /*!< Specifies the WWDG window value to be compared to the downcounter.
mbed_official 235:685d5f11838f 80 This parameter must be a number lower than Max_Data = 0x80 */
mbed_official 235:685d5f11838f 81
mbed_official 235:685d5f11838f 82 uint32_t Counter; /*!< Specifies the WWDG free-running downcounter value.
mbed_official 235:685d5f11838f 83 This parameter must be a number between Min_Data = 0x40 and Max_Data = 0x7F */
mbed_official 235:685d5f11838f 84
mbed_official 235:685d5f11838f 85 }WWDG_InitTypeDef;
mbed_official 235:685d5f11838f 86
mbed_official 235:685d5f11838f 87 /**
mbed_official 235:685d5f11838f 88 * @brief WWDG handle Structure definition
mbed_official 235:685d5f11838f 89 */
mbed_official 235:685d5f11838f 90 typedef struct
mbed_official 235:685d5f11838f 91 {
mbed_official 235:685d5f11838f 92 WWDG_TypeDef *Instance; /*!< Register base address */
mbed_official 235:685d5f11838f 93
mbed_official 235:685d5f11838f 94 WWDG_InitTypeDef Init; /*!< WWDG required parameters */
mbed_official 235:685d5f11838f 95
mbed_official 235:685d5f11838f 96 HAL_LockTypeDef Lock; /*!< WWDG locking object */
mbed_official 235:685d5f11838f 97
mbed_official 235:685d5f11838f 98 __IO HAL_WWDG_StateTypeDef State; /*!< WWDG communication state */
mbed_official 235:685d5f11838f 99
mbed_official 235:685d5f11838f 100 }WWDG_HandleTypeDef;
mbed_official 235:685d5f11838f 101
mbed_official 235:685d5f11838f 102 /* Exported constants --------------------------------------------------------*/
mbed_official 235:685d5f11838f 103
mbed_official 235:685d5f11838f 104 /** @defgroup WWDG_Exported_Constants
mbed_official 235:685d5f11838f 105 * @{
mbed_official 235:685d5f11838f 106 */
mbed_official 235:685d5f11838f 107
mbed_official 235:685d5f11838f 108 /** @defgroup WWDG_BitAddress_AliasRegion
mbed_official 235:685d5f11838f 109 * @brief WWDG registers bit address in the alias region
mbed_official 235:685d5f11838f 110 * @{
mbed_official 235:685d5f11838f 111 */
mbed_official 235:685d5f11838f 112
mbed_official 235:685d5f11838f 113 /* --- CFR Register ---*/
mbed_official 235:685d5f11838f 114 /* Alias word address of EWI bit */
mbed_official 235:685d5f11838f 115 #define CFR_BASE (uint32_t)(WWDG_BASE + 0x04)
mbed_official 235:685d5f11838f 116
mbed_official 235:685d5f11838f 117 /**
mbed_official 235:685d5f11838f 118 * @}
mbed_official 235:685d5f11838f 119 */
mbed_official 235:685d5f11838f 120
mbed_official 235:685d5f11838f 121 /** @defgroup WWDG_Interrupt_definition
mbed_official 235:685d5f11838f 122 * @{
mbed_official 235:685d5f11838f 123 */
mbed_official 235:685d5f11838f 124 #define WWDG_IT_EWI ((uint32_t)WWDG_CFR_EWI)
mbed_official 235:685d5f11838f 125
mbed_official 235:685d5f11838f 126 #define IS_WWDG_IT(__IT__) ((__IT__) == WWDG_IT_EWI)
mbed_official 235:685d5f11838f 127
mbed_official 235:685d5f11838f 128 /**
mbed_official 235:685d5f11838f 129 * @}
mbed_official 235:685d5f11838f 130 */
mbed_official 235:685d5f11838f 131
mbed_official 235:685d5f11838f 132 /** @defgroup WWDG_Flag_definition
mbed_official 235:685d5f11838f 133 * @brief WWDG Flag definition
mbed_official 235:685d5f11838f 134 * @{
mbed_official 235:685d5f11838f 135 */
mbed_official 235:685d5f11838f 136 #define WWDG_FLAG_EWIF ((uint32_t)WWDG_SR_EWIF) /*!< Early wakeup interrupt flag */
mbed_official 235:685d5f11838f 137 #define IS_WWDG_FLAG(__FLAG__) ((__FLAG__) == WWDG_FLAG_EWIF))
mbed_official 235:685d5f11838f 138
mbed_official 235:685d5f11838f 139
mbed_official 235:685d5f11838f 140 /**
mbed_official 235:685d5f11838f 141 * @}
mbed_official 235:685d5f11838f 142 */
mbed_official 235:685d5f11838f 143
mbed_official 235:685d5f11838f 144 /** @defgroup WWDG_Prescaler
mbed_official 235:685d5f11838f 145 * @{
mbed_official 235:685d5f11838f 146 */
mbed_official 235:685d5f11838f 147 #define WWDG_PRESCALER_1 ((uint32_t)0x00000000) /*!< WWDG counter clock = (PCLK1/4096)/1 */
mbed_official 235:685d5f11838f 148 #define WWDG_PRESCALER_2 ((uint32_t)WWDG_CFR_WDGTB0) /*!< WWDG counter clock = (PCLK1/4096)/2 */
mbed_official 235:685d5f11838f 149 #define WWDG_PRESCALER_4 ((uint32_t)WWDG_CFR_WDGTB1) /*!< WWDG counter clock = (PCLK1/4096)/4 */
mbed_official 235:685d5f11838f 150 #define WWDG_PRESCALER_8 ((uint32_t)WWDG_CFR_WDGTB) /*!< WWDG counter clock = (PCLK1/4096)/8 */
mbed_official 235:685d5f11838f 151
mbed_official 235:685d5f11838f 152 #define IS_WWDG_PRESCALER(__PRESCALER__) (((__PRESCALER__) == WWDG_PRESCALER_1) || \
mbed_official 235:685d5f11838f 153 ((__PRESCALER__) == WWDG_PRESCALER_2) || \
mbed_official 235:685d5f11838f 154 ((__PRESCALER__) == WWDG_PRESCALER_4) || \
mbed_official 235:685d5f11838f 155 ((__PRESCALER__) == WWDG_PRESCALER_8))
mbed_official 235:685d5f11838f 156
mbed_official 235:685d5f11838f 157 /**
mbed_official 235:685d5f11838f 158 * @}
mbed_official 235:685d5f11838f 159 */
mbed_official 235:685d5f11838f 160
mbed_official 235:685d5f11838f 161 /** @defgroup WWDG_Window
mbed_official 235:685d5f11838f 162 * @{
mbed_official 235:685d5f11838f 163 */
mbed_official 235:685d5f11838f 164 #define IS_WWDG_WINDOW(__WINDOW__) ((__WINDOW__) <= 0x7F)
mbed_official 235:685d5f11838f 165
mbed_official 235:685d5f11838f 166 /**
mbed_official 235:685d5f11838f 167 * @}
mbed_official 235:685d5f11838f 168 */
mbed_official 235:685d5f11838f 169
mbed_official 235:685d5f11838f 170 /** @defgroup WWDG_Counter
mbed_official 235:685d5f11838f 171 * @{
mbed_official 235:685d5f11838f 172 */
mbed_official 235:685d5f11838f 173 #define IS_WWDG_COUNTER(__COUNTER__) (((__COUNTER__) >= 0x40) && ((__COUNTER__) <= 0x7F))
mbed_official 235:685d5f11838f 174
mbed_official 235:685d5f11838f 175 /**
mbed_official 235:685d5f11838f 176 * @}
mbed_official 235:685d5f11838f 177 */
mbed_official 235:685d5f11838f 178
mbed_official 235:685d5f11838f 179 /**
mbed_official 235:685d5f11838f 180 * @}
mbed_official 235:685d5f11838f 181 */
mbed_official 235:685d5f11838f 182
mbed_official 235:685d5f11838f 183 /* Exported macro ------------------------------------------------------------*/
mbed_official 235:685d5f11838f 184
mbed_official 235:685d5f11838f 185 /** @brief Reset WWDG handle state
mbed_official 235:685d5f11838f 186 * @param __HANDLE__: WWDG handle
mbed_official 235:685d5f11838f 187 * @retval None
mbed_official 235:685d5f11838f 188 */
mbed_official 235:685d5f11838f 189 #define __HAL_WWDG_RESET_HANDLE_STATE(__HANDLE__) ((__HANDLE__)->State = HAL_WWDG_STATE_RESET)
mbed_official 235:685d5f11838f 190
mbed_official 235:685d5f11838f 191 /**
mbed_official 235:685d5f11838f 192 * @brief Enables the WWDG peripheral.
mbed_official 235:685d5f11838f 193 * @param __HANDLE__: WWDG handle
mbed_official 235:685d5f11838f 194 * @retval None
mbed_official 235:685d5f11838f 195 */
mbed_official 235:685d5f11838f 196 #define __HAL_WWDG_ENABLE(__HANDLE__) SET_BIT((__HANDLE__)->Instance->CR, WWDG_CR_WDGA)
mbed_official 235:685d5f11838f 197
mbed_official 235:685d5f11838f 198 /**
mbed_official 235:685d5f11838f 199 * @brief Gets the selected WWDG's flag status.
mbed_official 235:685d5f11838f 200 * @param __HANDLE__: WWDG handle
mbed_official 235:685d5f11838f 201 * @param __FLAG__: specifies the flag to check.
mbed_official 235:685d5f11838f 202 * This parameter can be one of the following values:
mbed_official 235:685d5f11838f 203 * @arg WWDG_FLAG_EWIF: Early wakeup interrupt flag
mbed_official 235:685d5f11838f 204 * @retval The new state of WWDG_FLAG (SET or RESET).
mbed_official 235:685d5f11838f 205 */
mbed_official 235:685d5f11838f 206 #define __HAL_WWDG_GET_FLAG(__HANDLE__, __FLAG__) (((__HANDLE__)->Instance->SR & (__FLAG__)) == (__FLAG__))
mbed_official 235:685d5f11838f 207
mbed_official 235:685d5f11838f 208 /**
mbed_official 235:685d5f11838f 209 * @brief Clears the WWDG's pending flags.
mbed_official 235:685d5f11838f 210 * @param __HANDLE__: WWDG handle
mbed_official 235:685d5f11838f 211 * @param __FLAG__: specifies the flag to clear.
mbed_official 235:685d5f11838f 212 * This parameter can be one of the following values:
mbed_official 235:685d5f11838f 213 * @arg WWDG_FLAG_EWIF: Early wakeup interrupt flag
mbed_official 235:685d5f11838f 214 * @retval None
mbed_official 235:685d5f11838f 215 */
mbed_official 235:685d5f11838f 216 #define __HAL_WWDG_CLEAR_FLAG(__HANDLE__, __FLAG__) (((__HANDLE__)->Instance->SR) = ~(__FLAG__))
mbed_official 235:685d5f11838f 217
mbed_official 235:685d5f11838f 218 /**
mbed_official 235:685d5f11838f 219 * @brief Enables the WWDG early wakeup interrupt.
mbed_official 235:685d5f11838f 220 * @param __INTERRUPT__: specifies the interrupt to enable.
mbed_official 235:685d5f11838f 221 * This parameter can be one of the following values:
mbed_official 235:685d5f11838f 222 * @arg WWDG_IT_EWI: Early wakeup interrupt
mbed_official 235:685d5f11838f 223 * @note Once enabled this interrupt cannot be disabled except by a system reset.
mbed_official 235:685d5f11838f 224 * @retval None
mbed_official 235:685d5f11838f 225 */
mbed_official 235:685d5f11838f 226 #define __HAL_WWDG_ENABLE_IT(__INTERRUPT__) (*(__IO uint32_t *) CFR_BASE |= (__INTERRUPT__))
mbed_official 235:685d5f11838f 227
mbed_official 235:685d5f11838f 228 /** @brief Clear the WWDG's interrupt pending bits
mbed_official 235:685d5f11838f 229 * bits to clear the selected interrupt pending bits.
mbed_official 235:685d5f11838f 230 * @param __HANDLE__: WWDG handle
mbed_official 235:685d5f11838f 231 * @param __INTERRUPT__: specifies the interrupt pending bit to clear.
mbed_official 235:685d5f11838f 232 * This parameter can be one of the following values:
mbed_official 235:685d5f11838f 233 * @arg WWDG_FLAG_EWIF: Early wakeup interrupt flag
mbed_official 235:685d5f11838f 234 */
mbed_official 235:685d5f11838f 235 #define __HAL_WWDG_CLEAR_IT(__HANDLE__, __INTERRUPT__) __HAL_WWDG_CLEAR_FLAG((__HANDLE__), (__INTERRUPT__))
mbed_official 235:685d5f11838f 236 /* Exported functions --------------------------------------------------------*/
mbed_official 235:685d5f11838f 237
mbed_official 235:685d5f11838f 238 /* Initialization/de-initialization functions **********************************/
mbed_official 235:685d5f11838f 239 HAL_StatusTypeDef HAL_WWDG_Init(WWDG_HandleTypeDef *hwwdg);
mbed_official 235:685d5f11838f 240 HAL_StatusTypeDef HAL_WWDG_DeInit(WWDG_HandleTypeDef *hwwdg);
mbed_official 235:685d5f11838f 241 void HAL_WWDG_MspInit(WWDG_HandleTypeDef *hwwdg);
mbed_official 235:685d5f11838f 242 void HAL_WWDG_MspDeInit(WWDG_HandleTypeDef *hwwdg);
mbed_official 235:685d5f11838f 243 void HAL_WWDG_WakeupCallback(WWDG_HandleTypeDef* hwwdg);
mbed_official 235:685d5f11838f 244
mbed_official 235:685d5f11838f 245 /* I/O operation functions ******************************************************/
mbed_official 235:685d5f11838f 246 HAL_StatusTypeDef HAL_WWDG_Start(WWDG_HandleTypeDef *hwwdg);
mbed_official 235:685d5f11838f 247 HAL_StatusTypeDef HAL_WWDG_Start_IT(WWDG_HandleTypeDef *hwwdg);
mbed_official 235:685d5f11838f 248 HAL_StatusTypeDef HAL_WWDG_Refresh(WWDG_HandleTypeDef *hwwdg, uint32_t Counter);
mbed_official 235:685d5f11838f 249 void HAL_WWDG_IRQHandler(WWDG_HandleTypeDef *hwwdg);
mbed_official 235:685d5f11838f 250
mbed_official 235:685d5f11838f 251 /* Peripheral State functions **************************************************/
mbed_official 235:685d5f11838f 252 HAL_WWDG_StateTypeDef HAL_WWDG_GetState(WWDG_HandleTypeDef *hwwdg);
mbed_official 235:685d5f11838f 253
mbed_official 235:685d5f11838f 254 /**
mbed_official 235:685d5f11838f 255 * @}
mbed_official 235:685d5f11838f 256 */
mbed_official 235:685d5f11838f 257
mbed_official 235:685d5f11838f 258 /**
mbed_official 235:685d5f11838f 259 * @}
mbed_official 235:685d5f11838f 260 */
mbed_official 235:685d5f11838f 261
mbed_official 235:685d5f11838f 262 #ifdef __cplusplus
mbed_official 235:685d5f11838f 263 }
mbed_official 235:685d5f11838f 264 #endif
mbed_official 235:685d5f11838f 265
mbed_official 235:685d5f11838f 266 #endif /* __STM32F4xx_HAL_WWDG_H */
mbed_official 235:685d5f11838f 267
mbed_official 235:685d5f11838f 268 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/