Added public configuration API for Wi-SUN BBR

New modes for differenet RPL conficuration added
No ULA prefix
No GUA prefix
Wait backbone interface before start
Wait Wi-SUN network startup before backbone

Author: Mika Tervonen

nanostack/ws_bbr_api.h

@@ -45,6 +45,36 @@
  */
 int ws_bbr_start(int8_t interface_id, int8_t backbone_interface_id);
 
+/**
+ * Border router configuration options
+ */
+#define BBR_ULA_C           0x0001 /**< Static ULA prefix created automatically */
+#define BBR_GUA_C           0x0002 /**< Routable prefix is learned from the backbone */
+#define BBR_GUA_ROUTE       0x0004 /**< More specific route is added for GUA prefix */
+#define BBR_GUA_SLAAC       0x0008 /**< Use SLAAC addressing in routable prefix */
+#define BBR_GUA_WAIT        0x0010 /**< Wait backbone availability before starting RPL dodag */
+#define BBR_BB_WAIT         0x0020 /**< Wait backbone availability before starting Wi-SUN network */
+/**
+ * Configure border router features.
+ *
+ * \param interface_id interface ID of the Wi-SUN network
+ * \param options Options configured to Border router
+ *          BBR_ULA_C     Configure Mesh local ULA prefix with SLAAC address  (default)
+ *          BBR_GUA_C     Configure GUA/ULA prefix from backbone to RPL       (default)
+ *          BBR_GUA_ROUTE Add more specific route for GUA                     (default)
+ *          BBR_GUA_SLAAC Use SLAAC address generation in GUA prefix
+ *          BBR_GUA_WAIT  Start RPL root only when GUA is available
+ *          BBR_BB_WAIT   Start Wi-SUN network only when backbone is ready
+ *
+ * By default Wi-SUN network is started and is treated as separate interface even if backbone is not available.
+ *
+ * Default route RPL options when backbone is set up. RPL root is always Grounded
+ *
+ * \return 0 on success
+ * \return <0 in case of errors
+ *
+ */
+int ws_bbr_configure(int8_t interface_id, uint16_t options);
 /**
  * Stop backbone Border router.
  *

source/6LoWPAN/ws/ws_bbr_api.c

@@ -37,6 +37,8 @@
 #include "6LoWPAN/ws/ws_bbr_api_internal.h"
 #include "DHCPv6_Server/DHCPv6_server_service.h"
 
+#include "ws_bbr_api.h"
+
 #define TRACE_GROUP "wsbs"
 
 #define RPL_INSTANCE_ID 1
@@ -49,6 +51,7 @@
  *
  */
 static int8_t backbone_interface_id = -1; // BBR backbone information
+static uint16_t configuration = BBR_ULA_C | BBR_GUA_C | BBR_GUA_ROUTE;
 
 static uint8_t static_dodag_prefix[8] = {0xfd, 0x00, 0x61, 0x72, 0x6d};
 static uint8_t static_ula_address[16] = {0};
@@ -109,15 +112,10 @@ static void ws_bbr_rpl_root_start(uint8_t *dodag_id)
         tr_err("RPL dodag init failed");
         return;
     }
-    memcpy(static_dodag_id, dodag_id, 16);
-
     // RPL memory limits set larger for Border router
     rpl_control_set_memory_limits(64 * 1024, 0);
-
-    uint8_t t_flags = PIO_A;
-
-    rpl_control_update_dodag_prefix(protocol_6lowpan_rpl_root_dodag, dodag_id, 64, t_flags, 7200, 7200, false);
-    rpl_control_update_dodag_route(protocol_6lowpan_rpl_root_dodag, dodag_id, 64, 0x18, 7200, false);
+    // Save configured static id to check for changes later
+    memcpy(static_dodag_id, dodag_id, 16);
 }
 
 static void ws_bbr_rpl_root_stop(void)
@@ -130,6 +128,17 @@ static void ws_bbr_rpl_root_stop(void)
     memset(global_dodag_id, 0, 16);
 }
 
