samples: dect_phy: dect_shell: mac: FT to FT bidir data transfer

Improved bidir FT/Beacon device to FT/Beacon device data sending when
using associate/rach_tx commands.
Jira: MOSH-632

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

Author: jhirsi

samples/dect/dect_phy/dect_shell/README.rst

@@ -932,6 +932,92 @@ Example: starting of cluster beacon and sending RA data to it
       Stopping beacon.
       Beacon TX stopped, cause: User Initiated.
 
+Example: two devices sending data to each other
+-----------------------------------------------
+
+* FT/Beacon device 1 - Start periodic cluster beacon TX on default band 1 and on the first free channel:
+
+  .. code-block:: console
+
+      desh:~$ dect sett --reset
+      desh:~$ dect sett -t 1
+      desh:~$ dect mac beacon_start
+      ...
+      Channel 1671 was chosen for the beacon.
+      Beacon TX started.
+
+* FT/Beacon device 2 - Scan the beacon from device 1:
+
+  .. code-block:: console
+
+      desh:~$ dect sett --reset
+      desh:~$ dect sett -t 2
+      desh:~$ dect mac beacon_scan -c 1671
+
+* FT/Beacon device 2 - Start periodic cluster beacon TX on default band 1 and on the first free channel:
+
+  .. code-block:: console
+
+      desh:~$ dect mac beacon_start
+      ...
+      Channel 1675 was chosen for the beacon.
+      Beacon TX started.
+
+* FT/Beacon device 1 - Scan the beacon from device 2 by using special force:
+
+  .. code-block:: console
+
+      desh:~$ dect mac beacon_scan -c 1675 -f
+
+* FT/Beacon device 1 - Send association request to device 2:
+
+  .. code-block:: console
+
+      desh:~$ dect mac associate -t 2
+
+
+* FT/Beacon device 2 - Send association request to device 1:
+
+  .. code-block:: console
+
+      desh:~$ dect mac associate -t 1
+
+* FT/Beacon device 1 - Send JSON-formatted periodic RA data in 10-second intervals with the current modem temperature to the device 2:
+
+  .. code-block:: console
+
+      desh:~$ dect mac rach_tx -t 2 -d "Data from device 1" -i 10 -j
+
+* FT/Beacon device 2 - Send JSON-formatted periodic RA data in 10-second intervals with the current modem temperature to the device 1:
+
+  .. code-block:: console
+
+      desh:~$ dect mac rach_tx -t 1 -d "Data from device 2" -i 10 -j
+
+* FT/Beacon devices 1 & 2 - Stop periodic RA data sending:
+
+  .. code-block:: console
+
+      desh:~$ dect mac rach_tx stop
+
+* FT/Beacon device 1 - Send association release to the device 2:
+
+  .. code-block:: console
+
+      desh:~$ dect mac dissociate -t 2
+
+* FT/Beacon device 2 - Send association release to the device 1:
+
+  .. code-block:: console
+
+      desh:~$ dect mac dissociate -t 1
+
+* FT/Beacon devices 1 & 2 - Stop the beacon:
+
+  .. code-block:: console
+
+      desh:~$ dect mac beacon_stop
+
 Running commands at bootup
 ==========================
 

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

@@ -482,3 +482,10 @@ bool dect_common_utils_32bit_network_id_validate(uint32_t network_id)
 
 	return ((0 != lsb_bits) && (0 != msb_bits));
 }
+
+/**************************************************************************************************/
+
+bool dect_common_utils_mdm_ticks_is_in_range(uint64_t time, uint64_t start, uint64_t end)
+{
+	return (time >= start && time <= end);
+}

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

