Two board variant definitions and a high speed SPI transfer function (#172)

Author: ladyada

boards.txt

@@ -35,21 +35,29 @@ SPIClassRP2040::SPIClassRP2040(spi_inst_t *spi, pin_size_t rx, pin_size_t cs, pi
 
 inline spi_cpol_t SPIClassRP2040::cpol() {
     switch (_spis.getDataMode()) {
-    case SPI_MODE0: return SPI_CPOL_0;
-    case SPI_MODE1: return SPI_CPOL_0;
-    case SPI_MODE2: return SPI_CPOL_1;
-    case SPI_MODE3: return SPI_CPOL_1;
+    case SPI_MODE0:
+        return SPI_CPOL_0;
+    case SPI_MODE1:
+        return SPI_CPOL_0;
+    case SPI_MODE2:
+        return SPI_CPOL_1;
+    case SPI_MODE3:
+        return SPI_CPOL_1;
     }
     // Error
     return SPI_CPOL_0;
 }
 
 inline spi_cpha_t SPIClassRP2040::cpha() {
     switch (_spis.getDataMode()) {
-    case SPI_MODE0: return SPI_CPHA_0;
-    case SPI_MODE1: return SPI_CPHA_1;
-    case SPI_MODE2: return SPI_CPHA_0;
-    case SPI_MODE3: return SPI_CPHA_1;
+    case SPI_MODE0:
+        return SPI_CPHA_0;
+    case SPI_MODE1:
+        return SPI_CPHA_1;
+    case SPI_MODE2:
+        return SPI_CPHA_0;
+    case SPI_MODE3:
+        return SPI_CPHA_1;
     }
     // Error
     return SPI_CPHA_0;
@@ -124,6 +132,42 @@ void SPIClassRP2040::transfer(void *buf, size_t count) {
     DEBUGSPI("SPI::transfer completed\n");
 }
 
+void SPIClassRP2040::transfer(void *txbuf, void *rxbuf, size_t count) {
+    if (!_initted) {
+        return;
+    }
+
+    DEBUGSPI("SPI::transfer(%p, %p, %d)\n", txbuf, rxbuf, count);
+    uint8_t *txbuff = reinterpret_cast<uint8_t *>(txbuf);
+    uint8_t *rxbuff = reinterpret_cast<uint8_t *>(rxbuf);
+
+    // MSB version is easy!
+    if (_spis.getBitOrder() == MSBFIRST) {
+        spi_set_format(_spi, 8, cpol(), cpha(), SPI_MSB_FIRST);
+
+        if (rxbuf == NULL) { // transmit only!
+            spi_write_blocking(_spi, txbuff, count);
+            return;
+        }
+        if (txbuf == NULL) { // receive only!
+            spi_read_blocking(_spi, 0xFF, rxbuff, count);
+            return;
+        }
+        // transmit and receive!
+        spi_write_read_blocking(_spi, txbuff, rxbuff, count);
+        return;
+    }
+
+    // If its LSB this isn't nearly as fun, we'll just let transfer(x) do it :(
+    for (size_t i = 0; i < count; i++) {
+        *rxbuff = transfer(*txbuff);
+        *rxbuff = (_spis.getBitOrder() == MSBFIRST) ? *rxbuff : reverseByte(*rxbuff);
+        txbuff++;
+        rxbuff++;
+    }
+    DEBUGSPI("SPI::transfer completed\n");
+}
+
 void SPIClassRP2040::beginTransaction(SPISettings settings) {
     DEBUGSPI("SPI::beginTransaction(clk=%d, bo=%s\n", _spis.getClockFreq(), (_spis.getBitOrder() == MSBFIRST) ? "MSB" : "LSB");
     _spis = settings;

libraries/SPI/SPI.cpp

@@ -35,6 +35,9 @@ class SPIClassRP2040 : public arduino::HardwareSPI {
     // Sends buffer in 8 bit chunks.  Overwrites buffer with read data
     void transfer(void *buf, size_t count) override;
 
+    // Sends one buffer and receives into another, much faster! can set rx or txbuf to NULL
+    void transfer(void *txbuf, void *rxbuf, size_t count);
+
     // Call before/after every complete transaction
     void beginTransaction(SPISettings settings) override;
     void endTransaction(void) override;

libraries/SPI/SPI.h

@@ -123,5 +123,7 @@ def MakeBoard(name, vendor_name, product_name, vid, pid, boarddefine, flashsizem
 MakeBoard("adafruit_feather", "Adafruit", "Feather RP2040", "0x239a", "0x80f1", "ADAFRUIT_FEATHER_RP2040", 8, "boot2_w25x10cl_4_padded_checksum")
 MakeBoard("adafruit_itsybitsy", "Adafruit", "ItsyBitsy RP2040", "0x239a", "0x80fd", "ADAFRUIT_ITSYBITSY_RP2040", 8, "boot2_w25q080_2_padded_checksum")
 MakeBoard("adafruit_qtpy", "Adafruit", "QT Py RP2040", "0x239a", "0x80f7", "ADAFRUIT_QTPY_RP2040", 8, "boot2_generic_03h_4_padded_checksum")
+MakeBoard("adafruit_stemmafriend", "Adafruit", "STEMMA Friend RP2040", "0x239a", "0x80e3", "ADAFRUIT_STEMMAFRIEND_RP2040", 8, "boot2_w25q080_2_padded_checksum")
+MakeBoard("adafruit_trinkeyrp2040qt", "Adafruit", "Trinkey RP2040 QT", "0x239a", "0x8109", "ADAFRUIT_TRINKEYQT_RP2040", 8, "boot2_w25q080_2_padded_checksum")
 MakeBoard("generic", "Generic", "RP2040", "0x2e8a", "0xf00a", "GENERIC_RP2040", 16, "boot2_generic_03h_4_padded_checksum")
 

tools/makeboards.py

@@ -0,0 +1,45 @@
+#pragma once
+
+// Pin definitions taken from:
+//    https://learn.adafruit.com/assets/100337
+
+// LEDs not pinned out
+#define PIN_LED        (12u)  // backlight, weird but why not?
+
+#define PIN_NEOPIXEL   (17u)
+#define NUM_NEOPIXEL   (1u)
+#define PIN_SWITCH     (11u)
+
+// Serial
+#define PIN_SERIAL1_TX (26u)  // shared on grove/jst 2mm
+#define PIN_SERIAL1_RX (27u)  // shared on grove/jst 2mm
+
+// Not pinned out
+#define PIN_SERIAL2_TX (20u)  // shared on JST SH
+#define PIN_SERIAL2_RX (21u)
+
+// SPI
+#define PIN_SPI0_MISO  (4u)  // unconnected
+#define PIN_SPI0_MOSI  (7u)  // TFT data
+#define PIN_SPI0_SCK   (2u)  // TFT clock
+#define PIN_SPI0_SS    (1u)  // TFT CS
+
+// Not pinned out
+#define PIN_SPI1_MISO  (31u)
+#define PIN_SPI1_MOSI  (31u)
+#define PIN_SPI1_SCK   (31u)
+#define PIN_SPI1_SS    (31u)
+
+// Wire connected to STEMMA QT
+#define PIN_WIRE0_SDA  (20u)
+#define PIN_WIRE0_SCL  (21u)
+
+// Wire1 is connected to Stemma JST/grove connector
+#define PIN_WIRE1_SDA  (26u)
+#define PIN_WIRE1_SCL  (27u)
+
+#define SERIAL_HOWMANY (2u)
+#define SPI_HOWMANY    (1u)
+#define WIRE_HOWMANY   (2u)
+
+#include "../generic/common.h"

variants/adafruit_stemmafriend/pins_arduino.h

@@ -0,0 +1,42 @@
+#pragma once
+
+// LEDs not pinned out
+#define PIN_LED        (31u)
+
+#define PIN_NEOPIXEL   (27u)
+#define NUM_NEOPIXEL   (1u)
+#define PIN_SWITCH     (12u)
+
+// Serial, shared on QT pin
+#define PIN_SERIAL1_TX (16u)
+#define PIN_SERIAL1_RX (17u)
+
+// Not pinned out
+#define PIN_SERIAL2_TX (31u)
+#define PIN_SERIAL2_RX (31u)
+
+// SPI Not pinned out
+#define PIN_SPI0_MISO  (31u)
+#define PIN_SPI0_MOSI  (31u)
+#define PIN_SPI0_SCK   (31u)
+#define PIN_SPI0_SS    (31u)
+
+// Not pinned out
+#define PIN_SPI1_MISO  (31u)
+#define PIN_SPI1_MOSI  (31u)
+#define PIN_SPI1_SCK   (31u)
+#define PIN_SPI1_SS    (31u)
+
+// Wire
+#define PIN_WIRE0_SDA  (16u)
+#define PIN_WIRE0_SCL  (17u)
+
+// Wire1  Not pinned out
+#define PIN_WIRE1_SDA  (31u)
+#define PIN_WIRE1_SCL  (31u)
+
+#define SERIAL_HOWMANY (1u)
+#define SPI_HOWMANY    (0u)
+#define WIRE_HOWMANY   (1u)
+
+#include "../generic/common.h"