Added information API to Wi-SUN and border router

Added Gateway to Border router info

Added new information API to Wi-SUN interface

Author: Mika

nanostack/ws_bbr_api.h

@@ -36,6 +36,8 @@
 typedef struct bbr_information {
     /** Timestamp of the the device. Can be used as version number*/
     uint64_t timestamp;
+    /** Default route Link Local address of north bound router*/
+    uint8_t gateway[16];
     /** Border router dodag id */
     uint8_t dodag_id[16];
     /** Address prefix given to devices in network  set to 0 if not available*/

nanostack/ws_management_api.h

@@ -102,6 +102,24 @@ typedef struct ws_statistics {
     uint32_t asynch_rx_count;
 } ws_statistics_t;
 
+/**
+ * \brief Struct ws_info defines the Wi-SUN stack state.
+ */
+typedef struct ws_stack_info {
+    /** Parent link local address */
+    uint8_t parent[16];
+    /** parent RSSI Out measured RSSI value calculated using EWMA specified by Wi-SUN from range of -174 (0) to +80 (254) dBm.*/
+    uint8_t rsl_out;
+    /** parent RSSI in measured RSSI value calculated using EWMA specified by Wi-SUN from range of -174 (0) to +80 (254) dBm.*/
+    uint8_t rsl_in;
+    /** ETX To border router */
+    uint16_t routing_cost;
+    /** Network PAN ID */
+    uint16_t pan_id;
+    /** Wi-SUN join state defined by Wi-SUN specification 1-5*/
+    uint8_t join_state;
+} ws_stack_info_t;
+
 /**
  * Initialize Wi-SUN stack.
  *
@@ -582,6 +600,20 @@ int ws_statistics_start(
 int ws_statistics_stop(
     int8_t interface_id);
 
+/**
+ * Get information from the stack state.
+ * Parent information and link qualities with stack state info
+ *
+ * \param interface_id Network interface ID.
+ * \param info_ptr Pointer to stored stack state.
+ *
+ * \return 0 Success.
+ * \return <0 Failure.
+ */
+int ws_stack_info_get(
+    int8_t interface_id,
+    ws_stack_info_t *info_ptr);
+
 #ifdef __cplusplus
 }
 #endif

source/6LoWPAN/Bootstraps/Generic/protocol_6lowpan.c

@@ -75,7 +75,6 @@
 #include "Service_Libs/etx/etx.h"
 #include "Service_Libs/mac_neighbor_table/mac_neighbor_table.h"
 #include "6LoWPAN/ws/ws_common.h"
-#include "6LoWPAN/ws/ws_bootstrap.h"
 #ifdef HAVE_WS
 #include "6LoWPAN/ws/ws_cfg_settings.h"
 #endif
@@ -517,7 +516,7 @@ uint16_t protocol_6lowpan_neighbor_priority_set(int8_t interface_id, addrtype_t
         }
 
         if (new_primary) {
-            ws_primary_parent_update(cur, entry);
+            ws_common_primary_parent_update(cur, entry);
         }
         return 1;
     } else {
@@ -550,7 +549,7 @@ uint16_t protocol_6lowpan_neighbor_second_priority_set(int8_t interface_id, addr
             protocol_stats_update(STATS_ETX_2ND_PARENT, etx_entry->etx >> 4);
         }
         if (new_secondary) {
-            ws_secondary_parent_update(cur);
+            ws_common_secondary_parent_update(cur);
         }
         return 1;
     } else {

source/6LoWPAN/ws/ws_bbr_api.c

@@ -807,6 +807,11 @@ int ws_bbr_info_get(int8_t interface_id, bbr_information_t *info_ptr)
         memcpy(info_ptr->IID, wisun_if_addr + 8, 8);
     }
 
+    ipv6_route_t *next_hop = ipv6_route_choose_next_hop(ADDR_6TO4, backbone_interface_id, NULL);
+    if (next_hop) {
+        memcpy(info_ptr->gateway, next_hop->info.next_hop_addr, 16);
+    }
+
     info_ptr->devices_in_network = ws_bbr_pan_size(cur);
     info_ptr->instance_id = current_instance_id;
     info_ptr->version = dodag_info.version_num;

source/6LoWPAN/ws/ws_bootstrap.c

@@ -3304,33 +3304,32 @@ void ws_bootstrap_rpl_wait_process(protocol_interface_info_entry_t *cur)
     return;
 }
 
