Merge branch 'feat/remove_eth_drivers' into 'master'

Feat/remove eth drivers

Closes IDF-13553 and IDF-5865

See merge request espressif/esp-idf!42021

Author: kostaond

components/esp_eth/CMakeLists.txt

@@ -30,32 +30,12 @@ if(CONFIG_ETH_ENABLED)
         list(APPEND srcs "src/mac/esp_eth_mac_esp.c"
                          "src/mac/esp_eth_mac_esp_dma.c"
                          "src/mac/esp_eth_mac_esp_gpio.c"
-                         "src/phy/esp_eth_phy_generic.c"
-                         "src/phy/esp_eth_phy_dp83848.c"
-                         "src/phy/esp_eth_phy_ip101.c"
-                         "src/phy/esp_eth_phy_ksz80xx.c"
-                         "src/phy/esp_eth_phy_lan87xx.c"
-                         "src/phy/esp_eth_phy_rtl8201.c")
-    endif()
-
-    if(CONFIG_ETH_SPI_ETHERNET_DM9051)
-        list(APPEND srcs "src/spi/dm9051/esp_eth_mac_dm9051.c"
-                         "src/spi/dm9051/esp_eth_phy_dm9051.c")
-    endif()
-
-    if(CONFIG_ETH_SPI_ETHERNET_W5500)
-        list(APPEND srcs "src/spi/w5500/esp_eth_mac_w5500.c"
-                         "src/spi/w5500/esp_eth_phy_w5500.c")
-    endif()
-
-    if(CONFIG_ETH_SPI_ETHERNET_KSZ8851SNL)
-        list(APPEND srcs "src/spi/ksz8851snl/esp_eth_mac_ksz8851snl.c"
-                         "src/spi/ksz8851snl/esp_eth_phy_ksz8851snl.c")
+                         "src/phy/esp_eth_phy_generic.c")
     endif()
 
     if(CONFIG_ETH_USE_OPENETH)
         list(APPEND srcs "src/openeth/esp_eth_mac_openeth.c"
-                         "src/phy/esp_eth_phy_dp83848.c")
+                         "src/phy/esp_eth_phy_generic.c")
     endif()
 endif()
 

components/esp_eth/Kconfig

@@ -57,38 +57,13 @@ menu "Ethernet"
                 If disabled, all functions are placed into FLASH.
 
     endif # ETH_USE_ESP32_EMAC
-
     menuconfig ETH_USE_SPI_ETHERNET
         bool "Support SPI to Ethernet Module"
         default y
         select ETH_ENABLED
         help
-            ESP-IDF can also support some SPI-Ethernet modules.
-
-    if ETH_USE_SPI_ETHERNET
-        config ETH_SPI_ETHERNET_DM9051
-            bool "Use DM9051"
-            help
-                DM9051 is a fast Ethernet controller with an SPI interface.
-                It's also integrated with a 10/100M PHY and MAC.
-                Select this to enable DM9051 driver.
-
-        config ETH_SPI_ETHERNET_W5500
-            bool "Use W5500 (MAC RAW)"
-            help
-                W5500 is a HW TCP/IP embedded Ethernet controller.
-                TCP/IP stack, 10/100 Ethernet MAC and PHY are embedded in a single chip.
-                However the driver in ESP-IDF only enables the RAW MAC mode,
-                making it compatible with the software TCP/IP stack.
-                Say yes to enable W5500 driver.
-
-        config ETH_SPI_ETHERNET_KSZ8851SNL
-            bool "Use KSZ8851SNL"
-            help
-                The KSZ8851SNL is a single-chip Fast Ethernet controller consisting of
-                a 10/100 physical layer transceiver (PHY), a MAC, and a Serial Peripheral Interface (SPI).
-                Select this to enable KSZ8851SNL driver.
-    endif # ETH_USE_SPI_ETHERNET
+            ESP-IDF can also support SPI-Ethernet. Actual chip drivers are available as components in
+            Component Registry.
 
     menuconfig ETH_USE_OPENETH
         bool "Support OpenCores Ethernet MAC (for use with QEMU)"

