[linux-block.git] / drivers / rtc / rtc-ftrtc010.c

// SPDX-License-Identifier: GPL-2.0-or-later
/*
 *  Faraday Technology FTRTC010 driver
 *
 *  Copyright (C) 2009 Janos Laube <janos.dev@gmail.com>
 *
 * Original code for older kernel 2.6.15 are from Stormlinksemi
 * first update from Janos Laube for > 2.6.29 kernels
 *
 * checkpatch fixes and usage of rtc-lib code
 * Hans Ulli Kroll <ulli.kroll@googlemail.com>
 */

#include <linux/rtc.h>
#include <linux/io.h>
#include <linux/slab.h>
#include <linux/platform_device.h>
#include <linux/kernel.h>
#include <linux/module.h>
#include <linux/mod_devicetable.h>
#include <linux/clk.h>

#define DRV_NAME        "rtc-ftrtc010"

MODULE_AUTHOR("Hans Ulli Kroll <ulli.kroll@googlemail.com>");
MODULE_DESCRIPTION("RTC driver for Gemini SoC");
MODULE_LICENSE("GPL");
MODULE_ALIAS("platform:" DRV_NAME);

struct ftrtc010_rtc {
	struct rtc_device	*rtc_dev;
	void __iomem		*rtc_base;
	int			rtc_irq;
	struct clk		*pclk;
	struct clk		*extclk;
};

enum ftrtc010_rtc_offsets {
	FTRTC010_RTC_SECOND		= 0x00,
	FTRTC010_RTC_MINUTE		= 0x04,
	FTRTC010_RTC_HOUR		= 0x08,
	FTRTC010_RTC_DAYS		= 0x0C,
	FTRTC010_RTC_ALARM_SECOND	= 0x10,
	FTRTC010_RTC_ALARM_MINUTE	= 0x14,
	FTRTC010_RTC_ALARM_HOUR		= 0x18,
	FTRTC010_RTC_RECORD		= 0x1C,
	FTRTC010_RTC_CR			= 0x20,
};

static irqreturn_t ftrtc010_rtc_interrupt(int irq, void *dev)
{
	return IRQ_HANDLED;
}

/*
 * Looks like the RTC in the Gemini SoC is (totaly) broken
 * We can't read/write directly the time from RTC registers.
 * We must do some "offset" calculation to get the real time
 *
 * This FIX works pretty fine and Stormlinksemi aka Cortina-Networks does
 * the same thing, without the rtc-lib.c calls.
 */

static int ftrtc010_rtc_read_time(struct device *dev, struct rtc_time *tm)
{
	struct ftrtc010_rtc *rtc = dev_get_drvdata(dev);

	u32 days, hour, min, sec, offset;
	timeu64_t time;

	sec  = readl(rtc->rtc_base + FTRTC010_RTC_SECOND);
	min  = readl(rtc->rtc_base + FTRTC010_RTC_MINUTE);
	hour = readl(rtc->rtc_base + FTRTC010_RTC_HOUR);
	days = readl(rtc->rtc_base + FTRTC010_RTC_DAYS);
	offset = readl(rtc->rtc_base + FTRTC010_RTC_RECORD);

	time = offset + days * 86400 + hour * 3600 + min * 60 + sec;

	rtc_time64_to_tm(time, tm);

	return 0;
}

static int ftrtc010_rtc_set_time(struct device *dev, struct rtc_time *tm)
{
	struct ftrtc010_rtc *rtc = dev_get_drvdata(dev);
	u32 sec, min, hour, day, offset;
	timeu64_t time;

	time = rtc_tm_to_time64(tm);

	sec = readl(rtc->rtc_base + FTRTC010_RTC_SECOND);
	min = readl(rtc->rtc_base + FTRTC010_RTC_MINUTE);
	hour = readl(rtc->rtc_base + FTRTC010_RTC_HOUR);
	day = readl(rtc->rtc_base + FTRTC010_RTC_DAYS);

	offset = time - (day * 86400 + hour * 3600 + min * 60 + sec);

	writel(offset, rtc->rtc_base + FTRTC010_RTC_RECORD);
	writel(0x01, rtc->rtc_base + FTRTC010_RTC_CR);

	return 0;
}

