Skip to content

D
Docs

OpenHarmony / Docs
大约 2 年 前同步成功

通知 161
Star 293
Fork 28
D
Docs
未验证 提交 6699bd5a 编写于 作者: O openharmony_ci 提交者： Gitee
浏览文件
操作

!3946 【OpenHarmony开源贡献者计划2022】I2C&I3C驱动相关格式及表达问题 

Merge pull request !3946 from king_he/i23c
上级 149d393f 20870694
隐藏空白更改
内联 并排
Showing with 143 addition and 160 deletion
zh-cn/device-dev/driver/driver-platform-i2c-des.md
浏览文件 @ 6699bd5a
......@@ -3,17 +3,17 @@
## 概述
- I2C（Inter Integrated Circuit）总线是由Philips公司开发的一种简单、双向二线制同步串行总线。
I2C（Inter Integrated Circuit）总线是由Philips公司开发的一种简单、双向二线制同步串行总线。
- I2C以主从方式工作，通常有一个主设备和一个或者多个从设备，主从设备通过SDA（SerialData）串行数据线以及SCL（SerialClock）串行时钟线两根线相连，如图1所示。
I2C以主从方式工作，通常有一个主设备和一个或者多个从设备，主从设备通过SDA（SerialData）串行数据线以及SCL（SerialClock）串行时钟线两根线相连，如图1所示。
- I2C数据的传输必须以一个起始信号作为开始条件，以一个结束信号作为传输的停止条件。数据传输以字节为单位，高位在前，逐个bit进行传输。
I2C数据的传输必须以一个起始信号作为开始条件，以一个结束信号作为传输的停止条件。数据传输以字节为单位，高位在前，逐个bit进行传输。
- I2C总线上的每一个设备都可以作为主设备或者从设备，而且每一个设备都会对应一个唯一的地址，当主设备需要和某一个从设备通信时，通过广播的方式，将从设备地址写到总线上，如果某个从设备符合此地址，将会发出应答信号，建立传输。
I2C总线上的每一个设备都可以作为主设备或者从设备，而且每一个设备都会对应一个唯一的地址，当主设备需要和某一个从设备通信时，通过广播的方式，将从设备地址写到总线上，如果某个从设备符合此地址，将会发出应答信号，建立传输。
- I2C接口定义了完成I2C传输的通用方法集合，包括：
- I2C控制器管理: 打开或关闭I2C控制器
- I2C消息传输：通过消息传输结构体数组进行自定义传输
I2C接口定义了完成I2C传输的通用方法集合，包括：
- I2C控制器管理：打开或关闭I2C控制器
- I2C消息传输：通过消息传输结构体数组进行自定义传输
**图1** I2C物理连线示意图
......@@ -29,7 +29,7 @@
| I2C控制器管理接口 | -&nbsp;I2cOpen：打开I2C控制器<br/>-&nbsp;I2cClose：关闭I2C控制器 |
| I2C消息传输接口 | I2cTransfer：自定义传输 |
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：**
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：**<br>
> 本文涉及的所有接口，仅限内核态使用，不支持在用户态使用。
......@@ -60,7 +60,7 @@ DevHandle I2cOpen(int16_t number);
| NULL | 打开I2C控制器失败 |
| 设备句柄 | 打开的I2C控制器设备句柄 |
假设系统中存在8个I2C控制器，编号从0到7，那么我们现在获取3号控制器
假设系统中存在8个I2C控制器，编号从0到7，以下代码示例为获取3号控制器：
```
......@@ -128,7 +128,7 @@ if (ret != 2) {
### 关闭I2C控制器
I2C通信完成之后，需要关闭I2C控制器，关闭函数如下所示：
I2C通信完成之后，需要关闭I2C控制器，关闭函数如下所述：
void I2cClose(DevHandle handle);
......@@ -144,7 +144,7 @@ I2cClose(i2cHandle); /* 关闭I2C控制器 */
```
## 使用实例
## 使用示例
本例程以操作开发板上的I2C设备为例，详细展示I2C接口的完整使用流程。
......@@ -158,8 +158,8 @@ I2cClose(i2cHandle); /* 关闭I2C控制器 */
本例程首先对Touch IC进行复位操作（开发板上电默认会给TouchIC供电，本例程不考虑供电），然后对其内部寄存器进行随机读写，测试I2C通路是否正常。
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：**
> 本例程重点在于展示I2C设备访问流程，并验证I2C通路，所以对于设备寄存器读写值不做关注，读写寄存器导致的行为由设备自身决定。
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：**<br>
> 本示例重点在于展示I2C设备访问流程，并验证I2C通路，所以对于设备寄存器读写值不做关注，读写寄存器导致的行为由设备自身决定。
示例如下：
......
zh-cn/device-dev/driver/driver-platform-i2c-develop.md
浏览文件 @ 6699bd5a
......@@ -19,9 +19,9 @@ I2cMethod和I2cLockMethod定义：
struct I2cMethod {
int32_t (*transfer)(struct I2cCntlr *cntlr, struct I2cMsg *msgs, int16_t count);
};
struct I2cLockMethod {//锁机制操作结构体
int32_t (*lock)(struct I2cCntlr *cntlr);//加锁
void (*unlock)(struct I2cCntlr *cntlr); //解锁
struct I2cLockMethod {// 锁机制操作结构体
int32_t (*lock)(struct I2cCntlr *cntlr);// 加锁
void (*unlock)(struct I2cCntlr *cntlr); // 解锁
};
```
......@@ -36,21 +36,21 @@ struct I2cLockMethod {//锁机制操作结构体
I2C模块适配的三个环节是配置属性文件，实例化驱动入口，以及实例化核心层接口函数。
1. **实例化驱动入口：**
1. 实例化驱动入口：
- 实例化HdfDriverEntry结构体成员。
- 调用HDF_INIT将HdfDriverEntry实例化对象注册到HDF框架中。
2. **配置属性文件：**
2. 配置属性文件：
- 在device_info.hcs文件中添加deviceNode描述。
- 【可选】添加i2c_config.hcs器件属性文件。
3. **实例化I2C控制器对象：**
3. 实例化I2C控制器对象：
- 初始化I2cCntlr成员。
- 实例化I2cCntlr成员I2cMethod和I2cLockMethod。
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：**
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：**<br>
> 实例化I2cCntlr成员I2cMethod和I2cLockMethod，详见[接口说明](#接口说明)。
4. **驱动调试：**
4. 驱动调试：
【可选】针对新增驱动程序，建议验证驱动基本功能，例如挂载后的信息反馈，消息传输的成功与否等。
......@@ -73,17 +73,17 @@ I2C模块适配的三个环节是配置属性文件，实例化驱动入口，
.moduleVersion = 1,
.Init = Hi35xxI2cInit,
.Release = Hi35xxI2cRelease,
.moduleName = "hi35xx_i2c_driver",//【必要且与config.hcs文件里面匹配】
.moduleName = "hi35xx_i2c_driver",// 【必要且与config.hcs文件里面匹配】
};
HDF_INIT(g_i2cDriverEntry); //调用HDF_INIT将驱动入口注册到HDF框架中
HDF_INIT(g_i2cDriverEntry); // 调用HDF_INIT将驱动入口注册到HDF框架中
//核心层i2c_core.c 管理器服务的驱动入口
// 核心层i2c_core.c管理器服务的驱动入口
struct HdfDriverEntry g_i2cManagerEntry = {
.moduleVersion = 1,
.Bind = I2cManagerBind,
.Init = I2cManagerInit,
.Release = I2cManagerRelease,
.moduleName = "HDF_PLATFORM_I2C_MANAGER",//这与device_info文件中device0对应
.moduleName = "HDF_PLATFORM_I2C_MANAGER",// 这与device_info文件中device0对应
};
HDF_INIT(g_i2cManagerEntry);
```
......@@ -101,7 +101,7 @@ I2C模块适配的三个环节是配置属性文件，实例化驱动入口，
| deviceMatchAttr | 没有使用，可忽略 |
从第二个节点开始配置具体I2C控制器信息，此节点并不表示某一路I2C控制器，而是代表一个资源性质设备，用于描述一类I2C控制器的信息。多个控制器之间相互区分的参数是busID和reg_pbase，这在i2c_config文件中有所体现。
- device_info.hcs 配置参考。
- device_info.hcs配置参考
```
......@@ -124,14 +124,14 @@ I2C模块适配的三个环节是配置属性文件，实例化驱动入口，
moduleName = "hi35xx_i2c_driver"; //【必要】用于指定驱动名称，需要与期望的驱动Entry中的moduleName一致；
serviceName = "HI35XX_I2C_DRIVER"; //【必要】驱动对外发布服务的名称，必须唯一
deviceMatchAttr = "hisilicon_hi35xx_i2c";//【必要】用于配置控制器私有数据，要与i2c_config.hcs中对应控制器保持一致
// 具体的控制器信息在 i2c_config.hcs 中
// 具体的控制器信息在 i2c_config.hcs中
}
}
}
}
```
- i2c_config.hcs 配置参考。
- i2c_config.hcs 配置参考
```
......@@ -140,12 +140,12 @@ I2C模块适配的三个环节是配置属性文件，实例化驱动入口，
i2c_config {
match_attr = "hisilicon_hi35xx_i2c";//【必要】需要和device_info.hcs中的deviceMatchAttr值一致
template i2c_controller { //模板公共参数，继承该模板的节点如果使用模板中的默认值，则节点字段可以缺省
bus = 0; //【必要】i2c 识别号
reg_pbase = 0x120b0000; //【必要】物理基地址
reg_size = 0xd1; //【必要】寄存器位宽
irq = 0; //【可选】根据厂商需要来使用
freq = 400000; //【可选】根据厂商需要来使用
clk = 50000000; //【可选】根据厂商需要来使用
bus = 0; // 【必要】i2c 识别号
reg_pbase = 0x120b0000; // 【必要】物理基地址
reg_size = 0xd1; // 【必要】寄存器位宽
irq = 0; // 【可选】根据厂商需要来使用
freq = 400000; // 【可选】根据厂商需要来使用
clk = 50000000; // 【可选】根据厂商需要来使用
}
controller_0x120b0000 :: i2c_controller {
bus = 0;
......@@ -169,15 +169,15 @@ I2C模块适配的三个环节是配置属性文件，实例化驱动入口，
```
// 厂商自定义功能结构体
struct Hi35xxI2cCntlr {
struct I2cCntlr cntlr; //【必要】是核心层控制对象，具体描述见下面
OsalSpinlock spin; //【必要】厂商需要基于此锁变量对各个 i2c 操作函数实现对应的加锁解锁
volatile unsigned char *regBase; //【必要】寄存器基地址
uint16_t regSize; //【必要】寄存器位宽
int16_t bus; //【必要】i2c_config.hcs 文件中可读取具体值
uint32_t clk; //【可选】厂商自定义
uint32_t freq; //【可选】厂商自定义
uint32_t irq; //【可选】厂商自定义
uint32_t regBasePhy; //【必要】寄存器物理基地址
struct I2cCntlr cntlr; // 【必要】是核心层控制对象，具体描述见下面
OsalSpinlock spin; // 【必要】厂商需要基于此锁变量对各个 i2c 操作函数实现对应的加锁解锁
volatile unsigned char *regBase; // 【必要】寄存器基地址
uint16_t regSize; // 【必要】寄存器位宽
int16_t bus; // 【必要】i2c_config.hcs文件中可读取具体值
uint32_t clk; // 【可选】厂商自定义
uint32_t freq; // 【可选】厂商自定义
uint32_t irq; // 【可选】厂商自定义
uint32_t regBasePhy; // 【必要】寄存器物理基地址
};
// I2cCntlr是核心层控制器结构体，其中的成员在Init函数中会被赋值
......@@ -190,29 +190,29 @@ I2C模块适配的三个环节是配置属性文件，实例化驱动入口，
const struct I2cLockMethod *lockOps;
};
```
- I2cCntlr成员回调函数结构体I2cMethod的实例化，和锁机制回调函数结构体I2cLockMethod实例化,其他成员在Init函数中初始化。
- I2cCntlr成员回调函数结构体I2cMethod的实例化，和锁机制回调函数结构体I2cLockMethod实例化，其他成员在Init函数中初始化。
```
// i2c_hi35xx.c 中的示例
// i2c_hi35xx.c中的示例
static const struct I2cMethod g_method = {
.transfer = Hi35xxI2cTransfer,
};
static const struct I2cLockMethod g_lockOps = {
.lock = Hi35xxI2cLock, //加锁函数
.unlock = Hi35xxI2cUnlock,//解锁函数
.lock = Hi35xxI2cLock, // 加锁函数
.unlock = Hi35xxI2cUnlock,// 解锁函数
};
```
- Init函数参考
入参：
HdfDeviceObject 是整个驱动对外暴露的接口参数，具备 HCS 配置文件的信息。
HdfDeviceObject是整个驱动对外暴露的接口参数，具备hcs配置文件的信息。
返回值：
HDF_STATUS相关状态 （下表为部分展示，如需使用其他状态，可见//drivers/framework/include/utils/hdf_base.h中HDF_STATUS 定义）。
HDF_STATUS相关状态（下表为部分展示，如需使用其他状态，可见//drivers/framework/include/utils/hdf_base.h中HDF_STATUS定义）。
**表3** Init函数入参及返回值参考
......@@ -234,7 +234,7 @@ I2C模块适配的三个环节是配置属性文件，实例化驱动入口，
static int32_t Hi35xxI2cInit(struct HdfDeviceObject *device)
{
...
//遍历、解析 i2c_config.hcs 中的所有配置节点，并分别进行初始化，需要调用Hi35xxI2cParseAndInit函数
// 遍历、解析 i2c_config.hcs中的所有配置节点，并分别进行初始化，需要调用Hi35xxI2cParseAndInit函数
DEV_RES_NODE_FOR_EACH_CHILD_NODE(device->property, childNode) {
ret = Hi35xxI2cParseAndInit(device, childNode);//函数定义见下
...
......@@ -252,18 +252,18 @@ I2C模块适配的三个环节是配置属性文件，实例化驱动入口，
...
Hi35xxI2cCntlrInit(hi35xx); // 【必要】i2c设备的初始化
hi35xx->cntlr.priv = (void *)node; //【必要】存储设备属性
hi35xx->cntlr.busId = hi35xx->bus; //【必要】初始化I2cCntlr成员busId
hi35xx->cntlr.ops = &g_method; //【必要】I2cMethod的实例化对象的挂载
hi35xx->cntlr.lockOps = &g_lockOps; //【必要】I2cLockMethod的实例化对象的挂载
(void)OsalSpinInit(&hi35xx->spin); //【必要】锁的初始化
ret = I2cCntlrAdd(&hi35xx->cntlr); //【必要】调用此函数填充核心层结构体，返回成功信号后驱动才完全接入平台核心层
hi35xx->cntlr.priv = (void *)node; // 【必要】存储设备属性
hi35xx->cntlr.busId = hi35xx->bus; // 【必要】初始化I2cCntlr成员busId
hi35xx->cntlr.ops = &g_method; // 【必要】I2cMethod的实例化对象的挂载
hi35xx->cntlr.lockOps = &g_lockOps; // 【必要】I2cLockMethod的实例化对象的挂载
(void)OsalSpinInit(&hi35xx->spin); // 【必要】锁的初始化
ret = I2cCntlrAdd(&hi35xx->cntlr); // 【必要】调用此函数填充核心层结构体，返回成功信号后驱动才完全接入平台核心层
...
#ifdef USER_VFS_SUPPORT
(void)I2cAddVfsById(hi35xx->cntlr.busId);//【可选】若支持用户级的虚拟文件系统，则接入
(void)I2cAddVfsById(hi35xx->cntlr.busId);// 【可选】若支持用户级的虚拟文件系统，则接入
#endif
return HDF_SUCCESS;
__ERR__: //不成功的话，需要反向执行初始化相关函数
__ERR__: // 不成功的话，需要反向执行初始化相关函数
if (hi35xx != NULL) {
if (hi35xx->regBase != NULL) {
OsalIoUnmap((void *)hi35xx->regBase);
......@@ -275,11 +275,11 @@ I2C模块适配的三个环节是配置属性文件，实例化驱动入口，
return ret;
}
```
- Release 函数参考
- Release函数参考
入参：
HdfDeviceObject 是整个驱动对外暴露的接口参数，具备 HCS 配置文件的信息。
HdfDeviceObject是整个驱动对外暴露的接口参数，具备hcs配置文件的信息。
返回值：
......@@ -287,28 +287,28 @@ I2C模块适配的三个环节是配置属性文件，实例化驱动入口，
函数说明：
释放内存和删除控制器，该函数需要在驱动入口结构体中赋值给 Release 接口， 当HDF框架调用Init函数初始化驱动失败时，可以调用 Release 释放驱动资源。
释放内存和删除控制器，该函数需要在驱动入口结构体中赋值给Release接口，当HDF框架调用Init函数初始化驱动失败时，可以调用Release释放驱动资源。
```
static void Hi35xxI2cRelease(struct HdfDeviceObject *device)
{
...
//与Hi35xxI2cInit一样，需要将对每个节点分别进行释放
// 与Hi35xxI2cInit一样，需要将对每个节点分别进行释放
DEV_RES_NODE_FOR_EACH_CHILD_NODE(device->property, childNode) {
Hi35xxI2cRemoveByNode(childNode);//函数定义见下
Hi35xxI2cRemoveByNode(childNode);// 函数定义见下
}
}
static void Hi35xxI2cRemoveByNode(const struct DeviceResourceNode *node)
{
...
//【必要】可以调用 I2cCntlrGet 函数通过设备的 busid 获取 I2cCntlr 对象， 以及调用 I2cCntlrRemove 函数来释放 I2cCntlr 对象的内容
// 【必要】可以调用 I2cCntlrGet函数通过设备的busid获取I2cCntlr对象， 以及调用I2cCntlrRemove函数来释放I2cCntlr对象的内容
cntlr = I2cCntlrGet(bus);
if (cntlr != NULL && cntlr->priv == node) {
...
I2cCntlrRemove(cntlr);
//【必要】解除地址映射，锁和内存的释放
// 【必要】解除地址映射，锁和内存的释放
hi35xx = (struct Hi35xxI2cCntlr *)cntlr;
OsalIoUnmap((void *)hi35xx->regBase);
(void)OsalSpinDestroy(&hi35xx->spin);
......
zh-cn/device-dev/driver/driver-platform-i3c-des.md
浏览文件 @ 6699bd5a
# I3C<a name="1"></a>
- [概述](#section1)
- [功能简介](#section2)
- [基本概念](#section3)
- [运作机制](#section4)
- [约束与限制](#section5)
- [使用指导](#section6)
- [场景介绍](#section7)
- [接口说明](#section8)
- [开发步骤](#section9)
- [使用实例](#section10)
## 概述<a name="section1"></a>
### 功能简介<a name="section2"></a>
I3C（Improved Inter Integrated Circuit）总线是由MIPI Alliance开发的一种简单、低成本的双向二线制同步串行总线。
- I3C接口定义了完成I3C传输的通用方法集合，包括：
I3C控制器管理：打开或关闭I3C控制器。
I3C控制器配置：获取或配置I3C控制器参数。
I3C消息传输：通过消息传输结构体数组进行自定义传输。
I3C带内中断：请求或释放带内中断。
I3C是两线双向串行总线，针对多个传感器从设备进行了优化，并且一次只能由一个I3C主设备控制。相比于I2C，I3C总线拥有更高的速度、更低的功耗，支持带内中断、从设备热接入以及切换当前主设备，同时向后兼容I2C从设备。I3C增加了带内中断（In-Bind Interrupt）功能，支持I3C设备进行热接入操作，弥补了I2C总线需要额外增加中断线来完成中断的不足。I3C总线上允许同时存在I2C设备、I3C从设备和I3C次级主设备。
I3C接口定义了完成I3C传输的通用方法集合，包括：
- I3C控制器管理：打开或关闭I3C控制器。
- I3C控制器配置：获取或配置I3C控制器参数。
- I3C消息传输：通过消息传输结构体数组进行自定义传输。
- I3C带内中断：请求或释放带内中断。
### 基本概念<a name="section3"></a>
- I3C是两线双向串行总线，针对多个传感器从设备进行了优化，并且一次只能由一个I3C主设备控制。 相比于I2C，I3C总线拥有更高的速度、更低的功耗，支持带内中断、从设备热接入以及切换当前主设备，同时向后兼容I2C从设备。
- I3C增加了带内中断（In-Bind Interrupt）功能，支持I3C设备进行热接入操作，弥补了I2C总线需要额外增加中断线来完成中断的不足。
- I3C总线上允许同时存在I2C设备、I3C从设备和I3C次级主设备。
- I3C相关缩略词解释：
- IBI（In-Band Interrupt）：带内中断。在SCL线没有启动信号时，I3C从设备可以通过拉低SDA线使主设备发出SCL启动信号，从而发出带内中断请求。若有多个从机同时发出中断请求，I3C主机则通过从机地址进行仲裁，低地址优先相应。
- DAA（Dynamic Address Assignment）：动态地址分配。I3C支持对从设备地址进行动态分配从而避免地址冲突。在分配动态地址之前，连接到I3C总线上的每个I3C设备都应以两种方式之一来唯一标识：
- IBI（In-Band Interrupt）
带内中断。在SCL线没有启动信号时，I3C从设备可以通过拉低SDA线使主设备发出SCL启动信号，从而发出带内中断请求。若有多个从机同时发出中断请求，I3C主机则通过从机地址进行仲裁，低地址优先相应。
- DAA（Dynamic Address Assignment）：动态地址分配。I3C支持对从设备地址进行动态分配从而避免地址冲突。在分配动态地址之前，连接到I3C总线上的每个I3C设备都应以两种方式之一来唯一标识：
1）设备可能有一个符合I2C规范的静态地址，主机可以使用此静态地址；
2）在任何情况下，设备均应具有48位的临时ID。 除非设备具有静态地址且主机使用静态地址，否则主机应使用此48位临时ID。
- CCC（Common Command Code） ：通用命令代码，所有I3C设备均支持CCC，可以直接将其传输到特定的I3C从设备，也可以同时传输到所有I3C从设备。
- BCR（Bus Characteristic Register）：总线特性寄存器，每个连接到 I3C 总线的 I3C 设备都应具有相关的只读总线特性寄存器 （BCR），该寄存器描述了I3C兼容设备在动态地址分配和通用命令代码中的作用和功能。
- DCR（Device Characteristic Register）：设备特性寄存器，连接到 I3C 总线的每个 I3C 设备都应具有相关的只读设备特性寄存器 (DCR)。 该寄存器描述了用于动态地址分配和通用命令代码的 I3C 兼容设备类型（例如，加速度计、陀螺仪等）。
- CCC（Common Command Code）：通用命令代码，所有I3C设备均支持CCC，可以直接将其传输到特定的I3C从设备，也可以同时传输到所有I3C从设备。
- BCR（Bus Characteristic Register）：总线特性寄存器，每个连接到 I3C 总线的 I3C 设备都应具有相关的只读总线特性寄存器 （BCR），该寄存器描述了I3C兼容设备在动态地址分配和通用命令代码中的作用和功能。
- DCR（Device Characteristic Register）：设备特性寄存器，连接到 I3C 总线的每个 I3C 设备都应具有相关的只读设备特性寄存器 (DCR)。 该寄存器描述了用于动态地址分配和通用命令代码的 I3C 兼容设备类型（例如，加速度计、陀螺仪等）。
### 运作机制<a name="section4"></a>
......@@ -48,7 +40,7 @@ I3C（Improved Inter Integrated Circuit）总线是由MIPI Alliance开发的一
### 约束与限制<a name="section5"></a>
I3C模块当前仅支持轻量和小型系统内核（LiteOS） 。
I3C模块当前仅支持轻量和小型系统内核（LiteOS）。
## 使用指导<a name="section6"></a>
......@@ -74,7 +66,7 @@ I3C可连接单个或多个I3C、I2C从器件，它主要用于：
| I3cRequestIbi | 请求带内中断 |
| I3cFreeIbi | 释放带内中断 |
>![](../public_sys-resources/icon-note.gif) **说明：**
>![](../public_sys-resources/icon-note.gif) **说明：**<br>
>本文涉及的所有接口，仅限内核态使用，不支持在用户态使用。
### 开发步骤<a name="section9"></a>
......@@ -102,7 +94,7 @@ DevHandle I3cOpen(int16_t number);
| NULL | 打开I3C控制器失败 |
| 控制器句柄 | 打开的I3C控制器句柄 |
假设系统中存在8个I3C控制器，编号从0到7，那么我们现在打开1号控制器：
假设系统中存在8个I3C控制器，编号从0到7，以下示例代码为打开1号控制器：
```c
DevHandle i3cHandle = NULL; /* I3C控制器句柄 /
......
zh-cn/device-dev/driver/driver-platform-i3c-develop.md
浏览文件 @ 6699bd5a
# I3C
- [概述](#1)
- [功能简介](#2)
- [基本概念](#3)
- [运作机制](#4)
- [约束与限制](#5)
- [开发指导](#6)
- [场景介绍](#7)
- [接口说明](#8)
- [开发步骤](#9)
## 概述 <a name="1"></a>
### 功能简介<a name="2"></a>
I3C（Improved Inter Integrated Circuit）总线是由MIPI Alliance开发的一种简单、低成本的双向二线制同步串行总线。
### 基本概念<a name="3"></a>
I3C是两线双向串行总线，针对多个传感器从设备进行了优化，并且一次只能由一个I3C主设备控制。 相比于I2C，I3C总线拥有更高的速度、更低的功耗，支持带内中断、从设备热接入以及切换当前主设备，同时向后兼容I2C从设备。
### 基本概念<a name="3"></a>
- IBI（In-Band Interrupt）：带内中断。在SCL线没有启动信号时，I3C从设备可以通过拉低SDA线使主设备发出SCL启动信号，从而发出带内中断请求。若有多个从机同时发出中断请求，I3C主机则通过从机地址进行仲裁，低地址优先相应。
- DAA（Dynamic Address Assignment）：动态地址分配。I3C支持对从设备地址进行动态分配从而避免地址冲突。在分配动态地址之前，连接到I3C总线上的每个I3C设备都应以两种方式之一来唯一标识：
1）设备可能有一个符合I2C规范的静态地址，主机可以使用此静态地址；
2）在任何情况下，设备均应具有48位的临时ID。 除非设备具有静态地址且主机使用静态地址，否则主机应使用此48位临时ID。
- CCC（Common Command Code） ：通用命令代码（CCC），所有I3C设备均支持CCC，可以直接将其传输到特定的I3C从设备，也可以同时传输到所有I3C从设备。
- BCR（Bus Characteristic Register）：总线特性寄存器，每个连接到 I3C 总线的 I3C 设备都应具有相关的只读总线特性寄存器 （BCR），该寄存器描述了I3C兼容设备在动态地址分配和通用命令代码中的作用和功能。
- DCR（Device Characteristic Register）：设备特性寄存器，连接到 I3C 总线的每个 I3C 设备都应具有相关的只读设备特性寄存器 (DCR)。 该寄存器描述了用于动态地址分配和通用命令代码的 I3C 兼容设备类型（例如，加速度计、陀螺仪等）。
- BCR（Bus Characteristic Register）：总线特性寄存器，每个连接到I3C总线的 I3C 设备都应具有相关的只读总线特性寄存器（BCR），该寄存器描述了I3C兼容设备在动态地址分配和通用命令代码中的作用和功能。
- DCR（Device Characteristic Register）：设备特性寄存器，连接到I3C总线的每个 I3C 设备都应具有相关的只读设备特性寄存器（DCR）。该寄存器描述了用于动态地址分配和通用命令代码的I3C兼容设备类型（例如，加速度计、陀螺仪等）。
### 运作机制<a name="4"></a>
在HDF框架中，同类型控制器对象较多时（可能同时存在十几个同类型控制器），如果采用独立服务模式则需要配置更多的设备节点，且相关服务会占据更多的内存资源。相反，采用统一服务模式可以使用一个设备服务作为管理器，统一处理所有同类型对象的外部访问（这会在配置文件中有所体现）,实现便捷管理和节约资源的目的。I3C模块接口适配模式采用统一服务模式（如[图1](#fig1)所示）。
在HDF框架中，同类型控制器对象较多时（可能同时存在十几个同类型控制器），如果采用独立服务模式则需要配置更多的设备节点，且相关服务会占据更多的内存资源。相反，采用统一服务模式可以使用一个设备服务作为管理器，统一处理所有同类型对象的外部访问（这会在配置文件中有所体现），实现便捷管理和节约资源的目的。I3C模块接口适配模式采用统一服务模式（如[图1](#fig1)所示）。
I3C模块各分层的作用为：接口层提供打开控制器、传输消息、获取和设置控制器参数以及关闭控制器的接口。核心层主要提供绑定设备、初始化设备以及释放设备的能力。适配层实现其他具体的功能。
......@@ -70,35 +60,36 @@ struct I3cMethod {
**表1** I3cMethod结构体成员的回调函数功能说明
|函数成员|入参|出参|返回值|功能|
|-|-|-|-|-|
|sendCccCmd|**cntlr**: 结构体指针，核心层I3C控制器;<br />**ccc**：传入的通用命令代码结构体指针;|**ccc**：传出的通用命令代码结构体指针;|HDF_STATUS相关状态|发送CCC（Common command Code，即通用命令代码）|
|Transfer |**cntlr**: 结构体指针，核心层I3C控制器;<br />**msgs**：结构体指针，用户消息 ;<br />**count**：int16_t，消息数量|**msgs**：结构体指针，用户消息 ;|HDF_STATUS相关状态|使用I3C模式传递用户消息|
|i2cTransfer |**cntlr**: 结构体指针，核心层I3C控制器;<br />**msgs**：结构体指针，用户消息 ;<br />**count**：int16_t，消息数量|**msgs**：结构体指针，用户消息 ;|HDF_STATUS相关状态|使用I2C模式传递用户消息|
|setConfig|**cntlr**: 结构体指针，核心层I3C控制器; <br />**config**: 控制器配置参数|无|HDF_STATUS相关状态|设置I3C控制器配置参数|
|getConfig|**cntlr**: 结构体指针，核心层I3C控制器;|**config**: 控制器配置参数|HDF_STATUS相关状态|获取I3C控制器配置参数|
|requestIbi|**device**: 结构体指针，核心层I3C设备;|无|HDF_STATUS相关状态|为I3C设备请求IBI（In-Bind Interrupt，即带内中断）|
|freeIbi|**device**: 结构体指针，核心层I3C设备;|无|HDF_STATUS相关状态|释放IBI|
|sendCccCmd| **cntlr**: 结构体指针，核心层I3C控制器<br />**ccc**：传入的通用命令代码结构体指针 | **ccc**：传出的通用命令代码结构体指针 | HDF_STATUS相关状态|发送CCC（Common command Code，即通用命令代码）|
|Transfer | **cntlr**: 结构体指针，核心层I3C控制器<br />**msgs**：结构体指针，用户消息<br />**count**：int16_t，消息数量 | **msgs**：结构体指针，用户消息
| HDF_STATUS相关状态 | 使用I3C模式传递用户消息 |
|i2cTransfer | **cntlr**: 结构体指针，核心层I3C控制器<br />**msgs**：结构体指针，用户消息<br />**count**：int16_t，消息数量 | **msgs**：结构体指针，用户消息 | HDF_STATUS相关状态 | 使用I2C模式传递用户消息 |
|setConfig| **cntlr**: 结构体指针，核心层I3C控制器<br />**config**: 控制器配置参数| 无 | HDF_STATUS相关状态 | 设置I3C控制器配置参数 |
|getConfig| **cntlr**: 结构体指针，核心层I3C控制器| **config**: 控制器配置参数 | HDF_STATUS相关状态 | 获取I3C控制器配置参数 |
|requestIbi| **device**: 结构体指针，核心层I3C设备| 无 | HDF_STATUS相关状态 | 为I3C设备请求IBI（In-Bind Interrupt，即带内中断） |
|freeIbi| **device**: 结构体指针，核心层I3C设备| 无 | HDF_STATUS相关状态 | 释放IBI |
### 开发步骤 <a name="9"></a>
I3C模块适配的四个环节是实例化驱动入口、配置属性文件、实例化I3C控制器对象以及注册中断处理子程序。
- **实例化驱动入口：**
- 实例化驱动入口：
- 实例化HdfDriverEntry结构体成员。
- 调用HDF_INIT将HdfDriverEntry实例化对象注册到HDF框架中。
- **配置属性文件：**
- 配置属性文件：
- 在device_info.hcs文件中添加deviceNode描述。
- 【可选】添加i3c_config.hcs器件属性文件。
- **实例化I3C控制器对象：**
- 实例化I3C控制器对象：
- 初始化I3cCntlr成员。
- 实例化I3cCntlr成员I3cMethod方法集合，其定义和成员函数说明见下文。
- **注册中断处理子程序：**
- 注册中断处理子程序：
为控制器注册中断处理程序，实现设备热接入和IBI（带内中断）功能。
1. **实例化驱动入口**
1. 实例化驱动入口
驱动入口必须为HdfDriverEntry（在 hdf_device_desc.h 中定义）类型的全局变量，且moduleName要和device_info.hcs中保持一致。HDF框架会将所有加载的驱动的HdfDriverEntry对象首地址汇总，形成一个类似数组的段地址空间，方便上层调用。
......@@ -115,21 +106,21 @@ I3C模块适配的四个环节是实例化驱动入口、配置属性文件、
.moduleVersion = 1,
.Init = VirtualI3cInit,
.Release = VirtualI3cRelease,
.moduleName = "virtual_i3c_driver",//【必要且与 HCS 里面的名字匹配】
.moduleName = "virtual_i3c_driver",// 【必要且与hcs文件中的名字匹配】
};
HDF_INIT(g_virtualI3cDriverEntry); //调用HDF_INIT将驱动入口注册到HDF框架中
HDF_INIT(g_virtualI3cDriverEntry); // 调用HDF_INIT将驱动入口注册到HDF框架中
/* 核心层i3c_core.c管理器服务的驱动入口 */
struct HdfDriverEntry g_i3cManagerEntry = {
.moduleVersion = 1,
.Init = I3cManagerInit,
.Release = I3cManagerRelease,
.moduleName = "HDF_PLATFORM_I3C_MANAGER",//这与device_info文件中device0对应
.moduleName = "HDF_PLATFORM_I3C_MANAGER",// 这与device_info文件中device0对应
};
HDF_INIT(g_i3cManagerEntry);
```
2. **配置属性文件**
2. 配置属性文件
完成驱动入口注册之后，下一步请在device_info.hcs文件中添加deviceNode信息，并在i3c_config.hcs中配置器件属性。deviceNode信息与驱动入口注册相关，器件属性值对于厂商驱动的实现以及核心层I3cCntlr相关成员的默认值或限制范围有密切关系。
......@@ -144,7 +135,7 @@ I3C模块适配的四个环节是实例化驱动入口、配置属性文件、
从第二个节点开始配置具体I3C控制器信息，此节点并不表示某一路I3C控制器，而是代表一个资源性质设备，用于描述一类I3C控制器的信息。本例只有一个I3C控制器，如有多个控制器，则需要在device_info文件增加deviceNode信息，以及在i3c_config文件中增加对应的器件属性。
- device_info.hcs 配置参考
- device_info.hcs配置参考
```c
root {
......@@ -161,9 +152,9 @@ I3C模块适配的四个环节是实例化驱动入口、配置属性文件、
policy = 0; // 等于0，不需要发布服务
priority = 56; // 驱动启动优先级
permission = 0644; // 驱动创建设备节点权限
moduleName = "virtual_i3c_driver"; //【必要】用于指定驱动名称，需要与期望的驱动Entry中的moduleName一致；
serviceName = "VIRTUAL_I3C_DRIVER"; //【必要】驱动对外发布服务的名称，必须唯一
deviceMatchAttr = "virtual_i3c"; //【必要】用于配置控制器私有数据，要与i3c_config.hcs中对应控制器保持一致
moduleName = "virtual_i3c_driver"; // 【必要】用于指定驱动名称，需要与期望的驱动Entry中的moduleName一致；
serviceName = "VIRTUAL_I3C_DRIVER"; // 【必要】驱动对外发布服务的名称，必须唯一
deviceMatchAttr = "virtual_i3c"; // 【必要】用于配置控制器私有数据，要与i3c_config.hcs中对应控制器保持一致
} // 具体的控制器信息在 i3c_config.hcs 中
}
```
......@@ -174,17 +165,17 @@ I3C模块适配的四个环节是实例化驱动入口、配置属性文件、
root {
platform {
i3c_config {
match_attr = "virtual_i3c"; //【必要】需要和device_info.hcs中的deviceMatchAttr值一致
match_attr = "virtual_i3c"; // 【必要】需要和device_info.hcs中的deviceMatchAttr值一致
template i3c_controller { // 模板公共参数，继承该模板的节点如果使用模板中的默认值，则节点字段可以缺省
busId = 0; //【必要】i3c总线号
busId = 0; // 【必要】i3c总线号
busMode = 0x0; // 总线模式，0x0:纯净; 0x1:混合高速; 0x2:混合受限; 0x3: 混合低速;
regBasePhy = 0x120b0000; //【必要】物理基地址
regSize = 0xd1; //【必要】寄存器位宽
IrqNum = 20; //【必要】中断号
i3cMaxRate = 12900000; //【可选】i3c模式最大时钟速率
i3cRate = 12500000; //【可选】i3c模式时钟速率
i2cFmRate = 1000000; //【可选】i2c FM模式时钟速率
i2cFmPlusRate = 400000; //【可选】i2c FM+模式时钟速率
regBasePhy = 0x120b0000; // 【必要】物理基地址
regSize = 0xd1; // 【必要】寄存器位宽
IrqNum = 20; // 【必要】中断号
i3cMaxRate = 12900000; // 【可选】i3c模式最大时钟速率
i3cRate = 12500000; // 【可选】i3c模式时钟速率
i2cFmRate = 1000000; // 【可选】i2c FM模式时钟速率
i2cFmPlusRate = 400000; // 【可选】i2c FM+模式时钟速率
}
controller_0 :: i3c_controller {
busId = 18;
......@@ -195,7 +186,7 @@ I3C模块适配的四个环节是实例化驱动入口、配置属性文件、
}
```
3. **实例化I3C控制器对象**
3. 实例化I3C控制器对象
配置属性文件完成后，要以核心层I3cCntlr对象的初始化为核心，包括厂商自定义结构体（传递参数和数据），实例化I3cCntlr成员I3cMethod（让用户可以通过接口来调用驱动底层函数）。
......@@ -207,11 +198,11 @@ I3C模块适配的四个环节是实例化驱动入口、配置属性文件、
```c
struct VirtualI3cCntlr {
struct I3cCntlr cntlr; //【必要】是核心层控制对象，具体描述见下面
volatile unsigned char *regBase;//【必要】寄存器基地址
uint32_t regBasePhy; //【必要】寄存器物理基地址
uint32_t regSize; //【必要】寄存器位宽
uint16_t busId; //【必要】设备号
struct I3cCntlr cntlr; // 【必要】是核心层控制对象，具体描述见下面
volatile unsigned char *regBase;// 【必要】寄存器基地址
uint32_t regBasePhy; // 【必要】寄存器物理基地址
uint32_t regSize; // 【必要】寄存器位宽
uint16_t busId; // 【必要】设备号
uint16_t busMode;
uint16_t IrqNum;
uint32_t i3cMaxRate;
......@@ -261,34 +252,34 @@ I3C模块适配的四个环节是实例化驱动入口、配置属性文件、
static int32_t VirtualI3cParseAndInit(struct HdfDeviceObject *device, const struct DeviceResourceNode *node)
{
int32_t ret;
struct VirtualI3cCntlr *virtual = NULL; //【必要】自定义结构体对象
struct VirtualI3cCntlr *virtual = NULL; // 【必要】自定义结构体对象
(void)device;
virtual = (struct VirtualI3cCntlr *)OsalMemCalloc(sizeof(*virtual)); //【必要】内存分配
virtual = (struct VirtualI3cCntlr *)OsalMemCalloc(sizeof(*virtual)); // 【必要】内存分配
if (virtual == NULL) {
HDF_LOGE("%s: Malloc virtual fail!", __func__);
return HDF_ERR_MALLOC_FAIL;
}
ret = VirtualI3cReadDrs(virtual, node); //【必要】将i3c_config文件的默认值填充到结构体中
ret = VirtualI3cReadDrs(virtual, node); // 【必要】将i3c_config文件的默认值填充到结构体中
if (ret != HDF_SUCCESS) {
HDF_LOGE("%s: Read drs fail! ret:%d", __func__, ret);
goto __ERR__;
}
...
virtual->regBase = OsalIoRemap(virtual->regBasePhy, virtual->regSize);//【必要】地址映射
virtual->regBase = OsalIoRemap(virtual->regBasePhy, virtual->regSize);// 【必要】地址映射
ret = OsalRegisterIrq(hi35xx->softIrqNum, OSAL_IRQF_TRIGGER_NONE, I3cIbiHandle, "I3C", virtual); //【必要】注册中断程序
if (ret != HDF_SUCCESS) {
HDF_LOGE("%s: register irq failed!", __func__);
return ret;
}
...
VirtualI3cCntlrInit(virtual); //【必要】I3C设备的初始化
virtual->cntlr.priv = (void *)node; //【必要】存储设备属性
virtual->cntlr.busId = virtual->busId; //【必要】初始化I3cCntlr成员
virtual->cntlr.ops = &g_method; //【必要】I3cMethod的实例化对象的挂载
VirtualI3cCntlrInit(virtual); // 【必要】I3C设备的初始化
virtual->cntlr.priv = (void *)node; // 【必要】存储设备属性
virtual->cntlr.busId = virtual->busId; // 【必要】初始化I3cCntlr成员
virtual->cntlr.ops = &g_method; // 【必要】I3cMethod的实例化对象的挂载
(void)OsalSpinInit(&virtual->spin);
ret = I3cCntlrAdd(&virtual->cntlr); //【必要且重要】调用此函数将控制器添加至核心，返回成功信号后驱动才完全接入平台核心层
ret = I3cCntlrAdd(&virtual->cntlr); // 【必要且重要】调用此函数将控制器添加至核心，返回成功信号后驱动才完全接入平台核心层
if (ret != HDF_SUCCESS) {
HDF_LOGE("%s: add i3c controller failed! ret = %d", __func__, ret);
(void)OsalSpinDestroy(&virtual->spin);
......@@ -296,7 +287,7 @@ I3C模块适配的四个环节是实例化驱动入口、配置属性文件、
}
return HDF_SUCCESS;
__ERR__: //若控制器添加失败，需要执行去初始化相关函数
__ERR__: // 若控制器添加失败，需要执行去初始化相关函数
if (virtual != NULL) {
OsalMemFree(virtual);
virtual = NULL;
......@@ -326,16 +317,16 @@ I3C模块适配的四个环节是实例化驱动入口、配置属性文件、
}
```
- Release 函数参考
- Release函数参考
**入参：**
HdfDeviceObject 是整个驱动对外暴露的接口参数，具备 HCS 配置文件的信息 。
HdfDeviceObject 是整个驱动对外暴露的接口参数，具备hcs配置文件的信息 。
**返回值：**
无。
**函数说明：**
释放内存和删除控制器，该函数需要在驱动入口结构体中赋值给 Release 接口， 当HDF框架调用Init函数初始化驱动失败时，可以调用 Release 释放驱动资源。所有强制转换获取相应对象的操作**前提**是在Init函数中具备对应赋值的操作。
释放内存和删除控制器，该函数需要在驱动入口结构体中赋值给Release接口，当HDF框架调用Init函数初始化驱动失败时，可以调用Release释放驱动资源。所有强制转换获取相应对象的操作**前提**是在Init函数中具备对应赋值的操作。
```c
static void VirtualI3cRemoveByNode(const struct DeviceResourceNode *node)
......@@ -362,8 +353,8 @@ I3C模块适配的四个环节是实例化驱动入口、配置属性文件、
cntlr = I3cCntlrGet(busId);
if (cntlr != NULL && cntlr->priv == node) {
I3cCntlrPut(cntlr);
I3cCntlrRemove(cntlr); //【必要】主要是从管理器驱动那边移除I3cCntlr对象
virtual = (struct VirtualI3cCntlr *)cntlr;//【必要】通过强制转换获取自定义的对象并进行release操作
I3cCntlrRemove(cntlr); // 【必要】主要是从管理器驱动那边移除I3cCntlr对象
virtual = (struct VirtualI3cCntlr *)cntlr;// 【必要】通过强制转换获取自定义的对象并进行release操作
(void)OsalSpinDestroy(&virtual->spin);
OsalMemFree(virtual);
}
......@@ -381,14 +372,14 @@ I3C模块适配的四个环节是实例化驱动入口、配置属性文件、
return;
}
...
//遍历、解析i3c_config.hcs中的所有配置节点，并分别进行release操作
// 遍历、解析i3c_config.hcs中的所有配置节点，并分别进行release操作
DEV_RES_NODE_FOR_EACH_CHILD_NODE(device->property, childNode) {
VirtualI3cRemoveByNode(childNode); //函数定义如上
}
}
```
4. **注册中断处理子程序**
4. 注册中断处理子程序
在中断处理程序中通过判断中断产生的地址，实现热接入、IBI等操作。
......
Markdown is supported
0% 或 .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑！
想要评论请 注册 或