网站建设与应用,建设银网站,职业教育培训机构排名前十,我想用c 来做网站1、程序介绍
本程序是基于OpenHarmony标准系统编写的平台驱动案例#xff1a;I2C
系统版本:openharmony5.0.0
开发板:dayu200
编译环境:ubuntu22
部署路径#xff1a; //sample/04_platform_i2c
2、基础知识
2.1、I2C简介
I2C#xff08;Inter Integrated CircuitI2C
系统版本:openharmony5.0.0
开发板:dayu200
编译环境:ubuntu22
部署路径 //sample/04_platform_i2c
2、基础知识
2.1、I2C简介
I2CInter Integrated Circuit总线是由Philips公司开发的一种简单、双向二线制同步串行总线。由于其硬件连接简单、成本低廉因此被广泛应用于各种短距离通信的场景。
I2C以主从方式工作通常有一个主设备和一个或者多个从设备主从设备通过SDASerialData串行数据线以及SCLSerialClock串行时钟线两根线相连如下图。
I2C数据的传输必须以一个起始信号作为开始条件以一个结束信号作为传输的停止条件。数据传输以字节为单位高位在前逐个bit进行传输。
I2C总线上的每一个设备都可以作为主设备或者从设备而且每一个设备都会对应一个唯一的地址当主设备需要和某一个从设备通信时通过广播的方式将从设备地址写到总线上如果某个从设备符合此地址将会发出应答信号建立传输。
I2C接口定义了完成I2C传输的通用方法集合包括 I2C控制器管理打开或关闭I2C控制器 I2C消息传输通过消息传输结构体数组进行自定义传输
I2C物理连线示意图 2.2、I2C驱动开发
I2C模块各分层的作用为
接口层提供打开设备数据传输以及关闭设备的能力。核心层主要负责服务绑定、初始化以及释放管理器并提供添加、删除以及获取控制器的能力。适配层由驱动适配者实现与硬件相关的具体功能如控制器的初始化等。 2.2.1、I2C驱动开发接口
为了保证上层在调用I2C接口时能够正确的操作硬件核心层在//drivers/hdf_core/framework/support/platform/include/i2c/i2c_core.h中定义了以下钩子函数。驱动适配者需要在适配层实现这些函数的具体功能并与这些钩子函数挂接从而完成接口层与核心层的交互。
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);
};在适配层中I2cMethod必须被实现I2cLockMethod可根据实际情况考虑是否实现。核心层提供了默认的I2cLockMethod其中使用mutex作为保护临界区的锁
static int32_t I2cCntlrLockDefault(struct I2cCntlr *cntlr)
{if (cntlr NULL) {return HDF_ERR_INVALID_OBJECT;}return OsalMutexLock(cntlr-lock);
}static void I2cCntlrUnlockDefault(struct I2cCntlr *cntlr)
{if (cntlr NULL) {return;}(void)OsalMutexUnlock(cntlr-lock);
}static const struct I2cLockMethod g_i2cLockOpsDefault {.lock I2cCntlrLockDefault,.unlock I2cCntlrUnlockDefault,
};若实际情况不允许使用mutex例如使用者可能在中断上下文调用I2C接口mutex可能导致休眠而中断上下文不允许休眠时驱动适配者可以考虑使用其他类型的锁来实现一个自定义的I2cLockMethod。一旦实现了自定义的I2cLockMethod默认的I2cLockMethod将被覆盖。
I2cMethod结构体成员函数功能说明
函数成员入参出参返回值功能transfercntlr结构体指针核心层I2C控制器。 msgs结构体指针用户消息。 countuint16_t消息数量。无HDF_STATUS相关状态传递用户消息
I2cLockMethod结构体成员函数功能说明
函数成员入参出参返回值功能lockcntlr结构体指针核心层I2C控制器。无HDF_STATUS相关状态获取临界区锁unlockcntlr结构体指针核心层I2C控制器。无HDF_STATUS相关状态释放临界区锁
2.2.2、I2C驱动开发步骤
I2C模块适配HDF框架包含以下四个步骤
实例化驱动入口。配置属性文件。实例化I2C控制器对象。驱动调试。
2.3、I2C应用开发
2.3.1、接口说明
I2C模块提供的主要接口如表1所示具体API详见//drivers/hdf_core/framework/include/platform/i2c_if.h。
I2C驱动API接口功能介绍如下所示
接口名接口描述DevHandle I2cOpen(int16_t number)打开I2C控制器void I2cClose(DevHandle handle)关闭I2C控制器int32_t I2cTransfer(DevHandle handle, struct I2cMsg *msgs, int16_t count)自定义传输
1I2cOpen
在进行I2C通信前首先要调用I2cOpen打开I2C控制器。
DevHandle I2cOpen(int16_t number);I2cOpen参数定义如下
参数参数描述numberI2C控制器号
I2cOpen返回值定义如下
返回值返回值描述NULL打开I2C控制器失败设备句柄打开的I2C控制器设备句柄
假设系统中存在8个I2C控制器编号从0到7以下代码示例为获取3号控制器
DevHandle i2cHandle NULL; /* I2C控制器句柄 //* 打开I2C控制器 */
i2cHandle I2cOpen(3);
if (i2cHandle NULL) {HDF_LOGE(I2cOpen: failed\n);return;
}2I2cClose
I2C通信完成之后需要关闭I2C控制器。
void I2cClose(DevHandle handle); I2cClose参数定义如下
参数参数描述handleI2C控制器设备句柄
3I2cTransfer
i2c消息传输。
int32_t I2cTransfer(DevHandle handle, struct I2cMsg \*msgs, int16_t count);I2cTransfer参数定义如下
参数参数描述handleI2C控制器设备句柄msgs待传输数据的消息结构体数组count消息数组长度
I2cTransfer返回值定义如下
返回值返回值描述正整数成功传输的消息结构体数目负数执行失败
I2C传输消息类型为I2cMsg每个传输消息结构体表示一次读或写通过一个消息数组可以执行若干次的读写组合操作。组合读写示例
int32_t ret;
uint8_t wbuff[2] { 0x12, 0x13 };
uint8_t rbuff[2] { 0 };
struct I2cMsg msgs[2]; /* 自定义传输的消息结构体数组 */
msgs[0].buf wbuff; /* 写入的数据 */
msgs[0].len 2; /* 写入数据长度为2 */
msgs[0].addr 0x5A; /* 写入设备地址为0x5A */
msgs[0].flags 0; /* 传输标记为0默认为写 */
msgs[1].buf rbuff; /* 要读取的数据 */
msgs[1].len 2; /* 读取数据长度为2 */
msgs[1].addr 0x5A; /* 读取设备地址为0x5A */
msgs[1].flags I2C_FLAG_READ /* I2C_FLAG_READ置位 */
/* 进行一次自定义传输传输的消息个数为2 */
ret I2cTransfer(i2cHandle, msgs, 2);
if (ret ! 2) {HDF_LOGE(I2cTransfer: failed, ret %d\n, ret);return;
}2.2.2、开发流程
使用I2C设备的一般流程如下图所示 3、程序解析
3.1、源码目录 3.2、接口流程梳理
I2cOpen执行流程
//drivers\hdf_core\framework\support\platform\src\i2c\i2c_if.c
DevHandle I2cOpen(int16_t number)
|--return (DevHandle)I2cCntlrGet(number);|--return I2cManagerFindCntlr(number);|--struct I2cCntlr *cntlr g_i2cManager-cntlrs[number];|--return cntlrI2cTransfer执行流程
//drivers\hdf_core\framework\support\platform\src\i2c\i2c_if.c
int32_t I2cTransfer(DevHandle handle, struct I2cMsg *msgs, int16_t count)
|--return I2cCntlrTransfer((struct I2cCntlr *)handle, msgs, count);|--return cntlr-ops-transfer(cntlr, msgs, count);由上可见设备节点由全局变量g_i2cManager提供此变量由下文中平台驱动linux_i2c_adapter(drivers\hdf_core\adapter\khdf\linux\platform\i2c\i2c_adapter.c)进行设置。
3.3、平台驱动说明
驱动实例化驱动入口
I2C控制器会出现很多个设备挂接的情况因而在HDF框架中首先会为此类型的设备创建一个管理器对象并同时对外发布一个管理器服务来统一处理外部访问。这样用户需要打开某个设备时会先获取到管理器服务然后管理器服务根据用户指定参数查找到指定设备。
I2C管理器服务的驱动由核心层实现驱动适配者不需要关注这部分内容的实现但在实现Init函数的时候需要调用核心层的I2cCntlrAdd函数它会实现相应功能。
I2C驱动入口开发参考
struct HdfDriverEntry g_i2cLinuxDriverEntry {.moduleVersion 1,.Bind LinuxI2cBind,.Init LinuxI2cInit,.Release LinuxI2cRelease,.moduleName linux_i2c_adapter, // 【必要且与device_info.hcs文件里面匹配】
};
HDF_INIT(g_i2cLinuxDriverEntry); // 调用HDF_INIT将驱动入口注册到HDF框架中/* 核心层i2c_core.c管理器服务的驱动入口 */
struct HdfDriverEntry g_i2cManagerEntry {.moduleVersion 1,.Bind I2cManagerBind,.Init I2cManagerInit,.Release I2cManagerRelease,.moduleName HDF_PLATFORM_I2C_MANAGER, // 这与device_info.hcs文件中device0对应
};
HDF_INIT(g_i2cManagerEntry);配置属性文件
deviceNode信息与驱动入口注册相关器件属性值对于驱动适配者的驱动实现以及核心层I2cCntlr相关成员的默认值或限制范围有密切关系。
统一服务模式的特点是device_info.hcs文件中第一个设备节点必须为I2C管理器其各项参数如下所示
成员名值moduleName固定为HDF_PLATFORM_I2C_MANAGERserviceName固定为HDF_PLATFORM_I2C_MANAGERpolicy具体配置为1或2取决于是否对用户态可见deviceMatchAttr没有使用可忽略
从第二个节点开始配置具体I2C控制器信息此节点并不表示某一路I2C控制器而是代表一个资源性质设备用于描述一类I2C控制器的信息。多个控制器之间相互区分的参数是busId和reg_pbase这在i2c_config.hcs文件中有所体现。如下
//vendor/hihope/rk3568/hdf_config/khdf/device_info/device_info.hcs已定义好具体如下 注意
device1是rk3568原有的配置也是我们需要的作为OpenHarmony的i2c配置。moduleName定义为linux_i2c_adapter表示该节点对应于//drivers/hdf_core/adapter/khdf/linux/platform/i2c/i2c_adapter.c该驱动是对接Linux i2c子系统。
在//vendor/hihope/rk3568/hdf_config/khdf/platform/i2c_config.hcs具体内容如下 注意
controller_0x120b2000是为i2c2准备的。bus用于确定Linux i2c控制器序号。
具体执行流程如下:
//drivers\hdf_core\adapter\khdf\linux\platform\i2c\i2c_adapter.c
// 定义I2cMethod结构体变量g_method实现i2c相应接口
static struct I2cMethod g_method {.transfer LinuxI2cTransfer,
};
static int32_t LinuxI2cInit(struct HdfDeviceObject *device)
|--struct I2cCntlr *cntlr (struct I2cCntlr *)OsalMemCalloc(sizeof(*cntlr));//为I2cCntlr对象分配内存
|--cntlr-ops g_method;//分配i2c相应接口
|--ret I2cCntlrAdd(cntlr);//添加新创建的I2cCntlr对象到全局变量g_i2cManager中|--ret I2cManagerAddCntlr(cntlr);|--manager-cntlrs[cntlr-busId] cntlr;由HDF驱动框架通过init和bind调用此驱动入口注册之后下一步就是以核心层I2cCntlr对象的初始化为核心包括驱动适配者自定义结构体传递参数和数据实例化I2cCntlr成员I2cMethod让用户可以通过接口来调用驱动底层函数实现HdfDriverEntry成员函数BindInitRelease。
3.4、应用程序
3.4.1、i2c_test.c
i2c相关头文件如下所示
#include i2c_if.h // i2c标准接口头文件主函数负责i2c读写操作。
其中读操作源代码具体如下
int main(int argc, char* argv[])
{DevHandle handle NULL;int32_t ret 0;struct I2cMsg msgs[2]; // 消息结构体数组int16_t msgs_count 0;uint8_t wbuff[STRING_MAXSIZE] { 0 };uint8_t rbuff[STRING_MAXSIZE] { 0 };// 解析参数......// 打开i2c控制器handle I2cOpen(m_i2c_number);if (handle NULL) {PRINT_ERROR(I2cOpen failed\n);return -1;}if (m_i2c_flags_read 1) {// 读操作// 设置msgs数组有效数目msgs_count 2;// 初始化msgs[0]该部分为主设备发送从设备的i2c内容msgs[0].addr m_i2c_slave_address;msgs[0].flags toI2cFlags(0, m_i2c_flags_addr_10bit, m_i2c_flags_read_no_ack, m_i2c_flags_ignore_no_ack, m_i2c_flags_no_start, m_i2c_flags_stop);msgs[0].len 1;wbuff[0] m_i2c_reg_address; // 本案例的i2c从设备是第1字节是寄存器地址msgs[0].buf wbuff;// 初始化msgs[1]该部分为主设备读取从设备发送的i2c内容msgs[1].addr m_i2c_slave_address;msgs[1].flags toI2cFlags(1, m_i2c_flags_addr_10bit, m_i2c_flags_read_no_ack, m_i2c_flags_ignore_no_ack, m_i2c_flags_no_start, m_i2c_flags_stop);msgs[1].len m_i2c_read_data_length;msgs[1].buf rbuff;// i2c数据传输传输次数为2次ret I2cTransfer(handle, msgs, msgs_count);if (ret ! msgs_count) {PRINT_ERROR(I2cTransfer(read) failed and ret %d\n, ret);goto out;}printf(I2cTransfer success and read data length %d\n, strlen((char *)rbuff));for (uint32_t i 0; i strlen((char *)rbuff); i) {printf(rbuff[%d] 0x%x\n, i, rbuff[i]);}} else {......}out:// 关闭i2c控制器I2cClose(handle);return ret;
}写操作源代码如下所示
int main(int argc, char* argv[])
{DevHandle handle NULL;int32_t ret 0;struct I2cMsg msgs[2]; // 消息结构体数组int16_t msgs_count 0;uint8_t wbuff[STRING_MAXSIZE] { 0 };uint8_t rbuff[STRING_MAXSIZE] { 0 };// 解析参数......// 打开i2c控制器handle I2cOpen(m_i2c_number);if (handle NULL) {PRINT_ERROR(I2cOpen failed\n);return -1;}if (m_i2c_flags_read 1) {......} else {// 写操作// 设置msgs数组有效数目msgs_count 1;// 初始化msgs[0]该部分为主设备发送从设备的i2c内容msgs[0].addr m_i2c_slave_address;msgs[0].flags toI2cFlags(0, m_i2c_flags_addr_10bit, m_i2c_flags_read_no_ack, m_i2c_flags_ignore_no_ack, m_i2c_flags_no_start, m_i2c_flags_stop);msgs[0].len 2;wbuff[0] m_i2c_reg_address; // 本案例的i2c从设备是第1字节是寄存器地址wbuff[1] m_i2c_reg_value; // 本案例的i2c从设备是第2字节是寄存器数值msgs[0].buf wbuff;// i2c数据传输传输次数为2次ret I2cTransfer(handle, msgs, msgs_count);if (ret ! msgs_count) {PRINT_ERROR(I2cTransfer(write) failed and ret %d\n, ret);goto out;}printf(I2cTransfer success and write reg(%d), data(%d)\n, m_i2c_reg_address, m_i2c_reg_value);}out:// 关闭i2c控制器I2cClose(handle);return ret;
}3.4.2、BUILD.gn
编写应用程序的BUILD.gn具体内容如下
import(//build/ohos.gni)
import(//drivers/hdf_core/adapter/uhdf2/uhdf.gni)print(samples: compile rk3568_i2c_test)
ohos_executable(rk3568_i2c_test) {sources [ i2c_test.c ]include_dirs [$hdf_framework_path/include,$hdf_framework_path/include/core,$hdf_framework_path/include/osal,$hdf_framework_path/include/platform,$hdf_framework_path/include/utils,$hdf_uhdf_path/osal/include,$hdf_uhdf_path/ipc/include,//base/hiviewdfx/hilog/interfaces/native/kits/include,//third_party/bounds_checking_function/include,]deps [$hdf_uhdf_path/platform:libhdf_platform,$hdf_uhdf_path/utils:libhdf_utils,//base/hiviewdfx/hilog/interfaces/native/innerkits:libhilog,]cflags [-Wall,-Wextra,-Werror,-Wno-format,-Wno-format-extra-args,]part_name rk3568_i2c_testinstall_enable true
}3.4.3、bundle.json
编写应用程序的bundle.json具体内容如下
{name: ohos/i2c_test,description: rk3568_i2c_test example.,version: 3.1,license: Apache License 2.0,publishAs: code-segment,segment: {destPath: sample/04_platform_i2c},dirs: {},scripts: {},component: {name: rk3568_i2c_test,subsystem: sample,syscap: [],features: [],adapted_system_type: [mini,small,standard],rom: 10KB,ram: 10KB,deps: {components: [hdf_core,hilog],third_party: []},build: {sub_component: [//sample/04_platform_i2c:rk3568_i2c_test],inner_kits: [],test: []}}
}4、程序编译
sudo ./build.sh --product-name rk3568 --build-target rk3568_i2c_test5、运行结果
通过i2cdetect命令查看发现I2C 5中包含地址为0x15的设备所以直接通过此设备进行测试了。
在i2c调试过程中OpenHarmony还提供Linux i2c-tools工具具体使用方法可以参考这篇。
运行如下 上述命令为查看i2c 5控制器从设备地址21即0x15该地址为开发板外接i2c芯片读取寄存器地址0数据长度为3。
6.参考资料
I2C平台驱动开发I2C应用程序开发 OpenHarmony平台驱动案例–I2C
