i2c_driver_install() function

Install an I2C driver

Syntax

Show:

Summary

Declaration

Definition

from i2c.h:107

esp_err_t i2c_driver_install(i2c_port_t i2c_num, i2c_mode_t mode, size_t slv_rx_buf_len, size_t slv_tx_buf_len, int intr_alloc_flags);

Implemented in i2c.c:296

Arguments

Argument

Description

i2c_num

I2C port number

mode

I2C mode (either master or slave).

slv_rx_buf_len

Receiving buffer size. Only slave mode will use this value, it is ignored in master mode.

slv_tx_buf_len

Sending buffer size. Only slave mode will use this value, it is ignored in master mode.

intr_alloc_flags

Flags used to allocate the interrupt. One or multiple (ORred) ESP_INTR_FLAG_* values. See esp_intr_alloc.h for more info.

Return value

- ESP_OK Success - ESP_ERR_INVALID_ARG Parameter error - ESP_FAIL Driver installation error

Notes

Not all Espressif chips can support slave mode (e.g. ESP32C2) In master mode, if the cache is likely to be disabled(such as write flash) and the slave is time-sensitive, `ESP_INTR_FLAG_IRAM` is suggested to be used. In this case, please use the memory allocated from internal RAM in i2c read and write function, because we can not access the psram(if psram is enabled) in interrupt handle function when cache is disabled.

Examples

i2c_driver_install() is referenced by 8 libraries and example projects:

References

from examples

i2c_driver_install() function

Syntax

Arguments

Return value

Notes

Examples

References

Call Tree

Data Use

Class Tree

Override Tree

Implementations

Instances

Lifecycle