samples: wi-fi: Enhance shutdown sample

Enhance shutdown sample to enable functionality without a need for
buttons. Enabled both one-shot and continuous modes.

Jira: SHEL-3697

Signed-off-by: Bansidhar Mangalwedhekar <[email protected]>

Author: bama-nordic

samples/wifi/shutdown/Kconfig

@@ -7,9 +7,39 @@
 source "Kconfig.zephyr"
 
 config WIFI_MAC_ADDRESS
-	string "WiFi MAC address"
+	string "Wi-Fi MAC address"
 	default "F6:CE:36:00:00:01"
 	help
-		WiFi MAC address to be used by the sample. If not set, the sample will
-		use the default MAC address (locally administrative). This is only used
-		when the nRF7002 OTP is not programmed with a MAC address.
+	  Wi-Fi MAC address to be used by the sample. If not set, the sample will
+	  use the default MAC address (locally administrative). This is only used
+	  when the nRF7002 OTP is not programmed with a MAC address.
+
+choice SHUTDOWN_OPERATION_MODE
+	prompt "Sample operation mode"
+	default OPERATION_MODE_CONTINUOUS
+	help
+	  Select the operation mode for the sample.
+
+config OPERATION_MODE_CONTINUOUS
+	bool "Continuous mode"
+	help
+	  In this mode, the sample will continue to run alternating between
+	  Wi-Fi shutdown and startup.
+
+config OPERATION_MODE_ONE_SHOT
+	bool "One-shot mode"
+	help
+	  In this mode, the sample will shutdown Wi-Fi only once and then exit.
+
+config OPERATION_MODE_BUTTONS
+	bool "Enable button interaction"
+	help
+	  Enable button interaction in the sample. If enabled, the sample will
+	  enable use of buttons to toggle the Wi-Fi shutdown or startup.
+endchoice
+
+config SHUTDOWN_TIMEOUT_S
+	int "Wi-Fi shutdown timeout"
+	default 5
+	help
+	  Timeout in seconds after the Wi-Fi shutdown operation.

samples/wifi/shutdown/README.rst

@@ -12,6 +12,12 @@ For more information, see the `nRF70 Series power states`_ page.
 
 This also demonstrates how to achieve the lowest possible power consumption in the Host SoC (nRF53, nRF52 or nRF91 Series) when Wi-Fi is enabled but not being used.
 
+The sample supports the following three modes of operation:
+
+* Continuous mode (default): Continuously cycles between Wi-Fi startup and shutdown with a configurable timeout.
+* One-shot mode: Performs Wi-Fi startup followed by shutdown once, then remains in shutdown mode.
+* Buttons mode: Manual control of Wi-Fi startup and shutdown using buttons.
+
 Requirements
 ************
 
@@ -23,17 +29,28 @@ Overview
 ********
 
 The sample can demonstrate Wi-Fi shutdown and achieve the lowest possible power consumption in the Host SoC.
-The sample:
+It operates in one of the following three modes, based on the selected configuration:
 
-1. Initializes the Wi-Fi driver.
+* In Continuous mode(default), the sample performs the following steps:
+
+1. Initializes the Wi-Fi driver and powers up the nRF70 device.
 #. Scans for available Wi-Fi networks to verify that the Wi-Fi driver is operational.
 #. Brings down the Wi-Fi network interface, which automatically directs the Wi-Fi driver to power down the nRF70 device.
 #. Puts the Host SoC in the lowest possible power consumption mode.
+#. Waits for the configured timeout period (``SHUTDOWN_TIMEOUT_S``).
+#. Repeats the cycle from step 1.
+
+* In One-shot mode, the sample performs steps 1-4 once, then remains in shutdown mode permanently.
 
+* In Buttons mode, the Wi-Fi state is controlled manually based on user button interactions.
 
 User Interface
 **************
 
+The user interface depends on the selected mode of operation:
+
+Buttons mode only:
+
 Button 1:
    Wakes up the Host SoC, brings up the Wi-Fi network interface, which automatically directs the Wi-Fi driver to power on the nRF70 device.
    The sample then scans for available Wi-Fi networks to verify that the Wi-Fi driver is operational.