-/*
-
-static bool ws_bootstrap_state_configure(struct protocol_interface_info_entry *cur)
+static bool ws_bootstrap_state_discovery(struct protocol_interface_info_entry *cur)
 {
-    // Think about the state value
-    if (cur->nwk_bootstrap_state == ER_SCAN) {
+    if (cur->nwk_bootstrap_state == ER_ACTIVE_SCAN) {
         return true;
     }
     return false;
 }
 
-*/
-static bool ws_bootstrap_state_discovery(struct protocol_interface_info_entry *cur)
+static bool ws_bootstrap_state_authenticate(struct protocol_interface_info_entry *cur)
 {
-    if (cur->nwk_bootstrap_state == ER_ACTIVE_SCAN) {
+    // Think about the state value
+    if (cur->nwk_bootstrap_state == ER_PANA_AUTH) {
         return true;
     }
     return false;
 }
 
-static bool ws_bootstrap_state_active(struct protocol_interface_info_entry *cur)
+static bool ws_bootstrap_state_configure(struct protocol_interface_info_entry *cur)
 {
-    if (cur->nwk_bootstrap_state == ER_BOOTSRAP_DONE) {
+    // Think about the state value
+    if (cur->nwk_bootstrap_state == ER_SCAN) {
         return true;
     }
     return false;
 }
+
 static bool ws_bootstrap_state_wait_rpl(struct protocol_interface_info_entry *cur)
 {
     // Think about the state value
@@ -3340,6 +3339,14 @@ static bool ws_bootstrap_state_wait_rpl(struct protocol_interface_info_entry *cu
     return false;
 }
 
+static bool ws_bootstrap_state_active(struct protocol_interface_info_entry *cur)
+{
+    if (cur->nwk_bootstrap_state == ER_BOOTSRAP_DONE) {
+        return true;
+    }
+    return false;
+}
+
 static void ws_bootstrap_state_change(protocol_interface_info_entry_t *cur, icmp_state_t nwk_bootstrap_state)
 {
     cur->bootsrap_state_machine_cnt = 1;
@@ -3486,7 +3493,7 @@ void ws_bootstrap_seconds_timer(protocol_interface_info_entry_t *cur, uint32_t s
 
 }
 
-void ws_primary_parent_update(protocol_interface_info_entry_t *interface, mac_neighbor_table_entry_t *neighbor)
+void ws_bootstrap_primary_parent_update(protocol_interface_info_entry_t *interface, mac_neighbor_table_entry_t *neighbor)
 {
     if (interface->ws_info) {
         llc_neighbour_req_t neighbor_info;
@@ -3497,11 +3504,11 @@ void ws_primary_parent_update(protocol_interface_info_entry_t *interface, mac_ne
         ws_bootsrap_create_ll_address(link_local_address, neighbor->mac64);
         dhcp_client_server_address_update(interface->id, NULL, link_local_address);
 
-        ws_secondary_parent_update(interface);
+        ws_bootstrap_secondary_parent_update(interface);
     }
 }
 
-void ws_secondary_parent_update(protocol_interface_info_entry_t *interface)
+void ws_bootstrap_secondary_parent_update(protocol_interface_info_entry_t *interface)
 {
     if (interface->ws_info) {
         ns_list_foreach(if_address_entry_t, address, &interface->ip_addresses) {
@@ -3512,4 +3519,40 @@ void ws_secondary_parent_update(protocol_interface_info_entry_t *interface)
     }
 }
 
+int ws_bootstrap_get_info(protocol_interface_info_entry_t *cur, struct ws_stack_info *info_ptr)
+{
+
+    ws_neighbor_class_entry_t *ws_neighbour = NULL;
+
+    memset(info_ptr, 0, sizeof(struct ws_stack_info));
+    mac_neighbor_table_entry_t *mac_parent = mac_neighbor_entry_get_priority(mac_neighbor_info(cur));
+
+    if (mac_parent) {
+        ws_neighbour = ws_neighbor_class_entry_get(&cur->ws_info->neighbor_storage, mac_parent->index);
+
+        memcpy(info_ptr->parent, ADDR_LINK_LOCAL_PREFIX, 8);
+        memcpy(info_ptr->parent + 8, mac_parent->mac64, 8);
+        info_ptr->parent[8] ^= 2;
+    }
+    if (ws_neighbour) {
+        info_ptr->rsl_in = ws_neighbour->rsl_in;
+        info_ptr->rsl_out = ws_neighbour->rsl_out;
+        info_ptr->routing_cost = ws_neighbour->routing_cost;
+    }
+    if (ws_bootstrap_state_discovery(cur)) {
+        info_ptr->join_state = 1;
+    } else if (ws_bootstrap_state_authenticate(cur)) {
+        info_ptr->join_state = 2;
+    } else if (ws_bootstrap_state_configure(cur)) {
+        info_ptr->join_state = 3;
+    } else if (ws_bootstrap_state_wait_rpl(cur)) {
+        info_ptr->join_state = 4;
+    } else if (ws_bootstrap_state_active(cur)) {
+        info_ptr->join_state = 5;
+    }
+    info_ptr->pan_id = cur->ws_info->network_pan_id;
+
+    return 0;
+}
+
 #endif //HAVE_WS

source/6LoWPAN/ws/ws_bootstrap.h

@@ -33,6 +33,7 @@ struct llc_neighbour_req;
 struct ws_us_ie;
 struct ws_bs_ie;
 struct ws_neighbor_class_entry;
+struct ws_stack_info;
 
 int ws_bootstrap_init(int8_t interface_id, net_6lowpan_mode_e bootstrap_mode);
 
@@ -65,9 +66,9 @@ void ws_bootstrap_seconds_timer(protocol_interface_info_entry_t *cur, uint32_t s
 
 void ws_bootstrap_trickle_timer(protocol_interface_info_entry_t *cur, uint16_t ticks);
 
-void ws_primary_parent_update(protocol_interface_info_entry_t *interface, mac_neighbor_table_entry_t *neighbor);
+void ws_bootstrap_primary_parent_update(protocol_interface_info_entry_t *interface, mac_neighbor_table_entry_t *neighbor);
 
-void ws_secondary_parent_update(protocol_interface_info_entry_t *interface);
+void ws_bootstrap_secondary_parent_update(protocol_interface_info_entry_t *interface);
 
 void ws_nud_entry_remove_active(protocol_interface_info_entry_t *cur, void *neighbor);
 
@@ -91,15 +92,18 @@ struct ws_neighbor_class_entry *ws_bootstrap_eapol_tx_temporary_set(struct proto
 
 void ws_bootstrap_eapol_tx_temporary_clear(struct protocol_interface_info_entry *interface);
 
+int ws_bootstrap_get_info(protocol_interface_info_entry_t *cur, struct ws_stack_info *info_ptr);
+
 #else
 
 #define ws_bootstrap_init(interface_id, bootstrap_mode) (-1)
 #define ws_bootstrap_state_machine(cur)
 #define ws_bootstrap_restart(cur)
 #define ws_bootstrap_neighbor_remove(cur, ll_address)
 #define ws_bootstrap_aro_failure(cur, ll_address)
-#define ws_primary_parent_update(interface, neighbor)
-#define ws_secondary_parent_update(interface)
+#define ws_bootstrap_primary_parent_update(interface, neighbor)
+#define ws_bootstrap_secondary_parent_update(interface)
+#define ws_bootstrap_get_info(cur, info_ptr)
 
 #endif //HAVE_WS
 

source/6LoWPAN/ws/ws_common.c

@@ -479,4 +479,14 @@ uint32_t ws_common_network_size_estimate_get(protocol_interface_info_entry_t *cu
     return network_size_estimate;
 }
 
+void ws_common_primary_parent_update(protocol_interface_info_entry_t *interface, mac_neighbor_table_entry_t *neighbor)
+{
+    ws_bootstrap_primary_parent_update(interface, neighbor);
+}
+
+void ws_common_secondary_parent_update(protocol_interface_info_entry_t *interface)
+{
+    ws_bootstrap_secondary_parent_update(interface);
+}
+
 #endif // HAVE_WS

source/6LoWPAN/ws/ws_common.h

@@ -151,6 +151,10 @@ uint32_t ws_common_datarate_get(protocol_interface_info_entry_t *cur);
 
 uint32_t ws_common_network_size_estimate_get(protocol_interface_info_entry_t *cur);
 
+void ws_common_primary_parent_update(protocol_interface_info_entry_t *interface, mac_neighbor_table_entry_t *neighbor);
+
+void ws_common_secondary_parent_update(protocol_interface_info_entry_t *interface);
+
 #define ws_info(cur) ((cur)->ws_info)
 #else
 #define ws_info(cur) ((ws_info_t *) NULL)
@@ -164,6 +168,9 @@ uint32_t ws_common_network_size_estimate_get(protocol_interface_info_entry_t *cu
 #define ws_common_latency_estimate_get(cur) 0
 #define ws_common_datarate_get(cur) 0
 #define ws_common_network_size_estimate_get(cur) 0
+#define ws_common_primary_parent_update(interface, neighbor)
+#define ws_common_secondary_parent_update(interface)
+
 
 #endif //HAVE_WS
 #endif //WS_COMMON_H_

source/6LoWPAN/ws/ws_empty_functions.c

@@ -406,4 +406,11 @@ void ns_time_api_system_time_callback_set(ns_time_api_system_time_callback callb
     (void) callback;
 }
 
+int ws_state_info_get(int8_t interface_id, ws_stack_info_t *info_ptr)
+{
+    (void) interface_id;
+    (void) info_ptr;
+    return -1;
+}
+
 #endif // no HAVE_WS

source/6LoWPAN/ws/ws_management_api.c

@@ -731,4 +731,14 @@ int ws_management_timing_parameters_validate(
     return 0;
 }
 
+int ws_stack_info_get(int8_t interface_id, ws_stack_info_t *info_ptr)
+{
+    protocol_interface_info_entry_t *cur;
+    cur = protocol_stack_interface_info_get_by_id(interface_id);
+    if (!cur || !ws_info(cur) || !info_ptr) {
+        return -1;
+    }
+    return ws_bootstrap_get_info(cur, info_ptr);
+}
+
 #endif // HAVE_WS

source/Core/include/ns_address_internal.h

@@ -142,6 +142,7 @@ extern const uint8_t ADDR_ALL_MPL_FORWARDERS[16];                   // ff03::fc
 extern const uint8_t ADDR_ALL_DHCP_RELAY_AGENTS_AND_SERVERS[16];    // ff02::1:2
 extern const uint8_t ADDR_LOOPBACK[16];                             // ::1
 extern const uint8_t ADDR_UNSPECIFIED[16];                          // ::
+extern const uint8_t ADDR_6TO4[16];                                 // 2002::
 
 /* Don't bother having another 8 zero bytes for this - reuse ADDR_UNSPECIFIED */
 #define ADDR_EUI64_ZERO ADDR_UNSPECIFIED

source/Core/ns_address_internal.c

@@ -81,6 +81,7 @@ const uint8_t ADDR_ALL_DHCP_RELAY_AGENTS_AND_SERVERS[16] = { 0xff, 0x02, [13] =
 const uint8_t ADDR_IPV4_MAPPED_PREFIX[12]       = { [10] = 0xff, 0xff };
 const uint8_t ADDR_LOOPBACK[16]                 = { [15] = 1 };
 const uint8_t ADDR_UNSPECIFIED[16]              = { 0 };        /* Note a few bits of code check for pointer equality with ADDR_UNSPECIFIED */
+const uint8_t ADDR_6TO4[16]                     = { 0x20, 0x02 }; /*Can be used as global address*/
 #define ADDR_IPV4_COMPATIBLE                    ADDR_LOOPBACK /* First 96 bits match...*/
 
 #define ADDR_MULTICAST_LINK_PREFIX              ADDR_LINK_LOCAL_ALL_NODES /* ff02::xx */

test/nanostack/unittest/stub/ws_bootstrap_stub.c

@@ -106,12 +106,12 @@ void ws_bootstrap_configuration_trickle_reset(protocol_interface_info_entry_t *c
 
 }
 
-void ws_primary_parent_update(protocol_interface_info_entry_t *interface, mac_neighbor_table_entry_t *neighbor)
+void ws_bootstrap_primary_parent_update(protocol_interface_info_entry_t *interface, mac_neighbor_table_entry_t *neighbor)
 {
 
 }
 
-void ws_secondary_parent_update(protocol_interface_info_entry_t *interface)
+void ws_bootstrap_secondary_parent_update(protocol_interface_info_entry_t *interface)
 {
 
 }
@@ -149,3 +149,7 @@ void ws_bootstrap_eapol_tx_temporary_clear(struct protocol_interface_info_entry
 {
 
 }
+int ws_bootstrap_get_info(protocol_interface_info_entry_t *cur, struct ws_stack_info *info_ptr)
+{
+}
+

test/nanostack/unittest/stub/ws_common_stub.c

@@ -102,3 +102,11 @@ uint16_t ws_active_channel_count(uint32_t *channel_mask, uint16_t number_of_chan
 {
     return 35;
 }
+
+void ws_common_primary_parent_update(protocol_interface_info_entry_t *interface, mac_neighbor_table_entry_t *neighbor)
+{
+}
+
+void ws_common_secondary_parent_update(protocol_interface_info_entry_t *interface)
+{
+}