Linux-4.5.1下的RTC实时时钟

最新推荐文章于 2024-05-16 19:21:42 发布
雨落樱殇
最新推荐文章于 2024-05-16 19:21:42 发布
阅读量242
点赞数 1
分类专栏： Linux内核文章标签： linux rtc
本文链接：https://blog.csdn.net/xyy_ywqs/article/details/106015676
版权
Linux内核专栏收录该内容
5 篇文章 0 订阅
订阅专栏
RTC（Real - Time Clock，简称RTC）实时时钟为操作系统提供一个可靠的时间，并且在断电的情况下，RTC实时时钟也可以通过电池供电，一直运行下去。
RTC单元可以在系统电源关闭的情况下依靠备用电池工作，一般主板上都有一个纽扣电池作为实时时钟的电源。RTC可以通过使用STRB / LDDRB这两个ARM指令向CPU传递8位数据（BCD码）。RTC依靠一个外部的32.768kHz的石晶体，产生周期性的脉冲信号。每一个脉冲信号到来时，计数器就加1，通过这种方式，完成计时功能。
*一、RTC的特性： * *
BCD数据；闰年产生器；报警功能；解决了千年虫问题；独立电源引脚RTCVDD；支持ms中断作为TROS内核时钟；循环复位功能。
*二、RTC实时时钟架构 * *
位置： / drives / rtc / Rtc - s3.c
/* drivers/rtc/rtc-s3c.c
 *
 * Copyright (c) 2010 Samsung Electronics Co., Ltd.
 *		http://www.samsung.com/
 *
 * Copyright (c) 2004,2006 Simtec Electronics
 *	Ben Dooks, <ben@simtec.co.uk>
 *	http://armlinux.simtec.co.uk/
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License version 2 as
 * published by the Free Software Foundation.
 *
 * S3C2410/S3C2440/S3C24XX Internal RTC Driver
*/

#include <linux/module.h>
#include <linux/fs.h>
#include <linux/string.h>
#include <linux/init.h>
#include <linux/platform_device.h>
#include <linux/interrupt.h>
#include <linux/rtc.h>
#include <linux/bcd.h>
#include <linux/clk.h>
#include <linux/log2.h>
#include <linux/slab.h>
#include <linux/of.h>
#include <linux/uaccess.h>
#include <linux/io.h>

#include <asm/irq.h>
#include "rtc-s3c.h"

struct s3c_rtc {
	struct device* dev;
	struct rtc_device* rtc;

	void __iomem* base;//虚拟地址
	struct clk* rtc_clk;
	struct clk* rtc_src_clk;
	bool clk_disabled;

	struct s3c_rtc_data* data;

	int irq_alarm;
	int irq_tick;

	spinlock_t pie_lock;//自旋锁
	spinlock_t alarm_clk_lock;

	int ticnt_save, ticnt_en_save;
	bool wake_en;
};

struct s3c_rtc_data {
	int max_user_freq;//频率
	bool needs_src_clk;

	void (*irq_handler) (struct s3c_rtc* info, int mask);
	void (*set_freq) (struct s3c_rtc* info, int freq);//设置
	void (*enable_tick) (struct s3c_rtc* info, struct seq_file* seq);
	void (*select_tick_clk) (struct s3c_rtc* info);
	void (*save_tick_cnt) (struct s3c_rtc* info);
	void (*restore_tick_cnt) (struct s3c_rtc* info);
	void (*enable) (struct s3c_rtc* info);//使能
	void (*disable) (struct s3c_rtc* info);
};

static void s3c_rtc_enable_clk(struct s3c_rtc* info)//使能RTC，有效
{
	unsigned long irq_flags;

	spin_lock_irqsave(&info->alarm_clk_lock, irq_flags);
	if (info->clk_disabled) {
		clk_enable(info->rtc_clk);//RTC时钟信号有效
		if (info->data->needs_src_clk)
			clk_enable(info->rtc_src_clk);
		info->clk_disabled = false;
	}
	spin_unlock_irqrestore(&info->alarm_clk_lock, irq_flags);
}

static void s3c_rtc_disable_clk(struct s3c_rtc* info)
{
	unsigned long irq_flags;

	spin_lock_irqsave(&info->alarm_clk_lock, irq_flags);
	if (!info->clk_disabled) {
		if (info->data->needs_src_clk)
			clk_disable(info->rtc_src_clk);//RTC时钟信号无效
		clk_disable(info->rtc_clk);
		info->clk_disabled = true;
	}
	spin_unlock_irqrestore(&info->alarm_clk_lock, irq_flags);
}

/* IRQ Handlers */
static irqreturn_t s3c_rtc_tickirq(int irq, void* id)
{
	struct s3c_rtc* info = (struct s3c_rtc*)id;

	if (info->data->irq_handler)
		info->data->irq_handler(info, S3C2410_INTP_TIC);

	return IRQ_HANDLED;
}

