linux笔记—rtc子系统

发表于 2017-08-19 更新于 2023-12-14 分类于 Linux/linux学习阅读次数： Disqus：本文字数： 9.8k 阅读时长 ≈ 9 分钟

正式开始让人崩溃的 linux 系列，希望自己能写完。
先拿 rtc 开刀。
这里我尽可能记录下思维的细节，而不是仅局限于代码，希望自己能领会 Linux 内核开发者的想法。
内核版本：linux4.1
需要了解：简略了解字符驱动和 Linux 设备驱动模型

RTC

rtc 即 real time clock，实时时钟。
rtc 一般负责系统关机后计时，面对繁多的 Linux RTC 设备，内核干脆提供了一个 rtc 子系统，来支持所有的 rtc 设备。
参考资料

Rtc 子系统

rtc 设备本质上是一个字符设备，rtc 子系统在字符设备的基础上抽象与硬件无关的部分，并在这个基础上拓展 sysfs 和 proc 文件系统下的访问。
分析时候始终记住两点：
- rtc 子系统是为了让 rtc 设备驱动编写更为简单，与硬件无关部分已被抽离。
- rtc 子系统是基于字符设备而来的。

文件框架

rtc 子系统的源码在 /drivers/rtc

删减了很多 rtc-xxx.c 的驱动，只留下了 ds1307 作为示例，这里看到实际上代码并不多。
具体文件分析
- rtc.h：定义与 RTC 有关的数据结构。
- class.c：向内核注册 RTC 类，为底层驱动提供 rtc_device_register 与 rtc_device_unregister 接口用于 RTC 设备的注册/注销。初始化 RTC 设备结构、sysfs、proc。
- Interface.c：提供用户程序与 RTC 的接口函数，其中包括 ioctl 命令。
- rtc-dev.c：将 RTC 设备抽象为通用的字符设备，提供文件操作函数集。
- rtc-sysfs.c：管理 RTC 设备的 sysfs 属性，获取 RTC 设备名、日期、时间等。
- rtc-proc.c：管理 RTC 设备的 procfs 属性，提供中断状态和标志查询。
- rtc-lib.c：提供 RTC、Data 和 Time 之间的转换函数。
- rtc-xxx,c：RTC 设备的实际驱动，此处以 rtc-ds1307 为例。
- hctosys.c：开机时获取 RTC 时间。
RTC 子系统具体可分为 3 层：
- 用户层：RTC 子系统向上层提供了接口，用户通过虚拟文件系统，间接调用 RTC 设备，具体有 3 种方式。
  - /dev/rtc RTC 设备抽象而来的字符设备，常规文件操作集合。
  - /sys/class/rtc/rtcx 通过 sysfs 文件系统进行 RTC 操作，也是最常用的方式。
  - /proc/driver/rtc 通过 proc 文件系统获取 RTC 相关信息。
- RTC 核心层：与硬件无关，用于管理 RTC 设备注册/注销、提供上层文件操作的接口等。
- RTC 驱动：特定 RTC 设备的驱动程序，实现 RTC 核心层的回掉函数。编写 RTC 驱动需要按照 RTC 子系统的接口填写对应函数并建立映射即可。RTC 核心层函数实现的过程和数量与特定硬件紧密相关。
初看 linux 系统的人来说，这个图够头晕的了，但是呢，实际上没那么麻烦。由浅入深，一点一点来分析。

Rtc 子系统分析

Rtc-dev

rtc 子系统基于字符设备，字符设备对应的肯定是 rtc-dev.c 了，我们的分析由 rtc-dev 起步。
rtc-dev.c
典型的字符设备，模块的初始化/卸载自然是 rtc_dev_init(void) 和 rtc_dev_exit(void)。
设备接入，添加/删除设备 rtc_dev_add_device(struct rtc_device _rtc) 和 e) void rtc_dev_del_device(struct rtc_device_rtc)
还有 ioctl 和 open 等函数，熟悉字符设备驱动的不用多说。
追踪一下这两组函数在哪里调用的。
- rtc_dev_init(void) 对应在 class.c 的 rtc_init(void) 函数
- rtc_dev_add_device 对应在 class.c 的 rtc_device_register() 函数。
rtc_dev_init(void) 对应实在系统初始化时使用，对应 rtc_init(void) 也是在系统初始化之后调用。
rtc_dev_add_device() 是在驱动匹配后调用，rtc_device_register() 也是在驱动匹配后调用。打开 rtc-ds1307.c>-prob 函数，能找到 rtc_device_register() 也就证实了这个思路。
接下来转入 class.c