static const struct rtc_class_ops ftrtc010_rtc_ops = {
	.read_time     = ftrtc010_rtc_read_time,
	.set_time      = ftrtc010_rtc_set_time,
};

static int ftrtc010_rtc_probe(struct platform_device *pdev)
{
	u32 days, hour, min, sec;
	struct ftrtc010_rtc *rtc;
	struct device *dev = &pdev->dev;
	struct resource *res;
	int ret;

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

	rtc->pclk = devm_clk_get(dev, "PCLK");
	if (IS_ERR(rtc->pclk)) {
		dev_err(dev, "could not get PCLK\n");
	} else {
		ret = clk_prepare_enable(rtc->pclk);
		if (ret) {
			dev_err(dev, "failed to enable PCLK\n");
			return ret;
		}
	}
	rtc->extclk = devm_clk_get(dev, "EXTCLK");
	if (IS_ERR(rtc->extclk)) {
		dev_err(dev, "could not get EXTCLK\n");
	} else {
		ret = clk_prepare_enable(rtc->extclk);
		if (ret) {
			dev_err(dev, "failed to enable EXTCLK\n");
			goto err_disable_pclk;
		}
	}

	rtc->rtc_irq = platform_get_irq(pdev, 0);
	if (rtc->rtc_irq < 0) {
		ret = rtc->rtc_irq;
		goto err_disable_extclk;
	}

	res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
	if (!res) {
		ret = -ENODEV;
		goto err_disable_extclk;
	}

	rtc->rtc_base = devm_ioremap(dev, res->start,
				     resource_size(res));
	if (!rtc->rtc_base) {
		ret = -ENOMEM;
		goto err_disable_extclk;
	}

	rtc->rtc_dev = devm_rtc_allocate_device(dev);
	if (IS_ERR(rtc->rtc_dev)) {
		ret = PTR_ERR(rtc->rtc_dev);
		goto err_disable_extclk;
	}

	rtc->rtc_dev->ops = &ftrtc010_rtc_ops;

	sec  = readl(rtc->rtc_base + FTRTC010_RTC_SECOND);
	min  = readl(rtc->rtc_base + FTRTC010_RTC_MINUTE);
	hour = readl(rtc->rtc_base + FTRTC010_RTC_HOUR);
	days = readl(rtc->rtc_base + FTRTC010_RTC_DAYS);

	rtc->rtc_dev->range_min = (u64)days * 86400 + hour * 3600 +
				  min * 60 + sec;
	rtc->rtc_dev->range_max = U32_MAX + rtc->rtc_dev->range_min;

	ret = devm_request_irq(dev, rtc->rtc_irq, ftrtc010_rtc_interrupt,
			       IRQF_SHARED, pdev->name, dev);
	if (unlikely(ret))
		goto err_disable_extclk;

	return devm_rtc_register_device(rtc->rtc_dev);

err_disable_extclk:
	clk_disable_unprepare(rtc->extclk);
err_disable_pclk:
	clk_disable_unprepare(rtc->pclk);
	return ret;
}

static int ftrtc010_rtc_remove(struct platform_device *pdev)
{
	struct ftrtc010_rtc *rtc = platform_get_drvdata(pdev);

	if (!IS_ERR(rtc->extclk))
		clk_disable_unprepare(rtc->extclk);
	if (!IS_ERR(rtc->pclk))
		clk_disable_unprepare(rtc->pclk);

	return 0;
}

static const struct of_device_id ftrtc010_rtc_dt_match[] = {
	{ .compatible = "cortina,gemini-rtc" },
	{ .compatible = "faraday,ftrtc010" },
	{ }
};
MODULE_DEVICE_TABLE(of, ftrtc010_rtc_dt_match);

