Add slave_mode parameter to the SPI bus constructor

Author: Randall-Scharpf

ports/atmel-samd/common-hal/busio/SPI.c

@@ -44,7 +44,7 @@
 
 void common_hal_busio_spi_construct(busio_spi_obj_t *self,
     const mcu_pin_obj_t *clock, const mcu_pin_obj_t *mosi,
-    const mcu_pin_obj_t *miso, bool half_duplex) {
+    const mcu_pin_obj_t *miso, bool half_duplex, bool slave_mode) {
     Sercom *sercom = NULL;
     uint8_t sercom_index;
     uint32_t clock_pinmux = 0;
@@ -60,6 +60,9 @@ void common_hal_busio_spi_construct(busio_spi_obj_t *self,
     if (half_duplex) {
         mp_raise_NotImplementedError(MP_ERROR_TEXT("Half duplex SPI is not implemented"));
     }
+    if (slave_mode) {
+        mp_raise_NotImplementedError(MP_ERROR_TEXT("Slave mode SPI is not implemented"));
+    }
 
     // Ensure the object starts in its deinit state.
     self->clock_pin = NO_PIN;

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

@@ -77,7 +77,7 @@ void reset_spi(void) {
 
 void common_hal_busio_spi_construct(busio_spi_obj_t *self,
     const mcu_pin_obj_t *clock, const mcu_pin_obj_t *mosi,
-    const mcu_pin_obj_t *miso, bool half_duplex) {
+    const mcu_pin_obj_t *miso, bool half_duplex, bool slave_mode) {
     size_t instance_index = NUM_SPI;
     BP_Function_Enum clock_alt = 0;
     BP_Function_Enum mosi_alt = 0;
@@ -86,6 +86,9 @@ void common_hal_busio_spi_construct(busio_spi_obj_t *self,
     if (half_duplex) {
         mp_raise_NotImplementedError(MP_ERROR_TEXT("Half duplex SPI is not implemented"));
     }
+    if (slave_mode) {
+        mp_raise_NotImplementedError(MP_ERROR_TEXT("Slave mode SPI is not implemented"));
+    }
 
     // BCM_VERSION != 2711 have 3 SPI but as listed in peripherals/gen/pins.c two are on
     // index 0, once one index 0 SPI is found the other will throw an invalid_pins error.

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

@@ -36,12 +36,15 @@
 #include "shared-bindings/microcontroller/Pin.h"
 
 void common_hal_busio_spi_construct(busio_spi_obj_t *self, const mcu_pin_obj_t *clock,
-    const mcu_pin_obj_t *mosi, const mcu_pin_obj_t *miso, bool half_duplex) {
+    const mcu_pin_obj_t *mosi, const mcu_pin_obj_t *miso, bool half_duplex, bool slave_mode) {
     int port = -1;
 
     if (half_duplex) {
         mp_raise_NotImplementedError(MP_ERROR_TEXT("Half duplex SPI is not implemented"));
     }
+    if (slave_mode) {
+        mp_raise_NotImplementedError(MP_ERROR_TEXT("Slave mode SPI is not implemented"));
+    }
 
     if (clock->number == PIN_SPI4_SCK &&
         (mosi == NULL || mosi->number == PIN_SPI4_MOSI) &&

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

@@ -77,7 +77,7 @@ static void set_spi_config(busio_spi_obj_t *self,
 
 void common_hal_busio_spi_construct(busio_spi_obj_t *self,
     const mcu_pin_obj_t *clock, const mcu_pin_obj_t *mosi,
-    const mcu_pin_obj_t *miso, bool half_duplex) {
+    const mcu_pin_obj_t *miso, bool half_duplex, bool slave_mode) {
 
     const spi_bus_config_t bus_config = {
         .mosi_io_num = mosi != NULL ? mosi->number : -1,
@@ -90,6 +90,9 @@ void common_hal_busio_spi_construct(busio_spi_obj_t *self,
     if (half_duplex) {
         mp_raise_NotImplementedError(MP_ERROR_TEXT("Half duplex SPI is not implemented"));
     }
+    if (slave_mode) {
+        mp_raise_NotImplementedError(MP_ERROR_TEXT("Slave mode SPI is not implemented"));
+    }
 
     for (spi_host_device_t host_id = SPI2_HOST; host_id < SOC_SPI_PERIPH_NUM; host_id++) {
         if (spi_bus_is_free(host_id)) {

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

@@ -91,7 +91,7 @@ void spi_reset(void) {
 
 void common_hal_busio_spi_construct(busio_spi_obj_t *self,
     const mcu_pin_obj_t *clock, const mcu_pin_obj_t *mosi,
-    const mcu_pin_obj_t *miso, bool half_duplex) {
+    const mcu_pin_obj_t *miso, bool half_duplex, bool slave_mode) {
 
     const uint32_t sck_count = MP_ARRAY_SIZE(mcu_spi_sck_list);
     const uint32_t miso_count = MP_ARRAY_SIZE(mcu_spi_sdi_list);
@@ -101,6 +101,9 @@ void common_hal_busio_spi_construct(busio_spi_obj_t *self,
     if (half_duplex) {
         mp_raise_NotImplementedError(MP_ERROR_TEXT("Half duplex SPI is not implemented"));
     }
+    if (slave_mode) {
+        mp_raise_NotImplementedError(MP_ERROR_TEXT("Slave mode SPI is not implemented"));
+    }
 
     for (uint i = 0; i < sck_count; i++) {
         if (mcu_spi_sck_list[i].pin != clock) {

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

@@ -143,11 +143,14 @@ static nrf_spim_frequency_t baudrate_to_spim_frequency(const uint32_t baudrate)
     return 0;
 }
 
-void common_hal_busio_spi_construct(busio_spi_obj_t *self, const mcu_pin_obj_t *clock, const mcu_pin_obj_t *mosi, const mcu_pin_obj_t *miso, bool half_duplex) {
+void common_hal_busio_spi_construct(busio_spi_obj_t *self, const mcu_pin_obj_t *clock, const mcu_pin_obj_t *mosi, const mcu_pin_obj_t *miso, bool half_duplex, bool slave_mode) {
 
     if (half_duplex) {
         mp_raise_NotImplementedError(MP_ERROR_TEXT("Half duplex SPI is not implemented"));
     }
+    if (slave_mode) {
+        mp_raise_NotImplementedError(MP_ERROR_TEXT("Slave mode SPI is not implemented"));
+    }
 
     // Find a free instance, with most desirable (highest freq and not shared) allocated first.
     self->spim_peripheral = NULL;

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

@@ -54,12 +54,15 @@ void reset_spi(void) {
 
 void common_hal_busio_spi_construct(busio_spi_obj_t *self,
     const mcu_pin_obj_t *clock, const mcu_pin_obj_t *mosi,
-    const mcu_pin_obj_t *miso, bool half_duplex) {
+    const mcu_pin_obj_t *miso, bool half_duplex, bool slave_mode) {
     size_t instance_index = NO_INSTANCE;
 
     if (half_duplex) {
         mp_raise_NotImplementedError(MP_ERROR_TEXT("Half duplex SPI is not implemented"));
     }
+    if (slave_mode) {
+        mp_raise_NotImplementedError(MP_ERROR_TEXT("Slave mode SPI is not implemented"));
+    }
 
     if (clock->number % 4 == 2) {
         instance_index = (clock->number / 8) % 2;

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

@@ -53,13 +53,16 @@ void common_hal_busio_spi_construct(busio_spi_obj_t *self,
     const mcu_pin_obj_t *sck,
     const mcu_pin_obj_t *mosi,
     const mcu_pin_obj_t *miso,
-    bool half_duplex) {
+    bool half_duplex, bool slave_mode) {
     Ecode_t sc = ECODE_OK;
 
     if (half_duplex) {
         mp_raise_NotImplementedError(
             MP_ERROR_TEXT("Half duplex SPI is not implemented"));
     }
+    if (slave_mode) {
+        mp_raise_NotImplementedError(MP_ERROR_TEXT("Slave mode SPI is not implemented"));
+    }
 
     if ((sck != NULL) && (mosi != NULL) && (miso != NULL)) {
         if (sck->function_list[FN_EUSART1_SCLK] == 1

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

@@ -167,7 +167,10 @@ STATIC int check_pins(busio_spi_obj_t *self,
 
 void common_hal_busio_spi_construct(busio_spi_obj_t *self,
     const mcu_pin_obj_t *sck, const mcu_pin_obj_t *mosi,
-    const mcu_pin_obj_t *miso, bool half_duplex) {
+    const mcu_pin_obj_t *miso, bool half_duplex, bool slave_mode) {
+    if (slave_mode) {
+        mp_raise_NotImplementedError(MP_ERROR_TEXT("Slave mode SPI is not implemented"));
+    }
 
     int periph_index = check_pins(self, sck, mosi, miso);
     SPI_TypeDef *SPIx = mcu_spi_banks[periph_index - 1];

shared-bindings/busio/SPI.c

@@ -74,6 +74,7 @@
 //|         MOSI: Optional[microcontroller.Pin] = None,
 //|         MISO: Optional[microcontroller.Pin] = None,
 //|         half_duplex: bool = False,
+//|         slave_mode: bool = False
 //|     ) -> None:
 //|         """Construct an SPI object on the given pins.
 //|
@@ -96,8 +97,10 @@
 //|         :param ~microcontroller.Pin MOSI: the Main Out Selected In pin.
 //|         :param ~microcontroller.Pin MISO: the Main In Selected Out pin.
 //|         :param bool half_duplex: True when MOSI is used for bidirectional data. False when SPI is full-duplex or simplex.
+//|         :param-bool slave_mode: True when the chip is operating as a slave. False when the chip is operating as a master.
 //|
 //|         **Limitations:** ``half_duplex`` is available only on STM; other chips do not have the hardware support.
+//|         **Limitations:** ``slave_mode`` is available only on SAMD51; other chips do not have the firmware support.
 //|         """
 //|         ...
 
@@ -106,12 +109,13 @@
 STATIC mp_obj_t busio_spi_make_new(const mp_obj_type_t *type, size_t n_args, size_t n_kw, const mp_obj_t *all_args) {
     #if CIRCUITPY_BUSIO_SPI
     busio_spi_obj_t *self = mp_obj_malloc(busio_spi_obj_t, &busio_spi_type);
-    enum { ARG_clock, ARG_MOSI, ARG_MISO, ARG_half_duplex };
+    enum { ARG_clock, ARG_MOSI, ARG_MISO, ARG_half_duplex, ARG_slave_mode };
     static const mp_arg_t allowed_args[] = {
         { MP_QSTR_clock, MP_ARG_REQUIRED | MP_ARG_OBJ },
         { MP_QSTR_MOSI, MP_ARG_OBJ, {.u_obj = mp_const_none} },
         { MP_QSTR_MISO, MP_ARG_OBJ, {.u_obj = mp_const_none} },
         { MP_QSTR_half_duplex, MP_ARG_OBJ | MP_ARG_KW_ONLY, {.u_bool = false} },
+        { MP_QSTR_slave_mode, MP_ARG_OBJ | MP_ARG_KW_ONLY, {.u_bool = false} },
     };
     mp_arg_val_t args[MP_ARRAY_SIZE(allowed_args)];
     mp_arg_parse_all_kw_array(n_args, n_kw, all_args, MP_ARRAY_SIZE(allowed_args), allowed_args, args);
@@ -124,7 +128,7 @@ STATIC mp_obj_t busio_spi_make_new(const mp_obj_type_t *type, size_t n_args, siz
         mp_raise_ValueError(MP_ERROR_TEXT("Must provide MISO or MOSI pin"));
     }
 
-    common_hal_busio_spi_construct(self, clock, mosi, miso, args[ARG_half_duplex].u_bool);
+    common_hal_busio_spi_construct(self, clock, mosi, miso, args[ARG_half_duplex].u_bool, args[ARG_slave_mode].u_bool);
     return MP_OBJ_FROM_PTR(self);
     #else
     raise_ValueError_invalid_pins();