static irqreturn_t s3c_rtc_alarmirq(int irq, void* id)
{
	struct s3c_rtc* info = (struct s3c_rtc*)id;

	if (info->data->irq_handler)
		info->data->irq_handler(info, S3C2410_INTP_ALM);

	return IRQ_HANDLED;
}

/* Update control registers */
static int s3c_rtc_setaie(struct device* dev, unsigned int enabled)
{
	struct s3c_rtc* info = dev_get_drvdata(dev);
	unsigned int tmp;

	dev_dbg(info->dev, "%s: aie=%d\n", __func__, enabled);

	s3c_rtc_enable_clk(info);//锁住

	tmp = readb(info->base + S3C2410_RTCALM) & ~S3C2410_RTCALM_ALMEN;//读出数据，消除最高位

	if (enabled)
		tmp |= S3C2410_RTCALM_ALMEN;//如果enabled不等于0，则设置最高位为允许脉冲中断

	writeb(tmp, info->base + S3C2410_RTCALM);//将tmp的值写入RTCALM

	s3c_rtc_disable_clk(info);//解锁

	if (enabled)
		s3c_rtc_enable_clk(info);
	else
		s3c_rtc_disable_clk(info);

	return 0;
}

/* Set RTC frequency */
static int s3c_rtc_setfreq(struct s3c_rtc* info, int freq)
{
	if (!is_power_of_2(freq))//判断需要设置的频率freq是不是2的倍数
		return -EINVAL;

	spin_lock_irq(&info->pie_lock);//锁定自旋锁。对临界资源进行保护

	if (info->data->set_freq)
		info->data->set_freq(info, freq);

	spin_unlock_irq(&info->pie_lock);//解除自旋锁

	return 0;
}
//存储在RTC寄存器中的值都是以BCD码的形式保存的，但是Linux驱动程序中使用二进制码形式。
//BCD码到二进制码形式的转换函数：bcd2bin()
//二进制码到BCD码形式的转换函数：bcd2bcd()
/* Time read/write */
static int s3c_rtc_gettime(struct device* dev, struct rtc_time* rtc_tm)//RTC实时时钟获得时间函数
{
	struct s3c_rtc* info = dev_get_drvdata(dev);
	unsigned int have_retried = 0;//重试变量，如果该变量为0，表示可能重新读取寄存器中的时间值

	s3c_rtc_enable_clk(info);

retry_get_time://分别从各个寄存器中读取rtc_tm结构中需要的值
	rtc_tm->tm_min = readb(info->base + S3C2410_RTCMIN);
	rtc_tm->tm_hour = readb(info->base + S3C2410_RTCHOUR);
	rtc_tm->tm_mday = readb(info->base + S3C2410_RTCDATE);
	rtc_tm->tm_mon = readb(info->base + S3C2410_RTCMON);
	rtc_tm->tm_year = readb(info->base + S3C2410_RTCYEAR);
	rtc_tm->tm_sec = readb(info->base + S3C2410_RTCSEC);

	/* the only way to work out whether the system was mid-update
	 * when we read it is to check the second counter, and if it
	 * is zero, then we re-try the entire read
	 */

	if (rtc_tm->tm_sec == 0 && !have_retried) {
		//如果秒寄存器中是0，则表示过来一分钟，那么小时、天、月等寄存器中的值都可能发生变化，则重新读取
		have_retried = 1;
		goto retry_get_time;
	}
	//将BCD码转换到二进制存储到rtc_tm结构的相映成员中，将其作为时间值返回给调用者
	rtc_tm->tm_sec = bcd2bin(rtc_tm->tm_sec);
	rtc_tm->tm_min = bcd2bin(rtc_tm->tm_min);
	rtc_tm->tm_hour = bcd2bin(rtc_tm->tm_hour);
	rtc_tm->tm_mday = bcd2bin(rtc_tm->tm_mday);
	rtc_tm->tm_mon = bcd2bin(rtc_tm->tm_mon);
	rtc_tm->tm_year = bcd2bin(rtc_tm->tm_year);

	s3c_rtc_disable_clk(info);

	rtc_tm->tm_year += 100;//将年数加1，因为存储器中存放的是从1900年开始的时间

	dev_dbg(dev, "read time %04d.%02d.%02d %02d:%02d:%02d\n",
		1900 + rtc_tm->tm_year, rtc_tm->tm_mon, rtc_tm->tm_mday,
		rtc_tm->tm_hour, rtc_tm->tm_min, rtc_tm->tm_sec);//以十六进制的方式打印出这些值

	rtc_tm->tm_mon -= 1;

	return rtc_valid_tm(rtc_tm);
}

