Merge branch 'refactor/remove_i2c_slave_v1_s1' into 'master'

refactor(i2c): Replace i2c test from version one to version two

See merge request espressif/esp-idf!39085

Author: mythbuster5

components/esp_driver_i2c/test_apps/i2c_test_apps/main/CMakeLists.txt

@@ -2,35 +2,27 @@ set(srcs "test_app_main.c"
          "test_i2c_common.c"
     )
 
-if(CONFIG_SOC_I2C_SUPPORT_SLAVE)
-    if(CONFIG_I2C_ENABLE_SLAVE_DRIVER_VERSION_2)
-        list(APPEND srcs "test_i2c_slave_v2.c")
-    else()
-        list(APPEND srcs "test_i2c_multi.c")
-
-        if(CONFIG_SOC_I2C_SLAVE_SUPPORT_BROADCAST)
-            list(APPEND srcs "test_i2c_broadcast.c")
-        endif()
-
-        if(CONFIG_SOC_I2C_SLAVE_SUPPORT_I2CRAM_ACCESS)
-            list(APPEND srcs "test_i2c_ram.c")
-        endif()
-
-        if(CONFIG_SOC_I2C_SUPPORT_10BIT_ADDR AND CONFIG_SOC_I2C_SUPPORT_SLAVE)
-            list(APPEND srcs "test_i2c_10bit.c")
-        endif()
-
-        if(CONFIG_SOC_LP_I2C_SUPPORTED)
-            list(APPEND srcs "test_lp_i2c.c")
-        endif()
-
-        if(CONFIG_SOC_I2C_SUPPORT_SLEEP_RETENTION)
-            list(APPEND srcs "test_i2c_sleep_retention.c")
-        endif()
-
-        if(CONFIG_I2C_ISR_IRAM_SAFE)
-            list(APPEND srcs "test_i2c_iram.c")
-        endif()
+if(CONFIG_SOC_I2C_SUPPORT_SLAVE AND CONFIG_SOC_I2C_SLAVE_CAN_GET_STRETCH_CAUSE)
+    list(APPEND srcs "test_i2c_multi.c")
+
+    if(CONFIG_SOC_I2C_SLAVE_SUPPORT_BROADCAST)
+        list(APPEND srcs "test_i2c_broadcast.c")
+    endif()
+
+    if(CONFIG_SOC_I2C_SUPPORT_10BIT_ADDR)
+        list(APPEND srcs "test_i2c_10bit.c")
+    endif()
+
+    if(CONFIG_SOC_LP_I2C_SUPPORTED)
+        list(APPEND srcs "test_lp_i2c.c")
+    endif()
+
+    if(CONFIG_SOC_I2C_SUPPORT_SLEEP_RETENTION)
+       list(APPEND srcs "test_i2c_sleep_retention.c")
+    endif()
+
+    if(CONFIG_I2C_ISR_IRAM_SAFE)
+       list(APPEND srcs "test_i2c_iram.c")
     endif()
 endif()
 

components/esp_driver_i2c/test_apps/i2c_test_apps/main/test_board.h

@@ -1,5 +1,5 @@
 /*
- * SPDX-FileCopyrightText: 2023-2024 Espressif Systems (Shanghai) CO LTD
+ * SPDX-FileCopyrightText: 2023-2025 Espressif Systems (Shanghai) CO LTD
  *
  * SPDX-License-Identifier: Apache-2.0
  */
