Merge pull request #5422 from Neradoc/nera-secondary-I2C

Allow multiple board buses

Author: tannewt

main.c

@@ -290,10 +290,10 @@ STATIC void cleanup_after_vm(supervisor_allocation *heap, mp_obj_t exception) {
     keypad_reset();
     #endif
 
-    // reset_board_busses() first because it may release pins from the never_reset state, so that
+    // reset_board_buses() first because it may release pins from the never_reset state, so that
     // reset_port() can reset them.
     #if CIRCUITPY_BOARD
-    reset_board_busses();
+    reset_board_buses();
     #endif
     reset_port();
     reset_board();

ports/atmel-samd/boards/hallowing_m0_express/board.c

@@ -71,7 +71,7 @@ uint8_t display_init_sequence[] = {
 void board_init(void) {
     displayio_fourwire_obj_t *bus = &displays[0].fourwire_bus;
     bus->base.type = &displayio_fourwire_type;
-    busio_spi_obj_t *spi = common_hal_board_create_spi();
+    busio_spi_obj_t *spi = common_hal_board_create_spi(0);
     common_hal_busio_spi_never_reset(spi);
     common_hal_displayio_fourwire_construct(bus,
         spi,

ports/atmel-samd/boards/ugame10/board.c

@@ -72,7 +72,7 @@ uint8_t display_init_sequence[] = {
 void board_init(void) {
     displayio_fourwire_obj_t *bus = &displays[0].fourwire_bus;
     bus->base.type = &displayio_fourwire_type;
-    busio_spi_obj_t *spi = common_hal_board_create_spi();
+    busio_spi_obj_t *spi = common_hal_board_create_spi(0);
     common_hal_displayio_fourwire_construct(bus,
         spi,
         &pin_PA09, // Command or data

ports/espressif/boards/adafruit_esp32s2_camera/board.c

@@ -51,7 +51,7 @@ uint8_t display_init_sequence[] = {
 };
 
 void board_init(void) {
-    busio_spi_obj_t *spi = common_hal_board_create_spi();
+    busio_spi_obj_t *spi = common_hal_board_create_spi(0);
     displayio_fourwire_obj_t *bus = &displays[0].fourwire_bus;
     bus->base.type = &displayio_fourwire_type;
     common_hal_displayio_fourwire_construct(bus,

ports/espressif/boards/adafruit_feather_esp32s2_tft/board.c

@@ -78,7 +78,7 @@ void board_init(void) {
     gpio_set_direction(21, GPIO_MODE_DEF_OUTPUT);
     gpio_set_level(21, true);
 
-    busio_spi_obj_t *spi = common_hal_board_create_spi();
+    busio_spi_obj_t *spi = common_hal_board_create_spi(0);
     displayio_fourwire_obj_t *bus = &displays[0].fourwire_bus;
     bus->base.type = &displayio_fourwire_type;
 

ports/raspberrypi/boards/adafruit_qtpy_rp2040/mpconfigboard.h

@@ -4,12 +4,12 @@
 #define MICROPY_HW_NEOPIXEL (&pin_GPIO12)
 #define CIRCUITPY_STATUS_LED_POWER (&pin_GPIO11)
 
-#define DEFAULT_I2C_BUS_SCL (&pin_GPIO25)
-#define DEFAULT_I2C_BUS_SDA (&pin_GPIO24)
+#define CIRCUITPY_BOARD_I2C         (2)
+#define CIRCUITPY_BOARD_I2C_PIN     {{.scl = &pin_GPIO25, .sda = &pin_GPIO24}, \
+                                     {.scl = &pin_GPIO23, .sda = &pin_GPIO22}}
 
-#define DEFAULT_SPI_BUS_SCK (&pin_GPIO6)
-#define DEFAULT_SPI_BUS_MOSI (&pin_GPIO3)
-#define DEFAULT_SPI_BUS_MISO (&pin_GPIO4)
+#define CIRCUITPY_BOARD_SPI         (1)
+#define CIRCUITPY_BOARD_SPI_PIN     {{.clock = &pin_GPIO6, .mosi = &pin_GPIO3, .miso = &pin_GPIO4}}
 
-#define DEFAULT_UART_BUS_RX (&pin_GPIO5)
-#define DEFAULT_UART_BUS_TX (&pin_GPIO20)
+#define CIRCUITPY_BOARD_UART        (1)
+#define CIRCUITPY_BOARD_UART_PIN    {{.tx = &pin_GPIO20, .rx = &pin_GPIO5}}

ports/raspberrypi/boards/adafruit_qtpy_rp2040/pins.c

@@ -1,5 +1,7 @@
 #include "shared-bindings/board/__init__.h"
 
+CIRCUITPY_BOARD_BUS_SINGLETON(stemma_i2c, i2c, 1)
+
 STATIC const mp_rom_map_elem_t board_module_globals_table[] = {
     CIRCUITPYTHON_BOARD_DICT_STANDARD_ITEMS
 
@@ -47,5 +49,7 @@ STATIC const mp_rom_map_elem_t board_module_globals_table[] = {
     { MP_ROM_QSTR(MP_QSTR_I2C), MP_ROM_PTR(&board_i2c_obj) },
     { MP_ROM_QSTR(MP_QSTR_SPI), MP_ROM_PTR(&board_spi_obj) },
     { MP_ROM_QSTR(MP_QSTR_UART), MP_ROM_PTR(&board_uart_obj) },
+
+    { MP_ROM_QSTR(MP_QSTR_STEMMA_I2C), MP_ROM_PTR(&board_stemma_i2c_obj) },
 };
 MP_DEFINE_CONST_DICT(board_module_globals, board_module_globals_table);

py/circuitpy_mpconfig.h

@@ -259,22 +259,41 @@ typedef long mp_off_t;
 #error No *_FLASH_FILESYSTEM set!
 #endif
 
-// These CIRCUITPY_xxx values should all be defined in the *.mk files as being on or off.
-// So if any are not defined in *.mk, they'll throw an error here.
+// Default board buses.
 
-#if CIRCUITPY_BOARD
-#define BOARD_I2C (defined(DEFAULT_I2C_BUS_SDA) && defined(DEFAULT_I2C_BUS_SCL))
-#define BOARD_SPI (defined(DEFAULT_SPI_BUS_SCK) && defined(DEFAULT_SPI_BUS_MISO) && defined(DEFAULT_SPI_BUS_MOSI))
-#define BOARD_UART (defined(DEFAULT_UART_BUS_RX) && defined(DEFAULT_UART_BUS_TX))
-// I2C and SPI are always allocated off the heap.
-#if BOARD_UART
-#define BOARD_UART_ROOT_POINTER mp_obj_t shared_uart_bus;
+#ifndef CIRCUITPY_BOARD_I2C
+#if defined(DEFAULT_I2C_BUS_SCL) && defined(DEFAULT_I2C_BUS_SDA)
+#define CIRCUITPY_BOARD_I2C     (1)
+#define CIRCUITPY_BOARD_I2C_PIN {{.scl = DEFAULT_I2C_BUS_SCL, .sda = DEFAULT_I2C_BUS_SDA}}
 #else
-#define BOARD_UART_ROOT_POINTER
+#define CIRCUITPY_BOARD_I2C     (0)
+#endif
+#endif
+
+#ifndef CIRCUITPY_BOARD_SPI
+#if defined(DEFAULT_SPI_BUS_SCK) && defined(DEFAULT_SPI_BUS_MOSI) && defined(DEFAULT_SPI_BUS_MISO)
+#define CIRCUITPY_BOARD_SPI     (1)
+#define CIRCUITPY_BOARD_SPI_PIN {{.clock = DEFAULT_SPI_BUS_SCK, .mosi = DEFAULT_SPI_BUS_MOSI, .miso = DEFAULT_SPI_BUS_MISO}}
+#else
+#define CIRCUITPY_BOARD_SPI     (0)
 #endif
+#endif
+
+#ifndef CIRCUITPY_BOARD_UART
+#if defined(DEFAULT_UART_BUS_TX) && defined(DEFAULT_UART_BUS_RX)
+#define CIRCUITPY_BOARD_UART        (1)
+#define CIRCUITPY_BOARD_UART_PIN    {{.tx = DEFAULT_UART_BUS_TX, .rx = DEFAULT_UART_BUS_RX}}
+#define BOARD_UART_ROOT_POINTER     mp_obj_t board_uart_bus;
 #else
+#define CIRCUITPY_BOARD_UART        (0)
 #define BOARD_UART_ROOT_POINTER
 #endif
+#else
+#define BOARD_UART_ROOT_POINTER     mp_obj_t board_uart_bus;
+#endif
+
+// These CIRCUITPY_xxx values should all be defined in the *.mk files as being on or off.
+// So if any are not defined in *.mk, they'll throw an error here.
 
 #if CIRCUITPY_DISPLAYIO
 #ifndef CIRCUITPY_DISPLAY_LIMIT

shared-bindings/board/__init__.c

@@ -28,12 +28,15 @@
 #include "py/runtime.h"
 
 #include "shared-bindings/board/__init__.h"
-#if BOARD_I2C
+#if CIRCUITPY_BOARD_I2C
 #include "shared-bindings/busio/I2C.h"
 #endif
-#if BOARD_SPI
+#if CIRCUITPY_BOARD_SPI
 #include "shared-bindings/busio/SPI.h"
 #endif
+#if CIRCUITPY_BOARD_UART
+#include "shared-bindings/busio/UART.h"
+#endif
 
 //| """Board specific pin names
 //|
@@ -47,84 +50,57 @@
 //| """Board ID string. The unique identifier for the board model in
 //| circuitpython, as well as on circuitpython.org.
 //| Example: "hallowing_m0_express"."""
-//|
 
 //| def I2C() -> busio.I2C:
-//|     """Returns the `busio.I2C` object for the board designated SDA and SCL pins. It is a singleton."""
+//|     """Returns the `busio.I2C` object for the board's designated I2C bus(es).
+//|     The object created is a singleton, and uses the default parameter values for `busio.I2C`."""
 //|     ...
 //|
-
-#if BOARD_I2C
-mp_obj_t board_i2c(void) {
-    mp_obj_t singleton = common_hal_board_get_i2c();
-    if (singleton != NULL && !common_hal_busio_i2c_deinited(singleton)) {
-        return singleton;
-    }
-    assert_pin_free(DEFAULT_I2C_BUS_SDA);
-    assert_pin_free(DEFAULT_I2C_BUS_SCL);
-    return common_hal_board_create_i2c();
+#if CIRCUITPY_BOARD_I2C
+STATIC mp_obj_t board_i2c_0(void) {
+    return common_hal_board_create_i2c(0);
 }
 #else
-mp_obj_t board_i2c(void) {
+STATIC mp_obj_t board_i2c_0(void) {
     mp_raise_NotImplementedError_varg(translate("No default %q bus"), MP_QSTR_I2C);
     return MP_ROM_NONE;
 }
 #endif
-MP_DEFINE_CONST_FUN_OBJ_0(board_i2c_obj, board_i2c);
-
+MP_DEFINE_CONST_FUN_OBJ_0(board_i2c_obj, board_i2c_0);
 
 //| def SPI() -> busio.SPI:
-//|     """Returns the `busio.SPI` object for the board designated SCK, MOSI and MISO pins. It is a
-//|     singleton."""
+//|     """Returns the `busio.SPI` object for the board's designated SPI bus(es).
+//|     The object created is a singleton, and uses the default parameter values for `busio.SPI`."""
 //|     ...
 //|
-#if BOARD_SPI
-mp_obj_t board_spi(void) {
-    mp_obj_t singleton = common_hal_board_get_spi();
-    if (singleton != NULL && !common_hal_busio_spi_deinited(singleton)) {
-        return singleton;
-    }
-    assert_pin_free(DEFAULT_SPI_BUS_SCK);
-    assert_pin_free(DEFAULT_SPI_BUS_MOSI);
-    assert_pin_free(DEFAULT_SPI_BUS_MISO);
-    return common_hal_board_create_spi();
+#if CIRCUITPY_BOARD_SPI
+STATIC mp_obj_t board_spi_0(void) {
+    return common_hal_board_create_spi(0);
 }
 #else
-mp_obj_t board_spi(void) {
+STATIC mp_obj_t board_spi_0(void) {
     mp_raise_NotImplementedError_varg(translate("No default %q bus"), MP_QSTR_SPI);
     return MP_ROM_NONE;
 }
 #endif
-MP_DEFINE_CONST_FUN_OBJ_0(board_spi_obj, board_spi);
+MP_DEFINE_CONST_FUN_OBJ_0(board_spi_obj, board_spi_0);
 
 //| def UART() -> busio.UART:
-//|     """Returns the `busio.UART` object for the board designated TX and RX pins. It is a singleton.
-//|
-//|     The object created uses the default parameter values for `busio.UART`. If you need to set
-//|     parameters that are not changeable after creation, such as ``receiver_buffer_size``,
-//|     do not use `board.UART()`; instead create a `busio.UART` object explicitly with the
-//|     desired parameters."""
+//|     """Returns the `busio.UART` object for the board's designated UART bus(es).
+//|     The object created is a singleton, and uses the default parameter values for `busio.UART`."""
 //|     ...
 //|
-#if BOARD_UART
-mp_obj_t board_uart(void) {
-    mp_obj_t singleton = common_hal_board_get_uart();
-    if (singleton != NULL) {
-        return singleton;
-    }
-
-    assert_pin_free(DEFAULT_UART_BUS_RX);
-    assert_pin_free(DEFAULT_UART_BUS_TX);
-
-    return common_hal_board_create_uart();
+#if CIRCUITPY_BOARD_UART
+STATIC mp_obj_t board_uart_0(void) {
+    return common_hal_board_create_uart(0);
 }
 #else
-mp_obj_t board_uart(void) {
+STATIC mp_obj_t board_uart_0(void) {
     mp_raise_NotImplementedError_varg(translate("No default %q bus"), MP_QSTR_UART);
     return MP_ROM_NONE;
 }
 #endif
-MP_DEFINE_CONST_FUN_OBJ_0(board_uart_obj, board_uart);
+MP_DEFINE_CONST_FUN_OBJ_0(board_uart_obj, board_uart_0);
 
 const mp_obj_module_t board_module = {
     .base = { &mp_type_module },

shared-bindings/board/__init__.h

@@ -35,21 +35,29 @@
 extern const mp_obj_dict_t board_module_globals;
 STATIC const MP_DEFINE_STR_OBJ(board_module_id_obj, CIRCUITPY_BOARD_ID);
 
-mp_obj_t common_hal_board_get_i2c(void);
-mp_obj_t common_hal_board_create_i2c(void);
+bool common_hal_board_is_i2c(mp_obj_t obj);
+mp_obj_t common_hal_board_get_i2c(const mp_int_t instance);
+mp_obj_t common_hal_board_create_i2c(const mp_int_t instance);
+mp_obj_t board_i2c(size_t n_args, const mp_obj_t *args);
 MP_DECLARE_CONST_FUN_OBJ_0(board_i2c_obj);
 
-mp_obj_t common_hal_board_get_spi(void);
-mp_obj_t common_hal_board_create_spi(void);
+bool common_hal_board_is_spi(mp_obj_t obj);
+mp_obj_t common_hal_board_get_spi(const mp_int_t instance);
+mp_obj_t common_hal_board_create_spi(const mp_int_t instance);
+mp_obj_t board_spi(size_t n_args, const mp_obj_t *args);
 MP_DECLARE_CONST_FUN_OBJ_0(board_spi_obj);
 
-mp_obj_t common_hal_board_get_uart(void);
-mp_obj_t common_hal_board_create_uart(void);
+bool common_hal_board_is_uart(mp_obj_t obj);
+mp_obj_t common_hal_board_get_uart(const mp_int_t instance);
+mp_obj_t common_hal_board_create_uart(const mp_int_t instance);
+mp_obj_t board_uart(size_t n_args, const mp_obj_t *args);
 MP_DECLARE_CONST_FUN_OBJ_0(board_uart_obj);
 
-mp_obj_t board_i2c(void);
-mp_obj_t board_spi(void);
-mp_obj_t board_uart(void);
+#define CIRCUITPY_BOARD_BUS_SINGLETON(name, bus, instance) \
+    STATIC mp_obj_t board_##name(void) { \
+        return common_hal_board_create_##bus(instance); \
+    } \
+    MP_DEFINE_CONST_FUN_OBJ_0(board_##name##_obj, board_##name);
 
 #define CIRCUITPYTHON_BOARD_DICT_STANDARD_ITEMS \
     { MP_ROM_QSTR(MP_QSTR___name__), MP_ROM_QSTR(MP_QSTR_board) }, \