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
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
|
/**
* \file
*
* \brief SAM Watchdog Driver for SAMB
*
* Copyright (c) 2015 Atmel Corporation. All rights reserved.
*
* \asf_license_start
*
* \page License
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* 1. Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
*
* 3. The name of Atmel may not be used to endorse or promote products derived
* from this software without specific prior written permission.
*
* 4. This software may only be redistributed and used in connection with an
* Atmel microcontroller product.
*
* THIS SOFTWARE IS PROVIDED BY ATMEL "AS IS" AND ANY EXPRESS OR IMPLIED
* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT ARE
* EXPRESSLY AND SPECIFICALLY DISCLAIMED. IN NO EVENT SHALL ATMEL BE LIABLE FOR
* ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
* STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
* ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*
* \asf_license_stop
*
*/
/*
* Support and FAQ: visit <a href="http://www.atmel.com/design-support/">Atmel Support</a>
*/
#ifndef WDT_SAM_B_H_INCLUDED
#define WDT_SAM_B_H_INCLUDED
/**
* \defgroup asfdoc_samb_wdt_group SAM Watchdog Driver (WDT)
*
* This driver for Atmel® | SMART SAM devices provides an interface for the configuration
* and management of the device's Watchdog Timer module, including the enabling,
* disabling, and kicking within the device.
*
* The following peripherals are used by this module:
* - WDT (Watchdog Timer)
*
* The following devices can use this module:
* - Atmel | SMART SAM B11
*
* The outline of this documentation is as follows:
* - \ref asfdoc_samb_wdt_prerequisites
* - \ref asfdoc_samb_wdt_module_overview
* - \ref asfdoc_samb_wdt_special_considerations
* - \ref asfdoc_samb_wdt_extra_info
* - \ref asfdoc_samb_wdt_examples
* - \ref asfdoc_samb_wdt_api_overview
*
*
* \section asfdoc_samb_wdt_prerequisites Prerequisites
*
* There are no prerequisites for this module.
*
*
* \section asfdoc_samb_wdt_module_overview Module Overview
* The watchdog module is based on a 32-bit down-counter that is initialized
* from the Reload Register. The watchdog module generates a regular interrupt,
* depending on a programmed value. The counter decrements by one on each
* positive clock edge of clock when the clock is enable. The watchdog monitors
* the interrupt and asserts a reset request signal when the counter reaches 0,
* and the counter is stopped. On the next enabled clock edge, the counter is
* reloaded from the WDT load Register and the countdown sequence continues. If
* the interrupt is not cleared by the time the counter next reaches 0, the
* watchdog module reasserts the reset signal.
*
* A simplified block diagram of the WDT can be seen in
* \ref asfdoc_samb_wdt_module_block_diagram "the figure below".
*
* \anchor asfdoc_samb_wdt_module_block_diagram
* \image html wdt_block_diagram.svg "WDT Block Diagram"
*
* \section asfdoc_samb_wdt_special_considerations Special Considerations
* There are no special considerations for this module.
*
* \section asfdoc_samb_wdt_extra_info Extra Information
*
* For extra information, see \ref asfdoc_samb_wdt_extra. This includes:
* - \ref asfdoc_samb_wdt_extra_acronyms
* - \ref asfdoc_samb_wdt_extra_dependencies
* - \ref asfdoc_samb_wdt_extra_errata
* - \ref asfdoc_samb_wdt_extra_history
*
*
* \section asfdoc_samb_wdt_examples Examples
*
* For a list of examples related to this driver, see
* \ref asfdoc_samb_wdt_exqsg.
*
* \section asfdoc_samb_wdt_api_overview API Overview
* @{
*/
#include <compiler.h>
#include <system_sam_b.h>
#ifdef __cplusplus
extern "C" {
#endif
#define WDT_WRITE_ACCESS_KEY 0x1ACCE551
struct wdt_module;
/** Type definition for a WDT module callback function. */
typedef void (*wdt_callback_t)(void);
/** Enum for the possible callback types for the WDT module. */
enum wdt_callback
{
/**
* Callback type for when an early warning callback from the WDT module
* is issued
*/
WDT_CALLBACK_EARLY_WARNING,
/** Number of available callbacks */
WDT_CALLBACK_N,
};
/**
* \brief Watchdog Timer configuration structure.
*
* Configuration structure for a Watchdog Timer instance. This
* structure should be initialized by the \ref wdt_get_config_defaults()
* function before being modified by the user application.
*/
struct wdt_config {
/** Watchdog load value */
uint32_t load_value;
/** Enable reset output */
bool enable_reset;
/** Enable write access */
bool write_access;
};
/**
* \brief WDT driver software device instance structure.
*
* WDT driver software instance structure, used to retain software
* state information of an associated hardware module instance.
*
* \note The fields of this structure should not be altered by the user
* application; they are reserved for module-internal use only.
*/
struct wdt_module {
#if !defined(__DOXYGEN__)
/** Pointer to the hardware instance */
Wdt *hw;
/** Array to store callback function pointers in */
wdt_callback_t callback[WDT_CALLBACK_N];
/** Bit mask for callbacks registered */
uint8_t callback_reg_mask;
/** Bit mask for callbacks enabled */
uint8_t callback_enable_mask;
#endif
};
/**
* \name Configuration and Initialization
* @{
*/
void wdt_get_config_defaults(struct wdt_config *const config);
enum status_code wdt_set_config(struct wdt_module *const module, Wdt * const hw, \
const struct wdt_config *const config);
/** @} */
/**
* \name Reset
* @{
*/
void wdt_reset(struct wdt_module *const module);
/** @} */
/**
* \name Get and Clear status
* @{
*/
uint8_t wdt_get_interrupt_status(struct wdt_module *const module);
uint8_t wdt_get_status(struct wdt_module *const module);
void wdt_clear_status(struct wdt_module *const module);
/** @} */
/**
* \name Reload and get count value
* @{
*/
enum status_code wdt_set_reload_count(struct wdt_module *const module, \
uint32_t load_value);
void wdt_get_current_count(struct wdt_module *const module, \
uint32_t * count_value);
/** @} */
/**
* \name Callback
* @{
*/
void wdt_register_callback(struct wdt_module *const module,
wdt_callback_t callback_func,
enum wdt_callback callback_type);
void wdt_unregister_callback(struct wdt_module *module,
enum wdt_callback callback_type);
void wdt_enable_callback(struct wdt_module *module,
enum wdt_callback callback_type);
void wdt_disable_callback(struct wdt_module *const module,
enum wdt_callback callback_type);
/** @} */
/** @} */
#ifdef __cplusplus
}
#endif
/** @} */
/**
* \page asfdoc_samb_wdt_extra Extra Information for WDT Driver
*
* \section asfdoc_samb_wdt_extra_acronyms Acronyms
* The table below presents the acronyms used in this module:
*
* <table>
* <tr>
* <th>Acronym</th>
* <th>Description</th>
* </tr>
* <tr>
* <td>WDT</td>
* <td>Watchdog Timer</td>
* </tr>
* </table>
*
*
* \section asfdoc_samb_wdt_extra_dependencies Dependencies
* There are no dependencies related to this driver.
*
*
* \section asfdoc_samb_wdt_extra_errata Errata
* There are no errata related to this driver.
*
*
* \section asfdoc_samb_wdt_extra_history Module History
* An overview of the module history is presented in the table below, with
* details on the enhancements and fixes made to the module since its first
* release. The current version of this corresponds to the newest version in
* the table.
*
* <table>
* <tr>
* <th>Changelog</th>
* </tr>
* <tr>
* <td>Initial Release</td>
* </tr>
* </table>
*/
/**
* \page asfdoc_samb_wdt_exqsg Examples for WDT Driver
*
* This is a list of the available Quick Start guides (QSGs) and example
* applications for \ref asfdoc_samb_wdt_group. QSGs are simple examples with
* step-by-step instructions to configure and use this driver in a selection of
* use cases. Note that QSGs can be compiled as a standalone application or be
* added to the user application.
*
* - \subpage asfdoc_samb_wdt_basic_use_case
*
* \page asfdoc_samb_wdt_document_revision_history Document Revision History
*
* <table>
* <tr>
* <th>Doc. Rev.</td>
* <th>Date</td>
* <th>Comments</td>
* </tr>
* <tr>
* <td>A</td>
* <td>09/2015</td>
* <td>Initial release</td>
* </tr>
* </table>
*/
#endif /* WDT_H_INCLUDED */
|
