Egor Rumjantsev / mbed

The official mbed C/C SDK provides the software platform and libraries to build your applications.

Fork of mbed by mbed official

TARGET_ARCH_MAX/stm32f4xx_hal_wwdg.h@99:7f6c6de930c0, 2015-05-03 (annotated)

Committer:
Mikchel
Date:
Sun May 03 16:04:42 2015 +0000
Revision:
99:7f6c6de930c0
Parent:
92:4fc01daae5a5 
12

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_wwdg.h
bogdanm 89:552587b429a1 4 * @author MCD Application Team
bogdanm 92:4fc01daae5a5 5 * @version V1.1.0
bogdanm 92:4fc01daae5a5 6 * @date 19-June-2014
bogdanm 89:552587b429a1 7 * @brief Header file of WWDG 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_WWDG_H
bogdanm 89:552587b429a1 40 #define __STM32F4xx_HAL_WWDG_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 WWDG
bogdanm 89:552587b429a1 54 * @{
bogdanm 89:552587b429a1 55 */
bogdanm 89:552587b429a1 56
bogdanm 92:4fc01daae5a5 57 /* Exported types ------------------------------------------------------------*/
bogdanm 89:552587b429a1 58
bogdanm 92:4fc01daae5a5 59 /**
bogdanm 92:4fc01daae5a5 60 * @brief WWDG HAL State Structure definition
bogdanm 92:4fc01daae5a5 61 */
bogdanm 89:552587b429a1 62 typedef enum
bogdanm 89:552587b429a1 63 {
bogdanm 89:552587b429a1 64 HAL_WWDG_STATE_RESET = 0x00, /*!< WWDG not yet initialized or disabled */
bogdanm 89:552587b429a1 65 HAL_WWDG_STATE_READY = 0x01, /*!< WWDG initialized and ready for use */
bogdanm 92:4fc01daae5a5 66 HAL_WWDG_STATE_BUSY = 0x02, /*!< WWDG internal process is ongoing */
bogdanm 89:552587b429a1 67 HAL_WWDG_STATE_TIMEOUT = 0x03, /*!< WWDG timeout state */
bogdanm 89:552587b429a1 68 HAL_WWDG_STATE_ERROR = 0x04 /*!< WWDG error state */
bogdanm 89:552587b429a1 69 }HAL_WWDG_StateTypeDef;
bogdanm 89:552587b429a1 70
bogdanm 89:552587b429a1 71 /**
bogdanm 89:552587b429a1 72 * @brief WWDG Init structure definition
bogdanm 89:552587b429a1 73 */
bogdanm 89:552587b429a1 74 typedef struct
bogdanm 89:552587b429a1 75 {
bogdanm 92:4fc01daae5a5 76 uint32_t Prescaler; /*!< Specifies the prescaler value of the WWDG.
bogdanm 89:552587b429a1 77 This parameter can be a value of @ref WWDG_Prescaler */
bogdanm 89:552587b429a1 78
bogdanm 89:552587b429a1 79 uint32_t Window; /*!< Specifies the WWDG window value to be compared to the downcounter.
bogdanm 89:552587b429a1 80 This parameter must be a number lower than Max_Data = 0x80 */
bogdanm 89:552587b429a1 81
bogdanm 89:552587b429a1 82 uint32_t Counter; /*!< Specifies the WWDG free-running downcounter value.
bogdanm 92:4fc01daae5a5 83 This parameter must be a number between Min_Data = 0x40 and Max_Data = 0x7F */
bogdanm 89:552587b429a1 84
bogdanm 89:552587b429a1 85 }WWDG_InitTypeDef;
bogdanm 89:552587b429a1 86
bogdanm 89:552587b429a1 87 /**
bogdanm 89:552587b429a1 88 * @brief WWDG handle Structure definition
bogdanm 89:552587b429a1 89 */
bogdanm 89:552587b429a1 90 typedef struct
bogdanm 89:552587b429a1 91 {
bogdanm 92:4fc01daae5a5 92 WWDG_TypeDef *Instance; /*!< Register base address */
bogdanm 89:552587b429a1 93
bogdanm 89:552587b429a1 94 WWDG_InitTypeDef Init; /*!< WWDG required parameters */
bogdanm 89:552587b429a1 95
bogdanm 89:552587b429a1 96 HAL_LockTypeDef Lock; /*!< WWDG locking object */
bogdanm 89:552587b429a1 97
bogdanm 89:552587b429a1 98 __IO HAL_WWDG_StateTypeDef State; /*!< WWDG communication state */
bogdanm 89:552587b429a1 99
bogdanm 89:552587b429a1 100 }WWDG_HandleTypeDef;
bogdanm 89:552587b429a1 101
bogdanm 89:552587b429a1 102 /* Exported constants --------------------------------------------------------*/
bogdanm 89:552587b429a1 103
bogdanm 92:4fc01daae5a5 104 /** @defgroup WWDG_Exported_Constants
bogdanm 92:4fc01daae5a5 105 * @{
bogdanm 92:4fc01daae5a5 106 */
bogdanm 92:4fc01daae5a5 107
bogdanm 89:552587b429a1 108 /** @defgroup WWDG_BitAddress_AliasRegion
bogdanm 92:4fc01daae5a5 109 * @brief WWDG registers bit address in the alias region
bogdanm 89:552587b429a1 110 * @{
bogdanm 89:552587b429a1 111 */
bogdanm 89:552587b429a1 112
bogdanm 89:552587b429a1 113 /* --- CFR Register ---*/
bogdanm 89:552587b429a1 114 /* Alias word address of EWI bit */
bogdanm 89:552587b429a1 115 #define CFR_BASE (uint32_t)(WWDG_BASE + 0x04)
bogdanm 89:552587b429a1 116
bogdanm 89:552587b429a1 117 /**
bogdanm 89:552587b429a1 118 * @}
bogdanm 89:552587b429a1 119 */
bogdanm 89:552587b429a1 120
bogdanm 89:552587b429a1 121 /** @defgroup WWDG_Interrupt_definition
bogdanm 89:552587b429a1 122 * @{
bogdanm 89:552587b429a1 123 */
bogdanm 89:552587b429a1 124 #define WWDG_IT_EWI ((uint32_t)WWDG_CFR_EWI)
bogdanm 89:552587b429a1 125
bogdanm 92:4fc01daae5a5 126 #define IS_WWDG_IT(__IT__) ((__IT__) == WWDG_IT_EWI)
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 WWDG_Flag_definition
bogdanm 89:552587b429a1 133 * @brief WWDG Flag definition
bogdanm 89:552587b429a1 134 * @{
bogdanm 89:552587b429a1 135 */
bogdanm 92:4fc01daae5a5 136 #define WWDG_FLAG_EWIF ((uint32_t)WWDG_SR_EWIF) /*!< Early wakeup interrupt flag */
bogdanm 92:4fc01daae5a5 137 #define IS_WWDG_FLAG(__FLAG__) ((__FLAG__) == WWDG_FLAG_EWIF))
bogdanm 89:552587b429a1 138
bogdanm 89:552587b429a1 139
bogdanm 89:552587b429a1 140 /**
bogdanm 89:552587b429a1 141 * @}
bogdanm 89:552587b429a1 142 */
bogdanm 89:552587b429a1 143
bogdanm 89:552587b429a1 144 /** @defgroup WWDG_Prescaler
bogdanm 89:552587b429a1 145 * @{
bogdanm 89:552587b429a1 146 */
bogdanm 89:552587b429a1 147 #define WWDG_PRESCALER_1 ((uint32_t)0x00000000) /*!< WWDG counter clock = (PCLK1/4096)/1 */
bogdanm 92:4fc01daae5a5 148 #define WWDG_PRESCALER_2 ((uint32_t)WWDG_CFR_WDGTB0) /*!< WWDG counter clock = (PCLK1/4096)/2 */
bogdanm 92:4fc01daae5a5 149 #define WWDG_PRESCALER_4 ((uint32_t)WWDG_CFR_WDGTB1) /*!< WWDG counter clock = (PCLK1/4096)/4 */
bogdanm 92:4fc01daae5a5 150 #define WWDG_PRESCALER_8 ((uint32_t)WWDG_CFR_WDGTB) /*!< WWDG counter clock = (PCLK1/4096)/8 */
bogdanm 89:552587b429a1 151
bogdanm 92:4fc01daae5a5 152 #define IS_WWDG_PRESCALER(__PRESCALER__) (((__PRESCALER__) == WWDG_PRESCALER_1) || \
bogdanm 92:4fc01daae5a5 153 ((__PRESCALER__) == WWDG_PRESCALER_2) || \
bogdanm 92:4fc01daae5a5 154 ((__PRESCALER__) == WWDG_PRESCALER_4) || \
bogdanm 92:4fc01daae5a5 155 ((__PRESCALER__) == WWDG_PRESCALER_8))
bogdanm 89:552587b429a1 156
bogdanm 89:552587b429a1 157 /**
bogdanm 89:552587b429a1 158 * @}
bogdanm 89:552587b429a1 159 */
bogdanm 89:552587b429a1 160
bogdanm 89:552587b429a1 161 /** @defgroup WWDG_Window
bogdanm 89:552587b429a1 162 * @{
bogdanm 89:552587b429a1 163 */
bogdanm 92:4fc01daae5a5 164 #define IS_WWDG_WINDOW(__WINDOW__) ((__WINDOW__) <= 0x7F)
bogdanm 89:552587b429a1 165
bogdanm 89:552587b429a1 166 /**
bogdanm 89:552587b429a1 167 * @}
bogdanm 89:552587b429a1 168 */
bogdanm 89:552587b429a1 169
bogdanm 89:552587b429a1 170 /** @defgroup WWDG_Counter
bogdanm 89:552587b429a1 171 * @{
bogdanm 89:552587b429a1 172 */
bogdanm 92:4fc01daae5a5 173 #define IS_WWDG_COUNTER(__COUNTER__) (((__COUNTER__) >= 0x40) && ((__COUNTER__) <= 0x7F))
bogdanm 92:4fc01daae5a5 174
bogdanm 92:4fc01daae5a5 175 /**
bogdanm 92:4fc01daae5a5 176 * @}
bogdanm 92:4fc01daae5a5 177 */
bogdanm 89:552587b429a1 178
bogdanm 89:552587b429a1 179 /**
bogdanm 89:552587b429a1 180 * @}
bogdanm 89:552587b429a1 181 */
bogdanm 89:552587b429a1 182
bogdanm 89:552587b429a1 183 /* Exported macro ------------------------------------------------------------*/
bogdanm 89:552587b429a1 184
bogdanm 89:552587b429a1 185 /** @brief Reset WWDG handle state
bogdanm 89:552587b429a1 186 * @param __HANDLE__: WWDG handle
bogdanm 89:552587b429a1 187 * @retval None
bogdanm 89:552587b429a1 188 */
bogdanm 89:552587b429a1 189 #define __HAL_WWDG_RESET_HANDLE_STATE(__HANDLE__) ((__HANDLE__)->State = HAL_WWDG_STATE_RESET)
bogdanm 89:552587b429a1 190
bogdanm 89:552587b429a1 191 /**
bogdanm 89:552587b429a1 192 * @brief Enables the WWDG peripheral.
bogdanm 89:552587b429a1 193 * @param __HANDLE__: WWDG handle
bogdanm 89:552587b429a1 194 * @retval None
bogdanm 89:552587b429a1 195 */
bogdanm 92:4fc01daae5a5 196 #define __HAL_WWDG_ENABLE(__HANDLE__) SET_BIT((__HANDLE__)->Instance->CR, WWDG_CR_WDGA)
bogdanm 89:552587b429a1 197
bogdanm 89:552587b429a1 198 /**
bogdanm 89:552587b429a1 199 * @brief Gets the selected WWDG's flag status.
bogdanm 89:552587b429a1 200 * @param __HANDLE__: WWDG handle
bogdanm 89:552587b429a1 201 * @param __FLAG__: specifies the flag to check.
bogdanm 89:552587b429a1 202 * This parameter can be one of the following values:
bogdanm 89:552587b429a1 203 * @arg WWDG_FLAG_EWIF: Early wakeup interrupt flag
bogdanm 89:552587b429a1 204 * @retval The new state of WWDG_FLAG (SET or RESET).
bogdanm 89:552587b429a1 205 */
bogdanm 89:552587b429a1 206 #define __HAL_WWDG_GET_FLAG(__HANDLE__, __FLAG__) (((__HANDLE__)->Instance->SR & (__FLAG__)) == (__FLAG__))
bogdanm 89:552587b429a1 207
bogdanm 89:552587b429a1 208 /**
bogdanm 89:552587b429a1 209 * @brief Clears the WWDG's pending flags.
bogdanm 89:552587b429a1 210 * @param __HANDLE__: WWDG handle
bogdanm 89:552587b429a1 211 * @param __FLAG__: specifies the flag to clear.
bogdanm 89:552587b429a1 212 * This parameter can be one of the following values:
bogdanm 89:552587b429a1 213 * @arg WWDG_FLAG_EWIF: Early wakeup interrupt flag
bogdanm 89:552587b429a1 214 * @retval None
bogdanm 89:552587b429a1 215 */
bogdanm 92:4fc01daae5a5 216 #define __HAL_WWDG_CLEAR_FLAG(__HANDLE__, __FLAG__) (((__HANDLE__)->Instance->SR) = ~(__FLAG__))
bogdanm 89:552587b429a1 217
bogdanm 89:552587b429a1 218 /**
bogdanm 89:552587b429a1 219 * @brief Enables the WWDG early wakeup interrupt.
bogdanm 92:4fc01daae5a5 220 * @param __INTERRUPT__: specifies the interrupt to enable.
bogdanm 92:4fc01daae5a5 221 * This parameter can be one of the following values:
bogdanm 92:4fc01daae5a5 222 * @arg WWDG_IT_EWI: Early wakeup interrupt
bogdanm 89:552587b429a1 223 * @note Once enabled this interrupt cannot be disabled except by a system reset.
bogdanm 89:552587b429a1 224 * @retval None
bogdanm 89:552587b429a1 225 */
bogdanm 89:552587b429a1 226 #define __HAL_WWDG_ENABLE_IT(__INTERRUPT__) (*(__IO uint32_t *) CFR_BASE |= (__INTERRUPT__))
bogdanm 89:552587b429a1 227
bogdanm 92:4fc01daae5a5 228 /** @brief Clear the WWDG's interrupt pending bits
bogdanm 92:4fc01daae5a5 229 * bits to clear the selected interrupt pending bits.
bogdanm 92:4fc01daae5a5 230 * @param __HANDLE__: WWDG handle
bogdanm 92:4fc01daae5a5 231 * @param __INTERRUPT__: specifies the interrupt pending bit to clear.
bogdanm 92:4fc01daae5a5 232 * This parameter can be one of the following values:
bogdanm 92:4fc01daae5a5 233 * @arg WWDG_FLAG_EWIF: Early wakeup interrupt flag
bogdanm 92:4fc01daae5a5 234 */
bogdanm 92:4fc01daae5a5 235 #define __HAL_WWDG_CLEAR_IT(__HANDLE__, __INTERRUPT__) __HAL_WWDG_CLEAR_FLAG((__HANDLE__), (__INTERRUPT__))
bogdanm 89:552587b429a1 236 /* Exported functions --------------------------------------------------------*/
bogdanm 89:552587b429a1 237
bogdanm 89:552587b429a1 238 /* Initialization/de-initialization functions **********************************/
bogdanm 89:552587b429a1 239 HAL_StatusTypeDef HAL_WWDG_Init(WWDG_HandleTypeDef *hwwdg);
bogdanm 89:552587b429a1 240 HAL_StatusTypeDef HAL_WWDG_DeInit(WWDG_HandleTypeDef *hwwdg);
bogdanm 89:552587b429a1 241 void HAL_WWDG_MspInit(WWDG_HandleTypeDef *hwwdg);
bogdanm 89:552587b429a1 242 void HAL_WWDG_MspDeInit(WWDG_HandleTypeDef *hwwdg);
bogdanm 89:552587b429a1 243 void HAL_WWDG_WakeupCallback(WWDG_HandleTypeDef* hwwdg);
bogdanm 89:552587b429a1 244
bogdanm 89:552587b429a1 245 /* I/O operation functions ******************************************************/
bogdanm 89:552587b429a1 246 HAL_StatusTypeDef HAL_WWDG_Start(WWDG_HandleTypeDef *hwwdg);
bogdanm 89:552587b429a1 247 HAL_StatusTypeDef HAL_WWDG_Start_IT(WWDG_HandleTypeDef *hwwdg);
bogdanm 89:552587b429a1 248 HAL_StatusTypeDef HAL_WWDG_Refresh(WWDG_HandleTypeDef *hwwdg, uint32_t Counter);
bogdanm 89:552587b429a1 249 void HAL_WWDG_IRQHandler(WWDG_HandleTypeDef *hwwdg);
bogdanm 89:552587b429a1 250
bogdanm 89:552587b429a1 251 /* Peripheral State functions **************************************************/
bogdanm 89:552587b429a1 252 HAL_WWDG_StateTypeDef HAL_WWDG_GetState(WWDG_HandleTypeDef *hwwdg);
bogdanm 89:552587b429a1 253
bogdanm 89:552587b429a1 254 /**
bogdanm 89:552587b429a1 255 * @}
bogdanm 89:552587b429a1 256 */
bogdanm 89:552587b429a1 257
bogdanm 89:552587b429a1 258 /**
bogdanm 89:552587b429a1 259 * @}
bogdanm 89:552587b429a1 260 */
bogdanm 89:552587b429a1 261
bogdanm 89:552587b429a1 262 #ifdef __cplusplus
bogdanm 89:552587b429a1 263 }
bogdanm 89:552587b429a1 264 #endif
bogdanm 89:552587b429a1 265
bogdanm 89:552587b429a1 266 #endif /* __STM32F4xx_HAL_WWDG_H */
bogdanm 89:552587b429a1 267
bogdanm 89:552587b429a1 268 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/