i2c_driver_api Struct Reference

@driver_ops{I2C} More...

#include <i2c.h>

Data Fields
i2c_api_configure_t	configure
	@driver_ops_mandatory Configure operation of a host controller.
i2c_api_get_config_t	get_config
	@driver_ops_optional Get configuration of a host controller.
i2c_api_full_io_t	transfer
	@driver_ops_mandatory Perform data transfer to another I2C device in controller mode.
i2c_api_target_register_t	target_register
	@driver_ops_optional Registers the provided config as Target device of a controller.
i2c_api_target_unregister_t	target_unregister
	@driver_ops_optional Unregisters the provided config as Target device.
i2c_api_transfer_cb_t	transfer_cb
	@driver_ops_optional Perform data transfer to another I2C device in controller mode.
i2c_api_iodev_submit	iodev_submit
	@driver_ops_optional Submit request(s) to an I2C device with RTIO.
i2c_api_recover_bus_t	recover_bus
	@driver_ops_optional Recover the I2C bus.

Detailed Description

@driver_ops{I2C}

Field Documentation

configure

i2c_api_configure_t i2c_driver_api::configure

@driver_ops_mandatory Configure operation of a host controller.

get_config

i2c_api_get_config_t i2c_driver_api::get_config

@driver_ops_optional Get configuration of a host controller.

iodev_submit

i2c_api_iodev_submit i2c_driver_api::iodev_submit

@driver_ops_optional Submit request(s) to an I2C device with RTIO.

Attention

Available only when the following Kconfig option is enabled:

CONFIG_I2C_RTIO 

.

recover_bus

i2c_api_recover_bus_t i2c_driver_api::recover_bus

@driver_ops_optional Recover the I2C bus.

target_register

i2c_api_target_register_t i2c_driver_api::target_register

@driver_ops_optional Registers the provided config as Target device of a controller.

target_unregister

i2c_api_target_unregister_t i2c_driver_api::target_unregister

@driver_ops_optional Unregisters the provided config as Target device.

transfer

i2c_api_full_io_t i2c_driver_api::transfer

@driver_ops_mandatory Perform data transfer to another I2C device in controller mode.

transfer_cb

i2c_api_transfer_cb_t i2c_driver_api::transfer_cb

@driver_ops_optional Perform data transfer to another I2C device in controller mode.

Attention

Available only when the following Kconfig option is enabled:

CONFIG_I2C_CALLBACK 

.

---

The documentation for this struct was generated from the following file:

• include/zephyr/drivers/i2c.h