modules: hostap: add 11k/v/r roaming support

nxf58150 · aescolar · commit 83812f213f2e · 2024-10-25T13:53:49.000+02:00
Added new ops and events in glue layer to support roaming.
Added new flag WIFI_NM_WPA_SUPPLICANT_ROAMING to control roaming
feature.

Signed-off-by: Hui Bai &lt;hui.bai@nxp.com&gt;
diff --git a/include/zephyr/net/wifi.h b/include/zephyr/net/wifi.h
@@ -78,6 +78,14 @@ enum wifi_security_type {
 	WIFI_SECURITY_TYPE_EAP_PEAP_TLS,
 	/** EAP TLS SHA256 security - Enterprise. */
 	WIFI_SECURITY_TYPE_EAP_TLS_SHA256,
+	/** FT-PSK security */
+	WIFI_SECURITY_TYPE_FT_PSK,
+	/** FT-SAE security */
+	WIFI_SECURITY_TYPE_FT_SAE,
+	/** FT-EAP security */
+	WIFI_SECURITY_TYPE_FT_EAP,
+	/** FT-EAP-SHA384 security */
+	WIFI_SECURITY_TYPE_FT_EAP_SHA384,
 
 	/** @cond INTERNAL_HIDDEN */
 	__WIFI_SECURITY_TYPE_AFTER_LAST,
diff --git a/include/zephyr/net/wifi_mgmt.h b/include/zephyr/net/wifi_mgmt.h
@@ -117,6 +117,12 @@ enum net_request_wifi_cmd {
 	/** Connect to APs stored using wifi_credentials library. */
 	NET_REQUEST_WIFI_CMD_CONNECT_STORED,
 #endif
+	/** Start roaming */
+	NET_REQUEST_WIFI_CMD_START_ROAMING,
+	/** Neighbor report complete */
+	NET_REQUEST_WIFI_CMD_NEIGHBOR_REP_COMPLETE,
+	/** Specific scan */
+	NET_REQUEST_WIFI_CMD_CANDIDATE_SCAN,
 	/** @cond INTERNAL_HIDDEN */
 	NET_REQUEST_WIFI_CMD_MAX
 	/** @endcond */
@@ -282,6 +288,16 @@ NET_MGMT_DEFINE_REQUEST_HANDLER(NET_REQUEST_WIFI_WPS_CONFIG);
 NET_MGMT_DEFINE_REQUEST_HANDLER(NET_REQUEST_WIFI_CONNECT_STORED);
 #endif
 
+#define NET_REQUEST_WIFI_START_ROAMING				\
+	(_NET_WIFI_BASE | NET_REQUEST_WIFI_CMD_START_ROAMING)
+
+NET_MGMT_DEFINE_REQUEST_HANDLER(NET_REQUEST_WIFI_START_ROAMING);
+
+#define NET_REQUEST_WIFI_NEIGHBOR_REP_COMPLETE			\
+	(_NET_WIFI_BASE | NET_REQUEST_WIFI_CMD_NEIGHBOR_REP_COMPLETE)
+
+NET_MGMT_DEFINE_REQUEST_HANDLER(NET_REQUEST_WIFI_NEIGHBOR_REP_COMPLETE);
+
 /** @brief Wi-Fi management events */
 enum net_event_wifi_cmd {
 	/** Scan results available */
@@ -304,6 +320,12 @@ enum net_event_wifi_cmd {
 	NET_EVENT_WIFI_CMD_RAW_SCAN_RESULT,
 	/** Disconnect complete */
 	NET_EVENT_WIFI_CMD_DISCONNECT_COMPLETE,
+	/** Signal change event */
+	NET_EVENT_WIFI_CMD_SIGNAL_CHANGE,
+	/** Neighbor Report */
+	NET_EVENT_WIFI_CMD_NEIGHBOR_REP_RECEIVED,
+	/** Neighbor Report complete */
+	NET_EVENT_WIFI_CMD_NEIGHBOR_REP_COMPLETE,
 	/** AP mode enable result */
 	NET_EVENT_WIFI_CMD_AP_ENABLE_RESULT,
 	/** AP mode disable result */
@@ -352,6 +374,14 @@ enum net_event_wifi_cmd {
 #define NET_EVENT_WIFI_DISCONNECT_COMPLETE			\
 	(_NET_WIFI_EVENT | NET_EVENT_WIFI_CMD_DISCONNECT_COMPLETE)
 
+/** Event signal change of connected AP */
+#define NET_EVENT_WIFI_SIGNAL_CHANGE				\
+	(_NET_WIFI_EVENT | NET_EVENT_WIFI_CMD_SIGNAL_CHANGE)
+
+/** Event Neighbor Report Completed */
+#define NET_EVENT_WIFI_NEIGHBOR_REP_COMP			\
+	(_NET_WIFI_EVENT | NET_EVENT_WIFI_CMD_NEIGHBOR_REP_COMPLETE)
+
 /** Event emitted for Wi-Fi access point enable result */
 #define NET_EVENT_WIFI_AP_ENABLE_RESULT				\
 	(_NET_WIFI_EVENT | NET_EVENT_WIFI_CMD_AP_ENABLE_RESULT)
@@ -1417,6 +1447,21 @@ struct wifi_mgmt_ops {
 	 * @return 0 if ok, < 0 if error
 	 */
 	int (*wps_config)(const struct device *dev, struct wifi_wps_config_params *params);
+	/** Trigger candidate scan
+	 *
+	 * @param dev Pointer to the device structure for the driver instance
+	 * @param params Scan parameters
+	 *
+	 * @return 0 if ok, < 0 if error
+	 */
+	int (*candidate_scan)(const struct device *dev, struct wifi_scan_params *params);
+	/** Start 11r roaming
+	 *
+	 * @param dev Pointer to the device structure for the driver instance
+	 *
+	 * @return 0 if ok, < 0 if error
+	 */
+	int (*start_11r_roaming)(const struct device *dev);
 };
 
 /** Wi-Fi management offload API */
@@ -1508,6 +1553,17 @@ void wifi_mgmt_raise_raw_scan_result_event(struct net_if *iface,
  */
 void wifi_mgmt_raise_disconnect_complete_event(struct net_if *iface, int status);
 
+#ifdef CONFIG_WIFI_NM_WPA_SUPPLICANT_ROAMING
+/** Wi-Fi management neighbor reports event
+ *
+ * @param iface Network interface
+ * @param inbuf Input buffer of neighbor reports
+ * @param buf_len Lenghth of input buffer
+ */
+void wifi_mgmt_raise_neighbor_rep_recv_event(struct net_if *iface,
+					     char *inbuf, size_t buf_len);
+#endif
+
 /** Wi-Fi management AP mode enable result event
  *
  * @param iface Network interface
diff --git a/modules/hostap/Kconfig b/modules/hostap/Kconfig
@@ -303,6 +303,23 @@ if WIFI_NM_WPA_SUPPLICANT_CRYPTO_ENTERPRISE
 		default 16384
 endif
 
+config WIFI_NM_WPA_SUPPLICANT_ROAMING
+	bool "Roaming support"
+	imply IEEE80211R
+	help
+	  Enable roaming support with wpa_supplicant. When current BSS RSSI drops,
+	  STA will try to find an AP with better RSSI. If found, STA will reassociate
+	  to the new AP automatically without losing connection.
+
+config WIFI_NM_WPA_SUPPLICANT_SKIP_DHCP_ON_ROAMING
+	bool "Skip DHCP after roaming to new AP"
+	help
+	  For L2 roaming, the original AP and new AP are in the same subnet, client
+	  can use same IP address and skip DHCP. Enable this to skip DHCP.
+	  For L3 roaming, the original AP and new AP are in different subnet, client
+	  needs to get new IP address after roaming to new AP. Disable this to keep
+	  DHCP after roaming.
+
 # Create hidden config options that are used in hostap. This way we do not need
 # to mark them as allowed for CI checks, and also someone else cannot use the
 # same name options.
diff --git a/modules/hostap/src/supp_api.c b/modules/hostap/src/supp_api.c
@@ -380,6 +380,14 @@ static inline enum wifi_security_type wpas_key_mgmt_to_zephyr(int key_mgmt, int
 		return WIFI_SECURITY_TYPE_SAE;
 	case WPA_KEY_MGMT_SAE | WPA_KEY_MGMT_PSK:
 		return WIFI_SECURITY_TYPE_WPA_AUTO_PERSONAL;
+	case WPA_KEY_MGMT_FT_PSK:
+		return WIFI_SECURITY_TYPE_FT_PSK;
+	case WPA_KEY_MGMT_FT_SAE:
+		return WIFI_SECURITY_TYPE_FT_SAE;
+	case WPA_KEY_MGMT_FT_IEEE8021X:
+		return WIFI_SECURITY_TYPE_FT_EAP;
+	case WPA_KEY_MGMT_FT_IEEE8021X_SHA384:
+		return WIFI_SECURITY_TYPE_FT_EAP_SHA384;
 	default:
 		return WIFI_SECURITY_TYPE_UNKNOWN;
 	}
@@ -1435,6 +1443,71 @@ int supplicant_11k_neighbor_request(const struct device *dev, struct wifi_11k_pa
 	return 0;
 }
 
+#ifdef CONFIG_WIFI_NM_WPA_SUPPLICANT_ROAMING
+#define SUPPLICANT_CANDIDATE_SCAN_CMD_BUF_SIZE 100
+int supplicant_candidate_scan(const struct device *dev, struct wifi_scan_params *params)
+{
+	int i = 0;
+	char cmd[SUPPLICANT_CANDIDATE_SCAN_CMD_BUF_SIZE] = {0};
+	char *pos = cmd;
+	char *end = pos + SUPPLICANT_CANDIDATE_SCAN_CMD_BUF_SIZE;
+	int freq = 0;
+
+	strcpy(pos, "freq=");
+	pos += 5;
+	while (params->band_chan[i].channel) {
+		if (i > 0) {
+			pos += snprintf(pos, end - pos, ",");
+		}
+		freq = chan_to_freq(params->band_chan[i].channel);
+		pos += snprintf(pos, end - pos, "%d", freq);
+		i++;
+	}
+
+	if (!wpa_cli_cmd_v("scan %s", cmd)) {
+		wpa_printf(MSG_ERROR,
+			   "%s: cli cmd <scan %s> fail",
+			   __func__, cmd);
+		return -1;
+	}
+
+	return 0;
+}
+
+int supplicant_11r_roaming(const struct device *dev)
+{
+	struct wpa_supplicant *wpa_s;
+	int ret = 0;
+
+	k_mutex_lock(&wpa_supplicant_mutex, K_FOREVER);
+
+	wpa_s = get_wpa_s_handle(dev);
+	if (!wpa_s) {
+		wpa_printf(MSG_ERROR, "Device %s not found", dev->name);
+		ret = -1;
+		goto out;
+	}
+
+	if (wpa_s->reassociate || (wpa_s->wpa_state >= WPA_AUTHENTICATING &&
+	    wpa_s->wpa_state < WPA_COMPLETED)) {
+		wpa_printf(MSG_INFO, "Reassociation is in progress, skip");
+		ret = 0;
+		goto out;
+	}
+
+	if (!wpa_cli_cmd_v("reassociate")) {
+		wpa_printf(MSG_ERROR, "%s: cli cmd <reassociate> fail",
+			   __func__);
+		ret = -1;
+		goto out;
+	}
+
+out:
+	k_mutex_unlock(&wpa_supplicant_mutex);
+	return ret;
+}
+#endif
+
 int supplicant_set_power_save(const struct device *dev, struct wifi_ps_params *params)
 {
 	const struct wifi_mgmt_ops *const wifi_mgmt_api = get_wifi_mgmt_api(dev);
diff --git a/modules/hostap/src/supp_api.h b/modules/hostap/src/supp_api.h
@@ -118,6 +118,25 @@ int supplicant_11k_cfg(const struct device *dev, struct wifi_11k_params *params)
  */
 int supplicant_11k_neighbor_request(const struct device *dev, struct wifi_11k_params *params);
 
+#ifdef CONFIG_WIFI_NM_WPA_SUPPLICANT_ROAMING
+/** Send candidate scan request
+ *
+ * @param dev Pointer to the device structure for the driver instance.
+ * @param params Scan parameters
+ *
+ * @return 0 if ok, < 0 if error
+ */
+int supplicant_candidate_scan(const struct device *dev, struct wifi_scan_params *params);
+
+/** Send 11r roaming request
+ *
+ * @param dev Pointer to the device structure for the driver instance.
+ *
+ * @return 0 if ok, < 0 if error
+ */
+int supplicant_11r_roaming(const struct device *dev);
+#endif
+
 /**
  * @brief Set Wi-Fi power save configuration
  *
diff --git a/modules/hostap/src/supp_events.c b/modules/hostap/src/supp_events.c
@@ -368,6 +368,21 @@ int supplicant_send_wifi_mgmt_event(const char *ifname, enum net_event_wifi_cmd
 			iface,
 			*(int *)supplicant_status);
 		break;
+#ifdef CONFIG_WIFI_NM_WPA_SUPPLICANT_ROAMING
+	case NET_EVENT_WIFI_CMD_SIGNAL_CHANGE:
+		net_mgmt_event_notify_with_info(NET_EVENT_WIFI_SIGNAL_CHANGE,
+						iface, NULL, 0);
+		break;
+	case NET_EVENT_WIFI_CMD_NEIGHBOR_REP_RECEIVED:
+		wifi_mgmt_raise_neighbor_rep_recv_event(
+			iface,
+			(char *)supplicant_status, len);
+		break;
+	case NET_EVENT_WIFI_CMD_NEIGHBOR_REP_COMPLETE:
+		net_mgmt_event_notify_with_info(NET_EVENT_WIFI_NEIGHBOR_REP_COMP,
+						iface, NULL, 0);
+		break;
+#endif
 #ifdef CONFIG_AP
 	case NET_EVENT_WIFI_CMD_AP_ENABLE_RESULT:
 		wifi_mgmt_raise_ap_enable_result_event(iface,
diff --git a/modules/hostap/src/supp_main.c b/modules/hostap/src/supp_main.c
@@ -64,6 +64,10 @@ static const struct wifi_mgmt_ops mgmt_ops = {
 #endif
 	.cfg_11k = supplicant_11k_cfg,
 	.send_11k_neighbor_request = supplicant_11k_neighbor_request,
+#ifdef CONFIG_WIFI_NM_WPA_SUPPLICANT_ROAMING
+	.candidate_scan = supplicant_candidate_scan,
+	.start_11r_roaming = supplicant_11r_roaming,
+#endif
 	.set_power_save = supplicant_set_power_save,
 	.set_twt = supplicant_set_twt,
 	.get_power_save_config = supplicant_get_power_save_config,
diff --git a/samples/net/wifi/boards/frdm_rw612.conf b/samples/net/wifi/boards/frdm_rw612.conf
@@ -88,6 +88,8 @@ CONFIG_WIFI_NM_MAX_MANAGED_INTERFACES=2
 CONFIG_SAE_PWE_EARLY_EXIT=y
 CONFIG_WIFI_NM_HOSTAPD_AP=y
 CONFIG_WIFI_NM_WPA_SUPPLICANT_WPS=y
+CONFIG_WIFI_NM_WPA_SUPPLICANT_ROAMING=y
+CONFIG_WIFI_NM_WPA_SUPPLICANT_SKIP_DHCP_ON_ROAMING=y
 
 # Enable mbedtls
 CONFIG_MBEDTLS=y
diff --git a/samples/net/wifi/boards/rd_rw612_bga.conf b/samples/net/wifi/boards/rd_rw612_bga.conf
@@ -87,6 +87,8 @@ CONFIG_WIFI_NM_MAX_MANAGED_INTERFACES=2
 CONFIG_SAE_PWE_EARLY_EXIT=y
 CONFIG_WIFI_NM_HOSTAPD_AP=y
 CONFIG_WIFI_NM_WPA_SUPPLICANT_WPS=y
+CONFIG_WIFI_NM_WPA_SUPPLICANT_ROAMING=y
+CONFIG_WIFI_NM_WPA_SUPPLICANT_SKIP_DHCP_ON_ROAMING=y
 
 # Enable mbedtls
 CONFIG_MBEDTLS=y
diff --git a/subsys/net/l2/wifi/wifi_mgmt.c b/subsys/net/l2/wifi/wifi_mgmt.c
diff --git a/subsys/net/l2/wifi/wifi_shell.c b/subsys/net/l2/wifi/wifi_shell.c
