MAC enhanced ACK RX and TX support

MAC extension for update: callback for request payload for Enhanced ACK.

ACK Build without security and Receive support

Enabled new MCPS data conform extension for indicate Enhanced ACK data.

Change-Id: I97bea8bf3caa9cfffa3593c45ac29beeb2e461ef

Author: Juha Heiskanen

nanostack/mac_api.h

@@ -172,6 +172,16 @@ typedef void mcps_data_indication(const mac_api_t* api, const mcps_data_ind_t *d
  */
 typedef void mcps_data_indication_ext(const mac_api_t* api, const mcps_data_ind_t *data, const mcps_data_ie_list_t *ie_ext);
 
+/**
+ * @brief mcps_ack_data_req_ext Callback for request IE elements and payload to enhanced ACK
+ * @param api The API which handled the response
+ * @param data Pointer where MAC user set Payload and IE element pointers and length
+ * @param rssi Signal strength for received packet
+ * @param lqi Link quality to neighbor
+ */
+typedef void mcps_ack_data_req_ext(const mac_api_t* api, mcps_ack_data_payload_t *data, int8_t rssi, uint8_t lqi);
+
+
 /**
  * @brief mcps_purge_confirm MCPS-PURGE confirm is called as a response to MCPS-PURGE request
  * @param api The API which handled the request
@@ -235,11 +245,13 @@ typedef int8_t mac_api_initialize(mac_api_t *api, mcps_data_confirm *data_conf_c
  * @param api mac_api_t pointer, which is created by application.
  * @param data_ind_cb Upper layer function to handle MCPS indications
  * @param data_cnf_cb Upper layer function to handle MCPS confirmation
+ * @param ack_data_req_cb Upper layer function for set Enhanced ACK payload
  * @return -1 if error, -2 if OOM, 0 otherwise
  */
 typedef int8_t mac_api_enable_mcps_ext(mac_api_t *api,
                                        mcps_data_indication_ext *data_ind_cb,
-                                       mcps_data_confirm_ext *data_cnf_cb);
+                                       mcps_data_confirm_ext *data_cnf_cb,
+                                       mcps_ack_data_req_ext *ack_data_req_cb);
 
 /**
  * \brief Struct mac_api_s defines functions for two-way communications between external MAC and Upper layer.
@@ -261,6 +273,7 @@ struct mac_api_s {
     mcps_data_confirm_ext       *data_conf_ext_cb;              /**< MAC MCPS data confirm with payload callback function */
     mcps_data_indication        *data_ind_cb;                   /**< MAC MCPS data indication callback function */
     mcps_data_indication_ext    *data_ind_ext_cb;               /**< MAC MCPS data indication with IE extension's callback function */
+    mcps_ack_data_req_ext       *enhanced_ack_data_req_cb;      /**< Enhanced ACK IE element and payload request from MAC user */
     mcps_purge_confirm          *purge_conf_cb;                 /**< MAC MCPS purge confirm callback function */
     mlme_confirm                *mlme_conf_cb;                  /**< MAC MLME confirm callback function */
     mlme_indication             *mlme_ind_cb;                   /**< MAC MLME indication callback function */

nanostack/mac_mcps.h

@@ -25,6 +25,7 @@
 #include <inttypes.h>
 #include "mac_common_defines.h"
 
+
 /**
  * @brief struct mcps_data_req_t Data request structure
  *
@@ -74,6 +75,7 @@ typedef struct mcps_data_conf_payload_s {
     uint16_t payloadLength;             /**< Payload length in bytes */
 } mcps_data_conf_payload_t;
 
+
 /**
  * @brief struct mcps_data_ind_t Data indication structure
  *
@@ -133,6 +135,15 @@ typedef struct mcps_data_req_ie_list {
 } mcps_data_req_ie_list_t;
 
 
+/**
+ * @brief struct mcps_ack_data_payload_t IE extension list and payload for enhanced ACK
+ *
+ */
+typedef struct mcps_ack_data_payload {
+    struct mcps_data_req_ie_list ie_elements;   /**< IE hader and payload's elements */
+    uint8_t *payloadPtr;                        /**< Ack payload pointer */
+    uint16_t payloadLength;                     /**< Payload length in bytes */
+} mcps_ack_data_payload_t;
 
 /**
  * @brief struct mcps_purge_t Purge request structure

nanostack/platform/arm_hal_phy.h

@@ -120,7 +120,7 @@ typedef struct phy_signal_info_s {
 
 /** CSMA-CA parameters */
 typedef struct phy_csma_params {
-    uint32_t symbol_backoff_time;    /**< CSMA Backoff symbol time before start CCA & TX. */
+    uint32_t symbol_backoff_time;    /**< CSMA Backoff symbol time before start CCA & TX. 0 should disable current backoff*/
     bool cca_enabled;                /**< True will affect CCA check false start TX direct after backoff */
 } phy_csma_params_t;
 