@@ -42,6 +59,10 @@ Button 2:
    Brings down the Wi-Fi network interface, which automatically directs the Wi-Fi driver to power down the nRF70 device.
    The Host SoC is put into the lowest possible power consumption mode.
 
+Continuous and One-shot modes:
+
+User interaction required.
+The sample operates automatically according to the selected mode.
 
 Building and running
 ********************
@@ -50,25 +71,78 @@ Building and running
 
 .. include:: /includes/build_and_run_ns.txt
 
-To build for the nRF7000 EK, use the ``nrf5340dk/nrf5340/cpuapp`` board target.
-The following is an example of the CLI command to demonstrate Wi-Fi shutdown:
+Modes of Operation
+==================
 
-.. code-block:: console
+To build for the nRF7002 DK and nRF7000 EK with nRF5340 DK in different modes of operation, see the following examples:
+
+Continuous mode (Default)
+-------------------------
+
+* For nRF7002 DK:
+
+ .. code-block:: console
+
+    west build -p -b nrf7002dk/nrf5340/cpuapp
+
+* For nRF7000 EK with nRF5340 DK:
+
+ .. code-block:: console
+
+    west build -p -b nrf5340dk/nrf5340/cpuapp -- -DSHIELD=nrf7002ek_nrf7000
+
+One-shot mode
+-------------
+
+* For nRF7002 DK:
+
+ .. code-block:: console
+
+    west build -p -b nrf7002dk/nrf5340/cpuapp -- -DCONFIG_OPERATION_MODE_ONE_SHOT=y -DCONFIG_NRF_WIFI_IF_AUTO_START=n
+
+* For nRF7000 EK with nRF5340 DK:
+
+ .. code-block:: console
+
+    west build -p -b nrf5340dk/nrf5340/cpuapp -- -DSHIELD=nrf7002ek_nrf7000 -DCONFIG_OPERATION_MODE_ONE_SHOT=y -DCONFIG_NRF_WIFI_IF_AUTO_START=n
+
+Buttons mode
+------------
+
+* For nRF7002 DK:
+
+ .. code-block:: console
+
+    west build -p -b nrf7002dk/nrf5340/cpuapp -- -DCONFIG_OPERATION_MODE_BUTTONS=y
+
+* For nRF7000 EK with nRF5340 DK:
 
-   west build -b nrf5340dk/nrf5340/cpuapp -- -DSHIELD=nrf7002ek_nrf7000
+ .. code-block:: console
+
+    west build -p -b nrf5340dk/nrf5340/cpuapp -- -DSHIELD=nrf7002ek_nrf7000 -DCONFIG_OPERATION_MODE_BUTTONS=y
+
+Configuration options
+=====================
 
 Disable auto-start of the Wi-Fi driver
 --------------------------------------
 
 The Wi-Fi network interface is automatically brought up when the Wi-Fi driver is initialized by default.
 You can disable it by setting the :kconfig:option:`CONFIG_NRF_WIFI_IF_AUTO_START` Kconfig option to ``n``.
+This is automatically set for One-shot mode.
 
 .. code-block:: console
 
-   west build -b nrf5340dk/nrf5340/cpuapp -- -DSHIELD=nrf7002ek_nrf7000 -DCONFIG_NRF_WIFI_IF_AUTO_START=n
+   west build -p -b nrf7002dk/nrf5340/cpuapp -- -DCONFIG_NRF_WIFI_IF_AUTO_START=n
 
-With this configuration, the Wi-Fi network interface is not automatically brought up by the Zephyr networking stack.
-You must press **Button 1** to bring up the Wi-Fi network interface.
+Adjust shutdown timeout
+-----------------------
+
+In Continuous mode, you can configure the timeout period between shutdown and restart cycles using the ``SHUTDOWN_TIMEOUT_S`` option (in seconds):
+
+.. code-block:: console
+
+   west build -p -b nrf7002dk/nrf5340/cpuapp -- -DCONFIG_SHUTDOWN_TIMEOUT_S=10
 
 Testing
 =======
@@ -78,46 +152,89 @@ Testing
 #. |connect_kit|
 #. |connect_terminal|
 
-   The sample shows the following output:
+Testing in Continuous mode
+--------------------------
 
