Linux RTC 驱动实验

RTC 也就是实时时钟，用于记录当前系统时间，对于 Linux 系统而言时间是非常重要的，就和我们使用 Windows 电脑或手机查看时间一样，我们在使用 Linux 设备的时候也需要查看时间。本章我们就来学习一下如何编写 Linux 下的 RTC 驱动程序。

Linux 内核 RTC 驱动简介

RTC 设备驱动是一个标准的字符设备驱动，应用程序通过 open、release、read、write 和 ioctl等函数完成对 RTC 设备的操作。Linux 内核将 RTC 设备抽象为 rtc_device 结构体，因此 RTC 设备驱动就是申请并初始化rtc_device，最后将 rtc_device 注册到 Linux 内核里面，这样 Linux 内核就有一个 RTC 设备了。至于 RTC 设备的操作肯定是用一个操作集合(结构体)来表示的，我们先来看一下 rtc_device 结构体，此结构体定义在 include/linux/rtc.h 文件中，结构体内容如下(删除条件编译)：

我们需要重点关注的是 ops 成员变量，这是一个 rtc_class_ops 类型的指针变量，rtc_class_ops为 RTC 设备的最底层操作函数集合（不是用的默认的file_operations），包括从 RTC 设备中读取时间、向 RTC 设备写入新的时间值等。因此，rtc_class_ops 是需要用户根据所使用的 RTC 设备编写的，此结构体定义在include/linux/rtc.h 文件中，内容如下：

看名字就知道 rtc_class_ops 操作集合中的这些函数是做什么的了，但是我们要注意，rtc_class_ops 中的这些函数只是最底层的 RTC 设备操作函数，并不是提供给应用层的file_operations 函数操作集。

在Linux驱动中，通常将驱动分为上层和下层，比如upper和lower，上层通常指的是与应用程序或系统调用接口交互的部分，而下层则涉及到直接与硬件交互的代码。这种分层设计有助于将硬件特定的细节从通用的软件操作中隔离出来，提高代码的可维护性和可重用性。

RTC 是个字符设备，那么肯定有字符设备的 file_operations 函数操作集，Linux 内核提供了一个 RTC 通用字符设备驱动文件，文件名为 drivers/rtc/rtc-dev.c，rtc-dev.c 文件提供了所有 RTC 设备共用的 file_operations 函数操作集，如下所示：

看到示例代码 60.1.3 是不是很熟悉了，标准的字符设备操作集。应用程序可以通过 ioctl 函数来设置/读取时间，设置/读取闹钟的操作，那么对应的 rtc_dev_ioctl 函数就会执行，rtc_dev_ioctl 最终会通过操作 rtc_class_ops 中的 read_time、set_time 等函数来对具体 RTC 设备的读写操作。我们简单来看一下 rtc_dev_ioctl 函数，函数内容如下(有省略)：

第 333 行，RTC_RD_TIME 为时间读取命令。

第 336 行，如果是读取时间命令的话就调用 rtc_read_time 函数获取当前 RTC 时钟， rtc_read_time 函数会调用__rtc_read_time 函数，__rtc_read_time 函数内容如下：

从示例代码 60.1.5 中的 32 行可以看出，__rtc_read_time 函数会通过调用 rtc_class_ops 中的read_time 来从 RTC 设备中获取当前时间。rtc_dev_ioctl 函数对其他的命令处理都是类似的，比如 RTC_ALM_READ 命令会通过 rtc_read_alarm 函数获取到闹钟值，而 rtc_read_alarm 函数经过层层调用，最终会调用 rtc_class_ops 中的 read_alarm 函数来获取闹钟值。

至此，Linux 内核中 RTC 驱动调用流程就很清晰了，如图 60.1.1 所示：

当 rtc_class_ops 准备好以后需要将其注册到 Linux 内核中，这里我们可以使用rtc_device_register函数完成注册工作。此函数会申请一个rtc_device并且初始化这个rtc_device，最后向调用者返回这个 rtc_device，此函数原型如下：

struct rtc_device *rtc_device_register(const char *name, struct device *dev, const struct rtc_class_ops *ops, struct module *owner)

函数参数和返回值含义如下：

name：设备名字。

dev：设备。

ops：RTC 底层驱动函数集。

owner：驱动模块拥有者。

返回值：注册成功的话就返回 rtc_device，错误的话会返回一个负值。

当卸载 RTC 驱动的时候需要调用 rtc_device_unregister 函数来注销注册的 rtc_device，函数原型如下：

void rtc_device_unregister(struct rtc_device *rtc)

函数参数和返回值含义如下：

rtc：要删除的 rtc_device。

返回值：无。

还有另外一对 rtc_device 注册函数 devm_rtc_device_register 和 devm_rtc_device_unregister，分别为注册和注销 rtc_device。

I.MX6U 内部 RTC 驱动分析

先直接告诉大家，I.MX6U 的 RTC 驱动我们不用自己编写，因为 NXP 已经写好了。其实对于大多数的 SOC 来讲，内部 RTC 驱动都不需要我们去编写，半导体厂商会编写好。但是这不代表我们就偷懒了，虽然不用编写 RTC 驱动，但是我们得看一下这些原厂是怎么编写 RTC 驱动的。

分析驱动，先从设备树入手，打开 imx6ull.dtsi，在里面找到如下 snvs_rtc 设备节点，节点内容如下所示：

第 2 行设置兼容属性 compatible 的值为“fsl,sec-v4.0-mon-rtc-lp”，因此在 Linux 内核源码中搜索此字符串即可找到对应的驱动文件，此文件为 drivers/rtc/rtc-snvs.c，在 rtc-snvs.c 文件中找到如下所示内容：

