From 872ada14e2a3e11d6cd459946ef893cd295db637 Mon Sep 17 00:00:00 2001 From: Ondrej Kosta Date: Mon, 30 Jan 2023 09:29:58 +0100 Subject: [PATCH] esp_eth: improved L2 test stability and removed duplicate test cases --- .../esp_eth/test_apps/main/esp_eth_test.c | 521 +++++++++--------- .../esp_eth/test_apps/pytest_esp_eth.py | 174 +++--- 2 files changed, 341 insertions(+), 354 deletions(-) diff --git a/components/esp_eth/test_apps/main/esp_eth_test.c b/components/esp_eth/test_apps/main/esp_eth_test.c index d8b5b097a5..cf8ac4c5cd 100644 --- a/components/esp_eth/test_apps/main/esp_eth_test.c +++ b/components/esp_eth/test_apps/main/esp_eth_test.c @@ -9,6 +9,12 @@ #include "sdkconfig.h" #include "lwip/sockets.h" +#define TEST_ETH_TYPE 0x2222 +#define TEST_CTRL_ETH_TYPE (TEST_ETH_TYPE + 1) + +#define WAIT_AFTER_CONN_MS 2500 +#define WAIT_AFTER_CONN_TMO_MS 20000 + #define ETH_START_BIT BIT(0) #define ETH_STOP_BIT BIT(1) #define ETH_CONNECT_BIT BIT(2) @@ -16,6 +22,7 @@ #define ETH_BROADCAST_RECV_BIT BIT(0) #define ETH_MULTICAST_RECV_BIT BIT(1) #define ETH_UNICAST_RECV_BIT BIT(2) +#define ETH_POKE_RESP_RECV_BIT BIT(3) #define POKE_REQ 0xFA #define POKE_RESP 0xFB @@ -28,6 +35,16 @@ typedef struct { uint8_t data[]; } __attribute__((__packed__)) emac_frame_t; +typedef struct +{ + EventGroupHandle_t eth_event_group; + int unicast_rx_cnt; + int multicast_rx_cnt; + int brdcast_rx_cnt; + + bool check_rx_data; +} recv_info_t; + static void eth_event_handler(void *arg, esp_event_base_t event_base, int32_t event_id, void *event_data){ EventGroupHandle_t eth_event_group = (EventGroupHandle_t)arg; @@ -48,250 +65,84 @@ static void eth_event_handler(void *arg, esp_event_base_t event_base, } } -TEST_CASE("start_and_stop", "[esp_eth]") -{ - EventGroupHandle_t eth_event_group = xEventGroupCreate(); - TEST_ASSERT(eth_event_group != NULL); - - eth_mac_config_t mac_config = ETH_MAC_DEFAULT_CONFIG(); // apply default MAC configuration - eth_esp32_emac_config_t esp32_emac_config = ETH_ESP32_EMAC_DEFAULT_CONFIG(); - esp_eth_mac_t *mac = esp_eth_mac_new_esp32(&esp32_emac_config, &mac_config); // create MAC instance - TEST_ASSERT_NOT_NULL(mac); - 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_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 - esp_eth_handle_t eth_handle = NULL; // after driver installed, we will get the handle of the driver - TEST_ASSERT_EQUAL(ESP_OK, esp_eth_driver_install(&config, ð_handle)); // install driver - TEST_ASSERT_NOT_NULL(eth_handle); - TEST_ASSERT_EQUAL(ESP_OK, esp_event_loop_create_default()); - TEST_ESP_OK(esp_event_handler_register(ETH_EVENT, ESP_EVENT_ANY_ID, ð_event_handler, eth_event_group)); - TEST_ASSERT_EQUAL(ESP_OK, esp_eth_start(eth_handle)); // start Ethernet driver state machine - - EventBits_t bits = 0; - bits = xEventGroupWaitBits(eth_event_group, ETH_START_BIT, true, true, pdMS_TO_TICKS(3000)); - TEST_ASSERT((bits & ETH_START_BIT) == ETH_START_BIT); - - TEST_ASSERT_EQUAL(ESP_OK, esp_eth_stop(eth_handle)); - - bits = xEventGroupWaitBits(eth_event_group, ETH_STOP_BIT, true, true, pdMS_TO_TICKS(3000)); - TEST_ASSERT((bits & ETH_STOP_BIT) == ETH_STOP_BIT); - - TEST_ASSERT_EQUAL(ESP_OK, esp_event_loop_delete_default()); - TEST_ASSERT_EQUAL(ESP_OK, esp_eth_driver_uninstall(eth_handle)); - phy->del(phy); - mac->del(mac); - vEventGroupDelete(eth_event_group); -} - -TEST_CASE("get_set_mac", "[esp_eth]") -{ - EventGroupHandle_t eth_event_group = xEventGroupCreate(); - TEST_ASSERT(eth_event_group != NULL); - - eth_mac_config_t mac_config = ETH_MAC_DEFAULT_CONFIG(); // apply default MAC configuration - eth_esp32_emac_config_t esp32_emac_config = ETH_ESP32_EMAC_DEFAULT_CONFIG(); - esp_eth_mac_t *mac = esp_eth_mac_new_esp32(&esp32_emac_config, &mac_config); // create MAC instance - TEST_ASSERT_NOT_NULL(mac); - 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_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 - esp_eth_handle_t eth_handle = NULL; // after driver installed, we will get the handle of the driver - TEST_ASSERT_EQUAL(ESP_OK, esp_eth_driver_install(&config, ð_handle)); // install driver - TEST_ASSERT_NOT_NULL(eth_handle); - TEST_ASSERT_EQUAL(ESP_OK, esp_event_loop_create_default()); - TEST_ESP_OK(esp_event_handler_register(ETH_EVENT, ESP_EVENT_ANY_ID, ð_event_handler, eth_event_group)); - TEST_ASSERT_EQUAL(ESP_OK, esp_eth_start(eth_handle)); // start Ethernet driver state machine - - EventBits_t bits = 0; - bits = xEventGroupWaitBits(eth_event_group, ETH_CONNECT_BIT, true, true, pdMS_TO_TICKS(3000)); - TEST_ASSERT((bits & ETH_CONNECT_BIT) == ETH_CONNECT_BIT); - - uint8_t mac_addr[6] = {}; - TEST_ASSERT_EQUAL(ESP_OK, mac->get_addr(mac, mac_addr)); - TEST_ASSERT_BITS(0b00000011, 0b00, mac_addr[0]); // Check UL&IG, should be UI - mac_addr[5] ^= mac_addr[4]; - TEST_ASSERT_EQUAL(ESP_OK, mac->set_addr(mac, mac_addr)); - uint8_t new_mac_addr[6] = {}; - TEST_ASSERT_EQUAL(ESP_OK, mac->get_addr(mac, new_mac_addr)); - TEST_ASSERT_EQUAL(0, memcmp(mac_addr, new_mac_addr, 6)); - - TEST_ASSERT_EQUAL(ESP_OK, esp_eth_stop(eth_handle)); - TEST_ASSERT_EQUAL(ESP_OK, esp_event_loop_delete_default()); - TEST_ASSERT_EQUAL(ESP_OK, esp_eth_driver_uninstall(eth_handle)); - phy->del(phy); - mac->del(mac); - vEventGroupDelete(eth_event_group); -} - -TEST_CASE("ethernet_broadcast_transmit", "[esp_eth]") -{ - EventGroupHandle_t eth_event_group = xEventGroupCreate(); - TEST_ASSERT(eth_event_group != NULL); - - eth_mac_config_t mac_config = ETH_MAC_DEFAULT_CONFIG(); // apply default MAC configuration - eth_esp32_emac_config_t esp32_emac_config = ETH_ESP32_EMAC_DEFAULT_CONFIG(); - esp_eth_mac_t *mac = esp_eth_mac_new_esp32(&esp32_emac_config, &mac_config); // create MAC instance - TEST_ASSERT_NOT_NULL(mac); - 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_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 - esp_eth_handle_t eth_handle = NULL; // after driver installed, we will get the handle of the driver - TEST_ASSERT_EQUAL(ESP_OK, esp_eth_driver_install(&config, ð_handle)); // install driver - TEST_ASSERT_NOT_NULL(eth_handle); - TEST_ASSERT_EQUAL(ESP_OK, esp_event_loop_create_default()); - TEST_ESP_OK(esp_event_handler_register(ETH_EVENT, ESP_EVENT_ANY_ID, ð_event_handler, eth_event_group)); - TEST_ASSERT_EQUAL(ESP_OK, esp_eth_start(eth_handle)); // start Ethernet driver state machine - - EventBits_t bits = 0; - bits = xEventGroupWaitBits(eth_event_group, ETH_CONNECT_BIT, true, true, pdMS_TO_TICKS(3000)); - TEST_ASSERT((bits & ETH_CONNECT_BIT) == ETH_CONNECT_BIT); - // even if PHY (IP101) indicates autonegotiation done and link up, it sometimes may miss few packets after atonego reset, hence wait a bit - vTaskDelay(pdMS_TO_TICKS(100)); - - emac_frame_t *pkt = malloc(1024); - pkt->proto = 0x2222; - memset(pkt->dest, 0xff, 6); // broadcast addr - for (int i = 0; i < (1024 - ETH_HEADER_LEN); ++i){ - pkt->data[i] = i & 0xff; - } - - TEST_ASSERT_EQUAL(ESP_OK, esp_eth_transmit(eth_handle, pkt, 1024)); - vTaskDelay(pdMS_TO_TICKS(100)); - free(pkt); - - TEST_ASSERT_EQUAL(ESP_OK, esp_eth_stop(eth_handle)); - TEST_ASSERT_EQUAL(ESP_OK, esp_event_loop_delete_default()); - TEST_ASSERT_EQUAL(ESP_OK, esp_eth_driver_uninstall(eth_handle)); - phy->del(phy); - mac->del(mac); - vEventGroupDelete(eth_event_group); -} - -static uint8_t local_mac_addr[6] = {}; - esp_err_t l2_packet_txrx_test_cb(esp_eth_handle_t hdl, uint8_t *buffer, uint32_t length, void *priv) { - EventGroupHandle_t eth_event_group = (EventGroupHandle_t)priv; - emac_frame_t *pkt = (emac_frame_t *) buffer; + recv_info_t *recv_info = (recv_info_t*)priv; + EventGroupHandle_t eth_event_group = recv_info->eth_event_group; + emac_frame_t *pkt = (emac_frame_t *)buffer; // check header - if (pkt->proto == 0x2222 && length == 1024) { - // check content - for (int i = 0; i < (length - ETH_HEADER_LEN); ++i) { - if (pkt->data[i] != (i & 0xff)) { - printf("payload mismatch\n"); - return ESP_OK; + if (pkt->proto == TEST_ETH_TYPE) { // data packet + uint8_t local_mac_addr[ETH_ADDR_LEN]; + esp_eth_ioctl(hdl, ETH_CMD_G_MAC_ADDR, local_mac_addr); + // check data content + if (recv_info->check_rx_data) { + if (length == 1024) { + for (int i = 0; i < (length - ETH_HEADER_LEN); ++i) { + if (pkt->data[i] != (i & 0xff)) { + printf("payload mismatch\n"); + free(buffer); + return ESP_OK; + } + } } } - if (memcmp(pkt->dest, "\xff\xff\xff\xff\xff\xff", 6) == 0) { - printf("broadcast received...\n"); + + if (memcmp(pkt->dest, "\xff\xff\xff\xff\xff\xff", ETH_ADDR_LEN) == 0) { + recv_info->brdcast_rx_cnt++; xEventGroupSetBits(eth_event_group, ETH_BROADCAST_RECV_BIT); } else if (pkt->dest[0] & 0x1) { - printf("multicast received...\n"); + recv_info->multicast_rx_cnt++; xEventGroupSetBits(eth_event_group, ETH_MULTICAST_RECV_BIT); - } else if (memcmp(pkt->dest, local_mac_addr, 6) == 0) { - printf("unicast received...\n"); + } else if (memcmp(pkt->dest, local_mac_addr, ETH_ADDR_LEN) == 0) { + recv_info->unicast_rx_cnt++; xEventGroupSetBits(eth_event_group, ETH_UNICAST_RECV_BIT); } - } else { - printf("unexpected frame (protocol: 0x%x, length: %u)\n", pkt->proto, length); - } - return ESP_OK; -}; - -TEST_CASE("recv_pkt", "[esp_eth]") -{ - EventGroupHandle_t eth_event_group = xEventGroupCreate(); - TEST_ASSERT(eth_event_group != NULL); - - eth_mac_config_t mac_config = ETH_MAC_DEFAULT_CONFIG(); // apply default MAC configuration - eth_esp32_emac_config_t esp32_emac_config = ETH_ESP32_EMAC_DEFAULT_CONFIG(); - esp_eth_mac_t *mac = esp_eth_mac_new_esp32(&esp32_emac_config, &mac_config); // create MAC instance - TEST_ASSERT_NOT_NULL(mac); - 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_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 - esp_eth_handle_t eth_handle = NULL; // after driver installed, we will get the handle of the driver - TEST_ASSERT_EQUAL(ESP_OK, esp_eth_driver_install(&config, ð_handle)); // install driver - TEST_ASSERT_NOT_NULL(eth_handle); - TEST_ASSERT_EQUAL(ESP_OK, esp_event_loop_create_default()); - TEST_ASSERT_EQUAL(ESP_OK, esp_eth_start(eth_handle)); // start Ethernet driver state machine - - TEST_ASSERT_EQUAL(ESP_OK, mac->get_addr(mac, local_mac_addr)); - // test app will parse the DUT MAC from this line of log output - printf("DUT MAC: %.2x:%.2x:%.2x:%.2x:%.2x:%.2x\n", local_mac_addr[0], local_mac_addr[1], local_mac_addr[2], - local_mac_addr[3], local_mac_addr[4], local_mac_addr[5]); - - TEST_ASSERT_EQUAL(ESP_OK, esp_eth_update_input_path(eth_handle, l2_packet_txrx_test_cb, eth_event_group)); - - EventBits_t bits = 0; - bits = xEventGroupWaitBits(eth_event_group, ETH_BROADCAST_RECV_BIT | ETH_MULTICAST_RECV_BIT | ETH_UNICAST_RECV_BIT, - true, true, pdMS_TO_TICKS(5000)); - TEST_ASSERT((bits & (ETH_BROADCAST_RECV_BIT | ETH_MULTICAST_RECV_BIT | ETH_UNICAST_RECV_BIT)) == - (ETH_BROADCAST_RECV_BIT | ETH_MULTICAST_RECV_BIT | ETH_UNICAST_RECV_BIT)); - - TEST_ASSERT_EQUAL(ESP_OK, esp_eth_stop(eth_handle)); - TEST_ASSERT_EQUAL(ESP_OK, esp_event_loop_delete_default()); - TEST_ASSERT_EQUAL(ESP_OK, esp_eth_driver_uninstall(eth_handle)); - phy->del(phy); - mac->del(mac); - vEventGroupDelete(eth_event_group); -} - -typedef struct -{ - SemaphoreHandle_t mutex; - int rx_pkt_cnt; -} recv_info_t; - -static esp_err_t eth_recv_cb(esp_eth_handle_t hdl, uint8_t *buffer, uint32_t length, void *priv) -{ - emac_frame_t *pkt = (emac_frame_t *)buffer; - recv_info_t *recv_info = (recv_info_t *)priv; - - if (pkt->proto == 0x2222) { - switch (pkt->data[0]) - { - case POKE_RESP: - xSemaphoreGive(recv_info->mutex); - break; - - case DUMMY_TRAFFIC: - (recv_info->rx_pkt_cnt)++; - break; - default: - break; + } else if (ntohs(pkt->proto) == TEST_CTRL_ETH_TYPE) { // control packet + if (pkt->data[0] == POKE_RESP) { + printf("Poke response received\n"); + xEventGroupSetBits(eth_event_group, ETH_POKE_RESP_RECV_BIT); } } free(buffer); return ESP_OK; } -TEST_CASE("start_stop_stress_test", "[esp_eth]") +/** + * @brief The function sends a "POKE" request message over the Ethernet and waits until the test script sends a reply. + * Multiple "POKE" attempts are issued when timeout for the reply expires. + * This function is used to drive the test flow and to ensure that data path between the test points + * has been established. I.e. if DUT is connected in network with a switch, even if link is indicated up, + * it may take some time the switch starts forwarding the associated port (e.g. it runs RSTP at first). + */ +void poke_and_wait(esp_eth_handle_t eth_handle, void *data, uint16_t size, EventGroupHandle_t eth_event_group) { - recv_info_t recv_info; - recv_info.mutex = xSemaphoreCreateBinary(); - TEST_ASSERT_NOT_NULL(recv_info.mutex); - recv_info.rx_pkt_cnt = 0; + // create a control frame to control test flow between the UT and the Python test script + emac_frame_t *ctrl_pkt = calloc(1, 60); + ctrl_pkt->proto = htons(TEST_CTRL_ETH_TYPE); + memset(ctrl_pkt->dest, 0xff, ETH_ADDR_LEN); // broadcast addr + esp_eth_ioctl(eth_handle, ETH_CMD_G_MAC_ADDR, ctrl_pkt->src); + ctrl_pkt->data[0] = POKE_REQ; + if (data != NULL && size > 0) { + memcpy(&ctrl_pkt->data[1], data, size); + } + + uint32_t tmo; + uint32_t i; + for(tmo = 0, i = 1; tmo < WAIT_AFTER_CONN_TMO_MS; tmo += WAIT_AFTER_CONN_MS, i++) { + printf("Poke attempt #%" PRIu32 "\n", i); + TEST_ESP_OK(esp_eth_transmit(eth_handle, ctrl_pkt, 60)); + EventBits_t bits = xEventGroupWaitBits(eth_event_group, ETH_POKE_RESP_RECV_BIT, + true, true, pdMS_TO_TICKS(WAIT_AFTER_CONN_MS)); + if ((bits & ETH_POKE_RESP_RECV_BIT) == ETH_POKE_RESP_RECV_BIT) { + break; + } + } + TEST_ASSERT(tmo < WAIT_AFTER_CONN_TMO_MS); + free(ctrl_pkt); +} + +TEST_CASE("ethernet_broadcast_transmit", "[esp_eth]") +{ eth_mac_config_t mac_config = ETH_MAC_DEFAULT_CONFIG(); // apply default MAC configuration eth_esp32_emac_config_t esp32_emac_config = ETH_ESP32_EMAC_DEFAULT_CONFIG(); esp_eth_mac_t *mac = esp_eth_mac_new_esp32(&esp32_emac_config, &mac_config); // create MAC instance @@ -308,98 +159,220 @@ TEST_CASE("start_stop_stress_test", "[esp_eth]") TEST_ASSERT_EQUAL(ESP_OK, esp_eth_driver_install(&config, ð_handle)); // install driver TEST_ASSERT_NOT_NULL(eth_handle); - TEST_ASSERT_EQUAL(ESP_OK, mac->get_addr(mac, local_mac_addr)); + TEST_ESP_OK(esp_event_loop_create_default()); + EventGroupHandle_t eth_event_state_group = xEventGroupCreate(); + TEST_ASSERT(eth_event_state_group != NULL); + TEST_ESP_OK(esp_event_handler_register(ETH_EVENT, ESP_EVENT_ANY_ID, ð_event_handler, eth_event_state_group)); + EventGroupHandle_t eth_event_rx_group = xEventGroupCreate(); + TEST_ASSERT(eth_event_rx_group != NULL); + recv_info_t recv_info = { + .eth_event_group = eth_event_rx_group, + .check_rx_data = false, + .unicast_rx_cnt = 0, + .multicast_rx_cnt = 0, + .brdcast_rx_cnt = 0 + }; + + TEST_ESP_OK(esp_eth_update_input_path(eth_handle, l2_packet_txrx_test_cb, &recv_info)); + TEST_ESP_OK(esp_eth_start(eth_handle)); // start Ethernet driver state machine + + EventBits_t bits = 0; + bits = xEventGroupWaitBits(eth_event_state_group, ETH_CONNECT_BIT, true, true, pdMS_TO_TICKS(3000)); + TEST_ASSERT((bits & ETH_CONNECT_BIT) == ETH_CONNECT_BIT); + // if DUT is connected in network with switch: even if link is indicated up, it may take some time the switch + // starts switching the associated port (e.g. it runs RSTP at first) + poke_and_wait(eth_handle, NULL, 0, eth_event_rx_group); + + emac_frame_t *pkt = malloc(1024); + pkt->proto = TEST_ETH_TYPE; + TEST_ESP_OK(esp_eth_ioctl(eth_handle, ETH_CMD_G_MAC_ADDR, pkt->src)); + memset(pkt->dest, 0xff, ETH_ADDR_LEN); // broadcast addr + for (int i = 0; i < (1024 - ETH_HEADER_LEN); ++i){ + pkt->data[i] = i & 0xff; + } + + TEST_ESP_OK(esp_eth_transmit(eth_handle, pkt, 1024)); + vTaskDelay(pdMS_TO_TICKS(100)); + free(pkt); + + TEST_ESP_OK(esp_eth_stop(eth_handle)); + TEST_ESP_OK(esp_event_loop_delete_default()); + TEST_ESP_OK(esp_eth_driver_uninstall(eth_handle)); + phy->del(phy); + mac->del(mac); + vEventGroupDelete(eth_event_rx_group); + vEventGroupDelete(eth_event_state_group); +} + +TEST_CASE("recv_pkt", "[esp_eth]") +{ + eth_mac_config_t mac_config = ETH_MAC_DEFAULT_CONFIG(); // apply default MAC configuration + eth_esp32_emac_config_t esp32_emac_config = ETH_ESP32_EMAC_DEFAULT_CONFIG(); + esp_eth_mac_t *mac = esp_eth_mac_new_esp32(&esp32_emac_config, &mac_config); // create MAC instance + TEST_ASSERT_NOT_NULL(mac); + 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_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 + esp_eth_handle_t eth_handle = NULL; // after driver installed, we will get the handle of the driver + TEST_ASSERT_EQUAL(ESP_OK, esp_eth_driver_install(&config, ð_handle)); // install driver + TEST_ASSERT_NOT_NULL(eth_handle); + + TEST_ESP_OK(esp_event_loop_create_default()); + EventGroupHandle_t eth_event_state_group = xEventGroupCreate(); + TEST_ASSERT(eth_event_state_group != NULL); + TEST_ESP_OK(esp_event_handler_register(ETH_EVENT, ESP_EVENT_ANY_ID, ð_event_handler, eth_event_state_group)); + EventGroupHandle_t eth_event_rx_group = xEventGroupCreate(); + TEST_ASSERT(eth_event_rx_group != NULL); + recv_info_t recv_info = { + .eth_event_group = eth_event_rx_group, + .check_rx_data = true, + .unicast_rx_cnt = 0, + .multicast_rx_cnt = 0, + .brdcast_rx_cnt = 0 + }; + + uint8_t local_mac_addr[ETH_ADDR_LEN] = {}; + TEST_ESP_OK(mac->get_addr(mac, local_mac_addr)); // test app will parse the DUT MAC from this line of log output printf("DUT MAC: %.2x:%.2x:%.2x:%.2x:%.2x:%.2x\n", local_mac_addr[0], local_mac_addr[1], local_mac_addr[2], local_mac_addr[3], local_mac_addr[4], local_mac_addr[5]); - TEST_ESP_OK(esp_eth_update_input_path(eth_handle, eth_recv_cb, &recv_info)); + TEST_ESP_OK(esp_eth_update_input_path(eth_handle, l2_packet_txrx_test_cb, &recv_info)); + TEST_ESP_OK(esp_eth_start(eth_handle)); // start Ethernet driver state machine EventBits_t bits = 0; - EventGroupHandle_t eth_event_group = xEventGroupCreate(); - TEST_ASSERT(eth_event_group != NULL); - TEST_ESP_OK(esp_event_loop_create_default()); - TEST_ESP_OK(esp_event_handler_register(ETH_EVENT, ESP_EVENT_ANY_ID, ð_event_handler, eth_event_group)); + bits = xEventGroupWaitBits(eth_event_state_group, ETH_CONNECT_BIT, true, true, pdMS_TO_TICKS(3000)); + TEST_ASSERT((bits & ETH_CONNECT_BIT) == ETH_CONNECT_BIT); + // if DUT is connected in network with switch: even if link is indicated up, it may take some time the switch + // starts switching the associated port (e.g. it runs RSTP at first) + poke_and_wait(eth_handle, NULL, 0, eth_event_rx_group); - // create a control frame to control test flow between the UT and the Python test script - emac_frame_t *ctrl_pkt = calloc(1, 60); - ctrl_pkt->proto = 0x2222; - memset(ctrl_pkt->dest, 0xff, 6); // broadcast addr - memcpy(ctrl_pkt->src, local_mac_addr, 6); + bits = 0; + bits = xEventGroupWaitBits(eth_event_rx_group, ETH_BROADCAST_RECV_BIT | ETH_MULTICAST_RECV_BIT | ETH_UNICAST_RECV_BIT, + true, true, pdMS_TO_TICKS(5000)); + printf("bits = 0x%" PRIu32 "\n", (uint32_t)bits & (ETH_BROADCAST_RECV_BIT | ETH_MULTICAST_RECV_BIT | ETH_UNICAST_RECV_BIT)); + TEST_ASSERT((bits & (ETH_BROADCAST_RECV_BIT | ETH_MULTICAST_RECV_BIT | ETH_UNICAST_RECV_BIT)) == + (ETH_BROADCAST_RECV_BIT | ETH_MULTICAST_RECV_BIT | ETH_UNICAST_RECV_BIT)); + + TEST_ESP_OK(esp_eth_stop(eth_handle)); + TEST_ESP_OK(esp_event_loop_delete_default()); + TEST_ESP_OK(esp_eth_driver_uninstall(eth_handle)); + phy->del(phy); + mac->del(mac); + vEventGroupDelete(eth_event_state_group); + vEventGroupDelete(eth_event_rx_group); +} + +TEST_CASE("start_stop_stress_test", "[esp_eth]") +{ + eth_mac_config_t mac_config = ETH_MAC_DEFAULT_CONFIG(); // apply default MAC configuration + eth_esp32_emac_config_t esp32_emac_config = ETH_ESP32_EMAC_DEFAULT_CONFIG(); + esp_eth_mac_t *mac = esp_eth_mac_new_esp32(&esp32_emac_config, &mac_config); // create MAC instance + TEST_ASSERT_NOT_NULL(mac); + 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_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 + esp_eth_handle_t eth_handle = NULL; // after driver installed, we will get the handle of the driver + TEST_ASSERT_EQUAL(ESP_OK, esp_eth_driver_install(&config, ð_handle)); // install driver + TEST_ASSERT_NOT_NULL(eth_handle); + + TEST_ESP_OK(esp_event_loop_create_default()); + EventBits_t bits = 0; + EventGroupHandle_t eth_event_state_group = xEventGroupCreate(); + TEST_ASSERT(eth_event_state_group != NULL); + TEST_ESP_OK(esp_event_handler_register(ETH_EVENT, ESP_EVENT_ANY_ID, ð_event_handler, eth_event_state_group)); + EventGroupHandle_t eth_event_rx_group = xEventGroupCreate(); + TEST_ASSERT(eth_event_rx_group != NULL); + recv_info_t recv_info = { + .eth_event_group = eth_event_rx_group, + .check_rx_data = false, + .unicast_rx_cnt = 0, + .multicast_rx_cnt = 0, + .brdcast_rx_cnt = 0 + }; + + uint8_t local_mac_addr[ETH_ADDR_LEN] = {}; + TEST_ESP_OK(mac->get_addr(mac, local_mac_addr)); + // test app will parse the DUT MAC from this line of log output + printf("DUT MAC: %.2x:%.2x:%.2x:%.2x:%.2x:%.2x\n", local_mac_addr[0], local_mac_addr[1], local_mac_addr[2], + local_mac_addr[3], local_mac_addr[4], local_mac_addr[5]); + + TEST_ESP_OK(esp_eth_update_input_path(eth_handle, l2_packet_txrx_test_cb, &recv_info)); // create dummy data packet used for traffic generation emac_frame_t *pkt = calloc(1, 1500); - pkt->proto = 0x2222; + pkt->proto = TEST_ETH_TYPE; // we don't care about dest MAC address much, however it is better to not be broadcast or multifcast to not flood // other network nodes - memset(pkt->dest, 0xBA, 6); - memcpy(pkt->src, local_mac_addr, 6); + memset(pkt->dest, 0xBA, ETH_ADDR_LEN); + memcpy(pkt->src, local_mac_addr, ETH_ADDR_LEN); printf("EMAC start/stop stress test under heavy Tx traffic\n"); for (int tx_i = 0; tx_i < 10; tx_i++) { - TEST_ASSERT_EQUAL(ESP_OK, esp_eth_start(eth_handle)); // start Ethernet driver state machine - bits = xEventGroupWaitBits(eth_event_group, ETH_CONNECT_BIT, true, true, pdMS_TO_TICKS(3000)); + printf("Tx Test iteration %d\n", tx_i); + TEST_ESP_OK(esp_eth_start(eth_handle)); // start Ethernet driver state machine + bits = xEventGroupWaitBits(eth_event_state_group, ETH_CONNECT_BIT, true, true, pdMS_TO_TICKS(3000)); TEST_ASSERT((bits & ETH_CONNECT_BIT) == ETH_CONNECT_BIT); - // even if PHY (IP101) indicates autonegotiation done and link up, it sometimes may miss few packets after atonego reset, hence wait a bit - vTaskDelay(pdMS_TO_TICKS(100)); - // at first, check that Tx/Rx path works as expected by poking the test script // this also serves as main PASS/FAIL criteria - ctrl_pkt->data[0] = POKE_REQ; - ctrl_pkt->data[1] = tx_i; - TEST_ASSERT_EQUAL(ESP_OK, esp_eth_transmit(eth_handle, ctrl_pkt, 60)); - TEST_ASSERT(xSemaphoreTake(recv_info.mutex, pdMS_TO_TICKS(3000))); - printf("Tx Test iteration %d\n", tx_i); + poke_and_wait(eth_handle, &tx_i, sizeof(tx_i), eth_event_rx_group); // generate heavy Tx traffic printf("Note: transmit errors are expected...\n"); for (int j = 0; j < 150; j++) { // return value is not checked on purpose since it is expected that it may fail time to time because // we may try to queue more packets than hardware is able to handle - pkt->data[0] = j & 0xFF; + pkt->data[2] = j & 0xFF; // sequence number esp_eth_transmit(eth_handle, pkt, 1500); } - TEST_ASSERT_EQUAL(ESP_OK, esp_eth_stop(eth_handle)); - bits = xEventGroupWaitBits(eth_event_group, ETH_STOP_BIT, true, true, pdMS_TO_TICKS(3000)); + TEST_ESP_OK(esp_eth_stop(eth_handle)); + bits = xEventGroupWaitBits(eth_event_state_group, ETH_STOP_BIT, true, true, pdMS_TO_TICKS(3000)); TEST_ASSERT((bits & ETH_STOP_BIT) == ETH_STOP_BIT); printf("Ethernet stopped\n"); } printf("EMAC start/stop stress test under heavy Rx traffic\n"); for (int rx_i = 0; rx_i < 10; rx_i++) { - recv_info.rx_pkt_cnt = 0; - TEST_ASSERT_EQUAL(ESP_OK, esp_eth_start(eth_handle)); // start Ethernet driver state machine - bits = xEventGroupWaitBits(eth_event_group, ETH_CONNECT_BIT, true, true, pdMS_TO_TICKS(3000)); - TEST_ASSERT((bits & ETH_CONNECT_BIT) == ETH_CONNECT_BIT); - // even if PHY (IP101) indicates autonegotiation done and link up, it sometimes may miss few packets after atonego reset, hence wait a bit - vTaskDelay(pdMS_TO_TICKS(100)); - - ctrl_pkt->data[0] = POKE_REQ; - ctrl_pkt->data[1] = rx_i; - TEST_ASSERT_EQUAL(ESP_OK, esp_eth_transmit(eth_handle, ctrl_pkt, 60)); - TEST_ASSERT(xSemaphoreTake(recv_info.mutex, pdMS_TO_TICKS(3000))); printf("Rx Test iteration %d\n", rx_i); + TEST_ESP_OK(esp_eth_start(eth_handle)); // start Ethernet driver state machine + bits = xEventGroupWaitBits(eth_event_state_group, ETH_CONNECT_BIT, true, true, pdMS_TO_TICKS(3000)); + TEST_ASSERT((bits & ETH_CONNECT_BIT) == ETH_CONNECT_BIT); + poke_and_wait(eth_handle, &rx_i, sizeof(rx_i), eth_event_rx_group); + + // wait for dummy traffic + recv_info.unicast_rx_cnt = 0; + bits = xEventGroupWaitBits(eth_event_rx_group, ETH_UNICAST_RECV_BIT, true, true, pdMS_TO_TICKS(3000)); + TEST_ASSERT((bits & ETH_UNICAST_RECV_BIT) == ETH_UNICAST_RECV_BIT); vTaskDelay(pdMS_TO_TICKS(500)); - TEST_ASSERT_EQUAL(ESP_OK, esp_eth_stop(eth_handle)); - bits = xEventGroupWaitBits(eth_event_group, ETH_STOP_BIT, true, true, pdMS_TO_TICKS(3000)); + TEST_ESP_OK(esp_eth_stop(eth_handle)); + bits = xEventGroupWaitBits(eth_event_state_group, ETH_STOP_BIT, true, true, pdMS_TO_TICKS(3000)); TEST_ASSERT((bits & ETH_STOP_BIT) == ETH_STOP_BIT); - printf("Recv packets: %d\n", recv_info.rx_pkt_cnt); - TEST_ASSERT_GREATER_THAN_INT32(0, recv_info.rx_pkt_cnt); + printf("Recv packets: %d\n", recv_info.unicast_rx_cnt); + TEST_ASSERT_GREATER_THAN_INT32(0, recv_info.unicast_rx_cnt); printf("Ethernet stopped\n"); } - free(ctrl_pkt); free(pkt); TEST_ESP_OK(esp_event_handler_unregister(ETH_EVENT, ESP_EVENT_ANY_ID, eth_event_handler)); - TEST_ASSERT_EQUAL(ESP_OK, esp_event_loop_delete_default()); - TEST_ASSERT_EQUAL(ESP_OK, esp_eth_driver_uninstall(eth_handle)); + TEST_ESP_OK(esp_event_loop_delete_default()); + TEST_ESP_OK(esp_eth_driver_uninstall(eth_handle)); phy->del(phy); mac->del(mac); - vEventGroupDelete(eth_event_group); - vSemaphoreDelete(recv_info.mutex); + vEventGroupDelete(eth_event_rx_group); + vEventGroupDelete(eth_event_state_group); } void app_main(void) diff --git a/components/esp_eth/test_apps/pytest_esp_eth.py b/components/esp_eth/test_apps/pytest_esp_eth.py index aba0ead6cf..a6515f4709 100644 --- a/components/esp_eth/test_apps/pytest_esp_eth.py +++ b/components/esp_eth/test_apps/pytest_esp_eth.py @@ -1,4 +1,4 @@ -# SPDX-FileCopyrightText: 2022 Espressif Systems (Shanghai) CO LTD +# SPDX-FileCopyrightText: 2022-2023 Espressif Systems (Shanghai) CO LTD # SPDX-License-Identifier: CC0-1.0 import contextlib @@ -15,88 +15,98 @@ from scapy.all import Ether, raw ETH_TYPE = 0x2222 -@contextlib.contextmanager -def configure_eth_if() -> Iterator[socket.socket]: - # try to determine which interface to use - netifs = os.listdir('/sys/class/net/') - logging.info('detected interfaces: %s', str(netifs)) +class EthTestIntf(object): + def __init__(self, eth_type: int, my_if: str = ''): + self.target_if = '' + self.eth_type = eth_type + self.find_target_if(my_if) - target_if = '' - for netif in netifs: - if netif.find('eth') == 0 or netif.find('enp') == 0 or netif.find('eno') == 0: - target_if = netif - break - if target_if == '': - raise Exception('no network interface found') - logging.info('Use %s for testing', target_if) + def find_target_if(self, my_if: str = '') -> None: + # try to determine which interface to use + netifs = os.listdir('/sys/class/net/') + logging.info('detected interfaces: %s', str(netifs)) - so = socket.socket(socket.AF_PACKET, socket.SOCK_RAW, socket.htons(ETH_TYPE)) - so.bind((target_if, 0)) + for netif in netifs: + # if no interface defined, try to find it automatically + if my_if == '': + if netif.find('eth') == 0 or netif.find('enp') == 0 or netif.find('eno') == 0: + self.target_if = netif + break + else: + if netif.find(my_if) == 0: + self.target_if = my_if + break + if self.target_if == '': + raise Exception('network interface not found') + logging.info('Use %s for testing', self.target_if) - try: - yield so - finally: - so.close() - - -def send_eth_packet(mac: str) -> None: - with configure_eth_if() as so: - so.settimeout(10) - payload = bytearray(1010) - for i, _ in enumerate(payload): - payload[i] = i & 0xff - eth_frame = Ether(dst=mac, src=so.getsockname()[4], type=ETH_TYPE) / raw(payload) + @contextlib.contextmanager + def configure_eth_if(self, eth_type:int=0) -> Iterator[socket.socket]: + if eth_type == 0: + eth_type = self.eth_type + so = socket.socket(socket.AF_PACKET, socket.SOCK_RAW, socket.htons(eth_type)) + so.bind((self.target_if, 0)) try: - so.send(raw(eth_frame)) - except Exception as e: - raise e + yield so + finally: + so.close() - -def recv_resp_poke(i: int) -> None: - with configure_eth_if() as so: - so.settimeout(10) - try: - eth_frame = Ether(so.recv(60)) - - if eth_frame.type == ETH_TYPE and eth_frame.load[0] == 0xfa: - if eth_frame.load[1] != i: - raise Exception('Missed Poke Packet') - eth_frame.dst = eth_frame.src - eth_frame.src = so.getsockname()[4] - eth_frame.load = bytes.fromhex('fb') # POKE_RESP code + def send_eth_packet(self, mac: str) -> None: + with self.configure_eth_if() as so: + so.settimeout(10) + payload = bytearray(1010) + for i, _ in enumerate(payload): + payload[i] = i & 0xff + eth_frame = Ether(dst=mac, src=so.getsockname()[4], type=self.eth_type) / raw(payload) + try: so.send(raw(eth_frame)) - except Exception as e: - raise e + except Exception as e: + raise e + def recv_resp_poke(self, i:int=0) -> None: + eth_type_ctrl = self.eth_type + 1 + with self.configure_eth_if(eth_type_ctrl) as so: + so.settimeout(30) + try: + eth_frame = Ether(so.recv(60)) + if eth_frame.load[0] == 0xfa: + if eth_frame.load[1] != i: + raise Exception('Missed Poke Packet') + logging.info('Poke Packet received...') + eth_frame.dst = eth_frame.src + eth_frame.src = so.getsockname()[4] + eth_frame.load = bytes.fromhex('fb') # POKE_RESP code + so.send(raw(eth_frame)) + except Exception as e: + raise e -def traffic_gen(mac: str, pipe_rcv:connection.Connection) -> None: - with configure_eth_if() as so: - payload = bytes.fromhex('ff') # DUMMY_TRAFFIC code - payload += bytes(1485) - eth_frame = Ether(dst=mac, src=so.getsockname()[4], type=ETH_TYPE) / raw(payload) - try: - while pipe_rcv.poll() is not True: - so.send(raw(eth_frame)) - except Exception as e: - raise e + def traffic_gen(self, mac: str, pipe_rcv:connection.Connection) -> None: + with self.configure_eth_if() as so: + payload = bytes.fromhex('ff') # DUMMY_TRAFFIC code + payload += bytes(1485) + eth_frame = Ether(dst=mac, src=so.getsockname()[4], type=self.eth_type) / raw(payload) + try: + while pipe_rcv.poll() is not True: + so.send(raw(eth_frame)) + except Exception as e: + raise e def actual_test(dut: Dut) -> None: + target_if = EthTestIntf(ETH_TYPE) + dut.expect_exact('Press ENTER to see the list of tests') dut.write('\n') - dut.expect_exact('Enter test for running.') - dut.write('"start_and_stop"') - dut.expect_unity_test_output() - dut.expect_exact("Enter next test, or 'enter' to see menu") - dut.write('"get_set_mac"') - dut.expect_unity_test_output() - - dut.expect_exact("Enter next test, or 'enter' to see menu") - with configure_eth_if() as so: + with target_if.configure_eth_if() as so: so.settimeout(30) dut.write('"ethernet_broadcast_transmit"') + + # wait for POKE msg to be sure the switch already started forwarding the port's traffic + # (there might be slight delay due to the RSTP execution) + target_if.recv_resp_poke() + eth_frame = Ether(so.recv(1024)) for i in range(0, 1010): if eth_frame.load[i] != i & 0xff: @@ -109,9 +119,12 @@ def actual_test(dut: Dut) -> None: r'([\s\S]*)' r'DUT MAC: ([0-9A-Fa-f]{2}:[0-9A-Fa-f]{2}:[0-9A-Fa-f]{2}:[0-9A-Fa-f]{2}:[0-9A-Fa-f]{2}:[0-9A-Fa-f]{2})' ) - send_eth_packet('ff:ff:ff:ff:ff:ff') # broadcast frame - send_eth_packet('01:00:00:00:00:00') # multicast frame - send_eth_packet(res.group(2)) # unicast frame + # wait for POKE msg to be sure the switch already started forwarding the port's traffic + # (there might be slight delay due to the RSTP execution) + target_if.recv_resp_poke() + target_if.send_eth_packet('ff:ff:ff:ff:ff:ff') # broadcast frame + target_if.send_eth_packet('01:00:00:00:00:00') # multicast frame + target_if.send_eth_packet(res.group(2)) # unicast frame dut.expect_unity_test_output(extra_before=res.group(1)) dut.expect_exact("Enter next test, or 'enter' to see menu") @@ -122,21 +135,22 @@ def actual_test(dut: Dut) -> None: ) # Start/stop under heavy Tx traffic for tx_i in range(10): - recv_resp_poke(tx_i) + target_if.recv_resp_poke(tx_i) + dut.expect_exact('Ethernet stopped') - # Start/stop under heavy Rx traffic - pipe_rcv, pipe_send = Pipe(False) - tx_proc = Process(target=traffic_gen, args=(res.group(2), pipe_rcv, )) - tx_proc.start() - try: - for rx_i in range(10): - recv_resp_poke(rx_i) - finally: - pipe_send.send(0) + for rx_i in range(10): + target_if.recv_resp_poke(rx_i) + # Start/stop under heavy Rx traffic + pipe_rcv, pipe_send = Pipe(False) + tx_proc = Process(target=target_if.traffic_gen, args=(res.group(2), pipe_rcv, )) + tx_proc.start() + dut.expect_exact('Ethernet stopped') + pipe_send.send(0) # just send some dummy data tx_proc.join(5) if tx_proc.exitcode is None: tx_proc.terminate() - dut.expect_unity_test_output() + + dut.expect_unity_test_output(extra_before=res.group(1)) @pytest.mark.esp32