Merge pull request ARMmbed#2041 from ARMmbed/iotthd-3309

EAPOL parent synch update

Author: Juha Heiskanen

source/6LoWPAN/ws/ws_bootstrap.c

@@ -92,6 +92,12 @@ static void ws_bootstrap_pan_version_increment(protocol_interface_info_entry_t *
 static ws_nud_table_entry_t *ws_nud_entry_discover(protocol_interface_info_entry_t *cur, void *neighbor);
 static void ws_nud_entry_remove(protocol_interface_info_entry_t *cur, mac_neighbor_table_entry_t *entry_ptr);
 
+typedef enum {
+    WS_PARENT_SOFT_SYNCH = 0,  /**< let FHSS make decision if synchronization is needed*/
+    WS_PARENT_HARD_SYNCH,      /**< Synch FHSS with latest synch information*/
+    WS_EAPOL_PARENT_SYNCH,  /**< Broadcast synch with EAPOL parent*/
+} ws_parent_synch_e;
+
 mac_neighbor_table_entry_t *ws_bootstrap_mac_neighbor_add(struct protocol_interface_info_entry *interface, const uint8_t *src64)
 
 {
@@ -470,8 +476,6 @@ static int8_t ws_fhss_discovery_configure(protocol_interface_info_entry_t *cur)
     fhss_configuration.fhss_broadcast_interval = 0;
     uint8_t tmp_uc_fixed_channel = ws_randomize_fixed_channel(cur->ws_info->fhss_uc_fixed_channel, cur->ws_info->hopping_schdule.number_of_channels);
     uint8_t tmp_bc_fixed_channel = ws_randomize_fixed_channel(cur->ws_info->fhss_bc_fixed_channel, cur->ws_info->hopping_schdule.number_of_channels);
-    memset(fhss_configuration.channel_mask, 0, sizeof(uint32_t) * 8);
-    channel_list_set_channel(fhss_configuration.channel_mask, tmp_uc_fixed_channel, true);
     fhss_configuration.unicast_fixed_channel = tmp_uc_fixed_channel;
     fhss_configuration.broadcast_fixed_channel = tmp_bc_fixed_channel;
     ns_fhss_ws_configuration_set(cur->ws_info->fhss_api, &fhss_configuration);
@@ -503,7 +507,7 @@ static int8_t ws_fhss_enable(protocol_interface_info_entry_t *cur)
 /* Sets the parent and broadcast schedule we are following
  *
  */
-static void ws_bootstrap_primary_parent_set(struct protocol_interface_info_entry *cur, llc_neighbour_req_t *neighbor_info, bool force_synch)
+static void ws_bootstrap_primary_parent_set(struct protocol_interface_info_entry *cur, llc_neighbour_req_t *neighbor_info, ws_parent_synch_e synch_req)
 {
 
     fhss_ws_configuration_t fhss_configuration;
@@ -516,7 +520,9 @@ static void ws_bootstrap_primary_parent_set(struct protocol_interface_info_entry
 
     // Learning broadcast network configuration
     if (neighbor_info->ws_neighbor->broadcast_shedule_info_stored) {
-        ws_fhss_set_defaults(cur, &fhss_configuration);
+        if (synch_req == WS_EAPOL_PARENT_SYNCH) {
+            ws_fhss_set_defaults(cur, &fhss_configuration);
+        }
         fhss_configuration.ws_bc_channel_function = (fhss_ws_channel_functions)neighbor_info->ws_neighbor->fhss_data.bc_timing_info.broadcast_channel_function;
         if (fhss_configuration.ws_bc_channel_function == WS_FIXED_CHANNEL) {
             cur->ws_info->hopping_schdule.bc_fixed_channel = neighbor_info->ws_neighbor->fhss_data.bc_timing_info.fixed_channel;
@@ -532,12 +538,28 @@ static void ws_bootstrap_primary_parent_set(struct protocol_interface_info_entry
     ns_fhss_ws_configuration_set(cur->ws_info->fhss_api, &fhss_configuration);
 
     // We have broadcast schedule set up set the broadcast parent schedule
-    ns_fhss_ws_set_parent(cur->ws_info->fhss_api, neighbor_info->neighbor->mac64, &neighbor_info->ws_neighbor->fhss_data.bc_timing_info, force_synch);
+    ns_fhss_ws_set_parent(cur->ws_info->fhss_api, neighbor_info->neighbor->mac64, &neighbor_info->ws_neighbor->fhss_data.bc_timing_info, synch_req != WS_PARENT_SOFT_SYNCH);
 
     // Update LLC to follow updated fhss settings
     ws_bootstrap_llc_hopping_update(cur, &fhss_configuration);
 }
 
+void ws_bootstrap_eapol_parent_synch(struct protocol_interface_info_entry *cur, llc_neighbour_req_t *neighbor_info, ws_bs_ie_t *ws_bs_ie)
+{
+    if (neighbor_info->ws_neighbor->broadcast_shedule_info_stored || cur->ws_info->configuration_learned) {
+        return;
+    }
+
+    if (memcmp(neighbor_info->neighbor->mac64, cur->ws_info->parent_info.addr, 8)) {
+        return;
+    }
+
+    //Store Brodacst Shedule
+    ws_neighbor_class_neighbor_broadcast_schedule_set(neighbor_info->ws_neighbor, ws_bs_ie);
+
+    ws_bootstrap_primary_parent_set(cur, neighbor_info, WS_EAPOL_PARENT_SYNCH);
+}
+
 static void ws_bootstrap_ll_address_validate(struct protocol_interface_info_entry *cur)
 {
     // Configure EUI64 for MAC if missing
@@ -1042,7 +1064,13 @@ static void ws_bootstrap_pan_config_analyse(struct protocol_interface_info_entry
         if (neighbor_info.neighbor->link_role == PRIORITY_PARENT_NEIGHBOUR) {
             // RPL priority parent configuration we must update FHSS data
             //Update synch to primary parent allways to update broadcast shedule and timing
-            ws_bootstrap_primary_parent_set(cur, &neighbor_info, !old_version);
+            ws_parent_synch_e synreq;
+            if (old_version) {
+                synreq = WS_PARENT_SOFT_SYNCH;
+            } else {
+                synreq = WS_PARENT_HARD_SYNCH;
+            }
+            ws_bootstrap_primary_parent_set(cur, &neighbor_info, synreq);
         }
 
         if (old_version) {
@@ -1070,7 +1098,7 @@ static void ws_bootstrap_pan_config_analyse(struct protocol_interface_info_entry
         // return to state machine after 1-2 s
         cur->bootsrap_state_machine_cnt = randLIB_get_random_in_range(10, 20);
         // enable frequency hopping for unicast channel and start listening first neighbour
-        ws_bootstrap_primary_parent_set(cur, &neighbor_info, true);
+        ws_bootstrap_primary_parent_set(cur, &neighbor_info, WS_PARENT_HARD_SYNCH);
         // set neighbor as priority parent clear if there is others
         protocol_6lowpan_neighbor_priority_clear_all(cur->id, PRIORITY_1ST);
         neighbor_info.neighbor->link_role = PRIORITY_PARENT_NEIGHBOUR;
@@ -2543,7 +2571,7 @@ void ws_primary_parent_update(protocol_interface_info_entry_t *interface, mac_ne
         llc_neighbour_req_t neighbor_info;
         neighbor_info.neighbor = neighbor;
         neighbor_info.ws_neighbor = ws_neighbor_class_entry_get(&interface->ws_info->neighbor_storage, neighbor->index);
-        ws_bootstrap_primary_parent_set(interface, &neighbor_info, true);
+        ws_bootstrap_primary_parent_set(interface, &neighbor_info, WS_PARENT_HARD_SYNCH);
 
         ws_secondary_parent_update(interface);
     }

source/6LoWPAN/ws/ws_bootstrap.h

@@ -31,6 +31,9 @@ typedef enum {
 
 #ifdef HAVE_WS
 
+struct llc_neighbour_req;
+struct ws_bs_ie;
+
 int ws_bootstrap_init(int8_t interface_id, net_6lowpan_mode_e bootstrap_mode);
 
 void ws_bootstrap_state_machine(protocol_interface_info_entry_t *cur);
@@ -72,6 +75,8 @@ void ws_dhcp_client_address_delete(protocol_interface_info_entry_t *cur, uint8_t
 
 bool ws_eapol_relay_state_active(protocol_interface_info_entry_t *cur);
 
+void ws_bootstrap_eapol_parent_synch(struct protocol_interface_info_entry *cur, struct llc_neighbour_req *neighbor_info, struct ws_bs_ie *ws_bs_ie);
+
 #else
 
 #define ws_bootstrap_init(interface_id, bootstrap_mode) (-1)

source/6LoWPAN/ws/ws_llc_data_service.c

@@ -513,9 +513,12 @@ static void ws_llc_mac_indication_cb(const mac_api_t *api, const mcps_data_ind_t
         mac_payload_IE_t ws_wp_nested;
         ws_us_ie_t us_ie;
         bool us_ie_inline = false;
+        bool bs_ie_inline = false;
         ws_wp_nested.id = WS_WP_NESTED_IE;
+        ws_bs_ie_t ws_bs_ie;
         if (mac_ie_payload_discover(ie_ext->payloadIeList, ie_ext->payloadIeListLength, &ws_wp_nested) > 2) {
             us_ie_inline = ws_wp_nested_us_read(ws_wp_nested.content_ptr, ws_wp_nested.length, &us_ie);
+            bs_ie_inline = ws_wp_nested_bs_read(ws_wp_nested.content_ptr, ws_wp_nested.length, &ws_bs_ie);
         }
 
         llc_neighbour_req_t neighbor_info;
@@ -545,6 +548,9 @@ static void ws_llc_mac_indication_cb(const mac_api_t *api, const mcps_data_ind_t
             if (neighbor_info.neighbor->link_role == PRIORITY_PARENT_NEIGHBOUR) {
                 // We have broadcast schedule set up set the broadcast parent schedule
                 ns_fhss_ws_set_parent(interface->ws_info->fhss_api, neighbor_info.neighbor->mac64, &neighbor_info.ws_neighbor->fhss_data.bc_timing_info, false);
+            } else if (ws_utt.message_type == WS_FT_EAPOL && bs_ie_inline) {
+                //Synch Broadcast Only 1 time when configuration is not learned
+                ws_bootstrap_eapol_parent_synch(interface, &neighbor_info, &ws_bs_ie);
             }
         }
 
@@ -681,6 +687,8 @@ static void ws_llc_mpx_data_request(const mpx_api_t *api, const struct mcps_data
     } else if (user_id == MPX_KEY_MANAGEMENT_ENC_USER_ID) {
         ie_header_mask.ea_ie = ws_eapol_handshake_first_msg(data->msdu, data->msduLength, base->interface_ptr);
         ie_header_mask.bt_ie = ie_header_mask.ea_ie;
+        nested_wp_id.bs_ie = ie_header_mask.ea_ie;
+
     }
 
     nested_wp_id.us_ie = true;
@@ -764,6 +772,11 @@ static void ws_llc_mpx_data_request(const mpx_api_t *api, const struct mcps_data
         ptr = ws_wp_base_write(ptr, nested_ie_length);
         //Write unicast schedule
         ptr = ws_wp_nested_hopping_schedule_write(ptr, base->ie_params.hopping_schedule, true);
+
+        if (nested_wp_id.bs_ie) {
+            //Write Broadcastcast schedule
+            ptr = ws_wp_nested_hopping_schedule_write(ptr, base->ie_params.hopping_schedule, false);
+        }
     }
 
 

test/nanostack/unittest/stub/ws_bootstrap_stub.c

@@ -15,15 +15,59 @@
  * limitations under the License.
  */
 
+#include <string.h>
 #include "nsconfig.h"
 #include "ns_types.h"
 #include "ns_trace.h"
 #include "net_interface.h"
 #include "eventOS_event.h"
+#include "randLIB.h"
+#include "common_functions.h"
+#include "mac_common_defines.h"
+#include "sw_mac.h"
+#include "ccmLIB.h"
 #include "NWK_INTERFACE/Include/protocol.h"
+#include "6LoWPAN/Bootstraps/protocol_6lowpan.h"
 #include "6LoWPAN/Bootstraps/protocol_6lowpan_interface.h"
+#include "ipv6_stack/protocol_ipv6.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 "MPL/mpl.h"
+#include "RPL/rpl_protocol.h"
+#include "RPL/rpl_control.h"
+#include "RPL/rpl_data.h"
+#include "Common_Protocols/icmpv6.h"
+#include "Common_Protocols/icmpv6_radv.h"
+#include "Common_Protocols/ipv6_constants.h"
+#include "Service_Libs/Trickle/trickle.h"
+#include "Service_Libs/fhss/channel_list.h"
+#include "6LoWPAN/ws/ws_common_defines.h"
+#include "6LoWPAN/ws/ws_common_defines.h"
+#include "6LoWPAN/ws/ws_config.h"
 #include "6LoWPAN/ws/ws_common.h"
 #include "6LoWPAN/ws/ws_bootstrap.h"
+#include "6LoWPAN/ws/ws_bbr_api_internal.h"
+#include "6LoWPAN/ws/ws_common_defines.h"
+#include "6LoWPAN/ws/ws_llc.h"
+#include "6LoWPAN/ws/ws_neighbor_class.h"
+#include "6LoWPAN/ws/ws_ie_lib.h"
+#include "6LoWPAN/lowpan_adaptation_interface.h"
+#include "Service_Libs/etx/etx.h"
+#include "Service_Libs/mac_neighbor_table/mac_neighbor_table.h"
+#include "Service_Libs/nd_proxy/nd_proxy.h"
+#include "Service_Libs/blacklist/blacklist.h"
+#include "platform/topo_trace.h"
+#include "libDHCPv6/libDHCPv6.h"
+#include "DHCPv6_client/dhcpv6_client_api.h"
+#include "ws_management_api.h"
+#include "net_rpl.h"
+#include "mac_api.h"
+#include "6LoWPAN/ws/ws_pae_controller.h"
+#include "6LoWPAN/ws/ws_eapol_pdu.h"
+#include "6LoWPAN/ws/ws_eapol_auth_relay.h"
+#include "6LoWPAN/ws/ws_eapol_relay.h"
 
 #include "mac_api.h"
 
@@ -71,3 +115,8 @@ bool ws_eapol_relay_state_active(protocol_interface_info_entry_t *cur)
 {
     return false;
 }
+
+void ws_bootstrap_eapol_parent_synch(struct protocol_interface_info_entry *cur, llc_neighbour_req_t *neighbor_info, ws_bs_ie_t *ws_bs_ie)
+{
+
+}