From d4f3c9c0d57d81d847fb2b7e287c107acc537bf8 Mon Sep 17 00:00:00 2001 From: "C.S.M" Date: Thu, 21 Nov 2024 11:23:15 +0800 Subject: [PATCH 1/5] fix(i2c): Enhance lp clock source and avoid deadlock, Closes https://github.com/espressif/esp-idf/issues/14908, Closes https://github.com/espressif/esp-idf/issues/14906 --- components/esp_driver_i2c/i2c_common.c | 6 +++- components/esp_driver_i2c/i2c_master.c | 13 +++++++ .../i2c_test_apps/main/test_i2c_common.c | 35 +++++++++++++++++++ .../i2c_test_apps/main/test_lp_i2c.c | 14 ++++++++ 4 files changed, 67 insertions(+), 1 deletion(-) diff --git a/components/esp_driver_i2c/i2c_common.c b/components/esp_driver_i2c/i2c_common.c index 87bad063b0..b0872c4598 100644 --- a/components/esp_driver_i2c/i2c_common.c +++ b/components/esp_driver_i2c/i2c_common.c @@ -153,7 +153,11 @@ esp_err_t i2c_acquire_bus_handle(i2c_port_num_t port_num, i2c_bus_handle_t *i2c_ break; } } - ESP_RETURN_ON_FALSE((bus_found == true), ESP_ERR_NOT_FOUND, TAG, "acquire bus failed, no free bus"); + if (bus_found == false) { + ESP_LOGE(TAG, "acquire bus failed, no free bus"); + _lock_release(&s_i2c_platform.mutex); + return ESP_ERR_NOT_FOUND; + } } else { ret = s_i2c_bus_handle_acquire(port_num, i2c_new_bus, mode); if (ret != ESP_OK) { diff --git a/components/esp_driver_i2c/i2c_master.c b/components/esp_driver_i2c/i2c_master.c index 2211971f38..924eeddb83 100644 --- a/components/esp_driver_i2c/i2c_master.c +++ b/components/esp_driver_i2c/i2c_master.c @@ -932,6 +932,19 @@ esp_err_t i2c_new_master_bus(const i2c_master_bus_config_t *bus_config, i2c_mast } #if SOC_LP_I2C_SUPPORTED else { + + soc_periph_lp_i2c_clk_src_t clk_srcs[] = SOC_LP_I2C_CLKS; + bool lp_clock_match = false; + for (int i = 0; i < sizeof(clk_srcs) / sizeof(clk_srcs[0]); i++) { + if ((int)clk_srcs[i] == (int)i2c_master->base->clk_src) { + /* Clock source matches. Override the source clock type with the user configured value */ + lp_clock_match = true; + break; + } + } + + ESP_GOTO_ON_FALSE(lp_clock_match, ESP_ERR_NOT_SUPPORTED, err, TAG, "the clock source does not support lp i2c, please check"); + LP_I2C_SRC_CLK_ATOMIC() { lp_i2c_ll_set_source_clk(hal->dev, i2c_master->base->clk_src); } diff --git a/components/esp_driver_i2c/test_apps/i2c_test_apps/main/test_i2c_common.c b/components/esp_driver_i2c/test_apps/i2c_test_apps/main/test_i2c_common.c index 55d7064b86..53034af1bd 100644 --- a/components/esp_driver_i2c/test_apps/i2c_test_apps/main/test_i2c_common.c +++ b/components/esp_driver_i2c/test_apps/i2c_test_apps/main/test_i2c_common.c @@ -146,6 +146,41 @@ TEST_CASE("I2C device add & remove check", "[i2c]") TEST_ESP_OK(i2c_del_master_bus(bus_handle)); } +TEST_CASE("I2C peripheral allocate all", "[i2c]") +{ + i2c_master_bus_handle_t bus_handle[SOC_HP_I2C_NUM]; + for (int i = 0; i < SOC_HP_I2C_NUM; i++) { + i2c_master_bus_config_t i2c_mst_config_1 = { + .clk_source = I2C_CLK_SRC_DEFAULT, + .i2c_port = -1, + .scl_io_num = I2C_MASTER_SCL_IO, + .sda_io_num = I2C_MASTER_SDA_IO, + .flags.enable_internal_pullup = true, + }; + + TEST_ESP_OK(i2c_new_master_bus(&i2c_mst_config_1, &bus_handle[i])); + } + i2c_master_bus_config_t i2c_mst_config_1 = { + .clk_source = I2C_CLK_SRC_DEFAULT, + .i2c_port = -1, + .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_2; + + TEST_ESP_ERR(ESP_ERR_NOT_FOUND, i2c_new_master_bus(&i2c_mst_config_1, &bus_handle_2)); + + for (int i = 0; i < SOC_HP_I2C_NUM; i++) { + TEST_ESP_OK(i2c_del_master_bus(bus_handle[i])); + } + + // Get another one + + TEST_ESP_OK(i2c_new_master_bus(&i2c_mst_config_1, &bus_handle_2)); + TEST_ESP_OK(i2c_del_master_bus(bus_handle_2)); +} + TEST_CASE("I2C master probe device test", "[i2c]") { // 0x22,33,44,55 does not exist on the I2C bus, so it's expected to return `not found` error diff --git a/components/esp_driver_i2c/test_apps/i2c_test_apps/main/test_lp_i2c.c b/components/esp_driver_i2c/test_apps/i2c_test_apps/main/test_lp_i2c.c index c9701e41b7..e17b025993 100644 --- a/components/esp_driver_i2c/test_apps/i2c_test_apps/main/test_lp_i2c.c +++ b/components/esp_driver_i2c/test_apps/i2c_test_apps/main/test_lp_i2c.c @@ -64,6 +64,20 @@ TEST_CASE("LP I2C initialize with wrong IO", "[i2c]") #endif +TEST_CASE("LP I2C initialize with wrong clock source", "[i2c]") +{ + i2c_master_bus_config_t i2c_mst_config = { + .lp_source_clk = I2C_CLK_SRC_DEFAULT, + .i2c_port = LP_I2C_NUM_0, + .scl_io_num = LP_I2C_SCL_IO, + .sda_io_num = LP_I2C_SDA_IO, + .flags.enable_internal_pullup = true, + }; + i2c_master_bus_handle_t bus_handle; + + TEST_ESP_ERR(ESP_ERR_NOT_SUPPORTED, i2c_new_master_bus(&i2c_mst_config, &bus_handle)); +} + static IRAM_ATTR bool test_i2c_rx_done_callback(i2c_slave_dev_handle_t channel, const i2c_slave_rx_done_event_data_t *edata, void *user_data) { BaseType_t high_task_wakeup = pdFALSE; From 5729fd29527ed1f476780e64774019257f8b9c34 Mon Sep 17 00:00:00 2001 From: "C.S.M" Date: Fri, 5 Jul 2024 12:12:32 +0800 Subject: [PATCH 2/5] fix(i2c): Fix lose byte during data reading in i2c master on esp32, Closes https://github.com/espressif/esp-idf/issues/12860 --- components/hal/esp32/include/hal/i2c_ll.h | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/components/hal/esp32/include/hal/i2c_ll.h b/components/hal/esp32/include/hal/i2c_ll.h index 7e5d352337..d5e1acb82e 100644 --- a/components/hal/esp32/include/hal/i2c_ll.h +++ b/components/hal/esp32/include/hal/i2c_ll.h @@ -573,7 +573,9 @@ __attribute__((always_inline)) static inline void i2c_ll_read_rxfifo(i2c_dev_t *hw, uint8_t *ptr, uint8_t len) { for(int i = 0; i < len; i++) { - ptr[i] = HAL_FORCE_READ_U32_REG_FIELD(hw->fifo_data, data); + // Known issue that hardware read fifo will cause data lose, (fifo pointer jump over a random address) + // use `DPORT_REG_READ` can avoid this issue. + ptr[i] = DPORT_REG_READ((uint32_t)&hw->fifo_data); } } From 056f0bdb0eff5aefb8ac8e4b35f8ada752a3fa8c Mon Sep 17 00:00:00 2001 From: "C.S.M" Date: Tue, 17 Dec 2024 11:06:14 +0800 Subject: [PATCH 3/5] fix(i2c_slave): Support 10-bit address on esp32 --- components/hal/esp32/include/hal/i2c_ll.h | 4 ++-- components/soc/esp32/include/soc/Kconfig.soc_caps.in | 4 ++++ components/soc/esp32/include/soc/soc_caps.h | 1 + 3 files changed, 7 insertions(+), 2 deletions(-) diff --git a/components/hal/esp32/include/hal/i2c_ll.h b/components/hal/esp32/include/hal/i2c_ll.h index d5e1acb82e..99a7aa06f0 100644 --- a/components/hal/esp32/include/hal/i2c_ll.h +++ b/components/hal/esp32/include/hal/i2c_ll.h @@ -323,8 +323,8 @@ static inline void i2c_ll_set_slave_addr(i2c_dev_t *hw, uint16_t slave_addr, boo hw->slave_addr.en_10bit = addr_10bit_en; if (addr_10bit_en) { uint16_t addr_14_7 = (slave_addr & 0xff) << 7; - uint8_t addr_6_0 = ((slave_addr & 0x300) >> 8) || 0x78; - hw->slave_addr.addr = addr_14_7 || addr_6_0; + uint8_t addr_6_0 = ((slave_addr & 0x300) >> 8) | 0x78; + hw->slave_addr.addr = addr_14_7 | addr_6_0; } else { hw->slave_addr.addr = slave_addr; } diff --git a/components/soc/esp32/include/soc/Kconfig.soc_caps.in b/components/soc/esp32/include/soc/Kconfig.soc_caps.in index 54613e95c7..bed61353ce 100644 --- a/components/soc/esp32/include/soc/Kconfig.soc_caps.in +++ b/components/soc/esp32/include/soc/Kconfig.soc_caps.in @@ -387,6 +387,10 @@ config SOC_I2C_SUPPORT_APB bool default y +config SOC_I2C_SUPPORT_10BIT_ADDR + bool + default y + config SOC_I2C_STOP_INDEPENDENT bool default y diff --git a/components/soc/esp32/include/soc/soc_caps.h b/components/soc/esp32/include/soc/soc_caps.h index 8b81cff3f2..b06e0669f1 100644 --- a/components/soc/esp32/include/soc/soc_caps.h +++ b/components/soc/esp32/include/soc/soc_caps.h @@ -206,6 +206,7 @@ #define SOC_I2C_SUPPORT_SLAVE (1) #define SOC_I2C_SUPPORT_APB (1) +#define SOC_I2C_SUPPORT_10BIT_ADDR (1) // On ESP32, the stop bit should be independent, we can't put trans data and stop command together #define SOC_I2C_STOP_INDEPENDENT (1) From 385fa9870fc643b230e7215f566756968ece40f5 Mon Sep 17 00:00:00 2001 From: "C.S.M" Date: Wed, 6 Nov 2024 13:52:45 +0800 Subject: [PATCH 4/5] fix(i2c): Add bus handle check so that it will not be panic when there is no free bus, Closes https://github.com/espressif/esp-idf/issues/14819 --- components/esp_driver_i2c/i2c_master.c | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/components/esp_driver_i2c/i2c_master.c b/components/esp_driver_i2c/i2c_master.c index 924eeddb83..4d4f0af8e8 100644 --- a/components/esp_driver_i2c/i2c_master.c +++ b/components/esp_driver_i2c/i2c_master.c @@ -760,7 +760,11 @@ static esp_err_t i2c_master_bus_destroy(i2c_master_bus_handle_t bus_handle) { ESP_RETURN_ON_FALSE(bus_handle, ESP_ERR_INVALID_ARG, TAG, "no memory for i2c master bus"); i2c_master_bus_handle_t i2c_master = bus_handle; - if (i2c_release_bus_handle(i2c_master->base) == ESP_OK) { + esp_err_t err = ESP_OK; + if (i2c_master->base) { + err = i2c_release_bus_handle(i2c_master->base); + } + if (err == ESP_OK) { if (i2c_master) { if (i2c_master->bus_lock_mux) { vSemaphoreDeleteWithCaps(i2c_master->bus_lock_mux); From 09321904dc619d6398fb99b3737fd63cae894eab Mon Sep 17 00:00:00 2001 From: "C.S.M" Date: Tue, 31 Dec 2024 15:35:59 +0800 Subject: [PATCH 5/5] docs(i2c): Add type declaration in i2c docs, Closes https://github.com/espressif/esp-idf/issues/15086 --- docs/en/api-reference/peripherals/i2c.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/en/api-reference/peripherals/i2c.rst b/docs/en/api-reference/peripherals/i2c.rst index b7b14ae40c..b2d96756ea 100644 --- a/docs/en/api-reference/peripherals/i2c.rst +++ b/docs/en/api-reference/peripherals/i2c.rst @@ -451,7 +451,7 @@ Whenever the master writes data to the slave, the slave will automatically store i2c_slave_dev_handle_t slave_handle; ESP_ERROR_CHECK(i2c_new_slave_device(&i2c_slv_config, &slave_handle)); - s_receive_queue = xQueueCreate(1, sizeof(i2c_slave_rx_done_event_data_t)); + QueueHandle_t s_receive_queue = xQueueCreate(1, sizeof(i2c_slave_rx_done_event_data_t)); i2c_slave_event_callbacks_t cbs = { .on_recv_done = i2c_slave_rx_done_callback, };