static int s3c_rtc_settime(struct device* dev, struct rtc_time* tm)//RTC实时时钟设置时间函数
{
	//时间值分别保存在各个寄存器中
	struct s3c_rtc* info = dev_get_drvdata(dev);
	int year = tm->tm_year - 100;//存储器中存储的时间比实际的时间少100年

	dev_dbg(dev, "set time %04d.%02d.%02d %02d:%02d:%02d\n",
		1900 + tm->tm_year, tm->tm_mon, tm->tm_mday,
		tm->tm_hour, tm->tm_min, tm->tm_sec);//以十六进制的方式打印出这些值

	/* we get around y2k by simply not supporting it */

	if (year < 0 || year >= 100) {//寄存器的限制，只支持100年的时间
		dev_err(dev, "rtc only supports 100 years\n");
		return -EINVAL;
	}

	s3c_rtc_enable_clk(info);
	//将相应的BCD码写到相应的寄存器中
	writeb(bin2bcd(tm->tm_sec), info->base + S3C2410_RTCSEC);
	writeb(bin2bcd(tm->tm_min), info->base + S3C2410_RTCMIN);
	writeb(bin2bcd(tm->tm_hour), info->base + S3C2410_RTCHOUR);
	writeb(bin2bcd(tm->tm_mday), info->base + S3C2410_RTCDATE);
	writeb(bin2bcd(tm->tm_mon + 1), info->base + S3C2410_RTCMON);
	writeb(bin2bcd(year), info->base + S3C2410_RTCYEAR);

	s3c_rtc_disable_clk(info);

	return 0;
}

static int s3c_rtc_getalarm(struct device* dev, struct rtc_wkalrm* alrm)//RTC驱动探测函数，用以获得指定的时刻
{
	//在正常模式和掉电模式下，RTC在指定的时刻会产生一个报警信号。
	//正常模式下，报警中断ALMINT有效，对应INT_RTC引脚。
	//掉电模式下，报警中断ALMINT有效外还产生一个唤醒信号PMWKUP，对应PMWKUP引脚
	//RTC报警寄存器RTCALM决定是否使能报警状态和设置报警条件
	struct s3c_rtc* info = dev_get_drvdata(dev);
	struct rtc_time* alm_tm = &alrm->time;//得到rtc_time表示的报警时间
	unsigned int alm_en;//是否使能报警

	s3c_rtc_enable_clk(info);
	//从各个报警寄存器中独处其值，包括报警时刻的秒、分、小时、月、日期、年
	alm_tm->tm_sec = readb(info->base + S3C2410_ALMSEC);
	alm_tm->tm_min = readb(info->base + S3C2410_ALMMIN);
	alm_tm->tm_hour = readb(info->base + S3C2410_ALMHOUR);
	alm_tm->tm_mon = readb(info->base + S3C2410_ALMMON);
	alm_tm->tm_mday = readb(info->base + S3C2410_ALMDATE);
	alm_tm->tm_year = readb(info->base + S3C2410_ALMYEAR);

	alm_en = readb(info->base + S3C2410_RTCALM);//读出RTCALM寄存器的值及这些寄存器中的值是否有效地标志

	s3c_rtc_disable_clk(info);

	alrm->enabled = (alm_en & S3C2410_RTCALM_ALMEN) ? 1 : 0;//判断所有寄存器中的报警时间是否可用，并将这个结构赋给alrm->enabled

	dev_dbg(dev, "read alarm %d, %04d.%02d.%02d %02d:%02d:%02d\n",
		alm_en,
		1900 + alm_tm->tm_year, alm_tm->tm_mon, alm_tm->tm_mday,
		alm_tm->tm_hour, alm_tm->tm_min, alm_tm->tm_sec);//打印调试信息

	/* decode the alarm enable field */
	if (alm_en & S3C2410_RTCALM_SECEN)//如果秒报警器有效，则将其转换为十进制形式，否则将alm_tm->tm_sec赋为一个无效值-1。
		alm_tm->tm_sec = bcd2bin(alm_tm->tm_sec);//由BCD码转换为十进制的函数
	else
		alm_tm->tm_sec = -1;

	if (alm_en & S3C2410_RTCALM_MINEN)//分报警器
		alm_tm->tm_min = bcd2bin(alm_tm->tm_min);
	else
		alm_tm->tm_min = -1;

	if (alm_en & S3C2410_RTCALM_HOUREN)//小时报警器
		alm_tm->tm_hour = bcd2bin(alm_tm->tm_hour);
	else
		alm_tm->tm_hour = -1;

	if (alm_en & S3C2410_RTCALM_DAYEN)//日报警器
		alm_tm->tm_mday = bcd2bin(alm_tm->tm_mday);
	else
		alm_tm->tm_mday = -1;

	if (alm_en & S3C2410_RTCALM_MONEN) {//月报警器
		alm_tm->tm_mon = bcd2bin(alm_tm->tm_mon);
		alm_tm->tm_mon -= 1;
	}
	else {
		alm_tm->tm_mon = -1;
	}

	if (alm_en & S3C2410_RTCALM_YEAREN)//年报警器
		alm_tm->tm_year = bcd2bin(alm_tm->tm_year);
	else
		alm_tm->tm_year = -1;

	return 0;
}

