-Added USB via tinyUSB. Still need to test/debug before REPL is ready. - Enabled USB-based modules & dependencies in mpconfigport.mk

Author: U-ANALOG\BHurst

ports/analog/Makefile

@@ -166,17 +166,30 @@ else
 COPT += -O0 #opt completely off to start
 endif
 
-
 # TinyUSB CFLAGS
+ifeq ($(CIRCUITPY_TINYUSB),1)
 CFLAGS += \
 	-DCFG_TUSB_MCU=OPT_MCU_$(MCU_VARIANT_UPPER) \
 	-DBOARD_TUD_MAX_SPEED=OPT_MODE_HIGH_SPEED \
+	-DCFG_TUSB_OS=OPT_OS_NONE \
+	-DCFG_TUD_TASK_QUEUE_SZ=32
 
-# TODO: Add for TinyUSB once our PR goes through for MAX32 devices
-# Add TinyUSB
+# Add TinyUSB sources
 INC += -I../../lib/tinyusb/src
 INC += -I../../supervisor/shared/usb
 SRC_C += lib/tinyusb/src/portable/mentor/musb/dcd_musb.c
+endif
+
+ifeq ($(CIRCUITPY_USB_DEVICE),1)
+CFLAGS += \
+	-DCFG_TUD_CDC_RX_BUFSIZE=1024 \
+	-DCFG_TUD_CDC_TX_BUFSIZE=1024 \
+	-DCFG_TUD_MSC_BUFSIZE=4096 \
+	-DCFG_TUD_MIDI_RX_BUFSIZE=128 \
+	-DCFG_TUD_MIDI_TX_BUFSIZE=128 \
+	-DCFG_TUD_VENDOR_RX_BUFSIZE=128 \
+	-DCFG_TUD_VENDOR_TX_BUFSIZE=128
+endif
 
 SRC_C += \
 	boards/$(BOARD)/board.c \

ports/analog/README.md

