allow multiple board buses

Co-authored-by: Neradoc <[email protected]>

Author: microdev1

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

py/circuitpy_mpconfig.h

@@ -254,23 +254,38 @@ 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.
+
+#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 {DEFAULT_I2C_BUS_SCL, DEFAULT_I2C_BUS_SDA}
+#else
+#define CIRCUITPY_BOARD_I2C     (0)
+#endif
+#endif
 
-#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_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 {DEFAULT_SPI_BUS_SCK, DEFAULT_SPI_BUS_MOSI, DEFAULT_SPI_BUS_MISO}
 #else
-#define BOARD_UART_ROOT_POINTER
+#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 {DEFAULT_UART_BUS_TX, DEFAULT_UART_BUS_RX, NULL, NULL}
 #else
-#define BOARD_UART_ROOT_POINTER
+#define CIRCUITPY_BOARD_UART     (0)
+#endif
 #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
 #define CIRCUITPY_DISPLAY_LIMIT (1)
@@ -460,7 +475,6 @@ struct _supervisor_allocation_node;
     FLASH_ROOT_POINTERS \
     KEYPAD_ROOT_POINTERS \
     GAMEPAD_ROOT_POINTERS \
-    BOARD_UART_ROOT_POINTER \
     WIFI_MONITOR_ROOT_POINTERS \
     MEMORYMONITOR_ROOT_POINTERS \
     vstr_t *repl_line; \

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,85 @@
 //| """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."""
+#if CIRCUITPY_BOARD_I2C || CIRCUITPY_BOARD_SPI || CIRCUITPY_BOARD_UART
+STATIC mp_int_t board_get_instance(size_t n_args, const mp_obj_t *args, const mp_int_t bus_in) {
+    if (n_args == 0) {
+        return 0;
+    }
+    const mp_int_t instance = mp_obj_get_int(args[0]);
+    if (instance >= bus_in || instance < 0) {
+        mp_raise_ValueError_varg(translate("No default %q bus"), MP_QSTR_UART);
+    }
+    return instance;
+}
+#endif
+
+//| def I2C(instance: Optional[int] = 0) -> busio.I2C:
+//|     """Returns the `busio.I2C` object for the board's designated I2C bus(es). It is a singleton.
+//|     The object created 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 CIRCUITPY_BOARD_I2C
+mp_obj_t board_i2c(size_t n_args, const mp_obj_t *args) {
+    const mp_int_t instance = board_get_instance(n_args, args, CIRCUITPY_BOARD_I2C);
+    const mp_obj_t singleton = common_hal_board_get_i2c(instance);
     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();
+    return common_hal_board_create_i2c(instance);
 }
 #else
-mp_obj_t board_i2c(void) {
+mp_obj_t board_i2c(size_t n_args, const mp_obj_t *args) {
     mp_raise_NotImplementedError_varg(translate("No default %q bus"), MP_QSTR_I2C);
     return NULL;
 }
 #endif
-MP_DEFINE_CONST_FUN_OBJ_0(board_i2c_obj, board_i2c);
-
+MP_DEFINE_CONST_FUN_OBJ_VAR_BETWEEN(board_i2c_obj, 0, 1, board_i2c);
 
-//| def SPI() -> busio.SPI:
-//|     """Returns the `busio.SPI` object for the board designated SCK, MOSI and MISO pins. It is a
-//|     singleton."""
+//| def SPI(instance: Optional[int] = 0) -> busio.SPI:
+//|     """Returns the `busio.SPI` object for the board's designated SPI bus(es). It is a singleton.
+//|     The object created 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 CIRCUITPY_BOARD_SPI
+mp_obj_t board_spi(size_t n_args, const mp_obj_t *args) {
+    const mp_int_t instance = board_get_instance(n_args, args, CIRCUITPY_BOARD_SPI);
+    const mp_obj_t singleton = common_hal_board_get_spi(instance);
     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();
+    return common_hal_board_create_spi(instance);
 }
 #else
-mp_obj_t board_spi(void) {
+mp_obj_t board_spi(size_t n_args, const mp_obj_t *args) {
     mp_raise_NotImplementedError_varg(translate("No default %q bus"), MP_QSTR_SPI);
     return NULL;
 }
 #endif
-MP_DEFINE_CONST_FUN_OBJ_0(board_spi_obj, board_spi);
+MP_DEFINE_CONST_FUN_OBJ_VAR_BETWEEN(board_spi_obj, 0, 1, board_spi);
 
-//| 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."""
+//| def UART(instance: Optional[int] = 0) -> busio.UART:
+//|     """Returns the `busio.UART` object for the board's designated UART bus(es). It is a singleton.
+//|     The object created 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) {
+#if CIRCUITPY_BOARD_UART
+mp_obj_t board_uart(size_t n_args, const mp_obj_t *args) {
+    const mp_int_t instance = board_get_instance(n_args, args, CIRCUITPY_BOARD_UART);
+    const mp_obj_t singleton = common_hal_board_get_uart(instance);
+    if (singleton != NULL && !common_hal_busio_uart_deinited(singleton)) {
         return singleton;
     }
-
-    assert_pin_free(DEFAULT_UART_BUS_RX);
-    assert_pin_free(DEFAULT_UART_BUS_TX);
-
-    return common_hal_board_create_uart();
+    return common_hal_board_create_uart(instance);
 }
 #else
-mp_obj_t board_uart(void) {
+mp_obj_t board_uart(size_t n_args, const mp_obj_t *args) {
     mp_raise_NotImplementedError_varg(translate("No default %q bus"), MP_QSTR_UART);
     return NULL;
 }
 #endif
-MP_DEFINE_CONST_FUN_OBJ_0(board_uart_obj, board_uart);
+MP_DEFINE_CONST_FUN_OBJ_VAR_BETWEEN(board_uart_obj, 0, 1, board_uart);
 
 const mp_obj_module_t board_module = {
     .base = { &mp_type_module },

shared-bindings/board/__init__.h

@@ -35,21 +35,30 @@
 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);
-MP_DECLARE_CONST_FUN_OBJ_0(board_i2c_obj);
+bool common_hal_board_is_i2c(mp_obj_t obj);
+mp_obj_t common_hal_board_get_i2c(const mp_int_t insatnce);
+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_VAR_BETWEEN(board_i2c_obj);
 
-mp_obj_t common_hal_board_get_spi(void);
-mp_obj_t common_hal_board_create_spi(void);
-MP_DECLARE_CONST_FUN_OBJ_0(board_spi_obj);
+bool common_hal_board_is_spi(mp_obj_t obj);
+mp_obj_t common_hal_board_get_spi(const mp_int_t insatnce);
+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_VAR_BETWEEN(board_spi_obj);
 
-mp_obj_t common_hal_board_get_uart(void);
-mp_obj_t common_hal_board_create_uart(void);
-MP_DECLARE_CONST_FUN_OBJ_0(board_uart_obj);
+bool common_hal_board_is_uart(mp_obj_t obj);
+mp_obj_t common_hal_board_get_uart(const mp_int_t insatnce);
+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_VAR_BETWEEN(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) { \
+        const mp_obj_t inst = mp_obj_new_int_from_uint(instance); \
+        return board_##bus(1, &inst); \
+    } \
+    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) }, \