@@ -42,6 +42,14 @@ extern "C" {
 #define TEST_I2C_PORT     0
 #define DATA_LENGTH     100
 
+/**
+ * @brief Slave test event
+ */
+typedef enum {
+    I2C_SLAVE_EVT_RX,
+    I2C_SLAVE_EVT_TX
+} i2c_slave_event_t;
+
 /**
  * @brief Display buffer
  *

components/esp_driver_i2c/test_apps/i2c_test_apps/main/test_i2c_10bit.c

@@ -1,5 +1,5 @@
 /*
- * SPDX-FileCopyrightText: 2023 Espressif Systems (Shanghai) CO LTD
+ * SPDX-FileCopyrightText: 2023-2025 Espressif Systems (Shanghai) CO LTD
  *
  * SPDX-License-Identifier: Unlicense OR CC0-1.0
  */
@@ -22,14 +22,77 @@
 #include "test_utils.h"
 #include "test_board.h"
 
-static QueueHandle_t s_receive_queue;
+static QueueHandle_t event_queue;
+static uint8_t *temp_data;
+static size_t temp_len = 0;
 
-static IRAM_ATTR bool example_i2c_rx_done_callback(i2c_slave_dev_handle_t channel, const i2c_slave_rx_done_event_data_t *edata, void *user_data)
+static IRAM_ATTR bool i2c_slave_request_cb(i2c_slave_dev_handle_t i2c_slave, const i2c_slave_request_event_data_t *evt_data, void *arg)
 {
-    BaseType_t high_task_wakeup = pdFALSE;
-    QueueHandle_t receive_queue = (QueueHandle_t)user_data;
-    xQueueSendFromISR(receive_queue, edata, &high_task_wakeup);
-    return high_task_wakeup == pdTRUE;
+    BaseType_t xTaskWoken;
+    i2c_slave_event_t evt = I2C_SLAVE_EVT_TX;
+    xQueueSendFromISR(event_queue, &evt, &xTaskWoken);
+    return xTaskWoken;
+}
+
+static IRAM_ATTR bool i2c_slave_receive_cb(i2c_slave_dev_handle_t i2c_slave, const i2c_slave_rx_done_event_data_t *evt_data, void *arg)
+{
+    BaseType_t xTaskWoken;
+    i2c_slave_event_t evt = I2C_SLAVE_EVT_RX;
+    memcpy(temp_data, evt_data->buffer, evt_data->length);
+    temp_len = evt_data->length;
+    xQueueSendFromISR(event_queue, &evt, &xTaskWoken);
+    return xTaskWoken;
+}
+
+static void i2c_slave_read_test_10bit(void)
+{
+    unity_wait_for_signal("i2c master init first");
+    i2c_slave_dev_handle_t handle;
+    event_queue = xQueueCreate(2, sizeof(i2c_slave_event_t));
+    assert(event_queue);
+    temp_data = heap_caps_malloc(DATA_LENGTH, MALLOC_CAP_DEFAULT);
+    assert(temp_data);
+
+    i2c_slave_config_t i2c_slv_config = {
+        .i2c_port = TEST_I2C_PORT,
+        .clk_source = I2C_CLK_SRC_DEFAULT,
+        .scl_io_num = I2C_SLAVE_SCL_IO,
+        .sda_io_num = I2C_SLAVE_SDA_IO,
+        .slave_addr = 0x134,
+        .send_buf_depth = DATA_LENGTH,
+        .receive_buf_depth = DATA_LENGTH,
+        .flags.enable_internal_pullup = true,
+        .addr_bit_len = I2C_ADDR_BIT_LEN_10,
+    };
+
+    TEST_ESP_OK(i2c_new_slave_device(&i2c_slv_config, &handle));
+
+    i2c_slave_event_callbacks_t cbs = {
+        .on_receive = i2c_slave_receive_cb,
+        .on_request = i2c_slave_request_cb,
+    };
+
+    TEST_ESP_OK(i2c_slave_register_event_callbacks(handle, &cbs, NULL));
+
+    unity_send_signal("i2c slave init finish");
+
+    unity_wait_for_signal("master write");
+
+    i2c_slave_event_t evt;
+    if (xQueueReceive(event_queue, &evt, portMAX_DELAY) == pdTRUE) {
+        if (evt == I2C_SLAVE_EVT_RX) {
+            disp_buf(temp_data, temp_len);
+            printf("length is %x\n", temp_len);
+            for (int i = 0; i < temp_len; i++) {
+                TEST_ASSERT(temp_data[i] == i);
+            }
+        }
+    }
+
+    unity_send_signal("ready to delete");
+    free(temp_data);
+    vQueueDelete(event_queue);
+    TEST_ESP_OK(i2c_del_slave_device(handle));
 }
 
 static void i2c_master_write_test_10bit(void)
@@ -74,47 +137,6 @@ static void i2c_master_write_test_10bit(void)
     TEST_ESP_OK(i2c_del_master_bus(bus_handle));
 }
 
-static void i2c_slave_read_test_10bit(void)
-{
-    unity_wait_for_signal("i2c master init first");
-    uint8_t data_rd[DATA_LENGTH] = {0};
-
-    i2c_slave_config_t i2c_slv_config = {
-        .addr_bit_len = I2C_ADDR_BIT_LEN_10,
-        .clk_source = I2C_CLK_SRC_DEFAULT,
-        .i2c_port = TEST_I2C_PORT,
-        .send_buf_depth = 256,
-        .scl_io_num = I2C_SLAVE_SCL_IO,
-        .sda_io_num = I2C_SLAVE_SDA_IO,
-        .slave_addr = 0x134,
-    };
-
-    i2c_slave_dev_handle_t slave_handle;
-    TEST_ESP_OK(i2c_new_slave_device(&i2c_slv_config, &slave_handle));
-
-    s_receive_queue = xQueueCreate(1, sizeof(i2c_slave_rx_done_event_data_t));
-    i2c_slave_event_callbacks_t cbs = {
-        .on_recv_done = example_i2c_rx_done_callback,
-    };
-    ESP_ERROR_CHECK(i2c_slave_register_event_callbacks(slave_handle, &cbs, s_receive_queue));
-
-    i2c_slave_rx_done_event_data_t rx_data;
-    TEST_ESP_OK(i2c_slave_receive(slave_handle, data_rd, DATA_LENGTH));
-
-    unity_send_signal("i2c slave init finish");
-
-    unity_wait_for_signal("master write");
-    xQueueReceive(s_receive_queue, &rx_data, pdMS_TO_TICKS(1000));
-
-    disp_buf(data_rd, DATA_LENGTH);
-    for (int i = 0; i < DATA_LENGTH; i++) {
-        TEST_ASSERT(data_rd[i] == i);
-    }
-    vQueueDelete(s_receive_queue);
-    unity_send_signal("ready to delete");
-    TEST_ESP_OK(i2c_del_slave_device(slave_handle));
-}
-
 TEST_CASE_MULTIPLE_DEVICES("I2C master write slave test 10 bit", "[i2c][test_env=generic_multi_device][timeout=150]", i2c_master_write_test_10bit, i2c_slave_read_test_10bit);
 
 static void master_read_slave_test_10bit(void)
