nRF52: SoftSPI library is no longer in use [skip ci]

software/firmware/README.md

@@ -68,7 +68,6 @@ along with this program.  If not, see <http://www.gnu.org/licenses/>.
  * Arduino Core for nRF52 and TinyUSB library are developed by **Ha Thach**
  * Arduino-NVM library is developed by **Frank Holtz**
  * U8g2 fonts for Adafruit GFX are developed by **Oliver Kraus**
- * SoftSPI library is developed by **Matt Jenkins**
  * Adafruit SPIFlash and SleepyDog libraries are developed by **Adafruit Industries**
  * SdFat library is developed by **Bill Greiman**
  * Arduino MIDI library is developed by **Francois Best**

software/firmware/source/SoftRF/SoftRF.ino

@@ -52,7 +52,6 @@
  *   GxEPD2 library is developed by Jean-Marc Zingg
  *   Adafruit GFX library is developed by Adafruit Industries
  *   U8g2 fonts for Adafruit GFX are developed by Oliver Kraus
- *   SoftSPI library is developed by Matt Jenkins
  *   Adafruit SPIFlash and SleepyDog libraries are developed by Adafruit Industries
  *   SdFat library is developed by Bill Greiman
  *   Arduino MIDI library is developed by Francois Best (Forty Seven Effects)

software/firmware/source/SoftRF/src/driver/Bluetooth.cpp

@@ -1200,7 +1200,7 @@ void nRF52_Bluetooth_setup()
   bledis.setManufacturer("SoftRF");
   bledis.setModel("Badge Edition");
   bledis.setHardwareRev(hw_info.revision == 0 ? "2020-8-6"   :
-                        hw_info.revision == 1 ? "2020-12-12" : "2021-1-15");
+                        hw_info.revision == 1 ? "2020-12-12" : "2021-3-16");
   bledis.setSoftwareRev(SOFTRF_FIRMWARE_VERSION);
   bledis.begin();
 

software/firmware/source/SoftRF/src/platform/nRF52.cpp

@@ -21,7 +21,6 @@
 #include <SPI.h>
 #include <Wire.h>
 #include <pcf8563.h>
-#include <SoftSPI.h>
 #include <Adafruit_SPIFlash.h>
 #include "Adafruit_TinyUSB.h"
 #include <Adafruit_SleepyDog.h>
