Ethernet.h

Go to the documentation of this file.

/****
 * Sming Framework Project - Open Source framework for high efficiency native ESP8266 development.
 * Created 2015 by Skurydin Alexey
 * http://github.com/SmingHub/Sming
 * All files of the Sming Core are provided under the LGPL v3 license.
 *
 * Ethernet.h
 *
 ****/

#pragma once

#include <WString.h>
#include <IpAddress.h>
#include <MacAddress.h>
#include <Delegate.h>
#include <memory>

#define ETHERNET_EVENT_MAP(XX)                                                                                         \
    XX(Start, "Ethernet driver Started")                                                                               \
    XX(Stop, "Ethernet driver stopped")                                                                                \
    XX(Connected, "Ethernet link established")                                                                         \
    XX(Disconnected, "Ethernet link lost")

namespace Ethernet
{
enum class Event {
#define XX(tag, desc) tag,
    ETHERNET_EVENT_MAP(XX)
#undef XX
};

using EventDelegate = Delegate<void(Ethernet::Event event)>;

using GotIpDelegate = Delegate<void(IpAddress ip, IpAddress netmask, IpAddress gateway)>;

constexpr int8_t PIN_DEFAULT{-2};

constexpr int8_t PIN_UNUSED{-1};

enum class Speed {
    MBPS10,
    MBPS100,
};

struct PhyInstance;

constexpr int8_t PHY_ADDR_AUTO{-1};

struct PhyConfig {
    int8_t phyAddr = PHY_ADDR_AUTO; 
    int8_t resetPin = PIN_UNUSED;   
    uint16_t resetTimeout = 100;    
    uint16_t autoNegTimeout = 4000; 
};

class PhyFactory
{
public:
    using PhyInstance = Ethernet::PhyInstance;

    virtual PhyInstance* create(const PhyConfig& config) = 0;

    virtual void destroy(PhyInstance* inst) = 0;
};

class Service
{
public:
    virtual void end() = 0;

    virtual MacAddress getMacAddress() const = 0;

    virtual bool setMacAddress(const MacAddress& addr) = 0;

    virtual bool setSpeed(Speed speed) = 0;

    virtual bool setFullDuplex(bool enable) = 0;

    virtual bool setLinkState(bool up) = 0;

    virtual bool setPromiscuous(bool enable) = 0;

    virtual void setHostname(const String& hostname) = 0;

    virtual String getHostname() const = 0;

    virtual IpAddress getIP() const = 0;

    virtual bool setIP(IpAddress address, IpAddress netmask, IpAddress gateway) = 0;

    virtual bool isEnabledDHCP() const = 0;

    virtual bool enableDHCP(bool enable) = 0;

    void onEvent(EventDelegate callback)
    {
        eventCallback = callback;
    }

    void onGotIp(GotIpDelegate callback)
    {
        gotIpCallback = callback;
    }

protected:
    EventDelegate eventCallback;
    GotIpDelegate gotIpCallback;
};

} // namespace Ethernet

String toString(Ethernet::Event event);
String toLongString(Ethernet::Event event);