hw/mcu/atmel/samd21xx/include/mcu/hal_adc.h

/**
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *  http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */

#ifndef _SAMD21_HAL_ADC_H
#define _SAMD21_HAL_ADC_H

/* this structure is passed to the BSP for configuration options */
enum samd_adc_reference_voltage {
    SAMD21_ADC_REFERENCE_INT1V,
    SAMD21_ADC_REFERENCE_INTVCC0,
    SAMD21_ADC_REFERENCE_INTVCC1,
    SAMD21_ADC_REFERENCE_AREFA,
    SAMD21_ADC_REFERENCE_AREFB,
};

enum samd_adc_analog_channel {
    SAMD21_ANALOG_0 = 0,
    SAMD21_ANALOG_1,
    SAMD21_ANALOG_2,
    SAMD21_ANALOG_3,
    SAMD21_ANALOG_4,
    SAMD21_ANALOG_5,
    SAMD21_ANALOG_6,
    SAMD21_ANALOG_7,
    SAMD21_ANALOG_8,
    SAMD21_ANALOG_9,
    SAMD21_ANALOG_10,
    SAMD21_ANALOG_11,
    SAMD21_ANALOG_12,
    SAMD21_ANALOG_13,
    SAMD21_ANALOG_14,
    SAMD21_ANALOG_15,
    SAMD21_ANALOG_16,
    SAMD21_ANALOG_17,
    SAMD21_ANALOG_18,
    SAMD21_ANALOG_19,
    SAMD21_ANALOG_TEMP,
    SAMD21_ANALOG_BANDGAP,
    SAMD21_ANALOG_SCALEDCOREVCC,
    SAMD21_ANALOG_SCALEDIOVCC,
    SAMD21_ANALOG_ADC_DAC,  
    SAMD21_ANALOG_MAX,
};

enum samd_adc_resolution {
    SAMD21_RESOLUTION_8_BITS,
    SAMD21_RESOLUTION_10_BITS,
    SAMD21_RESOLUTION_12_BITS,
};

enum samd_adc_gain {
    SAMD21_GAIN_DIV2,
    SAMD21_GAIN_1X,
    SAMD21_GAIN_2X,
    SAMD21_GAIN_4X,
    SAMD21_GAIN_8X,
    SAMD21_GAIN_16X,
};

struct samd21_adc_config {
    enum samd_adc_reference_voltage volt;
    enum samd_adc_resolution resolution_bits;
    enum samd_adc_gain gain;
    int voltage_mvolts;
};

/* This creates a new ADC object for this ADC source */
struct hal_adc *samd21_adc_create(enum samd_adc_analog_channel chan,
                                  const struct samd21_adc_config *pconfig);


#endif /* _SAMD21_HAL_ADC_H */