MAC address set/get support for EMAC interface

Add support to set and get MAC address from EMAC interface.

Author: Arto Kinnunen

connectivity/nanostack/include/nanostack-interface/Nanostack.h

@@ -41,9 +41,10 @@ class Nanostack : public OnboardNetworkStack, private mbed::NonCopyable<Nanostac
 
     /* Implement OnboardNetworkStack method */
     nsapi_error_t add_ethernet_interface(EMAC &emac, bool default_if, OnboardNetworkStack::Interface **interface_out) override;
+    nsapi_error_t add_ethernet_interface(EMAC &emac, bool default_if, OnboardNetworkStack::Interface **interface_out, const uint8_t *mac_addr) override;
 
-    /* Local variant with stronger typing and manual address specification */
-    nsapi_error_t add_ethernet_interface(EMAC &emac, bool default_if, Nanostack::EthernetInterface **interface_out, const uint8_t *mac_addr = NULL);
+    /* Local variant */
+    nsapi_error_t add_ethernet_interface_ns(EMAC &emac, bool default_if, Nanostack::EthernetInterface **interface_out, const uint8_t *mac_addr = NULL);
 
     nsapi_error_t add_ppp_interface(PPP &ppp, bool default_if, OnboardNetworkStack::Interface **interface_out) override;
 

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

@@ -28,6 +28,7 @@ class Nanostack::EthernetInterface final : public Nanostack::Interface {
                           nsapi_ip_stack_t stack = DEFAULT_STACK,
                           bool blocking = true) override;
     nsapi_error_t bringdown() override;
+    char *get_mac_address(char *buf, nsapi_size_t buflen) override;
 
     char *get_interface_name(char *buf);
 private:

connectivity/nanostack/mbed-mesh-api/source/NanostackEMACInterface.cpp

@@ -191,7 +191,7 @@ void EMACPhy::set_mac_address(uint8_t *mac)
     memcpy(mac_addr, mac, sizeof mac_addr);
 }
 
