Add busio support for ADI MAX32xxx port #10413

Brandon-Hurst · 2025-06-10T18:01:18Z

Add BUSIO Support for supported MAX32xxx devices. Not all capable MAX32 devices are supported yet; more support for MAX32650/MAX32666/MAX78002 boards may be added in a future PR. This module was tested on a MAX32690 board, the AD-APARD32690-SL. I used a ADT7140 I2C and MAX31723 SPI temperature sensor, and also tested the UART via the debug port serial connection.

BUSIO support added for MAX32 devices
Peripherals enumerated in peripherals/max32690 for MAX32690 MCU, including helper functions for mapping a set of pins to the associated on-chip peripheral
common-hal/busio contains the implementation of the BUSIO port functions

MAX31723 (SPI):

ADT7420 (I2C):

A simple echo test was done with UART as well with no issues:

from board import *
from busio import UART
 
# init uart with timeout of 10 seconds
uart = UART(P2_12, P2_11, baudrate=115200, timeout = 10.0)
 
# Write 'hello' to another serial port
uart.write('hello\n')
 
# Read 5 characters
uart.read(5)
 
# Read until newline
uart.readline()

- Enabled BUSIO in mpconfigport.mk - Stubs added for busio.I2C & busio.SPI - Implemented busio.UART to basic working functionality - Added MCU-specific UART data in peripherals/<mcu>/max32_uart.c & max32_uart.h - Still have a couple issues where UART generates garbage characters or does not respond to timeouts / generate asynchronous IRQs

- Add debug-dap.sh to spawn OpenOCD process & gdb-multiarch process for debugging. Requires MaximSDK install & path settings inside this script. Also depends on gdb-multiarch and connected CMSIS-DAP probe over USB. - debug-dap.gdb simply holds the gdb commands for this script + small style fix on common-hal/microcontroller/Pin.c

- Graceful recovery from timeouts added - Remaining issue still exists where a timeout occurs after a while

- No ISR for UART writes, but uses timeouts - Reads use ISRs, but also incorporate timeouts

- Formatting & codespell fixes from pre-commit

- Call NVIC_SetRAM in supervisor/port.c to move NVIC table to RAM, enabling ISR RAM remapping. - Rename UART ISR to be generic for any UART IRQn. - Remove background led writes from background.c.

- Data structure and constructor for I2C (tested) - Lock and probing functions complete and tested TODO: Implement I2C Write, Read, Wr/Rd Signed-off-by: Brandon-Hurst <brandon.hurst97@gmail.com>

Currently coupled a bit to APARD32690-SL board. Will refactor after testing BUSIO.SPI Signed-off-by: Brandon-Hurst <brandon.hurst97@gmail.com>

TODO: - Figure out assigning CS Pins for SPI - Test & Debug SPI / I2C Signed-off-by: Brandon-Hurst <brandon.hurst97@gmail.com>

Signed-off-by: Brandon-Hurst <brandon.hurst97@gmail.com>

…ipherals. Signed-off-by: Brandon-Hurst <brandon.hurst97@gmail.com>

Also reformatted pinmaps for SPI/I2C/UART on MAX32690 Signed-off-by: Brandon Hurst <brandon.hurst@analog.com>

- 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 <brandon.hurst@analog.com>

Signed-off-by: Brandon Hurst <brandon.hurst@analog.com>

- Add correct ringbuffer handling code to ports/analog/common-hal/UART.c Signed-off-by: Brandon Hurst <brandon.hurst@analog.com>

Signed-off-by: Brandon Hurst <brandon.hurst@analog.com>

- Used direct hardware values to rely on common HW implementation - Accounted for TX Lockout conditions in Transmit FIFO causing errors Signed-off-by: Brandon Hurst <brandon.hurst@analog.com>

Signed-off-by: Brandon Hurst <brandon.hurst@analog.com>

- Probe function caused infinite loops / unreliable ACK values - Replaced with probe-function with low-level routines Signed-off-by: Brandon Hurst <brandon.hurst@analog.com>

