fix(i2c_bus): soft i2c allows access to all registers and avoids Kconfig conflicts

Author: YanKE01

components/i2c_bus/CHANGELOG.md

@@ -1,5 +1,12 @@
 # ChangeLog
 
+## V1.4.1 - 2025-8-14
+
+### Bug Fix:
+
+- Soft i2c supports removing the restriction on ``NULL_I2C_MEM_ADDR``, allowing users to refer to all eligible register addresses.
+- Modify the `ESP_IDF_VERSION` naming in Kconfig to avoid conflicts with other components.
+
 ## v1.4.0 - 2025-3-13
 
 ### Enhancements:

components/i2c_bus/Kconfig

@@ -1,7 +1,7 @@
 menu "Bus Options"
 
     menu "I2C Bus Options"
-        config ESP_IDF_VERSION
+        config ESP_IDF_VERSION_FOR_I2C
             string
             option env="ESP_IDF_VERSION"
 
@@ -22,7 +22,7 @@ menu "Bus Options"
         config I2C_BUS_BACKWARD_CONFIG
             bool "Enable backward compatibility for the I2C driver (force use of the old i2c_driver above v5.3)"
             default n
-            depends on ESP_IDF_VERSION >= 5.3
+            depends on ESP_IDF_VERSION_FOR_I2C >= 5.3
             help
                 Enable this option for backward compatibility with the old I2C driver
 

components/i2c_bus/i2c_bus_soft.c

