WS neighbor class integrated to use new FHSS structures

Added new functions for store brodcast and unicast time info and
schedules

Refactor ws_utt_ie_t ws_bs_ie_t and ws_bt_ie_t parameters.

Integrated new functions to llc andbootstrap.

Change-Id: I814f8b21932386a683f1b00cfffcd0323656e525

Author: Juha Heiskanen

source/6LoWPAN/ws/ws_bootstrap.c

@@ -321,12 +321,8 @@ static void ws_bootstrap_pan_advertisement_analyse(struct protocol_interface_inf
         return;
     }
 
-    ws_neighbor->fhss_data.utt_timestamp = data->timestamp;
-    ws_neighbor->fhss_data.ufsi = ws_utt.ut;
-    ws_neighbor->fhss_data.channel_function = ws_us.channle_function;
-    ws_neighbor->fhss_data.unicast_dwell = ws_us.dwell_interval;
-
-
+    ws_neighbor_class_neighbor_unicast_time_info_update(ws_neighbor, &ws_utt, data->timestamp);
+    ws_neighbor_class_neighbor_unicast_schedule_set(ws_neighbor, &ws_us);
 
     // This parent is selected and used for authentication.
     if (memcmp(cur->ws_info->parent_info.addr, ADDR_UNSPECIFIED,8) != 0) {
@@ -338,7 +334,7 @@ static void ws_bootstrap_pan_advertisement_analyse(struct protocol_interface_inf
 
 
     // Parent valid store information
-    cur->ws_info->parent_info.ufsi = ws_utt.ut;
+    cur->ws_info->parent_info.ufsi = ws_utt.ufsi;
     // Saved from unicast IE
     cur->ws_info->parent_info.dwell_interval = ws_us.dwell_interval;
 
@@ -396,10 +392,8 @@ static void ws_bootstrap_pan_advertisement_solicit_analyse(struct protocol_inter
         return;
     }
 
-    ws_neighbor->fhss_data.utt_timestamp = data->timestamp;
-    ws_neighbor->fhss_data.ufsi = ws_utt.ut;
-    ws_neighbor->fhss_data.channel_function = ws_us.channle_function;
-    ws_neighbor->fhss_data.unicast_dwell = ws_us.dwell_interval;
+    ws_neighbor_class_neighbor_unicast_time_info_update(ws_neighbor, &ws_utt, data->timestamp);
+    ws_neighbor_class_neighbor_unicast_schedule_set(ws_neighbor, &ws_us);
 
     trickle_inconsistent_heard(&cur->ws_info->trickle_pan_advertisement,&trickle_params_pan_advertisement);
 }

source/6LoWPAN/ws/ws_common_defines.h

@@ -90,15 +90,15 @@ typedef struct ws_hopping_schedule_s {
  */
 typedef struct ws_utt_ie {
     uint8_t message_type;
-    uint_fast24_t ut;
+    uint_fast24_t ufsi;
 } ws_utt_ie_t;
 
 /**
  * @brief ws_bt_ie_t WS BT-IE read
  */
 typedef struct ws_bt_ie {
     uint16_t broadcast_slot_number;
-    uint_fast24_t bsi;
+    uint_fast24_t broadcast_interval_offset;
 } ws_bt_ie_t;
 
 
@@ -141,8 +141,8 @@ typedef struct ws_us_ie {
     uint8_t dwell_interval;
     uint8_t clock_drift;
     uint8_t timing_accurancy;
-    unsigned channle_plan:3;
-    unsigned channle_function:3;
+    unsigned channel_plan:3;
+    unsigned channel_function:3;
     unsigned excluded_channel_ctrl:2;
     union {
         ws_channel_plan_zero_t zero;
@@ -159,12 +159,12 @@ typedef struct ws_us_ie {
  */
 typedef struct ws_bs_ie {
     uint32_t broadcast_interval;
-    uint16_t bsi;
+    uint16_t broadcast_schedule_identifier;
     uint8_t dwell_interval;
     uint8_t clock_drift;
     uint8_t timing_accurancy;
-    unsigned channle_plan:3;
-    unsigned channle_function:3;
+    unsigned channel_plan:3;
+    unsigned channel_function:3;
     unsigned excluded_channel_ctrl:2;
     union {
         ws_channel_plan_zero_t zero;

source/6LoWPAN/ws/ws_ie_lib.c

@@ -255,7 +255,7 @@ bool ws_wh_utt_read(uint8_t *data, uint16_t length, struct ws_utt_ie *utt_ie)
     }
     data = utt_ie_data.content_ptr;
     utt_ie->message_type = *data++;
-    utt_ie->ut = common_read_24_bit_inverse(data + 1);
+    utt_ie->ufsi = common_read_24_bit_inverse(data + 1);
     return true;
 }
 
@@ -268,7 +268,7 @@ bool ws_wh_bt_read(uint8_t *data, uint16_t length, struct ws_bt_ie * bt_ie)
     }
     data = btt_ie_data.content_ptr;
     bt_ie->broadcast_slot_number = common_read_16_bit_inverse(data);
-    bt_ie->bsi = common_read_24_bit_inverse(data + 2);
+    bt_ie->broadcast_interval_offset = common_read_24_bit_inverse(data + 2);
     return true;
 }
 
@@ -314,19 +314,19 @@ bool ws_wp_nested_us_read(uint8_t *data, uint16_t length, struct ws_us_ie *us_ie
     us_ie->dwell_interval = *data++;
     us_ie->clock_drift = *data++;
     us_ie->timing_accurancy = *data++;
-    us_ie->channle_plan = (*data & 3);
-    us_ie->channle_function = (*data & 0x38) >> 3;
+    us_ie->channel_plan = (*data & 3);
+    us_ie->channel_function = (*data & 0x38) >> 3;
     us_ie->excluded_channel_ctrl = (*data & 0xc0) >> 6;
     data++;
     uint16_t info_length = 0;
     nested_payload_ie.length -= 4;
-    info_length = ws_channel_plan_length(us_ie->channle_plan);
+    info_length = ws_channel_plan_length(us_ie->channel_plan);
     if (nested_payload_ie.length < info_length) {
         return false;
     }
 
     nested_payload_ie.length -= info_length;
-    switch ( us_ie->channle_plan) {
+    switch ( us_ie->channel_plan) {
         case 0:
             data = ws_channel_plan_zero_read(data, &us_ie->plan.zero);
             break;
@@ -339,15 +339,15 @@ bool ws_wp_nested_us_read(uint8_t *data, uint16_t length, struct ws_us_ie *us_ie
 
     }
 
-    info_length = ws_channel_function_length(us_ie->channle_function, 0);
+    info_length = ws_channel_function_length(us_ie->channel_function, 0);
 
     if (nested_payload_ie.length < info_length) {
         return false;
     }
     nested_payload_ie.length -= info_length;
 
 
-    switch (us_ie->channle_function) {
+    switch (us_ie->channel_function) {
         case 0:
             data = ws_channel_function_zero_read(data, &us_ie->function.zero);
             break;
@@ -383,25 +383,25 @@ bool ws_wp_nested_bs_read(uint8_t *data, uint16_t length, struct ws_bs_ie *bs_ie
     }
     data = nested_payload_ie.content_ptr;
     bs_ie->broadcast_interval = common_read_32_bit_inverse(data);
-    bs_ie->bsi = common_read_16_bit_inverse(data + 4);
+    bs_ie->broadcast_schedule_identifier = common_read_16_bit_inverse(data + 4);
     data += 6;
     bs_ie->dwell_interval = *data++;
     bs_ie->clock_drift = *data++;
     bs_ie->timing_accurancy = *data++;
 
-    bs_ie->channle_plan = (*data & 3);
-    bs_ie->channle_function = (*data & 0x38) >> 3;
+    bs_ie->channel_plan = (*data & 3);
+    bs_ie->channel_function = (*data & 0x38) >> 3;
     bs_ie->excluded_channel_ctrl = (*data & 0xc0) >> 6;
     data++;
     nested_payload_ie.length -= 10;
     uint16_t info_length = 0;
 
-    info_length = ws_channel_plan_length(bs_ie->channle_plan);
+    info_length = ws_channel_plan_length(bs_ie->channel_plan);
     if (nested_payload_ie.length < info_length) {
         return false;
     }
     nested_payload_ie.length -= info_length;
-    switch ( bs_ie->channle_plan) {
+    switch ( bs_ie->channel_plan) {
         case 0:
             data = ws_channel_plan_zero_read(data, &bs_ie->plan.zero);
             break;
@@ -414,13 +414,13 @@ bool ws_wp_nested_bs_read(uint8_t *data, uint16_t length, struct ws_bs_ie *bs_ie
 
     }
 
-    info_length = ws_channel_function_length(bs_ie->channle_function,0);
+    info_length = ws_channel_function_length(bs_ie->channel_function,0);
     if (nested_payload_ie.length < info_length) {
         return false;
     }
     nested_payload_ie.length -= info_length;
 
-    switch (bs_ie->channle_function) {
+    switch (bs_ie->channel_function) {
         case 0:
             data = ws_channel_function_zero_read(data, &bs_ie->function.zero);
             break;

source/6LoWPAN/ws/ws_llc_data_service.c

@@ -409,33 +409,29 @@ static void ws_llc_mac_indication_cb(const mac_api_t* api, const mcps_data_ind_t
 
     protocol_interface_info_entry_t *interface = base->interface_ptr;
 
-    ws_neighbor_class_entry_t * ws_neighbor = NULL;
-    mac_neighbor_table_entry_t *neighbor = mac_neighbor_table_address_discover(interface->mac_parameters->mac_neighbor_table, data->SrcAddr, data->SrcAddrMode);
-    if (neighbor) {
-        ws_neighbor =  ws_neighbor_class_entry_get(&interface->ws_info->neighbor_storage, neighbor->index);
-    }
-
-    if (ws_neighbor) {
-        ws_neighbor->fhss_data.utt_timestamp = data->timestamp;
-        ws_neighbor->fhss_data.ufsi = ws_utt.ut;
-        //Update BT if it is part of message
-        ws_bt_ie_t ws_bt;
-        if (ws_wh_bt_read(ie_ext->headerIeList, ie_ext->headerIeListLength, &ws_bt)) {
-            ws_neighbor->fhss_data.bt_timestamp = data->timestamp;
-            ws_neighbor->fhss_data.broadcast_slot_number = ws_bt.broadcast_slot_number;
-            ws_neighbor->fhss_data.broadcast_interval = ws_bt.bsi;
-        }
+    //Discover 2 Payload Heder
+    if (ws_utt.message_type == WS_FT_DATA || ws_utt.message_type == WS_FT_EAPOL) {
 
-        //Refresh Neighbor if unicast
-        if (ws_utt.message_type == WS_FT_DATA && data->DstAddrMode && addr_check_broadcast(data->DstAddr, data->DstAddrMode)) {
-            tr_debug("Refresh neigh index %u", neighbor->index);
-            mac_neighbor_table_neighbor_refresh(interface->mac_parameters->mac_neighbor_table, neighbor, neighbor->link_lifetime);
+        ws_neighbor_class_entry_t * ws_neighbor = NULL;
+        mac_neighbor_table_entry_t *neighbor = mac_neighbor_table_address_discover(interface->mac_parameters->mac_neighbor_table, data->SrcAddr, data->SrcAddrMode);
+        if (neighbor) {
+            ws_neighbor =  ws_neighbor_class_entry_get(&interface->ws_info->neighbor_storage, neighbor->index);
         }
-    }
 
+        if (ws_neighbor) {
+            ws_neighbor_class_neighbor_unicast_time_info_update(ws_neighbor, &ws_utt, data->timestamp);
+            //Update BT if it is part of message
+            ws_bt_ie_t ws_bt;
+            if (ws_wh_bt_read(ie_ext->headerIeList, ie_ext->headerIeListLength, &ws_bt)) {
+                ws_neighbor_class_neighbor_broadcast_time_info_update(ws_neighbor, &ws_bt, data->timestamp);
+            }
 
-    //Discover 2 Payload Heder
-    if (ws_utt.message_type == WS_FT_DATA || ws_utt.message_type == WS_FT_EAPOL) {
+            //Refresh Neighbor if unicast
+            if (ws_utt.message_type == WS_FT_DATA && data->DstAddrMode && addr_check_broadcast(data->DstAddr, data->DstAddrMode)) {
+                tr_debug("Refresh neigh index %u", neighbor->index);
+                mac_neighbor_table_neighbor_refresh(interface->mac_parameters->mac_neighbor_table, neighbor, neighbor->link_lifetime);
+            }
+        }
 
         mac_payload_IE_t mpx_ie;
         mpx_ie.id = MAC_PAYLOAD_MPX_IE_GROUP_ID;
@@ -478,7 +474,7 @@ static void ws_llc_mac_indication_cb(const mac_api_t* api, const mcps_data_ind_t
         asynch_ie_list.headerIeListLength = ie_ext->headerIeListLength;
         asynch_ie_list.payloadIeList = ws_wp_nested.content_ptr;
         asynch_ie_list.payloadIeListLength = ws_wp_nested.length;
-        base->acynch_ind(base->interface_ptr,data, &asynch_ie_list, ws_utt.message_type);
+        base->acynch_ind(interface,data, &asynch_ie_list, ws_utt.message_type);
     }
 
 }

source/6LoWPAN/ws/ws_neighbor_class.c

@@ -66,3 +66,31 @@ void ws_neighbor_class_entry_remove(ws_neighbor_class_t *class_data, uint8_t att
         memset(entry, 0, sizeof(ws_neighbor_class_entry_t));
     }
 }
+
+void ws_neighbor_class_neighbor_unicast_time_info_update(ws_neighbor_class_entry_t *ws_neighbor, ws_utt_ie_t *ws_utt, uint32_t timestamp)
+{
+    ws_neighbor->fhss_data.uc_timing_info.utt_rx_timestamp = timestamp;
+    ws_neighbor->fhss_data.uc_timing_info.ufsi = ws_utt->ufsi;
+}
+
+void ws_neighbor_class_neighbor_unicast_schedule_set(ws_neighbor_class_entry_t *ws_neighbor, ws_us_ie_t *ws_us)
+{
+    ws_neighbor->fhss_data.uc_timing_info.unicast_channel_function = ws_us->channel_function;
+    ws_neighbor->fhss_data.uc_timing_info.unicast_dwell_interval = ws_us->dwell_interval;
+}
+
+
+void ws_neighbor_class_neighbor_broadcast_time_info_update(ws_neighbor_class_entry_t *ws_neighbor, ws_bt_ie_t *ws_bt_ie, uint32_t timestamp)
+{
+    ws_neighbor->fhss_data.bc_timing_info.bt_rx_timestamp = timestamp;
+    ws_neighbor->fhss_data.bc_timing_info.broadcast_slot = ws_bt_ie->broadcast_slot_number;
+    ws_neighbor->fhss_data.bc_timing_info.broadcast_interval_offset = ws_bt_ie->broadcast_interval_offset;
+}
+
+
+void ws_neighbor_class_neighbor_broadcast_schedule_set(ws_neighbor_class_entry_t *ws_neighbor, ws_bs_ie_t *ws_bs_ie)
+{
+    ws_neighbor->fhss_data.bc_timing_info.broadcast_dwell_interval = ws_bs_ie->dwell_interval;
+    ws_neighbor->fhss_data.bc_timing_info.broadcast_interval = ws_bs_ie->broadcast_interval;
+    ws_neighbor->fhss_data.bc_timing_info.broadcast_schedule_id = ws_bs_ie->broadcast_schedule_identifier;
+}

source/6LoWPAN/ws/ws_neighbor_class.h

@@ -18,25 +18,11 @@
 #ifndef WS_NEIGHBOR_CLASS_H_
 #define WS_NEIGHBOR_CLASS_H_
 
-/**
- * Neighbour Channel hopping information
- */
-typedef struct ws_fhss_s {
-    uint32_t        utt_timestamp;          /*!< Timestamp from MAC for Unicast time UTT-IE */
-    uint32_t        bt_timestamp;           /*!< Timestamp from MAC for Broadcast time BT-IE */
-    uint32_t        broadcast_interval;
-    uint32_t        ufsi;                   /*!< Unicast Fractional Sequence Interval 24-bit */
-    uint32_t        bti;                    /*!< Broadcast Interval_offset 24-bit */
-    uint16_t        broadcast_slot_number;  /*!< Broadcast Slot number */
-    uint16_t        bsi;                    /*!< Broadcast schedule identifier */
-    uint8_t         broadcast_dwell;
-    uint8_t         unicast_dwell;
-    unsigned        channel_function:3;
-} ws_fhss_t;
-
+#include "fhss_ws_extension.h"
+#include "6LoWPAN/ws/ws_common_defines.h"
 
 typedef struct ws_neighbor_class_entry_s {
-    ws_fhss_t   fhss_data;
+    fhss_ws_neighbor_timing_info_t   fhss_data;
 } ws_neighbor_class_entry_t;
 
 /**
@@ -87,4 +73,43 @@ ws_neighbor_class_entry_t * ws_neighbor_class_entry_get(ws_neighbor_class_t *cla
  */
 void ws_neighbor_class_entry_remove(ws_neighbor_class_t *class_data, uint8_t attribute_index);
 
+/**
+ * ws_neighbor_class_neighbor_unicast_time_info_update a function for update neighbor unicast time information
+ *
+ * \param ws_neighbor pointer to neighbor
+ * \param ws_utt Unicast time IE data
+ * \param timestamp timestamp for received data
+ *
+ */
+void ws_neighbor_class_neighbor_unicast_time_info_update(ws_neighbor_class_entry_t *ws_neighbor, ws_utt_ie_t *ws_utt, uint32_t timestamp);
+
+/**
+ * ws_neighbor_class_neighbor_unicast_schedule_set a function for update neighbor unicast shedule information
+ *
+ * \param ws_neighbor pointer to neighbor
+ * \param ws_us Unicast schedule IE data
+ *
+ */
+void ws_neighbor_class_neighbor_unicast_schedule_set(ws_neighbor_class_entry_t *ws_neighbor, ws_us_ie_t *ws_us);
+
+
+/**
+ * ws_neighbor_class_neighbor_broadcast_time_info_update a function for update neighbor broadcast time information
+ *
+ * \param ws_neighbor pointer to neighbor
+ * \param ws_bt_ie Broadcast time IE data
+ * \param timestamp timestamp for received data
+ *
+ */
+void ws_neighbor_class_neighbor_broadcast_time_info_update(ws_neighbor_class_entry_t *ws_neighbor, ws_bt_ie_t *ws_bt_ie, uint32_t timestamp);
+
+/**
+ * ws_neighbor_class_neighbor_broadcast_schedule_set a function for update neighbor broadcast shedule information
+ *
+ * \param ws_neighbor pointer to neighbor
+ * \param ws_bs_ie Broadcast schedule IE data
+ *
+ */
+void ws_neighbor_class_neighbor_broadcast_schedule_set(ws_neighbor_class_entry_t *ws_neighbor, ws_bs_ie_t *ws_bs_ie);
+
 #endif /* WS_NEIGHBOR_CLASS_H_ */

test/nanostack/unittest/stub/ws_neighbour_class_stub.c

@@ -62,3 +62,25 @@ void ws_neighbor_class_entry_remove(ws_neighbor_class_t *class_data, uint8_t att
 {
 
 }
+
+void ws_neighbor_class_neighbor_unicast_time_info_update(ws_neighbor_class_entry_t *ws_neighbor, ws_utt_ie_t *ws_utt, uint32_t timestamp)
+{
+
+}
+
+void ws_neighbor_class_neighbor_unicast_schedule_set(ws_neighbor_class_entry_t *ws_neighbor, ws_us_ie_t *ws_us)
+{
+
+}
+
+
+void ws_neighbor_class_neighbor_broadcast_time_info_update(ws_neighbor_class_entry_t *ws_neighbor, ws_bt_ie_t *ws_bt_ie, uint32_t timestamp)
+{
+
+}
+
+
+void ws_neighbor_class_neighbor_broadcast_schedule_set(ws_neighbor_class_entry_t *ws_neighbor, ws_bs_ie_t *ws_bs_ie)
+{
+
+}