static int s3c_rtc_setalarm(struct device* dev, struct rtc_wkalrm* alrm)//实时时钟设置报警时间函数
{
	struct s3c_rtc* info = dev_get_drvdata(dev);
	struct rtc_time* tm = &alrm->time;//得到rtc_time表示的报警时间
	unsigned int alrm_en;//是否能报警
	int year = tm->tm_year - 100;

	dev_dbg(dev, "s3c_rtc_setalarm: %d, %04d.%02d.%02d %02d:%02d:%02d\n",
		alrm->enabled,
		1900 + tm->tm_year, tm->tm_mon + 1, tm->tm_mday,
		tm->tm_hour, tm->tm_min, tm->tm_sec);//打印调试信息

	s3c_rtc_enable_clk(info);

	alrm_en = readb(info->base + S3C2410_RTCALM) & S3C2410_RTCALM_ALMEN;//读出RTCALM寄存器第6位的值，表示所有报警功能都打开
	writeb(0x00, info->base + S3C2410_RTCALM);//将00写入RTCALM寄存器，是所有功能都不可用

		writeb(bin2bcd(tm->tm_sec), info->base + S3C2410_ALMSEC);
	if (tm->tm_sec < 60 && tm->tm_sec >= 0) {//设置报警秒寄存器ALMSEC的值，并设置RTCALM寄存器的第0位为1，表示打开秒报警功能
		alrm_en |= S3C2410_RTCALM_SECEN;
		writeb(bin2bcd(tm->tm_sec), info->base + S3C2410_ALMSEC);
	}

	if (tm->tm_min < 60 && tm->tm_min >= 0) {//设置报警分寄存器ALMMIN的值，并设置RTCALM寄存器的第1位为1，表示打开分报警功能
		alrm_en |= S3C2410_RTCALM_MINEN;
		writeb(bin2bcd(tm->tm_min), info->base + S3C2410_ALMMIN);
	}

	if (tm->tm_hour < 24 && tm->tm_hour >= 0) {//设置报警小时寄存器ALMHOUR的值，并设置RTCALM寄存器的第2位为1，表示打开小时报警功能
		alrm_en |= S3C2410_RTCALM_HOUREN;
		writeb(bin2bcd(tm->tm_hour), info->base + S3C2410_ALMHOUR);
	}

	if (year < 100 && year >= 0) {//年
		alrm_en |= S3C2410_RTCALM_YEAREN;
		writeb(bin2bcd(year), info->base + S3C2410_ALMYEAR);
	}

	if (tm->tm_mon < 12 && tm->tm_mon >= 0) {//月
		alrm_en |= S3C2410_RTCALM_MONEN;
		writeb(bin2bcd(tm->tm_mon + 1), info->base + S3C2410_ALMMON);
	}

	if (tm->tm_mday <= 31 && tm->tm_mday >= 1) {//日
		alrm_en |= S3C2410_RTCALM_DAYEN;
		writeb(bin2bcd(tm->tm_mday), info->base + S3C2410_ALMDATE);
	}

	dev_dbg(dev, "setting S3C2410_RTCALM to %08x\n", alrm_en);//打印报警功能的使能状态

	writeb(alrm_en, info->base + S3C2410_RTCALM);//写入

	s3c_rtc_disable_clk(info);

	s3c_rtc_setaie(dev, alrm->enabled);//使能中断唤醒功能

	return 0;
}

static int s3c_rtc_proc(struct device* dev, struct seq_file* seq)//时钟脉冲中断判断函数
{
	//在proc文件系统中，可以读取proc文件系统来判断RTC实时时钟是否支持脉冲中断
	//脉冲中断由TICNT寄存器的最高位决定，最高位为1则表示使能脉冲中断，为0则表示不允许脉冲中断
	struct s3c_rtc* info = dev_get_drvdata(dev);//读取设备的数据

	s3c_rtc_enable_clk(info);

	if (info->data->enable_tick)//为1
		info->data->enable_tick(info, seq);

	s3c_rtc_disable_clk(info);//为0

	return 0;
}

static const struct rtc_class_ops s3c_rtcops = {
	.read_time = s3c_rtc_gettime,//RTC实时时钟获得时间函数
	.set_time = s3c_rtc_settime,//RTC实时时钟设置时间函数
	.read_alarm = s3c_rtc_getalarm,//RTC驱动探测函数
	.set_alarm = s3c_rtc_setalarm,//RTC实时时钟设置报警时间函数
	.proc = s3c_rtc_proc,//RTC时钟脉冲中断判断函数
	.alarm_irq_enable = s3c_rtc_setaie,//用于设置RTCALM寄存器
};

