Wi-SUN FAN 1.1 PCAP IE update

Advertisment and storage support for PA messages.

Added Parser for Data frame and storage.

Author: Juha Heiskanen

source/6LoWPAN/ws/ws_bootstrap.c

@@ -2967,6 +2967,9 @@ static void ws_bootstrap_pan_advert(protocol_interface_info_entry_t *cur)
     async_req.wp_requested_nested_ie_list.us_ie = true;
     async_req.wp_requested_nested_ie_list.pan_ie = true;
     async_req.wp_requested_nested_ie_list.net_name_ie = true;
+    if (ws_version_1_1(cur)) {
+        async_req.wp_requested_nested_ie_list.phy_cap_ie = true;
+    }
 
     ws_set_asynch_channel_list(cur, &async_req);
     async_req.security.SecurityLevel = 0;
@@ -2998,11 +3001,9 @@ static void ws_bootstrap_pan_config(protocol_interface_info_entry_t *cur)
     async_req.wp_requested_nested_ie_list.pan_version_ie = true;
     async_req.wp_requested_nested_ie_list.gtkhash_ie = true;
     async_req.wp_requested_nested_ie_list.vp_ie = true;
-#ifdef HAVE_WS_VERSION_1_1
     if (ws_version_1_1(cur)) {
-        async_req.wp_requested_nested_ie_list.lfn_gtk_version_ie = cur->ws_info->lfngtk.lfn_version_learned;
+        async_req.wp_requested_nested_ie_list.lfn_gtk_version_ie = ws_lfn_version_learned(cur);
     }
-#endif
 
     ws_set_asynch_channel_list(cur, &async_req);
 

source/6LoWPAN/ws/ws_bootstrap_ffn.c

