root / branches / analog / code / projects / libdragonfly / analog.c @ 1378
History | View | Annotate | Download (10.4 KB)
1 | 338 | bcoltin | /**
|
---|---|---|---|
2 | * Copyright (c) 2007 Colony Project
|
||
3 | *
|
||
4 | * Permission is hereby granted, free of charge, to any person
|
||
5 | * obtaining a copy of this software and associated documentation
|
||
6 | * files (the "Software"), to deal in the Software without
|
||
7 | * restriction, including without limitation the rights to use,
|
||
8 | * copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||
9 | * copies of the Software, and to permit persons to whom the
|
||
10 | * Software is furnished to do so, subject to the following
|
||
11 | * conditions:
|
||
12 | *
|
||
13 | * The above copyright notice and this permission notice shall be
|
||
14 | * included in all copies or substantial portions of the Software.
|
||
15 | *
|
||
16 | * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
||
17 | * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
|
||
18 | * OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
|
||
19 | * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
|
||
20 | * HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
|
||
21 | * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
|
||
22 | * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
|
||
23 | * OTHER DEALINGS IN THE SOFTWARE.
|
||
24 | **/
|
||
25 | |||
26 | /**
|
||
27 | * @file analog.c
|
||
28 | * @brief Analog input and output
|
||
29 | *
|
||
30 | * Contains functions for manipulating the ADC on the Dragonfly board.
|
||
31 | *
|
||
32 | * @author Colony Project, CMU Robotics Club
|
||
33 | 1378 | jykong | * originally taken from fwr analog file (author: Tom Lauwers)
|
34 | * loop code written by Kevin Woo and James Kong
|
||
35 | 338 | bcoltin | **/
|
36 | |||
37 | #include <util/delay.h> |
||
38 | #include <avr/interrupt.h> |
||
39 | #include "analog.h" |
||
40 | #include "serial.h" |
||
41 | // Internal Function Prototypes
|
||
42 | void set_adc_mux(int which); |
||
43 | |||
44 | /**
|
||
45 | * @defgroup analog Analog
|
||
46 | * Functions for manipulation the ADC on the dragonfly board.
|
||
47 | * All definitions may be found in analog.h.
|
||
48 | *
|
||
49 | * @{
|
||
50 | **/
|
||
51 | |||
52 | int adc_loop_running = 0; |
||
53 | int adc_current_port = 0; |
||
54 | 339 | bcoltin | adc_t an_val[11];
|
55 | 338 | bcoltin | |
56 | /**
|
||
57 | * Initializes the ADC.
|
||
58 | * Call analog_init before reading from the analog ports.
|
||
59 | *
|
||
60 | 437 | kwoo | * @see analog8, analog10, analog_get8, analog_get10
|
61 | 1378 | jykong | *
|
62 | * @bug First conversion takes a performance penalty of
|
||
63 | * 25 vs. 13 ADC clock cycles of successive conversions.
|
||
64 | * Analog_init should run a dummy conversion to pre-empt
|
||
65 | * this.
|
||
66 | *
|
||
67 | * For good 10-bit precision, ACD clock must be between
|
||
68 | * 50kHz and 200kHz. Currently, ADC clock is fixed at
|
||
69 | * 125kHz using 1/64prescalar. However, most code uses
|
||
70 | * 8-bit precision which can work at ADC clock speeds
|
||
71 | * higher than 200kHz. Experimental tests needed to
|
||
72 | * determine highest clock speed for accurate 8-bit ADC.
|
||
73 | *
|
||
74 | 338 | bcoltin | **/
|
75 | 439 | kwoo | void analog_init(int start_conversion) { |
76 | 339 | bcoltin | for (int i = 0; i < 11; i++) { |
77 | 338 | bcoltin | an_val[i].adc10 = 0;
|
78 | an_val[i].adc8 = 0;
|
||
79 | } |
||
80 | |||
81 | // ADMUX register
|
||
82 | // Bit 7,6 - Set voltage reference to AVcc (0b01)
|
||
83 | // Bit 5 - ADLAR set to simplify moving from register
|
||
84 | // Bit 4 - X
|
||
85 | // Bit 3:0 - Sets the current channel
|
||
86 | // Initializes to read from AN1 first (AN0 is reservered for the BOM)
|
||
87 | ADMUX = 0;
|
||
88 | ADMUX |= ADMUX_OPT | _BV(MUX0); |
||
89 | |||
90 | // ADC Status Register A
|
||
91 | // Bit 7 - ADEN is set (enables analog)
|
||
92 | // Bit 6 - Start conversion bit is set (must be done once for free-running mode)
|
||
93 | // Bit 5 - Enable Auto Trigger (for free running mode) NOT DOING THIS RIGHT NOW
|
||
94 | // Bit 4 - ADC interrupt flag, 0
|
||
95 | // Bit 3 - Enable ADC Interrupt (required to run free-running mode)
|
||
96 | // Bits 2-0 - Set to create a clock divisor of 128, to make ADC clock = 8,000,000/64 = 125kHz
|
||
97 | ADCSRA = 0;
|
||
98 | 1378 | jykong | ADCSRA |= _BV(ADEN) | _BV(ADPS2) | _BV(ADPS1) | _BV(ADPS0); |
99 | 338 | bcoltin | |
100 | // Set external mux lines to outputs
|
||
101 | DDRG |= 0x1C;
|
||
102 | |||
103 | // Set up first port for conversions
|
||
104 | set_adc_mux(0x00);
|
||
105 | adc_current_port = AN1; |
||
106 | |||
107 | //Start the conversion if requested
|
||
108 | if (start_conversion)
|
||
109 | analog_start_loop(); |
||
110 | else
|
||
111 | analog_stop_loop(); |
||
112 | } |
||
113 | |||
114 | 862 | kwoo | /**
|
115 | * Returns the 8-bit analog conversion of which from
|
||
116 | * the lookup table. If the requested port is the BOM_PORT
|
||
117 | * you will get an automatic 0 since the BOM_PORT is not
|
||
118 | * read in the loop and not stored. If you need that port
|
||
119 | * you should use the functions in bom.c. There is an analog_get8
|
||
120 | * function which for instant lookups but should be avoided unless
|
||
121 | * you know what you're doing.
|
||
122 | *
|
||
123 | * @param which the port that you want to read
|
||
124 | *
|
||
125 | * @bug may cause a seg fault if which is a larger value
|
||
126 | * than exists in an_val table. Not sure if we should fix
|
||
127 | * this or not since it would add overhead.
|
||
128 | *
|
||
129 | * @return 8-bit analog value for the which port requested
|
||
130 | *
|
||
131 | * @see analog10, analog_get8, analog_get10
|
||
132 | **/
|
||
133 | 338 | bcoltin | unsigned int analog8(int which) { |
134 | if (which == BOM_PORT) {
|
||
135 | return 0; |
||
136 | } else {
|
||
137 | return an_val[which - 1].adc8; |
||
138 | } |
||
139 | } |
||
140 | |||
141 | 437 | kwoo | /**
|
142 | * Returns the 10-bit analog conversion of which from
|
||
143 | * the lookup table. If the requested port is the BOM_PORT
|
||
144 | * you will get an automatic 0 since the BOM_PORT is not
|
||
145 | * read in the loop and not stored. If you need that port
|
||
146 | * you should use the functions in bom.c. There is an analog_get10
|
||
147 | 862 | kwoo | * function which for instant lookups but should be avoided unless
|
148 | * you know what you are doing.
|
||
149 | 437 | kwoo | *
|
150 | * @param which the port that you want to read
|
||
151 | *
|
||
152 | * @bug may cause a seg fault if which is a larger value
|
||
153 | * than exists in an_val table. Not sure if we should fix
|
||
154 | * this or not since it would add overhead.
|
||
155 | *
|
||
156 | * @return 10-bit analog value for the which port requested
|
||
157 | *
|
||
158 | * @see analog8, analog_get8, analog_get10
|
||
159 | **/
|
||
160 | 338 | bcoltin | unsigned int analog10(int which) { |
161 | if (which == BOM_PORT) {
|
||
162 | return 0; |
||
163 | } else {
|
||
164 | return an_val[which - 1].adc10; |
||
165 | } |
||
166 | } |
||
167 | |||
168 | 437 | kwoo | /**
|
169 | * Starts the analog update loop. Will continue to run
|
||
170 | * until analog_stop_loop is called.
|
||
171 | *
|
||
172 | 1378 | jykong | * @see analog_stop_loop, analog_loop_running
|
173 | 437 | kwoo | **/
|
174 | 338 | bcoltin | void analog_start_loop(void) { |
175 | 1378 | jykong | //Start the conversion, enable ADC interrupt
|
176 | ADCSRA |= _BV(ADSC) | _BV(ADIE); |
||
177 | 338 | bcoltin | adc_loop_running = 0x1;
|
178 | } |
||
179 | |||
180 | 437 | kwoo | /**
|
181 | * Stops the analog update loop. If there is a current
|
||
182 | * read, it will finish up and be stored before the loop
|
||
183 | * is interrupted. No further updates will be made until
|
||
184 | * the loop is started again.
|
||
185 | *
|
||
186 | 1378 | jykong | * @param Whether or not to block until current conversion
|
187 | * to complete. Use WAIT_UNTIL_FINISHED or
|
||
188 | * SKIP_WAIT.
|
||
189 | *
|
||
190 | * @see analog_start_loop, analog_loop_running
|
||
191 | 437 | kwoo | **/
|
192 | 1378 | jykong | void analog_stop_loop(int skip_wait) { |
193 | 338 | bcoltin | //Stop the conversion
|
194 | adc_loop_running = 0x0;
|
||
195 | 1378 | jykong | |
196 | if(skip_wait) {
|
||
197 | //Stop the interrupt
|
||
198 | ADCSRA &= _BV(ADIE); |
||
199 | return;
|
||
200 | } |
||
201 | |||
202 | //Wait for the ADC interrupt flag to clear / conversion to complete
|
||
203 | while(ADCSRA & _BV(ADIF));
|
||
204 | //Stop the interrupt
|
||
205 | ADCSRA &= _BV(ADIE); |
||
206 | 338 | bcoltin | } |
207 | 1378 | jykong | |
208 | 338 | bcoltin | /**
|
209 | 1378 | jykong | * Returns the status of loop. 1 for running.
|
210 | * 0 for not running.
|
||
211 | *
|
||
212 | * @see analog_start_loop, analog_stop_loop
|
||
213 | **/
|
||
214 | int analog_loop_running(void) { |
||
215 | return adc_loop_running;
|
||
216 | } |
||
217 | |||
218 | /**
|
||
219 | 862 | kwoo | * Reads an 8-bit number from an analog port.
|
220 | 338 | bcoltin | * analog_init must be called before using this function.
|
221 | 862 | kwoo | * The analog loop must also be stopped before using this
|
222 | * function or you will mess up the lookup table. You
|
||
223 | * must also reenabled the loop when you are done unless
|
||
224 | * you are doing more instant reads. See analog_stop_loop
|
||
225 | * and analog_start_loop for more information about the loop.
|
||
226 | 338 | bcoltin | *
|
227 | * @param which the analog port to read from. One of
|
||
228 | * the constants AN0 - AN7.
|
||
229 | *
|
||
230 | 862 | kwoo | * @return the 8-bit input to the specified port
|
231 | 338 | bcoltin | *
|
232 | 862 | kwoo | * @see analog_init, analog_get10, analog8, analog_stop_loop,
|
233 | * analog_start_loop
|
||
234 | 338 | bcoltin | **/
|
235 | 439 | kwoo | unsigned int analog_get8(int which) { |
236 | 338 | bcoltin | // Let any previous conversion finish
|
237 | while (ADCSRA & _BV(ADSC));
|
||
238 | |||
239 | if(which < EXT_MUX) {
|
||
240 | ADMUX = ADMUX_OPT + which; |
||
241 | } else {
|
||
242 | ADMUX = ADMUX_OPT + EXT_MUX; |
||
243 | set_adc_mux(which - 8);
|
||
244 | } |
||
245 | |||
246 | // Start the conversion
|
||
247 | ADCSRA |= _BV(ADSC); |
||
248 | |||
249 | // Wait for the conversion to finish
|
||
250 | while (ADCSRA & _BV(ADSC));
|
||
251 | |||
252 | return ADCH; //since we left aligned the data, ADCH is the 8 MSB. |
||
253 | } |
||
254 | |||
255 | /**
|
||
256 | 862 | kwoo | * Reads an 10-bit number from an analog port.
|
257 | 338 | bcoltin | * analog_init must be called before using this function.
|
258 | 862 | kwoo | * The analog loop must also be stopped before using this
|
259 | * function or you will mess up the lookup table. You
|
||
260 | * must also reenabled the loop when you are done unless
|
||
261 | * you are doing more instant reads. See analog_stop_loop
|
||
262 | * and analog_start_loop for more information about the loop.
|
||
263 | 338 | bcoltin | *
|
264 | *
|
||
265 | * @param which the analog port to read from. Typically
|
||
266 | * a constant, one of AN0 - AN7.
|
||
267 | *
|
||
268 | 862 | kwoo | * @return the 10-bit number input to the specified port
|
269 | 338 | bcoltin | *
|
270 | 862 | kwoo | * @see analog_init, analog_get8, analog10, analog_stop_loop,
|
271 | * analog_start_loop
|
||
272 | 338 | bcoltin | **/
|
273 | 439 | kwoo | unsigned int analog_get10(int which) { |
274 | 338 | bcoltin | int adc_h;
|
275 | int adc_l;
|
||
276 | |||
277 | // Let any previous conversion finish
|
||
278 | while (ADCSRA & _BV(ADSC));
|
||
279 | |||
280 | if(which < EXT_MUX) {
|
||
281 | ADMUX = ADMUX_OPT + which; |
||
282 | } else {
|
||
283 | ADMUX = ADMUX_OPT + EXT_MUX; |
||
284 | set_adc_mux(which - 8);
|
||
285 | } |
||
286 | |||
287 | // Start the conversion
|
||
288 | ADCSRA |= _BV(ADSC); |
||
289 | |||
290 | // Wait for the conversion to finish
|
||
291 | while (ADCSRA & _BV(ADSC));
|
||
292 | |||
293 | adc_l = ADCL; |
||
294 | adc_h = ADCH; |
||
295 | |||
296 | return ((adc_h << 2) | (adc_l >> 6)); |
||
297 | } |
||
298 | |||
299 | /**
|
||
300 | * Returns the current position of the wheel, as an integer
|
||
301 | * in the range 0 - 255.
|
||
302 | * analog_init must be called before using this function.
|
||
303 | *
|
||
304 | * @return the orientation of the wheel, as an integer in
|
||
305 | * the range 0 - 255.
|
||
306 | *
|
||
307 | * @see analog_init
|
||
308 | **/
|
||
309 | 439 | kwoo | int wheel(void) { |
310 | 338 | bcoltin | return analog8(WHEEL_PORT);
|
311 | } |
||
312 | |||
313 | |||
314 | /**
|
||
315 | * Sets the value of the external analog mux. Values are read
|
||
316 | * on AN7 physical port. (AN8 - AN15 are "virtual" ports).
|
||
317 | *
|
||
318 | * @param which which analog mux port (0-7) which corresponds
|
||
319 | * to AN8-AN15.
|
||
320 | *
|
||
321 | * @bug FIX THIS IN THE NEXT BOARD REVISION:
|
||
322 | * ADDR2 ADDR1 ADDR0
|
||
323 | * G2.G4.G3 set mux to port 0-7 via vinary selection
|
||
324 | * math would be much cleaner if it was G4.G3.G2
|
||
325 | *
|
||
326 | * @see analog_init
|
||
327 | **/
|
||
328 | 439 | kwoo | void set_adc_mux(int which) { |
329 | 338 | bcoltin | // mask so only proper bits are possible.
|
330 | PORTG = (PORTG & 0xE3) | ((which & 0x03) << 3) | (which & 0x04); |
||
331 | } |
||
332 | |||
333 | /**@}**/ //end defgroup |
||
334 | |||
335 | |||
336 | ISR(ADC_vect) { |
||
337 | 437 | kwoo | static volatile int adc_prev_loop_running = 0; |
338 | 338 | bcoltin | int adc_h = 0; |
339 | int adc_l = 0; |
||
340 | |||
341 | //Store the value only if this read isn't for the BOM
|
||
342 | if (ADMUX != BOM_PORT) {
|
||
343 | adc_l = ADCL; |
||
344 | adc_h = ADCH; |
||
345 | |||
346 | an_val[adc_current_port - 1].adc10 = (adc_h << 2) | (adc_l >> 6); |
||
347 | an_val[adc_current_port - 1].adc8 = adc_h;
|
||
348 | } |
||
349 | |||
350 | //Save the result only if we just turned off the loop
|
||
351 | if (!adc_loop_running && !adc_prev_loop_running)
|
||
352 | return;
|
||
353 | |||
354 | adc_prev_loop_running = adc_loop_running; |
||
355 | |||
356 | //Skip AN7 because it is not a real port
|
||
357 | if (adc_current_port == AN6) {
|
||
358 | ADMUX = ADMUX_OPT | EXT_MUX; |
||
359 | set_adc_mux(AN8 - 8);
|
||
360 | adc_current_port = AN8; |
||
361 | //Wrap around
|
||
362 | } else if (adc_current_port == AN11) { |
||
363 | adc_current_port = AN1; |
||
364 | ADMUX = ADMUX_OPT | adc_current_port; |
||
365 | //Normal increment
|
||
366 | } else {
|
||
367 | adc_current_port++; |
||
368 | |||
369 | if(adc_current_port < EXT_MUX) {
|
||
370 | ADMUX = ADMUX_OPT | adc_current_port; |
||
371 | } else {
|
||
372 | ADMUX = ADMUX_OPT | EXT_MUX; |
||
373 | set_adc_mux(adc_current_port - 8);
|
||
374 | } |
||
375 | } |
||
376 | |||
377 | //Initiate next conversion only if we are running a loop
|
||
378 | 437 | kwoo | if (!adc_loop_running) {
|
379 | 338 | bcoltin | return;
|
380 | 437 | kwoo | } else {
|
381 | ADCSRA |= _BV(ADSC); |
||
382 | } |
||
383 | 338 | bcoltin | |
384 | return;
|
||
385 | } |