class.c

linux 驱动模型中 class.c 对应类的意思，是 rtc 类。
每个 class 对应都有自己核心数据结果，对应 rtc 类就是 rtc-device

rtc_device
rtc_device 代表 RTC 设备基础的数据结构

数据结构

 struct rtc_device  {
 struct device dev;
 struct module *owner;
 int id;                                   //RTC设备的次设备号
 char name[RTC_DEVICE_NAME_SIZE];
 const struct rtc_class_ops *ops;
 struct mutex ops_lock;
 struct cdev char_dev;
 unsigned long flags;
 unsigned long irq_data;
 spinlock_t irq_lock;
 wait_queue_head_t irq_queue;
 struct fasync_struct *async_queue;
 struct rtc_task *irq_task;
 spinlock_t irq_task_lock;
 int irq_freq;
 int max_user_freq;
 #ifdef CONFIG_RTC_INTF_DEV_UIE_EMUL
 struct work_struct uie_task;
 struct timer_list uie_timer;
 /* Those fields are protected by rtc->irq_lock */
 unsigned int oldsecs;
 unsigned int uie_irq_active:1;
 unsigned int stop_uie_polling:1;
 unsigned int uie_task_active:1;
 unsigned int uie_timer_active:1;
#endif
};

很长？很😵对不对？只要关注一点就行 _


int id;                                              //代表是那个rtc设备
char name[RTC_DEVICE_NAME_SIZE];                     //代表rtc设备的名称
const struct rtc_class_ops *ops;                     //rtc操作函数集，需要驱动实现
struct mutex ops_lock;                               //操作函数集的互斥锁

struct cdev char_dev;                                //代表rtc字符设备，因为rtc就是个字符设备
unsigned long flags;                                 //rtc的状态标志，例如RTC_DEV_BUSY

上文书说到，驱动程序的 prob 函数里面调用了 rtc_device_register() 这货的类型就是 rtc_device。参加驱动程序怎样调用 rtc_device_register(),与其他核心的基本结构不同的是，驱动程序以不是以 rtc-device 为参数注册设备到子系统，而是注册函数会返回一个 rtc_deivce 的结构给驱动。

rtc_class_ops
这个是 rtc_device 的一部分。_

数据结构

struct rtc_class_ops {
int (*open)(struct device *);     //打开设备时的回调函数，这个函数应该初始化硬件并申请资源
void (*release)(struct device *); //这个函数是设备关闭时被调用的，应该注销申请的资源
int (*ioctl)(struct device *, unsigned int, unsigned long); //ioctl函数，对想让RTC自己实现的命令应返回ENOIOCTLCMD
int (*read_time)(struct device *, struct rtc_time *);       //读取时间
int (*set_time)(struct device *, struct rtc_time *);        //设置时间
int (*read_alarm)(struct device *, struct rtc_wkalrm *);    //读取下一次定时中断的时间
int (*set_alarm)(struct device *, struct rtc_wkalrm *);     //设置下一次定时中断的时间
int (*proc)(struct device *, struct seq_file *);            //procfs接口
int (*set_mmss)(struct device *, unsigned long secs);       //将传入的参数secs转换为struct rtc_time然后调用set_time函数。程序员可以不实现这个函数，但  前提是定义好了read_time/set_time，因为RTC框架需要用这两个函数来实现这个功能。
int (*irq_set_state)(struct device *, int enabled);         //周期采样中断的开关，根据enabled的值来设置
int (*irq_set_freq)(struct device *, int freq);             //设置周期中断的频率
int (*read_callback)(struct device *, int data);            ///用户空间获得数据后会传入读取的数据，并用这个函数返回的数据更新数据。
int (*alarm_irq_enable)(struct device *, unsigned int enabled);  //alarm中断使能开关，根据enabled的值来设置
int (*update_irq_enable)(struct device*, unsigned int enabled); //更新中断使能开关，根据enabled的值来设置
};

