Merge commit '93c77e83625be3989aecb9b3c2b7e930b34eb529'

* commit '93c77e83625be3989aecb9b3c2b7e930b34eb529':
  Squashed 'features/nanostack/sal-stack-nanostack/' changes from cc03296..b3fe574

Author: Arto Kinnunen

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

@@ -3,37 +3,29 @@ ARM Mesh networking stack
 
 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
+* 6LoWPAN with Neighbor Discovery (ND) and Mesh Link Establishment (MLE)
+* Wi-SUN
 
- All networking stacks are using IEEE 802.15.4 based radios.
+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).
+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/latest/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
+
+## 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.
 
-##Wi-SUN
+## Wi-SUN
 Wi-SUN (Smart Utility Networks) specification is standardized by [Wi-SUN Alliance](https://www.wi-sun.org/). 
 
-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/docs/img/thread_certified.png

@@ -88,6 +88,16 @@ typedef struct fhss_configuration {
  */
 typedef int32_t fhss_vendor_defined_cf(const fhss_api_t *api, uint16_t slot, uint8_t eui64[8], uint16_t bsi, uint16_t number_of_channels);
 
+/**
+ * \brief Struct fhss_config_parameters defines FHSS configuration parameters.
+ *
+ */
+typedef struct fhss_config_parameters {
+    /** Number of channel retries defines how many consecutive channels are used when retransmitting a frame after initial transmission channel. */
+    uint8_t number_of_channel_retries;
+} fhss_config_parameters_t;
+
+
 /**
  * \brief Struct fhss_ws_configuration defines configuration of WS FHSS.
  */
@@ -125,6 +135,9 @@ typedef struct fhss_ws_configuration {
     /** Vendor defined channel function. */
     fhss_vendor_defined_cf *vendor_defined_cf;
 
+    /** Configuration parameters. */
+    fhss_config_parameters_t config_parameters;
+
 } fhss_ws_configuration_t;
 
 /**

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

@@ -39,6 +39,17 @@ extern "C" {
   */
 int8_t fhss_set_optimal_packet_length(const fhss_api_t *fhss_api, uint16_t packet_length);
 
+/**
+  * \brief Set number of channel retries
+  *
+  * \param fhss_api FHSS instance.
+  * \param number_of_channel_retries Number of channel retries
+  *
+  * \return  0 Success
+  * \return -1 Failure
+  */
+int8_t fhss_set_number_of_channel_retries(const fhss_api_t *fhss_api, uint8_t number_of_channel_retries);
+
 #ifdef __cplusplus
 }
 #endif

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

@@ -264,6 +264,8 @@ typedef enum {
     macAutoRequestKeyIndex = 0x7b,  /*<The index of the key used for automatic data*/
     macDefaultKeySource = 0x7c,      /*<Default key source*/
     //NON standard extension
+    macCCAThresholdStart = 0xf4,    /*< Start automatic CCA threshold */
+    macDevicePendingAckTrig = 0xf5, /*< Trig Pending ACK for Accepted Data packet for temporary neighbour */
     mac802_15_4Mode = 0xf6,         /*<IEEE 802.15.4 mode*/
     macDeviceDescriptionPanIDUpdate = 0xf7, /*<Thread pending link update case this will update device descrioton list pan-id to new one*/
     macTXPower = 0xf8,              /*<TX output power*/

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

@@ -50,6 +50,109 @@ int ns_file_system_set_root_path(const char *root_path);
  */
 char *ns_file_system_get_root_path(void);
 
+/**
+ * \brief NS file handle
+ *
+ */
+typedef void *NS_FILE;
+
+/**
+ * File open callback
+ *
+ * Depending on underlying file system file open for read for non-existing
+ * files can return success. In that case file read will fail.
+ *
+ * \param filename filename
+ * \param mode can be either "r" or "w"
+ *
+ * \return file handle
+ * \return NULL on error
+ *
+ */
+typedef NS_FILE(*ns_file_open)(const char *filename, const char *mode);
+
+/**
+ * File close callback
+ *
+ * \param handle file handle
+ *
+ * \return 0 on success
+ * \return < 0 in case of errors
+ *
+ */
+typedef int (*ns_file_close)(NS_FILE *handle);
+
+/**
+ * File remove callback
+ *
+ * \param filename filename
+ *
+ * \return 0 on success
+ * \return < 0 in case of errors
+ *
+ */
+typedef int (*ns_file_remove)(const char *filename);
+
+/**
+ * File write callback
+ *
+ * Write is not stream write. The whole file is written from start to end
+ * and if function is called again, previous file content is replaced with
+ * new content.
+ *
+ * \param handle file handle
+ * \param buffer buffer
+ * \param buffer buffer size
+ *
+ * \return bytes written
+ *
+ */
+typedef size_t (*ns_file_write)(NS_FILE *handle, const void *buffer, size_t size);
+
+/**
+ * File read callback
+ *
+ * Read is not stream read. The whole file is read from start to end
+ * and if function is called again, read is started from start again.
+ *
+ * \param handle file handle
+ * \param buffer buffer
+ * \param size buffer size
+ *
+ * \return bytes written
+ *
+ */
+typedef size_t (*ns_file_read)(NS_FILE *handle, void *buffer, size_t size);
+
+/**
+ * File size callback
+ *
+ * Reads file size.
+ *
+ * \param handle file handle
+ * \param size file size
+ *
+ * \return 0 on success
+ * \return < 0 in case of reading file size is not supported
+ *
+ */
+typedef int (*ns_file_size)(NS_FILE *handle, size_t *size);
+
+/**
+ * File callbacks set
+ *
+ * Sets file handling callbacks to nanostack.
+ *
+ * \param open file open callback
+ * \param close file close callback
+ * \param remove file remove callback
+ * \param write file write callback
+ * \param read file read callback
+ * \param size file size callback
+ *
+ */
+void ns_file_system_callbacks_set(ns_file_open open, ns_file_close close, ns_file_remove remove, ns_file_write write, ns_file_read read, ns_file_size size);
+
 #ifdef __cplusplus
 }
 #endif

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

@@ -0,0 +1,51 @@
+/*
+ * Copyright (c) 2020, 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.
+ */
+
+/**
+ * \file ns_time_api.h
+ * \brief Nanostack time API
+ *
+ * This is Nanostack time API.
+ *
+ */
+
+#ifndef NS_TIME_API_H_
+#define NS_TIME_API_H_
+
+#include "ns_types.h"
+
+/**
+ * System time callback.
+ *
+ * Callback shall return the system time in seconds after 1970.
+ *
+ * \param seconds system time in seconds
+ *
+ */
+typedef uint64_t ns_time_api_system_time_callback(void);
+
+/**
+ * System time callback set.
+ *
+ * Sets callback for the system time.
+ *
+ * \param callback system time callback
+ *
+ */
+void ns_time_api_system_time_callback_set(ns_time_api_system_time_callback callback);
+
+#endif /* NS_TIME_API_H_ */

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

@@ -80,6 +80,7 @@ typedef enum {
     PHY_EXTENSION_FILTERING_SUPPORT, /**<  Return filtering modes that can be supported by the PHY driver. See phy_link_filters_e */
     PHY_EXTENSION_SET_TX_POWER, /**<  Set TX output power which is given as percentage of maximum. 0 is the lowest possible TX power and 100 is the highest possible TX power */
     PHY_EXTENSION_SET_CCA_THRESHOLD, /**<  Set CCA threshold which is given as percentage of maximum threshold. 0 is the lowest(strictest) possible threshold and 100 is the highest possible threshold */
+    PHY_EXTENSION_SET_CHANNEL_CCA_THRESHOLD, /**<  Set CCA threshold which is given as dBm. This value is set in PHY_LINK_CCA_PREPARE callback and PHY driver should update the CCA threshold configuration */
     PHY_EXTENSION_SET_802_15_4_MODE /**<  Set IEEE 802.15.4 mode as defined by phy_802_15_4_mode_t*/
 } phy_extension_type_e;
 

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

@@ -30,6 +30,36 @@
 
 #include "ns_types.h"
 
+/**
+ * \brief Struct ws_statistics Border router dynamic information.
+ */
+typedef struct bbr_information {
+    /** Timestamp of the the device. Can be used as version number*/
+    uint64_t timestamp;
+    /** Border router dodag id */
+    uint8_t dodag_id[16];
+    /** Address prefix given to devices in network  set to 0 if not available*/
+    uint8_t prefix[8];
+    /** Address IID of the border router set to 0 if not available*/
+    uint8_t IID[8];
+    /** Amount of devices in the network. */
+    uint16_t devices_in_network;
+    /** Border router instance identifier defined in RPL */
+    uint8_t instance_id;
+    /** RPL version number */
+    uint8_t version;
+} bbr_information_t;
+
+/**
+ * \brief Struct route_info is parent child relation structure.
+ */
+typedef struct bbr_route_info {
+    /** IID of target device public IPv6 address can be formed by combining prefix + IID*/
+    uint8_t target[8];
+    /** IID of parent*/
+    uint8_t parent[8];
+} bbr_route_info_t;
+
 /**
  * Start backbone border router service.
  *
@@ -83,6 +113,49 @@ int ws_bbr_configure(int8_t interface_id, uint16_t options);
  */
 void ws_bbr_stop(int8_t interface_id);
 
+/**
+ * Get border router information
+ *
+ * \param interface_id interface ID of the Wi-SUN network
+ * \param info_ptr Structure given to stack where information is stored
+ *
+ * \return 0 on success
+ * \return <0 in case of errors
+ *
+ */
+int ws_bbr_info_get(int8_t interface_id, bbr_information_t *info_ptr);
+
+/**
+ * Routing table get
+ *
+ * Table is Parent child relation using the Global address IID of the devices
+ * To get the full IPv6 address of the device.
+ *  IPv6 =  Global Prefix + IID.
+ *
+ * Routing table is in the format: 18 bytes per entry
+ * | Node IID 8 bytes   | parent IID 8 bytes |
+ * | 1122112211221122   | 1111111111111111   |
+ * | 1133113311331133   | 1111111111111111   |
+ * | 1144114411441144   | 1111111111111111   |
+ * | 1155115511551155   | 1122112211221122   |
+ * | 1166116611661166   | 1122112211221122   |
+ * | 1177117711771177   | 1155115511551155   |
+ * | 1188118811881188   | 1177117711771177   |
+ *
+ * Order is not assured only parent child link is given in random order
+ *
+ * Return value is device amount in network divided by 16 bytes per route entry
+ *
+ * \param interface_id interface ID of the Wi-SUN network
+ * \param table_ptr Application allocated memory block where routing table is written.
+ * \param table_len Length of the table allocated by application given as amount of entries.
+ *
+ * \return 0 - x on success indicates amount of bytes written to the table_ptr
+ * \return <0 in case of errors
+ *
+ */
+int ws_bbr_routing_table_get(int8_t interface_id, bbr_route_info_t *table_ptr, uint16_t table_len);
+
 /**
  * Remove node's keys from border router
  *
@@ -243,4 +316,40 @@ int ws_bbr_pan_configuration_get(int8_t interface_id, uint16_t *pan_id);
  */
 int ws_bbr_pan_configuration_validate(int8_t interface_id, uint16_t pan_id);
 
+/**
+ * ws_bbr_key_storage_memory_set sets memory used for key storages
+ *
+ * This functions can be used to set memory used by EAPOL key storage. When memory
+ * areas are set, module does not allocate memory internally from heap.
+ *
+ * \param interface_id Network interface ID.
+ * \param key_storages_number number of memory areas.
+ * \param key_storage_size array of memory area sizes.
+ * \param key_storages array of memory area start pointers.
+ *
+ * \return < 0 failure
+ * \return >= 0 success
+ *
+ */
+int ws_bbr_key_storage_memory_set(int8_t interface_id, uint8_t key_storages_number, const uint16_t *key_storage_size, void **key_storages);
+
+/**
+ * ws_bbr_key_storage_settings_set sets key storage settings
+ *
+ * This functions can be used to set the settings of EAPOL key storage.
+ * Allocation max number and allocation size sets the settings that are used when key storage
+ * memory is allocated dynamically from heap. These settings must be set before (first) interface
+ * up and shall not be set if key storage memory is set by ws_pae_key_storage_memory_set() call.
+ *
+ * \param interface_id Network interface ID.
+ * \param alloc_max_number maximum number of allocation made to dynamic memory.
+ * \param alloc_size size of each allocation.
+ * \param storing_interval interval in which the check to store to NVM is made.
+ *
+ * \return < 0 failure
+ * \return >= 0 success
+ *
+ */
+int ws_bbr_key_storage_settings_set(int8_t interface_id, uint8_t alloc_max_number, uint16_t alloc_size, uint16_t storing_interval);
+
 #endif /* WS_BBR_API_H_ */