+static void ws_bbr_ula_prefix_enable(uint8_t *dodag_id)
+{
+    tr_info("RPL ula prefix start");
+
+    uint8_t t_flags = PIO_A;
+
+    rpl_control_update_dodag_prefix(protocol_6lowpan_rpl_root_dodag, dodag_id, 64, t_flags, 7200, 7200, false);
+    rpl_control_update_dodag_route(protocol_6lowpan_rpl_root_dodag, dodag_id, 64, 0x18, 7200, false);
+}
+
+
 static int ws_border_router_proxy_validate(int8_t interface_id, uint8_t *address)
 {
 
@@ -267,6 +276,35 @@ static bool wisun_dhcp_address_add_cb(int8_t interfaceId, dhcp_address_cache_upd
     return true;
 }
 
+static void ws_bbr_dhcp_server_start(protocol_interface_info_entry_t *cur, uint8_t *global_id)
+{
+    uint8_t ll[16];
+    memcpy(ll, ADDR_LINK_LOCAL_PREFIX, 8);
+    memcpy(&ll[8], cur->mac, 8);
+    ll[8] ^= 2;
+
+    tr_debug("DHCP server activate %s", trace_ipv6(global_id));
+
+    if (DHCPv6_server_service_init(cur->id, global_id, cur->mac, DHCPV6_DUID_HARDWARE_IEEE_802_NETWORKS_TYPE) != 0) {
+        tr_error("DHCPv6 Server create fail");
+        return;
+    }
+    DHCPv6_server_service_callback_set(cur->id, global_id, NULL, wisun_dhcp_address_add_cb);
+
+    DHCPv6_server_service_set_address_autonous_flag(cur->id, global_id, true);
+    DHCPv6_server_service_set_address_validlifetime(cur->id, global_id, 7200);
+
+    ws_dhcp_client_address_request(cur, global_id, ll);
+}
+static void ws_bbr_dhcp_server_stop(protocol_interface_info_entry_t *cur, uint8_t *global_id)
+{
+    tr_debug("DHCP server deactivate %s", trace_ipv6(global_id));
+    DHCPv6_server_service_delete(cur->id, global_id, false);
+
+    // Set old addresses to deferred and timeout
+    ws_dhcp_client_address_delete(cur, global_id);
+
+}
 
 static void ws_bbr_rpl_status_check(protocol_interface_info_entry_t *cur)
 {
@@ -278,56 +316,64 @@ static void ws_bbr_rpl_status_check(protocol_interface_info_entry_t *cur)
 
     ws_bbr_dodag_get(cur, static_id, global_id);
 
+    // Check if we need to wait for Global ID
+    if (configuration & BBR_GUA_WAIT) {
+        if (memcmp(global_dodag_id, ADDR_UNSPECIFIED, 16) == 0 &&
+                memcmp(global_id, ADDR_UNSPECIFIED, 16) == 0) {
+            // We need to wait for Global connectivity to start anything
+            return;
+        }
+    }
+
     if (memcmp(static_dodag_id, static_id, 16) != 0) {
         // Static id updated or first setup
         ws_bbr_rpl_root_start(static_id);
+        if (configuration & BBR_ULA_C) {
+            // Start static ULA prefix and routing always
+            ws_bbr_ula_prefix_enable(static_id);
+        }
     }
+
     if (memcmp(global_dodag_id, global_id, 16) != 0) {
         // Global prefix changed
         if (memcmp(global_dodag_id, ADDR_UNSPECIFIED, 16) != 0) {
             // TODO remove old global prefix
             tr_info("RPL GUA deactivate %s", trace_ipv6(global_dodag_id));
 
-            rpl_control_update_dodag_prefix(protocol_6lowpan_rpl_root_dodag, static_dodag_id, 64, PIO_A, 7200, 7200, false);
-            rpl_control_update_dodag_route(protocol_6lowpan_rpl_root_dodag, static_dodag_id, 64, 0x18, 7200, false);
-
             // Old backbone information is deleted after 120 seconds
             rpl_control_update_dodag_route(protocol_6lowpan_rpl_root_dodag, NULL, 0, 0, 120, true);
             rpl_control_update_dodag_prefix(protocol_6lowpan_rpl_root_dodag, global_dodag_id, 64, 0, 120, 0, true);
             rpl_control_update_dodag_route(protocol_6lowpan_rpl_root_dodag, global_dodag_id, 64, 0, 120, true);
             ipv6_route_add_with_info(global_dodag_id, 64, backbone_interface_id, NULL, ROUTE_THREAD_BBR, NULL, 0, 120, 0);
-            DHCPv6_server_service_delete(cur->id, global_dodag_id, false);
 
-            // Set old addresses to deferred and timeout
-            ws_dhcp_client_address_delete(cur, global_dodag_id);
+            ws_bbr_dhcp_server_stop(cur, global_dodag_id);
         }
         // TODO add global prefix
         if (memcmp(global_id, ADDR_UNSPECIFIED, 16) != 0) {
-            //DHCPv6 Server set here
-            //Interface LL64 address
-            uint8_t ll[16];
-            memcpy(ll, ADDR_LINK_LOCAL_PREFIX, 8);
-            memcpy(&ll[8], cur->mac, 8);
-            ll[8] ^= 2;
-
-            if (DHCPv6_server_service_init(cur->id, global_id, cur->mac, DHCPV6_DUID_HARDWARE_IEEE_802_NETWORKS_TYPE) != 0) {
-                tr_error("DHCPv6 Server create fail");
-                return;
-            }
-            DHCPv6_server_service_callback_set(cur->id, global_id, NULL, wisun_dhcp_address_add_cb);
-
-            DHCPv6_server_service_set_address_autonous_flag(cur->id, global_id, true);
-            DHCPv6_server_service_set_address_validlifetime(cur->id, global_id, 7200);
-
-            tr_info("RPL GUA activate %s", trace_ipv6(global_id));
-            ws_dhcp_client_address_request(cur, global_id, ll);
+            //DHCPv6 Server flags set 0 by default
+            uint8_t t_flags = 0;
 
+            // Add default route to RPL
             rpl_control_update_dodag_route(protocol_6lowpan_rpl_root_dodag, NULL, 0, 0, 7200, false);
-            rpl_control_update_dodag_prefix(protocol_6lowpan_rpl_root_dodag, static_dodag_id, 64, PIO_A, 7200, 7200, false);
-            rpl_control_update_dodag_route(protocol_6lowpan_rpl_root_dodag, static_dodag_id, 64, 0x18, 7200, false);
-            rpl_control_update_dodag_prefix(protocol_6lowpan_rpl_root_dodag, global_id, 64, 0, 7200, 7200, false);
-            rpl_control_update_dodag_route(protocol_6lowpan_rpl_root_dodag, global_id, 64, 0, 7200, false);
+            // Enable default routing to backbone
             ipv6_route_add_with_info(global_id, 64, backbone_interface_id, NULL, ROUTE_THREAD_BBR, NULL, 0, 0xffffffff, 0);
+
+            if (configuration & BBR_GUA_SLAAC) {
+                // GUA prefix is using SLAAC so no DHCP started and set correct flags for prefix
+                t_flags = PIO_A;
+            } else {
+                ws_bbr_dhcp_server_start(cur, global_id);
+            }
+
+            if (configuration & BBR_GUA_C) {
+                // Add also global prefix and route to RPL
+                rpl_control_update_dodag_prefix(protocol_6lowpan_rpl_root_dodag, global_id, 64, t_flags, 7200, 7200, false);
+            }
+            if (configuration & BBR_GUA_ROUTE) {
+                // Add also global prefix and route to RPL
+                rpl_control_update_dodag_route(protocol_6lowpan_rpl_root_dodag, global_id, 64, 0, 7200, false);
+            }
+
         }
         memcpy(global_dodag_id, global_id, 16);
         rpl_control_increment_dodag_version(protocol_6lowpan_rpl_root_dodag);
@@ -426,7 +472,29 @@ uint16_t ws_bbr_pan_size(protocol_interface_info_entry_t *cur)
     return result;
 }
 
+bool ws_bbr_ready_to_start(protocol_interface_info_entry_t *cur)
+{
 
+    (void)cur;
+    uint8_t global_address[16];
+
+    if (backbone_interface_id < 0) {
+        // No need to wait for backbone
+        return true;
+    }
+
+    if ((configuration & BBR_BB_WAIT) != BBR_BB_WAIT) {
+        // No need to wait for backbone
+        return true;
+    }
+
+    if (arm_net_address_get(backbone_interface_id, ADDR_IPV6_GP, global_address) != 0) {
+        // No global prefix available
+        return false;
+    }
+
+    return true;
+}
 #endif //HAVE_WS_BORDER_ROUTER
 
 /* Public APIs
@@ -472,6 +540,24 @@ void ws_bbr_stop(int8_t interface_id)
     (void)interface_id;
 #endif
 }
+int ws_bbr_configure(int8_t interface_id, uint16_t options)
+{
+#ifdef HAVE_WS_BORDER_ROUTER
+
+    (void)interface_id;
+    if (protocol_6lowpan_rpl_root_dodag &&
+            options != configuration) {
+        //Configuration changed delete previus setup
+        ws_bbr_rpl_root_stop();
+    }
+    configuration = options;
+    return 0;
+#else
+    (void)interface_id;
+    (void)options;
+    return -1;
+#endif
+}
 
 int ws_bbr_node_keys_remove(int8_t interface_id, uint8_t *eui64)
 {

source/6LoWPAN/ws/ws_bbr_api_internal.h

@@ -29,13 +29,15 @@ uint16_t ws_bbr_pan_size(protocol_interface_info_entry_t *cur);
 
 void ws_bbr_rpl_config(uint8_t imin, uint8_t doubling, uint8_t redundancy);
 
+bool ws_bbr_ready_to_start(protocol_interface_info_entry_t *cur);
 
 
 #else
 
 #define ws_bbr_seconds_timer( cur, seconds)
 #define ws_bbr_pan_size(cur) 0
-#define ws_bbr_rpl_config( imin, doubling, redundancy);
+#define ws_bbr_rpl_config( imin, doubling, redundancy)
+#define ws_bbr_ready_to_start(cur) true
 
 #endif //HAVE_WS_BORDER_ROUTER
 

source/6LoWPAN/ws/ws_bootstrap.c

@@ -2211,6 +2211,13 @@ 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");
+
+                if (!ws_bbr_ready_to_start(cur)) {
+                    // Wi-SUN not started yet we wait for Border router permission
+                    ws_bootstrap_state_change(cur, ER_WAIT_RESTART);
+                    cur->nwk_nd_re_scan_count = randLIB_get_random_in_range(40, 100);
+                    return;
+                }
                 ws_pae_controller_auth_init(cur);
 
                 // Randomize fixed channels. Only used if channel plan is fixed.
@@ -2437,6 +2444,10 @@ void ws_bootstrap_state_machine(protocol_interface_info_entry_t *cur)
 {
 
     switch (cur->nwk_bootstrap_state) {
+        case ER_WAIT_RESTART:
+            tr_debug("WS SM:Wait for startup");
+            ws_bootstrap_event_discovery_start(cur);
+            break;
         case ER_ACTIVE_SCAN:
             tr_debug("WS SM:Active Scan");
             ws_bootstrap_network_scan_process(cur);
@@ -2454,10 +2465,8 @@ void ws_bootstrap_state_machine(protocol_interface_info_entry_t *cur)
             // Bootstrap_done event to application
             nwk_bootsrap_state_update(ARM_NWK_BOOTSTRAP_READY, cur);
             break;
-
         default:
             tr_warn("WS SM:Invalid state %d", cur->nwk_bootstrap_state);
-
     }
 }
 

source/NWK_INTERFACE/Include/protocol.h

@@ -121,6 +121,7 @@ typedef enum icmp_state {
     ER_BOOTSTRAP_SCAN_FAIL,
     ER_BOOTSTRAP_LEADER_UP,
     ER_BOOTSTRAP_NEW_FRAGMENT_START,
+    ER_WAIT_RESTART,
     ER_RPL_LOCAL_REPAIR,
 } icmp_state_t;