[linux-2.6-block.git] / drivers / rtc / rtc-nuc900.c

// SPDX-License-Identifier: GPL-2.0-only
/*
 * Copyright (c) 2008-2009 Nuvoton technology corporation.
 *
 * Wan ZongShun <mcuos.com@gmail.com>
 */

#include <linux/module.h>
#include <linux/init.h>
#include <linux/platform_device.h>
#include <linux/slab.h>
#include <linux/rtc.h>
#include <linux/delay.h>
#include <linux/io.h>
#include <linux/bcd.h>

/* RTC Control Registers */
#define REG_RTC_INIR		0x00
#define REG_RTC_AER		0x04
#define REG_RTC_FCR		0x08
#define REG_RTC_TLR		0x0C
#define REG_RTC_CLR		0x10
#define REG_RTC_TSSR		0x14
#define REG_RTC_DWR		0x18
#define REG_RTC_TAR		0x1C
#define REG_RTC_CAR		0x20
#define REG_RTC_LIR		0x24
#define REG_RTC_RIER		0x28
#define REG_RTC_RIIR		0x2C
#define REG_RTC_TTR		0x30

#define RTCSET			0x01
#define AERRWENB		0x10000
#define INIRRESET		0xa5eb1357
#define AERPOWERON		0xA965
#define AERPOWEROFF		0x0000
#define LEAPYEAR		0x0001
#define TICKENB			0x80
#define TICKINTENB		0x0002
#define ALARMINTENB		0x0001
#define MODE24			0x0001

struct nuc900_rtc {
	int			irq_num;
	void __iomem		*rtc_reg;
	struct rtc_device	*rtcdev;
};

struct nuc900_bcd_time {
	int bcd_sec;
	int bcd_min;
	int bcd_hour;
	int bcd_mday;
	int bcd_mon;
	int bcd_year;
};

static irqreturn_t nuc900_rtc_interrupt(int irq, void *_rtc)
{
	struct nuc900_rtc *rtc = _rtc;
	unsigned long events = 0, rtc_irq;

	rtc_irq = __raw_readl(rtc->rtc_reg + REG_RTC_RIIR);

	if (rtc_irq & ALARMINTENB) {
		rtc_irq &= ~ALARMINTENB;
		__raw_writel(rtc_irq, rtc->rtc_reg + REG_RTC_RIIR);
		events |= RTC_AF | RTC_IRQF;
	}

	if (rtc_irq & TICKINTENB) {
		rtc_irq &= ~TICKINTENB;
		__raw_writel(rtc_irq, rtc->rtc_reg + REG_RTC_RIIR);
		events |= RTC_UF | RTC_IRQF;
	}

	rtc_update_irq(rtc->rtcdev, 1, events);

	return IRQ_HANDLED;
}

static int *check_rtc_access_enable(struct nuc900_rtc *nuc900_rtc)
{
	unsigned int timeout = 0x1000;
	__raw_writel(INIRRESET, nuc900_rtc->rtc_reg + REG_RTC_INIR);

	mdelay(10);

	__raw_writel(AERPOWERON, nuc900_rtc->rtc_reg + REG_RTC_AER);

	while (!(__raw_readl(nuc900_rtc->rtc_reg + REG_RTC_AER) & AERRWENB)
								&& --timeout)
		mdelay(1);

	if (!timeout)
		return ERR_PTR(-EPERM);

	return NULL;
}

static void nuc900_rtc_bcd2bin(unsigned int timereg,
			       unsigned int calreg, struct rtc_time *tm)
{
	tm->tm_mday	= bcd2bin(calreg >> 0);
	tm->tm_mon	= bcd2bin(calreg >> 8);
	tm->tm_year	= bcd2bin(calreg >> 16) + 100;

	tm->tm_sec	= bcd2bin(timereg >> 0);
	tm->tm_min	= bcd2bin(timereg >> 8);
	tm->tm_hour	= bcd2bin(timereg >> 16);
}

