Offload BLE HCI transport to spi for Nina based devices

.github/workflows/compile-examples.yml

@@ -34,17 +34,20 @@ jobs:
           - fqbn: arduino:samd:mkrwifi1010
             platforms: |
               - name: arduino:samd
-            libraries: ""
+            libraries: |
+              - name: WiFiNINA
             artifact-name-suffix: arduino-samd-mkrwifi1010
           - fqbn: arduino:samd:nano_33_iot
             platforms: |
               - name: arduino:samd
-            libraries: ""
+            libraries: |
+              - name: WiFiNINA
             artifact-name-suffix: arduino-samd-nano_33_iot
           - fqbn: arduino:megaavr:uno2018:mode=on
             platforms: |
               - name: arduino:megaavr
-            libraries: ""
+            libraries: |
+              - name: WiFiNINA
             artifact-name-suffix: arduino-megaavr-uno2018
           - fqbn: arduino:mbed_nano:nano33ble
             platforms: |
@@ -54,7 +57,8 @@ jobs:
           - fqbn: arduino:mbed_nano:nanorp2040connect
             platforms: |
               - name: arduino:mbed_nano
-            libraries: ""
+            libraries: |
+              - name: WiFiNINA
             artifact-name-suffix: arduino-mbed_nano-nanorp2040connect
           - fqbn: arduino:mbed_portenta:envie_m7
             platforms: |
@@ -175,6 +179,8 @@ jobs:
         with:
           github-token: ${{ secrets.GITHUB_TOKEN }}
           fqbn: ${{ matrix.fqbn }}
+          libraries: |
+            ${{ matrix.libraries }}
           platforms: |
             - name: esp32:esp32
               source-url: https://raw.githubusercontent.com/espressif/arduino-esp32/gh-pages/package_esp32_index.json

library.properties

@@ -8,3 +8,4 @@ category=Communication
 url=https://www.arduino.cc/en/Reference/ArduinoBLE
 architectures=*
 includes=ArduinoBLE.h
+depends=WiFiNINA

src/local/BLELocalDevice.cpp

