refactor rak13800 to new ethernet interface class

examples/companion_radio/main.cpp

@@ -53,16 +53,8 @@ MultiSerialInterface interface_manager;
 
 // include ethernet interface
 #if defined(ETHERNET_ENABLED)
-  // todo refactor rak/nrf52 SerialEthernetInterface to new EthernetInterface
-  #if defined(NRF52_PLATFORM)
-    // include nrf52 ethernet interface
-    #include <helpers/nrf52/SerialEthernetInterface.h>
-    SerialEthernetInterface ethernet_interface;
-  #else
-    // include ethernet interface
-    #include <helpers/ethernet/EthernetInterface.h>
-    ETHERNET_CLASS ethernet_interface;
-  #endif
+  #include <helpers/ethernet/EthernetInterface.h>
+  ETHERNET_CLASS ethernet_interface;
 #endif
 
 // include hardware serial interface

src/helpers/ethernet/EthernetInterface.h

@@ -3,6 +3,8 @@
 #if defined(ETHERNET_ENABLED)
   #if defined(ETHERNET_USE_CH390)
     #include "helpers/ethernet/ch390/CH390EthernetInterface.h"
+  #elif defined(ETHERNET_USE_RAK13800)
+    #include "helpers/ethernet/RAK13800/RAK13800EthernetInterface.h"
   #else
     #error "ETHERNET_ENABLED is defined, but no specific driver flag (e.g. ETHERNET_USE_CH390) was provided!"
   #endif

src/helpers/ethernet/RAK13800/RAK13800EthernetInterface.cpp

@@ -0,0 +1,109 @@
+#include "RAK13800EthernetInterface.h"
+#include "../../nrf52/EthernetMac.h"
+#include <SPI.h>
+#include <EthernetUdp.h>
+
+#define PIN_SPI1_MISO (29) // (0 + 29)
+#define PIN_SPI1_MOSI (30) // (0 + 30)
+#define PIN_SPI1_SCK (3)   // (0 + 3)
+
+SPIClass ETHERNET_SPI_PORT(NRF_SPIM1, PIN_SPI1_MISO, PIN_SPI1_SCK, PIN_SPI1_MOSI);
+
+#define PIN_ETHERNET_POWER_EN WB_IO2    // output, high to enable
+#define PIN_ETHERNET_RESET 21
+#define PIN_ETHERNET_SS 26
+
+bool RAK13800EthernetInterface::begin() {
+
+  // WB_IO2 (power enable) is already driven HIGH by early constructor
+  // in RAK4631Board.cpp to support POE boot.
+  // Skip hardware reset — the W5100S comes out of power-on reset cleanly,
+  // and toggling reset kills the PHY link which breaks POE power.
+#ifdef PIN_ETHERNET_RESET
+        pinMode(PIN_ETHERNET_RESET, OUTPUT);
+        digitalWrite(PIN_ETHERNET_RESET, HIGH);
+#endif
+
+  // generate mac address
+  uint8_t mac[6];
+  generateEthernetMac(mac);
+  ETHERNET_DEBUG_PRINTLN(
+      "Ethernet MAC: %02X:%02X:%02X:%02X:%02X:%02X",
+      mac[0],
+      mac[1],
+      mac[2],
+      mac[3],
+      mac[4],
+      mac[5]);
+  ETHERNET_SPI_PORT.begin();
+  Ethernet.init(ETHERNET_SPI_PORT, PIN_ETHERNET_SS);
+
+  // Use static IP if build flags are defined, otherwise DHCP
+  #if defined(ETHERNET_STATIC_IP) && defined(ETHERNET_STATIC_GATEWAY) && defined(ETHERNET_STATIC_SUBNET) && defined(ETHERNET_STATIC_DNS)
+  IPAddress ip(ETHERNET_STATIC_IP);
+  IPAddress gateway(ETHERNET_STATIC_GATEWAY);
+  IPAddress subnet(ETHERNET_STATIC_SUBNET);
+  IPAddress dns(ETHERNET_STATIC_DNS);
+  Ethernet.begin(mac, ip, dns, gateway, subnet);
+  #else
+  if (Ethernet.begin(mac) == 0) {
+    ETHERNET_DEBUG_PRINTLN("Failed to initialize RAK13800 hardware.");
+    if (Ethernet.hardwareStatus() == EthernetNoHardware) {
+      ETHERNET_DEBUG_PRINTLN("Ethernet hardware not found.");
+    } else if (Ethernet.linkStatus() == LinkOFF) {
+      ETHERNET_DEBUG_PRINTLN("Ethernet cable not connected.");
+    } else {
+      ETHERNET_DEBUG_PRINTLN("DHCP failed for unknown reason.");
+    }
+    return false;
+  }
+  #endif
+
+  ETHERNET_DEBUG_PRINTLN("Ethernet begin complete");
+  ETHERNET_DEBUG_PRINT_IP("IP Address", Ethernet.localIP());
+  ETHERNET_DEBUG_PRINT_IP("Subnet Mask", Ethernet.subnetMask());
+  ETHERNET_DEBUG_PRINT_IP("Gateway", Ethernet.gatewayIP());
+  ETHERNET_DEBUG_PRINT_IP("DNS", Ethernet.dnsServerIP());
+
+  server.begin();
+  ETHERNET_DEBUG_PRINTLN("listening on TCP port: %d", ETHERNET_TCP_PORT);
+
+  return true;
+}
+
+int RAK13800EthernetInterface::available() {
+  return client.available();
+}
+
+int RAK13800EthernetInterface::read() {
+  return client.read();
+}
+
+size_t RAK13800EthernetInterface::write(const uint8_t *buf, size_t size) {
+  return client.write(buf, size);
+}
+
+bool RAK13800EthernetInterface::isConnected() const {
+  return _isConnected;
+}
+
+void RAK13800EthernetInterface::loop() {
+
+  Ethernet.maintain();
+  
+  auto newClient = server.accept();
+  if (newClient) {
+    IPAddress remoteIp = newClient.remoteIP();
+    uint16_t remotePort = newClient.remotePort();
+    ETHERNET_DEBUG_PRINTLN("New client accepted %u.%u.%u.%u:%u", remoteIp[0], remoteIp[1], remoteIp[2], remoteIp[3], remotePort);
+    if (client) {
+      ETHERNET_DEBUG_PRINTLN("Closing previous client");
+      client.stop();
+    }
+    client = newClient;
+    onClientConnected();
+  }
+
+  _isConnected = client.connected();
+
+}

