v2.6: Backport latest fixes

doc/nrf/libraries/networking/wifi_ready.rst

@@ -0,0 +1,30 @@
+.. _lib_wifi_ready:
+
+Wi-Fi ready
+###########
+
+.. contents::
+   :local:
+   :depth: 2
+
+The Wi-Fi ready library manages Wi-Fi® readiness for applications by handling supplicant ready and not ready events.
+
+Overview
+********
+
+The Wi-Fi ready library informs applications of Wi-Fi readiness by managing supplicant events, indicating when Wi-Fi is available for use.
+
+Configuration
+*************
+
+To use this library, enable the :kconfig:option:`CONFIG_WIFI_READY_LIB` Kconfig option.
+
+API documentation
+*****************
+
+| Header file: :file:`include/net/wifi_ready.h`
+| Source files: :file:`subsys/net/lib/wifi_ready`
+
+.. doxygengroup:: wifi_ready
+   :project: nrf
+   :members:

doc/nrf/releases_and_maturity/releases/release-notes-changelog.rst

@@ -295,7 +295,7 @@ This section provides detailed lists of changes by :ref:`driver <drivers>`.
 Wi-Fi drivers
 -------------
 
-|no_changes_yet_note|
+* Added a new feature to recover nRF70 chip.
 
 Libraries
 =========
@@ -335,7 +335,7 @@ Modem libraries
 Libraries for networking
 ------------------------
 
-|no_changes_yet_note|
+* Added the :ref:`lib_wifi_ready` library.
 
 Libraries for NFC
 -----------------

drivers/wifi/nrf700x/Kconfig

@@ -620,3 +620,130 @@ config NRF_WIFI_AP_DEAD_DETECT_TIMEOUT
 	help
 		The number of seconds after which AP is declared dead if no beacons
 		are received from the AP. Used to detect AP silently going down e.g., power off.
+
+choice NRF_WIFI_PS_DATA_RETRIEVAL_MECHANISM
+	prompt "Power save data retrieval mechanism"
+	default NRF_WIFI_PS_POLL_BASED_RETRIEVAL
+	help
+	  Select the mechanism to retrieve buffered data from AP.
+
+config NRF_WIFI_PS_POLL_BASED_RETRIEVAL
+	bool "PS-Poll frame based mechanism to retrieve buffered data from AP"
+	help
+	  When AP notifies about availability of buffered data, the STA stays in power save
+	  and retrieves the frames one-by-one, this conserved more power but adds latency
+	  to the traffic. Ideal for minimum number of frames.
+
+config NRF_WIFI_QOS_NULL_BASED_RETRIEVAL
+	bool "QoS null frame based mechanism to retrieve buffered data from AP"
+	help
+	  When AP notifies about availability of buffered data, the STA comes out of
+	  power save and then AP can deliver all buffered frames without any additional
+	  overhead or latency, but STA enters power save after a delay costing more power
+	  depending on the delay. Ideal for heavy buffered traffic.
+
+endchoice
+
+config NRF_WIFI_MGMT_BUFF_OFFLOAD
+	bool "Enable management buffer offload"
+	default y
+
+config NRF_WIFI_RPU_RECOVERY
+	bool "Enable RPU recovery mechanism"
+	depends on NRF_WIFI_LOW_POWER
+	select EXPERIMENTAL
+	default y
+	help
+		Enable RPU recovery mechanism to recover from RPU (nRF70) hang.
+		This feature performs an interface reset (down and up) which triggers
+		a RPU coldboot. Application's network connection will be lost during
+		the recovery process and it is application's responsibility to
+		re-establish the network connection.
+
+config NRF_WIFI_CMD_EVENT_LOG
+	bool "Enable command event logging"
+	help
+		Enable command event logging to help debug Wi-Fi command events.
+if NRF_WIFI_RPU_RECOVERY
+
+config NRF_WIFI_RPU_RECOVERY_PROPAGATION_DELAY_MS
+	int "RPU recovery propagation delay in milliseconds"
+	default 2000
+	help
+		Propagation delay in milliseconds to wait after RPU is powered down
+		before powering it up. This delay is required to ensure that the recovery
+		is propagted to all the applications and stack and have enough time to
+		clean up the resources.
+
+config NRF_WIFI_RPU_RECOVERY_PS_ACTIVE_TIMEOUT_MS
+	int "RPU recovery power save active timeout in milliseconds"
+	default 50000
+	help
+		Power save active timeout in milliseconds after which RPU recovery
+		mechanism will be triggered. This timeout is used to ensure that the
+		RPU attempts to enter power save mode in case of inactivity.
+
+config NRF_WIFI_RPU_MIN_TIME_TO_ENTER_SLEEP_MS
+	int "Minimum idle time to enter sleep in milliseconds"
+	range 100 5000
+	default 1000
+	help
+		Minimum time the host should de-assert WAKEUP_NOW and let RPU enter
+		sleep mode, assuming there is no activity.
+
+config NRF_WIFI_RPU_RECOVERY_DEBUG
+	bool "Enable RPU recovery debug logs"
+	help
+		Enable RPU recovery debug logs to help debug RPU recovery mechanism.
+
+config NRF_WIFI_RPU_RECOVERY_QUIET_PERIOD_MS
+	int "RPU recovery quiet period in milliseconds"
+	default 5000
+	help
+		Quiet period in milliseconds after RPU recovery is triggered. During
+		this period, no new RPU recovery will be triggered.
+
+config NRF_WIFI_RPU_RECOVERY_MAX_RETRIES
+	int "Maximum number of consecutive RPU recovery retries, 0 to disable"
+	default 0
+	help
+		Maximum number of consecutive RPU recovery retries before giving up
+		and resetting the system. Set to 0 to keep retrying indefinitely.
+
+config NRF_WIFI_RPU_RECOVERY_RETRY_WINDOW_S
+	int "RPU recovery retry window in seconds"
+	default 900
+	help
+		Window in seconds during which the number of consecutive RPU recovery
+		retries are counted. If the number of consecutive RPU recovery retries
+		exceeds NRF_WIFI_RPU_RECOVERY_MAX_RETRIES within this window, the system
+		will be reset.
+
+config NRF_WIFI_RPU_RECOVERY_PS_STATE_DEBUG
+	bool "Enable RPU recovery power save state debug logs"
+	help
+		Enable RPU recovery power save state debug logs to help debug RPU recovery mechanism.
+
+
+config NET_MGMT_EVENT_QUEUE_SIZE
+	# Doing interface down and up even with delay puts a lot of events in the queue
+	default 16
+endif
+
+config NRF_WIFI_FEAT_KEEPALIVE
+	bool "Enable Wi-Fi keepalive feature"
+	depends on NRF700X_STA_MODE
+	help
+		Enable Wi-Fi keepalive feature to keep the connection alive by sending
+		keepalive packets to the AP. Primarily intended to interoperate with APs
+		that disconnect idle clients without any explicit checks. Slightly increases
+		power consumption.
+
+if NRF_WIFI_FEAT_KEEPALIVE
+config NRF_WIFI_KEEPALIVE_PERIOD_S
+	int "Keepalive period in seconds"
+	range 30 3600
+	default 60
+	help
+		Keepalive period in seconds to send keepalive packets to the AP.
+endif

