Mac helper API update:

mac_helper_device_description_write() mle_neigh_table_entry_t replaced
by generic standard mlme_device_descriptor_t.

Added new function: mac_helper_device_description_write() which will
help to use updated mac_helper_device_description_write().

Integrated new API changes to code.

Author: Juha Heiskanen

source/6LoWPAN/MAC/mac_helper.c

@@ -25,7 +25,6 @@
 #include "net_nwk_scan.h"
 #include "ns_trace.h"
 #include "common_functions.h"
-#include "MLE/mle_tlv.h"
 #include "mac_api.h"
 
 #define TRACE_GROUP "MACh"
@@ -830,7 +829,16 @@ void mac_helper_devicetable_remove(mac_api_t *mac_api, uint8_t attribute_index)
     mac_api->mlme_req(mac_api,MLME_SET , &set_req);
 }
 
-void mac_helper_devicetable_set(mle_neigh_table_entry_t *entry_temp, protocol_interface_info_entry_t *cur, uint32_t frame_counter, uint8_t keyID)
+void mac_helper_device_description_write(protocol_interface_info_entry_t *cur, mlme_device_descriptor_t *device_desc, uint8_t *mac64, uint16_t mac16, uint32_t frame_counter, bool exempt)
+{
+    memcpy(device_desc->ExtAddress, mac64, 8);
+    device_desc->ShortAddress = mac16;
+    device_desc->PANId = mac_helper_panid_get(cur);
+    device_desc->Exempt = exempt;
+    device_desc->FrameCounter = frame_counter;
+}
+
+void mac_helper_devicetable_set(const mlme_device_descriptor_t *device_desc, protocol_interface_info_entry_t *cur, uint8_t attribute_index, uint8_t keyID)
 {
     if (!cur->mac_api) {
         return;
@@ -841,18 +849,10 @@ void mac_helper_devicetable_set(mle_neigh_table_entry_t *entry_temp, protocol_in
         return;
     }
 
-    mlme_device_descriptor_t device_desc;
     mlme_set_t set_req;
-    device_desc.FrameCounter = frame_counter;
-    device_desc.Exempt = false;
-    device_desc.ShortAddress = entry_temp->short_adr;
-    memcpy(device_desc.ExtAddress, entry_temp->mac64, 8);
-    device_desc.PANId = mac_helper_panid_get(cur);
-
-
     set_req.attr = macDeviceTable;
-    set_req.attr_index = entry_temp->attribute_index;
-    set_req.value_pointer = (void*)&device_desc;
+    set_req.attr_index = attribute_index;
+    set_req.value_pointer = (void*)device_desc;
     set_req.value_size = sizeof(mlme_device_descriptor_t);
     tr_debug("Register Device");
     cur->mac_api->mlme_req(cur->mac_api,MLME_SET , &set_req);

source/6LoWPAN/MAC/mac_helper.h

@@ -29,7 +29,6 @@ struct protocol_interface_info_entry;
 struct ns_sockaddr;
 struct buffer;
 struct mac_api_s;
-struct mle_neigh_table_entry_t;
 
 
 void mac_create_scan_request(mac_scan_type_t type, struct channel_list_s *chanlist, uint8_t scan_duration, struct mlme_scan_s *request);
@@ -110,7 +109,9 @@ int8_t mac_helper_link_frame_counter_set(int8_t interface_id, uint32_t seq_ptr);
 
 void mac_helper_devicetable_remove(struct mac_api_s *mac_api, uint8_t attribute_index);
 
-void mac_helper_devicetable_set(struct mle_neigh_table_entry_t *entry_temp, struct protocol_interface_info_entry *cur, uint32_t frame_counter, uint8_t keyID);
+void mac_helper_device_description_write(struct protocol_interface_info_entry *cur, mlme_device_descriptor_t *device_desc, uint8_t *mac64, uint16_t mac16, uint32_t frame_counter, bool exempt);
+
+void mac_helper_devicetable_set(const mlme_device_descriptor_t *device_dec, struct protocol_interface_info_entry *cur, uint8_t attribute_index, uint8_t keyID);
 
 int8_t mac_helper_mac_mlme_max_retry_set(int8_t interface_id, uint8_t mac_retry_set);
 

source/6LoWPAN/MAC/mac_pairwise_key.c

@@ -281,8 +281,9 @@ int mac_pairwise_key_add(int8_t interface_id, uint32_t valid_life_time, const ui
         return -1;
     }
 
-    //Set device descriptor
-    mac_helper_devicetable_set(mle_entry, interface, 0, interface->mac_parameters->mac_default_key_index);
+    mlme_device_descriptor_t device_desc;
+    mac_helper_device_description_write(interface, &device_desc, mle_entry->mac64, mle_entry->short_adr,0, false);
+    mac_helper_devicetable_set(&device_desc, interface,mle_entry->attribute_index, interface->mac_parameters->mac_default_key_index);
 
     //set key descriptor
     if (mac_helper_security_pairwisekey_set(interface, key, eui64, key_desc->key_decriptor_attribute) != 0) {

source/6LoWPAN/Thread/thread_host_bootstrap.c

@@ -172,7 +172,9 @@ static bool thread_parent_discover_timeout_cb(int8_t interface_id, uint16_t msgI
         thread_management_key_sets_calc(cur, linkConfiguration, cur->thread_info->thread_attach_scanned_parent->keySequence);
         thread_calculate_key_guard_timer(cur, linkConfiguration, true);
 
-        mac_helper_devicetable_set(entry_temp, cur, parent->linLayerFrameCounter, mac_helper_default_key_index_get(cur));
+        mlme_device_descriptor_t device_desc;
+        mac_helper_device_description_write(cur, &device_desc, entry_temp->mac64, entry_temp->short_adr,parent->linLayerFrameCounter, false);
+        mac_helper_devicetable_set(&device_desc, cur,entry_temp->attribute_index, mac_helper_default_key_index_get(cur));
         mle_entry_timeout_update(entry_temp, THREAD_DEFAULT_LINK_LIFETIME);
 
         if (cur->thread_info->thread_device_mode == THREAD_DEVICE_MODE_SLEEPY_END_DEVICE) {
@@ -343,7 +345,10 @@ static int thread_end_device_synch_response_validate(protocol_interface_info_ent
 
     mac_helper_coordinator_address_set(cur, ADDR_802_15_4_SHORT, shortAddress);
     mle_entry_timeout_update(entry_temp, thread_info(cur)->host_link_timeout);
-    mac_helper_devicetable_set(entry_temp, cur, llFrameCounter, securityHeader->KeyIndex);
+
+    mlme_device_descriptor_t device_desc;
+    mac_helper_device_description_write(cur, &device_desc, entry_temp->mac64, entry_temp->short_adr,llFrameCounter, false);
+    mac_helper_devicetable_set(&device_desc, cur, entry_temp->attribute_index, securityHeader->KeyIndex);
 
     thread_info(cur)->thread_attached_state = THREAD_STATE_CONNECTED;
     thread_bootstrap_update_ml16_address(cur, address16);
@@ -832,7 +837,10 @@ static void thread_mle_child_request_receive_cb(int8_t interface_id, mle_message
 
             mac_helper_coordinator_address_set(cur, ADDR_802_15_4_SHORT, shortAddress);
             mle_entry_timeout_update(entry_temp, thread_info(cur)->host_link_timeout);
-            mac_helper_devicetable_set(entry_temp, cur, scan_result->linLayerFrameCounter, security_headers->KeyIndex);
+
+            mlme_device_descriptor_t device_desc;
+            mac_helper_device_description_write(cur, &device_desc, entry_temp->mac64, entry_temp->short_adr,scan_result->linLayerFrameCounter, false);
+            mac_helper_devicetable_set(&device_desc, cur, entry_temp->attribute_index, security_headers->KeyIndex);
 
             thread_info(cur)->thread_attached_state = THREAD_STATE_CONNECTED;
 
@@ -941,7 +949,9 @@ void thread_endevice_synch_start(protocol_interface_info_entry_t *cur)
             mle_entry_timeout_update(entry_temp, 20);
 
             // Add the parent to the MAC table (for e.g. secured/fragmented Child Update Response)
-            mac_helper_devicetable_set(entry_temp, cur, 0, cur->mac_parameters->mac_default_key_index);
+            mlme_device_descriptor_t device_desc;
+            mac_helper_device_description_write(cur, &device_desc, entry_temp->mac64, entry_temp->short_adr,0, false);
+            mac_helper_devicetable_set(&device_desc, cur, entry_temp->attribute_index, cur->mac_parameters->mac_default_key_index);
         }
     }
 

source/6LoWPAN/Thread/thread_mle_message_handler.c

@@ -456,8 +456,9 @@ static void thread_parse_accept(protocol_interface_info_entry_t *cur, mle_messag
     entry_temp->mle_frame_counter = mleFrameCounter;
     // Set full data as REED needs full data and SED will not make links
     entry_temp->mode |= MLE_THREAD_REQ_FULL_DATA_SET;
-
-    mac_helper_devicetable_set(entry_temp, cur, llFrameCounter, security_headers->KeyIndex);
+    mlme_device_descriptor_t device_desc;
+    mac_helper_device_description_write(cur, &device_desc, entry_temp->mac64, entry_temp->short_adr,llFrameCounter, false);
+    mac_helper_devicetable_set(&device_desc, cur, entry_temp->attribute_index, security_headers->KeyIndex);
 
     if (entry_temp->timeout_rx) {
         mle_entry_timeout_refresh(entry_temp);

source/6LoWPAN/Thread/thread_network_synch.c

@@ -272,7 +272,9 @@ void thread_dynamic_storage_build_mle_table(int8_t interface_id)
 
             if (cur && cur->mac_parameters) {
                 // Set MAC layer frame counter for the child
-                mac_helper_devicetable_set(entry, cur, storeEntry->networ_dynamic_data_parameters.children[i].mac_frame_counter, cur->mac_parameters->mac_default_key_index);
+                mlme_device_descriptor_t device_desc;
+                mac_helper_device_description_write(cur, &device_desc, entry->mac64, entry->short_adr,storeEntry->networ_dynamic_data_parameters.children[i].mac_frame_counter, false);
+                mac_helper_devicetable_set(&device_desc, cur, entry->attribute_index, cur->mac_parameters->mac_default_key_index);
             }
         }
     }

source/6LoWPAN/Thread/thread_router_bootstrap.c

@@ -361,8 +361,8 @@ static void thread_router_synch_receive_cb(int8_t interface_id, mle_message_t *m
             //Free Response
             mle_service_msg_free(messageId);
             entry_temp->threadNeighbor = true;
-            mac_helper_devicetable_set(entry_temp, cur, llFrameCounter, security_headers->KeyIndex);
             entry_temp->short_adr = shortAddress;
+
             //when allocating neighbour entry, use MLE Frame counter if present to validate further advertisements from the neighbour
             entry_temp->mle_frame_counter = mleFrameCounter;
             if (entry_temp->timeout_rx) {
@@ -388,7 +388,9 @@ static void thread_router_synch_receive_cb(int8_t interface_id, mle_message_t *m
                 thread_routing_update_link_margin(cur, entry_temp->short_adr, linkMargin, linkMarginfronNeigh);
             }
 
-            mac_helper_devicetable_set(entry_temp, cur, llFrameCounter, security_headers->KeyIndex);
+            mlme_device_descriptor_t device_desc;
+            mac_helper_device_description_write(cur, &device_desc, entry_temp->mac64, entry_temp->short_adr,llFrameCounter, false);
+            mac_helper_devicetable_set(&device_desc, cur, entry_temp->attribute_index, security_headers->KeyIndex);
 
             //Copy Leader Data
             *cur->thread_info->thread_leader_data = leaderData;
@@ -1340,7 +1342,9 @@ void thread_router_bootstrap_child_id_handler(protocol_interface_info_entry_t *c
         }
     }
     if (new_neigbour) {
-        mac_helper_devicetable_set(entry_temp, cur, req->frameCounter, req->keyId);
+        mlme_device_descriptor_t device_desc;
+        mac_helper_device_description_write(cur, &device_desc, entry_temp->mac64, entry_temp->short_adr,req->frameCounter, false);
+        mac_helper_devicetable_set(&device_desc, cur, entry_temp->attribute_index, req->keyId);
     } else {
         // in get response handler this will update the short address from MLE table
         mlme_get_t get_req;
@@ -1863,7 +1867,9 @@ void thread_router_bootstrap_mle_receive_cb(int8_t interface_id, mle_message_t *
 
                     entry_temp->threadNeighbor = true;
                     entry_temp->short_adr = shortAddress;
-                    mac_helper_devicetable_set(entry_temp, cur, llFrameCounter, security_headers->KeyIndex);
+                    mlme_device_descriptor_t device_desc;
+                    mac_helper_device_description_write(cur, &device_desc, entry_temp->mac64, entry_temp->short_adr,llFrameCounter, false);
+                    mac_helper_devicetable_set(&device_desc, cur, entry_temp->attribute_index, security_headers->KeyIndex);
                     if (entry_temp->timeout_rx) {
                         mle_entry_timeout_refresh(entry_temp);
                     } else {

source/MLE/mle.c

@@ -787,8 +787,9 @@ bool mle_neigh_entry_frame_counter_update(mle_neigh_table_entry_t *entry_temp, u
     } else {
         frame_counter = common_read_32_bit(mle_tlv_info.dataPtr);
     }
-
-    mac_helper_devicetable_set(entry_temp, cur, frame_counter, key_id);
+    mlme_device_descriptor_t device_desc;
+    mac_helper_device_description_write(cur, &device_desc, entry_temp->mac64, entry_temp->short_adr,frame_counter, false);
+    mac_helper_devicetable_set(&device_desc, cur, entry_temp->attribute_index, key_id);
     return true;
 }
 

test/nanostack/unittest/6lp_mac/mac_helper/test_mac_helper.c

@@ -853,14 +853,18 @@ bool test_mac_helper_devicetable_set()
     api.mlme_req = &mlme_req;
     entry.mac_api = &api;
 
+    mlme_device_descriptor_t device_desc;
+    mac_helper_device_description_write(&entry, &device_desc, entry_temp.mac64, entry_temp.short_adr,10, false);
+
     entry.mac_parameters->SecurityEnabled = false;
 
-    mac_helper_devicetable_set(&entry_temp, &entry, 10, 1);
+
+    mac_helper_devicetable_set(&device_desc, &entry, entry_temp.attribute_index, 1);
 
     entry.mac_parameters->SecurityEnabled = true;
     entry.mac_parameters->mac_default_key_index = 2;
 
-    mac_helper_devicetable_set(&entry_temp, &entry, 10, 1);
+    mac_helper_devicetable_set(&device_desc, &entry, entry_temp.attribute_index, 1);
 
 
     return true;

test/nanostack/unittest/stub/mac_helper_stub.c

@@ -244,10 +244,16 @@ void mac_helper_devicetable_remove(struct mac_api_s *mac_api, uint8_t attribute_
 
 }
 
-void mac_helper_devicetable_set(mle_neigh_table_entry_t *entry_temp, protocol_interface_info_entry_t *cur, uint32_t frame_counter, uint8_t keyID)
+void mac_helper_device_description_write(struct protocol_interface_info_entry *cur, mlme_device_descriptor_t *device_desc, uint8_t *mac64, uint16_t mac16, uint32_t frame_counter, bool exempt)
 {
 
 }
+
+void mac_helper_devicetable_set(const mlme_device_descriptor_t *device_dec, protocol_interface_info_entry_t *cur, uint8_t attribute_index, uint8_t keyID)
+{
+
+}
+
 int8_t mac_helper_mac_mlme_max_retry_set(int8_t interface_id, uint8_t mac_retry_set)
 {