第 380~383 行，设备树 ID 表，有一条 compatible 属性，值为“fsl,sec-v4.0-mon-rtc-lp”，因此 imx6ull.dtsi 中的 snvs_rtc 设备节点会和此驱动匹配。

第 386~393 行，标准的 platform 驱动框架，当设备和驱动匹配成功以后 snvs_rtc_probe 函数就会执行。我们来看一下 snvs_rtc_probe 函数，函数内容如下(有省略)：

第 253 行，调用 platform_get_resource 函数从设备树中获取到 RTC 外设寄存器基地址。

第 255 行，调用函数 devm_ioremap_resource 完成内存映射，得到 RTC 外设寄存器物理基地址对应的虚拟地址。

第 259 行，Linux3.1 引入了一个全新的 regmap 机制，regmap 用于提供一套方便的 API 函数去操作底层硬件寄存器，以提高代码的可重用性。snvs-rtc.c 文件会采用 regmap 机制来读写RTC 底层硬件寄存器。这里使用 devm_regmap_init_mmio 函数将 RTC 的硬件寄存器转化为regmap 形式，这样 regmap 机制的 regmap_write、regmap_read 等 API 函数才能操作寄存器。

第 270 行，从设备树中获取 RTC 的中断号。

第 289 行，设置 RTC_ LPPGDR 寄存器值为 SNVS_LPPGDR_INIT= 0x41736166，这里就是用的 regmap 机制的 regmap_write 函数完成对寄存器进行写操作。

第 292 行，设置 RTC_LPSR 寄存器，写入 0xffffffff，LPSR 是 RTC 状态寄存器，写 1 清零，因此这一步就是清除 LPSR 寄存器。

第 295 行，调用 snvs_rtc_enable 函数使能 RTC，此函数会设置 RTC_LPCR 寄存器。

第299行，调用devm_request_irq函数请求RTC中断，中断服务函数为snvs_rtc_irq_handler，用于 RTC 闹钟中断。

第 307 行，调用 devm_rtc_device_register 函数向系统注册 rtc_devcie，RTC 底层驱动集为snvs_rtc_ops。snvs_rtc_ops操作集包含了读取/设置RTC时间，读取/设置闹钟等函数。snvs_rtc_ops内容如下：

我们就以第 201 行的 snvs_rtc_read_time 函数为例讲解一下 rtc_class_ops 的各个 RTC 底层操作函数该如何去编写。snvs_rtc_read_time 函数用于读取 RTC 时间值，此函数内容如下所示：

第 129 行，调用 rtc_read_lp_counter 获取 RTC 计数值，这个时间值是秒数。

第 131 行，调用 rtc_time_to_tm 函数将获取到的秒数转换为时间值，也就是 rtc_time 结构体类型，rtc_time 结构体定义如下：

最后我们来看一下 rtc_read_lp_counter 函数，此函数用于读取 RTC 计数值，函数内容如下(有省略)：

第 56~72 行，读取 RTC_LPSRTCMR 和 RTC_LPSRTCLR 这两个寄存器，得到 RTC 的计数值，单位为秒，这个秒数就是当前时间。这里读取了两次 RTC 计数值，因为要读取两个寄存器，因此可能存在读取第二个寄存器的时候时间数据更新了，导致时间不匹配，因此这里连续读两次，如果两次的时间值相等那么就表示时间数据有效。

第 75 行，返回时间值，注意这里将前面读取到的 RTC 计数值右移了 15 位。

这个就是 snvs_rtc_read_time 函数读取 RTC 时间值的过程，至于其他的底层操作函数大家自行分析即可，都是大同小异的，这里就不再分析了。关于 I.MX6U 内部 RTC 驱动源码就讲解到这里。

RTC 时间查看与设置

1、时间 RTC 查看

RTC 是用来计时的，因此最基本的就是查看时间，Linux 内核启动的时候可以看到系统时钟设置信息，如图 60.3.1 所示：

从图 60.3.1 中可以看出，Linux 内核在启动的时候将 snvs_rtc 设置为 rtc0，大家的启动信息可能会和图 60.3.1 中的不同，但是内容基本上都是一样的。

如果要查看时间的话输入“date”命令即可，结果如图 60.3.2 所示：

从图 60.3.2 可以看出，当前时间为 1970 年 1 月 1 日 00:06:11，很明显是时间不对，我们需要重新设置 RTC 时间。

2、设置 RTC 时间

RTC 时间设置也是使用的 date 命令，输入“date --help”命令即可查看 date 命令如何设置系统时间，结果如图 60.3.3 所示：

现在我要设置当前时间为 2019 年 8 月 31 日 18:13:00，因此输入如下命令：

date -s "2019-08-31 18:13:00"

设置完成以后再次使用 date 命令查看一下当前时间就会发现时间改过来了，如图 60.3.4 所示：

大家注意我们使用“date -s”命令仅仅是将当前系统时间设置了，此时间还没有写入到I.MX6U 内部 RTC 里面或其他的 RTC 芯片里面，因此系统重启以后时间又会丢失。我们需要将当前的时间写入到 RTC 里面，这里要用到 hwclock 命令，输入如下命令将系统时间写入到 RTC里面：

hwclock -w //将当前系统时间写入到 RTC 里面

时间写入到 RTC 里面以后就不怕系统重启以后时间丢失了，如果 I.MX6U-ALPHA 开发板底板接了纽扣电池，那么开发板即使断电了时间也不会丢失。大家可以尝试一下不断电重启和断电重启这两种情况下开发板时间会不会丢失。