Merge pull request ARMmbed#1613 from ARMmbed/IOTTHD-2320

Iotthd 2320

Author: Jarkko Paso

nanostack/fhss_config.h

@@ -28,6 +28,8 @@
 extern "C" {
 #endif
 
+#include "fhss_ws_extension.h"
+
 /**
  * @brief WS channel functions.
  */
@@ -89,6 +91,14 @@ typedef struct fhss_configuration
  */
 typedef int32_t fhss_vendor_defined_cf(const fhss_api_t *api, uint16_t slot, uint8_t eui64[8], uint16_t bsi, uint16_t number_of_channels);
 
+/**
+ * @brief Get neighbor timing/hopping schedule.
+ * @param api FHSS instance.
+ * @param eui64 EUI-64 address of node for which the info is requested.
+ * @return Neighbor timing/hopping schedule.
+ */
+typedef fhss_ws_neighbor_timing_info_t *fhss_get_neighbor_info(const fhss_api_t *api, uint8_t eui64[8]);
+
 /**
  * \brief Struct fhss_ws_configuration defines configuration of WS FHSS.
  */
@@ -115,6 +125,9 @@ typedef struct fhss_ws_configuration
     /** Vendor defined channel function. */
     fhss_vendor_defined_cf *vendor_defined_cf;
 
+    /** Get neighbor timing/hopping schedule. */
+    fhss_get_neighbor_info *get_neighbor_info;
+
 } fhss_ws_configuration_t;
 
 /**

nanostack/fhss_ws_extension.h

@@ -23,6 +23,8 @@
 #ifndef FHSS_WS_EXT_H
 #define FHSS_WS_EXT_H
 
+#include "ns_types.h"
+#include "fhss_api.h"
 
 #ifdef __cplusplus
 extern "C" {
@@ -61,6 +63,22 @@ typedef struct fhss_ws_neighbor_timing_info {
     broadcast_timing_info_t bc_timing_info;     /**< Neighbor broadcast timing info */
 } fhss_ws_neighbor_timing_info_t;
 
+/**
+ * @brief Set parent which broadcast channels must be listened by FHSS.
+ * @param fhss_api FHSS instance.
+ * @param eui64 EUI-64 address of parent.
+ * @param bc_timing_info Pointer to parent broadcast timing/hopping schedule info.
+ * @return 0 on success, -1 on fail.
+ */
+extern int ns_fhss_ws_set_parent(const fhss_api_t *fhss_api, const uint8_t eui64[8], const broadcast_timing_info_t *bc_timing_info);
+
+/**
+ * @brief Remove parent which was set by ns_fhss_ws_set_parent function.
+ * @param fhss_api FHSS instance.
+ * @param eui64 EUI-64 address of parent.
+ * @return 0 on success, -1 on fail.
+ */
+extern int ns_fhss_ws_remove_parent(const fhss_api_t *fhss_api, const uint8_t eui64[8]);
 
 #ifdef __cplusplus
 }

source/Service_Libs/fhss/fhss_configuration_interface.c

@@ -62,6 +62,24 @@ fhss_api_t *ns_fhss_ws_create(const fhss_ws_configuration_t *fhss_configuration,
     return this;
 }
 
