Ricardo Benitez / mbed

meh

Fork of mbed by mbed official

TARGET_NUCLEO_F411RE/stm32f4xx_hal_wwdg.h@118:16969dd821af, 2016-04-05 (annotated)

Committer:
ricardobtez
Date:
Tue Apr 05 23:51:21 2016 +0000
Revision:
118:16969dd821af
Parent:
86:04dd9b1680ae
Child:
99:dbbf35b96557
dgdgr

Who changed what in which revision?

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