Merge branch 'feat/i2c_bus_version_update' into 'master'

feat(i2c_bus): i2c_bus component version update

Closes AEG-1919

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

Author: YanKE01

components/i2c_bus/CHANGELOG.md

@@ -1,5 +1,12 @@
 # ChangeLog
 
+## v1.0.0 - 2024-9-19
+
+### Enhancements:
+
+- Component version maintenance and documentation enhancement.
+- Support `esp_driver_i2c` driver.
+
 ## v0.1.0 - 2024-5-27
 
 First release version.

components/i2c_bus/CMakeLists.txt

@@ -1,5 +1,13 @@
-idf_component_register(SRC_DIRS "."
+if("${IDF_VERSION_MAJOR}.${IDF_VERSION_MINOR}" VERSION_GREATER_EQUAL "5.3")
+    set(SRC_FILE "i2c_bus_v2.c")
+    set(REQ esp_driver_i2c)
+else()
+    set(SRC_FILE "i2c_bus.c")
+    set(REQ driver)
+endif()
+
+idf_component_register(SRCS ${SRC_FILE}
                         INCLUDE_DIRS "include"
-                        REQUIRES driver)
+                        REQUIRES ${REQ})
 include(package_manager)
 cu_pkg_define_version(${CMAKE_CURRENT_LIST_DIR})

components/i2c_bus/README.md

@@ -20,4 +20,49 @@ Please use the component manager command `add-dependency` to add the `i2c_bus` t
 
 ```
 idf.py add-dependency "espressif/i2c_bus=*"
-```
+```
+
+Alternatively, you can create `idf_component.yml`. More is in [Espressif's documentation](https://docs.espressif.com/projects/esp-idf/en/latest/esp32/api-guides/tools/idf-component-manager.html).
+
+## Example use
+
+```c
+#include <stdio.h>
+#include "freertos/FreeRTOS.h"
+#include "freertos/task.h"
+#include "i2c_bus.h"
+
+#define I2C_MASTER_SCL_IO   (gpio_num_t)15       /*!< gpio number for I2C master clock */
+#define I2C_MASTER_SDA_IO   (gpio_num_t)16       /*!< gpio number for I2C master data  */
+#define I2C_MASTER_FREQ_HZ  100000               /*!< I2C master clock frequency */
+#define ESP_SLAVE_ADDR      0x28                 /*!< ESP32 slave address, you can set any 7bit value */
+#define DATA_LENGTH         64                   /*!<Data buffer length for test buffer*/
+
+void app_main(void)
+{
+
+    uint8_t *data_wr = (uint8_t *)malloc(DATA_LENGTH);
+
+    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 i2c0_bus = i2c_bus_create(I2C_NUM_0, &conf);
+    i2c_bus_device_handle_t i2c0_device1 = i2c_bus_device_create(i2c0_bus, ESP_SLAVE_ADDR, 0);
+    for (int i = 0; i < DATA_LENGTH; i++)
+    {
+        data_wr[i] = i;
+    }
+
+    i2c_bus_write_bytes(i2c0_device1, NULL_I2C_MEM_ADDR, DATA_LENGTH, data_wr);
+    free(data_wr);
+    i2c_bus_device_delete(&i2c0_device1);
+    i2c_bus_delete(&i2c0_bus);
+}
+
+```

components/i2c_bus/i2c_bus.c

@@ -364,7 +364,7 @@ esp_err_t i2c_bus_read_reg16(i2c_bus_device_handle_t dev_handle, uint16_t mem_ad
     I2C_BUS_MUTEX_TAKE(i2c_device->i2c_bus->mutex, ESP_ERR_TIMEOUT);
     i2c_cmd_handle_t cmd = i2c_cmd_link_create();
 
-    if (mem_address != NULL_I2C_MEM_ADDR) {
+    if (mem_address != NULL_I2C_MEM_16BIT_ADDR) {
         i2c_master_start(cmd);
         i2c_master_write_byte(cmd, (i2c_device->dev_addr << 1) | I2C_MASTER_WRITE, I2C_ACK_CHECK_EN);
         i2c_master_write(cmd, memAddress8, 2, I2C_ACK_CHECK_EN);
@@ -417,7 +417,7 @@ esp_err_t i2c_bus_write_reg16(i2c_bus_device_handle_t dev_handle, uint16_t mem_a
     i2c_master_start(cmd);
     i2c_master_write_byte(cmd, (i2c_device->dev_addr << 1) | I2C_MASTER_WRITE, I2C_ACK_CHECK_EN);
 
-    if (mem_address != NULL_I2C_MEM_ADDR) {
+    if (mem_address != NULL_I2C_MEM_16BIT_ADDR) {
         i2c_master_write(cmd, memAddress8, 2, I2C_ACK_CHECK_EN);
     }