Merge pull request #9164 from tannewt/max3421e

Add Max3421E support for usb host

Author: dhalbert

.gitignore

@@ -91,3 +91,7 @@ TAGS
 
 # Uncrustify formatting
 *.uncrustify
+
+# clangd cache
+##############
+.cache

docs/shared_bindings_matrix.py

@@ -83,7 +83,7 @@
     "select": "MICROPY_PY_SELECT_SELECT",
     "sys": "CIRCUITPY_SYS",
     "terminalio": "CIRCUITPY_DISPLAYIO",
-    "usb": "CIRCUITPY_USB_HOST",
+    "usb": "CIRCUITPY_PYUSB",
 }
 
 MODULES_NOT_IN_BINDINGS = [ "binascii", "errno", "json", "re", "ulab" ]

lib/tinyusb

@@ -0,0 +1,80 @@
+/*
+ * This file is part of the MicroPython project, http://micropython.org/
+ *
+ * The MIT License (MIT)
+ *
+ * Copyright (c) 2024 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-module/max3421e/Max3421E.h"
+
+#include "common-hal/max3421e/Max3421E.h"
+
+#include "lib/tinyusb/src/host/usbh.h"
+#include "supervisor/usb.h"
+
+#include "eic_handler.h"
+#include "py/runtime.h"
+#include "samd/external_interrupts.h"
+
+#include "shared-bindings/microcontroller/Pin.h"
+
+void samd_max3421e_interrupt_handler(uint8_t channel) {
+    max3421e_interrupt_handler((max3421e_max3421e_obj_t *)get_eic_channel_data(channel));
+}
+
+// Setup irq on self->irq to call tuh_int_handler(rhport, true) on falling edge
+void common_hal_max3421e_max3421e_init_irq(max3421e_max3421e_obj_t *self) {
+    const mcu_pin_obj_t *pin = self->irq.pin;
+    if (!pin->has_extint) {
+        raise_ValueError_invalid_pin();
+    }
+    if (eic_get_enable()) {
+        if (!eic_channel_free(pin->extint_channel)) {
+            mp_raise_RuntimeError(MP_ERROR_TEXT("Internal resource(s) in use"));
+        }
+    } else {
+        turn_on_external_interrupt_controller();
+    }
+
+    set_eic_channel_data(pin->extint_channel, self);
+    set_eic_handler(pin->extint_channel, EIC_HANDLER_MAX3421E);
+    turn_on_eic_channel(pin->extint_channel, EIC_CONFIG_SENSE0_LOW_Val);
+}
+
+void common_hal_max3421e_max3421e_deinit_irq(max3421e_max3421e_obj_t *self) {
+    const mcu_pin_obj_t *pin = self->irq.pin;
+    set_eic_handler(pin->extint_channel, EIC_HANDLER_NO_INTERRUPT);
+    turn_off_eic_channel(pin->extint_channel);
+    reset_pin_number(pin->extint_channel);
+}
+
+// Enable or disable the irq interrupt.
+void common_hal_max3421e_max3421e_irq_enabled(max3421e_max3421e_obj_t *self, bool enabled) {
+    const mcu_pin_obj_t *pin = self->irq.pin;
+    uint32_t mask = 1 << pin->extint_channel;
+    // Don't use the turn_(on|off) API because it may deinit the eic completely.
+    if (!enabled) {
+        EIC->INTENCLR.reg = mask << EIC_INTENSET_EXTINT_Pos;
+    } else {
+        EIC->INTENSET.reg = mask << EIC_INTENSET_EXTINT_Pos;
+    }
+}

ports/atmel-samd/common-hal/max3421e/Max3421E.c

@@ -0,0 +1,31 @@
+/*
+ * This file is part of the MicroPython project, http://micropython.org/
+ *
+ * The MIT License (MIT)
+ *
+ * Copyright (c) 2024 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.
+ */
+
+#pragma once
+
+#include <stdint.h>
+
+void samd_max3421e_interrupt_handler(uint8_t channel);

ports/atmel-samd/common-hal/max3421e/Max3421E.h

@@ -24,6 +24,7 @@
  * THE SOFTWARE.
  */
 
+#include "common-hal/max3421e/Max3421E.h"
 #include "common-hal/pulseio/PulseIn.h"
 #include "common-hal/ps2io/Ps2.h"
 #include "common-hal/rotaryio/IncrementalEncoder.h"
@@ -73,6 +74,12 @@ void shared_eic_handler(uint8_t channel) {
             break;
         #endif
 
+        #if CIRCUITPY_MAX3421E
+        case EIC_HANDLER_MAX3421E:
+            samd_max3421e_interrupt_handler(channel);
+            break;
+        #endif
+
         default:
             break;
     }

ports/atmel-samd/eic_handler.c

@@ -23,17 +23,15 @@
  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
  * THE SOFTWARE.
  */
-#ifndef MICROPY_INCLUDED_ATMEL_SAMD_EIC_HANDLER_H
-#define MICROPY_INCLUDED_ATMEL_SAMD_EIC_HANDLER_H
+#pragma once
 
 #define EIC_HANDLER_NO_INTERRUPT 0x0
 #define EIC_HANDLER_PULSEIN 0x1
 #define EIC_HANDLER_INCREMENTAL_ENCODER 0x2
 #define EIC_HANDLER_PS2 0x3
 #define EIC_HANDLER_COUNTER 0x04
 #define EIC_HANDLER_ALARM 0x05
+#define EIC_HANDLER_MAX3421E 0x06
 
 void set_eic_handler(uint8_t channel, uint8_t eic_handler);
 void shared_eic_handler(uint8_t channel);
