mcp23017: fatal error: i2c_bus.h: no such file or directory (AEGHB-1192)

[stkw0]

Answers checklist.

• I have read the documentation ESP-IDF Programming Guide and the issue is not addressed there.
• I have updated my IDF branch (master or release) to the latest version and checked that the issue is present there.
• I have searched the issue tracker for a similar issue and not found a similar issue.

IDF version.

v5.5.0

Espressif SoC revision.

ESP32-P4 (revision v1.0)

Operating System used.

Linux

How did you build your project?

Command line with idf.py

If you are using Windows, please specify command line type.

None

Development Kit.

Olimex ESP32-P4-DevKit

Steps to reproduce.

1. copy get-started/hello_world project
2. idf add-dependency mcp23017
3. modify hello_world_main.c and add #include "mcp23017.h"
4. idf build

Build Logs.

/tmp/hello_world/managed_components/espressif__mcp23017/include/mcp23017.h:10:10: fatal error: i2c_bus.h: No such file or directory
   10 | #include "i2c_bus.h"
      |          ^~~~~~~~~~~

More Information.

Seems that mcp23017 component uses the removed i2c driver instead of the new one. I think it should be ported to use the driver/i2c_master.h

[YanKE01]

Hi, @stkw0 .Please check whether the managed_components directory in your project contains i2c_bus. In theory, the i2c_bus component should be pulled into the managed_components directory together with the mcp23017 component. Alternatively, the most effective way is to re-run idf.py set-target esp32p4.

[stkw0]

Yes. This is the output of tree -L2 -I build:

.
├── CMakeLists.txt
├── README.md
├── dependencies.lock
├── main
│   ├── CMakeLists.txt
│   ├── hello_world_main.c
│   └── idf_component.yml
├── managed_components
│   ├── espressif__cmake_utilities
│   ├── espressif__i2c_bus
│   └── espressif__mcp23017
├── pytest_hello_world.py
├── sdkconfig
└── sdkconfig.ci

I run the set-target command and run build again and realized a warning. about i2c_bus being on PRIV_REQUIRES and not REQUIRES.
In file included from /tmp/hello_world/main/hello_world_main.c:15:

/tmp/hello_world/managed_components/espressif__mcp23017/include/mcp23017.h:10:10: fatal error: i2c_bus.h: No such file or directory
   10 | #include "i2c_bus.h"
      |          ^~~~~~~~~~~
compilation terminated.
....
ninja: build stopped: subcommand failed.
Compilation failed because mcp23017.h (in "espressif__mcp23017" component) includes i2c_bus.h, provided by espressif__i2c_bus component(s).
However, espressif__i2c_bus component(s) is in the private requirements list of "espressif__mcp23017".
To fix this, move espressif__i2c_bus from PRIV_REQUIRES into REQUIRES list of idf_component_register call in /tmp/hello_world/managed_components/espressif__mcp23017/CMakeLists.txt.

A part from the build issue, I am worried that, given our project uses the newer I2C driver to communicate with an sht3x chip, we would not be able to use mcp23017 (or we would need to switch to the deprecated driver.) The mcp23017 component will expect a i2c_bus_handle_t type but the new driver uses i2c_master_bus_handle_t which I guess are incompatible.

[YanKE01]

The dependency issue is that mcp23017 depends on i2c_bus, but it was not explicitly declared as public, so it defaulted to a private dependency. This issue will be fixed soon.

If your project has already registered the I2C port using esp_driver_i2c, then the current i2c_bus will automatically attach to the internally initialized I2C bus, and there will be no conflict.

Conversely, if you initialized the I2C bus using i2c_bus, you can still obtain the internally initialized bus handle by calling i2c_bus_get_internal_bus_handle.

[stkw0]

That means I can cast an i2c_master_bus_handle_t to i2c_bus_handle_t and call to mcp23017_create like this:

i2c_master_bus_handle_t bus;
i2c_new_master_bus(&cfg, &bus); // using newer i2c_master.h

mcp23017_create( (i2c_bus_handle_t) bus, 0x21);

and should work?

I tried and it end up with

E (437) i2c_bus: ./managed_components/espressif__i2c_bus/i2c_bus_v2.c:150 (i2c_bus_device_create):i2c_bus has not inited
E (437) mcp23017: ./managed_components/espressif__mcp23017/mcp23017.c:366 (mcp23017_check_present):invalid arg

[YanKE01]

You only need to call i2c_bus_create directly on the already initialized I2C_PORT_NUM. Inside, i2c_bus_create will directly obtain the handle created by i2c_new_master_bus. Note that you need to use i2c_bus version 1.3.0 or above.

    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);