Add ETHClass2 lib, board definition and ETH companion radio support

boards/t_eth_elite.json

@@ -0,0 +1,51 @@
+{
+    "build": {
+      "arduino":{
+        "ldscript": "esp32s3_out.ld",
+        "partitions": "default.csv",
+        "memory_type": "qio_qspi"
+      },
+      "core": "esp32",
+      "extra_flags": [
+        "-DARDUINO_USB_MODE=1",
+        "-DARDUINO_USB_CDC_ON_BOOT=1",
+        "-DARDUINO_RUNNING_CORE=1",
+        "-DARDUINO_EVENT_RUNNING_CORE=1"
+      ],
+      "f_cpu": "240000000L",
+      "f_flash": "80000000L",
+      "flash_mode": "qio",
+      "hwids": [
+        [
+          "0x303A",
+          "0x1001"
+        ]
+      ],
+      "mcu": "esp32s3",
+      "variant": "esp32s3"
+    },
+    "connectivity": [
+      "wifi"
+    ],
+    "debug": {
+      "default_tool": "esp-builtin",
+      "onboard_tools": [
+        "esp-builtin"
+      ],
+      "openocd_target": "esp32s3.cfg"
+    },
+    "frameworks": [
+      "arduino",
+      "espidf"
+    ],
+    "name": "LilyGo T-ETH-ELite (16MB Flash 8MB PSRAM)",
+    "upload": {
+      "flash_size": "16MB",
+      "maximum_ram_size": 8388608,
+      "maximum_size": 16777216,
+      "require_upload_port": true,
+      "speed": 460800
+    },
+    "url": "https://lilygo.cc/products/t-eth-elite-1",
+    "vendor": "LilyGo"
+  }

examples/companion_radio/main.cpp

