samples: dect_phy: dect_shell: rx command changes

Following changes were done to dect rx command:
- possibility to iterate all channels in a set band by giving channel 0
- new hook: --use_filter to enable RX filter.
- new hook: --use_all_channels, channel access override to scan all
channels. default without this hook mis to scan only allowed channels
per ETSI EN 301 406-2.
These changes also impact to dect mac beacon_scan command to have
a support iterate all channels by giving channel 0.
Also, this commit contains PR review changes from mac sample review.

Signed-off-by: Jani Hirsimäki <[email protected]>

Author: jhirsi

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

@@ -263,8 +263,16 @@ DECT NR+ samples
 
 * :ref:`dect_shell_application` sample:
 
-  * A brief mac level sample on top of dect_phy api. New commands to create a periodic cluster beacon, scan for it, associate/disassociate a PT/client, and send data to a FT/beacon random access window. Note: this is just a sample/initials of a mac implementation and thus not a full MAC implementation and not fully compliant with dect nr+ mac spec (ETSI TS 103 636-4).
-  * dect rssi_scan: In addition to default high/low rssi_scan: option for MAC spec like rssi_scan: busy/possible/free subslot count based RSSI scan.
+  * Added:
+
+    * The ``dect mac`` command.
+      A brief MAC-level sample on top of DECT PHY interface with new commands to create a periodic cluster beacon, scan for it, associate or disassociate a PT/client, and send data to a FT/beacon random access window.
+      This is not a full MAC implementation and not fully compliant with DECT NR+ MAC specification (`ETSI TS 103 636-4`_).
+
+  * Updated:
+
+    * The ``dect rssi_scan`` command with busy/possible/free subslot count-based RSSI scan.
+    * The ``dect rx`` command to provide the possibility to iterate all channels and to enable RX filter.
 
 Edge Impulse samples
 --------------------

samples/dect/dect_phy/dect_shell/README.rst

@@ -45,14 +45,14 @@ Main command structure:
        rf_tool
        status
        rx
-      mac
-        beacon_scan
-        beacon_start
-        beacon_stop
-        rach_tx
-        associate
-        dissociate
-        status
+       mac
+         beacon_scan
+         beacon_start
+         beacon_stop
+         rach_tx
+         associate
+         dissociate
+         status
 
 Application settings
 ====================
@@ -118,13 +118,14 @@ Examples
 
      dect rssi_scan stop
 
-* Execute longer RSSI measurements on all permitted channels, and instead of default high/low RSSI value based verdict; use subslot count based verdict for BUSY/POSSIBLE/FREE and as a end results, see the verdict for the best channel:
+* Execute longer RSSI measurements on all permitted channels, and instead of default high/low RSSI value-based verdict, use subslot count-based verdict for BUSY/POSSIBLE/FREE and as an end result, see the verdict for the best channel:
 
   .. code-block:: console
 
      dect rssi_scan -c 0 --verdict_type_count -t 3000 -a
 
-* Execute longer RSSI measurements on specific channel, and instead of default high/low RSSI value based verdict; use subslot count based verdict for BUSY/POSSIBLE/FREE. Additionally, print BUSY/POSSIBLE measurements:
+* Execute longer RSSI measurements on specific channel, and instead of default high/low RSSI value-based verdict, use subslot count-based verdict for BUSY/POSSIBLE/FREE.
+  Additionally, print BUSY/POSSIBLE measurements:
 
   .. code-block:: console
 
@@ -437,16 +438,23 @@ Dect NR+ PHY MAC
 
 DeSh command: ``dect mac``
 
-This command demostrates basic sample of DECT NR+ MAC layer on top of PHY API based on ETSI TS 103 636-4 V1.4.8 (2024-01).
-With this command you can start a cluster beacon, scan for beacons, associate/dissociate, and send data to beacon random access RX window.
+This command demonstrates a basic sample of the DECT NR+ MAC layer on top of PHY API. It is based on MAC specification `ETSI TS 103 636-4`_.
+With this command, you can start a cluster beacon, scan for beacons, associate/dissociate, and send data to the beacon random access RX window.
 
-Disclaimer: this is just a basic sample for initials and not a full MAC implementation, it does not support all the features of the DECT NR+ MAC layer and is not fully compliant with the MAC specification.
-For example cluster beaconing with RA allocation, and LMS implementations overall are not what is required by the MAC specification.
+.. note::
+   This is just an initial basic sample and not a full MAC implementation.
+   It does not support all the features of the DECT NR+ MAC layer and is not fully compliant with the MAC specification.
+   For example, cluster beaconing with RA allocation and LMS implementations overall are not what is required by the specification.
+
+The following abbreviations from MAC specification are used in the examples:
+
+* FT: Fixed Termination point
+* PT: Portable Termination point
 
 Example: starting of cluster beacon and sending RA data to it
 -------------------------------------------------------------
 
