esp32eth.h

/*
  Copyright (C) AC SOFTWARE SP. Z O.O.
 
  This program is free software; you can redistribute it and/or
  modify it under the terms of the GNU General Public License
  as published by the Free Software Foundation; either version 2
  of the License, or (at your option) any later version.
  This program is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  GNU General Public License for more details.
  You should have received a copy of the GNU General Public License
  along with this program; if not, write to the Free Software
  Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
*/
 
/*
  - for LAN8720 + ESP32 - using as less gpio as possible
  - 50MHz oscillator disable on LAN8720 by bridging the oscillator pins 1 and 2
  -ESP32 Gpio-        -LAN8720 PIN -
  GPIO22 - EMAC_TXD1   : TX1
  GPIO19 - EMAC_TXD0   : TX0
  GPIO21 - EMAC_TX_EN  : TX_EN
  GPIO26 - EMAC_RXD1   : RX1
  GPIO25 - EMAC_RXD0   : RX0
  GPIO27 - EMAC_RX_DV  : CRS
  GPIO17 - EMAC_TX_CLK : nINT/REFCLK (50MHz)
  GPIO23 - SMI_MDC     : MDC
  GPIO18 - SMI_MDIO    : MDIO
  GND                  : GND
  3V3                  : VCC
*/
 
#ifndef SRC_SUPLA_NETWORK_ESP32ETH_H_
#define SRC_SUPLA_NETWORK_ESP32ETH_H_
 
#include <Arduino.h>
#include <ETH.h>
#include <supla/network/netif_lan.h>
#include <supla/supla_lib_config.h>
#include <supla/log_wrapper.h>
 
namespace Supla {
class ESPETH;
}  // namespace Supla
 
static Supla::ESPETH *thisEth = nullptr;
 
namespace Supla {
class ESPETH : public Supla::LAN {
 public:
  explicit ESPETH(uint8_t ethMode) {
    thisEth = this;
    if (ethMode == 0) {
      ethAddress = 0;
    } else {
      ethAddress = 1;
    }
  }

  ESPETH(eth_phy_type_t ethType,
         int32_t phyAddr,
         int mdc,
         int mdio,
         int power,
         eth_clock_mode_t clkMode)
      : ethType(ethType),
        ethAddress(phyAddr),
        mdcPin(mdc),
        mdioPin(mdio),
        powerPin(power),
        clkMode(clkMode) {
    thisEth = this;
  }
 
  ~ESPETH() {
    if (thisEth == this) {
      thisEth = nullptr;
    }
  }
 
  static void networkEventHandler(arduino_event_id_t event) {
    switch (event) {
      case ARDUINO_EVENT_ETH_GOT_IP: {
        if (thisEth) {
          thisEth->setIpv4Addr(ETH.localIP());
        }
        Serial.print(F("[Ethernet] local IP: "));
        Serial.println(ETH.localIP());
        Serial.print(F("subnetMask: "));
        Serial.println(ETH.subnetMask());
        Serial.print(F("gatewayIP: "));
        Serial.println(ETH.gatewayIP());
        Serial.print(F("ETH MAC: "));
        Serial.println(ETH.macAddress());
        if (ETH.fullDuplex()) {
          Serial.print(F("FULL_DUPLEX , "));
        }
        Serial.print(ETH.linkSpeed());
        Serial.println(F("Mbps"));
        break;
      }
      case ARDUINO_EVENT_ETH_DISCONNECTED: {
        if (thisEth) {
          SUPLA_LOG_INFO("[%s] Disconnected", thisEth->getIntfName());
          thisEth->setIpv4Addr(0);
        }
        break;
      }
    }
  }
 
 
  void setup() override {
    allowDisable = true;
    if (initDone) {
      return;
    }
 
    ::Network.onEvent(Supla::ESPETH::networkEventHandler);
 
    SUPLA_LOG_INFO(
        "[%s] setting up ETH (type %d, address %d, mdcPin %d, mdioPin %d, "
        "powerPin %d, clkMode %d)",
        thisEth->getIntfName(),
        ethType,
        ethAddress,
        mdcPin,
        mdioPin,
        powerPin,
        clkMode);
    ETH.begin(ethType, ethAddress, mdcPin, mdioPin, powerPin, clkMode);
 
    initDone = true;
 
    char newHostname[32] = {};
    generateHostname(hostname, macSizeForHostname, newHostname);
    strncpy(hostname, newHostname, sizeof(hostname) - 1);
    SUPLA_LOG_DEBUG("[%s] Network LAN/hostname: %s", getIntfName(), hostname);
    ETH.setHostname(hostname);
  }
 
  void disable() override {
    if (!allowDisable) {
      return;
    }
 
    allowDisable = false;
    SUPLA_LOG_DEBUG("[%s] disabling ETH connection", getIntfName());
    DisconnectProtocols();
  }
 
  bool getMacAddr(uint8_t *mac) override {
    if (initDone) {
      ETH.macAddress(mac);
      return true;
    }
    return false;
  }
 
  const char *getIntfName() const override {
    return "ETH";
  }
 
  void setHostname(const char *prefix, int macSize) override {
    macSizeForHostname = macSize;
    strncpy(hostname, prefix, sizeof(hostname) - 1);
    SUPLA_LOG_DEBUG("[%s] Network LAN/hostname: %s", getIntfName(), hostname);
  }
 
 protected:
  bool allowDisable = false;
  int macSizeForHostname = 0;
  bool initDone = false;
  eth_phy_type_t ethType = ETH_PHY_LAN8720;
  int32_t ethAddress = -1;
  int mdcPin = 23;    // GPIO for I2C clock
  int mdioPin = 18;  // GPIO for I2C IO
  int powerPin = -1;  // -1 to disable
  eth_clock_mode_t clkMode = ETH_CLOCK_GPIO17_OUT;
};
 
}  // namespace Supla
 
#endif  // SRC_SUPLA_NETWORK_ESP32ETH_H_