samples: dect_phy: dect_shell: mac: last minute scan

Instead of LBT, support for Last Minute Scan (LMS) before
beacon TX and the 1st random access resource.
Jira: MOSH-592

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

Author: jhirsi

samples/dect/dect_phy/dect_shell/README.rst

@@ -427,7 +427,9 @@ 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.
-Note: this is just a basic sample and not a full MAC implementation.
+
+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.
 
 Example: starting of cluster beacon and sending RA data to it
 -------------------------------------------------------------

samples/dect/dect_phy/dect_shell/src/dect/common/dect_common.h

@@ -233,6 +233,7 @@ typedef struct {
 
 #define DECT_RADIO_FRAME_SUBSLOT_COUNT_IN_SLOT (2)
 #define DECT_RADIO_FRAME_SLOT_COUNT	       (24)
+
 #define DECT_RADIO_FRAME_SUBSLOT_COUNT                                                             \
 	(DECT_RADIO_FRAME_SUBSLOT_COUNT_IN_SLOT * DECT_RADIO_FRAME_SLOT_COUNT)
 #define DECT_RADIO_FRAME_DURATION_US		(10000)
@@ -247,5 +248,10 @@ typedef struct {
 
 #define MS_TO_SUBSLOTS(x) (((x) / 10) * 48)
 
+#define DECT_RADIO_SLOT_SYMBOL_COUNT (10)
+#define DECT_RADIO_SUBSLOT_SYMBOL_COUNT (5)
+
+#define DECT_RADIO_FRAME_SYMBOL_COUNT (DECT_RADIO_FRAME_SLOT_COUNT * DECT_RADIO_SLOT_SYMBOL_COUNT)
+
 /******************************************************************************/
 #endif /* DECT_COMMON_H */

samples/dect/dect_phy/dect_shell/src/dect/common/dect_phy_api_scheduler.c

@@ -20,16 +20,17 @@
 /* Internals */
 
 /* Internal events to scheduler thread */
-#define DECT_PHY_API_EVENT_SCHEDULER_NEXT_FRAME		  1
-#define DECT_PHY_API_EVENT_SCHEDULER_OP_COMPLETED	  2
-#define DECT_PHY_API_EVENT_SCHEDULER_OP_PDC_DATA_RECEIVED 3
-#define DECT_PHY_API_EVENT_SCHEDULER_OP_LIST_PURGE	  4
-#define DECT_PHY_API_EVENT_SCHEDULER_LED_TX_ON		  5
-#define DECT_PHY_API_EVENT_SCHEDULER_LED_TX_OFF		  6
-#define DECT_PHY_API_EVENT_SCHEDULER_OP_SUSPEND		  7
-#define DECT_PHY_API_EVENT_SCHEDULER_OP_RESUME		  8
-#define DECT_PHY_API_EVENT_SCHEDULER_OP_RECONFIG_ON	  9
-#define DECT_PHY_API_EVENT_SCHEDULER_OP_RECONFIG_OFF	  10
+#define DECT_PHY_API_EVENT_SCHEDULER_NEXT_FRAME			1
+#define DECT_PHY_API_EVENT_SCHEDULER_OP_COMPLETED		2
+#define DECT_PHY_API_EVENT_SCHEDULER_OP_PDC_DATA_RECEIVED	3
+#define DECT_PHY_API_EVENT_SCHEDULER_OP_LIST_PURGE		4
+#define DECT_PHY_API_EVENT_SCHEDULER_OP_LIST_ITEM_RM_DEALLOC	5
+#define DECT_PHY_API_EVENT_SCHEDULER_LED_TX_ON			6
+#define DECT_PHY_API_EVENT_SCHEDULER_LED_TX_OFF			7
+#define DECT_PHY_API_EVENT_SCHEDULER_OP_SUSPEND			8
+#define DECT_PHY_API_EVENT_SCHEDULER_OP_RESUME			9
+#define DECT_PHY_API_EVENT_SCHEDULER_OP_RECONFIG_ON		10
+#define DECT_PHY_API_EVENT_SCHEDULER_OP_RECONFIG_OFF		11
 
 /* Scheduler states */
 enum dect_phy_api_scheduler_state {
@@ -278,6 +279,13 @@ dect_phy_api_scheduler_list_item_remove_by_phy_op_handle(uint16_t handle)
 	return iterator;
 }
 
+void dect_phy_api_scheduler_th_list_item_remove_dealloc_by_phy_op_handle(uint16_t handle)
+{
+	(void)dect_phy_api_scheduler_raise_event_with_data(
+		DECT_PHY_API_EVENT_SCHEDULER_OP_LIST_ITEM_RM_DEALLOC, (void *)&handle,
+		sizeof(uint16_t));
+}
+
 void dect_phy_api_scheduler_list_item_remove_dealloc_by_phy_op_handle(uint16_t handle)
 {
 	struct dect_phy_api_scheduler_list_item *iterator = NULL;
@@ -687,6 +695,24 @@ struct dect_phy_api_scheduler_list_item *dect_phy_api_scheduler_list_item_alloc_
 	return p_elem;
 }
 
+struct dect_phy_api_scheduler_list_item *dect_phy_api_scheduler_list_item_alloc_rssi_element(
+	struct dect_phy_api_scheduler_list_item_config **item_conf)
+{
+	struct dect_phy_api_scheduler_list_item *p_elem =
+		k_calloc(1, sizeof(struct dect_phy_api_scheduler_list_item));
+
+	if (p_elem == NULL) {
+		printk("%s: cannot allocate memory for scheduler list item\n", (__func__));
+		return NULL;
+	}
+	p_elem->priority = DECT_PRIORITY1_RX_RSSI;
+	p_elem->sched_config.tx.encoded_payload_pdu = NULL;
+	p_elem->silent_fail = false;
+	*item_conf = &p_elem->sched_config;
+
+	return p_elem;
+}
+
 void dect_phy_api_scheduler_list_item_dealloc(struct dect_phy_api_scheduler_list_item *list_item)
 {
 	if (list_item != NULL) {
@@ -1033,6 +1059,15 @@ dect_phy_api_scheduler_core_mdm_phy_op(struct dect_phy_api_scheduler_list_item *
 					DECT_PHY_API_EVENT_SCHEDULER_LED_TX_ON);
 #endif
 			}
+		} else if (list_item->priority == DECT_PRIORITY1_RX_RSSI) {
+			struct nrf_modem_dect_phy_rssi_params rssi_params =
+				list_item->sched_config.rssi.rssi_op_params;
+
+			err = nrf_modem_dect_phy_rssi(&rssi_params);
+			if (err) {
+				desh_error("(%s): nrf_modem_dect_phy_rssi failed %d",
+					(__func__), err);
+			}
 		} else {
 			struct nrf_modem_dect_phy_rx_params rx_op = {
 				.rssi_interval = NRF_MODEM_DECT_PHY_RSSI_INTERVAL_OFF,
@@ -1155,6 +1190,10 @@ static void dect_phy_api_scheduler_core_tick_th_schedule_next_frame(void)
 					}
 					iterator->phy_op_handle = next_handle;
 				}
+				if (iterator->priority == DECT_PRIORITY1_RX_RSSI) {
+					iterator->sched_config.rssi.rssi_op_params.start_time =
+						new_frame_time;
+				}
 
 				if (!dect_phy_api_scheduler_list_item_add(iterator)) {
 					printk("(%s)/1: dect_phy_api_scheduler_list_item_add for "
@@ -1274,6 +1313,10 @@ static void dect_phy_api_scheduler_core_tick_th_schedule_next_frame(void)
 					}
 					iterator->phy_op_handle = next_handle;
 				}
+				if (iterator->priority == DECT_PRIORITY1_RX_RSSI) {
+					iterator->sched_config.rssi.rssi_op_params.start_time =
+						new_frame_time;
+				}
 
 				if (!dect_phy_api_scheduler_list_item_add(iterator)) {
 					desh_error("(%s): dect_phy_api_scheduler_list_item_add "
@@ -1406,6 +1449,13 @@ static void dect_phy_api_scheduler_th_handler(void)
 			dect_phy_api_scheduler_done_list_purge();
 			break;
 		}
+		case DECT_PHY_API_EVENT_SCHEDULER_OP_LIST_ITEM_RM_DEALLOC: {
+			uint16_t *phy_handle = (uint16_t *)event.data;
+
+			dect_phy_api_scheduler_list_item_remove_dealloc_by_phy_op_handle(
+				*phy_handle);
+			break;
+		}
 		case DECT_PHY_API_EVENT_SCHEDULER_OP_SUSPEND: {
 			scheduler_data.state = SCHEDULER_STATE_SUSPENDED;
 			dect_phy_api_scheduler_done_list_items_stop_in_modem();

samples/dect/dect_phy/dect_shell/src/dect/common/dect_phy_api_scheduler.h

@@ -59,6 +59,7 @@ typedef enum {
 	DECT_PRIORITY0_FORCE_RX, /* Possible to schedule past of the scheduler mdm RX window */
 	DECT_PRIORITY1_TX,
 	DECT_PRIORITY1_RX,
+	DECT_PRIORITY1_RX_RSSI,
 	DECT_PRIORITY2_TX,
 	DECT_PRIORITY2_RX,
 	DECT_PRIORITY_LOWEST_RX
@@ -104,6 +105,10 @@ struct dect_phy_api_scheduler_list_item_config_rx {
 	enum nrf_modem_dect_phy_rx_mode mode;
 };
 
+struct dect_phy_api_scheduler_list_item_config_rx_rssi {
+	struct nrf_modem_dect_phy_rssi_params rssi_op_params;
+};
+
 struct dect_phy_api_scheduler_list_item_config {
 	dect_mac_address_info_t address_info;
 
@@ -139,8 +144,9 @@ struct dect_phy_api_scheduler_list_item_config {
 	uint16_t length_slots;
 	uint16_t length_subslots;
 
-	struct dect_phy_api_scheduler_list_item_config_rx rx; /* RX specifics */
-	struct dect_phy_api_scheduler_list_item_config_tx tx; /* TX specifics */
+	struct dect_phy_api_scheduler_list_item_config_rx rx;        /* RX specifics */
+	struct dect_phy_api_scheduler_list_item_config_tx tx;        /* TX specifics */
+	struct dect_phy_api_scheduler_list_item_config_rx_rssi rssi; /* RSSI specifics */
 };
 
 struct dect_phy_api_scheduler_list_item {
@@ -166,6 +172,8 @@ struct dect_phy_api_scheduler_list_item *dect_phy_api_scheduler_list_item_alloc_
 	struct dect_phy_api_scheduler_list_item_config **item_conf);
 struct dect_phy_api_scheduler_list_item *dect_phy_api_scheduler_list_item_alloc_rx_element(
 	struct dect_phy_api_scheduler_list_item_config **item_conf);
+struct dect_phy_api_scheduler_list_item *dect_phy_api_scheduler_list_item_alloc_rssi_element(
+	struct dect_phy_api_scheduler_list_item_config **item_conf);
 void dect_phy_api_scheduler_list_item_dealloc(struct dect_phy_api_scheduler_list_item *list_item);
 struct dect_phy_api_scheduler_list_item *dect_phy_api_scheduler_list_item_create_new_copy(
 	struct dect_phy_api_scheduler_list_item *item_to_be_copied, uint64_t new_frame_time,
@@ -183,6 +191,8 @@ void dect_phy_api_scheduler_list_item_remove_dealloc_by_phy_op_handle(uint16_t h
 void dect_phy_api_scheduler_list_item_remove_dealloc_by_phy_op_handle_range(uint16_t range_start,
 									    uint16_t range_end);
 
+void dect_phy_api_scheduler_th_list_item_remove_dealloc_by_phy_op_handle(uint16_t handle);
+
 void dect_phy_api_scheduler_list_item_pdu_payload_update_by_phy_handle(
 	uint16_t handle, uint8_t *new_encoded_payload_pdu, uint16_t size);
 

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

@@ -612,7 +612,12 @@ static void dect_phy_ctrl_mdm_on_rssi_cb(const uint64_t *time,
 				  const struct nrf_modem_dect_phy_rssi_meas *p_result)
 {
 	dect_app_modem_time_save(time);
-	dect_phy_scan_rssi_cb_handle(NRF_MODEM_DECT_PHY_SUCCESS, p_result);
+
+	if (ctrl_data.rssi_scan_on_going) {
+		dect_phy_scan_rssi_cb_handle(NRF_MODEM_DECT_PHY_SUCCESS, p_result);
+	} else if (ctrl_data.ext_cmd.direct_rssi_cb != NULL) {
+		ctrl_data.ext_cmd.direct_rssi_cb(p_result);
+	}
 }
 
 static void dect_phy_ctrl_mdm_on_link_configuration_cb(uint64_t const *time,

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

@@ -106,6 +106,10 @@ typedef bool (*dect_phy_ctrl_ext_phy_api_pdc_rx_cb_t)(
 int dect_phy_ctrl_th_register_default_phy_api_pdc_rcv_cb(
 	dect_phy_ctrl_ext_phy_api_pdc_rx_cb_t default_pdc_rcv_cb);
 
+/* Callback for receiving RSSI measurement results */
+typedef void (*dect_phy_ctrl_ext_phy_api_direct_rssi_cb_t)(
+	const struct nrf_modem_dect_phy_rssi_meas *meas_results);
+
 /* Callback for receiving modem operation complete events */
 typedef void (*dect_phy_ctrl_ext_phy_api_mdm_op_complete_cb_t)(
 	struct dect_phy_common_op_completed_params *params);
@@ -130,6 +134,7 @@ struct dect_phy_ctrl_ext_callbacks {
 	dect_phy_ctrl_ext_phy_api_pcc_rx_cb_t direct_pcc_rcv_cb;
 	dect_phy_ctrl_ext_phy_api_pcc_rx_cb_t pcc_rcv_cb;
 	dect_phy_ctrl_ext_phy_api_direct_pdc_rx_cb_t direct_pdc_rcv_cb;
+	dect_phy_ctrl_ext_phy_api_direct_rssi_cb_t direct_rssi_cb;
 	dect_phy_ctrl_ext_phy_api_pdc_rx_cb_t pdc_rcv_cb;
 	dect_phy_ctrl_ext_phy_api_mdm_op_complete_cb_t op_complete_cb;
 	dect_phy_ctrl_ext_settings_changed_cb_t sett_changed_cb;

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

@@ -22,11 +22,6 @@
 #include "dect_phy_scan.h"
 #include "dect_phy_rx.h"
 
-enum dect_phy_rssi_scan_data_result_verdict {
-	DECT_PHY_RSSI_SCAN_VERDICT_FREE,
-	DECT_PHY_RSSI_SCAN_VERDICT_POSSIBLE,
-	DECT_PHY_RSSI_SCAN_VERDICT_BUSY,
-};
 struct dect_phy_rssi_scan_data_result {
 	uint16_t channel;
 	enum dect_phy_rssi_scan_data_result_verdict result;

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

@@ -8,6 +8,12 @@
 #define DECT_PHY_SCAN_H
 #include <zephyr/kernel.h>
 
+enum dect_phy_rssi_scan_data_result_verdict {
+	DECT_PHY_RSSI_SCAN_VERDICT_FREE,
+	DECT_PHY_RSSI_SCAN_VERDICT_POSSIBLE,
+	DECT_PHY_RSSI_SCAN_VERDICT_BUSY,
+};
+
 struct dect_phy_rssi_channel_scan_result_t {
 	enum nrf_modem_dect_phy_err phy_status;
 

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

@@ -166,6 +166,8 @@ struct dect_phy_common_op_event_msgq_item {
 #define DECT_PHY_COMMON_RX_CMD_HANDLE	 50
 #define DECT_PHY_COMMON_RSSI_SCAN_HANDLE 60
 
+#define DECT_PHY_MAC_BEACON_LMS_RSSI_SCAN_HANDLE 99
+
 #define DECT_PHY_MAC_BEACON_TX_HANDLE		 100
 #define DECT_PHY_MAC_BEACON_RX_RACH_HANDLE_START 101
 #define DECT_PHY_MAC_BEACON_RX_RACH_HANDLE_END	 999
@@ -180,6 +182,7 @@ struct dect_phy_common_op_event_msgq_item {
 #define DECT_PHY_MAC_CLIENT_ASSOCIATION_RX_HANDLE     1003
 #define DECT_PHY_MAC_CLIENT_ASSOCIATION_REL_TX_HANDLE 1004
 
+
 #define DECT_PHY_PERF_TX_HANDLE_START 10000
 #define DECT_PHY_PERF_TX_HANDLE_END   10049
 #define DECT_PHY_PERF_TX_HANDLE_IN_RANGE(x)                                                        \

samples/dect/dect_phy/dect_shell/src/dect/mac/dect_phy_mac.c

@@ -371,6 +371,7 @@ bool dect_phy_mac_handle(struct dect_phy_commmon_op_pdc_rcv_params *rcv_params)
 				beacon_msg = &sdu_list_item->message.cluster_beacon;
 			} else if (sdu_list_item->message_type ==
 				   DECT_PHY_MAC_MESSAGE_RANDOM_ACCESS_RESOURCE_IE) {
+				/* Note: there could be many of these, this takes only the last */
 				ra_ie = &sdu_list_item->message.rach_ie;
 			}
 		}