ESP32S2: Support for native TouchIO

ports/esp32s2/common-hal/touchio/TouchIn.c

@@ -0,0 +1,96 @@
+/*
+ * 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 "shared-bindings/touchio/TouchIn.h"
+#include "py/runtime.h"
+
+#include "driver/touch_pad.h"
+
+static uint16_t get_raw_reading(touchio_touchin_obj_t *self) {
+    uint32_t touch_value;
+    touch_pad_read_raw_data((touch_pad_t)self->pin->touch_channel, &touch_value);
+    if (touch_value > UINT16_MAX) {
+        return UINT16_MAX;
+    }
+    return touch_value;
+}
+
+void common_hal_touchio_touchin_construct(touchio_touchin_obj_t* self,
+        const mcu_pin_obj_t *pin) {
+    if (pin->touch_channel == TOUCH_PAD_MAX) {
+        mp_raise_ValueError(translate("Invalid pin"));
+    }
+    claim_pin(pin);
+
+    touch_pad_init();
+    touch_pad_config((touch_pad_t)pin->touch_channel);
+
+    touch_pad_set_fsm_mode(TOUCH_FSM_MODE_TIMER);
+    touch_pad_fsm_start();
+
+    // wait for "raw data" to reset
+    mp_hal_delay_ms(10);
+
+    // Initial values for pins will vary, depending on what peripherals the pins
+    // share on-chip.
+
+    // Set a "touched" threshold not too far above the initial value.
+    // For simple finger touch, the values may vary as much as a factor of two,
+    // but for touches using fruit or other objects, the difference is much less.
+
+    self->pin = pin;
+    self->threshold = get_raw_reading(self) + 100;
+}
+
+bool common_hal_touchio_touchin_deinited(touchio_touchin_obj_t* self) {
+    return self->pin == NULL;
+}
+
+void common_hal_touchio_touchin_deinit(touchio_touchin_obj_t* self) {
+    if (common_hal_touchio_touchin_deinited(self)) {
+        return;
+    }
+    touch_pad_deinit();
+    reset_pin_number(self->pin->touch_channel);
+    self->pin = NULL;
+}
+
+bool common_hal_touchio_touchin_get_value(touchio_touchin_obj_t *self) {
+    uint16_t reading = get_raw_reading(self);
+    return reading > self->threshold;
+}
+
+uint16_t common_hal_touchio_touchin_get_raw_value(touchio_touchin_obj_t *self) {
+    return get_raw_reading(self);
+}
+
+uint16_t common_hal_touchio_touchin_get_threshold(touchio_touchin_obj_t *self) {
+    return self->threshold;
+}
+
+void common_hal_touchio_touchin_set_threshold(touchio_touchin_obj_t *self, uint16_t new_threshold) {
+    self->threshold = new_threshold;
+}

ports/esp32s2/common-hal/touchio/TouchIn.h

@@ -0,0 +1,42 @@
+/*
+ * This file is part of the MicroPython project, http://micropython.org/
+ *
+ * The MIT License (MIT)
+ *
+ * Copyright (c) 2016 Scott Shawcroft
+ *
+ * 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.
+ */
+
+#ifndef MICROPY_INCLUDED_ESP32S2_COMMON_HAL_TOUCHIO_TOUCHIN_H
+#define MICROPY_INCLUDED_ESP32S2_COMMON_HAL_TOUCHIO_TOUCHIN_H
+
+#include "common-hal/microcontroller/Pin.h"
+
+#include "py/obj.h"
+
+typedef struct {
+    mp_obj_base_t base;
+    const mcu_pin_obj_t * pin;
+    uint16_t threshold;
+} touchio_touchin_obj_t;
+
+void touchin_reset(void);
+
+#endif // MICROPY_INCLUDED_ESP32S2_COMMON_HAL_TOUCHIO_TOUCHIN_H

ports/esp32s2/common-hal/touchio/__init__.c