-
-#endif  // MICROPY_INCLUDED_ATMEL_SAMD_EIC_HANDLER_H

ports/atmel-samd/eic_handler.h

@@ -99,6 +99,13 @@ ifeq ($(CIRCUITPY_FULL_BUILD),0)
 CIRCUITPY_LTO_PARTITION ?= one
 endif
 
+# 20A skus have 1MB flash and can fit more.
+ifeq ($(patsubst %20A,,$(CHIP_VARIANT)),)
+HAS_1MB_FLASH = 1
+else
+HAS_1MB_FLASH = 0
+endif
+
 # The ?='s allow overriding in mpconfigboard.mk.
 
 
@@ -107,6 +114,7 @@ CIRCUITPY_ALARM ?= 1
 CIRCUITPY_BITMAPFILTER ?= 0
 CIRCUITPY_FLOPPYIO ?= $(CIRCUITPY_FULL_BUILD)
 CIRCUITPY_FRAMEBUFFERIO ?= $(CIRCUITPY_FULL_BUILD)
+CIRCUITPY_MAX3421E ?= $(HAS_1MB_FLASH)
 CIRCUITPY_PS2IO ?= 1
 CIRCUITPY_RGBMATRIX ?= $(CIRCUITPY_FRAMEBUFFERIO)
 CIRCUITPY_SAMD ?= 1

ports/atmel-samd/mpconfigport.mk

@@ -1,6 +1,6 @@
 USB_VID = 0x239A
 USB_PID = 0x8114
-USB_PRODUCT = "Adafruit Feather ESP32S3 No PSRAM"
+USB_PRODUCT = "Feather ESP32S3 No PSRAM"
 USB_MANUFACTURER = "Adafruit"
 
 IDF_TARGET = esp32s3

ports/espressif/boards/adafruit_feather_esp32s3_nopsram/mpconfigboard.mk

@@ -26,6 +26,7 @@
 
 #include <string.h>
 
+#include "freertos/projdefs.h"
 #include "py/runtime.h"
 #include "shared-bindings/busio/SPI.h"
 #include "shared-bindings/microcontroller/Pin.h"
@@ -37,6 +38,7 @@
 
 static bool spi_never_reset[SOC_SPI_PERIPH_NUM];
 static spi_device_handle_t spi_handle[SOC_SPI_PERIPH_NUM];
+static StaticSemaphore_t spi_mutex[SOC_SPI_PERIPH_NUM];
 
 static bool spi_bus_is_free(spi_host_device_t host_id) {
     return spi_bus_get_attr(host_id) == NULL;
@@ -121,6 +123,8 @@ void common_hal_busio_spi_construct(busio_spi_obj_t *self,
         claim_pin(miso);
     }
     claim_pin(clock);
+
+    self->mutex = xSemaphoreCreateMutexStatic(&spi_mutex[self->host_id]);
 }
 
 void common_hal_busio_spi_never_reset(busio_spi_obj_t *self) {
@@ -143,14 +147,22 @@ void common_hal_busio_spi_deinit(busio_spi_obj_t *self) {
         return;
     }
 
+    // Wait for any other users of this to finish.
+    while (!common_hal_busio_spi_try_lock(self)) {
+    }
+
+    // Mark us as deinit early in case we are used in an interrupt.
+    common_hal_reset_pin(self->clock);
+    self->clock = NULL;
+
     spi_never_reset[self->host_id] = false;
     spi_bus_remove_device(spi_handle[self->host_id]);
     spi_bus_free(self->host_id);
 
+    vSemaphoreDelete(self->mutex);
+
     common_hal_reset_pin(self->MOSI);
     common_hal_reset_pin(self->MISO);
-    common_hal_reset_pin(self->clock);
-    self->clock = NULL;
 }
 
 bool common_hal_busio_spi_configure(busio_spi_obj_t *self,
@@ -167,20 +179,18 @@ bool common_hal_busio_spi_configure(busio_spi_obj_t *self,
 }
 
 bool common_hal_busio_spi_try_lock(busio_spi_obj_t *self) {
-    bool grabbed_lock = false;
-    if (!self->has_lock) {
-        grabbed_lock = true;
-        self->has_lock = true;
+    if (common_hal_busio_spi_deinited(self)) {
+        return false;
     }
-    return grabbed_lock;
+    return xSemaphoreTake(self->mutex, 1) == pdTRUE;
 }
 
 bool common_hal_busio_spi_has_lock(busio_spi_obj_t *self) {
-    return self->has_lock;
+    return xSemaphoreGetMutexHolder(self->mutex) == xTaskGetCurrentTaskHandle();
 }
 
 void common_hal_busio_spi_unlock(busio_spi_obj_t *self) {
-    self->has_lock = false;
+    xSemaphoreGive(self->mutex);
 }
 
 bool common_hal_busio_spi_write(busio_spi_obj_t *self,
@@ -229,7 +239,10 @@ bool common_hal_busio_spi_transfer(busio_spi_obj_t *self,
 
         transactions[0].flags = SPI_TRANS_USE_TXDATA | SPI_TRANS_USE_RXDATA;
         transactions[0].length = bits_to_send;
-        spi_device_transmit(spi_handle[self->host_id], &transactions[0]);
+        esp_err_t result = spi_device_transmit(spi_handle[self->host_id], &transactions[0]);
+        if (result != ESP_OK) {
+            return false;
+        }
 
         if (data_in != NULL) {
             memcpy(data_in, &transactions[0].rx_data, len);