功能简介
RTC(real-time clock)为操作系统中的实时时钟设备,为操作系统提供精准的实时时间和定时报警功能。当设备下电后,通过外置电池供电,RTC继续记录操作系统时间;设备上电后,RTC提供实时时钟给操作系统,确保断电后系统时间的连续性。
运作机制
在HDF框架中,RTC模块采用独立服务模式,在这种模式下,每一个设备对象会独立发布一个设备服务来处理外部访问,设备管理器收到API的访问请求之后,通过提取该请求的参数,达到调用实际设备对象的相应内部方法的目的。独立服务模式可以直接借助HDFDeviceManager的服务管理能力,但需要为每个设备单独配置设备节点,若设备过多会增加内存占用。通常,一个硬件系统中只需要一个RTC设备,因此RTC模块采用独立服务模式较为合适。
独立服务模式下,核心层不会统一发布一个服务供上层使用,因此这种模式下驱动要为每个控制器发布一个服务,具体表现为:
-
驱动适配者需要实现HdfDriverEntry的Bind钩子函数以绑定服务。
-
device_info.hcs文件中deviceNode的policy字段为1或2,不能为0。
RTC模块各分层作用:
-
接口层提供打开RTC设备、RTC设备读取时间、RTC设备设置时间、RTC设备读取警报时间、RTC设备设置警报时间、RTC设备定时报警回调函数、RTC设备设置定时报警中断使能去使能、RTC设备设置RTC外频、RTC设备读取RTC外频、复位RTC、设置RTC自定义寄存器配置,读取RTC自定义寄存器配置以及关闭RTC设备的接口。
-
核心层主要提供RTC控制器的创建、销毁,通过钩子函数与适配层交互。
-
适配层主要是将钩子函数的功能实例化,实现具体的功能。
使用指导
场景介绍
RTC主要用于提供实时时间和定时报警功能。
接口说明
RTC模块提供的主要接口如表1所示,具体API详见//drivers/hdf_core/framework/include/platform/rtc_if.h。
表 1 RTC设备API接口功能介绍
接口名 | 接口描述 |
---|---|
DevHandle RtcOpen(void) | 获取RTC设备驱动句柄 |
void RtcClose(DevHandle handle) | 释放RTC设备驱动句柄 |
int32_t RtcReadTime(DevHandle handle, struct RtcTime *time) | 读RTC时间信息 |
int32_t RtcWriteTime(DevHandle handle, const struct RtcTime *time) | 写RTC时间信息,包括年、月、星期、日、时、分、秒、毫秒 |
int32_t RtcReadAlarm(DevHandle handle, enum RtcAlarmIndex alarmIndex, struct RtcTime *time) | 读RTC报警时间信息 |
int32_t RtcWriteAlarm(DevHandle handle, enum RtcAlarmIndex alarmIndex, const struct RtcTime *time) | 写RTC报警时间信息 |
int32_t RtcRegisterAlarmCallback(DevHandle handle, enum RtcAlarmIndex alarmIndex, RtcAlarmCallback cb) | 注册报警超时回调函数 |
int32_t RtcAlarmInterruptEnable(DevHandle handle, enum RtcAlarmIndex alarmIndex, uint8_t enable) | 使能/去使能RTC报警中断 |
int32_t RtcGetFreq(DevHandle handle, uint32_t *freq) | 读RTC外接晶振频率 |
int32_t RtcSetFreq(DevHandle handle, uint32_t freq) | 配置RTC外接晶振频率 |
int32_t RtcReset(DevHandle handle) | RTC复位 |
int32_t RtcReadReg(DevHandle handle, uint8_t usrDefIndex, uint8_t *value) | 读用户自定义寄存器 |
int32_t RtcWriteReg(DevHandle handle, uint8_t usrDefIndex, uint8_t value) | 写用户自定义寄存器 |
使用流程
使用RTC设备的一般流程如图2所示。
图 2 RTC设备使用流程图
创建RTC设备句柄
RTC驱动加载成功后,使用驱动框架提供的查询接口并调用RTC设备驱动接口。
说明:
当前操作系统仅支持一个RTC设备。本文涉及的RTC的所有接口,支持内核态及用户态使用。
DevHandle RtcOpen(void);
表 2 RtcOpen参数和返回值描述
参数 | 描述 |
---|---|
void | NA |
返回值 | 描述 |
handle | 获取对应的RTC设备句柄成功 |
NULL | 获取对应的RTC设备句柄成功失败 |
DevHandle handle = NULL;
// 获取RTC句柄
handle = RtcOpen();
if (handle == NULL) {
// 错误处理
HDF_LOGE("open rtc fail!");
return HDF_FAILURE;
}
注册RTC定时报警回调函数
系统启动后需要注册RTC定时报警回调函数,报警超时后触发回调函数。
int32_t RtcRegisterAlarmCallback(DevHandle handle, enum RtcAlarmIndex alarmIndex, RtcAlarmCallback cb);
表 3 RtcRegisterAlarmCallback参数和返回值描述
参数 | 描述 |
---|---|
handle | DevHandle类型,RTC设备句柄 |
alarmIndex | 枚举类型,报警索引 |
cb | 定时报警回调函数 |
返回值 | 描述 |
HDF_SUCCESS | 操作成功 |
负数 | 操作失败 |
注册RTC_ALARM_INDEX_A的定时报警处理函数, 示例如下:
// 用户注册RTC定时报警回调函数的方法
int32_t RtcAlarmACallback(enum RtcAlarmIndex alarmIndex)
{
if (alarmIndex == RTC_ALARM_INDEX_A) {
// 报警A的处理
HDF_LOGD("RTC Alarm A callback function\n\r");
return HDF_SUCCESS;
} else if (alarmIn