I2C¶

Overview¶

Note

Zephyr recognizes the need to change the terms “master” and “slave” used in the current I2C Specification. This will be done when the conditions identified in Rule A.2: Inclusive Language have been met. Existing documentation, data structures, functions, and value symbols in code are likely to change at that point.

I2C (Inter-Integrated Circuit, pronounced “eye squared see”) is a commonly-used two-signal shared peripheral interface bus. Many system-on-chip solutions provide controllers that communicate on an I2C bus. Devices on the bus can operate in two roles: as a “master” that initiates transactions and controls the clock, or as a “slave” that responds to transaction commands. A I2C controller on a given SoC will generally support the master role, and some will also support the slave mode. Zephyr has API for both roles.

I2C Master API¶

Zephyr’s I2C master API is used when an I2C peripheral controls the bus, in particularly the start and stop conditions and the clock. This is the most common mode, used to interact with I2C devices like sensors and serial memory.

This API is supported in all in-tree I2C peripheral drivers and is considered stable.

I2C Slave API¶

Zephyr’s I2C slave API is used when an I2C peripheral responds to transactions initiated by a different controller on the bus. It might be used for a Zephyr application with transducer roles that are controlled by another device such as a host processor.

This API is supported in very few in-tree I2C peripheral drivers. The API is considered experimental, as it is not compatible with the capabilities of all I2C peripherals supported in master mode.

Configuration Options¶

Related configuration options:

CONFIG_I2C

API Reference¶

group i2c_interface

I2C Interface.

Defines

I2C_SPEED_STANDARD¶: I2C Standard Speed: 100 kHz

I2C_SPEED_FAST¶: I2C Fast Speed: 400 kHz

I2C_SPEED_FAST_PLUS¶: I2C Fast Plus Speed: 1 MHz

I2C_SPEED_HIGH¶: I2C High Speed: 3.4 MHz

I2C_SPEED_ULTRA¶: I2C Ultra Fast Speed: 5 MHz

I2C_SPEED_SHIFT¶

I2C_SPEED_SET(speed)¶

I2C_SPEED_MASK¶

I2C_SPEED_GET(cfg)¶

I2C_ADDR_10_BITS¶: Use 10-bit addressing. DEPRECATED - Use I2C_MSG_ADDR_10_BITS instead.

I2C_MODE_MASTER¶: Controller to act as Master.

I2C_MSG_WRITE¶: Write message to I2C bus.

I2C_MSG_READ¶: Read message from I2C bus.

I2C_MSG_STOP¶: Send STOP after this message.

I2C_MSG_RESTART¶: RESTART I2C transaction for this message.

Note

Not all I2C drivers have or require explicit support for this feature. Some drivers require this be present on a read message that follows a write, or vice-versa. Some drivers will merge adjacent fragments into a single transaction using this flag; some will not.

I2C_MSG_ADDR_10_BITS¶: Use 10-bit addressing for this message.

Note

Not all SoC I2C implementations support this feature.

I2C_SLAVE_FLAGS_ADDR_10_BITS¶: Slave device responds to 10-bit addressing.

I2C_DECLARE_CLIENT_CONFIG¶

I2C_CLIENT(_master, _addr)¶

I2C_GET_MASTER(_conf)¶

I2C_GET_ADDR(_conf)¶

Typedefs

typedef int (*i2c_slave_write_requested_cb_t)(struct i2c_slave_config *config)¶

Function called when a write to the device is initiated.

This function is invoked by the controller when the bus completes a start condition for a write operation to the address associated with a particular device.

A success return shall cause the controller to ACK the next byte received. An error return shall cause the controller to NACK the next byte received.

Parameters

config – the configuration structure associated with the device to which the operation is addressed.

Returns

0 if the write is accepted, or a negative error code.

typedef int (*i2c_slave_write_received_cb_t)(struct i2c_slave_config *config, uint8_t val)¶

Function called when a write to the device is continued.

This function is invoked by the controller when it completes reception of a byte of data in an ongoing write operation to the device.

A success return shall cause the controller to ACK the next byte received. An error return shall cause the controller to NACK the next byte received.

Parameters

config – the configuration structure associated with the device to which the operation is addressed.
val – the byte received by the controller.

Returns

0 if more data can be accepted, or a negative error code.

