Extented Frame exchange support

Added support send Extented frame exchange when MAC ack functionality is disabled and mac user handle those.

MAC-API have new API for enable new feature and add Callback for detect Extented Data flow packet and send responses.

MAC support only 1 active EDFE Data request.

Wi-sun DSN duplicate check is disabled for EFDE frames.

Wi-sun EFDE TX process do allways full handshake which not add data to initial frame.

Fix unit test's.

Author: Juha Heiskanen

nanostack/mac_api.h

@@ -183,6 +183,14 @@ typedef void mcps_data_indication_ext(const mac_api_t *api, const mcps_data_ind_
 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_edfe_handler Callback for handle and detect edfe frame
+ * @param api The API which handled the response
+ * @param response_message Enhanced message response data and status
+ */
+typedef void mcps_edfe_handler(const mac_api_t *api, mcps_edfe_response_t *response_message);
+
+
 /**
  * @brief mcps_purge_confirm MCPS-PURGE confirm is called as a response to MCPS-PURGE request
  * @param api The API which handled the request
@@ -254,6 +262,15 @@ typedef int8_t mac_api_enable_mcps_ext(mac_api_t *api,
                                        mcps_data_confirm_ext *data_cnf_cb,
                                        mcps_ack_data_req_ext *ack_data_req_cb);
 
+/**
+ * @brief mac_api_enable_mcps_edfe_ext Initialises MAC 2015 extension for EDFE handler callbacks must be non-NULL.
+ * @param api mac_api_t pointer, which is created by application.
+ * @param edfe_ind_cb Upper layer function to handle and detect EDFE's
+ * @return -1 if error, -2 if OOM, 0 otherwise
+ */
+typedef int8_t mac_api_enable_mcps_edfe_ext(mac_api_t *api,
+                                            mcps_edfe_handler *edfe_ind_cb);
+
 /**
  * \brief Struct mac_api_s defines functions for two-way communications between external MAC and Upper layer.
  * Application creates mac_api_t object by calling external MAC's creator function.
@@ -263,17 +280,18 @@ typedef int8_t mac_api_enable_mcps_ext(mac_api_t *api,
 struct mac_api_s {
     mac_api_initialize          *mac_initialize;                /**< MAC initialize function to use */
     mac_api_enable_mcps_ext     *mac_mcps_extension_enable;     /**< MAC MCPS IE extension enable function, optional feature */
+    mac_api_enable_mcps_edfe_ext *mac_mcps_edfe_enable;         /**< MAC MCPS MCPS EDFE frame extension enable function, optional feature */
     //External MAC callbacks
     mlme_request                *mlme_req;                      /**< MAC MLME request function to use */
     mcps_data_request           *mcps_data_req;                 /**< MAC MCPS data request function to use */
     mcps_data_request_ext       *mcps_data_req_ext;             /**< MAC MCPS data request with Information element extension function to use */
     mcps_purge_request          *mcps_purge_req;                /**< MAC MCPS purge request function to use */
-
     //Upper layer callbacksMLME_ASSOCIATE
     mcps_data_confirm           *data_conf_cb;                  /**< MAC MCPS data confirm callback function */
     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_edfe_handler           *edfe_ind_cb;                   /**< MAC MCPS EDFE detection 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 */

nanostack/mac_mcps.h

@@ -44,6 +44,7 @@ typedef struct mcps_data_req_s {
     bool PendingBit: 1;             /**< Specifies whether more fragments are to be sent or not */
     bool SeqNumSuppressed: 1;       /**< True suppress sequence number from frame. This will be only checked when 2015 extension is enabled */
     bool PanIdSuppressed: 1;        /**< True suppress PAN-id is done when possible from frame. This will be only checked when 2015 extension is enabled */
+    bool ExtendedFrameExchange: 1;  /**< True for Extended Frame change. This will be only checked when 2015 extension and enhanced frame is enabled */
     mlme_security_t Key;            /**< Security key */
 } mcps_data_req_t;
 
@@ -86,6 +87,7 @@ typedef struct mcps_data_ind_s {
     uint16_t SrcPANId;          /**< Source PAN ID */
     uint8_t SrcAddr[8];         /**< Source address */
     unsigned DstAddrMode: 2;    /**< Destination address mode */
+    bool DSN_suppressed: 1;     /**< Indicate when DSN not include valid sequency id */
     uint16_t DstPANId;          /**< Destination PAN ID */
     uint8_t DstAddr[8];         /**< Destination address */
     uint8_t mpduLinkQuality;    /**< LQI value measured during reception of the MPDU */
@@ -164,5 +166,31 @@ typedef struct mcps_purge_conf_s {
     uint8_t status;             /**< Status of the purge performed */
 } mcps_purge_conf_t;
 
+#define MCPS_EDFE_NORMAL_FRAME 0    /**< Normal Data message normal behaviour */
+#define MCPS_EDFE_MALFORMED_FRAME 1 /**< Drop whole packet */
+#define MCPS_EDFE_TX_FRAME  2       /**< Tx message send data if pending in 1ms -5ms time window */
+#define MCPS_EDFE_RESPONSE_FRAME 3  /**< Response message send data if pending in 1ms -5ms time window */
+#define MCPS_EDFE_FINAL_FRAME_TX 4  /**< Final response message send in 1ms -5ms time window */
+#define MCPS_EDFE_FINAL_FRAME_RX 5  /**< EDFE session can be close at MAC side and drop this packet */
+
+/**
+ * @brief struct mcps_edfe_response_t EDFE detetction and response structure
+ *
+ */
+typedef struct mcps_edfe_response_s {
+    struct mcps_data_ie_list ie_elements;   /**< IE hader and payload's elements from Packet */
+    struct mcps_data_req_ie_list ie_response; /**< IE hader and payload's elements for Response Packet */
+    uint8_t edfe_message_status; /**< Indicate Packet handler status */
+    uint8_t message_handle; /**< EDFE Data request message ID for detect pending data at LLC layer*/
+    int8_t rssi;    /**< Received packet signal streng in dbm */
+    unsigned SrcAddrMode: 2;        /**< Source address mode: used for RX validation and TX purpose */
+    unsigned DstAddrMode: 2;        /**< Destination address mode: used for RX validation and TX purpose */
+    uint8_t Address[8];             /**< RX: Packet Address Src & TX Response Destination address */
+    bool SeqNumSuppressed: 1;       /**< True suppress sequence number from frame. This will be only checked when 2015 extension is enabled */
+    bool PanIdSuppressed: 1;        /**< True suppress PAN-id is done when possible from frame.  */
+    bool wait_response: 1;          /**< True enable response wait timer and re-send operation.  */
+    bool use_message_handle_to_discover: 1; /**< EDFE Data request message ID is valid at message_handle.  */
+} mcps_edfe_response_t;
+
 
 #endif // MAC_MCPS_H

source/6LoWPAN/adaptation_interface.c

@@ -938,6 +938,7 @@ static void lowpan_data_request_to_mac(protocol_interface_info_entry_t *cur, buf
     }
 
     if (interface_ptr->mpx_api) {
+        dataReq.ExtendedFrameExchange = buf->options.edfe_mode;
         interface_ptr->mpx_api->mpx_data_request(interface_ptr->mpx_api, &dataReq, interface_ptr->mpx_user_id);
     } else {
         cur->mac_api->mcps_data_req(cur->mac_api, &dataReq);

source/6LoWPAN/ws/ws_common_defines.h

@@ -130,6 +130,13 @@ typedef struct ws_bt_ie {
     uint_fast24_t broadcast_interval_offset;
 } ws_bt_ie_t;
 
+/**
+ * @brief ws_fc_ie_t WS FC-IE element
+ */
+typedef struct ws_fc_ie {
+    uint8_t tx_flow_ctrl;
+    uint8_t rx_flow_ctrl;
+} ws_fc_ie_t;
 
 /**
  * @brief ws_channel_plan_zero_t WS channel plan 0 define domain and class

source/6LoWPAN/ws/ws_ie_lib.c

@@ -110,10 +110,11 @@ uint8_t *ws_wh_bt_write(uint8_t *ptr)
 }
 
 
-uint8_t *ws_wh_fc_write(uint8_t *ptr, uint8_t flow_ctrl)
+uint8_t *ws_wh_fc_write(uint8_t *ptr, ws_fc_ie_t *fc_ie)
 {
-    ptr = ws_wh_header_base_write(ptr, 1, WH_IE_FC_TYPE);
-    *ptr++ = flow_ctrl;
+    ptr = ws_wh_header_base_write(ptr, 2, WH_IE_FC_TYPE);
+    *ptr++ = fc_ie->tx_flow_ctrl;
+    *ptr++ = fc_ie->rx_flow_ctrl;
     return ptr;
 }
 
@@ -341,6 +342,19 @@ bool ws_wh_bt_read(uint8_t *data, uint16_t length, struct ws_bt_ie *bt_ie)
     return true;
 }
 
+bool ws_wh_fc_read(uint8_t *data, uint16_t length, struct ws_fc_ie *fc_ie)
+{
+    mac_header_IE_t fc_ie_data;
+    fc_ie_data.id = MAC_HEADER_ASSIGNED_EXTERNAL_ORG_IE_ID;
+    if (2 != mac_ie_header_sub_id_discover(data, length, &fc_ie_data, WH_IE_FC_TYPE)) {
+        return false;
+    }
+    data = fc_ie_data.content_ptr;
+    fc_ie->tx_flow_ctrl = *data++;
+    fc_ie->rx_flow_ctrl = *data;
+    return true;
+}
+
 bool ws_wh_rsl_read(uint8_t *data, uint16_t length, int8_t *rsl)
 {
     mac_header_IE_t rsl_ie_data;

source/6LoWPAN/ws/ws_ie_lib.h

@@ -23,6 +23,7 @@ struct ws_utt_ie;
 struct ws_bt_ie;
 struct ws_us_ie;
 struct ws_hopping_schedule_s;
+struct ws_fc_ie;
 
 /**
  * @brief ws_wp_network_name_t WS nested payload network name
@@ -35,13 +36,14 @@ typedef struct ws_wp_network_name {
 /* WS_WH HEADER IE */
 uint8_t *ws_wh_utt_write(uint8_t *ptr, uint8_t message_type);
 uint8_t *ws_wh_bt_write(uint8_t *ptr);
-uint8_t *ws_wh_fc_write(uint8_t *ptr, uint8_t flow_ctrl);
+uint8_t *ws_wh_fc_write(uint8_t *ptr, struct ws_fc_ie *fc_ie);
 uint8_t *ws_wh_rsl_write(uint8_t *ptr, uint8_t rsl);
 uint8_t *ws_wh_vh_write(uint8_t *ptr, uint8_t *vendor_header, uint8_t vendor_header_length);
 uint8_t *ws_wh_ea_write(uint8_t *ptr, uint8_t *eui64);
 
 bool ws_wh_utt_read(uint8_t *data, uint16_t length, struct ws_utt_ie *utt_ie);
 bool ws_wh_bt_read(uint8_t *data, uint16_t length, struct ws_bt_ie *bt_ie);
+bool ws_wh_fc_read(uint8_t *data, uint16_t length, struct ws_fc_ie *fc_ie);
 bool ws_wh_rsl_read(uint8_t *data, uint16_t length, int8_t *rsl);
 bool ws_wh_ea_read(uint8_t *data, uint16_t length, uint8_t *eui64);