Process advertisement solicit and process response (ARMmbed#1592)

Filter network names and save timing information for parent

Author: Mika Tervonen

source/6LoWPAN/ws/ws_bootstrap.c

@@ -22,12 +22,14 @@
 #include "net_interface.h"
 #include "eventOS_event.h"
 #include "randLIB.h"
+#include "common_functions.h"
 #include "NWK_INTERFACE/Include/protocol.h"
 #include "6LoWPAN/Bootstraps/protocol_6lowpan.h"
 #include "6LoWPAN/Bootstraps/protocol_6lowpan_interface.h"
 #include "6LoWPAN/MAC/mac_helper.h"
 #include "6LoWPAN/MAC/mac_data_poll.h"
 #include "6LoWPAN/MAC/mpx_api.h"
+#include "6LoWPAN/MAC/mac_ie_lib.h"
 #include "6LoWPAN/ws/ws_common_defines.h"
 #include "6LoWPAN/ws/ws_common.h"
 #include "6LoWPAN/ws/ws_bootstrap.h"
@@ -216,6 +218,96 @@ void ws_bootstrap_configuration_reset(protocol_interface_info_entry_t *cur)
     return;
 }
 
+static bool ws_bootstrap_network_name_matches(const struct mcps_data_ie_list *ie_ext, const char *network_name_ptr)
+{
+    mac_nested_payload_IE_t nested_payload_ie;
+    nested_payload_ie.id = WP_PAYLOAD_IE_NETNAME_TYPE;
+    nested_payload_ie.type_long = true;
+
+    if (!network_name_ptr || !ie_ext ){
+        return false;
+    }
+
+    if (0 == mac_ie_nested_discover(ie_ext->payloadIeList , ie_ext->payloadIeListLength, &nested_payload_ie)) {
+        tr_warn("No network name IE");
+        return false;
+    }
+
+    if (network_name_ptr == NULL || strncmp(network_name_ptr, (char *)nested_payload_ie.content_ptr, nested_payload_ie.length) != 0) {
+        return false;
+    }
+    return true;
+}
+
+static bool ws_bootstrap_unicast_schedule_read(uint8_t *ptr, uint16_t length, ws_hoopping_schedule_t *uc_hopping)
+{
+    mac_nested_payload_IE_t nested_payload_ie;
+    nested_payload_ie.id = WP_PAYLOAD_IE_US_TYPE;
+    nested_payload_ie.type_long = true;
+
+    if (0 == mac_ie_nested_discover(ptr , length, &nested_payload_ie)) {
+        tr_warn("No unicast schedule");
+        return false;
+    }
+    if (nested_payload_ie.length < 4) {
+        tr_warn("corrupetd schedule");
+        return false;
+    }
+    if (!uc_hopping) {
+        // all OK no data read
+        return true;
+    }
+    uc_hopping->fhss_uc_dwell_interval = nested_payload_ie.content_ptr[0];
+    uc_hopping->clock_drift = nested_payload_ie.content_ptr[1];
+    uc_hopping->timing_accurancy = nested_payload_ie.content_ptr[2];
+    uc_hopping->channel_plan = (nested_payload_ie.content_ptr[3] & 0x03);
+    uc_hopping->channel_function = (nested_payload_ie.content_ptr[3] & 0x38) >> 3;
+
+    // TODO missing rest of the fields
+
+    return true;
+}
+
+static bool ws_bootstrap_pan_information_read(uint8_t *ptr, uint16_t length, ws_pan_information_t *pan_information)
+{
+    mac_nested_payload_IE_t nested_payload_ie;
+    nested_payload_ie.id = WP_PAYLOAD_IE_PAN_TYPE;
+    nested_payload_ie.type_long = true;
+
+    if (0 == mac_ie_nested_discover(ptr , length, &nested_payload_ie)) {
+        tr_warn("No PAN information");
+        return false;
+    }
+    if (nested_payload_ie.length < 5) {
+        tr_warn("corrupetd PAN information");
+        return false;
+    }
+    if (pan_information) {
+        pan_information->pan_size = common_read_16_bit_inverse(nested_payload_ie.content_ptr);
+        pan_information->routing_cost = common_read_16_bit_inverse(nested_payload_ie.content_ptr + 2);
+        pan_information->use_parent_bs = (nested_payload_ie.content_ptr[4] & 0x10) == 0x10;
+        pan_information->rpl_routing_method = (nested_payload_ie.content_ptr[4] & 0x20) == 0x20;
+        pan_information->version = (nested_payload_ie.content_ptr[4]& 0xe0) >> 5;
+    }
+
+    return true;
+}
+
+static bool ws_bootstrap_ufsi_read(uint8_t *ptr, uint16_t length, uint_fast24_t *ufsi)
+{
+    mac_header_IE_t utt_ie;
+    utt_ie.id = MAC_HEADER_ASSIGNED_EXTERNAL_ORG_IE_ID;
+
+    if (4 != mac_ie_header_sub_id_discover(ptr, length, &utt_ie, WH_IE_UTT_TYPE)) {
+        // NO UTT header
+        return false;
+    }
+    if (ufsi) {
+        *ufsi = common_read_24_bit_inverse(&utt_ie.content_ptr[1]);
+    }
+    return true;
+}
+
 static void ws_bootstrap_pan_advertisement_analyse(struct protocol_interface_info_entry *cur, const struct mcps_data_ind_s *data, const struct mcps_data_ie_list *ie_ext)
 {
 
@@ -230,16 +322,57 @@ static void ws_bootstrap_pan_advertisement_analyse(struct protocol_interface_inf
         // Not from long address
         return;
     }
-    //TODO Match network name
+    if (!ws_bootstrap_network_name_matches(ie_ext, cur->ws_info->network_name)) {
+        // Not in our network
+        return;
+    }
 
     // This parent is selected and used for authentication.
     if (memcmp(cur->ws_info->parent_info.addr, ADDR_UNSPECIFIED,8) != 0) {
         //Decide which is better parent for authentication
-        if(cur->ws_info->parent_info.signal_dbm > data->signal_dbm) {
+        if(cur->ws_info->parent_info.link_quality > data->mpduLinkQuality) {
             return;
         }
     }
-    // TODO save unicast timing info
+
+    ws_pan_information_t pan_information;
+    ws_hoopping_schedule_t hopping_schedule = { 0 };
+    uint_fast24_t ufsi;
+
+    if (!ws_bootstrap_ufsi_read(ie_ext->headerIeList, ie_ext->headerIeListLength, &ufsi)) {
+        // Corrupted
+        tr_error("No ufsi");
+        return;
+    }
+    if (!ws_bootstrap_pan_information_read(ie_ext->payloadIeList, ie_ext->payloadIeListLength, &pan_information)) {
+        // Corrupted
+        tr_error("No pan information");
+        return;
+    }
+
+    // TODO create own function to read just dwell time
+    if (!ws_bootstrap_unicast_schedule_read(ie_ext->payloadIeList, ie_ext->payloadIeListLength, &hopping_schedule)) {
+        // Corrupted
+        tr_error("No unicast schedule");
+        return;
+    }
+    // Check pan flags so that it is valid
+    if (!pan_information.rpl_routing_method) {
+        // NOT RPL routing
+        tr_warn("Not supported routing");
+        return;
+    }
+
+    // Parent valid store information
+    cur->ws_info->parent_info.ufsi = ufsi;
+    // Saved from unicast IE
+    cur->ws_info->parent_info.dwell_interval = hopping_schedule.fhss_uc_dwell_interval;
+
+    // Saved from Pan information
+    cur->ws_info->parent_info.pan_configuration = pan_information;
+
+    // Saved from message
+    cur->ws_info->parent_info.timestamp = data->timestamp;
     cur->ws_info->parent_info.pan_id = data->SrcPANId;
     cur->ws_info->parent_info.link_quality = data->mpduLinkQuality;
     cur->ws_info->parent_info.signal_dbm = data->signal_dbm;
@@ -252,16 +385,16 @@ static void ws_bootstrap_pan_advertisement_solicit_analyse(struct protocol_inter
 {
 
     (void)data;
-    (void)ie_ext;
     if(!ws_bootstrap_state_active(cur)) {
+        // We are not active yet
+        return;
+    }
+    if (!ws_bootstrap_network_name_matches(ie_ext, cur->ws_info->network_name)) {
+        // Not in our network
+        tr_debug("Network name not matching");
         return;
     }
-    //TODO Match network name
-    //TODO message is valid
-
     trickle_inconsistent_heard(&cur->ws_info->trickle_pan_advertisement,&trickle_params_pan_advertisement);
-
-
 }
 
 static bool ws_bootstrap_network_found(protocol_interface_info_entry_t *cur)
@@ -415,6 +548,36 @@ static void ws_bootstrap_fhss_activate(protocol_interface_info_entry_t *cur)
     return;
 }
 
+static void ws_bootstrap_network_information_learn(protocol_interface_info_entry_t *cur)
+{
+    tr_debug("learn network information from parent");
+
+    // Start following network timing schedules
+    cur->ws_info->hopping_schdule.fhss_uc_dwell_interval = cur->ws_info->parent_info.dwell_interval;
+    // Regulatory domain saving? cant change?
+
+    // Save network information
+    cur->ws_info->network_pan_id = cur->ws_info->parent_info.pan_id;
+    cur->ws_info->pan_configuration = cur->ws_info->parent_info.pan_configuration;
+    cur->ws_info->pan_configuration.pan_version = 0; // This is learned from actual configuration
+
+    // TODO create parent neighbour table entry for unicast schedule to enable authentication
+
+    return;
+}
+static void ws_bootstrap_network_configuration_learn(protocol_interface_info_entry_t *cur)
+{
+    tr_debug("learn network information from parent");
+
+    // Save network information
+    cur->ws_info->pan_configuration = cur->ws_info->parent_info.pan_configuration;
+
+    // Timing information can be modified here
+    ws_llc_set_pan_information_pointer(cur, &cur->ws_info->pan_configuration);
+
+    return;
+}
+
 static void ws_bootstrap_ip_stack_activate(protocol_interface_info_entry_t *cur)
 {
     tr_debug("ip stack init");
@@ -447,12 +610,18 @@ static void ws_bootstrap_rpl_activate(protocol_interface_info_entry_t *cur)
         rpl_control_transmit_dis(cur->rpl_domain, cur, 0, 0, NULL, 0, ADDR_LINK_LOCAL_ALL_ROUTERS);
     }
 }
+
 static void ws_bootstrap_network_start(protocol_interface_info_entry_t *cur)
 {
     //Set Network names, Pan information configure, hopping schedule & GTKHash
     ws_llc_set_network_name(cur, (uint8_t*)cur->ws_info->network_name, strlen(cur->ws_info->network_name));
     ws_llc_set_pan_information_pointer(cur, &cur->ws_info->pan_configuration);
+}
 
+static void ws_bootstrap_network_discovery_configure(protocol_interface_info_entry_t *cur)
+{
+    //Set Network names, Pan information configure, hopping schedule & GTKHash
+    ws_llc_set_network_name(cur, (uint8_t*)cur->ws_info->network_name, strlen(cur->ws_info->network_name));
 }
 
 
@@ -595,16 +764,26 @@ 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");
             cur->ws_info->network_pan_id = randLIB_get_random_in_range(0,0xfffd);
+            cur->ws_info->pan_configuration.pan_size = 3;
+            cur->ws_info->pan_configuration.pan_version = randLIB_get_random_in_range(0,0xffff);
+            cur->ws_info->pan_configuration.routing_cost = 0;
+            cur->ws_info->pan_configuration.rpl_routing_method = true;
+            cur->ws_info->pan_configuration.use_parent_bs = true;
+            cur->ws_info->pan_configuration.version = WS_FAN_VERSION_1_0;
             ws_bootstrap_fhss_activate(cur);
             ws_bootstrap_event_operation_start(cur);
             break;
         }
