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
|
/// $Id: HplAtm128Adc.nc,v 1.6 2010-06-29 22:07:43 scipio Exp $
/*
* Copyright (c) 2004-2005 Crossbow Technology, Inc. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* - Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* - 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.
* - Neither the name of Crossbow Technology nor the names of
* its contributors may be used to endorse or promote products derived
* from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
* FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
* THE COPYRIGHT HOLDER OR CONTRIBUTORS 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.
*/
#include "Atm128Adc.h"
/**
* HPL interface to the Atmega128 A/D conversion subsystem. Please see the
* Atmega128 manual for full details on the functioning of this subsystem.
* <p>
* A word of warning: the Atmega128 SLEEP instruction initiates an A/D
* conversion when the ADC and ADC interrupt are enabled.
*
* @author Martin Turon <mturon@xbow.com>
* @author Hu Siquan <husq@xbow.com>
* @author David Gay
*/
interface HplAtm128Adc {
/**
* Sets the ADC channel
* @param mux New channel
*/
async command void setChannel(uint8_t mux);
/**
* Returns the current ADC channel
* @return Current channel
*/
async command uint8_t getChannel();
/**
* Turns ADLAR (ADC left adjust result) on/off
* @param adlarOn TRUE turns on ADLAR, FALSE turns it off
*/
async command void setAdlar(bool adlarOn);
/**
* Returns ADLAR (ADC left adjust result) status
* @returns TRUE if ADLAR is on.
*/
async command bool isAdlarOn();
/**
* Sets the reference voltage
* @param ref New reference voltage
*/
async command void setRef(uint8_t ref);
/**
* Returns the current reference voltage
* @returns the current reference voltage
*/
async command uint8_t getRef();
/**
* Read the ADCSRA (ADC control) register
* @return Current ADCSRA value
*/
async command Atm128Adcsra_t getAdcsra();
/**
* Set the ADCSRA (ADC control) register
* @param adcsra New ADCSRA value
*/
async command void setAdcsra(Atm128Adcsra_t adcsra);
/**
* Read the latest A/D conversion result
* @return A/D value
*/
async command uint16_t getValue();
/// A/D control utilities. All of these clear any pending A/D interrupt.
/**
* Enable ADC sampling
*/
async command void enableAdc();
/**
* Disable ADC sampling
*/
async command void disableAdc();
/**
* Enable ADC interrupt
*/
async command void enableInterruption();
/**
* Disable ADC interrupt
*/
async command void disableInterruption();
/**
* Clear the ADC interrupt flag
*/
async command void resetInterrupt();
/**
* Start ADC conversion. If ADC interrupts are enabled, the dataReady event
* will be signaled once (in non-continuous mode) or repeatedly (in
* continuous mode).
*/
async command void startConversion();
/**
* Enable continuous sampling
*/
async command void setContinuous();
/**
* Disable continuous sampling
*/
async command void setSingle();
/* A/D status checks */
/**
* Is ADC enabled?
* @return TRUE if the ADC is enabled, FALSE otherwise
*/
async command bool isEnabled();
/**
* Is A/D conversion in progress?
* @return TRUE if the A/D conversion is in progress, FALSE otherwise
*/
async command bool isStarted();
/**
* Is A/D conversion complete? Note that this flag is automatically
* cleared when an A/D interrupt occurs.
* @return TRUE if the A/D conversion is complete, FALSE otherwise
*/
async command bool isComplete();
/**
* Set ADC prescaler selection bits
* @param scale New ADC prescaler. Must be one of the ATM128_ADC_PRESCALE_xxx
* values from Atm128Adc.h
*/
async command void setPrescaler(uint8_t scale);
/**
* Cancel A/D conversion and any pending A/D interrupt. Also disables the
* ADC interruption (otherwise a sample might start at the next sleep
* instruction). This command can assume that the A/D converter is enabled.
* @return TRUE if an A/D conversion was in progress or an A/D interrupt
* was pending, FALSE otherwise. In single conversion mode, a return
* of TRUE implies that the dataReady event will not be signaled.
*/
async command bool cancel();
/**
* A/D interrupt occured
* @param data Latest A/D conversion result
*/
async event void dataReady(uint16_t data);
}
|
