Enhanced ACK GEN and TX update

Added verification that securd enhanced ACK isonly sended to device
which is at device table.

Seperated ACK build and buffer init  functionality to own function.

Change-Id: Ib8bda4117b4754a52b5fa0a1c11d1b7bc6e0f876

Author: Juha Heiskanen

source/MAC/IEEE802_15_4/mac_data_buffer.h

@@ -0,0 +1,105 @@
+/*
+ * Copyright (c) 2019, 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 MAC_DATA_BUFFER_H_
+#define MAC_DATA_BUFFER_H_
+
+#include "mac_mcps.h"
+
+/**
+ * @brief struct mac_aux_security_header_t MAC auxiliarity security header structure
+ * INTERNAL use only
+ */
+typedef struct mac_aux_security_header_s {
+    uint32_t frameCounter;
+    uint8_t Keysource[8];
+    uint8_t KeyIndex;
+    unsigned securityLevel: 3;
+    unsigned KeyIdMode: 2;
+} mac_aux_security_header_t;
+
+typedef struct mac_fcf_sequence_s {
+    unsigned frametype: 3;
+    bool securityEnabled: 1;
+    bool framePending : 1;
+    bool ackRequested: 1;
+    bool intraPan: 1;
+    bool sequenceNumberSuppress: 1;
+    bool informationElementsPresets: 1;
+    bool DstPanPresents: 1;
+    bool SrcPanPresents: 1;
+    unsigned DstAddrMode: 2; /*0x00 = no address 0x01 = reserved 0x02 = 16-bit short address 0x03 = 64-bit extended address */
+    unsigned frameVersion: 2;
+    unsigned SrcAddrMode: 2; /*0x00 = no address 0x01 = reserved 0x02 = 16-bit short address 0x03 = 64-bit extended address */
+    uint8_t DSN;
+} mac_fcf_sequence_t;
+
+typedef struct mac_pre_parsed_frame_s {
+    void *mac_class_ptr;
+    uint8_t *payloadsIePtr;
+    uint8_t *headerIePtr;
+    uint8_t *macPayloadPtr;
+    mlme_device_descriptor_t *neigh_info;
+    uint32_t timestamp;
+    mac_fcf_sequence_t fcf_dsn;
+    uint16_t frameLength; //Encoded or open payload length
+    uint16_t payloadsIeLength;
+    uint16_t headerIeLength;
+    uint16_t mac_header_length;
+    uint16_t header_ie_length;
+    uint16_t mac_payload_length;
+    uint8_t security_aux_header_length;
+    uint8_t LQI;
+    int8_t dbm;
+    bool ack_pendinfg_status;
+    uint8_t buf[]; /*!< Trailing buffer data */
+} mac_pre_parsed_frame_t;
+
+typedef struct mac_pre_build_frame {
+    mac_fcf_sequence_t fcf_dsn;
+    uint16_t DstPANId;
+    uint8_t DstAddr[8];
+    uint16_t SrcPANId;
+    uint8_t SrcAddr[8];
+    mac_aux_security_header_t aux_header;
+    uint8_t mac_command_id; //For MLME
+    uint16_t payloadsIeLength;
+    uint16_t headerIeLength;
+    uint16_t mac_payload_length;
+    uint16_t mac_header_length_with_security;
+    uint8_t msduHandle;
+    uint16_t buffer_ttl;
+    struct mcps_data_req_ie_list ie_elements;
+    struct channel_list_s asynch_channel_list;
+    uint8_t *mac_payload;
+    uint8_t status;
+    uint8_t asynch_channel;
+    uint8_t csma_periods_left;
+    uint8_t fhss_retry_count;
+    uint8_t fhss_cca_retry_count;
+    uint32_t tx_time;
+    bool upper_layer_request: 1;
+    bool mac_allocated_payload_ptr: 1;
+    bool asynch_request: 1;
+    bool message_builded: 1;
+    unsigned security_mic_len: 5;   //Max possible lengths 0, 4, 8, 16 bytes
+    unsigned priority: 2;
+    struct mac_pre_build_frame *next; //Pointer for queue purpose
+} mac_pre_build_frame_t;
+
+
+#endif /* MAC_DATA_BUFFER_H_ */