该结构体中函数大多数都是和 rtc 芯片的操作有关，需要驱动程序实现。
所有 RTC 驱动都必须实现 read_time、set_time 函数，其他函数可选。

参考其他的资料，class 的分析如下
static int __init rtc_init(void)
- 调用 class_create 创建 RTC 类，创建/sys/class/rtc 目录，初始化 RTC 类相关成员，向用户空间提供设备信息。
- 调用 rtc-dev.c 实现的 rtc_dev_init(); 动态分配 RTC 字符设备的设备号。
- 调用 rtc_sysfs_init(rtc_class)；创建/sys/class/rtc 下属性文件 _
static void _exit rtc_exit(void)
- 调用 rtc-dev.c 实现的 rtc_dev_exit()；注销设备号。
- 调用 class_destroy(rtc_class)；注销/sys/class 下的 rtc 目录
struct rtc_device *rtc_device_register(const char *name, struct device *dev,const struct rtc_class_ops *ops,struct module *owner）_
- 申请一个 idr 整数 ID 管理机制结构体，并且初始化相关成员
- 将设备 dev 关联 sysfs 下的 rtc 类
- 初始化 rtc 结构体的信号量
- 初始化 rtc 结构体中的中断
- 设置 rtc 的名字
- 初始化 rtc 字符设备的设备号，然后注册 rtc 设备,自动创建/dev/rtc(n) 设备节点文件
- 注册字符设备
- 在/sys/rtc/目录下创建一个闹钟属性文件
- 创建/proc/driver/rtc 目录
void rtc_device_unregister(struct rtc_device *rtc)
- 删除 sysfs 中的 rtc 设备,即删除/sys/class/rtc 目录
- 删除 dev 下的/dev/rtc(n) 设备节点文件
- 删除虚拟文件系统接口,即删除/proc/driver/rtc 目录
- 卸载字符设备
- 清空 rtc 的操作函数指针 rtc->ops
- 释放 rtc 的 device 结构体 _
static void rtc_device_release(struct device dev)
- 卸载 idr 数字管理机制结构体
- 释放 rtc 结构体的内存

Rtc 子系统初始化

上图
使用 rtc 子系统首先需要在内核编译选项中启用 RTC 子系统支持。
- 必须启用 Real Time Clock
- 使用/dev 下的设备文件对应开启 CONFIG_RTC_INTF_DEV
- 使用/proc 下的接口对应开启 CONFIG_RTC_INTF_PROC
- 使用/sysfs 下的接口对应开启 CONFIG_RTC_INTF_SYSFS
_ 系统启动后，如配置启用 rtc 子系统，则会首先执行 rtc_init_ 函数，创建 rtc 类、初始化相关成员、分配设备号等
创建 rtc 类后，之后调用 rtc_dev_init() 动态分配 rtc 字符设备的设备号。之后调用 rtc_sysfs_init() 初始化/sys/class/rtc 目录中的属性文件

Rtc 设备注册

Rtc 设备本质上属于字符设备，依附于系统内总线。一般来说 cpu 内部 rtc 依附于 platform 总线，外置 rtc 芯片则依附于通信方式对应总线。其过程与通用字符设备相似，rtc 子系统在设备注册过程中附加了 prob 和 sysfs 相关的注册和初始化操作。
上图
Rtc 设备挂载后，相应总线会搜索匹配的驱动程序，驱动程序成功 match 后，进入驱动实现的 probe 函数，执行设备注册等操作。
完成总线设备注册后，probe 会跳转到 rtc_device_register() 函数，将设备注册到 rtc 子系统。
Rtc 设备本质属于字符设备，会调用 rtc_dev_prepare() 函数，初始化字符设备，设置 rtc 相关的 file operation 函数集合。
之后依次调用 rtc_dev_add_device(rtc)、rtc_sysfs_add_device(rtc)、rtc_proc_add_device(rtc) ，进行注册字符设备、在/sys/rtc/目录下创建一个闹钟属性文件、创建/proc/driver/rtc 目录等操作。
rtc_device_register() 会将驱动实现的 rtc_class_ops 结构体与具体设备联系起来。

interface.c

在 rtc-proc.c、rtc_sysfs 和 ioctl 命令中，所有的操作调用的都是 interface.c 提供的接口，这里以 ioctl 的一个例子说明整个调用的过程
上图

以 icotl 命令 RTC_RD_TIME 为例，说明命令调用的流程。

RTC_RD_TIME 对应的是/dev 下 ioctl 命令，调用被转发至/rtc-dev.c
rtc-dev.c->rtc_dev_ioctl(struct file *file,unsigned int cmd, unsigned long arg) 函数中。RTC_RD_TIME 对应的代码为 err = rtc_read_time(rtc, &tm); rtc_read_time 是 interface.c 文件提供的接口之一。
interface.c->rtc_read_time(struct rtc_device *rtc, struct rtc_time *tm) 函数中对应 rtc_class_ops 转发代码为 err = rtc->ops->read_time(rtc->dev.parent, tm); 将操作转发至匹配的 rtc 设备。

设备驱动这里以 rtc-ds1307 为例，但设备注册时通过 mcp794xx_rtc_ops 结构体将 rtc_class_ops 对应函数与驱动程序实现的函数绑定

static const struct rtc_class_ops mcp794xx_rtc_ops = {
.read_time  = ds1307_get_time,
.set_time   = ds1307_set_time,
.read_alarm = mcp794xx_read_alarm,
.set_alarm  = mcp794xx_set_alarm,
.alarm_irq_enable = mcp794xx_alarm_irq_enable,
};

最终执行转入 ds1307.c-> ds1307_get_time 函数，执行与硬件相关的操作。

rtc-sysfs.c

由前半部分可知，/sys/class/rtc/是在 rtc-init 调用 rtc_sysfs_init 后生成。


void __init rtc_sysfs_init(struct class *rtc_class) {
  rtc_class->dev_groups = rtc_groups;
}

这里的 rtc_groups 是 rtc-sysfs.c 中定义了这样一个 attribute 函数指针数组：


static struct attribute *rtc_attrs[] = {
&dev_attr_name.attr,
&dev_attr_date.attr,
&dev_attr_time.attr,
&dev_attr_since_epoch.attr,
&dev_attr_max_user_freq.attr,
&dev_attr_hctosys.attr,
NULL,
};
ATTRIBUTE_GROUPS(rtc);

_ 在 rtc_sysfs_init 函数调用后绑定了 sysfs 节点操作函数的集合，使得设备匹配驱动程序后而生成对应的 rtcn 文件夹。
dev_attr_name和dev_attr_data 由宏 DEVICE_ATTR_RO 和 DEVICE_ATTR_RW 生成，他们分别定义了只读的和可读可写的 attribute 节点。每个属性函数下都有 DEVICE_ATTR_XX() 宏声明，绑定到对应 attribute 节点。

rtc-proc.c

proc 文件系统是软件创建的文件系统，内核通过他向外界导出信息，下面的每一个文件都绑定一个函数，当用户读取这个文件的时候，这个函数会向文件写入信息。

rtc-proc.c 中初始化了 file_operations 结构体：

static const struct file_operations rtc_proc_fops = {
  .open       = rtc_proc_open,
  .read       = seq_read,
  .llseek     = seq_lseek,
  .release    = rtc_proc_release,
};

_RTC 驱动在向 RTC 核心注册自己的时候，由注册函数 rtc_device_resgister 调用 rtc_proc_add_device 来实现 proc 接口的初始化，这个函数如下定义：
1
2
3
4
5
6

void rtc_proc_add_device(struct rtc_device *rtc)
{
if (rtc->id == 0)
proc_create_data("driver/rtc", 0, NULL, &rtc_proc_fops, rtc);
}
主要是完成创建文件节点，并将文件的操作函数与节点联系起来。调用这个函数后，在/proc/driver 目录下就会有一个文件 rtc

Rtc 设备访问

rtc 子系统最多可以支持 16 个 rtc 设备，多个 rtc 设备会在/dev/和 /sys/class/rtc/下生成 rtc0、rtc1…等不同节点 (下文以 rtcn 代称)。而系统启动时会选择一个 rtc 设备读取计时，在/dev 下有 rtc 文件，rtc 文件指向系统选择的 rtc 设备对应的 rtcn（一般为 rtc0）。
用户层访问 rtc 设备有 3 种途径：
- /dev/rtcn open 等字符设备操作和 ioctl 命令。
- /sys/class/rtc/rtcn sysfs 属性，一些属性是只读。
- /proc/driver/rtc 第一个 rtc 会占用 procfs 接口，在 procfs 下暴露更多信息。

/dev

在/dev 下用户可以通过两种方式访问 rtc 设备，第一个是通过字符设备定义的 open、read 等函数（需要驱动程序实现）、另一个是通过定义的 ioctl 命令。第一种方式是直接打开 rtc-dev.c 定义的 open 等函数，在 open 等中直接调用驱动程序实现的函数。通过 ioctl 命令访问则是将操作转发到了 interface.c 定义的接口，间接调用驱动程序实现的函数。
ioctl() 函数访问/dev 下的设备。以下是典型函数：_
- ioctl(fd,RTC_ALM_SET, &rtc_tm);
  设置 alarm 中断的触发时刻，不超过 24 小时。第三个参数为 structrtc_time 结构体，读取时会忽略年月日信息。alarm 中断与 wakeupalarm 中断只能同时使用 1 个，以最后一次设定为准。
- ioctl(fd,RTC_ALM_READ, &rtc_tm)
  读取 alarm 中断的触发时刻。
- ioctl(fd,RTC_WKALM_SET, &alarm);
  设置 wakeupalarm 中断的触发时刻， wakeupalarm 中断的触发时刻可以在未来的任意时刻。alarm 中断与 wakeupalarm 中断只能同时使用 1 个，以最后一次设定为准。
- ioctl(fd,RTC_WKALM_RD, &alarm);
  读取 wakeupalarm 中断的触发时刻。
- ioctl(fd,RTC_IRQP_SET, tmp);
  设置周期中断的频率，tmp 的值必须是 2 的幂，非 Root 用户无法使用 64HZ 以上的周期中断。
- ioctl(fd,RTC_IRQP_READ, &tmp);
  读取周期中断的频率。
- ioctl(fd,RTC_SET_TIME, &rtc_tm)
  更新 RTC 芯片的当前时间。
- ioctl(fd,RTC_RD_TIME, &rtc_tm);
  读取 RTC 硬件中的当前时间。
以 open 操作为例，在用户层对/dev 下设备执行 open 会被转发至 rtc_dev_open(struct inode *inode, struct file *file) 函数，通过 err= ops->open ? ops->open(rtc->dev.parent) : 0; 判断驱动程序是否通过连接的 rtc_class_ops 结构体实现了 open 函数，驱动程序实现了 open 函数，则将 open 操作转发至驱动程序。

/sys

/sys/class/rtc/rtcn 下面的 sysfs 接口提供了操作 rtc 属性的方法，所有的日期时间都是墙上时间，而不是系统时间。
- date: RTC 提供的日期
- hctosys: 如果在内核配置选项中配置了 CONFIG_RTC_HCTOSYS，RTC 会在系统启动的时候提供系统时间，这种情况下这个位就是 1,否则为 0
- max_user_freq: 非特权用户可以从 RTC 得到的最大中断频
- name: RTC 的名字，与 sysfs 目录相关
- since_epoch: 从纪元开始所经历的秒数
- time: RTC 提供的时间
- wakealarm: 唤醒时间的时间事件。这是一种单次的唤醒事件，所以如果还需要唤醒，在唤醒发生后必须复位。这个域的数据结构或者是从纪元开始经历的妙数，或者是相对的秒数

/proc

/proc/driver/rtc 下只对应第一个 rtc 设备，与 sysfs 下相比，该设备暴露更多信息
对应截图

RTC 子系统测试

Hwclock 命令或使用测试文件。

Hwclock 命令可以执行最简单的 RTC 测试。常用命令示例如下
- hwclock #查看RTC时间
- hwclock -set -date=”07/07/17 10:10” #设置硬件RTC时间（月/日/年时: 分: 秒）
- hwclock -w #系统时间同步至RTC
- hwclock -s #同步RTC到系统时间
Linux 内核提供了 RTC 子系统的测试示例文件，位于 tools/testing/selftests/timers/rtctest.c，包含了基于 ioctl 命令的完整测试。