+        // Configure LLC for network discovery
+        ws_bootstrap_network_discovery_configure(cur);
         ws_bootstrap_fhss_activate(cur);
         // Start network scan
         ws_bootstrap_start_discovery(cur);
         break;
     case WS_CONFIGURATION_START:
         tr_info("Configuration start");
+        // TODO temporary learn from parent
+        ws_bootstrap_network_configuration_learn(cur);
         ws_bootstrap_event_authentication_start(cur);
         break;
     case WS_AUTHENTICATION_START:
@@ -643,7 +822,7 @@ void ws_bootstrap_network_scan_process(protocol_interface_info_entry_t *cur)
     cur->nwk_nd_re_scan_count++;
     if (ws_bootstrap_network_found(cur)) {
         tr_info("select network");
-        cur->ws_info->network_pan_id = cur->ws_info->parent_info.pan_id;
+        ws_bootstrap_network_information_learn(cur);
         ws_bootstrap_fhss_activate(cur);
         ws_bootstrap_event_authentication_start(cur);
         return;
@@ -716,7 +895,7 @@ void ws_bootstrap_seconds_timer(protocol_interface_info_entry_t *cur, uint32_t s
     if(trickle_timer(&cur->ws_info->trickle_pan_config, &trickle_params_pan_configuration, seconds)) {
         // send PAN Configuration
         tr_info("Send PAN configuration");
-        ws_bootstrap_pan_config(cur);
+//        ws_bootstrap_pan_config(cur);
     }
 }
 

source/6LoWPAN/ws/ws_common.h

@@ -25,10 +25,14 @@
 struct ws_pan_information_s;
 
 typedef struct parent_info_s {
-        uint16_t pan_id;          /**< PAN ID */
-        uint8_t addr[8];         /**< address */
-        uint8_t link_quality;    /**< LQI value measured during reception of the MPDU */
+        uint16_t pan_id;            /**< PAN ID */
+        uint8_t addr[8];            /**< address */
+        uint8_t link_quality;       /**< LQI value measured during reception of the MPDU */
         int8_t signal_dbm;          /**< This extension for normal IEEE 802.15.4 Data indication */
+        ws_pan_information_t pan_configuration;
+        uint8_t dwell_interval;        /**< unicast dwell time */
+        uint_fast24_t ufsi;            /**< unicast_fractional_sequence_interval */
+        uint32_t timestamp;            /**< Timestamp when packet was received */
 }parent_info_t;
 
 typedef struct ws_info_s {

source/6LoWPAN/ws/ws_ie_lib.c

@@ -197,12 +197,12 @@ uint8_t *ws_wp_nested_pan_info_write(uint8_t *ptr, struct ws_pan_information_s *
         return mac_ie_nested_ie_long_base_write(ptr,WP_PAYLOAD_IE_PAN_TYPE, 0);
     }
     ptr = mac_ie_nested_ie_long_base_write(ptr,WP_PAYLOAD_IE_PAN_TYPE, 5);
-    ptr = common_write_16_bit(pan_congiguration->pan_size, ptr);
-    ptr = common_write_16_bit(pan_congiguration->routing_cost, ptr);
+    ptr = common_write_16_bit_inverse(pan_congiguration->pan_size, ptr);
+    ptr = common_write_16_bit_inverse(pan_congiguration->routing_cost, ptr);
     uint8_t temp8 = 0;
-    temp8 |= (pan_congiguration->use_parent_bs << 7);
-    temp8 |= (pan_congiguration->rpl_routing_method << 6);
-    temp8 |= pan_congiguration->version;
+    temp8 |= (pan_congiguration->use_parent_bs << 0);
+    temp8 |= (pan_congiguration->rpl_routing_method << 1);
+    temp8 |= pan_congiguration->version << 5;
     *ptr++ = temp8;
     return ptr;
 }