separated BBR to own file (ARMmbed#1567)

fixed dodagID
added seconds timer support

Author: Mika Tervonen

source/6LoWPAN/ws/ws_bbr_api.c

@@ -0,0 +1,143 @@
+/*
+ * Copyright (c) 2018, Arm Limited and affiliates.
+ * SPDX-License-Identifier: Apache-2.0
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * 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 "NWK_INTERFACE/Include/protocol.h"
+#include "6LoWPAN/Bootstraps/protocol_6lowpan.h"
+#include "6LoWPAN/Bootstraps/protocol_6lowpan_interface.h"
+#include "6LoWPAN/ws/ws_config.h"
+#include "6LoWPAN/ws/ws_common.h"
+#include "RPL/rpl_control.h"
+#include "RPL/rpl_data.h"
+#include "Common_Protocols/icmpv6.h"
+#include "Common_Protocols/icmpv6_radv.h"
+#include "net_rpl.h"
+
+#include "6LoWPAN/ws/ws_bbr_api_internal.h"
+
+#define TRACE_GROUP "wsbs"
+
+#ifdef HAVE_WS
+
+static void ws_bbr_rpl_root_activate(uint8_t *dodag_prefix, uint8_t *dodag_id)
+{
+    tr_debug("RPL root Activate");
+    rpl_dodag_conf_t new_conf;
+
+    // Lifetime values
+    new_conf.default_lifetime = 120;
+    new_conf.lifetime_unit = 60;
+    new_conf.objective_code_point = 1;
+    new_conf.authentication = 0;
+    new_conf.path_control_size = 0;
+
+
+    // TODO temporary values spec says 0
+    new_conf.dag_max_rank_increase = 3072;
+    new_conf.min_hop_rank_increase = 128;// 24 Hop networks 3072/128 == 24
+
+
+    // DIO configuration
+    new_conf.dio_interval_min = WS_RPL_DIO_IMIN;
+    new_conf.dio_interval_doublings = WS_RPL_DIO_DOUBLING;
+    new_conf.dio_redundancy_constant = WS_RPL_DIO_REDUDANCY;
+
+    rpl_data_init_root();
+    protocol_6lowpan_rpl_root_dodag = rpl_control_create_dodag_root(protocol_6lowpan_rpl_domain, 1, dodag_id, &new_conf, new_conf.min_hop_rank_increase, RPL_GROUNDED | RPL_MODE_NON_STORING | RPL_DODAG_PREF(0));
+    if (!protocol_6lowpan_rpl_root_dodag) {
+        tr_err("RPL dodag init failed");
+    }
+    uint8_t t_flags = PIO_A;
+
+    rpl_control_update_dodag_prefix(protocol_6lowpan_rpl_root_dodag, dodag_prefix, 64, t_flags, 0xffffffff, 0xffffffff, false);
+    rpl_control_update_dodag_route(protocol_6lowpan_rpl_root_dodag, dodag_prefix, 64, 0, 0xffffffff, false);
+    rpl_control_update_dodag_route(protocol_6lowpan_rpl_root_dodag, NULL, 0, 0, 0xffffffff, false);
+}
+
+static uint8_t static_dodag_prefix[8] = {0xfd,0x00,0x61, 0x72, 0x6d};
+
+static void ws_bbr_root_start(protocol_interface_info_entry_t *cur)
+{
+    uint8_t *bbr_prefix_ptr = NULL;
+    uint8_t *bbr_dodag_id_ptr = NULL;
+
+   /*if (arm_net_address_get(this->backbone_interface_id, ADDR_IPV6_GP, global_address) == 0) {
+       bbr_prefix_ptr = global_address;
+   }*/
+
+   if (!bbr_prefix_ptr) {
+       // Start static ula prefix
+       if_address_entry_t *add_entry = icmpv6_slaac_address_add(cur, static_dodag_prefix, 64, 0xffffffff, 0xffffffff, true, SLAAC_IID_FIXED);
+       if (!add_entry) {
+           return;
+       }
+       bbr_dodag_id_ptr = add_entry->address;
+       bbr_prefix_ptr = add_entry->address;
+   }
+
+   if (!bbr_prefix_ptr || !bbr_dodag_id_ptr) {
+       return;
+   }
+   ws_bbr_rpl_root_activate(bbr_prefix_ptr, bbr_dodag_id_ptr);
+}
+
+void ws_bbr_seconds_timer(protocol_interface_info_entry_t *cur, uint32_t seconds)
+{
+    (void)seconds;
+
+    if (!ws_info(cur)) {
+        return;
+    }
+   if (cur->bootsrap_mode != ARM_NWK_BOOTSRAP_MODE_6LoWPAN_BORDER_ROUTER) {
+       // Not a border router
+       return;
+   }
+   if (!cur->rpl_domain) {
+       // RPL not started
+       return;
+   }
+
+   if (protocol_6lowpan_rpl_root_dodag) {
+       // RPL configured
+       return;
+   }
+   // 1. Wait for backend connection
+   // 2. request own prefix if available
+   // 3. check if connected to RPL root
+   // 3.1 check if Globally connected root available (Backend with own mesh prefix)
+   // 3.2 check if Globally connected root available (ND proxy)
+   // 3.3 Check if grounded root available (Backend connectivity to static config in backend)
+   // 3.4 only local connectivity (No backend)
+   // 4. If I can provide better connectivity start root
+   // 4.1. If no other roots or backend start static root
+   // 4.2. If backend gets connectivity add global root
+   // 4.3. If backend loses connectivity remove global root, leave static
+   // 5. if someone has offered better connected root remove own
+   // 6. if multiple same level roots
+   // 6.1 lower connectivity must drop
+   // 6.2 lowest dodag ID remains
+
+   ws_bbr_root_start(cur);
+}
+
+
+#endif //HAVE_WS

