Merge pull request #14565 from artokin/nanostack_release_13_0_0_for_5_15_branch

[mbed-os-5.15] Nanostack release v13.0.0

Author: 0xc0170

components/802.15.4_RF/atmel-rf-driver/source/NanostackRfPhyAT86RF215.cpp

@@ -619,7 +619,7 @@ static void rf_handle_cca_ed_done(void)
             backup_time = 0;
         }
         rf_backup_timer_start(0, backup_time + PACKET_PROCESSING_TIME);
-        device_driver.phy_tx_done_cb(rf_radio_driver_id, mac_tx_handle, PHY_LINK_CCA_FAIL, 0, 0);
+        device_driver.phy_tx_done_cb(rf_radio_driver_id, mac_tx_handle, PHY_LINK_CCA_FAIL_RX, 0, 0);
         return;
     }
     if ((cca_enabled == true) && (((int8_t) rf_read_rf_register(RF_EDV, rf_module) > cca_threshold))) {
@@ -997,7 +997,7 @@ static void rf_backup_timer_interrupt(void)
     }
     if ((rf_state == RF_CSMA_STARTED) || (rf_state == RF_CSMA_WHILE_RX)) {
         TEST_CSMA_DONE
-        device_driver.phy_tx_done_cb(rf_radio_driver_id, mac_tx_handle, PHY_LINK_CCA_FAIL, 0, 0);
+        device_driver.phy_tx_done_cb(rf_radio_driver_id, mac_tx_handle, PHY_LINK_CCA_FAIL_RX, 0, 0);
     }
     TEST_TX_DONE
     TEST_RX_DONE

components/802.15.4_RF/stm-s2lp-rf-driver/source/NanostackRfPhys2lp.cpp