@@ -0,0 +1 @@
+// No touchio module functions.

ports/esp32s2/mpconfigport.mk

@@ -26,4 +26,8 @@ CIRCUITPY_USB_MIDI = 0
 CIRCUITPY_WIFI = 1
 CIRCUITPY_ESPIDF = 1
 
+ifndef CIRCUITPY_TOUCHIO_USE_NATIVE
+CIRCUITPY_TOUCHIO_USE_NATIVE = 1
+endif
+
 CIRCUITPY_MODULE ?= none

ports/esp32s2/peripherals/pins.c

@@ -29,55 +29,58 @@
 #define NO_ADC 0
 #define NO_ADC_CHANNEL ADC_CHANNEL_MAX
 
+#define NO_TOUCH_CHANNEL TOUCH_PAD_MAX
+
 // This macro is used to simplify pin definition in boards/<board>/pins.c
-#define PIN(p_name, p_number, p_adc_index, p_adc_channel) \
+#define PIN(p_name, p_number, p_adc_index, p_adc_channel, p_touch_channel) \
 const mcu_pin_obj_t pin_## p_name = { \
     PIN_PREFIX_VALUES \
     .number = p_number, \
     .adc_index = p_adc_index, \
     .adc_channel = p_adc_channel, \
+    .touch_channel = p_touch_channel, \
 }
 
