VSF Documented
sthal_wwdg.h
Go to the documentation of this file.
1/*****************************************************************************
2 * Copyright(C)2009-2024 by VSF Team *
3 * *
4 * Licensed under the Apache License, Version 2.0 (the "License"); *
5 * you may not use this file except in compliance with the License. *
6 * You may obtain a copy of the License at *
7 * *
8 * http://www.apache.org/licenses/LICENSE-2.0 *
9 * *
10 * Unless required by applicable law or agreed to in writing, software *
11 * distributed under the License is distributed on an "AS IS" BASIS, *
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. *
13 * See the License for the specific language governing permissions and *
14 * limitations under the License. *
15 * *
16 ****************************************************************************/
17
18#ifndef __ST_HAL_WWDG_H__
19#define __ST_HAL_WWDG_H__
20
21#ifdef __cplusplus
22extern "C" {
23#endif
24
25#if defined(HAL_WWDG_MODULE_ENABLED) && VSF_HAL_USE_WDT == ENABLED
26
27/*============================ INCLUDES ======================================*/
28
29#include "sthal_def.h"
30
31/*============================ MACROS ========================================*/
32
33#define WWDG_PRESCALER_1 1
34#define WWDG_PRESCALER_2 2
35#define WWDG_PRESCALER_4 4
36#define WWDG_PRESCALER_8 8
37
38#define WWDG_EWI_DISABLE VSF_WDT_MODE_NO_EARLY_WAKEUP
39#define WWDG_EWI_ENABLE VSF_WDT_MODE_EARLY_WAKEUP
40
41#define IS_WWDG_PRESCALER(__PRESCALER__) \
42 (((__PRESCALER__) == WWDG_PRESCALER_1) || \
43 ((__PRESCALER__) == WWDG_PRESCALER_2) || \
44 ((__PRESCALER__) == WWDG_PRESCALER_4) || \
45 ((__PRESCALER__) == WWDG_PRESCALER_8))
46
47#ifndef VSF_STHAL_CFG_WWDT_MIN_WINDOW
48# define VSF_STHAL_CFG_WWDT_MIN_WINDOW 0x40
49#endif
50
51#ifndef VSF_STHAL_CFG_WWDT_MAX_WINDOW
52# define VSF_STHAL_CFG_WWDT_MAX_WINDOW 0x7F
53#endif
54
55#define IS_WWDG_WINDOW(__WINDOW__) \
56 (((__WINDOW__) >= VSF_STHAL_CFG_WWDT_MIN_WINDOW) && ((__WINDOW__) <= VSF_STHAL_CFG_WWDT_MAX_WINDOW))
57#define IS_WWDG_COUNTER(__COUNTER__) \
58 (((__COUNTER__) >= VSF_STHAL_CFG_WWDT_MIN_WINDOW) && ((__COUNTER__) <= VSF_STHAL_CFG_WWDT_MAX_WINDOW))
59
60#define IS_WWDG_EWI_MODE(__MODE__) \
61 (((__MODE__) == WWDG_EWI_ENABLE) || ((__MODE__) == WWDG_EWI_DISABLE))
62
63#define IS_WWDG_ALL_INSTANCE(__INSTANCE__) 1
64
65/*============================ MACROFIED FUNCTIONS ===========================*/
66/*============================ TYPES =========================================*/
67
68typedef vsf_wdt_t WWDG_TypeDef;
69
70typedef struct {
71 uint32_t Prescaler;
72 uint32_t Window;
74 uint32_t EWIMode;
75} WWDG_InitTypeDef;
76
77#if (USE_HAL_WWDG_REGISTER_CALLBACKS == 1)
78typedef struct __WWDG_HandleTypeDef
79#else
80typedef struct
81#endif
82{
83 WWDG_TypeDef *Instance;
84 WWDG_InitTypeDef Init;
85
86#if (USE_HAL_WWDG_REGISTER_CALLBACKS == 1)
87 void (*EwiCallback)(struct __WWDG_HandleTypeDef *hwwdg);
88 void (*MspInitCallback)(struct __WWDG_HandleTypeDef *hwwdg);
89#endif
90} WWDG_HandleTypeDef;
91
92#if (USE_HAL_WWDG_REGISTER_CALLBACKS == 1)
93typedef enum {
94 HAL_WWDG_EWI_CB_ID = 0x00U,
95 HAL_WWDG_MSPINIT_CB_ID = 0x01U,
96} HAL_WWDG_CallbackIDTypeDef;
97typedef void (*pWWDG_CallbackTypeDef)(WWDG_HandleTypeDef *hppp);
98#endif
99
100/*============================ GLOBAL VARIABLES ==============================*/
101/*============================ PROTOTYPES ====================================*/
102HAL_StatusTypeDef HAL_WWDG_Init(WWDG_HandleTypeDef *hwwdg);
103void HAL_WWDG_MspInit(WWDG_HandleTypeDef *hwwdg);
104
105#if (USE_HAL_WWDG_REGISTER_CALLBACKS == 1)
106HAL_StatusTypeDef HAL_WWDG_RegisterCallback(
107 WWDG_HandleTypeDef *hwwdg, HAL_WWDG_CallbackIDTypeDef CallbackID,
108 pWWDG_CallbackTypeDef pCallback);
109HAL_StatusTypeDef HAL_WWDG_UnRegisterCallback(
110 WWDG_HandleTypeDef *hwwdg, HAL_WWDG_CallbackIDTypeDef CallbackID);
111#endif
112HAL_StatusTypeDef HAL_WWDG_Refresh(WWDG_HandleTypeDef *hwwdg);
113void HAL_WWDG_IRQHandler(WWDG_HandleTypeDef *hwwdg);
114void HAL_WWDG_EarlyWakeupCallback(WWDG_HandleTypeDef *hwwdg);
115
116#endif /* defined(HAL_WWDG_MODULE_ENABLED) && VSF_HAL_USE_WDT == ENABLED */
117
118#ifdef __cplusplus
119}
120#endif
121
122#endif
vsf_err_t(* Init)(vsf_adc_cfg_t *pCfg)
Definition adc_interface.h:38
unsigned uint32_t
Definition stdint.h:9
HAL_StatusTypeDef
Definition sthal_def.h:61
void HAL_WWDG_IRQHandler(WWDG_HandleTypeDef *hwwdg)
Definition sthal_wwdg.c:201
HAL_StatusTypeDef HAL_WWDG_Init(WWDG_HandleTypeDef *hwwdg)
Definition sthal_wwdg.c:71
void HAL_WWDG_MspInit(WWDG_HandleTypeDef *hwwdg)
Definition sthal_wwdg.c:43
void HAL_WWDG_EarlyWakeupCallback(WWDG_HandleTypeDef *hwwdg)
Definition sthal_wwdg.c:50
HAL_StatusTypeDef HAL_WWDG_Refresh(WWDG_HandleTypeDef *hwwdg)
Definition sthal_wwdg.c:187
WDT instance structure, used for WDT Multi Class support, not needed in non Multi Class mode.
Definition vsf_template_wdt.h:362
u32_property_t Counter
get or set the counter
Definition systick.h:89
Generated from commit: vsfteam/vsf@0c4049f