typedef int (*i2c_slave_read_requested_cb_t)(struct i2c_slave_config *config, uint8_t *val)¶

Function called when a read from the device is initiated.

This function is invoked by the controller when the bus completes a start condition for a read operation from the address associated with a particular device.

The value returned in *val will be transmitted. A success return shall cause the controller to react to additional read operations. An error return shall cause the controller to ignore bus operations until a new start condition is received.

Parameters

config – the configuration structure associated with the device to which the operation is addressed.
val – pointer to storage for the first byte of data to return for the read request.

Returns

0 if more data can be requested, or a negative error code.

typedef int (*i2c_slave_read_processed_cb_t)(struct i2c_slave_config *config, uint8_t *val)¶

Function called when a read from the device is continued.

This function is invoked by the controller when the bus is ready to provide additional data for a read operation from the address associated with the device device.

The value returned in *val will be transmitted. A success return shall cause the controller to react to additional read operations. An error return shall cause the controller to ignore bus operations until a new start condition is received.

Parameters

config – the configuration structure associated with the device to which the operation is addressed.
val – pointer to storage for the next byte of data to return for the read request.

Returns

0 if data has been provided, or a negative error code.

typedef int (*i2c_slave_stop_cb_t)(struct i2c_slave_config *config)¶

Function called when a stop condition is observed after a start condition addressed to a particular device.

This function is invoked by the controller when the bus is ready to provide additional data for a read operation from the address associated with the device device. After the function returns the controller shall enter a state where it is ready to react to new start conditions.

Parameters

config – the configuration structure associated with the device to which the operation is addressed.

Returns

Ignored.

Functions

int i2c_configure(const struct device *dev, uint32_t dev_config)¶

Configure operation of a host controller.

Parameters

dev – Pointer to the device structure for the driver instance.
dev_config – Bit-packed 32-bit value to the device runtime configuration for the I2C controller.

Returns 0

If successful.

Returns -EIO

General input / output error, failed to configure device.

int i2c_transfer(const struct device *dev, struct i2c_msg *msgs, uint8_t num_msgs, uint16_t addr)¶

Perform data transfer to another I2C device in master mode.

This routine provides a generic interface to perform data transfer to another I2C device synchronously. Use i2c_read()/i2c_write() for simple read or write.

The array of message msgs must not be NULL. The number of message num_msgs may be zero,in which case no transfer occurs.

Note

Not all scatter/gather transactions can be supported by all drivers. As an example, a gather write (multiple consecutive i2c_msg buffers all configured for I2C_MSG_WRITE) may be packed into a single transaction by some drivers, but others may emit each fragment as a distinct write transaction, which will not produce the same behavior. See the documentation of struct i2c_msg for limitations on support for multi-message bus transactions.

Parameters

dev – Pointer to the device structure for an I2C controller driver configured in master mode.
msgs – Array of messages to transfer.
num_msgs – Number of messages to transfer.
addr – Address of the I2C target device.

Returns 0

If successful.

Returns -EIO

General input / output error.

int i2c_recover_bus(const struct device *dev)¶

Recover the I2C bus.

Attempt to recover the I2C bus.

Parameters

dev – Pointer to the device structure for an I2C controller driver configured in master mode.

Returns 0

If successful

Returns -EBUSY

If bus is not clear after recovery attempt.

Returns -EIO

General input / output error.

Returns -ENOSYS

If bus recovery is not implemented

static inline int i2c_slave_register(const struct device *dev, struct i2c_slave_config *cfg)¶

Registers the provided config as Slave device of a controller.

Enable I2C slave mode for the ‘dev’ I2C bus driver using the provided ‘config’ struct containing the functions and parameters to send bus events. The I2C slave will be registered at the address provided as ‘address’ struct member. Addressing mode - 7 or 10 bit - depends on the ‘flags’ struct member. Any I2C bus events related to the slave mode will be passed onto I2C slave device driver via a set of callback functions provided in the ‘callbacks’ struct member.

Most of the existing hardware allows simultaneous support for master and slave mode. This is however not guaranteed.

Parameters

dev – Pointer to the device structure for an I2C controller driver configured in slave mode.
cfg – Config struct with functions and parameters used by the I2C driver to send bus events

Returns 0

Is successful

Returns -EINVAL

If parameters are invalid

Returns -EIO