-* FT/Beacon device - start periodic cluster beacon TX at default band #1 and at the 1st free channel:
+* FT/Beacon device - Start periodic cluster beacon TX on default band 1 and on the first free channel:
 
   .. code-block:: console
 
@@ -627,7 +635,7 @@ Example: starting of cluster beacon and sending RA data to it
       short RD ID....................................27462 (0x6b46)
       band number....................................1
 
-* PT/client side: Scan beacon:
+* PT/client side - Scan the beacon:
 
   .. code-block:: console
 
@@ -708,13 +716,13 @@ Example: starting of cluster beacon and sending RA data to it
       -----------------------------------------------------------------------------
       RX DONE.
 
-* PT/client side: As an alternative to the previous command, and if you don't know in which channel beacon is running, you can scan all channels in a set band:
+* PT/client side - As an alternative to the previous command, and if you do not know in which channel the beacon is running, you can scan all channels in a set band:
 
   .. code-block:: console
 
       desh:~$ dect mac beacon_scan -c 0
 
-* PT/client side: See that scanned beacon can be found from neighbor list:
+* PT/client side - Check that the scanned beacon is found from neighbor list:
 
   .. code-block:: console
 
@@ -732,7 +740,7 @@ Example: starting of cluster beacon and sending RA data to it
          channel:                1659
          last seen time:         17016336625
 
-* PT/client side: Send association request to scanned beacon:
+* PT/client side - Send association request to the scanned beacon:
 
   .. code-block:: console
 
@@ -773,7 +781,7 @@ Example: starting of cluster beacon and sending RA data to it
             Received padding data, len 1, payload is not printed
       RX for Association Response completed.
 
-* PT/client side: Send RA data to scanned beacon:
+* PT/client side - Send RA data to the scanned beacon:
 
   .. code-block:: console
 
@@ -787,7 +795,7 @@ Example: starting of cluster beacon and sending RA data to it
       Client TX to RACH started.
       Client data TX completed.
 
-* FT/Beacon device: Observe that data was received:
+* FT/Beacon device - Observe that data was received:
 
   .. code-block:: console
 
@@ -816,7 +824,7 @@ Example: starting of cluster beacon and sending RA data to it
             Payload length: 0
             Received padding data, len 0, payload is not printed
 
-* PT/client side: Send association release to scanned beacon:
+* PT/client side - Send association release to the scanned beacon:
 
   .. code-block:: console
 
@@ -830,7 +838,7 @@ Example: starting of cluster beacon and sending RA data to it
       Association Release TX started.
       TX for Association Release completed.
 
-* FT/Beacon device: See that Association Release message was received:
+* FT/Beacon device - Observe that the association release message was received:
 
   .. code-block:: console
 
@@ -860,17 +868,14 @@ Example: starting of cluster beacon and sending RA data to it
             Payload length: 1
             Received padding data, len 1, payload is not printed
 
-* FT/Beacon device: Stop beacon
+* FT/Beacon device - Stop the beacon:
 
-+  .. code-block:: console
+  .. code-block:: console
 
       desh:~$ dect mac beacon_stop
       Stopping beacon.
       Beacon TX stopped, cause: User Initiated.
 
-----
-
-
 Building
 ********
 

samples/dect/dect_phy/dect_shell/src/dect/dect_phy_ctrl.c

