时间:2023-09-19 10:14
人气:
作者:admin
本程序是基于OpenHarmony标准系统编写的平台驱动案例:RTC
RTC(real-time clock)为操作系统中的实时时钟设备,为操作系统提供精准的实时时间和定时报警功能。当设备下电后,通过外置电池供电,RTC继续记录操作系统时间;设备上电后,RTC提供实时时钟给操作系统,确保断电后系统时间的连续性。
在HDF框架中,RTC的接口适配模式采用独立服务模式,在这种模式下,每一个设备对象会独立发布一个设备服务来处理外部访问,设备管理器收到API的访问请求之后,通过提取该请求的参数,达到调用实际设备对象的相应内部方法的目的。独立服务模式可以直接借助HDFDeviceManager的服务管理能力,但需要为每个设备单独配置设备节点,增加内存占用。
独立服务模式下,核心层不会统一发布一个服务供上层使用,因此这种模式下驱动要为每个控制器发布一个服务,具体表现为:
驱动适配者需要实现HdfDriverEntry的Bind钩子函数以绑定服务。
device_info.hcs文件中deviceNode的policy字段为1或2,不能为0。
为了保证上层在调用RTC接口时能够正确的操作硬件,核心层在//drivers/hdf_core/framework/support/platform/include/rtc/rtc_core.h中定义了以下钩子函数。驱动适配者需要在适配层实现这些函数的具体功能,并与这些钩子函数挂接,从而完成接口层与核心层的交互。
RtcMethod定义:
struct RtcMethod { int32_t (*ReadTime)(struct RtcHost *host, struct RtcTime *time); int32_t (*WriteTime)(struct RtcHost *host, const struct RtcTime *time); int32_t (*ReadAlarm)(struct RtcHost *host, enum RtcAlarmIndex alarmIndex, struct RtcTime *time); int32_t (*WriteAlarm)(struct RtcHost *host, enum RtcAlarmIndex alarmIndex, const struct RtcTime *time); int32_t (*RegisterAlarmCallback)(struct RtcHost *host, enum RtcAlarmIndex alarmIndex, RtcAlarmCallback cb); int32_t (*AlarmInterruptEnable)(struct RtcHost *host, enum RtcAlarmIndex alarmIndex, uint8_t enable); int32_t (*GetFreq)(struct RtcHost *host, uint32_t *freq); int32_t (*SetFreq)(struct RtcHost *host, uint32_t freq); int32_t (*Reset)(struct RtcHost *host); int32_t (*ReadReg)(struct RtcHost *host, uint8_t usrDefIndex, uint8_t *value); int32_t (*WriteReg)(struct RtcHost *host, uint8_t usrDefIndex, uint8_t value);};
RtcMethod结构体成员的钩子函数功能说明:

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驱动入口参考:
struct HdfDriverEntry g_rtcDriverEntry = { .moduleVersion = 1, .Bind = HiRtcBind, .Init = HiRtcInit, .Release = HiRtcRelease, .moduleName = "HDF_PLATFORM_RTC", //【必要且与HCS文件中里面的moduleName匹配】};/* 调用HDF_INIT将驱动入口注册到HDF框架中 */HDF_INIT(g_rtcDriverEntry);
2.2.2.2、配置属性文件
deviceNode信息与驱动入口注册相关,器件属性值与核心层RTCCntlr成员的默认值或限制范围有密切关系。
本例只有一个RTC控制器,如有多个器件信息,则需要在device_info.hcs文件增加deviceNode信息。
本次案例以rk3568为案例(即文件//vendor/lockzhiner/rk3568/hdf_config/khdf/device_info/device_info.hcs),添加deviceNode描述,具体修改如下:
device_rtc :: device { device0 :: deviceNode { policy = 2; // 驱动服务发布的策略,policy大于等于1(用户态可见为2,仅内核态可见为1) priority = 30; // 驱动启动优先级 permission = 0644; // 驱动创建设备节点权限 moduleName = "HDF_PLATFORM_RTC"; // 驱动名称,该字段的值必须和驱动入口结构的moduleName值一致 serviceName = "HDF_PLATFORM_RTC"; // 驱动对外发布服务的名称,必须唯一 deviceMatchAttr = ""; // 驱动私有数据匹配的关键字,必须和驱动私有数据配置表中的match_attr值一致 }}
2.2.2.3、实例化RTC控制器对象
完成属性文件配置之后,下一步就是以核心层RtcHost对象的初始化为核心,包括驱动适配者自定义结构体(传递参数和数据),实例化RtcHost成员RtcMethod(让用户可以通过接口来调用驱动底层函数),实现HdfDriverEntry成员函数(Bind、Init、Release)。
RtcHost成员钩子函数结构体RtcMethod的实例化,其他成员在Init函数中初始化。
static int32_t HiRtcReadTime(struct RtcHost *host, struct RtcTime *hdfTime);static int32_t HiRtcWriteTime(struct RtcHost *host, const struct RtcTime *hdfTime);static int32_t HiReadAlarm(struct RtcHost *host, enum RtcAlarmIndex alarmIndex, struct RtcTime *hdfTime);static int32_t HiWriteAlarm(struct RtcHost *host, enum RtcAlarmIndex alarmIndex, const struct RtcTime *hdfTime);static int32_t HiAlarmInterruptEnable(struct RtcHost *host, enum RtcAlarmIndex alarmIndex, uint8_t enable);// 定义RtcMethod结构体变量g_method,负责RTC相关接口static struct RtcMethod g_method = { .ReadTime = HiRtcReadTime, .WriteTime = HiRtcWriteTime, .ReadAlarm = HiReadAlarm, .WriteAlarm = HiWriteAlarm, .RegisterAlarmCallback = NULL, .AlarmInterruptEnable = HiAlarmInterruptEnable, .GetFreq = NULL, .SetFreq = NULL, .Reset = NULL, .ReadReg = NULL, .WriteReg = NULL,};
static int32_t HiRtcBind(struct HdfDeviceObject *device);static int32_t HiRtcInit(struct HdfDeviceObject *device);static void HiRtcRelease(struct HdfDeviceObject *device);struct HdfDriverEntry g_rtcDriverEntry = { .moduleVersion = 1, .Bind = HiRtcBind, .Init = HiRtcInit, .Release = HiRtcRelease, .moduleName = "HDF_PLATFORM_RTC", //【必要且与HCS文件中里面的moduleName匹配】};/* 调用HDF_INIT将驱动入口注册到HDF框架中 */HDF_INIT(g_rtcDriverEntry);
2.2.2.4、驱动调试
建议先在Linux下修改确认,再移植到OpenHarmony。
RTC主要用于提供实时时间和定时报警功能。
RTC模块提供的主要接口如表1所示,具体API详见//drivers/hdf_core/framework/include/platform/rtc_if.h。
RTC驱动API接口功能介绍如下所示:

(1)RtcOpen
RTC驱动加载成功后,使用驱动框架提供的查询接口并调用RTC设备驱动接口。
DevHandle RtcOpen(void);
RtcOpen参数定义如下:

RtcOpen返回值定义如下:

假设系统中的RTC设备总线号为0,片选号为0,获取该RTC设备句柄的示例如下:
DevHandle handle = NULL;
/* 获取RTC句柄 */handle = RtcOpen();if (handle == NULL) { /* 错误处理 *