General input / output error.

Returns -ENOSYS

If slave mode is not implemented

static inline int i2c_slave_unregister(const struct device *dev, struct i2c_slave_config *cfg)¶

Unregisters the provided config as Slave device.

This routine disables I2C slave mode for the ‘dev’ I2C bus driver using the provided ‘config’ struct containing the functions and parameters to send bus events.

Parameters

dev – Pointer to the device structure for an I2C controller driver configured in slave mode.
cfg – Config struct with functions and parameters used by the I2C driver to send bus events

Returns 0

Is successful

Returns -EINVAL

If parameters are invalid

Returns -ENOSYS

If slave mode is not implemented

int i2c_slave_driver_register(const struct device *dev)¶

Instructs the I2C Slave device to register itself to the I2C Controller.

This routine instructs the I2C Slave device to register itself to the I2C Controller via its parent controller’s i2c_slave_register() API.

Parameters

dev – Pointer to the device structure for the I2C slave device (not itself an I2C controller).

Returns 0

Is successful

Returns -EINVAL

If parameters are invalid

Returns -EIO

General input / output error.

int i2c_slave_driver_unregister(const struct device *dev)¶

Instructs the I2C Slave device to unregister itself from the I2C Controller.

This routine instructs the I2C Slave device to unregister itself from the I2C Controller via its parent controller’s i2c_slave_register() API.

Parameters

dev – Pointer to the device structure for the I2C slave device (not itself an I2C controller).

Returns 0

Is successful

Returns -EINVAL

If parameters are invalid

static inline int i2c_write(const struct device *dev, const uint8_t *buf, uint32_t num_bytes, uint16_t addr)¶

Write a set amount of data to an I2C device.

This routine writes a set amount of data synchronously.

Parameters

dev – Pointer to the device structure for an I2C controller driver configured in master mode.
buf – Memory pool from which the data is transferred.
num_bytes – Number of bytes to write.
addr – Address to the target I2C device for writing.

Returns 0

If successful.

Returns -EIO

General input / output error.

static inline int i2c_read(const struct device *dev, uint8_t *buf, uint32_t num_bytes, uint16_t addr)¶

Read a set amount of data from an I2C device.

This routine reads a set amount of data synchronously.

Parameters

dev – Pointer to the device structure for an I2C controller driver configured in master mode.
buf – Memory pool that stores the retrieved data.
num_bytes – Number of bytes to read.
addr – Address of the I2C device being read.

Returns 0

If successful.

Returns -EIO

General input / output error.

static inline int i2c_write_read(const struct device *dev, uint16_t addr, const void *write_buf, size_t num_write, void *read_buf, size_t num_read)¶

Write then read data from an I2C device.

This supports the common operation “this is what I want”, “now give

it to me” transaction pair through a combined write-then-read bus transaction.

Parameters

dev – Pointer to the device structure for an I2C controller driver configured in master mode.
addr – Address of the I2C device
write_buf – Pointer to the data to be written
num_write – Number of bytes to write
read_buf – Pointer to storage for read data
num_read – Number of bytes to read

Returns 0

if successful

Returns negative

on error.

static inline int i2c_burst_read(const struct device *dev, uint16_t dev_addr, uint8_t start_addr, uint8_t *buf, uint32_t num_bytes)¶

Read multiple bytes from an internal address of an I2C device.

This routine reads multiple bytes from an internal address of an I2C device synchronously.

Instances of this may be replaced by i2c_write_read().

Parameters

dev – Pointer to the device structure for an I2C controller driver configured in master mode.
dev_addr – Address of the I2C device for reading.
start_addr – Internal address from which the data is being read.
buf – Memory pool that stores the retrieved data.
num_bytes – Number of bytes being read.

Returns 0

If successful.

Returns -EIO

General input / output error.

static inline int i2c_burst_write(const struct device *dev, uint16_t dev_addr, uint8_t start_addr, const uint8_t *buf, uint32_t num_bytes)¶

Write multiple bytes to an internal address of an I2C device.

This routine writes multiple bytes to an internal address of an I2C device synchronously.

Warning

The combined write synthesized by this API may not be supported on all I2C devices. Uses of this API may be made more portable by replacing them with calls to i2c_write() passing a buffer containing the combined address and data.

Parameters

