Merge commit '1c29564f653e93a2bda270b257c9bb239de9b61e' into prepare_for_mbedos513

* commit '1c29564f653e93a2bda270b257c9bb239de9b61e':
  Squashed 'features/nanostack/sal-stack-nanostack/' changes from 84a07ce..0345477

Author: Arto Kinnunen

features/nanostack/sal-stack-nanostack/README.md

@@ -1,17 +1,39 @@
-ARM IPV6/6LoWPAN stack.
+ARM Mesh networking stack
 =======================
 
-This repository contains the ARM IPv6/6LoWPAN/Thread Stack for mbed OS.
+This repository contains the ARM mesh networking stack that  provides support for the following mesh protocols:
+
+  * 6LoWPAN with Neighbor Discovery (ND) and Mesh Link Establishment (MLE)
+  * Thread
+  * Wi-SUN
+ 
+ All networking stacks are using IEEE 802.15.4 based radios.
+  
+The full documentation is hosted in [Mbed OS documentation](https://os.mbed.com/docs/mbed-os/latest/reference/mesh-tech.html).
+
+On mbed OS, mesh networking stacks can be used  through [Mbed Mesh API](https://os.mbed.com/docs/mbed-os/latest/apis/mesh-api.html) and [Network Socket API](https://os.mbed.com/docs/mbed-os/v5.11/apis/network-socket.html).
+
+To see, how the mesh networking stack works, check the example application [mbed-os-example-mesh-minimal](https://github.com/ARMmbed/mbed-os-example-mesh-minimal).
+
+  
+##6LoWPAN with ND and MLE
+
+This networking stack is using standard 6LoWPAN and uses:
+
+* Neighbor Discovery Protocol ([RFC4861](https://tools.ietf.org/html/rfc4861)) to locate other devices in the mesh network. 
+* Mesh-Link-Establishment ([draft-kelsey-intarea-mesh-link-establishment-06](https://tools.ietf.org/html/draft-kelsey-intarea-mesh-link-establishment-06)) is used for establishing and configuring secure radio links. 
+  
+##Thread
+Thread is standardized by [Thread group](https://www.threadgroup.org/).
 
 ![](docs/img/thread_certified.png)
 
 mbed OS is now a Thread Certified Component. Using IPv6 with 6LoWPAN as the foundation, Thread technology provides a low-power, self-healing mesh network designed for the home.
 
-The documentation is hosted in [here](https://os.mbed.com/docs/v5.6/tutorials/6lowpan-mesh.html).
-
-On mbed OS, usage is through [mbed Mesh API](https://os.mbed.com/docs/v5.6/reference/mesh.html) and [Socket API](https://os.mbed.com/docs/v5.6/reference/network-socket.html).
+##Wi-SUN
+Wi-SUN (Smart Utility Networks) specification is standardized by [Wi-SUN Alliance](https://www.wi-sun.org/). 
 
-To see, how the 6LoWPAN Stack works, check the example application [mbed-os-example-mesh-minimal](https://github.com/ARMmbed/mbed-os-example-mesh-minimal).
+Mbed OS release 5.12 contains the initial Mbed Wi-SUN FAN implementation. Functionality of the Mbed Wi-SUN network stack will be updated when the Wi-SUN protocol is specified further.
 
 ## License
 

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

@@ -133,6 +133,16 @@ 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 Get DHCPv6 Relay Agent address pointer.
+*
+* \param instance The instance ID of the registered server.
+*
+* \return NULL when address is not available
+* {
+*/
+uint8_t *dhcp_service_relay_global_addres_get(uint16_t instance);
+
 
 /**
 * \brief Deletes a server instance.
@@ -188,6 +198,15 @@ uint32_t dhcp_service_send_req(uint16_t instance_id, uint8_t options, void *ptr,
  */
 void dhcp_service_set_retry_timers(uint32_t msg_tr_id, uint16_t timeout_init, uint16_t timeout_max, uint8_t retrans_max);
 
+/**
+ * \brief Update DHCP service server address to active tx process.
+ *
+ * \param msg_tr_id The message transaction ID.
+ * \param server_address New destination address to server / relay Agent.
+ *
+ */
+void dhcp_service_update_server_address(uint32_t msg_tr_id, uint8_t *server_address);
+
 /**
  * \brief Stops transactions for a message (retransmissions).
  *

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

@@ -143,13 +143,13 @@ typedef int16_t fhss_synch_state_set(const fhss_api_t *api, fhss_states fhss_sta
 typedef uint32_t fhss_read_timestamp(const fhss_api_t *api);
 
 /**
- * @brief Get retransmission period. FHSS uses different retry periods for different destinations.
+ * @brief Get additional retransmission period. FHSS uses different retry periods depending on destination or channel availability.
  * @param api FHSS instance.
  * @param destination_address Destination MAC address.
  * @param phy_mtu PHY MTU size.
- * @return Retransmission period.
+ * @return Retransmission period in microsecond which should be added to normal backoff period.
  */
-typedef uint16_t fhss_get_retry_period(const fhss_api_t *api, uint8_t *destination_address, uint16_t phy_mtu);
+typedef uint32_t fhss_get_retry_period(const fhss_api_t *api, uint8_t *destination_address, uint16_t phy_mtu);
 
 /**
  * @brief Write synchronization info to given pointer.

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
+    macMultiCSMAParameters = 0xfa,  /*<Multi CSMA parameters*/
     macRfConfiguration = 0xfb,      /*<RF channel configuration parameters*/
     macAcceptByPassUnknowDevice = 0xfc,  /*< Accept data trough MAC if packet is data can be authenticated by group key nad MIC. Security enforsment point must be handled carefully these packets */
     macLoadBalancingBeaconTx = 0xfd,  /*< Trig Beacon from load balance module periodic */
@@ -499,4 +500,14 @@ typedef struct mlme_poll_conf_s {
     uint8_t status;             /**< Status of Poll operation */
 } mlme_poll_conf_t;
 
+/**
+ * @brief struct mlme_multi_csma_ca_param_s Set multi CSMA-CA parameters
+ *
+ * Non standard extension to perform CCA multiple times before transmission
+ */
+typedef struct mlme_multi_csma_ca_s {
+    uint8_t number_of_csma_ca_periods;  /**< Number of CSMA-CA periods */
+    uint16_t multi_cca_interval;        /**< Length of the additional CSMA-CA period(s) in microseconds */
+} mlme_multi_csma_ca_param_t;
+
 #endif /* MLME_H_ */

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

@@ -51,6 +51,40 @@ int8_t arm_nwk_ipv6_frag_mru(uint16_t frag_mru);
  */
 int8_t arm_nwk_ipv6_max_cache_entries(uint16_t max_entries);
 
+/**
+ * \brief Configure destination cache.
+ *
+ * Set destination cache maximum entry count, thresholds where amount of entries is kept during operation and lifetime.
+ *
+ * Note: This must be called before arm_nwk_interface_lowpan_init()
+ *
+ * \param max_entries Maximum number of entries allowed in destination cache at any time.
+ * \param short_term_threshold Amount of cache entries kept in memory in short term. Must be less than max_entries.
+ * \param long_term_threshold Amount of entries kept in memory over long period of time. Must be less than short_term_threshold.
+ * \param lifetime Lifetime of cache entry, must be over 120 seconds
+ *
+ * \return 0 Change OK.
+ * \return <0 Change invalid - unable to change the maximum for cache.
+ */
+int8_t arm_nwk_ipv6_destination_cache_configure(uint16_t max_entries, uint16_t short_term_threshold, uint16_t long_term_threshold, uint16_t lifetime);
+
+/**
+ * \brief Configure neighbour cache.
+ *
+ * Set neighbour cache maximum entry count, thresholds where amount of entries is kept during operation and lifetime.
+ *
+ * Note: This must be called before arm_nwk_interface_lowpan_init()
+ *
+ * \param max_entries Maximum number of entries allowed in neighbour cache at any time.
+ * \param short_term_threshold Amount of cache entries kept in memory in short term. Must be less than max_entries.
+ * \param long_term_threshold Amount of entries kept in memory over long period of time. Must be less than short_term_threshold.
+ * \param lifetime Lifetime of cache entry, must be over 120 seconds
+ *
+ * \return 0 Change OK.
+ * \return <0 Change invalid - unable to change the maximum for cache.
+ */
+int8_t arm_nwk_ipv6_neighbour_cache_configure(uint16_t max_entries, uint16_t short_term_threshold, uint16_t long_term_threshold, uint16_t lifetime);
+
 /**
  * \brief Configure automatic flow label calculation.
  *

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

@@ -241,6 +241,19 @@ int thread_test_version_set(int8_t interface_id, uint8_t version);
  */
 int thread_test_router_selection_jitter_set(int8_t interface_id, uint32_t jitter);
 
+/**
+ * \brief Set Thread PBBR status response override.
+ *
+ * \param interface_id Network Interface
+ * \param dua_status expected dua response value from PBBR
+ * \param dua_count number of times dua_response is repeated
+ * \param ba_failure_count number of times bba failure is repeated
+ *
+ * \return 0, OK
+ * \return <0 Error
+ */
+int thread_test_pbbr_response_override_set(int8_t interface_id, uint8_t dua_status, uint8_t dua_count, uint8_t ba_failure_count);
+
 /**
  * \brief Sets the thread MIN_DELAY_TIMER default value.
  *

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

@@ -113,9 +113,9 @@ int ws_test_active_key_set(int8_t interface_id, uint8_t index);
  * Pairwise Transient Key (PTK) lifetimes.
  *
  * \param interface_id Network interface ID.
- * \param gtk_lifetime GTK lifetime in minutes
- * \param pmk_lifetime PMK lifetime in minutes
- * \param ptk_lifetime PTK lifetime in minutes
+ * \param gtk_lifetime GTK lifetime in minutes or zero if value is not changed
+ * \param pmk_lifetime PMK lifetime in minutes or zero if value is not changed
+ * \param ptk_lifetime PTK lifetime in minutes or zero if value is not changed
  *
  * \return 0                         Lifetimes are set
  * \return <0                        Lifetime set has failed
@@ -135,9 +135,10 @@ int ws_test_key_lifetime_set(
  * maximum mismatch time in minutes.
  *
  * \param interface_id Network interface ID.
- * \param revocat_lifetime_reduct GTK Revocation Lifetime Reduction (1 / value * GTK lifetime)
- * \param new_activation_time GTK New Activation Time (1 / value * GTK lifetime)
- * \param max_mismatch GTK maximum mismatch in minutes
+ * \param revocat_lifetime_reduct GTK Revocation Lifetime Reduction (1 / value * GTK lifetime) or zero if value is not changed
+ * \param new_activation_time GTK New Activation Time (1 / value * GTK lifetime) or zero if value is not changed
+ * \param new_install_req GTK New Install Required (percent * GTK lifetime) or zero if value is not changed
+ * \param max_mismatch GTK maximum mismatch in minutes or zero if value is not changed
  *
  * \return 0                         Lifetimes are set
  * \return <0                        Lifetime set has failed.
@@ -146,9 +147,26 @@ int ws_test_gtk_time_settings_set(
     int8_t interface_id,
     uint8_t revocat_lifetime_reduct,
     uint8_t new_activation_time,
+    uint8_t new_install_req,
     uint32_t max_mismatch
 );
 
+/**
+ * Sets Next Group Transient Keys used during GTK life cycle
+ *
+ * Sets next Group Transient Keys (GTKs) used during GTK life cycle. Up to four
+ * GTKs can be set (GTKs from index 0 to 3). When next GTK(s) are set, border
+ * router inserts GTKs from the next GTK list into use during GTK update
+ * procedure.
+ *
+ * \param interface_id Network interface ID.
+ * \param gtk GTK array, if GTK is not set, pointer for the index shall be NULL.
+ *
+ * \return 0                         GTKs are set
+ * \return <0                        GTK set has failed
+ */
+int ws_test_next_gtk_set(int8_t interface_id, uint8_t *gtk[4]);
+
 #ifdef __cplusplus
 }
 #endif

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

@@ -29,6 +29,11 @@
 extern "C" {
 #endif
 
+/** PHY_LINK_CCA_PREPARE status definitions */
+#define PHY_TX_NOT_ALLOWED  -1      /**< TX not allowed. Do not continue to CCA process. */
+#define PHY_TX_ALLOWED      0       /**< TX allowed. Continue to CCA process. */
+#define PHY_RESTART_CSMA    1       /**< Restart CSMA-CA timer. CSMA-CA period must be calculated using given backoff time (PHY_EXTENSION_SET_CSMA_PARAMETERS) */
+
 /** Interface states */
 typedef enum {
     PHY_INTERFACE_RESET,            /**< Reset PHY driver and set to idle. */
@@ -45,9 +50,16 @@ 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_PREPARE,       /**< RX Tx timeout prepare operation like channel switch to Tx channel from Receive one If operation fail must return not zero*/
+    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;
 
+/** MAC filtering modes. Set corresponding bit to 1 (1 << MAC_FRAME_VERSION_X) in PHY_EXTENSION_FILTERING_SUPPORT request when PHY can handle the filtering of this frame type.
+ *  NOTE: Currently MAC supports filtering and Acking only 802.15.4-2015 frames. Any other frame version must be filtered and Acked by PHY with either HW or SW solution. */
+typedef enum {
+    MAC_FRAME_VERSION_2 = 2          /**< 802.15.4-2015 */
+} phy_link_filters_e;
+
 /** Extension types */
 typedef enum {
     PHY_EXTENSION_CTRL_PENDING_BIT, /**< Control MAC pending bit for indirect data. */
@@ -64,7 +76,8 @@ typedef enum {
     PHY_EXTENSION_GET_TIMESTAMP, /**<  Read 32-bit constant monotonic time stamp in us */
     PHY_EXTENSION_SET_CSMA_PARAMETERS, /**< CSMA parameter's are given by phy_csma_params_t structure remember type cast uint8_t pointer to structure type*/
     PHY_EXTENSION_GET_SYMBOLS_PER_SECOND, /**<  Read Symbols per seconds which will help to convert symbol time to real time  */
-    PHY_EXTENSION_SET_RF_CONFIGURATION  /**<  Set RF configuration using phy_rf_channel_parameters_s structure */
+    PHY_EXTENSION_SET_RF_CONFIGURATION,  /**<  Set RF configuration using phy_rf_channel_parameters_s structure */
+    PHY_EXTENSION_FILTERING_SUPPORT /**<  Return filtering modes that can be supported by the PHY driver. See phy_link_filters_e */
 } phy_extension_type_e;
 
 /** Address types */

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

@@ -83,6 +83,7 @@ typedef struct link_configuration {
     uint8_t version; /**< current protocol version*/
     uint16_t rfChannel; /**< current rf channel*/
     uint8_t securityPolicy; /**< Commission Security Policy*/
+    uint8_t securityPolicyExt; /**< Additional Security Policy byte*/
     uint64_t timestamp;/**< commissioning data set timestamp. [48 bit timestamp seconds]-[15 bit timestamp ticks]-[U bit] */
 } link_configuration_s;
 

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

@@ -45,6 +45,36 @@
  */
 int ws_bbr_start(int8_t interface_id, int8_t backbone_interface_id);
 
+/**
+ * Border router configuration options
+ */
+#define BBR_ULA_C           0x0001 /**< Static ULA prefix created automatically */
+#define BBR_GUA_C           0x0002 /**< Routable prefix is learned from the backbone */
+#define BBR_GUA_ROUTE       0x0004 /**< More specific route is added for GUA prefix */
+#define BBR_GUA_SLAAC       0x0008 /**< Use SLAAC addressing in routable prefix */
+#define BBR_GUA_WAIT        0x0010 /**< Wait backbone availability before starting RPL dodag */
+#define BBR_BB_WAIT         0x0020 /**< Wait backbone availability before starting Wi-SUN network */
+/**
+ * Configure border router features.
+ *
+ * \param interface_id interface ID of the Wi-SUN network
+ * \param options Options configured to Border router
+ *          BBR_ULA_C     Configure Mesh local ULA prefix with SLAAC address  (default)
+ *          BBR_GUA_C     Configure GUA/ULA prefix from backbone to RPL       (default)
+ *          BBR_GUA_ROUTE Add more specific route for GUA                     (default)
+ *          BBR_GUA_SLAAC Use SLAAC address generation in GUA prefix
+ *          BBR_GUA_WAIT  Start RPL root only when GUA is available
+ *          BBR_BB_WAIT   Start Wi-SUN network only when backbone is ready
+ *
+ * By default Wi-SUN network is started and is treated as separate interface even if backbone is not available.
+ *
+ * Default route RPL options when backbone is set up. RPL root is always Grounded
+ *
+ * \return 0 on success
+ * \return <0 in case of errors
+ *
+ */
+int ws_bbr_configure(int8_t interface_id, uint16_t options);
 /**
  * Stop backbone Border router.
  *

features/nanostack/sal-stack-nanostack/source/6LoWPAN/MAC/mac_helper.c

@@ -339,6 +339,26 @@ int8_t mac_helper_security_default_key_set(protocol_interface_info_entry_t *inte
     return 0;
 }
 
+int8_t mac_helper_security_default_recv_key_set(protocol_interface_info_entry_t *interface, const uint8_t *key, uint8_t id, uint8_t keyid_mode)
+{
+    if (id == 0 || keyid_mode > 3) {
+        return -1;
+    }
+
+    mac_helper_keytable_descriptor_set(interface->mac_api, key, id, interface->mac_parameters->mac_default_key_attribute_id);
+    return 0;
+}
+
+int8_t mac_helper_security_auto_request_key_index_set(protocol_interface_info_entry_t *interface, uint8_t id)
+{
+    if (id == 0) {
+        return -1;
+    }
+
+    mac_helper_pib_8bit_set(interface, macAutoRequestKeyIndex, id);
+    return 0;
+}
+
 
 int8_t mac_helper_security_pairwisekey_set(protocol_interface_info_entry_t *interface, const uint8_t *key, const uint8_t *mac_64, uint8_t key_attribute)
 {
@@ -374,6 +394,33 @@ int8_t mac_helper_security_prev_key_set(protocol_interface_info_entry_t *interfa
 
 }
 
+int8_t mac_helper_security_key_to_descriptor_set(protocol_interface_info_entry_t *interface, const uint8_t *key, uint8_t id, uint8_t descriptor)
+{
+    if (id == 0) {
+        return -1;
+    }
+
+    mac_helper_keytable_descriptor_set(interface->mac_api, key, id, descriptor);
+    return 0;
+}
+
+int8_t mac_helper_security_key_descriptor_clear(protocol_interface_info_entry_t *interface, uint8_t descriptor)
+{
+    if (!interface->mac_api) {
+        return -1;
+    }
+
+    mlme_set_t set_req;
+    mlme_key_descriptor_entry_t key_description;
+    memset(&key_description, 0, sizeof(mlme_key_descriptor_entry_t));
+
+    set_req.attr = macKeyTable;
+    set_req.value_pointer = &key_description;
+    set_req.value_size = sizeof(mlme_key_descriptor_entry_t);
+    set_req.attr_index = descriptor;
+    interface->mac_api->mlme_req(interface->mac_api, MLME_SET, &set_req);
+    return 0;
+}
 
 void mac_helper_security_key_swap_next_to_default(protocol_interface_info_entry_t *interface)
 {

features/nanostack/sal-stack-nanostack/source/6LoWPAN/MAC/mac_helper.h

@@ -67,10 +67,18 @@ uint8_t mac_helper_default_key_index_get(struct protocol_interface_info_entry *i
 
 int8_t mac_helper_security_default_key_set(struct protocol_interface_info_entry *interface, const uint8_t *key, uint8_t id, uint8_t keyid_mode);
 
+int8_t mac_helper_security_default_recv_key_set(struct protocol_interface_info_entry *interface, const uint8_t *key, uint8_t id, uint8_t keyid_mode);
+
+int8_t mac_helper_security_auto_request_key_index_set(struct protocol_interface_info_entry *interface, uint8_t id);
+
 int8_t mac_helper_security_next_key_set(struct protocol_interface_info_entry *interface, uint8_t *key, uint8_t id, uint8_t keyid_mode);
 
 int8_t mac_helper_security_prev_key_set(struct protocol_interface_info_entry *interface, uint8_t *key, uint8_t id, uint8_t keyid_mode);
 
+int8_t mac_helper_security_key_to_descriptor_set(struct protocol_interface_info_entry *interface, const uint8_t *key, uint8_t id, uint8_t descriptor);
+
+int8_t mac_helper_security_key_descriptor_clear(struct protocol_interface_info_entry *interface, uint8_t descriptor);
+
 void mac_helper_security_key_swap_next_to_default(struct protocol_interface_info_entry *interface);
 
 int8_t mac_helper_security_pairwisekey_set(struct protocol_interface_info_entry *interface, const uint8_t *key, const uint8_t *mac_64, uint8_t key_attribute);