未验证 提交 6699bd5a 编写于 作者: O openharmony_ci 提交者: Gitee

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

Merge pull request !3946 from king_he/i23c
......@@ -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通路,所以对于设备寄存器读写值不做关注,读写寄存器导致的行为由设备自身决定。
示例如下:
......
......@@ -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);
......
# 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控制器句柄 /
......
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册