Add new configuration parameters to Wi-SUN network interface and Border Router class (Mbed OS 5.15)

features/nanostack/mbed-mesh-api/mbed-mesh-api/MeshInterfaceNanostack.h

@@ -82,6 +82,8 @@ class Nanostack::Interface : public OnboardNetworkStack::Interface, private mbed
 };
 
 class Nanostack::MeshInterface : public Nanostack::Interface {
+public:
+ char *get_interface_name(char *buf);
 protected:
  MeshInterface(NanostackRfPhy &phy) : Interface(phy) { }
  NanostackRfPhy &get_phy() const
@@ -172,6 +174,7 @@ class InterfaceNanostack : public virtual NetworkInterface {
  char mac_addr_str[24];
  mbed::Callback<void(nsapi_event_t, intptr_t)> _connection_status_cb;
  bool _blocking;
+ bool _configured = false;
 };
 
 class MeshInterfaceNanostack : public InterfaceNanostack, public MeshInterface, private mbed::NonCopyable<MeshInterfaceNanostack> {

features/nanostack/mbed-mesh-api/mbed-mesh-api/NanostackEthernetInterface.h

@@ -29,6 +29,7 @@ class Nanostack::EthernetInterface : public Nanostack::Interface {
  bool blocking = true);
  virtual nsapi_error_t bringdown();
 
+ char *get_interface_name(char *buf);
 private:
  friend class Nanostack;
  friend class NanostackEthernetInterface;

features/nanostack/mbed-mesh-api/mbed-mesh-api/NanostackPPPInterface.h

@@ -32,6 +32,7 @@ class Nanostack::PPPInterface : public Nanostack::Interface {
  typedef mbed::Callback<void (uint8_t up, int8_t device_id)> link_state_cb_t;
  virtual void set_link_state_changed_callback(link_state_cb_t link_state_cb);
 
+ char *get_interface_name(char *buf);
 private:
  friend class Nanostack;
  PPPInterface(NanostackPhy &phy) : Interface(phy), link_state_up(false), enet_tasklet_connected(false) {}

features/nanostack/mbed-mesh-api/mbed-mesh-api/WisunBorderRouter.h

@@ -0,0 +1,155 @@
+/*
+ * Copyright (c) 2020 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.
+ */
+
+#ifndef WISUNBORDERROUTER_H
+#define WISUNBORDERROUTER_H
+
+/** Wi-SUN Border Router class
+ *
+ * Class can be used to start, stop and configure Wi-SUN Border Router.
+ */
+class WisunBorderRouter {
+public:
+
+ /** Create WisunBorderRouter
+ *
+ * */
+ WisunBorderRouter() { }
+
+ /**
+ * \brief Start Wi-SUN Border Router
+ *
+ * Starts Wi-SUN Border Router and routing between the mesh and backbone interfaces. Network interfaces
+ * must be initialized and connected before calling the start. Backbone interface can be either Ethernet
+ * (EMAC) or Cellular.
+ *
+ * \param mesh_if Wi-SUN mesh network interface
+ * \param backbone_if Backbone network interface
+ * \return MESH_ERROR_NONE on success.
+ * \return MESH_ERROR_UNKNOWN in case of failure.
+ * */
+ mesh_error_t start(NetworkInterface *mesh_if, NetworkInterface *backbone_if);
+
+ /**
+ * \brief Start Wi-SUN Border Router
+ *
+ * Starts Wi-SUN Border Router and routing between the mesh and backbone interfaces. Mesh network interface
+ * must be initialized and connected before calling the start. Backbone OnboardNetworkStack::Interface must
+ * be brought up before calling the start. Backbone interface can be either Ethernet (EMAC) or Cellular (PPP).
+ *
+ * \param mesh_if Wi-SUN mesh network interface
+ * \param backbone_if Backbone OnboardNetworkStack::Interface interface
+ * \return MESH_ERROR_NONE on success.
+ * \return MESH_ERROR_UNKNOWN in case of failure.
+ * */
+ mesh_error_t start(NetworkInterface *mesh_if, OnboardNetworkStack::Interface *backbone_if);
+
+ /**
+ * \brief Stop Wi-SUN Border Router
+ *
+ * Stops Wi-SUN Border Router.
+ *
+ * */
+ void stop();
+
+ /**
+ * \brief Set Wi-SUN RPL DIO trickle parameters.
+ *
+ * Function stores new parameters to Border Router and uses them when mesh interface connect() is called
+ * next time. If device is already connected to the Wi-SUN network then device will restart Wi-SUN network after
+ * changing the RPL DIO trickle parameters. Mesh interface must be initialized before calling this
+ * function.
+ *
+ * \param dio_interval_min DIO trickle timer Imin parameter. Use 0x00 to use leave parameter unchanged.
+ * \param dio_interval_doublings DIO trickle timer Imax parameter as doublings of Imin. Use 0x00 to use leave parameter unchanged.
+ * \param dio_redundancy_constant DIO trickle timer redundancy constant. Use 0xff to use leave parameter unchanged.
+ * \return MESH_ERROR_NONE on success.
+ * \return MESH_ERROR_UNKNOWN in case of failure.
+ * */
+ mesh_error_t set_rpl_parameters(uint8_t dio_interval_min, uint8_t dio_interval_doublings, uint8_t dio_redundancy_constant);
+
+ /**
+ * \brief Get Wi-SUN RPL DIO trickle parameters.
+ *
+ * Function reads DIO trickle timer Imin, DIO trickle timer Imax and DIO trickle timer redundancy
+ * constant from Border Router. Mesh interface must be initialized before calling this function.
+ *
+ * \param dio_interval_min DIO trickle timer Imin parameter.
+ * \param dio_interval_doublings DIO trickle timer Imax parameter as doublings of Imin.
+ * \param dio_redundancy_constant DIO trickle timer redundancy constant.
+ * \return MESH_ERROR_NONE on success.
+ * \return MESH_ERROR_UNKNOWN in case of failure.
+ * */
+ mesh_error_t get_rpl_parameters(uint8_t *dio_interval_min, uint8_t *dio_interval_doublings, uint8_t *dio_redundancy_constant);
+
+ /**
+ * \brief Validate Wi-SUN RPL DIO trickle parameters.
+ *
+ * Function validates DIO trickle timer Imin, DIO trickle timer Imax and DIO trickle timer redundancy
+ * constant. Function can be used to test that values that will be used on set function are valid.
+ * Mesh interface must be initialized before the calling this function.
+ *
+ * \param dio_interval_min DIO trickle timer Imin parameter.
+ * \param dio_interval_doublings DIO trickle timer Imax parameter as doublings of Imin.
+ * \param dio_redundancy_constant DIO trickle timer redundancy constant.
+ * \return MESH_ERROR_NONE on success.
+ * \return MESH_ERROR_UNKNOWN in case of failure.
+ * */
+ mesh_error_t validate_rpl_parameters(uint8_t dio_interval_min, uint8_t dio_interval_doublings, uint8_t dio_redundancy_constant);
+
+ /**
+ * \brief Set Wi-SUN PAN configuration parameters.
+ *
+ * Function stores new parameters to Border Router and uses them when mesh interface connect() is called
+ * next time. If device is already connected to the Wi-SUN network then device will restart Wi-SUN network after
+ * changing the PAN configuration parameters. Mesh interface must be initialized before calling this
+ * function.
+ *
+ * \param pan_id PAN ID. 0xffff will generate the PAN ID on the mesh interface connect() call if not already generated.
+ * \return MESH_ERROR_NONE on success.
+ * \return MESH_ERROR_UNKNOWN in case of failure.
+ * */
+ mesh_error_t set_pan_configuration(uint16_t pan_id);
+
+ /**
+ * \brief Get Wi-SUN PAN configuration parameters.
+ *
+ * Function reads PAN ID from Border Router. Mesh interface must be initialized before calling this function.
+ *
+ * \param pan_id PAN ID.
+ * \return MESH_ERROR_NONE on success.
+ * \return MESH_ERROR_UNKNOWN in case of failure.
+ * */
+ mesh_error_t get_pan_configuration(uint16_t *pan_id);
+
+ /**
+ * \brief Validate Wi-SUN PAN configuration parameters.
+ *
+ * Function validates PAN ID. Function can be used to test that values that will be used on set function are valid.
+ * Mesh interface must be initialized before calling this function.
+ *
+ * \param pan_id PAN ID.
+ * \return MESH_ERROR_NONE on success.
+ * \return MESH_ERROR_UNKNOWN in case of failure.
+ * */
+ mesh_error_t validate_pan_configuration(uint16_t pan_id);
+
+private:
+ int8_t _mesh_if_id = -1;
+
+};
+
+#endif