Merge pull request ARMmbed#1602 from ARMmbed/IOTTHD-2311

Iotthd 2311

Author: Jarkko Paso

source/Service_Libs/fhss/channel_functions.c

@@ -42,7 +42,7 @@
 static uint32_t global_seed = 1;
 
 
-uint16_t tr51_calc_nearest_prime_number(uint16_t start_value)
+static uint16_t tr51_calc_nearest_prime_number(uint16_t start_value)
 {
     if (start_value < 2) {
         return 0;
@@ -60,22 +60,28 @@ uint16_t tr51_calc_nearest_prime_number(uint16_t start_value)
     return 0;
 }
 
-void tr51_seed_rand(uint32_t seed)
+static void tr51_seed_rand(uint32_t seed)
 {
     if (!seed) {
         seed = 1;
     }
     global_seed = seed;
 }
 
-int32_t tr51_get_rand(void)
+static int32_t tr51_get_rand(void)
 {
     uint32_t random_val = ((global_seed * 1103515245) + 12345) & 0x7fffffff;
     global_seed = random_val;
     return random_val;
 }
 
-void tr51_calculate_channel_table(uint16_t number_of_channels, uint16_t nearest_prime, int32_t *channel_table)
+/**
+ * @brief Calculate channel table based on TR51 channel function.
+ * @param number_of_channels Number of channels in table.
+ * @param nearest_prime Nearest prime number. Must be equal to or larger than number_of_channels.
+ * @param channel_table Output channel table. Has to be at least nearest_prime in length.
+ */
+static void tr51_calculate_channel_table(uint16_t number_of_channels, uint16_t nearest_prime, int32_t *channel_table)
 {
     int32_t i,j,k;
     tr51_seed_rand(1);
@@ -97,7 +103,7 @@ void tr51_calculate_channel_table(uint16_t number_of_channels, uint16_t nearest_
     }
 }
 
-void tr51_compute_cfd(uint8_t *mac, uint8_t *first_element, uint8_t *step_size, uint16_t channel_table_length)
+static void tr51_compute_cfd(uint8_t *mac, uint8_t *first_element, uint8_t *step_size, uint16_t channel_table_length)
 {
     *first_element = (mac[5] ^ mac[6] ^ mac[7]) % channel_table_length;
     *step_size = (mac[7] % (channel_table_length - 1)) + 1;
@@ -116,7 +122,18 @@ static uint8_t tr51_find_excluded(int32_t channel, uint16_t *excluded_channels,
     return 0;
 }
 
-uint16_t tr51_calculate_hopping_sequence(int32_t *channel_table, uint16_t channel_table_length, uint8_t first_element, uint8_t step_size, int32_t *output_table, uint16_t *excluded_channels, uint16_t number_of_excluded_channels)
+/**
+ * @brief Calculate hopping sequence for a specific peer using tr51 channel function.
+ * @param channel_table Used channel table.
+ * @param channel_table_length Length of the used channel table.
+ * @param first_element Start generated by CFD function.
+ * @param step_size Step size generated by CFD function.
+ * @param output_table Output hopping sequence table.
+ * @param excluded_channels List of not used channels.
+ * @param number_of_excluded_channels Number of not used channels.
+ * @return Number of channels in sequence.
+ */
+static uint16_t tr51_calculate_hopping_sequence(int32_t *channel_table, uint16_t channel_table_length, uint8_t first_element, uint8_t step_size, int32_t *output_table, uint16_t *excluded_channels, uint16_t number_of_excluded_channels)
 {
     uint16_t cntr = channel_table_length;
     uint8_t index = first_element;
@@ -179,7 +196,7 @@ int32_t dh1cf_get_bc_channel_index(uint16_t slot_number, uint16_t bsi, int16_t n
     return channel_number;
 }
 
-int32_t tr51_get_uc_channel_index(uint16_t slot_number, uint8_t *mac, int16_t number_of_channels)
+int32_t tr51_get_uc_channel_index(uint16_t slot_number, uint8_t *mac, int16_t number_of_channels, uint16_t *excluded_channels, uint16_t number_of_excluded_channels)
 {
     uint16_t nearest_prime = tr51_calc_nearest_prime_number(number_of_channels);
     int32_t channel_table[nearest_prime];
@@ -190,11 +207,11 @@ int32_t tr51_get_uc_channel_index(uint16_t slot_number, uint8_t *mac, int16_t nu
     tr51_compute_cfd(mac, &first_element, &step_size, nearest_prime);
 // Not sure yet which one is the correct second parameter
 //    tr51_calculate_hopping_sequence(channel_table, number_of_channels, first_element, step_size, output_table, NULL, 0);
-    tr51_calculate_hopping_sequence(channel_table, nearest_prime, first_element, step_size, output_table, NULL, 0);
+    tr51_calculate_hopping_sequence(channel_table, nearest_prime, first_element, step_size, output_table, excluded_channels, number_of_excluded_channels);
     return output_table[slot_number];
 }
 
-int32_t tr51_get_bc_channel_index(uint16_t slot_number, uint16_t bsi, int16_t number_of_channels)
+int32_t tr51_get_bc_channel_index(uint16_t slot_number, uint16_t bsi, int16_t number_of_channels, uint16_t *excluded_channels, uint16_t number_of_excluded_channels)
 {
     uint16_t nearest_prime = tr51_calc_nearest_prime_number(number_of_channels);
     int32_t channel_table[nearest_prime];
@@ -206,6 +223,6 @@ int32_t tr51_get_bc_channel_index(uint16_t slot_number, uint16_t bsi, int16_t nu
     tr51_compute_cfd(mac, &first_element, &step_size, nearest_prime);
 // Not sure yet which one is the correct second parameter
 //    tr51_calculate_hopping_sequence(channel_table, number_of_channels, first_element, step_size, output_table, NULL, 0);
-    tr51_calculate_hopping_sequence(channel_table, nearest_prime, first_element, step_size, output_table, NULL, 0);
+    tr51_calculate_hopping_sequence(channel_table, nearest_prime, first_element, step_size, output_table, excluded_channels, number_of_excluded_channels);
     return output_table[slot_number];
 }

source/Service_Libs/fhss/channel_functions.h

@@ -16,44 +16,28 @@
  */
 #ifndef CHANNEL_FUNC_H_
 #define CHANNEL_FUNC_H_
-/**
- * @brief Calculate channel table based on TR51 channel function.
- * @param number_of_channels Number of channels in table.
- * @param nearest_prime Nearest prime number. Must be equal to or larger than number_of_channels.
- * @param channel_table Output channel table. Has to be at least nearest_prime in length.
- */
-void tr51_calculate_channel_table(uint16_t number_of_channels, uint16_t nearest_prime, int32_t *channel_table);
-
-/**
- * @brief Calculate hopping sequence for a specific peer using tr51 channel function.
- * @param channel_table Used channel table.
- * @param channel_table_length Length of the used channel table.
- * @param first_element Start generated by CFD function.
- * @param step_size Step size generated by CFD function.
- * @param output_table Output hopping sequence table.
- * @param excluded_channels List of not used channels.
- * @param number_of_excluded_channels Number of not used channels.
- * @return Number of channels in sequence.
- */
-uint16_t tr51_calculate_hopping_sequence(int32_t *channel_table, uint16_t channel_table_length, uint8_t first_element, uint8_t step_size, int32_t *output_table, uint16_t *excluded_channels, uint16_t number_of_excluded_channels);
 
 /**
  * @brief Compute the unicast schedule channel index using tr51 channel function.
  * @param slot_number Current slot number.
  * @param mac MAC address of the node for which the index is calculated.
  * @param number_of_channels Number of channels.
+ * @param excluded_channels Excluded channels.
+ * @param number_of_excluded_channels Number of excluded channels.
  * @return Channel index.
  */
-int32_t tr51_get_uc_channel_index(uint16_t slot_number, uint8_t *mac, int16_t number_of_channels);
+int32_t tr51_get_uc_channel_index(uint16_t slot_number, uint8_t *mac, int16_t number_of_channels, uint16_t *excluded_channels, uint16_t number_of_excluded_channels);
 
 /**
  * @brief Compute the broadcast schedule channel index using tr51 channel function.
  * @param slot_number Current slot number.
  * @param bsi Broadcast schedule identifier of the node for which the index is calculated.
  * @param number_of_channels Number of channels.
+ * @param excluded_channels Excluded channels.
+ * @param number_of_excluded_channels Number of excluded channels.
  * @return Channel index.
  */
-int32_t tr51_get_bc_channel_index(uint16_t slot_number, uint16_t bsi, int16_t number_of_channels);
+int32_t tr51_get_bc_channel_index(uint16_t slot_number, uint16_t bsi, int16_t number_of_channels, uint16_t *excluded_channels, uint16_t number_of_excluded_channels);
 
 /**
  * @brief Compute the unicast schedule channel index using direct hash channel function.

source/Service_Libs/fhss/fhss_ws.c

@@ -82,7 +82,7 @@ static int32_t fhss_ws_calc_bc_channel(fhss_structure_t *fhss_structure)
     if (fhss_structure->ws->fhss_configuration.ws_channel_function == WS_FIXED_CHANNEL) {
 
     } else if (fhss_structure->ws->fhss_configuration.ws_channel_function == WS_TR51CF) {
-        next_channel = tr51_get_bc_channel_index(fhss_structure->ws->bc_slot, fhss_structure->ws->fhss_configuration.bsi, fhss_structure->number_of_channels);
+        next_channel = tr51_get_bc_channel_index(fhss_structure->ws->bc_slot, fhss_structure->ws->fhss_configuration.bsi, fhss_structure->number_of_channels, NULL, 0);
         if (++fhss_structure->ws->bc_slot == fhss_structure->number_of_channels) {
             fhss_structure->ws->bc_slot = 0;
         }
@@ -204,7 +204,7 @@ static void fhss_ws_update_uc_channel_callback(fhss_structure_t *fhss_structure)
     if (fhss_structure->ws->fhss_configuration.ws_channel_function == WS_FIXED_CHANNEL) {
         return;
     } else if (fhss_structure->ws->fhss_configuration.ws_channel_function == WS_TR51CF) {
-        next_channel = fhss_structure->rx_channel = tr51_get_uc_channel_index(fhss_structure->ws->uc_slot, mac_address, fhss_structure->number_of_channels);
+        next_channel = fhss_structure->rx_channel = tr51_get_uc_channel_index(fhss_structure->ws->uc_slot, mac_address, fhss_structure->number_of_channels, NULL, 0);
         if (++fhss_structure->ws->uc_slot == fhss_structure->number_of_channels) {
             fhss_structure->ws->uc_slot = 0;
         }
@@ -245,7 +245,7 @@ static int fhss_ws_tx_handle_callback(const fhss_api_t *api, bool is_broadcast_a
         //TODO: Get destination UFSI, timestamp and dwell time from neighbour table
         uint16_t destination_slot = fhss_ws_calculate_destination_slot(fhss_structure, 0, 0, fhss_structure->ws->fhss_configuration.fhss_uc_dwell_interval, tx_time);
         if (fhss_structure->ws->fhss_configuration.ws_channel_function == WS_TR51CF) {
-            tx_channel = tr51_get_uc_channel_index(destination_slot, destination_address, fhss_structure->number_of_channels);
+            tx_channel = tr51_get_uc_channel_index(destination_slot, destination_address, fhss_structure->number_of_channels, NULL, 0);
         } else if(fhss_structure->ws->fhss_configuration.ws_channel_function == WS_DH1CF) {
             tx_channel = dh1cf_get_uc_channel_index(destination_slot, destination_address, fhss_structure->number_of_channels);
         } else if (fhss_structure->ws->fhss_configuration.ws_channel_function == WS_VENDOR_DEF_CF) {

test/nanostack/unittest/service_libs/channel_functions/channelfunctest.cpp

@@ -29,26 +29,6 @@ TEST_GROUP(channel_functions)
     }
 };
 
-TEST(channel_functions, test_tr51_get_rand)
-{
-    CHECK(test_tr51_get_rand());
-}
-
-TEST(channel_functions, test_tr51_calculate_channel_table)
-{
-    CHECK(test_tr51_calculate_channel_table());
-}
-
-TEST(channel_functions, test_tr51_compute_cfd)
-{
-    CHECK(test_tr51_compute_cfd());
-}
-
-TEST(channel_functions, test_tr51_calculate_hopping_sequence)
-{
-    CHECK(test_tr51_calculate_hopping_sequence());
-}
-
 TEST(channel_functions, test_dh1cf_get_uc_channel_index)
 {
     CHECK(test_dh1cf_get_uc_channel_index());
@@ -59,12 +39,12 @@ TEST(channel_functions, test_dh1cf_get_bc_channel_index)
     CHECK(test_dh1cf_get_bc_channel_index());
 }
 
-TEST(channel_functions, test_tr51_calc_nearest_prime_number)
+TEST(channel_functions, test_tr51_get_uc_channel_index)
 {
-    CHECK(test_tr51_calc_nearest_prime_number());
+    CHECK(test_tr51_get_uc_channel_index());
 }
 
-TEST(channel_functions, test_tr51_get_uc_channel_index)
+TEST(channel_functions, test_tr51_get_bc_channel_index)
 {
-    CHECK(test_tr51_get_uc_channel_index());
+    CHECK(test_tr51_get_bc_channel_index());
 }