static void s3c24xx_rtc_enable(struct s3c_rtc* info)
{
	unsigned int con, tmp;

	con = readw(info->base + S3C2410_RTCCON);
	/* re-enable the device, and check it is ok */
	if ((con & S3C2410_RTCCON_RTCEN) == 0) {
		dev_info(info->dev, "rtc disabled, re-enabling\n");

		tmp = readw(info->base + S3C2410_RTCCON);
		writew(tmp | S3C2410_RTCCON_RTCEN,
			info->base + S3C2410_RTCCON);//将RTCCON寄存器的最低位置为0，表示不下雨实时时钟计数
	}

	if (con & S3C2410_RTCCON_CNTSEL) {
		dev_info(info->dev, "removing RTCCON_CNTSEL\n");

		tmp = readw(info->base + S3C2410_RTCCON);
		writew(tmp & ~S3C2410_RTCCON_CNTSEL,
			info->base + S3C2410_RTCCON);//将RTCCON寄存器的位2置为0，不使用BCD计数选择器
	}

	if (con & S3C2410_RTCCON_CLKRST) {
		dev_info(info->dev, "removing RTCCON_CLKRST\n");

		tmp = readw(info->base + S3C2410_RTCCON);
		writew(tmp & ~S3C2410_RTCCON_CLKRST,
			info->base + S3C2410_RTCCON);//将RTCCON寄存器的位3置为0，不重新设置计数器
	}
}

static void s3c24xx_rtc_disable(struct s3c_rtc* info)
{
	unsigned int con;

	con = readw(info->base + S3C2410_RTCCON);
	con &= ~S3C2410_RTCCON_RTCEN;
	writew(con, info->base + S3C2410_RTCCON);//将RTCCON寄存器的最低位置为0，使RTC实时时钟工作起来

	con = readb(info->base + S3C2410_TICNT);
	con &= ~S3C2410_TICNT_ENABLE;
	writeb(con, info->base + S3C2410_TICNT);//将TICNT寄存器的最高位置为0，表示不允许实时时钟产生报警中断
}

static void s3c6410_rtc_disable(struct s3c_rtc* info)
{
	unsigned int con;

	con = readw(info->base + S3C2410_RTCCON);
	con &= ~S3C64XX_RTCCON_TICEN;
	con &= ~S3C2410_RTCCON_RTCEN;
	writew(con, info->base + S3C2410_RTCCON);
}

static int s3c_rtc_remove(struct platform_device* pdev)//在prode()函数申请的资源，在此函数中释放
{
	struct s3c_rtc* info = platform_get_drvdata(pdev);

	s3c_rtc_setaie(info->dev, 0);

	if (info->data->needs_src_clk)
		clk_unprepare(info->rtc_src_clk);
	clk_unprepare(info->rtc_clk);

	return 0;
}

static const struct of_device_id s3c_rtc_dt_match[];

static struct s3c_rtc_data* s3c_rtc_get_data(struct platform_device* pdev)
{
	const struct of_device_id* match;

	match = of_match_node(s3c_rtc_dt_match, pdev->dev.of_node);
	return (struct s3c_rtc_data*)match->data;
}

