Merge pull request ARMmbed#1829 from ARMmbed/IOTTHD-2821

WS: fixed overwriting fixed channel with random

Author: Jarkko Paso

nanostack/fhss_config.h

@@ -29,8 +29,6 @@ extern "C" {
 #endif
 
 #include "fhss_ws_extension.h"
-// Just to make the PR work. Will be removed when Application updated.
-#define ws_channel_function ws_uc_channel_function
 
 /**
  * @brief WS channel functions.

nanostack/ws_management_api.h

@@ -31,11 +31,6 @@
 #include "ns_types.h"
 #include "net_interface.h" /* Declaration for channel_list_s. */
 
-// TODO: Remove when application updated
-#define DEFAULT_FIXED_CHANNEL   11
-#define DEFAULT_DWELL_TIME      250
-#define ws_management_fhss_channel_function_configure(x,y)   ws_management_fhss_unicast_channel_function_configure(x,y,DEFAULT_FIXED_CHANNEL,DEFAULT_DWELL_TIME)
-
 #ifdef __cplusplus
 extern "C" {
 #endif
@@ -187,12 +182,11 @@ int ws_management_fhss_timing_configure(
  * Configure unicast channel function.
  *
  * Change the default configuration for Wi-SUN FHSS operation.
- * This will use randomized value for fixed channel if used.
  * if application defined is used the behaviour is undefined
  *
  * \param interface_id Network interface ID.
  * \param channel_function Unicast channel function.
- * \param fixed_channel Used channel when channel function is fixed channel.
+ * \param fixed_channel Used channel when channel function is fixed channel. If 0xFFFF, randomly chosen channel is used.
  * \param dwell_interval Used dwell interval when channel function is TR51 or DH1.
  *
  * \return 0, Init OK.
@@ -201,19 +195,18 @@ int ws_management_fhss_timing_configure(
 int ws_management_fhss_unicast_channel_function_configure(
     int8_t interface_id,
     uint8_t channel_function,
-    uint8_t fixed_channel,
+    uint16_t fixed_channel,
     uint8_t dwell_interval);
 
 /**
  * Configure broadcast channel function.
  *
  * Change the default configuration for Wi-SUN FHSS operation.
- * This will use randomized value for fixed channel if used.
  * if application defined is used the behaviour is undefined
  *
  * \param interface_id Network interface ID.
  * \param channel_function Broadcast channel function.
- * \param fixed_channel Used channel when channel function is fixed channel.
+ * \param fixed_channel Used channel when channel function is fixed channel. If 0xFFFF, randomly chosen channel is used.
  * \param dwell_interval Broadcast channel dwell interval.
  * \param broadcast_interval Broadcast interval.
  *
@@ -223,7 +216,7 @@ int ws_management_fhss_unicast_channel_function_configure(
 int ws_management_fhss_broadcast_channel_function_configure(
     int8_t interface_id,
     uint8_t channel_function,
-    uint8_t fixed_channel,
+    uint16_t fixed_channel,
     uint8_t dwell_interval,
     uint32_t broadcast_interval);
 

source/6LoWPAN/ws/ws_bootstrap.c

@@ -407,6 +407,15 @@ static int8_t ws_fhss_border_router_configure(protocol_interface_info_entry_t *c
     return 0;
 }
 
+static uint16_t ws_randomize_fixed_channel(uint16_t configured_fixed_channel, uint8_t number_of_channels)
+{
+    if (configured_fixed_channel == 0xFFFF) {
+        return randLIB_get_random_in_range(0, number_of_channels - 1);
+    } else {
+        return configured_fixed_channel;
+    }
+}
+
 static int8_t ws_fhss_discovery_configure(protocol_interface_info_entry_t *cur)
 {
     // Read configuration of existing FHSS and start using the default values for any network
@@ -420,12 +429,12 @@ static int8_t ws_fhss_discovery_configure(protocol_interface_info_entry_t *cur)
     fhss_configuration.ws_bc_channel_function = WS_FIXED_CHANNEL;
     fhss_configuration.fhss_bc_dwell_interval = 0;
     fhss_configuration.fhss_broadcast_interval = 0;
-    cur->ws_info->fhss_uc_fixed_channel = randLIB_get_random_in_range(0,cur->ws_info->hopping_schdule.number_of_channels - 1);
-    cur->ws_info->fhss_bc_fixed_channel = randLIB_get_random_in_range(0,cur->ws_info->hopping_schdule.number_of_channels - 1);
+    uint8_t tmp_uc_fixed_channel = ws_randomize_fixed_channel(cur->ws_info->fhss_uc_fixed_channel, cur->ws_info->hopping_schdule.number_of_channels);
+    uint8_t tmp_bc_fixed_channel = ws_randomize_fixed_channel(cur->ws_info->fhss_bc_fixed_channel, cur->ws_info->hopping_schdule.number_of_channels);
     memset(fhss_configuration.channel_mask, 0, sizeof(uint32_t) * 8);
-    channel_list_set_channel(fhss_configuration.channel_mask, cur->ws_info->fhss_uc_fixed_channel, true);
-    fhss_configuration.unicast_fixed_channel = cur->ws_info->fhss_uc_fixed_channel;
-    fhss_configuration.broadcast_fixed_channel = cur->ws_info->fhss_bc_fixed_channel;
+    channel_list_set_channel(fhss_configuration.channel_mask, tmp_uc_fixed_channel, true);
+    fhss_configuration.unicast_fixed_channel = tmp_uc_fixed_channel;
+    fhss_configuration.broadcast_fixed_channel = tmp_bc_fixed_channel;
     ns_fhss_ws_configuration_set(cur->ws_info->fhss_api,&fhss_configuration);
     ws_bootstrap_llc_hopping_update(cur,&fhss_configuration);
 
@@ -473,6 +482,7 @@ static void ws_bootstrap_primary_parent_set(struct protocol_interface_info_entry
         fhss_configuration.ws_bc_channel_function = neighbor_info->ws_neighbor->fhss_data.bc_timing_info.broadcast_channel_function;
         if (fhss_configuration.ws_bc_channel_function == WS_FIXED_CHANNEL) {
             cur->ws_info->hopping_schdule.bc_fixed_channel = neighbor_info->ws_neighbor->fhss_data.bc_timing_info.fixed_channel;
+            cur->ws_info->fhss_bc_fixed_channel = neighbor_info->ws_neighbor->fhss_data.bc_timing_info.fixed_channel;
         }
         fhss_configuration.bsi = neighbor_info->ws_neighbor->fhss_data.bc_timing_info.broadcast_schedule_id;
         fhss_configuration.fhss_bc_dwell_interval = neighbor_info->ws_neighbor->fhss_data.bc_timing_info.broadcast_dwell_interval;
@@ -1776,9 +1786,9 @@ static void ws_bootstrap_event_handler(arm_event_s *event)
 
         if (cur->bootsrap_mode == ARM_NWK_BOOTSRAP_MODE_6LoWPAN_BORDER_ROUTER) {
             tr_debug("Border router start network");
-            // Randomize fixed channel. Only used if channel plan is fixed
-            cur->ws_info->fhss_uc_fixed_channel = randLIB_get_random_in_range(0,cur->ws_info->hopping_schdule.number_of_channels - 1);
-            cur->ws_info->fhss_bc_fixed_channel = randLIB_get_random_in_range(0,cur->ws_info->hopping_schdule.number_of_channels - 1);
+            // Randomize fixed channels. Only used if channel plan is fixed.
+            cur->ws_info->fhss_uc_fixed_channel = ws_randomize_fixed_channel(cur->ws_info->fhss_uc_fixed_channel, cur->ws_info->hopping_schdule.number_of_channels);
+            cur->ws_info->fhss_bc_fixed_channel = ws_randomize_fixed_channel(cur->ws_info->fhss_bc_fixed_channel, cur->ws_info->hopping_schdule.number_of_channels);
             cur->ws_info->network_pan_id = randLIB_get_random_in_range(0,0xfffd);
             cur->ws_info->pan_information.pan_size = 0;
             cur->ws_info->pan_information.pan_version = randLIB_get_random_in_range(0,0xffff);

source/6LoWPAN/ws/ws_common.c

@@ -153,6 +153,8 @@ int8_t ws_common_allocate_and_init(protocol_interface_info_entry_t *cur)
     ws_common_regulatory_domain_config(cur);
 
     // Set defaults for the device. user can modify these.
+    cur->ws_info->fhss_uc_fixed_channel = 0xffff;
+    cur->ws_info->fhss_bc_fixed_channel = 0xffff;
     cur->ws_info->fhss_uc_dwell_interval = WS_FHSS_UC_DWELL_INTERVAL;
     cur->ws_info->fhss_bc_interval = WS_FHSS_BC_INTERVAL;
     cur->ws_info->fhss_bc_dwell_interval = WS_FHSS_BC_DWELL_INTERVAL;

source/6LoWPAN/ws/ws_common.h

@@ -78,8 +78,8 @@ typedef struct ws_info_s {
     uint32_t fhss_bc_interval;
     uint8_t fhss_uc_channel_function;
     uint8_t fhss_bc_channel_function;
-    uint8_t fhss_uc_fixed_channel;
-    uint8_t fhss_bc_fixed_channel;
+    uint16_t fhss_uc_fixed_channel;
+    uint16_t fhss_bc_fixed_channel;
     uint32_t fhss_channel_mask[8];
     ws_nud_table_entry_t nud_table_entrys[ACTIVE_NUD_PROCESS_MAX];
     ws_nud_table_list_t active_nud_process;

source/6LoWPAN/ws/ws_empty_functions.c

@@ -95,7 +95,7 @@ int ws_management_fhss_timing_configure(
 int ws_management_fhss_unicast_channel_function_configure(
     int8_t interface_id,
     uint8_t channel_function,
-    uint8_t fixed_channel,
+    uint16_t fixed_channel,
     uint8_t dwell_interval)
 {
     (void)interface_id;
@@ -108,7 +108,7 @@ int ws_management_fhss_unicast_channel_function_configure(
 int ws_management_fhss_broadcast_channel_function_configure(
     int8_t interface_id,
     uint8_t channel_function,
-    uint8_t fixed_channel,
+    uint16_t fixed_channel,
     uint8_t dwell_interval,
     uint32_t broadcast_interval)
 {

source/6LoWPAN/ws/ws_management_api.c

@@ -164,7 +164,7 @@ int ws_management_fhss_timing_configure(
 int ws_management_fhss_unicast_channel_function_configure(
     int8_t interface_id,
     uint8_t channel_function,
-    uint8_t fixed_channel,
+    uint16_t fixed_channel,
     uint8_t dwell_interval)
 {
     protocol_interface_info_entry_t *cur;
@@ -195,7 +195,7 @@ int ws_management_fhss_unicast_channel_function_configure(
 int ws_management_fhss_broadcast_channel_function_configure(
     int8_t interface_id,
     uint8_t channel_function,
-    uint8_t fixed_channel,
+    uint16_t fixed_channel,
     uint8_t dwell_interval,
     uint32_t broadcast_interval)
 {

test/nanostack/unittest/service_libs/fhss_ws/test_fhss_ws.c

@@ -301,7 +301,7 @@ bool test_fhss_ws_check_tx_conditions_callback()
         return false;
     }
     // Test broadcast destination on unicast channel
-    fhss_common_stub.fhss_struct.ws->fhss_configuration.ws_channel_function = WS_TR51CF;
+    fhss_common_stub.fhss_struct.ws->fhss_configuration.ws_uc_channel_function = WS_TR51CF;
     if (fhss_common_stub.fhss_struct.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;
     }
@@ -386,7 +386,7 @@ bool test_fhss_ws_data_tx_done_callback()
     // Test when FHSS struct can be found
     enable_fhss_struct();
     fhss_common_stub.fhss_struct.fhss_state = FHSS_SYNCHRONIZED;
-    fhss_common_stub.fhss_struct.ws->fhss_configuration.ws_channel_function = WS_TR51CF;
+    fhss_common_stub.fhss_struct.ws->fhss_configuration.ws_uc_channel_function = WS_TR51CF;
     fhss_common_stub.fhss_struct.fhss_api->data_tx_done(api, DEFAULT_WAITING_ACK, DEFAULT_TX_COMPLETED, DEFAULT_HANDLE);
 
     return true;
@@ -452,7 +452,7 @@ bool test_fhss_ws_synch_state_set_callback()
 bool test_fhss_ws_write_synch_info_callback()
 {
     fhss_api_t *api = test_generate_fhss_api();
-    fhss_common_stub.fhss_struct.ws->fhss_configuration.ws_channel_function = WS_TR51CF;
+    fhss_common_stub.fhss_struct.ws->fhss_configuration.ws_uc_channel_function = WS_TR51CF;
     fhss_common_stub.fhss_struct.rx_channel = 0;
     uint8_t synch_info[100] = {0x05, 0x15, 0x02, 0x00, 0x00, 0x00, 0x00, 0x05, 0x15, 0x01, 0x04, 0x00, 0x00, 0x00, 0x00, 0x3f};
     // Test when FHSS struct not found
@@ -561,28 +561,28 @@ bool test_fhss_ws_update_uc_channel_callback()
         return false;
     }
     // Test setting TR51 unicast channel
-    fhss_common_stub.fhss_struct.ws->fhss_configuration.ws_channel_function = WS_TR51CF;
+    fhss_common_stub.fhss_struct.ws->fhss_configuration.ws_uc_channel_function = WS_TR51CF;
     fhss_common_stub.fhss_struct.fhss_api->synch_state_set(api, DEFAULT_FHSS_STATE, DEFAULT_PANID);
     if ((3 != fhss_callbacks_stub.uint8_value) || (fhss_common_stub.fhss_struct.ws->uc_slot != 0)) {
         return false;
     }
     // Test setting direct hash unicast channel
-    fhss_common_stub.fhss_struct.ws->fhss_configuration.ws_channel_function = WS_DH1CF;
+    fhss_common_stub.fhss_struct.ws->fhss_configuration.ws_uc_channel_function = WS_DH1CF;
     fhss_common_stub.fhss_struct.fhss_api->synch_state_set(api, DEFAULT_FHSS_STATE, DEFAULT_PANID);
     if ((1 != fhss_callbacks_stub.uint8_value) || (fhss_common_stub.fhss_struct.ws->uc_slot != 1)) {
         return false;
     }
     // Test setting vendor defined unicast channel
     fhss_common_stub.fhss_struct.ws->fhss_configuration.vendor_defined_cf = app_channel_function;
-    fhss_common_stub.fhss_struct.ws->fhss_configuration.ws_channel_function = WS_VENDOR_DEF_CF;
+    fhss_common_stub.fhss_struct.ws->fhss_configuration.ws_uc_channel_function = WS_VENDOR_DEF_CF;
     fhss_common_stub.fhss_struct.fhss_api->synch_state_set(api, DEFAULT_FHSS_STATE, DEFAULT_PANID);
     if ((VENDOR_CHANNEL != fhss_callbacks_stub.uint8_value) || (fhss_common_stub.fhss_struct.ws->uc_slot != 1)) {
         return false;
     }
     // Test changing unicast channel when broadcast channel is active
     api = test_generate_fhss_api();
     enable_fhss_struct();
-    fhss_common_stub.fhss_struct.ws->fhss_configuration.ws_channel_function = WS_TR51CF;
+    fhss_common_stub.fhss_struct.ws->fhss_configuration.ws_uc_channel_function = WS_TR51CF;
     fhss_common_stub.fhss_struct.fhss_api->synch_state_set(api, DEFAULT_FHSS_STATE, DEFAULT_PANID);
     if ((3 != fhss_common_stub.fhss_struct.rx_channel) || (3 == fhss_callbacks_stub.uint8_value)) {
         return false;
@@ -597,7 +597,7 @@ bool test_fhss_unicast_handler()
     fhss_common_stub.fhss_struct.ws->fhss_configuration.fhss_bc_dwell_interval = 0;
     fhss_common_stub.fhss_struct.ws->fhss_configuration.fhss_broadcast_interval = 0;
     fhss_common_stub.fhss_struct.ws->uc_slot = fhss_common_stub.fhss_struct.number_of_channels - 1;
-    fhss_common_stub.fhss_struct.ws->fhss_configuration.ws_channel_function = WS_TR51CF;
+    fhss_common_stub.fhss_struct.ws->fhss_configuration.ws_uc_channel_function = WS_TR51CF;
 
     // Call state set just to get fhss_stub.callback
     enable_fhss_struct();
@@ -629,7 +629,7 @@ bool test_fhss_ws_set_parent()
     }
 
     // Test success
-    fhss_common_stub.fhss_struct.ws->fhss_configuration.ws_channel_function = WS_TR51CF;
+    fhss_common_stub.fhss_struct.ws->fhss_configuration.ws_uc_channel_function = WS_TR51CF;
     bc_timing_info.broadcast_channel_function = WS_TR51CF;
     bc_timing_info.broadcast_dwell_interval = 250;
     bc_timing_info.broadcast_interval = 1000;