static void nuc900_rtc_bin2bcd(struct device *dev, struct rtc_time *settm,
						struct nuc900_bcd_time *gettm)
{
	gettm->bcd_mday = bin2bcd(settm->tm_mday) << 0;
	gettm->bcd_mon  = bin2bcd(settm->tm_mon) << 8;

	if (settm->tm_year < 100) {
		dev_warn(dev, "The year will be between 1970-1999, right?\n");
		gettm->bcd_year = bin2bcd(settm->tm_year) << 16;
	} else {
		gettm->bcd_year = bin2bcd(settm->tm_year - 100) << 16;
	}

	gettm->bcd_sec  = bin2bcd(settm->tm_sec) << 0;
	gettm->bcd_min  = bin2bcd(settm->tm_min) << 8;
	gettm->bcd_hour = bin2bcd(settm->tm_hour) << 16;
}

static int nuc900_alarm_irq_enable(struct device *dev, unsigned int enabled)
{
	struct nuc900_rtc *rtc = dev_get_drvdata(dev);

	if (enabled)
		__raw_writel(__raw_readl(rtc->rtc_reg + REG_RTC_RIER)|
				(ALARMINTENB), rtc->rtc_reg + REG_RTC_RIER);
	else
		__raw_writel(__raw_readl(rtc->rtc_reg + REG_RTC_RIER)&
				(~ALARMINTENB), rtc->rtc_reg + REG_RTC_RIER);

	return 0;
}

static int nuc900_rtc_read_time(struct device *dev, struct rtc_time *tm)
{
	struct nuc900_rtc *rtc = dev_get_drvdata(dev);
	unsigned int timeval, clrval;

	timeval = __raw_readl(rtc->rtc_reg + REG_RTC_TLR);
	clrval	= __raw_readl(rtc->rtc_reg + REG_RTC_CLR);

	nuc900_rtc_bcd2bin(timeval, clrval, tm);

	return 0;
}

static int nuc900_rtc_set_time(struct device *dev, struct rtc_time *tm)
{
	struct nuc900_rtc *rtc = dev_get_drvdata(dev);
	struct nuc900_bcd_time gettm;
	unsigned long val;
	int *err;

	nuc900_rtc_bin2bcd(dev, tm, &gettm);

	err = check_rtc_access_enable(rtc);
	if (IS_ERR(err))
		return PTR_ERR(err);

	val = gettm.bcd_mday | gettm.bcd_mon | gettm.bcd_year;
	__raw_writel(val, rtc->rtc_reg + REG_RTC_CLR);

	val = gettm.bcd_sec | gettm.bcd_min | gettm.bcd_hour;
	__raw_writel(val, rtc->rtc_reg + REG_RTC_TLR);

	return 0;
}

static int nuc900_rtc_read_alarm(struct device *dev, struct rtc_wkalrm *alrm)
{
	struct nuc900_rtc *rtc = dev_get_drvdata(dev);
	unsigned int timeval, carval;

	timeval = __raw_readl(rtc->rtc_reg + REG_RTC_TAR);
	carval	= __raw_readl(rtc->rtc_reg + REG_RTC_CAR);

	nuc900_rtc_bcd2bin(timeval, carval, &alrm->time);

	return rtc_valid_tm(&alrm->time);
}

static int nuc900_rtc_set_alarm(struct device *dev, struct rtc_wkalrm *alrm)
{
	struct nuc900_rtc *rtc = dev_get_drvdata(dev);
	struct nuc900_bcd_time tm;
	unsigned long val;
	int *err;

	nuc900_rtc_bin2bcd(dev, &alrm->time, &tm);

	err = check_rtc_access_enable(rtc);
	if (IS_ERR(err))
		return PTR_ERR(err);

	val = tm.bcd_mday | tm.bcd_mon | tm.bcd_year;
	__raw_writel(val, rtc->rtc_reg + REG_RTC_CAR);

	val = tm.bcd_sec | tm.bcd_min | tm.bcd_hour;
	__raw_writel(val, rtc->rtc_reg + REG_RTC_TAR);

	return 0;
}

