Statistics
| Revision:

root / trunk / code / projects / libdragonfly / analog.c @ 1862

History | View | Annotate | Download (10.3 KB)

1
/**
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
 * originally taken from fwr analog file (author: Tom Lauwers)
34
 * loop code written by Kevin Woo and James Kong
35
 **/
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
volatile int adc_loop_status = ADC_LOOP_STOPPED;
53
volatile int adc_sig_stop_loop = 0;
54
volatile int adc_current_port = 0;
55
volatile adc_t an_val[11];
56

    
57
/**
58
 * Initializes the ADC.
59
 * Call analog_init before reading from the analog ports.
60
 *
61
 * @see analog8, analog10, analog_get8, analog_get10
62
 *
63
 * @bug First conversion takes a performance penalty of
64
 * 25 vs. 13 ADC clock cycles of successive conversions.
65
 * Analog_init should run a dummy conversion to pre-empt
66
 * this.
67
 *
68
 * For good 10-bit precision, ACD clock must be between
69
 * 50kHz and 200kHz. Currently, ADC clock is fixed at
70
 * 125kHz using 1/64prescalar. However, most code uses
71
 * 8-bit precision which can work at ADC clock speeds
72
 * higher than 200kHz. Experimental tests needed to
73
 * determine highest clock speed for accurate 8-bit ADC.
74
 *
75
 **/
76
void analog_init(int start_conversion) {
77
        start_conversion=0;                   //forces the analog loop off
78
        for (int i = 0; i < 11; i++) {
79
                an_val[i].adc10 = 0;
80
                an_val[i].adc8 = 0;
81
        }
82

    
83
        // ADMUX register
84
        // Bit 7,6 - Set voltage reference to AVcc (0b01)
85
        // Bit 5 - ADLAR set to simplify moving from register
86
        // Bit 4 - X
87
        // Bit 3:0 - Sets the current channel
88
        // Initializes to read from AN1 first (AN0 is reservered for the BOM)
89
        ADMUX = 0;
90
        ADMUX |= ADMUX_OPT | _BV(MUX0);
91

    
92
        // ADC Status Register A
93
        // Bit 7 - ADEN is set (enables analog)
94
        // Bit 6 - Start conversion bit is set (must be done once for free-running mode)
95
        // Bit 5 - Enable Auto Trigger (for free running mode) NOT DOING THIS RIGHT NOW
96
        // Bit 4 - ADC interrupt flag, 0
97
        // Bit 3 - Enable ADC Interrupt (required to run free-running mode)
98
        // Bits 2-0 - Set to create a clock divisor of 2, to make ADC clock != 8,000,000/64 = 125kHz (it runs at highest frequency)
99
        ADCSRA = 0;
100
        ADCSRA |= _BV(ADEN) | /*_BV(ADPS2) | _BV(ADPS1) |*/ _BV(ADPS0);
101
        
102
        // Set external mux lines to outputs
103
        DDRG |= 0x1C;
104
        
105
        // Set up first port for conversions
106
        set_adc_mux(0x00);
107
        adc_current_port = AN1;
108

    
109
        //Start the conversion loop if requested
110
        if (start_conversion)
111
                analog_start_loop();
112
                
113
        //Conversion loop disabled by default
114
}        
115

    
116
/**
117
 * Returns the 8-bit analog conversion of which from
118
 * the lookup table. If the requested port is the BOM_PORT
119
 * you will get an automatic 0 since the BOM_PORT is not
120
 * read in the loop and not stored. If you need that port
121
 * you should use the functions in bom.c. There is an analog_get8
122
 * function which for instant lookups but should be avoided unless
123
 * you know what you're doing.
124
 *
125
 * @param which the port that you want to read
126
 *
127
 * @bug may cause a seg fault if which is a larger value
128
 * than exists in an_val table. Not sure if we should fix
129
 * this or not since it would add overhead.
130
 *
131
 * @return 8-bit analog value for the which port requested
132
 *
133
 * @see analog10, analog_get8, analog_get10
134
 **/
