Ethernet.h

/* Copyright 2018 Paul Stoffregen
 * Copyright 2020-2021 Arduino SA
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy of this
 * software and associated documentation files (the "Software"), to deal in the Software
 * without restriction, including without limitation the rights to use, copy, modify,
 * merge, publish, distribute, sublicense, and/or sell copies of the Software, and to
 * permit persons to whom the Software is furnished to do so, subject to the following
 * conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
 * INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
 * PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
 * HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
 * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
 * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 */

#ifndef ethernet_h_
#define ethernet_h_

#include "Arduino.h"
#include "SocketHelpers.h"
#include "api/IPAddress.h"

#include "netsocket/NetworkInterface.h"
#include "EthernetInterface.h"

enum EthernetLinkStatus {
  Unknown,
  LinkON,
  LinkOFF
};

enum EthernetHardwareStatus {
  EthernetNoHardware,
  EthernetMbed = 6
};

namespace arduino {

enum {  // compatibility with Arduino ::maintain()
    DHCP_CHECK_NONE         = 0,
    DHCP_CHECK_RENEW_FAIL   = 1,
    DHCP_CHECK_RENEW_OK     = 2,
    DHCP_CHECK_REBIND_FAIL  = 3,
    DHCP_CHECK_REBIND_OK    = 4
};

class EthernetClass : public MbedSocketClass {

public:
  EthernetClass(EthernetInterface *_if)
    : eth_if(_if){};

  // Initialise the Ethernet shield to use the provided MAC address and
  // gain the rest of the configuration through DHCP.
  // Returns 0 if the DHCP configuration failed, and 1 if it succeeded
  int begin(uint8_t *mac = nullptr, unsigned long timeout = 60000, unsigned long responseTimeout = 4000);
  EthernetLinkStatus linkStatus();
  EthernetHardwareStatus hardwareStatus();

  // Manual configuration
  int begin(uint8_t *mac, IPAddress ip);
  int begin(uint8_t *mac, IPAddress ip, IPAddress dns);
  int begin(uint8_t *mac, IPAddress ip, IPAddress dns, IPAddress gateway);
  int begin(uint8_t *mac, IPAddress ip, IPAddress dns, IPAddress gateway, IPAddress subnet, unsigned long timeout = 60000, unsigned long responseTimeout = 4000);

  int begin(IPAddress ip) {
    return begin(nullptr, ip);
  }
  int begin(IPAddress ip, IPAddress dns) {
    return begin(nullptr, ip, dns);
  }
  int begin(IPAddress ip, IPAddress dns, IPAddress gateway) {
    return begin(nullptr, ip, dns, gateway);
  }
  int begin(IPAddress ip, IPAddress dns, IPAddress gateway, IPAddress subnet) {
    return begin(nullptr, ip, dns, gateway, subnet);
  }
  void init(uint8_t sspin = 10);

  void MACAddress(uint8_t *mac_address);

  int disconnect(void);
  void end(void);

  uint8_t status();
  unsigned long getTime();

  void setMACAddress(const uint8_t *mac_address);
  void setLocalIP(const IPAddress local_ip);
  void setSubnetMask(const IPAddress subnet);
  void setGatewayIP(const IPAddress gateway);
  void setDnsServerIP(const IPAddress dns_server) {
    _dnsServer1 = socketAddressFromIpAddress(dns_server, 0);
  }
  void setRetransmissionTimeout(uint16_t milliseconds);
  void setRetransmissionCount(uint8_t num);

  friend class EthernetClient;
  friend class EthernetServer;
  friend class EthernetUDP;

  NetworkInterface *getNetwork();

  constexpr static int maintain () { return DHCP_CHECK_NONE; }

private:
  int _begin(uint8_t *mac, unsigned long timeout, unsigned long responseTimeout);

  volatile EthernetLinkStatus _currentNetworkStatus = Unknown;
  EthernetInterface *eth_if = nullptr;
  arduino::IPAddress ipAddressFromSocketAddress(SocketAddress socketAddress);
};

}

extern arduino::EthernetClass Ethernet;

#include "EthernetClient.h"
#include "EthernetServer.h"
#include "EthernetUdp.h"

#endif