| /* |
| * This file is part of the MicroPython project, http://micropython.org/ |
| * |
| * The MIT License (MIT) |
| * |
| * Copyright (c) 2017 Nick Moore |
| * Copyright (c) 2021 Jonathan Hogg |
| * |
| * 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. |
| */ |
| |
| // This file is never compiled standalone, it's included directly from |
| // extmod/machine_adc.c via MICROPY_PY_MACHINE_ADC_INCLUDEFILE. |
| |
| #include "py/mphal.h" |
| #include "adc.h" |
| #include "esp_adc/adc_oneshot.h" |
| |
| #define ADCBLOCK1 (&madcblock_obj[0]) |
| #define ADCBLOCK2 (&madcblock_obj[1]) |
| |
| #if SOC_ADC_RTC_MIN_BITWIDTH <= 9 && SOC_ADC_RTC_MAX_BITWIDTH >= 11 |
| #define MICROPY_PY_MACHINE_ADC_CLASS_CONSTANTS_WIDTH_9_10_11 \ |
| { MP_ROM_QSTR(MP_QSTR_WIDTH_9BIT), MP_ROM_INT(9) }, \ |
| { MP_ROM_QSTR(MP_QSTR_WIDTH_10BIT), MP_ROM_INT(10) }, \ |
| { MP_ROM_QSTR(MP_QSTR_WIDTH_11BIT), MP_ROM_INT(11) }, |
| #else |
| #define MICROPY_PY_MACHINE_ADC_CLASS_CONSTANTS_WIDTH_9_10_11 |
| #endif |
| |
| #if SOC_ADC_RTC_MIN_BITWIDTH <= 12 && SOC_ADC_RTC_MAX_BITWIDTH >= 12 |
| #define MICROPY_PY_MACHINE_ADC_CLASS_CONSTANTS_WIDTH_12 \ |
| { MP_ROM_QSTR(MP_QSTR_WIDTH_12BIT), MP_ROM_INT(12) }, |
| #else |
| #define MICROPY_PY_MACHINE_ADC_CLASS_CONSTANTS_WIDTH_12 |
| #endif |
| |
| #if SOC_ADC_RTC_MIN_BITWIDTH <= 13 && SOC_ADC_RTC_MAX_BITWIDTH >= 13 |
| #define MICROPY_PY_MACHINE_ADC_CLASS_CONSTANTS_WIDTH_13 \ |
| { MP_ROM_QSTR(MP_QSTR_WIDTH_13BIT), MP_ROM_INT(13) }, |
| #else |
| #define MICROPY_PY_MACHINE_ADC_CLASS_CONSTANTS_WIDTH_13 |
| #endif |
| |
| #define MICROPY_PY_MACHINE_ADC_CLASS_CONSTANTS \ |
| { MP_ROM_QSTR(MP_QSTR_ATTN_0DB), MP_ROM_INT(ADC_ATTEN_DB_0) }, \ |
| { MP_ROM_QSTR(MP_QSTR_ATTN_2_5DB), MP_ROM_INT(ADC_ATTEN_DB_2_5) }, \ |
| { MP_ROM_QSTR(MP_QSTR_ATTN_6DB), MP_ROM_INT(ADC_ATTEN_DB_6) }, \ |
| { MP_ROM_QSTR(MP_QSTR_ATTN_11DB), MP_ROM_INT(ADC_ATTEN_DB_11) }, \ |
| MICROPY_PY_MACHINE_ADC_CLASS_CONSTANTS_WIDTH_9_10_11 \ |
| MICROPY_PY_MACHINE_ADC_CLASS_CONSTANTS_WIDTH_12 \ |
| MICROPY_PY_MACHINE_ADC_CLASS_CONSTANTS_WIDTH_13 \ |
| |
| static const machine_adc_obj_t madc_obj[] = { |
| #if CONFIG_IDF_TARGET_ESP32 |
| {{&machine_adc_type}, ADCBLOCK1, ADC_CHANNEL_0, GPIO_NUM_36}, |
| {{&machine_adc_type}, ADCBLOCK1, ADC_CHANNEL_1, GPIO_NUM_37}, |
| {{&machine_adc_type}, ADCBLOCK1, ADC_CHANNEL_2, GPIO_NUM_38}, |
| {{&machine_adc_type}, ADCBLOCK1, ADC_CHANNEL_3, GPIO_NUM_39}, |
| {{&machine_adc_type}, ADCBLOCK1, ADC_CHANNEL_4, GPIO_NUM_32}, |
| {{&machine_adc_type}, ADCBLOCK1, ADC_CHANNEL_5, GPIO_NUM_33}, |
| {{&machine_adc_type}, ADCBLOCK1, ADC_CHANNEL_6, GPIO_NUM_34}, |
| {{&machine_adc_type}, ADCBLOCK1, ADC_CHANNEL_7, GPIO_NUM_35}, |
| {{&machine_adc_type}, ADCBLOCK2, ADC_CHANNEL_0, GPIO_NUM_4}, |
| {{&machine_adc_type}, ADCBLOCK2, ADC_CHANNEL_1, GPIO_NUM_0}, |
| {{&machine_adc_type}, ADCBLOCK2, ADC_CHANNEL_2, GPIO_NUM_2}, |
| {{&machine_adc_type}, ADCBLOCK2, ADC_CHANNEL_3, GPIO_NUM_15}, |
| {{&machine_adc_type}, ADCBLOCK2, ADC_CHANNEL_4, GPIO_NUM_13}, |
| {{&machine_adc_type}, ADCBLOCK2, ADC_CHANNEL_5, GPIO_NUM_12}, |
| {{&machine_adc_type}, ADCBLOCK2, ADC_CHANNEL_6, GPIO_NUM_14}, |
| {{&machine_adc_type}, ADCBLOCK2, ADC_CHANNEL_7, GPIO_NUM_27}, |
| {{&machine_adc_type}, ADCBLOCK2, ADC_CHANNEL_8, GPIO_NUM_25}, |
| {{&machine_adc_type}, ADCBLOCK2, ADC_CHANNEL_9, GPIO_NUM_26}, |
| #elif CONFIG_IDF_TARGET_ESP32C3 |
| {{&machine_adc_type}, ADCBLOCK1, ADC_CHANNEL_0, GPIO_NUM_0}, |
| {{&machine_adc_type}, ADCBLOCK1, ADC_CHANNEL_1, GPIO_NUM_1}, |
| {{&machine_adc_type}, ADCBLOCK1, ADC_CHANNEL_2, GPIO_NUM_2}, |
| {{&machine_adc_type}, ADCBLOCK1, ADC_CHANNEL_3, GPIO_NUM_3}, |
| {{&machine_adc_type}, ADCBLOCK1, ADC_CHANNEL_4, GPIO_NUM_4}, |
| {{&machine_adc_type}, ADCBLOCK2, ADC_CHANNEL_0, GPIO_NUM_5}, |
| #elif CONFIG_IDF_TARGET_ESP32C6 |
| {{&machine_adc_type}, ADCBLOCK1, ADC_CHANNEL_0, GPIO_NUM_0}, |
| {{&machine_adc_type}, ADCBLOCK1, ADC_CHANNEL_1, GPIO_NUM_1}, |
| {{&machine_adc_type}, ADCBLOCK1, ADC_CHANNEL_2, GPIO_NUM_2}, |
| {{&machine_adc_type}, ADCBLOCK1, ADC_CHANNEL_3, GPIO_NUM_3}, |
| {{&machine_adc_type}, ADCBLOCK1, ADC_CHANNEL_4, GPIO_NUM_4}, |
| {{&machine_adc_type}, ADCBLOCK1, ADC_CHANNEL_5, GPIO_NUM_5}, |
| {{&machine_adc_type}, ADCBLOCK1, ADC_CHANNEL_6, GPIO_NUM_6}, |
| #elif CONFIG_IDF_TARGET_ESP32S2 || CONFIG_IDF_TARGET_ESP32S3 |
| {{&machine_adc_type}, ADCBLOCK1, ADC_CHANNEL_0, GPIO_NUM_1}, |
| {{&machine_adc_type}, ADCBLOCK1, ADC_CHANNEL_1, GPIO_NUM_2}, |
| {{&machine_adc_type}, ADCBLOCK1, ADC_CHANNEL_2, GPIO_NUM_3}, |
| {{&machine_adc_type}, ADCBLOCK1, ADC_CHANNEL_3, GPIO_NUM_4}, |
| {{&machine_adc_type}, ADCBLOCK1, ADC_CHANNEL_4, GPIO_NUM_5}, |
| {{&machine_adc_type}, ADCBLOCK1, ADC_CHANNEL_5, GPIO_NUM_6}, |
| {{&machine_adc_type}, ADCBLOCK1, ADC_CHANNEL_6, GPIO_NUM_7}, |
| {{&machine_adc_type}, ADCBLOCK1, ADC_CHANNEL_7, GPIO_NUM_8}, |
| {{&machine_adc_type}, ADCBLOCK1, ADC_CHANNEL_8, GPIO_NUM_9}, |
| {{&machine_adc_type}, ADCBLOCK1, ADC_CHANNEL_9, GPIO_NUM_10}, |
| {{&machine_adc_type}, ADCBLOCK2, ADC_CHANNEL_0, GPIO_NUM_11}, |
| {{&machine_adc_type}, ADCBLOCK2, ADC_CHANNEL_1, GPIO_NUM_12}, |
| {{&machine_adc_type}, ADCBLOCK2, ADC_CHANNEL_2, GPIO_NUM_13}, |
| {{&machine_adc_type}, ADCBLOCK2, ADC_CHANNEL_3, GPIO_NUM_14}, |
| {{&machine_adc_type}, ADCBLOCK2, ADC_CHANNEL_4, GPIO_NUM_15}, |
| {{&machine_adc_type}, ADCBLOCK2, ADC_CHANNEL_5, GPIO_NUM_16}, |
| {{&machine_adc_type}, ADCBLOCK2, ADC_CHANNEL_6, GPIO_NUM_17}, |
| {{&machine_adc_type}, ADCBLOCK2, ADC_CHANNEL_7, GPIO_NUM_18}, |
| {{&machine_adc_type}, ADCBLOCK2, ADC_CHANNEL_8, GPIO_NUM_19}, |
| {{&machine_adc_type}, ADCBLOCK2, ADC_CHANNEL_9, GPIO_NUM_20}, |
| #endif |
| }; |
| |
| static uint8_t madc_obj_atten[MP_ARRAY_SIZE(madc_obj)]; |
| |
| const machine_adc_obj_t *madc_search_helper(machine_adc_block_obj_t *block, adc_channel_t channel_id, gpio_num_t gpio_id) { |
| for (int i = 0; i < MP_ARRAY_SIZE(madc_obj); i++) { |
| const machine_adc_obj_t *adc = &madc_obj[i]; |
| if ((block == NULL || block == adc->block) && (channel_id == -1 || channel_id == adc->channel_id) && (gpio_id == -1 || gpio_id == adc->gpio_id)) { |
| return adc; |
| } |
| } |
| return NULL; |
| } |
| |
| static void mp_machine_adc_print(const mp_print_t *print, mp_obj_t self_in, mp_print_kind_t kind) { |
| const machine_adc_obj_t *self = MP_OBJ_TO_PTR(self_in); |
| mp_printf(print, "ADC(Pin(%u), atten=%u)", self->gpio_id, mp_machine_adc_atten_get_helper(self)); |
| } |
| |
| void madc_init_helper(const machine_adc_obj_t *self, size_t n_pos_args, const mp_obj_t *pos_args, mp_map_t *kw_args) { |
| enum { |
| ARG_atten, |
| }; |
| |
| static const mp_arg_t allowed_args[] = { |
| { MP_QSTR_atten, MP_ARG_KW_ONLY | MP_ARG_INT, {.u_int = -1} }, |
| }; |
| |
| mp_arg_val_t args[MP_ARRAY_SIZE(allowed_args)]; |
| mp_arg_parse_all(n_pos_args, pos_args, kw_args, MP_ARRAY_SIZE(allowed_args), allowed_args, args); |
| |
| |
| if (!self->block->handle) { |
| adc_oneshot_unit_init_cfg_t init_config = { |
| .unit_id = self->block->unit_id |
| }; |
| check_esp_err(adc_oneshot_new_unit(&init_config, &self->block->handle)); |
| } |
| |
| mp_int_t atten = args[ARG_atten].u_int; |
| mp_machine_adc_atten_set_helper(self, atten != -1 ? atten : ADC_ATTEN_MAX); |
| mp_machine_adc_block_width_set_helper(self->block, ADC_WIDTH_MAX); |
| apply_self_adc_channel_atten(self, mp_machine_adc_atten_get_helper(self)); |
| |
| } |
| |
| static void mp_machine_adc_init_helper(machine_adc_obj_t *self, size_t n_pos_args, const mp_obj_t *pos_args, mp_map_t *kw_args) { |
| madc_init_helper(self, n_pos_args, pos_args, kw_args); |
| } |
| |
| static void mp_machine_adc_deinit(machine_adc_obj_t *self) { |
| if (self->block->handle) { |
| check_esp_err(adc_oneshot_del_unit(self->block->handle)); |
| self->block->handle = NULL; |
| } |
| } |
| |
| static mp_obj_t mp_machine_adc_make_new(const mp_obj_type_t *type, size_t n_pos_args, size_t n_kw_args, const mp_obj_t *args) { |
| mp_arg_check_num(n_pos_args, n_kw_args, 1, MP_OBJ_FUN_ARGS_MAX, true); |
| gpio_num_t gpio_id = machine_pin_get_id(args[0]); |
| const machine_adc_obj_t *self = madc_search_helper(NULL, -1, gpio_id); |
| if (!self) { |
| mp_raise_ValueError(MP_ERROR_TEXT("invalid pin")); |
| } |
| |
| mp_map_t kw_args; |
| mp_map_init_fixed_table(&kw_args, n_kw_args, args + n_pos_args); |
| madc_init_helper(self, n_pos_args - 1, args + 1, &kw_args); |
| |
| return MP_OBJ_FROM_PTR(self); |
| } |
| |
| static mp_obj_t mp_machine_adc_block(machine_adc_obj_t *self) { |
| return MP_OBJ_FROM_PTR(self->block); |
| } |
| |
| static mp_int_t mp_machine_adc_read(machine_adc_obj_t *self) { |
| mp_int_t raw = madcblock_read_helper(self->block, self->channel_id); |
| return raw; |
| } |
| |
| static mp_int_t mp_machine_adc_read_u16(machine_adc_obj_t *self) { |
| mp_uint_t raw = madcblock_read_helper(self->block, self->channel_id); |
| // Scale raw reading to 16 bit value using a Taylor expansion (for 8 <= bits <= 16) |
| mp_int_t bits = mp_machine_adc_width_get_helper(self); |
| mp_uint_t u16 = raw << (16 - bits) | raw >> (2 * bits - 16); |
| return u16; |
| } |
| |
| static mp_int_t mp_machine_adc_read_uv(machine_adc_obj_t *self) { |
| return madcblock_read_uv_helper(self->block, self->channel_id, mp_machine_adc_atten_get_helper(self)); |
| } |
| |
| mp_int_t mp_machine_adc_atten_get_helper(const machine_adc_obj_t *self) { |
| uint8_t value = madc_obj_atten[self - &madc_obj[0]]; |
| return value == 0 ? ADC_ATTEN_MAX : value - 1; |
| } |
| |
| void mp_machine_adc_atten_set_helper(const machine_adc_obj_t *self, mp_int_t atten) { |
| if (atten < ADC_ATTEN_MIN || atten > ADC_ATTEN_MAX) { |
| mp_raise_ValueError(MP_ERROR_TEXT("invalid attenuation")); |
| } |
| |
| madc_obj_atten[self - &madc_obj[0]] = atten + 1; |
| } |
| |
| static void mp_machine_adc_atten_set(machine_adc_obj_t *self, mp_int_t atten) { |
| mp_machine_adc_atten_set_helper(self, atten); |
| apply_self_adc_channel_atten(self, mp_machine_adc_atten_get_helper(self)); |
| } |
| |
| mp_int_t mp_machine_adc_width_get_helper(const machine_adc_obj_t *self) { |
| return self->block->bitwidth; |
| } |
| |
| void mp_machine_adc_block_width_set_helper(machine_adc_block_obj_t *self, mp_int_t width) { |
| if (width < ADC_WIDTH_MIN || width > ADC_WIDTH_MAX) { |
| mp_raise_ValueError(MP_ERROR_TEXT("invalid bit-width")); |
| } |
| |
| self->bitwidth = width; |
| } |
| |
| static void mp_machine_adc_width_set(machine_adc_obj_t *self, mp_int_t width) { |
| mp_machine_adc_block_width_set_helper(self->block, width); |
| apply_self_adc_channel_atten(self, mp_machine_adc_atten_get_helper(self)); |
| } |