FHSS: Moved own hop to common FHSS structure

Author: Jarkko Paso

source/Service_Libs/fhss/fhss.c

@@ -79,7 +79,7 @@ fhss_structure_t *fhss_enable(fhss_api_t *fhss_api, const fhss_configuration_t *
         fhss_struct->bs->fhss_configuration.fhss_max_synch_interval = 240;
     }
     ns_list_init(&fhss_struct->fhss_failed_tx_list);
-    fhss_struct->bs->own_hop = 0xff;
+    fhss_struct->own_hop = 0xff;
     fhss_reset(fhss_struct);
 
     if (fhss_beacon_create_tasklet(fhss_struct) < 0) {
@@ -93,7 +93,7 @@ fhss_structure_t *fhss_enable(fhss_api_t *fhss_api, const fhss_configuration_t *
 
 bool fhss_is_synch_root(fhss_structure_t *fhss_structure)
 {
-    if (fhss_structure->bs->own_hop > 0) {
+    if (fhss_structure->own_hop > 0) {
         return false;
     }
     return true;
@@ -241,7 +241,7 @@ static int fhss_update_txrx_slots(fhss_structure_t *fhss_structure)
      *
      */
 
-    if ((fhss_structure->bs->own_hop % 2)) {
+    if ((fhss_structure->own_hop % 2)) {
         tx_slot_up_limit += tx_slot_length;
     }
     while(number_of_tx_slots--)
@@ -367,12 +367,12 @@ static int fhss_sync_with_beacon(fhss_structure_t *fhss_structure,
         configuration->fhss_number_of_superframes = payload->number_of_superframes_per_channel;
         // todo:
         // * payload->time_since_last_beacon
-        uint8_t own_hop_tmp = fhss_structure->bs->own_hop;
+        uint8_t own_hop_tmp = fhss_structure->own_hop;
         if (fhss_is_synch_root(fhss_structure) == false) {
             // my own hop count is one more than the parent's
-            fhss_structure->bs->own_hop = payload->hop_count + 1;
+            fhss_structure->own_hop = payload->hop_count + 1;
         }
-        fhss_stats_update(fhss_structure, STATS_FHSS_HOP_COUNT, fhss_structure->bs->own_hop);
+        fhss_stats_update(fhss_structure, STATS_FHSS_HOP_COUNT, fhss_structure->own_hop);
         fhss_structure->bs->channel_list_counter = payload->channel_list_counter;
         fhss_structure->bs->current_channel_index = payload->channel_index;
         uint8_t mac_address[8];
@@ -427,7 +427,7 @@ static int fhss_sync_with_beacon(fhss_structure_t *fhss_structure,
             fhss_beacon_periodic_start(fhss_structure, fhss_structure->bs->synch_interval + beacon_interval_random);
         }
         // Our hop has changed, needs to inform possible children by sending Beacon
-        if ((own_hop_tmp != 0) && (own_hop_tmp != fhss_structure->bs->own_hop)) {
+        if ((own_hop_tmp != 0) && (own_hop_tmp != fhss_structure->own_hop)) {
             fhss_structure->bs->send_synch_info_on_next_broadcast_channel = true;
         }
         ret_val = 0;
@@ -458,7 +458,7 @@ static uint32_t fhss_get_remaining_tx_time(fhss_structure_t *fhss_structure)
         uint8_t tx_slot_up_limit = tx_slot_length;
         uint16_t superframe_length = fhss_structure->bs->synch_configuration.fhss_superframe_length;
 
-        if ((fhss_structure->bs->own_hop % 2)) {
+        if ((fhss_structure->own_hop % 2)) {
             tx_slot_up_limit += tx_slot_length;
         }
         while(number_of_tx_slots--)
@@ -645,7 +645,7 @@ static int fhss_reset(fhss_structure_t *fhss_structure)
     fhss_structure->bs->current_channel_index = 0;
     fhss_structure->bs->channel_list_counter = 0;
     if (fhss_is_synch_root(fhss_structure) == false) {
-        fhss_structure->bs->own_hop = 0xff;
+        fhss_structure->own_hop = 0xff;
     }
     fhss_structure->bs->tx_allowed = false;
     fhss_structure->bs->synch_interval = (uint32_t) (fhss_structure->bs->fhss_configuration.fhss_max_synch_interval/BEACON_INTERVAL_INIT_DIVIDER) * 1000;
@@ -1031,7 +1031,7 @@ static void fhss_update_channel_callback(fhss_structure_t *fhss_structure)
     // If channel is broadcast channel (true), send event
     if (fhss_change_to_next_channel(fhss_structure) == true) {
         // Only if device is border router
-        if (fhss_structure->bs->own_hop == 0) {
+        if (fhss_structure->own_hop == 0) {
             fhss_trig_event(fhss_structure, FHSS_BROADCAST_CHANNEL);
         }
     }
@@ -1068,7 +1068,7 @@ static void fhss_beacon_build(fhss_structure_t *fhss_structure, uint8_t* dest)
     // should be the case as the superframe length field is also in that range.
     temp_payload.remaining_slots = (uint16_t) fhss_get_remaining_time_to_next_superframe(fhss_structure);
     temp_payload.channel_list_counter = fhss_structure->bs->channel_list_counter;
-    temp_payload.hop_count = fhss_structure->bs->own_hop;
+    temp_payload.hop_count = fhss_structure->own_hop;
     temp_payload.number_of_broadcast_channels = config->fhss_number_of_bc_channels;
     temp_payload.number_of_tx_slots = config->fhss_number_of_tx_slots;
     temp_payload.time_since_last_beacon = 0; // XXX not available yet
@@ -1303,7 +1303,7 @@ int8_t fhss_set_synch_configuration(fhss_structure_t *fhss_structure, const fhss
         return -4;
     }
     fhss_structure->bs->synch_configuration = *fhss_synch_configuration;
-    fhss_structure->bs->own_hop = 0;
+    fhss_structure->own_hop = 0;
     return 0;
 }
 

source/Service_Libs/fhss/fhss.h

@@ -92,7 +92,6 @@ struct fhss_bs
     uint8_t uc_channel_index;
     uint8_t current_superframe;
     uint8_t current_channel_index;
-    uint8_t own_hop;
     uint8_t beacons_received_timer;
     uint8_t broadcast_start_superframe;
     uint8_t synch_infos_sent_counter;

source/Service_Libs/fhss/fhss_common.h

@@ -35,6 +35,7 @@ typedef NS_LIST_HEAD(fhss_failed_tx_t, link) fhss_failed_tx_list_t;
 
 struct fhss_structure
 {
+    uint8_t own_hop;
     uint8_t fhss_resolution_divider;
     uint8_t rx_channel;
     int8_t beacon_tasklet_id;

test/nanostack/unittest/service_libs/fhss/test_fhss.c

@@ -118,7 +118,7 @@ static void test_set_fhss_default_configs(void)
     FHSS.rx_channel = DEFAULT_CHANNEL;
     FHSS.fhss_state = FHSS_UNSYNCHRONIZED;
     FHSS.datarate = 250000;
-    FHSS.bs->own_hop = 2;
+    FHSS.own_hop = 2;
 }
 
 static fhss_api_t *test_generate_fhss_api(void)
@@ -454,15 +454,15 @@ bool test_fhss_synch_state_set_callback()
     // Test when device is synch root
     FHSS.fhss_state = FHSS_UNSYNCHRONIZED;
     FHSS.bs->synch_panid = 0xffff;
-    FHSS.bs->own_hop = 0;
+    FHSS.own_hop = 0;
     FHSS.fhss_api->synch_state_set(api, DEFAULT_FHSS_STATE, DEFAULT_PANID);
     if (FHSS.fhss_state != DEFAULT_FHSS_STATE) {
         return false;
     }
     // Test when synch info not found
     FHSS.fhss_state = FHSS_UNSYNCHRONIZED;
     FHSS.bs->synch_panid = 0xffff;
-    FHSS.bs->own_hop = 1;
+    FHSS.own_hop = 1;
     FHSS.fhss_api->synch_state_set(api, DEFAULT_FHSS_STATE, DEFAULT_PANID);
     if (FHSS.fhss_state != FHSS_UNSYNCHRONIZED) {
         return false;
@@ -524,7 +524,7 @@ bool test_fhss_superframe_handler()
     fhss_api_t *api = test_generate_fhss_api();
     // Set superframe handler callback
     enable_fhss_struct();
-    FHSS.bs->own_hop = 0;
+    FHSS.own_hop = 0;
     FHSS.fhss_api->synch_state_set(api, DEFAULT_FHSS_STATE, DEFAULT_PANID);
 
     // Test when FHSS struct not found
@@ -533,7 +533,7 @@ bool test_fhss_superframe_handler()
 
     // Test updating channel for node
     enable_fhss_struct();
-    FHSS.bs->own_hop = 1;
+    FHSS.own_hop = 1;
     FHSS.bs->synch_infos_sent_counter = 1;
     FHSS.bs->current_superframe = FHSS.bs->synch_configuration.fhss_number_of_superframes - 1;
     FHSS.bs->current_channel_index = FHSS.number_of_channels - 1;
@@ -544,7 +544,7 @@ bool test_fhss_superframe_handler()
     }
 
     // Test updating channel for synch root
-    FHSS.bs->own_hop = 0;
+    FHSS.own_hop = 0;
     FHSS.bs->tx_allowed = false;
     fhss_channel_stub.channel_bool_value = true;
     FHSS.bs->synch_infos_sent_counter = 1;
@@ -560,7 +560,7 @@ bool test_fhss_superframe_handler()
     fhss_channel_stub.channel_bool_value = true;
     fhss_callbacks_stub.uint8_value = 1;
     FHSS.bs->send_synch_info_on_next_broadcast_channel = true;
-    FHSS.bs->own_hop = 1;
+    FHSS.own_hop = 1;
     FHSS.bs->tx_allowed = false;
     FHSS.bs->synch_infos_sent_counter = 0;
     FHSS.bs->current_superframe = FHSS.bs->synch_configuration.fhss_number_of_superframes - 2;
@@ -689,13 +689,13 @@ bool test_fhss_set_synch_configuration()
         return false;
     }
     // Test success
-    FHSS.bs->own_hop = 0xff;
+    FHSS.own_hop = 0xff;
     FHSS.number_of_channels = 25;
     fhss_synch_configuration.fhss_number_of_bc_channels = 5;
     fhss_synch_configuration.fhss_number_of_superframes = 4;
     fhss_synch_configuration.fhss_number_of_tx_slots = 1;
     fhss_synch_configuration.fhss_superframe_length = 25000;
-    if ((fhss_set_synch_configuration(&FHSS, &fhss_synch_configuration) != 0) || memcmp(&fhss_synch_configuration, &FHSS.bs->synch_configuration, sizeof(fhss_synch_configuration_t)) || FHSS.bs->own_hop) {
+    if ((fhss_set_synch_configuration(&FHSS, &fhss_synch_configuration) != 0) || memcmp(&fhss_synch_configuration, &FHSS.bs->synch_configuration, sizeof(fhss_synch_configuration_t)) || FHSS.own_hop) {
         return false;
     }