components/esp_eth/include/esp_eth_mac_spi.h

@@ -1,5 +1,5 @@
 /*
- * SPDX-FileCopyrightText: 2019-2024 Espressif Systems (Shanghai) CO LTD
+ * SPDX-FileCopyrightText: 2019-2025 Espressif Systems (Shanghai) CO LTD
  *
  * SPDX-License-Identifier: Apache-2.0
  */
@@ -9,15 +9,14 @@
 #include "soc/soc_caps.h"
 #include "esp_eth_com.h"
 #include "esp_eth_mac.h"
-#include "sdkconfig.h"
 #include "driver/spi_master.h"
+#include "sdkconfig.h"
 
 #ifdef __cplusplus
 extern "C" {
 #endif
 
 #if CONFIG_ETH_USE_SPI_ETHERNET
-
 /**
  * @brief Custom SPI Driver Configuration.
  * This structure declares configuration and callback functions to access Ethernet SPI module via
@@ -112,125 +111,8 @@ typedef struct
         .read = NULL,    \
         .write = NULL    \
     }
-#endif // CONFIG_ETH_USE_SPI_ETHERNET
-
-#if CONFIG_ETH_SPI_ETHERNET_DM9051
-/**
- * @brief DM9051 specific configuration
- *
- */
-typedef struct {
-    int int_gpio_num;                                   /*!< Interrupt GPIO number, set -1 to not use interrupt and to poll rx status periodically */
-    uint32_t poll_period_ms;                            /*!< Period in ms to poll rx status when interrupt mode is not used */
-    spi_host_device_t spi_host_id;                      /*!< SPI peripheral (this field is invalid when custom SPI driver is defined) */
-    spi_device_interface_config_t *spi_devcfg;          /*!< SPI device configuration (this field is invalid when custom SPI driver is defined) */
-    eth_spi_custom_driver_config_t custom_spi_driver;   /*!< Custom SPI driver definitions */
-} eth_dm9051_config_t;
-
-/**
- * @brief Default DM9051 specific configuration
- *
- */
-#define ETH_DM9051_DEFAULT_CONFIG(spi_host, spi_devcfg_p) \
-    {                                           \
-        .int_gpio_num = 4,                      \
-        .poll_period_ms = 0,                    \
-        .spi_host_id = spi_host,                \
-        .spi_devcfg = spi_devcfg_p,             \
-        .custom_spi_driver = ETH_DEFAULT_SPI,   \
-    }
-
-/**
-* @brief Create DM9051 Ethernet MAC instance
-*
-* @param dm9051_config: DM9051 specific configuration
-* @param mac_config: Ethernet MAC configuration
-*
-* @return
-*      - instance: create MAC instance successfully
-*      - NULL: create MAC instance failed because some error occurred
-*/
-esp_eth_mac_t *esp_eth_mac_new_dm9051(const eth_dm9051_config_t *dm9051_config, const eth_mac_config_t *mac_config);
-#endif // CONFIG_ETH_SPI_ETHERNET_DM9051
-
-#if CONFIG_ETH_SPI_ETHERNET_W5500
-/**
- * @brief W5500 specific configuration
- *
- */
-typedef struct {
-    int int_gpio_num;                                   /*!< Interrupt GPIO number, set -1 to not use interrupt and to poll rx status periodically */
-    uint32_t poll_period_ms;                            /*!< Period in ms to poll rx status when interrupt mode is not used */
-    spi_host_device_t spi_host_id;                      /*!< SPI peripheral (this field is invalid when custom SPI driver is defined)*/
-    spi_device_interface_config_t *spi_devcfg;          /*!< SPI device configuration (this field is invalid when custom SPI driver is defined)*/
-    eth_spi_custom_driver_config_t custom_spi_driver;   /*!< Custom SPI driver definitions */
-} eth_w5500_config_t;
-
-/**
- * @brief Default W5500 specific configuration
- *
- */
-#define ETH_W5500_DEFAULT_CONFIG(spi_host, spi_devcfg_p) \
-    {                                           \
-        .int_gpio_num = 4,                      \
-        .poll_period_ms = 0,                    \
-        .spi_host_id = spi_host,                \
-        .spi_devcfg = spi_devcfg_p,             \
-        .custom_spi_driver = ETH_DEFAULT_SPI,   \
-    }
-
-/**
-* @brief Create W5500 Ethernet MAC instance
-*
-* @param w5500_config: W5500 specific configuration
-* @param mac_config: Ethernet MAC configuration
-*
-* @return
-*      - instance: create MAC instance successfully
-*      - NULL: create MAC instance failed because some error occurred
-*/
-esp_eth_mac_t *esp_eth_mac_new_w5500(const eth_w5500_config_t *w5500_config, const eth_mac_config_t *mac_config);
-#endif // CONFIG_ETH_SPI_ETHERNET_W5500
-
-#if CONFIG_ETH_SPI_ETHERNET_KSZ8851SNL
-/**
- * @brief KSZ8851SNL specific configuration
- *
- */
-typedef struct {
-    int int_gpio_num;                                   /*!< Interrupt GPIO number, set -1 to not use interrupt and to poll rx status periodically */
-    uint32_t poll_period_ms;                            /*!< Period in ms to poll rx status when interrupt mode is not used */
-    spi_host_device_t spi_host_id;                      /*!< SPI peripheral (this field is invalid when custom SPI driver is defined) */
-    spi_device_interface_config_t *spi_devcfg;          /*!< SPI device configuration (this field is invalid when custom SPI driver is defined) */
-    eth_spi_custom_driver_config_t custom_spi_driver;   /*!< Custom SPI driver definitions */
-} eth_ksz8851snl_config_t;
-
-/**
- * @brief Default KSZ8851SNL specific configuration
- *
- */
-#define ETH_KSZ8851SNL_DEFAULT_CONFIG(spi_host, spi_devcfg_p) \
-    {                                               \
-        .int_gpio_num = 4,                          \
-        .poll_period_ms = 0,                        \
-        .spi_host_id = spi_host,                    \
-        .spi_devcfg = spi_devcfg_p,                 \
-        .custom_spi_driver = ETH_DEFAULT_SPI,       \
-    }
-
-/**
-* @brief Create KSZ8851SNL Ethernet MAC instance
-*
-* @param ksz8851snl_config: KSZ8851SNL specific configuration
-* @param mac_config: Ethernet MAC configuration
-*
-* @return
-*      - instance: create MAC instance successfully
-*      - NULL: create MAC instance failed because some error occurred
-*/
-esp_eth_mac_t *esp_eth_mac_new_ksz8851snl(const eth_ksz8851snl_config_t *ksz8851snl_config, const eth_mac_config_t *mac_config);
-#endif // CONFIG_ETH_SPI_ETHERNET_KSZ8851
 
+#endif // CONFIG_ETH_USE_SPI_ETHERNET
 #ifdef __cplusplus
 }
 #endif

