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
|
/**
* \file
*
* \brief SAM External Interrupt Driver
*
* Copyright (C) 2012-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>
*/
#include "extint.h"
#include "extint_callback.h"
/**
* \internal
* Internal driver device instance struct, declared in the main module driver.
*/
extern struct _extint_module _extint_dev;
/**
* \internal
* This is the number of the channel whose callback is currently running.
*/
uint8_t _current_channel;
/**
* \brief Registers an asynchronous callback function with the driver.
*
* Registers an asynchronous callback with the EXTINT driver, fired when a
* channel detects the configured channel detection criteria
* (e.g. edge or level). Callbacks are fired once for each detected channel.
*
* \note NMI channel callbacks cannot be registered via this function; the
* device's NMI interrupt should be hooked directly in the user
* application and the NMI flags manually cleared via
* \ref extint_nmi_clear_detected().
*
* \param[in] callback Pointer to the callback function to register
* \param[in] channel Logical channel to register callback for
* \param[in] type Type of callback function to register
*
* \return Status of the registration operation.
* \retval STATUS_OK The callback was registered successfully
* \retval STATUS_ERR_INVALID_ARG If an invalid callback type was supplied
* \retval STATUS_ERR_ALREADY_INITIALIZED Callback function has been
* registered, need unregister first
*/
enum status_code extint_register_callback(
const extint_callback_t callback,
const uint8_t channel,
const enum extint_callback_type type)
{
/* Sanity check arguments */
Assert(callback);
if (type != EXTINT_CALLBACK_TYPE_DETECT) {
Assert(false);
return STATUS_ERR_INVALID_ARG;
}
if (_extint_dev.callbacks[channel] == NULL) {
_extint_dev.callbacks[channel] = callback;
return STATUS_OK;
} else if (_extint_dev.callbacks[channel] == callback) {
return STATUS_OK;
}
return STATUS_ERR_ALREADY_INITIALIZED;
}
/**
* \brief Unregisters an asynchronous callback function with the driver.
*
* Unregisters an asynchronous callback with the EXTINT driver, removing it
* from the internal callback registration table.
*
* \param[in] callback Pointer to the callback function to unregister
* \param[in] channel Logical channel to unregister callback for
* \param[in] type Type of callback function to unregister
*
* \return Status of the de-registration operation.
* \retval STATUS_OK The callback was unregistered successfully
* \retval STATUS_ERR_INVALID_ARG If an invalid callback type was supplied
* \retval STATUS_ERR_BAD_ADDRESS No matching entry was found in the
* registration table
*/
enum status_code extint_unregister_callback(
const extint_callback_t callback,
const uint8_t channel,
const enum extint_callback_type type)
{
/* Sanity check arguments */
Assert(callback);
if (type != EXTINT_CALLBACK_TYPE_DETECT) {
Assert(false);
return STATUS_ERR_INVALID_ARG;
}
if (_extint_dev.callbacks[channel] == callback) {
_extint_dev.callbacks[channel] = NULL;
return STATUS_OK;
}
return STATUS_ERR_BAD_ADDRESS;
}
/**
* \brief Enables asynchronous callback generation for a given channel and type.
*
* Enables asynchronous callbacks for a given logical external interrupt channel
* and type. This must be called before an external interrupt channel will
* generate callback events.
*
* \param[in] channel Logical channel to enable callback generation for
* \param[in] type Type of callback function callbacks to enable
*
* \return Status of the callback enable operation.
* \retval STATUS_OK The callback was enabled successfully
* \retval STATUS_ERR_INVALID_ARG If an invalid callback type was supplied
*/
enum status_code extint_chan_enable_callback(
const uint8_t channel,
const enum extint_callback_type type)
{
if (type == EXTINT_CALLBACK_TYPE_DETECT) {
Eic *const eic = _extint_get_eic_from_channel(channel);
eic->INTENSET.reg = (1UL << channel);
}
else {
Assert(false);
return STATUS_ERR_INVALID_ARG;
}
return STATUS_OK;
}
/**
* \brief Disables asynchronous callback generation for a given channel and type.
*
* Disables asynchronous callbacks for a given logical external interrupt
* channel and type.
*
* \param[in] channel Logical channel to disable callback generation for
* \param[in] type Type of callback function callbacks to disable
*
* \return Status of the callback disable operation.
* \retval STATUS_OK The callback was disabled successfully
* \retval STATUS_ERR_INVALID_ARG If an invalid callback type was supplied
*/
enum status_code extint_chan_disable_callback(
const uint8_t channel,
const enum extint_callback_type type)
{
if (type == EXTINT_CALLBACK_TYPE_DETECT) {
Eic *const eic = _extint_get_eic_from_channel(channel);
eic->INTENCLR.reg = (1UL << channel);
}
else {
Assert(false);
return STATUS_ERR_INVALID_ARG;
}
return STATUS_OK;
}
/**
* \brief Find what channel caused the callback.
*
* Can be used in an EXTINT callback function to find what channel caused
* the callback in case the same callback is used by multiple channels.
*
* \return Channel number.
*/
uint8_t extint_get_current_channel(void)
{
return _current_channel;
}
/** Handler for the EXTINT hardware module interrupt. */
void EIC_Handler(void)
{
/* Find any triggered channels, run associated callback handlers */
for (_current_channel = 0; _current_channel < EIC_NUMBER_OF_INTERRUPTS ; _current_channel++) {
if (extint_chan_is_detected(_current_channel)) {
/* Clear flag */
extint_chan_clear_detected(_current_channel);
/* Find any associated callback entries in the callback table */
if (_extint_dev.callbacks[_current_channel] != NULL) {
/* Run the registered callback */
_extint_dev.callbacks[_current_channel]();
}
}
}
}
|
