Handle Ethernet lost IP and more

me-no-dev · me-no-dev · commit da42146d68e1 · 2023-08-31T16:14:37.000+03:00
diff --git a/libraries/Ethernet/examples/ETH_LAN8720/ETH_LAN8720.ino b/libraries/Ethernet/examples/ETH_LAN8720/ETH_LAN8720.ino
@@ -16,7 +16,7 @@
 
 static bool eth_connected = false;
 
-void WiFiEvent(WiFiEvent_t event)
+void onEvent(arduino_event_id_t event, arduino_event_info_t info)
 {
   switch (event) {
     case ARDUINO_EVENT_ETH_START:
@@ -32,6 +32,10 @@ void WiFiEvent(WiFiEvent_t event)
       ETH.printInfo(Serial);
       eth_connected = true;
       break;
+    case ARDUINO_EVENT_ETH_LOST_IP:
+      Serial.println("ETH Lost IP");
+      eth_connected = false;
+      break;
     case ARDUINO_EVENT_ETH_DISCONNECTED:
       Serial.println("ETH Disconnected");
       eth_connected = false;
@@ -68,7 +72,7 @@ void testClient(const char * host, uint16_t port)
 void setup()
 {
   Serial.begin(115200);
-  WiFi.onEvent(WiFiEvent);
+  WiFi.onEvent(onEvent);
   ETH.begin();
 }
 
diff --git a/libraries/Ethernet/examples/ETH_TLK110/ETH_TLK110.ino b/libraries/Ethernet/examples/ETH_TLK110/ETH_TLK110.ino
@@ -14,7 +14,7 @@
 
 static bool eth_connected = false;
 
-void WiFiEvent(WiFiEvent_t event)
+void onEvent(arduino_event_id_t event, arduino_event_info_t info)
 {
   switch (event) {
     case ARDUINO_EVENT_ETH_START:
@@ -30,6 +30,10 @@ void WiFiEvent(WiFiEvent_t event)
       ETH.printInfo(Serial);
       eth_connected = true;
       break;
+    case ARDUINO_EVENT_ETH_LOST_IP:
+      Serial.println("ETH Lost IP");
+      eth_connected = false;
+      break;
     case ARDUINO_EVENT_ETH_DISCONNECTED:
       Serial.println("ETH Disconnected");
       eth_connected = false;
@@ -66,7 +70,7 @@ void testClient(const char * host, uint16_t port)
 void setup()
 {
   Serial.begin(115200);
-  WiFi.onEvent(WiFiEvent);
+  WiFi.onEvent(onEvent);
   ETH.begin(ETH_TYPE, ETH_ADDR, ETH_MDC_PIN, ETH_MDIO_PIN, ETH_POWER_PIN, ETH_CLK_MODE);
 }
 
diff --git a/libraries/Ethernet/examples/ETH_W5500_IDF_SPI/ETH_W5500_IDF_SPI.ino b/libraries/Ethernet/examples/ETH_W5500_IDF_SPI/ETH_W5500_IDF_SPI.ino
@@ -3,6 +3,11 @@
 
 */
 
+#include <ETH.h>
+
+// Set this to 1 to enable dual Ethernet support
+#define USE_TWO_ETH_PORTS 0
+
 #define ETH_TYPE        ETH_PHY_W5500
 #define ETH_ADDR         1
 #define ETH_CS          15
@@ -13,26 +18,41 @@
 #define ETH_SPI_MISO    12
 #define ETH_SPI_MOSI    13
 
-#include <ETH.h>
+#if USE_TWO_ETH_PORTS
+// Second port on shared SPI bus
+#define ETH1_TYPE        ETH_PHY_W5500
+#define ETH1_ADDR         1
+#define ETH1_CS          32
+#define ETH1_IRQ         33
+#define ETH1_RST         18
+ETHClass ETH1(1);
+#endif
 
 static bool eth_connected = false;
 
-void WiFiEvent(WiFiEvent_t event)
+void onEvent(arduino_event_id_t event, arduino_event_info_t info)
 {
   switch (event) {
     case ARDUINO_EVENT_ETH_START:
       Serial.println("ETH Started");
       //set eth hostname here
-      ETH.setHostname("esp32-ethernet");
+      ETH.setHostname("esp32-eth0");
       break;
     case ARDUINO_EVENT_ETH_CONNECTED:
       Serial.println("ETH Connected");
       break;
     case ARDUINO_EVENT_ETH_GOT_IP:
-      Serial.println("ETH Got IP");
+      Serial.printf("ETH Got IP: '%s'\n", esp_netif_get_desc(info.got_ip.esp_netif));
       ETH.printInfo(Serial);
+#if USE_TWO_ETH_PORTS
+      ETH1.printInfo(Serial);
+#endif
       eth_connected = true;
       break;
+    case ARDUINO_EVENT_ETH_LOST_IP:
+      Serial.println("ETH Lost IP");
+      eth_connected = false;
+      break;
     case ARDUINO_EVENT_ETH_DISCONNECTED:
       Serial.println("ETH Disconnected");
       eth_connected = false;
@@ -69,8 +89,12 @@ void testClient(const char * host, uint16_t port)
 void setup()
 {
   Serial.begin(115200);
-  WiFi.onEvent(WiFiEvent);
+  WiFi.onEvent(onEvent);
   ETH.begin(ETH_TYPE, ETH_ADDR, ETH_CS, ETH_IRQ, ETH_RST, ETH_SPI_HOST, ETH_SPI_SCK, ETH_SPI_MISO, ETH_SPI_MOSI);
+#if USE_TWO_ETH_PORTS
+  // Since SPI bus is shared, we should skip the SPI pins when calling ETH1.begin()
+  ETH1.begin(ETH1_TYPE, ETH1_ADDR, ETH1_CS, ETH1_IRQ, ETH1_RST, ETH_SPI_HOST);
+#endif
 }
 
 
diff --git a/libraries/Ethernet/src/ETH.cpp b/libraries/Ethernet/src/ETH.cpp
@@ -45,7 +45,6 @@ extern void add_esp_interface_netif(esp_interface_t interface, esp_netif_t* esp_
 
 ETHClass::ETHClass(uint8_t eth_index)
     :_eth_started(false)
-    ,_use_static_ip(false)
     ,_eth_handle(NULL)
     ,_esp_netif(NULL)
     ,_eth_index(eth_index)
@@ -616,7 +615,6 @@ bool ETHClass::begin(eth_phy_type_t type, uint8_t phy_addr, int cs, int irq, int
 void ETHClass::end(void)
 {
     _eth_started = false;
-    _use_static_ip = false;
 
     if(_esp_netif != NULL){
         esp_netif_destroy(_esp_netif);
@@ -704,53 +702,52 @@ bool ETHClass::config(IPAddress local_ip, IPAddress gateway, IPAddress subnet, I
     }
     esp_err_t err = ESP_OK;
     esp_netif_ip_info_t info;
+    esp_netif_dns_info_t d1;
+    esp_netif_dns_info_t d2;
+    d1.ip.type = IPADDR_TYPE_V4;
+    d2.ip.type = IPADDR_TYPE_V4;
 
     if(static_cast<uint32_t>(local_ip) != 0){
         info.ip.addr = static_cast<uint32_t>(local_ip);
         info.gw.addr = static_cast<uint32_t>(gateway);
         info.netmask.addr = static_cast<uint32_t>(subnet);
+        d1.ip.u_addr.ip4.addr = static_cast<uint32_t>(dns1);
+        d2.ip.u_addr.ip4.addr = static_cast<uint32_t>(dns2);
     } else {
         info.ip.addr = 0;
         info.gw.addr = 0;
         info.netmask.addr = 0;
+        d1.ip.u_addr.ip4.addr = 0;
+        d2.ip.u_addr.ip4.addr = 0;
 	}
 
+    // Stop DHCPC
     err = esp_netif_dhcpc_stop(_esp_netif);
     if(err != ESP_OK && err != ESP_ERR_ESP_NETIF_DHCP_ALREADY_STOPPED){
         log_e("DHCP could not be stopped! Error: %d", err);
         return false;
     }
 
+    // Set IPv4, Netmask, Gateway
     err = esp_netif_set_ip_info(_esp_netif, &info);
     if(err != ERR_OK){
         log_e("ETH IP could not be configured! Error: %d", err);
         return false;
     }
     
-    if(info.ip.addr){
-        _use_static_ip = true;
-    } else {
+    // Set DNS1-Server
+    esp_netif_set_dns_info(_esp_netif, ESP_NETIF_DNS_MAIN, &d1);
+
+    // Set DNS2-Server
+    esp_netif_set_dns_info(_esp_netif, ESP_NETIF_DNS_BACKUP, &d2);
+
+    // Start DHCPC if static IP was set
+    if(info.ip.addr == 0){
         err = esp_netif_dhcpc_start(_esp_netif);
         if(err != ESP_OK && err != ESP_ERR_ESP_NETIF_DHCP_ALREADY_STARTED){
             log_w("DHCP could not be started! Error: %d", err);
             return false;
         }
-        _use_static_ip = false;
-    }
-
-    esp_netif_dns_info_t d;
-    d.ip.type = IPADDR_TYPE_V4;
-
-    if(static_cast<uint32_t>(dns1) != 0) {
-        // Set DNS1-Server
-        d.ip.u_addr.ip4.addr = static_cast<uint32_t>(dns1);
-        esp_netif_set_dns_info(_esp_netif, ESP_NETIF_DNS_MAIN, &d);
-    }
-
-    if(static_cast<uint32_t>(dns2) != 0) {
-        // Set DNS2-Server
-        d.ip.u_addr.ip4.addr = static_cast<uint32_t>(dns2);
-        esp_netif_set_dns_info(_esp_netif, ESP_NETIF_DNS_BACKUP, &d);
     }
 
     return true;
@@ -880,21 +877,24 @@ IPv6Address ETHClass::localIPv6()
     return IPv6Address(addr.addr);
 }
 
-const char * ETHClass::ifkey(void){
+const char * ETHClass::ifkey(void)
+{
     if(_esp_netif == NULL){
         return "";
     }
     return esp_netif_get_ifkey(_esp_netif);
 }
 
-const char * ETHClass::desc(void){
+const char * ETHClass::desc(void)
+{
     if(_esp_netif == NULL){
         return "";
     }
     return esp_netif_get_desc(_esp_netif);
 }
 
-String ETHClass::impl_name(void){
+String ETHClass::impl_name(void)
+{
     if(_esp_netif == NULL){
         return String("");
     }
@@ -907,9 +907,18 @@ String ETHClass::impl_name(void){
     return String(netif_name);
 }
 
+bool ETHClass::connected()
+{
+    return WiFiGenericClass::getStatusBits() & ETH_CONNECTED_BIT;
+}
+
+bool ETHClass::hasIP()
+{
+    return WiFiGenericClass::getStatusBits() & ETH_HAS_IP_BIT;
+}
+
 bool ETHClass::linkUp()
 {
-    //return WiFiGenericClass::getStatusBits() & ETH_CONNECTED_BIT;
     if(_esp_netif == NULL){
         return false;
     }
diff --git a/libraries/Ethernet/src/ETH.h b/libraries/Ethernet/src/ETH.h
@@ -118,7 +118,7 @@ class ETHClass {
 #if ETH_SPI_SUPPORTS_CUSTOM
         bool begin(eth_phy_type_t type, uint8_t phy_addr, int cs, int irq, int rst, SPIClass &spi);
 #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, int miso, int mosi);
+        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);
 
         bool begin(){
 #if defined(ETH_PHY_TYPE) && defined(ETH_PHY_ADDR)
@@ -137,37 +137,38 @@ class ETHClass {
 
         void end();
 
-        bool config(IPAddress local_ip, IPAddress gateway, IPAddress subnet, IPAddress dns1 = (uint32_t)0x00000000, IPAddress dns2 = (uint32_t)0x00000000);
-
+        // 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);
-
-        bool fullDuplex();
-        bool linkUp();
-        uint8_t linkSpeed();
-        bool autoNegotiation();
-        uint32_t phyAddr();
-
-        bool enableIpV6();
-        IPv6Address localIPv6();
-
         IPAddress localIP();
         IPAddress subnetMask();
         IPAddress gatewayIP();
         IPAddress dnsIP(uint8_t dns_no = 0);
-
         IPAddress broadcastIP();
         IPAddress networkID();
         uint8_t subnetCIDR();
-
-        uint8_t * macAddress(uint8_t* mac);
-        String macAddress();
-
-        esp_netif_t * netif(void){ return _esp_netif; }
+        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;
@@ -188,7 +189,6 @@ class ETHClass {
 
     private:
         bool _eth_started;
-        bool _use_static_ip;
         esp_eth_handle_t _eth_handle;
         esp_netif_t *_esp_netif;
         uint8_t _eth_index;
diff --git a/libraries/WiFi/src/WiFiGeneric.cpp b/libraries/WiFi/src/WiFiGeneric.cpp
@@ -448,6 +448,9 @@ static void _arduino_event_cb(void* arg, esp_event_base_t event_base, int32_t ev
     	#endif
         arduino_event.event_id = ARDUINO_EVENT_ETH_GOT_IP;
     	memcpy(&arduino_event.event_info.got_ip, event_data, sizeof(ip_event_got_ip_t));
+    } else if (event_base == ETH_EVENT && event_id == IP_EVENT_ETH_LOST_IP) {
+        log_v("Ethernet Lost IP");
+        arduino_event.event_id = ARDUINO_EVENT_ETH_LOST_IP;
 
 	/*
 	 * IPv6
@@ -870,6 +873,7 @@ const char * WiFiGenericClass::eventName(arduino_event_id_t id) {
         case ARDUINO_EVENT_ETH_CONNECTED: return "ETH_CONNECTED";
         case ARDUINO_EVENT_ETH_DISCONNECTED: return "ETH_DISCONNECTED";
         case ARDUINO_EVENT_ETH_GOT_IP: return "ETH_GOT_IP";
+        case ARDUINO_EVENT_ETH_LOST_IP: return "ETH_LOST_IP";
         case ARDUINO_EVENT_ETH_GOT_IP6: return "ETH_GOT_IP6";
         case ARDUINO_EVENT_WPS_ER_SUCCESS: return "WPS_ER_SUCCESS";
         case ARDUINO_EVENT_WPS_ER_FAILED: return "WPS_ER_FAILED";
@@ -1137,6 +1141,8 @@ esp_err_t WiFiGenericClass::_eventCallback(arduino_event_t *event)
             gw[0], gw[1], gw[2], gw[3]);
 #endif
         setStatusBits(ETH_CONNECTED_BIT | ETH_HAS_IP_BIT);
+    } else if(event->event_id == ARDUINO_EVENT_ETH_LOST_IP) {
+        clearStatusBits(ETH_HAS_IP_BIT);
 
     } else if(event->event_id == ARDUINO_EVENT_WIFI_STA_GOT_IP6) {
     	setStatusBits(STA_CONNECTED_BIT | STA_HAS_IP6_BIT);
diff --git a/libraries/WiFi/src/WiFiGeneric.h b/libraries/WiFi/src/WiFiGeneric.h
@@ -59,6 +59,7 @@ typedef enum {
 	ARDUINO_EVENT_ETH_CONNECTED,
 	ARDUINO_EVENT_ETH_DISCONNECTED,
 	ARDUINO_EVENT_ETH_GOT_IP,
+	ARDUINO_EVENT_ETH_LOST_IP,
 	ARDUINO_EVENT_ETH_GOT_IP6,
 	ARDUINO_EVENT_WPS_ER_SUCCESS,
 	ARDUINO_EVENT_WPS_ER_FAILED,