static const struct rtc_class_ops nuc900_rtc_ops = {
	.read_time = nuc900_rtc_read_time,
	.set_time = nuc900_rtc_set_time,
	.read_alarm = nuc900_rtc_read_alarm,
	.set_alarm = nuc900_rtc_set_alarm,
	.alarm_irq_enable = nuc900_alarm_irq_enable,
};

static int __init nuc900_rtc_probe(struct platform_device *pdev)
{
	struct resource *res;
	struct nuc900_rtc *nuc900_rtc;

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

	res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
	nuc900_rtc->rtc_reg = devm_ioremap_resource(&pdev->dev, res);
	if (IS_ERR(nuc900_rtc->rtc_reg))
		return PTR_ERR(nuc900_rtc->rtc_reg);

	platform_set_drvdata(pdev, nuc900_rtc);

	nuc900_rtc->rtcdev = devm_rtc_device_register(&pdev->dev, pdev->name,
						&nuc900_rtc_ops, THIS_MODULE);
	if (IS_ERR(nuc900_rtc->rtcdev)) {
		dev_err(&pdev->dev, "rtc device register failed\n");
		return PTR_ERR(nuc900_rtc->rtcdev);
	}

	__raw_writel(__raw_readl(nuc900_rtc->rtc_reg + REG_RTC_TSSR) | MODE24,
					nuc900_rtc->rtc_reg + REG_RTC_TSSR);

	nuc900_rtc->irq_num = platform_get_irq(pdev, 0);
	if (devm_request_irq(&pdev->dev, nuc900_rtc->irq_num,
			nuc900_rtc_interrupt, 0, "nuc900rtc", nuc900_rtc)) {
		dev_err(&pdev->dev, "NUC900 RTC request irq failed\n");
		return -EBUSY;
	}

	return 0;
}

static struct platform_driver nuc900_rtc_driver = {
	.driver		= {
		.name	= "nuc900-rtc",
	},
};

module_platform_driver_probe(nuc900_rtc_driver, nuc900_rtc_probe);

MODULE_AUTHOR("Wan ZongShun <mcuos.com@gmail.com>");
MODULE_DESCRIPTION("nuc910/nuc920 RTC driver");
MODULE_LICENSE("GPL");
MODULE_ALIAS("platform:nuc900-rtc");
Commit	Line	Data
b886d83c	1	// SPDX-License-Identifier: GPL-2.0-only
afd49a7e WZ	2	/*
	3	* Copyright (c) 2008-2009 Nuvoton technology corporation.
	4	*
	5	* Wan ZongShun <mcuos.com@gmail.com>
afd49a7e WZ	6	*/
	7
	8	#include <linux/module.h>
	9	#include <linux/init.h>
	10	#include <linux/platform_device.h>
