extmod/machine_adc: Factor ports' ADC Python bindings to common code.

No functional change, just code factoring to have the Python bindings in
one location, and all the ports use those same bindings.

Signed-off-by: Damien George <damien@micropython.org>

1 files changed, 59 insertions, 87 deletions

diff --git a/ports/esp32/machine_adc.c b/ports/esp32/machine_adc.c
index 1e20186b9..42746cb4b 100644
--- a/ports/esp32/machine_adc.c
+++ b/ports/esp32/machine_adc.c
@@ -25,22 +25,53 @@
  * THE SOFTWARE.
  */
 
-#include <stdio.h>
+// This file is never compiled standalone, it's included directly from
+// extmod/machine_adc.c via MICROPY_PY_MACHINE_ADC_INCLUDEFILE.
 
 #include "esp_log.h"
 
 #include "driver/gpio.h"
 #include "driver/adc.h"
 
-#include "py/runtime.h"
 #include "py/mphal.h"
-#include "modmachine.h"
 #include "machine_adc.h"
 
 #define ADCBLOCK1 (&madcblock_obj[0])
 #define ADCBLOCK2 (&madcblock_obj[1])
 
-STATIC const madc_obj_t madc_obj[] = {
+#if CONFIG_IDF_TARGET_ESP32
+#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 CONFIG_IDF_TARGET_ESP32 || CONFIG_IDF_TARGET_ESP32C3 || CONFIG_IDF_TARGET_ESP32S3
+#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 CONFIG_IDF_TARGET_ESP32S2
+#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},
@@ -96,18 +127,18 @@ STATIC const madc_obj_t madc_obj[] = {
 // can be distinguished from the initialised state.
 STATIC uint8_t madc_obj_atten[MP_ARRAY_SIZE(madc_obj)];
 
-static inline adc_atten_t madc_atten_get(const madc_obj_t *self) {
+static inline adc_atten_t madc_atten_get(const machine_adc_obj_t *self) {
     uint8_t value = madc_obj_atten[self - &madc_obj[0]];
     return value == 0 ? ADC_ATTEN_MAX : value - 1;
 }
 
-static inline void madc_atten_set(const madc_obj_t *self, adc_atten_t atten) {
+static inline void madc_atten_set(const machine_adc_obj_t *self, adc_atten_t atten) {
     madc_obj_atten[self - &madc_obj[0]] = atten + 1;
 }
 
-const madc_obj_t *madc_search_helper(madcblock_obj_t *block, adc_channel_t channel_id, gpio_num_t gpio_id) {
+const machine_adc_obj_t *madc_search_helper(madcblock_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 madc_obj_t *adc = &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;
         }
@@ -115,12 +146,12 @@ const madc_obj_t *madc_search_helper(madcblock_obj_t *block, adc_channel_t chann
     return NULL;
 }
 
-STATIC void madc_print(const mp_print_t *print, mp_obj_t self_in, mp_print_kind_t kind) {
-    const madc_obj_t *self = MP_OBJ_TO_PTR(self_in);
+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, madc_atten_get(self));
 }
 
-STATIC void madc_atten_helper(const madc_obj_t *self, mp_int_t atten) {
+STATIC void madc_atten_helper(const machine_adc_obj_t *self, mp_int_t atten) {
     esp_err_t err;
     if (self->block->unit_id == ADC_UNIT_1) {
         err = adc1_config_channel_atten(self->channel_id, atten);
@@ -133,7 +164,7 @@ STATIC void madc_atten_helper(const madc_obj_t *self, mp_int_t atten) {
     madc_atten_set(self, atten);
 }
 
-void madc_init_helper(const madc_obj_t *self, size_t n_pos_args, const mp_obj_t *pos_args, mp_map_t *kw_args) {
+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,
     };
@@ -153,10 +184,14 @@ void madc_init_helper(const madc_obj_t *self, size_t n_pos_args, const mp_obj_t
     }
 }
 
-STATIC mp_obj_t madc_make_new(const mp_obj_type_t *type, size_t n_pos_args, size_t n_kw_args, const mp_obj_t *args) {
+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 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 madc_obj_t *self = madc_search_helper(NULL, -1, gpio_id);
+    const machine_adc_obj_t *self = madc_search_helper(NULL, -1, gpio_id);
     if (!self) {
         mp_raise_ValueError(MP_ERROR_TEXT("invalid pin"));
     }
@@ -172,95 +207,32 @@ STATIC mp_obj_t madc_make_new(const mp_obj_type_t *type, size_t n_pos_args, size
     return MP_OBJ_FROM_PTR(self);
 }
 
-STATIC mp_obj_t madc_init(size_t n_pos_args, const mp_obj_t *pos_args, mp_map_t *kw_args) {
-    const madc_obj_t *self = MP_OBJ_TO_PTR(pos_args[0]);
-    madc_init_helper(self, n_pos_args - 1, pos_args + 1, kw_args);
-    return mp_const_none;
-}
-STATIC MP_DEFINE_CONST_FUN_OBJ_KW(madc_init_obj, 1, madc_init);
-
-STATIC mp_obj_t madc_block(mp_obj_t self_in) {
-    const madc_obj_t *self = MP_OBJ_TO_PTR(self_in);
+STATIC mp_obj_t mp_machine_adc_block(machine_adc_obj_t *self) {
     return MP_OBJ_FROM_PTR(self->block);
 }
-STATIC MP_DEFINE_CONST_FUN_OBJ_1(madc_block_obj, madc_block);
 
-STATIC mp_obj_t madc_read(mp_obj_t self_in) {
-    const madc_obj_t *self = MP_OBJ_TO_PTR(self_in);
+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 MP_OBJ_NEW_SMALL_INT(raw);
+    return raw;
 }
-STATIC MP_DEFINE_CONST_FUN_OBJ_1(madc_read_obj, madc_read);
 
-STATIC mp_obj_t madc_read_u16(mp_obj_t self_in) {
-    const madc_obj_t *self = MP_OBJ_TO_PTR(self_in);
+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 = self->block->bits;
     mp_uint_t u16 = raw << (16 - bits) | raw >> (2 * bits - 16);
-    return MP_OBJ_NEW_SMALL_INT(u16);
+    return u16;
 }
-STATIC MP_DEFINE_CONST_FUN_OBJ_1(madc_read_u16_obj, madc_read_u16);
 
-STATIC mp_obj_t madc_read_uv(mp_obj_t self_in) {
-    const madc_obj_t *self = MP_OBJ_TO_PTR(self_in);
+STATIC mp_int_t mp_machine_adc_read_uv(machine_adc_obj_t *self) {
     adc_atten_t atten = madc_atten_get(self);
-    return MP_OBJ_NEW_SMALL_INT(madcblock_read_uv_helper(self->block, self->channel_id, atten));
+    return madcblock_read_uv_helper(self->block, self->channel_id, atten);
 }
-STATIC MP_DEFINE_CONST_FUN_OBJ_1(madc_read_uv_obj, madc_read_uv);
 
-STATIC mp_obj_t madc_atten(mp_obj_t self_in, mp_obj_t atten_in) {
-    const madc_obj_t *self = MP_OBJ_TO_PTR(self_in);
-    mp_int_t atten = mp_obj_get_int(atten_in);
+STATIC void mp_machine_adc_atten_set(machine_adc_obj_t *self, mp_int_t atten) {
     madc_atten_helper(self, atten);
-    return mp_const_none;
 }
-MP_DEFINE_CONST_FUN_OBJ_2(madc_atten_obj, madc_atten);
 
-STATIC mp_obj_t madc_width(mp_obj_t self_in, mp_obj_t bits_in) {
-    const madc_obj_t *self = MP_OBJ_TO_PTR(self_in);
-    mp_int_t bits = mp_obj_get_int(bits_in);
-    madcblock_bits_helper(self->block, bits);
-    return mp_const_none;
+STATIC void mp_machine_adc_width_set(machine_adc_obj_t *self, mp_int_t width) {
+    madcblock_bits_helper(self->block, width);
 }
-MP_DEFINE_CONST_FUN_OBJ_2(madc_width_obj, madc_width);
-
-STATIC const mp_rom_map_elem_t madc_locals_dict_table[] = {
-    { MP_ROM_QSTR(MP_QSTR_init), MP_ROM_PTR(&madc_init_obj) },
-    { MP_ROM_QSTR(MP_QSTR_block), MP_ROM_PTR(&madc_block_obj) },
-    { MP_ROM_QSTR(MP_QSTR_read), MP_ROM_PTR(&madc_read_obj) },
-    { MP_ROM_QSTR(MP_QSTR_read_u16), MP_ROM_PTR(&madc_read_u16_obj) },
-    { MP_ROM_QSTR(MP_QSTR_read_uv), MP_ROM_PTR(&madc_read_uv_obj) },
-
-    // Legacy API methods:
-    { MP_ROM_QSTR(MP_QSTR_atten), MP_ROM_PTR(&madc_atten_obj) },
-    { MP_ROM_QSTR(MP_QSTR_width), MP_ROM_PTR(&madc_width_obj) },
-
-    { 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) },
-
-    #if CONFIG_IDF_TARGET_ESP32
-    { 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) },
-    #endif
-    #if CONFIG_IDF_TARGET_ESP32 || CONFIG_IDF_TARGET_ESP32C3 || CONFIG_IDF_TARGET_ESP32S3
-    { MP_ROM_QSTR(MP_QSTR_WIDTH_12BIT), MP_ROM_INT(12) },
-    #endif
-    #if CONFIG_IDF_TARGET_ESP32S2
-    { MP_ROM_QSTR(MP_QSTR_WIDTH_13BIT), MP_ROM_INT(13) },
-    #endif
-
-};
-STATIC MP_DEFINE_CONST_DICT(madc_locals_dict, madc_locals_dict_table);
-
-MP_DEFINE_CONST_OBJ_TYPE(
-    machine_adc_type,
-    MP_QSTR_ADC,
-    MP_TYPE_FLAG_NONE,
-    make_new, madc_make_new,
-    print, madc_print,
-    locals_dict, &madc_locals_dict
-    );