@@ -848,7 +848,11 @@ static void rf_cca_timer_interrupt(void)
         rf_flush_tx_fifo();
         tx_finnish_time = rf_get_timestamp();
         if (device_driver.phy_tx_done_cb) {
-            device_driver.phy_tx_done_cb(rf_radio_driver_id, mac_tx_handle, PHY_LINK_CCA_FAIL, 0, 0);
+            if (rf_state == RF_RX_STARTED) {
+                device_driver.phy_tx_done_cb(rf_radio_driver_id, mac_tx_handle, PHY_LINK_CCA_FAIL_RX, 0, 0);
+            } else {
+                device_driver.phy_tx_done_cb(rf_radio_driver_id, mac_tx_handle, PHY_LINK_CCA_FAIL, 0, 0);
+            }
         }
     } else {
         if (status == PHY_RESTART_CSMA) {
@@ -1143,7 +1147,7 @@ static void rf_irq_task_process_irq(void)
         tx_finnish_time = rf_get_timestamp();
         rf_update_tx_active_time();
         TEST_TX_DONE
-        device_driver.phy_tx_done_cb(rf_radio_driver_id, mac_tx_handle, PHY_LINK_CCA_FAIL, 1, 0);
+        device_driver.phy_tx_done_cb(rf_radio_driver_id, mac_tx_handle, PHY_LINK_CCA_FAIL_RX, 1, 0);
         rf_send_command(S2LP_CMD_SABORT);
         rf_poll_state_change(S2LP_STATE_READY);
         rf_send_command(S2LP_CMD_FLUSHTXFIFO);

features/frameworks/mbed-client-randlib/test/mbed-client-randlib/unittest/randlib/main.cpp

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2015 ARM. All rights reserved.
+ * Copyright (c) 2015 ARM Limited. All rights reserved.
  */
 
 #include "CppUTest/CommandLineTestRunner.h"

features/frameworks/mbed-client-randlib/test/mbed-client-randlib/unittest/randlib/randlibtest.cpp

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2016 ARM. All rights reserved.
+ * Copyright (c) 2016 ARM Limited. All rights reserved.
  */
 #include "CppUTest/TestHarness.h"
 #include "test_randlib.h"

features/frameworks/mbed-client-randlib/test/mbed-client-randlib/unittest/randlib/test_randlib.c

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2016 ARM. All rights reserved.
+ * Copyright (c) 2016 ARM Limited. All rights reserved.
  */
 #include "test_randlib.h"
 #include <string.h>

features/frameworks/mbed-client-randlib/test/mbed-client-randlib/unittest/randlib/test_randlib.h

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2016 ARM. All rights reserved.
+ * Copyright (c) 2016 ARM Limited. All rights reserved.
  */
 #ifndef TEST_RANDLIB_H
 #define TEST_RANDLIB_H

features/frameworks/mbed-client-randlib/test/mbed-client-randlib/unittest/stubs/open_stub.c

@@ -1,3 +1,6 @@
+/*
+ * Copyright (c) 2016 ARM Limited. All rights reserved.
+ */
 #include <stdbool.h>
 #include <sys/types.h>
 #include <sys/stat.h>

features/frameworks/mbed-client-randlib/test/mbed-client-randlib/unittest/stubs/random_stub.c

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2016, ARM Limited, All Rights Reserved
+ * Copyright (c) 2016 ARM Limited. All rights reserved.
  */
 
 #include "ns_types.h"

features/frameworks/nanostack-libservice/mbed-client-libservice/ns_nvm_helper.h

@@ -1,20 +1,18 @@
-// ----------------------------------------------------------------------------
-// Copyright 2016-2017 ARM Ltd.
-//
-// 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.
-// ----------------------------------------------------------------------------
+/*
+ * Copyright (c) 2016-2017 ARM Limited. All rights reserved.
+ * 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.
+ */
 
 /**
  * NanoStack NVM helper functions to read, write and delete key-value pairs to platform NVM.

features/frameworks/nanostack-libservice/source/nvmHelper/ns_nvm_helper.c

@@ -1,20 +1,18 @@
-// ----------------------------------------------------------------------------
-// Copyright 2016-2017 ARM Ltd.
-//
-// 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.
-// ----------------------------------------------------------------------------
+/*
+ * Copyright (c) 2016-2017 ARM Limited. All rights reserved.
+ * 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.
+ */
 
 #include <string.h>
 #include <ns_types.h>

features/nanostack/sal-stack-nanostack/nanostack/dhcp_service_api.h

@@ -142,6 +142,15 @@ uint16_t dhcp_service_init(int8_t interface_id, dhcp_instance_type_e instance_ty
 */
 void dhcp_service_relay_instance_enable(uint16_t instance, uint8_t *server_address);
 
+/**
+* \brief Enable DHCPv6 Relay Agent to add interface ID option to relay frame. Default is disabled.
+*
+*
+* \param instance The instance ID of the registered server.
+* \param enable true add interface option
+*/
+void dhcp_service_relay_interface_id_option_enable(uint16_t instance, bool enable);
+
 /**
 * \brief Get DHCPv6 Relay Agent address pointer.
 *

features/nanostack/sal-stack-nanostack/nanostack/fhss_api.h

@@ -49,6 +49,7 @@ typedef struct fhss_callback fhss_callback_t;
 typedef enum {
     FHSS_UNSYNCHRONIZED,
     FHSS_SYNCHRONIZED,
+    FHSS_EXPEDITED_FORWARDING
 } fhss_states;
 
 /**

features/nanostack/sal-stack-nanostack/nanostack/fhss_ws_extension.h

@@ -118,6 +118,27 @@ extern int ns_fhss_set_neighbor_info_fp(const fhss_api_t *fhss_api, fhss_get_nei
  */
 extern int ns_fhss_ws_set_hop_count(const fhss_api_t *fhss_api, const uint8_t hop_count);
 
+/**
+ * @brief WS TX allowance levels.
+ */
+typedef enum {
+    /** Allow transmitting only on TX slots. */
+    WS_TX_SLOT,
+    /** Allow transmitting only on TX and RX slots. */
+    WS_TX_AND_RX_SLOT,
+    /** Allow transmitting always. Also unicast on broadcast channel. */
+    WS_TX_ALWAYS
+} fhss_ws_tx_allow_level;
+
+/**
+ * @brief Set node unicast TX allowance level. Allows device to use the unicast and broadcast channel for unicast transmission as described by fhss_ws_tx_allow_level.
+ * @param fhss_api FHSS instance.
+ * @param global_level Level of TX allowance in normal mode.
+ * @param ef_level Level of TX allowance in expedited forwarding mode.
+ * @return 0 on success, -1 on fail.
+ */
+extern int ns_fhss_ws_set_tx_allowance_level(const fhss_api_t *fhss_api, const fhss_ws_tx_allow_level global_level, const fhss_ws_tx_allow_level ef_level);
+
 #ifdef __cplusplus
 }
 #endif

features/nanostack/sal-stack-nanostack/nanostack/mac_api.h

@@ -128,10 +128,11 @@ typedef void mcps_data_request(const mac_api_t *api, const mcps_data_req_t *data
  * @param data MCPS-DATA.request specific values
  * @param ie_ext Information element list to MCPS-DATA.request
  * @param asynch_channel_list Optional channel list to asynch data request. Give NULL when normal data request.
+ * @param priority Data request priority level
  *
  * Asynch data request is mac standard extension. asynch_channel_list include channel mask which channel message is requested to send.
  */
-typedef void mcps_data_request_ext(const mac_api_t *api, const mcps_data_req_t *data, const mcps_data_req_ie_list_t *ie_ext, const struct channel_list_s *asynch_channel_list);
+typedef void mcps_data_request_ext(const mac_api_t *api, const mcps_data_req_t *data, const mcps_data_req_ie_list_t *ie_ext, const struct channel_list_s *asynch_channel_list, mac_data_priority_t priority);
 
 /**
  * @brief mcps_purge_request MCPS_PURGE request call

features/nanostack/sal-stack-nanostack/nanostack/mac_mcps.h

@@ -192,5 +192,17 @@ typedef struct mcps_edfe_response_s {
     bool use_message_handle_to_discover: 1; /**< EDFE Data request message ID is valid at message_handle.  */
 } mcps_edfe_response_t;
 
+/**
+ * @brief enum mac_data_priority_t Data request priority level
+ *
+ * Data request priority level may affect CCA process and MAC queue process
+ */
+typedef enum mac_data_priority_e {
+    MAC_DATA_NORMAL_PRIORITY = 0,   /**< Normal MCPS DATA REQ */
+    MAC_DATA_MEDIUM_PRIORITY = 1,   /**< Indirect Data which is polled */
+    MAC_DATA_HIGH_PRIORITY = 2,     /**< MAC command usually use this and beacon */
+    MAC_DATA_EXPEDITE_FORWARD = 3   /**< Expedite forward level give highest priority */
+} mac_data_priority_t;
+
 
 #endif // MAC_MCPS_H

features/nanostack/sal-stack-nanostack/nanostack/mlme.h

@@ -264,6 +264,7 @@ typedef enum {
     macAutoRequestKeyIndex = 0x7b,  /*<The index of the key used for automatic data*/
     macDefaultKeySource = 0x7c,      /*<Default key source*/
     //NON standard extension
+    macRequestRestart = 0xf1,       /*< Configure failed packet data request restart */
     macEdfeForceStop = 0xf2,          /*< Use this command for Data wait timeout at LLC: Mac stop Edfe session data wait and enable normal FHSS mode */
     macSetDataWhitening = 0xf3,     /*< Enable or disable data whitening, boolean true for enable, false for disable */
     macCCAThresholdStart = 0xf4,    /*< Start automatic CCA threshold */
@@ -517,4 +518,16 @@ typedef struct mlme_multi_csma_ca_s {
     uint16_t multi_cca_interval;        /**< Length of the additional CSMA-CA period(s) in microseconds */
 } mlme_multi_csma_ca_param_t;
 
+/**
+ * @brief struct mlme_request_restart_config_s Set failed packet request restart configuration
+ *
+ * Non standard extension to restart data request after failed CCA or TX attempts
+ */
+typedef struct mlme_request_restart_config_s {
+    uint8_t cca_failure_restart_max;    /**< Max number of restarts after CCA failure */
+    uint8_t tx_failure_restart_max;     /**< Max number of restarts after TX failure */
+    uint16_t blacklist_min_ms;          /**< Blacklist min, which is doubled by every restart */
+    uint16_t blacklist_max_ms;          /**< Blacklist max, largest allowed blacklist time */
+} mlme_request_restart_config_t;
+
 #endif /* MLME_H_ */

features/nanostack/sal-stack-nanostack/nanostack/platform/arm_hal_phy.h

@@ -50,6 +50,7 @@ typedef enum {
     PHY_LINK_TX_SUCCESS,        /**< MAC TX complete. MAC will a make decision to enter wait ACK or TX done state. */
     PHY_LINK_TX_FAIL,           /**< Link TX process fail. */
     PHY_LINK_CCA_FAIL,          /**< RF link CCA process fail. */
+    PHY_LINK_CCA_FAIL_RX,       /**< RF link CCA process failed because of packet reception. */
     PHY_LINK_CCA_OK,            /**< RF link CCA process ok. */
     PHY_LINK_CCA_PREPARE,       /**< Prepare for CCA after CSMA-CA: changes to CCA channel and gives permission to TX. See PHY_LINK_CCA_PREPARE status definitions for return values */
 } phy_link_tx_status_e;

features/nanostack/sal-stack-nanostack/nanostack/socket_api.h

@@ -138,10 +138,41 @@ extern "C" {
  * After the successful state change, data can be sent using socket_send().
  * The connection can be shut down in either direction with socket_shutdown() function - shutting down write signals end-of-data to the peer.
  *
+ *
  * \section socket-udpicmp How to use UDP and RAW socket:
  *
  * A UDP socket is ready to receive and send data immediately after a successful call of socket_open() and a NET_READY event is received.
  * Data can be transmitted with the socket_sendto() function. An ICMP socket works with same function call.
+ *
+ * \section socket-trafficpriority How to set socket message priority to improve Quality of Service (QoS):
+ *
+ * IPv6 header has a field traffic class that contains a 6-bit Differentiated Services Code Point (DSCP) field that is used for packet
+ * classification. By default the packet class level is set to 0 NS_DSCP_DEFAULT.
+ *
+ * Recommend QoS levels:
+ *
+ * |     Level        |Description                                                                                          |
+ * | :--------------: | :-------------------------------------------------------------------------------------------------: |
+ * | NS_DSCP_DEFAULT  | Default level for normal data usage                                                                 |
+ * | NS_DSCP_AF11     | Higher Application data service for prioritize packet forwarding.                                   |
+ * | NS_DSCP_EF       | Expedited Forwarding (EF) for short messages. Allows low loss, low delay, and low jitter services.  |
+ * |                  | This is meant for very important messages like alerts. EF packet length should be kept in           |
+ * |                  | minimum. This should not be used for any other purpose as it will block other network traffic       |
+ * | NS_DSCP_CS6      | Network protocol message Priority. Application should not use this.                                 |
+ *
+ * High priority messages can be set to use higher than default class by using socket_setsockopt() and
+ * socket_option_traffic_class_dsc_set() helper.
+ *
+ * Example to send a message using Expedited Forwarding class:
+ *
+ * //Set EF class to high priority messages
+ * int16_t traffic_class = socket_option_traffic_class_dsc_set(NS_DSCP_EF);
+ * socket_setsockopt(socket_id, SOCKET_IPPROTO_IPV6, SOCKET_IPV6_TCLASS, &traffic_class, sizeof traffic_class);
+ *
+ * //Set traffic class back to default
+ * traffic_class = socket_option_traffic_class_dsc_set(NS_DSCP_DEFAULT);
+ * socket_setsockopt(socket_id, SOCKET_IPPROTO_IPV6, SOCKET_IPV6_TCLASS, &traffic_class, sizeof traffic_class);
+ *
  */
 
 #include "ns_address.h"
@@ -250,6 +281,24 @@ typedef struct ns_in6_pktinfo {
     int8_t  ipi6_ifindex;    /**< send/recv interface index */
 } ns_in6_pktinfo_t;
 
+/** \name Socket DSCP (Differentiated Services Code Point) QoS level examples.
+ * \anchor MSG_QOS_LEVELS
+ */
+///@{
+/** Standard priority and it is socket default */
+#define NS_DSCP_DEFAULT 0
+/** Application high priority service: Stack priorities these messages over the default priority messages */
+#define NS_DSCP_AF11 10
+/** Expedited Forwarding (EF) QoS level enable high priority state: low loss, low delay, and low jitter services */
+#define NS_DSCP_EF 46
+/** Network protocol traffic allocated QoS level stack may internally use that */
+#define NS_DSCP_CS6 48
+///@}
+
+/** Helper Traffic class Differentiated Services Code for QoS  0-63. 0 is default which define Lowest Priority
+ *
+ * */
+#define socket_option_traffic_class_dsc_set(x)  (uint8_t)((x & 63) << 2)
 
 /** \name Alignment macros for control message headers
 * \anchor CMSG_ALIGN_FLAGS

features/nanostack/sal-stack-nanostack/nanostack/ws_bbr_api.h

@@ -99,6 +99,7 @@ int ws_bbr_start(int8_t interface_id, int8_t backbone_interface_id);
 #define BBR_REQUIRE_DAO_REFRESH   0x0000 /**< Deprecated DAO Refresh is now the default functionality*/
 #define BBR_PERIODIC_VERSION_INC  0x0010 /**< Increment PAN version number Periodically*/
 #define BBR_GUA_SLAAC             0x0020 /**< in Global prefix use SLAAC address generation to reduce traffic during bootstrap */
+#define BBR_DHCP_ANONYMOUS        0x0040 /**< Generate anonymous addresses from DHCP server */
 
 /**
  * Configure border router features.
@@ -108,6 +109,9 @@ int ws_bbr_start(int8_t interface_id, int8_t backbone_interface_id);
  *          BBR_ULA_C     Configure Mesh local ULA prefix with SLAAC address
  *          BBR_GUA_ROUTE Add more specific route for GUA
  *          BBR_BB_WAIT   Start Wi-SUN network only when backbone is ready
+ *          BBR_DHCP_ANONYMOUS if true give anonymous address (16 bit suffix) to
+ *                             optimize data in RF interface (saves 12 bytes per hop)
+ *                             or false to reduce RAM usage in Border router as assigned address list is not needed (40 bytes per device).
  *
  * By default Wi-SUN network is started and is treated as separate interface even if backbone is not available.
  *