Merge branch 'feat/i2c_bus_support_bus_handle' into 'master'

feat(i2c_bus): support the bus_handle provided by esp_driver_i2c

See merge request ae_group/esp-iot-solution!1224

Author: YanKE01

components/i2c_bus/CHANGELOG.md

@@ -1,5 +1,11 @@
 # ChangeLog
 
+## v1.3.0 - 2025-2-13
+
+### Enhancements:
+
+- ``i2c_bus_v2`` supports initialization using the bus_handle provided by ``esp_driver_i2c``, and also supports returning the internal bus_handle of ``esp_driver_i2c``.
+
 ## v1.2.0 - 2025-1-14
 
 ### Enhancements:

components/i2c_bus/i2c_bus_v2.c

@@ -100,6 +100,18 @@ i2c_bus_handle_t i2c_bus_create(i2c_port_t port, const i2c_config_t *conf)
     I2C_BUS_CHECK(conf != NULL, "pointer = NULL error", NULL);
     I2C_BUS_CHECK(conf->mode == I2C_MODE_MASTER, "i2c_bus only supports master mode", NULL);
 
+    if (i2c_master_get_bus_handle(port, &s_i2c_bus[port].bus_handle) == ESP_OK) {
+        s_i2c_bus[port].is_init = true;
+        s_i2c_bus[port].conf_activate = *conf;
+        s_i2c_bus[port].bus_config.i2c_port = port;
+        s_i2c_bus[port].device_config.scl_speed_hz = conf->master.clk_speed;
+        s_i2c_bus[port].mutex = xSemaphoreCreateMutex();
+        I2C_BUS_CHECK(s_i2c_bus[port].mutex != NULL, "i2c_bus xSemaphoreCreateMutex failed", NULL);
+        s_i2c_bus[port].ref_counter = 0;
+        ESP_LOGI(TAG, "I2C Bus V2 uses the externally initialized bus handle");
+        return (i2c_bus_handle_t)&s_i2c_bus[port];
+    }
+
     if (s_i2c_bus[port].is_init) {
         // if i2c_bus has been inited and configs not changed, return the handle directly
         if (i2c_config_compare(port, conf)) {
@@ -141,6 +153,14 @@ esp_err_t i2c_bus_delete(i2c_bus_handle_t *p_bus)
     return ESP_OK;
 }
 
+i2c_master_bus_handle_t i2c_bus_get_internal_bus_handle(i2c_bus_handle_t bus_handle)
+{
+    I2C_BUS_CHECK(bus_handle != NULL, "Null Bus Handle", NULL);
+    i2c_bus_t *i2c_bus = (i2c_bus_t *)bus_handle;
+    I2C_BUS_INIT_CHECK(i2c_bus->is_init, NULL);
+    return i2c_bus->bus_handle;
+}
+
 uint32_t i2c_bus_get_current_clk_speed(i2c_bus_handle_t bus_handle)
 {
     I2C_BUS_CHECK(bus_handle != NULL, "Null Bus Handle", 0);

components/i2c_bus/idf_component.yml

@@ -1,4 +1,4 @@
-version: "1.2.0"
+version: "1.3.0"
 description: The I2C Bus Driver supports both hardware and software I2C.
 url: https://github.com/espressif/esp-iot-solution/tree/master/components/i2c_bus
 repository: https://github.com/espressif/esp-iot-solution.git

components/i2c_bus/include/i2c_bus.h

@@ -98,6 +98,18 @@ i2c_bus_handle_t i2c_bus_create(i2c_port_t port, const i2c_config_t *conf);
  */
 esp_err_t i2c_bus_delete(i2c_bus_handle_t *p_bus_handle);
 
+#if ESP_IDF_VERSION >= ESP_IDF_VERSION_VAL(5, 3, 0)
+#if !CONFIG_I2C_BUS_BACKWARD_CONFIG
+/**
+ * @brief Get internal idf bus_handle from i2c_bus_handle
+ *
+ * @param bus_handle I2C bus handle
+ * @return i2c_master_bus_handle_t Return the idf bus_handle if obtained successfully, return NULL if failed.
+ */
+i2c_master_bus_handle_t i2c_bus_get_internal_bus_handle(i2c_bus_handle_t bus_handle);
+#endif
+#endif
+
 /**
  * @brief Scan i2c devices attached on i2c bus
  *

components/i2c_bus/test_apps/main/test_i2c_bus.c

@@ -372,6 +372,46 @@ TEST_CASE("i2c bus init-deinit test", "[bus][i2c_bus]")
     i2c_bus_device_add_test();
 }
 
+#if ESP_IDF_VERSION >= ESP_IDF_VERSION_VAL(5, 3, 0) && !CONFIG_I2C_BUS_BACKWARD_CONFIG
+TEST_CASE("I2C bus uses external bus handle test", "[bus][i2c_bus]")
+{
+    uint8_t *data_wr = (uint8_t *) malloc(RW_TEST_LENGTH);
+    for (int i = 0; i < RW_TEST_LENGTH; i++) {
+        data_wr[i] = i;
+    }
+
+    i2c_master_bus_config_t i2c_mst_config = {
+        .clk_source = I2C_CLK_SRC_DEFAULT,
+        .i2c_port = I2C_MASTER_NUM,
+        .scl_io_num = I2C_MASTER_SCL_IO,
+        .sda_io_num = I2C_MASTER_SDA_IO,
+        .flags.enable_internal_pullup = true,
+    };
+    i2c_master_bus_handle_t bus_handle;
+
+    TEST_ESP_OK(i2c_new_master_bus(&i2c_mst_config, &bus_handle));
+
+    i2c_config_t conf = {
+        .mode = I2C_MODE_MASTER,
+        .sda_io_num = I2C_MASTER_SDA_IO,
+        .sda_pullup_en = GPIO_PULLUP_ENABLE,
+        .scl_io_num = I2C_MASTER_SCL_IO,
+        .scl_pullup_en = GPIO_PULLUP_ENABLE,
+        .master.clk_speed = I2C_MASTER_FREQ_HZ,
+    };
+
+    i2c_bus_handle_t i2c_bus = i2c_bus_create(I2C_MASTER_NUM, &conf);
+
+    i2c_bus_device_handle_t i2c_device1 = i2c_bus_device_create(i2c_bus, 0x01, 400000);
+    TEST_ASSERT(i2c_device1 != NULL);
+    i2c_bus_write_bytes(i2c_device1, NULL_I2C_MEM_ADDR, RW_TEST_LENGTH, data_wr);
+    i2c_bus_device_delete(&i2c_device1);
+    free(data_wr);
+    TEST_ASSERT(ESP_OK == i2c_bus_delete(&i2c_bus));
+    TEST_ASSERT(i2c_bus == NULL);
+}
+#endif
+
 TEST_CASE("I2C bus scan test", "[i2c_bus][scan]")
 {
     uint8_t addrs[I2C_SCAN_ADDR_NUM] = {0};