git.rot13.org Git - simavr/blob - simavr/sim/avr_adc.h

   1 /*
   2         avr_adc.h
   3
   4         Copyright 2008, 2009 Michel Pollet <buserror@gmail.com>
   5
   6         This file is part of simavr.
   7
   8         simavr is free software: you can redistribute it and/or modify
   9         it under the terms of the GNU General Public License as published by
  10         the Free Software Foundation, either version 3 of the License, or
  11         (at your option) any later version.
  12
  13         simavr is distributed in the hope that it will be useful,
  14         but WITHOUT ANY WARRANTY; without even the implied warranty of
  15         MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16         GNU General Public License for more details.
  17
  18         You should have received a copy of the GNU General Public License
  19         along with simavr.  If not, see <http://www.gnu.org/licenses/>.
  20  */
  21
  22 #ifndef __AVR_ADC_H___
  23 #define __AVR_ADC_H___
  24
  25 #ifdef __cplusplus
  26 extern "C" {
  27 #endif
  28
  29 #include "sim_avr.h"
  30
  31 /*
  32  * simavr ADC allows external code to feed real voltages to the
  33  * simulator, and the simulator uses it's 'real' reference voltage
  34  * to do the right thing and return the 'proper' 10 bits ADC value
  35  * to the AVR firmware.
  36  *
  37  * To send values to the ADC, register your code to wait for the
  38  * ADC_IRQ_OUT_TRIGGER irq, and at that point send any of the
  39  * ADC_IRQ_ADC* with Millivolts as value.
  40  *
  41  * External trigger is not done yet.
  42  */
  43
  44 enum {
  45         // input IRQ values. Values are /always/ volts * 1000 (millivolts)
  46         ADC_IRQ_ADC0 = 0, ADC_IRQ_ADC1, ADC_IRQ_ADC2, ADC_IRQ_ADC3,
  47         ADC_IRQ_ADC4, ADC_IRQ_ADC5, ADC_IRQ_ADC6, ADC_IRQ_ADC7,
  48         ADC_IRQ_ADC8, ADC_IRQ_ADC9, ADC_IRQ_ADC10, ADC_IRQ_ADC11,
  49         ADC_IRQ_ADC12, ADC_IRQ_ADC13, ADC_IRQ_ADC14, ADC_IRQ_ADC15,
  50         ADC_IRQ_TEMP,                   // see the datasheet
  51         ADC_IRQ_IN_TRIGGER,
  52         ADC_IRQ_OUT_TRIGGER,    // sends a avr_adc_mux_t
  53         ADC_IRQ_COUNT
  54 };
  55
  56 // Get the internal IRQ corresponding to the INT
  57 #define AVR_IOCTL_ADC_GETIRQ AVR_IOCTL_DEF('a','d','c',' ')
  58
  59 /*
  60  * Definition of a ADC mux mode.
  61  */
  62 enum {
  63         ADC_MUX_NONE = 0,               // Nothing. return 0
  64         ADC_MUX_NOISE,                  // Nothing. return something random
  65         ADC_MUX_SINGLE,                 // Normal ADC pin reading
  66         ADC_MUX_DIFF,                   // differential channels (src-diff)
  67         ADC_MUX_TEMP,                   // internal temp sensor
  68         ADC_MUX_REF,                    // reference voltage (in src * 100)
  69         ADC_MUX_VCC4,                   // VCC/4
  70 };
  71 typedef struct avr_adc_mux_t {
  72         unsigned long kind : 3, gain : 8, diff : 8, src : 13;
  73 } avr_adc_mux_t;
  74
  75 enum {
  76         ADC_VREF_AREF   = 0,    // default mode
  77         ADC_VREF_VCC,
  78         ADC_VREF_AVCC,
  79         ADC_VREF_V110   = 1100,
  80         ADC_VREF_V256   = 2560,
  81 };
  82
  83 typedef struct avr_adc_t {
  84         avr_io_t                io;
  85
  86         uint8_t                 r_admux;
  87         // if the last bit exists in the mux, we are an extended ADC
  88         avr_regbit_t    mux[6];
  89         avr_regbit_t    ref[3];         // reference voltages bits
  90         uint16_t                ref_values[7]; // ADC_VREF_*
  91
  92         avr_regbit_t    adlar;          // left/right adjustment bit
  93
  94         uint8_t                 r_adcsra;       // ADC Control and Status Register A
  95         avr_regbit_t    aden;           // ADC Enabled
  96         avr_regbit_t    adsc;           // ADC Start Conversion
  97         avr_regbit_t    adate;          // ADC Auto Trigger Enable
  98
  99         avr_regbit_t    adps[3];        // Prescaler bits. Note that it's a frequency bit shift
 100
 101         uint8_t                 r_adcl, r_adch; // Data Registers
 102
 103         uint8_t                 r_adcsrb;       // ADC Control and Status Register B
 104         avr_regbit_t    adts[3];        // Timing Source
 105         avr_regbit_t    bin;            // Bipolar Input Mode (tinyx5 have it)
 106         avr_regbit_t    ipr;            // Input Polarity Reversal (tinyx5 have it)
 107
 108         // use ADIF and ADIE bits
 109         avr_int_vector_t adc;
 110
 111         /*
 112          * runtime bits
 113          */
 114         avr_adc_mux_t   muxmode[64];// maximum 6 bits of mux modes
 115         uint16_t                adc_values[8];  // current values on the ADCs
 116         uint16_t                temp;           // temp sensor reading
 117         uint8_t                 first;
 118         uint8_t                 read_status;    // marked one when adcl is read
 119 } avr_adc_t;
 120
 121 void avr_adc_init(avr_t * avr, avr_adc_t * port);
 122
 123
 124 /*
 125  * Helper macros for the Cores definition of muxes
 126  */
 127 #define AVR_ADC_SINGLE(_chan) { \
 128                 .kind = ADC_MUX_SINGLE, \
 129                 .src = (_chan), \
 130         }
 131 #define AVR_ADC_DIFF(_a,_b,_g) { \
 132                 .kind = ADC_MUX_DIFF, \
 133                 .src = (_a), \
 134                 .diff = (_b), \
 135                 .gain = (_g), \
 136         }
 137 #define AVR_ADC_REF(_t) { \
 138                 .kind = ADC_MUX_REF, \
 139                 .src = (_t), \
 140         }
 141 #define AVR_ADC_TEMP() { \
 142                 .kind = ADC_MUX_TEMP, \
 143         }
 144
 145 #define AVR_ADC_VCC4() { \
 146                 .kind = ADC_MUX_VCC4, \
 147         }
 148
 149 #ifdef __cplusplus
 150 };
 151 #endif
 152
 153 #endif /* __AVR_ADC_H___ */