initial: add WiFi APIs

Author: facchinm

libraries/SocketWrapper/SocketHelpers.h

@@ -16,6 +16,7 @@
 
 #define DHCP_OPTION_NTP (42)
 
+#undef LOG_INF
 #define LOG_INF(...)
 
 #ifdef SPECIALIZE_FOR_ETHERNET
@@ -31,6 +32,11 @@ enum EthernetHardwareStatus {
 };
 #endif
 
+#ifdef SPECIALIZE_FOR_WIFI
+#include "utility/wl_definitions.h"
+#include <zephyr/net/wifi_mgmt.h>
+#endif
+
 class NetworkInterface {
 private:
     int iface_index = -1;
@@ -49,8 +55,6 @@ class NetworkInterface {
             return;
         }
 
-        //printk("Interface %p has IP\n", iface);
-
         for (i = 0; i < NET_IF_MAX_IPV4_ADDR; i++) {
             char buf[NET_IPV4_ADDR_LEN];
 
@@ -124,16 +128,18 @@ class NetworkInterface {
 
     void setMACAddress(const uint8_t* mac);
 
-    bool begin() {
+    bool begin(bool blocking = true, uint32_t additional_event_mask = 0) {
         dhcp();
-        net_mgmt_event_wait_on_iface(net_if_get_by_index(iface_index), NET_EVENT_IPV4_ADDR_ADD, NULL, NULL, NULL, K_FOREVER);        return 0;
+        int ret =  net_mgmt_event_wait_on_iface(net_if_get_by_index(iface_index), NET_EVENT_IPV4_ADDR_ADD | additional_event_mask,
+                    NULL, NULL, NULL, blocking ? K_FOREVER : K_SECONDS(1));
+        return (ret == 0);
     }
 
-    // Manual functions
+    // TODO: manual functions for setting IP address, subnet mask, gateway, etc.
     // net_if_ipv4_set_netmask_by_addr(iface, &addr4, &nm);
     // net_if_ipv4_addr_add(iface, &addr4, NET_ADDR_MANUAL, 0);
 
-#ifdef SPECIALIZE_FOR_ETHERNET
+#if defined(SPECIALIZE_FOR_ETHERNET) && DT_HAS_COMPAT_STATUS_OKAY(ethernet_phy)
     EthernetLinkStatus linkStatus() {
         if (net_if_is_up(net_if_get_by_index(iface_index))) {
             return LinkON;
@@ -151,4 +157,66 @@ class NetworkInterface {
         }
     }
 #endif
+
+#ifdef SPECIALIZE_FOR_WIFI
+
+#define NET_EVENT_WIFI_MASK                                                                        \
+	(NET_EVENT_WIFI_CONNECT_RESULT | NET_EVENT_WIFI_DISCONNECT_RESULT |                        \
+	 NET_EVENT_WIFI_AP_ENABLE_RESULT | NET_EVENT_WIFI_AP_DISABLE_RESULT |                      \
+	 NET_EVENT_WIFI_AP_STA_CONNECTED | NET_EVENT_WIFI_AP_STA_DISCONNECTED |                    \
+     NET_EVENT_WIFI_SCAN_RESULT)
+
+    struct net_if *sta_iface;
+    struct net_if *ap_iface;
+
+    struct wifi_connect_req_params ap_config;
+    struct wifi_connect_req_params sta_config;
+
+    bool begin(const char* ssid, const char* passphrase, wl_enc_type security = ENC_TYPE_UNKNOWN, bool blocking = false) {
+        sta_iface = net_if_get_wifi_sta();
+
+        sta_config.ssid = (const uint8_t *)ssid;
+        sta_config.ssid_length = strlen(ssid);
+        sta_config.psk = (const uint8_t *)passphrase;
+        sta_config.psk_length = strlen(passphrase);
+        // TODO: change these fields with scan() results
+        sta_config.security = WIFI_SECURITY_TYPE_PSK;
+        sta_config.channel = WIFI_CHANNEL_ANY;
+        sta_config.band = WIFI_FREQ_BAND_2_4_GHZ;
+	    sta_config.bandwidth = WIFI_FREQ_BANDWIDTH_20MHZ;
+
+        int ret = net_mgmt(NET_REQUEST_WIFI_CONNECT, sta_iface, &sta_config,
+                sizeof(struct wifi_connect_req_params));
+        if (ret) {
+            return false;
+        }
+
+        begin(false, NET_EVENT_WIFI_MASK);
+        if (blocking) {
+            net_mgmt_event_wait_on_iface(sta_iface, NET_EVENT_WIFI_AP_STA_CONNECTED, NULL, NULL, NULL, K_FOREVER);
+        }
+
+        return true;
+    }
+
+    int status() {
+        struct wifi_iface_status status = { 0 };
+
+        if (net_mgmt(NET_REQUEST_WIFI_IFACE_STATUS, net_if_get_by_index(iface_index), &status,
+                sizeof(struct wifi_iface_status))) {
+            return WL_NO_SHIELD;
+        }
+
+	    if (status.state >= WIFI_STATE_ASSOCIATED) {
+            return WL_CONNECTED;
+        } else {
+            return WL_DISCONNECTED;
+        }
+        return WL_NO_SHIELD;
+    }
+
+    int8_t scanNetworks() {
+        // TODO: borrow code from mbed core for scan results handling
+    }
+#endif
 };

libraries/SocketWrapper/WiFi.cpp

@@ -0,0 +1,3 @@
+#include "WiFi.h"
+
+NetworkInterface WiFi(1);

libraries/SocketWrapper/WiFi.h

@@ -0,0 +1,4 @@
+#define SPECIALIZE_FOR_WIFI
+#include "SocketHelpers.h"
+
+extern NetworkInterface WiFi;

libraries/SocketWrapper/utility/wl_definitions.h

@@ -0,0 +1,77 @@
+/*
+  wl_definitions.h - Library for Arduino Wifi shield.
+  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
+*/
+/*
+ * wl_definitions.h
+ *
+ *  Created on: Mar 6, 2011
+ *      Author: dlafauci
+ */
+
+#ifndef WL_DEFINITIONS_H_
+#define WL_DEFINITIONS_H_
+
+// Maximum size of a SSID
+#define WL_SSID_MAX_LENGTH 32
+// Length of passphrase. Valid lengths are 8-63.
+#define WL_WPA_KEY_MAX_LENGTH 63
+// Length of key in bytes. Valid values are 5 and 13.
+#define WL_WEP_KEY_MAX_LENGTH 13
+// Size of a MAC-address or BSSID
+#define WL_MAC_ADDR_LENGTH 6
+// Size of a MAC-address or BSSID
+#define WL_IPV4_LENGTH 4
+// Maximum size of a SSID list
+#define WL_NETWORKS_LIST_MAXNUM	10
+// Maxmium number of socket
+#define	MAX_SOCK_NUM		4
+// Socket not available constant
+#define SOCK_NOT_AVAIL  255
+// Default state value for Wifi state field
+#define NA_STATE -1
+//Maximum number of attempts to establish wifi connection
+#define WL_MAX_ATTEMPT_CONNECTION	10
+
+typedef enum {
+    WL_NO_SHIELD = 255,
+    WL_NO_MODULE = 255,
+    WL_IDLE_STATUS = 0,
+    WL_NO_SSID_AVAIL,
+    WL_SCAN_COMPLETED,
+    WL_CONNECTED,
+    WL_CONNECT_FAILED,
+    WL_CONNECTION_LOST,
+    WL_DISCONNECTED,
+    WL_AP_LISTENING,
+    WL_AP_CONNECTED,
+    WL_AP_FAILED
+} wl_status_t;
+
+/* Encryption modes */
+enum wl_enc_type {  /* Values map to 802.11 Cipher Algorithm Identifier */
+    ENC_TYPE_WEP  = 5,
+    ENC_TYPE_TKIP = 2,
+    ENC_TYPE_WPA = ENC_TYPE_TKIP,
+    ENC_TYPE_CCMP = 4,
+    ENC_TYPE_WPA2 = ENC_TYPE_CCMP,
+    ENC_TYPE_GCMP = 6,
+    ENC_TYPE_WPA3 = ENC_TYPE_GCMP,
+    /* ... except these two, 7 and 8 are reserved in 802.11-2007 */
+    ENC_TYPE_NONE = 7,
+    ENC_TYPE_UNKNOWN = 9,
+    ENC_TYPE_AUTO = 8
+};
+
+#endif /* WL_DEFINITIONS_H_ */

loader/llext_exports.c

@@ -64,10 +64,16 @@ FORCE_EXPORT_SYM(net_dhcpv4_add_option_callback);
 #endif
 
 #if defined(CONFIG_NET_MGMT_EVENT)
+FORCE_EXPORT_SYM(net_mgmt_NET_REQUEST_WIFI_CONNECT);
+FORCE_EXPORT_SYM(net_mgmt_NET_REQUEST_WIFI_IFACE_STATUS);
 FORCE_EXPORT_SYM(net_mgmt_add_event_callback);
 FORCE_EXPORT_SYM(net_mgmt_event_wait_on_iface);
 #endif
 
+#if defined(CONFIG_WIFI)
+FORCE_EXPORT_SYM(net_if_get_wifi_sta);
+#endif
+
 #if defined(CONFIG_BT)
 FORCE_EXPORT_SYM(bt_enable_raw);
 FORCE_EXPORT_SYM(bt_hci_raw_set_mode);