5a0e3ad6	11	#include <linux/slab.h>
afd49a7e WZ	12	#include <linux/rtc.h>
	13	#include <linux/delay.h>
	14	#include <linux/io.h>
	15	#include <linux/bcd.h>
	16
	17	/* RTC Control Registers */
	18	#define REG_RTC_INIR 0x00
	19	#define REG_RTC_AER 0x04
	20	#define REG_RTC_FCR 0x08
	21	#define REG_RTC_TLR 0x0C
	22	#define REG_RTC_CLR 0x10
	23	#define REG_RTC_TSSR 0x14
	24	#define REG_RTC_DWR 0x18
	25	#define REG_RTC_TAR 0x1C
	26	#define REG_RTC_CAR 0x20
	27	#define REG_RTC_LIR 0x24
	28	#define REG_RTC_RIER 0x28
	29	#define REG_RTC_RIIR 0x2C
	30	#define REG_RTC_TTR 0x30
	31
	32	#define RTCSET 0x01
	33	#define AERRWENB 0x10000
	34	#define INIRRESET 0xa5eb1357
	35	#define AERPOWERON 0xA965
	36	#define AERPOWEROFF 0x0000
	37	#define LEAPYEAR 0x0001
	38	#define TICKENB 0x80
	39	#define TICKINTENB 0x0002
	40	#define ALARMINTENB 0x0001
	41	#define MODE24 0x0001
	42
	43	struct nuc900_rtc {
	44	int irq_num;
	45	void __iomem *rtc_reg;
	46	struct rtc_device *rtcdev;
	47	};
	48
	49	struct nuc900_bcd_time {
	50	int bcd_sec;
	51	int bcd_min;
	52	int bcd_hour;
	53	int bcd_mday;
	54	int bcd_mon;
	55	int bcd_year;
	56	};
	57
	58	static irqreturn_t nuc900_rtc_interrupt(int irq, void *_rtc)
	59	{
	60	struct nuc900_rtc *rtc = _rtc;
	61	unsigned long events = 0, rtc_irq;
	62
	63	rtc_irq = __raw_readl(rtc->rtc_reg + REG_RTC_RIIR);
	64
	65	if (rtc_irq & ALARMINTENB) {
	66	rtc_irq &= ~ALARMINTENB;
	67	__raw_writel(rtc_irq, rtc->rtc_reg + REG_RTC_RIIR);
	68	events \|= RTC_AF \| RTC_IRQF;
	69	}
	70
	71	if (rtc_irq & TICKINTENB) {
	72	rtc_irq &= ~TICKINTENB;
	73	__raw_writel(rtc_irq, rtc->rtc_reg + REG_RTC_RIIR);
	74	events \|= RTC_UF \| RTC_IRQF;
	75	}
76
77	rtc_update_irq(rtc->rtcdev, 1, events);
78
79	return IRQ_HANDLED;
80	}
81
82	static int check_rtc_access_enable(struct nuc900_rtc nuc900_rtc)
83	{
2f11e57d	84	unsigned int timeout = 0x1000;
afd49a7e WZ	85	__raw_writel(INIRRESET, nuc900_rtc->rtc_reg + REG_RTC_INIR);
	86
	87	mdelay(10);
	88
	89	__raw_writel(AERPOWERON, nuc900_rtc->rtc_reg + REG_RTC_AER);
	90
0a89b553	91	while (!(__raw_readl(nuc900_rtc->rtc_reg + REG_RTC_AER) & AERRWENB)
d0a67c37	92	&& --timeout)
0a89b553	93	mdelay(1);
afd49a7e	94
0a89b553 WZ	95	if (!timeout)
0a89b553 WZ	96	return ERR_PTR(-EPERM);
afd49a7e	97
0ebbf439	98	return NULL;
afd49a7e WZ	99	}
afd49a7e WZ	100
b6cb3984 AB	101	static void nuc900_rtc_bcd2bin(unsigned int timereg,
b6cb3984 AB	102	unsigned int calreg, struct rtc_time *tm)
afd49a7e WZ	103	{
	104	tm->tm_mday = bcd2bin(calreg >> 0);
	105	tm->tm_mon = bcd2bin(calreg >> 8);
	106	tm->tm_year = bcd2bin(calreg >> 16) + 100;
	107
	108	tm->tm_sec = bcd2bin(timereg >> 0);
	109	tm->tm_min = bcd2bin(timereg >> 8);
	110	tm->tm_hour = bcd2bin(timereg >> 16);
afd49a7e WZ	111	}
afd49a7e WZ	112
70d2a0ba	113	static void nuc900_rtc_bin2bcd(struct device dev, struct rtc_time settm,
afd49a7e WZ	114	struct nuc900_bcd_time *gettm)
	115	{
	116	gettm->bcd_mday = bin2bcd(settm->tm_mday) << 0;
	117	gettm->bcd_mon = bin2bcd(settm->tm_mon) << 8;
70d2a0ba WZ	118
	119	if (settm->tm_year < 100) {
	120	dev_warn(dev, "The year will be between 1970-1999, right?\n");
	121	gettm->bcd_year = bin2bcd(settm->tm_year) << 16;
	122	} else {
	123	gettm->bcd_year = bin2bcd(settm->tm_year - 100) << 16;
	124	}
afd49a7e WZ	125
	126	gettm->bcd_sec = bin2bcd(settm->tm_sec) << 0;
	127	gettm->bcd_min = bin2bcd(settm->tm_min) << 8;
	128	gettm->bcd_hour = bin2bcd(settm->tm_hour) << 16;
	129	}
	130