@@ -9,7 +9,8 @@ This port brings CircuitPython to ADI's "MAX32" series of microcontrollers. Thes
 - **`linking/:`** Linkerfiles customized for CircuitPython. These are distinct from the linkerfiles used in MSDK as they adopt the structure required by CircuitPython. They may also omit unused features and memory sections, e.g. Mailboxes, RISC-V Flash, & Hyperbus RAM for MAX32690.
 - **`msdk:/`** SDK for MAX32 devices. More info on our GitHub: [Analog Devices MSDK GitHub](https://github.com/analogdevicesinc/msdk)
 - **`peripherals:/`** Helper files for peripherals such as clocks, gpio, etc. These files tend to be specific to vendor SDKs and provide some useful functions for the common-hal interfaces.
-- **`supervisor/:`** Implementation files for the CircuitPython supervisor. This includes port setup, usb, and a filesystem on a storage medium such as SD Card/eMMC, QSPI Flash, or internal flash memory. Currently the internal flash is used.
+- **`supervisor/:`** Implementation files for the CircuitPython supervisor. This includes port setup, usb, and a filesystem on a storage medium such as SD Card/eMMC, QSPI Flash, or internal flash memory. Currently the internal flash is used. This folder is the most important part of a port's core functionality for CircuitPython.
+- **`supervisor/port.c:`** Port-specific startup code including clock initialization, console startup, etc.
 
 - `. :` Build system and high-level interface to the CircuitPython core for the ADI port.
 

ports/analog/boards/APARD/board.c

@@ -32,8 +32,21 @@ const int num_leds = (sizeof(led_pin) / sizeof(mxc_gpio_cfg_t));
 // way.
 // bool board_requests_safe_mode(void);
 
+volatile uint32_t system_ticks = 0;
+
+void SysTick_Handler(void) {
+  system_ticks++;
+}
+
+uint32_t board_millis(void) {
+  return system_ticks;
+}
+
 // Initializes board related state once on start up.
 void board_init(void) {
+    // 1ms tick timer
+    SysTick_Config(SystemCoreClock / 1000);\
+
     // Enable GPIO (enables clocks + common init for ports)
     for (int i = 0; i < MXC_CFG_GPIO_INSTANCES; i++){
         MXC_GPIO_Init(0x1 << i);

ports/analog/boards/APARD/mpconfigboard.mk

@@ -8,8 +8,13 @@ INTERNAL_FLASH_FILESYSTEM = 1
 # FLASH: 	0x10000000 to 0x10300000 (ARM)
 # SRAM: 	0x20000000 to 0x20100000
 
-USB_PRODUCT = "MAX32690 APARD"
-USB_MANUFACTURER = "Analog Devices, Inc."
+USB_MANUFACTURER="Analog Devices, Inc."
+USB_PRODUCT="MAX32690 APARD"
+
+# Use 0x0456 for Analog Devices, Inc.; 0B6A for Maxim
+USB_VID=0x0456
+# USB_VID=0x0B6A
+USB_PID=0x003C
 
 # NOTE: Not implementing external flash for now
 # CFLAGS+=-DEXT_FLASH_MX25

ports/analog/common-hal/microcontroller/Pin.c

@@ -8,56 +8,104 @@
 #include "mxc_sys.h"
 #include "max32690.h"
 #include "gpio.h"
+#include "gpio_regs.h"
+
+// Structs to represent GPIO ports & valid pins/pads
+#ifdef MAX32690
+// todo: special constraints are applied to GPIO4 for MAX32690. Tend to these later (low prior)
+static mxc_gpio_regs_t* ports[NUM_GPIO_PORTS] = { MXC_GPIO0, MXC_GPIO1, MXC_GPIO2, MXC_GPIO3};
+#endif
+
+static uint32_t claimed_pins[NUM_GPIO_PORTS];
+static uint32_t never_reset_pins[NUM_GPIO_PORTS];
+
+#define INVALID_PIN 0xFF // id for invalid pin
 
 void reset_all_pins(void) {
-    // todo: this is not a good method for this long-term
-    // Pins should be individually reset to account for never_reset pins like SWD
+    // reset all pins except for never_reset_pins
     for (int i = 0; i < NUM_GPIO_PORTS; i++) {
-        MXC_GPIO_Reset(i);
+        for (int j = 0; j < 32; j++) {
+            if (!(never_reset_pins[i] & (1 << j))) {
+                reset_pin_number(i, j);
+            }
+        }
+    // set claimed pins to never_reset pins
+    claimed_pins[i] = never_reset_pins[i];
     }
 }
 
-// todo: Implement
-void reset_pin_number(uint8_t pin) {
-}
+void reset_pin_number(uint8_t pin_port, uint8_t pin_pad) {
+    if (pin_port == INVALID_PIN || pin_port > NUM_GPIO_PORTS) {
+        return;
+    }
 
-// todo: Implement
-void claim_pin(const mcu_pin_obj_t *pin) {
-    return;
-}
+    uint32_t mask = 1 << (pin_pad);
 
-// todo: Implement
-bool pin_number_is_free(uint8_t pin_number) {
-    return true;
-}
+    /** START: RESET LOGIC for GPIOs */
+    // Switch to I/O mode first
+    ports[pin_port]->en0_set = mask;
+
+    // set GPIO configuration enable bits to I/O
+    ports[pin_port]->en0_clr = mask;
+    ports[pin_port]->en1_clr = mask;
+    ports[pin_port]->en2_clr = mask;
+
+    // enable input mode GPIOn_INEN.pin = 1
+    ports[pin_port]->inen |= mask;
+
+    // High Impedance mode enable (GPIOn_PADCTRL1 = 0, _PADCTRL0 = 0), pu/pd disable
+    ports[pin_port]->padctrl0 &= ~mask;
+    ports[pin_port]->padctrl1 &= ~mask;
 
+    // Output mode disable GPIOn_OUTEN = 0
+    ports[pin_port]->outen |= mask;
 
-// todo: Implement
-void never_reset_pin_number(uint8_t pin_number) {
-    return;
+    // Interrupt disable GPIOn_INTEN = 0
+    ports[pin_port]->inten &= ~mask;
+    /** END: RESET LOGIC for GPIOs */
 }
 
-//todo: implement
 uint8_t common_hal_mcu_pin_number(const mcu_pin_obj_t *pin) {
-    return 0;
+    if (pin == NULL) {
+        return INVALID_PIN;
+    }
+
+    // most max32 gpio ports have 32 pins
+    // todo: create a struct to encode # of pins for each port, since some GPIO ports differ
+    return pin->port * 32 + pin->pad;
 }
 
-// todo: implement
 bool common_hal_mcu_pin_is_free(const mcu_pin_obj_t *pin) {
-    return true;
+    if (pin == NULL) {
+        return true;
+    }
+    return !(claimed_pins[pin->port] & (pin->pad));
 }
 
 void common_hal_never_reset_pin(const mcu_pin_obj_t *pin) {
+    if ((pin != NULL) && (pin->pad != INVALID_PIN)) {
+        never_reset_pins[pin->port] |= (1 << pin->pad);
+
+        // any never reset pin must also be claimed
+        claimed_pins[pin->port] |= (1 << pin->pad);
+    }
 }
 
 void common_hal_reset_pin(const mcu_pin_obj_t *pin) {
-}
+    if (pin == NULL) {
+        return;
+    }
 
-void common_hal_mcu_pin_claim(const mcu_pin_obj_t *pin) {
+    reset_pin_number(pin->port, pin->pad);
 }
 
-void common_hal_mcu_pin_claim_number(uint8_t pin_no) {
+void common_hal_mcu_pin_claim(const mcu_pin_obj_t *pin) {
+    if (pin == NULL) {
+        return;
+    }
+    claimed_pins[pin->port] |= (1 << pin->pad);
 }
 
 void common_hal_mcu_pin_reset_number(uint8_t pin_no) {
+    reset_pin_number(pin_no / 32, pin_no & 32);
 }

ports/analog/common-hal/microcontroller/Pin.h

@@ -8,7 +8,4 @@
 void reset_all_pins(void);
 // reset_pin_number takes the pin number instead of the pointer so that objects don't
 // need to store a full pointer.
-void reset_pin_number(uint8_t pin);
-void claim_pin(const mcu_pin_obj_t *pin);
-bool pin_number_is_free(uint8_t pin_number);
-void never_reset_pin_number(uint8_t pin_number);
+void reset_pin_number(uint8_t pin_port, uint8_t pin_pad);

ports/analog/mpconfigport.mk

@@ -15,22 +15,27 @@ INTERNAL_FLASH_FILESYSTEM = 1
 SPI_FLASH_FILESYSTEM = 0
 QSPI_FLASH_FILESYSTEM = 0
 
-# TODO: TEST filesystem & general bringup!
+# TODO: Test/Debug fs & general bringup
 DISABLE_FILESYSTEM = 0
 
+# TODO: Test/Debug TinyUSB!
+# Builds clean; need to test
+CIRCUITPY_TINYUSB = 1
+CIRCUITPY_USB_DEVICE ?= 1
+CIRCUITPY_USB_CDC ?= 1
+CIRCUITPY_USB_HID ?= 0
+CIRCUITPY_USB_MIDI ?= 0
+
 ####################################################################################
 # Suggested config for first-time porting
 ####################################################################################
 # These modules are implemented in ports/<port>/common-hal:
 
-# Typically the first module to create
-CIRCUITPY_MICROCONTROLLER ?= 1
 # Typically the second module to create
 CIRCUITPY_DIGITALIO ?= 0
 
 # Plan to implement
 CIRCUITPY_BUSIO ?= 0
-CIRCUITPY_OS ?= 1
 CIRCUITPY_RTC ?= 0
 
 # Other modules (may or may not implement):
@@ -58,17 +63,10 @@ CIRCUITPY_BITBANGIO ?= 0
 CIRCUITPY_PIXELBUF ?= 0
 # Requires OS
 CIRCUITPY_RANDOM ?= 0
-# Requires OS, filesystem
-CIRCUITPY_STORAGE ?= 0
 # Requires Microcontroller
 CIRCUITPY_TOUCHIO ?= 0
 # Requires UART
 CIRCUITPY_CONSOLE_UART ?= 0
-# Requires USB
-CIRCUITPY_USB_DEVICE ?= 0
-CIRCUITPY_USB_CDC ?= 0
-CIRCUITPY_USB_HID ?= 0
-CIRCUITPY_USB_MIDI ?= 0
 # Does nothing without I2C
 CIRCUITPY_REQUIRE_I2C_PULLUPS = 0
 
@@ -83,7 +81,3 @@ CIRCUITPY_ULAB = 1
 CIRCUITPY_BLEIO_HCI = 0
 CIRCUITPY_KEYPAD = 0
 CIRCUITPY_BUSDEVICE = 0
-
-# TinyUSB will be added later.
-CIRCUITPY_TINYUSB = 0
-CIRCUITPY_PYUSB = 0

ports/analog/supervisor/usb.c

@@ -0,0 +1,40 @@
+
+#include "supervisor/usb.h"
+#include "common-hal/microcontroller/Pin.h"
+
+#include "py/mpconfig.h"
+
+#include "lib/tinyusb/src/device/usbd.h"
+
+// max32 includes
+#include "mxc_sys.h"
+#include "gcr_regs.h"
+#include "mcr_regs.h"
+
+void init_usb_hardware(void) {
+    // USB GPIOs are non-configurable on MAX32 devices
+    // No need to add them to the never_reset list for mcu/Pin API.
+
+    // 1 ms SysTick initialized in board.c
+    // todo: consider moving SysTick initialization here?
+
+    // Enable requisite clocks & power for USB
+    MXC_SYS_ClockSourceEnable(MXC_SYS_CLOCK_IPO);
+    MXC_MCR->ldoctrl |= MXC_F_MCR_LDOCTRL_0P9EN;
+    MXC_SYS_ClockEnable(MXC_SYS_PERIPH_CLOCK_USB);
+    MXC_SYS_Reset_Periph(MXC_SYS_RESET0_USB);
+
+    // Supervisor calls TinyUSB's dcd_init,
+    // which initializes the USB PHY.
+    // Dep. on CIRCUITPY_TINYUSB and CIRCUITPY_USB_DEVICE
+
+    // Interrupt enables are left to TUSB depending on the device class
+    // todo: confirm with testing!
+}
+
+void USB_IRQHandler(void)
+{
+    // Schedules USB background callback
+    // appropriate to a given device class via TinyUSB lib
+    usb_irq_handler(0);
+}