# I3C
Source: [https://docs.qualcomm.com/doc/80-70014-8/topic/i3c.html](https://docs.qualcomm.com/doc/80-70014-8/topic/i3c.html)
The improved interintegrated circuit (I3C) interface has been developed to provide a
fast, low-cost, low-power, 2-wire digital interface for connected I3C target devices.
The I3C interface is intended to improve upon the features of the I2C interface,
preserving backward compatibility. The 2-wire serial interface supports up to 12.5 MHz.
Legacy I2C devices co-exist on the same bus. The I3C bus supports the in Band support
and hot join supported. Synchronous timing support and asynchronous time stamping.
During the write operation, the transition bit is of 8‑bit data parity. During read, the
controller uses the transition bit to either proceed with the next data or abort the
read. The address followed by the START condition is open-drain (Arbitration phase). The
address followed by a repeated START condition is push-pull. The data phase can be
either push-pull or open-drain, based on the I3C capability of the target device (for
mixed bus, the I3C controller can address the I2C target). The following figure
illustrates the I3C hardware and software entities.
Figure : I3C block diagram
The main features of the I3C architecture are as follows:
- I3C controller driver software – software-privileged entity, capable of
enumeration and bus configuration.
- I3C client software – software entities that use the I3C bus for read/write to
devices.
### I3C packet frame structure
A frame begins with START, command (8), data (8), transition (1), and STOP.
Where,
- ACK: Acknowledge (SDA low)
- S: Start condition
- Sr: Repeat start condition
- P: Stop condition
- T: Transition bit alternative to ACK/NACK
### I3C bus initialization
The I3C bus initialization procedure is as follows:
1. The I3C controller driver software initializes the I3C controller (firmware
and configuration settings).
2. The I3C controller driver software reads the I3C configuration and the
device database, including:
- List of I2C, static address devices.
- List of I3C, static address devices.
- List of expected I3C dynamic devices: vendor ID, device ID,
predefined dynamic address, and associated drivers.
- Optional hot-join allowed devices (vendor ID, device ID, and
predefined address).
3. Using the I3C controller software, the driver enumerates the devices on the
bus (set local addresses).
4. The I3C controller driver software writes an I3C controller with the
required devices and the bus characteristic information:
- Operation frequency
- Pure/legacy I2C mode
- SDR/HDR enable/disable (and types)
- IBI capable devices and expected data bytes
5. The I3C client software stack receives the following information about the
I3C configuration and device database.
- List of I2C, static address devices.
- List of I3C, static address devices.
- List of expected I3C dynamic devices: vendor ID, device ID,
predefined dynamic address, and associated drivers.
- Optional hot-join allowed devices (vendor ID, device ID, and
predefined address).
## I3C features
Source: [https://docs.qualcomm.com/doc/80-70014-8/topic/i3c.html](https://docs.qualcomm.com/doc/80-70014-8/topic/i3c.html)
The aDSP/SDC I3C subsystem supports the following features.
- Address phase at frequency 400 kHz.
- Data phase at frequency 12,500 kHz.
- Backward compatibility with legacy I2C.
- Dynamic addressing of targets.
- Single data rate (SDR) mode.
- CCC commands as per the MIPI I3C specification
## I3C interface
Source: [https://docs.qualcomm.com/doc/80-70014-8/topic/i3c.html](https://docs.qualcomm.com/doc/80-70014-8/topic/i3c.html)
I3C use cases in the aDSP/SLPI software support sensor target device communication.
Note: I3C does not support Linux use cases.
The software
driver and the configuration support for the I3C functionality for target communication
are listed in the following table.
Table : aDSP/SLPI/SDC target communication
| File type | Description |
| --- | --- |
| QUP v3 serial engine configuration | For QUP v3 serial engine configuration settings in the aDSP subsystem
to enable the I3C interface, see the following file paths.
- /firmware/qualcomm-linux-spf-1-0_ap_standard_oem_nomodem/ADSP.HT.5.5.c8/adsp_proc/core/settings/buses/qup_common/config/<chipset>/adsp/ssc/qup_devcfg.c
- /firmware/qualcomm-linux-spf-1-0_ap_standard_oem_nomodem/ADSP.HT.5.5.c8/adsp_proc/core/settings/buses/qup_fw/config/<chipset>/fw_devcfg.c
- /firmware/qualcomm-linux-spf-1-0_ap_standard_oem_nomodem/ADSP.HT.5.5.c8/adsp_proc/core/settings/buses/qup_common/config/<chipset>/adsp/ssc/qup_devcfg.json
|
| Firmware configuration settings | For QUP v3 serial engine firmware settings to configure I3C in aDSP
software, see the following files.
- /firmware/qualcomm-linux-spf-1-0_ap_standard_oem_nomodem/ADSP.HT.5.5.c8/adsp_proc/core/settings/buses/qup_fw/config/<chipset>/fw_devcfg.c
- /firmware/qualcomm-linux-spf-1-0_ap_standard_oem_nomodem/ADSP.HT.5.5.c8/adsp_proc/core/settings/buses/qup_fw/config/<chipset>/fw_devcfg.xml
|
| Public APIs | For I3C software APIs and information on usage, see the following
header files.
- api/buses/i2c_api.h
- api/buses/qup_common.h
|
## I3C software
Source: [https://docs.qualcomm.com/doc/80-70014-8/topic/i3c.html](https://docs.qualcomm.com/doc/80-70014-8/topic/i3c.html)
The I3C firmware for the QUP v3 serial engine is loaded with SSC QUP during the bootup
sequence. The configuration file is present in the aDSP build. The source code path to
enable the I3C configuration for a specific QUP v3 serial engine instance is at /firmware/qualcomm-linux-spf-1-0\_ap\_standard\_oem\_nomodem/ADSP.HT.5.5.c8/adsp\_proc/core/settings/buses/qup\_fw/config/<chipset>/fw\_devcfg.c
and /firmware/qualcomm-linux-spf-1-0\_ap\_standard\_oem\_nomodem/ADSP.HT.5.5.c8/adsp\_proc/core/settings/buses/qup\_fw/config/<chipset>/fw\_devcfg.xml.
Sample of SSC QUP SE0 or SE1 loaded with the I3C firmware.
se_cfg se0_cfg = { 0x80000, SE_PROTOCOL_I3C, GSI, TRUE, TRUE };
se_cfg se1_cfg = { 0x84000, SE_PROTOCOL_I3C, GSI, TRUE, TRUE };Copy to clipboard
**GPIO configuration**: Each serial engine in the QUP common driver is configured with
the default GPIO configuration per protocol in the chipset-specific configurations. The
GPIO configuration is picked up by the QUP common driver as per the protocol loaded in
the serial engine. The source code path for the GPIO configuration of a specific I3C
serial engine instance is /firmware/qualcomm-linux-spf-1-0\_ap\_standard\_oem\_nomodem/ADSP.HT.5.5.c8/adsp\_proc/core/settings/buses/qup\_common/config/<chipset>/adsp/ssc/qup\_instance\_mapping.c.
The default GPIO configuration can be overwritten as follows:
{ .instance_id = 1 , //Instance ID
.qup = QUP_SSC, //QUP Type
.se_index = 0, //SE ID
.se_data = NULL, //devcfg_map
.protocol_io_cfg = {
TLMM_MAP(TLMM_GPIO_KEEPER ,TLMM_GPIO_2MA,TLMM_GPIO_KEEPER ), // SLEEP CFG
TLMM_MAP(TLMM_GPIO_NO_PULL,TLMM_GPIO_6MA,TLMM_GPIO_KEEPER ), //SPI CFG
TLMM_MAP(TLMM_GPIO_NO_PULL,TLMM_GPIO_2MA,TLMM_GPIO_NO_PULL), // UART CFG
TLMM_MAP(TLMM_GPIO_PULL_UP,TLMM_GPIO_2MA,TLMM_GPIO_NO_PULL), //I2C CFG
TLMM_MAP(TLMM_GPIO_PULL_UP,TLMM_GPIO_2MA,TLMM_GPIO_KEEPER ) //I3C CFG
},
.se_exclusive = TRUE,
}
Copy to clipboard
TLMM\_MAP is a macro to initialize the active and sleep state GPIO configurations. For
example, a sample usage of the TLMM\_MAP macro is as
follows:
TLMM_MAP (active state pull type, drive strength, sleep state pull type)Copy to clipboard
Last Published: Jul 13, 2024
[Previous Topic
I2C](https://docs.qualcomm.com/bundle/publicresource/80-70014-8/topics/i2c.md) [Next Topic
PCIe](https://docs.qualcomm.com/bundle/publicresource/80-70014-8/topics/pcie.md)