afd49a7e WZ	131	static int nuc900_alarm_irq_enable(struct device *dev, unsigned int enabled)
	132	{
	133	struct nuc900_rtc *rtc = dev_get_drvdata(dev);
	134
	135	if (enabled)
	136	__raw_writel(__raw_readl(rtc->rtc_reg + REG_RTC_RIER)\|
	137	(ALARMINTENB), rtc->rtc_reg + REG_RTC_RIER);
	138	else
	139	__raw_writel(__raw_readl(rtc->rtc_reg + REG_RTC_RIER)&
	140	(~ALARMINTENB), rtc->rtc_reg + REG_RTC_RIER);
	141
	142	return 0;
	143	}
	144
	145	static int nuc900_rtc_read_time(struct device dev, struct rtc_time tm)
	146	{
	147	struct nuc900_rtc *rtc = dev_get_drvdata(dev);
	148	unsigned int timeval, clrval;
	149
	150	timeval = __raw_readl(rtc->rtc_reg + REG_RTC_TLR);
	151	clrval = __raw_readl(rtc->rtc_reg + REG_RTC_CLR);
	152
b6cb3984 AB	153	nuc900_rtc_bcd2bin(timeval, clrval, tm);
	154
	155	return 0;
afd49a7e WZ	156	}
	157
	158	static int nuc900_rtc_set_time(struct device dev, struct rtc_time tm)
	159	{
	160	struct nuc900_rtc *rtc = dev_get_drvdata(dev);
	161	struct nuc900_bcd_time gettm;
	162	unsigned long val;
	163	int *err;
	164
70d2a0ba	165	nuc900_rtc_bin2bcd(dev, tm, &gettm);
afd49a7e WZ	166
	167	err = check_rtc_access_enable(rtc);
	168	if (IS_ERR(err))
	169	return PTR_ERR(err);
	170
	171	val = gettm.bcd_mday \| gettm.bcd_mon \| gettm.bcd_year;
	172	__raw_writel(val, rtc->rtc_reg + REG_RTC_CLR);
	173
	174	val = gettm.bcd_sec \| gettm.bcd_min \| gettm.bcd_hour;
	175	__raw_writel(val, rtc->rtc_reg + REG_RTC_TLR);
	176
	177	return 0;
	178	}
	179
	180	static int nuc900_rtc_read_alarm(struct device dev, struct rtc_wkalrm alrm)
	181	{
	182	struct nuc900_rtc *rtc = dev_get_drvdata(dev);
	183	unsigned int timeval, carval;
	184
	185	timeval = __raw_readl(rtc->rtc_reg + REG_RTC_TAR);
	186	carval = __raw_readl(rtc->rtc_reg + REG_RTC_CAR);
	187
b6cb3984 AB	188	nuc900_rtc_bcd2bin(timeval, carval, &alrm->time);
	189
	190	return rtc_valid_tm(&alrm->time);
afd49a7e WZ	191	}
	192
	193	static int nuc900_rtc_set_alarm(struct device dev, struct rtc_wkalrm alrm)
	194	{
	195	struct nuc900_rtc *rtc = dev_get_drvdata(dev);
	196	struct nuc900_bcd_time tm;
	197	unsigned long val;
	198	int *err;
	199
70d2a0ba	200	nuc900_rtc_bin2bcd(dev, &alrm->time, &tm);
afd49a7e WZ	201
	202	err = check_rtc_access_enable(rtc);
	203	if (IS_ERR(err))
	204	return PTR_ERR(err);
	205
	206	val = tm.bcd_mday \| tm.bcd_mon \| tm.bcd_year;
	207	__raw_writel(val, rtc->rtc_reg + REG_RTC_CAR);
	208
	209	val = tm.bcd_sec \| tm.bcd_min \| tm.bcd_hour;
	210	__raw_writel(val, rtc->rtc_reg + REG_RTC_TAR);
	211
	212	return 0;
	213	}
	214