drivers/wifi/nrf700x/inc/fmac_main.h

@@ -69,18 +69,16 @@ struct nrf_wifi_vif_ctx_zep {
 	struct wifi_ps_config *ps_info;
 	bool ps_config_info_evnt;
 	bool authorized;
-	struct nrf_wifi_ext_capa {
-		enum nrf_wifi_iftype iftype;
-		unsigned char *ext_capa, *ext_capa_mask;
-		unsigned int ext_capa_len;
-	} iface_ext_capa;
 	bool cookie_resp_received;
 #ifdef CONFIG_NRF700X_DATA_TX
 	struct k_work nrf_wifi_net_iface_work;
 #endif /* CONFIG_NRF700X_DATA_TX */
 	unsigned long rssi_record_timestamp_us;
 	signed short rssi;
 #endif /* CONFIG_NRF700X_STA_MODE */
+#ifdef CONFIG_NRF_WIFI_RPU_RECOVERY
+	struct k_work nrf_wifi_rpu_recovery_work;
+#endif /* CONFIG_NRF_WIFI_RPU_RECOVERY */
 };
 
 struct nrf_wifi_vif_ctx_map {
@@ -104,6 +102,12 @@ struct nrf_wifi_ctx_zep {
 #endif /* CONFIG_NRF700X_RADIO_TEST */
 	unsigned char *extended_capa, *extended_capa_mask;
 	unsigned int extended_capa_len;
+	struct k_mutex rpu_lock;
+#ifdef CONFIG_NRF_WIFI_RPU_RECOVERY
+	bool rpu_recovery_in_progress;
+	unsigned long last_rpu_recovery_time_ms;
+	unsigned int rpu_recovery_retries;
+#endif /* CONFIG_NRF_WIFI_RPU_RECOVERY */
 };
 
 struct nrf_wifi_drv_priv_zep {
@@ -123,5 +127,10 @@ enum nrf_wifi_status nrf_wifi_fmac_dev_add_zep(struct nrf_wifi_drv_priv_zep *drv
 enum nrf_wifi_status nrf_wifi_fmac_dev_rem_zep(struct nrf_wifi_drv_priv_zep *drv_priv_zep);
 enum nrf_wifi_status nrf_wifi_fw_load(void *rpu_ctx);
 struct nrf_wifi_vif_ctx_zep *nrf_wifi_get_vif_ctx(struct net_if *iface);
+#ifdef CONFIG_NRF_WIFI_RPU_RECOVERY
+void nrf_wifi_rpu_recovery_cb(void *vif_ctx,
+		void *event_data,
+		unsigned int event_len);
+#endif /* CONFIG_NRF_WIFI_RPU_RECOVERY */
 
 #endif /* __ZEPHYR_FMAC_MAIN_H__ */

drivers/wifi/nrf700x/src/fmac_main.c

@@ -249,8 +249,8 @@ static void nrf_wifi_process_rssi_from_rx(void *vif_ctx,
 
 	rpu_ctx_zep = vif_ctx_zep->rpu_ctx_zep;
 
-	if (!rpu_ctx_zep) {
-		LOG_ERR("%s: rpu_ctx_zep is NULL", __func__);
+	if (!rpu_ctx_zep || !rpu_ctx_zep->rpu_ctx) {
+		LOG_ERR("%s: rpu_ctx_zep is NULL\n", __func__);
 		return;
 	}
 
@@ -306,6 +306,7 @@ int nrf_wifi_reg_domain(const struct device *dev, struct wifi_reg_domain *reg_do
 {
 	enum nrf_wifi_status status = NRF_WIFI_STATUS_FAIL;
 	struct nrf_wifi_ctx_zep *rpu_ctx_zep = NULL;
+	struct nrf_wifi_fmac_dev_ctx *fmac_dev_ctx = NULL;
 	struct nrf_wifi_vif_ctx_zep *vif_ctx_zep = NULL;
 	struct nrf_wifi_fmac_reg_info reg_domain_info = {0};
 	struct wifi_reg_chan_info *chan_info = NULL;
@@ -333,12 +334,18 @@ int nrf_wifi_reg_domain(const struct device *dev, struct wifi_reg_domain *reg_do
 		goto err;
 	}
 
+	fmac_dev_ctx = rpu_ctx_zep->rpu_ctx;
+	if (!fmac_dev_ctx) {
+		LOG_ERR("%s: fmac_dev_ctx is NULL", __func__);
+		goto err;
+	}
+
 	if (reg_domain->oper == WIFI_MGMT_SET) {
 		memcpy(reg_domain_info.alpha2, reg_domain->country_code, WIFI_COUNTRY_CODE_LEN);
 
 		reg_domain_info.force = reg_domain->force;
 
-		status = nrf_wifi_fmac_set_reg(rpu_ctx_zep->rpu_ctx, &reg_domain_info);
+		status = nrf_wifi_fmac_set_reg(fmac_dev_ctx, &reg_domain_info);
 		if (status != NRF_WIFI_STATUS_SUCCESS) {
 			LOG_ERR("%s: Failed to set regulatory domain", __func__);
 			goto err;
@@ -350,9 +357,9 @@ int nrf_wifi_reg_domain(const struct device *dev, struct wifi_reg_domain *reg_do
 			goto err;
 		}
 
-		status = nrf_wifi_fmac_get_reg(rpu_ctx_zep->rpu_ctx, &reg_domain_info);
+		status = nrf_wifi_fmac_get_reg(fmac_dev_ctx, &reg_domain_info);
 		if (status != NRF_WIFI_STATUS_SUCCESS) {
-			LOG_ERR("%s: Failed to get regulatory domain", __func__);
+			LOG_ERR("%s: Failed to get regulatory domain\n", __func__);
 			goto err;
 		}
 
@@ -625,6 +632,8 @@ enum nrf_wifi_status nrf_wifi_fmac_dev_add_zep(struct nrf_wifi_drv_priv_zep *drv
 		goto err;
 	}
 
+	k_mutex_init(&rpu_ctx_zep->rpu_lock);
+
 	return status;
 err:
 	if (rpu_ctx) {
@@ -651,6 +660,11 @@ enum nrf_wifi_status nrf_wifi_fmac_dev_rem_zep(struct nrf_wifi_drv_priv_zep *drv
 	nrf_wifi_fmac_dev_rem(rpu_ctx_zep->rpu_ctx);
 #endif /* CONFIG_NRF700X_RADIO_TEST */
 
+	free(rpu_ctx_zep->extended_capa);
+	rpu_ctx_zep->extended_capa = NULL;
+	free(rpu_ctx_zep->extended_capa_mask);
+	rpu_ctx_zep->extended_capa_mask = NULL;
+
 	rpu_ctx_zep->rpu_ctx = NULL;
 	LOG_DBG("%s: FMAC device removed", __func__);
 
@@ -689,6 +703,9 @@ static int nrf_wifi_drv_main_zep(const struct device *dev)
 	rx_buf_pools[1].buf_sz = rx2_buf_sz;
 	rx_buf_pools[2].buf_sz = rx3_buf_sz;
 
+#ifdef CONFIG_NRF_WIFI_RPU_RECOVERY
+	callbk_fns.rpu_recovery_callbk_fn = nrf_wifi_rpu_recovery_cb;
+#endif /* CONFIG_NRF_WIFI_RPU_RECOVERY */
 	callbk_fns.scan_start_callbk_fn = nrf_wifi_event_proc_scan_start_zep;
 	callbk_fns.scan_done_callbk_fn = nrf_wifi_event_proc_scan_done_zep;
 	callbk_fns.reg_change_callbk_fn = reg_change_callbk_fn;