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
|
/**
* \file
*
* \brief SAM TIMER Driver for SAMB11
*
* 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 TIMER_H_INCLUDED
#define TIMER_H_INCLUDED
/**
* \defgroup asfdoc_samb_timer_group SAM TIMER
*
* This driver for Atmel® | SMART SAM devices provides an interface for the
* configuration and management of the device's basic Timer functionality.
*
* The following peripherals are used by this module:
* - TIMER
*
* The following devices can use this module:
* - Atmel | SMART SAM B11
*
* The outline of this documentation is as follows:
* - \ref asfdoc_samb_timer_prerequisites
* - \ref asfdoc_samb_timer_module_overview
* - \ref asfdoc_samb_timer_special_considerations
* - \ref asfdoc_samb_timer_extra_info
* - \ref asfdoc_samb_timer_examples
* - \ref asfdoc_samb_timer_api_overview
*
*
* \section asfdoc_samb_timer_prerequisites Prerequisites
*
* There are no prerequisites for this module.
*
*
* \section asfdoc_samb_timer_module_overview Module Overview
* This driver proiveds a basic timer for count, is a 32-bit
* down-counter with the following features:
*
* - You can generate an interrupt request signal, TIMERINT,
* when the counter reaches 0.
* - The interrupt request is held until it is cleared by writing to the INTCLEAR Register.
*
* - You can use the zero to one transition of the external input signal, EXTIN, as a timer enable.
*
* - If the APB timer count reaches 0 and, at the same time, the software clears a previous
* interrupt status, the interrupt status is set to 1.
*
* - The external clock, EXTIN, must be slower than half of the peripheral clock because it is
* sampled by a double flip-flop and then goes through edge-detection logic when the
* external inputs act as a clock.
*
* - A separate clock pin, PCLKG, for the APB register read or write logic that permits the
* clock to peripheral register logic to stop when there is no APB activity.
*
* \section asfdoc_samb_timer_special_considerations Special Considerations
*
* There are no prerequisites for this module.
*
* \section asfdoc_samb_timer_extra_info Extra Information
*
* For extra information, see \ref asfdoc_samb_timer_extra. This includes:
* - \ref asfdoc_samb_timer_extra_acronyms
* - \ref asfdoc_samb_timer_extra_dependencies
* - \ref asfdoc_samb_timer_extra_errata
* - \ref asfdoc_samb_timer_extra_history
*
*
* \section asfdoc_samb_timer_examples Examples
*
* For a list of examples related to this driver, see
* \ref asfdoc_samb_timer_exqsg.
*
*
* \section asfdoc_samb_timer_api_overview API Overview
* @{
*/
#include <compiler.h>
#include <system_sam_b.h>
#ifdef __cplusplus
extern "C" {
#endif
/** Type definition for a TIMER module callback function. */
typedef void (*timer_callback_t)(void);
/**
* \brief TIMER configuration structure.
*
* Configuration struct for a TIMER instance. This structure should be
* initialized by the \ref timer_get_config_defaults function before being
* modified by the user application.
*/
struct timer_config {
/** Reload value */
uint32_t reload_value;
/** Enable timer interrupt */
bool interrupt_enable;
};
/**
* \name Configuration and Initialization
* @{
*/
void timer_get_config_defaults(struct timer_config *config);
void timer_init(const struct timer_config *config);
/** @} */
/**
* \name Get and set value
* @{
*/
uint32_t timer_get_value(void);
void timer_set_value(uint32_t value);
/** @} */
/**
* \name Get and Clear status
* @{
*/
uint32_t timer_get_interrupt_status(void);
void timer_clear_interrupt_status(void);
/** @} */
/**
* \name Enable and disable module
* @{
*/
void timer_enable(void);
void timer_disable(void);
/** @} */
/**
* \name Callback
* @{
*/
void timer_register_callback(timer_callback_t fun);
void timer_unregister_callback(void);
/** @} */
/** @}*/
#ifdef __cplusplus
}
#endif
/**
* \page asfdoc_samb_timer_extra Extra Information for TIMER Driver
*
* \section asfdoc_samb_timer_extra_acronyms Acronyms
* Below is a table listing the acronyms used in this module, along with their
* intended meanings.
* <table>
* <tr>
* <th>Acronym</th>
* <th>Description</th>
* </tr>
* <tr>
* <td>TIMER</td>
* <td>Timer</td>
* </tr>
* </table>
*
* \section asfdoc_samb_timer_extra_dependencies Dependencies
* There are no dependencies related to this driver.
*
*
* \section asfdoc_samb_timer_extra_errata Errata
* There are no errata related to this driver.
*
*
* \section asfdoc_samb_timer_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_timer_exqsg Examples for TIMER Driver
*
* This is a list of the available Quick Start guides (QSGs) and example
* applications for \ref asfdoc_samb_timer_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_timer_basic_use_case
*
* \page asfdoc_samb_timer_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
|
