mirror of https://github.com/esphome/esphome.git
465 lines
15 KiB
C++
465 lines
15 KiB
C++
#include "ethernet_component.h"
|
||
#include "esphome/core/log.h"
|
||
#include "esphome/core/util.h"
|
||
#include "esphome/core/application.h"
|
||
|
||
#ifdef USE_ESP32
|
||
|
||
#include <lwip/dns.h>
|
||
#include "esp_event.h"
|
||
|
||
namespace esphome {
|
||
namespace ethernet {
|
||
|
||
static const char *const TAG = "ethernet";
|
||
|
||
EthernetComponent *global_eth_component; // NOLINT(cppcoreguidelines-avoid-non-const-global-variables)
|
||
|
||
#define ESPHL_ERROR_CHECK(err, message) \
|
||
if ((err) != ESP_OK) { \
|
||
ESP_LOGE(TAG, message ": (%d) %s", err, esp_err_to_name(err)); \
|
||
this->mark_failed(); \
|
||
return; \
|
||
}
|
||
|
||
EthernetComponent::EthernetComponent() { global_eth_component = this; }
|
||
|
||
void EthernetComponent::setup() {
|
||
ESP_LOGCONFIG(TAG, "Setting up Ethernet...");
|
||
if (esp_reset_reason() != ESP_RST_DEEPSLEEP) {
|
||
// Delay here to allow power to stabilise before Ethernet is initialized.
|
||
delay(300); // NOLINT
|
||
}
|
||
|
||
esp_err_t err;
|
||
err = esp_netif_init();
|
||
ESPHL_ERROR_CHECK(err, "ETH netif init error");
|
||
err = esp_event_loop_create_default();
|
||
ESPHL_ERROR_CHECK(err, "ETH event loop error");
|
||
|
||
esp_netif_config_t cfg = ESP_NETIF_DEFAULT_ETH();
|
||
this->eth_netif_ = esp_netif_new(&cfg);
|
||
|
||
// Init MAC and PHY configs to default
|
||
eth_phy_config_t phy_config = ETH_PHY_DEFAULT_CONFIG();
|
||
phy_config.phy_addr = this->phy_addr_;
|
||
phy_config.reset_gpio_num = this->power_pin_;
|
||
|
||
eth_mac_config_t mac_config = ETH_MAC_DEFAULT_CONFIG();
|
||
#if ESP_IDF_VERSION_MAJOR >= 5
|
||
eth_esp32_emac_config_t esp32_emac_config = ETH_ESP32_EMAC_DEFAULT_CONFIG();
|
||
esp32_emac_config.smi_mdc_gpio_num = this->mdc_pin_;
|
||
esp32_emac_config.smi_mdio_gpio_num = this->mdio_pin_;
|
||
esp32_emac_config.clock_config.rmii.clock_mode = this->clk_mode_;
|
||
esp32_emac_config.clock_config.rmii.clock_gpio = this->clk_gpio_;
|
||
|
||
esp_eth_mac_t *mac = esp_eth_mac_new_esp32(&esp32_emac_config, &mac_config);
|
||
#else
|
||
mac_config.smi_mdc_gpio_num = this->mdc_pin_;
|
||
mac_config.smi_mdio_gpio_num = this->mdio_pin_;
|
||
mac_config.clock_config.rmii.clock_mode = this->clk_mode_;
|
||
mac_config.clock_config.rmii.clock_gpio = this->clk_gpio_;
|
||
|
||
esp_eth_mac_t *mac = esp_eth_mac_new_esp32(&mac_config);
|
||
#endif
|
||
|
||
switch (this->type_) {
|
||
case ETHERNET_TYPE_LAN8720: {
|
||
this->phy_ = esp_eth_phy_new_lan87xx(&phy_config);
|
||
break;
|
||
}
|
||
case ETHERNET_TYPE_RTL8201: {
|
||
this->phy_ = esp_eth_phy_new_rtl8201(&phy_config);
|
||
break;
|
||
}
|
||
case ETHERNET_TYPE_DP83848: {
|
||
this->phy_ = esp_eth_phy_new_dp83848(&phy_config);
|
||
break;
|
||
}
|
||
case ETHERNET_TYPE_IP101: {
|
||
this->phy_ = esp_eth_phy_new_ip101(&phy_config);
|
||
break;
|
||
}
|
||
case ETHERNET_TYPE_JL1101: {
|
||
this->phy_ = esp_eth_phy_new_jl1101(&phy_config);
|
||
break;
|
||
}
|
||
case ETHERNET_TYPE_KSZ8081:
|
||
case ETHERNET_TYPE_KSZ8081RNA: {
|
||
#if ESP_IDF_VERSION_MAJOR >= 5
|
||
this->phy_ = esp_eth_phy_new_ksz80xx(&phy_config);
|
||
#else
|
||
this->phy_ = esp_eth_phy_new_ksz8081(&phy_config);
|
||
#endif
|
||
break;
|
||
}
|
||
default: {
|
||
this->mark_failed();
|
||
return;
|
||
}
|
||
}
|
||
|
||
esp_eth_config_t eth_config = ETH_DEFAULT_CONFIG(mac, this->phy_);
|
||
this->eth_handle_ = nullptr;
|
||
err = esp_eth_driver_install(ð_config, &this->eth_handle_);
|
||
ESPHL_ERROR_CHECK(err, "ETH driver install error");
|
||
|
||
if (this->type_ == ETHERNET_TYPE_KSZ8081RNA && this->clk_mode_ == EMAC_CLK_OUT) {
|
||
// KSZ8081RNA default is incorrect. It expects a 25MHz clock instead of the 50MHz we provide.
|
||
this->ksz8081_set_clock_reference_(mac);
|
||
}
|
||
|
||
/* attach Ethernet driver to TCP/IP stack */
|
||
err = esp_netif_attach(this->eth_netif_, esp_eth_new_netif_glue(this->eth_handle_));
|
||
ESPHL_ERROR_CHECK(err, "ETH netif attach error");
|
||
|
||
// Register user defined event handers
|
||
err = esp_event_handler_register(ETH_EVENT, ESP_EVENT_ANY_ID, &EthernetComponent::eth_event_handler, nullptr);
|
||
ESPHL_ERROR_CHECK(err, "ETH event handler register error");
|
||
err = esp_event_handler_register(IP_EVENT, IP_EVENT_ETH_GOT_IP, &EthernetComponent::got_ip_event_handler, nullptr);
|
||
ESPHL_ERROR_CHECK(err, "GOT IP event handler register error");
|
||
#if ENABLE_IPV6
|
||
err = esp_event_handler_register(IP_EVENT, IP_EVENT_GOT_IP6, &EthernetComponent::got_ip6_event_handler, nullptr);
|
||
ESPHL_ERROR_CHECK(err, "GOT IP6 event handler register error");
|
||
#endif /* ENABLE_IPV6 */
|
||
|
||
/* start Ethernet driver state machine */
|
||
err = esp_eth_start(this->eth_handle_);
|
||
ESPHL_ERROR_CHECK(err, "ETH start error");
|
||
}
|
||
|
||
void EthernetComponent::loop() {
|
||
const uint32_t now = millis();
|
||
|
||
switch (this->state_) {
|
||
case EthernetComponentState::STOPPED:
|
||
if (this->started_) {
|
||
ESP_LOGI(TAG, "Starting ethernet connection");
|
||
this->state_ = EthernetComponentState::CONNECTING;
|
||
this->start_connect_();
|
||
}
|
||
break;
|
||
case EthernetComponentState::CONNECTING:
|
||
if (!this->started_) {
|
||
ESP_LOGI(TAG, "Stopped ethernet connection");
|
||
this->state_ = EthernetComponentState::STOPPED;
|
||
} else if (this->connected_) {
|
||
// connection established
|
||
ESP_LOGI(TAG, "Connected via Ethernet!");
|
||
this->state_ = EthernetComponentState::CONNECTED;
|
||
|
||
this->dump_connect_params_();
|
||
this->status_clear_warning();
|
||
} else if (now - this->connect_begin_ > 15000) {
|
||
ESP_LOGW(TAG, "Connecting via ethernet failed! Re-connecting...");
|
||
this->start_connect_();
|
||
}
|
||
break;
|
||
case EthernetComponentState::CONNECTED:
|
||
if (!this->started_) {
|
||
ESP_LOGI(TAG, "Stopped ethernet connection");
|
||
this->state_ = EthernetComponentState::STOPPED;
|
||
} else if (!this->connected_) {
|
||
ESP_LOGW(TAG, "Connection via Ethernet lost! Re-connecting...");
|
||
this->state_ = EthernetComponentState::CONNECTING;
|
||
this->start_connect_();
|
||
}
|
||
#if ENABLE_IPV6
|
||
else if (this->got_ipv6_) {
|
||
esp_ip6_addr_t ip6_addr;
|
||
if (esp_netif_get_ip6_global(this->eth_netif_, &ip6_addr) == 0 &&
|
||
esp_netif_ip6_get_addr_type(&ip6_addr) == ESP_IP6_ADDR_IS_GLOBAL) {
|
||
ESP_LOGCONFIG(TAG, "IPv6 Addr (Global): " IPV6STR, IPV62STR(ip6_addr));
|
||
} else {
|
||
esp_netif_get_ip6_linklocal(this->eth_netif_, &ip6_addr);
|
||
ESP_LOGCONFIG(TAG, " IPv6: " IPV6STR, IPV62STR(ip6_addr));
|
||
}
|
||
|
||
this->got_ipv6_ = false;
|
||
}
|
||
#endif /* ENABLE_IPV6 */
|
||
break;
|
||
}
|
||
}
|
||
|
||
void EthernetComponent::dump_config() {
|
||
const char *eth_type;
|
||
switch (this->type_) {
|
||
case ETHERNET_TYPE_LAN8720:
|
||
eth_type = "LAN8720";
|
||
break;
|
||
|
||
case ETHERNET_TYPE_RTL8201:
|
||
eth_type = "RTL8201";
|
||
break;
|
||
|
||
case ETHERNET_TYPE_DP83848:
|
||
eth_type = "DP83848";
|
||
break;
|
||
|
||
case ETHERNET_TYPE_IP101:
|
||
eth_type = "IP101";
|
||
break;
|
||
|
||
case ETHERNET_TYPE_JL1101:
|
||
eth_type = "JL1101";
|
||
break;
|
||
|
||
case ETHERNET_TYPE_KSZ8081:
|
||
eth_type = "KSZ8081";
|
||
break;
|
||
|
||
case ETHERNET_TYPE_KSZ8081RNA:
|
||
eth_type = "KSZ8081RNA";
|
||
break;
|
||
|
||
default:
|
||
eth_type = "Unknown";
|
||
break;
|
||
}
|
||
|
||
ESP_LOGCONFIG(TAG, "Ethernet:");
|
||
this->dump_connect_params_();
|
||
if (this->power_pin_ != -1) {
|
||
ESP_LOGCONFIG(TAG, " Power Pin: %u", this->power_pin_);
|
||
}
|
||
ESP_LOGCONFIG(TAG, " MDC Pin: %u", this->mdc_pin_);
|
||
ESP_LOGCONFIG(TAG, " MDIO Pin: %u", this->mdio_pin_);
|
||
ESP_LOGCONFIG(TAG, " Type: %s", eth_type);
|
||
ESP_LOGCONFIG(TAG, " PHY addr: %u", this->phy_addr_);
|
||
}
|
||
|
||
float EthernetComponent::get_setup_priority() const { return setup_priority::WIFI; }
|
||
|
||
bool EthernetComponent::can_proceed() { return this->is_connected(); }
|
||
|
||
network::IPAddress EthernetComponent::get_ip_address() {
|
||
esp_netif_ip_info_t ip;
|
||
esp_netif_get_ip_info(this->eth_netif_, &ip);
|
||
return network::IPAddress(&ip.ip);
|
||
}
|
||
|
||
void EthernetComponent::eth_event_handler(void *arg, esp_event_base_t event_base, int32_t event, void *event_data) {
|
||
const char *event_name;
|
||
|
||
switch (event) {
|
||
case ETHERNET_EVENT_START:
|
||
event_name = "ETH started";
|
||
global_eth_component->started_ = true;
|
||
break;
|
||
case ETHERNET_EVENT_STOP:
|
||
event_name = "ETH stopped";
|
||
global_eth_component->started_ = false;
|
||
global_eth_component->connected_ = false;
|
||
break;
|
||
case ETHERNET_EVENT_CONNECTED:
|
||
event_name = "ETH connected";
|
||
break;
|
||
case ETHERNET_EVENT_DISCONNECTED:
|
||
event_name = "ETH disconnected";
|
||
global_eth_component->connected_ = false;
|
||
break;
|
||
default:
|
||
return;
|
||
}
|
||
|
||
ESP_LOGV(TAG, "[Ethernet event] %s (num=%" PRId32 ")", event_name, event);
|
||
}
|
||
|
||
void EthernetComponent::got_ip_event_handler(void *arg, esp_event_base_t event_base, int32_t event_id,
|
||
void *event_data) {
|
||
global_eth_component->connected_ = true;
|
||
ESP_LOGV(TAG, "[Ethernet event] ETH Got IP (num=%" PRId32 ")", event_id);
|
||
}
|
||
|
||
#if ENABLE_IPV6
|
||
void EthernetComponent::got_ip6_event_handler(void *arg, esp_event_base_t event_base, int32_t event_id,
|
||
void *event_data) {
|
||
ESP_LOGV(TAG, "[Ethernet event] ETH Got IP6 (num=%d)", event_id);
|
||
global_eth_component->got_ipv6_ = true;
|
||
global_eth_component->ipv6_count_ += 1;
|
||
}
|
||
#endif /* ENABLE_IPV6 */
|
||
|
||
void EthernetComponent::start_connect_() {
|
||
this->connect_begin_ = millis();
|
||
this->status_set_warning();
|
||
|
||
esp_err_t err;
|
||
err = esp_netif_set_hostname(this->eth_netif_, App.get_name().c_str());
|
||
if (err != ERR_OK) {
|
||
ESP_LOGW(TAG, "esp_netif_set_hostname failed: %s", esp_err_to_name(err));
|
||
}
|
||
|
||
esp_netif_ip_info_t info;
|
||
if (this->manual_ip_.has_value()) {
|
||
info.ip = this->manual_ip_->static_ip;
|
||
info.gw = this->manual_ip_->gateway;
|
||
info.netmask = this->manual_ip_->subnet;
|
||
} else {
|
||
info.ip.addr = 0;
|
||
info.gw.addr = 0;
|
||
info.netmask.addr = 0;
|
||
}
|
||
|
||
esp_netif_dhcp_status_t status = ESP_NETIF_DHCP_INIT;
|
||
|
||
err = esp_netif_dhcpc_get_status(this->eth_netif_, &status);
|
||
ESPHL_ERROR_CHECK(err, "DHCPC Get Status Failed!");
|
||
|
||
ESP_LOGV(TAG, "DHCP Client Status: %d", status);
|
||
|
||
err = esp_netif_dhcpc_stop(this->eth_netif_);
|
||
if (err != ESP_ERR_ESP_NETIF_DHCP_ALREADY_STOPPED) {
|
||
ESPHL_ERROR_CHECK(err, "DHCPC stop error");
|
||
}
|
||
|
||
err = esp_netif_set_ip_info(this->eth_netif_, &info);
|
||
ESPHL_ERROR_CHECK(err, "DHCPC set IP info error");
|
||
|
||
if (this->manual_ip_.has_value()) {
|
||
if (this->manual_ip_->dns1.is_set()) {
|
||
ip_addr_t d;
|
||
d = this->manual_ip_->dns1;
|
||
dns_setserver(0, &d);
|
||
}
|
||
if (this->manual_ip_->dns2.is_set()) {
|
||
ip_addr_t d;
|
||
d = this->manual_ip_->dns2;
|
||
dns_setserver(1, &d);
|
||
}
|
||
} else {
|
||
err = esp_netif_dhcpc_start(this->eth_netif_);
|
||
if (err != ESP_ERR_ESP_NETIF_DHCP_ALREADY_STARTED) {
|
||
ESPHL_ERROR_CHECK(err, "DHCPC start error");
|
||
}
|
||
#if ENABLE_IPV6
|
||
err = esp_netif_create_ip6_linklocal(this->eth_netif_);
|
||
if (err != ESP_OK) {
|
||
ESPHL_ERROR_CHECK(err, "IPv6 local failed");
|
||
}
|
||
#endif /* ENABLE_IPV6 */
|
||
}
|
||
|
||
this->connect_begin_ = millis();
|
||
this->status_set_warning();
|
||
}
|
||
|
||
bool EthernetComponent::is_connected() { return this->state_ == EthernetComponentState::CONNECTED; }
|
||
|
||
void EthernetComponent::dump_connect_params_() {
|
||
esp_netif_ip_info_t ip;
|
||
esp_netif_get_ip_info(this->eth_netif_, &ip);
|
||
ESP_LOGCONFIG(TAG, " IP Address: %s", network::IPAddress(&ip.ip).str().c_str());
|
||
ESP_LOGCONFIG(TAG, " Hostname: '%s'", App.get_name().c_str());
|
||
ESP_LOGCONFIG(TAG, " Subnet: %s", network::IPAddress(&ip.netmask).str().c_str());
|
||
ESP_LOGCONFIG(TAG, " Gateway: %s", network::IPAddress(&ip.gw).str().c_str());
|
||
|
||
const ip_addr_t *dns_ip1 = dns_getserver(0);
|
||
const ip_addr_t *dns_ip2 = dns_getserver(1);
|
||
|
||
ESP_LOGCONFIG(TAG, " DNS1: %s", network::IPAddress(dns_ip1).str().c_str());
|
||
ESP_LOGCONFIG(TAG, " DNS2: %s", network::IPAddress(dns_ip2).str().c_str());
|
||
|
||
#if ENABLE_IPV6
|
||
if (this->ipv6_count_ > 0) {
|
||
esp_ip6_addr_t ip6_addr;
|
||
esp_netif_get_ip6_linklocal(this->eth_netif_, &ip6_addr);
|
||
ESP_LOGCONFIG(TAG, " IPv6: " IPV6STR, IPV62STR(ip6_addr));
|
||
|
||
if (esp_netif_get_ip6_global(this->eth_netif_, &ip6_addr) == 0 &&
|
||
esp_netif_ip6_get_addr_type(&ip6_addr) == ESP_IP6_ADDR_IS_GLOBAL) {
|
||
ESP_LOGCONFIG(TAG, "IPv6 Addr (Global): " IPV6STR, IPV62STR(ip6_addr));
|
||
}
|
||
}
|
||
#endif /* ENABLE_IPV6 */
|
||
|
||
esp_err_t err;
|
||
|
||
uint8_t mac[6];
|
||
err = esp_eth_ioctl(this->eth_handle_, ETH_CMD_G_MAC_ADDR, &mac);
|
||
ESPHL_ERROR_CHECK(err, "ETH_CMD_G_MAC error");
|
||
ESP_LOGCONFIG(TAG, " MAC Address: %02X:%02X:%02X:%02X:%02X:%02X", mac[0], mac[1], mac[2], mac[3], mac[4], mac[5]);
|
||
|
||
eth_duplex_t duplex_mode;
|
||
err = esp_eth_ioctl(this->eth_handle_, ETH_CMD_G_DUPLEX_MODE, &duplex_mode);
|
||
ESPHL_ERROR_CHECK(err, "ETH_CMD_G_DUPLEX_MODE error");
|
||
ESP_LOGCONFIG(TAG, " Is Full Duplex: %s", YESNO(duplex_mode == ETH_DUPLEX_FULL));
|
||
|
||
eth_speed_t speed;
|
||
err = esp_eth_ioctl(this->eth_handle_, ETH_CMD_G_SPEED, &speed);
|
||
ESPHL_ERROR_CHECK(err, "ETH_CMD_G_SPEED error");
|
||
ESP_LOGCONFIG(TAG, " Link Speed: %u", speed == ETH_SPEED_100M ? 100 : 10);
|
||
}
|
||
|
||
void EthernetComponent::set_phy_addr(uint8_t phy_addr) { this->phy_addr_ = phy_addr; }
|
||
void EthernetComponent::set_power_pin(int power_pin) { this->power_pin_ = power_pin; }
|
||
void EthernetComponent::set_mdc_pin(uint8_t mdc_pin) { this->mdc_pin_ = mdc_pin; }
|
||
void EthernetComponent::set_mdio_pin(uint8_t mdio_pin) { this->mdio_pin_ = mdio_pin; }
|
||
void EthernetComponent::set_type(EthernetType type) { this->type_ = type; }
|
||
void EthernetComponent::set_clk_mode(emac_rmii_clock_mode_t clk_mode, emac_rmii_clock_gpio_t clk_gpio) {
|
||
this->clk_mode_ = clk_mode;
|
||
this->clk_gpio_ = clk_gpio;
|
||
}
|
||
void EthernetComponent::set_manual_ip(const ManualIP &manual_ip) { this->manual_ip_ = manual_ip; }
|
||
|
||
std::string EthernetComponent::get_use_address() const {
|
||
if (this->use_address_.empty()) {
|
||
return App.get_name() + ".local";
|
||
}
|
||
return this->use_address_;
|
||
}
|
||
|
||
void EthernetComponent::set_use_address(const std::string &use_address) { this->use_address_ = use_address; }
|
||
|
||
bool EthernetComponent::powerdown() {
|
||
ESP_LOGI(TAG, "Powering down ethernet PHY");
|
||
if (this->phy_ == nullptr) {
|
||
ESP_LOGE(TAG, "Ethernet PHY not assigned");
|
||
return false;
|
||
}
|
||
this->connected_ = false;
|
||
this->started_ = false;
|
||
if (this->phy_->pwrctl(this->phy_, false) != ESP_OK) {
|
||
ESP_LOGE(TAG, "Error powering down ethernet PHY");
|
||
return false;
|
||
}
|
||
return true;
|
||
}
|
||
|
||
void EthernetComponent::ksz8081_set_clock_reference_(esp_eth_mac_t *mac) {
|
||
#define KSZ80XX_PC2R_REG_ADDR (0x1F)
|
||
|
||
esp_err_t err;
|
||
|
||
uint32_t phy_control_2;
|
||
err = mac->read_phy_reg(mac, this->phy_addr_, KSZ80XX_PC2R_REG_ADDR, &(phy_control_2));
|
||
ESPHL_ERROR_CHECK(err, "Read PHY Control 2 failed");
|
||
ESP_LOGVV(TAG, "KSZ8081 PHY Control 2: %s", format_hex_pretty((u_int8_t *) &phy_control_2, 2).c_str());
|
||
|
||
/*
|
||
* Bit 7 is `RMII Reference Clock Select`. Default is `0`.
|
||
* KSZ8081RNA:
|
||
* 0 - clock input to XI (Pin 8) is 25 MHz for RMII – 25 MHz clock mode.
|
||
* 1 - clock input to XI (Pin 8) is 50 MHz for RMII – 50 MHz clock mode.
|
||
* KSZ8081RND:
|
||
* 0 - clock input to XI (Pin 8) is 50 MHz for RMII – 50 MHz clock mode.
|
||
* 1 - clock input to XI (Pin 8) is 25 MHz (driven clock only, not a crystal) for RMII – 25 MHz clock mode.
|
||
*/
|
||
if ((phy_control_2 & (1 << 7)) != (1 << 7)) {
|
||
phy_control_2 |= 1 << 7;
|
||
err = mac->write_phy_reg(mac, this->phy_addr_, KSZ80XX_PC2R_REG_ADDR, phy_control_2);
|
||
ESPHL_ERROR_CHECK(err, "Write PHY Control 2 failed");
|
||
err = mac->read_phy_reg(mac, this->phy_addr_, KSZ80XX_PC2R_REG_ADDR, &(phy_control_2));
|
||
ESPHL_ERROR_CHECK(err, "Read PHY Control 2 failed");
|
||
ESP_LOGVV(TAG, "KSZ8081 PHY Control 2: %s", format_hex_pretty((u_int8_t *) &phy_control_2, 2).c_str());
|
||
}
|
||
|
||
#undef KSZ80XX_PC2R_REG_ADDR
|
||
}
|
||
|
||
} // namespace ethernet
|
||
} // namespace esphome
|
||
|
||
#endif // USE_ESP32
|