source/6LoWPAN/ws/ws_bbr_api_internal.h

@@ -0,0 +1,32 @@
+/*
+ * Copyright (c) 2018, Arm Limited and affiliates.
+ * SPDX-License-Identifier: Apache-2.0
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+#ifndef WS_BBR_API_PRIVATE_H_
+#define WS_BBR_API_PRIVATE_H_
+
+
+#ifdef HAVE_WS
+
+void ws_bbr_seconds_timer(protocol_interface_info_entry_t *cur, uint32_t seconds);
+
+#else
+
+#define ws_bbr_seconds_timer( cur, seconds)
+
+#endif //HAVE_WS
+
+#endif /* WS_BBR_API_PRIVATE_H_ */

source/6LoWPAN/ws/ws_bootstrap.c

@@ -246,38 +246,8 @@ static void ws_bootstrap_rpl_callback(rpl_event_t event, void *handle)
     }
     tr_warn("RPL callback event %d", event);
 }
-static uint8_t dodag_id[16] = {1,2,3,4,5,6,7,8,9,10,11,12,13,14,15};
-static uint8_t dodag_prefix[16] = {0xfd,00,0xaa};
 
-static void ws_bootstrap_rpl_root_activate(protocol_interface_info_entry_t *cur)
-{
-    tr_debug("RPL root Activate");
-    rpl_dodag_conf_t new_conf;
-    new_conf.default_lifetime = 64;
-    new_conf.lifetime_unit = 60;
-    new_conf.dag_max_rank_increase = 3072;
-    new_conf.min_hop_rank_increase = 128;// 24 HOP?
-    new_conf.dio_interval_min = 9;
-    new_conf.dio_interval_doublings = 12;
-    new_conf.dio_redundancy_constant = 10;
-    new_conf.objective_code_point = 1;
-    new_conf.authentication = 0;
-    new_conf.path_control_size = 0;
-    rpl_data_init_root();
-    protocol_6lowpan_rpl_root_dodag = rpl_control_create_dodag_root(protocol_6lowpan_rpl_domain, 1, dodag_id, &new_conf, new_conf.min_hop_rank_increase, RPL_GROUNDED | RPL_MODE_NON_STORING | RPL_DODAG_PREF(0));
-    if (!protocol_6lowpan_rpl_root_dodag) {
-        tr_err("RPL dodag init failed");
-    }
-    uint8_t t_flags = PIO_A;
-
-    icmpv6_slaac_address_add(cur, dodag_prefix, 64, 0xffffffff, 0xffffffff, true, SLAAC_IID_FIXED);
-
-    rpl_control_update_dodag_prefix(protocol_6lowpan_rpl_root_dodag, dodag_prefix, 64, t_flags, 0xffffffff, 0xffffffff, false);
-    rpl_control_update_dodag_route(protocol_6lowpan_rpl_root_dodag, dodag_prefix, 64, 0, 0xffffffff, false);
-    rpl_control_update_dodag_route(protocol_6lowpan_rpl_root_dodag, NULL, 0, 0, 0xffffffff, false);
-}
-
-    static void ws_bootstrap_rpl_activate(protocol_interface_info_entry_t *cur)
+static void ws_bootstrap_rpl_activate(protocol_interface_info_entry_t *cur)
 {
     tr_debug("RPL Activate");
     bool downstream = true;
@@ -291,19 +261,7 @@ static void ws_bootstrap_rpl_root_activate(protocol_interface_info_entry_t *cur)
 
     if (cur->bootsrap_mode == ARM_NWK_BOOTSRAP_MODE_6LoWPAN_ROUTER) {
         rpl_control_transmit_dis(cur->rpl_domain, cur, 0, 0, NULL, 0, ADDR_LINK_LOCAL_ALL_ROUTERS);
-    } else if (cur->bootsrap_mode == ARM_NWK_BOOTSRAP_MODE_6LoWPAN_BORDER_ROUTER) {
-        ws_bootstrap_rpl_root_activate(cur);
     }
-
-}
-
-
-static void ws_bootstrap_icmp_rs_msg_tx(protocol_interface_info_entry_t *cur)
-{
-    tr_debug("send RS");
-    buffer_t *buf = icmpv6_build_rs(cur, NULL);
-
-    protocol_push(buf);
 }
 
 /*

source/6LoWPAN/ws/ws_common.c

@@ -21,6 +21,7 @@
 #include <nsdynmemLIB.h>
 #include "NWK_INTERFACE/Include/protocol.h"
 #include "6LoWPAN/ws/ws_common.h"
+#include "6LoWPAN/ws/ws_bbr_api_internal.h"
 #include "ws_management_api.h"
 
 #ifdef HAVE_WS
@@ -134,6 +135,10 @@ int8_t ws_common_allocate_and_init(protocol_interface_info_entry_t *cur)
     return 0;
 }
 
+void ws_common_seconds_timer(protocol_interface_info_entry_t *cur, uint32_t seconds)
+{
+    ws_bbr_seconds_timer(cur, seconds);
+}
 
 
 #endif // HAVE_WS

source/6LoWPAN/ws/ws_common.h

@@ -23,6 +23,7 @@
 
 typedef struct ws_info_s {
     char network_name[33]; // Network name max 32 octets + terminating 0.
+    uint16_t network_pan_id;
 
     struct fhss_timer *fhss_timer_ptr; // Platform adaptation for FHSS timers.
     uint8_t fhss_uc_dwell_interval;
@@ -47,10 +48,13 @@ int8_t ws_common_regulatory_domain_config(protocol_interface_info_entry_t *cur);
 
 int8_t ws_common_allocate_and_init(protocol_interface_info_entry_t *cur);
 
+void ws_common_seconds_timer(protocol_interface_info_entry_t *cur, uint32_t seconds);
+
 #define ws_info(cur) ((cur)->ws_info)
 #else
 
 #define ws_info(cur) ((ws_info_t *) NULL)
+#define ws_common_seconds_timer(cur, seconds)
 
 
 #endif //HAVE_WS

source/6LoWPAN/ws/ws_config.h

@@ -0,0 +1,33 @@
+/*
+ * Copyright (c) 2018, Arm Limited and affiliates.
+ * SPDX-License-Identifier: Apache-2.0
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+#ifndef WS_CONFIG_H_
+#define WS_CONFIG_H_
+
+
+/*RPL parameters for DIO messages
+ *
+ * Small scale values imin 15, doubling 2, redudancy 1
+ * Large scale network imin 19, doubling 1, redudancy 1
+ *
+ */
+
+#define WS_RPL_DIO_IMIN 15
+#define WS_RPL_DIO_DOUBLING 2
+#define WS_RPL_DIO_REDUDANCY 1
+
+#endif /* WS_CONFIG_H_ */