//注册驱动后，会出发平台设备和驱动的匹配函数platform_match()。
//匹配成功，则会调用平台设备驱动中的s3c_rtc_probe函数
static int s3c_rtc_probe(struct platform_device* pdev)//RTC驱动探测函数
{
	struct s3c_rtc* info = NULL;
	struct rtc_time rtc_tm;//定义了一个指向资源的指针
	struct resource* res;
	int ret;

	info = devm_kzalloc(&pdev->dev, sizeof(*info), GFP_KERNEL);
	if (!info)
		return -ENOMEM;

	/* find the IRQs */
	info->irq_tick = platform_get_irq(pdev, 1);//获得平台设备的资源信息的第2个中断号
	//s3c_rtc_tickno被赋值为46
	if (info->irq_tick < 0) {
		//表示资源信息中没有这个中断对应的中断号
		dev_err(&pdev->dev, "no irq for rtc tick\n");
		return info->irq_tick;
	}

	info->dev = &pdev->dev;
	info->data = s3c_rtc_get_data(pdev);
	if (!info->data) {
		dev_err(&pdev->dev, "failed getting s3c_rtc_data\n");
		return -EINVAL;
	}
	spin_lock_init(&info->pie_lock);
	spin_lock_init(&info->alarm_clk_lock);

	platform_set_drvdata(pdev, info);//保存平台总线设备的私有数据

	info->irq_alarm = platform_get_irq(pdev, 0);//获得平台设备的资源信息的第1个中断号
	//s3c_rtc_alarmno被赋值为24
	if (info->irq_alarm < 0) {
		//表示资源信息中没有这个中断对应的中断号
		dev_err(&pdev->dev, "no irq for alarm\n");
		return info->irq_alarm;
	}

	dev_dbg(&pdev->dev, "s3c2410_rtc: tick irq %d, alarm irq %d\n",
		info->irq_tick, info->irq_alarm);//打印获得的两个中断号

	/* get the memory region */
	res = platform_get_resource(pdev, IORESOURCE_MEM, 0);//获得rtc使用的内存资源描述
	info->base = devm_ioremap_resource(&pdev->dev, res);//将寄存器地址映射到虚拟地址空间，这样可以使用内核提供的访问内存的函数访问寄存器
	if (IS_ERR(info->base))
		return PTR_ERR(info->base);

	info->rtc_clk = devm_clk_get(&pdev->dev, "rtc");//得到RTC的时钟信号
	if (IS_ERR(info->rtc_clk)) {
		dev_err(&pdev->dev, "failed to find rtc clock\n");
		return PTR_ERR(info->rtc_clk);
	}
	clk_prepare_enable(info->rtc_clk);

	if (info->data->needs_src_clk) {
		info->rtc_src_clk = devm_clk_get(&pdev->dev, "rtc_src");
		if (IS_ERR(info->rtc_src_clk)) {
			dev_err(&pdev->dev,
				"failed to find rtc source clock\n");
			clk_disable_unprepare(info->rtc_clk);
			return PTR_ERR(info->rtc_src_clk);
		}
		clk_prepare_enable(info->rtc_src_clk);
	}

	/* check to see if everything is setup correctly */
	if (info->data->enable)
		info->data->enable(info);

	dev_dbg(&pdev->dev, "s3c2410_rtc: RTCCON=%02x\n",
		readw(info->base + S3C2410_RTCCON));

	device_init_wakeup(&pdev->dev, 1);//唤醒RTC设备

	/* Check RTC Time */
	if (s3c_rtc_gettime(&pdev->dev, &rtc_tm)) {
		rtc_tm.tm_year = 100;
		rtc_tm.tm_mon = 0;
		rtc_tm.tm_mday = 1;
		rtc_tm.tm_hour = 0;
		rtc_tm.tm_min = 0;
		rtc_tm.tm_sec = 0;

		s3c_rtc_settime(&pdev->dev, &rtc_tm);//设置时间

		dev_warn(&pdev->dev, "warning: invalid RTC value so initializing it\n");
	}

	/* register RTC and exit */
	info->rtc = devm_rtc_device_register(&pdev->dev, "s3c", &s3c_rtcops,
		THIS_MODULE);//设备注册函数,THIS_MODULE驱动的模块
	if (IS_ERR(info->rtc)) {
		dev_err(&pdev->dev, "cannot attach rtc\n");
		ret = PTR_ERR(info->rtc);
		goto err_nortc;
	}

	ret = devm_request_irq(&pdev->dev, info->irq_alarm, s3c_rtc_alarmirq,
		0, "s3c2410-rtc alarm", info);//申请RTC报警中断
	if (ret) {
		dev_err(&pdev->dev, "IRQ%d error %d\n", info->irq_alarm, ret);
		goto err_nortc;
	}

	ret = devm_request_irq(&pdev->dev, info->irq_tick, s3c_rtc_tickirq,
		0, "s3c2410-rtc tick", info);//申请RTC时间街拍中断
	if (ret) {
		dev_err(&pdev->dev, "IRQ%d error %d\n", info->irq_tick, ret);
		goto err_nortc;
	}

	if (info->data->select_tick_clk)
		info->data->select_tick_clk(info);

	s3c_rtc_setfreq(info, 1);//设置频率、设置TICNT寄存器

	s3c_rtc_disable_clk(info); //无效

	return 0;

err_nortc:
	if (info->data->disable)
		info->data->disable(info);

	if (info->data->needs_src_clk)
		clk_disable_unprepare(info->rtc_src_clk);
	clk_disable_unprepare(info->rtc_clk);

	return ret;
}

#ifdef CONFIG_PM_SLEEP

static int s3c_rtc_suspend(struct device* dev)//RTC挂起函数，使设备处于低功耗状态
{
	struct s3c_rtc* info = dev_get_drvdata(dev);

	s3c_rtc_enable_clk(info);

	/* save TICNT for anyone using periodic interrupts */
	if (info->data->save_tick_cnt)
		info->data->save_tick_cnt(info);

	if (info->data->disable)
		info->data->disable(info);

	if (device_may_wakeup(dev) && !info->wake_en) {
		if (enable_irq_wake(info->irq_alarm) == 0)
			info->wake_en = true;
		else
			dev_err(dev, "enable_irq_wake failed\n");
	}

	return 0;
}