135
unsigned int analog8(int which) {
136
/*        if (which == BOM_PORT) {
137
                return 0;
138
        } else {
139
                return an_val[which - 1].adc8;
140
        }
141
*/
142
return analog_get8(which);
143
}
144

    
145
/**
146
 * Returns the 10-bit analog conversion of which from
147
 * the lookup table. If the requested port is the BOM_PORT
148
 * you will get an automatic 0 since the BOM_PORT is not
149
 * read in the loop and not stored. If you need that port
150
 * you should use the functions in bom.c. There is an analog_get10
151
 * function which for instant lookups but should be avoided unless
152
 * you know what you are doing.
153
 *
154
 * @param which the port that you want to read
155
 *
156
 * @bug may cause a seg fault if which is a larger value
157
 * than exists in an_val table. Not sure if we should fix
158
 * this or not since it would add overhead.
159
 *
160
 * @return 10-bit analog value for the which port requested
161
 *
162
 * @see analog8, analog_get8, analog_get10
163
 **/
164
unsigned int analog10(int which) {
165
/*        if (which == BOM_PORT) {
166
                return 0;
167
        } else {
168
                return an_val[which - 1].adc10;
169
        }
170
*/
171
return analog_get10(which);
172
}
173

    
174
/**
175
 * Starts the analog update loop. Will continue to run
176
 * until analog_stop_loop is called.
177
 *
178
 * @see analog_stop_loop, analog_loop_status
179
 **/
180
void analog_start_loop(void) {
181
        if(adc_loop_status != ADC_LOOP_RUNNING){
182
                //Start the conversion, enable ADC interrupt
183
                ADCSRA |= _BV(ADIE);
184
                ADCSRA |= _BV(ADSC);
185
                adc_loop_status = ADC_LOOP_RUNNING;
186
        }
187
}
188

    
189
/**
190
 * Stops the analog update loop. If there is a current
191
 * read, it will finish up and be stored before the loop
192
 * is interrupted. No further updates will be made until
193
 * the loop is started again.
194
 *
195
 * @see analog_start_loop, analog_loop_status
196
 **/
197
void analog_stop_loop() {
198
        //Signal to stop after the next conversion
199
        adc_sig_stop_loop = 1;
200
}
201

    
202
/**
203
 * Returns the status of loop. 0 for stopped.
204
 * 1 for running. 2 for paused.
205
 *
206
 * @see analog_start_loop, analog_stop_loop
207
 **/
208
int analog_loop_status(void) {
209
        return adc_loop_status;
210
}
211

    
212
/**
213
 * Reads an 8-bit number from an analog port.
214
 * analog_init must be called before using this function.
215
 * The analog loop must also be stopped before using this
216
 * function or you will mess up the lookup table. You
217
 * must also reenabled the loop when you are done unless
218
 * you are doing more instant reads. See analog_stop_loop
219
 * and analog_start_loop for more information about the loop.
220
 * 
221
 * @param which the analog port to read from. One of
222
 * the constants AN0 - AN7.
223
 *
224
 * @return the 8-bit input to the specified port
225
 *
226
 * @see analog_init, analog_get10, analog8, analog_stop_loop,
227
 * analog_start_loop
228
 **/
229
unsigned int analog_get8(int which) {        
230
        // Let any previous conversion finish
231
        while (ADCSRA & _BV(ADSC));
232
        
233
        if(which < EXT_MUX) {
234
                ADMUX = ADMUX_OPT + which;
235
        } else {
236
                ADMUX = ADMUX_OPT + EXT_MUX;
237
                set_adc_mux(which - 8);
238
        }
239
        
240
        // Start the conversion
241
        ADCSRA |= _BV(ADSC);
242

    
243
        // Wait for the conversion to finish
244
        while (ADCSRA & _BV(ADSC));
245

    
246
        return ADCH; //since we left aligned the data, ADCH is the 8 MSB.
247
}
248

    
249
/**
250
 * Reads an 10-bit number from an analog port.
251
 * analog_init must be called before using this function.
252
 * The analog loop must also be stopped before using this
253
 * function or you will mess up the lookup table. You
254
 * must also reenabled the loop when you are done unless
255
 * you are doing more instant reads. See analog_stop_loop
256
 * and analog_start_loop for more information about the loop.
257
 * 
258
 *
259
 * @param which the analog port to read from. Typically
260
 * a constant, one of AN0 - AN7.
261
 *
262
 * @return the 10-bit number input to the specified port
263
 * 
264
 * @see analog_init, analog_get8, analog10, analog_stop_loop,
265
 * analog_start_loop
266
 **/
