Merge branch 'feature/ksz80xx_support_extension' into 'master'

esp_eth: rework KSZ80xx implementation and add more KSZ80xx PHYs

Closes IDFGH-6203 and IDF-3522

See merge request espressif/esp-idf!16024

components/esp_eth/include/esp_eth_phy.h

@@ -294,22 +294,6 @@ esp_eth_phy_t *esp_eth_phy_new_rtl8201(const eth_phy_config_t *config);
 */
 esp_eth_phy_t *esp_eth_phy_new_lan87xx(const eth_phy_config_t *config);
 
-/**
-* @brief Create a PHY instance of LAN8720
-*
-* @note For ESP-IDF backwards compatibility reasons. In all other cases, use esp_eth_phy_new_lan87xx instead.
-*
-* @param[in] config: configuration of PHY
-*
-* @return
-*      - instance: create PHY instance successfully
-*      - NULL: create PHY instance failed because some error occurred
-*/
-static inline esp_eth_phy_t *esp_eth_phy_new_lan8720(const eth_phy_config_t *config)
-{
-    return esp_eth_phy_new_lan87xx(config);
-}
-
 /**
 * @brief Create a PHY instance of DP83848
 *
@@ -322,29 +306,13 @@ static inline esp_eth_phy_t *esp_eth_phy_new_lan8720(const eth_phy_config_t *con
 esp_eth_phy_t *esp_eth_phy_new_dp83848(const eth_phy_config_t *config);
 
 /**
-* @brief Create a PHY instance of KSZ8041
-*
-* @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_ksz8041(const eth_phy_config_t *config);
-
-/**
-* @brief Create a PHY instance of KSZ8081
+* @brief Create a PHY instance of KSZ80xx
 *
-* @param[in] config: configuration of PHY
+* The phy model from the KSZ80xx series is detected automatically. If the driver
+* is unable to detect a supported model, \c NULL is returned.
 *
-* @return
-*      - instance: create PHY instance successfully
-*      - NULL: create PHY instance failed because some error occurred
-*/
-esp_eth_phy_t *esp_eth_phy_new_ksz8081(const eth_phy_config_t *config);
-
-/**
-* @brief Create a PHY instance of KSZ8091
+* Currently, the following models are supported:
+* KSZ8001, KSZ8021, KSZ8031, KSZ8041, KSZ8051, KSZ8061, KSZ8081, KSZ8091
 *
 * @param[in] config: configuration of PHY
 *
@@ -352,10 +320,7 @@ esp_eth_phy_t *esp_eth_phy_new_ksz8081(const eth_phy_config_t *config);
 *      - instance: create PHY instance successfully
 *      - NULL: create PHY instance failed because some error occurred
 */
-static inline esp_eth_phy_t *esp_eth_phy_new_ksz8091(const eth_phy_config_t *config)
-{
-    return esp_eth_phy_new_ksz8081(config);
-}
+esp_eth_phy_t *esp_eth_phy_new_ksz80xx(const eth_phy_config_t *config);
 
 #if CONFIG_ETH_SPI_ETHERNET_DM9051
 /**

components/esp_eth/src/esp_eth_phy_ksz80xx.c

@@ -16,86 +16,23 @@
 #include "esp_rom_gpio.h"
 #include "esp_rom_sys.h"
 
-static const char *TAG = "ksz80xx";
-
-#define KSZ8041_MODEL_ID (0x11)
-#define KSZ8081_MODEL_ID (0x16)
-#define KSZ8091_MODEL_ID KSZ8081_MODEL_ID
-
-/***************Vendor Specific Register***************/
-/**
- * @brief PC2R(PHY Control 2 Register) for KSZ8041
- *
- */
-typedef union {
-    struct {
-        uint32_t dis_data_scr: 1;    /* Disable Scrambler */
-        uint32_t en_sqe_test : 1;    /* Enable SQE Test */
-        uint32_t op_mode : 3;        /* Operation Mode */
-        uint32_t phy_iso : 1;        /* PHY Isolate */
-        uint32_t en_flow_ctrl : 1;   /* Enable Flow Control */
-        uint32_t auto_nego_comp : 1; /* Auto Negotiation Complete */
-        uint32_t en_jabber : 1;      /* Enable Jabber Counter */
-        uint32_t irq_level : 1;      /* Interrupt Pin Active Level */
-        uint32_t power_saving : 1;   /* Enable Powering Saving */
-        uint32_t force_link : 1;     /* Force Link Pass */
-        uint32_t energy_det : 1;     /* Presence of Signal on RX+/- Wire Pair */
-        uint32_t pair_swap_dis : 1;  /* Disable Auto MDI/MDI-X */
-        uint32_t mdix_select : 1;    /* MDI/MDI-X Select */
-        uint32_t hp_mdix : 1;        /* HP Auto MDI/MDI-X Mode */
-    };
-    uint32_t val;
-} ksz8041_pc2r_reg_t;
-#define KSZ8041_PC2R_REG_ADDR (0x1F)
+#define KSZ80XX_PHY_ID_MSB (0x22)
+#define KSZ80XX_PHY_ID_LSB (0x05)
 