+int ns_fhss_ws_set_parent(const fhss_api_t *fhss_api, const uint8_t eui64[8], const broadcast_timing_info_t *bc_timing_info)
+{
+    fhss_structure_t *fhss_structure = fhss_get_object_with_api(fhss_api);
+    if (!fhss_structure || !eui64 || !bc_timing_info) {
+        return -1;
+    }
+    return fhss_ws_set_parent(fhss_structure, eui64, bc_timing_info);
+}
+
+int ns_fhss_ws_remove_parent(const fhss_api_t *fhss_api, const uint8_t eui64[8])
+{
+    fhss_structure_t *fhss_structure = fhss_get_object_with_api(fhss_api);
+    if (!fhss_structure || !eui64) {
+        return -1;
+    }
+    return fhss_ws_remove_parent(fhss_structure, eui64);
+}
+
 int ns_fhss_delete(fhss_api_t *fhss_api)
 {
     fhss_structure_t *fhss_structure = fhss_get_object_with_api(fhss_api);

source/Service_Libs/fhss/fhss_ws.c

@@ -158,8 +158,11 @@ static uint32_t fhss_ws_calculate_ufsi(fhss_structure_t *fhss_structure, uint32_
     return own_floor((float)(ms_since_seq_start * DEF_2E24) / (seq_length*dwell_time));
 }
 
-static uint16_t fhss_ws_calculate_destination_slot(fhss_structure_t *fhss_structure, uint32_t ufsi, uint32_t ufsi_timestamp, uint8_t dwell_time, uint32_t tx_time)
+static uint16_t fhss_ws_calculate_destination_slot(fhss_structure_t *fhss_structure, fhss_ws_neighbor_timing_info_t *neighbor_timing_info, uint32_t tx_time)
 {
+    uint_fast24_t ufsi = neighbor_timing_info->uc_timing_info.ufsi;
+    uint32_t ufsi_timestamp = neighbor_timing_info->uc_timing_info.utt_rx_timestamp;
+    uint8_t dwell_time = neighbor_timing_info->uc_timing_info.unicast_dwell_interval;
     uint32_t seq_length = 0x10000;
     if (fhss_structure->ws->fhss_configuration.ws_channel_function  == WS_TR51CF) {
         seq_length = fhss_structure->number_of_channels;
@@ -241,9 +244,12 @@ static int fhss_ws_tx_handle_callback(const fhss_api_t *api, bool is_broadcast_a
         return 0;
     }
     if (fhss_structure->fhss_state == FHSS_SYNCHRONIZED) {
+        fhss_ws_neighbor_timing_info_t *neighbor_timing_info = fhss_structure->ws->fhss_configuration.get_neighbor_info(api, destination_address);
+        if (!neighbor_timing_info) {
+            return -1;
+        }
+        uint16_t destination_slot = fhss_ws_calculate_destination_slot(fhss_structure, neighbor_timing_info, tx_time);
         int32_t tx_channel;
-        //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, NULL, 0);
         } else if(fhss_structure->ws->fhss_configuration.ws_channel_function == WS_DH1CF) {
@@ -383,3 +389,24 @@ int fhss_ws_set_callbacks(fhss_structure_t *fhss_structure)
     fhss_structure->fhss_api->init_callbacks = &fhss_init_callbacks_cb;
     return 0;
 }
+
+int fhss_ws_set_parent(fhss_structure_t *fhss_structure, const uint8_t eui64[8], const broadcast_timing_info_t *bc_timing_info)
+{
+    (void) eui64;
+    if (!fhss_structure->ws) {
+        return -1;
+    }
+    //TODO: support multiple parents
+    fhss_structure->ws->parent_bc_info = bc_timing_info;
+    return 0;
+}
+
+int fhss_ws_remove_parent(fhss_structure_t *fhss_structure, const uint8_t eui64[8])
+{
+    (void) eui64;
+    if (!fhss_structure->ws) {
+        return -1;
+    }
+    fhss_structure->ws->parent_bc_info = NULL;
+    return 0;
+}

source/Service_Libs/fhss/fhss_ws.h

@@ -24,9 +24,12 @@ struct fhss_ws
     uint16_t bc_slot;
     bool is_on_bc_channel;
     struct fhss_ws_configuration fhss_configuration;
+    const struct broadcast_timing_info *parent_bc_info;
 };
 
 fhss_structure_t *fhss_ws_enable(fhss_api_t *fhss_api, const fhss_ws_configuration_t *fhss_configuration, const fhss_timer_t *fhss_timer);
 int fhss_ws_set_callbacks(fhss_structure_t *fhss_structure);
+int fhss_ws_set_parent(fhss_structure_t *fhss_structure, const uint8_t eui64[8], const broadcast_timing_info_t *bc_timing_info);
+int fhss_ws_remove_parent(fhss_structure_t *fhss_structure, const uint8_t eui64[8]);
 
 #endif /*FHSS_WS_H_*/

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

@@ -47,12 +47,18 @@
 
 static fhss_api_t fhss_api;
 static fhss_ws_t ws;
+static fhss_ws_neighbor_timing_info_t neighbor_info;
 
 static int32_t app_channel_function(const fhss_api_t *api, uint16_t slot, uint8_t eui64[8], uint16_t bsi, uint16_t number_of_channels)
 {
     return VENDOR_CHANNEL;
 }
 
+static fhss_ws_neighbor_timing_info_t *app_get_neighbor_info(const fhss_api_t *api, uint8_t eui64[8])
+{
+    return &neighbor_info;
+}
+
 static void disable_fhss_struct(void)
 {
     // With this setting, FHSS structure cannot be found
@@ -84,6 +90,7 @@ static fhss_api_t *test_generate_fhss_api(void)
     fhss_common_stub.fhss_struct.ws->fhss_configuration.fhss_uc_dwell_interval = 200;
     fhss_common_stub.fhss_struct.ws->fhss_configuration.fhss_bc_dwell_interval = 250;
     fhss_common_stub.fhss_struct.ws->fhss_configuration.fhss_broadcast_interval = 1000;
+    fhss_common_stub.fhss_struct.ws->fhss_configuration.get_neighbor_info = &app_get_neighbor_info;
     fhss_common_stub.fhss_struct.number_of_channels = 50;
     fhss_common_stub.fhss_struct.rx_channel = DEFAULT_CHANNEL;
     fhss_common_stub.fhss_struct.fhss_state = FHSS_UNSYNCHRONIZED;

test/nanostack/unittest/stub/fhss_ws_stub.c

@@ -37,3 +37,13 @@ fhss_structure_t *fhss_ws_enable(fhss_api_t *fhss_api, const fhss_ws_configurati
     }
     return &fhss_ws_stub.fhss_struct;
 }
+
+int fhss_ws_set_parent(fhss_structure_t *fhss_structure, uint8_t eui64[8], broadcast_timing_info_t *bc_timing_info)
+{
+    return 0;
+}
+
+int fhss_ws_remove_parent(fhss_structure_t *fhss_structure, const uint8_t eui64[8])
+{
+    return 0;
+}