10 #include "esp_event.h" 12 #ifdef USE_ETHERNET_SPI 13 #include <driver/gpio.h> 14 #include <driver/spi_master.h> 20 static const char *
const TAG =
"ethernet";
24 #define ESPHL_ERROR_CHECK(err, message) \ 25 if ((err) != ESP_OK) { \ 26 ESP_LOGE(TAG, message ": (%d) %s", err, esp_err_to_name(err)); \ 27 this->mark_failed(); \ 34 ESP_LOGCONFIG(TAG,
"Setting up Ethernet...");
35 if (esp_reset_reason() != ESP_RST_DEEPSLEEP) {
42 #ifdef USE_ETHERNET_SPI 44 gpio_install_isr_service(0);
46 spi_bus_config_t buscfg = {
61 #if defined(USE_ESP32_VARIANT_ESP32C3) || defined(USE_ESP32_VARIANT_ESP32S2) || defined(USE_ESP32_VARIANT_ESP32S3) 62 auto host = SPI2_HOST;
64 auto host = SPI3_HOST;
67 err = spi_bus_initialize(host, &buscfg, SPI_DMA_CH_AUTO);
68 ESPHL_ERROR_CHECK(err,
"SPI bus initialize error");
71 err = esp_netif_init();
72 ESPHL_ERROR_CHECK(err,
"ETH netif init error");
73 err = esp_event_loop_create_default();
74 ESPHL_ERROR_CHECK(err,
"ETH event loop error");
76 esp_netif_config_t cfg = ESP_NETIF_DEFAULT_ETH();
80 eth_phy_config_t phy_config = ETH_PHY_DEFAULT_CONFIG();
81 eth_mac_config_t mac_config = ETH_MAC_DEFAULT_CONFIG();
83 #ifdef USE_ETHERNET_SPI // Configure SPI interface and Ethernet driver for specific SPI module 84 spi_device_interface_config_t devcfg = {
91 .cs_ena_posttrans = 0,
101 spi_device_handle_t spi_handle =
nullptr;
102 err = spi_bus_add_device(host, &devcfg, &spi_handle);
103 ESPHL_ERROR_CHECK(err,
"SPI bus add device error");
105 eth_w5500_config_t w5500_config = ETH_W5500_DEFAULT_CONFIG(spi_handle);
110 esp_eth_mac_t *mac = esp_eth_mac_new_w5500(&w5500_config, &mac_config);
115 #if ESP_IDF_VERSION_MAJOR >= 5 116 eth_esp32_emac_config_t esp32_emac_config = ETH_ESP32_EMAC_DEFAULT_CONFIG();
117 esp32_emac_config.smi_mdc_gpio_num = this->
mdc_pin_;
118 esp32_emac_config.smi_mdio_gpio_num = this->
mdio_pin_;
119 esp32_emac_config.clock_config.rmii.clock_mode = this->
clk_mode_;
120 esp32_emac_config.clock_config.rmii.clock_gpio = this->
clk_gpio_;
122 esp_eth_mac_t *mac = esp_eth_mac_new_esp32(&esp32_emac_config, &mac_config);
124 mac_config.smi_mdc_gpio_num = this->
mdc_pin_;
125 mac_config.smi_mdio_gpio_num = this->
mdio_pin_;
126 mac_config.clock_config.rmii.clock_mode = this->
clk_mode_;
127 mac_config.clock_config.rmii.clock_gpio = this->
clk_gpio_;
129 esp_eth_mac_t *mac = esp_eth_mac_new_esp32(&mac_config);
133 switch (this->
type_) {
134 #if CONFIG_ETH_USE_ESP32_EMAC 136 this->
phy_ = esp_eth_phy_new_lan87xx(&phy_config);
140 this->
phy_ = esp_eth_phy_new_rtl8201(&phy_config);
144 this->
phy_ = esp_eth_phy_new_dp83848(&phy_config);
148 this->
phy_ = esp_eth_phy_new_ip101(&phy_config);
157 #if ESP_IDF_VERSION_MAJOR >= 5 158 this->
phy_ = esp_eth_phy_new_ksz80xx(&phy_config);
160 this->
phy_ = esp_eth_phy_new_ksz8081(&phy_config);
165 #ifdef USE_ETHERNET_SPI 167 this->
phy_ = esp_eth_phy_new_w5500(&phy_config);
177 esp_eth_config_t eth_config = ETH_DEFAULT_CONFIG(mac, this->
phy_);
179 err = esp_eth_driver_install(ð_config, &this->
eth_handle_);
180 ESPHL_ERROR_CHECK(err,
"ETH driver install error");
182 #ifndef USE_ETHERNET_SPI 191 esp_read_mac(mac_addr, ESP_MAC_ETH);
192 err = esp_eth_ioctl(this->
eth_handle_, ETH_CMD_S_MAC_ADDR, mac_addr);
193 ESPHL_ERROR_CHECK(err,
"set mac address error");
197 ESPHL_ERROR_CHECK(err,
"ETH netif attach error");
201 ESPHL_ERROR_CHECK(err,
"ETH event handler register error");
203 ESPHL_ERROR_CHECK(err,
"GOT IP event handler register error");
206 ESPHL_ERROR_CHECK(err,
"GOT IPv6 event handler register error");
211 ESPHL_ERROR_CHECK(err,
"ETH start error");
215 const uint32_t now =
millis();
220 ESP_LOGI(TAG,
"Starting ethernet connection");
227 ESP_LOGI(TAG,
"Stopped ethernet connection");
231 ESP_LOGI(TAG,
"Connected via Ethernet!");
237 ESP_LOGW(TAG,
"Connecting via ethernet failed! Re-connecting...");
243 ESP_LOGI(TAG,
"Stopped ethernet connection");
246 ESP_LOGW(TAG,
"Connection via Ethernet lost! Re-connecting...");
255 const char *eth_type;
256 switch (this->
type_) {
258 eth_type =
"LAN8720";
262 eth_type =
"RTL8201";
266 eth_type =
"DP83848";
278 eth_type =
"KSZ8081";
282 eth_type =
"KSZ8081RNA";
290 eth_type =
"Unknown";
294 ESP_LOGCONFIG(TAG,
"Ethernet:");
296 #ifdef USE_ETHERNET_SPI 297 ESP_LOGCONFIG(TAG,
" CLK Pin: %u", this->
clk_pin_);
298 ESP_LOGCONFIG(TAG,
" MISO Pin: %u", this->
miso_pin_);
299 ESP_LOGCONFIG(TAG,
" MOSI Pin: %u", this->
mosi_pin_);
300 ESP_LOGCONFIG(TAG,
" CS Pin: %u", this->
cs_pin_);
302 ESP_LOGCONFIG(TAG,
" Reset Pin: %d", this->
reset_pin_);
303 ESP_LOGCONFIG(TAG,
" Clock Speed: %d MHz", this->
clock_speed_ / 1000000);
306 ESP_LOGCONFIG(TAG,
" Power Pin: %u", this->
power_pin_);
308 ESP_LOGCONFIG(TAG,
" MDC Pin: %u", this->
mdc_pin_);
309 ESP_LOGCONFIG(TAG,
" MDIO Pin: %u", this->
mdio_pin_);
310 ESP_LOGCONFIG(TAG,
" PHY addr: %u", this->
phy_addr_);
312 ESP_LOGCONFIG(TAG,
" Type: %s", eth_type);
321 esp_netif_ip_info_t ip;
322 esp_err_t err = esp_netif_get_ip_info(this->
eth_netif_, &ip);
324 ESP_LOGV(TAG,
"esp_netif_get_ip_info failed: %s", esp_err_to_name(err));
331 struct esp_ip6_addr if_ip6s[CONFIG_LWIP_IPV6_NUM_ADDRESSES];
333 count = esp_netif_get_all_ip6(this->
eth_netif_, if_ip6s);
334 assert(count <= CONFIG_LWIP_IPV6_NUM_ADDRESSES);
335 for (
int i = 0; i < count; i++) {
344 const char *event_name;
347 case ETHERNET_EVENT_START:
348 event_name =
"ETH started";
349 global_eth_component->
started_ =
true;
351 case ETHERNET_EVENT_STOP:
352 event_name =
"ETH stopped";
353 global_eth_component->
started_ =
false;
356 case ETHERNET_EVENT_CONNECTED:
357 event_name =
"ETH connected";
359 case ETHERNET_EVENT_DISCONNECTED:
360 event_name =
"ETH disconnected";
367 ESP_LOGV(TAG,
"[Ethernet event] %s (num=%" PRId32
")", event_name, event);
372 ip_event_got_ip_t *
event = (ip_event_got_ip_t *) event_data;
373 const esp_netif_ip_info_t *ip_info = &
event->ip_info;
374 ESP_LOGV(TAG,
"[Ethernet event] ETH Got IP " IPSTR, IP2STR(&ip_info->ip));
377 global_eth_component->
connected_ = global_eth_component->
ipv6_count_ >= USE_NETWORK_MIN_IPV6_ADDR_COUNT;
386 ip_event_got_ip6_t *
event = (ip_event_got_ip6_t *) event_data;
387 ESP_LOGV(TAG,
"[Ethernet event] ETH Got IPv6: " IPV6STR, IPV62STR(event->ip6_info.ip));
405 ESP_LOGW(TAG,
"esp_netif_set_hostname failed: %s", esp_err_to_name(err));
408 esp_netif_ip_info_t info;
416 info.netmask.addr = 0;
419 esp_netif_dhcp_status_t
status = ESP_NETIF_DHCP_INIT;
421 err = esp_netif_dhcpc_get_status(this->
eth_netif_, &status);
422 ESPHL_ERROR_CHECK(err,
"DHCPC Get Status Failed!");
424 ESP_LOGV(TAG,
"DHCP Client Status: %d", status);
427 if (err != ESP_ERR_ESP_NETIF_DHCP_ALREADY_STOPPED) {
428 ESPHL_ERROR_CHECK(err,
"DHCPC stop error");
431 err = esp_netif_set_ip_info(this->
eth_netif_, &info);
432 ESPHL_ERROR_CHECK(err,
"DHCPC set IP info error");
438 dns_setserver(0, &d);
443 dns_setserver(1, &d);
446 err = esp_netif_dhcpc_start(this->
eth_netif_);
447 if (err != ESP_ERR_ESP_NETIF_DHCP_ALREADY_STARTED) {
448 ESPHL_ERROR_CHECK(err,
"DHCPC start error");
451 err = esp_netif_create_ip6_linklocal(this->
eth_netif_);
453 ESPHL_ERROR_CHECK(err,
"Enable IPv6 link local failed");
465 esp_netif_ip_info_t ip;
468 ESP_LOGCONFIG(TAG,
" Hostname: '%s'",
App.
get_name().c_str());
472 const ip_addr_t *dns_ip1 = dns_getserver(0);
473 const ip_addr_t *dns_ip2 = dns_getserver(1);
479 struct esp_ip6_addr if_ip6s[CONFIG_LWIP_IPV6_NUM_ADDRESSES];
481 count = esp_netif_get_all_ip6(this->
eth_netif_, if_ip6s);
482 assert(count <= CONFIG_LWIP_IPV6_NUM_ADDRESSES);
483 for (
int i = 0; i < count; i++) {
484 ESP_LOGCONFIG(TAG,
" IPv6: " IPV6STR, IPV62STR(if_ip6s[i]));
491 err = esp_eth_ioctl(this->
eth_handle_, ETH_CMD_G_MAC_ADDR, &mac);
492 ESPHL_ERROR_CHECK(err,
"ETH_CMD_G_MAC error");
493 ESP_LOGCONFIG(TAG,
" MAC Address: %02X:%02X:%02X:%02X:%02X:%02X", mac[0], mac[1], mac[2], mac[3], mac[4], mac[5]);
495 eth_duplex_t duplex_mode;
496 err = esp_eth_ioctl(this->
eth_handle_, ETH_CMD_G_DUPLEX_MODE, &duplex_mode);
497 ESPHL_ERROR_CHECK(err,
"ETH_CMD_G_DUPLEX_MODE error");
498 ESP_LOGCONFIG(TAG,
" Is Full Duplex: %s", YESNO(duplex_mode == ETH_DUPLEX_FULL));
501 err = esp_eth_ioctl(this->
eth_handle_, ETH_CMD_G_SPEED, &speed);
502 ESPHL_ERROR_CHECK(err,
"ETH_CMD_G_SPEED error");
503 ESP_LOGCONFIG(TAG,
" Link Speed: %u", speed == ETH_SPEED_100M ? 100 : 10);
506 #ifdef USE_ETHERNET_SPI 537 ESP_LOGI(TAG,
"Powering down ethernet PHY");
538 if (this->
phy_ ==
nullptr) {
539 ESP_LOGE(TAG,
"Ethernet PHY not assigned");
544 if (this->
phy_->pwrctl(this->phy_,
false) != ESP_OK) {
545 ESP_LOGE(TAG,
"Error powering down ethernet PHY");
551 #ifndef USE_ETHERNET_SPI 553 #define KSZ80XX_PC2R_REG_ADDR (0x1F) 557 uint32_t phy_control_2;
558 err = mac->read_phy_reg(mac, this->
phy_addr_, KSZ80XX_PC2R_REG_ADDR, &(phy_control_2));
559 ESPHL_ERROR_CHECK(err,
"Read PHY Control 2 failed");
560 ESP_LOGVV(TAG,
"KSZ8081 PHY Control 2: %s",
format_hex_pretty((u_int8_t *) &phy_control_2, 2).c_str());
571 if ((phy_control_2 & (1 << 7)) != (1 << 7)) {
572 phy_control_2 |= 1 << 7;
573 err = mac->write_phy_reg(mac, this->
phy_addr_, KSZ80XX_PC2R_REG_ADDR, phy_control_2);
574 ESPHL_ERROR_CHECK(err,
"Write PHY Control 2 failed");
575 err = mac->read_phy_reg(mac, this->
phy_addr_, KSZ80XX_PC2R_REG_ADDR, &(phy_control_2));
576 ESPHL_ERROR_CHECK(err,
"Read PHY Control 2 failed");
577 ESP_LOGVV(TAG,
"KSZ8081 PHY Control 2: %s",
format_hex_pretty((u_int8_t *) &phy_control_2, 2).c_str());
580 #undef KSZ80XX_PC2R_REG_ADDR bool can_proceed() override
std::string format_hex_pretty(const uint8_t *data, size_t length)
Format the byte array data of length len in pretty-printed, human-readable hex.
void set_manual_ip(const ManualIP &manual_ip)
esp_eth_phy_t * esp_eth_phy_new_jl1101(const eth_phy_config_t *config)
void set_power_pin(int power_pin)
void set_mdio_pin(uint8_t mdio_pin)
void status_set_warning(const char *message="unspecified")
void ksz8081_set_clock_reference_(esp_eth_mac_t *mac)
Set RMII Reference Clock Select bit for KSZ8081.
void set_mdc_pin(uint8_t mdc_pin)
void set_interrupt_pin(uint8_t interrupt_pin)
EthernetComponentState state_
void set_miso_pin(uint8_t miso_pin)
void set_reset_pin(uint8_t reset_pin)
static void got_ip6_event_handler(void *arg, esp_event_base_t event_base, int32_t event_id, void *event_data)
void set_clk_pin(uint8_t clk_pin)
void set_mosi_pin(uint8_t mosi_pin)
uint32_t IRAM_ATTR HOT millis()
EthernetComponent * global_eth_component
emac_rmii_clock_gpio_t clk_gpio_
void set_clk_mode(emac_rmii_clock_mode_t clk_mode, emac_rmii_clock_gpio_t clk_gpio)
void set_type(EthernetType type)
void dump_connect_params_()
network::IPAddresses get_ip_addresses()
void set_clock_speed(int clock_speed)
static void got_ip_event_handler(void *arg, esp_event_base_t event_base, int32_t event_id, void *event_data)
void set_cs_pin(uint8_t cs_pin)
void status_clear_warning()
Application App
Global storage of Application pointer - only one Application can exist.
const std::string & get_name() const
Get the name of this Application set by pre_setup().
std::array< IPAddress, 5 > IPAddresses
void set_use_address(const std::string &use_address)
virtual void mark_failed()
Mark this component as failed.
This is a workaround until we can figure out a way to get the tflite-micro idf component code availab...
void dump_config() override
void set_phy_addr(uint8_t phy_addr)
emac_rmii_clock_mode_t clk_mode_
optional< ManualIP > manual_ip_
float get_setup_priority() const override
static void eth_event_handler(void *arg, esp_event_base_t event_base, int32_t event_id, void *event_data)
esp_eth_handle_t eth_handle_
std::string get_use_address() const
void IRAM_ATTR HOT delay(uint32_t ms)