@@ -63,26 +63,7 @@ BLELocalDevice::~BLELocalDevice()
 
 int BLELocalDevice::begin()
 {
-#if defined(ARDUINO_SAMD_MKRWIFI1010) || defined(ARDUINO_AVR_UNO_WIFI_REV2) || defined(ARDUINO_SAMD_NANO_33_IOT) || defined(ARDUINO_NANO_RP2040_CONNECT)
-  // reset the NINA in BLE mode
-  pinMode(SPIWIFI_SS, OUTPUT);
-  pinMode(NINA_RESETN, OUTPUT);
-
-  digitalWrite(SPIWIFI_SS, LOW);
-#endif
-
-#if defined(ARDUINO_SAMD_MKRWIFI1010) || defined(ARDUINO_AVR_UNO_WIFI_REV2)
-  digitalWrite(NINA_RESETN, HIGH);
-  delay(100);
-  digitalWrite(NINA_RESETN, LOW);
-  delay(750);
-#elif defined(ARDUINO_SAMD_NANO_33_IOT) || defined(ARDUINO_NANO_RP2040_CONNECT)
-  // inverted reset
-  digitalWrite(NINA_RESETN, LOW);
-  delay(100);
-  digitalWrite(NINA_RESETN, HIGH);
-  delay(750);
-#elif defined(PORTENTA_H7_PINS) || defined(ARDUINO_PORTENTA_H7_M7) || defined(ARDUINO_NICLA_VISION) || defined(ARDUINO_GIGA) || defined(ARDUINO_OPTA)
+#if defined(PORTENTA_H7_PINS) || defined(ARDUINO_PORTENTA_H7_M7) || defined(ARDUINO_NICLA_VISION) || defined(ARDUINO_GIGA) || defined(ARDUINO_OPTA)
   // BT_REG_ON -> HIGH
   pinMode(BT_REG_ON, OUTPUT);
   digitalWrite(BT_REG_ON, LOW);
@@ -187,10 +168,10 @@ int BLELocalDevice::begin()
   //     }
   //     Serial.println();
 
-  //     // save this 
+  //     // save this
   //     uint8_t zeros[16];
   //     for(int k=0; k<16; k++) zeros[15-k] = 0;
-      
+
   //     // HCI.leAddResolvingAddress((*BADDR_Type)[i],(*BADDRs)[i],(*IRKs)[i], zeros);
 
   //     delete[] (*BADDRs)[i];
@@ -202,7 +183,7 @@ int BLELocalDevice::begin()
   //   delete BADDRs;
   //   delete[] (*IRKs);
   //   delete IRKs;
-    
+
   //   memcheck = new uint8_t[1];
   //   Serial.print("nIRK location: 0x");
   //   Serial.println((int)memcheck,HEX);
@@ -221,15 +202,9 @@ void BLELocalDevice::end()
 
   HCI.end();
 
-#if defined(ARDUINO_SAMD_MKRWIFI1010) || defined(ARDUINO_AVR_UNO_WIFI_REV2)
-  // disable the NINA
-  digitalWrite(NINA_RESETN, HIGH);
-#elif defined(ARDUINO_SAMD_NANO_33_IOT) || defined(ARDUINO_NANO_RP2040_CONNECT)
-  // disable the NINA
-  digitalWrite(NINA_RESETN, LOW);
-#elif defined(ARDUINO_PORTENTA_H7_M4) || defined(ARDUINO_PORTENTA_H7_M7) || defined(ARDUINO_NICLA_VISION) || defined(ARDUINO_GIGA) || defined(ARDUINO_OPTA)
+#if defined(ARDUINO_PORTENTA_H7_M4) || defined(ARDUINO_PORTENTA_H7_M7) || defined(ARDUINO_NICLA_VISION) || defined(ARDUINO_GIGA) || defined(ARDUINO_OPTA)
   digitalWrite(BT_REG_ON, LOW);
-#endif 
+#endif
   _advertisingData.clear();
   _scanResponseData.clear();
 }
