2 ******************************************************************************
3 * @file stm32l1xx_hal_wwdg.h
4 * @author MCD Application Team
6 * @date 5-September-2014
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 __STM32L1xx_HAL_WWDG_H
40 #define __STM32L1xx_HAL_WWDG_H
46 /* Includes ------------------------------------------------------------------*/
47 #include "stm32l1xx_hal_def.h"
49 /** @addtogroup STM32L1xx_HAL_Driver
57 /* Exported types ------------------------------------------------------------*/
59 /** @defgroup WWDG_Exported_Types WWDG Exported Types
64 * @brief WWDG HAL State Structure definition
68 HAL_WWDG_STATE_RESET = 0x00, /*!< WWDG not yet initialized or disabled */
69 HAL_WWDG_STATE_READY = 0x01, /*!< WWDG initialized and ready for use */
70 HAL_WWDG_STATE_BUSY = 0x02, /*!< WWDG internal process is ongoing */
71 HAL_WWDG_STATE_TIMEOUT = 0x03, /*!< WWDG timeout state */
72 HAL_WWDG_STATE_ERROR = 0x04 /*!< WWDG error state */
73 }HAL_WWDG_StateTypeDef;
76 * @brief WWDG Init structure definition
80 uint32_t Prescaler; /*!< Specifies the prescaler value of the WWDG.
81 This parameter can be a value of @ref WWDG_Prescaler */
83 uint32_t Window; /*!< Specifies the WWDG window value to be compared to the downcounter.
84 This parameter must be a number lower than Max_Data = 0x80 */
86 uint32_t Counter; /*!< Specifies the WWDG free-running downcounter value.
87 This parameter must be a number between Min_Data = 0x40 and Max_Data = 0x7F */
92 * @brief WWDG handle Structure definition
96 WWDG_TypeDef *Instance; /*!< Register base address */
98 WWDG_InitTypeDef Init; /*!< WWDG required parameters */
100 HAL_LockTypeDef Lock; /*!< WWDG locking object */
102 __IO HAL_WWDG_StateTypeDef State; /*!< WWDG communication state */
110 /* Exported constants --------------------------------------------------------*/
112 /** @defgroup WWDG_Exported_Constants WWDG Exported Constants
116 /** @defgroup WWDG_BitAddress_AliasRegion WWDG BitAddress AliasRegion
117 * @brief WWDG registers bit address in the alias region
121 /* --- CFR Register ---*/
122 /* Alias word address of EWI bit */
123 #define CFR_BASE (uint32_t)(WWDG_BASE + 0x04)
129 /** @defgroup WWDG_Interrupt_definition WWDG Interrupt definition
132 #define WWDG_IT_EWI ((uint32_t)WWDG_CFR_EWI)
138 /** @defgroup WWDG_Flag_definition WWDG Flag definition
139 * @brief WWDG Flag definition
142 #define WWDG_FLAG_EWIF ((uint32_t)WWDG_SR_EWIF) /*!< Early wakeup interrupt flag */
148 /** @defgroup WWDG_Prescaler WWDG Prescaler
151 #define WWDG_PRESCALER_1 ((uint32_t)0x00000000) /*!< WWDG counter clock = (PCLK1/4096)/1 */
152 #define WWDG_PRESCALER_2 ((uint32_t)WWDG_CFR_WDGTB0) /*!< WWDG counter clock = (PCLK1/4096)/2 */
153 #define WWDG_PRESCALER_4 ((uint32_t)WWDG_CFR_WDGTB1) /*!< WWDG counter clock = (PCLK1/4096)/4 */
154 #define WWDG_PRESCALER_8 ((uint32_t)WWDG_CFR_WDGTB) /*!< WWDG counter clock = (PCLK1/4096)/8 */
156 #define IS_WWDG_PRESCALER(__PRESCALER__) (((__PRESCALER__) == WWDG_PRESCALER_1) || \
157 ((__PRESCALER__) == WWDG_PRESCALER_2) || \
158 ((__PRESCALER__) == WWDG_PRESCALER_4) || \
159 ((__PRESCALER__) == WWDG_PRESCALER_8))
165 /** @defgroup WWDG_Window WWDG Window
168 #define IS_WWDG_WINDOW(__WINDOW__) ((__WINDOW__) <= 0x7F)
174 /** @defgroup WWDG_Counter WWDG Counter
177 #define IS_WWDG_COUNTER(__COUNTER__) (((__COUNTER__) >= 0x40) && ((__COUNTER__) <= 0x7F))
187 /* Exported macro ------------------------------------------------------------*/
189 /** @defgroup WWDG_Exported_Macros WWDG Exported Macros
193 /** @brief Reset WWDG handle state
194 * @param __HANDLE__: WWDG handle
197 #define __HAL_WWDG_RESET_HANDLE_STATE(__HANDLE__) ((__HANDLE__)->State = HAL_WWDG_STATE_RESET)
200 * @brief Enables the WWDG peripheral.
201 * @param __HANDLE__: WWDG handle
204 #define __HAL_WWDG_ENABLE(__HANDLE__) SET_BIT((__HANDLE__)->Instance->CR, WWDG_CR_WDGA)
207 * @brief Gets the selected WWDG's flag status.
208 * @param __HANDLE__: WWDG handle
209 * @param __FLAG__: specifies the flag to check.
210 * This parameter can be one of the following values:
211 * @arg WWDG_FLAG_EWIF: Early wakeup interrupt flag
212 * @retval The new state of WWDG_FLAG (SET or RESET).
214 #define __HAL_WWDG_GET_FLAG(__HANDLE__, __FLAG__) (((__HANDLE__)->Instance->SR & (__FLAG__)) == (__FLAG__))
217 * @brief Clears the WWDG's pending flags.
218 * @param __HANDLE__: WWDG handle
219 * @param __FLAG__: specifies the flag to clear.
220 * This parameter can be one of the following values:
221 * @arg WWDG_FLAG_EWIF: Early wakeup interrupt flag
224 #define __HAL_WWDG_CLEAR_FLAG(__HANDLE__, __FLAG__) (((__HANDLE__)->Instance->SR) = ~(__FLAG__))
227 * @brief Enables the WWDG early wakeup interrupt.
228 * @param __INTERRUPT__: specifies the interrupt to enable.
229 * This parameter can be one of the following values:
230 * @arg WWDG_IT_EWI: Early wakeup interrupt
231 * @note Once enabled this interrupt cannot be disabled except by a system reset.
234 #define __HAL_WWDG_ENABLE_IT(__INTERRUPT__) (*(__IO uint32_t *) CFR_BASE |= (__INTERRUPT__))
236 /** @brief Clear the WWDG's interrupt pending bits
237 * bits to clear the selected interrupt pending bits.
238 * @param __HANDLE__: WWDG handle
239 * @param __INTERRUPT__: specifies the interrupt pending bit to clear.
240 * This parameter can be one of the following values:
241 * @arg WWDG_FLAG_EWIF: Early wakeup interrupt flag
243 #define __HAL_WWDG_CLEAR_IT(__HANDLE__, __INTERRUPT__) __HAL_WWDG_CLEAR_FLAG((__HANDLE__), (__INTERRUPT__))
249 /* Exported functions --------------------------------------------------------*/
251 /** @addtogroup WWDG_Exported_Functions
255 /** @addtogroup WWDG_Exported_Functions_Group1
258 /* Initialization/de-initialization functions **********************************/
259 HAL_StatusTypeDef HAL_WWDG_Init(WWDG_HandleTypeDef *hwwdg);
260 HAL_StatusTypeDef HAL_WWDG_DeInit(WWDG_HandleTypeDef *hwwdg);
261 void HAL_WWDG_MspInit(WWDG_HandleTypeDef *hwwdg);
262 void HAL_WWDG_MspDeInit(WWDG_HandleTypeDef *hwwdg);
263 void HAL_WWDG_WakeupCallback(WWDG_HandleTypeDef* hwwdg);
269 /** @addtogroup WWDG_Exported_Functions_Group2
272 /* I/O operation functions ******************************************************/
273 HAL_StatusTypeDef HAL_WWDG_Start(WWDG_HandleTypeDef *hwwdg);
274 HAL_StatusTypeDef HAL_WWDG_Start_IT(WWDG_HandleTypeDef *hwwdg);
275 HAL_StatusTypeDef HAL_WWDG_Refresh(WWDG_HandleTypeDef *hwwdg, uint32_t Counter);
276 void HAL_WWDG_IRQHandler(WWDG_HandleTypeDef *hwwdg);
282 /** @addtogroup WWDG_Exported_Functions_Group3
285 /* Peripheral State functions **************************************************/
286 HAL_WWDG_StateTypeDef HAL_WWDG_GetState(WWDG_HandleTypeDef *hwwdg);
308 #endif /* __STM32L1xx_HAL_WWDG_H */
310 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/