circuitpython/ports/atmel-samd/common-hal/analogio/AnalogIn.c

/*
 * This file is part of the MicroPython project, http://micropython.org/
 *
 * The MIT License (MIT)
 *
 * Copyright (c) 2016 Scott Shawcroft for Adafruit Industries
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */

#include "common-hal/analogio/AnalogIn.h"

#include <string.h>

#include "py/gc.h"
#include "py/nlr.h"
#include "py/runtime.h"
#include "py/binary.h"
#include "py/mphal.h"
#include "shared-bindings/analogio/AnalogIn.h"

#include "asf/sam0/drivers/adc/adc.h"
#include "samd21_pins.h"

void common_hal_analogio_analogin_construct(analogio_analogin_obj_t* self,
        const mcu_pin_obj_t *pin) {
    if (!pin->has_adc) {
        // No ADC function on that pin
        mp_raise_ValueError("Pin does not have ADC capabilities");
    }
    claim_pin(pin);

    self->pin = pin;
}

bool common_hal_analogio_analogin_deinited(analogio_analogin_obj_t *self) {
    return self->pin == mp_const_none;
}

void common_hal_analogio_analogin_deinit(analogio_analogin_obj_t *self) {
    if (common_hal_analogio_analogin_deinited(self)) {
        return;
    }
    reset_pin(self->pin->pin);
    self->pin = mp_const_none;
}

void analogin_reset() {
}

uint16_t common_hal_analogio_analogin_get_value(analogio_analogin_obj_t *self) {
    // Something else might have used the ADC in a different way,
    // so we completely re-initialize it.

    struct adc_config config_adc;
    adc_get_config_defaults(&config_adc);

    config_adc.reference = ADC_REFERENCE_INTVCC1;
    config_adc.gain_factor = ADC_GAIN_FACTOR_DIV2;
    config_adc.positive_input = self->pin->adc_input;
    config_adc.resolution = ADC_RESOLUTION_12BIT;
    // Default input clock is GCLK0 (48 MHz)
    // 48Mhz / 32 = 1.5MHz. Max ADC clock is 2.1MHz
    config_adc.clock_prescaler = ADC_CLOCK_PRESCALER_DIV32;

    struct adc_module adc_instance;
    // ADC must have been disabled before adc_init() is called.
    adc_init(&adc_instance, ADC, &config_adc);
    adc_enable(&adc_instance);

    // Read twice and discard first result, as recommended in section 14 of
    // http://www.atmel.com/images/Atmel-42645-ADC-Configurations-with-Examples_ApplicationNote_AT11481.pdf
    // "Discard the first conversion result whenever there is a change in ADC configuration
    // like voltage reference / ADC channel change"
    // Empirical observation shows the first reading is quite different than subsequent ones.

    uint16_t data;
    enum status_code status;

    adc_start_conversion(&adc_instance);
    do {
      status = adc_read(&adc_instance, &data);
    }  while (status == STATUS_BUSY); 
    if (status == STATUS_ERR_OVERFLOW) {
        mp_raise_RuntimeError("ADC result overwritten before reading");
    }

    adc_start_conversion(&adc_instance);
    do {
        status = adc_read(&adc_instance, &data);
    } while (status == STATUS_BUSY);
    if (status == STATUS_ERR_OVERFLOW) {
        mp_raise_RuntimeError("ADC result overwritten before reading");
    }

    adc_disable(&adc_instance);
    // Scale to 16 bits. In the future we might make this be this be under API control.
    return data * 16;
}

float common_hal_analogio_analogin_get_reference_voltage(analogio_analogin_obj_t *self) {
    return 3.3f;
}