static struct platform_driver ftrtc010_rtc_driver = {
	.driver		= {
		.name	= DRV_NAME,
		.of_match_table = ftrtc010_rtc_dt_match,
	},
	.probe		= ftrtc010_rtc_probe,
	.remove		= ftrtc010_rtc_remove,
};

module_platform_driver_probe(ftrtc010_rtc_driver, ftrtc010_rtc_probe);
Commit	Line	Data
c942fddf	1	// SPDX-License-Identifier: GPL-2.0-or-later
98a9bb5b	2	/*
1d61d259	3	* Faraday Technology FTRTC010 driver
98a9bb5b HUK	4	*
	5	* Copyright (C) 2009 Janos Laube <janos.dev@gmail.com>
	6	*
98a9bb5b HUK	7	* Original code for older kernel 2.6.15 are from Stormlinksemi
	8	* first update from Janos Laube for > 2.6.29 kernels
	9	*
	10	* checkpatch fixes and usage of rtc-lib code
	11	* Hans Ulli Kroll <ulli.kroll@googlemail.com>
	12	*/
	13
	14	#include <linux/rtc.h>
	15	#include <linux/io.h>
	16	#include <linux/slab.h>
	17	#include <linux/platform_device.h>
	18	#include <linux/kernel.h>
	19	#include <linux/module.h>
ac316725	20	#include <linux/mod_devicetable.h>
ac05fba3	21	#include <linux/clk.h>
98a9bb5b	22
1d61d259	23	#define DRV_NAME "rtc-ftrtc010"
98a9bb5b HUK	24
	25	MODULE_AUTHOR("Hans Ulli Kroll <ulli.kroll@googlemail.com>");
	26	MODULE_DESCRIPTION("RTC driver for Gemini SoC");
	27	MODULE_LICENSE("GPL");
	28	MODULE_ALIAS("platform:" DRV_NAME);
	29
1d61d259	30	struct ftrtc010_rtc {
98a9bb5b HUK	31	struct rtc_device *rtc_dev;
	32	void __iomem *rtc_base;
	33	int rtc_irq;
ac05fba3 LW	34	struct clk *pclk;
ac05fba3 LW	35	struct clk *extclk;
98a9bb5b HUK	36	};
98a9bb5b HUK	37
1d61d259 LW	38	enum ftrtc010_rtc_offsets {
	39	FTRTC010_RTC_SECOND = 0x00,
	40	FTRTC010_RTC_MINUTE = 0x04,
	41	FTRTC010_RTC_HOUR = 0x08,
	42	FTRTC010_RTC_DAYS = 0x0C,
	43	FTRTC010_RTC_ALARM_SECOND = 0x10,
	44	FTRTC010_RTC_ALARM_MINUTE = 0x14,
	45	FTRTC010_RTC_ALARM_HOUR = 0x18,
	46	FTRTC010_RTC_RECORD = 0x1C,
	47	FTRTC010_RTC_CR = 0x20,
98a9bb5b HUK	48	};
98a9bb5b HUK	49
1d61d259	50	static irqreturn_t ftrtc010_rtc_interrupt(int irq, void *dev)
98a9bb5b HUK	51	{
	52	return IRQ_HANDLED;
	53	}
	54
	55	/*
	56	* Looks like the RTC in the Gemini SoC is (totaly) broken
	57	* We can't read/write directly the time from RTC registers.
	58	* We must do some "offset" calculation to get the real time
	59	*
	60	* This FIX works pretty fine and Stormlinksemi aka Cortina-Networks does
	61	* the same thing, without the rtc-lib.c calls.
	62	*/
	63