@@ -131,45 +130,52 @@ GxEPD2_BW<GxEPD2_154_D67, GxEPD2_154_D67::HEIGHT> epd_ttgo_techo(GxEPD2_154_D67(
 GxEPD2_BW<GxEPD2_154_D67, GxEPD2_154_D67::HEIGHT> *display;
 #endif /* USE_EPAPER */
 
-SoftSPI SPI2(SOC_GPIO_PIN_SFL_MOSI, SOC_GPIO_PIN_SFL_MISO, SOC_GPIO_PIN_SFL_SCK);
-
-Adafruit_FlashTransport_SPI SWFlashTransport (SOC_GPIO_PIN_SFL_SS, &SPI2);
 Adafruit_FlashTransport_QSPI HWFlashTransport(SOC_GPIO_PIN_SFL_SCK,
                                               SOC_GPIO_PIN_SFL_SS,
                                               SOC_GPIO_PIN_SFL_MOSI,
                                               SOC_GPIO_PIN_SFL_MISO,
                                               SOC_GPIO_PIN_SFL_WP,
                                               SOC_GPIO_PIN_SFL_HOLD);
 
-Adafruit_SPIFlash SoftSPIFlash(&SWFlashTransport);
-Adafruit_SPIFlash QSPIFlash   (&HWFlashTransport);
+Adafruit_SPIFlash QSPIFlash (&HWFlashTransport);
 
 static Adafruit_SPIFlash *SPIFlash = NULL;
 
-#define MX25R1635F                                                             \
-  {                                                                            \
-    .total_size = (1 << 21), /* 2 MiB */                                       \
-    .start_up_time_us = 5000, .manufacturer_id = 0xc2,                         \
-    .memory_type = 0x28, .capacity = 0x15, .max_clock_speed_mhz = 8,           \
-    .quad_enable_bit_mask = 0x40, .has_sector_protection = false,              \
-    .supports_fast_read = true, .supports_qspi = true,                         \
-    .supports_qspi_writes = true, .write_status_register_split = false,        \
-    .single_status_byte = true, .is_fram = false,                              \
-  }
+// Settings for the Macronix MX25R1635F 2MiB SPI flash.
+// Datasheet: https://www.macronix.com/Lists/Datasheet/Attachments/7595/MX25R1635F,%20Wide%20Range,%2016Mb,%20v1.6.pdf
+// In low power mode, quad operations can only run at 8 MHz. In high power mode it can do 80 MHz.
+#define MX25R1635F_DESC  { \
+        .total_size = (1 << 21), /* 2 MiB */ \
+        .start_up_time_us = 800, \
+        .manufacturer_id = 0xc2, \
+        .memory_type = 0x28, \
+        .capacity = 0x15, \
+        .max_clock_speed_mhz = 8, /* 33 MHz for 1-bit operations */ \
+        .quad_enable_bit_mask = 0x40, \
+        .has_sector_protection = false, \
+        .supports_fast_read = true, \
+        .supports_qspi = true, \
+        .supports_qspi_writes = true, \
+        .write_status_register_split = false, \
+        .single_status_byte = true, \
+        .is_fram = false, \
+}
 
-/// List of all possible flash devices used by nRF52840 boards
-static const SPIFlash_Device_t possible_devices[] = {
-    // LilyGO T-Echo
-    MX25R1635F,
+#define SFLASH_CMD_READ_CONFIG  0x15
 
-    // Nordic PCA10056
-    MX25R6435F,
-};
+static uint32_t spiflash_id = 0;
+static uint8_t mx25_status_config[3] = {0x00, 0x00, 0x00};
 
 /// Flash device list count
 enum {
-  EXTERNAL_FLASH_DEVICE_COUNT =
-      sizeof(possible_devices) / sizeof(possible_devices[0])
+  MX25R1635F,
+  EXTERNAL_FLASH_DEVICE_COUNT
+};
+
+/// List of all possible flash devices used by nRF52840 boards
+static SPIFlash_Device_t possible_devices[] = {
+    // LilyGO T-Echo
+    [MX25R1635F] = MX25R1635F_DESC,
 };
 
 // USB Mass Storage object
@@ -408,7 +414,10 @@ static void nRF52_setup()
   switch (nRF52_board)
   {
     case NRF52_LILYGO_TECHO_REV_0:
-      SPIFlash = &SoftSPIFlash;
+      possible_devices[0].max_clock_speed_mhz = 33;
+      possible_devices[0].supports_qspi = false;
+      possible_devices[0].supports_qspi_writes = false;
+      SPIFlash = &QSPIFlash;
       break;
     case NRF52_LILYGO_TECHO_REV_1:
     case NRF52_LILYGO_TECHO_REV_2:
@@ -424,9 +433,20 @@ static void nRF52_setup()
                                          EXTERNAL_FLASH_DEVICE_COUNT);
   }
 