34c7b3ac	215	static const struct rtc_class_ops nuc900_rtc_ops = {
afd49a7e WZ	216	.read_time = nuc900_rtc_read_time,
	217	.set_time = nuc900_rtc_set_time,
	218	.read_alarm = nuc900_rtc_read_alarm,
	219	.set_alarm = nuc900_rtc_set_alarm,
	220	.alarm_irq_enable = nuc900_alarm_irq_enable,
afd49a7e WZ	221	};
afd49a7e WZ	222
e7a6c214	223	static int __init nuc900_rtc_probe(struct platform_device *pdev)
afd49a7e WZ	224	{
	225	struct resource *res;
	226	struct nuc900_rtc *nuc900_rtc;
afd49a7e	227
a63794fe JH	228	nuc900_rtc = devm_kzalloc(&pdev->dev, sizeof(struct nuc900_rtc),
a63794fe JH	229	GFP_KERNEL);
ee567199	230	if (!nuc900_rtc)
afd49a7e	231	return -ENOMEM;
ee567199	232
afd49a7e	233	res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
a63794fe JH	234	nuc900_rtc->rtc_reg = devm_ioremap_resource(&pdev->dev, res);
	235	if (IS_ERR(nuc900_rtc->rtc_reg))
	236	return PTR_ERR(nuc900_rtc->rtc_reg);
afd49a7e	237
23e53be9	238	platform_set_drvdata(pdev, nuc900_rtc);
afd49a7e	239
a63794fe	240	nuc900_rtc->rtcdev = devm_rtc_device_register(&pdev->dev, pdev->name,
afd49a7e WZ	241	&nuc900_rtc_ops, THIS_MODULE);
afd49a7e WZ	242	if (IS_ERR(nuc900_rtc->rtcdev)) {
426d3107	243	dev_err(&pdev->dev, "rtc device register failed\n");
a63794fe	244	return PTR_ERR(nuc900_rtc->rtcdev);
afd49a7e WZ	245	}
afd49a7e WZ	246
afd49a7e WZ	247	__raw_writel(__raw_readl(nuc900_rtc->rtc_reg + REG_RTC_TSSR) \| MODE24,
	248	nuc900_rtc->rtc_reg + REG_RTC_TSSR);
	249
23e53be9	250	nuc900_rtc->irq_num = platform_get_irq(pdev, 0);
a63794fe JH	251	if (devm_request_irq(&pdev->dev, nuc900_rtc->irq_num,
a63794fe JH	252	nuc900_rtc_interrupt, 0, "nuc900rtc", nuc900_rtc)) {
23e53be9	253	dev_err(&pdev->dev, "NUC900 RTC request irq failed\n");
a63794fe	254	return -EBUSY;
23e53be9 WZ	255	}
23e53be9 WZ	256
afd49a7e	257	return 0;
afd49a7e WZ	258	}
afd49a7e WZ	259
afd49a7e	260	static struct platform_driver nuc900_rtc_driver = {
afd49a7e WZ	261	.driver = {
afd49a7e WZ	262	.name = "nuc900-rtc",
afd49a7e WZ	263	},
	264	};
	265
af5e7db6	266	module_platform_driver_probe(nuc900_rtc_driver, nuc900_rtc_probe);
afd49a7e WZ	267
	268	MODULE_AUTHOR("Wan ZongShun <mcuos.com@gmail.com>");
	269	MODULE_DESCRIPTION("nuc910/nuc920 RTC driver");
	270	MODULE_LICENSE("GPL");
	271	MODULE_ALIAS("platform:nuc900-rtc");