source/NWK_INTERFACE/protocol_core.c

@@ -244,6 +244,8 @@ void core_timer_event_handle(uint16_t ticksUpdate)
                 if (cur->lowpan_info & INTERFACE_NWK_ACTIVE) {
                     if (thread_info(cur)) {
                         thread_seconds_timer(cur, seconds);
+                    } else if (ws_info(cur)) {
+                        ws_common_seconds_timer(cur, seconds);
                     } else if (cur->lowpan_info & INTERFACE_NWK_ROUTER_DEVICE) {
                         beacon_join_priority_update(cur->id);
                     }

sources.mk

@@ -24,6 +24,7 @@ SRCS += \
 	source/6LoWPAN/ws/ws_bootstrap.c \
 	source/6LoWPAN/ws/ws_common.c \
 	source/6LoWPAN/ws/ws_management_api.c \
+	source/6LoWPAN/ws/ws_bbr_api.c \
 	source/BorderRouter/border_router.c \
 	source/Common_Protocols/icmpv6.c \
 	source/Common_Protocols/icmpv6_prefix.c \

test/nanostack/unittest/nwk_interface/protocol_core/Makefile

@@ -36,6 +36,7 @@ TEST_SRC_FILES = \
         ../../stub/thread_common_stub.c \
         ../../stub/thread_bootstrap_stub.c \
         ../../stub/ws_bootstrap_stub.c \
+        ../../stub/ws_common_stub.c \
         ../../stub/mld_stub.c \
         ../../stub/mpl_stub.c \
         ../../stub/rpl_control_stub.c \

test/nanostack/unittest/stub/ws_common_stub.c

@@ -0,0 +1,35 @@
+/*
+ * Copyright (c) 2018, Arm Limited and affiliates.
+ * SPDX-License-Identifier: Apache-2.0
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+#include "nsconfig.h"
+#include "ns_types.h"
+#include "ns_trace.h"
+#include "net_interface.h"
+#include "eventOS_event.h"
+#include "NWK_INTERFACE/Include/protocol.h"
+#include "6LoWPAN/Bootstraps/protocol_6lowpan_interface.h"
+#include "6LoWPAN/ws/ws_common.h"
+
+#include "mac_api.h"
+
+void ws_common_seconds_timer(protocol_interface_info_entry_t *cur, uint32_t seconds)
+{
+    (void) cur;
+    (void) seconds;
+
+    return;
+}