Insert EMACInterface class

Rather than let "EthernetInterface" be the base EMAC NetworkInterface,
insert an "EMACInterface" class.

EthernetInterface then derives from EMACInterface and EthInterface.

A Wi-Fi driver can derive from EMACInterface and WiFiInterface - this
will be more logical than deriving from EthernetInterface and
WiFiInterface.

This does mean adding a couple of virtual inheritances to avoid
duplicate NetworkInterfaces:

                   NetworkInterface
                     /           \
            virtual /             \ virtual
                   /               \
             EMACInterface     WiFiInterface
                   \               /
                    \             /
                     \           /
                  MyCustomWiFiInterface

Author: kjbracey

features/netsocket/EMAC.h

@@ -148,7 +148,7 @@ class EMAC {
 
 
 /** These need to be defined by targets wishing to provide an Ethernet driver using EMAC interface. It will
- *  be used by the EthernetInterface class's default constructor to initialise the networking subsystem.
+ *  be used by the EMACInterface class's default constructor to initialise the networking subsystem.
  */
 //extern const emac_interface_ops_t mbed_emac_eth_ops_default;
 //extern void *mbed_emac_eth_hw_default;

features/netsocket/EthernetInterface.cpp renamed to features/netsocket/EMACInterface.cpp

@@ -14,15 +14,15 @@
  * limitations under the License.
  */
 
-#include "EthernetInterface.h"
+#include "EMACInterface.h"
 
 /* Interface implementation */
-EthernetInterface::EthernetInterface(EMAC &emac, OnboardNetworkStack &stack)
+EMACInterface::EMACInterface(EMAC &emac, OnboardNetworkStack &stack)
     : _emac(emac), _stack(stack), _interface(NULL), _dhcp(true), _mac_address(), _ip_address(), _netmask(), _gateway()
 {
 }
 
-nsapi_error_t EthernetInterface::set_network(const char *ip_address, const char *netmask, const char *gateway)
+nsapi_error_t EMACInterface::set_network(const char *ip_address, const char *netmask, const char *gateway)
 {
     _dhcp = false;
 
@@ -36,13 +36,13 @@ nsapi_error_t EthernetInterface::set_network(const char *ip_address, const char
     return NSAPI_ERROR_OK;
 }
 
-nsapi_error_t EthernetInterface::set_dhcp(bool dhcp)
+nsapi_error_t EMACInterface::set_dhcp(bool dhcp)
 {
     _dhcp = dhcp;
     return NSAPI_ERROR_OK;
 }
 
-nsapi_error_t EthernetInterface::connect()
+nsapi_error_t EMACInterface::connect()
 {
     if (!_interface) {
         nsapi_error_t err = _stack.add_ethernet_interface(_emac, true, &_interface);
@@ -59,20 +59,20 @@ nsapi_error_t EthernetInterface::connect()
             DEFAULT_STACK);
 }
 
-nsapi_error_t EthernetInterface::disconnect()
+nsapi_error_t EMACInterface::disconnect()
 {
     return _interface->bringdown();
 }
 
-const char *EthernetInterface::get_mac_address()
+const char *EMACInterface::get_mac_address()
 {
     if (_interface->get_mac_address(_mac_address, sizeof(_mac_address))) {
         return _mac_address;
     }
     return NULL;
 }
 
-const char *EthernetInterface::get_ip_address()
+const char *EMACInterface::get_ip_address()
 {
     if (_interface->get_ip_address(_ip_address, sizeof(_ip_address))) {
         return _ip_address;
@@ -81,7 +81,7 @@ const char *EthernetInterface::get_ip_address()
     return NULL;
 }
 
-const char *EthernetInterface::get_netmask()
+const char *EMACInterface::get_netmask()
 {
     if (_interface->get_netmask(_netmask, sizeof(_netmask))) {
         return _netmask;
@@ -90,7 +90,7 @@ const char *EthernetInterface::get_netmask()
     return 0;
 }
 
-const char *EthernetInterface::get_gateway()
+const char *EMACInterface::get_gateway()
 {
     if (_interface->get_gateway(_gateway, sizeof(_gateway))) {
         return _gateway;
@@ -99,7 +99,7 @@ const char *EthernetInterface::get_gateway()
     return 0;
 }
 
-NetworkStack *EthernetInterface::get_stack()
+NetworkStack *EMACInterface::get_stack()
 {
     return &_stack;
 }

features/netsocket/EMACInterface.h

@@ -0,0 +1,131 @@
+/* LWIP implementation of NetworkInterfaceAPI
+ * Copyright (c) 2015 ARM Limited
+ *
+ * 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 EMAC_INTERFACE_H
+#define EMAC_INTERFACE_H
+
+#include "nsapi.h"
+#include "rtos.h"
+#include "EMAC.h"
+#include "OnboardNetworkStack.h"
+
+
+/** EMACInterface class
+ *  Implementation of the NetworkInterface for an EMAC-based driver
+ */
+class EMACInterface : public virtual NetworkInterface
+{
+public:
+    /** Create an EMAC-based network interface.
+     *
+     * The default arguments obtain the default EMAC, which will be target-
+     * dependent (and the target may have some JSON option to choose which
+     * is the default, if there are multiple). The default stack is configured
+     * by JSON option nsapi.default-stack.
+     *
+     * Due to inability to return errors from the constructor, no real
+     * work is done until the first call to connect().
+     *
+     * @param emac  Reference to EMAC to use
+     * @param stack Reference to onboard-network stack to use
+     */
+    EMACInterface(
+            EMAC &emac = EMAC::get_default_instance(),
+            OnboardNetworkStack &stack = OnboardNetworkStack::get_default_instance());
+
+    /** Set a static IP address
+     *
+     *  Configures this network interface to use a static IP address.
+     *  Implicitly disables DHCP, which can be enabled in set_dhcp.
+     *  Requires that the network is disconnected.
+     *
+     *  @param ip_address  Null-terminated representation of the local IP address
+     *  @param netmask     Null-terminated representation of the local network mask
+     *  @param gateway     Null-terminated representation of the local gateway
+     *  @return            0 on success, negative error code on failure
+     */
+    virtual nsapi_error_t set_network(
+            const char *ip_address, const char *netmask, const char *gateway);
+
+    /** Enable or disable DHCP on the network
+     *
+     *  Requires that the network is disconnected
+     *
+     *  @param dhcp     False to disable dhcp (defaults to enabled)
+     *  @return         0 on success, negative error code on failure
+     */
+    virtual nsapi_error_t set_dhcp(bool dhcp);
+
+    /** Start the interface
+     *  @return             0 on success, negative on failure
+     */
+    virtual nsapi_error_t connect();
+
+    /** Stop the interface
+     *  @return             0 on success, negative on failure
+     */
+    virtual nsapi_error_t disconnect();
+
+    /** Get the local MAC address
+     *
+     *  Provided MAC address is intended for info or debug purposes and
+     *  may not be provided if the underlying network interface does not
+     *  provide a MAC address
+     *  
+     *  @return         Null-terminated representation of the local MAC address
+     *                  or null if no MAC address is available
+     */
+    virtual const char *get_mac_address();
+
+    /** Get the local IP address
+     *
+     *  @return         Null-terminated representation of the local IP address
+     *                  or null if no IP address has been recieved
+     */
+    virtual const char *get_ip_address();
+
+    /** Get the local network mask
+     *
+     *  @return         Null-terminated representation of the local network mask 
+     *                  or null if no network mask has been recieved
+     */
+    virtual const char *get_netmask();
+
+    /** Get the local gateways
+     *
+     *  @return         Null-terminated representation of the local gateway
+     *                  or null if no network mask has been recieved
+     */
+    virtual const char *get_gateway();
+
+protected:
+    /** Provide access to the underlying stack
+     *
+     *  @return The underlying network stack 
+     */
+    virtual NetworkStack *get_stack();
+
+    EMAC &_emac;
+    OnboardNetworkStack &_stack;
+    OnboardNetworkStack::Interface *_interface;
+    bool _dhcp;
+    char _mac_address[NSAPI_MAC_SIZE];
+    char _ip_address[NSAPI_IPv6_SIZE];
+    char _netmask[NSAPI_IPv4_SIZE];
+    char _gateway[NSAPI_IPv4_SIZE];
+};
+
+#endif

features/netsocket/EthInterface.h

@@ -27,7 +27,7 @@
  *
  *  Common interface that is shared between ethernet hardware.
  */
-class EthInterface : public NetworkInterface
+class EthInterface : public virtual NetworkInterface
 {
 };
 

features/netsocket/EthernetInterface.h

@@ -19,14 +19,13 @@
 
 #include "nsapi.h"
 #include "rtos.h"
-#include "EMAC.h"
-#include "OnboardNetworkStack.h"
+#include "EMACInterface.h"
 
 
 /** EthernetInterface class
- *  Implementation of the NetworkStack for an EMAC-based driver
+ *  Implementation of the NetworkStack for an EMAC-based Ethernet driver
  */
-class EthernetInterface : public EthInterface
+class EthernetInterface : public EMACInterface, public EthInterface
 {
 public:
     /** Create an EMAC-based ethernet interface.
@@ -44,88 +43,7 @@ class EthernetInterface : public EthInterface
      */
     EthernetInterface(
             EMAC &emac = EMAC::get_default_instance(),
-            OnboardNetworkStack &stack = OnboardNetworkStack::get_default_instance());
-
-    /** Set a static IP address
-     *
-     *  Configures this network interface to use a static IP address.
-     *  Implicitly disables DHCP, which can be enabled in set_dhcp.
-     *  Requires that the network is disconnected.
-     *
-     *  @param ip_address  Null-terminated representation of the local IP address
-     *  @param netmask     Null-terminated representation of the local network mask
-     *  @param gateway     Null-terminated representation of the local gateway
-     *  @return            0 on success, negative error code on failure
-     */
-    virtual nsapi_error_t set_network(
-            const char *ip_address, const char *netmask, const char *gateway);
-
-    /** Enable or disable DHCP on the network
-     *
-     *  Requires that the network is disconnected
-     *
-     *  @param dhcp     False to disable dhcp (defaults to enabled)
-     *  @return         0 on success, negative error code on failure
-     */
-    virtual nsapi_error_t set_dhcp(bool dhcp);
-
-    /** Start the interface
-     *  @return             0 on success, negative on failure
-     */
-    virtual nsapi_error_t connect();
-
-    /** Stop the interface
-     *  @return             0 on success, negative on failure
-     */
-    virtual nsapi_error_t disconnect();
-
-    /** Get the local MAC address
-     *
-     *  Provided MAC address is intended for info or debug purposes and
-     *  may not be provided if the underlying network interface does not
-     *  provide a MAC address
-     *  
-     *  @return         Null-terminated representation of the local MAC address
-     *                  or null if no MAC address is available
-     */
-    virtual const char *get_mac_address();
-
-    /** Get the local IP address
-     *
-     *  @return         Null-terminated representation of the local IP address
-     *                  or null if no IP address has been recieved
-     */
-    virtual const char *get_ip_address();
-
-    /** Get the local network mask
-     *
-     *  @return         Null-terminated representation of the local network mask 
-     *                  or null if no network mask has been recieved
-     */
-    virtual const char *get_netmask();
-
-    /** Get the local gateways
-     *
-     *  @return         Null-terminated representation of the local gateway
-     *                  or null if no network mask has been recieved
-     */
-    virtual const char *get_gateway();
-
-protected:
-    /** Provide access to the underlying stack
-     *
-     *  @return The underlying network stack 
-     */
-    virtual NetworkStack *get_stack();
-
-    EMAC &_emac;
-    OnboardNetworkStack &_stack;
-    OnboardNetworkStack::Interface *_interface;
-    bool _dhcp;
-    char _mac_address[NSAPI_MAC_SIZE];
-    char _ip_address[NSAPI_IPv6_SIZE];
-    char _netmask[NSAPI_IPv4_SIZE];
-    char _gateway[NSAPI_IPv4_SIZE];
+            OnboardNetworkStack &stack = OnboardNetworkStack::get_default_instance()) : EMACInterface(emac, stack) { }
 };
 
 #endif

features/netsocket/WiFiInterface.h

@@ -27,7 +27,7 @@
  *  Common interface that is shared between WiFi devices
  *  @addtogroup netsocket
  */
-class WiFiInterface: public NetworkInterface
+class WiFiInterface: public virtual NetworkInterface
 {
 public:
     /** WiFiInterface lifetime