-nsapi_error_t Nanostack::add_ethernet_interface(EMAC &emac, bool default_if, Nanostack::EthernetInterface **interface_out, const uint8_t *mac_addr)
+nsapi_error_t Nanostack::add_ethernet_interface_ns(EMAC &emac, bool default_if, Nanostack::EthernetInterface **interface_out, const uint8_t *mac_addr)
 {
     if (single_phy) {
         return NSAPI_ERROR_DEVICE_ERROR;
@@ -225,10 +225,15 @@ nsapi_error_t Nanostack::add_ethernet_interface(EMAC &emac, bool default_if, Nan
 
 }
 
-nsapi_error_t Nanostack::add_ethernet_interface(EMAC &emac, bool default_if, OnboardNetworkStack::Interface **interface_out)
+nsapi_error_t Nanostack::add_ethernet_interface(EMAC &emac, bool default_if, OnboardNetworkStack::Interface **interface_out, const uint8_t *mac_addr)
 {
     Nanostack::EthernetInterface *interface;
-    nsapi_error_t err = add_ethernet_interface(emac, default_if, &interface);
+    nsapi_error_t err = add_ethernet_interface_ns(emac, default_if, &interface, mac_addr);
     *interface_out = interface;
     return err;
 }
+
+nsapi_error_t Nanostack::add_ethernet_interface(EMAC &emac, bool default_if, OnboardNetworkStack::Interface **interface_out)
+{
+    return Nanostack::add_ethernet_interface(emac, default_if, interface_out, nullptr);
+}

connectivity/nanostack/mbed-mesh-api/source/NanostackEthernetInterface.cpp

@@ -132,3 +132,17 @@ char *Nanostack::EthernetInterface::get_interface_name(char *buf)
     sprintf(buf, "ETH%d", interface_id);
     return buf;
 };
+
+char *Nanostack::EthernetInterface::get_mac_address(char *buf, nsapi_size_t buflen)
+{
+    uint8_t mac_buf[NSAPI_MAC_BYTES];
+
+    if (!buf || buflen < NSAPI_MAC_SIZE) {
+        return NULL;
+    }
+
+    get_phy().get_mac_address(mac_buf);
+
+    snprintf(buf, buflen, "%02x:%02x:%02x:%02x:%02x:%02x", mac_buf[0], mac_buf[1], mac_buf[2], mac_buf[3], mac_buf[4], mac_buf[5]);
+    return buf;
+}

connectivity/netsocket/include/netsocket/EMACInterface.h

@@ -86,6 +86,9 @@ class EMACInterface : public virtual NetworkInterface {
     /** @copydoc NetworkInterface::get_mac_address */
     const char *get_mac_address() override;
 
+    /** @copydoc NetworkInterface::set_mac_address */
+    nsapi_error_t set_mac_address(uint8_t *mac_addr, size_t addr_len);
+
     /** @copydoc NetworkInterface::get_ip_address */
     nsapi_error_t get_ip_address(SocketAddress *address) override;
 
@@ -143,10 +146,12 @@ class EMACInterface : public virtual NetworkInterface {
     OnboardNetworkStack::Interface *_interface = nullptr;
     bool _dhcp = true;
     bool _blocking = true;
+    bool _hw_mac_addr_set = false;
     char _mac_address[NSAPI_MAC_SIZE];
     char _ip_address[NSAPI_IPv6_SIZE] {};
     char _netmask[NSAPI_IPv4_SIZE] {};
     char _gateway[NSAPI_IPv4_SIZE] {};
+    uint8_t _hw_mac_addr[NSAPI_MAC_BYTES];
     mbed::Callback<void(nsapi_event_t, intptr_t)> _connection_status_cb;
 };
 

connectivity/netsocket/include/netsocket/NetworkInterface.h

@@ -104,10 +104,14 @@ class NetworkInterface: public DNS {
     /** Set the MAC address to the interface.
      *
      *  Provided MAC address is set the the network interface. Address must be
-     *  set before using the interface connect() method.
+     *  set before calling the interface connect() method. EUI-48 MAC addresses
+     *  are used for Ethernet while Mesh interface is using 8-byte EUI-64 address.
+     *
+     *  All interfaces are not supporting MAC address set. A call to connect()
+     *  will fail if MAC address is provided but not possible to use.
      *
      *  @param          mac_addr Buffer containing the MAC address
-     *  @param          addr_len Length of provided buffer in bytes
+     *  @param          addr_len Length of provided buffer in bytes (6 or 8 bytes)
      *  @retval         NSAPI_ERROR_OK on success
      *  @retval         NSAPI_ERROR_UNSUPPORTED if this feature is not supported
      *  @retval         NSAPI_ERROR_PARAMETER if address is not valid

connectivity/netsocket/include/netsocket/OnboardNetworkStack.h

@@ -162,6 +162,11 @@ class OnboardNetworkStack : public NetworkStack {
      */
     virtual nsapi_error_t add_ethernet_interface(EMAC &emac, bool default_if, Interface **interface_out) = 0;
 
+    virtual nsapi_error_t add_ethernet_interface(EMAC &emac, bool default_if, Interface **interface_out, const uint8_t *mac_addr)
+    {
+        return NSAPI_ERROR_UNSUPPORTED;
+    }
+
     virtual nsapi_error_t add_l3ip_interface(L3IP &l3ip, bool default_if, Interface **interface_out)
     {
         return NSAPI_ERROR_OK;

connectivity/netsocket/source/EMACInterface.cpp

@@ -49,7 +49,13 @@ nsapi_error_t EMACInterface::set_dhcp(bool dhcp)
 nsapi_error_t EMACInterface::connect()
 {
     if (!_interface) {
-        nsapi_error_t err = _stack.add_ethernet_interface(_emac, true, &_interface);
+        nsapi_error_t err;
+        if (_hw_mac_addr_set) {
+            err = _stack.add_ethernet_interface(_emac, true, &_interface, _hw_mac_addr);
+        } else {
+            err = _stack.add_ethernet_interface(_emac, true, &_interface);
+        }
+
         if (err != NSAPI_ERROR_OK) {
             _interface = NULL;
             return err;
@@ -81,6 +87,23 @@ const char *EMACInterface::get_mac_address()
     return nullptr;
 }
 
+nsapi_error_t EMACInterface::set_mac_address(uint8_t *mac_addr, size_t addr_len)
+{
+    if (!mac_addr || addr_len != NSAPI_MAC_BYTES) {
+        return NSAPI_ERROR_PARAMETER;
+    }
+
+    if (_interface) {
+        // can't set MAC address once initialized
+        return NSAPI_ERROR_BUSY;
+    }
+
+    memcpy(_hw_mac_addr, mac_addr, addr_len);
+    _hw_mac_addr_set = true;
+
+    return NSAPI_ERROR_OK;
+}
+
 nsapi_error_t EMACInterface::get_ip_address(SocketAddress *address)
 {
     if (_interface && _interface->get_ip_address(address) == NSAPI_ERROR_OK) {