components/esp_eth/include/esp_eth_phy.h

@@ -1,5 +1,5 @@
 /*
- * SPDX-FileCopyrightText: 2019-2024 Espressif Systems (Shanghai) CO LTD
+ * SPDX-FileCopyrightText: 2019-2025 Espressif Systems (Shanghai) CO LTD
  *
  * SPDX-License-Identifier: Apache-2.0
  */
@@ -299,7 +299,7 @@ typedef struct {
 /**
 * @brief Create a PHY instance of generic chip which conforms with IEEE 802.3
 *
-* @note Default reset timing configuration is set conservatively( @c DEFAULT_PHY_RESET_ASSERTION_TIME_US ).
+* @note Default reset timing configuration is set conservatively(see internals of the function).
 *       If you need faster response and your chip supports it, configure it via @c config parameter.
 *
 * @warning While basic functionality should always work, some specific features might be limited,
@@ -313,105 +313,6 @@ typedef struct {
  */
 esp_eth_phy_t *esp_eth_phy_new_generic(const eth_phy_config_t *config);
 
-/**
-* @brief Create a PHY instance of IP101
-*
-* @param[in] config: configuration of PHY
-*
-* @return
-*      - instance: create PHY instance successfully
-*      - NULL: create PHY instance failed because some error occurred
-*/
-esp_eth_phy_t *esp_eth_phy_new_ip101(const eth_phy_config_t *config);
-
-/**
-* @brief Create a PHY instance of RTL8201
-*
-* @param[in] config: configuration of PHY
-*
-* @return
-*      - instance: create PHY instance successfully
-*      - NULL: create PHY instance failed because some error occurred
-*/
-esp_eth_phy_t *esp_eth_phy_new_rtl8201(const eth_phy_config_t *config);
-
-/**
-* @brief Create a PHY instance of LAN87xx
-*
-* @param[in] config: configuration of PHY
-*
-* @return
-*      - instance: create PHY instance successfully
-*      - NULL: create PHY instance failed because some error occurred
-*/
-esp_eth_phy_t *esp_eth_phy_new_lan87xx(const eth_phy_config_t *config);
-
-/**
-* @brief Create a PHY instance of DP83848
-*
-* @param[in] config: configuration of PHY
-*
-* @return
-*      - instance: create PHY instance successfully
-*      - NULL: create PHY instance failed because some error occurred
-*/
-esp_eth_phy_t *esp_eth_phy_new_dp83848(const eth_phy_config_t *config);
-
-/**
-* @brief Create a PHY instance of KSZ80xx
-*
-* The phy model from the KSZ80xx series is detected automatically. If the driver
-* is unable to detect a supported model, \c NULL is returned.
-*
-* Currently, the following models are supported:
-* KSZ8001, KSZ8021, KSZ8031, KSZ8041, KSZ8051, KSZ8061, KSZ8081, KSZ8091
-*
-* @param[in] config: configuration of PHY
-*
-* @return
-*      - instance: create PHY instance successfully
-*      - NULL: create PHY instance failed because some error occurred
-*/
-esp_eth_phy_t *esp_eth_phy_new_ksz80xx(const eth_phy_config_t *config);
-
-#if CONFIG_ETH_SPI_ETHERNET_DM9051
-/**
-* @brief Create a PHY instance of DM9051
-*
-* @param[in] config: configuration of PHY
-*
-* @return
-*      - instance: create PHY instance successfully
-*      - NULL: create PHY instance failed because some error occurred
-*/
-esp_eth_phy_t *esp_eth_phy_new_dm9051(const eth_phy_config_t *config);
-#endif
-
-#if CONFIG_ETH_SPI_ETHERNET_W5500
-/**
-* @brief Create a PHY instance of W5500
-*
-* @param[in] config: configuration of PHY
-*
-* @return
-*      - instance: create PHY instance successfully
-*      - NULL: create PHY instance failed because some error occurred
-*/
-esp_eth_phy_t *esp_eth_phy_new_w5500(const eth_phy_config_t *config);
-#endif
-
-#if CONFIG_ETH_SPI_ETHERNET_KSZ8851SNL
-/**
-* @brief Create a PHY instance of KSZ8851SNL
-*
-* @param[in] config: configuration of PHY
-*
-* @return
-*      - instance: create PHY instance successfully
-*      - NULL: create PHY instance failed because some error occurred
-*/
-esp_eth_phy_t *esp_eth_phy_new_ksz8851snl(const eth_phy_config_t *config);
-#endif
 #ifdef __cplusplus
 }
 #endif