static int s3c_rtc_resume(struct device* dev)//RTC恢复函数，使设备从低功耗恢复到正常状态
{
	struct s3c_rtc* info = dev_get_drvdata(dev);

	if (info->data->enable)
		info->data->enable(info);

	if (info->data->restore_tick_cnt)
		info->data->restore_tick_cnt(info);

	s3c_rtc_disable_clk(info);

	if (device_may_wakeup(dev) && info->wake_en) {
		disable_irq_wake(info->irq_alarm);
		info->wake_en = false;
	}

	return 0;
}
#endif
static SIMPLE_DEV_PM_OPS(s3c_rtc_pm_ops, s3c_rtc_suspend, s3c_rtc_resume);

static void s3c24xx_rtc_irq(struct s3c_rtc* info, int mask)
{
	rtc_update_irq(info->rtc, 1, RTC_AF | RTC_IRQF);
}

static void s3c6410_rtc_irq(struct s3c_rtc* info, int mask)
{
	rtc_update_irq(info->rtc, 1, RTC_AF | RTC_IRQF);
	writeb(mask, info->base + S3C2410_INTP);
}

static void s3c2410_rtc_setfreq(struct s3c_rtc* info, int freq)
{
	unsigned int tmp = 0;
	int val;

	tmp = readb(info->base + S3C2410_TICNT);
	tmp &= S3C2410_TICNT_ENABLE;

	val = (info->rtc->max_user_freq / freq) - 1;
	tmp |= val;

	writel(tmp, info->base + S3C2410_TICNT);
}

static void s3c2416_rtc_setfreq(struct s3c_rtc* info, int freq)
{
	unsigned int tmp = 0;
	int val;

	tmp = readb(info->base + S3C2410_TICNT);//读取TICNT寄存器中的值，S3C2410_TICNT为该寄存器的地址
	tmp &= S3C2410_TICNT_ENABLE;//将最后7位设为0

	val = (info->rtc->max_user_freq / freq) - 1;

	tmp |= S3C2443_TICNT_PART(val);
	writel(S3C2443_TICNT1_PART(val), info->base + S3C2443_TICNT1);//将设置的值写入TICNT寄存器

	writel(S3C2416_TICNT2_PART(val), info->base + S3C2416_TICNT2);

	writel(tmp, info->base + S3C2410_TICNT);
}

static void s3c2443_rtc_setfreq(struct s3c_rtc* info, int freq)
{
	unsigned int tmp = 0;
	int val;

	tmp = readb(info->base + S3C2410_TICNT);
	tmp &= S3C2410_TICNT_ENABLE;

	val = (info->rtc->max_user_freq / freq) - 1;

	tmp |= S3C2443_TICNT_PART(val);
	writel(S3C2443_TICNT1_PART(val), info->base + S3C2443_TICNT1);

	writel(tmp, info->base + S3C2410_TICNT);
}

static void s3c6410_rtc_setfreq(struct s3c_rtc* info, int freq)
{
	int val;

	val = (info->rtc->max_user_freq / freq) - 1;
	writel(val, info->base + S3C2410_TICNT);
}

static void s3c24xx_rtc_enable_tick(struct s3c_rtc* info, struct seq_file* seq)
{
	unsigned int ticnt;

	ticnt = readb(info->base + S3C2410_TICNT);
	ticnt &= S3C2410_TICNT_ENABLE;

	seq_printf(seq, "periodic_IRQ\t: %s\n", ticnt ? "yes" : "no");
}

static void s3c2416_rtc_select_tick_clk(struct s3c_rtc* info)
{
	unsigned int con;

	con = readw(info->base + S3C2410_RTCCON);
	con |= S3C2443_RTCCON_TICSEL;
	writew(con, info->base + S3C2410_RTCCON);
}

static void s3c6410_rtc_enable_tick(struct s3c_rtc* info, struct seq_file* seq)
{
	unsigned int ticnt;

	ticnt = readw(info->base + S3C2410_RTCCON);
	ticnt &= S3C64XX_RTCCON_TICEN;

	seq_printf(seq, "periodic_IRQ\t: %s\n", ticnt ? "yes" : "no");
}

static void s3c24xx_rtc_save_tick_cnt(struct s3c_rtc* info)
{
	info->ticnt_save = readb(info->base + S3C2410_TICNT);
}

static void s3c24xx_rtc_restore_tick_cnt(struct s3c_rtc* info)
{
	writeb(info->ticnt_save, info->base + S3C2410_TICNT);
}

static void s3c6410_rtc_save_tick_cnt(struct s3c_rtc* info)
{
	info->ticnt_en_save = readw(info->base + S3C2410_RTCCON);
	info->ticnt_en_save &= S3C64XX_RTCCON_TICEN;
	info->ticnt_save = readl(info->base + S3C2410_TICNT);
}

static void s3c6410_rtc_restore_tick_cnt(struct s3c_rtc* info)
{
	unsigned int con;

	writel(info->ticnt_save, info->base + S3C2410_TICNT);
	if (info->ticnt_en_save) {
		con = readw(info->base + S3C2410_RTCCON);
		writew(con | info->ticnt_en_save,
			info->base + S3C2410_RTCCON);
	}
}