-/**
- * @brief PC1R(PHY Control 1 Register) for KSZ8081
- *
- */
-typedef union {
-    struct {
-        uint32_t op_mode : 3;         /* Operation Mode Indication */
-        uint32_t phy_iso : 1;         /* PHY in Isolate Mode */
-        uint32_t energy_det: 1;       /* Signal presence on RX pair */
-        uint32_t mdix_state : 1;      /* MDI/MDI-X state */
-        uint32_t reserved_6 : 1;      /* Reserved */
-        uint32_t polarity_status : 1; /* Polarity status */
-        uint32_t link_status : 1;     /* Link status */
-        uint32_t en_flow_ctrl : 1;    /* Flow control */
-        uint32_t reserved_15_10 : 6;  /* Reserved */
-    };
-    uint32_t val;
-} ksz8081_pc1r_reg_t;
-#define KSZ8081_PC1R_REG_ADDR (0x1E)
+#define KSZ80XX_PC1R_REG_ADDR (0x1E)
+#define KSZ80XX_PC2R_REG_ADDR (0x1F)
 
-/**
- * @brief PC2R(PHY Control 2 Register)
- *
- */
-typedef union {
-    struct {
-        uint32_t dis_data_scr: 1;       /* Disable Scrambler */
-        uint32_t enable_sqe_test : 1;   /* Enable SQE test. MLX/MNX/RNB only. */
-        uint32_t rem_loopb : 1;         /* Enable remote loopback */
-        uint32_t dis_trx : 1;           /* Disable Transmitter */
-        uint32_t led_mode : 2;          /* LED mode link-activity / link */
-        uint32_t reserved_6 : 1;
-        uint32_t rmii_ref_sel : 1;      /* RMII Reference Clock Select */
-        uint32_t en_jabber : 1;         /* Enable Jabber Counter */
-        uint32_t irq_level : 1;         /* Interrupt Pin Active Level */
-        uint32_t power_saving : 1;      /* Enable Powering Saving */
-        uint32_t force_link : 1;        /* Force Link Pass */
-        uint32_t reserved_12 : 1;
-        uint32_t pair_swap_dis : 1;     /* Disable Auto MDI/MDI-X */
-        uint32_t mdix_select : 1;       /* MDI/MDI-X Select */
-        uint32_t hp_mdix : 1;           /* HP Auto MDI/MDI-X Mode */
-    };
-    uint32_t val;
-} ksz8081_pc2r_reg_t;
-#define KSZ8081_PC2R_REG_ADDR (0x1F)
-
-
-typedef struct {
+typedef enum
+{
+    KSZ80XX_MODEL_NUMBER_11 = 0x11,     // KSZ8041
+    KSZ80XX_MODEL_NUMBER_15 = 0x15,     // KSZ8021/31
+    KSZ80XX_MODEL_NUMBER_16 = 0x16,     // KSZ8051/81/91
+    KSZ80XX_MODEL_NUMBER_17 = 0x17,     // KSZ8061
+    KSZ80XX_MODEL_NUMBER_21 = 0x21,     // KSZ8001
+} ksz80xx_model_number_t;
+
+typedef struct
+{
     esp_eth_phy_t parent;
     esp_eth_mediator_t *eth;
     int addr;
@@ -103,10 +40,31 @@ typedef struct {
     uint32_t autonego_timeout_ms;
     eth_link_t link_status;
     int reset_gpio_num;
-    int vendor_model;
+    uint8_t model_number;
+    uint32_t op_mode_reg;
+    uint32_t op_mode_offset;
 } phy_ksz80xx_t;
 
-static esp_err_t ksz80xx_update_link_duplex_speed(phy_ksz80xx_t *ksz80xx)
+static const uint8_t supported_model_numbers[] =
+{
+    KSZ80XX_MODEL_NUMBER_11,
+    KSZ80XX_MODEL_NUMBER_15,
+    KSZ80XX_MODEL_NUMBER_16,
+    KSZ80XX_MODEL_NUMBER_17,
+    KSZ80XX_MODEL_NUMBER_21,
+};
+
+static const char *model_names[] = {
+    "41",           // models with model number 0x11
+    "21/31",        // models with model number 0x15
+    "51/81/91",     // models with model number 0x16
+    "61",           // models with model number 0x17
+    "01",           // models with model number 0x21
+};
+
+static const char *TAG = "ksz80xx";
+
+static esp_err_t ksz80xx_update_link_duplex_speed(phy_ksz80xx_t * ksz80xx)
 {
     esp_err_t ret = ESP_OK;
     esp_eth_mediator_t *eth = ksz80xx->eth;
@@ -122,16 +80,9 @@ static esp_err_t ksz80xx_update_link_duplex_speed(phy_ksz80xx_t *ksz80xx)
     if (ksz80xx->link_status != link) {
         /* when link up, read negotiation result */
         if (link == ETH_LINK_UP) {
-            int op_mode = 0;
-            if (ksz80xx->vendor_model == KSZ8041_MODEL_ID) {
-                ksz8041_pc2r_reg_t pc2r;
-                ESP_GOTO_ON_ERROR(eth->phy_reg_read(eth, ksz80xx->addr, KSZ8041_PC2R_REG_ADDR, &(pc2r.val)), err, TAG, "read PC2R failed");
-                op_mode = pc2r.op_mode;
-            } else if (ksz80xx->vendor_model == KSZ8081_MODEL_ID) {
-                ksz8081_pc1r_reg_t pc1r;
-                ESP_GOTO_ON_ERROR(eth->phy_reg_read(eth, ksz80xx->addr, KSZ8081_PC1R_REG_ADDR, &(pc1r.val)), err, TAG, "read PC1R failed");
-                op_mode = pc1r.op_mode;
-            }
+            uint32_t reg_value = 0;
+            ESP_GOTO_ON_ERROR(eth->phy_reg_read(eth, ksz80xx->addr, ksz80xx->op_mode_reg, &reg_value), err, TAG, "read %#04x failed", ksz80xx->op_mode_reg);
+            uint8_t op_mode = (reg_value >> ksz80xx->op_mode_offset) & 0x07;
             switch (op_mode) {
             case 1: //10Base-T half-duplex
                 speed = ETH_SPEED_10M;
@@ -441,6 +392,29 @@ err:
     return ret;
 }
 
+static bool ksz80xx_init_model(phy_ksz80xx_t *ksz80xx)
+{
+    // set variables for op_mode access
+    switch (ksz80xx->model_number) {
+    case KSZ80XX_MODEL_NUMBER_21:   // models KSZ8001
+    case KSZ80XX_MODEL_NUMBER_11:   // models KSZ8041
+        ksz80xx->op_mode_reg = KSZ80XX_PC2R_REG_ADDR;
+        ksz80xx->op_mode_offset = 2; // bits 4:2
+        break;
+
+    case KSZ80XX_MODEL_NUMBER_15:   // models KSZ8021/31
+    case KSZ80XX_MODEL_NUMBER_16:   // models KSZ8051/81/91
+    case KSZ80XX_MODEL_NUMBER_17:   // models KSZ8061
+        ksz80xx->op_mode_reg = KSZ80XX_PC1R_REG_ADDR;
+        ksz80xx->op_mode_offset = 0; // bits 2:0
+        break;
+
+    default:
+        return false;
+    }
+    return true;
+}
+
 static esp_err_t ksz80xx_init(esp_eth_phy_t *phy)
 {
     esp_err_t ret = ESP_OK;
@@ -455,7 +429,17 @@ static esp_err_t ksz80xx_init(esp_eth_phy_t *phy)
     phyidr2_reg_t id2;
     ESP_GOTO_ON_ERROR(eth->phy_reg_read(eth, ksz80xx->addr, ETH_PHY_IDR1_REG_ADDR, &(id1.val)), err, TAG, "read ID1 failed");
     ESP_GOTO_ON_ERROR(eth->phy_reg_read(eth, ksz80xx->addr, ETH_PHY_IDR2_REG_ADDR, &(id2.val)), err, TAG, "read ID2 failed");
-    ESP_GOTO_ON_FALSE(id1.oui_msb == 0x22 && id2.oui_lsb == 0x5 && id2.vendor_model == ksz80xx->vendor_model, ESP_FAIL, err, TAG, "wrong chip ID");
+    ESP_GOTO_ON_FALSE(id1.oui_msb == KSZ80XX_PHY_ID_MSB && id2.oui_lsb == KSZ80XX_PHY_ID_LSB, ESP_FAIL, err, TAG, "wrong chip ID");
+    const char* supported_model_name = NULL;
+    ksz80xx->model_number = id2.vendor_model;
+    for (size_t i = 0; i < sizeof(supported_model_numbers); i++) {
+        if (ksz80xx->model_number == supported_model_numbers[i]) {
+            supported_model_name = model_names[i];
+            break;
+        }
+    }
+    ESP_GOTO_ON_FALSE(supported_model_name != NULL && ksz80xx_init_model(ksz80xx), ESP_FAIL, err, TAG, "unsupported model number: %#04x", ksz80xx->model_number);
+    ESP_LOGI(TAG, "auto detected phy KSZ80%s", supported_model_name);
     return ESP_OK;
 err:
     return ret;
@@ -471,66 +455,33 @@ err:
     return ret;
 }
 
-esp_eth_phy_t *esp_eth_phy_new_ksz8041(const eth_phy_config_t *config)
+esp_eth_phy_t *esp_eth_phy_new_ksz80xx(const eth_phy_config_t *config)
 {
     esp_eth_phy_t *ret = NULL;
     ESP_GOTO_ON_FALSE(config, NULL, err, TAG, "can't set phy config to null");
-    phy_ksz80xx_t *ksz8041 = calloc(1, sizeof(phy_ksz80xx_t));
-    ESP_GOTO_ON_FALSE(ksz8041, NULL, err, TAG, "calloc ksz8041 failed");
-    ksz8041->vendor_model = KSZ8041_MODEL_ID;
-    ksz8041->addr = config->phy_addr;
-    ksz8041->reset_gpio_num = config->reset_gpio_num;
-    ksz8041->reset_timeout_ms = config->reset_timeout_ms;
-    ksz8041->link_status = ETH_LINK_DOWN;
-    ksz8041->autonego_timeout_ms = config->autonego_timeout_ms;
-    ksz8041->parent.reset = ksz80xx_reset;
-    ksz8041->parent.reset_hw = ksz80xx_reset_hw;
-    ksz8041->parent.init = ksz80xx_init;
-    ksz8041->parent.deinit = ksz80xx_deinit;
-    ksz8041->parent.set_mediator = ksz80xx_set_mediator;
-    ksz8041->parent.autonego_ctrl = ksz80xx_autonego_ctrl;
-    ksz8041->parent.get_link = ksz80xx_get_link;
-    ksz8041->parent.pwrctl = ksz80xx_pwrctl;
-    ksz8041->parent.get_addr = ksz80xx_get_addr;
-    ksz8041->parent.set_addr = ksz80xx_set_addr;
-    ksz8041->parent.advertise_pause_ability = ksz80xx_advertise_pause_ability;
-    ksz8041->parent.loopback = ksz80xx_loopback;
-    ksz8041->parent.set_speed = ksz80xx_set_speed;
-    ksz8041->parent.set_duplex = ksz80xx_set_duplex;
-    ksz8041->parent.del = ksz80xx_del;
-    return &(ksz8041->parent);
-err:
-    return ret;
-}
-
-esp_eth_phy_t *esp_eth_phy_new_ksz8081(const eth_phy_config_t *config)
-{
-    esp_eth_phy_t *ret = NULL;
-    ESP_GOTO_ON_FALSE(config, NULL, err, TAG, "can't set phy config to null");
-    phy_ksz80xx_t *ksz8081 = calloc(1, sizeof(phy_ksz80xx_t));
-    ESP_GOTO_ON_FALSE(ksz8081, NULL, err, TAG, "calloc ksz8081 failed");
-    ksz8081->vendor_model = KSZ8081_MODEL_ID;
-    ksz8081->addr = config->phy_addr;
-    ksz8081->reset_gpio_num = config->reset_gpio_num;
-    ksz8081->reset_timeout_ms = config->reset_timeout_ms;
-    ksz8081->link_status = ETH_LINK_DOWN;
-    ksz8081->autonego_timeout_ms = config->autonego_timeout_ms;
-    ksz8081->parent.reset = ksz80xx_reset;
-    ksz8081->parent.reset_hw = ksz80xx_reset_hw;
-    ksz8081->parent.init = ksz80xx_init;
-    ksz8081->parent.deinit = ksz80xx_deinit;
-    ksz8081->parent.set_mediator = ksz80xx_set_mediator;
-    ksz8081->parent.autonego_ctrl = ksz80xx_autonego_ctrl;
-    ksz8081->parent.get_link = ksz80xx_get_link;
-    ksz8081->parent.pwrctl = ksz80xx_pwrctl;
-    ksz8081->parent.get_addr = ksz80xx_get_addr;
-    ksz8081->parent.set_addr = ksz80xx_set_addr;
-    ksz8081->parent.advertise_pause_ability = ksz80xx_advertise_pause_ability;
-    ksz8081->parent.loopback = ksz80xx_loopback;
-    ksz8081->parent.set_speed = ksz80xx_set_speed;
-    ksz8081->parent.set_duplex = ksz80xx_set_duplex;
-    ksz8081->parent.del = ksz80xx_del;
-    return &(ksz8081->parent);
+    phy_ksz80xx_t *ksz80xx = calloc(1, sizeof(phy_ksz80xx_t));
+    ESP_GOTO_ON_FALSE(ksz80xx, NULL, err, TAG, "calloc ksz80xx failed");
+    ksz80xx->addr = config->phy_addr;
+    ksz80xx->reset_gpio_num = config->reset_gpio_num;
+    ksz80xx->reset_timeout_ms = config->reset_timeout_ms;
+    ksz80xx->link_status = ETH_LINK_DOWN;
+    ksz80xx->autonego_timeout_ms = config->autonego_timeout_ms;
+    ksz80xx->parent.reset = ksz80xx_reset;
+    ksz80xx->parent.reset_hw = ksz80xx_reset_hw;
+    ksz80xx->parent.init = ksz80xx_init;
+    ksz80xx->parent.deinit = ksz80xx_deinit;
+    ksz80xx->parent.set_mediator = ksz80xx_set_mediator;
+    ksz80xx->parent.autonego_ctrl = ksz80xx_autonego_ctrl;
+    ksz80xx->parent.get_link = ksz80xx_get_link;
+    ksz80xx->parent.pwrctl = ksz80xx_pwrctl;
+    ksz80xx->parent.get_addr = ksz80xx_get_addr;
+    ksz80xx->parent.set_addr = ksz80xx_set_addr;
+    ksz80xx->parent.advertise_pause_ability = ksz80xx_advertise_pause_ability;
+    ksz80xx->parent.loopback = ksz80xx_loopback;
+    ksz80xx->parent.set_speed = ksz80xx_set_speed;
+    ksz80xx->parent.set_duplex = ksz80xx_set_duplex;
+    ksz80xx->parent.del = ksz80xx_del;
+    return &(ksz80xx->parent);
 err:
     return ret;
 }

components/esp_eth/test_apps/main/Kconfig.projbuild

@@ -8,7 +8,7 @@ menu "esp_eth TEST_APPS Configuration"
 
         config TARGET_ETH_PHY_DEVICE_IP101
             bool "IP101"
-        config TARGET_ETH_PHY_DEVICE_LAN8720
+        config TARGET_ETH_PHY_DEVICE_LAN87XX
             bool "LAN8720"
     endchoice
 endmenu

components/esp_eth/test_apps/main/esp_eth_test.c

@@ -53,8 +53,8 @@ TEST_CASE("start_and_stop", "[esp_eth]")
     eth_phy_config_t phy_config = ETH_PHY_DEFAULT_CONFIG(); // apply default PHY configuration
 #if defined(CONFIG_TARGET_ETH_PHY_DEVICE_IP101)
     esp_eth_phy_t *phy = esp_eth_phy_new_ip101(&phy_config); // create PHY instance
-#elif defined(CONFIG_TARGET_ETH_PHY_DEVICE_LAN8720)
-    esp_eth_phy_t *phy = esp_eth_phy_new_lan8720(&phy_config);
+#elif defined(CONFIG_TARGET_ETH_PHY_DEVICE_LAN87XX)
+    esp_eth_phy_t *phy = esp_eth_phy_new_lan87xx(&phy_config);
 #endif
     TEST_ASSERT_NOT_NULL(phy);
     esp_eth_config_t config = ETH_DEFAULT_CONFIG(mac, phy); // apply default driver configuration
@@ -104,8 +104,8 @@ TEST_CASE("get_set_mac", "[esp_eth]")
     eth_phy_config_t phy_config = ETH_PHY_DEFAULT_CONFIG(); // apply default PHY configuration
 #if defined(CONFIG_TARGET_ETH_PHY_DEVICE_IP101)
     esp_eth_phy_t *phy = esp_eth_phy_new_ip101(&phy_config); // create PHY instance
-#elif defined(CONFIG_TARGET_ETH_PHY_DEVICE_LAN8720)
-    esp_eth_phy_t *phy = esp_eth_phy_new_lan8720(&phy_config);
+#elif defined(CONFIG_TARGET_ETH_PHY_DEVICE_LAN87XX)
+    esp_eth_phy_t *phy = esp_eth_phy_new_lan87xx(&phy_config);
 #endif
     TEST_ASSERT_NOT_NULL(phy);
     esp_eth_config_t config = ETH_DEFAULT_CONFIG(mac, phy); // apply default driver configuration
@@ -157,8 +157,8 @@ TEST_CASE("ethernet_broadcast_transmit", "[esp_eth]")
     eth_phy_config_t phy_config = ETH_PHY_DEFAULT_CONFIG(); // apply default PHY configuration
 #if defined(CONFIG_TARGET_ETH_PHY_DEVICE_IP101)
     esp_eth_phy_t *phy = esp_eth_phy_new_ip101(&phy_config); // create PHY instance
-#elif defined(CONFIG_TARGET_ETH_PHY_DEVICE_LAN8720)
-    esp_eth_phy_t *phy = esp_eth_phy_new_lan8720(&phy_config);
+#elif defined(CONFIG_TARGET_ETH_PHY_DEVICE_LAN87XX)
+    esp_eth_phy_t *phy = esp_eth_phy_new_lan87xx(&phy_config);
 #endif
     TEST_ASSERT_NOT_NULL(phy);
     esp_eth_config_t config = ETH_DEFAULT_CONFIG(mac, phy); // apply default driver configuration
@@ -227,8 +227,8 @@ TEST_CASE("recv_pkt", "[esp_eth]")
     eth_phy_config_t phy_config = ETH_PHY_DEFAULT_CONFIG(); // apply default PHY configuration
 #if defined(CONFIG_TARGET_ETH_PHY_DEVICE_IP101)
     esp_eth_phy_t *phy = esp_eth_phy_new_ip101(&phy_config); // create PHY instance
-#elif defined(CONFIG_TARGET_ETH_PHY_DEVICE_LAN8720)
-    esp_eth_phy_t *phy = esp_eth_phy_new_lan8720(&phy_config);
+#elif defined(CONFIG_TARGET_ETH_PHY_DEVICE_LAN87XX)
+    esp_eth_phy_t *phy = esp_eth_phy_new_lan87xx(&phy_config);
 #endif
     TEST_ASSERT_NOT_NULL(phy);
     esp_eth_config_t config = ETH_DEFAULT_CONFIG(mac, phy); // apply default driver configuration

components/esp_eth/test_apps/sdkconfig.ci.lan8720

@@ -4,6 +4,6 @@ CONFIG_UNITY_ENABLE_IDF_TEST_RUNNER=y
 CONFIG_ETH_USE_ESP32_EMAC=y
 CONFIG_ESP_TASK_WDT=n
 
-CONFIG_TARGET_ETH_PHY_DEVICE_LAN8720=y
+CONFIG_TARGET_ETH_PHY_DEVICE_LAN87XX=y
 CONFIG_ETH_RMII_CLK_OUTPUT=y
 CONFIG_ETH_RMII_CLK_OUT_GPIO=17

docs/en/migration-guides/ethernet.rst

@@ -31,3 +31,13 @@ Usage example to get Ethernet configuration:
 
     eth_duplex_t duplex_mode;
     esp_eth_ioctl(eth_handle, ETH_CMD_G_DUPLEX_MODE, &duplex_mode);
+
+
+KSZ8041/81 and LAN8720 Driver Update
+------------------------------------
+KSZ8041/81 and LAN8720 Drivers were updated to support more devices (generations) from associated product family. The drivers are able to recognize particular chip number and its potential support by the driver.
+
+As a result, the specific "chip number" functions calls were replaced by generic ones as follows:
+
+* :cpp:func:`esp_eth_phy_new_ksz8041` and :cpp:func:`esp_eth_phy_new_ksz8081` were removed, use :cpp:func:`esp_eth_phy_new_ksz80xx` instead
+* :cpp:func:`esp_eth_phy_new_lan8720` was removed, use :cpp:func:`esp_eth_phy_new_lan87xx` instead

examples/common_components/protocol_examples_common/Kconfig.projbuild

@@ -191,6 +191,15 @@ menu "Example Connection Configuration"
                     help
                         DP83848 is a single port 10/100Mb/s Ethernet Physical Layer Transceiver.
                         Goto http://www.ti.com/product/DP83848J for more information about it.
+
+                config EXAMPLE_ETH_PHY_KSZ80XX
+                    bool "KSZ80xx"
+                    help
+                        With the KSZ80xx series, Microchip offers single-chip 10BASE-T/100BASE-TX
+                        Ethernet Physical Layer Tranceivers (PHY).
+                        The following chips are supported: KSZ8001, KSZ8021, KSZ8031, KSZ8041,
+                            KSZ8051, KSZ8061, KSZ8081, KSZ8091
+                        Goto https://www.microchip.com for more information about them.
             endchoice
 
             config EXAMPLE_ETH_MDC_GPIO

examples/common_components/protocol_examples_common/connect.c

@@ -390,6 +390,8 @@ static esp_netif_t *eth_start(void)
     s_phy = esp_eth_phy_new_lan87xx(&phy_config);
 #elif CONFIG_EXAMPLE_ETH_PHY_DP83848
     s_phy = esp_eth_phy_new_dp83848(&phy_config);
+#elif CONFIG_EXAMPLE_ETH_PHY_KSZ80XX
+    s_phy = esp_eth_phy_new_ksz80xx(&phy_config);
 #endif
 #elif CONFIG_EXAMPLE_USE_SPI_ETHERNET
     gpio_install_isr_service(0);

examples/ethernet/basic/main/Kconfig.projbuild

@@ -56,17 +56,14 @@ menu "Example Configuration"
                     DP83848 is a single port 10/100Mb/s Ethernet Physical Layer Transceiver.
                     Goto http://www.ti.com/product/DP83848J for more information about it.
 
-            config EXAMPLE_ETH_PHY_KSZ8041
-                bool "KSZ8041"
+            config EXAMPLE_ETH_PHY_KSZ80XX
+                bool "KSZ80xx"
                 help
-                    The KSZ8041 is a single supply 10Base-T/100Base-TX Physical Layer Transceiver.
-                    Goto https://www.microchip.com/wwwproducts/en/KSZ8041 for more information about it.
-
-            config EXAMPLE_ETH_PHY_KSZ8081
-                bool "KSZ8081"
-                help
-                    The KSZ8081 is a single supply 10Base-T/100Base-TX Physical Layer Transceiver.
-                    Goto https://www.microchip.com/wwwproducts/en/KSZ8081 for more information about it.
+                    With the KSZ80xx series, Microchip offers single-chip 10BASE-T/100BASE-TX
+                    Ethernet Physical Layer Tranceivers (PHY).
+                    The following chips are supported: KSZ8001, KSZ8021, KSZ8031, KSZ8041,
+                        KSZ8051, KSZ8061, KSZ8081, KSZ8091
+                    Goto https://www.microchip.com for more information about them.
         endchoice # EXAMPLE_ETH_PHY_MODEL
 
         config EXAMPLE_ETH_MDC_GPIO

examples/ethernet/basic/main/ethernet_example_main.c

@@ -112,10 +112,8 @@ void app_main(void)
     esp_eth_phy_t *phy = esp_eth_phy_new_lan87xx(&phy_config);
 #elif CONFIG_EXAMPLE_ETH_PHY_DP83848
     esp_eth_phy_t *phy = esp_eth_phy_new_dp83848(&phy_config);
-#elif CONFIG_EXAMPLE_ETH_PHY_KSZ8041
-    esp_eth_phy_t *phy = esp_eth_phy_new_ksz8041(&phy_config);
-#elif CONFIG_EXAMPLE_ETH_PHY_KSZ8081
-    esp_eth_phy_t *phy = esp_eth_phy_new_ksz8081(&phy_config);
+#elif CONFIG_EXAMPLE_ETH_PHY_KSZ80XX
+    esp_eth_phy_t *phy = esp_eth_phy_new_ksz80xx(&phy_config);
 #endif
     esp_eth_config_t config = ETH_DEFAULT_CONFIG(mac, phy);
     esp_eth_handle_t eth_handle = NULL;

examples/ethernet/eth2ap/main/Kconfig.projbuild

@@ -91,17 +91,14 @@ menu "Example Configuration"
                     DP83848 is a single port 10/100Mb/s Ethernet Physical Layer Transceiver.
                     Goto http://www.ti.com/product/DP83848J for more information about it.
 
-            config EXAMPLE_ETH_PHY_KSZ8041
-                bool "KSZ8041"
+            config EXAMPLE_ETH_PHY_KSZ80XX
+                bool "KSZ80xx"
                 help
-                    The KSZ8041 is a single supply 10Base-T/100Base-TX Physical Layer Transceiver.
-                    Goto https://www.microchip.com/wwwproducts/en/KSZ8041 for more information about it.
-
-            config EXAMPLE_ETH_PHY_KSZ8081
-                bool "KSZ8081"
-                help
-                    The KSZ8081 is a single supply 10Base-T/100Base-TX Physical Layer Transceiver.
-                    Goto https://www.microchip.com/wwwproducts/en/KSZ8081 for more information about it.
+                    With the KSZ80xx series, Microchip offers single-chip 10BASE-T/100BASE-TX
+                    Ethernet Physical Layer Tranceivers (PHY).
+                    The following chips are supported: KSZ8001, KSZ8021, KSZ8031, KSZ8041,
+                        KSZ8051, KSZ8061, KSZ8081, KSZ8091
+                    Goto https://www.microchip.com for more information about them.
         endchoice # EXAMPLE_ETH_PHY_MODEL
 
         config EXAMPLE_ETH_MDC_GPIO

examples/ethernet/eth2ap/main/ethernet_example_main.c

@@ -169,10 +169,8 @@ static void initialize_ethernet(void)
     esp_eth_phy_t *phy = esp_eth_phy_new_lan87xx(&phy_config);
 #elif CONFIG_EXAMPLE_ETH_PHY_DP83848
     esp_eth_phy_t *phy = esp_eth_phy_new_dp83848(&phy_config);
-#elif CONFIG_EXAMPLE_ETH_PHY_KSZ8041
-    esp_eth_phy_t *phy = esp_eth_phy_new_ksz8041(&phy_config);
-#elif CONFIG_EXAMPLE_ETH_PHY_KSZ8081
-    esp_eth_phy_t *phy = esp_eth_phy_new_ksz8081(&phy_config);
+#elif CONFIG_EXAMPLE_ETH_PHY_KSZ80XX
+    esp_eth_phy_t *phy = esp_eth_phy_new_ksz80xx(&phy_config);
 #endif
 #elif CONFIG_ETH_USE_SPI_ETHERNET
     gpio_install_isr_service(0);

examples/ethernet/iperf/main/Kconfig.projbuild

@@ -107,17 +107,14 @@ menu "Example Configuration"
                     DP83848 is a single port 10/100Mb/s Ethernet Physical Layer Transceiver.
                     Goto http://www.ti.com/product/DP83848J for more information about it.
 
-            config EXAMPLE_ETH_PHY_KSZ8041
-                bool "KSZ8041"
+            config EXAMPLE_ETH_PHY_KSZ80XX
+                bool "KSZ80xx"
                 help
-                    The KSZ8041 is a single supply 10Base-T/100Base-TX Physical Layer Transceiver.
-                    Goto https://www.microchip.com/wwwproducts/en/KSZ8041 for more information about it.
-
-            config EXAMPLE_ETH_PHY_KSZ8081
-                bool "KSZ8081"
-                help
-                    The KSZ8081 is a single supply 10Base-T/100Base-TX Physical Layer Transceiver.
-                    Goto https://www.microchip.com/wwwproducts/en/KSZ8081 for more information about it.
+                    With the KSZ80xx series, Microchip offers single-chip 10BASE-T/100BASE-TX
+                    Ethernet Physical Layer Tranceivers (PHY).
+                    The following chips are supported: KSZ8001, KSZ8021, KSZ8031, KSZ8041,
+                        KSZ8051, KSZ8061, KSZ8081, KSZ8091
+                    Goto https://www.microchip.com for more information about them.
         endchoice # EXAMPLE_ETH_PHY_MODEL
 
         config EXAMPLE_ETH_MDC_GPIO

examples/ethernet/iperf/main/cmd_ethernet.c

@@ -219,10 +219,8 @@ void register_ethernet(void)
     esp_eth_phy_t *phy = esp_eth_phy_new_lan87xx(&phy_config);
 #elif CONFIG_EXAMPLE_ETH_PHY_DP83848
     esp_eth_phy_t *phy = esp_eth_phy_new_dp83848(&phy_config);
-#elif CONFIG_EXAMPLE_ETH_PHY_KSZ8041
-    esp_eth_phy_t *phy = esp_eth_phy_new_ksz8041(&phy_config);
-#elif CONFIG_EXAMPLE_ETH_PHY_KSZ8081
-    esp_eth_phy_t *phy = esp_eth_phy_new_ksz8081(&phy_config);
+#elif CONFIG_EXAMPLE_ETH_PHY_KSZ80XX
+    esp_eth_phy_t *phy = esp_eth_phy_new_ksz80xx(&phy_config);
 #endif
 #elif CONFIG_ETH_USE_SPI_ETHERNET
     gpio_install_isr_service(0);

examples/network/simple_sniffer/main/Kconfig.projbuild

@@ -180,17 +180,14 @@ menu "Example Configuration"
                     DP83848 is a single port 10/100Mb/s Ethernet Physical Layer Transceiver.
                     Goto http://www.ti.com/product/DP83848J for more information about it.
 
-            config SNIFFER_ETH_PHY_KSZ8041
-                bool "KSZ8041"
+            config SNIFFER_ETH_PHY_KSZ80XX
+                bool "KSZ80xx"
                 help
-                    The KSZ8041 is a single supply 10Base-T/100Base-TX Physical Layer Transceiver.
-                    Goto https://www.microchip.com/wwwproducts/en/KSZ8041 for more information about it.
-
-            config SNIFFER_ETH_PHY_KSZ8081
-                bool "KSZ8081"
-                help
-                    The KSZ8081 is a single supply 10Base-T/100Base-TX Physical Layer Transceiver.
-                    Goto https://www.microchip.com/wwwproducts/en/KSZ8081 for more information about it.
+                    With the KSZ80xx series, Microchip offers single-chip 10BASE-T/100BASE-TX
+                    Ethernet Physical Layer Tranceivers (PHY).
+                    The following chips are supported: KSZ8001, KSZ8021, KSZ8031, KSZ8041,
+                        KSZ8051, KSZ8061, KSZ8081, KSZ8091
+                    Goto https://www.microchip.com for more information about them.
         endchoice # SNIFFER_ETH_PHY_MODEL
 
         config SNIFFER_ETH_MDC_GPIO

examples/network/simple_sniffer/main/simple_sniffer_example_main.c

@@ -146,10 +146,8 @@ static void initialize_eth(void)
     esp_eth_phy_t *phy = esp_eth_phy_new_lan87xx(&phy_config);
 #elif CONFIG_SNIFFER_ETH_PHY_DP83848
     esp_eth_phy_t *phy = esp_eth_phy_new_dp83848(&phy_config);
-#elif CONFIG_SNIFFER_ETH_PHY_KSZ8041
-    esp_eth_phy_t *phy = esp_eth_phy_new_ksz8041(&phy_config);
-#elif CONFIG_SNIFFER_ETH_PHY_KSZ8081
-    esp_eth_phy_t *phy = esp_eth_phy_new_ksz8081(&phy_config);
+#elif CONFIG_SNIFFER_ETH_PHY_KSZ80XX
+    esp_eth_phy_t *phy = esp_eth_phy_new_ksz80xx(&phy_config);
 #endif
 #elif CONFIG_ETH_USE_SPI_ETHERNET
     gpio_install_isr_service(0);