-   .. code-block:: console
+The sample shows the following output in Continuous mode:
 
-      *** Booting Zephyr OS build v3.3.99-ncs1-26-ge405279d2134 ***
-      [00:00:00.440,460] <inf> wifi_nrf: Firmware (v1.2.8.1) booted successfully
+.. code-block:: console
 
-      [00:00:00.638,397] <inf> scan: Starting nrf5340dk/nrf5340/cpuapp with CPU frequency: 64 MHz
+   *** Booting nRF Connect SDK v3.0.99-7c4f8113c3e4 ***
+   *** Using Zephyr OS v4.1.99-eb12c854d528 ***
+   [00:00:00.428,253] <inf> shutdown: Starting nrf7002dk with CPU frequency: 64 MHz
 
-      [00:00:00.642,608] <inf> scan: Scan requested
+   [00:00:00.431,640] <inf> shutdown: Scan requested
 
-      Num  | SSID                             (len) | Chan | RSSI | Security | BSSID
-      1    | abcdef                           6     | 1    | -37  | WPA/WPA2 | aa:aa:aa:aa:aa:aa
-      2    | pqrst                            5     | 1    | -65  | WPA/WPA2 | xx:xx:xx:xx:xx:xx
-      3    | AZBYCXD                          7     | 1    | -41  | WPA/WPA2 | yy:yy:yy:yy:yy:yy
-      [00:00:05.445,739] <inf> scan: Scan request done
+   Num  | SSID                             (len) | Chan | RSSI | Security | BSSID
+   1    | abcdef                           6     | 1    | -37  | WPA/WPA2 | aa:aa:aa:aa:aa:aa
+   2    | pqrst                            5     | 1    | -65  | WPA/WPA2 | xx:xx:xx:xx:xx:xx
+   3    | AZBYCXD                          7     | 1    | -41  | WPA/WPA2 | yy:yy:yy:yy:yy:yy
+   [00:00:05.116,943] <inf> shutdown: Scan request done
+
+   [00:00:05.130,706] <inf> shutdown: Interface down
+   [00:00:05.297,180] <inf> shutdown: Interface up
+   [00:00:05.299,194] <inf> shutdown: Scan requested
+
+   Num  | SSID                             (len) | Chan | RSSI | Security | BSSID
+   1    | abcdef                           6     | 1    | -37  | WPA/WPA2 | aa:aa:aa:aa:aa:aa
+   2    | pqrst                            5     | 1    | -65  | WPA/WPA2 | xx:xx:xx:xx:xx:xx
+   3    | AZBYCXD                          7     | 1    | -41  | WPA/WPA2 | yy:yy:yy:yy:yy:yy
+   [00:00:10.009,399] <inf> shutdown: Scan request done
+
+   [00:00:10.022,735] <inf> shutdown: Interface down
+   [00:00:15.189,270] <inf> shutdown: Interface up
+   [00:00:15.191,284] <inf> shutdown: Scan requested
+
+Testing in One-shot mode
+------------------------
+
+The sample shows the following output in One-shot mode:
+
+.. code-block:: console
+
+   *** Booting nRF Connect SDK v3.0.99-7c4f8113c3e4 ***
+   *** Using Zephyr OS v4.1.99-eb12c854d528 ***
+   [00:00:00.261,718] <inf> shutdown: Starting nrf7002dk with CPU frequency: 64 MHz
+
+   [00:00:00.428,802] <inf> shutdown: OTP not programmed, proceeding with local MAC: F6:CE:36:00:00:01
+   [00:00:00.430,877] <inf> shutdown: Scan requested
+
+   Num  | SSID                             (len) | Chan | RSSI | Security | BSSID
+   1    | abcdef                           6     | 1    | -37  | WPA/WPA2 | aa:aa:aa:aa:aa:aa
+   2    | pqrst                            5     | 1    | -65  | WPA/WPA2 | xx:xx:xx:xx:xx:xx
+   3    | AZBYCXD                          7     | 1    | -41  | WPA/WPA2 | yy:yy:yy:yy:yy:yy
+   [00:00:05.144,104] <inf> shutdown: Scan request done
+
+   [00:00:05.157,714] <inf> shutdown: Interface down
+
+Testing in Buttons mode
+-----------------------
+
+Complete the following steps to test the sample in Buttons mode (nRF5340 host boards only):
 