source/MAC/IEEE802_15_4/mac_defines.h

@@ -20,6 +20,7 @@
 
 #include "eventOS_event.h"
 #include "mlme.h"
+#include "mac_data_buffer.h"
 #include "ns_list.h"
 
 struct cca_structure_s;
@@ -186,6 +187,7 @@ typedef struct protocol_interface_rf_mac_setup {
     bool macBroadcastDisabled: 1;
     bool scan_active: 1;
     bool rf_csma_extension_supported: 1;
+    bool ack_tx_possible: 1;
     /* CSMA Params */
     unsigned macMinBE: 4;
     unsigned macMaxBE: 4;
@@ -224,6 +226,8 @@ typedef struct protocol_interface_rf_mac_setup {
     uint16_t multi_cca_interval;        /**< Length of the additional CSMA-CA period(s) in microseconds */
     /* Indirect queue parameters */
     struct mac_pre_build_frame *indirect_pd_data_request_queue;
+    struct mac_pre_build_frame enhanced_ack_buffer;
+    uint32_t enhanced_ack_handler_timestamp;
     arm_event_t mac_mcps_timer_event;
     uint16_t indirect_pending_bytes;
     arm_nwk_mlme_event_type_e mac_mlme_event;

source/MAC/IEEE802_15_4/mac_filter.c

@@ -25,7 +25,7 @@
 #include "mac_filter_api.h"
 #include "mac_filter.h"
 #include "mac_common_defines.h"
-
+#include "mac_defines.h"
 #include "mac_mcps.h"
 #include "MAC/IEEE802_15_4/mac_mcps_sap.h"
 #include "MAC/IEEE802_15_4/mac_header_helper_functions.h"

source/MAC/IEEE802_15_4/mac_mcps_sap.c

@@ -83,7 +83,7 @@ static ns_mem_heap_size_t ns_dyn_mem_rate_limiting_threshold = 0xFFFFFFFF;
  * \return Timestamp from PHY
  *
  */
-static uint32_t mac_mcps_sap_get_phy_timestamp(protocol_interface_rf_mac_setup_s *rf_mac_setup)
+uint32_t mac_mcps_sap_get_phy_timestamp(protocol_interface_rf_mac_setup_s *rf_mac_setup)
 {
     uint32_t timestamp;
     rf_mac_setup->dev_driver->phy_driver->extension(PHY_EXTENSION_GET_TIMESTAMP, (uint8_t *)&timestamp);
@@ -1589,15 +1589,12 @@ static int8_t mcps_generic_packet_build(protocol_interface_rf_mac_setup_s *rf_pt
     return 0;
 }
 
-int8_t mcps_generic_ack_build(protocol_interface_rf_mac_setup_s *rf_ptr, const mac_fcf_sequence_t *fcf, const uint8_t *data_ptr, const mcps_ack_data_payload_t *ack_payload)
+int8_t mcps_generic_ack_data_request_init(protocol_interface_rf_mac_setup_s *rf_ptr, const mac_fcf_sequence_t *fcf, const uint8_t *data_ptr, const mcps_ack_data_payload_t *ack_payload)
 {
-    phy_device_driver_s *dev_driver = rf_ptr->dev_driver->phy_driver;
-    dev_driver_tx_buffer_s *tx_buf = &rf_ptr->dev_driver_tx_buffer;
-
-    ccm_globals_t ccm_ptr;
+    mac_pre_build_frame_t *buffer = &rf_ptr->enhanced_ack_buffer;
+    //save timestamp
+    rf_ptr->enhanced_ack_handler_timestamp = mac_mcps_sap_get_phy_timestamp(rf_ptr);
 
-    mac_pre_build_frame_t pd_act_buf;
-    mac_pre_build_frame_t *buffer = &pd_act_buf;
     memset(buffer, 0, sizeof(mac_pre_build_frame_t));
     buffer->fcf_dsn.frametype = FC_ACK_FRAME;
     buffer->fcf_dsn.frameVersion = fcf->frameVersion;
@@ -1609,6 +1606,7 @@ int8_t mcps_generic_ack_build(protocol_interface_rf_mac_setup_s *rf_ptr, const m
     buffer->fcf_dsn.SrcAddrMode = fcf->DstAddrMode;
     buffer->fcf_dsn.SrcPanPresents = fcf->SrcPanPresents;
     buffer->fcf_dsn.DstAddrMode = fcf->SrcAddrMode;
+
     if (buffer->fcf_dsn.sequenceNumberSuppress) {
         buffer->mac_header_length_with_security = 2;
     } else {
@@ -1642,8 +1640,6 @@ int8_t mcps_generic_ack_build(protocol_interface_rf_mac_setup_s *rf_ptr, const m
 
     }
 
-
-    //TODO Request Application data to ACK
     uint16_t ie_header_length = 0;
     uint16_t ie_payload_length = 0;
 
@@ -1666,15 +1662,31 @@ int8_t mcps_generic_ack_build(protocol_interface_rf_mac_setup_s *rf_ptr, const m
 
     //This will prepare MHR length with Header IE
     mac_header_information_elements_preparation(buffer);
+    return 0;
+}
+
+
+int8_t mcps_generic_ack_build(protocol_interface_rf_mac_setup_s *rf_ptr, bool init_build)
+{
+    phy_device_driver_s *dev_driver = rf_ptr->dev_driver->phy_driver;
+    dev_driver_tx_buffer_s *tx_buf = &rf_ptr->dev_driver_tx_buffer;
+
+    ccm_globals_t ccm_ptr;
+    mac_pre_build_frame_t *buffer = &rf_ptr->enhanced_ack_buffer;
+
 
     if (buffer->fcf_dsn.securityEnabled) {
         //Remember to update security counter here!
-        buffer->aux_header.frameCounter = mac_mlme_framecounter_get(rf_ptr);
+        if (init_build) {
+            buffer->aux_header.frameCounter = mac_mlme_framecounter_get(rf_ptr);
+        }
         if (!mac_frame_security_parameters_init(&ccm_ptr, rf_ptr, buffer)) {
             return -2;
         }
-        //Increment security counter
-        mac_mlme_framecounter_increment(rf_ptr);
+        if (init_build) {
+            //Increment security counter
+            mac_mlme_framecounter_increment(rf_ptr);
+        }
     }
 
     //Calculate Payload length here with IE extension

source/MAC/IEEE802_15_4/mac_mcps_sap.h

@@ -27,12 +27,12 @@
 
 #include "mlme.h"
 #include "mac_common_defines.h"
+#include "mac_data_buffer.h"
 
 struct protocol_interface_rf_mac_setup;
 struct mcps_data_req_s;
 struct arm_phy_sap_msg_s;
 struct mcps_purge_s;
-struct mcps_data_ie_list;
 struct mcps_data_req_ie_list;
 struct channel_list_s;
 
@@ -62,88 +62,6 @@ typedef enum {
 // Interval between two CCA checks
 #define MAC_DEFAULT_CSMA_MULTI_CCA_INTERVAL 1000
 
-/**
- * @brief struct mac_aux_security_header_t MAC auxiliarity security header structure
- * INTERNAL use only
- */
-typedef struct mac_aux_security_header_s {
-    unsigned securityLevel: 3;
-    unsigned KeyIdMode: 2;
-    uint32_t frameCounter;
-    uint8_t Keysource[8];
-    uint8_t KeyIndex;
-} mac_aux_security_header_t;
-
-typedef struct mac_fcf_sequence_s {
-    unsigned frametype: 3;
-    bool securityEnabled: 1;
-    bool framePending : 1;
-    bool ackRequested: 1;
-    bool intraPan: 1;
-    bool sequenceNumberSuppress: 1;
-    bool informationElementsPresets: 1;
-    bool DstPanPresents: 1;
-    bool SrcPanPresents: 1;
-    unsigned DstAddrMode: 2; /*0x00 = no address 0x01 = reserved 0x02 = 16-bit short address 0x03 = 64-bit extended address */
-    unsigned frameVersion: 2;
-    unsigned SrcAddrMode: 2; /*0x00 = no address 0x01 = reserved 0x02 = 16-bit short address 0x03 = 64-bit extended address */
-    uint8_t DSN;
-} mac_fcf_sequence_t;
-
-typedef struct mac_pre_parsed_frame_s {
-    void *mac_class_ptr;
-    uint8_t *payloadsIePtr;
-    uint8_t *headerIePtr;
-    uint8_t *macPayloadPtr;
-    mlme_device_descriptor_t *neigh_info;
-    uint8_t LQI;
-    int8_t dbm;
-    mac_fcf_sequence_t fcf_dsn;
-    uint16_t frameLength; //Encoded or open payload length
-    uint16_t payloadsIeLength;
-    uint16_t headerIeLength;
-    uint16_t mac_header_length;
-    uint16_t header_ie_length;
-    uint8_t security_aux_header_length;
-    uint16_t mac_payload_length;
-    uint32_t timestamp;
-    bool ack_pendinfg_status;
-
-    uint8_t buf[]; /*!< Trailing buffer data */
-} mac_pre_parsed_frame_t;
-
-typedef struct mac_pre_build_frame {
-    mac_fcf_sequence_t fcf_dsn;
-    uint16_t DstPANId;
-    uint8_t DstAddr[8];
-    uint16_t SrcPANId;
-    uint8_t SrcAddr[8];
-    mac_aux_security_header_t aux_header;
-    uint8_t mac_command_id; //For MLME
-    uint16_t payloadsIeLength;
-    uint16_t headerIeLength;
-    uint16_t mac_payload_length;
-    uint16_t mac_header_length_with_security;
-    uint8_t msduHandle;
-    uint16_t buffer_ttl;
-    struct mcps_data_req_ie_list ie_elements;
-    struct channel_list_s asynch_channel_list;
-    uint8_t *mac_payload;
-    uint8_t status;
-    uint8_t asynch_channel;
-    uint8_t csma_periods_left;
-    uint8_t fhss_retry_count;
-    uint8_t fhss_cca_retry_count;
-    uint32_t tx_time;
-    bool upper_layer_request;
-    bool mac_allocated_payload_ptr: 1;
-    bool asynch_request: 1;
-    bool message_builded: 1;
-    unsigned security_mic_len: 5;   //Max possible lengths 0, 4, 8, 16 bytes
-    unsigned priority: 2;
-    struct mac_pre_build_frame *next; //Pointer for queue purpose
-} mac_pre_build_frame_t;
-
 
 void mac_generic_event_trig(uint8_t event_type, void *mac_ptr, bool low_latency);
 
@@ -214,8 +132,12 @@ uint8_t mcps_sap_purge_reg_handler(struct protocol_interface_rf_mac_setup *rf_ma
 
 int8_t mcps_pd_data_rebuild(struct protocol_interface_rf_mac_setup *rf_ptr, mac_pre_build_frame_t *buffer);
 
-int8_t mcps_generic_ack_build(struct protocol_interface_rf_mac_setup *rf_ptr, const mac_fcf_sequence_t *fcf, const uint8_t *data_ptr, const mcps_ack_data_payload_t *ack_payload);
+int8_t mcps_generic_ack_data_request_init(struct protocol_interface_rf_mac_setup *rf_ptr, const mac_fcf_sequence_t *fcf, const uint8_t *data_ptr, const mcps_ack_data_payload_t *ack_payload);
+
+int8_t mcps_generic_ack_build(struct protocol_interface_rf_mac_setup *rf_ptr, bool init_build);
 
 int mcps_packet_ingress_rate_limit_by_memory(uint8_t free_heap_percentage);
 
+uint32_t mac_mcps_sap_get_phy_timestamp(struct protocol_interface_rf_mac_setup *rf_mac_setup);
+
 #endif /* MAC_IEEE802_15_4_MAC_MCPS_SAP_H_ */