@@ -56,6 +56,7 @@ static struct dect_phy_ctrl_data {
 	bool ext_command_running;
 
 	bool rx_cmd_on_going;
+	uint16_t rx_cmd_current_channel;
 	struct dect_phy_rx_cmd_params rx_cmd_params;
 
 	bool time_cmd;
@@ -358,7 +359,7 @@ static void dect_phy_ctrl_msgq_thread_handler(void)
 					params->status, params->temperature, tmp_str);
 				if (params->handle == DECT_PHY_COMMON_RSSI_SCAN_HANDLE) {
 					dect_phy_scan_rssi_finished_handle(params->status);
-				} else if (params->handle == DECT_PHY_COMMON_RX_CMD_HANDLE) {
+				} else if (params->handle == ctrl_data.rx_cmd_params.handle) {
 					dect_phy_api_scheduler_resume();
 					desh_error("%s: cannot start RX: %s", __func__, tmp_str);
 					ctrl_data.rx_cmd_on_going = false;
@@ -368,10 +369,17 @@ static void dect_phy_ctrl_msgq_thread_handler(void)
 					}
 				}
 			} else {
-				if (params->handle == DECT_PHY_COMMON_RX_CMD_HANDLE) {
-					ctrl_data.rx_cmd_on_going = false;
-					dect_phy_api_scheduler_resume();
-					desh_print("RX DONE.");
+				if (params->handle == ctrl_data.rx_cmd_params.handle) {
+					struct dect_phy_rx_cmd_params copy_params =
+						ctrl_data.rx_cmd_params;
+					int err;
+
+					err = dect_phy_ctrl_rx_start(&copy_params, true);
+					if (err) {
+						ctrl_data.rx_cmd_on_going = false;
+						dect_phy_api_scheduler_resume();
+						desh_print("RX DONE.");
+					}
 				} else if (params->handle == DECT_PHY_COMMON_RSSI_SCAN_HANDLE) {
 					dect_phy_scan_rssi_finished_handle(params->status);
 				} else {
@@ -765,11 +773,11 @@ int dect_phy_ctrl_time_query(void)
 void dect_phy_ctrl_rx_stop(void)
 {
 	ctrl_data.rx_cmd_on_going = false;
-	(void)nrf_modem_dect_phy_rx_stop(DECT_PHY_COMMON_RX_CMD_HANDLE);
+	(void)nrf_modem_dect_phy_rx_stop(ctrl_data.rx_cmd_params.handle);
 	dect_phy_api_scheduler_resume();
 }
 
-int dect_phy_ctrl_rx_start(struct dect_phy_rx_cmd_params *params)
+int dect_phy_ctrl_rx_start(struct dect_phy_rx_cmd_params *params, bool restart)
 {
 	int err;
 
@@ -778,7 +786,12 @@ int dect_phy_ctrl_rx_start(struct dect_phy_rx_cmd_params *params)
 		return -EACCES;
 	}
 
-	if (ctrl_data.rx_cmd_on_going) {
+	if (restart && !ctrl_data.rx_cmd_on_going) {
+		desh_warn("Cannot restart RX when RX is not on going.");
+		return -EINVAL;
+	}
+
+	if (ctrl_data.rx_cmd_on_going && !restart) {
 		desh_error("rx cmd already on going.");
 		return -EALREADY;
 	}
@@ -787,15 +800,48 @@ int dect_phy_ctrl_rx_start(struct dect_phy_rx_cmd_params *params)
 		dect_phy_api_scheduler_suspend();
 	}
 
+	struct dect_phy_settings *current_settings = dect_common_settings_ref_get();
+
+	if (params->channel == 0) {
+		if (restart) {
+			uint16_t next_channel = dect_common_utils_get_next_channel_in_band_range(
+				current_settings->common.band_nbr,
+				ctrl_data.rx_cmd_current_channel,
+				!params->ch_acc_use_all_channels);
+
+			if (next_channel) {
+				ctrl_data.rx_cmd_current_channel = next_channel;
+			} else {
+				/* We are done */
+				desh_print("All channels in band scanned.");
+				return -ENODATA;
+			}
+		} else {
+			/* All channels in a set band */
+			ctrl_data.rx_cmd_current_channel =
+				dect_common_utils_channel_min_on_band(
+					current_settings->common.band_nbr);
+		}
+	} else {
+		if (restart) {
+			/* Cannot restart RX on a specific channel */
+			return -EINVAL;
+		}
+		ctrl_data.rx_cmd_current_channel = params->channel;
+	}
+
 	struct dect_phy_rssi_scan_params rssi_params = {
-		.channel = params->channel,
+		.channel = ctrl_data.rx_cmd_current_channel,
 		.result_verdict_type = DECT_PHY_RSSI_SCAN_RESULT_VERDICT_TYPE_ALL,
 		.busy_rssi_limit = params->busy_rssi_limit,
 		.free_rssi_limit = params->free_rssi_limit,
 		.interval_secs = params->rssi_interval_secs,
 	};
 
+
 	ctrl_data.rx_cmd_params = *params;
+	params->channel = ctrl_data.rx_cmd_current_channel;
+
 	err = dect_phy_scan_rssi_data_init(&rssi_params);
 	if (err) {
 		desh_error("RSSI scan data init failed: err", err);

samples/dect/dect_phy/dect_shell/src/dect/dect_phy_ctrl.h

@@ -44,7 +44,7 @@ int dect_phy_ctrl_msgq_data_op_add(uint16_t event_id, void *data, size_t data_si
 
 void dect_phy_ctrl_status_get_n_print(void);
 
-int dect_phy_ctrl_rx_start(struct dect_phy_rx_cmd_params *params);
+int dect_phy_ctrl_rx_start(struct dect_phy_rx_cmd_params *params, bool restart);
 void dect_phy_ctrl_rx_stop(void);
 
 int dect_phy_ctrl_time_query(void);