1# I3C<a name="1"></a> 2 3## 概述<a name="section1"></a> 4 5### 功能简介<a name="section2"></a> 6 7I3C（Improved Inter Integrated Circuit）总线是由MIPI Alliance开发的一种简单、低成本的双向二线制同步串行总线。 8 9I3C是两线双向串行总线，针对多个传感器从设备进行了优化，并且一次只能由一个I3C主设备控制。相比于I2C，I3C总线拥有更高的速度、更低的功耗，支持带内中断、从设备热接入以及切换当前主设备，同时向后兼容I2C从设备。I3C增加了带内中断（In-Bind Interrupt）功能，支持I3C设备进行热接入操作，弥补了I2C总线需要额外增加中断线来完成中断的不足。I3C总线上允许同时存在I2C设备、I3C从设备和I3C次级主设备。 10 11I3C接口定义了完成I3C传输的通用方法集合，包括： 12- I3C控制器管理：打开或关闭I3C控制器。 13- I3C控制器配置：获取或配置I3C控制器参数。 14- I3C消息传输：通过消息传输结构体数组进行自定义传输。 15- I3C带内中断：请求或释放带内中断。 16 17### 基本概念<a name="section3"></a> 18 19- IBI（In-Band Interrupt）<br> 20 带内中断。在SCL线没有启动信号时，I3C从设备可以通过拉低SDA线使主设备发出SCL启动信号，从而发出带内中断请求。若有多个从机同时发出中断请求，I3C主机则通过从机地址进行仲裁，低地址优先相应。 21 22- DAA（Dynamic Address Assignment）<br> 23 动态地址分配。I3C支持对从设备地址进行动态分配从而避免地址冲突。在分配动态地址之前，连接到I3C总线上的每个I3C设备都应以两种方式之一来唯一标识： 24 1）设备可能有一个符合I2C规范的静态地址，主机可以使用此静态地址； 25 2）在任何情况下，设备均应具有48位的临时ID。 除非设备具有静态地址且主机使用静态地址，否则主机应使用此48位临时ID。 26 27- CCC（Common Command Code）<br> 28 通用命令代码，所有I3C设备均支持CCC，可以直接将其传输到特定的I3C从设备，也可以同时传输到所有I3C从设备。 29 30- BCR（Bus Characteristic Register）<br> 31 总线特性寄存器，每个连接到 I3C 总线的 I3C 设备都应具有相关的只读总线特性寄存器 （BCR），该寄存器描述了I3C兼容设备在动态地址分配和通用命令代码中的作用和功能。 32 33- DCR（Device Characteristic Register）<br> 34 设备特性寄存器，连接到 I3C 总线的每个 I3C 设备都应具有相关的只读设备特性寄存器 (DCR)。 该寄存器描述了用于动态地址分配和通用命令代码的 I3C 兼容设备类型（例如，加速度计、陀螺仪等）。 35 36### 运作机制<a name="section4"></a> 37 38在HDF框架中，I3C模块接口适配模式采用统一服务模式，这需要一个设备服务来作为I3C模块的管理器，统一处理外部访问，这会在配置文件中有所体现。统一服务模式适合于同类型设备对象较多的情况，如I3C可能同时具备十几个控制器，采用独立服务模式需要配置更多的设备节点，且服务会占据内存资源。相反，采用统一服务模式可以使用一个设备服务作为管理器，统一处理所有同类型对象的外部访问（这会在配置文件中有所体现），实现便捷管理和节约资源的目的。 39 40 相比于I2C，I3C总线拥有更高的速度、更低的功耗，支持带内中断、从设备热接入以及切换当前主设备，同时向后兼容I2C从设备。一路I3C总线上，可以连接多个设备，这些设备可以是I2C从设备、I3C从设备和I3C次级主设备，但只能同时存在一个主设备，一般为控制器本身。 41 42**图 1** I3C物理连线示意图<a name="fig1"></a> 43 44 45### 约束与限制<a name="section5"></a> 46 47I3C模块当前仅支持轻量和小型系统内核（LiteOS-A），不支持在用户态使用。 48 49## 使用指导<a name="section6"></a> 50 51### 场景介绍<a name="section7"></a> 52 53I3C可连接单个或多个I3C、I2C从器件，它主要用于： 54 55- 与传感器通信，如陀螺仪、气压计或支持I3C协议的图像传感器等； 56- 通过软件或硬件协议转换，与其他接口（如 UART 串口等）的设备进行通信。 57 58### 接口说明<a name="section8"></a> 59 60I3C模块提供的主要接口如表1所示，具体API详见//drivers/hdf_core/framework/include/platform/i3c_if.h。 61 62**表 1** I3C驱动API接口功能介绍 63 64<a name="table1"></a> 65 66| 接口名 | 接口描述 | 67| ------------- | ----------------- | 68| DevHandle I3cOpen(int16_t number) | 打开I3C控制器 | 69| void I3cClose(DevHandle handle) | 关闭I3C控制器 | 70| int32_t I3cTransfer(DevHandle handle, struct I3cMsg \*msg, int16_t count, enum TransMode mode) | 自定义传输 | 71| int32_t I3cSetConfig(DevHandle handle, struct I3cConfig \*config) | 配置I3C控制器 | 72| int32_t I3cGetConfig(DevHandle handle, struct I3cConfig \*config) | 获取I3C控制器配置 | 73| int32_t I3cRequestIbi(DevHandle handle, uint16_t addr, I3cIbiFunc func, uint32_t payload) | 请求带内中断 | 74| int32_t I3cFreeIbi(DevHandle handle, uint16_t addr) | 释放带内中断 | 75 76> **说明：**<br> 77>本文涉及的所有接口，仅限内核态使用，不支持在用户态使用。 78 79### 开发步骤<a name="section9"></a> 80 81I3C的使用流程如图2所示。 82 83**图 2** I3C使用流程图<a name="fig2"></a> 84 85 86#### 打开I3C控制器<a name="section5"></a> 87 88在进行I3C通信前，首先要调用I3cOpen打开I3C控制器。 89```c 90DevHandle I3cOpen(int16_t number); 91``` 92 93**表 2** I3cOpen参数和返回值描述 94 95<a name="table2"></a> 96 97| 参数 | 参数描述 | 98| ---------- | ------------------- | 99| number | I3C控制器号 | 100| **返回值** | **返回值描述** | 101| NULL | 打开I3C控制器失败 | 102| 控制器句柄 | 打开的I3C控制器句柄 | 103 104假设系统中存在8个I3C控制器，编号从0到7，以下示例代码为打开1号控制器： 105 106```c 107DevHandle i3cHandle = NULL; /* I3C控制器句柄 / 108 109/* 打开I3C控制器 */ 110i3cHandle = I3cOpen(1); 111if (i3cHandle == NULL) { 112 HDF_LOGE("I3cOpen: failed\n"); 113 return; 114} 115``` 116 117#### 获取I3C控制器配置<a name="section7"></a> 118 119```c 120int32_t I3cGetConfig(DevHandle handle, struct I3cConfig *config); 121``` 122 123**表 3** I3cGetConfig参数和返回值描述 124 125<a name="table3"></a> 126 127| 参数 | 参数描述 | 128| ---------- | -------------- | 129| handle | I3C控制器句柄 | 130| config | I3C控制器配置 | 131| **返回值** | **返回值描述** | 132| 0 | 获取成功 | 133| 负数 | 获取失败 | 134 135获取I3C控制器配置示例： 136 137```c 138struct I3cConfig config; 139 140ret = I3cGetConfig(i3cHandle, &config); 141if (ret != HDF_SUCCESS) { 142 HDF_LOGE("%s: Get config fail!", __func__); 143 return HDF_FAILURE; 144} 145``` 146 147#### 配置I3C控制器<a name="section8"></a> 148 149```c 150int32_t I3cSetConfig(DevHandle handle, struct I3cConfig *config); 151``` 152 153**表 4** I3cSetConfig参数和返回值描述 154 155<a name="table4"></a> 156 157| 参数 | 参数描述 | 158| ---------- | -------------- | 159| handle | I3C控制器句柄 | 160| config | I3C控制器配置 | 161| **返回值** | **返回值描述** | 162| 0 | 配置成功 | 163| 负数 | 配置失败 | 164 165配置I3C控制器示例： 166 167```c 168struct I3cConfig config; 169 170config->busMode = I3C_BUS_HDR_MODE; 171config->curMaster = NULL; 172ret = I3cSetConfig(i3cHandle, &config); 173if (ret != HDF_SUCCESS) { 174 HDF_LOGE("%s: Set config fail!", __func__); 175 return HDF_FAILURE; 176} 177``` 178 179#### 进行I3C通信<a name="section6"></a> 180 181消息传输 182```c 183int32_t I3cTransfer(DevHandle handle, struct I3cMsg *msgs, int16_t count, enum TransMode mode); 184``` 185 186**表 5** I3cTransfer参数和返回值描述 187 188<a name="table5"></a> 189 190| 参数 | 参数描述 | 191| ---------- | -------------------------------------------- | 192| handle | I3C控制器句柄 | 193| msgs | 待传输数据的消息结构体数组 | 194| count | 消息数组长度 | 195| mode | 传输模式，0：I2C模式；1：I3C模式；2：发送CCC | 196| **返回值** | **返回值描述** | 197| 正整数 | 成功传输的消息结构体数目 | 198| 负数 | 执行失败 | 199 200I3C传输消息类型为I3cMsg，每个传输消息结构体表示一次读或写，通过一个消息数组，可以执行若干次的读写组合操作。 201 202```c 203int32_t ret; 204uint8_t wbuff[2] = { 0x12, 0x13 }; 205uint8_t rbuff[2] = { 0 }; 206struct I3cMsg msgs[2]; /* 自定义传输的消息结构体数组 */ 207msgs[0].buf = wbuff; /* 写入的数据 */ 208msgs[0].len = 2; /* 写入数据长度为2 */ 209msgs[0].addr = 0x3F; /* 写入设备地址为0x3F */ 210msgs[0].flags = 0; /* 传输标记为0，默认为写 */ 211msgs[1].buf = rbuff; /* 要读取的数据 */ 212msgs[1].len = 2; /* 读取数据长度为2 */ 213msgs[1].addr = 0x3F; /* 读取设备地址为0x3F */ 214msgs[1].flags = I3C_FLAG_READ /* I3C_FLAG_READ置位 */ 215/* 进行一次I2C模式自定义传输，传输的消息个数为2 */ 216ret = I3cTransfer(i3cHandle, msgs, 2, I2C_MODE); 217if (ret != 2) { 218 HDF_LOGE("I3cTransfer: failed, ret %d\n", ret); 219 return; 220} 221``` 222 223> **注意：** 224>- I3cMsg结构体中的设备地址不包含读写标志位，读写信息由flags成员变量的读写控制位传递。 225>- 本函数不对消息结构体个数做限制，其最大个数度由具体I3C控制器决定。 226>- 本函数不对每个消息结构体中的数据长度做限制，同样由具体I3C控制器决定。 227>- 本函数可能会引起系统休眠，禁止在中断上下文调用。 228 229#### 请求IBI（带内中断）<a name="section9"></a> 230 231```c 232int32_t I3cRequestIbi(DevHandle handle, uint16_t addr, I3cIbiFunc func, uint32_t payload); 233``` 234 235**表 6** I3cRequestIbi参数和返回值描述 236 237<a name="table6"></a> 238 239| 参数 | 参数描述 | 240| ---------- | -------------- | 241| handle | I3C控制器句柄 | 242| addr | I3C设备地址 | 243| func | IBI回调函数 | 244| payload | IBI有效载荷 | 245| **返回值** | **返回值描述** | 246| 0 | 请求成功 | 247| 负数 | 请求失败 | 248 249请求带内中断示例： 250 251```c 252static int32_t TestI3cIbiFunc(DevHandle handle, uint16_t addr, struct I3cIbiData data) 253{ 254 (void)handle; 255 (void)addr; 256 HDF_LOGD("%s: %.16s", __func__, (char *)data.buf); 257 258 return 0; 259} 260 261int32_t I3cTestRequestIbi(void) 262{ 263 DevHandle i3cHandle = NULL; 264 int32_t ret; 265 266 /* 打开I3C控制器 */ 267 i3cHandle = I3cOpen(1); 268 if (i3cHandle == NULL) { 269 HDF_LOGE("I3cOpen: failed\n"); 270 return; 271} 272 ret = I3cRequestIbi(i3cHandle, 0x3F, TestI3cIbiFunc, 16); 273 if (ret != 0) { 274 HDF_LOGE("%s: Request IBI failed!", __func__); 275 return -1; 276 } 277 278 I3cClose(i3cHandle); 279 HDF_LOGD("%s: Done", __func__); 280 281 return 0; 282} 283``` 284 285#### 释放IBI（带内中断）<a name="section10"></a> 286 287```c 288int32_t I3cFreeIbi(DevHandle handle, uint16_t addr); 289``` 290 291**表 7** I3cFreeIbi参数和返回值描述 292 293<a name="table7"></a> 294 295| 参数 | 参数描述 | 296| ---------- | -------------- | 297| handle | I3C控制器句柄 | 298| addr | I3C设备地址 | 299| **返回值** | **返回值描述** | 300| 0 | 释放成功 | 301| 负数 | 释放失败 | 302 303释放带内中断示例： 304 305```c 306I3cFreeIbi(i3cHandle, 0x3F); /* 释放带内中断 */ 307``` 308 309#### 关闭I3C控制器<a name="section11"></a> 310 311I3C通信完成之后，需要关闭I3C控制器，关闭函数如下所示： 312```c 313void I3cClose(DevHandle handle); 314``` 315 316**表 8** I3cClose参数和返回值描述 317 318<a name="table8"></a> 319 320| 参数 | 参数描述 | 321| ---------- | -------------- | 322| handle | I3C控制器句柄 | 323 324关闭I3C控制器实例： 325 326```c 327I3cClose(i3cHandle); /* 关闭I3C控制器 */ 328``` 329 330## 使用实例<a name="section10"></a> 331 332本例程以操作Hi3516DV300开发板上的I3C虚拟设备为例，详细展示I3C接口的完整使用流程，基本硬件信息如下。 333 334- SOC：hi3516dv300。 335 336- 虚拟I3C设备：I3C地址为0x3f, 寄存器位宽为1字节。 337 338- 硬件连接：虚拟I3C设备挂接在18号和19号I3C控制器下。 339 340本例程进行简单的I3C传输，测试I3C通路是否正常。 341 342示例如下： 343 344```c 345#include "i3c_if.h" /* I3C标准接口头文件 */ 346#include "hdf_log.h" /* 标准日志打印头文件 */ 347#include "osal_io.h" /* 标准IO读写接口头文件 */ 348#include "osal_time.h" /* 标准延迟&睡眠接口头文件 */ 349 350/* 定义一个表示设备的结构体，存储信息 */ 351struct TestI3cDevice { 352 uint16_t busNum; /* I3C总线号 */ 353 uint16_t addr; /* I3C设备地址 */ 354 uint16_t regLen; /* 寄存器字节宽度 */ 355 DevHandle i3cHandle; /* I3C控制器句柄 */ 356}; 357 358/* 基于I3cTransfer方法封装一个寄存器读写的辅助函数， 通过flag表示读或写 */ 359static int TestI3cReadWrite(struct TestI3cDevice *testDevice, unsigned int regAddr, 360 unsigned char *regData, unsigned int dataLen, uint8_t flag) 361{ 362 int index = 0; 363 unsigned char regBuf[4] = {0}; 364 struct I3cMsg msgs[2] = {0}; 365 366 /* 单双字节寄存器长度适配 */ 367 if (testDevice->regLen == 1) { 368 regBuf[index++] = regAddr & 0xFF; 369 } else { 370 regBuf[index++] = (regAddr >> 8) & 0xFF; 371 regBuf[index++] = regAddr & 0xFF; 372 } 373 374 /* 填充I3cMsg消息结构 */ 375 msgs[0].addr = testDevice->addr; 376 msgs[0].flags = 0; /* 标记为0，表示写入 */ 377 msgs[0].len = testDevice->regLen; 378 msgs[0].buf = regBuf; 379 380 msgs[1].addr = testDevice->addr; 381 msgs[1].flags = (flag == 1) ? I3C_FLAG_READ : 0; /* 添加读标记位，表示读取 */ 382 msgs[1].len = dataLen; 383 msgs[1].buf = regData; 384 385 if (I3cTransfer(testDevice->i3cHandle, msgs, 2, I2C_MODE) != 2) { 386 HDF_LOGE("%s: i3c read err", __func__); 387 return HDF_FAILURE; 388 } 389 return HDF_SUCCESS; 390} 391 392/* 寄存器读函数 */ 393static inline int TestI3cReadReg(struct TestI3cDevice *testDevice, unsigned int regAddr, 394 unsigned char *regData, unsigned int dataLen) 395{ 396 return TestI3cReadWrite(testDevice, regAddr, regData, dataLen, 1); 397} 398 399/* 寄存器写函数 */ 400static inline int TestI3cWriteReg(struct TestI3cDevice *testDevice, unsigned int regAddr, 401 unsigned char *regData, unsigned int dataLen) 402{ 403 return TestI3cReadWrite(testDevice, regAddr, regData, dataLen, 0); 404} 405 406/* I3C例程总入口 */ 407static int32_t TestCaseI3c(void) 408{ 409 int32_t i; 410 int32_t ret; 411 unsigned char bufWrite[7] = { 0xFF, 0xFF, 0xFF, 0xFF, 0xA, 0xB, 0xC }; 412 unsigned char bufRead[7] = {0}; 413 static struct TestI3cDevice testDevice; 414 415 /* 设备信息初始化 */ 416 testDevice.busNum = 18; 417 testDevice.addr = 0x3F; 418 testDevice.regLen = 1; 419 testDevice.i3cHandle = NULL; 420 421 /* 打开I3C控制器 */ 422 testDevice.i3cHandle = I3cOpen(testDevice.busNum); 423 if (testDevice.i3cHandle == NULL) { 424 HDF_LOGE("%s: Open I3c:%u fail!", __func__, testDevice.busNum); 425 return -1; 426 } 427 428 /* 向地址为0x3F的设备连续写7字节数据 */ 429 ret = TestI3cWriteReg(&testDevice, 0x3F, bufWrite, 7); 430 if (ret != HDF_SUCCESS) { 431 HDF_LOGE("%s: test i3c write reg fail!:%d", __func__, ret); 432 I3cClose(testDevice.i3cHandle); 433 return -1; 434 } 435 OsalMSleep(10); 436 437 /* 从地址为0x3F的设备连续读7字节数据 */ 438 ret = TestI3cReadReg(&testDevice, 0x3F, bufRead, 7); 439 if (ret != HDF_SUCCESS) { 440 HDF_LOGE("%s: test i3c read reg fail!:%d", __func__, ret); 441 I3cClose(testDevice.i3cHandle); 442 return -1; 443 } 444 HDF_LOGI("%s: test i3c write&read reg success!", __func__); 445 446 /* 访问完毕关闭I3C控制器 */ 447 I3cClose(testDevice.i3cHandle); 448 449 return 0; 450} 451``` 452
