fix(i2c_master): Fix issue that use callback may cause memory leak,

Closes https://github.com/espressif/esp-idf/issues/12878
2026-10-02 11:10:54 +03:00 · 2024-04-01 10:15:45 +08:00
parent f93ebedcb6
commit 8567102be4
3 changed files with 171 additions and 97 deletions
@@ -1,5 +1,5 @@
 /*
- * SPDX-FileCopyrightText: 2023 Espressif Systems (Shanghai) CO LTD
+ * SPDX-FileCopyrightText: 2023-2024 Espressif Systems (Shanghai) CO LTD
 *
 * SPDX-License-Identifier: Unlicense OR CC0-1.0
 */
@@ -148,3 +148,84 @@ TEST_CASE("I2C master probe device test", "[i2c]")
    TEST_ESP_ERR(i2c_master_probe(bus_handle, 0x55, -1), ESP_ERR_NOT_FOUND);
    TEST_ESP_OK(i2c_del_master_bus(bus_handle));
 }
+
+#define LENGTH 48
+
+static IRAM_ATTR bool test_master_tx_done_callback(i2c_master_dev_handle_t i2c_dev, const i2c_master_event_data_t *evt_data, void *arg)
+{
+    return true;
+}
+
+/*******************************************************************************
+ *
+ * This test aim to test I2C non-blocking transaction function. Several things have been
+ * done in this test for testing its memory/concurrency issues.
+ *
+ * 1. See the depth of queue is 37, but the number of transaction is 42, that means some
+ *    queue must be reused.
+ * 2. There are some delay randomly set there, for testing the concurency or any I2C state
+ *    might be met.
+ *******************************************************************************
+*/
+TEST_CASE("I2C master transaction non-blocking mode with large amount of transaction", "[i2c]")
+{
+    i2c_master_bus_config_t i2c_bus_config = {
+        .clk_source = I2C_CLK_SRC_DEFAULT,
+        .i2c_port = TEST_I2C_PORT,
+        .scl_io_num = I2C_MASTER_SCL_IO,
+        .sda_io_num = I2C_MASTER_SDA_IO,
+        .glitch_ignore_cnt = 7,
+        .trans_queue_depth = 37,
+        .flags.enable_internal_pullup = true,
+    };
+
+    i2c_master_bus_handle_t bus_handle;
+
+    TEST_ESP_OK(i2c_new_master_bus(&i2c_bus_config, &bus_handle));
+
+    i2c_device_config_t dev_cfg = {
+        .dev_addr_length = I2C_ADDR_BIT_LEN_7,
+        .device_address = 0x58,
+        .scl_speed_hz = 400000,
+    };
+
+    i2c_master_dev_handle_t dev_handle;
+    TEST_ESP_OK(i2c_master_bus_add_device(bus_handle, &dev_cfg, &dev_handle));
+
+    i2c_master_event_callbacks_t cbs = {
+        .on_trans_done = test_master_tx_done_callback,
+    };
+    i2c_master_register_event_callbacks(dev_handle, &cbs, NULL);
+
+    uint32_t cnt = 7;
+    uint8_t *buf[6];
+    for (int i = 0; i < 6; i++) {
+        buf[i] = (uint8_t*)heap_caps_calloc(1, LENGTH, MALLOC_CAP_8BIT);
+        for (int j = 0; j < LENGTH; j++) {
+            buf[i][j] = i + j;
+        }
+    }
+    while (cnt--) {
+        i2c_master_transmit(dev_handle, buf[0], LENGTH, -1);
+        esp_rom_delay_us(1000);
+        i2c_master_transmit(dev_handle, buf[1], LENGTH, -1);
+        esp_rom_delay_us(500);
+        i2c_master_transmit(dev_handle, buf[2], LENGTH, -1);
+        esp_rom_delay_us(200);
+        i2c_master_transmit(dev_handle, buf[3], LENGTH, -1);
+        esp_rom_delay_us(400);
+        i2c_master_transmit(dev_handle, buf[4], LENGTH, -1);
+        esp_rom_delay_us(700);
+        i2c_master_transmit(dev_handle, buf[5], LENGTH, -1);
+        esp_rom_delay_us(200);
+    }
+
+    i2c_master_bus_wait_all_done(bus_handle, -1);
+    for (int i = 0; i < 6; i++) {
+        if (buf[i]) {
+            free(buf[i]);
+        }
+    }
+    TEST_ESP_OK(i2c_master_bus_rm_device(dev_handle));
+    TEST_ESP_OK(i2c_del_master_bus(bus_handle));
+}