1 /**
2 ******************************************************************************
3 * @file stm32u5xx_hal_wwdg.c
4 * @author MCD Application Team
5 * @brief WWDG HAL module driver.
6 * This file provides firmware functions to manage the following
7 * functionalities of the Window Watchdog (WWDG) peripheral:
8 * + Initialization and Configuration functions
9 * + IO operation functions
10 ******************************************************************************
11 * @attention
12 *
13 * Copyright (c) 2021 STMicroelectronics.
14 * All rights reserved.
15 *
16 * This software is licensed under terms that can be found in the LICENSE file
17 * in the root directory of this software component.
18 * If no LICENSE file comes with this software, it is provided AS-IS.
19 *
20 ******************************************************************************
21 @verbatim
22 ==============================================================================
23 ##### WWDG Specific features #####
24 ==============================================================================
25 [..]
26 Once enabled the WWDG generates a system reset on expiry of a programmed
27 time period, unless the program refreshes the counter (T[6;0] downcounter)
28 before reaching 0x3F value (i.e. a reset is generated when the counter
29 value rolls down from 0x40 to 0x3F).
30
31 (+) An MCU reset is also generated if the counter value is refreshed
32 before the counter has reached the refresh window value. This
33 implies that the counter must be refreshed in a limited window.
34 (+) Once enabled the WWDG cannot be disabled except by a system reset.
35 (+) If required by application, an Early Wakeup Interrupt can be triggered
36 in order to be warned before WWDG expiration. The Early Wakeup Interrupt
37 (EWI) can be used if specific safety operations or data logging must
38 be performed before the actual reset is generated. When the downcounter
39 reaches 0x40, interrupt occurs. This mechanism requires WWDG interrupt
40 line to be enabled in NVIC. Once enabled, EWI interrupt cannot be
41 disabled except by a system reset.
42 (+) WWDGRST flag in RCC CSR register can be used to inform when a WWDG
43 reset occurs.
44 (+) The WWDG counter input clock is derived from the APB clock divided
45 by a programmable prescaler.
46 (+) WWDG clock (Hz) = PCLK1 / (4096 * Prescaler)
47 (+) WWDG timeout (mS) = 1000 * (T[5;0] + 1) / WWDG clock (Hz)
48 where T[5;0] are the lowest 6 bits of Counter.
49 (+) WWDG Counter refresh is allowed between the following limits :
50 (++) min time (mS) = 1000 * (Counter - Window) / WWDG clock
51 (++) max time (mS) = 1000 * (Counter - 0x40) / WWDG clock
52 (+) Typical values:
53 (++) Counter min (T[5;0] = 0x00) at 56MHz (PCLK1) with zero prescaler:
54 max timeout before reset: approximately 73.14us
55 (++) Counter max (T[5;0] = 0x3F) at 56MHz (PCLK1) with prescaler
56 dividing by 128:
57 max timeout before reset: approximately 599.18ms
58
59 ##### How to use this driver #####
60 ==============================================================================
61
62 *** Common driver usage ***
63 ===========================
64
65 [..]
66 (+) Enable WWDG APB1 clock using __HAL_RCC_WWDG_CLK_ENABLE().
67 (+) Configure the WWDG prescaler, refresh window value, counter value and early
68 interrupt status using HAL_WWDG_Init() function. This will automatically
69 enable WWDG and start its downcounter. Time reference can be taken from
70 function exit. Care must be taken to provide a counter value
71 greater than 0x40 to prevent generation of immediate reset.
72 (+) If the Early Wakeup Interrupt (EWI) feature is enabled, an interrupt is
73 generated when the counter reaches 0x40. When HAL_WWDG_IRQHandler is
74 triggered by the interrupt service routine, flag will be automatically
75 cleared and HAL_WWDG_WakeupCallback user callback will be executed. User
76 can add his own code by customization of callback HAL_WWDG_WakeupCallback.
77 (+) Then the application program must refresh the WWDG counter at regular
78 intervals during normal operation to prevent an MCU reset, using
79 HAL_WWDG_Refresh() function. This operation must occur only when
80 the counter is lower than the refresh window value already programmed.
81
82 *** Callback registration ***
83 =============================
84
85 [..]
86 The compilation define USE_HAL_WWDG_REGISTER_CALLBACKS when set to 1 allows
87 the user to configure dynamically the driver callbacks. Use Functions
88 HAL_WWDG_RegisterCallback() to register a user callback.
89
90 (+) Function HAL_WWDG_RegisterCallback() allows to register following
91 callbacks:
92 (++) EwiCallback : callback for Early WakeUp Interrupt.
93 (++) MspInitCallback : WWDG MspInit.
94 This function takes as parameters the HAL peripheral handle, the Callback ID
95 and a pointer to the user callback function.
96
97 (+) Use function HAL_WWDG_UnRegisterCallback() to reset a callback to
98 the default weak (surcharged) function. HAL_WWDG_UnRegisterCallback()
99 takes as parameters the HAL peripheral handle and the Callback ID.
100 This function allows to reset following callbacks:
101 (++) EwiCallback : callback for Early WakeUp Interrupt.
102 (++) MspInitCallback : WWDG MspInit.
103
104 [..]
105 When calling HAL_WWDG_Init function, callbacks are reset to the
106 corresponding legacy weak (surcharged) functions:
107 HAL_WWDG_EarlyWakeupCallback() and HAL_WWDG_MspInit() only if they have
108 not been registered before.
109
110 [..]
111 When compilation define USE_HAL_WWDG_REGISTER_CALLBACKS is set to 0 or
112 not defined, the callback registering feature is not available
113 and weak (surcharged) callbacks are used.
114
115 *** WWDG HAL driver macros list ***
116 ===================================
117 [..]
118 Below the list of available macros in WWDG HAL driver.
119 (+) __HAL_WWDG_ENABLE: Enable the WWDG peripheral
120 (+) __HAL_WWDG_GET_FLAG: Get the selected WWDG's flag status
121 (+) __HAL_WWDG_CLEAR_FLAG: Clear the WWDG's pending flags
122 (+) __HAL_WWDG_ENABLE_IT: Enable the WWDG early wakeup interrupt
123
124 @endverbatim
125 */
126
127 /* Includes ------------------------------------------------------------------*/
128 #include "stm32u5xx_hal.h"
129
130 /** @addtogroup STM32U5xx_HAL_Driver
131 * @{
132 */
133
134 #ifdef HAL_WWDG_MODULE_ENABLED
135 /** @defgroup WWDG WWDG
136 * @brief WWDG HAL module driver.
137 * @{
138 */
139
140 /* Private typedef -----------------------------------------------------------*/
141 /* Private define ------------------------------------------------------------*/
142 /* Private macro -------------------------------------------------------------*/
143 /* Private variables ---------------------------------------------------------*/
144 /* Private function prototypes -----------------------------------------------*/
145 /* Exported functions --------------------------------------------------------*/
146
147 /** @defgroup WWDG_Exported_Functions WWDG Exported Functions
148 * @{
149 */
150
151 /** @defgroup WWDG_Exported_Functions_Group1 Initialization and Configuration functions
152 * @brief Initialization and Configuration functions.
153 *
154 @verbatim
155 ==============================================================================
156 ##### Initialization and Configuration functions #####
157 ==============================================================================
158 [..]
159 This section provides functions allowing to:
160 (+) Initialize and start the WWDG according to the specified parameters
161 in the WWDG_InitTypeDef of associated handle.
162 (+) Initialize the WWDG MSP.
163
164 @endverbatim
165 * @{
166 */
167
168 /**
169 * @brief Initialize the WWDG according to the specified.
170 * parameters in the WWDG_InitTypeDef of associated handle.
171 * @param hwwdg pointer to a WWDG_HandleTypeDef structure that contains
172 * the configuration information for the specified WWDG module.
173 * @retval HAL status
174 */
HAL_WWDG_Init(WWDG_HandleTypeDef * hwwdg)175 HAL_StatusTypeDef HAL_WWDG_Init(WWDG_HandleTypeDef *hwwdg)
176 {
177 /* Check the WWDG handle allocation */
178 if (hwwdg == NULL)
179 {
180 return HAL_ERROR;
181 }
182
183 /* Check the parameters */
184 assert_param(IS_WWDG_ALL_INSTANCE(hwwdg->Instance));
185 assert_param(IS_WWDG_PRESCALER(hwwdg->Init.Prescaler));
186 assert_param(IS_WWDG_WINDOW(hwwdg->Init.Window));
187 assert_param(IS_WWDG_COUNTER(hwwdg->Init.Counter));
188 assert_param(IS_WWDG_EWI_MODE(hwwdg->Init.EWIMode));
189
190 #if (USE_HAL_WWDG_REGISTER_CALLBACKS == 1)
191 /* Reset Callback pointers */
192 if (hwwdg->EwiCallback == NULL)
193 {
194 hwwdg->EwiCallback = HAL_WWDG_EarlyWakeupCallback;
195 }
196
197 if (hwwdg->MspInitCallback == NULL)
198 {
199 hwwdg->MspInitCallback = HAL_WWDG_MspInit;
200 }
201
202 /* Init the low level hardware */
203 hwwdg->MspInitCallback(hwwdg);
204 #else
205 /* Init the low level hardware */
206 HAL_WWDG_MspInit(hwwdg);
207 #endif /* USE_HAL_WWDG_REGISTER_CALLBACKS */
208
209 /* Set WWDG Counter */
210 WRITE_REG(hwwdg->Instance->CR, (WWDG_CR_WDGA | hwwdg->Init.Counter));
211
212 /* Set WWDG Prescaler and Window */
213 WRITE_REG(hwwdg->Instance->CFR, (hwwdg->Init.EWIMode | hwwdg->Init.Prescaler | hwwdg->Init.Window));
214
215 /* Return function status */
216 return HAL_OK;
217 }
218
219
220 /**
221 * @brief Initialize the WWDG MSP.
222 * @param hwwdg pointer to a WWDG_HandleTypeDef structure that contains
223 * the configuration information for the specified WWDG module.
224 * @note When rewriting this function in user file, mechanism may be added
225 * to avoid multiple initialize when HAL_WWDG_Init function is called
226 * again to change parameters.
227 * @retval None
228 */
HAL_WWDG_MspInit(WWDG_HandleTypeDef * hwwdg)229 __weak void HAL_WWDG_MspInit(WWDG_HandleTypeDef *hwwdg)
230 {
231 /* Prevent unused argument(s) compilation warning */
232 UNUSED(hwwdg);
233
234 /* NOTE: This function should not be modified, when the callback is needed,
235 the HAL_WWDG_MspInit could be implemented in the user file
236 */
237 }
238
239
240 #if (USE_HAL_WWDG_REGISTER_CALLBACKS == 1)
241 /**
242 * @brief Register a User WWDG Callback
243 * To be used instead of the weak (surcharged) predefined callback
244 * @param hwwdg WWDG handle
245 * @param CallbackID ID of the callback to be registered
246 * This parameter can be one of the following values:
247 * @arg @ref HAL_WWDG_EWI_CB_ID Early WakeUp Interrupt Callback ID
248 * @arg @ref HAL_WWDG_MSPINIT_CB_ID MspInit callback ID
249 * @param pCallback pointer to the Callback function
250 * @retval status
251 */
HAL_WWDG_RegisterCallback(WWDG_HandleTypeDef * hwwdg,HAL_WWDG_CallbackIDTypeDef CallbackID,pWWDG_CallbackTypeDef pCallback)252 HAL_StatusTypeDef HAL_WWDG_RegisterCallback(WWDG_HandleTypeDef *hwwdg, HAL_WWDG_CallbackIDTypeDef CallbackID,
253 pWWDG_CallbackTypeDef pCallback)
254 {
255 HAL_StatusTypeDef status = HAL_OK;
256
257 if (pCallback == NULL)
258 {
259 status = HAL_ERROR;
260 }
261 else
262 {
263 switch (CallbackID)
264 {
265 case HAL_WWDG_EWI_CB_ID:
266 hwwdg->EwiCallback = pCallback;
267 break;
268
269 case HAL_WWDG_MSPINIT_CB_ID:
270 hwwdg->MspInitCallback = pCallback;
271 break;
272
273 default:
274 status = HAL_ERROR;
275 break;
276 }
277 }
278
279 return status;
280 }
281
282
283 /**
284 * @brief Unregister a WWDG Callback
285 * WWDG Callback is redirected to the weak (surcharged) predefined callback
286 * @param hwwdg WWDG handle
287 * @param CallbackID ID of the callback to be registered
288 * This parameter can be one of the following values:
289 * @arg @ref HAL_WWDG_EWI_CB_ID Early WakeUp Interrupt Callback ID
290 * @arg @ref HAL_WWDG_MSPINIT_CB_ID MspInit callback ID
291 * @retval status
292 */
HAL_WWDG_UnRegisterCallback(WWDG_HandleTypeDef * hwwdg,HAL_WWDG_CallbackIDTypeDef CallbackID)293 HAL_StatusTypeDef HAL_WWDG_UnRegisterCallback(WWDG_HandleTypeDef *hwwdg, HAL_WWDG_CallbackIDTypeDef CallbackID)
294 {
295 HAL_StatusTypeDef status = HAL_OK;
296
297 switch (CallbackID)
298 {
299 case HAL_WWDG_EWI_CB_ID:
300 hwwdg->EwiCallback = HAL_WWDG_EarlyWakeupCallback;
301 break;
302
303 case HAL_WWDG_MSPINIT_CB_ID:
304 hwwdg->MspInitCallback = HAL_WWDG_MspInit;
305 break;
306
307 default:
308 status = HAL_ERROR;
309 break;
310 }
311
312 return status;
313 }
314 #endif /* USE_HAL_WWDG_REGISTER_CALLBACKS */
315
316 /**
317 * @}
318 */
319
320 /** @defgroup WWDG_Exported_Functions_Group2 IO operation functions
321 * @brief IO operation functions
322 *
323 @verbatim
324 ==============================================================================
325 ##### IO operation functions #####
326 ==============================================================================
327 [..]
328 This section provides functions allowing to:
329 (+) Refresh the WWDG.
330 (+) Handle WWDG interrupt request and associated function callback.
331
332 @endverbatim
333 * @{
334 */
335
336 /**
337 * @brief Refresh the WWDG.
338 * @param hwwdg pointer to a WWDG_HandleTypeDef structure that contains
339 * the configuration information for the specified WWDG module.
340 * @retval HAL status
341 */
HAL_WWDG_Refresh(WWDG_HandleTypeDef * hwwdg)342 HAL_StatusTypeDef HAL_WWDG_Refresh(WWDG_HandleTypeDef *hwwdg)
343 {
344 /* Write to WWDG CR the WWDG Counter value to refresh with */
345 WRITE_REG(hwwdg->Instance->CR, (hwwdg->Init.Counter));
346
347 /* Return function status */
348 return HAL_OK;
349 }
350
351 /**
352 * @brief Handle WWDG interrupt request.
353 * @note The Early Wakeup Interrupt (EWI) can be used if specific safety operations
354 * or data logging must be performed before the actual reset is generated.
355 * The EWI interrupt is enabled by calling HAL_WWDG_Init function with
356 * EWIMode set to WWDG_EWI_ENABLE.
357 * When the downcounter reaches the value 0x40, and EWI interrupt is
358 * generated and the corresponding Interrupt Service Routine (ISR) can
359 * be used to trigger specific actions (such as communications or data
360 * logging), before resetting the device.
361 * @param hwwdg pointer to a WWDG_HandleTypeDef structure that contains
362 * the configuration information for the specified WWDG module.
363 * @retval None
364 */
HAL_WWDG_IRQHandler(WWDG_HandleTypeDef * hwwdg)365 void HAL_WWDG_IRQHandler(WWDG_HandleTypeDef *hwwdg)
366 {
367 /* Check if Early Wakeup Interrupt is enable */
368 if (__HAL_WWDG_GET_IT_SOURCE(hwwdg, WWDG_IT_EWI) != RESET)
369 {
370 /* Check if WWDG Early Wakeup Interrupt occurred */
371 if (__HAL_WWDG_GET_FLAG(hwwdg, WWDG_FLAG_EWIF) != RESET)
372 {
373 /* Clear the WWDG Early Wakeup flag */
374 __HAL_WWDG_CLEAR_FLAG(hwwdg, WWDG_FLAG_EWIF);
375
376 #if (USE_HAL_WWDG_REGISTER_CALLBACKS == 1)
377 /* Early Wakeup registered callback */
378 hwwdg->EwiCallback(hwwdg);
379 #else
380 /* Early Wakeup callback */
381 HAL_WWDG_EarlyWakeupCallback(hwwdg);
382 #endif /* USE_HAL_WWDG_REGISTER_CALLBACKS */
383 }
384 }
385 }
386
387
388 /**
389 * @brief WWDG Early Wakeup callback.
390 * @param hwwdg pointer to a WWDG_HandleTypeDef structure that contains
391 * the configuration information for the specified WWDG module.
392 * @retval None
393 */
HAL_WWDG_EarlyWakeupCallback(WWDG_HandleTypeDef * hwwdg)394 __weak void HAL_WWDG_EarlyWakeupCallback(WWDG_HandleTypeDef *hwwdg)
395 {
396 /* Prevent unused argument(s) compilation warning */
397 UNUSED(hwwdg);
398
399 /* NOTE: This function should not be modified, when the callback is needed,
400 the HAL_WWDG_EarlyWakeupCallback could be implemented in the user file
401 */
402 }
403
404 /**
405 * @}
406 */
407
408 /**
409 * @}
410 */
411
412 #endif /* HAL_WWDG_MODULE_ENABLED */
413 /**
414 * @}
415 */
416
417 /**
418 * @}
419 */
420
