blob: 423762241042bc40de9e9c9b3db251e46e15fdf1 [file] [log] [blame]
Saeed Bisharadefb4512009-01-06 14:42:24 -08001/*
2 * Driver for the RTC in Marvell SoCs.
3 *
4 * This file is licensed under the terms of the GNU General Public
5 * License version 2. This program is licensed "as is" without any
6 * warranty of any kind, whether express or implied.
7 */
8
9#include <linux/init.h>
10#include <linux/kernel.h>
11#include <linux/rtc.h>
12#include <linux/bcd.h>
13#include <linux/io.h>
14#include <linux/platform_device.h>
Jason Cooperea983ede2012-03-06 23:53:57 +000015#include <linux/of.h>
Nicolas Pitre9d1d4f92009-03-23 20:42:29 -040016#include <linux/delay.h>
Andrew Lunn89c58c12013-02-03 12:32:06 +010017#include <linux/clk.h>
Tejun Heo5a0e3ad2010-03-24 17:04:11 +090018#include <linux/gfp.h>
Paul Gortmaker21138522011-05-27 09:57:25 -040019#include <linux/module.h>
Saeed Bisharadefb4512009-01-06 14:42:24 -080020
21
22#define RTC_TIME_REG_OFFS 0
23#define RTC_SECONDS_OFFS 0
24#define RTC_MINUTES_OFFS 8
25#define RTC_HOURS_OFFS 16
26#define RTC_WDAY_OFFS 24
27#define RTC_HOURS_12H_MODE (1 << 22) /* 12 hours mode */
28
29#define RTC_DATE_REG_OFFS 4
30#define RTC_MDAY_OFFS 0
31#define RTC_MONTH_OFFS 8
32#define RTC_YEAR_OFFS 16
33
Saeed Bisharaaeedaca2009-12-15 16:46:08 -080034#define RTC_ALARM_TIME_REG_OFFS 8
35#define RTC_ALARM_DATE_REG_OFFS 0xc
36#define RTC_ALARM_VALID (1 << 7)
37
38#define RTC_ALARM_INTERRUPT_MASK_REG_OFFS 0x10
39#define RTC_ALARM_INTERRUPT_CASUE_REG_OFFS 0x14
Saeed Bisharadefb4512009-01-06 14:42:24 -080040
41struct rtc_plat_data {
42 struct rtc_device *rtc;
43 void __iomem *ioaddr;
Saeed Bisharaaeedaca2009-12-15 16:46:08 -080044 int irq;
Andrew Lunn89c58c12013-02-03 12:32:06 +010045 struct clk *clk;
Saeed Bisharadefb4512009-01-06 14:42:24 -080046};
47
48static int mv_rtc_set_time(struct device *dev, struct rtc_time *tm)
49{
50 struct rtc_plat_data *pdata = dev_get_drvdata(dev);
51 void __iomem *ioaddr = pdata->ioaddr;
52 u32 rtc_reg;
53
54 rtc_reg = (bin2bcd(tm->tm_sec) << RTC_SECONDS_OFFS) |
55 (bin2bcd(tm->tm_min) << RTC_MINUTES_OFFS) |
56 (bin2bcd(tm->tm_hour) << RTC_HOURS_OFFS) |
57 (bin2bcd(tm->tm_wday) << RTC_WDAY_OFFS);
58 writel(rtc_reg, ioaddr + RTC_TIME_REG_OFFS);
59
60 rtc_reg = (bin2bcd(tm->tm_mday) << RTC_MDAY_OFFS) |
61 (bin2bcd(tm->tm_mon + 1) << RTC_MONTH_OFFS) |
62 (bin2bcd(tm->tm_year % 100) << RTC_YEAR_OFFS);
63 writel(rtc_reg, ioaddr + RTC_DATE_REG_OFFS);
64
65 return 0;
66}
67
68static int mv_rtc_read_time(struct device *dev, struct rtc_time *tm)
69{
70 struct rtc_plat_data *pdata = dev_get_drvdata(dev);
71 void __iomem *ioaddr = pdata->ioaddr;
72 u32 rtc_time, rtc_date;
73 unsigned int year, month, day, hour, minute, second, wday;
74
75 rtc_time = readl(ioaddr + RTC_TIME_REG_OFFS);
76 rtc_date = readl(ioaddr + RTC_DATE_REG_OFFS);
77
78 second = rtc_time & 0x7f;
79 minute = (rtc_time >> RTC_MINUTES_OFFS) & 0x7f;
80 hour = (rtc_time >> RTC_HOURS_OFFS) & 0x3f; /* assume 24 hours mode */
81 wday = (rtc_time >> RTC_WDAY_OFFS) & 0x7;
82
83 day = rtc_date & 0x3f;
84 month = (rtc_date >> RTC_MONTH_OFFS) & 0x3f;
85 year = (rtc_date >> RTC_YEAR_OFFS) & 0xff;
86
87 tm->tm_sec = bcd2bin(second);
88 tm->tm_min = bcd2bin(minute);
89 tm->tm_hour = bcd2bin(hour);
90 tm->tm_mday = bcd2bin(day);
91 tm->tm_wday = bcd2bin(wday);
92 tm->tm_mon = bcd2bin(month) - 1;
93 /* hw counts from year 2000, but tm_year is relative to 1900 */
94 tm->tm_year = bcd2bin(year) + 100;
95
96 return rtc_valid_tm(tm);
97}
98
Saeed Bisharaaeedaca2009-12-15 16:46:08 -080099static int mv_rtc_read_alarm(struct device *dev, struct rtc_wkalrm *alm)
100{
101 struct rtc_plat_data *pdata = dev_get_drvdata(dev);
102 void __iomem *ioaddr = pdata->ioaddr;
103 u32 rtc_time, rtc_date;
104 unsigned int year, month, day, hour, minute, second, wday;
105
106 rtc_time = readl(ioaddr + RTC_ALARM_TIME_REG_OFFS);
107 rtc_date = readl(ioaddr + RTC_ALARM_DATE_REG_OFFS);
108
109 second = rtc_time & 0x7f;
110 minute = (rtc_time >> RTC_MINUTES_OFFS) & 0x7f;
111 hour = (rtc_time >> RTC_HOURS_OFFS) & 0x3f; /* assume 24 hours mode */
112 wday = (rtc_time >> RTC_WDAY_OFFS) & 0x7;
113
114 day = rtc_date & 0x3f;
115 month = (rtc_date >> RTC_MONTH_OFFS) & 0x3f;
116 year = (rtc_date >> RTC_YEAR_OFFS) & 0xff;
117
118 alm->time.tm_sec = bcd2bin(second);
119 alm->time.tm_min = bcd2bin(minute);
120 alm->time.tm_hour = bcd2bin(hour);
121 alm->time.tm_mday = bcd2bin(day);
122 alm->time.tm_wday = bcd2bin(wday);
123 alm->time.tm_mon = bcd2bin(month) - 1;
124 /* hw counts from year 2000, but tm_year is relative to 1900 */
125 alm->time.tm_year = bcd2bin(year) + 100;
126
127 if (rtc_valid_tm(&alm->time) < 0) {
128 dev_err(dev, "retrieved alarm date/time is not valid.\n");
129 rtc_time_to_tm(0, &alm->time);
130 }
131
132 alm->enabled = !!readl(ioaddr + RTC_ALARM_INTERRUPT_MASK_REG_OFFS);
133 return 0;
134}
135
136static int mv_rtc_set_alarm(struct device *dev, struct rtc_wkalrm *alm)
137{
138 struct rtc_plat_data *pdata = dev_get_drvdata(dev);
139 void __iomem *ioaddr = pdata->ioaddr;
140 u32 rtc_reg = 0;
141
142 if (alm->time.tm_sec >= 0)
143 rtc_reg |= (RTC_ALARM_VALID | bin2bcd(alm->time.tm_sec))
144 << RTC_SECONDS_OFFS;
145 if (alm->time.tm_min >= 0)
146 rtc_reg |= (RTC_ALARM_VALID | bin2bcd(alm->time.tm_min))
147 << RTC_MINUTES_OFFS;
148 if (alm->time.tm_hour >= 0)
149 rtc_reg |= (RTC_ALARM_VALID | bin2bcd(alm->time.tm_hour))
150 << RTC_HOURS_OFFS;
151
152 writel(rtc_reg, ioaddr + RTC_ALARM_TIME_REG_OFFS);
153
154 if (alm->time.tm_mday >= 0)
155 rtc_reg = (RTC_ALARM_VALID | bin2bcd(alm->time.tm_mday))
156 << RTC_MDAY_OFFS;
157 else
158 rtc_reg = 0;
159
160 if (alm->time.tm_mon >= 0)
161 rtc_reg |= (RTC_ALARM_VALID | bin2bcd(alm->time.tm_mon + 1))
162 << RTC_MONTH_OFFS;
163
164 if (alm->time.tm_year >= 0)
165 rtc_reg |= (RTC_ALARM_VALID | bin2bcd(alm->time.tm_year % 100))
166 << RTC_YEAR_OFFS;
167
168 writel(rtc_reg, ioaddr + RTC_ALARM_DATE_REG_OFFS);
169 writel(0, ioaddr + RTC_ALARM_INTERRUPT_CASUE_REG_OFFS);
170 writel(alm->enabled ? 1 : 0,
171 ioaddr + RTC_ALARM_INTERRUPT_MASK_REG_OFFS);
172
173 return 0;
174}
175
John Stultz16380c12011-02-02 17:02:41 -0800176static int mv_rtc_alarm_irq_enable(struct device *dev, unsigned int enabled)
Saeed Bisharaaeedaca2009-12-15 16:46:08 -0800177{
178 struct platform_device *pdev = to_platform_device(dev);
179 struct rtc_plat_data *pdata = platform_get_drvdata(pdev);
180 void __iomem *ioaddr = pdata->ioaddr;
181
182 if (pdata->irq < 0)
John Stultz16380c12011-02-02 17:02:41 -0800183 return -EINVAL; /* fall back into rtc-dev's emulation */
184
185 if (enabled)
Saeed Bisharaaeedaca2009-12-15 16:46:08 -0800186 writel(1, ioaddr + RTC_ALARM_INTERRUPT_MASK_REG_OFFS);
John Stultz16380c12011-02-02 17:02:41 -0800187 else
188 writel(0, ioaddr + RTC_ALARM_INTERRUPT_MASK_REG_OFFS);
Saeed Bisharaaeedaca2009-12-15 16:46:08 -0800189 return 0;
190}
191
192static irqreturn_t mv_rtc_interrupt(int irq, void *data)
193{
194 struct rtc_plat_data *pdata = data;
195 void __iomem *ioaddr = pdata->ioaddr;
196
197 /* alarm irq? */
198 if (!readl(ioaddr + RTC_ALARM_INTERRUPT_CASUE_REG_OFFS))
199 return IRQ_NONE;
200
201 /* clear interrupt */
202 writel(0, ioaddr + RTC_ALARM_INTERRUPT_CASUE_REG_OFFS);
203 rtc_update_irq(pdata->rtc, 1, RTC_IRQF | RTC_AF);
204 return IRQ_HANDLED;
205}
206
Saeed Bisharadefb4512009-01-06 14:42:24 -0800207static const struct rtc_class_ops mv_rtc_ops = {
208 .read_time = mv_rtc_read_time,
209 .set_time = mv_rtc_set_time,
210};
211
Saeed Bisharaaeedaca2009-12-15 16:46:08 -0800212static const struct rtc_class_ops mv_rtc_alarm_ops = {
213 .read_time = mv_rtc_read_time,
214 .set_time = mv_rtc_set_time,
215 .read_alarm = mv_rtc_read_alarm,
216 .set_alarm = mv_rtc_set_alarm,
John Stultz16380c12011-02-02 17:02:41 -0800217 .alarm_irq_enable = mv_rtc_alarm_irq_enable,
Saeed Bisharaaeedaca2009-12-15 16:46:08 -0800218};
219
Jingoo Hanb69af432013-04-29 16:18:21 -0700220static int __init mv_rtc_probe(struct platform_device *pdev)
Saeed Bisharadefb4512009-01-06 14:42:24 -0800221{
222 struct resource *res;
223 struct rtc_plat_data *pdata;
Saeed Bisharadefb4512009-01-06 14:42:24 -0800224 u32 rtc_time;
Thomas Petazzonie102dc72014-02-18 14:26:06 +0100225 u32 rtc_date;
Andrew Lunn89c58c12013-02-03 12:32:06 +0100226 int ret = 0;
Saeed Bisharadefb4512009-01-06 14:42:24 -0800227
Saeed Bisharadefb4512009-01-06 14:42:24 -0800228 pdata = devm_kzalloc(&pdev->dev, sizeof(*pdata), GFP_KERNEL);
229 if (!pdata)
230 return -ENOMEM;
231
Julia Lawall7c1d69e2013-09-11 14:24:27 -0700232 res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
233 pdata->ioaddr = devm_ioremap_resource(&pdev->dev, res);
234 if (IS_ERR(pdata->ioaddr))
235 return PTR_ERR(pdata->ioaddr);
Saeed Bisharadefb4512009-01-06 14:42:24 -0800236
Andrew Lunn89c58c12013-02-03 12:32:06 +0100237 pdata->clk = devm_clk_get(&pdev->dev, NULL);
238 /* Not all SoCs require a clock.*/
239 if (!IS_ERR(pdata->clk))
240 clk_prepare_enable(pdata->clk);
241
Saeed Bisharadefb4512009-01-06 14:42:24 -0800242 /* make sure the 24 hours mode is enabled */
243 rtc_time = readl(pdata->ioaddr + RTC_TIME_REG_OFFS);
244 if (rtc_time & RTC_HOURS_12H_MODE) {
245 dev_err(&pdev->dev, "24 Hours mode not supported.\n");
Andrew Lunn89c58c12013-02-03 12:32:06 +0100246 ret = -EINVAL;
247 goto out;
Saeed Bisharadefb4512009-01-06 14:42:24 -0800248 }
249
Nicolas Pitre9d1d4f92009-03-23 20:42:29 -0400250 /* make sure it is actually functional */
251 if (rtc_time == 0x01000000) {
252 ssleep(1);
253 rtc_time = readl(pdata->ioaddr + RTC_TIME_REG_OFFS);
254 if (rtc_time == 0x01000000) {
255 dev_err(&pdev->dev, "internal RTC not ticking\n");
Andrew Lunn89c58c12013-02-03 12:32:06 +0100256 ret = -ENODEV;
257 goto out;
Nicolas Pitre9d1d4f92009-03-23 20:42:29 -0400258 }
259 }
260
Thomas Petazzonie102dc72014-02-18 14:26:06 +0100261 /*
262 * A date after January 19th, 2038 does not fit on 32 bits and
263 * will confuse the kernel and userspace. Reset to a sane date
264 * (January 1st, 2013) if we're after 2038.
265 */
266 rtc_date = readl(pdata->ioaddr + RTC_DATE_REG_OFFS);
267 if (bcd2bin((rtc_date >> RTC_YEAR_OFFS) & 0xff) >= 38) {
268 dev_info(&pdev->dev, "invalid RTC date, resetting to January 1st, 2013\n");
269 writel(0x130101, pdata->ioaddr + RTC_DATE_REG_OFFS);
270 }
271
Saeed Bisharaaeedaca2009-12-15 16:46:08 -0800272 pdata->irq = platform_get_irq(pdev, 0);
273
Saeed Bisharadefb4512009-01-06 14:42:24 -0800274 platform_set_drvdata(pdev, pdata);
Saeed Bisharaaeedaca2009-12-15 16:46:08 -0800275
276 if (pdata->irq >= 0) {
277 device_init_wakeup(&pdev->dev, 1);
Jingoo Han4241e2b2013-04-29 16:19:08 -0700278 pdata->rtc = devm_rtc_device_register(&pdev->dev, pdev->name,
Saeed Bisharaaeedaca2009-12-15 16:46:08 -0800279 &mv_rtc_alarm_ops,
280 THIS_MODULE);
Jingoo Han4241e2b2013-04-29 16:19:08 -0700281 } else {
282 pdata->rtc = devm_rtc_device_register(&pdev->dev, pdev->name,
Saeed Bisharaaeedaca2009-12-15 16:46:08 -0800283 &mv_rtc_ops, THIS_MODULE);
Jingoo Han4241e2b2013-04-29 16:19:08 -0700284 }
Andrew Lunn89c58c12013-02-03 12:32:06 +0100285 if (IS_ERR(pdata->rtc)) {
286 ret = PTR_ERR(pdata->rtc);
287 goto out;
288 }
Saeed Bisharadefb4512009-01-06 14:42:24 -0800289
Saeed Bisharaaeedaca2009-12-15 16:46:08 -0800290 if (pdata->irq >= 0) {
291 writel(0, pdata->ioaddr + RTC_ALARM_INTERRUPT_MASK_REG_OFFS);
292 if (devm_request_irq(&pdev->dev, pdata->irq, mv_rtc_interrupt,
Yong Zhang2f6e5f92012-03-23 15:02:34 -0700293 IRQF_SHARED,
Saeed Bisharaaeedaca2009-12-15 16:46:08 -0800294 pdev->name, pdata) < 0) {
295 dev_warn(&pdev->dev, "interrupt not available.\n");
296 pdata->irq = -1;
297 }
298 }
299
Saeed Bisharadefb4512009-01-06 14:42:24 -0800300 return 0;
Andrew Lunn89c58c12013-02-03 12:32:06 +0100301out:
302 if (!IS_ERR(pdata->clk))
303 clk_disable_unprepare(pdata->clk);
304
305 return ret;
Saeed Bisharadefb4512009-01-06 14:42:24 -0800306}
307
308static int __exit mv_rtc_remove(struct platform_device *pdev)
309{
310 struct rtc_plat_data *pdata = platform_get_drvdata(pdev);
311
Saeed Bisharaaeedaca2009-12-15 16:46:08 -0800312 if (pdata->irq >= 0)
313 device_init_wakeup(&pdev->dev, 0);
314
Andrew Lunn89c58c12013-02-03 12:32:06 +0100315 if (!IS_ERR(pdata->clk))
316 clk_disable_unprepare(pdata->clk);
317
Saeed Bisharadefb4512009-01-06 14:42:24 -0800318 return 0;
319}
320
Jason Cooperea983ede2012-03-06 23:53:57 +0000321#ifdef CONFIG_OF
Jingoo Han4621bc52014-06-06 14:35:57 -0700322static const struct of_device_id rtc_mv_of_match_table[] = {
Andrew Lunn77843502012-07-18 19:22:54 +0200323 { .compatible = "marvell,orion-rtc", },
Jason Cooperea983ede2012-03-06 23:53:57 +0000324 {}
325};
326#endif
327
Saeed Bisharadefb4512009-01-06 14:42:24 -0800328static struct platform_driver mv_rtc_driver = {
329 .remove = __exit_p(mv_rtc_remove),
330 .driver = {
331 .name = "rtc-mv",
Jason Cooperea983ede2012-03-06 23:53:57 +0000332 .of_match_table = of_match_ptr(rtc_mv_of_match_table),
Saeed Bisharadefb4512009-01-06 14:42:24 -0800333 },
334};
335
Jingoo Han1963f7c2013-04-29 16:18:44 -0700336module_platform_driver_probe(mv_rtc_driver, mv_rtc_probe);
Saeed Bisharadefb4512009-01-06 14:42:24 -0800337
338MODULE_AUTHOR("Saeed Bishara <saeed@marvell.com>");
339MODULE_DESCRIPTION("Marvell RTC driver");
340MODULE_LICENSE("GPL");
341MODULE_ALIAS("platform:rtc-mv");