src/helpers/ethernet/RAK13800/RAK13800EthernetInterface.h

@@ -0,0 +1,27 @@
+#pragma once
+
+#include "../SerialEthernetInterface.h"
+#include <SPI.h>
+#include <RAK13800_W5100S.h>
+
+class RAK13800EthernetInterface : public SerialEthernetInterface {
+  
+  bool _isConnected;
+  EthernetServer server;
+  EthernetClient client;
+
+  public:
+    RAK13800EthernetInterface() : server(EthernetServer(ETHERNET_TCP_PORT)) {
+      _isConnected = false;
+    }
+    
+    bool begin();
+    void loop() override;
+
+    // BaseSerialInterface methods
+    bool isConnected() const override;
+
+    int available() override;
+    int read() override;
+    size_t write(const uint8_t *buf, size_t size) override;
+};

variants/rak4631/platformio.ini

@@ -190,13 +190,16 @@ build_flags =
   -D MAX_CONTACTS=350
   -D MAX_GROUP_CHANNELS=40
   -D ETHERNET_ENABLED=1
+  -D ETHERNET_USE_RAK13800
+  -D ETHERNET_CLASS=RAK13800EthernetInterface
 ; NOTE: DO NOT ENABLE -->  -D MESH_PACKET_LOGGING=1
 ; NOTE: DO NOT ENABLE -->  -D MESH_DEBUG=1
 ;  -D ETHERNET_DEBUG_LOGGING=1
 build_src_filter = ${rak4631.build_src_filter}
   +<../examples/companion_radio/*.cpp>
   +<../examples/companion_radio/ui-new/*.cpp>
-  +<helpers/nrf52/SerialEthernetInterface.cpp>
+  +<helpers/ethernet/*.cpp>
+  +<helpers/ethernet/RAK13800/>
 lib_deps =
   ${rak4631.lib_deps}
   densaugeo/base64 @ ~1.4.0