static struct s3c_rtc_data const s3c2410_rtc_data = {
	.max_user_freq = 128,
	.irq_handler = s3c24xx_rtc_irq,
	.set_freq = s3c2410_rtc_setfreq,
	.enable_tick = s3c24xx_rtc_enable_tick,
	.save_tick_cnt = s3c24xx_rtc_save_tick_cnt,
	.restore_tick_cnt = s3c24xx_rtc_restore_tick_cnt,
	.enable = s3c24xx_rtc_enable,
	.disable = s3c24xx_rtc_disable,
};

static struct s3c_rtc_data const s3c2416_rtc_data = {
	.max_user_freq = 32768,
	.irq_handler = s3c24xx_rtc_irq,
	.set_freq = s3c2416_rtc_setfreq,
	.enable_tick = s3c24xx_rtc_enable_tick,
	.select_tick_clk = s3c2416_rtc_select_tick_clk,
	.save_tick_cnt = s3c24xx_rtc_save_tick_cnt,
	.restore_tick_cnt = s3c24xx_rtc_restore_tick_cnt,
	.enable = s3c24xx_rtc_enable,
	.disable = s3c24xx_rtc_disable,
};

static struct s3c_rtc_data const s3c2443_rtc_data = {
	.max_user_freq = 32768,
	.irq_handler = s3c24xx_rtc_irq,
	.set_freq = s3c2443_rtc_setfreq,
	.enable_tick = s3c24xx_rtc_enable_tick,
	.select_tick_clk = s3c2416_rtc_select_tick_clk,
	.save_tick_cnt = s3c24xx_rtc_save_tick_cnt,
	.restore_tick_cnt = s3c24xx_rtc_restore_tick_cnt,
	.enable = s3c24xx_rtc_enable,
	.disable = s3c24xx_rtc_disable,
};

static struct s3c_rtc_data const s3c6410_rtc_data = {
	.max_user_freq = 32768,
	.needs_src_clk = true,
	.irq_handler = s3c6410_rtc_irq,
	.set_freq = s3c6410_rtc_setfreq,
	.enable_tick = s3c6410_rtc_enable_tick,
	.save_tick_cnt = s3c6410_rtc_save_tick_cnt,
	.restore_tick_cnt = s3c6410_rtc_restore_tick_cnt,
	.enable = s3c24xx_rtc_enable,
	.disable = s3c6410_rtc_disable,
};

static const struct of_device_id s3c_rtc_dt_match[] = {
	{
		.compatible = "samsung,s3c2410-rtc",
		.data = (void*)&s3c2410_rtc_data,
	}, {
		.compatible = "samsung,s3c2416-rtc",
		.data = (void*)&s3c2416_rtc_data,
	}, {
		.compatible = "samsung,s3c2443-rtc",
		.data = (void*)&s3c2443_rtc_data,
	}, {
		.compatible = "samsung,s3c6410-rtc",
		.data = (void*)&s3c6410_rtc_data,
	}, {
		.compatible = "samsung,exynos3250-rtc",
		.data = (void*)&s3c6410_rtc_data,
	},
	{ /* sentinel */ },
};
MODULE_DEVICE_TABLE(of, s3c_rtc_dt_match);

static struct platform_driver s3c_rtc_driver = {//内嵌的驱动程序结构
	.probe = s3c_rtc_probe,
	.remove = s3c_rtc_remove,
	.driver = {
		.name = "s3c-rtc",//驱动名字
		.pm = &s3c_rtc_pm_ops,
		.of_match_table = of_match_ptr(s3c_rtc_dt_match),
	},
};
module_platform_driver(s3c_rtc_driver);

MODULE_DESCRIPTION("Samsung S3C RTC Driver");
MODULE_AUTHOR("Ben Dooks <ben@simtec.co.uk>");
MODULE_LICENSE("GPL");
MODULE_ALIAS("platform:s3c2410-rtc");
雨落樱殇
关注
1
点赞
踩
1

收藏

觉得还不错? 一键收藏
0
评论
Linux-4.5.1下的RTC实时时钟

RTC（Real - Time Clock，简称RTC）实时时钟为操作系统提供一个可靠的时间，并且在断电的情况下，RTC实时时钟也可以通过电池供电，一直运行下去。RTC单元可以在系统电源关闭的情况下依靠备用电池工作，一般主板上都有一个纽扣电池作为实时时钟的电源。RTC可以通过使用STRB / LDDRB这两个ARM指令向CPU传递8位数据（BCD码）。RTC依靠一个外部的32.768kHz的石晶体，产生周期性的脉冲信号。每一个脉冲信号到来时，计数器就加1，通过这种方式，完成计时功能。*一、RTC的特性
复制链接

扫一扫