@@ -110,11 +110,14 @@ esp_err_t i2c_master_soft_bus_write_reg8(i2c_master_soft_bus_handle_t bus_handle
 
     ESP_RETURN_ON_ERROR(i2c_master_soft_bus_wait_ack(bus_handle), TAG, "No ACK for device address");
 
+#if !CONFIG_I2C_BUS_REMOVE_NULL_MEM_ADDR
     if (mem_address != NULL_I2C_MEM_ADDR) {
+#endif
         ESP_RETURN_ON_ERROR(i2c_master_soft_bus_write_byte(bus_handle, mem_address), TAG, "Failed to write memory address");
         ESP_RETURN_ON_ERROR(i2c_master_soft_bus_wait_ack(bus_handle), TAG, "No ACK for device address");
+#if !CONFIG_I2C_BUS_REMOVE_NULL_MEM_ADDR
     }
-
+#endif
     // Write data
     for (size_t i = 0; i < data_len; i++) {
         ESP_RETURN_ON_ERROR(i2c_master_soft_bus_write_byte(bus_handle, data[i]), TAG, "Failed to write data byte");
@@ -136,12 +139,16 @@ esp_err_t i2c_master_soft_bus_write_reg16(i2c_master_soft_bus_handle_t bus_handl
     ESP_RETURN_ON_ERROR(i2c_master_soft_bus_write_byte(bus_handle, address_byte), TAG, "Failed to write device address");
     ESP_RETURN_ON_ERROR(i2c_master_soft_bus_wait_ack(bus_handle), TAG, "No ACK for device address");
 
+#if !CONFIG_I2C_BUS_REMOVE_NULL_MEM_ADDR
     if (mem_address != NULL_I2C_MEM_16BIT_ADDR) {
+#endif
         ESP_RETURN_ON_ERROR(i2c_master_soft_bus_write_byte(bus_handle, (uint8_t)((mem_address >> 8) & 0x00FF)), TAG, "Failed to write memory address");
         ESP_RETURN_ON_ERROR(i2c_master_soft_bus_wait_ack(bus_handle), TAG, "No ACK for mem address");
         ESP_RETURN_ON_ERROR(i2c_master_soft_bus_write_byte(bus_handle, (uint8_t)(mem_address & 0x00FF)), TAG, "Failed to write memory address");
         ESP_RETURN_ON_ERROR(i2c_master_soft_bus_wait_ack(bus_handle), TAG, "No ACK for mem address");
+#if !CONFIG_I2C_BUS_REMOVE_NULL_MEM_ADDR
     }
+#endif
 
     // Write data
     for (size_t i = 0; i < data_len; i++) {
@@ -159,7 +166,9 @@ esp_err_t i2c_master_soft_bus_read_reg8(i2c_master_soft_bus_handle_t bus_handle,
     ESP_RETURN_ON_FALSE(bus_handle, ESP_ERR_INVALID_ARG, TAG, "Invalid I2C bus handle");
 
     // Send memory address
+#if !CONFIG_I2C_BUS_REMOVE_NULL_MEM_ADDR
     if (mem_address != NULL_I2C_MEM_ADDR) {
+#endif
         // Generate START condition
         ESP_RETURN_ON_ERROR(i2c_master_soft_bus_start(bus_handle), TAG, "Failed to initiate start signal");
 
@@ -169,7 +178,9 @@ esp_err_t i2c_master_soft_bus_read_reg8(i2c_master_soft_bus_handle_t bus_handle,
         ESP_RETURN_ON_ERROR(i2c_master_soft_bus_wait_ack(bus_handle), TAG, "No ACK for device address");
         ESP_RETURN_ON_ERROR(i2c_master_soft_bus_write_byte(bus_handle, mem_address), TAG, "Failed to write memory address");
         ESP_RETURN_ON_ERROR(i2c_master_soft_bus_wait_ack(bus_handle), TAG, "No ACK for mem address");
+#if !CONFIG_I2C_BUS_REMOVE_NULL_MEM_ADDR
     }
+#endif
 
     // Generate RESTART condition
     ESP_RETURN_ON_ERROR(i2c_master_soft_bus_start(bus_handle), TAG, "Failed to initiate repeated start signal");
@@ -198,7 +209,9 @@ esp_err_t i2c_master_soft_bus_read_reg16(i2c_master_soft_bus_handle_t bus_handle
     ESP_RETURN_ON_FALSE(bus_handle, ESP_ERR_INVALID_ARG, TAG, "Invalid I2C bus handle");
 
     // Send memory address
+#if !CONFIG_I2C_BUS_REMOVE_NULL_MEM_ADDR
     if (mem_address != NULL_I2C_MEM_16BIT_ADDR) {
+#endif
         // Generate START condition
         ESP_RETURN_ON_ERROR(i2c_master_soft_bus_start(bus_handle), TAG, "Failed to initiate start signal");
 
@@ -210,7 +223,9 @@ esp_err_t i2c_master_soft_bus_read_reg16(i2c_master_soft_bus_handle_t bus_handle
         ESP_RETURN_ON_ERROR(i2c_master_soft_bus_wait_ack(bus_handle), TAG, "No ACK for mem address");
         ESP_RETURN_ON_ERROR(i2c_master_soft_bus_write_byte(bus_handle, (uint8_t)(mem_address & 0x00FF)), TAG, "Failed to write memory address");
         ESP_RETURN_ON_ERROR(i2c_master_soft_bus_wait_ack(bus_handle), TAG, "No ACK for mem address");
+#if !CONFIG_I2C_BUS_REMOVE_NULL_MEM_ADDR
     }
+#endif
 
     // Generate RESTART condition
     ESP_RETURN_ON_ERROR(i2c_master_soft_bus_start(bus_handle), TAG, "Failed to initiate repeated start signal");

components/i2c_bus/idf_component.yml

@@ -1,4 +1,4 @@
-version: "1.4.0"
+version: "1.4.1"
 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/test_apps/sdkconfig.defaults

@@ -0,0 +1,10 @@
+# For IDF 5.0
+CONFIG_ESP_DEFAULT_CPU_FREQ_MHZ_240=y
+CONFIG_FREERTOS_HZ=1000
+CONFIG_ESP_TASK_WDT_EN=n
+CONFIG_FREERTOS_TIMER_TASK_STACK_DEPTH=4096
+
+# For IDF4.4
+CONFIG_ESP32S2_DEFAULT_CPU_FREQ_240=y
+CONFIG_ESP32S3_DEFAULT_CPU_FREQ_240=y
+CONFIG_ESP_TASK_WDT=n