Skip to content

D
Docs

OpenHarmony / Docs
1 年多 前同步成功

通知 159
Star 292
Fork 28
D
Docs
未验证 提交 c5ae4dd6 编写于 作者: K king_he 提交者： Gitee
浏览文件
操作

update zh-cn/device-dev/driver/driver-platform-i2c-develop.md. 

Signed-off-by: Nking_he <6384784@qq.com>
上级 ce1ee779
隐藏空白更改
内联 并排
Showing with 52 addition and 52 deletion
zh-cn/device-dev/driver/driver-platform-i2c-develop.md
浏览文件 @ c5ae4dd6
......@@ -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);
......
Markdown is supported
0% 或 .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑！
想要评论请 注册 或