dev – Pointer to the device structure for an I2C controller driver configured in master mode.
dev_addr – Address of the I2C device for writing.
start_addr – Internal address to which the data is being written.
buf – Memory pool from which the data is transferred.
num_bytes – Number of bytes being written.

Returns 0

If successful.

Returns -EIO

General input / output error.

static inline int i2c_reg_read_byte(const struct device *dev, uint16_t dev_addr, uint8_t reg_addr, uint8_t *value)¶

Read internal register of an I2C device.

This routine reads the value of an 8-bit internal register of an I2C device synchronously.

Parameters

dev – Pointer to the device structure for an I2C controller driver configured in master mode.
dev_addr – Address of the I2C device for reading.
reg_addr – Address of the internal register being read.
value – Memory pool that stores the retrieved register value.

Returns 0

If successful.

Returns -EIO

General input / output error.

static inline int i2c_reg_write_byte(const struct device *dev, uint16_t dev_addr, uint8_t reg_addr, uint8_t value)¶

Write internal register of an I2C device.

This routine writes a value to an 8-bit internal register of an I2C device synchronously.

Note

This function internally combines the register and value into a single bus transaction.

Parameters

dev – Pointer to the device structure for an I2C controller driver configured in master mode.
dev_addr – Address of the I2C device for writing.
reg_addr – Address of the internal register being written.
value – Value to be written to internal register.

Returns 0

If successful.

Returns -EIO

General input / output error.

static inline int i2c_reg_update_byte(const struct device *dev, uint8_t dev_addr, uint8_t reg_addr, uint8_t mask, uint8_t value)¶

Update internal register of an I2C device.

This routine updates the value of a set of bits from an 8-bit internal register of an I2C device synchronously.

Note

If the calculated new register value matches the value that was read this function will not generate a write operation.

Parameters

dev – Pointer to the device structure for an I2C controller driver configured in master mode.
dev_addr – Address of the I2C device for updating.
reg_addr – Address of the internal register being updated.
mask – Bitmask for updating internal register.
value – Value for updating internal register.

Returns 0

If successful.

Returns -EIO

General input / output error.

void i2c_dump_msgs(const char *name, const struct i2c_msg *msgs, uint8_t num_msgs, uint16_t addr)¶

Dump out an I2C message.

Dumps out a list of I2C messages. For any that are writes (W), the data is displayed in hex.

It looks something like this (with name “testing”):

D: I2C msg: testing, addr=56 D: W len=01: D: contents: D: 06 |. D: W len=0e: D: contents: D: 00 01 02 03 04 05 06 07 |…….. D: 08 09 0a 0b 0c 0d |……

Parameters

name – Name of this dump, displayed at the top.
msgs – Array of messages to dump.
num_msgs – Number of messages to dump.
addr – Address of the I2C target device.

struct i2c_msg¶

#include <i2c.h>

One I2C Message.

This defines one I2C message to transact on the I2C bus.

Note

Some of the configurations supported by this API may not be supported by specific SoC I2C hardware implementations, in particular features related to bus transactions intended to read or write data from different buffers within a single transaction. Invocations of i2c_transfer() may not indicate an error when an unsupported configuration is encountered. In some cases drivers will generate separate transactions for each message fragment, with or without presence of I2C_MSG_RESTART in flags.

Public Members

uint8_t *buf¶: Data buffer in bytes

uint32_t len¶: Length of buffer in bytes

uint8_t flags¶: Flags for this message

struct i2c_slave_callbacks¶

#include <i2c.h>

Structure providing callbacks to be implemented for devices that supports the I2C slave API.

This structure may be shared by multiple devices that implement the same API at different addresses on the bus.

struct i2c_slave_config¶

#include <i2c.h>

Structure describing a device that supports the I2C slave API.

Instances of this are passed to the i2c_slave_register() and i2c_slave_unregister() functions to indicate addition and removal of a slave device, respective.

Fields other than node must be initialized by the module that implements the device behavior prior to passing the object reference to i2c_slave_register().

Public Members

sys_snode_t node¶: Private, do not modify

uint8_t flags¶: Flags for the slave device defined by I2C_SLAVE_FLAGS_* constants

uint16_t address¶: Address for this slave device

const struct i2c_slave_callbacks *callbacks¶: Callback functions

struct i2c_client_config¶: #include <i2c.h>