@@ -323,6 +323,10 @@ static void ws_bootstrap_ffn_pan_advertisement_analyse(struct protocol_interface
     neighbor_info.neighbor = NULL;
     if (ws_bootstrap_neighbor_info_request(cur, data->SrcAddr, &neighbor_info, false)) {
         neighbor_info.ws_neighbor->routing_cost = pan_information.routing_cost;
+        //Store and search neighbour PCAP info
+        if (ws_version_1_1(cur)) {
+            ws_wp_nested_pcap_read(ie_ext->payloadIeList, ie_ext->payloadIeListLength, ws_neighbour_cap_pointer(neighbor_info.ws_neighbor));
+        }
     }
 
     ws_bootstrap_ffn_pan_advertisement_analyse_active(cur, &pan_information);

source/6LoWPAN/ws/ws_common.c

@@ -20,6 +20,7 @@
 #include "ns_types.h"
 #include "ns_trace.h"
 #include "randLIB.h"
+#include "common_functions.h"
 #include <ns_list.h>
 #include <nsdynmemLIB.h>
 #include "Common_Protocols/icmpv6.h"
@@ -39,6 +40,7 @@
 #include "6LoWPAN/ws/ws_pae_controller.h"
 #include "6LoWPAN/ws/ws_cfg_settings.h"
 #include "6LoWPAN/ws/ws_stats.h"
+#include "6LoWPAN/ws/ws_ie_lib.h"
 #include "Service_Libs/etx/etx.h"
 #include "Service_Libs/mac_neighbor_table/mac_neighbor_table.h"
 #include "Service_Libs/blacklist/blacklist.h"

source/6LoWPAN/ws/ws_common.h

@@ -37,6 +37,8 @@ struct ws_pan_information_s;
 struct ws_neighbor_class_s;
 struct ws_excluded_channel_data_s;
 struct ws_cfg_s;
+struct ws_neighbor_class_entry;
+struct mcps_data_ie_list;
 
 typedef struct parent_info_s {
     uint16_t             pan_id;             /**< PAN ID */
@@ -102,10 +104,6 @@ typedef struct {
     uint8_t lgtkhash[24];
 } ws_lfn_lgtk_t;
 
-typedef struct {
-    unsigned length_of_list: 3;
-    ws_pcab_ie_t pcab[7];
-} ws_phy_cap_info_t;
 
 typedef NS_LIST_HEAD(ws_nud_table_entry_t, link) ws_nud_table_list_t;
 
@@ -229,15 +227,21 @@ void ws_common_state_machine(protocol_interface_info_entry_t *cur);
 #ifdef HAVE_WS_VERSION_1_1
 #define ws_version_1_0(cur) (((cur)->ws_info) && ((cur)->ws_info)->version == 1)
 #define ws_version_1_1(cur) (((cur)->ws_info) && ((cur)->ws_info)->version > 1)
+#define ws_lfn_version_learned(cur) ((cur)->ws_info->lfngtk.lfn_version_learned == true)
+#define ws_neighbour_cap_pointer(neighbour) (&neighbour->pcap_info)
 #else
 #define ws_version_1_1(cur) (false)
 #define ws_version_1_0(cur) ((cur)->ws_info)
+#define ws_lfn_version_learned(cur) (false)
+#define ws_neighbour_cap_pointer(neighbour) NULL
 #endif
 #define ws_test_proc_auto_trg(cur) ((cur)->ws_info->test_proc_trg.auto_trg_enabled == true)
 #else
 #define ws_info(cur) ((ws_info_t *) NULL)
 #define ws_version_1_1(cur) (false)
 #define ws_version_1_0(cur) (false)
+#define ws_lfn_version_learned(cur) (false)
+#define ws_neighbour_cap_pointer(neighbour) NULL
 #define ws_test_proc_auto_trg(cur) (false)
 #define ws_common_seconds_timer(cur, seconds)
 #define ws_common_neighbor_update(cur, ll_address) ((void) 0)

source/6LoWPAN/ws/ws_common_defines.h

@@ -241,20 +241,17 @@ typedef struct ws_panid_ie {
 } ws_panid_ie_t;
 
 /**
- * @brief ws_pcab_ie_t WS PCAB-IE
+ * @brief ws_pcap_ie_t WS PCAB-IE
  */
-typedef struct ws_pcab_ie {
+typedef struct ws_pcap_ie {
     unsigned phy_type: 3;
     uint16_t operation_mode;
-} ws_pcab_ie_t;
+} ws_pcap_ie_t;
 
-/**
- * @brief ws_pcab_read_ie_t WS PCAB-IE
- */
-typedef struct ws_pcab_read_ie {
-    unsigned length_of_pcab: 3;
-    uint8_t *pcab_start;
-} ws_pcab_read_ie_t;
+typedef struct ws_phy_cap_info {
+    unsigned length_of_list: 3;
+    ws_pcap_ie_t pcap[7];
+} ws_phy_cap_info_t;
 
 /**
  * @brief ws_bt_ie_t WS BT-IE read

source/6LoWPAN/ws/ws_ie_lib.c

@@ -547,23 +547,21 @@ uint8_t *ws_wp_nested_gtkhash_write(uint8_t *ptr, uint8_t *gtkhash, uint8_t gtkh
     return ptr;
 }
 
-uint16_t ws_wp_nested_pcab_length(uint8_t list_length)
+uint16_t ws_wp_nested_pcap_length(uint8_t list_length)
 {
     uint16_t lenght = (list_length * 3) + 1;
     return lenght;
 }
 
-uint8_t *ws_wp_nested_pcap_write(uint8_t *ptr, uint8_t list_length, struct ws_pcab_ie *pcab_list)
+uint8_t *ws_wp_nested_pcap_write(uint8_t *ptr, struct ws_phy_cap_info *pcap_list)
 {
-    uint16_t lenght = ws_wp_nested_pcab_length(list_length);
+    uint16_t lenght = ws_wp_nested_pcap_length(pcap_list->length_of_list);
 
     ptr = mac_ie_nested_ie_short_base_write(ptr, WP_PAYLOAD_IE_PCAP_TYPE, lenght);
-    *ptr++ = list_length;
-    while (list_length) {
-        *ptr++ = pcab_list->phy_type;
-        ptr = common_write_16_bit_inverse(pcab_list->operation_mode, ptr);
-        list_length--;
-        pcab_list++;
+    *ptr++ = pcap_list->length_of_list;
+    for (int i = 0; i < pcap_list->length_of_list; i++) {
+        *ptr++ = pcap_list->pcap[i].phy_type;
+        ptr = common_write_16_bit_inverse(pcap_list->pcap[i].operation_mode, ptr);
     }
     return ptr;
 }
@@ -1157,23 +1155,38 @@ bool ws_wp_nested_network_name_read(uint8_t *data, uint16_t length, ws_wp_networ
     return true;
 }
 
-bool ws_wp_nested_pcab_read(uint8_t *data, uint16_t length, struct ws_pcab_read_ie *ws_pcab_list)
+bool ws_wp_nested_pcap_read(uint8_t *data, uint16_t length, struct ws_phy_cap_info *ws_pcap_list)
 {
+#ifdef HAVE_WS_VERSION_1_1
     mac_nested_payload_IE_t nested_payload_ie;
     nested_payload_ie.id = WP_PAYLOAD_IE_PCAP_TYPE;
     nested_payload_ie.type_long = false;
     if (4 > mac_ie_nested_discover(data, length, &nested_payload_ie)) {
         return false;
     }
-    //Validate length
+    //Read & Validate length
     data = nested_payload_ie.content_ptr;
-    ws_pcab_list->length_of_pcab = *data & 0x07;
-    if (nested_payload_ie.length < ws_pcab_list->length_of_pcab * 3) {
+    uint8_t length_of_cap = *data++ & 0x07;
+
+    if (nested_payload_ie.length < length_of_cap * 3) {
         return false;
     }
+    ws_pcap_list->length_of_list = length_of_cap;
+
+    for (uint8_t i = 0; i < length; length_of_cap++) {
+        ws_pcap_list->pcap[i].phy_type = *data++ & 7;
+        ws_pcap_list->pcap[i].operation_mode = common_read_16_bit_inverse(data);
+        data += 2;
+    }
+
 
-    ws_pcab_list->pcab_start = data + 1;
     return true;
+#else
+    (void) data;
+    (void) length;
+    (void) ws_pcap_list;
+    return false;
+#endif
 }
 
 

source/6LoWPAN/ws/ws_ie_lib.h

@@ -24,6 +24,7 @@ struct ws_bt_ie;
 struct ws_us_ie;
 struct ws_hopping_schedule_s;
 struct ws_fc_ie;
+struct ws_phy_cap_info;
 
 /**
  * @brief ws_wp_network_name_t WS nested payload network name
@@ -89,9 +90,9 @@ uint8_t *ws_wp_nested_pan_ver_write(uint8_t *ptr, struct ws_pan_information_s *p
 uint8_t *ws_wp_nested_gtkhash_write(uint8_t *ptr, uint8_t *gtkhash, uint8_t gtkhash_length);
 uint16_t ws_wp_nested_hopping_schedule_length(struct ws_hopping_schedule_s *hopping_schedule, bool unicast_schedule);
 /* Wi-SUN FAN 1.1 */
-/* WS PCAB */
-uint8_t *ws_wp_nested_pcap_write(uint8_t *ptr, uint8_t list_length, struct ws_pcab_ie *pcab_list);
-uint16_t ws_wp_nested_pcab_length(uint8_t list_length);
+/* WS PCAP */
+uint8_t *ws_wp_nested_pcap_write(uint8_t *ptr, struct ws_phy_cap_info *pcap_list);
+uint16_t ws_wp_nested_pcap_length(uint8_t list_length);
 /* WS LFN version */
 uint8_t *ws_wp_nested_lfn_version_write(uint8_t *ptr, struct ws_lfnver_ie *ws_lfnver);
 /* WS LFN GTK HAS */
@@ -109,7 +110,7 @@ bool ws_wp_nested_pan_version_read(uint8_t *data, uint16_t length, uint16_t *pan
 bool ws_wp_nested_network_name_read(uint8_t *data, uint16_t length, ws_wp_network_name_t *network_name);
 uint8_t *ws_wp_nested_gtkhash_read(uint8_t *data, uint16_t length);
 /* Wi-SUN FAN 1.1 */
-bool ws_wp_nested_pcab_read(uint8_t *data, uint16_t length, struct ws_pcab_read_ie *ws_pcab_list);
+bool ws_wp_nested_pcap_read(uint8_t *data, uint16_t length, struct ws_phy_cap_info *ws_pcap_list);
 bool ws_wp_nested_lfn_version_read(uint8_t *data, uint16_t length, struct ws_lfnver_ie *ws_lfnver);
 bool ws_wp_nested_lgtk_hash_read(uint8_t *data, uint16_t length, struct ws_lgtkhash_ie *ws_lgtkhash);
 bool ws_wp_nested_lfn_channel_plan_read(uint8_t *data, uint16_t length, struct ws_generic_channel_info *ws_lcp, uint8_t plan_tag_id);

source/6LoWPAN/ws/ws_llc.h

@@ -56,7 +56,8 @@ typedef struct wp_nested_ie_sub_list_s {
     bool net_name_ie: 1;            /**< Network Name information */
     bool pan_version_ie: 1;         /**< Pan configuration version */
     bool gtkhash_ie: 1;             /**< GTK Hash information */
-    bool lfn_gtk_version_ie: 1;    /**<  LFN Version & GTK Hash */
+    bool lfn_gtk_version_ie: 1;     /**<  LFN Version & GTK Hash */
+    bool phy_cap_ie: 1;             /** < Phy Cap information for MDR */
 } wp_nested_ie_sub_list_t;
 
 /**

source/6LoWPAN/ws/ws_llc_data_service.c

@@ -413,14 +413,20 @@ static uint16_t ws_wp_nested_message_length(wp_nested_ie_sub_list_t requested_li
         }
     }
 #ifdef HAVE_WS_VERSION_1_1
-    if (requested_list.lfn_gtk_version_ie) {
+    if (ws_version_1_1(llc_base->interface_ptr)) {
+        if (requested_list.lfn_gtk_version_ie) {
+
+            length += WS_WP_SUB_IE_ELEMENT_HEADER_LENGTH + ws_wp_nested_lfn_version_length();
+            ws_lgtkhash_ie_t ws_lgtkhash;
+            ws_lgtkhash.lgtk0 = llc_base->interface_ptr->ws_info->lfngtk.active_hash_1;
+            ws_lgtkhash.lgtk1 = llc_base->interface_ptr->ws_info->lfngtk.active_hash_2;
+            ws_lgtkhash.lgtk2 = llc_base->interface_ptr->ws_info->lfngtk.active_hash_3;
+            length += WS_WP_SUB_IE_ELEMENT_HEADER_LENGTH + ws_wp_lgtk_hash_length(&ws_lgtkhash);
+        }
 
-        length += WS_WP_SUB_IE_ELEMENT_HEADER_LENGTH + ws_wp_nested_lfn_version_length();
-        ws_lgtkhash_ie_t ws_lgtkhash;
-        ws_lgtkhash.lgtk0 = llc_base->interface_ptr->ws_info->lfngtk.active_hash_1;
-        ws_lgtkhash.lgtk1 = llc_base->interface_ptr->ws_info->lfngtk.active_hash_2;
-        ws_lgtkhash.lgtk2 = llc_base->interface_ptr->ws_info->lfngtk.active_hash_3;
-        length += WS_WP_SUB_IE_ELEMENT_HEADER_LENGTH + ws_wp_lgtk_hash_length(&ws_lgtkhash);
+        if (requested_list.phy_cap_ie) {
+            length += WS_WP_SUB_IE_ELEMENT_HEADER_LENGTH + ws_wp_nested_pcap_length(llc_base->interface_ptr->ws_info->phy_cap_info.length_of_list);
+        }
     }
 #endif
 
@@ -786,6 +792,11 @@ static void ws_llc_data_indication_cb(const mac_api_t *api, const mcps_data_ind_
             //SET trusted state
             mac_neighbor_table_trusted_neighbor(mac_neighbor_info(interface), neighbor_info.neighbor, true);
         }
+        //
+        //Phy CAP info read and store
+        if (ws_version_1_1(interface)) {
+            ws_wp_nested_pcap_read(ie_ext->payloadIeList, ie_ext->payloadIeListLength, ws_neighbour_cap_pointer(neighbor_info.ws_neighbor));
+        }
     }
 
     mcps_data_ind_t data_ind = *data;
@@ -1911,6 +1922,10 @@ int8_t ws_llc_asynch_request(struct protocol_interface_info_entry *interface, as
                 ws_lgtkhash.lgtk2_hash = base->interface_ptr->ws_info->lfngtk.lgtkhash + 16;
                 ptr = ws_wp_nested_lgtk_hash_write(ptr, &ws_lgtkhash);
             }
+
+            if (request->wp_requested_nested_ie_list.phy_cap_ie) {
+                ptr = ws_wp_nested_pcap_write(ptr, &base->interface_ptr->ws_info->phy_cap_info);
+            }
         }
 #endif
 

source/6LoWPAN/ws/ws_neighbor_class.c

@@ -26,7 +26,9 @@
 #include "6LoWPAN/ws/ws_config.h"
 #include "6LoWPAN/ws/ws_neighbor_class.h"
 #include "6LoWPAN/ws/ws_common.h"
+#include "6LoWPAN/ws/ws_ie_lib.h"
 #include "ws_management_api.h"
+#include "mac_api.h"
 
 #ifdef HAVE_WS
 
@@ -393,6 +395,14 @@ bool ws_neighbor_class_neighbor_duplicate_packet_check(ws_neighbor_class_entry_t
     return true;
 }
 
+#ifdef HAVE_WS_VERSION_1_1
+void ws_neighbor_class_pcap_ie_store(struct ws_neighbor_class_entry *ws_neighbor, const struct mcps_data_ie_list *ie_ext)
+{
+    ws_wp_nested_pcap_read(ie_ext->payloadIeList, ie_ext->payloadIeListLength, &ws_neighbor->pcap_info);
+
+}
+#endif
+
 
 #endif /* HAVE_WS */
 

source/6LoWPAN/ws/ws_neighbor_class.h

@@ -21,6 +21,8 @@
 #include "fhss_ws_extension.h"
 #include "6LoWPAN/ws/ws_common_defines.h"
 
+struct mcps_data_ie_list;
+
 #define RSL_UNITITIALIZED 0x7fff
 
 typedef struct ws_neighbor_class_entry {
@@ -34,6 +36,9 @@ typedef struct ws_neighbor_class_entry {
     bool broadcast_shedule_info_stored: 1;
     bool synch_done : 1;
     bool unicast_data_rx : 1;
+#ifdef HAVE_WS_VERSION_1_1
+    ws_phy_cap_info_t pcap_info;
+#endif
 } ws_neighbor_class_entry_t;
 
 /**

test/nanostack/unittest/6LoWPAN/ws_llc_data_service/Makefile

@@ -29,6 +29,7 @@ TEST_SRC_FILES = \
         ../../stub/mac_ie_lib_stub.c \
         ../../stub/ws_ie_lib_stub.c \
         ../../stub/ws_bootstrap_stub.c \
+        ../../stub/ws_common_stub.c \
         ../../stub/ws_mpx_header_stub.c \
         ../../stub/ws_neighbour_class_stub.c \
         ../../stub/ws_pae_controller_stub.c \

test/nanostack/unittest/stub/ws_common_stub.c

@@ -15,6 +15,7 @@
  * limitations under the License.
  */
 
+#include <string.h>
 #include "nsconfig.h"
 #include "ns_types.h"
 #include "ns_trace.h"

test/nanostack/unittest/stub/ws_ie_lib_stub.c

@@ -216,3 +216,14 @@ uint8_t *ws_wp_nested_lfn_version_write(uint8_t *ptr, struct ws_lfnver_ie *ws_lf
     ptr += 2 + 2;
     return ptr;
 }
+
+uint16_t ws_wp_nested_pcap_length(uint8_t list_length)
+{
+    return 1;
+}
+
+uint8_t *ws_wp_nested_pcap_write(uint8_t *ptr, struct ws_phy_cap_info *pcap_list)
+{
+    ptr += 2 + 1;
+    return ptr;
+}

test/nanostack/unittest/stub/ws_neighbour_class_stub.c

@@ -22,6 +22,9 @@
 #include "ns_trace.h"
 #include "nsdynmemLIB.h"
 #include "6LoWPAN/ws/ws_neighbor_class.h"
+#include "6LoWPAN/ws/ws_ie_lib.h"
+#include "ws_management_api.h"
+#include "mac_api.h"
 #include "ws_neighbour_class_stub.h"
 
 ws_neighbor_stub_def ws_neighbor_stub;