-PIN(GPIO0, 0, NO_ADC, NO_ADC_CHANNEL);
-PIN(GPIO1, 1, ADC_UNIT_1, ADC_CHANNEL_0);
-PIN(GPIO2, 2, ADC_UNIT_1, ADC_CHANNEL_1);
-PIN(GPIO3, 3, ADC_UNIT_1, ADC_CHANNEL_2);
-PIN(GPIO4, 4, ADC_UNIT_1, ADC_CHANNEL_3);
-PIN(GPIO5, 5, ADC_UNIT_1, ADC_CHANNEL_4);
-PIN(GPIO6, 6, ADC_UNIT_1, ADC_CHANNEL_5);
-PIN(GPIO7, 7, ADC_UNIT_1, ADC_CHANNEL_6);
-PIN(GPIO8, 8, ADC_UNIT_1, ADC_CHANNEL_7);
-PIN(GPIO9, 9, ADC_UNIT_1, ADC_CHANNEL_8);
-PIN(GPIO10, 10, ADC_UNIT_1, ADC_CHANNEL_9);
-PIN(GPIO11, 11, ADC_UNIT_2, ADC_CHANNEL_0);
-PIN(GPIO12, 12, ADC_UNIT_2, ADC_CHANNEL_1);
-PIN(GPIO13, 13, ADC_UNIT_2, ADC_CHANNEL_2);
-PIN(GPIO14, 14, ADC_UNIT_2, ADC_CHANNEL_3);
-PIN(GPIO15, 15, ADC_UNIT_2, ADC_CHANNEL_4);
-PIN(GPIO16, 16, ADC_UNIT_2, ADC_CHANNEL_5);
-PIN(GPIO17, 17, ADC_UNIT_2, ADC_CHANNEL_6);
-PIN(GPIO18, 18, ADC_UNIT_2, ADC_CHANNEL_7);
-PIN(GPIO19, 19, ADC_UNIT_2, ADC_CHANNEL_8);
-PIN(GPIO20, 20, ADC_UNIT_2, ADC_CHANNEL_9);
-PIN(GPIO21, 21, NO_ADC, NO_ADC_CHANNEL);
-PIN(GPIO26, 26, NO_ADC, NO_ADC_CHANNEL);
-PIN(GPIO27, 27, NO_ADC, NO_ADC_CHANNEL);
-PIN(GPIO28, 28, NO_ADC, NO_ADC_CHANNEL);
-PIN(GPIO29, 29, NO_ADC, NO_ADC_CHANNEL);
-PIN(GPIO30, 30, NO_ADC, NO_ADC_CHANNEL);
-PIN(GPIO31, 31, NO_ADC, NO_ADC_CHANNEL);
-PIN(GPIO32, 32, NO_ADC, NO_ADC_CHANNEL);
-PIN(GPIO33, 33, NO_ADC, NO_ADC_CHANNEL);
-PIN(GPIO34, 34, NO_ADC, NO_ADC_CHANNEL);
-PIN(GPIO35, 35, NO_ADC, NO_ADC_CHANNEL);
-PIN(GPIO36, 36, NO_ADC, NO_ADC_CHANNEL);
-PIN(GPIO37, 37, NO_ADC, NO_ADC_CHANNEL);
-PIN(GPIO38, 38, NO_ADC, NO_ADC_CHANNEL);
-PIN(GPIO39, 39, NO_ADC, NO_ADC_CHANNEL);
-PIN(GPIO40, 40, NO_ADC, NO_ADC_CHANNEL);
-PIN(GPIO41, 41, NO_ADC, NO_ADC_CHANNEL);
-PIN(GPIO42, 42, NO_ADC, NO_ADC_CHANNEL);
-PIN(GPIO43, 43, NO_ADC, NO_ADC_CHANNEL);
-PIN(GPIO44, 44, NO_ADC, NO_ADC_CHANNEL);
-PIN(GPIO45, 45, NO_ADC, NO_ADC_CHANNEL);
-PIN(GPIO46, 46, NO_ADC, NO_ADC_CHANNEL);
+PIN(GPIO0, 0, NO_ADC, NO_ADC_CHANNEL, NO_TOUCH_CHANNEL);
+PIN(GPIO1, 1, ADC_UNIT_1, ADC_CHANNEL_0, TOUCH_PAD_NUM1);
+PIN(GPIO2, 2, ADC_UNIT_1, ADC_CHANNEL_1, TOUCH_PAD_NUM2);
+PIN(GPIO3, 3, ADC_UNIT_1, ADC_CHANNEL_2, TOUCH_PAD_NUM3);
+PIN(GPIO4, 4, ADC_UNIT_1, ADC_CHANNEL_3, TOUCH_PAD_NUM4);
+PIN(GPIO5, 5, ADC_UNIT_1, ADC_CHANNEL_4, TOUCH_PAD_NUM5);
+PIN(GPIO6, 6, ADC_UNIT_1, ADC_CHANNEL_5, TOUCH_PAD_NUM6);
+PIN(GPIO7, 7, ADC_UNIT_1, ADC_CHANNEL_6, TOUCH_PAD_NUM7);
+PIN(GPIO8, 8, ADC_UNIT_1, ADC_CHANNEL_7, TOUCH_PAD_NUM8);
+PIN(GPIO9, 9, ADC_UNIT_1, ADC_CHANNEL_8, TOUCH_PAD_NUM9);
+PIN(GPIO10, 10, ADC_UNIT_1, ADC_CHANNEL_9, TOUCH_PAD_NUM10);
+PIN(GPIO11, 11, ADC_UNIT_2, ADC_CHANNEL_0, TOUCH_PAD_NUM11);
+PIN(GPIO12, 12, ADC_UNIT_2, ADC_CHANNEL_1, TOUCH_PAD_NUM12);
+PIN(GPIO13, 13, ADC_UNIT_2, ADC_CHANNEL_2, TOUCH_PAD_NUM13);
+PIN(GPIO14, 14, ADC_UNIT_2, ADC_CHANNEL_3, TOUCH_PAD_NUM14);
+PIN(GPIO15, 15, ADC_UNIT_2, ADC_CHANNEL_4, NO_TOUCH_CHANNEL);
+PIN(GPIO16, 16, ADC_UNIT_2, ADC_CHANNEL_5, NO_TOUCH_CHANNEL);
+PIN(GPIO17, 17, ADC_UNIT_2, ADC_CHANNEL_6, NO_TOUCH_CHANNEL);
+PIN(GPIO18, 18, ADC_UNIT_2, ADC_CHANNEL_7, NO_TOUCH_CHANNEL);
+PIN(GPIO19, 19, ADC_UNIT_2, ADC_CHANNEL_8, NO_TOUCH_CHANNEL);
+PIN(GPIO20, 20, ADC_UNIT_2, ADC_CHANNEL_9, NO_TOUCH_CHANNEL);
+PIN(GPIO21, 21, NO_ADC, NO_ADC_CHANNEL, NO_TOUCH_CHANNEL);
+PIN(GPIO26, 26, NO_ADC, NO_ADC_CHANNEL, NO_TOUCH_CHANNEL);
+PIN(GPIO27, 27, NO_ADC, NO_ADC_CHANNEL, NO_TOUCH_CHANNEL);
+PIN(GPIO28, 28, NO_ADC, NO_ADC_CHANNEL, NO_TOUCH_CHANNEL);
+PIN(GPIO29, 29, NO_ADC, NO_ADC_CHANNEL, NO_TOUCH_CHANNEL);
+PIN(GPIO30, 30, NO_ADC, NO_ADC_CHANNEL, NO_TOUCH_CHANNEL);
+PIN(GPIO31, 31, NO_ADC, NO_ADC_CHANNEL, NO_TOUCH_CHANNEL);
+PIN(GPIO32, 32, NO_ADC, NO_ADC_CHANNEL, NO_TOUCH_CHANNEL);
+PIN(GPIO33, 33, NO_ADC, NO_ADC_CHANNEL, NO_TOUCH_CHANNEL);
+PIN(GPIO34, 34, NO_ADC, NO_ADC_CHANNEL, NO_TOUCH_CHANNEL);
+PIN(GPIO35, 35, NO_ADC, NO_ADC_CHANNEL, NO_TOUCH_CHANNEL);
+PIN(GPIO36, 36, NO_ADC, NO_ADC_CHANNEL, NO_TOUCH_CHANNEL);
+PIN(GPIO37, 37, NO_ADC, NO_ADC_CHANNEL, NO_TOUCH_CHANNEL);
+PIN(GPIO38, 38, NO_ADC, NO_ADC_CHANNEL, NO_TOUCH_CHANNEL);
+PIN(GPIO39, 39, NO_ADC, NO_ADC_CHANNEL, NO_TOUCH_CHANNEL);
+PIN(GPIO40, 40, NO_ADC, NO_ADC_CHANNEL, NO_TOUCH_CHANNEL);
+PIN(GPIO41, 41, NO_ADC, NO_ADC_CHANNEL, NO_TOUCH_CHANNEL);
+PIN(GPIO42, 42, NO_ADC, NO_ADC_CHANNEL, NO_TOUCH_CHANNEL);
+PIN(GPIO43, 43, NO_ADC, NO_ADC_CHANNEL, NO_TOUCH_CHANNEL);
+PIN(GPIO44, 44, NO_ADC, NO_ADC_CHANNEL, NO_TOUCH_CHANNEL);
+PIN(GPIO45, 45, NO_ADC, NO_ADC_CHANNEL, NO_TOUCH_CHANNEL);
+PIN(GPIO46, 46, NO_ADC, NO_ADC_CHANNEL, NO_TOUCH_CHANNEL);

ports/esp32s2/peripherals/pins.h

@@ -37,12 +37,14 @@
 
 #include "components/hal/include/hal/gpio_types.h"
 #include "components/hal/include/hal/adc_types.h"
+#include "components/hal/include/hal/touch_sensor_types.h"
 
 typedef struct {
     PIN_PREFIX_FIELDS
     gpio_num_t number;
     uint8_t adc_index:2;
     uint8_t adc_channel:6;
+    uint8_t touch_channel;
 } mcu_pin_obj_t;
 
 extern const mcu_pin_obj_t pin_GPIO0;