avr_adc.h

Go to the documentation of this file.

/*
 * avr_adc.h
 *
 * Copyright 2008, 2009 Michel Pollet <buserror@gmail.com>
 *
 * This file is part of simavr.
 *
 * simavr is free software: you can redistribute it and/or modify it under the terms of the GNU
 * General Public License as published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 *
 * simavr is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even
 * the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General
 * Public License for more details.
 *
 * You should have received a copy of the GNU General Public License along with simavr.  If not, see
 * <http://www.gnu.org/licenses/>.
 */

#ifndef __AVR_ADC_H___
#define __AVR_ADC_H___

#ifdef __cplusplus
extern "C"
{
#endif

#include "sim_avr.h"

  enum
    {
      ADC_IRQ_ADC0 = 0, ADC_IRQ_ADC1, ADC_IRQ_ADC2, ADC_IRQ_ADC3,
      ADC_IRQ_ADC4, ADC_IRQ_ADC5, ADC_IRQ_ADC6, ADC_IRQ_ADC7,
      ADC_IRQ_ADC8, ADC_IRQ_ADC9, ADC_IRQ_ADC10, ADC_IRQ_ADC11,
      ADC_IRQ_ADC12, ADC_IRQ_ADC13, ADC_IRQ_ADC14, ADC_IRQ_ADC15,
      ADC_IRQ_TEMP,   // see the datasheet
      ADC_IRQ_IN_TRIGGER,
      ADC_IRQ_OUT_TRIGGER,   
      ADC_IRQ_COUNT
    };

#define AVR_IOCTL_ADC_GETIRQ AVR_IOCTL_DEF('a','d','c',' ')

  enum
    {
      ADC_MUX_NONE = 0,   
      ADC_MUX_NOISE,   
      ADC_MUX_SINGLE,   
      ADC_MUX_DIFF,   
      ADC_MUX_TEMP,   
      ADC_MUX_REF,   
      ADC_MUX_VCC4,   
    };

  typedef struct avr_adc_mux_t
  {
    unsigned long kind:3, gain:8, diff:8, src:13;
  } avr_adc_mux_t;

  enum
    {
      ADC_VREF_AREF = 0,   
      ADC_VREF_VCC,
      ADC_VREF_AVCC,
      ADC_VREF_V110 = 1100,
      ADC_VREF_V256 = 2560,
    };

  typedef enum
    {
      avr_adts_none = 0,
      avr_adts_free_running,
      avr_adts_analog_comparator_0,
      avr_adts_analog_comparator_1,
      avr_adts_analog_comparator_2,
      avr_adts_analog_comparator_3,
      avr_adts_external_interrupt_0,
      avr_adts_timer_0_compare_match_a,
      avr_adts_timer_0_compare_match_b,
      avr_adts_timer_0_overflow,
      avr_adts_timer_1_compare_match_b,
      avr_adts_timer_1_overflow,
      avr_adts_timer_1_capture_event,
      avr_adts_pin_change_interrupt,
      avr_adts_psc_module_0_sync_signal,
      avr_adts_psc_module_1_sync_signal,
      avr_adts_psc_module_2_sync_signal,
    } avr_adts_type;

  typedef struct avr_adc_t
  {
    avr_io_t io;

    uint8_t r_admux;
    // if the last bit exists in the mux, we are an extended ADC
    avr_regbit_t mux[6];
    avr_regbit_t ref[3];    
    uint16_t ref_values[7];    

    avr_regbit_t adlar;    

    uint8_t r_adcsra;    
    avr_regbit_t aden;    
    avr_regbit_t adsc;    
    avr_regbit_t adate;    

    avr_regbit_t adps[3];    

    uint8_t r_adcl, r_adch;    

    uint8_t r_adcsrb;    
    avr_regbit_t adts[4];    
    avr_adts_type adts_op[16];    
    uint8_t adts_mode;    
    avr_regbit_t bin;    
    avr_regbit_t ipr;    

    avr_int_vector_t adc;

    /*
     * runtime bits
     */
    avr_adc_mux_t muxmode[64];    
    uint16_t adc_values[8];    
    uint16_t temp;    
    uint8_t first;
    uint8_t read_status;    
  } avr_adc_t;

  void avr_adc_init (avr_t * avr, avr_adc_t * port);

  /*
   * Helper macros for the Cores definition of muxes
   */
#define AVR_ADC_SINGLE(_chan) {         \
    .kind = ADC_MUX_SINGLE,         \
      .src = (_chan),               \
      }

#define AVR_ADC_DIFF(_a,_b,_g) {        \
    .kind = ADC_MUX_DIFF,           \
      .src = (_a),              \
      .diff = (_b),             \
      .gain = (_g),             \
      }

#define AVR_ADC_REF(_t) {           \
    .kind = ADC_MUX_REF,            \
      .src = (_t),              \
      }

#define AVR_ADC_TEMP() {            \
    .kind = ADC_MUX_TEMP,           \
      }

#define AVR_ADC_VCC4() {            \
    .kind = ADC_MUX_VCC4,           \
      }

#ifdef __cplusplus
};
#endif

#endif /* __AVR_ADC_H___ */