-  /* SoftSPI on REV_0 is slow which causes the system crash in main loop */
   if (nRF52_has_spiflash && (nRF52_board != NRF52_LILYGO_TECHO_REV_0)) {
-    uint32_t spi_flash_id = SPIFlash->getJEDECID();
+    spiflash_id = SPIFlash->getJEDECID();
+
+    //mx25_status_config[0] = SPIFlash->readStatus();
+    //HWFlashTransport.readCommand(SFLASH_CMD_READ_CONFIG,   mx25_status_config + 1, 2);
+    //mx25_status_config[2] |= 0x2;       /* High performance mode */
+    //SPIFlash->writeEnable();
+    //HWFlashTransport.writeCommand(SFLASH_CMD_WRITE_STATUS, mx25_status_config,     3);
+    //SPIFlash->writeDisable();
+    //SPIFlash->waitUntilReady();
+
+    //uint32_t const wr_speed = min(80 * 1000000U, (uint32_t)F_CPU);
+    //uint32_t rd_speed = wr_speed;
+    //HWFlashTransport.setClockSpeed(wr_speed, rd_speed);
 
     // Set disk vendor id, product id and revision with string up to 8, 16, 4 characters respectively
     usb_msc.setID("SoftRF", "External Flash", "1.0");
@@ -457,6 +477,15 @@ static void nRF52_post_init()
   if (nRF52_board == NRF52_LILYGO_TECHO_REV_0 ||
       nRF52_board == NRF52_LILYGO_TECHO_REV_1 ||
       nRF52_board == NRF52_LILYGO_TECHO_REV_2) {
+
+    Serial.println();
+    Serial.print  (F("SPI FLASH JEDEC ID: "));
+    Serial.print  (spiflash_id, HEX);           Serial.print(" ");
+    Serial.print  (F("STATUS/CONFIG: "));
+    Serial.print  (mx25_status_config[0], HEX); Serial.print(" ");
+    Serial.print  (mx25_status_config[1], HEX); Serial.print(" ");
+    Serial.print  (mx25_status_config[2], HEX); Serial.println();
+
     Serial.println();
     Serial.print  (F("LilyGO T-Echo (rev."));
     Serial.print  (hw_info.revision);
@@ -605,7 +634,7 @@ static void nRF52_fini(int reason)
 {
   uint8_t sd_en;
 
-//  if (nRF52_has_spiflash && (nRF52_board != NRF52_LILYGO_TECHO_REV_0)) {
+//  if (nRF52_has_spiflash) {
 //    usb_msc.end();
 //  }
 //    if (SPIFlash != NULL) SPIFlash->end();
@@ -636,7 +665,6 @@ static void nRF52_fini(int reason)
       pinMode(SOC_GPIO_LED_TECHO_REV_0_BLUE,  INPUT);
 
       pinMode(SOC_GPIO_PIN_IO_PWR, INPUT);
-      SPI2.end(); /* SoftSPI */
       pinMode(SOC_GPIO_PIN_SFL_SS, INPUT);
       break;
 
@@ -899,7 +927,7 @@ static void nRF52_EEPROM_extension()
   if ( nRF52_has_spiflash                       &&
       (nRF52_board != NRF52_LILYGO_TECHO_REV_0) &&
        fatfs.begin(SPIFlash)) {
-    File file = fatfs.open("/settings.txt", FILE_READ);
+    File file = fatfs.open("/settings.json", FILE_READ);
 
     if (file) {
       // StaticJsonBuffer<NRF52_JSON_BUFFER_SIZE> nRF52_jsonBuffer;

software/firmware/source/libraries/Adafruit_SPIFlash/src/spi/Adafruit_FlashTransport_SPI.cpp

@@ -25,7 +25,7 @@
 #include "Adafruit_FlashTransport.h"
 
 Adafruit_FlashTransport_SPI::Adafruit_FlashTransport_SPI(
-    uint8_t ss, SoftSPI *spiinterface) {
+    uint8_t ss, SPIClass *spiinterface) {
   _cmd_read = SFLASH_CMD_READ;
   _addr_len = 3; // work with most device if not set
   _ss = ss;
@@ -34,7 +34,7 @@ Adafruit_FlashTransport_SPI::Adafruit_FlashTransport_SPI(
 }
 
 Adafruit_FlashTransport_SPI::Adafruit_FlashTransport_SPI(uint8_t ss,
-                                                         SoftSPI &spiinterface)
+                                                         SPIClass &spiinterface)
     : Adafruit_FlashTransport_SPI(ss, &spiinterface) {}
 
 void Adafruit_FlashTransport_SPI::begin(void) {

software/firmware/source/libraries/Adafruit_SPIFlash/src/spi/Adafruit_FlashTransport_SPI.h

@@ -26,20 +26,20 @@
 #define ADAFRUIT_FLASHTRANSPORT_SPI_H_
 
 #include "Arduino.h"
-#include "SoftSPI.h"
+#include "SPI.h"
 
 class Adafruit_FlashTransport_SPI : public Adafruit_FlashTransport {
 private:
-  SoftSPI *_spi;
+  SPIClass *_spi;
   uint8_t _ss;
 
   // SAMD21 M0 can write up to 24 Mhz, but can only read reliably with 12 MHz
   uint32_t _clock_wr;
   uint32_t _clock_rd;
 
 public:
-  Adafruit_FlashTransport_SPI(uint8_t ss, SoftSPI *spiinterface);
-  Adafruit_FlashTransport_SPI(uint8_t ss, SoftSPI &spiinterface);
+  Adafruit_FlashTransport_SPI(uint8_t ss, SPIClass *spiinterface);
+  Adafruit_FlashTransport_SPI(uint8_t ss, SPIClass &spiinterface);
 
   virtual void begin(void);