Clean up MAX32 BUSIO drivers

- Fixed errors with peripheral bus hardware descriptions in MAX32690 "peripherals/"
- Resolved all FIXME comments
- Removed unused ringbuf API from common-hal/busio/UART.c

Signed-off-by: Brandon Hurst <[email protected]>

Author: Brandon-Hurst

ports/analog/common-hal/busio/I2C.c

@@ -155,10 +155,6 @@ void common_hal_busio_i2c_deinit(busio_i2c_obj_t *self) {
     self->scl = NULL;
 }
 
-void common_hal_busio_i2c_mark_deinit(busio_i2c_obj_t *self) {
-    // FIXME: Implement
-}
-
 // Probe device in I2C bus
 bool common_hal_busio_i2c_probe(busio_i2c_obj_t *self, uint8_t addr) {
     int nack = 0;

ports/analog/common-hal/busio/SPI.c

@@ -60,12 +60,6 @@ void spi_isr(void) {
     }
 }
 
-// Reset SPI when reload
-void spi_reset(void) {
-    // FIXME: Implement
-    return;
-}
-
 // Construct SPI protocol, this function init SPI peripheral
 // todo: figure out Chip select behavior
 void common_hal_busio_spi_construct(busio_spi_obj_t *self,
@@ -102,11 +96,9 @@ void common_hal_busio_spi_construct(busio_spi_obj_t *self,
 
     assert((self->spi_id >= 0) && (self->spi_id < NUM_SPI));
 
-    // Init I2C as main / controller node (0x00 is ignored)
-    // FIXME: MUST map the SPI pins to a spi_pins_t struct
+    // Init SPI controller
     if ((mosi != NULL) && (miso != NULL) && (sck != NULL)) {
         // spi, mastermode, quadModeUsed, numSubs, ssPolarity, frequency
-        // err = MXC_SPI_Init((mxc_spi_reva_regs_t *)self->spi_regs, 1, 0, 1, 0x00, 1000000, &spi_pins);
         err = MXC_SPI_Init(self->spi_regs, MXC_SPI_TYPE_CONTROLLER, MXC_SPI_INTERFACE_STANDARD,
             1, 0x01, 1000000, spi_pins);
         MXC_GPIO_SetVSSEL(MXC_GPIO_GET_GPIO(sck->port), MXC_GPIO_VSSEL_VDDIOH, (sck->mask | miso->mask | mosi->mask | MXC_GPIO_PIN_0));
@@ -117,9 +109,6 @@ void common_hal_busio_spi_construct(busio_spi_obj_t *self,
         mp_raise_NotImplementedError(MP_ERROR_TEXT("SPI needs MOSI, MISO, and SCK"));
     }
 
-    // FIXME: Debugging
-
-
     // Attach SPI pins
     self->mosi = mosi;
     self->miso = miso;

ports/analog/common-hal/busio/UART.c

@@ -96,7 +96,7 @@ static uint32_t timeout_ms = 0;
 static uint8_t uarts_active = 0;
 static uart_status_t uart_status[NUM_UARTS];
 static volatile int uart_err;
-// static uint8_t uart_never_reset_mask = 0;
+static uint8_t uart_never_reset_mask = 0;
 
 static int isValidBaudrate(uint32_t baudrate) {
     switch (baudrate) {
@@ -167,8 +167,7 @@ void common_hal_busio_uart_construct(busio_uart_obj_t *self,
     const mcu_pin_obj_t *rts, const mcu_pin_obj_t *cts,
     const mcu_pin_obj_t *rs485_dir, bool rs485_invert,
     uint32_t baudrate, uint8_t bits, busio_uart_parity_t parity, uint8_t stop,
-    mp_float_t timeout, uint16_t receiver_buffer_size, byte *receiver_buffer,
-    bool sigint_enabled) {
+    mp_float_t timeout, bool sigint_enabled) {
     int err, temp;
 
     // Check for NULL Pointers && valid UART settings
@@ -236,21 +235,6 @@ void common_hal_busio_uart_construct(busio_uart_obj_t *self,
     self->baudrate = baudrate;
     self->error = E_NO_ERROR;
 
-    // Initialize ringbuffer for receiving data
-    // FIXME: Either the use the ringbuf or get rid of it!
-    if (self->rx_pin) {
-        // if given a ringbuff, use that
-        if (receiver_buffer) {
-            ringbuf_init(&self->ringbuf, receiver_buffer, receiver_buffer_size);
-        }
-        // else create one and attach it
-        else {
-            if (!ringbuf_alloc(&self->ringbuf, receiver_buffer_size)) {
-                m_malloc_fail(receiver_buffer_size);
-            }
-        }
-    }
-
     // Indicate to this module that the UART is active
     uarts_active |= (1 << self->uart_id);
 
@@ -277,6 +261,7 @@ void common_hal_busio_uart_deinit(busio_uart_obj_t *self) {
         // First disable the ISR to avoid pre-emption
         NVIC_DisableIRQ(UART0_IRQn);
 
+        // Shutdown the UART Controller
         MXC_UART_Shutdown(self->uart_regs);
         self->error = E_UNINITIALIZED;
 
@@ -307,7 +292,7 @@ bool common_hal_busio_uart_deinited(busio_uart_obj_t *self) {
     };
 }
 
-// Read characters. len is in characters NOT bytes!
+// Read characters. len is in characters.
 size_t common_hal_busio_uart_read(busio_uart_obj_t *self,
     uint8_t *data, size_t len, int *errcode) {
     int err;
@@ -474,7 +459,7 @@ void common_hal_busio_uart_never_reset(busio_uart_obj_t *self) {
     common_hal_never_reset_pin(self->rx_pin);
     common_hal_never_reset_pin(self->cts_pin);
     common_hal_never_reset_pin(self->rts_pin);
-    // uart_never_reset_mask |= ( 1 << (self->uart_id) );
+    uart_never_reset_mask |= (1 << (self->uart_id));
 }
 
 #endif // CIRCUITPY_BUSIO_UART

ports/analog/common-hal/busio/UART.h

@@ -33,8 +33,6 @@ typedef struct {
     int error;
     float timeout;
 
-    ringbuf_t ringbuf;
-
     const mcu_pin_obj_t *rx_pin;
     const mcu_pin_obj_t *tx_pin;
     const mcu_pin_obj_t *rts_pin;

ports/analog/peripherals/max32690/max32_i2c.c

@@ -20,7 +20,7 @@
      *
      * See MAX32690 Rev A2 Errata #16:
      * https://www.analog.com/media/en/technical-documentation/data-sheets/max32690_a2_errata_rev2.pdf
-     * 
+     *
      * Additionally, note that the TQFN package does not expose some of the duplicate pins.  For this package,
      * enabling the un-routed GPIOs has been shown to cause initialization issues with the I2C block.
      * To work around this, "MAX32690GTK_PACKAGE_TQFN" can be defined by the build system.  The recommend place
@@ -30,13 +30,13 @@
 const mxc_gpio_cfg_t i2c_maps[NUM_I2C] = {
     // I2C0
     { MXC_GPIO2, (MXC_GPIO_PIN_7 | MXC_GPIO_PIN_8), MXC_GPIO_FUNC_ALT1,
-        MXC_GPIO_PAD_NONE, MXC_GPIO_VSSEL_VDDIO, MXC_GPIO_DRVSTR_0 };
+      MXC_GPIO_PAD_NONE, MXC_GPIO_VSSEL_VDDIO, MXC_GPIO_DRVSTR_0 },
     // I2C1
     { MXC_GPIO0, (MXC_GPIO_PIN_11 | MXC_GPIO_PIN_12), MXC_GPIO_FUNC_ALT1,
-        MXC_GPIO_PAD_NONE, MXC_GPIO_VSSEL_VDDIO, MXC_GPIO_DRVSTR_0 };
+      MXC_GPIO_PAD_NONE, MXC_GPIO_VSSEL_VDDIO, MXC_GPIO_DRVSTR_0 },
     // I2C2
     { MXC_GPIO1, (MXC_GPIO_PIN_7 | MXC_GPIO_PIN_8), MXC_GPIO_FUNC_ALT3,
-        MXC_GPIO_PAD_NONE, MXC_GPIO_VSSEL_VDDIOH, MXC_GPIO_DRVSTR_0 };,
+      MXC_GPIO_PAD_NONE, MXC_GPIO_VSSEL_VDDIOH, MXC_GPIO_DRVSTR_0 },
 };
 #ifndef MAX32690GTK_PACKAGE_TQFN
 const mxc_gpio_cfg_t i2c_maps_extra[NUM_I2C] = {
@@ -48,7 +48,7 @@ const mxc_gpio_cfg_t i2c_maps_extra[NUM_I2C] = {
       MXC_GPIO_PAD_PULL_UP, MXC_GPIO_VSSEL_VDDIOH, MXC_GPIO_DRVSTR_0 },
     // I2C2C
     { MXC_GPIO0, (MXC_GPIO_PIN_13 | MXC_GPIO_PIN_14), MXC_GPIO_FUNC_ALT3,
-        MXC_GPIO_PAD_NONE, MXC_GPIO_VSSEL_VDDIO, MXC_GPIO_DRVSTR_0 };,
+      MXC_GPIO_PAD_NONE, MXC_GPIO_VSSEL_VDDIO, MXC_GPIO_DRVSTR_0 },
 };
 #endif
 

ports/analog/peripherals/max32690/max32_i2c.h

@@ -11,6 +11,6 @@
 #include "i2c.h"
 #include "peripherals/pins.h"
 
-#define NUM_I2C 2
+#define NUM_I2C 3
 
 int pinsToI2c(const mcu_pin_obj_t *sda, const mcu_pin_obj_t *scl);

ports/analog/peripherals/max32690/max32_spi.c

@@ -16,7 +16,7 @@
 const mxc_gpio_cfg_t spi_maps[NUM_SPI] = {
     // SPI0
     { MXC_GPIO2, (MXC_GPIO_PIN_27 | MXC_GPIO_PIN_28 | MXC_GPIO_PIN_29),
-    MXC_GPIO_FUNC_ALT2, MXC_GPIO_PAD_NONE, MXC_GPIO_VSSEL_VDDIO, MXC_GPIO_DRVSTR_0 };
+      MXC_GPIO_FUNC_ALT2, MXC_GPIO_PAD_NONE, MXC_GPIO_VSSEL_VDDIO, MXC_GPIO_DRVSTR_0 },
     // SPI1
     { MXC_GPIO1, (MXC_GPIO_PIN_26 | MXC_GPIO_PIN_28 | MXC_GPIO_PIN_29),
       MXC_GPIO_FUNC_ALT1, MXC_GPIO_PAD_NONE, MXC_GPIO_VSSEL_VDDIO, MXC_GPIO_DRVSTR_0 },

ports/analog/peripherals/max32690/max32_uart.c

@@ -18,14 +18,14 @@ const mxc_gpio_cfg_t uart_maps[NUM_UARTS] = {
       MXC_GPIO_PAD_WEAK_PULL_UP, MXC_GPIO_VSSEL_VDDIO, MXC_GPIO_DRVSTR_0 },
     { MXC_GPIO2, (MXC_GPIO_PIN_14 | MXC_GPIO_PIN_16), MXC_GPIO_FUNC_ALT1,
       MXC_GPIO_PAD_WEAK_PULL_UP, MXC_GPIO_VSSEL_VDDIO, MXC_GPIO_DRVSTR_0 },
-    { MXC_GPIO1, (MXC_GPIO_PIN_9 | MXC_GPIO_PIN_10), MXC_GPIO_FUNC_ALT1, 
+    { MXC_GPIO1, (MXC_GPIO_PIN_9 | MXC_GPIO_PIN_10), MXC_GPIO_FUNC_ALT1,
       MXC_GPIO_PAD_WEAK_PULL_UP, MXC_GPIO_VSSEL_VDDIO, MXC_GPIO_DRVSTR_0 },
-    { MXC_GPIO3, (MXC_GPIO_PIN_0 | MXC_GPIO_PIN_1), MXC_GPIO_FUNC_ALT2, 
+    { MXC_GPIO3, (MXC_GPIO_PIN_0 | MXC_GPIO_PIN_1), MXC_GPIO_FUNC_ALT2,
       MXC_GPIO_PAD_WEAK_PULL_UP, MXC_GPIO_VSSEL_VDDIO, MXC_GPIO_DRVSTR_0 }
 };
 
 int pinsToUart(const mcu_pin_obj_t *rx, const mcu_pin_obj_t *tx) {
-    for (int i = 0; i < uart_entries; i++) {
+    for (int i = 0; i < NUM_UARTS; i++) {
         if ((uart_maps[i].port == (MXC_GPIO_GET_GPIO(tx->port)))
             && (uart_maps[i].mask == ((tx->mask) | (rx->mask)))) {
             return i;