1d61d259	64	static int ftrtc010_rtc_read_time(struct device dev, struct rtc_time tm)
98a9bb5b	65	{
1d61d259	66	struct ftrtc010_rtc *rtc = dev_get_drvdata(dev);
98a9bb5b	67
73318f8b AB	68	u32 days, hour, min, sec, offset;
73318f8b AB	69	timeu64_t time;
98a9bb5b	70
1d61d259 LW	71	sec = readl(rtc->rtc_base + FTRTC010_RTC_SECOND);
	72	min = readl(rtc->rtc_base + FTRTC010_RTC_MINUTE);
	73	hour = readl(rtc->rtc_base + FTRTC010_RTC_HOUR);
	74	days = readl(rtc->rtc_base + FTRTC010_RTC_DAYS);
	75	offset = readl(rtc->rtc_base + FTRTC010_RTC_RECORD);
98a9bb5b HUK	76
	77	time = offset + days * 86400 + hour * 3600 + min * 60 + sec;
	78
73318f8b	79	rtc_time64_to_tm(time, tm);
98a9bb5b HUK	80
	81	return 0;
	82	}
	83
1d61d259	84	static int ftrtc010_rtc_set_time(struct device dev, struct rtc_time tm)
98a9bb5b	85	{
1d61d259	86	struct ftrtc010_rtc *rtc = dev_get_drvdata(dev);
73318f8b AB	87	u32 sec, min, hour, day, offset;
73318f8b AB	88	timeu64_t time;
98a9bb5b	89
73318f8b	90	time = rtc_tm_to_time64(tm);
98a9bb5b	91
1d61d259 LW	92	sec = readl(rtc->rtc_base + FTRTC010_RTC_SECOND);
	93	min = readl(rtc->rtc_base + FTRTC010_RTC_MINUTE);
	94	hour = readl(rtc->rtc_base + FTRTC010_RTC_HOUR);
	95	day = readl(rtc->rtc_base + FTRTC010_RTC_DAYS);
98a9bb5b HUK	96
	97	offset = time - (day * 86400 + hour * 3600 + min * 60 + sec);
	98
1d61d259 LW	99	writel(offset, rtc->rtc_base + FTRTC010_RTC_RECORD);
1d61d259 LW	100	writel(0x01, rtc->rtc_base + FTRTC010_RTC_CR);
98a9bb5b HUK	101
	102	return 0;
	103	}
	104