source/6LoWPAN/ws/ws_llc_data_service.c

@@ -100,6 +100,8 @@ typedef struct {
     ws_asynch_ind                   *asynch_ind;                    /**< LLC Asynch data indication call back configured by user */
     ws_asynch_confirm               *asynch_confirm;                /**< LLC Asynch data confirmation call back configured by user */
     ws_neighbor_info_request        *ws_neighbor_info_request_cb;   /**< LLC Neighbour discover API*/
+    uint8_t                         ws_enhanced_ack_elements[WH_IE_ELEMENT_HEADER_LENGTH + 4 + WH_IE_ELEMENT_HEADER_LENGTH + 1];
+    ns_ie_iovec_t                   ws_header_vector;
     protocol_interface_info_entry_t *interface_ptr;                 /**< List link entry */
     ns_list_link_t                  link;                           /**< List link entry */
 } llc_data_base_t;
@@ -421,6 +423,27 @@ static void ws_llc_mac_confirm_cb(const mac_api_t* api, const mcps_data_conf_t *
 
 }
 
+static void ws_llc_ack_data_req_ext(const mac_api_t* api, mcps_ack_data_payload_t *data, int8_t rssi, uint8_t lqi)
+{
+    llc_data_base_t *base = ws_llc_discover_by_mac(api);
+    if (!base) {
+        return;
+    }
+    /* Init all by zero */
+    memset(data, 0, sizeof(mcps_ack_data_payload_t));
+    //Add just 2 header elements to inside 1 block
+    data->ie_elements.headerIeVectorList = &base->ws_header_vector;
+    base->ws_header_vector.ieBase = base->ws_enhanced_ack_elements;
+    base->ws_header_vector.iovLen = sizeof(base->ws_enhanced_ack_elements);
+    data->ie_elements.headerIovLength = 1;
+
+    //Write Data to block
+    uint8_t *ptr = base->ws_enhanced_ack_elements;
+    ptr = ws_wh_utt_write(ptr, WS_FT_ACK);
+    uint8_t rsl = ws_neighbor_class_rssi_from_dbm_calculate(rssi);
+    ws_wh_rsl_write(ptr, rsl);
+}
+
 /** WS LLC MAC data extension indication  */
 static void ws_llc_mac_indication_cb(const mac_api_t* api, const mcps_data_ind_t *data, const mcps_data_ie_list_t *ie_ext)
 {
@@ -745,7 +768,7 @@ int8_t ws_llc_create(struct protocol_interface_info_entry *interface, ws_asynch_
     base->asynch_confirm = asynch_cnf_cb;
     base->ws_neighbor_info_request_cb = ws_neighbor_info_request_cb;
     //Register MAC Extensions
-    base->interface_ptr->mac_api->mac_mcps_extension_enable(base->interface_ptr->mac_api, &ws_llc_mac_indication_cb, &ws_llc_mac_confirm_cb);
+    base->interface_ptr->mac_api->mac_mcps_extension_enable(base->interface_ptr->mac_api, &ws_llc_mac_indication_cb, &ws_llc_mac_confirm_cb, &ws_llc_ack_data_req_ext);
     //Init MPX class
     ws_llc_mpx_init(&base->mpx_data_base);
     return 0;
@@ -762,7 +785,7 @@ int8_t ws_llc_delete(struct protocol_interface_info_entry *interface)
 
     ns_list_remove(&llc_data_base_list, base);
     //Disable Mac extension
-    base->interface_ptr->mac_api->mac_mcps_extension_enable(base->interface_ptr->mac_api, NULL, NULL);
+    base->interface_ptr->mac_api->mac_mcps_extension_enable(base->interface_ptr->mac_api, NULL, NULL, NULL);
     ns_dyn_mem_free(base);
     return 0;
 }

source/MAC/IEEE802_15_4/mac_defines.h

@@ -140,6 +140,8 @@ typedef struct protocol_interface_rf_mac_setup {
     bool shortAdressValid: 1;   //Define Dynamic src address to mac16 when it is true
     bool beaconSrcAddressModeLong: 1; //This force beacon src to mac64 otherwise shortAdressValid will define type
     bool mac_extension_enabled:1;
+    bool mac_ack_tx_active:1;
+    bool mac_frame_pending:1;
     uint16_t mac_short_address;
     uint16_t pan_id;
     uint8_t mac64[8];

source/MAC/IEEE802_15_4/mac_header_helper_functions.c

@@ -107,7 +107,7 @@ bool mac_src_panid_present(const mac_fcf_sequence_t *header)
     return presents;
 }
 
-static uint8_t mac_address_length(uint8_t address_mode)
+uint8_t mac_address_length(uint8_t address_mode)
 {
     uint8_t length = 0;
     switch (address_mode) {
@@ -252,6 +252,10 @@ const uint8_t * mac_header_parse_fcf_dsn(mac_fcf_sequence_t *header, const uint8
     if (header->frameVersion == MAC_FRAME_VERSION_2015 ) {
         header->sequenceNumberSuppress = ((fcf & MAC_FCF_SEQ_NUM_SUPPRESS_MASK ) >> MAC_FCF_SEQ_NUM_SUPPRESS_SHIFT);
         header->informationElementsPresets = ((fcf & MAC_FCF_IE_PRESENTS_MASK ) >> MAC_FCF_IE_PRESENTS_SHIFT);
+    } else {
+        //SET False to ALL 2015 Extension's by default
+        header->sequenceNumberSuppress = false;
+        header->informationElementsPresets = false;
     }
 
     if (header->frameVersion < MAC_FRAME_VERSION_2015 || (header->frameVersion ==  MAC_FRAME_VERSION_2015 &&  !header->sequenceNumberSuppress)) {

source/MAC/IEEE802_15_4/mac_header_helper_functions.h

@@ -59,6 +59,7 @@ uint16_t mac_header_get_src_panid(const struct mac_fcf_sequence_s *header, const
 uint16_t mac_header_get_dst_panid(const struct mac_fcf_sequence_s *header, const uint8_t *ptr);
 void mac_header_get_src_address(const struct mac_fcf_sequence_s *header, const uint8_t *ptr, uint8_t *address_ptr);
 void mac_header_get_dst_address(const struct mac_fcf_sequence_s *header, const uint8_t *ptr, uint8_t *address_ptr);
+uint8_t mac_address_length(uint8_t address_mode);
 uint8_t mcps_mac_header_length_from_received_frame(const struct mac_pre_parsed_frame_s *buffer);
 uint32_t mcps_mac_security_frame_counter_read(const struct mac_pre_parsed_frame_s *buffer);
 uint8_t mcps_mac_command_frame_id_get(const struct mac_pre_parsed_frame_s *buffer);

source/MAC/IEEE802_15_4/mac_indirect_data.c

@@ -55,6 +55,7 @@ void mac_indirect_data_ttl_handle(protocol_interface_rf_mac_setup_s *cur, uint16
         if( dev_driver && dev_driver->extension ){
             dev_driver->extension(PHY_EXTENSION_CTRL_PENDING_BIT, &value);
         }
+        cur->mac_frame_pending = false;
         return;
     }
     mac_pre_build_frame_t *buf, *buf_prev = 0, *buf_temp = 0;
@@ -222,6 +223,7 @@ void mac_indirect_queue_write(protocol_interface_rf_mac_setup_s *rf_mac_setup, m
         //Trig timer and set pending flag to radio
         eventOS_callback_timer_stop(rf_mac_setup->mac_mcps_timer);
         eventOS_callback_timer_start(rf_mac_setup->mac_mcps_timer, MAC_INDIRECT_TICK_IN_MS * 20);
+        rf_mac_setup->mac_frame_pending = true;
         if (rf_mac_setup->dev_driver->phy_driver->extension)
         {
             uint8_t value = 1;