-      [00:00:05.452,423] <inf> scan: Interface down
+#. The sample starts with Wi-Fi initialization and shutdown.
 
 #. Press **Button 1** to wake up the nRF5340 SoC, initialize the Wi-Fi chipset, and scan for available Wi-Fi networks:
 
    The sample shows the following output:
 
    .. code-block:: console
 
-      [00:00:29.141,357] <inf> wifi_nrf: Firmware (v1.2.8.1) booted successfully
+      [00:00:29.141,357] <inf> shutdown: Firmware (v1.2.8.1) booted successfully
 
-      [00:00:29.269,165] <inf> scan: Interface up
-      [00:00:29.272,521] <inf> scan: Scan requested
+      [00:00:29.269,165] <inf> shutdown: Interface up
+      [00:00:29.272,521] <inf> shutdown: Scan requested
 
       Num  | SSID                             (len) | Chan | RSSI | Security | BSSID
       1    | abcdef                           6     | 1    | -37  | WPA/WPA2 | aa:aa:aa:aa:aa:aa
       2    | pqrst                            5     | 1    | -65  | WPA/WPA2 | xx:xx:xx:xx:xx:xx
       3    | AZBYCXD                          7     | 1    | -41  | WPA/WPA2 | yy:yy:yy:yy:yy:yy
-      [00:00:34.092,285] <inf> scan: Scan request done
+      [00:00:34.092,285] <inf> shutdown: Scan request done
 
 #. Press **Button 2** to shut down the Wi-Fi driver and put the nRF5340 SoC in lowest possible power consumption mode:
 
    The sample shows the following output:
 
    .. code-block:: console
 
-      [00:00:48.313,354] <inf> scan : Interface down
+      [00:00:48.313,354] <inf> shutdown : Interface down

samples/wifi/shutdown/src/main.c

@@ -131,6 +131,7 @@ static bool is_mac_addr_set(struct net_if *iface)
 	return net_eth_is_addr_valid(&wifi_addr);
 }
 
+#ifdef CONFIG_OPERATION_MODE_BUTTONS
 static void button_handler_cb(uint32_t button_state, uint32_t has_changed)
 {
 	if ((has_changed & DK_BTN1_MSK) && (button_state & DK_BTN1_MSK)) {
@@ -151,6 +152,8 @@ static void buttons_init(void)
 	}
 }
 
+#endif /* CONFIG_OPERATION_MODE_BUTTONS */
+
 int shutdown_wifi(struct net_if *iface)
 {
 	int ret;
@@ -237,8 +240,7 @@ int main(void)
 			return ret;
 		}
 
-		net_mgmt(NET_REQUEST_ETHERNET_SET_MAC_ADDRESS, iface,
-			 &params, sizeof(params));
+		net_mgmt(NET_REQUEST_ETHERNET_SET_MAC_ADDRESS, iface, &params, sizeof(params));
 
 		ret = net_if_up(iface);
 		if (ret) {
@@ -251,15 +253,28 @@ int main(void)
 							net_if_get_link_addr(iface)->len));
 	}
 
+#ifdef CONFIG_OPERATION_MODE_BUTTONS
 	buttons_init();
+#endif /* CONFIG_OPERATION_MODE_BUTTONS */
 
 #ifdef CONFIG_NRF_WIFI_IF_AUTO_START
 	exit_shutdown_mode();
-
 	enter_shutdown_mode();
 #endif
 
+#if defined(CONFIG_OPERATION_MODE_BUTTONS) || defined(CONFIG_OPERATION_MODE_ONE_SHOT)
+	exit_shutdown_mode();
+	enter_shutdown_mode();
 	k_sleep(K_FOREVER);
-
+#else
+	/* Will continuously alternate between shutdown and startup modes
+	 * with a defined timeout after shutdown.
+	 */
+	while (1) {
+		exit_shutdown_mode();
+		enter_shutdown_mode();
+		k_sleep(K_SECONDS(CONFIG_SHUTDOWN_TIMEOUT_S));
+	}
+#endif /* CONFIG_OPERATION_MODE_BUTTONS */
 	return 0;
 }