Signed-off-by: Brandon Hurst <brandon.hurst@analog.com>

dhalbert

Thanks for continuing to flesh this out. The changes here are stylistic, to match how we do error messages, etc. elsewhere.

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

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

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

ports/analog/peripherals/max32690/max32_spi.c

ports/analog/peripherals/max32690/max32_i2c.c

ports/analog/peripherals/max32690/max32_uart.c

- Use existing error messages from locale/circuitpython.pot for most error messages - Replace ConnectionError (networking specific) calls with others (usually RuntimeError) - Remove '\n' from mp error calls (since they add it already) - Remove some redundant validation code that repeats checks done by shared-bindings/common-hal/busio code. e.g. pin validation Signed-off-by: Brandon-Hurst <brandon.hurst97@gmail.com>

- Use m_malloc_without_collect storage API change from CircuitPython - Remove err number for asynchronous read error; just report it Signed-off-by: Brandon-Hurst <brandon.hurst97@gmail.com>

- Remove excess argument from UART ringbuf malloc call - Remove unused err and intfl0 in I2C driver to remove warnings Signed-off-by: Brandon-Hurst <brandon.hurst97@gmail.com>

Brandon-Hurst · 2025-07-05T19:47:09Z

Thanks for the comments, Dan! Helpful stuff. I have implemented the requested changes to the error reporting -- should be ready for another review now.

Signed-off-by: Brandon-Hurst <brandon.hurst97@gmail.com>

dhalbert

Thanks for the error message cleanup! I found a few more cases that could be changed or I had questions about. Thanks for your patience on the review.

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

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

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

- Reuse more messages in locales/circuitpython.pot in BUSIO - Remove UART write timeout - Refine some error handling for SPI initialization Signed-off-by: Brandon-Hurst <brandon.hurst97@gmail.com>

Brandon-Hurst · 2025-07-11T05:21:53Z

Sure thing, I appreciate the thorough feedback :) latest round should be cleaned up now.

Brandon-Hurst and others added 23 commits June 10, 2025 10:52

Setup files for busio

5052177

Add default build for analog ports for apard32690 board.

0220236

Fixed most UART write issues.

8848d43

- Graceful recovery from timeouts added - Remaining issue still exists where a timeout occurs after a while

Fix issues with UART reads and unreliable UART writes.

872e81c

- No ISR for UART writes, but uses timeouts - Reads use ISRs, but also incorporate timeouts

Add pre-commit changes to UART

d47b882

- Formatting & codespell fixes from pre-commit

Resolve UART ISR naming issues

68d8daa

- Call NVIC_SetRAM in supervisor/port.c to move NVIC table to RAM, enabling ISR RAM remapping. - Rename UART ISR to be generic for any UART IRQn. - Remove background led writes from background.c.

Add BUSIO.I2C and MAX32690 I2C structure

edf069d

- Data structure and constructor for I2C (tested) - Lock and probing functions complete and tested TODO: Implement I2C Write, Read, Wr/Rd Signed-off-by: Brandon-Hurst <brandon.hurst97@gmail.com>

Add hardware mapping for BUSIO.SPI for MAX32690

6967949

Currently coupled a bit to APARD32690-SL board. Will refactor after testing BUSIO.SPI Signed-off-by: Brandon-Hurst <brandon.hurst97@gmail.com>

Add complete BUSIO driver structure for SPI & I2C.

a81ea5e

TODO: - Figure out assigning CS Pins for SPI - Test & Debug SPI / I2C Signed-off-by: Brandon-Hurst <brandon.hurst97@gmail.com>

Add call to MXC_DelayHandler in SysTick ISR

ddd4cf6

Signed-off-by: Brandon-Hurst <brandon.hurst97@gmail.com>

Corrected I2C & SPI. Tested with example scripts; works with real per…

32c6b3e

…ipherals. Signed-off-by: Brandon-Hurst <brandon.hurst97@gmail.com>

Add extra I2C options for MAX32690 non-TQFN packages

