making netif compatible with connection handler usage

andreagilardoni · andreagilardoni · commit ec3cba55e473 · 2024-01-22T14:19:07.000+01:00
diff --git a/libraries/WiFi/src/WiFi.cpp b/libraries/WiFi/src/WiFi.cpp
@@ -23,16 +23,16 @@ const char* CWifi::firmwareVersion() {
 /* -------------------------------------------------------------------------- */
 int CWifi::begin(const char* ssid) {
 /* -------------------------------------------------------------------------- */
-    WiFiStation.begin();
-    return WiFiStation.connectToAP(ssid, nullptr);
+    WiFiStation.connectToAP(ssid, nullptr);
+    return WiFiStation.begin();
 }
 
 
 /* -------------------------------------------------------------------------- */
 int CWifi::begin(const char* ssid, const char *passphrase) {
 /* -------------------------------------------------------------------------- */
-    WiFiStation.begin();
-    return WiFiStation.connectToAP(ssid, passphrase);
+    WiFiStation.connectToAP(ssid, passphrase);
+    return WiFiStation.begin();;
 }
 
 /* passphrase is needed so a default one will be set */
@@ -242,6 +242,7 @@ uint8_t CWifi::channel(uint8_t networkItem) {
 uint8_t CWifi::status() { // FIXME
 /* -------------------------------------------------------------------------- */
     // return CLwipIf::getInstance().getWifiStatus();
+    return WiFiStation.status();
 }
 
 /* -------------------------------------------------------------------------- */
diff --git a/libraries/lwIpWrapper/src/CNetIf.cpp b/libraries/lwIpWrapper/src/CNetIf.cpp
@@ -597,11 +597,19 @@ CWifiStation::~CWifiStation() {
 }
 
 int CWifiStation::begin(const IPAddress &ip, const IPAddress &nm, const IPAddress &gw) {
-    int res = 0;
+    return CNetIf::begin(ip, nm, gw);
+}
+
+int CWifiStation::connectToAP(const char* ssid, const char *passphrase) {
+    WifiApCfg_t ap;
+    int rv = ESP_CONTROL_CTRL_ERROR; // FIXME this should be set with an error meaning AP not found
+    bool found = false;
+    int8_t best_index = -1; // this index is used to find the ap with the best rssi
     int time_num = 0;
 
     CEspControl::getInstance().listenForStationDisconnectEvent([this] (CCtrlMsgWrapper *resp) -> int {
         netif_set_link_down(&this->ni);
+        wifi_status = WL_DISCONNECTED;
         return ESP_CONTROL_OK;
     });
     CEspControl::getInstance().listenForInitEvent([this] (CCtrlMsgWrapper *resp) -> int {
@@ -610,10 +618,11 @@ int CWifiStation::begin(const IPAddress &ip, const IPAddress &nm, const IPAddres
         return ESP_CONTROL_OK;
     });
 
-    if ((res=CEspControl::getInstance().initSpiDriver()) != 0) {
-        res = -1; // FIXME put a proper error code
+    if ((rv=CEspControl::getInstance().initSpiDriver()) != 0  && !hw_init) {
+        rv = -1; // FIXME put a proper error code
         goto exit;
     }
+    wifi_status = WL_NO_SSID_AVAIL;
 
     while (time_num < 100 && !hw_init) { // TODO #define WIFI_INIT_TIMEOUT_MS 10000
         CEspControl::getInstance().communicateWithEsp();
@@ -622,21 +631,11 @@ int CWifiStation::begin(const IPAddress &ip, const IPAddress &nm, const IPAddres
     }
 
     CLwipIf::getInstance().sync_timer();
-    res = CEspControl::getInstance().setWifiMode(WIFI_MODE_STA);
+    rv = CEspControl::getInstance().setWifiMode(WIFI_MODE_STA);
     CLwipIf::getInstance().enable_timer();
 
-    return CNetIf::begin(ip, nm, gw);
-exit:
-    return res;
-}
-
-int CWifiStation::connectToAP(const char* ssid, const char *passphrase) {
-    WifiApCfg_t ap;
-    int rv = ESP_CONTROL_CTRL_ERROR; // FIXME this should be set with an error meaning AP not found
-    bool found = false;
-    int8_t best_index = -1; // this index is used to find the ap with the best rssi
-
     if((rv=this->scanForAp()) != WL_SCAN_COMPLETED) {
+        rv = -2;
         goto exit;
     }
 
@@ -666,8 +665,12 @@ int CWifiStation::connectToAP(const char* ssid, const char *passphrase) {
 
         if (rv == ESP_CONTROL_OK) {
             CEspControl::getInstance().getAccessPointConfig(access_point_cfg);
+            wifi_status = WL_CONNECTED;
+
 
             netif_set_link_up(&this->ni);
+        } else {
+            wifi_status = WL_CONNECT_FAILED;
         }
         CLwipIf::getInstance().enable_timer();
     }
@@ -685,13 +688,13 @@ int CWifiStation::scanForAp() {
     CLwipIf::getInstance().enable_timer();
 
     if (res == ESP_CONTROL_OK) {
-        res = WL_SCAN_COMPLETED;
+        wifi_status = WL_SCAN_COMPLETED;
     } else {
-        res = WL_NO_SSID_AVAIL;
+        wifi_status = WL_NO_SSID_AVAIL;
     }
 
 
-    return res;
+    return wifi_status;
 }
 
 // disconnect
diff --git a/libraries/lwIpWrapper/src/CNetIf.h b/libraries/lwIpWrapper/src/CNetIf.h
@@ -79,12 +79,17 @@ typedef enum {
     NI_ETHERNET
 } NetIfType_t;
 
-enum EthernetLinkStatus {
+enum LinkStatus {
     Unknown,
     LinkON,
     LinkOFF
 };
 
+enum EthernetHardwareStatus {
+    EthernetNoHardware,
+    EthernetLwip = 7
+};
+
 #define MAX_CLIENT MEMP_NUM_TCP_PCB
 #define MAX_DHCP_TRIES 4
 #define TIMEOUT_DNS_REQUEST 10000U
@@ -148,7 +153,7 @@ class CNetIf: public NetworkInterface {
 
     inline int disconnect() { this->down(); return 0; }
 
-    inline EthernetLinkStatus linkStatus() { return netif_is_link_up(&ni) ? LinkON : LinkOFF; }
+    inline LinkStatus linkStatus() { return netif_is_link_up(&ni) ? LinkON : LinkOFF; }
 
     bool isLinkUp() { return (bool)netif_is_link_up(&ni); }
 
@@ -164,16 +169,10 @@ class CNetIf: public NetworkInterface {
     IPAddress gatewayIP()   { return IPAddress(this->getGwAdd()); }
     IPAddress dnsServerIP() { /* FIXME understand where dns should be managed */}
 
-    // FIXME hostname should be defined in the NetworkStack singleton
-    // void setHostname(const char* name)
-    // {
-    //     memset(hostname, 0x00, MAX_HOSTNAME_DIM);
-    //     memcpy(hostname, name, strlen(name) < MAX_HOSTNAME_DIM ? strlen(name) : MAX_HOSTNAME_DIM);
-    // }
     void config(IPAddress _ip, IPAddress _gw, IPAddress _nm);
 
-
     virtual int getMacAddress(uint8_t* mac) = 0;
+    virtual int setMacAddress(uint8_t* mac) = 0;
 
     friend CLwipIf;
 protected:
@@ -216,13 +215,40 @@ class CEth : public CNetIf {
         const IPAddress &gw = INADDR_NONE,
         const IPAddress &dns = INADDR_NONE);
 
+    // The following are overloaded begin methods kept for retrocompatibility with other Arduino cores
+    // Initialise the Ethernet shield to use the provided MAC address and gain the rest of the
+    // configuration through DHCP.
+    // Returns 0 if the DHCP configuration failed, and 1 if it succeeded
+    virtual int begin(
+        uint8_t *mac_address,
+        const IPAddress &local_ip           = INADDR_NONE,
+        const IPAddress &dns_server         = INADDR_NONE,
+        const IPAddress &gateway            = INADDR_NONE,
+        const IPAddress &subnet             = INADDR_NONE,
+        const unsigned long timeout         = 60000,
+        const unsigned long responseTimeout = 4000);
+
+    virtual int begin(
+        uint8_t *mac_address,
+        const unsigned long timeout         = 60000,
+        const unsigned long responseTimeout = 4000);
+
+
     virtual int getMacAddress(uint8_t* mac) override {
         UNUSED(mac); // FIXME not implemented
         return 1;
     }
 
+    virtual int setMacAddress(uint8_t* mac) override {
+        UNUSED(mac); // FIXME not implemented
+        return 1;
+    }
+
+
     int maintain() {} // Deprecated method for retrocompatibility
     void schedule(void) {} // Deprecated method for retrocompatibility
+
+    inline EthernetHardwareStatus hardwareStatus() { return EthernetLwip; }
 protected:
     /*
      * this function is used to initialize the netif structure of lwip
@@ -262,6 +288,11 @@ class CWifiStation : public CNetIf {
         // FIXME not implemented
     }
 
+    virtual int setMacAddress(uint8_t* mac) override {
+        UNUSED(mac); // FIXME not implemented
+        return 1;
+    }
+
     virtual const char* getSSID();
     virtual uint8_t* getBSSID(uint8_t* bssid);
     virtual int32_t getRSSI();
@@ -276,6 +307,10 @@ class CWifiStation : public CNetIf {
 
     int setLowPowerMode();
     int resetLowPowerMode();
+
+    inline WifiStatus_t status() {
+        return wifi_status;
+    }
 protected:
     static const char wifistation_ifname[];
 
@@ -293,6 +328,7 @@ class CWifiStation : public CNetIf {
     std::vector<AccessPoint_t> access_points;
     WifiApCfg_t access_point_cfg;
     bool hw_init; // TODO this should be moved to the wifi driver class
+    WifiStatus_t wifi_status = WL_IDLE_STATUS; // TODO this should be moved to the wifi driver class
 };
 
 class CWifiSoftAp : public CNetIf {
@@ -312,6 +348,11 @@ class CWifiSoftAp : public CNetIf {
         // FIXME not implemented
     }
 
+    virtual int setMacAddress(uint8_t* mac) override {
+        UNUSED(mac); // FIXME not implemented
+        return 1;
+    }
+
     virtual const char* getSSID();
     virtual uint8_t* getBSSID(uint8_t* bssid);
     virtual uint8_t getEncryptionType();
