VSF Documented
wdt.h
Go to the documentation of this file.
1/*****************************************************************************
2 * Copyright(C)2009-2022 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 __HAL_DRIVER_${SERIES/WDT_IP}_WDT_H__
19#define __HAL_DRIVER_${SERIES/WDT_IP}_WDT_H__
20
21/*============================ INCLUDES ======================================*/
22
23#include "hal/vsf_hal_cfg.h"
24
25#if VSF_HAL_USE_WDT == ENABLED
26
27// HW/IPCore
32// HW/IPCore end
33
34/*\note Refer to template/README.md for usage cases.
35 * For peripheral drivers, blackbox mode is recommended but not required, reimplementation part MUST be open.
36 * For IPCore drivers, class structure, MULTI_CLASS configuration, reimplementation and class APIs should be open to user.
37 * For emulated drivers, **** No reimplementation ****.
38 */
39
40/*\note Includes CAN ONLY be put here. */
41/*\note If current header is for a peripheral driver(hw driver), and inherit from an IPCore driver, include IPCore header here. */
42
43// IPCore
44#if defined(__VSF_HAL_${WDT_IP}_WDT_CLASS_IMPLEMENT)
45# define __VSF_CLASS_IMPLEMENT__
46#elif defined(__VSF_HAL_${WDT_IP}_WDT_CLASS_INHERIT__)
47# define __VSF_CLASS_INHERIT__
48#endif
49
50#include "utilities/ooc_class.h"
51// IPCore end
52
53#ifdef __cplusplus
54extern "C" {
55#endif
56
57/*============================ MACROS ========================================*/
58
59/*\note VSF_${WDT_IP}_WDT_CFG_MULTI_CLASS should be implemented for IP drives and open to user,
60 * while VSF_HW_WDT_CFG_MULTI_CLASS should be in wdt.c.
61 */
62
63// IPCore
64#ifndef VSF_${WDT_IP}_WDT_CFG_MULTI_CLASS
65# define VSF_${WDT_IP}_WDT_CFG_MULTI_CLASS VSF_WDT_CFG_MULTI_CLASS
66#endif
67// IPCore end
68
69// HW
70/*\note hw WDT driver can reimplement following types:
71 * To enable reimplementation, please enable macro below:
72 * VSF_WDT_CFG_REIMPLEMENT_TYPE_MODE for vsf_wdt_mode_t
73 * VSF_WDT_CFG_REIMPLEMENT_TYPE_IRQ_MASK for vsf_wdt_irq_mask_t
74 * VSF_WDT_CFG_REIMPLEMENT_TYPE_CTRL for vsf_wdt_ctrl_t
75 * VSF_WDT_CFG_REIMPLEMENT_TYPE_CFG for vsf_wdt_cfg_t
76 * VSF_WDT_CFG_REIMPLEMENT_TYPE_CAPABILITY for vsf_wdt_capability_t
77 * Reimplementation is used for optimization hw/IPCore drivers, reimplement the bit mask according to hw registers.
78 * *** DO NOT reimplement these in emulated drivers. ***
79 */
80
81#define VSF_WDT_CFG_REIMPLEMENT_TYPE_MODE ENABLED
82#define VSF_WDT_CFG_REIMPLEMENT_TYPE_IRQ_MASK ENABLED
83#define VSF_WDT_CFG_REIMPLEMENT_TYPE_CTRL ENABLED
84#define VSF_WDT_CFG_REIMPLEMENT_TYPE_CFG ENABLED
85#define VSF_WDT_CFG_REIMPLEMENT_TYPE_CAPABILITY ENABLED
86// HW end
87
88/*============================ MACROFIED FUNCTIONS ===========================*/
89/*============================ TYPES =========================================*/
90
91// IPCore
92vsf_class(vsf_${wdt_ip}_wdt_t) {
93#if VSF_${WDT_IP}_CFG_MULTI_CLASS == ENABLED
94 public_member(
95 vsf_wdt_t vsf_wdt;
96 )
97#endif
98
99/*\note You can add more member in vsf_${wdt_ip}_wdt_t instance.
100 * For members accessible from child, put in protected_member.
101 * Else, put in private_member.
102 */
103
104 protected_member(
105 vsf_${wdt_ip}_wdt_reg_t *reg;
108};
109// IPCore end
110
111// HW/IPCore, not for emulated drivers
112#if VSF_WDT_CFG_REIMPLEMENT_TYPE_MODE == ENABLED
113typedef enum vsf_wdt_mode_t {
119
120 // more vendor specified modes can be added here
122#endif
123
124#if VSF_WDT_CFG_REIMPLEMENT_TYPE_IRQ_MASK == ENABLED
125typedef enum vsf_wdt_irq_mask_t {
127
128 // more vendor specified irq_masks can be added here
130#endif
131
132#if VSF_WDT_CFG_REIMPLEMENT_TYPE_CTRL == ENABLED
133typedef enum vsf_wdt_ctrl_t {
135
136 // more vendor specified ctrl can be added here
138#endif
139
140#if VSF_WDT_CFG_REIMPLEMENT_TYPE_CFG == ENABLED
141typedef struct vsf_wdt_t vsf_wdt_t;
142typedef void vsf_wdt_isr_handler_t(void *target_ptr, vsf_wdt_t *wdt_ptr);
143typedef struct vsf_wdt_isr_t {
145 void *target_ptr;
148typedef struct vsf_wdt_cfg_t {
154#endif
155
156#if VSF_WDT_CFG_REIMPLEMENT_TYPE_CAPABILITY == ENABLED
157typedef struct vsf_wdt_capability_t {
165
166 // more vendor specified capability can be added here
168#endif
169// HW/IPCore end
170
171
172/*============================ INCLUDES ======================================*/
173
174// IPCore
175/*\note Extern APIs for ip core diriver.
176 * There is no requirement about how APIs of IPCore drivers should be implemented.
177 * Just consider the simplicity for actual peripheral drivers.
178 */
179// IPCore end
180
181#ifdef __cplusplus
182}
183#endif
184
185// IPCore
186#undef __VSF_HAL_${WDT_IP}_WDT_CLASS_IMPLEMENT
187#undef __VSF_HAL_${WDT_IP}_WDT_CLASS_INHERIT__
188// IPCore end
189
190#endif // VSF_HAL_USE_WDT
191#endif // __HAL_DRIVER_${SERIES/WDT_IP}_WDT_H__
192/* EOF */
vsf_wdt_mode_t
Definition wdt.h:31
@ VSF_WDT_MODE_RESET_SOC
Definition wdt.h:36
@ VSF_WDT_MODE_NO_EARLY_WAKEUP
Definition wdt.h:32
@ VSF_WDT_MODE_RESET_CPU
Definition wdt.h:37
@ VSF_WDT_MODE_RESET_NONE
Definition wdt.h:38
@ VSF_WDT_MODE_EARLY_WAKEUP
Definition wdt.h:33
Definition adc.h:92
vsf_arch_prio_t
Definition cortex_a_generic.h:88
#define vsf_class(__name)
Definition ooc_class.h:48
unsigned uint32_t
Definition stdint.h:9
unsigned char uint8_t
Definition stdint.h:5
Predefined VSF WDT capability that can be reimplemented in specific hal drivers. The vsf_wdt_capabili...
Definition vsf_template_wdt.h:330
uint8_t support_reset_soc
Indicates if SoC reset mode is supported.
Definition vsf_template_wdt.h:338
uint8_t support_disable
Indicates if WDT can be disabled after startup.
Definition vsf_template_wdt.h:339
uint8_t support_reset_none
Definition wdt.h:159
uint8_t support_early_wakeup
Definition wdt.h:158
uint8_t support_reset_cpu
Indicates if core reset mode is supported.
Definition vsf_template_wdt.h:337
uint32_t max_timeout_ms
Maximum timeout in milliseconds.
Definition vsf_template_wdt.h:341
uint8_t support_min_timeout
Indicates if minimum timeout is supported.
Definition vsf_template_wdt.h:340
WDT configuration structure.
Definition vsf_template_wdt.h:311
vsf_wdt_mode_t mode
WDT mode, refer to vsf_wdt_mode_t.
Definition vsf_template_wdt.h:312
uint32_t min_ms
Minimum timeout in milliseconds.
Definition vsf_template_wdt.h:314
uint32_t max_ms
Maximum timeout in milliseconds.
Definition vsf_template_wdt.h:313
vsf_wdt_isr_t isr
WDT interrupt configuration, refer to vsf_wdt_isr_t.
Definition vsf_template_wdt.h:315
WDT interrupt configuration structure.
Definition vsf_template_wdt.h:298
vsf_wdt_isr_handler_t * handler_fn
Interrupt handler function pointer.
Definition vsf_template_wdt.h:299
void * target_ptr
User-defined target pointer.
Definition vsf_template_wdt.h:300
vsf_arch_prio_t prio
Interrupt priority.
Definition vsf_template_wdt.h:301
WDT instance structure, used for WDT Multi Class support, not needed in non Multi Class mode.
Definition vsf_template_wdt.h:363
vsf_wdt_irq_mask_t
Definition wdt.h:125
@ VSF_WDT_IRQ_MASK_OVERFLOW
Definition wdt.h:126
vsf_wdt_isr_t isr
Definition wdt.h:107
void vsf_wdt_isr_handler_t(void *target_ptr, vsf_wdt_t *wdt_ptr)
Definition wdt.h:142
class vsf_$ * reg
vsf_wdt_ctrl_t
Definition wdt.h:133
@ __VSF_WDT_CTRL_DUMMY
Definition wdt.h:134
Generated from commit: vsfteam/vsf@74aa6ce