@@ -315,7 +290,7 @@ bool BLELocalDevice::setManufacturerData(const uint16_t companyId, const uint8_t
 
 bool BLELocalDevice::setLocalName(const char *localName)
 {
-  return _scanResponseData.setLocalName(localName);  
+  return _scanResponseData.setLocalName(localName);
 }
 
 void BLELocalDevice::setAdvertisingData(BLEAdvertisingData& advertisingData)
@@ -360,7 +335,7 @@ int BLELocalDevice::advertise()
 {
   _advertisingData.updateData();
   _scanResponseData.updateData();
-  return GAP.advertise( _advertisingData.data(), _advertisingData.dataLength(), 
+  return GAP.advertise( _advertisingData.data(), _advertisingData.dataLength(),
                         _scanResponseData.data(), _scanResponseData.dataLength());
 }
 

src/utility/HCINinaSpiTransport.cpp

@@ -0,0 +1,209 @@
+/*
+  This file is part of the ArduinoBLE library.
+
+  Copyright (c) 2024 Arduino SA
+
+  This Source Code Form is subject to the terms of the Mozilla Public
+  License, v. 2.0. If a copy of the MPL was not distributed with this
+  file, You can obtain one at http://mozilla.org/MPL/2.0/.
+*/
+
+#if defined(ARDUINO_AVR_UNO_WIFI_REV2) || defined(ARDUINO_SAMD_MKRWIFI1010) || defined(ARDUINO_SAMD_NANO_33_IOT) || defined(TARGET_NANO_RP2040_CONNECT)
+#include "HCINinaSpiTransport.h"
+#include "spi_drv.h"
+
+enum {
+  BLE_BEGIN 			= 0x4A,
+  BLE_END 				= 0x4B,
+  BLE_AVAILABLE		= 0x4C,
+  BLE_PEEK 				= 0x4D,
+  BLE_READ 				= 0x4E,
+  BLE_WRITE 			= 0x4F,
+};
+
+int BleDrv::bleBegin() {
+    WAIT_FOR_SLAVE_SELECT();
+
+    SpiDrv::sendCmd(BLE_BEGIN, PARAM_NUMS_0);
+
+    SpiDrv::spiSlaveDeselect();
+    //Wait the reply elaboration
+    SpiDrv::waitForSlaveReady();
+    SpiDrv::spiSlaveSelect();
+
+    uint8_t len = 1;
+    uint8_t result = 0;
+    SpiDrv::waitResponseCmd(BLE_BEGIN, PARAM_NUMS_1, (uint8_t*)&result, &len);
+    SpiDrv::spiSlaveDeselect();
+
+    return result == 0;
+}
+
+void BleDrv::bleEnd() {
+    WAIT_FOR_SLAVE_SELECT();
+
+    SpiDrv::sendCmd(BLE_END, PARAM_NUMS_0);
+
+    SpiDrv::spiSlaveDeselect();
+    //Wait the reply elaboration
+    SpiDrv::waitForSlaveReady();
+    SpiDrv::spiSlaveSelect();
+
+    uint8_t len = 1;
+    uint8_t result = 0;
+    SpiDrv::waitResponseCmd(BLE_END, PARAM_NUMS_1, (uint8_t*)&result, &len);
+    SpiDrv::spiSlaveDeselect();
+}
+
+int BleDrv::bleAvailable() {
+    WAIT_FOR_SLAVE_SELECT();
+    uint16_t result = 0;
+
+    SpiDrv::sendCmd(BLE_AVAILABLE, PARAM_NUMS_0);
+
+    SpiDrv::spiSlaveDeselect();
+    //Wait the reply elaboration
+    SpiDrv::waitForSlaveReady();
+    SpiDrv::spiSlaveSelect();
+
+    uint8_t len = 2;
+    SpiDrv::waitResponseCmd(BLE_AVAILABLE, PARAM_NUMS_1, (uint8_t*)&result, &len);
+    SpiDrv::spiSlaveDeselect();
+
+    return result;
+}
+
+int BleDrv::bleRead(uint8_t data[], size_t length) {
+    WAIT_FOR_SLAVE_SELECT();
+
+    SpiDrv::sendCmd(BLE_READ, PARAM_NUMS_1);
+
+    int commandSize = 7; // 4 for the normal command length + 3 for the parameter
+    uint16_t param = length; // TODO check length doesn't exceed 2^16
+    SpiDrv::sendParam((uint8_t*)&param, sizeof(param), LAST_PARAM);
+
+    // pad to multiple of 4
+    while (commandSize % 4 != 0) {
+        SpiDrv::readChar();
+        commandSize++;
+    }
+
+    SpiDrv::spiSlaveDeselect();
+    //Wait the reply elaboration
+    SpiDrv::waitForSlaveReady();
+    SpiDrv::spiSlaveSelect();
+
+    uint16_t res_len = 0;
+    SpiDrv::waitResponseData16(BLE_READ, data, (uint16_t*)&res_len);
+
+    SpiDrv::spiSlaveDeselect();
+
+    return res_len;
+}
+
+int BleDrv::blePeek(uint8_t data[], size_t length) {
+    WAIT_FOR_SLAVE_SELECT();
+
+    SpiDrv::sendCmd(BLE_PEEK, PARAM_NUMS_1);
+
+    int commandSize = 7; // 4 for the normal command length + 3 for the parameter
+    uint16_t param = length; // TODO check length doesn't exceed 2^16
+    SpiDrv::sendParam((uint8_t*)&param, sizeof(param), LAST_PARAM);
+
+    // pad to multiple of 4
+    while (commandSize % 4 != 0) {
+        SpiDrv::readChar();
+        commandSize++;
+    }
+
+    SpiDrv::spiSlaveDeselect();
+    //Wait the reply elaboration
+    SpiDrv::waitForSlaveReady();
+    SpiDrv::spiSlaveSelect();
+
+    uint16_t res_len = 0;
+    SpiDrv::waitResponseData16(BLE_READ, data, (uint16_t*)&res_len);
+
+    SpiDrv::spiSlaveDeselect();
+
+    return res_len;
+}
+
+size_t BleDrv::bleWrite(const uint8_t* data, size_t len) {
+    WAIT_FOR_SLAVE_SELECT();
+
+    int commandSize = 4;
+    SpiDrv::sendCmd(BLE_WRITE, PARAM_NUMS_1);
+
+    SpiDrv::sendBuffer((uint8_t*)data, len, LAST_PARAM);
+    commandSize += len+2;
+
+    // pad to multiple of 4
+    while (commandSize % 4 != 0) {
+        SpiDrv::readChar();
+        commandSize++;
+    }
+
+    SpiDrv::spiSlaveDeselect();
+    //Wait the reply elaboration
+    SpiDrv::waitForSlaveReady();
+    SpiDrv::spiSlaveSelect();
+
+    uint8_t res_len = 1;
+    uint16_t res = 0;
+    SpiDrv::waitResponseCmd(BLE_WRITE, PARAM_NUMS_1, (uint8_t*)&res, &res_len);
+    SpiDrv::spiSlaveDeselect();
+
+    return res;
+}
+
+int HCINinaSpiTransportClass::begin()
+{
+  SpiDrv::begin();
+  return BleDrv::bleBegin();
+}
+
+void HCINinaSpiTransportClass::end()
+{
+  BleDrv::bleEnd();
+}
+
+void HCINinaSpiTransportClass::wait(unsigned long timeout)
+{
+  for (unsigned long start = millis(); (millis() - start) < timeout;) {
+    if (available()) {
+      break;
+    }
+  }
+}
+
+int HCINinaSpiTransportClass::available()
+{
+  return BleDrv::bleAvailable();
+}
+
+int HCINinaSpiTransportClass::peek()
+{
+  int res=-1;
+  BleDrv::blePeek((uint8_t*)&res, 1); // read a single byte, if nothing is returned we return -1
+
+  return res;
+}
+
+int HCINinaSpiTransportClass::read()
+{
+  int res=-1;
+  BleDrv::bleRead((uint8_t*)&res, 1); // read a single byte, if nothing is returned we return -1
+
+  return res;
+}
+
+size_t HCINinaSpiTransportClass::write(const uint8_t* data, size_t length)
+{
+  return BleDrv::bleWrite(data, length);
+}
+
+HCINinaSpiTransportClass HCINinaSpiTransport;
+HCITransportInterface& HCITransport = HCINinaSpiTransport;
+
+#endif

src/utility/HCINinaSpiTransport.h

@@ -0,0 +1,43 @@
+/*
+  This file is part of the ArduinoBLE library.
+
+  Copyright (c) 2024 Arduino SA
+
+  This Source Code Form is subject to the terms of the Mozilla Public
+  License, v. 2.0. If a copy of the MPL was not distributed with this
+  file, You can obtain one at http://mozilla.org/MPL/2.0/.
+*/
+
+#ifndef _HCI_NINA_SPI_TRANSPORT_H_
+#define _HCI_NINA_SPI_TRANSPORT_H_
+
+#include "HCITransport.h"
+
+class BleDrv
+{
+public:
+    static int bleBegin();
+    static void bleEnd();
+    static int bleAvailable();
+    static int bleRead(uint8_t data[], size_t length);
+    static int blePeek(uint8_t data[], size_t length);
+    static size_t bleWrite(const uint8_t* data, size_t length);
+};
+
+class HCINinaSpiTransportClass : public HCITransportInterface {
+public:
+  HCINinaSpiTransportClass() {}
+
+  virtual int begin();
+  virtual void end();
+
+  virtual void wait(unsigned long timeout);
+
+  virtual int available();
+  virtual int peek();
+  virtual int read();
+
+  virtual size_t write(const uint8_t* data, size_t length);
+};
+
+#endif