@@ -90,4 +90,8 @@ int8_t dect_common_utils_harq_tx_next_redundancy_version_get(uint8_t current_red
 
 bool dect_common_utils_32bit_network_id_validate(uint32_t network_id);
 
+/******************************************************************************/
+
+bool dect_common_utils_mdm_ticks_is_in_range(uint64_t time, uint64_t start, uint64_t end);
+
 #endif /* DECT_COMMON_UTILS_H */

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

@@ -790,7 +790,7 @@ int dect_phy_ctrl_modem_temperature_get(void)
 
 /**************************************************************************************************/
 
-bool dect_phy_ctrl_rx_is_on_going(void)
+bool dect_phy_ctrl_rx_is_ongoing(void)
 {
 	return ctrl_data.rx_cmd_on_going;
 }

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

@@ -46,7 +46,7 @@ void dect_phy_ctrl_status_get_n_print(void);
 
 int dect_phy_ctrl_rx_start(struct dect_phy_rx_cmd_params *params, bool restart);
 void dect_phy_ctrl_rx_stop(void);
-bool dect_phy_ctrl_rx_is_on_going(void);
+bool dect_phy_ctrl_rx_is_ongoing(void);
 
 int dect_phy_ctrl_time_query(void);
 

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

@@ -191,7 +191,7 @@ struct dect_phy_common_op_event_msgq_item {
 #define DECT_PHY_MAC_CLIENT_ASSOCIATION_RX_HANDLE	1004
 #define DECT_PHY_MAC_CLIENT_ASSOCIATION_REL_TX_HANDLE	1005
 #define DECT_PHY_MAC_CLIENT_ASSOCIATED_BG_SCAN		1006
-/* Following handles DECT_PHY_MAC_CLIENT_ASSOCIATED_BG_SCAN + DECT_PHY_MAC_MAX_NEIGBORS
+/* Following handles from DECT_PHY_MAC_CLIENT_ASSOCIATED_BG_SCAN + 1 to DECT_PHY_MAC_MAX_NEIGBORS
  * are reserved for associated bg scannings.
  */
 

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

@@ -357,20 +357,24 @@ bool dect_phy_mac_handle(struct dect_phy_commmon_op_pdc_rcv_params *rcv_params)
 	}
 
 	/* Print only if:
+	 * - beacon tx ongoing and we have announced RA resources.
 	 * - client is associating/associated with the target device and
 	 *   the received message is not a beacon from target
 	 * - beacon scan / rx cmd is ongoing
-	 * - beacon tx ongoing and we have announced RA resources.
 	 */
-	if (dect_phy_mac_client_associated_by_target_short_rd_id(
-		rcv_params->last_received_pcc_transmitter_short_rd_id) &&
-		type_header.type != DECT_PHY_MAC_HEADER_TYPE_BEACON) {
+	if (dect_phy_mac_cluster_beacon_is_running()) {
 		print = true;
 	}
-	if (dect_phy_ctrl_rx_is_on_going()) {
+
+	if (dect_phy_mac_client_associated_by_target_short_rd_id(
+		rcv_params->last_received_pcc_transmitter_short_rd_id)) {
 		print = true;
+		if (type_header.type == DECT_PHY_MAC_HEADER_TYPE_BEACON) {
+			print = false;
+		}
 	}
-	if (dect_phy_mac_cluster_beacon_is_running()) {
+
+	if (dect_phy_ctrl_rx_is_ongoing()) {
 		print = true;
 	}
 

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

@@ -26,6 +26,7 @@
 #include "dect_phy_mac_pdu.h"
 #include "dect_phy_mac_nbr.h"
 #include "dect_phy_mac_nbr_bg_scan.h"
+#include "dect_phy_mac_cluster_beacon.h"
 #include "dect_phy_mac.h"
 #include "dect_phy_mac_client.h"
 
@@ -43,7 +44,7 @@ struct dect_phy_mac_client_association_data {
 	uint32_t target_long_rd_id;
 
 	uint32_t bg_scan_phy_handle;
-	bool bg_scan_on_going;
+	bool bg_scan_ongoing;
 
 	struct dect_phy_mac_nbr_info_list_item *target_nbr;
 	struct k_work_delayable association_resp_wait_work;
@@ -176,6 +177,15 @@ static uint64_t dect_phy_mac_client_next_rach_tx_time_get(
 	if (beacon_interval_ms < 0) {
 		return 0;
 	}
+	bool our_beacon_is_running = dect_phy_mac_cluster_beacon_is_running();
+
+	if (our_beacon_is_running) {
+		/* If our beacon is running, send beyond the window to get the priority over others.
+		 * This adds more delay to TX but is more reliable to avoid scheduling collisions.
+		 */
+		first_possible_tx += MS_TO_MODEM_TICKS(DECT_PHY_API_SCHEDULER_OP_TIME_WINDOW_MS);
+	}
+
 	beacon_interval_mdm_ticks = MS_TO_MODEM_TICKS(beacon_interval_ms);
 
 	/* We are sending after next beacon and ...  */
@@ -206,6 +216,21 @@ static uint64_t dect_phy_mac_client_next_rach_tx_time_get(
 	if (client_data.last_tx_time_mdm_ticks > first_possible_tx) {
 		first_possible_tx = client_data.last_tx_time_mdm_ticks + 1;
 	}
+
+	/* ... and try to avoid collisions with our own beacon TX:  */
+	uint64_t next_our_beacon_frame_time = 0;
+
+	if (dect_phy_mac_cluster_beacon_is_running()) {
+		next_our_beacon_frame_time =
+			dect_phy_mac_cluster_beacon_last_tx_frame_time_get();
+		uint32_t our_beacon_interval_mdm_ticks =
+			MS_TO_MODEM_TICKS(DECT_PHY_MAC_CLUSTER_BEACON_INTERVAL_MS);
+
+		while (next_our_beacon_frame_time < first_possible_tx) {
+			next_our_beacon_frame_time += our_beacon_interval_mdm_ticks;
+		}
+	}
+
 	/* ...and in 1st RA (if not associated). Additionally, to get RX really on target:
 	 * delay TX by 2 subslots.
 	 */
@@ -220,6 +245,14 @@ static uint64_t dect_phy_mac_client_next_rach_tx_time_get(
 	while (ra_start_mdm_ticks < first_possible_tx &&
 	       ra_start_mdm_ticks < last_valid_rach_rx_frame_time) {
 		ra_start_mdm_ticks += ra_interval_mdm_ticks;
+		if (next_our_beacon_frame_time && dect_common_utils_mdm_ticks_is_in_range(
+							ra_start_mdm_ticks,
+							next_our_beacon_frame_time,
+							next_our_beacon_frame_time +
+							(DECT_RADIO_FRAME_DURATION_IN_MODEM_TICKS /
+								2))) {
+			ra_start_mdm_ticks += ra_interval_mdm_ticks;
+		}
 	}
 
 	return ra_start_mdm_ticks;
@@ -367,7 +400,7 @@ static int dect_phy_mac_client_rach_tx(struct dect_phy_mac_nbr_info_list_item *t
 	memcpy(&sched_list_item->sched_config.tx.phy_header.type_2, &phy_header.type_2,
 	       sizeof(phy_header.type_2));
 
-	sched_list_item->priority = DECT_PRIORITY1_TX;
+	sched_list_item->priority = DECT_PRIORITY0_FORCE_TX;
 	sched_list_item->phy_op_handle = DECT_PHY_MAC_CLIENT_RA_TX_HANDLE;
 
 	if (params->interval_secs) {
@@ -578,7 +611,7 @@ static int dect_phy_mac_client_associate_msg_send(
 	memcpy(&sched_list_item->sched_config.tx.phy_header.type_2, &phy_header.type_2,
 	       sizeof(phy_header.type_2));
 
-	sched_list_item->priority = DECT_PRIORITY1_TX;
+	sched_list_item->priority = DECT_PRIORITY0_FORCE_TX;
 	sched_list_item->phy_op_handle = DECT_PHY_MAC_CLIENT_ASSOCIATION_TX_HANDLE;
 
 	/* Add tx operation to scheduler list */
@@ -671,7 +704,7 @@ static void dect_phy_mac_client_association_data_init(void)
 		client_data.associations[i].bg_scan_phy_handle =
 			DECT_PHY_MAC_CLIENT_ASSOCIATED_BG_SCAN + i;
 		client_data.associations[i].target_nbr = NULL;
-		client_data.associations[i].bg_scan_on_going = false;
+		client_data.associations[i].bg_scan_ongoing = false;
 	}
 }
 
@@ -686,7 +719,7 @@ static struct dect_phy_mac_client_association_data *dect_phy_mac_client_associat
 	return NULL;
 }
 
-static void dect_phy_mac_client_associate_resp_wait_worker(struct k_work *work_item)
+static void dect_phy_mac_client_associate_resp_timeout_worker(struct k_work *work_item)
 {
 	struct k_work_delayable *delayable_work = k_work_delayable_from_work(work_item);
 	struct dect_phy_mac_client_association_data *association_data =
@@ -701,7 +734,7 @@ static void dect_phy_mac_client_associate_resp_wait_worker(struct k_work *work_i
 	association_data->target_nbr = NULL;
 	association_data->state = DECT_PHY_MAC_CLIENT_ASSOCIATION_STATE_DISASSOCIATED;
 	dect_phy_mac_nbr_bg_scan_stop(association_data->bg_scan_phy_handle);
-	association_data->bg_scan_on_going = false;
+	association_data->bg_scan_ongoing = false;
 
 	desh_warn("Association response timeout: not associated with device long RD ID %d",
 		association_data->target_long_rd_id);
@@ -737,7 +770,7 @@ int dect_phy_mac_client_associate(struct dect_phy_mac_nbr_info_list_item *target
 
 	k_work_init_delayable(
 		&association_data->association_resp_wait_work,
-		dect_phy_mac_client_associate_resp_wait_worker);
+		dect_phy_mac_client_associate_resp_timeout_worker);
 
 	/* Start worker for waiting association response */
 	k_work_schedule_for_queue(&dect_phy_ctrl_work_q,
@@ -769,7 +802,7 @@ void dect_phy_mac_client_nbr_scan_completed_cb(
 			(__func__), info->target_long_rd_id,
 			DECT_PHY_MAC_NBR_BG_SCAN_MAX_UNREACHABLE_TIME_MS);
 	}
-	association_data->bg_scan_on_going = false;
+	association_data->bg_scan_ongoing = false;
 }
 
 void dect_phy_mac_client_associate_resp_handle(
@@ -797,14 +830,14 @@ void dect_phy_mac_client_associate_resp_handle(
 	bg_scan_params.target_long_rd_id = association_data->target_long_rd_id;
 	bg_scan_params.phy_op_handle = association_data->bg_scan_phy_handle;
 
-	if (association_data->bg_scan_on_going) {
+	if (association_data->bg_scan_ongoing) {
 		dect_phy_mac_nbr_bg_scan_stop(association_data->bg_scan_phy_handle);
 	}
 
 	if (dect_phy_mac_nbr_bg_scan_start(&bg_scan_params)) {
 		desh_warn("(%s): dect_phy_mac_nbr_bg_scan_start failed", (__func__));
 	} else {
-		association_data->bg_scan_on_going = true;
+		association_data->bg_scan_ongoing = true;
 	}
 }
 
@@ -1020,7 +1053,7 @@ int dect_phy_mac_client_dissociate(struct dect_phy_mac_nbr_info_list_item *targe
 	k_work_cancel_delayable(&association_data->association_resp_wait_work);
 
 	dect_phy_mac_nbr_bg_scan_stop(association_data->bg_scan_phy_handle);
-	association_data->bg_scan_on_going = false;
+	association_data->bg_scan_ongoing = false;
 
 	association_data->state = DECT_PHY_MAC_CLIENT_ASSOCIATION_STATE_DISASSOCIATED;
 	association_data->target_nbr = NULL;

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

@@ -40,6 +40,7 @@ static struct dect_phy_mac_cluster_beacon_data {
 
 	dect_phy_mac_cluster_beacon_t last_cluster_beacon_msg;
 	dect_phy_mac_random_access_resource_ie_t last_rach_ie;
+	uint64_t last_tx_frame_time;
 
 	struct dect_phy_mac_beacon_start_params start_params;
 } beacon_data;
@@ -272,6 +273,19 @@ void dect_phy_mac_ctrl_cluster_beacon_phy_api_direct_rssi_cb(
 	}
 }
 
+static void dect_phy_mac_cluster_beacon_to_mdm_cb(
+	struct dect_phy_common_op_completed_params *params, uint64_t frame_time)
+{
+	if (params->status == NRF_MODEM_DECT_PHY_SUCCESS) {
+		beacon_data.last_tx_frame_time = frame_time;
+	}
+}
+
+uint64_t dect_phy_mac_cluster_beacon_last_tx_frame_time_get(void)
+{
+	return beacon_data.last_tx_frame_time;
+}
+
 int dect_phy_mac_cluster_beacon_tx_start(struct dect_phy_mac_beacon_start_params *params)
 {
 
@@ -367,6 +381,7 @@ int dect_phy_mac_cluster_beacon_tx_start(struct dect_phy_mac_beacon_start_params
 		current_settings->common.transmitter_id;
 	sched_list_item_conf->address_info.receiver_long_rd_id = DECT_LONG_RD_ID_BROADCAST;
 
+	sched_list_item_conf->cb_op_to_mdm = dect_phy_mac_cluster_beacon_to_mdm_cb;
 	sched_list_item_conf->cb_op_completed = NULL;
 
 	sched_list_item_conf->channel = params->beacon_channel;

samples/dect/dect_phy/dect_shell/src/dect/mac/dect_phy_mac_cluster_beacon.h

@@ -39,6 +39,8 @@ void dect_phy_mac_ctrl_cluster_beacon_phy_api_direct_rssi_cb(
 
 bool dect_phy_mac_cluster_beacon_is_running(void);
 
+uint64_t dect_phy_mac_cluster_beacon_last_tx_frame_time_get(void);
+
 /******************************************************************************/
 
 void dect_phy_mac_cluster_beacon_association_req_handle(