88099be

Also reformatted pinmaps for SPI/I2C/UART on MAX32690 Signed-off-by: Brandon Hurst <brandon.hurst@analog.com>

Clean up MAX32 BUSIO drivers

5cf0305

- 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 <brandon.hurst@analog.com>

Cleanup copy-paste comments in MAX32 busio files

deda980

Signed-off-by: Brandon Hurst <brandon.hurst@analog.com>

Correct ringbuffer code for ports/analog BUSIO

0f9ea29

- Add correct ringbuffer handling code to ports/analog/common-hal/UART.c Signed-off-by: Brandon Hurst <brandon.hurst@analog.com>

Update jlink script for ports/analog

a305ece

Signed-off-by: Brandon Hurst <brandon.hurst@analog.com>

Refactor ports/analog/common-hal/busio i2c probe function.

cbbf34d

- Used direct hardware values to rely on common HW implementation - Accounted for TX Lockout conditions in Transmit FIFO causing errors Signed-off-by: Brandon Hurst <brandon.hurst@analog.com>

Expand command in ports/analog/tools/flash_max32.jlink for clarity.

c3ea182

Signed-off-by: Brandon Hurst <brandon.hurst@analog.com>

Fix i2c scan bug with ports/analog/ BUSIO.

db95dd0

- Probe function caused infinite loops / unreliable ACK values - Replaced with probe-function with low-level routines Signed-off-by: Brandon Hurst <brandon.hurst@analog.com>

Add translations for ports/analog/busio

9b8e08f

Signed-off-by: Brandon Hurst <brandon.hurst@analog.com>

Merge branch 'main' into ports/analog/add-busio

363e310

dhalbert requested changes Jun 12, 2025

View reviewed changes

Brandon-Hurst added 3 commits July 5, 2025 12:32

Minor changes in ports/analog/ busio UART.

e681c44

- Use m_malloc_without_collect storage API change from CircuitPython - Remove err number for asynchronous read error; just report it Signed-off-by: Brandon-Hurst <brandon.hurst97@gmail.com>

Fix UART malloc for ports/analog BUSIO

81c0b7d

- Remove excess argument from UART ringbuf malloc call - Remove unused err and intfl0 in I2C driver to remove warnings Signed-off-by: Brandon-Hurst <brandon.hurst97@gmail.com>

Brandon-Hurst requested a review from dhalbert July 5, 2025 19:46

Commit locale changes from ports/analog BUSIO updates

3524b1d

Signed-off-by: Brandon-Hurst <brandon.hurst97@gmail.com>

Merge branch 'main' into ports/analog/add-busio

fed3081

dhalbert requested changes Jul 8, 2025

View reviewed changes

Reuse more existing error messages in ports/analog BUSIO

bd6f5dd

- Reuse more messages in locales/circuitpython.pot in BUSIO - Remove UART write timeout - Refine some error handling for SPI initialization Signed-off-by: Brandon-Hurst <brandon.hurst97@gmail.com>

Brandon-Hurst force-pushed the ports/analog/add-busio branch from c290878 to bd6f5dd Compare July 11, 2025 05:16

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Add busio support for ADI MAX32xxx port #10413

Add busio support for ADI MAX32xxx port #10413

Brandon-Hurst commented Jun 10, 2025 •

edited

Loading

Uh oh!

dhalbert left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Brandon-Hurst commented Jul 5, 2025

Uh oh!

dhalbert left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Brandon-Hurst commented Jul 11, 2025

Uh oh!

Uh oh!

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Add busio support for ADI MAX32xxx port #10413

Are you sure you want to change the base?

Add busio support for ADI MAX32xxx port #10413

Conversation

Brandon-Hurst commented Jun 10, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

dhalbert left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Brandon-Hurst commented Jul 5, 2025

Uh oh!

dhalbert left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Brandon-Hurst commented Jul 11, 2025

Uh oh!

Uh oh!

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Brandon-Hurst commented Jun 10, 2025 •

edited

Loading