@@ -134,59 +156,74 @@ static void master_read_slave_test_10bit(void)
         .dev_addr_length = I2C_ADDR_BIT_LEN_10,
         .device_address = 0x134,
         .scl_speed_hz = 100000,
+        .scl_wait_us = 20000,
     };
 
     i2c_master_dev_handle_t dev_handle;
     TEST_ESP_OK(i2c_master_bus_add_device(bus_handle, &dev_cfg, &dev_handle));
 
     unity_wait_for_signal("i2c slave init finish");
 
-    printf("Slave please write data to buffer\n");
-
-    unity_send_signal("slave write");
-    unity_wait_for_signal("master read");
-
     TEST_ESP_OK(i2c_master_receive(dev_handle, data_rd, DATA_LENGTH, -1));
     vTaskDelay(100 / portTICK_PERIOD_MS);
     for (int i = 0; i < DATA_LENGTH; i++) {
-        printf("%d\n", data_rd[i]);
+        printf("%x\n", data_rd[i]);
         TEST_ASSERT(data_rd[i] == i);
     }
-    unity_send_signal("ready to delete 10bit");
+    unity_send_signal("ready to delete master read test");
 
     TEST_ESP_OK(i2c_master_bus_rm_device(dev_handle));
     TEST_ESP_OK(i2c_del_master_bus(bus_handle));
 }
 
 static void slave_write_buffer_test_10bit(void)
 {
-    uint8_t data_wr[DATA_LENGTH] = {0};
+    i2c_slave_dev_handle_t handle;
+    uint8_t data_wr[DATA_LENGTH];
+    event_queue = xQueueCreate(2, sizeof(i2c_slave_event_t));
+    assert(event_queue);
 
     i2c_slave_config_t i2c_slv_config = {
-        .addr_bit_len = I2C_ADDR_BIT_LEN_10,
-        .clk_source = I2C_CLK_SRC_DEFAULT,
         .i2c_port = TEST_I2C_PORT,
-        .send_buf_depth = 256,
+        .clk_source = I2C_CLK_SRC_DEFAULT,
         .scl_io_num = I2C_SLAVE_SCL_IO,
         .sda_io_num = I2C_SLAVE_SDA_IO,
         .slave_addr = 0x134,
+        .send_buf_depth = DATA_LENGTH,
+        .receive_buf_depth = DATA_LENGTH,
+        .flags.enable_internal_pullup = true,
+        .addr_bit_len = I2C_ADDR_BIT_LEN_10,
     };
 
-    i2c_slave_dev_handle_t slave_handle;
-    TEST_ESP_OK(i2c_new_slave_device(&i2c_slv_config, &slave_handle));
+    TEST_ESP_OK(i2c_new_slave_device(&i2c_slv_config, &handle));
+
+    i2c_slave_event_callbacks_t cbs = {
+        .on_receive = i2c_slave_receive_cb,
+        .on_request = i2c_slave_request_cb,
+    };
+
+    TEST_ESP_OK(i2c_slave_register_event_callbacks(handle, &cbs, NULL));
 
     unity_send_signal("i2c slave init finish");
 
-    unity_wait_for_signal("slave write");
     for (int i = 0; i < DATA_LENGTH; i++) {
         data_wr[i] = i;
     }
 
-    TEST_ESP_OK(i2c_slave_transmit(slave_handle, data_wr, DATA_LENGTH, -1));
-    disp_buf(data_wr, DATA_LENGTH);
-    unity_send_signal("master read");
-    unity_wait_for_signal("ready to delete 10bit");
-    TEST_ESP_OK(i2c_del_slave_device(slave_handle));
+    i2c_slave_event_t evt;
+    uint32_t write_len;
+    while (true) {
+        if (xQueueReceive(event_queue, &evt, portMAX_DELAY) == pdTRUE) {
+            if (evt == I2C_SLAVE_EVT_TX) {
+                TEST_ESP_OK(i2c_slave_write(handle, data_wr, DATA_LENGTH, &write_len, 1000));
+                break;
+            }
+        }
+    }
+
+    unity_wait_for_signal("ready to delete master read test");
+    vQueueDelete(event_queue);
+    TEST_ESP_OK(i2c_del_slave_device(handle));
 }
 
 TEST_CASE_MULTIPLE_DEVICES("I2C master read slave test 10 bit", "[i2c][test_env=generic_multi_device][timeout=150]", master_read_slave_test_10bit, slave_write_buffer_test_10bit);