2 ******************************************************************************
3 * @file stm32f4xx_hal_wwdg.h
4 * @author MCD Application Team
7 * @brief Header file of WWDG HAL module.
8 ******************************************************************************
11 * <h2><center>© COPYRIGHT(c) 2014 STMicroelectronics</center></h2>
13 * Redistribution and use in source and binary forms, with or without modification,
14 * are permitted provided that the following conditions are met:
15 * 1. Redistributions of source code must retain the above copyright notice,
16 * this list of conditions and the following disclaimer.
17 * 2. Redistributions in binary form must reproduce the above copyright notice,
18 * this list of conditions and the following disclaimer in the documentation
19 * and/or other materials provided with the distribution.
20 * 3. Neither the name of STMicroelectronics nor the names of its contributors
21 * may be used to endorse or promote products derived from this software
22 * without specific prior written permission.
24 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
25 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
26 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
27 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
28 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
29 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
30 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
31 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
32 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
33 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
35 ******************************************************************************
38 /* Define to prevent recursive inclusion -------------------------------------*/
39 #ifndef __STM32F4xx_HAL_WWDG_H
40 #define __STM32F4xx_HAL_WWDG_H
46 /* Includes ------------------------------------------------------------------*/
47 #include "stm32f4xx_hal_def.h"
49 /** @addtogroup STM32F4xx_HAL_Driver
57 /* Exported types ------------------------------------------------------------*/
60 * @brief WWDG HAL State Structure definition
64 HAL_WWDG_STATE_RESET = 0x00, /*!< WWDG not yet initialized or disabled */
65 HAL_WWDG_STATE_READY = 0x01, /*!< WWDG initialized and ready for use */
66 HAL_WWDG_STATE_BUSY = 0x02, /*!< WWDG internal process is ongoing */
67 HAL_WWDG_STATE_TIMEOUT = 0x03, /*!< WWDG timeout state */
68 HAL_WWDG_STATE_ERROR = 0x04 /*!< WWDG error state */
69 }HAL_WWDG_StateTypeDef;
72 * @brief WWDG Init structure definition
76 uint32_t Prescaler; /*!< Specifies the prescaler value of the WWDG.
77 This parameter can be a value of @ref WWDG_Prescaler */
79 uint32_t Window; /*!< Specifies the WWDG window value to be compared to the downcounter.
80 This parameter must be a number lower than Max_Data = 0x80 */
82 uint32_t Counter; /*!< Specifies the WWDG free-running downcounter value.
83 This parameter must be a number between Min_Data = 0x40 and Max_Data = 0x7F */
88 * @brief WWDG handle Structure definition
92 WWDG_TypeDef *Instance; /*!< Register base address */
94 WWDG_InitTypeDef Init; /*!< WWDG required parameters */
96 HAL_LockTypeDef Lock; /*!< WWDG locking object */
98 __IO HAL_WWDG_StateTypeDef State; /*!< WWDG communication state */
102 /* Exported constants --------------------------------------------------------*/
104 /** @defgroup WWDG_Exported_Constants
108 /** @defgroup WWDG_BitAddress_AliasRegion
109 * @brief WWDG registers bit address in the alias region
113 /* --- CFR Register ---*/
114 /* Alias word address of EWI bit */
115 #define CFR_BASE (uint32_t)(WWDG_BASE + 0x04)
121 /** @defgroup WWDG_Interrupt_definition
124 #define WWDG_IT_EWI ((uint32_t)WWDG_CFR_EWI)
126 #define IS_WWDG_IT(__IT__) ((__IT__) == WWDG_IT_EWI)
132 /** @defgroup WWDG_Flag_definition
133 * @brief WWDG Flag definition
136 #define WWDG_FLAG_EWIF ((uint32_t)WWDG_SR_EWIF) /*!< Early wakeup interrupt flag */
137 #define IS_WWDG_FLAG(__FLAG__) ((__FLAG__) == WWDG_FLAG_EWIF))
144 /** @defgroup WWDG_Prescaler
147 #define WWDG_PRESCALER_1 ((uint32_t)0x00000000) /*!< WWDG counter clock = (PCLK1/4096)/1 */
148 #define WWDG_PRESCALER_2 ((uint32_t)WWDG_CFR_WDGTB0) /*!< WWDG counter clock = (PCLK1/4096)/2 */
149 #define WWDG_PRESCALER_4 ((uint32_t)WWDG_CFR_WDGTB1) /*!< WWDG counter clock = (PCLK1/4096)/4 */
150 #define WWDG_PRESCALER_8 ((uint32_t)WWDG_CFR_WDGTB) /*!< WWDG counter clock = (PCLK1/4096)/8 */
152 #define IS_WWDG_PRESCALER(__PRESCALER__) (((__PRESCALER__) == WWDG_PRESCALER_1) || \
153 ((__PRESCALER__) == WWDG_PRESCALER_2) || \
154 ((__PRESCALER__) == WWDG_PRESCALER_4) || \
155 ((__PRESCALER__) == WWDG_PRESCALER_8))
161 /** @defgroup WWDG_Window
164 #define IS_WWDG_WINDOW(__WINDOW__) ((__WINDOW__) <= 0x7F)
170 /** @defgroup WWDG_Counter
173 #define IS_WWDG_COUNTER(__COUNTER__) (((__COUNTER__) >= 0x40) && ((__COUNTER__) <= 0x7F))
183 /* Exported macro ------------------------------------------------------------*/
185 /** @brief Reset WWDG handle state
186 * @param __HANDLE__: WWDG handle
189 #define __HAL_WWDG_RESET_HANDLE_STATE(__HANDLE__) ((__HANDLE__)->State = HAL_WWDG_STATE_RESET)
192 * @brief Enables the WWDG peripheral.
193 * @param __HANDLE__: WWDG handle
196 #define __HAL_WWDG_ENABLE(__HANDLE__) SET_BIT((__HANDLE__)->Instance->CR, WWDG_CR_WDGA)
199 * @brief Gets the selected WWDG's flag status.
200 * @param __HANDLE__: WWDG handle
201 * @param __FLAG__: specifies the flag to check.
202 * This parameter can be one of the following values:
203 * @arg WWDG_FLAG_EWIF: Early wakeup interrupt flag
204 * @retval The new state of WWDG_FLAG (SET or RESET).
206 #define __HAL_WWDG_GET_FLAG(__HANDLE__, __FLAG__) (((__HANDLE__)->Instance->SR & (__FLAG__)) == (__FLAG__))
209 * @brief Clears the WWDG's pending flags.
210 * @param __HANDLE__: WWDG handle
211 * @param __FLAG__: specifies the flag to clear.
212 * This parameter can be one of the following values:
213 * @arg WWDG_FLAG_EWIF: Early wakeup interrupt flag
216 #define __HAL_WWDG_CLEAR_FLAG(__HANDLE__, __FLAG__) (((__HANDLE__)->Instance->SR) = ~(__FLAG__))
219 * @brief Enables the WWDG early wakeup interrupt.
220 * @param __INTERRUPT__: specifies the interrupt to enable.
221 * This parameter can be one of the following values:
222 * @arg WWDG_IT_EWI: Early wakeup interrupt
223 * @note Once enabled this interrupt cannot be disabled except by a system reset.
226 #define __HAL_WWDG_ENABLE_IT(__INTERRUPT__) (*(__IO uint32_t *) CFR_BASE |= (__INTERRUPT__))
228 /** @brief Clear the WWDG's interrupt pending bits
229 * bits to clear the selected interrupt pending bits.
230 * @param __HANDLE__: WWDG handle
231 * @param __INTERRUPT__: specifies the interrupt pending bit to clear.
232 * This parameter can be one of the following values:
233 * @arg WWDG_FLAG_EWIF: Early wakeup interrupt flag
235 #define __HAL_WWDG_CLEAR_IT(__HANDLE__, __INTERRUPT__) __HAL_WWDG_CLEAR_FLAG((__HANDLE__), (__INTERRUPT__))
236 /* Exported functions --------------------------------------------------------*/
238 /* Initialization/de-initialization functions **********************************/
239 HAL_StatusTypeDef HAL_WWDG_Init(WWDG_HandleTypeDef *hwwdg);
240 HAL_StatusTypeDef HAL_WWDG_DeInit(WWDG_HandleTypeDef *hwwdg);
241 void HAL_WWDG_MspInit(WWDG_HandleTypeDef *hwwdg);
242 void HAL_WWDG_MspDeInit(WWDG_HandleTypeDef *hwwdg);
243 void HAL_WWDG_WakeupCallback(WWDG_HandleTypeDef* hwwdg);
245 /* I/O operation functions ******************************************************/
246 HAL_StatusTypeDef HAL_WWDG_Start(WWDG_HandleTypeDef *hwwdg);
247 HAL_StatusTypeDef HAL_WWDG_Start_IT(WWDG_HandleTypeDef *hwwdg);
248 HAL_StatusTypeDef HAL_WWDG_Refresh(WWDG_HandleTypeDef *hwwdg, uint32_t Counter);
249 void HAL_WWDG_IRQHandler(WWDG_HandleTypeDef *hwwdg);
251 /* Peripheral State functions **************************************************/
252 HAL_WWDG_StateTypeDef HAL_WWDG_GetState(WWDG_HandleTypeDef *hwwdg);
266 #endif /* __STM32F4xx_HAL_WWDG_H */
268 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/