Add ESP32-based WiFi support via lwIP_ESPHost library (#1950)

Author: JAndrassy

libraries/WiFi/src/WiFiClass.cpp

@@ -32,6 +32,8 @@
 #ifdef ARDUINO_RASPBERRY_PI_PICO_W
 #include <pico/cyw43_arch.h>
 static CYW43lwIP _wifi(1);
+#elif defined(ESPHOSTSPI)
+static ESPHostLwIP _wifi;
 #else
 static NoDriverLwIP _wifi;
 #endif
@@ -100,11 +102,11 @@ int WiFiClass::begin(const char* ssid, const char *passphrase, const uint8_t *bs
     } else {
         bzero(_bssid, sizeof(_bssid));
     }
+    _wifi.setSTA();
     _wifi.setSSID(_ssid.c_str());
     _wifi.setBSSID(_bssid);
     _wifi.setPassword(passphrase);
     _wifi.setTimeout(_timeout);
-    _wifi.setSTA();
     _apMode = false;
     _wifiHWInitted = true;
     uint32_t start = millis(); // The timeout starts from network init, not network link up
@@ -139,10 +141,10 @@ uint8_t WiFiClass::beginAP(const char *ssid, const char* passphrase) {
 
     _ssid = ssid;
     _password = passphrase;
+    _wifi.setAP();
     _wifi.setSSID(_ssid.c_str());
     _wifi.setPassword(passphrase);
     _wifi.setTimeout(_timeout);
-    _wifi.setAP();
     _apMode = true;
     IPAddress gw = _wifi.gatewayIP();
     if (!gw.isSet()) {

libraries/WiFi/src/WiFiClass.h

@@ -25,6 +25,8 @@
 #include <Arduino.h>
 #ifdef ARDUINO_RASPBERRY_PI_PICO_W
 #include <lwIP_CYW43.h>
+#elif defined(ESPHOSTSPI)
+#include <lwIP_ESPHost.h>
 #else
 #include "utility/lwIP_nodriver.h"
 #endif

libraries/lwIP_ESPHost/README.md

@@ -0,0 +1,6 @@
+# lwIP_ESPHost library 
+
+RP2040 Arduino integration with the ESPHost library.
+
+[ESPHost library](https://github.com/JAndrassy/ESPHost) is a driver for communication with Espressif's esp-hosted-fg firmware.
+

libraries/lwIP_ESPHost/library.properties

@@ -0,0 +1,10 @@
+name=lwIP_ESPHost
+version=1
+author=Juraj Andrassy
+maintainer=Earle F. Philhower, III <[email protected]>
+sentence=RP2040 ESPHost wifi driver
+paragraph=Driver for the esp-hosted-fg firmware with the ESPHosted library
+category=Communication
+url=https://github.com/earlephilhower/arduino-pico
+architectures=rp2040
+dot_a_linkage=true

libraries/lwIP_ESPHost/src/ESPHost.cpp

@@ -0,0 +1,70 @@
+/*
+ WiFi <-> LWIP for ESPHost library in RP2040 Core
+
+ Copyright (c) 2024 Juraj Andrassy
+
+ This library is free software; you can redistribute it and/or
+ modify it under the terms of the GNU Lesser General Public
+ License as published by the Free Software Foundation; either
+ version 2.1 of the License, or (at your option) any later version.
+
+ This library is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ Lesser General Public License for more details.
+
+ You should have received a copy of the GNU Lesser General Public
+ License along with this library; if not, write to the Free Software
+ Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
+ */
+
+#include "ESPHost.h"
+#include "CEspControl.h"
+
+ESPHost::ESPHost(int8_t cs, arduino::SPIClass &spi, int8_t intrpin) {
+    (void) cs;
+    (void) spi;
+    (void) intrpin;
+    // CS and SPI are configured in ESPHost library
+}
+
+bool ESPHost::begin(const uint8_t *address, netif *netif) {
+    (void) address;
+    (void) netif;
+
+    // WiFi is initialized in ESPHostLwIP
+
+    return true;
+}
+
+void ESPHost::end() {
+    // WiFi is ended in ESPHostLwIP
+}
+
+uint16_t ESPHost::sendFrame(const uint8_t *data, uint16_t datalen) {
+    int res = CEspControl::getInstance().sendBuffer(apMode ? ESP_AP_IF : ESP_STA_IF, 0, (uint8_t*) data, datalen);
+    CEspControl::getInstance().communicateWithEsp();
+    return (res == ESP_CONTROL_OK) ? datalen : 0;
+}
+
+uint16_t ESPHost::readFrameData(uint8_t *buffer, uint16_t bufsize) {
+    uint8_t ifn = 0;
+    uint16_t res;
+    if (apMode) {
+        res = CEspControl::getInstance().getSoftApRx(ifn, buffer, bufsize);
+    } else {
+        res = CEspControl::getInstance().getStationRx(ifn, buffer, bufsize);
+    }
+    return res;
+}
+
+uint16_t ESPHost::readFrameSize() {
+    CEspControl::getInstance().communicateWithEsp();
+    uint16_t res;
+    if (apMode) {
+        res = CEspControl::getInstance().peekSoftApRxPayloadLen();
+    } else {
+        res = CEspControl::getInstance().peekStationRxPayloadLen();
+    }
+    return res;
+}

libraries/lwIP_ESPHost/src/ESPHost.h

@@ -0,0 +1,57 @@
+/*
+    WiFi <-> LWIP for ESPHost library in RP2040 Core
+
+    Copyright (c) 2024 Juraj Andrassy
+
+    This library is free software; you can redistribute it and/or
+    modify it under the terms of the GNU Lesser General Public
+    License as published by the Free Software Foundation; either
+    version 2.1 of the License, or (at your option) any later version.
+
+    This library is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+    Lesser General Public License for more details.
+
+    You should have received a copy of the GNU Lesser General Public
+    License along with this library; if not, write to the Free Software
+    Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
+ */
+
+#pragma once
+
+#include <Arduino.h>
+#include <SPI.h>
+
+class ESPHost {
+public:
+
+    // constructor and methods as required by LwipIntfDev
+
+    ESPHost(int8_t cs, arduino::SPIClass &spi, int8_t intrpin);
+
+    bool begin(const uint8_t *address, netif *netif);
+    void end();
+
+    uint16_t sendFrame(const uint8_t *data, uint16_t datalen);
+
+    uint16_t readFrameData(uint8_t *buffer, uint16_t bufsize);
+
+    uint16_t readFrameSize();
+
+    void discardFrame(uint16_t ign) {
+        (void) ign;
+    }
+
+    bool interruptIsPossible() {
+        return false;
+    }
+
+    constexpr bool needsSPI() const {
+        return false;
+    }
+
+protected:
+    bool apMode = false;
+
+};