@@ -35,7 +35,7 @@ static uint32_t _atoi(const char* sp) {
 #endif
 
 #ifdef ESP32
-  #ifdef WIFI_SSID
+  #if defined(WIFI_SSID) || defined(USE_ETHERNET)
     #include <helpers/esp32/SerialWifiInterface.h>
     SerialWifiInterface serial_interface;
     #ifndef TCP_PORT
@@ -194,9 +194,12 @@ void setup() {
   );
 
 #ifdef WIFI_SSID
-  board.setInhibitSleep(true);   // prevent sleep when WiFi is active
+  board.setInhibitSleep(true);
   WiFi.begin(WIFI_SSID, WIFI_PWD);
   serial_interface.begin(TCP_PORT);
+#elif defined(USE_ETHERNET)
+  serial_interface.begin(TCP_PORT);
+  Serial.printf("TCP server started on port %d\n", TCP_PORT);
 #elif defined(BLE_PIN_CODE)
   serial_interface.begin(BLE_NAME_PREFIX, the_mesh.getNodePrefs()->node_name, the_mesh.getBLEPin());
 #elif defined(SERIAL_RX)

lib/ETHClass2/library.properties

@@ -0,0 +1,9 @@
+name=ETHClass2
+version=1.0.0
+author=Lewis He
+maintainer=Lewis He <lewishe@outlook.com>
+sentence=Enables network connection (local and Internet) using the ESP32/ESP32S3 Ethernet.
+paragraph=With this library you can instantiate Servers, Clients and send/receive UDP packets through Ethernet. The IP address can be assigned statically or through a DHCP. The library can also manage DNS.
+category=Communication
+url=
+architectures=esp32

lib/ETHClass2/src/ETHClass2.h

@@ -0,0 +1,219 @@
+/*
+ ETH.h - espre ETH PHY support.
+ Based on WiFi.h from Ardiono WiFi shield library.
+ Copyright (c) 2011-2014 Arduino.  All right reserved.
+
+ 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
+ */
+
+#ifndef _ETH_H_
+#define _ETH_H_
+
+//
+// Example configurations for pins_arduino.h to allow starting with ETH.begin();
+//
+
+// // Example RMII LAN8720 (Olimex, etc.)
+// #define ETH_PHY_TYPE        ETH_PHY_LAN8720
+// #define ETH_PHY_ADDR         0
+// #define ETH_PHY_MDC         23
+// #define ETH_PHY_MDIO        18
+// #define ETH_PHY_POWER       -1
+// #define ETH_CLK_MODE        ETH_CLOCK_GPIO0_IN
+
+// // Example RMII ESP32_Ethernet_V4
+// #define ETH_PHY_TYPE        ETH_PHY_TLK110
+// #define ETH_PHY_ADDR         1
+// #define ETH_PHY_MDC         23
+// #define ETH_PHY_MDIO        18
+// #define ETH_PHY_POWER       -1
+// #define ETH_CLK_MODE        ETH_CLOCK_GPIO0_OUT
+
+// // Example SPI using ESP-IDF's driver
+// #define ETH_PHY_TYPE        ETH_PHY_W5500
+// #define ETH_PHY_ADDR         1
+// #define ETH_PHY_CS          15
+// #define ETH_PHY_IRQ          4
+// #define ETH_PHY_RST          5
+// #define ETH_PHY_SPI_HOST    SPI2_HOST
+// #define ETH_PHY_SPI_SCK     14
+// #define ETH_PHY_SPI_MISO    12
+// #define ETH_PHY_SPI_MOSI    13
+
+// // Example SPI using Arduino's driver
+// #define ETH_PHY_TYPE        ETH_PHY_W5500
+// #define ETH_PHY_ADDR         1
+// #define ETH_PHY_CS          15
+// #define ETH_PHY_IRQ          4
+// #define ETH_PHY_RST          5
+// #define ETH_PHY_SPI         SPI
+
+// This will be uncommented once custom SPI support is available in ESP-IDF
+#define ETH_SPI_SUPPORTS_CUSTOM 0
+#include "WiFi.h"
+#if ETH_SPI_SUPPORTS_CUSTOM
+#include "SPI.h"
+#endif
+#include "esp_system.h"
+#include "esp_eth.h"
+#include "esp_netif.h"
+#include "hal/spi_types.h"
+
+#if CONFIG_ETH_USE_ESP32_EMAC
+#define ETH_PHY_IP101 ETH_PHY_TLK110
+typedef enum { ETH_CLOCK_GPIO0_IN, ETH_CLOCK_GPIO0_OUT, ETH_CLOCK_GPIO16_OUT, ETH_CLOCK_GPIO17_OUT } eth_clock_mode_t;
+//Dedicated GPIOs for RMII
+#define ETH_RMII_TX_EN  21
+#define ETH_RMII_TX0    19
+#define ETH_RMII_TX1    22
+#define ETH_RMII_RX0    25
+#define ETH_RMII_RX1_EN 26
+#define ETH_RMII_CRS_DV 27
+#endif /* CONFIG_ETH_USE_ESP32_EMAC */
+
+#ifndef ETH_PHY_SPI_FREQ_MHZ
+#define ETH_PHY_SPI_FREQ_MHZ 20
+#endif /* ETH_PHY_SPI_FREQ_MHZ */
+
+typedef enum { 
+#if CONFIG_ETH_USE_ESP32_EMAC
+    ETH_PHY_LAN8720, ETH_PHY_TLK110, ETH_PHY_RTL8201, ETH_PHY_DP83848, ETH_PHY_KSZ8041, ETH_PHY_KSZ8081, 
+#endif /* CONFIG_ETH_USE_ESP32_EMAC */
+#if CONFIG_ETH_SPI_ETHERNET_DM9051
+    ETH_PHY_DM9051, 
+#endif
+#if CONFIG_ETH_SPI_ETHERNET_W5500
+    ETH_PHY_W5500, 
+#endif
+#if CONFIG_ETH_SPI_ETHERNET_KSZ8851SNL
+    ETH_PHY_KSZ8851,
+#endif
+    ETH_PHY_MAX 
+} eth_phy_type_t;
+
+class ETHClass2 {
+    public:
+        ETHClass2(uint8_t eth_index=0);
+        ~ETHClass2();
+
+#if CONFIG_ETH_USE_ESP32_EMAC
+        bool begin(eth_phy_type_t type, uint8_t phy_addr, int mdc, int mdio, int power, eth_clock_mode_t clk_mode);
+#endif /* CONFIG_ETH_USE_ESP32_EMAC */
+#if ETH_SPI_SUPPORTS_CUSTOM
+        bool begin(eth_phy_type_t type, uint8_t phy_addr, int cs, int irq, int rst, SPIClass &spi, uint8_t spi_freq_mhz=ETH_PHY_SPI_FREQ_MHZ);
+#endif
+        bool begin(eth_phy_type_t type, uint8_t phy_addr, int cs, int irq, int rst, spi_host_device_t spi_host, int sck=-1, int miso=-1, int mosi=-1, uint8_t spi_freq_mhz=ETH_PHY_SPI_FREQ_MHZ);
+
+        bool begin(){
+#if defined(ETH_PHY_TYPE) && defined(ETH_PHY_ADDR)
+    #if defined(CONFIG_ETH_USE_ESP32_EMAC) && defined(ETH_PHY_POWER) && defined(ETH_PHY_MDC) && defined(ETH_PHY_MDIO) && defined(ETH_CLK_MODE)
+            return begin(ETH_PHY_TYPE, ETH_PHY_ADDR, ETH_PHY_MDC, ETH_PHY_MDIO, ETH_PHY_POWER, ETH_CLK_MODE);
+    #elif defined(ETH_PHY_CS) && defined(ETH_PHY_IRQ) && defined(ETH_PHY_RST)
+        #if ETH_SPI_SUPPORTS_CUSTOM && defined(ETH_PHY_SPI)
+            return begin(ETH_PHY_TYPE, ETH_PHY_ADDR, ETH_PHY_CS, ETH_PHY_IRQ, ETH_PHY_RST, ETH_PHY_SPI, ETH_PHY_SPI_FREQ_MHZ);
+        #elif defined(ETH_PHY_SPI_HOST) && defined(ETH_PHY_SPI_SCK) && defined(ETH_PHY_SPI_MISO) && defined(ETH_PHY_SPI_MOSI)
+            return begin(ETH_PHY_TYPE, ETH_PHY_ADDR, ETH_PHY_CS, ETH_PHY_IRQ, ETH_PHY_RST, ETH_PHY_SPI_HOST, ETH_PHY_SPI_SCK, ETH_PHY_SPI_MISO, ETH_PHY_SPI_MOSI, ETH_PHY_SPI_FREQ_MHZ);
+        #endif
+    #endif
+#endif
+            return false;
+        }
+
+        void end();
+
+        // Netif APIs
+        esp_netif_t * netif(void){ return _esp_netif; }
+        bool config(IPAddress local_ip = (uint32_t)0x00000000, IPAddress gateway = (uint32_t)0x00000000, IPAddress subnet = (uint32_t)0x00000000, IPAddress dns1 = (uint32_t)0x00000000, IPAddress dns2 = (uint32_t)0x00000000);
+        const char * getHostname();
+        bool setHostname(const char * hostname);
+        IPAddress localIP();
+        IPAddress subnetMask();
+        IPAddress gatewayIP();
+        IPAddress dnsIP(uint8_t dns_no = 0);
+        IPAddress broadcastIP();
+        IPAddress networkID();
+        uint8_t subnetCIDR();
+        bool enableIpV6();
+        IPv6Address localIPv6();
+        const char * ifkey(void);
+        const char * desc(void);
+        String impl_name(void);
+
+        // Event based getters
+        bool connected();
+        bool hasIP();
+
+        // ETH Handle APIs
+        uint8_t * macAddress(uint8_t* mac);
+        String macAddress();
+        bool fullDuplex();
+        bool linkUp();
+        uint8_t linkSpeed();
+        bool autoNegotiation();
+        uint32_t phyAddr();
+
+        // Info APIs
+        void printInfo(Print & out);
+
+        friend class WiFiClient;
+        friend class WiFiServer;
+
+#if ETH_SPI_SUPPORTS_CUSTOM
+        static esp_err_t _eth_spi_read(void *ctx, uint32_t cmd, uint32_t addr, void *data, uint32_t data_len);
+        static esp_err_t _eth_spi_write(void *ctx, uint32_t cmd, uint32_t addr, const void *data, uint32_t data_len);
+#endif
+
+    protected:
+#if ETH_SPI_SUPPORTS_CUSTOM
+        esp_err_t eth_spi_read(uint32_t cmd, uint32_t addr, void *data, uint32_t data_len);
+        esp_err_t eth_spi_write(uint32_t cmd, uint32_t addr, const void *data, uint32_t data_len);
+#endif
+
+        static void eth_event_handler(void *arg, esp_event_base_t event_base, int32_t event_id, void *event_data);
+
+    private:
+        bool _eth_started;
+        esp_eth_handle_t _eth_handle;
+        esp_netif_t *_esp_netif;
+        uint8_t _eth_index;
+        eth_phy_type_t _phy_type;
+#if ETH_SPI_SUPPORTS_CUSTOM
+        SPIClass * _spi;
+#endif
+        uint8_t _spi_freq_mhz;
+        int8_t _pin_cs;
+        int8_t _pin_irq;
+        int8_t _pin_rst;
+        int8_t _pin_sck;
+        int8_t _pin_miso;
+        int8_t _pin_mosi;
+#if CONFIG_ETH_USE_ESP32_EMAC
+        int8_t _pin_mcd;
+        int8_t _pin_mdio;
+        int8_t _pin_power;
+        int8_t _pin_rmii_clock;
+#endif /* CONFIG_ETH_USE_ESP32_EMAC */
+
+        static bool ethDetachBus(void * bus_pointer);
+        bool beginSPI(eth_phy_type_t type, uint8_t phy_addr, int cs, int irq, int rst, 
+#if ETH_SPI_SUPPORTS_CUSTOM
+            SPIClass * spi, 
+#endif
+            int sck, int miso, int mosi, spi_host_device_t spi_host, uint8_t spi_freq_mhz);
+};
+
+extern ETHClass2 ETH2;
+
+#endif /* _ETH_H_ */

src/helpers/esp32/SerialWifiInterface.cpp

@@ -2,10 +2,9 @@
 #include <WiFi.h>
 
 void SerialWifiInterface::begin(int port) {
-  // wifi setup is handled outside of this class, only starts the server
+  server = WiFiServer(port);
-  server.begin(port);
+  server.begin();
 }
-
 // ---------- public methods
 void SerialWifiInterface::enable() { 
   if (_isEnabled) return;
@@ -170,3 +169,4 @@ size_t SerialWifiInterface::checkRecvFrame(uint8_t dest[]) {
 bool SerialWifiInterface::isConnected() const {
   return deviceConnected;  //pServer != NULL && pServer->getConnectedCount() > 0;
 }
+