Store TX start channel and black list if TX failed (#2261)

Jarkko Paso · web-flow · commit 11a1e1d2de52 · 2019-12-19T15:13:28.000+02:00
diff --git a/nanostack/fhss_api.h b/nanostack/fhss_api.h
@@ -122,9 +122,10 @@ typedef void fhss_data_tx_done(const fhss_api_t *api, bool waiting_ack, bool tx_
  * @param api FHSS instance.
  * @param handle Handle of the data request.
  * @param frame_type Frame type of packet (Frames types are defined by FHSS api).
+ * @param channel Channel wanted to black list temporarily.
  * @return true if frame has to be queued for retransmission, false otherwise.
  */
-typedef bool fhss_data_tx_fail(const fhss_api_t *api, uint8_t handle, int frame_type);
+typedef bool fhss_data_tx_fail(const fhss_api_t *api, uint8_t handle, int frame_type, uint8_t channel);
 
 /**
  * @brief Change synchronization state.
diff --git a/source/MAC/IEEE802_15_4/mac_defines.h b/source/MAC/IEEE802_15_4/mac_defines.h
@@ -202,6 +202,7 @@ typedef struct protocol_interface_rf_mac_setup {
     mac_scan_type_t scan_type;
 
     uint8_t mac_channel;
+    uint8_t mac_tx_start_channel;
     //uint8_t cca_failure;
 
     /* MAC TX Queue */
diff --git a/source/MAC/IEEE802_15_4/mac_mcps_sap.c b/source/MAC/IEEE802_15_4/mac_mcps_sap.c
@@ -1430,7 +1430,7 @@ static void mcps_data_confirm_handle(protocol_interface_rf_mac_setup_s *rf_ptr,
     if (rf_ptr->fhss_api && !buffer->asynch_request) {
         // FHSS checks if this failed buffer needs to be pushed back to TX queue and retransmitted
         if ((rf_ptr->mac_tx_result == MAC_TX_FAIL) || (rf_ptr->mac_tx_result == MAC_CCA_FAIL)) {
-            if (rf_ptr->fhss_api->data_tx_fail(rf_ptr->fhss_api, buffer->msduHandle, mac_convert_frame_type_to_fhss(buffer->fcf_dsn.frametype)) == true) {
+            if (rf_ptr->fhss_api->data_tx_fail(rf_ptr->fhss_api, buffer->msduHandle, mac_convert_frame_type_to_fhss(buffer->fcf_dsn.frametype), rf_ptr->mac_tx_start_channel) == true) {
 
                 if (rf_ptr->mac_tx_result == MAC_TX_FAIL) {
                     buffer->fhss_retry_count += 1 + rf_ptr->mac_tx_status.retry;
@@ -1921,6 +1921,7 @@ static int8_t mcps_pd_data_request(protocol_interface_rf_mac_setup_s *rf_ptr, ma
     memset(&(rf_ptr->mac_tx_status), 0, sizeof(mac_tx_status_t));
     rf_ptr->mac_cca_retry = 0;
     rf_ptr->mac_tx_retry = 0;
+    rf_ptr->mac_tx_start_channel = rf_ptr->mac_channel;
     mac_csma_param_init(rf_ptr);
     if (mcps_generic_packet_build(rf_ptr, buffer) != 0) {
         return -1;
diff --git a/source/Service_Libs/fhss/fhss.c b/source/Service_Libs/fhss/fhss.c
@@ -1123,8 +1123,9 @@ static void fhss_data_tx_done_callback(const fhss_api_t *api, bool waiting_ack,
     }
 }
 
-static bool fhss_data_tx_fail_callback(const fhss_api_t *api, uint8_t handle, int frame_type)
+static bool fhss_data_tx_fail_callback(const fhss_api_t *api, uint8_t handle, int frame_type, uint8_t channel)
 {
+    (void) channel;
     fhss_structure_t *fhss_structure = fhss_get_object_with_api(api);
     if (!fhss_structure) {
         return false;
diff --git a/source/Service_Libs/fhss/fhss_ws.c b/source/Service_Libs/fhss/fhss_ws.c
@@ -663,7 +663,7 @@ static void fhss_ws_data_tx_done_callback(const fhss_api_t *api, bool waiting_ac
     }
 }
 
-static bool fhss_ws_data_tx_fail_callback(const fhss_api_t *api, uint8_t handle, int frame_type)
+static bool fhss_ws_data_tx_fail_callback(const fhss_api_t *api, uint8_t handle, int frame_type, uint8_t channel)
 {
     fhss_structure_t *fhss_structure = fhss_get_object_with_api(api);
     if (!fhss_structure) {
@@ -687,7 +687,7 @@ static bool fhss_ws_data_tx_fail_callback(const fhss_api_t *api, uint8_t handle,
             fhss_failed_handle_remove(fhss_structure, handle);
             return false;
         }
-        fhss_failed_tx->bad_channel = fhss_structure->rx_channel;
+        fhss_failed_tx->bad_channel = channel;
     } else {
         // Create new failure handle and return true to retransmit
         fhss_failed_handle_add(fhss_structure, handle, fhss_structure->rx_channel);
diff --git a/test/nanostack/unittest/service_libs/fhss/test_fhss.c b/test/nanostack/unittest/service_libs/fhss/test_fhss.c
@@ -48,6 +48,7 @@
 #define DEFAULT_WAITING_ACK     false
 #define DEFAULT_TX_COMPLETED    true
 #define DEFAULT_PHY_MTU_SIZE    255
+#define DEFAULT_BAD_CHANNEL     0
 
 static fhss_api_t fhss_api;
 static fhss_bs_t bs;
@@ -259,12 +260,12 @@ bool test_fhss_check_tx_conditions_callback()
     enable_fhss_struct();
     FHSS.fhss_state = FHSS_SYNCHRONIZED;
     nsdynmemlib_stub.returnCounter = 1;
-    FHSS.fhss_api->data_tx_fail(api, DEFAULT_HANDLE, DEFAULT_FRAME_TYPE);
+    FHSS.fhss_api->data_tx_fail(api, DEFAULT_HANDLE, DEFAULT_FRAME_TYPE, DEFAULT_BAD_CHANNEL);
     if (FHSS.fhss_api->check_tx_conditions(api, DEFAULT_IS_BC_DEST, DEFAULT_HANDLE, DEFAULT_FRAME_TYPE, DEFAULT_FRAME_LENGTH, DEFAULT_PHY_HEAD_LENGTH, DEFAULT_PHY_TAIL_LENGTH) != false) {
         return false;
     }
     // Second call of TX fail should remove the failed handle from list
-    FHSS.fhss_api->data_tx_fail(api, DEFAULT_HANDLE, DEFAULT_FRAME_TYPE);
+    FHSS.fhss_api->data_tx_fail(api, DEFAULT_HANDLE, DEFAULT_FRAME_TYPE, DEFAULT_BAD_CHANNEL);
     // Test failing channel type
     if (FHSS.fhss_api->check_tx_conditions(api, true, DEFAULT_HANDLE, DEFAULT_FRAME_TYPE, DEFAULT_FRAME_LENGTH, DEFAULT_PHY_HEAD_LENGTH, DEFAULT_PHY_TAIL_LENGTH) != false) {
         return false;
@@ -377,7 +378,7 @@ bool test_fhss_data_tx_done_callback()
 
     // Test removing failed handle
     nsdynmemlib_stub.returnCounter = 1;
-    FHSS.fhss_api->data_tx_fail(api, DEFAULT_HANDLE, DEFAULT_FRAME_TYPE);
+    FHSS.fhss_api->data_tx_fail(api, DEFAULT_HANDLE, DEFAULT_FRAME_TYPE, DEFAULT_BAD_CHANNEL);
     FHSS.fhss_api->data_tx_done(api, true, DEFAULT_TX_COMPLETED, DEFAULT_HANDLE);
 
     return true;
@@ -388,23 +389,23 @@ bool test_fhss_data_tx_fail_callback()
     fhss_api_t *api = test_generate_fhss_api();
     // Test when FHSS struct not found
     disable_fhss_struct();
-    if (FHSS.fhss_api->data_tx_fail(api, DEFAULT_HANDLE, DEFAULT_FRAME_TYPE) != false) {
+    if (FHSS.fhss_api->data_tx_fail(api, DEFAULT_HANDLE, DEFAULT_FRAME_TYPE, DEFAULT_BAD_CHANNEL) != false) {
         return false;
     }
     // Test when FHSS not synchronized
     enable_fhss_struct();
-    if (FHSS.fhss_api->data_tx_fail(api, DEFAULT_HANDLE, DEFAULT_FRAME_TYPE) != false) {
+    if (FHSS.fhss_api->data_tx_fail(api, DEFAULT_HANDLE, DEFAULT_FRAME_TYPE, DEFAULT_BAD_CHANNEL) != false) {
         return false;
     }
     // Test when channel retries are disabled
     FHSS.fhss_state = FHSS_SYNCHRONIZED;
     FHSS.bs->fhss_configuration.fhss_number_of_channel_retries = 0;
-    if (FHSS.fhss_api->data_tx_fail(api, DEFAULT_HANDLE, DEFAULT_FRAME_TYPE) != false) {
+    if (FHSS.fhss_api->data_tx_fail(api, DEFAULT_HANDLE, DEFAULT_FRAME_TYPE, DEFAULT_BAD_CHANNEL) != false) {
         return false;
     }
     // Test incorrect frame type
     FHSS.bs->fhss_configuration.fhss_number_of_channel_retries = 1;
-    if (FHSS.fhss_api->data_tx_fail(api, DEFAULT_HANDLE, FHSS_SYNCH_FRAME) != false) {
+    if (FHSS.fhss_api->data_tx_fail(api, DEFAULT_HANDLE, FHSS_SYNCH_FRAME, DEFAULT_BAD_CHANNEL) != false) {
         return false;
     }
 
diff --git a/test/nanostack/unittest/service_libs/fhss_ws/test_fhss_ws.c b/test/nanostack/unittest/service_libs/fhss_ws/test_fhss_ws.c
@@ -45,6 +45,7 @@
 #define DEFAULT_TIMESTAMP       0
 #define DEFAULT_WAITING_ACK     false
 #define DEFAULT_TX_COMPLETED    true
+#define DEFAULT_BAD_CHANNEL     0
 
 static fhss_api_t fhss_api;
 static fhss_ws_t ws;
@@ -399,33 +400,33 @@ bool test_fhss_ws_data_tx_fail_callback()
     fhss_api_t *api = test_generate_fhss_api();
     // Test when FHSS struct not found
     disable_fhss_struct();
-    if (fhss_common_stub.fhss_struct.fhss_api->data_tx_fail(api, DEFAULT_HANDLE, DEFAULT_FRAME_TYPE) != false) {
+    if (fhss_common_stub.fhss_struct.fhss_api->data_tx_fail(api, DEFAULT_HANDLE, DEFAULT_FRAME_TYPE, DEFAULT_BAD_CHANNEL) != false) {
         return false;
     }
     // Test when FHSS is unsynchronized
     enable_fhss_struct();
-    if (fhss_common_stub.fhss_struct.fhss_api->data_tx_fail(api, DEFAULT_HANDLE, DEFAULT_FRAME_TYPE) != false) {
+    if (fhss_common_stub.fhss_struct.fhss_api->data_tx_fail(api, DEFAULT_HANDLE, DEFAULT_FRAME_TYPE, DEFAULT_BAD_CHANNEL) != false) {
         return false;
     }
     // Test when not data frame
     fhss_common_stub.fhss_struct.fhss_state = FHSS_SYNCHRONIZED;
-    if (fhss_common_stub.fhss_struct.fhss_api->data_tx_fail(api, DEFAULT_HANDLE, FHSS_SYNCH_FRAME) != false) {
+    if (fhss_common_stub.fhss_struct.fhss_api->data_tx_fail(api, DEFAULT_HANDLE, FHSS_SYNCH_FRAME, DEFAULT_BAD_CHANNEL) != false) {
         return false;
     }
     // Test adding new failed entry
     fhss_common_stub.fhss_failed_tx.handle = DEFAULT_HANDLE + 1;
     fhss_common_stub.fhss_failed_tx.retries_done = 0;
-    if (fhss_common_stub.fhss_struct.fhss_api->data_tx_fail(api, DEFAULT_HANDLE, DEFAULT_FRAME_TYPE) != true) {
+    if (fhss_common_stub.fhss_struct.fhss_api->data_tx_fail(api, DEFAULT_HANDLE, DEFAULT_FRAME_TYPE, DEFAULT_BAD_CHANNEL) != true) {
         return false;
     }
     // Test when handle failed again
     fhss_common_stub.fhss_failed_tx.handle = DEFAULT_HANDLE;
-    if (fhss_common_stub.fhss_struct.fhss_api->data_tx_fail(api, DEFAULT_HANDLE, DEFAULT_FRAME_TYPE) != true) {
+    if (fhss_common_stub.fhss_struct.fhss_api->data_tx_fail(api, DEFAULT_HANDLE, DEFAULT_FRAME_TYPE, DEFAULT_BAD_CHANNEL) != true) {
         return false;
     }
     // Test last failure
     fhss_common_stub.fhss_failed_tx.retries_done = 3;
-    if (fhss_common_stub.fhss_struct.fhss_api->data_tx_fail(api, DEFAULT_HANDLE, DEFAULT_FRAME_TYPE) != false) {
+    if (fhss_common_stub.fhss_struct.fhss_api->data_tx_fail(api, DEFAULT_HANDLE, DEFAULT_FRAME_TYPE, DEFAULT_BAD_CHANNEL) != false) {
         return false;
     }
 
diff --git a/test/nanostack/unittest/stub/fhss_config_stub.c b/test/nanostack/unittest/stub/fhss_config_stub.c
@@ -44,7 +44,7 @@ void fhss_data_tx_done_cb_stub(const fhss_api_t *api, bool waiting_ack, bool tx_
     fhss_config_stub.int8_value++;
 }
 
-bool fhss_data_tx_fail_cb_stub(const fhss_api_t *api, uint8_t handle, int frame_type)
+bool fhss_data_tx_fail_cb_stub(const fhss_api_t *api, uint8_t handle, int frame_type, uint8_t channel)
 {
     fhss_config_stub.int8_value++;
     return true;
diff --git a/test/nanostack/unittest/stub/fhss_config_stub.h b/test/nanostack/unittest/stub/fhss_config_stub.h
@@ -35,7 +35,7 @@ bool fhss_is_broadcast_channel_cb_stub(const fhss_api_t *api);
 bool fhss_use_broadcast_queue_cb_stub(const fhss_api_t *api, bool is_broadcast_addr, int frame_type);
 void fhss_receive_frame_cb_stub(const fhss_api_t *api, uint16_t pan_id, uint8_t *source_address, uint32_t timestamp, uint8_t *synch_info, int frame_type);
 void fhss_data_tx_done_cb_stub(const fhss_api_t *api, bool waiting_ack, bool tx_completed, uint8_t handle);
-bool fhss_data_tx_fail_cb_stub(const fhss_api_t *api, uint8_t handle, int frame_type);
+bool fhss_data_tx_fail_cb_stub(const fhss_api_t *api, uint8_t handle, int frame_type, uint8_t channel);
 void fhss_synch_state_set_cb_stub(const fhss_api_t *api, fhss_states fhss_state, uint16_t pan_id);
 uint32_t fhss_read_timestamp_cb_stub(const fhss_api_t *api);
 uint16_t fhss_get_retry_period_cb_stub(const fhss_api_t *api, uint8_t *destination_address, uint16_t phy_mtu);

Original file line number	Diff line number	Diff line change
`@@ -1123,8 +1123,9 @@ static void fhss_data_tx_done_callback(const fhss_api_t *api, bool waiting_ack,`
`1123`	`1123`	`}`
`1124`	`1124`	`}`
`1125`	`1125`
`1126`		`-static bool fhss_data_tx_fail_callback(const fhss_api_t *api, uint8_t handle, int frame_type)`
	`1126`	`+static bool fhss_data_tx_fail_callback(const fhss_api_t *api, uint8_t handle, int frame_type, uint8_t channel)`
`1127`	`1127`	`{`
	`1128`	`+ (void) channel;`
`1128`	`1129`	`fhss_structure_t *fhss_structure = fhss_get_object_with_api(api);`
`1129`	`1130`	`if (!fhss_structure) {`
`1130`	`1131`	`return false;`
Original file line number	Diff line number	Diff line change
`@@ -663,7 +663,7 @@ static void fhss_ws_data_tx_done_callback(const fhss_api_t *api, bool waiting_ac`
`663`	`663`	`}`
`664`	`664`	`}`
`665`	`665`
`666`		`-static bool fhss_ws_data_tx_fail_callback(const fhss_api_t *api, uint8_t handle, int frame_type)`
	`666`	`+static bool fhss_ws_data_tx_fail_callback(const fhss_api_t *api, uint8_t handle, int frame_type, uint8_t channel)`
`667`	`667`	`{`
`668`	`668`	`fhss_structure_t *fhss_structure = fhss_get_object_with_api(api);`
`669`	`669`	`if (!fhss_structure) {`
`@@ -687,7 +687,7 @@ static bool fhss_ws_data_tx_fail_callback(const fhss_api_t *api, uint8_t handle,`
`687`	`687`	`fhss_failed_handle_remove(fhss_structure, handle);`
`688`	`688`	`return false;`
`689`	`689`	`}`
`690`		`- fhss_failed_tx->bad_channel = fhss_structure->rx_channel;`
	`690`	`+ fhss_failed_tx->bad_channel = channel;`
`691`	`691`	`} else {`
`692`	`692`	`// Create new failure handle and return true to retransmit`
`693`	`693`	`fhss_failed_handle_add(fhss_structure, handle, fhss_structure->rx_channel);`
Original file line number	Diff line number	Diff line change
`@@ -44,7 +44,7 @@ void fhss_data_tx_done_cb_stub(const fhss_api_t *api, bool waiting_ack, bool tx_`
`44`	`44`	`fhss_config_stub.int8_value++;`
`45`	`45`	`}`
`46`	`46`
`47`		`-bool fhss_data_tx_fail_cb_stub(const fhss_api_t *api, uint8_t handle, int frame_type)`
	`47`	`+bool fhss_data_tx_fail_cb_stub(const fhss_api_t *api, uint8_t handle, int frame_type, uint8_t channel)`
`48`	`48`	`{`
`49`	`49`	`fhss_config_stub.int8_value++;`
`50`	`50`	`return true;`