1d61d259 LW	105	static const struct rtc_class_ops ftrtc010_rtc_ops = {
	106	.read_time = ftrtc010_rtc_read_time,
	107	.set_time = ftrtc010_rtc_set_time,
98a9bb5b HUK	108	};
98a9bb5b HUK	109
1d61d259	110	static int ftrtc010_rtc_probe(struct platform_device *pdev)
98a9bb5b	111	{
b8e62b58	112	u32 days, hour, min, sec;
1d61d259	113	struct ftrtc010_rtc *rtc;
98a9bb5b HUK	114	struct device *dev = &pdev->dev;
	115	struct resource *res;
	116	int ret;
	117
	118	rtc = devm_kzalloc(&pdev->dev, sizeof(*rtc), GFP_KERNEL);
	119	if (unlikely(!rtc))
	120	return -ENOMEM;
	121	platform_set_drvdata(pdev, rtc);
	122
ac05fba3 LW	123	rtc->pclk = devm_clk_get(dev, "PCLK");
	124	if (IS_ERR(rtc->pclk)) {
	125	dev_err(dev, "could not get PCLK\n");
	126	} else {
	127	ret = clk_prepare_enable(rtc->pclk);
	128	if (ret) {
	129	dev_err(dev, "failed to enable PCLK\n");
	130	return ret;
	131	}
	132	}
	133	rtc->extclk = devm_clk_get(dev, "EXTCLK");
	134	if (IS_ERR(rtc->extclk)) {
	135	dev_err(dev, "could not get EXTCLK\n");
	136	} else {
	137	ret = clk_prepare_enable(rtc->extclk);
	138	if (ret) {
	139	dev_err(dev, "failed to enable EXTCLK\n");
b520cbe5	140	goto err_disable_pclk;
ac05fba3 LW	141	}
	142	}
	143
05020a73	144	rtc->rtc_irq = platform_get_irq(pdev, 0);
b520cbe5 ML	145	if (rtc->rtc_irq < 0) {
	146	ret = rtc->rtc_irq;
	147	goto err_disable_extclk;
	148	}
98a9bb5b HUK	149
98a9bb5b HUK	150	res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
b520cbe5 ML	151	if (!res) {
	152	ret = -ENODEV;
	153	goto err_disable_extclk;
	154	}
98a9bb5b HUK	155
98a9bb5b HUK	156	rtc->rtc_base = devm_ioremap(dev, res->start,
45b4c85b	157	resource_size(res));
b520cbe5 ML	158	if (!rtc->rtc_base) {
	159	ret = -ENOMEM;
	160	goto err_disable_extclk;
	161	}
98a9bb5b	162
e38d161f	163	rtc->rtc_dev = devm_rtc_allocate_device(dev);
b520cbe5 ML	164	if (IS_ERR(rtc->rtc_dev)) {
	165	ret = PTR_ERR(rtc->rtc_dev);
	166	goto err_disable_extclk;
	167	}
e38d161f AB	168
	169	rtc->rtc_dev->ops = &ftrtc010_rtc_ops;
	170
b8e62b58 AB	171	sec = readl(rtc->rtc_base + FTRTC010_RTC_SECOND);
	172	min = readl(rtc->rtc_base + FTRTC010_RTC_MINUTE);
	173	hour = readl(rtc->rtc_base + FTRTC010_RTC_HOUR);
	174	days = readl(rtc->rtc_base + FTRTC010_RTC_DAYS);
	175
	176	rtc->rtc_dev->range_min = (u64)days * 86400 + hour * 3600 +
	177	min * 60 + sec;
	178	rtc->rtc_dev->range_max = U32_MAX + rtc->rtc_dev->range_min;
	179
1d61d259	180	ret = devm_request_irq(dev, rtc->rtc_irq, ftrtc010_rtc_interrupt,
98a9bb5b HUK	181	IRQF_SHARED, pdev->name, dev);
98a9bb5b HUK	182	if (unlikely(ret))
b520cbe5	183	goto err_disable_extclk;
98a9bb5b	184
fdcfd854	185	return devm_rtc_register_device(rtc->rtc_dev);
b520cbe5 ML	186
	187	err_disable_extclk:
	188	clk_disable_unprepare(rtc->extclk);
	189	err_disable_pclk:
	190	clk_disable_unprepare(rtc->pclk);
	191	return ret;
98a9bb5b HUK	192	}
98a9bb5b HUK	193
1d61d259	194	static int ftrtc010_rtc_remove(struct platform_device *pdev)
98a9bb5b	195	{
1d61d259	196	struct ftrtc010_rtc *rtc = platform_get_drvdata(pdev);
98a9bb5b	197
ac05fba3 LW	198	if (!IS_ERR(rtc->extclk))
	199	clk_disable_unprepare(rtc->extclk);
	200	if (!IS_ERR(rtc->pclk))
	201	clk_disable_unprepare(rtc->pclk);
98a9bb5b HUK	202
	203	return 0;
	204	}
	205
1d61d259	206	static const struct of_device_id ftrtc010_rtc_dt_match[] = {
bc7d8ebf	207	{ .compatible = "cortina,gemini-rtc" },
1d61d259	208	{ .compatible = "faraday,ftrtc010" },
bc7d8ebf LW	209	{ }
bc7d8ebf LW	210	};
1d61d259	211	MODULE_DEVICE_TABLE(of, ftrtc010_rtc_dt_match);
bc7d8ebf	212
1d61d259	213	static struct platform_driver ftrtc010_rtc_driver = {
98a9bb5b HUK	214	.driver = {
98a9bb5b HUK	215	.name = DRV_NAME,
1d61d259	216	.of_match_table = ftrtc010_rtc_dt_match,
98a9bb5b	217	},
1d61d259 LW	218	.probe = ftrtc010_rtc_probe,
1d61d259 LW	219	.remove = ftrtc010_rtc_remove,
98a9bb5b HUK	220	};
98a9bb5b HUK	221
1d61d259	222	module_platform_driver_probe(ftrtc010_rtc_driver, ftrtc010_rtc_probe);