267
unsigned int analog_get10(int which) {
268
        int adc_h;
269
        int adc_l;
270
        
271
        // Let any previous conversion finish
272
        while (ADCSRA & _BV(ADSC));
273

    
274
        if(which < EXT_MUX) {
275
                ADMUX = ADMUX_OPT + which;
276
        } else {
277
                ADMUX = ADMUX_OPT + EXT_MUX;
278
                set_adc_mux(which - 8);
279
        }
280
        
281
        // Start the conversion
282
        ADCSRA |= _BV(ADSC);
283

    
284
        // Wait for the conversion to finish
285
        while (ADCSRA & _BV(ADSC));
286
        
287
        adc_l = ADCL;
288
        adc_h = ADCH;
289

    
290
        return ((adc_h << 2) | (adc_l >> 6));
291
}
292

    
293
/**
294
 * Returns the current position of the wheel, as an integer
295
 * in the range 0 - 255.
296
 * analog_init must be called before using this function.
297
 *
298
 * @return the orientation of the wheel, as an integer in
299
 * the range 0 - 255.
300
 *
301
 * @see analog_init
302
 **/
303
int wheel(void) {
304
        return analog8(WHEEL_PORT);
305
}
306

    
307

    
308
/**
309
 * Sets the value of the external analog mux. Values are read
310
 *         on AN7 physical port. (AN8 - AN15 are "virtual" ports).
311
 *
312
 * @param which which analog mux port (0-7) which corresponds
313
 *                   to AN8-AN15.
314
 *
315
 * @bug FIX THIS IN THE NEXT BOARD REVISION:
316
 *                ADDR2 ADDR1 ADDR0
317
 *                G2.G4.G3 set mux to port 0-7 via vinary selection
318
 *                math would be much cleaner if it was G4.G3.G2
319
 *
320
 * @see analog_init
321
 **/
322
void set_adc_mux(int which) {  
323
  // mask so only proper bits are possible.  
324
  PORTG = (PORTG & 0xE3) | ((which & 0x03) << 3) | (which & 0x04);
325
}
326

    
327
/**@}**/ //end defgroup
328

    
329

    
330
ISR(ADC_vect) {
331
        int adc_h = 0;
332
        int adc_l = 0;
333
        
334
        if(adc_loop_status != ADC_LOOP_RUNNING) return;
335

    
336
        //Store the value only if this read isn't for the BOM
337
        if (ADMUX != BOM_PORT) {
338
                adc_l = ADCL;
339
                adc_h = ADCH;
340
        
341
                an_val[adc_current_port - 1].adc10 = (adc_h << 2) | (adc_l >> 6);
342
                an_val[adc_current_port - 1].adc8 = adc_h;
343
        }
344
        
345
        //Skip AN7 because it is not a real port
346
        if (adc_current_port == AN6) {
347
                ADMUX = ADMUX_OPT | EXT_MUX;
348
                set_adc_mux(AN8 - 8);
349
                adc_current_port = AN8;
350
        //Wrap around
351
        } else if (adc_current_port == AN11) {
352
                adc_current_port = AN1;
353
                ADMUX = ADMUX_OPT | adc_current_port;
354
        //Normal increment
355
        } else {
356
                adc_current_port++;
357
        
358
                if(adc_current_port < EXT_MUX) {
359
                        ADMUX = ADMUX_OPT | adc_current_port;
360
                } else {
361
                        ADMUX = ADMUX_OPT | EXT_MUX;
362
                        set_adc_mux(adc_current_port - 8);
363
                }
364
        }
365

    
366
        //Stop loop if signal is set
367
        if(adc_sig_stop_loop) {
368
                adc_sig_stop_loop = 0;
369
                adc_loop_status = ADC_LOOP_STOPPED;
370
                return;
371
        }
372
        
373
        //Start next conversion
374
        ADCSRA |= _BV(ADSC);
375
}
376