blob: 0f694c57ba7bbe52cb0245296cd813c44552a422 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
|
/*
Copyright (C) 2014..2017 Marco Veeneman
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
/**
* @file WDT/hal_wdg_lld.h
* @brief WDG Driver subsystem low level driver header.
*
* @addtogroup WDG
* @{
*/
#ifndef _WDG_LLD_H_
#define _WDG_LLD_H_
#if HAL_USE_WDG || defined(__DOXYGEN__)
/*===========================================================================*/
/* Driver constants. */
/*===========================================================================*/
/*===========================================================================*/
/* Driver pre-compile time settings. */
/*===========================================================================*/
/**
* @name Configuration options
* @{
*/
/**
* @brief WDT driver enable switch.
* @details If set to @p TRUE the support for WDT is included.
* @note The default is @p FALSE.
*/
#if !defined(TIVA_WDG_USE_WDT) || defined(__DOXYGEN__)
#define TIVA_WDG_USE_WDT FALSE
#endif
/**
* @brief WDT interrupt priority level setting.
*/
#if !defined(TIVA_WDG_WDT_IRQ_PRIORITY) || defined(__DOXYGEN__)
#define TIVA_WDG_WDT_IRQ_PRIORITY 5
#endif
/** @} */
/*===========================================================================*/
/* Derived constants and error checks. */
/*===========================================================================*/
#if TIVA_WDG_USE_WDT0 && !TIVA_HAS_WDT0
#error "WDT0 not present in the selected device"
#endif
#if TIVA_WDG_USE_WDT1 && !TIVA_HAS_WDT1
#error "WDT1 not present in the selected device"
#endif
#if !TIVA_WDG_USE_WDT0 && !TIVA_WDG_USE_WDT1
#error "WDG driver activated but no WDT peripheral assigned"
#endif
/*===========================================================================*/
/* Driver data structures and types. */
/*===========================================================================*/
/**
* @brief Type of a structure representing an WDG driver.
*/
typedef struct WDGDriver WDGDriver;
/**
* @brief WDG timeout callback type.
*
* @param[in] wdgp pointer to the @p WDGDriver object triggering the callback.
*/
typedef bool (*wdgcallback_t)(WDGDriver *wdgp);
/**
* @brief Driver configuration structure.
* @note It could be empty on some architectures.
*/
typedef struct
{
/**
* @brief Interval value used by the WDT.
*/
uint32_t load;
/**
* @brief Timeout callback pointer.
* @note This callback is invoked on the first WDT timeout. If set to
* @p NULL then the callback is disabled.
*/
wdgcallback_t callback;
/**
* @brief Test register configuration value.
*/
uint16_t test;
} WDGConfig;
/**
* @brief Structure representing an WDG driver.
*/
struct WDGDriver
{
/**
* @brief Driver state.
*/
wdgstate_t state;
/**
* @brief Current configuration data.
*/
const WDGConfig *config;
/* End of the mandatory fields.*/
/**
* @brief Pointer to the WDT registers block.
*/
uint32_t wdt;
};
/*===========================================================================*/
/* Driver macros. */
/*===========================================================================*/
#if !TIVA_WDG_USE_WDT1
#define wdgTivaSyncWrite(wdt)
#endif
/*===========================================================================*/
/* External declarations. */
/*===========================================================================*/
#if TIVA_WDG_USE_WDT0 && !defined(__DOXYGEN__)
extern WDGDriver WDGD1;
#endif
#if TIVA_WDG_USE_WDT1 && !defined(__DOXYGEN__)
extern WDGDriver WDGD2;
#endif
#ifdef __cplusplus
extern "C" {
#endif
void wdg_lld_init(void);
void wdg_lld_start(WDGDriver *wdgp);
void wdg_lld_stop(WDGDriver *wdgp);
void wdg_lld_reset(WDGDriver *wdgp);
#if TIVA_WDG_USE_WDT1
void wdgTivaSyncWrite(WDGDriver *wdgp);
#endif
#ifdef __cplusplus
}
#endif
#endif /* HAL_USE_WDG */
#endif /* _WDG_LLD_H_ */
/** @} */
|
