OpenHarmony:全流程讲解如何编写RTC平台驱动以及应用程序 原创 精华
1、程序介绍
本程序是基于OpenHarmony标准系统编写的平台驱动案例:RTC
目前已在凌蒙派-RK3568开发板跑通。详细资料请参考官网:https://gitee.com/Lockzhiner-Electronics/lockzhiner-rk3568-openharmony/tree/master/samples/b09_platform_device_rtc
详细资料请参考官网:
2、基础知识
2.1、RTC简介
RTC(real-time clock)为操作系统中的实时时钟设备,为操作系统提供精准的实时时间和定时报警功能。当设备下电后,通过外置电池供电,RTC继续记录操作系统时间;设备上电后,RTC提供实时时钟给操作系统,确保断电后系统时间的连续性。
2.2、RTC驱动开发
在HDF框架中,RTC的接口适配模式采用独立服务模式,在这种模式下,每一个设备对象会独立发布一个设备服务来处理外部访问,设备管理器收到API的访问请求之后,通过提取该请求的参数,达到调用实际设备对象的相应内部方法的目的。独立服务模式可以直接借助HDFDeviceManager的服务管理能力,但需要为每个设备单独配置设备节点,增加内存占用。
独立服务模式下,核心层不会统一发布一个服务供上层使用,因此这种模式下驱动要为每个控制器发布一个服务,具体表现为:
- 驱动适配者需要实现HdfDriverEntry的Bind钩子函数以绑定服务。
- device_info.hcs文件中deviceNode的policy字段为1或2,不能为0。
2.2.1、RTC驱动开发接口
为了保证上层在调用RTC接口时能够正确的操作硬件,核心层在//drivers/hdf_core/framework/support/platform/include/rtc/rtc_core.h中定义了以下钩子函数。驱动适配者需要在适配层实现这些函数的具体功能,并与这些钩子函数挂接,从而完成接口层与核心层的交互。
RtcMethod定义:
RtcMethod结构体成员的钩子函数功能说明:
2.2.2、RTC驱动开发步骤
RTC模块适配HDF框架包含以下四个步骤:
- 实例化驱动入口。
- 配置属性文件。
- 实例化RTC控制器对象。
- 驱动调试。
我们以//drivers/hdf_core/adapter/khdf/linux/platform/rtc/rtc_adapter.c为例(该rtc驱动是建立于Linux rtc子系统基础上创建)。
2.2.2.1、驱动实例化驱动入口
驱动入口必须为HdfDriverEntry(在hdf_device_desc.h中定义)类型的全局变量,且moduleName要和device_info.hcs中保持一致。
HDF框架会将所有加载的驱动的HdfDriverEntry对象首地址汇总,形成一个类似数组的段地址空间,方便上层调用。
一般在加载驱动时HDF会先调用Bind函数,再调用Init函数加载该驱动。当Init调用异常时,HDF框架会调用Release释放驱动资源并退出。
rtc驱动入口参考:
2.2.2.2、配置属性文件
deviceNode信息与驱动入口注册相关,器件属性值与核心层RTCCntlr成员的默认值或限制范围有密切关系。
本例只有一个RTC控制器,如有多个器件信息,则需要在device_info.hcs文件增加deviceNode信息。
本次案例以rk3568为案例(即文件//vendor/lockzhiner/rk3568/hdf_config/khdf/device_info/device_info.hcs),添加deviceNode描述,具体修改如下:
2.2.2.3、实例化RTC控制器对象
完成属性文件配置之后,下一步就是以核心层RtcHost对象的初始化为核心,包括驱动适配者自定义结构体(传递参数和数据),实例化RtcHost成员RtcMethod(让用户可以通过接口来调用驱动底层函数),实现HdfDriverEntry成员函数(Bind、Init、Release)。
RtcHost成员钩子函数结构体RtcMethod的实例化,其他成员在Init函数中初始化。
2.2.2.4、驱动调试
建议先在Linux下修改确认,再移植到OpenHarmony。
2.3、RTC应用开发
RTC主要用于提供实时时间和定时报警功能。
2.3.1、接口说明
RTC模块提供的主要接口如表1所示,具体API详见//drivers/hdf_core/framework/include/platform/rtc_if.h。
RTC驱动API接口功能介绍如下所示:
(1)RtcOpen
RTC驱动加载成功后,使用驱动框架提供的查询接口并调用RTC设备驱动接口。
RtcOpen参数定义如下:
RtcOpen返回值定义如下:
假设系统中的RTC设备总线号为0,片选号为0,获取该RTC设备句柄的示例如下:
(2)RtcClose
销毁RTC设备句柄,系统释放对应的资源。
RtcClose返回值定义如下:
(3)RtcReadTime
系统从RTC读取时间信息,包括年、月、星期、日、时、分、秒、毫秒。
RtcReadTime参数定义如下:
RtcReadTime返回值定义如下:
(4)RtcWriteTime
设置RTC时间。
RtcWriteTime参数定义如下:
RtcWriteTime返回值定义如下:
(5)RtcReadAlarm
从rtc模块中读取定时报警时间。
RtcReadAlarm参数定义如下:
RtcReadAlarm返回值定义如下:
(6)RtcWriteAlarm
根据报警索引设置RTC报警时间。
RtcWriteAlarm参数定义如下:
RtcWriteAlarm返回值定义如下:
(7)RtcRegisterAlarmCallback
系统启动后需要注册RTC定时报警回调函数,报警超时后触发回调函数。
RtcRegisterAlarmCallback参数定义如下:
RtcRegisterAlarmCallback返回值定义如下:
(8)RtcAlarmInterruptEnable
在启动报警操作前,需要先设置报警中断使能,报警超时后会触发告警回调函数。
RtcAlarmInterruptEnable参数定义如下:
RtcAlarmInterruptEnable返回值定义如下:
2.2.2、开发流程
使用rtc的一般流程如下图所示:
3、程序解析
3.1、准备工作
无
3.2、Linux内核解析
3.2.1、创建Linux内核Git
请参考《OpenHarmony如何为内核打patch》(即Git仓库的//docs/OpenHarmony如何为内核打patch.docx)。
3.2.2、修改设备树PWM7配置
修改//arch/arm64/boot/dts/rockchip/rk3568-lockzhiner-x0.dtsi(即该目录是指已打Patch后的Linux内核,不是OpenHarmony主目录),具体如下所示:
设备树中默认是开启rtc模块的hym8563,读者不用修改。
3.2.3、创建内核patch
请参考《OpenHarmony如何为内核打patch》(即Git仓库的//docs/OpenHarmony如何为内核打patch.docx)。
3.2.4、替换OpenHarmony的内核patch
将制作出的kernel.patch替换到//kernel/linux/patches/linux-5.10/rk3568_patch/kernel.patch即可。
3.2.5、开启内核配置
修改///kernel/linux/config/linux-5.10/arch/arm64/configs/rk3568_standard_defconfig(即该目录是指OpenHarmony主目录),将CONFIG_DRIVERS_HDF_PLATFORM_RTC功能开启,具体如下所示:
另外,Linux配置文件中需要定义rtc设备名称定义,具体如下所示:
3.3、OpenHarmony配置树配置
3.3.1、device_info.hcs
//vendor/lockzhiner/rk3568/hdf_config/khdf/device_info/device_info.hcs已定义好,具体如下:
注意:
- device0是rtc模块,一般只需要1个rtc设备即可。
- policy必须为2,表示对内核态和用户态提供服务。否则,应用程序无法调用。
3.4、OpenHarmony RTC平台驱动
在//drivers/hdf_core/adapter/khdf/linux/platform/rtc/rtc_adapter.c已编写对接Linux RTC驱动的相关代码,具体内容如下:
该部分代码不细述,感兴趣的读者可以去详读。
3.5、应用程序
3.5.1、rtc_test.c
rtc相关头文件如下所示:
主函数定义RTC接口调用,具体如下:
注意:由于目前rtc平台驱动没有定义rtc定时器响应函数接口,故rtc定时回调功能暂时关闭
3.5.2、BUILD.gn
编写应用程序的BUILD.gn,具体内容如下:
3.5.3、参与应用程序编译
编辑//vendor/lockzhiner/rk3568/samples/BUILD.gn,开启编译选项。具体如下:
4、程序编译
建议使用docker编译方法,运行如下:
5、运行结果
运行如下:
开发板重启,可以发现系统相关时间已经变更为我们案例中的配置。
跟着老师一步步学OpenHarmony
很详细的流程讲解